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