Bug 22955: Markup error in OPAC lists template
[koha.git] / C4 / Acquisition.pm
blob38bb24186b64798265eccbaad38e2d9bc9a436f1
1 package C4::Acquisition;
3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 use Modern::Perl;
22 use Carp;
23 use C4::Context;
24 use C4::Debug;
25 use C4::Suggestions;
26 use C4::Biblio;
27 use C4::Contract;
28 use C4::Debug;
29 use C4::Templates qw(gettemplate);
30 use Koha::DateUtils qw( dt_from_string output_pref );
31 use Koha::Acquisition::Baskets;
32 use Koha::Acquisition::Booksellers;
33 use Koha::Acquisition::Orders;
34 use Koha::Biblios;
35 use Koha::Exceptions;
36 use Koha::Items;
37 use Koha::Number::Price;
38 use Koha::Libraries;
39 use Koha::CsvProfiles;
40 use Koha::Patrons;
42 use C4::Koha;
44 use MARC::Field;
45 use MARC::Record;
47 use Time::localtime;
49 use vars qw(@ISA @EXPORT);
51 BEGIN {
52 require Exporter;
53 @ISA = qw(Exporter);
54 @EXPORT = qw(
55 &GetBasket &NewBasket &CloseBasket &ReopenBasket &DelBasket &ModBasket
56 &GetBasketAsCSV &GetBasketGroupAsCSV
57 &GetBasketsByBookseller &GetBasketsByBasketgroup
58 &GetBasketsInfosByBookseller
60 &GetBasketUsers &ModBasketUsers
61 &CanUserManageBasket
63 &ModBasketHeader
65 &ModBasketgroup &NewBasketgroup &DelBasketgroup &GetBasketgroup &CloseBasketgroup
66 &GetBasketgroups &ReOpenBasketgroup
68 &DelOrder &ModOrder &GetOrder &GetOrders &GetOrdersByBiblionumber
69 &GetLateOrders &GetOrderFromItemnumber
70 &SearchOrders &GetHistory &GetRecentAcqui
71 &ModReceiveOrder &CancelReceipt
72 &TransferOrder
73 &GetLastOrderNotReceivedFromSubscriptionid &GetLastOrderReceivedFromSubscriptionid
74 &ModItemOrder
76 &GetParcels
78 &GetInvoices
79 &GetInvoice
80 &GetInvoiceDetails
81 &AddInvoice
82 &ModInvoice
83 &CloseInvoice
84 &ReopenInvoice
85 &DelInvoice
86 &MergeInvoices
88 &AddClaim
89 &GetBiblioCountByBasketno
91 &GetOrderUsers
92 &ModOrderUsers
93 &NotifyOrderUsers
95 &FillWithDefaultValues
97 &get_rounded_price
98 &get_rounding_sql
106 sub GetOrderFromItemnumber {
107 my ($itemnumber) = @_;
108 my $dbh = C4::Context->dbh;
109 my $query = qq|
111 SELECT * from aqorders LEFT JOIN aqorders_items
112 ON ( aqorders.ordernumber = aqorders_items.ordernumber )
113 WHERE itemnumber = ? |;
115 my $sth = $dbh->prepare($query);
117 # $sth->trace(3);
119 $sth->execute($itemnumber);
121 my $order = $sth->fetchrow_hashref;
122 return ( $order );
126 =head1 NAME
128 C4::Acquisition - Koha functions for dealing with orders and acquisitions
130 =head1 SYNOPSIS
132 use C4::Acquisition;
134 =head1 DESCRIPTION
136 The functions in this module deal with acquisitions, managing book
137 orders, basket and parcels.
139 =head1 FUNCTIONS
141 =head2 FUNCTIONS ABOUT BASKETS
143 =head3 GetBasket
145 $aqbasket = &GetBasket($basketnumber);
147 get all basket informations in aqbasket for a given basket
149 B<returns:> informations for a given basket returned as a hashref.
151 =cut
153 sub GetBasket {
154 my ($basketno) = @_;
155 my $dbh = C4::Context->dbh;
156 my $query = "
157 SELECT aqbasket.*,
158 concat( b.firstname,' ',b.surname) AS authorisedbyname
159 FROM aqbasket
160 LEFT JOIN borrowers b ON aqbasket.authorisedby=b.borrowernumber
161 WHERE basketno=?
163 my $sth=$dbh->prepare($query);
164 $sth->execute($basketno);
165 my $basket = $sth->fetchrow_hashref;
166 return ( $basket );
169 #------------------------------------------------------------#
171 =head3 NewBasket
173 $basket = &NewBasket( $booksellerid, $authorizedby, $basketname,
174 $basketnote, $basketbooksellernote, $basketcontractnumber, $deliveryplace, $billingplace, $is_standing, $create_items );
176 Create a new basket in aqbasket table
178 =over
180 =item C<$booksellerid> is a foreign key in the aqbasket table
182 =item C<$authorizedby> is the username of who created the basket
184 =back
186 The other parameters are optional, see ModBasketHeader for more info on them.
188 =cut
190 sub NewBasket {
191 my ( $booksellerid, $authorisedby, $basketname, $basketnote,
192 $basketbooksellernote, $basketcontractnumber, $deliveryplace,
193 $billingplace, $is_standing, $create_items ) = @_;
194 my $dbh = C4::Context->dbh;
195 my $query =
196 'INSERT INTO aqbasket (creationdate,booksellerid,authorisedby) '
197 . 'VALUES (now(),?,?)';
198 $dbh->do( $query, {}, $booksellerid, $authorisedby );
200 my $basket = $dbh->{mysql_insertid};
201 $basketname ||= q{}; # default to empty strings
202 $basketnote ||= q{};
203 $basketbooksellernote ||= q{};
204 ModBasketHeader( $basket, $basketname, $basketnote, $basketbooksellernote,
205 $basketcontractnumber, $booksellerid, $deliveryplace, $billingplace, $is_standing, $create_items );
206 return $basket;
209 #------------------------------------------------------------#
211 =head3 CloseBasket
213 &CloseBasket($basketno);
215 close a basket (becomes unmodifiable, except for receives)
217 =cut
219 sub CloseBasket {
220 my ($basketno) = @_;
221 my $dbh = C4::Context->dbh;
222 $dbh->do('UPDATE aqbasket SET closedate=now() WHERE basketno=?', {}, $basketno );
224 $dbh->do(
225 q{UPDATE aqorders SET orderstatus = 'ordered' WHERE basketno = ? AND orderstatus NOT IN ( 'complete', 'cancelled')},
226 {}, $basketno
228 return;
231 =head3 ReopenBasket
233 &ReopenBasket($basketno);
235 reopen a basket
237 =cut
239 sub ReopenBasket {
240 my ($basketno) = @_;
241 my $dbh = C4::Context->dbh;
242 $dbh->do( q{UPDATE aqbasket SET closedate=NULL WHERE basketno=?}, {}, $basketno );
244 $dbh->do( q{
245 UPDATE aqorders
246 SET orderstatus = 'new'
247 WHERE basketno = ?
248 AND orderstatus NOT IN ( 'complete', 'cancelled' )
249 }, {}, $basketno);
250 return;
253 #------------------------------------------------------------#
255 =head3 GetBasketAsCSV
257 &GetBasketAsCSV($basketno);
259 Export a basket as CSV
261 $cgi parameter is needed for column name translation
263 =cut
265 sub GetBasketAsCSV {
266 my ($basketno, $cgi, $csv_profile_id) = @_;
267 my $basket = GetBasket($basketno);
268 my @orders = GetOrders($basketno);
269 my $contract = GetContract({
270 contractnumber => $basket->{'contractnumber'}
273 my $template = C4::Templates::gettemplate("acqui/csv/basket.tt", "intranet", $cgi);
274 my @rows;
275 if ($csv_profile_id) {
276 my $csv_profile = Koha::CsvProfiles->find( $csv_profile_id );
277 Koha::Exceptions::ObjectNotFound->throw( 'There is no valid csv profile given') unless $csv_profile;
279 my $csv = Text::CSV_XS->new({'quote_char'=>'"','escape_char'=>'"','sep_char'=>$csv_profile->csv_separator,'binary'=>1});
280 my $csv_profile_content = $csv_profile->content;
281 my ( @headers, @fields );
282 while ( $csv_profile_content =~ /
283 ([^=\|]+) # header
285 ([^\|]*) # fieldname (table.row or row)
286 \|? /gxms
288 my $header = $1;
289 my $field = ($2 eq '') ? $1 : $2;
291 $header =~ s/^\s+|\s+$//g; # Trim whitespaces
292 push @headers, $header;
294 $field =~ s/[^\.]*\.{1}//; # Remove the table name if exists.
295 $field =~ s/^\s+|\s+$//g; # Trim whitespaces
296 push @fields, $field;
298 for my $order (@orders) {
299 my @row;
300 my $biblio = Koha::Biblios->find( $order->{biblionumber} );
301 my $biblioitem = $biblio->biblioitem;
302 $order = { %$order, %{ $biblioitem->unblessed } };
303 if ($contract) {
304 $order = {%$order, %$contract};
306 $order = {%$order, %$basket, %{ $biblio->unblessed }};
307 for my $field (@fields) {
308 push @row, $order->{$field};
310 push @rows, \@row;
312 my $content = join( $csv_profile->csv_separator, @headers ) . "\n";
313 for my $row ( @rows ) {
314 $csv->combine(@$row);
315 my $string = $csv->string;
316 $content .= $string . "\n";
318 return $content;
320 else {
321 foreach my $order (@orders) {
322 my $biblio = Koha::Biblios->find( $order->{biblionumber} );
323 my $biblioitem = $biblio->biblioitem;
324 my $row = {
325 contractname => $contract->{'contractname'},
326 ordernumber => $order->{'ordernumber'},
327 entrydate => $order->{'entrydate'},
328 isbn => $order->{'isbn'},
329 author => $biblio->author,
330 title => $biblio->title,
331 publicationyear => $biblioitem->publicationyear,
332 publishercode => $biblioitem->publishercode,
333 collectiontitle => $biblioitem->collectiontitle,
334 notes => $order->{'order_vendornote'},
335 quantity => $order->{'quantity'},
336 rrp => $order->{'rrp'},
338 for my $place ( qw( deliveryplace billingplace ) ) {
339 if ( my $library = Koha::Libraries->find( $row->{deliveryplace} ) ) {
340 $row->{$place} = $library->branchname
343 foreach(qw(
344 contractname author title publishercode collectiontitle notes
345 deliveryplace billingplace
346 ) ) {
347 # Double the quotes to not be interpreted as a field end
348 $row->{$_} =~ s/"/""/g if $row->{$_};
350 push @rows, $row;
353 @rows = sort {
354 if(defined $a->{publishercode} and defined $b->{publishercode}) {
355 $a->{publishercode} cmp $b->{publishercode};
357 } @rows;
359 $template->param(rows => \@rows);
361 return $template->output;
366 =head3 GetBasketGroupAsCSV
368 &GetBasketGroupAsCSV($basketgroupid);
370 Export a basket group as CSV
372 $cgi parameter is needed for column name translation
374 =cut
376 sub GetBasketGroupAsCSV {
377 my ($basketgroupid, $cgi) = @_;
378 my $baskets = GetBasketsByBasketgroup($basketgroupid);
380 my $template = C4::Templates::gettemplate('acqui/csv/basketgroup.tt', 'intranet', $cgi);
382 my @rows;
383 for my $basket (@$baskets) {
384 my @orders = GetOrders( $basket->{basketno} );
385 my $contract = GetContract({
386 contractnumber => $basket->{contractnumber}
388 my $bookseller = Koha::Acquisition::Booksellers->find( $basket->{booksellerid} );
389 my $basketgroup = GetBasketgroup( $$basket{basketgroupid} );
391 foreach my $order (@orders) {
392 my $biblio = Koha::Biblios->find( $order->{biblionumber} );
393 my $biblioitem = $biblio->biblioitem;
394 my $row = {
395 clientnumber => $bookseller->accountnumber,
396 basketname => $basket->{basketname},
397 ordernumber => $order->{ordernumber},
398 author => $biblio->author,
399 title => $biblio->title,
400 publishercode => $biblioitem->publishercode,
401 publicationyear => $biblioitem->publicationyear,
402 collectiontitle => $biblioitem->collectiontitle,
403 isbn => $order->{isbn},
404 quantity => $order->{quantity},
405 rrp_tax_included => $order->{rrp_tax_included},
406 rrp_tax_excluded => $order->{rrp_tax_excluded},
407 discount => $bookseller->discount,
408 ecost_tax_included => $order->{ecost_tax_included},
409 ecost_tax_excluded => $order->{ecost_tax_excluded},
410 notes => $order->{order_vendornote},
411 entrydate => $order->{entrydate},
412 booksellername => $bookseller->name,
413 bookselleraddress => $bookseller->address1,
414 booksellerpostal => $bookseller->postal,
415 contractnumber => $contract->{contractnumber},
416 contractname => $contract->{contractname},
418 my $temp = {
419 basketgroupdeliveryplace => $basketgroup->{deliveryplace},
420 basketgroupbillingplace => $basketgroup->{billingplace},
421 basketdeliveryplace => $basket->{deliveryplace},
422 basketbillingplace => $basket->{billingplace},
424 for my $place (qw( basketgroupdeliveryplace basketgroupbillingplace basketdeliveryplace basketbillingplace )) {
425 if ( my $library = Koha::Libraries->find( $temp->{$place} ) ) {
426 $row->{$place} = $library->branchname;
429 foreach(qw(
430 basketname author title publishercode collectiontitle notes
431 booksellername bookselleraddress booksellerpostal contractname
432 basketgroupdeliveryplace basketgroupbillingplace
433 basketdeliveryplace basketbillingplace
434 ) ) {
435 # Double the quotes to not be interpreted as a field end
436 $row->{$_} =~ s/"/""/g if $row->{$_};
438 push @rows, $row;
441 $template->param(rows => \@rows);
443 return $template->output;
447 =head3 CloseBasketgroup
449 &CloseBasketgroup($basketgroupno);
451 close a basketgroup
453 =cut
455 sub CloseBasketgroup {
456 my ($basketgroupno) = @_;
457 my $dbh = C4::Context->dbh;
458 my $sth = $dbh->prepare("
459 UPDATE aqbasketgroups
460 SET closed=1
461 WHERE id=?
463 $sth->execute($basketgroupno);
466 #------------------------------------------------------------#
468 =head3 ReOpenBaskergroup($basketgroupno)
470 &ReOpenBaskergroup($basketgroupno);
472 reopen a basketgroup
474 =cut
476 sub ReOpenBasketgroup {
477 my ($basketgroupno) = @_;
478 my $dbh = C4::Context->dbh;
479 my $sth = $dbh->prepare("
480 UPDATE aqbasketgroups
481 SET closed=0
482 WHERE id=?
484 $sth->execute($basketgroupno);
487 #------------------------------------------------------------#
490 =head3 DelBasket
492 &DelBasket($basketno);
494 Deletes the basket that has basketno field $basketno in the aqbasket table.
496 =over
498 =item C<$basketno> is the primary key of the basket in the aqbasket table.
500 =back
502 =cut
504 sub DelBasket {
505 my ( $basketno ) = @_;
506 my $query = "DELETE FROM aqbasket WHERE basketno=?";
507 my $dbh = C4::Context->dbh;
508 my $sth = $dbh->prepare($query);
509 $sth->execute($basketno);
510 return;
513 #------------------------------------------------------------#
515 =head3 ModBasket
517 &ModBasket($basketinfo);
519 Modifies a basket, using a hashref $basketinfo for the relevant information, only $basketinfo->{'basketno'} is required.
521 =over
523 =item C<$basketno> is the primary key of the basket in the aqbasket table.
525 =back
527 =cut
529 sub ModBasket {
530 my $basketinfo = shift;
531 my $query = "UPDATE aqbasket SET ";
532 my @params;
533 foreach my $key (keys %$basketinfo){
534 if ($key ne 'basketno'){
535 $query .= "$key=?, ";
536 push(@params, $basketinfo->{$key} || undef );
539 # get rid of the "," at the end of $query
540 if (substr($query, length($query)-2) eq ', '){
541 chop($query);
542 chop($query);
543 $query .= ' ';
545 $query .= "WHERE basketno=?";
546 push(@params, $basketinfo->{'basketno'});
547 my $dbh = C4::Context->dbh;
548 my $sth = $dbh->prepare($query);
549 $sth->execute(@params);
551 return;
554 #------------------------------------------------------------#
556 =head3 ModBasketHeader
558 &ModBasketHeader($basketno, $basketname, $note, $booksellernote, $contractnumber, $booksellerid);
560 Modifies a basket's header.
562 =over
564 =item C<$basketno> is the "basketno" field in the "aqbasket" table;
566 =item C<$basketname> is the "basketname" field in the "aqbasket" table;
568 =item C<$note> is the "note" field in the "aqbasket" table;
570 =item C<$booksellernote> is the "booksellernote" field in the "aqbasket" table;
572 =item C<$contractnumber> is the "contractnumber" (foreign) key in the "aqbasket" table.
574 =item C<$booksellerid> is the id (foreign) key in the "aqbooksellers" table for the vendor.
576 =item C<$deliveryplace> is the "deliveryplace" field in the aqbasket table.
578 =item C<$billingplace> is the "billingplace" field in the aqbasket table.
580 =item C<$is_standing> is the "is_standing" field in the aqbasket table.
582 =item C<$create_items> should be set to 'ordering', 'receiving' or 'cataloguing' (or undef, in which
583 case the AcqCreateItem syspref takes precedence).
585 =back
587 =cut
589 sub ModBasketHeader {
590 my ($basketno, $basketname, $note, $booksellernote, $contractnumber, $booksellerid, $deliveryplace, $billingplace, $is_standing, $create_items) = @_;
592 $is_standing ||= 0;
593 my $query = qq{
594 UPDATE aqbasket
595 SET basketname=?, note=?, booksellernote=?, booksellerid=?, deliveryplace=?, billingplace=?, is_standing=?, create_items=?
596 WHERE basketno=?
599 my $dbh = C4::Context->dbh;
600 my $sth = $dbh->prepare($query);
601 $sth->execute($basketname, $note, $booksellernote, $booksellerid, $deliveryplace, $billingplace, $is_standing, $create_items || undef, $basketno);
603 if ( $contractnumber ) {
604 my $query2 ="UPDATE aqbasket SET contractnumber=? WHERE basketno=?";
605 my $sth2 = $dbh->prepare($query2);
606 $sth2->execute($contractnumber,$basketno);
608 return;
611 #------------------------------------------------------------#
613 =head3 GetBasketsByBookseller
615 @results = &GetBasketsByBookseller($booksellerid, $extra);
617 Returns a list of hashes of all the baskets that belong to bookseller 'booksellerid'.
619 =over
621 =item C<$booksellerid> is the 'id' field of the bookseller in the aqbooksellers table
623 =item C<$extra> is the extra sql parameters, can be
625 $extra->{groupby}: group baskets by column
626 ex. $extra->{groupby} = aqbasket.basketgroupid
627 $extra->{orderby}: order baskets by column
628 $extra->{limit}: limit number of results (can be helpful for pagination)
630 =back
632 =cut
634 sub GetBasketsByBookseller {
635 my ($booksellerid, $extra) = @_;
636 my $query = "SELECT * FROM aqbasket WHERE booksellerid=?";
637 if ($extra){
638 if ($extra->{groupby}) {
639 $query .= " GROUP by $extra->{groupby}";
641 if ($extra->{orderby}){
642 $query .= " ORDER by $extra->{orderby}";
644 if ($extra->{limit}){
645 $query .= " LIMIT $extra->{limit}";
648 my $dbh = C4::Context->dbh;
649 my $sth = $dbh->prepare($query);
650 $sth->execute($booksellerid);
651 return $sth->fetchall_arrayref({});
654 =head3 GetBasketsInfosByBookseller
656 my $baskets = GetBasketsInfosByBookseller($supplierid, $allbaskets);
658 The optional second parameter allbaskets is a boolean allowing you to
659 select all baskets from the supplier; by default only active baskets (open or
660 closed but still something to receive) are returned.
662 Returns in a arrayref of hashref all about booksellers baskets, plus:
663 total_biblios: Number of distinct biblios in basket
664 total_items: Number of items in basket
665 expected_items: Number of non-received items in basket
667 =cut
669 sub GetBasketsInfosByBookseller {
670 my ($supplierid, $allbaskets) = @_;
672 return unless $supplierid;
674 my $dbh = C4::Context->dbh;
675 my $query = q{
676 SELECT aqbasket.basketno, aqbasket.basketname, aqbasket.note, aqbasket.booksellernote, aqbasket.contractnumber, aqbasket.creationdate, aqbasket.closedate, aqbasket.booksellerid, aqbasket.authorisedby, aqbasket.booksellerinvoicenumber, aqbasket.basketgroupid, aqbasket.deliveryplace, aqbasket.billingplace, aqbasket.branch, aqbasket.is_standing, aqbasket.create_items,
677 SUM(aqorders.quantity) AS total_items,
678 SUM(
679 IF ( aqorders.orderstatus = 'cancelled', aqorders.quantity, 0 )
680 ) AS total_items_cancelled,
681 COUNT(DISTINCT aqorders.biblionumber) AS total_biblios,
682 SUM(
683 IF(aqorders.datereceived IS NULL
684 AND (aqorders.datecancellationprinted IS NULL OR aqorders.datecancellationprinted='0000-00-00')
685 , aqorders.quantity
686 , 0)
687 ) AS expected_items,
688 SUM( aqorders.uncertainprice ) AS uncertainprices
689 FROM aqbasket
690 LEFT JOIN aqorders ON aqorders.basketno = aqbasket.basketno
691 WHERE booksellerid = ?};
693 $query.=" GROUP BY aqbasket.basketno, aqbasket.basketname, aqbasket.note, aqbasket.booksellernote, aqbasket.contractnumber, aqbasket.creationdate, aqbasket.closedate, aqbasket.booksellerid, aqbasket.authorisedby, aqbasket.booksellerinvoicenumber, aqbasket.basketgroupid, aqbasket.deliveryplace, aqbasket.billingplace, aqbasket.branch, aqbasket.is_standing, aqbasket.create_items";
695 unless ( $allbaskets ) {
696 # Don't show the basket if it's NOT CLOSED or is FULLY RECEIVED
697 $query.=" HAVING (closedate IS NULL OR (
698 SUM(
699 IF(aqorders.datereceived IS NULL
700 AND (aqorders.datecancellationprinted IS NULL OR aqorders.datecancellationprinted='0000-00-00')
701 , aqorders.quantity
702 , 0)
703 ) > 0))"
706 my $sth = $dbh->prepare($query);
707 $sth->execute($supplierid);
708 my $baskets = $sth->fetchall_arrayref({});
710 # Retrieve the number of biblios cancelled
711 my $cancelled_biblios = $dbh->selectall_hashref( q|
712 SELECT COUNT(DISTINCT(biblionumber)) AS total_biblios_cancelled, aqbasket.basketno
713 FROM aqbasket
714 LEFT JOIN aqorders ON aqorders.basketno = aqbasket.basketno
715 WHERE booksellerid = ?
716 AND aqorders.orderstatus = 'cancelled'
717 GROUP BY aqbasket.basketno
718 |, 'basketno', {}, $supplierid );
719 map {
720 $_->{total_biblios_cancelled} = $cancelled_biblios->{$_->{basketno}}{total_biblios_cancelled} || 0
721 } @$baskets;
723 return $baskets;
726 =head3 GetBasketUsers
728 $basketusers_ids = &GetBasketUsers($basketno);
730 Returns a list of all borrowernumbers that are in basket users list
732 =cut
734 sub GetBasketUsers {
735 my $basketno = shift;
737 return unless $basketno;
739 my $query = qq{
740 SELECT borrowernumber
741 FROM aqbasketusers
742 WHERE basketno = ?
744 my $dbh = C4::Context->dbh;
745 my $sth = $dbh->prepare($query);
746 $sth->execute($basketno);
747 my $results = $sth->fetchall_arrayref( {} );
749 my @borrowernumbers;
750 foreach (@$results) {
751 push @borrowernumbers, $_->{'borrowernumber'};
754 return @borrowernumbers;
757 =head3 ModBasketUsers
759 my @basketusers_ids = (1, 2, 3);
760 &ModBasketUsers($basketno, @basketusers_ids);
762 Delete all users from basket users list, and add users in C<@basketusers_ids>
763 to this users list.
765 =cut
767 sub ModBasketUsers {
768 my ($basketno, @basketusers_ids) = @_;
770 return unless $basketno;
772 my $dbh = C4::Context->dbh;
773 my $query = qq{
774 DELETE FROM aqbasketusers
775 WHERE basketno = ?
777 my $sth = $dbh->prepare($query);
778 $sth->execute($basketno);
780 $query = qq{
781 INSERT INTO aqbasketusers (basketno, borrowernumber)
782 VALUES (?, ?)
784 $sth = $dbh->prepare($query);
785 foreach my $basketuser_id (@basketusers_ids) {
786 $sth->execute($basketno, $basketuser_id);
788 return;
791 =head3 CanUserManageBasket
793 my $bool = CanUserManageBasket($borrower, $basket[, $userflags]);
794 my $bool = CanUserManageBasket($borrowernumber, $basketno[, $userflags]);
796 Check if a borrower can manage a basket, according to system preference
797 AcqViewBaskets, user permissions and basket properties (creator, users list,
798 branch).
800 First parameter can be either a borrowernumber or a hashref as returned by
801 Koha::Patron->unblessed
803 Second parameter can be either a basketno or a hashref as returned by
804 C4::Acquisition::GetBasket.
806 The third parameter is optional. If given, it should be a hashref as returned
807 by C4::Auth::getuserflags. If not, getuserflags is called.
809 If user is authorised to manage basket, returns 1.
810 Otherwise returns 0.
812 =cut
814 sub CanUserManageBasket {
815 my ($borrower, $basket, $userflags) = @_;
817 if (!ref $borrower) {
818 # FIXME This needs to be replaced
819 # We should not accept both scalar and array
820 # Tests need to be updated
821 $borrower = Koha::Patrons->find( $borrower )->unblessed;
823 if (!ref $basket) {
824 $basket = GetBasket($basket);
827 return 0 unless ($basket and $borrower);
829 my $borrowernumber = $borrower->{borrowernumber};
830 my $basketno = $basket->{basketno};
832 my $AcqViewBaskets = C4::Context->preference('AcqViewBaskets');
834 if (!defined $userflags) {
835 my $dbh = C4::Context->dbh;
836 my $sth = $dbh->prepare("SELECT flags FROM borrowers WHERE borrowernumber = ?");
837 $sth->execute($borrowernumber);
838 my ($flags) = $sth->fetchrow_array;
839 $sth->finish;
841 $userflags = C4::Auth::getuserflags($flags, $borrower->{userid}, $dbh);
844 unless ($userflags->{superlibrarian}
845 || (ref $userflags->{acquisition} && $userflags->{acquisition}->{order_manage_all})
846 || (!ref $userflags->{acquisition} && $userflags->{acquisition}))
848 if (not exists $userflags->{acquisition}) {
849 return 0;
852 if ( (ref $userflags->{acquisition} && !$userflags->{acquisition}->{order_manage})
853 || (!ref $userflags->{acquisition} && !$userflags->{acquisition}) ) {
854 return 0;
857 if ($AcqViewBaskets eq 'user'
858 && $basket->{authorisedby} != $borrowernumber
859 && ! grep { $borrowernumber eq $_ } GetBasketUsers($basketno)) {
860 return 0;
863 if ($AcqViewBaskets eq 'branch' && defined $basket->{branch}
864 && $basket->{branch} ne $borrower->{branchcode}) {
865 return 0;
869 return 1;
872 #------------------------------------------------------------#
874 =head3 GetBasketsByBasketgroup
876 $baskets = &GetBasketsByBasketgroup($basketgroupid);
878 Returns a reference to all baskets that belong to basketgroup $basketgroupid.
880 =cut
882 sub GetBasketsByBasketgroup {
883 my $basketgroupid = shift;
884 my $query = qq{
885 SELECT *, aqbasket.booksellerid as booksellerid
886 FROM aqbasket
887 LEFT JOIN aqcontract USING(contractnumber) WHERE basketgroupid=?
889 my $dbh = C4::Context->dbh;
890 my $sth = $dbh->prepare($query);
891 $sth->execute($basketgroupid);
892 return $sth->fetchall_arrayref({});
895 #------------------------------------------------------------#
897 =head3 NewBasketgroup
899 $basketgroupid = NewBasketgroup(\%hashref);
901 Adds a basketgroup to the aqbasketgroups table, and add the initial baskets to it.
903 $hashref->{'booksellerid'} is the 'id' field of the bookseller in the aqbooksellers table,
905 $hashref->{'name'} is the 'name' field of the basketgroup in the aqbasketgroups table,
907 $hashref->{'basketlist'} is a list reference of the 'id's of the baskets that belong to this group,
909 $hashref->{'billingplace'} is the 'billingplace' field of the basketgroup in the aqbasketgroups table,
911 $hashref->{'deliveryplace'} is the 'deliveryplace' field of the basketgroup in the aqbasketgroups table,
913 $hashref->{'freedeliveryplace'} is the 'freedeliveryplace' field of the basketgroup in the aqbasketgroups table,
915 $hashref->{'deliverycomment'} is the 'deliverycomment' field of the basketgroup in the aqbasketgroups table,
917 $hashref->{'closed'} is the 'closed' field of the aqbasketgroups table, it is false if 0, true otherwise.
919 =cut
921 sub NewBasketgroup {
922 my $basketgroupinfo = shift;
923 die "booksellerid is required to create a basketgroup" unless $basketgroupinfo->{'booksellerid'};
924 my $query = "INSERT INTO aqbasketgroups (";
925 my @params;
926 foreach my $field (qw(name billingplace deliveryplace freedeliveryplace deliverycomment closed)) {
927 if ( defined $basketgroupinfo->{$field} ) {
928 $query .= "$field, ";
929 push(@params, $basketgroupinfo->{$field});
932 $query .= "booksellerid) VALUES (";
933 foreach (@params) {
934 $query .= "?, ";
936 $query .= "?)";
937 push(@params, $basketgroupinfo->{'booksellerid'});
938 my $dbh = C4::Context->dbh;
939 my $sth = $dbh->prepare($query);
940 $sth->execute(@params);
941 my $basketgroupid = $dbh->{'mysql_insertid'};
942 if( $basketgroupinfo->{'basketlist'} ) {
943 foreach my $basketno (@{$basketgroupinfo->{'basketlist'}}) {
944 my $query2 = "UPDATE aqbasket SET basketgroupid=? WHERE basketno=?";
945 my $sth2 = $dbh->prepare($query2);
946 $sth2->execute($basketgroupid, $basketno);
949 return $basketgroupid;
952 #------------------------------------------------------------#
954 =head3 ModBasketgroup
956 ModBasketgroup(\%hashref);
958 Modifies a basketgroup in the aqbasketgroups table, and add the baskets to it.
960 $hashref->{'id'} is the 'id' field of the basketgroup in the aqbasketgroup table, this parameter is mandatory,
962 $hashref->{'name'} is the 'name' field of the basketgroup in the aqbasketgroups table,
964 $hashref->{'basketlist'} is a list reference of the 'id's of the baskets that belong to this group,
966 $hashref->{'billingplace'} is the 'billingplace' field of the basketgroup in the aqbasketgroups table,
968 $hashref->{'deliveryplace'} is the 'deliveryplace' field of the basketgroup in the aqbasketgroups table,
970 $hashref->{'freedeliveryplace'} is the 'freedeliveryplace' field of the basketgroup in the aqbasketgroups table,
972 $hashref->{'deliverycomment'} is the 'deliverycomment' field of the basketgroup in the aqbasketgroups table,
974 $hashref->{'closed'} is the 'closed' field of the aqbasketgroups table, it is false if 0, true otherwise.
976 =cut
978 sub ModBasketgroup {
979 my $basketgroupinfo = shift;
980 die "basketgroup id is required to edit a basketgroup" unless $basketgroupinfo->{'id'};
981 my $dbh = C4::Context->dbh;
982 my $query = "UPDATE aqbasketgroups SET ";
983 my @params;
984 foreach my $field (qw(name billingplace deliveryplace freedeliveryplace deliverycomment closed)) {
985 if ( defined $basketgroupinfo->{$field} ) {
986 $query .= "$field=?, ";
987 push(@params, $basketgroupinfo->{$field});
990 chop($query);
991 chop($query);
992 $query .= " WHERE id=?";
993 push(@params, $basketgroupinfo->{'id'});
994 my $sth = $dbh->prepare($query);
995 $sth->execute(@params);
997 $sth = $dbh->prepare('UPDATE aqbasket SET basketgroupid = NULL WHERE basketgroupid = ?');
998 $sth->execute($basketgroupinfo->{'id'});
1000 if($basketgroupinfo->{'basketlist'} && @{$basketgroupinfo->{'basketlist'}}){
1001 $sth = $dbh->prepare("UPDATE aqbasket SET basketgroupid=? WHERE basketno=?");
1002 foreach my $basketno (@{$basketgroupinfo->{'basketlist'}}) {
1003 $sth->execute($basketgroupinfo->{'id'}, $basketno);
1006 return;
1009 #------------------------------------------------------------#
1011 =head3 DelBasketgroup
1013 DelBasketgroup($basketgroupid);
1015 Deletes a basketgroup in the aqbasketgroups table, and removes the reference to it from the baskets,
1017 =over
1019 =item C<$basketgroupid> is the 'id' field of the basket in the aqbasketgroup table
1021 =back
1023 =cut
1025 sub DelBasketgroup {
1026 my $basketgroupid = shift;
1027 die "basketgroup id is required to edit a basketgroup" unless $basketgroupid;
1028 my $query = "DELETE FROM aqbasketgroups WHERE id=?";
1029 my $dbh = C4::Context->dbh;
1030 my $sth = $dbh->prepare($query);
1031 $sth->execute($basketgroupid);
1032 return;
1035 #------------------------------------------------------------#
1038 =head2 FUNCTIONS ABOUT ORDERS
1040 =head3 GetBasketgroup
1042 $basketgroup = &GetBasketgroup($basketgroupid);
1044 Returns a reference to the hash containing all information about the basketgroup.
1046 =cut
1048 sub GetBasketgroup {
1049 my $basketgroupid = shift;
1050 die "basketgroup id is required to edit a basketgroup" unless $basketgroupid;
1051 my $dbh = C4::Context->dbh;
1052 my $result_set = $dbh->selectall_arrayref(
1053 'SELECT * FROM aqbasketgroups WHERE id=?',
1054 { Slice => {} },
1055 $basketgroupid
1057 return $result_set->[0]; # id is unique
1060 #------------------------------------------------------------#
1062 =head3 GetBasketgroups
1064 $basketgroups = &GetBasketgroups($booksellerid);
1066 Returns a reference to the array of all the basketgroups of bookseller $booksellerid.
1068 =cut
1070 sub GetBasketgroups {
1071 my $booksellerid = shift;
1072 die 'bookseller id is required to edit a basketgroup' unless $booksellerid;
1073 my $query = 'SELECT * FROM aqbasketgroups WHERE booksellerid=? ORDER BY id DESC';
1074 my $dbh = C4::Context->dbh;
1075 my $sth = $dbh->prepare($query);
1076 $sth->execute($booksellerid);
1077 return $sth->fetchall_arrayref({});
1080 #------------------------------------------------------------#
1082 =head2 FUNCTIONS ABOUT ORDERS
1084 =head3 GetOrders
1086 @orders = &GetOrders( $basketno, { orderby => 'biblio.title', cancelled => 0|1 } );
1088 Looks up the pending (non-cancelled) orders with the given basket
1089 number.
1091 If cancelled is set, only cancelled orders will be returned.
1093 =cut
1095 sub GetOrders {
1096 my ( $basketno, $params ) = @_;
1098 return () unless $basketno;
1100 my $orderby = $params->{orderby};
1101 my $cancelled = $params->{cancelled} || 0;
1103 my $dbh = C4::Context->dbh;
1104 my $query = q|
1105 SELECT biblio.*,biblioitems.*,
1106 aqorders.*,
1107 aqbudgets.*,
1109 $query .= $cancelled
1110 ? q|
1111 aqorders_transfers.ordernumber_to AS transferred_to,
1112 aqorders_transfers.timestamp AS transferred_to_timestamp
1114 : q|
1115 aqorders_transfers.ordernumber_from AS transferred_from,
1116 aqorders_transfers.timestamp AS transferred_from_timestamp
1118 $query .= q|
1119 FROM aqorders
1120 LEFT JOIN aqbudgets ON aqbudgets.budget_id = aqorders.budget_id
1121 LEFT JOIN biblio ON biblio.biblionumber = aqorders.biblionumber
1122 LEFT JOIN biblioitems ON biblioitems.biblionumber =biblio.biblionumber
1124 $query .= $cancelled
1125 ? q|
1126 LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_from = aqorders.ordernumber
1128 : q|
1129 LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_to = aqorders.ordernumber
1132 $query .= q|
1133 WHERE basketno=?
1136 if ($cancelled) {
1137 $orderby ||= q|biblioitems.publishercode, biblio.title|;
1138 $query .= q|
1139 AND (datecancellationprinted IS NOT NULL
1140 AND datecancellationprinted <> '0000-00-00')
1143 else {
1144 $orderby ||=
1145 q|aqorders.datecancellationprinted desc, aqorders.timestamp desc|;
1146 $query .= q|
1147 AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')
1151 $query .= " ORDER BY $orderby";
1152 my $orders =
1153 $dbh->selectall_arrayref( $query, { Slice => {} }, $basketno );
1154 return @{$orders};
1158 #------------------------------------------------------------#
1160 =head3 GetOrdersByBiblionumber
1162 @orders = &GetOrdersByBiblionumber($biblionumber);
1164 Looks up the orders with linked to a specific $biblionumber, including
1165 cancelled orders and received orders.
1167 return :
1168 C<@orders> is an array of references-to-hash, whose keys are the
1169 fields from the aqorders, biblio, and biblioitems tables in the Koha database.
1171 =cut
1173 sub GetOrdersByBiblionumber {
1174 my $biblionumber = shift;
1175 return unless $biblionumber;
1176 my $dbh = C4::Context->dbh;
1177 my $query ="
1178 SELECT biblio.*,biblioitems.*,
1179 aqorders.*,
1180 aqbudgets.*
1181 FROM aqorders
1182 LEFT JOIN aqbudgets ON aqbudgets.budget_id = aqorders.budget_id
1183 LEFT JOIN biblio ON biblio.biblionumber = aqorders.biblionumber
1184 LEFT JOIN biblioitems ON biblioitems.biblionumber =biblio.biblionumber
1185 WHERE aqorders.biblionumber=?
1187 my $result_set =
1188 $dbh->selectall_arrayref( $query, { Slice => {} }, $biblionumber );
1189 return @{$result_set};
1193 #------------------------------------------------------------#
1195 =head3 GetOrder
1197 $order = &GetOrder($ordernumber);
1199 Looks up an order by order number.
1201 Returns a reference-to-hash describing the order. The keys of
1202 C<$order> are fields from the biblio, biblioitems, aqorders tables of the Koha database.
1204 =cut
1206 sub GetOrder {
1207 my ($ordernumber) = @_;
1208 return unless $ordernumber;
1210 my $dbh = C4::Context->dbh;
1211 my $query = qq{SELECT
1212 aqorders.*,
1213 biblio.title,
1214 biblio.author,
1215 aqbasket.basketname,
1216 borrowers.branchcode,
1217 biblioitems.publicationyear,
1218 biblio.copyrightdate,
1219 biblioitems.editionstatement,
1220 biblioitems.isbn,
1221 biblioitems.ean,
1222 biblio.seriestitle,
1223 biblioitems.publishercode,
1224 aqorders.rrp AS unitpricesupplier,
1225 aqorders.ecost AS unitpricelib,
1226 aqorders.claims_count AS claims_count,
1227 aqorders.claimed_date AS claimed_date,
1228 aqbudgets.budget_name AS budget,
1229 aqbooksellers.name AS supplier,
1230 aqbooksellers.id AS supplierid,
1231 biblioitems.publishercode AS publisher,
1232 ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) AS estimateddeliverydate,
1233 DATE(aqbasket.closedate) AS orderdate,
1234 aqorders.quantity - COALESCE(aqorders.quantityreceived,0) AS quantity_to_receive,
1235 (aqorders.quantity - COALESCE(aqorders.quantityreceived,0)) * aqorders.rrp AS subtotal,
1236 DATEDIFF(CURDATE( ),closedate) AS latesince
1237 FROM aqorders LEFT JOIN biblio ON biblio.biblionumber = aqorders.biblionumber
1238 LEFT JOIN biblioitems ON biblioitems.biblionumber = biblio.biblionumber
1239 LEFT JOIN aqbudgets ON aqorders.budget_id = aqbudgets.budget_id,
1240 aqbasket LEFT JOIN borrowers ON aqbasket.authorisedby = borrowers.borrowernumber
1241 LEFT JOIN aqbooksellers ON aqbasket.booksellerid = aqbooksellers.id
1242 WHERE aqorders.basketno = aqbasket.basketno
1243 AND ordernumber=?};
1244 my $result_set =
1245 $dbh->selectall_arrayref( $query, { Slice => {} }, $ordernumber );
1247 # result_set assumed to contain 1 match
1248 return $result_set->[0];
1251 =head3 GetLastOrderNotReceivedFromSubscriptionid
1253 $order = &GetLastOrderNotReceivedFromSubscriptionid($subscriptionid);
1255 Returns a reference-to-hash describing the last order not received for a subscription.
1257 =cut
1259 sub GetLastOrderNotReceivedFromSubscriptionid {
1260 my ( $subscriptionid ) = @_;
1261 my $dbh = C4::Context->dbh;
1262 my $query = qq|
1263 SELECT * FROM aqorders
1264 LEFT JOIN subscription
1265 ON ( aqorders.subscriptionid = subscription.subscriptionid )
1266 WHERE aqorders.subscriptionid = ?
1267 AND aqorders.datereceived IS NULL
1268 LIMIT 1
1270 my $result_set =
1271 $dbh->selectall_arrayref( $query, { Slice => {} }, $subscriptionid );
1273 # result_set assumed to contain 1 match
1274 return $result_set->[0];
1277 =head3 GetLastOrderReceivedFromSubscriptionid
1279 $order = &GetLastOrderReceivedFromSubscriptionid($subscriptionid);
1281 Returns a reference-to-hash describing the last order received for a subscription.
1283 =cut
1285 sub GetLastOrderReceivedFromSubscriptionid {
1286 my ( $subscriptionid ) = @_;
1287 my $dbh = C4::Context->dbh;
1288 my $query = qq|
1289 SELECT * FROM aqorders
1290 LEFT JOIN subscription
1291 ON ( aqorders.subscriptionid = subscription.subscriptionid )
1292 WHERE aqorders.subscriptionid = ?
1293 AND aqorders.datereceived =
1295 SELECT MAX( aqorders.datereceived )
1296 FROM aqorders
1297 LEFT JOIN subscription
1298 ON ( aqorders.subscriptionid = subscription.subscriptionid )
1299 WHERE aqorders.subscriptionid = ?
1300 AND aqorders.datereceived IS NOT NULL
1302 ORDER BY ordernumber DESC
1303 LIMIT 1
1305 my $result_set =
1306 $dbh->selectall_arrayref( $query, { Slice => {} }, $subscriptionid, $subscriptionid );
1308 # result_set assumed to contain 1 match
1309 return $result_set->[0];
1313 #------------------------------------------------------------#
1315 =head3 ModOrder
1317 &ModOrder(\%hashref);
1319 Modifies an existing order. Updates the order with order number
1320 $hashref->{'ordernumber'} and biblionumber $hashref->{'biblionumber'}. All
1321 other keys of the hash update the fields with the same name in the aqorders
1322 table of the Koha database.
1324 =cut
1326 sub ModOrder {
1327 my $orderinfo = shift;
1329 die "Ordernumber is required" if $orderinfo->{'ordernumber'} eq '';
1331 my $dbh = C4::Context->dbh;
1332 my @params;
1334 # update uncertainprice to an integer, just in case (under FF, checked boxes have the value "ON" by default)
1335 $orderinfo->{uncertainprice}=1 if $orderinfo->{uncertainprice};
1337 # delete($orderinfo->{'branchcode'});
1338 # the hash contains a lot of entries not in aqorders, so get the columns ...
1339 my $sth = $dbh->prepare("SELECT * FROM aqorders LIMIT 1;");
1340 $sth->execute;
1341 my $colnames = $sth->{NAME};
1342 #FIXME Be careful. If aqorders would have columns with diacritics,
1343 #you should need to decode what you get back from NAME.
1344 #See report 10110 and guided_reports.pl
1345 my $query = "UPDATE aqorders SET ";
1347 foreach my $orderinfokey (grep(!/ordernumber/, keys %$orderinfo)){
1348 # ... and skip hash entries that are not in the aqorders table
1349 # FIXME : probably not the best way to do it (would be better to have a correct hash)
1350 next unless grep(/^$orderinfokey$/, @$colnames);
1351 $query .= "$orderinfokey=?, ";
1352 push(@params, $orderinfo->{$orderinfokey});
1355 $query .= "timestamp=NOW() WHERE ordernumber=?";
1356 push(@params, $orderinfo->{'ordernumber'} );
1357 $sth = $dbh->prepare($query);
1358 $sth->execute(@params);
1359 return;
1362 #------------------------------------------------------------#
1364 =head3 ModItemOrder
1366 ModItemOrder($itemnumber, $ordernumber);
1368 Modifies the ordernumber of an item in aqorders_items.
1370 =cut
1372 sub ModItemOrder {
1373 my ($itemnumber, $ordernumber) = @_;
1375 return unless ($itemnumber and $ordernumber);
1377 my $dbh = C4::Context->dbh;
1378 my $query = qq{
1379 UPDATE aqorders_items
1380 SET ordernumber = ?
1381 WHERE itemnumber = ?
1383 my $sth = $dbh->prepare($query);
1384 return $sth->execute($ordernumber, $itemnumber);
1387 #------------------------------------------------------------#
1389 =head3 ModReceiveOrder
1391 my ( $date_received, $new_ordernumber ) = ModReceiveOrder(
1393 biblionumber => $biblionumber,
1394 order => $order,
1395 quantityreceived => $quantityreceived,
1396 user => $user,
1397 invoice => $invoice,
1398 budget_id => $budget_id,
1399 received_itemnumbers => \@received_itemnumbers,
1400 order_internalnote => $order_internalnote,
1404 Updates an order, to reflect the fact that it was received, at least
1405 in part.
1407 If a partial order is received, splits the order into two.
1409 Updates the order with biblionumber C<$biblionumber> and ordernumber
1410 C<$order->{ordernumber}>.
1412 =cut
1415 sub ModReceiveOrder {
1416 my ($params) = @_;
1417 my $biblionumber = $params->{biblionumber};
1418 my $order = { %{ $params->{order} } }; # Copy the order, we don't want to modify it
1419 my $invoice = $params->{invoice};
1420 my $quantrec = $params->{quantityreceived};
1421 my $user = $params->{user};
1422 my $budget_id = $params->{budget_id};
1423 my $received_items = $params->{received_items};
1425 my $dbh = C4::Context->dbh;
1426 my $datereceived = ( $invoice and $invoice->{datereceived} ) ? $invoice->{datereceived} : dt_from_string;
1427 my $suggestionid = GetSuggestionFromBiblionumber( $biblionumber );
1428 if ($suggestionid) {
1429 ModSuggestion( {suggestionid=>$suggestionid,
1430 STATUS=>'AVAILABLE',
1431 biblionumber=> $biblionumber}
1435 my $result_set = $dbh->selectrow_arrayref(
1436 q{SELECT aqbasket.is_standing
1437 FROM aqbasket
1438 WHERE basketno=?},{ Slice => {} }, $order->{basketno});
1439 my $is_standing = $result_set->[0]; # we assume we have a unique basket
1441 my $new_ordernumber = $order->{ordernumber};
1442 if ( $is_standing || $order->{quantity} > $quantrec ) {
1443 # Split order line in two parts: the first is the original order line
1444 # without received items (the quantity is decreased),
1445 # the second part is a new order line with quantity=quantityrec
1446 # (entirely received)
1447 my $query = q|
1448 UPDATE aqorders
1449 SET quantity = ?,
1450 orderstatus = 'partial'|;
1451 $query .= q| WHERE ordernumber = ?|;
1452 my $sth = $dbh->prepare($query);
1454 $sth->execute(
1455 ( $is_standing ? 1 : ($order->{quantity} - $quantrec) ),
1456 $order->{ordernumber}
1459 if ( not $order->{subscriptionid} && defined $order->{order_internalnote} ) {
1460 $dbh->do(
1461 q|UPDATE aqorders
1462 SET order_internalnote = ?
1463 WHERE ordernumber = ?|, {},
1464 $order->{order_internalnote}, $order->{ordernumber}
1468 # Recalculate tax_value
1469 $dbh->do(q|
1470 UPDATE aqorders
1472 tax_value_on_ordering = quantity * | . get_rounding_sql(q|ecost_tax_excluded|) . q| * tax_rate_on_ordering,
1473 tax_value_on_receiving = quantity * | . get_rounding_sql(q|unitprice_tax_excluded|) . q| * tax_rate_on_receiving
1474 WHERE ordernumber = ?
1475 |, undef, $order->{ordernumber});
1477 delete $order->{ordernumber};
1478 $order->{budget_id} = ( $budget_id || $order->{budget_id} );
1479 $order->{quantity} = $quantrec;
1480 $order->{quantityreceived} = $quantrec;
1481 $order->{ecost_tax_excluded} //= 0;
1482 $order->{tax_rate_on_ordering} //= 0;
1483 $order->{unitprice_tax_excluded} //= 0;
1484 $order->{tax_rate_on_receiving} //= 0;
1485 $order->{tax_value_on_ordering} = $order->{quantity} * get_rounded_price($order->{ecost_tax_excluded}) * $order->{tax_rate_on_ordering};
1486 $order->{tax_value_on_receiving} = $order->{quantity} * get_rounded_price($order->{unitprice_tax_excluded}) * $order->{tax_rate_on_receiving};
1487 $order->{datereceived} = $datereceived;
1488 $order->{invoiceid} = $invoice->{invoiceid};
1489 $order->{orderstatus} = 'complete';
1490 $new_ordernumber = Koha::Acquisition::Order->new($order)->store->ordernumber; # TODO What if the store fails?
1492 if ($received_items) {
1493 foreach my $itemnumber (@$received_items) {
1494 ModItemOrder($itemnumber, $new_ordernumber);
1497 } else {
1498 my $query = q|
1499 UPDATE aqorders
1500 SET quantityreceived = ?,
1501 datereceived = ?,
1502 invoiceid = ?,
1503 budget_id = ?,
1504 orderstatus = 'complete'
1507 $query .= q|
1508 , replacementprice = ?
1509 | if defined $order->{replacementprice};
1511 $query .= q|
1512 , unitprice = ?, unitprice_tax_included = ?, unitprice_tax_excluded = ?
1513 | if defined $order->{unitprice};
1515 $query .= q|
1516 ,tax_value_on_receiving = ?
1517 | if defined $order->{tax_value_on_receiving};
1519 $query .= q|
1520 ,tax_rate_on_receiving = ?
1521 | if defined $order->{tax_rate_on_receiving};
1523 $query .= q|
1524 , order_internalnote = ?
1525 | if defined $order->{order_internalnote};
1527 $query .= q| where biblionumber=? and ordernumber=?|;
1529 my $sth = $dbh->prepare( $query );
1530 my @params = ( $quantrec, $datereceived, $invoice->{invoiceid}, ( $budget_id ? $budget_id : $order->{budget_id} ) );
1532 if ( defined $order->{replacementprice} ) {
1533 push @params, $order->{replacementprice};
1536 if ( defined $order->{unitprice} ) {
1537 push @params, $order->{unitprice}, $order->{unitprice_tax_included}, $order->{unitprice_tax_excluded};
1540 if ( defined $order->{tax_value_on_receiving} ) {
1541 push @params, $order->{tax_value_on_receiving};
1544 if ( defined $order->{tax_rate_on_receiving} ) {
1545 push @params, $order->{tax_rate_on_receiving};
1548 if ( defined $order->{order_internalnote} ) {
1549 push @params, $order->{order_internalnote};
1552 push @params, ( $biblionumber, $order->{ordernumber} );
1554 $sth->execute( @params );
1556 # All items have been received, sent a notification to users
1557 NotifyOrderUsers( $order->{ordernumber} );
1560 return ($datereceived, $new_ordernumber);
1563 =head3 CancelReceipt
1565 my $parent_ordernumber = CancelReceipt($ordernumber);
1567 Cancel an order line receipt and update the parent order line, as if no
1568 receipt was made.
1569 If items are created at receipt (AcqCreateItem = receiving) then delete
1570 these items.
1572 =cut
1574 sub CancelReceipt {
1575 my $ordernumber = shift;
1577 return unless $ordernumber;
1579 my $dbh = C4::Context->dbh;
1580 my $query = qq{
1581 SELECT datereceived, parent_ordernumber, quantity
1582 FROM aqorders
1583 WHERE ordernumber = ?
1585 my $sth = $dbh->prepare($query);
1586 $sth->execute($ordernumber);
1587 my $order = $sth->fetchrow_hashref;
1588 unless($order) {
1589 warn "CancelReceipt: order $ordernumber does not exist";
1590 return;
1592 unless($order->{'datereceived'}) {
1593 warn "CancelReceipt: order $ordernumber is not received";
1594 return;
1597 my $parent_ordernumber = $order->{'parent_ordernumber'};
1599 my $order_obj = Koha::Acquisition::Orders->find( $ordernumber ); # FIXME rewrite all this subroutine using this object
1600 my @itemnumbers = $order_obj->items->get_column('itemnumber');
1602 if($parent_ordernumber == $ordernumber || not $parent_ordernumber) {
1603 # The order line has no parent, just mark it as not received
1604 $query = qq{
1605 UPDATE aqorders
1606 SET quantityreceived = ?,
1607 datereceived = ?,
1608 invoiceid = ?,
1609 orderstatus = 'ordered'
1610 WHERE ordernumber = ?
1612 $sth = $dbh->prepare($query);
1613 $sth->execute(0, undef, undef, $ordernumber);
1614 _cancel_items_receipt( $order_obj );
1615 } else {
1616 # The order line has a parent, increase parent quantity and delete
1617 # the order line.
1618 $query = qq{
1619 SELECT quantity, datereceived
1620 FROM aqorders
1621 WHERE ordernumber = ?
1623 $sth = $dbh->prepare($query);
1624 $sth->execute($parent_ordernumber);
1625 my $parent_order = $sth->fetchrow_hashref;
1626 unless($parent_order) {
1627 warn "Parent order $parent_ordernumber does not exist.";
1628 return;
1630 if($parent_order->{'datereceived'}) {
1631 warn "CancelReceipt: parent order is received.".
1632 " Can't cancel receipt.";
1633 return;
1635 $query = qq{
1636 UPDATE aqorders
1637 SET quantity = ?,
1638 orderstatus = 'ordered'
1639 WHERE ordernumber = ?
1641 $sth = $dbh->prepare($query);
1642 my $rv = $sth->execute(
1643 $order->{'quantity'} + $parent_order->{'quantity'},
1644 $parent_ordernumber
1646 unless($rv) {
1647 warn "Cannot update parent order line, so do not cancel".
1648 " receipt";
1649 return;
1652 # Recalculate tax_value
1653 $dbh->do(q|
1654 UPDATE aqorders
1656 tax_value_on_ordering = quantity * | . get_rounding_sql(q|ecost_tax_excluded|) . q| * tax_rate_on_ordering,
1657 tax_value_on_receiving = quantity * | . get_rounding_sql(q|unitprice_tax_excluded|) . q| * tax_rate_on_receiving
1658 WHERE ordernumber = ?
1659 |, undef, $parent_ordernumber);
1661 _cancel_items_receipt( $order_obj, $parent_ordernumber );
1662 # Delete order line
1663 $query = qq{
1664 DELETE FROM aqorders
1665 WHERE ordernumber = ?
1667 $sth = $dbh->prepare($query);
1668 $sth->execute($ordernumber);
1672 if( $order_obj->basket->effective_create_items eq 'ordering' ) {
1673 my @affects = split q{\|}, C4::Context->preference("AcqItemSetSubfieldsWhenReceiptIsCancelled");
1674 if ( @affects ) {
1675 for my $in ( @itemnumbers ) {
1676 my $item = Koha::Items->find( $in ); # FIXME We do not need that, we already have Koha::Items from $order_obj->items
1677 my $biblio = $item->biblio;
1678 my ( $itemfield ) = GetMarcFromKohaField( 'items.itemnumber', $biblio->frameworkcode );
1679 my $item_marc = C4::Items::GetMarcItem( $biblio->biblionumber, $in );
1680 for my $affect ( @affects ) {
1681 my ( $sf, $v ) = split q{=}, $affect, 2;
1682 foreach ( $item_marc->field($itemfield) ) {
1683 $_->update( $sf => $v );
1686 C4::Items::ModItemFromMarc( $item_marc, $biblio->biblionumber, $in );
1691 return $parent_ordernumber;
1694 sub _cancel_items_receipt {
1695 my ( $order, $parent_ordernumber ) = @_;
1696 $parent_ordernumber ||= $order->ordernumber;
1698 my $items = $order->items;
1699 if ( $order->basket->effective_create_items eq 'receiving' ) {
1700 # Remove items that were created at receipt
1701 my $query = qq{
1702 DELETE FROM items, aqorders_items
1703 USING items, aqorders_items
1704 WHERE items.itemnumber = ? AND aqorders_items.itemnumber = ?
1706 my $dbh = C4::Context->dbh;
1707 my $sth = $dbh->prepare($query);
1708 while ( my $item = $items->next ) {
1709 $sth->execute($item->itemnumber, $item->itemnumber);
1711 } else {
1712 # Update items
1713 while ( my $item = $items->next ) {
1714 ModItemOrder($item->itemnumber, $parent_ordernumber);
1719 #------------------------------------------------------------#
1721 =head3 SearchOrders
1723 @results = &SearchOrders({
1724 ordernumber => $ordernumber,
1725 search => $search,
1726 ean => $ean,
1727 booksellerid => $booksellerid,
1728 basketno => $basketno,
1729 basketname => $basketname,
1730 basketgroupname => $basketgroupname,
1731 owner => $owner,
1732 pending => $pending
1733 ordered => $ordered
1734 biblionumber => $biblionumber,
1735 budget_id => $budget_id
1738 Searches for orders filtered by criteria.
1740 C<$ordernumber> Finds matching orders or transferred orders by ordernumber.
1741 C<$search> Finds orders matching %$search% in title, author, or isbn.
1742 C<$owner> Finds order for the logged in user.
1743 C<$pending> Finds pending orders. Ignores completed and cancelled orders.
1744 C<$ordered> Finds orders to receive only (status 'ordered' or 'partial').
1747 C<@results> is an array of references-to-hash with the keys are fields
1748 from aqorders, biblio, biblioitems and aqbasket tables.
1750 =cut
1752 sub SearchOrders {
1753 my ( $params ) = @_;
1754 my $ordernumber = $params->{ordernumber};
1755 my $search = $params->{search};
1756 my $ean = $params->{ean};
1757 my $booksellerid = $params->{booksellerid};
1758 my $basketno = $params->{basketno};
1759 my $basketname = $params->{basketname};
1760 my $basketgroupname = $params->{basketgroupname};
1761 my $owner = $params->{owner};
1762 my $pending = $params->{pending};
1763 my $ordered = $params->{ordered};
1764 my $biblionumber = $params->{biblionumber};
1765 my $budget_id = $params->{budget_id};
1767 my $dbh = C4::Context->dbh;
1768 my @args = ();
1769 my $query = q{
1770 SELECT aqbasket.basketno,
1771 borrowers.surname,
1772 borrowers.firstname,
1773 biblio.*,
1774 biblioitems.isbn,
1775 biblioitems.biblioitemnumber,
1776 biblioitems.publishercode,
1777 biblioitems.publicationyear,
1778 aqbasket.authorisedby,
1779 aqbasket.booksellerid,
1780 aqbasket.closedate,
1781 aqbasket.creationdate,
1782 aqbasket.basketname,
1783 aqbasketgroups.id as basketgroupid,
1784 aqbasketgroups.name as basketgroupname,
1785 aqorders.*
1786 FROM aqorders
1787 LEFT JOIN aqbasket ON aqorders.basketno = aqbasket.basketno
1788 LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid = aqbasketgroups.id
1789 LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
1790 LEFT JOIN biblio ON aqorders.biblionumber=biblio.biblionumber
1791 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
1794 # If we search on ordernumber, we retrieve the transferred order if a transfer has been done.
1795 $query .= q{
1796 LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_to = aqorders.ordernumber
1797 } if $ordernumber;
1799 $query .= q{
1800 WHERE (datecancellationprinted is NULL)
1803 if ( $pending or $ordered ) {
1804 $query .= q{
1805 AND (
1806 ( aqbasket.is_standing AND aqorders.orderstatus IN ( "new", "ordered", "partial" ) )
1807 OR (
1808 ( quantity > quantityreceived OR quantityreceived is NULL )
1811 if ( $ordered ) {
1812 $query .= q{ AND aqorders.orderstatus IN ( "ordered", "partial" )};
1814 $query .= q{
1820 my $userenv = C4::Context->userenv;
1821 if ( C4::Context->preference("IndependentBranches") ) {
1822 unless ( C4::Context->IsSuperLibrarian() ) {
1823 $query .= q{
1824 AND (
1825 borrowers.branchcode = ?
1826 OR borrowers.branchcode = ''
1829 push @args, $userenv->{branch};
1833 if ( $ordernumber ) {
1834 $query .= ' AND ( aqorders.ordernumber = ? OR aqorders_transfers.ordernumber_from = ? ) ';
1835 push @args, ( $ordernumber, $ordernumber );
1837 if ( $biblionumber ) {
1838 $query .= 'AND aqorders.biblionumber = ?';
1839 push @args, $biblionumber;
1841 if( $search ) {
1842 $query .= ' AND (biblio.title LIKE ? OR biblio.author LIKE ? OR biblioitems.isbn LIKE ?)';
1843 push @args, ("%$search%","%$search%","%$search%");
1845 if ( $ean ) {
1846 $query .= ' AND biblioitems.ean = ?';
1847 push @args, $ean;
1849 if ( $booksellerid ) {
1850 $query .= 'AND aqbasket.booksellerid = ?';
1851 push @args, $booksellerid;
1853 if( $basketno ) {
1854 $query .= 'AND aqbasket.basketno = ?';
1855 push @args, $basketno;
1857 if( $basketname ) {
1858 $query .= 'AND aqbasket.basketname LIKE ?';
1859 push @args, "%$basketname%";
1861 if( $basketgroupname ) {
1862 $query .= ' AND aqbasketgroups.name LIKE ?';
1863 push @args, "%$basketgroupname%";
1866 if ( $owner ) {
1867 $query .= ' AND aqbasket.authorisedby=? ';
1868 push @args, $userenv->{'number'};
1871 if ( $budget_id ) {
1872 $query .= ' AND aqorders.budget_id = ?';
1873 push @args, $budget_id;
1876 $query .= ' ORDER BY aqbasket.basketno';
1878 my $sth = $dbh->prepare($query);
1879 $sth->execute(@args);
1880 return $sth->fetchall_arrayref({});
1883 #------------------------------------------------------------#
1885 =head3 DelOrder
1887 &DelOrder($biblionumber, $ordernumber);
1889 Cancel the order with the given order and biblio numbers. It does not
1890 delete any entries in the aqorders table, it merely marks them as
1891 cancelled.
1893 =cut
1895 sub DelOrder {
1896 my ( $bibnum, $ordernumber, $delete_biblio, $reason ) = @_;
1897 my $error;
1898 my $dbh = C4::Context->dbh;
1899 my $query = "
1900 UPDATE aqorders
1901 SET datecancellationprinted=now(), orderstatus='cancelled'
1903 if($reason) {
1904 $query .= ", cancellationreason = ? ";
1906 $query .= "
1907 WHERE biblionumber=? AND ordernumber=?
1909 my $sth = $dbh->prepare($query);
1910 if($reason) {
1911 $sth->execute($reason, $bibnum, $ordernumber);
1912 } else {
1913 $sth->execute( $bibnum, $ordernumber );
1915 $sth->finish;
1917 my $order = Koha::Acquisition::Orders->find($ordernumber);
1918 my $items = $order->items;
1919 while ( my $item = $items->next ) { # Should be moved to Koha::Acquisition::Order->delete
1920 my $delcheck = C4::Items::DelItemCheck( $bibnum, $item->itemnumber );
1922 if($delcheck != 1) {
1923 $error->{'delitem'} = 1;
1927 if($delete_biblio) {
1928 # We get the number of remaining items
1929 my $biblio = Koha::Biblios->find( $bibnum );
1930 my $itemcount = $biblio->items->count;
1932 # If there are no items left,
1933 if ( $itemcount == 0 ) {
1934 # We delete the record
1935 my $delcheck = DelBiblio($bibnum);
1937 if($delcheck) {
1938 $error->{'delbiblio'} = 1;
1943 return $error;
1946 =head3 TransferOrder
1948 my $newordernumber = TransferOrder($ordernumber, $basketno);
1950 Transfer an order line to a basket.
1951 Mark $ordernumber as cancelled with an internal note 'Cancelled and transferred
1952 to BOOKSELLER on DATE' and create new order with internal note
1953 'Transferred from BOOKSELLER on DATE'.
1954 Move all attached items to the new order.
1955 Received orders cannot be transferred.
1956 Return the ordernumber of created order.
1958 =cut
1960 sub TransferOrder {
1961 my ($ordernumber, $basketno) = @_;
1963 return unless ($ordernumber and $basketno);
1965 my $order = Koha::Acquisition::Orders->find( $ordernumber ) or return;
1966 return if $order->datereceived;
1968 $order = $order->unblessed;
1970 my $basket = GetBasket($basketno);
1971 return unless $basket;
1973 my $dbh = C4::Context->dbh;
1974 my ($query, $sth, $rv);
1976 $query = q{
1977 UPDATE aqorders
1978 SET datecancellationprinted = CAST(NOW() AS date), orderstatus = ?
1979 WHERE ordernumber = ?
1981 $sth = $dbh->prepare($query);
1982 $rv = $sth->execute('cancelled', $ordernumber);
1984 delete $order->{'ordernumber'};
1985 delete $order->{parent_ordernumber};
1986 $order->{'basketno'} = $basketno;
1988 my $newordernumber = Koha::Acquisition::Order->new($order)->store->ordernumber;
1990 $query = q{
1991 UPDATE aqorders_items
1992 SET ordernumber = ?
1993 WHERE ordernumber = ?
1995 $sth = $dbh->prepare($query);
1996 $sth->execute($newordernumber, $ordernumber);
1998 $query = q{
1999 INSERT INTO aqorders_transfers (ordernumber_from, ordernumber_to)
2000 VALUES (?, ?)
2002 $sth = $dbh->prepare($query);
2003 $sth->execute($ordernumber, $newordernumber);
2005 return $newordernumber;
2008 =head3 get_rounding_sql
2010 $rounding_sql = get_rounding_sql($column_name);
2012 returns the correct SQL routine based on OrderPriceRounding system preference.
2014 =cut
2016 sub get_rounding_sql {
2017 my ( $round_string ) = @_;
2018 my $rounding_pref = C4::Context->preference('OrderPriceRounding') // q{};
2019 if ( $rounding_pref eq "nearest_cent" ) {
2020 return "CAST($round_string*100 AS SIGNED)/100";
2022 return $round_string;
2025 =head3 get_rounded_price
2027 $rounded_price = get_rounded_price( $price );
2029 returns a price rounded as specified in OrderPriceRounding system preference.
2031 =cut
2033 sub get_rounded_price {
2034 my ( $price ) = @_;
2035 my $rounding_pref = C4::Context->preference('OrderPriceRounding') // q{};
2036 if( $rounding_pref eq 'nearest_cent' ) {
2037 return Koha::Number::Price->new( $price )->round();
2039 return $price;
2043 =head2 FUNCTIONS ABOUT PARCELS
2045 =head3 GetParcels
2047 $results = &GetParcels($bookseller, $order, $code, $datefrom, $dateto);
2049 get a lists of parcels.
2051 * Input arg :
2053 =over
2055 =item $bookseller
2056 is the bookseller this function has to get parcels.
2058 =item $order
2059 To know on what criteria the results list has to be ordered.
2061 =item $code
2062 is the booksellerinvoicenumber.
2064 =item $datefrom & $dateto
2065 to know on what date this function has to filter its search.
2067 =back
2069 * return:
2070 a pointer on a hash list containing parcel informations as such :
2072 =over
2074 =item Creation date
2076 =item Last operation
2078 =item Number of biblio
2080 =item Number of items
2082 =back
2084 =cut
2086 sub GetParcels {
2087 my ($bookseller,$order, $code, $datefrom, $dateto) = @_;
2088 my $dbh = C4::Context->dbh;
2089 my @query_params = ();
2090 my $strsth ="
2091 SELECT aqinvoices.invoicenumber,
2092 datereceived,purchaseordernumber,
2093 count(DISTINCT biblionumber) AS biblio,
2094 sum(quantity) AS itemsexpected,
2095 sum(quantityreceived) AS itemsreceived
2096 FROM aqorders LEFT JOIN aqbasket ON aqbasket.basketno = aqorders.basketno
2097 LEFT JOIN aqinvoices ON aqorders.invoiceid = aqinvoices.invoiceid
2098 WHERE aqbasket.booksellerid = ? and datereceived IS NOT NULL
2100 push @query_params, $bookseller;
2102 if ( defined $code ) {
2103 $strsth .= ' and aqinvoices.invoicenumber like ? ';
2104 # add a % to the end of the code to allow stemming.
2105 push @query_params, "$code%";
2108 if ( defined $datefrom ) {
2109 $strsth .= ' and datereceived >= ? ';
2110 push @query_params, $datefrom;
2113 if ( defined $dateto ) {
2114 $strsth .= 'and datereceived <= ? ';
2115 push @query_params, $dateto;
2118 $strsth .= "group by aqinvoices.invoicenumber,datereceived ";
2120 # can't use a placeholder to place this column name.
2121 # but, we could probably be checking to make sure it is a column that will be fetched.
2122 $strsth .= "order by $order " if ($order);
2124 my $sth = $dbh->prepare($strsth);
2126 $sth->execute( @query_params );
2127 my $results = $sth->fetchall_arrayref({});
2128 return @{$results};
2131 #------------------------------------------------------------#
2133 =head3 GetLateOrders
2135 @results = &GetLateOrders;
2137 Searches for bookseller with late orders.
2139 return:
2140 the table of supplier with late issues. This table is full of hashref.
2142 =cut
2144 sub GetLateOrders {
2145 my $delay = shift;
2146 my $supplierid = shift;
2147 my $branch = shift;
2148 my $estimateddeliverydatefrom = shift;
2149 my $estimateddeliverydateto = shift;
2151 my $dbh = C4::Context->dbh;
2153 #BEWARE, order of parenthesis and LEFT JOIN is important for speed
2154 my $dbdriver = C4::Context->config("db_scheme") || "mysql";
2156 my @query_params = ();
2157 my $select = "
2158 SELECT aqbasket.basketno,
2159 aqorders.ordernumber,
2160 DATE(aqbasket.closedate) AS orderdate,
2161 aqbasket.basketname AS basketname,
2162 aqbasket.basketgroupid AS basketgroupid,
2163 aqbasketgroups.name AS basketgroupname,
2164 aqorders.rrp AS unitpricesupplier,
2165 aqorders.ecost AS unitpricelib,
2166 aqorders.claims_count AS claims_count,
2167 aqorders.claimed_date AS claimed_date,
2168 aqbudgets.budget_name AS budget,
2169 borrowers.branchcode AS branch,
2170 aqbooksellers.name AS supplier,
2171 aqbooksellers.id AS supplierid,
2172 biblio.author, biblio.title,
2173 biblioitems.publishercode AS publisher,
2174 biblioitems.publicationyear,
2175 ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) AS estimateddeliverydate,
2177 my $from = "
2178 FROM
2179 aqorders LEFT JOIN biblio ON biblio.biblionumber = aqorders.biblionumber
2180 LEFT JOIN biblioitems ON biblioitems.biblionumber = biblio.biblionumber
2181 LEFT JOIN aqbudgets ON aqorders.budget_id = aqbudgets.budget_id,
2182 aqbasket LEFT JOIN borrowers ON aqbasket.authorisedby = borrowers.borrowernumber
2183 LEFT JOIN aqbooksellers ON aqbasket.booksellerid = aqbooksellers.id
2184 LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid = aqbasketgroups.id
2185 WHERE aqorders.basketno = aqbasket.basketno
2186 AND ( datereceived = ''
2187 OR datereceived IS NULL
2188 OR aqorders.quantityreceived < aqorders.quantity
2190 AND aqbasket.closedate IS NOT NULL
2191 AND (aqorders.datecancellationprinted IS NULL OR aqorders.datecancellationprinted='0000-00-00')
2193 if ($dbdriver eq "mysql") {
2194 $select .= "
2195 aqorders.quantity - COALESCE(aqorders.quantityreceived,0) AS quantity,
2196 (aqorders.quantity - COALESCE(aqorders.quantityreceived,0)) * aqorders.rrp AS subtotal,
2197 DATEDIFF(CAST(now() AS date),closedate) AS latesince
2199 if ( defined $delay ) {
2200 $from .= " AND (closedate <= DATE_SUB(CAST(now() AS date),INTERVAL ? DAY)) " ;
2201 push @query_params, $delay;
2203 $from .= " AND aqorders.quantity - COALESCE(aqorders.quantityreceived,0) <> 0";
2204 } else {
2205 # FIXME: account for IFNULL as above
2206 $select .= "
2207 aqorders.quantity AS quantity,
2208 aqorders.quantity * aqorders.rrp AS subtotal,
2209 (CAST(now() AS date) - closedate) AS latesince
2211 if ( defined $delay ) {
2212 $from .= " AND (closedate <= (CAST(now() AS date) -(INTERVAL ? DAY)) ";
2213 push @query_params, $delay;
2215 $from .= " AND aqorders.quantity <> 0";
2217 if (defined $supplierid) {
2218 $from .= ' AND aqbasket.booksellerid = ? ';
2219 push @query_params, $supplierid;
2221 if (defined $branch) {
2222 $from .= ' AND borrowers.branchcode LIKE ? ';
2223 push @query_params, $branch;
2226 if ( defined $estimateddeliverydatefrom or defined $estimateddeliverydateto ) {
2227 $from .= ' AND aqbooksellers.deliverytime IS NOT NULL ';
2229 if ( defined $estimateddeliverydatefrom ) {
2230 $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) >= ?';
2231 push @query_params, $estimateddeliverydatefrom;
2233 if ( defined $estimateddeliverydateto ) {
2234 $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) <= ?';
2235 push @query_params, $estimateddeliverydateto;
2237 if ( defined $estimateddeliverydatefrom and not defined $estimateddeliverydateto ) {
2238 $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) <= CAST(now() AS date)';
2240 if (C4::Context->preference("IndependentBranches")
2241 && !C4::Context->IsSuperLibrarian() ) {
2242 $from .= ' AND borrowers.branchcode LIKE ? ';
2243 push @query_params, C4::Context->userenv->{branch};
2245 $from .= " AND orderstatus <> 'cancelled' ";
2246 my $query = "$select $from \nORDER BY latesince, basketno, borrowers.branchcode, supplier";
2247 $debug and print STDERR "GetLateOrders query: $query\nGetLateOrders args: " . join(" ",@query_params);
2248 my $sth = $dbh->prepare($query);
2249 $sth->execute(@query_params);
2250 my @results;
2251 while (my $data = $sth->fetchrow_hashref) {
2252 push @results, $data;
2254 return @results;
2257 #------------------------------------------------------------#
2259 =head3 GetHistory
2261 \@order_loop = GetHistory( %params );
2263 Retreives some acquisition history information
2265 params:
2266 title
2267 author
2268 name
2269 isbn
2271 from_placed_on
2272 to_placed_on
2273 basket - search both basket name and number
2274 booksellerinvoicenumber
2275 basketgroupname
2276 budget
2277 orderstatus (note that orderstatus '' will retrieve orders
2278 of any status except cancelled)
2279 biblionumber
2280 get_canceled_order (if set to a true value, cancelled orders will
2281 be included)
2283 returns:
2284 $order_loop is a list of hashrefs that each look like this:
2286 'author' => 'Twain, Mark',
2287 'basketno' => '1',
2288 'biblionumber' => '215',
2289 'count' => 1,
2290 'creationdate' => 'MM/DD/YYYY',
2291 'datereceived' => undef,
2292 'ecost' => '1.00',
2293 'id' => '1',
2294 'invoicenumber' => undef,
2295 'name' => '',
2296 'ordernumber' => '1',
2297 'quantity' => 1,
2298 'quantityreceived' => undef,
2299 'title' => 'The Adventures of Huckleberry Finn'
2302 =cut
2304 sub GetHistory {
2305 # don't run the query if there are no parameters (list would be too long for sure !)
2306 croak "No search params" unless @_;
2307 my %params = @_;
2308 my $title = $params{title};
2309 my $author = $params{author};
2310 my $isbn = $params{isbn};
2311 my $ean = $params{ean};
2312 my $name = $params{name};
2313 my $from_placed_on = $params{from_placed_on};
2314 my $to_placed_on = $params{to_placed_on};
2315 my $basket = $params{basket};
2316 my $booksellerinvoicenumber = $params{booksellerinvoicenumber};
2317 my $basketgroupname = $params{basketgroupname};
2318 my $budget = $params{budget};
2319 my $orderstatus = $params{orderstatus};
2320 my $biblionumber = $params{biblionumber};
2321 my $get_canceled_order = $params{get_canceled_order} || 0;
2322 my $ordernumber = $params{ordernumber};
2323 my $search_children_too = $params{search_children_too} || 0;
2324 my $created_by = $params{created_by} || [];
2325 my $ordernumbers = $params{ordernumbers} || [];
2326 my $additional_fields = $params{additional_fields} // [];
2328 my @order_loop;
2329 my $total_qty = 0;
2330 my $total_qtyreceived = 0;
2331 my $total_price = 0;
2333 #get variation of isbn
2334 my @isbn_params;
2335 my @isbns;
2336 if ($isbn){
2337 if ( C4::Context->preference("SearchWithISBNVariations") ){
2338 @isbns = C4::Koha::GetVariationsOfISBN( $isbn );
2339 foreach my $isb (@isbns){
2340 push @isbn_params, '?';
2343 unless (@isbns){
2344 push @isbns, $isbn;
2345 push @isbn_params, '?';
2349 my $dbh = C4::Context->dbh;
2350 my $query ="
2351 SELECT
2352 COALESCE(biblio.title, deletedbiblio.title) AS title,
2353 COALESCE(biblio.author, deletedbiblio.author) AS author,
2354 COALESCE(biblioitems.isbn, deletedbiblioitems.isbn) AS isbn,
2355 COALESCE(biblioitems.ean, deletedbiblioitems.ean) AS ean,
2356 aqorders.basketno,
2357 aqbasket.basketname,
2358 aqbasket.basketgroupid,
2359 aqbasket.authorisedby,
2360 concat( borrowers.firstname,' ',borrowers.surname) AS authorisedbyname,
2361 aqbasketgroups.name as groupname,
2362 aqbooksellers.name,
2363 aqbasket.creationdate,
2364 aqorders.datereceived,
2365 aqorders.quantity,
2366 aqorders.quantityreceived,
2367 aqorders.ecost,
2368 aqorders.ordernumber,
2369 aqorders.invoiceid,
2370 aqinvoices.invoicenumber,
2371 aqbooksellers.id as id,
2372 aqorders.biblionumber,
2373 aqorders.orderstatus,
2374 aqorders.parent_ordernumber,
2375 aqbudgets.budget_name
2377 $query .= ", aqbudgets.budget_id AS budget" if defined $budget;
2378 $query .= "
2379 FROM aqorders
2380 LEFT JOIN aqbasket ON aqorders.basketno=aqbasket.basketno
2381 LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid=aqbasketgroups.id
2382 LEFT JOIN aqbooksellers ON aqbasket.booksellerid=aqbooksellers.id
2383 LEFT JOIN biblioitems ON biblioitems.biblionumber=aqorders.biblionumber
2384 LEFT JOIN biblio ON biblio.biblionumber=aqorders.biblionumber
2385 LEFT JOIN aqbudgets ON aqorders.budget_id=aqbudgets.budget_id
2386 LEFT JOIN aqinvoices ON aqorders.invoiceid = aqinvoices.invoiceid
2387 LEFT JOIN deletedbiblio ON deletedbiblio.biblionumber=aqorders.biblionumber
2388 LEFT JOIN deletedbiblioitems ON deletedbiblioitems.biblionumber=aqorders.biblionumber
2389 LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
2392 $query .= " WHERE 1 ";
2394 unless ($get_canceled_order or (defined $orderstatus and $orderstatus eq 'cancelled')) {
2395 $query .= " AND (datecancellationprinted is NULL or datecancellationprinted='0000-00-00') ";
2398 my @query_params = ();
2400 if ( $biblionumber ) {
2401 $query .= " AND biblio.biblionumber = ?";
2402 push @query_params, $biblionumber;
2405 if ( $title ) {
2406 $query .= " AND biblio.title LIKE ? ";
2407 $title =~ s/\s+/%/g;
2408 push @query_params, "%$title%";
2411 if ( $author ) {
2412 $query .= " AND biblio.author LIKE ? ";
2413 push @query_params, "%$author%";
2416 if ( @isbns ) {
2417 $query .= " AND ( biblioitems.isbn LIKE " . join (" OR biblioitems.isbn LIKE ", @isbn_params ) . ")";
2418 foreach my $isb (@isbns){
2419 push @query_params, "%$isb%";
2423 if ( $ean ) {
2424 $query .= " AND biblioitems.ean = ? ";
2425 push @query_params, "$ean";
2427 if ( $name ) {
2428 $query .= " AND aqbooksellers.name LIKE ? ";
2429 push @query_params, "%$name%";
2432 if ( $budget ) {
2433 $query .= " AND aqbudgets.budget_id = ? ";
2434 push @query_params, "$budget";
2437 if ( $from_placed_on ) {
2438 $query .= " AND creationdate >= ? ";
2439 push @query_params, $from_placed_on;
2442 if ( $to_placed_on ) {
2443 $query .= " AND creationdate <= ? ";
2444 push @query_params, $to_placed_on;
2447 if ( defined $orderstatus and $orderstatus ne '') {
2448 $query .= " AND aqorders.orderstatus = ? ";
2449 push @query_params, "$orderstatus";
2452 if ($basket) {
2453 if ($basket =~ m/^\d+$/) {
2454 $query .= " AND aqorders.basketno = ? ";
2455 push @query_params, $basket;
2456 } else {
2457 $query .= " AND aqbasket.basketname LIKE ? ";
2458 push @query_params, "%$basket%";
2462 if ($booksellerinvoicenumber) {
2463 $query .= " AND aqinvoices.invoicenumber LIKE ? ";
2464 push @query_params, "%$booksellerinvoicenumber%";
2467 if ($basketgroupname) {
2468 $query .= " AND aqbasketgroups.name LIKE ? ";
2469 push @query_params, "%$basketgroupname%";
2472 if ($ordernumber) {
2473 $query .= " AND (aqorders.ordernumber = ? ";
2474 push @query_params, $ordernumber;
2475 if ($search_children_too) {
2476 $query .= " OR aqorders.parent_ordernumber = ? ";
2477 push @query_params, $ordernumber;
2479 $query .= ") ";
2482 if ( @$created_by ) {
2483 $query .= ' AND aqbasket.authorisedby IN ( ' . join( ',', ('?') x @$created_by ) . ')';
2484 push @query_params, @$created_by;
2487 if ( @$ordernumbers ) {
2488 $query .= ' AND (aqorders.ordernumber IN ( ' . join (',', ('?') x @$ordernumbers ) . '))';
2489 push @query_params, @$ordernumbers;
2491 if ( @$additional_fields ) {
2492 my @baskets = Koha::Acquisition::Baskets->filter_by_additional_fields($additional_fields);
2494 return [] unless @baskets;
2496 # No parameterization because record IDs come directly from DB
2497 $query .= ' AND aqbasket.basketno IN ( ' . join( ',', map { $_->basketno } @baskets ) . ' )';
2500 if ( C4::Context->preference("IndependentBranches") ) {
2501 unless ( C4::Context->IsSuperLibrarian() ) {
2502 $query .= " AND (borrowers.branchcode = ? OR borrowers.branchcode ='' ) ";
2503 push @query_params, C4::Context->userenv->{branch};
2506 $query .= " ORDER BY id";
2508 return $dbh->selectall_arrayref( $query, { Slice => {} }, @query_params );
2511 =head2 GetRecentAcqui
2513 $results = GetRecentAcqui($days);
2515 C<$results> is a ref to a table which contains hashref
2517 =cut
2519 sub GetRecentAcqui {
2520 my $limit = shift;
2521 my $dbh = C4::Context->dbh;
2522 my $query = "
2523 SELECT *
2524 FROM biblio
2525 ORDER BY timestamp DESC
2526 LIMIT 0,".$limit;
2528 my $sth = $dbh->prepare($query);
2529 $sth->execute;
2530 my $results = $sth->fetchall_arrayref({});
2531 return $results;
2534 #------------------------------------------------------------#
2536 =head3 AddClaim
2538 &AddClaim($ordernumber);
2540 Add a claim for an order
2542 =cut
2544 sub AddClaim {
2545 my ($ordernumber) = @_;
2546 my $dbh = C4::Context->dbh;
2547 my $query = "
2548 UPDATE aqorders SET
2549 claims_count = claims_count + 1,
2550 claimed_date = CURDATE()
2551 WHERE ordernumber = ?
2553 my $sth = $dbh->prepare($query);
2554 $sth->execute($ordernumber);
2557 =head3 GetInvoices
2559 my @invoices = GetInvoices(
2560 invoicenumber => $invoicenumber,
2561 supplierid => $supplierid,
2562 suppliername => $suppliername,
2563 shipmentdatefrom => $shipmentdatefrom, # ISO format
2564 shipmentdateto => $shipmentdateto, # ISO format
2565 billingdatefrom => $billingdatefrom, # ISO format
2566 billingdateto => $billingdateto, # ISO format
2567 isbneanissn => $isbn_or_ean_or_issn,
2568 title => $title,
2569 author => $author,
2570 publisher => $publisher,
2571 publicationyear => $publicationyear,
2572 branchcode => $branchcode,
2573 order_by => $order_by
2576 Return a list of invoices that match all given criteria.
2578 $order_by is "column_name (asc|desc)", where column_name is any of
2579 'invoicenumber', 'booksellerid', 'shipmentdate', 'billingdate', 'closedate',
2580 'shipmentcost', 'shipmentcost_budgetid'.
2582 asc is the default if omitted
2584 =cut
2586 sub GetInvoices {
2587 my %args = @_;
2589 my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2590 closedate shipmentcost shipmentcost_budgetid);
2592 my $dbh = C4::Context->dbh;
2593 my $query = qq{
2594 SELECT aqinvoices.invoiceid, aqinvoices.invoicenumber, aqinvoices.booksellerid, aqinvoices.shipmentdate, aqinvoices.billingdate, aqinvoices.closedate, aqinvoices.shipmentcost, aqinvoices.shipmentcost_budgetid, aqinvoices.message_id,
2595 aqbooksellers.name AS suppliername,
2596 COUNT(
2597 DISTINCT IF(
2598 aqorders.datereceived IS NOT NULL,
2599 aqorders.biblionumber,
2600 NULL
2602 ) AS receivedbiblios,
2603 COUNT(
2604 DISTINCT IF(
2605 aqorders.subscriptionid IS NOT NULL,
2606 aqorders.subscriptionid,
2607 NULL
2609 ) AS is_linked_to_subscriptions,
2610 SUM(aqorders.quantityreceived) AS receiveditems
2611 FROM aqinvoices
2612 LEFT JOIN aqbooksellers ON aqbooksellers.id = aqinvoices.booksellerid
2613 LEFT JOIN aqorders ON aqorders.invoiceid = aqinvoices.invoiceid
2614 LEFT JOIN aqbasket ON aqbasket.basketno=aqorders.basketno
2615 LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
2616 LEFT JOIN biblio ON aqorders.biblionumber = biblio.biblionumber
2617 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
2618 LEFT JOIN subscription ON biblio.biblionumber = subscription.biblionumber
2621 my @bind_args;
2622 my @bind_strs;
2623 if($args{supplierid}) {
2624 push @bind_strs, " aqinvoices.booksellerid = ? ";
2625 push @bind_args, $args{supplierid};
2627 if($args{invoicenumber}) {
2628 push @bind_strs, " aqinvoices.invoicenumber LIKE ? ";
2629 push @bind_args, "%$args{invoicenumber}%";
2631 if($args{suppliername}) {
2632 push @bind_strs, " aqbooksellers.name LIKE ? ";
2633 push @bind_args, "%$args{suppliername}%";
2635 if($args{shipmentdatefrom}) {
2636 push @bind_strs, " aqinvoices.shipmentdate >= ? ";
2637 push @bind_args, $args{shipmentdatefrom};
2639 if($args{shipmentdateto}) {
2640 push @bind_strs, " aqinvoices.shipmentdate <= ? ";
2641 push @bind_args, $args{shipmentdateto};
2643 if($args{billingdatefrom}) {
2644 push @bind_strs, " aqinvoices.billingdate >= ? ";
2645 push @bind_args, $args{billingdatefrom};
2647 if($args{billingdateto}) {
2648 push @bind_strs, " aqinvoices.billingdate <= ? ";
2649 push @bind_args, $args{billingdateto};
2651 if($args{isbneanissn}) {
2652 push @bind_strs, " (biblioitems.isbn LIKE CONCAT('%', ?, '%') OR biblioitems.ean LIKE CONCAT('%', ?, '%') OR biblioitems.issn LIKE CONCAT('%', ?, '%') ) ";
2653 push @bind_args, $args{isbneanissn}, $args{isbneanissn}, $args{isbneanissn};
2655 if($args{title}) {
2656 push @bind_strs, " biblio.title LIKE CONCAT('%', ?, '%') ";
2657 push @bind_args, $args{title};
2659 if($args{author}) {
2660 push @bind_strs, " biblio.author LIKE CONCAT('%', ?, '%') ";
2661 push @bind_args, $args{author};
2663 if($args{publisher}) {
2664 push @bind_strs, " biblioitems.publishercode LIKE CONCAT('%', ?, '%') ";
2665 push @bind_args, $args{publisher};
2667 if($args{publicationyear}) {
2668 push @bind_strs, " ((biblioitems.publicationyear LIKE CONCAT('%', ?, '%')) OR (biblio.copyrightdate LIKE CONCAT('%', ?, '%'))) ";
2669 push @bind_args, $args{publicationyear}, $args{publicationyear};
2671 if($args{branchcode}) {
2672 push @bind_strs, " borrowers.branchcode = ? ";
2673 push @bind_args, $args{branchcode};
2675 if($args{message_id}) {
2676 push @bind_strs, " aqinvoices.message_id = ? ";
2677 push @bind_args, $args{message_id};
2680 $query .= " WHERE " . join(" AND ", @bind_strs) if @bind_strs;
2681 $query .= " GROUP BY aqinvoices.invoiceid, aqinvoices.invoicenumber, aqinvoices.booksellerid, aqinvoices.shipmentdate, aqinvoices.billingdate, aqinvoices.closedate, aqinvoices.shipmentcost, aqinvoices.shipmentcost_budgetid, aqinvoices.message_id, aqbooksellers.name";
2683 if($args{order_by}) {
2684 my ($column, $direction) = split / /, $args{order_by};
2685 if(grep /^$column$/, @columns) {
2686 $direction ||= 'ASC';
2687 $query .= " ORDER BY $column $direction";
2691 my $sth = $dbh->prepare($query);
2692 $sth->execute(@bind_args);
2694 my $results = $sth->fetchall_arrayref({});
2695 return @$results;
2698 =head3 GetInvoice
2700 my $invoice = GetInvoice($invoiceid);
2702 Get informations about invoice with given $invoiceid
2704 Return a hash filled with aqinvoices.* fields
2706 =cut
2708 sub GetInvoice {
2709 my ($invoiceid) = @_;
2710 my $invoice;
2712 return unless $invoiceid;
2714 my $dbh = C4::Context->dbh;
2715 my $query = qq{
2716 SELECT *
2717 FROM aqinvoices
2718 WHERE invoiceid = ?
2720 my $sth = $dbh->prepare($query);
2721 $sth->execute($invoiceid);
2723 $invoice = $sth->fetchrow_hashref;
2724 return $invoice;
2727 =head3 GetInvoiceDetails
2729 my $invoice = GetInvoiceDetails($invoiceid)
2731 Return informations about an invoice + the list of related order lines
2733 Orders informations are in $invoice->{orders} (array ref)
2735 =cut
2737 sub GetInvoiceDetails {
2738 my ($invoiceid) = @_;
2740 if ( !defined $invoiceid ) {
2741 carp 'GetInvoiceDetails called without an invoiceid';
2742 return;
2745 my $dbh = C4::Context->dbh;
2746 my $query = q{
2747 SELECT aqinvoices.*, aqbooksellers.name AS suppliername
2748 FROM aqinvoices
2749 LEFT JOIN aqbooksellers ON aqinvoices.booksellerid = aqbooksellers.id
2750 WHERE invoiceid = ?
2752 my $sth = $dbh->prepare($query);
2753 $sth->execute($invoiceid);
2755 my $invoice = $sth->fetchrow_hashref;
2757 $query = q{
2758 SELECT aqorders.*,
2759 biblio.*,
2760 biblio.copyrightdate,
2761 biblioitems.isbn,
2762 biblioitems.publishercode,
2763 biblioitems.publicationyear,
2764 aqbasket.basketname,
2765 aqbasketgroups.id AS basketgroupid,
2766 aqbasketgroups.name AS basketgroupname
2767 FROM aqorders
2768 LEFT JOIN aqbasket ON aqorders.basketno = aqbasket.basketno
2769 LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid = aqbasketgroups.id
2770 LEFT JOIN biblio ON aqorders.biblionumber = biblio.biblionumber
2771 LEFT JOIN biblioitems ON aqorders.biblionumber = biblioitems.biblionumber
2772 WHERE invoiceid = ?
2774 $sth = $dbh->prepare($query);
2775 $sth->execute($invoiceid);
2776 $invoice->{orders} = $sth->fetchall_arrayref({});
2777 $invoice->{orders} ||= []; # force an empty arrayref if fetchall_arrayref fails
2779 return $invoice;
2782 =head3 AddInvoice
2784 my $invoiceid = AddInvoice(
2785 invoicenumber => $invoicenumber,
2786 booksellerid => $booksellerid,
2787 shipmentdate => $shipmentdate,
2788 billingdate => $billingdate,
2789 closedate => $closedate,
2790 shipmentcost => $shipmentcost,
2791 shipmentcost_budgetid => $shipmentcost_budgetid
2794 Create a new invoice and return its id or undef if it fails.
2796 =cut
2798 sub AddInvoice {
2799 my %invoice = @_;
2801 return unless(%invoice and $invoice{invoicenumber});
2803 my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2804 closedate shipmentcost shipmentcost_budgetid message_id);
2806 my @set_strs;
2807 my @set_args;
2808 foreach my $key (keys %invoice) {
2809 if(0 < grep(/^$key$/, @columns)) {
2810 push @set_strs, "$key = ?";
2811 push @set_args, ($invoice{$key} || undef);
2815 my $rv;
2816 if(@set_args > 0) {
2817 my $dbh = C4::Context->dbh;
2818 my $query = "INSERT INTO aqinvoices SET ";
2819 $query .= join (",", @set_strs);
2820 my $sth = $dbh->prepare($query);
2821 $rv = $sth->execute(@set_args);
2822 if($rv) {
2823 $rv = $dbh->last_insert_id(undef, undef, 'aqinvoices', undef);
2826 return $rv;
2829 =head3 ModInvoice
2831 ModInvoice(
2832 invoiceid => $invoiceid, # Mandatory
2833 invoicenumber => $invoicenumber,
2834 booksellerid => $booksellerid,
2835 shipmentdate => $shipmentdate,
2836 billingdate => $billingdate,
2837 closedate => $closedate,
2838 shipmentcost => $shipmentcost,
2839 shipmentcost_budgetid => $shipmentcost_budgetid
2842 Modify an invoice, invoiceid is mandatory.
2844 Return undef if it fails.
2846 =cut
2848 sub ModInvoice {
2849 my %invoice = @_;
2851 return unless(%invoice and $invoice{invoiceid});
2853 my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2854 closedate shipmentcost shipmentcost_budgetid);
2856 my @set_strs;
2857 my @set_args;
2858 foreach my $key (keys %invoice) {
2859 if(0 < grep(/^$key$/, @columns)) {
2860 push @set_strs, "$key = ?";
2861 push @set_args, ($invoice{$key} || undef);
2865 my $dbh = C4::Context->dbh;
2866 my $query = "UPDATE aqinvoices SET ";
2867 $query .= join(",", @set_strs);
2868 $query .= " WHERE invoiceid = ?";
2870 my $sth = $dbh->prepare($query);
2871 $sth->execute(@set_args, $invoice{invoiceid});
2874 =head3 CloseInvoice
2876 CloseInvoice($invoiceid);
2878 Close an invoice.
2880 Equivalent to ModInvoice(invoiceid => $invoiceid, closedate => undef);
2882 =cut
2884 sub CloseInvoice {
2885 my ($invoiceid) = @_;
2887 return unless $invoiceid;
2889 my $dbh = C4::Context->dbh;
2890 my $query = qq{
2891 UPDATE aqinvoices
2892 SET closedate = CAST(NOW() AS DATE)
2893 WHERE invoiceid = ?
2895 my $sth = $dbh->prepare($query);
2896 $sth->execute($invoiceid);
2899 =head3 ReopenInvoice
2901 ReopenInvoice($invoiceid);
2903 Reopen an invoice
2905 Equivalent to ModInvoice(invoiceid => $invoiceid, closedate => output_pref({ dt=>dt_from_string, dateonly=>1, otputpref=>'iso' }))
2907 =cut
2909 sub ReopenInvoice {
2910 my ($invoiceid) = @_;
2912 return unless $invoiceid;
2914 my $dbh = C4::Context->dbh;
2915 my $query = qq{
2916 UPDATE aqinvoices
2917 SET closedate = NULL
2918 WHERE invoiceid = ?
2920 my $sth = $dbh->prepare($query);
2921 $sth->execute($invoiceid);
2924 =head3 DelInvoice
2926 DelInvoice($invoiceid);
2928 Delete an invoice if there are no items attached to it.
2930 =cut
2932 sub DelInvoice {
2933 my ($invoiceid) = @_;
2935 return unless $invoiceid;
2937 my $dbh = C4::Context->dbh;
2938 my $query = qq{
2939 SELECT COUNT(*)
2940 FROM aqorders
2941 WHERE invoiceid = ?
2943 my $sth = $dbh->prepare($query);
2944 $sth->execute($invoiceid);
2945 my $res = $sth->fetchrow_arrayref;
2946 if ( $res && $res->[0] == 0 ) {
2947 $query = qq{
2948 DELETE FROM aqinvoices
2949 WHERE invoiceid = ?
2951 my $sth = $dbh->prepare($query);
2952 return ( $sth->execute($invoiceid) > 0 );
2954 return;
2957 =head3 MergeInvoices
2959 MergeInvoices($invoiceid, \@sourceids);
2961 Merge the invoices identified by the IDs in \@sourceids into
2962 the invoice identified by $invoiceid.
2964 =cut
2966 sub MergeInvoices {
2967 my ($invoiceid, $sourceids) = @_;
2969 return unless $invoiceid;
2970 foreach my $sourceid (@$sourceids) {
2971 next if $sourceid == $invoiceid;
2972 my $source = GetInvoiceDetails($sourceid);
2973 foreach my $order (@{$source->{'orders'}}) {
2974 $order->{'invoiceid'} = $invoiceid;
2975 ModOrder($order);
2977 DelInvoice($source->{'invoiceid'});
2979 return;
2982 =head3 GetBiblioCountByBasketno
2984 $biblio_count = &GetBiblioCountByBasketno($basketno);
2986 Looks up the biblio's count that has basketno value $basketno
2988 Returns a quantity
2990 =cut
2992 sub GetBiblioCountByBasketno {
2993 my ($basketno) = @_;
2994 my $dbh = C4::Context->dbh;
2995 my $query = "
2996 SELECT COUNT( DISTINCT( biblionumber ) )
2997 FROM aqorders
2998 WHERE basketno = ?
2999 AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')
3002 my $sth = $dbh->prepare($query);
3003 $sth->execute($basketno);
3004 return $sth->fetchrow;
3007 =head3 populate_order_with_prices
3009 $order = populate_order_with_prices({
3010 order => $order #a hashref with the order values
3011 booksellerid => $booksellerid #FIXME - should obtain from order basket
3012 receiving => 1 # boolean representing order stage, should pass only this or ordering
3013 ordering => 1 # boolean representing order stage
3017 Sets calculated values for an order - all values are stored with pull precision regardless of rounding preference except fot
3018 tax value which is calculated on rounded values if requested
3020 For ordering the values set are:
3021 rrp_tax_included
3022 rrp_tax_excluded
3023 ecost_tax_included
3024 ecost_tax_excluded
3025 tax_value_on_ordering
3026 For receiving the value set are:
3027 unitprice_tax_included
3028 unitprice_tax_excluded
3029 tax_value_on_receiving
3031 Note: When receiving if the rounded value of the unitprice matches the rounded value of the ecost then then ecost (full precision) is used.
3033 Returns a hashref of the order
3035 FIXME: Move this to Koha::Acquisition::Order.pm
3037 =cut
3039 sub populate_order_with_prices {
3040 my ($params) = @_;
3042 my $order = $params->{order};
3043 my $booksellerid = $params->{booksellerid};
3044 return unless $booksellerid;
3046 my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
3048 my $receiving = $params->{receiving};
3049 my $ordering = $params->{ordering};
3050 my $discount = $order->{discount};
3051 $discount /= 100 if $discount > 1;
3053 if ($ordering) {
3054 $order->{tax_rate_on_ordering} //= $order->{tax_rate};
3055 if ( $bookseller->listincgst ) {
3056 # The user entered the rrp tax included
3057 $order->{rrp_tax_included} = $order->{rrp};
3059 # rrp tax excluded = rrp tax included / ( 1 + tax rate )
3060 $order->{rrp_tax_excluded} = $order->{rrp_tax_included} / ( 1 + $order->{tax_rate_on_ordering} );
3062 # ecost tax included = rrp tax included ( 1 - discount )
3063 $order->{ecost_tax_included} = $order->{rrp_tax_included} * ( 1 - $discount );
3065 # ecost tax excluded = rrp tax excluded * ( 1 - discount )
3066 $order->{ecost_tax_excluded} = $order->{rrp_tax_excluded} * ( 1 - $discount );
3068 # tax value = quantity * ecost tax excluded * tax rate
3069 $order->{tax_value_on_ordering} = ( get_rounded_price($order->{ecost_tax_included}) - get_rounded_price($order->{ecost_tax_excluded}) ) * $order->{quantity};
3072 else {
3073 # The user entered the rrp tax excluded
3074 $order->{rrp_tax_excluded} = $order->{rrp};
3076 # rrp tax included = rrp tax excluded * ( 1 - tax rate )
3077 $order->{rrp_tax_included} = $order->{rrp_tax_excluded} * ( 1 + $order->{tax_rate_on_ordering} );
3079 # ecost tax excluded = rrp tax excluded * ( 1 - discount )
3080 $order->{ecost_tax_excluded} = $order->{rrp_tax_excluded} * ( 1 - $discount );
3082 # ecost tax included = rrp tax excluded * ( 1 + tax rate ) * ( 1 - discount ) = ecost tax excluded * ( 1 + tax rate )
3083 $order->{ecost_tax_included} = $order->{ecost_tax_excluded} * ( 1 + $order->{tax_rate_on_ordering} );
3085 # tax value = quantity * ecost tax included * tax rate
3086 $order->{tax_value_on_ordering} = $order->{quantity} * get_rounded_price($order->{ecost_tax_excluded}) * $order->{tax_rate_on_ordering};
3090 if ($receiving) {
3091 $order->{tax_rate_on_receiving} //= $order->{tax_rate};
3092 if ( $bookseller->invoiceincgst ) {
3093 # Trick for unitprice. If the unit price rounded value is the same as the ecost rounded value
3094 # we need to keep the exact ecost value
3095 if ( Koha::Number::Price->new( $order->{unitprice} )->round == Koha::Number::Price->new( $order->{ecost_tax_included} )->round ) {
3096 $order->{unitprice} = $order->{ecost_tax_included};
3099 # The user entered the unit price tax included
3100 $order->{unitprice_tax_included} = $order->{unitprice};
3102 # unit price tax excluded = unit price tax included / ( 1 + tax rate )
3103 $order->{unitprice_tax_excluded} = $order->{unitprice_tax_included} / ( 1 + $order->{tax_rate_on_receiving} );
3105 else {
3106 # Trick for unitprice. If the unit price rounded value is the same as the ecost rounded value
3107 # we need to keep the exact ecost value
3108 if ( Koha::Number::Price->new( $order->{unitprice} )->round == Koha::Number::Price->new( $order->{ecost_tax_excluded} )->round ) {
3109 $order->{unitprice} = $order->{ecost_tax_excluded};
3112 # The user entered the unit price tax excluded
3113 $order->{unitprice_tax_excluded} = $order->{unitprice};
3116 # unit price tax included = unit price tax included * ( 1 + tax rate )
3117 $order->{unitprice_tax_included} = $order->{unitprice_tax_excluded} * ( 1 + $order->{tax_rate_on_receiving} );
3120 # tax value = quantity * unit price tax excluded * tax rate
3121 $order->{tax_value_on_receiving} = $order->{quantity} * get_rounded_price($order->{unitprice_tax_excluded}) * $order->{tax_rate_on_receiving};
3124 return $order;
3127 =head3 GetOrderUsers
3129 $order_users_ids = &GetOrderUsers($ordernumber);
3131 Returns a list of all borrowernumbers that are in order users list
3133 =cut
3135 sub GetOrderUsers {
3136 my ($ordernumber) = @_;
3138 return unless $ordernumber;
3140 my $query = q|
3141 SELECT borrowernumber
3142 FROM aqorder_users
3143 WHERE ordernumber = ?
3145 my $dbh = C4::Context->dbh;
3146 my $sth = $dbh->prepare($query);
3147 $sth->execute($ordernumber);
3148 my $results = $sth->fetchall_arrayref( {} );
3150 my @borrowernumbers;
3151 foreach (@$results) {
3152 push @borrowernumbers, $_->{'borrowernumber'};
3155 return @borrowernumbers;
3158 =head3 ModOrderUsers
3160 my @order_users_ids = (1, 2, 3);
3161 &ModOrderUsers($ordernumber, @basketusers_ids);
3163 Delete all users from order users list, and add users in C<@order_users_ids>
3164 to this users list.
3166 =cut
3168 sub ModOrderUsers {
3169 my ( $ordernumber, @order_users_ids ) = @_;
3171 return unless $ordernumber;
3173 my $dbh = C4::Context->dbh;
3174 my $query = q|
3175 DELETE FROM aqorder_users
3176 WHERE ordernumber = ?
3178 my $sth = $dbh->prepare($query);
3179 $sth->execute($ordernumber);
3181 $query = q|
3182 INSERT INTO aqorder_users (ordernumber, borrowernumber)
3183 VALUES (?, ?)
3185 $sth = $dbh->prepare($query);
3186 foreach my $order_user_id (@order_users_ids) {
3187 $sth->execute( $ordernumber, $order_user_id );
3191 sub NotifyOrderUsers {
3192 my ($ordernumber) = @_;
3194 my @borrowernumbers = GetOrderUsers($ordernumber);
3195 return unless @borrowernumbers;
3197 my $order = GetOrder( $ordernumber );
3198 for my $borrowernumber (@borrowernumbers) {
3199 my $patron = Koha::Patrons->find( $borrowernumber );
3200 my $library = $patron->library->unblessed;
3201 my $biblio = Koha::Biblios->find( $order->{biblionumber} )->unblessed;
3202 my $letter = C4::Letters::GetPreparedLetter(
3203 module => 'acquisition',
3204 letter_code => 'ACQ_NOTIF_ON_RECEIV',
3205 branchcode => $library->{branchcode},
3206 lang => $patron->lang,
3207 tables => {
3208 'branches' => $library,
3209 'borrowers' => $patron->unblessed,
3210 'biblio' => $biblio,
3211 'aqorders' => $order,
3214 if ( $letter ) {
3215 C4::Letters::EnqueueLetter(
3217 letter => $letter,
3218 borrowernumber => $borrowernumber,
3219 LibraryName => C4::Context->preference("LibraryName"),
3220 message_transport_type => 'email',
3222 ) or warn "can't enqueue letter $letter";
3227 =head3 FillWithDefaultValues
3229 FillWithDefaultValues( $marc_record );
3231 This will update the record with default value defined in the ACQ framework.
3232 For all existing fields, if a default value exists and there are no subfield, it will be created.
3233 If the field does not exist, it will be created too.
3235 =cut
3237 sub FillWithDefaultValues {
3238 my ($record) = @_;
3239 my $tagslib = C4::Biblio::GetMarcStructure( 1, 'ACQ', { unsafe => 1 } );
3240 if ($tagslib) {
3241 my ($itemfield) =
3242 C4::Biblio::GetMarcFromKohaField( 'items.itemnumber', '' );
3243 for my $tag ( sort keys %$tagslib ) {
3244 next unless $tag;
3245 next if $tag == $itemfield;
3246 for my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
3247 next if IsMarcStructureInternal($tagslib->{$tag}{$subfield});
3248 my $defaultvalue = $tagslib->{$tag}{$subfield}{defaultvalue};
3249 if ( defined $defaultvalue and $defaultvalue ne '' ) {
3250 my @fields = $record->field($tag);
3251 if (@fields) {
3252 for my $field (@fields) {
3253 unless ( defined $field->subfield($subfield) ) {
3254 $field->add_subfields(
3255 $subfield => $defaultvalue );
3259 else {
3260 $record->insert_fields_ordered(
3261 MARC::Field->new(
3262 $tag, '', '', $subfield => $defaultvalue
3273 __END__
3275 =head1 AUTHOR
3277 Koha Development Team <http://koha-community.org/>
3279 =cut