Bug 21747: (follow-up) Intelligent rename of offsets
[koha.git] / C4 / Heading / MARC21.pm
index a057e51..fc4d576 100644 (file)
@@ -1,28 +1,27 @@
 package C4::Heading::MARC21;
 
 # Copyright (C) 2008 LibLime
-# 
+#
 # 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 strict;
-#use warnings; FIXME - Bug 2505
+use warnings;
 use MARC::Record;
 use MARC::Field;
 
-our $VERSION = 3.00;
 
 =head1 NAME
 
@@ -49,27 +48,75 @@ FIXME - this should be moved to a configuration file.
 =cut
 
 my $bib_heading_fields = {
-    '100' => { auth_type => 'PERSO_NAME', subfields => 'abcdefghjklmnopqrst', main_entry => 1 },
-    '110' => { auth_type => 'CORPO_NAME', subfields => 'abcdefghklmnoprst', main_entry => 1 },
-    '111' => { auth_type => 'MEETI_NAME', subfields => 'acdefghjklnpqst', main_entry => 1 },
-    '130' => { auth_type => 'UNIF_TITLE', subfields => 'adfghklmnoprst', main_entry => 1 },
+    '100' => {
+        auth_type  => 'PERSO_NAME',
+        subfields  => 'abcdfghjklmnopqrst',
+        main_entry => 1
+    },
+    '110' => {
+        auth_type  => 'CORPO_NAME',
+        subfields  => 'abcdfghklmnoprst',
+        main_entry => 1
+    },
+    '111' => {
+        auth_type  => 'MEETI_NAME',
+        subfields  => 'acdfghjklnpqst',
+        main_entry => 1
+    },
+    '130' => {
+        auth_type  => 'UNIF_TITLE',
+        subfields  => 'adfghklmnoprst',
+        main_entry => 1
+    },
     '440' => { auth_type => 'UNIF_TITLE', subfields => 'anp', series => 1 },
-    '600' => { auth_type => 'PERSO_NAME', subfields => 'abcdefghjklmnopqrstvxyz', subject => 1 },
-    '610' => { auth_type => 'CORPO_NAME', subfields => 'abcdefghklmnoprstvxyz', subject => 1 },
-    '611' => { auth_type => 'MEETI_NAME', subfields => 'acdefghjklnpqstvxyz', subject => 1 },
-    '630' => { auth_type => 'UNIF_TITLE', subfields => 'adfghklmnoprstvxyz', subject => 1 },
-    '648' => { auth_type => 'CHRON_TERM', subfields => 'avxyz', subject => 1 },
+    '600' => {
+        auth_type => 'PERSO_NAME',
+        subfields => 'abcdfghjklmnopqrstvxyz',
+        subject   => 1
+    },
+    '610' => {
+        auth_type => 'CORPO_NAME',
+        subfields => 'abcdfghklmnoprstvxyz',
+        subject   => 1
+    },
+    '611' => {
+        auth_type => 'MEETI_NAME',
+        subfields => 'acdfghjklnpqstvxyz',
+        subject   => 1
+    },
+    '630' => {
+        auth_type => 'UNIF_TITLE',
+        subfields => 'adfghklmnoprstvxyz',
+        subject   => 1
+    },
+    '648' => { auth_type => 'CHRON_TERM', subfields => 'avxyz',  subject => 1 },
     '650' => { auth_type => 'TOPIC_TERM', subfields => 'abvxyz', subject => 1 },
-    '651' => { auth_type => 'GEOGR_NAME', subfields => 'avxyz', subject => 1 },
-    '655' => { auth_type => 'GENRE/FORM', subfields => 'avxyz', subject => 1 },
-    '700' => { auth_type => 'PERSO_NAME', subfields => 'abcdefghjklmnopqrst' },
-    '710' => { auth_type => 'CORPO_NAME', subfields => 'abcdefghklmnoprst' },
-    '711' => { auth_type => 'MEETI_NAME', subfields => 'acdefghjklnpqst' },
+    '651' => { auth_type => 'GEOGR_NAME', subfields => 'avxyz',  subject => 1 },
+    '655' => { auth_type => 'GENRE/FORM', subfields => 'avxyz',  subject => 1 },
+    '690' => { auth_type => 'TOPIC_TERM', subfields => 'abvxyz', subject => 1 },
+    '691' => { auth_type => 'GEOGR_NAME', subfields => 'avxyz',  subject => 1 },
+    '696' => { auth_type => 'PERSO_NAME', subfields => 'abcdfghjklmnopqrst' },
+    '697' => { auth_type => 'CORPO_NAME', subfields => 'abcdfghklmnoprst' },
+    '698' => { auth_type => 'MEETI_NAME', subfields => 'acdfghjklnpqst' },
+    '699' => { auth_type => 'UNIF_TITLE', subfields => 'adfghklmnoprst' },
+    '700' => { auth_type => 'PERSO_NAME', subfields => 'abcdfghjklmnopqrst' },
+    '710' => { auth_type => 'CORPO_NAME', subfields => 'abcdfghklmnoprst' },
+    '711' => { auth_type => 'MEETI_NAME', subfields => 'acdfghjklnpqst' },
     '730' => { auth_type => 'UNIF_TITLE', subfields => 'adfghklmnoprst' },
-    '800' => { auth_type => 'PERSO_NAME', subfields => 'abcdefghjklmnopqrst', series => 1 },
-    '810' => { auth_type => 'CORPO_NAME', subfields => 'abcdefghklmnoprst', series => 1 },
-    '811' => { auth_type => 'MEETI_NAME', subfields => 'acdefghjklnpqst', series => 1 },
-    '830' => { auth_type => 'UNIF_TITLE', subfields => 'adfghklmnoprst', series => 1 },
+    '800' => {
+        auth_type => 'PERSO_NAME',
+        subfields => 'abcdfghjklmnopqrst',
+        series    => 1
+    },
+    '810' => {
+        auth_type => 'CORPO_NAME',
+        subfields => 'abcdfghklmnoprst',
+        series    => 1
+    },
+    '811' =>
+      { auth_type => 'MEETI_NAME', subfields => 'acdfghjklnpqst', series => 1 },
+    '830' =>
+      { auth_type => 'UNIF_TITLE', subfields => 'adfghklmnoprst', series => 1 },
 };
 
 =head2 subdivisions
@@ -87,11 +134,7 @@ my %subdivisions = (
 
 =head2 new
 
-=over 4
-
-my $marc_handler = C4::Heading::MARC21->new();
-
-=back
+  my $marc_handler = C4::Heading::MARC21->new();
 
 =cut
 
@@ -105,37 +148,57 @@ sub new {
 =cut
 
 sub valid_bib_heading_tag {
-    my $self = shift;
-    my $tag = shift;
+    my $self          = shift;
+    my $tag           = shift;
+    my $frameworkcode = shift;
 
-    if (exists $bib_heading_fields->{$tag}) {
-        return 1
-    } else {
+    if ( exists $bib_heading_fields->{$tag} ) {
+        return 1;
+    }
+    else {
         return 0;
     }
 
 }
 
+=head2 valid_bib_heading_subfield
+
+=cut
+
+sub valid_bib_heading_subfield {
+    my $self          = shift;
+    my $tag           = shift;
+    my $subfield      = shift;
+
+    if ( exists $bib_heading_fields->{$tag} ) {
+        return 1 if ($bib_heading_fields->{$tag}->{subfields} =~ /$subfield/);
+    }
+    return 0;
+}
+
 =head2 parse_heading
 
 =cut
 
 sub parse_heading {
-    my $self = shift;
+    my $self  = shift;
     my $field = shift;
 
-    my $tag = $field->tag;
+    my $tag        = $field->tag;
     my $field_info = $bib_heading_fields->{$tag};
 
     my $auth_type = $field_info->{'auth_type'};
-    my $subject = $field_info->{'subject'} ? 1 : 0;
-    my $series = $field_info->{'series'} ? 1 : 0;
-    my $main_entry = $field_info->{'main_entry'} ? 1 : 0;
-    my $thesaurus = $subject ? _get_subject_thesaurus($field) : "lcsh"; # use 'lcsh' for names, UT, etc.
-    my $search_heading = _get_search_heading($field, $field_info->{'subfields'});
-    my $display_heading = _get_display_heading($field, $field_info->{'subfields'});
-
-    return ($auth_type, $subject, $series, $main_entry, $thesaurus, $search_heading, $display_heading);
+    my $thesaurus =
+      $tag =~ m/6../
+      ? _get_subject_thesaurus($field)
+      : "lcsh";    # use 'lcsh' for names, UT, etc.
+    my $search_heading =
+      _get_search_heading( $field, $field_info->{'subfields'} );
+    my $display_heading =
+      _get_display_heading( $field, $field_info->{'subfields'} );
+
+    return ( $auth_type, $thesaurus, $search_heading, $display_heading,
+        'exact' );
 }
 
 =head1 INTERNAL FUNCTIONS
@@ -146,24 +209,31 @@ sub parse_heading {
 
 sub _get_subject_thesaurus {
     my $field = shift;
-    my $ind2 = $field->indicator(2);
+    my $ind2  = $field->indicator(2);
 
     my $thesaurus = "notdefined";
-    if ($ind2 eq '0') {
+    if ( $ind2 eq '0' ) {
         $thesaurus = "lcsh";
-    } elsif ($ind2 eq '1') {
+    }
+    elsif ( $ind2 eq '1' ) {
         $thesaurus = "lcac";
-    } elsif ($ind2 eq '2') {
+    }
+    elsif ( $ind2 eq '2' ) {
         $thesaurus = "mesh";
-    } elsif ($ind2 eq '3') {
+    }
+    elsif ( $ind2 eq '3' ) {
         $thesaurus = "nal";
-    } elsif ($ind2 eq '4') {
+    }
+    elsif ( $ind2 eq '4' ) {
         $thesaurus = "notspecified";
-    } elsif ($ind2 eq '5') {
+    }
+    elsif ( $ind2 eq '5' ) {
         $thesaurus = "cash";
-    } elsif ($ind2 eq '6') {
+    }
+    elsif ( $ind2 eq '6' ) {
         $thesaurus = "rvm";
-    } elsif ($ind2 eq '7') {
+    }
+    elsif ( $ind2 eq '7' ) {
         my $sf2 = $field->subfield('2');
         $thesaurus = $sf2 if defined($sf2);
     }
@@ -176,24 +246,27 @@ sub _get_subject_thesaurus {
 =cut
 
 sub _get_search_heading {
-    my $field = shift;
+    my $field     = shift;
     my $subfields = shift;
 
-    my $heading = "";
+    my $heading   = "";
     my @subfields = $field->subfields();
-    my $first = 1;
-    for (my $i = 0; $i <= $#subfields; $i++) {
-        my $code = $subfields[$i]->[0];
+    my $first     = 1;
+    for ( my $i = 0 ; $i <= $#subfields ; $i++ ) {
+        my $code    = $subfields[$i]->[0];
         my $code_re = quotemeta $code;
-        my $value = $subfields[$i]->[1];
+        my $value   = $subfields[$i]->[1];
+        $value =~ s/[-,.:=;!%\/]$//;
         next unless $subfields =~ qr/$code_re/;
         if ($first) {
-            $first = 0;
+            $first   = 0;
             $heading = $value;
-        } else {
-            if (exists $subdivisions{$code}) {
+        }
+        else {
+            if ( exists $subdivisions{$code} ) {
                 $heading .= " $subdivisions{$code} $value";
-            } else {
+            }
+            else {
                 $heading .= " $value";
             }
         }
@@ -210,24 +283,26 @@ sub _get_search_heading {
 =cut
 
 sub _get_display_heading {
-    my $field = shift;
+    my $field     = shift;
     my $subfields = shift;
 
-    my $heading = "";
+    my $heading   = "";
     my @subfields = $field->subfields();
-    my $first = 1;
-    for (my $i = 0; $i <= $#subfields; $i++) {
-        my $code = $subfields[$i]->[0];
+    my $first     = 1;
+    for ( my $i = 0 ; $i <= $#subfields ; $i++ ) {
+        my $code    = $subfields[$i]->[0];
         my $code_re = quotemeta $code;
-        my $value = $subfields[$i]->[1];
+        my $value   = $subfields[$i]->[1];
         next unless $subfields =~ qr/$code_re/;
         if ($first) {
-            $first = 0;
+            $first   = 0;
             $heading = $value;
-        } else {
-            if (exists $subdivisions{$code}) {
+        }
+        else {
+            if ( exists $subdivisions{$code} ) {
                 $heading .= "--$value";
-            } else {
+            }
+            else {
                 $heading .= " $value";
             }
         }
@@ -235,9 +310,20 @@ sub _get_display_heading {
     return $heading;
 }
 
+# Additional limiters that we aren't using:
+#    if ($self->{'subject_added_entry'}) {
+#        $limiters .= " AND Heading-use-subject-added-entry=a";
+#    }
+#    if ($self->{'series_added_entry'}) {
+#        $limiters .= " AND Heading-use-series-added-entry=a";
+#    }
+#    if (not $self->{'subject_added_entry'} and not $self->{'series_added_entry'}) {
+#        $limiters .= " AND Heading-use-main-or-added-entry=a"
+#    }
+
 =head1 AUTHOR
 
-Koha Developement team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
 
 Galen Charlton <galen.charlton@liblime.com>