Bug 11715: require authentication for various staff scripts
[koha.git] / C4 / Acquisition.pm
1 package C4::Acquisition;
2
3 # Copyright 2000-2002 Katipo Communications
4 #
5 # This file is part of Koha.
6 #
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
10 # version.
11 #
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19
20
21 use strict;
22 use warnings;
23 use Carp;
24 use C4::Context;
25 use C4::Debug;
26 use C4::Dates qw(format_date format_date_in_iso);
27 use MARC::Record;
28 use C4::Suggestions;
29 use C4::Biblio;
30 use C4::Debug;
31 use C4::SQLHelper qw(InsertInTable UpdateInTable);
32 use C4::Bookseller qw(GetBookSellerFromId);
33 use C4::Templates qw(gettemplate);
34
35 use Time::localtime;
36 use HTML::Entities;
37
38 use vars qw($VERSION @ISA @EXPORT);
39
40 BEGIN {
41     # set the version for version checking
42     $VERSION = 3.07.00.049;
43     require Exporter;
44     @ISA    = qw(Exporter);
45     @EXPORT = qw(
46         &GetBasket &NewBasket &CloseBasket &ReopenBasket &DelBasket &ModBasket
47         &GetBasketAsCSV &GetBasketGroupAsCSV
48         &GetBasketsByBookseller &GetBasketsByBasketgroup
49         &GetBasketsInfosByBookseller
50
51         &GetBasketUsers &ModBasketUsers
52         &CanUserManageBasket
53
54         &ModBasketHeader
55
56         &ModBasketgroup &NewBasketgroup &DelBasketgroup &GetBasketgroup &CloseBasketgroup
57         &GetBasketgroups &ReOpenBasketgroup
58
59         &NewOrder &DelOrder &ModOrder &GetOrder &GetOrders &GetOrdersByBiblionumber
60         &GetLateOrders &GetOrderFromItemnumber
61         &SearchOrders &GetHistory &GetRecentAcqui
62         &ModReceiveOrder &CancelReceipt
63         &GetCancelledOrders &TransferOrder
64         &GetLastOrderNotReceivedFromSubscriptionid &GetLastOrderReceivedFromSubscriptionid
65         &NewOrderItem &ModItemOrder
66
67         &GetParcels &GetParcel
68         &GetContracts &GetContract
69
70         &GetInvoices
71         &GetInvoice
72         &GetInvoiceDetails
73         &AddInvoice
74         &ModInvoice
75         &CloseInvoice
76         &ReopenInvoice
77         &DelInvoice
78         &MergeInvoices
79
80         &GetItemnumbersFromOrder
81
82         &AddClaim
83         &GetBiblioCountByBasketno
84     );
85 }
86
87
88
89
90
91 sub GetOrderFromItemnumber {
92     my ($itemnumber) = @_;
93     my $dbh          = C4::Context->dbh;
94     my $query        = qq|
95
96     SELECT  * from aqorders    LEFT JOIN aqorders_items
97     ON (     aqorders.ordernumber = aqorders_items.ordernumber   )
98     WHERE itemnumber = ?  |;
99
100     my $sth = $dbh->prepare($query);
101
102 #    $sth->trace(3);
103
104     $sth->execute($itemnumber);
105
106     my $order = $sth->fetchrow_hashref;
107     return ( $order  );
108
109 }
110
111 # Returns the itemnumber(s) associated with the ordernumber given in parameter
112 sub GetItemnumbersFromOrder {
113     my ($ordernumber) = @_;
114     my $dbh          = C4::Context->dbh;
115     my $query        = "SELECT itemnumber FROM aqorders_items WHERE ordernumber=?";
116     my $sth = $dbh->prepare($query);
117     $sth->execute($ordernumber);
118     my @tab;
119
120     while (my $order = $sth->fetchrow_hashref) {
121     push @tab, $order->{'itemnumber'};
122     }
123
124     return @tab;
125
126 }
127
128
129
130
131
132
133 =head1 NAME
134
135 C4::Acquisition - Koha functions for dealing with orders and acquisitions
136
137 =head1 SYNOPSIS
138
139 use C4::Acquisition;
140
141 =head1 DESCRIPTION
142
143 The functions in this module deal with acquisitions, managing book
144 orders, basket and parcels.
145
146 =head1 FUNCTIONS
147
148 =head2 FUNCTIONS ABOUT BASKETS
149
150 =head3 GetBasket
151
152   $aqbasket = &GetBasket($basketnumber);
153
154 get all basket informations in aqbasket for a given basket
155
156 B<returns:> informations for a given basket returned as a hashref.
157
158 =cut
159
160 sub GetBasket {
161     my ($basketno) = @_;
162     my $dbh        = C4::Context->dbh;
163     my $query = "
164         SELECT  aqbasket.*,
165                 concat( b.firstname,' ',b.surname) AS authorisedbyname
166         FROM    aqbasket
167         LEFT JOIN borrowers b ON aqbasket.authorisedby=b.borrowernumber
168         WHERE basketno=?
169     ";
170     my $sth=$dbh->prepare($query);
171     $sth->execute($basketno);
172     my $basket = $sth->fetchrow_hashref;
173     return ( $basket );
174 }
175
176 #------------------------------------------------------------#
177
178 =head3 NewBasket
179
180   $basket = &NewBasket( $booksellerid, $authorizedby, $basketname, 
181       $basketnote, $basketbooksellernote, $basketcontractnumber, $deliveryplace, $billingplace );
182
183 Create a new basket in aqbasket table
184
185 =over
186
187 =item C<$booksellerid> is a foreign key in the aqbasket table
188
189 =item C<$authorizedby> is the username of who created the basket
190
191 =back
192
193 The other parameters are optional, see ModBasketHeader for more info on them.
194
195 =cut
196
197 sub NewBasket {
198     my ( $booksellerid, $authorisedby, $basketname, $basketnote,
199         $basketbooksellernote, $basketcontractnumber, $deliveryplace,
200         $billingplace ) = @_;
201     my $dbh = C4::Context->dbh;
202     my $query =
203         'INSERT INTO aqbasket (creationdate,booksellerid,authorisedby) '
204       . 'VALUES  (now(),?,?)';
205     $dbh->do( $query, {}, $booksellerid, $authorisedby );
206
207     my $basket = $dbh->{mysql_insertid};
208     $basketname           ||= q{}; # default to empty strings
209     $basketnote           ||= q{};
210     $basketbooksellernote ||= q{};
211     ModBasketHeader( $basket, $basketname, $basketnote, $basketbooksellernote,
212         $basketcontractnumber, $booksellerid, $deliveryplace, $billingplace );
213     return $basket;
214 }
215
216 #------------------------------------------------------------#
217
218 =head3 CloseBasket
219
220   &CloseBasket($basketno);
221
222 close a basket (becomes unmodifiable, except for receives)
223
224 =cut
225
226 sub CloseBasket {
227     my ($basketno) = @_;
228     my $dbh        = C4::Context->dbh;
229     my $query = "
230         UPDATE aqbasket
231         SET    closedate=now()
232         WHERE  basketno=?
233     ";
234     my $sth = $dbh->prepare($query);
235     $sth->execute($basketno);
236
237     my @orders = GetOrders($basketno);
238     foreach my $order (@orders) {
239         $query = qq{
240             UPDATE aqorders
241             SET orderstatus = 'ordered'
242             WHERE ordernumber = ?;
243         };
244         $sth = $dbh->prepare($query);
245         $sth->execute($order->{'ordernumber'});
246     }
247 }
248
249 =head3 ReopenBasket
250
251   &ReopenBasket($basketno);
252
253 reopen a basket
254
255 =cut
256
257 sub ReopenBasket {
258     my ($basketno) = @_;
259     my $dbh        = C4::Context->dbh;
260     my $query = "
261         UPDATE aqbasket
262         SET    closedate=NULL
263         WHERE  basketno=?
264     ";
265     my $sth = $dbh->prepare($query);
266     $sth->execute($basketno);
267
268     my @orders = GetOrders($basketno);
269     foreach my $order (@orders) {
270         $query = qq{
271             UPDATE aqorders
272             SET orderstatus = 'new'
273             WHERE ordernumber = ?;
274         };
275         $sth = $dbh->prepare($query);
276         $sth->execute($order->{'ordernumber'});
277     }
278 }
279
280 #------------------------------------------------------------#
281
282 =head3 GetBasketAsCSV
283
284   &GetBasketAsCSV($basketno);
285
286 Export a basket as CSV
287
288 $cgi parameter is needed for column name translation
289
290 =cut
291
292 sub GetBasketAsCSV {
293     my ($basketno, $cgi) = @_;
294     my $basket = GetBasket($basketno);
295     my @orders = GetOrders($basketno);
296     my $contract = GetContract($basket->{'contractnumber'});
297
298     my $template = C4::Templates::gettemplate("acqui/csv/basket.tmpl", "intranet", $cgi);
299
300     my @rows;
301     foreach my $order (@orders) {
302         my $bd = GetBiblioData( $order->{'biblionumber'} );
303         my $row = {
304             contractname => $contract->{'contractname'},
305             ordernumber => $order->{'ordernumber'},
306             entrydate => $order->{'entrydate'},
307             isbn => $order->{'isbn'},
308             author => $bd->{'author'},
309             title => $bd->{'title'},
310             publicationyear => $bd->{'publicationyear'},
311             publishercode => $bd->{'publishercode'},
312             collectiontitle => $bd->{'collectiontitle'},
313             notes => $order->{'order_vendornote'},
314             quantity => $order->{'quantity'},
315             rrp => $order->{'rrp'},
316             deliveryplace => C4::Branch::GetBranchName( $basket->{'deliveryplace'} ),
317             billingplace => C4::Branch::GetBranchName( $basket->{'billingplace'} ),
318         };
319         foreach(qw(
320             contractname author title publishercode collectiontitle notes
321             deliveryplace billingplace
322         ) ) {
323             # Double the quotes to not be interpreted as a field end
324             $row->{$_} =~ s/"/""/g if $row->{$_};
325         }
326         push @rows, $row;
327     }
328
329     @rows = sort {
330         if(defined $a->{publishercode} and defined $b->{publishercode}) {
331             $a->{publishercode} cmp $b->{publishercode};
332         }
333     } @rows;
334
335     $template->param(rows => \@rows);
336
337     return $template->output;
338 }
339
340
341 =head3 GetBasketGroupAsCSV
342
343 =over
344
345 &GetBasketGroupAsCSV($basketgroupid);
346
347 Export a basket group as CSV
348
349 $cgi parameter is needed for column name translation
350
351 =back
352
353 =cut
354
355 sub GetBasketGroupAsCSV {
356     my ($basketgroupid, $cgi) = @_;
357     my $baskets = GetBasketsByBasketgroup($basketgroupid);
358
359     my $template = C4::Templates::gettemplate('acqui/csv/basketgroup.tmpl', 'intranet', $cgi);
360
361     my @rows;
362     for my $basket (@$baskets) {
363         my @orders     = GetOrders( $$basket{basketno} );
364         my $contract   = GetContract( $$basket{contractnumber} );
365         my $bookseller = GetBookSellerFromId( $$basket{booksellerid} );
366         my $basketgroup = GetBasketgroup( $$basket{basketgroupid} );
367
368         foreach my $order (@orders) {
369             my $bd = GetBiblioData( $order->{'biblionumber'} );
370             my $row = {
371                 clientnumber => $bookseller->{accountnumber},
372                 basketname => $basket->{basketname},
373                 ordernumber => $order->{ordernumber},
374                 author => $bd->{author},
375                 title => $bd->{title},
376                 publishercode => $bd->{publishercode},
377                 publicationyear => $bd->{publicationyear},
378                 collectiontitle => $bd->{collectiontitle},
379                 isbn => $order->{isbn},
380                 quantity => $order->{quantity},
381                 rrp => $order->{rrp},
382                 discount => $bookseller->{discount},
383                 ecost => $order->{ecost},
384                 notes => $order->{order_vendornote},
385                 entrydate => $order->{entrydate},
386                 booksellername => $bookseller->{name},
387                 bookselleraddress => $bookseller->{address1},
388                 booksellerpostal => $bookseller->{postal},
389                 contractnumber => $contract->{contractnumber},
390                 contractname => $contract->{contractname},
391                 basketgroupdeliveryplace => C4::Branch::GetBranchName( $basketgroup->{deliveryplace} ),
392                 basketgroupbillingplace => C4::Branch::GetBranchName( $basketgroup->{billingplace} ),
393                 basketdeliveryplace => C4::Branch::GetBranchName( $basket->{deliveryplace} ),
394                 basketbillingplace => C4::Branch::GetBranchName( $basket->{billingplace} ),
395             };
396             foreach(qw(
397                 basketname author title publishercode collectiontitle notes
398                 booksellername bookselleraddress booksellerpostal contractname
399                 basketgroupdeliveryplace basketgroupbillingplace
400                 basketdeliveryplace basketbillingplace
401             ) ) {
402                 # Double the quotes to not be interpreted as a field end
403                 $row->{$_} =~ s/"/""/g if $row->{$_};
404             }
405             push @rows, $row;
406          }
407      }
408     $template->param(rows => \@rows);
409
410     return $template->output;
411
412 }
413
414 =head3 CloseBasketgroup
415
416   &CloseBasketgroup($basketgroupno);
417
418 close a basketgroup
419
420 =cut
421
422 sub CloseBasketgroup {
423     my ($basketgroupno) = @_;
424     my $dbh        = C4::Context->dbh;
425     my $sth = $dbh->prepare("
426         UPDATE aqbasketgroups
427         SET    closed=1
428         WHERE  id=?
429     ");
430     $sth->execute($basketgroupno);
431 }
432
433 #------------------------------------------------------------#
434
435 =head3 ReOpenBaskergroup($basketgroupno)
436
437   &ReOpenBaskergroup($basketgroupno);
438
439 reopen a basketgroup
440
441 =cut
442
443 sub ReOpenBasketgroup {
444     my ($basketgroupno) = @_;
445     my $dbh        = C4::Context->dbh;
446     my $sth = $dbh->prepare("
447         UPDATE aqbasketgroups
448         SET    closed=0
449         WHERE  id=?
450     ");
451     $sth->execute($basketgroupno);
452 }
453
454 #------------------------------------------------------------#
455
456
457 =head3 DelBasket
458
459   &DelBasket($basketno);
460
461 Deletes the basket that has basketno field $basketno in the aqbasket table.
462
463 =over
464
465 =item C<$basketno> is the primary key of the basket in the aqbasket table.
466
467 =back
468
469 =cut
470
471 sub DelBasket {
472     my ( $basketno ) = @_;
473     my $query = "DELETE FROM aqbasket WHERE basketno=?";
474     my $dbh = C4::Context->dbh;
475     my $sth = $dbh->prepare($query);
476     $sth->execute($basketno);
477     return;
478 }
479
480 #------------------------------------------------------------#
481
482 =head3 ModBasket
483
484   &ModBasket($basketinfo);
485
486 Modifies a basket, using a hashref $basketinfo for the relevant information, only $basketinfo->{'basketno'} is required.
487
488 =over
489
490 =item C<$basketno> is the primary key of the basket in the aqbasket table.
491
492 =back
493
494 =cut
495
496 sub ModBasket {
497     my $basketinfo = shift;
498     my $query = "UPDATE aqbasket SET ";
499     my @params;
500     foreach my $key (keys %$basketinfo){
501         if ($key ne 'basketno'){
502             $query .= "$key=?, ";
503             push(@params, $basketinfo->{$key} || undef );
504         }
505     }
506 # get rid of the "," at the end of $query
507     if (substr($query, length($query)-2) eq ', '){
508         chop($query);
509         chop($query);
510         $query .= ' ';
511     }
512     $query .= "WHERE basketno=?";
513     push(@params, $basketinfo->{'basketno'});
514     my $dbh = C4::Context->dbh;
515     my $sth = $dbh->prepare($query);
516     $sth->execute(@params);
517
518     return;
519 }
520
521 #------------------------------------------------------------#
522
523 =head3 ModBasketHeader
524
525   &ModBasketHeader($basketno, $basketname, $note, $booksellernote, $contractnumber, $booksellerid);
526
527 Modifies a basket's header.
528
529 =over
530
531 =item C<$basketno> is the "basketno" field in the "aqbasket" table;
532
533 =item C<$basketname> is the "basketname" field in the "aqbasket" table;
534
535 =item C<$note> is the "note" field in the "aqbasket" table;
536
537 =item C<$booksellernote> is the "booksellernote" field in the "aqbasket" table;
538
539 =item C<$contractnumber> is the "contractnumber" (foreign) key in the "aqbasket" table.
540
541 =item C<$booksellerid> is the id (foreign) key in the "aqbooksellers" table for the vendor.
542
543 =item C<$deliveryplace> is the "deliveryplace" field in the aqbasket table.
544
545 =item C<$billingplace> is the "billingplace" field in the aqbasket table.
546
547 =back
548
549 =cut
550
551 sub ModBasketHeader {
552     my ($basketno, $basketname, $note, $booksellernote, $contractnumber, $booksellerid, $deliveryplace, $billingplace) = @_;
553     my $query = qq{
554         UPDATE aqbasket
555         SET basketname=?, note=?, booksellernote=?, booksellerid=?, deliveryplace=?, billingplace=?
556         WHERE basketno=?
557     };
558
559     my $dbh = C4::Context->dbh;
560     my $sth = $dbh->prepare($query);
561     $sth->execute($basketname, $note, $booksellernote, $booksellerid, $deliveryplace, $billingplace, $basketno);
562
563     if ( $contractnumber ) {
564         my $query2 ="UPDATE aqbasket SET contractnumber=? WHERE basketno=?";
565         my $sth2 = $dbh->prepare($query2);
566         $sth2->execute($contractnumber,$basketno);
567     }
568     return;
569 }
570
571 #------------------------------------------------------------#
572
573 =head3 GetBasketsByBookseller
574
575   @results = &GetBasketsByBookseller($booksellerid, $extra);
576
577 Returns a list of hashes of all the baskets that belong to bookseller 'booksellerid'.
578
579 =over
580
581 =item C<$booksellerid> is the 'id' field of the bookseller in the aqbooksellers table
582
583 =item C<$extra> is the extra sql parameters, can be
584
585  $extra->{groupby}: group baskets by column
586     ex. $extra->{groupby} = aqbasket.basketgroupid
587  $extra->{orderby}: order baskets by column
588  $extra->{limit}: limit number of results (can be helpful for pagination)
589
590 =back
591
592 =cut
593
594 sub GetBasketsByBookseller {
595     my ($booksellerid, $extra) = @_;
596     my $query = "SELECT * FROM aqbasket WHERE booksellerid=?";
597     if ($extra){
598         if ($extra->{groupby}) {
599             $query .= " GROUP by $extra->{groupby}";
600         }
601         if ($extra->{orderby}){
602             $query .= " ORDER by $extra->{orderby}";
603         }
604         if ($extra->{limit}){
605             $query .= " LIMIT $extra->{limit}";
606         }
607     }
608     my $dbh = C4::Context->dbh;
609     my $sth = $dbh->prepare($query);
610     $sth->execute($booksellerid);
611     return $sth->fetchall_arrayref({});
612 }
613
614 =head3 GetBasketsInfosByBookseller
615
616     my $baskets = GetBasketsInfosByBookseller($supplierid, $allbaskets);
617
618 The optional second parameter allbaskets is a boolean allowing you to
619 select all baskets from the supplier; by default only active baskets (open or 
620 closed but still something to receive) are returned.
621
622 Returns in a arrayref of hashref all about booksellers baskets, plus:
623     total_biblios: Number of distinct biblios in basket
624     total_items: Number of items in basket
625     expected_items: Number of non-received items in basket
626
627 =cut
628
629 sub GetBasketsInfosByBookseller {
630     my ($supplierid, $allbaskets) = @_;
631
632     return unless $supplierid;
633
634     my $dbh = C4::Context->dbh;
635     my $query = q{
636         SELECT aqbasket.*,
637           SUM(aqorders.quantity) AS total_items,
638           SUM(
639             IF ( aqorders.orderstatus = 'cancelled', aqorders.quantity, 0 )
640           ) AS total_items_cancelled,
641           COUNT(DISTINCT aqorders.biblionumber) AS total_biblios,
642           SUM(
643             IF(aqorders.datereceived IS NULL
644               AND aqorders.datecancellationprinted IS NULL
645             , aqorders.quantity
646             , 0)
647           ) AS expected_items
648         FROM aqbasket
649           LEFT JOIN aqorders ON aqorders.basketno = aqbasket.basketno
650         WHERE booksellerid = ?};
651
652     unless ( $allbaskets ) {
653         $query.=" AND (closedate IS NULL OR (aqorders.quantity > aqorders.quantityreceived AND datecancellationprinted IS NULL))";
654     }
655     $query.=" GROUP BY aqbasket.basketno";
656
657     my $sth = $dbh->prepare($query);
658     $sth->execute($supplierid);
659     my $baskets = $sth->fetchall_arrayref({});
660
661     # Retrieve the number of biblios cancelled
662     my $cancelled_biblios = $dbh->selectall_hashref( q|
663         SELECT COUNT(DISTINCT(biblionumber)) AS total_biblios_cancelled, aqbasket.basketno
664         FROM aqbasket
665         LEFT JOIN aqorders ON aqorders.basketno = aqbasket.basketno
666         WHERE booksellerid = ?
667         AND aqorders.orderstatus = 'cancelled'
668         GROUP BY aqbasket.basketno
669     |, 'basketno', {}, $supplierid );
670     map {
671         $_->{total_biblios_cancelled} = $cancelled_biblios->{$_->{basketno}}{total_biblios_cancelled} || 0
672     } @$baskets;
673
674     return $baskets;
675 }
676
677 =head3 GetBasketUsers
678
679     $basketusers_ids = &GetBasketUsers($basketno);
680
681 Returns a list of all borrowernumbers that are in basket users list
682
683 =cut
684
685 sub GetBasketUsers {
686     my $basketno = shift;
687
688     return unless $basketno;
689
690     my $query = qq{
691         SELECT borrowernumber
692         FROM aqbasketusers
693         WHERE basketno = ?
694     };
695     my $dbh = C4::Context->dbh;
696     my $sth = $dbh->prepare($query);
697     $sth->execute($basketno);
698     my $results = $sth->fetchall_arrayref( {} );
699
700     my @borrowernumbers;
701     foreach (@$results) {
702         push @borrowernumbers, $_->{'borrowernumber'};
703     }
704
705     return @borrowernumbers;
706 }
707
708 =head3 ModBasketUsers
709
710     my @basketusers_ids = (1, 2, 3);
711     &ModBasketUsers($basketno, @basketusers_ids);
712
713 Delete all users from basket users list, and add users in C<@basketusers_ids>
714 to this users list.
715
716 =cut
717
718 sub ModBasketUsers {
719     my ($basketno, @basketusers_ids) = @_;
720
721     return unless $basketno;
722
723     my $dbh = C4::Context->dbh;
724     my $query = qq{
725         DELETE FROM aqbasketusers
726         WHERE basketno = ?
727     };
728     my $sth = $dbh->prepare($query);
729     $sth->execute($basketno);
730
731     $query = qq{
732         INSERT INTO aqbasketusers (basketno, borrowernumber)
733         VALUES (?, ?)
734     };
735     $sth = $dbh->prepare($query);
736     foreach my $basketuser_id (@basketusers_ids) {
737         $sth->execute($basketno, $basketuser_id);
738     }
739     return;
740 }
741
742 =head3 CanUserManageBasket
743
744     my $bool = CanUserManageBasket($borrower, $basket[, $userflags]);
745     my $bool = CanUserManageBasket($borrowernumber, $basketno[, $userflags]);
746
747 Check if a borrower can manage a basket, according to system preference
748 AcqViewBaskets, user permissions and basket properties (creator, users list,
749 branch).
750
751 First parameter can be either a borrowernumber or a hashref as returned by
752 C4::Members::GetMember.
753
754 Second parameter can be either a basketno or a hashref as returned by
755 C4::Acquisition::GetBasket.
756
757 The third parameter is optional. If given, it should be a hashref as returned
758 by C4::Auth::getuserflags. If not, getuserflags is called.
759
760 If user is authorised to manage basket, returns 1.
761 Otherwise returns 0.
762
763 =cut
764
765 sub CanUserManageBasket {
766     my ($borrower, $basket, $userflags) = @_;
767
768     if (!ref $borrower) {
769         $borrower = C4::Members::GetMember(borrowernumber => $borrower);
770     }
771     if (!ref $basket) {
772         $basket = GetBasket($basket);
773     }
774
775     return 0 unless ($basket and $borrower);
776
777     my $borrowernumber = $borrower->{borrowernumber};
778     my $basketno = $basket->{basketno};
779
780     my $AcqViewBaskets = C4::Context->preference('AcqViewBaskets');
781
782     if (!defined $userflags) {
783         my $dbh = C4::Context->dbh;
784         my $sth = $dbh->prepare("SELECT flags FROM borrowers WHERE borrowernumber = ?");
785         $sth->execute($borrowernumber);
786         my ($flags) = $sth->fetchrow_array;
787         $sth->finish;
788
789         $userflags = C4::Auth::getuserflags($flags, $borrower->{userid}, $dbh);
790     }
791
792     unless ($userflags->{superlibrarian}
793     || (ref $userflags->{acquisition} && $userflags->{acquisition}->{order_manage_all})
794     || (!ref $userflags->{acquisition} && $userflags->{acquisition}))
795     {
796         if (not exists $userflags->{acquisition}) {
797             return 0;
798         }
799
800         if ( (ref $userflags->{acquisition} && !$userflags->{acquisition}->{order_manage})
801         || (!ref $userflags->{acquisition} && !$userflags->{acquisition}) ) {
802             return 0;
803         }
804
805         if ($AcqViewBaskets eq 'user'
806         && $basket->{authorisedby} != $borrowernumber
807         && grep($borrowernumber, GetBasketUsers($basketno)) == 0) {
808             return 0;
809         }
810
811         if ($AcqViewBaskets eq 'branch' && defined $basket->{branch}
812         && $basket->{branch} ne $borrower->{branchcode}) {
813             return 0;
814         }
815     }
816
817     return 1;
818 }
819
820 #------------------------------------------------------------#
821
822 =head3 GetBasketsByBasketgroup
823
824   $baskets = &GetBasketsByBasketgroup($basketgroupid);
825
826 Returns a reference to all baskets that belong to basketgroup $basketgroupid.
827
828 =cut
829
830 sub GetBasketsByBasketgroup {
831     my $basketgroupid = shift;
832     my $query = qq{
833         SELECT *, aqbasket.booksellerid as booksellerid
834         FROM aqbasket
835         LEFT JOIN aqcontract USING(contractnumber) WHERE basketgroupid=?
836     };
837     my $dbh = C4::Context->dbh;
838     my $sth = $dbh->prepare($query);
839     $sth->execute($basketgroupid);
840     return $sth->fetchall_arrayref({});
841 }
842
843 #------------------------------------------------------------#
844
845 =head3 NewBasketgroup
846
847   $basketgroupid = NewBasketgroup(\%hashref);
848
849 Adds a basketgroup to the aqbasketgroups table, and add the initial baskets to it.
850
851 $hashref->{'booksellerid'} is the 'id' field of the bookseller in the aqbooksellers table,
852
853 $hashref->{'name'} is the 'name' field of the basketgroup in the aqbasketgroups table,
854
855 $hashref->{'basketlist'} is a list reference of the 'id's of the baskets that belong to this group,
856
857 $hashref->{'billingplace'} is the 'billingplace' field of the basketgroup in the aqbasketgroups table,
858
859 $hashref->{'deliveryplace'} is the 'deliveryplace' field of the basketgroup in the aqbasketgroups table,
860
861 $hashref->{'freedeliveryplace'} is the 'freedeliveryplace' field of the basketgroup in the aqbasketgroups table,
862
863 $hashref->{'deliverycomment'} is the 'deliverycomment' field of the basketgroup in the aqbasketgroups table,
864
865 $hashref->{'closed'} is the 'closed' field of the aqbasketgroups table, it is false if 0, true otherwise.
866
867 =cut
868
869 sub NewBasketgroup {
870     my $basketgroupinfo = shift;
871     die "booksellerid is required to create a basketgroup" unless $basketgroupinfo->{'booksellerid'};
872     my $query = "INSERT INTO aqbasketgroups (";
873     my @params;
874     foreach my $field (qw(name billingplace deliveryplace freedeliveryplace deliverycomment closed)) {
875         if ( defined $basketgroupinfo->{$field} ) {
876             $query .= "$field, ";
877             push(@params, $basketgroupinfo->{$field});
878         }
879     }
880     $query .= "booksellerid) VALUES (";
881     foreach (@params) {
882         $query .= "?, ";
883     }
884     $query .= "?)";
885     push(@params, $basketgroupinfo->{'booksellerid'});
886     my $dbh = C4::Context->dbh;
887     my $sth = $dbh->prepare($query);
888     $sth->execute(@params);
889     my $basketgroupid = $dbh->{'mysql_insertid'};
890     if( $basketgroupinfo->{'basketlist'} ) {
891         foreach my $basketno (@{$basketgroupinfo->{'basketlist'}}) {
892             my $query2 = "UPDATE aqbasket SET basketgroupid=? WHERE basketno=?";
893             my $sth2 = $dbh->prepare($query2);
894             $sth2->execute($basketgroupid, $basketno);
895         }
896     }
897     return $basketgroupid;
898 }
899
900 #------------------------------------------------------------#
901
902 =head3 ModBasketgroup
903
904   ModBasketgroup(\%hashref);
905
906 Modifies a basketgroup in the aqbasketgroups table, and add the baskets to it.
907
908 $hashref->{'id'} is the 'id' field of the basketgroup in the aqbasketgroup table, this parameter is mandatory,
909
910 $hashref->{'name'} is the 'name' field of the basketgroup in the aqbasketgroups table,
911
912 $hashref->{'basketlist'} is a list reference of the 'id's of the baskets that belong to this group,
913
914 $hashref->{'billingplace'} is the 'billingplace' field of the basketgroup in the aqbasketgroups table,
915
916 $hashref->{'deliveryplace'} is the 'deliveryplace' field of the basketgroup in the aqbasketgroups table,
917
918 $hashref->{'freedeliveryplace'} is the 'freedeliveryplace' field of the basketgroup in the aqbasketgroups table,
919
920 $hashref->{'deliverycomment'} is the 'deliverycomment' field of the basketgroup in the aqbasketgroups table,
921
922 $hashref->{'closed'} is the 'closed' field of the aqbasketgroups table, it is false if 0, true otherwise.
923
924 =cut
925
926 sub ModBasketgroup {
927     my $basketgroupinfo = shift;
928     die "basketgroup id is required to edit a basketgroup" unless $basketgroupinfo->{'id'};
929     my $dbh = C4::Context->dbh;
930     my $query = "UPDATE aqbasketgroups SET ";
931     my @params;
932     foreach my $field (qw(name billingplace deliveryplace freedeliveryplace deliverycomment closed)) {
933         if ( defined $basketgroupinfo->{$field} ) {
934             $query .= "$field=?, ";
935             push(@params, $basketgroupinfo->{$field});
936         }
937     }
938     chop($query);
939     chop($query);
940     $query .= " WHERE id=?";
941     push(@params, $basketgroupinfo->{'id'});
942     my $sth = $dbh->prepare($query);
943     $sth->execute(@params);
944
945     $sth = $dbh->prepare('UPDATE aqbasket SET basketgroupid = NULL WHERE basketgroupid = ?');
946     $sth->execute($basketgroupinfo->{'id'});
947
948     if($basketgroupinfo->{'basketlist'} && @{$basketgroupinfo->{'basketlist'}}){
949         $sth = $dbh->prepare("UPDATE aqbasket SET basketgroupid=? WHERE basketno=?");
950         foreach my $basketno (@{$basketgroupinfo->{'basketlist'}}) {
951             $sth->execute($basketgroupinfo->{'id'}, $basketno);
952         }
953     }
954     return;
955 }
956
957 #------------------------------------------------------------#
958
959 =head3 DelBasketgroup
960
961   DelBasketgroup($basketgroupid);
962
963 Deletes a basketgroup in the aqbasketgroups table, and removes the reference to it from the baskets,
964
965 =over
966
967 =item C<$basketgroupid> is the 'id' field of the basket in the aqbasketgroup table
968
969 =back
970
971 =cut
972
973 sub DelBasketgroup {
974     my $basketgroupid = shift;
975     die "basketgroup id is required to edit a basketgroup" unless $basketgroupid;
976     my $query = "DELETE FROM aqbasketgroups WHERE id=?";
977     my $dbh = C4::Context->dbh;
978     my $sth = $dbh->prepare($query);
979     $sth->execute($basketgroupid);
980     return;
981 }
982
983 #------------------------------------------------------------#
984
985
986 =head2 FUNCTIONS ABOUT ORDERS
987
988 =head3 GetBasketgroup
989
990   $basketgroup = &GetBasketgroup($basketgroupid);
991
992 Returns a reference to the hash containing all information about the basketgroup.
993
994 =cut
995
996 sub GetBasketgroup {
997     my $basketgroupid = shift;
998     die "basketgroup id is required to edit a basketgroup" unless $basketgroupid;
999     my $dbh = C4::Context->dbh;
1000     my $result_set = $dbh->selectall_arrayref(
1001         'SELECT * FROM aqbasketgroups WHERE id=?',
1002         { Slice => {} },
1003         $basketgroupid
1004     );
1005     return $result_set->[0];    # id is unique
1006 }
1007
1008 #------------------------------------------------------------#
1009
1010 =head3 GetBasketgroups
1011
1012   $basketgroups = &GetBasketgroups($booksellerid);
1013
1014 Returns a reference to the array of all the basketgroups of bookseller $booksellerid.
1015
1016 =cut
1017
1018 sub GetBasketgroups {
1019     my $booksellerid = shift;
1020     die 'bookseller id is required to edit a basketgroup' unless $booksellerid;
1021     my $query = 'SELECT * FROM aqbasketgroups WHERE booksellerid=? ORDER BY id DESC';
1022     my $dbh = C4::Context->dbh;
1023     my $sth = $dbh->prepare($query);
1024     $sth->execute($booksellerid);
1025     return $sth->fetchall_arrayref({});
1026 }
1027
1028 #------------------------------------------------------------#
1029
1030 =head2 FUNCTIONS ABOUT ORDERS
1031
1032 =head3 GetOrders
1033
1034   @orders = &GetOrders($basketnumber, $orderby);
1035
1036 Looks up the pending (non-cancelled) orders with the given basket
1037 number. If C<$booksellerID> is non-empty, only orders from that seller
1038 are returned.
1039
1040 return :
1041 C<&basket> returns a two-element array. C<@orders> is an array of
1042 references-to-hash, whose keys are the fields from the aqorders,
1043 biblio, and biblioitems tables in the Koha database.
1044
1045 =cut
1046
1047 sub GetOrders {
1048     my ( $basketno, $orderby ) = @_;
1049     return () unless $basketno;
1050     my $dbh   = C4::Context->dbh;
1051     my $query  ="
1052         SELECT biblio.*,biblioitems.*,
1053                 aqorders.*,
1054                 aqbudgets.*,
1055                 biblio.title,
1056                 aqorders_transfers.ordernumber_from AS transferred_from,
1057                 aqorders_transfers.timestamp AS transferred_from_timestamp
1058         FROM    aqorders
1059             LEFT JOIN aqbudgets        ON aqbudgets.budget_id = aqorders.budget_id
1060             LEFT JOIN biblio           ON biblio.biblionumber = aqorders.biblionumber
1061             LEFT JOIN biblioitems      ON biblioitems.biblionumber =biblio.biblionumber
1062             LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_to = aqorders.ordernumber
1063         WHERE   basketno=?
1064             AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')
1065     ";
1066
1067     $orderby = "biblioitems.publishercode,biblio.title" unless $orderby;
1068     $query .= " ORDER BY $orderby";
1069     my $result_set =
1070       $dbh->selectall_arrayref( $query, { Slice => {} }, $basketno );
1071     return @{$result_set};
1072
1073 }
1074
1075 #------------------------------------------------------------#
1076 =head3 GetOrdersByBiblionumber
1077
1078   @orders = &GetOrdersByBiblionumber($biblionumber);
1079
1080 Looks up the orders with linked to a specific $biblionumber, including
1081 cancelled orders and received orders.
1082
1083 return :
1084 C<@orders> is an array of references-to-hash, whose keys are the
1085 fields from the aqorders, biblio, and biblioitems tables in the Koha database.
1086
1087 =cut
1088
1089 sub GetOrdersByBiblionumber {
1090     my $biblionumber = shift;
1091     return unless $biblionumber;
1092     my $dbh   = C4::Context->dbh;
1093     my $query  ="
1094         SELECT biblio.*,biblioitems.*,
1095                 aqorders.*,
1096                 aqbudgets.*
1097         FROM    aqorders
1098             LEFT JOIN aqbudgets        ON aqbudgets.budget_id = aqorders.budget_id
1099             LEFT JOIN biblio           ON biblio.biblionumber = aqorders.biblionumber
1100             LEFT JOIN biblioitems      ON biblioitems.biblionumber =biblio.biblionumber
1101         WHERE   aqorders.biblionumber=?
1102     ";
1103     my $result_set =
1104       $dbh->selectall_arrayref( $query, { Slice => {} }, $biblionumber );
1105     return @{$result_set};
1106
1107 }
1108
1109 #------------------------------------------------------------#
1110
1111 =head3 GetOrder
1112
1113   $order = &GetOrder($ordernumber);
1114
1115 Looks up an order by order number.
1116
1117 Returns a reference-to-hash describing the order. The keys of
1118 C<$order> are fields from the biblio, biblioitems, aqorders tables of the Koha database.
1119
1120 =cut
1121
1122 sub GetOrder {
1123     my ($ordernumber) = @_;
1124     return unless $ordernumber;
1125
1126     my $dbh      = C4::Context->dbh;
1127     my $query = qq{SELECT
1128                 aqorders.*,
1129                 biblio.title,
1130                 biblio.author,
1131                 aqbasket.basketname,
1132                 borrowers.branchcode,
1133                 biblioitems.publicationyear,
1134                 biblio.copyrightdate,
1135                 biblioitems.editionstatement,
1136                 biblioitems.isbn,
1137                 biblioitems.ean,
1138                 biblio.seriestitle,
1139                 biblioitems.publishercode,
1140                 aqorders.rrp              AS unitpricesupplier,
1141                 aqorders.ecost            AS unitpricelib,
1142                 aqorders.claims_count     AS claims_count,
1143                 aqorders.claimed_date     AS claimed_date,
1144                 aqbudgets.budget_name     AS budget,
1145                 aqbooksellers.name        AS supplier,
1146                 aqbooksellers.id          AS supplierid,
1147                 biblioitems.publishercode AS publisher,
1148                 ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) AS estimateddeliverydate,
1149                 DATE(aqbasket.closedate)  AS orderdate,
1150                 aqorders.quantity - COALESCE(aqorders.quantityreceived,0)                 AS quantity_to_receive,
1151                 (aqorders.quantity - COALESCE(aqorders.quantityreceived,0)) * aqorders.rrp AS subtotal,
1152                 DATEDIFF(CURDATE( ),closedate) AS latesince
1153                 FROM aqorders LEFT JOIN biblio ON biblio.biblionumber = aqorders.biblionumber
1154                 LEFT JOIN biblioitems ON biblioitems.biblionumber = biblio.biblionumber
1155                 LEFT JOIN aqbudgets ON aqorders.budget_id = aqbudgets.budget_id,
1156                 aqbasket LEFT JOIN borrowers  ON aqbasket.authorisedby = borrowers.borrowernumber
1157                 LEFT JOIN aqbooksellers       ON aqbasket.booksellerid = aqbooksellers.id
1158                 WHERE aqorders.basketno = aqbasket.basketno
1159                     AND ordernumber=?};
1160     my $result_set =
1161       $dbh->selectall_arrayref( $query, { Slice => {} }, $ordernumber );
1162
1163     # result_set assumed to contain 1 match
1164     return $result_set->[0];
1165 }
1166
1167 =head3 GetLastOrderNotReceivedFromSubscriptionid
1168
1169   $order = &GetLastOrderNotReceivedFromSubscriptionid($subscriptionid);
1170
1171 Returns a reference-to-hash describing the last order not received for a subscription.
1172
1173 =cut
1174
1175 sub GetLastOrderNotReceivedFromSubscriptionid {
1176     my ( $subscriptionid ) = @_;
1177     my $dbh                = C4::Context->dbh;
1178     my $query              = qq|
1179         SELECT * FROM aqorders
1180         LEFT JOIN subscription
1181             ON ( aqorders.subscriptionid = subscription.subscriptionid )
1182         WHERE aqorders.subscriptionid = ?
1183             AND aqorders.datereceived IS NULL
1184         LIMIT 1
1185     |;
1186     my $result_set =
1187       $dbh->selectall_arrayref( $query, { Slice => {} }, $subscriptionid );
1188
1189     # result_set assumed to contain 1 match
1190     return $result_set->[0];
1191 }
1192
1193 =head3 GetLastOrderReceivedFromSubscriptionid
1194
1195   $order = &GetLastOrderReceivedFromSubscriptionid($subscriptionid);
1196
1197 Returns a reference-to-hash describing the last order received for a subscription.
1198
1199 =cut
1200
1201 sub GetLastOrderReceivedFromSubscriptionid {
1202     my ( $subscriptionid ) = @_;
1203     my $dbh                = C4::Context->dbh;
1204     my $query              = qq|
1205         SELECT * FROM aqorders
1206         LEFT JOIN subscription
1207             ON ( aqorders.subscriptionid = subscription.subscriptionid )
1208         WHERE aqorders.subscriptionid = ?
1209             AND aqorders.datereceived =
1210                 (
1211                     SELECT MAX( aqorders.datereceived )
1212                     FROM aqorders
1213                     LEFT JOIN subscription
1214                         ON ( aqorders.subscriptionid = subscription.subscriptionid )
1215                         WHERE aqorders.subscriptionid = ?
1216                             AND aqorders.datereceived IS NOT NULL
1217                 )
1218         ORDER BY ordernumber DESC
1219         LIMIT 1
1220     |;
1221     my $result_set =
1222       $dbh->selectall_arrayref( $query, { Slice => {} }, $subscriptionid, $subscriptionid );
1223
1224     # result_set assumed to contain 1 match
1225     return $result_set->[0];
1226
1227 }
1228
1229
1230 #------------------------------------------------------------#
1231
1232 =head3 NewOrder
1233
1234   &NewOrder(\%hashref);
1235
1236 Adds a new order to the database. Any argument that isn't described
1237 below is the new value of the field with the same name in the aqorders
1238 table of the Koha database.
1239
1240 =over
1241
1242 =item $hashref->{'basketno'} is the basketno foreign key in aqorders, it is mandatory
1243
1244 =item $hashref->{'ordernumber'} is a "minimum order number."
1245
1246 =item $hashref->{'budgetdate'} is effectively ignored.
1247 If it's undef (anything false) or the string 'now', the current day is used.
1248 Else, the upcoming July 1st is used.
1249
1250 =item $hashref->{'subscription'} may be either "yes", or anything else for "no".
1251
1252 =item $hashref->{'uncertainprice'} may be 0 for "the price is known" or 1 for "the price is uncertain"
1253
1254 =item defaults entrydate to Now
1255
1256 The following keys are used: "biblionumber", "title", "basketno", "quantity", "order_vendornote", "order_internalnote", "rrp", "ecost", "gstrate", "unitprice", "subscription", "sort1", "sort2", "booksellerinvoicenumber", "listprice", "budgetdate", "purchaseordernumber", "branchcode", "booksellerinvoicenumber", "budget_id".
1257
1258 =back
1259
1260 =cut
1261
1262 sub NewOrder {
1263     my $orderinfo = shift;
1264
1265     my $dbh = C4::Context->dbh;
1266     my @params;
1267
1268
1269     # if these parameters are missing, we can't continue
1270     for my $key (qw/basketno quantity biblionumber budget_id/) {
1271         croak "Mandatory parameter $key missing" unless $orderinfo->{$key};
1272     }
1273
1274     if ( defined $orderinfo->{subscription} && $orderinfo->{'subscription'} eq 'yes' ) {
1275         $orderinfo->{'subscription'} = 1;
1276     } else {
1277         $orderinfo->{'subscription'} = 0;
1278     }
1279     $orderinfo->{'entrydate'} ||= C4::Dates->new()->output("iso");
1280     if (!$orderinfo->{quantityreceived}) {
1281         $orderinfo->{quantityreceived} = 0;
1282     }
1283
1284     my $ordernumber=InsertInTable("aqorders",$orderinfo);
1285     if (not $orderinfo->{parent_ordernumber}) {
1286         my $sth = $dbh->prepare("
1287             UPDATE aqorders
1288             SET parent_ordernumber = ordernumber
1289             WHERE ordernumber = ?
1290         ");
1291         $sth->execute($ordernumber);
1292     }
1293     return ( $orderinfo->{'basketno'}, $ordernumber );
1294 }
1295
1296
1297
1298 #------------------------------------------------------------#
1299
1300 =head3 NewOrderItem
1301
1302   &NewOrderItem();
1303
1304 =cut
1305
1306 sub NewOrderItem {
1307     my ($itemnumber, $ordernumber)  = @_;
1308     my $dbh = C4::Context->dbh;
1309     my $query = qq|
1310             INSERT INTO aqorders_items
1311                 (itemnumber, ordernumber)
1312             VALUES (?,?)    |;
1313
1314     my $sth = $dbh->prepare($query);
1315     $sth->execute( $itemnumber, $ordernumber);
1316 }
1317
1318 #------------------------------------------------------------#
1319
1320 =head3 ModOrder
1321
1322   &ModOrder(\%hashref);
1323
1324 Modifies an existing order. Updates the order with order number
1325 $hashref->{'ordernumber'} and biblionumber $hashref->{'biblionumber'}. All 
1326 other keys of the hash update the fields with the same name in the aqorders 
1327 table of the Koha database.
1328
1329 =cut
1330
1331 sub ModOrder {
1332     my $orderinfo = shift;
1333
1334     die "Ordernumber is required"     if $orderinfo->{'ordernumber'} eq  '' ;
1335     die "Biblionumber is required"  if  $orderinfo->{'biblionumber'} eq '';
1336
1337     my $dbh = C4::Context->dbh;
1338     my @params;
1339
1340     # update uncertainprice to an integer, just in case (under FF, checked boxes have the value "ON" by default)
1341     $orderinfo->{uncertainprice}=1 if $orderinfo->{uncertainprice};
1342
1343 #    delete($orderinfo->{'branchcode'});
1344     # the hash contains a lot of entries not in aqorders, so get the columns ...
1345     my $sth = $dbh->prepare("SELECT * FROM aqorders LIMIT 1;");
1346     $sth->execute;
1347     my $colnames = $sth->{NAME};
1348         #FIXME Be careful. If aqorders would have columns with diacritics,
1349         #you should need to decode what you get back from NAME.
1350         #See report 10110 and guided_reports.pl
1351     my $query = "UPDATE aqorders SET ";
1352
1353     foreach my $orderinfokey (grep(!/ordernumber/, keys %$orderinfo)){
1354         # ... and skip hash entries that are not in the aqorders table
1355         # FIXME : probably not the best way to do it (would be better to have a correct hash)
1356         next unless grep(/^$orderinfokey$/, @$colnames);
1357             $query .= "$orderinfokey=?, ";
1358             push(@params, $orderinfo->{$orderinfokey});
1359     }
1360
1361     $query .= "timestamp=NOW()  WHERE  ordernumber=?";
1362     push(@params, $orderinfo->{'ordernumber'} );
1363     $sth = $dbh->prepare($query);
1364     $sth->execute(@params);
1365     return;
1366 }
1367
1368 #------------------------------------------------------------#
1369
1370 =head3 ModItemOrder
1371
1372     ModItemOrder($itemnumber, $ordernumber);
1373
1374 Modifies the ordernumber of an item in aqorders_items.
1375
1376 =cut
1377
1378 sub ModItemOrder {
1379     my ($itemnumber, $ordernumber) = @_;
1380
1381     return unless ($itemnumber and $ordernumber);
1382
1383     my $dbh = C4::Context->dbh;
1384     my $query = qq{
1385         UPDATE aqorders_items
1386         SET ordernumber = ?
1387         WHERE itemnumber = ?
1388     };
1389     my $sth = $dbh->prepare($query);
1390     return $sth->execute($ordernumber, $itemnumber);
1391 }
1392
1393 #------------------------------------------------------------#
1394
1395 =head3 GetCancelledOrders
1396
1397   my @orders = GetCancelledOrders($basketno, $orderby);
1398
1399 Returns cancelled orders for a basket
1400
1401 =cut
1402
1403 sub GetCancelledOrders {
1404     my ( $basketno, $orderby ) = @_;
1405
1406     return () unless $basketno;
1407
1408     my $dbh   = C4::Context->dbh;
1409     my $query = "
1410         SELECT
1411             biblio.*,
1412             biblioitems.*,
1413             aqorders.*,
1414             aqbudgets.*,
1415             aqorders_transfers.ordernumber_to AS transferred_to,
1416             aqorders_transfers.timestamp AS transferred_to_timestamp
1417         FROM aqorders
1418           LEFT JOIN aqbudgets   ON aqbudgets.budget_id = aqorders.budget_id
1419           LEFT JOIN biblio      ON biblio.biblionumber = aqorders.biblionumber
1420           LEFT JOIN biblioitems ON biblioitems.biblionumber = biblio.biblionumber
1421           LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_from = aqorders.ordernumber
1422         WHERE basketno = ?
1423           AND (datecancellationprinted IS NOT NULL
1424                AND datecancellationprinted <> '0000-00-00')
1425     ";
1426
1427     $orderby = "aqorders.datecancellationprinted desc, aqorders.timestamp desc"
1428         unless $orderby;
1429     $query .= " ORDER BY $orderby";
1430     my $sth = $dbh->prepare($query);
1431     $sth->execute($basketno);
1432     my $results = $sth->fetchall_arrayref( {} );
1433
1434     return @$results;
1435 }
1436
1437
1438 #------------------------------------------------------------#
1439
1440 =head3 ModReceiveOrder
1441
1442   &ModReceiveOrder({
1443     biblionumber => $biblionumber,
1444     ordernumber => $ordernumber,
1445     quantityreceived => $quantityreceived,
1446     user => $user,
1447     cost => $cost,
1448     ecost => $ecost,
1449     invoiceid => $invoiceid,
1450     rrp => $rrp,
1451     budget_id => $budget_id,
1452     datereceived => $datereceived,
1453     received_itemnumbers => \@received_itemnumbers,
1454     order_internalnote => $order_internalnote,
1455     order_vendornote => $order_vendornote,
1456    });
1457
1458 Updates an order, to reflect the fact that it was received, at least
1459 in part. All arguments not mentioned below update the fields with the
1460 same name in the aqorders table of the Koha database.
1461
1462 If a partial order is received, splits the order into two.
1463
1464 Updates the order with bibilionumber C<$biblionumber> and ordernumber
1465 C<$ordernumber>.
1466
1467 =cut
1468
1469
1470 sub ModReceiveOrder {
1471     my ( $params ) = @_;
1472     my $biblionumber = $params->{biblionumber};
1473     my $ordernumber = $params->{ordernumber};
1474     my $quantrec = $params->{quantityreceived};
1475     my $user = $params->{user};
1476     my $cost = $params->{cost};
1477     my $ecost = $params->{ecost};
1478     my $invoiceid = $params->{invoiceid};
1479     my $rrp = $params->{rrp};
1480     my $budget_id = $params->{budget_id};
1481     my $datereceived = $params->{datereceived};
1482     my $received_items = $params->{received_items};
1483     my $order_internalnote = $params->{order_internalnote};
1484     my $order_vendornote = $params->{order_vendornote};
1485
1486     my $dbh = C4::Context->dbh;
1487     $datereceived = C4::Dates->output('iso') unless $datereceived;
1488     my $suggestionid = GetSuggestionFromBiblionumber( $biblionumber );
1489     if ($suggestionid) {
1490         ModSuggestion( {suggestionid=>$suggestionid,
1491                         STATUS=>'AVAILABLE',
1492                         biblionumber=> $biblionumber}
1493                         );
1494     }
1495
1496     my $result_set = $dbh->selectall_arrayref(
1497 q{SELECT * FROM aqorders WHERE biblionumber=? AND aqorders.ordernumber=?},
1498         { Slice => {} }, $biblionumber, $ordernumber
1499     );
1500
1501     # we assume we have a unique order
1502     my $order = $result_set->[0];
1503
1504     my $new_ordernumber = $ordernumber;
1505     if ( $order->{quantity} > $quantrec ) {
1506         # Split order line in two parts: the first is the original order line
1507         # without received items (the quantity is decreased),
1508         # the second part is a new order line with quantity=quantityrec
1509         # (entirely received)
1510         my $query = q|
1511             UPDATE aqorders
1512             SET quantity = ?,
1513                 orderstatus = 'partial'|;
1514         $query .= q|, order_internalnote = ?| if defined $order_internalnote;
1515         $query .= q|, order_vendornote = ?| if defined $order_vendornote;
1516         $query .= q| WHERE ordernumber = ?|;
1517         my $sth = $dbh->prepare($query);
1518
1519         $sth->execute(
1520             $order->{quantity} - $quantrec,
1521             ( defined $order_internalnote ? $order_internalnote : () ),
1522             ( defined $order_vendornote ? $order_vendornote : () ),
1523             $ordernumber
1524         );
1525
1526         delete $order->{'ordernumber'};
1527         $order->{'budget_id'} = ( $budget_id || $order->{'budget_id'} );
1528         $order->{'quantity'} = $quantrec;
1529         $order->{'quantityreceived'} = $quantrec;
1530         $order->{'datereceived'} = $datereceived;
1531         $order->{'invoiceid'} = $invoiceid;
1532         $order->{'unitprice'} = $cost;
1533         $order->{'rrp'} = $rrp;
1534         $order->{ecost} = $ecost;
1535         $order->{'orderstatus'} = 'complete';
1536         my $basketno;
1537         ( $basketno, $new_ordernumber ) = NewOrder($order);
1538
1539         if ($received_items) {
1540             foreach my $itemnumber (@$received_items) {
1541                 ModItemOrder($itemnumber, $new_ordernumber);
1542             }
1543         }
1544     } else {
1545         my $query = q|
1546             update aqorders
1547             set quantityreceived=?,datereceived=?,invoiceid=?,
1548                 unitprice=?,rrp=?,ecost=?,budget_id=?,orderstatus='complete'|;
1549         $query .= q|, order_internalnote = ?| if defined $order_internalnote;
1550         $query .= q|, order_vendornote = ?| if defined $order_vendornote;
1551         $query .= q| where biblionumber=? and ordernumber=?|;
1552         my $sth = $dbh->prepare( $query );
1553         $sth->execute(
1554             $quantrec,
1555             $datereceived,
1556             $invoiceid,
1557             $cost,
1558             $rrp,
1559             $ecost,
1560             $budget_id,
1561             ( defined $order_internalnote ? $order_internalnote : () ),
1562             ( defined $order_vendornote ? $order_vendornote : () ),
1563             $biblionumber,
1564             $ordernumber
1565         );
1566     }
1567     return ($datereceived, $new_ordernumber);
1568 }
1569
1570 =head3 CancelReceipt
1571
1572     my $parent_ordernumber = CancelReceipt($ordernumber);
1573
1574     Cancel an order line receipt and update the parent order line, as if no
1575     receipt was made.
1576     If items are created at receipt (AcqCreateItem = receiving) then delete
1577     these items.
1578
1579 =cut
1580
1581 sub CancelReceipt {
1582     my $ordernumber = shift;
1583
1584     return unless $ordernumber;
1585
1586     my $dbh = C4::Context->dbh;
1587     my $query = qq{
1588         SELECT datereceived, parent_ordernumber, quantity
1589         FROM aqorders
1590         WHERE ordernumber = ?
1591     };
1592     my $sth = $dbh->prepare($query);
1593     $sth->execute($ordernumber);
1594     my $order = $sth->fetchrow_hashref;
1595     unless($order) {
1596         warn "CancelReceipt: order $ordernumber does not exist";
1597         return;
1598     }
1599     unless($order->{'datereceived'}) {
1600         warn "CancelReceipt: order $ordernumber is not received";
1601         return;
1602     }
1603
1604     my $parent_ordernumber = $order->{'parent_ordernumber'};
1605
1606     if($parent_ordernumber == $ordernumber || not $parent_ordernumber) {
1607         # The order line has no parent, just mark it as not received
1608         $query = qq{
1609             UPDATE aqorders
1610             SET quantityreceived = ?,
1611                 datereceived = ?,
1612                 invoiceid = ?,
1613                 orderstatus = 'ordered'
1614             WHERE ordernumber = ?
1615         };
1616         $sth = $dbh->prepare($query);
1617         $sth->execute(0, undef, undef, $ordernumber);
1618     } else {
1619         # The order line has a parent, increase parent quantity and delete
1620         # the order line.
1621         $query = qq{
1622             SELECT quantity, datereceived
1623             FROM aqorders
1624             WHERE ordernumber = ?
1625         };
1626         $sth = $dbh->prepare($query);
1627         $sth->execute($parent_ordernumber);
1628         my $parent_order = $sth->fetchrow_hashref;
1629         unless($parent_order) {
1630             warn "Parent order $parent_ordernumber does not exist.";
1631             return;
1632         }
1633         if($parent_order->{'datereceived'}) {
1634             warn "CancelReceipt: parent order is received.".
1635                 " Can't cancel receipt.";
1636             return;
1637         }
1638         $query = qq{
1639             UPDATE aqorders
1640             SET quantity = ?,
1641                 orderstatus = 'ordered'
1642             WHERE ordernumber = ?
1643         };
1644         $sth = $dbh->prepare($query);
1645         my $rv = $sth->execute(
1646             $order->{'quantity'} + $parent_order->{'quantity'},
1647             $parent_ordernumber
1648         );
1649         unless($rv) {
1650             warn "Cannot update parent order line, so do not cancel".
1651                 " receipt";
1652             return;
1653         }
1654         if(C4::Context->preference('AcqCreateItem') eq 'receiving') {
1655             # Remove items that were created at receipt
1656             $query = qq{
1657                 DELETE FROM items, aqorders_items
1658                 USING items, aqorders_items
1659                 WHERE items.itemnumber = ? AND aqorders_items.itemnumber = ?
1660             };
1661             $sth = $dbh->prepare($query);
1662             my @itemnumbers = GetItemnumbersFromOrder($ordernumber);
1663             foreach my $itemnumber (@itemnumbers) {
1664                 $sth->execute($itemnumber, $itemnumber);
1665             }
1666         } else {
1667             # Update items
1668             my @itemnumbers = GetItemnumbersFromOrder($ordernumber);
1669             foreach my $itemnumber (@itemnumbers) {
1670                 ModItemOrder($itemnumber, $parent_ordernumber);
1671             }
1672         }
1673         # Delete order line
1674         $query = qq{
1675             DELETE FROM aqorders
1676             WHERE ordernumber = ?
1677         };
1678         $sth = $dbh->prepare($query);
1679         $sth->execute($ordernumber);
1680
1681     }
1682
1683     return $parent_ordernumber;
1684 }
1685
1686 #------------------------------------------------------------#
1687
1688 =head3 SearchOrders
1689
1690 @results = &SearchOrders({
1691     ordernumber => $ordernumber,
1692     search => $search,
1693     biblionumber => $biblionumber,
1694     ean => $ean,
1695     booksellerid => $booksellerid,
1696     basketno => $basketno,
1697     owner => $owner,
1698     pending => $pending
1699     ordered => $ordered
1700 });
1701
1702 Searches for orders.
1703
1704 C<$owner> Finds order for the logged in user.
1705 C<$pending> Finds pending orders. Ignores completed and cancelled orders.
1706 C<$ordered> Finds orders to receive only (status 'ordered' or 'partial').
1707
1708
1709 C<@results> is an array of references-to-hash with the keys are fields
1710 from aqorders, biblio, biblioitems and aqbasket tables.
1711
1712 =cut
1713
1714 sub SearchOrders {
1715     my ( $params ) = @_;
1716     my $ordernumber = $params->{ordernumber};
1717     my $search = $params->{search};
1718     my $ean = $params->{ean};
1719     my $booksellerid = $params->{booksellerid};
1720     my $basketno = $params->{basketno};
1721     my $basketname = $params->{basketname};
1722     my $basketgroupname = $params->{basketgroupname};
1723     my $owner = $params->{owner};
1724     my $pending = $params->{pending};
1725     my $ordered = $params->{ordered};
1726     my $biblionumber = $params->{biblionumber};
1727
1728     my $dbh = C4::Context->dbh;
1729     my @args = ();
1730     my $query = q{
1731         SELECT aqbasket.basketno,
1732                borrowers.surname,
1733                borrowers.firstname,
1734                biblio.*,
1735                biblioitems.isbn,
1736                biblioitems.biblioitemnumber,
1737                aqbasket.authorisedby,
1738                aqbasket.booksellerid,
1739                aqbasket.closedate,
1740                aqbasket.creationdate,
1741                aqbasket.basketname,
1742                aqbasketgroups.id as basketgroupid,
1743                aqbasketgroups.name as basketgroupname,
1744                aqorders.*
1745         FROM aqorders
1746             LEFT JOIN aqbasket ON aqorders.basketno = aqbasket.basketno
1747             LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid = aqbasketgroups.id
1748             LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
1749             LEFT JOIN biblio ON aqorders.biblionumber=biblio.biblionumber
1750             LEFT JOIN biblioitems ON biblioitems.biblionumber=biblio.biblionumber
1751     };
1752
1753     # If we search on ordernumber, we retrieve the transfered order if a transfer has been done.
1754     $query .= q{
1755             LEFT JOIN aqorders_transfers ON aqorders_transfers.ordernumber_to = aqorders.ordernumber
1756     } if $ordernumber;
1757
1758     $query .= q{
1759         WHERE (datecancellationprinted is NULL)
1760     };
1761
1762     if ( $pending or $ordered ) {
1763         $query .= q{ AND (quantity > quantityreceived OR quantityreceived is NULL)};
1764     }
1765     if ( $ordered ) {
1766         $query .= q{ AND aqorders.orderstatus IN ( "ordered", "partial" )};
1767     }
1768
1769     my $userenv = C4::Context->userenv;
1770     if ( C4::Context->preference("IndependentBranches") ) {
1771         unless ( C4::Context->IsSuperLibrarian() ) {
1772             $query .= q{
1773                 AND (
1774                     borrowers.branchcode = ?
1775                     OR borrowers.branchcode  = ''
1776                 )
1777             };
1778             push @args, $userenv->{branch};
1779         }
1780     }
1781
1782     if ( $ordernumber ) {
1783         $query .= ' AND ( aqorders.ordernumber = ? OR aqorders_transfers.ordernumber_from = ? ) ';
1784         push @args, ( $ordernumber, $ordernumber );
1785     }
1786     if ( $biblionumber ) {
1787         $query .= 'AND aqorders.biblionumber = ?';
1788         push @args, $biblionumber;
1789     }
1790     if( $search ) {
1791         $query .= ' AND (biblio.title LIKE ? OR biblio.author LIKE ? OR biblioitems.isbn LIKE ?)';
1792         push @args, ("%$search%","%$search%","%$search%");
1793     }
1794     if ( $ean ) {
1795         $query .= ' AND biblioitems.ean = ?';
1796         push @args, $ean;
1797     }
1798     if ( $booksellerid ) {
1799         $query .= 'AND aqbasket.booksellerid = ?';
1800         push @args, $booksellerid;
1801     }
1802     if( $basketno ) {
1803         $query .= 'AND aqbasket.basketno = ?';
1804         push @args, $basketno;
1805     }
1806     if( $basketname ) {
1807         $query .= 'AND aqbasket.basketname LIKE ?';
1808         push @args, "%$basketname%";
1809     }
1810     if( $basketgroupname ) {
1811         $query .= ' AND aqbasketgroups.name LIKE ?';
1812         push @args, "%$basketgroupname%";
1813     }
1814
1815     if ( $owner ) {
1816         $query .= ' AND aqbasket.authorisedby=? ';
1817         push @args, $userenv->{'number'};
1818     }
1819
1820     $query .= ' ORDER BY aqbasket.basketno';
1821
1822     my $sth = $dbh->prepare($query);
1823     $sth->execute(@args);
1824     return $sth->fetchall_arrayref({});
1825 }
1826
1827 #------------------------------------------------------------#
1828
1829 =head3 DelOrder
1830
1831   &DelOrder($biblionumber, $ordernumber);
1832
1833 Cancel the order with the given order and biblio numbers. It does not
1834 delete any entries in the aqorders table, it merely marks them as
1835 cancelled.
1836
1837 =cut
1838
1839 sub DelOrder {
1840     my ( $bibnum, $ordernumber ) = @_;
1841     my $dbh = C4::Context->dbh;
1842     my $query = "
1843         UPDATE aqorders
1844         SET    datecancellationprinted=now(), orderstatus='cancelled'
1845         WHERE  biblionumber=? AND ordernumber=?
1846     ";
1847     my $sth = $dbh->prepare($query);
1848     $sth->execute( $bibnum, $ordernumber );
1849     my @itemnumbers = GetItemnumbersFromOrder( $ordernumber );
1850     foreach my $itemnumber (@itemnumbers){
1851         C4::Items::DelItem( $dbh, $bibnum, $itemnumber );
1852     }
1853     return;
1854 }
1855
1856 =head3 TransferOrder
1857
1858     my $newordernumber = TransferOrder($ordernumber, $basketno);
1859
1860 Transfer an order line to a basket.
1861 Mark $ordernumber as cancelled with an internal note 'Cancelled and transfered
1862 to BOOKSELLER on DATE' and create new order with internal note
1863 'Transfered from BOOKSELLER on DATE'.
1864 Move all attached items to the new order.
1865 Received orders cannot be transfered.
1866 Return the ordernumber of created order.
1867
1868 =cut
1869
1870 sub TransferOrder {
1871     my ($ordernumber, $basketno) = @_;
1872
1873     return unless ($ordernumber and $basketno);
1874
1875     my $order = GetOrder( $ordernumber );
1876     return if $order->{datereceived};
1877     my $basket = GetBasket($basketno);
1878     return unless $basket;
1879
1880     my $dbh = C4::Context->dbh;
1881     my ($query, $sth, $rv);
1882
1883     $query = q{
1884         UPDATE aqorders
1885         SET datecancellationprinted = CAST(NOW() AS date)
1886         WHERE ordernumber = ?
1887     };
1888     $sth = $dbh->prepare($query);
1889     $rv = $sth->execute($ordernumber);
1890
1891     delete $order->{'ordernumber'};
1892     delete $order->{parent_ordernumber};
1893     $order->{'basketno'} = $basketno;
1894     my $newordernumber;
1895     (undef, $newordernumber) = NewOrder($order);
1896
1897     $query = q{
1898         UPDATE aqorders_items
1899         SET ordernumber = ?
1900         WHERE ordernumber = ?
1901     };
1902     $sth = $dbh->prepare($query);
1903     $sth->execute($newordernumber, $ordernumber);
1904
1905     $query = q{
1906         INSERT INTO aqorders_transfers (ordernumber_from, ordernumber_to)
1907         VALUES (?, ?)
1908     };
1909     $sth = $dbh->prepare($query);
1910     $sth->execute($ordernumber, $newordernumber);
1911
1912     return $newordernumber;
1913 }
1914
1915 =head2 FUNCTIONS ABOUT PARCELS
1916
1917 =cut
1918
1919 #------------------------------------------------------------#
1920
1921 =head3 GetParcel
1922
1923   @results = &GetParcel($booksellerid, $code, $date);
1924
1925 Looks up all of the received items from the supplier with the given
1926 bookseller ID at the given date, for the given code (bookseller Invoice number). Ignores cancelled and completed orders.
1927
1928 C<@results> is an array of references-to-hash. The keys of each element are fields from
1929 the aqorders, biblio, and biblioitems tables of the Koha database.
1930
1931 C<@results> is sorted alphabetically by book title.
1932
1933 =cut
1934
1935 sub GetParcel {
1936     #gets all orders from a certain supplier, orders them alphabetically
1937     my ( $supplierid, $code, $datereceived ) = @_;
1938     my $dbh     = C4::Context->dbh;
1939     my @results = ();
1940     $code .= '%'
1941     if $code;  # add % if we search on a given code (otherwise, let him empty)
1942     my $strsth ="
1943         SELECT  authorisedby,
1944                 creationdate,
1945                 aqbasket.basketno,
1946                 closedate,surname,
1947                 firstname,
1948                 aqorders.biblionumber,
1949                 aqorders.ordernumber,
1950                 aqorders.parent_ordernumber,
1951                 aqorders.quantity,
1952                 aqorders.quantityreceived,
1953                 aqorders.unitprice,
1954                 aqorders.listprice,
1955                 aqorders.rrp,
1956                 aqorders.ecost,
1957                 aqorders.gstrate,
1958                 biblio.title
1959         FROM aqorders
1960         LEFT JOIN aqbasket ON aqbasket.basketno=aqorders.basketno
1961         LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
1962         LEFT JOIN biblio ON aqorders.biblionumber=biblio.biblionumber
1963         LEFT JOIN aqinvoices ON aqorders.invoiceid = aqinvoices.invoiceid
1964         WHERE
1965             aqbasket.booksellerid = ?
1966             AND aqinvoices.invoicenumber LIKE ?
1967             AND aqorders.datereceived = ? ";
1968
1969     my @query_params = ( $supplierid, $code, $datereceived );
1970     if ( C4::Context->preference("IndependentBranches") ) {
1971         unless ( C4::Context->IsSuperLibrarian() ) {
1972             $strsth .= " and (borrowers.branchcode = ?
1973                         or borrowers.branchcode  = '')";
1974             push @query_params, C4::Context->userenv->{branch};
1975         }
1976     }
1977     $strsth .= " ORDER BY aqbasket.basketno";
1978     my $result_set = $dbh->selectall_arrayref(
1979         $strsth,
1980         { Slice => {} },
1981         @query_params);
1982
1983     return @{$result_set};
1984 }
1985
1986 #------------------------------------------------------------#
1987
1988 =head3 GetParcels
1989
1990   $results = &GetParcels($bookseller, $order, $code, $datefrom, $dateto);
1991
1992 get a lists of parcels.
1993
1994 * Input arg :
1995
1996 =over
1997
1998 =item $bookseller
1999 is the bookseller this function has to get parcels.
2000
2001 =item $order
2002 To know on what criteria the results list has to be ordered.
2003
2004 =item $code
2005 is the booksellerinvoicenumber.
2006
2007 =item $datefrom & $dateto
2008 to know on what date this function has to filter its search.
2009
2010 =back
2011
2012 * return:
2013 a pointer on a hash list containing parcel informations as such :
2014
2015 =over
2016
2017 =item Creation date
2018
2019 =item Last operation
2020
2021 =item Number of biblio
2022
2023 =item Number of items
2024
2025 =back
2026
2027 =cut
2028
2029 sub GetParcels {
2030     my ($bookseller,$order, $code, $datefrom, $dateto) = @_;
2031     my $dbh    = C4::Context->dbh;
2032     my @query_params = ();
2033     my $strsth ="
2034         SELECT  aqinvoices.invoicenumber,
2035                 datereceived,purchaseordernumber,
2036                 count(DISTINCT biblionumber) AS biblio,
2037                 sum(quantity) AS itemsexpected,
2038                 sum(quantityreceived) AS itemsreceived
2039         FROM   aqorders LEFT JOIN aqbasket ON aqbasket.basketno = aqorders.basketno
2040         LEFT JOIN aqinvoices ON aqorders.invoiceid = aqinvoices.invoiceid
2041         WHERE aqbasket.booksellerid = ? and datereceived IS NOT NULL
2042     ";
2043     push @query_params, $bookseller;
2044
2045     if ( defined $code ) {
2046         $strsth .= ' and aqinvoices.invoicenumber like ? ';
2047         # add a % to the end of the code to allow stemming.
2048         push @query_params, "$code%";
2049     }
2050
2051     if ( defined $datefrom ) {
2052         $strsth .= ' and datereceived >= ? ';
2053         push @query_params, $datefrom;
2054     }
2055
2056     if ( defined $dateto ) {
2057         $strsth .=  'and datereceived <= ? ';
2058         push @query_params, $dateto;
2059     }
2060
2061     $strsth .= "group by aqinvoices.invoicenumber,datereceived ";
2062
2063     # can't use a placeholder to place this column name.
2064     # but, we could probably be checking to make sure it is a column that will be fetched.
2065     $strsth .= "order by $order " if ($order);
2066
2067     my $sth = $dbh->prepare($strsth);
2068
2069     $sth->execute( @query_params );
2070     my $results = $sth->fetchall_arrayref({});
2071     return @{$results};
2072 }
2073
2074 #------------------------------------------------------------#
2075
2076 =head3 GetLateOrders
2077
2078   @results = &GetLateOrders;
2079
2080 Searches for bookseller with late orders.
2081
2082 return:
2083 the table of supplier with late issues. This table is full of hashref.
2084
2085 =cut
2086
2087 sub GetLateOrders {
2088     my $delay      = shift;
2089     my $supplierid = shift;
2090     my $branch     = shift;
2091     my $estimateddeliverydatefrom = shift;
2092     my $estimateddeliverydateto = shift;
2093
2094     my $dbh = C4::Context->dbh;
2095
2096     #BEWARE, order of parenthesis and LEFT JOIN is important for speed
2097     my $dbdriver = C4::Context->config("db_scheme") || "mysql";
2098
2099     my @query_params = ();
2100     my $select = "
2101     SELECT aqbasket.basketno,
2102         aqorders.ordernumber,
2103         DATE(aqbasket.closedate)  AS orderdate,
2104         aqbasket.basketname       AS basketname,
2105         aqbasket.basketgroupid    AS basketgroupid,
2106         aqbasketgroups.name       AS basketgroupname,
2107         aqorders.rrp              AS unitpricesupplier,
2108         aqorders.ecost            AS unitpricelib,
2109         aqorders.claims_count     AS claims_count,
2110         aqorders.claimed_date     AS claimed_date,
2111         aqbudgets.budget_name     AS budget,
2112         borrowers.branchcode      AS branch,
2113         aqbooksellers.name        AS supplier,
2114         aqbooksellers.id          AS supplierid,
2115         biblio.author, biblio.title,
2116         biblioitems.publishercode AS publisher,
2117         biblioitems.publicationyear,
2118         ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) AS estimateddeliverydate,
2119     ";
2120     my $from = "
2121     FROM
2122         aqorders LEFT JOIN biblio     ON biblio.biblionumber         = aqorders.biblionumber
2123         LEFT JOIN biblioitems         ON biblioitems.biblionumber    = biblio.biblionumber
2124         LEFT JOIN aqbudgets           ON aqorders.budget_id          = aqbudgets.budget_id,
2125         aqbasket LEFT JOIN borrowers  ON aqbasket.authorisedby       = borrowers.borrowernumber
2126         LEFT JOIN aqbooksellers       ON aqbasket.booksellerid       = aqbooksellers.id
2127         LEFT JOIN aqbasketgroups      ON aqbasket.basketgroupid      = aqbasketgroups.id
2128         WHERE aqorders.basketno = aqbasket.basketno
2129         AND ( datereceived = ''
2130             OR datereceived IS NULL
2131             OR aqorders.quantityreceived < aqorders.quantity
2132         )
2133         AND aqbasket.closedate IS NOT NULL
2134         AND (aqorders.datecancellationprinted IS NULL OR aqorders.datecancellationprinted='0000-00-00')
2135     ";
2136     my $having = "";
2137     if ($dbdriver eq "mysql") {
2138         $select .= "
2139         aqorders.quantity - COALESCE(aqorders.quantityreceived,0)                 AS quantity,
2140         (aqorders.quantity - COALESCE(aqorders.quantityreceived,0)) * aqorders.rrp AS subtotal,
2141         DATEDIFF(CAST(now() AS date),closedate) AS latesince
2142         ";
2143         if ( defined $delay ) {
2144             $from .= " AND (closedate <= DATE_SUB(CAST(now() AS date),INTERVAL ? DAY)) " ;
2145             push @query_params, $delay;
2146         }
2147         $having = "
2148         HAVING quantity          <> 0
2149             AND unitpricesupplier <> 0
2150             AND unitpricelib      <> 0
2151         ";
2152     } else {
2153         # FIXME: account for IFNULL as above
2154         $select .= "
2155                 aqorders.quantity                AS quantity,
2156                 aqorders.quantity * aqorders.rrp AS subtotal,
2157                 (CAST(now() AS date) - closedate)            AS latesince
2158         ";
2159         if ( defined $delay ) {
2160             $from .= " AND (closedate <= (CAST(now() AS date) -(INTERVAL ? DAY)) ";
2161             push @query_params, $delay;
2162         }
2163     }
2164     if (defined $supplierid) {
2165         $from .= ' AND aqbasket.booksellerid = ? ';
2166         push @query_params, $supplierid;
2167     }
2168     if (defined $branch) {
2169         $from .= ' AND borrowers.branchcode LIKE ? ';
2170         push @query_params, $branch;
2171     }
2172
2173     if ( defined $estimateddeliverydatefrom or defined $estimateddeliverydateto ) {
2174         $from .= ' AND aqbooksellers.deliverytime IS NOT NULL ';
2175     }
2176     if ( defined $estimateddeliverydatefrom ) {
2177         $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) >= ?';
2178         push @query_params, $estimateddeliverydatefrom;
2179     }
2180     if ( defined $estimateddeliverydateto ) {
2181         $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) <= ?';
2182         push @query_params, $estimateddeliverydateto;
2183     }
2184     if ( defined $estimateddeliverydatefrom and not defined $estimateddeliverydateto ) {
2185         $from .= ' AND ADDDATE(aqbasket.closedate, INTERVAL aqbooksellers.deliverytime DAY) <= CAST(now() AS date)';
2186     }
2187     if (C4::Context->preference("IndependentBranches")
2188             && !C4::Context->IsSuperLibrarian() ) {
2189         $from .= ' AND borrowers.branchcode LIKE ? ';
2190         push @query_params, C4::Context->userenv->{branch};
2191     }
2192     $from .= " AND orderstatus <> 'cancelled' ";
2193     my $query = "$select $from $having\nORDER BY latesince, basketno, borrowers.branchcode, supplier";
2194     $debug and print STDERR "GetLateOrders query: $query\nGetLateOrders args: " . join(" ",@query_params);
2195     my $sth = $dbh->prepare($query);
2196     $sth->execute(@query_params);
2197     my @results;
2198     while (my $data = $sth->fetchrow_hashref) {
2199         push @results, $data;
2200     }
2201     return @results;
2202 }
2203
2204 #------------------------------------------------------------#
2205
2206 =head3 GetHistory
2207
2208   (\@order_loop, $total_qty, $total_price, $total_qtyreceived) = GetHistory( %params );
2209
2210 Retreives some acquisition history information
2211
2212 params:  
2213   title
2214   author
2215   name
2216   isbn
2217   ean
2218   from_placed_on
2219   to_placed_on
2220   basket                  - search both basket name and number
2221   booksellerinvoicenumber 
2222   basketgroupname
2223   budget
2224   orderstatus (note that orderstatus '' will retrieve orders
2225                of any status except cancelled)
2226   biblionumber
2227   get_canceled_order (if set to a true value, cancelled orders will
2228                       be included)
2229
2230 returns:
2231     $order_loop is a list of hashrefs that each look like this:
2232             {
2233                 'author'           => 'Twain, Mark',
2234                 'basketno'         => '1',
2235                 'biblionumber'     => '215',
2236                 'count'            => 1,
2237                 'creationdate'     => 'MM/DD/YYYY',
2238                 'datereceived'     => undef,
2239                 'ecost'            => '1.00',
2240                 'id'               => '1',
2241                 'invoicenumber'    => undef,
2242                 'name'             => '',
2243                 'ordernumber'      => '1',
2244                 'quantity'         => 1,
2245                 'quantityreceived' => undef,
2246                 'title'            => 'The Adventures of Huckleberry Finn'
2247             }
2248     $total_qty is the sum of all of the quantities in $order_loop
2249     $total_price is the cost of each in $order_loop times the quantity
2250     $total_qtyreceived is the sum of all of the quantityreceived entries in $order_loop
2251
2252 =cut
2253
2254 sub GetHistory {
2255 # don't run the query if there are no parameters (list would be too long for sure !)
2256     croak "No search params" unless @_;
2257     my %params = @_;
2258     my $title = $params{title};
2259     my $author = $params{author};
2260     my $isbn   = $params{isbn};
2261     my $ean    = $params{ean};
2262     my $name = $params{name};
2263     my $from_placed_on = $params{from_placed_on};
2264     my $to_placed_on = $params{to_placed_on};
2265     my $basket = $params{basket};
2266     my $booksellerinvoicenumber = $params{booksellerinvoicenumber};
2267     my $basketgroupname = $params{basketgroupname};
2268     my $budget = $params{budget};
2269     my $orderstatus = $params{orderstatus};
2270     my $biblionumber = $params{biblionumber};
2271     my $get_canceled_order = $params{get_canceled_order} || 0;
2272     my $ordernumber = $params{ordernumber};
2273     my $search_children_too = $params{search_children_too} || 0;
2274
2275     my @order_loop;
2276     my $total_qty         = 0;
2277     my $total_qtyreceived = 0;
2278     my $total_price       = 0;
2279
2280     my $dbh   = C4::Context->dbh;
2281     my $query ="
2282         SELECT
2283             COALESCE(biblio.title,     deletedbiblio.title)     AS title,
2284             COALESCE(biblio.author,    deletedbiblio.author)    AS author,
2285             COALESCE(biblioitems.isbn, deletedbiblioitems.isbn) AS isbn,
2286             COALESCE(biblioitems.ean,  deletedbiblioitems.ean)  AS ean,
2287             aqorders.basketno,
2288             aqbasket.basketname,
2289             aqbasket.basketgroupid,
2290             aqbasketgroups.name as groupname,
2291             aqbooksellers.name,
2292             aqbasket.creationdate,
2293             aqorders.datereceived,
2294             aqorders.quantity,
2295             aqorders.quantityreceived,
2296             aqorders.ecost,
2297             aqorders.ordernumber,
2298             aqorders.invoiceid,
2299             aqinvoices.invoicenumber,
2300             aqbooksellers.id as id,
2301             aqorders.biblionumber,
2302             aqorders.orderstatus,
2303             aqorders.parent_ordernumber,
2304             aqbudgets.budget_name
2305             ";
2306     $query .= ", aqbudgets.budget_id AS budget" if defined $budget;
2307     $query .= "
2308         FROM aqorders
2309         LEFT JOIN aqbasket ON aqorders.basketno=aqbasket.basketno
2310         LEFT JOIN aqbasketgroups ON aqbasket.basketgroupid=aqbasketgroups.id
2311         LEFT JOIN aqbooksellers ON aqbasket.booksellerid=aqbooksellers.id
2312         LEFT JOIN biblioitems ON biblioitems.biblionumber=aqorders.biblionumber
2313         LEFT JOIN biblio ON biblio.biblionumber=aqorders.biblionumber
2314         LEFT JOIN aqbudgets ON aqorders.budget_id=aqbudgets.budget_id
2315         LEFT JOIN aqinvoices ON aqorders.invoiceid = aqinvoices.invoiceid
2316         LEFT JOIN deletedbiblio ON deletedbiblio.biblionumber=aqorders.biblionumber
2317         LEFT JOIN deletedbiblioitems ON deletedbiblioitems.biblionumber=aqorders.biblionumber
2318         ";
2319
2320     if ( C4::Context->preference("IndependentBranches") ) {
2321         $query .= " LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber";
2322     }
2323
2324     $query .= " WHERE 1 ";
2325
2326     unless ($get_canceled_order or (defined $orderstatus and $orderstatus eq 'cancelled')) {
2327         $query .= " AND (datecancellationprinted is NULL or datecancellationprinted='0000-00-00') ";
2328     }
2329
2330     my @query_params  = ();
2331
2332     if ( $biblionumber ) {
2333         $query .= " AND biblio.biblionumber = ?";
2334         push @query_params, $biblionumber;
2335     }
2336
2337     if ( $title ) {
2338         $query .= " AND biblio.title LIKE ? ";
2339         $title =~ s/\s+/%/g;
2340         push @query_params, "%$title%";
2341     }
2342
2343     if ( $author ) {
2344         $query .= " AND biblio.author LIKE ? ";
2345         push @query_params, "%$author%";
2346     }
2347
2348     if ( $isbn ) {
2349         $query .= " AND biblioitems.isbn LIKE ? ";
2350         push @query_params, "%$isbn%";
2351     }
2352     if ( $ean ) {
2353         $query .= " AND biblioitems.ean = ? ";
2354         push @query_params, "$ean";
2355     }
2356     if ( $name ) {
2357         $query .= " AND aqbooksellers.name LIKE ? ";
2358         push @query_params, "%$name%";
2359     }
2360
2361     if ( $budget ) {
2362         $query .= " AND aqbudgets.budget_id = ? ";
2363         push @query_params, "$budget";
2364     }
2365
2366     if ( $from_placed_on ) {
2367         $query .= " AND creationdate >= ? ";
2368         push @query_params, $from_placed_on;
2369     }
2370
2371     if ( $to_placed_on ) {
2372         $query .= " AND creationdate <= ? ";
2373         push @query_params, $to_placed_on;
2374     }
2375
2376     if ( defined $orderstatus and $orderstatus ne '') {
2377         $query .= " AND aqorders.orderstatus = ? ";
2378         push @query_params, "$orderstatus";
2379     }
2380
2381     if ($basket) {
2382         if ($basket =~ m/^\d+$/) {
2383             $query .= " AND aqorders.basketno = ? ";
2384             push @query_params, $basket;
2385         } else {
2386             $query .= " AND aqbasket.basketname LIKE ? ";
2387             push @query_params, "%$basket%";
2388         }
2389     }
2390
2391     if ($booksellerinvoicenumber) {
2392         $query .= " AND aqinvoices.invoicenumber LIKE ? ";
2393         push @query_params, "%$booksellerinvoicenumber%";
2394     }
2395
2396     if ($basketgroupname) {
2397         $query .= " AND aqbasketgroups.name LIKE ? ";
2398         push @query_params, "%$basketgroupname%";
2399     }
2400
2401     if ($ordernumber) {
2402         $query .= " AND (aqorders.ordernumber = ? ";
2403         push @query_params, $ordernumber;
2404         if ($search_children_too) {
2405             $query .= " OR aqorders.parent_ordernumber = ? ";
2406             push @query_params, $ordernumber;
2407         }
2408         $query .= ") ";
2409     }
2410
2411
2412     if ( C4::Context->preference("IndependentBranches") ) {
2413         unless ( C4::Context->IsSuperLibrarian() ) {
2414             $query .= " AND (borrowers.branchcode = ? OR borrowers.branchcode ='' ) ";
2415             push @query_params, C4::Context->userenv->{branch};
2416         }
2417     }
2418     $query .= " ORDER BY id";
2419     my $sth = $dbh->prepare($query);
2420     $sth->execute( @query_params );
2421     my $cnt = 1;
2422     while ( my $line = $sth->fetchrow_hashref ) {
2423         $line->{count} = $cnt++;
2424         $line->{toggle} = 1 if $cnt % 2;
2425         push @order_loop, $line;
2426         $total_qty         += ( $line->{quantity} ) ? $line->{quantity} : 0;
2427         $total_qtyreceived += ( $line->{quantityreceived} ) ? $line->{quantityreceived} : 0;
2428         $total_price       += ( $line->{quantity} and $line->{ecost} ) ? $line->{quantity} * $line->{ecost} : 0;
2429     }
2430     return \@order_loop, $total_qty, $total_price, $total_qtyreceived;
2431 }
2432
2433 =head2 GetRecentAcqui
2434
2435   $results = GetRecentAcqui($days);
2436
2437 C<$results> is a ref to a table which containts hashref
2438
2439 =cut
2440
2441 sub GetRecentAcqui {
2442     my $limit  = shift;
2443     my $dbh    = C4::Context->dbh;
2444     my $query = "
2445         SELECT *
2446         FROM   biblio
2447         ORDER BY timestamp DESC
2448         LIMIT  0,".$limit;
2449
2450     my $sth = $dbh->prepare($query);
2451     $sth->execute;
2452     my $results = $sth->fetchall_arrayref({});
2453     return $results;
2454 }
2455
2456 =head3 GetContracts
2457
2458   $contractlist = &GetContracts($booksellerid, $activeonly);
2459
2460 Looks up the contracts that belong to a bookseller
2461
2462 Returns a list of contracts
2463
2464 =over
2465
2466 =item C<$booksellerid> is the "id" field in the "aqbooksellers" table.
2467
2468 =item C<$activeonly> if exists get only contracts that are still active.
2469
2470 =back
2471
2472 =cut
2473
2474 sub GetContracts {
2475     my ( $booksellerid, $activeonly ) = @_;
2476     my $dbh = C4::Context->dbh;
2477     my $query;
2478     if (! $activeonly) {
2479         $query = "
2480             SELECT *
2481             FROM   aqcontract
2482             WHERE  booksellerid=?
2483         ";
2484     } else {
2485         $query = "SELECT *
2486             FROM aqcontract
2487             WHERE booksellerid=?
2488                 AND contractenddate >= CURDATE( )";
2489     }
2490     my $result_set =
2491       $dbh->selectall_arrayref( $query, { Slice => {} }, $booksellerid );
2492     return @{$result_set};
2493 }
2494
2495 #------------------------------------------------------------#
2496
2497 =head3 GetContract
2498
2499   $contract = &GetContract($contractID);
2500
2501 Looks up the contract that has PRIMKEY (contractnumber) value $contractID
2502
2503 Returns a contract
2504
2505 =cut
2506
2507 sub GetContract {
2508     my ( $contractno ) = @_;
2509     my $dbh = C4::Context->dbh;
2510     my $query = "
2511         SELECT *
2512         FROM   aqcontract
2513         WHERE  contractnumber=?
2514         ";
2515
2516     my $sth = $dbh->prepare($query);
2517     $sth->execute( $contractno );
2518     my $result = $sth->fetchrow_hashref;
2519     return $result;
2520 }
2521
2522 =head3 AddClaim
2523
2524 =over
2525
2526 &AddClaim($ordernumber);
2527
2528 Add a claim for an order
2529
2530 =back
2531
2532 =cut
2533
2534 sub AddClaim {
2535     my ($ordernumber) = @_;
2536     my $dbh          = C4::Context->dbh;
2537     my $query        = "
2538         UPDATE aqorders SET
2539             claims_count = claims_count + 1,
2540             claimed_date = CURDATE()
2541         WHERE ordernumber = ?
2542         ";
2543     my $sth = $dbh->prepare($query);
2544     $sth->execute($ordernumber);
2545 }
2546
2547 =head3 GetInvoices
2548
2549     my @invoices = GetInvoices(
2550         invoicenumber => $invoicenumber,
2551         supplierid => $supplierid,
2552         suppliername => $suppliername,
2553         shipmentdatefrom => $shipmentdatefrom, # ISO format
2554         shipmentdateto => $shipmentdateto, # ISO format
2555         billingdatefrom => $billingdatefrom, # ISO format
2556         billingdateto => $billingdateto, # ISO format
2557         isbneanissn => $isbn_or_ean_or_issn,
2558         title => $title,
2559         author => $author,
2560         publisher => $publisher,
2561         publicationyear => $publicationyear,
2562         branchcode => $branchcode,
2563         order_by => $order_by
2564     );
2565
2566 Return a list of invoices that match all given criteria.
2567
2568 $order_by is "column_name (asc|desc)", where column_name is any of
2569 'invoicenumber', 'booksellerid', 'shipmentdate', 'billingdate', 'closedate',
2570 'shipmentcost', 'shipmentcost_budgetid'.
2571
2572 asc is the default if omitted
2573
2574 =cut
2575
2576 sub GetInvoices {
2577     my %args = @_;
2578
2579     my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2580         closedate shipmentcost shipmentcost_budgetid);
2581
2582     my $dbh = C4::Context->dbh;
2583     my $query = qq{
2584         SELECT aqinvoices.*, aqbooksellers.name AS suppliername,
2585           COUNT(
2586             DISTINCT IF(
2587               aqorders.datereceived IS NOT NULL,
2588               aqorders.biblionumber,
2589               NULL
2590             )
2591           ) AS receivedbiblios,
2592           COUNT(
2593              DISTINCT IF(
2594               aqorders.subscriptionid IS NOT NULL,
2595               aqorders.subscriptionid,
2596               NULL
2597             )
2598           ) AS is_linked_to_subscriptions,
2599           SUM(aqorders.quantityreceived) AS receiveditems
2600         FROM aqinvoices
2601           LEFT JOIN aqbooksellers ON aqbooksellers.id = aqinvoices.booksellerid
2602           LEFT JOIN aqorders ON aqorders.invoiceid = aqinvoices.invoiceid
2603           LEFT JOIN aqbasket ON aqbasket.basketno=aqorders.basketno
2604           LEFT JOIN borrowers ON aqbasket.authorisedby=borrowers.borrowernumber
2605           LEFT JOIN biblio ON aqorders.biblionumber = biblio.biblionumber
2606           LEFT JOIN biblioitems ON biblio.biblionumber = biblioitems.biblionumber
2607           LEFT JOIN subscription ON biblio.biblionumber = subscription.biblionumber
2608     };
2609
2610     my @bind_args;
2611     my @bind_strs;
2612     if($args{supplierid}) {
2613         push @bind_strs, " aqinvoices.booksellerid = ? ";
2614         push @bind_args, $args{supplierid};
2615     }
2616     if($args{invoicenumber}) {
2617         push @bind_strs, " aqinvoices.invoicenumber LIKE ? ";
2618         push @bind_args, "%$args{invoicenumber}%";
2619     }
2620     if($args{suppliername}) {
2621         push @bind_strs, " aqbooksellers.name LIKE ? ";
2622         push @bind_args, "%$args{suppliername}%";
2623     }
2624     if($args{shipmentdatefrom}) {
2625         push @bind_strs, " aqinvoices.shipmentdate >= ? ";
2626         push @bind_args, $args{shipmentdatefrom};
2627     }
2628     if($args{shipmentdateto}) {
2629         push @bind_strs, " aqinvoices.shipmentdate <= ? ";
2630         push @bind_args, $args{shipmentdateto};
2631     }
2632     if($args{billingdatefrom}) {
2633         push @bind_strs, " aqinvoices.billingdate >= ? ";
2634         push @bind_args, $args{billingdatefrom};
2635     }
2636     if($args{billingdateto}) {
2637         push @bind_strs, " aqinvoices.billingdate <= ? ";
2638         push @bind_args, $args{billingdateto};
2639     }
2640     if($args{isbneanissn}) {
2641         push @bind_strs, " (biblioitems.isbn LIKE CONCAT('%', ?, '%') OR biblioitems.ean LIKE CONCAT('%', ?, '%') OR biblioitems.issn LIKE CONCAT('%', ?, '%') ) ";
2642         push @bind_args, $args{isbneanissn}, $args{isbneanissn}, $args{isbneanissn};
2643     }
2644     if($args{title}) {
2645         push @bind_strs, " biblio.title LIKE CONCAT('%', ?, '%') ";
2646         push @bind_args, $args{title};
2647     }
2648     if($args{author}) {
2649         push @bind_strs, " biblio.author LIKE CONCAT('%', ?, '%') ";
2650         push @bind_args, $args{author};
2651     }
2652     if($args{publisher}) {
2653         push @bind_strs, " biblioitems.publishercode LIKE CONCAT('%', ?, '%') ";
2654         push @bind_args, $args{publisher};
2655     }
2656     if($args{publicationyear}) {
2657         push @bind_strs, " ((biblioitems.publicationyear LIKE CONCAT('%', ?, '%')) OR (biblio.copyrightdate LIKE CONCAT('%', ?, '%'))) ";
2658         push @bind_args, $args{publicationyear}, $args{publicationyear};
2659     }
2660     if($args{branchcode}) {
2661         push @bind_strs, " borrowers.branchcode = ? ";
2662         push @bind_args, $args{branchcode};
2663     }
2664
2665     $query .= " WHERE " . join(" AND ", @bind_strs) if @bind_strs;
2666     $query .= " GROUP BY aqinvoices.invoiceid ";
2667
2668     if($args{order_by}) {
2669         my ($column, $direction) = split / /, $args{order_by};
2670         if(grep /^$column$/, @columns) {
2671             $direction ||= 'ASC';
2672             $query .= " ORDER BY $column $direction";
2673         }
2674     }
2675
2676     my $sth = $dbh->prepare($query);
2677     $sth->execute(@bind_args);
2678
2679     my $results = $sth->fetchall_arrayref({});
2680     return @$results;
2681 }
2682
2683 =head3 GetInvoice
2684
2685     my $invoice = GetInvoice($invoiceid);
2686
2687 Get informations about invoice with given $invoiceid
2688
2689 Return a hash filled with aqinvoices.* fields
2690
2691 =cut
2692
2693 sub GetInvoice {
2694     my ($invoiceid) = @_;
2695     my $invoice;
2696
2697     return unless $invoiceid;
2698
2699     my $dbh = C4::Context->dbh;
2700     my $query = qq{
2701         SELECT *
2702         FROM aqinvoices
2703         WHERE invoiceid = ?
2704     };
2705     my $sth = $dbh->prepare($query);
2706     $sth->execute($invoiceid);
2707
2708     $invoice = $sth->fetchrow_hashref;
2709     return $invoice;
2710 }
2711
2712 =head3 GetInvoiceDetails
2713
2714     my $invoice = GetInvoiceDetails($invoiceid)
2715
2716 Return informations about an invoice + the list of related order lines
2717
2718 Orders informations are in $invoice->{orders} (array ref)
2719
2720 =cut
2721
2722 sub GetInvoiceDetails {
2723     my ($invoiceid) = @_;
2724
2725     if ( !defined $invoiceid ) {
2726         carp 'GetInvoiceDetails called without an invoiceid';
2727         return;
2728     }
2729
2730     my $dbh = C4::Context->dbh;
2731     my $query = q{
2732         SELECT aqinvoices.*, aqbooksellers.name AS suppliername
2733         FROM aqinvoices
2734           LEFT JOIN aqbooksellers ON aqinvoices.booksellerid = aqbooksellers.id
2735         WHERE invoiceid = ?
2736     };
2737     my $sth = $dbh->prepare($query);
2738     $sth->execute($invoiceid);
2739
2740     my $invoice = $sth->fetchrow_hashref;
2741
2742     $query = q{
2743         SELECT aqorders.*, biblio.*, aqbasket.basketname
2744         FROM aqorders
2745           LEFT JOIN aqbasket ON aqorders.basketno = aqbasket.basketno
2746           LEFT JOIN biblio ON aqorders.biblionumber = biblio.biblionumber
2747         WHERE invoiceid = ?
2748     };
2749     $sth = $dbh->prepare($query);
2750     $sth->execute($invoiceid);
2751     $invoice->{orders} = $sth->fetchall_arrayref({});
2752     $invoice->{orders} ||= []; # force an empty arrayref if fetchall_arrayref fails
2753
2754     return $invoice;
2755 }
2756
2757 =head3 AddInvoice
2758
2759     my $invoiceid = AddInvoice(
2760         invoicenumber => $invoicenumber,
2761         booksellerid => $booksellerid,
2762         shipmentdate => $shipmentdate,
2763         billingdate => $billingdate,
2764         closedate => $closedate,
2765         shipmentcost => $shipmentcost,
2766         shipmentcost_budgetid => $shipmentcost_budgetid
2767     );
2768
2769 Create a new invoice and return its id or undef if it fails.
2770
2771 =cut
2772
2773 sub AddInvoice {
2774     my %invoice = @_;
2775
2776     return unless(%invoice and $invoice{invoicenumber});
2777
2778     my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2779         closedate shipmentcost shipmentcost_budgetid);
2780
2781     my @set_strs;
2782     my @set_args;
2783     foreach my $key (keys %invoice) {
2784         if(0 < grep(/^$key$/, @columns)) {
2785             push @set_strs, "$key = ?";
2786             push @set_args, ($invoice{$key} || undef);
2787         }
2788     }
2789
2790     my $rv;
2791     if(@set_args > 0) {
2792         my $dbh = C4::Context->dbh;
2793         my $query = "INSERT INTO aqinvoices SET ";
2794         $query .= join (",", @set_strs);
2795         my $sth = $dbh->prepare($query);
2796         $rv = $sth->execute(@set_args);
2797         if($rv) {
2798             $rv = $dbh->last_insert_id(undef, undef, 'aqinvoices', undef);
2799         }
2800     }
2801     return $rv;
2802 }
2803
2804 =head3 ModInvoice
2805
2806     ModInvoice(
2807         invoiceid => $invoiceid,    # Mandatory
2808         invoicenumber => $invoicenumber,
2809         booksellerid => $booksellerid,
2810         shipmentdate => $shipmentdate,
2811         billingdate => $billingdate,
2812         closedate => $closedate,
2813         shipmentcost => $shipmentcost,
2814         shipmentcost_budgetid => $shipmentcost_budgetid
2815     );
2816
2817 Modify an invoice, invoiceid is mandatory.
2818
2819 Return undef if it fails.
2820
2821 =cut
2822
2823 sub ModInvoice {
2824     my %invoice = @_;
2825
2826     return unless(%invoice and $invoice{invoiceid});
2827
2828     my @columns = qw(invoicenumber booksellerid shipmentdate billingdate
2829         closedate shipmentcost shipmentcost_budgetid);
2830
2831     my @set_strs;
2832     my @set_args;
2833     foreach my $key (keys %invoice) {
2834         if(0 < grep(/^$key$/, @columns)) {
2835             push @set_strs, "$key = ?";
2836             push @set_args, ($invoice{$key} || undef);
2837         }
2838     }
2839
2840     my $dbh = C4::Context->dbh;
2841     my $query = "UPDATE aqinvoices SET ";
2842     $query .= join(",", @set_strs);
2843     $query .= " WHERE invoiceid = ?";
2844
2845     my $sth = $dbh->prepare($query);
2846     $sth->execute(@set_args, $invoice{invoiceid});
2847 }
2848
2849 =head3 CloseInvoice
2850
2851     CloseInvoice($invoiceid);
2852
2853 Close an invoice.
2854
2855 Equivalent to ModInvoice(invoiceid => $invoiceid, closedate => undef);
2856
2857 =cut
2858
2859 sub CloseInvoice {
2860     my ($invoiceid) = @_;
2861
2862     return unless $invoiceid;
2863
2864     my $dbh = C4::Context->dbh;
2865     my $query = qq{
2866         UPDATE aqinvoices
2867         SET closedate = CAST(NOW() AS DATE)
2868         WHERE invoiceid = ?
2869     };
2870     my $sth = $dbh->prepare($query);
2871     $sth->execute($invoiceid);
2872 }
2873
2874 =head3 ReopenInvoice
2875
2876     ReopenInvoice($invoiceid);
2877
2878 Reopen an invoice
2879
2880 Equivalent to ModInvoice(invoiceid => $invoiceid, closedate => C4::Dates->new()->output('iso'))
2881
2882 =cut
2883
2884 sub ReopenInvoice {
2885     my ($invoiceid) = @_;
2886
2887     return unless $invoiceid;
2888
2889     my $dbh = C4::Context->dbh;
2890     my $query = qq{
2891         UPDATE aqinvoices
2892         SET closedate = NULL
2893         WHERE invoiceid = ?
2894     };
2895     my $sth = $dbh->prepare($query);
2896     $sth->execute($invoiceid);
2897 }
2898
2899 =head3 DelInvoice
2900
2901     DelInvoice($invoiceid);
2902
2903 Delete an invoice if there are no items attached to it.
2904
2905 =cut
2906
2907 sub DelInvoice {
2908     my ($invoiceid) = @_;
2909
2910     return unless $invoiceid;
2911
2912     my $dbh   = C4::Context->dbh;
2913     my $query = qq{
2914         SELECT COUNT(*)
2915         FROM aqorders
2916         WHERE invoiceid = ?
2917     };
2918     my $sth = $dbh->prepare($query);
2919     $sth->execute($invoiceid);
2920     my $res = $sth->fetchrow_arrayref;
2921     if ( $res && $res->[0] == 0 ) {
2922         $query = qq{
2923             DELETE FROM aqinvoices
2924             WHERE invoiceid = ?
2925         };
2926         my $sth = $dbh->prepare($query);
2927         return ( $sth->execute($invoiceid) > 0 );
2928     }
2929     return;
2930 }
2931
2932 =head3 MergeInvoices
2933
2934     MergeInvoices($invoiceid, \@sourceids);
2935
2936 Merge the invoices identified by the IDs in \@sourceids into
2937 the invoice identified by $invoiceid.
2938
2939 =cut
2940
2941 sub MergeInvoices {
2942     my ($invoiceid, $sourceids) = @_;
2943
2944     return unless $invoiceid;
2945     foreach my $sourceid (@$sourceids) {
2946         next if $sourceid == $invoiceid;
2947         my $source = GetInvoiceDetails($sourceid);
2948         foreach my $order (@{$source->{'orders'}}) {
2949             $order->{'invoiceid'} = $invoiceid;
2950             ModOrder($order);
2951         }
2952         DelInvoice($source->{'invoiceid'});
2953     }
2954     return;
2955 }
2956
2957 =head3 GetBiblioCountByBasketno
2958
2959 $biblio_count = &GetBiblioCountByBasketno($basketno);
2960
2961 Looks up the biblio's count that has basketno value $basketno
2962
2963 Returns a quantity
2964
2965 =cut
2966
2967 sub GetBiblioCountByBasketno {
2968     my ($basketno) = @_;
2969     my $dbh          = C4::Context->dbh;
2970     my $query        = "
2971         SELECT COUNT( DISTINCT( biblionumber ) )
2972         FROM   aqorders
2973         WHERE  basketno = ?
2974             AND (datecancellationprinted IS NULL OR datecancellationprinted='0000-00-00')
2975         ";
2976
2977     my $sth = $dbh->prepare($query);
2978     $sth->execute($basketno);
2979     return $sth->fetchrow;
2980 }
2981
2982 1;
2983 __END__
2984
2985 =head1 AUTHOR
2986
2987 Koha Development Team <http://koha-community.org/>
2988
2989 =cut