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 if ($tagfield && $tagsubfield) {
469 my $tag = $record->field($tagfield);
471 # my $tagsubs = $record->field($tagfield)->subfield($tagsubfield);
472 $tag->update( $tagsubfield => $newvalue );
473 $record->delete_field($tag);
474 $record->insert_fields_ordered($tag);
475 &ModItemInMarc( $record, $biblionumber, $itemnumber, 0 );
484 &ModItemInMarc( $record, $biblionumber, $itemnumber )
491 my ( $ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
492 my $dbh = C4::Context->dbh;
494 # get complete MARC record & replace the item field by the new one
495 my $completeRecord = GetMarcBiblio($biblionumber);
496 my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
497 my $itemField = $ItemRecord->field($itemtag);
498 my @items = $completeRecord->field($itemtag);
500 if ($_->subfield($itemsubfield) eq $itemnumber) {
501 # $completeRecord->delete_field($_);
502 $_->replace_with($itemField);
506 my $sth = $dbh->prepare("UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
507 $sth->execute( $completeRecord->as_usmarc(), $completeRecord->as_xml_record(),$biblionumber );
509 ModZebra($biblionumber,"specialUpdate","biblioserver",$completeRecord);
512 =head2 ModDateLastSeen
514 &ModDateLastSeen($itemnum)
515 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking
516 C<$itemnum> is the item number
520 sub ModDateLastSeen {
522 my $dbh = C4::Context->dbh;
525 "UPDATE items SET itemlost=0,datelastseen = NOW() WHERE items.itemnumber = ?"
527 $sth->execute($itemnum);
534 my $error = &DelBiblio($dbh,$biblionumber);
535 Exported function (core API) for deleting a biblio in koha.
536 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
537 Also backs it up to deleted* tables
538 Checks to make sure there are not issues on any of the items
540 C<$error> : undef unless an error occurs
547 my ( $biblionumber ) = @_;
548 my $dbh = C4::Context->dbh;
549 my $error; # for error handling
551 # First make sure this biblio has no items attached
552 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
553 $sth->execute($biblionumber);
554 if (my $itemnumber = $sth->fetchrow){
555 # Fix this to use a status the template can understand
556 $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
559 return $error if $error;
561 # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
562 # for at least 2 reasons :
563 # - we need to read the biblio if NoZebra is set (to remove it from the indexes
564 # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
565 # 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)
566 ModZebra($biblionumber, "recordDelete", "biblioserver", undef);
568 # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
571 "SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
572 $sth->execute($biblionumber);
573 while ( my $biblioitemnumber = $sth->fetchrow ) {
575 # delete this biblioitem
576 $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
577 return $error if $error;
580 # delete biblio from Koha tables and save in deletedbiblio
581 # must do this *after* _koha_delete_biblioitems, otherwise
582 # delete cascade will prevent deletedbiblioitems rows
583 # from being generated by _koha_delete_biblioitems
584 $error = _koha_delete_biblio( $dbh, $biblionumber );
586 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","DELETE",$biblionumber,"")
587 if C4::Context->preference("CataloguingLog");
595 DelItem( $biblionumber, $itemnumber );
596 Exported function (core API) for deleting an item record in Koha.
603 my ( $dbh, $biblionumber, $itemnumber ) = @_;
605 # check the item has no current issues
608 &_koha_delete_item( $dbh, $itemnumber );
610 # get the MARC record
611 my $record = GetMarcBiblio($biblionumber);
612 my $frameworkcode = GetFrameworkCode($biblionumber);
615 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
616 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
618 #search item field code
619 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
620 my @fields = $record->field($itemtag);
622 # delete the item specified
623 foreach my $field (@fields) {
624 if ( $field->subfield($itemsubfield) eq $itemnumber ) {
625 $record->delete_field($field);
628 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
629 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","DELETE",$itemnumber,"item")
630 if C4::Context->preference("CataloguingLog");
637 $data = &GetBiblioData($biblionumber);
638 Returns information about the book with the given biblionumber.
639 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
640 the C<biblio> and C<biblioitems> tables in the
642 In addition, C<$data-E<gt>{subject}> is the list of the book's
643 subjects, separated by C<" , "> (space, comma, space).
644 If there are multiple biblioitems with the given biblionumber, only
645 the first one is considered.
653 my $dbh = C4::Context->dbh;
655 # my $query = C4::Context->preference('item-level_itypes') ?
656 # " SELECT * , biblioitems.notes AS bnotes, biblio.notes
658 # LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
659 # WHERE biblio.biblionumber = ?
660 # AND biblioitems.biblionumber = biblio.biblionumber
663 my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
665 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
666 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
667 WHERE biblio.biblionumber = ?
668 AND biblioitems.biblionumber = biblio.biblionumber ";
670 my $sth = $dbh->prepare($query);
671 $sth->execute($bibnum);
673 $data = $sth->fetchrow_hashref;
677 } # sub GetBiblioData
684 @results = &GetItemsInfo($biblionumber, $type);
686 Returns information about books with the given biblionumber.
688 C<$type> may be either C<intra> or anything else. If it is not set to
689 C<intra>, then the search will exclude lost, very overdue, and
692 C<&GetItemsInfo> returns a list of references-to-hash. Each element
693 contains a number of keys. Most of them are table items from the
694 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
695 Koha database. Other keys include:
699 =item C<$data-E<gt>{branchname}>
701 The name (not the code) of the branch to which the book belongs.
703 =item C<$data-E<gt>{datelastseen}>
705 This is simply C<items.datelastseen>, except that while the date is
706 stored in YYYY-MM-DD format in the database, here it is converted to
707 DD/MM/YYYY format. A NULL date is returned as C<//>.
709 =item C<$data-E<gt>{datedue}>
711 =item C<$data-E<gt>{class}>
713 This is the concatenation of C<biblioitems.classification>, the book's
714 Dewey code, and C<biblioitems.subclass>.
716 =item C<$data-E<gt>{ocount}>
718 I think this is the number of copies of the book available.
720 =item C<$data-E<gt>{order}>
722 If this is set, it is set to C<One Order>.
731 my ( $biblionumber, $type ) = @_;
732 my $dbh = C4::Context->dbh;
733 my $query = "SELECT *,items.notforloan as itemnotforloan
735 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
736 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
737 $query .= (C4::Context->preference('item-level_itypes')) ?
738 " LEFT JOIN itemtypes on items.itype = itemtypes.itemtype "
739 : " LEFT JOIN itemtypes on biblioitems.itemtype = itemtypes.itemtype ";
740 $query .= "WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
741 my $sth = $dbh->prepare($query);
742 $sth->execute($biblionumber);
745 my ( $date_due, $count_reserves );
747 my $isth = $dbh->prepare(
748 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
749 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
751 AND returndate IS NULL"
753 while ( my $data = $sth->fetchrow_hashref ) {
755 $isth->execute( $data->{'itemnumber'} );
756 if ( my $idata = $isth->fetchrow_hashref ) {
757 $data->{borrowernumber} = $idata->{borrowernumber};
758 $data->{cardnumber} = $idata->{cardnumber};
759 $data->{surname} = $idata->{surname};
760 $data->{firstname} = $idata->{firstname};
761 $datedue = format_date( $idata->{'date_due'} );
762 if (C4::Context->preference("IndependantBranches")){
763 my $userenv = C4::Context->userenv;
764 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
765 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
769 if ( $datedue eq '' ) {
770 #$datedue="Available";
771 my ( $restype, $reserves ) =
772 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
775 $count_reserves = $restype;
780 #get branch information.....
781 my $bsth = $dbh->prepare(
782 "SELECT * FROM branches WHERE branchcode = ?
785 $bsth->execute( $data->{'holdingbranch'} );
786 if ( my $bdata = $bsth->fetchrow_hashref ) {
787 $data->{'branchname'} = $bdata->{'branchname'};
789 my $date = format_date( $data->{'datelastseen'} );
790 $data->{'datelastseen'} = $date;
791 $data->{'datedue'} = $datedue;
792 $data->{'count_reserves'} = $count_reserves;
794 # get notforloan complete status if applicable
795 my $sthnflstatus = $dbh->prepare(
796 'SELECT authorised_value
797 FROM marc_subfield_structure
798 WHERE kohafield="items.notforloan"
802 $sthnflstatus->execute;
803 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
804 if ($authorised_valuecode) {
805 $sthnflstatus = $dbh->prepare(
806 "SELECT lib FROM authorised_values
808 AND authorised_value=?"
810 $sthnflstatus->execute( $authorised_valuecode,
811 $data->{itemnotforloan} );
812 my ($lib) = $sthnflstatus->fetchrow;
813 $data->{notforloan} = $lib;
816 # my stack procedures
817 my $stackstatus = $dbh->prepare(
818 'SELECT authorised_value
819 FROM marc_subfield_structure
820 WHERE kohafield="items.stack"
823 $stackstatus->execute;
825 ($authorised_valuecode) = $stackstatus->fetchrow;
826 if ($authorised_valuecode) {
827 $stackstatus = $dbh->prepare(
829 FROM authorised_values
831 AND authorised_value=?
834 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
835 my ($lib) = $stackstatus->fetchrow;
836 $data->{stack} = $lib;
838 $results[$i] = $data;
850 $itemstatushash = &getitemstatus($fwkcode);
851 returns information about status.
852 Can be MARC dependant.
854 But basically could be can be loan or not
855 Create a status selector with the following code
857 =head3 in PERL SCRIPT
859 my $itemstatushash = getitemstatus;
861 foreach my $thisstatus (keys %$itemstatushash) {
862 my %row =(value => $thisstatus,
863 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
865 push @itemstatusloop, \%row;
867 $template->param(statusloop=>\@itemstatusloop);
872 <select name="statusloop">
873 <option value="">Default</option>
874 <!-- TMPL_LOOP name="statusloop" -->
875 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
883 # returns a reference to a hash of references to status...
886 my $dbh = C4::Context->dbh;
888 $fwk = '' unless ($fwk);
889 my ( $tag, $subfield ) =
890 GetMarcFromKohaField( "items.notforloan", $fwk );
891 if ( $tag and $subfield ) {
894 "SELECT authorised_value
895 FROM marc_subfield_structure
901 $sth->execute( $tag, $subfield, $fwk );
902 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
905 "SELECT authorised_value,lib
906 FROM authorised_values
911 $authvalsth->execute($authorisedvaluecat);
912 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
913 $itemstatus{$authorisedvalue} = $lib;
929 $itemstatus{"1"} = "Not For Loan";
933 =head2 getitemlocation
937 $itemlochash = &getitemlocation($fwk);
938 returns informations about location.
939 where fwk stands for an optional framework code.
940 Create a location selector with the following code
942 =head3 in PERL SCRIPT
944 my $itemlochash = getitemlocation;
946 foreach my $thisloc (keys %$itemlochash) {
947 my $selected = 1 if $thisbranch eq $branch;
948 my %row =(locval => $thisloc,
949 selected => $selected,
950 locname => $itemlochash->{$thisloc},
952 push @itemlocloop, \%row;
954 $template->param(itemlocationloop => \@itemlocloop);
958 <select name="location">
959 <option value="">Default</option>
960 <!-- TMPL_LOOP name="itemlocationloop" -->
961 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
969 sub GetItemLocation {
971 # returns a reference to a hash of references to location...
974 my $dbh = C4::Context->dbh;
976 $fwk = '' unless ($fwk);
977 my ( $tag, $subfield ) =
978 GetMarcFromKohaField( "items.location", $fwk );
979 if ( $tag and $subfield ) {
982 "SELECT authorised_value
983 FROM marc_subfield_structure
988 $sth->execute( $tag, $subfield, $fwk );
989 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
992 "SELECT authorised_value,lib
993 FROM authorised_values
997 $authvalsth->execute($authorisedvaluecat);
998 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
999 $itemlocation{$authorisedvalue} = $lib;
1001 $authvalsth->finish;
1002 return \%itemlocation;
1015 $itemlocation{"1"} = "Not For Loan";
1016 return \%itemlocation;
1021 $items = GetLostItems($where,$orderby);
1023 This function get the items lost into C<$items>.
1028 C<$where> is a hashref. it containts a field of the items table as key
1029 and the value to match as value.
1030 C<$orderby> is a field of the items table.
1033 C<$items> is a reference to an array full of hasref which keys are items' table column.
1035 =item usage in the perl script:
1038 $where{barcode} = 0001548;
1039 my $items = GetLostItems( \%where, "homebranch" );
1040 $template->param(itemsloop => $items);
1047 # Getting input args.
1049 my $orderby = shift;
1050 my $dbh = C4::Context->dbh;
1055 WHERE itemlost IS NOT NULL
1058 foreach my $key (keys %$where) {
1059 $query .= " AND " . $key . " LIKE '%" . $where->{$key} . "%'";
1061 $query .= " ORDER BY ".$orderby if defined $orderby;
1063 my $sth = $dbh->prepare($query);
1066 while ( my $row = $sth->fetchrow_hashref ){
1072 =head2 GetItemsForInventory
1074 $itemlist = GetItemsForInventory($minlocation,$maxlocation,$datelastseen,$offset,$size)
1076 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1078 The sub returns a list of hashes, containing itemnumber, author, title, barcode & item callnumber.
1079 It is ordered by callnumber,title.
1081 The minlocation & maxlocation parameters are used to specify a range of item callnumbers
1082 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1083 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1087 sub GetItemsForInventory {
1088 my ( $minlocation, $maxlocation,$location, $datelastseen, $branch, $offset, $size ) = @_;
1089 my $dbh = C4::Context->dbh;
1091 if ($datelastseen) {
1092 $datelastseen=format_date_in_iso($datelastseen);
1094 "SELECT itemnumber,barcode,itemcallnumber,title,author,biblio.biblionumber,datelastseen
1096 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1097 WHERE itemcallnumber>= ?
1098 AND itemcallnumber <=?
1099 AND (datelastseen< ? OR datelastseen IS NULL)";
1100 $query.= " AND items.location=".$dbh->quote($location) if $location;
1101 $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
1102 $query .= " ORDER BY itemcallnumber,title";
1103 $sth = $dbh->prepare($query);
1104 $sth->execute( $minlocation, $maxlocation, $datelastseen );
1108 SELECT itemnumber,barcode,itemcallnumber,biblio.biblionumber,title,author,datelastseen
1110 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1111 WHERE itemcallnumber>= ?
1112 AND itemcallnumber <=?";
1113 $query.= " AND items.location=".$dbh->quote($location) if $location;
1114 $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
1115 $query .= " ORDER BY itemcallnumber,title";
1116 $sth = $dbh->prepare($query);
1117 $sth->execute( $minlocation, $maxlocation );
1120 while ( my $row = $sth->fetchrow_hashref ) {
1121 $offset-- if ($offset);
1122 $row->{datelastseen}=format_date($row->{datelastseen});
1123 if ( ( !$offset ) && $size ) {
1124 push @results, $row;
1131 =head2 &GetBiblioItemData
1135 $itemdata = &GetBiblioItemData($biblioitemnumber);
1137 Looks up the biblioitem with the given biblioitemnumber. Returns a
1138 reference-to-hash. The keys are the fields from the C<biblio>,
1139 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
1140 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
1147 sub GetBiblioItemData {
1148 my ($biblioitemnumber) = @_;
1149 my $dbh = C4::Context->dbh;
1150 my $query = "SELECT *,biblioitems.notes AS bnotes
1151 FROM biblio, biblioitems ";
1152 unless(C4::Context->preference('item-level_itypes')) {
1153 $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
1155 $query .= " WHERE biblio.biblionumber = biblioitems.biblionumber
1156 AND biblioitemnumber = ? ";
1157 my $sth = $dbh->prepare($query);
1159 $sth->execute($biblioitemnumber);
1160 $data = $sth->fetchrow_hashref;
1163 } # sub &GetBiblioItemData
1165 =head2 GetItemnumberFromBarcode
1169 $result = GetItemnumberFromBarcode($barcode);
1175 sub GetItemnumberFromBarcode {
1177 my $dbh = C4::Context->dbh;
1180 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1181 $rq->execute($barcode);
1182 my ($result) = $rq->fetchrow;
1186 =head2 GetBiblioItemByBiblioNumber
1190 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
1196 sub GetBiblioItemByBiblioNumber {
1197 my ($biblionumber) = @_;
1198 my $dbh = C4::Context->dbh;
1199 my $sth = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
1203 $sth->execute($biblionumber);
1205 while ( my $data = $sth->fetchrow_hashref ) {
1206 push @results, $data;
1213 =head2 GetBiblioFromItemNumber
1217 $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
1219 Looks up the item with the given itemnumber. if undef, try the barcode.
1221 C<&itemnodata> returns a reference-to-hash whose keys are the fields
1222 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
1230 sub GetBiblioFromItemNumber {
1231 my ( $itemnumber, $barcode ) = @_;
1232 my $dbh = C4::Context->dbh;
1235 $sth=$dbh->prepare( "SELECT * FROM items
1236 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1237 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1238 WHERE items.itemnumber = ?") ;
1239 $sth->execute($itemnumber);
1241 $sth=$dbh->prepare( "SELECT * FROM items
1242 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1243 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1244 WHERE items.barcode = ?") ;
1245 $sth->execute($barcode);
1247 my $data = $sth->fetchrow_hashref;
1256 ( $count, @results ) = &GetBiblio($biblionumber);
1263 my ($biblionumber) = @_;
1264 my $dbh = C4::Context->dbh;
1265 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
1268 $sth->execute($biblionumber);
1269 while ( my $data = $sth->fetchrow_hashref ) {
1270 $results[$count] = $data;
1274 return ( $count, @results );
1281 $data = &GetItem($itemnumber,$barcode);
1283 return Item information, for a given itemnumber or barcode
1290 my ($itemnumber,$barcode) = @_;
1291 my $dbh = C4::Context->dbh;
1293 my $sth = $dbh->prepare("
1295 WHERE itemnumber = ?");
1296 $sth->execute($itemnumber);
1297 my $data = $sth->fetchrow_hashref;
1300 my $sth = $dbh->prepare("
1304 $sth->execute($barcode);
1305 my $data = $sth->fetchrow_hashref;
1310 =head2 get_itemnumbers_of
1314 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1316 Given a list of biblionumbers, return the list of corresponding itemnumbers
1317 for each biblionumber.
1319 Return a reference on a hash where keys are biblionumbers and values are
1320 references on array of itemnumbers.
1326 sub get_itemnumbers_of {
1327 my @biblionumbers = @_;
1329 my $dbh = C4::Context->dbh;
1335 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1337 my $sth = $dbh->prepare($query);
1338 $sth->execute(@biblionumbers);
1342 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1343 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1346 return \%itemnumbers_of;
1349 =head2 GetItemInfosOf
1353 GetItemInfosOf(@itemnumbers);
1359 sub GetItemInfosOf {
1360 my @itemnumbers = @_;
1365 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1367 return get_infos_of( $query, 'itemnumber' );
1370 =head2 GetItemsByBiblioitemnumber
1374 GetItemsByBiblioitemnumber($biblioitemnumber);
1376 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1377 Called by moredetail.pl
1383 sub GetItemsByBiblioitemnumber {
1384 my ( $bibitem ) = @_;
1385 my $dbh = C4::Context->dbh;
1386 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1387 # Get all items attached to a biblioitem
1390 $sth->execute($bibitem) || die $sth->errstr;
1391 while ( my $data = $sth->fetchrow_hashref ) {
1392 # Foreach item, get circulation information
1393 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1394 WHERE itemnumber = ?
1395 AND returndate is NULL
1396 AND issues.borrowernumber = borrowers.borrowernumber"
1398 $sth2->execute( $data->{'itemnumber'} );
1399 if ( my $data2 = $sth2->fetchrow_hashref ) {
1400 # if item is out, set the due date and who it is out too
1401 $data->{'date_due'} = $data2->{'date_due'};
1402 $data->{'cardnumber'} = $data2->{'cardnumber'};
1403 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1406 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1407 $data->{'date_due'} = '';
1410 # Find the last 3 people who borrowed this item.
1411 my $query2 = "SELECT * FROM issues, borrowers WHERE itemnumber = ?
1412 AND issues.borrowernumber = borrowers.borrowernumber
1413 AND returndate is not NULL
1414 ORDER BY returndate desc,timestamp desc LIMIT 3";
1415 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1416 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1418 while ( my $data2 = $sth2->fetchrow_hashref ) {
1419 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1420 $data->{"card$i2"} = $data2->{'cardnumber'};
1421 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1425 push(@results,$data);
1432 =head2 GetBiblioItemInfosOf
1436 GetBiblioItemInfosOf(@biblioitemnumbers);
1442 sub GetBiblioItemInfosOf {
1443 my @biblioitemnumbers = @_;
1446 SELECT biblioitemnumber,
1450 WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
1452 return get_infos_of( $query, 'biblioitemnumber' );
1455 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
1457 =head2 GetMarcStructure
1461 $res = GetMarcStructure($forlibrarian,$frameworkcode);
1463 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
1464 $forlibrarian :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
1465 $frameworkcode : the framework code to read
1471 sub GetMarcStructure {
1472 my ( $forlibrarian, $frameworkcode ) = @_;
1473 my $dbh=C4::Context->dbh;
1474 $frameworkcode = "" unless $frameworkcode;
1476 my $libfield = ( $forlibrarian eq 1 ) ? 'liblibrarian' : 'libopac';
1478 # check that framework exists
1481 "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
1482 $sth->execute($frameworkcode);
1483 my ($total) = $sth->fetchrow;
1484 $frameworkcode = "" unless ( $total > 0 );
1487 "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable
1488 FROM marc_tag_structure
1489 WHERE frameworkcode=?
1492 $sth->execute($frameworkcode);
1493 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
1495 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) =
1498 $res->{$tag}->{lib} =
1499 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
1500 $res->{$tab}->{tab} = "";
1501 $res->{$tag}->{mandatory} = $mandatory;
1502 $res->{$tag}->{repeatable} = $repeatable;
1507 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue
1508 FROM marc_subfield_structure
1509 WHERE frameworkcode=?
1510 ORDER BY tagfield,tagsubfield
1514 $sth->execute($frameworkcode);
1517 my $authorised_value;
1529 $tag, $subfield, $liblibrarian,
1531 $mandatory, $repeatable, $authorised_value,
1532 $authtypecode, $value_builder, $kohafield,
1533 $seealso, $hidden, $isurl,
1539 $res->{$tag}->{$subfield}->{lib} =
1540 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
1541 $res->{$tag}->{$subfield}->{tab} = $tab;
1542 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
1543 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
1544 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
1545 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
1546 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
1547 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
1548 $res->{$tag}->{$subfield}->{seealso} = $seealso;
1549 $res->{$tag}->{$subfield}->{hidden} = $hidden;
1550 $res->{$tag}->{$subfield}->{isurl} = $isurl;
1551 $res->{$tag}->{$subfield}->{'link'} = $link;
1552 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
1557 =head2 GetUsedMarcStructure
1559 the same function as GetMarcStructure expcet it just take field
1560 in tab 0-9. (used field)
1562 my $results = GetUsedMarcStructure($frameworkcode);
1564 L<$results> is a ref to an array which each case containts a ref
1565 to a hash which each keys is the columns from marc_subfield_structure
1567 L<$frameworkcode> is the framework code.
1571 sub GetUsedMarcStructure($){
1572 my $frameworkcode = shift || '';
1573 my $dbh = C4::Context->dbh;
1576 FROM marc_subfield_structure
1578 AND frameworkcode = ?
1581 my $sth = $dbh->prepare($query);
1582 $sth->execute($frameworkcode);
1583 while (my $row = $sth->fetchrow_hashref){
1589 =head2 GetMarcFromKohaField
1593 ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
1594 Returns the MARC fields & subfields mapped to the koha field
1595 for the given frameworkcode
1601 sub GetMarcFromKohaField {
1602 my ( $kohafield, $frameworkcode ) = @_;
1603 return 0, 0 unless $kohafield;
1604 my $relations = C4::Context->marcfromkohafield;
1606 $relations->{$frameworkcode}->{$kohafield}->[0],
1607 $relations->{$frameworkcode}->{$kohafield}->[1]
1611 =head2 GetMarcBiblio
1615 Returns MARC::Record of the biblionumber passed in parameter.
1616 the marc record contains both biblio & item datas
1623 my $biblionumber = shift;
1624 my $dbh = C4::Context->dbh;
1626 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
1627 $sth->execute($biblionumber);
1628 my ($marcxml) = $sth->fetchrow;
1629 MARC::File::XML->default_record_format(C4::Context->preference('marcflavour'));
1630 $marcxml =~ s/\x1e//g;
1631 $marcxml =~ s/\x1f//g;
1632 $marcxml =~ s/\x1d//g;
1633 $marcxml =~ s/\x0f//g;
1634 $marcxml =~ s/\x0c//g;
1636 my $record = MARC::Record->new();
1638 $record = eval {MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour'))};
1640 # $record = MARC::Record::new_from_usmarc( $marc) if $marc;
1651 my $marcxml = GetXmlBiblio($biblionumber);
1653 Returns biblioitems.marcxml of the biblionumber passed in parameter.
1654 The XML contains both biblio & item datas
1661 my ( $biblionumber ) = @_;
1662 my $dbh = C4::Context->dbh;
1664 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
1665 $sth->execute($biblionumber);
1666 my ($marcxml) = $sth->fetchrow;
1670 =head2 GetAuthorisedValueDesc
1674 my $subfieldvalue =get_authorised_value_desc(
1675 $tag, $subf[$i][0],$subf[$i][1], '', $taglib);
1676 Retrieve the complete description for a given authorised value.
1682 sub GetAuthorisedValueDesc {
1683 my ( $tag, $subfield, $value, $framework, $tagslib ) = @_;
1684 my $dbh = C4::Context->dbh;
1687 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
1688 return C4::Branch::GetBranchName($value);
1692 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
1693 return getitemtypeinfo($value)->{description};
1696 #---- "true" authorized value
1697 my $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'};
1698 if ( $category ne "" ) {
1701 "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
1703 $sth->execute( $category, $value );
1704 my $data = $sth->fetchrow_hashref;
1705 return $data->{'lib'};
1708 return $value; # if nothing is found return the original value
1716 Returns MARC::Record of the item passed in parameter.
1723 my ( $biblionumber, $itemnumber ) = @_;
1724 my $dbh = C4::Context->dbh;
1725 my $newrecord = MARC::Record->new();
1726 my $marcflavour = C4::Context->preference('marcflavour');
1728 my $marcxml = GetXmlBiblio($biblionumber);
1729 my $record = MARC::Record->new();
1730 $record = MARC::Record::new_from_xml( $marcxml, "utf8", $marcflavour );
1731 # now, find where the itemnumber is stored & extract only the item
1732 my ( $itemnumberfield, $itemnumbersubfield ) =
1733 GetMarcFromKohaField( 'items.itemnumber', '' );
1734 my @fields = $record->field($itemnumberfield);
1735 foreach my $field (@fields) {
1736 if ( $field->subfield($itemnumbersubfield) eq $itemnumber ) {
1737 $newrecord->insert_fields_ordered($field);
1749 $marcnotesarray = GetMarcNotes( $record, $marcflavour );
1750 Get all notes from the MARC record and returns them in an array.
1751 The note are stored in differents places depending on MARC flavour
1758 my ( $record, $marcflavour ) = @_;
1760 if ( $marcflavour eq "MARC21" ) {
1763 else { # assume unimarc if not marc21
1770 foreach my $field ( $record->field($scope) ) {
1771 my $value = $field->as_string();
1772 if ( $note ne "" ) {
1773 $marcnote = { marcnote => $note, };
1774 push @marcnotes, $marcnote;
1777 if ( $note ne $value ) {
1778 $note = $note . " " . $value;
1783 $marcnote = { marcnote => $note };
1784 push @marcnotes, $marcnote; #load last tag into array
1787 } # end GetMarcNotes
1789 =head2 GetMarcSubjects
1793 $marcsubjcts = GetMarcSubjects($record,$marcflavour);
1794 Get all subjects from the MARC record and returns them in an array.
1795 The subjects are stored in differents places depending on MARC flavour
1801 sub GetMarcSubjects {
1802 my ( $record, $marcflavour ) = @_;
1803 my ( $mintag, $maxtag );
1804 if ( $marcflavour eq "MARC21" ) {
1808 else { # assume unimarc if not marc21
1818 foreach my $field ( $record->field('6..' )) {
1819 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1821 my @subfields = $field->subfields();
1824 # if there is an authority link, build the link with an= subfield9
1825 my $subfield9 = $field->subfield('9');
1826 for my $subject_subfield (@subfields ) {
1827 # don't load unimarc subfields 3,4,5
1828 next if (($marcflavour eq "UNIMARC") and ($subject_subfield->[0] =~ (3|4|5) ) );
1829 my $code = $subject_subfield->[0];
1830 my $value = $subject_subfield->[1];
1831 my $linkvalue = $value;
1832 $linkvalue =~ s/(\(|\))//g;
1833 my $operator = " and " unless $counter==0;
1835 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1837 push @link_loop, {'limit' => 'su', link => $linkvalue, operator => $operator };
1839 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1841 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator} unless ($subject_subfield->[0] == 9 );
1842 # this needs to be added back in in a way that the template can expose it properly
1843 #if ( $code == 9 ) {
1844 # $link = "an:".$subject_subfield->[1];
1850 push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1853 return \@marcsubjects;
1854 } #end getMARCsubjects
1856 =head2 GetMarcAuthors
1860 authors = GetMarcAuthors($record,$marcflavour);
1861 Get all authors from the MARC record and returns them in an array.
1862 The authors are stored in differents places depending on MARC flavour
1868 sub GetMarcAuthors {
1869 my ( $record, $marcflavour ) = @_;
1870 my ( $mintag, $maxtag );
1871 # tagslib useful for UNIMARC author reponsabilities
1872 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.
1873 if ( $marcflavour eq "MARC21" ) {
1877 elsif ( $marcflavour eq "UNIMARC" ) { # assume unimarc if not marc21
1886 foreach my $field ( $record->fields ) {
1887 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1889 my @subfields = $field->subfields();
1891 for my $authors_subfield (@subfields) {
1892 #unimarc-specific line
1893 next if ($marcflavour eq 'UNIMARC' and (($authors_subfield->[0] eq '3') or ($authors_subfield->[0] eq '5')));
1894 my $subfieldcode = $authors_subfield->[0];
1896 # deal with UNIMARC author responsibility
1897 if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] eq '4')) {
1898 $value = "(".GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ).")";
1900 $value = $authors_subfield->[1];
1902 $hash{tag} = $field->tag;
1903 $hash{value} .= $value . " " if ($subfieldcode != 9) ;
1904 $hash{link} .= $value if ($subfieldcode eq 9);
1906 push @marcauthors, \%hash;
1908 return \@marcauthors;
1915 $marcurls = GetMarcUrls($record,$marcflavour);
1916 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1917 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1924 my ($record, $marcflavour) = @_;
1927 for my $field ($record->field('856')) {
1928 my $url = $field->subfield('u');
1930 for my $note ( $field->subfield('z')) {
1931 push @notes , {note => $note};
1933 $marcurl = { MARCURL => $url,
1936 if($marcflavour eq 'MARC21') {
1937 my $s3 = $field->subfield('3');
1938 my $link = $field->subfield('y');
1939 $marcurl->{'linktext'} = $link || $s3 || $url ;;
1940 $marcurl->{'part'} = $s3 if($link);
1941 $marcurl->{'toc'} = 1 if($s3 =~ /^[Tt]able/) ;
1943 $marcurl->{'linktext'} = $url;
1945 push @marcurls, $marcurl;
1950 =head2 GetMarcSeries
1954 $marcseriesarray = GetMarcSeries($record,$marcflavour);
1955 Get all series from the MARC record and returns them in an array.
1956 The series are stored in differents places depending on MARC flavour
1963 my ($record, $marcflavour) = @_;
1964 my ($mintag, $maxtag);
1965 if ($marcflavour eq "MARC21") {
1968 } else { # assume unimarc if not marc21
1978 foreach my $field ($record->field('440'), $record->field('490')) {
1980 #my $value = $field->subfield('a');
1981 #$marcsubjct = {MARCSUBJCT => $value,};
1982 my @subfields = $field->subfields();
1983 #warn "subfields:".join " ", @$subfields;
1986 for my $series_subfield (@subfields) {
1988 undef $volume_number;
1989 # see if this is an instance of a volume
1990 if ($series_subfield->[0] eq 'v') {
1994 my $code = $series_subfield->[0];
1995 my $value = $series_subfield->[1];
1996 my $linkvalue = $value;
1997 $linkvalue =~ s/(\(|\))//g;
1998 my $operator = " and " unless $counter==0;
1999 push @link_loop, {link => $linkvalue, operator => $operator };
2000 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
2001 if ($volume_number) {
2002 push @subfields_loop, {volumenum => $value};
2005 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number};
2009 push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
2010 #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
2011 #push @marcsubjcts, $marcsubjct;
2015 my $marcseriessarray=\@marcseries;
2016 return $marcseriessarray;
2017 } #end getMARCseriess
2019 =head2 GetFrameworkCode
2023 $frameworkcode = GetFrameworkCode( $biblionumber )
2029 sub GetFrameworkCode {
2030 my ( $biblionumber ) = @_;
2031 my $dbh = C4::Context->dbh;
2032 my $sth = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
2033 $sth->execute($biblionumber);
2034 my ($frameworkcode) = $sth->fetchrow;
2035 return $frameworkcode;
2038 =head2 GetPublisherNameFromIsbn
2040 $name = GetPublishercodeFromIsbn($isbn);
2047 sub GetPublisherNameFromIsbn($){
2049 $isbn =~ s/[- _]//g;
2051 my @codes = (split '-', DisplayISBN($isbn));
2052 my $code = $codes[0].$codes[1].$codes[2];
2053 my $dbh = C4::Context->dbh;
2055 SELECT distinct publishercode
2058 AND publishercode IS NOT NULL
2061 my $sth = $dbh->prepare($query);
2062 $sth->execute("$code%");
2063 my $name = $sth->fetchrow;
2064 return $name if length $name;
2068 =head2 TransformKohaToMarc
2072 $record = TransformKohaToMarc( $hash )
2073 This function builds partial MARC::Record from a hash
2074 Hash entries can be from biblio or biblioitems.
2075 This function is called in acquisition module, to create a basic catalogue entry from user entry
2081 sub TransformKohaToMarc {
2084 my $dbh = C4::Context->dbh;
2087 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
2089 my $record = MARC::Record->new();
2090 foreach (keys %{$hash}) {
2091 &TransformKohaToMarcOneField( $sth, $record, $_,
2097 =head2 TransformKohaToMarcOneField
2101 $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
2107 sub TransformKohaToMarcOneField {
2108 my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
2109 $frameworkcode='' unless $frameworkcode;
2113 if ( !defined $sth ) {
2114 my $dbh = C4::Context->dbh;
2115 $sth = $dbh->prepare(
2116 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
2119 $sth->execute( $frameworkcode, $kohafieldname );
2120 if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
2121 my $tag = $record->field($tagfield);
2123 $tag->update( $tagsubfield => $value );
2124 $record->delete_field($tag);
2125 $record->insert_fields_ordered($tag);
2128 $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
2134 =head2 TransformHtmlToXml
2138 $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type )
2140 $auth_type contains :
2141 - nothing : rebuild a biblio, un UNIMARC the encoding is in 100$a pos 26/27
2142 - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
2143 - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
2149 sub TransformHtmlToXml {
2150 my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
2151 my $xml = MARC::File::XML::header('UTF-8');
2152 $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
2153 MARC::File::XML->default_record_format($auth_type);
2154 # in UNIMARC, field 100 contains the encoding
2155 # check that there is one, otherwise the
2156 # MARC::Record->new_from_xml will fail (and Koha will die)
2157 my $unimarc_and_100_exist=0;
2158 $unimarc_and_100_exist=1 if $auth_type eq 'ITEM'; # if we rebuild an item, no need of a 100 field
2163 for ( my $i = 0 ; $i <= @$tags ; $i++ ) {
2164 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a") {
2165 # if we have a 100 field and it's values are not correct, skip them.
2166 # if we don't have any valid 100 field, we will create a default one at the end
2167 my $enc = substr( @$values[$i], 26, 2 );
2168 if ($enc eq '01' or $enc eq '50' or $enc eq '03') {
2169 $unimarc_and_100_exist=1;
2174 @$values[$i] =~ s/&/&/g;
2175 @$values[$i] =~ s/</</g;
2176 @$values[$i] =~ s/>/>/g;
2177 @$values[$i] =~ s/"/"/g;
2178 @$values[$i] =~ s/'/'/g;
2179 # if ( !utf8::is_utf8( @$values[$i] ) ) {
2180 # utf8::decode( @$values[$i] );
2182 if ( ( @$tags[$i] ne $prevtag ) ) {
2183 $j++ unless ( @$tags[$i] eq "" );
2185 $xml .= "</datafield>\n";
2186 if ( ( @$tags[$i] && @$tags[$i] > 10 )
2187 && ( @$values[$i] ne "" ) )
2189 my $ind1 = substr( @$indicator[$j], 0, 1 );
2191 if ( @$indicator[$j] ) {
2192 $ind2 = substr( @$indicator[$j], 1, 1 );
2195 warn "Indicator in @$tags[$i] is empty";
2199 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2201 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2209 if ( @$values[$i] ne "" ) {
2212 if ( @$tags[$i] eq "000" ) {
2213 $xml .= "<leader>@$values[$i]</leader>\n";
2216 # rest of the fixed fields
2218 elsif ( @$tags[$i] < 10 ) {
2220 "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
2224 my $ind1 = substr( @$indicator[$j], 0, 1 );
2225 my $ind2 = substr( @$indicator[$j], 1, 1 );
2227 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2229 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2235 else { # @$tags[$i] eq $prevtag
2236 if ( @$values[$i] eq "" ) {
2240 my $ind1 = substr( @$indicator[$j], 0, 1 );
2241 my $ind2 = substr( @$indicator[$j], 1, 1 );
2243 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2247 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2250 $prevtag = @$tags[$i];
2252 if (C4::Context->preference('marcflavour') and !$unimarc_and_100_exist) {
2253 # warn "SETTING 100 for $auth_type";
2254 use POSIX qw(strftime);
2255 my $string = strftime( "%Y%m%d", localtime(time) );
2256 # set 50 to position 26 is biblios, 13 if authorities
2258 $pos=13 if $auth_type eq 'UNIMARCAUTH';
2259 $string = sprintf( "%-*s", 35, $string );
2260 substr( $string, $pos , 6, "50" );
2261 $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
2262 $xml .= "<subfield code=\"a\">$string</subfield>\n";
2263 $xml .= "</datafield>\n";
2265 $xml .= MARC::File::XML::footer();
2269 =head2 TransformHtmlToMarc
2271 L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
2272 L<$params> is a ref to an array as below:
2274 'tag_010_indicator_531951' ,
2275 'tag_010_code_a_531951_145735' ,
2276 'tag_010_subfield_a_531951_145735' ,
2277 'tag_200_indicator_873510' ,
2278 'tag_200_code_a_873510_673465' ,
2279 'tag_200_subfield_a_873510_673465' ,
2280 'tag_200_code_b_873510_704318' ,
2281 'tag_200_subfield_b_873510_704318' ,
2282 'tag_200_code_e_873510_280822' ,
2283 'tag_200_subfield_e_873510_280822' ,
2284 'tag_200_code_f_873510_110730' ,
2285 'tag_200_subfield_f_873510_110730' ,
2287 L<$cgi> is the CGI object which containts the value.
2288 L<$record> is the MARC::Record object.
2292 sub TransformHtmlToMarc {
2296 # creating a new record
2297 my $record = MARC::Record->new();
2300 while ($params->[$i]){ # browse all CGI params
2301 my $param = $params->[$i];
2303 # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
2304 if ($param eq 'biblionumber') {
2305 my ( $biblionumbertagfield, $biblionumbertagsubfield ) =
2306 &GetMarcFromKohaField( "biblio.biblionumber", '' );
2307 if ($biblionumbertagfield < 10) {
2308 $newfield = MARC::Field->new(
2309 $biblionumbertagfield,
2310 $cgi->param($param),
2313 $newfield = MARC::Field->new(
2314 $biblionumbertagfield,
2317 "$biblionumbertagsubfield" => $cgi->param($param),
2320 push @fields,$newfield if($newfield);
2322 elsif ($param =~ /^tag_(\d*)_indicator_/){ # new field start when having 'input name="..._indicator_..."
2325 my $ind1 = substr($cgi->param($param),0,1);
2326 my $ind2 = substr($cgi->param($param),1,1);
2330 if($tag < 10){ # no code for theses fields
2331 # in MARC editor, 000 contains the leader.
2332 if ($tag eq '000' ) {
2333 $record->leader($cgi->param($params->[$j+1])) if length($cgi->param($params->[$j+1]))==24;
2334 # between 001 and 009 (included)
2336 $newfield = MARC::Field->new(
2338 $cgi->param($params->[$j+1]),
2341 # > 009, deal with subfields
2343 while($params->[$j] =~ /_code_/){ # browse all it's subfield
2344 my $inner_param = $params->[$j];
2346 if($cgi->param($params->[$j+1])){ # only if there is a value (code => value)
2347 $newfield->add_subfields(
2348 $cgi->param($inner_param) => $cgi->param($params->[$j+1])
2352 if ( $cgi->param($params->[$j+1]) ) { # creating only if there is a value (code => value)
2353 $newfield = MARC::Field->new(
2357 $cgi->param($inner_param) => $cgi->param($params->[$j+1]),
2364 push @fields,$newfield if($newfield);
2369 $record->append_fields(@fields);
2373 =head2 TransformMarcToKoha
2377 $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
2383 sub TransformMarcToKoha {
2384 my ( $dbh, $record, $frameworkcode, $table ) = @_;
2388 # sometimes we only want to return the items data
2389 if ($table eq 'items') {
2390 my $sth = $dbh->prepare("SHOW COLUMNS FROM items");
2392 while ( (my $field) = $sth->fetchrow ) {
2393 my $value = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2394 my $key = _disambiguate($table, $field);
2395 if ($result->{$key}) {
2396 $result->{$key} .= " | " . $value;
2398 $result->{$key} = $value;
2403 my @tables = ('biblio','biblioitems','items');
2404 foreach my $table (@tables){
2405 my $sth2 = $dbh->prepare("SHOW COLUMNS from $table");
2407 while (my ($field) = $sth2->fetchrow){
2408 # FIXME use of _disambiguate is a temporary hack
2409 # $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2410 my $value = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2411 my $key = _disambiguate($table, $field);
2412 if ($result->{$key}) {
2413 # FIXME - hack to not bring in duplicates of the same value
2414 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($value eq "")) {
2415 $result->{$key} .= " | " . $value;
2418 $result->{$key} = $value;
2423 # modify copyrightdate to keep only the 1st year found
2424 my $temp = $result->{'copyrightdate'};
2425 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
2427 $result->{'copyrightdate'} = $1;
2429 else { # if no cYYYY, get the 1st date.
2430 $temp =~ m/(\d\d\d\d)/;
2431 $result->{'copyrightdate'} = $1;
2434 # modify publicationyear to keep only the 1st year found
2435 $temp = $result->{'publicationyear'};
2436 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
2438 $result->{'publicationyear'} = $1;
2440 else { # if no cYYYY, get the 1st date.
2441 $temp =~ m/(\d\d\d\d)/;
2442 $result->{'publicationyear'} = $1;
2449 =head2 _disambiguate
2453 $newkey = _disambiguate($table, $field);
2455 This is a temporary hack to distinguish between the
2456 following sets of columns when using TransformMarcToKoha.
2458 items.cn_source & biblioitems.cn_source
2459 items.cn_sort & biblioitems.cn_sort
2461 Columns that are currently NOT distinguished (FIXME
2462 due to lack of time to fully test) are:
2464 biblio.notes and biblioitems.notes
2469 FIXME - this is necessary because prefixing each column
2470 name with the table name would require changing lots
2471 of code and templates, and exposing more of the DB
2472 structure than is good to the UI templates, particularly
2473 since biblio and bibloitems may well merge in a future
2474 version. In the future, it would also be good to
2475 separate DB access and UI presentation field names
2483 my ($table, $column) = @_;
2484 if ($column eq "cn_sort" or $column eq "cn_source") {
2485 return $table . '.' . $column;
2492 =head2 get_koha_field_from_marc
2496 $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2498 Internal function to map data from the MARC record to a specific non-MARC field.
2499 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
2505 sub get_koha_field_from_marc {
2506 my ($koha_table,$koha_column,$record,$frameworkcode) = @_;
2507 my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table.'.'.$koha_column, $frameworkcode );
2509 foreach my $field ( $record->field($tagfield) ) {
2510 if ( $field->tag() < 10 ) {
2512 $kohafield .= " | " . $field->data();
2515 $kohafield = $field->data();
2519 if ( $field->subfields ) {
2520 my @subfields = $field->subfields();
2521 foreach my $subfieldcount ( 0 .. $#subfields ) {
2522 if ( $subfields[$subfieldcount][0] eq $subfield ) {
2525 " | " . $subfields[$subfieldcount][1];
2529 $subfields[$subfieldcount][1];
2540 =head2 TransformMarcToKohaOneField
2544 $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
2550 sub TransformMarcToKohaOneField {
2552 # FIXME ? if a field has a repeatable subfield that is used in old-db,
2553 # only the 1st will be retrieved...
2554 my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
2556 my ( $tagfield, $subfield ) =
2557 GetMarcFromKohaField( $kohatable . "." . $kohafield,
2559 foreach my $field ( $record->field($tagfield) ) {
2560 if ( $field->tag() < 10 ) {
2561 if ( $result->{$kohafield} ) {
2562 $result->{$kohafield} .= " | " . $field->data();
2565 $result->{$kohafield} = $field->data();
2569 if ( $field->subfields ) {
2570 my @subfields = $field->subfields();
2571 foreach my $subfieldcount ( 0 .. $#subfields ) {
2572 if ( $subfields[$subfieldcount][0] eq $subfield ) {
2573 if ( $result->{$kohafield} ) {
2574 $result->{$kohafield} .=
2575 " | " . $subfields[$subfieldcount][1];
2578 $result->{$kohafield} =
2579 $subfields[$subfieldcount][1];
2589 =head1 OTHER FUNCTIONS
2595 my $string = char_decode( $string, $encoding );
2597 converts ISO 5426 coded string to UTF-8
2598 sloppy code : should be improved in next issue
2605 my ( $string, $encoding ) = @_;
2608 $encoding = C4::Context->preference("marcflavour") unless $encoding;
2609 if ( $encoding eq "UNIMARC" ) {
2679 # this handles non-sorting blocks (if implementation requires this)
2680 $string = nsb_clean($_);
2682 elsif ( $encoding eq "USMARC" || $encoding eq "MARC21" ) {
2741 #Additional Turkish characters
2744 s/(\xf0)s/\xc5\x9f/gm;
2745 s/(\xf0)S/\xc5\x9e/gm;
2748 s/\xe7\x49/\\xc4\xb0/gm;
2749 s/(\xe6)G/\xc4\x9e/gm;
2750 s/(\xe6)g/ğ\xc4\x9f/gm;
2753 s/(\xe8|\xc8)o/ö/gm;
2754 s/(\xe8|\xc8)O/Ö/gm;
2755 s/(\xe8|\xc8)u/ü/gm;
2756 s/(\xe8|\xc8)U/Ü/gm;
2757 s/\xc2\xb8/\xc4\xb1/gm;
2760 # this handles non-sorting blocks (if implementation requires this)
2761 $string = nsb_clean($_);
2770 my $string = nsb_clean( $string, $encoding );
2777 my $NSB = '\x88'; # NSB : begin Non Sorting Block
2778 my $NSE = '\x89'; # NSE : Non Sorting Block end
2779 # handles non sorting blocks
2783 s/[ ]{0,1}$NSE/) /gm;
2788 =head2 PrepareItemrecordDisplay
2792 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber);
2794 Returns a hash with all the fields for Display a given item data in a template
2800 sub PrepareItemrecordDisplay {
2802 my ( $bibnum, $itemnum ) = @_;
2804 my $dbh = C4::Context->dbh;
2805 my $frameworkcode = &GetFrameworkCode( $bibnum );
2806 my ( $itemtagfield, $itemtagsubfield ) =
2807 &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2808 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2809 my $itemrecord = GetMarcItem( $bibnum, $itemnum) if ($itemnum);
2811 my $authorised_values_sth =
2813 "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib"
2815 foreach my $tag ( sort keys %{$tagslib} ) {
2816 my $previous_tag = '';
2818 # loop through each subfield
2820 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2821 next if ( subfield_is_koha_internal_p($subfield) );
2822 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2824 $subfield_data{tag} = $tag;
2825 $subfield_data{subfield} = $subfield;
2826 $subfield_data{countsubfield} = $cntsubf++;
2827 $subfield_data{kohafield} =
2828 $tagslib->{$tag}->{$subfield}->{'kohafield'};
2830 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2831 $subfield_data{marc_lib} =
2832 "<span id=\"error\" title=\""
2833 . $tagslib->{$tag}->{$subfield}->{lib} . "\">"
2834 . substr( $tagslib->{$tag}->{$subfield}->{lib}, 0, 12 )
2836 $subfield_data{mandatory} =
2837 $tagslib->{$tag}->{$subfield}->{mandatory};
2838 $subfield_data{repeatable} =
2839 $tagslib->{$tag}->{$subfield}->{repeatable};
2840 $subfield_data{hidden} = "display:none"
2841 if $tagslib->{$tag}->{$subfield}->{hidden};
2843 ( $x, $value ) = _find_value( $tag, $subfield, $itemrecord )
2845 $value =~ s/"/"/g;
2847 # search for itemcallnumber if applicable
2848 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
2849 'items.itemcallnumber'
2850 && C4::Context->preference('itemcallnumber') )
2853 substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2855 substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2856 my $temp = $itemrecord->field($CNtag) if ($itemrecord);
2858 $value = $temp->subfield($CNsubfield);
2861 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2862 my @authorised_values;
2865 # builds list, depending on authorised value...
2867 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq
2870 if ( ( C4::Context->preference("IndependantBranches") )
2871 && ( C4::Context->userenv->{flags} != 1 ) )
2875 "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname"
2877 $sth->execute( C4::Context->userenv->{branch} );
2878 push @authorised_values, ""
2880 $tagslib->{$tag}->{$subfield}->{mandatory} );
2881 while ( my ( $branchcode, $branchname ) =
2882 $sth->fetchrow_array )
2884 push @authorised_values, $branchcode;
2885 $authorised_lib{$branchcode} = $branchname;
2891 "SELECT branchcode,branchname FROM branches ORDER BY branchname"
2894 push @authorised_values, ""
2896 $tagslib->{$tag}->{$subfield}->{mandatory} );
2897 while ( my ( $branchcode, $branchname ) =
2898 $sth->fetchrow_array )
2900 push @authorised_values, $branchcode;
2901 $authorised_lib{$branchcode} = $branchname;
2907 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq
2912 "SELECT itemtype,description FROM itemtypes ORDER BY description"
2915 push @authorised_values, ""
2916 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2917 while ( my ( $itemtype, $description ) =
2918 $sth->fetchrow_array )
2920 push @authorised_values, $itemtype;
2921 $authorised_lib{$itemtype} = $description;
2924 #---- "true" authorised value
2927 $authorised_values_sth->execute(
2928 $tagslib->{$tag}->{$subfield}->{authorised_value} );
2929 push @authorised_values, ""
2930 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2931 while ( my ( $value, $lib ) =
2932 $authorised_values_sth->fetchrow_array )
2934 push @authorised_values, $value;
2935 $authorised_lib{$value} = $lib;
2938 $subfield_data{marc_value} = CGI::scrolling_list(
2939 -name => 'field_value',
2940 -values => \@authorised_values,
2941 -default => "$value",
2942 -labels => \%authorised_lib,
2948 elsif ( $tagslib->{$tag}->{$subfield}->{thesaurus_category} ) {
2949 $subfield_data{marc_value} =
2950 "<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>";
2953 # COMMENTED OUT because No $i is provided with this API.
2954 # And thus, no value_builder can be activated.
2955 # BUT could be thought over.
2956 # } elsif ($tagslib->{$tag}->{$subfield}->{'value_builder'}) {
2957 # my $plugin="value_builder/".$tagslib->{$tag}->{$subfield}->{'value_builder'};
2959 # my $extended_param = plugin_parameters($dbh,$itemrecord,$tagslib,$i,0);
2960 # my ($function_name,$javascript) = plugin_javascript($dbh,$record,$tagslib,$i,0);
2961 # $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";
2964 $subfield_data{marc_value} =
2965 "<input type=\"text\" name=\"field_value\" value=\"$value\" size=50 maxlength=255>";
2967 push( @loop_data, \%subfield_data );
2971 my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
2972 if ( $itemrecord && $itemrecord->field($itemtagfield) );
2974 'itemtagfield' => $itemtagfield,
2975 'itemtagsubfield' => $itemtagsubfield,
2976 'itemnumber' => $itemnumber,
2977 'iteminformation' => \@loop_data
2983 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2985 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2986 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2987 # =head2 ModZebrafiles
2989 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
2993 # sub ModZebrafiles {
2995 # my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
2999 # C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
3000 # unless ( opendir( DIR, "$zebradir" ) ) {
3001 # warn "$zebradir not found";
3005 # my $filename = $zebradir . $biblionumber;
3008 # open( OUTPUT, ">", $filename . ".xml" );
3009 # print OUTPUT $record;
3018 ModZebra( $biblionumber, $op, $server, $newRecord );
3020 $biblionumber is the biblionumber we want to index
3021 $op is specialUpdate or delete, and is used to know what we want to do
3022 $server is the server that we want to update
3023 $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.
3030 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
3031 my ( $biblionumber, $op, $server, $newRecord ) = @_;
3032 my $dbh=C4::Context->dbh;
3034 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
3036 # replaced by a zebraqueue table, that is filled with ModZebra to run.
3037 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
3039 if (C4::Context->preference("NoZebra")) {
3040 # lock the nozebra table : we will read index lines, update them in Perl process
3041 # and write everything in 1 transaction.
3042 # lock the table to avoid someone else overwriting what we are doing
3043 $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE');
3044 my %result; # the result hash that will be builded by deletion / add, and written on mySQL at the end, to improve speed
3046 if ($server eq 'biblioserver') {
3047 $record= GetMarcBiblio($biblionumber);
3049 $record= C4::AuthoritiesMarc::GetAuthority($biblionumber);
3051 if ($op eq 'specialUpdate') {
3052 # OK, we have to add or update the record
3053 # 1st delete (virtually, in indexes) ...
3054 %result = _DelBiblioNoZebra($biblionumber,$record,$server);
3055 # ... add the record
3056 %result=_AddBiblioNoZebra($biblionumber,$newRecord, $server, %result);
3058 # it's a deletion, delete the record...
3059 # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
3060 %result=_DelBiblioNoZebra($biblionumber,$record,$server);
3062 # ok, now update the database...
3063 my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
3064 foreach my $key (keys %result) {
3065 foreach my $index (keys %{$result{$key}}) {
3066 $sth->execute($result{$key}->{$index}, $server, $key, $index);
3069 $dbh->do('UNLOCK TABLES');
3073 # we use zebra, just fill zebraqueue table
3075 my $sth=$dbh->prepare("INSERT INTO zebraqueue (biblio_auth_number,server,operation) VALUES(?,?,?)");
3076 $sth->execute($biblionumber,$server,$op);
3081 =head2 GetNoZebraIndexes
3083 %indexes = GetNoZebraIndexes;
3085 return the data from NoZebraIndexes syspref.
3089 sub GetNoZebraIndexes {
3090 my $index = C4::Context->preference('NoZebraIndexes');
3092 foreach my $line (split /('|"),/,$index) {
3093 $line =~ /(.*)=>(.*)/;
3095 my $index = substr($1,1); # get the index, don't forget to remove initial ' or "
3097 $index =~ s/'|"|\s//g;
3100 $fields =~ s/'|"|\s//g;
3101 $indexes{$index}=$fields;
3106 =head1 INTERNAL FUNCTIONS
3108 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
3110 function to delete a biblio in NoZebra indexes
3111 This function does NOT delete anything in database : it reads all the indexes entries
3112 that have to be deleted & delete them in the hash
3113 The SQL part is done either :
3114 - after the Add if we are modifying a biblio (delete + add again)
3115 - immediatly after this sub if we are doing a true deletion.
3116 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
3121 sub _DelBiblioNoZebra {
3122 my ($biblionumber, $record, $server)=@_;
3125 my $dbh = C4::Context->dbh;
3129 if ($server eq 'biblioserver') {
3130 %index=GetNoZebraIndexes;
3131 # get title of the record (to store the 10 first letters with the index)
3132 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
3133 $title = lc($record->subfield($titletag,$titlesubfield));
3135 # for authorities, the "title" is the $a mainentry
3136 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
3137 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
3138 $title = $record->subfield($authref->{auth_tag_to_report},'a');
3139 $index{'mainmainentry'}= $authref->{'auth_tag_to_report'}.'a';
3140 $index{'mainentry'} = $authref->{'auth_tag_to_report'}.'*';
3141 $index{'auth_type'} = '152b';
3145 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
3146 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
3147 # limit to 10 char, should be enough, and limit the DB size
3148 $title = substr($title,0,10);
3150 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
3151 foreach my $field ($record->fields()) {
3152 #parse each subfield
3153 next if $field->tag <10;
3154 foreach my $subfield ($field->subfields()) {
3155 my $tag = $field->tag();
3156 my $subfieldcode = $subfield->[0];
3158 # check each index to see if the subfield is stored somewhere
3159 # otherwise, store it in __RAW__ index
3160 foreach my $key (keys %index) {
3161 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
3162 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
3164 my $line= lc $subfield->[1];
3165 # remove meaningless value in the field...
3166 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3167 # ... and split in words
3168 foreach (split / /,$line) {
3169 next unless $_; # skip empty values (multiple spaces)
3170 # if the entry is already here, do nothing, the biblionumber has already be removed
3171 unless ($result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/) {
3172 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
3173 $sth2->execute($server,$key,$_);
3174 my $existing_biblionumbers = $sth2->fetchrow;
3176 if ($existing_biblionumbers) {
3177 # warn " existing for $key $_: $existing_biblionumbers";
3178 $result{$key}->{$_} =$existing_biblionumbers;
3179 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
3185 # the subfield is not indexed, store it in __RAW__ index anyway
3187 my $line= lc $subfield->[1];
3188 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3189 # ... and split in words
3190 foreach (split / /,$line) {
3191 next unless $_; # skip empty values (multiple spaces)
3192 # if the entry is already here, do nothing, the biblionumber has already be removed
3193 unless ($result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/) {
3194 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
3195 $sth2->execute($server,'__RAW__',$_);
3196 my $existing_biblionumbers = $sth2->fetchrow;
3198 if ($existing_biblionumbers) {
3199 $result{'__RAW__'}->{$_} =$existing_biblionumbers;
3200 $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
3210 =head2 _AddBiblioNoZebra($biblionumber, $record, $server, %result);
3212 function to add a biblio in NoZebra indexes
3216 sub _AddBiblioNoZebra {
3217 my ($biblionumber, $record, $server, %result)=@_;
3218 my $dbh = C4::Context->dbh;
3222 if ($server eq 'biblioserver') {
3223 %index=GetNoZebraIndexes;
3224 # get title of the record (to store the 10 first letters with the index)
3225 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
3226 $title = lc($record->subfield($titletag,$titlesubfield));
3228 # warn "server : $server";
3229 # for authorities, the "title" is the $a mainentry
3230 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
3231 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
3232 $title = $record->subfield($authref->{auth_tag_to_report},'a');
3233 $index{'mainmainentry'} = $authref->{auth_tag_to_report}.'a';
3234 $index{'mainentry'} = $authref->{auth_tag_to_report}.'*';
3235 $index{'auth_type'} = '152b';
3238 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
3239 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
3240 # limit to 10 char, should be enough, and limit the DB size
3241 $title = substr($title,0,10);
3243 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
3244 foreach my $field ($record->fields()) {
3245 #parse each subfield
3246 next if $field->tag <10;
3247 foreach my $subfield ($field->subfields()) {
3248 my $tag = $field->tag();
3249 my $subfieldcode = $subfield->[0];
3251 # check each index to see if the subfield is stored somewhere
3252 # otherwise, store it in __RAW__ index
3253 foreach my $key (keys %index) {
3254 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
3255 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
3257 my $line= lc $subfield->[1];
3258 # remove meaningless value in the field...
3259 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3260 # ... and split in words
3261 foreach (split / /,$line) {
3262 next unless $_; # skip empty values (multiple spaces)
3263 # if the entry is already here, improve weight
3264 # warn "managing $_";
3265 if ($result{$key}->{"$_"} =~ /$biblionumber,$title\-(\d);/) {
3267 $result{$key}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3268 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
3270 # get the value if it exist in the nozebra table, otherwise, create it
3271 $sth2->execute($server,$key,$_);
3272 my $existing_biblionumbers = $sth2->fetchrow;
3274 if ($existing_biblionumbers) {
3275 $result{$key}->{"$_"} =$existing_biblionumbers;
3277 $result{$key}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3278 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
3279 # create a new ligne for this entry
3281 # warn "INSERT : $server / $key / $_";
3282 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname='.$dbh->quote($key).',value='.$dbh->quote($_));
3283 $result{$key}->{"$_"}.="$biblionumber,$title-1;";
3289 # the subfield is not indexed, store it in __RAW__ index anyway
3291 my $line= lc $subfield->[1];
3292 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3293 # ... and split in words
3294 foreach (split / /,$line) {
3295 next unless $_; # skip empty values (multiple spaces)
3296 # if the entry is already here, improve weight
3297 if ($result{'__RAW__'}->{"$_"} =~ /$biblionumber,$title\-(\d);/) {
3299 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3300 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
3302 # get the value if it exist in the nozebra table, otherwise, create it
3303 $sth2->execute($server,'__RAW__',$_);
3304 my $existing_biblionumbers = $sth2->fetchrow;
3306 if ($existing_biblionumbers) {
3307 $result{'__RAW__'}->{"$_"} =$existing_biblionumbers;
3309 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3310 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
3311 # create a new ligne for this entry
3313 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname="__RAW__",value='.$dbh->quote($_));
3314 $result{'__RAW__'}->{"$_"}.="$biblionumber,$title-1;";
3325 =head2 MARCitemchange
3329 &MARCitemchange( $record, $itemfield, $newvalue )
3331 Function to update a single value in an item field.
3332 Used twice, could probably be replaced by something else, but works well...
3340 sub MARCitemchange {
3341 my ( $record, $itemfield, $newvalue ) = @_;
3342 my $dbh = C4::Context->dbh;
3344 my ( $tagfield, $tagsubfield ) =
3345 GetMarcFromKohaField( $itemfield, "" );
3346 if ( ($tagfield) && ($tagsubfield) ) {
3347 my $tag = $record->field($tagfield);
3349 $tag->update( $tagsubfield => $newvalue );
3350 $record->delete_field($tag);
3351 $record->insert_fields_ordered($tag);
3359 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
3361 Find the given $subfield in the given $tag in the given
3362 MARC::Record $record. If the subfield is found, returns
3363 the (indicators, value) pair; otherwise, (undef, undef) is
3367 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
3368 I suggest we export it from this module.
3375 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
3378 if ( $tagfield < 10 ) {
3379 if ( $record->field($tagfield) ) {
3380 push @result, $record->field($tagfield)->data();
3387 foreach my $field ( $record->field($tagfield) ) {
3388 my @subfields = $field->subfields();
3389 foreach my $subfield (@subfields) {
3390 if ( @$subfield[0] eq $insubfield ) {
3391 push @result, @$subfield[1];
3392 $indicator = $field->indicator(1) . $field->indicator(2);
3397 return ( $indicator, @result );
3400 =head2 _koha_marc_update_bib_ids
3404 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
3406 Internal function to add or update biblionumber and biblioitemnumber to
3413 sub _koha_marc_update_bib_ids {
3414 my ($record, $frameworkcode, $biblionumber, $biblioitemnumber) = @_;
3416 # we must add bibnum and bibitemnum in MARC::Record...
3417 # we build the new field with biblionumber and biblioitemnumber
3418 # we drop the original field
3419 # we add the new builded field.
3420 my ($biblio_tag, $biblio_subfield ) = GetMarcFromKohaField("biblio.biblionumber",$frameworkcode);
3421 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.biblioitemnumber",$frameworkcode);
3423 if ($biblio_tag != $biblioitem_tag) {
3424 # biblionumber & biblioitemnumber are in different fields
3426 # deal with biblionumber
3427 my ($new_field, $old_field);
3428 if ($biblio_tag < 10) {
3429 $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
3432 MARC::Field->new( $biblio_tag, '', '',
3433 "$biblio_subfield" => $biblionumber );
3436 # drop old field and create new one...
3437 $old_field = $record->field($biblio_tag);
3438 $record->delete_field($old_field);
3439 $record->append_fields($new_field);
3441 # deal with biblioitemnumber
3442 if ($biblioitem_tag < 10) {
3443 $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
3446 MARC::Field->new( $biblioitem_tag, '', '',
3447 "$biblioitem_subfield" => $biblioitemnumber, );
3449 # drop old field and create new one...
3450 $old_field = $record->field($biblioitem_tag);
3451 $record->delete_field($old_field);
3452 $record->insert_fields_ordered($new_field);
3455 # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
3456 my $new_field = MARC::Field->new(
3457 $biblio_tag, '', '',
3458 "$biblio_subfield" => $biblionumber,
3459 "$biblioitem_subfield" => $biblioitemnumber
3462 # drop old field and create new one...
3463 my $old_field = $record->field($biblio_tag);
3464 $record->delete_field($old_field);
3465 $record->insert_fields_ordered($new_field);
3469 =head2 _koha_add_biblio
3473 my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
3475 Internal function to add a biblio ($biblio is a hash with the values)
3481 sub _koha_add_biblio {
3482 my ( $dbh, $biblio, $frameworkcode ) = @_;
3486 # set the series flag
3488 if ( $biblio->{'seriestitle'} ) { $serial = 1 };
3492 SET frameworkcode = ?,
3503 my $sth = $dbh->prepare($query);
3506 $biblio->{'author'},
3508 $biblio->{'unititle'},
3511 $biblio->{'seriestitle'},
3512 $biblio->{'copyrightdate'},
3513 $biblio->{'abstract'}
3516 my $biblionumber = $dbh->{'mysql_insertid'};
3517 if ( $dbh->errstr ) {
3518 $error.="ERROR in _koha_add_biblio $query".$dbh->errstr;
3523 #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
3524 return ($biblionumber,$error);
3527 =head2 _koha_modify_biblio
3531 my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
3533 Internal function for updating the biblio table
3539 sub _koha_modify_biblio {
3540 my ( $dbh, $biblio, $frameworkcode ) = @_;
3545 SET frameworkcode = ?,
3554 WHERE biblionumber = ?
3557 my $sth = $dbh->prepare($query);
3561 $biblio->{'author'},
3563 $biblio->{'unititle'},
3565 $biblio->{'serial'},
3566 $biblio->{'seriestitle'},
3567 $biblio->{'copyrightdate'},
3568 $biblio->{'abstract'},
3569 $biblio->{'biblionumber'}
3570 ) if $biblio->{'biblionumber'};
3572 if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
3573 $error.="ERROR in _koha_modify_biblio $query".$dbh->errstr;
3576 return ( $biblio->{'biblionumber'},$error );
3579 =head2 _koha_modify_biblioitem_nonmarc
3583 my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
3585 Updates biblioitems row except for marc and marcxml, which should be changed
3592 sub _koha_modify_biblioitem_nonmarc {
3593 my ( $dbh, $biblioitem ) = @_;
3596 # re-calculate the cn_sort, it may have changed
3597 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3601 SET biblionumber = ?,
3607 publicationyear = ?,
3611 collectiontitle = ?,
3613 collectionvolume= ?,
3614 editionstatement= ?,
3615 editionresponsibility = ?,
3629 where biblioitemnumber = ?
3631 my $sth = $dbh->prepare($query);
3633 $biblioitem->{'biblionumber'},
3634 $biblioitem->{'volume'},
3635 $biblioitem->{'number'},
3636 $biblioitem->{'itemtype'},
3637 $biblioitem->{'isbn'},
3638 $biblioitem->{'issn'},
3639 $biblioitem->{'publicationyear'},
3640 $biblioitem->{'publishercode'},
3641 $biblioitem->{'volumedate'},
3642 $biblioitem->{'volumedesc'},
3643 $biblioitem->{'collectiontitle'},
3644 $biblioitem->{'collectionissn'},
3645 $biblioitem->{'collectionvolume'},
3646 $biblioitem->{'editionstatement'},
3647 $biblioitem->{'editionresponsibility'},
3648 $biblioitem->{'illus'},
3649 $biblioitem->{'pages'},
3650 $biblioitem->{'bnotes'},
3651 $biblioitem->{'size'},
3652 $biblioitem->{'place'},
3653 $biblioitem->{'lccn'},
3654 $biblioitem->{'url'},
3655 $biblioitem->{'biblioitems.cn_source'},
3656 $biblioitem->{'cn_class'},
3657 $biblioitem->{'cn_item'},
3658 $biblioitem->{'cn_suffix'},
3660 $biblioitem->{'totalissues'},
3661 $biblioitem->{'biblioitemnumber'}
3663 if ( $dbh->errstr ) {
3664 $error.="ERROR in _koha_modify_biblioitem_nonmarc $query".$dbh->errstr;
3667 return ($biblioitem->{'biblioitemnumber'},$error);
3670 =head2 _koha_add_biblioitem
3674 my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
3676 Internal function to add a biblioitem
3682 sub _koha_add_biblioitem {
3683 my ( $dbh, $biblioitem ) = @_;
3686 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3688 "INSERT INTO biblioitems SET
3695 publicationyear = ?,
3699 collectiontitle = ?,
3701 collectionvolume= ?,
3702 editionstatement= ?,
3703 editionresponsibility = ?,
3719 my $sth = $dbh->prepare($query);
3721 $biblioitem->{'biblionumber'},
3722 $biblioitem->{'volume'},
3723 $biblioitem->{'number'},
3724 $biblioitem->{'itemtype'},
3725 $biblioitem->{'isbn'},
3726 $biblioitem->{'issn'},
3727 $biblioitem->{'publicationyear'},
3728 $biblioitem->{'publishercode'},
3729 $biblioitem->{'volumedate'},
3730 $biblioitem->{'volumedesc'},
3731 $biblioitem->{'collectiontitle'},
3732 $biblioitem->{'collectionissn'},
3733 $biblioitem->{'collectionvolume'},
3734 $biblioitem->{'editionstatement'},
3735 $biblioitem->{'editionresponsibility'},
3736 $biblioitem->{'illus'},
3737 $biblioitem->{'pages'},
3738 $biblioitem->{'bnotes'},
3739 $biblioitem->{'size'},
3740 $biblioitem->{'place'},
3741 $biblioitem->{'lccn'},
3742 $biblioitem->{'marc'},
3743 $biblioitem->{'url'},
3744 $biblioitem->{'biblioitems.cn_source'},
3745 $biblioitem->{'cn_class'},
3746 $biblioitem->{'cn_item'},
3747 $biblioitem->{'cn_suffix'},
3749 $biblioitem->{'totalissues'}
3751 my $bibitemnum = $dbh->{'mysql_insertid'};
3752 if ( $dbh->errstr ) {
3753 $error.="ERROR in _koha_add_biblioitem $query".$dbh->errstr;
3757 return ($bibitemnum,$error);
3760 =head2 _koha_new_items
3764 my ($itemnumber,$error) = _koha_new_items( $dbh, $item, $barcode );
3770 sub _koha_new_items {
3771 my ( $dbh, $item, $barcode ) = @_;
3774 my ($items_cn_sort) = GetClassSort($item->{'items.cn_source'}, $item->{'itemcallnumber'}, "");
3776 # if dateaccessioned is provided, use it. Otherwise, set to NOW()
3777 if ( $item->{'dateaccessioned'} eq '' || !$item->{'dateaccessioned'} ) {
3778 my $today = C4::Dates->new();
3779 $item->{'dateaccessioned'} = $today->output("iso"); #TODO: check time issues
3782 "INSERT INTO items SET
3784 biblioitemnumber = ?,
3786 dateaccessioned = ?,
3790 replacementprice = ?,
3791 replacementpricedate = NOW(),
3792 datelastborrowed = ?,
3793 datelastseen = NOW(),
3813 my $sth = $dbh->prepare($query);
3815 $item->{'biblionumber'},
3816 $item->{'biblioitemnumber'},
3818 $item->{'dateaccessioned'},
3819 $item->{'booksellerid'},
3820 $item->{'homebranch'},
3822 $item->{'replacementprice'},
3823 $item->{datelastborrowed},
3825 $item->{'notforloan'},
3827 $item->{'itemlost'},
3828 $item->{'wthdrawn'},
3829 $item->{'itemcallnumber'},
3830 $item->{'restricted'},
3831 $item->{'itemnotes'},
3832 $item->{'holdingbranch'},
3834 $item->{'location'},
3836 $item->{'items.cn_source'},
3840 $item->{'materials'},
3843 my $itemnumber = $dbh->{'mysql_insertid'};
3844 if ( defined $sth->errstr ) {
3845 $error.="ERROR in _koha_new_items $query".$sth->errstr;
3848 return ( $itemnumber, $error );
3851 =head2 _koha_modify_item
3855 my ($itemnumber,$error) =_koha_modify_item( $dbh, $item, $op );
3861 sub _koha_modify_item {
3862 my ( $dbh, $item ) = @_;
3865 # calculate items.cn_sort
3866 $item->{'cn_sort'} = GetClassSort($item->{'items.cn_source'}, $item->{'itemcallnumber'}, "");
3868 my $query = "UPDATE items SET ";
3870 for my $key ( keys %$item ) {
3872 push @bind, $item->{$key};
3875 $query .= " WHERE itemnumber=?";
3876 push @bind, $item->{'itemnumber'};
3877 my $sth = $dbh->prepare($query);
3878 $sth->execute(@bind);
3879 if ( $dbh->errstr ) {
3880 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
3884 return ($item->{'itemnumber'},$error);
3887 =head2 _koha_delete_biblio
3891 $error = _koha_delete_biblio($dbh,$biblionumber);
3893 Internal sub for deleting from biblio table -- also saves to deletedbiblio
3895 C<$dbh> - the database handle
3896 C<$biblionumber> - the biblionumber of the biblio to be deleted
3902 # FIXME: add error handling
3904 sub _koha_delete_biblio {
3905 my ( $dbh, $biblionumber ) = @_;
3907 # get all the data for this biblio
3908 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
3909 $sth->execute($biblionumber);
3911 if ( my $data = $sth->fetchrow_hashref ) {
3913 # save the record in deletedbiblio
3914 # find the fields to save
3915 my $query = "INSERT INTO deletedbiblio SET ";
3917 foreach my $temp ( keys %$data ) {
3918 $query .= "$temp = ?,";
3919 push( @bind, $data->{$temp} );
3922 # replace the last , by ",?)"
3924 my $bkup_sth = $dbh->prepare($query);
3925 $bkup_sth->execute(@bind);
3929 my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
3930 $del_sth->execute($biblionumber);
3937 =head2 _koha_delete_biblioitems
3941 $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
3943 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
3945 C<$dbh> - the database handle
3946 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
3952 # FIXME: add error handling
3954 sub _koha_delete_biblioitems {
3955 my ( $dbh, $biblioitemnumber ) = @_;
3957 # get all the data for this biblioitem
3959 $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
3960 $sth->execute($biblioitemnumber);
3962 if ( my $data = $sth->fetchrow_hashref ) {
3964 # save the record in deletedbiblioitems
3965 # find the fields to save
3966 my $query = "INSERT INTO deletedbiblioitems SET ";
3968 foreach my $temp ( keys %$data ) {
3969 $query .= "$temp = ?,";
3970 push( @bind, $data->{$temp} );
3973 # replace the last , by ",?)"
3975 my $bkup_sth = $dbh->prepare($query);
3976 $bkup_sth->execute(@bind);
3979 # delete the biblioitem
3981 $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
3982 $del_sth->execute($biblioitemnumber);
3989 =head2 _koha_delete_item
3993 _koha_delete_item( $dbh, $itemnum );
3995 Internal function to delete an item record from the koha tables
4001 sub _koha_delete_item {
4002 my ( $dbh, $itemnum ) = @_;
4004 # save the deleted item to deleteditems table
4005 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
4006 $sth->execute($itemnum);
4007 my $data = $sth->fetchrow_hashref();
4009 my $query = "INSERT INTO deleteditems SET ";
4011 foreach my $key ( keys %$data ) {
4012 $query .= "$key = ?,";
4013 push( @bind, $data->{$key} );
4016 $sth = $dbh->prepare($query);
4017 $sth->execute(@bind);
4020 # delete from items table
4021 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
4022 $sth->execute($itemnum);
4027 =head1 UNEXPORTED FUNCTIONS
4029 =head2 ModBiblioMarc
4031 &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
4033 Add MARC data for a biblio to koha
4035 Function exported, but should NOT be used, unless you really know what you're doing
4041 # pass the MARC::Record to this function, and it will create the records in the marc field
4042 my ( $record, $biblionumber, $frameworkcode ) = @_;
4043 my $dbh = C4::Context->dbh;
4044 my @fields = $record->fields();
4045 if ( !$frameworkcode ) {
4046 $frameworkcode = "";
4049 $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
4050 $sth->execute( $frameworkcode, $biblionumber );
4052 my $encoding = C4::Context->preference("marcflavour");
4054 # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
4055 if ( $encoding eq "UNIMARC" ) {
4057 if ( length($record->subfield( 100, "a" )) == 35 ) {
4058 $string = $record->subfield( 100, "a" );
4059 my $f100 = $record->field(100);
4060 $record->delete_field($f100);
4063 $string = POSIX::strftime( "%Y%m%d", localtime );
4065 $string = sprintf( "%-*s", 35, $string );
4067 substr( $string, 22, 6, "frey50" );
4068 unless ( $record->subfield( 100, "a" ) ) {
4069 $record->insert_grouped_field(
4070 MARC::Field->new( 100, "", "", "a" => $string ) );
4073 ModZebra($biblionumber,"specialUpdate","biblioserver",$record);
4076 "UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
4077 $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding),
4080 return $biblionumber;
4083 =head2 AddItemInMarc
4087 $newbiblionumber = AddItemInMarc( $record, $biblionumber, $frameworkcode );
4089 Add an item in a MARC record and save the MARC record
4091 Function exported, but should NOT be used, unless you really know what you're doing
4099 # pass the MARC::Record to this function, and it will create the records in the marc tables
4100 my ( $record, $biblionumber, $frameworkcode ) = @_;
4101 my $newrec = &GetMarcBiblio($biblionumber);
4104 my @fields = $record->fields();
4105 foreach my $field (@fields) {
4106 $newrec->append_fields($field);
4109 # FIXME: should we be making sure the biblionumbers are the same?
4110 my $newbiblionumber =
4111 &ModBiblioMarc( $newrec, $biblionumber, $frameworkcode );
4112 return $newbiblionumber;
4115 =head2 z3950_extended_services
4117 z3950_extended_services($serviceType,$serviceOptions,$record);
4119 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.
4121 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
4123 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
4125 action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
4129 recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
4130 syntax => the record syntax (transfer syntax)
4131 databaseName = Database from connection object
4133 To set serviceOptions, call set_service_options($serviceType)
4135 C<$record> the record, if one is needed for the service type
4137 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
4141 sub z3950_extended_services {
4142 my ( $server, $serviceType, $action, $serviceOptions ) = @_;
4144 # get our connection object
4145 my $Zconn = C4::Context->Zconn( $server, 0, 1 );
4147 # create a new package object
4148 my $Zpackage = $Zconn->package();
4151 $Zpackage->option( action => $action );
4153 if ( $serviceOptions->{'databaseName'} ) {
4154 $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
4156 if ( $serviceOptions->{'recordIdNumber'} ) {
4158 recordIdNumber => $serviceOptions->{'recordIdNumber'} );
4160 if ( $serviceOptions->{'recordIdOpaque'} ) {
4162 recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
4165 # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
4166 #if ($serviceType eq 'itemorder') {
4167 # $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
4168 # $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
4169 # $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
4170 # $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
4173 if ( $serviceOptions->{record} ) {
4174 $Zpackage->option( record => $serviceOptions->{record} );
4176 # can be xml or marc
4177 if ( $serviceOptions->{'syntax'} ) {
4178 $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
4182 # send the request, handle any exception encountered
4183 eval { $Zpackage->send($serviceType) };
4184 if ( $@ && $@->isa("ZOOM::Exception") ) {
4185 return "error: " . $@->code() . " " . $@->message() . "\n";
4188 # free up package resources
4189 $Zpackage->destroy();
4192 =head2 set_service_options
4194 my $serviceOptions = set_service_options($serviceType);
4196 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
4198 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
4202 sub set_service_options {
4203 my ($serviceType) = @_;
4206 # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
4207 # $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
4209 if ( $serviceType eq 'commit' ) {
4213 if ( $serviceType eq 'create' ) {
4217 if ( $serviceType eq 'drop' ) {
4218 die "ERROR: 'drop' not currently supported (by Zebra)";
4220 return $serviceOptions;
4223 =head2 GetItemsCount
4225 $count = &GetItemsCount( $biblionumber);
4226 this function return count of item with $biblionumber
4230 my ( $biblionumber ) = @_;
4231 my $dbh = C4::Context->dbh;
4232 my $query = "SELECT count(*)
4234 WHERE biblionumber=?";
4235 my $sth = $dbh->prepare($query);
4236 $sth->execute($biblionumber);
4237 my $count = $sth->fetchrow;
4242 END { } # module clean-up code here (global destructor)
4250 Koha Developement team <info@koha.org>
4252 Paul POULAIN paul.poulain@free.fr
4254 Joshua Ferraro jmf@liblime.com