fix global settings

CHANGELOG.md

@@ -2,6 +2,21 @@ dev
 - [ ] orphan media cleaner
 - [ ] move to plugin maintenance
 
+1.2 - 2023.07.28
+- require dotclear 2.27
+- require php 8.1+
+- update to dotclear 2.27-dev
+
+1.1 - 2023.05.13
+- require dotclear 2.26
+- require php 8.1+
+- use define php_min
+
+1.0.1 - 2023.05.01
+- require dotclear 2.26
+- require php 8.1+
+- require plugin Uninstaller 0.8
+
 1.0 - 2023.04.24
 - require dotclear 2.26
 - require php 8.1+

README.md

@@ -3,7 +3,7 @@
 [![Release](https://img.shields.io/github/v/release/JcDenis/dcAdvancedCleaner)](https://github.com/JcDenis/dcAdvancedCleaner/releases)
 [![Date](https://img.shields.io/github/release-date/JcDenis/dcAdvancedCleaner)](https://github.com/JcDenis/dcAdvancedCleaner/releases)
 [![Issues](https://img.shields.io/github/issues/JcDenis/dcAdvancedCleaner)](https://github.com/JcDenis/dcAdvancedCleaner/issues)
-[![Dotclear](https://img.shields.io/badge/dotclear-v2.26-blue.svg)](https://fr.dotclear.org/download)
+[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-blue.svg)](https://fr.dotclear.org/download)
 [![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/dcAdvancedCleaner)
 [![License](https://img.shields.io/github/license/JcDenis/dcAdvancedCleaner)](https://github.com/JcDenis/dcAdvancedCleaner/blob/master/LICENSE)
 
@@ -20,9 +20,9 @@ settings, tables, cache, etc...
  _dcAdvancedCleaner_ requires: 
 
   * Permissions superadmin
-  * Dotclear 2.26
+  * Dotclear 2.27
   * PHP >= 8.1
-  * Plugin Uninstaller
+  * Plugin Uninstaller (temporary at https://github.com/JcDenis/Uninstaller )
 
 ## USAGE
 
@@ -44,4 +44,4 @@ Once it's done you can manage cleaners from menu
  * Jean-Christian Denis
  * Pierre Van Glabeke
 
- You are welcome to contribute to this code.
+ You are welcome to contribute to this code.

_define.php

@@ -18,11 +18,12 @@ $this->registerModule(
     'Advanced cleaner',
     'Make a huge cleaning of dotclear',
     'Jean-Christian Denis and Contributors',
-    '1.0',
+    '1.2',
     [
         'requires' => [
-            ['core', '2.26'],
+            ['php', '8.1'],
-            ['Uninstaller', '0.6'],
+            ['core', '2.27'],
+            ['Uninstaller', '0.8'],
         ],
         'permissions' => null,
         'type'        => 'plugin',

dcstore.xml

@@ -2,11 +2,11 @@
 <modules xmlns:da="http://dotaddict.org/da/">
   <module id="dcAdvancedCleaner">
     <name>Advanced cleaner</name>
-    <version>1.0</version>
+    <version>1.2</version>
     <author>Jean-Christian Denis and Contributors</author>
     <desc>Make a huge cleaning of dotclear</desc>
-    <file>https://github.com/JcDenis/dcAdvancedCleaner/releases/download/v1.0/plugin-dcAdvancedCleaner.zip</file>
+    <file>https://github.com/JcDenis/dcAdvancedCleaner/releases/download/v1.2/plugin-dcAdvancedCleaner.zip</file>
-    <da:dcmin>2.26</da:dcmin>
+    <da:dcmin>2.27</da:dcmin>
     <da:details>https://plugins.dotaddict.org/dc2/details/dcAdvancedCleaner</da:details>
     <da:support>https://github.com/JcDenis/dcAdvancedCleaner</da:support>
   </module>

src/Backend.php

@@ -14,46 +14,32 @@ declare(strict_types=1);
 
 namespace Dotclear\Plugin\dcAdvancedCleaner;
 
-use dcAdmin;
 use dcCore;
-use dcFavorites;
+use Dotclear\Core\Process;
-use dcNsProcess;
+use Dotclear\Core\Backend\Favorites;
-use dcPage;
 
-class Backend extends dcNsProcess
+class Backend extends Process
 {
     public static function init(): bool
     {
-        static::$init = defined('DC_CONTEXT_ADMIN')
+        return self::status(My::checkContext(My::BACKEND));
-            && My::phpCompliant();
-
-        return static::$init;
     }
 
     public static function process(): bool
     {
-        if (!static::$init || !dcCore::app()->plugins->moduleExists('Uninstaller')) {
+        if (!self::status() || !dcCore::app()->plugins->moduleExists('Uninstaller')) {
             return false;
         }
 
-        dcCore::app()->menu[dcAdmin::MENU_PLUGINS]->addItem(
+        My::addBackendMenuItem();
-            My::name(),
-            dcCore::app()->adminurl?->get('admin.plugin.' . My::id()),
-            dcPage::getPF(My::id() . '/icon.svg'),
-            preg_match(
-                '/' . preg_quote((string) dcCore::app()->adminurl?->get('admin.plugin.' . My::id())) . '(&.*)?$/',
-                $_SERVER['REQUEST_URI']
-            ),
-            dcCore::app()->auth?->isSuperAdmin()
-        );
 
         dcCore::app()->addBehaviors([
-            'adminDashboardFavoritesV2' => function (dcFavorites $favs): void {
+            'adminDashboardFavoritesV2' => function (Favorites $favs): void {
                 $favs->register(My::id(), [
                     'title'      => My::name(),
-                    'url'        => dcCore::app()->adminurl?->get('admin.plugin.' . My::id()),
+                    'url'        => My::manageURL(),
-                    'small-icon' => dcPage::getPF(My::id() . '/icon.svg'),
+                    'small-icon' => My::icons(),
-                    'large-icon' => dcPage::getPF(My::id() . '/icon-big.svg'),
+                    'large-icon' => My::icons(),
                     //'permissions' => dcCore::app()->auth?->isSuperAdmin(),
                 ]);
             },

src/Manage.php

@@ -15,8 +15,11 @@ declare(strict_types=1);
 namespace Dotclear\Plugin\dcAdvancedCleaner;
 
 use dcCore;
-use dcNsProcess;
+use Dotclear\Core\Process;
-use dcPage;
+use Dotclear\Core\Backend\{
+    Notices,
+    Page
+};
 use Dotclear\Helper\Html\Form\{
     Checkbox,
     Div,
@@ -32,20 +35,16 @@ use Dotclear\Helper\Html\Form\{
 use Dotclear\Helper\Html\Html;
 use Exception;
 
-class Manage extends dcNsProcess
+class Manage extends Process
 {
     public static function init(): bool
     {
-        static::$init = defined('DC_CONTEXT_ADMIN')
+        return self::status(My::checkContext(My::MANAGE));
-            && dcCore::app()->auth?->isSuperAdmin()
-            && My::phpCompliant();
-
-        return static::$init;
     }
 
     public static function process(): bool
     {
-        if (!static::$init || !dcCore::app()->plugins->moduleExists('Uninstaller')) {
+        if (!self::status() || !dcCore::app()->plugins->moduleExists('Uninstaller')) {
             return false;
         }
 
@@ -56,10 +55,10 @@ class Manage extends dcNsProcess
         }
 
         if (!empty($_POST['option-action'])) {
-            dcCore::app()->blog?->settings->get(My::id())->dropEvery(
+            My::settings()->dropEvery(
                 'dcproperty_hide'
             );
-            dcCore::app()->blog?->settings->get(My::id())->put(
+            My::settings()->put(
                 'dcproperty_hide',
                 !empty($_POST['dcproperty_hide']),
                 'boolean',
@@ -67,11 +66,8 @@ class Manage extends dcNsProcess
                 true,
                 true
             );
-            dcPage::addSuccessNotice(__('Configuration successfully updated.'));
+            Notices::addSuccessNotice(__('Configuration successfully updated.'));
-            dcCore::app()->adminurl?->redirect(
+            My::redirect(['part' => $vars->cleaner->id]);
-                'admin.plugin.' . My::id(),
-                ['part' => $vars->cleaner->id]
-            );
         }
 
         if (!empty($vars->entries) && !empty($vars->action)) {
@@ -90,11 +86,8 @@ class Manage extends dcNsProcess
                     }
                 }
 
-                dcPage::addSuccessNotice(__('Action successfuly excecuted'));
+                Notices::addSuccessNotice(__('Action successfuly excecuted'));
-                dcCore::app()->adminurl?->redirect(
+                My::redirect(['part' => $vars->cleaner->id]);
-                    'admin.plugin.' . My::id(),
-                    ['part' => $vars->cleaner->id]
-                );
             } catch (Exception $e) {
                 dcCore::app()->error->add($e->getMessage());
             }
@@ -105,17 +98,17 @@ class Manage extends dcNsProcess
 
     public static function render(): void
     {
-        if (!static::$init) {
+        if (!self::status()) {
             return;
         }
 
         $vars = ManageVars::init();
 
-        dcPage::openModule(
+        Page::openModule(
             My::name(),
-            dcPage::jsJson('dcAdvancedCleaner', ['confirm_delete' => __('Are you sure you perform these ations?')]) .
+            Page::jsJson('dcAdvancedCleaner', ['confirm_delete' => __('Are you sure you perform these ations?')]) .
-            dcPage::cssModuleLoad(My::id() . '/css/backend.css') .
+            My::cssLoad('backend') .
-            dcPage::jsModuleLoad(My::id() . '/js/backend.js')
+            My::jsLoad('backend')
         );
 
         # --BEHAVIOR-- dcAdvancedCleanerAdminHeader
@@ -129,34 +122,34 @@ class Manage extends dcNsProcess
         // something went wrong !
         if (null === $vars->cleaner) {
             echo
-            dcPage::breadcrumb($breadcrumb) .
+            Page::breadcrumb($breadcrumb) .
-            dcPage::notices();
+            Notices::getNotices();
             echo (new Text('p', __('There is nothing to display')))->class('error')->render();
-            dcPage::closeModule();
+            Page::closeModule();
 
             return;
         }
 
-        $breadcrumb[My::name()]           = dcCore::app()->adminurl?->get('admin.plugin.' . My::id());
+        $breadcrumb[My::name()]           = My::manageUrl();
         $breadcrumb[$vars->cleaner->name] = '';
 
         if (!empty($vars->related)) {
-            $breadcrumb[$vars->cleaner->name] = dcCore::app()->adminurl?->get('admin.plugin.' . My::id(), ['part' => $vars->cleaner->id]);
+            $breadcrumb[$vars->cleaner->name] = My::manageUrl(['part' => $vars->cleaner->id]);
             $breadcrumb[$vars->related]       = '';
         }
 
         echo
-        dcPage::breadcrumb($breadcrumb) .
+        Page::breadcrumb($breadcrumb) .
-        dcPage::notices();
+        Notices::getNotices();
 
         if (empty($vars->related)) {
             echo
-            (new Form('parts_menu'))->method('get')->action(dcCore::app()->adminurl?->get('admin.plugin.' . My::id()))->fields([
+            (new Form('parts_menu'))->method('get')->action(dcCore::app()->admin->getPageURL())->fields([
                 (new Para())->class('anchor-nav')->items([
                     (new Label(__('Goto:'), Label::OUTSIDE_LABEL_BEFORE))->for('part')->class('classic'),
                     (new Select(['part', 'select_part']))->default($vars->cleaner->id)->items($vars->combo),
                     (new Submit('go'))->value(__('Ok')),
-                    (new Hidden(['p'], My::id())),
+                    ... My::hiddenFields(),
                 ]),
             ])->render() .
 
@@ -179,7 +172,7 @@ class Manage extends dcNsProcess
                 }
 
                 echo
-                '<form method="post" action="' . dcCore::app()->adminurl?->get('admin.plugin.' . My::id()) . '" id="form-funcs">' .
+                '<form method="post" action="' . dcCore::app()->admin->getPageURL() . '" id="form-funcs">' .
                 '<div class="table-outer">' .
                 '<table><caption>' . sprintf(__('There are %s entries'), count($rs)) . '</caption><thead><tr>' .
                 '<th colspan="2">' . __('Name') . '</th><th colspan="2">' . __('Objects') . '</th>' .
@@ -189,7 +182,7 @@ class Manage extends dcNsProcess
                 foreach ($rs as $key => $value) {
                     $distrib = in_array($value->ns, $vars->cleaner->distributed());
 
-                    if ($distrib && dcCore::app()->blog?->settings->get(My::id())->get('dcproperty_hide')) {
+                    if ($distrib && My::settings()->getGlobal('dcproperty_hide')) {
                         continue;
                     }
                     echo
@@ -207,7 +200,7 @@ class Manage extends dcNsProcess
                         __('Values from official distribution') . '" />'
                     : '') . '</td>' .
                     '<td class="maximal">' . ($has_related ? ' <a href="' .
-                        dcCore::app()->adminurl?->get('admin.plugin.' . My::id(), ['part' => $vars->cleaner->id, 'related' => $value->ns]) .
+                        My::manageUrl(['part' => $vars->cleaner->id, 'related' => $value->ns]) .
                     '">' . __('Details') . '<a>' : '') . '</td>' .
                     '</tr>';
                 }
@@ -218,9 +211,8 @@ class Manage extends dcNsProcess
                     (new Label(__('Action on selected rows:'), Label::OUTSIDE_LABEL_BEFORE))->for('select_action'),
                     (new Select(['action', 'select_action']))->items($combo_actions),
                     (new Submit('do-action'))->class('delete')->value(__('I understand and I am want to delete this')),
-                    (new Hidden(['p'], My::id())),
                     (new Hidden(['part'], $vars->cleaner->id)),
-                    dcCore::app()->formNonce(false),
+                    ... My::hiddenFields(),
                 ])->render() .
                 '<p class="warning">' .
                 __('Beware: All actions done here are irreversible and are directly applied') .
@@ -229,18 +221,17 @@ class Manage extends dcNsProcess
             }
 
             echo
-            (new Form('option'))->method('post')->action(dcCore::app()->adminurl?->get('admin.plugin.' . My::id()))->fields([
+            (new Form('option'))->method('post')->action(dcCore::app()->admin->getPageURL())->fields([
                 (new Para())->items([
-                    (new Submit('option-action'))->value(dcCore::app()->blog?->settings->get(My::id())->get('dcproperty_hide') ? __('Show Dotclear default properties') : __('Hide Dotclear default properties')),
+                    (new Submit('option-action'))->value(My::settings()->getGlobal('dcproperty_hide') ? __('Show Dotclear default properties') : __('Hide Dotclear default properties')),
-                    (new Hidden('dcproperty_hide', (string) (int) !dcCore::app()->blog->settings->get(My::id())->get('dcproperty_hide'))),
+                    (new Hidden('dcproperty_hide', My::settings()->getGlobal('dcproperty_hide') ? '0' : '1')),
-                    (new Hidden(['p'], My::id())),
                     (new Hidden(['part'], $vars->cleaner->id)),
-                    dcCore::app()->formNonce(false),
+                    ... My::hiddenFields(),
                 ]),
             ])->render();
         } else {
             echo
-            '<p><a class="back" href="' . dcCore::app()->adminurl?->get('admin.plugin.' . My::id(), ['part' => $vars->cleaner->id]) . '">' . __('Back') . '</a></p>' .
+            '<p><a class="back" href="' . My::manageUrl(['part' => $vars->cleaner->id]) . '">' . __('Back') . '</a></p>' .
             '<h3>' . $vars->cleaner->name . ' : ' . $vars->related . '</h3><p>' . $vars->cleaner->desc . '</p>';
 
             $distrib = in_array($vars->related, $vars->cleaner->distributed());
@@ -249,7 +240,7 @@ class Manage extends dcNsProcess
                 echo (new Text('p', __('There is nothing to display')))->class('error')->render();
             } else {
                 echo
-                '<form method="post" action="' . dcCore::app()->adminurl?->get('admin.plugin.' . My::id()) . '" id="form-funcs">' .
+                '<form method="post" action="' . dcCore::app()->admin->getPageURL() . '" id="form-funcs">' .
                 '<div class="table-outer">' .
                 '<table><caption>' . sprintf(__('There are %s related entries for the group "%s"'), count($rs), $vars->related) . '</caption><thead><tr>' .
                 '<th colspan="2">' . __('Name') . '</th><th>' . __('Objects') . '</th>' .
@@ -272,11 +263,10 @@ class Manage extends dcNsProcess
                 '</tbody></table></div>' .
                 (new Para())->items([
                     (new Submit('do-action'))->class('delete')->value(__('I understand and I am want to delete this')),
-                    (new Hidden(['p'], My::id())),
                     (new Hidden(['related'], $vars->related)),
                     (new Hidden(['part'], $vars->cleaner->id)),
                     (new Hidden(['action'], 'delete_related')),
-                    dcCore::app()->formNonce(false),
+                    ... My::hiddenFields(),
                 ])->render() .
                 '<p class="warning">' .
                 __('Beware: All actions done here are irreversible and are directly applied') .
@@ -285,6 +275,6 @@ class Manage extends dcNsProcess
             }
         }
 
-        dcPage::closeModule();
+        Page::closeModule();
     }
 }

src/ManageVars.php

@@ -23,16 +23,25 @@ use Exception;
 
 class ManageVars
 {
-    /**
+    /** @var    ManageVars  self instance */
-     * @var ManageVars self instance
-     */
     private static $container;
 
+    /** @var    CleanersStack   The cleaners stack */
     public readonly CleanersStack $cleaners;
+
+    /** @var    null|CleanerParent  The post form cleaner */
     public readonly ?CleanerParent $cleaner;
+
+    /** @var string     $related    The post form related action id */
     public readonly string $related;
+
+    /** @var    array<int,string>   The post form selected ns */
     public readonly array $entries;
+
+    /** @var    string  The post form action id */
     public readonly string $action;
+
+    /** @var    array<string,string>    The form actions combo */
     public readonly array $combo;
 
     protected function __construct()

src/My.php

@@ -15,44 +15,12 @@ declare(strict_types=1);
 namespace Dotclear\Plugin\dcAdvancedCleaner;
 
 use dcCore;
+use Dotclear\Module\MyPlugin;
 
-/**
+class My extends MyPlugin
- * Plugin definitions
- */
-class My
 {
-    /** @var string Required php version */
+    public static function checkCustomContext(int $context): ?bool
-    public const PHP_MIN = '8.1';
-
-    /**
-     * This module id
-     */
-    public static function id(): string
     {
-        return basename(dirname(__DIR__));
+        return $context === self::PREPEND ? dcCore::app()->auth->isSuperAdmin() : null;
-    }
-
-    /**
-     * This module name
-     */
-    public static function name(): string
-    {
-        return __((string) dcCore::app()->plugins->moduleInfo(self::id(), 'name'));
-    }
-
-    /**
-     * This plugin root
-     */
-    public static function root(): string
-    {
-        return dirname(__DIR__);
-    }
-
-    /**
-     * Check php version
-     */
-    public static function phpCompliant(): bool
-    {
-        return version_compare(phpversion(), self::PHP_MIN, '>=');
     }
 }

src/Prepend.php

@@ -14,8 +14,7 @@ declare(strict_types=1);
 
 namespace Dotclear\Plugin\dcAdvancedCleaner;
 
-use dcCore;
+use Dotclear\Core\Process;
-use dcNsProcess;
 use Dotclear\Plugin\activityReport\{
     Action,
     ActivityReport,
@@ -23,20 +22,16 @@ use Dotclear\Plugin\activityReport\{
 };
 use Dotclear\Plugin\Uninstaller\Uninstaller;
 
-class Prepend extends dcNsProcess
+class Prepend extends Process
 {
     public static function init(): bool
     {
-        static::$init = defined('DC_CONTEXT_ADMIN')
+        return self::status(My::checkContext(My::PREPEND));
-            && My::phpCompliant()
-            && dcCore::app()->auth?->isSuperAdmin();
-
-        return static::$init;
     }
 
     public static function process(): bool
     {
-        if (!static::$init) {
+        if (!self::status()) {
             return false;
         }
 

src/Uninstall.php

@@ -15,21 +15,19 @@ declare(strict_types=1);
 namespace Dotclear\Plugin\dcAdvancedCleaner;
 
 use dcCore;
-use dcNsProcess;
+use Dotclear\Core\Process;
 use Dotclear\Plugin\Uninstaller\Uninstaller;
 
-class Uninstall extends dcNsProcess
+class Uninstall extends Process
 {
     public static function init(): bool
     {
-        static::$init = defined('DC_CONTEXT_ADMIN');
+        return self::status(My::checkContext(My::UNINSTALL));
-
-        return static::$init;
     }
 
     public static function process(): bool
     {
-        if (!static::$init || !dcCore::app()->plugins->moduleExists('Uninstaller')) {
+        if (!self::status() || !dcCore::app()->plugins->moduleExists('Uninstaller')) {
             return false;
         }