Skip to content

feat: add configurable advent calendar block #501

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 3, 2025
Merged

feat: add configurable advent calendar block #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions config/allowed_files.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
'controllers/admin/AdminEverBlockHookController.php',
'controllers/admin/AdminEverBlockShortcodeController.php',
'controllers/admin/index.php',
'controllers/front/advent.php',
'controllers/front/contact.php',
'controllers/front/cron.php',
'controllers/front/everlogin.php',
Expand Down Expand Up @@ -257,6 +258,7 @@
'views/templates/hook/prettyblocks/prettyblock_toc.tpl',
'views/templates/hook/prettyblocks/prettyblock_video_products.tpl',
'views/templates/hook/prettyblocks/prettyblock_video_gallery.tpl',
'views/templates/hook/prettyblocks/prettyblock_advent_calendar.tpl',
'views/templates/hook/prettyblocks/prettyblock_scratch_card.tpl',
'views/templates/hook/prettyblocks/prettyblock_wheel_of_fortune.tpl',
'views/templates/hook/prettyblocks/prettyblocks.tpl',
Expand Down
297 changes: 297 additions & 0 deletions controllers/front/advent.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,297 @@
<?php
/**
* 2019-2025 Team Ever
*
* 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 [email protected] so we can send you a copy immediately.
*
* @author Team Ever <https://www.team-ever.com/>
* @copyright 2019-2025 Team Ever
* @license http://opensource.org/licenses/afl-3.0.php Academic Free License (AFL 3.0)
*/

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

class EverblockAdventModuleFrontController extends ModuleFrontController
{
public function initContent()
{
$this->ajax = true;
parent::initContent();

header('Content-Type: application/json');

$token = Tools::getValue('token');
if (!$token || $token !== Tools::getToken(false)) {
$this->renderJson([
'status' => false,
'message' => $this->module->l('Invalid token', 'advent'),
]);
}

if (!$this->context->customer->isLogged()) {
$this->renderJson([
'status' => false,
'message' => $this->module->l('You must be logged in to open this window.', 'advent'),
]);
}

$idBlock = (int) Tools::getValue('id_block');
$requestedDay = (int) Tools::getValue('day');
if ($idBlock <= 0 || $requestedDay < 1 || $requestedDay > 24) {
$this->renderJson([
'status' => false,
'message' => $this->module->l('Invalid calendar configuration.', 'advent'),
]);
}

$idCustomer = (int) $this->context->customer->id;
$idShop = (int) $this->context->shop->id;
$idLang = (int) $this->context->language->id;

$row = Db::getInstance()->getRow(
'SELECT config, state FROM ' . _DB_PREFIX_ . 'prettyblocks WHERE id_prettyblocks = ' . (int) $idBlock
. ' AND id_shop = ' . (int) $idShop . ' AND id_lang = ' . (int) $idLang
);

if (!$row) {
$this->renderJson([
'status' => false,
'message' => $this->module->l('Configuration not found', 'advent'),
]);
}

$settings = json_decode($row['config'], true);
if (!is_array($settings)) {
$settings = [];
}

$rawWindows = json_decode($row['state'], true);
if (!is_array($rawWindows)) {
$rawWindows = [];
}

$calendarSettings = $this->resolveCalendarSettings($settings);
$window = $this->findWindowForDay($rawWindows, $requestedDay, $idLang);

if (!$window) {
$this->renderJson([
'status' => false,
'message' => $this->module->l('This window is not configured yet.', 'advent'),
]);
}

$today = $this->getNowDate();
$startDate = $calendarSettings['start_date'];
if (!$startDate) {
$startDate = new DateTime('first day of December ' . (int) $today->format('Y'));
}

$windowDate = clone $startDate;
$windowDate->modify('+' . ($requestedDay - 1) . ' days');

if ($today < $windowDate) {
$this->renderJson([
'status' => false,
'message' => sprintf(
$this->module->l('This window will open on %s.', 'advent'),
Tools::displayDate($windowDate->format('Y-m-d'), null, false)
),
'reason' => 'too_early',
'available_on' => $windowDate->format('Y-m-d'),
]);
}

if ($calendarSettings['restrict_to_current_day'] && $today->format('Y-m-d') !== $windowDate->format('Y-m-d')) {
$this->renderJson([
'status' => false,
'message' => $this->module->l('You can only open today\'s window.', 'advent'),
'reason' => 'not_today',
'available_on' => $windowDate->format('Y-m-d'),
]);
}

$ipAddress = Tools::getRemoteAddr();
if (!is_string($ipAddress)) {
$ipAddress = '';
} else {
$ipAddress = Tools::substr($ipAddress, 0, 45);
}

if (!$this->isAdmin()) {
$alreadyCustomer = (bool) Db::getInstance()->getValue(
'SELECT id_everblock_game_play FROM ' . _DB_PREFIX_ . 'everblock_game_play WHERE id_prettyblocks = ' . (int) $idBlock
. ' AND id_customer = ' . (int) $idCustomer
. " AND result = '" . pSQL('day-' . $requestedDay) . "'"
);

$alreadyIp = false;
if ($ipAddress !== '') {
$alreadyIp = (bool) Db::getInstance()->getValue(
'SELECT id_everblock_game_play FROM ' . _DB_PREFIX_ . 'everblock_game_play WHERE id_prettyblocks = ' . (int) $idBlock
. " AND ip_address = '" . pSQL($ipAddress) . "'"
. " AND result = '" . pSQL('day-' . $requestedDay) . "'"
);
}

if ($alreadyCustomer || $alreadyIp) {
$this->renderJson([
'status' => false,
'message' => $this->module->l('You have already opened this window.', 'advent'),
'reason' => 'already_opened',
]);
}
}

Db::getInstance()->insert('everblock_game_play', [
'id_prettyblocks' => (int) $idBlock,
'id_customer' => (int) $idCustomer,
'ip_address' => pSQL($ipAddress),
'result' => pSQL('day-' . $requestedDay),
'is_winner' => 0,
'date_add' => date('Y-m-d H:i:s'),
]);

$this->renderJson([
'status' => true,
'day' => $requestedDay,
'message' => $this->module->l('Window unlocked!', 'advent'),
]);
}

private function renderJson(array $payload)
{
die(json_encode($payload));
}

private function resolveCalendarSettings(array $settings)
{
$restrict = true;
if (array_key_exists('restrict_to_current_day', $settings)) {
$restrictValue = $this->resolveConfigValue($settings['restrict_to_current_day']);
if ($restrictValue !== null) {
$restrict = (bool) $restrictValue;
}
}

$startDate = null;
if (array_key_exists('start_date', $settings)) {
$startRaw = $this->resolveConfigValue($settings['start_date']);
if (is_string($startRaw) && trim($startRaw) !== '') {
$parsed = $this->createDateTime($startRaw);
if ($parsed) {
$startDate = $parsed;
}
}
}

return [
'restrict_to_current_day' => $restrict,
'start_date' => $startDate,
];
}

private function resolveConfigValue($value)
{
if (is_array($value)) {
if (array_key_exists('value', $value)) {
return $this->resolveConfigValue($value['value']);
}
if (array_key_exists($this->context->language->id, $value)) {
return $this->resolveConfigValue($value[$this->context->language->id]);
}
$first = reset($value);
if ($first !== false) {
return $this->resolveConfigValue($first);
}

return null;
}

if (is_scalar($value)) {
return $value;
}

return null;
}

private function findWindowForDay(array $windows, $day, $idLang)
{
foreach ($windows as $window) {
if (!is_array($window)) {
continue;
}
$normalized = $this->normalizeWindow($window, $idLang);
if ((int) ($normalized['day_number'] ?? 0) === (int) $day) {
return $normalized;
}
}

return null;
}

private function normalizeWindow(array $window, $idLang)
{
$normalized = [];
foreach ($window as $key => $value) {
$normalized[$key] = $this->normalizeWindowValue($value, $idLang);
}

return $normalized;
}

private function normalizeWindowValue($value, $idLang)
{
if (is_array($value)) {
if (array_key_exists('value', $value)) {
return $this->normalizeWindowValue($value['value'], $idLang);
}
if (array_key_exists($idLang, $value)) {
return $this->normalizeWindowValue($value[$idLang], $idLang);
}
foreach ($value as $subKey => $subValue) {
$value[$subKey] = $this->normalizeWindowValue($subValue, $idLang);
}
}

return $value;
}

private function createDateTime($value)
{
try {
return new DateTime($value);
} catch (Exception $e) {
return null;
}
}

private function getNowDate()
{
try {
$timezone = new DateTimeZone(@date_default_timezone_get());
} catch (Exception $e) {
$timezone = null;
}

if ($timezone) {
return new DateTime('now', $timezone);
}

return new DateTime();
}

private function isAdmin()
{
return !empty((new Cookie('psAdmin'))->id_employee);
}
}
Loading
Loading