Compare commits
8 Commits
Author | SHA1 | Date |
---|---|---|
Jean-Christian Paul Denis | 8b352b5a81 | |
Jean-Christian Paul Denis | 3f32615115 | |
Jean-Christian Paul Denis | 118bd06ead | |
Jean-Christian Paul Denis | 81bd9889d0 | |
Jean-Christian Paul Denis | dac7de41d6 | |
Jean-Christian Paul Denis | 332930aab9 | |
Jean-Christian Paul Denis | 1a13ca2405 | |
Jean-Christian Paul Denis | 4d5066d118 |
34
CHANGELOG.md
34
CHANGELOG.md
|
@ -1,3 +1,37 @@
|
||||||
|
DotclearWatch 0.9.3 - 2023.10.22
|
||||||
|
===========================================================
|
||||||
|
* Require dotclear 2.28
|
||||||
|
* Require php 8.1
|
||||||
|
* Add PHP minor version (using PHP constants)
|
||||||
|
* Add uninstall feature (plugin Uninstaller)
|
||||||
|
* Fix colored synthax
|
||||||
|
* Use Helper Form everywhere
|
||||||
|
|
||||||
|
DotclearWatch 0.9.2 - 2023.10.14
|
||||||
|
===========================================================
|
||||||
|
* Require dotclear 2.28
|
||||||
|
* Require php 8.1
|
||||||
|
* Fix last minute update from Dtoclear 2.28
|
||||||
|
|
||||||
|
DotclearWatch 0.9.1 - 2023.10.09
|
||||||
|
===========================================================
|
||||||
|
* Require dotclear 2.28
|
||||||
|
* Require php 8.1
|
||||||
|
* Fix permissions
|
||||||
|
* Code review
|
||||||
|
|
||||||
|
DotclearWatch 0.9 - 2023.10.07
|
||||||
|
===========================================================
|
||||||
|
* Require dotclear 2.28
|
||||||
|
* Require php 8.1
|
||||||
|
* Update to Dotclear 2.28-dev
|
||||||
|
|
||||||
|
DotclearWatch 0.8 - 2023.08.27
|
||||||
|
===========================================================
|
||||||
|
* Require dotclear 2.27
|
||||||
|
* Require php 7.4
|
||||||
|
* Add web server name and version to stats
|
||||||
|
|
||||||
DotclearWatch 0.7.2 - 2023.08.26
|
DotclearWatch 0.7.2 - 2023.08.26
|
||||||
===========================================================
|
===========================================================
|
||||||
* Require dotclear 2.27
|
* Require dotclear 2.27
|
||||||
|
|
12
README.md
12
README.md
|
@ -1,8 +1,8 @@
|
||||||
# README
|
# README
|
||||||
|
|
||||||
[![Release](https://img.shields.io/badge/release-0.7.3-a2cbe9.svg)](https://git.dotclear.watch/dw/DotclearWatch/releases)
|
[![Release](https://img.shields.io/badge/release-0.9.3-a2cbe9.svg)](https://git.dotclear.watch/dw/DotclearWatch/releases)
|
||||||
![Date](https://img.shields.io/badge/date-2023.08.26-c44d58.svg)]
|
![Date](https://img.shields.io/badge/date-2023.10.22-c44d58.svg)
|
||||||
[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
|
[![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/DotclearWatch)
|
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/DotclearWatch)
|
||||||
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/dw/DotclearWatch/src/branch/master/LICENSE)
|
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/dw/DotclearWatch/src/branch/master/LICENSE)
|
||||||
|
|
||||||
|
@ -29,9 +29,9 @@ in aboutConfig global parameters called DotclearWatch->hidden_modules
|
||||||
|
|
||||||
## REQUIREMENTS
|
## REQUIREMENTS
|
||||||
|
|
||||||
* super admin permission to intall it
|
* Dotclear 2.28
|
||||||
* Dotclear 2.27
|
* PHP 8.1+
|
||||||
* PHP 7.4+
|
* Dotclear super admin permission to intall it
|
||||||
|
|
||||||
## USAGE
|
## USAGE
|
||||||
|
|
||||||
|
|
22
_define.php
22
_define.php
|
@ -1,25 +1,27 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
/**
|
||||||
* @brief DotclearWatch, a plugin for Dotclear 2
|
* @file
|
||||||
|
* @brief The plugin DotclearWatch definition
|
||||||
|
* @ingroup DotclearWatch
|
||||||
*
|
*
|
||||||
* @package Dotclear
|
* @defgroup DotclearWatch Plugin DotclearWatch.
|
||||||
* @subpackage Plugin
|
|
||||||
*
|
*
|
||||||
* @author Jean-Christian Denis and contributors
|
* QSend report about your Dotclear.
|
||||||
*
|
*
|
||||||
* @copyright Jean-Christain Denis
|
* @author Jean-Christian Denis
|
||||||
|
* @copyright Jean-Christian Denis
|
||||||
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
||||||
*/
|
*/
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
$this->registerModule(
|
$this->registerModule(
|
||||||
'Dotclear Watch',
|
'Dotclear Watch',
|
||||||
'Send report about your Dotclear',
|
'Send report about your Dotclear',
|
||||||
'Jean-Christian Denis and contributors',
|
'Jean-Christian Denis and contributors',
|
||||||
'0.7.3',
|
'0.9.3',
|
||||||
[
|
[
|
||||||
'requires' => [
|
'requires' => [['core', '2.28']],
|
||||||
['php', '7.4'],
|
'permissions' => 'My',
|
||||||
['core', '2.27'],
|
|
||||||
],
|
|
||||||
'type' => 'plugin',
|
'type' => 'plugin',
|
||||||
'support' => 'https://git.dotclear.watch/dw/' . basename(__DIR__) . '/issues',
|
'support' => 'https://git.dotclear.watch/dw/' . basename(__DIR__) . '/issues',
|
||||||
'details' => 'https://git.dotclear.watch/dw/' . basename(__DIR__) . '/src/branch/master/README.md',
|
'details' => 'https://git.dotclear.watch/dw/' . basename(__DIR__) . '/src/branch/master/README.md',
|
||||||
|
|
|
@ -2,11 +2,11 @@
|
||||||
<modules xmlns:da="http://dotaddict.org/da/">
|
<modules xmlns:da="http://dotaddict.org/da/">
|
||||||
<module id="DotclearWatch">
|
<module id="DotclearWatch">
|
||||||
<name>Dotclear Watch</name>
|
<name>Dotclear Watch</name>
|
||||||
<version>0.7.3</version>
|
<version>0.9.3</version>
|
||||||
<author>Jean-Christian Denis and contributors</author>
|
<author>Jean-Christian Denis and contributors</author>
|
||||||
<desc>Send report about your Dotclear</desc>
|
<desc>Send report about your Dotclear</desc>
|
||||||
<file>https://git.dotclear.watch/dw/DotclearWatch/releases/download/v0.7.3/plugin-DotclearWatch.zip</file>
|
<file>https://git.dotclear.watch/dw/DotclearWatch/releases/download/v0.9.3/plugin-DotclearWatch.zip</file>
|
||||||
<da:dcmin>2.27</da:dcmin>
|
<da:dcmin>2.28</da:dcmin>
|
||||||
<da:details>https://git.dotclear.watch/dw/DotclearWatch/src/branch/master/README.md</da:details>
|
<da:details>https://git.dotclear.watch/dw/DotclearWatch/src/branch/master/README.md</da:details>
|
||||||
<da:support>https://git.dotclear.watch/dw/DotclearWatch/issues</da:support>
|
<da:support>https://git.dotclear.watch/dw/DotclearWatch/issues</da:support>
|
||||||
</module>
|
</module>
|
||||||
|
|
|
@ -1,22 +1,25 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
|
||||||
* @brief DotclearWatch, a plugin for Dotclear 2
|
|
||||||
*
|
|
||||||
* @package Dotclear
|
|
||||||
* @subpackage Plugin
|
|
||||||
*
|
|
||||||
* @author Jean-Christian Denis and contributors
|
|
||||||
*
|
|
||||||
* @copyright Jean-Christain Denis
|
|
||||||
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
|
||||||
*/
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace Dotclear\Plugin\DotclearWatch;
|
namespace Dotclear\Plugin\DotclearWatch;
|
||||||
|
|
||||||
use dcCore;
|
use Dotclear\App;
|
||||||
use Dotclear\Core\Process;
|
use Dotclear\Core\Process;
|
||||||
|
use Dotclear\Helper\Html\Form\{
|
||||||
|
Img,
|
||||||
|
Li,
|
||||||
|
Link,
|
||||||
|
Ul
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief DotclearWatch backend class.
|
||||||
|
* @ingroup DotclearWatch
|
||||||
|
*
|
||||||
|
* @author Jean-Christian Denis
|
||||||
|
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
||||||
|
*/
|
||||||
class Backend extends Process
|
class Backend extends Process
|
||||||
{
|
{
|
||||||
public static function init(): bool
|
public static function init(): bool
|
||||||
|
@ -30,24 +33,32 @@ class Backend extends Process
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
dcCore::app()->addBehaviors([
|
App::behavior()->addBehaviors([
|
||||||
|
// Add JS for asynchronous report sending
|
||||||
'adminDashboardHeaders' => function (): string {
|
'adminDashboardHeaders' => function (): string {
|
||||||
return My::jsLoad('service', dcCore::app()->getVersion(My::id()));
|
return My::jsLoad('service', App::version()->getVersion(My::id()));
|
||||||
},
|
},
|
||||||
|
// Add icon on bottom of dashboard sidebar menu
|
||||||
'adminPageFooterV2' => function (): void {
|
'adminPageFooterV2' => function (): void {
|
||||||
if (My::settings()->getGlobal('distant_api_url')) {
|
if (My::settings()->getGlobal('distant_api_url')) {
|
||||||
echo sprintf(
|
echo (new Ul())->items([
|
||||||
'<ul><li><a href="%s" title="%s" class="outgoing">%s<img src="%s" /></a></ul></li>',
|
(new li())->items([
|
||||||
'https://stat.dotclear.watch',
|
(new Link())
|
||||||
__('Uses DotclearWatch plugin statistics'),
|
->class('outgoing')
|
||||||
__('Shared statistics'),
|
->href('https://stat.dotclear.watch')
|
||||||
My::fileURL('icon.svg')
|
->title(__('Uses DotclearWatch plugin statistics'))
|
||||||
);
|
->text(__('Shared statistics'))
|
||||||
|
->items([
|
||||||
|
(new Img(My::fileURL('icon.svg'))),
|
||||||
|
]),
|
||||||
|
]),
|
||||||
|
])->render();
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
]);
|
]);
|
||||||
|
|
||||||
dcCore::app()->rest->addFunction(
|
App::rest()->addFunction(
|
||||||
|
// Add REST service for asynchronous report sending
|
||||||
'adminDotclearWatchSendReport',
|
'adminDotclearWatchSendReport',
|
||||||
function (): array {
|
function (): array {
|
||||||
Utils::sendReport();
|
Utils::sendReport();
|
||||||
|
|
|
@ -1,18 +1,10 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
|
||||||
* @brief DotclearWatch, a plugin for Dotclear 2
|
|
||||||
*
|
|
||||||
* @package Dotclear
|
|
||||||
* @subpackage Plugins
|
|
||||||
*
|
|
||||||
* @copyright Olivier Meunier & Association Dotclear
|
|
||||||
* @copyright GPL-2.0-only
|
|
||||||
*/
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace Dotclear\Plugin\DotclearWatch;
|
namespace Dotclear\Plugin\DotclearWatch;
|
||||||
|
|
||||||
use dcCore;
|
use Dotclear\App;
|
||||||
use Dotclear\Core\Backend\Notices;
|
use Dotclear\Core\Backend\Notices;
|
||||||
use Dotclear\Core\Backend\Page;
|
use Dotclear\Core\Backend\Page;
|
||||||
use Dotclear\Core\Process;
|
use Dotclear\Core\Process;
|
||||||
|
@ -30,14 +22,32 @@ use Dotclear\Helper\Html\Form\{
|
||||||
};
|
};
|
||||||
use Dotclear\Helper\Html\Html;
|
use Dotclear\Helper\Html\Html;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief DotclearWatch configuration class.
|
||||||
|
* @ingroup DotclearWatch
|
||||||
|
*
|
||||||
|
* @author Jean-Christian Denis
|
||||||
|
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
||||||
|
*/
|
||||||
class Config extends Process
|
class Config extends Process
|
||||||
{
|
{
|
||||||
|
/**
|
||||||
|
* List of hidden modules.
|
||||||
|
*
|
||||||
|
* @var string $hidden_modules
|
||||||
|
*/
|
||||||
private static string $hidden_modules = '';
|
private static string $hidden_modules = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Distant API URL.
|
||||||
|
*
|
||||||
|
* @var string $distant_api_url
|
||||||
|
*/
|
||||||
private static string $distant_api_url = '';
|
private static string $distant_api_url = '';
|
||||||
|
|
||||||
public static function init(): bool
|
public static function init(): bool
|
||||||
{
|
{
|
||||||
return self::status(My::checkContext(My::MANAGE));
|
return self::status(My::checkContext(My::CONFIG));
|
||||||
}
|
}
|
||||||
|
|
||||||
public static function process(): bool
|
public static function process(): bool
|
||||||
|
@ -46,8 +56,8 @@ class Config extends Process
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (self::useColorSynthax()) {
|
if (App::auth()->prefs()->get('interface')->get('colorsyntax')) {
|
||||||
dcCore::app()->addBehavior('pluginsToolsHeadersV2', fn (bool $plugin): string => Page::jsLoadCodeMirror(dcCore::app()->auth->user_prefs->get('interface')->get('colorsyntax_theme')));
|
App::behavior()->addBehavior('pluginsToolsHeadersV2', fn (bool $plugin): string => Page::jsLoadCodeMirror(App::auth()->prefs()->get('interface')->get('colorsyntax_theme')));
|
||||||
}
|
}
|
||||||
|
|
||||||
self::$hidden_modules = (string) My::settings()->getGlobal('hidden_modules');
|
self::$hidden_modules = (string) My::settings()->getGlobal('hidden_modules');
|
||||||
|
@ -62,6 +72,7 @@ class Config extends Process
|
||||||
Notices::AddSuccessNotice(__('Cache directory sucessfully cleared.'));
|
Notices::AddSuccessNotice(__('Cache directory sucessfully cleared.'));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
self::$distant_api_url = !empty($_POST['distant_api_url']) && is_string($_POST['distant_api_url']) ? $_POST['distant_api_url'] : Utils::DISTANT_API_URL;
|
||||||
self::$hidden_modules = '';
|
self::$hidden_modules = '';
|
||||||
foreach (explode(',', $_POST['hidden_modules']) as $hidden) {
|
foreach (explode(',', $_POST['hidden_modules']) as $hidden) {
|
||||||
$hidden = trim($hidden);
|
$hidden = trim($hidden);
|
||||||
|
@ -70,8 +81,6 @@ class Config extends Process
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
self::$distant_api_url = !empty($_POST['distant_api_url']) && is_string($_POST['distant_api_url']) ? $_POST['distant_api_url'] : Utils::DISTANT_API_URL;
|
|
||||||
|
|
||||||
My::settings()->put('hidden_modules', self::$hidden_modules, 'string', 'Hidden modules from report', true, true);
|
My::settings()->put('hidden_modules', self::$hidden_modules, 'string', 'Hidden modules from report', true, true);
|
||||||
My::settings()->put('distant_api_url', self::$distant_api_url, 'string', 'Distant API report URL', true, true);
|
My::settings()->put('distant_api_url', self::$distant_api_url, 'string', 'Distant API report URL', true, true);
|
||||||
Notices::AddSuccessNotice(__('Settings successfully updated.'));
|
Notices::AddSuccessNotice(__('Settings successfully updated.'));
|
||||||
|
@ -86,7 +95,7 @@ class Config extends Process
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
dcCore::app()->admin->url->redirect('admin.plugins', ['module' => My::id(), 'conf' => '1']);
|
App::backend()->url()->redirect('admin.plugins', ['module' => My::id(), 'conf' => '1']);
|
||||||
|
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
@ -106,12 +115,12 @@ class Config extends Process
|
||||||
]),
|
]),
|
||||||
(new Para())->items([
|
(new Para())->items([
|
||||||
(new Label(__('Hidden modules:')))->for('hidden_modules'),
|
(new Label(__('Hidden modules:')))->for('hidden_modules'),
|
||||||
(new Input('hidden_modules'))->class('maximal')->size(65)->maxlenght(255)->value(self::$hidden_modules),
|
(new Input('hidden_modules'))->class('maximal')->size(65)->maxlength(255)->value(self::$hidden_modules),
|
||||||
]),
|
]),
|
||||||
(new Note())->class('form-note')->text(__('This is the comma separated list of plugins IDs and themes IDs to ignore in report.')),
|
(new Note())->class('form-note')->text(__('This is the comma separated list of plugins IDs and themes IDs to ignore in report.')),
|
||||||
(new Para())->items([
|
(new Para())->items([
|
||||||
(new Label(__('Distant API URL:')))->for('distant_api_url'),
|
(new Label(__('Distant API URL:')))->for('distant_api_url'),
|
||||||
(new Input('distant_api_url'))->class('maximal')->size(65)->maxlenght(255)->value(self::$distant_api_url),
|
(new Input('distant_api_url'))->class('maximal')->size(65)->maxlength(255)->value(self::$distant_api_url),
|
||||||
]),
|
]),
|
||||||
(new Note())->class('form-note')->text(__('This is the URL of the API to send report. Leave empty to reset value.')),
|
(new Note())->class('form-note')->text(__('This is the URL of the API to send report. Leave empty to reset value.')),
|
||||||
(new Para())->items([
|
(new Para())->items([
|
||||||
|
@ -138,14 +147,9 @@ class Config extends Process
|
||||||
->class('maximal'),
|
->class('maximal'),
|
||||||
])->render() .
|
])->render() .
|
||||||
(
|
(
|
||||||
self::useColorSynthax() ?
|
App::auth()->prefs()->get('interface')->get('colorsyntax') ?
|
||||||
Page::jsRunCodeMirror(My::id() . 'editor', 'report_contents', 'json', dcCore::app()->auth->user_prefs->get('interface')->get('colorsyntax_theme')) : ''
|
Page::jsRunCodeMirror(My::id() . 'editor', 'report_contents', 'json', App::auth()->prefs()->get('interface')->get('colorsyntax_theme')) : ''
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private static function useColorSynthax(): bool
|
|
||||||
{
|
|
||||||
return dcCore::app()->auth->user_prefs->get('interface')->get('colorsyntax') && '' != dcCore::app()->auth->user_prefs->get('interface')->get('colorsyntax_theme');
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,21 +1,18 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
|
||||||
* @brief DotclearWatch, a plugin for Dotclear 2
|
|
||||||
*
|
|
||||||
* @package Dotclear
|
|
||||||
* @subpackage Plugin
|
|
||||||
*
|
|
||||||
* @author Jean-Christian Denis and contributors
|
|
||||||
*
|
|
||||||
* @copyright Jean-Christain Denis
|
|
||||||
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
|
||||||
*/
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace Dotclear\Plugin\DotclearWatch;
|
namespace Dotclear\Plugin\DotclearWatch;
|
||||||
|
|
||||||
use Dotclear\Core\Process;
|
use Dotclear\Core\Process;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief DotclearWatch install class.
|
||||||
|
* @ingroup DotclearWatch
|
||||||
|
*
|
||||||
|
* @author Jean-Christian Denis
|
||||||
|
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
||||||
|
*/
|
||||||
class Install extends Process
|
class Install extends Process
|
||||||
{
|
{
|
||||||
public static function init(): bool
|
public static function init(): bool
|
||||||
|
@ -25,9 +22,8 @@ class Install extends Process
|
||||||
|
|
||||||
public static function process(): bool
|
public static function process(): bool
|
||||||
{
|
{
|
||||||
$s = My::settings();
|
if (self::status()) {
|
||||||
if (self::status() && $s !== null) {
|
My::settings()->put(
|
||||||
$s->put(
|
|
||||||
'hidden_modules',
|
'hidden_modules',
|
||||||
'DotclearWatch',
|
'DotclearWatch',
|
||||||
'string',
|
'string',
|
||||||
|
@ -35,7 +31,7 @@ class Install extends Process
|
||||||
false,
|
false,
|
||||||
true
|
true
|
||||||
);
|
);
|
||||||
$s->put(
|
My::settings()->put(
|
||||||
'distant_api_url',
|
'distant_api_url',
|
||||||
'https://dotclear.watch/api',
|
'https://dotclear.watch/api',
|
||||||
'string',
|
'string',
|
||||||
|
|
26
src/My.php
26
src/My.php
|
@ -1,27 +1,19 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
|
||||||
* @brief DotclearWatch, a plugin for Dotclear 2
|
|
||||||
*
|
|
||||||
* @package Dotclear
|
|
||||||
* @subpackage Plugin
|
|
||||||
*
|
|
||||||
* @author Jean-Christian Denis and contributors
|
|
||||||
*
|
|
||||||
* @copyright Jean-Christain Denis
|
|
||||||
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
|
||||||
*/
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace Dotclear\Plugin\DotclearWatch;
|
namespace Dotclear\Plugin\DotclearWatch;
|
||||||
|
|
||||||
use dcCore;
|
|
||||||
use Dotclear\Module\MyPlugin;
|
use Dotclear\Module\MyPlugin;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief DotclearWatch My helper.
|
||||||
|
* @ingroup DotclearWatch
|
||||||
|
*
|
||||||
|
* @author Jean-Christian Denis
|
||||||
|
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
||||||
|
*/
|
||||||
class My extends MyPlugin
|
class My extends MyPlugin
|
||||||
{
|
{
|
||||||
protected static function checkCustomContext(int $context): ?bool
|
// Use default permissions
|
||||||
{
|
|
||||||
return $context === My::INSTALL ? null :
|
|
||||||
defined('DC_CONTEXT_ADMIN') && dcCore::app()->auth->isSuperAdmin();
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -0,0 +1,66 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
namespace Dotclear\Plugin\DotclearWatch;
|
||||||
|
|
||||||
|
use Dotclear\Core\Process;
|
||||||
|
use Dotclear\Plugin\Uninstaller\Uninstaller;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief DotclearWatch uninstall class.
|
||||||
|
* @ingroup DotclearWatch
|
||||||
|
*
|
||||||
|
* @author Jean-Christian Denis
|
||||||
|
* @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(
|
||||||
|
'settings',
|
||||||
|
'delete_all',
|
||||||
|
My::id()
|
||||||
|
)
|
||||||
|
->addUserAction(
|
||||||
|
'plugins',
|
||||||
|
'delete',
|
||||||
|
My::id()
|
||||||
|
)
|
||||||
|
->addUserAction(
|
||||||
|
'versions',
|
||||||
|
'delete',
|
||||||
|
My::id()
|
||||||
|
)
|
||||||
|
->addDirectAction(
|
||||||
|
'settings',
|
||||||
|
'delete_all',
|
||||||
|
My::id()
|
||||||
|
)
|
||||||
|
->addDirectAction(
|
||||||
|
'plugins',
|
||||||
|
'delete',
|
||||||
|
My::id()
|
||||||
|
)
|
||||||
|
->addDirectAction(
|
||||||
|
'versions',
|
||||||
|
'delete',
|
||||||
|
My::id()
|
||||||
|
)
|
||||||
|
;
|
||||||
|
|
||||||
|
// no custom action
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
179
src/Utils.php
179
src/Utils.php
|
@ -1,42 +1,57 @@
|
||||||
<?php
|
<?php
|
||||||
/**
|
|
||||||
* @brief DotclearWatch, a plugin for Dotclear 2
|
|
||||||
*
|
|
||||||
* @package Dotclear
|
|
||||||
* @subpackage Plugin
|
|
||||||
*
|
|
||||||
* @author Jean-Christian Denis and contributors
|
|
||||||
*
|
|
||||||
* @copyright Jean-Christain Denis
|
|
||||||
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
|
||||||
*/
|
|
||||||
declare(strict_types=1);
|
declare(strict_types=1);
|
||||||
|
|
||||||
namespace Dotclear\Plugin\DotclearWatch;
|
namespace Dotclear\Plugin\DotclearWatch;
|
||||||
|
|
||||||
use dcCore;
|
use Dotclear\App;
|
||||||
use dcLog;
|
|
||||||
use dcModuleDefine;
|
|
||||||
use dcThemes;
|
|
||||||
use Dotclear\Helper\Crypt;
|
use Dotclear\Helper\Crypt;
|
||||||
use Dotclear\Helper\Network\HttpClient;
|
use Dotclear\Helper\Network\HttpClient;
|
||||||
|
use Dotclear\Module\ModuleDefine;
|
||||||
use Exception;
|
use Exception;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @brief DotclearWatch utils class.
|
||||||
|
* @ingroup DotclearWatch
|
||||||
|
*
|
||||||
|
* @author Jean-Christian Denis
|
||||||
|
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
|
||||||
|
*/
|
||||||
class Utils
|
class Utils
|
||||||
{
|
{
|
||||||
/** @var int The expiration delay before resend report (one week) */
|
/**
|
||||||
|
* The expiration delay before resend report (one week).
|
||||||
|
*
|
||||||
|
* @var int EXPIRED_DELAY
|
||||||
|
*/
|
||||||
public const EXPIRED_DELAY = 604800;
|
public const EXPIRED_DELAY = 604800;
|
||||||
|
|
||||||
/** @var string The default distant API URL */
|
/**
|
||||||
|
* The default distant API URL.
|
||||||
|
*
|
||||||
|
* @var string DISTANT_API_URL
|
||||||
|
*/
|
||||||
public const DISTANT_API_URL = 'https://dotclear.watch/api';
|
public const DISTANT_API_URL = 'https://dotclear.watch/api';
|
||||||
|
|
||||||
/** @var string The distant API version */
|
/**
|
||||||
|
* The distant API version.
|
||||||
|
*
|
||||||
|
* @var string DISTANT_API_VERSION
|
||||||
|
*/
|
||||||
public const DISTANT_API_VERSION = '1.1';
|
public const DISTANT_API_VERSION = '1.1';
|
||||||
|
|
||||||
/** @var array<int,string> The hiddens modules IDs */
|
/**
|
||||||
|
* The hiddens modules IDs.
|
||||||
|
*
|
||||||
|
* @var array<int,string> $hiddens
|
||||||
|
*/
|
||||||
private static array $hiddens = [];
|
private static array $hiddens = [];
|
||||||
|
|
||||||
/** @var string Multiblog unique identifiant */
|
/**
|
||||||
|
* Multiblog unique identifiant.
|
||||||
|
*
|
||||||
|
* @var string $uid
|
||||||
|
*/
|
||||||
private static string $uid = '';
|
private static string $uid = '';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -71,12 +86,12 @@ class Utils
|
||||||
{
|
{
|
||||||
$modules = [];
|
$modules = [];
|
||||||
$hiddens = self::getHiddens();
|
$hiddens = self::getHiddens();
|
||||||
$defines = dcCore::app()->plugins->getDefines($strict ? ['state' => dcModuleDefine::STATE_ENABLED] : []);
|
$defines = App::plugins()->getDefines($strict ? ['state' => ModuleDefine::STATE_ENABLED] : []);
|
||||||
foreach ($defines as $define) {
|
foreach ($defines as $define) {
|
||||||
if ($strict && in_array($define->getId(), $hiddens)) {
|
if ($strict && in_array($define->getId(), $hiddens)) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
$modules[$define->getId()] = $define->get('version');
|
$modules[(string) $define->getId()] = (string) $define->get('version');
|
||||||
}
|
}
|
||||||
|
|
||||||
return $modules;
|
return $modules;
|
||||||
|
@ -91,24 +106,48 @@ class Utils
|
||||||
*/
|
*/
|
||||||
public static function getThemes(bool $strict = true): array
|
public static function getThemes(bool $strict = true): array
|
||||||
{
|
{
|
||||||
if (!(dcCore::app()->themes instanceof dcThemes)) {
|
if (App::themes()->isEmpty()) {
|
||||||
dcCore::app()->themes = new dcThemes();
|
App::themes()->loadModules(App::blog()->themesPath());
|
||||||
dcCore::app()->themes->loadModules(dcCore::app()->blog->themes_path);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$modules = [];
|
$modules = [];
|
||||||
$hiddens = self::getHiddens();
|
$hiddens = self::getHiddens();
|
||||||
$defines = dcCore::app()->themes->getDefines($strict ? ['state' => dcModuleDefine::STATE_ENABLED] : []);
|
$defines = App::themes()->getDefines($strict ? ['state' => ModuleDefine::STATE_ENABLED] : []);
|
||||||
foreach ($defines as $define) {
|
foreach ($defines as $define) {
|
||||||
if ($strict && in_array($define->getId(), $hiddens)) {
|
if ($strict && in_array($define->getId(), $hiddens)) {
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
$modules[$define->getId()] = $define->get('version');
|
$modules[(string) $define->getId()] = (string) $define->get('version');
|
||||||
}
|
}
|
||||||
|
|
||||||
return $modules;
|
return $modules;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get server software and version.
|
||||||
|
*
|
||||||
|
* @return array<string,string> The server info
|
||||||
|
*/
|
||||||
|
public static function getServer(): array
|
||||||
|
{
|
||||||
|
$res = [
|
||||||
|
'name' => 'undefined',
|
||||||
|
'version' => 'undefined',
|
||||||
|
];
|
||||||
|
|
||||||
|
if (!empty($_SERVER['SERVER_SOFTWARE'])) {
|
||||||
|
$exp = explode('/', $_SERVER['SERVER_SOFTWARE']);
|
||||||
|
if (count($exp) == 2) {
|
||||||
|
$res = [
|
||||||
|
'name' => $exp[0],
|
||||||
|
'version' => $exp[1],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $res;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get report contents.
|
* Get report contents.
|
||||||
*
|
*
|
||||||
|
@ -132,7 +171,7 @@ class Utils
|
||||||
*/
|
*/
|
||||||
public static function getError(): string
|
public static function getError(): string
|
||||||
{
|
{
|
||||||
$rs = dcCore::app()->log->getLogs([
|
$rs = App::log()->getLogs([
|
||||||
'log_table' => My::id() . '_error',
|
'log_table' => My::id() . '_error',
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
@ -216,14 +255,24 @@ class Utils
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if report can be done.
|
||||||
|
*
|
||||||
|
* @return bool True if it can
|
||||||
|
*/
|
||||||
private static function check(): bool
|
private static function check(): bool
|
||||||
{
|
{
|
||||||
return defined('DC_CRYPT_ALGO');
|
return true; // not yet
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get report key.
|
||||||
|
*
|
||||||
|
* @return string The report key
|
||||||
|
*/
|
||||||
private static function key(): string
|
private static function key(): string
|
||||||
{
|
{
|
||||||
return Crypt::hmac(self::uid() . My::id(), DC_CRYPT_ALGO);
|
return Crypt::hmac(self::uid() . My::id(), App::config()->cryptAlgo());
|
||||||
}
|
}
|
||||||
|
|
||||||
private static function uid(): string
|
private static function uid(): string
|
||||||
|
@ -239,11 +288,21 @@ class Utils
|
||||||
return self::$uid;
|
return self::$uid;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get blog report uid.
|
||||||
|
*
|
||||||
|
* @return string The blog report uid
|
||||||
|
*/
|
||||||
private static function buid(): string
|
private static function buid(): string
|
||||||
{
|
{
|
||||||
return md5(self::uid() . dcCore::app()->blog->uid);
|
return md5(self::uid() . App::blog()->uid());
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get query URL.
|
||||||
|
*
|
||||||
|
* @return string The URL
|
||||||
|
*/
|
||||||
private static function url(): string
|
private static function url(): string
|
||||||
{
|
{
|
||||||
$api_url = My::settings()->getGlobal('distant_api_url');
|
$api_url = My::settings()->getGlobal('distant_api_url');
|
||||||
|
@ -251,9 +310,12 @@ class Utils
|
||||||
return (is_string($api_url) ? $api_url : self::DISTANT_API_URL) . '/' . self::DISTANT_API_VERSION . '/%s/' . self::uid();
|
return (is_string($api_url) ? $api_url : self::DISTANT_API_URL) . '/' . self::DISTANT_API_VERSION . '/%s/' . self::uid();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clear report logs.
|
||||||
|
*/
|
||||||
private static function clear(): void
|
private static function clear(): void
|
||||||
{
|
{
|
||||||
$rs = dcCore::app()->log->getLogs([
|
$rs = App::log()->getLogs([
|
||||||
'log_table' => [
|
'log_table' => [
|
||||||
My::id() . '_report',
|
My::id() . '_report',
|
||||||
My::id() . '_error',
|
My::id() . '_error',
|
||||||
|
@ -268,49 +330,56 @@ class Utils
|
||||||
while ($rs->fetch()) {
|
while ($rs->fetch()) {
|
||||||
$logs[] = (int) $rs->f('log_id');
|
$logs[] = (int) $rs->f('log_id');
|
||||||
}
|
}
|
||||||
dcCore::app()->log->delLogs($logs);
|
App::log()->delLogs($logs);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Log error.
|
||||||
|
*/
|
||||||
private static function error(string $message): void
|
private static function error(string $message): void
|
||||||
{
|
{
|
||||||
self::clear();
|
self::clear();
|
||||||
|
|
||||||
$cur = dcCore::app()->con->openCursor(dcCore::app()->prefix . dcLog::LOG_TABLE_NAME);
|
$cur = App::log()->openLogCursor();
|
||||||
$cur->setField('log_table', My::id() . '_error');
|
$cur->setField('log_table', My::id() . '_error');
|
||||||
$cur->setField('log_msg', $message);
|
$cur->setField('log_msg', $message);
|
||||||
|
|
||||||
dcCore::app()->log->addLog($cur);
|
App::log()->addLog($cur);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Write report.
|
||||||
|
*/
|
||||||
private static function write(string $contents): void
|
private static function write(string $contents): void
|
||||||
{
|
{
|
||||||
self::clear();
|
self::clear();
|
||||||
|
|
||||||
$cur = dcCore::app()->con->openCursor(dcCore::app()->prefix . dcLog::LOG_TABLE_NAME);
|
$cur = App::log()->openLogCursor();
|
||||||
$cur->setField('log_table', My::id() . '_report');
|
$cur->setField('log_table', My::id() . '_report');
|
||||||
$cur->setField('log_msg', $contents);
|
$cur->setField('log_msg', $contents);
|
||||||
|
|
||||||
dcCore::app()->log->addLog($cur);
|
App::log()->addLog($cur);
|
||||||
}
|
|
||||||
|
|
||||||
private static function read(): string
|
|
||||||
{
|
|
||||||
$rs = dcCore::app()->log->getLogs([
|
|
||||||
'log_table' => My::id() . '_report',
|
|
||||||
]);
|
|
||||||
|
|
||||||
return $rs->isEmpty() || !is_string($rs->f('log_msg')) ? '' : $rs->f('log_msg');
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if report is expired.
|
||||||
|
*
|
||||||
|
* @return bool True if expired
|
||||||
|
*/
|
||||||
private static function expired(): bool
|
private static function expired(): bool
|
||||||
{
|
{
|
||||||
$rs = dcCore::app()->log->getLogs([
|
$rs = App::log()->getLogs([
|
||||||
'log_table' => My::id() . '_report',
|
'log_table' => My::id() . '_report',
|
||||||
]);
|
]);
|
||||||
|
|
||||||
return $rs->isEmpty() || !is_string($rs->f('log_dt')) || (int) strtotime($rs->f('log_dt')) + self::EXPIRED_DELAY < time();
|
return $rs->isEmpty() || !is_string($rs->f('log_dt')) || (int) strtotime($rs->f('log_dt')) + self::EXPIRED_DELAY < time();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get report content.
|
||||||
|
*
|
||||||
|
* @return string Teh report content
|
||||||
|
*/
|
||||||
private static function contents(): string
|
private static function contents(): string
|
||||||
{
|
{
|
||||||
// Build json response
|
// Build json response
|
||||||
|
@ -320,26 +389,28 @@ class Utils
|
||||||
'plugins' => self::getPlugins(), // enabled plugins
|
'plugins' => self::getPlugins(), // enabled plugins
|
||||||
'themes' => self::getThemes(), // enabled themes
|
'themes' => self::getThemes(), // enabled themes
|
||||||
'blog' => [
|
'blog' => [
|
||||||
'lang' => (string) dcCore::app()->blog->settings->get('system')->get('lang'),
|
'lang' => (string) App::blog()->settings()->get('system')->get('lang'),
|
||||||
'theme' => (string) dcCore::app()->blog->settings->get('system')->get('theme'),
|
'theme' => (string) App::blog()->settings()->get('system')->get('theme'),
|
||||||
],
|
],
|
||||||
'blogs' => [
|
'blogs' => [
|
||||||
'count' => (int) dcCore::app()->getBlogs([], true)->f(0),
|
'count' => (int) App::blogs()->getBlogs([], true)->f(0),
|
||||||
],
|
],
|
||||||
'core' => [
|
'core' => [
|
||||||
'version' => DC_VERSION,
|
'version' => App::config()->dotclearVersion(),
|
||||||
],
|
],
|
||||||
|
'server' => self::getServer(),
|
||||||
'php' => [
|
'php' => [
|
||||||
'sapi' => php_sapi_name() ?: 'php',
|
'sapi' => php_sapi_name() ?: 'php',
|
||||||
'version' => phpversion(),
|
'version' => PHP_VERSION,
|
||||||
|
'minor' => PHP_MAJOR_VERSION . '.' . PHP_MINOR_VERSION,
|
||||||
],
|
],
|
||||||
'system' => [
|
'system' => [
|
||||||
'name' => php_uname('s'),
|
'name' => php_uname('s'),
|
||||||
'version' => php_uname('r'),
|
'version' => php_uname('r'),
|
||||||
],
|
],
|
||||||
'database' => [
|
'database' => [
|
||||||
'driver' => dcCore::app()->con->driver(),
|
'driver' => App::con()->driver(),
|
||||||
'version' => dcCore::app()->con->version(),
|
'version' => App::con()->version(),
|
||||||
],
|
],
|
||||||
], JSON_PRETTY_PRINT);
|
], JSON_PRETTY_PRINT);
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue