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= new ZOOM::Query::PQF($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
 475 FROM auth_subfield_structure
 476 WHERE authtypecode=?
 477 ORDER BY tagfield,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 $link;
 489     my $defaultvalue;
 490
 491     while (
 492         ( $tag,         $subfield,   $liblibrarian,   , $libopac,      $tab,
 493         $mandatory,     $repeatable, $authorised_value, $authtypecode,
 494         $value_builder, $kohafield,  $seealso,          $hidden,
 495         $isurl,         $defaultvalue, $link )
 496         = $sth->fetchrow
 497       )
 498     {
 499         $res->{$tag}->{$subfield}->{lib}              = ($forlibrarian or !$libopac)?$liblibrarian:$libopac;
 500         $res->{$tag}->{$subfield}->{tab}              = $tab;
 501         $res->{$tag}->{$subfield}->{mandatory}        = $mandatory;
 502         $res->{$tag}->{$subfield}->{repeatable}       = $repeatable;
 503         $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
 504         $res->{$tag}->{$subfield}->{authtypecode}     = $authtypecode;
 505         $res->{$tag}->{$subfield}->{value_builder}    = $value_builder;
 506         $res->{$tag}->{$subfield}->{kohafield}        = $kohafield;
 507         $res->{$tag}->{$subfield}->{seealso}          = $seealso;
 508         $res->{$tag}->{$subfield}->{hidden}           = $hidden;
 509         $res->{$tag}->{$subfield}->{isurl}            = $isurl;
 510         $res->{$tag}->{$subfield}->{link}            = $link;
 511         $res->{$tag}->{$subfield}->{defaultvalue}     = $defaultvalue;
 512     }
 513     return $res;
 514 }
 515
 516 =head2 AddAuthority
 517
 518   $authid= &AddAuthority($record, $authid,$authtypecode)
 519
 520 Either Create Or Modify existing authority.
 521 returns authid of the newly created authority
 522
 523 =cut
 524
 525 sub AddAuthority {
 526 # pass the MARC::Record to this function, and it will create the records in the authority table
 527   my ($record,$authid,$authtypecode) = @_;
 528   my $dbh=C4::Context->dbh;
 529         my $leader='     nz  a22     o  4500';#Leader for incomplete MARC21 record
 530
 531 # if authid empty => true add, find a new authid number
 532     my $format;
 533     if (uc(C4::Context->preference('marcflavour')) eq 'UNIMARC') {
 534         $format= 'UNIMARCAUTH';
 535     }
 536     else {
 537         $format= 'MARC21';
 538     }
 539
 540     #update date/time to 005 for marc and unimarc
 541     my $time=POSIX::strftime("%Y%m%d%H%M%S",localtime);
 542     my $f5=$record->field('005');
 543     if (!$f5) {
 544       $record->insert_fields_ordered( MARC::Field->new('005',$time.".0") );
 545     }
 546     else {
 547       $f5->update($time.".0");
 548     }
 549
 550     SetUTF8Flag($record);
 551         if ($format eq "MARC21") {
 552         my $userenv = C4::Context->userenv;
 553         my $library;
 554         my $marcorgcode = C4::Context->preference('MARCOrgCode');
 555         if ( $userenv && $userenv->{'branch'} ) {
 556             $library = Koha::Libraries->find( $userenv->{'branch'} );
 557             # userenv's library could not exist because of a trick in misc/commit_file.pl (see FIXME and set_userenv statement)
 558             $marcorgcode = $library ? $library->get_effective_marcorgcode : $marcorgcode;
 559         }
 560                 if (!$record->leader) {
 561                         $record->leader($leader);
 562                 }
 563                 if (!$record->field('003')) {
 564                         $record->insert_fields_ordered(
 565                 MARC::Field->new('003', $marcorgcode),
 566                         );
 567                 }
 568                 my $date=POSIX::strftime("%y%m%d",localtime);
 569                 if (!$record->field('008')) {
 570             # Get a valid default value for field 008
 571             my $default_008 = C4::Context->preference('MARCAuthorityControlField008');
 572             if(!$default_008 or length($default_008)<34) {
 573                 $default_008 = '|| aca||aabn           | a|a     d';
 574             }
 575             else {
 576                 $default_008 = substr($default_008,0,34);
 577             }
 578
 579             $record->insert_fields_ordered( MARC::Field->new('008',$date.$default_008) );
 580                 }
 581                 if (!$record->field('040')) {
 582                  $record->insert_fields_ordered(
 583         MARC::Field->new('040','','',
 584             'a' => $marcorgcode,
 585             'c' => $marcorgcode,
 586                                 )
 587                         );
 588     }
 589         }
 590
 591   if ($format eq "UNIMARCAUTH") {
 592         $record->leader("     nx  j22             ") unless ($record->leader());
 593         my $date=POSIX::strftime("%Y%m%d",localtime);
 594         my $defaultfield100 = C4::Context->preference('UNIMARCAuthorityField100');
 595     if (my $string=$record->subfield('100',"a")){
 596         $string=~s/fre50/frey50/;
 597         $record->field('100')->update('a'=>$string);
 598     }
 599     elsif ($record->field('100')){
 600           $record->field('100')->update('a'=>$date.$defaultfield100);
 601     } else {
 602         $record->append_fields(
 603         MARC::Field->new('100',' ',' '
 604             ,'a'=>$date.$defaultfield100)
 605         );
 606     }
 607   }
 608   my ($auth_type_tag, $auth_type_subfield) = get_auth_type_location($authtypecode);
 609   if (!$authid and $format eq "MARC21") {
 610     # only need to do this fix when modifying an existing authority
 611     C4::AuthoritiesMarc::MARC21::fix_marc21_auth_type_location($record, $auth_type_tag, $auth_type_subfield);
 612   }
 613   if (my $field=$record->field($auth_type_tag)){
 614     $field->update($auth_type_subfield=>$authtypecode);
 615   }
 616   else {
 617     $record->add_fields($auth_type_tag,'','', $auth_type_subfield=>$authtypecode);
 618   }
 619
 620     # Save record into auth_header, update 001
 621     if (!$authid ) {
 622         # Save a blank record, get authid
 623         $dbh->do( "INSERT INTO auth_header (datecreated,marcxml) values (NOW(),?)", undef, '' );
 624         $authid = $dbh->last_insert_id( undef, undef, 'auth_header', 'authid' );
 625         logaction( "AUTHORITIES", "ADD", $authid, "authority" ) if C4::Context->preference("AuthoritiesLog");
 626     }
 627     # Insert/update the recordID in MARC record
 628     $record->delete_field( $record->field('001') );
 629     $record->insert_fields_ordered( MARC::Field->new( '001', $authid ) );
 630     # Update
 631     $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;
 632     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::AUTHORITIES_INDEX });
 633     $indexer->index_records( $authid, "specialUpdate", "authorityserver", $record );
 634
 635     return ( $authid );
 636 }
 637
 638 =head2 DelAuthority
 639
 640     DelAuthority({ authid => $authid, [ skip_merge => 1 ] });
 641
 642 Deletes $authid and calls merge to cleanup linked biblio records.
 643 Parameter skip_merge is used in authorities/merge.pl. You should normally not
 644 use it.
 645
 646 =cut
 647
 648 sub DelAuthority {
 649     my ( $params ) = @_;
 650     my $authid = $params->{authid} || return;
 651     my $skip_merge = $params->{skip_merge};
 652     my $dbh = C4::Context->dbh;
 653
 654     # Remove older pending merge requests for $authid to itself. (See bug 22437)
 655     my $condition = { authid => $authid, authid_new => [undef, 0, $authid], done => 0 };
 656     Koha::Authority::MergeRequests->search($condition)->delete;
 657
 658     merge({ mergefrom => $authid }) if !$skip_merge;
 659     $dbh->do( "DELETE FROM auth_header WHERE authid=?", undef, $authid );
 660     logaction( "AUTHORITIES", "DELETE", $authid, "authority" ) if C4::Context->preference("AuthoritiesLog");
 661     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::AUTHORITIES_INDEX });
 662     $indexer->index_records( $authid, "recordDelete", "authorityserver", undef );
 663 }
 664
 665 =head2 ModAuthority
 666
 667   $authid= &ModAuthority($authid,$record,$authtypecode)
 668
 669 Modifies authority record, optionally updates attached biblios.
 670
 671 =cut
 672
 673 sub ModAuthority {
 674     my ( $authid, $record, $authtypecode ) = @_;
 675     my $oldrecord = GetAuthority($authid);
 676     #Now rewrite the $record to table with an add
 677     $authid = AddAuthority($record, $authid, $authtypecode);
 678     merge({ mergefrom => $authid, MARCfrom => $oldrecord, mergeto => $authid, MARCto => $record });
 679     logaction( "AUTHORITIES", "MODIFY", $authid, "authority BEFORE=>" . $oldrecord->as_formatted ) if C4::Context->preference("AuthoritiesLog");
 680     return $authid;
 681 }
 682
 683 =head2 GetAuthorityXML
 684
 685   $marcxml= &GetAuthorityXML( $authid)
 686
 687 returns xml form of record $authid
 688
 689 =cut
 690
 691 sub GetAuthorityXML {
 692   # Returns MARC::XML of the authority passed in parameter.
 693   my ( $authid ) = @_;
 694   if (uc(C4::Context->preference('marcflavour')) eq 'UNIMARC') {
 695       my $dbh=C4::Context->dbh;
 696       my $sth = $dbh->prepare("select marcxml from auth_header where authid=? "  );
 697       $sth->execute($authid);
 698       my ($marcxml)=$sth->fetchrow;
 699       return $marcxml;
 700   }
 701   else {
 702       # for MARC21, call GetAuthority instead of
 703       # getting the XML directly since we may
 704       # need to fix up the location of the authority
 705       # code -- note that this is reasonably safe
 706       # because GetAuthorityXML is used only by the
 707       # indexing processes like zebraqueue_start.pl
 708       my $record = GetAuthority($authid);
 709       return $record->as_xml_record('MARC21');
 710   }
 711 }
 712
 713 =head2 GetAuthority
 714
 715   $record= &GetAuthority( $authid)
 716
 717 Returns MARC::Record of the authority passed in parameter.
 718
 719 =cut
 720
 721 sub GetAuthority {
 722     my ($authid)=@_;
 723     my $authority = Koha::MetadataRecord::Authority->get_from_authid($authid);
 724     return unless $authority;
 725     return ($authority->record);
 726 }
 727
 728 =head2 FindDuplicateAuthority
 729
 730   $record= &FindDuplicateAuthority( $record, $authtypecode)
 731
 732 return $authid,Summary if duplicate is found.
 733
 734 Comments : an improvement would be to return All the records that match.
 735
 736 =cut
 737
 738 sub FindDuplicateAuthority {
 739
 740     my ($record,$authtypecode)=@_;
 741 #    warn "IN for ".$record->as_formatted;
 742     my $dbh = C4::Context->dbh;
 743 #    warn "".$record->as_formatted;
 744     my $auth_tag_to_report = Koha::Authority::Types->find($authtypecode)->auth_tag_to_report;
 745 #     warn "record :".$record->as_formatted."  auth_tag_to_report :$auth_tag_to_report";
 746     # build a request for SearchAuthorities
 747     my $op = 'AND';
 748     $authtypecode =~ s#/#\\/#; # GENRE/FORM contains forward slash which is a reserved character
 749     my $query='at:'.$authtypecode.' ';
 750     my $filtervalues=qr([\001-\040\Q!'"`#$%&*+,-./:;<=>?@(){[}_|~\E\]]);
 751     if ($record->field($auth_tag_to_report)) {
 752         foreach ($record->field($auth_tag_to_report)->subfields()) {
 753             $_->[1]=~s/$filtervalues/ /g; $query.= " $op he:\"".$_->[1]."\"" if ($_->[0]=~/[A-z]/);
 754         }
 755     }
 756     my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::AUTHORITIES_INDEX});
 757     my ($error, $results, $total_hits) = $searcher->simple_search_compat( $query, 0, 1, [ 'authorityserver' ] );
 758     # there is at least 1 result => return the 1st one
 759     if (!defined $error && @{$results} ) {
 760         my $marcrecord = C4::Search::new_record_from_zebra(
 761             'authorityserver',
 762             $results->[0]
 763         );
 764         return $marcrecord->field('001')->data,BuildSummary($marcrecord,$marcrecord->field('001')->data,$authtypecode);
 765     }
 766     # no result, returns nothing
 767     return;
 768 }
 769
 770 =head2 BuildSummary
 771
 772   $summary= &BuildSummary( $record, $authid, $authtypecode)
 773
 774 Returns a hashref with a summary of the specified record.
 775
 776 Comment : authtypecode can be inferred from both record and authid.
 777 Moreover, authid can also be inferred from $record.
 778 Would it be interesting to delete those things.
 779
 780 =cut
 781
 782 sub BuildSummary {
 783     ## give this a Marc record to return summary
 784     my ($record,$authid,$authtypecode)=@_;
 785     my $dbh=C4::Context->dbh;
 786     my %summary;
 787     my $summary_template;
 788     # handle $authtypecode is NULL or eq ""
 789     if ($authtypecode) {
 790         my $authref = Koha::Authority::Types->find($authtypecode);
 791         if ( $authref ) {
 792             $summary{authtypecode} = $authref->authtypecode;
 793             $summary{type} = $authref->authtypetext;
 794             $summary_template = $authref->summary;
 795             # for MARC21, the authority type summary displays a label meant for
 796             # display
 797             if (C4::Context->preference('marcflavour') ne 'UNIMARC') {
 798                 $summary{label} = $authref->summary;
 799             } else {
 800                 $summary{summary} = $authref->summary;
 801             }
 802         }
 803     }
 804     my $marc21subfields = 'abcdfghjklmnopqrstuvxyz68';
 805     my %marc21controlrefs = ( 'a' => 'earlier',
 806         'b' => 'later',
 807         'd' => 'acronym',
 808         'f' => 'musical',
 809         'g' => 'broader',
 810         'h' => 'narrower',
 811         'n' => 'notapplicable',
 812         'i' => 'subfi',
 813         't' => 'parent'
 814     );
 815     my %unimarc_relation_from_code = (
 816         g => 'broader',
 817         h => 'narrower',
 818         a => 'seealso',
 819     );
 820     my %thesaurus;
 821     $thesaurus{'1'}="Peuples";
 822     $thesaurus{'2'}="Anthroponymes";
 823     $thesaurus{'3'}="Oeuvres";
 824     $thesaurus{'4'}="Chronologie";
 825     $thesaurus{'5'}="Lieux";
 826     $thesaurus{'6'}="Sujets";
 827     #thesaurus a remplir
 828     my $reported_tag;
 829 # if the library has a summary defined, use it. Otherwise, build a standard one
 830 # FIXME - it appears that the summary field in the authority frameworks
 831 #         can work as a display template.  However, this doesn't
 832 #         suit the MARC21 version, so for now the "templating"
 833 #         feature will be enabled only for UNIMARC for backwards
 834 #         compatibility.
 835     if ($summary{summary} and C4::Context->preference('marcflavour') eq 'UNIMARC') {
 836         my @matches = ($summary{summary} =~ m/\[(.*?)(\d{3})([\*a-z0-9])(.*?)\]/g);
 837         my (@textbefore, @tag, @subtag, @textafter);
 838         for(my $i = 0; $i < scalar @matches; $i++){
 839             push @textbefore, $matches[$i] if($i%4 == 0);
 840             push @tag,        $matches[$i] if($i%4 == 1);
 841             push @subtag,     $matches[$i] if($i%4 == 2);
 842             push @textafter,  $matches[$i] if($i%4 == 3);
 843         }
 844         for(my $i = scalar @tag; $i >= 0; $i--){
 845             my $textbefore = $textbefore[$i] || '';
 846             my $tag = $tag[$i] || '';
 847             my $subtag = $subtag[$i] || '';
 848             my $textafter = $textafter[$i] || '';
 849             my $value = '';
 850             my $field = $record->field($tag);
 851             if ( $field ) {
 852                 if($subtag eq '*') {
 853                     if($tag < 10) {
 854                         $value = $textbefore . $field->data() . $textafter;
 855                     }
 856                 } else {
 857                     my @subfields = $field->subfield($subtag);
 858                     if(@subfields > 0) {
 859                         $value = $textbefore . join (" - ", @subfields) . $textafter;
 860                     }
 861                 }
 862             }
 863             $summary{summary} =~ s/\[\Q$textbefore$tag$subtag$textafter\E\]/$value/;
 864         }
 865         $summary{summary} =~ s/\\n/<br \/>/g;
 866     }
 867     my @authorized;
 868     my @notes;
 869     my @seefrom;
 870     my @seealso;
 871     my @otherscript;
 872     if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
 873 # construct UNIMARC summary, that is quite different from MARC21 one
 874 # accepted form
 875         foreach my $field ($record->field('2..')) {
 876             push @authorized, {
 877                 heading => $field->as_string('abcdefghijlmnopqrstuvwxyz'),
 878                 hemain  => ( $field->subfield('a') // undef ),
 879                 field   => $field->tag(),
 880             };
 881         }
 882 # rejected form(s)
 883         foreach my $field ($record->field('3..')) {
 884             push @notes, { note => $field->subfield('a'), field => $field->tag() };
 885         }
 886         foreach my $field ($record->field('4..')) {
 887             my $thesaurus = $field->subfield('2') ? "thes. : ".$thesaurus{"$field->subfield('2')"}." : " : '';
 888             push @seefrom, {
 889                 heading => $thesaurus . $field->as_string('abcdefghijlmnopqrstuvwxyz'),
 890                 hemain  => ( $field->subfield('a') // undef ),
 891                 type    => 'seefrom',
 892                 field   => $field->tag(),
 893             };
 894         }
 895
 896         # see :
 897         @seealso = map {
 898             my $type = $unimarc_relation_from_code{$_->subfield('5') || 'a'};
 899             my $heading = $_->as_string('abcdefgjxyz');
 900             {
 901                 field   => $_->tag,
 902                 type    => $type,
 903                 heading => $heading,
 904                 hemain  => ( $_->subfield('a') // undef ),
 905                 search  => $heading,
 906                 authid  => ( $_->subfield('9') // undef ),
 907             }
 908         } $record->field('5..');
 909
 910         # Other forms
 911         @otherscript = map { {
 912             lang      => length ($_->subfield('8')) == 6 ? substr ($_->subfield('8'), 3, 3) : $_->subfield('8') || '',
 913             term      => $_->subfield('a') . ($_->subfield('b') ? ', ' . $_->subfield('b') : ''),
 914             direction => 'ltr',
 915             field     => $_->tag,
 916         } } $record->field('7..');
 917
 918     } else {
 919 # construct MARC21 summary
 920 # FIXME - looping over 1XX is questionable
 921 # since MARC21 authority should have only one 1XX
 922         my $subfields_to_report;
 923         foreach my $field ($record->field('1..')) {
 924             my $tag = $field->tag();
 925             next if "152" eq $tag;
 926 # FIXME - 152 is not a good tag to use
 927 # in MARC21 -- purely local tags really ought to be
 928 # 9XX
 929             if ($tag eq '100') {
 930                 $subfields_to_report = 'abcdefghjklmnopqrstvxyz';
 931             } elsif ($tag eq '110') {
 932                 $subfields_to_report = 'abcdefghklmnoprstvxyz';
 933             } elsif ($tag eq '111') {
 934                 $subfields_to_report = 'acdefghklnpqstvxyz';
 935             } elsif ($tag eq '130') {
 936                 $subfields_to_report = 'adfghklmnoprstvxyz';
 937             } elsif ($tag eq '148') {
 938                 $subfields_to_report = 'abvxyz';
 939             } elsif ($tag eq '150') {
 940                 $subfields_to_report = 'abvxyz';
 941             } elsif ($tag eq '151') {
 942                 $subfields_to_report = 'avxyz';
 943             } elsif ($tag eq '155') {
 944                 $subfields_to_report = 'abvxyz';
 945             } elsif ($tag eq '180') {
 946                 $subfields_to_report = 'vxyz';
 947             } elsif ($tag eq '181') {
 948                 $subfields_to_report = 'vxyz';
 949             } elsif ($tag eq '182') {
 950                 $subfields_to_report = 'vxyz';
 951             } elsif ($tag eq '185') {
 952                 $subfields_to_report = 'vxyz';
 953             }
 954             if ($subfields_to_report) {
 955                 push @authorized, {
 956                     heading => $field->as_string($subfields_to_report),
 957                     hemain  => ( $field->subfield( substr($subfields_to_report, 0, 1) ) // undef ),
 958                     field   => $tag,
 959                 };
 960             } else {
 961                 push @authorized, {
 962                     heading => $field->as_string(),
 963                     hemain  => ( $field->subfield( 'a' ) // undef ),
 964                     field   => $tag,
 965                 };
 966             }
 967         }
 968         foreach my $field ($record->field('4..')) { #See From
 969             my $type = 'seefrom';
 970             $type = ($marc21controlrefs{substr $field->subfield('w'), 0, 1} || '') if ($field->subfield('w'));
 971             if ($type eq 'notapplicable') {
 972                 $type = substr $field->subfield('w'), 2, 1;
 973                 $type = 'earlier' if $type && $type ne 'n';
 974             }
 975             if ($type eq 'subfi') {
 976                 push @seefrom, {
 977                     heading => $field->as_string($marc21subfields),
 978                     hemain  => scalar $field->subfield( substr($marc21subfields, 0, 1) ),
 979                     type    => ($field->subfield('i') || ''),
 980                     field   => $field->tag(),
 981                 };
 982             } else {
 983                 push @seefrom, {
 984                     heading => $field->as_string($marc21subfields),
 985                     hemain  => scalar $field->subfield( substr($marc21subfields, 0, 1) ),
 986                     type    => $type,
 987                     field   => $field->tag(),
 988                 };
 989             }
 990         }
 991         foreach my $field ($record->field('5..')) { #See Also
 992             my $type = 'seealso';
 993             $type = ($marc21controlrefs{substr $field->subfield('w'), 0, 1} || '') if ($field->subfield('w'));
 994             if ($type eq 'notapplicable') {
 995                 $type = substr $field->subfield('w'), 2, 1;
 996                 $type = 'earlier' if $type && $type ne 'n';
 997             }
 998             if ($type eq 'subfi') {
 999                 push @seealso, {
1000                     heading => $field->as_string($marc21subfields),
1001                     hemain  => scalar $field->subfield( substr($marc21subfields, 0, 1) ),
1002                     type    => scalar $field->subfield('i'),
1003                     field   => $field->tag(),
1004                     search  => $field->as_string($marc21subfields) || '',
1005                     authid  => $field->subfield('9') || ''
1006                 };
1007             } else {
1008                 push @seealso, {
1009                     heading => $field->as_string($marc21subfields),
1010                     hemain  => scalar $field->subfield( substr($marc21subfields, 0, 1) ),
1011                     type    => $type,
1012                     field   => $field->tag(),
1013                     search  => $field->as_string($marc21subfields) || '',
1014                     authid  => $field->subfield('9') || ''
1015                 };
1016             }
1017         }
1018         foreach my $field ($record->field('6..')) {
1019             push @notes, { note => $field->as_string(), field => $field->tag() };
1020         }
1021         foreach my $field ($record->field('880')) {
1022             my $linkage = $field->subfield('6');
1023             my $category = substr $linkage, 0, 1;
1024             if ($category eq '1') {
1025                 $category = 'preferred';
1026             } elsif ($category eq '4') {
1027                 $category = 'seefrom';
1028             } elsif ($category eq '5') {
1029                 $category = 'seealso';
1030             }
1031             my $type;
1032             if ($field->subfield('w')) {
1033                 $type = $marc21controlrefs{substr $field->subfield('w'), '0'};
1034             } else {
1035                 $type = $category;
1036             }
1037             my $direction = $linkage =~ m#/r$# ? 'rtl' : 'ltr';
1038             push @otherscript, { term => $field->as_string($subfields_to_report), category => $category, type => $type, direction => $direction, linkage => $linkage };
1039         }
1040     }
1041     $summary{mainentry} = $authorized[0]->{heading};
1042     $summary{mainmainentry} = $authorized[0]->{hemain};
1043     $summary{authorized} = \@authorized;
1044     $summary{notes} = \@notes;
1045     $summary{seefrom} = \@seefrom;
1046     $summary{seealso} = \@seealso;
1047     $summary{otherscript} = \@otherscript;
1048     return \%summary;
1049 }
1050
1051 =head2 GetAuthorizedHeading
1052
1053   $heading = &GetAuthorizedHeading({ record => $record, authid => $authid })
1054
1055 Takes a MARC::Record object describing an authority record or an authid, and
1056 returns a string representation of the first authorized heading. This routine
1057 should be considered a temporary shim to ease the future migration of authority
1058 data from C4::AuthoritiesMarc to the object-oriented Koha::*::Authority.
1059
1060 =cut
1061
1062 sub GetAuthorizedHeading {
1063     my $args = shift;
1064     my $record;
1065     unless ($record = $args->{record}) {
1066         return unless $args->{authid};
1067         $record = GetAuthority($args->{authid});
1068     }
1069     return unless (ref $record eq 'MARC::Record');
1070     if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1071 # construct UNIMARC summary, that is quite different from MARC21 one
1072 # accepted form
1073         foreach my $field ($record->field('2..')) {
1074             return $field->as_string('abcdefghijlmnopqrstuvwxyz');
1075         }
1076     } else {
1077         foreach my $field ($record->field('1..')) {
1078             my $tag = $field->tag();
1079             next if "152" eq $tag;
1080 # FIXME - 152 is not a good tag to use
1081 # in MARC21 -- purely local tags really ought to be
1082 # 9XX
1083             if ($tag eq '100') {
1084                 return $field->as_string('abcdefghjklmnopqrstvxyz68');
1085             } elsif ($tag eq '110') {
1086                 return $field->as_string('abcdefghklmnoprstvxyz68');
1087             } elsif ($tag eq '111') {
1088                 return $field->as_string('acdefghklnpqstvxyz68');
1089             } elsif ($tag eq '130') {
1090                 return $field->as_string('adfghklmnoprstvxyz68');
1091             } elsif ($tag eq '148') {
1092                 return $field->as_string('abvxyz68');
1093             } elsif ($tag eq '150') {
1094                 return $field->as_string('abvxyz68');
1095             } elsif ($tag eq '151') {
1096                 return $field->as_string('avxyz68');
1097             } elsif ($tag eq '155') {
1098                 return $field->as_string('abvxyz68');
1099             } elsif ($tag eq '180') {
1100                 return $field->as_string('vxyz68');
1101             } elsif ($tag eq '181') {
1102                 return $field->as_string('vxyz68');
1103             } elsif ($tag eq '182') {
1104                 return $field->as_string('vxyz68');
1105             } elsif ($tag eq '185') {
1106                 return $field->as_string('vxyz68');
1107             } else {
1108                 return $field->as_string();
1109             }
1110         }
1111     }
1112     return;
1113 }
1114
1115 =head2 BuildAuthHierarchies
1116
1117   $text= &BuildAuthHierarchies( $authid, $force)
1118
1119 return text containing trees for hierarchies
1120 for them to be stored in auth_header
1121
1122 Example of text:
1123 122,1314,2452;1324,2342,3,2452
1124
1125 =cut
1126
1127 sub BuildAuthHierarchies{
1128     my $authid = shift @_;
1129 #   warn "authid : $authid";
1130     my $force = shift @_ || (C4::Context->preference('marcflavour') eq 'UNIMARC' ? 0 : 1);
1131     my @globalresult;
1132     my $dbh=C4::Context->dbh;
1133     my $hierarchies;
1134     my $data = GetHeaderAuthority($authid);
1135     if ($data->{'authtrees'} and not $force){
1136         return $data->{'authtrees'};
1137 #  } elsif ($data->{'authtrees'}){
1138 #    $hierarchies=$data->{'authtrees'};
1139     } else {
1140         my $record = GetAuthority($authid);
1141         my $found;
1142         return unless $record;
1143         foreach my $field ($record->field('5..')){
1144             my $broader = 0;
1145             $broader = 1 if (
1146                     (C4::Context->preference('marcflavour') eq 'UNIMARC' && $field->subfield('5') && $field->subfield('5') eq 'g') ||
1147                     (C4::Context->preference('marcflavour') ne 'UNIMARC' && $field->subfield('w') && substr($field->subfield('w'), 0, 1) eq 'g'));
1148             if ($broader) {
1149                 my $subfauthid=_get_authid_subfield($field) || '';
1150                 next if ($subfauthid eq $authid);
1151                 my $parentrecord = GetAuthority($subfauthid);
1152                 next unless $parentrecord;
1153                 my $localresult=$hierarchies;
1154                 my $trees;
1155                 $trees = BuildAuthHierarchies($subfauthid);
1156                 my @trees;
1157                 if ($trees=~/;/){
1158                     @trees = split(/;/,$trees);
1159                 } else {
1160                     push @trees, $trees;
1161                 }
1162                 foreach (@trees){
1163                     $_.= ",$authid";
1164                 }
1165                 @globalresult = (@globalresult,@trees);
1166                 $found=1;
1167             }
1168             $hierarchies=join(";",@globalresult);
1169         }
1170 #Unless there is no ancestor, I am alone.
1171         $hierarchies="$authid" unless ($hierarchies);
1172     }
1173     AddAuthorityTrees($authid,$hierarchies);
1174     return $hierarchies;
1175 }
1176
1177 =head2 BuildAuthHierarchy
1178
1179   $ref= &BuildAuthHierarchy( $record, $class,$authid)
1180
1181 return a hashref in order to display hierarchy for record and final Authid $authid
1182
1183 "loopparents"
1184 "loopchildren"
1185 "class"
1186 "loopauthid"
1187 "current_value"
1188 "value"
1189
1190 =cut
1191
1192 sub BuildAuthHierarchy{
1193     my $record = shift @_;
1194     my $class = shift @_;
1195     my $authid_constructed = shift @_;
1196     return unless ($record && $record->field('001'));
1197     my $authid=$record->field('001')->data();
1198     my %cell;
1199     my $parents=""; my $children="";
1200     my (@loopparents,@loopchildren);
1201     my $marcflavour = C4::Context->preference('marcflavour');
1202     my $relationshipsf = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1203     foreach my $field ($record->field('5..')){
1204         my $subfauthid=_get_authid_subfield($field);
1205         if ($subfauthid && $field->subfield($relationshipsf) && $field->subfield('a')){
1206             my $relationship = substr($field->subfield($relationshipsf), 0, 1);
1207             if ($relationship eq 'h'){
1208                 push @loopchildren, { "authid"=>$subfauthid,"value"=>$field->subfield('a')};
1209             }
1210             elsif ($relationship eq 'g'){
1211                 push @loopparents, { "authid"=>$subfauthid,"value"=>$field->subfield('a')};
1212             }
1213 # brothers could get in there with an else
1214         }
1215     }
1216     $cell{"parents"}=\@loopparents;
1217     $cell{"children"}=\@loopchildren;
1218     $cell{"class"}=$class;
1219     $cell{"authid"}=$authid;
1220     $cell{"current_value"} =1 if ($authid eq $authid_constructed);
1221     $cell{"value"}=C4::Context->preference('marcflavour') eq 'UNIMARC' ? $record->subfield('2..',"a") : $record->subfield('1..', 'a');
1222     return \%cell;
1223 }
1224
1225 =head2 BuildAuthHierarchyBranch
1226
1227   $branch = &BuildAuthHierarchyBranch( $tree, $authid[, $cnt])
1228
1229 Return a data structure representing an authority hierarchy
1230 given a list of authorities representing a single branch in
1231 an authority hierarchy tree. $authid is the current node in
1232 the tree (which may or may not be somewhere in the middle).
1233 $cnt represents the level of the upper-most item, and is only
1234 used when BuildAuthHierarchyBranch is called recursively (i.e.,
1235 don't ever pass in anything but zero to it).
1236
1237 =cut
1238
1239 sub BuildAuthHierarchyBranch {
1240     my ($tree, $authid, $cnt) = @_;
1241     $cnt |= 0;
1242     my $elementdata = GetAuthority(shift @$tree);
1243     my $branch = BuildAuthHierarchy($elementdata,"child".$cnt, $authid);
1244     if (scalar @$tree > 0) {
1245         my $nextBranch = BuildAuthHierarchyBranch($tree, $authid, ++$cnt);
1246         my $nextAuthid = $nextBranch->{authid};
1247         my $found;
1248         # If we already have the next branch listed as a child, let's
1249         # replace the old listing with the new one. If not, we will add
1250         # the branch at the end.
1251         foreach my $cell (@{$branch->{children}}) {
1252             if ($cell->{authid} eq $nextAuthid) {
1253                 $cell = $nextBranch;
1254                 $found = 1;
1255                 last;
1256             }
1257         }
1258         push @{$branch->{children}}, $nextBranch unless $found;
1259     }
1260     return $branch;
1261 }
1262
1263 =head2 GenerateHierarchy
1264
1265   $hierarchy = &GenerateHierarchy($authid);
1266
1267 Return an arrayref holding one or more "trees" representing
1268 authority hierarchies.
1269
1270 =cut
1271
1272 sub GenerateHierarchy {
1273     my ($authid) = @_;
1274     my $trees    = BuildAuthHierarchies($authid);
1275     my @trees    = split /;/,$trees ;
1276     push @trees,$trees unless (@trees);
1277     my @loophierarchies;
1278     foreach my $tree (@trees){
1279         my @tree=split /,/,$tree;
1280         push @tree, $tree unless (@tree);
1281         my $branch = BuildAuthHierarchyBranch(\@tree, $authid);
1282         push @loophierarchies, [ $branch ];
1283     }
1284     return \@loophierarchies;
1285 }
1286
1287 sub _get_authid_subfield{
1288     my ($field)=@_;
1289     return $field->subfield('9')||$field->subfield('3');
1290 }
1291
1292 =head2 GetHeaderAuthority
1293
1294   $ref= &GetHeaderAuthority( $authid)
1295
1296 return a hashref in order auth_header table data
1297
1298 =cut
1299
1300 sub GetHeaderAuthority{
1301   my $authid = shift @_;
1302   my $sql= "SELECT * from auth_header WHERE authid = ?";
1303   my $dbh=C4::Context->dbh;
1304   my $rq= $dbh->prepare($sql);
1305   $rq->execute($authid);
1306   my $data= $rq->fetchrow_hashref;
1307   return $data;
1308 }
1309
1310 =head2 AddAuthorityTrees
1311
1312   $ref= &AddAuthorityTrees( $authid, $trees)
1313
1314 return success or failure
1315
1316 =cut
1317
1318 sub AddAuthorityTrees{
1319   my $authid = shift @_;
1320   my $trees = shift @_;
1321   my $sql= "UPDATE IGNORE auth_header set authtrees=? WHERE authid = ?";
1322   my $dbh=C4::Context->dbh;
1323   my $rq= $dbh->prepare($sql);
1324   return $rq->execute($trees,$authid);
1325 }
1326
1327 =head2 merge
1328
1329     $count = merge({
1330         mergefrom => $mergefrom,
1331         [ MARCfrom => $MARCfrom, ]
1332         [ mergeto => $mergeto, ]
1333         [ MARCto => $MARCto, ]
1334         [ biblionumbers => [ $a, $b, $c ], ]
1335         [ override_limit => 1, ]
1336     });
1337
1338 Merge biblios linked to authority $mergefrom (mandatory parameter).
1339 If $mergeto equals mergefrom, the linked biblio field is updated.
1340 If $mergeto is different, the biblio field will be linked to $mergeto.
1341 If $mergeto is missing, the biblio field is deleted.
1342
1343 MARCfrom is used to determine if a cleared subfield in the authority record
1344 should be removed from a biblio. MARCto is used to populate the biblio
1345 record with the updated values; if you do not pass it, the biblio field
1346 will be deleted (same as missing mergeto).
1347
1348 Normally all biblio records linked to $mergefrom, will be considered. But
1349 you can pass specific numbers via the biblionumbers parameter.
1350
1351 The parameter override_limit is used by the cron job to force larger
1352 postponed merges.
1353
1354 Note: Although $mergefrom and $mergeto will normally be of the same
1355 authority type, merge also supports moving to another authority type.
1356
1357 =cut
1358
1359 sub merge {
1360     my ( $params ) = @_;
1361     my $mergefrom = $params->{mergefrom} || return;
1362     my $MARCfrom = $params->{MARCfrom};
1363     my $mergeto = $params->{mergeto};
1364     my $MARCto = $params->{MARCto};
1365     my $override_limit = $params->{override_limit};
1366
1367     # If we do not have biblionumbers, we get all linked biblios if the
1368     # number of linked records does not exceed the limit UNLESS we override.
1369     my @biblionumbers;
1370     if( $params->{biblionumbers} ) {
1371         @biblionumbers = @{ $params->{biblionumbers} };
1372     } elsif( $override_limit ) {
1373         @biblionumbers = Koha::Authorities->linked_biblionumbers({ authid => $mergefrom });
1374     } else { # now first check number of linked records
1375         my $max = C4::Context->preference('AuthorityMergeLimit') // 0;
1376         my $hits = Koha::Authorities->get_usage_count({ authid => $mergefrom });
1377         if( $hits > 0 && $hits <= $max ) {
1378             @biblionumbers = Koha::Authorities->linked_biblionumbers({ authid => $mergefrom });
1379         } elsif( $hits > $max ) { #postpone this merge to the cron job
1380             Koha::Authority::MergeRequest->new({
1381                 authid => $mergefrom,
1382                 oldrecord => $MARCfrom,
1383                 authid_new => $mergeto,
1384             })->store;
1385         }
1386     }
1387     return 0 if !@biblionumbers;
1388
1389     # Search authtypes and reporting tags
1390     my $authfrom = Koha::Authorities->find($mergefrom);
1391     my $authto = Koha::Authorities->find($mergeto);
1392     my $authtypefrom = $authfrom ? Koha::Authority::Types->find($authfrom->authtypecode) : undef;
1393     my $authtypeto   = $authto ? Koha::Authority::Types->find($authto->authtypecode) : undef;
1394     my $auth_tag_to_report_from = $authtypefrom ? $authtypefrom->auth_tag_to_report : '';
1395     my $auth_tag_to_report_to   = $authtypeto ? $authtypeto->auth_tag_to_report : '';
1396
1397     my @record_to;
1398     @record_to = $MARCto->field($auth_tag_to_report_to)->subfields() if $auth_tag_to_report_to && $MARCto && $MARCto->field($auth_tag_to_report_to);
1399     # Exceptional: If MARCto and authtypeto exist but $auth_tag_to_report_to
1400     # is empty, make sure that $9 and $a remain (instead of clearing the
1401     # reference) in order to allow for data recovery.
1402     # Note: We need $a too, since a single $9 does not pass ModBiblio.
1403     if( $MARCto && $authtypeto && !@record_to  ) {
1404         push @record_to, [ 'a', ' ' ]; # do not remove the space
1405     }
1406
1407     my @record_from;
1408     if( !$authfrom && $MARCfrom && $MARCfrom->field('1..','2..') ) {
1409     # postponed merge, authfrom was deleted and MARCfrom only contains the old reporting tag (and possibly a 100 for UNIMARC)
1410     # 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
1411         @record_from = ( $MARCfrom->field('1..','2..') )[-1]->subfields;
1412     } elsif( $auth_tag_to_report_from && $MARCfrom && $MARCfrom->field($auth_tag_to_report_from) ) {
1413         @record_from = $MARCfrom->field($auth_tag_to_report_from)->subfields;
1414     }
1415
1416     # Get all candidate tags for the change
1417     # (This will reduce the search scope in marc records).
1418     # For a deleted authority record, we scan all auth controlled fields
1419     my $dbh = C4::Context->dbh;
1420     my $sql = "SELECT DISTINCT tagfield FROM marc_subfield_structure WHERE authtypecode=?";
1421     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<>''" );
1422     my $tags_new;
1423     if( $authtypeto && ( !$authtypefrom || $authtypeto->authtypecode ne $authtypefrom->authtypecode )) {
1424         $tags_new = $dbh->selectcol_arrayref( $sql, undef, ( $authtypeto->authtypecode ));
1425     }
1426
1427     my $overwrite = C4::Context->preference( 'AuthorityMergeMode' ) eq 'strict';
1428     my $skip_subfields = $overwrite
1429         # This hash contains all subfields from the authority report fields
1430         # Including $MARCfrom as well as $MARCto
1431         # We only need it in loose merge mode; replaces the former $exclude
1432         ? {}
1433         : { map { ( $_->[0], 1 ); } ( @record_from, @record_to ) };
1434
1435     my $counteditedbiblio = 0;
1436     foreach my $biblionumber ( @biblionumbers ) {
1437         my $marcrecord = GetMarcBiblio({ biblionumber => $biblionumber });
1438         next if !$marcrecord;
1439         my $update = 0;
1440         foreach my $tagfield (@$tags_using_authtype) {
1441             my $countfrom = 0;    # used in strict mode to remove duplicates
1442             foreach my $field ( $marcrecord->field($tagfield) ) {
1443                 my $auth_number = $field->subfield("9");    # link to authority
1444                 my $tag         = $field->tag();
1445                 next if !defined($auth_number) || $auth_number ne $mergefrom;
1446                 $countfrom++;
1447                 if ( !$mergeto || !@record_to ||
1448                   ( $overwrite && $countfrom > 1 ) ) {
1449                     # !mergeto or !record_to indicates a delete
1450                     # Other condition: remove this duplicate in strict mode
1451                     $marcrecord->delete_field($field);
1452                     $update = 1;
1453                     next;
1454                 }
1455                 my $newtag = $tags_new && @$tags_new
1456                   ? _merge_newtag( $tag, $tags_new )
1457                   : $tag;
1458                 my $controlled_ind = $authto->controlled_indicators({ record => $MARCto, biblio_tag => $newtag });
1459                 my $field_to = MARC::Field->new(
1460                     $newtag,
1461                     $controlled_ind->{ind1} // $field->indicator(1),
1462                     $controlled_ind->{ind2} // $field->indicator(2),
1463                     9 => $mergeto, # Needed to create field, will be moved
1464                 );
1465                 my ( @prefix, @postfix );
1466                 if ( !$overwrite ) {
1467                     # add subfields back in loose mode, check skip_subfields
1468                     # The first extra subfields will be in front of the
1469                     # controlled block, the rest at the end.
1470                     my $prefix_flag = 1;
1471                     foreach my $subfield ( $field->subfields ) {
1472                         next if $subfield->[0] eq '9'; # skip but leave flag
1473                         if ( $skip_subfields->{ $subfield->[0] } ) {
1474                             # This marks the beginning of the controlled block
1475                             $prefix_flag = 0;
1476                             next;
1477                         }
1478                         if ($prefix_flag) {
1479                             push @prefix, [ $subfield->[0], $subfield->[1] ];
1480                         } else {
1481                             push @postfix, [ $subfield->[0], $subfield->[1] ];
1482                         }
1483                     }
1484                 }
1485                 foreach my $subfield ( @prefix, @record_to, @postfix ) {
1486                     $field_to->add_subfields($subfield->[0] => $subfield->[1]);
1487                 }
1488                 if( exists $controlled_ind->{sub2} ) { # thesaurus info
1489                     if( defined $controlled_ind->{sub2} ) {
1490                         # Add or replace
1491                         $field_to->update( 2 => $controlled_ind->{sub2} );
1492                     } else {
1493                         # Key alerts us here to remove $2
1494                         $field_to->delete_subfield( code => '2' );
1495                     }
1496                 }
1497                 # Move $9 to the end
1498                 $field_to->delete_subfield( code => '9' );
1499                 $field_to->add_subfields( 9 => $mergeto );
1500
1501                 if ($tags_new && @$tags_new) {
1502                     $marcrecord->delete_field($field);
1503                     append_fields_ordered( $marcrecord, $field_to );
1504                 } else {
1505                     $field->replace_with($field_to);
1506                 }
1507                 $update = 1;
1508             }
1509         }
1510         next if !$update;
1511         ModBiblio($marcrecord, $biblionumber, GetFrameworkCode($biblionumber));
1512         $counteditedbiblio++;
1513     }
1514     return $counteditedbiblio;
1515 }
1516
1517 sub _merge_newtag {
1518 # Routine is only called for an (exceptional) authtypecode change
1519 # Fixes old behavior of returning the first tag found
1520     my ( $oldtag, $new_tags ) = @_;
1521
1522     # If we e.g. have 650 and 151,651,751 try 651 and check presence
1523     my $prefix = substr( $oldtag, 0, 1 );
1524     my $guess = $prefix . substr( $new_tags->[0], -2 );
1525     if( grep { $_ eq $guess } @$new_tags ) {
1526         return $guess;
1527     }
1528     # Otherwise return one from the same block e.g. 6XX for 650
1529     # If not there too, fall back to first new tag (old behavior!)
1530     my @same_block = grep { /^$prefix/ } @$new_tags;
1531     return @same_block ? $same_block[0] : $new_tags->[0];
1532 }
1533
1534 sub append_fields_ordered {
1535 # while we lack this function in MARC::Record
1536 # we do not want insert_fields_ordered since it inserts before
1537     my ( $record, $field ) = @_;
1538     if( my @flds = $record->field( $field->tag ) ) {
1539         $record->insert_fields_after( pop @flds, $field );
1540     } else { # now fallback to insert_fields_ordered
1541         $record->insert_fields_ordered( $field );
1542     }
1543 }
1544
1545 =head2 get_auth_type_location
1546
1547   my ($tag, $subfield) = get_auth_type_location($auth_type_code);
1548
1549 Get the tag and subfield used to store the heading type
1550 for indexing purposes.  The C<$auth_type> parameter is
1551 optional; if it is not supplied, assume ''.
1552
1553 This routine searches the MARC authority framework
1554 for the tag and subfield whose kohafield is
1555 C<auth_header.authtypecode>; if no such field is
1556 defined in the framework, default to the hardcoded value
1557 specific to the MARC format.
1558
1559 =cut
1560
1561 sub get_auth_type_location {
1562     my $auth_type_code = @_ ? shift : '';
1563
1564     my ($tag, $subfield) = GetAuthMARCFromKohaField('auth_header.authtypecode', $auth_type_code);
1565     if (defined $tag and defined $subfield and $tag != 0 and $subfield ne '' and $subfield ne ' ') {
1566         return ($tag, $subfield);
1567     } else {
1568         if (C4::Context->preference('marcflavour') eq "MARC21")  {
1569             return C4::AuthoritiesMarc::MARC21::default_auth_type_location();
1570         } else {
1571             return C4::AuthoritiesMarc::UNIMARC::default_auth_type_location();
1572         }
1573     }
1574 }
1575
1576 END { }       # module clean-up code here (global destructor)
1577
1578 1;
1579 __END__
1580
1581 =head1 AUTHOR
1582
1583 Koha Development Team <http://koha-community.org/>
1584
1585 Paul POULAIN paul.poulain@free.fr
1586
1587 =cut
1588