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>.
30 this script allows to create a new record to order it. This record shouldn't exist
38 the bookseller the librarian has to buy a new book.
41 the title of this new record.
44 the author of this new record.
46 =item publication year
47 the publication year of this new record.
50 the number of this order.
55 the basket number for this new order.
58 if this order comes from a suggestion.
61 the item's id in the breeding reservoir
76 use C4::Suggestions; # GetSuggestion
77 use C4::Biblio; # GetBiblioData GetMarcPrice
78 use C4::Items; #PrepareItemRecord
82 use C4::Search qw/FindDuplicate/;
84 #needed for z3950 import:
85 use C4::ImportBatch qw/GetImportRecordMarc SetImportRecordStatus/;
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;
94 use Koha::RecordProcessor;
95 use Koha::Subscriptions;
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');
113 our ( $template, $loggedinuser, $cookie, $userflags ) = get_template_and_user(
115 template_name => "acqui/neworderempty.tt",
118 authnotrequired => 0,
119 flagsrequired => { acquisition => 'order_manage' },
124 our $marcflavour = C4::Context->preference('marcflavour');
127 my $order = GetOrder($ordernumber);
128 $basketno = $order->{'basketno'};
131 our $basket = GetBasket($basketno);
132 my $basketobj = Koha::Acquisition::Baskets->find( $basketno );
133 $booksellerid = $basket->{booksellerid} unless $booksellerid;
134 my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
136 output_and_exit( $input, $cookie, $template, 'unknown_basket') unless $basketobj;
137 output_and_exit( $input, $cookie, $template, 'unknown_vendor') unless $bookseller;
139 my $contract = GetContract({
140 contractnumber => $basket->{contractnumber}
143 #simple parameters reading (all in one :-)
144 our $params = $input->Vars;
145 my $listprice=0; # the price, that can be in MARC record if we have one
146 if ( $ordernumber eq '' and defined $params->{'breedingid'}){
147 #we want to import from the breeding reservoir (from a z3950 search)
148 my ($marcrecord, $encoding) = MARCfindbreeding($params->{'breedingid'});
149 die("Could not find the selected record in the reservoir, bailing") unless $marcrecord;
151 # Remove all the items (952) from the imported record
152 foreach my $item ($marcrecord->field('952')) {
153 $marcrecord->delete_field($item);
158 ($biblionumber,$duplicatetitle) = FindDuplicate($marcrecord);
159 if($biblionumber && !$input->param('use_external_source')) {
160 #if duplicate record found and user did not decide yet, first warn user
161 #and let them choose between using a new record or an existing record
162 Load_Duplicate($duplicatetitle);
165 #from this point: add a new record
166 C4::Acquisition::FillWithDefaultValues($marcrecord, {only_mandatory => 1});
168 $params->{'frameworkcode'} or $params->{'frameworkcode'} = "";
169 ( $biblionumber, $bibitemnum ) = AddBiblio( $marcrecord, $params->{'frameworkcode'} );
170 # get the price if there is one.
171 $listprice = GetMarcPrice($marcrecord, $marcflavour);
172 SetImportRecordStatus($params->{'breedingid'}, 'imported');
177 my ( @order_user_ids, @order_users, @catalog_details );
178 our $tagslib = GetMarcStructure(1, 'ACQ', { unsafe => 1 } );
179 my ( $itemnumber_tag, $itemnumber_subtag ) = GetMarcFromKohaField( 'items.itemnumber' );
180 if ( not $ordernumber ) { # create order
183 if ( $biblionumber ) {
184 $data = GetBiblioData($biblionumber);
186 # get suggestion fields if applicable. If it's a subscription renewal, then the biblio already exists
187 # otherwise, retrieve suggestion information.
188 elsif ($suggestionid) {
189 $data = GetSuggestion($suggestionid);
190 $budget_id ||= $data->{'budgetid'} // 0;
193 if ( not $biblionumber and Koha::BiblioFrameworks->find('ACQ') ) {
194 #my $acq_mss = Koha::MarcSubfieldStructures->search({ frameworkcode => 'ACQ', tagfield => { '!=' => $itemnumber_tag } });
195 foreach my $tag ( sort keys %{$tagslib} ) {
197 next if $tag eq $itemnumber_tag; # skip items fields
198 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
199 my $mss = $tagslib->{$tag}{$subfield};
200 next if IsMarcStructureInternal($mss);
201 next if $mss->{tab} == -1;
202 my $value = $mss->{defaultvalue};
204 if ($suggestionid and $mss->{kohafield}) {
205 # Reading suggestion info if ordering from a suggestion
206 if ( $mss->{kohafield} eq 'biblio.title' ) {
207 $value = $data->{title};
209 elsif ( $mss->{kohafield} eq 'biblio.author' ) {
210 $value = $data->{author};
212 elsif ( $mss->{kohafield} eq 'biblioitems.publishercode' ) {
213 $value = $data->{publishercode};
215 elsif ( $mss->{kohafield} eq 'biblioitems.editionstatement' ) {
216 $value = $data->{editionstatement};
218 elsif ( $mss->{kohafield} eq 'biblioitems.publicationyear' ) {
219 $value = $data->{publicationyear};
221 elsif ( $mss->{kohafield} eq 'biblioitems.isbn' ) {
222 $value = $data->{isbn};
224 elsif ( $mss->{kohafield} eq 'biblio.seriestitle' ) {
225 $value = $data->{seriestitle};
231 # get today date & replace <<YYYY>>, <<MM>>, <<DD>> if provided in the default value
232 my $today_dt = dt_from_string;
233 my $year = $today_dt->strftime('%Y');
234 my $month = $today_dt->strftime('%m');
235 my $day = $today_dt->strftime('%d');
236 $value =~ s/<<YYYY>>/$year/g;
237 $value =~ s/<<MM>>/$month/g;
238 $value =~ s/<<DD>>/$day/g;
240 # And <<USER>> with surname (?)
242 ( C4::Context->userenv
243 ? C4::Context->userenv->{'surname'}
244 : "superlibrarian" );
245 $value =~ s/<<USER>>/$username/g;
247 push @catalog_details, {
249 subfield => $subfield,
250 %$mss, # Do we need plugins support (?)
258 $data = GetOrder($ordernumber);
259 $budget_id = $data->{'budget_id'};
262 subscriptionid => $data->{subscriptionid},
265 $basket = GetBasket( $data->{'basketno'} );
266 $basketno = $basket->{'basketno'};
268 @order_user_ids = GetOrderUsers($ordernumber);
269 foreach my $order_user_id (@order_user_ids) {
270 # FIXME Could be improved with search -in
271 my $order_patron = Koha::Patrons->find( $order_user_id );
272 push @order_users, $order_patron if $order_patron;
275 $biblionumber = $data->{biblionumber};
278 # - no ordernumber but a biblionumber: from a subscription, from an existing record
279 # - no ordernumber, no biblionumber: from a suggestion, from a new order
280 if ( not $ordernumber or $biblionumber ) {
281 if ( C4::Context->preference('UseACQFrameworkForBiblioRecords') ) {
282 my $record = $biblionumber ? GetMarcBiblio({ biblionumber => $biblionumber }) : undef;
283 foreach my $tag ( sort keys %{$tagslib} ) {
285 next if $tag eq $itemnumber_tag; # skip items fields
286 my @fields = $biblionumber ? $record->field($tag) : ();
287 foreach my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
288 my $mss = $tagslib->{$tag}{$subfield};
289 next if IsMarcStructureInternal($mss);
290 next if $mss->{tab} == -1;
291 # We only need to display the values
292 my $value = join '; ', map { $tag < 10 ? $_->data : $_->subfield( $subfield ) } @fields;
294 push @catalog_details, {
296 subfield => $subfield,
306 $template->param( catalog_details => \@catalog_details, );
309 $suggestion = GetSuggestionInfo($suggestionid) if $suggestionid;
311 my @currencies = Koha::Acquisition::Currencies->search;
312 my $active_currency = Koha::Acquisition::Currencies->get_active;
314 # build bookfund list
315 my $patron = Koha::Patrons->find( $loggedinuser )->unblessed;
317 my $budget = GetBudget($budget_id);
319 my $budget_loop = [];
320 my $budgets = GetBudgetHierarchy;
321 foreach my $r (@{$budgets}) {
322 next unless (CanUserUseBudget($patron, $r, $userflags));
323 push @{$budget_loop}, {
324 b_id => $r->{budget_id},
325 b_txt => $r->{budget_name},
326 b_sort1_authcat => $r->{'sort1_authcat'},
327 b_sort2_authcat => $r->{'sort2_authcat'},
328 b_active => $r->{budget_period_active},
329 b_sel => ( $r->{budget_id} == $budget_id ) ? 1 : 0,
330 b_level => $r->{budget_level},
335 $template->param( sort1 => $data->{'sort1'} );
336 $template->param( sort2 => $data->{'sort2'} );
338 if ($basketobj->effective_create_items eq 'ordering' && !$ordernumber) {
339 # Check if ACQ framework exists
340 my $marc = GetMarcStructure(1, 'ACQ', { unsafe => 1 } );
342 $template->param('NoACQframework' => 1);
345 AcqCreateItemOrdering => 1,
346 UniqueItemFields => C4::Context->preference('UniqueItemFields'),
350 # 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
352 @itemtypes = Koha::ItemTypes->search unless C4::Context->preference('item-level_itypes');
354 if ( defined $from_subscriptionid ) {
355 # Get the last received order for this subscription
356 my $lastOrderReceived = Koha::Acquisition::Orders->search(
358 subscriptionid => $from_subscriptionid,
359 datereceived => { '!=' => undef }
363 [ { -desc => 'datereceived' }, { -desc => 'ordernumber' } ]
366 if ( $lastOrderReceived->count ) {
367 $lastOrderReceived = $lastOrderReceived->next->unblessed; # FIXME We should send the object to the template
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};
383 $basket = GetBasket( $input->param('basketno') );
386 my $subscription = Koha::Subscriptions->find($from_subscriptionid);
388 subscriptionid => $from_subscriptionid,
389 subscription => $subscription,
393 # Find the items.barcode subfield for barcode validations
394 my (undef, $barcode_subfield) = GetMarcFromKohaField( 'items.barcode' );
397 # get option values for gist syspref
398 my @gst_values = map {
400 }, split( '\|', C4::Context->preference("gist") );
402 my $quantity = $input->param('rr_quantity_to_order') ?
403 $input->param('rr_quantity_to_order') :
409 existing => $biblionumber,
410 ordernumber => $ordernumber,
411 # basket informations
412 basketno => $basketno,
414 basketname => $basket->{'basketname'},
415 basketnote => $basket->{'note'},
416 booksellerid => $basket->{'booksellerid'},
417 basketbooksellernote => $basket->{booksellernote},
418 basketcontractno => $basket->{contractnumber},
419 basketcontractname => $contract->{contractname},
420 creationdate => $basket->{creationdate},
421 authorisedby => $basket->{'authorisedby'},
422 authorisedbyname => $basket->{'authorisedbyname'},
423 closedate => $basket->{'closedate'},
425 suggestionid => $suggestion->{suggestionid},
426 surnamesuggestedby => $suggestion->{surnamesuggestedby},
427 firstnamesuggestedby => $suggestion->{firstnamesuggestedby},
428 biblionumber => $biblionumber,
429 uncertainprice => $data->{'uncertainprice'},
430 discount_2dp => sprintf( "%.2f", $bookseller->discount ) , # for display
431 discount => $bookseller->discount,
432 orderdiscount_2dp => sprintf( "%.2f", $data->{'discount'} || 0 ),
433 orderdiscount => $data->{'discount'},
434 order_internalnote => $data->{'order_internalnote'},
435 order_vendornote => $data->{'order_vendornote'},
436 listincgst => $bookseller->listincgst,
437 invoiceincgst => $bookseller->invoiceincgst,
438 name => $bookseller->name,
439 cur_active_sym => $active_currency->symbol,
440 cur_active => $active_currency->currency,
441 currencies => \@currencies,
442 currency => $data->{currency},
443 vendor_currency => $bookseller->listprice,
444 orderexists => ( $new eq 'yes' ) ? 0 : 1,
445 title => $data->{'title'},
446 author => $data->{'author'},
447 publicationyear => $data->{'publicationyear'} ? $data->{'publicationyear'} : $data->{'copyrightdate'},
448 editionstatement => $data->{'editionstatement'},
449 budget_loop => $budget_loop,
450 isbn => $data->{'isbn'},
451 ean => $data->{'ean'},
452 seriestitle => $data->{'seriestitle'},
453 itemtypeloop => \@itemtypes,
454 quantity => $quantity,
455 quantityrec => $quantity,
456 rrp => $data->{'rrp'},
457 replacementprice => $data->{'replacementprice'},
458 gst_values => \@gst_values,
459 tax_rate => $data->{tax_rate_on_ordering} ? $data->{tax_rate_on_ordering}+0.0 : $bookseller->tax_rate ? $bookseller->tax_rate+0.0 : 0,
460 listprice => sprintf( "%.2f", $data->{listprice} || $data->{price} || $listprice),
461 total => sprintf( "%.2f", ($data->{ecost} || 0) * ($data->{'quantity'} || 0) ),
462 ecost => sprintf( "%.2f", $data->{ecost} || 0),
463 unitprice => sprintf( "%.2f", $data->{unitprice} || 0),
464 publishercode => $data->{'publishercode'},
465 barcode_subfield => $barcode_subfield,
466 import_batch_id => $import_batch_id,
467 acqcreate => $basketobj->effective_create_items eq "ordering" ? 1 : "",
468 users_ids => join(':', @order_user_ids),
469 users => \@order_users,
470 (uc(C4::Context->preference("marcflavour"))) => 1
473 output_html_with_http_headers $input, $cookie, $template->output;
476 =head2 MARCfindbreeding
478 $record = MARCfindbreeding($breedingid);
480 Look up the import record repository for the record with
481 record with id $breedingid. If found, returns the decoded
482 MARC::Record; otherwise, -1 is returned (FIXME).
483 Returns as second parameter the character encoding.
487 sub MARCfindbreeding {
489 my ($marc, $encoding) = GetImportRecordMarc($id);
490 # remove the - in isbn, koha store isbn without any -
492 my $record = MARC::Record->new_from_usmarc($marc);
493 my ($isbnfield,$isbnsubfield) = GetMarcFromKohaField( 'biblioitems.isbn' );
494 if ( $record->field($isbnfield) ) {
495 foreach my $field ( $record->field($isbnfield) ) {
496 foreach my $subfield ( $field->subfield($isbnsubfield) ) {
497 my $newisbn = $field->subfield($isbnsubfield);
499 $field->update( $isbnsubfield => $newisbn );
503 # fix the unimarc 100 coded field (with unicode information)
504 if ($marcflavour eq 'UNIMARC' && $record->subfield(100,'a')) {
505 my $f100a=$record->subfield(100,'a');
506 my $f100 = $record->field(100);
507 my $f100temp = $f100->as_string;
508 $record->delete_field($f100);
509 if ( length($f100temp) > 28 ) {
510 substr( $f100temp, 26, 2, "50" );
511 $f100->update( 'a' => $f100temp );
512 my $f100 = MARC::Field->new( '100', '', '', 'a' => $f100temp );
513 $record->insert_fields_ordered($f100);
517 if ( !defined(ref($record)) ) {
521 # normalize author : probably UNIMARC specific...
522 if ( C4::Context->preference("z3950NormalizeAuthor")
523 and C4::Context->preference("z3950AuthorAuthFields") )
525 my ( $tag, $subfield ) = GetMarcFromKohaField( "biblio.author" );
528 C4::Context->preference("z3950AuthorAuthFields");
529 my @auth_fields = split /,/, $auth_fields;
532 if ( $record->field($tag) ) {
533 foreach my $tmpfield ( $record->field($tag)->subfields ) {
535 my $subfieldcode = shift @$tmpfield;
536 my $subfieldvalue = shift @$tmpfield;
538 $field->add_subfields(
539 "$subfieldcode" => $subfieldvalue )
540 if ( $subfieldcode ne $subfield );
544 MARC::Field->new( $tag, "", "",
545 $subfieldcode => $subfieldvalue )
546 if ( $subfieldcode ne $subfield );
550 $record->delete_field( $record->field($tag) );
551 foreach my $fieldtag (@auth_fields) {
552 next unless ( $record->field($fieldtag) );
553 my $lastname = $record->field($fieldtag)->subfield('a');
554 my $firstname = $record->field($fieldtag)->subfield('b');
555 my $title = $record->field($fieldtag)->subfield('c');
556 my $number = $record->field($fieldtag)->subfield('d');
558 $field->add_subfields(
559 "$subfield" => ucfirst($title) . " "
560 . ucfirst($firstname) . " "
564 $field->add_subfields(
565 "$subfield" => ucfirst($firstname) . ", "
566 . ucfirst($lastname) );
569 $record->insert_fields_ordered($field);
571 return $record, $encoding;
578 my ($duplicatetitle)= @_;
579 ($template, $loggedinuser, $cookie) = get_template_and_user(
581 template_name => "acqui/neworderempty_duplicate.tt",
584 authnotrequired => 0,
585 flagsrequired => { acquisition => 'order_manage' },
591 biblionumber => $biblionumber,
592 basketno => $basketno,
593 booksellerid => $basket->{'booksellerid'},
594 breedingid => $params->{'breedingid'},
595 duplicatetitle => $duplicatetitle,
596 (uc(C4::Context->preference("marcflavour"))) => 1
599 output_html_with_http_headers $input, $cookie, $template->output;