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("CATALOGUING", "ADD", $biblionumber, "biblio") if C4::Context->preference("CataloguingLog");
244 return ( $biblionumber, $biblioitemnumber );
251 ModBiblio( $record,$biblionumber,$frameworkcode);
255 Replace an existing bib record identified by C<$biblionumber>
256 with one supplied by the MARC::Record object C<$record>. The embedded
257 item, biblioitem, and biblionumber fields from the previous
258 version of the bib record replace any such fields of those tags that
259 are present in C<$record>. Consequently, ModBiblio() is not
260 to be used to try to modify item records.
262 C<$frameworkcode> specifies the MARC framework to use
263 when storing the modified bib record; among other things,
264 this controls how MARC fields get mapped to display columns
265 in the C<biblio> and C<biblioitems> tables, as well as
266 which fields are used to store embedded item, biblioitem,
267 and biblionumber data for indexing.
272 my ( $record, $biblionumber, $frameworkcode ) = @_;
273 if (C4::Context->preference("CataloguingLog")) {
274 my $newrecord = GetMarcBiblio($biblionumber);
275 logaction("CATALOGUING", "MODIFY", $biblionumber, "BEFORE=>".$newrecord->as_formatted);
278 my $dbh = C4::Context->dbh;
280 $frameworkcode = "" unless $frameworkcode;
282 # get the items before and append them to the biblio before updating the record, atm we just have the biblio
283 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
284 my $oldRecord = GetMarcBiblio( $biblionumber );
286 # delete any item fields from incoming record to avoid
287 # duplication or incorrect data - use AddItem() or ModItem()
289 foreach my $field ($record->field($itemtag)) {
290 $record->delete_field($field);
293 # parse each item, and, for an unknown reason, re-encode each subfield
294 # if you don't do that, the record will have encoding mixed
295 # and the biblio will be re-encoded.
296 # strange, I (Paul P.) searched more than 1 day to understand what happends
297 # but could only solve the problem this way...
298 my @fields = $oldRecord->field( $itemtag );
299 foreach my $fielditem ( @fields ){
301 foreach ($fielditem->subfields()) {
303 $field->add_subfields(Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
305 $field = MARC::Field->new("$itemtag",'','',Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
308 $record->append_fields($field);
311 # update biblionumber and biblioitemnumber in MARC
312 # FIXME - this is assuming a 1 to 1 relationship between
313 # biblios and biblioitems
314 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
315 $sth->execute($biblionumber);
316 my ($biblioitemnumber) = $sth->fetchrow;
318 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
320 # load the koha-table data object
321 my $oldbiblio = TransformMarcToKoha( $dbh, $record, $frameworkcode );
323 # update MARC subfield that stores biblioitems.cn_sort
324 _koha_marc_update_biblioitem_cn_sort($record, $oldbiblio, $frameworkcode);
326 # update the MARC record (that now contains biblio and items) with the new record data
327 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
329 # modify the other koha tables
330 _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
331 _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
335 =head2 ModBiblioframework
337 ModBiblioframework($biblionumber,$frameworkcode);
338 Exported function to modify a biblio framework
342 sub ModBiblioframework {
343 my ( $biblionumber, $frameworkcode ) = @_;
344 my $dbh = C4::Context->dbh;
345 my $sth = $dbh->prepare(
346 "UPDATE biblio SET frameworkcode=? WHERE biblionumber=?"
348 $sth->execute($frameworkcode, $biblionumber);
356 my $error = &DelBiblio($dbh,$biblionumber);
357 Exported function (core API) for deleting a biblio in koha.
358 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
359 Also backs it up to deleted* tables
360 Checks to make sure there are not issues on any of the items
362 C<$error> : undef unless an error occurs
369 my ( $biblionumber ) = @_;
370 my $dbh = C4::Context->dbh;
371 my $error; # for error handling
373 # First make sure this biblio has no items attached
374 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
375 $sth->execute($biblionumber);
376 if (my $itemnumber = $sth->fetchrow){
377 # Fix this to use a status the template can understand
378 $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
381 return $error if $error;
383 # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
384 # for at least 2 reasons :
385 # - we need to read the biblio if NoZebra is set (to remove it from the indexes
386 # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
387 # 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)
389 if (C4::Context->preference("NoZebra")) {
390 # only NoZebra indexing needs to have
391 # the previous version of the record
392 $oldRecord = GetMarcBiblio($biblionumber);
394 ModZebra($biblionumber, "recordDelete", "biblioserver", $oldRecord, undef);
396 # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
399 "SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
400 $sth->execute($biblionumber);
401 while ( my $biblioitemnumber = $sth->fetchrow ) {
403 # delete this biblioitem
404 $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
405 return $error if $error;
408 # delete biblio from Koha tables and save in deletedbiblio
409 # must do this *after* _koha_delete_biblioitems, otherwise
410 # delete cascade will prevent deletedbiblioitems rows
411 # from being generated by _koha_delete_biblioitems
412 $error = _koha_delete_biblio( $dbh, $biblionumber );
414 logaction("CATALOGUING", "DELETE", $biblionumber, "") if C4::Context->preference("CataloguingLog");
419 =head2 LinkBibHeadingsToAuthorities
423 my $headings_linked = LinkBibHeadingsToAuthorities($marc);
427 Links bib headings to authority records by checking
428 each authority-controlled field in the C<MARC::Record>
429 object C<$marc>, looking for a matching authority record,
430 and setting the linking subfield $9 to the ID of that
433 If no matching authority exists, or if multiple
434 authorities match, no $9 will be added, and any
435 existing one inthe field will be deleted.
437 Returns the number of heading links changed in the
442 sub LinkBibHeadingsToAuthorities {
445 my $num_headings_changed = 0;
446 foreach my $field ($bib->fields()) {
447 my $heading = C4::Heading->new_from_bib_field($field);
448 next unless defined $heading;
451 my $current_link = $field->subfield('9');
453 # look for matching authorities
454 my $authorities = $heading->authorities();
456 # want only one exact match
457 if ($#{ $authorities } == 0) {
458 my $authority = MARC::Record->new_from_usmarc($authorities->[0]);
459 my $authid = $authority->field('001')->data();
460 next if defined $current_link and $current_link eq $authid;
462 $field->delete_subfield(code => '9') if defined $current_link;
463 $field->add_subfields('9', $authid);
464 $num_headings_changed++;
466 if (defined $current_link) {
467 $field->delete_subfield(code => '9');
468 $num_headings_changed++;
473 return $num_headings_changed;
480 $data = &GetBiblioData($biblionumber);
481 Returns information about the book with the given biblionumber.
482 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
483 the C<biblio> and C<biblioitems> tables in the
485 In addition, C<$data-E<gt>{subject}> is the list of the book's
486 subjects, separated by C<" , "> (space, comma, space).
487 If there are multiple biblioitems with the given biblionumber, only
488 the first one is considered.
496 my $dbh = C4::Context->dbh;
498 # my $query = C4::Context->preference('item-level_itypes') ?
499 # " SELECT * , biblioitems.notes AS bnotes, biblio.notes
501 # LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
502 # WHERE biblio.biblionumber = ?
503 # AND biblioitems.biblionumber = biblio.biblionumber
506 my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
508 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
509 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
510 WHERE biblio.biblionumber = ?
511 AND biblioitems.biblionumber = biblio.biblionumber ";
513 my $sth = $dbh->prepare($query);
514 $sth->execute($bibnum);
516 $data = $sth->fetchrow_hashref;
520 } # sub GetBiblioData
522 =head2 &GetBiblioItemData
526 $itemdata = &GetBiblioItemData($biblioitemnumber);
528 Looks up the biblioitem with the given biblioitemnumber. Returns a
529 reference-to-hash. The keys are the fields from the C<biblio>,
530 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
531 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
538 sub GetBiblioItemData {
539 my ($biblioitemnumber) = @_;
540 my $dbh = C4::Context->dbh;
541 my $query = "SELECT *,biblioitems.notes AS bnotes
542 FROM biblio LEFT JOIN biblioitems on biblio.biblionumber=biblioitems.biblioitemnumber ";
543 unless(C4::Context->preference('item-level_itypes')) {
544 $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
546 $query .= " WHERE biblioitemnumber = ? ";
547 my $sth = $dbh->prepare($query);
549 $sth->execute($biblioitemnumber);
550 $data = $sth->fetchrow_hashref;
553 } # sub &GetBiblioItemData
555 =head2 GetBiblioItemByBiblioNumber
559 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
565 sub GetBiblioItemByBiblioNumber {
566 my ($biblionumber) = @_;
567 my $dbh = C4::Context->dbh;
568 my $sth = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
572 $sth->execute($biblionumber);
574 while ( my $data = $sth->fetchrow_hashref ) {
575 push @results, $data;
582 =head2 GetBiblioFromItemNumber
586 $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
588 Looks up the item with the given itemnumber. if undef, try the barcode.
590 C<&itemnodata> returns a reference-to-hash whose keys are the fields
591 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
599 sub GetBiblioFromItemNumber {
600 my ( $itemnumber, $barcode ) = @_;
601 my $dbh = C4::Context->dbh;
604 $sth=$dbh->prepare( "SELECT * FROM items
605 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
606 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
607 WHERE items.itemnumber = ?") ;
608 $sth->execute($itemnumber);
610 $sth=$dbh->prepare( "SELECT * FROM items
611 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
612 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
613 WHERE items.barcode = ?") ;
614 $sth->execute($barcode);
616 my $data = $sth->fetchrow_hashref;
625 ( $count, @results ) = &GetBiblio($biblionumber);
632 my ($biblionumber) = @_;
633 my $dbh = C4::Context->dbh;
634 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
637 $sth->execute($biblionumber);
638 while ( my $data = $sth->fetchrow_hashref ) {
639 $results[$count] = $data;
643 return ( $count, @results );
646 =head2 GetBiblioItemInfosOf
650 GetBiblioItemInfosOf(@biblioitemnumbers);
656 sub GetBiblioItemInfosOf {
657 my @biblioitemnumbers = @_;
660 SELECT biblioitemnumber,
664 WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
666 return get_infos_of( $query, 'biblioitemnumber' );
669 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
671 =head2 GetMarcStructure
675 $res = GetMarcStructure($forlibrarian,$frameworkcode);
677 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
678 $forlibrarian :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
679 $frameworkcode : the framework code to read
685 # cache for results of GetMarcStructure -- needed
687 our $marc_structure_cache;
689 sub GetMarcStructure {
690 my ( $forlibrarian, $frameworkcode ) = @_;
691 my $dbh=C4::Context->dbh;
692 $frameworkcode = "" unless $frameworkcode;
694 if (defined $marc_structure_cache and exists $marc_structure_cache->{$forlibrarian}->{$frameworkcode}) {
695 return $marc_structure_cache->{$forlibrarian}->{$frameworkcode};
699 my $libfield = ( $forlibrarian eq 1 ) ? 'liblibrarian' : 'libopac';
701 # check that framework exists
704 "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
705 $sth->execute($frameworkcode);
706 my ($total) = $sth->fetchrow;
707 $frameworkcode = "" unless ( $total > 0 );
710 "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable
711 FROM marc_tag_structure
712 WHERE frameworkcode=?
715 $sth->execute($frameworkcode);
716 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
718 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) =
721 $res->{$tag}->{lib} =
722 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
723 $res->{$tag}->{tab} = "";
724 $res->{$tag}->{mandatory} = $mandatory;
725 $res->{$tag}->{repeatable} = $repeatable;
730 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue
731 FROM marc_subfield_structure
732 WHERE frameworkcode=?
733 ORDER BY tagfield,tagsubfield
737 $sth->execute($frameworkcode);
740 my $authorised_value;
752 $tag, $subfield, $liblibrarian,
754 $mandatory, $repeatable, $authorised_value,
755 $authtypecode, $value_builder, $kohafield,
756 $seealso, $hidden, $isurl,
762 $res->{$tag}->{$subfield}->{lib} =
763 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
764 $res->{$tag}->{$subfield}->{tab} = $tab;
765 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
766 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
767 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
768 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
769 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
770 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
771 $res->{$tag}->{$subfield}->{seealso} = $seealso;
772 $res->{$tag}->{$subfield}->{hidden} = $hidden;
773 $res->{$tag}->{$subfield}->{isurl} = $isurl;
774 $res->{$tag}->{$subfield}->{'link'} = $link;
775 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
778 $marc_structure_cache->{$forlibrarian}->{$frameworkcode} = $res;
783 =head2 GetUsedMarcStructure
785 the same function as GetMarcStructure expcet it just take field
786 in tab 0-9. (used field)
788 my $results = GetUsedMarcStructure($frameworkcode);
790 L<$results> is a ref to an array which each case containts a ref
791 to a hash which each keys is the columns from marc_subfield_structure
793 L<$frameworkcode> is the framework code.
797 sub GetUsedMarcStructure($){
798 my $frameworkcode = shift || '';
799 my $dbh = C4::Context->dbh;
802 FROM marc_subfield_structure
804 AND frameworkcode = ?
807 my $sth = $dbh->prepare($query);
808 $sth->execute($frameworkcode);
809 while (my $row = $sth->fetchrow_hashref){
815 =head2 GetMarcFromKohaField
819 ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
820 Returns the MARC fields & subfields mapped to the koha field
821 for the given frameworkcode
827 sub GetMarcFromKohaField {
828 my ( $kohafield, $frameworkcode ) = @_;
829 return 0, 0 unless $kohafield;
830 my $relations = C4::Context->marcfromkohafield;
832 $relations->{$frameworkcode}->{$kohafield}->[0],
833 $relations->{$frameworkcode}->{$kohafield}->[1]
841 my $record = GetMarcBiblio($biblionumber);
845 Returns MARC::Record representing bib identified by
846 C<$biblionumber>. If no bib exists, returns undef.
847 The MARC record contains both biblio & item data.
852 my $biblionumber = shift;
853 my $dbh = C4::Context->dbh;
855 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
856 $sth->execute($biblionumber);
857 my $row = $sth->fetchrow_hashref;
858 my $marcxml = StripNonXmlChars($row->{'marcxml'});
859 MARC::File::XML->default_record_format(C4::Context->preference('marcflavour'));
860 my $record = MARC::Record->new();
862 $record = eval {MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour'))};
863 if ($@) {warn " problem with :$biblionumber : $@ \n$marcxml";}
864 # $record = MARC::Record::new_from_usmarc( $marc) if $marc;
875 my $marcxml = GetXmlBiblio($biblionumber);
877 Returns biblioitems.marcxml of the biblionumber passed in parameter.
878 The XML contains both biblio & item datas
885 my ( $biblionumber ) = @_;
886 my $dbh = C4::Context->dbh;
888 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
889 $sth->execute($biblionumber);
890 my ($marcxml) = $sth->fetchrow;
894 =head2 GetAuthorisedValueDesc
898 my $subfieldvalue =get_authorised_value_desc(
899 $tag, $subf[$i][0],$subf[$i][1], '', $taglib, $category);
900 Retrieve the complete description for a given authorised value.
902 Now takes $category and $value pair too.
903 my $auth_value_desc =GetAuthorisedValueDesc(
904 '','', 'DVD' ,'','','CCODE');
910 sub GetAuthorisedValueDesc {
911 my ( $tag, $subfield, $value, $framework, $tagslib, $category ) = @_;
912 my $dbh = C4::Context->dbh;
916 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
917 return C4::Branch::GetBranchName($value);
921 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
922 return getitemtypeinfo($value)->{description};
925 #---- "true" authorized value
926 $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'}
929 if ( $category ne "" ) {
932 "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
934 $sth->execute( $category, $value );
935 my $data = $sth->fetchrow_hashref;
936 return $data->{'lib'};
939 return $value; # if nothing is found return the original value
947 $marcnotesarray = GetMarcNotes( $record, $marcflavour );
948 Get all notes from the MARC record and returns them in an array.
949 The note are stored in differents places depending on MARC flavour
956 my ( $record, $marcflavour ) = @_;
958 if ( $marcflavour eq "MARC21" ) {
961 else { # assume unimarc if not marc21
968 foreach my $field ( $record->field($scope) ) {
969 my $value = $field->as_string();
971 $marcnote = { marcnote => $note, };
972 push @marcnotes, $marcnote;
975 if ( $note ne $value ) {
976 $note = $note . " " . $value;
981 $marcnote = { marcnote => $note };
982 push @marcnotes, $marcnote; #load last tag into array
987 =head2 GetMarcSubjects
991 $marcsubjcts = GetMarcSubjects($record,$marcflavour);
992 Get all subjects from the MARC record and returns them in an array.
993 The subjects are stored in differents places depending on MARC flavour
999 sub GetMarcSubjects {
1000 my ( $record, $marcflavour ) = @_;
1001 my ( $mintag, $maxtag );
1002 if ( $marcflavour eq "MARC21" ) {
1006 else { # assume unimarc if not marc21
1016 foreach my $field ( $record->field('6..' )) {
1017 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1019 my @subfields = $field->subfields();
1022 # if there is an authority link, build the link with an= subfield9
1023 my $subfield9 = $field->subfield('9');
1024 for my $subject_subfield (@subfields ) {
1025 # don't load unimarc subfields 3,4,5
1026 next if (($marcflavour eq "UNIMARC") and ($subject_subfield->[0] =~ /3|4|5/ ) );
1027 my $code = $subject_subfield->[0];
1028 my $value = $subject_subfield->[1];
1029 my $linkvalue = $value;
1030 $linkvalue =~ s/(\(|\))//g;
1031 my $operator = " and " unless $counter==0;
1033 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1035 push @link_loop, {'limit' => 'su', link => $linkvalue, operator => $operator };
1037 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1039 my @this_link_loop = @link_loop;
1040 push @subfields_loop, {code => $code, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($subject_subfield->[0] eq 9 );
1044 push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1047 return \@marcsubjects;
1048 } #end getMARCsubjects
1050 =head2 GetMarcAuthors
1054 authors = GetMarcAuthors($record,$marcflavour);
1055 Get all authors from the MARC record and returns them in an array.
1056 The authors are stored in differents places depending on MARC flavour
1062 sub GetMarcAuthors {
1063 my ( $record, $marcflavour ) = @_;
1064 my ( $mintag, $maxtag );
1065 # tagslib useful for UNIMARC author reponsabilities
1066 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.
1067 if ( $marcflavour eq "MARC21" ) {
1071 elsif ( $marcflavour eq "UNIMARC" ) { # assume unimarc if not marc21
1080 foreach my $field ( $record->fields ) {
1081 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1084 my @subfields = $field->subfields();
1086 # if there is an authority link, build the link with Koha-Auth-Number: subfield9
1087 my $subfield9 = $field->subfield('9');
1088 for my $authors_subfield (@subfields) {
1089 # don't load unimarc subfields 3, 5
1090 next if ($marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~ /3|5/ ) );
1091 my $subfieldcode = $authors_subfield->[0];
1092 my $value = $authors_subfield->[1];
1093 my $linkvalue = $value;
1094 $linkvalue =~ s/(\(|\))//g;
1095 my $operator = " and " unless $count_auth==0;
1096 # if we have an authority link, use that as the link, otherwise use standard searching
1098 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1101 # reset $linkvalue if UNIMARC author responsibility
1102 if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] eq "4")) {
1103 $linkvalue = "(".GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ).")";
1105 push @link_loop, {'limit' => 'au', link => $linkvalue, operator => $operator };
1107 $value = GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ) if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~/4/));
1108 my @this_link_loop = @link_loop;
1109 my $separator = C4::Context->preference("authoritysep") unless $count_auth==0;
1110 push @subfields_loop, {code => $subfieldcode, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($authors_subfield->[0] == 9 );
1113 push @marcauthors, { MARCAUTHOR_SUBFIELDS_LOOP => \@subfields_loop };
1115 return \@marcauthors;
1122 $marcurls = GetMarcUrls($record,$marcflavour);
1123 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1124 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1131 my ($record, $marcflavour) = @_;
1134 for my $field ($record->field('856')) {
1135 my $url = $field->subfield('u');
1137 for my $note ( $field->subfield('z')) {
1138 push @notes , {note => $note};
1140 if($marcflavour eq 'MARC21') {
1141 my $s3 = $field->subfield('3');
1142 my $link = $field->subfield('y');
1143 unless($url =~ /^\w+:/) {
1144 if($field->indicator(1) eq '7') {
1145 $url = $field->subfield('2') . "://" . $url;
1146 } elsif ($field->indicator(1) eq '1') {
1147 $url = 'ftp://' . $url;
1149 # properly, this should be if ind1=4,
1150 # however we will assume http protocol since we're building a link.
1151 $url = 'http://' . $url;
1154 # TODO handle ind 2 (relationship)
1155 $marcurl = { MARCURL => $url,
1158 $marcurl->{'linktext'} = $link || $s3 || C4::Context->preference('URLLinkText') || $url ;;
1159 $marcurl->{'part'} = $s3 if($link);
1160 $marcurl->{'toc'} = 1 if($s3 =~ /^[Tt]able/) ;
1162 $marcurl->{'linktext'} = $url || C4::Context->preference('URLLinkText') ;
1164 push @marcurls, $marcurl;
1169 =head2 GetMarcSeries
1173 $marcseriesarray = GetMarcSeries($record,$marcflavour);
1174 Get all series from the MARC record and returns them in an array.
1175 The series are stored in differents places depending on MARC flavour
1182 my ($record, $marcflavour) = @_;
1183 my ($mintag, $maxtag);
1184 if ($marcflavour eq "MARC21") {
1187 } else { # assume unimarc if not marc21
1197 foreach my $field ($record->field('440'), $record->field('490')) {
1199 #my $value = $field->subfield('a');
1200 #$marcsubjct = {MARCSUBJCT => $value,};
1201 my @subfields = $field->subfields();
1202 #warn "subfields:".join " ", @$subfields;
1205 for my $series_subfield (@subfields) {
1207 undef $volume_number;
1208 # see if this is an instance of a volume
1209 if ($series_subfield->[0] eq 'v') {
1213 my $code = $series_subfield->[0];
1214 my $value = $series_subfield->[1];
1215 my $linkvalue = $value;
1216 $linkvalue =~ s/(\(|\))//g;
1217 my $operator = " and " unless $counter==0;
1218 push @link_loop, {link => $linkvalue, operator => $operator };
1219 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1220 if ($volume_number) {
1221 push @subfields_loop, {volumenum => $value};
1224 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number};
1228 push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
1229 #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
1230 #push @marcsubjcts, $marcsubjct;
1234 my $marcseriessarray=\@marcseries;
1235 return $marcseriessarray;
1236 } #end getMARCseriess
1238 =head2 GetFrameworkCode
1242 $frameworkcode = GetFrameworkCode( $biblionumber )
1248 sub GetFrameworkCode {
1249 my ( $biblionumber ) = @_;
1250 my $dbh = C4::Context->dbh;
1251 my $sth = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
1252 $sth->execute($biblionumber);
1253 my ($frameworkcode) = $sth->fetchrow;
1254 return $frameworkcode;
1257 =head2 GetPublisherNameFromIsbn
1259 $name = GetPublishercodeFromIsbn($isbn);
1266 sub GetPublisherNameFromIsbn($){
1268 $isbn =~ s/[- _]//g;
1270 my @codes = (split '-', DisplayISBN($isbn));
1271 my $code = $codes[0].$codes[1].$codes[2];
1272 my $dbh = C4::Context->dbh;
1274 SELECT distinct publishercode
1277 AND publishercode IS NOT NULL
1280 my $sth = $dbh->prepare($query);
1281 $sth->execute("$code%");
1282 my $name = $sth->fetchrow;
1283 return $name if length $name;
1287 =head2 TransformKohaToMarc
1291 $record = TransformKohaToMarc( $hash )
1292 This function builds partial MARC::Record from a hash
1293 Hash entries can be from biblio or biblioitems.
1294 This function is called in acquisition module, to create a basic catalogue entry from user entry
1300 sub TransformKohaToMarc {
1303 my $dbh = C4::Context->dbh;
1306 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1308 my $record = MARC::Record->new();
1309 foreach (keys %{$hash}) {
1310 &TransformKohaToMarcOneField( $sth, $record, $_,
1316 =head2 TransformKohaToMarcOneField
1320 $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
1326 sub TransformKohaToMarcOneField {
1327 my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
1328 $frameworkcode='' unless $frameworkcode;
1332 if ( !defined $sth ) {
1333 my $dbh = C4::Context->dbh;
1334 $sth = $dbh->prepare(
1335 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1338 $sth->execute( $frameworkcode, $kohafieldname );
1339 if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
1340 my $tag = $record->field($tagfield);
1342 $tag->update( $tagsubfield => $value );
1343 $record->delete_field($tag);
1344 $record->insert_fields_ordered($tag);
1347 $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
1353 =head2 TransformHtmlToXml
1357 $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type )
1359 $auth_type contains :
1360 - nothing : rebuild a biblio, un UNIMARC the encoding is in 100$a pos 26/27
1361 - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
1362 - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
1368 sub TransformHtmlToXml {
1369 my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
1370 my $xml = MARC::File::XML::header('UTF-8');
1371 $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
1372 MARC::File::XML->default_record_format($auth_type);
1373 # in UNIMARC, field 100 contains the encoding
1374 # check that there is one, otherwise the
1375 # MARC::Record->new_from_xml will fail (and Koha will die)
1376 my $unimarc_and_100_exist=0;
1377 $unimarc_and_100_exist=1 if $auth_type eq 'ITEM'; # if we rebuild an item, no need of a 100 field
1382 for ( my $i = 0 ; $i <= @$tags ; $i++ ) {
1383 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a") {
1384 # if we have a 100 field and it's values are not correct, skip them.
1385 # if we don't have any valid 100 field, we will create a default one at the end
1386 my $enc = substr( @$values[$i], 26, 2 );
1387 if ($enc eq '01' or $enc eq '50' or $enc eq '03') {
1388 $unimarc_and_100_exist=1;
1393 @$values[$i] =~ s/&/&/g;
1394 @$values[$i] =~ s/</</g;
1395 @$values[$i] =~ s/>/>/g;
1396 @$values[$i] =~ s/"/"/g;
1397 @$values[$i] =~ s/'/'/g;
1398 # if ( !utf8::is_utf8( @$values[$i] ) ) {
1399 # utf8::decode( @$values[$i] );
1401 if ( ( @$tags[$i] ne $prevtag ) ) {
1402 $j++ unless ( @$tags[$i] eq "" );
1404 $xml .= "</datafield>\n";
1405 if ( ( @$tags[$i] && @$tags[$i] > 10 )
1406 && ( @$values[$i] ne "" ) )
1408 my $ind1 = substr( @$indicator[$j], 0, 1 );
1410 if ( @$indicator[$j] ) {
1411 $ind2 = substr( @$indicator[$j], 1, 1 );
1414 warn "Indicator in @$tags[$i] is empty";
1418 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1420 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1428 if ( @$values[$i] ne "" ) {
1431 if ( @$tags[$i] eq "000" ) {
1432 $xml .= "<leader>@$values[$i]</leader>\n";
1435 # rest of the fixed fields
1437 elsif ( @$tags[$i] < 10 ) {
1439 "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
1443 my $ind1 = substr( @$indicator[$j], 0, 1 );
1444 my $ind2 = substr( @$indicator[$j], 1, 1 );
1446 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1448 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1454 else { # @$tags[$i] eq $prevtag
1455 if ( @$values[$i] eq "" ) {
1459 my $ind1 = substr( @$indicator[$j], 0, 1 );
1460 my $ind2 = substr( @$indicator[$j], 1, 1 );
1462 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1466 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1469 $prevtag = @$tags[$i];
1471 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and !$unimarc_and_100_exist) {
1472 # warn "SETTING 100 for $auth_type";
1473 use POSIX qw(strftime);
1474 my $string = strftime( "%Y%m%d", localtime(time) );
1475 # set 50 to position 26 is biblios, 13 if authorities
1477 $pos=13 if $auth_type eq 'UNIMARCAUTH';
1478 $string = sprintf( "%-*s", 35, $string );
1479 substr( $string, $pos , 6, "50" );
1480 $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
1481 $xml .= "<subfield code=\"a\">$string</subfield>\n";
1482 $xml .= "</datafield>\n";
1484 $xml .= MARC::File::XML::footer();
1488 =head2 TransformHtmlToMarc
1490 L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
1491 L<$params> is a ref to an array as below:
1493 'tag_010_indicator1_531951' ,
1494 'tag_010_indicator2_531951' ,
1495 'tag_010_code_a_531951_145735' ,
1496 'tag_010_subfield_a_531951_145735' ,
1497 'tag_200_indicator1_873510' ,
1498 'tag_200_indicator2_873510' ,
1499 'tag_200_code_a_873510_673465' ,
1500 'tag_200_subfield_a_873510_673465' ,
1501 'tag_200_code_b_873510_704318' ,
1502 'tag_200_subfield_b_873510_704318' ,
1503 'tag_200_code_e_873510_280822' ,
1504 'tag_200_subfield_e_873510_280822' ,
1505 'tag_200_code_f_873510_110730' ,
1506 'tag_200_subfield_f_873510_110730' ,
1508 L<$cgi> is the CGI object which containts the value.
1509 L<$record> is the MARC::Record object.
1513 sub TransformHtmlToMarc {
1517 # explicitly turn on the UTF-8 flag for all
1518 # 'tag_' parameters to avoid incorrect character
1519 # conversion later on
1520 my $cgi_params = $cgi->Vars;
1521 foreach my $param_name (keys %$cgi_params) {
1522 if ($param_name =~ /^tag_/) {
1523 my $param_value = $cgi_params->{$param_name};
1524 if (utf8::decode($param_value)) {
1525 $cgi_params->{$param_name} = $param_value;
1527 # FIXME - need to do something if string is not valid UTF-8
1531 # creating a new record
1532 my $record = MARC::Record->new();
1535 while ($params->[$i]){ # browse all CGI params
1536 my $param = $params->[$i];
1538 # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
1539 if ($param eq 'biblionumber') {
1540 my ( $biblionumbertagfield, $biblionumbertagsubfield ) =
1541 &GetMarcFromKohaField( "biblio.biblionumber", '' );
1542 if ($biblionumbertagfield < 10) {
1543 $newfield = MARC::Field->new(
1544 $biblionumbertagfield,
1545 $cgi->param($param),
1548 $newfield = MARC::Field->new(
1549 $biblionumbertagfield,
1552 "$biblionumbertagsubfield" => $cgi->param($param),
1555 push @fields,$newfield if($newfield);
1557 elsif ($param =~ /^tag_(\d*)_indicator1_/){ # new field start when having 'input name="..._indicator1_..."
1560 my $ind1 = substr($cgi->param($param),0,1);
1561 my $ind2 = substr($cgi->param($params->[$i+1]),0,1);
1565 if($tag < 10){ # no code for theses fields
1566 # in MARC editor, 000 contains the leader.
1567 if ($tag eq '000' ) {
1568 $record->leader($cgi->param($params->[$j+1])) if length($cgi->param($params->[$j+1]))==24;
1569 # between 001 and 009 (included)
1570 } elsif ($cgi->param($params->[$j+1]) ne '') {
1571 $newfield = MARC::Field->new(
1573 $cgi->param($params->[$j+1]),
1576 # > 009, deal with subfields
1578 while($params->[$j] =~ /_code_/){ # browse all it's subfield
1579 my $inner_param = $params->[$j];
1581 if($cgi->param($params->[$j+1]) ne ''){ # only if there is a value (code => value)
1582 $newfield->add_subfields(
1583 $cgi->param($inner_param) => $cgi->param($params->[$j+1])
1587 if ( $cgi->param($params->[$j+1]) ne '' ) { # creating only if there is a value (code => value)
1588 $newfield = MARC::Field->new(
1592 $cgi->param($inner_param) => $cgi->param($params->[$j+1]),
1599 push @fields,$newfield if($newfield);
1604 $record->append_fields(@fields);
1608 # cache inverted MARC field map
1609 our $inverted_field_map;
1611 =head2 TransformMarcToKoha
1615 $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
1619 Extract data from a MARC bib record into a hashref representing
1620 Koha biblio, biblioitems, and items fields.
1623 sub TransformMarcToKoha {
1624 my ( $dbh, $record, $frameworkcode, $limit_table ) = @_;
1628 unless (defined $inverted_field_map) {
1629 $inverted_field_map = _get_inverted_marc_field_map();
1633 if ($limit_table eq 'items') {
1634 $tables{'items'} = 1;
1636 $tables{'items'} = 1;
1637 $tables{'biblio'} = 1;
1638 $tables{'biblioitems'} = 1;
1641 # traverse through record
1642 MARCFIELD: foreach my $field ($record->fields()) {
1643 my $tag = $field->tag();
1644 next MARCFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag};
1645 if ($field->is_control_field()) {
1646 my $kohafields = $inverted_field_map->{$frameworkcode}->{$tag}->{list};
1647 ENTRY: foreach my $entry (@{ $kohafields }) {
1648 my ($subfield, $table, $column) = @{ $entry };
1649 next ENTRY unless exists $tables{$table};
1650 my $key = _disambiguate($table, $column);
1651 if ($result->{$key}) {
1652 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($field->data() eq "")) {
1653 $result->{$key} .= " | " . $field->data();
1656 $result->{$key} = $field->data();
1660 # deal with subfields
1661 MARCSUBFIELD: foreach my $sf ($field->subfields()) {
1662 my $code = $sf->[0];
1663 next MARCSUBFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code};
1664 my $value = $sf->[1];
1665 SFENTRY: foreach my $entry (@{ $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code} }) {
1666 my ($table, $column) = @{ $entry };
1667 next SFENTRY unless exists $tables{$table};
1668 my $key = _disambiguate($table, $column);
1669 if ($result->{$key}) {
1670 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($value eq "")) {
1671 $result->{$key} .= " | " . $value;
1674 $result->{$key} = $value;
1681 # modify copyrightdate to keep only the 1st year found
1682 if (exists $result->{'copyrightdate'}) {
1683 my $temp = $result->{'copyrightdate'};
1684 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
1686 $result->{'copyrightdate'} = $1;
1688 else { # if no cYYYY, get the 1st date.
1689 $temp =~ m/(\d\d\d\d)/;
1690 $result->{'copyrightdate'} = $1;
1694 # modify publicationyear to keep only the 1st year found
1695 if (exists $result->{'publicationyear'}) {
1696 my $temp = $result->{'publicationyear'};
1697 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
1699 $result->{'publicationyear'} = $1;
1701 else { # if no cYYYY, get the 1st date.
1702 $temp =~ m/(\d\d\d\d)/;
1703 $result->{'publicationyear'} = $1;
1710 sub _get_inverted_marc_field_map {
1712 my $relations = C4::Context->marcfromkohafield;
1714 foreach my $frameworkcode (keys %{ $relations }) {
1715 foreach my $kohafield (keys %{ $relations->{$frameworkcode} }) {
1716 my $tag = $relations->{$frameworkcode}->{$kohafield}->[0];
1717 my $subfield = $relations->{$frameworkcode}->{$kohafield}->[1];
1718 my ($table, $column) = split /[.]/, $kohafield, 2;
1719 push @{ $field_map->{$frameworkcode}->{$tag}->{list} }, [ $subfield, $table, $column ];
1720 push @{ $field_map->{$frameworkcode}->{$tag}->{sfs}->{$subfield} }, [ $table, $column ];
1726 =head2 _disambiguate
1730 $newkey = _disambiguate($table, $field);
1732 This is a temporary hack to distinguish between the
1733 following sets of columns when using TransformMarcToKoha.
1735 items.cn_source & biblioitems.cn_source
1736 items.cn_sort & biblioitems.cn_sort
1738 Columns that are currently NOT distinguished (FIXME
1739 due to lack of time to fully test) are:
1741 biblio.notes and biblioitems.notes
1746 FIXME - this is necessary because prefixing each column
1747 name with the table name would require changing lots
1748 of code and templates, and exposing more of the DB
1749 structure than is good to the UI templates, particularly
1750 since biblio and bibloitems may well merge in a future
1751 version. In the future, it would also be good to
1752 separate DB access and UI presentation field names
1760 my ($table, $column) = @_;
1761 if ($column eq "cn_sort" or $column eq "cn_source") {
1762 return $table . '.' . $column;
1769 =head2 get_koha_field_from_marc
1773 $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
1775 Internal function to map data from the MARC record to a specific non-MARC field.
1776 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
1782 sub get_koha_field_from_marc {
1783 my ($koha_table,$koha_column,$record,$frameworkcode) = @_;
1784 my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table.'.'.$koha_column, $frameworkcode );
1786 foreach my $field ( $record->field($tagfield) ) {
1787 if ( $field->tag() < 10 ) {
1789 $kohafield .= " | " . $field->data();
1792 $kohafield = $field->data();
1796 if ( $field->subfields ) {
1797 my @subfields = $field->subfields();
1798 foreach my $subfieldcount ( 0 .. $#subfields ) {
1799 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1802 " | " . $subfields[$subfieldcount][1];
1806 $subfields[$subfieldcount][1];
1817 =head2 TransformMarcToKohaOneField
1821 $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
1827 sub TransformMarcToKohaOneField {
1829 # FIXME ? if a field has a repeatable subfield that is used in old-db,
1830 # only the 1st will be retrieved...
1831 my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
1833 my ( $tagfield, $subfield ) =
1834 GetMarcFromKohaField( $kohatable . "." . $kohafield,
1836 foreach my $field ( $record->field($tagfield) ) {
1837 if ( $field->tag() < 10 ) {
1838 if ( $result->{$kohafield} ) {
1839 $result->{$kohafield} .= " | " . $field->data();
1842 $result->{$kohafield} = $field->data();
1846 if ( $field->subfields ) {
1847 my @subfields = $field->subfields();
1848 foreach my $subfieldcount ( 0 .. $#subfields ) {
1849 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1850 if ( $result->{$kohafield} ) {
1851 $result->{$kohafield} .=
1852 " | " . $subfields[$subfieldcount][1];
1855 $result->{$kohafield} =
1856 $subfields[$subfieldcount][1];
1866 =head1 OTHER FUNCTIONS
1869 =head2 PrepareItemrecordDisplay
1873 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber);
1875 Returns a hash with all the fields for Display a given item data in a template
1881 sub PrepareItemrecordDisplay {
1883 my ( $bibnum, $itemnum, $defaultvalues ) = @_;
1885 my $dbh = C4::Context->dbh;
1886 my $frameworkcode = &GetFrameworkCode( $bibnum );
1887 my ( $itemtagfield, $itemtagsubfield ) =
1888 &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
1889 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
1890 my $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum) if ($itemnum);
1892 my $authorised_values_sth =
1894 "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib"
1896 foreach my $tag ( sort keys %{$tagslib} ) {
1897 my $previous_tag = '';
1899 # loop through each subfield
1901 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
1902 next if ( subfield_is_koha_internal_p($subfield) );
1903 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
1905 $subfield_data{tag} = $tag;
1906 $subfield_data{subfield} = $subfield;
1907 $subfield_data{countsubfield} = $cntsubf++;
1908 $subfield_data{kohafield} =
1909 $tagslib->{$tag}->{$subfield}->{'kohafield'};
1911 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
1912 $subfield_data{marc_lib} = $tagslib->{$tag}->{$subfield}->{lib};
1913 $subfield_data{mandatory} =
1914 $tagslib->{$tag}->{$subfield}->{mandatory};
1915 $subfield_data{repeatable} =
1916 $tagslib->{$tag}->{$subfield}->{repeatable};
1917 $subfield_data{hidden} = "display:none"
1918 if $tagslib->{$tag}->{$subfield}->{hidden};
1920 ( $x, $value ) = _find_value( $tag, $subfield, $itemrecord )
1922 $value =~ s/"/"/g;
1924 # search for itemcallnumber if applicable
1925 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
1926 'items.itemcallnumber'
1927 && C4::Context->preference('itemcallnumber') )
1930 substr( C4::Context->preference('itemcallnumber'), 0, 3 );
1932 substr( C4::Context->preference('itemcallnumber'), 3, 1 );
1933 my $temp = $itemrecord->field($CNtag) if ($itemrecord);
1935 $value = $temp->subfield($CNsubfield);
1938 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
1939 'items.itemcallnumber'
1940 && $defaultvalues->{'callnumber'} )
1942 my $temp = $itemrecord->field($subfield) if ($itemrecord);
1944 $value = $defaultvalues->{'callnumber'};
1947 if ( ($tagslib->{$tag}->{$subfield}->{kohafield} eq
1948 'items.holdingbranch' ||
1949 $tagslib->{$tag}->{$subfield}->{kohafield} eq
1951 && $defaultvalues->{'branchcode'} )
1953 my $temp = $itemrecord->field($subfield) if ($itemrecord);
1955 $value = $defaultvalues->{branchcode};
1958 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
1959 my @authorised_values;
1962 # builds list, depending on authorised value...
1964 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq
1967 if ( ( C4::Context->preference("IndependantBranches") )
1968 && ( C4::Context->userenv->{flags} != 1 ) )
1972 "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname"
1974 $sth->execute( C4::Context->userenv->{branch} );
1975 push @authorised_values, ""
1977 $tagslib->{$tag}->{$subfield}->{mandatory} );
1978 while ( my ( $branchcode, $branchname ) =
1979 $sth->fetchrow_array )
1981 push @authorised_values, $branchcode;
1982 $authorised_lib{$branchcode} = $branchname;
1988 "SELECT branchcode,branchname FROM branches ORDER BY branchname"
1991 push @authorised_values, ""
1993 $tagslib->{$tag}->{$subfield}->{mandatory} );
1994 while ( my ( $branchcode, $branchname ) =
1995 $sth->fetchrow_array )
1997 push @authorised_values, $branchcode;
1998 $authorised_lib{$branchcode} = $branchname;
2004 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq
2009 "SELECT itemtype,description FROM itemtypes ORDER BY description"
2012 push @authorised_values, ""
2013 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2014 while ( my ( $itemtype, $description ) =
2015 $sth->fetchrow_array )
2017 push @authorised_values, $itemtype;
2018 $authorised_lib{$itemtype} = $description;
2021 #---- "true" authorised value
2024 $authorised_values_sth->execute(
2025 $tagslib->{$tag}->{$subfield}->{authorised_value} );
2026 push @authorised_values, ""
2027 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2028 while ( my ( $value, $lib ) =
2029 $authorised_values_sth->fetchrow_array )
2031 push @authorised_values, $value;
2032 $authorised_lib{$value} = $lib;
2035 $subfield_data{marc_value} = CGI::scrolling_list(
2036 -name => 'field_value',
2037 -values => \@authorised_values,
2038 -default => "$value",
2039 -labels => \%authorised_lib,
2045 elsif ( $tagslib->{$tag}->{$subfield}->{thesaurus_category} ) {
2046 $subfield_data{marc_value} =
2047 "<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>";
2050 # COMMENTED OUT because No $i is provided with this API.
2051 # And thus, no value_builder can be activated.
2052 # BUT could be thought over.
2053 # } elsif ($tagslib->{$tag}->{$subfield}->{'value_builder'}) {
2054 # my $plugin="value_builder/".$tagslib->{$tag}->{$subfield}->{'value_builder'};
2056 # my $extended_param = plugin_parameters($dbh,$itemrecord,$tagslib,$i,0);
2057 # my ($function_name,$javascript) = plugin_javascript($dbh,$record,$tagslib,$i,0);
2058 # $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";
2061 $subfield_data{marc_value} =
2062 "<input type=\"text\" name=\"field_value\" value=\"$value\" size=\"50\" maxlength=\"255\" />";
2064 push( @loop_data, \%subfield_data );
2068 my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
2069 if ( $itemrecord && $itemrecord->field($itemtagfield) );
2071 'itemtagfield' => $itemtagfield,
2072 'itemtagsubfield' => $itemtagsubfield,
2073 'itemnumber' => $itemnumber,
2074 'iteminformation' => \@loop_data
2080 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2082 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2083 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2084 # =head2 ModZebrafiles
2086 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
2090 # sub ModZebrafiles {
2092 # my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
2096 # C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
2097 # unless ( opendir( DIR, "$zebradir" ) ) {
2098 # warn "$zebradir not found";
2102 # my $filename = $zebradir . $biblionumber;
2105 # open( OUTPUT, ">", $filename . ".xml" );
2106 # print OUTPUT $record;
2115 ModZebra( $biblionumber, $op, $server, $oldRecord, $newRecord );
2117 $biblionumber is the biblionumber we want to index
2118 $op is specialUpdate or delete, and is used to know what we want to do
2119 $server is the server that we want to update
2120 $oldRecord is the MARC::Record containing the previous version of the record. This is used only when
2121 NoZebra=1, as NoZebra indexing needs to know the previous version of a record in order to
2123 $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.
2130 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
2131 my ( $biblionumber, $op, $server, $oldRecord, $newRecord ) = @_;
2132 my $dbh=C4::Context->dbh;
2134 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2136 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2137 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2139 if (C4::Context->preference("NoZebra")) {
2140 # lock the nozebra table : we will read index lines, update them in Perl process
2141 # and write everything in 1 transaction.
2142 # lock the table to avoid someone else overwriting what we are doing
2143 $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE, auth_subfield_structure READ');
2144 my %result; # the result hash that will be built by deletion / add, and written on mySQL at the end, to improve speed
2145 if ($op eq 'specialUpdate') {
2146 # OK, we have to add or update the record
2147 # 1st delete (virtually, in indexes), if record actually exists
2149 %result = _DelBiblioNoZebra($biblionumber,$oldRecord,$server);
2151 # ... add the record
2152 %result=_AddBiblioNoZebra($biblionumber,$newRecord, $server, %result);
2154 # it's a deletion, delete the record...
2155 # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
2156 %result=_DelBiblioNoZebra($biblionumber,$oldRecord,$server);
2158 # ok, now update the database...
2159 my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
2160 foreach my $key (keys %result) {
2161 foreach my $index (keys %{$result{$key}}) {
2162 $sth->execute($result{$key}->{$index}, $server, $key, $index);
2165 $dbh->do('UNLOCK TABLES');
2168 # we use zebra, just fill zebraqueue table
2170 my $check_sql = "SELECT COUNT(*) FROM zebraqueue
2172 AND biblio_auth_number = ?
2175 my $check_sth = $dbh->prepare_cached($check_sql);
2176 $check_sth->execute($server, $biblionumber, $op);
2177 my ($count) = $check_sth->fetchrow_array;
2178 $check_sth->finish();
2180 my $sth=$dbh->prepare("INSERT INTO zebraqueue (biblio_auth_number,server,operation) VALUES(?,?,?)");
2181 $sth->execute($biblionumber,$server,$op);
2187 =head2 GetNoZebraIndexes
2189 %indexes = GetNoZebraIndexes;
2191 return the data from NoZebraIndexes syspref.
2195 sub GetNoZebraIndexes {
2196 my $index = C4::Context->preference('NoZebraIndexes');
2198 foreach my $line (split /('|"),/,$index) {
2199 $line =~ /(.*)=>(.*)/;
2200 my $index = substr($1,1); # get the index, don't forget to remove initial ' or "
2202 $index =~ s/'|"|\s//g;
2205 $fields =~ s/'|"|\s//g;
2206 $indexes{$index}=$fields;
2211 =head1 INTERNAL FUNCTIONS
2213 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
2215 function to delete a biblio in NoZebra indexes
2216 This function does NOT delete anything in database : it reads all the indexes entries
2217 that have to be deleted & delete them in the hash
2218 The SQL part is done either :
2219 - after the Add if we are modifying a biblio (delete + add again)
2220 - immediatly after this sub if we are doing a true deletion.
2221 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
2226 sub _DelBiblioNoZebra {
2227 my ($biblionumber, $record, $server)=@_;
2230 my $dbh = C4::Context->dbh;
2234 if ($server eq 'biblioserver') {
2235 %index=GetNoZebraIndexes;
2236 # get title of the record (to store the 10 first letters with the index)
2237 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
2238 $title = lc($record->subfield($titletag,$titlesubfield));
2240 # for authorities, the "title" is the $a mainentry
2241 my ($auth_type_tag, $auth_type_sf) = C4::AuthoritiesMarc::get_auth_type_location();
2242 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield($auth_type_tag, $auth_type_sf));
2243 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2244 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2245 $index{'mainmainentry'}= $authref->{'auth_tag_to_report'}.'a';
2246 $index{'mainentry'} = $authref->{'auth_tag_to_report'}.'*';
2247 $index{'auth_type'} = "${auth_type_tag}${auth_type_sf}";
2251 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2252 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
2253 # limit to 10 char, should be enough, and limit the DB size
2254 $title = substr($title,0,10);
2256 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2257 foreach my $field ($record->fields()) {
2258 #parse each subfield
2259 next if $field->tag <10;
2260 foreach my $subfield ($field->subfields()) {
2261 my $tag = $field->tag();
2262 my $subfieldcode = $subfield->[0];
2264 # check each index to see if the subfield is stored somewhere
2265 # otherwise, store it in __RAW__ index
2266 foreach my $key (keys %index) {
2267 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2268 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2270 my $line= lc $subfield->[1];
2271 # remove meaningless value in the field...
2272 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2273 # ... and split in words
2274 foreach (split / /,$line) {
2275 next unless $_; # skip empty values (multiple spaces)
2276 # if the entry is already here, do nothing, the biblionumber has already be removed
2277 unless ($result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2278 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2279 $sth2->execute($server,$key,$_);
2280 my $existing_biblionumbers = $sth2->fetchrow;
2282 if ($existing_biblionumbers) {
2283 # warn " existing for $key $_: $existing_biblionumbers";
2284 $result{$key}->{$_} =$existing_biblionumbers;
2285 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2291 # the subfield is not indexed, store it in __RAW__ index anyway
2293 my $line= lc $subfield->[1];
2294 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2295 # ... and split in words
2296 foreach (split / /,$line) {
2297 next unless $_; # skip empty values (multiple spaces)
2298 # if the entry is already here, do nothing, the biblionumber has already be removed
2299 unless ($result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2300 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2301 $sth2->execute($server,'__RAW__',$_);
2302 my $existing_biblionumbers = $sth2->fetchrow;
2304 if ($existing_biblionumbers) {
2305 $result{'__RAW__'}->{$_} =$existing_biblionumbers;
2306 $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2316 =head2 _AddBiblioNoZebra($biblionumber, $record, $server, %result);
2318 function to add a biblio in NoZebra indexes
2322 sub _AddBiblioNoZebra {
2323 my ($biblionumber, $record, $server, %result)=@_;
2324 my $dbh = C4::Context->dbh;
2328 if ($server eq 'biblioserver') {
2329 %index=GetNoZebraIndexes;
2330 # get title of the record (to store the 10 first letters with the index)
2331 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
2332 $title = lc($record->subfield($titletag,$titlesubfield));
2334 # warn "server : $server";
2335 # for authorities, the "title" is the $a mainentry
2336 my ($auth_type_tag, $auth_type_sf) = C4::AuthoritiesMarc::get_auth_type_location();
2337 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield($auth_type_tag, $auth_type_sf));
2338 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2339 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2340 $index{'mainmainentry'} = $authref->{auth_tag_to_report}.'a';
2341 $index{'mainentry'} = $authref->{auth_tag_to_report}.'*';
2342 $index{'auth_type'} = "${auth_type_tag}${auth_type_sf}";
2345 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2346 $title =~ s/ |\.|,|;|\[|\]|\(|\)|\*|-|'|:|=|\r|\n//g;
2347 # limit to 10 char, should be enough, and limit the DB size
2348 $title = substr($title,0,10);
2350 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2351 foreach my $field ($record->fields()) {
2352 #parse each subfield
2353 next if $field->tag <10;
2354 foreach my $subfield ($field->subfields()) {
2355 my $tag = $field->tag();
2356 my $subfieldcode = $subfield->[0];
2358 # warn "INDEXING :".$subfield->[1];
2359 # check each index to see if the subfield is stored somewhere
2360 # otherwise, store it in __RAW__ index
2361 foreach my $key (keys %index) {
2362 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2363 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2365 my $line= lc $subfield->[1];
2366 # remove meaningless value in the field...
2367 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2368 # ... and split in words
2369 foreach (split / /,$line) {
2370 next unless $_; # skip empty values (multiple spaces)
2371 # if the entry is already here, improve weight
2372 # warn "managing $_";
2373 if ($result{$key}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d);/) {
2375 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2376 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2378 # get the value if it exist in the nozebra table, otherwise, create it
2379 $sth2->execute($server,$key,$_);
2380 my $existing_biblionumbers = $sth2->fetchrow;
2382 if ($existing_biblionumbers) {
2383 $result{$key}->{"$_"} =$existing_biblionumbers;
2385 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2386 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2387 # create a new ligne for this entry
2389 # warn "INSERT : $server / $key / $_";
2390 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname='.$dbh->quote($key).',value='.$dbh->quote($_));
2391 $result{$key}->{"$_"}.="$biblionumber,$title-1;";
2397 # the subfield is not indexed, store it in __RAW__ index anyway
2399 my $line= lc $subfield->[1];
2400 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2401 # ... and split in words
2402 foreach (split / /,$line) {
2403 next unless $_; # skip empty values (multiple spaces)
2404 # if the entry is already here, improve weight
2405 if ($result{'__RAW__'}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d);/) {
2407 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2408 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2410 # get the value if it exist in the nozebra table, otherwise, create it
2411 $sth2->execute($server,'__RAW__',$_);
2412 my $existing_biblionumbers = $sth2->fetchrow;
2414 if ($existing_biblionumbers) {
2415 $result{'__RAW__'}->{"$_"} =$existing_biblionumbers;
2417 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2418 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2419 # create a new ligne for this entry
2421 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname="__RAW__",value='.$dbh->quote($_));
2422 $result{'__RAW__'}->{"$_"}.="$biblionumber,$title-1;";
2437 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2439 Find the given $subfield in the given $tag in the given
2440 MARC::Record $record. If the subfield is found, returns
2441 the (indicators, value) pair; otherwise, (undef, undef) is
2445 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2446 I suggest we export it from this module.
2453 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2456 if ( $tagfield < 10 ) {
2457 if ( $record->field($tagfield) ) {
2458 push @result, $record->field($tagfield)->data();
2465 foreach my $field ( $record->field($tagfield) ) {
2466 my @subfields = $field->subfields();
2467 foreach my $subfield (@subfields) {
2468 if ( @$subfield[0] eq $insubfield ) {
2469 push @result, @$subfield[1];
2470 $indicator = $field->indicator(1) . $field->indicator(2);
2475 return ( $indicator, @result );
2478 =head2 _koha_marc_update_bib_ids
2482 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
2484 Internal function to add or update biblionumber and biblioitemnumber to
2491 sub _koha_marc_update_bib_ids {
2492 my ($record, $frameworkcode, $biblionumber, $biblioitemnumber) = @_;
2494 # we must add bibnum and bibitemnum in MARC::Record...
2495 # we build the new field with biblionumber and biblioitemnumber
2496 # we drop the original field
2497 # we add the new builded field.
2498 my ($biblio_tag, $biblio_subfield ) = GetMarcFromKohaField("biblio.biblionumber",$frameworkcode);
2499 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.biblioitemnumber",$frameworkcode);
2501 if ($biblio_tag != $biblioitem_tag) {
2502 # biblionumber & biblioitemnumber are in different fields
2504 # deal with biblionumber
2505 my ($new_field, $old_field);
2506 if ($biblio_tag < 10) {
2507 $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
2510 MARC::Field->new( $biblio_tag, '', '',
2511 "$biblio_subfield" => $biblionumber );
2514 # drop old field and create new one...
2515 $old_field = $record->field($biblio_tag);
2516 $record->delete_field($old_field) if $old_field;
2517 $record->append_fields($new_field);
2519 # deal with biblioitemnumber
2520 if ($biblioitem_tag < 10) {
2521 $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
2524 MARC::Field->new( $biblioitem_tag, '', '',
2525 "$biblioitem_subfield" => $biblioitemnumber, );
2527 # drop old field and create new one...
2528 $old_field = $record->field($biblioitem_tag);
2529 $record->delete_field($old_field) if $old_field;
2530 $record->insert_fields_ordered($new_field);
2533 # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
2534 my $new_field = MARC::Field->new(
2535 $biblio_tag, '', '',
2536 "$biblio_subfield" => $biblionumber,
2537 "$biblioitem_subfield" => $biblioitemnumber
2540 # drop old field and create new one...
2541 my $old_field = $record->field($biblio_tag);
2542 $record->delete_field($old_field) if $old_field;
2543 $record->insert_fields_ordered($new_field);
2547 =head2 _koha_marc_update_biblioitem_cn_sort
2551 _koha_marc_update_biblioitem_cn_sort($marc, $biblioitem, $frameworkcode);
2555 Given a MARC bib record and the biblioitem hash, update the
2556 subfield that contains a copy of the value of biblioitems.cn_sort.
2560 sub _koha_marc_update_biblioitem_cn_sort {
2562 my $biblioitem = shift;
2563 my $frameworkcode= shift;
2565 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.cn_sort",$frameworkcode);
2566 return unless $biblioitem_tag;
2568 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2570 if (my $field = $marc->field($biblioitem_tag)) {
2571 $field->delete_subfield(code => $biblioitem_subfield);
2572 if ($cn_sort ne '') {
2573 $field->add_subfields($biblioitem_subfield => $cn_sort);
2576 # if we get here, no biblioitem tag is present in the MARC record, so
2577 # we'll create it if $cn_sort is not empty -- this would be
2578 # an odd combination of events, however
2580 $marc->insert_grouped_field(MARC::Field->new($biblioitem_tag, ' ', ' ', $biblioitem_subfield => $cn_sort));
2585 =head2 _koha_add_biblio
2589 my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
2591 Internal function to add a biblio ($biblio is a hash with the values)
2597 sub _koha_add_biblio {
2598 my ( $dbh, $biblio, $frameworkcode ) = @_;
2602 # set the series flag
2604 if ( $biblio->{'seriestitle'} ) { $serial = 1 };
2608 SET frameworkcode = ?,
2619 my $sth = $dbh->prepare($query);
2622 $biblio->{'author'},
2624 $biblio->{'unititle'},
2627 $biblio->{'seriestitle'},
2628 $biblio->{'copyrightdate'},
2629 $biblio->{'abstract'}
2632 my $biblionumber = $dbh->{'mysql_insertid'};
2633 if ( $dbh->errstr ) {
2634 $error.="ERROR in _koha_add_biblio $query".$dbh->errstr;
2639 #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
2640 return ($biblionumber,$error);
2643 =head2 _koha_modify_biblio
2647 my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
2649 Internal function for updating the biblio table
2655 sub _koha_modify_biblio {
2656 my ( $dbh, $biblio, $frameworkcode ) = @_;
2661 SET frameworkcode = ?,
2670 WHERE biblionumber = ?
2673 my $sth = $dbh->prepare($query);
2677 $biblio->{'author'},
2679 $biblio->{'unititle'},
2681 $biblio->{'serial'},
2682 $biblio->{'seriestitle'},
2683 $biblio->{'copyrightdate'},
2684 $biblio->{'abstract'},
2685 $biblio->{'biblionumber'}
2686 ) if $biblio->{'biblionumber'};
2688 if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
2689 $error.="ERROR in _koha_modify_biblio $query".$dbh->errstr;
2692 return ( $biblio->{'biblionumber'},$error );
2695 =head2 _koha_modify_biblioitem_nonmarc
2699 my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
2701 Updates biblioitems row except for marc and marcxml, which should be changed
2708 sub _koha_modify_biblioitem_nonmarc {
2709 my ( $dbh, $biblioitem ) = @_;
2712 # re-calculate the cn_sort, it may have changed
2713 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2717 SET biblionumber = ?,
2723 publicationyear = ?,
2727 collectiontitle = ?,
2729 collectionvolume= ?,
2730 editionstatement= ?,
2731 editionresponsibility = ?,
2745 where biblioitemnumber = ?
2747 my $sth = $dbh->prepare($query);
2749 $biblioitem->{'biblionumber'},
2750 $biblioitem->{'volume'},
2751 $biblioitem->{'number'},
2752 $biblioitem->{'itemtype'},
2753 $biblioitem->{'isbn'},
2754 $biblioitem->{'issn'},
2755 $biblioitem->{'publicationyear'},
2756 $biblioitem->{'publishercode'},
2757 $biblioitem->{'volumedate'},
2758 $biblioitem->{'volumedesc'},
2759 $biblioitem->{'collectiontitle'},
2760 $biblioitem->{'collectionissn'},
2761 $biblioitem->{'collectionvolume'},
2762 $biblioitem->{'editionstatement'},
2763 $biblioitem->{'editionresponsibility'},
2764 $biblioitem->{'illus'},
2765 $biblioitem->{'pages'},
2766 $biblioitem->{'bnotes'},
2767 $biblioitem->{'size'},
2768 $biblioitem->{'place'},
2769 $biblioitem->{'lccn'},
2770 $biblioitem->{'url'},
2771 $biblioitem->{'biblioitems.cn_source'},
2772 $biblioitem->{'cn_class'},
2773 $biblioitem->{'cn_item'},
2774 $biblioitem->{'cn_suffix'},
2776 $biblioitem->{'totalissues'},
2777 $biblioitem->{'biblioitemnumber'}
2779 if ( $dbh->errstr ) {
2780 $error.="ERROR in _koha_modify_biblioitem_nonmarc $query".$dbh->errstr;
2783 return ($biblioitem->{'biblioitemnumber'},$error);
2786 =head2 _koha_add_biblioitem
2790 my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
2792 Internal function to add a biblioitem
2798 sub _koha_add_biblioitem {
2799 my ( $dbh, $biblioitem ) = @_;
2802 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2804 "INSERT INTO biblioitems SET
2811 publicationyear = ?,
2815 collectiontitle = ?,
2817 collectionvolume= ?,
2818 editionstatement= ?,
2819 editionresponsibility = ?,
2835 my $sth = $dbh->prepare($query);
2837 $biblioitem->{'biblionumber'},
2838 $biblioitem->{'volume'},
2839 $biblioitem->{'number'},
2840 $biblioitem->{'itemtype'},
2841 $biblioitem->{'isbn'},
2842 $biblioitem->{'issn'},
2843 $biblioitem->{'publicationyear'},
2844 $biblioitem->{'publishercode'},
2845 $biblioitem->{'volumedate'},
2846 $biblioitem->{'volumedesc'},
2847 $biblioitem->{'collectiontitle'},
2848 $biblioitem->{'collectionissn'},
2849 $biblioitem->{'collectionvolume'},
2850 $biblioitem->{'editionstatement'},
2851 $biblioitem->{'editionresponsibility'},
2852 $biblioitem->{'illus'},
2853 $biblioitem->{'pages'},
2854 $biblioitem->{'bnotes'},
2855 $biblioitem->{'size'},
2856 $biblioitem->{'place'},
2857 $biblioitem->{'lccn'},
2858 $biblioitem->{'marc'},
2859 $biblioitem->{'url'},
2860 $biblioitem->{'biblioitems.cn_source'},
2861 $biblioitem->{'cn_class'},
2862 $biblioitem->{'cn_item'},
2863 $biblioitem->{'cn_suffix'},
2865 $biblioitem->{'totalissues'}
2867 my $bibitemnum = $dbh->{'mysql_insertid'};
2868 if ( $dbh->errstr ) {
2869 $error.="ERROR in _koha_add_biblioitem $query".$dbh->errstr;
2873 return ($bibitemnum,$error);
2876 =head2 _koha_delete_biblio
2880 $error = _koha_delete_biblio($dbh,$biblionumber);
2882 Internal sub for deleting from biblio table -- also saves to deletedbiblio
2884 C<$dbh> - the database handle
2885 C<$biblionumber> - the biblionumber of the biblio to be deleted
2891 # FIXME: add error handling
2893 sub _koha_delete_biblio {
2894 my ( $dbh, $biblionumber ) = @_;
2896 # get all the data for this biblio
2897 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
2898 $sth->execute($biblionumber);
2900 if ( my $data = $sth->fetchrow_hashref ) {
2902 # save the record in deletedbiblio
2903 # find the fields to save
2904 my $query = "INSERT INTO deletedbiblio SET ";
2906 foreach my $temp ( keys %$data ) {
2907 $query .= "$temp = ?,";
2908 push( @bind, $data->{$temp} );
2911 # replace the last , by ",?)"
2913 my $bkup_sth = $dbh->prepare($query);
2914 $bkup_sth->execute(@bind);
2918 my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
2919 $del_sth->execute($biblionumber);
2926 =head2 _koha_delete_biblioitems
2930 $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
2932 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
2934 C<$dbh> - the database handle
2935 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
2941 # FIXME: add error handling
2943 sub _koha_delete_biblioitems {
2944 my ( $dbh, $biblioitemnumber ) = @_;
2946 # get all the data for this biblioitem
2948 $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
2949 $sth->execute($biblioitemnumber);
2951 if ( my $data = $sth->fetchrow_hashref ) {
2953 # save the record in deletedbiblioitems
2954 # find the fields to save
2955 my $query = "INSERT INTO deletedbiblioitems SET ";
2957 foreach my $temp ( keys %$data ) {
2958 $query .= "$temp = ?,";
2959 push( @bind, $data->{$temp} );
2962 # replace the last , by ",?)"
2964 my $bkup_sth = $dbh->prepare($query);
2965 $bkup_sth->execute(@bind);
2968 # delete the biblioitem
2970 $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
2971 $del_sth->execute($biblioitemnumber);
2978 =head1 UNEXPORTED FUNCTIONS
2980 =head2 ModBiblioMarc
2982 &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
2984 Add MARC data for a biblio to koha
2986 Function exported, but should NOT be used, unless you really know what you're doing
2992 # pass the MARC::Record to this function, and it will create the records in the marc field
2993 my ( $record, $biblionumber, $frameworkcode ) = @_;
2994 my $dbh = C4::Context->dbh;
2995 my @fields = $record->fields();
2996 if ( !$frameworkcode ) {
2997 $frameworkcode = "";
3000 $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
3001 $sth->execute( $frameworkcode, $biblionumber );
3003 my $encoding = C4::Context->preference("marcflavour");
3005 # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
3006 if ( $encoding eq "UNIMARC" ) {
3008 if ( length($record->subfield( 100, "a" )) == 35 ) {
3009 $string = $record->subfield( 100, "a" );
3010 my $f100 = $record->field(100);
3011 $record->delete_field($f100);
3014 $string = POSIX::strftime( "%Y%m%d", localtime );
3016 $string = sprintf( "%-*s", 35, $string );
3018 substr( $string, 22, 6, "frey50" );
3019 unless ( $record->subfield( 100, "a" ) ) {
3020 $record->insert_grouped_field(
3021 MARC::Field->new( 100, "", "", "a" => $string ) );
3025 if (C4::Context->preference("NoZebra")) {
3026 # only NoZebra indexing needs to have
3027 # the previous version of the record
3028 $oldRecord = GetMarcBiblio($biblionumber);
3032 "UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
3033 $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding),
3036 ModZebra($biblionumber,"specialUpdate","biblioserver",$oldRecord,$record);
3037 return $biblionumber;
3040 =head2 z3950_extended_services
3042 z3950_extended_services($serviceType,$serviceOptions,$record);
3044 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.
3046 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
3048 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
3050 action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
3054 recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
3055 syntax => the record syntax (transfer syntax)
3056 databaseName = Database from connection object
3058 To set serviceOptions, call set_service_options($serviceType)
3060 C<$record> the record, if one is needed for the service type
3062 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
3066 sub z3950_extended_services {
3067 my ( $server, $serviceType, $action, $serviceOptions ) = @_;
3069 # get our connection object
3070 my $Zconn = C4::Context->Zconn( $server, 0, 1 );
3072 # create a new package object
3073 my $Zpackage = $Zconn->package();
3076 $Zpackage->option( action => $action );
3078 if ( $serviceOptions->{'databaseName'} ) {
3079 $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
3081 if ( $serviceOptions->{'recordIdNumber'} ) {
3083 recordIdNumber => $serviceOptions->{'recordIdNumber'} );
3085 if ( $serviceOptions->{'recordIdOpaque'} ) {
3087 recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
3090 # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
3091 #if ($serviceType eq 'itemorder') {
3092 # $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
3093 # $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
3094 # $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
3095 # $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
3098 if ( $serviceOptions->{record} ) {
3099 $Zpackage->option( record => $serviceOptions->{record} );
3101 # can be xml or marc
3102 if ( $serviceOptions->{'syntax'} ) {
3103 $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
3107 # send the request, handle any exception encountered
3108 eval { $Zpackage->send($serviceType) };
3109 if ( $@ && $@->isa("ZOOM::Exception") ) {
3110 return "error: " . $@->code() . " " . $@->message() . "\n";
3113 # free up package resources
3114 $Zpackage->destroy();
3117 =head2 set_service_options
3119 my $serviceOptions = set_service_options($serviceType);
3121 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
3123 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
3127 sub set_service_options {
3128 my ($serviceType) = @_;
3131 # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
3132 # $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
3134 if ( $serviceType eq 'commit' ) {
3138 if ( $serviceType eq 'create' ) {
3142 if ( $serviceType eq 'drop' ) {
3143 die "ERROR: 'drop' not currently supported (by Zebra)";
3145 return $serviceOptions;
3148 =head3 get_biblio_authorised_values
3150 find the types and values for all authorised values assigned to this biblio.
3155 returns: a hashref malling the authorised value to the value set for this biblionumber
3157 $authorised_values = {
3158 'Scent' => 'flowery',
3159 'Audience' => 'Young Adult',
3160 'itemtypes' => 'SER',
3163 Notes: forlibrarian should probably be passed in, and called something different.
3168 sub get_biblio_authorised_values {
3169 my $biblionumber = shift;
3171 my $forlibrarian = 1; # are we in staff or opac?
3172 my $frameworkcode = GetFrameworkCode( $biblionumber );
3174 my $authorised_values;
3176 my $record = GetMarcBiblio( $biblionumber )
3177 or return $authorised_values;
3178 my $tagslib = GetMarcStructure( $forlibrarian, $frameworkcode )
3179 or return $authorised_values;
3181 # assume that these entries in the authorised_value table are bibliolevel.
3182 # ones that start with 'item%' are item level.
3183 my $query = q(SELECT distinct authorised_value, kohafield
3184 FROM marc_subfield_structure
3185 WHERE authorised_value !=''
3186 AND (kohafield like 'biblio%'
3187 OR kohafield like '') );
3188 my $bibliolevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
3190 foreach my $tag ( keys( %$tagslib ) ) {
3191 foreach my $subfield ( keys( %{$tagslib->{ $tag }} ) ) {
3192 # warn "checking $subfield. type is: " . ref $tagslib->{ $tag }{ $subfield };
3193 if ( 'HASH' eq ref $tagslib->{ $tag }{ $subfield } ) {
3194 if ( exists $tagslib->{ $tag }{ $subfield }{'authorised_value'} && exists $bibliolevel_authorised_values->{ $tagslib->{ $tag }{ $subfield }{'authorised_value'} } ) {
3195 if ( defined $record->field( $tag ) ) {
3196 my $this_subfield_value = $record->field( $tag )->subfield( $subfield );
3197 if ( defined $this_subfield_value ) {
3198 $authorised_values->{ $tagslib->{ $tag }{ $subfield }{'authorised_value'} } = $this_subfield_value;
3205 # warn ( Data::Dumper->Dump( [ $authorised_values ], [ 'authorised_values' ] ) );
3206 return $authorised_values;
3216 Koha Developement team <info@koha.org>
3218 Paul POULAIN paul.poulain@free.fr
3220 Joshua Ferraro jmf@liblime.com