Compare commits

..

10 commits
2.28 ... master

Author SHA1 Message Date
JcDenis
70de130409 Update dcstore.xml
Some checks failed
Release package / check_release (push) Has been cancelled
Release package / do_release (push) Has been cancelled
2024-12-01 08:46:00 +00:00
b607bf775a
Create release.yml 2024-12-01 09:45:32 +01:00
6a11d1aff6
release 2023.11.04 2023-11-04 20:34:18 +01:00
616175eef5
cosmetic code review and typo 2023-11-04 20:33:00 +01:00
f2a5aa0179
maybe better permissions check 2023-10-21 22:48:54 +02:00
b360dc199f
cosmetic code review 2023-10-19 21:53:53 +02:00
53ef9fd071
release 2023.10.13 2023-10-13 20:46:34 +02:00
2ca39fb042
release 2023.10.09 2023-10-09 22:06:50 +02:00
dacdbf7342
oups 2023-10-07 22:11:11 +02:00
b77173f9cf
release 2023.10.07 2023-10-07 15:36:31 +02:00
16 changed files with 440 additions and 212 deletions

142
.github/workflows/release.yml vendored Normal file
View file

@ -0,0 +1,142 @@
name: Release package
on:
push:
workflow_dispatch:
env:
DC_TYPE: plugin
DC_MIN: 2.32
# required to set secrets in
# https://github.com/xxx/xxx/settings/secrets/actions
# TELEGRAM_ID, TELEGRAM_TOKEN
jobs:
check_release:
if: (contains(github.event.head_commit.message, 'release') || (github.event_name != 'push'))
runs-on: ubuntu-latest
outputs:
version: ${{ steps.dotclear.outputs.version }}
dcmin: ${{ steps.dotclear.outputs.dcmin }}
exists: ${{ steps.repository.outputs.release-exists }}
steps:
- name: Checkout repository master branch
uses: actions/checkout@master
# Parser from https://github.com/franck-paul
- name: Run PHP code
id: dotclear
shell: php {0}
run: |
<?php
$version = '';
$dcmin = '${{ env.DC_MIN }}';
$df = file_get_contents('./_define.php');
if (preg_match('/registerModule\((.*?),(.*?)[\'\"],(.*?)[\'\"],(.*?)[\'\"](.*?)[\'\"](.*?)(,.*)\)/s',$df,$matches)) {
if (isset($matches[5])) {
$version = $matches[5];
if (isset($matches[7])) {
$str = $matches[7];
if (preg_match('/\[(.*?)[\'\"]core[\'\"](.*?),(.*?)[\'\"](.*?)[\'\"](.*?)\]/s',$str,$submatches)) {
$dcmin = $submatches[4];
}
}
}
}
file_put_contents(getenv('GITHUB_OUTPUT'), "version=$version\n", FILE_APPEND);
file_put_contents(getenv('GITHUB_OUTPUT'), "dcmin=$dcmin\n", FILE_APPEND);
- name: Check repository releases
id: repository
uses: insightsengineering/release-existence-action@v1.0.0
with:
release-tag: 'v${{ steps.dotclear.outputs.version }}'
do_release:
needs: check_release
if: needs.check_release.outputs.exists == 'false'
runs-on: ubuntu-latest
steps:
- name: Checkout repository master branch
uses: actions/checkout@master
- name: Get repository name
id: repository
uses: MariachiBear/get-repo-name-action@v1.1.0
with:
with-owner: 'false'
- name: Get download URL
id: download
run: |
fulltag=${{ github.ref_name }}
echo download-url="https://github.com/${{ github.repository }}/releases/download/v${{ needs.check_release.outputs.version }}/${{ env.DC_TYPE }}-${{ steps.repository.outputs.repository-name }}.zip" >> $GITHUB_OUTPUT
# Parser from https://github.com/franck-paul
- name: Read dcstore
id: readstore
shell: php {0}
run: |
<?php
if (file_exists('dcstore.xml')) {
$ds = file_get_contents('dcstore.xml');
if ($ds) {
$ds = preg_replace('/<version>(.*?)<\/version>/s',"<version>${{ needs.check_release.outputs.version }}</version>",$ds);
$ds = preg_replace('/<file>(.*?)<\/file>/s',"<file>${{ steps.download.outputs.download-url }}</file>",$ds);
$ds = preg_replace('/<da:dcmin>(.*?)<\/da:dcmin>/s',"<da:dcmin>${{ needs.check_release.outputs.dcmin }}</da:dcmin>",$ds);
if ($ds) {
file_put_contents('dcstore.xml',$ds);
}
}
}
- name: Write dcstore
id: writestore
shell: bash
run: |
test=$(git diff --name-only -- dcstore.xml)
if [[ "$test" != "" ]]; then
echo "dcstore.xml modified, need to be commit"
git config user.name "${{ github.actor }}"
git config user.email "${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com"
git add dcstore.xml
git commit -m "Update dcstore.xml"
git push
else
echo "dcstore.xml not modified"
fi
- name: Create archive
id: writearchive
uses: thedoctor0/zip-release@0.7.6
with:
type: 'zip'
directory: ..
path: '${{ steps.repository.outputs.repository-name }}'
filename: '${{ env.DC_TYPE }}-${{ steps.repository.outputs.repository-name }}.zip'
exclusions: '*.git* /*node_modules/* .editorconfig'
- name: Create release with archive
id: writerelease
uses: ncipollo/release-action@v1.14.0
with:
artifacts: '../${{ env.DC_TYPE }}-${{ steps.repository.outputs.repository-name }}.zip'
token: ${{ secrets.GITHUB_TOKEN }}
commit: master
draft: false
prerelease: false
generateReleaseNotes: true
name: ${{ steps.repository.outputs.repository-name }} ${{ needs.check_release.outputs.version }}
tag: 'v${{ needs.check_release.outputs.version }}'
- name: Send Telegram Message Ok
uses: appleboy/telegram-action@v1.0.0
with:
to: ${{ secrets.TELEGRAM_ID }}
token: ${{ secrets.TELEGRAM_TOKEN }}
format: markdown
message: |
__Github workflow run__
- Trigger: ${{ github.event_name }}
- Release: ${{ steps.repository.outputs.repository-name }} ${{ needs.check_release.outputs.version }}
- Download URL: ${{ steps.download.outputs.download-url }}

View file

@ -1,6 +1,31 @@
pacKman 2023.10.06
pacKman 2023.11.04
===========================================================
* Require Dotclear 2.27
* 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

View file

@ -1,28 +1,24 @@
# README
[![Release](https://img.shields.io/badge/release-2023.10.06-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)
[![Release](https://img.shields.io/badge/release-2023.11.04-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/pacKman/releases)
![Date](https://img.shields.io/badge/date-2023.11.04-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+
* A writable cache directory
* A writable directory to put packages. (can be VAR dir)
* Dotclear super administrator permissions
* System writable cache directory
* System writable directory to put packages. (can be VAR dir)
## USAGE
@ -37,14 +33,15 @@ 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 & help](https://forum.dotclear.org/viewtopic.php?id=40066)
## CONTRIBUTORS
* Jean-Christian Denis
* Jean-Christian Denis (author)
* Philippe aka Dissitou
* franck-paul

View file

@ -1,32 +1,26 @@
<?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 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.06',
'2023.11.04',
[
'requires' => [
['php', '8.1'],
['core', '2.28'],
],
'permissions' => null,
'requires' => [['core', '2.28']],
'permissions' => 'My',
'type' => 'plugin',
'support' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',
'details' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/src/branch/master/README.md',

View file

@ -2,10 +2,10 @@
<modules xmlns:da="http://dotaddict.org/da/">
<module id="pacKman">
<name>Packages repository</name>
<version>2023.10.06</version>
<version>2023.11.04</version>
<author>Jean-Christian Denis</author>
<desc>Manage your Dotclear packages</desc>
<file>https://github.com/JcDenis/pacKman/releases/download/v2023.10.06/plugin-pacKman.zip</file>
<file>https://github.com/JcDenis/pacKman/releases/download/v2023.11.04/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>

View file

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

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,13 @@ use Dotclear\App;
use Dotclear\Core\Process;
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
{
public static function init(): bool
@ -38,7 +35,7 @@ class Backend extends Process
'title' => My::name(),
'url' => My::manageUrl(),
'small-icon' => My::icons(),
'large-icon' => My::icons()
'large-icon' => My::icons(),
]);
});

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,13 @@ use Dotclear\Helper\Html\Form\{
};
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
{
public static function init(): bool
@ -62,7 +59,7 @@ class Config extends Process
Notices::addSuccessNotice(
__('Configuration has been successfully updated.')
);
App::backend()->url->redirect('admin.plugins', [
App::backend()->url()->redirect('admin.plugins', [
'module' => My::id(),
'conf' => '1',
'redir' => App::backend()->__get('list')->getRedir(),
@ -114,12 +111,12 @@ class Config extends Process
// pack_repository
(new Para())->items([
(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(
sprintf(
__('Preconization: %s'),
App::blog()->publicPath() ?
App::blog()->publicPath() == '' ?
App::blog()->publicPath() : __("Blog's public directory")
) . ' ' . __('Leave it empty to use Dotclear VAR directory')
),
@ -134,13 +131,13 @@ class Config extends Process
// pack_filename
(new Para())->items([
(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'),
// secondpack_filename
(new Para())->items([
(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'),
// pack_overwrite
@ -153,7 +150,7 @@ class Config extends Process
// pack_excludefiles
(new Para())->items([
(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'),
// pack_nocomment

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,22 @@ use Dotclear\Helper\File\Zip\Unzip;
use Dotclear\Module\ModuleDefine;
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
{
/**
* 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 +40,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 +145,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

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,13 @@ use Dotclear\App;
use Dotclear\Core\Process;
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
{
public static function init(): bool
@ -56,7 +53,7 @@ class Install extends Process
while ($record->fetch()) {
if (preg_match('/^packman_(.*?)$/', $record->f('setting_id'), $match)) {
$cur = App::blogWorspace()->openBlogWorkspaceCursor();
$cur = App::blogWorkspace()->openBlogWorkspaceCursor();
$cur->setField('setting_id', $match[1]);
$cur->setField('setting_ns', My::id());
$cur->update(

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,13 @@ use Dotclear\Helper\Html\Form\{
use Dotclear\Helper\Network\Http;
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
{
public static function init(): bool
@ -184,11 +181,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);

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,19 @@ use Dotclear\App;
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
{
/** @var array Excluded files */
/**
* Excluded files.
*
* @var array<int,string> EXCLUDED_FILES
*/
public const EXCLUDED_FILES = [
'.',
'..',
@ -38,6 +36,10 @@ 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;
return match ($context) {
// Limit to super admin
self::MODULE => App::auth()->isSuperAdmin(),
default => null,
};
}
}

View file

@ -1,73 +1,113 @@
<?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 GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Settings
{
// Remove comments from files
/**
* Remove comments from files.
*
* @var 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;
// Overwrite existing package
/**
* Overwrite existing package.
*
* @var bool $pack_overwrite
*/
public readonly bool $pack_overwrite;
// Name of package
/**
* Name of package.
*
* @var 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;
// Path to package repository
/**
* Path to package repository.
*
* @var 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;
// Extra files to exclude from package
/**
* Extra files to exclude from package.
*
* @var 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;
/**
* 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 +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
{

View file

@ -1,23 +1,19 @@
<?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 GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Uninstall extends Process
{
public static function init(): bool
@ -27,7 +23,7 @@ class Uninstall extends Process
public static function process(): bool
{
if (!self::status() || !App::plugins()->moduleExists('Uninstaller')) {
if (!self::status()) {
return false;
}

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,21 @@ 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 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 +84,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 +95,15 @@ class Utils
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
{
if (empty($modules)) {
@ -109,6 +116,9 @@ class Utils
$tbody = [];
self::sort($modules);
foreach ($modules as $module) {
if (!is_a($module, ModuleDefine::class)) {
continue;
}
$tbody[] = (new Para(null, 'tr'))
->class('line')
->items([
@ -178,6 +188,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)) {
@ -209,7 +228,7 @@ class Utils
if (str_contains($type, 'repository')) {
$helpers_addon[] = (new Link())
->class('button')
->href(App::backend()->url->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'))
;
}
@ -257,7 +276,7 @@ class Utils
(new Text('a', Html::escapeHTML(basename($module->get('root')))))
->class('packman-download')
->extra(
'href="' . App::backend()->url->get('admin.plugin.' . My::id(), [
'href="' . App::backend()->url()->get('admin.plugin.' . My::id(), [
'package' => basename($module->get('root')),
'repo' => $type,
]) . '"'
@ -323,6 +342,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'));

View file

@ -1,25 +1,33 @@
<?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 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 +67,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" .