release 2023.11.04

cosmetic code review and typo
maybe better permissions check
2023-11-04 20:34:18 +01:00 · 2023-11-04 20:33:00 +01:00 · 2023-10-21 22:48:54 +02:00 · 2023-10-19 21:53:53 +02:00
15 changed files with 113 additions and 77 deletions
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@ -1,3 +1,16 @@
+pacKman 2023.11.04
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1+
+* Fix typo
+* Code review
+
+pacKman 2023.10.19
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1+
+* cosmetic code review
+
 pacKman 2023.10.13
 ===========================================================
 * Require Dotclear 2.28
--- a/README.md
+++ b/README.md
@ -1,7 +1,7 @@
 # README

-[![Release](https://img.shields.io/badge/release-2023.10.13-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/pacKman/releases)
-![Date](https://img.shields.io/badge/date-2023.10.13-c44d58.svg)
+[![Release](https://img.shields.io/badge/release-2023.11.04-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/pacKman/releases)
+![Date](https://img.shields.io/badge/date-2023.11.04-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/pacKman)
 [![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/pacKman/src/branch/master/LICENSE)
@ -16,9 +16,9 @@ _pacKman_ is a plugin for the open-source web publishing software called [Dotcle

 * Dotclear 2.28
 * PHP 8.1+
-* Super administrator permissions
-* A writable cache directory 
-* A writable directory to put packages. (can be VAR dir)
+* Dotclear super administrator permissions
+* System writable cache directory 
+* System writable directory to put packages. (can be VAR dir)

 ## USAGE

@ -37,11 +37,11 @@ Once it's done you can manage your packages from menu
 * [Packages & details](https://git.dotclear.watch/JcDenis/pacKman/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/pacKman))
 * [Sources & contributions](https://git.dotclear.watch/JcDenis/pacKman) (or on [GitHub](https://github.com/JcDenis/pacKman))
 * [Issues & security](https://git.dotclear.watch/JcDenis/pacKman/issues) (or on [GitHub](https://github.com/JcDenis/pacKman/issues))
-* [Discuss and help](https://forum.dotclear.org/viewtopic.php?id=40066)
+* [Discuss & help](https://forum.dotclear.org/viewtopic.php?id=40066)

 ## CONTRIBUTORS

-* Jean-Christian Denis
+* Jean-Christian Denis (author)
 * Philippe aka Dissitou
 * franck-paul

--- a/_define.php
+++ b/_define.php
@ -9,7 +9,6 @@
 * Manage your Dotclear packages.
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 declare(strict_types=1);
@ -18,9 +17,10 @@ $this->registerModule(
    'Packages repository',
    'Manage your Dotclear packages',
    'Jean-Christian Denis',
-    '2023.10.13',
+    '2023.11.04',
    [
        'requires'    => [['core', '2.28']],
+        'permissions' => 'My',
        'type'        => 'plugin',
        'support'     => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',
        'details'     => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/src/branch/master/README.md',
--- a/dcstore.xml
+++ b/dcstore.xml
@ -2,10 +2,10 @@
 <modules xmlns:da="http://dotaddict.org/da/">
  <module id="pacKman">
    <name>Packages repository</name>
-    <version>2023.10.13</version>
+    <version>2023.11.04</version>
    <author>Jean-Christian Denis</author>
    <desc>Manage your Dotclear packages</desc>
-    <file>https://git.dotclear.watch/JcDenis/pacKman/releases/download/v2023.10.13/plugin-pacKman.zip</file>
+    <file>https://git.dotclear.watch/JcDenis/pacKman/releases/download/v2023.11.04/plugin-pacKman.zip</file>
    <da:dcmin>2.28</da:dcmin>
    <da:details>https://git.dotclear.watch/JcDenis/pacKman/src/branch/master/README.md</da:details>
    <da:support>https://git.dotclear.watch/JcDenis/pacKman/issues</da:support>
--- a/locales/fr/resources.php
+++ b/locales/fr/resources.php
@ -1,19 +1,10 @@
 <?php
 /**
- * @brief pacKman, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
+ * @file
+ * @brief       The plugin pacKman locales resources
+ * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- *
- * @copyright Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
-if (!defined('DC_RC_PATH')) {
-    return null;
-}
-
-if (!isset(dcCore::app()->resources['help']['pacKman'])) {
-    dcCore::app()->resources['help']['pacKman'] = __DIR__ . '/help/help.html';
-}
+\Dotclear\App::backend()->resources()->set('help', 'pacKman', __DIR__ . '/help/help.html');
--- a/src/Backend.php
+++ b/src/Backend.php
@ -13,7 +13,6 @@ use Dotclear\Core\Backend\Favorites;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Backend extends Process
--- a/src/Config.php
+++ b/src/Config.php
@ -25,7 +25,6 @@ use Exception;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Config extends Process
@ -112,7 +111,7 @@ class Config extends Process
                // pack_repository
                (new Para())->items([
                    (new Label($check_repo . __('Path to repository:')))->for('pack_repository'),
-                    (new Input('pack_repository'))->class('maximal')->size(65)->maxlenght(255)->value($s->pack_repository),
+                    (new Input('pack_repository'))->class('maximal')->size(65)->maxlength(255)->value($s->pack_repository),
                ]),
                (new Note())->class('form-note')->text(
                    sprintf(
@ -132,13 +131,13 @@ class Config extends Process
                // pack_filename
                (new Para())->items([
                    (new Label($check_first . __('Name of exported package:')))->for('pack_filename'),
-                    (new Input('pack_filename'))->class('maximal')->size(65)->maxlenght(255)->value($s->pack_filename),
+                    (new Input('pack_filename'))->class('maximal')->size(65)->maxlength(255)->value($s->pack_filename),
                ]),
                (new Note())->text(sprintf(__('Preconization: %s'), '%type%-%id%'))->class('form-note'),
                // secondpack_filename
                (new Para())->items([
                    (new Label($check_second . __('Name of second exported package:')))->for('secondpack_filename'),
-                    (new Input('secondpack_filename'))->class('maximal')->size(65)->maxlenght(255)->value($s->secondpack_filename),
+                    (new Input('secondpack_filename'))->class('maximal')->size(65)->maxlength(255)->value($s->secondpack_filename),
                ]),
                (new Note())->text(sprintf(__('Preconization: %s'), '%type%-%id%-%version%'))->class('form-note'),
                // pack_overwrite
@ -151,7 +150,7 @@ class Config extends Process
                // pack_excludefiles
                (new Para())->items([
                    (new Label(__('Extra files to exclude from package:')))->for('pack_excludefiles'),
-                    (new Input('pack_excludefiles'))->class('maximal')->size(65)->maxlenght(255)->value($s->pack_excludefiles),
+                    (new Input('pack_excludefiles'))->class('maximal')->size(65)->maxlength(255)->value($s->pack_excludefiles),
                ]),
                (new Note())->text(sprintf(__('Preconization: %s'), '*.zip,*.tar,*.tar.gz'))->class('form-note'),
                // pack_nocomment
--- a/src/Core.php
+++ b/src/Core.php
@ -16,7 +16,6 @@ use Exception;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Core
--- a/src/Install.php
+++ b/src/Install.php
@ -13,7 +13,6 @@ use Exception;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Install extends Process
--- a/src/Manage.php
+++ b/src/Manage.php
@ -23,7 +23,6 @@ use Exception;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Manage extends Process
--- a/src/My.php
+++ b/src/My.php
@ -12,7 +12,6 @@ use Dotclear\Module\MyPlugin;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class My extends MyPlugin
@ -37,7 +36,10 @@ class My extends MyPlugin

    public static function checkCustomContext(int $context): ?bool
    {
-        // Only backend and super admin
-        return $context === self::INSTALL ? null : App::task()->checkContext('BACKEND') && App::auth()->isSuperAdmin();
+        return match ($context) {
+            // Limit to super admin
+            self::MODULE => App::auth()->isSuperAdmin(),
+            default      => null,
+        };
    }
 }
--- a/src/Settings.php
+++ b/src/Settings.php
@ -9,36 +9,71 @@ namespace Dotclear\Plugin\pacKman;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Settings
 {
-    // Remove comments from files
+    /**
+     * Remove comments from files.
+     *
+     * @var     bool   $pack_nocomment
+     */
    public readonly bool $pack_nocomment;

-    // Remove comments from files
+    /**
+     * Remove comments from files.
+     *
+     * @var     bool    $pack_fixnewline
+     */
    public readonly bool $pack_fixnewline;

-    // Overwrite existing package
+    /**
+     * Overwrite existing package.
+     *
+     * @var     bool    $pack_overwrite
+     */
    public readonly bool $pack_overwrite;

-    // Name of package
+    /**
+     * Name of package.
+     *
+     * @var     string  $pack_filename
+     */
    public readonly string $pack_filename;

-    // Name of second package
+    /**
+     * Name of second package.
+     *
+     * @var     string  $secondpack_filename
+     */
    public readonly string $secondpack_filename;

-    // Path to package repository
+    /**
+     * Path to package repository.
+     *
+     * @var     string  $pack_repository
+     */
    public readonly string $pack_repository;

-    // Seperate themes and plugins repository
+    /**
+     * Seperate themes and plugins repository.
+     *
+     * @var     bool    $pack_typedrepo
+     */
    public readonly bool $pack_typedrepo;

-    // Extra files to exclude from package
+    /**
+     * Extra files to exclude from package.
+     *
+     * @var     string  $pack_excludefiles
+     */
    public readonly string $pack_excludefiles;

-    // Hide distributed modules from lists
+    /**
+     * Hide distributed modules from lists.
+     *
+     * @var     bool    $hide_distrib
+     */
    public readonly bool $hide_distrib;

    /**
--- a/src/Uninstall.php
+++ b/src/Uninstall.php
@ -12,7 +12,6 @@ use Dotclear\Plugin\Uninstaller\Uninstaller;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Uninstall extends Process
--- a/src/Utils.php
+++ b/src/Utils.php
@ -29,7 +29,6 @@ use Exception;
 * @ingroup     pacKman
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Utils
@ -99,7 +98,7 @@ class Utils
    /**
     * Get modules list form.
     *
-     * @param   array<int,ModuleDefine>     $modules    The modules
+     * @param   array<int|string, mixed>    $modules    The modules
     * @param   string                      $type       The modules type
     * @param   string                      $title      The list title
     *
@ -117,6 +116,9 @@ class Utils
        $tbody = [];
        self::sort($modules);
        foreach ($modules as $module) {
+            if (!is_a($module, ModuleDefine::class)) {
+                continue;
+            }
            $tbody[] = (new Para(null, 'tr'))
                ->class('line')
                ->items([
--- a/src/Zip.php
+++ b/src/Zip.php
@ -12,7 +12,6 @@ namespace Dotclear\Plugin\pacKman;
 * to tweak writeFile method.
 *
 * @author      Jean-Christian Denis
- * @copyright   Jean-Christian Denis
 * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
 */
 class Zip extends \Dotclear\Helper\File\Zip\Zip
Author	SHA1	Message	Date
Jean-Christian Denis	6a11d1aff6	release 2023.11.04	2023-11-04 20:34:18 +01:00
Jean-Christian Denis	616175eef5	cosmetic code review and typo	2023-11-04 20:33:00 +01:00
Jean-Christian Denis	f2a5aa0179	maybe better permissions check	2023-10-21 22:48:54 +02:00
Jean-Christian Denis	b360dc199f	cosmetic code review	2023-10-19 21:53:53 +02:00