New module (BulkGate SMS)

.docker/Dockerfile

@@ -0,0 +1,57 @@
+FROM php:8.2-apache
+ARG XDEBUG_VERSION=3.4.0
+ARG OC_VERSION=4.1.0.0
+
+LABEL org.opencontainers.image.source=https://github.com/bulkgate/cartsms
+LABEL opencart_version=${OC_VERSION}
+
+ENV OC_VERSION=${OC_VERSION}
+
+RUN echo "Opencart  version: ${OC_VERSION}"
+
+WORKDIR /tmp
+
+RUN curl -fL "https://github.com/opencart/opencart/archive/refs/tags/${OC_VERSION}.tar.gz" -o opencart.tar.gz && \
+    curl -sS https://raw.githubusercontent.com/composer/getcomposer.org/f3108f64b4e1c1ce6eb462b159956461592b3e3e/web/installer | php && \
+    mv composer.phar /usr/local/bin/composer
+
+RUN tar -xzf opencart.tar.gz
+
+RUN rm opencart.tar.gz
+
+USER www-data:www-data
+
+RUN cp -r opencart-*/upload/* /var/www/html
+
+WORKDIR /var/www/html
+
+RUN cp config-dist.php config.php && \
+    cp admin/config-dist.php admin/config.php
+
+USER root
+
+VOLUME /var/www/html
+
+RUN apt-get update \
+  && apt-get install -y \
+             wait-for-it \
+             unzip \
+             libicu-dev \
+             libfreetype6-dev \
+             libjpeg62-turbo-dev \
+             libpng-dev \
+             libzip-dev \
+             libcurl3-dev \
+             libwebp-dev \
+  && pecl install xdebug-${XDEBUG_VERSION} \
+  && docker-php-ext-enable xdebug \
+  && docker-php-ext-configure gd --with-freetype --with-jpeg --with-webp \
+  && docker-php-ext-install -j$(nproc) gd zip mysqli curl intl \
+  && docker-php-ext-enable gd zip mysqli curl intl
+
+RUN a2enmod rewrite
+
+COPY --chmod=777 entrypoint.sh /usr/sbin
+COPY install-extension.php /tmp
+
+ENTRYPOINT ["entrypoint.sh"]

.docker/entrypoint.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+if [ ! -f /var/www/html/install.lock ]; then
+    wait-for-it db:3306 -t 60 &&
+    php /var/www/html/install/cli_install.php install \
+        --username admin \
+        --password admin \
+        --email [email protected] \
+        --http_server http://localhost:8083/ \
+        --db_driver mysqli \
+        --db_hostname db \
+        --db_username root \
+        --db_password admin \
+        --db_database opencart \
+        --db_port 3306 \
+        --db_prefix oc_ &&
+    touch /var/www/html/install.lock &&
+    php /tmp/install-extension.php
+fi
+
+exec apache2-foreground

.docker/install-extension.php

@@ -0,0 +1,77 @@
+<?php
+
+require_once '/var/www/html/admin/config.php';
+require_once '/var/www/html/system/startup.php';
+
+//sytem/framework.php
+$autoloader = new \Opencart\System\Engine\Autoloader();
+$autoloader->register('Opencart\\' . APPLICATION, DIR_APPLICATION);
+$autoloader->register('Opencart\Extension', DIR_EXTENSION);
+$autoloader->register('Opencart\System', DIR_SYSTEM);
+
+require_once DIR_SYSTEM . 'vendor.php';
+
+// Registry
+$registry = new \Opencart\System\Engine\Registry();
+$registry->set('autoloader', $autoloader);
+
+// Config
+$config = new \Opencart\System\Engine\Config();
+$config->addPath(DIR_CONFIG);
+// Load the default config
+$config->load('default');
+$config->load(strtolower(APPLICATION));
+$registry->set('config', $config);
+
+// Set the default application
+$config->set('application', APPLICATION);
+
+define('IS_4_1_x', class_exists('Opencart\System\Engine\Factory'));
+
+// Factory - opencart 4.1.x
+if (IS_4_1_x) {
+	$registry->set('factory', new \Opencart\System\Engine\Factory($registry));
+}
+
+// Loader
+$loader = new \Opencart\System\Engine\Loader($registry);
+$registry->set('load', $loader);
+
+// Event
+$event = new \Opencart\System\Engine\Event($registry);
+$registry->set('event', $event);
+
+// Cache
+//$registry->set('cache', new \Opencart\System\Library\Cache($config->get('cache_engine'), $config->get('cache_expire')));
+
+$db = new \Opencart\System\Library\DB($config->get('db_engine'), $config->get('db_hostname'), $config->get('db_username'), $config->get('db_password'), $config->get('db_database'), $config->get('db_port'), $config->get('db_ssl_key'), $config->get('db_ssl_cert'), $config->get('db_ssl_ca'));
+$registry->set('db', $db);
+
+
+$response = new \Opencart\System\Library\Response();
+$response->addHeader('Content-Type: text/plain; charset=utf-8');
+$registry->set('response', $response);
+
+$registry->load->model('setting/extension');
+
+/** @var \Opencart\Admin\Model\Setting\Extension $install*/
+$install = $registry->get('model_setting_extension');
+$install_info = json_decode(file_get_contents('/var/www/html/extension/oc_cartsms/install.json'), true);
+
+$id = $install->addInstall([
+	'extension_id'          => 0,
+	'extension_download_id' => 0,
+	'name'                  => $install_info['name'],
+	'code'              	=> 'oc_cartsms',
+	'description'         	=> $install_info['description'],
+	'version'               => $install_info['version'],
+	'author'                => $install_info['author'],
+	'link'                  => $install_info['link']
+]);
+
+$install->addPath($id, 'oc_cartsms/admin/controller/module/cartsms.php');
+$install->editStatus($id, true);
+
+$response->setOutput('Extension ' . $install_info['name'] . ' installed successfully.');
+
+$response->output();

.github/workflows/php.yml

@@ -0,0 +1,25 @@
+name: Run tests
+
+on: [push]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    container: ghcr.io/bulkgate/cartsms:4.1.0.0
+
+    steps:
+      - uses: actions/checkout@v1
+
+      - run: composer install --prefer-dist --no-progress --no-suggest
+
+      - run: composer run tester
+
+      - run: composer run coverage
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.html
+
+      #- run: composer run phpstan

.gitignore

@@ -0,0 +1,5 @@
+.env
+.idea
+vendor
+opencart
+tests/**/output/*

README.md

@@ -1,3 +1,22 @@
 <img src="https://portal.bulkgate.com/images/products/oc.svg" width="200" />
 
 http://www.cart-sms.com/
+
+# Development
+
+https://webkul.com/blog/how-to-create-a-module-in-opencart/
+
+
+## Category extension
+URL: http://localhost:8083/admin/index.php?route=extension/opencart/module/category&user_token=886a6f6378b7a94cbccad4acd55abdf1
+FILE: /extension/opencart/admin/controller/module/category.php
+view: /extension/opencart/admin/view/template/module/category.twig
+NAMESPACE: Opencart\Admin\Controller\Extension\Opencart\Module;
+CLASS: Category
+
+## Cartsms extension
+URL: http://localhost:8083/admin/index.php?route=extension/cartsms/module/cartsms&user_token=886a6f6378b7a94cbccad4acd55abdf1
+FILE: /extension/cartsms/admin/controller/module/cartsms.php
+view: /extension/cartsms/admin/view/template/module/cartsms.twig
+NAMESPACE: Opencart\Admin\Controller\Extension\Cartsms\Module;
+CLASS: Cartsms

admin/controller/event/hook.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace Opencart\Admin\Controller\Extension\OcCartsms\Event;
+
+use BulkGate\CartSms\Event\State;
+use BulkGate\Plugin;
+
+require_once DIR_EXTENSION . 'oc_cartsms/vendor/autoload.php';
+
+class Hook extends \BulkGate\CartSms\Controller
+{
+	private State $product_out_of_stock_state;
+	private State $return_status_state;
+
+	public function hookMenu(string $route, array &$data)
+	{
+		$this->language->load('extension/oc_cartsms/module/cartsms');
+
+		$data['menus'][] = [
+			'id' => 'menu-cartsms',
+			'icon' => 'fas fa-envelope',
+			'name' => $this->language->get('extension_name_menu'),
+			'href' => $this->url->link('extension/oc_cartsms/module/cartsms', 'user_token=' . $this->session->data['user_token']),
+			'children' => []
+		];
+	}
+
+	public function hookRenderSendMessageBox(string $route, array &$data)
+	{
+		$order_id = (int) $data['order_id'];
+
+		if ($order_id === 0 || !$this->di_container->getByClass(Plugin\Settings\Settings::class)->load('static:application_token')) {
+			return;
+		}
+
+		$data['extensions'][] = $this->load->controller('extension/oc_cartsms/module/send_message', $order_id);
+	}
+
+	public function hookSendSms(array $params)
+	{
+		$number = $params['number'] ?? null;
+		$template = $params['template'] ?? null;
+		$variables = $params['variables'] ?? [];
+		$settings = $params['settings'] ?? [];
+
+		$hook = $this->di_container->getByClass(Plugin\Event\Hook::class);
+
+		$hook->send('/api/2.0/advanced/transactional', [
+			'number' => $number,
+			'application_product' => 'oc',
+			'tag' => 'module_custom',
+			'variables' => $variables,
+			'country' => $settings['country'] ?? null,
+			'channel' => [
+				'sms' => [
+					'sender_id' => $settings['senderType'] ?? 'gSystem',
+					'sender_id_value' => $settings['senderValue'] ?? '',
+					'unicode' => $settings['unicode'] ?? false,
+					'text' => $template,
+				],
+			],
+		]);
+	}
+
+	//OK
+	public function hookAddCustomer(string $route, array $params, int $id_customer)
+	{
+		$this->runHook('customer', 'new', new Plugin\Event\Variables([
+			'customer_id' => $id_customer,
+			//'data' => $params,
+		]));
+	}
+
+	public function hookProductOutOfStockBefore(string $route, array $params)
+	{
+		[$id_product] = $params;
+		$this->load->model('catalog/product');
+
+		$this->product_out_of_stock_state = (new State(fn() => (int) $this->model_catalog_product->getProduct($id_product)['quantity']))
+			->captureInitial()
+			->setExpected(0);
+	}
+
+	//OK
+	public function hookProductOutOfStockAfter(string $route, array $params)
+	{
+		[$id_product, $data] = $params;
+
+		$this->product_out_of_stock_state->captureActual();
+
+		if (!$this->product_out_of_stock_state->shouldRunHook()) {
+			return;
+		}
+
+		$this->runHook('product', 'out-of-stock', new Plugin\Event\Variables([
+			'product_id' => $id_product,
+			'shop_id' => $data['product_store'][0],
+			//'data' => $params,
+		]));
+	}
+
+	public function hookChangeReturnStatusBefore(string $route, array $params)
+	{
+		[$id_return, $id_return_status] = $params;
+
+		$this->load->model('sale/returns');
+
+		$this->return_status_state = (new State(fn() => (int) $this->model_sale_returns->getReturn($id_return)['return_status_id']))
+			->captureInitial()
+			->setExpected((int) $id_return_status);
+	}
+
+	public function hookChangeReturnStatusAfter(string $route, array $params)
+	{
+		[$id_return, $id_return_status] = $params;
+
+		$this->return_status_state->captureActual();
+
+		if (!$this->return_status_state->shouldRunHook()) {
+			return;
+		}
+
+		$this->runHook('return', 'change-status', new Plugin\Event\Variables([
+			'return_id' => $id_return,
+			'return_status_id' => $id_return_status,
+		]));
+	}
+}