blockonomics.php

<?php
/**
 * 2011-2023 Blockonomics
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Academic Free License (AFL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/afl-3.0.php
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@blockonomics.co so we can send you a copy immediately.
 *
 * @author    Blockonomics Admin <admin@blockonomics.co>
 * @copyright 2011-2023 Blockonomics
 * @license   http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
 * International Registered Trademark & Property of Blockonomics
 */
if (!defined('_PS_VERSION_') or !defined('_CAN_LOAD_FILES_')) {
    exit;
}

class Blockonomics extends PaymentModule
{
    private $_html = '';
    private $_postErrors = [];

    public function __construct()
    {
        $this->name = 'blockonomics';
        $this->tab = 'payments_gateways';
        $this->version = '1.6.7';
        $this->author = 'Blockonomics';
        $this->need_instance = 1;
        $this->bootstrap = true;
        $this->ps_versions_compliancy = [
            'min' => '1.6',
            'max' => '1.6.1.24',
        ];
        $this->display_column_left = false;
        $this->module_key = '454392b952b7d0cfc55a656b3cdebb12';

        parent::__construct();

        $this->displayName = $this->l('Bitcoin - Blockonomics');
        $this->description = $this->l('Module for accepting payments by bitcoin');
        $this->confirmUninstall = $this->l('Are you sure you want to uninstall?');

        // Include configuration from the local file.
        $BLOCKONOMICS_BASE_URL = 'https://www.blockonomics.co';
        $BLOCKONOMICS_WEBSOCKET_URL = 'wss://www.blockonomics.co';
        $BLOCKONOMICS_NEW_ADDRESS_URL = $BLOCKONOMICS_BASE_URL . '/api/new_address';
        $BLOCKONOMICS_PRICE_URL = $BLOCKONOMICS_BASE_URL . '/api/price?currency=';
        $BLOCKONOMICS_GET_CALLBACKS_URL = $BLOCKONOMICS_BASE_URL . '/api/address?&no_balance=true&only_xpub=true&get_callback=true';
        $BLOCKONOMICS_SET_CALLBACK_URL = $BLOCKONOMICS_BASE_URL . '/api/update_callback';

        Configuration::updateValue('BLOCKONOMICS_BASE_URL', $BLOCKONOMICS_BASE_URL);
        Configuration::updateValue('BLOCKONOMICS_PRICE_URL', $BLOCKONOMICS_PRICE_URL);
        Configuration::updateValue('BLOCKONOMICS_NEW_ADDRESS_URL', $BLOCKONOMICS_NEW_ADDRESS_URL);
        Configuration::updateValue('BLOCKONOMICS_WEBSOCKET_URL', $BLOCKONOMICS_WEBSOCKET_URL);
        Configuration::updateValue('BLOCKONOMICS_GET_CALLBACKS_URL', $BLOCKONOMICS_GET_CALLBACKS_URL);
        Configuration::updateValue('BLOCKONOMICS_SET_CALLBACK_URL', $BLOCKONOMICS_SET_CALLBACK_URL);

        if (!Configuration::get('BLOCKONOMICS_API_KEY')) {
            $this->warning = $this->l('API Key is not provided to communicate with Blockonomics');
        }
    }

    public function install()
    {
        if (!parent::install()
            or !$this->installOrder('BLOCKONOMICS_ORDER_STATE_WAIT', 'Awaiting Bitcoin Payment', null)
            or !$this->installOrder('BLOCKONOMICS_ORDER_STATUS_0', 'Waiting for 2 Confirmations', null)
            or !$this->installOrder('BLOCKONOMICS_ORDER_STATUS_2', 'Bitcoin Payment Confirmed', null)
            or !$this->installDB()
            or !$this->registerHook('payment')
            or !$this->registerHook('paymentReturn')
            or !$this->registerHook('displayPDFInvoice')
            or !$this->registerHook('invoice')
        ) {
            return false;
        }

        $this->active = true;

        return true;
    }

    public function uninstall()
    {
        if (!parent::uninstall()
            or !$this->uninstallOrder('BLOCKONOMICS_ORDER_STATE_WAIT')
            or !$this->uninstallOrder('BLOCKONOMICS_ORDER_STATUS_0')
            or !$this->uninstallOrder('BLOCKONOMICS_ORDER_STATUS_2')
            or !$this->uninstallDB()
        ) {
            return false;
        }

        return true;
    }

    public function installOrder($key, $title, $template)
    {
        // Already existing from previous install(ignore)
        if (Configuration::get($key) > 0) {
            return true;
        }
        $orderState = new OrderState();
        $orderState->name = array_fill(0, 10, $title);
        $orderState->color = '#add8e6';
        $orderState->send_email = isset($template);
        $orderState->template = array_fill(0, 10, $template);
        $orderState->hidden = false;
        $orderState->delivery = false;
        $orderState->logable = false;
        $orderState->invoice = false;

        if (!$orderState->add()) {
            return false;
        }

        Configuration::updateValue($key, (int) $orderState->id);

        return true;
    }

    public function uninstallOrder($key)
    {
        $orderState = new OrderState();
        $orderState->id = (int) Configuration::get($key);
        $orderState->delete();
        Configuration::deleteByName($key);

        return true;
    }

    public function installDB()
    {
        Db::getInstance()->Execute(
            'CREATE TABLE IF NOT EXISTS ' . _DB_PREFIX_ . 'blockonomics_bitcoin_orders (
            id INT UNSIGNED NOT NULL AUTO_INCREMENT,
            id_order INT UNSIGNED NOT NULL,
            timestamp INT(8) NOT NULL,
            addr varchar(255) NOT NULL,
            txid varchar(255) NOT NULL,
            status int(8) NOT NULL,
            value double(10,2) NOT NULL,
            bits int(8) NOT NULL,
            bits_payed int(8) NOT NULL,
            id_cart INT UNSIGNED NOT NULL,
            PRIMARY KEY (id),
        UNIQUE KEY order_table (addr))'
        );

        // Blockonimcs basic configuration
        Configuration::updateValue('BLOCKONOMICS_API_KEY', '');

        // Generate callback secret
        $secret = md5(uniqid(rand(), true));
        Configuration::updateValue('BLOCKONOMICS_CALLBACK_SECRET', $secret);
        Configuration::updateValue('BLOCKONOMICS_CALLBACK_URL', Tools::getHttpHost(true, true) . __PS_BASE_URI__ . 'modules/' . $this->name . '/callback.php?secret=' . $secret);

        return true;
    }

    public function uninstallDB()
    {
        Db::getInstance()->Execute('DROP TABLE IF EXISTS `' . _DB_PREFIX_ . 'blockonomics_bitcoin_orders`;');
        Configuration::deleteByName('BLOCKONOMICS_API_KEY');
        Configuration::deleteByName('BLOCKONOMICS_CALLBACK_SECRET');
        Configuration::deleteByName('BLOCKONOMICS_CALLBACK_URL');

        Configuration::deleteByName('BLOCKONOMICS_BASE_URL');
        Configuration::deleteByName('BLOCKONOMICS_PRICE_URL');
        Configuration::deleteByName('BLOCKONOMICS_NEW_ADDRESS_URL');
        Configuration::deleteByName('BLOCKONOMICS_WEBSOCKET_URL');
        Configuration::deleteByName('BLOCKONOMICS_GET_CALLBACKS_URL');
        Configuration::deleteByName('BLOCKONOMICS_SET_CALLBACK_URL');

        return true;
    }

    public function hookPaymentReturn($params)
    {
        return $this->display(__FILE__, 'payment-return.tpl');
    }

    // Display payment
    public function hookPayment($params)
    {
        if (!$this->active) {
            return;
        }

        if (!$this->checkCurrency($params['cart'])) {
            return;
        }

        $this->smarty->assign(
            [
            'this_path' => $this->_path,
            'this_path_ssl' => Tools::getHttpHost(true, true) . __PS_BASE_URI__ . 'modules/' . $this->name . '/',
            'this_path_ssl_validation' => $this->context->link->getModuleLink($this->name, 'validation', [], true),
            ]
        );

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

    public function getBTCPrice($id_currency)
    {
        // Getting price
        $currency = new Currency((int) $id_currency);
        $options = ['http' => ['method' => 'GET']];
        $context = stream_context_create($options);
        $contents = Tools::file_get_contents(Configuration::get('BLOCKONOMICS_PRICE_URL') . $currency->iso_code, false, $context);
        $priceObj = Tools::jsonDecode($contents);

        return $priceObj->price;
    }

    public function getNewAddress()
    {
        $url = Configuration::get('BLOCKONOMICS_NEW_ADDRESS_URL') . '?match_callback=' . Configuration::get('BLOCKONOMICS_CALLBACK_SECRET');

        return $this->doCurlCall($url, 'dummy');
    }

    public function doCurlCall($url, $post_content = '')
    {
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        if ($post_content) {
            curl_setopt($ch, CURLOPT_POST, 1);
            curl_setopt($ch, CURLOPT_POSTFIELDS, $post_content);
        }
        curl_setopt($ch, CURLOPT_TIMEOUT, 60);
        curl_setopt($ch, CURLOPT_HTTPHEADER, [
            'Authorization: Bearer ' . Configuration::get('BLOCKONOMICS_API_KEY'),
            'Content-type: application/x-www-form-urlencoded',
          ]);

        $data = curl_exec($ch);
        $httpcode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        curl_close($ch);

        $responseObj = new stdClass();
        $responseObj->data = Tools::jsonDecode($data);
        $responseObj->response_code = $httpcode;

        return $responseObj;
    }

    public function testSetup()
    {
        $error_str = '';
        $url = Configuration::get('BLOCKONOMICS_GET_CALLBACKS_URL');
        $response = $this->doCurlCall($url);

        $callback_url = Configuration::get('BLOCKONOMICS_CALLBACK_URL');

        // TODO: Check This: WE should actually check code for timeout
        if (!isset($response->response_code)) {
            $error_str = $this->l('Your server is blocking outgoing HTTPS calls');
        } elseif ($response->response_code == 401) {
            $error_str = $this->l('API Key is incorrect');
        } elseif ($response->response_code != 200) {
            $error_str = $response->data;
        } elseif (!isset($response->data) || count($response->data) == 0) {
            $error_str = $this->l('You have not entered an xpub');
        } elseif (count($response->data) == 1) {
            if (!$response->data[0]->callback || $response->data[0]->callback == null) {
                // No callback URL set, set one
                $post_content = '{"callback": "' . $callback_url . '", "xpub": "' . $response->data[0]->address . '"}';
                $set_callback_url = Configuration::get('BLOCKONOMICS_SET_CALLBACK_URL');
                $this->doCurlCall($set_callback_url, $post_content);
            } elseif ($response->data[0]->callback != $callback_url) {
                // Check if only secret differs
                $base_url = Tools::getHttpHost(true, true) . __PS_BASE_URI__ . 'modules/' . $this->name . '/callback.php';
                if (strpos($response->data[0]->callback, $base_url) !== false) {
                    // Looks like the user regenrated callback by mistake
                    // Just force Update_callback on server
                    $post_content = '{"callback": "' . $callback_url . '", "xpub": "' . $response->data[0]->address . '"}';
                    $set_callback_url = Configuration::get('BLOCKONOMICS_SET_CALLBACK_URL');
                    $this->doCurlCall($set_callback_url, $post_content);
                } else {
                    $error_str = $this->l('Your have an existing callback URL. Refer instructions on integrating multiple websites');
                }
            }
        } else {
            // Check if callback url is set
            foreach ($response->data as $resObj) {
                if ($resObj->callback == $callback_url) {
                    return '';
                }
            }
            $error_str = $this->l('Your have an existing callback URL. Refer instructions on integrating multiple websites');
        }

        return $error_str;
    }

    public function getContext()
    {
        return $this->context;
    }

    public function checkCurrency($cart)
    {
        $currency_order = new Currency((int) $cart->id_currency);
        $currencies_module = $this->getCurrency((int) $cart->id_currency);

        if (is_array($currencies_module)) {
            foreach ($currencies_module as $currency_module) {
                if ($currency_order->id == $currency_module['id_currency']) {
                    return true;
                }
            }
        }
    }

    // Add Bitcoin invoice to pdf invoice
    public function hookDisplayPDFInvoice($params)
    {
        if (!$this->active) {
            return;
        }

        $b_order = Db::getInstance()->ExecuteS('SELECT * FROM ' . _DB_PREFIX_ . 'blockonomics_bitcoin_orders WHERE `id_order` = ' . (int) $params['object']->id_order . '  LIMIT 1');

        if ($b_order) {
            $this->smarty->assign(
                [
                'status' => (int) $b_order[0]['status'],
                'addr' => $b_order[0]['addr'],
                'txid' => $b_order[0]['txid'],
                'base_url' => Configuration::get('BLOCKONOMICS_BASE_URL'),
                'bits_payed' => $b_order[0]['bits_payed'],
                ]
            );

            return $this->display(__FILE__, 'views/templates/hook/invoice_pdf.tpl');
        }
    }

    // Display Invoice
    public function hookInvoice($params)
    {
        $b_order = Db::getInstance()->ExecuteS('SELECT * FROM ' . _DB_PREFIX_ . 'blockonomics_bitcoin_orders WHERE `id_order` = ' . (int) $params['id_order'] . '  LIMIT 1');

        /*
        print_r($b_order);
        */

        if ($b_order) {
            $tx_status = (int) $b_order[0]['status'];

            if ($tx_status == -1) {
                $status = 'Payment Not Received.';
            } elseif ($tx_status == 0 || $tx_status == 1) {
                $status = 'Waiting for 2 Confirmations.';
            } else {
                $status = 'Payment Confirmed.';
            }
            $this->smarty->assign(
                [
                'status' => $status,
                'addr' => $b_order[0]['addr'],
                'txid' => $b_order[0]['txid'],
                'bits' => $b_order[0]['bits'],
                'base_url' => Configuration::get('BLOCKONOMICS_BASE_URL'),
                'bits_payed' => $b_order[0]['bits_payed'],
                ]
            );

            return $this->display(__FILE__, 'views/templates/hook/invoice.tpl');
        }
    }

    public function getContent()
    {
        $output = '';
        if (Tools::isSubmit('testSetup')) {
            // Save current settings before testing setup
            Configuration::updateValue('BLOCKONOMICS_API_KEY', Tools::getValue('BLOCKONOMICS_API_KEY'));
            $error_str = $this->testSetup();
            if ($error_str) {
                $error_str = $error_str . '</br>' . $this->l('For more information please consult this ') . "<a target='_blank' href='https://blockonomics.freshdesk.com/solution/articles/33000215104-troubleshooting-unable-to-generate-new-address'>" . $this->l('troubleshooting article') . '</a>';
                $output = $this->displayError($error_str);
            } else {
                $output = $this->displayConfirmation($this->l('Setup is all done!'));
            }
        } elseif (Tools::isSubmit('updateSettings')) {
            Configuration::updateValue('BLOCKONOMICS_API_KEY', Tools::getValue('BLOCKONOMICS_API_KEY'));
            $output = $this->displayConfirmation($this->l('Settings Saved, click on Test Setup to verify installation'));
        } elseif (Tools::isSubmit('generateNewURL')) {
            $this->generatenewCallback();
        }

        if (!Configuration::get('BLOCKONOMICS_API_KEY')) {
            $output = $output . $this->display(__FILE__, 'views/templates/admin/backend.tpl');
        }

        return $output . $this->displayForm();
    }

    public function displayForm()
    {
        // Get default language
        $default_lang = (int) Configuration::get('PS_LANG_DEFAULT');

        // Init Fields form array
        $fields_form[0]['form'] = [
          'legend' => [
            'title' => $this->l('Settings'),
          ],
          'input' => [
            [
              'type' => 'text',
              'label' => $this->l('API Key'),
              'name' => 'BLOCKONOMICS_API_KEY',
              'size' => 10,
              'required' => true,
            ],
                      [
              'type' => 'text',
              'label' => $this->l('HTTP CALLBACK URL'),
              'name' => 'callbackURL',
              'disabled' => 'disabled',
                      ], ],
          'submit' => [
            'title' => $this->l('Save'),
            'name' => 'updateSettings',
            'class' => 'btn btn-default pull-right',
          ],
          'buttons' => [
            'test-setup' => [
                'title' => $this->l('Test Setup'),
                'name' => $this->l('testSetup'),
                'type' => 'submit',
                'class' => 'btn btn-default pull-right',
                'icon' => 'process-icon-save',
                ],
            ],
        ];
        $helper = new HelperForm();

        // Module, token and currentIndex
        $helper->module = $this;
        $helper->name_controller = $this->name;
        $helper->token = Tools::getAdminTokenLite('AdminModules');
        $helper->currentIndex = AdminController::$currentIndex . '&configure=' . $this->name;

        // Language
        $helper->default_form_language = $default_lang;
        $helper->allow_employee_form_lang = $default_lang;

        // Title and toolbar
        $helper->title = $this->displayName;
        $helper->show_toolbar = true;        // false -> remove toolbar
        $helper->toolbar_scroll = true;      // yes - > Toolbar is always visible on the top of the screen.
        $helper->submit_action = 'submit' . $this->name;
        $helper->toolbar_btn = [
          'save' => [
            'desc' => $this->l('Save'),
            'href' => AdminController::$currentIndex . '&configure=' . $this->name . '&save' . $this->name .
            '&token=' . Tools::getAdminTokenLite('AdminModules'),
            ],
            'back' => [
              'href' => AdminController::$currentIndex . '&token=' . Tools::getAdminTokenLite('AdminModules'),
              'desc' => $this->l('Back to list'),
            ],
          ];

        // Load current value
        $helper->fields_value['BLOCKONOMICS_API_KEY'] = Configuration::get('BLOCKONOMICS_API_KEY');
        $callbackurl = Configuration::get('BLOCKONOMICS_CALLBACK_URL');
        if (!$callbackurl) {
            $this->generatenewCallback();
            $callbackurl = Configuration::get('BLOCKONOMICS_CALLBACK_URL');
        }
        $helper->fields_value['callbackURL'] = $callbackurl;

        return $helper->generateForm($fields_form);
    }

    public function generatenewCallback()
    {
        $secret = md5(uniqid(rand(), true));
        Configuration::updateValue('BLOCKONOMICS_CALLBACK_SECRET', $secret);
        Configuration::updateValue('BLOCKONOMICS_CALLBACK_URL', Tools::getHttpHost(true, true) . __PS_BASE_URI__ . 'modules/' . $this->name . '/callback.php?secret=' . $secret);
    }
}