cosmetic

CHANGELOG.md

@@ -1,3 +1,16 @@
+myUrlHandlers 2023.10.22
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Use default permissions and update to admin only
+* Code review (phpstan)
+
+myUrlHandlers 2023.10.11
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Code review
+
 myUrlHandlers 2023.10.07
 ===========================================================
 * Require Dotclear 2.28

README.md

@@ -1,8 +1,8 @@
 # README
 
-[![Release](https://img.shields.io/badge/release-2023.08.13-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/myUrlHandlers/releases)
-![Date](https://img.shields.io/badge/date-2023.08.13-c44d58.svg)
-[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
+[![Release](https://img.shields.io/badge/release-2023.10.22-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/myUrlHandlers/releases)
+![Date](https://img.shields.io/badge/date-2023.10.22-c44d58.svg)
+[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download)
 [![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/myUrlHandlers)
 [![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/myUrlHandlers/src/branch/master/LICENSE)
 
@@ -10,13 +10,13 @@
 
 _myUrlHandlers_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
 
-> You can change public URL of each Dotclear parts, like post, category, etc and some plugins having public parts.
+> Change public URL of each Dotclear parts, like post, category, etc and some plugins having public parts.
 
 ## REQUIREMENTS
 
-* contentadmin permissions for management
 * Dotclear 2.28
 * PHP 8.1+
+* Dotclear admin permissions for management
 
 ## USAGE
 
@@ -36,8 +36,8 @@ or you can add dashboard icon.
 
 ## CONTRIBUTORS
 
-* Alex pirine (First author)
+* Alex pirine (Author)
 * te2dy
-* Jean-Christian Denis
+* Jean-Christian Denis (latest)
 
 You are welcome to contribute to this code.

_define.php

@@ -1,27 +1,28 @@
 <?php
 /**
- * @brief myUrlHandlers, a plugin for Dotclear 2
+ * @file
+ * @brief       The plugin myUrlHandlers definition
+ * @ingroup     myUrlHandlers
  *
- * @package Dotclear
- * @subpackage Plugin
+ * @defgroup    myUrlHandlers Plugin myUrlHandlers.
+ *
+ * Change Dotclear URL handlers.
  *
  * @author      Alex Pirine and contributors
- *
- * @copyright Jean-Christian Denis
+ * @author      Jean-Christian Denis
+ * @copyright   Alex Pirine
  * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-use Dotclear\App;
+declare(strict_types=1);
 
 $this->registerModule(
     'URL handlers',
     'Change Dotclear URL handlers',
     'Alex Pirine and contributors',
-    '2023.08.13',
+    '2023.10.11',
     [
         'requires'    => [['core', '2.28']],
-        'permissions' => App::auth()->makePermissions([
-            App::auth()::PERMISSION_CONTENT_ADMIN,
-        ]),
+        'permissions' => 'My',
         'priority'    => 150000,
         'type'        => 'plugin',
         'support'     => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',

dcstore.xml

@@ -2,11 +2,11 @@
 <modules xmlns:da="http://dotaddict.org/da/">
   <module id="myUrlHandlers">
     <name>URL handlers</name>
-    <version>2023.08.13</version>
+    <version>2023.10.22</version>
     <author>Alex Pirine and contributors</author>
     <desc>Change Dotclear URL handlers</desc>
-    <file>https://github.com/JcDenis/myUrlHandlers/releases/download/v2023.08.13/plugin-myUrlHandlers.zip</file>
-    <da:dcmin>2.27</da:dcmin>
+    <file>https://git.dotclear.watch/JcDenis/myUrlHandlers/releases/download/v2023.10.22/plugin-myUrlHandlers.zip</file>
+    <da:dcmin>2.28</da:dcmin>
     <da:details>https://git.dotclear.watch/JcDenis/myUrlHandlers/src/branch/master/README.md</da:details>
     <da:support>https://git.dotclear.watch/JcDenis/myUrlHandlers/issues</da:support>
   </module>

src/Backend.php

@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief myUrlHandlers, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Alex Pirine 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\myUrlHandlers;
@@ -18,6 +8,14 @@ use Dotclear\App;
 use Dotclear\Core\Process;
 use Dotclear\Core\Backend\Favorites;
 
+/**
+ * @brief       myUrlHandlers backend class.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Backend extends Process
 {
     public static function init(): bool
@@ -40,7 +38,7 @@ class Backend extends Process
                 'url'         => My::manageUrl(),
                 'small-icon'  => My::icons(),
                 'large-icon'  => My::icons(),
-                'permissions' => App::auth()->makePermissions([App::auth()::PERMISSION_CONTENT_ADMIN]),
+                'permissions' => App::auth()->makePermissions([App::auth()::PERMISSION_ADMIN]),
             ]);
         });
 

src/Install.php

@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief myUrlHandlers, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Alex Pirine 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\myUrlHandlers;
@@ -17,6 +7,14 @@ namespace Dotclear\Plugin\myUrlHandlers;
 use Dotclear\App;
 use Dotclear\Core\Process;
 
+/**
+ * @brief       myUrlHandlers installation class.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Install extends Process
 {
     public static function init(): bool

src/Manage.php

@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief myUrlHandlers, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Alex Pirine 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\myUrlHandlers;
@@ -26,7 +16,12 @@ use Dotclear\Helper\Text;
 use Exception;
 
 /**
- * Manage contributions list
+ * @brief       myUrlHandlers manage class.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
 class Manage extends Process
 {
@@ -51,14 +46,14 @@ class Manage extends Process
                     if (empty($handlers[$name])) {
                         throw new Exception(sprintf(
                             __('Uknown handler "%s".'),
-                            Html::escapeHTML($name)
+                            Html::escapeHTML((string) $name)
                         ));
                     }
 
                     if (empty($url)) {
                         throw new Exception(sprintf(
                             __('Invalid URL for handler "%s".'),
-                            Html::escapeHTML($name)
+                            Html::escapeHTML((string) $name)
                         ));
                     }
 

src/My.php

@@ -1,23 +1,27 @@
 <?php
-/**
- * @brief myUrlHandlers, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Alex Pirine 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\myUrlHandlers;
 
 use Dotclear\Module\MyPlugin;
 
+/**
+ * @brief       myUrlHandlers My helper.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class My extends MyPlugin
 {
-    /** @var    string  This module settings ID */
+    /**
+     * This module settings ID.
+     *
+     * @var     string  NS_SETTING_ID
+     */
     public const NS_SETTING_ID = 'handlers';
+
+    // Use default permissions
 }

src/MyUrlHandlers.php

@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief myUrlHandlers, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Alex Pirine 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\myUrlHandlers;
@@ -17,52 +7,66 @@ namespace Dotclear\Plugin\myUrlHandlers;
 use Dotclear\App;
 use Dotclear\Core\PostType;
 
+/**
+ * @brief       myUrlHandlers main class.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class MyUrlHandlers
 {
     /**
-     * The default URLs handlers.
+     * The URLs stack.
      *
-     * @var     array<string,array<string,string>>  $defaults
+     * @var     UrlStack    $stack
      */
-    private static array $defaults = [];
+    private static UrlStack $stack;
 
     /**
      * The posts types URLs.
      *
-     * @var     array<string,string>    $url2post
+     * @var     array<string, string>   $pt_public2type
      */
-    private static array $url2post = [];
+    private static array $pt_public2type = [];
 
     /**
      * The posts types admin URLs.
      *
-     * @var     array<string,string>    $post_adm_url
+     * @var     array<string, string>   $pt_type2admin
      */
-    private static array $post_adm_url = [];
+    private static array $pt_type2admin = [];
 
     /**
      * Initialize handlers list.
      */
     public static function init(): void
     {
+        self::$stack = new UrlStack();
+
         # Set defaults
         foreach (App::url()->getTypes() as $k => $v) {
             if (empty($v['url'])) {
                 continue;
             }
 
-            $p                   = '/' . preg_quote($v['url'], '/') . '/';
             $v['representation'] = str_replace('%', '%%', $v['representation']);
-            $v['representation'] = preg_replace($p, '%s', $v['representation'], 1, $c);
+            $v['representation'] = preg_replace('/' . preg_quote($v['url'], '/') . '/', '%s', $v['representation'], 1, $c);
 
-            if ($c) {
-                self::$defaults[$k] = $v;
+            if ($c && is_string($v['representation'])) {
+                self::$stack->set(new UrlDescriptor(
+                    $k,
+                    $v['url'],
+                    $v['representation'],
+                    $v['handler'] ?? null
+                ));
             }
         }
 
         foreach (App::postTypes()->dump() as $pt) {
-            self::$url2post[$pt->public_url] = $pt->type;
-            self::$post_adm_url[$pt->type]   = $pt->admin_url;
+            self::$pt_public2type[$pt->public_url] = $pt->type;
+            self::$pt_type2admin[$pt->type]        = $pt->admin_url;
         }
 
         # Read user settings
@@ -79,27 +83,29 @@ class MyUrlHandlers
      */
     public static function overrideHandler(string $name, string $url): void
     {
-        if (!isset(self::$defaults[$name])) {
+        $desc = self::$stack->get($name);
+        if (is_null($desc->handler())) {
             return;
         }
 
         App::url()->register(
             $name,
             $url,
-            sprintf(self::$defaults[$name]['representation'], $url),
-            self::$defaults[$name]['handler']
+            sprintf($desc->representation, $url),
+            $desc->handler()
         );
 
-        $k = self::$url2post[self::$defaults[$name]['url'] . '/%s'] ?? '';
+        $type = self::$pt_public2type[$desc->url . '/%s'] ?? '';
+        if (!$type) {
+            return;
+        }
 
-        if ($k) {
         App::postTypes()->set(new PostType(
-                $k,
-                self::$post_adm_url[$k],
+            $type,
+            self::$pt_type2admin[$type],
             App::url()->getBase($name) . '/%s'
         ));
     }
-    }
 
     /**
      * Get default URLs handlers.
@@ -109,8 +115,8 @@ class MyUrlHandlers
     public static function getDefaults(): array
     {
         $res = [];
-        foreach (self::$defaults as $k => $v) {
-            $res[$k] = $v['url'];
+        foreach (self::$stack->dump() as $v) {
+            $res[$v->id] = $v->url;
         }
 
         return $res;

src/Prepend.php

@@ -1,21 +1,19 @@
 <?php
-/**
- * @brief myUrlHandlers, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Alex Pirine 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\myUrlHandlers;
 
 use Dotclear\Core\Process;
 
+/**
+ * @brief       myUrlHandlers prepend class.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Prepend extends Process
 {
     public static function init(): bool

src/Uninstall.php

@@ -1,15 +1,5 @@
 <?php
-/**
- * @brief myUrlHandlers, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Alex Pirine 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\myUrlHandlers;
@@ -17,6 +7,14 @@ namespace Dotclear\Plugin\myUrlHandlers;
 use Dotclear\Core\Process;
 use Dotclear\Plugin\Uninstaller\Uninstaller;
 
+/**
+ * @brief       myUrlHandlers uninstall class.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Uninstall extends Process
 {
     public static function init(): bool

src/UrlDescriptor.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dotclear\Plugin\myUrlHandlers;
+
+/**
+ * @brief       myUrlHandlers URL descriptor class.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
+class UrlDescriptor
+{
+    /**
+     * URL handler callback.
+     *
+     * @var     ?callable   $handler
+     */
+    private $handler = null;
+
+    /**
+     * Constructor.
+     *
+     * @param   string      $id                 The ID
+     * @param   string      $url                The URL
+     * @param   string      $representation     The representation
+     * @param   ?callable   $handler            The callback
+     */
+    public function __construct(
+        public readonly string $id,
+        public readonly string $url = '',
+        public readonly string $representation = '',
+        ?callable $handler = null,
+    ) {
+        // As PHP does not support callable property type.
+        $this->handler = $handler;
+    }
+
+    /**
+     * Get handler.
+     *
+     * @return  ?callable   The handler
+     */
+    public function handler(): ?callable
+    {
+        return $this->handler;
+    }
+}

src/UrlStack.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Dotclear\Plugin\myUrlHandlers;
+
+/**
+ * @brief       myUrlHandlers URL descriptor stack class.
+ * @ingroup     myUrlHandlers
+ *
+ * @author      Alex Pirine (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
+class UrlStack
+{
+    /**
+     * The stack of URL descriptors.
+     *
+     * @var     array<string, UrlDescriptor>
+     */
+    private array $stack = [];
+
+    /**
+     * Check if an handler is set.
+     *
+     * @param   string  $id     The handler ID
+     *
+     * @return  bool    True if it exists
+     */
+    public function has(string $id): bool
+    {
+        return array_key_exists($id, $this->stack);
+    }
+
+    /**
+     * Set an URL handler.
+     *
+     * @param   UrlDescriptor   $descriptor     The URL descriptor
+     */
+    public function set(UrlDescriptor $descriptor): void
+    {
+        $this->stack[$descriptor->id] = $descriptor;
+    }
+
+    /**
+     * Get an URL handler.
+     *
+     * If it does not exist, return an empty handler.
+     *
+     * @param   string  $id     The handler ID
+     *
+     * @return  UrlDescriptor   The URL descriptor
+     */
+    public function get(string $id): UrlDescriptor
+    {
+        return $this->stack[$id] ?? new UrlDescriptor($id);
+    }
+
+    /**
+     * Get URLs stack.
+     *
+     * @return  array<string, UrlDescriptor>
+     */
+    public function dump()
+    {
+        return $this->stack;
+    }
+}