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