Attachment 48766 Details for Bug 15870 – Bug 15870: MARC Filter to exclude fields/subfields lacking visibility

[patch] Bug 15870: MARC Filter to exclude fields/subfields lacking visibility

Bug-15870-MARC-Filter-to-exclude-fieldssubfields-l.patch (text/plain), 10.49 KB, created by Mark Tompsett on 2016-03-08 06:19:00 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Mark Tompsett

Created: 2016-03-08 06:19:00 UTC

Size: 10.49 KB

patch

obsolete

>From cedaedb653339e36f097861d4ff42c6e3972d70f Mon Sep 17 00:00:00 2001
>From: Mark Tompsett <mtompset@hotmail.com>
>Date: Fri, 19 Feb 2016 17:13:16 -0500
>Subject: [PATCH] Bug 15870: MARC Filter to exclude fields/subfields lacking
> visibility
>
>TEST PLAN
>---------
>0) Apply 15777 and 15871 as required.
>1) Apply patch
>2) prove -v t/db_dependpent/RecordProcessor_ViewPolicy.t
>   -- all should pass.
>3) koha qa test tools.
>BONUS
>4) perlcritic -1 t/db_dependpent/RecordProcessor_ViewPolicy.t
>   -- using the koha qa test tools perlcriticrc, it should pass
>      though I am excluding checking print return values.
>      (see bug 15646)
>---
> Koha/Filter/MARC/ViewPolicy.pm              | 252 ++++++++++++++++++++++++++++
> t/db_dependent/RecordProcessor_ViewPolicy.t |  68 ++++++++
> 2 files changed, 320 insertions(+)
> create mode 100644 Koha/Filter/MARC/ViewPolicy.pm
> create mode 100644 t/db_dependent/RecordProcessor_ViewPolicy.t
>
>diff --git a/Koha/Filter/MARC/ViewPolicy.pm b/Koha/Filter/MARC/ViewPolicy.pm
>new file mode 100644
>index 0000000..e28ade7
>--- /dev/null
>+++ b/Koha/Filter/MARC/ViewPolicy.pm
>@@ -0,0 +1,252 @@
>+package Koha::Filter::MARC::ViewPolicy;
>+
>+# Copyright 2015 Mark Tompsett
>+#
>+# 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 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.
>+#
>+# You should have received a copy of the GNU General Public License
>+# along with Koha; if not, see <http://www.gnu.org/licenses>.
>+
>+=head1 NAME
>+
>+Koha::Filter::MARC::ViewPolicy - this filters a MARC record.
>+
>+=head1 VERSION
>+
>+version 1.0
>+
>+=head1 SYNOPSIS
>+
>+my $processor = Koha::RecordProcessor->new( { filters => ('ViewPolicy') } );
>+
>+=head1 DESCRIPTION
>+
>+Filter to remove fields based on the 'Advance constraints'
>+settings found when editing a particular subfield definition of
>+a MARC bibliographic framework found under the Koha administration
>+menu.
>+
>+=cut
>+
>+use Modern::Perl;
>+use Carp;
>+use C4::Biblio;
>+
>+use base qw(Koha::RecordProcessor::Base);
>+our $NAME    = 'MARC_ViewPolicy';
>+our $VERSION = '3.23'; # Master version I hope it gets in.
>+
>+=head1 SUBROUTINES/METHODS
>+
>+=head2 filter
>+
>+    my $processor = Koha::RecordProcessor->new( { filters => ('ViewPolicy') } );
>+...
>+    my $newrecord = $processor->filter($record);
>+    my $newrecords = $processor->filter(\@records);
>+
>+This returns a filtered copy of the record based on the Advanced constraints
>+visibility settings.
>+
>+=cut
>+
>+sub filter {
>+    my $self    = shift;
>+    my $precord = shift;
>+    my @records;
>+
>+    if ( !$precord ) {
>+        return $precord;
>+    }
>+
>+    if ( ref($precord) eq 'ARRAY' ) {
>+        @records = @{$precord};
>+    }
>+    else {
>+        push @records, $precord;
>+    }
>+
>+    my @results;
>+    foreach my $current_record (@records) {
>+        my $result        = $current_record->clone();
>+        my $interface     = $self->{options}->{interface} // 'opac';
>+        my $frameworkcode = $self->{options}->{frameworkcode} // q{};
>+        my $display       = _should_display_on_interface();
>+
>+        my $marcsubfieldstructure = GetMarcStructure( 0, $frameworkcode );
>+
>+        #if ($marcsubfieldstructure->{'000'}->{'@'}->{hidden}>0) {
>+        # LDR field is excluded from $current_record->fields().
>+        # if we hide it here, the MARCXML->MARC::Record->MARCXML
>+        # transformation blows up.
>+        #}
>+        foreach my $field ( $result->fields() ) {
>+            _filter_field(
>+                {
>+                    field                 => $field,
>+                    marcsubfieldstructure => $marcsubfieldstructure,
>+                    display               => $display,
>+                    interface             => $interface,
>+                    result                => $result
>+                }
>+            );
>+        }
>+        push @results, $result;
>+    }
>+
>+    if ( scalar @results == 1 ) {
>+        return $results[0];
>+    }
>+    else {
>+        return \@results;
>+    }
>+}
>+
>+sub _filter_field {
>+    my ($parameter) = @_;
>+
>+    my $field                 = $parameter->{field};
>+    my $marcsubfieldstructure = $parameter->{marcsubfieldstructure};
>+    my $display               = $parameter->{display};
>+    my $interface             = $parameter->{interface};
>+    my $result                = $parameter->{result};
>+
>+    my $tag = $field->tag();
>+    if ( $tag >= 10 ) {
>+        foreach my $subpairs ( $field->subfields() ) {
>+            my ( $subtag, $value ) = @{$subpairs};
>+
>+            # visibility is a "level" (-7 to +7), default to 0
>+            my $visibility =
>+              $marcsubfieldstructure->{$tag}->{$subtag}->{hidden};
>+            $visibility //= 0;
>+            my $hidden;
>+            if ( $display->{$interface}->{$visibility} ) {
>+                $hidden = 0;
>+            }
>+            else {
>+                # deleting last subfield doesn't delete field, so
>+                # this detects that case to delete the field.
>+                if ( scalar $field->subfields() <= 1 ) {
>+                    $result->delete_fields($field);
>+                }
>+                else {
>+                    $field->delete_subfield( code => $subtag );
>+                }
>+            }
>+        }
>+    }
>+
>+    # tags less than 10 don't have subfields, use @ trick.
>+    else {
>+        # visibility is a "level" (-7 to +7), default to 0
>+        my $visibility = $marcsubfieldstructure->{$tag}->{q{@}}->{hidden};
>+        $visibility //= 0;
>+        my $hidden;
>+        if ( $display->{$interface}->{$visibility} ) {
>+            $hidden = 0;
>+        }
>+        else {
>+            $hidden = 1;
>+            $result->delete_fields($field);
>+        }
>+    }
>+    return;
>+}
>+
>+sub initialize {
>+    my $self  = shift;
>+    my $param = shift;
>+
>+    my $options = $param->{options};
>+    $self->{options} = $options;
>+    $self->Koha::RecordProcessor::Base::initialize($param);
>+    return;
>+}
>+
>+sub _should_display_on_interface {
>+    my $display = {
>+        opac => {
>+            0  => 1,
>+            -1 => 1,
>+            -2 => 1,
>+            -3 => 1,
>+            -4 => 1,
>+            -5 => 1,
>+            -6 => 1,
>+            -7 => 1,
>+        },
>+        intranet => {
>+            -6 => 1,
>+            -5 => 1,
>+            -1 => 1,
>+            0  => 1,
>+            1  => 1,
>+            4  => 1,
>+            6  => 1,
>+            7  => 1,
>+        },
>+    };
>+    return $display;
>+}
>+
>+=head1 DIAGNOSTICS
>+
>+ $ prove -v t/RecordProcessor.t
>+ $ prove -v t/db_dependent/RecordProcessor_ViewPolicy.t
>+
>+=head1 CONFIGURATION AND ENVIRONMENT
>+
>+Install Koha. This filter will be used appropriately by the OPAC or Staff client.
>+
>+=head1 INCOMPATIBILITIES
>+
>+This is designed for MARC::Record filtering currently. It will not handle MARC::MARCXML.
>+
>+=head1 DEPENDENCIES
>+
>+The following Perl libraries are required: Modern::Perl and Carp.
>+The following Koha libraries are required: C4::Biblio, Koha::RecordProcessor, and Koha::RecordProcessor::Base.
>+These should all be installed if the koha-common package is installed or Koha is otherwise installed.
>+
>+=head1 BUGS AND LIMITATIONS
>+
>+This is the initial version. Please feel free to report bugs
>+at http://bugs.koha-community.org/.
>+
>+=head1 AUTHOR
>+
>+Mark Tompsett
>+
>+=head1 LICENSE AND COPYRIGHT
>+
>+Copyright 2015 Mark Tompsett
>+
>+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 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.
>+
>+You should have received a copy of the GNU General Public License
>+along with Koha; if not, see <http://www.gnu.org/licenses>.
>+
>+=cut
>+
>+1;
>diff --git a/t/db_dependent/RecordProcessor_ViewPolicy.t b/t/db_dependent/RecordProcessor_ViewPolicy.t
>new file mode 100644
>index 0000000..3f43a49
>--- /dev/null
>+++ b/t/db_dependent/RecordProcessor_ViewPolicy.t
>@@ -0,0 +1,68 @@
>+#!/usr/bin/perl
>+
>+# This file is part of Koha.
>+#
>+# Copyright 2015 Mark Tompsett
>+#
>+# 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.
>+#
>+# You should have received a copy of the GNU General Public License
>+# along with Koha; if not, see <http://www.gnu.org/licenses>.
>+
>+use Modern::Perl;
>+use MARC::Record;
>+use MARC::Field;
>+use Test::More;
>+use C4::Context;
>+use Koha::Database;
>+use Data::Dumper;
>+
>+BEGIN {
>+    use_ok('Koha::RecordProcessor');
>+}
>+
>+our $VERSION = '3.23';    # Master version that I hope it gets in.
>+
>+my $dbh = C4::Context->dbh;
>+
>+my $database = Koha::Database->new();
>+my $schema   = $database->schema();
>+$schema->storage->txn_begin();
>+
>+$dbh->{RaiseError} = 1;
>+
>+$dbh->do(q{UPDATE marc_subfield_structure SET hidden=2 WHERE tagfield='020';});
>+
>+my $isbn        = '0590353403';
>+my $title       = 'Foundation';
>+my $marc_record = MARC::Record->new;
>+my $field       = MARC::Field->new( '020', q{}, q{}, 'a' => $isbn );
>+$marc_record->append_fields($field);
>+$field = MARC::Field->new( '245', q{}, q{}, 'a' => $title );
>+$marc_record->append_fields($field);
>+
>+my $processor = Koha::RecordProcessor->new(
>+    { filters => ('ViewPolicy'), options => { 'test' => 'value1' } } );
>+is(
>+    ref( $processor->filters->[0] ),
>+    'Koha::Filter::MARC::ViewPolicy',
>+    'Created record processor with implicitly scoped ViewPolicy filter'
>+);
>+my $after_record    = $processor->process($marc_record);
>+my $modified_record = $marc_record->clone;
>+my @isbn            = $modified_record->field('020');
>+$modified_record->delete_fields(@isbn);
>+is_deeply( $modified_record, $after_record,
>+    'Filtered and modified MARC record match' );
>+
>+$schema->storage->txn_rollback();
>+
>+done_testing();
>-- 
>2.1.4

Actions: View | Diff | Splinter Review

Attachments on bug 15870: 48260 | 48261 | 48346 | 48628 | 48766 | 48767 | 48768 | 48769 | 48812 | 48813 | 48814 | 48815 | 49013 | 49035 | 49534 | 49535 | 49536 | 49537 | 49538