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

release 2023.10.09

Browse source
This commit is contained in:
Jean-Christian Denis 2023-10-09 22:06:50 +02:00
parent dacdbf7342
commit 2ca39fb042
Signed by: JcDenis
GPG key ID: 1B5B8C5B90B6C951
14 changed files with 220 additions and 176 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CHANGELOG.md
View file

@ -1,3 +1,9 @@
pacKman 2023.10.09
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1+
* Code review
pacKman 2023.10.07
===========================================================
* Require Dotclear 2.28

25
README.md
View file

@ -1,26 +1,22 @@
# README
[![Release](https://img.shields.io/badge/release-2023.10.07-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/pacKman/releases)
[![Date](https://img.shields.io/badge/date-2023.10.07-c44d58.svg)](https://git.dotclear.watch/JcDenis/pacKman/releases)
![Date](https://img.shields.io/badge/date-2023.10.07-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/github/license/JcDenis/pacKman)](https://git.dotclear.watch/JcDenis/pacKman/blob/master/LICENSE)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/pacKman/src/branch/master/LICENSE)
## WHAT IS PACKMAN ?
## ABOUT
_pacKman_ is a plugin for the open-source
web publishing software called Dotclear.
_pacKman_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
It help super admin to create and manage packages of
themes and plugins from Dotclear administration pages.
> Create and manage packages of themes and plugins from Dotclear administration pages.
## REQUIREMENTS
_pacKman_ requires:
* Super administrator permissions
* Dotclear 2.28
* PHP 8.1+
* Super administrator permissions
* A writable cache directory
* A writable directory to put packages. (can be VAR dir)
@ -37,10 +33,11 @@ Once it's done you can manage your packages from menu
## LINKS
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/pacKman) or [GitHub Page](https://github.com/JcDenis/pacKman)
* Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/pacKman/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/pacKman)
* Discuss and help : [Dotclear Forum](https://forum.dotclear.org/viewtopic.php?id=40066)
* [License](https://git.dotclear.watch/JcDenis/pacKman/src/branch/master/LICENSE)
* [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)
## CONTRIBUTORS

34
_define.php
View file

@ -1,35 +1,29 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
* @file
* @brief The plugin pacKman definition
* @ingroup pacKman
*
* @package Dotclear
* @subpackage Plugin
* @defgroup pacKman Plugin pacKman.
*
* @author Jean-Christian Denis
* Manage your Dotclear packages.
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
* @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);
if (!defined('DC_RC_PATH')) {
return null;
}
$this->registerModule(
'Packages repository',
'Manage your Dotclear packages',
'Jean-Christian Denis',
'2023.10.07',
'2023.10.09',
[
'requires' => [
['php', '8.1'],
['core', '2.28'],
],
'permissions' => null,
'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',
'requires' => [['core', '2.28']],
'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',
]
);

4
dcstore.xml
View file

@ -2,10 +2,10 @@
<modules xmlns:da="http://dotaddict.org/da/">
<module id="pacKman">
<name>Packages repository</name>
<version>2023.10.07</version>
<version>2023.10.09</version>
<author>Jean-Christian Denis</author>
<desc>Manage your Dotclear packages</desc>
<file>https://git.dotclear.watch/JcDenis/pacKman/releases/download/v2023.10.07/plugin-pacKman.zip</file>
<file>https://git.dotclear.watch/JcDenis/pacKman/releases/download/v2023.10.09/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>

20
src/Backend.php
View file

@ -1,15 +1,5 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
@ -18,6 +8,14 @@ use Dotclear\App;
use Dotclear\Core\Process;
use Dotclear\Core\Backend\Favorites;
/**
* @brief pacKman backend class.
* @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
{
public static function init(): bool

20
src/Config.php
View file

@ -1,15 +1,5 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
@ -30,6 +20,14 @@ use Dotclear\Helper\Html\Form\{
};
use Exception;
/**
* @brief pacKman configuration class.
* @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
{
public static function init(): bool

47
src/Core.php
View file

@ -1,15 +1,5 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
@ -21,8 +11,23 @@ use Dotclear\Helper\File\Zip\Unzip;
use Dotclear\Module\ModuleDefine;
use Exception;
/**
* @brief pacKman main class.
* @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
{
/**
* Quote excluded list.
*
* @param array<int,string> $exclude The list
*
* @return array<int,string> $exclude The list
*/
public static function quote_exclude(array $exclude): array
{
foreach ($exclude as $k => $v) {
@ -36,6 +41,13 @@ class Core
return $exclude;
}
/**
* Get packages list.
*
* @param string $root The path to scan
*
* @return array<int,ModuleDefine> The list
*/
public static function getPackages(string $root): array
{
$res = [];
@ -134,6 +146,19 @@ class Core
return $res;
}
/**
* Pack a module.
*
* @param ModuleDefine $define The module
* @param string $root The package path
* @param array<int,string> $files The files to pack
* @param bool $overwrite Overwrite package
* @param array<int,string> $exclude The files to exclude (regexp)
* @param bool $nocomment Remove comment from files
* @param bool $fixnewline Fix new lines in files
*
* @return bool True on success
*/
public static function pack(ModuleDefine $define, string $root, array $files, bool $overwrite = false, array $exclude = [], bool $nocomment = false, bool $fixnewline = false): bool
{
// check define

20
src/Install.php
View file

@ -1,15 +1,5 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
@ -18,6 +8,14 @@ use Dotclear\App;
use Dotclear\Core\Process;
use Exception;
/**
* @brief pacKman install class.
* @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
{
public static function init(): bool

27
src/Manage.php
View file

@ -1,15 +1,5 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
@ -28,6 +18,14 @@ use Dotclear\Helper\Html\Form\{
use Dotclear\Helper\Network\Http;
use Exception;
/**
* @brief pacKman manage page class.
* @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
{
public static function init(): bool
@ -184,11 +182,8 @@ class Manage extends Process
# --BEHAVIOR-- packmanBeforeInstallPackage
App::behavior()->callBehavior('packmanBeforeInstallPackage', $type, $id, $root);
if ($type == 'themes') {
App::themes()->installPackage($root, App::themes());
} else {
App::plugins()->installPackage($root, App::plugins());
}
$mods = $type == 'themes' ? App::themes() : App::plugins();
$mods->installPackage($root, $mods);
# --BEHAVIOR-- packmanAfterInstallPackage
App::behavior()->callBehavior('packmanAfterInstallPackage', $type, $id, $root);

28
src/My.php
View file

@ -1,15 +1,5 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
@ -18,11 +8,20 @@ use Dotclear\App;
use Dotclear\Module\MyPlugin;
/**
* This module definitions.
* @brief pacKman My plugin helper.
* @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
{
/** @var array Excluded files */
/**
* Excluded files.
*
* @var array<int,string> EXCLUDED_FILES
*/
public const EXCLUDED_FILES = [
'.',
'..',
@ -38,6 +37,7 @@ class My extends MyPlugin
public static function checkCustomContext(int $context): ?bool
{
return in_array($context, [My::BACKEND, My::MANAGE, My::MENU]) ? App::auth()->isSuperAdmin() : null;
// Only backend and super admin
return $context === self::INSTALL ? null : App::task()->checkContext('BACKEND') && App::auth()->isSuperAdmin();
}
}

55
src/Settings.php
View file

@ -1,19 +1,17 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
/**
* @brief pacKman settings class.
* @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
@ -44,30 +42,37 @@ class Settings
public readonly bool $hide_distrib;
/**
* Constructor set up plugin settings
* Constructor set up plugin settings.
*/
public function __construct()
{
$s = My::settings();
$this->pack_nocomment = (bool) ($s?->get('pack_nocomment') ?? false);
$this->pack_fixnewline = (bool) ($s?->get('pack_fixnewline') ?? false);
$this->pack_overwrite = (bool) ($s?->get('pack_overwrite') ?? false);
$this->pack_filename = (string) ($s?->get('pack_filename') ?? '%type%-%id%');
$this->secondpack_filename = (string) ($s?->get('secondpack_filename') ?? '%type%-%id%-%version%');
$this->pack_repository = (string) ($s?->get('pack_repository') ?? '');
$this->pack_typedrepo = (bool) ($s?->get('pack_typedrepo') ?? false);
$this->pack_excludefiles = (string) ($s?->get('pack_excludefiles') ?? '*.zip,*.tar,*.tar.gz,.directory,.hg');
$this->hide_distrib = (bool) ($s?->get('hide_distrib') ?? false);
$this->pack_nocomment = (bool) ($s->get('pack_nocomment') ?? false);
$this->pack_fixnewline = (bool) ($s->get('pack_fixnewline') ?? false);
$this->pack_overwrite = (bool) ($s->get('pack_overwrite') ?? false);
$this->pack_filename = (string) ($s->get('pack_filename') ?? '%type%-%id%');
$this->secondpack_filename = (string) ($s->get('secondpack_filename') ?? '%type%-%id%-%version%');
$this->pack_repository = (string) ($s->get('pack_repository') ?? '');
$this->pack_typedrepo = (bool) ($s->get('pack_typedrepo') ?? false);
$this->pack_excludefiles = (string) ($s->get('pack_excludefiles') ?? '*.zip,*.tar,*.tar.gz,.directory,.hg');
$this->hide_distrib = (bool) ($s->get('hide_distrib') ?? false);
}
public function getSetting(string $key): mixed
/**
* Get a setting.
*
* @param string $key The key
*
* @return null|bool|string The value
*/
public function getSetting(string $key): null|bool|string
{
return $this->{$key} ?? null;
}
/**
* Overwrite a plugin settings (in db)
* Overwrite a plugin settings (in db).
*
* @param string $key The setting ID
* @param mixed $value The setting value
@ -87,9 +92,9 @@ class Settings
}
/**
* List defined settings keys
* List defined settings keys.
*
* @return array The settings keys
* @return array<string,bool|string> The settings keys
*/
public function listSettings(): array
{

23
src/Uninstall.php
View file

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

48
src/Utils.php
View file

@ -1,15 +1,5 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
@ -31,13 +21,22 @@ use Dotclear\Helper\Html\Form\{
Text
};
use Dotclear\Helper\Html\Html;
use Dotclear\Module\ModuleDefine;
use Exception;
/**
* @brief pacKman utils class.
* @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
{
public static function getPluginsPath(): string
{
$e = explode(PATH_SEPARATOR, DC_PLUGINS_ROOT);
$e = explode(PATH_SEPARATOR, App::config()->pluginsRoot());
$p = array_pop($e);
return (string) Path::real($p);
@ -86,7 +85,7 @@ class Utils
public static function getRepositoryDir(?string $dir, ?string $typed = null): string
{
$typed = empty($typed) ? '' : DIRECTORY_SEPARATOR . ($typed == 'themes' ? 'themes' : 'plugins');
$dir = empty($dir) ? DC_VAR . DIRECTORY_SEPARATOR . 'packman' . $typed : $dir . $typed;
$dir = empty($dir) ? App::config()->varRoot() . DIRECTORY_SEPARATOR . 'packman' . $typed : $dir . $typed;
try {
@Files::makeDir($dir, true);
@ -97,6 +96,15 @@ class Utils
return $dir;
}
/**
* Get modules list form.
*
* @param array<int,ModuleDefine> $modules The modules
* @param string $type The modules type
* @param string $title The list title
*
* @return null|bool True on render
*/
public static function modules(array $modules, string $type, string $title): ?bool
{
if (empty($modules)) {
@ -178,6 +186,15 @@ class Utils
return true;
}
/**
* Get modules repository list form.
*
* @param array<int,ModuleDefine> $modules The modules
* @param string $type The modules type
* @param string $title The list title
*
* @return null|bool True on render
*/
public static function repository(array $modules, string $type, string $title): ?bool
{
if (empty($modules)) {
@ -323,6 +340,11 @@ class Utils
return true;
}
/**
* Sort modules by id.
*
* @param array<int,ModuleDefine> $modules The modules
*/
protected static function sort(array &$modules): void
{
uasort($modules, fn ($a, $b) => $a->get('version') <=> $b->get('version'));

39
src/Zip.php
View file

@ -1,25 +1,34 @@
<?php
/**
* @brief pacKman, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @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);
namespace Dotclear\Plugin\pacKman;
/**
* @brief pacKman zip class.
* @ingroup pacKman
*
* This class extends dotclear zip class
* 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
{
/** @var boolean Remove comments from files content */
/**
* Remove comments from files content.
*
* @var bool $remove_comment
*/
public static $remove_comment = false;
/** @var boolean Fix newline from files content */
/**
* Fix newline from files content.
*
* @var bool $fix_newline
*/
public static $fix_newline = false;
/**
@ -59,8 +68,8 @@ class Zip extends \Dotclear\Helper\File\Zip\Zip
unset($content);
$mdate = $this->makeDate($mtime);
$mtime = $this->makeTime($mtime);
$mdate = $this->makeDate((int) $mtime);
$mtime = $this->makeTime((int) $mtime);
# Data descriptor
$data_desc = "\x50\x4b\x03\x04" .