3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
26 use MARC::File::USMARC;
30 use C4::Dates qw/format_date/;
31 use C4::Log; # logaction
34 use vars qw($VERSION @ISA @EXPORT);
39 @ISA = qw( Exporter );
43 # to add biblios or items
44 push @EXPORT, qw( &AddBiblio &AddItem );
52 &GetBiblioItemByBiblioNumber
53 &GetBiblioFromItemNumber
73 &GetItemsByBiblioitemnumber
74 &GetItemnumberFromBarcode
78 &GetAuthorisedValueDesc
82 &GetPublisherNameFromIsbn
94 &ModItemInMarconefield
105 # those functions are exported but should not be used
106 # they are usefull is few circumstances, so are exported.
107 # but don't use them unless you're a core developer ;-)
116 &TransformHtmlToMarc2
119 &PrepareItemrecordDisplay
126 C4::Biblio - cataloging management functions
130 Biblio.pm contains functions for managing storage and editing of bibliographic data within Koha. Most of the functions in this module are used for cataloging records: adding, editing, or removing biblios, biblioitems, or items. Koha's stores bibliographic information in three places:
134 =item 1. in the biblio,biblioitems,items, etc tables, which are limited to a one-to-one mapping to underlying MARC data
136 =item 2. as raw MARC in the Zebra index and storage engine
138 =item 3. as raw MARC the biblioitems.marc and biblioitems.marcxml
142 In the 3.0 version of Koha, the authoritative record-level information is in biblioitems.marcxml
144 Because the data isn't completely normalized there's a chance for information to get out of sync. The design choice to go with a un-normalized schema was driven by performance and stability concerns. However, if this occur, it can be considered as a bug : The API is (or should be) complete & the only entry point for all biblio/items managements.
148 =item 1. Compared with MySQL, Zebra is slow to update an index for small data changes -- especially for proc-intensive operations like circulation
150 =item 2. Zebra's index has been known to crash and a backup of the data is necessary to rebuild it in such cases
154 Because of this design choice, the process of managing storage and editing is a bit convoluted. Historically, Biblio.pm's grown to an unmanagable size and as a result we have several types of functions currently:
158 =item 1. Add*/Mod*/Del*/ - high-level external functions suitable for being called from external scripts to manage the collection
160 =item 2. _koha_* - low-level internal functions for managing the koha tables
162 =item 3. Marc management function : as the MARC record is stored in biblioitems.marc(xml), some subs dedicated to it's management are in this package. They should be used only internally by Biblio.pm, the only official entry points being AddBiblio, AddItem, ModBiblio, ModItem.
164 =item 4. Zebra functions used to update the Zebra index
166 =item 5. internal helper functions such as char_decode, checkitems, etc. Some of these probably belong in Koha.pm
170 The MARC record (in biblioitems.marcxml) contains the complete marc record, including items. It also contains the biblionumber. That is the reason why it is not stored directly by AddBiblio, with all other fields . To save a biblio, we need to :
174 =item 1. save datas in biblio and biblioitems table, that gives us a biblionumber and a biblioitemnumber
176 =item 2. add the biblionumber and biblioitemnumber into the MARC records
178 =item 3. save the marc record
182 When dealing with items, we must :
186 =item 1. save the item in items table, that gives us an itemnumber
188 =item 2. add the itemnumber to the item MARC field
190 =item 3. overwrite the MARC record (with the added item) into biblioitems.marc(xml)
192 When modifying a biblio or an item, the behaviour is quite similar.
196 =head1 EXPORTED FUNCTIONS
202 ($biblionumber,$biblioitemnumber) = AddBiblio($record,$frameworkcode);
203 Exported function (core API) for adding a new biblio to koha.
210 my ( $record, $frameworkcode ) = @_;
211 my ($biblionumber,$biblioitemnumber,$error);
212 my $dbh = C4::Context->dbh;
213 # transform the data into koha-table style data
214 my $olddata = TransformMarcToKoha( $dbh, $record, $frameworkcode );
215 ($biblionumber,$error) = _koha_add_biblio( $dbh, $olddata, $frameworkcode );
216 $olddata->{'biblionumber'} = $biblionumber;
217 ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $olddata );
219 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
222 $biblionumber = ModBiblioMarc( $record, $biblionumber, $frameworkcode );
224 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","ADD",$biblionumber,"biblio")
225 if C4::Context->preference("CataloguingLog");
227 return ( $biblionumber, $biblioitemnumber );
234 $biblionumber = AddItem( $record, $biblionumber)
235 Exported function (core API) for adding a new item to Koha
242 my ( $record, $biblionumber ) = @_;
243 my $dbh = C4::Context->dbh;
246 my $frameworkcode = GetFrameworkCode( $biblionumber );
247 my $item = &TransformMarcToKoha( $dbh, $record, $frameworkcode );
249 # needs old biblionumber and biblioitemnumber
250 $item->{'biblionumber'} = $biblionumber;
253 "SELECT biblioitemnumber,itemtype FROM biblioitems WHERE biblionumber=?"
255 $sth->execute( $item->{'biblionumber'} );
257 ( $item->{'biblioitemnumber'}, $itemtype ) = $sth->fetchrow;
260 "SELECT notforloan FROM itemtypes WHERE itemtype=?");
261 $sth->execute( C4::Context->preference('item-level_itypes') ? $item->{'itype'} : $itemtype );
262 my $notforloan = $sth->fetchrow;
263 ##Change the notforloan field if $notforloan found
264 if ( $notforloan > 0 ) {
265 $item->{'notforloan'} = $notforloan;
266 &MARCitemchange( $record, "items.notforloan", $notforloan );
268 if ( !$item->{'dateaccessioned'} || $item->{'dateaccessioned'} eq '' ) {
271 my ( $sec, $min, $hour, $mday, $mon, $year, $wday, $yday, $isdst ) =
276 "$year-" . sprintf( "%0.2d", $mon ) . "-" . sprintf( "%0.2d", $mday );
277 $item->{'dateaccessioned'} = $date;
278 &MARCitemchange( $record, "items.dateaccessioned", $date );
280 my ( $itemnumber, $error ) = &_koha_new_items( $dbh, $item, $item->{barcode} );
281 # add itemnumber to MARC::Record before adding the item.
282 $sth = $dbh->prepare(
283 "SELECT tagfield,tagsubfield
284 FROM marc_subfield_structure
285 WHERE frameworkcode=?
288 &TransformKohaToMarcOneField( $sth, $record, "items.itemnumber", $itemnumber,
292 &AddItemInMarc( $record, $item->{'biblionumber'},$frameworkcode );
294 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","ADD",$itemnumber,"item")
295 if C4::Context->preference("CataloguingLog");
297 return ($item->{biblionumber}, $item->{biblioitemnumber},$itemnumber);
302 ModBiblio( $record,$biblionumber,$frameworkcode);
303 Exported function (core API) to modify a biblio
308 my ( $record, $biblionumber, $frameworkcode ) = @_;
309 if (C4::Context->preference("CataloguingLog")) {
310 my $newrecord = GetMarcBiblio($biblionumber);
311 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","MODIFY",$biblionumber,"BEFORE=>".$newrecord->as_formatted);
314 my $dbh = C4::Context->dbh;
316 $frameworkcode = "" unless $frameworkcode;
318 # get the items before and append them to the biblio before updating the record, atm we just have the biblio
319 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
320 my $oldRecord = GetMarcBiblio( $biblionumber );
322 # parse each item, and, for an unknown reason, re-encode each subfield
323 # if you don't do that, the record will have encoding mixed
324 # and the biblio will be re-encoded.
325 # strange, I (Paul P.) searched more than 1 day to understand what happends
326 # but could only solve the problem this way...
327 my @fields = $oldRecord->field( $itemtag );
328 foreach my $fielditem ( @fields ){
330 foreach ($fielditem->subfields()) {
332 $field->add_subfields(Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
334 $field = MARC::Field->new("$itemtag",'','',Encode::encode('utf-8',$_->[0]) => Encode::encode('utf-8',$_->[1]));
337 $record->append_fields($field);
340 # update biblionumber and biblioitemnumber in MARC
341 # FIXME - this is assuming a 1 to 1 relationship between
342 # biblios and biblioitems
343 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
344 $sth->execute($biblionumber);
345 my ($biblioitemnumber) = $sth->fetchrow;
347 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
349 # update the MARC record (that now contains biblio and items) with the new record data
350 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
352 # load the koha-table data object
353 my $oldbiblio = TransformMarcToKoha( $dbh, $record, $frameworkcode );
355 # modify the other koha tables
356 _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
357 _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
365 Exported function (core API) for modifying an item in Koha.
372 my ( $record, $biblionumber, $itemnumber, $delete, $new_item_hashref )
376 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","MODIFY",$itemnumber,$record->as_formatted)
377 if C4::Context->preference("CataloguingLog");
379 my $dbh = C4::Context->dbh;
381 # if we have a MARC record, we're coming from cataloging and so
382 # we do the whole routine: update the MARC and zebra, then update the koha
385 my $frameworkcode = GetFrameworkCode( $biblionumber );
386 ModItemInMarc( $record, $biblionumber, $itemnumber, $frameworkcode );
387 my $olditem = TransformMarcToKoha( $dbh, $record, $frameworkcode,'items');
388 $olditem->{'biblionumber'} = $biblionumber;
389 my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
390 $sth->execute($biblionumber);
391 my ($biblioitemnumber) = $sth->fetchrow;
393 $olditem->{'biblioitemnumber'} = $biblioitemnumber;
394 _koha_modify_item( $dbh, $olditem );
395 return $biblionumber;
398 # otherwise, we're just looking to modify something quickly
399 # (like a status) so we just update the koha tables
400 elsif ($new_item_hashref) {
401 _koha_modify_item( $dbh, $new_item_hashref );
405 sub ModItemTransfer {
406 my ( $itemnumber, $frombranch, $tobranch ) = @_;
408 my $dbh = C4::Context->dbh;
410 #new entry in branchtransfers....
411 my $sth = $dbh->prepare(
412 "INSERT INTO branchtransfers (itemnumber, frombranch, datesent, tobranch)
413 VALUES (?, ?, NOW(), ?)");
414 $sth->execute($itemnumber, $frombranch, $tobranch);
415 #update holdingbranch in items .....
417 "UPDATE items SET holdingbranch = ? WHERE items.itemnumber = ?");
418 $sth->execute($tobranch,$itemnumber);
419 &ModDateLastSeen($itemnumber);
420 $sth = $dbh->prepare(
421 "SELECT biblionumber FROM items WHERE itemnumber=?"
423 $sth->execute($itemnumber);
424 while ( my ( $biblionumber ) = $sth->fetchrow ) {
425 &ModItemInMarconefield( $biblionumber, $itemnumber,
426 'items.holdingbranch', $tobranch );
431 =head2 ModBiblioframework
433 ModBiblioframework($biblionumber,$frameworkcode);
434 Exported function to modify a biblio framework
438 sub ModBiblioframework {
439 my ( $biblionumber, $frameworkcode ) = @_;
440 my $dbh = C4::Context->dbh;
441 my $sth = $dbh->prepare(
442 "UPDATE biblio SET frameworkcode=? WHERE biblionumber=?"
444 $sth->execute($frameworkcode, $biblionumber);
448 =head2 ModItemInMarconefield
452 modify only 1 field in a MARC item (mainly used for holdingbranch, but could also be used for status modif - moving a book to "lost" on a long overdu for example)
453 &ModItemInMarconefield( $biblionumber, $itemnumber, $itemfield, $newvalue )
459 sub ModItemInMarconefield {
460 my ( $biblionumber, $itemnumber, $itemfield, $newvalue ) = @_;
461 my $dbh = C4::Context->dbh;
462 if ( !defined $newvalue ) {
466 my $record = GetMarcItem( $biblionumber, $itemnumber );
467 my ($tagfield, $tagsubfield) = GetMarcFromKohaField( $itemfield,'');
468 # FIXME - the condition is done this way because GetMarcFromKohaField
469 # returns (0, 0) if it can't field a MARC tag for the kohafield. However,
470 # some fields like items.wthdrawn are mapped to subfield $0, making the
471 # customary test of "if ($tagfield && $tagsubfield)" incorrect.
472 # GetMarcFromKohaField should probably be returning (undef, undef), making
473 # the correct test "if (defined $tagfield && defined $tagsubfield)", but
474 # this would be a large change and consequently deferred for after 3.0.
475 if (not(int($tagfield) == 0 && int($tagsubfield) == 0)) {
476 my $tag = $record->field($tagfield);
478 # my $tagsubs = $record->field($tagfield)->subfield($tagsubfield);
479 $tag->update( $tagsubfield => $newvalue );
480 $record->delete_field($tag);
481 $record->insert_fields_ordered($tag);
482 my $frameworkcode = GetFrameworkCode( $biblionumber );
483 &ModItemInMarc( $record, $biblionumber, $itemnumber, $frameworkcode );
492 &ModItemInMarc( $record, $biblionumber, $itemnumber, $frameworkcode )
499 my ( $ItemRecord, $biblionumber, $itemnumber, $frameworkcode) = @_;
500 my $dbh = C4::Context->dbh;
502 # get complete MARC record & replace the item field by the new one
503 my $completeRecord = GetMarcBiblio($biblionumber);
504 my ($itemtag,$itemsubfield) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
505 my $itemField = $ItemRecord->field($itemtag);
506 my @items = $completeRecord->field($itemtag);
508 if ($_->subfield($itemsubfield) eq $itemnumber) {
509 # $completeRecord->delete_field($_);
510 $_->replace_with($itemField);
514 my $sth = $dbh->prepare("UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
515 $sth->execute( $completeRecord->as_usmarc(), $completeRecord->as_xml_record(),$biblionumber );
517 ModZebra($biblionumber,"specialUpdate","biblioserver",$completeRecord);
520 =head2 ModDateLastSeen
522 &ModDateLastSeen($itemnum)
523 Mark item as seen. Is called when an item is issued, returned or manually marked during inventory/stocktaking
524 C<$itemnum> is the item number
528 sub ModDateLastSeen {
530 my $dbh = C4::Context->dbh;
533 "UPDATE items SET itemlost=0,datelastseen = NOW() WHERE items.itemnumber = ?"
535 $sth->execute($itemnum);
542 my $error = &DelBiblio($dbh,$biblionumber);
543 Exported function (core API) for deleting a biblio in koha.
544 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
545 Also backs it up to deleted* tables
546 Checks to make sure there are not issues on any of the items
548 C<$error> : undef unless an error occurs
555 my ( $biblionumber ) = @_;
556 my $dbh = C4::Context->dbh;
557 my $error; # for error handling
559 # First make sure this biblio has no items attached
560 my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
561 $sth->execute($biblionumber);
562 if (my $itemnumber = $sth->fetchrow){
563 # Fix this to use a status the template can understand
564 $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
567 return $error if $error;
569 # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
570 # for at least 2 reasons :
571 # - we need to read the biblio if NoZebra is set (to remove it from the indexes
572 # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
573 # and we would have no way to remove it (except manually in zebra, but I bet it would be very hard to handle the problem)
574 ModZebra($biblionumber, "recordDelete", "biblioserver", undef);
576 # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
579 "SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
580 $sth->execute($biblionumber);
581 while ( my $biblioitemnumber = $sth->fetchrow ) {
583 # delete this biblioitem
584 $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
585 return $error if $error;
588 # delete biblio from Koha tables and save in deletedbiblio
589 # must do this *after* _koha_delete_biblioitems, otherwise
590 # delete cascade will prevent deletedbiblioitems rows
591 # from being generated by _koha_delete_biblioitems
592 $error = _koha_delete_biblio( $dbh, $biblionumber );
594 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","DELETE",$biblionumber,"")
595 if C4::Context->preference("CataloguingLog");
603 DelItem( $biblionumber, $itemnumber );
604 Exported function (core API) for deleting an item record in Koha.
611 my ( $dbh, $biblionumber, $itemnumber ) = @_;
613 # check the item has no current issues
616 &_koha_delete_item( $dbh, $itemnumber );
618 # get the MARC record
619 my $record = GetMarcBiblio($biblionumber);
620 my $frameworkcode = GetFrameworkCode($biblionumber);
623 my $copy2deleted = $dbh->prepare("UPDATE deleteditems SET marc=? WHERE itemnumber=?");
624 $copy2deleted->execute( $record->as_usmarc(), $itemnumber );
626 #search item field code
627 my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField("items.itemnumber",$frameworkcode);
628 my @fields = $record->field($itemtag);
630 # delete the item specified
631 foreach my $field (@fields) {
632 if ( $field->subfield($itemsubfield) eq $itemnumber ) {
633 $record->delete_field($field);
636 &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
637 &logaction(C4::Context->userenv->{'number'},"CATALOGUING","DELETE",$itemnumber,"item")
638 if C4::Context->preference("CataloguingLog");
645 $data = &GetBiblioData($biblionumber);
646 Returns information about the book with the given biblionumber.
647 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
648 the C<biblio> and C<biblioitems> tables in the
650 In addition, C<$data-E<gt>{subject}> is the list of the book's
651 subjects, separated by C<" , "> (space, comma, space).
652 If there are multiple biblioitems with the given biblionumber, only
653 the first one is considered.
661 my $dbh = C4::Context->dbh;
663 # my $query = C4::Context->preference('item-level_itypes') ?
664 # " SELECT * , biblioitems.notes AS bnotes, biblio.notes
666 # LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
667 # WHERE biblio.biblionumber = ?
668 # AND biblioitems.biblionumber = biblio.biblionumber
671 my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
673 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
674 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
675 WHERE biblio.biblionumber = ?
676 AND biblioitems.biblionumber = biblio.biblionumber ";
678 my $sth = $dbh->prepare($query);
679 $sth->execute($bibnum);
681 $data = $sth->fetchrow_hashref;
685 } # sub GetBiblioData
692 @results = &GetItemsInfo($biblionumber, $type);
694 Returns information about books with the given biblionumber.
696 C<$type> may be either C<intra> or anything else. If it is not set to
697 C<intra>, then the search will exclude lost, very overdue, and
700 C<&GetItemsInfo> returns a list of references-to-hash. Each element
701 contains a number of keys. Most of them are table items from the
702 C<biblio>, C<biblioitems>, C<items>, and C<itemtypes> tables in the
703 Koha database. Other keys include:
707 =item C<$data-E<gt>{branchname}>
709 The name (not the code) of the branch to which the book belongs.
711 =item C<$data-E<gt>{datelastseen}>
713 This is simply C<items.datelastseen>, except that while the date is
714 stored in YYYY-MM-DD format in the database, here it is converted to
715 DD/MM/YYYY format. A NULL date is returned as C<//>.
717 =item C<$data-E<gt>{datedue}>
719 =item C<$data-E<gt>{class}>
721 This is the concatenation of C<biblioitems.classification>, the book's
722 Dewey code, and C<biblioitems.subclass>.
724 =item C<$data-E<gt>{ocount}>
726 I think this is the number of copies of the book available.
728 =item C<$data-E<gt>{order}>
730 If this is set, it is set to C<One Order>.
739 my ( $biblionumber, $type ) = @_;
740 my $dbh = C4::Context->dbh;
741 my $query = "SELECT *,items.notforloan as itemnotforloan
743 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
744 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
745 $query .= (C4::Context->preference('item-level_itypes')) ?
746 " LEFT JOIN itemtypes on items.itype = itemtypes.itemtype "
747 : " LEFT JOIN itemtypes on biblioitems.itemtype = itemtypes.itemtype ";
748 $query .= "WHERE items.biblionumber = ? ORDER BY items.dateaccessioned desc" ;
749 my $sth = $dbh->prepare($query);
750 $sth->execute($biblionumber);
753 my ( $date_due, $count_reserves );
755 my $isth = $dbh->prepare(
756 "SELECT issues.*,borrowers.cardnumber,borrowers.surname,borrowers.firstname,borrowers.branchcode as bcode
757 FROM issues LEFT JOIN borrowers ON issues.borrowernumber=borrowers.borrowernumber
759 AND returndate IS NULL"
761 while ( my $data = $sth->fetchrow_hashref ) {
763 $isth->execute( $data->{'itemnumber'} );
764 if ( my $idata = $isth->fetchrow_hashref ) {
765 $data->{borrowernumber} = $idata->{borrowernumber};
766 $data->{cardnumber} = $idata->{cardnumber};
767 $data->{surname} = $idata->{surname};
768 $data->{firstname} = $idata->{firstname};
769 $datedue = format_date( $idata->{'date_due'} );
770 if (C4::Context->preference("IndependantBranches")){
771 my $userenv = C4::Context->userenv;
772 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
773 $data->{'NOTSAMEBRANCH'} = 1 if ($idata->{'bcode'} ne $userenv->{branch});
777 if ( $datedue eq '' ) {
778 #$datedue="Available";
779 my ( $restype, $reserves ) =
780 C4::Reserves::CheckReserves( $data->{'itemnumber'} );
783 $count_reserves = $restype;
788 #get branch information.....
789 my $bsth = $dbh->prepare(
790 "SELECT * FROM branches WHERE branchcode = ?
793 $bsth->execute( $data->{'holdingbranch'} );
794 if ( my $bdata = $bsth->fetchrow_hashref ) {
795 $data->{'branchname'} = $bdata->{'branchname'};
797 my $date = format_date( $data->{'datelastseen'} );
798 $data->{'datelastseen'} = $date;
799 $data->{'datedue'} = $datedue;
800 $data->{'count_reserves'} = $count_reserves;
802 # get notforloan complete status if applicable
803 my $sthnflstatus = $dbh->prepare(
804 'SELECT authorised_value
805 FROM marc_subfield_structure
806 WHERE kohafield="items.notforloan"
810 $sthnflstatus->execute;
811 my ($authorised_valuecode) = $sthnflstatus->fetchrow;
812 if ($authorised_valuecode) {
813 $sthnflstatus = $dbh->prepare(
814 "SELECT lib FROM authorised_values
816 AND authorised_value=?"
818 $sthnflstatus->execute( $authorised_valuecode,
819 $data->{itemnotforloan} );
820 my ($lib) = $sthnflstatus->fetchrow;
821 $data->{notforloan} = $lib;
824 # my stack procedures
825 my $stackstatus = $dbh->prepare(
826 'SELECT authorised_value
827 FROM marc_subfield_structure
828 WHERE kohafield="items.stack"
831 $stackstatus->execute;
833 ($authorised_valuecode) = $stackstatus->fetchrow;
834 if ($authorised_valuecode) {
835 $stackstatus = $dbh->prepare(
837 FROM authorised_values
839 AND authorised_value=?
842 $stackstatus->execute( $authorised_valuecode, $data->{stack} );
843 my ($lib) = $stackstatus->fetchrow;
844 $data->{stack} = $lib;
846 $results[$i] = $data;
858 $itemstatushash = &getitemstatus($fwkcode);
859 returns information about status.
860 Can be MARC dependant.
862 But basically could be can be loan or not
863 Create a status selector with the following code
865 =head3 in PERL SCRIPT
867 my $itemstatushash = getitemstatus;
869 foreach my $thisstatus (keys %$itemstatushash) {
870 my %row =(value => $thisstatus,
871 statusname => $itemstatushash->{$thisstatus}->{'statusname'},
873 push @itemstatusloop, \%row;
875 $template->param(statusloop=>\@itemstatusloop);
880 <select name="statusloop">
881 <option value="">Default</option>
882 <!-- TMPL_LOOP name="statusloop" -->
883 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="statusname" --></option>
891 # returns a reference to a hash of references to status...
894 my $dbh = C4::Context->dbh;
896 $fwk = '' unless ($fwk);
897 my ( $tag, $subfield ) =
898 GetMarcFromKohaField( "items.notforloan", $fwk );
899 if ( $tag and $subfield ) {
902 "SELECT authorised_value
903 FROM marc_subfield_structure
909 $sth->execute( $tag, $subfield, $fwk );
910 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
913 "SELECT authorised_value,lib
914 FROM authorised_values
919 $authvalsth->execute($authorisedvaluecat);
920 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
921 $itemstatus{$authorisedvalue} = $lib;
937 $itemstatus{"1"} = "Not For Loan";
941 =head2 getitemlocation
945 $itemlochash = &getitemlocation($fwk);
946 returns informations about location.
947 where fwk stands for an optional framework code.
948 Create a location selector with the following code
950 =head3 in PERL SCRIPT
952 my $itemlochash = getitemlocation;
954 foreach my $thisloc (keys %$itemlochash) {
955 my $selected = 1 if $thisbranch eq $branch;
956 my %row =(locval => $thisloc,
957 selected => $selected,
958 locname => $itemlochash->{$thisloc},
960 push @itemlocloop, \%row;
962 $template->param(itemlocationloop => \@itemlocloop);
966 <select name="location">
967 <option value="">Default</option>
968 <!-- TMPL_LOOP name="itemlocationloop" -->
969 <option value="<!-- TMPL_VAR name="locval" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="locname" --></option>
977 sub GetItemLocation {
979 # returns a reference to a hash of references to location...
982 my $dbh = C4::Context->dbh;
984 $fwk = '' unless ($fwk);
985 my ( $tag, $subfield ) =
986 GetMarcFromKohaField( "items.location", $fwk );
987 if ( $tag and $subfield ) {
990 "SELECT authorised_value
991 FROM marc_subfield_structure
996 $sth->execute( $tag, $subfield, $fwk );
997 if ( my ($authorisedvaluecat) = $sth->fetchrow ) {
1000 "SELECT authorised_value,lib
1001 FROM authorised_values
1005 $authvalsth->execute($authorisedvaluecat);
1006 while ( my ( $authorisedvalue, $lib ) = $authvalsth->fetchrow ) {
1007 $itemlocation{$authorisedvalue} = $lib;
1009 $authvalsth->finish;
1010 return \%itemlocation;
1023 $itemlocation{"1"} = "Not For Loan";
1024 return \%itemlocation;
1029 $items = GetLostItems($where,$orderby);
1031 This function get the items lost into C<$items>.
1036 C<$where> is a hashref. it containts a field of the items table as key
1037 and the value to match as value.
1038 C<$orderby> is a field of the items table.
1041 C<$items> is a reference to an array full of hasref which keys are items' table column.
1043 =item usage in the perl script:
1046 $where{barcode} = 0001548;
1047 my $items = GetLostItems( \%where, "homebranch" );
1048 $template->param(itemsloop => $items);
1055 # Getting input args.
1057 my $orderby = shift;
1058 my $dbh = C4::Context->dbh;
1063 WHERE itemlost IS NOT NULL
1066 foreach my $key (keys %$where) {
1067 $query .= " AND " . $key . " LIKE '%" . $where->{$key} . "%'";
1069 $query .= " ORDER BY ".$orderby if defined $orderby;
1071 my $sth = $dbh->prepare($query);
1074 while ( my $row = $sth->fetchrow_hashref ){
1080 =head2 GetItemsForInventory
1082 $itemlist = GetItemsForInventory($minlocation,$maxlocation,$datelastseen,$offset,$size)
1084 Retrieve a list of title/authors/barcode/callnumber, for biblio inventory.
1086 The sub returns a list of hashes, containing itemnumber, author, title, barcode & item callnumber.
1087 It is ordered by callnumber,title.
1089 The minlocation & maxlocation parameters are used to specify a range of item callnumbers
1090 the datelastseen can be used to specify that you want to see items not seen since a past date only.
1091 offset & size can be used to retrieve only a part of the whole listing (defaut behaviour)
1095 sub GetItemsForInventory {
1096 my ( $minlocation, $maxlocation,$location, $datelastseen, $branch, $offset, $size ) = @_;
1097 my $dbh = C4::Context->dbh;
1099 if ($datelastseen) {
1100 $datelastseen=format_date_in_iso($datelastseen);
1102 "SELECT itemnumber,barcode,itemcallnumber,title,author,biblio.biblionumber,datelastseen
1104 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1105 WHERE itemcallnumber>= ?
1106 AND itemcallnumber <=?
1107 AND (datelastseen< ? OR datelastseen IS NULL)";
1108 $query.= " AND items.location=".$dbh->quote($location) if $location;
1109 $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
1110 $query .= " ORDER BY itemcallnumber,title";
1111 $sth = $dbh->prepare($query);
1112 $sth->execute( $minlocation, $maxlocation, $datelastseen );
1116 SELECT itemnumber,barcode,itemcallnumber,biblio.biblionumber,title,author,datelastseen
1118 LEFT JOIN biblio ON items.biblionumber=biblio.biblionumber
1119 WHERE itemcallnumber>= ?
1120 AND itemcallnumber <=?";
1121 $query.= " AND items.location=".$dbh->quote($location) if $location;
1122 $query.= " AND items.homebranch=".$dbh->quote($branch) if $branch;
1123 $query .= " ORDER BY itemcallnumber,title";
1124 $sth = $dbh->prepare($query);
1125 $sth->execute( $minlocation, $maxlocation );
1128 while ( my $row = $sth->fetchrow_hashref ) {
1129 $offset-- if ($offset);
1130 $row->{datelastseen}=format_date($row->{datelastseen});
1131 if ( ( !$offset ) && $size ) {
1132 push @results, $row;
1139 =head2 &GetBiblioItemData
1143 $itemdata = &GetBiblioItemData($biblioitemnumber);
1145 Looks up the biblioitem with the given biblioitemnumber. Returns a
1146 reference-to-hash. The keys are the fields from the C<biblio>,
1147 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
1148 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
1155 sub GetBiblioItemData {
1156 my ($biblioitemnumber) = @_;
1157 my $dbh = C4::Context->dbh;
1158 my $query = "SELECT *,biblioitems.notes AS bnotes
1159 FROM biblio, biblioitems ";
1160 unless(C4::Context->preference('item-level_itypes')) {
1161 $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
1163 $query .= " WHERE biblio.biblionumber = biblioitems.biblionumber
1164 AND biblioitemnumber = ? ";
1165 my $sth = $dbh->prepare($query);
1167 $sth->execute($biblioitemnumber);
1168 $data = $sth->fetchrow_hashref;
1171 } # sub &GetBiblioItemData
1173 =head2 GetItemnumberFromBarcode
1177 $result = GetItemnumberFromBarcode($barcode);
1183 sub GetItemnumberFromBarcode {
1185 my $dbh = C4::Context->dbh;
1188 $dbh->prepare("SELECT itemnumber FROM items WHERE items.barcode=?");
1189 $rq->execute($barcode);
1190 my ($result) = $rq->fetchrow;
1194 =head2 GetBiblioItemByBiblioNumber
1198 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
1204 sub GetBiblioItemByBiblioNumber {
1205 my ($biblionumber) = @_;
1206 my $dbh = C4::Context->dbh;
1207 my $sth = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
1211 $sth->execute($biblionumber);
1213 while ( my $data = $sth->fetchrow_hashref ) {
1214 push @results, $data;
1221 =head2 GetBiblioFromItemNumber
1225 $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
1227 Looks up the item with the given itemnumber. if undef, try the barcode.
1229 C<&itemnodata> returns a reference-to-hash whose keys are the fields
1230 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
1238 sub GetBiblioFromItemNumber {
1239 my ( $itemnumber, $barcode ) = @_;
1240 my $dbh = C4::Context->dbh;
1243 $sth=$dbh->prepare( "SELECT * FROM items
1244 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1245 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1246 WHERE items.itemnumber = ?") ;
1247 $sth->execute($itemnumber);
1249 $sth=$dbh->prepare( "SELECT * FROM items
1250 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1251 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
1252 WHERE items.barcode = ?") ;
1253 $sth->execute($barcode);
1255 my $data = $sth->fetchrow_hashref;
1264 ( $count, @results ) = &GetBiblio($biblionumber);
1271 my ($biblionumber) = @_;
1272 my $dbh = C4::Context->dbh;
1273 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
1276 $sth->execute($biblionumber);
1277 while ( my $data = $sth->fetchrow_hashref ) {
1278 $results[$count] = $data;
1282 return ( $count, @results );
1289 $data = &GetItem($itemnumber,$barcode);
1291 return Item information, for a given itemnumber or barcode
1298 my ($itemnumber,$barcode) = @_;
1299 my $dbh = C4::Context->dbh;
1301 my $sth = $dbh->prepare("
1303 WHERE itemnumber = ?");
1304 $sth->execute($itemnumber);
1305 my $data = $sth->fetchrow_hashref;
1308 my $sth = $dbh->prepare("
1312 $sth->execute($barcode);
1313 my $data = $sth->fetchrow_hashref;
1318 =head2 get_itemnumbers_of
1322 my @itemnumbers_of = get_itemnumbers_of(@biblionumbers);
1324 Given a list of biblionumbers, return the list of corresponding itemnumbers
1325 for each biblionumber.
1327 Return a reference on a hash where keys are biblionumbers and values are
1328 references on array of itemnumbers.
1334 sub get_itemnumbers_of {
1335 my @biblionumbers = @_;
1337 my $dbh = C4::Context->dbh;
1343 WHERE biblionumber IN (?' . ( ',?' x scalar @biblionumbers - 1 ) . ')
1345 my $sth = $dbh->prepare($query);
1346 $sth->execute(@biblionumbers);
1350 while ( my ( $itemnumber, $biblionumber ) = $sth->fetchrow_array ) {
1351 push @{ $itemnumbers_of{$biblionumber} }, $itemnumber;
1354 return \%itemnumbers_of;
1357 =head2 GetItemInfosOf
1361 GetItemInfosOf(@itemnumbers);
1367 sub GetItemInfosOf {
1368 my @itemnumbers = @_;
1373 WHERE itemnumber IN (' . join( ',', @itemnumbers ) . ')
1375 return get_infos_of( $query, 'itemnumber' );
1378 =head2 GetItemsByBiblioitemnumber
1382 GetItemsByBiblioitemnumber($biblioitemnumber);
1384 Returns an arrayref of hashrefs suitable for use in a TMPL_LOOP
1385 Called by moredetail.pl
1391 sub GetItemsByBiblioitemnumber {
1392 my ( $bibitem ) = @_;
1393 my $dbh = C4::Context->dbh;
1394 my $sth = $dbh->prepare("SELECT * FROM items WHERE items.biblioitemnumber = ?") || die $dbh->errstr;
1395 # Get all items attached to a biblioitem
1398 $sth->execute($bibitem) || die $sth->errstr;
1399 while ( my $data = $sth->fetchrow_hashref ) {
1400 # Foreach item, get circulation information
1401 my $sth2 = $dbh->prepare( "SELECT * FROM issues,borrowers
1402 WHERE itemnumber = ?
1403 AND returndate is NULL
1404 AND issues.borrowernumber = borrowers.borrowernumber"
1406 $sth2->execute( $data->{'itemnumber'} );
1407 if ( my $data2 = $sth2->fetchrow_hashref ) {
1408 # if item is out, set the due date and who it is out too
1409 $data->{'date_due'} = $data2->{'date_due'};
1410 $data->{'cardnumber'} = $data2->{'cardnumber'};
1411 $data->{'borrowernumber'} = $data2->{'borrowernumber'};
1414 # set date_due to blank, so in the template we check itemlost, and wthdrawn
1415 $data->{'date_due'} = '';
1418 # Find the last 3 people who borrowed this item.
1419 my $query2 = "SELECT * FROM issues, borrowers WHERE itemnumber = ?
1420 AND issues.borrowernumber = borrowers.borrowernumber
1421 AND returndate is not NULL
1422 ORDER BY returndate desc,timestamp desc LIMIT 3";
1423 $sth2 = $dbh->prepare($query2) || die $dbh->errstr;
1424 $sth2->execute( $data->{'itemnumber'} ) || die $sth2->errstr;
1426 while ( my $data2 = $sth2->fetchrow_hashref ) {
1427 $data->{"timestamp$i2"} = $data2->{'timestamp'};
1428 $data->{"card$i2"} = $data2->{'cardnumber'};
1429 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
1433 push(@results,$data);
1440 =head2 GetBiblioItemInfosOf
1444 GetBiblioItemInfosOf(@biblioitemnumbers);
1450 sub GetBiblioItemInfosOf {
1451 my @biblioitemnumbers = @_;
1454 SELECT biblioitemnumber,
1458 WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
1460 return get_infos_of( $query, 'biblioitemnumber' );
1463 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
1465 =head2 GetMarcStructure
1469 $res = GetMarcStructure($forlibrarian,$frameworkcode);
1471 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
1472 $forlibrarian :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
1473 $frameworkcode : the framework code to read
1479 sub GetMarcStructure {
1480 my ( $forlibrarian, $frameworkcode ) = @_;
1481 my $dbh=C4::Context->dbh;
1482 $frameworkcode = "" unless $frameworkcode;
1484 my $libfield = ( $forlibrarian eq 1 ) ? 'liblibrarian' : 'libopac';
1486 # check that framework exists
1489 "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
1490 $sth->execute($frameworkcode);
1491 my ($total) = $sth->fetchrow;
1492 $frameworkcode = "" unless ( $total > 0 );
1495 "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable
1496 FROM marc_tag_structure
1497 WHERE frameworkcode=?
1500 $sth->execute($frameworkcode);
1501 my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
1503 while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) =
1506 $res->{$tag}->{lib} =
1507 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
1508 $res->{$tab}->{tab} = "";
1509 $res->{$tag}->{mandatory} = $mandatory;
1510 $res->{$tag}->{repeatable} = $repeatable;
1515 "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue
1516 FROM marc_subfield_structure
1517 WHERE frameworkcode=?
1518 ORDER BY tagfield,tagsubfield
1522 $sth->execute($frameworkcode);
1525 my $authorised_value;
1537 $tag, $subfield, $liblibrarian,
1539 $mandatory, $repeatable, $authorised_value,
1540 $authtypecode, $value_builder, $kohafield,
1541 $seealso, $hidden, $isurl,
1547 $res->{$tag}->{$subfield}->{lib} =
1548 ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
1549 $res->{$tag}->{$subfield}->{tab} = $tab;
1550 $res->{$tag}->{$subfield}->{mandatory} = $mandatory;
1551 $res->{$tag}->{$subfield}->{repeatable} = $repeatable;
1552 $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
1553 $res->{$tag}->{$subfield}->{authtypecode} = $authtypecode;
1554 $res->{$tag}->{$subfield}->{value_builder} = $value_builder;
1555 $res->{$tag}->{$subfield}->{kohafield} = $kohafield;
1556 $res->{$tag}->{$subfield}->{seealso} = $seealso;
1557 $res->{$tag}->{$subfield}->{hidden} = $hidden;
1558 $res->{$tag}->{$subfield}->{isurl} = $isurl;
1559 $res->{$tag}->{$subfield}->{'link'} = $link;
1560 $res->{$tag}->{$subfield}->{defaultvalue} = $defaultvalue;
1565 =head2 GetUsedMarcStructure
1567 the same function as GetMarcStructure expcet it just take field
1568 in tab 0-9. (used field)
1570 my $results = GetUsedMarcStructure($frameworkcode);
1572 L<$results> is a ref to an array which each case containts a ref
1573 to a hash which each keys is the columns from marc_subfield_structure
1575 L<$frameworkcode> is the framework code.
1579 sub GetUsedMarcStructure($){
1580 my $frameworkcode = shift || '';
1581 my $dbh = C4::Context->dbh;
1584 FROM marc_subfield_structure
1586 AND frameworkcode = ?
1589 my $sth = $dbh->prepare($query);
1590 $sth->execute($frameworkcode);
1591 while (my $row = $sth->fetchrow_hashref){
1597 =head2 GetMarcFromKohaField
1601 ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
1602 Returns the MARC fields & subfields mapped to the koha field
1603 for the given frameworkcode
1609 sub GetMarcFromKohaField {
1610 my ( $kohafield, $frameworkcode ) = @_;
1611 return 0, 0 unless $kohafield;
1612 my $relations = C4::Context->marcfromkohafield;
1614 $relations->{$frameworkcode}->{$kohafield}->[0],
1615 $relations->{$frameworkcode}->{$kohafield}->[1]
1619 =head2 GetMarcBiblio
1623 Returns MARC::Record of the biblionumber passed in parameter.
1624 the marc record contains both biblio & item datas
1631 my $biblionumber = shift;
1632 my $dbh = C4::Context->dbh;
1634 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
1635 $sth->execute($biblionumber);
1636 my ($marcxml) = $sth->fetchrow;
1637 MARC::File::XML->default_record_format(C4::Context->preference('marcflavour'));
1638 $marcxml =~ s/\x1e//g;
1639 $marcxml =~ s/\x1f//g;
1640 $marcxml =~ s/\x1d//g;
1641 $marcxml =~ s/\x0f//g;
1642 $marcxml =~ s/\x0c//g;
1644 my $record = MARC::Record->new();
1646 $record = eval {MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour'))};
1648 # $record = MARC::Record::new_from_usmarc( $marc) if $marc;
1659 my $marcxml = GetXmlBiblio($biblionumber);
1661 Returns biblioitems.marcxml of the biblionumber passed in parameter.
1662 The XML contains both biblio & item datas
1669 my ( $biblionumber ) = @_;
1670 my $dbh = C4::Context->dbh;
1672 $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
1673 $sth->execute($biblionumber);
1674 my ($marcxml) = $sth->fetchrow;
1678 =head2 GetAuthorisedValueDesc
1682 my $subfieldvalue =get_authorised_value_desc(
1683 $tag, $subf[$i][0],$subf[$i][1], '', $taglib);
1684 Retrieve the complete description for a given authorised value.
1690 sub GetAuthorisedValueDesc {
1691 my ( $tag, $subfield, $value, $framework, $tagslib ) = @_;
1692 my $dbh = C4::Context->dbh;
1695 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
1696 return C4::Branch::GetBranchName($value);
1700 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
1701 return getitemtypeinfo($value)->{description};
1704 #---- "true" authorized value
1705 my $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'};
1706 if ( $category ne "" ) {
1709 "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
1711 $sth->execute( $category, $value );
1712 my $data = $sth->fetchrow_hashref;
1713 return $data->{'lib'};
1716 return $value; # if nothing is found return the original value
1724 Returns MARC::Record of the item passed in parameter.
1731 my ( $biblionumber, $itemnumber ) = @_;
1732 my $dbh = C4::Context->dbh;
1733 my $newrecord = MARC::Record->new();
1734 my $marcflavour = C4::Context->preference('marcflavour');
1736 my $marcxml = GetXmlBiblio($biblionumber);
1737 my $record = MARC::Record->new();
1738 $record = MARC::Record::new_from_xml( $marcxml, "utf8", $marcflavour );
1739 # now, find where the itemnumber is stored & extract only the item
1740 my ( $itemnumberfield, $itemnumbersubfield ) =
1741 GetMarcFromKohaField( 'items.itemnumber', '' );
1742 my @fields = $record->field($itemnumberfield);
1743 foreach my $field (@fields) {
1744 if ( $field->subfield($itemnumbersubfield) eq $itemnumber ) {
1745 $newrecord->insert_fields_ordered($field);
1757 $marcnotesarray = GetMarcNotes( $record, $marcflavour );
1758 Get all notes from the MARC record and returns them in an array.
1759 The note are stored in differents places depending on MARC flavour
1766 my ( $record, $marcflavour ) = @_;
1768 if ( $marcflavour eq "MARC21" ) {
1771 else { # assume unimarc if not marc21
1778 foreach my $field ( $record->field($scope) ) {
1779 my $value = $field->as_string();
1780 if ( $note ne "" ) {
1781 $marcnote = { marcnote => $note, };
1782 push @marcnotes, $marcnote;
1785 if ( $note ne $value ) {
1786 $note = $note . " " . $value;
1791 $marcnote = { marcnote => $note };
1792 push @marcnotes, $marcnote; #load last tag into array
1795 } # end GetMarcNotes
1797 =head2 GetMarcSubjects
1801 $marcsubjcts = GetMarcSubjects($record,$marcflavour);
1802 Get all subjects from the MARC record and returns them in an array.
1803 The subjects are stored in differents places depending on MARC flavour
1809 sub GetMarcSubjects {
1810 my ( $record, $marcflavour ) = @_;
1811 my ( $mintag, $maxtag );
1812 if ( $marcflavour eq "MARC21" ) {
1816 else { # assume unimarc if not marc21
1826 foreach my $field ( $record->field('6..' )) {
1827 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1829 my @subfields = $field->subfields();
1832 # if there is an authority link, build the link with an= subfield9
1833 my $subfield9 = $field->subfield('9');
1834 for my $subject_subfield (@subfields ) {
1835 # don't load unimarc subfields 3,4,5
1836 next if (($marcflavour eq "UNIMARC") and ($subject_subfield->[0] =~ (3|4|5) ) );
1837 my $code = $subject_subfield->[0];
1838 my $value = $subject_subfield->[1];
1839 my $linkvalue = $value;
1840 $linkvalue =~ s/(\(|\))//g;
1841 my $operator = " and " unless $counter==0;
1843 @link_loop = ({'limit' => 'an' ,link => "$subfield9" });
1845 push @link_loop, {'limit' => 'su', link => $linkvalue, operator => $operator };
1847 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
1849 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator} unless ($subject_subfield->[0] == 9 );
1850 # this needs to be added back in in a way that the template can expose it properly
1851 #if ( $code == 9 ) {
1852 # $link = "an:".$subject_subfield->[1];
1858 push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1861 return \@marcsubjects;
1862 } #end getMARCsubjects
1864 =head2 GetMarcAuthors
1868 authors = GetMarcAuthors($record,$marcflavour);
1869 Get all authors from the MARC record and returns them in an array.
1870 The authors are stored in differents places depending on MARC flavour
1876 sub GetMarcAuthors {
1877 my ( $record, $marcflavour ) = @_;
1878 my ( $mintag, $maxtag );
1879 # tagslib useful for UNIMARC author reponsabilities
1880 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.
1881 if ( $marcflavour eq "MARC21" ) {
1885 elsif ( $marcflavour eq "UNIMARC" ) { # assume unimarc if not marc21
1894 foreach my $field ( $record->fields ) {
1895 next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1897 my @subfields = $field->subfields();
1899 for my $authors_subfield (@subfields) {
1900 #unimarc-specific line
1901 next if ($marcflavour eq 'UNIMARC' and (($authors_subfield->[0] eq '3') or ($authors_subfield->[0] eq '5')));
1902 my $subfieldcode = $authors_subfield->[0];
1904 # deal with UNIMARC author responsibility
1905 if ( $marcflavour eq 'UNIMARC' and ($authors_subfield->[0] eq '4')) {
1906 $value = "(".GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ).")";
1908 $value = $authors_subfield->[1];
1910 $hash{tag} = $field->tag;
1911 $hash{value} .= $value . " " if ($subfieldcode != 9) ;
1912 $hash{link} .= $value if ($subfieldcode eq 9);
1914 push @marcauthors, \%hash;
1916 return \@marcauthors;
1923 $marcurls = GetMarcUrls($record,$marcflavour);
1924 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1925 Assumes web resources (not uncommon in MARC21 to omit resource type ind)
1932 my ($record, $marcflavour) = @_;
1935 for my $field ($record->field('856')) {
1936 my $url = $field->subfield('u');
1938 for my $note ( $field->subfield('z')) {
1939 push @notes , {note => $note};
1941 $marcurl = { MARCURL => $url,
1944 if($marcflavour eq 'MARC21') {
1945 my $s3 = $field->subfield('3');
1946 my $link = $field->subfield('y');
1947 $marcurl->{'linktext'} = $link || $s3 || $url ;;
1948 $marcurl->{'part'} = $s3 if($link);
1949 $marcurl->{'toc'} = 1 if($s3 =~ /^[Tt]able/) ;
1951 $marcurl->{'linktext'} = $url;
1953 push @marcurls, $marcurl;
1958 =head2 GetMarcSeries
1962 $marcseriesarray = GetMarcSeries($record,$marcflavour);
1963 Get all series from the MARC record and returns them in an array.
1964 The series are stored in differents places depending on MARC flavour
1971 my ($record, $marcflavour) = @_;
1972 my ($mintag, $maxtag);
1973 if ($marcflavour eq "MARC21") {
1976 } else { # assume unimarc if not marc21
1986 foreach my $field ($record->field('440'), $record->field('490')) {
1988 #my $value = $field->subfield('a');
1989 #$marcsubjct = {MARCSUBJCT => $value,};
1990 my @subfields = $field->subfields();
1991 #warn "subfields:".join " ", @$subfields;
1994 for my $series_subfield (@subfields) {
1996 undef $volume_number;
1997 # see if this is an instance of a volume
1998 if ($series_subfield->[0] eq 'v') {
2002 my $code = $series_subfield->[0];
2003 my $value = $series_subfield->[1];
2004 my $linkvalue = $value;
2005 $linkvalue =~ s/(\(|\))//g;
2006 my $operator = " and " unless $counter==0;
2007 push @link_loop, {link => $linkvalue, operator => $operator };
2008 my $separator = C4::Context->preference("authoritysep") unless $counter==0;
2009 if ($volume_number) {
2010 push @subfields_loop, {volumenum => $value};
2013 push @subfields_loop, {code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number};
2017 push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
2018 #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
2019 #push @marcsubjcts, $marcsubjct;
2023 my $marcseriessarray=\@marcseries;
2024 return $marcseriessarray;
2025 } #end getMARCseriess
2027 =head2 GetFrameworkCode
2031 $frameworkcode = GetFrameworkCode( $biblionumber )
2037 sub GetFrameworkCode {
2038 my ( $biblionumber ) = @_;
2039 my $dbh = C4::Context->dbh;
2040 my $sth = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
2041 $sth->execute($biblionumber);
2042 my ($frameworkcode) = $sth->fetchrow;
2043 return $frameworkcode;
2046 =head2 GetPublisherNameFromIsbn
2048 $name = GetPublishercodeFromIsbn($isbn);
2055 sub GetPublisherNameFromIsbn($){
2057 $isbn =~ s/[- _]//g;
2059 my @codes = (split '-', DisplayISBN($isbn));
2060 my $code = $codes[0].$codes[1].$codes[2];
2061 my $dbh = C4::Context->dbh;
2063 SELECT distinct publishercode
2066 AND publishercode IS NOT NULL
2069 my $sth = $dbh->prepare($query);
2070 $sth->execute("$code%");
2071 my $name = $sth->fetchrow;
2072 return $name if length $name;
2076 =head2 TransformKohaToMarc
2080 $record = TransformKohaToMarc( $hash )
2081 This function builds partial MARC::Record from a hash
2082 Hash entries can be from biblio or biblioitems.
2083 This function is called in acquisition module, to create a basic catalogue entry from user entry
2089 sub TransformKohaToMarc {
2092 my $dbh = C4::Context->dbh;
2095 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
2097 my $record = MARC::Record->new();
2098 foreach (keys %{$hash}) {
2099 &TransformKohaToMarcOneField( $sth, $record, $_,
2105 =head2 TransformKohaToMarcOneField
2109 $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
2115 sub TransformKohaToMarcOneField {
2116 my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
2117 $frameworkcode='' unless $frameworkcode;
2121 if ( !defined $sth ) {
2122 my $dbh = C4::Context->dbh;
2123 $sth = $dbh->prepare(
2124 "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?"
2127 $sth->execute( $frameworkcode, $kohafieldname );
2128 if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
2129 my $tag = $record->field($tagfield);
2131 $tag->update( $tagsubfield => $value );
2132 $record->delete_field($tag);
2133 $record->insert_fields_ordered($tag);
2136 $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
2142 =head2 TransformHtmlToXml
2146 $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type )
2148 $auth_type contains :
2149 - nothing : rebuild a biblio, un UNIMARC the encoding is in 100$a pos 26/27
2150 - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
2151 - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
2157 sub TransformHtmlToXml {
2158 my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
2159 my $xml = MARC::File::XML::header('UTF-8');
2160 $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
2161 MARC::File::XML->default_record_format($auth_type);
2162 # in UNIMARC, field 100 contains the encoding
2163 # check that there is one, otherwise the
2164 # MARC::Record->new_from_xml will fail (and Koha will die)
2165 my $unimarc_and_100_exist=0;
2166 $unimarc_and_100_exist=1 if $auth_type eq 'ITEM'; # if we rebuild an item, no need of a 100 field
2171 for ( my $i = 0 ; $i <= @$tags ; $i++ ) {
2172 if (C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a") {
2173 # if we have a 100 field and it's values are not correct, skip them.
2174 # if we don't have any valid 100 field, we will create a default one at the end
2175 my $enc = substr( @$values[$i], 26, 2 );
2176 if ($enc eq '01' or $enc eq '50' or $enc eq '03') {
2177 $unimarc_and_100_exist=1;
2182 @$values[$i] =~ s/&/&/g;
2183 @$values[$i] =~ s/</</g;
2184 @$values[$i] =~ s/>/>/g;
2185 @$values[$i] =~ s/"/"/g;
2186 @$values[$i] =~ s/'/'/g;
2187 # if ( !utf8::is_utf8( @$values[$i] ) ) {
2188 # utf8::decode( @$values[$i] );
2190 if ( ( @$tags[$i] ne $prevtag ) ) {
2191 $j++ unless ( @$tags[$i] eq "" );
2193 $xml .= "</datafield>\n";
2194 if ( ( @$tags[$i] && @$tags[$i] > 10 )
2195 && ( @$values[$i] ne "" ) )
2197 my $ind1 = substr( @$indicator[$j], 0, 1 );
2199 if ( @$indicator[$j] ) {
2200 $ind2 = substr( @$indicator[$j], 1, 1 );
2203 warn "Indicator in @$tags[$i] is empty";
2207 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2209 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2217 if ( @$values[$i] ne "" ) {
2220 if ( @$tags[$i] eq "000" ) {
2221 $xml .= "<leader>@$values[$i]</leader>\n";
2224 # rest of the fixed fields
2226 elsif ( @$tags[$i] < 10 ) {
2228 "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
2232 my $ind1 = substr( @$indicator[$j], 0, 1 );
2233 my $ind2 = substr( @$indicator[$j], 1, 1 );
2235 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2237 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2243 else { # @$tags[$i] eq $prevtag
2244 if ( @$values[$i] eq "" ) {
2248 my $ind1 = substr( @$indicator[$j], 0, 1 );
2249 my $ind2 = substr( @$indicator[$j], 1, 1 );
2251 "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
2255 "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
2258 $prevtag = @$tags[$i];
2260 if (C4::Context->preference('marcflavour') and !$unimarc_and_100_exist) {
2261 # warn "SETTING 100 for $auth_type";
2262 use POSIX qw(strftime);
2263 my $string = strftime( "%Y%m%d", localtime(time) );
2264 # set 50 to position 26 is biblios, 13 if authorities
2266 $pos=13 if $auth_type eq 'UNIMARCAUTH';
2267 $string = sprintf( "%-*s", 35, $string );
2268 substr( $string, $pos , 6, "50" );
2269 $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
2270 $xml .= "<subfield code=\"a\">$string</subfield>\n";
2271 $xml .= "</datafield>\n";
2273 $xml .= MARC::File::XML::footer();
2277 =head2 TransformHtmlToMarc
2279 L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
2280 L<$params> is a ref to an array as below:
2282 'tag_010_indicator_531951' ,
2283 'tag_010_code_a_531951_145735' ,
2284 'tag_010_subfield_a_531951_145735' ,
2285 'tag_200_indicator_873510' ,
2286 'tag_200_code_a_873510_673465' ,
2287 'tag_200_subfield_a_873510_673465' ,
2288 'tag_200_code_b_873510_704318' ,
2289 'tag_200_subfield_b_873510_704318' ,
2290 'tag_200_code_e_873510_280822' ,
2291 'tag_200_subfield_e_873510_280822' ,
2292 'tag_200_code_f_873510_110730' ,
2293 'tag_200_subfield_f_873510_110730' ,
2295 L<$cgi> is the CGI object which containts the value.
2296 L<$record> is the MARC::Record object.
2300 sub TransformHtmlToMarc {
2304 # creating a new record
2305 my $record = MARC::Record->new();
2308 while ($params->[$i]){ # browse all CGI params
2309 my $param = $params->[$i];
2311 # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
2312 if ($param eq 'biblionumber') {
2313 my ( $biblionumbertagfield, $biblionumbertagsubfield ) =
2314 &GetMarcFromKohaField( "biblio.biblionumber", '' );
2315 if ($biblionumbertagfield < 10) {
2316 $newfield = MARC::Field->new(
2317 $biblionumbertagfield,
2318 $cgi->param($param),
2321 $newfield = MARC::Field->new(
2322 $biblionumbertagfield,
2325 "$biblionumbertagsubfield" => $cgi->param($param),
2328 push @fields,$newfield if($newfield);
2330 elsif ($param =~ /^tag_(\d*)_indicator_/){ # new field start when having 'input name="..._indicator_..."
2333 my $ind1 = substr($cgi->param($param),0,1);
2334 my $ind2 = substr($cgi->param($param),1,1);
2338 if($tag < 10){ # no code for theses fields
2339 # in MARC editor, 000 contains the leader.
2340 if ($tag eq '000' ) {
2341 $record->leader($cgi->param($params->[$j+1])) if length($cgi->param($params->[$j+1]))==24;
2342 # between 001 and 009 (included)
2344 $newfield = MARC::Field->new(
2346 $cgi->param($params->[$j+1]),
2349 # > 009, deal with subfields
2351 while($params->[$j] =~ /_code_/){ # browse all it's subfield
2352 my $inner_param = $params->[$j];
2354 if($cgi->param($params->[$j+1])){ # only if there is a value (code => value)
2355 $newfield->add_subfields(
2356 $cgi->param($inner_param) => $cgi->param($params->[$j+1])
2360 if ( $cgi->param($params->[$j+1]) ) { # creating only if there is a value (code => value)
2361 $newfield = MARC::Field->new(
2365 $cgi->param($inner_param) => $cgi->param($params->[$j+1]),
2372 push @fields,$newfield if($newfield);
2377 $record->append_fields(@fields);
2381 =head2 TransformMarcToKoha
2385 $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
2391 sub TransformMarcToKoha {
2392 my ( $dbh, $record, $frameworkcode, $table ) = @_;
2396 # sometimes we only want to return the items data
2397 if ($table eq 'items') {
2398 my $sth = $dbh->prepare("SHOW COLUMNS FROM items");
2400 while ( (my $field) = $sth->fetchrow ) {
2401 my $value = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2402 my $key = _disambiguate($table, $field);
2403 if ($result->{$key}) {
2404 $result->{$key} .= " | " . $value;
2406 $result->{$key} = $value;
2411 my @tables = ('biblio','biblioitems','items');
2412 foreach my $table (@tables){
2413 my $sth2 = $dbh->prepare("SHOW COLUMNS from $table");
2415 while (my ($field) = $sth2->fetchrow){
2416 # FIXME use of _disambiguate is a temporary hack
2417 # $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2418 my $value = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2419 my $key = _disambiguate($table, $field);
2420 if ($result->{$key}) {
2421 # FIXME - hack to not bring in duplicates of the same value
2422 unless (($key eq "biblionumber" or $key eq "biblioitemnumber") and ($value eq "")) {
2423 $result->{$key} .= " | " . $value;
2426 $result->{$key} = $value;
2431 # modify copyrightdate to keep only the 1st year found
2432 my $temp = $result->{'copyrightdate'};
2433 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
2435 $result->{'copyrightdate'} = $1;
2437 else { # if no cYYYY, get the 1st date.
2438 $temp =~ m/(\d\d\d\d)/;
2439 $result->{'copyrightdate'} = $1;
2442 # modify publicationyear to keep only the 1st year found
2443 $temp = $result->{'publicationyear'};
2444 $temp =~ m/c(\d\d\d\d)/; # search cYYYY first
2446 $result->{'publicationyear'} = $1;
2448 else { # if no cYYYY, get the 1st date.
2449 $temp =~ m/(\d\d\d\d)/;
2450 $result->{'publicationyear'} = $1;
2457 =head2 _disambiguate
2461 $newkey = _disambiguate($table, $field);
2463 This is a temporary hack to distinguish between the
2464 following sets of columns when using TransformMarcToKoha.
2466 items.cn_source & biblioitems.cn_source
2467 items.cn_sort & biblioitems.cn_sort
2469 Columns that are currently NOT distinguished (FIXME
2470 due to lack of time to fully test) are:
2472 biblio.notes and biblioitems.notes
2477 FIXME - this is necessary because prefixing each column
2478 name with the table name would require changing lots
2479 of code and templates, and exposing more of the DB
2480 structure than is good to the UI templates, particularly
2481 since biblio and bibloitems may well merge in a future
2482 version. In the future, it would also be good to
2483 separate DB access and UI presentation field names
2491 my ($table, $column) = @_;
2492 if ($column eq "cn_sort" or $column eq "cn_source") {
2493 return $table . '.' . $column;
2500 =head2 get_koha_field_from_marc
2504 $result->{_disambiguate($table, $field)} = get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2506 Internal function to map data from the MARC record to a specific non-MARC field.
2507 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
2513 sub get_koha_field_from_marc {
2514 my ($koha_table,$koha_column,$record,$frameworkcode) = @_;
2515 my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table.'.'.$koha_column, $frameworkcode );
2517 foreach my $field ( $record->field($tagfield) ) {
2518 if ( $field->tag() < 10 ) {
2520 $kohafield .= " | " . $field->data();
2523 $kohafield = $field->data();
2527 if ( $field->subfields ) {
2528 my @subfields = $field->subfields();
2529 foreach my $subfieldcount ( 0 .. $#subfields ) {
2530 if ( $subfields[$subfieldcount][0] eq $subfield ) {
2533 " | " . $subfields[$subfieldcount][1];
2537 $subfields[$subfieldcount][1];
2548 =head2 TransformMarcToKohaOneField
2552 $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
2558 sub TransformMarcToKohaOneField {
2560 # FIXME ? if a field has a repeatable subfield that is used in old-db,
2561 # only the 1st will be retrieved...
2562 my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
2564 my ( $tagfield, $subfield ) =
2565 GetMarcFromKohaField( $kohatable . "." . $kohafield,
2567 foreach my $field ( $record->field($tagfield) ) {
2568 if ( $field->tag() < 10 ) {
2569 if ( $result->{$kohafield} ) {
2570 $result->{$kohafield} .= " | " . $field->data();
2573 $result->{$kohafield} = $field->data();
2577 if ( $field->subfields ) {
2578 my @subfields = $field->subfields();
2579 foreach my $subfieldcount ( 0 .. $#subfields ) {
2580 if ( $subfields[$subfieldcount][0] eq $subfield ) {
2581 if ( $result->{$kohafield} ) {
2582 $result->{$kohafield} .=
2583 " | " . $subfields[$subfieldcount][1];
2586 $result->{$kohafield} =
2587 $subfields[$subfieldcount][1];
2597 =head1 OTHER FUNCTIONS
2603 my $string = char_decode( $string, $encoding );
2605 converts ISO 5426 coded string to UTF-8
2606 sloppy code : should be improved in next issue
2613 my ( $string, $encoding ) = @_;
2616 $encoding = C4::Context->preference("marcflavour") unless $encoding;
2617 if ( $encoding eq "UNIMARC" ) {
2687 # this handles non-sorting blocks (if implementation requires this)
2688 $string = nsb_clean($_);
2690 elsif ( $encoding eq "USMARC" || $encoding eq "MARC21" ) {
2749 #Additional Turkish characters
2752 s/(\xf0)s/\xc5\x9f/gm;
2753 s/(\xf0)S/\xc5\x9e/gm;
2756 s/\xe7\x49/\\xc4\xb0/gm;
2757 s/(\xe6)G/\xc4\x9e/gm;
2758 s/(\xe6)g/ğ\xc4\x9f/gm;
2761 s/(\xe8|\xc8)o/ö/gm;
2762 s/(\xe8|\xc8)O/Ö/gm;
2763 s/(\xe8|\xc8)u/ü/gm;
2764 s/(\xe8|\xc8)U/Ü/gm;
2765 s/\xc2\xb8/\xc4\xb1/gm;
2768 # this handles non-sorting blocks (if implementation requires this)
2769 $string = nsb_clean($_);
2778 my $string = nsb_clean( $string, $encoding );
2785 my $NSB = '\x88'; # NSB : begin Non Sorting Block
2786 my $NSE = '\x89'; # NSE : Non Sorting Block end
2787 # handles non sorting blocks
2791 s/[ ]{0,1}$NSE/) /gm;
2796 =head2 PrepareItemrecordDisplay
2800 PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber);
2802 Returns a hash with all the fields for Display a given item data in a template
2808 sub PrepareItemrecordDisplay {
2810 my ( $bibnum, $itemnum ) = @_;
2812 my $dbh = C4::Context->dbh;
2813 my $frameworkcode = &GetFrameworkCode( $bibnum );
2814 my ( $itemtagfield, $itemtagsubfield ) =
2815 &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2816 my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2817 my $itemrecord = GetMarcItem( $bibnum, $itemnum) if ($itemnum);
2819 my $authorised_values_sth =
2821 "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib"
2823 foreach my $tag ( sort keys %{$tagslib} ) {
2824 my $previous_tag = '';
2826 # loop through each subfield
2828 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2829 next if ( subfield_is_koha_internal_p($subfield) );
2830 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2832 $subfield_data{tag} = $tag;
2833 $subfield_data{subfield} = $subfield;
2834 $subfield_data{countsubfield} = $cntsubf++;
2835 $subfield_data{kohafield} =
2836 $tagslib->{$tag}->{$subfield}->{'kohafield'};
2838 # $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2839 $subfield_data{marc_lib} =
2840 "<span id=\"error\" title=\""
2841 . $tagslib->{$tag}->{$subfield}->{lib} . "\">"
2842 . substr( $tagslib->{$tag}->{$subfield}->{lib}, 0, 12 )
2844 $subfield_data{mandatory} =
2845 $tagslib->{$tag}->{$subfield}->{mandatory};
2846 $subfield_data{repeatable} =
2847 $tagslib->{$tag}->{$subfield}->{repeatable};
2848 $subfield_data{hidden} = "display:none"
2849 if $tagslib->{$tag}->{$subfield}->{hidden};
2851 ( $x, $value ) = _find_value( $tag, $subfield, $itemrecord )
2853 $value =~ s/"/"/g;
2855 # search for itemcallnumber if applicable
2856 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq
2857 'items.itemcallnumber'
2858 && C4::Context->preference('itemcallnumber') )
2861 substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2863 substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2864 my $temp = $itemrecord->field($CNtag) if ($itemrecord);
2866 $value = $temp->subfield($CNsubfield);
2869 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2870 my @authorised_values;
2873 # builds list, depending on authorised value...
2875 if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq
2878 if ( ( C4::Context->preference("IndependantBranches") )
2879 && ( C4::Context->userenv->{flags} != 1 ) )
2883 "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname"
2885 $sth->execute( C4::Context->userenv->{branch} );
2886 push @authorised_values, ""
2888 $tagslib->{$tag}->{$subfield}->{mandatory} );
2889 while ( my ( $branchcode, $branchname ) =
2890 $sth->fetchrow_array )
2892 push @authorised_values, $branchcode;
2893 $authorised_lib{$branchcode} = $branchname;
2899 "SELECT branchcode,branchname FROM branches ORDER BY branchname"
2902 push @authorised_values, ""
2904 $tagslib->{$tag}->{$subfield}->{mandatory} );
2905 while ( my ( $branchcode, $branchname ) =
2906 $sth->fetchrow_array )
2908 push @authorised_values, $branchcode;
2909 $authorised_lib{$branchcode} = $branchname;
2915 elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq
2920 "SELECT itemtype,description FROM itemtypes ORDER BY description"
2923 push @authorised_values, ""
2924 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2925 while ( my ( $itemtype, $description ) =
2926 $sth->fetchrow_array )
2928 push @authorised_values, $itemtype;
2929 $authorised_lib{$itemtype} = $description;
2932 #---- "true" authorised value
2935 $authorised_values_sth->execute(
2936 $tagslib->{$tag}->{$subfield}->{authorised_value} );
2937 push @authorised_values, ""
2938 unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2939 while ( my ( $value, $lib ) =
2940 $authorised_values_sth->fetchrow_array )
2942 push @authorised_values, $value;
2943 $authorised_lib{$value} = $lib;
2946 $subfield_data{marc_value} = CGI::scrolling_list(
2947 -name => 'field_value',
2948 -values => \@authorised_values,
2949 -default => "$value",
2950 -labels => \%authorised_lib,
2956 elsif ( $tagslib->{$tag}->{$subfield}->{thesaurus_category} ) {
2957 $subfield_data{marc_value} =
2958 "<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>";
2961 # COMMENTED OUT because No $i is provided with this API.
2962 # And thus, no value_builder can be activated.
2963 # BUT could be thought over.
2964 # } elsif ($tagslib->{$tag}->{$subfield}->{'value_builder'}) {
2965 # my $plugin="value_builder/".$tagslib->{$tag}->{$subfield}->{'value_builder'};
2967 # my $extended_param = plugin_parameters($dbh,$itemrecord,$tagslib,$i,0);
2968 # my ($function_name,$javascript) = plugin_javascript($dbh,$record,$tagslib,$i,0);
2969 # $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";
2972 $subfield_data{marc_value} =
2973 "<input type=\"text\" name=\"field_value\" value=\"$value\" size=50 maxlength=255>";
2975 push( @loop_data, \%subfield_data );
2979 my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
2980 if ( $itemrecord && $itemrecord->field($itemtagfield) );
2982 'itemtagfield' => $itemtagfield,
2983 'itemtagsubfield' => $itemtagsubfield,
2984 'itemnumber' => $itemnumber,
2985 'iteminformation' => \@loop_data
2991 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2993 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2994 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2995 # =head2 ModZebrafiles
2997 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
3001 # sub ModZebrafiles {
3003 # my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
3007 # C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
3008 # unless ( opendir( DIR, "$zebradir" ) ) {
3009 # warn "$zebradir not found";
3013 # my $filename = $zebradir . $biblionumber;
3016 # open( OUTPUT, ">", $filename . ".xml" );
3017 # print OUTPUT $record;
3026 ModZebra( $biblionumber, $op, $server, $newRecord );
3028 $biblionumber is the biblionumber we want to index
3029 $op is specialUpdate or delete, and is used to know what we want to do
3030 $server is the server that we want to update
3031 $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.
3038 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
3039 my ( $biblionumber, $op, $server, $newRecord ) = @_;
3040 my $dbh=C4::Context->dbh;
3042 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
3044 # replaced by a zebraqueue table, that is filled with ModZebra to run.
3045 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
3047 if (C4::Context->preference("NoZebra")) {
3048 # lock the nozebra table : we will read index lines, update them in Perl process
3049 # and write everything in 1 transaction.
3050 # lock the table to avoid someone else overwriting what we are doing
3051 $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE');
3052 my %result; # the result hash that will be builded by deletion / add, and written on mySQL at the end, to improve speed
3054 if ($server eq 'biblioserver') {
3055 $record= GetMarcBiblio($biblionumber);
3057 $record= C4::AuthoritiesMarc::GetAuthority($biblionumber);
3059 if ($op eq 'specialUpdate') {
3060 # OK, we have to add or update the record
3061 # 1st delete (virtually, in indexes) ...
3062 %result = _DelBiblioNoZebra($biblionumber,$record,$server);
3063 # ... add the record
3064 %result=_AddBiblioNoZebra($biblionumber,$newRecord, $server, %result);
3066 # it's a deletion, delete the record...
3067 # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
3068 %result=_DelBiblioNoZebra($biblionumber,$record,$server);
3070 # ok, now update the database...
3071 my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
3072 foreach my $key (keys %result) {
3073 foreach my $index (keys %{$result{$key}}) {
3074 $sth->execute($result{$key}->{$index}, $server, $key, $index);
3077 $dbh->do('UNLOCK TABLES');
3081 # we use zebra, just fill zebraqueue table
3083 my $sth=$dbh->prepare("INSERT INTO zebraqueue (biblio_auth_number,server,operation) VALUES(?,?,?)");
3084 $sth->execute($biblionumber,$server,$op);
3089 =head2 GetNoZebraIndexes
3091 %indexes = GetNoZebraIndexes;
3093 return the data from NoZebraIndexes syspref.
3097 sub GetNoZebraIndexes {
3098 my $index = C4::Context->preference('NoZebraIndexes');
3100 foreach my $line (split /('|"),/,$index) {
3101 $line =~ /(.*)=>(.*)/;
3103 my $index = substr($1,1); # get the index, don't forget to remove initial ' or "
3105 $index =~ s/'|"|\s//g;
3108 $fields =~ s/'|"|\s//g;
3109 $indexes{$index}=$fields;
3114 =head1 INTERNAL FUNCTIONS
3116 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
3118 function to delete a biblio in NoZebra indexes
3119 This function does NOT delete anything in database : it reads all the indexes entries
3120 that have to be deleted & delete them in the hash
3121 The SQL part is done either :
3122 - after the Add if we are modifying a biblio (delete + add again)
3123 - immediatly after this sub if we are doing a true deletion.
3124 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
3129 sub _DelBiblioNoZebra {
3130 my ($biblionumber, $record, $server)=@_;
3133 my $dbh = C4::Context->dbh;
3137 if ($server eq 'biblioserver') {
3138 %index=GetNoZebraIndexes;
3139 # get title of the record (to store the 10 first letters with the index)
3140 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
3141 $title = lc($record->subfield($titletag,$titlesubfield));
3143 # for authorities, the "title" is the $a mainentry
3144 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
3145 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
3146 $title = $record->subfield($authref->{auth_tag_to_report},'a');
3147 $index{'mainmainentry'}= $authref->{'auth_tag_to_report'}.'a';
3148 $index{'mainentry'} = $authref->{'auth_tag_to_report'}.'*';
3149 $index{'auth_type'} = '152b';
3153 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
3154 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
3155 # limit to 10 char, should be enough, and limit the DB size
3156 $title = substr($title,0,10);
3158 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
3159 foreach my $field ($record->fields()) {
3160 #parse each subfield
3161 next if $field->tag <10;
3162 foreach my $subfield ($field->subfields()) {
3163 my $tag = $field->tag();
3164 my $subfieldcode = $subfield->[0];
3166 # check each index to see if the subfield is stored somewhere
3167 # otherwise, store it in __RAW__ index
3168 foreach my $key (keys %index) {
3169 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
3170 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
3172 my $line= lc $subfield->[1];
3173 # remove meaningless value in the field...
3174 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3175 # ... and split in words
3176 foreach (split / /,$line) {
3177 next unless $_; # skip empty values (multiple spaces)
3178 # if the entry is already here, do nothing, the biblionumber has already be removed
3179 unless ($result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/) {
3180 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
3181 $sth2->execute($server,$key,$_);
3182 my $existing_biblionumbers = $sth2->fetchrow;
3184 if ($existing_biblionumbers) {
3185 # warn " existing for $key $_: $existing_biblionumbers";
3186 $result{$key}->{$_} =$existing_biblionumbers;
3187 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
3193 # the subfield is not indexed, store it in __RAW__ index anyway
3195 my $line= lc $subfield->[1];
3196 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3197 # ... and split in words
3198 foreach (split / /,$line) {
3199 next unless $_; # skip empty values (multiple spaces)
3200 # if the entry is already here, do nothing, the biblionumber has already be removed
3201 unless ($result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/) {
3202 # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
3203 $sth2->execute($server,'__RAW__',$_);
3204 my $existing_biblionumbers = $sth2->fetchrow;
3206 if ($existing_biblionumbers) {
3207 $result{'__RAW__'}->{$_} =$existing_biblionumbers;
3208 $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
3218 =head2 _AddBiblioNoZebra($biblionumber, $record, $server, %result);
3220 function to add a biblio in NoZebra indexes
3224 sub _AddBiblioNoZebra {
3225 my ($biblionumber, $record, $server, %result)=@_;
3226 my $dbh = C4::Context->dbh;
3230 if ($server eq 'biblioserver') {
3231 %index=GetNoZebraIndexes;
3232 # get title of the record (to store the 10 first letters with the index)
3233 my ($titletag,$titlesubfield) = GetMarcFromKohaField('biblio.title');
3234 $title = lc($record->subfield($titletag,$titlesubfield));
3236 # warn "server : $server";
3237 # for authorities, the "title" is the $a mainentry
3238 my $authref = C4::AuthoritiesMarc::GetAuthType($record->subfield(152,'b'));
3239 warn "ERROR : authtype undefined for ".$record->as_formatted unless $authref;
3240 $title = $record->subfield($authref->{auth_tag_to_report},'a');
3241 $index{'mainmainentry'} = $authref->{auth_tag_to_report}.'a';
3242 $index{'mainentry'} = $authref->{auth_tag_to_report}.'*';
3243 $index{'auth_type'} = '152b';
3246 # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
3247 $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
3248 # limit to 10 char, should be enough, and limit the DB size
3249 $title = substr($title,0,10);
3251 my $sth2=$dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
3252 foreach my $field ($record->fields()) {
3253 #parse each subfield
3254 next if $field->tag <10;
3255 foreach my $subfield ($field->subfields()) {
3256 my $tag = $field->tag();
3257 my $subfieldcode = $subfield->[0];
3259 # check each index to see if the subfield is stored somewhere
3260 # otherwise, store it in __RAW__ index
3261 foreach my $key (keys %index) {
3262 # warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
3263 if ($index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/) {
3265 my $line= lc $subfield->[1];
3266 # remove meaningless value in the field...
3267 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3268 # ... and split in words
3269 foreach (split / /,$line) {
3270 next unless $_; # skip empty values (multiple spaces)
3271 # if the entry is already here, improve weight
3272 # warn "managing $_";
3273 if ($result{$key}->{"$_"} =~ /$biblionumber,$title\-(\d);/) {
3275 $result{$key}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3276 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
3278 # get the value if it exist in the nozebra table, otherwise, create it
3279 $sth2->execute($server,$key,$_);
3280 my $existing_biblionumbers = $sth2->fetchrow;
3282 if ($existing_biblionumbers) {
3283 $result{$key}->{"$_"} =$existing_biblionumbers;
3285 $result{$key}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3286 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
3287 # create a new ligne for this entry
3289 # warn "INSERT : $server / $key / $_";
3290 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname='.$dbh->quote($key).',value='.$dbh->quote($_));
3291 $result{$key}->{"$_"}.="$biblionumber,$title-1;";
3297 # the subfield is not indexed, store it in __RAW__ index anyway
3299 my $line= lc $subfield->[1];
3300 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
3301 # ... and split in words
3302 foreach (split / /,$line) {
3303 next unless $_; # skip empty values (multiple spaces)
3304 # if the entry is already here, improve weight
3305 if ($result{'__RAW__'}->{"$_"} =~ /$biblionumber,$title\-(\d);/) {
3307 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3308 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
3310 # get the value if it exist in the nozebra table, otherwise, create it
3311 $sth2->execute($server,'__RAW__',$_);
3312 my $existing_biblionumbers = $sth2->fetchrow;
3314 if ($existing_biblionumbers) {
3315 $result{'__RAW__'}->{"$_"} =$existing_biblionumbers;
3317 $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,$title\-(\d);//;
3318 $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
3319 # create a new ligne for this entry
3321 $dbh->do('INSERT INTO nozebra SET server='.$dbh->quote($server).', indexname="__RAW__",value='.$dbh->quote($_));
3322 $result{'__RAW__'}->{"$_"}.="$biblionumber,$title-1;";
3333 =head2 MARCitemchange
3337 &MARCitemchange( $record, $itemfield, $newvalue )
3339 Function to update a single value in an item field.
3340 Used twice, could probably be replaced by something else, but works well...
3348 sub MARCitemchange {
3349 my ( $record, $itemfield, $newvalue ) = @_;
3350 my $dbh = C4::Context->dbh;
3352 my ( $tagfield, $tagsubfield ) =
3353 GetMarcFromKohaField( $itemfield, "" );
3354 if ( ($tagfield) && ($tagsubfield) ) {
3355 my $tag = $record->field($tagfield);
3357 $tag->update( $tagsubfield => $newvalue );
3358 $record->delete_field($tag);
3359 $record->insert_fields_ordered($tag);
3367 ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
3369 Find the given $subfield in the given $tag in the given
3370 MARC::Record $record. If the subfield is found, returns
3371 the (indicators, value) pair; otherwise, (undef, undef) is
3375 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
3376 I suggest we export it from this module.
3383 my ( $tagfield, $insubfield, $record, $encoding ) = @_;
3386 if ( $tagfield < 10 ) {
3387 if ( $record->field($tagfield) ) {
3388 push @result, $record->field($tagfield)->data();
3395 foreach my $field ( $record->field($tagfield) ) {
3396 my @subfields = $field->subfields();
3397 foreach my $subfield (@subfields) {
3398 if ( @$subfield[0] eq $insubfield ) {
3399 push @result, @$subfield[1];
3400 $indicator = $field->indicator(1) . $field->indicator(2);
3405 return ( $indicator, @result );
3408 =head2 _koha_marc_update_bib_ids
3412 _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
3414 Internal function to add or update biblionumber and biblioitemnumber to
3421 sub _koha_marc_update_bib_ids {
3422 my ($record, $frameworkcode, $biblionumber, $biblioitemnumber) = @_;
3424 # we must add bibnum and bibitemnum in MARC::Record...
3425 # we build the new field with biblionumber and biblioitemnumber
3426 # we drop the original field
3427 # we add the new builded field.
3428 my ($biblio_tag, $biblio_subfield ) = GetMarcFromKohaField("biblio.biblionumber",$frameworkcode);
3429 my ($biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField("biblioitems.biblioitemnumber",$frameworkcode);
3431 if ($biblio_tag != $biblioitem_tag) {
3432 # biblionumber & biblioitemnumber are in different fields
3434 # deal with biblionumber
3435 my ($new_field, $old_field);
3436 if ($biblio_tag < 10) {
3437 $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
3440 MARC::Field->new( $biblio_tag, '', '',
3441 "$biblio_subfield" => $biblionumber );
3444 # drop old field and create new one...
3445 $old_field = $record->field($biblio_tag);
3446 $record->delete_field($old_field);
3447 $record->append_fields($new_field);
3449 # deal with biblioitemnumber
3450 if ($biblioitem_tag < 10) {
3451 $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
3454 MARC::Field->new( $biblioitem_tag, '', '',
3455 "$biblioitem_subfield" => $biblioitemnumber, );
3457 # drop old field and create new one...
3458 $old_field = $record->field($biblioitem_tag);
3459 $record->delete_field($old_field);
3460 $record->insert_fields_ordered($new_field);
3463 # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
3464 my $new_field = MARC::Field->new(
3465 $biblio_tag, '', '',
3466 "$biblio_subfield" => $biblionumber,
3467 "$biblioitem_subfield" => $biblioitemnumber
3470 # drop old field and create new one...
3471 my $old_field = $record->field($biblio_tag);
3472 $record->delete_field($old_field);
3473 $record->insert_fields_ordered($new_field);
3477 =head2 _koha_add_biblio
3481 my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
3483 Internal function to add a biblio ($biblio is a hash with the values)
3489 sub _koha_add_biblio {
3490 my ( $dbh, $biblio, $frameworkcode ) = @_;
3494 # set the series flag
3496 if ( $biblio->{'seriestitle'} ) { $serial = 1 };
3500 SET frameworkcode = ?,
3511 my $sth = $dbh->prepare($query);
3514 $biblio->{'author'},
3516 $biblio->{'unititle'},
3519 $biblio->{'seriestitle'},
3520 $biblio->{'copyrightdate'},
3521 $biblio->{'abstract'}
3524 my $biblionumber = $dbh->{'mysql_insertid'};
3525 if ( $dbh->errstr ) {
3526 $error.="ERROR in _koha_add_biblio $query".$dbh->errstr;
3531 #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
3532 return ($biblionumber,$error);
3535 =head2 _koha_modify_biblio
3539 my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
3541 Internal function for updating the biblio table
3547 sub _koha_modify_biblio {
3548 my ( $dbh, $biblio, $frameworkcode ) = @_;
3553 SET frameworkcode = ?,
3562 WHERE biblionumber = ?
3565 my $sth = $dbh->prepare($query);
3569 $biblio->{'author'},
3571 $biblio->{'unititle'},
3573 $biblio->{'serial'},
3574 $biblio->{'seriestitle'},
3575 $biblio->{'copyrightdate'},
3576 $biblio->{'abstract'},
3577 $biblio->{'biblionumber'}
3578 ) if $biblio->{'biblionumber'};
3580 if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
3581 $error.="ERROR in _koha_modify_biblio $query".$dbh->errstr;
3584 return ( $biblio->{'biblionumber'},$error );
3587 =head2 _koha_modify_biblioitem_nonmarc
3591 my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
3593 Updates biblioitems row except for marc and marcxml, which should be changed
3600 sub _koha_modify_biblioitem_nonmarc {
3601 my ( $dbh, $biblioitem ) = @_;
3604 # re-calculate the cn_sort, it may have changed
3605 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3609 SET biblionumber = ?,
3615 publicationyear = ?,
3619 collectiontitle = ?,
3621 collectionvolume= ?,
3622 editionstatement= ?,
3623 editionresponsibility = ?,
3637 where biblioitemnumber = ?
3639 my $sth = $dbh->prepare($query);
3641 $biblioitem->{'biblionumber'},
3642 $biblioitem->{'volume'},
3643 $biblioitem->{'number'},
3644 $biblioitem->{'itemtype'},
3645 $biblioitem->{'isbn'},
3646 $biblioitem->{'issn'},
3647 $biblioitem->{'publicationyear'},
3648 $biblioitem->{'publishercode'},
3649 $biblioitem->{'volumedate'},
3650 $biblioitem->{'volumedesc'},
3651 $biblioitem->{'collectiontitle'},
3652 $biblioitem->{'collectionissn'},
3653 $biblioitem->{'collectionvolume'},
3654 $biblioitem->{'editionstatement'},
3655 $biblioitem->{'editionresponsibility'},
3656 $biblioitem->{'illus'},
3657 $biblioitem->{'pages'},
3658 $biblioitem->{'bnotes'},
3659 $biblioitem->{'size'},
3660 $biblioitem->{'place'},
3661 $biblioitem->{'lccn'},
3662 $biblioitem->{'url'},
3663 $biblioitem->{'biblioitems.cn_source'},
3664 $biblioitem->{'cn_class'},
3665 $biblioitem->{'cn_item'},
3666 $biblioitem->{'cn_suffix'},
3668 $biblioitem->{'totalissues'},
3669 $biblioitem->{'biblioitemnumber'}
3671 if ( $dbh->errstr ) {
3672 $error.="ERROR in _koha_modify_biblioitem_nonmarc $query".$dbh->errstr;
3675 return ($biblioitem->{'biblioitemnumber'},$error);
3678 =head2 _koha_add_biblioitem
3682 my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
3684 Internal function to add a biblioitem
3690 sub _koha_add_biblioitem {
3691 my ( $dbh, $biblioitem ) = @_;
3694 my ($cn_sort) = GetClassSort($biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3696 "INSERT INTO biblioitems SET
3703 publicationyear = ?,
3707 collectiontitle = ?,
3709 collectionvolume= ?,
3710 editionstatement= ?,
3711 editionresponsibility = ?,
3727 my $sth = $dbh->prepare($query);
3729 $biblioitem->{'biblionumber'},
3730 $biblioitem->{'volume'},
3731 $biblioitem->{'number'},
3732 $biblioitem->{'itemtype'},
3733 $biblioitem->{'isbn'},
3734 $biblioitem->{'issn'},
3735 $biblioitem->{'publicationyear'},
3736 $biblioitem->{'publishercode'},
3737 $biblioitem->{'volumedate'},
3738 $biblioitem->{'volumedesc'},
3739 $biblioitem->{'collectiontitle'},
3740 $biblioitem->{'collectionissn'},
3741 $biblioitem->{'collectionvolume'},
3742 $biblioitem->{'editionstatement'},
3743 $biblioitem->{'editionresponsibility'},
3744 $biblioitem->{'illus'},
3745 $biblioitem->{'pages'},
3746 $biblioitem->{'bnotes'},
3747 $biblioitem->{'size'},
3748 $biblioitem->{'place'},
3749 $biblioitem->{'lccn'},
3750 $biblioitem->{'marc'},
3751 $biblioitem->{'url'},
3752 $biblioitem->{'biblioitems.cn_source'},
3753 $biblioitem->{'cn_class'},
3754 $biblioitem->{'cn_item'},
3755 $biblioitem->{'cn_suffix'},
3757 $biblioitem->{'totalissues'}
3759 my $bibitemnum = $dbh->{'mysql_insertid'};
3760 if ( $dbh->errstr ) {
3761 $error.="ERROR in _koha_add_biblioitem $query".$dbh->errstr;
3765 return ($bibitemnum,$error);
3768 =head2 _koha_new_items
3772 my ($itemnumber,$error) = _koha_new_items( $dbh, $item, $barcode );
3778 sub _koha_new_items {
3779 my ( $dbh, $item, $barcode ) = @_;
3782 my ($items_cn_sort) = GetClassSort($item->{'items.cn_source'}, $item->{'itemcallnumber'}, "");
3784 # if dateaccessioned is provided, use it. Otherwise, set to NOW()
3785 if ( $item->{'dateaccessioned'} eq '' || !$item->{'dateaccessioned'} ) {
3786 my $today = C4::Dates->new();
3787 $item->{'dateaccessioned'} = $today->output("iso"); #TODO: check time issues
3790 "INSERT INTO items SET
3792 biblioitemnumber = ?,
3794 dateaccessioned = ?,
3798 replacementprice = ?,
3799 replacementpricedate = NOW(),
3800 datelastborrowed = ?,
3801 datelastseen = NOW(),
3821 my $sth = $dbh->prepare($query);
3823 $item->{'biblionumber'},
3824 $item->{'biblioitemnumber'},
3826 $item->{'dateaccessioned'},
3827 $item->{'booksellerid'},
3828 $item->{'homebranch'},
3830 $item->{'replacementprice'},
3831 $item->{datelastborrowed},
3833 $item->{'notforloan'},
3835 $item->{'itemlost'},
3836 $item->{'wthdrawn'},
3837 $item->{'itemcallnumber'},
3838 $item->{'restricted'},
3839 $item->{'itemnotes'},
3840 $item->{'holdingbranch'},
3842 $item->{'location'},
3844 $item->{'items.cn_source'},
3848 $item->{'materials'},
3851 my $itemnumber = $dbh->{'mysql_insertid'};
3852 if ( defined $sth->errstr ) {
3853 $error.="ERROR in _koha_new_items $query".$sth->errstr;
3856 return ( $itemnumber, $error );
3859 =head2 _koha_modify_item
3863 my ($itemnumber,$error) =_koha_modify_item( $dbh, $item, $op );
3869 sub _koha_modify_item {
3870 my ( $dbh, $item ) = @_;
3873 # calculate items.cn_sort
3874 $item->{'cn_sort'} = GetClassSort($item->{'items.cn_source'}, $item->{'itemcallnumber'}, "");
3876 my $query = "UPDATE items SET ";
3878 for my $key ( keys %$item ) {
3880 push @bind, $item->{$key};
3883 $query .= " WHERE itemnumber=?";
3884 push @bind, $item->{'itemnumber'};
3885 my $sth = $dbh->prepare($query);
3886 $sth->execute(@bind);
3887 if ( $dbh->errstr ) {
3888 $error.="ERROR in _koha_modify_item $query".$dbh->errstr;
3892 return ($item->{'itemnumber'},$error);
3895 =head2 _koha_delete_biblio
3899 $error = _koha_delete_biblio($dbh,$biblionumber);
3901 Internal sub for deleting from biblio table -- also saves to deletedbiblio
3903 C<$dbh> - the database handle
3904 C<$biblionumber> - the biblionumber of the biblio to be deleted
3910 # FIXME: add error handling
3912 sub _koha_delete_biblio {
3913 my ( $dbh, $biblionumber ) = @_;
3915 # get all the data for this biblio
3916 my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
3917 $sth->execute($biblionumber);
3919 if ( my $data = $sth->fetchrow_hashref ) {
3921 # save the record in deletedbiblio
3922 # find the fields to save
3923 my $query = "INSERT INTO deletedbiblio SET ";
3925 foreach my $temp ( keys %$data ) {
3926 $query .= "$temp = ?,";
3927 push( @bind, $data->{$temp} );
3930 # replace the last , by ",?)"
3932 my $bkup_sth = $dbh->prepare($query);
3933 $bkup_sth->execute(@bind);
3937 my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
3938 $del_sth->execute($biblionumber);
3945 =head2 _koha_delete_biblioitems
3949 $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
3951 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
3953 C<$dbh> - the database handle
3954 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
3960 # FIXME: add error handling
3962 sub _koha_delete_biblioitems {
3963 my ( $dbh, $biblioitemnumber ) = @_;
3965 # get all the data for this biblioitem
3967 $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
3968 $sth->execute($biblioitemnumber);
3970 if ( my $data = $sth->fetchrow_hashref ) {
3972 # save the record in deletedbiblioitems
3973 # find the fields to save
3974 my $query = "INSERT INTO deletedbiblioitems SET ";
3976 foreach my $temp ( keys %$data ) {
3977 $query .= "$temp = ?,";
3978 push( @bind, $data->{$temp} );
3981 # replace the last , by ",?)"
3983 my $bkup_sth = $dbh->prepare($query);
3984 $bkup_sth->execute(@bind);
3987 # delete the biblioitem
3989 $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
3990 $del_sth->execute($biblioitemnumber);
3997 =head2 _koha_delete_item
4001 _koha_delete_item( $dbh, $itemnum );
4003 Internal function to delete an item record from the koha tables
4009 sub _koha_delete_item {
4010 my ( $dbh, $itemnum ) = @_;
4012 # save the deleted item to deleteditems table
4013 my $sth = $dbh->prepare("SELECT * FROM items WHERE itemnumber=?");
4014 $sth->execute($itemnum);
4015 my $data = $sth->fetchrow_hashref();
4017 my $query = "INSERT INTO deleteditems SET ";
4019 foreach my $key ( keys %$data ) {
4020 $query .= "$key = ?,";
4021 push( @bind, $data->{$key} );
4024 $sth = $dbh->prepare($query);
4025 $sth->execute(@bind);
4028 # delete from items table
4029 $sth = $dbh->prepare("DELETE FROM items WHERE itemnumber=?");
4030 $sth->execute($itemnum);
4035 =head1 UNEXPORTED FUNCTIONS
4037 =head2 ModBiblioMarc
4039 &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
4041 Add MARC data for a biblio to koha
4043 Function exported, but should NOT be used, unless you really know what you're doing
4049 # pass the MARC::Record to this function, and it will create the records in the marc field
4050 my ( $record, $biblionumber, $frameworkcode ) = @_;
4051 my $dbh = C4::Context->dbh;
4052 my @fields = $record->fields();
4053 if ( !$frameworkcode ) {
4054 $frameworkcode = "";
4057 $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
4058 $sth->execute( $frameworkcode, $biblionumber );
4060 my $encoding = C4::Context->preference("marcflavour");
4062 # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
4063 if ( $encoding eq "UNIMARC" ) {
4065 if ( length($record->subfield( 100, "a" )) == 35 ) {
4066 $string = $record->subfield( 100, "a" );
4067 my $f100 = $record->field(100);
4068 $record->delete_field($f100);
4071 $string = POSIX::strftime( "%Y%m%d", localtime );
4073 $string = sprintf( "%-*s", 35, $string );
4075 substr( $string, 22, 6, "frey50" );
4076 unless ( $record->subfield( 100, "a" ) ) {
4077 $record->insert_grouped_field(
4078 MARC::Field->new( 100, "", "", "a" => $string ) );
4081 ModZebra($biblionumber,"specialUpdate","biblioserver",$record);
4084 "UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
4085 $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding),
4088 return $biblionumber;
4091 =head2 AddItemInMarc
4095 $newbiblionumber = AddItemInMarc( $record, $biblionumber, $frameworkcode );
4097 Add an item in a MARC record and save the MARC record
4099 Function exported, but should NOT be used, unless you really know what you're doing
4107 # pass the MARC::Record to this function, and it will create the records in the marc tables
4108 my ( $record, $biblionumber, $frameworkcode ) = @_;
4109 my $newrec = &GetMarcBiblio($biblionumber);
4112 my @fields = $record->fields();
4113 foreach my $field (@fields) {
4114 $newrec->append_fields($field);
4117 # FIXME: should we be making sure the biblionumbers are the same?
4118 my $newbiblionumber =
4119 &ModBiblioMarc( $newrec, $biblionumber, $frameworkcode );
4120 return $newbiblionumber;
4123 =head2 z3950_extended_services
4125 z3950_extended_services($serviceType,$serviceOptions,$record);
4127 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.
4129 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
4131 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
4133 action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
4137 recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
4138 syntax => the record syntax (transfer syntax)
4139 databaseName = Database from connection object
4141 To set serviceOptions, call set_service_options($serviceType)
4143 C<$record> the record, if one is needed for the service type
4145 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
4149 sub z3950_extended_services {
4150 my ( $server, $serviceType, $action, $serviceOptions ) = @_;
4152 # get our connection object
4153 my $Zconn = C4::Context->Zconn( $server, 0, 1 );
4155 # create a new package object
4156 my $Zpackage = $Zconn->package();
4159 $Zpackage->option( action => $action );
4161 if ( $serviceOptions->{'databaseName'} ) {
4162 $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
4164 if ( $serviceOptions->{'recordIdNumber'} ) {
4166 recordIdNumber => $serviceOptions->{'recordIdNumber'} );
4168 if ( $serviceOptions->{'recordIdOpaque'} ) {
4170 recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
4173 # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
4174 #if ($serviceType eq 'itemorder') {
4175 # $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
4176 # $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
4177 # $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
4178 # $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
4181 if ( $serviceOptions->{record} ) {
4182 $Zpackage->option( record => $serviceOptions->{record} );
4184 # can be xml or marc
4185 if ( $serviceOptions->{'syntax'} ) {
4186 $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
4190 # send the request, handle any exception encountered
4191 eval { $Zpackage->send($serviceType) };
4192 if ( $@ && $@->isa("ZOOM::Exception") ) {
4193 return "error: " . $@->code() . " " . $@->message() . "\n";
4196 # free up package resources
4197 $Zpackage->destroy();
4200 =head2 set_service_options
4202 my $serviceOptions = set_service_options($serviceType);
4204 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
4206 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
4210 sub set_service_options {
4211 my ($serviceType) = @_;
4214 # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
4215 # $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
4217 if ( $serviceType eq 'commit' ) {
4221 if ( $serviceType eq 'create' ) {
4225 if ( $serviceType eq 'drop' ) {
4226 die "ERROR: 'drop' not currently supported (by Zebra)";
4228 return $serviceOptions;
4231 =head2 GetItemsCount
4233 $count = &GetItemsCount( $biblionumber);
4234 this function return count of item with $biblionumber
4238 my ( $biblionumber ) = @_;
4239 my $dbh = C4::Context->dbh;
4240 my $query = "SELECT count(*)
4242 WHERE biblionumber=?";
4243 my $sth = $dbh->prepare($query);
4244 $sth->execute($biblionumber);
4245 my $count = $sth->fetchrow;
4250 END { } # module clean-up code here (global destructor)
4258 Koha Developement team <info@koha.org>
4260 Paul POULAIN paul.poulain@free.fr
4262 Joshua Ferraro jmf@liblime.com