fix typo

CHANGELOG.md

@@ -1,3 +1,15 @@
+httpPassword 1.5.1 - 2023.11.04
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Fix typo
+
+httpPassword 1.5 - 2023.10.17
+===========================================================
+* Require Dotclear 2.28
+* Require PHP 8.1
+* Upgrade to Dotclear 2.28
+
 httpPassword 1.4 - 2023.08.12
 ===========================================================
 * Require Dotclear 2.27

README.md

@@ -1,25 +1,22 @@
 # README
 
-[![Release](https://img.shields.io/badge/release-1.4-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/httpPassword/releases)
+[![Release](https://img.shields.io/badge/release-1.5.1-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/httpPassword/releases)
-[![Date](https://img.shields.io/badge/date-2023.08.12-c44d58.svg)](https://git.dotclear.watch/JcDenis/httpPassword/releases)
+![Date](https://img.shields.io/badge/date-2023.10.04-c44d58.svg)
 [![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
 [![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/httpPassword)
-[![License](https://img.shields.io/github/license/JcDenis/httpPassword)](https://git.dotclear.watch/JcDenis/httpPassword/blob/master/LICENSE)
+[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/httpPassword/src/branch/master/LICENSE)
 
-## WHAT IS HTTPPASSWORD ?
+## ABOUT
 
-_httpPassword_ is a plugin for the open-source 
+_httpPassword_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
-web publishing software called Dotclear.
 
-Its helps to manage .httppassword files to make a blog private.
+> Help to manage .httppassword files to make a blog private.
 
 ## REQUIREMENTS
 
-_httpPassword_ requires: 
+* Dotclear 2.28
-
+* PHP 8.1+
-* Dotclear 2.27
+* Dotclear write permissions on blogs directories
-* PHP 7.4+
-* Write permissions on blogs directories
 
 ## USAGE
 
@@ -30,14 +27,14 @@ Manage settings, last logins, authorized users from sidebar menu _Http password_
 
 ## LINKS
 
-* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
+* [License](https://git.dotclear.watch/JcDenis/httpPassword/src/branch/master/LICENSE)
-* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/httpPassword) or [GitHub Page](https://github.com/JcDenis/httpPassword)
+* [Packages & details](https://git.dotclear.watch/JcDenis/httpPassword/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/httpPassword))
-* Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/httpPassword/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/httpPassword)
+* [Sources & contributions](https://git.dotclear.watch/JcDenis/httpPassword) (or on [GitHub](https://github.com/JcDenis/httpPassword))
-* Discussion & Help: [Dotclear Forum](http://forum.dotclear.org/viewtopic.php?pid=331158)
+* [Issues & security](https://git.dotclear.watch/JcDenis/httpPassword/issues) (or on [GitHub](https://github.com/JcDenis/httpPassword/issues))
 
 ## CONTRIBUTORS
 
 * Frederic PLE (author)
-* Jean-Christian Denis
+* Jean-Christian Denis (latest)
 
 You are welcome to contribute to this code.

_define.php

@@ -1,32 +1,30 @@
 <?php
 /**
- * @brief httpPassword, a plugin for Dotclear 2
+ * @file
+ * @brief       The plugin httpPassword definition
+ * @ingroup     httpPassword
  *
- * @package Dotclear
+ * @defgroup    httpPassword Plugin httpPassword.
- * @subpackage Plugin
  *
- * @author Frederic PLE and contributors
+ * Manage .htpasswd file to make the blog private.
  *
- * @copyright Jean-Christian Denis
+ * @author      Frederic PLE (author)
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
-if (!defined('DC_RC_PATH')) {
+declare(strict_types=1);
-    return null;
-}
 
 $this->registerModule(
     'Http password',
     'Manage .htpasswd file to make the blog private',
     'Frederic PLE and contributors',
-    '1.4',
+    '1.5.1',
     [
-        'requires'    => [['core', '2.27']],
+        'requires'    => [['core', '2.28']],
-        'permissions' => dcCore::app()->auth->makePermissions([
+        'permissions' => 'My',
-            dcCore::app()->auth::PERMISSION_ADMIN,
+        'type'        => 'plugin',
-        ]),
+        'support'     => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',
-        'type'       => 'plugin',
+        'details'     => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/src/branch/master/README.md',
-        'support'    => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',
+        'repository'  => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/raw/branch/master/dcstore.xml',
-        'details'    => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/src/branch/master/README.md',
-        'repository' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/raw/branch/master/dcstore.xml',
     ]
 );

_init.php

@@ -1,21 +0,0 @@
-<?php
-/**
- * @brief httpPassword, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Frederic PLE and contributors
- *
- * @copyright Jean-Christian Denis
- * @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
- */
-if (!defined('DC_RC_PATH')) {
-    return null;
-}
-
-class initHttpPassword
-{
-    public const PERMISSION    = 'httpPassword';
-    public const FILE_PASSWORD = '.htpasswd';
-}

dcstore.xml

@@ -2,11 +2,11 @@
 <modules xmlns:da="http://dotaddict.org/da/">
   <module id="httpPassword">
     <name>Http password</name>
-    <version>1.4</version>
+    <version>1.5.1</version>
     <author>Frederic PLE and contributors</author>
     <desc>Manage .htpasswd file to make the blog private</desc>
-    <file>https://git.dotclear.watch/JcDenis/httpPassword/releases/download/v1.4/plugin-httpPassword.zip</file>
+    <file>https://git.dotclear.watch/JcDenis/httpPassword/releases/download/v1.5.1/plugin-httpPassword.zip</file>
-    <da:dcmin>2.27</da:dcmin>
+    <da:dcmin>2.28</da:dcmin>
     <da:details>https://git.dotclear.watch/JcDenis/httpPassword/src/branch/master/README.md</da:details>
     <da:support>https://git.dotclear.watch/JcDenis/httpPassword/issues</da:support>
   </module>

src/Backend.php

@@ -1,21 +1,19 @@
 <?php
-/**
+
- * @brief httpPassword, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Frederic PLE 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\httpPassword;
 
 use Dotclear\Core\Process;
 
+/**
+ * @brief       httpPassword backend class.
+ * @ingroup     httpPassword
+ *
+ * @author      Frederic PLE (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

src/Frontend.php

@@ -1,23 +1,20 @@
 <?php
-/**
+
- * @brief httpPassword, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Frederic PLE 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\httpPassword;
 
-use dcCore;
+use Dotclear\App;
-use dcLog;
 use Dotclear\Core\Process;
 
+/**
+ * @brief       httpPassword frontend class.
+ * @ingroup     httpPassword
+ *
+ * @author      Frederic PLE (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Frontend extends Process
 {
     public static function init(): bool
@@ -32,9 +29,8 @@ class Frontend extends Process
         }
 
         // check password on frontend
-        dcCore::app()->addBehavior('publicPrependV2', function (): void {
+        App::behavior()->addBehavior('publicPrependV2', function (): void {
-            // nullsafe
+            if (!App::blog()->isDefined()) {
-            if (is_null(dcCore::app()->blog)) {
                 return;
             }
             $PHP_AUTH_USER = $PHP_AUTH_PW = '';
@@ -44,19 +40,19 @@ class Frontend extends Process
                 $PHP_AUTH_PW   = $_SERVER['PHP_AUTH_PW'];
             } elseif (isset($_ENV['REMOTE_USER'])) {
                 [$PHP_AUTH_PW, $PHP_AUTH_USER] = explode(' ', $_ENV['REMOTE_USER'], 2);
-                [$PHP_AUTH_USER, $PHP_AUTH_PW] = explode(':', base64_decode($PHP_AUTH_USER));
+                [$PHP_AUTH_USER, $PHP_AUTH_PW] = explode(':', base64_decode((string) $PHP_AUTH_USER));
             }
             if ($PHP_AUTH_PW === '' or $PHP_AUTH_USER === '') {
                 Utils::sendHttp401();
             }
 
-            if (!is_file(dcCore::app()->blog->public_path . DIRECTORY_SEPARATOR . My::FILE_PASSWORD)) {
+            if (!is_file(App::blog()->publicPath() . DIRECTORY_SEPARATOR . My::FILE_PASSWORD)) {
                 header('HTTP/1.0 500 Internal Server Error');
                 echo 'httpPassword plugin is not well configured.';
                 exit(1);
             }
 
-            $htpasswd      = file(dcCore::app()->blog->public_path . DIRECTORY_SEPARATOR . My::FILE_PASSWORD, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
+            $htpasswd      = file(App::blog()->publicPath() . DIRECTORY_SEPARATOR . My::FILE_PASSWORD, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
             $authenticated = false;
             if ($htpasswd !== false) {
                 foreach ($htpasswd as $ligne) {
@@ -73,18 +69,18 @@ class Frontend extends Process
             if (!$authenticated) {
                 Utils::sendHttp401();
             } else {
-                $logs = dcCore::app()->log->getLogs(['log_table' => My::id(), 'log_msg' => $PHP_AUTH_USER]);
+                $logs = App::log()->getLogs(['log_table' => My::id(), 'log_msg' => $PHP_AUTH_USER]);
                 if (!$logs->isEmpty()) {
                     $ids = [];
                     while ($logs->fetch()) {
                         $ids[] = is_numeric($logs->f('log_id')) ? (int) $logs->f('log_id') : 0;
                     }
-                    $logs = dcCore::app()->log->delLogs($ids);
+                    App::log()->delLogs($ids);
                 }
-                $cursor = dcCore::app()->con->openCursor(dcCore::app()->prefix . dcLog::LOG_TABLE_NAME);
+                $cursor = App::log()->openLogCursor();
                 $cursor->setField('log_table', My::id());
                 $cursor->setField('log_msg', $PHP_AUTH_USER);
-                dcCore::app()->log->addLog($cursor);
+                App::log()->addLog($cursor);
             }
         });
 

src/Install.php

@@ -1,23 +1,21 @@
 <?php
-/**
+
- * @brief httpPassword, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Frederic PLE 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\httpPassword;
 
-use dcCore;
+use Dotclear\App;
 use Dotclear\Core\Process;
 use Exception;
 
+/**
+ * @brief       httpPassword install class.
+ * @ingroup     httpPassword
+ *
+ * @author      Frederic PLE (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
@@ -40,7 +38,7 @@ class Install extends Process
 
             return true;
         } catch (Exception $e) {
-            dcCore::app()->error->add($e->getMessage());
+            App::error()->add($e->getMessage());
         }
 
         return true;

src/Manage.php

@@ -1,20 +1,10 @@
 <?php
-/**
+
- * @brief httpPassword, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Frederic PLE 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\httpPassword;
 
-use dcCore;
+use Dotclear\App;
 use Dotclear\Core\Backend\{
     Notices,
     Page
@@ -37,7 +27,12 @@ use Dotclear\Helper\Html\Form\{
 };
 
 /**
- * Manage contributions list
+ * @brief       httpPassword manage class.
+ * @ingroup     httpPassword
+ *
+ * @author      Frederic PLE (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
  */
 class Manage extends Process
 {
@@ -48,7 +43,7 @@ class Manage extends Process
 
     public static function process(): bool
     {
-        if (!self::status() || is_null(dcCore::app()->blog)) {
+        if (!self::status() || !App::blog()->isDefined()) {
             return false;
         }
 
@@ -71,7 +66,7 @@ class Manage extends Process
             $s->put('crypt', in_array((string) $_POST['crypt'], My::cryptCombo()) ? $_POST['crypt'] : 'paintext');
             $s->put('message', (string) $_POST['message']);
 
-            dcCore::app()->blog->triggerBlog();
+            App::blog()->triggerBlog();
 
             Notices::addSuccessNotice(
                 __('Settings successfully updated.')
@@ -82,13 +77,13 @@ class Manage extends Process
 
         // delete users logins
         if ('savelogins' == $action) {
-            $logs = dcCore::app()->log->getLogs(['log_table' => My::id()]);
+            $logs = App::log()->getLogs(['log_table' => My::id()]);
             if (!$logs->isEmpty()) {
                 $ids = [];
                 while ($logs->fetch()) {
                     $ids[] = $logs->__get('log_id');
                 }
-                $logs = dcCore::app()->log->delLogs($ids);
+                App::log()->delLogs($ids);
 
                 Notices::addSuccessNotice(
                     __('Logs successfully cleared.')
@@ -130,7 +125,7 @@ class Manage extends Process
             }
             file_put_contents(Utils::passwordFile(), $contents);
 
-            dcCore::app()->blog->triggerBlog();
+            App::blog()->triggerBlog();
 
             Notices::addSuccessNotice(
                 __('Logins successfully updated.')
@@ -144,7 +139,7 @@ class Manage extends Process
 
     public static function render(): void
     {
-        if (!self::status() || is_null(dcCore::app()->blog)) {
+        if (!self::status() || !App::blog()->isDefined()) {
             return;
         }
 
@@ -195,7 +190,7 @@ class Manage extends Process
                 // message
                 (new Para())->items([
                     (new Label(__('Authentication message:')))->for('message'),
-                    (new Input('message'))->size(60)->maxlenght(255)->value(Utils::httpMessage()),
+                    (new Input('message'))->size(60)->maxlength(255)->value(Utils::httpMessage()),
                 ]),
                 (new Div())->class('clear')->items([
                     (new Submit(['save']))->value(__('Save')),
@@ -207,7 +202,7 @@ class Manage extends Process
 
         // delete logins form
         if ('logins' == $part) {
-            $logs = dcCore::app()->log->getLogs(['log_table' => My::id()]);
+            $logs = App::log()->getLogs(['log_table' => My::id()]);
             if ($logs->isEmpty()) {
                 echo
                 '<p>' . __('Logins history is empty.') . '</p>';
@@ -260,7 +255,7 @@ class Manage extends Process
                         Html::escapeHTML($login) .
                     '</td>' .
                     '<td class="nowrap">' .
-                        (new Input(['newpassword[' . Html::escapeHTML($login) . ']']))->size(60)->maxlenght(255)->render() .
+                        (new Input(['newpassword[' . Html::escapeHTML($login) . ']']))->size(60)->maxlength(255)->render() .
                     '</td>' .
                     '<td class="nowrap">' .
                         (new Submit(['edit[' . Html::escapeHTML($login) . ']']))->value(__('Change password'))->render() .
@@ -297,12 +292,12 @@ class Manage extends Process
                 // login
                 (new Para())->items([
                     (new Label(__('Login:')))->for('login'),
-                    (new Input('login'))->size(60)->maxlenght(255),
+                    (new Input('login'))->size(60)->maxlength(255),
                 ]),
                 // password
                 (new Para())->items([
                     (new Label(__('Password:')))->for('password'),
-                    (new Input('password'))->size(60)->maxlenght(255),
+                    (new Input('password'))->size(60)->maxlength(255),
                 ]),
                 (new Para())->items([
                     (new Submit(['add']))->value(__('Save')),

src/My.php

@@ -1,15 +1,5 @@
 <?php
-/**
+
- * @brief httpPassword, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Frederic PLE 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\httpPassword;
@@ -17,11 +7,20 @@ namespace Dotclear\Plugin\httpPassword;
 use Dotclear\Module\MyPlugin;
 
 /**
- * This module definitions.
+ * @brief       httpPassword My helper.
+ * @ingroup     httpPassword
+ *
+ * @author      Frederic PLE (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  Passwords file name */
+    /**
+     * Passwords file name.
+     *
+     * @var     string  FILE_PASSWORD
+     */
     public const FILE_PASSWORD = '.htpasswd';
 
     /**

src/Uninstall.php

@@ -1,23 +1,20 @@
 <?php
-/**
+
- * @brief httpPassword, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Frederic PLE 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\httpPassword;
 
-use dcCore;
 use Dotclear\Core\Process;
 use Dotclear\Plugin\Uninstaller\Uninstaller;
 
+/**
+ * @brief       httpPassword uninstall class.
+ * @ingroup     httpPassword
+ *
+ * @author      Frederic PLE (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
@@ -27,7 +24,7 @@ class Uninstall extends Process
 
     public static function process(): bool
     {
-        if (!self::status() || !dcCore::app()->plugins->moduleExists('Uninstaller')) {
+        if (!self::status()) {
             return false;
         }
 

src/Utils.php

@@ -1,21 +1,19 @@
 <?php
-/**
+
- * @brief httpPassword, a plugin for Dotclear 2
- *
- * @package Dotclear
- * @subpackage Plugin
- *
- * @author Frederic PLE 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\httpPassword;
 
-use dcCore;
+use Dotclear\App;
 
+/**
+ * @brief       httpPassword utils.
+ * @ingroup     httpPassword
+ *
+ * @author      Frederic PLE (author)
+ * @author      Jean-Christian Denis (latest)
+ * @copyright   GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
+ */
 class Utils
 {
     /**
@@ -71,7 +69,7 @@ class Utils
 
         if ($saltlen > 0) {
             $salt .= substr(
-                sha1(dcCore::app()->getNonce() . date('U')),
+                sha1(App::nonce()->getNonce() . date('U')),
                 2,
                 $saltlen - strlen($salt)
             );
@@ -118,7 +116,7 @@ class Utils
      */
     public static function passwordFile(): string
     {
-        return is_null(dcCore::app()->blog) ? '' : dcCore::app()->blog->public_path . DIRECTORY_SEPARATOR . My::FILE_PASSWORD;
+        return App::blog()->isDefined() ? App::blog()->publicPath() . DIRECTORY_SEPARATOR . My::FILE_PASSWORD : '';
     }
 
     /**