C4/AuthoritiesMarc.pm

   1 package C4::AuthoritiesMarc;
   2 # Copyright 2000-2002 Katipo Communications
   3 #
   4 # This file is part of Koha.
   5 #
   6 # Koha is free software; you can redistribute it and/or modify it
   7 # under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # Koha is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  18
  19 use strict;
  20 use warnings;
  21 use C4::Context;
  22 use MARC::Record;
  23 use C4::Biblio;
  24 use C4::Search;
  25 use C4::AuthoritiesMarc::MARC21;
  26 use C4::AuthoritiesMarc::UNIMARC;
  27 use C4::Charset;
  28 use C4::Log;
  29 use Koha::MetadataRecord::Authority;
  30 use Koha::Authorities;
  31 use Koha::Authority::Types;
  32 use Koha::Authority;
  33 use Koha::SearchEngine;
  34 use Koha::SearchEngine::Search;
  35
  36 use vars qw(@ISA @EXPORT);
  37
  38 BEGIN {
  39
  40         require Exporter;
  41         @ISA = qw(Exporter);
  42         @EXPORT = qw(
  43             &GetTagsLabels
  44         &GetAuthMARCFromKohaField
  45
  46         &AddAuthority
  47         &ModAuthority
  48         &DelAuthority
  49         &GetAuthority
  50         &GetAuthorityXML
  51
  52         &CountUsage
  53         &CountUsageChildren
  54         &SearchAuthorities
  55
  56         &BuildSummary
  57         &BuildAuthHierarchies
  58         &BuildAuthHierarchy
  59         &GenerateHierarchy
  60
  61         &merge
  62         &FindDuplicateAuthority
  63
  64         &GuessAuthTypeCode
  65         &GuessAuthId
  66         );
  67 }
  68
  69
  70 =head1 NAME
  71
  72 C4::AuthoritiesMarc
  73
  74 =head2 GetAuthMARCFromKohaField
  75
  76   ( $tag, $subfield ) = &GetAuthMARCFromKohaField ($kohafield,$authtypecode);
  77
  78 returns tag and subfield linked to kohafield
  79
  80 Comment :
  81 Suppose Kohafield is only linked to ONE subfield
  82
  83 =cut
  84
  85 sub GetAuthMARCFromKohaField {
  86 #AUTHfind_marc_from_kohafield
  87   my ( $kohafield,$authtypecode ) = @_;
  88   my $dbh=C4::Context->dbh;
  89   return 0, 0 unless $kohafield;
  90   $authtypecode="" unless $authtypecode;
  91   my $sth = $dbh->prepare("select tagfield,tagsubfield from auth_subfield_structure where kohafield= ? and authtypecode=? ");
  92   $sth->execute($kohafield,$authtypecode);
  93   my ($tagfield,$tagsubfield) = $sth->fetchrow;
  94
  95   return  ($tagfield,$tagsubfield);
  96 }
  97
  98 =head2 SearchAuthorities
  99
 100   (\@finalresult, $nbresults)= &SearchAuthorities($tags, $and_or,
 101      $excluding, $operator, $value, $offset,$length,$authtypecode,
 102      $sortby[, $skipmetadata])
 103
 104 returns ref to array result and count of results returned
 105
 106 =cut
 107
 108 sub SearchAuthorities {
 109     my ($tags, $and_or, $excluding, $operator, $value, $offset,$length,$authtypecode,$sortby,$skipmetadata) = @_;
 110     # warn Dumper($tags, $and_or, $excluding, $operator, $value, $offset,$length,$authtypecode,$sortby);
 111     my $dbh=C4::Context->dbh;
 112     $sortby="" unless $sortby;
 113     my $query;
 114     my $qpquery = '';
 115     my $QParser;
 116     $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser'));
 117     my $attr = '';
 118         # the marclist may contain "mainentry". In this case, search the tag_to_report, that depends on
 119         # the authtypecode. Then, search on $a of this tag_to_report
 120         # also store main entry MARC tag, to extract it at end of search
 121     my $mainentrytag;
 122     ##first set the authtype search and may be multiple authorities
 123     if ($authtypecode) {
 124         my $n=0;
 125         my @authtypecode;
 126         my @auths=split / /,$authtypecode ;
 127         foreach my  $auth (@auths){
 128             $query .=" \@attr 1=authtype \@attr 5=100 ".$auth; ##No truncation on authtype
 129                 push @authtypecode ,$auth;
 130             $n++;
 131         }
 132         if ($n>1){
 133             while ($n>1){$query= "\@or ".$query;$n--;}
 134         }
 135         if ($QParser) {
 136             $qpquery .= '(authtype:' . join('|| authtype:', @auths) . ')';
 137         }
 138     }
 139
 140     my $dosearch;
 141     my $and=" \@and " ;
 142     my $q2;
 143     my $attr_cnt = 0;
 144     for ( my $i = 0 ; $i <= $#{$value} ; $i++ ) {
 145         if ( @$value[$i] ) {
 146             if ( @$tags[$i] ) {
 147                 if ( @$tags[$i] eq "mainmainentry" ) {
 148                     $attr = " \@attr 1=Heading-Main ";
 149                 }
 150                 elsif ( @$tags[$i] eq "mainentry" ) {
 151                     $attr = " \@attr 1=Heading ";
 152                 }
 153                 elsif ( @$tags[$i] eq "match" ) {
 154                     $attr = " \@attr 1=Match ";
 155                 }
 156                 elsif ( @$tags[$i] eq "match-heading" ) {
 157                     $attr = " \@attr 1=Match-heading ";
 158                 }
 159                 elsif ( @$tags[$i] eq "see-from" ) {
 160                     $attr = " \@attr 1=Match-heading-see-from ";
 161                 }
 162                 elsif ( @$tags[$i] eq "thesaurus" ) {
 163                     $attr = " \@attr 1=Subject-heading-thesaurus ";
 164                 }
 165                 else {    # Assume any if no index was specified
 166                     $attr = " \@attr 1=Any ";
 167                 }
 168             }         #if @$tags[$i]
 169             else {    # Assume any if no index was specified
 170                 $attr = " \@attr 1=Any ";
 171             }
 172
 173             my $operator = @$operator[$i];
 174             if ( $operator and $operator eq 'is' ) {
 175                 $attr .= " \@attr 4=1  \@attr 5=100 "
 176                   ;    ##Phrase, No truncation,all of subfield field must match
 177             }
 178             elsif ( $operator and $operator eq "=" ) {
 179                 $attr .= " \@attr 4=107 ";    #Number Exact match
 180             }
 181             elsif ( $operator and $operator eq "start" ) {
 182                 $attr .= " \@attr 3=2 \@attr 4=1 \@attr 5=1 "
 183                   ;    #Firstinfield Phrase, Right truncated
 184             }
 185             elsif ( $operator and $operator eq "exact" ) {
 186                 $attr .= " \@attr 4=1  \@attr 5=100 \@attr 6=3 "
 187                   ;    ##Phrase, No truncation,all of subfield field must match
 188             }
 189             else {
 190                 $attr .= " \@attr 5=1 \@attr 4=6 "
 191                   ;    ## Word list, right truncated, anywhere
 192                 if ( $sortby eq 'Relevance' ) {
 193                     $attr .= "\@attr 2=102 ";
 194                 }
 195             }
 196             @$value[$i] =~
 197               s/"/\\"/g;    # Escape the double-quotes in the search value
 198             $attr = $attr . "\"" . @$value[$i] . "\"";
 199             $q2 .= $attr;
 200             $dosearch = 1;
 201             ++$attr_cnt;
 202             if ($QParser) {
 203                 $qpquery .= " $tags->[$i]:\"$value->[$i]\"";
 204             }
 205         }    #if value
 206     }
 207     ##Add how many queries generated
 208     if (defined $query && $query=~/\S+/){
 209       $query= $and x $attr_cnt . $query . (defined $q2 ? $q2 : '');
 210     } else {
 211       $query= $q2;
 212     }
 213     ## Adding order
 214     #$query=' @or  @attr 7=2 @attr 1=Heading 0 @or  @attr 7=1 @attr 1=Heading 1'.$query if ($sortby eq "HeadingDsc");
 215     my $orderstring;
 216     if ($sortby eq 'HeadingAsc') {
 217         $orderstring = '@attr 7=1 @attr 1=Heading 0';
 218     } elsif ($sortby eq 'HeadingDsc') {
 219         $orderstring = '@attr 7=2 @attr 1=Heading 0';
 220     } elsif ($sortby eq 'AuthidAsc') {
 221         $orderstring = '@attr 7=1 @attr 4=109 @attr 1=Local-Number 0';
 222     } elsif ($sortby eq 'AuthidDsc') {
 223         $orderstring = '@attr 7=2 @attr 4=109 @attr 1=Local-Number 0';
 224     }
 225     if ($QParser) {
 226         $qpquery .= ' all:all' unless $value->[0];
 227
 228         if ( $value->[0] =~ m/^qp=(.*)$/ ) {
 229             $qpquery = $1;
 230         }
 231
 232         $qpquery .= " #$sortby" unless $sortby eq '';
 233
 234         $QParser->parse( $qpquery );
 235         $query = $QParser->target_syntax('authorityserver');
 236     } else {
 237         $query=($query?$query:"\@attr 1=_ALLRECORDS \@attr 2=103 ''");
 238         $query="\@or $orderstring $query" if $orderstring;
 239     }
 240
 241     $offset=0 unless $offset;
 242     my $counter = $offset;
 243     $length=10 unless $length;
 244     my @oAuth;
 245     my $i;
 246     $oAuth[0]=C4::Context->Zconn("authorityserver" , 1);
 247     my $Anewq= new ZOOM::Query::PQF($query,$oAuth[0]);
 248     my $oAResult;
 249     $oAResult= $oAuth[0]->search($Anewq) ;
 250     while (($i = ZOOM::event(\@oAuth)) != 0) {
 251         my $ev = $oAuth[$i-1]->last_event();
 252         last if $ev == ZOOM::Event::ZEND;
 253     }
 254     my($error, $errmsg, $addinfo, $diagset) = $oAuth[0]->error_x();
 255     if ($error) {
 256         warn  "oAuth error: $errmsg ($error) $addinfo $diagset\n";
 257         goto NOLUCK;
 258     }
 259
 260     my $nbresults;
 261     $nbresults=$oAResult->size();
 262     my $nremains=$nbresults;
 263     my @result = ();
 264     my @finalresult = ();
 265
 266     if ($nbresults>0){
 267
 268     ##Find authid and linkid fields
 269     ##we may be searching multiple authoritytypes.
 270     ## FIXME this assumes that all authid and linkid fields are the same for all authority types
 271     # my ($authidfield,$authidsubfield)=GetAuthMARCFromKohaField($dbh,"auth_header.authid",$authtypecode[0]);
 272     # my ($linkidfield,$linkidsubfield)=GetAuthMARCFromKohaField($dbh,"auth_header.linkid",$authtypecode[0]);
 273         while (($counter < $nbresults) && ($counter < ($offset + $length))) {
 274
 275         ##Here we have to extract MARC record and $authid from ZEBRA AUTHORITIES
 276         my $rec=$oAResult->record($counter);
 277         my $separator=C4::Context->preference('AuthoritySeparator');
 278         my $authrecord = C4::Search::new_record_from_zebra(
 279             'authorityserver',
 280             $rec->raw()
 281         );
 282
 283         if ( !defined $authrecord or !defined $authrecord->field('001') ) {
 284             $counter++;
 285             next;
 286         }
 287
 288         SetUTF8Flag( $authrecord );
 289
 290         my $authid=$authrecord->field('001')->data();
 291         my %newline;
 292         $newline{authid} = $authid;
 293         if ( !$skipmetadata ) {
 294             my $auth_tag_to_report;
 295             $auth_tag_to_report = Koha::Authority::Types->find($authtypecode)->auth_tag_to_report
 296                 if $authtypecode;
 297             my $reported_tag;
 298             my $mainentry = $authrecord->field($auth_tag_to_report);
 299             if ($mainentry) {
 300                 foreach ( $mainentry->subfields() ) {
 301                     $reported_tag .= '$' . $_->[0] . $_->[1];
 302                 }
 303             }
 304
 305             my ( $thisauthtype, $thisauthtypecode );
 306             if ( my $authority = Koha::Authorities->find($authid) ) {
 307                 $thisauthtypecode = $authority->authtypecode;
 308                 $thisauthtype = Koha::Authority::Types->find($thisauthtypecode);
 309             }
 310             unless (defined $thisauthtype) {
 311                 $thisauthtypecode = $authtypecode;
 312                 $thisauthtype = Koha::Authority::Types->find($thisauthtypecode);
 313             }
 314             my $summary = BuildSummary( $authrecord, $authid, $thisauthtypecode );
 315
 316             $newline{authtype}     = defined($thisauthtype) ?
 317                                         $thisauthtype->authtypetext : '';
 318             $newline{summary}      = $summary;
 319             $newline{even}         = $counter % 2;
 320             $newline{reported_tag} = $reported_tag;
 321         }
 322         $counter++;
 323         push @finalresult, \%newline;
 324         }## while counter
 325         ###
 326         if (! $skipmetadata) {
 327             for (my $z=0; $z<@finalresult; $z++){
 328                 my  $count=CountUsage($finalresult[$z]{authid});
 329                 $finalresult[$z]{used}=$count;
 330             }# all $z's
 331         }
 332
 333     }## if nbresult
 334     NOLUCK:
 335     $oAResult->destroy();
 336     # $oAuth[0]->destroy();
 337
 338     return (\@finalresult, $nbresults);
 339 }
 340
 341 =head2 CountUsage
 342
 343   $count= &CountUsage($authid)
 344
 345 counts Usage of Authid in bibliorecords.
 346
 347 =cut
 348
 349 sub CountUsage {
 350     my ($authid) = @_;
 351         ### ZOOM search here
 352         my $query;
 353         $query= "an:".$authid;
 354         # Should really be replaced with a real count call, this is a
 355         # bad way.
 356         my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
 357         my ($err,$res,$result) = $searcher->simple_search_compat($query,0,1);
 358         if ($err) {
 359             warn "Error: $err from search $query";
 360             $result = 0;
 361         }
 362
 363         return $result;
 364 }
 365
 366 =head2 CountUsageChildren
 367
 368   $count= &CountUsageChildren($authid)
 369
 370 counts Usage of narrower terms of Authid in bibliorecords.
 371
 372 =cut
 373
 374 sub CountUsageChildren {
 375   my ($authid) = @_;
 376 }
 377
 378 =head2 GuessAuthTypeCode
 379
 380   my $authtypecode = GuessAuthTypeCode($record);
 381
 382 Get the record and tries to guess the adequate authtypecode from its content.
 383
 384 =cut
 385
 386 sub GuessAuthTypeCode {
 387     my ($record, $heading_fields) = @_;
 388     return unless defined $record;
 389     $heading_fields //= {
 390     "MARC21"=>{
 391         '100'=>{authtypecode=>'PERSO_NAME'},
 392         '110'=>{authtypecode=>'CORPO_NAME'},
 393         '111'=>{authtypecode=>'MEETI_NAME'},
 394         '130'=>{authtypecode=>'UNIF_TITLE'},
 395         '148'=>{authtypecode=>'CHRON_TERM'},
 396         '150'=>{authtypecode=>'TOPIC_TERM'},
 397         '151'=>{authtypecode=>'GEOGR_NAME'},
 398         '155'=>{authtypecode=>'GENRE/FORM'},
 399         '180'=>{authtypecode=>'GEN_SUBDIV'},
 400         '181'=>{authtypecode=>'GEO_SUBDIV'},
 401         '182'=>{authtypecode=>'CHRON_SUBD'},
 402         '185'=>{authtypecode=>'FORM_SUBD'},
 403     },
 404 #200 Personal name      700, 701, 702 4-- with embedded 700, 701, 702 600
 405 #                    604 with embedded 700, 701, 702
 406 #210 Corporate or meeting name  710, 711, 712 4-- with embedded 710, 711, 712 601 604 with embedded 710, 711, 712
 407 #215 Territorial or geographic name     710, 711, 712 4-- with embedded 710, 711, 712 601, 607 604 with embedded 710, 711, 712
 408 #216 Trademark  716 [Reserved for future use]
 409 #220 Family name        720, 721, 722 4-- with embedded 720, 721, 722 602 604 with embedded 720, 721, 722
 410 #230 Title      500 4-- with embedded 500 605
 411 #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
 412 #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
 413 #250 Topical subject    606
 414 #260 Place access       620
 415 #280 Form, genre or physical characteristics    608
 416 #
 417 #
 418 # Could also be represented with :
 419 #leader position 9
 420 #a = personal name entry
 421 #b = corporate name entry
 422 #c = territorial or geographical name
 423 #d = trademark
 424 #e = family name
 425 #f = uniform title
 426 #g = collective uniform title
 427 #h = name/title
 428 #i = name/collective uniform title
 429 #j = topical subject
 430 #k = place access
 431 #l = form, genre or physical characteristics
 432     "UNIMARC"=>{
 433         '200'=>{authtypecode=>'NP'},
 434         '210'=>{authtypecode=>'CO'},
 435         '215'=>{authtypecode=>'SNG'},
 436         '216'=>{authtypecode=>'TM'},
 437         '220'=>{authtypecode=>'FAM'},
 438         '230'=>{authtypecode=>'TU'},
 439         '235'=>{authtypecode=>'CO_UNI_TI'},
 440         '240'=>{authtypecode=>'SAUTTIT'},
 441         '245'=>{authtypecode=>'NAME_COL'},
 442         '250'=>{authtypecode=>'SNC'},
 443         '260'=>{authtypecode=>'PA'},
 444         '280'=>{authtypecode=>'GENRE/FORM'},
 445     }
 446 };
 447     foreach my $field (keys %{$heading_fields->{uc(C4::Context->preference('marcflavour'))} }) {
 448        return $heading_fields->{uc(C4::Context->preference('marcflavour'))}->{$field}->{'authtypecode'} if (defined $record->field($field));
 449     }
 450     return;
 451 }
 452
 453 =head2 GuessAuthId
 454
 455   my $authtid = GuessAuthId($record);
 456
 457 Get the record and tries to guess the adequate authtypecode from its content.
 458
 459 =cut
 460
 461 sub GuessAuthId {
 462     my ($record) = @_;
 463     return unless ($record && $record->field('001'));
 464 #    my $authtypecode=GuessAuthTypeCode($record);
 465 #    my ($tag,$subfield)=GetAuthMARCFromKohaField("auth_header.authid",$authtypecode);
 466 #    if ($tag > 010) {return $record->subfield($tag,$subfield)}
 467 #    else {return $record->field($tag)->data}
 468     return $record->field('001')->data;
 469 }
 470
 471 =head2 GetTagsLabels
 472
 473   $tagslabel= &GetTagsLabels($forlibrarian,$authtypecode)
 474
 475 returns a ref to hashref of authorities tag and subfield structure.
 476
 477 tagslabel usage :
 478
 479   $tagslabel->{$tag}->{$subfield}->{'attribute'}
 480
 481 where attribute takes values in :
 482
 483   lib
 484   tab
 485   mandatory
 486   repeatable
 487   authorised_value
 488   authtypecode
 489   value_builder
 490   kohafield
 491   seealso
 492   hidden
 493   isurl
 494   link
 495
 496 =cut
 497
 498 sub GetTagsLabels {
 499   my ($forlibrarian,$authtypecode)= @_;
 500   my $dbh=C4::Context->dbh;
 501   $authtypecode="" unless $authtypecode;
 502   my $sth;
 503   my $libfield = ($forlibrarian == 1)? 'liblibrarian' : 'libopac';
 504
 505
 506   # check that authority exists
 507   $sth=$dbh->prepare("SELECT count(*) FROM auth_tag_structure WHERE authtypecode=?");
 508   $sth->execute($authtypecode);
 509   my ($total) = $sth->fetchrow;
 510   $authtypecode="" unless ($total >0);
 511   $sth= $dbh->prepare(
 512 "SELECT auth_tag_structure.tagfield,auth_tag_structure.liblibrarian,auth_tag_structure.libopac,auth_tag_structure.mandatory,auth_tag_structure.repeatable
 513  FROM auth_tag_structure
 514  WHERE authtypecode=?
 515  ORDER BY tagfield"
 516     );
 517
 518   $sth->execute($authtypecode);
 519   my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
 520
 521   while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) = $sth->fetchrow ) {
 522         $res->{$tag}->{lib}        = ($forlibrarian or !$libopac)?$liblibrarian:$libopac;
 523         $res->{$tag}->{tab}        = " ";            # XXX
 524         $res->{$tag}->{mandatory}  = $mandatory;
 525         $res->{$tag}->{repeatable} = $repeatable;
 526   }
 527   $sth=      $dbh->prepare(
 528 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab, mandatory, repeatable,authorised_value,frameworkcode as authtypecode,value_builder,kohafield,seealso,hidden,isurl,defaultvalue
 529 FROM auth_subfield_structure
 530 WHERE authtypecode=?
 531 ORDER BY tagfield,tagsubfield"
 532     );
 533     $sth->execute($authtypecode);
 534
 535     my $subfield;
 536     my $authorised_value;
 537     my $value_builder;
 538     my $kohafield;
 539     my $seealso;
 540     my $hidden;
 541     my $isurl;
 542     my $link;
 543     my $defaultvalue;
 544
 545     while (
 546         ( $tag,         $subfield,   $liblibrarian,   , $libopac,      $tab,
 547         $mandatory,     $repeatable, $authorised_value, $authtypecode,
 548         $value_builder, $kohafield,  $seealso,          $hidden,
 549         $isurl,         $defaultvalue, $link )
 550         = $sth->fetchrow
 551       )
 552     {
 553         $res->{$tag}->{$subfield}->{lib}              = ($forlibrarian or !$libopac)?$liblibrarian:$libopac;
 554         $res->{$tag}->{$subfield}->{tab}              = $tab;
 555         $res->{$tag}->{$subfield}->{mandatory}        = $mandatory;
 556         $res->{$tag}->{$subfield}->{repeatable}       = $repeatable;
 557         $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
 558         $res->{$tag}->{$subfield}->{authtypecode}     = $authtypecode;
 559         $res->{$tag}->{$subfield}->{value_builder}    = $value_builder;
 560         $res->{$tag}->{$subfield}->{kohafield}        = $kohafield;
 561         $res->{$tag}->{$subfield}->{seealso}          = $seealso;
 562         $res->{$tag}->{$subfield}->{hidden}           = $hidden;
 563         $res->{$tag}->{$subfield}->{isurl}            = $isurl;
 564         $res->{$tag}->{$subfield}->{link}            = $link;
 565         $res->{$tag}->{$subfield}->{defaultvalue}     = $defaultvalue;
 566     }
 567     return $res;
 568 }
 569
 570 =head2 AddAuthority
 571
 572   $authid= &AddAuthority($record, $authid,$authtypecode)
 573
 574 Either Create Or Modify existing authority.
 575 returns authid of the newly created authority
 576
 577 =cut
 578
 579 sub AddAuthority {
 580 # pass the MARC::Record to this function, and it will create the records in the authority table
 581   my ($record,$authid,$authtypecode) = @_;
 582   my $dbh=C4::Context->dbh;
 583         my $leader='     nz  a22     o  4500';#Leader for incomplete MARC21 record
 584
 585 # if authid empty => true add, find a new authid number
 586     my $format;
 587     if (uc(C4::Context->preference('marcflavour')) eq 'UNIMARC') {
 588         $format= 'UNIMARCAUTH';
 589     }
 590     else {
 591         $format= 'MARC21';
 592     }
 593
 594     #update date/time to 005 for marc and unimarc
 595     my $time=POSIX::strftime("%Y%m%d%H%M%S",localtime);
 596     my $f5=$record->field('005');
 597     if (!$f5) {
 598       $record->insert_fields_ordered( MARC::Field->new('005',$time.".0") );
 599     }
 600     else {
 601       $f5->update($time.".0");
 602     }
 603
 604     SetUTF8Flag($record);
 605         if ($format eq "MARC21") {
 606                 if (!$record->leader) {
 607                         $record->leader($leader);
 608                 }
 609                 if (!$record->field('003')) {
 610                         $record->insert_fields_ordered(
 611                                 MARC::Field->new('003',C4::Context->preference('MARCOrgCode'))
 612                         );
 613                 }
 614                 my $date=POSIX::strftime("%y%m%d",localtime);
 615                 if (!$record->field('008')) {
 616             # Get a valid default value for field 008
 617             my $default_008 = C4::Context->preference('MARCAuthorityControlField008');
 618             if(!$default_008 or length($default_008)<34) {
 619                 $default_008 = '|| aca||aabn           | a|a     d';
 620             }
 621             else {
 622                 $default_008 = substr($default_008,0,34);
 623             }
 624
 625             $record->insert_fields_ordered( MARC::Field->new('008',$date.$default_008) );
 626                 }
 627                 if (!$record->field('040')) {
 628                  $record->insert_fields_ordered(
 629         MARC::Field->new('040','','',
 630                                 'a' => C4::Context->preference('MARCOrgCode'),
 631                                 'c' => C4::Context->preference('MARCOrgCode')
 632                                 )
 633                         );
 634     }
 635         }
 636
 637   if ($format eq "UNIMARCAUTH") {
 638         $record->leader("     nx  j22             ") unless ($record->leader());
 639         my $date=POSIX::strftime("%Y%m%d",localtime);
 640         my $defaultfield100 = C4::Context->preference('UNIMARCAuthorityField100');
 641     if (my $string=$record->subfield('100',"a")){
 642         $string=~s/fre50/frey50/;
 643         $record->field('100')->update('a'=>$string);
 644     }
 645     elsif ($record->field('100')){
 646           $record->field('100')->update('a'=>$date.$defaultfield100);
 647     } else {
 648         $record->append_fields(
 649         MARC::Field->new('100',' ',' '
 650             ,'a'=>$date.$defaultfield100)
 651         );
 652     }
 653   }
 654   my ($auth_type_tag, $auth_type_subfield) = get_auth_type_location($authtypecode);
 655   if (!$authid and $format eq "MARC21") {
 656     # only need to do this fix when modifying an existing authority
 657     C4::AuthoritiesMarc::MARC21::fix_marc21_auth_type_location($record, $auth_type_tag, $auth_type_subfield);
 658   }
 659   if (my $field=$record->field($auth_type_tag)){
 660     $field->update($auth_type_subfield=>$authtypecode);
 661   }
 662   else {
 663     $record->add_fields($auth_type_tag,'','', $auth_type_subfield=>$authtypecode);
 664   }
 665
 666     # Save record into auth_header, update 001
 667     if (!$authid ) {
 668         # Save a blank record, get authid
 669         $dbh->do( "INSERT INTO auth_header (datecreated,marcxml) values (NOW(),?)", undef, '' );
 670         $authid = $dbh->last_insert_id( undef, undef, 'auth_header', 'authid' );
 671         logaction( "AUTHORITIES", "ADD", $authid, "authority" ) if C4::Context->preference("AuthoritiesLog");
 672     }
 673     # Insert/update the recordID in MARC record
 674     $record->delete_field( $record->field('001') );
 675     $record->insert_fields_ordered( MARC::Field->new( '001', $authid ) );
 676     # Update
 677     $dbh->do( "UPDATE auth_header SET authtypecode=?, marc=?, marcxml=? WHERE authid=?", undef, $authtypecode, $record->as_usmarc, $record->as_xml_record($format), $authid ) or die $DBI::errstr;
 678     ModZebra( $authid, 'specialUpdate', 'authorityserver', $record );
 679
 680     return ( $authid );
 681 }
 682
 683
 684 =head2 DelAuthority
 685
 686   $authid= &DelAuthority($authid)
 687
 688 Deletes $authid
 689
 690 =cut
 691
 692 sub DelAuthority {
 693     my ($authid) = @_;
 694     my $dbh=C4::Context->dbh;
 695
 696     logaction( "AUTHORITIES", "DELETE", $authid, "authority" ) if C4::Context->preference("AuthoritiesLog");
 697     ModZebra($authid,"recordDelete","authorityserver",GetAuthority($authid),undef);
 698     my $sth = $dbh->prepare("DELETE FROM auth_header WHERE authid=?");
 699     $sth->execute($authid);
 700 }
 701
 702 =head2 ModAuthority
 703
 704   $authid= &ModAuthority($authid,$record,$authtypecode)
 705
 706 Modifies authority record, optionally updates attached biblios.
 707
 708 =cut
 709
 710 sub ModAuthority {
 711   my ($authid,$record,$authtypecode)=@_; # deprecated $merge parameter removed
 712
 713   my $dbh=C4::Context->dbh;
 714   #Now rewrite the $record to table with an add
 715   my $oldrecord=GetAuthority($authid);
 716   $authid=AddAuthority($record,$authid,$authtypecode);
 717
 718   # If a library thinks that updating all biblios is a long process and wishes
 719   # to leave that to a cron job, use misc/migration_tools/merge_authority.pl.
 720   # In that case set system preference "dontmerge" to 1. Otherwise biblios will
 721   # be updated.
 722   unless(C4::Context->preference('dontmerge') eq '1'){
 723       &merge($authid,$oldrecord,$authid,$record);
 724   } else {
 725       # save a record in need_merge_authorities table
 726       my $sqlinsert="INSERT INTO need_merge_authorities (authid, done) ".
 727         "VALUES (?,?)";
 728       $dbh->do($sqlinsert,undef,($authid,0));
 729   }
 730   logaction( "AUTHORITIES", "MODIFY", $authid, "authority BEFORE=>" . $oldrecord->as_formatted ) if C4::Context->preference("AuthoritiesLog");
 731   return $authid;
 732 }
 733
 734 =head2 GetAuthorityXML
 735
 736   $marcxml= &GetAuthorityXML( $authid)
 737
 738 returns xml form of record $authid
 739
 740 =cut
 741
 742 sub GetAuthorityXML {
 743   # Returns MARC::XML of the authority passed in parameter.
 744   my ( $authid ) = @_;
 745   if (uc(C4::Context->preference('marcflavour')) eq 'UNIMARC') {
 746       my $dbh=C4::Context->dbh;
 747       my $sth = $dbh->prepare("select marcxml from auth_header where authid=? "  );
 748       $sth->execute($authid);
 749       my ($marcxml)=$sth->fetchrow;
 750       return $marcxml;
 751   }
 752   else {
 753       # for MARC21, call GetAuthority instead of
 754       # getting the XML directly since we may
 755       # need to fix up the location of the authority
 756       # code -- note that this is reasonably safe
 757       # because GetAuthorityXML is used only by the
 758       # indexing processes like zebraqueue_start.pl
 759       my $record = GetAuthority($authid);
 760       return $record->as_xml_record('MARC21');
 761   }
 762 }
 763
 764 =head2 GetAuthority
 765
 766   $record= &GetAuthority( $authid)
 767
 768 Returns MARC::Record of the authority passed in parameter.
 769
 770 =cut
 771
 772 sub GetAuthority {
 773     my ($authid)=@_;
 774     my $authority = Koha::MetadataRecord::Authority->get_from_authid($authid);
 775     return unless $authority;
 776     return ($authority->record);
 777 }
 778
 779 =head2 FindDuplicateAuthority
 780
 781   $record= &FindDuplicateAuthority( $record, $authtypecode)
 782
 783 return $authid,Summary if duplicate is found.
 784
 785 Comments : an improvement would be to return All the records that match.
 786
 787 =cut
 788
 789 sub FindDuplicateAuthority {
 790
 791     my ($record,$authtypecode)=@_;
 792 #    warn "IN for ".$record->as_formatted;
 793     my $dbh = C4::Context->dbh;
 794 #    warn "".$record->as_formatted;
 795     my $auth_tag_to_report = Koha::Authority::Types->find($authtypecode)->auth_tag_to_report;
 796 #     warn "record :".$record->as_formatted."  auth_tag_to_report :$auth_tag_to_report";
 797     # build a request for SearchAuthorities
 798     my $QParser;
 799     $QParser = C4::Context->queryparser if (C4::Context->preference('UseQueryParser'));
 800     my $op;
 801     if ($QParser) {
 802         $op = '&&';
 803     } else {
 804         $op = 'and';
 805     }
 806     my $query='at:'.$authtypecode.' ';
 807     my $filtervalues=qr([\001-\040\Q!'"`#$%&*+,-./:;<=>?@(){[}_|~\E\]]);
 808     if ($record->field($auth_tag_to_report)) {
 809         foreach ($record->field($auth_tag_to_report)->subfields()) {
 810             $_->[1]=~s/$filtervalues/ /g; $query.= " $op he:\"".$_->[1]."\"" if ($_->[0]=~/[A-z]/);
 811         }
 812     }
 813     my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::AUTHORITIES_INDEX});
 814     my ($error, $results, $total_hits) = $searcher->simple_search_compat( $query, 0, 1 );
 815     # there is at least 1 result => return the 1st one
 816     if (!defined $error && @{$results} ) {
 817         my $marcrecord = C4::Search::new_record_from_zebra(
 818             'authorityserver',
 819             $results->[0]
 820         );
 821         return $marcrecord->field('001')->data,BuildSummary($marcrecord,$marcrecord->field('001')->data,$authtypecode);
 822     }
 823     # no result, returns nothing
 824     return;
 825 }
 826
 827 =head2 BuildSummary
 828
 829   $summary= &BuildSummary( $record, $authid, $authtypecode)
 830
 831 Returns a hashref with a summary of the specified record.
 832
 833 Comment : authtypecode can be inferred from both record and authid.
 834 Moreover, authid can also be inferred from $record.
 835 Would it be interesting to delete those things.
 836
 837 =cut
 838
 839 sub BuildSummary {
 840     ## give this a Marc record to return summary
 841     my ($record,$authid,$authtypecode)=@_;
 842     my $dbh=C4::Context->dbh;
 843     my %summary;
 844     my $summary_template;
 845     # handle $authtypecode is NULL or eq ""
 846     if ($authtypecode) {
 847         my $authref = Koha::Authority::Types->find($authtypecode);
 848         if ( $authref ) {
 849             $summary{authtypecode} = $authref->authtypecode;
 850             $summary{type} = $authref->authtypetext;
 851             $summary_template = $authref->summary;
 852             # for MARC21, the authority type summary displays a label meant for
 853             # display
 854             if (C4::Context->preference('marcflavour') ne 'UNIMARC') {
 855                 $summary{label} = $authref->summary;
 856             } else {
 857                 $summary{summary} = $authref->summary;
 858             }
 859         }
 860     }
 861     my $marc21subfields = 'abcdfghjklmnopqrstuvxyz68';
 862     my %marc21controlrefs = ( 'a' => 'earlier',
 863         'b' => 'later',
 864         'd' => 'acronym',
 865         'f' => 'musical',
 866         'g' => 'broader',
 867         'h' => 'narrower',
 868         'n' => 'notapplicable',
 869         'i' => 'subfi',
 870         't' => 'parent'
 871     );
 872     my %unimarc_relation_from_code = (
 873         g => 'broader',
 874         h => 'narrower',
 875         a => 'seealso',
 876     );
 877     my %thesaurus;
 878     $thesaurus{'1'}="Peuples";
 879     $thesaurus{'2'}="Anthroponymes";
 880     $thesaurus{'3'}="Oeuvres";
 881     $thesaurus{'4'}="Chronologie";
 882     $thesaurus{'5'}="Lieux";
 883     $thesaurus{'6'}="Sujets";
 884     #thesaurus a remplir
 885     my $reported_tag;
 886 # if the library has a summary defined, use it. Otherwise, build a standard one
 887 # FIXME - it appears that the summary field in the authority frameworks
 888 #         can work as a display template.  However, this doesn't
 889 #         suit the MARC21 version, so for now the "templating"
 890 #         feature will be enabled only for UNIMARC for backwards
 891 #         compatibility.
 892     if ($summary{summary} and C4::Context->preference('marcflavour') eq 'UNIMARC') {
 893         my @matches = ($summary{summary} =~ m/\[(.*?)(\d{3})([\*a-z0-9])(.*?)\]/g);
 894         my (@textbefore, @tag, @subtag, @textafter);
 895         for(my $i = 0; $i < scalar @matches; $i++){
 896             push @textbefore, $matches[$i] if($i%4 == 0);
 897             push @tag,        $matches[$i] if($i%4 == 1);
 898             push @subtag,     $matches[$i] if($i%4 == 2);
 899             push @textafter,  $matches[$i] if($i%4 == 3);
 900         }
 901         for(my $i = scalar @tag; $i >= 0; $i--){
 902             my $textbefore = $textbefore[$i] || '';
 903             my $tag = $tag[$i] || '';
 904             my $subtag = $subtag[$i] || '';
 905             my $textafter = $textafter[$i] || '';
 906             my $value = '';
 907             my $field = $record->field($tag);
 908             if ( $field ) {
 909                 if($subtag eq '*') {
 910                     if($tag < 10) {
 911                         $value = $textbefore . $field->data() . $textafter;
 912                     }
 913                 } else {
 914                     my @subfields = $field->subfield($subtag);
 915                     if(@subfields > 0) {
 916                         $value = $textbefore . join (" - ", @subfields) . $textafter;
 917                     }
 918                 }
 919             }
 920             $summary{summary} =~ s/\[\Q$textbefore$tag$subtag$textafter\E\]/$value/;
 921         }
 922         $summary{summary} =~ s/\\n/<br \/>/g;
 923     }
 924     my @authorized;
 925     my @notes;
 926     my @seefrom;
 927     my @seealso;
 928     my @otherscript;
 929     if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
 930 # construct UNIMARC summary, that is quite different from MARC21 one
 931 # accepted form
 932         foreach my $field ($record->field('2..')) {
 933             push @authorized, {
 934                 heading => $field->as_string('abcdefghijlmnopqrstuvwxyz'),
 935                 hemain  => ( $field->subfield('a') // undef ),
 936                 field   => $field->tag(),
 937             };
 938         }
 939 # rejected form(s)
 940         foreach my $field ($record->field('3..')) {
 941             push @notes, { note => $field->subfield('a'), field => $field->tag() };
 942         }
 943         foreach my $field ($record->field('4..')) {
 944             my $thesaurus = $field->subfield('2') ? "thes. : ".$thesaurus{"$field->subfield('2')"}." : " : '';
 945             push @seefrom, {
 946                 heading => $thesaurus . $field->as_string('abcdefghijlmnopqrstuvwxyz'),
 947                 hemain  => ( $field->subfield('a') // undef ),
 948                 type    => 'seefrom',
 949                 field   => $field->tag(),
 950             };
 951         }
 952
 953         # see :
 954         @seealso = map {
 955             my $type = $unimarc_relation_from_code{$_->subfield('5') || 'a'};
 956             my $heading = $_->as_string('abcdefgjxyz');
 957             {
 958                 field   => $_->tag,
 959                 type    => $type,
 960                 heading => $heading,
 961                 hemain  => ( $_->subfield('a') // undef ),
 962                 search  => $heading,
 963                 authid  => ( $_->subfield('9') // undef ),
 964             }
 965         } $record->field('5..');
 966
 967         # Other forms
 968         @otherscript = map { {
 969             lang      => length ($_->subfield('8')) == 6 ? substr ($_->subfield('8'), 3, 3) : $_->subfield('8') || '',
 970             term      => $_->subfield('a') . ($_->subfield('b') ? ', ' . $_->subfield('b') : ''),
 971             direction => 'ltr',
 972             field     => $_->tag,
 973         } } $record->field('7..');
 974
 975     } else {
 976 # construct MARC21 summary
 977 # FIXME - looping over 1XX is questionable
 978 # since MARC21 authority should have only one 1XX
 979         my $subfields_to_report;
 980         foreach my $field ($record->field('1..')) {
 981             my $tag = $field->tag();
 982             next if "152" eq $tag;
 983 # FIXME - 152 is not a good tag to use
 984 # in MARC21 -- purely local tags really ought to be
 985 # 9XX
 986             if ($tag eq '100') {
 987                 $subfields_to_report = 'abcdefghjklmnopqrstvxyz';
 988             } elsif ($tag eq '110') {
 989                 $subfields_to_report = 'abcdefghklmnoprstvxyz';
 990             } elsif ($tag eq '111') {
 991                 $subfields_to_report = 'acdefghklnpqstvxyz';
 992             } elsif ($tag eq '130') {
 993                 $subfields_to_report = 'adfghklmnoprstvxyz';
 994             } elsif ($tag eq '148') {
 995                 $subfields_to_report = 'abvxyz';
 996             } elsif ($tag eq '150') {
 997                 $subfields_to_report = 'abvxyz';
 998             } elsif ($tag eq '151') {
 999                 $subfields_to_report = 'avxyz';
1000             } elsif ($tag eq '155') {
1001                 $subfields_to_report = 'abvxyz';
1002             } elsif ($tag eq '180') {
1003                 $subfields_to_report = 'vxyz';
1004             } elsif ($tag eq '181') {
1005                 $subfields_to_report = 'vxyz';
1006             } elsif ($tag eq '182') {
1007                 $subfields_to_report = 'vxyz';
1008             } elsif ($tag eq '185') {
1009                 $subfields_to_report = 'vxyz';
1010             }
1011             if ($subfields_to_report) {
1012                 push @authorized, {
1013                     heading => $field->as_string($subfields_to_report),
1014                     hemain  => ( $field->subfield( substr($subfields_to_report, 0, 1) ) // undef ),
1015                     field   => $tag,
1016                 };
1017             } else {
1018                 push @authorized, {
1019                     heading => $field->as_string(),
1020                     hemain  => ( $field->subfield( 'a' ) // undef ),
1021                     field   => $tag,
1022                 };
1023             }
1024         }
1025         foreach my $field ($record->field('4..')) { #See From
1026             my $type = 'seefrom';
1027             $type = ($marc21controlrefs{substr $field->subfield('w'), 0, 1} || '') if ($field->subfield('w'));
1028             if ($type eq 'notapplicable') {
1029                 $type = substr $field->subfield('w'), 2, 1;
1030                 $type = 'earlier' if $type && $type ne 'n';
1031             }
1032             if ($type eq 'subfi') {
1033                 push @seefrom, {
1034                     heading => $field->as_string($marc21subfields),
1035                     hemain  => $field->subfield( substr($marc21subfields, 0, 1) ),
1036                     type    => ($field->subfield('i') || ''),
1037                     field   => $field->tag(),
1038                 };
1039             } else {
1040                 push @seefrom, {
1041                     heading => $field->as_string($marc21subfields),
1042                     hemain  => $field->subfield( substr($marc21subfields, 0, 1) ),
1043                     type    => $type,
1044                     field   => $field->tag(),
1045                 };
1046             }
1047         }
1048         foreach my $field ($record->field('5..')) { #See Also
1049             my $type = 'seealso';
1050             $type = ($marc21controlrefs{substr $field->subfield('w'), 0, 1} || '') if ($field->subfield('w'));
1051             if ($type eq 'notapplicable') {
1052                 $type = substr $field->subfield('w'), 2, 1;
1053                 $type = 'earlier' if $type && $type ne 'n';
1054             }
1055             if ($type eq 'subfi') {
1056                 push @seealso, {
1057                     heading => $field->as_string($marc21subfields),
1058                     hemain  => $field->subfield( substr($marc21subfields, 0, 1) ),
1059                     type    => $field->subfield('i'),
1060                     field   => $field->tag(),
1061                     search  => $field->as_string($marc21subfields) || '',
1062                     authid  => $field->subfield('9') || ''
1063                 };
1064             } else {
1065                 push @seealso, {
1066                     heading => $field->as_string($marc21subfields),
1067                     hemain  => $field->subfield( substr($marc21subfields, 0, 1) ),
1068                     type    => $type,
1069                     field   => $field->tag(),
1070                     search  => $field->as_string($marc21subfields) || '',
1071                     authid  => $field->subfield('9') || ''
1072                 };
1073             }
1074         }
1075         foreach my $field ($record->field('6..')) {
1076             push @notes, { note => $field->as_string(), field => $field->tag() };
1077         }
1078         foreach my $field ($record->field('880')) {
1079             my $linkage = $field->subfield('6');
1080             my $category = substr $linkage, 0, 1;
1081             if ($category eq '1') {
1082                 $category = 'preferred';
1083             } elsif ($category eq '4') {
1084                 $category = 'seefrom';
1085             } elsif ($category eq '5') {
1086                 $category = 'seealso';
1087             }
1088             my $type;
1089             if ($field->subfield('w')) {
1090                 $type = $marc21controlrefs{substr $field->subfield('w'), '0'};
1091             } else {
1092                 $type = $category;
1093             }
1094             my $direction = $linkage =~ m#/r$# ? 'rtl' : 'ltr';
1095             push @otherscript, { term => $field->as_string($subfields_to_report), category => $category, type => $type, direction => $direction, linkage => $linkage };
1096         }
1097     }
1098     $summary{mainentry} = $authorized[0]->{heading};
1099     $summary{mainmainentry} = $authorized[0]->{hemain};
1100     $summary{authorized} = \@authorized;
1101     $summary{notes} = \@notes;
1102     $summary{seefrom} = \@seefrom;
1103     $summary{seealso} = \@seealso;
1104     $summary{otherscript} = \@otherscript;
1105     return \%summary;
1106 }
1107
1108 =head2 GetAuthorizedHeading
1109
1110   $heading = &GetAuthorizedHeading({ record => $record, authid => $authid })
1111
1112 Takes a MARC::Record object describing an authority record or an authid, and
1113 returns a string representation of the first authorized heading. This routine
1114 should be considered a temporary shim to ease the future migration of authority
1115 data from C4::AuthoritiesMarc to the object-oriented Koha::*::Authority.
1116
1117 =cut
1118
1119 sub GetAuthorizedHeading {
1120     my $args = shift;
1121     my $record;
1122     unless ($record = $args->{record}) {
1123         return unless $args->{authid};
1124         $record = GetAuthority($args->{authid});
1125     }
1126     return unless (ref $record eq 'MARC::Record');
1127     if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1128 # construct UNIMARC summary, that is quite different from MARC21 one
1129 # accepted form
1130         foreach my $field ($record->field('2..')) {
1131             return $field->as_string('abcdefghijlmnopqrstuvwxyz');
1132         }
1133     } else {
1134         foreach my $field ($record->field('1..')) {
1135             my $tag = $field->tag();
1136             next if "152" eq $tag;
1137 # FIXME - 152 is not a good tag to use
1138 # in MARC21 -- purely local tags really ought to be
1139 # 9XX
1140             if ($tag eq '100') {
1141                 return $field->as_string('abcdefghjklmnopqrstvxyz68');
1142             } elsif ($tag eq '110') {
1143                 return $field->as_string('abcdefghklmnoprstvxyz68');
1144             } elsif ($tag eq '111') {
1145                 return $field->as_string('acdefghklnpqstvxyz68');
1146             } elsif ($tag eq '130') {
1147                 return $field->as_string('adfghklmnoprstvxyz68');
1148             } elsif ($tag eq '148') {
1149                 return $field->as_string('abvxyz68');
1150             } elsif ($tag eq '150') {
1151                 return $field->as_string('abvxyz68');
1152             } elsif ($tag eq '151') {
1153                 return $field->as_string('avxyz68');
1154             } elsif ($tag eq '155') {
1155                 return $field->as_string('abvxyz68');
1156             } elsif ($tag eq '180') {
1157                 return $field->as_string('vxyz68');
1158             } elsif ($tag eq '181') {
1159                 return $field->as_string('vxyz68');
1160             } elsif ($tag eq '182') {
1161                 return $field->as_string('vxyz68');
1162             } elsif ($tag eq '185') {
1163                 return $field->as_string('vxyz68');
1164             } else {
1165                 return $field->as_string();
1166             }
1167         }
1168     }
1169     return;
1170 }
1171
1172 =head2 BuildAuthHierarchies
1173
1174   $text= &BuildAuthHierarchies( $authid, $force)
1175
1176 return text containing trees for hierarchies
1177 for them to be stored in auth_header
1178
1179 Example of text:
1180 122,1314,2452;1324,2342,3,2452
1181
1182 =cut
1183
1184 sub BuildAuthHierarchies{
1185     my $authid = shift @_;
1186 #   warn "authid : $authid";
1187     my $force = shift @_ || (C4::Context->preference('marcflavour') eq 'UNIMARC' ? 0 : 1);
1188     my @globalresult;
1189     my $dbh=C4::Context->dbh;
1190     my $hierarchies;
1191     my $data = GetHeaderAuthority($authid);
1192     if ($data->{'authtrees'} and not $force){
1193         return $data->{'authtrees'};
1194 #  } elsif ($data->{'authtrees'}){
1195 #    $hierarchies=$data->{'authtrees'};
1196     } else {
1197         my $record = GetAuthority($authid);
1198         my $found;
1199         return unless $record;
1200         foreach my $field ($record->field('5..')){
1201             my $broader = 0;
1202             $broader = 1 if (
1203                     (C4::Context->preference('marcflavour') eq 'UNIMARC' && $field->subfield('5') && $field->subfield('5') eq 'g') ||
1204                     (C4::Context->preference('marcflavour') ne 'UNIMARC' && $field->subfield('w') && substr($field->subfield('w'), 0, 1) eq 'g'));
1205             if ($broader) {
1206                 my $subfauthid=_get_authid_subfield($field) || '';
1207                 next if ($subfauthid eq $authid);
1208                 my $parentrecord = GetAuthority($subfauthid);
1209                 next unless $parentrecord;
1210                 my $localresult=$hierarchies;
1211                 my $trees;
1212                 $trees = BuildAuthHierarchies($subfauthid);
1213                 my @trees;
1214                 if ($trees=~/;/){
1215                     @trees = split(/;/,$trees);
1216                 } else {
1217                     push @trees, $trees;
1218                 }
1219                 foreach (@trees){
1220                     $_.= ",$authid";
1221                 }
1222                 @globalresult = (@globalresult,@trees);
1223                 $found=1;
1224             }
1225             $hierarchies=join(";",@globalresult);
1226         }
1227 #Unless there is no ancestor, I am alone.
1228         $hierarchies="$authid" unless ($hierarchies);
1229     }
1230     AddAuthorityTrees($authid,$hierarchies);
1231     return $hierarchies;
1232 }
1233
1234 =head2 BuildAuthHierarchy
1235
1236   $ref= &BuildAuthHierarchy( $record, $class,$authid)
1237
1238 return a hashref in order to display hierarchy for record and final Authid $authid
1239
1240 "loopparents"
1241 "loopchildren"
1242 "class"
1243 "loopauthid"
1244 "current_value"
1245 "value"
1246
1247 =cut
1248
1249 sub BuildAuthHierarchy{
1250     my $record = shift @_;
1251     my $class = shift @_;
1252     my $authid_constructed = shift @_;
1253     return unless ($record && $record->field('001'));
1254     my $authid=$record->field('001')->data();
1255     my %cell;
1256     my $parents=""; my $children="";
1257     my (@loopparents,@loopchildren);
1258     my $marcflavour = C4::Context->preference('marcflavour');
1259     my $relationshipsf = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1260     foreach my $field ($record->field('5..')){
1261         my $subfauthid=_get_authid_subfield($field);
1262         if ($subfauthid && $field->subfield($relationshipsf) && $field->subfield('a')){
1263             my $relationship = substr($field->subfield($relationshipsf), 0, 1);
1264             if ($relationship eq 'h'){
1265                 push @loopchildren, { "authid"=>$subfauthid,"value"=>$field->subfield('a')};
1266             }
1267             elsif ($relationship eq 'g'){
1268                 push @loopparents, { "authid"=>$subfauthid,"value"=>$field->subfield('a')};
1269             }
1270 # brothers could get in there with an else
1271         }
1272     }
1273     $cell{"parents"}=\@loopparents;
1274     $cell{"children"}=\@loopchildren;
1275     $cell{"class"}=$class;
1276     $cell{"authid"}=$authid;
1277     $cell{"current_value"} =1 if ($authid eq $authid_constructed);
1278     $cell{"value"}=C4::Context->preference('marcflavour') eq 'UNIMARC' ? $record->subfield('2..',"a") : $record->subfield('1..', 'a');
1279     return \%cell;
1280 }
1281
1282 =head2 BuildAuthHierarchyBranch
1283
1284   $branch = &BuildAuthHierarchyBranch( $tree, $authid[, $cnt])
1285
1286 Return a data structure representing an authority hierarchy
1287 given a list of authorities representing a single branch in
1288 an authority hierarchy tree. $authid is the current node in
1289 the tree (which may or may not be somewhere in the middle).
1290 $cnt represents the level of the upper-most item, and is only
1291 used when BuildAuthHierarchyBranch is called recursively (i.e.,
1292 don't ever pass in anything but zero to it).
1293
1294 =cut
1295
1296 sub BuildAuthHierarchyBranch {
1297     my ($tree, $authid, $cnt) = @_;
1298     $cnt |= 0;
1299     my $elementdata = GetAuthority(shift @$tree);
1300     my $branch = BuildAuthHierarchy($elementdata,"child".$cnt, $authid);
1301     if (scalar @$tree > 0) {
1302         my $nextBranch = BuildAuthHierarchyBranch($tree, $authid, ++$cnt);
1303         my $nextAuthid = $nextBranch->{authid};
1304         my $found;
1305         # If we already have the next branch listed as a child, let's
1306         # replace the old listing with the new one. If not, we will add
1307         # the branch at the end.
1308         foreach my $cell (@{$branch->{children}}) {
1309             if ($cell->{authid} eq $nextAuthid) {
1310                 $cell = $nextBranch;
1311                 $found = 1;
1312                 last;
1313             }
1314         }
1315         push @{$branch->{children}}, $nextBranch unless $found;
1316     }
1317     return $branch;
1318 }
1319
1320 =head2 GenerateHierarchy
1321
1322   $hierarchy = &GenerateHierarchy($authid);
1323
1324 Return an arrayref holding one or more "trees" representing
1325 authority hierarchies.
1326
1327 =cut
1328
1329 sub GenerateHierarchy {
1330     my ($authid) = @_;
1331     my $trees    = BuildAuthHierarchies($authid);
1332     my @trees    = split /;/,$trees ;
1333     push @trees,$trees unless (@trees);
1334     my @loophierarchies;
1335     foreach my $tree (@trees){
1336         my @tree=split /,/,$tree;
1337         push @tree, $tree unless (@tree);
1338         my $branch = BuildAuthHierarchyBranch(\@tree, $authid);
1339         push @loophierarchies, [ $branch ];
1340     }
1341     return \@loophierarchies;
1342 }
1343
1344 sub _get_authid_subfield{
1345     my ($field)=@_;
1346     return $field->subfield('9')||$field->subfield('3');
1347 }
1348 =head2 GetHeaderAuthority
1349
1350   $ref= &GetHeaderAuthority( $authid)
1351
1352 return a hashref in order auth_header table data
1353
1354 =cut
1355
1356 sub GetHeaderAuthority{
1357   my $authid = shift @_;
1358   my $sql= "SELECT * from auth_header WHERE authid = ?";
1359   my $dbh=C4::Context->dbh;
1360   my $rq= $dbh->prepare($sql);
1361   $rq->execute($authid);
1362   my $data= $rq->fetchrow_hashref;
1363   return $data;
1364 }
1365
1366 =head2 AddAuthorityTrees
1367
1368   $ref= &AddAuthorityTrees( $authid, $trees)
1369
1370 return success or failure
1371
1372 =cut
1373
1374 sub AddAuthorityTrees{
1375   my $authid = shift @_;
1376   my $trees = shift @_;
1377   my $sql= "UPDATE IGNORE auth_header set authtrees=? WHERE authid = ?";
1378   my $dbh=C4::Context->dbh;
1379   my $rq= $dbh->prepare($sql);
1380   return $rq->execute($trees,$authid);
1381 }
1382
1383 =head2 merge
1384
1385   $ref= &merge(mergefrom,$MARCfrom,$mergeto,$MARCto)
1386
1387 Could add some feature : Migrating from a typecode to an other for instance.
1388 Then we should add some new parameter : bibliotargettag, authtargettag
1389
1390 =cut
1391
1392 sub merge {
1393     my ($mergefrom,$MARCfrom,$mergeto,$MARCto) = @_;
1394     my ($counteditedbiblio,$countunmodifiedbiblio,$counterrors)=(0,0,0);
1395     my $dbh=C4::Context->dbh;
1396     my $authfrom = Koha::Authorities->find($mergefrom);
1397     my $authto = Koha::Authorities->find($mergeto);
1398     my $authtypefrom = Koha::Authority::Types->find($authfrom->authtypecode);
1399     my $authtypeto   = Koha::Authority::Types->find($authto->authtypecode);
1400
1401     return "error MARCFROM not a marcrecord ".Data::Dumper::Dumper($MARCfrom) if scalar($MARCfrom->fields()) == 0;
1402     return "error MARCTO not a marcrecord".Data::Dumper::Dumper($MARCto) if scalar($MARCto->fields()) == 0;
1403     # search the tag to report
1404     my $auth_tag_to_report_from = $authtypefrom->auth_tag_to_report;
1405     my $auth_tag_to_report_to   = $authtypeto->auth_tag_to_report;
1406
1407     my @record_to;
1408     @record_to = $MARCto->field($auth_tag_to_report_to)->subfields() if $MARCto->field($auth_tag_to_report_to);
1409     my @record_from;
1410     @record_from = $MARCfrom->field($auth_tag_to_report_from)->subfields() if $MARCfrom->field($auth_tag_to_report_from);
1411
1412     my @reccache;
1413     # search all biblio tags using this authority.
1414     #Getting marcbiblios impacted by the change.
1415     #zebra connection
1416     my $oConnection=C4::Context->Zconn("biblioserver",0);
1417     # We used to use XML syntax here, but that no longer works.
1418     # Thankfully, we don't need it.
1419     my $query;
1420     $query= "an=".$mergefrom;
1421     my $oResult = $oConnection->search(new ZOOM::Query::CCL2RPN( $query, $oConnection ));
1422     my $count = 0;
1423     if  ($oResult) {
1424         $count=$oResult->size();
1425     }
1426     my $z=0;
1427     while ( $z<$count ) {
1428         my $marcrecordzebra = C4::Search::new_record_from_zebra(
1429             'biblioserver',
1430             $oResult->record($z)->raw()
1431         );
1432         my ( $biblionumbertagfield, $biblionumbertagsubfield ) = &GetMarcFromKohaField( "biblio.biblionumber", '' );
1433         my $i = ($biblionumbertagfield < 10)
1434             ? $marcrecordzebra->field( $biblionumbertagfield )->data
1435             : $marcrecordzebra->subfield( $biblionumbertagfield, $biblionumbertagsubfield );
1436         my $marcrecorddb = GetMarcBiblio($i);
1437         push @reccache, $marcrecorddb;
1438         $z++;
1439     }
1440     $oResult->destroy();
1441     # Get All candidate Tags for the change
1442     # (This will reduce the search scope in marc records).
1443     my $sql = "SELECT DISTINCT tagfield FROM marc_subfield_structure WHERE authtypecode=?";
1444     my $tags_using_authtype = $dbh->selectcol_arrayref( $sql, undef, ( $authtypefrom->authtypecode ));
1445     my $tags_new;
1446     if ($authtypeto->authtypecode ne $authtypefrom->authtypecode){
1447         $tags_new = $dbh->selectcol_arrayref( $sql, undef, ( $authtypeto->authtypecode ));
1448     }
1449
1450     my $overwrite = C4::Context->preference( 'AuthorityMergeMode' ) eq 'strict';
1451     my $skip_subfields = $overwrite
1452         # This hash contains all subfields from the authority report fields
1453         # Including $MARCfrom as well as $MARCto
1454         # We only need it in loose merge mode; replaces the former $exclude
1455         ? {}
1456         : { map { ( $_->[0], 1 ); } ( @record_from, @record_to ) };
1457     # And we need to add $9 in order not to duplicate
1458     $skip_subfields->{9} = 1 if !$overwrite;
1459
1460     foreach my $marcrecord(@reccache){
1461         my $update = 0;
1462         foreach my $tagfield (@$tags_using_authtype) {
1463             my $countfrom = 0;    # used in strict mode to remove duplicates
1464             foreach my $field ( $marcrecord->field($tagfield) ) {
1465                 my $auth_number = $field->subfield("9");    # link to authority
1466                 my $tag         = $field->tag();
1467                 next if !defined($auth_number) || $auth_number ne $mergefrom;
1468                 $countfrom++;
1469                 if ( $overwrite && $countfrom > 1 ) {
1470                     # remove this duplicate in strict mode
1471                     $marcrecord->delete_field($field);
1472                     $update = 1;
1473                     next;
1474                 }
1475                 my $newtag = $tags_new
1476                   ? _merge_newtag( $tag, $tags_new )
1477                   : $tag;
1478                 my $field_to = MARC::Field->new(
1479                     $newtag,
1480                     $field->indicator(1),
1481                     $field->indicator(2),
1482                     "9" => $mergeto,
1483                 );
1484                 foreach my $subfield ( grep { $_->[0] ne '9' } @record_to ) {
1485                     $field_to->add_subfields( $subfield->[0] => $subfield->[1] );
1486                 }
1487                 if ( !$overwrite ) {
1488                     # add subfields back in loose mode, check skip_subfields
1489                     foreach my $subfield ( $field->subfields ) {
1490                         next if $skip_subfields->{ $subfield->[0] };
1491                         $field_to->add_subfields( $subfield->[0], $subfield->[1] );
1492                     }
1493                 }
1494                 if ($tags_new) {
1495                     $marcrecord->delete_field($field);
1496                     append_fields_ordered( $marcrecord, $field_to );
1497                 } else {
1498                     $field->replace_with($field_to);
1499                 }
1500                 $update = 1;
1501             }
1502         }
1503         my ($bibliotag,$bibliosubf) = GetMarcFromKohaField("biblio.biblionumber","") ;
1504         my $biblionumber;
1505         if ($bibliotag<10){
1506             $biblionumber=$marcrecord->field($bibliotag)->data;
1507         }
1508         else {
1509             $biblionumber=$marcrecord->subfield($bibliotag,$bibliosubf);
1510         }
1511         unless ($biblionumber){
1512             warn "pas de numéro de notice bibliographique dans : ".$marcrecord->as_formatted;
1513             next;
1514         }
1515         if ($update==1){
1516             &ModBiblio($marcrecord,$biblionumber,GetFrameworkCode($biblionumber)) ;
1517             $counteditedbiblio++;
1518             warn $counteditedbiblio if (($counteditedbiblio % 10) and $ENV{DEBUG});
1519         }
1520     }
1521     return $counteditedbiblio;
1522 }
1523
1524 sub _merge_newtag {
1525 # Routine is only called for an (exceptional) authtypecode change
1526 # Fixes old behavior of returning the first tag found
1527     my ( $oldtag, $new_tags ) = @_;
1528
1529     # If we e.g. have 650 and 151,651,751 try 651 and check presence
1530     my $prefix = substr( $oldtag, 0, 1 );
1531     my $guess = $prefix . substr( $new_tags->[0], -2 );
1532     if( grep { $_ eq $guess } @$new_tags ) {
1533         return $guess;
1534     }
1535     # Otherwise return one from the same block e.g. 6XX for 650
1536     # If not there too, fall back to first new tag (old behavior!)
1537     my @same_block = grep { /^$prefix/ } @$new_tags;
1538     return @same_block ? $same_block[0] : $new_tags->[0];
1539 }
1540
1541 sub append_fields_ordered {
1542 # while we lack this function in MARC::Record
1543 # we do not want insert_fields_ordered since it inserts before
1544     my ( $record, $field ) = @_;
1545     if( my @flds = $record->field( $field->tag ) ) {
1546         $record->insert_fields_after( pop @flds, $field );
1547     } else { # now fallback to insert_fields_ordered
1548         $record->insert_fields_ordered( $field );
1549     }
1550 }
1551
1552 =head2 get_auth_type_location
1553
1554   my ($tag, $subfield) = get_auth_type_location($auth_type_code);
1555
1556 Get the tag and subfield used to store the heading type
1557 for indexing purposes.  The C<$auth_type> parameter is
1558 optional; if it is not supplied, assume ''.
1559
1560 This routine searches the MARC authority framework
1561 for the tag and subfield whose kohafield is
1562 C<auth_header.authtypecode>; if no such field is
1563 defined in the framework, default to the hardcoded value
1564 specific to the MARC format.
1565
1566 =cut
1567
1568 sub get_auth_type_location {
1569     my $auth_type_code = @_ ? shift : '';
1570
1571     my ($tag, $subfield) = GetAuthMARCFromKohaField('auth_header.authtypecode', $auth_type_code);
1572     if (defined $tag and defined $subfield and $tag != 0 and $subfield ne '' and $subfield ne ' ') {
1573         return ($tag, $subfield);
1574     } else {
1575         if (C4::Context->preference('marcflavour') eq "MARC21")  {
1576             return C4::AuthoritiesMarc::MARC21::default_auth_type_location();
1577         } else {
1578             return C4::AuthoritiesMarc::UNIMARC::default_auth_type_location();
1579         }
1580     }
1581 }
1582
1583 END { }       # module clean-up code here (global destructor)
1584
1585 1;
1586 __END__
1587
1588 =head1 AUTHOR
1589
1590 Koha Development Team <http://koha-community.org/>
1591
1592 Paul POULAIN paul.poulain@free.fr
1593
1594 =cut
1595