1: <?php
  2: 
  3: /*
  4:   
  5:  *
  6:  * NOTICE OF LICENSE
  7:  *
  8:  * This source file is subject to the Open Software License (OSL 3.0)
  9:  * or OpenGPL v3 license (GNU Public License V3.0)
 10:  * that is bundled with this package in the file LICENSE.txt.
 11:  * It is also available through the world-wide-web at this URL:
 12:  * http://opensource.org/licenses/osl-3.0.php
 13:  * or
 14:  * http://www.gnu.org/licenses/gpl-3.0.txt
 15:  * If you did not receive a copy of the license and are unable to
 16:  * obtain it through the world-wide-web, please send an email
 17:  * to info@e-abi.ee so we can send you a copy immediately.
 18:  *
 19:  * DISCLAIMER
 20:  *
 21:  * Do not edit or add to this file if you wish to upgrade this module to newer
 22:  * versions in the future.
 23:  *
 24:  * @category   Eabi
 25:  * @package    Eabi_Dpd
 26:  * @copyright  Copyright (c) 2014 Aktsiamaailm LLC (http://en.e-abi.ee/)
 27:  * @license    http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 28:  * @license    http://www.gnu.org/licenses/gpl-3.0.txt  GNU Public License V3.0
 29:  * @author     Matis Halmann
 30:  * 
 31: 
 32:  */
 33: 
 34: /**
 35:  * <p>Wrapper class for communicating with DPD API</p>
 36:  * <p>Each request is prefilled with username, password, return address data whenever possible.</p>
 37:  * <p>Each response is json_decoded to assoc array and Exception is thrown when response error code is else than integer 0</p>
 38:  *
 39:  * @author Matis
 40:  */
 41: class Eabi_DpdEE_Model_Api extends Varien_Object {
 42:     
 43:     
 44:     
 45:     /**
 46:      * Retrieve information from carrier configuration
 47:      *
 48:      * @param   string $field
 49:      * @return  mixed
 50:      */
 51:     public function getConfigData($field) {
 52:         if (!$this->getCode()) {
 53:             return false;
 54:         }
 55:         $path = 'carriers/'.$this->getCode().'/'.$field;
 56:         return Mage::getStoreConfig($path, $this->getStore());
 57:     }
 58:     
 59:     
 60:     /**
 61:      * <p>Fetches list of parcel terminals from DPD API. (op=pudo)</p>
 62:      * <p>This function can be used without DPD API account.</p>
 63:      * <p>Parcel terminals are included in 'data' array key.</p>
 64:      * @return array
 65:      */
 66:     public function getOfficeList() {
 67:         $body = @$this->_getRequest();
 68:         return $body;
 69:     }
 70:     
 71:     
 72:     /**
 73:      * <p>Fetches available courier collection times. (op=date)</p>
 74:      * @param array $requestData
 75:      * @return array
 76:      */
 77:     public function getCourierCollectionTimes(array $requestData = array()) {
 78:         $details = array(
 79:             'op' => 'date',
 80:             'Po_postal' => $this->getConfigData('return_postcode'),
 81:             'Po_country' => strtolower($this->getConfigData('return_country')),
 82:             'Po_type' => isset($requestData['Po_type'])?strtolower($requestData['Po_type']):'po',
 83:         );
 84:         if ($details['Po_country'] == 'ee') {
 85:             //documentation required 'eesti' as supplied country
 86:             //in order to use same api in other countries, we change it to 'eesti' only for estonia
 87:             //probably in the future all countries require only iso-3166 code
 88:             $details['Po_country'] = 'eesti';
 89:         }
 90:         foreach ($details as $key => $detail) {
 91:             $requestData[$key] = $detail;
 92:         }
 93:         $requestResult = $this->_getRequest($requestData);
 94:         return $requestResult;
 95:         
 96:     }
 97:     
 98:     /**
 99:      * <p>Send parcel data to DPD server, prefills with return data from Magento configuration.</p>
100:      * @param array $requestData
101:      * @return array
102:      */
103:     public function autoSendData(array $requestData) {
104:         $returnDetails = array(
105:             'op' => 'order',
106:             'Po_name' => $this->getConfigData('return_name'),
107:             'Po_company' => $this->getConfigData('return_company'),
108:             'Po_street' => $this->getConfigData('return_street'),
109:             'Po_postal' => $this->getConfigData('return_postcode'),
110:             'Po_country' => strtolower($this->getConfigData('return_country')),
111:             'Po_city' => $this->getConfigData('return_citycounty'),
112:             'Po_contact' => $this->getConfigData('return_name'),
113:             'Po_phone' => $this->getConfigData('return_phone'),
114:             //po-remark
115:             'Po_email' => $this->getConfigData('return_email'),
116:             'Po_show_on_label' => $this->getConfigData('po_show_on_label')?'true':'false',
117:             'Po_save_address' => $this->getConfigData('po_save_address')?'true':'false',
118: //            'Po_type' => $this->getConfigData('senddata_service'),
119:             'LabelsPosition' => $this->getConfigData('label_position'),
120:             
121:         );
122:         
123:         foreach ($returnDetails as $key => $returnDetail) {
124:             $requestData[$key] = $returnDetail;
125:         }
126:         if (!isset($requestData['Po_type'])) {
127:             $requestData['Po_type'] = $this->getConfigData('senddata_service');
128:         }
129:         
130:         $requestResult = $this->_getRequest($requestData);
131:         return $requestResult;
132:     }
133:     
134: 
135:     /**
136:      * <p>Determines if courier has been called to pick up the packages.</p>
137:      * <p>If courier has been called to fetch packages and courier pickup time from has not yet been reached, then it returns array consisting following elements:</p>
138:      * <ul>
139:          <li>UNIX timestamp when courier pickup should start</li>
140:          <li>UNIX timestamp when courier pickup should end</li>
141:      </ul>
142:      * <p>On every other scenario this function returns boolean false</p>
143:      * @return boolean|array
144:      */
145:     public function isCourierComing() {
146:         $pickupTime = $this->getConfigData('courier_pickup_time');
147:         $time = time();
148:         if ($pickupTime) {
149:             $pickupTime = explode(',', $pickupTime);
150:         }
151:         if ($pickupTime[0] >= $time) {
152:             return $pickupTime;
153:         }
154:         return false;
155:     }
156:     
157:     
158:     
159:     /**
160:      * <p>Sends actual request to DPD API, prefills with username and password and json decodes the result.</p>
161:      * <p>Default operation (op=pudo), on such scenario username and password is not sent.</p>
162:      * <p>If return error code is else than 0, then exception is thrown.</p>
163:      * @param array $params
164:      * @param string $url
165:      * @return array
166:      */
167:     protected function _getRequest($params = array('op' => 'pudo'), $url = null) {
168:         if (!$url) {
169:             $url = $this->getConfigData('api_url');
170:         }
171:         if (isset($params['op']) && $params['op'] != 'pudo') {
172:             $params['User_login'] = $this->getConfigData('sendpackage_username');
173:             $params['User_password'] = $this->getConfigData('sendpackage_password');
174:         }
175:         $client = new Zend_Http_Client($url);
176:         $options = array(
177:             'timeout' => $this->getConfigData('http_request_timeout')>10?$this->getConfigData('http_request_timeout'):10,
178:         );
179:         $client->setConfig($options);
180:         $client->setParameterPost($params);
181:         $resp = $client->request(Zend_Http_Client::POST);
182:         $dataToLog = array(
183:             'url' => $url,
184:             'method' => Zend_Http_Client::POST,
185:             'params' => $this->_debugReplace($params),
186:         );
187:         
188:         
189:         $decodeResult = @json_decode($resp->getBody(), true);
190:         if (!is_array($decodeResult) || !isset($decodeResult['Error_code'])
191:                 || $decodeResult['Error_code'] !== 0) {
192:             if (!$decodeResult) {
193:                 $dataToLog['response'] = $resp;
194:             } else {
195:                 $dataToLog['response'] = $decodeResult;
196:             }
197:             if ($this->_isLogEnabled()) {
198:                 Mage::log($dataToLog, Zend_Log::ERR, __CLASS__ . '.log');
199:             }
200:             
201:             Mage::throwException($this->_getDpdHelper()->__('DPD request failed with response: %s', print_r($decodeResult, true)));
202:         }
203:         $dataToLog['response'] = $decodeResult;
204: //        $dataToLog['client'] = $client;
205:         if ($this->_isLogEnabled()) {
206:             Mage::log($dataToLog, Zend_Log::DEBUG, __CLASS__ . '.log');
207:         }
208:         
209:         return $decodeResult;
210:     }
211:     
212:     
213:     protected function _debugReplace($params) {
214:         $res = $params;
215:         $toReplace = array(
216:             'User_login',
217:             'User_password',
218:         );
219:         foreach ($toReplace as $replace) {
220:             if (isset($res[$replace])) {
221:                 $res[$replace] = '***';
222:             }
223:         }
224:         return $res;
225:     }
226:     
227:     
228:     protected function _isLogEnabled() {
229:         return $this->getConfigData('enable_log');
230:     }
231:     
232:     /**
233:      * 
234:      * @return Eabi_DpdEE_Helper_Data
235:      */
236:     protected function _getDpdHelper() {
237:         return Mage::helper('eabi_dpdee');
238:     }
239:     
240:     
241:     
242:     /**
243:      * 
244:      * @return Eabi_Postoffice_Helper_Data
245:      */
246:     protected function _getOfficeHelper() {
247:         return Mage::helper('eabi_postoffice');
248:     }
249:     
250:     
251: }
252: