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
24 use MARC::File::USMARC;
29 use C4::Dates qw/format_date/;
30 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
112 C4::Biblio - cataloging management functions
116 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:
120 =item 1. in the biblio,biblioitems,items, etc tables, which are limited to a one-to-one mapping to underlying MARC data
122 =item 2. as raw MARC in the Zebra index and storage engine
124 =item 3. as raw MARC the biblioitems.marc and biblioitems.marcxml
128 In the 3.0 version of Koha, the authoritative record-level information is in biblioitems.marcxml
130 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.
134 =item 1. Compared with MySQL, Zebra is slow to update an index for small data changes -- especially for proc-intensive operations like circulation
136 =item 2. Zebra's index has been known to crash and a backup of the data is necessary to rebuild it in such cases
140 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:
144 =item 1. Add*/Mod*/Del*/ - high-level external functions suitable for being called from external scripts to manage the collection
146 =item 2. _koha_* - low-level internal functions for managing the koha tables
148 =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.
150 =item 4. Zebra functions used to update the Zebra index
152 =item 5. internal helper functions such as char_decode, checkitems, etc. Some of these probably belong in Koha.pm
156 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 :
160 =item 1. save datas in biblio and biblioitems table, that gives us a biblionumber and a biblioitemnumber
162 =item 2. add the biblionumber and biblioitemnumber into the MARC records
164 =item 3. save the marc record
168 When dealing with items, we must :
172 =item 1. save the item in items table, that gives us an itemnumber
174 =item 2. add the itemnumber to the item MARC field
176 =item 3. overwrite the MARC record (with the added item) into biblioitems.marc(xml)
178 When modifying a biblio or an item, the behaviour is quite similar.
182 =head1 EXPORTED FUNCTIONS
188 ($biblionumber,$biblioitemnumber) = AddBiblio($record,$frameworkcode);
192 Exported function (core API) for adding a new biblio to koha.
194 The first argument is a C<MARC::Record> object containing the
195 bib to add, while the second argument is the desired MARC
198 This function also accepts a third, optional argument: a hashref
199 to additional options. The only defined option is C<defer_marc_save>,
200 which if present and mapped to a true value, causes C<AddBiblio>
201 to omit the call to save the MARC in C<bibilioitems.marc>
202 and C<biblioitems.marcxml> This option is provided B<only>
203 for the use of scripts such as C<bulkmarcimport.pl> that may need
204 to do some manipulation of the MARC record for item parsing before
205 saving it and which cannot afford the performance hit of saving
206 the MARC record twice. Consequently, do not use that option
207 unless you can guarantee that C<ModBiblioMarc> will be called.
213 my $frameworkcode = shift;
214 my $options = @_ ? shift : undef;
215 my $defer_marc_save = 0;
216 if (defined $options and exists $options->{'defer_marc_save'} and $options->{'defer_marc_save'}) {
217 $defer_marc_save = 1;
220 my ($biblionumber,$biblioitemnumber,$error);
221 my $dbh = C4::Context->dbh;
222 # transform the data into koha-table style data
223 my $olddata = TransformMarcToKoha( $dbh, $record, $frameworkcode );
224 ($biblionumber,$error) = _koha_add_biblio( $dbh, $olddata, $frameworkcode );
225 $olddata->{'biblionumber'} = $biblionumber;
226 ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $olddata );
228 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
230 # update MARC subfield that stores biblioitems.cn_sort
231 _koha_marc_update_biblioitem_cn_sort($record, $olddata, $frameworkcode);
234 $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode ) unless $defer_marc_save;
236 logaction("CATALOGUING", "ADD", $biblionumber, "biblio") if C4::Context->preference("CataloguingLog");
238 return ( $biblionumber, $biblioitemnumber );
245 ModBiblio( $record,$biblionumber,$frameworkcode);
249 Replace an existing bib record identified by C<$biblionumber>
250 with one supplied by the MARC::Record object C<$record>. The embedded
251 item, biblioitem, and biblionumber fields from the previous
252 version of the bib record replace any such fields of those tags that
253 are present in C<$record>. Consequently, ModBiblio() is not
254 to be used to try to modify item records.
256 C<$frameworkcode> specifies the MARC framework to use
257 when storing the modified bib record; among other things,
258 this controls how MARC fields get mapped to display columns
259 in the C<biblio> and C<biblioitems> tables, as well as
260 which fields are used to store embedded item, biblioitem,
261 and biblionumber data for indexing.
266 my ( $record, $biblionumber, $frameworkcode ) = @_;
267 if (C4::Context->preference("CataloguingLog")) {
268 my $newrecord = GetMarcBiblio($biblionumber);
269 logaction("CATALOGUING", "MODIFY", $biblionumber, "BEFORE=>".$newrecord->as_formatted);
272 my $dbh = C4::Context->dbh;
274 $frameworkcode = "" unless $frameworkcode;
276 # get the items before and append them to the biblio before updating the record, atm we just have the biblio
277 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
278 my $oldRecord = GetMarcBiblio( $biblionumber );
280 # delete any item fields from incoming record to avoid
281 # duplication or incorrect data - use AddItem() or ModItem()
283 foreach my $field ($record->field($itemtag)) {
284 $record->delete_field($field);
287 # parse each item, and, for an unknown reason, re-encode each subfield
288 # if you don't do that, the record will have encoding mixed
289 # and the biblio will be re-encoded.
290 # strange, I (Paul P.) searched more than 1 day to understand what happends
291 # but could only solve the problem this way...
292 my @fields = $oldRecord->field( $itemtag );
293 foreach my $fielditem ( @fields ){
295 foreach ($fielditem->subfields()) {
297 $field->add_subfields(Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
299 $field = MARC::Field->new("$itemtag",'','',Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
302 $record->append_fields($field);
305 # update biblionumber and biblioitemnumber in MARC
306 # FIXME - this is assuming a 1 to 1 relationship between
307 # biblios and biblioitems
308 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
309 $sth->execute($biblionumber);
310 my ($biblioitemnumber) = $sth->fetchrow;
312 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
314 # load the koha-table data object
315 my $oldbiblio = TransformMarcToKoha( $dbh, $record, $frameworkcode );
317 # update MARC subfield that stores biblioitems.cn_sort
318 _koha_marc_update_biblioitem_cn_sort($record, $oldbiblio, $frameworkcode);
320 # update the MARC record (that now contains biblio and items) with the new record data
321 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
323 # modify the other koha tables
324 _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
325 _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
329 =head2 ModBiblioframework
331 ModBiblioframework($biblionumber,$frameworkcode);
332 Exported function to modify a biblio framework
336 sub ModBiblioframework {
337 my ( $biblionumber, $frameworkcode ) = @_;
338 my $dbh = C4::Context->dbh;
339 my $sth = $dbh->prepare(
340 "UPDATE biblio SET frameworkcode=? WHERE biblionumber=?"
342 $sth->execute($frameworkcode, $biblionumber);
350 my $error = &DelBiblio($dbh,$biblionumber);
351 Exported function (core API) for deleting a biblio in koha.
352 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
353 Also backs it up to deleted* tables
354 Checks to make sure there are not issues on any of the items
356 C<$error> : undef unless an error occurs
363 my ( $biblionumber ) = @_;
364 my $dbh = C4::Context->dbh;
365 my $error; # for error handling
367 # First make sure this biblio has no items attached
368 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
369 $sth->execute($biblionumber);
370 if (my $itemnumber = $sth->fetchrow){
371 # Fix this to use a status the template can understand
372 $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
375 return $error if $error;
377 # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
378 # for at least 2 reasons :
379 # - we need to read the biblio if NoZebra is set (to remove it from the indexes
380 # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
381 # 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)
383 if (C4::Context->preference("NoZebra")) {
384 # only NoZebra indexing needs to have
385 # the previous version of the record
386 $oldRecord = GetMarcBiblio($biblionumber);
388 ModZebra($biblionumber, "recordDelete", "biblioserver", $oldRecord, undef);
390 # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
393 "SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
394 $sth->execute($biblionumber);
395 while ( my $biblioitemnumber = $sth->fetchrow ) {
397 # delete this biblioitem
398 $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
399 return $error if $error;
402 # delete biblio from Koha tables and save in deletedbiblio
403 # must do this *after* _koha_delete_biblioitems, otherwise
404 # delete cascade will prevent deletedbiblioitems rows
405 # from being generated by _koha_delete_biblioitems
406 $error = _koha_delete_biblio( $dbh, $biblionumber );
408 logaction("CATALOGUING", "DELETE", $biblionumber, "") if C4::Context->preference("CataloguingLog");
413 =head2 LinkBibHeadingsToAuthorities
417 my $headings_linked = LinkBibHeadingsToAuthorities($marc);
421 Links bib headings to authority records by checking
422 each authority-controlled field in the C<MARC::Record>
423 object C<$marc>, looking for a matching authority record,
424 and setting the linking subfield $9 to the ID of that
427 If no matching authority exists, or if multiple
428 authorities match, no $9 will be added, and any
429 existing one inthe field will be deleted.
431 Returns the number of heading links changed in the
436 sub LinkBibHeadingsToAuthorities {
439 my $num_headings_changed = 0;
440 foreach my $field ($bib->fields()) {
441 my $heading = C4::Heading->new_from_bib_field($field);
442 next unless defined $heading;
445 my $current_link = $field->subfield('9');
447 # look for matching authorities
448 my $authorities = $heading->authorities();
450 # want only one exact match
451 if ($#{ $authorities } == 0) {
452 my $authority = MARC::Record->new_from_usmarc($authorities->[0]);
453 my $authid = $authority->field('001')->data();
454 next if defined $current_link and $current_link eq $authid;
456 $field->delete_subfield(code => '9') if defined $current_link;
457 $field->add_subfields('9', $authid);
458 $num_headings_changed++;
460 if (defined $current_link) {
461 $field->delete_subfield(code => '9');
462 $num_headings_changed++;
467 return $num_headings_changed;
474 $data = &GetBiblioData($biblionumber);
475 Returns information about the book with the given biblionumber.
476 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
477 the C<biblio> and C<biblioitems> tables in the
479 In addition, C<$data-E<gt>{subject}> is the list of the book's
480 subjects, separated by C<" , "> (space, comma, space).
481 If there are multiple biblioitems with the given biblionumber, only
482 the first one is considered.
490 my $dbh = C4::Context->dbh;
492 # my $query = C4::Context->preference('item-level_itypes') ?
493 # " SELECT * , biblioitems.notes AS bnotes, biblio.notes
495 # LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
496 # WHERE biblio.biblionumber = ?
497 # AND biblioitems.biblionumber = biblio.biblionumber
500 my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
502 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
503 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
504 WHERE biblio.biblionumber = ?
505 AND biblioitems.biblionumber = biblio.biblionumber ";
507 my $sth = $dbh->prepare($query);
508 $sth->execute($bibnum);
510 $data = $sth->fetchrow_hashref;
514 } # sub GetBiblioData
516 =head2 &GetBiblioItemData
520 $itemdata = &GetBiblioItemData($biblioitemnumber);
522 Looks up the biblioitem with the given biblioitemnumber. Returns a
523 reference-to-hash. The keys are the fields from the C<biblio>,
524 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
525 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
532 sub GetBiblioItemData {
533 my ($biblioitemnumber) = @_;
534 my $dbh = C4::Context->dbh;
535 my $query = "SELECT *,biblioitems.notes AS bnotes
536 FROM biblio LEFT JOIN biblioitems on biblio.biblionumber=biblioitems.biblionumber ";
537 unless(C4::Context->preference('item-level_itypes')) {
538 $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
540 $query .= " WHERE biblioitemnumber = ? ";
541 my $sth = $dbh->prepare($query);
543 $sth->execute($biblioitemnumber);
544 $data = $sth->fetchrow_hashref;
547 } # sub &GetBiblioItemData
549 =head2 GetBiblioItemByBiblioNumber
553 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
559 sub GetBiblioItemByBiblioNumber {
560 my ($biblionumber) = @_;
561 my $dbh = C4::Context->dbh;
562 my $sth = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
566 $sth->execute($biblionumber);
568 while ( my $data = $sth->fetchrow_hashref ) {
569 push @results, $data;
576 =head2 GetBiblioFromItemNumber
580 $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
582 Looks up the item with the given itemnumber. if undef, try the barcode.
584 C<&itemnodata> returns a reference-to-hash whose keys are the fields
585 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
593 sub GetBiblioFromItemNumber {
594 my ( $itemnumber, $barcode ) = @_;
595 my $dbh = C4::Context->dbh;
598 $sth=$dbh->prepare( "SELECT * FROM items
599 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
600 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
601 WHERE items.itemnumber = ?") ;
602 $sth->execute($itemnumber);
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.barcode = ?") ;
608 $sth->execute($barcode);
610 my $data = $sth->fetchrow_hashref;
619 ( $count, @results ) = &GetBiblio($biblionumber);
626 my ($biblionumber) = @_;
627 my $dbh = C4::Context->dbh;
628 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
631 $sth->execute($biblionumber);
632 while ( my $data = $sth->fetchrow_hashref ) {
633 $results[$count] = $data;
637 return ( $count, @results );
640 =head2 GetBiblioItemInfosOf
644 GetBiblioItemInfosOf(@biblioitemnumbers);
650 sub GetBiblioItemInfosOf {
651 my @biblioitemnumbers = @_;
654 SELECT biblioitemnumber,
658 WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
660 return get_infos_of( $query, 'biblioitemnumber' );
663 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
665 =head2 GetMarcStructure
669 $res = GetMarcStructure($forlibrarian,$frameworkcode);
671 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
672 $forlibrarian :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
673 $frameworkcode : the framework code to read
679 # cache for results of GetMarcStructure -- needed
681 our $marc_structure_cache;
683 sub GetMarcStructure {
684 my ( $forlibrarian, $frameworkcode ) = @_;
685 my $dbh=C4::Context->dbh;
686 $frameworkcode = "" unless $frameworkcode;
688 if (defined $marc_structure_cache and exists $marc_structure_cache->{$forlibrarian}->{$frameworkcode}) {
689 return $marc_structure_cache->{$forlibrarian}->{$frameworkcode};
693 my $libfield = ( $forlibrarian eq 1 ) ? 'liblibrarian' : 'libopac';
695 # check that framework exists
698 "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
699 $sth->execute($frameworkcode);
700 my ($total) = $sth->fetchrow;
701 $frameworkcode = "" unless ( $total > 0 );
704 "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable
705 FROM marc_tag_structure
706 WHERE frameworkcode=?
709 $sth->execute($frameworkcode);
710 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
712 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) =
715 $res->{$tag}->{lib} =
716 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
717 $res->{$tag}->{tab} = "";
718 $res->{$tag}->{mandatory} = $mandatory;
719 $res->{$tag}->{repeatable} = $repeatable;
724 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue
725 FROM marc_subfield_structure
726 WHERE frameworkcode=?
727 ORDER BY tagfield,tagsubfield
731 $sth->execute($frameworkcode);
734 my $authorised_value;
746 $tag, $subfield, $liblibrarian,
748 $mandatory, $repeatable, $authorised_value,
749 $authtypecode, $value_builder, $kohafield,
750 $seealso, $hidden, $isurl,
756 $res->{$tag}->{$subfield}->{lib} =
757 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
758 $res->{$tag}->{$subfield}->{tab} = $tab;
759 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
760 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
761 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
762 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
763 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
764 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
765 $res->{$tag}->{$subfield}->{seealso} = $seealso;
766 $res->{$tag}->{$subfield}->{hidden} = $hidden;
767 $res->{$tag}->{$subfield}->{isurl} = $isurl;
768 $res->{$tag}->{$subfield}->{'link'} = $link;
769 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
772 $marc_structure_cache->{$forlibrarian}->{$frameworkcode} = $res;
777 =head2 GetUsedMarcStructure
779 the same function as GetMarcStructure expcet it just take field
780 in tab 0-9. (used field)
782 my $results = GetUsedMarcStructure($frameworkcode);
784 L<$results> is a ref to an array which each case containts a ref
785 to a hash which each keys is the columns from marc_subfield_structure
787 L<$frameworkcode> is the framework code.
791 sub GetUsedMarcStructure($){
792 my $frameworkcode = shift || '';
793 my $dbh = C4::Context->dbh;
796 FROM marc_subfield_structure
798 AND frameworkcode = ?
801 my $sth = $dbh->prepare($query);
802 $sth->execute($frameworkcode);
803 while (my $row = $sth->fetchrow_hashref){
809 =head2 GetMarcFromKohaField
813 ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
814 Returns the MARC fields & subfields mapped to the koha field
815 for the given frameworkcode
821 sub GetMarcFromKohaField {
822 my ( $kohafield, $frameworkcode ) = @_;
823 return 0, 0 unless $kohafield and defined $frameworkcode;
824 my $relations = C4::Context->marcfromkohafield;
826 $relations->{$frameworkcode}->{$kohafield}->[0],
827 $relations->{$frameworkcode}->{$kohafield}->[1]
835 my $record = GetMarcBiblio($biblionumber);
839 Returns MARC::Record representing bib identified by
840 C<$biblionumber>. If no bib exists, returns undef.
841 The MARC record contains both biblio & item data.
846 my $biblionumber = shift;
847 my $dbh = C4::Context->dbh;
849 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
850 $sth->execute($biblionumber);
851 my $row = $sth->fetchrow_hashref;
852 my $marcxml = StripNonXmlChars($row->{'marcxml'});
853 MARC::File::XML->default_record_format(C4::Context->preference('marcflavour'));
854 my $record = MARC::Record->new();
856 $record = eval {MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour'))};
857 if ($@) {warn " problem with :$biblionumber : $@ \n$marcxml";}
858 # $record = MARC::Record::new_from_usmarc( $marc) if $marc;
869 my $marcxml = GetXmlBiblio($biblionumber);
871 Returns biblioitems.marcxml of the biblionumber passed in parameter.
872 The XML contains both biblio & item datas
879 my ( $biblionumber ) = @_;
880 my $dbh = C4::Context->dbh;
882 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
883 $sth->execute($biblionumber);
884 my ($marcxml) = $sth->fetchrow;
888 =head2 GetAuthorisedValueDesc
892 my $subfieldvalue =get_authorised_value_desc(
893 $tag, $subf[$i][0],$subf[$i][1], '', $taglib, $category);
894 Retrieve the complete description for a given authorised value.
896 Now takes $category and $value pair too.
897 my $auth_value_desc =GetAuthorisedValueDesc(
898 '','', 'DVD' ,'','','CCODE');
904 sub GetAuthorisedValueDesc {
905 my ( $tag, $subfield, $value, $framework, $tagslib, $category ) = @_;
906 my $dbh = C4::Context->dbh;
910 return $value unless defined $tagslib->{$tag}->{$subfield}->{'authorised_value'};
913 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
914 return C4::Branch::GetBranchName($value);
918 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
919 return getitemtypeinfo($value)->{description};
922 #---- "true" authorized value
923 $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'}
926 if ( $category ne "" ) {
929 "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
931 $sth->execute( $category, $value );
932 my $data = $sth->fetchrow_hashref;
933 return $data->{'lib'};
936 return $value; # if nothing is found return the original value
944 $marcnotesarray = GetMarcNotes( $record, $marcflavour );
945 Get all notes from the MARC record and returns them in an array.
946 The note are stored in differents places depending on MARC flavour
953 my ( $record, $marcflavour ) = @_;
955 if ( $marcflavour eq "MARC21" ) {
958 else { # assume unimarc if not marc21
965 foreach my $field ( $record->field($scope) ) {
966 my $value = $field->as_string();
968 $marcnote = { marcnote => $note, };
969 push @marcnotes, $marcnote;
972 if ( $note ne $value ) {
973 $note = $note . " " . $value;
978 $marcnote = { marcnote => $note };
979 push @marcnotes, $marcnote; #load last tag into array
984 =head2 GetMarcSubjects
988 $marcsubjcts = GetMarcSubjects($record,$marcflavour);
989 Get all subjects from the MARC record and returns them in an array.
990 The subjects are stored in differents places depending on MARC flavour
996 sub GetMarcSubjects {
997 my ( $record, $marcflavour ) = @_;
998 my ( $mintag, $maxtag );
999 if ( $marcflavour eq "MARC21" ) {
1003 else { # assume unimarc if not marc21
1013 foreach my $field ( $record->field('6..' )) {
1014 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1016 my @subfields = $field->subfields();
1019 # if there is an authority link, build the link with an= subfield9
1020 my $subfield9 = $field->subfield('9');
1021 for my $subject_subfield (@subfields ) {
1022 # don't load unimarc subfields 3,4,5
1023 next if (($marcflavour eq "UNIMARC") and ($subject_subfield->[0] =~ /3|4|5/ ) );
1024 my $code = $subject_subfield->[0];
1025 my $value = $subject_subfield->[1];
1026 my $linkvalue = $value;
1027 $linkvalue =~ s/(\(|\))//g;
1028 my $operator = " and " unless $counter==0;
1030 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1032 push @link_loop, {'limit' => 'su', link => $linkvalue, operator => $operator };
1034 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1036 my @this_link_loop = @link_loop;
1037 push @subfields_loop, {code => $code, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($subject_subfield->[0] eq 9 );
1041 push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1044 return \@marcsubjects;
1045 } #end getMARCsubjects
1047 =head2 GetMarcAuthors
1051 authors = GetMarcAuthors($record,$marcflavour);
1052 Get all authors from the MARC record and returns them in an array.
1053 The authors are stored in differents places depending on MARC flavour
1059 sub GetMarcAuthors {
1060 my ( $record, $marcflavour ) = @_;
1061 my ( $mintag, $maxtag );
1062 # tagslib useful for UNIMARC author reponsabilities
1063 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.
1064 if ( $marcflavour eq "MARC21" ) {
1068 elsif ( $marcflavour eq "UNIMARC" ) { # assume unimarc if not marc21
1077 foreach my $field ( $record->fields ) {
1078 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1081 my @subfields = $field->subfields();
1083 # if there is an authority link, build the link with Koha-Auth-Number: subfield9
1084 my $subfield9 = $field->subfield('9');
1085 for my $authors_subfield (@subfields) {
1086 # don't load unimarc subfields 3, 5
1087 next if ($marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~ /3|5/ ) );
1088 my $subfieldcode = $authors_subfield->[0];
1089 my $value = $authors_subfield->[1];
1090 my $linkvalue = $value;
1091 $linkvalue =~ s/(\(|\))//g;
1092 my $operator = " and " unless $count_auth==0;
1093 # if we have an authority link, use that as the link, otherwise use standard searching
1095 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1098 # reset $linkvalue if UNIMARC author responsibility
1099 if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] eq "4")) {
1100 $linkvalue = "(".GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ).")";
1102 push @link_loop, {'limit' => 'au', link => $linkvalue, operator => $operator };
1104 $value = GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ) if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~/4/));
1105 my @this_link_loop = @link_loop;
1106 my $separator = C4::Context->preference("authoritysep") unless $count_auth==0;
1107 push @subfields_loop, {code => $subfieldcode, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($authors_subfield->[0] eq '9' );
1110 push @marcauthors, { MARCAUTHOR_SUBFIELDS_LOOP => \@subfields_loop };
1112 return \@marcauthors;
1119 $marcurls = GetMarcUrls($record,$marcflavour);
1120 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1121 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1128 my ($record, $marcflavour) = @_;
1130 for my $field ($record->field('856')) {
1132 my $url = $field->subfield('u');
1134 for my $note ( $field->subfield('z')) {
1135 push @notes , {note => $note};
1137 if($marcflavour eq 'MARC21') {
1138 my $s3 = $field->subfield('3');
1139 my $link = $field->subfield('y');
1140 unless($url =~ /^\w+:/) {
1141 if($field->indicator(1) eq '7') {
1142 $url = $field->subfield('2') . "://" . $url;
1143 } elsif ($field->indicator(1) eq '1') {
1144 $url = 'ftp://' . $url;
1146 # properly, this should be if ind1=4,
1147 # however we will assume http protocol since we're building a link.
1148 $url = 'http://' . $url;
1151 # TODO handle ind 2 (relationship)
1152 $marcurl = { MARCURL => $url,
1155 $marcurl->{'linktext'} = $link || $s3 || C4::Context->preference('URLLinkText') || $url ;;
1156 $marcurl->{'part'} = $s3 if($link);
1157 $marcurl->{'toc'} = 1 if($s3 =~ /^[Tt]able/) ;
1159 $marcurl->{'linktext'} = $field->subfield('z') || C4::Context->preference('URLLinkText') || $url;
1160 $marcurl->{'MARCURL'} = $url ;
1162 push @marcurls, $marcurl;
1167 =head2 GetMarcSeries
1171 $marcseriesarray = GetMarcSeries($record,$marcflavour);
1172 Get all series from the MARC record and returns them in an array.
1173 The series are stored in differents places depending on MARC flavour
1180 my ($record, $marcflavour) = @_;
1181 my ($mintag, $maxtag);
1182 if ($marcflavour eq "MARC21") {
1185 } else { # assume unimarc if not marc21
1195 foreach my $field ($record->field('440'), $record->field('490')) {
1197 #my $value = $field->subfield('a');
1198 #$marcsubjct = {MARCSUBJCT => $value,};
1199 my @subfields = $field->subfields();
1200 #warn "subfields:".join " ", @$subfields;
1203 for my $series_subfield (@subfields) {
1205 undef $volume_number;
1206 # see if this is an instance of a volume
1207 if ($series_subfield->[0] eq 'v') {
1211 my $code = $series_subfield->[0];
1212 my $value = $series_subfield->[1];
1213 my $linkvalue = $value;
1214 $linkvalue =~ s/(\(|\))//g;
1215 my $operator = " and " unless $counter==0;
1216 push @link_loop, {link => $linkvalue, operator => $operator };
1217 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1218 if ($volume_number) {
1219 push @subfields_loop, {volumenum => $value};
1222 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number};
1226 push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
1227 #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
1228 #push @marcsubjcts, $marcsubjct;
1232 my $marcseriessarray=\@marcseries;
1233 return $marcseriessarray;
1234 } #end getMARCseriess
1236 =head2 GetFrameworkCode
1240 $frameworkcode = GetFrameworkCode( $biblionumber )
1246 sub GetFrameworkCode {
1247 my ( $biblionumber ) = @_;
1248 my $dbh = C4::Context->dbh;
1249 my $sth = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
1250 $sth->execute($biblionumber);
1251 my ($frameworkcode) = $sth->fetchrow;
1252 return $frameworkcode;
1255 =head2 GetPublisherNameFromIsbn
1257 $name = GetPublishercodeFromIsbn($isbn);
1264 sub GetPublisherNameFromIsbn($){
1266 $isbn =~ s/[- _]//g;
1268 my @codes = (split '-', DisplayISBN($isbn));
1269 my $code = $codes[0].$codes[1].$codes[2];
1270 my $dbh = C4::Context->dbh;
1272 SELECT distinct publishercode
1275 AND publishercode IS NOT NULL
1278 my $sth = $dbh->prepare($query);
1279 $sth->execute("$code%");
1280 my $name = $sth->fetchrow;
1281 return $name if length $name;
1285 =head2 TransformKohaToMarc
1289 $record = TransformKohaToMarc( $hash )
1290 This function builds partial MARC::Record from a hash
1291 Hash entries can be from biblio or biblioitems.
1292 This function is called in acquisition module, to create a basic catalogue entry from user entry
1298 sub TransformKohaToMarc {
1301 my $dbh = C4::Context->dbh;
1304 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1306 my $record = MARC::Record->new();
1307 foreach (keys %{$hash}) {
1308 &TransformKohaToMarcOneField( $sth, $record, $_,
1314 =head2 TransformKohaToMarcOneField
1318 $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
1324 sub TransformKohaToMarcOneField {
1325 my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
1326 $frameworkcode='' unless $frameworkcode;
1330 if ( !defined $sth ) {
1331 my $dbh = C4::Context->dbh;
1332 $sth = $dbh->prepare(
1333 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1336 $sth->execute( $frameworkcode, $kohafieldname );
1337 if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
1338 my $tag = $record->field($tagfield);
1340 $tag->update( $tagsubfield => $value );
1341 $record->delete_field($tag);
1342 $record->insert_fields_ordered($tag);
1345 $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
1351 =head2 TransformHtmlToXml
1355 $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type )
1357 $auth_type contains :
1358 - nothing : rebuild a biblio, un UNIMARC the encoding is in 100$a pos 26/27
1359 - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
1360 - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
1366 sub TransformHtmlToXml {
1367 my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
1368 my $xml = MARC::File::XML::header('UTF-8');
1369 $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
1370 MARC::File::XML->default_record_format($auth_type);
1371 # in UNIMARC, field 100 contains the encoding
1372 # check that there is one, otherwise the
1373 # MARC::Record->new_from_xml will fail (and Koha will die)
1374 my $unimarc_and_100_exist=0;
1375 $unimarc_and_100_exist=1 if $auth_type eq 'ITEM'; # if we rebuild an item, no need of a 100 field
1380 for ( my $i = 0 ; $i < @$tags ; $i++ ) {
1381 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a") {
1382 # if we have a 100 field and it's values are not correct, skip them.
1383 # if we don't have any valid 100 field, we will create a default one at the end
1384 my $enc = substr( @$values[$i], 26, 2 );
1385 if ($enc eq '01' or $enc eq '50' or $enc eq '03') {
1386 $unimarc_and_100_exist=1;
1391 @$values[$i] =~ s/&/&/g;
1392 @$values[$i] =~ s/</</g;
1393 @$values[$i] =~ s/>/>/g;
1394 @$values[$i] =~ s/"/"/g;
1395 @$values[$i] =~ s/'/'/g;
1396 # if ( !utf8::is_utf8( @$values[$i] ) ) {
1397 # utf8::decode( @$values[$i] );
1399 if ( ( @$tags[$i] ne $prevtag ) ) {
1400 $j++ unless ( @$tags[$i] eq "" );
1402 $xml .= "</datafield>\n";
1403 if ( ( @$tags[$i] && @$tags[$i] > 10 )
1404 && ( @$values[$i] ne "" ) )
1406 my $ind1 = substr( @$indicator[$j], 0, 1 );
1408 if ( @$indicator[$j] ) {
1409 $ind2 = substr( @$indicator[$j], 1, 1 );
1412 warn "Indicator in @$tags[$i] is empty";
1416 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1418 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1426 if ( @$values[$i] ne "" ) {
1429 if ( @$tags[$i] eq "000" ) {
1430 $xml .= "<leader>@$values[$i]</leader>\n";
1433 # rest of the fixed fields
1435 elsif ( @$tags[$i] < 10 ) {
1437 "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
1441 my $ind1 = substr( @$indicator[$j], 0, 1 );
1442 my $ind2 = substr( @$indicator[$j], 1, 1 );
1444 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1446 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1452 else { # @$tags[$i] eq $prevtag
1453 if ( @$values[$i] eq "" ) {
1457 my $ind1 = substr( @$indicator[$j], 0, 1 );
1458 my $ind2 = substr( @$indicator[$j], 1, 1 );
1460 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1464 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1467 $prevtag = @$tags[$i];
1469 $xml .= "</datafield>\n" if @$tags > 0;
1470 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and !$unimarc_and_100_exist) {
1471 # warn "SETTING 100 for $auth_type";
1472 use POSIX qw(strftime);
1473 my $string = strftime( "%Y%m%d", localtime(time) );
1474 # set 50 to position 26 is biblios, 13 if authorities
1476 $pos=13 if $auth_type eq 'UNIMARCAUTH';
1477 $string = sprintf( "%-*s", 35, $string );
1478 substr( $string, $pos , 6, "50" );
1479 $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
1480 $xml .= "<subfield code=\"a\">$string</subfield>\n";
1481 $xml .= "</datafield>\n";
1483 $xml .= MARC::File::XML::footer();
1487 =head2 TransformHtmlToMarc
1489 L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
1490 L<$params> is a ref to an array as below:
1492 'tag_010_indicator1_531951' ,
1493 'tag_010_indicator2_531951' ,
1494 'tag_010_code_a_531951_145735' ,
1495 'tag_010_subfield_a_531951_145735' ,
1496 'tag_200_indicator1_873510' ,
1497 'tag_200_indicator2_873510' ,
1498 'tag_200_code_a_873510_673465' ,
1499 'tag_200_subfield_a_873510_673465' ,
1500 'tag_200_code_b_873510_704318' ,
1501 'tag_200_subfield_b_873510_704318' ,
1502 'tag_200_code_e_873510_280822' ,
1503 'tag_200_subfield_e_873510_280822' ,
1504 'tag_200_code_f_873510_110730' ,
1505 'tag_200_subfield_f_873510_110730' ,
1507 L<$cgi> is the CGI object which containts the value.
1508 L<$record> is the MARC::Record object.
1512 sub TransformHtmlToMarc {
1516 # explicitly turn on the UTF-8 flag for all
1517 # 'tag_' parameters to avoid incorrect character
1518 # conversion later on
1519 my $cgi_params = $cgi->Vars;
1520 foreach my $param_name (keys %$cgi_params) {
1521 if ($param_name =~ /^tag_/) {
1522 my $param_value = $cgi_params->{$param_name};
1523 if (utf8::decode($param_value)) {
1524 $cgi_params->{$param_name} = $param_value;
1526 # FIXME - need to do something if string is not valid UTF-8
1530 # creating a new record
1531 my $record = MARC::Record->new();
1534 while ($params->[$i]){ # browse all CGI params
1535 my $param = $params->[$i];
1537 # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
1538 if ($param eq 'biblionumber') {
1539 my ( $biblionumbertagfield, $biblionumbertagsubfield ) =
1540 &GetMarcFromKohaField( "biblio.biblionumber", '' );
1541 if ($biblionumbertagfield < 10) {
1542 $newfield = MARC::Field->new(
1543 $biblionumbertagfield,
1544 $cgi->param($param),
1547 $newfield = MARC::Field->new(
1548 $biblionumbertagfield,
1551 "$biblionumbertagsubfield" => $cgi->param($param),
1554 push @fields,$newfield if($newfield);
1556 elsif ($param =~ /^tag_(\d*)_indicator1_/){ # new field start when having 'input name="..._indicator1_..."
1559 my $ind1 = substr($cgi->param($param),0,1);
1560 my $ind2 = substr($cgi->param($params->[$i+1]),0,1);
1564 if($tag < 10){ # no code for theses fields
1565 # in MARC editor, 000 contains the leader.
1566 if ($tag eq '000' ) {
1567 $record->leader($cgi->param($params->[$j+1])) if length($cgi->param($params->[$j+1]))==24;
1568 # between 001 and 009 (included)
1569 } elsif ($cgi->param($params->[$j+1]) ne '') {
1570 $newfield = MARC::Field->new(
1572 $cgi->param($params->[$j+1]),
1575 # > 009, deal with subfields
1577 while(defined $params->[$j] && $params->[$j] =~ /_code_/){ # browse all it's subfield
1578 my $inner_param = $params->[$j];
1580 if($cgi->param($params->[$j+1]) ne ''){ # only if there is a value (code => value)
1581 $newfield->add_subfields(
1582 $cgi->param($inner_param) => $cgi->param($params->[$j+1])
1586 if ( $cgi->param($params->[$j+1]) ne '' ) { # creating only if there is a value (code => value)
1587 $newfield = MARC::Field->new(
1591 $cgi->param($inner_param) => $cgi->param($params->[$j+1]),
1598 push @fields,$newfield if($newfield);
1603 $record->append_fields(@fields);
1607 # cache inverted MARC field map
1608 our $inverted_field_map;
1610 =head2 TransformMarcToKoha
1614 $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
1618 Extract data from a MARC bib record into a hashref representing
1619 Koha biblio, biblioitems, and items fields.
1622 sub TransformMarcToKoha {
1623 my ( $dbh, $record, $frameworkcode, $limit_table ) = @_;
1626 $limit_table=$limit_table||0;
1627 $frameworkcode = '' unless defined $frameworkcode;
1629 unless (defined $inverted_field_map) {
1630 $inverted_field_map = _get_inverted_marc_field_map();
1634 if ( defined $limit_table && $limit_table eq 'items') {
1635 $tables{'items'} = 1;
1637 $tables{'items'} = 1;
1638 $tables{'biblio'} = 1;
1639 $tables{'biblioitems'} = 1;
1642 # traverse through record
1643 MARCFIELD: foreach my $field ($record->fields()) {
1644 my $tag = $field->tag();
1645 next MARCFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag};
1646 if ($field->is_control_field()) {
1647 my $kohafields = $inverted_field_map->{$frameworkcode}->{$tag}->{list};
1648 ENTRY: foreach my $entry (@{ $kohafields }) {
1649 my ($subfield, $table, $column) = @{ $entry };
1650 next ENTRY unless exists $tables{$table};
1651 my $key = _disambiguate($table, $column);
1652 if ($result->{$key}) {
1653 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($field->data() eq "")) {
1654 $result->{$key} .= " | " . $field->data();
1657 $result->{$key} = $field->data();
1661 # deal with subfields
1662 MARCSUBFIELD: foreach my $sf ($field->subfields()) {
1663 my $code = $sf->[0];
1664 next MARCSUBFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code};
1665 my $value = $sf->[1];
1666 SFENTRY: foreach my $entry (@{ $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code} }) {
1667 my ($table, $column) = @{ $entry };
1668 next SFENTRY unless exists $tables{$table};
1669 my $key = _disambiguate($table, $column);
1670 if ($result->{$key}) {
1671 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($value eq "")) {
1672 $result->{$key} .= " | " . $value;
1675 $result->{$key} = $value;
1682 # modify copyrightdate to keep only the 1st year found
1683 if (exists $result->{'copyrightdate'}) {
1684 my $temp = $result->{'copyrightdate'};
1685 $temp =~ m/c(\d\d\d\d)/;
1686 if ( $temp =~ m/c(\d\d\d\d)/ and $1 > 0 ) { # search cYYYY first
1687 $result->{'copyrightdate'} = $1;
1689 else { # if no cYYYY, get the 1st date.
1690 $temp =~ m/(\d\d\d\d)/;
1691 $result->{'copyrightdate'} = $1;
1695 # modify publicationyear to keep only the 1st year found
1696 if (exists $result->{'publicationyear'}) {
1697 my $temp = $result->{'publicationyear'};
1698 if ( $temp =~ m/c(\d\d\d\d)/ and $1 > 0 ) { # 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 next unless @{ $relations->{$frameworkcode}->{$kohafield} }; # not all columns are mapped to MARC tag & subfield
1717 my $tag = $relations->{$frameworkcode}->{$kohafield}->[0];
1718 my $subfield = $relations->{$frameworkcode}->{$kohafield}->[1];
1719 my ($table, $column) = split /[.]/, $kohafield, 2;
1720 push @{ $field_map->{$frameworkcode}->{$tag}->{list} }, [ $subfield, $table, $column ];
1721 push @{ $field_map->{$frameworkcode}->{$tag}->{sfs}->{$subfield} }, [ $table, $column ];
1727 =head2 _disambiguate
1731 $newkey = _disambiguate($table, $field);
1733 This is a temporary hack to distinguish between the
1734 following sets of columns when using TransformMarcToKoha.
1736 items.cn_source & biblioitems.cn_source
1737 items.cn_sort & biblioitems.cn_sort
1739 Columns that are currently NOT distinguished (FIXME
1740 due to lack of time to fully test) are:
1742 biblio.notes and biblioitems.notes
1747 FIXME - this is necessary because prefixing each column
1748 name with the table name would require changing lots
1749 of code and templates, and exposing more of the DB
1750 structure than is good to the UI templates, particularly
1751 since biblio and bibloitems may well merge in a future
1752 version. In the future, it would also be good to
1753 separate DB access and UI presentation field names
1761 my ($table, $column) = @_;
1762 if ($column eq "cn_sort" or $column eq "cn_source") {
1763 return $table . '.' . $column;
1770 =head2 get_koha_field_from_marc
1774 $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
1776 Internal function to map data from the MARC record to a specific non-MARC field.
1777 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
1783 sub get_koha_field_from_marc {
1784 my ($koha_table,$koha_column,$record,$frameworkcode) = @_;
1785 my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table.'.'.$koha_column, $frameworkcode );
1787 foreach my $field ( $record->field($tagfield) ) {
1788 if ( $field->tag() < 10 ) {
1790 $kohafield .= " | " . $field->data();
1793 $kohafield = $field->data();
1797 if ( $field->subfields ) {
1798 my @subfields = $field->subfields();
1799 foreach my $subfieldcount ( 0 .. $#subfields ) {
1800 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1803 " | " . $subfields[$subfieldcount][1];
1807 $subfields[$subfieldcount][1];
1818 =head2 TransformMarcToKohaOneField
1822 $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
1828 sub TransformMarcToKohaOneField {
1830 # FIXME ? if a field has a repeatable subfield that is used in old-db,
1831 # only the 1st will be retrieved...
1832 my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
1834 my ( $tagfield, $subfield ) =
1835 GetMarcFromKohaField( $kohatable . "." . $kohafield,
1837 foreach my $field ( $record->field($tagfield) ) {
1838 if ( $field->tag() < 10 ) {
1839 if ( $result->{$kohafield} ) {
1840 $result->{$kohafield} .= " | " . $field->data();
1843 $result->{$kohafield} = $field->data();
1847 if ( $field->subfields ) {
1848 my @subfields = $field->subfields();
1849 foreach my $subfieldcount ( 0 .. $#subfields ) {
1850 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1851 if ( $result->{$kohafield} ) {
1852 $result->{$kohafield} .=
1853 " | " . $subfields[$subfieldcount][1];
1856 $result->{$kohafield} =
1857 $subfields[$subfieldcount][1];
1867 =head1 OTHER FUNCTIONS
1870 =head2 PrepareItemrecordDisplay
1874 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber);
1876 Returns a hash with all the fields for Display a given item data in a template
1882 sub PrepareItemrecordDisplay {
1884 my ( $bibnum, $itemnum, $defaultvalues ) = @_;
1886 my $dbh = C4::Context->dbh;
1887 my $frameworkcode = &GetFrameworkCode( $bibnum );
1888 my ( $itemtagfield, $itemtagsubfield ) =
1889 &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
1890 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
1891 my $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum) if ($itemnum);
1893 my $authorised_values_sth =
1895 "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib"
1897 foreach my $tag ( sort keys %{$tagslib} ) {
1898 my $previous_tag = '';
1900 # loop through each subfield
1902 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
1903 next if ( subfield_is_koha_internal_p($subfield) );
1904 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
1906 $subfield_data{tag} = $tag;
1907 $subfield_data{subfield} = $subfield;
1908 $subfield_data{countsubfield} = $cntsubf++;
1909 $subfield_data{kohafield} =
1910 $tagslib->{$tag}->{$subfield}->{'kohafield'};
1912 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
1913 $subfield_data{marc_lib} = $tagslib->{$tag}->{$subfield}->{lib};
1914 $subfield_data{mandatory} =
1915 $tagslib->{$tag}->{$subfield}->{mandatory};
1916 $subfield_data{repeatable} =
1917 $tagslib->{$tag}->{$subfield}->{repeatable};
1918 $subfield_data{hidden} = "display:none"
1919 if $tagslib->{$tag}->{$subfield}->{hidden};
1921 ( $x, $value ) = _find_value( $tag, $subfield, $itemrecord )
1923 $value =~ s/"/"/g;
1925 # search for itemcallnumber if applicable
1926 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
1927 'items.itemcallnumber'
1928 && C4::Context->preference('itemcallnumber') )
1931 substr( C4::Context->preference('itemcallnumber'), 0, 3 );
1933 substr( C4::Context->preference('itemcallnumber'), 3, 1 );
1934 my $temp = $itemrecord->field($CNtag) if ($itemrecord);
1936 $value = $temp->subfield($CNsubfield);
1939 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
1940 'items.itemcallnumber'
1941 && $defaultvalues->{'callnumber'} )
1943 my $temp = $itemrecord->field($subfield) if ($itemrecord);
1945 $value = $defaultvalues->{'callnumber'};
1948 if ( ($tagslib->{$tag}->{$subfield}->{kohafield} eq
1949 'items.holdingbranch' ||
1950 $tagslib->{$tag}->{$subfield}->{kohafield} eq
1952 && $defaultvalues->{'branchcode'} )
1954 my $temp = $itemrecord->field($subfield) if ($itemrecord);
1956 $value = $defaultvalues->{branchcode};
1959 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
1960 my @authorised_values;
1963 # builds list, depending on authorised value...
1965 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq
1968 if ( ( C4::Context->preference("IndependantBranches") )
1969 && ( C4::Context->userenv->{flags} != 1 ) )
1973 "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname"
1975 $sth->execute( C4::Context->userenv->{branch} );
1976 push @authorised_values, ""
1978 $tagslib->{$tag}->{$subfield}->{mandatory} );
1979 while ( my ( $branchcode, $branchname ) =
1980 $sth->fetchrow_array )
1982 push @authorised_values, $branchcode;
1983 $authorised_lib{$branchcode} = $branchname;
1989 "SELECT branchcode,branchname FROM branches ORDER BY branchname"
1992 push @authorised_values, ""
1994 $tagslib->{$tag}->{$subfield}->{mandatory} );
1995 while ( my ( $branchcode, $branchname ) =
1996 $sth->fetchrow_array )
1998 push @authorised_values, $branchcode;
1999 $authorised_lib{$branchcode} = $branchname;
2005 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq
2010 "SELECT itemtype,description FROM itemtypes ORDER BY description"
2013 push @authorised_values, ""
2014 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2015 while ( my ( $itemtype, $description ) =
2016 $sth->fetchrow_array )
2018 push @authorised_values, $itemtype;
2019 $authorised_lib{$itemtype} = $description;
2022 #---- "true" authorised value
2025 $authorised_values_sth->execute(
2026 $tagslib->{$tag}->{$subfield}->{authorised_value} );
2027 push @authorised_values, ""
2028 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2029 while ( my ( $value, $lib ) =
2030 $authorised_values_sth->fetchrow_array )
2032 push @authorised_values, $value;
2033 $authorised_lib{$value} = $lib;
2036 $subfield_data{marc_value} = CGI::scrolling_list(
2037 -name => 'field_value',
2038 -values => \@authorised_values,
2039 -default => "$value",
2040 -labels => \%authorised_lib,
2047 $subfield_data{marc_value} =
2048 "<input type=\"text\" name=\"field_value\" value=\"$value\" size=\"50\" maxlength=\"255\" />";
2050 push( @loop_data, \%subfield_data );
2054 my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
2055 if ( $itemrecord && $itemrecord->field($itemtagfield) );
2057 'itemtagfield' => $itemtagfield,
2058 'itemtagsubfield' => $itemtagsubfield,
2059 'itemnumber' => $itemnumber,
2060 'iteminformation' => \@loop_data
2066 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2068 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2069 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2070 # =head2 ModZebrafiles
2072 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
2076 # sub ModZebrafiles {
2078 # my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
2082 # C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
2083 # unless ( opendir( DIR, "$zebradir" ) ) {
2084 # warn "$zebradir not found";
2088 # my $filename = $zebradir . $biblionumber;
2091 # open( OUTPUT, ">", $filename . ".xml" );
2092 # print OUTPUT $record;
2101 ModZebra( $biblionumber, $op, $server, $oldRecord, $newRecord );
2103 $biblionumber is the biblionumber we want to index
2104 $op is specialUpdate or delete, and is used to know what we want to do
2105 $server is the server that we want to update
2106 $oldRecord is the MARC::Record containing the previous version of the record. This is used only when
2107 NoZebra=1, as NoZebra indexing needs to know the previous version of a record in order to
2109 $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.
2116 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
2117 my ( $biblionumber, $op, $server, $oldRecord, $newRecord ) = @_;
2118 my $dbh=C4::Context->dbh;
2120 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2122 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2123 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2125 if (C4::Context->preference("NoZebra")) {
2126 # lock the nozebra table : we will read index lines, update them in Perl process
2127 # and write everything in 1 transaction.
2128 # lock the table to avoid someone else overwriting what we are doing
2129 $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE, auth_subfield_structure READ');
2130 my %result; # the result hash that will be built by deletion / add, and written on mySQL at the end, to improve speed
2131 if ($op eq 'specialUpdate') {
2132 # OK, we have to add or update the record
2133 # 1st delete (virtually, in indexes), if record actually exists
2135 %result = _DelBiblioNoZebra($biblionumber,$oldRecord,$server);
2137 # ... add the record
2138 %result=_AddBiblioNoZebra($biblionumber,$newRecord, $server, %result);
2140 # it's a deletion, delete the record...
2141 # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
2142 %result=_DelBiblioNoZebra($biblionumber,$oldRecord,$server);
2144 # ok, now update the database...
2145 my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
2146 foreach my $key (keys %result) {
2147 foreach my $index (keys %{$result{$key}}) {
2148 $sth->execute($result{$key}->{$index}, $server, $key, $index);
2151 $dbh->do('UNLOCK TABLES');
2154 # we use zebra, just fill zebraqueue table
2156 my $check_sql = "SELECT COUNT(*) FROM zebraqueue
2158 AND biblio_auth_number = ?
2161 my $check_sth = $dbh->prepare_cached($check_sql);
2162 $check_sth->execute($server, $biblionumber, $op);
2163 my ($count) = $check_sth->fetchrow_array;
2164 $check_sth->finish();
2166 my $sth=$dbh->prepare("INSERT INTO zebraqueue (biblio_auth_number,server,operation) VALUES(?,?,?)");
2167 $sth->execute($biblionumber,$server,$op);
2173 =head2 GetNoZebraIndexes
2175 %indexes = GetNoZebraIndexes;
2177 return the data from NoZebraIndexes syspref.
2181 sub GetNoZebraIndexes {
2182 my $no_zebra_indexes = C4::Context->preference('NoZebraIndexes');
2184 INDEX: foreach my $line (split /['"],[\n\r]*/,$no_zebra_indexes) {
2185 $line =~ /(.*)=>(.*)/;
2186 my $index = $1; # initial ' or " is removed afterwards
2188 $index =~ s/'|"|\s//g;
2189 $fields =~ s/'|"|\s//g;
2190 $indexes{$index}=$fields;
2195 =head1 INTERNAL FUNCTIONS
2197 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
2199 function to delete a biblio in NoZebra indexes
2200 This function does NOT delete anything in database : it reads all the indexes entries
2201 that have to be deleted & delete them in the hash
2202 The SQL part is done either :
2203 - after the Add if we are modifying a biblio (delete + add again)
2204 - immediatly after this sub if we are doing a true deletion.
2205 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
2210 sub _DelBiblioNoZebra {
2211 my ($biblionumber, $record, $server)=@_;
2214 my $dbh = C4::Context->dbh;
2218 if ($server eq 'biblioserver') {
2219 %index=GetNoZebraIndexes;
2220 # get title of the record (to store the 10 first letters with the index)
2221 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title', ''); # FIXME: should be GetFrameworkCode($biblionumber) ??
2222 $title = lc($record->subfield($titletag,$titlesubfield));
2224 # for authorities, the "title" is the $a mainentry
2225 my ($auth_type_tag, $auth_type_sf) = C4::AuthoritiesMarc::get_auth_type_location();
2226 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield($auth_type_tag, $auth_type_sf));
2227 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2228 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2229 $index{'mainmainentry'}= $authref->{'auth_tag_to_report'}.'a';
2230 $index{'mainentry'} = $authref->{'auth_tag_to_report'}.'*';
2231 $index{'auth_type'} = "${auth_type_tag}${auth_type_sf}";
2235 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2236 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
2237 # limit to 10 char, should be enough, and limit the DB size
2238 $title = substr($title,0,10);
2240 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2241 foreach my $field ($record->fields()) {
2242 #parse each subfield
2243 next if $field->tag <10;
2244 foreach my $subfield ($field->subfields()) {
2245 my $tag = $field->tag();
2246 my $subfieldcode = $subfield->[0];
2248 # check each index to see if the subfield is stored somewhere
2249 # otherwise, store it in __RAW__ index
2250 foreach my $key (keys %index) {
2251 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2252 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2254 my $line= lc $subfield->[1];
2255 # remove meaningless value in the field...
2256 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2257 # ... and split in words
2258 foreach (split / /,$line) {
2259 next unless $_; # skip empty values (multiple spaces)
2260 # if the entry is already here, do nothing, the biblionumber has already be removed
2261 unless ( defined( $result{$key}->{$_} ) && ( $result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/) ) {
2262 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2263 $sth2->execute($server,$key,$_);
2264 my $existing_biblionumbers = $sth2->fetchrow;
2266 if ($existing_biblionumbers) {
2267 # warn " existing for $key $_: $existing_biblionumbers";
2268 $result{$key}->{$_} =$existing_biblionumbers;
2269 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2275 # the subfield is not indexed, store it in __RAW__ index anyway
2277 my $line= lc $subfield->[1];
2278 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2279 # ... and split in words
2280 foreach (split / /,$line) {
2281 next unless $_; # skip empty values (multiple spaces)
2282 # if the entry is already here, do nothing, the biblionumber has already be removed
2283 unless ($result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2284 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2285 $sth2->execute($server,'__RAW__',$_);
2286 my $existing_biblionumbers = $sth2->fetchrow;
2288 if ($existing_biblionumbers) {
2289 $result{'__RAW__'}->{$_} =$existing_biblionumbers;
2290 $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2300 =head2 _AddBiblioNoZebra($biblionumber, $record, $server, %result);
2302 function to add a biblio in NoZebra indexes
2306 sub _AddBiblioNoZebra {
2307 my ($biblionumber, $record, $server, %result)=@_;
2308 my $dbh = C4::Context->dbh;
2312 if ($server eq 'biblioserver') {
2313 %index=GetNoZebraIndexes;
2314 # get title of the record (to store the 10 first letters with the index)
2315 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title', ''); # FIXME: should be GetFrameworkCode($biblionumber) ??
2316 $title = lc($record->subfield($titletag,$titlesubfield));
2318 # warn "server : $server";
2319 # for authorities, the "title" is the $a mainentry
2320 my ($auth_type_tag, $auth_type_sf) = C4::AuthoritiesMarc::get_auth_type_location();
2321 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield($auth_type_tag, $auth_type_sf));
2322 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2323 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2324 $index{'mainmainentry'} = $authref->{auth_tag_to_report}.'a';
2325 $index{'mainentry'} = $authref->{auth_tag_to_report}.'*';
2326 $index{'auth_type'} = "${auth_type_tag}${auth_type_sf}";
2329 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2330 $title =~ s/ |\.|,|;|\[|\]|\(|\)|\*|-|'|:|=|\r|\n//g;
2331 # limit to 10 char, should be enough, and limit the DB size
2332 $title = substr($title,0,10);
2334 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2335 foreach my $field ($record->fields()) {
2336 #parse each subfield
2337 ###FIXME: impossible to index a 001-009 value with NoZebra
2338 next if $field->tag <10;
2339 foreach my $subfield ($field->subfields()) {
2340 my $tag = $field->tag();
2341 my $subfieldcode = $subfield->[0];
2343 # warn "INDEXING :".$subfield->[1];
2344 # check each index to see if the subfield is stored somewhere
2345 # otherwise, store it in __RAW__ index
2346 foreach my $key (keys %index) {
2347 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2348 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2350 my $line= lc $subfield->[1];
2351 # remove meaningless value in the field...
2352 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2353 # ... and split in words
2354 foreach (split / /,$line) {
2355 next unless $_; # skip empty values (multiple spaces)
2356 # if the entry is already here, improve weight
2357 # warn "managing $_";
2358 if ( exists $result{$key}->{$_} && $result{$key}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d+);/) {
2359 my $weight = $1 + 1;
2360 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d+);//g;
2361 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2363 # get the value if it exist in the nozebra table, otherwise, create it
2364 $sth2->execute($server,$key,$_);
2365 my $existing_biblionumbers = $sth2->fetchrow;
2367 if ($existing_biblionumbers) {
2368 $result{$key}->{"$_"} =$existing_biblionumbers;
2369 my $weight = defined $1 ? $1 + 1 : 1;
2370 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d+);//g;
2371 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2372 # create a new ligne for this entry
2374 # warn "INSERT : $server / $key / $_";
2375 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname='.$dbh->quote($key).',value='.$dbh->quote($_));
2376 $result{$key}->{"$_"}.="$biblionumber,$title-1;";
2382 # the subfield is not indexed, store it in __RAW__ index anyway
2384 my $line= lc $subfield->[1];
2385 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2386 # ... and split in words
2387 foreach (split / /,$line) {
2388 next unless $_; # skip empty values (multiple spaces)
2389 # if the entry is already here, improve weight
2390 if ($result{'__RAW__'}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d+);/) {
2392 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d+);//;
2393 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2395 # get the value if it exist in the nozebra table, otherwise, create it
2396 $sth2->execute($server,'__RAW__',$_);
2397 my $existing_biblionumbers = $sth2->fetchrow;
2399 if ($existing_biblionumbers) {
2400 $result{'__RAW__'}->{"$_"} =$existing_biblionumbers;
2402 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d+);//;
2403 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2404 # create a new ligne for this entry
2406 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname="__RAW__",value='.$dbh->quote($_));
2407 $result{'__RAW__'}->{"$_"}.="$biblionumber,$title-1;";
2422 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2424 Find the given $subfield in the given $tag in the given
2425 MARC::Record $record. If the subfield is found, returns
2426 the (indicators, value) pair; otherwise, (undef, undef) is
2430 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2431 I suggest we export it from this module.
2438 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2441 if ( $tagfield < 10 ) {
2442 if ( $record->field($tagfield) ) {
2443 push @result, $record->field($tagfield)->data();
2450 foreach my $field ( $record->field($tagfield) ) {
2451 my @subfields = $field->subfields();
2452 foreach my $subfield (@subfields) {
2453 if ( @$subfield[0] eq $insubfield ) {
2454 push @result, @$subfield[1];
2455 $indicator = $field->indicator(1) . $field->indicator(2);
2460 return ( $indicator, @result );
2463 =head2 _koha_marc_update_bib_ids
2467 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
2469 Internal function to add or update biblionumber and biblioitemnumber to
2476 sub _koha_marc_update_bib_ids {
2477 my ($record, $frameworkcode, $biblionumber, $biblioitemnumber) = @_;
2479 # we must add bibnum and bibitemnum in MARC::Record...
2480 # we build the new field with biblionumber and biblioitemnumber
2481 # we drop the original field
2482 # we add the new builded field.
2483 my ($biblio_tag, $biblio_subfield ) = GetMarcFromKohaField("biblio.biblionumber",$frameworkcode);
2484 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.biblioitemnumber",$frameworkcode);
2486 if ($biblio_tag != $biblioitem_tag) {
2487 # biblionumber & biblioitemnumber are in different fields
2489 # deal with biblionumber
2490 my ($new_field, $old_field);
2491 if ($biblio_tag < 10) {
2492 $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
2495 MARC::Field->new( $biblio_tag, '', '',
2496 "$biblio_subfield" => $biblionumber );
2499 # drop old field and create new one...
2500 $old_field = $record->field($biblio_tag);
2501 $record->delete_field($old_field) if $old_field;
2502 $record->append_fields($new_field);
2504 # deal with biblioitemnumber
2505 if ($biblioitem_tag < 10) {
2506 $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
2509 MARC::Field->new( $biblioitem_tag, '', '',
2510 "$biblioitem_subfield" => $biblioitemnumber, );
2512 # drop old field and create new one...
2513 $old_field = $record->field($biblioitem_tag);
2514 $record->delete_field($old_field) if $old_field;
2515 $record->insert_fields_ordered($new_field);
2518 # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
2519 my $new_field = MARC::Field->new(
2520 $biblio_tag, '', '',
2521 "$biblio_subfield" => $biblionumber,
2522 "$biblioitem_subfield" => $biblioitemnumber
2525 # drop old field and create new one...
2526 my $old_field = $record->field($biblio_tag);
2527 $record->delete_field($old_field) if $old_field;
2528 $record->insert_fields_ordered($new_field);
2532 =head2 _koha_marc_update_biblioitem_cn_sort
2536 _koha_marc_update_biblioitem_cn_sort($marc, $biblioitem, $frameworkcode);
2540 Given a MARC bib record and the biblioitem hash, update the
2541 subfield that contains a copy of the value of biblioitems.cn_sort.
2545 sub _koha_marc_update_biblioitem_cn_sort {
2547 my $biblioitem = shift;
2548 my $frameworkcode= shift;
2550 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.cn_sort",$frameworkcode);
2551 return unless $biblioitem_tag;
2553 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2555 if (my $field = $marc->field($biblioitem_tag)) {
2556 $field->delete_subfield(code => $biblioitem_subfield);
2557 if ($cn_sort ne '') {
2558 $field->add_subfields($biblioitem_subfield => $cn_sort);
2561 # if we get here, no biblioitem tag is present in the MARC record, so
2562 # we'll create it if $cn_sort is not empty -- this would be
2563 # an odd combination of events, however
2565 $marc->insert_grouped_field(MARC::Field->new($biblioitem_tag, ' ', ' ', $biblioitem_subfield => $cn_sort));
2570 =head2 _koha_add_biblio
2574 my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
2576 Internal function to add a biblio ($biblio is a hash with the values)
2582 sub _koha_add_biblio {
2583 my ( $dbh, $biblio, $frameworkcode ) = @_;
2587 # set the series flag
2589 if ( $biblio->{'seriestitle'} ) { $serial = 1 };
2593 SET frameworkcode = ?,
2604 my $sth = $dbh->prepare($query);
2607 $biblio->{'author'},
2609 $biblio->{'unititle'},
2612 $biblio->{'seriestitle'},
2613 $biblio->{'copyrightdate'},
2614 $biblio->{'abstract'}
2617 my $biblionumber = $dbh->{'mysql_insertid'};
2618 if ( $dbh->errstr ) {
2619 $error.="ERROR in _koha_add_biblio $query".$dbh->errstr;
2624 #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
2625 return ($biblionumber,$error);
2628 =head2 _koha_modify_biblio
2632 my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
2634 Internal function for updating the biblio table
2640 sub _koha_modify_biblio {
2641 my ( $dbh, $biblio, $frameworkcode ) = @_;
2646 SET frameworkcode = ?,
2655 WHERE biblionumber = ?
2658 my $sth = $dbh->prepare($query);
2662 $biblio->{'author'},
2664 $biblio->{'unititle'},
2666 $biblio->{'serial'},
2667 $biblio->{'seriestitle'},
2668 $biblio->{'copyrightdate'},
2669 $biblio->{'abstract'},
2670 $biblio->{'biblionumber'}
2671 ) if $biblio->{'biblionumber'};
2673 if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
2674 $error.="ERROR in _koha_modify_biblio $query".$dbh->errstr;
2677 return ( $biblio->{'biblionumber'},$error );
2680 =head2 _koha_modify_biblioitem_nonmarc
2684 my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
2686 Updates biblioitems row except for marc and marcxml, which should be changed
2693 sub _koha_modify_biblioitem_nonmarc {
2694 my ( $dbh, $biblioitem ) = @_;
2697 # re-calculate the cn_sort, it may have changed
2698 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2702 SET biblionumber = ?,
2708 publicationyear = ?,
2712 collectiontitle = ?,
2714 collectionvolume= ?,
2715 editionstatement= ?,
2716 editionresponsibility = ?,
2730 where biblioitemnumber = ?
2732 my $sth = $dbh->prepare($query);
2734 $biblioitem->{'biblionumber'},
2735 $biblioitem->{'volume'},
2736 $biblioitem->{'number'},
2737 $biblioitem->{'itemtype'},
2738 $biblioitem->{'isbn'},
2739 $biblioitem->{'issn'},
2740 $biblioitem->{'publicationyear'},
2741 $biblioitem->{'publishercode'},
2742 $biblioitem->{'volumedate'},
2743 $biblioitem->{'volumedesc'},
2744 $biblioitem->{'collectiontitle'},
2745 $biblioitem->{'collectionissn'},
2746 $biblioitem->{'collectionvolume'},
2747 $biblioitem->{'editionstatement'},
2748 $biblioitem->{'editionresponsibility'},
2749 $biblioitem->{'illus'},
2750 $biblioitem->{'pages'},
2751 $biblioitem->{'bnotes'},
2752 $biblioitem->{'size'},
2753 $biblioitem->{'place'},
2754 $biblioitem->{'lccn'},
2755 $biblioitem->{'url'},
2756 $biblioitem->{'biblioitems.cn_source'},
2757 $biblioitem->{'cn_class'},
2758 $biblioitem->{'cn_item'},
2759 $biblioitem->{'cn_suffix'},
2761 $biblioitem->{'totalissues'},
2762 $biblioitem->{'biblioitemnumber'}
2764 if ( $dbh->errstr ) {
2765 $error.="ERROR in _koha_modify_biblioitem_nonmarc $query".$dbh->errstr;
2768 return ($biblioitem->{'biblioitemnumber'},$error);
2771 =head2 _koha_add_biblioitem
2775 my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
2777 Internal function to add a biblioitem
2783 sub _koha_add_biblioitem {
2784 my ( $dbh, $biblioitem ) = @_;
2787 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2789 "INSERT INTO biblioitems SET
2796 publicationyear = ?,
2800 collectiontitle = ?,
2802 collectionvolume= ?,
2803 editionstatement= ?,
2804 editionresponsibility = ?,
2820 my $sth = $dbh->prepare($query);
2822 $biblioitem->{'biblionumber'},
2823 $biblioitem->{'volume'},
2824 $biblioitem->{'number'},
2825 $biblioitem->{'itemtype'},
2826 $biblioitem->{'isbn'},
2827 $biblioitem->{'issn'},
2828 $biblioitem->{'publicationyear'},
2829 $biblioitem->{'publishercode'},
2830 $biblioitem->{'volumedate'},
2831 $biblioitem->{'volumedesc'},
2832 $biblioitem->{'collectiontitle'},
2833 $biblioitem->{'collectionissn'},
2834 $biblioitem->{'collectionvolume'},
2835 $biblioitem->{'editionstatement'},
2836 $biblioitem->{'editionresponsibility'},
2837 $biblioitem->{'illus'},
2838 $biblioitem->{'pages'},
2839 $biblioitem->{'bnotes'},
2840 $biblioitem->{'size'},
2841 $biblioitem->{'place'},
2842 $biblioitem->{'lccn'},
2843 $biblioitem->{'marc'},
2844 $biblioitem->{'url'},
2845 $biblioitem->{'biblioitems.cn_source'},
2846 $biblioitem->{'cn_class'},
2847 $biblioitem->{'cn_item'},
2848 $biblioitem->{'cn_suffix'},
2850 $biblioitem->{'totalissues'}
2852 my $bibitemnum = $dbh->{'mysql_insertid'};
2853 if ( $dbh->errstr ) {
2854 $error.="ERROR in _koha_add_biblioitem $query".$dbh->errstr;
2858 return ($bibitemnum,$error);
2861 =head2 _koha_delete_biblio
2865 $error = _koha_delete_biblio($dbh,$biblionumber);
2867 Internal sub for deleting from biblio table -- also saves to deletedbiblio
2869 C<$dbh> - the database handle
2870 C<$biblionumber> - the biblionumber of the biblio to be deleted
2876 # FIXME: add error handling
2878 sub _koha_delete_biblio {
2879 my ( $dbh, $biblionumber ) = @_;
2881 # get all the data for this biblio
2882 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
2883 $sth->execute($biblionumber);
2885 if ( my $data = $sth->fetchrow_hashref ) {
2887 # save the record in deletedbiblio
2888 # find the fields to save
2889 my $query = "INSERT INTO deletedbiblio SET ";
2891 foreach my $temp ( keys %$data ) {
2892 $query .= "$temp = ?,";
2893 push( @bind, $data->{$temp} );
2896 # replace the last , by ",?)"
2898 my $bkup_sth = $dbh->prepare($query);
2899 $bkup_sth->execute(@bind);
2903 my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
2904 $del_sth->execute($biblionumber);
2911 =head2 _koha_delete_biblioitems
2915 $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
2917 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
2919 C<$dbh> - the database handle
2920 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
2926 # FIXME: add error handling
2928 sub _koha_delete_biblioitems {
2929 my ( $dbh, $biblioitemnumber ) = @_;
2931 # get all the data for this biblioitem
2933 $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
2934 $sth->execute($biblioitemnumber);
2936 if ( my $data = $sth->fetchrow_hashref ) {
2938 # save the record in deletedbiblioitems
2939 # find the fields to save
2940 my $query = "INSERT INTO deletedbiblioitems SET ";
2942 foreach my $temp ( keys %$data ) {
2943 $query .= "$temp = ?,";
2944 push( @bind, $data->{$temp} );
2947 # replace the last , by ",?)"
2949 my $bkup_sth = $dbh->prepare($query);
2950 $bkup_sth->execute(@bind);
2953 # delete the biblioitem
2955 $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
2956 $del_sth->execute($biblioitemnumber);
2963 =head1 UNEXPORTED FUNCTIONS
2965 =head2 ModBiblioMarc
2967 &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
2969 Add MARC data for a biblio to koha
2971 Function exported, but should NOT be used, unless you really know what you're doing
2977 # pass the MARC::Record to this function, and it will create the records in the marc field
2978 my ( $record, $biblionumber, $frameworkcode ) = @_;
2979 my $dbh = C4::Context->dbh;
2980 my @fields = $record->fields();
2981 if ( !$frameworkcode ) {
2982 $frameworkcode = "";
2985 $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
2986 $sth->execute( $frameworkcode, $biblionumber );
2988 my $encoding = C4::Context->preference("marcflavour");
2990 # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
2991 if ( $encoding eq "UNIMARC" ) {
2993 if ( length($record->subfield( 100, "a" )) == 35 ) {
2994 $string = $record->subfield( 100, "a" );
2995 my $f100 = $record->field(100);
2996 $record->delete_field($f100);
2999 $string = POSIX::strftime( "%Y%m%d", localtime );
3001 $string = sprintf( "%-*s", 35, $string );
3003 substr( $string, 22, 6, "frey50" );
3004 unless ( $record->subfield( 100, "a" ) ) {
3005 $record->insert_grouped_field(
3006 MARC::Field->new( 100, "", "", "a" => $string ) );
3010 if (C4::Context->preference("NoZebra")) {
3011 # only NoZebra indexing needs to have
3012 # the previous version of the record
3013 $oldRecord = GetMarcBiblio($biblionumber);
3017 "UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
3018 $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding),
3021 ModZebra($biblionumber,"specialUpdate","biblioserver",$oldRecord,$record);
3022 return $biblionumber;
3025 =head2 z3950_extended_services
3027 z3950_extended_services($serviceType,$serviceOptions,$record);
3029 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.
3031 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
3033 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
3035 action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
3039 recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
3040 syntax => the record syntax (transfer syntax)
3041 databaseName = Database from connection object
3043 To set serviceOptions, call set_service_options($serviceType)
3045 C<$record> the record, if one is needed for the service type
3047 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
3051 sub z3950_extended_services {
3052 my ( $server, $serviceType, $action, $serviceOptions ) = @_;
3054 # get our connection object
3055 my $Zconn = C4::Context->Zconn( $server, 0, 1 );
3057 # create a new package object
3058 my $Zpackage = $Zconn->package();
3061 $Zpackage->option( action => $action );
3063 if ( $serviceOptions->{'databaseName'} ) {
3064 $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
3066 if ( $serviceOptions->{'recordIdNumber'} ) {
3068 recordIdNumber => $serviceOptions->{'recordIdNumber'} );
3070 if ( $serviceOptions->{'recordIdOpaque'} ) {
3072 recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
3075 # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
3076 #if ($serviceType eq 'itemorder') {
3077 # $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
3078 # $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
3079 # $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
3080 # $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
3083 if ( $serviceOptions->{record} ) {
3084 $Zpackage->option( record => $serviceOptions->{record} );
3086 # can be xml or marc
3087 if ( $serviceOptions->{'syntax'} ) {
3088 $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
3092 # send the request, handle any exception encountered
3093 eval { $Zpackage->send($serviceType) };
3094 if ( $@ && $@->isa("ZOOM::Exception") ) {
3095 return "error: " . $@->code() . " " . $@->message() . "\n";
3098 # free up package resources
3099 $Zpackage->destroy();
3102 =head2 set_service_options
3104 my $serviceOptions = set_service_options($serviceType);
3106 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
3108 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
3112 sub set_service_options {
3113 my ($serviceType) = @_;
3116 # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
3117 # $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
3119 if ( $serviceType eq 'commit' ) {
3123 if ( $serviceType eq 'create' ) {
3127 if ( $serviceType eq 'drop' ) {
3128 die "ERROR: 'drop' not currently supported (by Zebra)";
3130 return $serviceOptions;
3133 =head3 get_biblio_authorised_values
3135 find the types and values for all authorised values assigned to this biblio.
3139 MARC::Record of the bib
3141 returns: a hashref malling the authorised value to the value set for this biblionumber
3143 $authorised_values = {
3144 'Scent' => 'flowery',
3145 'Audience' => 'Young Adult',
3146 'itemtypes' => 'SER',
3149 Notes: forlibrarian should probably be passed in, and called something different.
3154 sub get_biblio_authorised_values {
3155 my $biblionumber = shift;
3158 my $forlibrarian = 1; # are we in staff or opac?
3159 my $frameworkcode = GetFrameworkCode( $biblionumber );
3161 my $authorised_values;
3163 my $tagslib = GetMarcStructure( $forlibrarian, $frameworkcode )
3164 or return $authorised_values;
3166 # assume that these entries in the authorised_value table are bibliolevel.
3167 # ones that start with 'item%' are item level.
3168 my $query = q(SELECT distinct authorised_value, kohafield
3169 FROM marc_subfield_structure
3170 WHERE authorised_value !=''
3171 AND (kohafield like 'biblio%'
3172 OR kohafield like '') );
3173 my $bibliolevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
3175 foreach my $tag ( keys( %$tagslib ) ) {
3176 foreach my $subfield ( keys( %{$tagslib->{ $tag }} ) ) {
3177 # warn "checking $subfield. type is: " . ref $tagslib->{ $tag }{ $subfield };
3178 if ( 'HASH' eq ref $tagslib->{ $tag }{ $subfield } ) {
3179 if ( defined $tagslib->{ $tag }{ $subfield }{'authorised_value'} && exists $bibliolevel_authorised_values->{ $tagslib->{ $tag }{ $subfield }{'authorised_value'} } ) {
3180 if ( defined $record->field( $tag ) ) {
3181 my $this_subfield_value = $record->field( $tag )->subfield( $subfield );
3182 if ( defined $this_subfield_value ) {
3183 $authorised_values->{ $tagslib->{ $tag }{ $subfield }{'authorised_value'} } = $this_subfield_value;
3190 # warn ( Data::Dumper->Dump( [ $authorised_values ], [ 'authorised_values' ] ) );
3191 return $authorised_values;
3201 Koha Developement team <info@koha.org>
3203 Paul POULAIN paul.poulain@free.fr
3205 Joshua Ferraro jmf@liblime.com