Bug 20462: Ensure batch item deletion will not delete the same item twice
[koha.git] / tools / inventory.pl
index 9a80017..3da000a 100755 (executable)
@@ -1,28 +1,27 @@
 #!/usr/bin/perl
 
 # Copyright 2000-2009 Biblibre S.A
-#                                         John Soros <john.soros@biblibre.com>
+# John Soros <john.soros@biblibre.com>
 #
 # 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;
 
 #need to open cgi and get the fh before anything else opens a new cgi context (see C4::Auth)
-use CGI;
+use CGI qw ( -utf8 );
 my $input = CGI->new;
 my $uploadbarcodes = $input->param('uploadbarcodes');
 
@@ -31,35 +30,31 @@ use C4::Context;
 use C4::Output;
 use C4::Biblio;
 use C4::Items;
-use C4::Dates qw/format_date format_date_in_iso/;
 use C4::Koha;
-use C4::Branch; # GetBranches
 use C4::Circulation;
 use C4::Reports::Guided;    #_get_column_defs
 use C4::Charset;
-use List::MoreUtils qw/none/;
 
+use Koha::Biblios;
+use Koha::DateUtils;
+use Koha::AuthorisedValues;
+use Koha::BiblioFrameworks;
+use List::MoreUtils qw( none );
 
 my $minlocation=$input->param('minlocation') || '';
 my $maxlocation=$input->param('maxlocation');
 $maxlocation=$minlocation.'Z' unless ( $maxlocation || ! $minlocation );
 my $location=$input->param('location') || '';
-my $itemtype=$input->param('itemtype'); # FIXME note, template does not currently supply this
 my $ignoreissued=$input->param('ignoreissued');
-my $datelastseen = $input->param('datelastseen');
-my $offset = $input->param('offset');
-my $markseen = $input->param('markseen');
-$offset=0 unless $offset;
-my $pagesize = $input->param('pagesize');
-$pagesize=50 unless $pagesize;
+my $datelastseen = $input->param('datelastseen'); # last inventory date
 my $branchcode = $input->param('branchcode') || '';
 my $branch     = $input->param('branch');
 my $op         = $input->param('op');
 my $compareinv2barcd = $input->param('compareinv2barcd');
-my $res;                                            #contains the results loop
+my $dont_checkin = $input->param('dont_checkin');
 
 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
-    {   template_name   => "tools/inventory.tmpl",
+    {   template_name   => "tools/inventory.tt",
         query           => $input,
         type            => "intranet",
         authnotrequired => 0,
@@ -68,25 +63,16 @@ my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
     }
 );
 
-
-my $branches = GetBranches();
-my @branch_loop;
-for my $branch_hash (keys %$branches) {
-    push @branch_loop, {value => "$branch_hash",
-                       branchname => $branches->{$branch_hash}->{'branchname'},
-                       selected => ($branch_hash eq $branchcode?1:0)};
-}
-
-@branch_loop = sort {$a->{branchname} cmp $b->{branchname}} @branch_loop;
 my @authorised_value_list;
 my $authorisedvalue_categories = '';
 
-my $frameworks = getframeworks();
-$frameworks->{''} = {frameworkcode => ''}; # Add the default framework
+my $frameworks = Koha::BiblioFrameworks->search({}, { order_by => ['frameworktext'] })->unblessed;
+unshift @$frameworks, { frameworkcode => '' };
 
-for my $fwk (keys %$frameworks){
-  my $fwkcode = $frameworks->{$fwk}->{'frameworkcode'};
-  my $authcode = GetAuthValCode('items.location', $fwkcode);
+for my $fwk ( @$frameworks ){
+  my $fwkcode = $fwk->{frameworkcode};
+  my $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $fwkcode, kohafield => 'items.location', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
+  my $authcode = $mss->count ? $mss->next->authorised_value : undef;
     if ($authcode && $authorisedvalue_categories!~/\b$authcode\W/){
       $authorisedvalue_categories.="$authcode ";
       my $data=GetAuthorisedValues($authcode);
@@ -98,20 +84,27 @@ for my $fwk (keys %$frameworks){
 }
 
 my $statuses = [];
+my @notforloans;
 for my $statfield (qw/items.notforloan items.itemlost items.withdrawn items.damaged/){
     my $hash = {};
     $hash->{fieldname} = $statfield;
-    $hash->{authcode} = GetAuthValCode($statfield);
+    my $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => '', kohafield => $statfield, authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
+    $hash->{authcode} = $mss->count ? $mss->next->authorised_value : undef;
     if ($hash->{authcode}){
         my $arr = GetAuthorisedValues($hash->{authcode});
+        if ( $statfield eq 'items.notforloan') {
+            # Add notforloan == 0 to the list of possible notforloan statuses
+            # The lib value is replaced in the template
+            push @$arr, { authorised_value => 0, id => 'stat0' , lib => 'ignore' } if ! grep { $_->{authorised_value} eq '0' } @$arr;
+            @notforloans = map { $_->{'authorised_value'} } @$arr;
+        }
         $hash->{values} = $arr;
         push @$statuses, $hash;
     }
 }
 
-
 $template->param( statuses => $statuses );
-my $staton = {};                                #authorized values that are ticked
+my $staton = {}; #authorized values that are ticked
 for my $authvfield (@$statuses) {
     $staton->{$authvfield->{fieldname}} = [];
     for my $authval (@{$authvfield->{values}}){
@@ -121,188 +114,223 @@ for my $authvfield (@$statuses) {
     }
 }
 
-my $notforloanlist;
-my $statussth = '';
-for my $authvfield (@$statuses) {
-    if ( scalar @{$staton->{$authvfield->{fieldname}}} > 0 ){
-        my $joinedvals = join ',', @{$staton->{$authvfield->{fieldname}}};
-        $statussth .= "$authvfield->{fieldname} in ($joinedvals) and ";
-        $notforloanlist = $joinedvals if ($authvfield->{fieldname} eq "items.notforloan");
-    }
-}
-$statussth =~ s, and $,,g;
 $template->param(
-    branchloop               => \@branch_loop,
     authorised_values        => \@authorised_value_list,
-    today                    => C4::Dates->today(),
+    today                    => dt_from_string,
     minlocation              => $minlocation,
     maxlocation              => $maxlocation,
     location                 => $location,
     ignoreissued             => $ignoreissued,
     branchcode               => $branchcode,
     branch                   => $branch,
-    offset                   => $offset,
-    pagesize                 => $pagesize,
     datelastseen             => $datelastseen,
     compareinv2barcd         => $compareinv2barcd,
-    notforloanlist           => $notforloanlist
+    uploadedbarcodesflag     => $uploadbarcodes ? 1 : 0,
 );
 
-my @notforloans;
-if (defined $notforloanlist) {
-    @notforloans = split(/,/, $notforloanlist);
-}
-
-
-
-my @brcditems;
-my $barcodelist;
+# Walk through uploaded barcodes, report errors, mark as seen, check in
+my $results = {};
+my @scanned_items;
 my @errorloop;
+my $moddatecount = 0;
 if ( $uploadbarcodes && length($uploadbarcodes) > 0 ) {
     my $dbh = C4::Context->dbh;
-    my $date = format_date_in_iso( $input->param('setdate') ) || C4::Dates->today('iso');
+    my $date = dt_from_string( scalar $input->param('setdate') );
+    $date = output_pref ( { dt => $date, dateformat => 'iso' } );
 
     my $strsth  = "select * from issues, items where items.itemnumber=issues.itemnumber and items.barcode =?";
     my $qonloan = $dbh->prepare($strsth);
     $strsth="select * from items where items.barcode =? and items.withdrawn = 1";
     my $qwithdrawn = $dbh->prepare($strsth);
 
-    my $count = 0;
-
-    while (my $barcode=<$uploadbarcodes>){
-        $barcode =~ s/\r?\n$//;
-        $barcodelist .= ($barcodelist) ? '|' . $barcode : $barcode;
+    my @barcodes;
+    my @uploadedbarcodes;
+
+    my $sth = $dbh->column_info(undef,undef,"items","barcode");
+    my $barcode_def = $sth->fetchall_hashref('COLUMN_NAME');
+    my $barcode_size = $barcode_def->{barcode}->{COLUMN_SIZE};
+    my $err_length=0;
+    my $err_data=0;
+    my $lines_read=0;
+    binmode($uploadbarcodes, ":encoding(UTF-8)");
+    while (my $barcode=<$uploadbarcodes>) {
+        push @uploadedbarcodes, grep { /\S/ } split( /[\n\r,;|-]/, $barcode );
+    }
+    for my $barcode (@uploadedbarcodes) {
+        next unless $barcode;
+        ++$lines_read;
+        if (length($barcode)>$barcode_size) {
+            $err_length += 1;
+        }
+        my $check_barcode = $barcode;
+        $check_barcode =~ s/\p{Print}//g;
+        if (length($check_barcode)>0) { # Only printable unicode characters allowed.
+            $err_data += 1;
+        }
+        next if length($barcode)>$barcode_size;
+        next if ( length($check_barcode)>0 );
+        push @barcodes,$barcode;
+    }
+    $template->param( LinesRead => $lines_read );
+    if (! @barcodes) {
+        push @errorloop, {'barcode'=>'No valid barcodes!'};
+        $op=''; # force the initial inventory screen again.
+    }
+    else {
+        $template->param( err_length => $err_length,
+                          err_data   => $err_data );
+    }
+    foreach my $barcode (@barcodes) {
         if ( $qwithdrawn->execute($barcode) && $qwithdrawn->rows ) {
             push @errorloop, { 'barcode' => $barcode, 'ERR_WTHDRAWN' => 1 };
         } else {
             my $item = GetItem( '', $barcode );
             if ( defined $item && $item->{'itemnumber'} ) {
-                ModItem( { datelastseen => $date }, undef, $item->{'itemnumber'} );
-                push @brcditems, $item;
-                $count++;
-                $qonloan->execute($barcode);
-                if ($qonloan->rows){
-                    my $data = $qonloan->fetchrow_hashref;
-                    my ($doreturn, $messages, $iteminformation, $borrower) =AddReturn($barcode, $data->{homebranch});
-                    if ($doreturn){
-                        push @errorloop, {'barcode'=>$barcode,'ERR_ONLOAN_RET'=>1}
-                    } else {
-                        push @errorloop, {'barcode'=>$barcode,'ERR_ONLOAN_NOT_RET'=>1}
+                # Modify date last seen for scanned items, remove lost status
+                ModItem( { itemlost => 0, datelastseen => $date }, undef, $item->{'itemnumber'} );
+                $moddatecount++;
+                # update item hash accordingly
+                $item->{itemlost} = 0;
+                $item->{datelastseen} = $date;
+                unless ( $dont_checkin ) {
+                    $qonloan->execute($barcode);
+                    if ($qonloan->rows){
+                        my $data = $qonloan->fetchrow_hashref;
+                        my ($doreturn, $messages, $iteminformation, $borrower) =AddReturn($barcode, $data->{homebranch});
+                        if( $doreturn ) {
+                            $item->{onloan} = undef;
+                            $item->{datelastseen} = dt_from_string;
+                        } else {
+                            push @errorloop, { barcode => $barcode, ERR_ONLOAN_NOT_RET => 1 };
+                        }
                     }
                 }
+                push @scanned_items, $item;
             } else {
-                push @errorloop, {'barcode'=>$barcode,'ERR_BARCODE'=>1};
+                push @errorloop, { barcode => $barcode, ERR_BARCODE => 1 };
             }
         }
-
     }
-    $qonloan->finish;
-    $qwithdrawn->finish;
-    $template->param( date => format_date($date), Number => $count );
+    $template->param( date => $date );
     $template->param( errorloop => \@errorloop ) if (@errorloop);
+}
 
+# Build inventorylist: used as result list when you do not pass barcodes
+# This list is also used when you want to compare with barcodes
+my ( $inventorylist, $rightplacelist );
+if ( $op && ( !$uploadbarcodes || $compareinv2barcd )) {
+    ( $inventorylist ) = GetItemsForInventory({
+      minlocation  => $minlocation,
+      maxlocation  => $maxlocation,
+      location     => $location,
+      ignoreissued => $ignoreissued,
+      datelastseen => $datelastseen,
+      branchcode   => $branchcode,
+      branch       => $branch,
+      offset       => 0,
+      statushash   => $staton,
+    });
 }
-$template->param(barcodelist => $barcodelist);
-
-# now build the result list: inventoried items if requested, and mis-placed items -always-
-my $inventorylist;
-if ( $markseen or $op ) {
-    # retrieve all items in this range.
-    my $totalrecords;
-    ($inventorylist, $totalrecords) = GetItemsForInventory($minlocation, $maxlocation, $location, $itemtype, $ignoreissued, '', $branchcode, $branch, 0, undef , $staton);
-
-    # Real copy
-    my @res_copy;
-    foreach (@$inventorylist) {
-        push @res_copy, $_;
-    }
-    $res = \@res_copy;
+# Build rightplacelist used to check if a scanned item is in the right place.
+if( @scanned_items ) {
+    ( $rightplacelist ) = GetItemsForInventory({
+      minlocation  => $minlocation,
+      maxlocation  => $maxlocation,
+      location     => $location,
+      ignoreissued => undef,
+      datelastseen => undef,
+      branchcode   => $branchcode,
+      branch       => $branch,
+      offset       => 0,
+      statushash   => undef,
+    });
+    # Convert the structure to a hash on barcode
+    $rightplacelist = {
+        map { $_->{barcode} ? ( $_->{barcode}, $_ ) : (); } @$rightplacelist
+    };
 }
 
-# set "missing" flags for all items with a datelastseen before the choosen datelastseen
-foreach (@$res) { $_->{missingitem}=1 if C4::Dates->new($_->{datelastseen})->output('iso') lt C4::Dates->new($datelastseen)->output('iso'); }
-
-# removing missing items from loop if "Compare barcodes list to results" has not been checked
-@$res = grep {!$_->{missingitem} == 1 } @$res if (!$input->param('compareinv2barcd'));
-
-# insert "wrongplace" to all scanned items that are not supposed to be in this range
-# note this list is always displayed, whatever the librarian has choosen for comparison
-foreach my $temp (@brcditems) {
-
-  # Saving notforloan code before it's replaced by it's authorised value for later comparison
-  $temp->{'notforloancode'} = $temp->{'notforloan'};
-
-  # Populating with authorised values
-  foreach (keys %$temp) {
-        # If the koha field is mapped to a marc field
-        my $fc = $temp->{'frameworkcode'} || '';
-        my ($f, $sf) = GetMarcFromKohaField("items.$_", $fc);
-        if ($f and $sf) {
-            # We replace the code with it's description
-            my $authvals = C4::Koha::GetKohaAuthorisedValuesFromField($f, $sf, $fc);
-            if ($authvals and defined $temp->{$_} and defined $authvals->{$temp->{$_}}) {
-              $temp->{$_} = $authvals->{$temp->{$_}};
-            }
+# Report scanned items that are on the wrong place, or have a wrong notforloan
+# status, or are still checked out.
+foreach my $item ( @scanned_items ) {
+    $item->{notforloancode} = $item->{notforloan}; # save for later use
+    my $fc = $item->{'frameworkcode'} || '';
+
+    # Populating with authorised values description
+    foreach my $field (qw/ location notforloan itemlost damaged withdrawn /) {
+        my $av = Koha::AuthorisedValues->get_description_by_koha_field(
+            { frameworkcode => $fc, kohafield => "items.$field", authorised_value => $item->{$field} } );
+        if ( $av and defined $item->{$field} and defined $av->{lib} ) {
+            $item->{$field} = $av->{lib};
         }
     }
 
-    next if $temp->{onloan}; # skip checked out items
-
     # If we have scanned items with a non-matching notforloan value
-    if (none { $temp->{'notforloancode'} eq $_ } @notforloans) {
-        $temp->{'changestatus'} = 1;
-        my $biblio = C4::Biblio::GetBiblioData($temp->{biblionumber});
-        $temp->{title} = $biblio->{title};
-        $temp->{author} = $biblio->{author};
-        $temp->{datelastseen} = format_date($temp->{datelastseen});
-        push @$res, $temp;
-
+    if( none { $item->{'notforloancode'} eq $_ } @notforloans ) {
+        $item->{problems}->{changestatus} = 1;
+        additemtoresults( $item, $results );
     }
-    if (none { $temp->{barcode} eq $_->{barcode} && !$_->{'onloan'} } @$inventorylist) {
-        my $temp2 = { %$temp };
-        $temp2->{wrongplace}=1;
-        my $biblio = C4::Biblio::GetBiblioData($temp->{biblionumber});
-        $temp2->{title} = $biblio->{title};
-        $temp2->{author} = $biblio->{author};
-        $temp2->{datelastseen} = format_date($temp->{datelastseen});
-        push @$res, $temp2;
+
+    # Report an item that is checked out (unusual!) or wrongly placed
+    if( $item->{onloan} ) {
+        $item->{problems}->{checkedout} = 1;
+        additemtoresults( $item, $results );
+        next; # do not modify item
+    } elsif( !exists $rightplacelist->{ $item->{barcode} } ) {
+        $item->{problems}->{wrongplace} = 1;
+        additemtoresults( $item, $results );
     }
 }
 
-# Finally, modifying datelastseen for remaining items
-my $moddatecount = 0;
-foreach (@$res) {
-    unless ($_->{'missingitem'}) {
-        ModDateLastSeen($_->{'itemnumber'});
-        $moddatecount++;
+# Compare barcodes with inventory list, report no_barcode and not_scanned.
+# not_scanned can be interpreted as missing
+if ( $compareinv2barcd ) {
+    my @scanned_barcodes = map {$_->{barcode}} @scanned_items;
+    for my $item ( @$inventorylist ) {
+        my $barcode = $item->{barcode};
+        if( !$barcode ) {
+            $item->{problems}->{no_barcode} = 1;
+        } elsif ( grep /^$barcode$/, @scanned_barcodes ) {
+            next;
+        } else {
+            $item->{problems}->{not_scanned} = 1;
+        }
+        additemtoresults( $item, $results );
     }
 }
 
-# Removing items that don't have any problems from loop
-@$res = grep { $_->{missingitem} || $_->{wrongplace} || $_->{changestatus} } @$res;
+# Construct final results, add biblio information
+my $loop = $uploadbarcodes
+    ? [ map { $results->{$_} } keys %$results ]
+    : $inventorylist // [];
+for my $item ( @$loop ) {
+    my $biblio = Koha::Biblios->find( $item->{biblionumber} );
+    $item->{title} = $biblio->title;
+    $item->{author} = $biblio->author;
+}
 
 $template->param(
     moddatecount => $moddatecount,
-    loop       => $res,
-    nextoffset => ( $offset + $pagesize ),
-    prevoffset => ( $offset ? $offset - $pagesize : 0 ),
-    op         => $op
+    loop         => $loop,
+    op           => $op,
 );
 
+# Export to csv
 if (defined $input->param('CSVexport') && $input->param('CSVexport') eq 'on'){
     eval {use Text::CSV};
     my $csv = Text::CSV->new or
             die Text::CSV->error_diag ();
+    binmode STDOUT, ":encoding(UTF-8)";
     print $input->header(
         -type       => 'text/csv',
         -attachment => 'inventory.csv',
     );
 
-    my $columns_def_hashref = C4::Reports::Guided::_get_column_defs();
+    my $columns_def_hashref = C4::Reports::Guided::_get_column_defs($input);
     foreach my $key ( keys %$columns_def_hashref ) {
         my $initkey = $key;
         $key =~ s/[^\.]*\.//;
-        $columns_def_hashref->{$initkey}=NormalizeString($columns_def_hashref->{$initkey});
+        $columns_def_hashref->{$initkey}=NormalizeString($columns_def_hashref->{$initkey} // '');
         $columns_def_hashref->{$key} = $columns_def_hashref->{$initkey};
     }
 
@@ -312,41 +340,58 @@ if (defined $input->param('CSVexport') && $input->param('CSVexport') eq 'on'){
                       items.homebranch     items.location
                       items.itemcallnumber items.notforloan
                       items.itemlost       items.damaged
-                      items.stocknumber
+                      items.withdrawn      items.stocknumber
                       / ) {
        push @translated_keys, $columns_def_hashref->{$key};
     }
+    push @translated_keys, 'problem' if $uploadbarcodes;
 
     $csv->combine(@translated_keys);
     print $csv->string, "\n";
 
-    my @keys = qw / title author barcode itemnumber homebranch location itemcallnumber notforloan lost damaged stocknumber /;
-    for my $re (@$res) {
+    my @keys = qw/ title author barcode itemnumber homebranch location itemcallnumber notforloan itemlost damaged withdrawn stocknumber /;
+    for my $item ( @$loop ) {
         my @line;
         for my $key (@keys) {
-            push @line, $re->{$key};
+            push @line, $item->{$key};
         }
-        if ($re->{wrongplace}) {
-            push @line, "wrong place";
-        } elsif ($re->{missingitem}) {
-            push @line, "missing item";
-        } elsif ($re->{changestatus}) {
-            push @line, "change item status";
+        my $errstr = '';
+        foreach my $key ( keys %{$item->{problems}} ) {
+            if( $key eq 'wrongplace' ) {
+                $errstr .= "wrong place,";
+            } elsif( $key eq 'changestatus' ) {
+                $errstr .= "unknown notforloan status,";
+            } elsif( $key eq 'not_scanned' ) {
+                $errstr .= "missing,";
+            } elsif( $key eq 'no_barcode' ) {
+                $errstr .= "no barcode,";
+            } elsif( $key eq 'checkedout' ) {
+                $errstr .= "checked out,";
+            }
         }
+        $errstr =~ s/,$//;
+        push @line, $errstr;
         $csv->combine(@line);
         print $csv->string, "\n";
     }
     # Adding not found barcodes
     foreach my $error (@errorloop) {
-    my @line;
-    if ($error->{'ERR_BARCODE'}) {
-        push @line, map { $_ eq 'barcode' ? $error->{'barcode'} : ''} @keys;
-        push @line, "barcode not found";
-        $csv->combine(@line);
-        print $csv->string, "\n";
-    }
+        my @line;
+        if ($error->{'ERR_BARCODE'}) {
+            push @line, map { $_ eq 'barcode' ? $error->{'barcode'} : ''} @keys;
+            push @line, "barcode not found";
+            $csv->combine(@line);
+            print $csv->string, "\n";
+        }
     }
     exit;
 }
 
 output_html_with_http_headers $input, $cookie, $template->output;
+
+sub additemtoresults {
+    my ( $item, $results ) = @_;
+    my $itemno = $item->{itemnumber};
+    # since the script appends to $item, we can just overwrite the hash entry
+    $results->{$itemno} = $item;
+}