Merge commit 'kc/master'
[koha.git] / tools / batchMod.pl
index 47de0e9..abeaf15 100755 (executable)
 # 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., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# 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.
 
 use CGI;
 use strict;
+#use warnings; FIXME - Bug 2505
 use C4::Auth;
 use C4::Output;
 use C4::Biblio;
@@ -27,47 +28,46 @@ use C4::Items;
 use C4::Context;
 use C4::Koha; # XXX subfield_is_koha_internal_p
 use C4::Branch; # XXX subfield_is_koha_internal_p
+use C4::BackgroundJob;
 use C4::ClassSource;
 use C4::Dates;
 use C4::Debug;
-use YAML;
 use Switch;
 use MARC::File::XML;
 
-sub find_value {
-    my ($tagfield,$insubfield,$record) = @_;
-    my $result;
-    my $indicator;
-    foreach my $field ($record->field($tagfield)) {
-        my @subfields = $field->subfields();
-        foreach my $subfield (@subfields) {
-            if (@$subfield[0] eq $insubfield) {
-                $result .= @$subfield[1];
-                $indicator = $field->indicator(1).$field->indicator(2);
-            }
-        }
-    }
-    return($indicator,$result);
-}
-
-
 my $input = new CGI;
 my $dbh = C4::Context->dbh;
 my $error        = $input->param('error');
 my @itemnumbers  = $input->param('itemnumber');
 my $op           = $input->param('op');
+my $del          = $input->param('del');
+my $completedJobID = $input->param('completedJobID');
+my $runinbackground = $input->param('runinbackground');
+
+
+my $template_name;
+my $template_flag;
+if (!defined $op) {
+    $template_name = "tools/batchMod.tmpl";
+    $template_flag = { tools => '*' };
+} else {
+    $template_name = ($del) ? "tools/batchMod-del.tmpl" : "tools/batchMod-edit.tmpl";
+    $template_flag = ($del) ? { tools => 'items_batchdel' }   : { tools => 'items_batchmod' };
+}
+
 
 my ($template, $loggedinuser, $cookie)
-    = get_template_and_user({template_name => "tools/batchMod.tmpl",
+    = get_template_and_user({template_name => $template_name,
                  query => $input,
                  type => "intranet",
                  authnotrequired => 0,
-                 flagsrequired => {editcatalogue => 1},
+                 flagsrequired => $template_flag,
                  });
 
 
 my $today_iso = C4::Dates->today('iso');
 $template->param(today_iso => $today_iso);
+$template->param(del       => $del);
 
 my $itemrecord;
 my $nextop="";
@@ -76,6 +76,15 @@ my $items_display_hashref;
 my $frameworkcode="";
 my $tagslib = &GetMarcStructure(1,$frameworkcode);
 
+my $deleted_items = 0;     # Numbers of deleted items
+my $not_deleted_items = 0; # Numbers of items that could not be deleted
+my @not_deleted;           # List of the itemnumbers that could not be deleted
+
+my %cookies = parse CGI::Cookie($cookie);
+my $sessionID = $cookies{'CGISESSID'}->value;
+my $dbh = C4::Context->dbh;
+
+
 #--- ----------------------------------------------------------------------------
 if ($op eq "action") {
 #-------------------------------------------------------------------------------
@@ -85,28 +94,70 @@ if ($op eq "action") {
     # build indicator hash.
     my @ind_tag   = $input->param('ind_tag');
     my @indicator = $input->param('indicator');
-    my $xml = TransformHtmlToXml(\@tags,\@subfields,\@values,\@indicator,\@ind_tag, 'ITEM');
-    my $marcitem = MARC::Record::new_from_xml($xml, 'UTF-8');
-    my $localitem = TransformMarcToKoha( $dbh, $marcitem, "", 'items' );
 
-#      my @params=$input->param();
-#      warn @params;
-#    my $marcitem = TransformHtmlToMarc(\@params,$input);
+    # Is there something to modify ?
+    # TODO : We shall use this var to warn the user in case no modification was done to the items
+    my $something_to_modify = scalar(grep {!/^$/} @values);
+
+    # Once the job is done
+    if ($completedJobID) {
+       # If we have a reasonable amount of items, we display them
+       if (scalar(@itemnumbers) <= 1000) {
+           $items_display_hashref=BuildItemsData(@itemnumbers);
+       } else {
+           # Else, we only display the barcode
+           my @simple_items_display = map {{ itemnumber => $_, barcode => (GetBarcodeFromItemnumber($_) or ""), biblionumber => (GetBiblionumberFromItemnumber($_) or "") }} @itemnumbers;
+           $template->param("simple_items_display" => \@simple_items_display);
+       }
+
+       # Setting the job as done
+       my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
+
+       # Calling the template
+        add_saved_job_results_to_template($template, $completedJobID);
+
+    # While the job is getting done
+    } else {
+
+       # Job size is the number of items we have to process
+       my $job_size = scalar(@itemnumbers);
+       my $job = undef;
+       my $callback = sub {};
+
+       # If we asked for background processing
+       if ($runinbackground) {
+           $job = put_in_background($job_size);
+           $callback = progress_callback($job, $dbh);
+       }
+
+       # For each item
+       my $i = 1; 
        foreach my $itemnumber(@itemnumbers){
+
+               $job->progress($i) if $runinbackground;
                my $itemdata=GetItem($itemnumber);
                if ($input->param("del")){
-                       DelItemCheck(C4::Context->dbh, $itemdata->{'biblionumber'}, $itemdata->{'itemnumber'})
+                       my $return = DelItemCheck(C4::Context->dbh, $itemdata->{'biblionumber'}, $itemdata->{'itemnumber'});
+                       if ($return == 1) {
+                           $deleted_items++;
+                       } else {
+                           $not_deleted_items++;
+                           push @not_deleted, { biblionumber => $itemdata->{'biblionumber'}, itemnumber => $itemdata->{'itemnumber'}, barcode => $itemdata->{'barcode'}, title => $itemdata->{'title'}, $return => 1 };
+                       }
                } else {
+                   if ($something_to_modify) {
+                       my $xml = TransformHtmlToXml(\@tags,\@subfields,\@values,\@indicator,\@ind_tag, 'ITEM');
+                       my $marcitem = MARC::Record::new_from_xml($xml, 'UTF-8');
+                       my $localitem = TransformMarcToKoha( $dbh, $marcitem, "", 'items' );
                        my $localmarcitem=Item2Marc($itemdata);
                        UpdateMarcWith($marcitem,$localmarcitem);
-            eval{my ($oldbiblionumber,$oldbibnum,$oldbibitemnum) = ModItemFromMarc($localmarcitem,$itemdata->{biblionumber},$itemnumber)};
-               #       eval{ModItem($localitem,$itemdata->{biblionumber},$itemnumber)};
+                       eval{my ($oldbiblionumber,$oldbibnum,$oldbibitemnum) = ModItemFromMarc($localmarcitem,$itemdata->{biblionumber},$itemnumber)};
+                   }
                }
+               $i++;
        }
-       $items_display_hashref=BuildItemsData(@itemnumbers);
-    $nextop="action";
+    }
 }
-
 #
 #-------------------------------------------------------------------------------
 # build screen with existing items. and "new" one
@@ -115,19 +166,27 @@ if ($op eq "action") {
 if ($op eq "show"){
        my $filefh = $input->upload('uploadfile');
        my $filecontent = $input->param('filecontent');
+       my @notfoundbarcodes;
 
     my @contentlist;
     if ($filefh){
         while (my $content=<$filefh>){
             chomp $content;
-            push @contentlist, $content;
+            push @contentlist, $content if $content;
         }
 
        switch ($filecontent) {
            case "barcode_file" {
-               push @itemnumbers,map{GetItemnumberFromBarcode($_)} @contentlist;
-               # Remove not found barcodes
-               @itemnumbers = grep(!/^$/, @itemnumbers);
+               foreach my $barcode (@contentlist) {
+
+                   my $itemnumber = GetItemnumberFromBarcode($barcode);
+                   if ($itemnumber) {
+                       push @itemnumbers,$itemnumber;
+                   } else {
+                       push @notfoundbarcodes, $barcode;
+                   }
+               }
+
            }
 
            case "itemid_file" {
@@ -137,77 +196,101 @@ if ($op eq "show"){
     } else {
        if ( my $list=$input->param('barcodelist')){
         push my @barcodelist, split(/\s\n/, $list);
-       push @itemnumbers,map{GetItemnumberFromBarcode($_)} @barcodelist;
-       # Remove not found barcodes
-       @itemnumbers = grep(!/^$/, @itemnumbers);
+
+       foreach my $barcode (@barcodelist) {
+
+           my $itemnumber = GetItemnumberFromBarcode($barcode);
+           if ($itemnumber) {
+               push @itemnumbers,$itemnumber;
+           } else {
+               push @notfoundbarcodes, $barcode;
+           }
+       }
 
     }
 }
+    # Only display the items if there are no more than 1000
+    if (scalar(@itemnumbers) <= 1000) {
        $items_display_hashref=BuildItemsData(@itemnumbers);
-
+    } else {
+       $template->param("too_many_items" => scalar(@itemnumbers));
+       # Even if we do not display the items, we need the itemnumbers
+       my @itemnumbers_hashref = map {{itemnumber => $_}} @itemnumbers;
+       $template->param("itemnumbers_hashref" => \@itemnumbers_hashref);
+    }
 # now, build the item form for entering a new item
 my @loop_data =();
 my $i=0;
 my $authorised_values_sth = $dbh->prepare("SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib");
 
 my $branches = GetBranchesLoop();  # build once ahead of time, instead of multiple times later.
+
+# Adding a default choice, in case the user does not want to modify the branch
+my $nochange_branch = { branchname => '', value => '', selected => 1 };
+unshift (@$branches, $nochange_branch);
+
 my $pref_itemcallnumber = C4::Context->preference('itemcallnumber');
 
+
 foreach my $tag (sort keys %{$tagslib}) {
-# loop through each subfield
-  foreach my $subfield (sort keys %{$tagslib->{$tag}}) {
-    next if subfield_is_koha_internal_p($subfield);
-    next if ($tagslib->{$tag}->{$subfield}->{'tab'} ne "10");
-    my %subfield_data;
+    # loop through each subfield
+    foreach my $subfield (sort keys %{$tagslib->{$tag}}) {
+       next if subfield_is_koha_internal_p($subfield);
+       next if ($tagslib->{$tag}->{$subfield}->{'tab'} ne "10");
+        # barcode and stocknumber are not meant to be batch-modified
+       next if $tagslib->{$tag}->{$subfield}->{'kohafield'} eq 'items.barcode';
+       next if $tagslib->{$tag}->{$subfield}->{'kohafield'} eq 'items.stocknumber';
+       my %subfield_data;
  
-    my $index_subfield = int(rand(1000000)); 
-    if ($subfield eq '@'){
-        $subfield_data{id} = "tag_".$tag."_subfield_00_".$index_subfield;
-    } else {
-        $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".$index_subfield;
-    }
-    $subfield_data{tag}        = $tag;
-    $subfield_data{subfield}   = $subfield;
-    $subfield_data{random}     = int(rand(1000000));    # why do we need 2 different randoms?
-#   $subfield_data{marc_lib}   = $tagslib->{$tag}->{$subfield}->{lib};
-    $subfield_data{marc_lib}   ="<span id=\"error$i\" title=\"".$tagslib->{$tag}->{$subfield}->{lib}."\">".$tagslib->{$tag}->{$subfield}->{lib}."</span>";
-    $subfield_data{mandatory}  = $tagslib->{$tag}->{$subfield}->{mandatory};
-    $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
-    my ($x,$value);
-    $value =~ s/"/&quot;/g;
-    unless ($value) {
-        $value = $tagslib->{$tag}->{$subfield}->{defaultvalue};
-        # get today date & replace YYYY, MM, DD if provided in the default value
-        my ( $year, $month, $day ) = split ',', $today_iso;     # FIXME: iso dates don't have commas!
-        $value =~ s/YYYY/$year/g;
-        $value =~ s/MM/$month/g;
-        $value =~ s/DD/$day/g;
-    }
-    $subfield_data{visibility} = "display:none;" if (($tagslib->{$tag}->{$subfield}->{hidden} > 4) || ($tagslib->{$tag}->{$subfield}->{hidden} < -4));
-    # testing branch value if IndependantBranches.
-
-    my $attributes_no_value = qq(tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="67" maxlength="255" );
-    my $attributes          = qq($attributes_no_value value="$value" );
-    if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
-      my @authorised_values;
-      my %authorised_lib;
-      # builds list, depending on authorised value...
+       my $index_subfield = int(rand(1000000)); 
+       if ($subfield eq '@'){
+           $subfield_data{id} = "tag_".$tag."_subfield_00_".$index_subfield;
+       } else {
+           $subfield_data{id} = "tag_".$tag."_subfield_".$subfield."_".$index_subfield;
+       }
+       $subfield_data{tag}        = $tag;
+       $subfield_data{subfield}   = $subfield;
+       $subfield_data{random}     = int(rand(1000000));    # why do we need 2 different randoms?
+    #   $subfield_data{marc_lib}   = $tagslib->{$tag}->{$subfield}->{lib};
+       $subfield_data{marc_lib}   ="<span id=\"error$i\" title=\"".$tagslib->{$tag}->{$subfield}->{lib}."\">".$tagslib->{$tag}->{$subfield}->{lib}."</span>";
+       $subfield_data{mandatory}  = $tagslib->{$tag}->{$subfield}->{mandatory};
+       $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
+       my ($x,$value);
+       $value =~ s/"/&quot;/g;
+       unless ($value) {
+           $value = $tagslib->{$tag}->{$subfield}->{defaultvalue};
+           # get today date & replace YYYY, MM, DD if provided in the default value
+           my ( $year, $month, $day ) = split ',', $today_iso;     # FIXME: iso dates don't have commas!
+           $value =~ s/YYYY/$year/g;
+           $value =~ s/MM/$month/g;
+           $value =~ s/DD/$day/g;
+       }
+       $subfield_data{visibility} = "display:none;" if (($tagslib->{$tag}->{$subfield}->{hidden} > 4) || ($tagslib->{$tag}->{$subfield}->{hidden} < -4));
+       # testing branch value if IndependantBranches.
+
+       my $attributes_no_value = qq(tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="67" maxlength="255" );
+       my $attributes          = qq($attributes_no_value value="$value" );
+
+       if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
+       my @authorised_values;
+       my %authorised_lib;
+       # builds list, depending on authorised value...
   
-      if ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "branches" ) {
-          foreach my $thisbranch (@$branches) {
-              push @authorised_values, $thisbranch->{value};
-              $authorised_lib{$thisbranch->{value}} = $thisbranch->{branchname};
-              $value = $thisbranch->{value} if $thisbranch->{selected};
-          }
-      }
-      elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
-          push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
-          my $sth = $dbh->prepare("select itemtype,description from itemtypes order by description");
-          $sth->execute;
-          while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
-              push @authorised_values, $itemtype;
-              $authorised_lib{$itemtype} = $description;
-          }
+       if ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "branches" ) {
+           foreach my $thisbranch (@$branches) {
+               push @authorised_values, $thisbranch->{value};
+               $authorised_lib{$thisbranch->{value}} = $thisbranch->{branchname};
+           }
+        $value = "";
+       }
+       elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
+           push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
+           my $sth = $dbh->prepare("select itemtype,description from itemtypes order by description");
+           $sth->execute;
+           while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
+               push @authorised_values, $itemtype;
+               $authorised_lib{$itemtype} = $description;
+           }
 
           #---- class_sources
       }
@@ -296,26 +379,44 @@ foreach my $tag (sort keys %{$tagslib}) {
     push (@loop_data, \%subfield_data);
     $i++
   }
-}
+} # -- End foreach tag
+
+
+    # what's the next op ? it's what we are not in : an add if we're editing, otherwise, and edit.
+    $template->param(item => \@loop_data);
+    if (@notfoundbarcodes) { 
+       my @notfoundbarcodesloop = map{{barcode=>$_}}@notfoundbarcodes;
+       $template->param(notfoundbarcodes => \@notfoundbarcodesloop);
+    }
+    $nextop="action"
+} # -- End action="show"
 
-# what's the next op ? it's what we are not in : an add if we're editing, otherwise, and edit.
-$template->param(
-    item             => \@loop_data,
-);
-$nextop="action"
-}
 $template->param(%$items_display_hashref) if $items_display_hashref;
 $template->param(
     op      => $nextop,
     $op => 1,
-    opisadd => ($nextop eq "saveitem") ? 0 : 1,
 );
+
+if ($op eq "action") {
+
+    #my @not_deleted_loop = map{{itemnumber=>$_}}@not_deleted;
+
+    $template->param(
+       not_deleted_items => $not_deleted_items,
+       deleted_items => $deleted_items,
+       not_deleted_loop => \@not_deleted 
+    );
+}
+
 foreach my $error (@errors) {
     $template->param($error => 1);
 }
 output_html_with_http_headers $input, $cookie, $template->output;
 exit;
 
+
+# ---------------- Functions
+
 sub BuildItemsData{
        my @itemnumbers=@_;
                # now, build existiing item list
@@ -327,7 +428,6 @@ sub BuildItemsData{
                foreach my $itemnumber (@itemnumbers){
                        my $itemdata=GetItem($itemnumber);
                        my $itemmarc=Item2Marc($itemdata);
-                       my $biblio=GetBiblioData($$itemdata{biblionumber});
                        my %this_row;
                        foreach my $field (grep {$_->tag() eq $itemtagfield} $itemmarc->fields()) {
                                # loop through each subfield
@@ -355,8 +455,12 @@ sub BuildItemsData{
                                        $this_row{itemnumber} = $subfvalue if ($tag eq $itemtagfield && $subfcode eq $itemtagsubfield);
                                }
                        }
-                       $this_row{0}=join("\n",@$biblio{qw(title author ISBN)});
-                       $witness{0}="&nbsp;";
+
+            # grab title, author, and ISBN to identify bib that the item
+            # belongs to in the display
+                       my $biblio=GetBiblioData($$itemdata{biblionumber});
+            $this_row{bibinfo} = join("\n", @$biblio{qw(title author ISBN)});
+
                        if (%this_row) {
                                push(@big_array, \%this_row);
                        }
@@ -374,11 +478,14 @@ sub BuildItemsData{
                        $row_data{itemnumber} = $row->{itemnumber};
                        #reporting this_row values
                        $row_data{'nomod'} = $row->{'nomod'};
+            $row_data{bibinfo} = $row->{bibinfo};
                        push(@item_value_loop,\%row_data);
                }
                my @header_loop=map { { header_value=> $witness{$_}} } @witnesscodessorted;
+
        return { item_loop        => \@item_value_loop, item_header_loop => \@header_loop };
 }
+
 #BE WARN : it is not the general case 
 # This function can be OK in the item marc record special case
 # Where subfield is not repeated
@@ -397,3 +504,82 @@ sub UpdateMarcWith($$){
     }
   #warn "TO edited:",$marcto->as_formatted;
 }
+
+sub find_value {
+    my ($tagfield,$insubfield,$record) = @_;
+    my $result;
+    my $indicator;
+    foreach my $field ($record->field($tagfield)) {
+        my @subfields = $field->subfields();
+        foreach my $subfield (@subfields) {
+            if (@$subfield[0] eq $insubfield) {
+                $result .= @$subfield[1];
+                $indicator = $field->indicator(1).$field->indicator(2);
+            }
+        }
+    }
+    return($indicator,$result);
+}
+
+# ----------------------------
+# Background functions
+
+
+sub add_results_to_template {
+    my $template = shift;
+    my $results = shift;
+    $template->param(map { $_ => $results->{$_} } keys %{ $results });
+}
+
+sub add_saved_job_results_to_template {
+    my $template = shift;
+    my $completedJobID = shift;
+    my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
+    my $results = $job->results();
+    add_results_to_template($template, $results);
+}
+
+sub put_in_background {
+    my $job_size = shift;
+
+    my $job = C4::BackgroundJob->new($sessionID, "test", $ENV{'SCRIPT_NAME'}, $job_size);
+    my $jobID = $job->id();
+
+    # fork off
+    if (my $pid = fork) {
+        # parent
+        # return job ID as JSON
+
+        # prevent parent exiting from
+        # destroying the kid's database handle
+        # FIXME: according to DBI doc, this may not work for Oracle
+        $dbh->{InactiveDestroy}  = 1;
+
+        my $reply = CGI->new("");
+        print $reply->header(-type => 'text/html');
+        print "{ jobID: '$jobID' }";
+        exit 0;
+    } elsif (defined $pid) {
+        # child
+        # close STDOUT to signal to Apache that
+        # we're now running in the background
+        close STDOUT;
+        close STDERR;
+    } else {
+        # fork failed, so exit immediately
+        warn "fork failed while attempting to run $ENV{'SCRIPT_NAME'} as a background job";
+        exit 0;
+    }
+    return $job;
+}
+
+sub progress_callback {
+    my $job = shift;
+    my $dbh = shift;
+    return sub {
+        my $progress = shift;
+        $job->progress($progress);
+    }
+}
+
+