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