Koha/BackgroundJob/BatchUpdateItem.pm

   1 package Koha::BackgroundJob::BatchUpdateItem;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use Modern::Perl;
  19 use List::MoreUtils qw( uniq );
  20 use Try::Tiny;
  21
  22 use MARC::Record;
  23 use MARC::Field;
  24
  25 use C4::Biblio;
  26 use C4::Items;
  27
  28 use Koha::DateUtils qw( dt_from_string );
  29 use Koha::SearchEngine::Indexer;
  30 use Koha::Items;
  31 use Koha::UI::Table::Builder::Items;
  32 use Koha::Exceptions::BackgroundJob;
  33
  34 use base 'Koha::BackgroundJob';
  35
  36 =head1 NAME
  37
  38 Koha::BackgroundJob::BatchUpdateItem - Background job derived class to process item modification in batch
  39
  40 =head1 API
  41
  42 =head2 Class methods
  43
  44 =head3 job_type
  45
  46 Define the job type of this job: batch_item_record_modification
  47
  48 =cut
  49
  50 sub job_type {
  51     return 'batch_item_record_modification';
  52 }
  53
  54 =head3 process
  55
  56     Koha::BackgroundJobs->find($id)->process(
  57         {
  58             record_ids => \@itemnumbers,
  59             new_values => {
  60                 itemnotes => $new_item_notes,
  61                 k         => $k,
  62             },
  63             regex_mod => {
  64                 itemnotes_nonpublic => {
  65                     search => 'foo',
  66                     replace => 'bar',
  67                     modifiers => 'gi',
  68                 },
  69             },
  70             exclude_from_local_holds_priority => 1|0
  71         }
  72     );
  73
  74 Process the modification.
  75
  76 new_values allows to set a new value for given fields.
  77 The key can be one of the item's column name, or one subfieldcode of a MARC subfields not linked with a Koha field.
  78
  79 regex_mod allows to modify existing subfield's values using a regular expression.
  80
  81 =cut
  82
  83 sub process {
  84     my ( $self, $args ) = @_;
  85
  86     if ( $self->status eq 'cancelled' ) {
  87         return;
  88     }
  89
  90     # FIXME If the job has already been started, but started again (worker has been restart for instance)
  91     # Then we will start from scratch and so double process the same records
  92
  93     $self->start;
  94
  95     my @record_ids = @{ $args->{record_ids} };
  96     my $regex_mod  = $args->{regex_mod};
  97     my $new_values = $args->{new_values};
  98     my $exclude_from_local_holds_priority =
  99       $args->{exclude_from_local_holds_priority};
 100     my $mark_items_returned =
 101       $args->{mark_items_returned};
 102
 103     my $report = {
 104         total_records            => scalar @record_ids,
 105         modified_fields          => 0,
 106     };
 107
 108     try {
 109         my ($results) = Koha::Items->search( { itemnumber => \@record_ids } )->batch_update(
 110             {   regex_mod                         => $regex_mod,
 111                 new_values                        => $new_values,
 112                 exclude_from_local_holds_priority => $exclude_from_local_holds_priority,
 113                 mark_items_returned               => $mark_items_returned,
 114                 callback                          => sub { $self->step; },
 115             }
 116         );
 117         $report->{modified_itemnumbers} = $results->{modified_itemnumbers};
 118         $report->{modified_fields}      = $results->{modified_fields};
 119     }
 120     catch {
 121         warn $_;
 122         die "Something terrible has happened!"
 123           if ( $_ =~ /Rollback failed/ );    # Rollback failed
 124     };
 125
 126     my $data = $self->decoded_data;
 127     $data->{report} = $report;
 128
 129     $self->finish( $data );
 130 }
 131
 132 =head3 enqueue
 133
 134 Enqueue the new job
 135
 136 =cut
 137
 138 sub enqueue {
 139     my ( $self, $args ) = @_;
 140
 141     Koha::Exceptions::BackgroundJob->throw('Job has not been enqueued')
 142         unless $args && exists $args->{record_ids};
 143
 144     my @record_ids = @{ $args->{record_ids} };
 145
 146     $self->SUPER::enqueue(
 147         {
 148             job_size  => scalar @record_ids,
 149             job_args  => {%$args},
 150             job_queue => 'long_tasks',
 151         }
 152     );
 153 }
 154
 155 =head3 additional_report
 156
 157 Sent the infos to generate the table containing the details of the modified items.
 158
 159 =cut
 160
 161 sub additional_report {
 162     my ( $self, $args ) = @_;
 163
 164     return unless $self->report->{modified_itemnumbers};
 165
 166     my $itemnumbers = $self->report->{modified_itemnumbers};
 167     if ( scalar(@$itemnumbers) > C4::Context->preference('MaxItemsToDisplayForBatchMod') ) {
 168         return { too_many_items_display => 1 };
 169     } else {
 170         my $items_table =
 171           Koha::UI::Table::Builder::Items->new( { itemnumbers => $itemnumbers } )
 172           ->build_table;
 173
 174         return {
 175             items            => $items_table->{items},
 176             item_header_loop => $items_table->{headers},
 177         };
 178     }
 179 }
 180
 181 1;