tools/inventory.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2000-2009 Biblibre S.A
   4 # John Soros <john.soros@biblibre.com>
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 use Modern::Perl;
  22
  23 #need to open cgi and get the fh before anything else opens a new cgi context (see C4::Auth)
  24 use CGI qw ( -utf8 );
  25 my $input = CGI->new;
  26 my $uploadbarcodes = $input->param('uploadbarcodes');
  27
  28 use C4::Auth;
  29 use C4::Context;
  30 use C4::Output;
  31 use C4::Biblio;
  32 use C4::Items;
  33 use C4::Koha;
  34 use C4::Circulation;
  35 use C4::Reports::Guided;    #_get_column_defs
  36 use C4::Charset;
  37
  38 use Koha::Biblios;
  39 use Koha::DateUtils;
  40 use Koha::AuthorisedValues;
  41 use Koha::BiblioFrameworks;
  42 use Koha::ClassSources;
  43 use Koha::Items;
  44 use List::MoreUtils qw( none );
  45
  46 my $minlocation=$input->param('minlocation') || '';
  47 my $maxlocation=$input->param('maxlocation');
  48 my $class_source=$input->param('class_source');
  49 $maxlocation=$minlocation.'Z' unless ( $maxlocation || ! $minlocation );
  50 my $location=$input->param('location') || '';
  51 my $ignoreissued=$input->param('ignoreissued');
  52 my $ignore_waiting_holds = $input->param('ignore_waiting_holds');
  53 my $datelastseen = $input->param('datelastseen'); # last inventory date
  54 my $branchcode = $input->param('branchcode') || '';
  55 my $branch     = $input->param('branch');
  56 my $op         = $input->param('op');
  57 my $compareinv2barcd = $input->param('compareinv2barcd');
  58 my $dont_checkin = $input->param('dont_checkin');
  59 my $out_of_order = $input->param('out_of_order');
  60
  61 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  62     {   template_name   => "tools/inventory.tt",
  63         query           => $input,
  64         type            => "intranet",
  65         authnotrequired => 0,
  66         flagsrequired   => { tools => 'inventory' },
  67         debug           => 1,
  68     }
  69 );
  70
  71 my @authorised_value_list;
  72 my $authorisedvalue_categories = '';
  73
  74 my $frameworks = Koha::BiblioFrameworks->search({}, { order_by => ['frameworktext'] })->unblessed;
  75 unshift @$frameworks, { frameworkcode => '' };
  76
  77 for my $fwk ( @$frameworks ){
  78   my $fwkcode = $fwk->{frameworkcode};
  79   my $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => $fwkcode, kohafield => 'items.location', authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
  80   my $authcode = $mss->count ? $mss->next->authorised_value : undef;
  81     if ($authcode && $authorisedvalue_categories!~/\b$authcode\W/){
  82       $authorisedvalue_categories.="$authcode ";
  83       my $data=GetAuthorisedValues($authcode);
  84       foreach my $value (@$data){
  85         $value->{selected}=1 if ($value->{authorised_value} eq ($location));
  86       }
  87       push @authorised_value_list,@$data;
  88     }
  89 }
  90
  91 my $statuses = [];
  92 my @notforloans;
  93 for my $statfield (qw/items.notforloan items.itemlost items.withdrawn items.damaged/){
  94     my $hash = {};
  95     $hash->{fieldname} = $statfield;
  96     my $mss = Koha::MarcSubfieldStructures->search({ frameworkcode => '', kohafield => $statfield, authorised_value => [ -and => {'!=' => undef }, {'!=' => ''}] });
  97     $hash->{authcode} = $mss->count ? $mss->next->authorised_value : undef;
  98     if ($hash->{authcode}){
  99         my $arr = GetAuthorisedValues($hash->{authcode});
 100         if ( $statfield eq 'items.notforloan') {
 101             # Add notforloan == 0 to the list of possible notforloan statuses
 102             # The lib value is replaced in the template
 103             push @$arr, { authorised_value => 0, id => 'stat0' , lib => '__IGNORE__' } if ! grep { $_->{authorised_value} eq '0' } @$arr;
 104             @notforloans = map { $_->{'authorised_value'} } @$arr;
 105         }
 106         $hash->{values} = $arr;
 107         push @$statuses, $hash;
 108     }
 109 }
 110
 111 $template->param( statuses => $statuses );
 112 my $staton = {}; #authorized values that are ticked
 113 for my $authvfield (@$statuses) {
 114     $staton->{$authvfield->{fieldname}} = [];
 115     for my $authval (@{$authvfield->{values}}){
 116         if ( defined $input->param('status-' . $authvfield->{fieldname} . '-' . $authval->{authorised_value}) && $input->param('status-' . $authvfield->{fieldname} . '-' . $authval->{authorised_value}) eq 'on' ){
 117             push @{$staton->{$authvfield->{fieldname}}}, $authval->{authorised_value};
 118         }
 119     }
 120 }
 121
 122 my @class_sources = Koha::ClassSources->search({ used => 1 });
 123 my $pref_class = C4::Context->preference("DefaultClassificationSource");
 124
 125
 126 $template->param(
 127     authorised_values        => \@authorised_value_list,
 128     today                    => dt_from_string,
 129     minlocation              => $minlocation,
 130     maxlocation              => $maxlocation,
 131     location                 => $location,
 132     ignoreissued             => $ignoreissued,
 133     branchcode               => $branchcode,
 134     branch                   => $branch,
 135     datelastseen             => $datelastseen,
 136     compareinv2barcd         => $compareinv2barcd,
 137     uploadedbarcodesflag     => $uploadbarcodes ? 1 : 0,
 138     ignore_waiting_holds     => $ignore_waiting_holds,
 139     class_sources            => \@class_sources,
 140     pref_class               => $pref_class
 141 );
 142
 143 # Walk through uploaded barcodes, report errors, mark as seen, check in
 144 my $results = {};
 145 my @scanned_items;
 146 my @errorloop;
 147 my $moddatecount = 0;
 148 if ( $uploadbarcodes && length($uploadbarcodes) > 0 ) {
 149     my $dbh = C4::Context->dbh;
 150     my $date = dt_from_string( scalar $input->param('setdate') );
 151     $date = output_pref ( { dt => $date, dateformat => 'iso' } );
 152
 153     my $strsth  = "select * from issues, items where items.itemnumber=issues.itemnumber and items.barcode =?";
 154     my $qonloan = $dbh->prepare($strsth);
 155     $strsth="select * from items where items.barcode =? and items.withdrawn = 1";
 156     my $qwithdrawn = $dbh->prepare($strsth);
 157
 158     my @barcodes;
 159     my @uploadedbarcodes;
 160
 161     my $sth = $dbh->column_info(undef,undef,"items","barcode");
 162     my $barcode_def = $sth->fetchall_hashref('COLUMN_NAME');
 163     my $barcode_size = $barcode_def->{barcode}->{COLUMN_SIZE};
 164     my $err_length=0;
 165     my $err_data=0;
 166     my $lines_read=0;
 167     binmode($uploadbarcodes, ":encoding(UTF-8)");
 168     while (my $barcode=<$uploadbarcodes>) {
 169         my $split_chars = C4::Context->preference('BarcodeSeparators');
 170         push @uploadedbarcodes, grep { /\S/ } split( /[$split_chars]/, $barcode );
 171     }
 172     for my $barcode (@uploadedbarcodes) {
 173         next unless $barcode;
 174         ++$lines_read;
 175         if (length($barcode)>$barcode_size) {
 176             $err_length += 1;
 177         }
 178         my $check_barcode = $barcode;
 179         $check_barcode =~ s/\p{Print}//g;
 180         if (length($check_barcode)>0) { # Only printable unicode characters allowed.
 181             $err_data += 1;
 182         }
 183         next if length($barcode)>$barcode_size;
 184         next if ( length($check_barcode)>0 );
 185         push @barcodes,$barcode;
 186     }
 187     $template->param( LinesRead => $lines_read );
 188     if (! @barcodes) {
 189         push @errorloop, {'barcode'=>'No valid barcodes!'};
 190         $op=''; # force the initial inventory screen again.
 191     }
 192     else {
 193         $template->param( err_length => $err_length,
 194                           err_data   => $err_data );
 195     }
 196     foreach my $barcode (@barcodes) {
 197         if ( $qwithdrawn->execute($barcode) && $qwithdrawn->rows ) {
 198             push @errorloop, { 'barcode' => $barcode, 'ERR_WTHDRAWN' => 1 };
 199         } else {
 200             my $item = Koha::Items->find({barcode => $barcode});
 201             if ( $item ) {
 202                 # Modify date last seen for scanned items, remove lost status
 203                 $item->set({ itemlost => 0, datelastseen => $date })->store;
 204                 my $item_unblessed = $item->unblessed;
 205                 $moddatecount++;
 206                 unless ( $dont_checkin ) {
 207                     $qonloan->execute($barcode);
 208                     if ($qonloan->rows){
 209                         my $data = $qonloan->fetchrow_hashref;
 210                         my ($doreturn, $messages, $iteminformation, $borrower) =AddReturn($barcode, $data->{homebranch});
 211                         if( $doreturn ) {
 212                             $item_unblessed->{onloan} = undef;
 213                             $item_unblessed->{datelastseen} = dt_from_string;
 214                         } else {
 215                             push @errorloop, { barcode => $barcode, ERR_ONLOAN_NOT_RET => 1 };
 216                         }
 217                     }
 218                 }
 219                 push @scanned_items, $item_unblessed;
 220             } else {
 221                 push @errorloop, { barcode => $barcode, ERR_BARCODE => 1 };
 222             }
 223         }
 224     }
 225     $template->param( date => $date );
 226     $template->param( errorloop => \@errorloop ) if (@errorloop);
 227 }
 228
 229 # Build inventorylist: used as result list when you do not pass barcodes
 230 # This list is also used when you want to compare with barcodes
 231 my ( $inventorylist, $rightplacelist );
 232 if ( $op && ( !$uploadbarcodes || $compareinv2barcd )) {
 233     ( $inventorylist ) = GetItemsForInventory({
 234       minlocation  => $minlocation,
 235       maxlocation  => $maxlocation,
 236       class_source => $class_source,
 237       location     => $location,
 238       ignoreissued => $ignoreissued,
 239       datelastseen => $datelastseen,
 240       branchcode   => $branchcode,
 241       branch       => $branch,
 242       offset       => 0,
 243       statushash   => $staton,
 244       ignore_waiting_holds => $ignore_waiting_holds,
 245     });
 246 }
 247 # Build rightplacelist used to check if a scanned item is in the right place.
 248 if( @scanned_items ) {
 249     ( $rightplacelist ) = GetItemsForInventory({
 250       minlocation  => $minlocation,
 251       maxlocation  => $maxlocation,
 252       class_source => $class_source,
 253       location     => $location,
 254       ignoreissued => undef,
 255       datelastseen => undef,
 256       branchcode   => $branchcode,
 257       branch       => $branch,
 258       offset       => 0,
 259       statushash   => undef,
 260       ignore_waiting_holds => $ignore_waiting_holds,
 261     });
 262     # Convert the structure to a hash on barcode
 263     $rightplacelist = {
 264         map { $_->{barcode} ? ( $_->{barcode}, $_ ) : (); } @$rightplacelist
 265     };
 266 }
 267
 268 # Report scanned items that are on the wrong place, or have a wrong notforloan
 269 # status, or are still checked out.
 270 for ( my $i = 0; $i < @scanned_items; $i++ ) {
 271
 272     my $item = $scanned_items[$i];
 273
 274     $item->{notforloancode} = $item->{notforloan}; # save for later use
 275     my $fc = $item->{'frameworkcode'} || '';
 276
 277     # Populating with authorised values description
 278     foreach my $field (qw/ location notforloan itemlost damaged withdrawn /) {
 279         my $av = Koha::AuthorisedValues->get_description_by_koha_field(
 280             { frameworkcode => $fc, kohafield => "items.$field", authorised_value => $item->{$field} } );
 281         if ( $av and defined $item->{$field} and defined $av->{lib} ) {
 282             $item->{$field} = $av->{lib};
 283         }
 284     }
 285
 286     # If we have scanned items with a non-matching notforloan value
 287     if( none { $item->{'notforloancode'} eq $_ } @notforloans ) {
 288         $item->{problems}->{changestatus} = 1;
 289         additemtoresults( $item, $results );
 290     }
 291
 292     # Check for items shelved out of order
 293     if ($out_of_order) {
 294         unless ( $i == 0 ) {
 295             my $previous_item = $scanned_items[ $i - 1 ];
 296             if ( $previous_item && $item->{cn_sort} lt $previous_item->{cn_sort} ) {
 297                 $item->{problems}->{out_of_order} = 1;
 298                 additemtoresults( $item, $results );
 299             }
 300         }
 301         unless ( $i == scalar(@scanned_items) ) {
 302             my $next_item = $scanned_items[ $i + 1 ];
 303             if ( $next_item && $item->{cn_sort} gt $next_item->{cn_sort} ) {
 304                 $item->{problems}->{out_of_order} = 1;
 305                 additemtoresults( $item, $results );
 306             }
 307         }
 308     }
 309
 310     # Report an item that is checked out (unusual!) or wrongly placed
 311     if( $item->{onloan} ) {
 312         $item->{problems}->{checkedout} = 1;
 313         additemtoresults( $item, $results );
 314         next; # do not modify item
 315     } elsif( !exists $rightplacelist->{ $item->{barcode} } ) {
 316         $item->{problems}->{wrongplace} = 1;
 317         additemtoresults( $item, $results );
 318     }
 319 }
 320
 321 # Compare barcodes with inventory list, report no_barcode and not_scanned.
 322 # not_scanned can be interpreted as missing
 323 if ( $compareinv2barcd ) {
 324     my @scanned_barcodes = map {$_->{barcode}} @scanned_items;
 325     for my $item ( @$inventorylist ) {
 326         my $barcode = $item->{barcode};
 327         if( !$barcode ) {
 328             $item->{problems}->{no_barcode} = 1;
 329         } elsif ( grep { $_ eq $barcode } @scanned_barcodes ) {
 330             next;
 331         } else {
 332             $item->{problems}->{not_scanned} = 1;
 333         }
 334         additemtoresults( $item, $results );
 335     }
 336 }
 337
 338 # Construct final results, add biblio information
 339 my $loop = $uploadbarcodes
 340     ? [ map { $results->{$_} } keys %$results ]
 341     : $inventorylist // [];
 342 for my $item ( @$loop ) {
 343     my $biblio = Koha::Biblios->find( $item->{biblionumber} );
 344     $item->{title} = $biblio->title;
 345     $item->{author} = $biblio->author;
 346 }
 347
 348 $template->param(
 349     moddatecount => $moddatecount,
 350     loop         => $loop,
 351     op           => $op,
 352 );
 353
 354 # Export to csv
 355 if (defined $input->param('CSVexport') && $input->param('CSVexport') eq 'on'){
 356     eval {use Text::CSV};
 357     my $csv = Text::CSV->new or
 358             die Text::CSV->error_diag ();
 359     binmode STDOUT, ":encoding(UTF-8)";
 360     print $input->header(
 361         -type       => 'text/csv',
 362         -attachment => 'inventory.csv',
 363     );
 364
 365     my $columns_def_hashref = C4::Reports::Guided::_get_column_defs($input);
 366     foreach my $key ( keys %$columns_def_hashref ) {
 367         my $initkey = $key;
 368         $key =~ s/[^\.]*\.//;
 369         $columns_def_hashref->{$initkey}=NormalizeString($columns_def_hashref->{$initkey} // '');
 370         $columns_def_hashref->{$key} = $columns_def_hashref->{$initkey};
 371     }
 372
 373     my @translated_keys;
 374     for my $key (qw / biblioitems.title    biblio.author
 375                       items.barcode        items.itemnumber
 376                       items.homebranch     items.location
 377                       items.itemcallnumber items.notforloan
 378                       items.itemlost       items.damaged
 379                       items.withdrawn      items.stocknumber
 380                       / ) {
 381        push @translated_keys, $columns_def_hashref->{$key};
 382     }
 383     push @translated_keys, 'problem' if $uploadbarcodes;
 384
 385     $csv->combine(@translated_keys);
 386     print $csv->string, "\n";
 387
 388     my @keys = qw/ title author barcode itemnumber homebranch location itemcallnumber notforloan itemlost damaged withdrawn stocknumber /;
 389     for my $item ( @$loop ) {
 390         my @line;
 391         for my $key (@keys) {
 392             push @line, $item->{$key};
 393         }
 394         my $errstr = '';
 395         foreach my $key ( keys %{$item->{problems}} ) {
 396             if( $key eq 'wrongplace' ) {
 397                 $errstr .= "wrong place,";
 398             } elsif( $key eq 'changestatus' ) {
 399                 $errstr .= "unknown notforloan status,";
 400             } elsif( $key eq 'not_scanned' ) {
 401                 $errstr .= "missing,";
 402             } elsif( $key eq 'no_barcode' ) {
 403                 $errstr .= "no barcode,";
 404             } elsif( $key eq 'checkedout' ) {
 405                 $errstr .= "checked out,";
 406             }
 407         }
 408         $errstr =~ s/,$//;
 409         push @line, $errstr;
 410         $csv->combine(@line);
 411         print $csv->string, "\n";
 412     }
 413     # Adding not found barcodes
 414     foreach my $error (@errorloop) {
 415         my @line;
 416         if ($error->{'ERR_BARCODE'}) {
 417             push @line, map { $_ eq 'barcode' ? $error->{'barcode'} : ''} @keys;
 418             push @line, "barcode not found";
 419             $csv->combine(@line);
 420             print $csv->string, "\n";
 421         }
 422     }
 423     exit;
 424 }
 425
 426 output_html_with_http_headers $input, $cookie, $template->output;
 427
 428 sub additemtoresults {
 429     my ( $item, $results ) = @_;
 430     my $itemno = $item->{itemnumber};
 431     # since the script appends to $item, we can just overwrite the hash entry
 432     $results->{$itemno} = $item;
 433 }