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_Paypal
 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:  * Website Payments Pro Hosted Solution payment gateway model
 29:  *
 30:  * @category    Mage
 31:  * @package     Mage_Paypal
 32:  * @author      Magento Core Team <core@magentocommerce.com>
 33:  */
 34: 
 35: class Mage_Paypal_Model_Hostedpro extends Mage_Paypal_Model_Direct
 36: {
 37:     /**
 38:      * Button code
 39:      *
 40:      * @var string
 41:      */
 42:     const BM_BUTTON_CODE    = 'TOKEN';
 43: 
 44:     /**
 45:      * Button type
 46:      *
 47:      * @var string
 48:      */
 49:     const BM_BUTTON_TYPE    = 'PAYMENT';
 50: 
 51:     /**
 52:      * Paypal API method name for button creation
 53:      *
 54:      * @var string
 55:      */
 56:     const BM_BUTTON_METHOD  = 'BMCreateButton';
 57: 
 58:     /**
 59:      * Payment method code
 60:      */
 61:     protected $_code = Mage_Paypal_Model_Config::METHOD_HOSTEDPRO;
 62: 
 63:     protected $_formBlockType = 'paypal/hosted_pro_form';
 64:     protected $_infoBlockType = 'paypal/hosted_pro_info';
 65: 
 66:     /**
 67:      * Availability options
 68:      */
 69:     protected $_canUseInternal          = false;
 70:     protected $_canUseForMultishipping  = false;
 71:     protected $_canSaveCc               = false;
 72:     protected $_isInitializeNeeded      = true;
 73: 
 74:     /**
 75:      * Return available CC types for gateway based on merchant country.
 76:      * We do not have to check the availability of card types.
 77:      *
 78:      * @return bool
 79:      */
 80:     public function getAllowedCcTypes()
 81:     {
 82:         return true;
 83:     }
 84: 
 85:     /**
 86:      * Return merchant country code from config,
 87:      * use default country if it not specified in General settings
 88:      *
 89:      * @return string
 90:      */
 91:     public function getMerchantCountry()
 92:     {
 93:         return $this->_pro->getConfig()->getMerchantCountry();
 94:     }
 95: 
 96:     /**
 97:      * Do not validate payment form using server methods
 98:      *
 99:      * @return  bool
100:      */
101:     public function validate()
102:     {
103:         return true;
104:     }
105: 
106:     /**
107:      * Instantiate state and set it to state object
108:      *
109:      * @param string $paymentAction
110:      * @param Varien_Object $stateObject
111:      */
112:     public function initialize($paymentAction, $stateObject)
113:     {
114:         switch ($paymentAction) {
115:             case Mage_Paypal_Model_Config::PAYMENT_ACTION_AUTH:
116:             case Mage_Paypal_Model_Config::PAYMENT_ACTION_SALE:
117:                 $payment = $this->getInfoInstance();
118:                 $order = $payment->getOrder();
119:                 $order->setCanSendNewEmailFlag(false);
120:                 $payment->setAmountAuthorized($order->getTotalDue());
121:                 $payment->setBaseAmountAuthorized($order->getBaseTotalDue());
122: 
123:                 $this->_setPaymentFormUrl($payment);
124: 
125:                 $stateObject->setState(Mage_Sales_Model_Order::STATE_PENDING_PAYMENT);
126:                 $stateObject->setStatus('pending_payment');
127:                 $stateObject->setIsNotified(false);
128:                 break;
129:             default:
130:                 break;
131:         }
132:     }
133: 
134:     /**
135:      * Sends API request to PayPal to get form URL, then sets this URL to $payment object.
136:      *
137:      * @param Mage_Payment_Model_Info $payment
138:      */
139:     protected function _setPaymentFormUrl(Mage_Payment_Model_Info $payment)
140:     {
141:         $request = $this->_buildFormUrlRequest($payment);
142:         $response = $this->_sendFormUrlRequest($request);
143:         if ($response) {
144:             $payment->setAdditionalInformation('secure_form_url', $response);
145:         } else {
146:             Mage::throwException('Cannot get secure form URL from PayPal');
147:         }
148:     }
149: 
150:     /**
151:      * Returns request object with needed data for API request to PayPal to get form URL.
152:      *
153:      * @param Mage_Payment_Model_Info $payment
154:      * @return Mage_Paypal_Model_Hostedpro_Request
155:      */
156:     protected function _buildFormUrlRequest(Mage_Payment_Model_Info $payment)
157:     {
158:         $request = $this->_buildBasicRequest()
159:             ->setOrder($payment->getOrder())
160:             ->setPaymentMethod($this);
161: 
162:         return $request;
163:     }
164: 
165:     /**
166:      * Returns form URL from request to PayPal.
167:      *
168:      * @param Mage_Paypal_Model_Hostedpro_Request $request
169:      * @return string | false
170:      */
171:     protected function _sendFormUrlRequest(Mage_Paypal_Model_Hostedpro_Request $request)
172:     {
173:         $api = $this->_pro->getApi();
174:         $response = $api->call(self::BM_BUTTON_METHOD, $request->getRequestData());
175: 
176:         if (!isset($response['EMAILLINK'])) {
177:             return false;
178:         }
179:         return $response['EMAILLINK'];
180:     }
181: 
182:     /**
183:      * Return request object with basic information
184:      *
185:      * @return Mage_Paypal_Model_Hostedpro_Request
186:      */
187:     protected function _buildBasicRequest()
188:     {
189:         $request = Mage::getModel('paypal/hostedpro_request');
190:         $request->setData(array(
191:             'METHOD'     => self::BM_BUTTON_METHOD,
192:             'BUTTONCODE' => self::BM_BUTTON_CODE,
193:             'BUTTONTYPE' => self::BM_BUTTON_TYPE
194:         ));
195:         return $request;
196:     }
197: 
198:     /**
199:      * Get return URL
200:      *
201:      * @param int $storeId
202:      * @return string
203:      */
204:     public function getReturnUrl($storeId = null)
205:     {
206:         return $this->_getUrl('paypal/hostedpro/return', $storeId);
207:     }
208: 
209:     /**
210:      * Get notify (IPN) URL
211:      *
212:      * @param int $storeId
213:      * @return string
214:      */
215:     public function getNotifyUrl($storeId = null)
216:     {
217:         return $this->_getUrl('paypal/ipn', $storeId, false);
218:     }
219: 
220:     /**
221:      * Get cancel URL
222:      *
223:      * @param int $storeId
224:      * @return string
225:      */
226:     public function getCancelUrl($storeId = null)
227:     {
228:         return $this->_getUrl('paypal/hostedpro/cancel', $storeId);
229:     }
230: 
231:     /**
232:      * Build URL for store
233:      *
234:      * @param string $path
235:      * @param int $storeId
236:      * @param bool $secure
237:      * @return string
238:      */
239:     protected function _getUrl($path, $storeId, $secure = null)
240:     {
241:         $store = Mage::app()->getStore($storeId);
242:         return Mage::getUrl($path, array(
243:             "_store"   => $store,
244:             "_secure"  => is_null($secure) ? $store->isCurrentlySecure() : $secure
245:         ));
246:     }
247: }
248: