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 );
249 ModBiblio( $record,$biblionumber,$frameworkcode);
250 Exported function (core API) to modify a biblio
255 my ( $record, $biblionumber, $frameworkcode ) = @_;
256 if (C4::Context->preference("CataloguingLog")) {
257 my $newrecord = GetMarcBiblio($biblionumber);
258 logaction("CATALOGUING", "MODIFY", $biblionumber, "BEFORE=>".$newrecord->as_formatted);
261 my $dbh = C4::Context->dbh;
263 $frameworkcode = "" unless $frameworkcode;
265 # get the items before and append them to the biblio before updating the record, atm we just have the biblio
266 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
267 my $oldRecord = GetMarcBiblio( $biblionumber );
269 # parse each item, and, for an unknown reason, re-encode each subfield
270 # if you don't do that, the record will have encoding mixed
271 # and the biblio will be re-encoded.
272 # strange, I (Paul P.) searched more than 1 day to understand what happends
273 # but could only solve the problem this way...
274 my @fields = $oldRecord->field( $itemtag );
275 foreach my $fielditem ( @fields ){
277 foreach ($fielditem->subfields()) {
279 $field->add_subfields(Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
281 $field = MARC::Field->new("$itemtag",'','',Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
284 $record->append_fields($field);
287 # update biblionumber and biblioitemnumber in MARC
288 # FIXME - this is assuming a 1 to 1 relationship between
289 # biblios and biblioitems
290 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
291 $sth->execute($biblionumber);
292 my ($biblioitemnumber) = $sth->fetchrow;
294 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
296 # load the koha-table data object
297 my $oldbiblio = TransformMarcToKoha( $dbh, $record, $frameworkcode );
299 # update MARC subfield that stores biblioitems.cn_sort
300 _koha_marc_update_biblioitem_cn_sort($record, $oldbiblio, $frameworkcode);
302 # update the MARC record (that now contains biblio and items) with the new record data
303 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
305 # modify the other koha tables
306 _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
307 _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
311 =head2 ModBiblioframework
313 ModBiblioframework($biblionumber,$frameworkcode);
314 Exported function to modify a biblio framework
318 sub ModBiblioframework {
319 my ( $biblionumber, $frameworkcode ) = @_;
320 my $dbh = C4::Context->dbh;
321 my $sth = $dbh->prepare(
322 "UPDATE biblio SET frameworkcode=? WHERE biblionumber=?"
324 $sth->execute($frameworkcode, $biblionumber);
332 my $error = &DelBiblio($dbh,$biblionumber);
333 Exported function (core API) for deleting a biblio in koha.
334 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
335 Also backs it up to deleted* tables
336 Checks to make sure there are not issues on any of the items
338 C<$error> : undef unless an error occurs
345 my ( $biblionumber ) = @_;
346 my $dbh = C4::Context->dbh;
347 my $error; # for error handling
349 # First make sure this biblio has no items attached
350 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
351 $sth->execute($biblionumber);
352 if (my $itemnumber = $sth->fetchrow){
353 # Fix this to use a status the template can understand
354 $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
357 return $error if $error;
359 # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
360 # for at least 2 reasons :
361 # - we need to read the biblio if NoZebra is set (to remove it from the indexes
362 # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
363 # 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)
365 if (C4::Context->preference("NoZebra")) {
366 # only NoZebra indexing needs to have
367 # the previous version of the record
368 $oldRecord = GetMarcBiblio($biblionumber);
370 ModZebra($biblionumber, "recordDelete", "biblioserver", $oldRecord, undef);
372 # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
375 "SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
376 $sth->execute($biblionumber);
377 while ( my $biblioitemnumber = $sth->fetchrow ) {
379 # delete this biblioitem
380 $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
381 return $error if $error;
384 # delete biblio from Koha tables and save in deletedbiblio
385 # must do this *after* _koha_delete_biblioitems, otherwise
386 # delete cascade will prevent deletedbiblioitems rows
387 # from being generated by _koha_delete_biblioitems
388 $error = _koha_delete_biblio( $dbh, $biblionumber );
390 logaction("CATALOGUING", "DELETE", $biblionumber, "") if C4::Context->preference("CataloguingLog");
395 =head2 LinkBibHeadingsToAuthorities
399 my $headings_linked = LinkBibHeadingsToAuthorities($marc);
403 Links bib headings to authority records by checking
404 each authority-controlled field in the C<MARC::Record>
405 object C<$marc>, looking for a matching authority record,
406 and setting the linking subfield $9 to the ID of that
409 If no matching authority exists, or if multiple
410 authorities match, no $9 will be added, and any
411 existing one inthe field will be deleted.
413 Returns the number of heading links changed in the
418 sub LinkBibHeadingsToAuthorities {
421 my $num_headings_changed = 0;
422 foreach my $field ($bib->fields()) {
423 my $heading = C4::Heading->new_from_bib_field($field);
424 next unless defined $heading;
427 my $current_link = $field->subfield('9');
429 # look for matching authorities
430 my $authorities = $heading->authorities();
432 # want only one exact match
433 if ($#{ $authorities } == 0) {
434 my $authority = MARC::Record->new_from_usmarc($authorities->[0]);
435 my $authid = $authority->field('001')->data();
436 next if defined $current_link and $current_link eq $authid;
438 $field->delete_subfield(code => '9') if defined $current_link;
439 $field->add_subfields('9', $authid);
440 $num_headings_changed++;
442 if (defined $current_link) {
443 $field->delete_subfield(code => '9');
444 $num_headings_changed++;
449 return $num_headings_changed;
456 $data = &GetBiblioData($biblionumber);
457 Returns information about the book with the given biblionumber.
458 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
459 the C<biblio> and C<biblioitems> tables in the
461 In addition, C<$data-E<gt>{subject}> is the list of the book's
462 subjects, separated by C<" , "> (space, comma, space).
463 If there are multiple biblioitems with the given biblionumber, only
464 the first one is considered.
472 my $dbh = C4::Context->dbh;
474 # my $query = C4::Context->preference('item-level_itypes') ?
475 # " SELECT * , biblioitems.notes AS bnotes, biblio.notes
477 # LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
478 # WHERE biblio.biblionumber = ?
479 # AND biblioitems.biblionumber = biblio.biblionumber
482 my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
484 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
485 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
486 WHERE biblio.biblionumber = ?
487 AND biblioitems.biblionumber = biblio.biblionumber ";
489 my $sth = $dbh->prepare($query);
490 $sth->execute($bibnum);
492 $data = $sth->fetchrow_hashref;
496 } # sub GetBiblioData
498 =head2 &GetBiblioItemData
502 $itemdata = &GetBiblioItemData($biblioitemnumber);
504 Looks up the biblioitem with the given biblioitemnumber. Returns a
505 reference-to-hash. The keys are the fields from the C<biblio>,
506 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
507 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
514 sub GetBiblioItemData {
515 my ($biblioitemnumber) = @_;
516 my $dbh = C4::Context->dbh;
517 my $query = "SELECT *,biblioitems.notes AS bnotes
518 FROM biblio LEFT JOIN biblioitems on biblio.biblionumber=biblioitems.biblioitemnumber ";
519 unless(C4::Context->preference('item-level_itypes')) {
520 $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
522 $query .= " WHERE biblioitemnumber = ? ";
523 my $sth = $dbh->prepare($query);
525 $sth->execute($biblioitemnumber);
526 $data = $sth->fetchrow_hashref;
529 } # sub &GetBiblioItemData
531 =head2 GetBiblioItemByBiblioNumber
535 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
541 sub GetBiblioItemByBiblioNumber {
542 my ($biblionumber) = @_;
543 my $dbh = C4::Context->dbh;
544 my $sth = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
548 $sth->execute($biblionumber);
550 while ( my $data = $sth->fetchrow_hashref ) {
551 push @results, $data;
558 =head2 GetBiblioFromItemNumber
562 $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
564 Looks up the item with the given itemnumber. if undef, try the barcode.
566 C<&itemnodata> returns a reference-to-hash whose keys are the fields
567 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
575 sub GetBiblioFromItemNumber {
576 my ( $itemnumber, $barcode ) = @_;
577 my $dbh = C4::Context->dbh;
580 $sth=$dbh->prepare( "SELECT * FROM items
581 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
582 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
583 WHERE items.itemnumber = ?") ;
584 $sth->execute($itemnumber);
586 $sth=$dbh->prepare( "SELECT * FROM items
587 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
588 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
589 WHERE items.barcode = ?") ;
590 $sth->execute($barcode);
592 my $data = $sth->fetchrow_hashref;
601 ( $count, @results ) = &GetBiblio($biblionumber);
608 my ($biblionumber) = @_;
609 my $dbh = C4::Context->dbh;
610 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
613 $sth->execute($biblionumber);
614 while ( my $data = $sth->fetchrow_hashref ) {
615 $results[$count] = $data;
619 return ( $count, @results );
622 =head2 GetBiblioItemInfosOf
626 GetBiblioItemInfosOf(@biblioitemnumbers);
632 sub GetBiblioItemInfosOf {
633 my @biblioitemnumbers = @_;
636 SELECT biblioitemnumber,
640 WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
642 return get_infos_of( $query, 'biblioitemnumber' );
645 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
647 =head2 GetMarcStructure
651 $res = GetMarcStructure($forlibrarian,$frameworkcode);
653 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
654 $forlibrarian :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
655 $frameworkcode : the framework code to read
661 # cache for results of GetMarcStructure -- needed
663 our $marc_structure_cache;
665 sub GetMarcStructure {
666 my ( $forlibrarian, $frameworkcode ) = @_;
667 my $dbh=C4::Context->dbh;
668 $frameworkcode = "" unless $frameworkcode;
670 if (defined $marc_structure_cache and exists $marc_structure_cache->{$forlibrarian}->{$frameworkcode}) {
671 return $marc_structure_cache->{$forlibrarian}->{$frameworkcode};
675 my $libfield = ( $forlibrarian eq 1 ) ? 'liblibrarian' : 'libopac';
677 # check that framework exists
680 "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
681 $sth->execute($frameworkcode);
682 my ($total) = $sth->fetchrow;
683 $frameworkcode = "" unless ( $total > 0 );
686 "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable
687 FROM marc_tag_structure
688 WHERE frameworkcode=?
691 $sth->execute($frameworkcode);
692 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
694 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) =
697 $res->{$tag}->{lib} =
698 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
699 $res->{$tag}->{tab} = "";
700 $res->{$tag}->{mandatory} = $mandatory;
701 $res->{$tag}->{repeatable} = $repeatable;
706 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue
707 FROM marc_subfield_structure
708 WHERE frameworkcode=?
709 ORDER BY tagfield,tagsubfield
713 $sth->execute($frameworkcode);
716 my $authorised_value;
728 $tag, $subfield, $liblibrarian,
730 $mandatory, $repeatable, $authorised_value,
731 $authtypecode, $value_builder, $kohafield,
732 $seealso, $hidden, $isurl,
738 $res->{$tag}->{$subfield}->{lib} =
739 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
740 $res->{$tag}->{$subfield}->{tab} = $tab;
741 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
742 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
743 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
744 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
745 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
746 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
747 $res->{$tag}->{$subfield}->{seealso} = $seealso;
748 $res->{$tag}->{$subfield}->{hidden} = $hidden;
749 $res->{$tag}->{$subfield}->{isurl} = $isurl;
750 $res->{$tag}->{$subfield}->{'link'} = $link;
751 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
754 $marc_structure_cache->{$forlibrarian}->{$frameworkcode} = $res;
759 =head2 GetUsedMarcStructure
761 the same function as GetMarcStructure expcet it just take field
762 in tab 0-9. (used field)
764 my $results = GetUsedMarcStructure($frameworkcode);
766 L<$results> is a ref to an array which each case containts a ref
767 to a hash which each keys is the columns from marc_subfield_structure
769 L<$frameworkcode> is the framework code.
773 sub GetUsedMarcStructure($){
774 my $frameworkcode = shift || '';
775 my $dbh = C4::Context->dbh;
778 FROM marc_subfield_structure
780 AND frameworkcode = ?
783 my $sth = $dbh->prepare($query);
784 $sth->execute($frameworkcode);
785 while (my $row = $sth->fetchrow_hashref){
791 =head2 GetMarcFromKohaField
795 ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
796 Returns the MARC fields & subfields mapped to the koha field
797 for the given frameworkcode
803 sub GetMarcFromKohaField {
804 my ( $kohafield, $frameworkcode ) = @_;
805 return 0, 0 unless $kohafield;
806 my $relations = C4::Context->marcfromkohafield;
808 $relations->{$frameworkcode}->{$kohafield}->[0],
809 $relations->{$frameworkcode}->{$kohafield}->[1]
817 Returns MARC::Record of the biblionumber passed in parameter.
818 the marc record contains both biblio & item datas
825 my $biblionumber = shift;
826 my $dbh = C4::Context->dbh;
828 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
829 $sth->execute($biblionumber);
830 my $row = $sth->fetchrow_hashref;
831 my $marcxml = StripNonXmlChars($row->{'marcxml'});
832 MARC::File::XML->default_record_format(C4::Context->preference('marcflavour'));
833 my $record = MARC::Record->new();
835 $record = eval {MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour'))};
836 if ($@) {warn " problem with :$biblionumber : $@ \n$marcxml";}
837 # $record = MARC::Record::new_from_usmarc( $marc) if $marc;
848 my $marcxml = GetXmlBiblio($biblionumber);
850 Returns biblioitems.marcxml of the biblionumber passed in parameter.
851 The XML contains both biblio & item datas
858 my ( $biblionumber ) = @_;
859 my $dbh = C4::Context->dbh;
861 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
862 $sth->execute($biblionumber);
863 my ($marcxml) = $sth->fetchrow;
867 =head2 GetAuthorisedValueDesc
871 my $subfieldvalue =get_authorised_value_desc(
872 $tag, $subf[$i][0],$subf[$i][1], '', $taglib, $category);
873 Retrieve the complete description for a given authorised value.
875 Now takes $category and $value pair too.
876 my $auth_value_desc =GetAuthorisedValueDesc(
877 '','', 'DVD' ,'','','CCODE');
883 sub GetAuthorisedValueDesc {
884 my ( $tag, $subfield, $value, $framework, $tagslib, $category ) = @_;
885 my $dbh = C4::Context->dbh;
889 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
890 return C4::Branch::GetBranchName($value);
894 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
895 return getitemtypeinfo($value)->{description};
898 #---- "true" authorized value
899 $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'}
902 if ( $category ne "" ) {
905 "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
907 $sth->execute( $category, $value );
908 my $data = $sth->fetchrow_hashref;
909 return $data->{'lib'};
912 return $value; # if nothing is found return the original value
920 $marcnotesarray = GetMarcNotes( $record, $marcflavour );
921 Get all notes from the MARC record and returns them in an array.
922 The note are stored in differents places depending on MARC flavour
929 my ( $record, $marcflavour ) = @_;
931 if ( $marcflavour eq "MARC21" ) {
934 else { # assume unimarc if not marc21
941 foreach my $field ( $record->field($scope) ) {
942 my $value = $field->as_string();
944 $marcnote = { marcnote => $note, };
945 push @marcnotes, $marcnote;
948 if ( $note ne $value ) {
949 $note = $note . " " . $value;
954 $marcnote = { marcnote => $note };
955 push @marcnotes, $marcnote; #load last tag into array
960 =head2 GetMarcSubjects
964 $marcsubjcts = GetMarcSubjects($record,$marcflavour);
965 Get all subjects from the MARC record and returns them in an array.
966 The subjects are stored in differents places depending on MARC flavour
972 sub GetMarcSubjects {
973 my ( $record, $marcflavour ) = @_;
974 my ( $mintag, $maxtag );
975 if ( $marcflavour eq "MARC21" ) {
979 else { # assume unimarc if not marc21
989 foreach my $field ( $record->field('6..' )) {
990 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
992 my @subfields = $field->subfields();
995 # if there is an authority link, build the link with an= subfield9
996 my $subfield9 = $field->subfield('9');
997 for my $subject_subfield (@subfields ) {
998 # don't load unimarc subfields 3,4,5
999 next if (($marcflavour eq "UNIMARC") and ($subject_subfield->[0] =~ (3|4|5) ) );
1000 my $code = $subject_subfield->[0];
1001 my $value = $subject_subfield->[1];
1002 my $linkvalue = $value;
1003 $linkvalue =~ s/(\(|\))//g;
1004 my $operator = " and " unless $counter==0;
1006 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1008 push @link_loop, {'limit' => 'su', link => $linkvalue, operator => $operator };
1010 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1012 my @this_link_loop = @link_loop;
1013 push @subfields_loop, {code => $code, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($subject_subfield->[0] eq 9 );
1017 push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1020 return \@marcsubjects;
1021 } #end getMARCsubjects
1023 =head2 GetMarcAuthors
1027 authors = GetMarcAuthors($record,$marcflavour);
1028 Get all authors from the MARC record and returns them in an array.
1029 The authors are stored in differents places depending on MARC flavour
1035 sub GetMarcAuthors {
1036 my ( $record, $marcflavour ) = @_;
1037 my ( $mintag, $maxtag );
1038 # tagslib useful for UNIMARC author reponsabilities
1039 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.
1040 if ( $marcflavour eq "MARC21" ) {
1044 elsif ( $marcflavour eq "UNIMARC" ) { # assume unimarc if not marc21
1053 foreach my $field ( $record->fields ) {
1054 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1057 my @subfields = $field->subfields();
1059 # if there is an authority link, build the link with Koha-Auth-Number: subfield9
1060 my $subfield9 = $field->subfield('9');
1061 for my $authors_subfield (@subfields) {
1062 # don't load unimarc subfields 3, 5
1063 next if ($marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~ (3|5) ) );
1064 my $subfieldcode = $authors_subfield->[0];
1065 my $value = $authors_subfield->[1];
1066 my $linkvalue = $value;
1067 $linkvalue =~ s/(\(|\))//g;
1068 my $operator = " and " unless $count_auth==0;
1069 # if we have an authority link, use that as the link, otherwise use standard searching
1071 @link_loop = ({'limit' => 'Koha-Auth-Number' ,link => "$subfield9" });
1074 # reset $linkvalue if UNIMARC author responsibility
1075 if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] eq "4")) {
1076 $linkvalue = "(".GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ).")";
1078 push @link_loop, {'limit' => 'au', link => $linkvalue, operator => $operator };
1080 $value = GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ) if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~/4/));
1081 my @this_link_loop = @link_loop;
1082 my $separator = C4::Context->preference("authoritysep") unless $count_auth==0;
1083 push @subfields_loop, {code => $subfieldcode, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($authors_subfield->[0] == 9 );
1086 push @marcauthors, { MARCAUTHOR_SUBFIELDS_LOOP => \@subfields_loop };
1088 return \@marcauthors;
1095 $marcurls = GetMarcUrls($record,$marcflavour);
1096 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1097 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1104 my ($record, $marcflavour) = @_;
1107 for my $field ($record->field('856')) {
1108 my $url = $field->subfield('u');
1110 for my $note ( $field->subfield('z')) {
1111 push @notes , {note => $note};
1113 $marcurl = { MARCURL => $url,
1116 if($marcflavour eq 'MARC21') {
1117 my $s3 = $field->subfield('3');
1118 my $link = $field->subfield('y');
1119 $marcurl->{'linktext'} = $link || $s3 || $url ;;
1120 $marcurl->{'part'} = $s3 if($link);
1121 $marcurl->{'toc'} = 1 if($s3 =~ /^[Tt]able/) ;
1123 $marcurl->{'linktext'} = $url;
1125 push @marcurls, $marcurl;
1130 =head2 GetMarcSeries
1134 $marcseriesarray = GetMarcSeries($record,$marcflavour);
1135 Get all series from the MARC record and returns them in an array.
1136 The series are stored in differents places depending on MARC flavour
1143 my ($record, $marcflavour) = @_;
1144 my ($mintag, $maxtag);
1145 if ($marcflavour eq "MARC21") {
1148 } else { # assume unimarc if not marc21
1158 foreach my $field ($record->field('440'), $record->field('490')) {
1160 #my $value = $field->subfield('a');
1161 #$marcsubjct = {MARCSUBJCT => $value,};
1162 my @subfields = $field->subfields();
1163 #warn "subfields:".join " ", @$subfields;
1166 for my $series_subfield (@subfields) {
1168 undef $volume_number;
1169 # see if this is an instance of a volume
1170 if ($series_subfield->[0] eq 'v') {
1174 my $code = $series_subfield->[0];
1175 my $value = $series_subfield->[1];
1176 my $linkvalue = $value;
1177 $linkvalue =~ s/(\(|\))//g;
1178 my $operator = " and " unless $counter==0;
1179 push @link_loop, {link => $linkvalue, operator => $operator };
1180 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1181 if ($volume_number) {
1182 push @subfields_loop, {volumenum => $value};
1185 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number};
1189 push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
1190 #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
1191 #push @marcsubjcts, $marcsubjct;
1195 my $marcseriessarray=\@marcseries;
1196 return $marcseriessarray;
1197 } #end getMARCseriess
1199 =head2 GetFrameworkCode
1203 $frameworkcode = GetFrameworkCode( $biblionumber )
1209 sub GetFrameworkCode {
1210 my ( $biblionumber ) = @_;
1211 my $dbh = C4::Context->dbh;
1212 my $sth = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
1213 $sth->execute($biblionumber);
1214 my ($frameworkcode) = $sth->fetchrow;
1215 return $frameworkcode;
1218 =head2 GetPublisherNameFromIsbn
1220 $name = GetPublishercodeFromIsbn($isbn);
1227 sub GetPublisherNameFromIsbn($){
1229 $isbn =~ s/[- _]//g;
1231 my @codes = (split '-', DisplayISBN($isbn));
1232 my $code = $codes[0].$codes[1].$codes[2];
1233 my $dbh = C4::Context->dbh;
1235 SELECT distinct publishercode
1238 AND publishercode IS NOT NULL
1241 my $sth = $dbh->prepare($query);
1242 $sth->execute("$code%");
1243 my $name = $sth->fetchrow;
1244 return $name if length $name;
1248 =head2 TransformKohaToMarc
1252 $record = TransformKohaToMarc( $hash )
1253 This function builds partial MARC::Record from a hash
1254 Hash entries can be from biblio or biblioitems.
1255 This function is called in acquisition module, to create a basic catalogue entry from user entry
1261 sub TransformKohaToMarc {
1264 my $dbh = C4::Context->dbh;
1267 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1269 my $record = MARC::Record->new();
1270 foreach (keys %{$hash}) {
1271 &TransformKohaToMarcOneField( $sth, $record, $_,
1277 =head2 TransformKohaToMarcOneField
1281 $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
1287 sub TransformKohaToMarcOneField {
1288 my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
1289 $frameworkcode='' unless $frameworkcode;
1293 if ( !defined $sth ) {
1294 my $dbh = C4::Context->dbh;
1295 $sth = $dbh->prepare(
1296 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1299 $sth->execute( $frameworkcode, $kohafieldname );
1300 if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
1301 my $tag = $record->field($tagfield);
1303 $tag->update( $tagsubfield => $value );
1304 $record->delete_field($tag);
1305 $record->insert_fields_ordered($tag);
1308 $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
1314 =head2 TransformHtmlToXml
1318 $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type )
1320 $auth_type contains :
1321 - nothing : rebuild a biblio, un UNIMARC the encoding is in 100$a pos 26/27
1322 - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
1323 - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
1329 sub TransformHtmlToXml {
1330 my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
1331 my $xml = MARC::File::XML::header('UTF-8');
1332 $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
1333 MARC::File::XML->default_record_format($auth_type);
1334 # in UNIMARC, field 100 contains the encoding
1335 # check that there is one, otherwise the
1336 # MARC::Record->new_from_xml will fail (and Koha will die)
1337 my $unimarc_and_100_exist=0;
1338 $unimarc_and_100_exist=1 if $auth_type eq 'ITEM'; # if we rebuild an item, no need of a 100 field
1343 for ( my $i = 0 ; $i <= @$tags ; $i++ ) {
1344 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a") {
1345 # if we have a 100 field and it's values are not correct, skip them.
1346 # if we don't have any valid 100 field, we will create a default one at the end
1347 my $enc = substr( @$values[$i], 26, 2 );
1348 if ($enc eq '01' or $enc eq '50' or $enc eq '03') {
1349 $unimarc_and_100_exist=1;
1354 @$values[$i] =~ s/&/&/g;
1355 @$values[$i] =~ s/</</g;
1356 @$values[$i] =~ s/>/>/g;
1357 @$values[$i] =~ s/"/"/g;
1358 @$values[$i] =~ s/'/'/g;
1359 # if ( !utf8::is_utf8( @$values[$i] ) ) {
1360 # utf8::decode( @$values[$i] );
1362 if ( ( @$tags[$i] ne $prevtag ) ) {
1363 $j++ unless ( @$tags[$i] eq "" );
1365 $xml .= "</datafield>\n";
1366 if ( ( @$tags[$i] && @$tags[$i] > 10 )
1367 && ( @$values[$i] ne "" ) )
1369 my $ind1 = substr( @$indicator[$j], 0, 1 );
1371 if ( @$indicator[$j] ) {
1372 $ind2 = substr( @$indicator[$j], 1, 1 );
1375 warn "Indicator in @$tags[$i] is empty";
1379 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1381 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1389 if ( @$values[$i] ne "" ) {
1392 if ( @$tags[$i] eq "000" ) {
1393 $xml .= "<leader>@$values[$i]</leader>\n";
1396 # rest of the fixed fields
1398 elsif ( @$tags[$i] < 10 ) {
1400 "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
1404 my $ind1 = substr( @$indicator[$j], 0, 1 );
1405 my $ind2 = substr( @$indicator[$j], 1, 1 );
1407 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1409 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1415 else { # @$tags[$i] eq $prevtag
1416 if ( @$values[$i] eq "" ) {
1420 my $ind1 = substr( @$indicator[$j], 0, 1 );
1421 my $ind2 = substr( @$indicator[$j], 1, 1 );
1423 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1427 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1430 $prevtag = @$tags[$i];
1432 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and !$unimarc_and_100_exist) {
1433 # warn "SETTING 100 for $auth_type";
1434 use POSIX qw(strftime);
1435 my $string = strftime( "%Y%m%d", localtime(time) );
1436 # set 50 to position 26 is biblios, 13 if authorities
1438 $pos=13 if $auth_type eq 'UNIMARCAUTH';
1439 $string = sprintf( "%-*s", 35, $string );
1440 substr( $string, $pos , 6, "50" );
1441 $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
1442 $xml .= "<subfield code=\"a\">$string</subfield>\n";
1443 $xml .= "</datafield>\n";
1445 $xml .= MARC::File::XML::footer();
1449 =head2 TransformHtmlToMarc
1451 L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
1452 L<$params> is a ref to an array as below:
1454 'tag_010_indicator_531951' ,
1455 'tag_010_code_a_531951_145735' ,
1456 'tag_010_subfield_a_531951_145735' ,
1457 'tag_200_indicator_873510' ,
1458 'tag_200_code_a_873510_673465' ,
1459 'tag_200_subfield_a_873510_673465' ,
1460 'tag_200_code_b_873510_704318' ,
1461 'tag_200_subfield_b_873510_704318' ,
1462 'tag_200_code_e_873510_280822' ,
1463 'tag_200_subfield_e_873510_280822' ,
1464 'tag_200_code_f_873510_110730' ,
1465 'tag_200_subfield_f_873510_110730' ,
1467 L<$cgi> is the CGI object which containts the value.
1468 L<$record> is the MARC::Record object.
1472 sub TransformHtmlToMarc {
1476 # creating a new record
1477 my $record = MARC::Record->new();
1480 while ($params->[$i]){ # browse all CGI params
1481 my $param = $params->[$i];
1483 # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
1484 if ($param eq 'biblionumber') {
1485 my ( $biblionumbertagfield, $biblionumbertagsubfield ) =
1486 &GetMarcFromKohaField( "biblio.biblionumber", '' );
1487 if ($biblionumbertagfield < 10) {
1488 $newfield = MARC::Field->new(
1489 $biblionumbertagfield,
1490 $cgi->param($param),
1493 $newfield = MARC::Field->new(
1494 $biblionumbertagfield,
1497 "$biblionumbertagsubfield" => $cgi->param($param),
1500 push @fields,$newfield if($newfield);
1502 elsif ($param =~ /^tag_(\d*)_indicator_/){ # new field start when having 'input name="..._indicator_..."
1505 my $ind1 = substr($cgi->param($param),0,1);
1506 my $ind2 = substr($cgi->param($param),1,1);
1510 if($tag < 10){ # no code for theses fields
1511 # in MARC editor, 000 contains the leader.
1512 if ($tag eq '000' ) {
1513 $record->leader($cgi->param($params->[$j+1])) if length($cgi->param($params->[$j+1]))==24;
1514 # between 001 and 009 (included)
1516 $newfield = MARC::Field->new(
1518 $cgi->param($params->[$j+1]),
1521 # > 009, deal with subfields
1523 while($params->[$j] =~ /_code_/){ # browse all it's subfield
1524 my $inner_param = $params->[$j];
1526 if($cgi->param($params->[$j+1])){ # only if there is a value (code => value)
1527 $newfield->add_subfields(
1528 $cgi->param($inner_param) => $cgi->param($params->[$j+1])
1532 if ( $cgi->param($params->[$j+1]) ) { # creating only if there is a value (code => value)
1533 $newfield = MARC::Field->new(
1537 $cgi->param($inner_param) => $cgi->param($params->[$j+1]),
1544 push @fields,$newfield if($newfield);
1549 $record->append_fields(@fields);
1553 # cache inverted MARC field map
1554 our $inverted_field_map;
1556 =head2 TransformMarcToKoha
1560 $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
1564 Extract data from a MARC bib record into a hashref representing
1565 Koha biblio, biblioitems, and items fields.
1568 sub TransformMarcToKoha {
1569 my ( $dbh, $record, $frameworkcode, $limit_table ) = @_;
1573 unless (defined $inverted_field_map) {
1574 $inverted_field_map = _get_inverted_marc_field_map();
1578 if ($limit_table eq 'items') {
1579 $tables{'items'} = 1;
1581 $tables{'items'} = 1;
1582 $tables{'biblio'} = 1;
1583 $tables{'biblioitems'} = 1;
1586 # traverse through record
1587 MARCFIELD: foreach my $field ($record->fields()) {
1588 my $tag = $field->tag();
1589 next MARCFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag};
1590 if ($field->is_control_field()) {
1591 my $kohafields = $inverted_field_map->{$frameworkcode}->{$tag}->{list};
1592 ENTRY: foreach my $entry (@{ $kohafields }) {
1593 my ($subfield, $table, $column) = @{ $entry };
1594 next ENTRY unless exists $tables{$table};
1595 my $key = _disambiguate($table, $column);
1596 if ($result->{$key}) {
1597 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($field->data() eq "")) {
1598 $result->{$key} .= " | " . $field->data();
1601 $result->{$key} = $field->data();
1605 # deal with subfields
1606 MARCSUBFIELD: foreach my $sf ($field->subfields()) {
1607 my $code = $sf->[0];
1608 next MARCSUBFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code};
1609 my $value = $sf->[1];
1610 SFENTRY: foreach my $entry (@{ $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code} }) {
1611 my ($table, $column) = @{ $entry };
1612 next SFENTRY unless exists $tables{$table};
1613 my $key = _disambiguate($table, $column);
1614 if ($result->{$key}) {
1615 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($value eq "")) {
1616 $result->{$key} .= " | " . $value;
1619 $result->{$key} = $value;
1626 # modify copyrightdate to keep only the 1st year found
1627 if (exists $result->{'copyrightdate'}) {
1628 my $temp = $result->{'copyrightdate'};
1629 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
1631 $result->{'copyrightdate'} = $1;
1633 else { # if no cYYYY, get the 1st date.
1634 $temp =~ m/(\d\d\d\d)/;
1635 $result->{'copyrightdate'} = $1;
1639 # modify publicationyear to keep only the 1st year found
1640 if (exists $result->{'publicationyear'}) {
1641 my $temp = $result->{'publicationyear'};
1642 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
1644 $result->{'publicationyear'} = $1;
1646 else { # if no cYYYY, get the 1st date.
1647 $temp =~ m/(\d\d\d\d)/;
1648 $result->{'publicationyear'} = $1;
1655 sub _get_inverted_marc_field_map {
1657 my $relations = C4::Context->marcfromkohafield;
1659 foreach my $frameworkcode (keys %{ $relations }) {
1660 foreach my $kohafield (keys %{ $relations->{$frameworkcode} }) {
1661 my $tag = $relations->{$frameworkcode}->{$kohafield}->[0];
1662 my $subfield = $relations->{$frameworkcode}->{$kohafield}->[1];
1663 my ($table, $column) = split /[.]/, $kohafield, 2;
1664 push @{ $field_map->{$frameworkcode}->{$tag}->{list} }, [ $subfield, $table, $column ];
1665 push @{ $field_map->{$frameworkcode}->{$tag}->{sfs}->{$subfield} }, [ $table, $column ];
1671 =head2 _disambiguate
1675 $newkey = _disambiguate($table, $field);
1677 This is a temporary hack to distinguish between the
1678 following sets of columns when using TransformMarcToKoha.
1680 items.cn_source & biblioitems.cn_source
1681 items.cn_sort & biblioitems.cn_sort
1683 Columns that are currently NOT distinguished (FIXME
1684 due to lack of time to fully test) are:
1686 biblio.notes and biblioitems.notes
1691 FIXME - this is necessary because prefixing each column
1692 name with the table name would require changing lots
1693 of code and templates, and exposing more of the DB
1694 structure than is good to the UI templates, particularly
1695 since biblio and bibloitems may well merge in a future
1696 version. In the future, it would also be good to
1697 separate DB access and UI presentation field names
1705 my ($table, $column) = @_;
1706 if ($column eq "cn_sort" or $column eq "cn_source") {
1707 return $table . '.' . $column;
1714 =head2 get_koha_field_from_marc
1718 $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
1720 Internal function to map data from the MARC record to a specific non-MARC field.
1721 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
1727 sub get_koha_field_from_marc {
1728 my ($koha_table,$koha_column,$record,$frameworkcode) = @_;
1729 my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table.'.'.$koha_column, $frameworkcode );
1731 foreach my $field ( $record->field($tagfield) ) {
1732 if ( $field->tag() < 10 ) {
1734 $kohafield .= " | " . $field->data();
1737 $kohafield = $field->data();
1741 if ( $field->subfields ) {
1742 my @subfields = $field->subfields();
1743 foreach my $subfieldcount ( 0 .. $#subfields ) {
1744 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1747 " | " . $subfields[$subfieldcount][1];
1751 $subfields[$subfieldcount][1];
1762 =head2 TransformMarcToKohaOneField
1766 $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
1772 sub TransformMarcToKohaOneField {
1774 # FIXME ? if a field has a repeatable subfield that is used in old-db,
1775 # only the 1st will be retrieved...
1776 my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
1778 my ( $tagfield, $subfield ) =
1779 GetMarcFromKohaField( $kohatable . "." . $kohafield,
1781 foreach my $field ( $record->field($tagfield) ) {
1782 if ( $field->tag() < 10 ) {
1783 if ( $result->{$kohafield} ) {
1784 $result->{$kohafield} .= " | " . $field->data();
1787 $result->{$kohafield} = $field->data();
1791 if ( $field->subfields ) {
1792 my @subfields = $field->subfields();
1793 foreach my $subfieldcount ( 0 .. $#subfields ) {
1794 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1795 if ( $result->{$kohafield} ) {
1796 $result->{$kohafield} .=
1797 " | " . $subfields[$subfieldcount][1];
1800 $result->{$kohafield} =
1801 $subfields[$subfieldcount][1];
1811 =head1 OTHER FUNCTIONS
1814 =head2 PrepareItemrecordDisplay
1818 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber);
1820 Returns a hash with all the fields for Display a given item data in a template
1826 sub PrepareItemrecordDisplay {
1828 my ( $bibnum, $itemnum ) = @_;
1830 my $dbh = C4::Context->dbh;
1831 my $frameworkcode = &GetFrameworkCode( $bibnum );
1832 my ( $itemtagfield, $itemtagsubfield ) =
1833 &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
1834 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
1835 my $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum) if ($itemnum);
1837 my $authorised_values_sth =
1839 "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib"
1841 foreach my $tag ( sort keys %{$tagslib} ) {
1842 my $previous_tag = '';
1844 # loop through each subfield
1846 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
1847 next if ( subfield_is_koha_internal_p($subfield) );
1848 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
1850 $subfield_data{tag} = $tag;
1851 $subfield_data{subfield} = $subfield;
1852 $subfield_data{countsubfield} = $cntsubf++;
1853 $subfield_data{kohafield} =
1854 $tagslib->{$tag}->{$subfield}->{'kohafield'};
1856 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
1857 $subfield_data{marc_lib} =
1858 "<span id=\"error\" title=\""
1859 . $tagslib->{$tag}->{$subfield}->{lib} . "\">"
1860 . substr( $tagslib->{$tag}->{$subfield}->{lib}, 0, 12 )
1862 $subfield_data{mandatory} =
1863 $tagslib->{$tag}->{$subfield}->{mandatory};
1864 $subfield_data{repeatable} =
1865 $tagslib->{$tag}->{$subfield}->{repeatable};
1866 $subfield_data{hidden} = "display:none"
1867 if $tagslib->{$tag}->{$subfield}->{hidden};
1869 ( $x, $value ) = _find_value( $tag, $subfield, $itemrecord )
1871 $value =~ s/"/"/g;
1873 # search for itemcallnumber if applicable
1874 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
1875 'items.itemcallnumber'
1876 && C4::Context->preference('itemcallnumber') )
1879 substr( C4::Context->preference('itemcallnumber'), 0, 3 );
1881 substr( C4::Context->preference('itemcallnumber'), 3, 1 );
1882 my $temp = $itemrecord->field($CNtag) if ($itemrecord);
1884 $value = $temp->subfield($CNsubfield);
1887 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
1888 my @authorised_values;
1891 # builds list, depending on authorised value...
1893 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq
1896 if ( ( C4::Context->preference("IndependantBranches") )
1897 && ( C4::Context->userenv->{flags} != 1 ) )
1901 "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname"
1903 $sth->execute( C4::Context->userenv->{branch} );
1904 push @authorised_values, ""
1906 $tagslib->{$tag}->{$subfield}->{mandatory} );
1907 while ( my ( $branchcode, $branchname ) =
1908 $sth->fetchrow_array )
1910 push @authorised_values, $branchcode;
1911 $authorised_lib{$branchcode} = $branchname;
1917 "SELECT branchcode,branchname FROM branches ORDER BY branchname"
1920 push @authorised_values, ""
1922 $tagslib->{$tag}->{$subfield}->{mandatory} );
1923 while ( my ( $branchcode, $branchname ) =
1924 $sth->fetchrow_array )
1926 push @authorised_values, $branchcode;
1927 $authorised_lib{$branchcode} = $branchname;
1933 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq
1938 "SELECT itemtype,description FROM itemtypes ORDER BY description"
1941 push @authorised_values, ""
1942 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
1943 while ( my ( $itemtype, $description ) =
1944 $sth->fetchrow_array )
1946 push @authorised_values, $itemtype;
1947 $authorised_lib{$itemtype} = $description;
1950 #---- "true" authorised value
1953 $authorised_values_sth->execute(
1954 $tagslib->{$tag}->{$subfield}->{authorised_value} );
1955 push @authorised_values, ""
1956 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
1957 while ( my ( $value, $lib ) =
1958 $authorised_values_sth->fetchrow_array )
1960 push @authorised_values, $value;
1961 $authorised_lib{$value} = $lib;
1964 $subfield_data{marc_value} = CGI::scrolling_list(
1965 -name => 'field_value',
1966 -values => \@authorised_values,
1967 -default => "$value",
1968 -labels => \%authorised_lib,
1974 elsif ( $tagslib->{$tag}->{$subfield}->{thesaurus_category} ) {
1975 $subfield_data{marc_value} =
1976 "<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>";
1979 # COMMENTED OUT because No $i is provided with this API.
1980 # And thus, no value_builder can be activated.
1981 # BUT could be thought over.
1982 # } elsif ($tagslib->{$tag}->{$subfield}->{'value_builder'}) {
1983 # my $plugin="value_builder/".$tagslib->{$tag}->{$subfield}->{'value_builder'};
1985 # my $extended_param = plugin_parameters($dbh,$itemrecord,$tagslib,$i,0);
1986 # my ($function_name,$javascript) = plugin_javascript($dbh,$record,$tagslib,$i,0);
1987 # $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";
1990 $subfield_data{marc_value} =
1991 "<input type=\"text\" name=\"field_value\" value=\"$value\" size=50 maxlength=255>";
1993 push( @loop_data, \%subfield_data );
1997 my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
1998 if ( $itemrecord && $itemrecord->field($itemtagfield) );
2000 'itemtagfield' => $itemtagfield,
2001 'itemtagsubfield' => $itemtagsubfield,
2002 'itemnumber' => $itemnumber,
2003 'iteminformation' => \@loop_data
2009 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2011 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2012 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2013 # =head2 ModZebrafiles
2015 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
2019 # sub ModZebrafiles {
2021 # my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
2025 # C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
2026 # unless ( opendir( DIR, "$zebradir" ) ) {
2027 # warn "$zebradir not found";
2031 # my $filename = $zebradir . $biblionumber;
2034 # open( OUTPUT, ">", $filename . ".xml" );
2035 # print OUTPUT $record;
2044 ModZebra( $biblionumber, $op, $server, $oldRecord, $newRecord );
2046 $biblionumber is the biblionumber we want to index
2047 $op is specialUpdate or delete, and is used to know what we want to do
2048 $server is the server that we want to update
2049 $oldRecord is the MARC::Record containing the previous version of the record. This is used only when
2050 NoZebra=1, as NoZebra indexing needs to know the previous version of a record in order to
2052 $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.
2059 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
2060 my ( $biblionumber, $op, $server, $oldRecord, $newRecord ) = @_;
2061 my $dbh=C4::Context->dbh;
2063 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2065 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2066 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2068 if (C4::Context->preference("NoZebra")) {
2069 # lock the nozebra table : we will read index lines, update them in Perl process
2070 # and write everything in 1 transaction.
2071 # lock the table to avoid someone else overwriting what we are doing
2072 $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE');
2073 my %result; # the result hash that will be builded by deletion / add, and written on mySQL at the end, to improve speed
2074 if ($op eq 'specialUpdate') {
2075 # OK, we have to add or update the record
2076 # 1st delete (virtually, in indexes), if record actually exists
2078 %result = _DelBiblioNoZebra($biblionumber,$oldRecord,$server);
2080 # ... add the record
2081 %result=_AddBiblioNoZebra($biblionumber,$newRecord, $server, %result);
2083 # it's a deletion, delete the record...
2084 # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
2085 %result=_DelBiblioNoZebra($biblionumber,$oldRecord,$server);
2087 # ok, now update the database...
2088 my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
2089 foreach my $key (keys %result) {
2090 foreach my $index (keys %{$result{$key}}) {
2091 $sth->execute($result{$key}->{$index}, $server, $key, $index);
2094 $dbh->do('UNLOCK TABLES');
2098 # we use zebra, just fill zebraqueue table
2100 my $check_sql = "SELECT COUNT(*) FROM zebraqueue
2102 AND biblio_auth_number = ?
2105 my $check_sth = $dbh->prepare_cached($check_sql);
2106 $check_sth->execute($server, $biblionumber, $op);
2107 my ($count) = $check_sth->fetchrow_array;
2108 $check_sth->finish();
2110 my $sth=$dbh->prepare("INSERT INTO zebraqueue (biblio_auth_number,server,operation) VALUES(?,?,?)");
2111 $sth->execute($biblionumber,$server,$op);
2117 =head2 GetNoZebraIndexes
2119 %indexes = GetNoZebraIndexes;
2121 return the data from NoZebraIndexes syspref.
2125 sub GetNoZebraIndexes {
2126 my $index = C4::Context->preference('NoZebraIndexes');
2128 foreach my $line (split /('|"),/,$index) {
2129 $line =~ /(.*)=>(.*)/;
2130 my $index = substr($1,1); # get the index, don't forget to remove initial ' or "
2132 $index =~ s/'|"|\s//g;
2135 $fields =~ s/'|"|\s//g;
2136 $indexes{$index}=$fields;
2141 =head1 INTERNAL FUNCTIONS
2143 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
2145 function to delete a biblio in NoZebra indexes
2146 This function does NOT delete anything in database : it reads all the indexes entries
2147 that have to be deleted & delete them in the hash
2148 The SQL part is done either :
2149 - after the Add if we are modifying a biblio (delete + add again)
2150 - immediatly after this sub if we are doing a true deletion.
2151 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
2156 sub _DelBiblioNoZebra {
2157 my ($biblionumber, $record, $server)=@_;
2160 my $dbh = C4::Context->dbh;
2164 if ($server eq 'biblioserver') {
2165 %index=GetNoZebraIndexes;
2166 # get title of the record (to store the 10 first letters with the index)
2167 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
2168 $title = lc($record->subfield($titletag,$titlesubfield));
2170 # for authorities, the "title" is the $a mainentry
2171 my ($auth_type_tag, $auth_type_sf) = C4::AuthoritiesMarc::get_auth_type_location();
2172 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield($auth_type_tag, $auth_type_sf));
2173 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2174 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2175 $index{'mainmainentry'}= $authref->{'auth_tag_to_report'}.'a';
2176 $index{'mainentry'} = $authref->{'auth_tag_to_report'}.'*';
2177 $index{'auth_type'} = "${auth_type_tag}${auth_type_sf}";
2181 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2182 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
2183 # limit to 10 char, should be enough, and limit the DB size
2184 $title = substr($title,0,10);
2186 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2187 foreach my $field ($record->fields()) {
2188 #parse each subfield
2189 next if $field->tag <10;
2190 foreach my $subfield ($field->subfields()) {
2191 my $tag = $field->tag();
2192 my $subfieldcode = $subfield->[0];
2194 # check each index to see if the subfield is stored somewhere
2195 # otherwise, store it in __RAW__ index
2196 foreach my $key (keys %index) {
2197 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2198 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2200 my $line= lc $subfield->[1];
2201 # remove meaningless value in the field...
2202 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2203 # ... and split in words
2204 foreach (split / /,$line) {
2205 next unless $_; # skip empty values (multiple spaces)
2206 # if the entry is already here, do nothing, the biblionumber has already be removed
2207 unless ($result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2208 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2209 $sth2->execute($server,$key,$_);
2210 my $existing_biblionumbers = $sth2->fetchrow;
2212 if ($existing_biblionumbers) {
2213 # warn " existing for $key $_: $existing_biblionumbers";
2214 $result{$key}->{$_} =$existing_biblionumbers;
2215 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2221 # the subfield is not indexed, store it in __RAW__ index anyway
2223 my $line= lc $subfield->[1];
2224 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2225 # ... and split in words
2226 foreach (split / /,$line) {
2227 next unless $_; # skip empty values (multiple spaces)
2228 # if the entry is already here, do nothing, the biblionumber has already be removed
2229 unless ($result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2230 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2231 $sth2->execute($server,'__RAW__',$_);
2232 my $existing_biblionumbers = $sth2->fetchrow;
2234 if ($existing_biblionumbers) {
2235 $result{'__RAW__'}->{$_} =$existing_biblionumbers;
2236 $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2246 =head2 _AddBiblioNoZebra($biblionumber, $record, $server, %result);
2248 function to add a biblio in NoZebra indexes
2252 sub _AddBiblioNoZebra {
2253 my ($biblionumber, $record, $server, %result)=@_;
2254 my $dbh = C4::Context->dbh;
2258 if ($server eq 'biblioserver') {
2259 %index=GetNoZebraIndexes;
2260 # get title of the record (to store the 10 first letters with the index)
2261 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
2262 $title = lc($record->subfield($titletag,$titlesubfield));
2264 # warn "server : $server";
2265 # for authorities, the "title" is the $a mainentry
2266 my ($auth_type_tag, $auth_type_sf) = C4::AuthoritiesMarc::get_auth_type_location();
2267 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield($auth_type_tag, $auth_type_sf));
2268 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2269 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2270 $index{'mainmainentry'} = $authref->{auth_tag_to_report}.'a';
2271 $index{'mainentry'} = $authref->{auth_tag_to_report}.'*';
2272 $index{'auth_type'} = "${auth_type_tag}${auth_type_sf}";
2275 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2276 $title =~ s/ |\.|,|;|\[|\]|\(|\)|\*|-|'|:|=|\r|\n//g;
2277 # limit to 10 char, should be enough, and limit the DB size
2278 $title = substr($title,0,10);
2280 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2281 foreach my $field ($record->fields()) {
2282 #parse each subfield
2283 next if $field->tag <10;
2284 foreach my $subfield ($field->subfields()) {
2285 my $tag = $field->tag();
2286 my $subfieldcode = $subfield->[0];
2288 warn "INDEXING :".$subfield->[1];
2289 # check each index to see if the subfield is stored somewhere
2290 # otherwise, store it in __RAW__ index
2291 foreach my $key (keys %index) {
2292 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2293 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2295 my $line= lc $subfield->[1];
2296 # remove meaningless value in the field...
2297 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2298 # ... and split in words
2299 foreach (split / /,$line) {
2300 next unless $_; # skip empty values (multiple spaces)
2301 # if the entry is already here, improve weight
2302 # warn "managing $_";
2303 if ($result{$key}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d);/) {
2305 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2306 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2308 # get the value if it exist in the nozebra table, otherwise, create it
2309 $sth2->execute($server,$key,$_);
2310 my $existing_biblionumbers = $sth2->fetchrow;
2312 if ($existing_biblionumbers) {
2313 $result{$key}->{"$_"} =$existing_biblionumbers;
2315 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2316 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2317 # create a new ligne for this entry
2319 # warn "INSERT : $server / $key / $_";
2320 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname='.$dbh->quote($key).',value='.$dbh->quote($_));
2321 $result{$key}->{"$_"}.="$biblionumber,$title-1;";
2327 # the subfield is not indexed, store it in __RAW__ index anyway
2329 my $line= lc $subfield->[1];
2330 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2331 # ... and split in words
2332 foreach (split / /,$line) {
2333 next unless $_; # skip empty values (multiple spaces)
2334 # if the entry is already here, improve weight
2335 if ($result{'__RAW__'}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d);/) {
2337 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2338 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2340 # get the value if it exist in the nozebra table, otherwise, create it
2341 $sth2->execute($server,'__RAW__',$_);
2342 my $existing_biblionumbers = $sth2->fetchrow;
2344 if ($existing_biblionumbers) {
2345 $result{'__RAW__'}->{"$_"} =$existing_biblionumbers;
2347 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2348 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2349 # create a new ligne for this entry
2351 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname="__RAW__",value='.$dbh->quote($_));
2352 $result{'__RAW__'}->{"$_"}.="$biblionumber,$title-1;";
2367 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2369 Find the given $subfield in the given $tag in the given
2370 MARC::Record $record. If the subfield is found, returns
2371 the (indicators, value) pair; otherwise, (undef, undef) is
2375 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2376 I suggest we export it from this module.
2383 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2386 if ( $tagfield < 10 ) {
2387 if ( $record->field($tagfield) ) {
2388 push @result, $record->field($tagfield)->data();
2395 foreach my $field ( $record->field($tagfield) ) {
2396 my @subfields = $field->subfields();
2397 foreach my $subfield (@subfields) {
2398 if ( @$subfield[0] eq $insubfield ) {
2399 push @result, @$subfield[1];
2400 $indicator = $field->indicator(1) . $field->indicator(2);
2405 return ( $indicator, @result );
2408 =head2 _koha_marc_update_bib_ids
2412 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
2414 Internal function to add or update biblionumber and biblioitemnumber to
2421 sub _koha_marc_update_bib_ids {
2422 my ($record, $frameworkcode, $biblionumber, $biblioitemnumber) = @_;
2424 # we must add bibnum and bibitemnum in MARC::Record...
2425 # we build the new field with biblionumber and biblioitemnumber
2426 # we drop the original field
2427 # we add the new builded field.
2428 my ($biblio_tag, $biblio_subfield ) = GetMarcFromKohaField("biblio.biblionumber",$frameworkcode);
2429 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.biblioitemnumber",$frameworkcode);
2431 if ($biblio_tag != $biblioitem_tag) {
2432 # biblionumber & biblioitemnumber are in different fields
2434 # deal with biblionumber
2435 my ($new_field, $old_field);
2436 if ($biblio_tag < 10) {
2437 $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
2440 MARC::Field->new( $biblio_tag, '', '',
2441 "$biblio_subfield" => $biblionumber );
2444 # drop old field and create new one...
2445 $old_field = $record->field($biblio_tag);
2446 $record->delete_field($old_field) if $old_field;
2447 $record->append_fields($new_field);
2449 # deal with biblioitemnumber
2450 if ($biblioitem_tag < 10) {
2451 $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
2454 MARC::Field->new( $biblioitem_tag, '', '',
2455 "$biblioitem_subfield" => $biblioitemnumber, );
2457 # drop old field and create new one...
2458 $old_field = $record->field($biblioitem_tag);
2459 $record->delete_field($old_field) if $old_field;
2460 $record->insert_fields_ordered($new_field);
2463 # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
2464 my $new_field = MARC::Field->new(
2465 $biblio_tag, '', '',
2466 "$biblio_subfield" => $biblionumber,
2467 "$biblioitem_subfield" => $biblioitemnumber
2470 # drop old field and create new one...
2471 my $old_field = $record->field($biblio_tag);
2472 $record->delete_field($old_field) if $old_field;
2473 $record->insert_fields_ordered($new_field);
2477 =head2 _koha_marc_update_biblioitem_cn_sort
2481 _koha_marc_update_biblioitem_cn_sort($marc, $biblioitem, $frameworkcode);
2485 Given a MARC bib record and the biblioitem hash, update the
2486 subfield that contains a copy of the value of biblioitems.cn_sort.
2490 sub _koha_marc_update_biblioitem_cn_sort {
2492 my $biblioitem = shift;
2493 my $frameworkcode= shift;
2495 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.cn_sort",$frameworkcode);
2496 return unless $biblioitem_tag;
2498 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2500 if (my $field = $marc->field($biblioitem_tag)) {
2501 $field->delete_subfield(code => $biblioitem_subfield);
2502 if ($cn_sort ne '') {
2503 $field->add_subfields($biblioitem_subfield => $cn_sort);
2506 # if we get here, no biblioitem tag is present in the MARC record, so
2507 # we'll create it if $cn_sort is not empty -- this would be
2508 # an odd combination of events, however
2510 $marc->insert_grouped_field(MARC::Field->new($biblioitem_tag, ' ', ' ', $biblioitem_subfield => $cn_sort));
2515 =head2 _koha_add_biblio
2519 my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
2521 Internal function to add a biblio ($biblio is a hash with the values)
2527 sub _koha_add_biblio {
2528 my ( $dbh, $biblio, $frameworkcode ) = @_;
2532 # set the series flag
2534 if ( $biblio->{'seriestitle'} ) { $serial = 1 };
2538 SET frameworkcode = ?,
2549 my $sth = $dbh->prepare($query);
2552 $biblio->{'author'},
2554 $biblio->{'unititle'},
2557 $biblio->{'seriestitle'},
2558 $biblio->{'copyrightdate'},
2559 $biblio->{'abstract'}
2562 my $biblionumber = $dbh->{'mysql_insertid'};
2563 if ( $dbh->errstr ) {
2564 $error.="ERROR in _koha_add_biblio $query".$dbh->errstr;
2569 #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
2570 return ($biblionumber,$error);
2573 =head2 _koha_modify_biblio
2577 my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
2579 Internal function for updating the biblio table
2585 sub _koha_modify_biblio {
2586 my ( $dbh, $biblio, $frameworkcode ) = @_;
2591 SET frameworkcode = ?,
2600 WHERE biblionumber = ?
2603 my $sth = $dbh->prepare($query);
2607 $biblio->{'author'},
2609 $biblio->{'unititle'},
2611 $biblio->{'serial'},
2612 $biblio->{'seriestitle'},
2613 $biblio->{'copyrightdate'},
2614 $biblio->{'abstract'},
2615 $biblio->{'biblionumber'}
2616 ) if $biblio->{'biblionumber'};
2618 if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
2619 $error.="ERROR in _koha_modify_biblio $query".$dbh->errstr;
2622 return ( $biblio->{'biblionumber'},$error );
2625 =head2 _koha_modify_biblioitem_nonmarc
2629 my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
2631 Updates biblioitems row except for marc and marcxml, which should be changed
2638 sub _koha_modify_biblioitem_nonmarc {
2639 my ( $dbh, $biblioitem ) = @_;
2642 # re-calculate the cn_sort, it may have changed
2643 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2647 SET biblionumber = ?,
2653 publicationyear = ?,
2657 collectiontitle = ?,
2659 collectionvolume= ?,
2660 editionstatement= ?,
2661 editionresponsibility = ?,
2675 where biblioitemnumber = ?
2677 my $sth = $dbh->prepare($query);
2679 $biblioitem->{'biblionumber'},
2680 $biblioitem->{'volume'},
2681 $biblioitem->{'number'},
2682 $biblioitem->{'itemtype'},
2683 $biblioitem->{'isbn'},
2684 $biblioitem->{'issn'},
2685 $biblioitem->{'publicationyear'},
2686 $biblioitem->{'publishercode'},
2687 $biblioitem->{'volumedate'},
2688 $biblioitem->{'volumedesc'},
2689 $biblioitem->{'collectiontitle'},
2690 $biblioitem->{'collectionissn'},
2691 $biblioitem->{'collectionvolume'},
2692 $biblioitem->{'editionstatement'},
2693 $biblioitem->{'editionresponsibility'},
2694 $biblioitem->{'illus'},
2695 $biblioitem->{'pages'},
2696 $biblioitem->{'bnotes'},
2697 $biblioitem->{'size'},
2698 $biblioitem->{'place'},
2699 $biblioitem->{'lccn'},
2700 $biblioitem->{'url'},
2701 $biblioitem->{'biblioitems.cn_source'},
2702 $biblioitem->{'cn_class'},
2703 $biblioitem->{'cn_item'},
2704 $biblioitem->{'cn_suffix'},
2706 $biblioitem->{'totalissues'},
2707 $biblioitem->{'biblioitemnumber'}
2709 if ( $dbh->errstr ) {
2710 $error.="ERROR in _koha_modify_biblioitem_nonmarc $query".$dbh->errstr;
2713 return ($biblioitem->{'biblioitemnumber'},$error);
2716 =head2 _koha_add_biblioitem
2720 my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
2722 Internal function to add a biblioitem
2728 sub _koha_add_biblioitem {
2729 my ( $dbh, $biblioitem ) = @_;
2732 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2734 "INSERT INTO biblioitems SET
2741 publicationyear = ?,
2745 collectiontitle = ?,
2747 collectionvolume= ?,
2748 editionstatement= ?,
2749 editionresponsibility = ?,
2765 my $sth = $dbh->prepare($query);
2767 $biblioitem->{'biblionumber'},
2768 $biblioitem->{'volume'},
2769 $biblioitem->{'number'},
2770 $biblioitem->{'itemtype'},
2771 $biblioitem->{'isbn'},
2772 $biblioitem->{'issn'},
2773 $biblioitem->{'publicationyear'},
2774 $biblioitem->{'publishercode'},
2775 $biblioitem->{'volumedate'},
2776 $biblioitem->{'volumedesc'},
2777 $biblioitem->{'collectiontitle'},
2778 $biblioitem->{'collectionissn'},
2779 $biblioitem->{'collectionvolume'},
2780 $biblioitem->{'editionstatement'},
2781 $biblioitem->{'editionresponsibility'},
2782 $biblioitem->{'illus'},
2783 $biblioitem->{'pages'},
2784 $biblioitem->{'bnotes'},
2785 $biblioitem->{'size'},
2786 $biblioitem->{'place'},
2787 $biblioitem->{'lccn'},
2788 $biblioitem->{'marc'},
2789 $biblioitem->{'url'},
2790 $biblioitem->{'biblioitems.cn_source'},
2791 $biblioitem->{'cn_class'},
2792 $biblioitem->{'cn_item'},
2793 $biblioitem->{'cn_suffix'},
2795 $biblioitem->{'totalissues'}
2797 my $bibitemnum = $dbh->{'mysql_insertid'};
2798 if ( $dbh->errstr ) {
2799 $error.="ERROR in _koha_add_biblioitem $query".$dbh->errstr;
2803 return ($bibitemnum,$error);
2806 =head2 _koha_delete_biblio
2810 $error = _koha_delete_biblio($dbh,$biblionumber);
2812 Internal sub for deleting from biblio table -- also saves to deletedbiblio
2814 C<$dbh> - the database handle
2815 C<$biblionumber> - the biblionumber of the biblio to be deleted
2821 # FIXME: add error handling
2823 sub _koha_delete_biblio {
2824 my ( $dbh, $biblionumber ) = @_;
2826 # get all the data for this biblio
2827 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
2828 $sth->execute($biblionumber);
2830 if ( my $data = $sth->fetchrow_hashref ) {
2832 # save the record in deletedbiblio
2833 # find the fields to save
2834 my $query = "INSERT INTO deletedbiblio SET ";
2836 foreach my $temp ( keys %$data ) {
2837 $query .= "$temp = ?,";
2838 push( @bind, $data->{$temp} );
2841 # replace the last , by ",?)"
2843 my $bkup_sth = $dbh->prepare($query);
2844 $bkup_sth->execute(@bind);
2848 my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
2849 $del_sth->execute($biblionumber);
2856 =head2 _koha_delete_biblioitems
2860 $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
2862 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
2864 C<$dbh> - the database handle
2865 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
2871 # FIXME: add error handling
2873 sub _koha_delete_biblioitems {
2874 my ( $dbh, $biblioitemnumber ) = @_;
2876 # get all the data for this biblioitem
2878 $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
2879 $sth->execute($biblioitemnumber);
2881 if ( my $data = $sth->fetchrow_hashref ) {
2883 # save the record in deletedbiblioitems
2884 # find the fields to save
2885 my $query = "INSERT INTO deletedbiblioitems SET ";
2887 foreach my $temp ( keys %$data ) {
2888 $query .= "$temp = ?,";
2889 push( @bind, $data->{$temp} );
2892 # replace the last , by ",?)"
2894 my $bkup_sth = $dbh->prepare($query);
2895 $bkup_sth->execute(@bind);
2898 # delete the biblioitem
2900 $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
2901 $del_sth->execute($biblioitemnumber);
2908 =head1 UNEXPORTED FUNCTIONS
2910 =head2 ModBiblioMarc
2912 &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
2914 Add MARC data for a biblio to koha
2916 Function exported, but should NOT be used, unless you really know what you're doing
2922 # pass the MARC::Record to this function, and it will create the records in the marc field
2923 my ( $record, $biblionumber, $frameworkcode ) = @_;
2924 my $dbh = C4::Context->dbh;
2925 my @fields = $record->fields();
2926 if ( !$frameworkcode ) {
2927 $frameworkcode = "";
2930 $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
2931 $sth->execute( $frameworkcode, $biblionumber );
2933 my $encoding = C4::Context->preference("marcflavour");
2935 # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
2936 if ( $encoding eq "UNIMARC" ) {
2938 if ( length($record->subfield( 100, "a" )) == 35 ) {
2939 $string = $record->subfield( 100, "a" );
2940 my $f100 = $record->field(100);
2941 $record->delete_field($f100);
2944 $string = POSIX::strftime( "%Y%m%d", localtime );
2946 $string = sprintf( "%-*s", 35, $string );
2948 substr( $string, 22, 6, "frey50" );
2949 unless ( $record->subfield( 100, "a" ) ) {
2950 $record->insert_grouped_field(
2951 MARC::Field->new( 100, "", "", "a" => $string ) );
2955 if (C4::Context->preference("NoZebra")) {
2956 # only NoZebra indexing needs to have
2957 # the previous version of the record
2958 $oldRecord = GetMarcBiblio($biblionumber);
2962 "UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
2963 $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding),
2966 ModZebra($biblionumber,"specialUpdate","biblioserver",$oldRecord,$record);
2967 return $biblionumber;
2970 =head2 z3950_extended_services
2972 z3950_extended_services($serviceType,$serviceOptions,$record);
2974 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.
2976 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
2978 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
2980 action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
2984 recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
2985 syntax => the record syntax (transfer syntax)
2986 databaseName = Database from connection object
2988 To set serviceOptions, call set_service_options($serviceType)
2990 C<$record> the record, if one is needed for the service type
2992 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
2996 sub z3950_extended_services {
2997 my ( $server, $serviceType, $action, $serviceOptions ) = @_;
2999 # get our connection object
3000 my $Zconn = C4::Context->Zconn( $server, 0, 1 );
3002 # create a new package object
3003 my $Zpackage = $Zconn->package();
3006 $Zpackage->option( action => $action );
3008 if ( $serviceOptions->{'databaseName'} ) {
3009 $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
3011 if ( $serviceOptions->{'recordIdNumber'} ) {
3013 recordIdNumber => $serviceOptions->{'recordIdNumber'} );
3015 if ( $serviceOptions->{'recordIdOpaque'} ) {
3017 recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
3020 # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
3021 #if ($serviceType eq 'itemorder') {
3022 # $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
3023 # $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
3024 # $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
3025 # $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
3028 if ( $serviceOptions->{record} ) {
3029 $Zpackage->option( record => $serviceOptions->{record} );
3031 # can be xml or marc
3032 if ( $serviceOptions->{'syntax'} ) {
3033 $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
3037 # send the request, handle any exception encountered
3038 eval { $Zpackage->send($serviceType) };
3039 if ( $@ && $@->isa("ZOOM::Exception") ) {
3040 return "error: " . $@->code() . " " . $@->message() . "\n";
3043 # free up package resources
3044 $Zpackage->destroy();
3047 =head2 set_service_options
3049 my $serviceOptions = set_service_options($serviceType);
3051 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
3053 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
3057 sub set_service_options {
3058 my ($serviceType) = @_;
3061 # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
3062 # $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
3064 if ( $serviceType eq 'commit' ) {
3068 if ( $serviceType eq 'create' ) {
3072 if ( $serviceType eq 'drop' ) {
3073 die "ERROR: 'drop' not currently supported (by Zebra)";
3075 return $serviceOptions;
3078 =head3 get_biblio_authorised_values
3080 find the types and values for all authorised values assigned to this biblio.
3085 returns: a hashref malling the authorised value to the value set for this biblionumber
3087 $authorised_values = {
3088 'Scent' => 'flowery',
3089 'Audience' => 'Young Adult',
3090 'itemtypes' => 'SER',
3093 Notes: forlibrarian should probably be passed in, and called something different.
3098 sub get_biblio_authorised_values {
3099 my $biblionumber = shift;
3101 my $forlibrarian = 1; # are we in staff or opac?
3102 my $frameworkcode = GetFrameworkCode( $biblionumber );
3104 my $authorised_values;
3106 my $record = GetMarcBiblio( $biblionumber );
3107 my $tagslib = GetMarcStructure( $forlibrarian, $frameworkcode );
3109 # assume that these entries in the authorised_value table are bibliolevel.
3110 # ones that start with 'item%' are item level.
3111 my $query = q(SELECT distinct authorised_value, kohafield
3112 FROM marc_subfield_structure
3113 WHERE authorised_value !=''
3114 AND (kohafield like 'biblio%'
3115 OR kohafield like '') );
3116 my $bibliolevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
3118 foreach my $tag ( keys( %$tagslib ) ) {
3119 foreach my $subfield ( keys( %{$tagslib->{ $tag }} ) ) {
3120 # warn "checking $subfield. type is: " . ref $tagslib->{ $tag }{ $subfield };
3121 if ( 'HASH' eq ref $tagslib->{ $tag }{ $subfield } ) {
3122 if ( exists $tagslib->{ $tag }{ $subfield }{'authorised_value'} && exists $bibliolevel_authorised_values->{ $tagslib->{ $tag }{ $subfield }{'authorised_value'} } ) {
3123 if ( defined $record->field( $tag ) ) {
3124 my $this_subfield_value = $record->field( $tag )->subfield( $subfield );
3125 if ( defined $this_subfield_value ) {
3126 $authorised_values->{ $tagslib->{ $tag }{ $subfield }{'authorised_value'} } = $this_subfield_value;
3133 # warn ( Data::Dumper->Dump( [ $authorised_values ], [ 'authorised_values' ] ) );
3134 return $authorised_values;
3144 Koha Developement team <info@koha.org>
3146 Paul POULAIN paul.poulain@free.fr
3148 Joshua Ferraro jmf@liblime.com