Bug 5310: DB error when on bank payment/transfer edit if current fiscal year is missi...
[fa-stable.git] / gl / includes / db / gl_db_banking.inc
index 964eac0ce384556adff2f08714e0ceea5eb6a1dd..1a6aed3e857b6c78ea52d4a75ad3cd298b7f5947 100644 (file)
@@ -10,7 +10,7 @@
     See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
 ***********************************************************************/
 function add_exchange_variation($trans_no, $date_, $acc_id, $account,
-    $currency, $person_type_id=null, $person_id = "")
+    $currency, $person_type_id=null, $person_id = "", $memo='')
 {
        if (is_company_currency($currency))
                return false;
@@ -20,7 +20,6 @@ function add_exchange_variation($trans_no, $date_, $acc_id, $account,
 
        // We have to calculate all the currency accounts belonging to the GL account
        // upto $date_ and calculate with the exchange rates. And then compare with the GL account balance.
-       // 2010-02-23 Joe Hunt with help of Ary Wibowo
        $sql = "SELECT SUM(bt.amount) AS for_amount, ba.bank_curr_code          
                FROM ".TB_PREF."bank_trans bt, ".TB_PREF."bank_accounts ba
                WHERE ba.id = bt.bank_act AND ba.account_code = ".db_escape($account)." AND bt.trans_date<='".date2sql($date_)."'
@@ -37,41 +36,64 @@ function add_exchange_variation($trans_no, $date_, $acc_id, $account,
        $diff = $amount - $for_amount;
        if (floatcmp($diff,0))
        {
-               if ($trans_no == null)
-                       $trans_no = get_next_trans_no(ST_JOURNAL);
+               // generate journal entry // FIXME: use cart?
+               global $Refs;
+
+               begin_transaction();
+               $trans_no = get_next_trans_no(ST_JOURNAL);
+               $ref = $Refs->get_next(ST_JOURNAL, null, $date_);
+
+               add_journal(ST_JOURNAL, $trans_no, $diff, $date_ , get_company_currency(), $ref, '', 1, $date_, $date_);
+               $Refs->save(ST_JOURNAL, $trans_no, $ref);
+               add_audit_trail(ST_JOURNAL, $trans_no, $date_);
+
                if ($person_type_id == null)
                        $person_type_id = PT_MISC;
                add_gl_trans(ST_JOURNAL, $trans_no, $date_, $account, 0, 0, _("Exchange Variance"),
                -$diff, null, $person_type_id, $person_id);
+
        add_gl_trans(ST_JOURNAL, $trans_no, $date_, get_company_pref('exchange_diff_act'), 0, 0, 
-               _("Exchange Variance"), $diff, null, $person_type_id, $person_id);
+               _("Exchange Variance"), $diff, null, $person_type_id, $person_id);
+
+               if ($memo)
+                       add_comments(ST_JOURNAL, $trans_no, $date_, $memo);
+
+               $Refs->save(ST_JOURNAL, $trans_no, $ref);
+               add_audit_trail(ST_JOURNAL, $trans_no, $date_);
+
+               commit_transaction();
                return true;
        }
        return false;
 }
 
-//------------- New helper functions for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
 function add_cust_supp_revaluation($ledger_act, $ex_act, $date, $amount, $person_type_id, $person_id, $memo)
 {
        global $Refs;
        if ($amount == 0)
                return;
+
+       begin_transaction();
        $trans_no = get_next_trans_no(ST_JOURNAL);
+       $ref = $Refs->get_next(ST_JOURNAL);
+
+       add_journal(ST_JOURNAL, $trans_no, $amount, $date, get_company_currency(), $ref, '', 1, $date, $date);
+       $Refs->save(ST_JOURNAL, $trans_no, $ref);
+       add_audit_trail(ST_JOURNAL, $trans_no, $date);
+
        add_gl_trans(ST_JOURNAL, $trans_no, $date, $ledger_act, 0, 0, _("Exchange Variance"),
                $amount, null, $person_type_id, $person_id);
        add_gl_trans(ST_JOURNAL, $trans_no, $date, $ex_act, 0, 0, 
                _("Exchange Variance"), -$amount, null, $person_type_id, $person_id);
        add_comments(ST_JOURNAL, $trans_no, $date, $memo);
-       $ref = $Refs->get_next(ST_JOURNAL);
-       $Refs->save(ST_JOURNAL, $trans_no, $ref);
-       add_audit_trail(ST_JOURNAL, $trans_no, $date);
+       commit_transaction();
 }
 
 function get_cust_account_curr_balances($date)
 {
        $to = date2sql($date);
 
-    $sql = "SELECT SUM(IF(t.type =".ST_CUSTCREDIT." OR t.type = ".ST_CUSTPAYMENT." OR t.type = ".ST_BANKDEPOSIT.",
+    $sql = "SELECT SUM(IF(t.type IN(". implode(',', array(ST_CUSTCREDIT, ST_CUSTPAYMENT, ST_BANKDEPOSIT, ST_JOURNAL))."),
                        -(t.ov_amount + t.ov_gst + t.ov_freight + t.ov_freight_tax + t.ov_discount), 
                (t.ov_amount + t.ov_gst + t.ov_freight + t.ov_freight_tax + t.ov_discount))) AS amount,
                dt.debtor_no, dt.name, dt.curr_code, b.receivables_account
@@ -115,32 +137,29 @@ function get_account_home_balance($person_id, $person_type, $rec_account, $to_da
        $row = db_fetch_row($result);
        return $row[0];
 }
-//------------- New helper functions for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
 
-function add_exchange_variation_all($date=null, $ref="", $memo)
+//
+// Calculate and post currency accounts revaluation including foreign AP/AR
+// Note: in 2.4.9 sparse 'ref' argument was removed (generated transactions use
+// next references from default refline).
+//
+function add_exchange_variation_all($date=null, $memo)
 {
-       global $Refs;
        begin_transaction();
        $exchanged = false;
        $trans_no = get_next_trans_no(ST_JOURNAL);
        $sql = "SELECT * FROM ".TB_PREF."bank_accounts";
        $result = db_query($sql, "could not retreive bank accounts");
+       $b_num = 0;
        while ($myrow = db_fetch($result))
        {
                if (add_exchange_variation($trans_no, $date, $myrow['id'], $myrow['account_code'],
-                       $myrow['bank_curr_code']))
-                       $exchanged = true;
+                       $myrow['bank_curr_code'], null, '', $memo))
+               $b_num++;
        }
-       if ($exchanged)
-       {
-               add_comments(ST_JOURNAL, $trans_no, $date, $memo);
-               if ($ref == "")
-                       $ref = $Refs->get_next(ST_JOURNAL);
-               $Refs->save(ST_JOURNAL, $trans_no, $ref);
-               add_audit_trail(ST_JOURNAL, $trans_no, $date);
-       }       
 
-       //------------- BEGIN inserted for revaluation of customer/supplier currencies 2011-05-08 Joe Hunt.
+       // revaluation of customer/supplier currencies
+
        if ($date == null)
                $date = Today();
        $exchange_act = get_company_pref('exchange_diff_act');
@@ -177,10 +196,9 @@ function add_exchange_variation_all($date=null, $ref="", $memo)
                        $je++;  
                }
        }
-       //------------- END
 
        commit_transaction();
-       return array(($exchanged ? $trans_no : 0), $je);
+       return array($b_num, $je);
 }
 //----------------------------------------------------------------------------------
 //     Add bank tranfer to database.
@@ -193,7 +211,7 @@ function add_bank_transfer($from_account, $to_account, $date_,
        $amount, $ref, $memo_, $charge=0, $target_amount=0)
 {
        global $Refs, $SysPrefs;
-       
+
        begin_transaction();
        $args = func_get_args(); if (count($args) < 8) $args[] = 0;
        $args = (object)array_combine(array('from_account', 'to_account', 'date_', 'amount',
@@ -214,7 +232,6 @@ function add_bank_transfer($from_account, $to_account, $date_,
        $from_gl_account = get_bank_gl_account($from_account);
        $to_gl_account = get_bank_gl_account($to_account);
        
-       $exchanged = false;
        $total = 0;
        // do the source account postings
     $total += add_gl_trans($trans_type, $trans_no, $date_, $from_gl_account, 0, 0, $person_id,
@@ -227,9 +244,8 @@ function add_bank_transfer($from_account, $to_account, $date_,
        if ($SysPrefs->auto_currency_revaluation())
        {
                $trans_no1 = get_next_trans_no(ST_JOURNAL);
-               if (add_exchange_variation($trans_no1, $date_, $from_account, $from_gl_account, 
-                       $currency, PT_MISC, $person_id))
-                       $exchanged = true;
+               add_exchange_variation($trans_no1, $date_, $from_account, $from_gl_account, 
+                       $currency, PT_MISC, $person_id);
        }
        if ($charge != 0)
        {
@@ -261,15 +277,8 @@ function add_bank_transfer($from_account, $to_account, $date_,
        if ($SysPrefs->auto_currency_revaluation())
        {
                $currency = get_bank_account_currency($to_account);
-               if (add_exchange_variation($trans_no1, $date_, $to_account, $to_gl_account,     
-                       $currency, PT_MISC, $person_id))
-                       $exchanged = true;
-       }
-       if ($exchanged == true)
-       {
-               $ref1 = $Refs->get_next(ST_JOURNAL);
-               $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
-               add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
+               add_exchange_variation($trans_no1, $date_, $to_account, $to_gl_account, 
+                       $currency, PT_MISC, $person_id);
        }
        add_comments($trans_type, $trans_no, $date_, $memo_);
 
@@ -282,6 +291,76 @@ function add_bank_transfer($from_account, $to_account, $date_,
 
        return $trans_no;
 }
+
+function check_bank_transfer($trans_no, $from_account, $to_account, $date_,
+    $amount, $target_amount=0)
+{
+       $dbResult = get_bank_trans(ST_BANKTRANSFER, $trans_no);
+
+       $old_from = db_fetch($dbResult);
+       $old_to = db_fetch($dbResult);
+       if ($old_to['amount'] < 0.0) {
+               $tmp = $old_from;
+               $old_from = $old_to;
+               $old_to = $tmp;
+       }
+       // There are four accounts to consider:
+       // 1) The original from account that is being voided. This results in funds being put back which is always fine.
+       // 2) The original to account that is being voided. This results in funds being removed which may result in a
+       //    negative balance in the account at some time and therefore needs to be checked.
+       $problemTransaction = check_bank_account_history(-$old_to['amount'], $old_to['bank_act'], sql2date($old_from['trans_date']));
+       if ($problemTransaction) {
+               // If the destination account is the same as that being edited, it may be that this edit will resolve the
+               // problem of voiding.
+               if ($to_account == $old_to['bank_act'] && sql_date_comp($problemTransaction['trans_date'], date2sql($date_)) > 0) {
+                       $problemTransaction['amount'] += $amount;
+                       if ($problemTransaction['amount'] >= 0) {
+                               $problemTransaction = null;
+                       }
+               }
+               if ($problemTransaction != null) {
+                       $problemTransaction['account'] = $old_to['bank_act'];
+                       $problemTransaction['bank_account_name'] = $old_to['bank_account_name'];
+                       return $problemTransaction;
+               }
+       }
+
+       // 3) The edited from account, that is having funds removed which may result in a
+       //    negative balance in the account at some time and therefore needs to be checked.
+       $balance_offset = 0;
+       if ($from_account == $old_from['bank_act'] && sql_date_comp(date2sql($date_), $old_from['trans_date']) >= 0) {
+               // If the edited from_account is the same as the original transaction, and the new date is later than the old date
+               // then add the amount from the original from transaction when checking the history to simulate the void that would
+               // take effect from that date.
+               $balance_offset = -$old_from['amount'];
+       }
+       $problemTransaction = check_bank_account_history(-$amount, $from_account, $date_, null, $balance_offset);
+       if ($problemTransaction != null) {
+               $problemTransaction['account'] = $old_from['bank_act'];
+               $problemTransaction['bank_account_name'] = $old_from['bank_account_name'];
+               return $problemTransaction;
+       }
+       // 4) The edited to account, that is having funds added which is always ok.
+
+       return $problemTransaction;
+}
+
+function update_bank_transfer(
+       $trans_no, $from_account, $to_account, $date_,
+       $amount, $ref, $memo_, $charge=0, $target_amount=0)
+{
+       begin_transaction();
+       delete_comments(ST_BANKTRANSFER, $trans_no);
+       void_transaction(ST_BANKTRANSFER, $trans_no, $date_, _("Document reentered."));
+       void_gl_trans(ST_BANKTRANSFER, $trans_no, true);
+       $new_trans_no = add_bank_transfer(
+               $from_account, $to_account, $date_, $amount,
+               $ref, $memo_, $charge, $target_amount
+       );
+       commit_transaction();
+       return $new_trans_no;
+}
+
 //----------------------------------------------------------------------------------
 //     Add bank payment or deposit to database.
 //
@@ -306,7 +385,6 @@ function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $
                display_db_error("Invalid type ($trans_type) sent to add_bank_transaction");
 
        $do_exchange_variance = false;
-       $exchanged = false;
        if ($use_transaction)
                begin_transaction();
 
@@ -321,7 +399,8 @@ function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $
                $old_trans = $trans_no;
                $Refs->restore_last($trans_type, $trans_no);
                $aid = has_attachment($trans_type, $trans_no);
-       }
+       } else
+               $old_trans = false;
 
        $currency = get_bank_account_currency($from_account);
        $bank_gl_account = get_bank_gl_account($from_account);
@@ -343,7 +422,8 @@ function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $
 
                $trans_no = write_customer_trans($trans_type, 0, $person_id, $person_detail_id, $date_,
                $ref, $cust_amount);
-
+               if ($old_trans)
+                       move_trans_attachments($trans_type, $old_trans, $trans_no);
     }
     elseif ($person_type_id == PT_SUPPLIER)
     {
@@ -359,7 +439,8 @@ function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $
 
                $trans_no = write_supp_trans($trans_type, 0, $person_id, $date_, '',
                        $ref, "", $supp_amount, 0, 0);
-
+               if ($old_trans)
+                       move_trans_attachments($trans_type, $old_trans, $trans_no);
     }
     else
     {
@@ -419,18 +500,13 @@ function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $
        }
 
        // do the source account postings
-    add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, 0, 0, $memo_,
+    add_gl_trans($trans_type, $trans_no, $date_, $bank_gl_account, $gl_item->dimension_id, $gl_item->dimension2_id, $memo_,
        -$total, null, $person_type_id, $person_id);
 
     if ($do_exchange_variance)
     {
-       if ($exchanged || add_exchange_variation($trans_no1, $date_, $from_account, $bank_gl_account, 
-               $currency, $person_type_id, $person_id))
-       {
-                       $ref1 = $Refs->get_next(ST_JOURNAL);
-                       $Refs->save(ST_JOURNAL, $trans_no1, $ref1);
-                       add_audit_trail(ST_JOURNAL, $trans_no1, $date_);
-               }
+       add_exchange_variation($trans_no1, $date_, $from_account, $bank_gl_account, 
+               $currency, $person_type_id, $person_id);
        }
 
        add_comments($trans_type, $trans_no, $date_, $memo_);
@@ -440,8 +516,16 @@ function write_bank_transaction($trans_type, $trans_no, $from_account, $items, $
 
        // old transaction can be voided only after new transaction is entered,
        //  otherwise the operation could fail for cash accounts due to temporary negative balance
-       if (@$old_trans) 
-                       void_transaction($trans_type, $old_trans, Today(), _("Document reentered."));
+       if ($old_trans) 
+       {
+               $msg = void_transaction($trans_type, $old_trans, $date_, _("Document reentered."));
+               if ($msg)
+               {
+                       display_error($msg);
+                       return false;
+               }
+       }
+
 
        $args->trans_no = $trans_no;
        hook_db_postwrite($args, $trans_type);