Bug 23425: (QA follow-up) Keep it generic
[koha.git] / acqui / neworderempty.pl
blob862719b51e8c3f31667d0e1d1344c0908191141e
1 #!/usr/bin/perl
3 #script to show display basket of orders
4 #written by chris@katipo.co.nz 24/2/2000
6 # Copyright 2000-2002 Katipo Communications
8 # This file is part of Koha.
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.
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.
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>.
24 =head1 NAME
26 neworderempty.pl
28 =head1 DESCRIPTION
30 this script allows to create a new record to order it. This record shouldn't exist
31 on database.
33 =head1 CGI PARAMETERS
35 =over 4
37 =item booksellerid
38 the bookseller the librarian has to buy a new book.
40 =item title
41 the title of this new record.
43 =item author
44 the author of this new record.
46 =item publication year
47 the publication year of this new record.
49 =item ordernumber
50 the number of this order.
52 =item biblio
54 =item basketno
55 the basket number for this new order.
57 =item suggestionid
58 if this order comes from a suggestion.
60 =item breedingid
61 the item's id in the breeding reservoir
63 =item close
65 =back
67 =cut
69 use Modern::Perl;
70 use CGI qw ( -utf8 );
71 use C4::Context;
73 use C4::Auth;
74 use C4::Budgets;
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/;
86 #needed for z3950 import:
87 use C4::ImportBatch qw/GetImportRecordMarc SetImportRecordStatus/;
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 use Koha::Subscriptions;
99 our $input = new CGI;
100 my $booksellerid = $input->param('booksellerid'); # FIXME: else ERROR!
101 my $budget_id = $input->param('budget_id') || 0;
102 my $title = $input->param('title');
103 my $author = $input->param('author');
104 my $publicationyear = $input->param('publicationyear');
105 my $ordernumber = $input->param('ordernumber') || '';
106 our $biblionumber = $input->param('biblionumber');
107 our $basketno = $input->param('basketno');
108 my $suggestionid = $input->param('suggestionid');
109 my $close = $input->param('close');
110 my $uncertainprice = $input->param('uncertainprice');
111 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 !
112 my $from_subscriptionid = $input->param('from_subscriptionid');
113 my $data;
114 my $new = 'no';
116 my $budget_name;
118 our ( $template, $loggedinuser, $cookie, $userflags ) = get_template_and_user(
120 template_name => "acqui/neworderempty.tt",
121 query => $input,
122 type => "intranet",
123 authnotrequired => 0,
124 flagsrequired => { acquisition => 'order_manage' },
125 debug => 1,
129 our $marcflavour = C4::Context->preference('marcflavour');
131 if(!$basketno) {
132 my $order = GetOrder($ordernumber);
133 $basketno = $order->{'basketno'};
136 our $basket = GetBasket($basketno);
137 my $basketobj = Koha::Acquisition::Baskets->find( $basketno );
138 $booksellerid = $basket->{booksellerid} unless $booksellerid;
139 my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
141 output_and_exit( $input, $cookie, $template, 'unknown_basket') unless $basketobj;
142 output_and_exit( $input, $cookie, $template, 'unknown_vendor') unless $bookseller;
144 my $contract = GetContract({
145 contractnumber => $basket->{contractnumber}
148 #simple parameters reading (all in one :-)
149 our $params = $input->Vars;
150 my $listprice=0; # the price, that can be in MARC record if we have one
151 if ( $ordernumber eq '' and defined $params->{'breedingid'}){
152 #we want to import from the breeding reservoir (from a z3950 search)
153 my ($marcrecord, $encoding) = MARCfindbreeding($params->{'breedingid'});
154 die("Could not find the selected record in the reservoir, bailing") unless $marcrecord;
156 # Remove all the items (952) from the imported record
157 foreach my $item ($marcrecord->field('952')) {
158 $marcrecord->delete_field($item);
161 my $duplicatetitle;
162 #look for duplicates
163 ($biblionumber,$duplicatetitle) = FindDuplicate($marcrecord);
164 if($biblionumber && !$input->param('use_external_source')) {
165 #if duplicate record found and user did not decide yet, first warn user
166 #and let them choose between using a new record or an existing record
167 Load_Duplicate($duplicatetitle);
168 exit;
170 #from this point: add a new record
171 my $bibitemnum;
172 $params->{'frameworkcode'} or $params->{'frameworkcode'} = "";
173 ( $biblionumber, $bibitemnum ) = AddBiblio( $marcrecord, $params->{'frameworkcode'} );
174 # get the price if there is one.
175 $listprice = GetMarcPrice($marcrecord, $marcflavour);
176 SetImportRecordStatus($params->{'breedingid'}, 'imported');
181 my ( @order_user_ids, @order_users, @catalog_details );
182 our $tagslib = GetMarcStructure(1, 'ACQ', { unsafe => 1 } );
183 my ( $itemnumber_tag, $itemnumber_subtag ) = GetMarcFromKohaField( 'items.itemnumber' );
184 if ( not $ordernumber ) { # create order
185 $new = 'yes';
187 if ( $biblionumber ) {
188 $data = GetBiblioData($biblionumber);
190 # get suggestion fields if applicable. If it's a subscription renewal, then the biblio already exists
191 # otherwise, retrieve suggestion information.
192 elsif ($suggestionid) {
193 $data = GetSuggestion($suggestionid);
194 $budget_id ||= $data->{'budgetid'} // 0;
197 if ( not $biblionumber and Koha::BiblioFrameworks->find('ACQ') ) {
198 #my $acq_mss = Koha::MarcSubfieldStructures->search({ frameworkcode => 'ACQ', tagfield => { '!=' => $itemnumber_tag } });
199 foreach my $tag ( sort keys %{$tagslib} ) {
200 next if $tag eq '';
201 next if $tag eq $itemnumber_tag; # skip items fields
202 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
203 my $mss = $tagslib->{$tag}{$subfield};
204 next if IsMarcStructureInternal($mss);
205 next if $mss->{tab} == -1;
206 my $value = $mss->{defaultvalue};
208 if ($suggestionid and $mss->{kohafield}) {
209 # Reading suggestion info if ordering from a suggestion
210 if ( $mss->{kohafield} eq 'biblio.title' ) {
211 $value = $data->{title};
213 elsif ( $mss->{kohafield} eq 'biblio.author' ) {
214 $value = $data->{author};
216 elsif ( $mss->{kohafield} eq 'biblioitems.publishercode' ) {
217 $value = $data->{publishercode};
219 elsif ( $mss->{kohafield} eq 'biblioitems.editionstatement' ) {
220 $value = $data->{editionstatement};
222 elsif ( $mss->{kohafield} eq 'biblioitems.publicationyear' ) {
223 $value = $data->{publicationyear};
225 elsif ( $mss->{kohafield} eq 'biblioitems.isbn' ) {
226 $value = $data->{isbn};
228 elsif ( $mss->{kohafield} eq 'biblio.seriestitle' ) {
229 $value = $data->{seriestitle};
233 if ( $value eq '' ) {
235 # get today date & replace <<YYYY>>, <<MM>>, <<DD>> if provided in the default value
236 my $today_dt = dt_from_string;
237 my $year = $today_dt->strftime('%Y');
238 my $month = $today_dt->strftime('%m');
239 my $day = $today_dt->strftime('%d');
240 $value =~ s/<<YYYY>>/$year/g;
241 $value =~ s/<<MM>>/$month/g;
242 $value =~ s/<<DD>>/$day/g;
244 # And <<USER>> with surname (?)
245 my $username =
246 ( C4::Context->userenv
247 ? C4::Context->userenv->{'surname'}
248 : "superlibrarian" );
249 $value =~ s/<<USER>>/$username/g;
251 push @catalog_details, {
252 tag => $tag,
253 subfield => $subfield,
254 %$mss, # Do we need plugins support (?)
255 value => $value,
261 else { #modify order
262 $data = GetOrder($ordernumber);
263 $biblionumber = $data->{'biblionumber'};
264 $budget_id = $data->{'budget_id'};
266 $template->param(
267 subscriptionid => $data->{subscriptionid},
270 $basket = GetBasket( $data->{'basketno'} );
271 $basketno = $basket->{'basketno'};
273 @order_user_ids = GetOrderUsers($ordernumber);
274 foreach my $order_user_id (@order_user_ids) {
275 # FIXME Could be improved with search -in
276 my $order_patron = Koha::Patrons->find( $order_user_id );
277 push @order_users, $order_patron if $order_patron;
281 # We can have:
282 # - no ordernumber but a biblionumber: from a subscription, from an existing record
283 # - no ordernumber, no biblionumber: from a suggestion, from a new order
284 if ( not $ordernumber or $biblionumber ) {
285 if ( C4::Context->preference('UseACQFrameworkForBiblioRecords') ) {
286 my $record = $biblionumber ? GetMarcBiblio({ biblionumber => $biblionumber }) : undef;
287 foreach my $tag ( sort keys %{$tagslib} ) {
288 next if $tag eq '';
289 next if $tag eq $itemnumber_tag; # skip items fields
290 my @fields = $biblionumber ? $record->field($tag) : ();
291 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
292 my $mss = $tagslib->{$tag}{$subfield};
293 next if IsMarcStructureInternal($mss);
294 next if $mss->{tab} == -1;
295 # We only need to display the values
296 my $value = join '; ', map { $tag < 10 ? $_->data : $_->subfield( $subfield ) } @fields;
297 if ( $value ) {
298 push @catalog_details, {
299 tag => $tag,
300 subfield => $subfield,
301 %$mss,
302 value => $value,
310 $template->param( catalog_details => \@catalog_details, );
312 my $suggestion;
313 $suggestion = GetSuggestionInfo($suggestionid) if $suggestionid;
315 my @currencies = Koha::Acquisition::Currencies->search;
316 my $active_currency = Koha::Acquisition::Currencies->get_active;
318 # build bookfund list
319 my $patron = Koha::Patrons->find( $loggedinuser )->unblessed;
321 my $budget = GetBudget($budget_id);
322 # build budget list
323 my $budget_loop = [];
324 my $budgets = GetBudgetHierarchy;
325 foreach my $r (@{$budgets}) {
326 next unless (CanUserUseBudget($patron, $r, $userflags));
327 if (!defined $r->{budget_amount} || $r->{budget_amount} <0) {
328 next;
330 push @{$budget_loop}, {
331 b_id => $r->{budget_id},
332 b_txt => $r->{budget_name},
333 b_sort1_authcat => $r->{'sort1_authcat'},
334 b_sort2_authcat => $r->{'sort2_authcat'},
335 b_active => $r->{budget_period_active},
336 b_sel => ( $r->{budget_id} == $budget_id ) ? 1 : 0,
337 b_level => $r->{budget_level},
341 if ($close) {
342 $budget_id = $data->{'budget_id'};
343 $budget_name = $budget->{'budget_name'};
347 $template->param( sort1 => $data->{'sort1'} );
348 $template->param( sort2 => $data->{'sort2'} );
350 if ($basketobj->effective_create_items eq 'ordering' && !$ordernumber) {
351 # Check if ACQ framework exists
352 my $marc = GetMarcStructure(1, 'ACQ', { unsafe => 1 } );
353 unless($marc) {
354 $template->param('NoACQframework' => 1);
356 $template->param(
357 AcqCreateItemOrdering => 1,
358 UniqueItemFields => C4::Context->preference('UniqueItemFields'),
362 # 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
363 my @itemtypes;
364 @itemtypes = Koha::ItemTypes->search unless C4::Context->preference('item-level_itypes');
366 if ( defined $from_subscriptionid ) {
367 my $lastOrderReceived = GetLastOrderReceivedFromSubscriptionid $from_subscriptionid;
368 if ( defined $lastOrderReceived ) {
369 $budget_id = $lastOrderReceived->{budgetid};
370 $data->{listprice} = $lastOrderReceived->{listprice};
371 $data->{uncertainprice} = $lastOrderReceived->{uncertainprice};
372 $data->{tax_rate} = $lastOrderReceived->{tax_rate_on_ordering};
373 $data->{discount} = $lastOrderReceived->{discount};
374 $data->{rrp} = $lastOrderReceived->{rrp};
375 $data->{replacementprice} = $lastOrderReceived->{replacementprice};
376 $data->{ecost} = $lastOrderReceived->{ecost};
377 $data->{quantity} = $lastOrderReceived->{quantity};
378 $data->{unitprice} = $lastOrderReceived->{unitprice};
379 $data->{order_internalnote} = $lastOrderReceived->{order_internalnote};
380 $data->{order_vendornote} = $lastOrderReceived->{order_vendornote};
381 $data->{sort1} = $lastOrderReceived->{sort1};
382 $data->{sort2} = $lastOrderReceived->{sort2};
384 $basket = GetBasket( $input->param('basketno') );
387 my $subscription = Koha::Subscriptions->find($from_subscriptionid);
388 $template->param(
389 subscriptionid => $from_subscriptionid,
390 subscription => $subscription,
394 # Find the items.barcode subfield for barcode validations
395 my (undef, $barcode_subfield) = GetMarcFromKohaField( 'items.barcode' );
397 # fill template
398 $template->param(
399 close => $close,
400 budget_id => $budget_id,
401 budget_name => $budget_name
402 ) if ($close);
404 # get option values for gist syspref
405 my @gst_values = map {
406 option => $_ + 0.0
407 }, split( '\|', C4::Context->preference("gist") );
409 my $quantity = $input->param('rr_quantity_to_order') ?
410 $input->param('rr_quantity_to_order') :
411 $data->{'quantity'};
412 $quantity //= 0;
414 $template->param(
415 existing => $biblionumber,
416 ordernumber => $ordernumber,
417 # basket informations
418 basketno => $basketno,
419 basket => $basket,
420 basketname => $basket->{'basketname'},
421 basketnote => $basket->{'note'},
422 booksellerid => $basket->{'booksellerid'},
423 basketbooksellernote => $basket->{booksellernote},
424 basketcontractno => $basket->{contractnumber},
425 basketcontractname => $contract->{contractname},
426 creationdate => $basket->{creationdate},
427 authorisedby => $basket->{'authorisedby'},
428 authorisedbyname => $basket->{'authorisedbyname'},
429 closedate => $basket->{'closedate'},
430 # order details
431 suggestionid => $suggestion->{suggestionid},
432 surnamesuggestedby => $suggestion->{surnamesuggestedby},
433 firstnamesuggestedby => $suggestion->{firstnamesuggestedby},
434 biblionumber => $biblionumber,
435 uncertainprice => $data->{'uncertainprice'},
436 discount_2dp => sprintf( "%.2f", $bookseller->discount ) , # for display
437 discount => $bookseller->discount,
438 orderdiscount_2dp => sprintf( "%.2f", $data->{'discount'} || 0 ),
439 orderdiscount => $data->{'discount'},
440 order_internalnote => $data->{'order_internalnote'},
441 order_vendornote => $data->{'order_vendornote'},
442 listincgst => $bookseller->listincgst,
443 invoiceincgst => $bookseller->invoiceincgst,
444 name => $bookseller->name,
445 cur_active_sym => $active_currency->symbol,
446 cur_active => $active_currency->currency,
447 currencies => \@currencies,
448 currency => $data->{currency},
449 vendor_currency => $bookseller->listprice,
450 orderexists => ( $new eq 'yes' ) ? 0 : 1,
451 title => $data->{'title'},
452 author => $data->{'author'},
453 publicationyear => $data->{'publicationyear'} ? $data->{'publicationyear'} : $data->{'copyrightdate'},
454 editionstatement => $data->{'editionstatement'},
455 budget_loop => $budget_loop,
456 isbn => $data->{'isbn'},
457 ean => $data->{'ean'},
458 seriestitle => $data->{'seriestitle'},
459 itemtypeloop => \@itemtypes,
460 quantity => $quantity,
461 quantityrec => $quantity,
462 rrp => $data->{'rrp'},
463 replacementprice => $data->{'replacementprice'},
464 gst_values => \@gst_values,
465 tax_rate => $data->{tax_rate_on_ordering} ? $data->{tax_rate_on_ordering}+0.0 : $bookseller->tax_rate ? $bookseller->tax_rate+0.0 : 0,
466 listprice => sprintf( "%.2f", $data->{listprice} || $data->{price} || $listprice),
467 total => sprintf( "%.2f", ($data->{ecost} || 0) * ($data->{'quantity'} || 0) ),
468 ecost => sprintf( "%.2f", $data->{ecost} || 0),
469 unitprice => sprintf( "%.2f", $data->{unitprice} || 0),
470 publishercode => $data->{'publishercode'},
471 barcode_subfield => $barcode_subfield,
472 import_batch_id => $import_batch_id,
473 acqcreate => $basketobj->effective_create_items eq "ordering" ? 1 : "",
474 users_ids => join(':', @order_user_ids),
475 users => \@order_users,
476 (uc(C4::Context->preference("marcflavour"))) => 1
479 output_html_with_http_headers $input, $cookie, $template->output;
482 =head2 MARCfindbreeding
484 $record = MARCfindbreeding($breedingid);
486 Look up the import record repository for the record with
487 record with id $breedingid. If found, returns the decoded
488 MARC::Record; otherwise, -1 is returned (FIXME).
489 Returns as second parameter the character encoding.
491 =cut
493 sub MARCfindbreeding {
494 my ( $id ) = @_;
495 my ($marc, $encoding) = GetImportRecordMarc($id);
496 # remove the - in isbn, koha store isbn without any -
497 if ($marc) {
498 my $record = MARC::Record->new_from_usmarc($marc);
499 my ($isbnfield,$isbnsubfield) = GetMarcFromKohaField( 'biblioitems.isbn' );
500 if ( $record->field($isbnfield) ) {
501 foreach my $field ( $record->field($isbnfield) ) {
502 foreach my $subfield ( $field->subfield($isbnsubfield) ) {
503 my $newisbn = $field->subfield($isbnsubfield);
504 $newisbn =~ s/-//g;
505 $field->update( $isbnsubfield => $newisbn );
509 # fix the unimarc 100 coded field (with unicode information)
510 if ($marcflavour eq 'UNIMARC' && $record->subfield(100,'a')) {
511 my $f100a=$record->subfield(100,'a');
512 my $f100 = $record->field(100);
513 my $f100temp = $f100->as_string;
514 $record->delete_field($f100);
515 if ( length($f100temp) > 28 ) {
516 substr( $f100temp, 26, 2, "50" );
517 $f100->update( 'a' => $f100temp );
518 my $f100 = MARC::Field->new( '100', '', '', 'a' => $f100temp );
519 $record->insert_fields_ordered($f100);
523 if ( !defined(ref($record)) ) {
524 return -1;
526 else {
527 # normalize author : probably UNIMARC specific...
528 if ( C4::Context->preference("z3950NormalizeAuthor")
529 and C4::Context->preference("z3950AuthorAuthFields") )
531 my ( $tag, $subfield ) = GetMarcFromKohaField( "biblio.author" );
533 my $auth_fields =
534 C4::Context->preference("z3950AuthorAuthFields");
535 my @auth_fields = split /,/, $auth_fields;
536 my $field;
538 if ( $record->field($tag) ) {
539 foreach my $tmpfield ( $record->field($tag)->subfields ) {
541 my $subfieldcode = shift @$tmpfield;
542 my $subfieldvalue = shift @$tmpfield;
543 if ($field) {
544 $field->add_subfields(
545 "$subfieldcode" => $subfieldvalue )
546 if ( $subfieldcode ne $subfield );
548 else {
549 $field =
550 MARC::Field->new( $tag, "", "",
551 $subfieldcode => $subfieldvalue )
552 if ( $subfieldcode ne $subfield );
556 $record->delete_field( $record->field($tag) );
557 foreach my $fieldtag (@auth_fields) {
558 next unless ( $record->field($fieldtag) );
559 my $lastname = $record->field($fieldtag)->subfield('a');
560 my $firstname = $record->field($fieldtag)->subfield('b');
561 my $title = $record->field($fieldtag)->subfield('c');
562 my $number = $record->field($fieldtag)->subfield('d');
563 if ($title) {
564 $field->add_subfields(
565 "$subfield" => ucfirst($title) . " "
566 . ucfirst($firstname) . " "
567 . $number );
569 else {
570 $field->add_subfields(
571 "$subfield" => ucfirst($firstname) . ", "
572 . ucfirst($lastname) );
575 $record->insert_fields_ordered($field);
577 return $record, $encoding;
580 return -1;
583 sub Load_Duplicate {
584 my ($duplicatetitle)= @_;
585 ($template, $loggedinuser, $cookie) = get_template_and_user(
587 template_name => "acqui/neworderempty_duplicate.tt",
588 query => $input,
589 type => "intranet",
590 authnotrequired => 0,
591 flagsrequired => { acquisition => 'order_manage' },
592 # debug => 1,
596 $template->param(
597 biblionumber => $biblionumber,
598 basketno => $basketno,
599 booksellerid => $basket->{'booksellerid'},
600 breedingid => $params->{'breedingid'},
601 duplicatetitle => $duplicatetitle,
602 (uc(C4::Context->preference("marcflavour"))) => 1
605 output_html_with_http_headers $input, $cookie, $template->output;