1 package C4::AuthoritiesMarc;
3 # Copyright 2000-2002 Katipo Communications
4 # Copyright 2018 The National Library of Finland, University of Helsinki
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
26 use C4::Biblio qw( ModBiblio );
27 use C4::Search qw( FindDuplicate new_record_from_zebra );
28 use C4::AuthoritiesMarc::MARC21;
29 use C4::AuthoritiesMarc::UNIMARC;
30 use C4::Charset qw( SetUTF8Flag );
31 use C4::Log qw( logaction );
32 use Koha::MetadataRecord::Authority;
33 use Koha::Authorities;
34 use Koha::Authority::MergeRequests;
35 use Koha::Authority::Types;
38 use Koha::RecordProcessor;
39 use Koha::SearchEngine;
40 use Koha::SearchEngine::Indexer;
41 use Koha::SearchEngine::Search;
43 our (@ISA, @EXPORT_OK);
50 GetAuthMARCFromKohaField
67 CompareFieldWithAuthority
70 FindDuplicateAuthority
83 =head2 GetAuthMARCFromKohaField
85 ( $tag, $subfield ) = &GetAuthMARCFromKohaField ($kohafield,$authtypecode);
87 returns tag and subfield linked to kohafield
90 Suppose Kohafield is only linked to ONE subfield
94 sub GetAuthMARCFromKohaField {
95 #AUTHfind_marc_from_kohafield
96 my ( $kohafield,$authtypecode ) = @_;
97 my $dbh=C4::Context->dbh;
98 return 0, 0 unless $kohafield;
99 $authtypecode="" unless $authtypecode;
100 my $sth = $dbh->prepare("select tagfield,tagsubfield from auth_subfield_structure where kohafield= ? and authtypecode=? ");
101 $sth->execute($kohafield,$authtypecode);
102 my ($tagfield,$tagsubfield) = $sth->fetchrow;
104 return ($tagfield,$tagsubfield);
107 =head2 SearchAuthorities
109 (\@finalresult, $nbresults)= &SearchAuthorities($tags, $and_or,
110 $excluding, $operator, $value, $offset,$length,$authtypecode,
111 $sortby[, $skipmetadata])
113 returns ref to array result and count of results returned
117 sub SearchAuthorities {
118 my ($tags, $and_or, $excluding, $operator, $value, $offset,$length,$authtypecode,$sortby,$skipmetadata) = @_;
119 # warn Dumper($tags, $and_or, $excluding, $operator, $value, $offset,$length,$authtypecode,$sortby);
120 my $dbh=C4::Context->dbh;
121 $sortby="" unless $sortby;
125 # the marclist may contain "mainentry". In this case, search the tag_to_report, that depends on
126 # the authtypecode. Then, search on $a of this tag_to_report
127 # also store main entry MARC tag, to extract it at end of search
128 ##first set the authtype search and may be multiple authorities
132 my @auths=split / /,$authtypecode ;
133 foreach my $auth (@auths){
134 $query .=" \@attr 1=authtype \@attr 5=100 ".$auth; ##No truncation on authtype
135 push @authtypecode ,$auth;
139 while ($n>1){$query= "\@or ".$query;$n--;}
147 for ( my $i = 0 ; $i <= $#{$value} ; $i++ ) {
150 if ( @$tags[$i] eq "mainmainentry" ) {
151 $attr = " \@attr 1=Heading-Main ";
153 elsif ( @$tags[$i] eq "mainentry" ) {
154 $attr = " \@attr 1=Heading ";
156 elsif ( @$tags[$i] eq "match" ) {
157 $attr = " \@attr 1=Match ";
159 elsif ( @$tags[$i] eq "match-heading" ) {
160 $attr = " \@attr 1=Match-heading ";
162 elsif ( @$tags[$i] eq "see-from" ) {
163 $attr = " \@attr 1=Match-heading-see-from ";
165 elsif ( @$tags[$i] eq "thesaurus" ) {
166 $attr = " \@attr 1=Subject-heading-thesaurus ";
168 elsif ( @$tags[$i] eq "all" ) {
169 $attr = " \@attr 1=Any ";
171 else { # Use the index passed in params
172 $attr = " \@attr 1=" . @$tags[$i] . " ";
175 else { # Assume any if no index was specified
176 $attr = " \@attr 1=Any ";
179 my $operator = @$operator[$i];
180 if ( $operator and $operator eq 'is' ) {
181 $attr .= " \@attr 4=1 \@attr 5=100 "
182 ; ##Phrase, No truncation,all of subfield field must match
184 elsif ( $operator and $operator eq "=" ) {
185 $attr .= " \@attr 4=107 "; #Number Exact match
187 elsif ( $operator and $operator eq "start" ) {
188 $attr .= " \@attr 3=2 \@attr 4=1 \@attr 5=1 \@attr 6=3 "
189 ; #Firstinfield Phrase, Right truncated, Complete field
191 elsif ( $operator and $operator eq "exact" ) {
192 $attr .= " \@attr 4=1 \@attr 5=100 \@attr 6=3 "
193 ; ##Phrase, No truncation,all of subfield field must match
196 $attr .= " \@attr 5=1 \@attr 4=6 "
197 ; ## Word list, right truncated, anywhere
198 if ( $sortby eq 'Relevance' ) {
199 $attr .= "\@attr 2=102 ";
203 s/"/\\"/g; # Escape the double-quotes in the search value
204 $attr = $attr . "\"" . @$value[$i] . "\"";
210 ##Add how many queries generated
211 if ( defined $query && $query =~ /\S+/ ) {
212 #NOTE: This code path is used by authority search in cataloguing plugins...
213 #FIXME: This does not quite work the way the author probably intended.
214 #It creates a ($query prefix) AND (query 1) AND (query 2) structure instead of
215 #($query prefix) AND (query 1 AND query 2)
216 $query = $and x $attr_cnt . $query . ( defined $q2 ? $q2 : '' );
218 #NOTE: This code path is used by authority search in authority home and record matching rules...
220 #NOTE: Without the following code, multiple queries will never be joined together
221 #with a Boolean operator.
222 if ( $attr_cnt > 1 ) {
223 #NOTE: We always need 1 less operator than we have operands,
224 #so long as there is more than 1 operand
225 my $or_cnt = $attr_cnt - 1;
226 #NOTE: We hard-code OR here because that's what Elasticsearch does
227 $op_prefix = ' @or ' x $or_cnt;
228 #NOTE: This evaluates to a logical structure like (query 1) OR (query 2) OR (query 3)
230 $query = $op_prefix . $q2;
233 #$query=' @or @attr 7=2 @attr 1=Heading 0 @or @attr 7=1 @attr 1=Heading 1'.$query if ($sortby eq "HeadingDsc");
235 if ($sortby eq 'HeadingAsc') {
236 $orderstring = '@attr 7=1 @attr 1=Heading 0';
237 } elsif ($sortby eq 'HeadingDsc') {
238 $orderstring = '@attr 7=2 @attr 1=Heading 0';
239 } elsif ($sortby eq 'AuthidAsc') {
240 $orderstring = '@attr 7=1 @attr 4=109 @attr 1=Local-Number 0';
241 } elsif ($sortby eq 'AuthidDsc') {
242 $orderstring = '@attr 7=2 @attr 4=109 @attr 1=Local-Number 0';
244 $query=($query?$query:"\@attr 1=_ALLRECORDS \@attr 2=103 ''");
245 $query="\@or $orderstring $query" if $orderstring;
247 $offset = 0 if not defined $offset or $offset < 0;
248 my $counter = $offset;
249 $length=10 unless $length;
252 $oAuth[0]=C4::Context->Zconn("authorityserver" , 1);
253 my $Anewq= ZOOM::Query::PQF->new($query,$oAuth[0]);
255 $oAResult= $oAuth[0]->search($Anewq) ;
256 while (($i = ZOOM::event(\@oAuth)) != 0) {
257 my $ev = $oAuth[$i-1]->last_event();
258 last if $ev == ZOOM::Event::ZEND;
260 my($error, $errmsg, $addinfo, $diagset) = $oAuth[0]->error_x();
262 warn "oAuth error: $errmsg ($error) $addinfo $diagset\n";
267 $nbresults=$oAResult->size();
268 my $nremains=$nbresults;
270 my @finalresult = ();
274 ##Find authid and linkid fields
275 ##we may be searching multiple authoritytypes.
276 ## FIXME this assumes that all authid and linkid fields are the same for all authority types
277 # my ($authidfield,$authidsubfield)=GetAuthMARCFromKohaField($dbh,"auth_header.authid",$authtypecode[0]);
278 # my ($linkidfield,$linkidsubfield)=GetAuthMARCFromKohaField($dbh,"auth_header.linkid",$authtypecode[0]);
279 while (($counter < $nbresults) && ($counter < ($offset + $length))) {
281 ##Here we have to extract MARC record and $authid from ZEBRA AUTHORITIES
282 my $rec=$oAResult->record($counter);
283 my $separator=C4::Context->preference('AuthoritySeparator');
284 my $authrecord = C4::Search::new_record_from_zebra(
289 if ( !defined $authrecord or !defined $authrecord->field('001') ) {
294 SetUTF8Flag( $authrecord );
296 my $authid=$authrecord->field('001')->data();
298 $newline{authid} = $authid;
299 if ( !$skipmetadata ) {
300 my ( $auth_tag_to_report, $reported_tag, $mainentry );
301 if ( $authtypecode ) {
302 $auth_tag_to_report = Koha::Authority::Types->find($authtypecode)->auth_tag_to_report;
303 $mainentry = $authrecord->field($auth_tag_to_report) if $auth_tag_to_report;
307 foreach ( $mainentry->subfields() ) {
308 $reported_tag .= '$' . $_->[0] . $_->[1];
312 my ( $thisauthtype, $thisauthtypecode );
313 if ( my $authority = Koha::Authorities->find($authid) ) {
314 $thisauthtypecode = $authority->authtypecode;
315 $thisauthtype = Koha::Authority::Types->find($thisauthtypecode);
317 unless (defined $thisauthtype) {
318 $thisauthtypecode = $authtypecode;
319 $thisauthtype = Koha::Authority::Types->find($thisauthtypecode);
321 my $summary = BuildSummary( $authrecord, $authid, $thisauthtypecode );
323 if ( C4::Context->preference('ShowHeadingUse') ) {
324 # checking valid heading use
325 my $f008 = $authrecord->field('008');
326 my $pos14to16 = substr( $f008->data, 14, 3 );
327 my $main = substr( $pos14to16, 0, 1 );
328 $newline{main} = 1 if $main eq 'a';
329 my $subject = substr( $pos14to16, 1, 1);
330 $newline{subject} = 1 if $subject eq 'a';
331 my $series = substr( $pos14to16, 2, 1 );
332 $newline{series} = 1 if $series eq 'a';
335 $newline{authtype} = defined($thisauthtype) ?
336 $thisauthtype->authtypetext : '';
337 $newline{summary} = $summary;
338 $newline{even} = $counter % 2;
339 $newline{reported_tag} = $reported_tag;
342 push @finalresult, \%newline;
345 if (! $skipmetadata) {
346 for (my $z=0; $z<@finalresult; $z++){
347 my $count = Koha::Authorities->get_usage_count({ authid => $finalresult[$z]{authid} });
348 $finalresult[$z]{used}=$count;
354 $oAResult->destroy();
355 # $oAuth[0]->destroy();
357 return (\@finalresult, $nbresults);
360 =head2 GuessAuthTypeCode
362 my $authtypecode = GuessAuthTypeCode($record);
364 Get the record and tries to guess the adequate authtypecode from its content.
368 sub GuessAuthTypeCode {
369 my ($record, $heading_fields) = @_;
370 return unless defined $record;
371 $heading_fields //= {
373 '100'=>{authtypecode=>'PERSO_NAME'},
374 '110'=>{authtypecode=>'CORPO_NAME'},
375 '111'=>{authtypecode=>'MEETI_NAME'},
376 '130'=>{authtypecode=>'UNIF_TITLE'},
377 '147'=>{authtypecode=>'NAME_EVENT'},
378 '148'=>{authtypecode=>'CHRON_TERM'},
379 '150'=>{authtypecode=>'TOPIC_TERM'},
380 '151'=>{authtypecode=>'GEOGR_NAME'},
381 '155'=>{authtypecode=>'GENRE/FORM'},
382 '162'=>{authtypecode=>'MED_PERFRM'},
383 '180'=>{authtypecode=>'GEN_SUBDIV'},
384 '181'=>{authtypecode=>'GEO_SUBDIV'},
385 '182'=>{authtypecode=>'CHRON_SUBD'},
386 '185'=>{authtypecode=>'FORM_SUBD'},
388 #200 Personal name 700, 701, 702 4-- with embedded 700, 701, 702 600
389 # 604 with embedded 700, 701, 702
390 #210 Corporate or meeting name 710, 711, 712 4-- with embedded 710, 711, 712 601 604 with embedded 710, 711, 712
391 #215 Territorial or geographic name 710, 711, 712 4-- with embedded 710, 711, 712 601, 607 604 with embedded 710, 711, 712
392 #216 Trademark 716 [Reserved for future use]
393 #220 Family name 720, 721, 722 4-- with embedded 720, 721, 722 602 604 with embedded 720, 721, 722
394 #230 Title 500 4-- with embedded 500 605
395 #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
396 #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
397 #250 Topical subject 606
398 #260 Place access 620
399 #280 Form, genre or physical characteristics 608
402 # Could also be represented with :
404 #a = personal name entry
405 #b = corporate name entry
406 #c = territorial or geographical name
410 #g = collective uniform title
412 #i = name/collective uniform title
415 #l = form, genre or physical characteristics
417 '200'=>{authtypecode=>'NP'},
418 '210'=>{authtypecode=>'CO'},
419 '215'=>{authtypecode=>'SNG'},
420 '216'=>{authtypecode=>'TM'},
421 '220'=>{authtypecode=>'FAM'},
422 '230'=>{authtypecode=>'TU'},
423 '235'=>{authtypecode=>'CO_UNI_TI'},
424 '240'=>{authtypecode=>'SAUTTIT'},
425 '245'=>{authtypecode=>'NAME_COL'},
426 '250'=>{authtypecode=>'SNC'},
427 '260'=>{authtypecode=>'PA'},
428 '280'=>{authtypecode=>'GENRE/FORM'},
431 foreach my $field (keys %{$heading_fields->{uc(C4::Context->preference('marcflavour'))} }) {
432 return $heading_fields->{uc(C4::Context->preference('marcflavour'))}->{$field}->{'authtypecode'} if (defined $record->field($field));
439 my $authtid = GuessAuthId($record);
441 Get the record and tries to guess the adequate authtypecode from its content.
447 return unless ($record && $record->field('001'));
448 # my $authtypecode=GuessAuthTypeCode($record);
449 # my ($tag,$subfield)=GetAuthMARCFromKohaField("auth_header.authid",$authtypecode);
450 # if ($tag > 010) {return $record->subfield($tag,$subfield)}
451 # else {return $record->field($tag)->data}
452 return $record->field('001')->data;
457 $tagslabel= &GetTagsLabels($forlibrarian,$authtypecode)
459 returns a ref to hashref of authorities tag and subfield structure.
463 $tagslabel->{$tag}->{$subfield}->{'attribute'}
465 where attribute takes values in :
483 my ($forlibrarian,$authtypecode)= @_;
484 my $dbh=C4::Context->dbh;
485 $authtypecode="" unless $authtypecode;
487 my $libfield = ($forlibrarian) ? 'liblibrarian' : 'libopac';
490 # check that authority exists
491 $sth=$dbh->prepare("SELECT count(*) FROM auth_tag_structure WHERE authtypecode=?");
492 $sth->execute($authtypecode);
493 my ($total) = $sth->fetchrow;
494 $authtypecode="" unless ($total >0);
496 "SELECT auth_tag_structure.tagfield,auth_tag_structure.liblibrarian,auth_tag_structure.libopac,auth_tag_structure.mandatory,auth_tag_structure.repeatable
497 FROM auth_tag_structure
502 $sth->execute($authtypecode);
503 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
505 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) = $sth->fetchrow ) {
506 $res->{$tag}->{lib} = ($forlibrarian or !$libopac)?$liblibrarian:$libopac;
507 $res->{$tag}->{tab} = " "; # XXX
508 $res->{$tag}->{mandatory} = $mandatory;
509 $res->{$tag}->{repeatable} = $repeatable;
512 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab, mandatory, repeatable,authorised_value,frameworkcode as authtypecode,value_builder,kohafield,seealso,hidden,isurl,defaultvalue, display_order
513 FROM auth_subfield_structure
515 ORDER BY tagfield, display_order, tagsubfield"
517 $sth->execute($authtypecode);
520 my $authorised_value;
530 ( $tag, $subfield, $liblibrarian, , $libopac, $tab,
531 $mandatory, $repeatable, $authorised_value, $authtypecode,
532 $value_builder, $kohafield, $seealso, $hidden,
533 $isurl, $defaultvalue, $display_order )
537 $res->{$tag}->{$subfield}->{subfield} = $subfield;
538 $res->{$tag}->{$subfield}->{lib} = ($forlibrarian or !$libopac)?$liblibrarian:$libopac;
539 $res->{$tag}->{$subfield}->{tab} = $tab;
540 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
541 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
542 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
543 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
544 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
545 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
546 $res->{$tag}->{$subfield}->{seealso} = $seealso;
547 $res->{$tag}->{$subfield}->{hidden} = $hidden;
548 $res->{$tag}->{$subfield}->{isurl} = $isurl;
549 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
550 $res->{$tag}->{$subfield}->{display_order} = $display_order;
558 $authid= &AddAuthority($record, $authid,$authtypecode)
560 Either Create Or Modify existing authority.
561 returns authid of the newly created authority
567 # pass the MARC::Record to this function, and it will create the records in the authority table
568 my ( $record, $authid, $authtypecode, $params ) = @_;
570 my $skip_record_index = $params->{skip_record_index} || 0;
572 my $dbh = C4::Context->dbh;
573 my $leader = ' nz a22 o 4500'; #Leader for incomplete MARC21 record
575 # if authid empty => true add, find a new authid number
577 if ( uc( C4::Context->preference('marcflavour') ) eq 'UNIMARC' ) {
578 $format = 'UNIMARCAUTH';
583 #update date/time to 005 for marc and unimarc
584 my $time = POSIX::strftime( "%Y%m%d%H%M%S", localtime );
585 my $f5 = $record->field('005');
587 $record->insert_fields_ordered( MARC::Field->new( '005', $time . ".0" ) );
589 $f5->update( $time . ".0" );
592 SetUTF8Flag($record);
593 if ( $format eq "MARC21" ) {
594 my $userenv = C4::Context->userenv;
596 my $marcorgcode = C4::Context->preference('MARCOrgCode');
597 if ( $userenv && $userenv->{'branch'} ) {
598 $library = Koha::Libraries->find( $userenv->{'branch'} );
600 # userenv's library could not exist because of a trick in misc/commit_file.pl (see FIXME and set_userenv statement)
601 $marcorgcode = $library ? $library->get_effective_marcorgcode : $marcorgcode;
603 if ( !$record->leader ) {
604 $record->leader($leader);
606 if ( !$record->field('003') ) {
607 $record->insert_fields_ordered(
608 MARC::Field->new( '003', $marcorgcode ),
611 my $date = POSIX::strftime( "%y%m%d", localtime );
612 if ( !$record->field('008') ) {
614 # Get a valid default value for field 008
615 my $default_008 = C4::Context->preference('MARCAuthorityControlField008');
616 if ( !$default_008 or length($default_008) < 34 ) {
617 $default_008 = '|| aca||aabn | a|a d';
619 $default_008 = substr( $default_008, 0, 34 );
622 $record->insert_fields_ordered( MARC::Field->new( '008', $date . $default_008 ) );
624 if ( !$record->field('040') ) {
625 $record->insert_fields_ordered(
635 if ( $format eq "UNIMARCAUTH" ) {
636 $record->leader(" nx j22 ") unless ( $record->leader() );
637 my $date = POSIX::strftime( "%Y%m%d", localtime );
638 my $defaultfield100 = C4::Context->preference('UNIMARCAuthorityField100');
639 if ( my $string = $record->subfield( '100', "a" ) ) {
640 $string =~ s/fre50/frey50/;
641 $record->field('100')->update( 'a' => $string );
642 } elsif ( $record->field('100') ) {
643 $record->field('100')->update( 'a' => $date . $defaultfield100 );
645 $record->append_fields(
648 , 'a' => $date . $defaultfield100
653 my ( $auth_type_tag, $auth_type_subfield ) = get_auth_type_location($authtypecode);
654 if ( !$authid and $format eq "MARC21" ) {
656 # only need to do this fix when modifying an existing authority
657 C4::AuthoritiesMarc::MARC21::fix_marc21_auth_type_location( $record, $auth_type_tag, $auth_type_subfield );
659 if ( my $field = $record->field($auth_type_tag) ) {
660 $field->update( $auth_type_subfield => $authtypecode );
662 $record->add_fields( $auth_type_tag, '', '', $auth_type_subfield => $authtypecode );
665 if ( C4::Context->preference('StripWhitespaceChars') ) {
666 my $p = Koha::RecordProcessor->new( { filters => qw(TrimFields) } );
667 $p->process($record);
670 # Save record into auth_header, update 001
676 # Save a blank record, get authid
677 $authority = Koha::Authority->new(
679 datecreated => \'NOW()',
681 authtypecode => $authtypecode
684 $authority->discard_changes();
685 $authid = $authority->authid;
686 logaction( "AUTHORITIES", "ADD", $authid, "authority" ) if C4::Context->preference("AuthoritiesLog");
689 $authority = Koha::Authorities->find($authid);
690 $authority->authtypecode($authtypecode);
691 # In the case we are changing type we need to set this to ensure heading field is correctly chosen
694 # Insert/update the recordID in MARC record
695 $record->delete_field( $record->field('001') );
696 $record->insert_fields_ordered( MARC::Field->new( '001', $authid ) );
698 my $heading = $authority->heading_object( { record => $record } );
703 authtypecode => $authtypecode,
704 marc => $record->as_usmarc,
705 marcxml => $record->as_xml_record($format),
706 heading => $heading ? $heading->display_form : '',
710 unless ($skip_record_index) {
711 my $indexer = Koha::SearchEngine::Indexer->new( { index => $Koha::SearchEngine::AUTHORITIES_INDEX } );
712 $indexer->index_records( $authid, "specialUpdate", "authorityserver", $record );
715 _after_authority_action_hooks( { action => $action, authority_id => $authid } );
721 DelAuthority({ authid => $authid, [ skip_merge => 1 ] });
723 Deletes $authid and calls merge to cleanup linked biblio records.
724 Parameter skip_merge is used in authorities/merge.pl. You should normally not
727 skip_record_index will skip the indexation step.
733 my $authid = $params->{authid} || return;
734 my $skip_merge = $params->{skip_merge};
735 my $skip_record_index = $params->{skip_record_index} || 0;
737 my $dbh = C4::Context->dbh;
739 # Remove older pending merge requests for $authid to itself. (See bug 22437)
740 my $condition = { authid => $authid, authid_new => [undef, 0, $authid], done => 0 };
741 Koha::Authority::MergeRequests->search($condition)->delete;
743 merge({ mergefrom => $authid }) if !$skip_merge;
744 $dbh->do( "DELETE FROM auth_header WHERE authid=?", undef, $authid );
745 logaction( "AUTHORITIES", "DELETE", $authid, "authority" ) if C4::Context->preference("AuthoritiesLog");
746 unless ( $skip_record_index ) {
747 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::AUTHORITIES_INDEX });
748 $indexer->index_records( $authid, "recordDelete", "authorityserver", undef );
751 _after_authority_action_hooks({ action => 'delete', authority_id => $authid });
756 $authid= &ModAuthority($authid,$record,$authtypecode, [ { skip_merge => 1 ] )
758 Modifies authority record, optionally updates attached biblios.
759 The parameter skip_merge is optional and should be used with care.
761 skip_record_index will skip the indexation step.
766 my ( $authid, $record, $authtypecode, $params ) = @_;
768 my $skip_record_index = $params->{skip_record_index} || 0;
770 my $oldrecord = GetAuthority($authid);
771 #Now rewrite the $record to table with an add
772 $authid = AddAuthority($record, $authid, $authtypecode, { skip_record_index => $skip_record_index });
773 merge({ mergefrom => $authid, MARCfrom => $oldrecord, mergeto => $authid, MARCto => $record }) if !$params->{skip_merge};
774 logaction( "AUTHORITIES", "MODIFY", $authid, "authority BEFORE=>" . $oldrecord->as_formatted ) if C4::Context->preference("AuthoritiesLog");
778 =head2 GetAuthorityXML
780 $marcxml= &GetAuthorityXML( $authid)
782 returns xml form of record $authid
786 sub GetAuthorityXML {
787 # Returns MARC::XML of the authority passed in parameter.
789 if (uc(C4::Context->preference('marcflavour')) eq 'UNIMARC') {
790 my $dbh=C4::Context->dbh;
791 my $sth = $dbh->prepare("select marcxml from auth_header where authid=? " );
792 $sth->execute($authid);
793 my ($marcxml)=$sth->fetchrow;
797 # for MARC21, call GetAuthority instead of
798 # getting the XML directly since we may
799 # need to fix up the location of the authority
800 # code -- note that this is reasonably safe
801 # because GetAuthorityXML is used only by the
802 # indexing processes like zebraqueue_start.pl
803 my $record = GetAuthority($authid);
804 return $record->as_xml_record('MARC21');
810 $record= &GetAuthority( $authid)
812 Returns MARC::Record of the authority passed in parameter.
818 my $authority = Koha::MetadataRecord::Authority->get_from_authid($authid);
819 return unless $authority;
820 return ($authority->record);
823 =head2 FindDuplicateAuthority
825 $record= &FindDuplicateAuthority( $record, $authtypecode)
827 return $authid,Summary if duplicate is found.
829 Comments : an improvement would be to return All the records that match.
833 sub FindDuplicateAuthority {
835 my ($record,$authtypecode)=@_;
836 my $dbh = C4::Context->dbh;
837 my $auth_tag_to_report = Koha::Authority::Types->find($authtypecode)->auth_tag_to_report;
838 # build a request for SearchAuthorities
840 my $query='at:"'.$authtypecode.'" '; # Quote authtype code to avoid unescaping slash in GENRE/FORM later
841 my $filtervalues=qr([\001-\040\Q!'"`#$%&*+,-./:;<=>?@(){[}_|~\E\]]);
842 if ($record->field($auth_tag_to_report)) {
843 foreach ($record->field($auth_tag_to_report)->subfields()) {
844 $_->[1]=~s/$filtervalues/ /g; $query.= " $op he:\"".$_->[1]."\"" if ($_->[0]=~/[A-z]/);
847 my $searcher = Koha::SearchEngine::Search->new({index => $Koha::SearchEngine::AUTHORITIES_INDEX});
848 my ($error, $results, $total_hits) = $searcher->simple_search_compat( $query, 0, 1, [ 'authorityserver' ] );
849 # there is at least 1 result => return the 1st one
850 if (!defined $error && @{$results} ) {
851 my $marcrecord = C4::Search::new_record_from_zebra(
855 return $marcrecord->field('001')->data,BuildSummary($marcrecord,$marcrecord->field('001')->data,$authtypecode);
857 # no result, returns nothing
863 $summary= &BuildSummary( $record, $authid, $authtypecode)
865 Returns a hashref with a summary of the specified record.
867 Comment : authtypecode can be inferred from both record and authid.
868 Moreover, authid can also be inferred from $record.
869 Would it be interesting to delete those things.
874 ## give this a Marc record to return summary
875 my ($record,$authid,$authtypecode)=@_;
876 my $dbh=C4::Context->dbh;
878 my $summary_template;
879 # handle $authtypecode is NULL or eq ""
881 my $authref = Koha::Authority::Types->find($authtypecode);
883 $summary{authtypecode} = $authref->authtypecode;
884 $summary{type} = $authref->authtypetext;
885 $summary_template = $authref->summary;
886 # for MARC21, the authority type summary displays a label meant for
888 if (C4::Context->preference('marcflavour') ne 'UNIMARC') {
889 $summary{label} = $authref->summary;
891 $summary{summary} = $authref->summary;
895 my $marc21subfields = 'abcdfghjklmnopqrstuvxyz68';
896 my %marc21controlrefs = ( 'a' => 'earlier',
902 'n' => 'notapplicable',
906 my %unimarc_relation_from_code = (
912 $thesaurus{'1'}="Peuples";
913 $thesaurus{'2'}="Anthroponymes";
914 $thesaurus{'3'}="Oeuvres";
915 $thesaurus{'4'}="Chronologie";
916 $thesaurus{'5'}="Lieux";
917 $thesaurus{'6'}="Sujets";
920 # if the library has a summary defined, use it. Otherwise, build a standard one
921 # FIXME - it appears that the summary field in the authority frameworks
922 # can work as a display template. However, this doesn't
923 # suit the MARC21 version, so for now the "templating"
924 # feature will be enabled only for UNIMARC for backwards
926 if ($summary{summary} and C4::Context->preference('marcflavour') eq 'UNIMARC') {
927 my @matches = ($summary{summary} =~ m/\[(.*?)(\d{3})([\*a-z0-9])(.*?)\]/g);
928 my (@textbefore, @tag, @subtag, @textafter);
929 for(my $i = 0; $i < scalar @matches; $i++){
930 push @textbefore, $matches[$i] if($i%4 == 0);
931 push @tag, $matches[$i] if($i%4 == 1);
932 push @subtag, $matches[$i] if($i%4 == 2);
933 push @textafter, $matches[$i] if($i%4 == 3);
935 for(my $i = scalar @tag; $i >= 0; $i--){
936 my $textbefore = $textbefore[$i] || '';
937 my $tag = $tag[$i] || '';
938 my $subtag = $subtag[$i] || '';
939 my $textafter = $textafter[$i] || '';
941 my $field = $record->field($tag);
945 $value = $textbefore . $field->data() . $textafter;
948 my @subfields = $field->subfield($subtag);
950 $value = $textbefore . join (" - ", @subfields) . $textafter;
954 $summary{summary} =~ s/\[\Q$textbefore$tag$subtag$textafter\E\]/$value/;
956 $summary{summary} =~ s/\\n/<br \/>/g;
965 if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
966 # construct UNIMARC summary, that is quite different from MARC21 one
968 foreach my $field ($record->field('2..')) {
970 heading => $field->as_string('abcdefghijlmnopqrstuvwxyz'),
971 hemain => ( $field->subfield('a') // undef ),
972 field => $field->tag(),
976 foreach my $field ($record->field('3..')) {
977 push @notes, { note => $field->subfield('a'), field => $field->tag() };
979 foreach my $field ($record->field('4..')) {
980 my $thesaurus = $field->subfield('2') ? "thes. : ".$thesaurus{"$field->subfield('2')"}." : " : '';
982 heading => $thesaurus . $field->as_string('abcdefghijlmnopqrstuvwxyz'),
983 hemain => ( $field->subfield('a') // undef ),
985 field => $field->tag(),
991 my $type = $unimarc_relation_from_code{$_->subfield('5') || 'a'};
992 my $heading = $_->as_string('abcdefgjxyz');
997 hemain => ( $_->subfield('a') // undef ),
999 authid => ( $_->subfield('9') // undef ),
1001 } $record->field('5..');
1004 @otherscript = map { {
1005 lang => length ($_->subfield('8')) == 6 ? substr ($_->subfield('8'), 3, 3) : $_->subfield('8') || '',
1006 term => $_->subfield('a') . ($_->subfield('b') ? ', ' . $_->subfield('b') : ''),
1009 } } $record->field('7..');
1012 # construct MARC21 summary
1013 # FIXME - looping over 1XX is questionable
1014 # since MARC21 authority should have only one 1XX
1015 use C4::Heading::MARC21;
1016 my $handler = C4::Heading::MARC21->new();
1017 my $subfields_to_report;
1018 my $subfields_to_subdivision = "";
1019 my $delimiter = C4::Context->preference('AuthoritySeparator');
1021 foreach my $field ($record->field('1..')) {
1022 my $tag = $field->tag();
1023 next if "152" eq $tag;
1024 # FIXME - 152 is not a good tag to use
1025 # in MARC21 -- purely local tags really ought to be
1028 $subfields_to_report = $handler->get_auth_heading_subfields_to_report($tag);
1030 if ($subfields_to_report) {
1032 heading => $field->as_string($subfields_to_report),
1033 hemain => ( $field->subfield( substr($subfields_to_report, 0, 1) ) // undef ),
1038 heading => $field->as_string(),
1039 hemain => ( $field->subfield( 'a' ) // undef ),
1044 foreach my $field ($record->field('4..')) { #See From
1045 my $type = 'seefrom';
1046 $type = ($marc21controlrefs{substr $field->subfield('w'), 0, 1} || '') if ($field->subfield('w'));
1047 if ($type eq 'notapplicable') {
1048 $type = substr $field->subfield('w'), 2, 1;
1049 $type = 'earlier' if $type && $type ne 'n';
1051 if ($type eq 'subfi') {
1053 heading => $field->as_string($marc21subfields),
1054 hemain => scalar $field->subfield( substr($marc21subfields, 0, 1) ),
1055 type => ($field->subfield('i') || ''),
1056 field => $field->tag(),
1060 heading => $field->as_string($marc21subfields),
1061 hemain => scalar $field->subfield( substr($marc21subfields, 0, 1) ),
1063 field => $field->tag(),
1067 foreach my $field ($record->field('5..')) { #See Also
1068 my $type = 'seealso';
1069 $type = ($marc21controlrefs{substr $field->subfield('w'), 0, 1} || '') if ($field->subfield('w'));
1070 if ($type eq 'notapplicable') {
1071 $type = substr $field->subfield('w'), 2, 1;
1072 $type = 'earlier' if $type && $type ne 'n';
1074 if ($type eq 'subfi') {
1076 heading => $field->as_string($marc21subfields),
1077 hemain => scalar $field->subfield( substr($marc21subfields, 0, 1) ),
1078 type => scalar $field->subfield('i'),
1079 field => $field->tag(),
1080 search => $field->as_string($marc21subfields) || '',
1081 authid => $field->subfield('9') || ''
1085 heading => $field->as_string($marc21subfields),
1086 hemain => scalar $field->subfield( substr($marc21subfields, 0, 1) ),
1088 field => $field->tag(),
1089 search => $field->as_string($marc21subfields) || '',
1090 authid => $field->subfield('9') || ''
1094 foreach my $field ($record->field('6..')) {
1095 push @notes, { note => $field->as_string(), field => $field->tag() };
1098 foreach my $field ( $record->field('7..') ) {
1099 my $tag = $field->tag();
1101 if ( $tag eq '700' ) {
1102 $subfields_to_report = 'abcdefghjklmnopqrst';
1103 $subfields_to_subdivision = 'vxyz';
1104 } elsif ( $tag eq '710' ) {
1105 $subfields_to_report = 'abcdefghklmnoprst';
1106 $subfields_to_subdivision = 'vxyz';
1107 } elsif ( $tag eq '711' ) {
1108 $subfields_to_report = 'acdefghklnpqst';
1109 $subfields_to_subdivision = 'vxyz';
1110 } elsif ( $tag eq '730' ) {
1111 $subfields_to_report = 'adfghklmnoprst';
1112 $subfields_to_subdivision = 'vxyz';
1113 } elsif ( $tag eq '748' ) {
1114 $subfields_to_report = 'ab';
1115 $subfields_to_subdivision = 'vxyz';
1116 } elsif ( $tag eq '750' ) {
1117 $subfields_to_report = 'ab';
1118 $subfields_to_subdivision = 'vxyz';
1119 } elsif ( $tag eq '751' ) {
1120 $subfields_to_report = 'a';
1121 $subfields_to_subdivision = 'vxyz';
1122 } elsif ( $tag eq '755' ) {
1123 $subfields_to_report = 'abvxyz';
1124 $subfields_to_subdivision = 'vxyz';
1125 } elsif ( $tag eq '780' ) {
1126 $subfields_to_report = 'vxyz';
1128 } elsif ( $tag eq '781' ) {
1129 $subfields_to_report = 'vxyz';
1131 } elsif ( $tag eq '782' ) {
1132 $subfields_to_report = 'vxyz';
1134 } elsif ( $tag eq '785' ) {
1135 $subfields_to_report = 'vxyz';
1139 my $heading = $field->as_string($subfields_to_report);
1141 if ($subfields_to_subdivision) {
1142 my $subheading = $field->as_string( $subfields_to_subdivision, $delimiter );
1143 if ( length $subheading > 0 ) {
1144 $heading .= $delimiter . $subheading;
1148 if ($subfields_to_report) {
1150 heading => $heading,
1151 hemain => ( $field->subfield( substr( $subfields_to_report, 0, 1 ) ) // undef ),
1156 heading => $field->as_string(),
1157 hemain => ( $field->subfield('a') // undef ),
1163 foreach my $field ($record->field('880')) {
1164 my $linkage = $field->subfield('6');
1165 my $category = substr $linkage, 0, 1;
1166 if ($category eq '1') {
1167 $category = 'preferred';
1168 } elsif ($category eq '4') {
1169 $category = 'seefrom';
1170 } elsif ($category eq '5') {
1171 $category = 'seealso';
1174 if ($field->subfield('w')) {
1175 $type = $marc21controlrefs{substr $field->subfield('w'), '0'};
1179 my $direction = $linkage =~ m#/r$# ? 'rtl' : 'ltr';
1180 push @otherscript, { term => $field->as_string($subfields_to_report), category => $category, type => $type, direction => $direction, linkage => $linkage };
1183 $summary{mainentry} = $authorized[0]->{heading};
1184 $summary{mainmainentry} = $authorized[0]->{hemain};
1185 $summary{authorized} = \@authorized;
1186 $summary{notes} = \@notes;
1187 $summary{seefrom} = \@seefrom;
1188 $summary{seealso} = \@seealso;
1189 $summary{otherscript} = \@otherscript;
1190 $summary{equalterm} = \@equalterm;
1194 =head2 GetAuthorizedHeading
1196 $heading = &GetAuthorizedHeading({ record => $record, authid => $authid })
1198 Takes a MARC::Record object describing an authority record or an authid, and
1199 returns a string representation of the first authorized heading. This routine
1200 should be considered a temporary shim to ease the future migration of authority
1201 data from C4::AuthoritiesMarc to the object-oriented Koha::*::Authority.
1205 sub GetAuthorizedHeading {
1208 unless ($record = $args->{record}) {
1209 return unless $args->{authid};
1210 $record = GetAuthority($args->{authid});
1212 return unless (ref $record eq 'MARC::Record');
1213 if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1214 # construct UNIMARC summary, that is quite different from MARC21 one
1216 foreach my $field ($record->field('2..')) {
1217 return $field->as_string('abcdefghijlmnopqrstuvwxyz');
1220 use C4::Heading::MARC21;
1221 my $handler = C4::Heading::MARC21->new();
1223 foreach my $field ($record->field('1..')) {
1224 my $subfields = $handler->get_valid_bib_heading_subfields($field->tag());
1225 return $field->as_string($subfields) if ($subfields);
1231 =head2 CompareFieldWithAuthority
1233 $match = &CompareFieldWithAuthority({ field => $field, authid => $authid })
1235 Takes a MARC::Field from a bibliographic record and an authid, and returns true if they match.
1239 sub CompareFieldWithAuthority {
1242 my $record = GetAuthority($args->{authid});
1243 return unless (ref $record eq 'MARC::Record');
1244 if (C4::Context->preference('marcflavour') eq 'UNIMARC') {
1245 # UNIMARC has same subfields for bibs and authorities
1246 foreach my $field ($record->field('2..')) {
1247 return compare_fields($field, $args->{field}, 'abcdefghijlmnopqrstuvwxyz');
1250 use C4::Heading::MARC21;
1251 my $handler = C4::Heading::MARC21->new();
1253 foreach my $field ($record->field('1..')) {
1254 my $subfields = $handler->get_valid_bib_heading_subfields($field->tag());
1255 return compare_fields($field, $args->{field}, $subfields) if ($subfields);
1261 =head2 BuildAuthHierarchies
1263 $text= &BuildAuthHierarchies( $authid, $force)
1265 return text containing trees for hierarchies
1266 for them to be stored in auth_header
1269 122,1314,2452;1324,2342,3,2452
1273 sub BuildAuthHierarchies{
1274 my $authid = shift @_;
1275 # warn "authid : $authid";
1276 my $force = shift @_ || (C4::Context->preference('marcflavour') eq 'UNIMARC' ? 0 : 1);
1278 my $dbh=C4::Context->dbh;
1280 my $data = GetHeaderAuthority($authid);
1281 if ($data->{'authtrees'} and not $force){
1282 return $data->{'authtrees'};
1283 # } elsif ($data->{'authtrees'}){
1284 # $hierarchies=$data->{'authtrees'};
1286 my $record = GetAuthority($authid);
1288 return unless $record;
1289 foreach my $field ($record->field('5..')){
1292 (C4::Context->preference('marcflavour') eq 'UNIMARC' && $field->subfield('5') && $field->subfield('5') eq 'g') ||
1293 (C4::Context->preference('marcflavour') ne 'UNIMARC' && $field->subfield('w') && substr($field->subfield('w'), 0, 1) eq 'g'));
1295 my $subfauthid=_get_authid_subfield($field) || '';
1296 next if ($subfauthid eq $authid);
1297 my $parentrecord = GetAuthority($subfauthid);
1298 next unless $parentrecord;
1299 my $localresult=$hierarchies;
1301 $trees = BuildAuthHierarchies($subfauthid);
1304 @trees = split(/;/,$trees);
1306 push @trees, $trees;
1311 @globalresult = (@globalresult,@trees);
1314 $hierarchies=join(";",@globalresult);
1316 #Unless there is no ancestor, I am alone.
1317 $hierarchies="$authid" unless ($hierarchies);
1319 AddAuthorityTrees($authid,$hierarchies);
1320 return $hierarchies;
1323 =head2 BuildAuthHierarchy
1325 $ref= &BuildAuthHierarchy( $record, $class,$authid)
1327 return a hashref in order to display hierarchy for record and final Authid $authid
1338 sub BuildAuthHierarchy{
1339 my $record = shift @_;
1340 my $class = shift @_;
1341 my $authid_constructed = shift @_;
1342 return unless ($record && $record->field('001'));
1343 my $authid=$record->field('001')->data();
1345 my $parents=""; my $children="";
1346 my (@loopparents,@loopchildren);
1347 my $marcflavour = C4::Context->preference('marcflavour');
1348 my $relationshipsf = $marcflavour eq 'UNIMARC' ? '5' : 'w';
1349 foreach my $field ($record->field('5..')){
1350 my $subfauthid=_get_authid_subfield($field);
1351 if ($subfauthid && $field->subfield($relationshipsf) && $field->subfield('a')){
1352 my $relationship = substr($field->subfield($relationshipsf), 0, 1);
1353 if ($relationship eq 'h'){
1354 push @loopchildren, { "authid"=>$subfauthid,"value"=>$field->subfield('a')};
1356 elsif ($relationship eq 'g'){
1357 push @loopparents, { "authid"=>$subfauthid,"value"=>$field->subfield('a')};
1359 # brothers could get in there with an else
1362 $cell{"parents"}=\@loopparents;
1363 $cell{"children"}=\@loopchildren;
1364 $cell{"class"}=$class;
1365 $cell{"authid"}=$authid;
1366 $cell{"current_value"} =1 if ($authid eq $authid_constructed);
1367 $cell{"value"}=C4::Context->preference('marcflavour') eq 'UNIMARC' ? $record->subfield('2..',"a") : $record->subfield('1..', 'a');
1371 =head2 BuildAuthHierarchyBranch
1373 $branch = &BuildAuthHierarchyBranch( $tree, $authid[, $cnt])
1375 Return a data structure representing an authority hierarchy
1376 given a list of authorities representing a single branch in
1377 an authority hierarchy tree. $authid is the current node in
1378 the tree (which may or may not be somewhere in the middle).
1379 $cnt represents the level of the upper-most item, and is only
1380 used when BuildAuthHierarchyBranch is called recursively (i.e.,
1381 don't ever pass in anything but zero to it).
1385 sub BuildAuthHierarchyBranch {
1386 my ($tree, $authid, $cnt) = @_;
1388 my $elementdata = GetAuthority(shift @$tree);
1389 my $branch = BuildAuthHierarchy($elementdata,"child".$cnt, $authid);
1390 if (scalar @$tree > 0) {
1391 my $nextBranch = BuildAuthHierarchyBranch($tree, $authid, ++$cnt);
1392 my $nextAuthid = $nextBranch->{authid};
1394 # If we already have the next branch listed as a child, let's
1395 # replace the old listing with the new one. If not, we will add
1396 # the branch at the end.
1397 foreach my $cell (@{$branch->{children}}) {
1398 if ($cell->{authid} eq $nextAuthid) {
1399 $cell = $nextBranch;
1404 push @{$branch->{children}}, $nextBranch unless $found;
1409 =head2 GenerateHierarchy
1411 $hierarchy = &GenerateHierarchy($authid);
1413 Return an arrayref holding one or more "trees" representing
1414 authority hierarchies.
1418 sub GenerateHierarchy {
1420 my $trees = BuildAuthHierarchies($authid);
1421 my @trees = split /;/,$trees ;
1422 push @trees,$trees unless (@trees);
1423 my @loophierarchies;
1424 foreach my $tree (@trees){
1425 my @tree=split /,/,$tree;
1426 push @tree, $tree unless (@tree);
1427 my $branch = BuildAuthHierarchyBranch(\@tree, $authid);
1428 push @loophierarchies, [ $branch ];
1430 return \@loophierarchies;
1433 sub _get_authid_subfield{
1435 return $field->subfield('9')||$field->subfield('3');
1438 =head2 GetHeaderAuthority
1440 $ref= &GetHeaderAuthority( $authid)
1442 return a hashref in order auth_header table data
1446 sub GetHeaderAuthority{
1447 my $authid = shift @_;
1448 my $sql= "SELECT * from auth_header WHERE authid = ?";
1449 my $dbh=C4::Context->dbh;
1450 my $rq= $dbh->prepare($sql);
1451 $rq->execute($authid);
1452 my $data= $rq->fetchrow_hashref;
1456 =head2 AddAuthorityTrees
1458 $ref= &AddAuthorityTrees( $authid, $trees)
1460 return success or failure
1464 sub AddAuthorityTrees{
1465 my $authid = shift @_;
1466 my $trees = shift @_;
1467 my $sql= "UPDATE IGNORE auth_header set authtrees=? WHERE authid = ?";
1468 my $dbh=C4::Context->dbh;
1469 my $rq= $dbh->prepare($sql);
1470 return $rq->execute($trees,$authid);
1476 mergefrom => $mergefrom,
1477 [ MARCfrom => $MARCfrom, ]
1478 [ mergeto => $mergeto, ]
1479 [ MARCto => $MARCto, ]
1480 [ biblionumbers => [ $a, $b, $c ], ]
1481 [ override_limit => 1, ]
1484 Merge biblios linked to authority $mergefrom (mandatory parameter).
1485 If $mergeto equals mergefrom, the linked biblio field is updated.
1486 If $mergeto is different, the biblio field will be linked to $mergeto.
1487 If $mergeto is missing, the biblio field is deleted.
1489 MARCfrom is used to determine if a cleared subfield in the authority record
1490 should be removed from a biblio. MARCto is used to populate the biblio
1491 record with the updated values; if you do not pass it, the biblio field
1492 will be deleted (same as missing mergeto).
1494 Normally all biblio records linked to $mergefrom, will be considered. But
1495 you can pass specific numbers via the biblionumbers parameter.
1497 The parameter override_limit is used by the cron job to force larger
1500 Note: Although $mergefrom and $mergeto will normally be of the same
1501 authority type, merge also supports moving to another authority type.
1506 my ( $params ) = @_;
1507 my $mergefrom = $params->{mergefrom} || return;
1508 my $MARCfrom = $params->{MARCfrom};
1509 my $mergeto = $params->{mergeto};
1510 my $MARCto = $params->{MARCto};
1511 my $override_limit = $params->{override_limit};
1513 # If we do not have biblionumbers, we get all linked biblios if the
1514 # number of linked records does not exceed the limit UNLESS we override.
1516 if( $params->{biblionumbers} ) {
1517 @biblionumbers = @{ $params->{biblionumbers} };
1518 } elsif( $override_limit ) {
1519 @biblionumbers = Koha::Authorities->linked_biblionumbers({ authid => $mergefrom });
1520 } else { # now first check number of linked records
1521 my $max = C4::Context->preference('AuthorityMergeLimit') // 0;
1522 my $hits = Koha::Authorities->get_usage_count({ authid => $mergefrom });
1523 if( $hits > 0 && $hits <= $max ) {
1524 @biblionumbers = Koha::Authorities->linked_biblionumbers({ authid => $mergefrom });
1525 } elsif( $hits > $max ) { #postpone this merge to the cron job
1526 Koha::Authority::MergeRequest->new({
1527 authid => $mergefrom,
1528 oldrecord => $MARCfrom,
1529 authid_new => $mergeto,
1533 return 0 if !@biblionumbers;
1535 # Search authtypes and reporting tags
1536 my $authfrom = Koha::Authorities->find($mergefrom);
1537 my $authto = Koha::Authorities->find($mergeto);
1539 my $authtypeto = $authto ? Koha::Authority::Types->find($authto->authtypecode) : undef;
1540 if( $mergeto && $mergefrom == $mergeto && $MARCfrom ) {
1541 # bulkmarcimport may have changed the authtype; see BZ 19693
1542 my $old_type = $MARCfrom->subfield( get_auth_type_location() ); # going via default
1543 if( $old_type && $authto && $old_type ne $authto->authtypecode ) {
1544 # Type change: handled by simulating a postponed merge where the auth record has been deleted already
1545 # This triggers a walk through all auth controlled tags
1549 $authtypefrom = Koha::Authority::Types->find($authfrom->authtypecode) if $authfrom;
1550 my $auth_tag_to_report_from = $authtypefrom ? $authtypefrom->auth_tag_to_report : '';
1551 my $auth_tag_to_report_to = $authtypeto ? $authtypeto->auth_tag_to_report : '';
1554 @record_to = $MARCto->field($auth_tag_to_report_to)->subfields() if $auth_tag_to_report_to && $MARCto && $MARCto->field($auth_tag_to_report_to);
1555 # Exceptional: If MARCto and authtypeto exist but $auth_tag_to_report_to
1556 # is empty, make sure that $9 and $a remain (instead of clearing the
1557 # reference) in order to allow for data recovery.
1558 # Note: We need $a too, since a single $9 does not pass ModBiblio.
1559 if( $MARCto && $authtypeto && !@record_to ) {
1560 push @record_to, [ 'a', ' ' ]; # do not remove the space
1564 if( !$authfrom && $MARCfrom && $MARCfrom->field('1..','2..') ) {
1565 # postponed merge, authfrom was deleted and MARCfrom only contains the old reporting tag (and possibly a 100 for UNIMARC)
1566 # 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
1567 @record_from = ( $MARCfrom->field('1..','2..') )[-1]->subfields;
1568 } elsif( $auth_tag_to_report_from && $MARCfrom && $MARCfrom->field($auth_tag_to_report_from) ) {
1569 @record_from = $MARCfrom->field($auth_tag_to_report_from)->subfields;
1572 # Get all candidate tags for the change
1573 # (This will reduce the search scope in marc records).
1574 # For a deleted authority record, we scan all auth controlled fields
1575 my $dbh = C4::Context->dbh;
1576 my $sql = "SELECT DISTINCT tagfield FROM marc_subfield_structure WHERE authtypecode=?";
1577 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<>''" );
1579 if( $authtypeto && ( !$authtypefrom || $authtypeto->authtypecode ne $authtypefrom->authtypecode )) {
1580 $tags_new = $dbh->selectcol_arrayref( $sql, undef, ( $authtypeto->authtypecode ));
1583 my $overwrite = C4::Context->preference( 'AuthorityMergeMode' ) eq 'strict';
1584 my $skip_subfields = $overwrite
1585 # This hash contains all subfields from the authority report fields
1586 # Including $MARCfrom as well as $MARCto
1587 # We only need it in loose merge mode; replaces the former $exclude
1589 : { map { ( $_->[0], 1 ); } ( @record_from, @record_to ) };
1591 my $counteditedbiblio = 0;
1593 my $biblios = Koha::Biblios->search({ biblionumber => { -in => \@biblionumbers } });
1595 while ( my $biblio = $biblios->next ) {
1596 my $marcrecord = $biblio->metadata->record;
1598 foreach my $tagfield (@$tags_using_authtype) {
1599 my $countfrom = 0; # used in strict mode to remove duplicates
1600 foreach my $field ( $marcrecord->field($tagfield) ) {
1601 my $auth_number = $field->subfield("9"); # link to authority
1602 my $tag = $field->tag();
1603 next if !defined($auth_number) || $auth_number ne $mergefrom;
1605 if ( !$mergeto || !@record_to ||
1606 ( $overwrite && $countfrom > 1 ) ) {
1607 # !mergeto or !record_to indicates a delete
1608 # Other condition: remove this duplicate in strict mode
1609 $marcrecord->delete_field($field);
1613 my $newtag = $tags_new && @$tags_new
1614 ? _merge_newtag( $tag, $tags_new )
1616 my $controlled_ind = $authto->controlled_indicators({ record => $MARCto, biblio_tag => $newtag });
1617 my $field_to = MARC::Field->new(
1619 $controlled_ind->{ind1} // $field->indicator(1),
1620 $controlled_ind->{ind2} // $field->indicator(2),
1621 9 => $mergeto, # Needed to create field, will be moved
1623 my ( @prefix, @postfix );
1624 if ( !$overwrite ) {
1625 # add subfields back in loose mode, check skip_subfields
1626 # The first extra subfields will be in front of the
1627 # controlled block, the rest at the end.
1628 my $prefix_flag = 1;
1629 foreach my $subfield ( $field->subfields ) {
1630 next if $subfield->[0] eq '9'; # skip but leave flag
1631 if ( $skip_subfields->{ $subfield->[0] } ) {
1632 # This marks the beginning of the controlled block
1637 push @prefix, [ $subfield->[0], $subfield->[1] ];
1639 push @postfix, [ $subfield->[0], $subfield->[1] ];
1643 foreach my $subfield ( @prefix, @record_to, @postfix ) {
1644 $field_to->add_subfields($subfield->[0] => $subfield->[1]);
1646 if( exists $controlled_ind->{sub2} ) { # thesaurus info
1647 if( defined $controlled_ind->{sub2} ) {
1649 $field_to->update( 2 => $controlled_ind->{sub2} );
1651 # Key alerts us here to remove $2
1652 $field_to->delete_subfield( code => '2' );
1655 # Move $9 to the end
1656 $field_to->delete_subfield( code => '9' );
1657 $field_to->add_subfields( 9 => $mergeto );
1659 if ($tags_new && @$tags_new) {
1660 $marcrecord->delete_field($field);
1661 append_fields_ordered( $marcrecord, $field_to );
1663 $field->replace_with($field_to);
1669 ModBiblio( $marcrecord, $biblio->biblionumber, $biblio->frameworkcode, { disable_autolink => 1 } );
1670 $counteditedbiblio++;
1672 return $counteditedbiblio;
1676 # Routine is only called for an (exceptional) authtypecode change
1677 # Fixes old behavior of returning the first tag found
1678 my ( $oldtag, $new_tags ) = @_;
1680 # If we e.g. have 650 and 151,651,751 try 651 and check presence
1681 my $prefix = substr( $oldtag, 0, 1 );
1682 my $guess = $prefix . substr( $new_tags->[0], -2 );
1683 if( grep { $_ eq $guess } @$new_tags ) {
1686 # Otherwise return one from the same block e.g. 6XX for 650
1687 # If not there too, fall back to first new tag (old behavior!)
1688 my @same_block = grep { /^$prefix/ } @$new_tags;
1689 return @same_block ? $same_block[0] : $new_tags->[0];
1692 sub append_fields_ordered {
1693 # while we lack this function in MARC::Record
1694 # we do not want insert_fields_ordered since it inserts before
1695 my ( $record, $field ) = @_;
1696 if( my @flds = $record->field( $field->tag ) ) {
1697 $record->insert_fields_after( pop @flds, $field );
1698 } else { # now fallback to insert_fields_ordered
1699 $record->insert_fields_ordered( $field );
1703 =head2 get_auth_type_location
1705 my ($tag, $subfield) = get_auth_type_location($auth_type_code);
1707 Get the tag and subfield used to store the heading type
1708 for indexing purposes. The C<$auth_type> parameter is
1709 optional; if it is not supplied, assume ''.
1711 This routine searches the MARC authority framework
1712 for the tag and subfield whose kohafield is
1713 C<auth_header.authtypecode>; if no such field is
1714 defined in the framework, default to the hardcoded value
1715 specific to the MARC format.
1719 sub get_auth_type_location {
1720 my $auth_type_code = @_ ? shift : '';
1722 my ($tag, $subfield) = GetAuthMARCFromKohaField('auth_header.authtypecode', $auth_type_code);
1723 if (defined $tag and defined $subfield and $tag != 0 and $subfield ne '' and $subfield ne ' ') {
1724 return ($tag, $subfield);
1726 if (C4::Context->preference('marcflavour') eq "MARC21") {
1727 return C4::AuthoritiesMarc::MARC21::default_auth_type_location();
1729 return C4::AuthoritiesMarc::UNIMARC::default_auth_type_location();
1734 =head2 compare_fields
1736 my match = compare_fields($field1, $field2, 'abcde');
1738 Compares the listed subfields of both fields and return true if they all match
1742 sub compare_fields {
1743 my ($field1, $field2, $subfields) = @_;
1745 foreach my $subfield (split(//, $subfields)) {
1746 my $subfield1 = $field1->subfield($subfield) // '';
1747 my $subfield2 = $field2->subfield($subfield) // '';
1748 return 0 unless $subfield1 eq $subfield2;
1754 =head2 _after_authority_action_hooks
1756 Helper method that takes care of calling all plugin hooks
1760 sub _after_authority_action_hooks {
1761 my ( $args ) = @_; # hash keys: action, authority_id
1762 return Koha::Plugins->call( 'after_authority_action', $args );
1765 END { } # module clean-up code here (global destructor)
1772 Koha Development Team <http://koha-community.org/>
1774 Paul POULAIN paul.poulain@free.fr
1775 Ere Maijala ere.maijala@helsinki.fi