3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
23 use MARC::File::USMARC;
30 use C4::Dates qw/format_date/;
31 use C4::Log; # logaction
35 use vars qw($VERSION @ISA @EXPORT);
41 @ISA = qw( Exporter );
55 &GetBiblioItemByBiblioNumber
56 &GetBiblioFromItemNumber
67 &GetAuthorisedValueDesc
71 &GetPublisherNameFromIsbn
86 # To link headings in a bib record
87 # to authority records.
89 &LinkBibHeadingsToAuthorities
93 # those functions are exported but should not be used
94 # they are usefull is few circumstances, so are exported.
95 # but don't use them unless you're a core developer ;-)
102 &TransformHtmlToMarc2
105 &PrepareItemrecordDisplay
110 # because of interdependencies between
111 # C4::Search, C4::Heading, and C4::Biblio,
112 # 'use C4::Heading' must occur after
113 # the exports have been defined.
118 C4::Biblio - cataloging management functions
122 Biblio.pm contains functions for managing storage and editing of bibliographic data within Koha. Most of the functions in this module are used for cataloging records: adding, editing, or removing biblios, biblioitems, or items. Koha's stores bibliographic information in three places:
126 =item 1. in the biblio,biblioitems,items, etc tables, which are limited to a one-to-one mapping to underlying MARC data
128 =item 2. as raw MARC in the Zebra index and storage engine
130 =item 3. as raw MARC the biblioitems.marc and biblioitems.marcxml
134 In the 3.0 version of Koha, the authoritative record-level information is in biblioitems.marcxml
136 Because the data isn't completely normalized there's a chance for information to get out of sync. The design choice to go with a un-normalized schema was driven by performance and stability concerns. However, if this occur, it can be considered as a bug : The API is (or should be) complete & the only entry point for all biblio/items managements.
140 =item 1. Compared with MySQL, Zebra is slow to update an index for small data changes -- especially for proc-intensive operations like circulation
142 =item 2. Zebra's index has been known to crash and a backup of the data is necessary to rebuild it in such cases
146 Because of this design choice, the process of managing storage and editing is a bit convoluted. Historically, Biblio.pm's grown to an unmanagable size and as a result we have several types of functions currently:
150 =item 1. Add*/Mod*/Del*/ - high-level external functions suitable for being called from external scripts to manage the collection
152 =item 2. _koha_* - low-level internal functions for managing the koha tables
154 =item 3. Marc management function : as the MARC record is stored in biblioitems.marc(xml), some subs dedicated to it's management are in this package. They should be used only internally by Biblio.pm, the only official entry points being AddBiblio, AddItem, ModBiblio, ModItem.
156 =item 4. Zebra functions used to update the Zebra index
158 =item 5. internal helper functions such as char_decode, checkitems, etc. Some of these probably belong in Koha.pm
162 The MARC record (in biblioitems.marcxml) contains the complete marc record, including items. It also contains the biblionumber. That is the reason why it is not stored directly by AddBiblio, with all other fields . To save a biblio, we need to :
166 =item 1. save datas in biblio and biblioitems table, that gives us a biblionumber and a biblioitemnumber
168 =item 2. add the biblionumber and biblioitemnumber into the MARC records
170 =item 3. save the marc record
174 When dealing with items, we must :
178 =item 1. save the item in items table, that gives us an itemnumber
180 =item 2. add the itemnumber to the item MARC field
182 =item 3. overwrite the MARC record (with the added item) into biblioitems.marc(xml)
184 When modifying a biblio or an item, the behaviour is quite similar.
188 =head1 EXPORTED FUNCTIONS
194 ($biblionumber,$biblioitemnumber) = AddBiblio($record,$frameworkcode);
198 Exported function (core API) for adding a new biblio to koha.
200 The first argument is a C<MARC::Record> object containing the
201 bib to add, while the second argument is the desired MARC
204 This function also accepts a third, optional argument: a hashref
205 to additional options. The only defined option is C<defer_marc_save>,
206 which if present and mapped to a true value, causes C<AddBiblio>
207 to omit the call to save the MARC in C<bibilioitems.marc>
208 and C<biblioitems.marcxml> This option is provided B<only>
209 for the use of scripts such as C<bulkmarcimport.pl> that may need
210 to do some manipulation of the MARC record for item parsing before
211 saving it and which cannot afford the performance hit of saving
212 the MARC record twice. Consequently, do not use that option
213 unless you can guarantee that C<ModBiblioMarc> will be called.
219 my $frameworkcode = shift;
220 my $options = @_ ? shift : undef;
221 my $defer_marc_save = 0;
222 if (defined $options and exists $options->{'defer_marc_save'} and $options->{'defer_marc_save'}) {
223 $defer_marc_save = 1;
226 my ($biblionumber,$biblioitemnumber,$error);
227 my $dbh = C4::Context->dbh;
228 # transform the data into koha-table style data
229 my $olddata = TransformMarcToKoha( $dbh, $record, $frameworkcode );
230 ($biblionumber,$error) = _koha_add_biblio( $dbh, $olddata, $frameworkcode );
231 $olddata->{'biblionumber'} = $biblionumber;
232 ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $olddata );
234 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
236 # update MARC subfield that stores biblioitems.cn_sort
237 _koha_marc_update_biblioitem_cn_sort($record, $olddata, $frameworkcode);
240 $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode ) unless $defer_marc_save;
242 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","ADD",$biblionumber,"biblio")
243 if C4::Context->preference("CataloguingLog");
245 return ( $biblionumber, $biblioitemnumber );
250 ModBiblio( $record,$biblionumber,$frameworkcode);
251 Exported function (core API) to modify a biblio
256 my ( $record, $biblionumber, $frameworkcode ) = @_;
257 if (C4::Context->preference("CataloguingLog")) {
258 my $newrecord = GetMarcBiblio($biblionumber);
259 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","MODIFY",$biblionumber,"BEFORE=>".$newrecord->as_formatted);
262 my $dbh = C4::Context->dbh;
264 $frameworkcode = "" unless $frameworkcode;
266 # get the items before and append them to the biblio before updating the record, atm we just have the biblio
267 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
268 my $oldRecord = GetMarcBiblio( $biblionumber );
270 # parse each item, and, for an unknown reason, re-encode each subfield
271 # if you don't do that, the record will have encoding mixed
272 # and the biblio will be re-encoded.
273 # strange, I (Paul P.) searched more than 1 day to understand what happends
274 # but could only solve the problem this way...
275 my @fields = $oldRecord->field( $itemtag );
276 foreach my $fielditem ( @fields ){
278 foreach ($fielditem->subfields()) {
280 $field->add_subfields(Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
282 $field = MARC::Field->new("$itemtag",'','',Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
285 $record->append_fields($field);
288 # update biblionumber and biblioitemnumber in MARC
289 # FIXME - this is assuming a 1 to 1 relationship between
290 # biblios and biblioitems
291 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
292 $sth->execute($biblionumber);
293 my ($biblioitemnumber) = $sth->fetchrow;
295 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
297 # load the koha-table data object
298 my $oldbiblio = TransformMarcToKoha( $dbh, $record, $frameworkcode );
300 # update MARC subfield that stores biblioitems.cn_sort
301 _koha_marc_update_biblioitem_cn_sort($record, $oldbiblio, $frameworkcode);
303 # update the MARC record (that now contains biblio and items) with the new record data
304 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
306 # modify the other koha tables
307 _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
308 _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
312 =head2 ModBiblioframework
314 ModBiblioframework($biblionumber,$frameworkcode);
315 Exported function to modify a biblio framework
319 sub ModBiblioframework {
320 my ( $biblionumber, $frameworkcode ) = @_;
321 my $dbh = C4::Context->dbh;
322 my $sth = $dbh->prepare(
323 "UPDATE biblio SET frameworkcode=? WHERE biblionumber=?"
325 $sth->execute($frameworkcode, $biblionumber);
333 my $error = &DelBiblio($dbh,$biblionumber);
334 Exported function (core API) for deleting a biblio in koha.
335 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
336 Also backs it up to deleted* tables
337 Checks to make sure there are not issues on any of the items
339 C<$error> : undef unless an error occurs
346 my ( $biblionumber ) = @_;
347 my $dbh = C4::Context->dbh;
348 my $error; # for error handling
350 # First make sure this biblio has no items attached
351 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
352 $sth->execute($biblionumber);
353 if (my $itemnumber = $sth->fetchrow){
354 # Fix this to use a status the template can understand
355 $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
358 return $error if $error;
360 # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
361 # for at least 2 reasons :
362 # - we need to read the biblio if NoZebra is set (to remove it from the indexes
363 # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
364 # and we would have no way to remove it (except manually in zebra, but I bet it would be very hard to handle the problem)
365 ModZebra($biblionumber, "recordDelete", "biblioserver", undef);
367 # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
370 "SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
371 $sth->execute($biblionumber);
372 while ( my $biblioitemnumber = $sth->fetchrow ) {
374 # delete this biblioitem
375 $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
376 return $error if $error;
379 # delete biblio from Koha tables and save in deletedbiblio
380 # must do this *after* _koha_delete_biblioitems, otherwise
381 # delete cascade will prevent deletedbiblioitems rows
382 # from being generated by _koha_delete_biblioitems
383 $error = _koha_delete_biblio( $dbh, $biblionumber );
385 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","DELETE",$biblionumber,"")
386 if C4::Context->preference("CataloguingLog");
390 =head2 LinkBibHeadingsToAuthorities
394 my $headings_linked = LinkBibHeadingsToAuthorities($marc);
398 Links bib headings to authority records by checking
399 each authority-controlled field in the C<MARC::Record>
400 object C<$marc>, looking for a matching authority record,
401 and setting the linking subfield $9 to the ID of that
404 If no matching authority exists, or if multiple
405 authorities match, no $9 will be added, and any
406 existing one inthe field will be deleted.
408 Returns the number of heading links changed in the
413 sub LinkBibHeadingsToAuthorities {
416 my $num_headings_changed = 0;
417 foreach my $field ($bib->fields()) {
418 my $heading = C4::Heading->new_from_bib_field($field);
419 next unless defined $heading;
422 my $current_link = $field->subfield('9');
424 # look for matching authorities
425 my $authorities = $heading->authorities();
427 # want only one exact match
428 if ($#{ $authorities } == 0) {
429 my $authority = MARC::Record->new_from_usmarc($authorities->[0]);
430 my $authid = $authority->field('001')->data();
431 next if defined $current_link and $current_link eq $authid;
433 $field->delete_subfield(code => '9') if defined $current_link;
434 $field->add_subfields('9', $authid);
435 $num_headings_changed++;
437 if (defined $current_link) {
438 $field->delete_subfield(code => '9');
439 $num_headings_changed++;
444 return $num_headings_changed;
451 $data = &GetBiblioData($biblionumber);
452 Returns information about the book with the given biblionumber.
453 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
454 the C<biblio> and C<biblioitems> tables in the
456 In addition, C<$data-E<gt>{subject}> is the list of the book's
457 subjects, separated by C<" , "> (space, comma, space).
458 If there are multiple biblioitems with the given biblionumber, only
459 the first one is considered.
467 my $dbh = C4::Context->dbh;
469 # my $query = C4::Context->preference('item-level_itypes') ?
470 # " SELECT * , biblioitems.notes AS bnotes, biblio.notes
472 # LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
473 # WHERE biblio.biblionumber = ?
474 # AND biblioitems.biblionumber = biblio.biblionumber
477 my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
479 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
480 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
481 WHERE biblio.biblionumber = ?
482 AND biblioitems.biblionumber = biblio.biblionumber ";
484 my $sth = $dbh->prepare($query);
485 $sth->execute($bibnum);
487 $data = $sth->fetchrow_hashref;
491 } # sub GetBiblioData
493 =head2 &GetBiblioItemData
497 $itemdata = &GetBiblioItemData($biblioitemnumber);
499 Looks up the biblioitem with the given biblioitemnumber. Returns a
500 reference-to-hash. The keys are the fields from the C<biblio>,
501 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
502 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
509 sub GetBiblioItemData {
510 my ($biblioitemnumber) = @_;
511 my $dbh = C4::Context->dbh;
512 my $query = "SELECT *,biblioitems.notes AS bnotes
513 FROM biblio LEFT JOIN biblioitems on biblio.biblionumber=biblioitems.biblioitemnumber ";
514 unless(C4::Context->preference('item-level_itypes')) {
515 $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
517 $query .= " WHERE biblioitemnumber = ? ";
518 my $sth = $dbh->prepare($query);
520 $sth->execute($biblioitemnumber);
521 $data = $sth->fetchrow_hashref;
524 } # sub &GetBiblioItemData
526 =head2 GetBiblioItemByBiblioNumber
530 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
536 sub GetBiblioItemByBiblioNumber {
537 my ($biblionumber) = @_;
538 my $dbh = C4::Context->dbh;
539 my $sth = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
543 $sth->execute($biblionumber);
545 while ( my $data = $sth->fetchrow_hashref ) {
546 push @results, $data;
553 =head2 GetBiblioFromItemNumber
557 $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
559 Looks up the item with the given itemnumber. if undef, try the barcode.
561 C<&itemnodata> returns a reference-to-hash whose keys are the fields
562 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
570 sub GetBiblioFromItemNumber {
571 my ( $itemnumber, $barcode ) = @_;
572 my $dbh = C4::Context->dbh;
575 $sth=$dbh->prepare( "SELECT * FROM items
576 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
577 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
578 WHERE items.itemnumber = ?") ;
579 $sth->execute($itemnumber);
581 $sth=$dbh->prepare( "SELECT * FROM items
582 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
583 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
584 WHERE items.barcode = ?") ;
585 $sth->execute($barcode);
587 my $data = $sth->fetchrow_hashref;
596 ( $count, @results ) = &GetBiblio($biblionumber);
603 my ($biblionumber) = @_;
604 my $dbh = C4::Context->dbh;
605 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
608 $sth->execute($biblionumber);
609 while ( my $data = $sth->fetchrow_hashref ) {
610 $results[$count] = $data;
614 return ( $count, @results );
617 =head2 GetBiblioItemInfosOf
621 GetBiblioItemInfosOf(@biblioitemnumbers);
627 sub GetBiblioItemInfosOf {
628 my @biblioitemnumbers = @_;
631 SELECT biblioitemnumber,
635 WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
637 return get_infos_of( $query, 'biblioitemnumber' );
640 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
642 =head2 GetMarcStructure
646 $res = GetMarcStructure($forlibrarian,$frameworkcode);
648 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
649 $forlibrarian :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
650 $frameworkcode : the framework code to read
656 # cache for results of GetMarcStructure -- needed
658 our $marc_structure_cache;
660 sub GetMarcStructure {
661 my ( $forlibrarian, $frameworkcode ) = @_;
662 my $dbh=C4::Context->dbh;
663 $frameworkcode = "" unless $frameworkcode;
665 if (defined $marc_structure_cache and exists $marc_structure_cache->{$forlibrarian}->{$frameworkcode}) {
666 return $marc_structure_cache->{$forlibrarian}->{$frameworkcode};
670 my $libfield = ( $forlibrarian eq 1 ) ? 'liblibrarian' : 'libopac';
672 # check that framework exists
675 "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
676 $sth->execute($frameworkcode);
677 my ($total) = $sth->fetchrow;
678 $frameworkcode = "" unless ( $total > 0 );
681 "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable
682 FROM marc_tag_structure
683 WHERE frameworkcode=?
686 $sth->execute($frameworkcode);
687 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
689 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) =
692 $res->{$tag}->{lib} =
693 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
694 $res->{$tab}->{tab} = "";
695 $res->{$tag}->{mandatory} = $mandatory;
696 $res->{$tag}->{repeatable} = $repeatable;
701 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue
702 FROM marc_subfield_structure
703 WHERE frameworkcode=?
704 ORDER BY tagfield,tagsubfield
708 $sth->execute($frameworkcode);
711 my $authorised_value;
723 $tag, $subfield, $liblibrarian,
725 $mandatory, $repeatable, $authorised_value,
726 $authtypecode, $value_builder, $kohafield,
727 $seealso, $hidden, $isurl,
733 $res->{$tag}->{$subfield}->{lib} =
734 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
735 $res->{$tag}->{$subfield}->{tab} = $tab;
736 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
737 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
738 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
739 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
740 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
741 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
742 $res->{$tag}->{$subfield}->{seealso} = $seealso;
743 $res->{$tag}->{$subfield}->{hidden} = $hidden;
744 $res->{$tag}->{$subfield}->{isurl} = $isurl;
745 $res->{$tag}->{$subfield}->{'link'} = $link;
746 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
749 $marc_structure_cache->{$forlibrarian}->{$frameworkcode} = $res;
754 =head2 GetUsedMarcStructure
756 the same function as GetMarcStructure expcet it just take field
757 in tab 0-9. (used field)
759 my $results = GetUsedMarcStructure($frameworkcode);
761 L<$results> is a ref to an array which each case containts a ref
762 to a hash which each keys is the columns from marc_subfield_structure
764 L<$frameworkcode> is the framework code.
768 sub GetUsedMarcStructure($){
769 my $frameworkcode = shift || '';
770 my $dbh = C4::Context->dbh;
773 FROM marc_subfield_structure
775 AND frameworkcode = ?
778 my $sth = $dbh->prepare($query);
779 $sth->execute($frameworkcode);
780 while (my $row = $sth->fetchrow_hashref){
786 =head2 GetMarcFromKohaField
790 ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
791 Returns the MARC fields & subfields mapped to the koha field
792 for the given frameworkcode
798 sub GetMarcFromKohaField {
799 my ( $kohafield, $frameworkcode ) = @_;
800 return 0, 0 unless $kohafield;
801 my $relations = C4::Context->marcfromkohafield;
803 $relations->{$frameworkcode}->{$kohafield}->[0],
804 $relations->{$frameworkcode}->{$kohafield}->[1]
812 Returns MARC::Record of the biblionumber passed in parameter.
813 the marc record contains both biblio & item datas
820 my $biblionumber = shift;
821 my $dbh = C4::Context->dbh;
823 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
824 $sth->execute($biblionumber);
825 my $row = $sth->fetchrow_hashref;
826 my $marcxml = StripNonXmlChars($row->{'marcxml'});
827 MARC::File::XML->default_record_format(C4::Context->preference('marcflavour'));
828 my $record = MARC::Record->new();
830 $record = eval {MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour'))};
831 if ($@) {warn " problem with :$biblionumber : $@ \n$marcxml";}
832 # $record = MARC::Record::new_from_usmarc( $marc) if $marc;
843 my $marcxml = GetXmlBiblio($biblionumber);
845 Returns biblioitems.marcxml of the biblionumber passed in parameter.
846 The XML contains both biblio & item datas
853 my ( $biblionumber ) = @_;
854 my $dbh = C4::Context->dbh;
856 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
857 $sth->execute($biblionumber);
858 my ($marcxml) = $sth->fetchrow;
862 =head2 GetAuthorisedValueDesc
866 my $subfieldvalue =get_authorised_value_desc(
867 $tag, $subf[$i][0],$subf[$i][1], '', $taglib, $category);
868 Retrieve the complete description for a given authorised value.
870 Now takes $category and $value pair too.
871 my $auth_value_desc =GetAuthorisedValueDesc(
872 '','', 'DVD' ,'','','CCODE');
878 sub GetAuthorisedValueDesc {
879 my ( $tag, $subfield, $value, $framework, $tagslib, $category ) = @_;
880 my $dbh = C4::Context->dbh;
884 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
885 return C4::Branch::GetBranchName($value);
889 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
890 return getitemtypeinfo($value)->{description};
893 #---- "true" authorized value
894 $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'}
897 if ( $category ne "" ) {
900 "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
902 $sth->execute( $category, $value );
903 my $data = $sth->fetchrow_hashref;
904 return $data->{'lib'};
907 return $value; # if nothing is found return the original value
915 $marcnotesarray = GetMarcNotes( $record, $marcflavour );
916 Get all notes from the MARC record and returns them in an array.
917 The note are stored in differents places depending on MARC flavour
924 my ( $record, $marcflavour ) = @_;
926 if ( $marcflavour eq "MARC21" ) {
929 else { # assume unimarc if not marc21
936 foreach my $field ( $record->field($scope) ) {
937 my $value = $field->as_string();
939 $marcnote = { marcnote => $note, };
940 push @marcnotes, $marcnote;
943 if ( $note ne $value ) {
944 $note = $note . " " . $value;
949 $marcnote = { marcnote => $note };
950 push @marcnotes, $marcnote; #load last tag into array
955 =head2 GetMarcSubjects
959 $marcsubjcts = GetMarcSubjects($record,$marcflavour);
960 Get all subjects from the MARC record and returns them in an array.
961 The subjects are stored in differents places depending on MARC flavour
967 sub GetMarcSubjects {
968 my ( $record, $marcflavour ) = @_;
969 my ( $mintag, $maxtag );
970 if ( $marcflavour eq "MARC21" ) {
974 else { # assume unimarc if not marc21
984 foreach my $field ( $record->field('6..' )) {
985 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
987 my @subfields = $field->subfields();
990 # if there is an authority link, build the link with an= subfield9
991 my $subfield9 = $field->subfield('9');
992 for my $subject_subfield (@subfields ) {
993 # don't load unimarc subfields 3,4,5
994 next if (($marcflavour eq "UNIMARC") and ($subject_subfield->[0] =~ (3|4|5) ) );
995 my $code = $subject_subfield->[0];
996 my $value = $subject_subfield->[1];
997 my $linkvalue = $value;
998 $linkvalue =~ s/(\(|\))//g;
999 my $operator = " and " unless $counter==0;
1001 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1003 push @link_loop, {'limit' => 'su', link => $linkvalue, operator => $operator };
1005 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1007 my @this_link_loop = @link_loop;
1008 push @subfields_loop, {code => $code, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($subject_subfield->[0] == 9 );
1012 push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1015 return \@marcsubjects;
1016 } #end getMARCsubjects
1018 =head2 GetMarcAuthors
1022 authors = GetMarcAuthors($record,$marcflavour);
1023 Get all authors from the MARC record and returns them in an array.
1024 The authors are stored in differents places depending on MARC flavour
1030 sub GetMarcAuthors {
1031 my ( $record, $marcflavour ) = @_;
1032 my ( $mintag, $maxtag );
1033 # tagslib useful for UNIMARC author reponsabilities
1034 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.
1035 if ( $marcflavour eq "MARC21" ) {
1039 elsif ( $marcflavour eq "UNIMARC" ) { # assume unimarc if not marc21
1048 foreach my $field ( $record->fields ) {
1049 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1052 my @subfields = $field->subfields();
1054 # if there is an authority link, build the link with Koha-Auth-Number: subfield9
1055 my $subfield9 = $field->subfield('9');
1056 for my $authors_subfield (@subfields) {
1057 # don't load unimarc subfields 3, 5
1058 next if ($marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~ (3|5) ) );
1059 my $subfieldcode = $authors_subfield->[0];
1060 my $value = $authors_subfield->[1];
1061 my $linkvalue = $value;
1062 $linkvalue =~ s/(\(|\))//g;
1063 my $operator = " and " unless $count_auth==0;
1064 # if we have an authority link, use that as the link, otherwise use standard searching
1066 @link_loop = ({'limit' => 'Koha-Auth-Number' ,link => "$subfield9" });
1069 # reset $linkvalue if UNIMARC author responsibility
1070 if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] eq "4")) {
1071 $linkvalue = "(".GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ).")";
1073 push @link_loop, {'limit' => 'au', link => $linkvalue, operator => $operator };
1075 $value = GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ) if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] =~/4/));
1076 my @this_link_loop = @link_loop;
1077 my $separator = C4::Context->preference("authoritysep") unless $count_auth==0;
1078 push @subfields_loop, {code => $subfieldcode, value => $value, link_loop => \@this_link_loop, separator => $separator} unless ($authors_subfield->[0] == 9 );
1081 push @marcauthors, { MARCAUTHOR_SUBFIELDS_LOOP => \@subfields_loop };
1083 return \@marcauthors;
1090 $marcurls = GetMarcUrls($record,$marcflavour);
1091 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1092 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1099 my ($record, $marcflavour) = @_;
1102 for my $field ($record->field('856')) {
1103 my $url = $field->subfield('u');
1105 for my $note ( $field->subfield('z')) {
1106 push @notes , {note => $note};
1108 $marcurl = { MARCURL => $url,
1111 if($marcflavour eq 'MARC21') {
1112 my $s3 = $field->subfield('3');
1113 my $link = $field->subfield('y');
1114 $marcurl->{'linktext'} = $link || $s3 || $url ;;
1115 $marcurl->{'part'} = $s3 if($link);
1116 $marcurl->{'toc'} = 1 if($s3 =~ /^[Tt]able/) ;
1118 $marcurl->{'linktext'} = $url;
1120 push @marcurls, $marcurl;
1125 =head2 GetMarcSeries
1129 $marcseriesarray = GetMarcSeries($record,$marcflavour);
1130 Get all series from the MARC record and returns them in an array.
1131 The series are stored in differents places depending on MARC flavour
1138 my ($record, $marcflavour) = @_;
1139 my ($mintag, $maxtag);
1140 if ($marcflavour eq "MARC21") {
1143 } else { # assume unimarc if not marc21
1153 foreach my $field ($record->field('440'), $record->field('490')) {
1155 #my $value = $field->subfield('a');
1156 #$marcsubjct = {MARCSUBJCT => $value,};
1157 my @subfields = $field->subfields();
1158 #warn "subfields:".join " ", @$subfields;
1161 for my $series_subfield (@subfields) {
1163 undef $volume_number;
1164 # see if this is an instance of a volume
1165 if ($series_subfield->[0] eq 'v') {
1169 my $code = $series_subfield->[0];
1170 my $value = $series_subfield->[1];
1171 my $linkvalue = $value;
1172 $linkvalue =~ s/(\(|\))//g;
1173 my $operator = " and " unless $counter==0;
1174 push @link_loop, {link => $linkvalue, operator => $operator };
1175 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1176 if ($volume_number) {
1177 push @subfields_loop, {volumenum => $value};
1180 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number};
1184 push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
1185 #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
1186 #push @marcsubjcts, $marcsubjct;
1190 my $marcseriessarray=\@marcseries;
1191 return $marcseriessarray;
1192 } #end getMARCseriess
1194 =head2 GetFrameworkCode
1198 $frameworkcode = GetFrameworkCode( $biblionumber )
1204 sub GetFrameworkCode {
1205 my ( $biblionumber ) = @_;
1206 my $dbh = C4::Context->dbh;
1207 my $sth = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
1208 $sth->execute($biblionumber);
1209 my ($frameworkcode) = $sth->fetchrow;
1210 return $frameworkcode;
1213 =head2 GetPublisherNameFromIsbn
1215 $name = GetPublishercodeFromIsbn($isbn);
1222 sub GetPublisherNameFromIsbn($){
1224 $isbn =~ s/[- _]//g;
1226 my @codes = (split '-', DisplayISBN($isbn));
1227 my $code = $codes[0].$codes[1].$codes[2];
1228 my $dbh = C4::Context->dbh;
1230 SELECT distinct publishercode
1233 AND publishercode IS NOT NULL
1236 my $sth = $dbh->prepare($query);
1237 $sth->execute("$code%");
1238 my $name = $sth->fetchrow;
1239 return $name if length $name;
1243 =head2 TransformKohaToMarc
1247 $record = TransformKohaToMarc( $hash )
1248 This function builds partial MARC::Record from a hash
1249 Hash entries can be from biblio or biblioitems.
1250 This function is called in acquisition module, to create a basic catalogue entry from user entry
1256 sub TransformKohaToMarc {
1259 my $dbh = C4::Context->dbh;
1262 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1264 my $record = MARC::Record->new();
1265 foreach (keys %{$hash}) {
1266 &TransformKohaToMarcOneField( $sth, $record, $_,
1272 =head2 TransformKohaToMarcOneField
1276 $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
1282 sub TransformKohaToMarcOneField {
1283 my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
1284 $frameworkcode='' unless $frameworkcode;
1288 if ( !defined $sth ) {
1289 my $dbh = C4::Context->dbh;
1290 $sth = $dbh->prepare(
1291 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
1294 $sth->execute( $frameworkcode, $kohafieldname );
1295 if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
1296 my $tag = $record->field($tagfield);
1298 $tag->update( $tagsubfield => $value );
1299 $record->delete_field($tag);
1300 $record->insert_fields_ordered($tag);
1303 $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
1309 =head2 TransformHtmlToXml
1313 $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type )
1315 $auth_type contains :
1316 - nothing : rebuild a biblio, un UNIMARC the encoding is in 100$a pos 26/27
1317 - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
1318 - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
1324 sub TransformHtmlToXml {
1325 my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
1326 my $xml = MARC::File::XML::header('UTF-8');
1327 $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
1328 MARC::File::XML->default_record_format($auth_type);
1329 # in UNIMARC, field 100 contains the encoding
1330 # check that there is one, otherwise the
1331 # MARC::Record->new_from_xml will fail (and Koha will die)
1332 my $unimarc_and_100_exist=0;
1333 $unimarc_and_100_exist=1 if $auth_type eq 'ITEM'; # if we rebuild an item, no need of a 100 field
1338 for ( my $i = 0 ; $i <= @$tags ; $i++ ) {
1339 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a") {
1340 # if we have a 100 field and it's values are not correct, skip them.
1341 # if we don't have any valid 100 field, we will create a default one at the end
1342 my $enc = substr( @$values[$i], 26, 2 );
1343 if ($enc eq '01' or $enc eq '50' or $enc eq '03') {
1344 $unimarc_and_100_exist=1;
1349 @$values[$i] =~ s/&/&/g;
1350 @$values[$i] =~ s/</</g;
1351 @$values[$i] =~ s/>/>/g;
1352 @$values[$i] =~ s/"/"/g;
1353 @$values[$i] =~ s/'/'/g;
1354 # if ( !utf8::is_utf8( @$values[$i] ) ) {
1355 # utf8::decode( @$values[$i] );
1357 if ( ( @$tags[$i] ne $prevtag ) ) {
1358 $j++ unless ( @$tags[$i] eq "" );
1360 $xml .= "</datafield>\n";
1361 if ( ( @$tags[$i] && @$tags[$i] > 10 )
1362 && ( @$values[$i] ne "" ) )
1364 my $ind1 = substr( @$indicator[$j], 0, 1 );
1366 if ( @$indicator[$j] ) {
1367 $ind2 = substr( @$indicator[$j], 1, 1 );
1370 warn "Indicator in @$tags[$i] is empty";
1374 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1376 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1384 if ( @$values[$i] ne "" ) {
1387 if ( @$tags[$i] eq "000" ) {
1388 $xml .= "<leader>@$values[$i]</leader>\n";
1391 # rest of the fixed fields
1393 elsif ( @$tags[$i] < 10 ) {
1395 "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
1399 my $ind1 = substr( @$indicator[$j], 0, 1 );
1400 my $ind2 = substr( @$indicator[$j], 1, 1 );
1402 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1404 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1410 else { # @$tags[$i] eq $prevtag
1411 if ( @$values[$i] eq "" ) {
1415 my $ind1 = substr( @$indicator[$j], 0, 1 );
1416 my $ind2 = substr( @$indicator[$j], 1, 1 );
1418 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1422 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1425 $prevtag = @$tags[$i];
1427 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and !$unimarc_and_100_exist) {
1428 # warn "SETTING 100 for $auth_type";
1429 use POSIX qw(strftime);
1430 my $string = strftime( "%Y%m%d", localtime(time) );
1431 # set 50 to position 26 is biblios, 13 if authorities
1433 $pos=13 if $auth_type eq 'UNIMARCAUTH';
1434 $string = sprintf( "%-*s", 35, $string );
1435 substr( $string, $pos , 6, "50" );
1436 $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
1437 $xml .= "<subfield code=\"a\">$string</subfield>\n";
1438 $xml .= "</datafield>\n";
1440 $xml .= MARC::File::XML::footer();
1444 =head2 TransformHtmlToMarc
1446 L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
1447 L<$params> is a ref to an array as below:
1449 'tag_010_indicator_531951' ,
1450 'tag_010_code_a_531951_145735' ,
1451 'tag_010_subfield_a_531951_145735' ,
1452 'tag_200_indicator_873510' ,
1453 'tag_200_code_a_873510_673465' ,
1454 'tag_200_subfield_a_873510_673465' ,
1455 'tag_200_code_b_873510_704318' ,
1456 'tag_200_subfield_b_873510_704318' ,
1457 'tag_200_code_e_873510_280822' ,
1458 'tag_200_subfield_e_873510_280822' ,
1459 'tag_200_code_f_873510_110730' ,
1460 'tag_200_subfield_f_873510_110730' ,
1462 L<$cgi> is the CGI object which containts the value.
1463 L<$record> is the MARC::Record object.
1467 sub TransformHtmlToMarc {
1471 # creating a new record
1472 my $record = MARC::Record->new();
1475 while ($params->[$i]){ # browse all CGI params
1476 my $param = $params->[$i];
1478 # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
1479 if ($param eq 'biblionumber') {
1480 my ( $biblionumbertagfield, $biblionumbertagsubfield ) =
1481 &GetMarcFromKohaField( "biblio.biblionumber", '' );
1482 if ($biblionumbertagfield < 10) {
1483 $newfield = MARC::Field->new(
1484 $biblionumbertagfield,
1485 $cgi->param($param),
1488 $newfield = MARC::Field->new(
1489 $biblionumbertagfield,
1492 "$biblionumbertagsubfield" => $cgi->param($param),
1495 push @fields,$newfield if($newfield);
1497 elsif ($param =~ /^tag_(\d*)_indicator_/){ # new field start when having 'input name="..._indicator_..."
1500 my $ind1 = substr($cgi->param($param),0,1);
1501 my $ind2 = substr($cgi->param($param),1,1);
1505 if($tag < 10){ # no code for theses fields
1506 # in MARC editor, 000 contains the leader.
1507 if ($tag eq '000' ) {
1508 $record->leader($cgi->param($params->[$j+1])) if length($cgi->param($params->[$j+1]))==24;
1509 # between 001 and 009 (included)
1511 $newfield = MARC::Field->new(
1513 $cgi->param($params->[$j+1]),
1516 # > 009, deal with subfields
1518 while($params->[$j] =~ /_code_/){ # browse all it's subfield
1519 my $inner_param = $params->[$j];
1521 if($cgi->param($params->[$j+1])){ # only if there is a value (code => value)
1522 $newfield->add_subfields(
1523 $cgi->param($inner_param) => $cgi->param($params->[$j+1])
1527 if ( $cgi->param($params->[$j+1]) ) { # creating only if there is a value (code => value)
1528 $newfield = MARC::Field->new(
1532 $cgi->param($inner_param) => $cgi->param($params->[$j+1]),
1539 push @fields,$newfield if($newfield);
1544 $record->append_fields(@fields);
1548 # cache inverted MARC field map
1549 our $inverted_field_map;
1551 =head2 TransformMarcToKoha
1555 $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
1559 Extract data from a MARC bib record into a hashref representing
1560 Koha biblio, biblioitems, and items fields.
1563 sub TransformMarcToKoha {
1564 my ( $dbh, $record, $frameworkcode, $limit_table ) = @_;
1568 unless (defined $inverted_field_map) {
1569 $inverted_field_map = _get_inverted_marc_field_map();
1573 if ($limit_table eq 'items') {
1574 $tables{'items'} = 1;
1576 $tables{'items'} = 1;
1577 $tables{'biblio'} = 1;
1578 $tables{'biblioitems'} = 1;
1581 # traverse through record
1582 MARCFIELD: foreach my $field ($record->fields()) {
1583 my $tag = $field->tag();
1584 next MARCFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag};
1585 if ($field->is_control_field()) {
1586 my $kohafields = $inverted_field_map->{$frameworkcode}->{$tag}->{list};
1587 ENTRY: foreach my $entry (@{ $kohafields }) {
1588 my ($subfield, $table, $column) = @{ $entry };
1589 next ENTRY unless exists $tables{$table};
1590 my $key = _disambiguate($table, $column);
1591 if ($result->{$key}) {
1592 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($field->data() eq "")) {
1593 $result->{$key} .= " | " . $field->data();
1596 $result->{$key} = $field->data();
1600 # deal with subfields
1601 MARCSUBFIELD: foreach my $sf ($field->subfields()) {
1602 my $code = $sf->[0];
1603 next MARCSUBFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code};
1604 my $value = $sf->[1];
1605 SFENTRY: foreach my $entry (@{ $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code} }) {
1606 my ($table, $column) = @{ $entry };
1607 next SFENTRY unless exists $tables{$table};
1608 my $key = _disambiguate($table, $column);
1609 if ($result->{$key}) {
1610 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($value eq "")) {
1611 $result->{$key} .= " | " . $value;
1614 $result->{$key} = $value;
1621 # modify copyrightdate to keep only the 1st year found
1622 if (exists $result->{'copyrightdate'}) {
1623 my $temp = $result->{'copyrightdate'};
1624 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
1626 $result->{'copyrightdate'} = $1;
1628 else { # if no cYYYY, get the 1st date.
1629 $temp =~ m/(\d\d\d\d)/;
1630 $result->{'copyrightdate'} = $1;
1634 # modify publicationyear to keep only the 1st year found
1635 if (exists $result->{'publicationyear'}) {
1636 my $temp = $result->{'publicationyear'};
1637 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
1639 $result->{'publicationyear'} = $1;
1641 else { # if no cYYYY, get the 1st date.
1642 $temp =~ m/(\d\d\d\d)/;
1643 $result->{'publicationyear'} = $1;
1650 sub _get_inverted_marc_field_map {
1652 my $relations = C4::Context->marcfromkohafield;
1654 foreach my $frameworkcode (keys %{ $relations }) {
1655 foreach my $kohafield (keys %{ $relations->{$frameworkcode} }) {
1656 my $tag = $relations->{$frameworkcode}->{$kohafield}->[0];
1657 my $subfield = $relations->{$frameworkcode}->{$kohafield}->[1];
1658 my ($table, $column) = split /[.]/, $kohafield, 2;
1659 push @{ $field_map->{$frameworkcode}->{$tag}->{list} }, [ $subfield, $table, $column ];
1660 push @{ $field_map->{$frameworkcode}->{$tag}->{sfs}->{$subfield} }, [ $table, $column ];
1666 =head2 _disambiguate
1670 $newkey = _disambiguate($table, $field);
1672 This is a temporary hack to distinguish between the
1673 following sets of columns when using TransformMarcToKoha.
1675 items.cn_source & biblioitems.cn_source
1676 items.cn_sort & biblioitems.cn_sort
1678 Columns that are currently NOT distinguished (FIXME
1679 due to lack of time to fully test) are:
1681 biblio.notes and biblioitems.notes
1686 FIXME - this is necessary because prefixing each column
1687 name with the table name would require changing lots
1688 of code and templates, and exposing more of the DB
1689 structure than is good to the UI templates, particularly
1690 since biblio and bibloitems may well merge in a future
1691 version. In the future, it would also be good to
1692 separate DB access and UI presentation field names
1700 my ($table, $column) = @_;
1701 if ($column eq "cn_sort" or $column eq "cn_source") {
1702 return $table . '.' . $column;
1709 =head2 get_koha_field_from_marc
1713 $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
1715 Internal function to map data from the MARC record to a specific non-MARC field.
1716 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
1722 sub get_koha_field_from_marc {
1723 my ($koha_table,$koha_column,$record,$frameworkcode) = @_;
1724 my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table.'.'.$koha_column, $frameworkcode );
1726 foreach my $field ( $record->field($tagfield) ) {
1727 if ( $field->tag() < 10 ) {
1729 $kohafield .= " | " . $field->data();
1732 $kohafield = $field->data();
1736 if ( $field->subfields ) {
1737 my @subfields = $field->subfields();
1738 foreach my $subfieldcount ( 0 .. $#subfields ) {
1739 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1742 " | " . $subfields[$subfieldcount][1];
1746 $subfields[$subfieldcount][1];
1757 =head2 TransformMarcToKohaOneField
1761 $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
1767 sub TransformMarcToKohaOneField {
1769 # FIXME ? if a field has a repeatable subfield that is used in old-db,
1770 # only the 1st will be retrieved...
1771 my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
1773 my ( $tagfield, $subfield ) =
1774 GetMarcFromKohaField( $kohatable . "." . $kohafield,
1776 foreach my $field ( $record->field($tagfield) ) {
1777 if ( $field->tag() < 10 ) {
1778 if ( $result->{$kohafield} ) {
1779 $result->{$kohafield} .= " | " . $field->data();
1782 $result->{$kohafield} = $field->data();
1786 if ( $field->subfields ) {
1787 my @subfields = $field->subfields();
1788 foreach my $subfieldcount ( 0 .. $#subfields ) {
1789 if ( $subfields[$subfieldcount][0] eq $subfield ) {
1790 if ( $result->{$kohafield} ) {
1791 $result->{$kohafield} .=
1792 " | " . $subfields[$subfieldcount][1];
1795 $result->{$kohafield} =
1796 $subfields[$subfieldcount][1];
1806 =head1 OTHER FUNCTIONS
1809 =head2 PrepareItemrecordDisplay
1813 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber);
1815 Returns a hash with all the fields for Display a given item data in a template
1821 sub PrepareItemrecordDisplay {
1823 my ( $bibnum, $itemnum ) = @_;
1825 my $dbh = C4::Context->dbh;
1826 my $frameworkcode = &GetFrameworkCode( $bibnum );
1827 my ( $itemtagfield, $itemtagsubfield ) =
1828 &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
1829 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
1830 my $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum) if ($itemnum);
1832 my $authorised_values_sth =
1834 "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib"
1836 foreach my $tag ( sort keys %{$tagslib} ) {
1837 my $previous_tag = '';
1839 # loop through each subfield
1841 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
1842 next if ( subfield_is_koha_internal_p($subfield) );
1843 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
1845 $subfield_data{tag} = $tag;
1846 $subfield_data{subfield} = $subfield;
1847 $subfield_data{countsubfield} = $cntsubf++;
1848 $subfield_data{kohafield} =
1849 $tagslib->{$tag}->{$subfield}->{'kohafield'};
1851 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
1852 $subfield_data{marc_lib} =
1853 "<span id=\"error\" title=\""
1854 . $tagslib->{$tag}->{$subfield}->{lib} . "\">"
1855 . substr( $tagslib->{$tag}->{$subfield}->{lib}, 0, 12 )
1857 $subfield_data{mandatory} =
1858 $tagslib->{$tag}->{$subfield}->{mandatory};
1859 $subfield_data{repeatable} =
1860 $tagslib->{$tag}->{$subfield}->{repeatable};
1861 $subfield_data{hidden} = "display:none"
1862 if $tagslib->{$tag}->{$subfield}->{hidden};
1864 ( $x, $value ) = _find_value( $tag, $subfield, $itemrecord )
1866 $value =~ s/"/"/g;
1868 # search for itemcallnumber if applicable
1869 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
1870 'items.itemcallnumber'
1871 && C4::Context->preference('itemcallnumber') )
1874 substr( C4::Context->preference('itemcallnumber'), 0, 3 );
1876 substr( C4::Context->preference('itemcallnumber'), 3, 1 );
1877 my $temp = $itemrecord->field($CNtag) if ($itemrecord);
1879 $value = $temp->subfield($CNsubfield);
1882 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
1883 my @authorised_values;
1886 # builds list, depending on authorised value...
1888 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq
1891 if ( ( C4::Context->preference("IndependantBranches") )
1892 && ( C4::Context->userenv->{flags} != 1 ) )
1896 "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname"
1898 $sth->execute( C4::Context->userenv->{branch} );
1899 push @authorised_values, ""
1901 $tagslib->{$tag}->{$subfield}->{mandatory} );
1902 while ( my ( $branchcode, $branchname ) =
1903 $sth->fetchrow_array )
1905 push @authorised_values, $branchcode;
1906 $authorised_lib{$branchcode} = $branchname;
1912 "SELECT branchcode,branchname FROM branches ORDER BY branchname"
1915 push @authorised_values, ""
1917 $tagslib->{$tag}->{$subfield}->{mandatory} );
1918 while ( my ( $branchcode, $branchname ) =
1919 $sth->fetchrow_array )
1921 push @authorised_values, $branchcode;
1922 $authorised_lib{$branchcode} = $branchname;
1928 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq
1933 "SELECT itemtype,description FROM itemtypes ORDER BY description"
1936 push @authorised_values, ""
1937 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
1938 while ( my ( $itemtype, $description ) =
1939 $sth->fetchrow_array )
1941 push @authorised_values, $itemtype;
1942 $authorised_lib{$itemtype} = $description;
1945 #---- "true" authorised value
1948 $authorised_values_sth->execute(
1949 $tagslib->{$tag}->{$subfield}->{authorised_value} );
1950 push @authorised_values, ""
1951 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
1952 while ( my ( $value, $lib ) =
1953 $authorised_values_sth->fetchrow_array )
1955 push @authorised_values, $value;
1956 $authorised_lib{$value} = $lib;
1959 $subfield_data{marc_value} = CGI::scrolling_list(
1960 -name => 'field_value',
1961 -values => \@authorised_values,
1962 -default => "$value",
1963 -labels => \%authorised_lib,
1969 elsif ( $tagslib->{$tag}->{$subfield}->{thesaurus_category} ) {
1970 $subfield_data{marc_value} =
1971 "<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>";
1974 # COMMENTED OUT because No $i is provided with this API.
1975 # And thus, no value_builder can be activated.
1976 # BUT could be thought over.
1977 # } elsif ($tagslib->{$tag}->{$subfield}->{'value_builder'}) {
1978 # my $plugin="value_builder/".$tagslib->{$tag}->{$subfield}->{'value_builder'};
1980 # my $extended_param = plugin_parameters($dbh,$itemrecord,$tagslib,$i,0);
1981 # my ($function_name,$javascript) = plugin_javascript($dbh,$record,$tagslib,$i,0);
1982 # $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";
1985 $subfield_data{marc_value} =
1986 "<input type=\"text\" name=\"field_value\" value=\"$value\" size=50 maxlength=255>";
1988 push( @loop_data, \%subfield_data );
1992 my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
1993 if ( $itemrecord && $itemrecord->field($itemtagfield) );
1995 'itemtagfield' => $itemtagfield,
1996 'itemtagsubfield' => $itemtagsubfield,
1997 'itemnumber' => $itemnumber,
1998 'iteminformation' => \@loop_data
2004 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2006 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2007 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2008 # =head2 ModZebrafiles
2010 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
2014 # sub ModZebrafiles {
2016 # my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
2020 # C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
2021 # unless ( opendir( DIR, "$zebradir" ) ) {
2022 # warn "$zebradir not found";
2026 # my $filename = $zebradir . $biblionumber;
2029 # open( OUTPUT, ">", $filename . ".xml" );
2030 # print OUTPUT $record;
2039 ModZebra( $biblionumber, $op, $server, $newRecord );
2041 $biblionumber is the biblionumber we want to index
2042 $op is specialUpdate or delete, and is used to know what we want to do
2043 $server is the server that we want to update
2044 $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.
2051 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
2052 my ( $biblionumber, $op, $server, $newRecord ) = @_;
2053 my $dbh=C4::Context->dbh;
2055 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2057 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2058 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2060 if (C4::Context->preference("NoZebra")) {
2061 # lock the nozebra table : we will read index lines, update them in Perl process
2062 # and write everything in 1 transaction.
2063 # lock the table to avoid someone else overwriting what we are doing
2064 $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE');
2065 my %result; # the result hash that will be builded by deletion / add, and written on mySQL at the end, to improve speed
2067 if ($server eq 'biblioserver') {
2068 $record= GetMarcBiblio($biblionumber);
2070 $record= C4::AuthoritiesMarc::GetAuthority($biblionumber);
2072 if ($op eq 'specialUpdate') {
2073 # OK, we have to add or update the record
2074 # 1st delete (virtually, in indexes), if record actually exists
2076 %result = _DelBiblioNoZebra($biblionumber,$record,$server);
2078 # ... add the record
2079 %result=_AddBiblioNoZebra($biblionumber,$newRecord, $server, %result);
2081 # it's a deletion, delete the record...
2082 # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
2083 %result=_DelBiblioNoZebra($biblionumber,$record,$server);
2085 # ok, now update the database...
2086 my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
2087 foreach my $key (keys %result) {
2088 foreach my $index (keys %{$result{$key}}) {
2089 $sth->execute($result{$key}->{$index}, $server, $key, $index);
2092 $dbh->do('UNLOCK TABLES');
2096 # we use zebra, just fill zebraqueue table
2098 my $check_sql = "SELECT COUNT(*) FROM zebraqueue
2100 AND biblio_auth_number = ?
2103 my $check_sth = $dbh->prepare_cached($check_sql);
2104 $check_sth->execute($server, $biblionumber, $op);
2105 my ($count) = $check_sth->fetchrow_array;
2106 $check_sth->finish();
2108 my $sth=$dbh->prepare("INSERT INTO zebraqueue (biblio_auth_number,server,operation) VALUES(?,?,?)");
2109 $sth->execute($biblionumber,$server,$op);
2115 =head2 GetNoZebraIndexes
2117 %indexes = GetNoZebraIndexes;
2119 return the data from NoZebraIndexes syspref.
2123 sub GetNoZebraIndexes {
2124 my $index = C4::Context->preference('NoZebraIndexes');
2126 foreach my $line (split /('|"),/,$index) {
2127 $line =~ /(.*)=>(.*)/;
2128 my $index = substr($1,1); # get the index, don't forget to remove initial ' or "
2130 $index =~ s/'|"|\s//g;
2133 $fields =~ s/'|"|\s//g;
2134 $indexes{$index}=$fields;
2139 =head1 INTERNAL FUNCTIONS
2141 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
2143 function to delete a biblio in NoZebra indexes
2144 This function does NOT delete anything in database : it reads all the indexes entries
2145 that have to be deleted & delete them in the hash
2146 The SQL part is done either :
2147 - after the Add if we are modifying a biblio (delete + add again)
2148 - immediatly after this sub if we are doing a true deletion.
2149 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
2154 sub _DelBiblioNoZebra {
2155 my ($biblionumber, $record, $server)=@_;
2158 my $dbh = C4::Context->dbh;
2162 if ($server eq 'biblioserver') {
2163 %index=GetNoZebraIndexes;
2164 # get title of the record (to store the 10 first letters with the index)
2165 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
2166 $title = lc($record->subfield($titletag,$titlesubfield));
2168 # for authorities, the "title" is the $a mainentry
2169 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
2170 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2171 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2172 $index{'mainmainentry'}= $authref->{'auth_tag_to_report'}.'a';
2173 $index{'mainentry'} = $authref->{'auth_tag_to_report'}.'*';
2174 $index{'auth_type'} = '152b';
2178 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2179 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
2180 # limit to 10 char, should be enough, and limit the DB size
2181 $title = substr($title,0,10);
2183 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2184 foreach my $field ($record->fields()) {
2185 #parse each subfield
2186 next if $field->tag <10;
2187 foreach my $subfield ($field->subfields()) {
2188 my $tag = $field->tag();
2189 my $subfieldcode = $subfield->[0];
2191 # check each index to see if the subfield is stored somewhere
2192 # otherwise, store it in __RAW__ index
2193 foreach my $key (keys %index) {
2194 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2195 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2197 my $line= lc $subfield->[1];
2198 # remove meaningless value in the field...
2199 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2200 # ... and split in words
2201 foreach (split / /,$line) {
2202 next unless $_; # skip empty values (multiple spaces)
2203 # if the entry is already here, do nothing, the biblionumber has already be removed
2204 unless ($result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2205 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2206 $sth2->execute($server,$key,$_);
2207 my $existing_biblionumbers = $sth2->fetchrow;
2209 if ($existing_biblionumbers) {
2210 # warn " existing for $key $_: $existing_biblionumbers";
2211 $result{$key}->{$_} =$existing_biblionumbers;
2212 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2218 # the subfield is not indexed, store it in __RAW__ index anyway
2220 my $line= lc $subfield->[1];
2221 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2222 # ... and split in words
2223 foreach (split / /,$line) {
2224 next unless $_; # skip empty values (multiple spaces)
2225 # if the entry is already here, do nothing, the biblionumber has already be removed
2226 unless ($result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/) {
2227 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2228 $sth2->execute($server,'__RAW__',$_);
2229 my $existing_biblionumbers = $sth2->fetchrow;
2231 if ($existing_biblionumbers) {
2232 $result{'__RAW__'}->{$_} =$existing_biblionumbers;
2233 $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2243 =head2 _AddBiblioNoZebra($biblionumber, $record, $server, %result);
2245 function to add a biblio in NoZebra indexes
2249 sub _AddBiblioNoZebra {
2250 my ($biblionumber, $record, $server, %result)=@_;
2251 my $dbh = C4::Context->dbh;
2255 if ($server eq 'biblioserver') {
2256 %index=GetNoZebraIndexes;
2257 # get title of the record (to store the 10 first letters with the index)
2258 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
2259 $title = lc($record->subfield($titletag,$titlesubfield));
2261 # warn "server : $server";
2262 # for authorities, the "title" is the $a mainentry
2263 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
2264 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
2265 $title = $record->subfield($authref->{auth_tag_to_report},'a');
2266 $index{'mainmainentry'} = $authref->{auth_tag_to_report}.'a';
2267 $index{'mainentry'} = $authref->{auth_tag_to_report}.'*';
2268 $index{'auth_type'} = '152b';
2271 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2272 $title =~ s/ |\.|,|;|\[|\]|\(|\)|\*|-|'|:|=//g;
2273 # limit to 10 char, should be enough, and limit the DB size
2274 $title = substr($title,0,10);
2276 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2277 foreach my $field ($record->fields()) {
2278 #parse each subfield
2279 next if $field->tag <10;
2280 foreach my $subfield ($field->subfields()) {
2281 my $tag = $field->tag();
2282 my $subfieldcode = $subfield->[0];
2284 # check each index to see if the subfield is stored somewhere
2285 # otherwise, store it in __RAW__ index
2286 foreach my $key (keys %index) {
2287 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2288 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
2290 my $line= lc $subfield->[1];
2291 # remove meaningless value in the field...
2292 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2293 # ... and split in words
2294 foreach (split / /,$line) {
2295 next unless $_; # skip empty values (multiple spaces)
2296 # if the entry is already here, improve weight
2297 # warn "managing $_";
2298 if ($result{$key}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d);/) {
2300 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2301 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2303 # get the value if it exist in the nozebra table, otherwise, create it
2304 $sth2->execute($server,$key,$_);
2305 my $existing_biblionumbers = $sth2->fetchrow;
2307 if ($existing_biblionumbers) {
2308 $result{$key}->{"$_"} =$existing_biblionumbers;
2310 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2311 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2312 # create a new ligne for this entry
2314 # warn "INSERT : $server / $key / $_";
2315 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname='.$dbh->quote($key).',value='.$dbh->quote($_));
2316 $result{$key}->{"$_"}.="$biblionumber,$title-1;";
2322 # the subfield is not indexed, store it in __RAW__ index anyway
2324 my $line= lc $subfield->[1];
2325 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2326 # ... and split in words
2327 foreach (split / /,$line) {
2328 next unless $_; # skip empty values (multiple spaces)
2329 # if the entry is already here, improve weight
2330 if ($result{'__RAW__'}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d);/) {
2332 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2333 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2335 # get the value if it exist in the nozebra table, otherwise, create it
2336 $sth2->execute($server,'__RAW__',$_);
2337 my $existing_biblionumbers = $sth2->fetchrow;
2339 if ($existing_biblionumbers) {
2340 $result{'__RAW__'}->{"$_"} =$existing_biblionumbers;
2342 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d);//;
2343 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2344 # create a new ligne for this entry
2346 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname="__RAW__",value='.$dbh->quote($_));
2347 $result{'__RAW__'}->{"$_"}.="$biblionumber,$title-1;";
2362 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2364 Find the given $subfield in the given $tag in the given
2365 MARC::Record $record. If the subfield is found, returns
2366 the (indicators, value) pair; otherwise, (undef, undef) is
2370 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2371 I suggest we export it from this module.
2378 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2381 if ( $tagfield < 10 ) {
2382 if ( $record->field($tagfield) ) {
2383 push @result, $record->field($tagfield)->data();
2390 foreach my $field ( $record->field($tagfield) ) {
2391 my @subfields = $field->subfields();
2392 foreach my $subfield (@subfields) {
2393 if ( @$subfield[0] eq $insubfield ) {
2394 push @result, @$subfield[1];
2395 $indicator = $field->indicator(1) . $field->indicator(2);
2400 return ( $indicator, @result );
2403 =head2 _koha_marc_update_bib_ids
2407 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
2409 Internal function to add or update biblionumber and biblioitemnumber to
2416 sub _koha_marc_update_bib_ids {
2417 my ($record, $frameworkcode, $biblionumber, $biblioitemnumber) = @_;
2419 # we must add bibnum and bibitemnum in MARC::Record...
2420 # we build the new field with biblionumber and biblioitemnumber
2421 # we drop the original field
2422 # we add the new builded field.
2423 my ($biblio_tag, $biblio_subfield ) = GetMarcFromKohaField("biblio.biblionumber",$frameworkcode);
2424 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.biblioitemnumber",$frameworkcode);
2426 if ($biblio_tag != $biblioitem_tag) {
2427 # biblionumber & biblioitemnumber are in different fields
2429 # deal with biblionumber
2430 my ($new_field, $old_field);
2431 if ($biblio_tag < 10) {
2432 $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
2435 MARC::Field->new( $biblio_tag, '', '',
2436 "$biblio_subfield" => $biblionumber );
2439 # drop old field and create new one...
2440 $old_field = $record->field($biblio_tag);
2441 $record->delete_field($old_field);
2442 $record->append_fields($new_field);
2444 # deal with biblioitemnumber
2445 if ($biblioitem_tag < 10) {
2446 $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
2449 MARC::Field->new( $biblioitem_tag, '', '',
2450 "$biblioitem_subfield" => $biblioitemnumber, );
2452 # drop old field and create new one...
2453 $old_field = $record->field($biblioitem_tag);
2454 $record->delete_field($old_field);
2455 $record->insert_fields_ordered($new_field);
2458 # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
2459 my $new_field = MARC::Field->new(
2460 $biblio_tag, '', '',
2461 "$biblio_subfield" => $biblionumber,
2462 "$biblioitem_subfield" => $biblioitemnumber
2465 # drop old field and create new one...
2466 my $old_field = $record->field($biblio_tag);
2467 $record->delete_field($old_field);
2468 $record->insert_fields_ordered($new_field);
2472 =head2 _koha_marc_update_biblioitem_cn_sort
2476 _koha_marc_update_biblioitem_cn_sort($marc, $biblioitem, $frameworkcode);
2480 Given a MARC bib record and the biblioitem hash, update the
2481 subfield that contains a copy of the value of biblioitems.cn_sort.
2485 sub _koha_marc_update_biblioitem_cn_sort {
2487 my $biblioitem = shift;
2488 my $frameworkcode= shift;
2490 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.cn_sort",$frameworkcode);
2491 return unless $biblioitem_tag;
2493 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2495 if (my $field = $marc->field($biblioitem_tag)) {
2496 $field->delete_subfield(code => $biblioitem_subfield);
2497 if ($cn_sort ne '') {
2498 $field->add_subfields($biblioitem_subfield => $cn_sort);
2501 # if we get here, no biblioitem tag is present in the MARC record, so
2502 # we'll create it if $cn_sort is not empty -- this would be
2503 # an odd combination of events, however
2505 $marc->insert_grouped_field(MARC::Field->new($biblioitem_tag, ' ', ' ', $biblioitem_subfield => $cn_sort));
2510 =head2 _koha_add_biblio
2514 my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
2516 Internal function to add a biblio ($biblio is a hash with the values)
2522 sub _koha_add_biblio {
2523 my ( $dbh, $biblio, $frameworkcode ) = @_;
2527 # set the series flag
2529 if ( $biblio->{'seriestitle'} ) { $serial = 1 };
2533 SET frameworkcode = ?,
2544 my $sth = $dbh->prepare($query);
2547 $biblio->{'author'},
2549 $biblio->{'unititle'},
2552 $biblio->{'seriestitle'},
2553 $biblio->{'copyrightdate'},
2554 $biblio->{'abstract'}
2557 my $biblionumber = $dbh->{'mysql_insertid'};
2558 if ( $dbh->errstr ) {
2559 $error.="ERROR in _koha_add_biblio $query".$dbh->errstr;
2564 #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
2565 return ($biblionumber,$error);
2568 =head2 _koha_modify_biblio
2572 my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
2574 Internal function for updating the biblio table
2580 sub _koha_modify_biblio {
2581 my ( $dbh, $biblio, $frameworkcode ) = @_;
2586 SET frameworkcode = ?,
2595 WHERE biblionumber = ?
2598 my $sth = $dbh->prepare($query);
2602 $biblio->{'author'},
2604 $biblio->{'unititle'},
2606 $biblio->{'serial'},
2607 $biblio->{'seriestitle'},
2608 $biblio->{'copyrightdate'},
2609 $biblio->{'abstract'},
2610 $biblio->{'biblionumber'}
2611 ) if $biblio->{'biblionumber'};
2613 if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
2614 $error.="ERROR in _koha_modify_biblio $query".$dbh->errstr;
2617 return ( $biblio->{'biblionumber'},$error );
2620 =head2 _koha_modify_biblioitem_nonmarc
2624 my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
2626 Updates biblioitems row except for marc and marcxml, which should be changed
2633 sub _koha_modify_biblioitem_nonmarc {
2634 my ( $dbh, $biblioitem ) = @_;
2637 # re-calculate the cn_sort, it may have changed
2638 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2642 SET biblionumber = ?,
2648 publicationyear = ?,
2652 collectiontitle = ?,
2654 collectionvolume= ?,
2655 editionstatement= ?,
2656 editionresponsibility = ?,
2670 where biblioitemnumber = ?
2672 my $sth = $dbh->prepare($query);
2674 $biblioitem->{'biblionumber'},
2675 $biblioitem->{'volume'},
2676 $biblioitem->{'number'},
2677 $biblioitem->{'itemtype'},
2678 $biblioitem->{'isbn'},
2679 $biblioitem->{'issn'},
2680 $biblioitem->{'publicationyear'},
2681 $biblioitem->{'publishercode'},
2682 $biblioitem->{'volumedate'},
2683 $biblioitem->{'volumedesc'},
2684 $biblioitem->{'collectiontitle'},
2685 $biblioitem->{'collectionissn'},
2686 $biblioitem->{'collectionvolume'},
2687 $biblioitem->{'editionstatement'},
2688 $biblioitem->{'editionresponsibility'},
2689 $biblioitem->{'illus'},
2690 $biblioitem->{'pages'},
2691 $biblioitem->{'bnotes'},
2692 $biblioitem->{'size'},
2693 $biblioitem->{'place'},
2694 $biblioitem->{'lccn'},
2695 $biblioitem->{'url'},
2696 $biblioitem->{'biblioitems.cn_source'},
2697 $biblioitem->{'cn_class'},
2698 $biblioitem->{'cn_item'},
2699 $biblioitem->{'cn_suffix'},
2701 $biblioitem->{'totalissues'},
2702 $biblioitem->{'biblioitemnumber'}
2704 if ( $dbh->errstr ) {
2705 $error.="ERROR in _koha_modify_biblioitem_nonmarc $query".$dbh->errstr;
2708 return ($biblioitem->{'biblioitemnumber'},$error);
2711 =head2 _koha_add_biblioitem
2715 my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
2717 Internal function to add a biblioitem
2723 sub _koha_add_biblioitem {
2724 my ( $dbh, $biblioitem ) = @_;
2727 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2729 "INSERT INTO biblioitems SET
2736 publicationyear = ?,
2740 collectiontitle = ?,
2742 collectionvolume= ?,
2743 editionstatement= ?,
2744 editionresponsibility = ?,
2760 my $sth = $dbh->prepare($query);
2762 $biblioitem->{'biblionumber'},
2763 $biblioitem->{'volume'},
2764 $biblioitem->{'number'},
2765 $biblioitem->{'itemtype'},
2766 $biblioitem->{'isbn'},
2767 $biblioitem->{'issn'},
2768 $biblioitem->{'publicationyear'},
2769 $biblioitem->{'publishercode'},
2770 $biblioitem->{'volumedate'},
2771 $biblioitem->{'volumedesc'},
2772 $biblioitem->{'collectiontitle'},
2773 $biblioitem->{'collectionissn'},
2774 $biblioitem->{'collectionvolume'},
2775 $biblioitem->{'editionstatement'},
2776 $biblioitem->{'editionresponsibility'},
2777 $biblioitem->{'illus'},
2778 $biblioitem->{'pages'},
2779 $biblioitem->{'bnotes'},
2780 $biblioitem->{'size'},
2781 $biblioitem->{'place'},
2782 $biblioitem->{'lccn'},
2783 $biblioitem->{'marc'},
2784 $biblioitem->{'url'},
2785 $biblioitem->{'biblioitems.cn_source'},
2786 $biblioitem->{'cn_class'},
2787 $biblioitem->{'cn_item'},
2788 $biblioitem->{'cn_suffix'},
2790 $biblioitem->{'totalissues'}
2792 my $bibitemnum = $dbh->{'mysql_insertid'};
2793 if ( $dbh->errstr ) {
2794 $error.="ERROR in _koha_add_biblioitem $query".$dbh->errstr;
2798 return ($bibitemnum,$error);
2801 =head2 _koha_delete_biblio
2805 $error = _koha_delete_biblio($dbh,$biblionumber);
2807 Internal sub for deleting from biblio table -- also saves to deletedbiblio
2809 C<$dbh> - the database handle
2810 C<$biblionumber> - the biblionumber of the biblio to be deleted
2816 # FIXME: add error handling
2818 sub _koha_delete_biblio {
2819 my ( $dbh, $biblionumber ) = @_;
2821 # get all the data for this biblio
2822 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
2823 $sth->execute($biblionumber);
2825 if ( my $data = $sth->fetchrow_hashref ) {
2827 # save the record in deletedbiblio
2828 # find the fields to save
2829 my $query = "INSERT INTO deletedbiblio SET ";
2831 foreach my $temp ( keys %$data ) {
2832 $query .= "$temp = ?,";
2833 push( @bind, $data->{$temp} );
2836 # replace the last , by ",?)"
2838 my $bkup_sth = $dbh->prepare($query);
2839 $bkup_sth->execute(@bind);
2843 my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
2844 $del_sth->execute($biblionumber);
2851 =head2 _koha_delete_biblioitems
2855 $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
2857 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
2859 C<$dbh> - the database handle
2860 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
2866 # FIXME: add error handling
2868 sub _koha_delete_biblioitems {
2869 my ( $dbh, $biblioitemnumber ) = @_;
2871 # get all the data for this biblioitem
2873 $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
2874 $sth->execute($biblioitemnumber);
2876 if ( my $data = $sth->fetchrow_hashref ) {
2878 # save the record in deletedbiblioitems
2879 # find the fields to save
2880 my $query = "INSERT INTO deletedbiblioitems SET ";
2882 foreach my $temp ( keys %$data ) {
2883 $query .= "$temp = ?,";
2884 push( @bind, $data->{$temp} );
2887 # replace the last , by ",?)"
2889 my $bkup_sth = $dbh->prepare($query);
2890 $bkup_sth->execute(@bind);
2893 # delete the biblioitem
2895 $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
2896 $del_sth->execute($biblioitemnumber);
2903 =head1 UNEXPORTED FUNCTIONS
2905 =head2 ModBiblioMarc
2907 &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
2909 Add MARC data for a biblio to koha
2911 Function exported, but should NOT be used, unless you really know what you're doing
2917 # pass the MARC::Record to this function, and it will create the records in the marc field
2918 my ( $record, $biblionumber, $frameworkcode ) = @_;
2919 my $dbh = C4::Context->dbh;
2920 my @fields = $record->fields();
2921 if ( !$frameworkcode ) {
2922 $frameworkcode = "";
2925 $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
2926 $sth->execute( $frameworkcode, $biblionumber );
2928 my $encoding = C4::Context->preference("marcflavour");
2930 # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
2931 if ( $encoding eq "UNIMARC" ) {
2933 if ( length($record->subfield( 100, "a" )) == 35 ) {
2934 $string = $record->subfield( 100, "a" );
2935 my $f100 = $record->field(100);
2936 $record->delete_field($f100);
2939 $string = POSIX::strftime( "%Y%m%d", localtime );
2941 $string = sprintf( "%-*s", 35, $string );
2943 substr( $string, 22, 6, "frey50" );
2944 unless ( $record->subfield( 100, "a" ) ) {
2945 $record->insert_grouped_field(
2946 MARC::Field->new( 100, "", "", "a" => $string ) );
2949 ModZebra($biblionumber,"specialUpdate","biblioserver",$record);
2952 "UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
2953 $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding),
2956 return $biblionumber;
2959 =head2 z3950_extended_services
2961 z3950_extended_services($serviceType,$serviceOptions,$record);
2963 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.
2965 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
2967 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
2969 action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
2973 recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
2974 syntax => the record syntax (transfer syntax)
2975 databaseName = Database from connection object
2977 To set serviceOptions, call set_service_options($serviceType)
2979 C<$record> the record, if one is needed for the service type
2981 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
2985 sub z3950_extended_services {
2986 my ( $server, $serviceType, $action, $serviceOptions ) = @_;
2988 # get our connection object
2989 my $Zconn = C4::Context->Zconn( $server, 0, 1 );
2991 # create a new package object
2992 my $Zpackage = $Zconn->package();
2995 $Zpackage->option( action => $action );
2997 if ( $serviceOptions->{'databaseName'} ) {
2998 $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
3000 if ( $serviceOptions->{'recordIdNumber'} ) {
3002 recordIdNumber => $serviceOptions->{'recordIdNumber'} );
3004 if ( $serviceOptions->{'recordIdOpaque'} ) {
3006 recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
3009 # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
3010 #if ($serviceType eq 'itemorder') {
3011 # $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
3012 # $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
3013 # $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
3014 # $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
3017 if ( $serviceOptions->{record} ) {
3018 $Zpackage->option( record => $serviceOptions->{record} );
3020 # can be xml or marc
3021 if ( $serviceOptions->{'syntax'} ) {
3022 $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
3026 # send the request, handle any exception encountered
3027 eval { $Zpackage->send($serviceType) };
3028 if ( $@ && $@->isa("ZOOM::Exception") ) {
3029 return "error: " . $@->code() . " " . $@->message() . "\n";
3032 # free up package resources
3033 $Zpackage->destroy();
3036 =head2 set_service_options
3038 my $serviceOptions = set_service_options($serviceType);
3040 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
3042 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
3046 sub set_service_options {
3047 my ($serviceType) = @_;
3050 # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
3051 # $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
3053 if ( $serviceType eq 'commit' ) {
3057 if ( $serviceType eq 'create' ) {
3061 if ( $serviceType eq 'drop' ) {
3062 die "ERROR: 'drop' not currently supported (by Zebra)";
3064 return $serviceOptions;
3073 Koha Developement team <info@koha.org>
3075 Paul POULAIN paul.poulain@free.fr
3077 Joshua Ferraro jmf@liblime.com