Bug 27994: (follow-up) Address missing instance
[koha.git] / acqui / neworderempty.pl
1 #!/usr/bin/perl
2
3 #script to show display basket of orders
4 #written by chris@katipo.co.nz 24/2/2000
5
6 # Copyright 2000-2002 Katipo Communications
7 #
8 # This file is part of Koha.
9 #
10 # Koha is free software; you can redistribute it and/or modify it
11 # under the terms of the GNU General Public License as published by
12 # the Free Software Foundation; either version 3 of the License, or
13 # (at your option) any later version.
14 #
15 # Koha is distributed in the hope that it will be useful, but
16 # WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the GNU General Public License
21 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22
23
24 =head1 NAME
25
26 neworderempty.pl
27
28 =head1 DESCRIPTION
29
30 this script allows to create a new record to order it. This record shouldn't exist
31 on database.
32
33 =head1 CGI PARAMETERS
34
35 =over 4
36
37 =item booksellerid
38 the bookseller the librarian has to buy a new book.
39
40 =item title
41 the title of this new record.
42
43 =item author
44 the author of this new record.
45
46 =item publication year
47 the publication year of this new record.
48
49 =item ordernumber
50 the number of this order.
51
52 =item biblio
53
54 =item basketno
55 the basket number for this new order.
56
57 =item suggestionid
58 if this order comes from a suggestion.
59
60 =item breedingid
61 the item's id in the breeding reservoir
62
63 =back
64
65 =cut
66
67 use Modern::Perl;
68 use CGI qw ( -utf8 );
69 use C4::Context;
70
71 use C4::Auth;
72 use C4::Budgets;
73
74 use C4::Acquisition;
75 use C4::Contract;
76 use C4::Suggestions;    # GetSuggestion
77 use C4::Biblio;                 # GetBiblioData GetMarcPrice
78 use C4::Items; #PrepareItemRecord
79 use C4::Output;
80 use C4::Koha;
81 use C4::Members;
82 use C4::Search qw/FindDuplicate/;
83
84 #needed for z3950 import:
85 use C4::ImportBatch qw/GetImportRecordMarc SetImportRecordStatus SetMatchedBiblionumber/;
86
87 use Koha::Acquisition::Booksellers;
88 use Koha::Acquisition::Currencies;
89 use Koha::BiblioFrameworks;
90 use Koha::DateUtils qw( dt_from_string );
91 use Koha::MarcSubfieldStructures;
92 use Koha::ItemTypes;
93 use Koha::Patrons;
94 use Koha::RecordProcessor;
95 use Koha::Subscriptions;
96
97 our $input           = CGI->new;
98 my $booksellerid    = $input->param('booksellerid');    # FIXME: else ERROR!
99 my $budget_id       = $input->param('budget_id') || 0;
100 my $title           = $input->param('title');
101 my $author          = $input->param('author');
102 my $publicationyear = $input->param('publicationyear');
103 my $ordernumber          = $input->param('ordernumber') || '';
104 our $biblionumber    = $input->param('biblionumber');
105 our $basketno        = $input->param('basketno');
106 my $suggestionid    = $input->param('suggestionid');
107 my $uncertainprice  = $input->param('uncertainprice');
108 my $import_batch_id = $input->param('import_batch_id'); # if this is filled, we come from a staged file, and we will return here after saving the order !
109 my $from_subscriptionid  = $input->param('from_subscriptionid');
110 my $data;
111 my $new = 'no';
112
113 our ( $template, $loggedinuser, $cookie, $userflags ) = get_template_and_user(
114     {
115         template_name   => "acqui/neworderempty.tt",
116         query           => $input,
117         type            => "intranet",
118         flagsrequired   => { acquisition => 'order_manage' },
119         debug           => 1,
120     }
121 );
122
123 our $marcflavour = C4::Context->preference('marcflavour');
124
125 if(!$basketno) {
126     my $order = GetOrder($ordernumber);
127     $basketno = $order->{'basketno'};
128 }
129
130 our $basket = GetBasket($basketno);
131 my $basketobj = Koha::Acquisition::Baskets->find( $basketno );
132 $booksellerid = $basket->{booksellerid} unless $booksellerid;
133 my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
134
135 output_and_exit( $input, $cookie, $template, 'unknown_basket') unless $basketobj;
136 output_and_exit( $input, $cookie, $template, 'unknown_vendor') unless $bookseller;
137
138 $template->param(
139     ordernumber  => $ordernumber,
140     basketno     => $basketno,
141     basket       => $basket,
142     booksellerid => $basket->{'booksellerid'},
143     name         => $bookseller->name,
144 );
145 output_and_exit( $input, $cookie, $template, 'order_cannot_be_edited' )
146     if $ordernumber and $basketobj->closedate;
147
148 my $contract = GetContract({
149     contractnumber => $basket->{contractnumber}
150 });
151
152 #simple parameters reading (all in one :-)
153 our $params = $input->Vars;
154 my $listprice=0; # the price, that can be in MARC record if we have one
155 if ( $ordernumber eq '' and defined $params->{'breedingid'}){
156 #we want to import from the breeding reservoir (from a z3950 search)
157     my ($marcrecord, $encoding) = MARCfindbreeding($params->{'breedingid'});
158     die("Could not find the selected record in the reservoir, bailing") unless $marcrecord;
159
160     # Remove all the items (952) from the imported record
161     foreach my $item ($marcrecord->field('952')) {
162         $marcrecord->delete_field($item);
163     }
164
165     my $duplicatetitle;
166 #look for duplicates
167     ($biblionumber,$duplicatetitle) = FindDuplicate($marcrecord);
168     if($biblionumber && !$input->param('use_external_source')) {
169         #if duplicate record found and user did not decide yet, first warn user
170         #and let them choose between using a new record or an existing record
171         Load_Duplicate($duplicatetitle);
172         exit;
173     }
174     #from this point: add a new record
175     C4::Acquisition::FillWithDefaultValues($marcrecord, {only_mandatory => 1});
176     my $bibitemnum;
177     $params->{'frameworkcode'} or $params->{'frameworkcode'} = "";
178     ( $biblionumber, $bibitemnum ) = AddBiblio( $marcrecord, $params->{'frameworkcode'} );
179     # get the price if there is one.
180     $listprice = GetMarcPrice($marcrecord, $marcflavour);
181     SetImportRecordStatus($params->{'breedingid'}, 'imported');
182
183     SetMatchedBiblionumber( $params->{breedingid}, $biblionumber );
184 }
185
186
187
188 my ( @order_user_ids, @order_users, @catalog_details );
189 our $tagslib = GetMarcStructure(1, 'ACQ', { unsafe => 1 } );
190 my ( $itemnumber_tag, $itemnumber_subtag ) = GetMarcFromKohaField( 'items.itemnumber' );
191 if ( not $ordernumber ) {    # create order
192     $new = 'yes';
193
194     if ( $biblionumber ) {
195         $data = GetBiblioData($biblionumber);
196     }
197     # get suggestion fields if applicable. If it's a subscription renewal, then the biblio already exists
198     # otherwise, retrieve suggestion information.
199     elsif ($suggestionid) {
200         $data = GetSuggestion($suggestionid);
201         $budget_id ||= $data->{'budgetid'} // 0;
202     }
203
204     if ( not $biblionumber and Koha::BiblioFrameworks->find('ACQ') ) {
205         #my $acq_mss = Koha::MarcSubfieldStructures->search({ frameworkcode => 'ACQ', tagfield => { '!=' => $itemnumber_tag } });
206         foreach my $tag ( sort keys %{$tagslib} ) {
207             next if $tag eq '';
208             next if $tag eq $itemnumber_tag;    # skip items fields
209             foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
210                 my $mss = $tagslib->{$tag}{$subfield};
211                 next if IsMarcStructureInternal($mss);
212                 next if $mss->{tab} == -1;
213                 my $value = $mss->{defaultvalue};
214
215                 if ($suggestionid and $mss->{kohafield}) {
216                     # Reading suggestion info if ordering from a suggestion
217                     if ( $mss->{kohafield} eq 'biblio.title' ) {
218                         $value = $data->{title};
219                     }
220                     elsif ( $mss->{kohafield} eq 'biblio.author' ) {
221                         $value = $data->{author};
222                     }
223                     elsif ( $mss->{kohafield} eq 'biblioitems.publishercode' ) {
224                         $value = $data->{publishercode};
225                     }
226                     elsif ( $mss->{kohafield} eq 'biblioitems.editionstatement' ) {
227                         $value = $data->{editionstatement};
228                     }
229                     elsif ( $mss->{kohafield} eq 'biblioitems.publicationyear' ) {
230                         $value = $data->{publicationyear};
231                     }
232                     elsif ( $mss->{kohafield} eq 'biblioitems.isbn' ) {
233                         $value = $data->{isbn};
234                     }
235                     elsif ( $mss->{kohafield} eq 'biblio.seriestitle' ) {
236                         $value = $data->{seriestitle};
237                     }
238                 }
239
240                 if ( $value ) {
241
242                     # get today date & replace <<YYYY>>, <<YY>>, <<MM>>, <<DD>> if provided in the default value
243                     my $today_dt = dt_from_string;
244                     my $year     = $today_dt->strftime('%Y');
245                     my $shortyear = $today_dt->strftime('%y');
246                     my $month    = $today_dt->strftime('%m');
247                     my $day      = $today_dt->strftime('%d');
248                     $value =~ s/<<YYYY>>/$year/g;
249                     $value =~ s/<<YY>>/$shortyear/g;
250                     $value =~ s/<<MM>>/$month/g;
251                     $value =~ s/<<DD>>/$day/g;
252
253                     # And <<USER>> with surname (?)
254                     my $username =
255                       (   C4::Context->userenv
256                         ? C4::Context->userenv->{'surname'}
257                         : "superlibrarian" );
258                     $value =~ s/<<USER>>/$username/g;
259                 }
260                 push @catalog_details, {
261                     tag      => $tag,
262                     subfield => $subfield,
263                     %$mss,    # Do we need plugins support (?)
264                     value => $value,
265                 };
266             }
267         }
268     }
269 }
270 else {    #modify order
271     $data   = GetOrder($ordernumber);
272     $budget_id = $data->{'budget_id'};
273
274     $template->param(
275         subscriptionid => $data->{subscriptionid},
276     );
277
278     $basket   = GetBasket( $data->{'basketno'} );
279     $basketno = $basket->{'basketno'};
280
281     @order_user_ids = GetOrderUsers($ordernumber);
282     foreach my $order_user_id (@order_user_ids) {
283         # FIXME Could be improved with search -in
284         my $order_patron = Koha::Patrons->find( $order_user_id );
285         push @order_users, $order_patron if $order_patron;
286     }
287 }
288 $biblionumber = $data->{biblionumber};
289
290 # We can have:
291 # - no ordernumber but a biblionumber: from a subscription, from an existing record
292 # - no ordernumber, no biblionumber: from a suggestion, from a new order
293 if ( not $ordernumber or $biblionumber ) {
294     if ( C4::Context->preference('UseACQFrameworkForBiblioRecords') ) {
295         my $record = $biblionumber ? GetMarcBiblio({ biblionumber => $biblionumber }) : undef;
296         foreach my $tag ( sort keys %{$tagslib} ) {
297             next if $tag eq '';
298             next if $tag eq $itemnumber_tag; # skip items fields
299             my @fields = $biblionumber ? $record->field($tag) : ();
300             foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
301                 my $mss = $tagslib->{$tag}{$subfield};
302                 next if IsMarcStructureInternal($mss);
303                 next if $mss->{tab} == -1;
304                 # We only need to display the values
305                 my $value = join '; ', map { $tag < 10 ? $_->data : $_->subfield( $subfield ) } @fields;
306                 if ( $value ) {
307                     push @catalog_details, {
308                         tag => $tag,
309                         subfield => $subfield,
310                         %$mss,
311                         value => $value,
312                     };
313                 }
314             }
315         }
316     }
317 }
318
319 $template->param( catalog_details => \@catalog_details, );
320
321 my $suggestion;
322 $suggestion = GetSuggestionInfo($suggestionid) if $suggestionid;
323
324 my @currencies = Koha::Acquisition::Currencies->search;
325 my $active_currency = Koha::Acquisition::Currencies->get_active;
326
327 # build bookfund list
328 my $patron = Koha::Patrons->find( $loggedinuser )->unblessed;
329
330 my $budget =  GetBudget($budget_id);
331 # build budget list
332 my $budget_loop = [];
333 my $budgets = GetBudgetHierarchy;
334 foreach my $r (@{$budgets}) {
335     next unless (CanUserUseBudget($patron, $r, $userflags));
336     push @{$budget_loop}, {
337         b_id  => $r->{budget_id},
338         b_txt => $r->{budget_name},
339         b_sort1_authcat => $r->{'sort1_authcat'},
340         b_sort2_authcat => $r->{'sort2_authcat'},
341         b_active => $r->{budget_period_active},
342         b_sel => ( $r->{budget_id} == $budget_id ) ? 1 : 0,
343         b_level => $r->{budget_level},
344     };
345 }
346
347
348 $template->param( sort1 => $data->{'sort1'} );
349 $template->param( sort2 => $data->{'sort2'} );
350
351 if ($basketobj->effective_create_items eq 'ordering' && !$ordernumber) {
352     # Check if ACQ framework exists
353     my $marc = GetMarcStructure(1, 'ACQ', { unsafe => 1 } );
354     unless($marc) {
355         $template->param('NoACQframework' => 1);
356     }
357     $template->param(
358         AcqCreateItemOrdering => 1,
359         UniqueItemFields => C4::Context->preference('UniqueItemFields'),
360     );
361 }
362
363 # Get the item types list, but only if item_level_itype is YES. Otherwise, it will be in the item, no need to display it in the biblio
364 my @itemtypes;
365 @itemtypes = Koha::ItemTypes->search unless C4::Context->preference('item-level_itypes');
366
367 if ( defined $from_subscriptionid ) {
368     # Get the last received order for this subscription
369     my $lastOrderReceived = Koha::Acquisition::Orders->search(
370         {
371             subscriptionid => $from_subscriptionid,
372             datereceived   => { '!=' => undef }
373         },
374         {
375             order_by =>
376               [ { -desc => 'datereceived' }, { -desc => 'ordernumber' } ]
377         }
378     );
379     if ( $lastOrderReceived->count ) {
380         $lastOrderReceived = $lastOrderReceived->next->unblessed; # FIXME We should send the object to the template
381         $budget_id              = $lastOrderReceived->{budgetid};
382         $data->{listprice}      = $lastOrderReceived->{listprice};
383         $data->{uncertainprice} = $lastOrderReceived->{uncertainprice};
384         $data->{tax_rate}       = $lastOrderReceived->{tax_rate_on_ordering};
385         $data->{discount}       = $lastOrderReceived->{discount};
386         $data->{rrp}            = $lastOrderReceived->{rrp};
387         $data->{replacementprice} = $lastOrderReceived->{replacementprice};
388         $data->{ecost}          = $lastOrderReceived->{ecost};
389         $data->{quantity}       = $lastOrderReceived->{quantity};
390         $data->{unitprice}       = $lastOrderReceived->{unitprice};
391         $data->{order_internalnote} = $lastOrderReceived->{order_internalnote};
392         $data->{order_vendornote}   = $lastOrderReceived->{order_vendornote};
393         $data->{sort1}          = $lastOrderReceived->{sort1};
394         $data->{sort2}          = $lastOrderReceived->{sort2};
395
396         $basket = GetBasket( $input->param('basketno') );
397     }
398
399     my $subscription = Koha::Subscriptions->find($from_subscriptionid);
400     $template->param(
401         subscriptionid => $from_subscriptionid,
402         subscription   => $subscription,
403     );
404 }
405
406 # Find the items.barcode subfield for barcode validations
407 my (undef, $barcode_subfield) = GetMarcFromKohaField( 'items.barcode' );
408
409
410 # get option values for TaxRates syspref
411 my @gst_values = map {
412     option => $_ + 0.0
413 }, split( '\|', C4::Context->preference("TaxRates") );
414
415 my $quantity = $input->param('rr_quantity_to_order') ?
416       $input->param('rr_quantity_to_order') :
417       $data->{'quantity'};
418 $quantity //= 0;
419
420 # fill template
421 $template->param(
422     existing         => $biblionumber,
423     # basket informations
424     basketname           => $basket->{'basketname'},
425     basketnote           => $basket->{'note'},
426     booksellerid         => $basket->{'booksellerid'},
427     basketbooksellernote => $basket->{booksellernote},
428     basketcontractno     => $basket->{contractnumber},
429     basketcontractname   => $contract->{contractname},
430     creationdate         => $basket->{creationdate},
431     authorisedby         => $basket->{'authorisedby'},
432     authorisedbyname     => $basket->{'authorisedbyname'},
433     closedate            => $basket->{'closedate'},
434     # order details
435     suggestionid         => $suggestion->{suggestionid},
436     surnamesuggestedby   => $suggestion->{surnamesuggestedby},
437     firstnamesuggestedby => $suggestion->{firstnamesuggestedby},
438     biblionumber         => $biblionumber,
439     uncertainprice       => $data->{'uncertainprice'},
440     discount_2dp         => sprintf( "%.2f",  $bookseller->discount ) ,   # for display
441     discount             => $bookseller->discount,
442     orderdiscount_2dp    => sprintf( "%.2f", $data->{'discount'} || 0 ),
443     orderdiscount        => $data->{'discount'},
444     order_internalnote   => $data->{'order_internalnote'},
445     order_vendornote     => $data->{'order_vendornote'},
446     listincgst       => $bookseller->listincgst,
447     invoiceincgst    => $bookseller->invoiceincgst,
448     cur_active_sym   => $active_currency->symbol,
449     cur_active       => $active_currency->currency,
450     currencies       => \@currencies,
451     currency         => $data->{currency},
452     vendor_currency  => $bookseller->listprice,
453     orderexists      => ( $new eq 'yes' ) ? 0 : 1,
454     title            => $data->{'title'},
455     author           => $data->{'author'},
456     publicationyear  => $data->{'publicationyear'} ? $data->{'publicationyear'} : $data->{'copyrightdate'},
457     editionstatement => $data->{'editionstatement'},
458     budget_loop      => $budget_loop,
459     isbn             => $data->{'isbn'},
460     ean              => $data->{'ean'},
461     seriestitle      => $data->{'seriestitle'},
462     itemtypeloop     => \@itemtypes,
463     quantity         => $quantity,
464     quantityrec      => $quantity,
465     rrp              => $data->{'rrp'},
466     replacementprice => $data->{'replacementprice'},
467     gst_values       => \@gst_values,
468     tax_rate         => $data->{tax_rate_on_ordering} ? $data->{tax_rate_on_ordering}+0.0 : $bookseller->tax_rate ? $bookseller->tax_rate+0.0 : 0,
469     listprice        => sprintf( "%.2f", $data->{listprice} || $data->{price} || $listprice),
470     total            => sprintf( "%.2f", ($data->{ecost} || 0) * ($data->{'quantity'} || 0) ),
471     ecost            => sprintf( "%.2f", $data->{ecost} || 0),
472     unitprice        => sprintf( "%.2f", $data->{unitprice} || 0),
473     publishercode    => $data->{'publishercode'},
474     barcode_subfield => $barcode_subfield,
475     import_batch_id  => $import_batch_id,
476     acqcreate        => $basketobj->effective_create_items eq "ordering" ? 1 : "",
477     users_ids        => join(':', @order_user_ids),
478     users            => \@order_users,
479     (uc(C4::Context->preference("marcflavour"))) => 1
480 );
481
482 output_html_with_http_headers $input, $cookie, $template->output;
483
484
485 =head2 MARCfindbreeding
486
487   $record = MARCfindbreeding($breedingid);
488
489 Look up the import record repository for the record with
490 record with id $breedingid.  If found, returns the decoded
491 MARC::Record; otherwise, -1 is returned (FIXME).
492 Returns as second parameter the character encoding.
493
494 =cut
495
496 sub MARCfindbreeding {
497     my ( $id ) = @_;
498     my ($marc, $encoding) = GetImportRecordMarc($id);
499     # remove the - in isbn, koha store isbn without any -
500     if ($marc) {
501         my $record = MARC::Record->new_from_usmarc($marc);
502         my ($isbnfield,$isbnsubfield) = GetMarcFromKohaField( 'biblioitems.isbn' );
503         if ( $record->field($isbnfield) ) {
504             foreach my $field ( $record->field($isbnfield) ) {
505                 foreach my $subfield ( $field->subfield($isbnsubfield) ) {
506                     my $newisbn = $field->subfield($isbnsubfield);
507                     $newisbn =~ s/-//g;
508                     $field->update( $isbnsubfield => $newisbn );
509                 }
510             }
511         }
512         # fix the unimarc 100 coded field (with unicode information)
513         if ($marcflavour eq 'UNIMARC' && $record->subfield(100,'a')) {
514             my $f100a=$record->subfield(100,'a');
515             my $f100 = $record->field(100);
516             my $f100temp = $f100->as_string;
517             $record->delete_field($f100);
518             if ( length($f100temp) > 28 ) {
519                 substr( $f100temp, 26, 2, "50" );
520                 $f100->update( 'a' => $f100temp );
521                 my $f100 = MARC::Field->new( '100', '', '', 'a' => $f100temp );
522                 $record->insert_fields_ordered($f100);
523             }
524         }
525         
526         if ( !defined(ref($record)) ) {
527             return -1;
528         }
529         else {
530             # normalize author : probably UNIMARC specific...
531             if (    C4::Context->preference("z3950NormalizeAuthor")
532                 and C4::Context->preference("z3950AuthorAuthFields") )
533             {
534                 my ( $tag, $subfield ) = GetMarcFromKohaField( "biblio.author" );
535
536                 my $auth_fields =
537                 C4::Context->preference("z3950AuthorAuthFields");
538                 my @auth_fields = split /,/, $auth_fields;
539                 my $field;
540
541                 if ( $record->field($tag) ) {
542                     foreach my $tmpfield ( $record->field($tag)->subfields ) {
543
544                         my $subfieldcode  = shift @$tmpfield;
545                         my $subfieldvalue = shift @$tmpfield;
546                         if ($field) {
547                             $field->add_subfields(
548                                 "$subfieldcode" => $subfieldvalue )
549                             if ( $subfieldcode ne $subfield );
550                         }
551                         else {
552                             $field =
553                             MARC::Field->new( $tag, "", "",
554                                 $subfieldcode => $subfieldvalue )
555                             if ( $subfieldcode ne $subfield );
556                         }
557                     }
558                 }
559                 $record->delete_field( $record->field($tag) );
560                 foreach my $fieldtag (@auth_fields) {
561                     next unless ( $record->field($fieldtag) );
562                     my $lastname  = $record->field($fieldtag)->subfield('a');
563                     my $firstname = $record->field($fieldtag)->subfield('b');
564                     my $title     = $record->field($fieldtag)->subfield('c');
565                     my $number    = $record->field($fieldtag)->subfield('d');
566                     if ($title) {
567                         $field->add_subfields(
568                                 "$subfield" => ucfirst($title) . " "
569                             . ucfirst($firstname) . " "
570                             . $number );
571                     }
572                     else {
573                         $field->add_subfields(
574                             "$subfield" => ucfirst($firstname) . ", "
575                             . ucfirst($lastname) );
576                     }
577                 }
578                 $record->insert_fields_ordered($field);
579             }
580             return $record, $encoding;
581         }
582     }
583     return -1;
584 }
585
586 sub Load_Duplicate {
587   my ($duplicatetitle)= @_;
588   ($template, $loggedinuser, $cookie) = get_template_and_user(
589     {
590         template_name   => "acqui/neworderempty_duplicate.tt",
591         query           => $input,
592         type            => "intranet",
593         flagsrequired   => { acquisition => 'order_manage' },
594 #        debug           => 1,
595     }
596   );
597
598   $template->param(
599     biblionumber        => $biblionumber,
600     basketno            => $basketno,
601     booksellerid        => $basket->{'booksellerid'},
602     breedingid          => $params->{'breedingid'},
603     duplicatetitle      => $duplicatetitle,
604     (uc(C4::Context->preference("marcflavour"))) => 1
605   );
606
607   output_html_with_http_headers $input, $cookie, $template->output;
608 }