JcDenis/dcLog
1
0
Fork 0
Code Issues Pull Requests Releases 5 Activity

Compare commits

base: JcDenis:master
Branches Tags
JcDenis:master
JcDenis:v1.7.3
JcDenis:v1.7.2
JcDenis:v1.7.1
JcDenis:v1.7
JcDenis:v1.6
..
compare: JcDenis:v1.6
Branches Tags
JcDenis:master
JcDenis:v1.7.3
JcDenis:v1.7.2
JcDenis:v1.7.1
JcDenis:v1.7
JcDenis:v1.6

No commits in common. "master" and "v1.6" have entirely different histories.
master ... v1.6

9 changed files with 126 additions and 161 deletions
Show Stats Expand all files Collapse all files

24
CHANGELOG.md
View File

@ -1,27 +1,3 @@
dcLog 1.7.3 - 2023.11.04
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Cosmetic code doc
dcLog 1.7.2 - 2023.10.13
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Upgrade to last minute change to Dotclear 2.28
dcLog 1.7.1 - 2023.10.11
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Code review
dcLog 1.7 - 2023.10.07
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Upgrade to Dotclear 2.28
dcLog 1.6 - 2023.08.14
===========================================================
* Require Dotclear 2.27

30
README.md
View File

@ -1,22 +1,25 @@
# README
[![Release](https://img.shields.io/badge/release-1.7.3-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/dcLog/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)
[![Release](https://img.shields.io/badge/release-1.6-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/dcLog/releases)
[![Date](https://img.shields.io/badge/date-2023.08.14-c44d58.svg)](https://git.dotclear.watch/JcDenis/dcLog/releases)
[![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/dcLog)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/dcLog/src/branch/master/LICENSE)
[![License](https://img.shields.io/github/license/JcDenis/dcLog)](https://git.dotclear.watch/JcDenis/dcLog/blob/master/LICENSE)
## ABOUT
## WHAT IS DCLOG ?
_dcLog_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
_dcLog_ is a plugin for the open-source
web publishing software called Dotclear.
> Display dotclear's logs.
Display dotclear's logs.
## REQUIREMENTS
_dcLog_ requires:
* PHP 8.1+
* Dotclear 2.28
* Dotclear super admin permission
* Dotclear 2.27
* super admin permission
## USAGE
@ -28,14 +31,13 @@ Once it's done you can manage your logs from menu
## LINKS
* [License](https://git.dotclear.watch/JcDenis/dcLog/src/branch/master/LICENSE)
* [Packages & details](https://git.dotclear.watch/JcDenis/dcLog/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/dcLog))
* [Sources & contributions](https://git.dotclear.watch/JcDenis/dcLog) (or on [GitHub](https://github.com/JcDenis/dcLog))
* [Issues & security](https://git.dotclear.watch/JcDenis/dcLog/issues) (or on [GitHub](https://github.com/JcDenis/dcLog/issues))
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/dcLog) or [GitHub Page](https://github.com/JcDenis/dcLog)
* Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/dcLog/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/dcLog)
## CONTRIBUTORS
* Tomtom (author)
* Jean-Christian Denis (latest)
* Jean-Christian Denis
You are welcome to contribute to this code.

25
_define.php
View File

@ -1,26 +1,29 @@
<?php
/**
* @file
* @brief The plugin dcLog definition
* @ingroup dcLog
* @brief dcLog, a plugin for Dotclear 2
*
* @defgroup dcLog Plugin dcLog.
* @package Dotclear
* @subpackage Plugin
*
* Displays Dotclear logs.
* @author Tomtom and Contributors
*
* @author Tomtom (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
if (!defined('DC_RC_PATH')) {
return null;
}
$this->registerModule(
"Dotclear's logs",
'Displays Dotclear logs',
'Tomtom and Contributors',
'1.7.3',
'1.6',
[
'requires' => [['core', '2.28']],
'requires' => [
['php', '8.1'],
['core', '2.27'],
],
'permissions' => null,
'type' => 'plugin',
'support' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',

6
dcstore.xml
View File

@ -2,11 +2,11 @@
<modules xmlns:da="http://dotaddict.org/da/">
<module id="dcLog">
<name>Dotclear's logs</name>
<version>1.7.3</version>
<version>1.6</version>
<author>Tomtom and Contributors</author>
<desc>Displays Dotclear logs</desc>
<file>https://git.dotclear.watch/JcDenis/dcLog/releases/download/v1.7.3/plugin-dcLog.zip</file>
<da:dcmin>2.28</da:dcmin>
<file>https://git.dotclear.watch/JcDenis/dcLog/releases/download/v1.6/plugin-dcLog.zip</file>
<da:dcmin>2.27</da:dcmin>
<da:details>https://git.dotclear.watch/JcDenis/dcLog/src/branch/master/README.md</da:details>
<da:support>https://git.dotclear.watch/JcDenis/dcLog/issues</da:support>
</module>

27
src/Backend.php
View File

@ -1,22 +1,25 @@
<?php
/**
* @brief dcLog, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Tomtom 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\dcLog;
use ArrayObject;
use Dotclear\App;
use dcCore;
use Dotclear\Core\Process;
use Dotclear\Core\Backend\Favorites;
use Dotclear\Core\Backend\Menus;
/**
* @brief dcLog backend class.
* @ingroup dcLog
*
* @author Tomtom (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
@ -30,9 +33,9 @@ class Backend extends Process
return false;
}
My::addBackendMenuItem(App::backend()->menus()::MENU_SYSTEM);
My::addBackendMenuItem(Menus::MENU_SYSTEM);
App::behavior()->addBehaviors([
dcCore::app()->addBehaviors([
// backend user preference for logs list columns
'adminColumnsListsV2' => function (ArrayObject $cols): void {
$cols[My::BACKEND_LIST_ID] = [

37
src/BackendList.php
View File

@ -1,5 +1,15 @@
<?php
/**
* @brief dcLog, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Tomtom 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\dcLog;
@ -20,12 +30,7 @@ use Dotclear\Helper\Html\Form\{
};
/**
* @brief dcLog logs list class.
* @ingroup dcLog
*
* @author Tomtom (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
* Backend logs list helper.
*/
class BackendList extends Listing
{
@ -48,7 +53,7 @@ class BackendList extends Listing
return;
}
$pager = new Pager($page, (int) $this->rs_count, $nb_per_page, 10);
$pager = new Pager($page, $this->rs_count, $nb_per_page, 10);
$cols = new ArrayObject([
'date' => (new Text('th', __('Date')))
@ -69,7 +74,7 @@ class BackendList extends Listing
$lines = [];
while ($this->rs->fetch()) {
$lines[] = $this->line(isset($_POST['entries']) && in_array($this->rs->f('log_id'), $_POST['entries']));
$lines[] = $this->line(isset($_POST['entries']) && in_array($this->rs->log_id, $_POST['entries']));
}
echo
@ -110,25 +115,25 @@ class BackendList extends Listing
->class('nowrap minimal')
->items([
(new Checkbox(['entries[]'], $checked))
->value($this->rs->f('log_id')),
->value($this->rs->log_id),
]),
'date' => (new Text('td', Html::escapeHTML(Date::dt2str(__('%Y-%m-%d %H:%M'), $this->rs->f('log_dt')))))
'date' => (new Text('td', Html::escapeHTML(Date::dt2str(__('%Y-%m-%d %H:%M'), $this->rs->log_dt))))
->class('nowrap minimal'),
'msg' => (new Text('td', nl2br(Html::escapeHTML($this->rs->f('log_msg')))))
'msg' => (new Text('td', nl2br(Html::escapeHTML($this->rs->log_msg))))
->class('maximal'),
'blog' => (new Text('td', Html::escapeHTML($this->rs->f('blog_id'))))
'blog' => (new Text('td', Html::escapeHTML($this->rs->blog_id)))
->class('nowrap minimal'),
'table' => (new Text('td', Html::escapeHTML($this->rs->f('log_table'))))
'table' => (new Text('td', Html::escapeHTML($this->rs->log_table)))
->class('nowrap minimal'),
'user' => (new Text('td', Html::escapeHTML($this->rs->getUserCN())))
->class('nowrap minimal'),
'ip' => (new Text('td', Html::escapeHTML($this->rs->f('log_ip'))))
'ip' => (new Text('td', Html::escapeHTML($this->rs->log_ip)))
->class('nowrap minimal'),
]);
$this->userColumns(My::BACKEND_LIST_ID, $cols);
return
(new Para('p' . $this->rs->f('log_id'), 'tr'))
(new Para('p' . $this->rs->log_id, 'tr'))
->class('line')
->items(iterator_to_array($cols));
}

35
src/Manage.php
View File

@ -1,10 +1,20 @@
<?php
/**
* @brief dcLog, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Tomtom 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\dcLog;
use Dotclear\App;
use dcCore;
use Dotclear\Core\Process;
use Dotclear\Core\Backend\{
Notices,
@ -21,12 +31,7 @@ use Dotclear\Helper\Html\Form\{
use Exception;
/**
* @brief dcLog manage class.
* @ingroup dcLog
*
* @author Tomtom (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
* Manage logs list
*/
class Manage extends Process
{
@ -46,11 +51,7 @@ class Manage extends Process
// Delete logs
if ($current->selected_logs && !empty($current->entries) || $current->all_logs) {
try {
if ($current->all_logs) {
App::log()->delAllLogs();
} else {
App::log()->delLogs($current->entries);
}
dcCore::app()->log->delLogs($current->entries, $current->all_logs);
Notices::addSuccessNotice(
$current->all_logs ?
__('All logs have been successfully deleted') :
@ -58,7 +59,7 @@ class Manage extends Process
);
My::redirect();
} catch (Exception $e) {
App::error()->add($e->getMessage());
dcCore::app()->error->add($e->getMessage());
}
}
@ -127,7 +128,11 @@ class Manage extends Process
->class('delete')
->value(__('Delete all logs')),
]),
... My::hiddenFields($current->filter->values()),
(new Text(
'',
dcCore::app()->admin->url->getHiddenFormFields('admin.plugin.' . My::id(), $current->filter->values()) .
dcCore::app()->formNonce()
)),
]),
])->render(),
$current->filter->show()

69
src/ManageVars.php
View File

@ -1,10 +1,20 @@
<?php
/**
* @brief dcLog, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Tomtom 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\dcLog;
use Dotclear\App;
use dcCore;
use Dotclear\Core\Backend\Filter\{
Filters,
FiltersLibrary
@ -13,62 +23,29 @@ use Dotclear\Database\MetaRecord;
use Exception;
/**
* @brief dcLog properties helper.
* @ingroup dcLog
*
* @author Tomtom (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
* Backend logs manage page vars container.
*/
class ManageVars
{
/**
* ManageVars instance.
*
* @var ManageVars $container
*/
/** @var ManageVars $container self instance */
private static $container;
/**
* The filter instance.
*
* @var Filters $filter
*/
/** @var Filters $filter The filter instance */
public readonly Filters $filter;
/**
* The current records.
*
* @var null|MetaRecord $logs
*/
/** @var null|MetaRecord $logs The current records */
public readonly ?MetaRecord $logs;
/**
* The records list form instance.
*
* @var null|BackendList $list
*/
/** @var null|BackendList $list The records list form instance */
public readonly ?BackendList $list;
/**
* The post form selected entries.
*
* @var array<int,string> $entries
*/
/** @var array<int,string> $entries The post form selected entries */
public readonly array $entries;
/**
* The post form action.
*
* @var bool $selected_logs
*/
/** @var bool $selected_logs The post form action */
public readonly bool $selected_logs;
/**
* The post form action.
*
* @var bool $all_logs
*/
/** @var bool $all_logs The post form action */
public readonly bool $all_logs;
/**
@ -89,12 +66,12 @@ class ManageVars
$params = $this->filter->params();
try {
$this->logs = App::log()->getLogs($params);
$count = App::log()->getLogs($params, true)->f(0);
$this->logs = dcCore::app()->log->getLogs($params);
$count = dcCore::app()->log->getLogs($params, true)->f(0);
$count = is_numeric($count) ? (int) $count : 0;
$this->list = new BackendList($this->logs, $count);
} catch (Exception $e) {
App::error()->add($e->getMessage());
dcCore::app()->error->add($e->getMessage());
}
}

34
src/My.php
View File

@ -1,35 +1,29 @@
<?php
/**
* @brief dcLog, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Tomtom 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\dcLog;
use Dotclear\App;
use dcCore;
use Dotclear\Module\MyPlugin;
/**
* @brief dcLog My helper.
* @ingroup dcLog
*
* @author Tomtom (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class My extends MyPlugin
{
/**
* Admin list ID.
*
* @var string BACKEND_LIST_ID
*/
/** @var string Admin list ID */
public const BACKEND_LIST_ID = 'dcloglist';
public static function checkCustomContext(int $context): ?bool
{
return match ($context) {
// Limit to super admin
self::MODULE => App::auth()->isSuperAdmin(),
default => null,
};
return dcCore::app()->auth->isSuperAdmin();
}
}