Merged latest changes from stable branch.
[fa-stable.git] / sales / includes / cart_class.inc
1 <?php
2 /**********************************************************************
3     Copyright (C) FrontAccounting, LLC.
4         Released under the terms of the GNU General Public License, GPL, 
5         as published by the Free Software Foundation, either version 3 
6         of the License, or (at your option) any later version.
7     This program is distributed in the hope that it will be useful,
8     but WITHOUT ANY WARRANTY; without even the implied warranty of
9     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
10     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
11 ***********************************************************************/
12 /* Definition of the cart class
13 this class can hold all the information for:
14
15 i)   a sales order
16 ii)  an invoice
17 iii) a credit note
18 iv)  a delivery note
19 */
20
21 include_once($path_to_root . "/inventory/includes/inventory_db.inc");
22 include_once($path_to_root . "/taxes/tax_calc.inc");
23
24 class cart
25 {
26         var $trans_type; // invoice, order, quotation, delivery note ...
27         var $trans_no = array();// array (num1=>ver1,..) or 0 for new
28         var $so_type = 0;               // for sales order: simple=0 template=1
29         var $cart_id;           // used to detect multi-tab edition conflits
30         var $line_items;  //array of objects of class line_details
31
32         var $src_docs = array();        // array of arrays(num1=>ver1,...) or 0 for no src
33         var $src_date;                  // src document date (for info only)
34
35         var $document_date;
36         var $due_date;
37         var $sales_type; // set to the customer's sales type
38         var $sales_type_name; // set to customer's sales type name
39         var $tax_included;
40
41         var $customer_currency; // set to the customer's currency
42         var $default_discount; // set to the customer's discount %
43         var $customer_name;
44         var $customer_id;
45         var $Branch;
46         var $email;
47
48         var $deliver_to;
49         var $delivery_address;
50         var $phone;
51
52         var $cust_ref;
53         var $reference;
54         var $Comments;
55         var $Location;
56         var $location_name;
57         var $order_no;          // the original order number
58
59         var $ship_via;
60         var $freight_cost = 0;
61
62         var $tax_group_id;
63         var $tax_group_name;
64         var $tax_group_array = null; // saves db queries
65         var $price_factor;       // ditto for price calculations
66
67         var     $pos;                   // user assigned POS
68         var $cash_account;
69         var $account_name;
70         var $cash_discount;     // not used as of FA 2.1
71         var $dimension_id;
72         var $dimension2_id;
73         var $payment;
74         var $payment_terms; // cached payment terms
75         var $credit;
76         
77         // prepayment mode:
78         var $prepaid;           // true for documents issued in prepayment mode
79         var $prep_amount;       // prepayment required for SO, invoiced amount for prepaiament invoice
80         var $sum_paid;          // sum of all allocated prepayments both to order and related invoices
81         var $alloc;             // sum of payments allocated to this document
82         var $prepayments = array(); // allocation records for this document
83         //-------------------------------------------------------------------------
84         //
85         //  $trans_no==0 => open new/direct document
86         //  $trans_no!=0 && $prepare_child==false => update with parent constarints for reedition
87         //  $trans_no!=0 && $prepare_child==true => prepare for child doc entry
88         //      $prepare_child is set to ST_SALESINVOICE for prepayment invoices
89         //
90         function Cart($type, $trans_no=0, $prepare_child=false) {
91                 /*Constructor function initialises a new shopping cart */
92                 $this->line_items = array();
93                 $this->sales_type = "";
94                 if ($type == ST_SALESQUOTE)
95                         $this->trans_type = $type;
96                 else    
97                         $this->trans_type = ST_SALESORDER;
98                 $this->dimension_id = 0;
99                 $this->dimension2_id = 0;
100                 $this->pos = get_sales_point(user_pos());
101                 $this->read($type, $trans_no, $prepare_child);
102                 $this->cart_id = uniqid('');
103         }
104         
105         //
106         //      Prepare cart to new child document entry, just after initial parent doc read.
107         //
108         function prepare_child($type)
109         {
110                 global $Refs;
111
112                 if ($type === true)
113                         $type = get_child_type($this->trans_type);
114
115                 $this->trans_type = $type;
116                 $this->reference = $Refs->get_next($this->trans_type);
117                 $this->document_date = new_doc_date();
118
119                 for($line_no = 0; $line_no < count($this->line_items); $line_no++) {
120                         $line = &$this->line_items[$line_no];
121                         $line->src_id = $line->id; // save src line ids for update
122                         $line->qty_dispatched = $type == ST_CUSTCREDIT ? '0' : 
123                                  (($this->prepaid && $type == ST_SALESINVOICE) ? $line->quantity : $line->quantity - $line->qty_done);
124                         $line->qty_old = 0;
125                 }
126                 unset($line);
127                 
128                 if ($type == ST_CUSTDELIVERY) {
129                         $this->order_no = key($this->trans_no);
130                         $cust = get_customer($this->customer_id);
131                         $this->dimension_id = $cust['dimension_id'];
132                         $this->dimension2_id = $cust['dimension2_id'];
133                 }
134                 if ($type == ST_SALESINVOICE) {
135                         $this->due_date = get_invoice_duedate($this->payment, $this->document_date);
136                 }
137
138                 if ($type == ST_CUSTCREDIT)
139                     $this->src_date = $this->document_date;
140
141                 $this->src_docs = $this->trans_no;
142                 $this->trans_no = 0;
143         }
144
145         //
146         //      Prepares transaction for reedition updating with parent transaction data 
147         //
148         function set_parent_constraints($sodata, $src_no) {
149
150                 $srcdetails = get_sales_parent_lines($this->trans_type, $src_no);
151                 $src_type = get_parent_type($this->trans_type);
152
153                 // calculate & save: qtys on other docs and free qtys on src doc
154                 $line_no = 0; $src_docs = array();
155                 // Loop speed optimisation below depends on fact 
156                 // that child line_items contains subset of parent lines in _the_same_ order !
157                 while (($line_no < count($this->line_items)) && ($srcline = db_fetch($srcdetails))) {
158                         $line = &$this->line_items[$line_no];
159                         $src_docs[] = $src_type == ST_SALESORDER ?  $srcline['order_no'] : $srcline['debtor_trans_no'];
160                         if ($srcline['id'] == $line->src_id) {
161                                 if ($this->trans_type == ST_SALESINVOICE)
162                                         $line->src_no = $srcline['debtor_trans_no'];
163                                 $line->qty_old = $line->qty_dispatched = $line->quantity;
164                                 $line->quantity += $srcline['quantity'] - 
165                                         ($src_type==ST_SALESORDER ? $srcline['qty_sent'] : $srcline['qty_done']); // add free qty on src doc
166                                 $line_no++;
167                         }
168                 }
169
170                 if ($src_type == ST_SALESORDER || $src_type == 0) {
171                         $this->src_docs = array( $sodata['order_no']=>$sodata['version']);
172                 } else {
173                         // get src_data from debtor_trans
174                         $this->src_docs = get_customer_trans_version($src_type, array_unique($src_docs));
175                 }
176         }
177         //-------------------------------------------------------------------------
178         // Reading document into cart
179         //
180         function read($type, $trans_no=0, $prepare_child=false) {
181
182                 global $SysPrefs, $Refs;
183
184                 if (!is_array($trans_no)) $trans_no = array($trans_no);
185
186                 if ($trans_no[0]) { // read old transaction
187                         if ($type == ST_SALESORDER || $type == ST_SALESQUOTE) { // sales order || sales quotation
188                                 read_sales_order($trans_no[0], $this, $type);
189                         } else {        // other type of sales transaction
190                                         read_sales_trans($type, $trans_no, $this);
191                                         $this->prepayments = get_payments_for($trans_no[0], $type);
192                                         if ($this->order_no) { // free hand credit notes have no order_no
193                                                 $sodata = get_sales_order_header($this->order_no, ST_SALESORDER);
194                                                 $this->cust_ref = $sodata["customer_ref"];
195                                         // currently currency is hard linked to debtor account
196                                         //      $this->customer_currency = $sodata["curr_code"];
197                                                 $this->delivery_to = $sodata["deliver_to"];
198                                                 $this->delivery_address = $sodata["delivery_address"];
199                                         // child transaction reedition - update with parent info unless it is freehand
200                                         if (!$this->is_prepaid() && !$prepare_child) // this is read for view/reedition
201                                                 $this->set_parent_constraints($sodata, $trans_no[0]);
202                                         }
203                         }
204                         // convert document into child and prepare qtys for entry
205                         if ($prepare_child)
206                                 $this->prepare_child($prepare_child);
207
208                 } else { // new document
209                                 $this->trans_type = $type;
210                                 $this->trans_no = 0;
211                                 $this->customer_currency = get_company_currency();
212                                 // set new sales document defaults here
213                                 if (get_global_customer() != ALL_TEXT)
214                                   $this->customer_id = get_global_customer();
215                                 else
216                                   $this->customer_id = '';
217                                 $this->document_date = new_doc_date();
218                                 if (!is_date_in_fiscalyear($this->document_date))
219                                         $this->document_date = end_fiscalyear();
220                                 $this->reference = $Refs->get_next($this->trans_type);
221                                 if ($type != ST_SALESORDER && $type != ST_SALESQUOTE) // Added 2.1 Joe Hunt 2008-11-12
222                                 {
223                                         $dim = get_company_pref('use_dimension');
224                                         if ($dim > 0)
225                                         {
226                                                 if ($this->customer_id == '')
227                                                         $this->dimension_id = 0;
228                                                 else
229                                                 {
230                                                         $cust = get_customer($this->customer_id);
231                                                         $this->dimension_id = $cust['dimension_id'];
232                                                 }       
233                                                 if ($dim > 1)
234                                                 {
235                                                         if ($this->customer_id == '')
236                                                                 $this->dimension2_id = 0;
237                                                         else
238                                                                 $this->dimension2_id = $cust['dimension2_id'];
239                                                 }               
240                                         }               
241                                 }       
242                                 if ($type == ST_SALESINVOICE) {
243                                         $this->due_date =
244                                                 get_invoice_duedate($this->payment, $this->document_date);
245                                 } else
246                                         $this->due_date =
247                                                 add_days($this->document_date, $SysPrefs->default_delivery_required_by());
248                 }
249                 $this->credit = get_current_cust_credit($this->customer_id);
250         }
251
252         //-------------------------------------------------------------------------
253         // Writing new/modified sales document to database.
254         // Makes parent documents for direct delivery/invoice by recurent call.
255         // $policy - 0 or 1:  writeoff/return for IV, back order/cancel for DN
256         function write($policy=0) {
257
258                 begin_transaction(); // prevents partial database changes in case of direct delivery/invoice
259                 if ($this->reference != 'auto' && $this->trans_no == 0 && !is_new_reference($this->reference, $this->trans_type))
260                 {
261                         commit_transaction();
262                         return -1;
263                 }
264                 if (count($this->src_docs) == 0 && ($this->trans_type == ST_SALESINVOICE || $this->trans_type == ST_CUSTDELIVERY) && !$this->is_prepaid()) {
265                         // this is direct document - first add parent
266                         $ref = $this->reference;
267                         $date = $this->document_date;
268                         $due_date = $this->due_date;
269                         $this->trans_type = get_parent_type($this->trans_type);
270
271                         $this->reference = 'auto'; 
272                         $trans_no = $this->write(1); 
273
274                         // re-read parent document converting it to child
275                         $this->read($this->trans_type, $trans_no, true); 
276                         $this->document_date = $date;
277                         $this->reference = $ref;
278                         $this->due_date = $due_date;
279                 }
280                 $this->reference = @html_entity_decode($this->reference, ENT_QUOTES);
281                 $this->Comments = @html_entity_decode($this->Comments, ENT_QUOTES);
282                 foreach($this->line_items as $lineno => $line) {
283                         $this->line_items[$lineno]->stock_id = @html_entity_decode($line->stock_id, ENT_QUOTES);
284                         $this->line_items[$lineno]->item_description = @html_entity_decode($line->item_description, ENT_QUOTES);
285                 }
286                 switch($this->trans_type) {
287                         case ST_SALESINVOICE:
288                                 $ret = write_sales_invoice($this); break;
289                         case ST_CUSTCREDIT:
290                                 $ret = write_credit_note($this, $policy); break;
291                         case ST_CUSTDELIVERY:
292                                 $ret = write_sales_delivery($this, $policy); break;
293                         case ST_SALESORDER:
294                         case ST_SALESQUOTE:
295                                 if ($this->trans_no==0) // new document
296                                         $ret = add_sales_order($this);
297                                 else
298                                         $ret = update_sales_order($this);
299                 }
300
301                 commit_transaction();
302
303                 return $ret;
304         }
305
306         function set_customer($customer_id, $customer_name, $currency, $discount, $payment, $cdiscount=0)
307         {
308                 $this->customer_name = $customer_name;
309                 $this->customer_id = $customer_id;
310                 $this->default_discount = $discount;
311                 $this->customer_currency = $currency;
312                 $this->payment = $payment;
313                 $this->payment_terms = get_payment_terms($payment);
314                 $this->cash_discount = $cdiscount;
315
316                 if ($this->payment_terms['cash_sale']) {
317                         $this->Location = $this->pos['pos_location'];
318                         $this->location_name = $this->pos['location_name'];
319                 }
320                 $this->credit = get_current_cust_credit($customer_id);
321         }
322
323         function set_branch($branch_id, $tax_group_id, $tax_group_name, $phone='', $email='')
324         {
325                 $this->Branch = $branch_id;
326                 $this->phone = $phone;
327                 $this->email = $email;
328                 $this->tax_group_id = $tax_group_id;
329                 $this->tax_group_array = get_tax_group_items_as_array($tax_group_id);
330         }
331
332         function set_sales_type($sales_type, $sales_name, $tax_included=0, $factor=0)
333         {
334             $this->sales_type = $sales_type;
335             $this->sales_type_name = $sales_name;
336             $this->tax_included = $tax_included;
337             $this->price_factor = $factor;
338         }
339
340         function set_location($id, $name)
341         {
342                 $this->Location = $id;
343                 $this->location_name = $name;
344         }
345
346         function set_delivery($shipper, $destination, $address, $freight_cost=null)
347         {
348                 $this->ship_via = $shipper;
349                 $this->deliver_to = $destination;
350                 $this->delivery_address = $address;
351                 if (isset($freight_cost))
352                         $this->freight_cost = $freight_cost;
353         }
354
355         function add_to_cart($line_no, $stock_id, $qty, $price, $disc, $qty_done=0, $standard_cost=0, $description=null, $id=0, $src_no=0,
356                 $src_id=0)
357         {
358                 $line = new line_details($stock_id, $qty, $price, $disc,
359                         $qty_done,  $standard_cost, $description, $id, $src_no, $src_id);
360
361                 if ($line->valid) {
362                         $this->line_items[$line_no] = $line;
363                         return 1;
364                 } else
365                         display_error(_("You have to enter valid stock code or nonempty description"));
366                 return 0;
367         }
368
369         function update_cart_item($line_no, $qty, $price, $disc, $description="")
370         {
371                 if ($description != "")
372                         $this->line_items[$line_no]->item_description = $description;
373                 $this->line_items[$line_no]->quantity = $qty;
374                 $this->line_items[$line_no]->qty_dispatched = $qty;
375                 $this->line_items[$line_no]->price = $price;
376                 $this->line_items[$line_no]->discount_percent = $disc;
377         }
378
379         function update_add_cart_item_qty($line_no, $qty)
380         {
381                 $this->line_items[$line_no]->quantity += $qty;
382         }
383
384         function remove_from_cart($line_no)
385         {
386                 array_splice($this->line_items, $line_no, 1);
387         }
388
389         function clear_items()
390         {
391                 unset($this->line_items);
392                 $this->line_items = array();
393                 $this->sales_type = "";
394                 $this->trans_no = 0;
395                 $this->customer_id = $this->order_no = 0;
396         }
397
398         function count_items()
399         {
400                 $counter=0;
401                 foreach ($this->line_items as $line) {
402                         if ($line->quantity!=$line->qty_done) $counter++;
403                 }
404                 return $counter;
405         }
406
407         function get_items_total()
408         {
409                 $total = 0;
410
411                 foreach ($this->line_items as $ln_itm) {
412                         $price = $ln_itm->line_price();
413                         $total += round($ln_itm->quantity * $price * (1 - $ln_itm->discount_percent), 
414                            user_price_dec());
415                 }
416                 return $total;
417         }
418
419         function get_items_total_dispatch()
420         {
421                 $total = 0;
422
423                 foreach ($this->line_items as $ln_itm) {
424                         $price = $ln_itm->line_price();
425                         $total += round(($ln_itm->qty_dispatched * $price * (1 - $ln_itm->discount_percent)), 
426                            user_price_dec());
427                 }
428                 return $total;
429         }
430
431         function has_items_dispatch()
432         {
433                 foreach ($this->line_items as $ln_itm) {
434                         if ($ln_itm->qty_dispatched > 0)
435                                 return true;
436                 }
437                 return false;
438         }
439
440         function any_already_delivered()
441         {
442                 /* Checks if there have been any line item processed */
443
444                 foreach ($this->line_items as $stock_item) {
445                         if ($stock_item->qty_done !=0) {
446                                 return 1;
447                         }
448                 }
449
450                 return 0;
451
452         }
453
454         function some_already_delivered($line_no)
455         {
456                 /* Checks if there have been deliveries of a specific line item */
457                 if (isset($this->line_items[$line_no]) &&
458                         $this->line_items[$line_no]->qty_done != 0) {
459                         return 1;
460                 }
461                 return 0;
462         }
463
464         function get_taxes($shipping_cost=null)
465         {
466                 $items = array();
467                 $prices = array();
468                 if($shipping_cost==null)
469                         $shipping_cost = $this->freight_cost;
470
471                 foreach ($this->line_items as $ln_itm) {
472                         $items[] = $ln_itm->stock_id;
473                         $prices[] = round(((
474                                 $this->trans_type==ST_SALESORDER ?      $ln_itm->quantity : $ln_itm->qty_dispatched) *
475                                 $ln_itm->line_price()* (1 - $ln_itm->discount_percent)),  user_price_dec());
476                 }
477
478                 $taxes = get_tax_for_items($items, $prices, $shipping_cost,
479                   $this->tax_group_id, $this->tax_included,  $this->tax_group_array);
480
481     // Adjustment for swiss franken, we always have 5 rappen = 1/20 franken
482     if ($this->customer_currency == 'CHF') {
483                         $val = $taxes['1']['Value'];
484                         $val1 = (floatval((intval(round(($val*20),0)))/20));
485                         $taxes['1']['Value'] = $val1;
486                 } 
487                 return $taxes;
488         }
489
490
491         function get_tax_free_shipping()
492         {
493
494                 if ($this->tax_included==0)
495                         return $this->freight_cost;
496                 else
497                         return ($this->freight_cost - $this->get_shipping_tax());
498         }
499
500         function get_shipping_tax()
501         {
502
503                 $tax_items = get_shipping_tax_as_array($this->tax_group_id);
504                 $tax_rate = 0;
505                 if ($tax_items != null) {
506                         foreach ($tax_items as $item_tax) {
507                                 $index = $item_tax['tax_type_id'];
508                                 if (isset($this->tax_group_array[$index]['rate'])) {
509                                         $tax_rate += $item_tax['rate'];
510                                 }
511                         }
512                 }
513                 if($this->tax_included)
514                         return round($this->freight_cost*$tax_rate/($tax_rate+100),  user_price_dec());
515                 else
516                         return round($this->freight_cost*$tax_rate/100,  user_price_dec());
517         }
518         /*
519                 Returns transaction value including all taxes
520         */
521         function get_trans_total() {
522                 
523                 $total = $this->get_items_total() + $this->freight_cost;
524                 $dec = user_price_dec();
525                 if (!$this->tax_included ) {
526                         $total += $this->get_shipping_tax();
527                         $taxes = $this->get_taxes();
528                         foreach($taxes as $tax)
529                                 $total += round($tax['Value'], $dec);
530                 }
531
532                 return $total;
533         }
534
535         /*
536                 Returns true for documents issued in prepayment cycle.
537         */
538         function is_prepaid()
539         {
540                 return $this->prepaid; //floatcmp($this->prep_amount, 0) > 0;
541         }
542         /*
543                 Order is ready for delivery in prepament mode.
544         */
545         function is_released()
546         {
547                 return floatcmp($this->sum_paid, $this->prep_amount) >= 0;
548         }
549
550         /*
551                 Check whether order has been already invoiced/send or not.
552         */
553         function is_started()
554         {
555                 if ($this->trans_no==0)
556                         return false;
557                 $order_no = array_keys($this->trans_no);
558
559                 return  is_sales_order_started(reset($order_no));
560         }
561
562         /*
563                 Check payment terms and prepayments selected for this invoice,
564                 and updates     partial/final invoice value respectively.
565         */
566         function update_payments()
567         {
568                 $remainder = prepaid_invoice_remainder($this->order_no);
569
570                 // recalculate prepaid part from payments
571                 if ($this->payment_terms['days_before_due'] < 0)
572                 {       // this is partial invoice for selected prepayments made.
573                         $paid = 0;
574                         foreach($this->prepayments as $payment)
575                                 $paid += $payment['amt'];
576                         $this->prep_amount = min($remainder, $paid);
577                 } else  // this is final invoice
578                         $this->prep_amount = $remainder;
579         }
580 } /* end of class defintion */
581
582 class line_details
583 {
584         var $id;
585         var $stock_id;
586         var $item_description;
587         var $units;
588         var $mb_flag;
589         var $tax_type;
590         var $tax_type_name;
591         var $src_no;    // number of src doc for this line
592         var $src_id;
593         var $price;
594         var $discount_percent;
595         
596         var $standard_cost;
597         var $descr_editable;
598
599         var $valid; // validation in constructor
600         /*
601                 Line quantity properties in various cart create modes:
602                 
603                 view:
604                 $quantity - quantity on current document
605                 $qty_done - quantity processed on all child documents
606                 $qty_dispatched - not used
607                 $qty_old - not used
608
609                 edit:
610                 $quantity - free parent quantity including this doc (= max allowed quantity)
611                 $qty_done - qty processed on child documents (= min allowed qty)
612                 $qty_dispatched - quantity currently selected to process
613                 $qty_old - quantity processed on this document before reedition 
614
615                 new child entry (view parent followed by prepare_child() call):
616                 $quantity - max allowed quantity (get from parent)
617                 $qty_done - qty processed on other child documents
618                 $qty_dispatched - quantity currently selected to process
619                 $qty_old - 0; not used
620         */
621         var $quantity;
622         var $qty_done;
623         var $qty_dispatched;
624         var $qty_old = 0;
625
626
627         function line_details ($stock_id, $qty, $prc, $disc_percent,
628                 $qty_done, $standard_cost, $description, $id=0, $src_no=0, $src_id=0)
629         {
630         /* Constructor function to add a new LineDetail object with passed params */
631
632                 $this->id = $id;
633                 $this->src_no = $src_no;
634                 $this->src_id = $src_id;
635                 $item_row = get_item($stock_id);
636
637                 if (!$item_row) 
638                         return;
639                         
640                 $this->mb_flag = $item_row["mb_flag"];
641                 $this->units = $item_row["units"];
642                 $this->descr_editable = $item_row["editable"];
643                 if ($description == null || !$this->descr_editable)
644                         $this->item_description = $item_row["description"];
645                 else
646                         $this->item_description = $description;
647                 //$this->standard_cost = $item_row["material_cost"] + $item_row["labour_cost"] + $item_row["overhead_cost"];
648                 $this->tax_type = $item_row["tax_type_id"];
649                 $this->tax_type_name = $item_row["tax_type_name"];
650                 $this->stock_id = $stock_id;
651                 $this->quantity = $qty;
652                 $this->qty_dispatched = $qty;
653                 $this->price = $prc;
654                 $this->discount_percent = $disc_percent;
655                 $this->qty_done = $qty_done;
656                 $this->standard_cost = $standard_cost;
657                 $this->valid = true;
658         }
659
660         // get unit price as stated on document
661         function line_price()
662         {
663                 return $this->price;
664         }
665 }
666
667 ?>