1: <?php
  2: /**
  3:  * Magento
  4:  *
  5:  * NOTICE OF LICENSE
  6:  *
  7:  * This source file is subject to the Open Software License (OSL 3.0)
  8:  * that is bundled with this package in the file LICENSE.txt.
  9:  * It is also available through the world-wide-web at this URL:
 10:  * http://opensource.org/licenses/osl-3.0.php
 11:  * If you did not receive a copy of the license and are unable to
 12:  * obtain it through the world-wide-web, please send an email
 13:  * to license@magentocommerce.com so we can send you a copy immediately.
 14:  *
 15:  * DISCLAIMER
 16:  *
 17:  * Do not edit or add to this file if you wish to upgrade Magento to newer
 18:  * versions in the future. If you wish to customize Magento for your
 19:  * needs please refer to http://www.magentocommerce.com for more information.
 20:  *
 21:  * @category    Mage
 22:  * @package     Mage_Sales
 23:  * @copyright   Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
 24:  * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 25:  */
 26: 
 27: 
 28: /**
 29:  * Sales transaction resource model
 30:  *
 31:  * @category    Mage
 32:  * @package     Mage_Sales
 33:  * @author      Magento Core Team <core@magentocommerce.com>
 34:  */
 35: class Mage_Sales_Model_Resource_Order_Payment_Transaction extends Mage_Sales_Model_Resource_Order_Abstract
 36: {
 37:     /**
 38:      * Serializeable field: additional_information
 39:      *
 40:      * @var array
 41:      */
 42:     protected $_serializableFields   = array(
 43:         'additional_information' => array(null, array())
 44:     );
 45: 
 46:     /**
 47:      * Initialize main table and the primary key field name
 48:      *
 49:      */
 50:     protected function _construct()
 51:     {
 52:         $this->_init('sales/payment_transaction', 'transaction_id');
 53:     }
 54: 
 55:     /**
 56:      * Update transactions in database using provided transaction as parent for them
 57:      * have to repeat the business logic to avoid accidental injection of wrong transactions
 58:      *
 59:      * @param Mage_Sales_Model_Order_Payment_Transaction $transaction
 60:      */
 61:     public function injectAsParent(Mage_Sales_Model_Order_Payment_Transaction $transaction)
 62:     {
 63:         $txnId = $transaction->getTxnId();
 64:         if ($txnId && Mage_Sales_Model_Order_Payment_Transaction::TYPE_PAYMENT === $transaction->getTxnType()
 65:             && $id = $transaction->getId()
 66:         ) {
 67:             $adapter = $this->_getWriteAdapter();
 68: 
 69:             // verify such transaction exists, determine payment and order id
 70:             $verificationRow = $adapter->fetchRow(
 71:                 $adapter->select()->from($this->getMainTable(), array('payment_id', 'order_id'))
 72:                     ->where("{$this->getIdFieldName()} = ?", (int)$id)
 73:             );
 74:             if (!$verificationRow) {
 75:                 return;
 76:             }
 77:             list($paymentId, $orderId) = array_values($verificationRow);
 78: 
 79:             // inject
 80:             $where = array(
 81:                 $adapter->quoteIdentifier($this->getIdFieldName()) . '!=?' => $id,
 82:                 new Zend_Db_Expr('parent_id IS NULL'),
 83:                 'payment_id = ?'    => (int)$paymentId,
 84:                 'order_id = ?'      => (int)$orderId,
 85:                 'parent_txn_id = ?' => $txnId
 86:             );
 87:             $adapter->update($this->getMainTable(), 
 88:                 array('parent_id' => $id),
 89:                 $where
 90:             );
 91:         }
 92:     }
 93: 
 94:     /**
 95:      * Load the transaction object by specified txn_id
 96:      *
 97:      * @param Mage_Sales_Model_Order_Payment_Transaction $transaction
 98:      * @param int $orderId
 99:      * @param int $paymentId
100:      * @param string $txnId
101:      */
102:     public function loadObjectByTxnId(Mage_Sales_Model_Order_Payment_Transaction $transaction, $orderId, $paymentId, 
103:         $txnId)
104:     {
105:         $select = $this->_getLoadByUniqueKeySelect($orderId, $paymentId, $txnId);
106:         $data   = $this->_getWriteAdapter()->fetchRow($select);
107:         $transaction->setData($data);
108:         $this->unserializeFields($transaction);
109:         $this->_afterLoad($transaction);
110:     }
111: 
112:     /**
113:      * Retrieve order website id
114:      *
115:      * @param int $orderId
116:      * @return string
117:      */
118:     public function getOrderWebsiteId($orderId)
119:     {
120:         $adapter = $this->_getReadAdapter();
121:         $bind    = array(':entity_id' => $orderId);
122:         $select  = $adapter->select()
123:             ->from(array('so' => $this->getTable('sales/order')), 'cs.website_id')
124:             ->joinInner(array('cs' => $this->getTable('core/store')), 'cs.store_id = so.store_id')
125:             ->where('so.entity_id = :entity_id');
126:         return $adapter->fetchOne($select, $bind);
127:     }
128: 
129:     /**
130:      * Lookup for parent_id in already saved transactions of this payment by the order_id
131:      * Also serialize additional information, if any
132:      *
133:      * @throws Mage_Core_Exception
134:      *
135:      * @param Mage_Sales_Model_Order_Payment_Transaction $transaction
136:      * @return Mage_Sales_Model_Resource_Order_Payment_Transaction
137:      */
138:     protected function _beforeSave(Mage_Core_Model_Abstract $transaction)
139:     {
140:         $parentTxnId = $transaction->getData('parent_txn_id');
141:         $txnId       = $transaction->getData('txn_id');
142:         $orderId     = $transaction->getData('order_id');
143:         $paymentId   = $transaction->getData('payment_id');
144:         $idFieldName = $this->getIdFieldName();
145: 
146:         if ($parentTxnId) {
147:             if (!$txnId || !$orderId || !$paymentId) {
148:                 Mage::throwException(
149:                     Mage::helper('sales')->__('Not enough valid data to save the parent transaction ID.'));
150:             }
151:             $parentId = (int)$this->_lookupByTxnId($orderId, $paymentId, $parentTxnId, $idFieldName);
152:             if ($parentId) {
153:                 $transaction->setData('parent_id', $parentId);
154:             }
155:         }
156: 
157:         // make sure unique key won't cause trouble
158:         if ($transaction->isFailsafe()) {
159:             $autoincrementId = (int)$this->_lookupByTxnId($orderId, $paymentId, $txnId, $idFieldName);
160:             if ($autoincrementId) {
161:                 $transaction->setData($idFieldName, $autoincrementId)->isObjectNew(false);
162:             }
163:         }
164: 
165:         return parent::_beforeSave($transaction);
166:     }
167: 
168:     /**
169:      * Load cell/row by specified unique key parts
170:      *
171:      * @param int $orderId
172:      * @param int $paymentId
173:      * @param string $txnId
174:      * @param mixed (array|string|object) $columns
175:      * @param bool $isRow
176:      * @param string $txnType
177:      * @return mixed (array|string)
178:      */
179:     private function _lookupByTxnId($orderId, $paymentId, $txnId, $columns, $isRow = false, $txnType = null)
180:     {
181:         $select = $this->_getLoadByUniqueKeySelect($orderId, $paymentId, $txnId, $columns);
182:         if ($txnType) {
183:             $select->where('txn_type = ?', $txnType);
184:         }
185:         if ($isRow) {
186:             return $this->_getWriteAdapter()->fetchRow($select);
187:         }
188:         return $this->_getWriteAdapter()->fetchOne($select);
189:     }
190: 
191:     /**
192:      * Get select object for loading transaction by the unique key of order_id, payment_id, txn_id
193:      *
194:      * @param int $orderId
195:      * @param int $paymentId
196:      * @param string $txnId
197:      * @param string|array|Zend_Db_Expr $columns
198:      * @return Varien_Db_Select
199:      */
200:     private function _getLoadByUniqueKeySelect($orderId, $paymentId, $txnId, $columns = '*')
201:     {
202:         return $this->_getWriteAdapter()->select()
203:             ->from($this->getMainTable(), $columns)
204:             ->where('order_id = ?', $orderId)
205:             ->where('payment_id = ?', $paymentId)
206:             ->where('txn_id = ?', $txnId);
207:     }
208: }
209: