More POD cleanups
[koha_fer] / C4 / AuthoritiesMarc.pm
index e039b99..f276987 100644 (file)
@@ -12,11 +12,12 @@ package C4::AuthoritiesMarc;
 # 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., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# 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.
 
 use strict;
+#use warnings; FIXME - Bug 2505
 use C4::Context;
 use C4::Koha;
 use MARC::Record;
@@ -57,21 +58,26 @@ BEGIN {
     
        &merge
        &FindDuplicateAuthority
+
+        &GuessAuthTypeCode
+        &GuessAuthId
        );
 }
 
+
+=head1 NAME
+
+C4::AuthoritiesMarc
+
 =head2 GetAuthMARCFromKohaField 
 
-=over 4
+  ( $tag, $subfield ) = &GetAuthMARCFromKohaField ($kohafield,$authtypecode);
 
-( $tag, $subfield ) = &GetAuthMARCFromKohaField ($kohafield,$authtypecode);
 returns tag and subfield linked to kohafield
 
 Comment :
 Suppose Kohafield is only linked to ONE subfield
 
-=back
-
 =cut
 
 sub GetAuthMARCFromKohaField {
@@ -90,13 +96,11 @@ sub GetAuthMARCFromKohaField {
 
 =head2 SearchAuthorities 
 
-=over 4
+  (\@finalresult, $nbresults)= &SearchAuthorities($tags, $and_or, 
+     $excluding, $operator, $value, $offset,$length,$authtypecode,$sortby)
 
-(\@finalresult, $nbresults)= &SearchAuthorities($tags, $and_or, $excluding, $operator, $value, $offset,$length,$authtypecode,$sortby)
 returns ref to array result and count of results returned
 
-=back
-
 =cut
 
 sub SearchAuthorities {
@@ -340,13 +344,10 @@ sub SearchAuthorities {
 
 =head2 CountUsage 
 
-=over 4
+  $count= &CountUsage($authid)
 
-$count= &CountUsage($authid)
 counts Usage of Authid in bibliorecords. 
 
-=back
-
 =cut
 
 sub CountUsage {
@@ -358,30 +359,19 @@ sub CountUsage {
         return scalar @tab;
     } else {
         ### ZOOM search here
-        my $oConnection=C4::Context->Zconn("biblioserver",1);
         my $query;
         $query= "an=".$authid;
-        my $oResult = $oConnection->search(new ZOOM::Query::CCL2RPN( $query, $oConnection ));
-        my $result;
-        while ((my $i = ZOOM::event([ $oConnection ])) != 0) {
-            my $ev = $oConnection->last_event();
-            if ($ev == ZOOM::Event::ZEND) {
-                $result = $oResult->size();
-            }
-        }
+               my ($err,$res,$result) = C4::Search::SimpleSearch($query,0,10);
         return ($result);
     }
 }
 
 =head2 CountUsageChildren 
 
-=over 4
+  $count= &CountUsageChildren($authid)
 
-$count= &CountUsageChildren($authid)
 counts Usage of narrower terms of Authid in bibliorecords.
 
-=back
-
 =cut
 
 sub CountUsageChildren {
@@ -390,13 +380,10 @@ sub CountUsageChildren {
 
 =head2 GetAuthTypeCode
 
-=over 4
+  $authtypecode= &GetAuthTypeCode($authid)
 
-$authtypecode= &GetAuthTypeCode($authid)
 returns authtypecode of an authid
 
-=back
-
 =cut
 
 sub GetAuthTypeCode {
@@ -409,16 +396,111 @@ sub GetAuthTypeCode {
   return $authtypecode;
 }
  
+=head2 GuessAuthTypeCode
+
+  my $authtypecode = GuessAuthTypeCode($record);
+
+Get the record and tries to guess the adequate authtypecode from its content.
+
+=cut
+
+sub GuessAuthTypeCode {
+    my ($record) = @_;
+    return unless defined $record;
+my $heading_fields = {
+    "MARC21"=>{
+        '100'=>{authtypecode=>'PERSO_NAME'},
+        '110'=>{authtypecode=>'CORPO_NAME'},
+        '111'=>{authtypecode=>'MEETI_NAME'},
+        '130'=>{authtypecode=>'UNIF_TITLE'},
+        '148'=>{authtypecode=>'CHRON_TERM'},
+        '150'=>{authtypecode=>'TOPIC_TERM'},
+        '151'=>{authtypecode=>'GEOGR_NAME'},
+        '155'=>{authtypecode=>'GENRE/FORM'},
+        '180'=>{authtypecode=>'GEN_SUBDIV'},
+        '181'=>{authtypecode=>'GEO_SUBDIV'},
+        '182'=>{authtypecode=>'CHRON_SUBD'},
+        '185'=>{authtypecode=>'FORM_SUBD'},
+    },
+#200 Personal name     700, 701, 702 4-- with embedded 700, 701, 702 600
+#                    604 with embedded 700, 701, 702
+#210 Corporate or meeting name 710, 711, 712 4-- with embedded 710, 711, 712 601 604 with embedded 710, 711, 712
+#215 Territorial or geographic name    710, 711, 712 4-- with embedded 710, 711, 712 601, 607 604 with embedded 710, 711, 712
+#216 Trademark         716 [Reserved for future use]
+#220 Family name       720, 721, 722 4-- with embedded 720, 721, 722 602 604 with embedded 720, 721, 722
+#230 Title     500 4-- with embedded 500 605
+#240 Name and title (embedded 200, 210, 215, or 220 and 230)   4-- with embedded 7-- and 500 7--  604 with embedded 7-- and 500 500
+#245 Name and collective title (embedded 200, 210, 215, or 220 and 235)        4-- with embedded 7-- and 501 604 with embedded 7-- and 501 7-- 501
+#250 Topical subject   606
+#260 Place access      620
+#280 Form, genre or physical characteristics   608
+#
+#
+# Could also be represented with :
+#leader position 9
+#a = personal name entry
+#b = corporate name entry
+#c = territorial or geographical name
+#d = trademark
+#e = family name
+#f = uniform title
+#g = collective uniform title
+#h = name/title
+#i = name/collective uniform title
+#j = topical subject
+#k = place access
+#l = form, genre or physical characteristics
+    "UNIMARC"=>{
+        '200'=>{authtypecode=>'NP'},
+        '210'=>{authtypecode=>'CO'},
+        '215'=>{authtypecode=>'SNG'},
+        '216'=>{authtypecode=>'TM'},
+        '220'=>{authtypecode=>'FAM'},
+        '230'=>{authtypecode=>'TU'},
+        '235'=>{authtypecode=>'CO_UNI_TI'},
+        '240'=>{authtypecode=>'SAUTTIT'},
+        '245'=>{authtypecode=>'NAME_COL'},
+        '250'=>{authtypecode=>'SNC'},
+        '260'=>{authtypecode=>'PA'},
+        '280'=>{authtypecode=>'GENRE/FORM'},
+    }
+};
+    foreach my $field (keys %{$heading_fields->{uc(C4::Context->preference('marcflavour'))} }) {
+       return $heading_fields->{uc(C4::Context->preference('marcflavour'))}->{$field}->{'authtypecode'} if (defined $record->field($field));
+    }
+    return;
+}
+
+=head2 GuessAuthId
+
+  my $authtid = GuessAuthId($record);
+
+Get the record and tries to guess the adequate authtypecode from its content.
+
+=cut
+
+sub GuessAuthId {
+    my ($record) = @_;
+    return unless ($record && $record->field('001'));
+#    my $authtypecode=GuessAuthTypeCode($record);
+#    my ($tag,$subfield)=GetAuthMARCFromKohaField("auth_header.authid",$authtypecode);
+#    if ($tag > 010) {return $record->subfield($tag,$subfield)}
+#    else {return $record->field($tag)->data}
+    return $record->field('001')->data;
+}
+
 =head2 GetTagsLabels
 
-=over 4
+  $tagslabel= &GetTagsLabels($forlibrarian,$authtypecode)
 
-$tagslabel= &GetTagsLabels($forlibrarian,$authtypecode)
 returns a ref to hashref of authorities tag and subfield structure.
 
 tagslabel usage : 
-$tagslabel->{$tag}->{$subfield}->{'attribute'}
+
+  $tagslabel->{$tag}->{$subfield}->{'attribute'}
+
 where attribute takes values in :
+
   lib
   tab
   mandatory
@@ -432,8 +514,6 @@ where attribute takes values in :
   isurl
   link
 
-=back
-
 =cut
 
 sub GetTagsLabels {
@@ -441,7 +521,7 @@ sub GetTagsLabels {
   my $dbh=C4::Context->dbh;
   $authtypecode="" unless $authtypecode;
   my $sth;
-  my $libfield = ($forlibrarian eq 1)? 'liblibrarian' : 'libopac';
+  my $libfield = ($forlibrarian == 1)? 'liblibrarian' : 'libopac';
 
 
   # check that authority exists
@@ -508,14 +588,10 @@ ORDER BY tagfield,tagsubfield"
 
 =head2 AddAuthority
 
-=over 4
-
-$authid= &AddAuthority($record, $authid,$authtypecode)
-returns authid of the newly created authority
+  $authid= &AddAuthority($record, $authid,$authtypecode)
 
 Either Create Or Modify existing authority.
-
-=back
+returns authid of the newly created authority
 
 =cut
 
@@ -625,16 +701,12 @@ sub AddAuthority {
 
 =head2 DelAuthority
 
-=over 4
+  $authid= &DelAuthority($authid)
 
-$authid= &DelAuthority($authid)
 Deletes $authid
 
-=back
-
 =cut
 
-
 sub DelAuthority {
     my ($authid) = @_;
     my $dbh=C4::Context->dbh;
@@ -674,13 +746,10 @@ sub ModAuthority {
 
 =head2 GetAuthorityXML 
 
-=over 4
+  $marcxml= &GetAuthorityXML( $authid)
 
-$marcxml= &GetAuthorityXML( $authid)
 returns xml form of record $authid
 
-=back
-
 =cut
 
 sub GetAuthorityXML {
@@ -707,13 +776,10 @@ sub GetAuthorityXML {
 
 =head2 GetAuthority 
 
-=over 4
+  $record= &GetAuthority( $authid)
 
-$record= &GetAuthority( $authid)
 Returns MARC::Record of the authority passed in parameter.
 
-=back
-
 =cut
 
 sub GetAuthority {
@@ -735,11 +801,7 @@ sub GetAuthority {
 
 =head2 GetAuthType 
 
-=over 4
-
-$result = &GetAuthType($authtypecode)
-
-=back
+  $result = &GetAuthType($authtypecode)
 
 If the authority type specified by C<$authtypecode> exists,
 returns a hashref of the type's fields.  If the type
@@ -812,15 +874,12 @@ sub AUTHhtml2marc {
 
 =head2 FindDuplicateAuthority
 
-=over 4
+  $record= &FindDuplicateAuthority( $record, $authtypecode)
 
-$record= &FindDuplicateAuthority( $record, $authtypecode)
 return $authid,Summary if duplicate is found.
 
 Comments : an improvement would be to return All the records that match.
 
-=back
-
 =cut
 
 sub FindDuplicateAuthority {
@@ -854,17 +913,14 @@ sub FindDuplicateAuthority {
 
 =head2 BuildSummary
 
-=over 4
+  $text= &BuildSummary( $record, $authid, $authtypecode)
 
-$text= &BuildSummary( $record, $authid, $authtypecode)
 return HTML encoded Summary
 
 Comment : authtypecode can be infered from both record and authid.
 Moreover, authid can also be inferred from $record.
 Would it be interesting to delete those things.
 
-=back
-
 =cut
 
 sub BuildSummary{
@@ -903,10 +959,12 @@ sub BuildSummary{
   if ($summary and C4::Context->preference('marcflavour') eq 'UNIMARC') {
     my @fields = $record->fields();
     #             $reported_tag = '$9'.$result[$counter];
+       my @stringssummary;
     foreach my $field (@fields) {
       my $tag = $field->tag();
       my $tagvalue = $field->as_string();
-      $summary =~ s/\[(.?.?.?.?)$tag\*(.*?)]/$1$tagvalue$2\[$1$tag$2]/g;
+      my $localsummary= $summary;
+         $localsummary =~ s/\[(.?.?.?.?)$tag\*(.*?)\]/$1$tagvalue$2\[$1$tag$2\]/g;
       if ($tag<10) {
         if ($tag eq '001') {
           $reported_tag.='$3'.$field->data();
@@ -917,15 +975,18 @@ sub BuildSummary{
           my $subfieldcode = $subf[$i][0];
           my $subfieldvalue = $subf[$i][1];
           my $tagsubf = $tag.$subfieldcode;
-          $summary =~ s/\[(.?.?.?.?)$tagsubf(.*?)]/$1$subfieldvalue$2\[$1$tagsubf$2]/g;
+          $localsummary =~ s/\[(.?.?.?.?)$tagsubf(.*?)\]/$1$subfieldvalue$2\[$1$tagsubf$2\]/g;
         }
       }
+         push @stringssummary, $localsummary if ($localsummary ne $summary);
     }
-    $summary =~ s/\[(.*?)]//g;
-    $summary =~ s/\n/<br>/g;
+       my $resultstring;
+       $resultstring = join(" -- ",@stringssummary);
+    $resultstring =~ s/\[(.*?)\]//g;
+    $resultstring =~ s/\n/<br>/g;
+       $summary      =  $resultstring;
   } else {
     my $heading; 
-    my $authid; 
     my $altheading;
     my $seealso;
     my $broaderterms;
@@ -938,8 +999,7 @@ sub BuildSummary{
     # construct UNIMARC summary, that is quite different from MARC21 one
       # accepted form
       foreach my $field ($record->field('2..')) {
-        $heading.= $field->subfield('a');
-                $authid=$field->subfield('3');
+        $heading.= $field->as_string('abcdefghijlmnopqrstuvwxyz');
       }
       # rejected form(s)
       foreach my $field ($record->field('3..')) {
@@ -948,18 +1008,18 @@ sub BuildSummary{
       foreach my $field ($record->field('4..')) {
         if ($field->subfield('2')) {
             my $thesaurus = "thes. : ".$thesaurus{"$field->subfield('2')"}." : ";
-            $see.= '<span class="UF">'.$thesaurus.$field->subfield('a')."</span> -- \n";
+            $see.= '<span class="UF">'.$thesaurus.$field->as_string('abcdefghijlmnopqrstuvwxyz')."</span> -- \n";
         }
       }
       # see :
       foreach my $field ($record->field('5..')) {
             
         if (($field->subfield('5')) && ($field->subfield('a')) && ($field->subfield('5') eq 'g')) {
-          $broaderterms.= '<span class="BT"> <a href="detail.pl?authid='.$field->subfield('3').'">'.$field->subfield('a')."</a></span> -- \n";
-        } elsif (($field->subfield('5')) && ($field->subfield('a')) && ($field->subfield('5') eq 'h')){
-          $narrowerterms.= '<span class="NT"><a href="detail.pl?authid='.$field->subfield('3').'">'.$field->subfield('a')."</a></span> -- \n";
+          $broaderterms.= '<span class="BT"> '.$field->as_string('abcdefgjxyz')."</span> -- \n";
+        } elsif (($field->subfield('5')) && ($field->as_string) && ($field->subfield('5') eq 'h')){
+          $narrowerterms.= '<span class="NT">'.$field->as_string('abcdefgjxyz')."</span> -- \n";
         } elsif ($field->subfield('a')) {
-          $seealso.= '<span class="RT"><a href="detail.pl?authid='.$field->subfield('3').'">'.$field->subfield('a')."</a></span> -- \n";
+          $seealso.= '<span class="RT">'.$field->as_string('abcdefgxyz')."</a></span> -- \n";
         }
       }
       # // form
@@ -1032,17 +1092,14 @@ sub BuildSummary{
 
 =head2 BuildUnimarcHierarchies
 
-=over 4
+  $text= &BuildUnimarcHierarchies( $authid, $force)
 
-$text= &BuildUnimarcHierarchies( $authid, $force)
 return text containing trees for hierarchies
 for them to be stored in auth_header
 
 Example of text:
 122,1314,2452;1324,2342,3,2452
 
-=back
-
 =cut
 
 sub BuildUnimarcHierarchies{
@@ -1060,26 +1117,28 @@ sub BuildUnimarcHierarchies{
   } else {
     my $record = GetAuthority($authid);
     my $found;
-    foreach my $field ($record->field('550')){
-      if ($field->subfield('5') && $field->subfield('5') eq 'g'){
-        my $parentrecord = GetAuthority($field->subfield('3'));
-        my $localresult=$hierarchies;
-        my $trees;
-        $trees = BuildUnimarcHierarchies($field->subfield('3'));
-        my @trees;
-        if ($trees=~/;/){
-           @trees = split(/;/,$trees);
-        } else {
-           push @trees, $trees;
-        }
-        foreach (@trees){
-          $_.= ",$authid";
-        }
-        @globalresult = (@globalresult,@trees);
-        $found=1;
-      }
-      $hierarchies=join(";",@globalresult);
-    }
+       if ($record){
+               foreach my $field ($record->field('550')){
+                 if ($field->subfield('5') && $field->subfield('5') eq 'g'){
+                       my $parentrecord = GetAuthority($field->subfield('3'));
+                       my $localresult=$hierarchies;
+                       my $trees;
+                       $trees = BuildUnimarcHierarchies($field->subfield('3'));
+                       my @trees;
+                       if ($trees=~/;/){
+                          @trees = split(/;/,$trees);
+                       } else {
+                          push @trees, $trees;
+                       }
+                       foreach (@trees){
+                         $_.= ",$authid";
+                       }
+                       @globalresult = (@globalresult,@trees);
+                       $found=1;
+                 }
+                 $hierarchies=join(";",@globalresult);
+               }
+       }
     #Unless there is no ancestor, I am alone.
     $hierarchies="$authid" unless ($hierarchies);
   }
@@ -1089,9 +1148,8 @@ sub BuildUnimarcHierarchies{
 
 =head2 BuildUnimarcHierarchy
 
-=over 4
+  $ref= &BuildUnimarcHierarchy( $record, $class,$authid)
 
-$ref= &BuildUnimarcHierarchy( $record, $class,$authid)
 return a hashref in order to display hierarchy for record and final Authid $authid
 
 "loopparents"
@@ -1105,15 +1163,14 @@ return a hashref in order to display hierarchy for record and final Authid $auth
 "ifchildren" 
 Those two latest ones should disappear soon.
 
-=back
-
 =cut
 
 sub BuildUnimarcHierarchy{
   my $record = shift @_;
   my $class = shift @_;
   my $authid_constructed = shift @_;
-  my $authid=$record->subfield('250','3');
+  return undef unless ($record);
+  my $authid=$record->subfield('2..','3');
   my %cell;
   my $parents=""; my $children="";
   my (@loopparents,@loopchildren);
@@ -1134,19 +1191,16 @@ sub BuildUnimarcHierarchy{
   $cell{"class"}=$class;
   $cell{"loopauthid"}=$authid;
   $cell{"current_value"} =1 if $authid eq $authid_constructed;
-  $cell{"value"}=$record->subfield('250',"a");
+  $cell{"value"}=$record->subfield('2..',"a");
   return \%cell;
 }
 
 =head2 GetHeaderAuthority
 
-=over 4
+  $ref= &GetHeaderAuthority( $authid)
 
-$ref= &GetHeaderAuthority( $authid)
 return a hashref in order auth_header table data
 
-=back
-
 =cut
 
 sub GetHeaderAuthority{
@@ -1161,13 +1215,10 @@ sub GetHeaderAuthority{
 
 =head2 AddAuthorityTrees
 
-=over 4
+  $ref= &AddAuthorityTrees( $authid, $trees)
 
-$ref= &AddAuthorityTrees( $authid, $trees)
 return success or failure
 
-=back
-
 =cut
 
 sub AddAuthorityTrees{
@@ -1181,16 +1232,11 @@ sub AddAuthorityTrees{
 
 =head2 merge
 
-=over 4
-
-$ref= &merge(mergefrom,$MARCfrom,$mergeto,$MARCto)
-
+  $ref= &merge(mergefrom,$MARCfrom,$mergeto,$MARCto)
 
 Could add some feature : Migrating from a typecode to an other for instance.
 Then we should add some new parameter : bibliotargettag, authtargettag
 
-=back
-
 =cut
 
 sub merge {
@@ -1361,11 +1407,7 @@ sub merge {
 
 =head2 get_auth_type_location
 
-=over 4
-
-my ($tag, $subfield) = get_auth_type_location($auth_type_code);
-
-=back
+  my ($tag, $subfield) = get_auth_type_location($auth_type_code);
 
 Get the tag and subfield used to store the heading type
 for indexing purposes.  The C<$auth_type> parameter is
@@ -1401,7 +1443,7 @@ __END__
 
 =head1 AUTHOR
 
-Koha Developement team <info@koha.org>
+Koha Development Team <info@koha.org>
 
 Paul POULAIN paul.poulain@free.fr