use namespace

src/Backend.php

@@ -10,32 +10,61 @@
  * @copyright Jean-Christian Denis
  * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_CONTEXT_ADMIN')) {
+declare(strict_types=1);
-    return null;
-}
 
-dcCore::app()->menu[dcAdmin::MENU_PLUGINS]->addItem(
+namespace Dotclear\Plugin\construction;
-    __('Construction'),
-    dcCore::app()->adminurl->get('admin.plugin.' . basename(__DIR__)),
-    urldecode(dcPage::getPF(basename(__DIR__) . '/icon.png')),
-    preg_match('/' . preg_quote(dcCore::app()->adminurl->get('admin.plugin.' . basename(__DIR__))) . '(&.*)?$/', $_SERVER['REQUEST_URI']),
-    dcCore::app()->auth->check(dcCore::app()->auth->makePermissions([dcAuth::PERMISSION_ADMIN]), dcCore::app()->blog->id),
-    dcCore::app()->blog->settings->get(basename(__DIR__))->get('flag') ? 'construction-blog' : ''
-);
 
-dcCore::app()->addBehaviors([
+use dcAdmin;
-    'adminPageHTMLHead'         => function () {
+use dcCore;
-        if (dcCore::app()->blog->settings->get(basename(__DIR__))->get('flag')) {
+use dcPage;
-            echo dcPage::cssModuleLoad(basename(__DIR__) . '/css/admin.css');
+use dcFavorites;
+use dcNsProcess;
+
+class Backend extends dcNsProcess
+{
+    public static function init(): bool
+    {
+        static::$init = defined('DC_CONTEXT_ADMIN')
+            && My::phpCompliant()
+            && dcCore::app()->auth->check(dcCore::app()->auth->makePermissions([
+                dcCore::app()->auth::PERMISSION_CONTENT_ADMIN,
+            ]), dcCore::app()->blog->id);
+
+        return static::$init;
+    }
+
+    public static function process(): bool
+    {
+        if (!static::$init) {
+            return false;
+        }
+
+        dcCore::app()->menu[dcAdmin::MENU_PLUGINS]->addItem(
+            My::name(),
+            dcCore::app()->adminurl->get('admin.plugin.' . My::id()),
+            dcPage::getPF(My::id() . '/icon.png'),
+            preg_match('/' . preg_quote(dcCore::app()->adminurl->get('admin.plugin.' . My::id())) . '(&.*)?$/', $_SERVER['REQUEST_URI']),
+            dcCore::app()->auth->check(dcCore::app()->auth->makePermissions([dcCore::app()->auth::PERMISSION_ADMIN]), dcCore::app()->blog->id),
+            dcCore::app()->blog->settings->get(My::id())->get('flag') ? 'construction-blog' : ''
+        );
+
+        dcCore::app()->addBehaviors([
+            'adminPageHTMLHead' => function (): void {
+                if (dcCore::app()->blog->settings->get(My::id())->get('flag')) {
+                    echo dcPage::cssModuleLoad(My::id() . '/css/backend.css');
                 }
             },
-    'adminDashboardFavoritesV2' => function (dcFavorites $favs) {
+            'adminDashboardFavoritesV2' => function (dcFavorites $favs): void {
-        $favs->register(basename(__DIR__), [
+                $favs->register(My::id(), [
-            'title'       => __('Construction'),
+                    'title'       => My::name(),
-            'url'         => dcCore::app()->adminurl->get('admin.plugin.' . basename(__DIR__)),
+                    'url'         => dcCore::app()->adminurl->get('admin.plugin.' . My::id()),
-            'small-icon'  => urldecode(dcPage::getPF(basename(__DIR__) . '/icon.png')),
+                    'small-icon'  => dcPage::getPF(My::id() . '/icon.png'),
-            'large-icon'  => urldecode(dcPage::getPF(basename(__DIR__) . '/icon-big.png')),
+                    'large-icon'  => dcPage::getPF(My::id() . '/icon-big.png'),
-            'permissions' => dcCore::app()->auth->makePermissions([dcAuth::PERMISSION_ADMIN]),
+                    'permissions' => dcCore::app()->auth->makePermissions([dcCore::app()->auth::PERMISSION_ADMIN]),
                 ]);
             },
-]);
+        ]);
+
+        return true;
+    }
+}

src/Frontend.php

@@ -10,28 +10,49 @@
  * @copyright Jean-Christian Denis
  * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_RC_PATH')) {
+declare(strict_types=1);
-    return null;
-}
 
-dcCore::app()->addBehavior('publicBeforeDocument', function () {
+namespace Dotclear\Plugin\construction;
-    if (!dcCore::app()->blog->settings->get(basename(__DIR__))->get('flag')) {
+
+use ArrayObject;
+use dcCore;
+use dcNsProcess;
+use Dotclear\Helper\Network\Http;
+use Exception;
+
+class Frontend extends dcNsProcess
+{
+    public static function init(): bool
+    {
+        static::$init = My::phpCompliant();
+
+        return static::$init;
+    }
+
+    public static function process(): bool
+    {
+        if (!static::$init) {
+            return false;
+        }
+
+        dcCore::app()->addBehavior('publicBeforeDocument', function (): void {
+            if (!dcCore::app()->blog->settings->get(My::id())->get('flag')) {
                 return;
             }
 
             $tplset = dcCore::app()->themes->moduleInfo(dcCore::app()->blog->settings->get('system')->get('theme'), 'tplset');
-    if (!empty($tplset) && is_dir(implode(DIRECTORY_SEPARATOR, [__DIR__, 'default-templates', $tplset]))) {
+            if (!empty($tplset) && is_dir(implode(DIRECTORY_SEPARATOR, [My::root(), 'default-templates', $tplset]))) {
-        dcCore::app()->tpl->setPath(dcCore::app()->tpl->getPath(), implode(DIRECTORY_SEPARATOR, [__DIR__, 'default-templates', $tplset]));
+                dcCore::app()->tpl->setPath(dcCore::app()->tpl->getPath(), implode(DIRECTORY_SEPARATOR, [My::root(), 'default-templates', $tplset]));
             } else {
-        dcCore::app()->tpl->setPath(dcCore::app()->tpl->getPath(), implode(DIRECTORY_SEPARATOR, [__DIR__, 'default-templates', DC_DEFAULT_TPLSET]));
+                dcCore::app()->tpl->setPath(dcCore::app()->tpl->getPath(), implode(DIRECTORY_SEPARATOR, [My::root(), 'default-templates', DC_DEFAULT_TPLSET]));
             }
 
-    $all_allowed_ip = json_decode(dcCore::app()->blog->settings->get(basename(__DIR__))->get('allowed_ip'), true);
+            $all_allowed_ip = json_decode(dcCore::app()->blog->settings->get(My::id())->get('allowed_ip'), true);
             if (!is_array($all_allowed_ip)) {
                 $all_allowed_ip = [];
             }
-    $extra_urls = json_decode(dcCore::app()->blog->settings->get(basename(__DIR__))->get('extra_urls'), true);
+            $extra_urls = json_decode(dcCore::app()->blog->settings->get(My::id())->get('extra_urls'), true);
-    if (!in_array(http::realIP(), $all_allowed_ip)) {
+            if (!in_array(Http::realIP(), $all_allowed_ip)) {
                 dcCore::app()->url->registerDefault(function ($args) {
                     dcCore::app()->url->type = 'default';
 
@@ -39,7 +60,7 @@ dcCore::app()->addBehavior('publicBeforeDocument', function () {
                 });
                 dcCore::app()->url->registerError(function ($args, $type, $e) {
                     header('Content-Type: text/html; charset=UTF-8');
-            http::head(503, 'Service Unavailable');
+                    Http::head(503, 'Service Unavailable');
                     dcCore::app()->url->type = '503';
                     dcCore::app()->ctx->__set('current_tpl', '503.html');
                     dcCore::app()->ctx->__set('content_type', 'text/html');
@@ -59,17 +80,21 @@ dcCore::app()->addBehavior('publicBeforeDocument', function () {
                     }
                 }
             }
-});
+        });
 
-dcCore::app()->tpl->addValue('ConstructionMessage', function ($attr) {
+        dcCore::app()->tpl->addValue('ConstructionMessage', function (ArrayObject $attr): string {
             return '<?php echo ' . sprintf(
                 dcCore::app()->tpl->getFilters($attr),
-        'dcCore::app()->blog->settings->get("' . basename(__DIR__) . '")->get("message")'
+                'dcCore::app()->blog->settings->get("' . My::id() . '")->get("message")'
             ) . '; ?>';
-});
+        });
-dcCore::app()->tpl->addValue('ConstructionTitle', function ($attr) {
+        dcCore::app()->tpl->addValue('ConstructionTitle', function (ArrayObject $attr): string {
             return '<?php echo ' . sprintf(
                 dcCore::app()->tpl->getFilters($attr),
-        'dcCore::app()->blog->settings->get("' . basename(__DIR__) . '")->get("title")'
+                'dcCore::app()->blog->settings->get("' . My::id() . '")->get("title")'
             ) . '; ?>';
-});
+        });
+
+        return true;
+    }
+}

src/Install.php

@@ -10,20 +10,33 @@
  * @copyright Jean-Christian Denis
  * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_CONTEXT_ADMIN')) {
+declare(strict_types=1);
-    return null;
-}
 
-try {
+namespace Dotclear\Plugin\construction;
-    // Version
+
-    if (!dcCore::app()->newVersion(
+use dcCore;
-        basename(__DIR__),
+use dcNsProcess;
-        dcCore::app()->plugins->moduleInfo(basename(__DIR__), 'version')
+use Exception;
-    )) {
+
-        return null;
+class Install extends dcNsProcess
+{
+    public static function init(): bool
+    {
+        static::$init = defined('DC_CONTEXT_ADMIN')
+            && My::phpCompliant()
+            && dcCore::app()->newVersion(My::id(), dcCore::app()->plugins->moduleInfo(My::id(), 'version'));
+
+        return static::$init;
     }
 
-    $s = dcCore::app()->blog->settings->get(basename(__DIR__));
+    public static function process(): bool
+    {
+        if (!static::$init) {
+            return false;
+        }
+
+        try {
+            $s = dcCore::app()->blog->settings->get(My::id());
 
             $s->put(
                 'flag',
@@ -71,8 +84,10 @@ try {
             );
 
             return true;
-} catch (Exception $e) {
+        } catch (Exception $e) {
             dcCore::app()->error->add($e->getMessage());
-}
+        }
 
-return false;
+        return true;
+    }
+}

src/Manage.php

@@ -10,17 +10,53 @@
  * @copyright Jean-Christian Denis
  * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_CONTEXT_ADMIN')) {
+declare(strict_types=1);
-    return null;
-}
 
-dcPage::check(dcCore::app()->auth->makePermissions([
+namespace Dotclear\Plugin\construction;
-    dcAuth::PERMISSION_ADMIN,
-]));
 
-$s = dcCore::app()->blog->settings->get(basename(__DIR__));
+use dcAuth;
+use dcCore;
+use dcNsProcess;
+use dcPage;
+use Dotclear\Helper\Html\Form\{
+    Checkbox,
+    Div,
+    Form,
+    Hidden,
+    Input,
+    Label,
+    Note,
+    Para,
+    Submit,
+    Text,
+    Textarea
+};
+use Dotclear\Helper\Html\Html;
+use Dotclear\Helper\Network\Http;
+use Exception;
 
-if (!empty($_POST['saveconfig'])) {
+class Manage extends dcNsProcess
+{
+    public static function init(): bool
+    {
+        static::$init = defined('DC_CONTEXT_ADMIN')
+            && My::phpCompliant()
+            && dcCore::app()->auth->check(dcCore::app()->auth->makePermissions([
+                dcAuth::PERMISSION_CONTENT_ADMIN,
+            ]), dcCore::app()->blog->id);
+
+        return static::$init;
+    }
+
+    public static function process(): bool
+    {
+        if (!static::$init) {
+            return false;
+        }
+
+        $s = dcCore::app()->blog->settings->get(My::id());
+
+        if (!empty($_POST['saveconfig'])) {
             try {
                 $allowed_ip = [];
                 foreach (explode("\n", $_POST['construction_allowed_ip']) as $ip) {
@@ -31,7 +67,7 @@ if (!empty($_POST['saveconfig'])) {
                     $extra_urls[] = trim($url);
                 }
 
-        $s->put('flag', empty($_POST['construction_flag']) ? false : true);
+                $s->put('flag', !empty($_POST['construction_flag']));
                 $s->put('allowed_ip', json_encode($allowed_ip));
                 $s->put('title', $_POST['construction_title']);
                 $s->put('message', $_POST['construction_message']);
@@ -39,77 +75,87 @@ if (!empty($_POST['saveconfig'])) {
 
                 dcCore::app()->blog->triggerBlog();
 
-        dcAdminNotices::addSuccessNotice(
+                dcPage::addSuccessNotice(
                     __('Settings successfully updated.')
                 );
 
                 dcCore::app()->adminurl->redirect(
-            'admin.plugin.' . basename(__DIR__)
+                    'admin.plugin.' . My::id()
                 );
             } catch (Exception $e) {
                 dcCore::app()->error->add($e->getMessage());
             }
-}
+        }
 
-$nb_rows = count(json_decode($s->get('allowed_ip'), true));
+        return true;
-if ($nb_rows < 2) {
+    }
+
+    public static function render(): void
+    {
+        if (!static::$init) {
+            return;
+        }
+
+        $s       = dcCore::app()->blog->settings->get(My::id());
+        $editor  = dcCore::app()->auth->getOption('editor');
+        $nb_rows = count(json_decode($s->get('allowed_ip'), true));
+        if ($nb_rows < 2) {
             $nb_rows = 2;
-} elseif ($nb_rows > 10) {
+        } elseif ($nb_rows > 10) {
             $nb_rows = 10;
-}
+        }
 
-$editor = dcCore::app()->auth->getOption('editor');
+        dcPage::openModule(
+            My::name(),
+            dcPage::jsConfirmClose('opts-forms') .
+            dcCore::app()->callBehavior('adminPostEditor', $editor['xhtml'], 'construction', ['#construction_message'], 'xhtml') .
+            dcPage::jsModuleLoad(My::id() . '/js/backend.js')
+        );
 
-echo '
+        echo
-<html><head><title>' . __('Construction') . '</title>' .
+        dcPage::breadcrumb([
-dcPage::jsConfirmClose('opts-forms') .
-dcCore::app()->callBehavior('adminPostEditor', $editor['xhtml'], 'construction', ['#construction_message'], 'xhtml') .
-dcPage::jsModuleLoad(basename(__DIR__) . '/js/index.js') . '
-</head><body>' .
-
-dcPage::breadcrumb([
             __('Plugins') => '',
-    __('Construction') => '',
+            My::name()    => '',
-]) .
+        ]) .
-dcPage::notices() . '
+        dcPage::notices() .
 
-<div id="construction_options">
+        (new Div())->id('construction_options')->items([
-<form method="post" action="' . dcCore::app()->adminurl->get('admin.plugin.' . basename(__DIR__)) . '">
+            (new Form(My::id() . 'form'))->method('post')->action(dcCore::app()->adminurl->get('admin.plugin.' . My::id()))->fields([
-<div class="fieldset">
+                (new Div())->class('fieldset')->items([
-<h4>' . __('Configuration') . '</h4>
+                    (new Text('h4', __('Configuration'))),
+                    (new Para())->class('filed')->items([
+                        (new Checkbox('construction_flag', (bool) $s->get('flag')))->value(1),
+                        (new Label(__('Plugin activation'), Label::OUTSIDE_LABEL_AFTER))->for('construction_flag')->class('classic'),
+                    ]),
+                    (new Para())->items([
+                        (new Label(__('Allowed IP:'), Label::OUTSIDE_LABEL_BEFORE))->for('construction_allowed_ip'),
+                        (new Textarea('construction_allowed_ip', Html::escapeHTML(implode("\n", json_decode($s->get('allowed_ip'), true)))))->cols(20)->rows($nb_rows),
+                    ]),
+                    (new Note())->class('form-note')->text(sprintf(__('Your IP is <strong>%s</strong> - the allowed IP can view the blog normally.'), (string) Http::realIP())),
+                    (new Para())->class('area')->items([
+                        (new Label(__('Extra allowed URL types:'), Label::OUTSIDE_LABEL_BEFORE))->for('construction_extra_urls'),
+                        (new Input('construction_extra_urls'))->size(20)->maxlenght(255)->class('maximal')->value(Html::escapeHTML(implode(',', json_decode($s->get('extra_urls'), true)))),
+                    ]),
+                ]),
+                (new Div())->class('fieldset')->items([
+                    (new Text('h4', __('Presentation'))),
+                    (new Para())->class('area')->items([
+                        (new Label(__('Title:'), Label::OUTSIDE_LABEL_BEFORE))->for('construction_title'),
+                        (new Input('construction_title'))->size(20)->maxlenght(255)->class('maximal')->value(Html::escapeHTML($s->get('title'))),
+                    ]),
+                    (new Para())->class('area')->items([
+                        (new Label(__('Message:'), Label::OUTSIDE_LABEL_BEFORE))->for('construction_message'),
+                        (new Textarea('construction_message', Html::escapeHTML($s->get('message'))))->cols(40)->rows(10),
+                    ]),
+                ]),
+                (new Para())->items([
+                    dcCore::app()->formNonce(false),
+                    (new Hidden(['p'], 'construction')),
+                    (new Submit(['saveconfig']))->value(__('Save')),
+                ]),
+            ]),
+        ])->render();
 
-<p class="field">' .
+        dcPage::closeModule();
-form::checkbox('construction_flag', 1, $s->get('flag')) . '
+    }
-<label class="classic" for="construction_flag">' . __('Plugin activation') . '</label>
+}
-</p>
-
-<p><label for="construction_allowed_ip">' . __('Allowed IP:') . '</label> ' .
-form::textarea('construction_allowed_ip', 20, $nb_rows, html::escapeHTML(implode("\n", json_decode($s->get('allowed_ip'), true)))) .
-'</p>
-<p class="form-note">' . sprintf(__('Your IP is <strong>%s</strong> - the allowed IP can view the blog normally.'), (string) http::realIP()) . '</p>
-
-<p class="area"><label for="construction_extra_urls">' . __('Extra allowed URL types:') . '</label>' .
-form::field('construction_extra_urls', 20, 255, html::escapeHTML(implode(',', json_decode($s->get('extra_urls'), true))), 'maximal') .
-'</p>
-
-</div>
-<div class="fieldset">
-<h4>' . __('Presentation') . '</h4>
-<p class="area"><label for="construction_title">' . __('Title:') . '</label>' .
-form::field('construction_title', 20, 255, html::escapeHTML($s->get('title')), 'maximal') .
-'</p>
-
-<p class="area"><label for="construction_message">' . __('Message:') . '</label>' .
-form::textarea('construction_message', 40, 10, html::escapeHTML($s->get('message'))) .
-'</p>
-</div>
-<p>' .
-form::hidden(['p'], 'construction') .
-dcCore::app()->formNonce() . '
-<input type="submit" name="saveconfig" value="' . __('Save') . '" />
-</p>
-</form>
-</div>
-
-</body>
-</html>';

src/My.php

@@ -0,0 +1,58 @@
+<?php
+/**
+ * @brief construction, a plugin for Dotclear 2
+ *
+ * @package Dotclear
+ * @subpackage Plugin
+ *
+ * @author Osku and contributors
+ *
+ * @copyright Jean-Christian Denis
+ * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
+declare(strict_types=1);
+
+namespace Dotclear\Plugin\construction;
+
+use dcCore;
+
+/**
+ * Plugin definitions
+ */
+class My
+{
+    /** @var string Required php version */
+    public const PHP_MIN = '7.4';
+
+    /**
+     * This module id
+     */
+    public static function id(): string
+    {
+        return basename(dirname(__DIR__));
+    }
+
+    /**
+     * This module name
+     */
+    public static function name(): string
+    {
+        return __((string) dcCore::app()->plugins->moduleInfo(self::id(), 'name'));
+    }
+
+    /**
+     * This mdoule directory
+     */
+    public static function root(): string
+    {
+        return dirname(__DIR__);
+    }
+
+    /**
+     * Check php version
+     */
+    public static function phpCompliant(): bool
+    {
+        return version_compare(phpversion(), self::PHP_MIN, '>=');
+    }
+}