3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
23 use MARC::File::USMARC;
30 use C4::Dates qw/format_date/;
31 use C4::Log; # logaction
35 use vars qw($VERSION @ISA @EXPORT);
41 @ISA = qw( Exporter );
55 &GetBiblioItemByBiblioNumber
56 &GetBiblioFromItemNumber
67 &GetAuthorisedValueDesc
71 &GetPublisherNameFromIsbn
86 # To link headings in a bib record
87 # to authority records.
89 &LinkBibHeadingsToAuthorities
93 # those functions are exported but should not be used
94 # they are usefull is few circumstances, so are exported.
95 # but don't use them unless you're a core developer ;-)
102 &TransformHtmlToMarc2
105 &PrepareItemrecordDisplay
110 # because of interdependencies between
111 # C4::Search, C4::Heading, and C4::Biblio,
112 # 'use C4::Heading' must occur after
113 # the exports have been defined.
118 C4::Biblio - cataloging management functions
122 Biblio.pm contains functions for managing storage and editing of bibliographic data within Koha. Most of the functions in this module are used for cataloging records: adding, editing, or removing biblios, biblioitems, or items. Koha's stores bibliographic information in three places:
126 =item 1. in the biblio,biblioitems,items, etc tables, which are limited to a one-to-one mapping to underlying MARC data
128 =item 2. as raw MARC in the Zebra index and storage engine
130 =item 3. as raw MARC the biblioitems.marc and biblioitems.marcxml
134 In the 3.0 version of Koha, the authoritative record-level information is in biblioitems.marcxml
136 Because the data isn't completely normalized there's a chance for information to get out of sync. The design choice to go with a un-normalized schema was driven by performance and stability concerns. However, if this occur, it can be considered as a bug : The API is (or should be) complete & the only entry point for all biblio/items managements.
140 =item 1. Compared with MySQL, Zebra is slow to update an index for small data changes -- especially for proc-intensive operations like circulation
142 =item 2. Zebra's index has been known to crash and a backup of the data is necessary to rebuild it in such cases
146 Because of this design choice, the process of managing storage and editing is a bit convoluted. Historically, Biblio.pm's grown to an unmanagable size and as a result we have several types of functions currently:
150 =item 1. Add*/Mod*/Del*/ - high-level external functions suitable for being called from external scripts to manage the collection
152 =item 2. _koha_* - low-level internal functions for managing the koha tables
154 =item 3. Marc management function : as the MARC record is stored in biblioitems.marc(xml), some subs dedicated to it's management are in this package. They should be used only internally by Biblio.pm, the only official entry points being AddBiblio, AddItem, ModBiblio, ModItem.
156 =item 4. Zebra functions used to update the Zebra index
158 =item 5. internal helper functions such as char_decode, checkitems, etc. Some of these probably belong in Koha.pm
162 The MARC record (in biblioitems.marcxml) contains the complete marc record, including items. It also contains the biblionumber. That is the reason why it is not stored directly by AddBiblio, with all other fields . To save a biblio, we need to :
166 =item 1. save datas in biblio and biblioitems table, that gives us a biblionumber and a biblioitemnumber
168 =item 2. add the biblionumber and biblioitemnumber into the MARC records
170 =item 3. save the marc record
174 When dealing with items, we must :
178 =item 1. save the item in items table, that gives us an itemnumber
180 =item 2. add the itemnumber to the item MARC field
182 =item 3. overwrite the MARC record (with the added item) into biblioitems.marc(xml)
184 When modifying a biblio or an item, the behaviour is quite similar.
188 =head1 EXPORTED FUNCTIONS
194 ($biblionumber,$biblioitemnumber) = AddBiblio($record,$frameworkcode);
198 Exported function (core API) for adding a new biblio to koha.
200 The first argument is a C<MARC::Record> object containing the
201 bib to add, while the second argument is the desired MARC
204 This function also accepts a third, optional argument: a hashref
205 to additional options. The only defined option is C<defer_marc_save>,
206 which if present and mapped to a true value, causes C<AddBiblio>
207 to omit the call to save the MARC in C<bibilioitems.marc>
208 and C<biblioitems.marcxml> This option is provided B<only>
209 for the use of scripts such as C<bulkmarcimport.pl> that may need
210 to do some manipulation of the MARC record for item parsing before
211 saving it and which cannot afford the performance hit of saving
212 the MARC record twice. Consequently, do not use that option
213 unless you can guarantee that C<ModBiblioMarc> will be called.
219 my $frameworkcode = shift;
220 my $options = @_ ? shift : undef;
221 my $defer_marc_save = 0;
222 if (defined $options and exists $options->{'defer_marc_save'} and $options->{'defer_marc_save'}) {
223 $defer_marc_save = 1;
226 my ($biblionumber,$biblioitemnumber,$error);
227 my $dbh = C4::Context->dbh;
228 # transform the data into koha-table style data
229 my $olddata = TransformMarcToKoha( $dbh, $record, $frameworkcode );
230 ($biblionumber,$error) = _koha_add_biblio( $dbh, $olddata, $frameworkcode );
231 $olddata->{'biblionumber'} = $biblionumber;
232 ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $olddata );
234 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
236 # update MARC subfield that stores biblioitems.cn_sort
237 _koha_marc_update_biblioitem_cn_sort($record, $olddata, $frameworkcode);
240 $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode ) unless $defer_marc_save;
242 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","ADD",$biblionumber,"biblio")
243 if C4::Context->preference("CataloguingLog");
245 return ( $biblionumber, $biblioitemnumber );
250 ModBiblio( $record,$biblionumber,$frameworkcode);
251 Exported function (core API) to modify a biblio
256 my ( $record, $biblionumber, $frameworkcode ) = @_;
257 if (C4::Context->preference("CataloguingLog")) {
258 my $newrecord = GetMarcBiblio($biblionumber);
259 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","MODIFY",$biblionumber,"BEFORE=>".$newrecord->as_formatted);
262 my $dbh = C4::Context->dbh;
264 $frameworkcode = "" unless $frameworkcode;
266 # get the items before and append them to the biblio before updating the record, atm we just have the biblio
267 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
268 my $oldRecord = GetMarcBiblio( $biblionumber );
270 # parse each item, and, for an unknown reason, re-encode each subfield
271 # if you don't do that, the record will have encoding mixed
272 # and the biblio will be re-encoded.
273 # strange, I (Paul P.) searched more than 1 day to understand what happends
274 # but could only solve the problem this way...
275 my @fields = $oldRecord->field( $itemtag );
276 foreach my $fielditem ( @fields ){
278 foreach ($fielditem->subfields()) {
280 $field->add_subfields(Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
282 $field = MARC::Field->new("$itemtag",'','',Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
285 $record->append_fields($field);
288 # update biblionumber and biblioitemnumber in MARC
289 # FIXME - this is assuming a 1 to 1 relationship between
290 # biblios and biblioitems
291 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
292 $sth->execute($biblionumber);
293 my ($biblioitemnumber) = $sth->fetchrow;
295 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
297 # load the koha-table data object
298 my $oldbiblio = TransformMarcToKoha( $dbh, $record, $frameworkcode );
300 # update MARC subfield that stores biblioitems.cn_sort
301 _koha_marc_update_biblioitem_cn_sort($record, $oldbiblio, $frameworkcode);
303 # update the MARC record (that now contains biblio and items) with the new record data
304 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
306 # modify the other koha tables
307 _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
308 _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
312 =head2 ModBiblioframework
314 ModBiblioframework($biblionumber,$frameworkcode);
315 Exported function to modify a biblio framework
319 sub ModBiblioframework {
320 my ( $biblionumber, $frameworkcode ) = @_;
321 my $dbh = C4::Context->dbh;
322 my $sth = $dbh->prepare(
323 "UPDATE biblio SET frameworkcode=? WHERE biblionumber=?"
325 $sth->execute($frameworkcode, $biblionumber);
333 my $error = &DelBiblio($dbh,$biblionumber);
334 Exported function (core API) for deleting a biblio in koha.
335 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
336 Also backs it up to deleted* tables
337 Checks to make sure there are not issues on any of the items
339 C<$error> : undef unless an error occurs
346 my ( $biblionumber ) = @_;
347 my $dbh = C4::Context->dbh;
348 my $error; # for error handling
350 # First make sure this biblio has no items attached
351 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
352 $sth->execute($biblionumber);
353 if (my $itemnumber = $sth->fetchrow){
354 # Fix this to use a status the template can understand
355 $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
358 return $error if $error;
360 # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
361 # for at least 2 reasons :
362 # - we need to read the biblio if NoZebra is set (to remove it from the indexes
363 # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
364 # and we would have no way to remove it (except manually in zebra, but I bet it would be very hard to handle the problem)
366 if (C4::Context->preference("NoZebra")) {
367 # only NoZebra indexing needs to have
368 # the previous version of the record
369 $oldRecord = GetMarcBiblio($biblionumber);
371 ModZebra($biblionumber, "recordDelete", "biblioserver", $oldRecord, undef);
373 # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
376 "SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
377 $sth->execute($biblionumber);
378 while ( my $biblioitemnumber = $sth->fetchrow ) {
380 # delete this biblioitem
381 $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
382 return $error if $error;
385 # delete biblio from Koha tables and save in deletedbiblio
386 # must do this *after* _koha_delete_biblioitems, otherwise
387 # delete cascade will prevent deletedbiblioitems rows
388 # from being generated by _koha_delete_biblioitems
389 $error = _koha_delete_biblio( $dbh, $biblionumber );
391 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","DELETE",$biblionumber,"")
392 if C4::Context->preference("CataloguingLog");
396 =head2 LinkBibHeadingsToAuthorities
400 my $headings_linked = LinkBibHeadingsToAuthorities($marc);
404 Links bib headings to authority records by checking
405 each authority-controlled field in the C<MARC::Record>
406 object C<$marc>, looking for a matching authority record,
407 and setting the linking subfield $9 to the ID of that
410 If no matching authority exists, or if multiple
411 authorities match, no $9 will be added, and any
412 existing one inthe field will be deleted.
414 Returns the number of heading links changed in the
419 sub LinkBibHeadingsToAuthorities {
422 my $num_headings_changed = 0;
423 foreach my $field ($bib->fields()) {
424 my $heading = C4::Heading->new_from_bib_field($field);
425 next unless defined $heading;
428 my $current_link = $field->subfield('9');
430 # look for matching authorities
431 my $authorities = $heading->authorities();
433 # want only one exact match
434 if ($#{ $authorities } == 0) {
435 my $authority = MARC::Record->new_from_usmarc($authorities->[0]);
436 my $authid = $authority->field('001')->data();
437 next if defined $current_link and $current_link eq $authid;
439 $field->delete_subfield(code => '9') if defined $current_link;
440 $field->add_subfields('9', $authid);
441 $num_headings_changed++;
443 if (defined $current_link) {
444 $field->delete_subfield(code => '9');
445 $num_headings_changed++;
450 return $num_headings_changed;
457 $data = &GetBiblioData($biblionumber);
458 Returns information about the book with the given biblionumber.
459 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
460 the C<biblio> and C<biblioitems> tables in the
462 In addition, C<$data-E<gt>{subject}> is the list of the book's
463 subjects, separated by C<" , "> (space, comma, space).
464 If there are multiple biblioitems with the given biblionumber, only
465 the first one is considered.
473 my $dbh = C4::Context->dbh;
475 # my $query = C4::Context->preference('item-level_itypes') ?
476 # " SELECT * , biblioitems.notes AS bnotes, biblio.notes
478 # LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
479 # WHERE biblio.biblionumber = ?
480 # AND biblioitems.biblionumber = biblio.biblionumber
483 my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
485 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
486 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
487 WHERE biblio.biblionumber = ?
488 AND biblioitems.biblionumber = biblio.biblionumber ";
490 my $sth = $dbh->prepare($query);
491 $sth->execute($bibnum);
493 $data = $sth->fetchrow_hashref;
497 } # sub GetBiblioData
499 =head2 &GetBiblioItemData
503 $itemdata = &GetBiblioItemData($biblioitemnumber);
505 Looks up the biblioitem with the given biblioitemnumber. Returns a
506 reference-to-hash. The keys are the fields from the C<biblio>,
507 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
508 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
515 sub GetBiblioItemData {
516 my ($biblioitemnumber) = @_;
517 my $dbh = C4::Context->dbh;
518 my $query = "SELECT *,biblioitems.notes AS bnotes
519 FROM biblio LEFT JOIN biblioitems on biblio.biblionumber=biblioitems.biblioitemnumber ";
520 unless(C4::Context->preference('item-level_itypes')) {
521 $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
523 $query .= " WHERE biblioitemnumber = ? ";
524 my $sth = $dbh->prepare($query);
526 $sth->execute($biblioitemnumber);
527 $data = $sth->fetchrow_hashref;
530 } # sub &GetBiblioItemData
532 =head2 GetBiblioItemByBiblioNumber
536 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
542 sub GetBiblioItemByBiblioNumber {
543 my ($biblionumber) = @_;
544 my $dbh = C4::Context->dbh;
545 my $sth = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
549 $sth->execute($biblionumber);
551 while ( my $data = $sth->fetchrow_hashref ) {
552 push @results, $data;
559 =head2 GetBiblioFromItemNumber
563 $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
565 Looks up the item with the given itemnumber. if undef, try the barcode.
567 C<&itemnodata> returns a reference-to-hash whose keys are the fields
568 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
576 sub GetBiblioFromItemNumber {
577 my ( $itemnumber, $barcode ) = @_;
578 my $dbh = C4::Context->dbh;
581 $sth=$dbh->prepare( "SELECT * FROM items
582 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
583 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
584 WHERE items.itemnumber = ?") ;
585 $sth->execute($itemnumber);
587 $sth=$dbh->prepare( "SELECT * FROM items
588 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
589 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
590 WHERE items.barcode = ?") ;
591 $sth->execute($barcode);
593 my $data = $sth->fetchrow_hashref;
602 ( $count, @results ) = &GetBiblio($biblionumber);
609 my ($biblionumber) = @_;
610 my $dbh = C4::Context->dbh;
611 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
614 $sth->execute($biblionumber);
615 while ( my $data = $sth->fetchrow_hashref ) {
616 $results[$count] = $data;
620 return ( $count, @results );
623 =head2 GetBiblioItemInfosOf
627 GetBiblioItemInfosOf(@biblioitemnumbers);
633 sub GetBiblioItemInfosOf {
634 my @biblioitemnumbers = @_;
637 SELECT biblioitemnumber,
641 WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
643 return get_infos_of( $query, 'biblioitemnumber' );
646 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
648 =head2 GetMarcStructure
652 $res = GetMarcStructure($forlibrarian,$frameworkcode);
654 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
655 $forlibrarian :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
656 $frameworkcode : the framework code to read
662 # cache for results of GetMarcStructure -- needed
664 our $marc_structure_cache;
666 sub GetMarcStructure {
667 my ( $forlibrarian, $frameworkcode ) = @_;
668 my $dbh=C4::Context->dbh;
669 $frameworkcode = "" unless $frameworkcode;
671 if (defined $marc_structure_cache and exists $marc_structure_cache->{$forlibrarian}->{$frameworkcode}) {
672 return $marc_structure_cache->{$forlibrarian}->{$frameworkcode};
676 my $libfield = ( $forlibrarian eq 1 ) ? 'liblibrarian' : 'libopac';
678 # check that framework exists
681 "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
682 $sth->execute($frameworkcode);
683 my ($total) = $sth->fetchrow;
684 $frameworkcode = "" unless ( $total > 0 );
687 "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable
688 FROM marc_tag_structure
689 WHERE frameworkcode=?
692 $sth->execute($frameworkcode);
693 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
695 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) =
698 $res->{$tag}->{lib} =
699 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
700 $res->{$tab}->{tab} = "";
701 $res->{$tag}->{mandatory} = $mandatory;
702 $res->{$tag}->{repeatable} = $repeatable;
707 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue
708 FROM marc_subfield_structure
709 WHERE frameworkcode=?
710 ORDER BY tagfield,tagsubfield
714 $sth->execute($frameworkcode);
717 my $authorised_value;
729 $tag, $subfield, $liblibrarian,
731 $mandatory, $repeatable, $authorised_value,
732 $authtypecode, $value_builder, $kohafield,
733 $seealso, $hidden, $isurl,
739 $res->{$tag}->{$subfield}->{lib} =
740 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
741 $res->{$tag}->{$subfield}->{tab} = $tab;
742 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
743 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
744 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
745 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
746 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
747 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
748 $res->{$tag}->{$subfield}->{seealso} = $seealso;
749 $res->{$tag}->{$subfield}->{hidden} = $hidden;
750 $res->{$tag}->{$subfield}->{isurl} = $isurl;
751 $res->{$tag}->{$subfield}->{'link'} = $link;
752 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
755 $marc_structure_cache->{$forlibrarian}->{$frameworkcode} = $res;
760 =head2 GetUsedMarcStructure
762 the same function as GetMarcStructure expcet it just take field
763 in tab 0-9. (used field)
765 my $results = GetUsedMarcStructure($frameworkcode);
767 L<$results> is a ref to an array which each case containts a ref
768 to a hash which each keys is the columns from marc_subfield_structure
770 L<$frameworkcode> is the framework code.
774 sub GetUsedMarcStructure($){
775 my $frameworkcode = shift || '';
776 my $dbh = C4::Context->dbh;
779 FROM marc_subfield_structure
781 AND frameworkcode = ?
784 my $sth = $dbh->prepare($query);
785 $sth->execute($frameworkcode);
786 while (my $row = $sth->fetchrow_hashref){
792 =head2 GetMarcFromKohaField
796 ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
797 Returns the MARC fields & subfields mapped to the koha field
798 for the given frameworkcode
804 sub GetMarcFromKohaField {
805 my ( $kohafield, $frameworkcode ) = @_;
806 return 0, 0 unless $kohafield;
807 my $relations = C4::Context->marcfromkohafield;
809 $relations->{$frameworkcode}->{$kohafield}->[0],
810 $relations->{$frameworkcode}->{$kohafield}->[1]
818 Returns MARC::Record of the biblionumber passed in parameter.
819 the marc record contains both biblio & item datas
826 my $biblionumber = shift;
827 my $dbh = C4::Context->dbh;
829 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
830 $sth->execute($biblionumber);
831 my $row = $sth->fetchrow_hashref;
832 my $marcxml = StripNonXmlChars($row->{'marcxml'});
833 MARC::File::XML->default_record_format(C4::Context->preference('marcflavour'));
834 my $record = MARC::Record->new();
836 $record = eval {MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour'))};
837 if ($@) {warn " problem with :$biblionumber : $@ \n$marcxml";}
838 # $record = MARC::Record::new_from_usmarc( $marc) if $marc;
849 my $marcxml = GetXmlBiblio($biblionumber);
851 Returns biblioitems.marcxml of the biblionumber passed in parameter.
852 The XML contains both biblio & item datas
859 my ( $biblionumber ) = @_;
860 my $dbh = C4::Context->dbh;
862 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
863 $sth->execute($biblionumber);
864 my ($marcxml) = $sth->fetchrow;
868 =head2 GetAuthorisedValueDesc
872 my $subfieldvalue =get_authorised_value_desc(
873 $tag, $subf[$i][0],$subf[$i][1], '', $taglib, $category);
874 Retrieve the complete description for a given authorised value.
876 Now takes $category and $value pair too.
877 my $auth_value_desc =GetAuthorisedValueDesc(
878 '','', 'DVD' ,'','','CCODE');
884 sub GetAuthorisedValueDesc {
885 my ( $tag, $subfield, $value, $framework, $tagslib, $category ) = @_;
886 my $dbh = C4::Context->dbh;
890 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
891 return C4::Branch::GetBranchName($value);
895 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
896 return getitemtypeinfo($value)->{description};
899 #---- "true" authorized value
900 $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'}
903 if ( $category ne "" ) {
906 "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
908 $sth->execute( $category, $value );
909 my $data = $sth->fetchrow_hashref;
910 return $data->{'lib'};
913 return $value; # if nothing is found return the original value
921 $marcnotesarray = GetMarcNotes( $record, $marcflavour );
922 Get all notes from the MARC record and returns them in an array.
923 The note are stored in differents places depending on MARC flavour
930 my ( $record, $marcflavour ) = @_;
932 if ( $marcflavour eq "MARC21" ) {
935 else { # assume unimarc if not marc21
942 foreach my $field ( $record->field($scope) ) {
943 my $value = $field->as_string();
945 $marcnote = { marcnote => $note, };
946 push @marcnotes, $marcnote;
949 if ( $note ne $value ) {
950 $note = $note . " " . $value;
955 $marcnote = { marcnote => $note };
956 push @marcnotes, $marcnote; #load last tag into array
961 =head2 GetMarcSubjects
965 $marcsubjcts = GetMarcSubjects($record,$marcflavour);
966 Get all subjects from the MARC record and returns them in an array.
967 The subjects are stored in differents places depending on MARC flavour
973 sub GetMarcSubjects {
974 my ( $record, $marcflavour ) = @_;
975 my ( $mintag, $maxtag );
976 if ( $marcflavour eq "MARC21" ) {
980 else { # assume unimarc if not marc21
990 foreach my $field ( $record->field('6..' )) {
991 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
993 my @subfields = $field->subfields();
996 # if there is an authority link, build the link with an= subfield9
997 my $subfield9 = $field->subfield('9');
998 for my $subject_subfield (@subfields ) {
999 # don't load unimarc subfields 3,4,5
1000 next if (($marcflavour eq "UNIMARC") and ($subject_subfield->[0] =~ (3|4|5) ) );
1001 my $code = $subject_subfield->[0];
1002 my $value = $subject_subfield->[1];
1003 my $linkvalue = $value;
1004 $linkvalue =~ s/(\(|\))//g;
1005 my $operator = " and " unless $counter==0;
1007 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1009 push @link_loop, {'limit' => 'su', link => $linkvalue, operator => $operator };
1011 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1013 my @this_link_loop = @link_loop;
1014 push @subfields_loop, {code => $code, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($subject_subfield->[0] == 9 );
1018 push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1021 return \@marcsubjects;
1022 } #end getMARCsubjects
1024 =head2 GetMarcAuthors
1028 authors = GetMarcAuthors($record,$marcflavour);
1029 Get all authors from the MARC record and returns them in an array.
1030 The authors are stored in differents places depending on MARC flavour
1036 sub GetMarcAuthors {
1037 my ( $record, $marcflavour ) = @_;
1038 my ( $mintag, $maxtag );
1039 # tagslib useful for UNIMARC author reponsabilities
1040 my $tagslib = &GetMarcStructure( 1, '' ); # FIXME : we don't have the framework available, we take the default framework. May be bugguy on some setups, will be usually correct.
1041 if ( $marcflavour eq "MARC21" ) {
1045 elsif ( $marcflavour eq "UNIMARC" ) { # assume unimarc if not marc21
1054 foreach my $field ( $record->fields ) {
1055 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1058 my @subfields = $field->subfields();
1060 # if there is an authority link, build the link with Koha-Auth-Number: subfield9
1061 my $subfield9 = $field->subfield('9');
1062 for my $authors_subfield (@subfields) {
1063 # don't load unimarc subfields 3, 5
1064 next if ($marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~ (3|5) ) );
1065 my $subfieldcode = $authors_subfield->[0];
1066 my $value = $authors_subfield->[1];
1067 my $linkvalue = $value;
1068 $linkvalue =~ s/(\(|\))//g;
1069 my $operator = " and " unless $count_auth==0;
1070 # if we have an authority link, use that as the link, otherwise use standard searching
1072 @link_loop = ({'limit' => 'Koha-Auth-Number' ,link => "$subfield9" });
1075 # reset $linkvalue if UNIMARC author responsibility
1076 if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] eq "4")) {
1077 $linkvalue = "(".GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ).")";
1079 push @link_loop, {'limit' => 'au', link => $linkvalue, operator => $operator };
1081 $value = GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ) if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~/4/));
1082 my @this_link_loop = @link_loop;
1083 my $separator = C4::Context->preference("authoritysep") unless $count_auth==0;
1084 push @subfields_loop, {code => $subfieldcode, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($authors_subfield->[0] == 9 );
1087 push @marcauthors, { MARCAUTHOR_SUBFIELDS_LOOP => \@subfields_loop };
1089 return \@marcauthors;
1096 $marcurls = GetMarcUrls($record,$marcflavour);
1097 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1098 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1105 my ($record, $marcflavour) = @_;
1108 for my $field ($record->field('856')) {
1109 my $url = $field->subfield('u');
1111 for my $note ( $field->subfield('z')) {
1112 push @notes , {note => $note};
1114 $marcurl = { MARCURL => $url,
1117 if($marcflavour eq 'MARC21') {
1118 my $s3 = $field->subfield('3');
1119 my $link = $field->subfield('y');
1120 $marcurl->{'linktext'} = $link || $s3 || $url ;;
1121 $marcurl->{'part'} = $s3 if($link);
1122 $marcurl->{'toc'} = 1 if($s3 =~ /^[Tt]able/) ;
1124 $marcurl->{'linktext'} = $url;
1126 push @marcurls, $marcurl;
1131 =head2 GetMarcSeries
1135 $marcseriesarray = GetMarcSeries($record,$marcflavour);
1136 Get all series from the MARC record and returns them in an array.
1137 The series are stored in differents places depending on MARC flavour
1144 my ($record, $marcflavour) = @_;
1145 my ($mintag, $maxtag);
1146 if ($marcflavour eq "MARC21") {
1149 } else { # assume unimarc if not marc21
1159 foreach my $field ($record->field('440'), $record->field('490')) {
1161 #my $value = $field->subfield('a');
1162 #$marcsubjct = {MARCSUBJCT => $value,};
1163 my @subfields = $field->subfields();
1164 #warn "subfields:".join " ", @$subfields;
1167 for my $series_subfield (@subfields) {
1169 undef $volume_number;
1170 # see if this is an instance of a volume
1171 if ($series_subfield->[0] eq 'v') {
1175 my $code = $series_subfield->[0];
1176 my $value = $series_subfield->[1];
1177 my $linkvalue = $value;
1178 $linkvalue =~ s/(\(|\))//g;
1179 my $operator = " and " unless $counter==0;
1180 push @link_loop, {link => $linkvalue, operator => $operator };
1181 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1182 if ($volume_number) {
1183 push @subfields_loop, {volumenum => $value};
1186 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number};
1190 push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
1191 #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
1192 #push @marcsubjcts, $marcsubjct;
1196 my $marcseriessarray=\@marcseries;
1197 return $marcseriessarray;
1198 } #end getMARCseriess
1200 =head2 GetFrameworkCode
1204 $frameworkcode = GetFrameworkCode( $biblionumber )
1210 sub GetFrameworkCode {
1211 my ( $biblionumber ) = @_;
1212 my $dbh = C4::Context->dbh;
1213 my $sth = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
1214 $sth->execute($biblionumber);
1215 my ($frameworkcode) = $sth->fetchrow;
1216 return $frameworkcode;
1219 =head2 GetPublisherNameFromIsbn
1221 $name = GetPublishercodeFromIsbn($isbn);
1228 sub GetPublisherNameFromIsbn($){
1230 $isbn =~ s/[- _]//g;
1232 my @codes = (split '-', DisplayISBN($isbn));
1233 my $code = $codes[0].$codes[1].$codes[2];
1234 my $dbh = C4::Context->dbh;
1236 SELECT distinct publishercode
1239 AND publishercode IS NOT NULL
1242 my $sth = $dbh->prepare($query);
1243 $sth->execute("$code%");
1244 my $name = $sth->fetchrow;
1245 return $name if length $name;
1249 =head2 TransformKohaToMarc
1253 $record = TransformKohaToMarc( $hash )
1254 This function builds partial MARC::Record from a hash
1255 Hash entries can be from biblio or biblioitems.
1256 This function is called in acquisition module, to create a basic catalogue entry from user entry
1262 sub TransformKohaToMarc {
1265 my $dbh = C4::Context->dbh;
1268 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1270 my $record = MARC::Record->new();
1271 foreach (keys %{$hash}) {
1272 &TransformKohaToMarcOneField( $sth, $record, $_,
1278 =head2 TransformKohaToMarcOneField
1282 $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
1288 sub TransformKohaToMarcOneField {
1289 my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
1290 $frameworkcode='' unless $frameworkcode;
1294 if ( !defined $sth ) {
1295 my $dbh = C4::Context->dbh;
1296 $sth = $dbh->prepare(
1297 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1300 $sth->execute( $frameworkcode, $kohafieldname );
1301 if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
1302 my $tag = $record->field($tagfield);
1304 $tag->update( $tagsubfield => $value );
1305 $record->delete_field($tag);
1306 $record->insert_fields_ordered($tag);
1309 $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
1315 =head2 TransformHtmlToXml
1319 $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type )
1321 $auth_type contains :
1322 - nothing : rebuild a biblio, un UNIMARC the encoding is in 100$a pos 26/27
1323 - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
1324 - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
1330 sub TransformHtmlToXml {
1331 my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
1332 my $xml = MARC::File::XML::header('UTF-8');
1333 $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
1334 MARC::File::XML->default_record_format($auth_type);
1335 # in UNIMARC, field 100 contains the encoding
1336 # check that there is one, otherwise the
1337 # MARC::Record->new_from_xml will fail (and Koha will die)
1338 my $unimarc_and_100_exist=0;
1339 $unimarc_and_100_exist=1 if $auth_type eq 'ITEM'; # if we rebuild an item, no need of a 100 field
1344 for ( my $i = 0 ; $i <= @$tags ; $i++ ) {
1345 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a") {
1346 # if we have a 100 field and it's values are not correct, skip them.
1347 # if we don't have any valid 100 field, we will create a default one at the end
1348 my $enc = substr( @$values[$i], 26, 2 );
1349 if ($enc eq '01' or $enc eq '50' or $enc eq '03') {
1350 $unimarc_and_100_exist=1;
1355 @$values[$i] =~ s/&/&/g;
1356 @$values[$i] =~ s/</</g;
1357 @$values[$i] =~ s/>/>/g;
1358 @$values[$i] =~ s/"/"/g;
1359 @$values[$i] =~ s/'/'/g;
1360 # if ( !utf8::is_utf8( @$values[$i] ) ) {
1361 # utf8::decode( @$values[$i] );
1363 if ( ( @$tags[$i] ne $prevtag ) ) {
1364 $j++ unless ( @$tags[$i] eq "" );
1366 $xml .= "</datafield>\n";
1367 if ( ( @$tags[$i] && @$tags[$i] > 10 )
1368 && ( @$values[$i] ne "" ) )
1370 my $ind1 = substr( @$indicator[$j], 0, 1 );
1372 if ( @$indicator[$j] ) {
1373 $ind2 = substr( @$indicator[$j], 1, 1 );
1376 warn "Indicator in @$tags[$i] is empty";
1380 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1382 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1390 if ( @$values[$i] ne "" ) {
1393 if ( @$tags[$i] eq "000" ) {
1394 $xml .= "<leader>@$values[$i]</leader>\n";
1397 # rest of the fixed fields
1399 elsif ( @$tags[$i] < 10 ) {
1401 "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
1405 my $ind1 = substr( @$indicator[$j], 0, 1 );
1406 my $ind2 = substr( @$indicator[$j], 1, 1 );
1408 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1410 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1416 else { # @$tags[$i] eq $prevtag
1417 if ( @$values[$i] eq "" ) {
1421 my $ind1 = substr( @$indicator[$j], 0, 1 );
1422 my $ind2 = substr( @$indicator[$j], 1, 1 );
1424 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1428 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1431 $prevtag = @$tags[$i];
1433 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and !$unimarc_and_100_exist) {
1434 # warn "SETTING 100 for $auth_type";
1435 use POSIX qw(strftime);
1436 my $string = strftime( "%Y%m%d", localtime(time) );
1437 # set 50 to position 26 is biblios, 13 if authorities
1439 $pos=13 if $auth_type eq 'UNIMARCAUTH';
1440 $string = sprintf( "%-*s", 35, $string );
1441 substr( $string, $pos , 6, "50" );
1442 $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
1443 $xml .= "<subfield code=\"a\">$string</subfield>\n";
1444 $xml .= "</datafield>\n";
1446 $xml .= MARC::File::XML::footer();
1450 =head2 TransformHtmlToMarc
1452 L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
1453 L<$params> is a ref to an array as below:
1455 'tag_010_indicator_531951' ,
1456 'tag_010_code_a_531951_145735' ,
1457 'tag_010_subfield_a_531951_145735' ,
1458 'tag_200_indicator_873510' ,
1459 'tag_200_code_a_873510_673465' ,
1460 'tag_200_subfield_a_873510_673465' ,
1461 'tag_200_code_b_873510_704318' ,
1462 'tag_200_subfield_b_873510_704318' ,
1463 'tag_200_code_e_873510_280822' ,
1464 'tag_200_subfield_e_873510_280822' ,
1465 'tag_200_code_f_873510_110730' ,
1466 'tag_200_subfield_f_873510_110730' ,
1468 L<$cgi> is the CGI object which containts the value.
1469 L<$record> is the MARC::Record object.
1473 sub TransformHtmlToMarc {
1477 # creating a new record
1478 my $record = MARC::Record->new();
1481 while ($params->[$i]){ # browse all CGI params
1482 my $param = $params->[$i];
1484 # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
1485 if ($param eq 'biblionumber') {
1486 my ( $biblionumbertagfield, $biblionumbertagsubfield ) =
1487 &GetMarcFromKohaField( "biblio.biblionumber", '' );
1488 if ($biblionumbertagfield < 10) {
1489 $newfield = MARC::Field->new(
1490 $biblionumbertagfield,
1491 $cgi->param($param),
1494 $newfield = MARC::Field->new(
1495 $biblionumbertagfield,
1498 "$biblionumbertagsubfield" => $cgi->param($param),
1501 push @fields,$newfield if($newfield);
1503 elsif ($param =~ /^tag_(\d*)_indicator_/){ # new field start when having 'input name="..._indicator_..."
1506 my $ind1 = substr($cgi->param($param),0,1);
1507 my $ind2 = substr($cgi->param($param),1,1);
1511 if($tag < 10){ # no code for theses fields
1512 # in MARC editor, 000 contains the leader.
1513 if ($tag eq '000' ) {
1514 $record->leader($cgi->param($params->[$j+1])) if length($cgi->param($params->[$j+1]))==24;
1515 # between 001 and 009 (included)
1517 $newfield = MARC::Field->new(
1519 $cgi->param($params->[$j+1]),
1522 # > 009, deal with subfields
1524 while($params->[$j] =~ /_code_/){ # browse all it's subfield
1525 my $inner_param = $params->[$j];
1527 if($cgi->param($params->[$j+1])){ # only if there is a value (code => value)
1528 $newfield->add_subfields(
1529 $cgi->param($inner_param) => $cgi->param($params->[$j+1])
1533 if ( $cgi->param($params->[$j+1]) ) { # creating only if there is a value (code => value)
1534 $newfield = MARC::Field->new(
1538 $cgi->param($inner_param) => $cgi->param($params->[$j+1]),
1545 push @fields,$newfield if($newfield);
1550 $record->append_fields(@fields);
1554 # cache inverted MARC field map
1555 our $inverted_field_map;
1557 =head2 TransformMarcToKoha
1561 $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
1565 Extract data from a MARC bib record into a hashref representing
1566 Koha biblio, biblioitems, and items fields.
1569 sub TransformMarcToKoha {
1570 my ( $dbh, $record, $frameworkcode, $limit_table ) = @_;
1574 unless (defined $inverted_field_map) {
1575 $inverted_field_map = _get_inverted_marc_field_map();
1579 if ($limit_table eq 'items') {
1580 $tables{'items'} = 1;
1582 $tables{'items'} = 1;
1583 $tables{'biblio'} = 1;
1584 $tables{'biblioitems'} = 1;
1587 # traverse through record
1588 MARCFIELD: foreach my $field ($record->fields()) {
1589 my $tag = $field->tag();
1590 next MARCFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag};
1591 if ($field->is_control_field()) {
1592 my $kohafields = $inverted_field_map->{$frameworkcode}->{$tag}->{list};
1593 ENTRY: foreach my $entry (@{ $kohafields }) {
1594 my ($subfield, $table, $column) = @{ $entry };
1595 next ENTRY unless exists $tables{$table};
1596 my $key = _disambiguate($table, $column);
1597 if ($result->{$key}) {
1598 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($field->data() eq "")) {
1599 $result->{$key} .= " | " . $field->data();
1602 $result->{$key} = $field->data();
1606 # deal with subfields
1607 MARCSUBFIELD: foreach my $sf ($field->subfields()) {
1608 my $code = $sf->[0];
1609 next MARCSUBFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code};
1610 my $value = $sf->[1];
1611 SFENTRY: foreach my $entry (@{ $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code} }) {
1612 my ($table, $column) = @{ $entry };
1613 next SFENTRY unless exists $tables{$table};
1614 my $key = _disambiguate($table, $column);
1615 if ($result->{$key}) {
1616 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($value eq "")) {
1617 $result->{$key} .= " | " . $value;
1620 $result->{$key} = $value;
1627 # modify copyrightdate to keep only the 1st year found
1628 if (exists $result->{'copyrightdate'}) {
1629 my $temp = $result->{'copyrightdate'};
1630 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
1632 $result->{'copyrightdate'} = $1;
1634 else { # if no cYYYY, get the 1st date.
1635 $temp =~ m/(\d\d\d\d)/;
1636 $result->{'copyrightdate'} = $1;
1640 # modify publicationyear to keep only the 1st year found
1641 if (exists $result->{'publicationyear'}) {
1642 my $temp = $result->{'publicationyear'};
1643 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
1645 $result->{'publicationyear'} = $1;
1647 else { # if no cYYYY, get the 1st date.
1648 $temp =~ m/(\d\d\d\d)/;
1649 $result->{'publicationyear'} = $1;
1656 sub _get_inverted_marc_field_map {
1658 my $relations = C4::Context->marcfromkohafield;
1660 foreach my $frameworkcode (keys %{ $relations }) {
1661 foreach my $kohafield (keys %{ $relations->{$frameworkcode} }) {
1662 my $tag = $relations->{$frameworkcode}->{$kohafield}->[0];
1663 my $subfield = $relations->{$frameworkcode}->{$kohafield}->[1];
1664 my ($table, $column) = split /[.]/, $kohafield, 2;
1665 push @{ $field_map->{$frameworkcode}->{$tag}->{list} }, [ $subfield, $table, $column ];
1666 push @{ $field_map->{$frameworkcode}->{$tag}->{sfs}->{$subfield} }, [ $table, $column ];
1672 =head2 _disambiguate
1676 $newkey = _disambiguate($table, $field);
1678 This is a temporary hack to distinguish between the
1679 following sets of columns when using TransformMarcToKoha.
1681 items.cn_source & biblioitems.cn_source
1682 items.cn_sort & biblioitems.cn_sort
1684 Columns that are currently NOT distinguished (FIXME
1685 due to lack of time to fully test) are:
1687 biblio.notes and biblioitems.notes
1692 FIXME - this is necessary because prefixing each column
1693 name with the table name would require changing lots
1694 of code and templates, and exposing more of the DB
1695 structure than is good to the UI templates, particularly
1696 since biblio and bibloitems may well merge in a future
1697 version. In the future, it would also be good to
1698 separate DB access and UI presentation field names
1706 my ($table, $column) = @_;
1707 if ($column eq "cn_sort" or $column eq "cn_source") {
1708 return $table . '.' . $column;
1715 =head2 get_koha_field_from_marc
1719 $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
1721 Internal function to map data from the MARC record to a specific non-MARC field.
1722 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
1728 sub get_koha_field_from_marc {
1729 my ($koha_table,$koha_column,$record,$frameworkcode) = @_;
1730 my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table.'.'.$koha_column, $frameworkcode );
1732 foreach my $field ( $record->field($tagfield) ) {
1733 if ( $field->tag() < 10 ) {
1735 $kohafield .= " | " . $field->data();
1738 $kohafield = $field->data();
1742 if ( $field->subfields ) {
1743 my @subfields = $field->subfields();
1744 foreach my $subfieldcount ( 0 .. $#subfields ) {
1745 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1748 " | " . $subfields[$subfieldcount][1];
1752 $subfields[$subfieldcount][1];
1763 =head2 TransformMarcToKohaOneField
1767 $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
1773 sub TransformMarcToKohaOneField {
1775 # FIXME ? if a field has a repeatable subfield that is used in old-db,
1776 # only the 1st will be retrieved...
1777 my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
1779 my ( $tagfield, $subfield ) =
1780 GetMarcFromKohaField( $kohatable . "." . $kohafield,
1782 foreach my $field ( $record->field($tagfield) ) {
1783 if ( $field->tag() < 10 ) {
1784 if ( $result->{$kohafield} ) {
1785 $result->{$kohafield} .= " | " . $field->data();
1788 $result->{$kohafield} = $field->data();
1792 if ( $field->subfields ) {
1793 my @subfields = $field->subfields();
1794 foreach my $subfieldcount ( 0 .. $#subfields ) {
1795 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1796 if ( $result->{$kohafield} ) {
1797 $result->{$kohafield} .=
1798 " | " . $subfields[$subfieldcount][1];
1801 $result->{$kohafield} =
1802 $subfields[$subfieldcount][1];
1812 =head1 OTHER FUNCTIONS
1815 =head2 PrepareItemrecordDisplay
1819 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber);
1821 Returns a hash with all the fields for Display a given item data in a template
1827 sub PrepareItemrecordDisplay {
1829 my ( $bibnum, $itemnum ) = @_;
1831 my $dbh = C4::Context->dbh;
1832 my $frameworkcode = &GetFrameworkCode( $bibnum );
1833 my ( $itemtagfield, $itemtagsubfield ) =
1834 &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
1835 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
1836 my $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum) if ($itemnum);
1838 my $authorised_values_sth =
1840 "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib"
1842 foreach my $tag ( sort keys %{$tagslib} ) {
1843 my $previous_tag = '';
1845 # loop through each subfield
1847 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
1848 next if ( subfield_is_koha_internal_p($subfield) );
1849 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
1851 $subfield_data{tag} = $tag;
1852 $subfield_data{subfield} = $subfield;
1853 $subfield_data{countsubfield} = $cntsubf++;
1854 $subfield_data{kohafield} =
1855 $tagslib->{$tag}->{$subfield}->{'kohafield'};
1857 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
1858 $subfield_data{marc_lib} =
1859 "<span id=\"error\" title=\""
1860 . $tagslib->{$tag}->{$subfield}->{lib} . "\">"
1861 . substr( $tagslib->{$tag}->{$subfield}->{lib}, 0, 12 )
1863 $subfield_data{mandatory} =
1864 $tagslib->{$tag}->{$subfield}->{mandatory};
1865 $subfield_data{repeatable} =
1866 $tagslib->{$tag}->{$subfield}->{repeatable};
1867 $subfield_data{hidden} = "display:none"
1868 if $tagslib->{$tag}->{$subfield}->{hidden};
1870 ( $x, $value ) = _find_value( $tag, $subfield, $itemrecord )
1872 $value =~ s/"/"/g;
1874 # search for itemcallnumber if applicable
1875 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
1876 'items.itemcallnumber'
1877 && C4::Context->preference('itemcallnumber') )
1880 substr( C4::Context->preference('itemcallnumber'), 0, 3 );
1882 substr( C4::Context->preference('itemcallnumber'), 3, 1 );
1883 my $temp = $itemrecord->field($CNtag) if ($itemrecord);
1885 $value = $temp->subfield($CNsubfield);
1888 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
1889 my @authorised_values;
1892 # builds list, depending on authorised value...
1894 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq
1897 if ( ( C4::Context->preference("IndependantBranches") )
1898 && ( C4::Context->userenv->{flags} != 1 ) )
1902 "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname"
1904 $sth->execute( C4::Context->userenv->{branch} );
1905 push @authorised_values, ""
1907 $tagslib->{$tag}->{$subfield}->{mandatory} );
1908 while ( my ( $branchcode, $branchname ) =
1909 $sth->fetchrow_array )
1911 push @authorised_values, $branchcode;
1912 $authorised_lib{$branchcode} = $branchname;
1918 "SELECT branchcode,branchname FROM branches ORDER BY branchname"
1921 push @authorised_values, ""
1923 $tagslib->{$tag}->{$subfield}->{mandatory} );
1924 while ( my ( $branchcode, $branchname ) =
1925 $sth->fetchrow_array )
1927 push @authorised_values, $branchcode;
1928 $authorised_lib{$branchcode} = $branchname;
1934 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq
1939 "SELECT itemtype,description FROM itemtypes ORDER BY description"
1942 push @authorised_values, ""
1943 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
1944 while ( my ( $itemtype, $description ) =
1945 $sth->fetchrow_array )
1947 push @authorised_values, $itemtype;
1948 $authorised_lib{$itemtype} = $description;
1951 #---- "true" authorised value
1954 $authorised_values_sth->execute(
1955 $tagslib->{$tag}->{$subfield}->{authorised_value} );
1956 push @authorised_values, ""
1957 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
1958 while ( my ( $value, $lib ) =
1959 $authorised_values_sth->fetchrow_array )
1961 push @authorised_values, $value;
1962 $authorised_lib{$value} = $lib;
1965 $subfield_data{marc_value} = CGI::scrolling_list(
1966 -name => 'field_value',
1967 -values => \@authorised_values,
1968 -default => "$value",
1969 -labels => \%authorised_lib,
1975 elsif ( $tagslib->{$tag}->{$subfield}->{thesaurus_category} ) {
1976 $subfield_data{marc_value} =
1977 "<input type=\"text\" name=\"field_value\" size=47 maxlength=255> <a href=\"javascript:Dopop('cataloguing/thesaurus_popup.pl?category=$tagslib->{$tag}->{$subfield}->{thesaurus_category}&index=',)\">...</a>";
1980 # COMMENTED OUT because No $i is provided with this API.
1981 # And thus, no value_builder can be activated.
1982 # BUT could be thought over.
1983 # } elsif ($tagslib->{$tag}->{$subfield}->{'value_builder'}) {
1984 # my $plugin="value_builder/".$tagslib->{$tag}->{$subfield}->{'value_builder'};
1986 # my $extended_param = plugin_parameters($dbh,$itemrecord,$tagslib,$i,0);
1987 # my ($function_name,$javascript) = plugin_javascript($dbh,$record,$tagslib,$i,0);
1988 # $subfield_data{marc_value}="<input type=\"text\" value=\"$value\" name=\"field_value\" size=47 maxlength=255 DISABLE READONLY OnFocus=\"javascript:Focus$function_name()\" OnBlur=\"javascript:Blur$function_name()\"> <a href=\"javascript:Clic$function_name()\">...</a> $javascript";
1991 $subfield_data{marc_value} =
1992 "<input type=\"text\" name=\"field_value\" value=\"$value\" size=50 maxlength=255>";
1994 push( @loop_data, \%subfield_data );
1998 my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
1999 if ( $itemrecord && $itemrecord->field($itemtagfield) );
2001 'itemtagfield' => $itemtagfield,
2002 'itemtagsubfield' => $itemtagsubfield,
2003 'itemnumber' => $itemnumber,
2004 'iteminformation' => \@loop_data
2010 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2012 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2013 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2014 # =head2 ModZebrafiles
2016 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
2020 # sub ModZebrafiles {
2022 # my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
2026 # C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
2027 # unless ( opendir( DIR, "$zebradir" ) ) {
2028 # warn "$zebradir not found";
2032 # my $filename = $zebradir . $biblionumber;
2035 # open( OUTPUT, ">", $filename . ".xml" );
2036 # print OUTPUT $record;
2045 ModZebra( $biblionumber, $op, $server, $newRecord );
2047 $biblionumber is the biblionumber we want to index
2048 $op is specialUpdate or delete, and is used to know what we want to do
2049 $server is the server that we want to update
2050 $newRecord is the MARC::Record containing the new record. It is usefull only when NoZebra=1, and is used to know what to add to the nozebra database. (the record in mySQL being, if it exist, the previous record, the one just before the modif. We need both : the previous and the new one.
2057 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
2058 my ( $biblionumber, $op, $server, $oldRecord, $newRecord ) = @_;
2059 my $dbh=C4::Context->dbh;
2061 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2063 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2064 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2066 if (C4::Context->preference("NoZebra")) {
2067 # lock the nozebra table : we will read index lines, update them in Perl process
2068 # and write everything in 1 transaction.
2069 # lock the table to avoid someone else overwriting what we are doing
2070 $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE');
2071 my %result; # the result hash that will be builded by deletion / add, and written on mySQL at the end, to improve speed
2072 if ($op eq 'specialUpdate') {
2073 # OK, we have to add or update the record
2074 # 1st delete (virtually, in indexes), if record actually exists
2076 %result = _DelBiblioNoZebra($biblionumber,$oldRecord,$server);
2078 # ... add the record
2079 %result=_AddBiblioNoZebra($biblionumber,$newRecord, $server, %result);
2081 # it's a deletion, delete the record...
2082 # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
2083 %result=_DelBiblioNoZebra($biblionumber,$oldRecord,$server);
2085 # ok, now update the database...
2086 my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
2087 foreach my $key (keys %result) {
2088 foreach my $index (keys %{$result{$key}}) {
2089 $sth->execute($result{$key}->{$index}, $server, $key, $index);
2092 $dbh->do('UNLOCK TABLES');
2096 # we use zebra, just fill zebraqueue table
2098 my $check_sql = "SELECT COUNT(*) FROM zebraqueue
2100 AND biblio_auth_number = ?
2103 my $check_sth = $dbh->prepare_cached($check_sql);
2104 $check_sth->execute($server, $biblionumber, $op);
2105 my ($count) = $check_sth->fetchrow_array;
2106 $check_sth->finish();
2108 my $sth=$dbh->prepare("INSERT INTO zebraqueue (biblio_auth_number,server,operation) VALUES(?,?,?)");
2109 $sth->execute($biblionumber,$server,$op);
2115 =head2 GetNoZebraIndexes
2117 %indexes = GetNoZebraIndexes;
2119 return the data from NoZebraIndexes syspref.
2123 sub GetNoZebraIndexes {
2124 my $index = C4::Context->preference('NoZebraIndexes');
2126 foreach my $line (split /('|"),/,$index) {
2127 $line =~ /(.*)=>(.*)/;
2128 my $index = substr($1,1); # get the index, don't forget to remove initial ' or "
2130 $index =~ s/'|"|\s//g;
2133 $fields =~ s/'|"|\s//g;
2134 $indexes{$index}=$fields;
2139 =head1 INTERNAL FUNCTIONS
2141 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
2143 function to delete a biblio in NoZebra indexes
2144 This function does NOT delete anything in database : it reads all the indexes entries
2145 that have to be deleted & delete them in the hash
2146 The SQL part is done either :
2147 - after the Add if we are modifying a biblio (delete + add again)
2148 - immediatly after this sub if we are doing a true deletion.
2149 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
2154 sub _DelBiblioNoZebra {
2155 my ($biblionumber, $record, $server)=@_;
2158 my $dbh = C4::Context->dbh;
2162 if ($server eq 'biblioserver') {
2163 %index=GetNoZebraIndexes;
2164 # get title of the record (to store the 10 first letters with the index)
2165 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
2166 $title = lc($record->subfield($titletag,$titlesubfield));
2168 # for authorities, the "title" is the $a mainentry
2169 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
2170 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2171 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2172 $index{'mainmainentry'}= $authref->{'auth_tag_to_report'}.'a';
2173 $index{'mainentry'} = $authref->{'auth_tag_to_report'}.'*';
2174 $index{'auth_type'} = '152b';
2178 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2179 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
2180 # limit to 10 char, should be enough, and limit the DB size
2181 $title = substr($title,0,10);
2183 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2184 foreach my $field ($record->fields()) {
2185 #parse each subfield
2186 next if $field->tag <10;
2187 foreach my $subfield ($field->subfields()) {
2188 my $tag = $field->tag();
2189 my $subfieldcode = $subfield->[0];
2191 # check each index to see if the subfield is stored somewhere
2192 # otherwise, store it in __RAW__ index
2193 foreach my $key (keys %index) {
2194 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2195 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2197 my $line= lc $subfield->[1];
2198 # remove meaningless value in the field...
2199 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2200 # ... and split in words
2201 foreach (split / /,$line) {
2202 next unless $_; # skip empty values (multiple spaces)
2203 # if the entry is already here, do nothing, the biblionumber has already be removed
2204 unless ($result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2205 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2206 $sth2->execute($server,$key,$_);
2207 my $existing_biblionumbers = $sth2->fetchrow;
2209 if ($existing_biblionumbers) {
2210 # warn " existing for $key $_: $existing_biblionumbers";
2211 $result{$key}->{$_} =$existing_biblionumbers;
2212 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2218 # the subfield is not indexed, store it in __RAW__ index anyway
2220 my $line= lc $subfield->[1];
2221 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2222 # ... and split in words
2223 foreach (split / /,$line) {
2224 next unless $_; # skip empty values (multiple spaces)
2225 # if the entry is already here, do nothing, the biblionumber has already be removed
2226 unless ($result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2227 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2228 $sth2->execute($server,'__RAW__',$_);
2229 my $existing_biblionumbers = $sth2->fetchrow;
2231 if ($existing_biblionumbers) {
2232 $result{'__RAW__'}->{$_} =$existing_biblionumbers;
2233 $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2243 =head2 _AddBiblioNoZebra($biblionumber, $record, $server, %result);
2245 function to add a biblio in NoZebra indexes
2249 sub _AddBiblioNoZebra {
2250 my ($biblionumber, $record, $server, %result)=@_;
2251 my $dbh = C4::Context->dbh;
2255 if ($server eq 'biblioserver') {
2256 %index=GetNoZebraIndexes;
2257 # get title of the record (to store the 10 first letters with the index)
2258 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
2259 $title = lc($record->subfield($titletag,$titlesubfield));
2261 # warn "server : $server";
2262 # for authorities, the "title" is the $a mainentry
2263 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
2264 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2265 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2266 $index{'mainmainentry'} = $authref->{auth_tag_to_report}.'a';
2267 $index{'mainentry'} = $authref->{auth_tag_to_report}.'*';
2268 $index{'auth_type'} = '152b';
2271 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2272 $title =~ s/ |\.|,|;|\[|\]|\(|\)|\*|-|'|:|=|\r|\n//g;
2273 # limit to 10 char, should be enough, and limit the DB size
2274 $title = substr($title,0,10);
2276 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2277 foreach my $field ($record->fields()) {
2278 #parse each subfield
2279 next if $field->tag <10;
2280 foreach my $subfield ($field->subfields()) {
2281 my $tag = $field->tag();
2282 my $subfieldcode = $subfield->[0];
2284 warn "INDEXING :".$subfield->[1];
2285 # check each index to see if the subfield is stored somewhere
2286 # otherwise, store it in __RAW__ index
2287 foreach my $key (keys %index) {
2288 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2289 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2291 my $line= lc $subfield->[1];
2292 # remove meaningless value in the field...
2293 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2294 # ... and split in words
2295 foreach (split / /,$line) {
2296 next unless $_; # skip empty values (multiple spaces)
2297 # if the entry is already here, improve weight
2298 # warn "managing $_";
2299 if ($result{$key}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d);/) {
2301 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2302 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2304 # get the value if it exist in the nozebra table, otherwise, create it
2305 $sth2->execute($server,$key,$_);
2306 my $existing_biblionumbers = $sth2->fetchrow;
2308 if ($existing_biblionumbers) {
2309 $result{$key}->{"$_"} =$existing_biblionumbers;
2311 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2312 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2313 # create a new ligne for this entry
2315 # warn "INSERT : $server / $key / $_";
2316 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname='.$dbh->quote($key).',value='.$dbh->quote($_));
2317 $result{$key}->{"$_"}.="$biblionumber,$title-1;";
2323 # the subfield is not indexed, store it in __RAW__ index anyway
2325 my $line= lc $subfield->[1];
2326 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2327 # ... and split in words
2328 foreach (split / /,$line) {
2329 next unless $_; # skip empty values (multiple spaces)
2330 # if the entry is already here, improve weight
2331 if ($result{'__RAW__'}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d);/) {
2333 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2334 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2336 # get the value if it exist in the nozebra table, otherwise, create it
2337 $sth2->execute($server,'__RAW__',$_);
2338 my $existing_biblionumbers = $sth2->fetchrow;
2340 if ($existing_biblionumbers) {
2341 $result{'__RAW__'}->{"$_"} =$existing_biblionumbers;
2343 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2344 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2345 # create a new ligne for this entry
2347 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname="__RAW__",value='.$dbh->quote($_));
2348 $result{'__RAW__'}->{"$_"}.="$biblionumber,$title-1;";
2363 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2365 Find the given $subfield in the given $tag in the given
2366 MARC::Record $record. If the subfield is found, returns
2367 the (indicators, value) pair; otherwise, (undef, undef) is
2371 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2372 I suggest we export it from this module.
2379 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2382 if ( $tagfield < 10 ) {
2383 if ( $record->field($tagfield) ) {
2384 push @result, $record->field($tagfield)->data();
2391 foreach my $field ( $record->field($tagfield) ) {
2392 my @subfields = $field->subfields();
2393 foreach my $subfield (@subfields) {
2394 if ( @$subfield[0] eq $insubfield ) {
2395 push @result, @$subfield[1];
2396 $indicator = $field->indicator(1) . $field->indicator(2);
2401 return ( $indicator, @result );
2404 =head2 _koha_marc_update_bib_ids
2408 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
2410 Internal function to add or update biblionumber and biblioitemnumber to
2417 sub _koha_marc_update_bib_ids {
2418 my ($record, $frameworkcode, $biblionumber, $biblioitemnumber) = @_;
2420 # we must add bibnum and bibitemnum in MARC::Record...
2421 # we build the new field with biblionumber and biblioitemnumber
2422 # we drop the original field
2423 # we add the new builded field.
2424 my ($biblio_tag, $biblio_subfield ) = GetMarcFromKohaField("biblio.biblionumber",$frameworkcode);
2425 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.biblioitemnumber",$frameworkcode);
2427 if ($biblio_tag != $biblioitem_tag) {
2428 # biblionumber & biblioitemnumber are in different fields
2430 # deal with biblionumber
2431 my ($new_field, $old_field);
2432 if ($biblio_tag < 10) {
2433 $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
2436 MARC::Field->new( $biblio_tag, '', '',
2437 "$biblio_subfield" => $biblionumber );
2440 # drop old field and create new one...
2441 $old_field = $record->field($biblio_tag);
2442 $record->delete_field($old_field);
2443 $record->append_fields($new_field);
2445 # deal with biblioitemnumber
2446 if ($biblioitem_tag < 10) {
2447 $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
2450 MARC::Field->new( $biblioitem_tag, '', '',
2451 "$biblioitem_subfield" => $biblioitemnumber, );
2453 # drop old field and create new one...
2454 $old_field = $record->field($biblioitem_tag);
2455 $record->delete_field($old_field);
2456 $record->insert_fields_ordered($new_field);
2459 # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
2460 my $new_field = MARC::Field->new(
2461 $biblio_tag, '', '',
2462 "$biblio_subfield" => $biblionumber,
2463 "$biblioitem_subfield" => $biblioitemnumber
2466 # drop old field and create new one...
2467 my $old_field = $record->field($biblio_tag);
2468 $record->delete_field($old_field);
2469 $record->insert_fields_ordered($new_field);
2473 =head2 _koha_marc_update_biblioitem_cn_sort
2477 _koha_marc_update_biblioitem_cn_sort($marc, $biblioitem, $frameworkcode);
2481 Given a MARC bib record and the biblioitem hash, update the
2482 subfield that contains a copy of the value of biblioitems.cn_sort.
2486 sub _koha_marc_update_biblioitem_cn_sort {
2488 my $biblioitem = shift;
2489 my $frameworkcode= shift;
2491 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.cn_sort",$frameworkcode);
2492 return unless $biblioitem_tag;
2494 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2496 if (my $field = $marc->field($biblioitem_tag)) {
2497 $field->delete_subfield(code => $biblioitem_subfield);
2498 if ($cn_sort ne '') {
2499 $field->add_subfields($biblioitem_subfield => $cn_sort);
2502 # if we get here, no biblioitem tag is present in the MARC record, so
2503 # we'll create it if $cn_sort is not empty -- this would be
2504 # an odd combination of events, however
2506 $marc->insert_grouped_field(MARC::Field->new($biblioitem_tag, ' ', ' ', $biblioitem_subfield => $cn_sort));
2511 =head2 _koha_add_biblio
2515 my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
2517 Internal function to add a biblio ($biblio is a hash with the values)
2523 sub _koha_add_biblio {
2524 my ( $dbh, $biblio, $frameworkcode ) = @_;
2528 # set the series flag
2530 if ( $biblio->{'seriestitle'} ) { $serial = 1 };
2534 SET frameworkcode = ?,
2545 my $sth = $dbh->prepare($query);
2548 $biblio->{'author'},
2550 $biblio->{'unititle'},
2553 $biblio->{'seriestitle'},
2554 $biblio->{'copyrightdate'},
2555 $biblio->{'abstract'}
2558 my $biblionumber = $dbh->{'mysql_insertid'};
2559 if ( $dbh->errstr ) {
2560 $error.="ERROR in _koha_add_biblio $query".$dbh->errstr;
2565 #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
2566 return ($biblionumber,$error);
2569 =head2 _koha_modify_biblio
2573 my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
2575 Internal function for updating the biblio table
2581 sub _koha_modify_biblio {
2582 my ( $dbh, $biblio, $frameworkcode ) = @_;
2587 SET frameworkcode = ?,
2596 WHERE biblionumber = ?
2599 my $sth = $dbh->prepare($query);
2603 $biblio->{'author'},
2605 $biblio->{'unititle'},
2607 $biblio->{'serial'},
2608 $biblio->{'seriestitle'},
2609 $biblio->{'copyrightdate'},
2610 $biblio->{'abstract'},
2611 $biblio->{'biblionumber'}
2612 ) if $biblio->{'biblionumber'};
2614 if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
2615 $error.="ERROR in _koha_modify_biblio $query".$dbh->errstr;
2618 return ( $biblio->{'biblionumber'},$error );
2621 =head2 _koha_modify_biblioitem_nonmarc
2625 my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
2627 Updates biblioitems row except for marc and marcxml, which should be changed
2634 sub _koha_modify_biblioitem_nonmarc {
2635 my ( $dbh, $biblioitem ) = @_;
2638 # re-calculate the cn_sort, it may have changed
2639 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2643 SET biblionumber = ?,
2649 publicationyear = ?,
2653 collectiontitle = ?,
2655 collectionvolume= ?,
2656 editionstatement= ?,
2657 editionresponsibility = ?,
2671 where biblioitemnumber = ?
2673 my $sth = $dbh->prepare($query);
2675 $biblioitem->{'biblionumber'},
2676 $biblioitem->{'volume'},
2677 $biblioitem->{'number'},
2678 $biblioitem->{'itemtype'},
2679 $biblioitem->{'isbn'},
2680 $biblioitem->{'issn'},
2681 $biblioitem->{'publicationyear'},
2682 $biblioitem->{'publishercode'},
2683 $biblioitem->{'volumedate'},
2684 $biblioitem->{'volumedesc'},
2685 $biblioitem->{'collectiontitle'},
2686 $biblioitem->{'collectionissn'},
2687 $biblioitem->{'collectionvolume'},
2688 $biblioitem->{'editionstatement'},
2689 $biblioitem->{'editionresponsibility'},
2690 $biblioitem->{'illus'},
2691 $biblioitem->{'pages'},
2692 $biblioitem->{'bnotes'},
2693 $biblioitem->{'size'},
2694 $biblioitem->{'place'},
2695 $biblioitem->{'lccn'},
2696 $biblioitem->{'url'},
2697 $biblioitem->{'biblioitems.cn_source'},
2698 $biblioitem->{'cn_class'},
2699 $biblioitem->{'cn_item'},
2700 $biblioitem->{'cn_suffix'},
2702 $biblioitem->{'totalissues'},
2703 $biblioitem->{'biblioitemnumber'}
2705 if ( $dbh->errstr ) {
2706 $error.="ERROR in _koha_modify_biblioitem_nonmarc $query".$dbh->errstr;
2709 return ($biblioitem->{'biblioitemnumber'},$error);
2712 =head2 _koha_add_biblioitem
2716 my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
2718 Internal function to add a biblioitem
2724 sub _koha_add_biblioitem {
2725 my ( $dbh, $biblioitem ) = @_;
2728 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2730 "INSERT INTO biblioitems SET
2737 publicationyear = ?,
2741 collectiontitle = ?,
2743 collectionvolume= ?,
2744 editionstatement= ?,
2745 editionresponsibility = ?,
2761 my $sth = $dbh->prepare($query);
2763 $biblioitem->{'biblionumber'},
2764 $biblioitem->{'volume'},
2765 $biblioitem->{'number'},
2766 $biblioitem->{'itemtype'},
2767 $biblioitem->{'isbn'},
2768 $biblioitem->{'issn'},
2769 $biblioitem->{'publicationyear'},
2770 $biblioitem->{'publishercode'},
2771 $biblioitem->{'volumedate'},
2772 $biblioitem->{'volumedesc'},
2773 $biblioitem->{'collectiontitle'},
2774 $biblioitem->{'collectionissn'},
2775 $biblioitem->{'collectionvolume'},
2776 $biblioitem->{'editionstatement'},
2777 $biblioitem->{'editionresponsibility'},
2778 $biblioitem->{'illus'},
2779 $biblioitem->{'pages'},
2780 $biblioitem->{'bnotes'},
2781 $biblioitem->{'size'},
2782 $biblioitem->{'place'},
2783 $biblioitem->{'lccn'},
2784 $biblioitem->{'marc'},
2785 $biblioitem->{'url'},
2786 $biblioitem->{'biblioitems.cn_source'},
2787 $biblioitem->{'cn_class'},
2788 $biblioitem->{'cn_item'},
2789 $biblioitem->{'cn_suffix'},
2791 $biblioitem->{'totalissues'}
2793 my $bibitemnum = $dbh->{'mysql_insertid'};
2794 if ( $dbh->errstr ) {
2795 $error.="ERROR in _koha_add_biblioitem $query".$dbh->errstr;
2799 return ($bibitemnum,$error);
2802 =head2 _koha_delete_biblio
2806 $error = _koha_delete_biblio($dbh,$biblionumber);
2808 Internal sub for deleting from biblio table -- also saves to deletedbiblio
2810 C<$dbh> - the database handle
2811 C<$biblionumber> - the biblionumber of the biblio to be deleted
2817 # FIXME: add error handling
2819 sub _koha_delete_biblio {
2820 my ( $dbh, $biblionumber ) = @_;
2822 # get all the data for this biblio
2823 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
2824 $sth->execute($biblionumber);
2826 if ( my $data = $sth->fetchrow_hashref ) {
2828 # save the record in deletedbiblio
2829 # find the fields to save
2830 my $query = "INSERT INTO deletedbiblio SET ";
2832 foreach my $temp ( keys %$data ) {
2833 $query .= "$temp = ?,";
2834 push( @bind, $data->{$temp} );
2837 # replace the last , by ",?)"
2839 my $bkup_sth = $dbh->prepare($query);
2840 $bkup_sth->execute(@bind);
2844 my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
2845 $del_sth->execute($biblionumber);
2852 =head2 _koha_delete_biblioitems
2856 $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
2858 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
2860 C<$dbh> - the database handle
2861 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
2867 # FIXME: add error handling
2869 sub _koha_delete_biblioitems {
2870 my ( $dbh, $biblioitemnumber ) = @_;
2872 # get all the data for this biblioitem
2874 $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
2875 $sth->execute($biblioitemnumber);
2877 if ( my $data = $sth->fetchrow_hashref ) {
2879 # save the record in deletedbiblioitems
2880 # find the fields to save
2881 my $query = "INSERT INTO deletedbiblioitems SET ";
2883 foreach my $temp ( keys %$data ) {
2884 $query .= "$temp = ?,";
2885 push( @bind, $data->{$temp} );
2888 # replace the last , by ",?)"
2890 my $bkup_sth = $dbh->prepare($query);
2891 $bkup_sth->execute(@bind);
2894 # delete the biblioitem
2896 $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
2897 $del_sth->execute($biblioitemnumber);
2904 =head1 UNEXPORTED FUNCTIONS
2906 =head2 ModBiblioMarc
2908 &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
2910 Add MARC data for a biblio to koha
2912 Function exported, but should NOT be used, unless you really know what you're doing
2918 # pass the MARC::Record to this function, and it will create the records in the marc field
2919 my ( $record, $biblionumber, $frameworkcode ) = @_;
2920 my $dbh = C4::Context->dbh;
2921 my @fields = $record->fields();
2922 if ( !$frameworkcode ) {
2923 $frameworkcode = "";
2926 $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
2927 $sth->execute( $frameworkcode, $biblionumber );
2929 my $encoding = C4::Context->preference("marcflavour");
2931 # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
2932 if ( $encoding eq "UNIMARC" ) {
2934 if ( length($record->subfield( 100, "a" )) == 35 ) {
2935 $string = $record->subfield( 100, "a" );
2936 my $f100 = $record->field(100);
2937 $record->delete_field($f100);
2940 $string = POSIX::strftime( "%Y%m%d", localtime );
2942 $string = sprintf( "%-*s", 35, $string );
2944 substr( $string, 22, 6, "frey50" );
2945 unless ( $record->subfield( 100, "a" ) ) {
2946 $record->insert_grouped_field(
2947 MARC::Field->new( 100, "", "", "a" => $string ) );
2951 if (C4::Context->preference("NoZebra")) {
2952 # only NoZebra indexing needs to have
2953 # the previous version of the record
2954 $oldRecord = GetMarcBiblio($biblionumber);
2958 "UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
2959 $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding),
2962 ModZebra($biblionumber,"specialUpdate","biblioserver",$oldRecord,$record);
2963 return $biblionumber;
2966 =head2 z3950_extended_services
2968 z3950_extended_services($serviceType,$serviceOptions,$record);
2970 z3950_extended_services is used to handle all interactions with Zebra's extended serices package, which is employed to perform all management of the MARC data stored in Zebra.
2972 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
2974 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
2976 action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
2980 recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
2981 syntax => the record syntax (transfer syntax)
2982 databaseName = Database from connection object
2984 To set serviceOptions, call set_service_options($serviceType)
2986 C<$record> the record, if one is needed for the service type
2988 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
2992 sub z3950_extended_services {
2993 my ( $server, $serviceType, $action, $serviceOptions ) = @_;
2995 # get our connection object
2996 my $Zconn = C4::Context->Zconn( $server, 0, 1 );
2998 # create a new package object
2999 my $Zpackage = $Zconn->package();
3002 $Zpackage->option( action => $action );
3004 if ( $serviceOptions->{'databaseName'} ) {
3005 $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
3007 if ( $serviceOptions->{'recordIdNumber'} ) {
3009 recordIdNumber => $serviceOptions->{'recordIdNumber'} );
3011 if ( $serviceOptions->{'recordIdOpaque'} ) {
3013 recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
3016 # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
3017 #if ($serviceType eq 'itemorder') {
3018 # $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
3019 # $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
3020 # $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
3021 # $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
3024 if ( $serviceOptions->{record} ) {
3025 $Zpackage->option( record => $serviceOptions->{record} );
3027 # can be xml or marc
3028 if ( $serviceOptions->{'syntax'} ) {
3029 $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
3033 # send the request, handle any exception encountered
3034 eval { $Zpackage->send($serviceType) };
3035 if ( $@ && $@->isa("ZOOM::Exception") ) {
3036 return "error: " . $@->code() . " " . $@->message() . "\n";
3039 # free up package resources
3040 $Zpackage->destroy();
3043 =head2 set_service_options
3045 my $serviceOptions = set_service_options($serviceType);
3047 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
3049 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
3053 sub set_service_options {
3054 my ($serviceType) = @_;
3057 # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
3058 # $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
3060 if ( $serviceType eq 'commit' ) {
3064 if ( $serviceType eq 'create' ) {
3068 if ( $serviceType eq 'drop' ) {
3069 die "ERROR: 'drop' not currently supported (by Zebra)";
3071 return $serviceOptions;
3080 Koha Developement team <info@koha.org>
3082 Paul POULAIN paul.poulain@free.fr
3084 Joshua Ferraro jmf@liblime.com