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:  * Billing agreements controller
 29:  *
 30:  * @author Magento Core Team <core@magentocommerce.com>
 31:  */
 32: class Mage_Sales_Billing_AgreementController extends Mage_Core_Controller_Front_Action
 33: {
 34:     /**
 35:      * View billing agreements
 36:      *
 37:      */
 38:     public function indexAction()
 39:     {
 40:         $this->_title($this->__('Billing Agreements'));
 41:         $this->loadLayout();
 42:         $this->_initLayoutMessages('customer/session');
 43:         $this->renderLayout();
 44:     }
 45: 
 46:     /**
 47:      * Action predispatch
 48:      *
 49:      * Check customer authentication
 50:      */
 51:     public function preDispatch()
 52:     {
 53:         parent::preDispatch();
 54:         if (!$this->getRequest()->isDispatched()) {
 55:             return;
 56:         }
 57:         if (!$this->_getSession()->authenticate($this)) {
 58:             $this->setFlag('', 'no-dispatch', true);
 59:         }
 60:     }
 61: 
 62:     /**
 63:      * View billing agreement
 64:      *
 65:      */
 66:     public function viewAction()
 67:     {
 68:         if (!$agreement = $this->_initAgreement()) {
 69:             return;
 70:         }
 71:         $this->_title($this->__('Billing Agreements'))
 72:             ->_title($this->__('Billing Agreement # %s', $agreement->getReferenceId()));
 73:         $this->loadLayout();
 74:         $this->_initLayoutMessages('customer/session');
 75:         $navigationBlock = $this->getLayout()->getBlock('customer_account_navigation');
 76:         if ($navigationBlock) {
 77:             $navigationBlock->setActive('sales/billing_agreement/');
 78:         }
 79:         $this->renderLayout();
 80:     }
 81: 
 82:     /**
 83:      * Wizard start action
 84:      *
 85:      */
 86:     public function startWizardAction()
 87:     {
 88:         $agreement = Mage::getModel('sales/billing_agreement');
 89:         $paymentCode = $this->getRequest()->getParam('payment_method');
 90:         if ($paymentCode) {
 91:             try {
 92:                 $agreement->setStoreId(Mage::app()->getStore()->getId())
 93:                     ->setMethodCode($paymentCode)
 94:                     ->setReturnUrl(Mage::getUrl('*/*/returnWizard', array('payment_method' => $paymentCode)))
 95:                     ->setCancelUrl(Mage::getUrl('*/*/cancelWizard', array('payment_method' => $paymentCode)));
 96: 
 97:                 $this->_redirectUrl($agreement->initToken());
 98:                 return $this;
 99:             } catch (Mage_Core_Exception $e) {
100:                 $this->_getSession()->addError($e->getMessage());
101:             } catch (Exception $e) {
102:                 Mage::logException($e);
103:                 $this->_getSession()->addError($this->__('Failed to start billing agreement wizard.'));
104:             }
105:         }
106:         $this->_redirect('*/*/');
107:     }
108: 
109:     /**
110:      * Wizard return action
111:      *
112:      */
113:     public function returnWizardAction()
114:     {
115:         $agreement = Mage::getModel('sales/billing_agreement');
116:         $paymentCode = $this->getRequest()->getParam('payment_method');
117:         $token = $this->getRequest()->getParam('token');
118:         if ($token && $paymentCode) {
119:             try {
120:                 $agreement->setStoreId(Mage::app()->getStore()->getId())
121:                     ->setToken($token)
122:                     ->setMethodCode($paymentCode)
123:                     ->setCustomer(Mage::getSingleton('customer/session')->getCustomer())
124:                     ->place();
125:                 $this->_getSession()->addSuccess(
126:                     $this->__('The billing agreement "%s" has been created.', $agreement->getReferenceId())
127:                 );
128:                 $this->_redirect('*/*/view', array('agreement' => $agreement->getId()));
129:                 return;
130:             } catch (Mage_Core_Exception $e) {
131:                 $this->_getSession()->addError($e->getMessage());
132:             } catch (Exception $e) {
133:                 Mage::logException($e);
134:                 $this->_getSession()->addError($this->__('Failed to finish billing agreement wizard.'));
135:             }
136:             $this->_redirect('*/*/index');
137:         }
138:     }
139: 
140:     /**
141:      * Wizard cancel action
142:      *
143:      */
144:     public function cancelWizardAction()
145:     {
146:         $this->_redirect('*/*/index');
147:     }
148: 
149:     /**
150:      * Cancel action
151:      * Set billing agreement status to 'Canceled'
152:      *
153:      */
154:     public function cancelAction()
155:     {
156:         $agreement = $this->_initAgreement();
157:         if ($agreement && $agreement->canCancel()) {
158:             try {
159:                 $agreement->cancel();
160:                 $this->_getSession()->addNotice($this->__('The billing agreement "%s" has been canceled.', $agreement->getReferenceId()));
161:             } catch (Mage_Core_Exception $e) {
162:                 $this->_getSession()->addError($e->getMessage());
163:             } catch (Exception $e) {
164:                 Mage::logException($e);
165:                 $this->_getSession()->addError($this->__('Failed to cancel the billing agreement.'));
166:             }
167:         }
168:         $this->_redirect('*/*/view', array('_current' => true));
169:     }
170: 
171:     /**
172:      * Init billing agreement model from request
173:      *
174:      * @return Mage_Sales_Model_Billing_Agreement
175:      */
176:     protected function _initAgreement()
177:     {
178:         $agreementId = $this->getRequest()->getParam('agreement');
179:         if ($agreementId) {
180:             $billingAgreement = Mage::getModel('sales/billing_agreement')->load($agreementId);
181:             if (!$billingAgreement->getAgreementId()) {
182:                 $this->_getSession()->addError($this->__('Wrong billing agreement ID specified.'));
183:                 $this->_redirect('*/*/');
184:                 return false;
185:             }
186:         }
187:         Mage::register('current_billing_agreement', $billingAgreement);
188:         return $billingAgreement;
189:     }
190: 
191:     /**
192:      * Retrieve customer session model
193:      *
194:      * @return Mage_Customer_Model_Session
195:      */
196:     protected function _getSession()
197:     {
198:         return Mage::getSingleton('customer/session');
199:     }
200: }
201: