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: if (!defined('_PS_VERSION_')) {
 34:     exit;
 35: }
 36: 
 37: /**
 38:  * <p>Wrapper class for communicating with DPD API</p>
 39:  * <p>Each request is prefilled with username, password, return address data whenever possible.</p>
 40:  * <p>Each response is json_decoded to assoc array and Exception is thrown when response error code is else than integer 0</p>
 41:  *
 42:  * @author Matis
 43:  */
 44: class eabi_dpd_parcelstore_dpd_api {
 45: 
 46:     protected $_store;
 47:     protected $_code;
 48:     
 49:     protected static $_logRequestsLimit = 60;
 50:     
 51:     /**
 52:      * <p>Logger resource instance</p>
 53:      * @var FileLoggerCore
 54:      */
 55:     protected static $log;
 56:     
 57:     
 58:     /**
 59:      * <p>Information about requests done via this API is stored here</p>
 60:      * <p>Each item is in following format:</p>
 61:      * <ul>
 62:          <li><code>url</code> - destination URL for the request</li>
 63:          <li><code>request</code> - assoc array of request parameters to DPD</li>
 64:          <li><code>response</code> - assoc array of response parameters from DPD (can be empty if request fails</li>
 65:      </ul>
 66:      *
 67:      * @var array 
 68:      */
 69:     protected static $_loggedRequests = array();
 70:     
 71:     /**
 72:      * <p>Is true if current _GET and _POST contents are already logged. Value is False otherwise</p>
 73:      * @var bool
 74:      */
 75:     protected static $_isRequestLogged = false;
 76:     
 77:     public function __construct() {
 78:         ;
 79:     }
 80:     
 81:     public function setStore($store) {
 82:         $this->_store = $store;
 83:         return $this;
 84:     }
 85:     
 86:     public function setCode($code) {
 87:         $this->_code = $code;
 88:         return $this;
 89:     }
 90:     
 91:     public function getCode() {
 92:         return $this->_code;
 93:     }
 94:     
 95:     public function getStore() {
 96:         return $this->_store;
 97:     }
 98:     
 99:     /**
100:      * Retrieve information from carrier configuration
101:      *
102:      * @param   string $field
103:      * @return  mixed
104:      */
105:     public function getConfigData($field) {
106:         if (!$this->getCode()) {
107:             return false;
108:         }
109:         $path = $this->getCode().$field;
110:         return Configuration::get($path, null, null, $this->getStore());
111:     }
112:     
113:     /**
114:      * <p>Fetches list of parcel terminals from DPD API. (op=pudo)</p>
115:      * <p>This function can be used without DPD API account.</p>
116:      * <p>Parcel terminals are included in 'data' array key.</p>
117:      * @return array
118:      */
119:     public function getOfficeList() {
120:         $body = @$this->_getRequest();
121:         return $body;
122:     }
123:     
124:     
125:     /**
126:      * <p>Fetches available courier collection times. (op=date)</p>
127:      * @param array $requestData
128:      * @return array
129:      */
130:     public function getCourierCollectionTimes(array $requestData = array()) {
131:         $details = array(
132:             'op' => 'date',
133:             'Po_postal' => $this->getConfigData('RETURN_POSTCODE'),
134:             'Po_country' => strtolower($this->getConfigData('RETURN_COUNTRY')),
135:             'Po_type' => isset($requestData['Po_type'])?strtolower($requestData['Po_type']):'po',
136:         );
137:         if ($details['Po_country'] == 'ee') {
138:             //documentation required 'eesti' as supplied country
139:             //in order to use same api in other countries, we change it to 'eesti' only for estonia
140:             //probably in the future all countries require only iso-3166 code
141:             $details['Po_country'] = 'eesti';
142:         }
143:         foreach ($details as $key => $detail) {
144:             $requestData[$key] = $detail;
145:         }
146:         $requestResult = $this->_getRequest($requestData);
147:         return $requestResult;
148:         
149:     }
150:     
151:     /**
152:      * <p>Send parcel data to DPD server, prefills with return data from PrestaShop configuration.</p>
153:      * @param array $requestData
154:      * @return array
155:      */
156:     public function autoSendData(array $requestData) {
157:         $returnDetails = array(
158:             'op' => 'order',
159:             'Po_name' => $this->getConfigData('RETURN_NAME'),
160:             'Po_company' => $this->getConfigData('RETURN_COMPANY'),
161:             'Po_street' => $this->getConfigData('RETURN_STREET'),
162:             'Po_postal' => $this->getConfigData('RETURN_POSTCODE'),
163:             'Po_country' => strtolower($this->getConfigData('RETURN_COUNTRY')),
164:             'Po_city' => $this->getConfigData('RETURN_CITYCOUNTY'),
165:             'Po_contact' => $this->getConfigData('RETURN_NAME'),
166:             'Po_phone' => $this->getConfigData('RETURN_PHONE'),
167:             //po-remark
168:             'Po_email' => $this->getConfigData('RETURN_EMAIL'),
169:             'Po_show_on_label' => $this->getConfigData('PO_SHOW_ON_LABEL') == 'yes'?'true':'false',
170:             'Po_save_address' => $this->getConfigData('PO_SAVE_ADDRESS')?'true':'false',
171: //            'Po_type' => $this->getConfigData('senddata_service'),
172:             'LabelsPosition' => $this->getConfigData('LABEL_POSITION'),
173:             
174:         );
175:         
176:         foreach ($returnDetails as $key => $returnDetail) {
177:             $requestData[$key] = $returnDetail;
178:         }
179:         if (!isset($requestData['Po_type'])) {
180:             $requestData['Po_type'] = 'LO';
181:         }
182:         
183:         $requestResult = $this->_getRequest($requestData);
184:         return $requestResult;
185:     }
186:     
187:     
188:     /**
189:      * <p>Determines if courier has been called to pick up the packages.</p>
190:      * <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>
191:      * <ul>
192:          <li>UNIX timestamp when courier pickup should start</li>
193:          <li>UNIX timestamp when courier pickup should end</li>
194:      </ul>
195:      * <p>On every other scenario this function returns boolean false</p>
196:      * @return boolean|array
197:      */
198:     public function isCourierComing() {
199:         $pickupTime = $this->getConfigData('COURIER_PICKUP_TIME');
200:         $time = time();
201:         $timezoneDiff = 0;
202:         $time2 = new DateTime("now");
203:         $timeZone = new DateTimeZone('Etc/GMT+0');
204:         
205:         $timezoneDiff = date('Z');
206:         $time += $timezoneDiff;
207:         
208:         
209:         if ($pickupTime) {
210:             $pickupTime = explode(',', $pickupTime);
211:         }
212:         if ($pickupTime[0] >= $time) {
213:             return $pickupTime;
214:         }
215:         return false;
216:     }
217:     
218:     
219:     /**
220:      * <p>Sends actual request to DPD API, prefills with username and password and json decodes the result.</p>
221:      * <p>Default operation (op=pudo), on such scenario username and password is not sent.</p>
222:      * <p>If return error code is else than 0, then exception is thrown.</p>
223:      * @param array $params
224:      * @param string $url
225:      * @return array
226:      */
227:     protected function _getRequest($params = array('op' => 'pudo'), $url = null) {
228:         if (!$url) {
229:             $url = $this->getConfigData('API_URL');
230:         }
231:         $auth = '';
232:         if (strpos($url, 'dpd.surflink.ee') > 0) {
233:             $auth = "Authorization: Basic " . base64_encode("demo:demo") . "\r\n";
234:         }
235:         
236:         if (isset($params['op']) && $params['op'] != 'pudo') {
237:             $params['User_login'] = $this->getConfigData('SENDPACKAGE_USERNAME');
238:             $params['User_password'] = $this->getConfigData('SENDPACKAGE_PASSWORD');
239:         }
240:         $logRequest = array(
241:             'url' => $url,
242:             'request' => $this->_removeSensitiveData($params),
243:             'response' => '',
244:             );
245:         
246:         
247: 
248: 
249: 
250:         $options = array(
251:             'http' => array(
252:                 'method' => 'POST',
253:                 'header' => $auth . "Content-type: application/x-www-form-urlencoded\r\n",
254:                 'content' => http_build_query($params),
255:                 'timeout' => $this->getConfigData('HTTP_REQUEST_TIMEOUT') > 10 ? $this->getConfigData('HTTP_REQUEST_TIMEOUT') : 10,
256:                 'ignore_errors' => true,
257:         ));
258:         
259:         
260:         $context = stream_context_create($options);
261:         $postRequestResult = file_get_contents($url, false, $context);
262:         $body = @json_decode($postRequestResult, true);
263:         if (!is_array($body) || !isset($body['Error_code']) || $body['Error_code'] !== 0) {
264:             $finalResult = $body ? $body : $postRequestResult;
265:             $translatedText = sprintf($this->l('DPD request failed with response: %s'), print_r($finalResult, true));
266:             $logRequest['response'] = $finalResult;
267:             $this->_addLogRequest($logRequest);
268:             if ($this->_isLogEnabled()) {
269:                 self::log($logRequest, AbstractLogger::ERROR);
270:             }
271: 
272:             throw new Exception($translatedText);
273:         }
274:         $logRequest['response'] = $body;
275:         $this->_addLogRequest($logRequest);
276:         if ($this->_isLogEnabled()) {
277:             self::log($logRequest, AbstractLogger::DEBUG);
278:         }
279:         return $logRequest['response'];
280:     }
281: 
282:     /**
283:      * <p>Removes sensite data like usernames and passwords from request</p>
284:      * @param array $params
285:      * @return array
286:      */
287:     protected function _removeSensitiveData($params) {
288:         $sensitiveDataToRemove = array(
289:             'User_login',
290:             'User_password'
291:         );
292:         foreach ($sensitiveDataToRemove as $toRemoval) {
293:             if (isset($params[$toRemoval])) {
294:                 $params[$toRemoval] = '*** removed ***';
295:             }
296:         }
297:         return $params;
298:     }
299: 
300:     /**
301:      * <p>Makes sure that maximum of 60 entries are stored in the request log.</p>
302:      * @param array $logRequest
303:      * @return null
304:      */
305:     protected function _addLogRequest($logRequest) {
306:         if (count(self::$_loggedRequests) > self::$_logRequestsLimit) {
307:             return;
308:         }
309:         if (count(self::$_loggedRequests) == self::$_logRequestsLimit) {
310:             self::$_loggedRequests[] = array(
311:                 'url' => '',
312:                 'request' => 'Logging limit reached',
313:                 'response' => '',
314:             );
315:             return;
316:         }
317:         self::$_loggedRequests[] = $logRequest;
318:         
319:     }
320:     
321:     /**
322:      * <p>Get all the logged requests which are performed thru this class.</p>
323:      * <p>Each item is in following format:</p>
324:      * <ul>
325:          <li><code>url</code> - destination URL for the request</li>
326:          <li><code>request</code> - assoc array of request parameters to DPD</li>
327:          <li><code>response</code> - assoc array of response parameters from DPD (can be empty if request fails</li>
328:      </ul>
329:      * @return array
330:      */
331:     public function getLoggedRequests() {
332:         return self::$_loggedRequests;
333:     }
334: 
335:     /**
336:      * <p>Required for the PrestaShop module to recognize translations</p>
337:      * @param string $i
338:      * @return string
339:      */
340:     protected function l($i) {
341:         return Module::getInstanceByName(eabi_dpd_parcelstore::NAME)->l($i);
342:     }
343:     
344:     /**
345:      * 
346:      * @param mixed $data
347:      * @param string $level
348:      */
349:     private static function log($data, $level = AbstractLogger::DEBUG) {
350:         //TODO: implement this function....
351:         if (is_null(self::$log)) {
352:             self::$log = new FileLogger(AbstractLogger::DEBUG);
353:             self::$log->setFilename(_PS_ROOT_DIR_ . '/log/' . __CLASS__ . '.log');
354:         }
355:         
356:          if (!self::$_isRequestLogged) {
357:             self::$log->log('POST=' . print_r($_POST, true), $level);
358:             self::$log->log('GET=' . print_r($_GET, true), $level);
359:             self::$_isRequestLogged = true;
360:         }
361:        
362:         
363:         if (is_object($data) || is_array($data)) {
364:             $data = print_r($data, true);
365:         }
366:         self::$log->log($data, $level);
367:     }
368:     
369:     /**
370:      * <p>Returns true, if logging is enabled for current method</p>
371:      * @return bool
372:      */
373:     protected function _isLogEnabled() {
374:         return $this->getConfigData('ENABLE_LOG') == 'yes';
375:     }
376:     
377:     
378:     
379:     
380: }
381: