Bug 19974: Make MarkLostItemsAsReturned multiple
[koha.git] / tools / batchMod.pl
index 97cdab6..192deb9 100755 (executable)
@@ -5,41 +5,45 @@
 #
 # 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 CGI;
-use strict;
-#use warnings; FIXME - Bug 2505
+use CGI qw ( -utf8 );
+use Modern::Perl;
 use C4::Auth;
 use C4::Output;
 use C4::Biblio;
 use C4::Items;
 use C4::Circulation;
 use C4::Context;
-use C4::Koha; # XXX subfield_is_koha_internal_p
-use C4::Branch; # XXX subfield_is_koha_internal_p
+use C4::Koha;
 use C4::BackgroundJob;
 use C4::ClassSource;
-use C4::Dates;
 use C4::Debug;
+use C4::Members;
 use MARC::File::XML;
 use List::MoreUtils qw/uniq/;
 
+use Koha::Biblios;
+use Koha::DateUtils;
+use Koha::Items;
+use Koha::ItemTypes;
+use Koha::Patrons;
+
 my $input = new CGI;
 my $dbh = C4::Context->dbh;
 my $error        = $input->param('error');
-my @itemnumbers  = $input->param('itemnumber');
+my @itemnumbers  = $input->multi_param('itemnumber');
 my $biblionumber = $input->param('biblionumber');
 my $op           = $input->param('op');
 my $del          = $input->param('del');
@@ -52,11 +56,11 @@ my $use_default_values = $input->param('use_default_values');
 my $template_name;
 my $template_flag;
 if (!defined $op) {
-    $template_name = "tools/batchMod.tmpl";
+    $template_name = "tools/batchMod.tt";
     $template_flag = { tools => '*' };
     $op = q{};
 } else {
-    $template_name = ($del) ? "tools/batchMod-del.tmpl" : "tools/batchMod-edit.tmpl";
+    $template_name = ($del) ? "tools/batchMod-del.tt" : "tools/batchMod-edit.tt";
     $template_flag = ($del) ? { tools => 'items_batchdel' }   : { tools => 'items_batchmod' };
 }
 
@@ -69,16 +73,19 @@ my ($template, $loggedinuser, $cookie)
                  flagsrequired => $template_flag,
                  });
 
+# Does the user have a restricted item edition permission?
+my $uid = $loggedinuser ? Koha::Patrons->find( $loggedinuser )->userid : undef;
+my $restrictededition = $uid ? haspermission($uid,  {'tools' => 'items_batchmod_restricted'}) : undef;
+# In case user is a superlibrarian, edition is not restricted
+$restrictededition = 0 if ($restrictededition != 0 && C4::Context->IsSuperLibrarian());
 
-my $today_iso = C4::Dates->today('iso');
-$template->param(today_iso => $today_iso);
 $template->param(del       => $del);
 
 my $itemrecord;
 my $nextop="";
 my @errors; # store errors found while checking data BEFORE saving item.
 my $items_display_hashref;
-my $tagslib = &GetMarcStructure(1);
+our $tagslib = &GetMarcStructure(1);
 
 my $deleted_items = 0;     # Number of deleted items
 my $deleted_records = 0;   # Number of deleted records ( with no items attached )
@@ -94,13 +101,13 @@ my $sessionID = $cookies{'CGISESSID'}->value;
 #--- ----------------------------------------------------------------------------
 if ($op eq "action") {
 #-------------------------------------------------------------------------------
-    my @tags      = $input->param('tag');
-    my @subfields = $input->param('subfield');
-    my @values    = $input->param('field_value');
-    my @disabled  = $input->param('disable_input');
+    my @tags      = $input->multi_param('tag');
+    my @subfields = $input->multi_param('subfield');
+    my @values    = $input->multi_param('field_value');
+    my @disabled  = $input->multi_param('disable_input');
     # build indicator hash.
-    my @ind_tag   = $input->param('ind_tag');
-    my @indicator = $input->param('indicator');
+    my @ind_tag   = $input->multi_param('ind_tag');
+    my @indicator = $input->multi_param('indicator');
 
     # Is there something to modify ?
     # TODO : We shall use this var to warn the user in case no modification was done to the items
@@ -111,11 +118,19 @@ if ($op eq "action") {
     # Once the job is done
     if ($completedJobID) {
        # If we have a reasonable amount of items, we display them
-       if (scalar(@itemnumbers) <= 1000) {
+    if (scalar(@itemnumbers) <= ( C4::Context->preference("MaxItemsToDisplayForBatchDel") // 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;
+        my @simple_items_display = map {
+            my $itemnumber = $_;
+            my $item = Koha::Items->find($itemnumber);
+            {
+                itemnumber   => $itemnumber,
+                barcode      => $item ? ( $item->barcode // q{} ) : q{},
+                biblionumber => $item ? $item->biblio->biblionumber : q{},
+            };
+        } @itemnumbers;
            $template->param("simple_items_display" => \@simple_items_display);
        }
 
@@ -141,7 +156,6 @@ if ($op eq "action") {
        my (  $itemtagfield,   $itemtagsubfield) = &GetMarcFromKohaField("items.itemnumber", "");
        if ($values_to_modify){
            my $xml = TransformHtmlToXml(\@tags,\@subfields,\@values,\@indicator,\@ind_tag, 'ITEM');
-        utf8::encode($xml);
            $marcitem = MARC::Record::new_from_xml($xml, 'UTF-8');
         }
         if ($values_to_blank){
@@ -163,7 +177,7 @@ if ($op eq "action") {
                $job->progress($i) if $runinbackground;
                my $itemdata = GetItem($itemnumber);
         if ( $del ){
-                       my $return = DelItemCheck(C4::Context->dbh, $itemdata->{'biblionumber'}, $itemdata->{'itemnumber'});
+            my $return = DelItemCheck( $itemdata->{'biblionumber'}, $itemdata->{'itemnumber'});
                        if ($return == 1) {
                            $deleted_items++;
                        } else {
@@ -179,7 +193,7 @@ if ($op eq "action") {
 
                        # If there are no items left, delete the biblio
                        if ( $del_records ) {
-                            my $itemscount = GetItemsCount($itemdata->{'biblionumber'});
+                            my $itemscount = Koha::Biblios->find( $itemdata->{'biblionumber'} )->items->count;
                             if ( $itemscount == 0 ) {
                                my $error = DelBiblio($itemdata->{'biblionumber'});
                                $deleted_records++ unless ( $error );
@@ -193,7 +207,7 @@ if ($op eq "action") {
                 if ( $modified ) {
                     eval {
                         if ( my $item = ModItemFromMarc( $localmarcitem, $itemdata->{biblionumber}, $itemnumber ) ) {
-                            LostItem($itemnumber, 'MARK RETURNED') if $item->{itemlost};
+                            LostItem($itemnumber, 'batchmod') if $item->{itemlost} and not $itemdata->{itemlost};
                         }
                     };
                 }
@@ -228,6 +242,7 @@ if ($op eq "show"){
             push @contentlist, $content if $content;
         }
 
+        @contentlist = uniq @contentlist;
         if ($filecontent eq 'barcode_file') {
             foreach my $barcode (@contentlist) {
 
@@ -267,8 +282,11 @@ if ($op eq "show"){
 
     # Flag to tell the template there are valid results, hidden or not
     if(scalar(@itemnumbers) > 0){ $template->param("itemresults" => 1); }
-    # Only display the items if there are no more than 1000
-    if (scalar(@itemnumbers) <= 1000) {
+    # Only display the items if there are no more than pref MaxItemsToProcessForBatchMod or MaxItemsToDisplayForBatchDel
+    my $max_items = $del
+        ? C4::Context->preference("MaxItemsToDisplayForBatchDel")
+        : C4::Context->preference("MaxItemsToProcessForBatchMod");
+    if (scalar(@itemnumbers) <= ( $max_items // 1000 ) ) {
         $items_display_hashref=BuildItemsData(@itemnumbers);
     } else {
         $template->param("too_many_items" => scalar(@itemnumbers));
@@ -286,19 +304,27 @@ $query  .= qq{ AND ( branchcode = ? OR branchcode IS NULL ) } if $branch_limit;
 $query  .= qq{ GROUP BY lib ORDER BY lib, lib_opac};
 my $authorised_values_sth = $dbh->prepare( $query );
 
-my $branches = GetBranchesLoop();  # build once ahead of time, instead of multiple times later.
+my $libraries = Koha::Libraries->search({}, { order_by => ['branchname'] })->unblessed;# 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);
+unshift (@$libraries, $nochange_branch);
 
 my $pref_itemcallnumber = C4::Context->preference('itemcallnumber');
 
+# Getting list of subfields to keep when restricted batchmod edit is enabled
+my $subfieldsToAllowForBatchmod = C4::Context->preference('SubfieldsToAllowForRestrictedBatchmod');
+my $allowAllSubfields = (
+    not defined $subfieldsToAllowForBatchmod
+      or $subfieldsToAllowForBatchmod == q||
+) ? 1 : 0;
+my @subfieldsToAllow = split(/ /, $subfieldsToAllowForBatchmod);
 
 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 IsMarcStructureInternal( $tagslib->{$tag}{$subfield} );
+        next if (not $allowAllSubfields and $restrictededition && !grep { $tag . '$' . $subfield eq $_ } @subfieldsToAllow );
        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';
@@ -313,8 +339,6 @@ foreach my $tag (sort keys %{$tagslib}) {
        }
        $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};
@@ -323,37 +347,36 @@ foreach my $tag (sort keys %{$tagslib}) {
    if ( !$value && $use_default_values) {
            $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;
+            my $today = dt_from_string;
+            my $year  = $today->year;
+            my $month = $today->month;
+            my $day   = $today->day;
+            $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 IndependentBranches.
 
-    my $attributes_no_value = qq(tabindex="1" id="$subfield_data{id}" name="field_value" class="input_marceditor" size="50" 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};
-           }
+
+    if ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "branches" ) {
+        foreach my $library (@$libraries) {
+            push @authorised_values, $library->{branchcode};
+            $authorised_lib{$library->{branchcode}} = $library->{branchname};
+        }
         $value = "";
-       }
-       elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
-           push @authorised_values, "";
-           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;
-           }
+    }
+    elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
+        push @authorised_values, "";
+        my $itemtypes = Koha::ItemTypes->search_with_localization;
+        while ( my $itemtype = $itemtypes->next ) {
+            push @authorised_values, $itemtype->itemtype;
+            $authorised_lib{$itemtype->itemtype} = $itemtype->translated_description;
+        }
         $value = "";
 
           #---- class_sources
@@ -384,49 +407,64 @@ foreach my $tag (sort keys %{$tagslib}) {
           }
           $value="";
       }
-      $subfield_data{marc_value} =CGI::scrolling_list(      # FIXME: factor out scrolling_list
-          -name     => "field_value",
-          -values   => \@authorised_values,
-          -default  => $value,
-          -labels   => \%authorised_lib,
-          -override => 1,
-          -size     => 1,
-          -multiple => 0,
-          -tabindex => 1,
-          -id       => "tag_".$tag."_subfield_".$subfield."_".$index_subfield,
-          -class    => "input_marceditor",
-      );
+        $subfield_data{marc_value} = {
+            type    => 'select',
+            id      => "tag_".$tag."_subfield_".$subfield."_".$index_subfield,
+            name    => "field_value",
+            values  => \@authorised_values,
+            labels  => \%authorised_lib,
+            default => $value,
+        };
     # it's a thesaurus / authority field
     }
     elsif ( $tagslib->{$tag}->{$subfield}->{authtypecode} ) {
-        $subfield_data{marc_value} = "<input type=\"text\" $attributes />
-            <a href=\"#\" class=\"buttonDot\"
-                onclick=\"Dopop('/cgi-bin/koha/authorities/auth_finder.pl?authtypecode=".$tagslib->{$tag}->{$subfield}->{authtypecode}."&index=$subfield_data{id}','$subfield_data{id}'); return false;\" title=\"Tag Editor\">...</a>
-    ";
-    # it's a plugin field
+        $subfield_data{marc_value} = {
+            type         => 'text1',
+            id           => $subfield_data{id},
+            value        => $value,
+            authtypecode => $tagslib->{$tag}->{$subfield}->{authtypecode},
+        }
     }
-    elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) {
-        # opening plugin
-        my $plugin = C4::Context->intranetdir . "/cataloguing/value_builder/" . $tagslib->{$tag}->{$subfield}->{'value_builder'};
-        if (do $plugin) {
-                       my $temp;
-            my $extended_param = plugin_parameters( $dbh, $temp, $tagslib, $subfield_data{id}, \@loop_data );
-            my ( $function_name, $javascript ) = plugin_javascript( $dbh, $temp, $tagslib, $subfield_data{id}, \@loop_data );
-            $subfield_data{marc_value} = qq[<input type="text" $attributes
-                onfocus="Focus$function_name($subfield_data{random}, '$subfield_data{id}');"
-                 onblur=" Blur$function_name($subfield_data{random}, '$subfield_data{id}');" />
-                <a href="#" class="buttonDot" onclick="Clic$function_name('$subfield_data{id}'); return false;" title="Tag Editor">...</a>
-                $javascript];
+    elsif ( $tagslib->{$tag}->{$subfield}->{value_builder} ) { # plugin
+        require Koha::FrameworkPlugin;
+        my $plugin = Koha::FrameworkPlugin->new( {
+            name => $tagslib->{$tag}->{$subfield}->{'value_builder'},
+            item_style => 1,
+        });
+        my $temp;
+        my $pars= { dbh => $dbh, record => $temp, tagslib => $tagslib,
+            id => $subfield_data{id}, tabloop => \@loop_data };
+        $plugin->build( $pars );
+        if( !$plugin->errstr ) {
+            $subfield_data{marc_value} = {
+                type       => 'text2',
+                id         => $subfield_data{id},
+                value      => $value,
+                javascript => $plugin->javascript,
+                noclick    => $plugin->noclick,
+            };
         } else {
-            warn "Plugin Failed: $plugin";
-            $subfield_data{marc_value} = "<input type=\"text\" $attributes />"; # supply default input form
+            warn $plugin->errstr;
+            $subfield_data{marc_value} = { # supply default input form
+                type       => 'text',
+                id         => $subfield_data{id},
+                value      => $value,
+            };
         }
     }
     elsif ( $tag eq '' ) {       # it's an hidden field
-        $subfield_data{marc_value} = qq(<input type="hidden" $attributes />);
+            $subfield_data{marc_value} = {
+                type       => 'hidden',
+                id         => $subfield_data{id},
+                value      => $value,
+            };
     }
     elsif ( $tagslib->{$tag}->{$subfield}->{'hidden'} ) {   # FIXME: shouldn't input type be "hidden" ?
-        $subfield_data{marc_value} = qq(<input type="text" $attributes />);
+        $subfield_data{marc_value} = {
+                type       => 'text',
+                id         => $subfield_data{id},
+                value      => $value,
+        };
     }
     elsif ( length($value) > 100
             or (C4::Context->preference("marcflavour") eq "UNIMARC" and
@@ -435,10 +473,18 @@ foreach my $tag (sort keys %{$tagslib}) {
                   500 <= $tag && $tag < 600                     )
           ) {
         # oversize field (textarea)
-        $subfield_data{marc_value} = "<textarea $attributes_no_value>$value</textarea>\n";
+        $subfield_data{marc_value} = {
+                type       => 'textarea',
+                id         => $subfield_data{id},
+                value      => $value,
+        };
     } else {
         # it's a standard field
-         $subfield_data{marc_value} = "<input type=\"text\" $attributes />";
+        $subfield_data{marc_value} = {
+                type       => 'text',
+                id         => $subfield_data{id},
+                value      => $value,
+        };
     }
 #   $subfield_data{marc_value}="<input type=\"text\" name=\"field_value\">";
     push (@loop_data, \%subfield_data);
@@ -530,11 +576,11 @@ sub BuildItemsData{
 
             # grab title, author, and ISBN to identify bib that the item
             # belongs to in the display
-                        my $biblio=GetBiblioData($$itemdata{biblionumber});
-            $this_row{title} = $biblio->{title};
-            $this_row{author} = $biblio->{author};
-            $this_row{isbn} = $biblio->{isbn};
-            $this_row{biblionumber} = $biblio->{biblionumber};
+            my $biblio = Koha::Biblios->find( $itemdata->{biblionumber} );
+            $this_row{title}        = $biblio->title;
+            $this_row{author}       = $biblio->author;
+            $this_row{isbn}         = $biblio->biblioitem->isbn;
+            $this_row{biblionumber} = $biblio->biblionumber;
 
                        if (%this_row) {
                                push(@big_array, \%this_row);
@@ -581,7 +627,7 @@ sub UpdateMarcWith {
     foreach my $subfield ( $fieldfrom->subfields() ) {
         foreach my $field_to_update ( @fields_to ) {
             if ( $subfield->[1] ) {
-                unless ( $field_to_update->subfield($subfield->[0]) ~~ $subfield->[1] ) {
+                unless ( $field_to_update->subfield($subfield->[0]) eq $subfield->[1] ) {
                     $modified++;
                     $field_to_update->update( $subfield->[0] => $subfield->[1] );
                 }
@@ -639,7 +685,7 @@ sub add_saved_job_results_to_template {
 sub put_in_background {
     my $job_size = shift;
 
-    my $job = C4::BackgroundJob->new($sessionID, "test", $ENV{'SCRIPT_NAME'}, $job_size);
+    my $job = C4::BackgroundJob->new($sessionID, "test", '/cgi-bin/koha/tools/batchMod.pl', $job_size);
     my $jobID = $job->id();
 
     # fork off
@@ -664,7 +710,7 @@ sub put_in_background {
         close STDERR;
     } else {
         # fork failed, so exit immediately
-        warn "fork failed while attempting to run $ENV{'SCRIPT_NAME'} as a background job";
+        warn "fork failed while attempting to run tools/batchMod.pl as a background job";
         exit 0;
     }
     return $job;