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
  33 use base 'Koha::BackgroundJob';
  34
  35 =head1 NAME
  36
  37 Koha::BackgroundJob::BatchUpdateItem - Background job derived class to process item modification in batch
  38
  39 =head1 API
  40
  41 =head2 Class methods
  42
  43 =head3 job_type
  44
  45 Define the job type of this job: batch_item_record_modification
  46
  47 =cut
  48
  49 sub job_type {
  50     return 'batch_item_record_modification';
  51 }
  52
  53 =head3 process
  54
  55     Koha::BackgroundJobs->find($id)->process(
  56         {
  57             record_ids => \@itemnumbers,
  58             new_values => {
  59                 itemnotes => $new_item_notes,
  60                 k         => $k,
  61             },
  62             regex_mod => {
  63                 itemnotes_nonpublic => {
  64                     search => 'foo',
  65                     replace => 'bar',
  66                     modifiers => 'gi',
  67                 },
  68             },
  69             exclude_from_local_holds_priority => 1|0
  70         }
  71     );
  72
  73 Process the modification.
  74
  75 new_values allows to set a new value for given fields.
  76 The key can be one of the item's column name, or one subfieldcode of a MARC subfields not linked with a Koha field.
  77
  78 regex_mod allows to modify existing subfield's values using a regular expression.
  79
  80 =cut
  81
  82 sub process {
  83     my ( $self, $args ) = @_;
  84
  85     if ( $self->status eq 'cancelled' ) {
  86         return;
  87     }
  88
  89     # FIXME If the job has already been started, but started again (worker has been restart for instance)
  90     # Then we will start from scratch and so double process the same records
  91
  92     $self->start;
  93
  94     my @record_ids = @{ $args->{record_ids} };
  95     my $regex_mod  = $args->{regex_mod};
  96     my $new_values = $args->{new_values};
  97     my $exclude_from_local_holds_priority =
  98       $args->{exclude_from_local_holds_priority};
  99     my $mark_items_returned =
 100       $args->{mark_items_returned};
 101
 102     my $report = {
 103         total_records            => scalar @record_ids,
 104         modified_fields          => 0,
 105     };
 106
 107     try {
 108         my ($results) = Koha::Items->search( { itemnumber => \@record_ids } )->batch_update(
 109             {   regex_mod                         => $regex_mod,
 110                 new_values                        => $new_values,
 111                 exclude_from_local_holds_priority => $exclude_from_local_holds_priority,
 112                 mark_items_returned               => $mark_items_returned,
 113                 callback                          => sub { $self->step; },
 114             }
 115         );
 116         $report->{modified_itemnumbers} = $results->{modified_itemnumbers};
 117         $report->{modified_fields}      = $results->{modified_fields};
 118     }
 119     catch {
 120         warn $_;
 121         die "Something terrible has happened!"
 122           if ( $_ =~ /Rollback failed/ );    # Rollback failed
 123     };
 124
 125     my $data = $self->decoded_data;
 126     $data->{report} = $report;
 127
 128     $self->finish( $data );
 129 }
 130
 131 =head3 enqueue
 132
 133 Enqueue the new job
 134
 135 =cut
 136
 137 sub enqueue {
 138     my ( $self, $args ) = @_;
 139
 140     # TODO Raise exception instead
 141     return unless exists $args->{record_ids};
 142
 143     my @record_ids = @{ $args->{record_ids} };
 144
 145     $self->SUPER::enqueue(
 146         {
 147             job_size  => scalar @record_ids,
 148             job_args  => {%$args},
 149             job_queue => 'long_tasks',
 150         }
 151     );
 152 }
 153
 154 =head3 additional_report
 155
 156 Sent the infos to generate the table containing the details of the modified items.
 157
 158 =cut
 159
 160 sub additional_report {
 161     my ( $self, $args ) = @_;
 162
 163     return unless $self->report->{modified_itemnumbers};
 164
 165     my $itemnumbers = $self->report->{modified_itemnumbers};
 166     if ( scalar(@$itemnumbers) > C4::Context->preference('MaxItemsToDisplayForBatchMod') ) {
 167         return { too_many_items_display => 1 };
 168     } else {
 169         my $items_table =
 170           Koha::UI::Table::Builder::Items->new( { itemnumbers => $itemnumbers } )
 171           ->build_table;
 172
 173         return {
 174             items            => $items_table->{items},
 175             item_header_loop => $items_table->{headers},
 176         };
 177     }
 178 }
 179
 180 1;