form_ecommerce.inc

<?php
require_once SQ_PACKAGES_PATH.'/cms/form/form_email/form_email.inc';
require_once SQ_FUDGE_PATH.'/general/www.inc';
require_once SQ_FUDGE_PATH.'/general/file_system.inc';
require_once SQ_PACKAGES_PATH.'/ecommerce/orders/order/order.inc';

class Form_Ecommerce extends Form_Email
{

    var $confirm_view = 'confirmation';

    var $process_view = 'process';

    var $receipt_view = 'receipt';

    var $_bodycopies = Array('Form', 'Confirmation', 'Receipt');


    function Form_Ecommerce($assetid=0)
    {
        $this->Form_Email($assetid);

    }//end constructor


    function _createAdditional(&$link)
    {
        return $this->_createBodycopies();

    }//end _createAdditional()


    function _createBodycopies()
    {
        $result = TRUE;
        foreach ($this->_bodycopies as $bodycopy) {
            $result = $result && $this->createBodycopy($bodycopy);
        }

        return $result;

    }//end _createBodycopies()


    function _getAllowedLinks()
    {
        $order_links = parent::_getAllowedLinks();
        $order_links[SQ_LINK_TYPE_2]['folder'] = Array('card' => 'M');
        return $order_links;

    }//end _getAllowedLinks()


    function _isAllowedQuestionType($type='')
    {
        switch ($type) {
            case('form_question_type_numeric'):
            case('form_question_type_select'):
            case('form_question_type_option_list'):
            case('form_question_type_tickbox_list'):
            case('form_question_type_tickbox_table'):
                return TRUE;

            default:
                return FALSE;
        }

    }//end _isAllowedQuestionType()


    function _isAllowedPassThroughQuestionType($type='')
    {
        switch ($type) {
            case('form_question_type_text'):
            case('form_question_type_numeric'):
            case('form_question_type_email_address'):
            case('form_question_type_select'):
            case('form_question_type_option_list'):
            case('form_question_type_tickbox_list'):
            case('form_question_type_tickbox_table'):
            case('form_question_type_country'):
                return TRUE;

            default:
                return FALSE;
        }

    }//end _isAllowedPassThroughQuestionType()
    
    
    function _getEcommerceRule($name='')
    {
        // get e-commerce rules
        $e_questions = $this->attr('rules');
        $result = array_get_index($e_questions, $name, FALSE);
        return $result;

    }//end _getEcommerceRule()


    function _setEcommerceRule($name, $value)
    {
        $rules = $this->attr('rules');

        if (!isset($rules[$name])) return FALSE;

        $rules[$name] = $value;
        $this->setAttrValue('rules', $rules);

        return TRUE;

    }//end _setEcommerceRule()


    function printStandard()
    {
        // an order in this case is a state of this form which was saved in a file
        if (isset($_SESSION[$this->getPrefix()]['order'])) {
            $order =& $_SESSION[$this->getPrefix()]['order'];
        } else {
            $order = $this->_readOrder();
        }

        $am =& $GLOBALS['SQ_SYSTEM']->am;

        // check to see if the form has been submitted or not
        $action = array_get_index($_REQUEST, $this->getPrefix().'_action');
        if (isset($_REQUEST[$this->getPrefix().'_submit'])) {
            if ($this->processPage(1) && empty($action)) {
                // Save Values for File Uploads and the create File asset if create location is specified
                $questions =& $this->getAllQuestionAssets();
                for (reset($questions); $question =& $questions[key($questions)]; next($questions)) {
                    if($question instanceof Form_Question_Type_File_Upload) {
                        $question->saveValue($this);
                        $this->current_answers[$question->id]      = $question->getValue();
                        $this->extra_data[$question->id]      = $question->getExtraData();

                        if (method_exists($question, 'onSubmitForm')) {
                            $question->onSubmitForm($this);
                            $this->extra_data[$question->id]      = $question->getExtraData();
                            if (!empty($question->failed_rules)) {
                                if (!is_array($this->submission_errors)) $this->submission_errors = Array();
                                $this->submission_errors = array_merge($this->submission_errors, $question->failed_rules);
                            }
                        }       
                    }

                }
                if(empty($this->submission_errors))
                    $action = $this->confirm_view;
            }
        } else if (!empty($order)) {
            //only get the current answers from session variables if we do not process after the submit button is clicked
            //if we put this block of codes before processPage() method is called like in the previous version, the result
            //of the answers will be wrong with tickbox list question type (it remembers the previous checked answer not the current unchecked one)
            $this->current_answers = $order['submission'];
            $this->extra_data = $order['submission_extra_data'];
            $this->repopulate();
        }
        
        $request_var_name = $this->attr('item_req_var');
        if (empty($action) && isset($_REQUEST[$request_var_name])) {
            $action = 'add_to_cart';
        }

        // determine which view to display
        switch ($action) {
            case ('add_to_cart'):
                // MAYBE: Convert to parameter map
                if ($request_var_name == '') break;

                $assetid = @$_REQUEST[$request_var_name];
                if (is_null($assetid)) break;

                $quantity = @$_REQUEST[$this->attr('item_quantity_req_var')];

                if (!$this->_addAssetItem($assetid, $quantity)) {
                    trigger_error('This item cannot be purchased', E_USER_NOTICE);
                    break;
                }
                
                $promo_code_var_name = $this->attr('item_promo_code_req_var');
                if (($promo_code_var_name != '') && isset($_REQUEST[$promo_code_var_name])) {
                    $this->_addAssetItemPromotionalCode($assetid, $_REQUEST[$promo_code_var_name]);
                }

                $this->_makeOrder();

                header('Location: '.$this->getUrl());
                return TRUE;

            break;

            case ('empty_cart'):
                $this->_clearAssetItems();
                $this->_clearAssetItemPromotionalCodes();
                $this->_makeOrder();

                header('Location: '.$this->getUrl());
                return TRUE;

            break;


            // confirm view: after the form has been filled out it needs
            // to be processed and confirmation displayed
            case ($this->confirm_view):
                // update order with ecom options

                $this->_makeOrder();
                $this->_saveOrder();
                // we prepare payment processing stuff here instead of in 'process' view
                // because we might want to nest the payment gateway on this screen
                // so we need all data to be available to it on this view
                // side effect of this is that it makes the 'process' view unnecessary if the gateway is nested
                $order = $_SESSION[$this->getPrefix()]['order'];
                $action_name = $this->getPrefix().'_action';

                $_SESSION['SQ_ECOM_SUCCESS_URL'] = $this->getURL().'?'.$action_name.'='.$this->receipt_view;
                $_SESSION['SQ_ECOM_CANCEL_URL'] = $this->getURL().'?'.$action_name.'='.$this->confirm_view;
                $_SESSION['SQ_ECOM_REF_NO'] = md5(session_id().time());
                
                //Add the pass through variables to SESSION variables
                $pass_through_vars = $this->_getPassThroughVars();
                if (!empty($pass_through_vars)) {
                    $_SESSION['SQ_ECOM_PASS_THROUGH_VARS'] = $pass_through_vars;
                }

                // if the custom reference id attribtue is not empty it means
                // that we need a customised reference id
                $new_reference_id = $this->attr('custom_reference_id');
                if (!empty($new_reference_id)) {
                    $new_reference_replacements = Array();
                    $new_reference_keywords = extract_keywords($new_reference_id);
                    foreach ($new_reference_keywords as $keyword) {
                        $new_reference_replacements[$keyword] = $this->_getThankYouKeywordReplacement($keyword);
                    }

                    $new_reference_replacements['session_id'] = session_id();
                    $new_reference_replacements['current_time'] = time();

                    replace_keywords($new_reference_id, $new_reference_replacements);
                    // replace_global_keywords($new_reference_id);
                    $_SESSION['SQ_ECOM_REF_NO'] = $new_reference_id;
                }

                $_SESSION['SQ_ECOM_AMOUNT'] = $order['total'];

                $this->printConfirmationView();
                return TRUE;

            break;


            case ('process'):
                $gateway = $this->attr('gateway_assetid');
                if (empty($gateway)) {
                    trigger_error('Payment Gateway not configured. Cannot proceed.', E_USER_NOTICE);
                    $this->printConfirmationView();
                    return TRUE;
                }

                $gateway = $this->attr('gateway_assetid');
                $gateway_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($gateway);
                $gateway_asset_url = $gateway_asset->getURL();

                header('Location: '.$gateway_asset_url);
                return TRUE;

            break;


            // receipt view: after the gateway has processed payment and redirected back to us
            // here we need to display the receipt and do the logging, etc
            case ($this->receipt_view):
                // check for response from the payment gateway
                $response = array_get_index($_SESSION, 'SQ_ECOM_RESPONSE', FALSE);
                if (!$response) {
                    // no response: we've either been here already - user has seen the receipt
                    // or someone has used an invalid url
                    // we redirect because we don't want users being able to refresh the browser
                    header('Location: '.$this->getUrl());
                    return TRUE;
                }
                


                unset($_SESSION['SQ_ECOM_RESPONSE']);
                $this->_tmp['GATEWAY_RESPONSE'] = $response;

                // this function is reponsible for doing business logic related to finalizing the
                // e-commerce transaction: e-mailing, logging and display
                $order = $this->_readOrder();
                $this->_deleteOrderFile();

                $this->current_answers = $order['submission'];
                $this->extra_data = $order['submission_extra_data'];
                // re-populate the active submissions
                $this->repopulate();

            
                
                // CREATE SUBMISSION
                $this->_saveOrderAsset();

                // Does two things, depending on whether a create location is set:
                // Create Location: create a NOTICE link between the File asset and the submission.
                // No Create Location: Move file upload to the order asset's data directory.
                $order_asset = $this->order;
                $file_uploads     = $this->getAllQuestionAssets('form_question_type_file_upload');

                foreach ($file_uploads as $assetid => $file_upload) {
                    $extra_data = $file_upload->getExtraData();
        
                    $create_location = $file_upload->attr('create_location');
                    if (empty($create_location)) {
                        if (!empty($extra_data['temp_filesystem_path'])) {
                            $filename   = $file_upload->getValue();
                            $perm_path  = $order_asset->data_path.'/attachments/'.str_replace(':', '_', $file_upload->id);
        
                            // Move it using Fudge file_system function
                            create_directory($perm_path);
                            move_file($extra_data['temp_filesystem_path'], $perm_path.'/'.$filename);
                            $extra_data = Array(
                                            'filesystem_path'   => $perm_path.'/'.$filename,
                                          );
        
                            $file_upload->setExtraData($extra_data);
                            // update order asset with uploaded file path
                            $this->_saveOrderAsset();
                        }
                    } else {
                        // create a notice link so we can keep track of uploaded file                       
                        $uploaded_assetid = array_get_index($extra_data, 'existing_file_assetid', array_get_index($extra_data, 'new_file_assetid', NULL));
                        if (!empty($uploaded_assetid)) {
                            $uploaded_file = $GLOBALS['SQ_SYSTEM']->am->getAsset($uploaded_assetid);
        
                            $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);
                            $order_asset->createLink($uploaded_file, SQ_LINK_NOTICE, 'file_submission');
                            $GLOBALS['SQ_SYSTEM']->restoreRunLevel();
                        }
                    }
                    // clean up tmp file path since it has been either imported to order asset dir or created as a file asset
                    $file_upload->cleanUp($this);
                }
        
                
        
                // log order to file
                if ($this->attr('log_to_file')) {
                    $this->_logOrderToFile();
                }

                // send emails
                $this->mailReceipt();
                $this->mailRecipients();

                // perform submission actions before showing the receipt
                $this->performSubmissionActions(TRUE);
                
                $this->printReceiptView();

                // clear the cart
                $_SESSION[$this->getPrefix()]['items'] = Array();
                $_SESSION[$this->getPrefix()]['order'] = Array();
                $this->_clearAssetItems();
                $this->_clearAssetItemPromotionalCodes();

                // perform submission actions
                $this->performSubmissionActions();
                
                return TRUE;

        }//end switch


        // print the initial form
        $this->printFormView();
        return TRUE;

    }//end printStandard()


    function _logOrderToFile()
    {
        $am =& $GLOBALS['SQ_SYSTEM']->am;

        $asset_item_format = $this->attr('log_asset_item_format');
        $question_item_format = $this->attr('log_question_item_format');
        $item_block_format = $this->attr('log_item_block_format');
        $log_entry_format = $this->attr('log_entry_format');

        ob_start();

        $asset_list = @$_SESSION[$this->getPrefix()]['order']['ecom_assets'];
        if (empty($asset_list)) $asset_list = Array();
        foreach ($asset_list as $id => $item) {
            $asset = $am->getAsset($id);
            $item_string = $asset->replaceKeywordsInString($asset_item_format);
            $replacements['item_name'] = $item['name'];
            $replacements['item_price'] = $item['price'];
            $replacements['item_id'] = $item['id'];
            replace_keywords($item_string, $replacements);
            echo $item_string;
        }
        $asset_item_list = ob_get_clean();
        $item_block_replacements['asset_item_list'] = $asset_item_list;

        ob_start();
        $question_list = @$_SESSION[$this->getPrefix()]['order']['ecom_questions'];
        if (empty($question_list)) $question_list = Array();
        foreach ($question_list as $id => $item) {
            $item_string = $question_item_format;
            $replacements['item_name'] = $item['name'];
            $replacements['item_price'] = $item['price'];
            $replacements['item_id'] = $item['id'];
            replace_keywords($item_string, $replacements);
            echo $item_string;
        }
        $question_item_list = ob_get_clean();
        $item_block_replacements['question_item_list'] = $question_item_list;

        $item_block = '';
        if (!empty($question_item_list) || !empty($asset_item_list)) {
            $item_block = $item_block_format;
            replace_keywords($item_block, $item_block_replacements);
        }

        $log_entry_string = $log_entry_format;
        $log_entry_keywords = extract_keywords($log_entry_format);
        foreach ($log_entry_keywords as $keyword) {
            if ($keyword == 'form_summary') {
                $keyword2 = $keyword.'_text';
                $log_entry_replacements[$keyword] = $this->_getThankYouKeywordReplacement($keyword2);
            } else {
                $log_entry_replacements[$keyword] = $this->_getThankYouKeywordReplacement($keyword);
            }
        }

        $log_entry_replacements['item_block'] = $item_block;
        $log_entry_replacements['order_id'] = $this->getOrderNumberKeywordReplacement();
        replace_keywords($log_entry_string, $log_entry_replacements);

        replace_global_keywords($log_entry_string);

        // write to log
        $this->_log($log_entry_string);

    }//end _logOrderToFile()


    function printBody()
    {
        $this->printStandard();

    }//end printBody()


    function printFormView()
    {
        $prefix = $this->getPrefix();

        $clientside = ($this->attr('use_client_side')) ? 'onsubmit="return beforeSubmit_'.$prefix.'(this);"' : '';

        $form_action = $_SERVER['PHP_SELF'];

        // Add the query string as well if it exists, so asset references with ?a=###
        // submit back to themselves.
        if (!empty($_SERVER['QUERY_STRING'])) {
            $form_action .= '?'.htmlentities($_SERVER['QUERY_STRING']);
        }

        ob_start();
        if ($this->attr('use_client_side')) {
            ?><script type="text/javascript">
            function beforeSubmit_<?php echo $prefix; ?>(form) {
                var submission_errors = new Array();
                i = 0;
                <?php echo $this->generateJSCode(); ?>
                    if (submission_errors.length > 0) {
                    var errors_list = "<?php echo translate('cms_form_submission_errors'); ?>\n";
                    for(x in submission_errors) {
                        errors_list += submission_errors[x] + "\n";
                    }
                    alert(errors_list);
                    return false;
                }
                return true;
            }
            </script>
        <?php
        }
        $javascript = ob_get_clean();

        $bodycopy =& $this->getBodycopy('Form');

        if (is_null($bodycopy)) return '';

        $replacements = Array();
        $keyword_list = $bodycopy->getKeywords();       
        if (!empty($keyword_list)) {
            foreach ($keyword_list as $keyword) {
                if (isset($replacements[$keyword])) continue;
                $replacements[$keyword] = $this->getKeywordReplacement($keyword);
            }
        }

        $bodycopy->setKeywordReplacements($replacements);

        // all the output is here
        echo '<form id="'.$prefix.'" enctype="multipart/form-data" action="'.$form_action.'" method="post" '.$clientside.'>';
        echo $javascript;
        echo hidden_field('SQ_FORM_'.$this->id.'_PAGE', 1);; 
        $bodycopy->printBody();
        echo '</form>';

    }//end printFormView()


    function getKeywordReplacement($keyword)
    {
        $value = NULL;
        $unreplaced_value = '%'.$keyword.'%';

        $keyword_parts = explode('_', $keyword);
        if (empty($keyword_parts)) return $unreplaced_value;

        $keyword_category = $keyword_parts[0];

        if ($keyword_category == 'question') {

            // keywords look like this:
            // question_TYPE_BRIDGEID_qQUESTIONID
            // where TYPE = id, label, field, note

            if (count($keyword_parts) != 4) {
                return $unreplaced_value;
            }

            $question_id = $keyword_parts[2].':'.$keyword_parts[3];

            if (!$this->isAllowedQuestionId($question_id)) {
                return $unreplaced_value;
            }

            $q_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($question_id);

            switch ($keyword_parts[1]) {
                case 'id':
                    $value = 'q'.$keyword_parts[2].'_'.$keyword_parts[3];
                break;

                case 'label':
                    $value = $q_asset->getHtmlLabel();
                break;

                case 'field':
                    $value = $q_asset->getHtmlField();
                break;

                case 'note':
                    $value = $q_asset->attr('note');
                break;

                case 'response':
                    $value = $q_asset->getSummary();
                break;
                
                case 'name':
                    $value = $q_asset->attr('name');
                break;

                default:
                    $value = $unreplaced_value;
            }

            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($q_asset);

            return $value;

        } else if ($keyword_category == 'response') {
            if (count($keyword_parts) != 3) {
                return $unreplaced_value;
            }

            $question_id = $keyword_parts[1].':'.$keyword_parts[2];
            if (!$this->isAllowedQuestionId($question_id)) {
                return $unreplaced_value;
            }

            $q_asset =& $GLOBALS['SQ_SYSTEM']->am->getAsset($question_id);
            $value = $q_asset->getSummary();
            return $value;

        } else if ($keyword_category == 'section') {
            // section keyword looks like this:
            // section_title_SECTIONID

            if (count($keyword_parts) != 3) {
                return $unreplaced_value;
            }

            if ($keyword_parts[1] == 'title') {
                $section_id = $keyword_parts[2];
                $section_asset =& $GLOBALS['SQ_SYSTEM']->am->getAsset($section_id);
                $value = $section_asset->attr('name');
                $GLOBALS['SQ_SYSTEM']->am->forgetAsset($section_asset);

                return $value;
            }
        }

        return parent::getKeywordReplacement($keyword);

    }//end getKeywordReplacement()


    function isAllowedQuestionId($question_id)
    {
        $all_questions = $this->getAllQuestionsCached();
        return isset($all_questions[$question_id]);

    }//end isAllowedQuestionId()


    function &getAllQuestionsCached()
    {
        if (is_null(@$this->_tmp['all_questions'])) {
            $this->_tmp['all_questions'] = $this->getAllQuestions();
        }

        $questions =& $this->_tmp['all_questions'];

        return $questions;

    }//end getAllQuestionsCached()


    function _getCommonFormKeywordReplacements()
    {
        // check to see if the bodycopy attached to this form has any content
        $questions = $this->getQuestions();
        $sections =& $this->getSections();

        foreach ($questions as $q_id => $question) {
            $q_asset =& $GLOBALS['SQ_SYSTEM']->am->getAsset($this->id.':q'.$q_id);
            $q_name = $q_asset->attr('name');
            $replacements['question_field_'.$this->id.'_q'.$q_id] = $q_asset->getHtmlField();
            $replacements['question_id_'.$this->id.'_q'.$q_id] = 'q'.$this->id.'_q'.$q_id;
            $replacements['question_note_'.$this->id.'_q'.$q_id] = $q_asset->attr('note');
            $replacements['question_label_'.$this->id.'_q'.$q_id] = $q_asset->getHtmlLabel();
        }

        foreach ($sections as $section) {
            $replacements['section_title_'.$section->id] = $section->attr('name');
            $questions = $section->getQuestions();
            foreach ($questions as $q_id => $question) {
                $q_asset =& $GLOBALS['SQ_SYSTEM']->am->getAsset($section->id.':q'.$q_id);
                $q_name = $section->attr('name').': '.$q_asset->attr('name');
                $replacements['question_field_'.$section->id.'_q'.$q_id] = $q_asset->getHtmlField();
                $replacements['question_id_'.$section->id.'_q'.$q_id] = 'q'.$section->id.'_q'.$q_id;
                $replacements['question_note_'.$section->id.'_q'.$q_id] = $q_asset->attr('note');
                $replacements['question_label_'.$section->id.'_q'.$q_id] = $q_asset->getHtmlLabel();
            }
        }

        return $replacements;

    }//end _getCommonFormKeywordReplacements()


    function &getBodycopy($bodycopy)
    {
        if ($bodycopy == 'Page Contents') {
            $bodycopy = 'Form';
        } else if ($bodycopy == 'Thank You') {
            $bodycopy = 'Confirmation';
        }

        $bodycopy_asset =& parent::getBodycopy($bodycopy);

        return $bodycopy_asset;

    }//end getBodycopy()


    function _getFormBodycopyKeywords()
    {
        return $this->_getPageContentsBodycopyKeywords();

    }//end _getFormBodycopyKeywords()


    function _getConfirmationBodycopyKeywords()
    {
        return $this->_getThankYouBodycopyKeywords();

    }//end _getConfirmationBodycopyKeywords()


    function _getReceiptBodycopyKeywords()
    {
        return $this->_getThankYouBodycopyKeywords();

    }//end _getReceiptBodycopyKeywords()


    function &createSubmission()
    {
        return ($order =& $this->createOrder());

    }//end createSubmission()


    function _getReceiptHeader($as_html=TRUE)
    {
        $header = '';

        // get response from the gateway
        $response = array_get_index($this->_tmp, 'GATEWAY_RESPONSE', FALSE);
        if (!$response) return $header;

        // today
        $date = date('F j, Y, g:i a');

        if ($as_html) {
            $header ='
                <table class="ecom_header_table">
                    <tr>
                        <td colspan="2"><h2>Receipt</h2></td>
                    </tr>
                    <tr>
                        <td>'.translate('ecom_form_transaction_number:').'</td>
                        <td>'.$response['TRANSACTION'].'</td>
                    </tr>
                    <tr>
                        <td>'.translate('ecom_form_transaction_status:').'</td>
                        <td>'.$response['STATUS'].'</td>
                    </tr>
                    <tr>
                        <td>'.translate('ecom_form_credit_card:').'</td>
                        <td>'.$response['CARDNO'].'</td>
                    </tr>
                    <tr>
                        <td>'.translate('ecom_form_date:').'</td>
                        <td>'.$date.'</td>
                    </tr>
                </table>
            ';

        } else {
            $header .= translate('ecom_form_transaction_number:').' '.$response['TRANSACTION']."\n";
            $header .= translate('ecom_form_transaction_status:').' '.$response['STATUS']."\n";
            $header .= translate('ecom_form_date:').' '.$date."\n";
        }

        return $header;

    }//end _getReceiptHeader()


    function printSummary($as_html=FALSE)
    {
        echo $this->_getReceiptHeader($as_html);
        echo $this->_getReceipt($as_html);
        if ($as_html) {
            echo '<br /><br />';
        } else {
            echo "\n\n";
        }
        parent::printSummary($as_html);

    }//end printSummary()


    function processForm()
    {
        return parent::processPage(1);

    }//end processForm()


    function _saveOrderAsset()
    {
        $questions =& $this->getAllQuestionAssets();

        $order =& $this->getCurrentOrderAsset();
        if (is_null($order)) $order =& $this->createOrder();


        $this->order =& $order;
        $this->submission_asset =& $order;


        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        // save question values
        for (reset($questions); $question =& $questions[key($questions)]; next($questions)) {
            $question->saveValue($this);

            // If the question is sticky, stick the value then
            if ($question->attr('sticky')) {
                $question->stickValue($question->getValue());
            }
        }

        // create the submission asset
        for (reset($questions); $question =& $questions[key($questions)]; next($questions)) {
            $order->setAnswer(key($questions), $question->getValue());
            $order->setSummary(key($questions), $question->attr('name'), $question->getSummary());
            $order->setExtraData(key($questions), $question->getExtraData());
        }

        $order->setIP($_SERVER['REMOTE_ADDR']);
        $order->setAttrValue('complete', TRUE);
        $order->setAttrValue('xml', $this->getXML());
        //set ecommerce order's details
        $order->setAttrValue('transaction_id', array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'TRANSACTION', ''));
        $order->setAttrValue('billing_name', array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'BILLING_NAME', ''));
        $order->setAttrValue('billing_addr', array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'BILLING_ADDR', ''));
        $order->setAttrValue('delivery_name', array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'DELIVERY_NAME', ''));
        $order->setAttrValue('delivery_addr', array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'DELIVERY_ADDR', ''));
        
        $order->saveAttributes();

        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();

    }//end _saveOrderAsset()


    function &createOrder()
    {
        $am =& $GLOBALS['SQ_SYSTEM']->am;

        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

        // search for a bodycopies folder and create one if there isn't one there
        $folder_link = $GLOBALS['SQ_SYSTEM']->am->getLink($this->id, SQ_LINK_TYPE_2, 'folder', TRUE, 'orders_folder');
        if (empty($folder_link)) {

            // create a folder for the bodycopies
            $GLOBALS['SQ_SYSTEM']->am->includeAsset('folder');
            $folder = new Folder();
            $folder->setAttrValue('name', 'Orders');

            $folder_link = Array('asset' => &$this, 'link_type' => SQ_LINK_TYPE_2, 'value' => 'orders_folder', 'is_dependant' => 0, 'is_exclusive' => 1);

            // Create order folder
            $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);
            $success = $folder->create($folder_link);
            $GLOBALS['SQ_SYSTEM']->restoreRunLevel();
            if (!$success) {
                $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
                $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
                return FALSE;
            }
            
            // Deny public read access to the order folder by default
            $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);
            $success = $GLOBALS['SQ_SYSTEM']->am->setPermission($folder->id, $GLOBALS['SQ_SYSTEM']->am->getSystemAssetid('public_user'), SQ_PERMISSION_READ, 0, TRUE, TRUE);
            $GLOBALS['SQ_SYSTEM']->restoreRunLevel();
            if (!$success) {
                $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
                $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
                return FALSE;
            }
    
        } else {
            // folder already exists, get the reference
            $folder = $GLOBALS['SQ_SYSTEM']->am->getAsset($folder_link['minorid'], $folder_link['minor_type_code']);
        }


        if (is_null($folder)) {
            $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
            return FALSE;
        }

        // create the Order asset
        $order = new Order();
        $copy_link  = Array('asset' => &$folder, 'link_type' => SQ_LINK_TYPE_2, 'is_dependant' => 1, 'is_exclusive' => 1);

        $GLOBALS['SQ_SYSTEM']->setRunLevel(SQ_RUN_LEVEL_FORCED);
        $success = $order->create($copy_link);
        $GLOBALS['SQ_SYSTEM']->restoreRunLevel();

        // attempt to create the link to this asset
        if (!$success) {
            $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
            $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
            return FALSE;
        }
        $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();

        return $order;

    }//end createOrder()


    function _getReceipt($as_html=TRUE)
    {
        $order = $_SESSION[$this->getPrefix()]['order'];
        if (empty($order)) return FALSE;
        
        $curr_sign = $this->attr('currency_sign');
        if ($as_html) {
            $receipt_fmt   = '<hr /><table class="sq_ecomTable">%s%s%s</table><hr />';
            $order_row_fmt = '<tr class="sq_ecomTableItemRow"><td class="sq_ecomTableItemName">%s</td><td class="sq_ecomTableItemValue" align="right">%01.2f</td></tr>';
            $divider_row = '<tr class="sq_ecomTableItemRow"><td class="sq_ecomTableItemName">&nbsp;</td><td class="sq_ecomTableItemValue" align="right"><hr /></td></tr>';
            $total_discount_row_fmt = '<tr class="sq_ecomTableTotalDiscountRow"><td class="sq_ecomTableTotalDiscountName" align="right">%s</td><td class="sq_ecomTableTotalDiscountValue" align="right">'.$curr_sign.'%01.2f</td></tr>';
            $total_row_fmt = '<tr class="sq_ecomTableTotalRow"><td class="sq_ecomTableTotalName" align="right">%s</td><td class="sq_ecomTableTotalValue" align="right">'.$curr_sign.'%01.2f</td></tr>';
        } else {
            $receipt_fmt   = strtoupper(translate('ecom_form_receipt:'))."\n############################\n%s\n%s\n%s\n############################";
            $order_row_fmt = "%s: %01.2f\n";
            $divider_row = "----------------------------\n";
            $total_discount_row_fmt = "*** %s $curr_sign%01.2f ***\n";
            $total_row_fmt = "*** %s $curr_sign%01.2f ***\n";
        }

        $rows = '';
        foreach ($order['items'] as $item) {
            $rows .= sprintf($order_row_fmt, $item['name'], $item['price']);
        }

        $rows .= $divider_row;
        
        $total_discount = '';
        if ($order['total_discount'] > 0) {
            $total_discount = sprintf($total_discount_row_fmt, translate('ecom_form_total_discount:'), $order['total_discount']);
            $total_discount .= $divider_row;
        }

        $total   = sprintf($total_row_fmt, translate('ecom_form_total:'), $order['total']);
        $receipt = sprintf($receipt_fmt, $rows, $total_discount, $total);

        return $receipt;

    }//end _getReceipt()


    function _makeOrder()
    {
        $total = 0;
        $taxable_total = 0;
        $total_discount = 0;

        $questions =& $this->getAllQuestionAssets();
        $ecom_items = Array();
        $taxable_items = Array();
        $ecom_assets = Array();
        $ecom_questions = Array();

        // process the assets being purchased
        $am =& $GLOBALS['SQ_SYSTEM']->am;
        $assets_in_cart = $this->_getAssetItems();
        $promo_codes_in_cart = $this->_getAssetItemPromotionalCodes();
        foreach ($assets_in_cart as $asset_id => $count) {
            $ecom_item['taxable'] = FALSE;
            $asset = $am->getAsset($asset_id);
            $name = $this->_getPurchasableAssetName($asset);
            $price = $this->_getPurchasableAssetPrice($asset);
            
            // process promotional codes
            $discount = 0;
            if (isset($promo_codes_in_cart[$asset_id])) {
                $discount = $this->_getPromotionalCodeDiscount($promo_codes_in_cart[$asset_id], $price, $count);
            }
            
            if ($count > 1) {
                $name = $count.' x '.$name.' @'.$price;
                $price = $price * $count;
            }

            $ecom_item['name'] = $name;
            $ecom_item['quantity'] = $count;
            $ecom_item['price'] = $price;
            $ecom_item['discount'] = $discount;
            $ecom_item['id'] = $asset_id;

            $is_taxable = $this->_isPurchasableAssetTaxable($asset);

            if ($is_taxable) {
                $taxable_items[$asset_id] = $ecom_item;
                $taxable_total += $ecom_item['price'];
                $ecom_item['taxable'] = TRUE;
            }
            $ecom_assets[$asset_id] = $ecom_item;
            $ecom_items[$asset_id] = $ecom_item;
            $total += $ecom_item['price'];
            $total_discount += $ecom_item['discount'];
            $am->forgetAsset($asset);
        }

        // now process the ecommerce questions
        $taxable_rules = $this->attr('taxable_rules');

        foreach ($questions as $q_id => $question) {
            if (($rule = $this->_getEcommerceRule($q_id)) !== FALSE) {
                $ecom_item['taxable'] = FALSE;
                $question_title = $question->attr('name');
                // if it is a selection question, we ask the question to
                // tell us if an option was selected

                // Reset the var here because we are going to overwrite them anyway
                $ecom_item['name']  = '';
                $ecom_item['price'] = '';
                if ($question->isSelection()) {
                    foreach ($rule as $option_id => $price) {
                        //if option is selcted and option is not --leave empty--
                        if ($question->isSelected($option_id) && (!($question instanceof Form_question_type_select) || !$question->isEmptyOption($option_id))) {
                            if (isset($ecom_item['name']) && !empty($ecom_item['name'])) {
                                $ecom_item['name']  .= ', '.$question->getOptionName($option_id);
                            } else {
                                $ecom_item['name']  = $question_title.': '.$question->getOptionName($option_id);
                            }//end if else
                            if (!isset($ecom_item['price']) && !empty($ecom_item['price'])) {
                                $ecom_item['price'] = $price;
                            } else {
                                $ecom_item['price'] += $price;
                            }//end if

                            $ecom_item['id'] = $q_id;

                            if (array_get_index($taxable_rules, $q_id, FALSE)) {
                                $taxable_items[$q_id] = $ecom_item;
                                $taxable_total += $price;
                                $ecom_item['taxable'] = TRUE;
                            }
                            $ecom_items[$q_id] = $ecom_item;
                            $ecom_questions[$q_id] = $ecom_item;
                            $total += $price;
                        }
                    }

                } else {
                    // if it is not a question with options, we get the submission directly
                    // we assume that it is a numeric question
                    $ecom_item['name']  = $question_title;
                    $ecom_item['price'] = $this->current_answers[$q_id];
                    $ecom_item['id'] = $q_id;

                    if (array_get_index($taxable_rules, $q_id, FALSE)) {
                        $taxable_items[$q_id] = $ecom_item;
                        $taxable_total += $ecom_item['price'];
                        $ecom_item['taxable'] = TRUE;
                    }
                    $ecom_items[$q_id] = $ecom_item;
                    $ecom_questions[$q_id] = $ecom_item;
                    $total += $ecom_item['price'];
                }//end if

            }//end if

        }//end foreach

        $order['items'] = $ecom_items;
        $order['ecom_assets'] = $ecom_assets;
        $order['ecom_questions'] = $ecom_questions;
        $order['taxable_items'] = $taxable_items;
        $order['taxable_total'] = $taxable_total;
        $order['total'] = $total - $total_discount;
        $order['total_discount'] = $total_discount;
        $order['submission'] = $this->current_answers;
        $order['submission_extra_data'] = $this->extra_data;

        $_SESSION[$this->getPrefix()]['order'] = $order;

        return TRUE;

    }//end _makeOrder()


    function _saveOrder()
    {
        $filename = $this->_getOrderFileName();
        $order = $_SESSION[$this->getPrefix()]['order'];
        $order_contents = serialize($order);
        return string_to_file($order_contents, $filename);

    }//end _saveOrder()


    function _readOrder()
    {
        $filename = $this->_getOrderFileName();
        $order = file_to_string($filename);
        if (!$order) return FALSE;
        $_SESSION[$this->getPrefix()]['order'] = unserialize($order);
        return $_SESSION[$this->getPrefix()]['order'];

    }//end _readOrder()


    function _deleteOrderFile()
    {
        $filename = $this->_getOrderFileName();
        unlink($filename);
        return TRUE;

    }//end _deleteOrderFile()


    function _getOrderFileName($order_no=FALSE)
    {
        $order_path = $this->data_path.'/tmp_orders';

        if (!is_dir($order_path)) {
            mkdir($order_path);
            chmod($order_path, 0700);
        }

        if (!$order_no) $order_no = session_id();

        return $order_path.'/'.$order_no.'.tmp';

    }//end _getOrderFileName()


    function printConfirmationView()
    {
        $body =& $this->getBodycopy('Confirmation');

        $keyword_list = $body->getKeywords();
        $replacements = Array();
        foreach ($keyword_list as $keyword) {
            $replacements[$keyword] = $this->_getThankYouKeywordReplacement($keyword == 'form_summary' ? 'form_summary_text' : $keyword);
        }

        $body->setKeywordReplacements($replacements);
        $body->printBody();

    }//end printConfirmationView()


    function printReceiptView()
    {
        $body = $this->getBodycopy('Receipt');
        $replacements = Array();

        $keyword_list = $body->getKeywords();
        foreach ($keyword_list as $keyword) {
            $replacements[$keyword] = $this->_getThankYouKeywordReplacement($keyword == 'form_summary' ? 'form_summary_text' : $keyword);
        }

        $body->setKeywordReplacements($replacements);
        $body->printBody();

    }//end printReceiptView()


    function _getParentPageAssetId()
    {
        $parent_page_assetid = array_get_index($this->_tmp, 'parent_form_page_assetid');

        if (is_null($parent_page_assetid)) {
            $parents = array_keys($GLOBALS['SQ_SYSTEM']->am->getParents($this->id, 'page_custom_form_ecommerce', FALSE));
            $parent_page_assetid = array_pop($parents);
            $this->_tmp['parent_form_page_assetid'] =& $parent_page_assetid;
        }

        return $parent_page_assetid;

    }//end _getParentPageAssetId()


    function &_getParentPageAsset()
    {
        if (!isset($this->_tmp['parent_form_page_asset'])) {
            $parent_page = $GLOBALS['SQ_SYSTEM']->am->getAsset($this->_getParentPageAssetId());
            $this->_tmp['parent_form_page_asset'] =& $parent_page;
        } else {
            $parent_page =& $this->_tmp['parent_form_page_asset'];
        }

        return $parent_page;

    }//end _getParentPageAsset()


    function getUrl()
    {
        $url = array_get_index($this->_tmp, 'current_url');

        if (is_null($url)) {
            $parent =& $this->_getParentPageAsset();
            $url = $parent->getURL();

            $this->_tmp['current_url'] = $url;
        }

        return $url;

    }//end getUrl()


//--        KEYWORDS AVAILABLE        --//


    function _getThankYouBodycopyKeywords()
    {
        $keywords = parent::_getThankYouBodycopyKeywords();

        $keywords['confirm_text'] = 'Confirm and pay button text';
        $keywords['cancel_text'] = 'Text Used on "Cancel" button';

        $keywords['confirm_url'] = 'URL to Confirmation Screen';
        $keywords['cancel_url'] = 'URL to Cancel Screen';

        $keywords['order_item_count'] = 'Count of items being purchased';
        $keywords['order_total'] = 'Total';
        $keywords['order_total_excluding_tax'] = 'Total minus tax';
        $keywords['order_total_tax'] = 'Total tax';
        $keywords['order_taxable_total'] = 'Taxable total';
        $keywords['order_taxable_item_count'] = 'Count of taxable items being purchased';
        $keywords['order_item_list'] = 'List of items being purchased';
        $keywords['order_total_discount'] = 'Total discount';
        $keywords['order_total_before_discount'] = 'Total before discount';

        $keywords['tax_rate'] = 'Tax Rate';
        $keywords['tax_name'] = 'Tax Name';

        $keywords['taxable_item_string'] = 'String appended to the taxable items';

        return $keywords;

    }//end _getThankYouBodycopyKeywords()


//--        KEYWORD REPLACEMENT FUNCTIONS        --//


    function getConfirmTextKeywordReplacement()
    {
        return $this->attr('confirm_button_name');

    }//end getConfirmTextKeywordReplacement()


    function getCancelTextKeywordReplacement()
    {
        return $this->attr('cancel_button_name');

    }//end getCancelTextKeywordReplacement()


    function getConfirmUrlKeywordReplacement()
    {
        $confrim_url = $this->getUrl();
        $confrim_url .= '?'.$this->getPrefix().'_action=process';

        return $confrim_url;

    }//end getConfirmUrlKeywordReplacement()


    function getCancelUrlKeywordReplacement()
    {
        $cancel_url = $this->getUrl();

        return $cancel_url;

    }//end getCancelUrlKeywordReplacement()


    function getOrderItemCountKeywordReplacement()
    {
        $item_count = 0;

        if (isset($_SESSION[$this->getPrefix()]['order']['items'])) {
            $item_count = count($_SESSION[$this->getPrefix()]['order']['items']);
        }

        return $item_count;

    }//end getOrderItemCountKeywordReplacement()


    function getOrderTotalKeywordReplacement()
    {
        $total = $this->_getTotal();
        $total = $this->_formatPriceAmount($total);

        return $total;

    }//end getOrderTotalKeywordReplacement()
    
    
    function getOrderTotalDiscountKeywordReplacement()
    {
        $total_discount = $this->_getTotalDiscount();
        $total_discount = $this->_formatPriceAmount($total_discount);

        return $total_discount;

    }//end getOrderTotalDiscountKeywordReplacement()
    
    
    function getOrderTotalBeforeDiscountKeywordReplacement()
    {
        $total = $this->_getTotal();
        $total_discount = $this->_getTotalDiscount();
        $total_before_discount = $total + $total_discount;
        $total_before_discount = $this->_formatPriceAmount($total_before_discount);

        return $total_before_discount;

    }//end getOrderTotalBeforeDiscountKeywordReplacement()
    


    function getOrderTotalExcludingTaxKeywordReplacement()
    {
        $total = $this->_getTotal();

        $tax = $this->_getTaxTotal();
        $total_no_tax = $total - $tax;
        $total_no_tax = $this->_formatPriceAmount($total_no_tax);

        return $total_no_tax;

    }//end getOrderTotalExcludingTaxKeywordReplacement()


    function getOrderTotalTaxKeywordReplacement()
    {
        $total_tax = $this->_formatPriceAmount($this->_getTaxTotal());

        return $total_tax;

    }//end getOrderTotalTaxKeywordReplacement()


    function getOrderTaxableTotalKeywordReplacement()
    {
        $taxable_total = $this->_formatPriceAmount($this->_getTaxableTotal());

        return $taxable_total;

    }//end getOrderTaxableTotalKeywordReplacement()


    function getOrderTaxableItemCountKeywordReplacement()
    {
        $taxable_count = 0;

        if (isset($_SESSION[$this->getPrefix()]['order']['taxable_items'])) {
            $taxable_count = count($_SESSION[$this->getPrefix()]['order']['taxable_items']);
        }
        return $taxable_count;

    }//end getOrderTaxableItemCountKeywordReplacement()


    function getTaxRateKeywordReplacement()
    {
        return $this->_getTaxRate();

    }//end getTaxRateKeywordReplacement()


    function getTaxNameKeywordReplacement()
    {
        return $this->attr('tax_name');

    }//end getTaxNameKeywordReplacement()


    function getOrderItemListKeywordReplacement()
    {
        $item_format = $this->attr('item_format');
        $keywords = extract_keywords($item_format);

        ob_start();
        foreach ($this->_getOrderItems() as $item) {
            $item_line = $item_format;

            $item_name = array_get_index($item, 'name', '--UNKNOWN ITEM NAME--');
            $item_price = array_get_index($item, 'price', 0);
            $item_id = array_get_index($item, 'id');
            $is_taxable = array_get_index($item, 'taxable', FALSE);

            $replacements['item_name'] = $item_name;
            $replacements['item_price'] = $this->_formatPriceAmount($item_price);
            $replacements['currency_sign'] = $this->attr('currency_sign');
            $replacements['item_taxable_string'] = '';
            if ($is_taxable) {
                $replacements['taxable_item_string'] = $this->attr('item_taxable_string');
            }
            replace_keywords($item_line, $replacements);

            echo $item_line;
        }

        return ob_get_clean();

    }//end getOrderItemListKeywordReplacement()


    function getOrderPurchasableAssetListKeywordReplacement()
    {
        $am =& $GLOBALS['SQ_SYSTEM']->am;
        $assets_in_cart = $this->_getAssetItems();

        $item_format = $this->attr('form_asset_format');

        ob_start();
        foreach ($assets_in_cart as $asset_id => $count) {
            $asset =& $am->getAsset($asset_id);

            $price = $this->_getPurchasableAssetPrice($asset);
            $name = $this->_getPurchasableAssetName($asset);
            $is_taxable = $this->_isPurchasableAssetTaxable($asset);

            if ($count > 1) {
                $name = $count.' x '.$name.' @'.$price;
                $price = $price * $count;
            }

            $replacements['item_name'] = $name;
            $replacements['item_price'] = $this->_formatPriceAmount($price);
            $replacements['currency_sign'] = $this->attr('currency_sign');
            $replacements['item_taxable_string'] = '';
            if ($is_taxable) {
                $replacements['taxable_item_string'] = $this->attr('item_taxable_string');
            }

            // ask asset to replace any known keywords
            $item_line = $asset->replaceKeywordsInString($item_format);
            // replace those new keywords the asset doesn't know about
            replace_keywords($item_line, $replacements);

            echo $item_line;
        }

        return ob_get_clean();

    }//end getOrderPurchasableAssetListKeywordReplacement()


    function getItemListingKeywordReplacement()
    {
        $item_printout  = $this->getOrderPurchasableAssetListKeywordReplacement();
        if (empty($item_printout)) {
            return $this->attr('form_assets_empty_str');
        }

        $form_assets_format = $this->attr('form_asset_list_format');
        $keywords['item_format'] = $item_printout;
        replace_keywords($form_assets_format, $keywords);

        return $form_assets_format;

    }//end getItemListingKeywordReplacement()


    function getTaxableItemStringKeywordReplacement()
    {
        return $this->attr('item_taxable_string');

    }//end getTaxableItemStringKeywordReplacement()
    
    
    function getCurrencySignKeywordReplacement()
    {
        return $this->attr('currency_sign');

    }//end getTaxableItemStringKeywordReplacement()


    function getTransactionNumberKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'TRANSACTION', '');

    }//end getTransactionNumberKeywordReplacement()


    function getTransactionStatusKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'STATUS', '');

    }//end getTransactionStatusKeywordReplacement()


    function getTransactionTypeKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'TYPE', '');

    }//end getTransactionTypeKeywordReplacement()


    function getTransactionTimeKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'TIME', '');

    }//end getTransactionTimeKeywordReplacement()


    function getTransactionAmountKeywordReplacement()
    {
        $amount = array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'AMOUNT', '');
        return $this->_formatPriceAmount($amount);

    }//end getTransactionAmountKeywordReplacement()


    function getTransactionCardNumberKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'CARDNO', '');

    }//end getTransactionCardNumberKeywordReplacement()
    
    
    function getTransactionBillingNameKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'BILLING_NAME', '');

    }//end getTransactionBillingNameKeywordReplacement()
    
    
    function getTransactionBillingAddressKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'BILLING_ADDR', '');

    }//end getTransactionBillingAddressKeywordReplacement()
    
    
    function getTransactionDeliveryNameKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'DELIVERY_NAME', '');

    }//end getTransactionDeliveryNameKeywordReplacement()
    
    
    function getTransactionDeliveryAddressKeywordReplacement()
    {
        return array_get_index($this->_tmp['GATEWAY_RESPONSE'], 'DELIVERY_ADDR', '');

    }//end getTransactionDeliveryAddressKeywordReplacement()


    function getOrderNumberKeywordReplacement()
    {
        $order = $this->getCurrentOrderAsset();
        if (is_null($order)) return;

        return $order->id;

    }//end getOrderNumberKeywordReplacement()


    function &getCurrentOrderAsset()
    {
        if (!empty($this->order)) {
            $order =& $this->order;
            return $order;
        }

        $order_id = @$_SESSION[$this->getPrefix()]['order_id'];
        if (empty($order_id)) {
            $order = NULL;
            return $order;
        }

        $this->order =& $GLOBALS['SQ_SYSTEM']->am->getAsset($order_id);
        $order =& $this->order;
        return $order;

    }//end getCurrentOrderAsset()


    function _getAssetItems()
    {
        $assets_in_cart = @$_SESSION[$this->getPrefix()]['assets'];
        if (is_null($assets_in_cart)) {
            $assets_in_cart = Array();
        }
        return $assets_in_cart;

    }//end _getAssetItems()


    function _clearAssetItems()
    {
        $_SESSION[$this->getPrefix()]['assets'] = Array();

    }//end _clearAssetItems()


    function _addAssetItem($assetid, $quantity=1)
    {
        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);
        if (is_null($asset)) return FALSE;

        if (!$this->_isPurchasableAsset($asset)) {
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset);
            return FALSE;
        }

        // can only buy one of each item
        if ($this->_isPurchasableAssetQuantityAllowed($asset)) {
            if (!is_numeric($quantity) || $quantity <= 0) {
                $quantity = 1;
            }
        } else {
            $quantity = 1;
        }

        $_SESSION[$this->getPrefix()]['assets'] = Array();
        $_SESSION[$this->getPrefix()]['assets'][$assetid] = $quantity;

        $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset);

        return TRUE;

    }//end _addAssetItem()
    
    
    function _getAssetItemPromotionalCodes()
    {
        $promo_codes_in_cart = @$_SESSION[$this->getPrefix()]['promo_code_assets'];
        if (is_null($promo_codes_in_cart)) {
            $promo_codes_in_cart = Array();
        }
        
        return $promo_codes_in_cart;
        
    }//end _getAssetItemPromotionalCodes()


    function _clearAssetItemPromotionalCodes()
    {
        $_SESSION[$this->getPrefix()]['promo_code_assets'] = Array();
        
    }//end _clearAssetItemPromotionalCodes()
    
    
    function _addAssetItemPromotionalCode($assetid, $promo_code)
    {
        if (trim($promo_code) == '') return;
        
        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);
        if (is_null($asset)) return;

        if (!$this->_isPurchasableAssetPromotable($asset)) {
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset);
            return;
        }
        
        $promo_code_asset = $this->_getPromotionalCodeAsset($asset, $promo_code);
        
        if (!is_null($promo_code_asset)){
            // Reset the promo code asset list because _addAssetItem() method also reset the asset list
            // A new array 'promo_code_assets' is created instead of using the 'assets' array
            // because we might want to add the promotional code for the whole ecommerce form later (the whole cart, not only individual items)
            $_SESSION[$this->getPrefix()]['promo_code_assets'] = Array();
            $_SESSION[$this->getPrefix()]['promo_code_assets'][$assetid] = $promo_code_asset->id;
            $GLOBALS['SQ_SYSTEM']->am->forgetAsset($promo_code_asset);
        }
        
        $GLOBALS['SQ_SYSTEM']->am->forgetAsset($asset);
        
    }//end _addAssetItemPromotionalCode()
    
    
    function _getPromotionalCodeDiscount($promo_code_assetid, $price, $quantity)
    {
        $promo_code_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($promo_code_assetid);
        $asset_data = Array('price' => $price, 'quantity' => $quantity);
        
        $promo_code_asset->process($asset_data);
        
        return $asset_data['discount'];
        
    }//end _getPromotionalCodeDiscount()


    function _getTotal()
    {
        $total = 0;

        if (isset($_SESSION[$this->getPrefix()]['order']['total'])) {
            $total = $_SESSION[$this->getPrefix()]['order']['total'];
        }
        return $total;

    }//end _getTotal()
    
    
    function _getTotalDiscount()
    {
        $total_discount = 0;
        
        if (isset($_SESSION[$this->getPrefix()]['order']['total_discount'])) {
            $total_discount = $_SESSION[$this->getPrefix()]['order']['total_discount'];
        }
        
        return $total_discount;

    }//end _getTotalDiscount()


    function _getTaxableTotal()
    {
        $taxable_total = 0;

        if (isset($_SESSION[$this->getPrefix()]['order']['taxable_total'])) {
            $taxable_total = $_SESSION[$this->getPrefix()]['order']['taxable_total'];
        }
        return $taxable_total;

    }//end _getTaxableTotal()


    function _getTaxRate()
    {
        return $this->attr('tax_value');

    }//end _getTaxRate()


    function _getTaxTotal()
    {
        $taxable_total = $this->_getTaxableTotal();

        $tax_rate = $this->_getTaxRate();
        $total_tax = $taxable_total * $tax_rate/(100 + $tax_rate);

        return $total_tax;

    }//end _getTaxTotal()


    function _getOrderItems()
    {

        $items = @$_SESSION[$this->getPrefix()]['order']['items'];
        if (is_null($items) || !is_array($items)) {
            $items = Array();
        }

        return $items;

    }//end _getOrderItems()


    function _getPurchasableAssetPrice(&$asset)
    {
        $price_string = $this->attr('asset_price_source');
        $price = $asset->replaceKeywordsInString($price_string);

        if (!is_numeric($price)) $price = 0;

        return $price;

    }//end _getPurchasableAssetPrice()


    function _getPurchasableAssetName(&$asset)
    {
        $name_string = $this->attr('asset_name_source');
        $name = $asset->replaceKeywordsInString($name_string);

        if ($name == '') {
            $name = $asset->replaceKeywordsInString('%asset_name%');
        }

        return $name;

    }//end _getPurchasableAssetName()


    function _getPassThroughVars()
    {
        $key_val_arr = Array();
        $var_rules = $this->attr('key_val_rules');
        if (empty($var_rules)) {
            return $key_val_arr;
        }
        
        $questions =& $this->getAllQuestionAssets();
        foreach ($questions as $q_id => $question) {
            if (key_exists($q_id, $var_rules)) {
                $var_rule = $var_rules[$q_id];
                $key = array_get_index($var_rule, 'key', '');
                if (trim($key) == '') {
                    continue;
                }
                
                $val = '';
                if (!($question instanceof Form_Question_Type_Country) && $question->isSelection()) {
                    $options = array_get_index($var_rule, 'value', Array());
                    foreach ($options as $option_id => $option_val) {
                        //if option is selcted and option is not --leave empty--
                        if ($question->isSelected($option_id) && (!($question instanceof Form_question_type_select) || !$question->isEmptyOption($option_id))) {
                            $val = $option_val;
                            break;
                        }
                    }
                } else {
                    $val = $this->current_answers[$q_id];
                }
                
                $key_val_arr[$key] = $val;
            }//end if
        }//end for
        
        return $key_val_arr;

    }//end _getPassThroughVars()
    
    
    function _isPurchasableAsset(&$asset)
    {
        $price_string = $this->attr('asset_price_source');
        $price = $asset->replaceKeywordsInString($price_string);

        return is_numeric($price);

    }//end _isPurchasableAsset()


    function _isPurchasableAssetTaxable(&$asset)
    {
        $tax_source_string = $this->attr('asset_taxable_source');
        $tax_check_string = $asset->replaceKeywordsInString($tax_source_string);

        return $tax_check_string !== '';

    }//end _isPurchasableAssetTaxable()


    function _isPurchasableAssetQuantityAllowed(&$asset)
    {
        $multiple_source_string = $this->attr('asset_multiple_source');
        $check_string = $asset->replaceKeywordsInString($multiple_source_string);

        return $check_string !== '';

    }//end _isPurchasableAssetQuantityAllowed()
    
    
    function _isPurchasableAssetPromotable(&$asset)
    {
        $promotable_source_string = $this->attr('asset_promotable_source');
        $check_string = $asset->replaceKeywordsInString($promotable_source_string);

        return (boolean) $check_string;

    }//end _isPurchasableAssetPromotable()
    
    
    function _getPromotionalCodeAsset(&$asset, $promo_code)
    {
        $am = $GLOBALS['SQ_SYSTEM']->am;
        $links = $am->getLinks($asset->id, SQ_LINK_NOTICE, 'promotional_code', TRUE, 'minor', $promo_code);
        
        foreach ($links as $link) {
            $promo_code_asset = $am->getAsset($link['majorid']);
            if (!is_null($promo_code_asset) && ($promo_code_asset->status == SQ_STATUS_LIVE)) {
                return $promo_code_asset;
            }
        }
        
        return NULL;
        
    }//end _getPromotionalCodeAsset()


    function _formatPriceAmount($amount=0)
    {
        return sprintf('%01.2f', $amount);

    }//end _formatPriceAmount()


    function _isItemTaxable($item_id)
    {

        $taxable = @$_SESSION[$this->getPrefix()]['order']['taxable_items'][$item_id];
        return !is_null($taxable);

    }//end _isItemTaxable()


    function _getLogFileName()
    {
        return 'order.log';

    }//end _getLogFileName()


    function _getLogFilePath()
    {
        return $this->data_path.'/'.$this->_getLogFileName();

    }//end _getLogFilePath()


    function _log($string='')
    {
        $file = $this->_getLogFilePath();
        if (!$file_pointer = fopen($file, 'a')) return FALSE;

        $sucess = fputs($file_pointer, $string);
        fclose($file_pointer);
        if ($sucess === FALSE) {
            trigger_error('Unable to write '.$file, E_USER_WARNING);
            return FALSE;
        }

        $om = umask(0000);
        chmod($file, 0664);
        umask($om);

        return TRUE;

    }//end _log()


}//end class

?>