Bug 14957: (QA follow-up) Clarify 'context' param

This patch renames the (passed through) 'context' param for
'overlay_context'. I propose doing so, because in Koha-land 'context'
has a special meaning, related to C4::Context and it reads ambigous.

The patch itself is pretty trivial.

Tests should pass:
1. Run:
   $ kshell
  k$ prove t/db_dependent/Biblio/MarcOverlayRules.t
=> SUCCESS: Tests pass
2. Apply this patch
3. Repeat 1
=> SUCCESS: Tests still pass!
4. Sign off :-D

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Bug 14957: (follow-up) Clarify 'context' param

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

C4/Biblio.pm

@@ -332,7 +332,7 @@ The C<$options> argument is a hashref with additional parameters:
 
 =over 4
 
-=item C<context>
+=item C<overlay_context>
 
 This parameter is forwarded to L</ApplyMarcOverlayRules> where it is used for
 selecting the current rule set if MARCOverlayRules is enabled.
@@ -389,13 +389,13 @@ sub ModBiblio {
     if (   C4::Context->preference('MARCOverlayRules')
         && $biblionumber
         && defined $options
-        && exists $options->{'context'} )
+        && exists $options->{overlay_context} )
     {
         $record = ApplyMarcOverlayRules(
             {
-                biblionumber => $biblionumber,
-                record       => $record,
-                context      => $options->{'context'},
+                biblionumber    => $biblionumber,
+                record          => $record,
+                overlay_context => $options->{overlay_context},
             }
         );
     }
@@ -3282,7 +3282,7 @@ biblionumber of old record
 =item C<record>
 Incoming record that will be merged with old record
 
-=item C<context>
+=item C<overlay_context>
 hashref containing at least one context module and filter value on
 the form {module => filter, ...}.
 
@@ -3320,8 +3320,8 @@ sub ApplyMarcOverlayRules {
     my $old_record = GetMarcBiblio({ biblionumber => $biblionumber });
 
     # Skip overlay rules if called with no context
-    if ($old_record && defined $params->{context}) {
-        return Koha::MarcOverlayRules->merge_records($old_record, $incoming_record, $params->{context});
+    if ($old_record && defined $params->{overlay_context}) {
+        return Koha::MarcOverlayRules->merge_records($old_record, $incoming_record, $params->{overlay_context});
     }
     return $incoming_record;
 }

C4/ImportBatch.pm

@@ -680,7 +680,7 @@ sub BatchCommitRecords {
                 $oldxml = $old_marc->as_xml($marc_type);
 
                 ModBiblio($marc_record, $recordid, $oldbiblio->frameworkcode, {
-                    context => {
+                    overlay_context => {
                         source => 'batchimport',
                         categorycode => $logged_in_patron->categorycode,
                         userid => $logged_in_patron->userid

Koha/BackgroundJob/BatchUpdateBiblio.pm

@@ -92,7 +92,7 @@ sub process {
             C4::MarcModificationTemplates::ModifyRecordWithTemplate( $mmtid, $record );
             my $frameworkcode = C4::Biblio::GetFrameworkCode( $biblionumber );
             C4::Biblio::ModBiblio( $record, $biblionumber, $frameworkcode, {
-                context => $args->{context},
+                overlay_context => $args->{overlay_context},
             });
         };
         if ( $error and $error != 1 or $@ ) { # ModBiblio returns 1 if everything as gone well

cataloguing/addbiblio.pl

@@ -866,11 +866,15 @@ if ( $op eq "addbiblio" ) {
         my $oldbibitemnum;
         if ( $is_a_modif ) {
             my $member = Koha::Patrons->find($loggedinuser);
-            ModBiblio( $record, $biblionumber, $frameworkcode, {
-                    context => {
-                        source => $z3950 ? 'z39.50' : 'intranet',
+            ModBiblio(
+                $record,
+                $biblionumber,
+                $frameworkcode,
+                {
+                    overlay_context => {
+                        source       => $z3950 ? 'z39.50' : 'intranet',
                         categorycode => $member->categorycode,
-                        userid => $member->userid
+                        userid       => $member->userid
                     }
                 }
             );

misc/migration_tools/bulkmarcimport.pl

@@ -450,7 +450,7 @@ RECORD: while (  ) {
                     $biblioitemnumber = Koha::Biblios->find( $biblionumber )->biblioitem->biblioitemnumber;
                 };
                 if ($update) {
-                    eval { ModBiblio( $record, $biblionumber, $framework, { context => { source => 'bulkmarcimport' } } ) };
+                    eval { ModBiblio( $record, $biblionumber, $framework, { overlay_context => { source => 'bulkmarcimport' } } ) };
                     if ($@) {
                         warn "ERROR: Edit biblio $biblionumber failed: $@\n";
                         printlog( { id => $id || $originalid || $biblionumber, op => "update", status => "ERROR" } ) if ($logfile);

misc/migration_tools/import_lexile.pl

@@ -203,7 +203,7 @@ while ( my $row = $csv->getline_hr($fh) ) {
             $record->append_fields($field);
         }
 
-        ModBiblio( $record, $biblionumber, undef, { context => { source => 'import_lexile' } } ) unless ( $test );
+        ModBiblio( $record, $biblionumber, undef, { overlay_context => { source => 'import_lexile' } } ) unless ( $test );
     }
 
 }

t/db_dependent/Biblio/MarcOverlayRules.t

@@ -749,7 +749,7 @@ subtest 'context option in ModBiblio is handled correctly' => sub {
         MARC::Field->new('500', '', '', 'a' => 'One cold bottle of beer in the fridge'), # Appended
     );
 
-    ModBiblio($saved_record, $biblionumber, '', { context => { 'source' => 'test' } });
+    ModBiblio($saved_record, $biblionumber, '', { overlay_context => { 'source' => 'test' } });
 
     my $updated_record = GetMarcBiblio({ biblionumber => $biblionumber });
 

tools/batch_record_modification.pl

@@ -159,12 +159,12 @@ if ( $op eq 'form' ) {
     try {
         my $patron = Koha::Patrons->find( $loggedinuser );
         my $params = {
-            mmtid       => $mmtid,
-            record_ids  => \@record_ids,
-            context => {
-                source => 'batchmod',
+            mmtid           => $mmtid,
+            record_ids      => \@record_ids,
+            overlay_context => {
+                source       => 'batchmod',
                 categorycode => $patron->categorycode,
-                userid => $patron->userid
+                userid       => $patron->userid
             }
         };