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>.
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;
37 use Koha::Number::Price;
39 use Koha::CsvProfiles;
49 use vars qw(@ISA @EXPORT);
55 &GetBasket &NewBasket &CloseBasket &ReopenBasket &DelBasket &ModBasket
56 &GetBasketAsCSV &GetBasketGroupAsCSV
57 &GetBasketsByBookseller &GetBasketsByBasketgroup
58 &GetBasketsInfosByBookseller
60 &GetBasketUsers &ModBasketUsers
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
73 &GetLastOrderNotReceivedFromSubscriptionid &GetLastOrderReceivedFromSubscriptionid
89 &GetBiblioCountByBasketno
95 &FillWithDefaultValues
106 sub GetOrderFromItemnumber {
107 my ($itemnumber) = @_;
108 my $dbh = C4::Context->dbh;
111 SELECT * from aqorders LEFT JOIN aqorders_items
112 ON ( aqorders.ordernumber = aqorders_items.ordernumber )
113 WHERE itemnumber = ? |;
115 my $sth = $dbh->prepare($query);
119 $sth->execute($itemnumber);
121 my $order = $sth->fetchrow_hashref;
128 C4::Acquisition - Koha functions for dealing with orders and acquisitions
136 The functions in this module deal with acquisitions, managing book
137 orders, basket and parcels.
141 =head2 FUNCTIONS ABOUT BASKETS
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.
155 my $dbh = C4::Context->dbh;
158 concat( b.firstname,' ',b.surname) AS authorisedbyname
160 LEFT JOIN borrowers b ON aqbasket.authorisedby=b.borrowernumber
163 my $sth=$dbh->prepare($query);
164 $sth->execute($basketno);
165 my $basket = $sth->fetchrow_hashref;
169 #------------------------------------------------------------#
173 $basket = &NewBasket( $booksellerid, $authorizedby, $basketname,
174 $basketnote, $basketbooksellernote, $basketcontractnumber, $deliveryplace, $billingplace, $is_standing, $create_items );
176 Create a new basket in aqbasket table
180 =item C<$booksellerid> is a foreign key in the aqbasket table
182 =item C<$authorizedby> is the username of who created the basket
186 The other parameters are optional, see ModBasketHeader for more info on them.
191 my ( $booksellerid, $authorisedby, $basketname, $basketnote,
192 $basketbooksellernote, $basketcontractnumber, $deliveryplace,
193 $billingplace, $is_standing, $create_items ) = @_;
194 my $dbh = C4::Context->dbh;
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
203 $basketbooksellernote ||= q{};
204 ModBasketHeader( $basket, $basketname, $basketnote, $basketbooksellernote,
205 $basketcontractnumber, $booksellerid, $deliveryplace, $billingplace, $is_standing, $create_items );
209 #------------------------------------------------------------#
213 &CloseBasket($basketno);
215 close a basket (becomes unmodifiable, except for receives)
221 my $dbh = C4::Context->dbh;
222 $dbh->do('UPDATE aqbasket SET closedate=now() WHERE basketno=?', {}, $basketno );
225 q{UPDATE aqorders SET orderstatus = 'ordered' WHERE basketno = ? AND orderstatus NOT IN ( 'complete', 'cancelled')},
233 &ReopenBasket($basketno);
241 my $dbh = C4::Context->dbh;
242 $dbh->do( q{UPDATE aqbasket SET closedate=NULL WHERE basketno=?}, {}, $basketno );
246 SET orderstatus = 'new'
248 AND orderstatus NOT IN ( 'complete', 'cancelled' )
253 #------------------------------------------------------------#
255 =head3 GetBasketAsCSV
257 &GetBasketAsCSV($basketno);
259 Export a basket as CSV
261 $cgi parameter is needed for column name translation
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);
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 =~ /
285 ([^\|]*) # fieldname (table.row or row)
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) {
300 my $biblio = Koha::Biblios->find( $order->{biblionumber} );
301 my $biblioitem = $biblio->biblioitem;
302 $order = { %$order, %{ $biblioitem->unblessed } };
304 $order = {%$order, %$contract};
306 $order = {%$order, %$basket, %{ $biblio->unblessed }};
307 for my $field (@fields) {
308 push @row, $order->{$field};
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";
321 foreach my $order (@orders) {
322 my $biblio = Koha::Biblios->find( $order->{biblionumber} );
323 my $biblioitem = $biblio->biblioitem;
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
344 contractname author title publishercode collectiontitle notes
345 deliveryplace billingplace
347 # Double the quotes to not be interpreted as a field end
348 $row->{$_} =~ s/"/""/g if $row->{$_};
354 if(defined $a->{publishercode} and defined $b->{publishercode}) {
355 $a->{publishercode} cmp $b->{publishercode};
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
376 sub GetBasketGroupAsCSV {
377 my ($basketgroupid, $cgi) = @_;
378 my $baskets = GetBasketsByBasketgroup($basketgroupid);
380 my $template = C4::Templates::gettemplate('acqui/csv/basketgroup.tt', 'intranet', $cgi);
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;
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},
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;
430 basketname author title publishercode collectiontitle notes
431 booksellername bookselleraddress booksellerpostal contractname
432 basketgroupdeliveryplace basketgroupbillingplace
433 basketdeliveryplace basketbillingplace
435 # Double the quotes to not be interpreted as a field end
436 $row->{$_} =~ s/"/""/g if $row->{$_};
441 $template->param(rows => \@rows);
443 return $template->output;
447 =head3 CloseBasketgroup
449 &CloseBasketgroup($basketgroupno);
455 sub CloseBasketgroup {
456 my ($basketgroupno) = @_;
457 my $dbh = C4::Context->dbh;
458 my $sth = $dbh->prepare("
459 UPDATE aqbasketgroups
463 $sth->execute($basketgroupno);
466 #------------------------------------------------------------#
468 =head3 ReOpenBaskergroup($basketgroupno)
470 &ReOpenBaskergroup($basketgroupno);
476 sub ReOpenBasketgroup {
477 my ($basketgroupno) = @_;
478 my $dbh = C4::Context->dbh;
479 my $sth = $dbh->prepare("
480 UPDATE aqbasketgroups
484 $sth->execute($basketgroupno);
487 #------------------------------------------------------------#
492 &DelBasket($basketno);
494 Deletes the basket that has basketno field $basketno in the aqbasket table.
498 =item C<$basketno> is the primary key of the basket in the aqbasket table.
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);
513 #------------------------------------------------------------#
517 &ModBasket($basketinfo);
519 Modifies a basket, using a hashref $basketinfo for the relevant information, only $basketinfo->{'basketno'} is required.
523 =item C<$basketno> is the primary key of the basket in the aqbasket table.
530 my $basketinfo = shift;
531 my $query = "UPDATE aqbasket SET ";
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 ', '){
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);
554 #------------------------------------------------------------#
556 =head3 ModBasketHeader
558 &ModBasketHeader($basketno, $basketname, $note, $booksellernote, $contractnumber, $booksellerid);
560 Modifies a basket's header.
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).
589 sub ModBasketHeader {
590 my ($basketno, $basketname, $note, $booksellernote, $contractnumber, $booksellerid, $deliveryplace, $billingplace, $is_standing, $create_items) = @_;
595 SET basketname=?, note=?, booksellernote=?, booksellerid=?, deliveryplace=?, billingplace=?, is_standing=?, create_items=?
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);
611 #------------------------------------------------------------#
613 =head3 GetBasketsByBookseller
615 @results = &GetBasketsByBookseller($booksellerid, $extra);
617 Returns a list of hashes of all the baskets that belong to bookseller 'booksellerid'.
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)
634 sub GetBasketsByBookseller {
635 my ($booksellerid, $extra) = @_;
636 my $query = "SELECT * FROM aqbasket WHERE booksellerid=?";
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
669 sub GetBasketsInfosByBookseller {
670 my ($supplierid, $allbaskets) = @_;
672 return unless $supplierid;
674 my $dbh = C4::Context->dbh;
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,
679 IF ( aqorders.orderstatus = 'cancelled', aqorders.quantity, 0 )
680 ) AS total_items_cancelled,
681 COUNT(DISTINCT aqorders.biblionumber) AS total_biblios,
683 IF(aqorders.datereceived IS NULL
684 AND (aqorders.datecancellationprinted IS NULL OR aqorders.datecancellationprinted='0000-00-00')
688 SUM( aqorders.uncertainprice ) AS uncertainprices
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 (
699 IF(aqorders.datereceived IS NULL
700 AND (aqorders.datecancellationprinted IS NULL OR aqorders.datecancellationprinted='0000-00-00')
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
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 );
720 $_->{total_biblios_cancelled} = $cancelled_biblios->{$_->{basketno}}{total_biblios_cancelled} || 0
726 =head3 GetBasketUsers
728 $basketusers_ids = &GetBasketUsers($basketno);
730 Returns a list of all borrowernumbers that are in basket users list
735 my $basketno = shift;
737 return unless $basketno;
740 SELECT borrowernumber
744 my $dbh = C4::Context->dbh;
745 my $sth = $dbh->prepare($query);
746 $sth->execute($basketno);
747 my $results = $sth->fetchall_arrayref( {} );
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>
768 my ($basketno, @basketusers_ids) = @_;
770 return unless $basketno;
772 my $dbh = C4::Context->dbh;
774 DELETE FROM aqbasketusers
777 my $sth = $dbh->prepare($query);
778 $sth->execute($basketno);
781 INSERT INTO aqbasketusers (basketno, borrowernumber)
784 $sth = $dbh->prepare($query);
785 foreach my $basketuser_id (@basketusers_ids) {
786 $sth->execute($basketno, $basketuser_id);
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,
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.
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;
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;
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}) {
852 if ( (ref $userflags->{acquisition} && !$userflags->{acquisition}->{order_manage})
853 || (!ref $userflags->{acquisition} && !$userflags->{acquisition}) ) {
857 if ($AcqViewBaskets eq 'user'
858 && $basket->{authorisedby} != $borrowernumber
859 && ! grep { $borrowernumber eq $_ } GetBasketUsers($basketno)) {
863 if ($AcqViewBaskets eq 'branch' && defined $basket->{branch}
864 && $basket->{branch} ne $borrower->{branchcode}) {
872 #------------------------------------------------------------#
874 =head3 GetBasketsByBasketgroup
876 $baskets = &GetBasketsByBasketgroup($basketgroupid);
878 Returns a reference to all baskets that belong to basketgroup $basketgroupid.
882 sub GetBasketsByBasketgroup {
883 my $basketgroupid = shift;
885 SELECT *, aqbasket.booksellerid as booksellerid
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.
922 my $basketgroupinfo = shift;
923 die "booksellerid is required to create a basketgroup" unless $basketgroupinfo->{'booksellerid'};
924 my $query = "INSERT INTO aqbasketgroups (";
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 (";
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.
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 ";
984 foreach my $field (qw(name billingplace deliveryplace freedeliveryplace deliverycomment closed)) {
985 if ( defined $basketgroupinfo->{$field} ) {
986 $query .= "$field=?, ";
987 push(@params, $basketgroupinfo->{$field});
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);
1009 #------------------------------------------------------------#
1011 =head3 DelBasketgroup
1013 DelBasketgroup($basketgroupid);
1015 Deletes a basketgroup in the aqbasketgroups table, and removes the reference to it from the baskets,
1019 =item C<$basketgroupid> is the 'id' field of the basket in the aqbasketgroup table
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);
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.
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=?',
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.
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
1086 @orders = &GetOrders( $basketno, { orderby => 'biblio.title', cancelled => 0|1 } );
1088 Looks up the pending (non-cancelled) orders with the given basket
1091 If cancelled is set, only cancelled orders will be returned.
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;
1105 SELECT biblio.*,biblioitems.*,
1109 $query .= $cancelled
1111 aqorders_transfers.ordernumber_to AS transferred_to,
1112 aqorders_transfers.timestamp AS transferred_to_timestamp
1115 aqorders_transfers.ordernumber_from AS transferred_from,
1116 aqorders_transfers.timestamp AS transferred_from_timestamp
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
1126 LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_from = aqorders.ordernumber
1129 LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_to = aqorders.ordernumber
1137 $orderby ||= q|biblioitems.publishercode, biblio.title|;
1139 AND (datecancellationprinted IS NOT NULL
1140 AND datecancellationprinted <> '0000-00-00')
1145 q|aqorders.datecancellationprinted desc, aqorders.timestamp desc|;
1147 AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')
1151 $query .= " ORDER BY $orderby";
1153 $dbh->selectall_arrayref( $query, { Slice => {} }, $basketno );
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.
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.
1173 sub GetOrdersByBiblionumber {
1174 my $biblionumber = shift;
1175 return unless $biblionumber;
1176 my $dbh = C4::Context->dbh;
1178 SELECT biblio.*,biblioitems.*,
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=?
1188 $dbh->selectall_arrayref( $query, { Slice => {} }, $biblionumber );
1189 return @{$result_set};
1193 #------------------------------------------------------------#
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.
1207 my ($ordernumber) = @_;
1208 return unless $ordernumber;
1210 my $dbh = C4::Context->dbh;
1211 my $query = qq{SELECT
1215 aqbasket.basketname,
1216 borrowers.branchcode,
1217 biblioitems.publicationyear,
1218 biblio.copyrightdate,
1219 biblioitems.editionstatement,
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
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.
1259 sub GetLastOrderNotReceivedFromSubscriptionid {
1260 my ( $subscriptionid ) = @_;
1261 my $dbh = C4::Context->dbh;
1263 SELECT * FROM aqorders
1264 LEFT JOIN subscription
1265 ON ( aqorders.subscriptionid = subscription.subscriptionid )
1266 WHERE aqorders.subscriptionid = ?
1267 AND aqorders.datereceived IS NULL
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.
1285 sub GetLastOrderReceivedFromSubscriptionid {
1286 my ( $subscriptionid ) = @_;
1287 my $dbh = C4::Context->dbh;
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 )
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
1306 $dbh->selectall_arrayref( $query, { Slice => {} }, $subscriptionid, $subscriptionid );
1308 # result_set assumed to contain 1 match
1309 return $result_set->[0];
1313 #------------------------------------------------------------#
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.
1327 my $orderinfo = shift;
1329 die "Ordernumber is required" if $orderinfo->{'ordernumber'} eq '';
1331 my $dbh = C4::Context->dbh;
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;");
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);
1362 #------------------------------------------------------------#
1366 ModItemOrder($itemnumber, $ordernumber);
1368 Modifies the ordernumber of an item in aqorders_items.
1373 my ($itemnumber, $ordernumber) = @_;
1375 return unless ($itemnumber and $ordernumber);
1377 my $dbh = C4::Context->dbh;
1379 UPDATE aqorders_items
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,
1395 quantityreceived => $quantityreceived,
1397 invoice => $invoice,
1398 budget_id => $budget_id,
1399 datereceived => $datereceived,
1400 received_itemnumbers => \@received_itemnumbers,
1404 Updates an order, to reflect the fact that it was received, at least
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}>.
1415 sub ModReceiveOrder {
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 $datereceived = $params->{datereceived};
1424 my $received_items = $params->{received_items};
1426 my $dbh = C4::Context->dbh;
1427 $datereceived = output_pref(
1429 dt => ( $datereceived ? dt_from_string( $datereceived ) : dt_from_string ),
1430 dateformat => 'iso',
1435 my $suggestionid = GetSuggestionFromBiblionumber( $biblionumber );
1436 if ($suggestionid) {
1437 ModSuggestion( {suggestionid=>$suggestionid,
1438 STATUS=>'AVAILABLE',
1439 biblionumber=> $biblionumber}
1443 my $result_set = $dbh->selectrow_arrayref(
1444 q{SELECT aqbasket.is_standing
1446 WHERE basketno=?},{ Slice => {} }, $order->{basketno});
1447 my $is_standing = $result_set->[0]; # we assume we have a unique basket
1449 my $new_ordernumber = $order->{ordernumber};
1450 if ( $is_standing || $order->{quantity} > $quantrec ) {
1451 # Split order line in two parts: the first is the original order line
1452 # without received items (the quantity is decreased),
1453 # the second part is a new order line with quantity=quantityrec
1454 # (entirely received)
1458 orderstatus = 'partial'|;
1459 $query .= q| WHERE ordernumber = ?|;
1460 my $sth = $dbh->prepare($query);
1463 ( $is_standing ? 1 : ($order->{quantity} - $quantrec) ),
1464 $order->{ordernumber}
1467 if ( not $order->{subscriptionid} && defined $order->{order_internalnote} ) {
1470 SET order_internalnote = ?
1471 WHERE ordernumber = ?|, {},
1472 $order->{order_internalnote}, $order->{ordernumber}
1476 # Recalculate tax_value
1480 tax_value_on_ordering = quantity * | . get_rounding_sql(q|ecost_tax_excluded|) . q| * tax_rate_on_ordering,
1481 tax_value_on_receiving = quantity * | . get_rounding_sql(q|unitprice_tax_excluded|) . q| * tax_rate_on_receiving
1482 WHERE ordernumber = ?
1483 |, undef, $order->{ordernumber});
1485 delete $order->{ordernumber};
1486 $order->{budget_id} = ( $budget_id || $order->{budget_id} );
1487 $order->{quantity} = $quantrec;
1488 $order->{quantityreceived} = $quantrec;
1489 $order->{ecost_tax_excluded} //= 0;
1490 $order->{tax_rate_on_ordering} //= 0;
1491 $order->{unitprice_tax_excluded} //= 0;
1492 $order->{tax_rate_on_receiving} //= 0;
1493 $order->{tax_value_on_ordering} = $order->{quantity} * get_rounded_price($order->{ecost_tax_excluded}) * $order->{tax_rate_on_ordering};
1494 $order->{tax_value_on_receiving} = $order->{quantity} * get_rounded_price($order->{unitprice_tax_excluded}) * $order->{tax_rate_on_receiving};
1495 $order->{datereceived} = $datereceived;
1496 $order->{invoiceid} = $invoice->{invoiceid};
1497 $order->{orderstatus} = 'complete';
1498 $new_ordernumber = Koha::Acquisition::Order->new($order)->store->ordernumber; # TODO What if the store fails?
1500 if ($received_items) {
1501 foreach my $itemnumber (@$received_items) {
1502 ModItemOrder($itemnumber, $new_ordernumber);
1508 SET quantityreceived = ?,
1512 orderstatus = 'complete'
1516 , replacementprice = ?
1517 | if defined $order->{replacementprice};
1520 , unitprice = ?, unitprice_tax_included = ?, unitprice_tax_excluded = ?
1521 | if defined $order->{unitprice};
1524 ,tax_value_on_receiving = ?
1525 | if defined $order->{tax_value_on_receiving};
1528 ,tax_rate_on_receiving = ?
1529 | if defined $order->{tax_rate_on_receiving};
1532 , order_internalnote = ?
1533 | if defined $order->{order_internalnote};
1535 $query .= q| where biblionumber=? and ordernumber=?|;
1537 my $sth = $dbh->prepare( $query );
1538 my @params = ( $quantrec, $datereceived, $invoice->{invoiceid}, ( $budget_id ? $budget_id : $order->{budget_id} ) );
1540 if ( defined $order->{replacementprice} ) {
1541 push @params, $order->{replacementprice};
1544 if ( defined $order->{unitprice} ) {
1545 push @params, $order->{unitprice}, $order->{unitprice_tax_included}, $order->{unitprice_tax_excluded};
1548 if ( defined $order->{tax_value_on_receiving} ) {
1549 push @params, $order->{tax_value_on_receiving};
1552 if ( defined $order->{tax_rate_on_receiving} ) {
1553 push @params, $order->{tax_rate_on_receiving};
1556 if ( defined $order->{order_internalnote} ) {
1557 push @params, $order->{order_internalnote};
1560 push @params, ( $biblionumber, $order->{ordernumber} );
1562 $sth->execute( @params );
1564 # All items have been received, sent a notification to users
1565 NotifyOrderUsers( $order->{ordernumber} );
1568 return ($datereceived, $new_ordernumber);
1571 =head3 CancelReceipt
1573 my $parent_ordernumber = CancelReceipt($ordernumber);
1575 Cancel an order line receipt and update the parent order line, as if no
1577 If items are created at receipt (AcqCreateItem = receiving) then delete
1583 my $ordernumber = shift;
1585 return unless $ordernumber;
1587 my $dbh = C4::Context->dbh;
1589 SELECT datereceived, parent_ordernumber, quantity
1591 WHERE ordernumber = ?
1593 my $sth = $dbh->prepare($query);
1594 $sth->execute($ordernumber);
1595 my $order = $sth->fetchrow_hashref;
1597 warn "CancelReceipt: order $ordernumber does not exist";
1600 unless($order->{'datereceived'}) {
1601 warn "CancelReceipt: order $ordernumber is not received";
1605 my $parent_ordernumber = $order->{'parent_ordernumber'};
1607 my $order_obj = Koha::Acquisition::Orders->find( $ordernumber ); # FIXME rewrite all this subroutine using this object
1608 my @itemnumbers = $order_obj->items->get_column('itemnumber');
1610 if($parent_ordernumber == $ordernumber || not $parent_ordernumber) {
1611 # The order line has no parent, just mark it as not received
1614 SET quantityreceived = ?,
1617 orderstatus = 'ordered'
1618 WHERE ordernumber = ?
1620 $sth = $dbh->prepare($query);
1621 $sth->execute(0, undef, undef, $ordernumber);
1622 _cancel_items_receipt( $order_obj );
1624 # The order line has a parent, increase parent quantity and delete
1627 SELECT quantity, datereceived
1629 WHERE ordernumber = ?
1631 $sth = $dbh->prepare($query);
1632 $sth->execute($parent_ordernumber);
1633 my $parent_order = $sth->fetchrow_hashref;
1634 unless($parent_order) {
1635 warn "Parent order $parent_ordernumber does not exist.";
1638 if($parent_order->{'datereceived'}) {
1639 warn "CancelReceipt: parent order is received.".
1640 " Can't cancel receipt.";
1646 orderstatus = 'ordered'
1647 WHERE ordernumber = ?
1649 $sth = $dbh->prepare($query);
1650 my $rv = $sth->execute(
1651 $order->{'quantity'} + $parent_order->{'quantity'},
1655 warn "Cannot update parent order line, so do not cancel".
1660 # Recalculate tax_value
1664 tax_value_on_ordering = quantity * | . get_rounding_sql(q|ecost_tax_excluded|) . q| * tax_rate_on_ordering,
1665 tax_value_on_receiving = quantity * | . get_rounding_sql(q|unitprice_tax_excluded|) . q| * tax_rate_on_receiving
1666 WHERE ordernumber = ?
1667 |, undef, $parent_ordernumber);
1669 _cancel_items_receipt( $order_obj, $parent_ordernumber );
1672 DELETE FROM aqorders
1673 WHERE ordernumber = ?
1675 $sth = $dbh->prepare($query);
1676 $sth->execute($ordernumber);
1680 if( $order_obj->basket->effective_create_items eq 'ordering' ) {
1681 my @affects = split q{\|}, C4::Context->preference("AcqItemSetSubfieldsWhenReceiptIsCancelled");
1683 for my $in ( @itemnumbers ) {
1684 my $item = Koha::Items->find( $in ); # FIXME We do not need that, we already have Koha::Items from $order_obj->items
1685 my $biblio = $item->biblio;
1686 my ( $itemfield ) = GetMarcFromKohaField( 'items.itemnumber', $biblio->frameworkcode );
1687 my $item_marc = C4::Items::GetMarcItem( $biblio->biblionumber, $in );
1688 for my $affect ( @affects ) {
1689 my ( $sf, $v ) = split q{=}, $affect, 2;
1690 foreach ( $item_marc->field($itemfield) ) {
1691 $_->update( $sf => $v );
1694 C4::Items::ModItemFromMarc( $item_marc, $biblio->biblionumber, $in );
1699 return $parent_ordernumber;
1702 sub _cancel_items_receipt {
1703 my ( $order, $parent_ordernumber ) = @_;
1704 $parent_ordernumber ||= $order->ordernumber;
1706 my $items = $order->items;
1707 if ( $order->basket->effective_create_items eq 'receiving' ) {
1708 # Remove items that were created at receipt
1710 DELETE FROM items, aqorders_items
1711 USING items, aqorders_items
1712 WHERE items.itemnumber = ? AND aqorders_items.itemnumber = ?
1714 my $dbh = C4::Context->dbh;
1715 my $sth = $dbh->prepare($query);
1716 while ( my $item = $items->next ) {
1717 $sth->execute($item->itemnumber, $item->itemnumber);
1721 while ( my $item = $items->next ) {
1722 ModItemOrder($item->itemnumber, $parent_ordernumber);
1727 #------------------------------------------------------------#
1731 @results = &SearchOrders({
1732 ordernumber => $ordernumber,
1735 booksellerid => $booksellerid,
1736 basketno => $basketno,
1737 basketname => $basketname,
1738 basketgroupname => $basketgroupname,
1742 biblionumber => $biblionumber,
1743 budget_id => $budget_id
1746 Searches for orders filtered by criteria.
1748 C<$ordernumber> Finds matching orders or transferred orders by ordernumber.
1749 C<$search> Finds orders matching %$search% in title, author, or isbn.
1750 C<$owner> Finds order for the logged in user.
1751 C<$pending> Finds pending orders. Ignores completed and cancelled orders.
1752 C<$ordered> Finds orders to receive only (status 'ordered' or 'partial').
1755 C<@results> is an array of references-to-hash with the keys are fields
1756 from aqorders, biblio, biblioitems and aqbasket tables.
1761 my ( $params ) = @_;
1762 my $ordernumber = $params->{ordernumber};
1763 my $search = $params->{search};
1764 my $ean = $params->{ean};
1765 my $booksellerid = $params->{booksellerid};
1766 my $basketno = $params->{basketno};
1767 my $basketname = $params->{basketname};
1768 my $basketgroupname = $params->{basketgroupname};
1769 my $owner = $params->{owner};
1770 my $pending = $params->{pending};
1771 my $ordered = $params->{ordered};
1772 my $biblionumber = $params->{biblionumber};
1773 my $budget_id = $params->{budget_id};
1775 my $dbh = C4::Context->dbh;
1778 SELECT aqbasket.basketno,
1780 borrowers.firstname,
1783 biblioitems.biblioitemnumber,
1784 biblioitems.publishercode,
1785 biblioitems.publicationyear,
1786 aqbasket.authorisedby,
1787 aqbasket.booksellerid,
1789 aqbasket.creationdate,
1790 aqbasket.basketname,
1791 aqbasketgroups.id as basketgroupid,
1792 aqbasketgroups.name as basketgroupname,
1795 LEFT JOIN aqbasket ON aqorders.basketno = aqbasket.basketno
1796 LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid = aqbasketgroups.id
1797 LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
1798 LEFT JOIN biblio ON aqorders.biblionumber=biblio.biblionumber
1799 LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
1802 # If we search on ordernumber, we retrieve the transferred order if a transfer has been done.
1804 LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_to = aqorders.ordernumber
1808 WHERE (datecancellationprinted is NULL)
1811 if ( $pending or $ordered ) {
1814 ( aqbasket.is_standing AND aqorders.orderstatus IN ( "new", "ordered", "partial" ) )
1816 ( quantity > quantityreceived OR quantityreceived is NULL )
1820 $query .= q{ AND aqorders.orderstatus IN ( "ordered", "partial" )};
1828 my $userenv = C4::Context->userenv;
1829 if ( C4::Context->preference("IndependentBranches") ) {
1830 unless ( C4::Context->IsSuperLibrarian() ) {
1833 borrowers.branchcode = ?
1834 OR borrowers.branchcode = ''
1837 push @args, $userenv->{branch};
1841 if ( $ordernumber ) {
1842 $query .= ' AND ( aqorders.ordernumber = ? OR aqorders_transfers.ordernumber_from = ? ) ';
1843 push @args, ( $ordernumber, $ordernumber );
1845 if ( $biblionumber ) {
1846 $query .= 'AND aqorders.biblionumber = ?';
1847 push @args, $biblionumber;
1850 $query .= ' AND (biblio.title LIKE ? OR biblio.author LIKE ? OR biblioitems.isbn LIKE ?)';
1851 push @args, ("%$search%","%$search%","%$search%");
1854 $query .= ' AND biblioitems.ean = ?';
1857 if ( $booksellerid ) {
1858 $query .= 'AND aqbasket.booksellerid = ?';
1859 push @args, $booksellerid;
1862 $query .= 'AND aqbasket.basketno = ?';
1863 push @args, $basketno;
1866 $query .= 'AND aqbasket.basketname LIKE ?';
1867 push @args, "%$basketname%";
1869 if( $basketgroupname ) {
1870 $query .= ' AND aqbasketgroups.name LIKE ?';
1871 push @args, "%$basketgroupname%";
1875 $query .= ' AND aqbasket.authorisedby=? ';
1876 push @args, $userenv->{'number'};
1880 $query .= ' AND aqorders.budget_id = ?';
1881 push @args, $budget_id;
1884 $query .= ' ORDER BY aqbasket.basketno';
1886 my $sth = $dbh->prepare($query);
1887 $sth->execute(@args);
1888 return $sth->fetchall_arrayref({});
1891 #------------------------------------------------------------#
1895 &DelOrder($biblionumber, $ordernumber);
1897 Cancel the order with the given order and biblio numbers. It does not
1898 delete any entries in the aqorders table, it merely marks them as
1904 my ( $bibnum, $ordernumber, $delete_biblio, $reason ) = @_;
1906 my $dbh = C4::Context->dbh;
1909 SET datecancellationprinted=now(), orderstatus='cancelled'
1912 $query .= ", cancellationreason = ? ";
1915 WHERE biblionumber=? AND ordernumber=?
1917 my $sth = $dbh->prepare($query);
1919 $sth->execute($reason, $bibnum, $ordernumber);
1921 $sth->execute( $bibnum, $ordernumber );
1925 my $order = Koha::Acquisition::Orders->find($ordernumber);
1926 my $items = $order->items;
1927 while ( my $item = $items->next ) { # Should be moved to Koha::Acquisition::Order->delete
1928 my $delcheck = C4::Items::DelItemCheck( $bibnum, $item->itemnumber );
1930 if($delcheck != 1) {
1931 $error->{'delitem'} = 1;
1935 if($delete_biblio) {
1936 # We get the number of remaining items
1937 my $biblio = Koha::Biblios->find( $bibnum );
1938 my $itemcount = $biblio->items->count;
1940 # If there are no items left,
1941 if ( $itemcount == 0 ) {
1942 # We delete the record
1943 my $delcheck = DelBiblio($bibnum);
1946 $error->{'delbiblio'} = 1;
1954 =head3 TransferOrder
1956 my $newordernumber = TransferOrder($ordernumber, $basketno);
1958 Transfer an order line to a basket.
1959 Mark $ordernumber as cancelled with an internal note 'Cancelled and transferred
1960 to BOOKSELLER on DATE' and create new order with internal note
1961 'Transferred from BOOKSELLER on DATE'.
1962 Move all attached items to the new order.
1963 Received orders cannot be transferred.
1964 Return the ordernumber of created order.
1969 my ($ordernumber, $basketno) = @_;
1971 return unless ($ordernumber and $basketno);
1973 my $order = Koha::Acquisition::Orders->find( $ordernumber ) or return;
1974 return if $order->datereceived;
1976 $order = $order->unblessed;
1978 my $basket = GetBasket($basketno);
1979 return unless $basket;
1981 my $dbh = C4::Context->dbh;
1982 my ($query, $sth, $rv);
1986 SET datecancellationprinted = CAST(NOW() AS date), orderstatus = ?
1987 WHERE ordernumber = ?
1989 $sth = $dbh->prepare($query);
1990 $rv = $sth->execute('cancelled', $ordernumber);
1992 delete $order->{'ordernumber'};
1993 delete $order->{parent_ordernumber};
1994 $order->{'basketno'} = $basketno;
1996 my $newordernumber = Koha::Acquisition::Order->new($order)->store->ordernumber;
1999 UPDATE aqorders_items
2001 WHERE ordernumber = ?
2003 $sth = $dbh->prepare($query);
2004 $sth->execute($newordernumber, $ordernumber);
2007 INSERT INTO aqorders_transfers (ordernumber_from, ordernumber_to)
2010 $sth = $dbh->prepare($query);
2011 $sth->execute($ordernumber, $newordernumber);
2013 return $newordernumber;
2016 =head3 get_rounding_sql
2018 $rounding_sql = get_rounding_sql($column_name);
2020 returns the correct SQL routine based on OrderPriceRounding system preference.
2024 sub get_rounding_sql {
2025 my ( $round_string ) = @_;
2026 my $rounding_pref = C4::Context->preference('OrderPriceRounding') // q{};
2027 if ( $rounding_pref eq "nearest_cent" ) {
2028 return "CAST($round_string*100 AS SIGNED)/100";
2030 return $round_string;
2033 =head3 get_rounded_price
2035 $rounded_price = get_rounded_price( $price );
2037 returns a price rounded as specified in OrderPriceRounding system preference.
2041 sub get_rounded_price {
2043 my $rounding_pref = C4::Context->preference('OrderPriceRounding') // q{};
2044 if( $rounding_pref eq 'nearest_cent' ) {
2045 return Koha::Number::Price->new( $price )->round();
2051 =head2 FUNCTIONS ABOUT PARCELS
2055 $results = &GetParcels($bookseller, $order, $code, $datefrom, $dateto);
2057 get a lists of parcels.
2064 is the bookseller this function has to get parcels.
2067 To know on what criteria the results list has to be ordered.
2070 is the booksellerinvoicenumber.
2072 =item $datefrom & $dateto
2073 to know on what date this function has to filter its search.
2078 a pointer on a hash list containing parcel informations as such :
2084 =item Last operation
2086 =item Number of biblio
2088 =item Number of items
2095 my ($bookseller,$order, $code, $datefrom, $dateto) = @_;
2096 my $dbh = C4::Context->dbh;
2097 my @query_params = ();
2099 SELECT aqinvoices.invoicenumber,
2100 datereceived,purchaseordernumber,
2101 count(DISTINCT biblionumber) AS biblio,
2102 sum(quantity) AS itemsexpected,
2103 sum(quantityreceived) AS itemsreceived
2104 FROM aqorders LEFT JOIN aqbasket ON aqbasket.basketno = aqorders.basketno
2105 LEFT JOIN aqinvoices ON aqorders.invoiceid = aqinvoices.invoiceid
2106 WHERE aqbasket.booksellerid = ? and datereceived IS NOT NULL
2108 push @query_params, $bookseller;
2110 if ( defined $code ) {
2111 $strsth .= ' and aqinvoices.invoicenumber like ? ';
2112 # add a % to the end of the code to allow stemming.
2113 push @query_params, "$code%";
2116 if ( defined $datefrom ) {
2117 $strsth .= ' and datereceived >= ? ';
2118 push @query_params, $datefrom;
2121 if ( defined $dateto ) {
2122 $strsth .= 'and datereceived <= ? ';
2123 push @query_params, $dateto;
2126 $strsth .= "group by aqinvoices.invoicenumber,datereceived ";
2128 # can't use a placeholder to place this column name.
2129 # but, we could probably be checking to make sure it is a column that will be fetched.
2130 $strsth .= "order by $order " if ($order);
2132 my $sth = $dbh->prepare($strsth);
2134 $sth->execute( @query_params );
2135 my $results = $sth->fetchall_arrayref({});
2139 #------------------------------------------------------------#
2141 =head3 GetLateOrders
2143 @results = &GetLateOrders;
2145 Searches for bookseller with late orders.
2148 the table of supplier with late issues. This table is full of hashref.
2154 my $supplierid = shift;
2156 my $estimateddeliverydatefrom = shift;
2157 my $estimateddeliverydateto = shift;
2159 my $dbh = C4::Context->dbh;
2161 #BEWARE, order of parenthesis and LEFT JOIN is important for speed
2162 my $dbdriver = C4::Context->config("db_scheme") || "mysql";
2164 my @query_params = ();
2166 SELECT aqbasket.basketno,
2167 aqorders.ordernumber,
2168 DATE(aqbasket.closedate) AS orderdate,
2169 aqbasket.basketname AS basketname,
2170 aqbasket.basketgroupid AS basketgroupid,
2171 aqbasketgroups.name AS basketgroupname,
2172 aqorders.rrp AS unitpricesupplier,
2173 aqorders.ecost AS unitpricelib,
2174 aqorders.claims_count AS claims_count,
2175 aqorders.claimed_date AS claimed_date,
2176 aqbudgets.budget_name AS budget,
2177 borrowers.branchcode AS branch,
2178 aqbooksellers.name AS supplier,
2179 aqbooksellers.id AS supplierid,
2180 biblio.author, biblio.title,
2181 biblioitems.publishercode AS publisher,
2182 biblioitems.publicationyear,
2183 ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) AS estimateddeliverydate,
2187 aqorders LEFT JOIN biblio ON biblio.biblionumber = aqorders.biblionumber
2188 LEFT JOIN biblioitems ON biblioitems.biblionumber = biblio.biblionumber
2189 LEFT JOIN aqbudgets ON aqorders.budget_id = aqbudgets.budget_id,
2190 aqbasket LEFT JOIN borrowers ON aqbasket.authorisedby = borrowers.borrowernumber
2191 LEFT JOIN aqbooksellers ON aqbasket.booksellerid = aqbooksellers.id
2192 LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid = aqbasketgroups.id
2193 WHERE aqorders.basketno = aqbasket.basketno
2194 AND ( datereceived = ''
2195 OR datereceived IS NULL
2196 OR aqorders.quantityreceived < aqorders.quantity
2198 AND aqbasket.closedate IS NOT NULL
2199 AND (aqorders.datecancellationprinted IS NULL OR aqorders.datecancellationprinted='0000-00-00')
2201 if ($dbdriver eq "mysql") {
2203 aqorders.quantity - COALESCE(aqorders.quantityreceived,0) AS quantity,
2204 (aqorders.quantity - COALESCE(aqorders.quantityreceived,0)) * aqorders.rrp AS subtotal,
2205 DATEDIFF(CAST(now() AS date),closedate) AS latesince
2207 if ( defined $delay ) {
2208 $from .= " AND (closedate <= DATE_SUB(CAST(now() AS date),INTERVAL ? DAY)) " ;
2209 push @query_params, $delay;
2211 $from .= " AND aqorders.quantity - COALESCE(aqorders.quantityreceived,0) <> 0";
2213 # FIXME: account for IFNULL as above
2215 aqorders.quantity AS quantity,
2216 aqorders.quantity * aqorders.rrp AS subtotal,
2217 (CAST(now() AS date) - closedate) AS latesince
2219 if ( defined $delay ) {
2220 $from .= " AND (closedate <= (CAST(now() AS date) -(INTERVAL ? DAY)) ";
2221 push @query_params, $delay;
2223 $from .= " AND aqorders.quantity <> 0";
2225 if (defined $supplierid) {
2226 $from .= ' AND aqbasket.booksellerid = ? ';
2227 push @query_params, $supplierid;
2229 if (defined $branch) {
2230 $from .= ' AND borrowers.branchcode LIKE ? ';
2231 push @query_params, $branch;
2234 if ( defined $estimateddeliverydatefrom or defined $estimateddeliverydateto ) {
2235 $from .= ' AND aqbooksellers.deliverytime IS NOT NULL ';
2237 if ( defined $estimateddeliverydatefrom ) {
2238 $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) >= ?';
2239 push @query_params, $estimateddeliverydatefrom;
2241 if ( defined $estimateddeliverydateto ) {
2242 $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) <= ?';
2243 push @query_params, $estimateddeliverydateto;
2245 if ( defined $estimateddeliverydatefrom and not defined $estimateddeliverydateto ) {
2246 $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) <= CAST(now() AS date)';
2248 if (C4::Context->preference("IndependentBranches")
2249 && !C4::Context->IsSuperLibrarian() ) {
2250 $from .= ' AND borrowers.branchcode LIKE ? ';
2251 push @query_params, C4::Context->userenv->{branch};
2253 $from .= " AND orderstatus <> 'cancelled' ";
2254 my $query = "$select $from \nORDER BY latesince, basketno, borrowers.branchcode, supplier";
2255 $debug and print STDERR "GetLateOrders query: $query\nGetLateOrders args: " . join(" ",@query_params);
2256 my $sth = $dbh->prepare($query);
2257 $sth->execute(@query_params);
2259 while (my $data = $sth->fetchrow_hashref) {
2260 push @results, $data;
2265 #------------------------------------------------------------#
2269 \@order_loop = GetHistory( %params );
2271 Retreives some acquisition history information
2281 basket - search both basket name and number
2282 booksellerinvoicenumber
2285 orderstatus (note that orderstatus '' will retrieve orders
2286 of any status except cancelled)
2288 get_canceled_order (if set to a true value, cancelled orders will
2292 $order_loop is a list of hashrefs that each look like this:
2294 'author' => 'Twain, Mark',
2296 'biblionumber' => '215',
2298 'creationdate' => 'MM/DD/YYYY',
2299 'datereceived' => undef,
2302 'invoicenumber' => undef,
2304 'ordernumber' => '1',
2306 'quantityreceived' => undef,
2307 'title' => 'The Adventures of Huckleberry Finn'
2313 # don't run the query if there are no parameters (list would be too long for sure !)
2314 croak "No search params" unless @_;
2316 my $title = $params{title};
2317 my $author = $params{author};
2318 my $isbn = $params{isbn};
2319 my $ean = $params{ean};
2320 my $name = $params{name};
2321 my $from_placed_on = $params{from_placed_on};
2322 my $to_placed_on = $params{to_placed_on};
2323 my $basket = $params{basket};
2324 my $booksellerinvoicenumber = $params{booksellerinvoicenumber};
2325 my $basketgroupname = $params{basketgroupname};
2326 my $budget = $params{budget};
2327 my $orderstatus = $params{orderstatus};
2328 my $biblionumber = $params{biblionumber};
2329 my $get_canceled_order = $params{get_canceled_order} || 0;
2330 my $ordernumber = $params{ordernumber};
2331 my $search_children_too = $params{search_children_too} || 0;
2332 my $created_by = $params{created_by} || [];
2333 my $ordernumbers = $params{ordernumbers} || [];
2334 my $additional_fields = $params{additional_fields} // [];
2338 my $total_qtyreceived = 0;
2339 my $total_price = 0;
2341 #get variation of isbn
2345 if ( C4::Context->preference("SearchWithISBNVariations") ){
2346 @isbns = C4::Koha::GetVariationsOfISBN( $isbn );
2347 foreach my $isb (@isbns){
2348 push @isbn_params, '?';
2353 push @isbn_params, '?';
2357 my $dbh = C4::Context->dbh;
2360 COALESCE(biblio.title, deletedbiblio.title) AS title,
2361 COALESCE(biblio.author, deletedbiblio.author) AS author,
2362 COALESCE(biblioitems.isbn, deletedbiblioitems.isbn) AS isbn,
2363 COALESCE(biblioitems.ean, deletedbiblioitems.ean) AS ean,
2365 aqbasket.basketname,
2366 aqbasket.basketgroupid,
2367 aqbasket.authorisedby,
2368 concat( borrowers.firstname,' ',borrowers.surname) AS authorisedbyname,
2369 aqbasketgroups.name as groupname,
2371 aqbasket.creationdate,
2372 aqorders.datereceived,
2374 aqorders.quantityreceived,
2376 aqorders.ordernumber,
2378 aqinvoices.invoicenumber,
2379 aqbooksellers.id as id,
2380 aqorders.biblionumber,
2381 aqorders.orderstatus,
2382 aqorders.parent_ordernumber,
2383 aqbudgets.budget_name
2385 $query .= ", aqbudgets.budget_id AS budget" if defined $budget;
2388 LEFT JOIN aqbasket ON aqorders.basketno=aqbasket.basketno
2389 LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid=aqbasketgroups.id
2390 LEFT JOIN aqbooksellers ON aqbasket.booksellerid=aqbooksellers.id
2391 LEFT JOIN biblioitems ON biblioitems.biblionumber=aqorders.biblionumber
2392 LEFT JOIN biblio ON biblio.biblionumber=aqorders.biblionumber
2393 LEFT JOIN aqbudgets ON aqorders.budget_id=aqbudgets.budget_id
2394 LEFT JOIN aqinvoices ON aqorders.invoiceid = aqinvoices.invoiceid
2395 LEFT JOIN deletedbiblio ON deletedbiblio.biblionumber=aqorders.biblionumber
2396 LEFT JOIN deletedbiblioitems ON deletedbiblioitems.biblionumber=aqorders.biblionumber
2397 LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
2400 $query .= " WHERE 1 ";
2402 unless ($get_canceled_order or (defined $orderstatus and $orderstatus eq 'cancelled')) {
2403 $query .= " AND (datecancellationprinted is NULL or datecancellationprinted='0000-00-00') ";
2406 my @query_params = ();
2408 if ( $biblionumber ) {
2409 $query .= " AND biblio.biblionumber = ?";
2410 push @query_params, $biblionumber;
2414 $query .= " AND biblio.title LIKE ? ";
2415 $title =~ s/\s+/%/g;
2416 push @query_params, "%$title%";
2420 $query .= " AND biblio.author LIKE ? ";
2421 push @query_params, "%$author%";
2425 $query .= " AND ( biblioitems.isbn LIKE " . join (" OR biblioitems.isbn LIKE ", @isbn_params ) . ")";
2426 foreach my $isb (@isbns){
2427 push @query_params, "%$isb%";
2432 $query .= " AND biblioitems.ean = ? ";
2433 push @query_params, "$ean";
2436 $query .= " AND aqbooksellers.name LIKE ? ";
2437 push @query_params, "%$name%";
2441 $query .= " AND aqbudgets.budget_id = ? ";
2442 push @query_params, "$budget";
2445 if ( $from_placed_on ) {
2446 $query .= " AND creationdate >= ? ";
2447 push @query_params, $from_placed_on;
2450 if ( $to_placed_on ) {
2451 $query .= " AND creationdate <= ? ";
2452 push @query_params, $to_placed_on;
2455 if ( defined $orderstatus and $orderstatus ne '') {
2456 $query .= " AND aqorders.orderstatus = ? ";
2457 push @query_params, "$orderstatus";
2461 if ($basket =~ m/^\d+$/) {
2462 $query .= " AND aqorders.basketno = ? ";
2463 push @query_params, $basket;
2465 $query .= " AND aqbasket.basketname LIKE ? ";
2466 push @query_params, "%$basket%";
2470 if ($booksellerinvoicenumber) {
2471 $query .= " AND aqinvoices.invoicenumber LIKE ? ";
2472 push @query_params, "%$booksellerinvoicenumber%";
2475 if ($basketgroupname) {
2476 $query .= " AND aqbasketgroups.name LIKE ? ";
2477 push @query_params, "%$basketgroupname%";
2481 $query .= " AND (aqorders.ordernumber = ? ";
2482 push @query_params, $ordernumber;
2483 if ($search_children_too) {
2484 $query .= " OR aqorders.parent_ordernumber = ? ";
2485 push @query_params, $ordernumber;
2490 if ( @$created_by ) {
2491 $query .= ' AND aqbasket.authorisedby IN ( ' . join( ',', ('?') x @$created_by ) . ')';
2492 push @query_params, @$created_by;
2495 if ( @$ordernumbers ) {
2496 $query .= ' AND (aqorders.ordernumber IN ( ' . join (',', ('?') x @$ordernumbers ) . '))';
2497 push @query_params, @$ordernumbers;
2499 if ( @$additional_fields ) {
2500 my @baskets = Koha::Acquisition::Baskets->filter_by_additional_fields($additional_fields);
2502 return [] unless @baskets;
2504 # No parameterization because record IDs come directly from DB
2505 $query .= ' AND aqbasket.basketno IN ( ' . join( ',', map { $_->basketno } @baskets ) . ' )';
2508 if ( C4::Context->preference("IndependentBranches") ) {
2509 unless ( C4::Context->IsSuperLibrarian() ) {
2510 $query .= " AND (borrowers.branchcode = ? OR borrowers.branchcode ='' ) ";
2511 push @query_params, C4::Context->userenv->{branch};
2514 $query .= " ORDER BY id";
2516 return $dbh->selectall_arrayref( $query, { Slice => {} }, @query_params );
2519 =head2 GetRecentAcqui
2521 $results = GetRecentAcqui($days);
2523 C<$results> is a ref to a table which contains hashref
2527 sub GetRecentAcqui {
2529 my $dbh = C4::Context->dbh;
2533 ORDER BY timestamp DESC
2536 my $sth = $dbh->prepare($query);
2538 my $results = $sth->fetchall_arrayref({});
2542 #------------------------------------------------------------#
2546 &AddClaim($ordernumber);
2548 Add a claim for an order
2553 my ($ordernumber) = @_;
2554 my $dbh = C4::Context->dbh;
2557 claims_count = claims_count + 1,
2558 claimed_date = CURDATE()
2559 WHERE ordernumber = ?
2561 my $sth = $dbh->prepare($query);
2562 $sth->execute($ordernumber);
2567 my @invoices = GetInvoices(
2568 invoicenumber => $invoicenumber,
2569 supplierid => $supplierid,
2570 suppliername => $suppliername,
2571 shipmentdatefrom => $shipmentdatefrom, # ISO format
2572 shipmentdateto => $shipmentdateto, # ISO format
2573 billingdatefrom => $billingdatefrom, # ISO format
2574 billingdateto => $billingdateto, # ISO format
2575 isbneanissn => $isbn_or_ean_or_issn,
2578 publisher => $publisher,
2579 publicationyear => $publicationyear,
2580 branchcode => $branchcode,
2581 order_by => $order_by
2584 Return a list of invoices that match all given criteria.
2586 $order_by is "column_name (asc|desc)", where column_name is any of
2587 'invoicenumber', 'booksellerid', 'shipmentdate', 'billingdate', 'closedate',
2588 'shipmentcost', 'shipmentcost_budgetid'.
2590 asc is the default if omitted
2597 my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2598 closedate shipmentcost shipmentcost_budgetid);
2600 my $dbh = C4::Context->dbh;
2602 SELECT aqinvoices.invoiceid, aqinvoices.invoicenumber, aqinvoices.booksellerid, aqinvoices.shipmentdate, aqinvoices.billingdate, aqinvoices.closedate, aqinvoices.shipmentcost, aqinvoices.shipmentcost_budgetid, aqinvoices.message_id,
2603 aqbooksellers.name AS suppliername,
2606 aqorders.datereceived IS NOT NULL,
2607 aqorders.biblionumber,
2610 ) AS receivedbiblios,
2613 aqorders.subscriptionid IS NOT NULL,
2614 aqorders.subscriptionid,
2617 ) AS is_linked_to_subscriptions,
2618 SUM(aqorders.quantityreceived) AS receiveditems
2620 LEFT JOIN aqbooksellers ON aqbooksellers.id = aqinvoices.booksellerid
2621 LEFT JOIN aqorders ON aqorders.invoiceid = aqinvoices.invoiceid
2622 LEFT JOIN aqbasket ON aqbasket.basketno=aqorders.basketno
2623 LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
2624 LEFT JOIN biblio ON aqorders.biblionumber = biblio.biblionumber
2625 LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
2626 LEFT JOIN subscription ON biblio.biblionumber = subscription.biblionumber
2631 if($args{supplierid}) {
2632 push @bind_strs, " aqinvoices.booksellerid = ? ";
2633 push @bind_args, $args{supplierid};
2635 if($args{invoicenumber}) {
2636 push @bind_strs, " aqinvoices.invoicenumber LIKE ? ";
2637 push @bind_args, "%$args{invoicenumber}%";
2639 if($args{suppliername}) {
2640 push @bind_strs, " aqbooksellers.name LIKE ? ";
2641 push @bind_args, "%$args{suppliername}%";
2643 if($args{shipmentdatefrom}) {
2644 push @bind_strs, " aqinvoices.shipmentdate >= ? ";
2645 push @bind_args, $args{shipmentdatefrom};
2647 if($args{shipmentdateto}) {
2648 push @bind_strs, " aqinvoices.shipmentdate <= ? ";
2649 push @bind_args, $args{shipmentdateto};
2651 if($args{billingdatefrom}) {
2652 push @bind_strs, " aqinvoices.billingdate >= ? ";
2653 push @bind_args, $args{billingdatefrom};
2655 if($args{billingdateto}) {
2656 push @bind_strs, " aqinvoices.billingdate <= ? ";
2657 push @bind_args, $args{billingdateto};
2659 if($args{isbneanissn}) {
2660 push @bind_strs, " (biblioitems.isbn LIKE CONCAT('%', ?, '%') OR biblioitems.ean LIKE CONCAT('%', ?, '%') OR biblioitems.issn LIKE CONCAT('%', ?, '%') ) ";
2661 push @bind_args, $args{isbneanissn}, $args{isbneanissn}, $args{isbneanissn};
2664 push @bind_strs, " biblio.title LIKE CONCAT('%', ?, '%') ";
2665 push @bind_args, $args{title};
2668 push @bind_strs, " biblio.author LIKE CONCAT('%', ?, '%') ";
2669 push @bind_args, $args{author};
2671 if($args{publisher}) {
2672 push @bind_strs, " biblioitems.publishercode LIKE CONCAT('%', ?, '%') ";
2673 push @bind_args, $args{publisher};
2675 if($args{publicationyear}) {
2676 push @bind_strs, " ((biblioitems.publicationyear LIKE CONCAT('%', ?, '%')) OR (biblio.copyrightdate LIKE CONCAT('%', ?, '%'))) ";
2677 push @bind_args, $args{publicationyear}, $args{publicationyear};
2679 if($args{branchcode}) {
2680 push @bind_strs, " borrowers.branchcode = ? ";
2681 push @bind_args, $args{branchcode};
2683 if($args{message_id}) {
2684 push @bind_strs, " aqinvoices.message_id = ? ";
2685 push @bind_args, $args{message_id};
2688 $query .= " WHERE " . join(" AND ", @bind_strs) if @bind_strs;
2689 $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";
2691 if($args{order_by}) {
2692 my ($column, $direction) = split / /, $args{order_by};
2693 if(grep /^$column$/, @columns) {
2694 $direction ||= 'ASC';
2695 $query .= " ORDER BY $column $direction";
2699 my $sth = $dbh->prepare($query);
2700 $sth->execute(@bind_args);
2702 my $results = $sth->fetchall_arrayref({});
2708 my $invoice = GetInvoice($invoiceid);
2710 Get informations about invoice with given $invoiceid
2712 Return a hash filled with aqinvoices.* fields
2717 my ($invoiceid) = @_;
2720 return unless $invoiceid;
2722 my $dbh = C4::Context->dbh;
2728 my $sth = $dbh->prepare($query);
2729 $sth->execute($invoiceid);
2731 $invoice = $sth->fetchrow_hashref;
2735 =head3 GetInvoiceDetails
2737 my $invoice = GetInvoiceDetails($invoiceid)
2739 Return informations about an invoice + the list of related order lines
2741 Orders informations are in $invoice->{orders} (array ref)
2745 sub GetInvoiceDetails {
2746 my ($invoiceid) = @_;
2748 if ( !defined $invoiceid ) {
2749 carp 'GetInvoiceDetails called without an invoiceid';
2753 my $dbh = C4::Context->dbh;
2755 SELECT aqinvoices.*, aqbooksellers.name AS suppliername
2757 LEFT JOIN aqbooksellers ON aqinvoices.booksellerid = aqbooksellers.id
2760 my $sth = $dbh->prepare($query);
2761 $sth->execute($invoiceid);
2763 my $invoice = $sth->fetchrow_hashref;
2768 biblio.copyrightdate,
2770 biblioitems.publishercode,
2771 biblioitems.publicationyear,
2772 aqbasket.basketname,
2773 aqbasketgroups.id AS basketgroupid,
2774 aqbasketgroups.name AS basketgroupname
2776 LEFT JOIN aqbasket ON aqorders.basketno = aqbasket.basketno
2777 LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid = aqbasketgroups.id
2778 LEFT JOIN biblio ON aqorders.biblionumber = biblio.biblionumber
2779 LEFT JOIN biblioitems ON aqorders.biblionumber = biblioitems.biblionumber
2782 $sth = $dbh->prepare($query);
2783 $sth->execute($invoiceid);
2784 $invoice->{orders} = $sth->fetchall_arrayref({});
2785 $invoice->{orders} ||= []; # force an empty arrayref if fetchall_arrayref fails
2792 my $invoiceid = AddInvoice(
2793 invoicenumber => $invoicenumber,
2794 booksellerid => $booksellerid,
2795 shipmentdate => $shipmentdate,
2796 billingdate => $billingdate,
2797 closedate => $closedate,
2798 shipmentcost => $shipmentcost,
2799 shipmentcost_budgetid => $shipmentcost_budgetid
2802 Create a new invoice and return its id or undef if it fails.
2809 return unless(%invoice and $invoice{invoicenumber});
2811 my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2812 closedate shipmentcost shipmentcost_budgetid message_id);
2816 foreach my $key (keys %invoice) {
2817 if(0 < grep(/^$key$/, @columns)) {
2818 push @set_strs, "$key = ?";
2819 push @set_args, ($invoice{$key} || undef);
2825 my $dbh = C4::Context->dbh;
2826 my $query = "INSERT INTO aqinvoices SET ";
2827 $query .= join (",", @set_strs);
2828 my $sth = $dbh->prepare($query);
2829 $rv = $sth->execute(@set_args);
2831 $rv = $dbh->last_insert_id(undef, undef, 'aqinvoices', undef);
2840 invoiceid => $invoiceid, # Mandatory
2841 invoicenumber => $invoicenumber,
2842 booksellerid => $booksellerid,
2843 shipmentdate => $shipmentdate,
2844 billingdate => $billingdate,
2845 closedate => $closedate,
2846 shipmentcost => $shipmentcost,
2847 shipmentcost_budgetid => $shipmentcost_budgetid
2850 Modify an invoice, invoiceid is mandatory.
2852 Return undef if it fails.
2859 return unless(%invoice and $invoice{invoiceid});
2861 my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2862 closedate shipmentcost shipmentcost_budgetid);
2866 foreach my $key (keys %invoice) {
2867 if(0 < grep(/^$key$/, @columns)) {
2868 push @set_strs, "$key = ?";
2869 push @set_args, ($invoice{$key} || undef);
2873 my $dbh = C4::Context->dbh;
2874 my $query = "UPDATE aqinvoices SET ";
2875 $query .= join(",", @set_strs);
2876 $query .= " WHERE invoiceid = ?";
2878 my $sth = $dbh->prepare($query);
2879 $sth->execute(@set_args, $invoice{invoiceid});
2884 CloseInvoice($invoiceid);
2888 Equivalent to ModInvoice(invoiceid => $invoiceid, closedate => undef);
2893 my ($invoiceid) = @_;
2895 return unless $invoiceid;
2897 my $dbh = C4::Context->dbh;
2900 SET closedate = CAST(NOW() AS DATE)
2903 my $sth = $dbh->prepare($query);
2904 $sth->execute($invoiceid);
2907 =head3 ReopenInvoice
2909 ReopenInvoice($invoiceid);
2913 Equivalent to ModInvoice(invoiceid => $invoiceid, closedate => output_pref({ dt=>dt_from_string, dateonly=>1, otputpref=>'iso' }))
2918 my ($invoiceid) = @_;
2920 return unless $invoiceid;
2922 my $dbh = C4::Context->dbh;
2925 SET closedate = NULL
2928 my $sth = $dbh->prepare($query);
2929 $sth->execute($invoiceid);
2934 DelInvoice($invoiceid);
2936 Delete an invoice if there are no items attached to it.
2941 my ($invoiceid) = @_;
2943 return unless $invoiceid;
2945 my $dbh = C4::Context->dbh;
2951 my $sth = $dbh->prepare($query);
2952 $sth->execute($invoiceid);
2953 my $res = $sth->fetchrow_arrayref;
2954 if ( $res && $res->[0] == 0 ) {
2956 DELETE FROM aqinvoices
2959 my $sth = $dbh->prepare($query);
2960 return ( $sth->execute($invoiceid) > 0 );
2965 =head3 MergeInvoices
2967 MergeInvoices($invoiceid, \@sourceids);
2969 Merge the invoices identified by the IDs in \@sourceids into
2970 the invoice identified by $invoiceid.
2975 my ($invoiceid, $sourceids) = @_;
2977 return unless $invoiceid;
2978 foreach my $sourceid (@$sourceids) {
2979 next if $sourceid == $invoiceid;
2980 my $source = GetInvoiceDetails($sourceid);
2981 foreach my $order (@{$source->{'orders'}}) {
2982 $order->{'invoiceid'} = $invoiceid;
2985 DelInvoice($source->{'invoiceid'});
2990 =head3 GetBiblioCountByBasketno
2992 $biblio_count = &GetBiblioCountByBasketno($basketno);
2994 Looks up the biblio's count that has basketno value $basketno
3000 sub GetBiblioCountByBasketno {
3001 my ($basketno) = @_;
3002 my $dbh = C4::Context->dbh;
3004 SELECT COUNT( DISTINCT( biblionumber ) )
3007 AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')
3010 my $sth = $dbh->prepare($query);
3011 $sth->execute($basketno);
3012 return $sth->fetchrow;
3015 =head3 populate_order_with_prices
3017 $order = populate_order_with_prices({
3018 order => $order #a hashref with the order values
3019 booksellerid => $booksellerid #FIXME - should obtain from order basket
3020 receiving => 1 # boolean representing order stage, should pass only this or ordering
3021 ordering => 1 # boolean representing order stage
3025 Sets calculated values for an order - all values are stored with pull precision regardless of rounding preference except fot
3026 tax value which is calculated on rounded values if requested
3028 For ordering the values set are:
3033 tax_value_on_ordering
3034 For receiving the value set are:
3035 unitprice_tax_included
3036 unitprice_tax_excluded
3037 tax_value_on_receiving
3039 Note: When receiving if the rounded value of the unitprice matches the rounded value of the ecost then then ecost (full precision) is used.
3041 Returns a hashref of the order
3043 FIXME: Move this to Koha::Acquisition::Order.pm
3047 sub populate_order_with_prices {
3050 my $order = $params->{order};
3051 my $booksellerid = $params->{booksellerid};
3052 return unless $booksellerid;
3054 my $bookseller = Koha::Acquisition::Booksellers->find( $booksellerid );
3056 my $receiving = $params->{receiving};
3057 my $ordering = $params->{ordering};
3058 my $discount = $order->{discount};
3059 $discount /= 100 if $discount > 1;
3062 $order->{tax_rate_on_ordering} //= $order->{tax_rate};
3063 if ( $bookseller->listincgst ) {
3064 # The user entered the rrp tax included
3065 $order->{rrp_tax_included} = $order->{rrp};
3067 # rrp tax excluded = rrp tax included / ( 1 + tax rate )
3068 $order->{rrp_tax_excluded} = $order->{rrp_tax_included} / ( 1 + $order->{tax_rate_on_ordering} );
3070 # ecost tax included = rrp tax included ( 1 - discount )
3071 $order->{ecost_tax_included} = $order->{rrp_tax_included} * ( 1 - $discount );
3073 # ecost tax excluded = rrp tax excluded * ( 1 - discount )
3074 $order->{ecost_tax_excluded} = $order->{rrp_tax_excluded} * ( 1 - $discount );
3076 # tax value = quantity * ecost tax excluded * tax rate
3077 $order->{tax_value_on_ordering} = ( get_rounded_price($order->{ecost_tax_included}) - get_rounded_price($order->{ecost_tax_excluded}) ) * $order->{quantity};
3081 # The user entered the rrp tax excluded
3082 $order->{rrp_tax_excluded} = $order->{rrp};
3084 # rrp tax included = rrp tax excluded * ( 1 - tax rate )
3085 $order->{rrp_tax_included} = $order->{rrp_tax_excluded} * ( 1 + $order->{tax_rate_on_ordering} );
3087 # ecost tax excluded = rrp tax excluded * ( 1 - discount )
3088 $order->{ecost_tax_excluded} = $order->{rrp_tax_excluded} * ( 1 - $discount );
3090 # ecost tax included = rrp tax excluded * ( 1 + tax rate ) * ( 1 - discount ) = ecost tax excluded * ( 1 + tax rate )
3091 $order->{ecost_tax_included} = $order->{ecost_tax_excluded} * ( 1 + $order->{tax_rate_on_ordering} );
3093 # tax value = quantity * ecost tax included * tax rate
3094 $order->{tax_value_on_ordering} = $order->{quantity} * get_rounded_price($order->{ecost_tax_excluded}) * $order->{tax_rate_on_ordering};
3099 $order->{tax_rate_on_receiving} //= $order->{tax_rate};
3100 if ( $bookseller->invoiceincgst ) {
3101 # Trick for unitprice. If the unit price rounded value is the same as the ecost rounded value
3102 # we need to keep the exact ecost value
3103 if ( Koha::Number::Price->new( $order->{unitprice} )->round == Koha::Number::Price->new( $order->{ecost_tax_included} )->round ) {
3104 $order->{unitprice} = $order->{ecost_tax_included};
3107 # The user entered the unit price tax included
3108 $order->{unitprice_tax_included} = $order->{unitprice};
3110 # unit price tax excluded = unit price tax included / ( 1 + tax rate )
3111 $order->{unitprice_tax_excluded} = $order->{unitprice_tax_included} / ( 1 + $order->{tax_rate_on_receiving} );
3114 # Trick for unitprice. If the unit price rounded value is the same as the ecost rounded value
3115 # we need to keep the exact ecost value
3116 if ( Koha::Number::Price->new( $order->{unitprice} )->round == Koha::Number::Price->new( $order->{ecost_tax_excluded} )->round ) {
3117 $order->{unitprice} = $order->{ecost_tax_excluded};
3120 # The user entered the unit price tax excluded
3121 $order->{unitprice_tax_excluded} = $order->{unitprice};
3124 # unit price tax included = unit price tax included * ( 1 + tax rate )
3125 $order->{unitprice_tax_included} = $order->{unitprice_tax_excluded} * ( 1 + $order->{tax_rate_on_receiving} );
3128 # tax value = quantity * unit price tax excluded * tax rate
3129 $order->{tax_value_on_receiving} = $order->{quantity} * get_rounded_price($order->{unitprice_tax_excluded}) * $order->{tax_rate_on_receiving};
3135 =head3 GetOrderUsers
3137 $order_users_ids = &GetOrderUsers($ordernumber);
3139 Returns a list of all borrowernumbers that are in order users list
3144 my ($ordernumber) = @_;
3146 return unless $ordernumber;
3149 SELECT borrowernumber
3151 WHERE ordernumber = ?
3153 my $dbh = C4::Context->dbh;
3154 my $sth = $dbh->prepare($query);
3155 $sth->execute($ordernumber);
3156 my $results = $sth->fetchall_arrayref( {} );
3158 my @borrowernumbers;
3159 foreach (@$results) {
3160 push @borrowernumbers, $_->{'borrowernumber'};
3163 return @borrowernumbers;
3166 =head3 ModOrderUsers
3168 my @order_users_ids = (1, 2, 3);
3169 &ModOrderUsers($ordernumber, @basketusers_ids);
3171 Delete all users from order users list, and add users in C<@order_users_ids>
3177 my ( $ordernumber, @order_users_ids ) = @_;
3179 return unless $ordernumber;
3181 my $dbh = C4::Context->dbh;
3183 DELETE FROM aqorder_users
3184 WHERE ordernumber = ?
3186 my $sth = $dbh->prepare($query);
3187 $sth->execute($ordernumber);
3190 INSERT INTO aqorder_users (ordernumber, borrowernumber)
3193 $sth = $dbh->prepare($query);
3194 foreach my $order_user_id (@order_users_ids) {
3195 $sth->execute( $ordernumber, $order_user_id );
3199 sub NotifyOrderUsers {
3200 my ($ordernumber) = @_;
3202 my @borrowernumbers = GetOrderUsers($ordernumber);
3203 return unless @borrowernumbers;
3205 my $order = GetOrder( $ordernumber );
3206 for my $borrowernumber (@borrowernumbers) {
3207 my $patron = Koha::Patrons->find( $borrowernumber );
3208 my $library = $patron->library->unblessed;
3209 my $biblio = Koha::Biblios->find( $order->{biblionumber} )->unblessed;
3210 my $letter = C4::Letters::GetPreparedLetter(
3211 module => 'acquisition',
3212 letter_code => 'ACQ_NOTIF_ON_RECEIV',
3213 branchcode => $library->{branchcode},
3214 lang => $patron->lang,
3216 'branches' => $library,
3217 'borrowers' => $patron->unblessed,
3218 'biblio' => $biblio,
3219 'aqorders' => $order,
3223 C4::Letters::EnqueueLetter(
3226 borrowernumber => $borrowernumber,
3227 LibraryName => C4::Context->preference("LibraryName"),
3228 message_transport_type => 'email',
3230 ) or warn "can't enqueue letter $letter";
3235 =head3 FillWithDefaultValues
3237 FillWithDefaultValues( $marc_record );
3239 This will update the record with default value defined in the ACQ framework.
3240 For all existing fields, if a default value exists and there are no subfield, it will be created.
3241 If the field does not exist, it will be created too.
3245 sub FillWithDefaultValues {
3247 my $tagslib = C4::Biblio::GetMarcStructure( 1, 'ACQ', { unsafe => 1 } );
3250 C4::Biblio::GetMarcFromKohaField( 'items.itemnumber', '' );
3251 for my $tag ( sort keys %$tagslib ) {
3253 next if $tag == $itemfield;
3254 for my $subfield ( sort keys %{ $tagslib->{$tag} } ) {
3255 next if IsMarcStructureInternal($tagslib->{$tag}{$subfield});
3256 my $defaultvalue = $tagslib->{$tag}{$subfield}{defaultvalue};
3257 if ( defined $defaultvalue and $defaultvalue ne '' ) {
3258 my @fields = $record->field($tag);
3260 for my $field (@fields) {
3261 unless ( defined $field->subfield($subfield) ) {
3262 $field->add_subfields(
3263 $subfield => $defaultvalue );
3268 $record->insert_fields_ordered(
3270 $tag, '', '', $subfield => $defaultvalue
3285 Koha Development Team <http://koha-community.org/>