hipay_enterprise.php

<?php
/**
 * HiPay Enterprise SDK Prestashop
 *
 * 2017 HiPay
 *
 * NOTICE OF LICENSE
 *
 * @author    HiPay <support.tpp@hipay.com>
 * @copyright 2017 HiPay
 * @license   https://github.com/hipay/hipay-enterprise-sdk-prestashop/blob/master/LICENSE.md
 */

if (!defined('_PS_VERSION_')) {
    exit;
}

/**
 * Hipay_enterprise
 *
 * @author      HiPay <support.tpp@hipay.com>
 * @copyright   Copyright (c) 2017 - HiPay
 * @license     https://github.com/hipay/hipay-enterprise-sdk-prestashop/blob/master/LICENSE.md
 * @link    https://github.com/hipay/hipay-enterprise-sdk-prestashop
 */
class Hipay_enterprise extends PaymentModule
{
    public $hipayConfigTool;
    public $hipayUpdateNotif;
    public $_errors = [];
    public $_successes = [];
    public $currencies_titles = [];
    public $moduleCurrencies = [];
    public $_technicalErrors = '';

    public function __construct()
    {

        $this->name = 'hipay_enterprise';
        $this->tab = 'payments_gateways';
        $this->version = '2.13.1';
        $this->module_key = 'c3c030302335d08603e8669a5210c744';
        $this->ps_versions_compliancy = ['min' => '1.6', 'max' => _PS_VERSION_];
        $this->currencies = true;
        $this->currencies_mode = 'checkbox';
        $this->author = 'HiPay';
        $this->is_eu_compatible = 1;

        $this->bootstrap = true;
        $this->display = 'view';
        $this->displayName = $this->l('HiPay Enterprise');
        $this->description = $this->l('Accept payments by credit card and other local methods with HiPay Enterprise. Very competitive rates, no configuration required!');

        // init log object
        $this->logs = new HipayLogs($this);

        // init mapper object
        $this->mapper = new HipayMapper($this);

        $this->dbSchemaManager = new HipayDBSchemaManager($this);
        $this->dbUtils = new HipayDBUtils($this);

        // init token manger object
        $this->token = new HipayCCToken($this);

        //init config form data manager object
        $this->hipayConfigFormHandler = new HipayConfigFormHandler($this);

        parent::__construct();

        $this->currencies_titles = [];
        $this->countries_titles = [];

        $countries = Country::getCountries($this->context->language->id);

        foreach ($countries as $country) {
            $this->countries_titles[$country['iso_code']] = $country['name'];
        }
        $moduleCurrencies = $this->getCurrency((int) Configuration::get('PS_CURRENCY_DEFAULT'));
        foreach ($moduleCurrencies as $cur) {
            $this->moduleCurrencies[] = $cur['iso_code'];
        }
        $currencies = Currency::getCurrencies();

        foreach ($currencies as $currency) {
            $this->currencies_titles[$currency['iso_code']] = $currency['name'];
        }

        //configuration is handle by an helper class
        $this->hipayConfigTool = new HipayConfig($this);

        // Checking new versions of the module
        $this->hipayUpdateNotif = new HipayUpdateNotif($this);
    }

    /**
     * Translations in Front Controller doesn't work
     *
     * @see http://forge.prestashop.com/browse/BOOM-3716
     */
    private function fakeTranslation()
    {
        $fake = $this->l('Registered notification from HiPay about captured amount of ');
        $fake = $this->l('Registered notification from HiPay about refunded amount of ');
        $fake = $this->l('Order total amount :');
        $fake = $this->l('Transaction ID: ');
        $fake = $this->l('HiPay status: ');
        $fake = $this->l('A payment transaction is awaiting validation for the order %s');
        $fake = $this->l('Please enter your phone number to use this payment method.');
        $fake = $this->l('Please inform your civility to use this method of payment.');
        $fake = $this->l('Please check the information entered.');
        $fake = $this->l('Please check the phone number entered.');
        $fake = $this->l('The format of the phone number must match a French phone.');
        $fake = $this->l('The format of the phone number must match a Portuguese phone.');
        $fake = $this->l('The format of the phone number is incorrect.');
        $fake = $this->l('Refused payment for order %s');
        $fake = $this->l('Hash Algorithm for %s was already set with %s');
        $fake = $this->l('Hash Algorithm for %s has been syncrhonize with %s');
        $fake = $this->l('Hash Algorithm for %s has not been updated : You must filled credentials.');
        $fake = $this->l('The HiPay transaction was not canceled because no transaction reference exists. You can see and cancel the transaction directly from HiPay\'s BackOffice');
        $fake = $this->l('The HiPay transaction was not canceled because it\'s status doesn\'t allow cancellation. You can see and cancel the transaction directly from HiPay\'s BackOffice');
        $fake = $this->l('There was an error on the cancellation of the HiPay transaction. You can see and cancel the transaction directly from HiPay\'s BackOffice');
        $fake = $this->l('Message was : ');
        $fake = $this->l('Transaction cancellation requested');
    }

    public function getLogs()
    {
        return $this->logs;
    }

    public function getLocalPath()
    {
        return $this->local_path;
    }

    public function getPath()
    {
        return $this->_path;
    }

    /**
     * Functions installation HiPay module or uninstall
     */
    public function install()
    {
        if (extension_loaded('soap') == false) {
            $this->_errors[] = $this->l('You have to enable the SOAP extension on your server to install this module');
            return false;
        }
        return parent::install() && $this->installHipay();
    }

    public function uninstall()
    {
        return $this->uninstallAdminTab() &&
        parent::uninstall() &&
        HipayHelper::clearAccountData() &&
        $this->deleteHipayTable();
    }

    /**
     * Installation procedure for the HiPay module
     * @return bool
     * @throws PrestaShopDatabaseException
     * @throws PrestaShopException
     */
    public function installHipay()
    {
        $return = $this->installAdminTab();
        $return &= HipayOrderStatus::updateHiPayOrderStates($this);
        $return &= $this->createHipayTable();
        $return &= $this->registerHook('backOfficeHeader');
        $return &= $this->registerHook('displayAdminOrder');
        $return &= $this->registerHook('customerAccount');
        $return &= $this->registerHook('updateCarrier');
        $return &= $this->registerHook('actionAdminDeleteBefore');
        $return &= $this->registerHook('actionAdminBulKDeleteBefore');
        $return &= $this->registerHook('dashboardZoneOne');
        $return &= $this->registerHook('actionOrderStatusUpdate');
        if (_PS_VERSION_ >= '1.7') {
            $return17 = $this->registerHook('paymentOptions') &&
            $this->registerHook('header') &&
            $this->registerHook('actionFrontControllerSetMedia');
            $return = $return && $return17;
        } elseif (_PS_VERSION_ < '1.7' && _PS_VERSION_ >= '1.6') {
            $return16 = $this->registerHook('payment') &&
            $this->registerHook('paymentReturn') &&
            $this->registerHook('displayPaymentEU');
            $return = $return && $return16;
        }

        Configuration::updateValue('HIPAY_NOTIFICATION_THRESHOLD', 4);

        return $return && $this->installHook();
    }

    public function installHook()
    {
        $hook = new Hook();
        $hook->name = 'actionHipayApiRequest';
        $hook->title = 'HiPay API Request';
        $hook->description = 'This hook is called right before HiPay calls its payment API';
        return $hook->add();
    }

    public function installAdminTab()
    {
        $class_names = [
            'AdminHiPayCapture',
            'AdminHiPayRefund',
            'AdminHiPayMoto',
            'AdminHiPayChallenge',
            'AdminHiPayConfig',
            'AdminHiPaySynchronizeHashing',
            'AdminHiPayCalculatePrice',
        ];
        return $this->createTabAdmin($class_names);
    }

    protected function createTabAdmin($class_names)
    {
        foreach ($class_names as $class_name) {
            $tab = new Tab();
            $tab->active = 1;
            $tab->module = $this->name;
            $tab->class_name = $class_name;
            $tab->id_parent = -1;
            foreach (Language::getLanguages(true) as $lang) {
                $tab->name[$lang['id_lang']] = $this->name;
            }
            if (!$tab->add()) {
                //    return false;
            }
        }
        return true;
    }

    public function uninstallAdminTab()
    {
        $class_names = [
            'AdminHiPayCapture',
            'AdminHiPayRefund',
            'AdminHiPayMoto',
            'AdminHiPayChallenge',
            'AdminHiPayConfig',
            'AdminHiPaySynchronizeHashing',
            'AdminHiPayCalculatePrice',
        ];
        foreach ($class_names as $class_name) {
            $id_tab = (int) Tab::getIdFromClassName($class_name);
            if ($id_tab) {
                $tab = new Tab($id_tab);
                if (!$tab->delete()) {
                    return false;
                }
            }
        }
        return true;
    }

    /**
     * Changing order status
     *
     * @param array $params
     */
    public function hookActionOrderStatusUpdate($params)
    {
        /**
         * @var OrderState $newOrderStatus
         */
        $newOrderStatus = $params['newOrderStatus'];
        $idOrder = $params['id_order'];
        $order = new OrderCore($idOrder);

        if ($newOrderStatus->id == Configuration::get('PS_OS_CANCELED')) {
            $maintenaceDBHelper = new HipayDBMaintenance($this);
            try {
                $transactionId = $maintenaceDBHelper->getTransactionReference($idOrder);
            } catch (PrestaShopDatabaseException $e) {
                $transactionId = '';
            }

            $apiHandler = new Apihandler($this, $this->context);
            $cancelResult = $apiHandler->handleCancel(
                [
                    'order' => $idOrder,
                    'transaction_reference' => $transactionId,
                    'operation' => \HiPay\Fullservice\Enum\Transaction\Operation::CANCEL,
                ]
            );
        }
    }

    /**
     * Delete customer.
     *
     * @param $value
     */
    public function hookActionAdminDeleteBefore()
    {
        if (Tools::getValue('id_customer')) {
            $this->token->deleteAllToken(Tools::getValue('id_customer'));
        }
    }

    /**
     * Bulk customer delete.
     *
     * @param $value
     */
    public function hookActionAdminBulKDeleteBefore()
    {
        if (Tools::getValue('customerBox')) {
            foreach (Tools::getValue('customerBox') as $customerId) {
                $this->token->deleteAllToken($customerId);
            }
        }
    }

    public function hookUpdateCarrier($params)
    {
        $this->logs->logInfos('# HookUpdateCarrier' . $params['id_carrier']);
        $idCarrierOld = (int) ($params['id_carrier']);
        $idCarrierNew = (int) ($params['carrier']->id);

        $this->mapper->updateCarrier($idCarrierOld, $idCarrierNew);
    }

    public function hookCustomerAccount()
    {
        if ($this->hipayConfigTool->getPaymentGlobal()['card_token']) {
            $this->smarty->assign(
                [
                    'link' => $this->context->link->getModuleLink($this->name, 'userToken', [], true),
                ]
            );
            if (_PS_VERSION_ >= '1.7') {
                $path = 'views/templates/hook/ps17/my-account-17.tpl';
            } else {
                $path = 'views/templates/hook/ps16/my-account-16.tpl';
            }

            return $this->display(dirname(__FILE__), $path);
        }
    }

    public function hookActionFrontControllerSetMedia($params)
    {
        $hipay17 = new HipayEnterpriseNew();
        return $hipay17->hipayActionFrontControllerSetMedia($params);
    }

    public function hookBackOfficeHeader()
    {
        $this->context->controller->addCSS(($this->_path) . 'views/css/bootstrap-duallistbox.min.css', 'all');
        $this->context->controller->addCSS(($this->_path) . 'views/css/bootstrap-multiselect.css', 'all');
        $this->context->controller->addCSS($this->_path . 'views/css/back.css', 'all');

        $this->context->controller->addJS($this->_path . '/views/js/form-input-control.js', 'all');
    }

    /**
     * Handling prestashop hook payment. Adding payment methods (PS16)
     *
     * @param type $params
     * @return type
     */
    public function hookPayment($params)
    {
        $idAddress = $params['cart']->id_address_invoice ? $params['cart']->id_address_invoice : $params['cart']->id_address_delivery;
        $address = new Address((int) $idAddress);
        $country = new Country((int) $address->id_country);
        $currency = new Currency((int) $params['cart']->id_currency);
        $orderTotal = $params['cart']->getOrderTotal();
        $this->context->controller->addJS([_MODULE_DIR_ . 'hipay_enterprise/views/js/devicefingerprint.js']);
        $customer = new Customer((int) $params['cart']->id_customer);

        $this->smarty->assign(
            [
                'domain' => Tools::getShopDomainSSL(true),
                'module_dir' => $this->_path,
                'payment_button' => $this->_path . 'views/img/cc.png',
                'configHipay' => $this->hipayConfigTool->getConfigHipay(),
                'sortedPaymentProducts' => HipayHelper::getSortedActivatedPaymentByCountryAndCurrency(
                    $this,
                    $this->hipayConfigTool->getConfigHipay(),
                    $country,
                    $currency,
                    $orderTotal,
                    $address,
                    $customer
                ),
                'lang' => Tools::strtolower($this->context->language->iso_code),
            ]
        );
        $this->smarty->assign('hipay_prod', !(bool) $this->hipayConfigTool->getAccountGlobal()['sandbox_mode']);

        return $this->display(dirname(__FILE__), 'views/templates/hook/ps16/payment-16.tpl');
    }

    /**
     *  Adding payment methods (PS16)
     *
     * @param $params
     * @return array
     */
    public function hookDisplayPaymentEU($params)
    {
        $idAddress = $params['cart']->id_address_invoice ? $params['cart']->id_address_invoice :
        $params['cart']->id_address_delivery;
        $address = new Address((int) $idAddress);
        $country = new Country((int) $address->id_country);
        $currency = new Currency((int) $params['cart']->id_currency);
        $orderTotal = $params['cart']->getOrderTotal();

        $paymentOptions = [];

        $sortedPaymentProducts = HipayHelper::getSortedActivatedPaymentByCountryAndCurrency(
            $this,
            $this->hipayConfigTool->getConfigHipay(),
            $country,
            $currency,
            $orderTotal
        );

        if (!empty($sortedPaymentProducts)) {
            foreach ($sortedPaymentProducts as $name => $paymentProduct) {
                if ($name == 'credit_card') {
                    $paymentOptions[] =
                        [
                        'cta_text' => $this->l('Pay by credit card'),
                        'logo' => Media::getMediaPath($this->_path . 'views/img/amexa200.png'),
                        'action' => $this->context->link->getModuleLink($this->name, 'redirect', [], true),
                        ];
                } else {
                    $paymentOptions[] =
                        [
                        'cta_text' => $this->l('Pay by') . ' ' . $paymentProduct['displayName'],
                        'logo' => Media::getMediaPath($paymentProduct['payment_button']),
                        'action' => $paymentProduct['link'],
                        ];
                }
            }
        }
        return $paymentOptions;
    }

    /**
     * Displays notification block in main admin dashboard
     * @param $params
     * @return mixed
     */
    public function hookDashboardZoneOne($params)
    {
        return $this->hipayUpdateNotif->displayBlock();
    }

    /**
     * Handling prestashop payment hook. Adding payment methods (PS17)
     * @param type $params
     * @return type
     */
    public function hookPaymentOptions($params)
    {
        $hipay17 = new HipayEnterpriseNew();
        // Fix Bug with translation and bad context ( Hook in an another file)
        $params['translation_checkout'] = $this->l('You will be redirected to an external payment page. Please do not refresh the page during the process');

        return $hipay17->hipayPaymentOptions($params);
    }

    /**
     *
     * @param type $params
     * @return type
     */
    public function hookPaymentReturn($params)
    {

        if (_PS_VERSION_ < '1.7' && _PS_VERSION_ >= '1.6') {
            $this->hipayPaymentReturn($params);
            return $this->display(dirname(__FILE__), 'views/templates/hook/paymentReturn.tpl');
        }
    }

    /**
     *
     * @param type $params
     * @return type
     */
    private function hipayPaymentReturn($params)
    {
        // Payment Return for PS1.6
        if ($this->active == false) {
            return;
        }
        $order = $params['objOrder'];
        if ($order->getCurrentOrderState()->id != Configuration::get('PS_OS_ERROR')) {
            $this->smarty->assign('status', 'ok');
        }
        $this->smarty->assign(
            [
                'id_order' => $order->id,
                'reference' => $order->reference,
                'params' => $params,
                'total_to_pay' => Tools::displayPrice($params['total_to_pay'], $params['currencyObj'], false),
                'shop_name' => $this->context->shop->name,
            ]
        );
    }

    /**
     * Display refund and capture blocks in order admin page
     */
    public function hookDisplayAdminOrder()
    {
        $hipayMaintenanceBlock = new HipayMaintenanceBlock($this, (int) Tools::getValue('id_order'));
        return $hipayMaintenanceBlock->displayBlock();
    }

    /**
     * Load configuration page
     * @return string
     */
    public function getContent()
    {
        $this->postProcess();

        $formGenerator = new HipayForm($this);

        $configuration = $this->local_path . 'views/templates/admin/configuration.tpl';

        $psCategories = $this->mapper->getPrestashopCategories();
        $hipayCategories = $this->mapper->getHipayCategories();
        $psCarriers = $this->mapper->getPrestashopCarriers();
        $hipayCarriers = $this->mapper->getHipayCarriers();
        $mappedCategories = $this->mapper->getMappedCategories($this->context->shop->id);
        $mappedCarriers = $this->mapper->getMappedCarriers($this->context->shop->id);

        $source = ['brand_version' => _PS_VERSION_, 'integration_version' => $this->version];

        if (!Configuration::get('PS_SSL_ENABLED')) {
            $this->_technicalErrors = $this->l('A SSL certificate is required to process credit card payments using HiPay. Please consult the FAQ.');
        }

        $this->context->smarty->assign(
            [
                'module_dir' => $this->_path,
                'config_hipay' => $this->hipayConfigTool->getConfigHipay(),
                'logs' => $this->getLogs()->getLogFiles(),
                'module_url' => AdminController::$currentIndex .
                '&configure=' .
                $this->name .
                '&token=' .
                Tools::getAdminTokenLite('AdminModules'),
                'fraud_form' => $formGenerator->getFraudForm(),
                'form_errors' => $this->_errors,
                'form_successes' => $this->_successes,
                'technicalErrors' => $this->_technicalErrors,
                'limitedCurrencies' => $this->currencies_titles,
                'default_currency' => Configuration::get('PS_SHOP_DEFAULT'),
                'limitedCountries' => $this->countries_titles,
                'this_callback' => $this->context->link->getModuleLink(
                    $this->name,
                    'notify',
                    [],
                    true,
                    null,
                    (int) Configuration::get('PS_SHOP_DEFAULT')
                ),
                'ipaddr' => $_SERVER['REMOTE_ADDR'],
                'psCategories' => $psCategories,
                'hipayCategories' => $hipayCategories,
                'mappedCategories' => $mappedCategories,
                'psCarriers' => $psCarriers,
                'hipayCarriers' => $hipayCarriers,
                'mappedCarriers' => $mappedCarriers,
                'lang' => Tools::strtolower($this->context->language->iso_code),
                'languages' => Language::getLanguages(false),
                'source' => $source,
                'ps_round_total' => Configuration::get('PS_ROUND_TYPE') == Order::ROUND_TOTAL,
                'ajax_url' => $this->context->link->getAdminLink('AdminModules'),
                'url_site' => Tools::getHttpHost(true) . __PS_BASE_URI__,
                'syncLink' => $this->context->link->getAdminLink('AdminHiPaySynchronizeHashing'),
                'syncToken' => Tools::getAdminTokenLite('AdminHiPaySynchronizeHashing'),
                'updateNotif' => $this->hipayUpdateNotif,
            ]
        );

        return $this->context->smarty->fetch($configuration);
    }

    /**
     * Process HTTP request send by module confguration page
     */
    protected function postProcess()
    {
        //==================================//
        //===         LOG VIEW           ===//
        //==================================//
        if (Tools::isSubmit('logfile')) {
            $logFile = Tools::getValue('logfile');
            $this->logs->displayLogFile($logFile);
            //==================================//
            //===         ACCOUNT VIEW       ===//
            //==================================//
        } elseif (Tools::isSubmit('submitAccount')) {
            $this->logs->logInfos('# submitAccount');

            $this->hipayConfigFormHandler->saveAccountInformations();

            $this->context->smarty->assign(
                'active_tab',
                'account_form'
            );
            //==================================//
            //===   GLOBAL PAYMENT METHODS   ===//
            //==================================//
        } elseif (Tools::isSubmit('submitGlobalPaymentMethods')) {
            $this->logs->logInfos('# submitGlobalPaymentMethods');
            $this->hipayConfigFormHandler->saveGlobalPaymentInformations();
            $this->context->smarty->assign(
                'active_tab',
                'payment_form'
            );
        } elseif (Tools::isSubmit('creditCardSubmit')) {
            $this->logs->logInfos('# creditCardSubmit');
            $this->hipayConfigFormHandler->saveCreditCardInformations($this->context);
            $this->context->smarty->assign(
                'active_tab',
                'payment_form'
            );
        } elseif (Tools::isSubmit('localPaymentSubmit')) {
            $this->logs->logInfos('# localPaymentSubmit');
            $this->hipayConfigFormHandler->saveLocalPaymentInformations($this->context);
            $this->context->smarty->assign(
                'active_tab',
                'payment_form'
            );
        } elseif (Tools::isSubmit('fraudSubmit')) {
            $this->logs->logInfos('# fraudSubmit');
            $this->hipayConfigFormHandler->saveFraudInformations();
            $this->context->smarty->assign(
                'active_tab',
                'fraud_form'
            );
        } elseif (Tools::isSubmit('submitCategoryMapping')) {
            $this->logs->logInfos('# submitCategoryMapping');
            $this->hipayConfigFormHandler->saveCategoryMappingInformations();
            $this->context->smarty->assign(
                'active_tab',
                'category_form'
            );
        } elseif (Tools::isSubmit('submitCarrierMapping')) {
            $this->logs->logInfos('# submitCarrierMapping');
            $this->hipayConfigFormHandler->saveCarrierMappingInformations();
            $this->context->smarty->assign(
                'active_tab',
                'carrier_form'
            );
        }
    }

    /**
     *
     */
    private function createHipayTable()
    {
        $this->mapper->createTable();
        $this->dbSchemaManager->createOrderRefundCaptureTable();
        $this->dbSchemaManager->createCCTokenTable();
        $this->dbSchemaManager->createHipayTransactionTable();
        $this->dbSchemaManager->createHipayOrderCaptureType();
        $this->dbSchemaManager->createHipayNotificationTable();
        return true;
    }

    /**
     *
     */
    private function deleteHipayTable()
    {
        $this->mapper->deleteTable();
        $this->dbSchemaManager->deleteCCTokenTable();
        $this->dbSchemaManager->deleteHipayNotificationTable();
        return true;
    }
}

if (_PS_VERSION_ >= '1.7') {
    // version 1.7
    require_once(dirname(__FILE__) . '/hipay_enterprise-17.php');
} elseif (_PS_VERSION_ < '1.6') {
    // Version < 1.6
    Tools::displayError('The module HiPay Enterprise is not compatible with your PrestaShop');
}

require_once(dirname(__FILE__) . '/classes/helper/HipayLogs.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayConfig.php');
require_once(dirname(__FILE__) . '/classes/forms/HipayForm.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayMapper.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayHelper.php');
require_once(dirname(__FILE__) . '/classes/helper/dbquery/HipayDBSchemaManager.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayCCToken.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayOrderStatus.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayFormControl.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayConfigFormHandler.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayMaintenanceBlock.php');
require_once(dirname(__FILE__) . '/classes/helper/HipayUpdateNotif.php');