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>Adds ability to use DPD COD services with DPD Parcelstore and DPD courier</p>
  36:  * <p>Customer can confirm the order without paying and customer is obligated to pay at the moment of receiving the package.</p>
  37:  * <p>Merchant can apply extra COD fee, when customer decides to use this payment method. COD fee can be set under DPD shipping modules own setting</p>
  38:  *
  39:  * @author Matis
  40:  */
  41: class dpdcodpayment extends PaymentModule {
  42:     
  43:     /**
  44:      * <p>1.6 means that module is working in 1.6 mode, otherwise module is working in 1.5 mode</p>
  45:      * @var string
  46:      */
  47:     public $ver = '1.6';
  48:     
  49:     /**
  50:      *
  51:      * @var string
  52:      */
  53:     protected $_title;
  54:     
  55:     /**
  56:      *
  57:      * @var string
  58:      */
  59:     protected $_info_text;
  60:     
  61:     /**
  62:      *
  63:      * @var string
  64:      */
  65:     protected $_checkstore;
  66:     
  67:     /**
  68:      *
  69:      * @var string
  70:      */
  71:     protected $_store_scope;
  72:     
  73: 
  74:     /**
  75:      *
  76:      * @var string
  77:      */
  78:     protected $_config_prefix = 'EABI_DPDCOD_';
  79:     const CONST_PREFIX = 'EABI_DPDCOD_';
  80: 
  81:     /**
  82:      * <p>Configuration variables for this module</p>
  83:      * @var array
  84:      */
  85:     protected $_config_array = array(
  86:         /* title displayed to the customer */
  87:         'TITLE',
  88:         /* description displayed to the customer */
  89:         'INFO_TEXT',
  90:         /* order status after customer confirms the order when using this payment method */
  91:         'ORDER_STATUS',
  92:         /* order status, when applied, shall initiate automatic data sending action */
  93:         'SEND_STATUS',
  94:         /* whether to allow this payment when cart contains only in-stock products */
  95:         'CHECKSTORE',
  96:     );
  97: 
  98:     /**
  99:      * <p>Cached instance of current modules configuration form fields</p>
 100:      * @var array
 101:      */
 102:     protected $form_fields = array();
 103:     
 104:     
 105:     /**
 106:      * <p>Makes sure only one instance is queried</p>
 107:      * @var Eabi_Postoffice
 108:      */
 109:     protected static $_helperModuleInstance;
 110:     
 111:     /**
 112:      * <p>Is activated in admin when another store scope is selected</p>
 113:      * @var int
 114:      */
 115:     protected $_id_store;
 116:     
 117:     /**
 118:      * <p>Is activated in admin when another store scope is selected</p>
 119:      * @var int
 120:      */
 121:     protected $_id_store_group;
 122:     
 123:     
 124:     
 125:     
 126:     /**
 127:      * Initiates module and loads default config
 128:      */
 129:     public function __construct() {
 130:         if (substr(_PS_VERSION_, 0, 3) == "1.5") {
 131:             $this->ver = "1.5";
 132:         }
 133:         $this->name = 'dpdcodpayment';
 134:         $this->tab = 'payments_gateways';
 135: 
 136:         $this->version = '0.9';
 137:         $this->secure_key = Tools::encrypt($this->name);
 138:         $this->bootstrap = false;
 139: 
 140:         $this->currencies = true;
 141:         $this->currencies_mode = 'checkbox';
 142:         $this->dependencies[] = 'eabi_dpd_parcelstore';
 143:         $this->ps_versions_compliancy = array('min' => '1.5', 'max' => '1.7');
 144:         
 145:         //when admin and multistore is enabled, then configuration can be set for each store separately
 146:         $cookie = new Cookie('psAdmin');
 147:         if ($cookie->id_employee) {
 148:             $this->_id_store_group = Tools::getValue('id_store_group', '0');
 149:             $this->_id_store = Tools::getValue('id_store', '0');
 150:             
 151:         }
 152:         
 153:         $config = Configuration::getMultiple($this->_getConfigArray($this->_config_prefix, $this->_config_array)
 154:                 , null
 155:                 , $this->_id_store_group
 156:                 , $this->_id_store);
 157:         $this->_initConfig($config);
 158:         
 159:         parent::__construct();
 160:         
 161:         $this->displayName = $this->l('Cash on delivery for DPD');
 162:         $this->description = $this->l('Allows customers to pay for the order at the moment when customer receives the package. Requires contractual relationships with DPD');
 163:         $this->confirmUninstall = $this->l('Are you sure you want to delete your details?');
 164:         if (!isset($this->_title) || !isset($this->_order_status) || !isset($this->_checkstore)) {
 165:             
 166:             $this->warning = $this->l('Details must be configured in order to use this module correctly');
 167:         }
 168:         if (!sizeof(Currency::checkPaymentCurrencies($this->id))) {
 169:             $this->warning = $this->l('No currency set for this module');
 170:         }
 171:     }
 172:     
 173:     /**
 174:      * <p>Performs following actions:</p>
 175:      * <ul>
 176:       <li>Registers hook with name <code>payment</code> - for displaying payment info, when this payment has been selected</li>
 177:       <li>Registers hook with name <code>paymentReturn</code> - for validating order confirmation when this payment has been selected</li>
 178:       <li>Registers hook with name <code>actionValidateOrder</code> - not applicable as of now, since automatic data sending is invoked with order status change</li>
 179:       <li>Registers hook with name <code>displayHeader</code> - for loading css file</li>
 180:       <li>Applies all updates, when applicable</li>
 181:       </ul>
 182:      * @return boolean
 183:      */
 184:     public function install() {
 185:         if (!parent::install() || !$this->registerHook('payment') || !$this->registerHook('paymentReturn')
 186:                 || !$this->registerHook('actionValidateOrder') || !$this->registerHook('displayHeader')
 187:                 || !$this->upgrade_module_0_6()) {
 188:             return false;
 189:         }
 190:         return true;
 191:         
 192:     }
 193:     
 194:     /**
 195:      * <p>Performs following actions:</p>
 196:      * <ul>
 197:       <li>Unregisters hook with name <code>payment</code></li>
 198:       <li>Unregisters hook with name <code>paymentReturn</code></li>
 199:       <li>Unregisters hook with name <code>actionValidateOrder</code></li>
 200:       <li>Unregisters hook with name <code>displayHeader</code></li>
 201:       <li>Unregisters hook with name <code>actionOrderStatusPostUpdate</code></li>
 202:       </ul>
 203:      * @return boolean
 204:      */
 205:     public function uninstall() {
 206:         //do not delete configuration
 207:         /*
 208:         $config = $this->_getConfigArray($this->_config_prefix, $this->_config_array);
 209:         foreach  ($config as $configToRemove) {
 210:             if (!Configuration::deleteByName($configToRemove)) {
 211:                 return false;
 212:             }
 213:         }
 214:          * 
 215:          */
 216:         if (!$this->unregisterHook('payment') || !$this->unregisterHook('paymentReturn')
 217:                 || !$this->unregisterHook('actionValidateOrder')
 218:                     || !$this->unregisterHook('displayHeader')
 219:                 || $this->unregisterHook('actionOrderStatusPostUpdate')) {
 220: //            return false;
 221:         }
 222:         if (!parent::uninstall()) {
 223:             return false;
 224:         }
 225:         return true;
 226:     }
 227: 
 228:     
 229:     
 230:     
 231:     
 232:     
 233:     /**
 234:      * <p>PrestaShop implementation for displaing configuration form for this module</p>
 235:      * @return string
 236:      */
 237:     public function getContent() {
 238:         $html = '<h2>' . $this->displayName . '</h2>';
 239: 
 240:         if (!empty($_POST)) {
 241:             $postErrors = $this->_postValidation();
 242:             if (!sizeof($postErrors)) {
 243:                 $html .= $this->_postProcess();
 244:             } else {
 245:                 foreach ($postErrors as $err) {
 246:                     $html .= '<div class="alert error">' . $err . '</div>';
 247:                 }
 248:             }
 249:         } else {
 250:             $html .= '<br />';
 251:         }
 252: 
 253:         $html .= $this->_displayHeader();
 254:         $html .= $this->_displayForm();
 255: 
 256:         return $html;
 257:     }
 258:     
 259:     
 260:     /**
 261:      * <p>Displays HTML block, when this payment method should be activated:</p>
 262:      * <ul>
 263:          <li>Payment method is active</li>
 264:          <li>Customer has chosen shipping method either of <code>eabi_dpd_parcelstore</code> or <code>eabi_dpd_courier</code></li>
 265:          <li>Merchant has allowed this payment method.</li>
 266:      </ul>
 267:      * @param CartCore $cart
 268:      * @deprecated since version 0.6
 269:      * @return string
 270:      */
 271:     public function execPayment($cart) {
 272:         $params = array('cart' => $cart);
 273:         if (!$this->_isAvailable($params)) {
 274:             return;
 275:         }
 276: 
 277:         $cookie = Context::getContext()->cookie;
 278:         $smarty = Context::getContext()->smarty;
 279:         
 280:         $curr = new Currency($cart->id_currency);
 281:         $module = array(
 282:             '_title' => $this->getCurrentLangValue($this->_title),
 283:             '_extra' => $this->getTitle($params['cart']),
 284:             '_text' => $this->getCurrentLangValue($this->_info_text),
 285:         );
 286:         
 287:         
 288:         $smarty->assign(array(
 289:             'nbProducts' => $cart->nbProducts(),
 290:             'cust_currency' => $cookie->id_currency,
 291:             'currencies' => $this->getCurrency(),
 292:             'total' => number_format($cart->getOrderTotal(true, 3) / $curr->conversion_rate, 2, '.', ''),
 293:             'isoCode' => Language::getIsoById(intval($cookie->id_lang)),
 294:             'this_path' => $this->_path,
 295:             'current_module' => $module,
 296:             'this_path_ssl' => (Configuration::get('PS_SSL_ENABLED') ? 'https://' : 'http://') . htmlspecialchars($_SERVER['HTTP_HOST'], ENT_COMPAT, 'UTF-8') . __PS_BASE_URI__ . 'modules/' . $this->name . '/'
 297:         ));
 298:         if ($this->ver == "1.5") {
 299:             return $this->display(__FILE__, 'payment_exec.tpl');
 300:         }
 301:         return $this->display(__FILE__, 'payment_execution.tpl');
 302:     }
 303:     
 304:     
 305:     /**
 306:      * <p>Called when customer is displayed list of available payment methods</p>
 307:      * <p>Params are assoc array and should contain at least <code>cart</code> entry, which is type of <code>Cart</code></p>
 308:      * <p>If this payment is not available, then empty string is returned</p>
 309:      * @param array $params
 310:      * @return string
 311:      */
 312:     public function hookPayment($params) {
 313:         if (!$this->_isAvailable($params)) {
 314:             return;
 315:         }
 316: 
 317:         $smarty = Context::getContext()->smarty;
 318: //        $code = $this->_getHelperModule()->codeFromId($params['cart']->id_carrier);
 319: //        $carrier = new Carrier($params['cart']->id_carrier);
 320:         $module = array(
 321:             '_title' => $this->getCurrentLangValue($this->_title),
 322:             '_extra' => $this->getTitle($params['cart']),
 323:             '_text' => $this->getCurrentLangValue($this->_info_text),
 324:         );
 325: 
 326:         $smarty->assign(array(
 327:             'this_path' => $this->_path,
 328:             'this_path_ssl' => Tools::getShopDomainSsl(true, true) . __PS_BASE_URI__ . 'modules/' . $this->name . '/',
 329:             'title' => htmlspecialchars($this->l($this->_title)),
 330:             'description' => htmlspecialchars($this->l($this->_info_text)),
 331:             'current_module' => $module,
 332:         ));
 333: 
 334:         if ($this->ver == "1.5") {
 335:             return $this->display(__FILE__, 'payment_15.tpl');
 336:         } else {
 337:             return $this->display(__FILE__,  'payment.tpl');
 338:         }
 339:     }    
 340:     
 341: 
 342:     /**
 343:      * 
 344:      * <p>Params is assoc array with following elements</p>
 345:      * <ul>
 346:          <li><code>cart</code> - cart object belonging to created order</li>
 347:          <li><code>order</code> - newly created order object</li>
 348:      </ul>
 349:      * <p>Not used, since automatic data is sent by ActionOrderStatusPostUpdate hook</p>
 350:      * @param array $params
 351:      */
 352:     public function hookActionValidateOrder($params) {
 353:     }
 354:     
 355:     /**
 356:      * <p>Adds CSS file to public side</p>
 357:      * @param array $params
 358:      */
 359:     public function hookDisplayHeader($params) {
 360:         $this->context->controller->addCSS($this->_path . $this->name . '.css', 'all');
 361:     }
 362:     
 363:     /**
 364:      * <p>Public wrapper for <code>_isAvailable</code> function.</p>
 365:      * <p>Params are assoc array and should contain at least <code>cart</code> entry, which is type of <code>Cart</code></p>
 366:      * @param array $params
 367:      * @return bool
 368:      */
 369:     public function isAvailable($params) {
 370:         return $this->_isAvailable($params);
 371:     }
 372:     
 373:     
 374:     
 375:     
 376:     /**
 377:      * <p>Global COD fee calculator based on the selected shipping method.</p>
 378:      * <p>This method is called after all validation rules have passed</p>
 379:      * @param CartCore $cart
 380:      * @return double
 381:      */
 382:     public function getCodFee($cart) {
 383:         $convertedCodFee = false;
 384:         if ($cart && $cart->id_carrier) {
 385: 
 386: 
 387:             $carrierInstance = $this->_getHelperModule()->getCarrierInstanceFromIdCarrier($cart->id_carrier);
 388:             $address = new Address($this->_getIdAddress($cart));
 389:             $codFee = $carrierInstance->getCodFee($address, $cart);
 390:             $currency = Currency::getCurrencyInstance($cart->id_currency);
 391:             $convertedCodFee = Tools::convertPrice($codFee, $currency);
 392:         }
 393:         return $convertedCodFee;
 394:     }
 395: 
 396:     /**
 397:      * <p>Displays current payment method title with extra cash on delivery fee when extra fee has been set</p>
 398:      * @return string
 399:      */
 400:     public function getTitle($cart) {
 401:         $carrierInstance = null;
 402:         $finalFee = false;
 403:         $title = '';
 404:         $convertedCodFee = $this->getCodFee($cart);
 405:             
 406:             
 407:             if ($convertedCodFee) {
 408:                 $currency = Currency::getCurrencyInstance($cart->id_currency);
 409:                 $finalFee = Tools::displayPrice($convertedCodFee, $currency);
 410:                 
 411:                 return $title . ' (' . $finalFee . ' ' . $this->l('Will be added to shipping fee').')';
 412:             }
 413:         return $title;
 414:     }
 415:     
 416:     
 417:     
 418:     
 419:     
 420:     /**
 421:      * <p>Sends automatic order data, when <code>_status is certain</code></p>
 422:      * <p><code>$params</code> contain:</p>
 423:      * <ul>
 424:          <li><code>id_order</code> order id, which status was just updated</li>
 425:          <li><code>newOrderStatus</code> order status which was applied</li>
 426:      </ul>
 427:      * @param array $params
 428:      */
 429:     public function hookActionOrderStatusPostUpdate($params) {
 430:         if ($params && isset($params['newOrderStatus']) && $params['newOrderStatus']) {
 431:             if ($params['newOrderStatus']->id == $this->getConfigData('SEND_STATUS')) {
 432:                 $order = new OrderCore($params['id_order']);
 433:                 
 434:                 
 435:                 /* @var $carrierInstance dpdcodpayment */
 436:                 $carrierInstance = $this->_getHelperModule()->getCarrierInstanceFromIdCarrier($order->id_carrier)
 437:                 ;
 438:                 if ($carrierInstance && method_exists($carrierInstance, 'isCodEnabled')) {
 439:                     $params['is_eabi_dpd_cod'] = true;
 440:                     $carrierInstance->hookPaymentConfirm($params);
 441:                 }
 442:             }
 443:         }
 444:     }
 445:     
 446:     /**
 447:      * <p>If <code>$title</code> is serialized then it is unserialized and current language value is returned</p>
 448:      * @param string|serialized $title
 449:      * @return string
 450:      */
 451:     public function getCurrentLangValue($title) {
 452:         $finalTitle = $title;
 453:         if ($this->_isSerialized($title)) {
 454:             $title = @unserialize($title);
 455:             if (is_array($title)) {
 456:                 $finalTitle = isset($title[$this->context->language->id]) ? $title[$this->context->language->id] : $title[0];
 457:             }
 458:         }
 459:         return $finalTitle;
 460:         
 461:     }
 462: 
 463: 
 464: 
 465: 
 466: 
 467:     /**
 468:      * <p>PrestaShop own currency validation method</p>
 469:      * @param CartCore $cart
 470:      * @return boolean
 471:      */
 472:     public function checkCurrency($cart) {
 473:         $currency_order = new Currency($cart->id_currency);
 474:         $currencies_module = $this->getCurrency($cart->id_currency);
 475: 
 476:         if (is_array($currencies_module)) {
 477:             foreach ($currencies_module as $currency_module) {
 478:                 if ($currency_order->id == $currency_module['id_currency']) {
 479:                     return true;
 480:                 }
 481:             }
 482:         }
 483:         return false;
 484:     }
 485: 
 486:     /**
 487:      * <p>Adds EUR as accepted currency for this payment method</p>
 488:      * @param array $shops
 489:      * @return boolean
 490:      */
 491:     public function addCheckboxCurrencyRestrictionsForModule(array $shops = array()) {
 492:         if (!$shops)
 493:             $shops = Shop::getShops(true, null, true);
 494: 
 495:         foreach ($shops as $s) {
 496:             if (!Db::getInstance()->execute('
 497:                     INSERT INTO `' . _DB_PREFIX_ . 'module_currency` (`id_module`, `id_shop`, `id_currency`)
 498:                     SELECT ' . (int) $this->id . ', "' . (int) $s . '", `id_currency` FROM `' . _DB_PREFIX_ . 'currency` WHERE deleted = 0 and iso_code = \'EUR\''))
 499:                 return false;
 500:         }
 501:         return true;
 502:     }
 503: 
 504:     /**
 505:      * Add checkbox country restrictions for a new module
 506:      * @param integer id_module
 507:      * @param array $shops
 508:      */
 509:     public function addCheckboxCountryRestrictionsForModule(array $shops = array()) {
 510:         $countries = Country::getCountries((int) Context::getContext()->language->id, true); //get only active country
 511:         $allowedCountries = array(
 512:             'EE', 'LV', 'LT',
 513:         );
 514:         $country_ids = array();
 515:         foreach ($countries as $country) {
 516:             if (in_array($country['iso_code'], $allowedCountries)) {
 517:                 $country_ids[] = $country['id_country'];
 518:             }
 519:         }
 520:         return Country::addModuleRestrictions($shops, $countries, array(array('id_module' => (int) $this->id)));
 521:     }
 522: 
 523: 
 524: 
 525:     /**
 526:      * <p>Fetches configuration for this instance for current store scope.</p>
 527:      * @param string $param
 528:      * @return mixed
 529:      */
 530:     public function getConfigData($param) {
 531:         
 532:         $value = Configuration::get(self::CONST_PREFIX . $param);
 533:         if ($value === null || $value === false) {
 534:             $formFields = $this->_initFormFields();
 535:             if (isset($formFields[strtolower($param)]) && $formFields[strtolower($param)]['default']) {
 536:                 return $formFields[strtolower($param)]['default'];
 537:             }
 538:         }
 539:         return $value;
 540:     }
 541:     /**
 542:      * <p>Fetches configuration for Admin form taking into account supplied store scope.</p>
 543:      * @param string $param
 544:      * @return mixed
 545:      */
 546:     public function getFormConfigData($param) {
 547:         
 548:         $value = Configuration::get(self::CONST_PREFIX . $param, null, $this->_id_store_group, $this->_id_store);
 549:         if ($value === null || $value === false) {
 550:             $formFields = $this->_initFormFields();
 551:             if (isset($formFields[strtolower($param)]) && $formFields[strtolower($param)]['default']) {
 552:                 return $formFields[strtolower($param)]['default'];
 553:             }
 554:         }
 555:         return $value;
 556:     }
 557:     
 558:     /**
 559:      * <p>Returns cached instance of base helper module</p>
 560:      * @return Eabi_Postoffice
 561:      */
 562:     public function _getHelperModule() {
 563:         if (is_null(self::$_helperModuleInstance)) {
 564:             self::$_helperModuleInstance = Module::getInstanceByName('eabi_postoffice');
 565:         }
 566:         return self::$_helperModuleInstance;
 567:     }
 568:     
 569:     
 570:     /**
 571:      * <p>Fetches global configuration for this instance.</p>
 572:      * @param string $param
 573:      * @return mixed
 574:      */
 575:     public function getGlobalConfigData($param) {
 576:         $value = Configuration::getGlobalValue(self::CONST_PREFIX . $param);
 577:         if ($value === null || $value === false) {
 578:             $formFields = $this->_initFormFields();
 579:             if (isset($formFields[strtolower($param)]) && $formFields[strtolower($param)]['default']) {
 580:                 return $formFields[strtolower($param)]['default'];
 581:             }
 582:         }
 583:         return $value;
 584:     }
 585: 
 586:     /**
 587:      * <p>Validates Admin Configuration Form and returns array of error message on validation failure.</p>
 588:      * @return array error messages as array, if any
 589:      */
 590:     protected function _postValidation() {
 591:         $errors = array();
 592:         if (strtoupper($_SERVER['REQUEST_METHOD']) != 'POST') {
 593:             //on no post mode do not validate
 594:             return $errors;
 595:         }
 596:         foreach ($this->_initFormFields() as $formFieldName => $formFieldData) {
 597:             $validationRules = isset($formFieldData['validate']) ? $formFieldData['validate'] : array();
 598:             $validationIfRules = isset($formFieldData['validate-if']) ? $formFieldData['validate-if'] : array();
 599:             //select,multiselect validation
 600:             $selectValidationResult = $this->_getValidator()->validate('validate_select', strtoupper($formFieldName), $_POST, $validationIfRules, $formFieldData);
 601:             if (is_string($selectValidationResult)) {
 602:                 //we have validation error
 603:                 $errors[] = sprintf($selectValidationResult, $formFieldData['title']);
 604:                 break;
 605:             }
 606: 
 607:             foreach ($validationRules as $validationRule) {
 608:                 $validationResult = $this->_getValidator()->validate($validationRule, strtoupper($formFieldName), $_POST, $validationIfRules, $formFieldData);
 609:                 if (is_string($validationResult)) {
 610:                     //we have validation error
 611:                     $errors[] = sprintf($this->l($validationResult), $formFieldData['title']);
 612:                     break;
 613:                 }
 614:             }
 615:         }
 616: 
 617: 
 618:         return $errors;
 619:     }
 620:     
 621:     
 622:     
 623:     
 624:     
 625:     /**
 626:      * <p>Renders form HTML from the form fields configuration</p>
 627:      * @param string $action action url
 628:      * @param string $method form element method attribute
 629:      * @param array $formFields form fields array
 630:      * @return string resulting html
 631:      */
 632:     protected function _getFormHtml($action, $method, $formFields) {
 633:         $action = Tools::htmlentitiesUTF8($action);
 634:         $html = '';
 635: 
 636:         $formElementsHtml = '';
 637:         $formElementHelper = $this->_getHtmlHelper();
 638:         foreach ($formFields as $fieldName => $fieldData) {
 639:             $methodName = 'get' . ucfirst($fieldData['type']) . 'Html';
 640:             $fieldPropertyName = '_' . $fieldName;
 641:             $value = Tools::getValue(strtoupper($fieldName), $this->getFormConfigData(strtoupper($fieldName)));
 642:             
 643:             //multi store support, inject global values, when substore has been selected
 644:             if ($this->_id_store || $this->_id_store_group) {
 645:                 $fieldData['global_value'] = $this->getGlobalConfigData(strtoupper($fieldName));
 646:             }
 647:             
 648:             
 649:             if (method_exists($formElementHelper, $methodName)) {
 650:                 $formElementsHtml .= $formElementHelper->$methodName(strtoupper($fieldName), $fieldData, $value);
 651:             } else {
 652:                 $formElementsHtml .= $formElementHelper->getTextHtml(strtoupper($fieldName), $fieldData, $value);
 653:             }
 654:         }
 655: 
 656:         $formClass = 'eabi_dpd_parcelstore '.$this->name;
 657: 
 658:         $html .= <<<HTML
 659:    <form action="{$action}" method="{$method}">
 660:        <fieldset>
 661:            <legend><img src="../img/admin/contact.gif" alt="" />{$this->l('Configuration details')}</legend>
 662:                <table id="form" class="{$formClass}">
 663:                 <colgroup class="label"></colgroup>
 664:                 <colgroup class="value"></colgroup>
 665:                <tbody>
 666:                {$formElementsHtml}
 667:                    <tr>
 668:                        <td colspan="2"><input class="button" name="btnSubmit" value="{$this->l('Update settings')}" type="submit" /></td>
 669:                    </tr>
 670:                 </tbody>
 671:                </table>
 672:        </fieldset>
 673:    </form>
 674: HTML;
 675:         return $html;
 676:     }
 677:     
 678:     /**
 679:      * <p>Returns true when:</p>
 680:      * <ul>
 681:          <li>Module is active</li>
 682:          <li>Shipping method is DPD Parcelstore or DPD courier and shipping method has COD fee defined</li>
 683:          <li>Method supports current currency</li>
 684:          <li>When status check is available, then all products in cart have to be in-stock</li>
 685:      </ul>
 686:      * <p>Params are assoc array and should contain at least <code>cart</code> entry, which is type of <code>Cart</code></p>
 687:      * @param array $params
 688:      * @return boolean
 689:      */
 690:     protected function _isAvailable($params) {
 691:         /* @var $cart CartCore */
 692:         $cart = $params['cart'];
 693:         if (!$this->active) {
 694:             return false;
 695:         }
 696:         if (!$this->checkCurrency($cart)) {
 697:             return false;
 698:         }
 699:         if ($cart && $cart->id_carrier) {
 700:             //availability check
 701:             if ($this->getConfigData('CHECKSTORE') == 'yes' && !$cart->isAllProductsInStock(true)) {
 702:                 //allowance only for in-stock products
 703:                 return false;
 704:             }
 705:             
 706:             
 707:             $carrierInstance = $this->_getHelperModule()->getCarrierInstanceFromIdCarrier($cart->id_carrier);
 708:             if ($carrierInstance && method_exists($carrierInstance, 'getCodFee')
 709:                     && method_exists($carrierInstance, 'isCodEnabled') && $carrierInstance->isCodEnabled(new Address($this->_getIdAddress($cart)))) {
 710:                 
 711:                 
 712:                 return true;
 713:             }
 714:             
 715:         } else {
 716:             return false;
 717:         }
 718:         
 719:         return false;
 720:     }
 721:     
 722:     /**
 723:      * <p>Fix display bug right after login</p>
 724:      * <p>select menu of pickup points not displayed after entering customer address and then logging in instead</p>
 725:      * @param int $origIdAddress default cart->id_address_delivery
 726:      * @return int
 727:      */
 728:     protected function _getIdAddress($cart) {
 729:         //fix display bug right after login.
 730:         //select menu of pickup points not displayed after entering customer address and then logging in instead
 731:         $origIdAddress = $cart->id_address_delivery;
 732:         $products = $cart->getProducts();
 733:         foreach ($products as $product) {
 734:             if (!$product['is_virtual']) {
 735:                 if ($product['id_address_delivery'] != $origIdAddress && $product['id_address_delivery']) {
 736:                     $origIdAddress = $product['id_address_delivery'];
 737:                 }
 738:                 break;
 739:             }
 740:         }
 741: 
 742:         //end fix display bug right after login
 743:         return $origIdAddress;
 744:     }
 745:     
 746:     
 747:     /**
 748:      * <p>Checks if input is phpserialized string or not</p>
 749:      * @param string $input
 750:      * @return bool
 751:      */
 752:     protected function _isSerialized($input) {
 753:         return preg_match('/^([adObis]):/', $input);
 754:     }
 755:     
 756:     /**
 757:      * 
 758:      * @return eabi_dpd_parcelstore_html_helper
 759:      */
 760:     protected function _getHtmlHelper() {
 761:         /* @var $helper eabi_dpd_parcelstore_html_helper */
 762:         $helper = $this->_getHelperModule()->helper('html_helper', eabi_dpd_parcelstore::NAME);
 763:         $helper->setContext($this->context)->setModuleInstance($this);
 764:         return $helper;
 765:     }
 766:     
 767:     /**
 768:      * 
 769:      * @return eabi_dpd_parcelstore_validator_helper
 770:      */
 771:     protected function _getValidator() {
 772:         return $this->_getHelperModule()->helper('validator_helper', eabi_dpd_parcelstore::NAME);
 773:     }
 774:     
 775:     
 776:     
 777:     
 778:     
 779:     
 780:     
 781:     /**
 782:      * <p>Saves configuration entered from the admin form and returns HTML generated during process.</p>
 783:      * @return string any generated HTML from the postprocess, for example success message
 784:      */
 785:     private function _postProcess() {
 786:         $data = $_POST;
 787:         $html = '';
 788:         if (isset($data['btnSubmit'])) {
 789:             $config = $this->_getConfigArray('', $this->_config_array);
 790:             
 791:             
 792:             
 793:             foreach ($config as $configValue) {
 794:                 if (is_array($data[$configValue])) {
 795:                     $data[$configValue] = serialize($data[$configValue]);
 796:                 }
 797:                 
 798:                 
 799:                 
 800:                 Configuration::updateValue($this->_config_prefix . $configValue, $data[$configValue], false
 801:                         , Tools::getValue('id_store_group', '0')
 802:                         , Tools::getValue('id_store', '0'));
 803:                 
 804:             }
 805:             $config = Configuration::getMultiple($this->_getConfigArray($this->_config_prefix, $this->_config_array));
 806:             $this->_initConfig($config);
 807:             
 808:             $html .= '<div class="conf confirm"><img src="../img/admin/ok.gif" alt="' . $this->l('ok') . '" /> ' . $this->l('Settings updated') . '</div>';
 809:         }
 810:         return $html;
 811:     }
 812:     
 813:     
 814:     /**
 815:      * <p>Displayes admin configuration form header</p>
 816:      * @return string html
 817:      */
 818:     private function _displayHeader() {
 819:         $html = <<<HTML
 820:    <img src="../modules/{$this->name}/{$this->name}.gif" alt=""  style="float:left; margin-right:15px;"/>
 821:        <b>{$this->l('This module allows you to accept COD payments from customers using DPD services')}</b>
 822:            <br />{$this->l('COD delivery fee can be set under DPD own settings')}
 823:                <br />
 824:                    <br />
 825:                    <br />
 826:                    <br />
 827: HTML;
 828:            
 829:         return $html;
 830:     }
 831:     
 832:     /**
 833:      * <p>Generates actual configuration form by rules</p>
 834:      * @return string
 835:      */
 836:     private function _displayForm() {
 837:         //Tools::safeOutput($_SERVER['REQUEST_URI'])
 838:         if (Configuration::getGlobalValue('PS_MULTISHOP_FEATURE_ACTIVE')) {
 839:             $shopFields = array(
 840:                 'store_scope' => array(
 841:                     'title' => $this->l('Store Scope'),
 842:                     'type' => 'stores',
 843:                     'description' => $this->l('Current configuration scope'),
 844:                     'default' => '0',
 845:                     'css' => 'width: 300px;',
 846:                 )
 847:             );
 848:             $formFields = array_merge($shopFields, $this->_initFormFields());
 849:         } else {
 850:             $formFields = $this->_initFormFields();
 851:         }
 852: 
 853: 
 854:         $html = $this->_getFormHtml($_SERVER['REQUEST_URI'], 'post', $formFields);
 855:         return $html;
 856:     }
 857:     
 858:     
 859:     /**
 860:      * <p>Creates admin form fields for this module and caches them after creation</p>
 861:      * @see eabi_dpd_parcelstore_html_helper
 862:      * @return array
 863:      */
 864:     private function _initFormFields() {
 865:         if (count($this->form_fields)) {
 866:             return $this->form_fields;
 867:         }
 868:         $returnUri = (Configuration::get('PS_SSL_ENABLED') ? 'https://' : 'http://') . $_SERVER['HTTP_HOST'] . __PS_BASE_URI__ . 'modules/' . $this->name . '/validatePayment.php';
 869:         
 870:         //alternate return URL depending on selected store
 871:         if ((int) Tools::getValue('id_store', 0)) {
 872:             $shop = new Shop((int) Tools::getValue('id_store', 0));
 873:             $urls = $shop->getUrls();
 874:             if (isset($urls[0])) {
 875:                 $returnUri = (Configuration::get('PS_SSL_ENABLED') ? 'https://' : 'http://') . $urls[0]['domain_ssl'] . $urls[0]['physical_uri'] . 'modules/' . $this->name . '/validatePayment.php';
 876:             }
 877:         }
 878:         $yesno = array(
 879:             'yes' => $this->l('Yes'),
 880:             'no' => $this->l('No'),
 881:         );
 882:         
 883:         $orderStates = OrderState::getOrderStates((int)Context::getContext()->language->id);
 884:         
 885:         $orderStatuses = array();
 886:         foreach ($orderStates as $orderState) {
 887:             $orderStatuses[(string)$orderState['id_order_state']] = $orderState['name'];
 888:         }
 889: 
 890: 
 891:         $this->form_fields = array(
 892:             'title' => array(
 893:                 'title' => $this->l('Text displayed to client'),
 894:                 'type' => 'multilang',
 895:                 'description' => $this->l('This controls the title which the user sees during checkout.'),
 896:                 'default' => 'Tasun lunaga paki kättesaamisel',
 897:                 'css' => 'width: 300px;',
 898:             ),
 899:             'info_text' => array(
 900:                 'title' => $this->l('Description displayed to the client'),
 901:                 'type' => 'multilangtextarea',
 902:                 'description' => $this->l('This controls the description which the user sees during checkout.'),
 903:                 'default' => '',
 904:                 'css' => 'width: 300px;',
 905:             ),
 906:             'order_status' => array(
 907:                 'title' => $this->l('New order status'),
 908:                 'type' => 'select',
 909:                 'default' => Configuration::get('PS_OS_BANKWIRE'),
 910:                 'options' => $orderStatuses,
 911:                 'css' => 'width: 300px;',
 912:             ),
 913:             'send_status' => array(
 914:                 'title' => $this->l('Order status for initiating data sending without marking order as paid.'),
 915:                 'type' => 'select',
 916:                 'default' => '',
 917:                 'options' => $orderStatuses,
 918:                 'description' => $this->l('If you want to send data to DPD server without marking order as paid, you need to set order to this status.'),
 919:                 'css' => 'width: 300px;',
 920:             ),
 921:             'checkstore' => array(
 922:                 'title' => $this->l('Allow only for products which are in-stock'),
 923:                 'type' => 'select',
 924:                 'default' => '',
 925:                 'options' => $yesno,
 926:                 'css' => 'width: 300px;',
 927:             ),
 928:         );
 929:         return $this->form_fields;
 930:     }
 931: 
 932:     /**
 933:      * <p>Reads in configuration keys and sets current class properties from configuration.</p>
 934:      * <p>Configuration <code>ABC</code> would be translated to <code>$this->_abc</code></p>
 935:      * @param array $config
 936:      */
 937:     private function _initConfig($config) {
 938:         foreach ($this->_config_array as $configKey) {
 939:             if (isset($config[$this->_config_prefix . $configKey])) {
 940:                 $classProperty = '_' . strtolower($configKey);
 941:                 $this->$classProperty = $config[$this->_config_prefix . $configKey];
 942:             }
 943:         }
 944:     }
 945: 
 946:     /**
 947:      * <p>Gets configuration keys with supplied prefix</p>
 948:      * @param string $prefix
 949:      * @param array $array
 950:      * @return array
 951:      */
 952:     private function _getConfigArray($prefix, $array) {
 953:         $result = array();
 954:         foreach ($array as $value) {
 955:             $result[] = $prefix.$value;
 956:         }
 957:         return $result;
 958:     }
 959:     
 960:     
 961:     
 962:     /* module upgrades */
 963: 
 964:     /**
 965:      * <p>Performs following actions</p>
 966:      * <ul>
 967:          <li>Creates new order state, which should trigger automatic data sending without marking order as paid</li>
 968:          <li>Applies created state as trigger-data-sending status</li>
 969:          <li>Registers hook <code>actionOrderStatusPostUpdate</code> for auto-sending data after status change</li>
 970:          <li></li>
 971:          <li></li>
 972:      </ul>
 973:      * @return bool
 974:      */
 975:     public function upgrade_module_0_6() {
 976:         // Process Module upgrade to 0.6
 977:         // ....
 978:         //insert new order status, where
 979:         /*
 980:          * order is considered as valid
 981:          * color is #7dffa3
 982:          * showDeliveryPdf is set to true
 983:          * insert id = ps_config.
 984:          */
 985:         $key = self::CONST_PREFIX . 'SEND_STATUS';
 986: 
 987: 
 988:         //= insertSomeOrderStatusAndReturnId('');
 989:         $orderState = new OrderState(null, Configuration::get('PS_LANG_DEFAULT'));
 990:         $orderState->invoice = 0;
 991:         $orderState->send_email = 0;
 992:         $orderState->color = '#7dffa3';
 993:         $orderState->unremovable = '1';
 994:         $orderState->logable = '1';
 995:         $orderState->delivery = '0';
 996: //    $orderState->id_lang = Configuration::get('PS_LANG_DEFAULT');
 997:         $orderState->name = $this->l('Pending, Customer accepted for COD');
 998: //    $orderState->name = 'Pending, Customer accepted for COD';
 999: //    echo '<pre>'.htmlspecialchars(print_r($orderState, true), ENT_COMPAT | ENT_HTML401 | ENT_IGNORE).'</pre>';
1000: 
1001:         $orderState->save();
1002:         
1003:         
1004:         //also insert translations....
1005:         $insertId = $orderState->id;
1006:         
1007:         $db = Db::getInstance();
1008:         
1009:         $languages = Language::getLanguages(false);
1010:         foreach ($languages as $language) {
1011:             /* @var $language LanguageCore */
1012:             if ($language['id_lang'] != Configuration::get('PS_LANG_DEFAULT')) {
1013:                 $db->insert('order_state_lang', array(
1014:                     'id_order_state' => $db->escape($insertId),
1015:                     'id_lang' => $db->escape($language['id_lang']),
1016:                     'name' => $db->escape($this->l('Pending, Customer accepted for COD')),
1017:                     /* empty template needs to exist, because it has no default value and is not null */
1018:                     'template' => '',
1019:                 ));
1020:             }
1021:         }
1022:         
1023:         
1024:         //set newly created order status as default status for accepting COD payments
1025:         Configuration::updateValue($key, $orderState->id);
1026: 
1027: 
1028:         //register hook for listening order status
1029:         return $this->registerHook('actionOrderStatusPostUpdate');
1030:     }
1031: 
1032: }
1033: