b151d71ae9885e49165f84c6465f26ff6e4732b5
[koha.git] / C4 / Biblio.pm
1 package C4::Biblio;
2
3 # Copyright 2000-2002 Katipo Communications
4 #
5 # This file is part of Koha.
6 #
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
10 # version.
11 #
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.
15 #
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20 use strict;
21 use warnings;
22
23 # use utf8;
24 use MARC::Record;
25 use MARC::File::USMARC;
26 use MARC::File::XML;
27 use ZOOM;
28 use POSIX qw(strftime);
29
30 use C4::Koha;
31 use C4::Dates qw/format_date/;
32 use C4::Log;    # logaction
33 use C4::ClassSource;
34 use C4::Charset;
35 require C4::Heading;
36 require C4::Serials;
37
38 use vars qw($VERSION @ISA @EXPORT);
39
40 BEGIN {
41     $VERSION = 1.00;
42
43     require Exporter;
44     @ISA = qw( Exporter );
45
46     # to add biblios
47     # EXPORTED FUNCTIONS.
48     push @EXPORT, qw(
49       &AddBiblio
50     );
51
52     # to get something
53     push @EXPORT, qw(
54       &Get
55       &GetBiblio
56       &GetBiblioData
57       &GetBiblioItemData
58       &GetBiblioItemInfosOf
59       &GetBiblioItemByBiblioNumber
60       &GetBiblioFromItemNumber
61       &GetBiblionumberFromItemnumber
62
63       &GetRecordValue
64       &GetFieldMapping
65       &SetFieldMapping
66       &DeleteFieldMapping
67
68       &GetISBDView
69
70       &GetMarcControlnumber
71       &GetMarcNotes
72       &GetMarcISBN
73       &GetMarcSubjects
74       &GetMarcBiblio
75       &GetMarcAuthors
76       &GetMarcSeries
77       GetMarcUrls
78       &GetUsedMarcStructure
79       &GetXmlBiblio
80       &GetCOinSBiblio
81
82       &GetAuthorisedValueDesc
83       &GetMarcStructure
84       &GetMarcFromKohaField
85       &GetFrameworkCode
86       &TransformKohaToMarc
87
88       &CountItemsIssued
89     );
90
91     # To modify something
92     push @EXPORT, qw(
93       &ModBiblio
94       &ModBiblioframework
95       &ModZebra
96     );
97
98     # To delete something
99     push @EXPORT, qw(
100       &DelBiblio
101     );
102
103     # To link headings in a bib record
104     # to authority records.
105     push @EXPORT, qw(
106       &LinkBibHeadingsToAuthorities
107     );
108
109     # Internal functions
110     # those functions are exported but should not be used
111     # they are usefull is few circumstances, so are exported.
112     # but don't use them unless you're a core developer ;-)
113     push @EXPORT, qw(
114       &ModBiblioMarc
115     );
116
117     # Others functions
118     push @EXPORT, qw(
119       &TransformMarcToKoha
120       &TransformHtmlToMarc2
121       &TransformHtmlToMarc
122       &TransformHtmlToXml
123       &PrepareItemrecordDisplay
124       &GetNoZebraIndexes
125     );
126 }
127
128 eval {
129     my $servers = C4::Context->config('memcached_servers');
130     if ($servers) {
131         require Memoize::Memcached;
132         import Memoize::Memcached qw(memoize_memcached);
133
134         my $memcached = {
135             servers    => [$servers],
136             key_prefix => C4::Context->config('memcached_namespace') || 'koha',
137         };
138         memoize_memcached( 'GetMarcStructure', memcached => $memcached, expire_time => 600 );    #cache for 10 minutes
139     }
140 };
141
142 =head1 NAME
143
144 C4::Biblio - cataloging management functions
145
146 =head1 DESCRIPTION
147
148 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:
149
150 =over 4
151
152 =item 1. in the biblio,biblioitems,items, etc tables, which are limited to a one-to-one mapping to underlying MARC data
153
154 =item 2. as raw MARC in the Zebra index and storage engine
155
156 =item 3. as raw MARC the biblioitems.marc and biblioitems.marcxml
157
158 =back
159
160 In the 3.0 version of Koha, the authoritative record-level information is in biblioitems.marcxml
161
162 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.
163
164 =over 4
165
166 =item 1. Compared with MySQL, Zebra is slow to update an index for small data changes -- especially for proc-intensive operations like circulation
167
168 =item 2. Zebra's index has been known to crash and a backup of the data is necessary to rebuild it in such cases
169
170 =back
171
172 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:
173
174 =over 4
175
176 =item 1. Add*/Mod*/Del*/ - high-level external functions suitable for being called from external scripts to manage the collection
177
178 =item 2. _koha_* - low-level internal functions for managing the koha tables
179
180 =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.
181
182 =item 4. Zebra functions used to update the Zebra index
183
184 =item 5. internal helper functions such as char_decode, checkitems, etc. Some of these probably belong in Koha.pm
185
186 =back
187
188 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 :
189
190 =over 4
191
192 =item 1. save datas in biblio and biblioitems table, that gives us a biblionumber and a biblioitemnumber
193
194 =item 2. add the biblionumber and biblioitemnumber into the MARC records
195
196 =item 3. save the marc record
197
198 =back
199
200 When dealing with items, we must :
201
202 =over 4
203
204 =item 1. save the item in items table, that gives us an itemnumber
205
206 =item 2. add the itemnumber to the item MARC field
207
208 =item 3. overwrite the MARC record (with the added item) into biblioitems.marc(xml)
209
210 When modifying a biblio or an item, the behaviour is quite similar.
211
212 =back
213
214 =head1 EXPORTED FUNCTIONS
215
216 =head2 AddBiblio
217
218   ($biblionumber,$biblioitemnumber) = AddBiblio($record,$frameworkcode);
219
220 Exported function (core API) for adding a new biblio to koha.
221
222 The first argument is a C<MARC::Record> object containing the
223 bib to add, while the second argument is the desired MARC
224 framework code.
225
226 This function also accepts a third, optional argument: a hashref
227 to additional options.  The only defined option is C<defer_marc_save>,
228 which if present and mapped to a true value, causes C<AddBiblio>
229 to omit the call to save the MARC in C<bibilioitems.marc>
230 and C<biblioitems.marcxml>  This option is provided B<only>
231 for the use of scripts such as C<bulkmarcimport.pl> that may need
232 to do some manipulation of the MARC record for item parsing before
233 saving it and which cannot afford the performance hit of saving
234 the MARC record twice.  Consequently, do not use that option
235 unless you can guarantee that C<ModBiblioMarc> will be called.
236
237 =cut
238
239 sub AddBiblio {
240     my $record          = shift;
241     my $frameworkcode   = shift;
242     my $options         = @_ ? shift : undef;
243     my $defer_marc_save = 0;
244     if ( defined $options and exists $options->{'defer_marc_save'} and $options->{'defer_marc_save'} ) {
245         $defer_marc_save = 1;
246     }
247
248     my ( $biblionumber, $biblioitemnumber, $error );
249     my $dbh = C4::Context->dbh;
250
251     # transform the data into koha-table style data
252     my $olddata = TransformMarcToKoha( $dbh, $record, $frameworkcode );
253     ( $biblionumber, $error ) = _koha_add_biblio( $dbh, $olddata, $frameworkcode );
254     $olddata->{'biblionumber'} = $biblionumber;
255     ( $biblioitemnumber, $error ) = _koha_add_biblioitem( $dbh, $olddata );
256
257     _koha_marc_update_bib_ids( $record, $frameworkcode, $biblionumber, $biblioitemnumber );
258
259     # update MARC subfield that stores biblioitems.cn_sort
260     _koha_marc_update_biblioitem_cn_sort( $record, $olddata, $frameworkcode );
261
262     # now add the record
263     ModBiblioMarc( $record, $biblionumber, $frameworkcode ) unless $defer_marc_save;
264
265     logaction( "CATALOGUING", "ADD", $biblionumber, "biblio" ) if C4::Context->preference("CataloguingLog");
266     return ( $biblionumber, $biblioitemnumber );
267 }
268
269 =head2 ModBiblio
270
271   ModBiblio( $record,$biblionumber,$frameworkcode);
272
273 Replace an existing bib record identified by C<$biblionumber>
274 with one supplied by the MARC::Record object C<$record>.  The embedded
275 item, biblioitem, and biblionumber fields from the previous
276 version of the bib record replace any such fields of those tags that
277 are present in C<$record>.  Consequently, ModBiblio() is not
278 to be used to try to modify item records.
279
280 C<$frameworkcode> specifies the MARC framework to use
281 when storing the modified bib record; among other things,
282 this controls how MARC fields get mapped to display columns
283 in the C<biblio> and C<biblioitems> tables, as well as
284 which fields are used to store embedded item, biblioitem,
285 and biblionumber data for indexing.
286
287 =cut
288
289 sub ModBiblio {
290     my ( $record, $biblionumber, $frameworkcode ) = @_;
291     if ( C4::Context->preference("CataloguingLog") ) {
292         my $newrecord = GetMarcBiblio($biblionumber);
293         logaction( "CATALOGUING", "MODIFY", $biblionumber, "BEFORE=>" . $newrecord->as_formatted );
294     }
295
296     my $dbh = C4::Context->dbh;
297
298     $frameworkcode = "" unless $frameworkcode;
299
300     # get the items before and append them to the biblio before updating the record, atm we just have the biblio
301     my ( $itemtag, $itemsubfield ) = GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
302     my $oldRecord = GetMarcBiblio($biblionumber);
303
304     # delete any item fields from incoming record to avoid
305     # duplication or incorrect data - use AddItem() or ModItem()
306     # to change items
307     foreach my $field ( $record->field($itemtag) ) {
308         $record->delete_field($field);
309     }
310
311     # parse each item, and, for an unknown reason, re-encode each subfield
312     # if you don't do that, the record will have encoding mixed
313     # and the biblio will be re-encoded.
314     # strange, I (Paul P.) searched more than 1 day to understand what happends
315     # but could only solve the problem this way...
316     my @fields = $oldRecord->field($itemtag);
317     foreach my $fielditem (@fields) {
318         my $field;
319         foreach ( $fielditem->subfields() ) {
320             if ($field) {
321                 $field->add_subfields( Encode::encode( 'utf-8', $_->[0] ) => Encode::encode( 'utf-8', $_->[1] ) );
322             } else {
323                 $field = MARC::Field->new( "$itemtag", '', '', Encode::encode( 'utf-8', $_->[0] ) => Encode::encode( 'utf-8', $_->[1] ) );
324             }
325         }
326         $record->append_fields($field);
327     }
328
329     foreach my $field ($record->fields()) {
330         if (! $field->is_control_field()) {
331             if (scalar($field->subfields()) == 0) {
332                 $record->delete_fields($field);
333             }
334         }
335     }
336
337     # update biblionumber and biblioitemnumber in MARC
338     # FIXME - this is assuming a 1 to 1 relationship between
339     # biblios and biblioitems
340     my $sth = $dbh->prepare("select biblioitemnumber from biblioitems where biblionumber=?");
341     $sth->execute($biblionumber);
342     my ($biblioitemnumber) = $sth->fetchrow;
343     $sth->finish();
344     _koha_marc_update_bib_ids( $record, $frameworkcode, $biblionumber, $biblioitemnumber );
345
346     # load the koha-table data object
347     my $oldbiblio = TransformMarcToKoha( $dbh, $record, $frameworkcode );
348
349     # update MARC subfield that stores biblioitems.cn_sort
350     _koha_marc_update_biblioitem_cn_sort( $record, $oldbiblio, $frameworkcode );
351
352     # update the MARC record (that now contains biblio and items) with the new record data
353     &ModBiblioMarc( $record, $biblionumber, $frameworkcode );
354
355     # modify the other koha tables
356     _koha_modify_biblio( $dbh, $oldbiblio, $frameworkcode );
357     _koha_modify_biblioitem_nonmarc( $dbh, $oldbiblio );
358     return 1;
359 }
360
361 =head2 ModBiblioframework
362
363    ModBiblioframework($biblionumber,$frameworkcode);
364
365 Exported function to modify a biblio framework
366
367 =cut
368
369 sub ModBiblioframework {
370     my ( $biblionumber, $frameworkcode ) = @_;
371     my $dbh = C4::Context->dbh;
372     my $sth = $dbh->prepare( "UPDATE biblio SET frameworkcode=? WHERE biblionumber=?" );
373     $sth->execute( $frameworkcode, $biblionumber );
374     return 1;
375 }
376
377 =head2 DelBiblio
378
379   my $error = &DelBiblio($dbh,$biblionumber);
380
381 Exported function (core API) for deleting a biblio in koha.
382 Deletes biblio record from Zebra and Koha tables (biblio,biblioitems,items)
383 Also backs it up to deleted* tables
384 Checks to make sure there are not issues on any of the items
385 return:
386 C<$error> : undef unless an error occurs
387
388 =cut
389
390 sub DelBiblio {
391     my ($biblionumber) = @_;
392     my $dbh = C4::Context->dbh;
393     my $error;    # for error handling
394
395     # First make sure this biblio has no items attached
396     my $sth = $dbh->prepare("SELECT itemnumber FROM items WHERE biblionumber=?");
397     $sth->execute($biblionumber);
398     if ( my $itemnumber = $sth->fetchrow ) {
399
400         # Fix this to use a status the template can understand
401         $error .= "This Biblio has items attached, please delete them first before deleting this biblio ";
402     }
403
404     return $error if $error;
405
406     # We delete attached subscriptions
407     my $subscriptions = &C4::Serials::GetFullSubscriptionsFromBiblionumber($biblionumber);
408     foreach my $subscription (@$subscriptions) {
409         &C4::Serials::DelSubscription( $subscription->{subscriptionid} );
410     }
411
412     # Delete in Zebra. Be careful NOT to move this line after _koha_delete_biblio
413     # for at least 2 reasons :
414     # - we need to read the biblio if NoZebra is set (to remove it from the indexes
415     # - if something goes wrong, the biblio may be deleted from Koha but not from zebra
416     #   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)
417     my $oldRecord;
418     if ( C4::Context->preference("NoZebra") ) {
419
420         # only NoZebra indexing needs to have
421         # the previous version of the record
422         $oldRecord = GetMarcBiblio($biblionumber);
423     }
424     ModZebra( $biblionumber, "recordDelete", "biblioserver", $oldRecord, undef );
425
426     # delete biblioitems and items from Koha tables and save in deletedbiblioitems,deleteditems
427     $sth = $dbh->prepare("SELECT biblioitemnumber FROM biblioitems WHERE biblionumber=?");
428     $sth->execute($biblionumber);
429     while ( my $biblioitemnumber = $sth->fetchrow ) {
430
431         # delete this biblioitem
432         $error = _koha_delete_biblioitems( $dbh, $biblioitemnumber );
433         return $error if $error;
434     }
435
436     # delete biblio from Koha tables and save in deletedbiblio
437     # must do this *after* _koha_delete_biblioitems, otherwise
438     # delete cascade will prevent deletedbiblioitems rows
439     # from being generated by _koha_delete_biblioitems
440     $error = _koha_delete_biblio( $dbh, $biblionumber );
441
442     logaction( "CATALOGUING", "DELETE", $biblionumber, "" ) if C4::Context->preference("CataloguingLog");
443
444     return;
445 }
446
447 =head2 LinkBibHeadingsToAuthorities
448
449   my $headings_linked = LinkBibHeadingsToAuthorities($marc);
450
451 Links bib headings to authority records by checking
452 each authority-controlled field in the C<MARC::Record>
453 object C<$marc>, looking for a matching authority record,
454 and setting the linking subfield $9 to the ID of that
455 authority record.  
456
457 If no matching authority exists, or if multiple
458 authorities match, no $9 will be added, and any 
459 existing one inthe field will be deleted.
460
461 Returns the number of heading links changed in the
462 MARC record.
463
464 =cut
465
466 sub LinkBibHeadingsToAuthorities {
467     my $bib = shift;
468
469     my $num_headings_changed = 0;
470     foreach my $field ( $bib->fields() ) {
471         my $heading = C4::Heading->new_from_bib_field($field);
472         next unless defined $heading;
473
474         # check existing $9
475         my $current_link = $field->subfield('9');
476
477         # look for matching authorities
478         my $authorities = $heading->authorities();
479
480         # want only one exact match
481         if ( $#{$authorities} == 0 ) {
482             my $authority = MARC::Record->new_from_usmarc( $authorities->[0] );
483             my $authid    = $authority->field('001')->data();
484             next if defined $current_link and $current_link eq $authid;
485
486             $field->delete_subfield( code => '9' ) if defined $current_link;
487             $field->add_subfields( '9', $authid );
488             $num_headings_changed++;
489         } else {
490             if ( defined $current_link ) {
491                 $field->delete_subfield( code => '9' );
492                 $num_headings_changed++;
493             }
494         }
495
496     }
497     return $num_headings_changed;
498 }
499
500 =head2 GetRecordValue
501
502   my $values = GetRecordValue($field, $record, $frameworkcode);
503
504 Get MARC fields from a keyword defined in fieldmapping table.
505
506 =cut
507
508 sub GetRecordValue {
509     my ( $field, $record, $frameworkcode ) = @_;
510     my $dbh = C4::Context->dbh;
511
512     my $sth = $dbh->prepare('SELECT fieldcode, subfieldcode FROM fieldmapping WHERE frameworkcode = ? AND field = ?');
513     $sth->execute( $frameworkcode, $field );
514
515     my @result = ();
516
517     while ( my $row = $sth->fetchrow_hashref ) {
518         foreach my $field ( $record->field( $row->{fieldcode} ) ) {
519             if ( ( $row->{subfieldcode} ne "" && $field->subfield( $row->{subfieldcode} ) ) ) {
520                 foreach my $subfield ( $field->subfield( $row->{subfieldcode} ) ) {
521                     push @result, { 'subfield' => $subfield };
522                 }
523
524             } elsif ( $row->{subfieldcode} eq "" ) {
525                 push @result, { 'subfield' => $field->as_string() };
526             }
527         }
528     }
529
530     return \@result;
531 }
532
533 =head2 SetFieldMapping
534
535   SetFieldMapping($framework, $field, $fieldcode, $subfieldcode);
536
537 Set a Field to MARC mapping value, if it already exists we don't add a new one.
538
539 =cut
540
541 sub SetFieldMapping {
542     my ( $framework, $field, $fieldcode, $subfieldcode ) = @_;
543     my $dbh = C4::Context->dbh;
544
545     my $sth = $dbh->prepare('SELECT * FROM fieldmapping WHERE fieldcode = ? AND subfieldcode = ? AND frameworkcode = ? AND field = ?');
546     $sth->execute( $fieldcode, $subfieldcode, $framework, $field );
547     if ( not $sth->fetchrow_hashref ) {
548         my @args;
549         $sth = $dbh->prepare('INSERT INTO fieldmapping (fieldcode, subfieldcode, frameworkcode, field) VALUES(?,?,?,?)');
550
551         $sth->execute( $fieldcode, $subfieldcode, $framework, $field );
552     }
553 }
554
555 =head2 DeleteFieldMapping
556
557   DeleteFieldMapping($id);
558
559 Delete a field mapping from an $id.
560
561 =cut
562
563 sub DeleteFieldMapping {
564     my ($id) = @_;
565     my $dbh = C4::Context->dbh;
566
567     my $sth = $dbh->prepare('DELETE FROM fieldmapping WHERE id = ?');
568     $sth->execute($id);
569 }
570
571 =head2 GetFieldMapping
572
573   GetFieldMapping($frameworkcode);
574
575 Get all field mappings for a specified frameworkcode
576
577 =cut
578
579 sub GetFieldMapping {
580     my ($framework) = @_;
581     my $dbh = C4::Context->dbh;
582
583     my $sth = $dbh->prepare('SELECT * FROM fieldmapping where frameworkcode = ?');
584     $sth->execute($framework);
585
586     my @return;
587     while ( my $row = $sth->fetchrow_hashref ) {
588         push @return, $row;
589     }
590     return \@return;
591 }
592
593 =head2 GetBiblioData
594
595   $data = &GetBiblioData($biblionumber);
596
597 Returns information about the book with the given biblionumber.
598 C<&GetBiblioData> returns a reference-to-hash. The keys are the fields in
599 the C<biblio> and C<biblioitems> tables in the
600 Koha database.
601
602 In addition, C<$data-E<gt>{subject}> is the list of the book's
603 subjects, separated by C<" , "> (space, comma, space).
604 If there are multiple biblioitems with the given biblionumber, only
605 the first one is considered.
606
607 =cut
608
609 sub GetBiblioData {
610     my ($bibnum) = @_;
611     my $dbh = C4::Context->dbh;
612
613     #  my $query =  C4::Context->preference('item-level_itypes') ?
614     #   " SELECT * , biblioitems.notes AS bnotes, biblio.notes
615     #       FROM biblio
616     #        LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
617     #       WHERE biblio.biblionumber = ?
618     #        AND biblioitems.biblionumber = biblio.biblionumber
619     #";
620
621     my $query = " SELECT * , biblioitems.notes AS bnotes, itemtypes.notforloan as bi_notforloan, biblio.notes
622             FROM biblio
623             LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
624             LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
625             WHERE biblio.biblionumber = ?
626             AND biblioitems.biblionumber = biblio.biblionumber ";
627
628     my $sth = $dbh->prepare($query);
629     $sth->execute($bibnum);
630     my $data;
631     $data = $sth->fetchrow_hashref;
632     $sth->finish;
633
634     return ($data);
635 }    # sub GetBiblioData
636
637 =head2 &GetBiblioItemData
638
639   $itemdata = &GetBiblioItemData($biblioitemnumber);
640
641 Looks up the biblioitem with the given biblioitemnumber. Returns a
642 reference-to-hash. The keys are the fields from the C<biblio>,
643 C<biblioitems>, and C<itemtypes> tables in the Koha database, except
644 that C<biblioitems.notes> is given as C<$itemdata-E<gt>{bnotes}>.
645
646 =cut
647
648 #'
649 sub GetBiblioItemData {
650     my ($biblioitemnumber) = @_;
651     my $dbh                = C4::Context->dbh;
652     my $query              = "SELECT *,biblioitems.notes AS bnotes
653         FROM biblio LEFT JOIN biblioitems on biblio.biblionumber=biblioitems.biblionumber ";
654     unless ( C4::Context->preference('item-level_itypes') ) {
655         $query .= "LEFT JOIN itemtypes on biblioitems.itemtype=itemtypes.itemtype ";
656     }
657     $query .= " WHERE biblioitemnumber = ? ";
658     my $sth = $dbh->prepare($query);
659     my $data;
660     $sth->execute($biblioitemnumber);
661     $data = $sth->fetchrow_hashref;
662     $sth->finish;
663     return ($data);
664 }    # sub &GetBiblioItemData
665
666 =head2 GetBiblioItemByBiblioNumber
667
668 NOTE : This function has been copy/paste from C4/Biblio.pm from head before zebra integration.
669
670 =cut
671
672 sub GetBiblioItemByBiblioNumber {
673     my ($biblionumber) = @_;
674     my $dbh            = C4::Context->dbh;
675     my $sth            = $dbh->prepare("Select * FROM biblioitems WHERE biblionumber = ?");
676     my $count          = 0;
677     my @results;
678
679     $sth->execute($biblionumber);
680
681     while ( my $data = $sth->fetchrow_hashref ) {
682         push @results, $data;
683     }
684
685     $sth->finish;
686     return @results;
687 }
688
689 =head2 GetBiblionumberFromItemnumber
690
691
692 =cut
693
694 sub GetBiblionumberFromItemnumber {
695     my ($itemnumber) = @_;
696     my $dbh            = C4::Context->dbh;
697     my $sth            = $dbh->prepare("Select biblionumber FROM items WHERE itemnumber = ?");
698
699     $sth->execute($itemnumber);
700     my ($result) = $sth->fetchrow;
701     return ($result);
702 }
703
704 =head2 GetBiblioFromItemNumber
705
706   $item = &GetBiblioFromItemNumber($itemnumber,$barcode);
707
708 Looks up the item with the given itemnumber. if undef, try the barcode.
709
710 C<&itemnodata> returns a reference-to-hash whose keys are the fields
711 from the C<biblio>, C<biblioitems>, and C<items> tables in the Koha
712 database.
713
714 =cut
715
716 #'
717 sub GetBiblioFromItemNumber {
718     my ( $itemnumber, $barcode ) = @_;
719     my $dbh = C4::Context->dbh;
720     my $sth;
721     if ($itemnumber) {
722         $sth = $dbh->prepare(
723             "SELECT * FROM items 
724             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
725             LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
726              WHERE items.itemnumber = ?"
727         );
728         $sth->execute($itemnumber);
729     } else {
730         $sth = $dbh->prepare(
731             "SELECT * FROM items 
732             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
733             LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber
734              WHERE items.barcode = ?"
735         );
736         $sth->execute($barcode);
737     }
738     my $data = $sth->fetchrow_hashref;
739     $sth->finish;
740     return ($data);
741 }
742
743 =head2 GetISBDView 
744
745   $isbd = &GetISBDView($biblionumber);
746
747 Return the ISBD view which can be included in opac and intranet
748
749 =cut
750
751 sub GetISBDView {
752     my ( $biblionumber, $template ) = @_;
753     my $record   = GetMarcBiblio($biblionumber);
754     my $itemtype = &GetFrameworkCode($biblionumber);
755     my ( $holdingbrtagf, $holdingbrtagsubf ) = &GetMarcFromKohaField( "items.holdingbranch", $itemtype );
756     my $tagslib = &GetMarcStructure( 1, $itemtype );
757
758     my $ISBD = C4::Context->preference('ISBD');
759     my $bloc = $ISBD;
760     my $res;
761     my $blocres;
762
763     foreach my $isbdfield ( split( /#/, $bloc ) ) {
764
765         #         $isbdfield= /(.?.?.?)/;
766         $isbdfield =~ /(\d\d\d)([^\|])?\|(.*)\|(.*)\|(.*)/;
767         my $fieldvalue = $1 || 0;
768         my $subfvalue  = $2 || "";
769         my $textbefore = $3;
770         my $analysestring = $4;
771         my $textafter     = $5;
772
773         #         warn "==> $1 / $2 / $3 / $4";
774         #         my $fieldvalue=substr($isbdfield,0,3);
775         if ( $fieldvalue > 0 ) {
776             my $hasputtextbefore = 0;
777             my @fieldslist       = $record->field($fieldvalue);
778             @fieldslist = sort { $a->subfield($holdingbrtagsubf) cmp $b->subfield($holdingbrtagsubf) } @fieldslist if ( $fieldvalue eq $holdingbrtagf );
779
780             #         warn "ERROR IN ISBD DEFINITION at : $isbdfield" unless $fieldvalue;
781             #             warn "FV : $fieldvalue";
782             if ( $subfvalue ne "" ) {
783                 foreach my $field (@fieldslist) {
784                     foreach my $subfield ( $field->subfield($subfvalue) ) {
785                         my $calculated = $analysestring;
786                         my $tag        = $field->tag();
787                         if ( $tag < 10 ) {
788                         } else {
789                             my $subfieldvalue = GetAuthorisedValueDesc( $tag, $subfvalue, $subfield, '', $tagslib );
790                             my $tagsubf = $tag . $subfvalue;
791                             $calculated =~ s/\{(.?.?.?.?)$tagsubf(.*?)\}/$1$subfieldvalue$2\{$1$tagsubf$2\}/g;
792                             if ( $template eq "opac" ) { $calculated =~ s#/cgi-bin/koha/[^/]+/([^.]*.pl\?.*)$#opac-$1#g; }
793
794                             # field builded, store the result
795                             if ( $calculated && !$hasputtextbefore ) {    # put textbefore if not done
796                                 $blocres .= $textbefore;
797                                 $hasputtextbefore = 1;
798                             }
799
800                             # remove punctuation at start
801                             $calculated =~ s/^( |;|:|\.|-)*//g;
802                             $blocres .= $calculated;
803
804                         }
805                     }
806                 }
807                 $blocres .= $textafter if $hasputtextbefore;
808             } else {
809                 foreach my $field (@fieldslist) {
810                     my $calculated = $analysestring;
811                     my $tag        = $field->tag();
812                     if ( $tag < 10 ) {
813                     } else {
814                         my @subf = $field->subfields;
815                         for my $i ( 0 .. $#subf ) {
816                             my $valuecode     = $subf[$i][1];
817                             my $subfieldcode  = $subf[$i][0];
818                             my $subfieldvalue = GetAuthorisedValueDesc( $tag, $subf[$i][0], $subf[$i][1], '', $tagslib );
819                             my $tagsubf       = $tag . $subfieldcode;
820
821                             $calculated =~ s/                  # replace all {{}} codes by the value code.
822                                   \{\{$tagsubf\}\} # catch the {{actualcode}}
823                                 /
824                                   $valuecode     # replace by the value code
825                                /gx;
826
827                             $calculated =~ s/\{(.?.?.?.?)$tagsubf(.*?)\}/$1$subfieldvalue$2\{$1$tagsubf$2\}/g;
828                             if ( $template eq "opac" ) { $calculated =~ s#/cgi-bin/koha/[^/]+/([^.]*.pl\?.*)$#opac-$1#g; }
829                         }
830
831                         # field builded, store the result
832                         if ( $calculated && !$hasputtextbefore ) {    # put textbefore if not done
833                             $blocres .= $textbefore;
834                             $hasputtextbefore = 1;
835                         }
836
837                         # remove punctuation at start
838                         $calculated =~ s/^( |;|:|\.|-)*//g;
839                         $blocres .= $calculated;
840                     }
841                 }
842                 $blocres .= $textafter if $hasputtextbefore;
843             }
844         } else {
845             $blocres .= $isbdfield;
846         }
847     }
848     $res .= $blocres;
849
850     $res =~ s/\{(.*?)\}//g;
851     $res =~ s/\\n/\n/g;
852     $res =~ s/\n/<br\/>/g;
853
854     # remove empty ()
855     $res =~ s/\(\)//g;
856
857     return $res;
858 }
859
860 =head2 GetBiblio
861
862   ( $count, @results ) = &GetBiblio($biblionumber);
863
864 =cut
865
866 sub GetBiblio {
867     my ($biblionumber) = @_;
868     my $dbh            = C4::Context->dbh;
869     my $sth            = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber = ?");
870     my $count          = 0;
871     my @results;
872     $sth->execute($biblionumber);
873     while ( my $data = $sth->fetchrow_hashref ) {
874         $results[$count] = $data;
875         $count++;
876     }    # while
877     $sth->finish;
878     return ( $count, @results );
879 }    # sub GetBiblio
880
881 =head2 GetBiblioItemInfosOf
882
883   GetBiblioItemInfosOf(@biblioitemnumbers);
884
885 =cut
886
887 sub GetBiblioItemInfosOf {
888     my @biblioitemnumbers = @_;
889
890     my $query = '
891         SELECT biblioitemnumber,
892             publicationyear,
893             itemtype
894         FROM biblioitems
895         WHERE biblioitemnumber IN (' . join( ',', @biblioitemnumbers ) . ')
896     ';
897     return get_infos_of( $query, 'biblioitemnumber' );
898 }
899
900 =head1 FUNCTIONS FOR HANDLING MARC MANAGEMENT
901
902 =head2 GetMarcStructure
903
904   $res = GetMarcStructure($forlibrarian,$frameworkcode);
905
906 Returns a reference to a big hash of hash, with the Marc structure for the given frameworkcode
907 $forlibrarian  :if set to 1, the MARC descriptions are the librarians ones, otherwise it's the public (OPAC) ones
908 $frameworkcode : the framework code to read
909
910 =cut
911
912 # cache for results of GetMarcStructure -- needed
913 # for batch jobs
914 our $marc_structure_cache;
915
916 sub GetMarcStructure {
917     my ( $forlibrarian, $frameworkcode ) = @_;
918     my $dbh = C4::Context->dbh;
919     $frameworkcode = "" unless $frameworkcode;
920
921     if ( defined $marc_structure_cache and exists $marc_structure_cache->{$forlibrarian}->{$frameworkcode} ) {
922         return $marc_structure_cache->{$forlibrarian}->{$frameworkcode};
923     }
924
925     #     my $sth = $dbh->prepare(
926     #         "SELECT COUNT(*) FROM marc_tag_structure WHERE frameworkcode=?");
927     #     $sth->execute($frameworkcode);
928     #     my ($total) = $sth->fetchrow;
929     #     $frameworkcode = "" unless ( $total > 0 );
930     my $sth = $dbh->prepare(
931         "SELECT tagfield,liblibrarian,libopac,mandatory,repeatable 
932         FROM marc_tag_structure 
933         WHERE frameworkcode=? 
934         ORDER BY tagfield"
935     );
936     $sth->execute($frameworkcode);
937     my ( $liblibrarian, $libopac, $tag, $res, $tab, $mandatory, $repeatable );
938
939     while ( ( $tag, $liblibrarian, $libopac, $mandatory, $repeatable ) = $sth->fetchrow ) {
940         $res->{$tag}->{lib}        = ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
941         $res->{$tag}->{tab}        = "";
942         $res->{$tag}->{mandatory}  = $mandatory;
943         $res->{$tag}->{repeatable} = $repeatable;
944     }
945
946     $sth = $dbh->prepare(
947         "SELECT tagfield,tagsubfield,liblibrarian,libopac,tab,mandatory,repeatable,authorised_value,authtypecode,value_builder,kohafield,seealso,hidden,isurl,link,defaultvalue 
948          FROM   marc_subfield_structure 
949          WHERE  frameworkcode=? 
950          ORDER BY tagfield,tagsubfield
951         "
952     );
953
954     $sth->execute($frameworkcode);
955
956     my $subfield;
957     my $authorised_value;
958     my $authtypecode;
959     my $value_builder;
960     my $kohafield;
961     my $seealso;
962     my $hidden;
963     my $isurl;
964     my $link;
965     my $defaultvalue;
966
967     while (
968         (   $tag,          $subfield,      $liblibrarian, $libopac, $tab,    $mandatory, $repeatable, $authorised_value,
969             $authtypecode, $value_builder, $kohafield,    $seealso, $hidden, $isurl,     $link,       $defaultvalue
970         )
971         = $sth->fetchrow
972       ) {
973         $res->{$tag}->{$subfield}->{lib}              = ( $forlibrarian or !$libopac ) ? $liblibrarian : $libopac;
974         $res->{$tag}->{$subfield}->{tab}              = $tab;
975         $res->{$tag}->{$subfield}->{mandatory}        = $mandatory;
976         $res->{$tag}->{$subfield}->{repeatable}       = $repeatable;
977         $res->{$tag}->{$subfield}->{authorised_value} = $authorised_value;
978         $res->{$tag}->{$subfield}->{authtypecode}     = $authtypecode;
979         $res->{$tag}->{$subfield}->{value_builder}    = $value_builder;
980         $res->{$tag}->{$subfield}->{kohafield}        = $kohafield;
981         $res->{$tag}->{$subfield}->{seealso}          = $seealso;
982         $res->{$tag}->{$subfield}->{hidden}           = $hidden;
983         $res->{$tag}->{$subfield}->{isurl}            = $isurl;
984         $res->{$tag}->{$subfield}->{'link'}           = $link;
985         $res->{$tag}->{$subfield}->{defaultvalue}     = $defaultvalue;
986     }
987
988     $marc_structure_cache->{$forlibrarian}->{$frameworkcode} = $res;
989
990     return $res;
991 }
992
993 =head2 GetUsedMarcStructure
994
995 The same function as GetMarcStructure except it just takes field
996 in tab 0-9. (used field)
997
998   my $results = GetUsedMarcStructure($frameworkcode);
999
1000 C<$results> is a ref to an array which each case containts a ref
1001 to a hash which each keys is the columns from marc_subfield_structure
1002
1003 C<$frameworkcode> is the framework code. 
1004
1005 =cut
1006
1007 sub GetUsedMarcStructure($) {
1008     my $frameworkcode = shift || '';
1009     my $query = qq/
1010         SELECT *
1011         FROM   marc_subfield_structure
1012         WHERE   tab > -1 
1013             AND frameworkcode = ?
1014         ORDER BY tagfield, tagsubfield
1015     /;
1016     my $sth = C4::Context->dbh->prepare($query);
1017     $sth->execute($frameworkcode);
1018     return $sth->fetchall_arrayref( {} );
1019 }
1020
1021 =head2 GetMarcFromKohaField
1022
1023   ($MARCfield,$MARCsubfield)=GetMarcFromKohaField($kohafield,$frameworkcode);
1024
1025 Returns the MARC fields & subfields mapped to the koha field 
1026 for the given frameworkcode
1027
1028 =cut
1029
1030 sub GetMarcFromKohaField {
1031     my ( $kohafield, $frameworkcode ) = @_;
1032     return 0, 0 unless $kohafield and defined $frameworkcode;
1033     my $relations = C4::Context->marcfromkohafield;
1034     return ( $relations->{$frameworkcode}->{$kohafield}->[0], $relations->{$frameworkcode}->{$kohafield}->[1] );
1035 }
1036
1037 =head2 GetMarcBiblio
1038
1039   my $record = GetMarcBiblio($biblionumber);
1040
1041 Returns MARC::Record representing bib identified by
1042 C<$biblionumber>.  If no bib exists, returns undef.
1043 The MARC record contains both biblio & item data.
1044
1045 =cut
1046
1047 sub GetMarcBiblio {
1048     my $biblionumber = shift;
1049     my $dbh          = C4::Context->dbh;
1050     my $sth          = $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
1051     $sth->execute($biblionumber);
1052     my $row     = $sth->fetchrow_hashref;
1053     my $marcxml = StripNonXmlChars( $row->{'marcxml'} );
1054     MARC::File::XML->default_record_format( C4::Context->preference('marcflavour') );
1055     my $record = MARC::Record->new();
1056
1057     if ($marcxml) {
1058         $record = eval { MARC::Record::new_from_xml( $marcxml, "utf8", C4::Context->preference('marcflavour') ) };
1059         if ($@) { warn " problem with :$biblionumber : $@ \n$marcxml"; }
1060
1061         #      $record = MARC::Record::new_from_usmarc( $marc) if $marc;
1062         return $record;
1063     } else {
1064         return undef;
1065     }
1066 }
1067
1068 =head2 GetXmlBiblio
1069
1070   my $marcxml = GetXmlBiblio($biblionumber);
1071
1072 Returns biblioitems.marcxml of the biblionumber passed in parameter.
1073 The XML contains both biblio & item datas
1074
1075 =cut
1076
1077 sub GetXmlBiblio {
1078     my ($biblionumber) = @_;
1079     my $dbh            = C4::Context->dbh;
1080     my $sth            = $dbh->prepare("SELECT marcxml FROM biblioitems WHERE biblionumber=? ");
1081     $sth->execute($biblionumber);
1082     my ($marcxml) = $sth->fetchrow;
1083     return $marcxml;
1084 }
1085
1086 =head2 GetCOinSBiblio
1087
1088   my $coins = GetCOinSBiblio($biblionumber);
1089
1090 Returns the COinS(a span) which can be included in a biblio record
1091
1092 =cut
1093
1094 sub GetCOinSBiblio {
1095     my ($biblionumber) = @_;
1096     my $record = GetMarcBiblio($biblionumber);
1097
1098     # get the coin format
1099     if ( ! $record ) {
1100         # can't get a valid MARC::Record object, bail out at this point
1101         warn "We called GetMarcBiblio with a biblionumber that doesn't exist biblionumber=$biblionumber";
1102         return;
1103     }
1104     my $pos7 = substr $record->leader(), 7, 1;
1105     my $pos6 = substr $record->leader(), 6, 1;
1106     my $mtx;
1107     my $genre;
1108     my ( $aulast, $aufirst ) = ( '', '' );
1109     my $oauthors  = '';
1110     my $title     = '';
1111     my $subtitle  = '';
1112     my $pubyear   = '';
1113     my $isbn      = '';
1114     my $issn      = '';
1115     my $publisher = '';
1116
1117     if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
1118         my $fmts6;
1119         my $fmts7;
1120         %$fmts6 = (
1121             'a' => 'book',
1122             'b' => 'manuscript',
1123             'c' => 'book',
1124             'd' => 'manuscript',
1125             'e' => 'map',
1126             'f' => 'map',
1127             'g' => 'film',
1128             'i' => 'audioRecording',
1129             'j' => 'audioRecording',
1130             'k' => 'artwork',
1131             'l' => 'document',
1132             'm' => 'computerProgram',
1133             'r' => 'document',
1134
1135         );
1136         %$fmts7 = (
1137             'a' => 'journalArticle',
1138             's' => 'journal',
1139         );
1140
1141         $genre = $fmts6->{$pos6} ? $fmts6->{$pos6} : 'book';
1142
1143         if ( $genre eq 'book' ) {
1144             $genre = $fmts7->{$pos7} if $fmts7->{$pos7};
1145         }
1146
1147         ##### We must transform mtx to a valable mtx and document type ####
1148         if ( $genre eq 'book' ) {
1149             $mtx = 'book';
1150         } elsif ( $genre eq 'journal' ) {
1151             $mtx = 'journal';
1152         } elsif ( $genre eq 'journalArticle' ) {
1153             $mtx   = 'journal';
1154             $genre = 'article';
1155         } else {
1156             $mtx = 'dc';
1157         }
1158
1159         $genre = ( $mtx eq 'dc' ) ? "&amp;rft.type=$genre" : "&amp;rft.genre=$genre";
1160
1161         # Setting datas
1162         $aulast  = $record->subfield( '700', 'a' );
1163         $aufirst = $record->subfield( '700', 'b' );
1164         $oauthors = "&amp;rft.au=$aufirst $aulast";
1165
1166         # others authors
1167         if ( $record->field('200') ) {
1168             for my $au ( $record->field('200')->subfield('g') ) {
1169                 $oauthors .= "&amp;rft.au=$au";
1170             }
1171         }
1172         $title =
1173           ( $mtx eq 'dc' )
1174           ? "&amp;rft.title=" . $record->subfield( '200', 'a' )
1175           : "&amp;rft.title=" . $record->subfield( '200', 'a' ) . "&amp;rft.btitle=" . $record->subfield( '200', 'a' );
1176         $pubyear   = $record->subfield( '210', 'd' );
1177         $publisher = $record->subfield( '210', 'c' );
1178         $isbn      = $record->subfield( '010', 'a' );
1179         $issn      = $record->subfield( '011', 'a' );
1180     } else {
1181
1182         # MARC21 need some improve
1183         my $fmts;
1184         $mtx   = 'book';
1185         $genre = "&amp;rft.genre=book";
1186
1187         # Setting datas
1188         if ( $record->field('100') ) {
1189             $oauthors .= "&amp;rft.au=" . $record->subfield( '100', 'a' );
1190         }
1191
1192         # others authors
1193         if ( $record->field('700') ) {
1194             for my $au ( $record->field('700')->subfield('a') ) {
1195                 $oauthors .= "&amp;rft.au=$au";
1196             }
1197         }
1198         $title = "&amp;rft.btitle=" . $record->subfield( '245', 'a' );
1199         $subtitle = $record->subfield( '245', 'b' ) || '';
1200         $title .= $subtitle;
1201         $pubyear   = $record->subfield( '260', 'c' ) || '';
1202         $publisher = $record->subfield( '260', 'b' ) || '';
1203         $isbn      = $record->subfield( '020', 'a' ) || '';
1204         $issn      = $record->subfield( '022', 'a' ) || '';
1205
1206     }
1207     my $coins_value =
1208 "ctx_ver=Z39.88-2004&amp;rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3A$mtx$genre$title&amp;rft.isbn=$isbn&amp;rft.issn=$issn&amp;rft.aulast=$aulast&amp;rft.aufirst=$aufirst$oauthors&amp;rft.pub=$publisher&amp;rft.date=$pubyear";
1209     $coins_value =~ s/(\ |&[^a])/\+/g;
1210     $coins_value =~ s/\"/\&quot\;/g;
1211
1212 #<!-- TMPL_VAR NAME="ocoins_format" -->&amp;rft.au=<!-- TMPL_VAR NAME="author" -->&amp;rft.btitle=<!-- TMPL_VAR NAME="title" -->&amp;rft.date=<!-- TMPL_VAR NAME="publicationyear" -->&amp;rft.pages=<!-- TMPL_VAR NAME="pages" -->&amp;rft.isbn=<!-- TMPL_VAR NAME=amazonisbn -->&amp;rft.aucorp=&amp;rft.place=<!-- TMPL_VAR NAME="place" -->&amp;rft.pub=<!-- TMPL_VAR NAME="publishercode" -->&amp;rft.edition=<!-- TMPL_VAR NAME="edition" -->&amp;rft.series=<!-- TMPL_VAR NAME="series" -->&amp;rft.genre="
1213
1214     return $coins_value;
1215 }
1216
1217 =head2 GetAuthorisedValueDesc
1218
1219   my $subfieldvalue =get_authorised_value_desc(
1220     $tag, $subf[$i][0],$subf[$i][1], '', $taglib, $category, $opac);
1221
1222 Retrieve the complete description for a given authorised value.
1223
1224 Now takes $category and $value pair too.
1225
1226   my $auth_value_desc =GetAuthorisedValueDesc(
1227     '','', 'DVD' ,'','','CCODE');
1228
1229 If the optional $opac parameter is set to a true value, displays OPAC 
1230 descriptions rather than normal ones when they exist.
1231
1232 =cut
1233
1234 sub GetAuthorisedValueDesc {
1235     my ( $tag, $subfield, $value, $framework, $tagslib, $category, $opac ) = @_;
1236     my $dbh = C4::Context->dbh;
1237
1238     if ( !$category ) {
1239
1240         return $value unless defined $tagslib->{$tag}->{$subfield}->{'authorised_value'};
1241
1242         #---- branch
1243         if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
1244             return C4::Branch::GetBranchName($value);
1245         }
1246
1247         #---- itemtypes
1248         if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "itemtypes" ) {
1249             return getitemtypeinfo($value)->{description};
1250         }
1251
1252         #---- "true" authorized value
1253         $category = $tagslib->{$tag}->{$subfield}->{'authorised_value'};
1254     }
1255
1256     if ( $category ne "" ) {
1257         my $sth = $dbh->prepare( "SELECT lib, lib_opac FROM authorised_values WHERE category = ? AND authorised_value = ?" );
1258         $sth->execute( $category, $value );
1259         my $data = $sth->fetchrow_hashref;
1260         return ( $opac && $data->{'lib_opac'} ) ? $data->{'lib_opac'} : $data->{'lib'};
1261     } else {
1262         return $value;    # if nothing is found return the original value
1263     }
1264 }
1265
1266 =head2 GetMarcControlnumber
1267
1268   $marccontrolnumber = GetMarcControlnumber($record,$marcflavour);
1269
1270 Get the control number / record Identifier from the MARC record and return it.
1271
1272 =cut
1273
1274 sub GetMarcControlnumber {
1275     my ( $record, $marcflavour ) = @_;
1276     my $controlnumber = "";
1277     # Control number or Record identifier are the same field in MARC21 and UNIMARC
1278     # Keep $marcflavour for possible later use
1279     if ($marcflavour eq "MARC21" || $marcflavour eq "UNIMARC") {
1280         my $controlnumberField = $record->field('001');
1281         if ($controlnumberField) {
1282             $controlnumber = $controlnumberField->data();
1283         }
1284     }
1285     return $controlnumber;
1286 }
1287
1288 =head2 GetMarcISBN
1289
1290   $marcisbnsarray = GetMarcISBN( $record, $marcflavour );
1291
1292 Get all ISBNs from the MARC record and returns them in an array.
1293 ISBNs stored in differents places depending on MARC flavour
1294
1295 =cut
1296
1297 sub GetMarcISBN {
1298     my ( $record, $marcflavour ) = @_;
1299     my $scope;
1300     if ( $marcflavour eq "MARC21" ) {
1301         $scope = '020';
1302     } else {    # assume unimarc if not marc21
1303         $scope = '010';
1304     }
1305     my @marcisbns;
1306     my $isbn = "";
1307     my $tag  = "";
1308     my $marcisbn;
1309     foreach my $field ( $record->field($scope) ) {
1310         my $value = $field->as_string();
1311         if ( $isbn ne "" ) {
1312             $marcisbn = { marcisbn => $isbn, };
1313             push @marcisbns, $marcisbn;
1314             $isbn = $value;
1315         }
1316         if ( $isbn ne $value ) {
1317             $isbn = $isbn . " " . $value;
1318         }
1319     }
1320
1321     if ($isbn) {
1322         $marcisbn = { marcisbn => $isbn };
1323         push @marcisbns, $marcisbn;    #load last tag into array
1324     }
1325     return \@marcisbns;
1326 }    # end GetMarcISBN
1327
1328 =head2 GetMarcNotes
1329
1330   $marcnotesarray = GetMarcNotes( $record, $marcflavour );
1331
1332 Get all notes from the MARC record and returns them in an array.
1333 The note are stored in differents places depending on MARC flavour
1334
1335 =cut
1336
1337 sub GetMarcNotes {
1338     my ( $record, $marcflavour ) = @_;
1339     my $scope;
1340     if ( $marcflavour eq "MARC21" ) {
1341         $scope = '5..';
1342     } else {    # assume unimarc if not marc21
1343         $scope = '3..';
1344     }
1345     my @marcnotes;
1346     my $note = "";
1347     my $tag  = "";
1348     my $marcnote;
1349     foreach my $field ( $record->field($scope) ) {
1350         my $value = $field->as_string();
1351         if ( $note ne "" ) {
1352             $marcnote = { marcnote => $note, };
1353             push @marcnotes, $marcnote;
1354             $note = $value;
1355         }
1356         if ( $note ne $value ) {
1357             $note = $note . " " . $value;
1358         }
1359     }
1360
1361     if ($note) {
1362         $marcnote = { marcnote => $note };
1363         push @marcnotes, $marcnote;    #load last tag into array
1364     }
1365     return \@marcnotes;
1366 }    # end GetMarcNotes
1367
1368 =head2 GetMarcSubjects
1369
1370   $marcsubjcts = GetMarcSubjects($record,$marcflavour);
1371
1372 Get all subjects from the MARC record and returns them in an array.
1373 The subjects are stored in differents places depending on MARC flavour
1374
1375 =cut
1376
1377 sub GetMarcSubjects {
1378     my ( $record, $marcflavour ) = @_;
1379     my ( $mintag, $maxtag );
1380     if ( $marcflavour eq "MARC21" ) {
1381         $mintag = "600";
1382         $maxtag = "699";
1383     } else {    # assume unimarc if not marc21
1384         $mintag = "600";
1385         $maxtag = "611";
1386     }
1387
1388     my @marcsubjects;
1389     my $subject  = "";
1390     my $subfield = "";
1391     my $marcsubject;
1392
1393     foreach my $field ( $record->field('6..') ) {
1394         next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1395         my @subfields_loop;
1396         my @subfields = $field->subfields();
1397         my $counter   = 0;
1398         my @link_loop;
1399
1400         # if there is an authority link, build the link with an= subfield9
1401         my $found9 = 0;
1402         for my $subject_subfield (@subfields) {
1403
1404             # don't load unimarc subfields 3,4,5
1405             next if ( ( $marcflavour eq "UNIMARC" ) and ( $subject_subfield->[0] =~ /2|3|4|5/ ) );
1406
1407             # don't load MARC21 subfields 2 (FIXME: any more subfields??)
1408             next if ( ( $marcflavour eq "MARC21" ) and ( $subject_subfield->[0] =~ /2/ ) );
1409             my $code      = $subject_subfield->[0];
1410             my $value     = $subject_subfield->[1];
1411             my $linkvalue = $value;
1412             $linkvalue =~ s/(\(|\))//g;
1413             my $operator = " and " unless $counter == 0;
1414             if ( $code eq 9 ) {
1415                 $found9 = 1;
1416                 @link_loop = ( { 'limit' => 'an', link => "$linkvalue" } );
1417             }
1418             if ( not $found9 ) {
1419                 push @link_loop, { 'limit' => 'su', link => $linkvalue, operator => $operator };
1420             }
1421             my $separator = C4::Context->preference("authoritysep") unless $counter == 0;
1422
1423             # ignore $9
1424             my @this_link_loop = @link_loop;
1425             push @subfields_loop, { code => $code, value => $value, link_loop => \@this_link_loop, separator => $separator } unless ( $subject_subfield->[0] eq 9 );
1426             $counter++;
1427         }
1428
1429         push @marcsubjects, { MARCSUBJECT_SUBFIELDS_LOOP => \@subfields_loop };
1430
1431     }
1432     return \@marcsubjects;
1433 }    #end getMARCsubjects
1434
1435 =head2 GetMarcAuthors
1436
1437   authors = GetMarcAuthors($record,$marcflavour);
1438
1439 Get all authors from the MARC record and returns them in an array.
1440 The authors are stored in differents places depending on MARC flavour
1441
1442 =cut
1443
1444 sub GetMarcAuthors {
1445     my ( $record, $marcflavour ) = @_;
1446     my ( $mintag, $maxtag );
1447
1448     # tagslib useful for UNIMARC author reponsabilities
1449     my $tagslib =
1450       &GetMarcStructure( 1, '' );    # FIXME : we don't have the framework available, we take the default framework. May be buggy on some setups, will be usually correct.
1451     if ( $marcflavour eq "MARC21" ) {
1452         $mintag = "700";
1453         $maxtag = "720";
1454     } elsif ( $marcflavour eq "UNIMARC" ) {    # assume unimarc if not marc21
1455         $mintag = "700";
1456         $maxtag = "712";
1457     } else {
1458         return;
1459     }
1460     my @marcauthors;
1461
1462     foreach my $field ( $record->fields ) {
1463         next unless $field->tag() >= $mintag && $field->tag() <= $maxtag;
1464         my @subfields_loop;
1465         my @link_loop;
1466         my @subfields  = $field->subfields();
1467         my $count_auth = 0;
1468
1469         # if there is an authority link, build the link with Koha-Auth-Number: subfield9
1470         my $subfield9 = $field->subfield('9');
1471         for my $authors_subfield (@subfields) {
1472
1473             # don't load unimarc subfields 3, 5
1474             next if ( $marcflavour eq 'UNIMARC' and ( $authors_subfield->[0] =~ /3|5/ ) );
1475             my $subfieldcode = $authors_subfield->[0];
1476             my $value        = $authors_subfield->[1];
1477             my $linkvalue    = $value;
1478             $linkvalue =~ s/(\(|\))//g;
1479             my $operator = " and " unless $count_auth == 0;
1480
1481             # if we have an authority link, use that as the link, otherwise use standard searching
1482             if ($subfield9) {
1483                 @link_loop = ( { 'limit' => 'an', link => "$subfield9" } );
1484             } else {
1485
1486                 # reset $linkvalue if UNIMARC author responsibility
1487                 if ( $marcflavour eq 'UNIMARC' and ( $authors_subfield->[0] eq "4" ) ) {
1488                     $linkvalue = "(" . GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib ) . ")";
1489                 }
1490                 push @link_loop, { 'limit' => 'au', link => $linkvalue, operator => $operator };
1491             }
1492             $value = GetAuthorisedValueDesc( $field->tag(), $authors_subfield->[0], $authors_subfield->[1], '', $tagslib )
1493               if ( $marcflavour eq 'UNIMARC' and ( $authors_subfield->[0] =~ /4/ ) );
1494             my @this_link_loop = @link_loop;
1495             my $separator = C4::Context->preference("authoritysep") unless $count_auth == 0;
1496             push @subfields_loop, { code => $subfieldcode, value => $value, link_loop => \@this_link_loop, separator => $separator } unless ( $authors_subfield->[0] eq '9' );
1497             $count_auth++;
1498         }
1499         push @marcauthors, { MARCAUTHOR_SUBFIELDS_LOOP => \@subfields_loop };
1500     }
1501     return \@marcauthors;
1502 }
1503
1504 =head2 GetMarcUrls
1505
1506   $marcurls = GetMarcUrls($record,$marcflavour);
1507
1508 Returns arrayref of URLs from MARC data, suitable to pass to tmpl loop.
1509 Assumes web resources (not uncommon in MARC21 to omit resource type ind) 
1510
1511 =cut
1512
1513 sub GetMarcUrls {
1514     my ( $record, $marcflavour ) = @_;
1515
1516     my @marcurls;
1517     for my $field ( $record->field('856') ) {
1518         my @notes;
1519         for my $note ( $field->subfield('z') ) {
1520             push @notes, { note => $note };
1521         }
1522         my @urls = $field->subfield('u');
1523         foreach my $url (@urls) {
1524             my $marcurl;
1525             if ( $marcflavour eq 'MARC21' ) {
1526                 my $s3   = $field->subfield('3');
1527                 my $link = $field->subfield('y');
1528                 unless ( $url =~ /^\w+:/ ) {
1529                     if ( $field->indicator(1) eq '7' ) {
1530                         $url = $field->subfield('2') . "://" . $url;
1531                     } elsif ( $field->indicator(1) eq '1' ) {
1532                         $url = 'ftp://' . $url;
1533                     } else {
1534
1535                         #  properly, this should be if ind1=4,
1536                         #  however we will assume http protocol since we're building a link.
1537                         $url = 'http://' . $url;
1538                     }
1539                 }
1540
1541                 # TODO handle ind 2 (relationship)
1542                 $marcurl = {
1543                     MARCURL => $url,
1544                     notes   => \@notes,
1545                 };
1546                 $marcurl->{'linktext'} = $link || $s3 || C4::Context->preference('URLLinkText') || $url;
1547                 $marcurl->{'part'} = $s3 if ($link);
1548                 $marcurl->{'toc'} = 1 if ( defined($s3) && $s3 =~ /^[Tt]able/ );
1549             } else {
1550                 $marcurl->{'linktext'} = $field->subfield('2') || C4::Context->preference('URLLinkText') || $url;
1551                 $marcurl->{'MARCURL'} = $url;
1552             }
1553             push @marcurls, $marcurl;
1554         }
1555     }
1556     return \@marcurls;
1557 }
1558
1559 =head2 GetMarcSeries
1560
1561   $marcseriesarray = GetMarcSeries($record,$marcflavour);
1562
1563 Get all series from the MARC record and returns them in an array.
1564 The series are stored in differents places depending on MARC flavour
1565
1566 =cut
1567
1568 sub GetMarcSeries {
1569     my ( $record, $marcflavour ) = @_;
1570     my ( $mintag, $maxtag );
1571     if ( $marcflavour eq "MARC21" ) {
1572         $mintag = "440";
1573         $maxtag = "490";
1574     } else {    # assume unimarc if not marc21
1575         $mintag = "600";
1576         $maxtag = "619";
1577     }
1578
1579     my @marcseries;
1580     my $subjct   = "";
1581     my $subfield = "";
1582     my $marcsubjct;
1583
1584     foreach my $field ( $record->field('440'), $record->field('490') ) {
1585         my @subfields_loop;
1586
1587         #my $value = $field->subfield('a');
1588         #$marcsubjct = {MARCSUBJCT => $value,};
1589         my @subfields = $field->subfields();
1590
1591         #warn "subfields:".join " ", @$subfields;
1592         my $counter = 0;
1593         my @link_loop;
1594         for my $series_subfield (@subfields) {
1595             my $volume_number;
1596             undef $volume_number;
1597
1598             # see if this is an instance of a volume
1599             if ( $series_subfield->[0] eq 'v' ) {
1600                 $volume_number = 1;
1601             }
1602
1603             my $code      = $series_subfield->[0];
1604             my $value     = $series_subfield->[1];
1605             my $linkvalue = $value;
1606             $linkvalue =~ s/(\(|\))//g;
1607             my $operator = " and " unless $counter == 0;
1608             push @link_loop, { link => $linkvalue, operator => $operator };
1609             my $separator = C4::Context->preference("authoritysep") unless $counter == 0;
1610             if ($volume_number) {
1611                 push @subfields_loop, { volumenum => $value };
1612             } else {
1613                 push @subfields_loop, { code => $code, value => $value, link_loop => \@link_loop, separator => $separator, volumenum => $volume_number };
1614             }
1615             $counter++;
1616         }
1617         push @marcseries, { MARCSERIES_SUBFIELDS_LOOP => \@subfields_loop };
1618
1619         #$marcsubjct = {MARCSUBJCT => $field->as_string(),};
1620         #push @marcsubjcts, $marcsubjct;
1621         #$subjct = $value;
1622
1623     }
1624     my $marcseriessarray = \@marcseries;
1625     return $marcseriessarray;
1626 }    #end getMARCseriess
1627
1628 =head2 GetFrameworkCode
1629
1630   $frameworkcode = GetFrameworkCode( $biblionumber )
1631
1632 =cut
1633
1634 sub GetFrameworkCode {
1635     my ($biblionumber) = @_;
1636     my $dbh            = C4::Context->dbh;
1637     my $sth            = $dbh->prepare("SELECT frameworkcode FROM biblio WHERE biblionumber=?");
1638     $sth->execute($biblionumber);
1639     my ($frameworkcode) = $sth->fetchrow;
1640     return $frameworkcode;
1641 }
1642
1643 =head2 TransformKohaToMarc
1644
1645     $record = TransformKohaToMarc( $hash )
1646
1647 This function builds partial MARC::Record from a hash
1648 Hash entries can be from biblio or biblioitems.
1649
1650 This function is called in acquisition module, to create a basic catalogue entry from user entry
1651
1652 =cut
1653
1654 sub TransformKohaToMarc {
1655     my ($hash) = @_;
1656     my $sth    = C4::Context->dbh->prepare( "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?" );
1657     my $record = MARC::Record->new();
1658     SetMarcUnicodeFlag( $record, C4::Context->preference("marcflavour") );
1659     foreach ( keys %{$hash} ) {
1660         &TransformKohaToMarcOneField( $sth, $record, $_, $hash->{$_}, '' );
1661     }
1662     return $record;
1663 }
1664
1665 =head2 TransformKohaToMarcOneField
1666
1667     $record = TransformKohaToMarcOneField( $sth, $record, $kohafieldname, $value, $frameworkcode );
1668
1669 =cut
1670
1671 sub TransformKohaToMarcOneField {
1672     my ( $sth, $record, $kohafieldname, $value, $frameworkcode ) = @_;
1673     $frameworkcode = '' unless $frameworkcode;
1674     my $tagfield;
1675     my $tagsubfield;
1676
1677     if ( !defined $sth ) {
1678         my $dbh = C4::Context->dbh;
1679         $sth = $dbh->prepare( "SELECT tagfield,tagsubfield FROM marc_subfield_structure WHERE frameworkcode=? AND kohafield=?" );
1680     }
1681     $sth->execute( $frameworkcode, $kohafieldname );
1682     if ( ( $tagfield, $tagsubfield ) = $sth->fetchrow ) {
1683         my $tag = $record->field($tagfield);
1684         if ($tag) {
1685             $tag->update( $tagsubfield => $value );
1686             $record->delete_field($tag);
1687             $record->insert_fields_ordered($tag);
1688         } else {
1689             $record->add_fields( $tagfield, " ", " ", $tagsubfield => $value );
1690         }
1691     }
1692     return $record;
1693 }
1694
1695 =head2 TransformHtmlToXml
1696
1697   $xml = TransformHtmlToXml( $tags, $subfields, $values, $indicator, 
1698                              $ind_tag, $auth_type )
1699
1700 $auth_type contains :
1701
1702 =over
1703
1704 =item - nothing : rebuild a biblio. In UNIMARC the encoding is in 100$a pos 26/27
1705
1706 =item - UNIMARCAUTH : rebuild an authority. In UNIMARC, the encoding is in 100$a pos 13/14
1707
1708 =item - ITEM : rebuild an item : in UNIMARC, 100$a, it's in the biblio ! (otherwise, we would get 2 100 fields !)
1709
1710 =back
1711
1712 =cut
1713
1714 sub TransformHtmlToXml {
1715     my ( $tags, $subfields, $values, $indicator, $ind_tag, $auth_type ) = @_;
1716     my $xml = MARC::File::XML::header('UTF-8');
1717     $xml .= "<record>\n";
1718     $auth_type = C4::Context->preference('marcflavour') unless $auth_type;
1719     MARC::File::XML->default_record_format($auth_type);
1720
1721     # in UNIMARC, field 100 contains the encoding
1722     # check that there is one, otherwise the
1723     # MARC::Record->new_from_xml will fail (and Koha will die)
1724     my $unimarc_and_100_exist = 0;
1725     $unimarc_and_100_exist = 1 if $auth_type eq 'ITEM';    # if we rebuild an item, no need of a 100 field
1726     my $prevvalue;
1727     my $prevtag = -1;
1728     my $first   = 1;
1729     my $j       = -1;
1730     for ( my $i = 0 ; $i < @$tags ; $i++ ) {
1731
1732         if ( C4::Context->preference('marcflavour') eq 'UNIMARC' and @$tags[$i] eq "100" and @$subfields[$i] eq "a" ) {
1733
1734             # if we have a 100 field and it's values are not correct, skip them.
1735             # if we don't have any valid 100 field, we will create a default one at the end
1736             my $enc = substr( @$values[$i], 26, 2 );
1737             if ( $enc eq '01' or $enc eq '50' or $enc eq '03' ) {
1738                 $unimarc_and_100_exist = 1;
1739             } else {
1740                 next;
1741             }
1742         }
1743         @$values[$i] =~ s/&/&amp;/g;
1744         @$values[$i] =~ s/</&lt;/g;
1745         @$values[$i] =~ s/>/&gt;/g;
1746         @$values[$i] =~ s/"/&quot;/g;
1747         @$values[$i] =~ s/'/&apos;/g;
1748
1749         #         if ( !utf8::is_utf8( @$values[$i] ) ) {
1750         #             utf8::decode( @$values[$i] );
1751         #         }
1752         if ( ( @$tags[$i] ne $prevtag ) ) {
1753             $j++ unless ( @$tags[$i] eq "" );
1754             my $indicator1 = eval { substr( @$indicator[$j], 0, 1 ) };
1755             my $indicator2 = eval { substr( @$indicator[$j], 1, 1 ) };
1756             my $ind1       = _default_ind_to_space($indicator1);
1757             my $ind2;
1758             if ( @$indicator[$j] ) {
1759                 $ind2 = _default_ind_to_space($indicator2);
1760             } else {
1761                 warn "Indicator in @$tags[$i] is empty";
1762                 $ind2 = " ";
1763             }
1764             if ( !$first ) {
1765                 $xml .= "</datafield>\n";
1766                 if (   ( @$tags[$i] && @$tags[$i] > 10 )
1767                     && ( @$values[$i] ne "" ) ) {
1768                     $xml .= "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1769                     $xml .= "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1770                     $first = 0;
1771                 } else {
1772                     $first = 1;
1773                 }
1774             } else {
1775                 if ( @$values[$i] ne "" ) {
1776
1777                     # leader
1778                     if ( @$tags[$i] eq "000" ) {
1779                         $xml .= "<leader>@$values[$i]</leader>\n";
1780                         $first = 1;
1781
1782                         # rest of the fixed fields
1783                     } elsif ( @$tags[$i] < 10 ) {
1784                         $xml .= "<controlfield tag=\"@$tags[$i]\">@$values[$i]</controlfield>\n";
1785                         $first = 1;
1786                     } else {
1787                         $xml .= "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1788                         $xml .= "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1789                         $first = 0;
1790                     }
1791                 }
1792             }
1793         } else {    # @$tags[$i] eq $prevtag
1794             my $indicator1 = eval { substr( @$indicator[$j], 0, 1 ) };
1795             my $indicator2 = eval { substr( @$indicator[$j], 1, 1 ) };
1796             my $ind1       = _default_ind_to_space($indicator1);
1797             my $ind2;
1798             if ( @$indicator[$j] ) {
1799                 $ind2 = _default_ind_to_space($indicator2);
1800             } else {
1801                 warn "Indicator in @$tags[$i] is empty";
1802                 $ind2 = " ";
1803             }
1804             if ( @$values[$i] eq "" ) {
1805             } else {
1806                 if ($first) {
1807                     $xml .= "<datafield tag=\"@$tags[$i]\" ind1=\"$ind1\" ind2=\"$ind2\">\n";
1808                     $first = 0;
1809                 }
1810                 $xml .= "<subfield code=\"@$subfields[$i]\">@$values[$i]</subfield>\n";
1811             }
1812         }
1813         $prevtag = @$tags[$i];
1814     }
1815     $xml .= "</datafield>\n" if @$tags > 0;
1816     if ( C4::Context->preference('marcflavour') eq 'UNIMARC' and !$unimarc_and_100_exist ) {
1817
1818         #     warn "SETTING 100 for $auth_type";
1819         my $string = strftime( "%Y%m%d", localtime(time) );
1820
1821         # set 50 to position 26 is biblios, 13 if authorities
1822         my $pos = 26;
1823         $pos = 13 if $auth_type eq 'UNIMARCAUTH';
1824         $string = sprintf( "%-*s", 35, $string );
1825         substr( $string, $pos, 6, "50" );
1826         $xml .= "<datafield tag=\"100\" ind1=\"\" ind2=\"\">\n";
1827         $xml .= "<subfield code=\"a\">$string</subfield>\n";
1828         $xml .= "</datafield>\n";
1829     }
1830     $xml .= "</record>\n";
1831     $xml .= MARC::File::XML::footer();
1832     return $xml;
1833 }
1834
1835 =head2 _default_ind_to_space
1836
1837 Passed what should be an indicator returns a space
1838 if its undefined or zero length
1839
1840 =cut
1841
1842 sub _default_ind_to_space {
1843     my $s = shift;
1844     if ( !defined $s || $s eq q{} ) {
1845         return ' ';
1846     }
1847     return $s;
1848 }
1849
1850 =head2 TransformHtmlToMarc
1851
1852     L<$record> = TransformHtmlToMarc(L<$params>,L<$cgi>)
1853     L<$params> is a ref to an array as below:
1854     {
1855         'tag_010_indicator1_531951' ,
1856         'tag_010_indicator2_531951' ,
1857         'tag_010_code_a_531951_145735' ,
1858         'tag_010_subfield_a_531951_145735' ,
1859         'tag_200_indicator1_873510' ,
1860         'tag_200_indicator2_873510' ,
1861         'tag_200_code_a_873510_673465' ,
1862         'tag_200_subfield_a_873510_673465' ,
1863         'tag_200_code_b_873510_704318' ,
1864         'tag_200_subfield_b_873510_704318' ,
1865         'tag_200_code_e_873510_280822' ,
1866         'tag_200_subfield_e_873510_280822' ,
1867         'tag_200_code_f_873510_110730' ,
1868         'tag_200_subfield_f_873510_110730' ,
1869     }
1870     L<$cgi> is the CGI object which containts the value.
1871     L<$record> is the MARC::Record object.
1872
1873 =cut
1874
1875 sub TransformHtmlToMarc {
1876     my $params = shift;
1877     my $cgi    = shift;
1878
1879     # explicitly turn on the UTF-8 flag for all
1880     # 'tag_' parameters to avoid incorrect character
1881     # conversion later on
1882     my $cgi_params = $cgi->Vars;
1883     foreach my $param_name ( keys %$cgi_params ) {
1884         if ( $param_name =~ /^tag_/ ) {
1885             my $param_value = $cgi_params->{$param_name};
1886             if ( utf8::decode($param_value) ) {
1887                 $cgi_params->{$param_name} = $param_value;
1888             }
1889
1890             # FIXME - need to do something if string is not valid UTF-8
1891         }
1892     }
1893
1894     # creating a new record
1895     my $record = MARC::Record->new();
1896     my $i      = 0;
1897     my @fields;
1898     while ( $params->[$i] ) {    # browse all CGI params
1899         my $param    = $params->[$i];
1900         my $newfield = 0;
1901
1902         # if we are on biblionumber, store it in the MARC::Record (it may not be in the edited fields)
1903         if ( $param eq 'biblionumber' ) {
1904             my ( $biblionumbertagfield, $biblionumbertagsubfield ) = &GetMarcFromKohaField( "biblio.biblionumber", '' );
1905             if ( $biblionumbertagfield < 10 ) {
1906                 $newfield = MARC::Field->new( $biblionumbertagfield, $cgi->param($param), );
1907             } else {
1908                 $newfield = MARC::Field->new( $biblionumbertagfield, '', '', "$biblionumbertagsubfield" => $cgi->param($param), );
1909             }
1910             push @fields, $newfield if ($newfield);
1911         } elsif ( $param =~ /^tag_(\d*)_indicator1_/ ) {    # new field start when having 'input name="..._indicator1_..."
1912             my $tag = $1;
1913
1914             my $ind1 = _default_ind_to_space( substr( $cgi->param($param), 0, 1 ) );
1915             my $ind2 = _default_ind_to_space( substr( $cgi->param( $params->[ $i + 1 ] ), 0, 1 ) );
1916             $newfield = 0;
1917             my $j = $i + 2;
1918
1919             if ( $tag < 10 ) {                              # no code for theses fields
1920                                                             # in MARC editor, 000 contains the leader.
1921                 if ( $tag eq '000' ) {
1922                     $record->leader( $cgi->param( $params->[ $j + 1 ] ) ) if length( $cgi->param( $params->[ $j + 1 ] ) ) == 24;
1923
1924                     # between 001 and 009 (included)
1925                 } elsif ( $cgi->param( $params->[ $j + 1 ] ) ne '' ) {
1926                     $newfield = MARC::Field->new( $tag, $cgi->param( $params->[ $j + 1 ] ), );
1927                 }
1928
1929                 # > 009, deal with subfields
1930             } else {
1931                 while ( defined $params->[$j] && $params->[$j] =~ /_code_/ ) {    # browse all it's subfield
1932                     my $inner_param = $params->[$j];
1933                     if ($newfield) {
1934                         if ( $cgi->param( $params->[ $j + 1 ] ) ne '' ) {         # only if there is a value (code => value)
1935                             $newfield->add_subfields( $cgi->param($inner_param) => $cgi->param( $params->[ $j + 1 ] ) );
1936                         }
1937                     } else {
1938                         if ( $cgi->param( $params->[ $j + 1 ] ) ne '' ) {         # creating only if there is a value (code => value)
1939                             $newfield = MARC::Field->new( $tag, $ind1, $ind2, $cgi->param($inner_param) => $cgi->param( $params->[ $j + 1 ] ), );
1940                         }
1941                     }
1942                     $j += 2;
1943                 }
1944             }
1945             push @fields, $newfield if ($newfield);
1946         }
1947         $i++;
1948     }
1949
1950     $record->append_fields(@fields);
1951     return $record;
1952 }
1953
1954 # cache inverted MARC field map
1955 our $inverted_field_map;
1956
1957 =head2 TransformMarcToKoha
1958
1959   $result = TransformMarcToKoha( $dbh, $record, $frameworkcode )
1960
1961 Extract data from a MARC bib record into a hashref representing
1962 Koha biblio, biblioitems, and items fields. 
1963
1964 =cut
1965
1966 sub TransformMarcToKoha {
1967     my ( $dbh, $record, $frameworkcode, $limit_table ) = @_;
1968
1969     my $result;
1970     $limit_table = $limit_table || 0;
1971     $frameworkcode = '' unless defined $frameworkcode;
1972
1973     unless ( defined $inverted_field_map ) {
1974         $inverted_field_map = _get_inverted_marc_field_map();
1975     }
1976
1977     my %tables = ();
1978     if ( defined $limit_table && $limit_table eq 'items' ) {
1979         $tables{'items'} = 1;
1980     } else {
1981         $tables{'items'}       = 1;
1982         $tables{'biblio'}      = 1;
1983         $tables{'biblioitems'} = 1;
1984     }
1985
1986     # traverse through record
1987   MARCFIELD: foreach my $field ( $record->fields() ) {
1988         my $tag = $field->tag();
1989         next MARCFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag};
1990         if ( $field->is_control_field() ) {
1991             my $kohafields = $inverted_field_map->{$frameworkcode}->{$tag}->{list};
1992           ENTRY: foreach my $entry ( @{$kohafields} ) {
1993                 my ( $subfield, $table, $column ) = @{$entry};
1994                 next ENTRY unless exists $tables{$table};
1995                 my $key = _disambiguate( $table, $column );
1996                 if ( $result->{$key} ) {
1997                     unless ( ( $key eq "biblionumber" or $key eq "biblioitemnumber" ) and ( $field->data() eq "" ) ) {
1998                         $result->{$key} .= " | " . $field->data();
1999                     }
2000                 } else {
2001                     $result->{$key} = $field->data();
2002                 }
2003             }
2004         } else {
2005
2006             # deal with subfields
2007           MARCSUBFIELD: foreach my $sf ( $field->subfields() ) {
2008                 my $code = $sf->[0];
2009                 next MARCSUBFIELD unless exists $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code};
2010                 my $value = $sf->[1];
2011               SFENTRY: foreach my $entry ( @{ $inverted_field_map->{$frameworkcode}->{$tag}->{sfs}->{$code} } ) {
2012                     my ( $table, $column ) = @{$entry};
2013                     next SFENTRY unless exists $tables{$table};
2014                     my $key = _disambiguate( $table, $column );
2015                     if ( $result->{$key} ) {
2016                         unless ( ( $key eq "biblionumber" or $key eq "biblioitemnumber" ) and ( $value eq "" ) ) {
2017                             $result->{$key} .= " | " . $value;
2018                         }
2019                     } else {
2020                         $result->{$key} = $value;
2021                     }
2022                 }
2023             }
2024         }
2025     }
2026
2027     # modify copyrightdate to keep only the 1st year found
2028     if ( exists $result->{'copyrightdate'} ) {
2029         my $temp = $result->{'copyrightdate'};
2030         $temp =~ m/c(\d\d\d\d)/;
2031         if ( $temp =~ m/c(\d\d\d\d)/ and $1 > 0 ) {    # search cYYYY first
2032             $result->{'copyrightdate'} = $1;
2033         } else {                                       # if no cYYYY, get the 1st date.
2034             $temp =~ m/(\d\d\d\d)/;
2035             $result->{'copyrightdate'} = $1;
2036         }
2037     }
2038
2039     # modify publicationyear to keep only the 1st year found
2040     if ( exists $result->{'publicationyear'} ) {
2041         my $temp = $result->{'publicationyear'};
2042         if ( $temp =~ m/c(\d\d\d\d)/ and $1 > 0 ) {    # search cYYYY first
2043             $result->{'publicationyear'} = $1;
2044         } else {                                       # if no cYYYY, get the 1st date.
2045             $temp =~ m/(\d\d\d\d)/;
2046             $result->{'publicationyear'} = $1;
2047         }
2048     }
2049
2050     return $result;
2051 }
2052
2053 sub _get_inverted_marc_field_map {
2054     my $field_map = {};
2055     my $relations = C4::Context->marcfromkohafield;
2056
2057     foreach my $frameworkcode ( keys %{$relations} ) {
2058         foreach my $kohafield ( keys %{ $relations->{$frameworkcode} } ) {
2059             next unless @{ $relations->{$frameworkcode}->{$kohafield} };    # not all columns are mapped to MARC tag & subfield
2060             my $tag      = $relations->{$frameworkcode}->{$kohafield}->[0];
2061             my $subfield = $relations->{$frameworkcode}->{$kohafield}->[1];
2062             my ( $table, $column ) = split /[.]/, $kohafield, 2;
2063             push @{ $field_map->{$frameworkcode}->{$tag}->{list} }, [ $subfield, $table, $column ];
2064             push @{ $field_map->{$frameworkcode}->{$tag}->{sfs}->{$subfield} }, [ $table, $column ];
2065         }
2066     }
2067     return $field_map;
2068 }
2069
2070 =head2 _disambiguate
2071
2072   $newkey = _disambiguate($table, $field);
2073
2074 This is a temporary hack to distinguish between the
2075 following sets of columns when using TransformMarcToKoha.
2076
2077   items.cn_source & biblioitems.cn_source
2078   items.cn_sort & biblioitems.cn_sort
2079
2080 Columns that are currently NOT distinguished (FIXME
2081 due to lack of time to fully test) are:
2082
2083   biblio.notes and biblioitems.notes
2084   biblionumber
2085   timestamp
2086   biblioitemnumber
2087
2088 FIXME - this is necessary because prefixing each column
2089 name with the table name would require changing lots
2090 of code and templates, and exposing more of the DB
2091 structure than is good to the UI templates, particularly
2092 since biblio and bibloitems may well merge in a future
2093 version.  In the future, it would also be good to 
2094 separate DB access and UI presentation field names
2095 more.
2096
2097 =cut
2098
2099 sub CountItemsIssued {
2100     my ($biblionumber) = @_;
2101     my $dbh            = C4::Context->dbh;
2102     my $sth            = $dbh->prepare('SELECT COUNT(*) as issuedCount FROM items, issues WHERE items.itemnumber = issues.itemnumber AND items.biblionumber = ?');
2103     $sth->execute($biblionumber);
2104     my $row = $sth->fetchrow_hashref();
2105     return $row->{'issuedCount'};
2106 }
2107
2108 sub _disambiguate {
2109     my ( $table, $column ) = @_;
2110     if ( $column eq "cn_sort" or $column eq "cn_source" ) {
2111         return $table . '.' . $column;
2112     } else {
2113         return $column;
2114     }
2115
2116 }
2117
2118 =head2 get_koha_field_from_marc
2119
2120   $result->{_disambiguate($table, $field)} = 
2121      get_koha_field_from_marc($table,$field,$record,$frameworkcode);
2122
2123 Internal function to map data from the MARC record to a specific non-MARC field.
2124 FIXME: this is meant to replace TransformMarcToKohaOneField after more testing.
2125
2126 =cut
2127
2128 sub get_koha_field_from_marc {
2129     my ( $koha_table, $koha_column, $record, $frameworkcode ) = @_;
2130     my ( $tagfield, $subfield ) = GetMarcFromKohaField( $koha_table . '.' . $koha_column, $frameworkcode );
2131     my $kohafield;
2132     foreach my $field ( $record->field($tagfield) ) {
2133         if ( $field->tag() < 10 ) {
2134             if ($kohafield) {
2135                 $kohafield .= " | " . $field->data();
2136             } else {
2137                 $kohafield = $field->data();
2138             }
2139         } else {
2140             if ( $field->subfields ) {
2141                 my @subfields = $field->subfields();
2142                 foreach my $subfieldcount ( 0 .. $#subfields ) {
2143                     if ( $subfields[$subfieldcount][0] eq $subfield ) {
2144                         if ($kohafield) {
2145                             $kohafield .= " | " . $subfields[$subfieldcount][1];
2146                         } else {
2147                             $kohafield = $subfields[$subfieldcount][1];
2148                         }
2149                     }
2150                 }
2151             }
2152         }
2153     }
2154     return $kohafield;
2155 }
2156
2157 =head2 TransformMarcToKohaOneField
2158
2159   $result = TransformMarcToKohaOneField( $kohatable, $kohafield, $record, $result, $frameworkcode )
2160
2161 =cut
2162
2163 sub TransformMarcToKohaOneField {
2164
2165     # FIXME ? if a field has a repeatable subfield that is used in old-db,
2166     # only the 1st will be retrieved...
2167     my ( $kohatable, $kohafield, $record, $result, $frameworkcode ) = @_;
2168     my $res = "";
2169     my ( $tagfield, $subfield ) = GetMarcFromKohaField( $kohatable . "." . $kohafield, $frameworkcode );
2170     foreach my $field ( $record->field($tagfield) ) {
2171         if ( $field->tag() < 10 ) {
2172             if ( $result->{$kohafield} ) {
2173                 $result->{$kohafield} .= " | " . $field->data();
2174             } else {
2175                 $result->{$kohafield} = $field->data();
2176             }
2177         } else {
2178             if ( $field->subfields ) {
2179                 my @subfields = $field->subfields();
2180                 foreach my $subfieldcount ( 0 .. $#subfields ) {
2181                     if ( $subfields[$subfieldcount][0] eq $subfield ) {
2182                         if ( $result->{$kohafield} ) {
2183                             $result->{$kohafield} .= " | " . $subfields[$subfieldcount][1];
2184                         } else {
2185                             $result->{$kohafield} = $subfields[$subfieldcount][1];
2186                         }
2187                     }
2188                 }
2189             }
2190         }
2191     }
2192     return $result;
2193 }
2194
2195 =head1  OTHER FUNCTIONS
2196
2197
2198 =head2 PrepareItemrecordDisplay
2199
2200   PrepareItemrecordDisplay($itemrecord,$bibnum,$itemumber,$frameworkcode);
2201
2202 Returns a hash with all the fields for Display a given item data in a template
2203
2204 The $frameworkcode returns the item for the given frameworkcode, ONLY if bibnum is not provided
2205
2206 =cut
2207
2208 sub PrepareItemrecordDisplay {
2209
2210     my ( $bibnum, $itemnum, $defaultvalues, $frameworkcode ) = @_;
2211
2212     my $dbh = C4::Context->dbh;
2213     $frameworkcode = &GetFrameworkCode($bibnum) if $bibnum;
2214     my ( $itemtagfield, $itemtagsubfield ) = &GetMarcFromKohaField( "items.itemnumber", $frameworkcode );
2215     my $tagslib = &GetMarcStructure( 1, $frameworkcode );
2216
2217     # return nothing if we don't have found an existing framework.
2218     return "" unless $tagslib;
2219     my $itemrecord = C4::Items::GetMarcItem( $bibnum, $itemnum ) if ($itemnum);
2220     my @loop_data;
2221     my $authorised_values_sth = $dbh->prepare( "SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib" );
2222     foreach my $tag ( sort keys %{$tagslib} ) {
2223         my $previous_tag = '';
2224         if ( $tag ne '' ) {
2225
2226             # loop through each subfield
2227             my $cntsubf;
2228             foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
2229                 next if ( subfield_is_koha_internal_p($subfield) );
2230                 next if ( $tagslib->{$tag}->{$subfield}->{'tab'} ne "10" );
2231                 my %subfield_data;
2232                 $subfield_data{tag}           = $tag;
2233                 $subfield_data{subfield}      = $subfield;
2234                 $subfield_data{countsubfield} = $cntsubf++;
2235                 $subfield_data{kohafield}     = $tagslib->{$tag}->{$subfield}->{'kohafield'};
2236
2237                 #        $subfield_data{marc_lib}=$tagslib->{$tag}->{$subfield}->{lib};
2238                 $subfield_data{marc_lib}   = $tagslib->{$tag}->{$subfield}->{lib};
2239                 $subfield_data{mandatory}  = $tagslib->{$tag}->{$subfield}->{mandatory};
2240                 $subfield_data{repeatable} = $tagslib->{$tag}->{$subfield}->{repeatable};
2241                 $subfield_data{hidden}     = "display:none"
2242                   if $tagslib->{$tag}->{$subfield}->{hidden};
2243                 my ( $x, $defaultvalue );
2244                 if ($itemrecord) {
2245                     ( $x, $defaultvalue ) = _find_value( $tag, $subfield, $itemrecord );
2246                 }
2247                 $defaultvalue = $tagslib->{$tag}->{$subfield}->{defaultvalue} unless $defaultvalue;
2248                 if ( !defined $defaultvalue ) {
2249                     $defaultvalue = q||;
2250                 }
2251                 $defaultvalue =~ s/"/&quot;/g;
2252
2253                 # search for itemcallnumber if applicable
2254                 if ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2255                     && C4::Context->preference('itemcallnumber') ) {
2256                     my $CNtag      = substr( C4::Context->preference('itemcallnumber'), 0, 3 );
2257                     my $CNsubfield = substr( C4::Context->preference('itemcallnumber'), 3, 1 );
2258                     my $temp = $itemrecord->field($CNtag) if ($itemrecord);
2259                     if ($temp) {
2260                         $defaultvalue = $temp->subfield($CNsubfield);
2261                     }
2262                 }
2263                 if (   $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.itemcallnumber'
2264                     && $defaultvalues
2265                     && $defaultvalues->{'callnumber'} ) {
2266                     my $temp = $itemrecord->field($subfield) if ($itemrecord);
2267                     unless ($temp) {
2268                         $defaultvalue = $defaultvalues->{'callnumber'} if $defaultvalues;
2269                     }
2270                 }
2271                 if (   ( $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.holdingbranch' || $tagslib->{$tag}->{$subfield}->{kohafield} eq 'items.homebranch' )
2272                     && $defaultvalues
2273                     && $defaultvalues->{'branchcode'} ) {
2274                     my $temp = $itemrecord->field($subfield) if ($itemrecord);
2275                     unless ($temp) {
2276                         $defaultvalue = $defaultvalues->{branchcode} if $defaultvalues;
2277                     }
2278                 }
2279                 if ( $tagslib->{$tag}->{$subfield}->{authorised_value} ) {
2280                     my @authorised_values;
2281                     my %authorised_lib;
2282
2283                     # builds list, depending on authorised value...
2284                     #---- branch
2285                     if ( $tagslib->{$tag}->{$subfield}->{'authorised_value'} eq "branches" ) {
2286                         if (   ( C4::Context->preference("IndependantBranches") )
2287                             && ( C4::Context->userenv->{flags} % 2 != 1 ) ) {
2288                             my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches WHERE branchcode = ? ORDER BY branchname" );
2289                             $sth->execute( C4::Context->userenv->{branch} );
2290                             push @authorised_values, ""
2291                               unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2292                             while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2293                                 push @authorised_values, $branchcode;
2294                                 $authorised_lib{$branchcode} = $branchname;
2295                             }
2296                         } else {
2297                             my $sth = $dbh->prepare( "SELECT branchcode,branchname FROM branches ORDER BY branchname" );
2298                             $sth->execute;
2299                             push @authorised_values, ""
2300                               unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2301                             while ( my ( $branchcode, $branchname ) = $sth->fetchrow_array ) {
2302                                 push @authorised_values, $branchcode;
2303                                 $authorised_lib{$branchcode} = $branchname;
2304                             }
2305                         }
2306
2307                         #----- itemtypes
2308                     } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "itemtypes" ) {
2309                         my $sth = $dbh->prepare( "SELECT itemtype,description FROM itemtypes ORDER BY description" );
2310                         $sth->execute;
2311                         push @authorised_values, ""
2312                           unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2313                         while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
2314                             push @authorised_values, $itemtype;
2315                             $authorised_lib{$itemtype} = $description;
2316                         }
2317                         #---- class_sources
2318                     } elsif ( $tagslib->{$tag}->{$subfield}->{authorised_value} eq "cn_source" ) {
2319                         push @authorised_values, "" unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2320
2321                         my $class_sources = GetClassSources();
2322                         my $default_source = C4::Context->preference("DefaultClassificationSource");
2323
2324                         foreach my $class_source (sort keys %$class_sources) {
2325                             next unless $class_sources->{$class_source}->{'used'} or
2326                                         ($class_source eq $default_source);
2327                             push @authorised_values, $class_source;
2328                             $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
2329                         }
2330
2331                         #---- "true" authorised value
2332                     } else {
2333                         $authorised_values_sth->execute( $tagslib->{$tag}->{$subfield}->{authorised_value} );
2334                         push @authorised_values, ""
2335                           unless ( $tagslib->{$tag}->{$subfield}->{mandatory} );
2336                         while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
2337                             push @authorised_values, $value;
2338                             $authorised_lib{$value} = $lib;
2339                         }
2340                     }
2341                     $subfield_data{marc_value} = CGI::scrolling_list(
2342                         -name     => 'field_value',
2343                         -values   => \@authorised_values,
2344                         -default  => "$defaultvalue",
2345                         -labels   => \%authorised_lib,
2346                         -size     => 1,
2347                         -tabindex => '',
2348                         -multiple => 0,
2349                     );
2350                 } else {
2351                     $subfield_data{marc_value} = "<input type=\"text\" name=\"field_value\" value=\"$defaultvalue\" size=\"50\" maxlength=\"255\" />";
2352                 }
2353                 push( @loop_data, \%subfield_data );
2354             }
2355         }
2356     }
2357     my $itemnumber = $itemrecord->subfield( $itemtagfield, $itemtagsubfield )
2358       if ( $itemrecord && $itemrecord->field($itemtagfield) );
2359     return {
2360         'itemtagfield'    => $itemtagfield,
2361         'itemtagsubfield' => $itemtagsubfield,
2362         'itemnumber'      => $itemnumber,
2363         'iteminformation' => \@loop_data
2364     };
2365 }
2366
2367 #"
2368
2369 #
2370 # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2371 # at the same time
2372 # replaced by a zebraqueue table, that is filled with ModZebra to run.
2373 # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2374 # =head2 ModZebrafiles
2375 #
2376 # &ModZebrafiles( $dbh, $biblionumber, $record, $folder, $server );
2377 #
2378 # =cut
2379 #
2380 # sub ModZebrafiles {
2381 #
2382 #     my ( $dbh, $biblionumber, $record, $folder, $server ) = @_;
2383 #
2384 #     my $op;
2385 #     my $zebradir =
2386 #       C4::Context->zebraconfig($server)->{directory} . "/" . $folder . "/";
2387 #     unless ( opendir( DIR, "$zebradir" ) ) {
2388 #         warn "$zebradir not found";
2389 #         return;
2390 #     }
2391 #     closedir DIR;
2392 #     my $filename = $zebradir . $biblionumber;
2393 #
2394 #     if ($record) {
2395 #         open( OUTPUT, ">", $filename . ".xml" );
2396 #         print OUTPUT $record;
2397 #         close OUTPUT;
2398 #     }
2399 # }
2400
2401 =head2 ModZebra
2402
2403   ModZebra( $biblionumber, $op, $server, $oldRecord, $newRecord );
2404
2405 $biblionumber is the biblionumber we want to index
2406
2407 $op is specialUpdate or delete, and is used to know what we want to do
2408
2409 $server is the server that we want to update
2410
2411 $oldRecord is the MARC::Record containing the previous version of the record.  This is used only when 
2412 NoZebra=1, as NoZebra indexing needs to know the previous version of a record in order to
2413 do an update.
2414
2415 $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.
2416
2417 =cut
2418
2419 sub ModZebra {
2420 ###Accepts a $server variable thus we can use it for biblios authorities or other zebra dbs
2421     my ( $biblionumber, $op, $server, $oldRecord, $newRecord ) = @_;
2422     my $dbh = C4::Context->dbh;
2423
2424     # true ModZebra commented until indexdata fixes zebraDB crashes (it seems they occur on multiple updates
2425     # at the same time
2426     # replaced by a zebraqueue table, that is filled with ModZebra to run.
2427     # the table is emptied by misc/cronjobs/zebraqueue_start.pl script
2428
2429     if ( C4::Context->preference("NoZebra") ) {
2430
2431         # lock the nozebra table : we will read index lines, update them in Perl process
2432         # and write everything in 1 transaction.
2433         # lock the table to avoid someone else overwriting what we are doing
2434         $dbh->do('LOCK TABLES nozebra WRITE,biblio WRITE,biblioitems WRITE, systempreferences WRITE, auth_types WRITE, auth_header WRITE, auth_subfield_structure READ');
2435         my %result;    # the result hash that will be built by deletion / add, and written on mySQL at the end, to improve speed
2436         if ( $op eq 'specialUpdate' ) {
2437
2438             # OK, we have to add or update the record
2439             # 1st delete (virtually, in indexes), if record actually exists
2440             if ($oldRecord) {
2441                 %result = _DelBiblioNoZebra( $biblionumber, $oldRecord, $server );
2442             }
2443
2444             # ... add the record
2445             %result = _AddBiblioNoZebra( $biblionumber, $newRecord, $server, %result );
2446         } else {
2447
2448             # it's a deletion, delete the record...
2449             # warn "DELETE the record $biblionumber on $server".$record->as_formatted;
2450             %result = _DelBiblioNoZebra( $biblionumber, $oldRecord, $server );
2451         }
2452
2453         # ok, now update the database...
2454         my $sth = $dbh->prepare("UPDATE nozebra SET biblionumbers=? WHERE server=? AND indexname=? AND value=?");
2455         foreach my $key ( keys %result ) {
2456             foreach my $index ( keys %{ $result{$key} } ) {
2457                 $sth->execute( $result{$key}->{$index}, $server, $key, $index );
2458             }
2459         }
2460         $dbh->do('UNLOCK TABLES');
2461     } else {
2462
2463         #
2464         # we use zebra, just fill zebraqueue table
2465         #
2466         my $check_sql = "SELECT COUNT(*) FROM zebraqueue 
2467                          WHERE server = ?
2468                          AND   biblio_auth_number = ?
2469                          AND   operation = ?
2470                          AND   done = 0";
2471         my $check_sth = $dbh->prepare_cached($check_sql);
2472         $check_sth->execute( $server, $biblionumber, $op );
2473         my ($count) = $check_sth->fetchrow_array;
2474         $check_sth->finish();
2475         if ( $count == 0 ) {
2476             my $sth = $dbh->prepare("INSERT INTO zebraqueue  (biblio_auth_number,server,operation) VALUES(?,?,?)");
2477             $sth->execute( $biblionumber, $server, $op );
2478             $sth->finish;
2479         }
2480     }
2481 }
2482
2483 =head2 GetNoZebraIndexes
2484
2485   %indexes = GetNoZebraIndexes;
2486
2487 return the data from NoZebraIndexes syspref.
2488
2489 =cut
2490
2491 sub GetNoZebraIndexes {
2492     my $no_zebra_indexes = C4::Context->preference('NoZebraIndexes');
2493     my %indexes;
2494   INDEX: foreach my $line ( split /['"],[\n\r]*/, $no_zebra_indexes ) {
2495         $line =~ /(.*)=>(.*)/;
2496         my $index  = $1;    # initial ' or " is removed afterwards
2497         my $fields = $2;
2498         $index  =~ s/'|"|\s//g;
2499         $fields =~ s/'|"|\s//g;
2500         $indexes{$index} = $fields;
2501     }
2502     return %indexes;
2503 }
2504
2505 =head1 INTERNAL FUNCTIONS
2506
2507 =head2 _DelBiblioNoZebra($biblionumber,$record,$server);
2508
2509 function to delete a biblio in NoZebra indexes
2510 This function does NOT delete anything in database : it reads all the indexes entries
2511 that have to be deleted & delete them in the hash
2512
2513 The SQL part is done either :
2514  - after the Add if we are modifying a biblio (delete + add again)
2515  - immediatly after this sub if we are doing a true deletion.
2516
2517 $server can be 'biblioserver' or 'authorityserver' : it indexes biblios or authorities (in the same table, $server being part of the table itself
2518
2519 =cut
2520
2521 sub _DelBiblioNoZebra {
2522     my ( $biblionumber, $record, $server ) = @_;
2523
2524     # Get the indexes
2525     my $dbh = C4::Context->dbh;
2526
2527     # Get the indexes
2528     my %index;
2529     my $title;
2530     if ( $server eq 'biblioserver' ) {
2531         %index = GetNoZebraIndexes;
2532
2533         # get title of the record (to store the 10 first letters with the index)
2534         my ( $titletag, $titlesubfield ) = GetMarcFromKohaField( 'biblio.title', '' );    # FIXME: should be GetFrameworkCode($biblionumber) ??
2535         $title = lc( $record->subfield( $titletag, $titlesubfield ) );
2536     } else {
2537
2538         # for authorities, the "title" is the $a mainentry
2539         my ( $auth_type_tag, $auth_type_sf ) = C4::AuthoritiesMarc::get_auth_type_location();
2540         my $authref = C4::AuthoritiesMarc::GetAuthType( $record->subfield( $auth_type_tag, $auth_type_sf ) );
2541         warn "ERROR : authtype undefined for " . $record->as_formatted unless $authref;
2542         $title = $record->subfield( $authref->{auth_tag_to_report}, 'a' );
2543         $index{'mainmainentry'} = $authref->{'auth_tag_to_report'} . 'a';
2544         $index{'mainentry'}     = $authref->{'auth_tag_to_report'} . '*';
2545         $index{'auth_type'}     = "${auth_type_tag}${auth_type_sf}";
2546     }
2547
2548     my %result;
2549
2550     # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2551     $title =~ s/ |,|;|\[|\]|\(|\)|\*|-|'|=//g;
2552
2553     # limit to 10 char, should be enough, and limit the DB size
2554     $title = substr( $title, 0, 10 );
2555
2556     #parse each field
2557     my $sth2 = $dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2558     foreach my $field ( $record->fields() ) {
2559
2560         #parse each subfield
2561         next if $field->tag < 10;
2562         foreach my $subfield ( $field->subfields() ) {
2563             my $tag          = $field->tag();
2564             my $subfieldcode = $subfield->[0];
2565             my $indexed      = 0;
2566
2567             # check each index to see if the subfield is stored somewhere
2568             # otherwise, store it in __RAW__ index
2569             foreach my $key ( keys %index ) {
2570
2571                 #                 warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2572                 if ( $index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/ ) {
2573                     $indexed = 1;
2574                     my $line = lc $subfield->[1];
2575
2576                     # remove meaningless value in the field...
2577                     $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2578
2579                     # ... and split in words
2580                     foreach ( split / /, $line ) {
2581                         next unless $_;    # skip  empty values (multiple spaces)
2582                                            # if the entry is already here, do nothing, the biblionumber has already be removed
2583                         unless ( defined( $result{$key}->{$_} ) && ( $result{$key}->{$_} =~ /$biblionumber,$title\-(\d);/ ) ) {
2584
2585                             # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2586                             $sth2->execute( $server, $key, $_ );
2587                             my $existing_biblionumbers = $sth2->fetchrow;
2588
2589                             # it exists
2590                             if ($existing_biblionumbers) {
2591
2592                                 #                                 warn " existing for $key $_: $existing_biblionumbers";
2593                                 $result{$key}->{$_} = $existing_biblionumbers;
2594                                 $result{$key}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2595                             }
2596                         }
2597                     }
2598                 }
2599             }
2600
2601             # the subfield is not indexed, store it in __RAW__ index anyway
2602             unless ($indexed) {
2603                 my $line = lc $subfield->[1];
2604                 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:/ /g;
2605
2606                 # ... and split in words
2607                 foreach ( split / /, $line ) {
2608                     next unless $_;    # skip  empty values (multiple spaces)
2609                                        # if the entry is already here, do nothing, the biblionumber has already be removed
2610                     unless ( $result{'__RAW__'}->{$_} =~ /$biblionumber,$title\-(\d);/ ) {
2611
2612                         # get the index value if it exist in the nozebra table and remove the entry, otherwise, do nothing
2613                         $sth2->execute( $server, '__RAW__', $_ );
2614                         my $existing_biblionumbers = $sth2->fetchrow;
2615
2616                         # it exists
2617                         if ($existing_biblionumbers) {
2618                             $result{'__RAW__'}->{$_} = $existing_biblionumbers;
2619                             $result{'__RAW__'}->{$_} =~ s/$biblionumber,$title\-(\d);//;
2620                         }
2621                     }
2622                 }
2623             }
2624         }
2625     }
2626     return %result;
2627 }
2628
2629 =head2 _AddBiblioNoZebra
2630
2631   _AddBiblioNoZebra($biblionumber, $record, $server, %result);
2632
2633 function to add a biblio in NoZebra indexes
2634
2635 =cut
2636
2637 sub _AddBiblioNoZebra {
2638     my ( $biblionumber, $record, $server, %result ) = @_;
2639     my $dbh = C4::Context->dbh;
2640
2641     # Get the indexes
2642     my %index;
2643     my $title;
2644     if ( $server eq 'biblioserver' ) {
2645         %index = GetNoZebraIndexes;
2646
2647         # get title of the record (to store the 10 first letters with the index)
2648         my ( $titletag, $titlesubfield ) = GetMarcFromKohaField( 'biblio.title', '' );    # FIXME: should be GetFrameworkCode($biblionumber) ??
2649         $title = lc( $record->subfield( $titletag, $titlesubfield ) );
2650     } else {
2651
2652         # warn "server : $server";
2653         # for authorities, the "title" is the $a mainentry
2654         my ( $auth_type_tag, $auth_type_sf ) = C4::AuthoritiesMarc::get_auth_type_location();
2655         my $authref = C4::AuthoritiesMarc::GetAuthType( $record->subfield( $auth_type_tag, $auth_type_sf ) );
2656         warn "ERROR : authtype undefined for " . $record->as_formatted unless $authref;
2657         $title = $record->subfield( $authref->{auth_tag_to_report}, 'a' );
2658         $index{'mainmainentry'} = $authref->{auth_tag_to_report} . 'a';
2659         $index{'mainentry'}     = $authref->{auth_tag_to_report} . '*';
2660         $index{'auth_type'}     = "${auth_type_tag}${auth_type_sf}";
2661     }
2662
2663     # remove blancks comma (that could cause problem when decoding the string for CQL retrieval) and regexp specific values
2664     $title =~ s/ |\.|,|;|\[|\]|\(|\)|\*|-|'|:|=|\r|\n//g;
2665
2666     # limit to 10 char, should be enough, and limit the DB size
2667     $title = substr( $title, 0, 10 );
2668
2669     #parse each field
2670     my $sth2 = $dbh->prepare('SELECT biblionumbers FROM nozebra WHERE server=? AND indexname=? AND value=?');
2671     foreach my $field ( $record->fields() ) {
2672
2673         #parse each subfield
2674         ###FIXME: impossible to index a 001-009 value with NoZebra
2675         next if $field->tag < 10;
2676         foreach my $subfield ( $field->subfields() ) {
2677             my $tag          = $field->tag();
2678             my $subfieldcode = $subfield->[0];
2679             my $indexed      = 0;
2680
2681             #             warn "INDEXING :".$subfield->[1];
2682             # check each index to see if the subfield is stored somewhere
2683             # otherwise, store it in __RAW__ index
2684             foreach my $key ( keys %index ) {
2685
2686                 #                 warn "examining $key index : ".$index{$key}." for $tag $subfieldcode";
2687                 if ( $index{$key} =~ /$tag\*/ or $index{$key} =~ /$tag$subfieldcode/ ) {
2688                     $indexed = 1;
2689                     my $line = lc $subfield->[1];
2690
2691                     # remove meaningless value in the field...
2692                     $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2693
2694                     # ... and split in words
2695                     foreach ( split / /, $line ) {
2696                         next unless $_;    # skip  empty values (multiple spaces)
2697                                            # if the entry is already here, improve weight
2698
2699                         #                         warn "managing $_";
2700                         if ( exists $result{$key}->{$_} && $result{$key}->{"$_"} =~ /$biblionumber,\Q$title\E\-(\d+);/ ) {
2701                             my $weight = $1 + 1;
2702                             $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d+);//g;
2703                             $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2704                         } else {
2705
2706                             # get the value if it exist in the nozebra table, otherwise, create it
2707                             $sth2->execute( $server, $key, $_ );
2708                             my $existing_biblionumbers = $sth2->fetchrow;
2709
2710                             # it exists
2711                             if ($existing_biblionumbers) {
2712                                 $result{$key}->{"$_"} = $existing_biblionumbers;
2713                                 my $weight = defined $1 ? $1 + 1 : 1;
2714                                 $result{$key}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d+);//g;
2715                                 $result{$key}->{"$_"} .= "$biblionumber,$title-$weight;";
2716
2717                                 # create a new ligne for this entry
2718                             } else {
2719
2720                                 #                             warn "INSERT : $server / $key / $_";
2721                                 $dbh->do( 'INSERT INTO nozebra SET server=' . $dbh->quote($server) . ', indexname=' . $dbh->quote($key) . ',value=' . $dbh->quote($_) );
2722                                 $result{$key}->{"$_"} .= "$biblionumber,$title-1;";
2723                             }
2724                         }
2725                     }
2726                 }
2727             }
2728
2729             # the subfield is not indexed, store it in __RAW__ index anyway
2730             unless ($indexed) {
2731                 my $line = lc $subfield->[1];
2732                 $line =~ s/-|\.|\?|,|;|!|'|\(|\)|\[|\]|{|}|"|<|>|&|\+|\*|\/|=|:|\r|\n/ /g;
2733
2734                 # ... and split in words
2735                 foreach ( split / /, $line ) {
2736                     next unless $_;    # skip  empty values (multiple spaces)
2737                                        # if the entry is already here, improve weight
2738                     my $tmpstr = $result{'__RAW__'}->{"$_"} || "";
2739                     if ( $tmpstr =~ /$biblionumber,\Q$title\E\-(\d+);/ ) {
2740                         my $weight = $1 + 1;
2741                         $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d+);//;
2742                         $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2743                     } else {
2744
2745                         # get the value if it exist in the nozebra table, otherwise, create it
2746                         $sth2->execute( $server, '__RAW__', $_ );
2747                         my $existing_biblionumbers = $sth2->fetchrow;
2748
2749                         # it exists
2750                         if ($existing_biblionumbers) {
2751                             $result{'__RAW__'}->{"$_"} = $existing_biblionumbers;
2752                             my $weight = ( $1 ? $1 : 0 ) + 1;
2753                             $result{'__RAW__'}->{"$_"} =~ s/$biblionumber,\Q$title\E\-(\d+);//;
2754                             $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-$weight;";
2755
2756                             # create a new ligne for this entry
2757                         } else {
2758                             $dbh->do( 'INSERT INTO nozebra SET server=' . $dbh->quote($server) . ',  indexname="__RAW__",value=' . $dbh->quote($_) );
2759                             $result{'__RAW__'}->{"$_"} .= "$biblionumber,$title-1;";
2760                         }
2761                     }
2762                 }
2763             }
2764         }
2765     }
2766     return %result;
2767 }
2768
2769 =head2 _find_value
2770
2771   ($indicators, $value) = _find_value($tag, $subfield, $record,$encoding);
2772
2773 Find the given $subfield in the given $tag in the given
2774 MARC::Record $record.  If the subfield is found, returns
2775 the (indicators, value) pair; otherwise, (undef, undef) is
2776 returned.
2777
2778 PROPOSITION :
2779 Such a function is used in addbiblio AND additem and serial-edit and maybe could be used in Authorities.
2780 I suggest we export it from this module.
2781
2782 =cut
2783
2784 sub _find_value {
2785     my ( $tagfield, $insubfield, $record, $encoding ) = @_;
2786     my @result;
2787     my $indicator;
2788     if ( $tagfield < 10 ) {
2789         if ( $record->field($tagfield) ) {
2790             push @result, $record->field($tagfield)->data();
2791         } else {
2792             push @result, "";
2793         }
2794     } else {
2795         foreach my $field ( $record->field($tagfield) ) {
2796             my @subfields = $field->subfields();
2797             foreach my $subfield (@subfields) {
2798                 if ( @$subfield[0] eq $insubfield ) {
2799                     push @result, @$subfield[1];
2800                     $indicator = $field->indicator(1) . $field->indicator(2);
2801                 }
2802             }
2803         }
2804     }
2805     return ( $indicator, @result );
2806 }
2807
2808 =head2 _koha_marc_update_bib_ids
2809
2810
2811   _koha_marc_update_bib_ids($record, $frameworkcode, $biblionumber, $biblioitemnumber);
2812
2813 Internal function to add or update biblionumber and biblioitemnumber to
2814 the MARC XML.
2815
2816 =cut
2817
2818 sub _koha_marc_update_bib_ids {
2819     my ( $record, $frameworkcode, $biblionumber, $biblioitemnumber ) = @_;
2820
2821     # we must add bibnum and bibitemnum in MARC::Record...
2822     # we build the new field with biblionumber and biblioitemnumber
2823     # we drop the original field
2824     # we add the new builded field.
2825     my ( $biblio_tag,     $biblio_subfield )     = GetMarcFromKohaField( "biblio.biblionumber",          $frameworkcode );
2826     my ( $biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField( "biblioitems.biblioitemnumber", $frameworkcode );
2827
2828     if ( $biblio_tag != $biblioitem_tag ) {
2829
2830         # biblionumber & biblioitemnumber are in different fields
2831
2832         # deal with biblionumber
2833         my ( $new_field, $old_field );
2834         if ( $biblio_tag < 10 ) {
2835             $new_field = MARC::Field->new( $biblio_tag, $biblionumber );
2836         } else {
2837             $new_field = MARC::Field->new( $biblio_tag, '', '', "$biblio_subfield" => $biblionumber );
2838         }
2839
2840         # drop old field and create new one...
2841         $old_field = $record->field($biblio_tag);
2842         $record->delete_field($old_field) if $old_field;
2843         $record->append_fields($new_field);
2844
2845         # deal with biblioitemnumber
2846         if ( $biblioitem_tag < 10 ) {
2847             $new_field = MARC::Field->new( $biblioitem_tag, $biblioitemnumber, );
2848         } else {
2849             $new_field = MARC::Field->new( $biblioitem_tag, '', '', "$biblioitem_subfield" => $biblioitemnumber, );
2850         }
2851
2852         # drop old field and create new one...
2853         $old_field = $record->field($biblioitem_tag);
2854         $record->delete_field($old_field) if $old_field;
2855         $record->insert_fields_ordered($new_field);
2856
2857     } else {
2858
2859         # biblionumber & biblioitemnumber are in the same field (can't be <10 as fields <10 have only 1 value)
2860         my $new_field = MARC::Field->new(
2861             $biblio_tag, '', '',
2862             "$biblio_subfield"     => $biblionumber,
2863             "$biblioitem_subfield" => $biblioitemnumber
2864         );
2865
2866         # drop old field and create new one...
2867         my $old_field = $record->field($biblio_tag);
2868         $record->delete_field($old_field) if $old_field;
2869         $record->insert_fields_ordered($new_field);
2870     }
2871 }
2872
2873 =head2 _koha_marc_update_biblioitem_cn_sort
2874
2875   _koha_marc_update_biblioitem_cn_sort($marc, $biblioitem, $frameworkcode);
2876
2877 Given a MARC bib record and the biblioitem hash, update the
2878 subfield that contains a copy of the value of biblioitems.cn_sort.
2879
2880 =cut
2881
2882 sub _koha_marc_update_biblioitem_cn_sort {
2883     my $marc          = shift;
2884     my $biblioitem    = shift;
2885     my $frameworkcode = shift;
2886
2887     my ( $biblioitem_tag, $biblioitem_subfield ) = GetMarcFromKohaField( "biblioitems.cn_sort", $frameworkcode );
2888     return unless $biblioitem_tag;
2889
2890     my ($cn_sort) = GetClassSort( $biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
2891
2892     if ( my $field = $marc->field($biblioitem_tag) ) {
2893         $field->delete_subfield( code => $biblioitem_subfield );
2894         if ( $cn_sort ne '' ) {
2895             $field->add_subfields( $biblioitem_subfield => $cn_sort );
2896         }
2897     } else {
2898
2899         # if we get here, no biblioitem tag is present in the MARC record, so
2900         # we'll create it if $cn_sort is not empty -- this would be
2901         # an odd combination of events, however
2902         if ($cn_sort) {
2903             $marc->insert_grouped_field( MARC::Field->new( $biblioitem_tag, ' ', ' ', $biblioitem_subfield => $cn_sort ) );
2904         }
2905     }
2906 }
2907
2908 =head2 _koha_add_biblio
2909
2910   my ($biblionumber,$error) = _koha_add_biblio($dbh,$biblioitem);
2911
2912 Internal function to add a biblio ($biblio is a hash with the values)
2913
2914 =cut
2915
2916 sub _koha_add_biblio {
2917     my ( $dbh, $biblio, $frameworkcode ) = @_;
2918
2919     my $error;
2920
2921     # set the series flag
2922     unless (defined $biblio->{'serial'}){
2923         $biblio->{'serial'} = 0;
2924         if ( $biblio->{'seriestitle'} ) { $biblio->{'serial'} = 1 }
2925     }
2926
2927     my $query = "INSERT INTO biblio
2928         SET frameworkcode = ?,
2929             author = ?,
2930             title = ?,
2931             unititle =?,
2932             notes = ?,
2933             serial = ?,
2934             seriestitle = ?,
2935             copyrightdate = ?,
2936             datecreated=NOW(),
2937             abstract = ?
2938         ";
2939     my $sth = $dbh->prepare($query);
2940     $sth->execute(
2941         $frameworkcode, $biblio->{'author'},      $biblio->{'title'},         $biblio->{'unititle'}, $biblio->{'notes'},
2942         $biblio->{'serial'},        $biblio->{'seriestitle'}, $biblio->{'copyrightdate'}, $biblio->{'abstract'}
2943     );
2944
2945     my $biblionumber = $dbh->{'mysql_insertid'};
2946     if ( $dbh->errstr ) {
2947         $error .= "ERROR in _koha_add_biblio $query" . $dbh->errstr;
2948         warn $error;
2949     }
2950
2951     $sth->finish();
2952
2953     #warn "LEAVING _koha_add_biblio: ".$biblionumber."\n";
2954     return ( $biblionumber, $error );
2955 }
2956
2957 =head2 _koha_modify_biblio
2958
2959   my ($biblionumber,$error) == _koha_modify_biblio($dbh,$biblio,$frameworkcode);
2960
2961 Internal function for updating the biblio table
2962
2963 =cut
2964
2965 sub _koha_modify_biblio {
2966     my ( $dbh, $biblio, $frameworkcode ) = @_;
2967     my $error;
2968
2969     my $query = "
2970         UPDATE biblio
2971         SET    frameworkcode = ?,
2972                author = ?,
2973                title = ?,
2974                unititle = ?,
2975                notes = ?,
2976                serial = ?,
2977                seriestitle = ?,
2978                copyrightdate = ?,
2979                abstract = ?
2980         WHERE  biblionumber = ?
2981         "
2982       ;
2983     my $sth = $dbh->prepare($query);
2984
2985     $sth->execute(
2986         $frameworkcode,      $biblio->{'author'},      $biblio->{'title'},         $biblio->{'unititle'}, $biblio->{'notes'},
2987         $biblio->{'serial'}, $biblio->{'seriestitle'}, $biblio->{'copyrightdate'}, $biblio->{'abstract'}, $biblio->{'biblionumber'}
2988     ) if $biblio->{'biblionumber'};
2989
2990     if ( $dbh->errstr || !$biblio->{'biblionumber'} ) {
2991         $error .= "ERROR in _koha_modify_biblio $query" . $dbh->errstr;
2992         warn $error;
2993     }
2994     return ( $biblio->{'biblionumber'}, $error );
2995 }
2996
2997 =head2 _koha_modify_biblioitem_nonmarc
2998
2999   my ($biblioitemnumber,$error) = _koha_modify_biblioitem_nonmarc( $dbh, $biblioitem );
3000
3001 Updates biblioitems row except for marc and marcxml, which should be changed
3002 via ModBiblioMarc
3003
3004 =cut
3005
3006 sub _koha_modify_biblioitem_nonmarc {
3007     my ( $dbh, $biblioitem ) = @_;
3008     my $error;
3009
3010     # re-calculate the cn_sort, it may have changed
3011     my ($cn_sort) = GetClassSort( $biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3012
3013     my $query = "UPDATE biblioitems 
3014     SET biblionumber    = ?,
3015         volume          = ?,
3016         number          = ?,
3017         itemtype        = ?,
3018         isbn            = ?,
3019         issn            = ?,
3020         publicationyear = ?,
3021         publishercode   = ?,
3022         volumedate      = ?,
3023         volumedesc      = ?,
3024         collectiontitle = ?,
3025         collectionissn  = ?,
3026         collectionvolume= ?,
3027         editionstatement= ?,
3028         editionresponsibility = ?,
3029         illus           = ?,
3030         pages           = ?,
3031         notes           = ?,
3032         size            = ?,
3033         place           = ?,
3034         lccn            = ?,
3035         url             = ?,
3036         cn_source       = ?,
3037         cn_class        = ?,
3038         cn_item         = ?,
3039         cn_suffix       = ?,
3040         cn_sort         = ?,
3041         totalissues     = ?
3042         where biblioitemnumber = ?
3043         ";
3044     my $sth = $dbh->prepare($query);
3045     $sth->execute(
3046         $biblioitem->{'biblionumber'},     $biblioitem->{'volume'},           $biblioitem->{'number'},                $biblioitem->{'itemtype'},
3047         $biblioitem->{'isbn'},             $biblioitem->{'issn'},             $biblioitem->{'publicationyear'},       $biblioitem->{'publishercode'},
3048         $biblioitem->{'volumedate'},       $biblioitem->{'volumedesc'},       $biblioitem->{'collectiontitle'},       $biblioitem->{'collectionissn'},
3049         $biblioitem->{'collectionvolume'}, $biblioitem->{'editionstatement'}, $biblioitem->{'editionresponsibility'}, $biblioitem->{'illus'},
3050         $biblioitem->{'pages'},            $biblioitem->{'bnotes'},           $biblioitem->{'size'},                  $biblioitem->{'place'},
3051         $biblioitem->{'lccn'},             $biblioitem->{'url'},              $biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'},
3052         $biblioitem->{'cn_item'},          $biblioitem->{'cn_suffix'},        $cn_sort,                               $biblioitem->{'totalissues'},
3053         $biblioitem->{'biblioitemnumber'}
3054     );
3055     if ( $dbh->errstr ) {
3056         $error .= "ERROR in _koha_modify_biblioitem_nonmarc $query" . $dbh->errstr;
3057         warn $error;
3058     }
3059     return ( $biblioitem->{'biblioitemnumber'}, $error );
3060 }
3061
3062 =head2 _koha_add_biblioitem
3063
3064   my ($biblioitemnumber,$error) = _koha_add_biblioitem( $dbh, $biblioitem );
3065
3066 Internal function to add a biblioitem
3067
3068 =cut
3069
3070 sub _koha_add_biblioitem {
3071     my ( $dbh, $biblioitem ) = @_;
3072     my $error;
3073
3074     my ($cn_sort) = GetClassSort( $biblioitem->{'biblioitems.cn_source'}, $biblioitem->{'cn_class'}, $biblioitem->{'cn_item'} );
3075     my $query = "INSERT INTO biblioitems SET
3076         biblionumber    = ?,
3077         volume          = ?,
3078         number          = ?,
3079         itemtype        = ?,
3080         isbn            = ?,
3081         issn            = ?,
3082         publicationyear = ?,
3083         publishercode   = ?,
3084         volumedate      = ?,
3085         volumedesc      = ?,
3086         collectiontitle = ?,
3087         collectionissn  = ?,
3088         collectionvolume= ?,
3089         editionstatement= ?,
3090         editionresponsibility = ?,
3091         illus           = ?,
3092         pages           = ?,
3093         notes           = ?,
3094         size            = ?,
3095         place           = ?,
3096         lccn            = ?,
3097         marc            = ?,
3098         url             = ?,
3099         cn_source       = ?,
3100         cn_class        = ?,
3101         cn_item         = ?,
3102         cn_suffix       = ?,
3103         cn_sort         = ?,
3104         totalissues     = ?
3105         ";
3106     my $sth = $dbh->prepare($query);
3107     $sth->execute(
3108         $biblioitem->{'biblionumber'},     $biblioitem->{'volume'},           $biblioitem->{'number'},                $biblioitem->{'itemtype'},
3109         $biblioitem->{'isbn'},             $biblioitem->{'issn'},             $biblioitem->{'publicationyear'},       $biblioitem->{'publishercode'},
3110         $biblioitem->{'volumedate'},       $biblioitem->{'volumedesc'},       $biblioitem->{'collectiontitle'},       $biblioitem->{'collectionissn'},
3111         $biblioitem->{'collectionvolume'}, $biblioitem->{'editionstatement'}, $biblioitem->{'editionresponsibility'}, $biblioitem->{'illus'},
3112         $biblioitem->{'pages'},            $biblioitem->{'bnotes'},           $biblioitem->{'size'},                  $biblioitem->{'place'},
3113         $biblioitem->{'lccn'},             $biblioitem->{'marc'},             $biblioitem->{'url'},                   $biblioitem->{'biblioitems.cn_source'},
3114         $biblioitem->{'cn_class'},         $biblioitem->{'cn_item'},          $biblioitem->{'cn_suffix'},             $cn_sort,
3115         $biblioitem->{'totalissues'}
3116     );
3117     my $bibitemnum = $dbh->{'mysql_insertid'};
3118
3119     if ( $dbh->errstr ) {
3120         $error .= "ERROR in _koha_add_biblioitem $query" . $dbh->errstr;
3121         warn $error;
3122     }
3123     $sth->finish();
3124     return ( $bibitemnum, $error );
3125 }
3126
3127 =head2 _koha_delete_biblio
3128
3129   $error = _koha_delete_biblio($dbh,$biblionumber);
3130
3131 Internal sub for deleting from biblio table -- also saves to deletedbiblio
3132
3133 C<$dbh> - the database handle
3134
3135 C<$biblionumber> - the biblionumber of the biblio to be deleted
3136
3137 =cut
3138
3139 # FIXME: add error handling
3140
3141 sub _koha_delete_biblio {
3142     my ( $dbh, $biblionumber ) = @_;
3143
3144     # get all the data for this biblio
3145     my $sth = $dbh->prepare("SELECT * FROM biblio WHERE biblionumber=?");
3146     $sth->execute($biblionumber);
3147
3148     if ( my $data = $sth->fetchrow_hashref ) {
3149
3150         # save the record in deletedbiblio
3151         # find the fields to save
3152         my $query = "INSERT INTO deletedbiblio SET ";
3153         my @bind  = ();
3154         foreach my $temp ( keys %$data ) {
3155             $query .= "$temp = ?,";
3156             push( @bind, $data->{$temp} );
3157         }
3158
3159         # replace the last , by ",?)"
3160         $query =~ s/\,$//;
3161         my $bkup_sth = $dbh->prepare($query);
3162         $bkup_sth->execute(@bind);
3163         $bkup_sth->finish;
3164
3165         # delete the biblio
3166         my $del_sth = $dbh->prepare("DELETE FROM biblio WHERE biblionumber=?");
3167         $del_sth->execute($biblionumber);
3168         $del_sth->finish;
3169     }
3170     $sth->finish;
3171     return undef;
3172 }
3173
3174 =head2 _koha_delete_biblioitems
3175
3176   $error = _koha_delete_biblioitems($dbh,$biblioitemnumber);
3177
3178 Internal sub for deleting from biblioitems table -- also saves to deletedbiblioitems
3179
3180 C<$dbh> - the database handle
3181 C<$biblionumber> - the biblioitemnumber of the biblioitem to be deleted
3182
3183 =cut
3184
3185 # FIXME: add error handling
3186
3187 sub _koha_delete_biblioitems {
3188     my ( $dbh, $biblioitemnumber ) = @_;
3189
3190     # get all the data for this biblioitem
3191     my $sth = $dbh->prepare("SELECT * FROM biblioitems WHERE biblioitemnumber=?");
3192     $sth->execute($biblioitemnumber);
3193
3194     if ( my $data = $sth->fetchrow_hashref ) {
3195
3196         # save the record in deletedbiblioitems
3197         # find the fields to save
3198         my $query = "INSERT INTO deletedbiblioitems SET ";
3199         my @bind  = ();
3200         foreach my $temp ( keys %$data ) {
3201             $query .= "$temp = ?,";
3202             push( @bind, $data->{$temp} );
3203         }
3204
3205         # replace the last , by ",?)"
3206         $query =~ s/\,$//;
3207         my $bkup_sth = $dbh->prepare($query);
3208         $bkup_sth->execute(@bind);
3209         $bkup_sth->finish;
3210
3211         # delete the biblioitem
3212         my $del_sth = $dbh->prepare("DELETE FROM biblioitems WHERE biblioitemnumber=?");
3213         $del_sth->execute($biblioitemnumber);
3214         $del_sth->finish;
3215     }
3216     $sth->finish;
3217     return undef;
3218 }
3219
3220 =head1 UNEXPORTED FUNCTIONS
3221
3222 =head2 ModBiblioMarc
3223
3224   &ModBiblioMarc($newrec,$biblionumber,$frameworkcode);
3225
3226 Add MARC data for a biblio to koha 
3227
3228 Function exported, but should NOT be used, unless you really know what you're doing
3229
3230 =cut
3231
3232 sub ModBiblioMarc {
3233
3234     # pass the MARC::Record to this function, and it will create the records in the marc field
3235     my ( $record, $biblionumber, $frameworkcode ) = @_;
3236     my $dbh    = C4::Context->dbh;
3237     my @fields = $record->fields();
3238     if ( !$frameworkcode ) {
3239         $frameworkcode = "";
3240     }
3241     my $sth = $dbh->prepare("UPDATE biblio SET frameworkcode=? WHERE biblionumber=?");
3242     $sth->execute( $frameworkcode, $biblionumber );
3243     $sth->finish;
3244     my $encoding = C4::Context->preference("marcflavour");
3245
3246     # deal with UNIMARC field 100 (encoding) : create it if needed & set encoding to unicode
3247     if ( $encoding eq "UNIMARC" ) {
3248         my $string = $record->subfield( 100, "a" );
3249         if ( ($string) && ( length( $record->subfield( 100, "a" ) ) == 36 ) ) {
3250             my $f100 = $record->field(100);
3251             $record->delete_field($f100);
3252         } else {
3253             $string = POSIX::strftime( "%Y%m%d", localtime );
3254             $string =~ s/\-//g;
3255             $string = sprintf( "%-*s", 35, $string );
3256         }
3257         substr( $string, 22, 6, "frey50" );
3258         unless ( $record->subfield( 100, "a" ) ) {
3259             $record->insert_grouped_field( MARC::Field->new( 100, "", "", "a" => $string ) );
3260         }
3261     }
3262
3263     #enhancement 5374: update transaction date (005) for marc21/unimarc
3264     if($encoding =~ /MARC21|UNIMARC/) {
3265       my @a= (localtime) [5,4,3,2,1,0]; $a[0]+=1900; $a[1]++;
3266         # YY MM DD HH MM SS (update year and month)
3267       my $f005= $record->field('005');
3268       $f005->update(sprintf("%4d%02d%02d%02d%02d%04.1f",@a)) if $f005;
3269     }
3270
3271     my $oldRecord;
3272     if ( C4::Context->preference("NoZebra") ) {
3273
3274         # only NoZebra indexing needs to have
3275         # the previous version of the record
3276         $oldRecord = GetMarcBiblio($biblionumber);
3277     }
3278     $sth = $dbh->prepare("UPDATE biblioitems SET marc=?,marcxml=? WHERE biblionumber=?");
3279     $sth->execute( $record->as_usmarc(), $record->as_xml_record($encoding), $biblionumber );
3280     $sth->finish;
3281     ModZebra( $biblionumber, "specialUpdate", "biblioserver", $oldRecord, $record );
3282     return $biblionumber;
3283 }
3284
3285 =head2 z3950_extended_services
3286
3287   z3950_extended_services($serviceType,$serviceOptions,$record);
3288
3289 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.
3290
3291 C<$serviceType> one of: itemorder,create,drop,commit,update,xmlupdate
3292
3293 C<$serviceOptions> a has of key/value pairs. For instance, if service_type is 'update', $service_options should contain:
3294
3295  action => update action, one of specialUpdate, recordInsert, recordReplace, recordDelete, elementUpdate.
3296
3297 and maybe
3298
3299   recordidOpaque => Opaque Record ID (user supplied) or recordidNumber => Record ID number (system number).
3300   syntax => the record syntax (transfer syntax)
3301   databaseName = Database from connection object
3302
3303 To set serviceOptions, call set_service_options($serviceType)
3304
3305 C<$record> the record, if one is needed for the service type
3306
3307 A record should be in XML. You can convert it to XML from MARC by running it through marc2xml().
3308
3309 =cut
3310
3311 sub z3950_extended_services {
3312     my ( $server, $serviceType, $action, $serviceOptions ) = @_;
3313
3314     # get our connection object
3315     my $Zconn = C4::Context->Zconn( $server, 0, 1 );
3316
3317     # create a new package object
3318     my $Zpackage = $Zconn->package();
3319
3320     # set our options
3321     $Zpackage->option( action => $action );
3322
3323     if ( $serviceOptions->{'databaseName'} ) {
3324         $Zpackage->option( databaseName => $serviceOptions->{'databaseName'} );
3325     }
3326     if ( $serviceOptions->{'recordIdNumber'} ) {
3327         $Zpackage->option( recordIdNumber => $serviceOptions->{'recordIdNumber'} );
3328     }
3329     if ( $serviceOptions->{'recordIdOpaque'} ) {
3330         $Zpackage->option( recordIdOpaque => $serviceOptions->{'recordIdOpaque'} );
3331     }
3332
3333     # this is an ILL request (Zebra doesn't support it, but Koha could eventually)
3334     #if ($serviceType eq 'itemorder') {
3335     #   $Zpackage->option('contact-name' => $serviceOptions->{'contact-name'});
3336     #   $Zpackage->option('contact-phone' => $serviceOptions->{'contact-phone'});
3337     #   $Zpackage->option('contact-email' => $serviceOptions->{'contact-email'});
3338     #   $Zpackage->option('itemorder-item' => $serviceOptions->{'itemorder-item'});
3339     #}
3340
3341     if ( $serviceOptions->{record} ) {
3342         $Zpackage->option( record => $serviceOptions->{record} );
3343
3344         # can be xml or marc
3345         if ( $serviceOptions->{'syntax'} ) {
3346             $Zpackage->option( syntax => $serviceOptions->{'syntax'} );
3347         }
3348     }
3349
3350     # send the request, handle any exception encountered
3351     eval { $Zpackage->send($serviceType) };
3352     if ( $@ && $@->isa("ZOOM::Exception") ) {
3353         return "error:  " . $@->code() . " " . $@->message() . "\n";
3354     }
3355
3356     # free up package resources
3357     $Zpackage->destroy();
3358 }
3359
3360 =head2 set_service_options
3361
3362   my $serviceOptions = set_service_options($serviceType);
3363
3364 C<$serviceType> itemorder,create,drop,commit,update,xmlupdate
3365
3366 Currently, we only support 'create', 'commit', and 'update'. 'drop' support will be added as soon as Zebra supports it.
3367
3368 =cut
3369
3370 sub set_service_options {
3371     my ($serviceType) = @_;
3372     my $serviceOptions;
3373
3374     # FIXME: This needs to be an OID ... if we ever need 'syntax' this sub will need to change
3375     #   $serviceOptions->{ 'syntax' } = ''; #zebra doesn't support syntaxes other than xml
3376
3377     if ( $serviceType eq 'commit' ) {
3378
3379         # nothing to do
3380     }
3381     if ( $serviceType eq 'create' ) {
3382
3383         # nothing to do
3384     }
3385     if ( $serviceType eq 'drop' ) {
3386         die "ERROR: 'drop' not currently supported (by Zebra)";
3387     }
3388     return $serviceOptions;
3389 }
3390
3391 =head2 get_biblio_authorised_values
3392
3393 find the types and values for all authorised values assigned to this biblio.
3394
3395 parameters:
3396     biblionumber
3397     MARC::Record of the bib
3398
3399 returns: a hashref mapping the authorised value to the value set for this biblionumber
3400
3401   $authorised_values = {
3402                        'Scent'     => 'flowery',
3403                        'Audience'  => 'Young Adult',
3404                        'itemtypes' => 'SER',
3405                         };
3406
3407 Notes: forlibrarian should probably be passed in, and called something different.
3408
3409 =cut
3410
3411 sub get_biblio_authorised_values {
3412     my $biblionumber = shift;
3413     my $record       = shift;
3414
3415     my $forlibrarian  = 1;                                 # are we in staff or opac?
3416     my $frameworkcode = GetFrameworkCode($biblionumber);
3417
3418     my $authorised_values;
3419
3420     my $tagslib = GetMarcStructure( $forlibrarian, $frameworkcode )
3421       or return $authorised_values;
3422
3423     # assume that these entries in the authorised_value table are bibliolevel.
3424     # ones that start with 'item%' are item level.
3425     my $query = q(SELECT distinct authorised_value, kohafield
3426                     FROM marc_subfield_structure
3427                     WHERE authorised_value !=''
3428                       AND (kohafield like 'biblio%'
3429                        OR  kohafield like '') );
3430     my $bibliolevel_authorised_values = C4::Context->dbh->selectall_hashref( $query, 'authorised_value' );
3431
3432     foreach my $tag ( keys(%$tagslib) ) {
3433         foreach my $subfield ( keys( %{ $tagslib->{$tag} } ) ) {
3434
3435             # warn "checking $subfield. type is: " . ref $tagslib->{ $tag }{ $subfield };
3436             if ( 'HASH' eq ref $tagslib->{$tag}{$subfield} ) {
3437                 if ( defined $tagslib->{$tag}{$subfield}{'authorised_value'} && exists $bibliolevel_authorised_values->{ $tagslib->{$tag}{$subfield}{'authorised_value'} } ) {
3438                     if ( defined $record->field($tag) ) {
3439                         my $this_subfield_value = $record->field($tag)->subfield($subfield);
3440                         if ( defined $this_subfield_value ) {
3441                             $authorised_values->{ $tagslib->{$tag}{$subfield}{'authorised_value'} } = $this_subfield_value;
3442                         }
3443                     }
3444                 }
3445             }
3446         }
3447     }
3448
3449     # warn ( Data::Dumper->Dump( [ $authorised_values ], [ 'authorised_values' ] ) );
3450     return $authorised_values;
3451 }
3452
3453 1;
3454
3455 __END__
3456
3457 =head1 AUTHOR
3458
3459 Koha Development Team <http://koha-community.org/>
3460
3461 Paul POULAIN paul.poulain@free.fr
3462
3463 Joshua Ferraro jmf@liblime.com
3464
3465 =cut