JcDenis/pacKman
1
0
Fork 0
Code Issues Pull Requests Projects Releases 6 Wiki Activity

Compare commits

base: JcDenis:master
Branches Tags
JcDenis:master
JcDenis:2.28
JcDenis:v2023.11.04
JcDenis:v2023.10.19
JcDenis:v2023.10.13
JcDenis:v2023.10.09
JcDenis:v2023.10.07
JcDenis:v2023.08.06
..
compare: JcDenis:v2023.08.06
Branches Tags
JcDenis:master
JcDenis:2.28
JcDenis:v2023.11.04
JcDenis:v2023.10.19
JcDenis:v2023.10.13
JcDenis:v2023.10.09
JcDenis:v2023.10.07
JcDenis:v2023.08.06

No commits in common. "master" and "v2023.08.06" have entirely different histories.
master ... v2023.08.0

15 changed files with 283 additions and 373 deletions
Show Stats Expand all files Collapse all files

33
CHANGELOG.md
View File

@ -1,35 +1,4 @@
pacKman 2023.11.04 pacKman 2023.07.29
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1+
* Fix typo
* Code review
pacKman 2023.10.19
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1+
* cosmetic code review
pacKman 2023.10.13
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1+
* Upgrade to last minute change to Dotclear 2.28
pacKman 2023.10.09
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1+
* Code review
pacKman 2023.10.07
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1+
* Update to Dotclear 2.28-dev
pacKman 2023.08.06
=========================================================== ===========================================================
* Require Dotclear 2.27 * Require Dotclear 2.27
* Require PHP 8.1+ * Require PHP 8.1+

40
README.md
View File

@ -1,24 +1,29 @@
# README # README
[![Release](https://img.shields.io/badge/release-2023.11.04-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/pacKman/releases) [![Release](https://img.shields.io/github/v/release/JcDenis/pacKman)](https://git.dotclear.watch/JcDenis/pacKman/releases)
![Date](https://img.shields.io/badge/date-2023.11.04-c44d58.svg) [![Date](https://img.shields.io/github/release-date/JcDenis/pacKman)](https://git.dotclear.watch/JcDenis/pacKman/releases)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download) [![Issues](https://img.shields.io/github/issues/JcDenis/pacKman)](https://git.dotclear.watch/JcDenis/pacKman/issues)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/pacKman) [![Dotclear](https://img.shields.io/badge/dotclear-v2.27-blue.svg)](https://fr.dotclear.org/download)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/pacKman/src/branch/master/LICENSE) [![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.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)
## ABOUT ## WHAT IS PACKMAN ?
_pacKman_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org). _pacKman_ is a plugin for the open-source
web publishing software called Dotclear.
> Create and manage packages of themes and plugins from Dotclear administration pages. It help super admin to create and manage packages of
themes and plugins from Dotclear administration pages.
## REQUIREMENTS ## REQUIREMENTS
* Dotclear 2.28 _pacKman_ requires:
* Super administrator permissions
* Dotclear 2.27
* PHP 8.1+ * PHP 8.1+
* Dotclear super administrator permissions * A writable cache directory
* System writable cache directory * A writable directory to put packages. (can be VAR dir)
* System writable directory to put packages. (can be VAR dir)
## USAGE ## USAGE
@ -33,15 +38,14 @@ Once it's done you can manage your packages from menu
## LINKS ## LINKS
* [License](https://git.dotclear.watch/JcDenis/pacKman/src/branch/master/LICENSE) * License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html)
* [Packages & details](https://git.dotclear.watch/JcDenis/pacKman/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/pacKman)) * Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/pacKman) or [GitHub Page](https://github.com/JcDenis/pacKman)
* [Sources & contributions](https://git.dotclear.watch/JcDenis/pacKman) (or on [GitHub](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)
* [Issues & security](https://git.dotclear.watch/JcDenis/pacKman/issues) (or on [GitHub](https://github.com/JcDenis/pacKman/issues)) * Discuss and help : [Dotclear Forum](https://forum.dotclear.org/viewtopic.php?id=40066)
* [Discuss & help](https://forum.dotclear.org/viewtopic.php?id=40066)
## CONTRIBUTORS ## CONTRIBUTORS
* Jean-Christian Denis (author) * Jean-Christian Denis
* Philippe aka Dissitou * Philippe aka Dissitou
* franck-paul * franck-paul

24
_define.php
View File

@ -1,26 +1,32 @@
<?php <?php
/** /**
* @file * @brief pacKman, a plugin for Dotclear 2
* @brief The plugin pacKman definition
* @ingroup pacKman
* *
* @defgroup pacKman Plugin pacKman. * @package Dotclear
* * @subpackage Plugin
* Manage your Dotclear packages.
* *
* @author Jean-Christian 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); declare(strict_types=1);
if (!defined('DC_RC_PATH')) {
return null;
}
$this->registerModule( $this->registerModule(
'Packages repository', 'Packages repository',
'Manage your Dotclear packages', 'Manage your Dotclear packages',
'Jean-Christian Denis', 'Jean-Christian Denis',
'2023.11.04', '2023.08.06',
[ [
'requires' => [['core', '2.28']], 'requires' => [
'permissions' => 'My', ['php', '8.1'],
['core', '2.27'],
],
'permissions' => null,
'type' => 'plugin', 'type' => 'plugin',
'support' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues', 'support' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',
'details' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/src/branch/master/README.md', 'details' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/src/branch/master/README.md',

6
dcstore.xml
View File

@ -2,11 +2,11 @@
<modules xmlns:da="http://dotaddict.org/da/"> <modules xmlns:da="http://dotaddict.org/da/">
<module id="pacKman"> <module id="pacKman">
<name>Packages repository</name> <name>Packages repository</name>
<version>2023.11.04</version> <version>2023.08.06</version>
<author>Jean-Christian Denis</author> <author>Jean-Christian Denis</author>
<desc>Manage your Dotclear packages</desc> <desc>Manage your Dotclear packages</desc>
<file>https://git.dotclear.watch/JcDenis/pacKman/releases/download/v2023.11.04/plugin-pacKman.zip</file> <file>https://gitea.dotclear.watch/JcDenis/pacKman/releases/download/v2023.08.06/plugin-pacKman.zip</file>
<da:dcmin>2.28</da:dcmin> <da:dcmin>2.27</da:dcmin>
<da:details>https://git.dotclear.watch/JcDenis/pacKman/src/branch/master/README.md</da:details> <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> <da:support>https://git.dotclear.watch/JcDenis/pacKman/issues</da:support>
</module> </module>

17
locales/fr/resources.php
View File

@ -1,10 +1,19 @@
<?php <?php
/** /**
* @file * @brief pacKman, a plugin for Dotclear 2
* @brief The plugin pacKman locales resources *
* @ingroup pacKman * @package Dotclear
* @subpackage Plugin
* *
* @author Jean-Christian 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
*/ */
\Dotclear\App::backend()->resources()->set('help', 'pacKman', __DIR__ . '/help/help.html'); if (!defined('DC_RC_PATH')) {
return null;
}
if (!isset(dcCore::app()->resources['help']['pacKman'])) {
dcCore::app()->resources['help']['pacKman'] = __DIR__ . '/help/help.html';
}

24
src/Backend.php
View File

@ -1,20 +1,23 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
use Dotclear\App; use dcCore;
use Dotclear\Core\Process; use Dotclear\Core\Process;
use Dotclear\Core\Backend\Favorites; use Dotclear\Core\Backend\Favorites;
/**
* @brief pacKman backend class.
* @ingroup pacKman
*
* @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,12 +33,13 @@ class Backend extends Process
My::addBackendMenuItem(); My::addBackendMenuItem();
App::behavior()->addBehavior('adminDashboardFavoritesV2', function (Favorites $favs): void { dcCore::app()->addBehavior('adminDashboardFavoritesV2', function (Favorites $favs): void {
$favs->register(My::id(), [ $favs->register(My::id(), [
'title' => My::name(), 'title' => My::name(),
'url' => My::manageUrl(), 'url' => My::manageUrl(),
'small-icon' => My::icons(), 'small-icon' => My::icons(),
'large-icon' => My::icons(), 'large-icon' => My::icons(),
//'permissions' => dcCore::app()->auth->isSuperAdmin(),
]); ]);
}); });

39
src/Config.php
View File

@ -1,10 +1,20 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
use Dotclear\App; use dcCore;
use Dotclear\Core\Process; use Dotclear\Core\Process;
use Dotclear\Core\Backend\Notices; use Dotclear\Core\Backend\Notices;
use Dotclear\Helper\Html\Form\{ use Dotclear\Helper\Html\Form\{
@ -20,13 +30,6 @@ use Dotclear\Helper\Html\Form\{
}; };
use Exception; use Exception;
/**
* @brief pacKman configuration class.
* @ingroup pacKman
*
* @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
{ {
public static function init(): bool public static function init(): bool
@ -59,13 +62,13 @@ class Config extends Process
Notices::addSuccessNotice( Notices::addSuccessNotice(
__('Configuration has been successfully updated.') __('Configuration has been successfully updated.')
); );
App::backend()->url()->redirect('admin.plugins', [ dcCore::app()->admin->url->redirect('admin.plugins', [
'module' => My::id(), 'module' => My::id(),
'conf' => '1', 'conf' => '1',
'redir' => App::backend()->__get('list')->getRedir(), 'redir' => dcCore::app()->admin->__get('list')->getRedir(),
]); ]);
} catch (Exception $e) { } catch (Exception $e) {
App::error()->add($e->getMessage()); dcCore::app()->error->add($e->getMessage());
} }
return true; return true;
@ -111,13 +114,13 @@ class Config extends Process
// pack_repository // pack_repository
(new Para())->items([ (new Para())->items([
(new Label($check_repo . __('Path to repository:')))->for('pack_repository'), (new Label($check_repo . __('Path to repository:')))->for('pack_repository'),
(new Input('pack_repository'))->class('maximal')->size(65)->maxlength(255)->value($s->pack_repository), (new Input('pack_repository'))->class('maximal')->size(65)->maxlenght(255)->value($s->pack_repository),
]), ]),
(new Note())->class('form-note')->text( (new Note())->class('form-note')->text(
sprintf( sprintf(
__('Preconization: %s'), __('Preconization: %s'),
App::blog()->publicPath() == '' ? dcCore::app()->blog?->public_path ?
App::blog()->publicPath() : __("Blog's public directory") dcCore::app()->blog->public_path : __("Blog's public directory")
) . ' ' . __('Leave it empty to use Dotclear VAR directory') ) . ' ' . __('Leave it empty to use Dotclear VAR directory')
), ),
// pack_overwrite // pack_overwrite
@ -131,13 +134,13 @@ class Config extends Process
// pack_filename // pack_filename
(new Para())->items([ (new Para())->items([
(new Label($check_first . __('Name of exported package:')))->for('pack_filename'), (new Label($check_first . __('Name of exported package:')))->for('pack_filename'),
(new Input('pack_filename'))->class('maximal')->size(65)->maxlength(255)->value($s->pack_filename), (new Input('pack_filename'))->class('maximal')->size(65)->maxlenght(255)->value($s->pack_filename),
]), ]),
(new Note())->text(sprintf(__('Preconization: %s'), '%type%-%id%'))->class('form-note'), (new Note())->text(sprintf(__('Preconization: %s'), '%type%-%id%'))->class('form-note'),
// secondpack_filename // secondpack_filename
(new Para())->items([ (new Para())->items([
(new Label($check_second . __('Name of second exported package:')))->for('secondpack_filename'), (new Label($check_second . __('Name of second exported package:')))->for('secondpack_filename'),
(new Input('secondpack_filename'))->class('maximal')->size(65)->maxlength(255)->value($s->secondpack_filename), (new Input('secondpack_filename'))->class('maximal')->size(65)->maxlenght(255)->value($s->secondpack_filename),
]), ]),
(new Note())->text(sprintf(__('Preconization: %s'), '%type%-%id%-%version%'))->class('form-note'), (new Note())->text(sprintf(__('Preconization: %s'), '%type%-%id%-%version%'))->class('form-note'),
// pack_overwrite // pack_overwrite
@ -150,7 +153,7 @@ class Config extends Process
// pack_excludefiles // pack_excludefiles
(new Para())->items([ (new Para())->items([
(new Label(__('Extra files to exclude from package:')))->for('pack_excludefiles'), (new Label(__('Extra files to exclude from package:')))->for('pack_excludefiles'),
(new Input('pack_excludefiles'))->class('maximal')->size(65)->maxlength(255)->value($s->pack_excludefiles), (new Input('pack_excludefiles'))->class('maximal')->size(65)->maxlenght(255)->value($s->pack_excludefiles),
]), ]),
(new Note())->text(sprintf(__('Preconization: %s'), '*.zip,*.tar,*.tar.gz'))->class('form-note'), (new Note())->text(sprintf(__('Preconization: %s'), '*.zip,*.tar,*.tar.gz'))->class('form-note'),
// pack_nocomment // pack_nocomment

67
src/Core.php
View File

@ -1,32 +1,29 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
use Dotclear\App; use dcCore;
use dcModuleDefine;
use dcModules;
use Dotclear\Helper\File\Files; use Dotclear\Helper\File\Files;
use Dotclear\Helper\File\Path; use Dotclear\Helper\File\Path;
use Dotclear\Helper\File\Zip\Unzip; use Dotclear\Helper\File\Zip\Unzip;
use Dotclear\Module\ModuleDefine;
use Exception; use Exception;
/**
* @brief pacKman main class.
* @ingroup pacKman
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Core 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 public static function quote_exclude(array $exclude): array
{ {
foreach ($exclude as $k => $v) { foreach ($exclude as $k => $v) {
@ -40,13 +37,6 @@ class Core
return $exclude; 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 public static function getPackages(string $root): array
{ {
$res = []; $res = [];
@ -69,8 +59,8 @@ class Core
} }
$sandboxes = [ $sandboxes = [
'theme' => clone App::themes(), 'theme' => clone dcCore::app()->themes,
'plugin' => clone App::plugins(), 'plugin' => clone dcCore::app()->plugins,
]; ];
$i = 0; $i = 0;
@ -83,13 +73,13 @@ class Core
if ($zip_root_dir != false) { if ($zip_root_dir != false) {
$target = dirname($zip_file); $target = dirname($zip_file);
$path = $target . DIRECTORY_SEPARATOR . $zip_root_dir; $path = $target . DIRECTORY_SEPARATOR . $zip_root_dir;
$define = $zip_root_dir . '/' . App::plugins()::MODULE_FILE_DEFINE; $define = $zip_root_dir . '/' . dcModules::MODULE_FILE_DEFINE;
$init = $zip_root_dir . '/' . App::plugins()::MODULE_FILE_INIT; $init = $zip_root_dir . '/' . dcModules::MODULE_FILE_INIT;
} else { } else {
$target = dirname($zip_file) . DIRECTORY_SEPARATOR . preg_replace('/\.([^.]+)$/', '', basename($zip_file)); $target = dirname($zip_file) . DIRECTORY_SEPARATOR . preg_replace('/\.([^.]+)$/', '', basename($zip_file));
$path = $target; $path = $target;
$define = App::plugins()::MODULE_FILE_DEFINE; $define = dcModules::MODULE_FILE_DEFINE;
$init = App::plugins()::MODULE_FILE_INIT; $init = dcModules::MODULE_FILE_INIT;
} }
if ($zip->isEmpty()) { if ($zip->isEmpty()) {
@ -145,20 +135,7 @@ class Core
return $res; return $res;
} }
/** public static function pack(dcModuleDefine $define, string $root, array $files, bool $overwrite = false, array $exclude = [], bool $nocomment = false, bool $fixnewline = false): bool
* 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 // check define
if (!$define->isDefined() if (!$define->isDefined()
@ -218,7 +195,7 @@ class Core
return true; return true;
} }
private static function getFile(string $file, ModuleDefine $define): string private static function getFile(string $file, dcModuleDefine $define): string
{ {
$file = str_replace( $file = str_replace(
[ [

34
src/Install.php
View File

@ -1,20 +1,24 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
use Dotclear\App; use dcCore;
use dcNamespace;
use Dotclear\Core\Process; use Dotclear\Core\Process;
use Exception; use Exception;
/**
* @brief pacKman install class.
* @ingroup pacKman
*
* @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
@ -34,7 +38,7 @@ class Install extends Process
return true; return true;
} catch (Exception $e) { } catch (Exception $e) {
App::error()->add($e->getMessage()); dcCore::app()->error->add($e->getMessage());
return false; return false;
} }
@ -42,23 +46,23 @@ class Install extends Process
public static function growUp(): void public static function growUp(): void
{ {
$current = App::version()->getVersion(My::id()); $current = dcCore::app()->getVersion(My::id());
// Update settings id, ns // Update settings id, ns
if ($current && version_compare($current, '2022.12.19.1', '<=')) { if ($current && version_compare($current, '2022.12.19.1', '<=')) {
$record = App::con()->select( $record = dcCore::app()->con->select(
'SELECT * FROM ' . App::con()->prefix() . App::blogWorkspace()::NS_TABLE_NAME . ' ' . 'SELECT * FROM ' . dcCore::app()->prefix . dcNamespace::NS_TABLE_NAME . ' ' .
"WHERE setting_ns = 'pacKman' " "WHERE setting_ns = 'pacKman' "
); );
while ($record->fetch()) { while ($record->fetch()) {
if (preg_match('/^packman_(.*?)$/', $record->f('setting_id'), $match)) { if (preg_match('/^packman_(.*?)$/', $record->f('setting_id'), $match)) {
$cur = App::blogWorkspace()->openBlogWorkspaceCursor(); $cur = dcCore::app()->con->openCursor(dcCore::app()->prefix . dcNamespace::NS_TABLE_NAME);
$cur->setField('setting_id', $match[1]); $cur->setField('setting_id', $match[1]);
$cur->setField('setting_ns', My::id()); $cur->setField('setting_ns', My::id());
$cur->update( $cur->update(
"WHERE setting_id = '" . $record->f('setting_id') . "' and setting_ns = 'pacKman' " . "WHERE setting_id = '" . $record->f('setting_id') . "' and setting_ns = 'pacKman' " .
'AND blog_id ' . (null === $record->f('blog_id') ? 'IS NULL ' : ("= '" . App::con()->escapeStr($record->f('blog_id')) . "' ")) 'AND blog_id ' . (null === $record->f('blog_id') ? 'IS NULL ' : ("= '" . dcCore::app()->con->escapeStr($record->f('blog_id')) . "' "))
); );
} }
} }

74
src/Manage.php
View File

@ -1,10 +1,22 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
use Dotclear\App; /* dotclear ns */
use dcCore;
use dcThemes;
use Dotclear\Core\Process; use Dotclear\Core\Process;
use Dotclear\Core\Backend\{ use Dotclear\Core\Backend\{
Notices, Notices,
@ -18,13 +30,6 @@ use Dotclear\Helper\Html\Form\{
use Dotclear\Helper\Network\Http; use Dotclear\Helper\Network\Http;
use Exception; use Exception;
/**
* @brief pacKman manage page class.
* @ingroup pacKman
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Manage extends Process class Manage extends Process
{ {
public static function init(): bool public static function init(): bool
@ -48,9 +53,12 @@ class Manage extends Process
$dir = Utils::getRepositoryDir($s->pack_repository, $repo); $dir = Utils::getRepositoryDir($s->pack_repository, $repo);
# Modules # Modules
if (App::themes()->isEmpty()) { if (!(dcCore::app()->themes instanceof dcThemes)) {
App::themes()->loadModules(App::blog()->themesPath(), null); dcCore::app()->themes = new dcThemes();
dcCore::app()->themes->loadModules((string) dcCore::app()->blog?->themes_path, null);
} }
$themes = dcCore::app()->themes;
$plugins = dcCore::app()->plugins;
# Rights # Rights
$is_writable = Utils::isWritable($dir, $s->pack_filename); $is_writable = Utils::isWritable($dir, $s->pack_filename);
@ -77,7 +85,7 @@ class Manage extends Process
&& is_file($module->get('root')) && is_readable($module->get('root')) && is_file($module->get('root')) && is_readable($module->get('root'))
) { ) {
# --BEHAVIOR-- packmanBeforeDownloadPackage # --BEHAVIOR-- packmanBeforeDownloadPackage
App::behavior()->callBehavior('packmanBeforeDownloadPackage', $module->dump(), $type); dcCore::app()->callBehavior('packmanBeforeDownloadPackage', $module->dump(), $type);
header('Content-Type: application/zip'); header('Content-Type: application/zip');
header('Content-Length: ' . filesize($module->get('root'))); header('Content-Length: ' . filesize($module->get('root')));
@ -85,7 +93,7 @@ class Manage extends Process
readfile($module->get('root')); readfile($module->get('root'));
# --BEHAVIOR-- packmanAfterDownloadPackage # --BEHAVIOR-- packmanAfterDownloadPackage
App::behavior()->callBehavior('packmanAfterDownloadPackage', $module->dump(), $type); dcCore::app()->callBehavior('packmanAfterDownloadPackage', $module->dump(), $type);
exit; exit;
} }
@ -109,22 +117,14 @@ class Manage extends Process
# Pack # Pack
} elseif ($action == 'packup') { } elseif ($action == 'packup') {
foreach ($_POST['modules'] as $root => $id) { foreach ($_POST['modules'] as $root => $id) {
if ($type == 'themes') { if (!dcCore::app()->{$type}->getDefine($id)->isDefined()) {
if (!App::themes()->getDefine($id)->isDefined()) {
throw new Exception('No such module'); throw new Exception('No such module');
} }
$module = App::themes()->getDefine($id); $module = dcCore::app()->{$type}->getDefine($id);
} else {
if (!App::plugins()->getDefine($id)->isDefined()) {
throw new Exception('No such module');
}
$module = App::plugins()->getDefine($id);
}
# --BEHAVIOR-- packmanBeforeCreatePackage # --BEHAVIOR-- packmanBeforeCreatePackage
App::behavior()->callBehavior('packmanBeforeCreatePackage', $module->dump()); dcCore::app()->callBehavior('packmanBeforeCreatePackage', $module->dump());
Core::pack( Core::pack(
$module, $module,
@ -137,7 +137,7 @@ class Manage extends Process
); );
# --BEHAVIOR-- packmanAfterCreatePackage # --BEHAVIOR-- packmanAfterCreatePackage
App::behavior()->callBehavior('packmanAfterCreatePackage', $module->dump()); dcCore::app()->callBehavior('packmanAfterCreatePackage', $module->dump());
} }
Notices::addSuccessNotice( Notices::addSuccessNotice(
@ -179,13 +179,17 @@ class Manage extends Process
} elseif ($action == 'install') { } elseif ($action == 'install') {
foreach ($_POST['modules'] as $root => $id) { foreach ($_POST['modules'] as $root => $id) {
# --BEHAVIOR-- packmanBeforeInstallPackage # --BEHAVIOR-- packmanBeforeInstallPackage
App::behavior()->callBehavior('packmanBeforeInstallPackage', $type, $id, $root); dcCore::app()->callBehavior('packmanBeforeInstallPackage', $type, $id, $root);
$mods = $type == 'themes' ? App::themes() : App::plugins(); if ($type == 'plugins') {
$mods->installPackage($root, $mods); $plugins->installPackage($root, $plugins);
}
if ($type == 'themes') {
$themes->installPackage($root, $themes);
}
# --BEHAVIOR-- packmanAfterInstallPackage # --BEHAVIOR-- packmanAfterInstallPackage
App::behavior()->callBehavior('packmanAfterInstallPackage', $type, $id, $root); dcCore::app()->callBehavior('packmanAfterInstallPackage', $type, $id, $root);
} }
Notices::addSuccessNotice( Notices::addSuccessNotice(
@ -252,7 +256,7 @@ class Manage extends Process
} }
} }
} catch (Exception $e) { } catch (Exception $e) {
App::error()->add($e->getMessage()); dcCore::app()->error->add($e->getMessage());
} }
return true; return true;
@ -297,7 +301,7 @@ class Manage extends Process
My::jsLoad('backend') . My::jsLoad('backend') .
# --BEHAVIOR-- packmanAdminHeader # --BEHAVIOR-- packmanAdminHeader
App::behavior()->callBehavior('packmanAdminHeader') dcCore::app()->callBehavior('packmanAdminHeader')
); );
echo echo
@ -307,7 +311,7 @@ class Manage extends Process
]) . ]) .
Notices::GetNotices(); Notices::GetNotices();
if (App::error()->flag() || !$is_configured || !$is_plugins_configured || !$is_themes_configured) { if (dcCore::app()->error->flag() || !$is_configured || !$is_plugins_configured || !$is_themes_configured) {
echo echo
(new Div()) (new Div())
->separator(' ') ->separator(' ')
@ -318,13 +322,13 @@ class Manage extends Process
->render(); ->render();
} else { } else {
Utils::modules( Utils::modules(
App::plugins()->getDefines((new Settings())->hide_distrib ? ['distributed' => false] : []), dcCore::app()->plugins->getDefines((new Settings())->hide_distrib ? ['distributed' => false] : []),
'plugins', 'plugins',
__('Installed plugins') __('Installed plugins')
); );
Utils::modules( Utils::modules(
App::themes()->getDefines((new Settings())->hide_distrib ? ['distributed' => false] : []), dcCore::app()->themes->getDefines((new Settings())->hide_distrib ? ['distributed' => false] : []),
'themes', 'themes',
__('Installed themes') __('Installed themes')
); );
@ -371,7 +375,7 @@ class Manage extends Process
} }
# --BEHAVIOR-- packmanAdminTabs # --BEHAVIOR-- packmanAdminTabs
App::behavior()->callBehavior('packmanAdminTabs'); dcCore::app()->callBehavior('packmanAdminTabs');
Page::helpBlock('pacKman'); Page::helpBlock('pacKman');
Page::closeModule(); Page::closeModule();

32
src/My.php
View File

@ -1,26 +1,28 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
use Dotclear\App; use dcCore;
use Dotclear\Module\MyPlugin; use Dotclear\Module\MyPlugin;
/** /**
* @brief pacKman My plugin helper. * This module definitions.
* @ingroup pacKman
*
* @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
{ {
/** /** @var array Excluded files */
* Excluded files.
*
* @var array<int,string> EXCLUDED_FILES
*/
public const EXCLUDED_FILES = [ public const EXCLUDED_FILES = [
'.', '.',
'..', '..',
@ -36,10 +38,6 @@ class My extends MyPlugin
public static function checkCustomContext(int $context): ?bool public static function checkCustomContext(int $context): ?bool
{ {
return match ($context) { return in_array($context, [My::BACKEND, My::MANAGE, My::MENU]) ? dcCore::app()->auth->isSuperAdmin() : null;
// Limit to super admin
self::MODULE => App::auth()->isSuperAdmin(),
default => null,
};
} }
} }

108
src/Settings.php
View File

@ -1,113 +1,73 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
/**
* @brief pacKman settings class.
* @ingroup pacKman
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Settings class Settings
{ {
/** // Remove comments from files
* Remove comments from files.
*
* @var bool $pack_nocomment
*/
public readonly bool $pack_nocomment; public readonly bool $pack_nocomment;
/** // Remove comments from files
* Remove comments from files.
*
* @var bool $pack_fixnewline
*/
public readonly bool $pack_fixnewline; public readonly bool $pack_fixnewline;
/** // Overwrite existing package
* Overwrite existing package.
*
* @var bool $pack_overwrite
*/
public readonly bool $pack_overwrite; public readonly bool $pack_overwrite;
/** // Name of package
* Name of package.
*
* @var string $pack_filename
*/
public readonly string $pack_filename; public readonly string $pack_filename;
/** // Name of second package
* Name of second package.
*
* @var string $secondpack_filename
*/
public readonly string $secondpack_filename; public readonly string $secondpack_filename;
/** // Path to package repository
* Path to package repository.
*
* @var string $pack_repository
*/
public readonly string $pack_repository; public readonly string $pack_repository;
/** // Seperate themes and plugins repository
* Seperate themes and plugins repository.
*
* @var bool $pack_typedrepo
*/
public readonly bool $pack_typedrepo; public readonly bool $pack_typedrepo;
/** // Extra files to exclude from package
* Extra files to exclude from package.
*
* @var string $pack_excludefiles
*/
public readonly string $pack_excludefiles; public readonly string $pack_excludefiles;
/** // Hide distributed modules from lists
* Hide distributed modules from lists.
*
* @var bool $hide_distrib
*/
public readonly bool $hide_distrib; public readonly bool $hide_distrib;
/** /**
* Constructor set up plugin settings. * Constructor set up plugin settings
*/ */
public function __construct() public function __construct()
{ {
$s = My::settings(); $s = My::settings();
$this->pack_nocomment = (bool) ($s->get('pack_nocomment') ?? false); $this->pack_nocomment = (bool) ($s?->get('pack_nocomment') ?? false);
$this->pack_fixnewline = (bool) ($s->get('pack_fixnewline') ?? false); $this->pack_fixnewline = (bool) ($s?->get('pack_fixnewline') ?? false);
$this->pack_overwrite = (bool) ($s->get('pack_overwrite') ?? false); $this->pack_overwrite = (bool) ($s?->get('pack_overwrite') ?? false);
$this->pack_filename = (string) ($s->get('pack_filename') ?? '%type%-%id%'); $this->pack_filename = (string) ($s?->get('pack_filename') ?? '%type%-%id%');
$this->secondpack_filename = (string) ($s->get('secondpack_filename') ?? '%type%-%id%-%version%'); $this->secondpack_filename = (string) ($s?->get('secondpack_filename') ?? '%type%-%id%-%version%');
$this->pack_repository = (string) ($s->get('pack_repository') ?? ''); $this->pack_repository = (string) ($s?->get('pack_repository') ?? '');
$this->pack_typedrepo = (bool) ($s->get('pack_typedrepo') ?? false); $this->pack_typedrepo = (bool) ($s?->get('pack_typedrepo') ?? false);
$this->pack_excludefiles = (string) ($s->get('pack_excludefiles') ?? '*.zip,*.tar,*.tar.gz,.directory,.hg'); $this->pack_excludefiles = (string) ($s?->get('pack_excludefiles') ?? '*.zip,*.tar,*.tar.gz,.directory,.hg');
$this->hide_distrib = (bool) ($s->get('hide_distrib') ?? false); $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; return $this->{$key} ?? null;
} }
/** /**
* Overwrite a plugin settings (in db). * Overwrite a plugin settings (in db)
* *
* @param string $key The setting ID * @param string $key The setting ID
* @param mixed $value The setting value * @param mixed $value The setting value
@ -127,9 +87,9 @@ class Settings
} }
/** /**
* List defined settings keys. * List defined settings keys
* *
* @return array<string,bool|string> The settings keys * @return array The settings keys
*/ */
public function listSettings(): array public function listSettings(): array
{ {

22
src/Uninstall.php
View File

@ -1,19 +1,23 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
use dcCore;
use Dotclear\Core\Process; use Dotclear\Core\Process;
use Dotclear\Plugin\Uninstaller\Uninstaller; use Dotclear\Plugin\Uninstaller\Uninstaller;
/**
* @brief pacKman Uninstaller class.
* @ingroup pacKman
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Uninstall extends Process class Uninstall extends Process
{ {
public static function init(): bool public static function init(): bool
@ -23,7 +27,7 @@ class Uninstall extends Process
public static function process(): bool public static function process(): bool
{ {
if (!self::status()) { if (!self::status() || !dcCore::app()->plugins->moduleExists('Uninstaller')) {
return false; return false;
} }

68
src/Utils.php
View File

@ -1,10 +1,20 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; namespace Dotclear\Plugin\pacKman;
use Dotclear\App; use dcCore;
use Dotclear\Helper\Date; use Dotclear\Helper\Date;
use Dotclear\Helper\File\Files; use Dotclear\Helper\File\Files;
use Dotclear\Helper\File\Path; use Dotclear\Helper\File\Path;
@ -21,21 +31,13 @@ use Dotclear\Helper\Html\Form\{
Text Text
}; };
use Dotclear\Helper\Html\Html; use Dotclear\Helper\Html\Html;
use Dotclear\Module\ModuleDefine;
use Exception; use Exception;
/**
* @brief pacKman utils class.
* @ingroup pacKman
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Utils class Utils
{ {
public static function getPluginsPath(): string public static function getPluginsPath(): string
{ {
$e = explode(PATH_SEPARATOR, App::config()->pluginsRoot()); $e = explode(PATH_SEPARATOR, DC_PLUGINS_ROOT);
$p = array_pop($e); $p = array_pop($e);
return (string) Path::real($p); return (string) Path::real($p);
@ -43,37 +45,37 @@ class Utils
public static function getThemesPath(): string public static function getThemesPath(): string
{ {
return App::blog()->themesPath(); return (string) dcCore::app()->blog?->themes_path;
} }
public static function isConfigured(string $repo, string $file_a, string $file_b): bool public static function isConfigured(string $repo, string $file_a, string $file_b): bool
{ {
sleep(1); sleep(1);
if (!is_writable($repo)) { if (!is_writable($repo)) {
App::error()->add( dcCore::app()->error->add(
__('Path to repository is not writable.') __('Path to repository is not writable.')
); );
} }
if (empty($file_a)) { if (empty($file_a)) {
App::error()->add( dcCore::app()->error->add(
__('You must specify the name of package to export.') __('You must specify the name of package to export.')
); );
} }
if (!is_writable(dirname($repo . DIRECTORY_SEPARATOR . $file_a))) { if (!is_writable(dirname($repo . DIRECTORY_SEPARATOR . $file_a))) {
App::error()->add( dcCore::app()->error->add(
__('Path to first export package is not writable.') __('Path to first export package is not writable.')
); );
} }
if (!empty($file_b) && !is_writable(dirname($repo . DIRECTORY_SEPARATOR . $file_b))) { if (!empty($file_b) && !is_writable(dirname($repo . DIRECTORY_SEPARATOR . $file_b))) {
App::error()->add( dcCore::app()->error->add(
__('Path to second export package is not writable.') __('Path to second export package is not writable.')
); );
} }
return !App::error()->flag(); return !dcCore::app()->error->flag();
} }
public static function isWritable(string $path, string $file): bool public static function isWritable(string $path, string $file): bool
@ -84,7 +86,7 @@ class Utils
public static function getRepositoryDir(?string $dir, ?string $typed = null): string public static function getRepositoryDir(?string $dir, ?string $typed = null): string
{ {
$typed = empty($typed) ? '' : DIRECTORY_SEPARATOR . ($typed == 'themes' ? 'themes' : 'plugins'); $typed = empty($typed) ? '' : DIRECTORY_SEPARATOR . ($typed == 'themes' ? 'themes' : 'plugins');
$dir = empty($dir) ? App::config()->varRoot() . DIRECTORY_SEPARATOR . 'packman' . $typed : $dir . $typed; $dir = empty($dir) ? DC_VAR . DIRECTORY_SEPARATOR . 'packman' . $typed : $dir . $typed;
try { try {
@Files::makeDir($dir, true); @Files::makeDir($dir, true);
@ -95,15 +97,6 @@ class Utils
return $dir; return $dir;
} }
/**
* Get modules list form.
*
* @param array<int|string, mixed> $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 public static function modules(array $modules, string $type, string $title): ?bool
{ {
if (empty($modules)) { if (empty($modules)) {
@ -116,9 +109,6 @@ class Utils
$tbody = []; $tbody = [];
self::sort($modules); self::sort($modules);
foreach ($modules as $module) { foreach ($modules as $module) {
if (!is_a($module, ModuleDefine::class)) {
continue;
}
$tbody[] = (new Para(null, 'tr')) $tbody[] = (new Para(null, 'tr'))
->class('line') ->class('line')
->items([ ->items([
@ -188,15 +178,6 @@ class Utils
return true; 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 public static function repository(array $modules, string $type, string $title): ?bool
{ {
if (empty($modules)) { if (empty($modules)) {
@ -228,7 +209,7 @@ class Utils
if (str_contains($type, 'repository')) { if (str_contains($type, 'repository')) {
$helpers_addon[] = (new Link()) $helpers_addon[] = (new Link())
->class('button') ->class('button')
->href(App::backend()->url()->get('admin.plugin.' . My::id(), ['purge' => 1]) . '#packman-repository-' . $type) ->href(dcCore::app()->adminurl?->get('admin.plugin.' . My::id(), ['purge' => 1]) . '#packman-repository-' . $type)
->text(__('Select non lastest versions')) ->text(__('Select non lastest versions'))
; ;
} }
@ -276,7 +257,7 @@ class Utils
(new Text('a', Html::escapeHTML(basename($module->get('root'))))) (new Text('a', Html::escapeHTML(basename($module->get('root')))))
->class('packman-download') ->class('packman-download')
->extra( ->extra(
'href="' . App::backend()->url()->get('admin.plugin.' . My::id(), [ 'href="' . dcCore::app()->adminurl?->get('admin.plugin.' . My::id(), [
'package' => basename($module->get('root')), 'package' => basename($module->get('root')),
'repo' => $type, 'repo' => $type,
]) . '"' ]) . '"'
@ -342,11 +323,6 @@ class Utils
return true; return true;
} }
/**
* Sort modules by id.
*
* @param array<int,ModuleDefine> $modules The modules
*/
protected static function sort(array &$modules): void protected static function sort(array &$modules): void
{ {
uasort($modules, fn ($a, $b) => $a->get('version') <=> $b->get('version')); uasort($modules, fn ($a, $b) => $a->get('version') <=> $b->get('version'));

44
src/Zip.php
View File

@ -1,33 +1,25 @@
<?php <?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); declare(strict_types=1);
namespace Dotclear\Plugin\pacKman; 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 GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Zip extends \Dotclear\Helper\File\Zip\Zip 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; 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; public static $fix_newline = false;
/** /**
@ -35,12 +27,12 @@ class Zip extends \Dotclear\Helper\File\Zip\Zip
* *
* @param string $name The name * @param string $name The name
* @param string $file The file * @param string $file The file
* @param float|int $size The size * @param string $size The size
* @param float|int $mtime The mtime * @param int|null $mtime The mtime
* *
* @return void * @return void
*/ */
protected function writeFile(string $name, string $file, int|float $size, int|float $mtime): void protected function writeFile($name, $file, $size, $mtime)
{ {
if (!isset($this->entries[$name])) { if (!isset($this->entries[$name])) {
return; return;
@ -67,8 +59,8 @@ class Zip extends \Dotclear\Helper\File\Zip\Zip
unset($content); unset($content);
$mdate = $this->makeDate((int) $mtime); $mdate = $this->makeDate($mtime);
$mtime = $this->makeTime((int) $mtime); $mtime = $this->makeTime($mtime);
# Data descriptor # Data descriptor
$data_desc = "\x50\x4b\x03\x04" . $data_desc = "\x50\x4b\x03\x04" .