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 strict;
  22 use warnings;
  23
  24 #need to open cgi and get the fh before anything else opens a new cgi context (see C4::Auth)
  25 use CGI qw ( -utf8 );
  26 my $input = CGI->new;
  27 my $uploadbarcodes = $input->param('uploadbarcodes');
  28
  29 use C4::Auth;
  30 use C4::Context;
  31 use C4::Output;
  32 use C4::Biblio;
  33 use C4::Items;
  34 use C4::Koha;
  35 use C4::Branch; # GetBranches
  36 use C4::Circulation;
  37 use C4::Reports::Guided;    #_get_column_defs
  38 use C4::Charset;
  39 use Koha::DateUtils;
  40 use List::MoreUtils qw( none );
  41
  42
  43 my $minlocation=$input->param('minlocation') || '';
  44 my $maxlocation=$input->param('maxlocation');
  45 $maxlocation=$minlocation.'Z' unless ( $maxlocation || ! $minlocation );
  46 my $location=$input->param('location') || '';
  47 my $itemtype=$input->param('itemtype'); # FIXME note, template does not currently supply this
  48 my $ignoreissued=$input->param('ignoreissued');
  49 my $datelastseen = $input->param('datelastseen');
  50 my $markseen = $input->param('markseen');
  51 my $branchcode = $input->param('branchcode') || '';
  52 my $branch     = $input->param('branch');
  53 my $op         = $input->param('op');
  54 my $compareinv2barcd = $input->param('compareinv2barcd');
  55 my $dont_checkin = $input->param('dont_checkin');
  56
  57 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  58     {   template_name   => "tools/inventory.tt",
  59         query           => $input,
  60         type            => "intranet",
  61         authnotrequired => 0,
  62         flagsrequired   => { tools => 'inventory' },
  63         debug           => 1,
  64     }
  65 );
  66
  67 my @authorised_value_list;
  68 my $authorisedvalue_categories = '';
  69
  70 my $frameworks = getframeworks();
  71 $frameworks->{''} = {frameworkcode => ''}; # Add the default framework
  72
  73 for my $fwk (keys %$frameworks){
  74   my $fwkcode = $frameworks->{$fwk}->{'frameworkcode'};
  75   my $authcode = GetAuthValCode('items.location', $fwkcode);
  76     if ($authcode && $authorisedvalue_categories!~/\b$authcode\W/){
  77       $authorisedvalue_categories.="$authcode ";
  78       my $data=GetAuthorisedValues($authcode);
  79       foreach my $value (@$data){
  80         $value->{selected}=1 if ($value->{authorised_value} eq ($location));
  81       }
  82       push @authorised_value_list,@$data;
  83     }
  84 }
  85
  86 my $statuses = [];
  87 for my $statfield (qw/items.notforloan items.itemlost items.withdrawn items.damaged/){
  88     my $hash = {};
  89     $hash->{fieldname} = $statfield;
  90     $hash->{authcode} = GetAuthValCode($statfield);
  91     if ($hash->{authcode}){
  92         my $arr = GetAuthorisedValues($hash->{authcode});
  93         $hash->{values} = $arr;
  94         push @$statuses, $hash;
  95     }
  96 }
  97
  98
  99 $template->param( statuses => $statuses );
 100 my $staton = {};                                #authorized values that are ticked
 101 for my $authvfield (@$statuses) {
 102     $staton->{$authvfield->{fieldname}} = [];
 103     for my $authval (@{$authvfield->{values}}){
 104         if ( defined $input->param('status-' . $authvfield->{fieldname} . '-' . $authval->{authorised_value}) && $input->param('status-' . $authvfield->{fieldname} . '-' . $authval->{authorised_value}) eq 'on' ){
 105             push @{$staton->{$authvfield->{fieldname}}}, $authval->{authorised_value};
 106         }
 107     }
 108 }
 109
 110 my $notforloanlist;
 111 my $statussth = '';
 112 for my $authvfield (@$statuses) {
 113     if ( scalar @{$staton->{$authvfield->{fieldname}}} > 0 ){
 114         my $joinedvals = join ',', @{$staton->{$authvfield->{fieldname}}};
 115         $statussth .= "$authvfield->{fieldname} in ($joinedvals) and ";
 116         $notforloanlist = $joinedvals if ($authvfield->{fieldname} eq "items.notforloan");
 117     }
 118 }
 119 $statussth =~ s, and $,,g;
 120 $template->param(
 121     authorised_values        => \@authorised_value_list,
 122     today                    => dt_from_string,
 123     minlocation              => $minlocation,
 124     maxlocation              => $maxlocation,
 125     location                 => $location,
 126     ignoreissued             => $ignoreissued,
 127     branchcode               => $branchcode,
 128     branch                   => $branch,
 129     datelastseen             => $datelastseen,
 130     compareinv2barcd         => $compareinv2barcd,
 131     notforloanlist           => $notforloanlist
 132 );
 133
 134 my @notforloans;
 135 if (defined $notforloanlist) {
 136     @notforloans = split(/,/, $notforloanlist);
 137 }
 138
 139 my @scanned_items;
 140 my @errorloop;
 141 if ( $uploadbarcodes && length($uploadbarcodes) > 0 ) {
 142     my $dbh = C4::Context->dbh;
 143     my $date = dt_from_string( scalar $input->param('setdate') );
 144     $date = output_pref ( { dt => $date, dateformat => 'iso' } );
 145
 146     my $strsth  = "select * from issues, items where items.itemnumber=issues.itemnumber and items.barcode =?";
 147     my $qonloan = $dbh->prepare($strsth);
 148     $strsth="select * from items where items.barcode =? and items.withdrawn = 1";
 149     my $qwithdrawn = $dbh->prepare($strsth);
 150
 151     my $count = 0;
 152
 153     my @barcodes;
 154     my @uploadedbarcodes;
 155
 156     my $sth = $dbh->column_info(undef,undef,"items","barcode");
 157     my $barcode_def = $sth->fetchall_hashref('COLUMN_NAME');
 158     my $barcode_size = $barcode_def->{barcode}->{COLUMN_SIZE};
 159     my $err_length=0;
 160     my $err_data=0;
 161     my $lines_read=0;
 162     binmode($uploadbarcodes, ":encoding(UTF-8)");
 163     while (my $barcode=<$uploadbarcodes>) {
 164         $barcode =~ s/\r/\n/g;
 165         $barcode =~ s/\n\n/\n/g;
 166         my @data = split(/\n/,$barcode);
 167         push @uploadedbarcodes, @data;
 168     }
 169     for my $barcode (@uploadedbarcodes) {
 170         next unless $barcode;
 171         ++$lines_read;
 172         if (length($barcode)>$barcode_size) {
 173             $err_length += 1;
 174         }
 175         my $check_barcode = $barcode;
 176         $check_barcode =~ s/\p{Print}//g;
 177         if (length($check_barcode)>0) { # Only printable unicode characters allowed.
 178             $err_data += 1;
 179         }
 180         next if length($barcode)>$barcode_size;
 181         next if ( length($check_barcode)>0 );
 182         push @barcodes,$barcode;
 183     }
 184     $template->param( LinesRead => $lines_read );
 185     if (! @barcodes) {
 186         push @errorloop, {'barcode'=>'No valid barcodes!'};
 187         $op=''; # force the initial inventory screen again.
 188     }
 189     else {
 190         $template->param( err_length => $err_length,
 191                           err_data   => $err_data );
 192     }
 193     foreach my $barcode (@barcodes) {
 194         if ( $qwithdrawn->execute($barcode) && $qwithdrawn->rows ) {
 195             push @errorloop, { 'barcode' => $barcode, 'ERR_WTHDRAWN' => 1 };
 196         } else {
 197             my $item = GetItem( '', $barcode );
 198             if ( defined $item && $item->{'itemnumber'} ) {
 199                 ModItem( { datelastseen => $date }, undef, $item->{'itemnumber'} );
 200                 push @scanned_items, $item;
 201                 $count++;
 202                 unless ( $dont_checkin ) {
 203                     $qonloan->execute($barcode);
 204                     if ($qonloan->rows){
 205                         my $data = $qonloan->fetchrow_hashref;
 206                         my ($doreturn, $messages, $iteminformation, $borrower) =AddReturn($barcode, $data->{homebranch});
 207                         if ($doreturn){
 208                             push @errorloop, {'barcode'=>$barcode,'ERR_ONLOAN_RET'=>1}
 209                         } else {
 210                             push @errorloop, {'barcode'=>$barcode,'ERR_ONLOAN_NOT_RET'=>1}
 211                         }
 212                     }
 213                 }
 214             } else {
 215                 push @errorloop, {'barcode'=>$barcode,'ERR_BARCODE'=>1};
 216             }
 217         }
 218
 219     }
 220
 221     $template->param( date => $date, Number => $count );
 222     $template->param( errorloop => \@errorloop ) if (@errorloop);
 223 }
 224
 225 # now build the result list: inventoried items if requested, and mis-placed items -always-
 226 my $inventorylist;
 227 my $wrongplacelist;
 228 my @items_with_problems;
 229 if ( $markseen or $op ) {
 230     # retrieve all items in this range.
 231     my $totalrecords;
 232
 233     # We use datelastseen only when comparing the results to the barcode file.
 234     my $paramdatelastseen = ($compareinv2barcd) ? $datelastseen : '';
 235     ($inventorylist, $totalrecords) = GetItemsForInventory( {
 236       minlocation  => $minlocation,
 237       maxlocation  => $maxlocation,
 238       location     => $location,
 239       itemtype     => $itemtype,
 240       ignoreissued => $ignoreissued,
 241       datelastseen => $paramdatelastseen,
 242       branchcode   => $branchcode,
 243       branch       => $branch,
 244       offset       => 0,
 245       size         => undef,
 246       statushash   => $staton,
 247       interface    => 'staff',
 248     } );
 249
 250     # For the items that may be marked as "wrong place", we only check the location (callnumbers, location and branch)
 251     ($wrongplacelist, $totalrecords) = GetItemsForInventory( {
 252       minlocation  => $minlocation,
 253       maxlocation  => $maxlocation,
 254       location     => $location,
 255       itemtype     => undef,
 256       ignoreissued => undef,
 257       datelastseen => undef,
 258       branchcode   => $branchcode,
 259       branch       => $branch,
 260       offset       => 0,
 261       size         => undef,
 262       statushash   => undef,
 263       interface    => 'staff',
 264     } );
 265
 266 }
 267
 268 # If "compare barcodes list to results" has been checked, we want to alert for missing items
 269 if ( $compareinv2barcd ) {
 270     # set "missing" flags for all items with a datelastseen (dls) before the chosen datelastseen (cdls)
 271     my $dls = output_pref( { dt => dt_from_string( $datelastseen ),
 272                              dateformat => 'iso' } );
 273     foreach my $item ( @$inventorylist ) {
 274         my $cdls = output_pref( { dt => dt_from_string( $item->{datelastseen} ),
 275                                   dateformat => 'iso' } );
 276         if ( $cdls lt $dls ) {
 277             $item->{problem} = 'missingitem';
 278             # We have to push a copy of the item, not the reference
 279             push @items_with_problems, { %$item };
 280         }
 281     }
 282 }
 283
 284
 285
 286 # insert "wrongplace" to all scanned items that are not supposed to be in this range
 287 # note this list is always displayed, whatever the librarian has chosen for comparison
 288 my $moddatecount = 0;
 289 foreach my $item ( @scanned_items ) {
 290
 291   # Saving notforloan code before it's replaced by it's authorised value for later comparison
 292   $item->{notforloancode} = $item->{notforloan};
 293
 294   # Populating with authorised values
 295   foreach my $field ( keys %$item ) {
 296         # If the koha field is mapped to a marc field
 297         my $fc = $item->{'frameworkcode'} || '';
 298         my ($f, $sf) = GetMarcFromKohaField("items.$field", $fc);
 299         if ($f and $sf) {
 300             # We replace the code with it's description
 301             my $authvals = C4::Koha::GetKohaAuthorisedValuesFromField($f, $sf, $fc);
 302             if ($authvals and defined $item->{$field} and defined $authvals->{$item->{$field}}) {
 303               $item->{$field} = $authvals->{$item->{$field}};
 304             }
 305         }
 306     }
 307
 308     next if $item->{onloan}; # skip checked out items
 309
 310     # If we have scanned items with a non-matching notforloan value
 311     if (none { $item->{'notforloancode'} eq $_ } @notforloans) {
 312         $item->{problem} = 'changestatus';
 313         push @items_with_problems, { %$item };
 314     }
 315     if (none { $item->{barcode} eq $_->{barcode} && !$_->{'onloan'} } @$wrongplacelist) {
 316         $item->{problem} = 'wrongplace';
 317         push @items_with_problems, { %$item };
 318     }
 319
 320     # Modify date last seen for scanned items
 321     ModDateLastSeen($item->{'itemnumber'});
 322     $moddatecount++;
 323 }
 324
 325 if ( $compareinv2barcd ) {
 326     my @scanned_barcodes = map {$_->{barcode}} @scanned_items;
 327     for my $should_be_scanned ( @$inventorylist ) {
 328         my $barcode = $should_be_scanned->{barcode};
 329         unless ( grep /^$barcode$/, @scanned_barcodes ) {
 330             $should_be_scanned->{problem} = 'not_scanned';
 331             push @items_with_problems, { %$should_be_scanned };
 332         }
 333     }
 334 }
 335
 336 for my $item ( @items_with_problems ) {
 337     my $biblio = C4::Biblio::GetBiblioData($item->{biblionumber});
 338     $item->{title} = $biblio->{title};
 339     $item->{author} = $biblio->{author};
 340 }
 341
 342 # If a barcode file is given, we want to show problems, else all items
 343 my @results;
 344 @results = $uploadbarcodes
 345             ? @items_with_problems
 346             : $op
 347                 ? @$inventorylist
 348                 : ();
 349
 350 $template->param(
 351     moddatecount => $moddatecount,
 352     loop       => \@results,
 353     op         => $op
 354 );
 355
 356 if (defined $input->param('CSVexport') && $input->param('CSVexport') eq 'on'){
 357     eval {use Text::CSV};
 358     my $csv = Text::CSV->new or
 359             die Text::CSV->error_diag ();
 360     binmode STDOUT, ":encoding(UTF-8)";
 361     print $input->header(
 362         -type       => 'text/csv',
 363         -attachment => 'inventory.csv',
 364     );
 365
 366     my $columns_def_hashref = C4::Reports::Guided::_get_column_defs($input);
 367     foreach my $key ( keys %$columns_def_hashref ) {
 368         my $initkey = $key;
 369         $key =~ s/[^\.]*\.//;
 370         $columns_def_hashref->{$initkey}=NormalizeString($columns_def_hashref->{$initkey} // '');
 371         $columns_def_hashref->{$key} = $columns_def_hashref->{$initkey};
 372     }
 373
 374     my @translated_keys;
 375     for my $key (qw / biblioitems.title    biblio.author
 376                       items.barcode        items.itemnumber
 377                       items.homebranch     items.location
 378                       items.itemcallnumber items.notforloan
 379                       items.itemlost       items.damaged
 380                       items.withdrawn      items.stocknumber
 381                       / ) {
 382        push @translated_keys, $columns_def_hashref->{$key};
 383     }
 384     push @translated_keys, 'problem' if $uploadbarcodes;
 385
 386     $csv->combine(@translated_keys);
 387     print $csv->string, "\n";
 388
 389     my @keys = qw / title author barcode itemnumber homebranch location itemcallnumber notforloan lost damaged withdrawn stocknumber /;
 390     for my $item ( @results ) {
 391         my @line;
 392         for my $key (@keys) {
 393             push @line, $item->{$key};
 394         }
 395         if ( defined $item->{problem} ) {
 396             if ( $item->{problem} eq 'wrongplace' ) {
 397                 push @line, "wrong place";
 398             } elsif ( $item->{problem} eq 'missingitem' ) {
 399                 push @line, "missing item";
 400             } elsif ( $item->{problem} eq 'changestatus' ) {
 401                 push @line, "change item status";
 402             } elsif ($item->{problem} eq 'not_scanned' ) {
 403                 push @line, "item not scanned";
 404             }
 405         }
 406         $csv->combine(@line);
 407         print $csv->string, "\n";
 408     }
 409     # Adding not found barcodes
 410     foreach my $error (@errorloop) {
 411         my @line;
 412         if ($error->{'ERR_BARCODE'}) {
 413             push @line, map { $_ eq 'barcode' ? $error->{'barcode'} : ''} @keys;
 414             push @line, "barcode not found";
 415             $csv->combine(@line);
 416             print $csv->string, "\n";
 417         }
 418     }
 419     exit;
 420 }
 421
 422 output_html_with_http_headers $input, $cookie, $template->output;