Compare commits

..

12 Commits

15 changed files with 373 additions and 283 deletions

View File

@ -1,4 +1,35 @@
pacKman 2023.07.29 pacKman 2023.11.04
===========================================================
* 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+

View File

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

View File

@ -1,32 +1,26 @@
<?php <?php
/** /**
* @brief pacKman, a plugin for Dotclear 2 * @file
* @brief The plugin pacKman definition
* @ingroup pacKman
* *
* @package Dotclear * @defgroup pacKman Plugin pacKman.
* @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.08.06', '2023.11.04',
[ [
'requires' => [ 'requires' => [['core', '2.28']],
['php', '8.1'], 'permissions' => 'My',
['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',

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.08.06</version> <version>2023.11.04</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://gitea.dotclear.watch/JcDenis/pacKman/releases/download/v2023.08.06/plugin-pacKman.zip</file> <file>https://git.dotclear.watch/JcDenis/pacKman/releases/download/v2023.11.04/plugin-pacKman.zip</file>
<da:dcmin>2.27</da:dcmin> <da:dcmin>2.28</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>

View File

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

View File

@ -1,23 +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 dcCore; use Dotclear\App;
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
@ -33,13 +30,12 @@ class Backend extends Process
My::addBackendMenuItem(); My::addBackendMenuItem();
dcCore::app()->addBehavior('adminDashboardFavoritesV2', function (Favorites $favs): void { App::behavior()->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(),
]); ]);
}); });

View File

@ -1,20 +1,10 @@
<?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\App;
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\{
@ -30,6 +20,13 @@ 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
@ -62,13 +59,13 @@ class Config extends Process
Notices::addSuccessNotice( Notices::addSuccessNotice(
__('Configuration has been successfully updated.') __('Configuration has been successfully updated.')
); );
dcCore::app()->admin->url->redirect('admin.plugins', [ App::backend()->url()->redirect('admin.plugins', [
'module' => My::id(), 'module' => My::id(),
'conf' => '1', 'conf' => '1',
'redir' => dcCore::app()->admin->__get('list')->getRedir(), 'redir' => App::backend()->__get('list')->getRedir(),
]); ]);
} catch (Exception $e) { } catch (Exception $e) {
dcCore::app()->error->add($e->getMessage()); App::error()->add($e->getMessage());
} }
return true; return true;
@ -114,13 +111,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)->maxlenght(255)->value($s->pack_repository), (new Input('pack_repository'))->class('maximal')->size(65)->maxlength(255)->value($s->pack_repository),
]), ]),
(new Note())->class('form-note')->text( (new Note())->class('form-note')->text(
sprintf( sprintf(
__('Preconization: %s'), __('Preconization: %s'),
dcCore::app()->blog?->public_path ? App::blog()->publicPath() == '' ?
dcCore::app()->blog->public_path : __("Blog's public directory") App::blog()->publicPath() : __("Blog's public directory")
) . ' ' . __('Leave it empty to use Dotclear VAR directory') ) . ' ' . __('Leave it empty to use Dotclear VAR directory')
), ),
// pack_overwrite // pack_overwrite
@ -134,13 +131,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)->maxlenght(255)->value($s->pack_filename), (new Input('pack_filename'))->class('maximal')->size(65)->maxlength(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)->maxlenght(255)->value($s->secondpack_filename), (new Input('secondpack_filename'))->class('maximal')->size(65)->maxlength(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
@ -153,7 +150,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)->maxlenght(255)->value($s->pack_excludefiles), (new Input('pack_excludefiles'))->class('maximal')->size(65)->maxlength(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

View File

@ -1,29 +1,32 @@
<?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\App;
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) {
@ -37,6 +40,13 @@ 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 = [];
@ -59,8 +69,8 @@ class Core
} }
$sandboxes = [ $sandboxes = [
'theme' => clone dcCore::app()->themes, 'theme' => clone App::themes(),
'plugin' => clone dcCore::app()->plugins, 'plugin' => clone App::plugins(),
]; ];
$i = 0; $i = 0;
@ -73,13 +83,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 . '/' . dcModules::MODULE_FILE_DEFINE; $define = $zip_root_dir . '/' . App::plugins()::MODULE_FILE_DEFINE;
$init = $zip_root_dir . '/' . dcModules::MODULE_FILE_INIT; $init = $zip_root_dir . '/' . App::plugins()::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 = dcModules::MODULE_FILE_DEFINE; $define = App::plugins()::MODULE_FILE_DEFINE;
$init = dcModules::MODULE_FILE_INIT; $init = App::plugins()::MODULE_FILE_INIT;
} }
if ($zip->isEmpty()) { if ($zip->isEmpty()) {
@ -135,7 +145,20 @@ 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()
@ -195,7 +218,7 @@ class Core
return true; return true;
} }
private static function getFile(string $file, dcModuleDefine $define): string private static function getFile(string $file, ModuleDefine $define): string
{ {
$file = str_replace( $file = str_replace(
[ [

View File

@ -1,24 +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 dcCore; use Dotclear\App;
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
@ -38,7 +34,7 @@ class Install extends Process
return true; return true;
} catch (Exception $e) { } catch (Exception $e) {
dcCore::app()->error->add($e->getMessage()); App::error()->add($e->getMessage());
return false; return false;
} }
@ -46,23 +42,23 @@ class Install extends Process
public static function growUp(): void public static function growUp(): void
{ {
$current = dcCore::app()->getVersion(My::id()); $current = App::version()->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 = dcCore::app()->con->select( $record = App::con()->select(
'SELECT * FROM ' . dcCore::app()->prefix . dcNamespace::NS_TABLE_NAME . ' ' . 'SELECT * FROM ' . App::con()->prefix() . App::blogWorkspace()::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 = dcCore::app()->con->openCursor(dcCore::app()->prefix . dcNamespace::NS_TABLE_NAME); $cur = App::blogWorkspace()->openBlogWorkspaceCursor();
$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 ' : ("= '" . dcCore::app()->con->escapeStr($record->f('blog_id')) . "' ")) 'AND blog_id ' . (null === $record->f('blog_id') ? 'IS NULL ' : ("= '" . App::con()->escapeStr($record->f('blog_id')) . "' "))
); );
} }
} }

View File

@ -1,22 +1,10 @@
<?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;
/* dotclear ns */ use Dotclear\App;
use dcCore;
use dcThemes;
use Dotclear\Core\Process; use Dotclear\Core\Process;
use Dotclear\Core\Backend\{ use Dotclear\Core\Backend\{
Notices, Notices,
@ -30,6 +18,13 @@ 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
@ -53,12 +48,9 @@ class Manage extends Process
$dir = Utils::getRepositoryDir($s->pack_repository, $repo); $dir = Utils::getRepositoryDir($s->pack_repository, $repo);
# Modules # Modules
if (!(dcCore::app()->themes instanceof dcThemes)) { if (App::themes()->isEmpty()) {
dcCore::app()->themes = new dcThemes(); App::themes()->loadModules(App::blog()->themesPath(), null);
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);
@ -85,7 +77,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
dcCore::app()->callBehavior('packmanBeforeDownloadPackage', $module->dump(), $type); App::behavior()->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')));
@ -93,7 +85,7 @@ class Manage extends Process
readfile($module->get('root')); readfile($module->get('root'));
# --BEHAVIOR-- packmanAfterDownloadPackage # --BEHAVIOR-- packmanAfterDownloadPackage
dcCore::app()->callBehavior('packmanAfterDownloadPackage', $module->dump(), $type); App::behavior()->callBehavior('packmanAfterDownloadPackage', $module->dump(), $type);
exit; exit;
} }
@ -117,14 +109,22 @@ 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 (!dcCore::app()->{$type}->getDefine($id)->isDefined()) { if ($type == 'themes') {
if (!App::themes()->getDefine($id)->isDefined()) {
throw new Exception('No such module'); throw new Exception('No such module');
} }
$module = dcCore::app()->{$type}->getDefine($id); $module = App::themes()->getDefine($id);
} else {
if (!App::plugins()->getDefine($id)->isDefined()) {
throw new Exception('No such module');
}
$module = App::plugins()->getDefine($id);
}
# --BEHAVIOR-- packmanBeforeCreatePackage # --BEHAVIOR-- packmanBeforeCreatePackage
dcCore::app()->callBehavior('packmanBeforeCreatePackage', $module->dump()); App::behavior()->callBehavior('packmanBeforeCreatePackage', $module->dump());
Core::pack( Core::pack(
$module, $module,
@ -137,7 +137,7 @@ class Manage extends Process
); );
# --BEHAVIOR-- packmanAfterCreatePackage # --BEHAVIOR-- packmanAfterCreatePackage
dcCore::app()->callBehavior('packmanAfterCreatePackage', $module->dump()); App::behavior()->callBehavior('packmanAfterCreatePackage', $module->dump());
} }
Notices::addSuccessNotice( Notices::addSuccessNotice(
@ -179,17 +179,13 @@ 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
dcCore::app()->callBehavior('packmanBeforeInstallPackage', $type, $id, $root); App::behavior()->callBehavior('packmanBeforeInstallPackage', $type, $id, $root);
if ($type == 'plugins') { $mods = $type == 'themes' ? App::themes() : App::plugins();
$plugins->installPackage($root, $plugins); $mods->installPackage($root, $mods);
}
if ($type == 'themes') {
$themes->installPackage($root, $themes);
}
# --BEHAVIOR-- packmanAfterInstallPackage # --BEHAVIOR-- packmanAfterInstallPackage
dcCore::app()->callBehavior('packmanAfterInstallPackage', $type, $id, $root); App::behavior()->callBehavior('packmanAfterInstallPackage', $type, $id, $root);
} }
Notices::addSuccessNotice( Notices::addSuccessNotice(
@ -256,7 +252,7 @@ class Manage extends Process
} }
} }
} catch (Exception $e) { } catch (Exception $e) {
dcCore::app()->error->add($e->getMessage()); App::error()->add($e->getMessage());
} }
return true; return true;
@ -301,7 +297,7 @@ class Manage extends Process
My::jsLoad('backend') . My::jsLoad('backend') .
# --BEHAVIOR-- packmanAdminHeader # --BEHAVIOR-- packmanAdminHeader
dcCore::app()->callBehavior('packmanAdminHeader') App::behavior()->callBehavior('packmanAdminHeader')
); );
echo echo
@ -311,7 +307,7 @@ class Manage extends Process
]) . ]) .
Notices::GetNotices(); Notices::GetNotices();
if (dcCore::app()->error->flag() || !$is_configured || !$is_plugins_configured || !$is_themes_configured) { if (App::error()->flag() || !$is_configured || !$is_plugins_configured || !$is_themes_configured) {
echo echo
(new Div()) (new Div())
->separator(' ') ->separator(' ')
@ -322,13 +318,13 @@ class Manage extends Process
->render(); ->render();
} else { } else {
Utils::modules( Utils::modules(
dcCore::app()->plugins->getDefines((new Settings())->hide_distrib ? ['distributed' => false] : []), App::plugins()->getDefines((new Settings())->hide_distrib ? ['distributed' => false] : []),
'plugins', 'plugins',
__('Installed plugins') __('Installed plugins')
); );
Utils::modules( Utils::modules(
dcCore::app()->themes->getDefines((new Settings())->hide_distrib ? ['distributed' => false] : []), App::themes()->getDefines((new Settings())->hide_distrib ? ['distributed' => false] : []),
'themes', 'themes',
__('Installed themes') __('Installed themes')
); );
@ -375,7 +371,7 @@ class Manage extends Process
} }
# --BEHAVIOR-- packmanAdminTabs # --BEHAVIOR-- packmanAdminTabs
dcCore::app()->callBehavior('packmanAdminTabs'); App::behavior()->callBehavior('packmanAdminTabs');
Page::helpBlock('pacKman'); Page::helpBlock('pacKman');
Page::closeModule(); Page::closeModule();

View File

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

View File

@ -1,73 +1,113 @@
<?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
@ -87,9 +127,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 public function listSettings(): array
{ {

View File

@ -1,23 +1,19 @@
<?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
@ -27,7 +23,7 @@ class Uninstall extends Process
public static function process(): bool public static function process(): bool
{ {
if (!self::status() || !dcCore::app()->plugins->moduleExists('Uninstaller')) { if (!self::status()) {
return false; return false;
} }

View File

@ -1,20 +1,10 @@
<?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\App;
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;
@ -31,13 +21,21 @@ 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, DC_PLUGINS_ROOT); $e = explode(PATH_SEPARATOR, App::config()->pluginsRoot());
$p = array_pop($e); $p = array_pop($e);
return (string) Path::real($p); return (string) Path::real($p);
@ -45,37 +43,37 @@ class Utils
public static function getThemesPath(): string public static function getThemesPath(): string
{ {
return (string) dcCore::app()->blog?->themes_path; return App::blog()->themesPath();
} }
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)) {
dcCore::app()->error->add( App::error()->add(
__('Path to repository is not writable.') __('Path to repository is not writable.')
); );
} }
if (empty($file_a)) { if (empty($file_a)) {
dcCore::app()->error->add( 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))) {
dcCore::app()->error->add( 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))) {
dcCore::app()->error->add( App::error()->add(
__('Path to second export package is not writable.') __('Path to second export package is not writable.')
); );
} }
return !dcCore::app()->error->flag(); return !App::error()->flag();
} }
public static function isWritable(string $path, string $file): bool public static function isWritable(string $path, string $file): bool
@ -86,7 +84,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) ? DC_VAR . DIRECTORY_SEPARATOR . 'packman' . $typed : $dir . $typed; $dir = empty($dir) ? App::config()->varRoot() . DIRECTORY_SEPARATOR . 'packman' . $typed : $dir . $typed;
try { try {
@Files::makeDir($dir, true); @Files::makeDir($dir, true);
@ -97,6 +95,15 @@ 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)) {
@ -109,6 +116,9 @@ 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([
@ -178,6 +188,15 @@ 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)) {
@ -209,7 +228,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(dcCore::app()->adminurl?->get('admin.plugin.' . My::id(), ['purge' => 1]) . '#packman-repository-' . $type) ->href(App::backend()->url()->get('admin.plugin.' . My::id(), ['purge' => 1]) . '#packman-repository-' . $type)
->text(__('Select non lastest versions')) ->text(__('Select non lastest versions'))
; ;
} }
@ -257,7 +276,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="' . dcCore::app()->adminurl?->get('admin.plugin.' . My::id(), [ 'href="' . App::backend()->url()->get('admin.plugin.' . My::id(), [
'package' => basename($module->get('root')), 'package' => basename($module->get('root')),
'repo' => $type, 'repo' => $type,
]) . '"' ]) . '"'
@ -323,6 +342,11 @@ 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'));

View File

@ -1,25 +1,33 @@
<?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;
/** /**
@ -27,12 +35,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 string $size The size * @param float|int $size The size
* @param int|null $mtime The mtime * @param float|int $mtime The mtime
* *
* @return void * @return void
*/ */
protected function writeFile($name, $file, $size, $mtime) protected function writeFile(string $name, string $file, int|float $size, int|float $mtime): void
{ {
if (!isset($this->entries[$name])) { if (!isset($this->entries[$name])) {
return; return;
@ -59,8 +67,8 @@ class Zip extends \Dotclear\Helper\File\Zip\Zip
unset($content); unset($content);
$mdate = $this->makeDate($mtime); $mdate = $this->makeDate((int) $mtime);
$mtime = $this->makeTime($mtime); $mtime = $this->makeTime((int) $mtime);
# Data descriptor # Data descriptor
$data_desc = "\x50\x4b\x03\x04" . $data_desc = "\x50\x4b\x03\x04" .