C4/AuthoritiesMarc.pm

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