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
26 use MARC::File::USMARC;
30 use C4::Dates qw/format_date/;
31 use C4::Log; # logaction
34 use vars qw($VERSION @ISA @EXPORT);
39 @ISA = qw( Exporter );
43 # to add biblios or items
44 push @EXPORT, qw( &AddBiblio &AddItem );
52 &GetBiblioItemByBiblioNumber
53 &GetBiblioFromItemNumber
73 &GetItemsByBiblioitemnumber
74 &GetItemnumberFromBarcode
78 &GetAuthorisedValueDesc
82 &GetPublisherNameFromIsbn
94 &ModItemInMarconefield
105 # those functions are exported but should not be used
106 # they are usefull is few circumstances, so are exported.
107 # but don't use them unless you're a core developer ;-)
116 &TransformHtmlToMarc2
119 &PrepareItemrecordDisplay
126 C4::Biblio - cataloging management functions
130 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:
134 =item 1. in the biblio,biblioitems,items, etc tables, which are limited to a one-to-one mapping to underlying MARC data
136 =item 2. as raw MARC in the Zebra index and storage engine
138 =item 3. as raw MARC the biblioitems.marc and biblioitems.marcxml
142 In the 3.0 version of Koha, the authoritative record-level information is in biblioitems.marcxml
144 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.
148 =item 1. Compared with MySQL, Zebra is slow to update an index for small data changes -- especially for proc-intensive operations like circulation
150 =item 2. Zebra's index has been known to crash and a backup of the data is necessary to rebuild it in such cases
154 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:
158 =item 1. Add*/Mod*/Del*/ - high-level external functions suitable for being called from external scripts to manage the collection
160 =item 2. _koha_* - low-level internal functions for managing the koha tables
162 =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.
164 =item 4. Zebra functions used to update the Zebra index
166 =item 5. internal helper functions such as char_decode, checkitems, etc. Some of these probably belong in Koha.pm
170 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 :
174 =item 1. save datas in biblio and biblioitems table, that gives us a biblionumber and a biblioitemnumber
176 =item 2. add the biblionumber and biblioitemnumber into the MARC records
178 =item 3. save the marc record
182 When dealing with items, we must :
186 =item 1. save the item in items table, that gives us an itemnumber
188 =item 2. add the itemnumber to the item MARC field
190 =item 3. overwrite the MARC record (with the added item) into biblioitems.marc(xml)
192 When modifying a biblio or an item, the behaviour is quite similar.
196 =head1 EXPORTED FUNCTIONS
202 ($biblionumber,$biblioitemnumber) = AddBiblio($record,$frameworkcode);
203 Exported function (core API) for adding a new biblio to koha.
210 my ( $record, $frameworkcode ) = @_;
211 my ($biblionumber,$biblioitemnumber,$error);
212 my $dbh = C4::Context->dbh;
213 # transform the data into koha-table style data
214 my $olddata = TransformMarcToKoha( $dbh, $record, $frameworkcode );
215 ($biblionumber,$error) = _koha_add_biblio( $dbh, $olddata, $frameworkcode );
216 $olddata->{'biblionumber'} = $biblionumber;
217 ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $olddata );
219 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
222 $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
224 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","ADD",$biblionumber,"biblio")
225 if C4::Context->preference("CataloguingLog");
227 return ( $biblionumber, $biblioitemnumber );
234 $biblionumber = AddItem( $record, $biblionumber)
235 Exported function (core API) for adding a new item to Koha
242 my ( $record, $biblionumber ) = @_;
243 my $dbh = C4::Context->dbh;
246 my $frameworkcode = GetFrameworkCode( $biblionumber );
247 my $item = &TransformMarcToKoha( $dbh, $record, $frameworkcode );
249 # needs old biblionumber and biblioitemnumber
250 $item->{'biblionumber'} = $biblionumber;
253 "SELECT biblioitemnumber,itemtype FROM biblioitems WHERE biblionumber=?"
255 $sth->execute( $item->{'biblionumber'} );
257 ( $item->{'biblioitemnumber'}, $itemtype ) = $sth->fetchrow;
260 "SELECT notforloan FROM itemtypes WHERE itemtype=?");
261 $sth->execute( C4::Context->preference('item-level_itypes') ? $item->{'itype'} : $itemtype );
262 my $notforloan = $sth->fetchrow;
263 ##Change the notforloan field if $notforloan found
264 if ( $notforloan > 0 ) {
265 $item->{'notforloan'} = $notforloan;
266 &MARCitemchange( $record, "items.notforloan", $notforloan );
268 if ( !$item->{'dateaccessioned'} || $item->{'dateaccessioned'} eq '' ) {
271 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
276 "$year-" . sprintf( "%0.2d", $mon ) . "-" . sprintf( "%0.2d", $mday );
277 $item->{'dateaccessioned'} = $date;
278 &MARCitemchange( $record, "items.dateaccessioned", $date );
280 my ( $itemnumber, $error ) = &_koha_new_items( $dbh, $item, $item->{barcode} );
281 # add itemnumber to MARC::Record before adding the item.
282 $sth = $dbh->prepare(
283 "SELECT tagfield,tagsubfield
284 FROM marc_subfield_structure
285 WHERE frameworkcode=?
288 &TransformKohaToMarcOneField( $sth, $record, "items.itemnumber", $itemnumber,
292 &AddItemInMarc( $record, $item->{'biblionumber'},$frameworkcode );
294 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","ADD",$itemnumber,"item")
295 if C4::Context->preference("CataloguingLog");
297 return ($item->{biblionumber}, $item->{biblioitemnumber},$itemnumber);
302 ModBiblio( $record,$biblionumber,$frameworkcode);
303 Exported function (core API) to modify a biblio
308 my ( $record, $biblionumber, $frameworkcode ) = @_;
309 if (C4::Context->preference("CataloguingLog")) {
310 my $newrecord = GetMarcBiblio($biblionumber);
311 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","MODIFY",$biblionumber,"BEFORE=>".$newrecord->as_formatted);
314 my $dbh = C4::Context->dbh;
316 $frameworkcode = "" unless $frameworkcode;
318 # get the items before and append them to the biblio before updating the record, atm we just have the biblio
319 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
320 my $oldRecord = GetMarcBiblio( $biblionumber );
322 # parse each item, and, for an unknown reason, re-encode each subfield
323 # if you don't do that, the record will have encoding mixed
324 # and the biblio will be re-encoded.
325 # strange, I (Paul P.) searched more than 1 day to understand what happends
326 # but could only solve the problem this way...
327 my @fields = $oldRecord->field( $itemtag );
328 foreach my $fielditem ( @fields ){
330 foreach ($fielditem->subfields()) {
332 $field->add_subfields(Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
334 $field = MARC::Field->new("$itemtag",'','',Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
337 $record->append_fields($field);
340 # update biblionumber and biblioitemnumber in MARC
341 # FIXME - this is assuming a 1 to 1 relationship between
342 # biblios and biblioitems
343 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
344 $sth->execute($biblionumber);
345 my ($biblioitemnumber) = $sth->fetchrow;
347 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
349 # update the MARC record (that now contains biblio and items) with the new record data
350 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
352 # load the koha-table data object
353 my $oldbiblio = TransformMarcToKoha( $dbh, $record, $frameworkcode );
355 # modify the other koha tables
356 _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
357 _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
365 Exported function (core API) for modifying an item in Koha.
372 my ( $record, $biblionumber, $itemnumber, $delete, $new_item_hashref )
376 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","MODIFY",$itemnumber,$record->as_formatted)
377 if C4::Context->preference("CataloguingLog");
379 my $dbh = C4::Context->dbh;
381 # if we have a MARC record, we're coming from cataloging and so
382 # we do the whole routine: update the MARC and zebra, then update the koha
385 my $frameworkcode = GetFrameworkCode( $biblionumber );
386 ModItemInMarc( $record, $biblionumber, $itemnumber, $frameworkcode );
387 my $olditem = TransformMarcToKoha( $dbh, $record, $frameworkcode,'items');
388 $olditem->{'biblionumber'} = $biblionumber;
389 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
390 $sth->execute($biblionumber);
391 my ($biblioitemnumber) = $sth->fetchrow;
393 $olditem->{'biblioitemnumber'} = $biblioitemnumber;
394 _koha_modify_item( $dbh, $olditem );
395 return $biblionumber;
398 # otherwise, we're just looking to modify something quickly
399 # (like a status) so we just update the koha tables
400 elsif ($new_item_hashref) {
401 _koha_modify_item( $dbh, $new_item_hashref );
405 sub ModItemTransfer {
406 my ( $itemnumber, $frombranch, $tobranch ) = @_;
408 my $dbh = C4::Context->dbh;
410 #new entry in branchtransfers....
411 my $sth = $dbh->prepare(
412 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
413 VALUES (?, ?, NOW(), ?)");
414 $sth->execute($itemnumber, $frombranch, $tobranch);
415 #update holdingbranch in items .....
417 "UPDATE items SET holdingbranch = ? WHERE items.itemnumber = ?");
418 $sth->execute($tobranch,$itemnumber);
419 &ModDateLastSeen($itemnumber);
420 $sth = $dbh->prepare(
421 "SELECT biblionumber FROM items WHERE itemnumber=?"
423 $sth->execute($itemnumber);
424 while ( my ( $biblionumber ) = $sth->fetchrow ) {
425 &ModItemInMarconefield( $biblionumber, $itemnumber,
426 'items.holdingbranch', $tobranch );
431 =head2 ModBiblioframework
433 ModBiblioframework($biblionumber,$frameworkcode);
434 Exported function to modify a biblio framework
438 sub ModBiblioframework {
439 my ( $biblionumber, $frameworkcode ) = @_;
440 my $dbh = C4::Context->dbh;
441 my $sth = $dbh->prepare(
442 "UPDATE biblio SET frameworkcode=? WHERE biblionumber=?"
444 $sth->execute($frameworkcode, $biblionumber);
448 =head2 ModItemInMarconefield
452 modify only 1 field in a MARC item (mainly used for holdingbranch, but could also be used for status modif - moving a book to "lost" on a long overdu for example)
453 &ModItemInMarconefield( $biblionumber, $itemnumber, $itemfield, $newvalue )
459 sub ModItemInMarconefield {
460 my ( $biblionumber, $itemnumber, $itemfield, $newvalue ) = @_;
461 my $dbh = C4::Context->dbh;
462 if ( !defined $newvalue ) {
466 my $record = GetMarcItem( $biblionumber, $itemnumber );
467 my ($tagfield, $tagsubfield) = GetMarcFromKohaField( $itemfield,'');
468 # FIXME - the condition is done this way because GetMarcFromKohaField
469 # returns (0, 0) if it can't field a MARC tag for the kohafield. However,
470 # some fields like items.wthdrawn are mapped to subfield $0, making the
471 # customary test of "if ($tagfield && $tagsubfield)" incorrect.
472 # GetMarcFromKohaField should probably be returning (undef, undef), making
473 # the correct test "if (defined $tagfield && defined $tagsubfield)", but
474 # this would be a large change and consequently deferred for after 3.0.
475 if (not(int($tagfield) == 0 && int($tagsubfield) == 0)) {
476 my $tag = $record->field($tagfield);
478 # my $tagsubs = $record->field($tagfield)->subfield($tagsubfield);
479 $tag->update( $tagsubfield => $newvalue );
480 $record->delete_field($tag);
481 $record->insert_fields_ordered($tag);
482 my $frameworkcode = GetFrameworkCode( $biblionumber );
483 &ModItemInMarc( $record, $biblionumber, $itemnumber, $frameworkcode );
492 &ModItemInMarc( $record, $biblionumber, $itemnumber, $frameworkcode )
499 my ( $ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
500 my $dbh = C4::Context->dbh;
502 # get complete MARC record & replace the item field by the new one
503 my $completeRecord = GetMarcBiblio($biblionumber);
504 my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
505 my $itemField = $ItemRecord->field($itemtag);
506 my @items = $completeRecord->field($itemtag);
508 if ($_->subfield($itemsubfield) eq $itemnumber) {
509 # $completeRecord->delete_field($_);
510 $_->replace_with($itemField);
514 my $sth = $dbh->prepare("UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
515 $sth->execute( $completeRecord->as_usmarc(), $completeRecord->as_xml_record(),$biblionumber );
517 ModZebra($biblionumber,"specialUpdate","biblioserver",$completeRecord);
520 =head2 ModDateLastSeen
522 &ModDateLastSeen($itemnum)
523 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking
524 C<$itemnum> is the item number
528 sub ModDateLastSeen {
530 my $dbh = C4::Context->dbh;
533 "UPDATE items SET itemlost=0,datelastseen = NOW() WHERE items.itemnumber = ?"
535 $sth->execute($itemnum);
542 my $error = &DelBiblio($dbh,$biblionumber);
543 Exported function (core API) for deleting a biblio in koha.
544 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
545 Also backs it up to deleted* tables
546 Checks to make sure there are not issues on any of the items
548 C<$error> : undef unless an error occurs
555 my ( $biblionumber ) = @_;
556 my $dbh = C4::Context->dbh;
557 my $error; # for error handling
559 # First make sure this biblio has no items attached
560 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
561 $sth->execute($biblionumber);
562 if (my $itemnumber = $sth->fetchrow){
563 # Fix this to use a status the template can understand
564 $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
567 return $error if $error;
569 # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
570 # for at least 2 reasons :
571 # - we need to read the biblio if NoZebra is set (to remove it from the indexes
572 # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
573 # 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)
574 ModZebra($biblionumber, "recordDelete", "biblioserver", undef);
576 # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
579 "SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
580 $sth->execute($biblionumber);
581 while ( my $biblioitemnumber = $sth->fetchrow ) {
583 # delete this biblioitem
584 $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
585 return $error if $error;
588 # delete biblio from Koha tables and save in deletedbiblio
589 # must do this *after* _koha_delete_biblioitems, otherwise
590 # delete cascade will prevent deletedbiblioitems rows
591 # from being generated by _koha_delete_biblioitems
592 $error = _koha_delete_biblio( $dbh, $biblionumber );
594 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","DELETE",$biblionumber,"")
595 if C4::Context->preference("CataloguingLog");
603 DelItem( $biblionumber, $itemnumber );
604 Exported function (core API) for deleting an item record in Koha.
611 my ( $dbh, $biblionumber, $itemnumber ) = @_;
613 # check the item has no current issues
616 &_koha_delete_item( $dbh, $itemnumber );
618 # get the MARC record
619 my $record = GetMarcBiblio($biblionumber);
620 my $frameworkcode = GetFrameworkCode($biblionumber);
623 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
624 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
626 #search item field code
627 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
628 my @fields = $record->field($itemtag);
630 # delete the item specified
631 foreach my $field (@fields) {
632 if ( $field->subfield($itemsubfield) eq $itemnumber ) {
633 $record->delete_field($field);
636 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
637 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","DELETE",$itemnumber,"item")
638 if C4::Context->preference("CataloguingLog");
645 $data = &GetBiblioData($biblionumber);
646 Returns information about the book with the given biblionumber.
647 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
648 the C<biblio> and C<biblioitems> tables in the
650 In addition, C<$data-E<gt>{subject}> is the list of the book's
651 subjects, separated by C<" , "> (space, comma, space).
652 If there are multiple biblioitems with the given biblionumber, only
653 the first one is considered.
661 my $dbh = C4::Context->dbh;
663 # my $query = C4::Context->preference('item-level_itypes') ?
664 # " SELECT * , biblioitems.notes AS bnotes, biblio.notes
666 # LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
667 # WHERE biblio.biblionumber = ?
668 # AND biblioitems.biblionumber = biblio.biblionumber
671 my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
673 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
674 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
675 WHERE biblio.biblionumber = ?
676 AND biblioitems.biblionumber = biblio.biblionumber ";
678 my $sth = $dbh->prepare($query);
679 $sth->execute($bibnum);
681 $data = $sth->fetchrow_hashref;
685 } # sub GetBiblioData
692 @results = &GetItemsInfo($biblionumber, $type);
694 Returns information about books with the given biblionumber.
696 C<$type> may be either C<intra> or anything else. If it is not set to
697 C<intra>, then the search will exclude lost, very overdue, and
700 C<&GetItemsInfo> returns a list of references-to-hash. Each element
701 contains a number of keys. Most of them are table items from the
702 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
703 Koha database. Other keys include:
707 =item C<$data-E<gt>{branchname}>
709 The name (not the code) of the branch to which the book belongs.
711 =item C<$data-E<gt>{datelastseen}>
713 This is simply C<items.datelastseen>, except that while the date is
714 stored in YYYY-MM-DD format in the database, here it is converted to
715 DD/MM/YYYY format. A NULL date is returned as C<//>.
717 =item C<$data-E<gt>{datedue}>
719 =item C<$data-E<gt>{class}>
721 This is the concatenation of C<biblioitems.classification>, the book's
722 Dewey code, and C<biblioitems.subclass>.
724 =item C<$data-E<gt>{ocount}>
726 I think this is the number of copies of the book available.
728 =item C<$data-E<gt>{order}>
730 If this is set, it is set to C<One Order>.
739 my ( $biblionumber, $type ) = @_;
740 my $dbh = C4::Context->dbh;
741 my $query = "SELECT *,items.notforloan as itemnotforloan
743 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
744 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
745 $query .= (C4::Context->preference('item-level_itypes')) ?
746 " LEFT JOIN itemtypes on items.itype = itemtypes.itemtype "
747 : " LEFT JOIN itemtypes on biblioitems.itemtype = itemtypes.itemtype ";
748 $query .= "WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
749 my $sth = $dbh->prepare($query);
750 $sth->execute($biblionumber);
753 my ( $date_due, $count_reserves );
755 my $isth = $dbh->prepare(
756 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
757 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
759 AND returndate IS NULL"
761 while ( my $data = $sth->fetchrow_hashref ) {
763 $isth->execute( $data->{'itemnumber'} );
764 if ( my $idata = $isth->fetchrow_hashref ) {
765 $data->{borrowernumber} = $idata->{borrowernumber};
766 $data->{cardnumber} = $idata->{cardnumber};
767 $data->{surname} = $idata->{surname};
768 $data->{firstname} = $idata->{firstname};
769 $datedue = format_date( $idata->{'date_due'} );
770 if (C4::Context->preference("IndependantBranches")){
771 my $userenv = C4::Context->userenv;
772 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
773 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
777 if ( $datedue eq '' ) {
778 #$datedue="Available";
779 my ( $restype, $reserves ) =
780 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
783 $count_reserves = $restype;
788 #get branch information.....
789 my $bsth = $dbh->prepare(
790 "SELECT * FROM branches WHERE branchcode = ?
793 $bsth->execute( $data->{'holdingbranch'} );
794 if ( my $bdata = $bsth->fetchrow_hashref ) {
795 $data->{'branchname'} = $bdata->{'branchname'};
797 my $date = format_date( $data->{'datelastseen'} );
798 $data->{'datelastseen'} = $date;
799 $data->{'datedue'} = $datedue;
800 $data->{'count_reserves'} = $count_reserves;
802 # get notforloan complete status if applicable
803 my $sthnflstatus = $dbh->prepare(
804 'SELECT authorised_value
805 FROM marc_subfield_structure
806 WHERE kohafield="items.notforloan"
810 $sthnflstatus->execute;
811 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
812 if ($authorised_valuecode) {
813 $sthnflstatus = $dbh->prepare(
814 "SELECT lib FROM authorised_values
816 AND authorised_value=?"
818 $sthnflstatus->execute( $authorised_valuecode,
819 $data->{itemnotforloan} );
820 my ($lib) = $sthnflstatus->fetchrow;
821 $data->{notforloan} = $lib;
824 # my stack procedures
825 my $stackstatus = $dbh->prepare(
826 'SELECT authorised_value
827 FROM marc_subfield_structure
828 WHERE kohafield="items.stack"
831 $stackstatus->execute;
833 ($authorised_valuecode) = $stackstatus->fetchrow;
834 if ($authorised_valuecode) {
835 $stackstatus = $dbh->prepare(
837 FROM authorised_values
839 AND authorised_value=?
842 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
843 my ($lib) = $stackstatus->fetchrow;
844 $data->{stack} = $lib;
846 $results[$i] = $data;
858 $itemstatushash = &getitemstatus($fwkcode);
859 returns information about status.
860 Can be MARC dependant.
862 But basically could be can be loan or not
863 Create a status selector with the following code
865 =head3 in PERL SCRIPT
867 my $itemstatushash = getitemstatus;
869 foreach my $thisstatus (keys %$itemstatushash) {
870 my %row =(value => $thisstatus,
871 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
873 push @itemstatusloop, \%row;
875 $template->param(statusloop=>\@itemstatusloop);
880 <select name="statusloop">
881 <option value="">Default</option>
882 <!-- TMPL_LOOP name="statusloop" -->
883 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
891 # returns a reference to a hash of references to status...
894 my $dbh = C4::Context->dbh;
896 $fwk = '' unless ($fwk);
897 my ( $tag, $subfield ) =
898 GetMarcFromKohaField( "items.notforloan", $fwk );
899 if ( $tag and $subfield ) {
902 "SELECT authorised_value
903 FROM marc_subfield_structure
909 $sth->execute( $tag, $subfield, $fwk );
910 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
913 "SELECT authorised_value,lib
914 FROM authorised_values
919 $authvalsth->execute($authorisedvaluecat);
920 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
921 $itemstatus{$authorisedvalue} = $lib;
937 $itemstatus{"1"} = "Not For Loan";
941 =head2 getitemlocation
945 $itemlochash = &getitemlocation($fwk);
946 returns informations about location.
947 where fwk stands for an optional framework code.
948 Create a location selector with the following code
950 =head3 in PERL SCRIPT
952 my $itemlochash = getitemlocation;
954 foreach my $thisloc (keys %$itemlochash) {
955 my $selected = 1 if $thisbranch eq $branch;
956 my %row =(locval => $thisloc,
957 selected => $selected,
958 locname => $itemlochash->{$thisloc},
960 push @itemlocloop, \%row;
962 $template->param(itemlocationloop => \@itemlocloop);
966 <select name="location">
967 <option value="">Default</option>
968 <!-- TMPL_LOOP name="itemlocationloop" -->
969 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
977 sub GetItemLocation {
979 # returns a reference to a hash of references to location...
982 my $dbh = C4::Context->dbh;
984 $fwk = '' unless ($fwk);
985 my ( $tag, $subfield ) =
986 GetMarcFromKohaField( "items.location", $fwk );
987 if ( $tag and $subfield ) {
990 "SELECT authorised_value
991 FROM marc_subfield_structure
996 $sth->execute( $tag, $subfield, $fwk );
997 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
1000 "SELECT authorised_value,lib
1001 FROM authorised_values
1005 $authvalsth->execute($authorisedvaluecat);
1006 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
1007 $itemlocation{$authorisedvalue} = $lib;
1009 $authvalsth->finish;
1010 return \%itemlocation;
1023 $itemlocation{"1"} = "Not For Loan";
1024 return \%itemlocation;
1029 $items = GetLostItems($where,$orderby);
1031 This function get the items lost into C<$items>.
1036 C<$where> is a hashref. it containts a field of the items table as key
1037 and the value to match as value.
1038 C<$orderby> is a field of the items table.
1041 C<$items> is a reference to an array full of hasref which keys are items' table column.
1043 =item usage in the perl script:
1046 $where{barcode} = 0001548;
1047 my $items = GetLostItems( \%where, "homebranch" );
1048 $template->param(itemsloop => $items);
1055 # Getting input args.
1057 my $orderby = shift;
1058 my $dbh = C4::Context->dbh;
1063 WHERE itemlost IS NOT NULL
1066 foreach my $key (keys %$where) {
1067 $query .= " AND " . $key . " LIKE '%" . $where->{$key} . "%'";
1069 $query .= " ORDER BY ".$orderby if defined $orderby;
1071 my $sth = $dbh->prepare($query);
1074 while ( my $row = $sth->fetchrow_hashref ){
1080 =head2 GetItemsForInventory
1082 $itemlist = GetItemsForInventory($minlocation,$maxlocation,$datelastseen,$offset,$size)
1084 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1086 The sub returns a list of hashes, containing itemnumber, author, title, barcode & item callnumber.
1087 It is ordered by callnumber,title.
1089 The minlocation & maxlocation parameters are used to specify a range of item callnumbers
1090 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1091 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1095 sub GetItemsForInventory {
1096 my ( $minlocation, $maxlocation,$location, $datelastseen, $branch, $offset, $size ) = @_;
1097 my $dbh = C4::Context->dbh;
1099 if ($datelastseen) {
1100 $datelastseen=format_date_in_iso($datelastseen);
1102 "SELECT itemnumber,barcode,itemcallnumber,title,author,biblio.biblionumber,datelastseen
1104 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1105 WHERE itemcallnumber>= ?
1106 AND itemcallnumber <=?
1107 AND (datelastseen< ? OR datelastseen IS NULL)";
1108 $query.= " AND items.location=".$dbh->quote($location) if $location;
1109 $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
1110 $query .= " ORDER BY itemcallnumber,title";
1111 $sth = $dbh->prepare($query);
1112 $sth->execute( $minlocation, $maxlocation, $datelastseen );
1116 SELECT itemnumber,barcode,itemcallnumber,biblio.biblionumber,title,author,datelastseen
1118 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1119 WHERE itemcallnumber>= ?
1120 AND itemcallnumber <=?";
1121 $query.= " AND items.location=".$dbh->quote($location) if $location;
1122 $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
1123 $query .= " ORDER BY itemcallnumber,title";
1124 $sth = $dbh->prepare($query);
1125 $sth->execute( $minlocation, $maxlocation );
1128 while ( my $row = $sth->fetchrow_hashref ) {
1129 $offset-- if ($offset);
1130 $row->{datelastseen}=format_date($row->{datelastseen});
1131 if ( ( !$offset ) && $size ) {
1132 push @results, $row;
1139 =head2 &GetBiblioItemData
1143 $itemdata = &GetBiblioItemData($biblioitemnumber);
1145 Looks up the biblioitem with the given biblioitemnumber. Returns a
1146 reference-to-hash. The keys are the fields from the C<biblio>,
1147 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
1148 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
1155 sub GetBiblioItemData {
1156 my ($biblioitemnumber) = @_;
1157 my $dbh = C4::Context->dbh;
1158 my $query = "SELECT *,biblioitems.notes AS bnotes
1159 FROM biblio, biblioitems ";
1160 unless(C4::Context->preference('item-level_itypes')) {
1161 $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
1163 $query .= " WHERE biblio.biblionumber = biblioitems.biblionumber
1164 AND biblioitemnumber = ? ";
1165 my $sth = $dbh->prepare($query);
1167 $sth->execute($biblioitemnumber);
1168 $data = $sth->fetchrow_hashref;
1171 } # sub &GetBiblioItemData
1173 =head2 GetItemnumberFromBarcode
1177 $result = GetItemnumberFromBarcode($barcode);
1183 sub GetItemnumberFromBarcode {
1185 my $dbh = C4::Context->dbh;
1188 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1189 $rq->execute($barcode);
1190 my ($result) = $rq->fetchrow;
1194 =head2 GetBiblioItemByBiblioNumber
1198 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
1204 sub GetBiblioItemByBiblioNumber {
1205 my ($biblionumber) = @_;
1206 my $dbh = C4::Context->dbh;
1207 my $sth = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
1211 $sth->execute($biblionumber);
1213 while ( my $data = $sth->fetchrow_hashref ) {
1214 push @results, $data;
1221 =head2 GetBiblioFromItemNumber
1225 $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
1227 Looks up the item with the given itemnumber. if undef, try the barcode.
1229 C<&itemnodata> returns a reference-to-hash whose keys are the fields
1230 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
1238 sub GetBiblioFromItemNumber {
1239 my ( $itemnumber, $barcode ) = @_;
1240 my $dbh = C4::Context->dbh;
1243 $sth=$dbh->prepare( "SELECT * FROM items
1244 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1245 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1246 WHERE items.itemnumber = ?") ;
1247 $sth->execute($itemnumber);
1249 $sth=$dbh->prepare( "SELECT * FROM items
1250 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1251 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1252 WHERE items.barcode = ?") ;
1253 $sth->execute($barcode);
1255 my $data = $sth->fetchrow_hashref;
1264 ( $count, @results ) = &GetBiblio($biblionumber);
1271 my ($biblionumber) = @_;
1272 my $dbh = C4::Context->dbh;
1273 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
1276 $sth->execute($biblionumber);
1277 while ( my $data = $sth->fetchrow_hashref ) {
1278 $results[$count] = $data;
1282 return ( $count, @results );
1289 $data = &GetItem($itemnumber,$barcode);
1291 return Item information, for a given itemnumber or barcode
1298 my ($itemnumber,$barcode) = @_;
1299 my $dbh = C4::Context->dbh;
1301 my $sth = $dbh->prepare("
1303 WHERE itemnumber = ?");
1304 $sth->execute($itemnumber);
1305 my $data = $sth->fetchrow_hashref;
1308 my $sth = $dbh->prepare("
1312 $sth->execute($barcode);
1313 my $data = $sth->fetchrow_hashref;
1318 =head2 get_itemnumbers_of
1322 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1324 Given a list of biblionumbers, return the list of corresponding itemnumbers
1325 for each biblionumber.
1327 Return a reference on a hash where keys are biblionumbers and values are
1328 references on array of itemnumbers.
1334 sub get_itemnumbers_of {
1335 my @biblionumbers = @_;
1337 my $dbh = C4::Context->dbh;
1343 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1345 my $sth = $dbh->prepare($query);
1346 $sth->execute(@biblionumbers);
1350 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1351 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1354 return \%itemnumbers_of;
1357 =head2 GetItemInfosOf
1361 GetItemInfosOf(@itemnumbers);
1367 sub GetItemInfosOf {
1368 my @itemnumbers = @_;
1373 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1375 return get_infos_of( $query, 'itemnumber' );
1378 =head2 GetItemsByBiblioitemnumber
1382 GetItemsByBiblioitemnumber($biblioitemnumber);
1384 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1385 Called by moredetail.pl
1391 sub GetItemsByBiblioitemnumber {
1392 my ( $bibitem ) = @_;
1393 my $dbh = C4::Context->dbh;
1394 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1395 # Get all items attached to a biblioitem
1398 $sth->execute($bibitem) || die $sth->errstr;
1399 while ( my $data = $sth->fetchrow_hashref ) {
1400 # Foreach item, get circulation information
1401 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1402 WHERE itemnumber = ?
1403 AND returndate is NULL
1404 AND issues.borrowernumber = borrowers.borrowernumber"
1406 $sth2->execute( $data->{'itemnumber'} );
1407 if ( my $data2 = $sth2->fetchrow_hashref ) {
1408 # if item is out, set the due date and who it is out too
1409 $data->{'date_due'} = $data2->{'date_due'};
1410 $data->{'cardnumber'} = $data2->{'cardnumber'};
1411 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1414 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1415 $data->{'date_due'} = '';
1418 # Find the last 3 people who borrowed this item.
1419 my $query2 = "SELECT * FROM issues, borrowers WHERE itemnumber = ?
1420 AND issues.borrowernumber = borrowers.borrowernumber
1421 AND returndate is not NULL
1422 ORDER BY returndate desc,timestamp desc LIMIT 3";
1423 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1424 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1426 while ( my $data2 = $sth2->fetchrow_hashref ) {
1427 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1428 $data->{"card$i2"} = $data2->{'cardnumber'};
1429 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1433 push(@results,$data);
1440 =head2 GetBiblioItemInfosOf
1444 GetBiblioItemInfosOf(@biblioitemnumbers);
1450 sub GetBiblioItemInfosOf {
1451 my @biblioitemnumbers = @_;
1454 SELECT biblioitemnumber,
1458 WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
1460 return get_infos_of( $query, 'biblioitemnumber' );
1463 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
1465 =head2 GetMarcStructure
1469 $res = GetMarcStructure($forlibrarian,$frameworkcode);
1471 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
1472 $forlibrarian :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
1473 $frameworkcode : the framework code to read
1479 sub GetMarcStructure {
1480 my ( $forlibrarian, $frameworkcode ) = @_;
1481 my $dbh=C4::Context->dbh;
1482 $frameworkcode = "" unless $frameworkcode;
1484 my $libfield = ( $forlibrarian eq 1 ) ? 'liblibrarian' : 'libopac';
1486 # check that framework exists
1489 "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
1490 $sth->execute($frameworkcode);
1491 my ($total) = $sth->fetchrow;
1492 $frameworkcode = "" unless ( $total > 0 );
1495 "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable
1496 FROM marc_tag_structure
1497 WHERE frameworkcode=?
1500 $sth->execute($frameworkcode);
1501 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
1503 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) =
1506 $res->{$tag}->{lib} =
1507 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
1508 $res->{$tab}->{tab} = "";
1509 $res->{$tag}->{mandatory} = $mandatory;
1510 $res->{$tag}->{repeatable} = $repeatable;
1515 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue
1516 FROM marc_subfield_structure
1517 WHERE frameworkcode=?
1518 ORDER BY tagfield,tagsubfield
1522 $sth->execute($frameworkcode);
1525 my $authorised_value;
1537 $tag, $subfield, $liblibrarian,
1539 $mandatory, $repeatable, $authorised_value,
1540 $authtypecode, $value_builder, $kohafield,
1541 $seealso, $hidden, $isurl,
1547 $res->{$tag}->{$subfield}->{lib} =
1548 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
1549 $res->{$tag}->{$subfield}->{tab} = $tab;
1550 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
1551 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
1552 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
1553 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
1554 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
1555 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
1556 $res->{$tag}->{$subfield}->{seealso} = $seealso;
1557 $res->{$tag}->{$subfield}->{hidden} = $hidden;
1558 $res->{$tag}->{$subfield}->{isurl} = $isurl;
1559 $res->{$tag}->{$subfield}->{'link'} = $link;
1560 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
1565 =head2 GetUsedMarcStructure
1567 the same function as GetMarcStructure expcet it just take field
1568 in tab 0-9. (used field)
1570 my $results = GetUsedMarcStructure($frameworkcode);
1572 L<$results> is a ref to an array which each case containts a ref
1573 to a hash which each keys is the columns from marc_subfield_structure
1575 L<$frameworkcode> is the framework code.
1579 sub GetUsedMarcStructure($){
1580 my $frameworkcode = shift || '';
1581 my $dbh = C4::Context->dbh;
1584 FROM marc_subfield_structure
1586 AND frameworkcode = ?
1589 my $sth = $dbh->prepare($query);
1590 $sth->execute($frameworkcode);
1591 while (my $row = $sth->fetchrow_hashref){
1597 =head2 GetMarcFromKohaField
1601 ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
1602 Returns the MARC fields & subfields mapped to the koha field
1603 for the given frameworkcode
1609 sub GetMarcFromKohaField {
1610 my ( $kohafield, $frameworkcode ) = @_;
1611 return 0, 0 unless $kohafield;
1612 my $relations = C4::Context->marcfromkohafield;
1614 $relations->{$frameworkcode}->{$kohafield}->[0],
1615 $relations->{$frameworkcode}->{$kohafield}->[1]
1619 =head2 GetMarcBiblio
1623 Returns MARC::Record of the biblionumber passed in parameter.
1624 the marc record contains both biblio & item datas
1631 my $biblionumber = shift;
1632 my $dbh = C4::Context->dbh;
1634 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
1635 $sth->execute($biblionumber);
1636 my ($marcxml) = $sth->fetchrow;
1637 MARC::File::XML->default_record_format(C4::Context->preference('marcflavour'));
1638 $marcxml =~ s/\x1e//g;
1639 $marcxml =~ s/\x1f//g;
1640 $marcxml =~ s/\x1d//g;
1641 $marcxml =~ s/\x0f//g;
1642 $marcxml =~ s/\x0c//g;
1644 my $record = MARC::Record->new();
1646 $record = eval {MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour'))};
1648 # $record = MARC::Record::new_from_usmarc( $marc) if $marc;
1659 my $marcxml = GetXmlBiblio($biblionumber);
1661 Returns biblioitems.marcxml of the biblionumber passed in parameter.
1662 The XML contains both biblio & item datas
1669 my ( $biblionumber ) = @_;
1670 my $dbh = C4::Context->dbh;
1672 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
1673 $sth->execute($biblionumber);
1674 my ($marcxml) = $sth->fetchrow;
1678 =head2 GetAuthorisedValueDesc
1682 my $subfieldvalue =get_authorised_value_desc(
1683 $tag, $subf[$i][0],$subf[$i][1], '', $taglib);
1684 Retrieve the complete description for a given authorised value.
1690 sub GetAuthorisedValueDesc {
1691 my ( $tag, $subfield, $value, $framework, $tagslib ) = @_;
1692 my $dbh = C4::Context->dbh;
1695 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
1696 return C4::Branch::GetBranchName($value);
1700 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
1701 return getitemtypeinfo($value)->{description};
1704 #---- "true" authorized value
1705 my $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'};
1706 if ( $category ne "" ) {
1709 "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
1711 $sth->execute( $category, $value );
1712 my $data = $sth->fetchrow_hashref;
1713 return $data->{'lib'};
1716 return $value; # if nothing is found return the original value
1724 Returns MARC::Record of the item passed in parameter.
1731 my ( $biblionumber, $itemnumber ) = @_;
1733 # GetMarcItem has been revised so that it does the following:
1734 # 1. Gets the item information from the items table.
1735 # 2. Converts it to a MARC field for storage in the bib record.
1737 # The previous behavior was:
1738 # 1. Get the bib record.
1739 # 2. Return the MARC tag corresponding to the item record.
1741 # The difference is that one treats the items row as authoritative,
1742 # while the other treats the MARC representation as authoritative
1743 # under certain circumstances.
1747 # As of 2007-11-27, this change hopefully does not introduce
1748 # any bugs. However, it does mean that for code that uses
1749 # ModItemInMarconefield to update one subfield (corresponding to
1750 # an items column) is now less efficient.
1752 # The API needs to be shifted to the following:
1753 # 1. User updates items record.
1754 # 2. Linked bib is sent for indexing.
1756 # The missing step 1.5 is updating the item tag in the bib MARC record
1757 # so that the indexes are updated. Depending on performance considerations,
1758 # this may ultimately mean of of the following:
1759 # a. MARC field for item is updated right away.
1760 # b. MARC field for item is updated only as part of indexing.
1761 # c. MARC field for item is never actually stored in bib record; instead
1762 # it is generated only when needed for indexing, item export, and
1763 # (maybe) OPAC display.
1766 my $itemrecord = GetItem($itemnumber);
1768 # Tack on 'items.' prefix to column names so that TransformKohaToMarc will work.
1769 # Also, don't emit a subfield if the underlying field is blank.
1770 my $mungeditem = { map { $itemrecord->{$_} ne '' ? ("items.$_" => $itemrecord->{$_}) : () } keys %{ $itemrecord } };
1772 my $itemmarc = TransformKohaToMarc($mungeditem);
1783 $marcnotesarray = GetMarcNotes( $record, $marcflavour );
1784 Get all notes from the MARC record and returns them in an array.
1785 The note are stored in differents places depending on MARC flavour
1792 my ( $record, $marcflavour ) = @_;
1794 if ( $marcflavour eq "MARC21" ) {
1797 else { # assume unimarc if not marc21
1804 foreach my $field ( $record->field($scope) ) {
1805 my $value = $field->as_string();
1806 if ( $note ne "" ) {
1807 $marcnote = { marcnote => $note, };
1808 push @marcnotes, $marcnote;
1811 if ( $note ne $value ) {
1812 $note = $note . " " . $value;
1817 $marcnote = { marcnote => $note };
1818 push @marcnotes, $marcnote; #load last tag into array
1821 } # end GetMarcNotes
1823 =head2 GetMarcSubjects
1827 $marcsubjcts = GetMarcSubjects($record,$marcflavour);
1828 Get all subjects from the MARC record and returns them in an array.
1829 The subjects are stored in differents places depending on MARC flavour
1835 sub GetMarcSubjects {
1836 my ( $record, $marcflavour ) = @_;
1837 my ( $mintag, $maxtag );
1838 if ( $marcflavour eq "MARC21" ) {
1842 else { # assume unimarc if not marc21
1852 foreach my $field ( $record->field('6..' )) {
1853 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1855 my @subfields = $field->subfields();
1858 # if there is an authority link, build the link with an= subfield9
1859 my $subfield9 = $field->subfield('9');
1860 for my $subject_subfield (@subfields ) {
1861 # don't load unimarc subfields 3,4,5
1862 next if (($marcflavour eq "UNIMARC") and ($subject_subfield->[0] =~ (3|4|5) ) );
1863 my $code = $subject_subfield->[0];
1864 my $value = $subject_subfield->[1];
1865 my $linkvalue = $value;
1866 $linkvalue =~ s/(\(|\))//g;
1867 my $operator = " and " unless $counter==0;
1869 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1871 push @link_loop, {'limit' => 'su', link => $linkvalue, operator => $operator };
1873 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1875 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator} unless ($subject_subfield->[0] == 9 );
1876 # this needs to be added back in in a way that the template can expose it properly
1877 #if ( $code == 9 ) {
1878 # $link = "an:".$subject_subfield->[1];
1884 push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1887 return \@marcsubjects;
1888 } #end getMARCsubjects
1890 =head2 GetMarcAuthors
1894 authors = GetMarcAuthors($record,$marcflavour);
1895 Get all authors from the MARC record and returns them in an array.
1896 The authors are stored in differents places depending on MARC flavour
1902 sub GetMarcAuthors {
1903 my ( $record, $marcflavour ) = @_;
1904 my ( $mintag, $maxtag );
1905 # tagslib useful for UNIMARC author reponsabilities
1906 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.
1907 if ( $marcflavour eq "MARC21" ) {
1911 elsif ( $marcflavour eq "UNIMARC" ) { # assume unimarc if not marc21
1920 foreach my $field ( $record->fields ) {
1921 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1923 my @subfields = $field->subfields();
1925 for my $authors_subfield (@subfields) {
1926 #unimarc-specific line
1927 next if ($marcflavour eq 'UNIMARC' and (($authors_subfield->[0] eq '3') or ($authors_subfield->[0] eq '5')));
1928 my $subfieldcode = $authors_subfield->[0];
1930 # deal with UNIMARC author responsibility
1931 if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] eq '4')) {
1932 $value = "(".GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ).")";
1934 $value = $authors_subfield->[1];
1936 $hash{tag} = $field->tag;
1937 $hash{value} .= $value . " " if ($subfieldcode != 9) ;
1938 $hash{link} .= $value if ($subfieldcode eq 9);
1940 push @marcauthors, \%hash;
1942 return \@marcauthors;
1949 $marcurls = GetMarcUrls($record,$marcflavour);
1950 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1951 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1958 my ($record, $marcflavour) = @_;
1961 for my $field ($record->field('856')) {
1962 my $url = $field->subfield('u');
1964 for my $note ( $field->subfield('z')) {
1965 push @notes , {note => $note};
1967 $marcurl = { MARCURL => $url,
1970 if($marcflavour eq 'MARC21') {
1971 my $s3 = $field->subfield('3');
1972 my $link = $field->subfield('y');
1973 $marcurl->{'linktext'} = $link || $s3 || $url ;;
1974 $marcurl->{'part'} = $s3 if($link);
1975 $marcurl->{'toc'} = 1 if($s3 =~ /^[Tt]able/) ;
1977 $marcurl->{'linktext'} = $url;
1979 push @marcurls, $marcurl;
1984 =head2 GetMarcSeries
1988 $marcseriesarray = GetMarcSeries($record,$marcflavour);
1989 Get all series from the MARC record and returns them in an array.
1990 The series are stored in differents places depending on MARC flavour
1997 my ($record, $marcflavour) = @_;
1998 my ($mintag, $maxtag);
1999 if ($marcflavour eq "MARC21") {
2002 } else { # assume unimarc if not marc21
2012 foreach my $field ($record->field('440'), $record->field('490')) {
2014 #my $value = $field->subfield('a');
2015 #$marcsubjct = {MARCSUBJCT => $value,};
2016 my @subfields = $field->subfields();
2017 #warn "subfields:".join " ", @$subfields;
2020 for my $series_subfield (@subfields) {
2022 undef $volume_number;
2023 # see if this is an instance of a volume
2024 if ($series_subfield->[0] eq 'v') {
2028 my $code = $series_subfield->[0];
2029 my $value = $series_subfield->[1];
2030 my $linkvalue = $value;
2031 $linkvalue =~ s/(\(|\))//g;
2032 my $operator = " and " unless $counter==0;
2033 push @link_loop, {link => $linkvalue, operator => $operator };
2034 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
2035 if ($volume_number) {
2036 push @subfields_loop, {volumenum => $value};
2039 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number};
2043 push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
2044 #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
2045 #push @marcsubjcts, $marcsubjct;
2049 my $marcseriessarray=\@marcseries;
2050 return $marcseriessarray;
2051 } #end getMARCseriess
2053 =head2 GetFrameworkCode
2057 $frameworkcode = GetFrameworkCode( $biblionumber )
2063 sub GetFrameworkCode {
2064 my ( $biblionumber ) = @_;
2065 my $dbh = C4::Context->dbh;
2066 my $sth = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
2067 $sth->execute($biblionumber);
2068 my ($frameworkcode) = $sth->fetchrow;
2069 return $frameworkcode;
2072 =head2 GetPublisherNameFromIsbn
2074 $name = GetPublishercodeFromIsbn($isbn);
2081 sub GetPublisherNameFromIsbn($){
2083 $isbn =~ s/[- _]//g;
2085 my @codes = (split '-', DisplayISBN($isbn));
2086 my $code = $codes[0].$codes[1].$codes[2];
2087 my $dbh = C4::Context->dbh;
2089 SELECT distinct publishercode
2092 AND publishercode IS NOT NULL
2095 my $sth = $dbh->prepare($query);
2096 $sth->execute("$code%");
2097 my $name = $sth->fetchrow;
2098 return $name if length $name;
2102 =head2 TransformKohaToMarc
2106 $record = TransformKohaToMarc( $hash )
2107 This function builds partial MARC::Record from a hash
2108 Hash entries can be from biblio or biblioitems.
2109 This function is called in acquisition module, to create a basic catalogue entry from user entry
2115 sub TransformKohaToMarc {
2118 my $dbh = C4::Context->dbh;
2121 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
2123 my $record = MARC::Record->new();
2124 foreach (keys %{$hash}) {
2125 &TransformKohaToMarcOneField( $sth, $record, $_,
2131 =head2 TransformKohaToMarcOneField
2135 $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
2141 sub TransformKohaToMarcOneField {
2142 my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
2143 $frameworkcode='' unless $frameworkcode;
2147 if ( !defined $sth ) {
2148 my $dbh = C4::Context->dbh;
2149 $sth = $dbh->prepare(
2150 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
2153 $sth->execute( $frameworkcode, $kohafieldname );
2154 if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
2155 my $tag = $record->field($tagfield);
2157 $tag->update( $tagsubfield => $value );
2158 $record->delete_field($tag);
2159 $record->insert_fields_ordered($tag);
2162 $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
2168 =head2 TransformHtmlToXml
2172 $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type )
2174 $auth_type contains :
2175 - nothing : rebuild a biblio, un UNIMARC the encoding is in 100$a pos 26/27
2176 - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
2177 - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
2183 sub TransformHtmlToXml {
2184 my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
2185 my $xml = MARC::File::XML::header('UTF-8');
2186 $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
2187 MARC::File::XML->default_record_format($auth_type);
2188 # in UNIMARC, field 100 contains the encoding
2189 # check that there is one, otherwise the
2190 # MARC::Record->new_from_xml will fail (and Koha will die)
2191 my $unimarc_and_100_exist=0;
2192 $unimarc_and_100_exist=1 if $auth_type eq 'ITEM'; # if we rebuild an item, no need of a 100 field
2197 for ( my $i = 0 ; $i <= @$tags ; $i++ ) {
2198 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a") {
2199 # if we have a 100 field and it's values are not correct, skip them.
2200 # if we don't have any valid 100 field, we will create a default one at the end
2201 my $enc = substr( @$values[$i], 26, 2 );
2202 if ($enc eq '01' or $enc eq '50' or $enc eq '03') {
2203 $unimarc_and_100_exist=1;
2208 @$values[$i] =~ s/&/&/g;
2209 @$values[$i] =~ s/</</g;
2210 @$values[$i] =~ s/>/>/g;
2211 @$values[$i] =~ s/"/"/g;
2212 @$values[$i] =~ s/'/'/g;
2213 # if ( !utf8::is_utf8( @$values[$i] ) ) {
2214 # utf8::decode( @$values[$i] );
2216 if ( ( @$tags[$i] ne $prevtag ) ) {
2217 $j++ unless ( @$tags[$i] eq "" );
2219 $xml .= "</datafield>\n";
2220 if ( ( @$tags[$i] && @$tags[$i] > 10 )
2221 && ( @$values[$i] ne "" ) )
2223 my $ind1 = substr( @$indicator[$j], 0, 1 );
2225 if ( @$indicator[$j] ) {
2226 $ind2 = substr( @$indicator[$j], 1, 1 );
2229 warn "Indicator in @$tags[$i] is empty";
2233 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2235 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2243 if ( @$values[$i] ne "" ) {
2246 if ( @$tags[$i] eq "000" ) {
2247 $xml .= "<leader>@$values[$i]</leader>\n";
2250 # rest of the fixed fields
2252 elsif ( @$tags[$i] < 10 ) {
2254 "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
2258 my $ind1 = substr( @$indicator[$j], 0, 1 );
2259 my $ind2 = substr( @$indicator[$j], 1, 1 );
2261 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2263 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2269 else { # @$tags[$i] eq $prevtag
2270 if ( @$values[$i] eq "" ) {
2274 my $ind1 = substr( @$indicator[$j], 0, 1 );
2275 my $ind2 = substr( @$indicator[$j], 1, 1 );
2277 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2281 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2284 $prevtag = @$tags[$i];
2286 if (C4::Context->preference('marcflavour') and !$unimarc_and_100_exist) {
2287 # warn "SETTING 100 for $auth_type";
2288 use POSIX qw(strftime);
2289 my $string = strftime( "%Y%m%d", localtime(time) );
2290 # set 50 to position 26 is biblios, 13 if authorities
2292 $pos=13 if $auth_type eq 'UNIMARCAUTH';
2293 $string = sprintf( "%-*s", 35, $string );
2294 substr( $string, $pos , 6, "50" );
2295 $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
2296 $xml .= "<subfield code=\"a\">$string</subfield>\n";
2297 $xml .= "</datafield>\n";
2299 $xml .= MARC::File::XML::footer();
2303 =head2 TransformHtmlToMarc
2305 L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
2306 L<$params> is a ref to an array as below:
2308 'tag_010_indicator_531951' ,
2309 'tag_010_code_a_531951_145735' ,
2310 'tag_010_subfield_a_531951_145735' ,
2311 'tag_200_indicator_873510' ,
2312 'tag_200_code_a_873510_673465' ,
2313 'tag_200_subfield_a_873510_673465' ,
2314 'tag_200_code_b_873510_704318' ,
2315 'tag_200_subfield_b_873510_704318' ,
2316 'tag_200_code_e_873510_280822' ,
2317 'tag_200_subfield_e_873510_280822' ,
2318 'tag_200_code_f_873510_110730' ,
2319 'tag_200_subfield_f_873510_110730' ,
2321 L<$cgi> is the CGI object which containts the value.
2322 L<$record> is the MARC::Record object.
2326 sub TransformHtmlToMarc {
2330 # creating a new record
2331 my $record = MARC::Record->new();
2334 while ($params->[$i]){ # browse all CGI params
2335 my $param = $params->[$i];
2337 # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
2338 if ($param eq 'biblionumber') {
2339 my ( $biblionumbertagfield, $biblionumbertagsubfield ) =
2340 &GetMarcFromKohaField( "biblio.biblionumber", '' );
2341 if ($biblionumbertagfield < 10) {
2342 $newfield = MARC::Field->new(
2343 $biblionumbertagfield,
2344 $cgi->param($param),
2347 $newfield = MARC::Field->new(
2348 $biblionumbertagfield,
2351 "$biblionumbertagsubfield" => $cgi->param($param),
2354 push @fields,$newfield if($newfield);
2356 elsif ($param =~ /^tag_(\d*)_indicator_/){ # new field start when having 'input name="..._indicator_..."
2359 my $ind1 = substr($cgi->param($param),0,1);
2360 my $ind2 = substr($cgi->param($param),1,1);
2364 if($tag < 10){ # no code for theses fields
2365 # in MARC editor, 000 contains the leader.
2366 if ($tag eq '000' ) {
2367 $record->leader($cgi->param($params->[$j+1])) if length($cgi->param($params->[$j+1]))==24;
2368 # between 001 and 009 (included)
2370 $newfield = MARC::Field->new(
2372 $cgi->param($params->[$j+1]),
2375 # > 009, deal with subfields
2377 while($params->[$j] =~ /_code_/){ # browse all it's subfield
2378 my $inner_param = $params->[$j];
2380 if($cgi->param($params->[$j+1])){ # only if there is a value (code => value)
2381 $newfield->add_subfields(
2382 $cgi->param($inner_param) => $cgi->param($params->[$j+1])
2386 if ( $cgi->param($params->[$j+1]) ) { # creating only if there is a value (code => value)
2387 $newfield = MARC::Field->new(
2391 $cgi->param($inner_param) => $cgi->param($params->[$j+1]),
2398 push @fields,$newfield if($newfield);
2403 $record->append_fields(@fields);
2407 =head2 TransformMarcToKoha
2411 $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
2417 sub TransformMarcToKoha {
2418 my ( $dbh, $record, $frameworkcode, $table ) = @_;
2422 # sometimes we only want to return the items data
2423 if ($table eq 'items') {
2424 my $sth = $dbh->prepare("SHOW COLUMNS FROM items");
2426 while ( (my $field) = $sth->fetchrow ) {
2427 my $value = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2428 my $key = _disambiguate($table, $field);
2429 if ($result->{$key}) {
2430 $result->{$key} .= " | " . $value;
2432 $result->{$key} = $value;
2437 my @tables = ('biblio','biblioitems','items');
2438 foreach my $table (@tables){
2439 my $sth2 = $dbh->prepare("SHOW COLUMNS from $table");
2441 while (my ($field) = $sth2->fetchrow){
2442 # FIXME use of _disambiguate is a temporary hack
2443 # $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2444 my $value = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2445 my $key = _disambiguate($table, $field);
2446 if ($result->{$key}) {
2447 # FIXME - hack to not bring in duplicates of the same value
2448 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($value eq "")) {
2449 $result->{$key} .= " | " . $value;
2452 $result->{$key} = $value;
2457 # modify copyrightdate to keep only the 1st year found
2458 my $temp = $result->{'copyrightdate'};
2459 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
2461 $result->{'copyrightdate'} = $1;
2463 else { # if no cYYYY, get the 1st date.
2464 $temp =~ m/(\d\d\d\d)/;
2465 $result->{'copyrightdate'} = $1;
2468 # modify publicationyear to keep only the 1st year found
2469 $temp = $result->{'publicationyear'};
2470 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
2472 $result->{'publicationyear'} = $1;
2474 else { # if no cYYYY, get the 1st date.
2475 $temp =~ m/(\d\d\d\d)/;
2476 $result->{'publicationyear'} = $1;
2483 =head2 _disambiguate
2487 $newkey = _disambiguate($table, $field);
2489 This is a temporary hack to distinguish between the
2490 following sets of columns when using TransformMarcToKoha.
2492 items.cn_source & biblioitems.cn_source
2493 items.cn_sort & biblioitems.cn_sort
2495 Columns that are currently NOT distinguished (FIXME
2496 due to lack of time to fully test) are:
2498 biblio.notes and biblioitems.notes
2503 FIXME - this is necessary because prefixing each column
2504 name with the table name would require changing lots
2505 of code and templates, and exposing more of the DB
2506 structure than is good to the UI templates, particularly
2507 since biblio and bibloitems may well merge in a future
2508 version. In the future, it would also be good to
2509 separate DB access and UI presentation field names
2517 my ($table, $column) = @_;
2518 if ($column eq "cn_sort" or $column eq "cn_source") {
2519 return $table . '.' . $column;
2526 =head2 get_koha_field_from_marc
2530 $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2532 Internal function to map data from the MARC record to a specific non-MARC field.
2533 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
2539 sub get_koha_field_from_marc {
2540 my ($koha_table,$koha_column,$record,$frameworkcode) = @_;
2541 my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table.'.'.$koha_column, $frameworkcode );
2543 foreach my $field ( $record->field($tagfield) ) {
2544 if ( $field->tag() < 10 ) {
2546 $kohafield .= " | " . $field->data();
2549 $kohafield = $field->data();
2553 if ( $field->subfields ) {
2554 my @subfields = $field->subfields();
2555 foreach my $subfieldcount ( 0 .. $#subfields ) {
2556 if ( $subfields[$subfieldcount][0] eq $subfield ) {
2559 " | " . $subfields[$subfieldcount][1];
2563 $subfields[$subfieldcount][1];
2574 =head2 TransformMarcToKohaOneField
2578 $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
2584 sub TransformMarcToKohaOneField {
2586 # FIXME ? if a field has a repeatable subfield that is used in old-db,
2587 # only the 1st will be retrieved...
2588 my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
2590 my ( $tagfield, $subfield ) =
2591 GetMarcFromKohaField( $kohatable . "." . $kohafield,
2593 foreach my $field ( $record->field($tagfield) ) {
2594 if ( $field->tag() < 10 ) {
2595 if ( $result->{$kohafield} ) {
2596 $result->{$kohafield} .= " | " . $field->data();
2599 $result->{$kohafield} = $field->data();
2603 if ( $field->subfields ) {
2604 my @subfields = $field->subfields();
2605 foreach my $subfieldcount ( 0 .. $#subfields ) {
2606 if ( $subfields[$subfieldcount][0] eq $subfield ) {
2607 if ( $result->{$kohafield} ) {
2608 $result->{$kohafield} .=
2609 " | " . $subfields[$subfieldcount][1];
2612 $result->{$kohafield} =
2613 $subfields[$subfieldcount][1];
2623 =head1 OTHER FUNCTIONS
2629 my $string = char_decode( $string, $encoding );
2631 converts ISO 5426 coded string to UTF-8
2632 sloppy code : should be improved in next issue
2639 my ( $string, $encoding ) = @_;
2642 $encoding = C4::Context->preference("marcflavour") unless $encoding;
2643 if ( $encoding eq "UNIMARC" ) {
2713 # this handles non-sorting blocks (if implementation requires this)
2714 $string = nsb_clean($_);
2716 elsif ( $encoding eq "USMARC" || $encoding eq "MARC21" ) {
2775 #Additional Turkish characters
2778 s/(\xf0)s/\xc5\x9f/gm;
2779 s/(\xf0)S/\xc5\x9e/gm;
2782 s/\xe7\x49/\\xc4\xb0/gm;
2783 s/(\xe6)G/\xc4\x9e/gm;
2784 s/(\xe6)g/ğ\xc4\x9f/gm;
2787 s/(\xe8|\xc8)o/ö/gm;
2788 s/(\xe8|\xc8)O/Ö/gm;
2789 s/(\xe8|\xc8)u/ü/gm;
2790 s/(\xe8|\xc8)U/Ü/gm;
2791 s/\xc2\xb8/\xc4\xb1/gm;
2794 # this handles non-sorting blocks (if implementation requires this)
2795 $string = nsb_clean($_);
2804 my $string = nsb_clean( $string, $encoding );
2811 my $NSB = '\x88'; # NSB : begin Non Sorting Block
2812 my $NSE = '\x89'; # NSE : Non Sorting Block end
2813 # handles non sorting blocks
2817 s/[ ]{0,1}$NSE/) /gm;
2822 =head2 PrepareItemrecordDisplay
2826 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber);
2828 Returns a hash with all the fields for Display a given item data in a template
2834 sub PrepareItemrecordDisplay {
2836 my ( $bibnum, $itemnum ) = @_;
2838 my $dbh = C4::Context->dbh;
2839 my $frameworkcode = &GetFrameworkCode( $bibnum );
2840 my ( $itemtagfield, $itemtagsubfield ) =
2841 &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2842 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2843 my $itemrecord = GetMarcItem( $bibnum, $itemnum) if ($itemnum);
2845 my $authorised_values_sth =
2847 "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib"
2849 foreach my $tag ( sort keys %{$tagslib} ) {
2850 my $previous_tag = '';
2852 # loop through each subfield
2854 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2855 next if ( subfield_is_koha_internal_p($subfield) );
2856 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2858 $subfield_data{tag} = $tag;
2859 $subfield_data{subfield} = $subfield;
2860 $subfield_data{countsubfield} = $cntsubf++;
2861 $subfield_data{kohafield} =
2862 $tagslib->{$tag}->{$subfield}->{'kohafield'};
2864 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2865 $subfield_data{marc_lib} =
2866 "<span id=\"error\" title=\""
2867 . $tagslib->{$tag}->{$subfield}->{lib} . "\">"
2868 . substr( $tagslib->{$tag}->{$subfield}->{lib}, 0, 12 )
2870 $subfield_data{mandatory} =
2871 $tagslib->{$tag}->{$subfield}->{mandatory};
2872 $subfield_data{repeatable} =
2873 $tagslib->{$tag}->{$subfield}->{repeatable};
2874 $subfield_data{hidden} = "display:none"
2875 if $tagslib->{$tag}->{$subfield}->{hidden};
2877 ( $x, $value ) = _find_value( $tag, $subfield, $itemrecord )
2879 $value =~ s/"/"/g;
2881 # search for itemcallnumber if applicable
2882 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
2883 'items.itemcallnumber'
2884 && C4::Context->preference('itemcallnumber') )
2887 substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2889 substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2890 my $temp = $itemrecord->field($CNtag) if ($itemrecord);
2892 $value = $temp->subfield($CNsubfield);
2895 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2896 my @authorised_values;
2899 # builds list, depending on authorised value...
2901 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq
2904 if ( ( C4::Context->preference("IndependantBranches") )
2905 && ( C4::Context->userenv->{flags} != 1 ) )
2909 "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname"
2911 $sth->execute( C4::Context->userenv->{branch} );
2912 push @authorised_values, ""
2914 $tagslib->{$tag}->{$subfield}->{mandatory} );
2915 while ( my ( $branchcode, $branchname ) =
2916 $sth->fetchrow_array )
2918 push @authorised_values, $branchcode;
2919 $authorised_lib{$branchcode} = $branchname;
2925 "SELECT branchcode,branchname FROM branches ORDER BY branchname"
2928 push @authorised_values, ""
2930 $tagslib->{$tag}->{$subfield}->{mandatory} );
2931 while ( my ( $branchcode, $branchname ) =
2932 $sth->fetchrow_array )
2934 push @authorised_values, $branchcode;
2935 $authorised_lib{$branchcode} = $branchname;
2941 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq
2946 "SELECT itemtype,description FROM itemtypes ORDER BY description"
2949 push @authorised_values, ""
2950 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2951 while ( my ( $itemtype, $description ) =
2952 $sth->fetchrow_array )
2954 push @authorised_values, $itemtype;
2955 $authorised_lib{$itemtype} = $description;
2958 #---- "true" authorised value
2961 $authorised_values_sth->execute(
2962 $tagslib->{$tag}->{$subfield}->{authorised_value} );
2963 push @authorised_values, ""
2964 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2965 while ( my ( $value, $lib ) =
2966 $authorised_values_sth->fetchrow_array )
2968 push @authorised_values, $value;
2969 $authorised_lib{$value} = $lib;
2972 $subfield_data{marc_value} = CGI::scrolling_list(
2973 -name => 'field_value',
2974 -values => \@authorised_values,
2975 -default => "$value",
2976 -labels => \%authorised_lib,
2982 elsif ( $tagslib->{$tag}->{$subfield}->{thesaurus_category} ) {
2983 $subfield_data{marc_value} =
2984 "<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>";
2987 # COMMENTED OUT because No $i is provided with this API.
2988 # And thus, no value_builder can be activated.
2989 # BUT could be thought over.
2990 # } elsif ($tagslib->{$tag}->{$subfield}->{'value_builder'}) {
2991 # my $plugin="value_builder/".$tagslib->{$tag}->{$subfield}->{'value_builder'};
2993 # my $extended_param = plugin_parameters($dbh,$itemrecord,$tagslib,$i,0);
2994 # my ($function_name,$javascript) = plugin_javascript($dbh,$record,$tagslib,$i,0);
2995 # $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";
2998 $subfield_data{marc_value} =
2999 "<input type=\"text\" name=\"field_value\" value=\"$value\" size=50 maxlength=255>";
3001 push( @loop_data, \%subfield_data );
3005 my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
3006 if ( $itemrecord && $itemrecord->field($itemtagfield) );
3008 'itemtagfield' => $itemtagfield,
3009 'itemtagsubfield' => $itemtagsubfield,
3010 'itemnumber' => $itemnumber,
3011 'iteminformation' => \@loop_data
3017 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
3019 # replaced by a zebraqueue table, that is filled with ModZebra to run.
3020 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
3021 # =head2 ModZebrafiles
3023 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
3027 # sub ModZebrafiles {
3029 # my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
3033 # C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
3034 # unless ( opendir( DIR, "$zebradir" ) ) {
3035 # warn "$zebradir not found";
3039 # my $filename = $zebradir . $biblionumber;
3042 # open( OUTPUT, ">", $filename . ".xml" );
3043 # print OUTPUT $record;
3052 ModZebra( $biblionumber, $op, $server, $newRecord );
3054 $biblionumber is the biblionumber we want to index
3055 $op is specialUpdate or delete, and is used to know what we want to do
3056 $server is the server that we want to update
3057 $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.
3064 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
3065 my ( $biblionumber, $op, $server, $newRecord ) = @_;
3066 my $dbh=C4::Context->dbh;
3068 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
3070 # replaced by a zebraqueue table, that is filled with ModZebra to run.
3071 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
3073 if (C4::Context->preference("NoZebra")) {
3074 # lock the nozebra table : we will read index lines, update them in Perl process
3075 # and write everything in 1 transaction.
3076 # lock the table to avoid someone else overwriting what we are doing
3077 $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE');
3078 my %result; # the result hash that will be builded by deletion / add, and written on mySQL at the end, to improve speed
3080 if ($server eq 'biblioserver') {
3081 $record= GetMarcBiblio($biblionumber);
3083 $record= C4::AuthoritiesMarc::GetAuthority($biblionumber);
3085 if ($op eq 'specialUpdate') {
3086 # OK, we have to add or update the record
3087 # 1st delete (virtually, in indexes) ...
3088 %result = _DelBiblioNoZebra($biblionumber,$record,$server);
3089 # ... add the record
3090 %result=_AddBiblioNoZebra($biblionumber,$newRecord, $server, %result);
3092 # it's a deletion, delete the record...
3093 # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
3094 %result=_DelBiblioNoZebra($biblionumber,$record,$server);
3096 # ok, now update the database...
3097 my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
3098 foreach my $key (keys %result) {
3099 foreach my $index (keys %{$result{$key}}) {
3100 $sth->execute($result{$key}->{$index}, $server, $key, $index);
3103 $dbh->do('UNLOCK TABLES');
3107 # we use zebra, just fill zebraqueue table
3109 my $sth=$dbh->prepare("INSERT INTO zebraqueue (biblio_auth_number,server,operation) VALUES(?,?,?)");
3110 $sth->execute($biblionumber,$server,$op);
3115 =head2 GetNoZebraIndexes
3117 %indexes = GetNoZebraIndexes;
3119 return the data from NoZebraIndexes syspref.
3123 sub GetNoZebraIndexes {
3124 my $index = C4::Context->preference('NoZebraIndexes');
3126 foreach my $line (split /('|"),/,$index) {
3127 $line =~ /(.*)=>(.*)/;
3129 my $index = substr($1,1); # get the index, don't forget to remove initial ' or "
3131 $index =~ s/'|"|\s//g;
3134 $fields =~ s/'|"|\s//g;
3135 $indexes{$index}=$fields;
3140 =head1 INTERNAL FUNCTIONS
3142 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
3144 function to delete a biblio in NoZebra indexes
3145 This function does NOT delete anything in database : it reads all the indexes entries
3146 that have to be deleted & delete them in the hash
3147 The SQL part is done either :
3148 - after the Add if we are modifying a biblio (delete + add again)
3149 - immediatly after this sub if we are doing a true deletion.
3150 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
3155 sub _DelBiblioNoZebra {
3156 my ($biblionumber, $record, $server)=@_;
3159 my $dbh = C4::Context->dbh;
3163 if ($server eq 'biblioserver') {
3164 %index=GetNoZebraIndexes;
3165 # get title of the record (to store the 10 first letters with the index)
3166 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
3167 $title = lc($record->subfield($titletag,$titlesubfield));
3169 # for authorities, the "title" is the $a mainentry
3170 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
3171 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
3172 $title = $record->subfield($authref->{auth_tag_to_report},'a');
3173 $index{'mainmainentry'}= $authref->{'auth_tag_to_report'}.'a';
3174 $index{'mainentry'} = $authref->{'auth_tag_to_report'}.'*';
3175 $index{'auth_type'} = '152b';
3179 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
3180 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
3181 # limit to 10 char, should be enough, and limit the DB size
3182 $title = substr($title,0,10);
3184 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
3185 foreach my $field ($record->fields()) {
3186 #parse each subfield
3187 next if $field->tag <10;
3188 foreach my $subfield ($field->subfields()) {
3189 my $tag = $field->tag();
3190 my $subfieldcode = $subfield->[0];
3192 # check each index to see if the subfield is stored somewhere
3193 # otherwise, store it in __RAW__ index
3194 foreach my $key (keys %index) {
3195 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
3196 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
3198 my $line= lc $subfield->[1];
3199 # remove meaningless value in the field...
3200 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3201 # ... and split in words
3202 foreach (split / /,$line) {
3203 next unless $_; # skip empty values (multiple spaces)
3204 # if the entry is already here, do nothing, the biblionumber has already be removed
3205 unless ($result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/) {
3206 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
3207 $sth2->execute($server,$key,$_);
3208 my $existing_biblionumbers = $sth2->fetchrow;
3210 if ($existing_biblionumbers) {
3211 # warn " existing for $key $_: $existing_biblionumbers";
3212 $result{$key}->{$_} =$existing_biblionumbers;
3213 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
3219 # the subfield is not indexed, store it in __RAW__ index anyway
3221 my $line= lc $subfield->[1];
3222 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3223 # ... and split in words
3224 foreach (split / /,$line) {
3225 next unless $_; # skip empty values (multiple spaces)
3226 # if the entry is already here, do nothing, the biblionumber has already be removed
3227 unless ($result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/) {
3228 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
3229 $sth2->execute($server,'__RAW__',$_);
3230 my $existing_biblionumbers = $sth2->fetchrow;
3232 if ($existing_biblionumbers) {
3233 $result{'__RAW__'}->{$_} =$existing_biblionumbers;
3234 $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
3244 =head2 _AddBiblioNoZebra($biblionumber, $record, $server, %result);
3246 function to add a biblio in NoZebra indexes
3250 sub _AddBiblioNoZebra {
3251 my ($biblionumber, $record, $server, %result)=@_;
3252 my $dbh = C4::Context->dbh;
3256 if ($server eq 'biblioserver') {
3257 %index=GetNoZebraIndexes;
3258 # get title of the record (to store the 10 first letters with the index)
3259 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
3260 $title = lc($record->subfield($titletag,$titlesubfield));
3262 # warn "server : $server";
3263 # for authorities, the "title" is the $a mainentry
3264 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
3265 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
3266 $title = $record->subfield($authref->{auth_tag_to_report},'a');
3267 $index{'mainmainentry'} = $authref->{auth_tag_to_report}.'a';
3268 $index{'mainentry'} = $authref->{auth_tag_to_report}.'*';
3269 $index{'auth_type'} = '152b';
3272 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
3273 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
3274 # limit to 10 char, should be enough, and limit the DB size
3275 $title = substr($title,0,10);
3277 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
3278 foreach my $field ($record->fields()) {
3279 #parse each subfield
3280 next if $field->tag <10;
3281 foreach my $subfield ($field->subfields()) {
3282 my $tag = $field->tag();
3283 my $subfieldcode = $subfield->[0];
3285 # check each index to see if the subfield is stored somewhere
3286 # otherwise, store it in __RAW__ index
3287 foreach my $key (keys %index) {
3288 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
3289 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
3291 my $line= lc $subfield->[1];
3292 # remove meaningless value in the field...
3293 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3294 # ... and split in words
3295 foreach (split / /,$line) {
3296 next unless $_; # skip empty values (multiple spaces)
3297 # if the entry is already here, improve weight
3298 # warn "managing $_";
3299 if ($result{$key}->{"$_"} =~ /$biblionumber,$title\-(\d);/) {
3301 $result{$key}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3302 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
3304 # get the value if it exist in the nozebra table, otherwise, create it
3305 $sth2->execute($server,$key,$_);
3306 my $existing_biblionumbers = $sth2->fetchrow;
3308 if ($existing_biblionumbers) {
3309 $result{$key}->{"$_"} =$existing_biblionumbers;
3311 $result{$key}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3312 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
3313 # create a new ligne for this entry
3315 # warn "INSERT : $server / $key / $_";
3316 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname='.$dbh->quote($key).',value='.$dbh->quote($_));
3317 $result{$key}->{"$_"}.="$biblionumber,$title-1;";
3323 # the subfield is not indexed, store it in __RAW__ index anyway
3325 my $line= lc $subfield->[1];
3326 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3327 # ... and split in words
3328 foreach (split / /,$line) {
3329 next unless $_; # skip empty values (multiple spaces)
3330 # if the entry is already here, improve weight
3331 if ($result{'__RAW__'}->{"$_"} =~ /$biblionumber,$title\-(\d);/) {
3333 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3334 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
3336 # get the value if it exist in the nozebra table, otherwise, create it
3337 $sth2->execute($server,'__RAW__',$_);
3338 my $existing_biblionumbers = $sth2->fetchrow;
3340 if ($existing_biblionumbers) {
3341 $result{'__RAW__'}->{"$_"} =$existing_biblionumbers;
3343 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3344 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
3345 # create a new ligne for this entry
3347 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname="__RAW__",value='.$dbh->quote($_));
3348 $result{'__RAW__'}->{"$_"}.="$biblionumber,$title-1;";
3359 =head2 MARCitemchange
3363 &MARCitemchange( $record, $itemfield, $newvalue )
3365 Function to update a single value in an item field.
3366 Used twice, could probably be replaced by something else, but works well...
3374 sub MARCitemchange {
3375 my ( $record, $itemfield, $newvalue ) = @_;
3376 my $dbh = C4::Context->dbh;
3378 my ( $tagfield, $tagsubfield ) =
3379 GetMarcFromKohaField( $itemfield, "" );
3380 if ( ($tagfield) && ($tagsubfield) ) {
3381 my $tag = $record->field($tagfield);
3383 $tag->update( $tagsubfield => $newvalue );
3384 $record->delete_field($tag);
3385 $record->insert_fields_ordered($tag);
3393 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
3395 Find the given $subfield in the given $tag in the given
3396 MARC::Record $record. If the subfield is found, returns
3397 the (indicators, value) pair; otherwise, (undef, undef) is
3401 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
3402 I suggest we export it from this module.
3409 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
3412 if ( $tagfield < 10 ) {
3413 if ( $record->field($tagfield) ) {
3414 push @result, $record->field($tagfield)->data();
3421 foreach my $field ( $record->field($tagfield) ) {
3422 my @subfields = $field->subfields();
3423 foreach my $subfield (@subfields) {
3424 if ( @$subfield[0] eq $insubfield ) {
3425 push @result, @$subfield[1];
3426 $indicator = $field->indicator(1) . $field->indicator(2);
3431 return ( $indicator, @result );
3434 =head2 _koha_marc_update_bib_ids
3438 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
3440 Internal function to add or update biblionumber and biblioitemnumber to
3447 sub _koha_marc_update_bib_ids {
3448 my ($record, $frameworkcode, $biblionumber, $biblioitemnumber) = @_;
3450 # we must add bibnum and bibitemnum in MARC::Record...
3451 # we build the new field with biblionumber and biblioitemnumber
3452 # we drop the original field
3453 # we add the new builded field.
3454 my ($biblio_tag, $biblio_subfield ) = GetMarcFromKohaField("biblio.biblionumber",$frameworkcode);
3455 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.biblioitemnumber",$frameworkcode);
3457 if ($biblio_tag != $biblioitem_tag) {
3458 # biblionumber & biblioitemnumber are in different fields
3460 # deal with biblionumber
3461 my ($new_field, $old_field);
3462 if ($biblio_tag < 10) {
3463 $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
3466 MARC::Field->new( $biblio_tag, '', '',
3467 "$biblio_subfield" => $biblionumber );
3470 # drop old field and create new one...
3471 $old_field = $record->field($biblio_tag);
3472 $record->delete_field($old_field);
3473 $record->append_fields($new_field);
3475 # deal with biblioitemnumber
3476 if ($biblioitem_tag < 10) {
3477 $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
3480 MARC::Field->new( $biblioitem_tag, '', '',
3481 "$biblioitem_subfield" => $biblioitemnumber, );
3483 # drop old field and create new one...
3484 $old_field = $record->field($biblioitem_tag);
3485 $record->delete_field($old_field);
3486 $record->insert_fields_ordered($new_field);
3489 # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
3490 my $new_field = MARC::Field->new(
3491 $biblio_tag, '', '',
3492 "$biblio_subfield" => $biblionumber,
3493 "$biblioitem_subfield" => $biblioitemnumber
3496 # drop old field and create new one...
3497 my $old_field = $record->field($biblio_tag);
3498 $record->delete_field($old_field);
3499 $record->insert_fields_ordered($new_field);
3503 =head2 _koha_add_biblio
3507 my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
3509 Internal function to add a biblio ($biblio is a hash with the values)
3515 sub _koha_add_biblio {
3516 my ( $dbh, $biblio, $frameworkcode ) = @_;
3520 # set the series flag
3522 if ( $biblio->{'seriestitle'} ) { $serial = 1 };
3526 SET frameworkcode = ?,
3537 my $sth = $dbh->prepare($query);
3540 $biblio->{'author'},
3542 $biblio->{'unititle'},
3545 $biblio->{'seriestitle'},
3546 $biblio->{'copyrightdate'},
3547 $biblio->{'abstract'}
3550 my $biblionumber = $dbh->{'mysql_insertid'};
3551 if ( $dbh->errstr ) {
3552 $error.="ERROR in _koha_add_biblio $query".$dbh->errstr;
3557 #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
3558 return ($biblionumber,$error);
3561 =head2 _koha_modify_biblio
3565 my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
3567 Internal function for updating the biblio table
3573 sub _koha_modify_biblio {
3574 my ( $dbh, $biblio, $frameworkcode ) = @_;
3579 SET frameworkcode = ?,
3588 WHERE biblionumber = ?
3591 my $sth = $dbh->prepare($query);
3595 $biblio->{'author'},
3597 $biblio->{'unititle'},
3599 $biblio->{'serial'},
3600 $biblio->{'seriestitle'},
3601 $biblio->{'copyrightdate'},
3602 $biblio->{'abstract'},
3603 $biblio->{'biblionumber'}
3604 ) if $biblio->{'biblionumber'};
3606 if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
3607 $error.="ERROR in _koha_modify_biblio $query".$dbh->errstr;
3610 return ( $biblio->{'biblionumber'},$error );
3613 =head2 _koha_modify_biblioitem_nonmarc
3617 my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
3619 Updates biblioitems row except for marc and marcxml, which should be changed
3626 sub _koha_modify_biblioitem_nonmarc {
3627 my ( $dbh, $biblioitem ) = @_;
3630 # re-calculate the cn_sort, it may have changed
3631 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3635 SET biblionumber = ?,
3641 publicationyear = ?,
3645 collectiontitle = ?,
3647 collectionvolume= ?,
3648 editionstatement= ?,
3649 editionresponsibility = ?,
3663 where biblioitemnumber = ?
3665 my $sth = $dbh->prepare($query);
3667 $biblioitem->{'biblionumber'},
3668 $biblioitem->{'volume'},
3669 $biblioitem->{'number'},
3670 $biblioitem->{'itemtype'},
3671 $biblioitem->{'isbn'},
3672 $biblioitem->{'issn'},
3673 $biblioitem->{'publicationyear'},
3674 $biblioitem->{'publishercode'},
3675 $biblioitem->{'volumedate'},
3676 $biblioitem->{'volumedesc'},
3677 $biblioitem->{'collectiontitle'},
3678 $biblioitem->{'collectionissn'},
3679 $biblioitem->{'collectionvolume'},
3680 $biblioitem->{'editionstatement'},
3681 $biblioitem->{'editionresponsibility'},
3682 $biblioitem->{'illus'},
3683 $biblioitem->{'pages'},
3684 $biblioitem->{'bnotes'},
3685 $biblioitem->{'size'},
3686 $biblioitem->{'place'},
3687 $biblioitem->{'lccn'},
3688 $biblioitem->{'url'},
3689 $biblioitem->{'biblioitems.cn_source'},
3690 $biblioitem->{'cn_class'},
3691 $biblioitem->{'cn_item'},
3692 $biblioitem->{'cn_suffix'},
3694 $biblioitem->{'totalissues'},
3695 $biblioitem->{'biblioitemnumber'}
3697 if ( $dbh->errstr ) {
3698 $error.="ERROR in _koha_modify_biblioitem_nonmarc $query".$dbh->errstr;
3701 return ($biblioitem->{'biblioitemnumber'},$error);
3704 =head2 _koha_add_biblioitem
3708 my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
3710 Internal function to add a biblioitem
3716 sub _koha_add_biblioitem {
3717 my ( $dbh, $biblioitem ) = @_;
3720 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3722 "INSERT INTO biblioitems SET
3729 publicationyear = ?,
3733 collectiontitle = ?,
3735 collectionvolume= ?,
3736 editionstatement= ?,
3737 editionresponsibility = ?,
3753 my $sth = $dbh->prepare($query);
3755 $biblioitem->{'biblionumber'},
3756 $biblioitem->{'volume'},
3757 $biblioitem->{'number'},
3758 $biblioitem->{'itemtype'},
3759 $biblioitem->{'isbn'},
3760 $biblioitem->{'issn'},
3761 $biblioitem->{'publicationyear'},
3762 $biblioitem->{'publishercode'},
3763 $biblioitem->{'volumedate'},
3764 $biblioitem->{'volumedesc'},
3765 $biblioitem->{'collectiontitle'},
3766 $biblioitem->{'collectionissn'},
3767 $biblioitem->{'collectionvolume'},
3768 $biblioitem->{'editionstatement'},
3769 $biblioitem->{'editionresponsibility'},
3770 $biblioitem->{'illus'},
3771 $biblioitem->{'pages'},
3772 $biblioitem->{'bnotes'},
3773 $biblioitem->{'size'},
3774 $biblioitem->{'place'},
3775 $biblioitem->{'lccn'},
3776 $biblioitem->{'marc'},
3777 $biblioitem->{'url'},
3778 $biblioitem->{'biblioitems.cn_source'},
3779 $biblioitem->{'cn_class'},
3780 $biblioitem->{'cn_item'},
3781 $biblioitem->{'cn_suffix'},
3783 $biblioitem->{'totalissues'}
3785 my $bibitemnum = $dbh->{'mysql_insertid'};
3786 if ( $dbh->errstr ) {
3787 $error.="ERROR in _koha_add_biblioitem $query".$dbh->errstr;
3791 return ($bibitemnum,$error);
3794 =head2 _koha_new_items
3798 my ($itemnumber,$error) = _koha_new_items( $dbh, $item, $barcode );
3804 sub _koha_new_items {
3805 my ( $dbh, $item, $barcode ) = @_;
3808 my ($items_cn_sort) = GetClassSort($item->{'items.cn_source'}, $item->{'itemcallnumber'}, "");
3810 # if dateaccessioned is provided, use it. Otherwise, set to NOW()
3811 if ( $item->{'dateaccessioned'} eq '' || !$item->{'dateaccessioned'} ) {
3812 my $today = C4::Dates->new();
3813 $item->{'dateaccessioned'} = $today->output("iso"); #TODO: check time issues
3816 "INSERT INTO items SET
3818 biblioitemnumber = ?,
3820 dateaccessioned = ?,
3824 replacementprice = ?,
3825 replacementpricedate = NOW(),
3826 datelastborrowed = ?,
3827 datelastseen = NOW(),
3847 my $sth = $dbh->prepare($query);
3849 $item->{'biblionumber'},
3850 $item->{'biblioitemnumber'},
3852 $item->{'dateaccessioned'},
3853 $item->{'booksellerid'},
3854 $item->{'homebranch'},
3856 $item->{'replacementprice'},
3857 $item->{datelastborrowed},
3859 $item->{'notforloan'},
3861 $item->{'itemlost'},
3862 $item->{'wthdrawn'},
3863 $item->{'itemcallnumber'},
3864 $item->{'restricted'},
3865 $item->{'itemnotes'},
3866 $item->{'holdingbranch'},
3868 $item->{'location'},
3870 $item->{'items.cn_source'},
3874 $item->{'materials'},
3877 my $itemnumber = $dbh->{'mysql_insertid'};
3878 if ( defined $sth->errstr ) {
3879 $error.="ERROR in _koha_new_items $query".$sth->errstr;
3882 return ( $itemnumber, $error );
3885 =head2 _koha_modify_item
3889 my ($itemnumber,$error) =_koha_modify_item( $dbh, $item, $op );
3895 sub _koha_modify_item {
3896 my ( $dbh, $item ) = @_;
3899 # calculate items.cn_sort
3900 $item->{'cn_sort'} = GetClassSort($item->{'items.cn_source'}, $item->{'itemcallnumber'}, "");
3902 my $query = "UPDATE items SET ";
3904 for my $key ( keys %$item ) {
3906 push @bind, $item->{$key};
3909 $query .= " WHERE itemnumber=?";
3910 push @bind, $item->{'itemnumber'};
3911 my $sth = $dbh->prepare($query);
3912 $sth->execute(@bind);
3913 if ( $dbh->errstr ) {
3914 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
3918 return ($item->{'itemnumber'},$error);
3921 =head2 _koha_delete_biblio
3925 $error = _koha_delete_biblio($dbh,$biblionumber);
3927 Internal sub for deleting from biblio table -- also saves to deletedbiblio
3929 C<$dbh> - the database handle
3930 C<$biblionumber> - the biblionumber of the biblio to be deleted
3936 # FIXME: add error handling
3938 sub _koha_delete_biblio {
3939 my ( $dbh, $biblionumber ) = @_;
3941 # get all the data for this biblio
3942 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
3943 $sth->execute($biblionumber);
3945 if ( my $data = $sth->fetchrow_hashref ) {
3947 # save the record in deletedbiblio
3948 # find the fields to save
3949 my $query = "INSERT INTO deletedbiblio SET ";
3951 foreach my $temp ( keys %$data ) {
3952 $query .= "$temp = ?,";
3953 push( @bind, $data->{$temp} );
3956 # replace the last , by ",?)"
3958 my $bkup_sth = $dbh->prepare($query);
3959 $bkup_sth->execute(@bind);
3963 my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
3964 $del_sth->execute($biblionumber);
3971 =head2 _koha_delete_biblioitems
3975 $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
3977 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
3979 C<$dbh> - the database handle
3980 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
3986 # FIXME: add error handling
3988 sub _koha_delete_biblioitems {
3989 my ( $dbh, $biblioitemnumber ) = @_;
3991 # get all the data for this biblioitem
3993 $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
3994 $sth->execute($biblioitemnumber);
3996 if ( my $data = $sth->fetchrow_hashref ) {
3998 # save the record in deletedbiblioitems
3999 # find the fields to save
4000 my $query = "INSERT INTO deletedbiblioitems SET ";
4002 foreach my $temp ( keys %$data ) {
4003 $query .= "$temp = ?,";
4004 push( @bind, $data->{$temp} );
4007 # replace the last , by ",?)"
4009 my $bkup_sth = $dbh->prepare($query);
4010 $bkup_sth->execute(@bind);
4013 # delete the biblioitem
4015 $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
4016 $del_sth->execute($biblioitemnumber);
4023 =head2 _koha_delete_item
4027 _koha_delete_item( $dbh, $itemnum );
4029 Internal function to delete an item record from the koha tables
4035 sub _koha_delete_item {
4036 my ( $dbh, $itemnum ) = @_;
4038 # save the deleted item to deleteditems table
4039 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
4040 $sth->execute($itemnum);
4041 my $data = $sth->fetchrow_hashref();
4043 my $query = "INSERT INTO deleteditems SET ";
4045 foreach my $key ( keys %$data ) {
4046 $query .= "$key = ?,";
4047 push( @bind, $data->{$key} );
4050 $sth = $dbh->prepare($query);
4051 $sth->execute(@bind);
4054 # delete from items table
4055 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
4056 $sth->execute($itemnum);
4061 =head1 UNEXPORTED FUNCTIONS
4063 =head2 ModBiblioMarc
4065 &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
4067 Add MARC data for a biblio to koha
4069 Function exported, but should NOT be used, unless you really know what you're doing
4075 # pass the MARC::Record to this function, and it will create the records in the marc field
4076 my ( $record, $biblionumber, $frameworkcode ) = @_;
4077 my $dbh = C4::Context->dbh;
4078 my @fields = $record->fields();
4079 if ( !$frameworkcode ) {
4080 $frameworkcode = "";
4083 $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
4084 $sth->execute( $frameworkcode, $biblionumber );
4086 my $encoding = C4::Context->preference("marcflavour");
4088 # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
4089 if ( $encoding eq "UNIMARC" ) {
4091 if ( length($record->subfield( 100, "a" )) == 35 ) {
4092 $string = $record->subfield( 100, "a" );
4093 my $f100 = $record->field(100);
4094 $record->delete_field($f100);
4097 $string = POSIX::strftime( "%Y%m%d", localtime );
4099 $string = sprintf( "%-*s", 35, $string );
4101 substr( $string, 22, 6, "frey50" );
4102 unless ( $record->subfield( 100, "a" ) ) {
4103 $record->insert_grouped_field(
4104 MARC::Field->new( 100, "", "", "a" => $string ) );
4107 ModZebra($biblionumber,"specialUpdate","biblioserver",$record);
4110 "UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
4111 $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding),
4114 return $biblionumber;
4117 =head2 AddItemInMarc
4121 $newbiblionumber = AddItemInMarc( $record, $biblionumber, $frameworkcode );
4123 Add an item in a MARC record and save the MARC record
4125 Function exported, but should NOT be used, unless you really know what you're doing
4133 # pass the MARC::Record to this function, and it will create the records in the marc tables
4134 my ( $record, $biblionumber, $frameworkcode ) = @_;
4135 my $newrec = &GetMarcBiblio($biblionumber);
4138 my @fields = $record->fields();
4139 foreach my $field (@fields) {
4140 $newrec->append_fields($field);
4143 # FIXME: should we be making sure the biblionumbers are the same?
4144 my $newbiblionumber =
4145 &ModBiblioMarc( $newrec, $biblionumber, $frameworkcode );
4146 return $newbiblionumber;
4149 =head2 z3950_extended_services
4151 z3950_extended_services($serviceType,$serviceOptions,$record);
4153 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.
4155 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
4157 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
4159 action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
4163 recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
4164 syntax => the record syntax (transfer syntax)
4165 databaseName = Database from connection object
4167 To set serviceOptions, call set_service_options($serviceType)
4169 C<$record> the record, if one is needed for the service type
4171 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
4175 sub z3950_extended_services {
4176 my ( $server, $serviceType, $action, $serviceOptions ) = @_;
4178 # get our connection object
4179 my $Zconn = C4::Context->Zconn( $server, 0, 1 );
4181 # create a new package object
4182 my $Zpackage = $Zconn->package();
4185 $Zpackage->option( action => $action );
4187 if ( $serviceOptions->{'databaseName'} ) {
4188 $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
4190 if ( $serviceOptions->{'recordIdNumber'} ) {
4192 recordIdNumber => $serviceOptions->{'recordIdNumber'} );
4194 if ( $serviceOptions->{'recordIdOpaque'} ) {
4196 recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
4199 # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
4200 #if ($serviceType eq 'itemorder') {
4201 # $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
4202 # $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
4203 # $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
4204 # $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
4207 if ( $serviceOptions->{record} ) {
4208 $Zpackage->option( record => $serviceOptions->{record} );
4210 # can be xml or marc
4211 if ( $serviceOptions->{'syntax'} ) {
4212 $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
4216 # send the request, handle any exception encountered
4217 eval { $Zpackage->send($serviceType) };
4218 if ( $@ && $@->isa("ZOOM::Exception") ) {
4219 return "error: " . $@->code() . " " . $@->message() . "\n";
4222 # free up package resources
4223 $Zpackage->destroy();
4226 =head2 set_service_options
4228 my $serviceOptions = set_service_options($serviceType);
4230 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
4232 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
4236 sub set_service_options {
4237 my ($serviceType) = @_;
4240 # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
4241 # $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
4243 if ( $serviceType eq 'commit' ) {
4247 if ( $serviceType eq 'create' ) {
4251 if ( $serviceType eq 'drop' ) {
4252 die "ERROR: 'drop' not currently supported (by Zebra)";
4254 return $serviceOptions;
4257 =head2 GetItemsCount
4259 $count = &GetItemsCount( $biblionumber);
4260 this function return count of item with $biblionumber
4264 my ( $biblionumber ) = @_;
4265 my $dbh = C4::Context->dbh;
4266 my $query = "SELECT count(*)
4268 WHERE biblionumber=?";
4269 my $sth = $dbh->prepare($query);
4270 $sth->execute($biblionumber);
4271 my $count = $sth->fetchrow;
4276 END { } # module clean-up code here (global destructor)
4284 Koha Developement team <info@koha.org>
4286 Paul POULAIN paul.poulain@free.fr
4288 Joshua Ferraro jmf@liblime.com