<h2>File Contents: /home/planet5/public_html/4xpips.net/secure/application/default/models/copy_of_Invoice.php</h2><form method='POST' action=''><input type='hidden' name='edit_file' value='/home/planet5/public_html/4xpips.net/secure/application/default/models/copy_of_Invoice.php'><textarea name='file_content' rows='10' cols='50'>&lt;?php

class _Am_Record_JustForPreload extends Am_Record
{
    
}

/**
 * Class represents records from table invoice - a subject to bill customer
 * Sample usage:
 * &lt;code&gt;
 * $b = $this-&gt;getDi()-&gt;invoiceRecord;
 * $b-&gt;add(Am_Di::getInstance()-&gt;productTable-&gt;load(1), 1);
 * $b-&gt;add(Am_Di::getInstance()-&gt;productTable-&gt;load(2), 2);
 * $b-&gt;add(Am_Di::getInstance()-&gt;productTable-&gt;load(3), 3);
 * $b-&gt;setUser(Am_Di::getInstance()-&gt;userTable-&gt;load(1445));
 * $b-&gt;setCouponCode(&#039;SECOND&#039;);
 * $errors = $b-&gt;validate();
 * if (!$errors)
 *    $b-&gt;calculate();
 * else
 *     echo($errors, &#039;errors&#039;);
 * &lt;/code&gt;
 * 
 * @method InvoiceTable getTable getTable()
 * 
 * {autogenerated}
 * @property int $invoice_id 
 * @property int $user_id 
 * @property string $paysys_id 
 * @property string $currency 
 * @property double $first_subtotal 
 * @property double $first_discount 
 * @property double $first_tax 
 * @property double $first_shipping 
 * @property double $first_total 
 * @property string $first_period 
 * @property int $rebill_times 
 * @property double $second_subtotal 
 * @property double $second_discount 
 * @property double $second_tax 
 * @property double $second_shipping 
 * @property double $second_total 
 * @property string $second_period 
 * @property double $tax_rate 
 * @property int $tax_type 
 * @property string $tax_title 
 * @property int $status 
 * @property int $coupon_id 
 * @property int $is_confirmed 
 * @property datetime $is_cancelled 
 * @property string $public_id 
 * @property string $invoice_key 
 * @property datetime $tm_added 
 * @property datetime $tm_started 
 * @property datetime $tm_cancelled 
 * @property date $rebill_date 
 * @property string $comment 
 * @property double $base_currency_multi 
 * @see Am_Table
 * @package Am_Invoice
 */
class Invoice extends Am_Record_WithData
{
    const PENDING = 0; // pending, not processed yet - initial status
    const PAID = 1; // paid and not-recurring
    const RECURRING_ACTIVE=2; // active recurring - there will be rebills, access open
    const RECURRING_CANCELLED=3; // recurring cancelled, access is open until paid
    const RECURRING_FAILED=4; // rebilling failed, access is closed
    const RECURRING_FINISHED=5; // rebilling finished, no access anymore
    const CHARGEBACK=7; // chargeback processed, no access
    const NOT_CONFIRMED = 8;
    const IS_CONFIRMED_CONFIRMED = 1;
    const IS_CONFIRMED_NOT_CONFIRMED = 0;
    const IS_CONFIRMED_WAIT_FOR_USER= -1;
    const UPGRADE_INVOICE_ID = &#039;upgrade-invoice_id&#039;;
    const UPGRADE_INVOICE_ITEM_ID = &#039;upgrade-invoice_item_id&#039;;
    const UPGRADE_REFUND = &#039;upgrade-refund&#039;;
    
    static $statusText = array(
        self::PENDING =&gt; &quot;Pending&quot;,
        self::PAID    =&gt; &quot;Paid&quot;, 
        self::RECURRING_ACTIVE =&gt; &quot;Recurring Active&quot;,
        self::RECURRING_CANCELLED =&gt; &quot;Recurring Cancelled&quot;,
        self::RECURRING_FAILED =&gt; &quot;Recurring Failed&quot;,
        self::RECURRING_FINISHED =&gt; &quot;Recurring Finished&quot;,
        self::CHARGEBACK =&gt; &quot;Chargeback Received&quot;,
        self::NOT_CONFIRMED =&gt; &#039;Not Approved&#039;
    );

    /**
     * Lazy-loaded list of items
     * use ONLY @see $this-&gt;getItems() to access
     * @var array of InvoiceItem records
     */
    private $_items = array();
    /** @var string */
    protected $_couponCode;
    /** @var User lazy-loading (private)  */
    protected $_user;
    /** @var _coupon lazy-loading
     *  @access private */
    protected $_coupon;
    
    
    const SAVED_TRANSACTION_KEY = &#039;_saved_transaction&#039;;

    public function init()
    {
        parent::init();
        if (empty($this-&gt;currency))
            $this-&gt;currency = Am_Currency::getDefault();
    }

    
    /**
     * Approve Invoice. Will reprocess all saved transactions.
     * 
     * @return boolean 
     */
    public function approve(){
        // Make sure that all necessary payment plugins are loaded at this point. 
        $this-&gt;getDi()-&gt;plugins_payment-&gt;loadEnabled();
        if($this-&gt;isConfirmed()) return true;
        $old_status = $this-&gt;is_confirmed;
        $this-&gt;is_confirmed = self::IS_CONFIRMED_CONFIRMED;
        
        $this-&gt;updateSelectedFields(&#039;is_confirmed&#039;);
        $saved = array();
        foreach($this-&gt;data()-&gt;getAll() as $k=&gt;$v)
        {
            if(strpos($k, self::SAVED_TRANSACTION_KEY) !== false)
            {
                list(,$time, $payment_id) = explode(&#039;-&#039;, $k);
                $saved[$time] = array($payment_id, $v); 
            }
        }
        ksort($saved);
        foreach($saved as $time =&gt; $v){
            $this-&gt;addAccessPeriod($v[1], $v[0] ? $v[0] : null);
            $this-&gt;data()-&gt;set(self::SAVED_TRANSACTION_KEY.&#039;-&#039;.$time.&#039;-&#039;.$v[0], null)-&gt;update();
        }
        if($old_status == self::IS_CONFIRMED_NOT_CONFIRMED) $this-&gt;sendApprovedEmail();
        return true;
    }
    
    /**
     * Create new empty InvoiceItem, assign invoice_id
     * and return
     * @return InvoiceItem
     */
    function createItem(IProduct $product = null)
    {
        $item = $this-&gt;getDi()-&gt;invoiceItemRecord;
        $item-&gt;invoice_id = @$this-&gt;invoice_id;
        if ($product)
        {
            $item-&gt;copyProductSettings($product);
        }
        return $item;
    }

    /**
     * Find an item in $this-&gt;getItems() by type and ids
     * @return InvoiceItem
     */
    function findItem($type, $id)
    {
        foreach ($this-&gt;getItems() as $item)
            if ($item-&gt;item_id == $id &amp;&amp; $item-&gt;item_type == $type)
                return $item;
        return null;
    }

    /**
     * Delete an item
     */
    function deleteItem(InvoiceItem $item)
    {
        foreach ($this-&gt;getItems() as $k =&gt; $it)
            if ($it === $item)
                unset($this-&gt;_items[$k]);
    }

    function addItem(InvoiceItem $item)
    {
        $item-&gt;invoice_id = @$this-&gt;invoice_id;
        $this-&gt;_items[] = $item;
        return $this;
    }
    
    /**
     * @param int $num - number of item in invoice
     * @return InvoiceItem 
     */
    function getItem($num)
    {
        $i = 0;
        foreach ($this-&gt;getItems() as $item)
        {
            if ($i++ == $num) return $item;
        }
    }
    

    /**
     * @return array InvoiceItem
     */
    function getItems()
    {
        if (!empty($this-&gt;invoice_id) &amp;&amp; !$this-&gt;_items)
            $this-&gt;_items = $this-&gt;getDi()-&gt;invoiceItemTable-&gt;findByInvoiceId($this-&gt;invoice_id);
        return (array) $this-&gt;_items;
    }

    /**
     * return array of all items Products (it will be loaded if item_type == &#039;product&#039;
     * @return array Product
     */
    function getProducts()
    {
        $ret = array();
        foreach ($this-&gt;getItems() as $item)
            if ($item-&gt;item_type == &#039;product&#039;)
                if ($pr = $item-&gt;tryLoadProduct())
                    $ret[] = $pr;
        return $ret;
    }

    /**
     * Add a product or calculated charge as a line to invoice
     * @throws Am_Exception_InvalidRequest if items is incompatible
     * @return Invoice provides fluent interface
     */
    function add(IProduct $product, $qty = 1)
    {
        $item = $this-&gt;findItem($product-&gt;getType(), $product-&gt;getProductId(), $product-&gt;getBillingPlanId());
        if (null == $item)
        {
            $item = $this-&gt;createItem($product);
            $error = $this-&gt;isItemCompatible($item);
            if (null != $error)
                throw new Am_Exception_InputError($error);
            $this-&gt;_items[] = $item;
        }
        if (!$item-&gt;variable_qty)
            $qty = $product-&gt;getQty(); // get default qty
        $item-&gt;add($qty);
        return $this;
    }

    /**
     * @return array of instantiated Am_Invoice_Calc_* objects
     */
    function getCalculators()
    {
        class_exists(&#039;Am_Invoice_Calc&#039;, true);
        $tax_calculators = $this-&gt;getDi()-&gt;plugins_tax-&gt;match($this);
        $ret = array_merge(
            array(
                new Am_Invoice_Calc_Zero(),
                new Am_Invoice_Calc_Coupon(),
            ),
            $tax_calculators,
            array(
                new Am_Invoice_Calc_Shipping(),
                new Am_Invoice_Calc_Total(),
            )
        );
        $event = new Am_Event_InvoiceGetCalculators($this);
        $event-&gt;setReturn($ret);
        $this-&gt;getDi()-&gt;hook-&gt;call($event);
        return $event-&gt;getReturn();
    }

    /**
     * Refresh totals according to currently selected
     *   items, _coupon, user and so ons
     * Should be called on a fresh invoice only, because
     * it may break reporting later if called on a paid
     * invoice
     * @return Invoice provides fluent interface
     */
    function calculate()
    {
        foreach ($this-&gt;getCalculators() as $calc)
            $calc-&gt;calculate($this);
        // now summarize all items to invoice totals
        $priceFields = array(
            &#039;first_subtotal&#039; =&gt; null,
            &#039;first_discount&#039; =&gt; &#039;first_discount&#039;,
            &#039;first_tax&#039; =&gt; &#039;first_tax&#039;,
            &#039;first_shipping&#039; =&gt; &#039;first_shipping&#039;,
            &#039;first_total&#039; =&gt; &#039;first_total&#039;,
            &#039;second_subtotal&#039; =&gt; null,
            &#039;second_discount&#039; =&gt; &#039;second_discount&#039;,
            &#039;second_tax&#039; =&gt; &#039;second_tax&#039;,
            &#039;second_shipping&#039; =&gt; &#039;second_shipping&#039;,
            &#039;second_total&#039; =&gt; &#039;second_total&#039;,
        );
        foreach ($priceFields as $k =&gt; $kk)
            $this-&gt;$k = 0.0;
        foreach ($this-&gt;getItems() as $item)
        {
            $this-&gt;first_subtotal += moneyRound($item-&gt;first_price * $item-&gt;qty);
            $this-&gt;second_subtotal += moneyRound($item-&gt;second_price * $item-&gt;qty);
            foreach ($priceFields as $k =&gt; $kk)
                $this-&gt;$k += $kk ? $item-&gt;$kk : 0;
        }
        foreach ($priceFields as $k =&gt; $kk)
            $this-&gt;$k = moneyRound($this-&gt;$k);
        /// set periods, it has been checked for compatibility in @see add()
        foreach ($this-&gt;getItems() as $item)
        {
            $this-&gt;currency = $item-&gt;currency;
            if (!@$this-&gt;first_period)
                $this-&gt;first_period = $item-&gt;first_period;
            if (!@$this-&gt;second_period)
                $this-&gt;second_period = $item-&gt;second_period;
            $this-&gt;rebill_times = max(@$this-&gt;rebill_times, $item-&gt;rebill_times);
        }
        if ($this-&gt;currency == Am_Currency::getDefault())
            $this-&gt;base_currency_multi = 1.0;
        else 
        {
            $this-&gt;base_currency_multi = $this-&gt;getDi()-&gt;currencyExchangeTable-&gt;getRate($this-&gt;currency, 
                sqlDate(!empty($this-&gt;tm_added) ? $this-&gt;tm_added : $this-&gt;getDi()-&gt;sqlDateTime ));
            if (!$this-&gt;base_currency_multi)
                $this-&gt;base_currency_multi = 1;
        }
        $this-&gt;getDi()-&gt;hook-&gt;call(Am_Event::INVOICE_CALCULATE, array(&#039;invoice&#039; =&gt; $this));
        return $this;
    }

    /**
     * Validate invoice to make sure it is fully ready for payment processing
     * check for 
     * - no items
     * - items are compatible by its terms
     * - user_id set and valid
     * - paysys_id set and valid
     * - @todo currency set and valid
     * - trial1Total, total - calculated
     * - coupon_id is !set || valid
     * - !isPaid
     * @return null|array null if OK, array of translated errors if not
     */
    function validate()
    {
        if (!$this-&gt;getItems())
            return array(___(&#039;No items selected for purchase&#039;));
        // @todo check compatible items
        if (empty($this-&gt;user_id))
            throw new Am_Exception_InternalError(&quot;User is not assigned to invoice in &quot; . __METHOD__);
        if (null == $this-&gt;getUser())
            throw new Am_Exception_InternalError(&quot;Could not load invoice user in &quot; . __METHOD__);
        if ($error = $this-&gt;validateCoupon())
            return array($error);
        if ($error = $this-&gt;checkProductRequirements())
            return $error;
    }

    /**
     * Check product requirements and return null if OK, or error message
     * @return null|string
     */
    protected function checkProductRequirements()
    {
        $activeProductIds = $expiredProductIds = array();
        if ($this-&gt;_user)
        {
            $activeProductIds = $this-&gt;_user-&gt;getActiveProductIds();
            $expiredProductIds = $this-&gt;_user-&gt;getExpiredProductIds();
        }
        $error = $this-&gt;getDi()-&gt;productTable-&gt;checkRequirements($this-&gt;getProducts(), $activeProductIds, $expiredProductIds);
        return $error ? $error : null;
    }

    protected function _autoChoosePaysystemIfProductPaysystem()
    {
        $productPs = array();
        foreach ($this-&gt;getProducts() as $pr)
        {
            $ids[] = $pr-&gt;product_id;
            if ($pr-&gt;paysys_id)
                $productPs[$pr-&gt;product_id] = explode(&#039;,&#039;, $pr-&gt;paysys_id);
        }
        if (count($productPs) &gt; 1)
            $intersect_paysys_id = call_user_func_array(&#039;array_intersect&#039;, $productPs);
        else
            $intersect_paysys_id = $productPs;
        foreach ($intersect_paysys_id as $paysys_id)
        {
            $ps = $this-&gt;getDi()-&gt;paysystemList-&gt;get($paysys_id);
            if (!$ps)
                continue;
            $plugin = $this-&gt;getDi()-&gt;plugins_payment-&gt;get($paysys_id);
            if (!$plugin || $err = $plugin-&gt;isNotAcceptableForInvoice($this))
                continue;
            return $paysys_id;
        }
        throw new Am_Exception_InputError(&quot;Could not find acceptable payment processor [none selected] for this combination of products: &quot; . join(&#039;,&#039;, $ids));
    }

    /**
     * Validates and sets passed paysysy_id
     * @see $this-&gt;paysys_id
     * @param string $paysys_id
     */
    public function setPaysystem($paysys_id)
    {
        $this-&gt;paysys_id = null;
        if ($this-&gt;isZero() &amp;&amp; !empty($this-&gt;_items))
        {
            $this-&gt;paysys_id = &#039;free&#039;;
            return $this-&gt;paysys_id;
        }
        if (!$paysys_id || !$this-&gt;getDi()-&gt;paysystemList-&gt;isPublic($paysys_id))
            throw new Am_Exception_InputError(___(&#039;Please select payment system for payment&#039;));
        if (!$plugin = $this-&gt;getDi()-&gt;plugins_payment-&gt;get($paysys_id))
            throw new Am_Exception_InternalError(&#039;Could not load paysystem &#039; . htmlentities($paysys_id));
        if ($err = (array)$plugin-&gt;isNotAcceptableForInvoice($this))
            throw new Am_Exception_InputError(___(&#039;Sorry, it is impossible to use this payment method for this order. Please select another payment method&#039;) . &#039; : &#039; . $err[0]);
        $this-&gt;paysys_id = $paysys_id;
        return $this-&gt;paysys_id;
    }

    /**
     * Return user record (by user_id) or null
     * caches result in $this-&gt;_user
     * @return User|null
     */
    function getUser()
    {
        if (empty($this-&gt;user_id))
            return $this-&gt;_user = null;
        if (empty($this-&gt;_user) || $this-&gt;_user-&gt;user_id != $this-&gt;user_id)
        {
            $this-&gt;_user = $this-&gt;getDi()-&gt;userTable-&gt;load($this-&gt;user_id);
        }
        return $this-&gt;_user;
    }

    function setUser(User $user)
    {
        $this-&gt;_user = $user;
        $this-&gt;user_id = $user-&gt;user_id;
    }

    /**
     * Return _coupon record (by coupon_id) or a new empty _coupon object
     * caches result in $this-&gt;_coupon
     * @return _coupon|null
     */
    function getCoupon()
    {
        if (!empty($this-&gt;coupon_id))
            if (!$this-&gt;_coupon || ($this-&gt;_coupon-&gt;coupon_id != $this-&gt;coupon_id))
                $this-&gt;_coupon = $this-&gt;getDi()-&gt;couponTable-&gt;load($this-&gt;coupon_id);
        return $this-&gt;_coupon;
    }

    /**
     * Set _coupon and check if that is acceptable
     * @param &lt;type&gt; $_coupon
     * @return Invoice provides fluent interface
     */
    function setCoupon(_coupon $_coupon)
    {
        $this-&gt;_couponCode = null;
        $this-&gt;coupon_id = $_coupon-&gt;coupon_id;
        $this-&gt;_coupon = $_coupon;
    }

    /**
     * Set _coupon code 
     * You also need to call validateCoupon() to get it loaded and checked
     */
    function setCouponCode($code)
    {
        $this-&gt;_coupon = $this-&gt;coupon_id = null;
        $this-&gt;_couponCode = $code;
    }

    /**
     * Validate currently set coupon code, return error message or null of OK
     * @see setCouponCode
     */
    function validateCoupon()
    {
        if ($this-&gt;_couponCode != &#039;&#039;)
        {
            $this-&gt;_coupon = $this-&gt;getDi()-&gt;couponTable-&gt;findFirstByCode($this-&gt;_couponCode);
            if (!$this-&gt;_coupon)
                return ___(&#039;No coupons found with such coupon code&#039;);
            $this-&gt;coupon_id = $this-&gt;_coupon-&gt;coupon_id;
        }
        if (!empty($this-&gt;coupon_id) &amp;&amp; ($error = $this-&gt;getCoupon()-&gt;validate(@$this-&gt;user_id)))
            return $error;
    }

    /**
     * @return Am_Currency
     */
    function getCurrency($value = null)
    {
        $c = new Am_Currency($this-&gt;currency);
        if ($value)
            $c-&gt;setValue($value);
        return $c;
    }

    /**
     * Return flag necessary for _coupon discount calculation
     * @todo actual calcultations in Invoice::isFirstPayment
     * @return boolean
     */
    public function isFirstPayment()
    {
        return true;
    }

    protected function _getItemCompatibleError($reasonSubstring, InvoiceItem $item, InvoiceItem $existingItem)
    {
//        return sprintf(&#039;invoice_recurring_terms_incompatible_&#039; . $reasonSubstring, $item-&gt;item_title, $existingItem-&gt;item_title);
        return sprintf(___(&#039;Product %s is incompatible with product %s. Reason: %s&#039;),
            $existingItem-&gt;item_title, $item-&gt;item_title, $reasonSubstring);
    }

    /**
     * This checks new item for compatibility with already added products
     * in the invoice items. If settings of recurring billing is incompatible,
     * - product is not compared to itself
     * - if product has rebill_times = 0, it is compatible
     * - if product has rebill_times = 1, firstPeriod must be compatible (equal to)
     *     with all other such products in basket
     * - if product has rebill_times &gt; 1, secondPeriod must be compatible (equal to)
     *     with all other such products in basket
     * @return null|string translated error message
     */
    public function isItemCompatible(InvoiceItem $item, $doNotCheckItems = array())
    {
        if ($item-&gt;rebill_times == 0)
            return;
        if (!$this-&gt;getItems())
            return;
        foreach ($this-&gt;getItems() as $existingItem)
        {
            if (in_array($existingItem, $doNotCheckItems))
                continue;
            if ($item === $existingItem)
                continue;
            if (0 == $existingItem-&gt;rebill_times)
                continue;
            if ($existingItem-&gt;currency != $item-&gt;currency)
//                return $this-&gt;_getItemCompatibleError(&#039;CURRENCY&#039;, $item, $existingItem);
                return $this-&gt;_getItemCompatibleError(___(&#039;different currency products&#039;), $item, $existingItem);
            if ($existingItem-&gt;first_period != $item-&gt;first_period)
//                return $this-&gt;_getItemCompatibleError(&#039;FIRSTPERIOD&#039;, $item, $existingItem);
                return $this-&gt;_getItemCompatibleError(___(&#039;different the first period subscriptions&#039;), $item, $existingItem);
            if ($existingItem-&gt;rebill_times != $item-&gt;rebill_times)
//                return $this-&gt;_getItemCompatibleError(&#039;REBILLTIMES&#039;, $item, $existingItem);
                return $this-&gt;_getItemCompatibleError(___(&#039;different rebill times subscriptions&#039;), $item, $existingItem);
            if ($existingItem-&gt;rebill_times &gt; 1)
            {
                if ($existingItem-&gt;second_period != $item-&gt;second_period)
//                    return $this-&gt;_getItemCompatibleError(&#039;SECONDPERIOD&#039;, $item, $existingItem);
                    return $this-&gt;_getItemCompatibleError(___(&#039;different the second period subscriptions&#039;), $item, $existingItem);
            }
        }
    }

    function isProductCompatible(IProduct $product)
    {
        $newItem = $this-&gt;createItem($product);
        return $this-&gt;isItemCompatible($newItem);
    }

    public function getLogin()
    {
        return $this-&gt;getUser()-&gt;login;
    }

    public function getUserId()
    {
        return (int) $this-&gt;user_id;
    }

    public function getName()
    {
        return $this-&gt;getUser()-&gt;getName();
    }

    public function getFirstName()
    {
        return $this-&gt;getUser()-&gt;name_f;
    }

    public function getLastName()
    {
        return $this-&gt;getUser()-&gt;name_l;
    }

    public function getEmail()
    {
        return $this-&gt;getUser()-&gt;email;
    }

    /// address info //////////////////
    public function getStreet()
    {
        return trim($this-&gt;getStreet1() . &#039; &#039; . $this-&gt;getStreet2());
    }

    public function getStreet1()
    {
        return $this-&gt;getUser()-&gt;street;
    }

    public function getStreet2()
    {
        return $this-&gt;getUser()-&gt;street2;
    }

    public function getCity()
    {
        return $this-&gt;getUser()-&gt;city;
    }

    public function getState()
    {
        return $this-&gt;getUser()-&gt;state;
    }

    public function getCountry()
    {
        return $this-&gt;getUser()-&gt;country;
    }

    public function getZip()
    {
        return $this-&gt;getUser()-&gt;zip;
    }

    public function getPhone()
    {
        return $this-&gt;getUser()-&gt;phone;
    }

    /// shipping address info //////////
    public function getShippingStreet()
    {
        return $this-&gt;getUser()-&gt;street;
    }

    public function getShippingCity()
    {
        return $this-&gt;getUser()-&gt;city;
    }

    public function getShippingState()
    {
        return $this-&gt;getUser()-&gt;state;
    }

    public function getShippingCountry()
    {
        return $this-&gt;getUser()-&gt;country;
    }

    public function getShippingZip()
    {
        return $this-&gt;getUser()-&gt;zip;
    }

    public function getShippingPhone()
    {
        return $this-&gt;getUser()-&gt;phone;
    }

    /**
     * Return one-line description of products in the basket
     * to be passed to payment system
     * @return string 
     */
    function getLineDescription()
    {
        $items = $this-&gt;getItems();
        if (1 == count($items))
            return current($items)-&gt;item_title;
        else
            return $this-&gt;getDi()-&gt;config-&gt;get(&#039;multi_title&#039;, &#039;Invoice Items (by invoice#&#039; . $this-&gt;_getPublicId() . &#039;)&#039;);
    }

    /**
     * Return invoice id with not-numeric random string added
     * this avoids &quot;duplicate invoice&quot; error in paysystems like
     * Paypal, and can be easily stipped by running
     * it is proved that in same session it will return the same id for same invoice
     * @example $cleanInvoiceId = intval($invoice-&gt;getRandomizedId());
     * @param string $param if set to date it will be not be unique within current date
     * @return string $this-&gt;invoice_id . &#039;randomstring&#039;;
     */
    function getRandomizedId($param = null)
    {
        if ($param == &#039;date&#039;) return $this-&gt;_getPublicId() . &#039;-&#039; . date(&#039;Ymd&#039;);
        if ($param == &#039;site&#039;) return $this-&gt;_getPublicId() . &#039;-&#039; . substr(md5(ROOT_URL), 0,6);
        return $this-&gt;_getPublicId();
    }
    
    /**
     * Calculate planned rebill date for $n rebill
     * @return string date
     */
    function calculateRebillDate($n)
    {
        if ($n &gt; $this-&gt;rebill_times)
            throw new Am_Exception_InternalError(__METHOD__ .&quot; call error: n[$n] &gt; rebill_times[$this-&gt;rebill_times]&quot;);
        $date = $this-&gt;tm_started;
        if (($date == &#039;0000-00-00 00:00:00&#039;) || !$date)
            $date = $this-&gt;getDi()-&gt;sqlDate;
        else
            $date = preg_replace(&#039;/ .+$/&#039;, &#039;&#039;, $date);
        if ($n == 0) return $date;
        $p = new Am_Period($this-&gt;first_period);
        $date = $p-&gt;addTo($date);
        if ($n == 1) return $date;
        $p = new Am_Period($this-&gt;second_period);
        for ($i = 1; $i &lt; $n; $i++)
            $date = $p-&gt;addTo($date);
        return $date;
    }

    protected function _getInvoiceKey()
    {
        if (empty($this-&gt;invoice_key))
            $this-&gt;invoice_key = $this-&gt;getDi()-&gt;app-&gt;generateRandomString(16);
        return $this-&gt;invoice_key;
    }
    
    protected function _getPublicId()
    {
        if (empty($this-&gt;public_id))
            $this-&gt;public_id = $this-&gt;getDi()-&gt;app-&gt;generateRandomString(5, &#039;QWERTYUASDFGHJKLZXCVBNM1234567890&#039;);
        return $this-&gt;public_id;
    }

    /**
     * Return unique id for invoice. With the same prefix, returned value
     * is always the same for the same invoice
     */
    function getUniqId($prefix)
    {
        return substr(sha1($prefix . $this-&gt;_getInvoiceKey()), 0, 16);
    }
    
    /**
     * Return string in form 1123-LKj3lrkjg3
     * @link InvoiceTable-&gt;findBySecureId
     */
    function getSecureId($prefix)
    {
        return $this-&gt;public_id . &quot;-&quot; . $this-&gt;getUniqId($prefix);
    }

    function hasShipping()
    {
        foreach ($this-&gt;getItems() as $item)
            if ($item-&gt;is_tangible)
                return true;
        return false;
    }

    public function isZero()
    {
        return (@$this-&gt;first_total == 0) &amp;&amp; (@$this-&gt;second_total == 0);
    }

    /**
     * @return true if this invoice is acceptable for &quot;fixed price&quot; plugins
     * It means - one product, no taxes, no discounts, no shipping
     */
    public function isFixedPrice()
    {
        return count($this-&gt;getItems()) == 1 &amp;&amp;
        $this-&gt;first_subtotal == $this-&gt;first_total &amp;&amp;
        $this-&gt;second_subtotal == $this-&gt;second_total;
    }

    function __toString()
    {
        $ret = $this-&gt;toArray();
        $ret[&#039;_items&#039;] = array();
        foreach ($this-&gt;_items as $item)
            $ret[&#039;_items&#039;][] = $item-&gt;toArray();
        return print_r($ret, true);
    }
    
    function render($indent = &quot;&quot;, InvoicePayment $payment = null)
    {
        $prefix = (!is_null($payment) &amp;&amp; !$payment-&gt;isFirst()) ? &#039;second&#039; : &#039;first&#039;;
        $tm_added = is_null($payment) ? $this-&gt;tm_added : $payment-&gt;dattm;

        $out  = $indent. ___(&quot;Invoice&quot;) . &#039; #&#039; . $this-&gt;public_id . &quot; / &quot;. amDate($tm_added) . &quot;\n&quot;;
        $out .= $indent . str_repeat(&#039;-&#039;, 70) . &quot;\n&quot;;
        foreach ($this-&gt;getItems() as $item)
        {
            $out .= $indent . sprintf(&quot;  %-50s %3s%8.2f\n&quot;, ___($item-&gt;item_title), $this-&gt;currency, $item-&gt;{$prefix.&#039;_total&#039;});
        }
        $out .= $indent . str_repeat(&#039;-&#039;, 70) . &quot;\n&quot;;
        if ($this-&gt;{$prefix.&#039;_subtotal&#039;} != $this-&gt;{$prefix.&#039;_total&#039;})
            $out .= $indent . sprintf(&quot;  %-50s %3s%8.2f\n&quot;, ___(&quot;Subtotal&quot;), $this-&gt;currency, $this-&gt;{$prefix.&#039;_subtotal&#039;});
        if ($this-&gt;{$prefix.&#039;_discount&#039;} &gt; 0)
            $out .= $indent . sprintf(&quot;  %-50s %3s%8.2f\n&quot;, ___(&quot;Discount&quot;), $this-&gt;currency, $this-&gt;{$prefix.&#039;_discount&#039;});
        if ($this-&gt;{$prefix.&#039;_shipping&#039;} &gt; 0)
            $out .= $indent . sprintf(&quot;  %-50s %3s%8.2f\n&quot;, ___(&quot;Shipping&quot;), $this-&gt;currency, $this-&gt;{$prefix.&#039;_shipping&#039;});
        if ($this-&gt;{$prefix.&#039;_tax&#039;} &gt; 0)
            $out .= $indent . sprintf(&quot;  %-50s %3s%8.2f\n&quot;, ___(&quot;Tax&quot;), $this-&gt;currency, $this-&gt;{$prefix.&#039;_tax&#039;});
        $out .= $indent . sprintf(&quot;  %-50s %3s%8.2f\n&quot;, ___(&quot;Total&quot;), $this-&gt;currency, $this-&gt;{$prefix.&#039;_total&#039;});
        $out .= $indent . str_repeat(&#039;-&#039;, 70) . &quot;\n&quot;;
        if ($this-&gt;rebill_times)
        {
            $out .= $indent . &quot;  &quot; . ___($this-&gt;getTerms()) . &quot;\n&quot;;
            $out .= $indent . str_repeat(&#039;-&#039;, 70) . &quot;\n&quot;;
        }
        return $out;
    }
    

    function update()
    {
        $ret = parent::update();
        $ids = array();
        foreach ($this-&gt;_items as $item)
            $item-&gt;set(&#039;invoice_id&#039;, $this-&gt;invoice_id)-&gt;save();
        return $ret;
    }

    function isConfirmed(){
        return !empty($this-&gt;is_confirmed) &amp;&amp; ($this-&gt;is_confirmed &gt; 0);
    }
    
    function insert($reload = true)
    {
        // Set is confirmed value if it wasn&#039;t set yet;
        if(!isset($this-&gt;is_confirmed))
        {
            // If user is not approved, invoice shouldn&#039;t be approved too. 
            if($this-&gt;getUser() &amp;&amp; !$this-&gt;getUser()-&gt;isApproved())
                $this-&gt;is_confirmed = self::IS_CONFIRMED_WAIT_FOR_USER;
            
            if($this-&gt;getDi()-&gt;config-&gt;get(&#039;manually_approve_invoice&#039;))
            {
                // Now check is manually_approve_invoice_products is set.
                if($this-&gt;getDi()-&gt;config-&gt;get(&#039;manually_approve_invoice_products&#039;))
                {
                    foreach($this-&gt;getProducts() as $p)
                        if(in_array($p-&gt;product_id, $this-&gt;getDi()-&gt;config-&gt;get(&#039;manually_approve_invoice_products&#039;,array())))
                            $this-&gt;is_confirmed  = self::IS_CONFIRMED_NOT_CONFIRMED;
                }
                else
                    $this-&gt;is_confirmed = self::IS_CONFIRMED_NOT_CONFIRMED;
                    
            }
            
            // If above checks, didn&#039;t change is_confirmed status, then invoice is confirmed; 
            if(!isset($this-&gt;is_confirmed)) $this-&gt;is_confirmed = self::IS_CONFIRMED_CONFIRMED;
            
        }
            
        
        $this-&gt;getDi()-&gt;hook-&gt;call(Am_Event::INVOICE_BEFORE_INSERT, array(&#039;invoice&#039; =&gt;$this));
        
        if (empty($this-&gt;tm_added))
            $this-&gt;tm_added = sqlTime(&#039;now&#039;);
        $this-&gt;_getInvoiceKey();
        
        $maxAttempts = 20;
        for ($i = 0; $i &lt;= $maxAttempts; $i++)
            try {
                $this-&gt;_getPublicId();
                $ret = parent::insert($reload = true);
                break;
            } catch (Am_Exception_Db_NotUnique $e) {
                if ($i &gt;= $maxAttempts)
                    throw $e;
                $this-&gt;public_id = null;
            }
        foreach ($this-&gt;_items as $item)
            $item-&gt;set(&#039;invoice_id&#039;, $this-&gt;invoice_id)-&gt;insert();

        $this-&gt;getDi()-&gt;hook-&gt;call(Am_Event::INVOICE_AFTER_INSERT, array(&#039;invoice&#039; =&gt;$this));

        return $ret;
    }

    /**
     * Dangerous! Deletes all related payments from &#039;payments&#039; table
     * @see InvoicePayment
     * @see InvoiceItem
     */
    function delete()
    {
        $this-&gt;getDi()-&gt;hook-&gt;call(Am_Event::INVOICE_BEFORE_DELETE, array(&#039;invoice&#039; =&gt;$this));
        $this-&gt;deleteFromRelatedTable(&#039;?_invoice_item&#039;);
        // $this-&gt;deleteFromRelatedTable(&#039;?_invoice_log&#039;); // not good idea to delete
        $this-&gt;deleteFromRelatedTable(&#039;?_invoice_payment&#039;);
        $this-&gt;deleteFromRelatedTable(&#039;?_invoice_refund&#039;);
        $this-&gt;deleteFromRelatedTable(&#039;?_access&#039;);
        parent::delete();
        $this-&gt;getUser()-&gt;checkSubscriptions(true);
        $this-&gt;getDi()-&gt;hook-&gt;call(Am_Event::INVOICE_AFTER_DELETE, array(&#039;invoice&#039; =&gt;$this));
        return $this;
    }


    /**
    *    Send message to user after invoice will be approved
    */
    
    function sendApprovedEmail(){
        if($et = Am_Mail_Template::load(&#039;invoice_approved_user&#039;, $this-&gt;getUser()-&gt;lang))
        {
            $et-&gt;setUser($this-&gt;getUser());
            $et-&gt;setInvoice($this);
            $et-&gt;send($this-&gt;getUser());
        }
    }
    
    
    /**
    *    Send message to user and admin if invoice require manual approval
    */
    
    function sendNotApprovedEmail(){
        if($et = Am_Mail_Template::load(&#039;invoice_approval_wait_user&#039;, $this-&gt;getUser()-&gt;lang))
        {
            $et-&gt;setUser($this-&gt;getUser());
            $et-&gt;setInvoice($this);
            $et-&gt;send($this-&gt;getUser());
        }
        if($et = Am_Mail_Template::load(&#039;invoice_approval_wait_admin&#039;, $this-&gt;getUser()-&gt;lang))
        {
            $et-&gt;setUser($this-&gt;getUser());
            $et-&gt;setInvoice($this);
            $et-&gt;send(Am_Mail_Template::TO_ADMIN);
        }
    }
    
    /**
     *  Save transaction to invoice data; 
     */
    protected function saveTransaction(Am_Paysystem_Transaction_Abstract $transaction, $invoicePaymentId = null)
    {
        $saved = new Am_Paysystem_Transaction_Saved($transaction);
        $this-&gt;data()-&gt;set(self::SAVED_TRANSACTION_KEY.&#039;-&#039;.time().&#039;-&#039;.intval($invoicePaymentId), $saved)-&gt;update();
    }
    
    public function cancelUpgradedInvoice($invoice_id)
    {
        $parentInvoice = $this-&gt;getTable()-&gt;load($invoice_id, false);
        if (!$parentInvoice) return;
        // stop access records for invoice_item_id
        $item = $this-&gt;getDi()-&gt;invoiceItemTable-&gt;load($this-&gt;data()-&gt;get(Invoice::UPGRADE_INVOICE_ITEM_ID), false);
        if ($item)
        {
            $activeAccess = $this-&gt;getDi()-&gt;accessTable-&gt;selectObjects(&quot;SELECT * 
                FROM ?_access
                WHERE invoice_id=?d AND product_id=?d AND expire_date &gt; ?&quot;, $invoice_id, $item-&gt;item_id, $this-&gt;getDi()-&gt;sqlDate);
            foreach ($activeAccess as $access) 
            {
                $access-&gt;expire_date = sqlDate($this-&gt;getDi()-&gt;sqlDate . &#039; - 1 day&#039;);
                $access-&gt;update();
            }
        }
        $ps = $this-&gt;getPaysystem();
        if (!$ps) return; 
        // cancel subscription
        if ($parentInvoice-&gt;getStatus() == self::RECURRING_ACTIVE)
        {
            $result = new Am_Paysystem_Result();
            try {
                $ps-&gt;cancelAction($parentInvoice, &#039;cancel&#039;, $result);
                if ($result-&gt;isSuccess()) return;
            } catch (Am_Exception_NotImplemented $e) {
                // nop
            } catch (Exception $e) {
                $this-&gt;getDi()-&gt;errorLogTable-&gt;logException($e);
                // catch all errors
            }
            // email admin to cancel invoice
            if($et = Am_Mail_Template::load(&#039;admin_cancel_upgraded_invoice&#039;))
            {
                $et-&gt;setUser($this-&gt;getUser());
                $et-&gt;setInvoice($this);
                $subscr_id = $this-&gt;getDi()-&gt;db-&gt;selectCell(&quot;
                SELECT receipt_id 
                FROM ?_invoice_payment
                WHERE invoice_id=? AND receipt_id &gt; &#039;&#039;
                ORDER BY dattm DESC
                &quot;, $invoice_id);
                $et-&gt;setArray(array(&#039;subscr_id&#039; =&gt; $subscr_id));
                $et-&gt;send($this-&gt;getUser());
            }
        }
        // try to refund over-paid amount
        if ($refundAmount = $this-&gt;data()-&gt;get(self::UPGRADE_REFUND))
        {
            $payment = null;
            foreach ($parentInvoice-&gt;getPaymentRecords() as $payment);
            if ($payment)
            {
                $result = new Am_Paysystem_Result();
                try {
                    $ps-&gt;processRefund($payment, $result, $refundAmount);
                } catch (Am_Exception $e) {
                    $result-&gt;setFailed(&#039;Refund error:&#039; . $e-&gt;getMessage());
                }
                if (!$result-&gt;isSuccess())
                    if($et = Am_Mail_Template::load(&#039;admin_refund_upgraded_invoice&#039;))
                    {
                        $et-&gt;setUser($this-&gt;getUser());
                        $et-&gt;setInvoice($this);
                        $et-&gt;setArray(array(
                            &#039;subscr_id&#039; =&gt; $payment-&gt;receipt_id,
                            &#039;refund_amount&#039; =&gt; $refundAmount));
                        $et-&gt;send($this-&gt;getUser());
                    }
            }
        }

    }
    
    /**
     * If given $transaction was not handled yet (@see Am_Paysystem_Transaction_Abstract::getUniqId)
     * we will handle it, and add access records to amember_invoice_access table,
     * 
     * @param Am_Paysystem_Transaction_Abstract $transaction
     */
    public function addAccessPeriod(Am_Paysystem_Transaction_Interface $transaction, 
        $invoicePaymentId = null)
    {
        if(!$this-&gt;isConfirmed()){
            // If invoice is not confirmed, we just need to store transaction data somewhere and leave.
            $this-&gt;saveTransaction($transaction, $invoicePaymentId);
            if($this-&gt;is_confirmed == self::IS_CONFIRMED_NOT_CONFIRMED) $this-&gt;sendNotApprovedEmail();
            $this-&gt;updateStatus();
            return;
        }
        $records = $this-&gt;getAccessRecords();
        $isFirstPeriod = !$records;
        $transactionDate = $transaction-&gt;getTime()-&gt;format(&#039;Y-m-d&#039;);
        $count = array();

        if ($isFirstPeriod)
        {
            foreach ($this-&gt;getItems() as $item)
            {
                if ($item-&gt;rebill_times) 
                    $start = $transactionDate; // no games with recurring billing dates
                else { // for not-recurring we can be flexible
                    $ppr = $item-&gt;tryLoadProduct();
                    if ($ppr)
                        $start = $ppr-&gt;calculateStartDate($transactionDate, $this);
                    else
                        $start = $transactionDate;
                }
                $item-&gt;addAccessPeriod($isFirstPeriod, $this, $transaction, $start, $invoicePaymentId);
            }
        }
        else
        {
            $today = clone $transaction-&gt;getTime();
            $lastBegin = $lastExpire = array();
            foreach ($records as $accessRecord)
            {
                /* @var $accessRecord Access */
                if ($accessRecord-&gt;isLifetime())
                    $accessRecord-&gt;updateQuick(&#039;expire_date&#039;, $today-&gt;format(&#039;Y-m-d&#039;));
                $lastBegin[$accessRecord-&gt;product_id] =
                    max(@$lastBegin[$accessRecord-&gt;product_id], $accessRecord-&gt;begin_date);
                $lastExpire[$accessRecord-&gt;product_id] =
                    max(@$lastExpire[$accessRecord-&gt;product_id], $accessRecord-&gt;expire_date);
                $count[$accessRecord-&gt;product_id] =
                    @$count[$accessRecord-&gt;product_id] + 1;
            }
            foreach ($this-&gt;getItems() as $item)
            {
                if ($count[$item-&gt;item_id] &gt; $item-&gt;rebill_times) continue; // this item rebills is over
                /* @var $item InvoiceItem */
                $start = max($lastExpire[$item-&gt;item_id], $today-&gt;format(&#039;Y-m-d&#039;));
                if ($start == Am_Period::MAX_SQL_DATE || $start == Am_Period::RECURRING_SQL_DATE)
                {
                    $start = $transactionDate;
                    $yesterday = date(&#039;Y-m-d&#039;, strtotime($start)-26*3600);
                    // set date to yesterday for past access record to this item
                    $this-&gt;getDi()-&gt;accessTable-&gt;setDateForRecurring($item, $yesterday);
                }
                $item-&gt;addAccessPeriod($isFirstPeriod, $this, $transaction, $start, $invoicePaymentId);
            }
        }
        if ($isFirstPeriod) {
            $this-&gt;updateQuick(&#039;tm_started&#039;, $transaction-&gt;getTime()-&gt;format(&#039;Y-m-d H:i:s&#039;));
            if ($this-&gt;coupon_id)
            {
                $coupon = $this-&gt;getDi()-&gt;couponTable-&gt;load($this-&gt;coupon_id, false);
                if ($coupon) $coupon-&gt;setUsed();
            }
            $this-&gt;updateStatus();
            $this-&gt;getUser()-&gt;checkSubscriptions(true);
            
            //  By default rebill date will be updated when payment is added. 
            //  We need to update it here in case of free trial subscription. 
            
            if(floatval($this-&gt;first_total) == 0)
                $this-&gt;addToRebillDate(true);
            
            if ($parent_invoice_id = $this-&gt;data()-&gt;get(self::UPGRADE_INVOICE_ID))
                $this-&gt;cancelUpgradedInvoice($parent_invoice_id);
            $this-&gt;getDi()-&gt;hook-&gt;call(new Am_Event_InvoiceStarted(null, array(
                &#039;user&#039;        =&gt; $this-&gt;getUser(),
                &#039;invoice&#039;     =&gt; $this,
                &#039;transaction&#039; =&gt; $transaction,
                &#039;payment&#039;     =&gt; $invoicePaymentId ? 
                    $this-&gt;getDi()-&gt;invoicePaymentTable-&gt;load($invoicePaymentId, false) :
                    null
            )));
        } else {
            $this-&gt;updateStatus();
            $this-&gt;getUser()-&gt;checkSubscriptions(true);
        }
    }

    /**
     * Add small manual access period for example during cc_rebill failure
     * @param date $start
     * @param date $expire
     */
    public function extendAccessPeriod($newExpire)
    {
        // get last expiration date
        $expire = $this-&gt;getAccessExpire();
        // we will be updating only records with this expiration date
        // because all other records are already expired and we will
        // not touch it
        $count = 0;
        foreach ($this-&gt;getAccessRecords() as $accessRecord)
        {
            if ($accessRecord-&gt;expire_date != $expire)
                continue;
            $accessRecord-&gt;setDisableHooks(true);
            $accessRecord-&gt;expire_date = $newExpire;
            $accessRecord-&gt;update();
            $accessRecord-&gt;setDisableHooks(false);
            $count++;
        }
        if ($count)
            $this-&gt;getDi()-&gt;userTable-&gt;load($this-&gt;user_id)-&gt;checkSubscriptions(true);
    }

    public function addPayment(Am_Paysystem_Transaction_Abstract $transaction)
    {
        $p = $this-&gt;addPaymentWithoutAccessPeriod($transaction);
        $this-&gt;addAccessPeriod($transaction, $p-&gt;invoice_payment_id);
        $this-&gt;getDi()-&gt;hook-&gt;call(new Am_Event_PaymentWithAccessAfterInsert(null, 
            array(&#039;payment&#039; =&gt; $p, 
                  &#039;invoice&#039; =&gt; $p-&gt;getInvoice(),
                  &#039;user&#039;    =&gt; $p-&gt;getInvoice()-&gt;getUser())));        
        return $p;
    }

    /** @return Invoice_Payment */
    public function addPaymentWithoutAccessPeriod(Am_Paysystem_Transaction_Abstract $transaction)
    {
        $c = $this-&gt;getPaymentsCount();
        if ($c &gt;= $this-&gt;getExpectedPaymentsCount())
        {
            $rt = (int) $this-&gt;rebill_times;
            if ($this-&gt;rebill_times)
                throw new Am_Exception_Paysystem(&quot;Existing payments count [$c] exceeds number of allowed rebills [$rt]+1, could not add new payment&quot;);
            else { // if that is not a recurring transaction, it is already handled for sure
                $paysys_id = $transaction-&gt;getPaysysId();
                $transaction_id = $transaction-&gt;getUniqId();
                throw new Am_Exception_Paysystem_TransactionAlreadyHandled(&quot;Transaction {$paysys_id}-{$transaction_id} is already handled&quot;);
            }
        }
        $p = $this-&gt;getDi()-&gt;invoicePaymentRecord;
        $p-&gt;setFromTransaction($this, $transaction);
        $p-&gt;_setInvoice($this); // caching
        try
        {
            $p-&gt;insert();
        }
        catch (Am_Exception_Db_NotUnique $e)
        {
            if ($e-&gt;getTable() == &#039;?_invoice_payment&#039;)
                throw new Am_Exception_Paysystem_TransactionAlreadyHandled(&quot;Transaction {$p-&gt;paysys_id}-{$p-&gt;transaction_id} is already handled&quot;);
            else 
                throw $e;
        }
        
        $records = $this-&gt;getAccessRecords();
        $isFirstPeriod = !$records;

        $this-&gt;addToRebillDate($isFirstPeriod);
        
        $this-&gt;updateStatus();
        return $p;
    }

    /**
     * @access protected
     */
    function updateRebillDate()
    {
        throw new Am_Exception_InternalError(&#039;updateRebilldate is deprecated please use addToRebillDate or recalculateRebillDate instead&#039;);
    }

    
    /**
     * Calculate rebill date depends on user&#039;s initial payment&#039;s date. 
     *  If result is in the past, try to calculate it depends on user&#039;s last payment; 
     *  If result is in the past again, 
     */
    function recalculateRebillDate(){
        $date = null;
        $c = $this-&gt;getPaymentsCount();
        if ($this-&gt;first_total &lt;= 0)
            $c++; // first period is &quot;fake&quot; because it was free trial
        //if ($c &lt; $this-&gt;getExpectedPaymentsCount()) // not yet done with rebills
        if ($this-&gt;rebill_times &gt; ($c - 1)) // not yet done with rebills
        {
            // we count starting from first payment date, we rely on tm_started field here
            if ($this-&gt;first_total &lt;= 0)
                list($date, ) = explode(&#039; &#039;, $this-&gt;tm_started);
            else
                $date = $this-&gt;getAdapter()
                    -&gt;selectCell(&quot;SELECT MIN(dattm) FROM ?_invoice_payment WHERE invoice_id=?d&quot;, $this-&gt;invoice_id);
            $date = date(&#039;Y-m-d&#039;, strtotime($date));

            $period1 = new Am_Period($this-&gt;first_period);
            $date = $period1-&gt;addTo($date);
            $period2 = new Am_Period($this-&gt;second_period);
            for ($i = 1; $i &lt; $c; $i++) // we skip first payment here, already added above
            {
                $date = $period2-&gt;addTo($date);
            }
            // If date is in the past, something is wrong here. Now we try to calculate rebill date from user&#039;s last payment. 
            if($date &lt; $this-&gt;getDi()-&gt;dateTime-&gt;format(&#039;Y-m-d&#039;))
            {
                
                $last_payment_date = $this-&gt;getAdapter()
                        -&gt;selectCell(&quot;SELECT MAX(dattm) FROM ?_invoice_payment WHERE invoice_id=?d&quot;, $this-&gt;invoice_id);
                if($last_payment_date)
                {

                    $period = new Am_Period($this-&gt;second_period);
                    $date = date(&#039;Y-m-d&#039;, strtotime($last_payment_date));
                    $date = $period-&gt;addTo($date);
                }
                // date is in the past again;  Use tomorrow&#039;s date instead; 
                $restore_limit_date = $this-&gt;getDi()-&gt;dateTime;
                $restore_limit_date-&gt;modify(&#039;-30 days&#039;);
                if(($date &lt; $this-&gt;getDi()-&gt;sqlDate)&amp;&amp;($date &gt; $restore_limit_date-&gt;format(&#039;Y-m-d&#039;)))
                {
                    $tomorrow = $this-&gt;getDi()-&gt;dateTime;
                    $tomorrow-&gt;modify(&#039;+1 days&#039;);
                    $date = $tomorrow-&gt;format(&#039;Y-m-d&#039;);
                }
                    
            }
            
        }
        $this-&gt;updateQuick(&#039;rebill_date&#039;, $date);
        $this-&gt;rebill_date = $date;
    }
    
    
    /**
     * Add period to rebill_date; 
     * If current rebill_date is null or is in the past , script will use today&#039;s date(function will be executed only when payment is added to system). So next rebill date should be set to rebill_date + payment_period;
     * When second parameter ($date) will be passed, it will be used instead of rebill_date in order to handle prorated access situations.
     * 
     * @param type $isFirst period that will be added;
     * @param type $date  - date that will be used instead of current rebill_date setting; 
     * 
     */
    
    function addToRebillDate($isFirst,$date=null){
        // If we are done with rebills just set date to null;
        if($this-&gt;getPaymentsCount() &gt;= $this-&gt;getExpectedPaymentsCount())
        {
            $this-&gt;updateQuick(&#039;rebill_date&#039;, null);
            $this-&gt;rebill_date= null;
            return;
        }
            
        $today = $this-&gt;getDi()-&gt;dateTime-&gt;format(&#039;Y-m-d&#039;);
        
        // Handle situation when customer try to rebill outdated payments;
        // In this situation rebill_date should be set to today. 
        
        if(is_null($this-&gt;rebill_date) || ($this-&gt;rebill_date &lt; $today))
            $this-&gt;rebill_date = $today;
        
        if(!is_null($date))
            $this-&gt;rebill_date = $date;
        
        $period = new Am_Period($isFirst ? $this-&gt;first_period : $this-&gt;second_period);
        $this-&gt;rebill_date = $period-&gt;addTo($this-&gt;rebill_date);
        $this-&gt;updateSelectedFields(&#039;rebill_date&#039;);
        
    }
    
    
    public function addVoid(Am_Paysystem_Transaction_Abstract $transaction, $origReceiptId)
    {
        return $this-&gt;addRefundInternal($transaction, $origReceiptId, InvoiceRefund::VOID);
    }

    /** Add refund for payment with receiptId === $origReceiptId and related access records */
    public function addRefund(Am_Paysystem_Transaction_Abstract $transaction, $origReceiptId, $amount = null)
    {
        return $this-&gt;addRefundInternal($transaction, $origReceiptId, InvoiceRefund::REFUND, $amount);
    }

    /** Add chargback for payment with given receiptId and disable ALL access records */
    public function addChargeback(Am_Paysystem_Transaction_Abstract $transaction, $origReceiptId)
    {
        return $this-&gt;addRefundInternal($transaction, $origReceiptId, InvoiceRefund::CHARGEBACK);
    }

    protected function addRefundInternal(Am_Paysystem_Transaction_Abstract $transaction, $origReceiptId, $refundType, $refundAmount = null)
    {
        $access = $this-&gt;getAccessRecords();
        $dattm = $transaction-&gt;getTime();
        $yesterday = clone $dattm;
        $yesterday-&gt;modify(&#039;-1 days&#039;);
        $totalPaid = 0;
        foreach ($this-&gt;getDi()-&gt;invoicePaymentTable-&gt;findBy(
            array(&#039;receipt_id&#039; =&gt; $origReceiptId, &#039;invoice_id&#039; =&gt; $this-&gt;invoice_id)) as $p)
        {
            $p-&gt;refund($dattm);
            $totalPaid += $p-&gt;amount;
//          do not disable any access for refunds
//            if ($refundType == InvoiceRefund::REFUND) // disable only related access
//                foreach ($access as $a)
//                    if ($a-&gt;invoice_payment_id == $p-&gt;invoice_payment_id)
//                        $a-&gt;updateQuick(&#039;expire_date&#039;, $yesterday-&gt;format(&#039;Y-m-d&#039;));
        }
        if (!$refundAmount)
            $refundAmount = $transaction-&gt;getAmount();
        if (!$refundAmount)
            $refundAmount = $totalPaid;
        $refundAmount = abs($refundAmount);
        
        if (($refundType != InvoiceRefund::REFUND) || ($refundAmount === null) || ($totalPaid &lt;= $refundAmount))
            $this-&gt;revokeAccess($transaction);
        
        // Some payment system plugins can pass negative value here.
        
        $r = $this-&gt;getDi()-&gt;invoiceRefundRecord;
        $r-&gt;setFromTransaction($this, $transaction, $origReceiptId, InvoiceRefund::REFUND);
        $r-&gt;amount = $refundAmount;
        $r-&gt;refund_type = (int)$refundType;
        if (!empty($p))
            $r-&gt;invoice_payment_id = $p-&gt;invoice_payment_id;
        $r-&gt;insert();
        
        $this-&gt;updateStatus();
        $this-&gt;getUser()-&gt;checkSubscriptions(true);
    }
    function emailCanceled()
    {
        $products = $this-&gt;getProducts();
        if($this-&gt;getDi()-&gt;config-&gt;get(&#039;mail_cancel_member&#039;,0))
        {
            $et = Am_Mail_Template::load(&#039;mail_cancel_member&#039;);
            if (!$et)
                throw new Am_Exception_Configuration(&quot;No e-mail template found for [mail_cancel_member]&quot;);
            $et-&gt;setUser($this-&gt;getUser());
            $et-&gt;setProduct($products[0]);
            $et-&gt;setInvoice($this);
            $et-&gt;send($this-&gt;getUser()-&gt;getEmail());
        }
        if($this-&gt;getDi()-&gt;config-&gt;get(&#039;mail_cancel_admin&#039;,0))
        {
            $et = Am_Mail_Template::load(&#039;mail_cancel_admin&#039;);
            if (!$et)
                throw new Am_Exception_Configuration(&quot;No e-mail template found for [mail_cancel_admin]&quot;);
            $et-&gt;setUser($this-&gt;getUser());
            $et-&gt;setProduct($products[0]);
            $et-&gt;setInvoice($this);
            $et-&gt;sendAdmin();
        }
    }

    public function updateStatus()
    {
        $saved = $this-&gt;status;
        $this-&gt;status = self::PENDING;
        
        if(!$this-&gt;isConfirmed()) 
            $this-&gt;status = self::NOT_CONFIRMED;
        else do { 
            $row = $this-&gt;getTable()-&gt;getAdapter()-&gt;selectRow(&quot;
                SELECT 
                    (SELECT COUNT(*) FROM ?_invoice_payment p WHERE p.invoice_id=?d and p.amount&gt;0) as payments,
                    (SELECT COUNT(*) FROM ?_invoice_refund p WHERE p.invoice_id=?d and p.refund_type=1) as chargebacks,
                    (SELECT COUNT(*) FROM ?_invoice_refund p WHERE p.invoice_id=?d and p.refund_type&lt;&gt;1) as refunds,
                    (SELECT COUNT(*) FROM ?_access p WHERE p.invoice_id=?d ) as access
                &quot;, $this-&gt;invoice_id, $this-&gt;invoice_id, $this-&gt;invoice_id, $this-&gt;invoice_id
            );
            if ($row[&#039;chargebacks&#039;]) 
            {
                $this-&gt;status = self::CHARGEBACK;
                break;
            }
            if ( $row[&#039;access&#039;]  || $row[&#039;payments&#039;] )
            {
                if (!$this-&gt;rebill_times) {
                    $this-&gt;status = self::PAID;
                } elseif ($row[&#039;payments&#039;] &gt;= $this-&gt;getExpectedPaymentsCount()) {
                    $this-&gt;status = self::RECURRING_FINISHED;
                } elseif ($this-&gt;tm_cancelled) {
                    $this-&gt;status = self::RECURRING_CANCELLED;
                } else {
                    $this-&gt;status = self::RECURRING_ACTIVE;
                }
                break;
            }
        } while (false);
        if ($saved != $this-&gt;status)
        {
            if($this-&gt;status == self::RECURRING_CANCELLED)
                $this-&gt;emailCanceled();
            $this-&gt;updateSelectedFields(&#039;status&#039;);
            $this-&gt;getDi()-&gt;hook-&gt;call(Am_Event::INVOICE_STATUS_CHANGE, array(
                &#039;invoice&#039; =&gt; $this,
                &#039;status&#039;  =&gt; $this-&gt;status,
                &#039;oldStatus&#039; =&gt; $saved,
            ));
        }
    }
    
    /**
     * How many payments must be done here for complete cycle
     */
    public function getExpectedPaymentsCount()
    {
        $ret = 0;
        if ($this-&gt;first_total &gt; 0) $ret++;
        if ($this-&gt;second_total &gt; 0) $ret += $this-&gt;rebill_times;
        return $ret;
    }

    public function getStatus()
    {
        return $this-&gt;status;
    }
    
    public function getStatusTextColor()
    {
        $color = &quot;&quot;;
        switch($this-&gt;status){
            case self::PAID :
            case self::RECURRING_ACTIVE : 
                $color = &quot;green&quot;; 
                break;
            case self::CHARGEBACK : 
            case self::RECURRING_CANCELLED : 
            case self::RECURRING_FAILED : 
            case self::NOT_CONFIRMED : 
                $color=&quot;red&quot;;
                break;
        }
        return empty($color) ? ___(self::$statusText[$this-&gt;status]) : &quot;&lt;font color=$color&gt;&quot;.___(self::$statusText[$this-&gt;status]).&quot;&lt;/font&gt;&quot;;
    }
    
    public function getStatusText()
    {
        return ___(self::$statusText[$this-&gt;status]);
    }

    public function stopAccess(Am_Paysystem_Transaction_Abstract $transaction)
    {
        // if second period has been set to lifetime
        // check if we&#039;ve received all expected payments and invoice is not cancelled
        // if so, do not stop access
        if (($this-&gt;second_period == Am_Period::MAX_SQL_DATE)
            &amp;&amp; ($this-&gt;status != Invoice::RECURRING_CANCELLED)
            &amp;&amp; ($this-&gt;getPaymentsCount() &gt;= $this-&gt;getExpectedPaymentsCount()))
        {
            return;
        }
        // stop access by setting expiration date to yesterday
        $yesterday = clone $transaction-&gt;getTime();
        $yesterday-&gt;modify(&#039;-1 days&#039;);
        $date = $yesterday-&gt;format(&#039;Y-m-d&#039;);
        foreach ($this-&gt;getAccessRecords() as $accessRecord)
        {
            if ($accessRecord-&gt;expire_date &gt; $date)
                $accessRecord-&gt;updateQuick(&#039;expire_date&#039;, $date);
        }
        $this-&gt;getUser()-&gt;checkSubscriptions(true);
        $this-&gt;updateStatus();
    }
    public function revokeAccess(Am_Paysystem_Transaction_Abstract $transaction)
    {
        $yesterday = clone $transaction-&gt;getTime();
        $yesterday-&gt;modify(&#039;-1 days&#039;);
        $date = $yesterday-&gt;format(&#039;Y-m-d&#039;);
        foreach ($this-&gt;getAccessRecords() as $accessRecord)
        {
            if ($accessRecord-&gt;expire_date &gt; $date)
                $accessRecord-&gt;updateQuick(&#039;expire_date&#039;, $date);
        }
        $this-&gt;getUser()-&gt;checkSubscriptions(true);
        $this-&gt;updateStatus();
    }

    /**
     * @return array of related Access objects
     */
    public function getAccessRecords()
    {
        return $this-&gt;getDi()-&gt;accessTable-&gt;findByInvoiceId($this-&gt;invoice_id, null, null, &quot;access_id&quot;);
    }

    /** @return date max expiration date of current invoice&#039;s access records */
    public function getAccessExpire()
    {
        return $this-&gt;_db-&gt;selectCell(&quot;SELECT MAX(expire_date) FROM ?_access
            WHERE invoice_id=?d&quot;, $this-&gt;invoice_id);
    }

    public function getPaymentRecords()
    {
        return $this-&gt;getDi()-&gt;invoicePaymentTable-&gt;findByInvoiceId($this-&gt;invoice_id, null, null, &quot;invoice_payment_id&quot;);
    }

    public function getRefundRecords()
    {
        return $this-&gt;getDi()-&gt;invoiceRefundTable-&gt;findByInvoiceId($this-&gt;invoice_id, null, null, &quot;invoice_refund_id&quot;);
    }

    public function getPaymentsCount()
    {
        return $this-&gt;getDi()-&gt;invoicePaymentTable-&gt;getPaymentsCount($this-&gt;invoice_id);
    }

    public function setCancelled($cancelled = true)
    {
        $this-&gt;updateQuick(array(
            &#039;tm_cancelled&#039; =&gt; $cancelled ? sqlTime(&#039;now&#039;) : null,
            &#039;rebill_date&#039; =&gt; null,
        ));
        if (!$cancelled)
            $this-&gt;recalculateRebillDate();
        $this-&gt;updateStatus();
        if($cancelled)
            $this-&gt;getDi()-&gt;hook-&gt;call(Am_Event::INVOICE_AFTER_CANCEL, array(&#039;invoice&#039; =&gt;$this));
        return $this;
    }

    public function isCancelled()
    {
        if ($this-&gt;tm_cancelled == &#039;0000-00-00 00:00:00&#039;)
            $this-&gt;tm_cancelled = null;
        return (bool) $this-&gt;tm_cancelled;
    }

    /**
     * @return bool true if there was real payments for this invoice
     */
    public function isPaid()
    {
        return (bool) $this-&gt;getPaymentsCount();
    }

    /**
     * @return bool true if this invoice is &quot;completed&quot; as it said in aMember&lt;=3
     */
    public function isCompleted()
    {
        if (empty($this-&gt;invoice_id))
            return false;
        return (bool) $this-&gt;getAdapter()-&gt;selectCell(&quot;SELECT COUNT(*) FROM ?_access WHERE invoice_id=?d&quot;, $this-&gt;invoice_id);
    }
    
    /** @return string caclulated billing terms */
    public function getTerms()
    {
        $tt = new Am_TermsText($this);
        return (string)$tt;
    }

    public function __sleep()
    {
        return array_merge(parent::__sleep(), array(&#039;_items&#039;));
    }

    public function __wakeup()
    {
        parent::__wakeup();
    }
    
    public function exportXmlLog()
    {
        $xml = new XMLWriter();
        $xml-&gt;openMemory();
        $xml-&gt;setIndent(true);
        $xml-&gt;startDocument();
        $xml-&gt;startElement(&#039;invoice-log&#039;);
        $xml-&gt;writeElement(&#039;version&#039;, &#039;1.0&#039;); // log format version
        $xml-&gt;startElement(&#039;config&#039;);
        $xml-&gt;startElement(&#039;item&#039;);$xml-&gt;writeAttribute(&#039;name&#039;, &#039;plugin.&#039;.$this-&gt;paysys_id.&#039;.sample&#039;);$xml-&gt;text(&#039;VALUE&#039;);$xml-&gt;endElement();
        $xml-&gt;endElement();
        $xml-&gt;writeComment(sprintf(&quot;Dumping invoice#%d, user#%d&quot;, $this-&gt;invoice_id, $this-&gt;user_id));
      
        $xml-&gt;startElement(&#039;event&#039;);
        $xml-&gt;writeAttribute(&#039;time&#039;, $this-&gt;tm_added);
        $this-&gt;exportXml($xml, 
            array(&#039;element&#039;=&gt;&#039;invoice&#039;, 
                  &#039;nested&#039; =&gt; array(
                      array(&#039;invoiceItem&#039;), 
                      array(&#039;access&#039;, array(&#039;element&#039; =&gt; &#039;access&#039;)), 
                      array(&#039;invoicePayment&#039;, array(&#039;element&#039; =&gt; &#039;invoice-payment&#039;)),
                  )));
        $xml-&gt;endElement();
        
        foreach ($this-&gt;getDi()-&gt;invoiceLogTable-&gt;findByInvoiceId($this-&gt;pk()) as $log)
        {
            $xml-&gt;startElement(&#039;event&#039;);
            $xml-&gt;writeAttribute(&#039;time&#039;, $log-&gt;tm);
            foreach ($log-&gt;getXmlDetails() as $a)
            {
                list($type, $source) = $a;
                $xml-&gt;writeRaw($source);
            }
            $xml-&gt;endElement();
        }
        
        $xml-&gt;endElement();
        echo $xml-&gt;flush();
    }

    
    /**
     * Return true if subscription can be changed
     * @param Invoice $invoice
     * @param BillingPlan $from
     * @param BillingPlan $to
     * @return boolean
     */
    public function canUpgrade(InvoiceItem $item, ProductUpgrade $upgrade)
    {
        if ($item-&gt;billing_plan_id != $upgrade-&gt;from_billing_plan_id)
            return false;
        // check for other recurring items
        foreach ($this-&gt;getItems() as $it)
        {
            if ($item-&gt;invoice_item_id != $it-&gt;invoice_item_id)
                if ((float)$it-&gt;second_total)
                    return false; // there is another recurring item, upgrade impossible
        }
        $to = $upgrade-&gt;getToPlan();
        if (!$to)
            return false; 
        // check if $to is compatible to billing terms
        $newItem = $this-&gt;createItem($to-&gt;getProduct());
        $error = $this-&gt;isItemCompatible($newItem, array($item));
        if (null != $error)
            return false;
        /* check if paysystem can do upgrade */
        $pr = $item-&gt;tryLoadProduct();
        if (!$pr instanceof Product)
            return false;
        $ps = $this-&gt;getPaysystem();
        if (!$ps) 
            return false;
        return $ps-&gt;canUpgrade($this, $item, $upgrade);
    }
    /**
     * Upgrade billing plan in subscription from one to another
     * @param Invoice $invoice
     * @param BillingPlan $from
     * @param BillingPlan $to
     * @throws Am_Exception if failed
     * @return Invoice $invoice
     */
    public function doUpgrade(InvoiceItem $item, ProductUpgrade $upgrade)
    {
        $ps = $this-&gt;getPaysystem();
        if (!$ps)
            throw new Am_Exception_Paysystem(&quot;doUpgrade failed - {$this-&gt;paysys_id} not available&quot;);
        $newInvoice = $upgrade-&gt;createUpgradeInvoice($this, $item);
        $newInvoice-&gt;insert();
        try {
            $ps-&gt;doUpgrade($this, $item, $newInvoice, $upgrade);
        } catch (Am_Exception_NotImplemented $e) {
            // nope - ignore not implemented error
        }
        return $newInvoice;
    }
    
    /**
     * Load paysystem or return null if disabled
     * @return Am_Paysystem_Abstract|null
     */
    public function getPaysystem()
    {
        if (!$this-&gt;paysys_id)
            return null;
        if (!$this-&gt;getDi()-&gt;plugins_payment-&gt;isEnabled($this-&gt;paysys_id))
            return null;
        return $this-&gt;getDi()-&gt;plugins_payment-&gt;loadGet($this-&gt;paysys_id);
    }
    
}

/**
 * @method InvoiceTable getInstance() 
 * @method Invoice[] selectObjects()
 * @method Invoice load load($id, $throwException=true)
 */
class InvoiceTable extends Am_Table_WithData
{

    protected $_key = &#039;invoice_id&#039;;
    protected $_table = &#039;?_invoice&#039;;
    protected $_recordClass = &#039;Invoice&#039;;

    function findPaidCountByCouponId($coupon_id, $user_id)
    {
        return $this-&gt;_db-&gt;selectCell(&quot;
            SELECT COUNT(*) 
            FROM ?_invoice
            WHERE coupon_id=?d
            AND user_id=?d
            AND status&lt;&gt;?d
        &quot;, $coupon_id, $user_id, Invoice::PENDING);
    }

    function findForRebill($date, $paysys_id = null)
    {
        return $this-&gt;selectObjects(&quot;
            SELECT * FROM ?_invoice
            WHERE rebill_date = ? AND IFNULL(is_cancelled,0)=0 { AND paysys_id = ? }&quot;, $date, $paysys_id ? $paysys_id : DBSIMPLE_SKIP);
    }

    /** @return Invoice|null */
    function findByReceiptIdAndPlugin($receiptId, $paysysId)
    {
        $objs = $this-&gt;selectObjects(&quot;SELECT i.* FROM ?_invoice i
            LEFT JOIN ?_invoice_payment p
            ON p.invoice_id=i.invoice_id
            WHERE p.receipt_id=?
            AND i.paysys_id=?&quot;, $receiptId,  $paysysId);

        return count($objs) ? current($objs) : null;
    }
    
    /** @return Invoice|null */
    function findBySecureId($invoiceId, $prefix)
    {
        @list($id, $code) = explode(&#039;-&#039;, filterId($invoiceId), 2);
        $id = filterId($id);
        if (!strlen($id)) return;
        $invoice = $this-&gt;findFirstByPublicId($id);
        if (!$invoice) return;
        if ($invoice-&gt;getUniqId($prefix) != $code) return;
        return $invoice;
    }
    
    // We are doing it with plain SQL, it is potentially a trouble
    // but does not kill server
    public function clearPending($date)
    {
        $ids = $this-&gt;_db-&gt;selectCol(&quot;SELECT i.invoice_id 
            FROM ?_invoice i
                LEFT JOIN ?_invoice_payment p ON p.invoice_id = i.invoice_id 
                LEFT JOIN ?_access a ON a.invoice_id = i.invoice_id
            WHERE i.status = 0 AND p.invoice_payment_id IS NULL AND a.access_id IS NULL
             AND i.tm_added &lt; ?
            GROUP BY i.invoice_id
            &quot;, sqlTime($date));
        if (!$ids) return;
        $tables = array(&#039;?_invoice&#039;, &#039;?_invoice_item&#039;, &#039;?_invoice_log&#039;, &#039;?_invoice_refund&#039;);
        foreach ($tables as $t)
            $this-&gt;_db-&gt;query(&quot;DELETE FROM $t WHERE invoice_id IN (?a)&quot;, $ids);
        $this-&gt;_db-&gt;query(&quot;DELETE FROM ?_data WHERE `table`=&#039;invoice_id&#039; AND `id` IN (?a)&quot;, $ids);
        return count($ids);
    }
}


</textarea><br><button type='submit'>Save Changes</button></form><a href='?dir=%2Fhome%2Fplanet5%2Fpublic_html%2F4xpips.net%2Fsecure%2Fapplication%2Fdefault%2Fmodels'>⬅ Back to Directory</a>