JcDenis/mail2log
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

clean up define

Browse source
This commit is contained in:
Jean-Christian Denis 2023-10-23 10:15:46 +02:00
parent 2377fdec76
commit 73e0c357e9
Signed by: JcDenis
GPG key ID: 1B5B8C5B90B6C951
8 changed files with 144 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CHANGELOG.md
View file

@ -1,3 +1,10 @@
mail2log 0.8 - 2023.10.23
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Move mail function to keep clean the define
* Add plugin Uninstaller features
mail2log 0.7.1 - 2023.10.19
===========================================================
* Require Dotclear 2.28

8
README.md
View file

@ -1,7 +1,7 @@
# README
[![Release](https://img.shields.io/badge/release-0.7.1-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/mail2log/releases)
![Date](https://img.shields.io/badge/date-2023.10.19-c44d58.svg)
[![Release](https://img.shields.io/badge/release-0.8-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/mail2log/releases)
![Date](https://img.shields.io/badge/date-2023.10.23-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/mail2log)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/mail2log/src/branch/master/LICENSE)
@ -10,7 +10,7 @@
_mail2log_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> It replaces mail function and send them to Dotclear's log database table.
> Replace mail function and send them to Dotclear's log database table.
## REQUIREMENTS
@ -35,6 +35,6 @@ Use it for dev only.
## CONTRIBUTORS
* Jean-Christian Denis
* Jean-Christian Denis (author)
You are welcome to contribute to this code.

17
_define.php
View file

@ -17,27 +17,14 @@ $this->registerModule(
'Mail to log',
'Do not send mails but log them',
'Jean-Christian Denis and contributors',
'0.7.1',
'0.8',
[
'requires' => [['core', '2.28']],
'permissions' => 'My',
'priority' => 10,
'type' => 'plugin',
'support' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',
'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',
]
);
if (!function_exists('\_mail')) {
function _mail(string $to, string $subject, string $message, $headers = '', ?string $params = null): bool
{
$headers = is_array($headers) ? implode("\n\t", $headers) : (is_string($headers) ? $headers : '');
$cur = Dotclear\App::log()->openLogCursor();
$cur->setField('log_table', basename(__DIR__));
$cur->setField('log_msg', sprintf("%s\n-----\n To: %s\n Subject: %s\n-----\n Message:\n%s\n", $headers, $to, $subject, $message));
Dotclear\App::log()->addLog($cur);
return true;
}
}

4
dcstore.xml
View file

@ -2,10 +2,10 @@
<modules xmlns:da="http://dotaddict.org/da/">
<module id="mail2log">
<name>Mail to log</name>
<version>0.7.1</version>
<version>0.8</version>
<author>Jean-Christian Denis and contributors</author>
<desc>Do not send mails but log them</desc>
<file>https://git.dotclear.watch/JcDenis/mail2log/releases/download/v0.7.1/plugin-mail2log.zip</file>
<file>https://git.dotclear.watch/JcDenis/mail2log/releases/download/v0.8/plugin-mail2log.zip</file>
<da:dcmin>2.28</da:dcmin>
<da:details>https://git.dotclear.watch/JcDenis/mail2log/src/branch/master/README.md</da:details>
<da:support>https://git.dotclear.watch/JcDenis/mail2log/issues</da:support>

4
src/My.php
View file

@ -7,8 +7,8 @@ namespace Dotclear\Plugin\mail2log;
use Dotclear\Module\MyPlugin;
/**
* @brief mail2log My helper.
* @ingroup mail2log
* @brief mail2log My helper.
* @ingroup mail2log
*
* @author Jean-Christian Denis (author)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html

32
src/Prepend.php Normal file
View file

@ -0,0 +1,32 @@
<?php
declare(strict_types=1);
namespace Dotclear\Plugin\mail2log;
use Dotclear\Core\Process;
/**
* @brief mail2log prepend class.
* @ingroup mail2log
*
* @author Jean-Christian Denis (author)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Prepend extends Process
{
public static function init(): bool
{
return self::status(My::checkContext(My::BACKEND));
}
public static function process(): bool
{
if (self::status()) {
// function must be out of namespace
require_once __DIR__ . '/_mail.php';
}
return self::status();
}
}

66
src/Uninstall.php Normal file
View file

@ -0,0 +1,66 @@
<?php
declare(strict_types=1);
namespace Dotclear\Plugin\mail2log;
use Dotclear\Core\Process;
use Dotclear\Plugin\Uninstaller\Uninstaller;
/**
* @brief mail2log uninstall class.
* @ingroup mail2log
*
* @author Jean-Christian Denis (author)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Uninstall extends Process
{
public static function init(): bool
{
return self::status(My::checkContext(My::UNINSTALL));
}
public static function process(): bool
{
if (!self::status()) {
return false;
}
Uninstaller::instance()
->addUserAction(
'logs',
'delete_all',
'mail2log'
)
->addUserAction(
'plugins',
'delete',
My::id()
)
->addUserAction(
'versions',
'delete',
My::id()
)
->addDirectAction(
'logs',
'delete_all',
'mail2log'
)
->addDirectAction(
'plugins',
'delete',
My::id()
)
->addDirectAction(
'versions',
'delete',
My::id()
)
;
// no custom action
return false;
}
}

29
src/_mail.php Normal file
View file

@ -0,0 +1,29 @@
<?php
/**
* @file
* @brief The plugin mail2log _mail function
* @ingroup mail2log
*
* @author Jean-Christian Denis (author)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
use Dotclear\App;
if (!function_exists('\_mail')) {
function _mail(string $to, string $subject, string $message, $headers = '', ?string $params = null): bool
{
$cur = App::log()->openLogCursor();
$cur->setField('log_table', 'mail2log');
$cur->setField('log_msg', sprintf(
"%s\n-----\n To: %s\n Subject: %s\n-----\n Message:\n%s\n",
is_array($headers) ? implode("\n\t", $headers) : (is_string($headers) ? $headers : ''),
$to,
$subject,
$message
));
App::log()->addLog($cur);
return true;
}
}