JcDenis/myUrlHandlers
1
0
Fork 0
Code Issues Pull Requests Releases 6 Activity

Compare commits

base: JcDenis:main
Branches Tags
JcDenis:master
JcDenis:main
JcDenis:v2023.11.27
JcDenis:v2023.10.23
JcDenis:v2023.10.22
JcDenis:v2023.10.11
JcDenis:v2023.10.07
JcDenis:v2023.08.13
..
compare: JcDenis:v2023.10.07
Branches Tags
JcDenis:master
JcDenis:main
JcDenis:v2023.11.27
JcDenis:v2023.10.23
JcDenis:v2023.10.22
JcDenis:v2023.10.11
JcDenis:v2023.10.07
JcDenis:v2023.08.13

No commits in common. "main" and "v2023.10.07" have entirely different histories.
main ... v2023.10.0

13 changed files with 137 additions and 268 deletions
Show Stats Expand all files Collapse all files

13
CHANGELOG.md
View File

@ -1,16 +1,3 @@
myUrlHandlers 2023.10.22
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Use default permissions and update to admin only
* Code review (phpstan)
myUrlHandlers 2023.10.11
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Code review
myUrlHandlers 2023.10.07
===========================================================
* Require Dotclear 2.28

14
README.md
View File

@ -1,8 +1,8 @@
# README
[![Release](https://img.shields.io/badge/release-2023.10.22-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/myUrlHandlers/releases)
![Date](https://img.shields.io/badge/date-2023.10.22-c44d58.svg)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.28-137bbb.svg)](https://fr.dotclear.org/download)
[![Release](https://img.shields.io/badge/release-2023.08.13-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/myUrlHandlers/releases)
![Date](https://img.shields.io/badge/date-2023.08.13-c44d58.svg)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/myUrlHandlers)
[![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/myUrlHandlers/src/branch/master/LICENSE)
@ -10,13 +10,13 @@
_myUrlHandlers_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
> Change public URL of each Dotclear parts, like post, category, etc and some plugins having public parts.
> You can change public URL of each Dotclear parts, like post, category, etc and some plugins having public parts.
## REQUIREMENTS
* contentadmin permissions for management
* Dotclear 2.28
* PHP 8.1+
* Dotclear admin permissions for management
## USAGE
@ -36,8 +36,8 @@ or you can add dashboard icon.
## CONTRIBUTORS
* Alex pirine (Author)
* Alex pirine (First author)
* te2dy
* Jean-Christian Denis (latest)
* Jean-Christian Denis
You are welcome to contribute to this code.

21
_define.php
View File

@ -1,28 +1,27 @@
<?php
/**
* @file
* @brief The plugin myUrlHandlers definition
* @ingroup myUrlHandlers
* @brief myUrlHandlers, a plugin for Dotclear 2
*
* @defgroup myUrlHandlers Plugin myUrlHandlers.
*
* Change Dotclear URL handlers.
* @package Dotclear
* @subpackage Plugin
*
* @author Alex Pirine and contributors
* @author Jean-Christian Denis
* @copyright Alex Pirine
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
use Dotclear\App;
$this->registerModule(
'URL handlers',
'Change Dotclear URL handlers',
'Alex Pirine and contributors',
'2023.10.11',
'2023.08.13',
[
'requires' => [['core', '2.28']],
'permissions' => 'My',
'permissions' => App::auth()->makePermissions([
App::auth()::PERMISSION_CONTENT_ADMIN,
]),
'priority' => 150000,
'type' => 'plugin',
'support' => 'https://git.dotclear.watch/JcDenis/' . basename(__DIR__) . '/issues',

6
dcstore.xml
View File

@ -2,11 +2,11 @@
<modules xmlns:da="http://dotaddict.org/da/">
<module id="myUrlHandlers">
<name>URL handlers</name>
<version>2023.10.22</version>
<version>2023.08.13</version>
<author>Alex Pirine and contributors</author>
<desc>Change Dotclear URL handlers</desc>
<file>https://git.dotclear.watch/JcDenis/myUrlHandlers/releases/download/v2023.10.22/plugin-myUrlHandlers.zip</file>
<da:dcmin>2.28</da:dcmin>
<file>https://github.com/JcDenis/myUrlHandlers/releases/download/v2023.08.13/plugin-myUrlHandlers.zip</file>
<da:dcmin>2.27</da:dcmin>
<da:details>https://git.dotclear.watch/JcDenis/myUrlHandlers/src/branch/master/README.md</da:details>
<da:support>https://git.dotclear.watch/JcDenis/myUrlHandlers/issues</da:support>
</module>

22
src/Backend.php
View File

@ -1,5 +1,15 @@
<?php
/**
* @brief myUrlHandlers, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Alex Pirine and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
@ -8,14 +18,6 @@ use Dotclear\App;
use Dotclear\Core\Process;
use Dotclear\Core\Backend\Favorites;
/**
* @brief myUrlHandlers backend class.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Backend extends Process
{
public static function init(): bool
@ -38,7 +40,7 @@ class Backend extends Process
'url' => My::manageUrl(),
'small-icon' => My::icons(),
'large-icon' => My::icons(),
'permissions' => App::auth()->makePermissions([App::auth()::PERMISSION_ADMIN]),
'permissions' => App::auth()->makePermissions([App::auth()::PERMISSION_CONTENT_ADMIN]),
]);
});

20
src/Install.php
View File

@ -1,5 +1,15 @@
<?php
/**
* @brief myUrlHandlers, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Alex Pirine and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
@ -7,14 +17,6 @@ namespace Dotclear\Plugin\myUrlHandlers;
use Dotclear\App;
use Dotclear\Core\Process;
/**
* @brief myUrlHandlers installation class.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Install extends Process
{
public static function init(): bool

23
src/Manage.php
View File

@ -1,5 +1,15 @@
<?php
/**
* @brief myUrlHandlers, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Alex Pirine and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
@ -16,12 +26,7 @@ use Dotclear\Helper\Text;
use Exception;
/**
* @brief myUrlHandlers manage class.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
* Manage contributions list
*/
class Manage extends Process
{
@ -46,14 +51,14 @@ class Manage extends Process
if (empty($handlers[$name])) {
throw new Exception(sprintf(
__('Uknown handler "%s".'),
Html::escapeHTML((string) $name)
Html::escapeHTML($name)
));
}
if (empty($url)) {
throw new Exception(sprintf(
__('Invalid URL for handler "%s".'),
Html::escapeHTML((string) $name)
Html::escapeHTML($name)
));
}

28
src/My.php
View File

@ -1,27 +1,23 @@
<?php
/**
* @brief myUrlHandlers, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Alex Pirine and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
use Dotclear\Module\MyPlugin;
/**
* @brief myUrlHandlers My helper.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class My extends MyPlugin
{
/**
* This module settings ID.
*
* @var string NS_SETTING_ID
*/
/** @var string This module settings ID */
public const NS_SETTING_ID = 'handlers';
// Use default permissions
}

80
src/MyUrlHandlers.php
View File

@ -1,5 +1,15 @@
<?php
/**
* @brief myUrlHandlers, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Alex Pirine and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
@ -7,66 +17,52 @@ namespace Dotclear\Plugin\myUrlHandlers;
use Dotclear\App;
use Dotclear\Core\PostType;
/**
* @brief myUrlHandlers main class.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class MyUrlHandlers
{
/**
* The URLs stack.
* The default URLs handlers.
*
* @var UrlStack $stack
* @var array<string,array<string,string>> $defaults
*/
private static UrlStack $stack;
private static array $defaults = [];
/**
* The posts types URLs.
*
* @var array<string, string> $pt_public2type
* @var array<string,string> $url2post
*/
private static array $pt_public2type = [];
private static array $url2post = [];
/**
* The posts types admin URLs.
*
* @var array<string, string> $pt_type2admin
* @var array<string,string> $post_adm_url
*/
private static array $pt_type2admin = [];
private static array $post_adm_url = [];
/**
* Initialize handlers list.
*/
public static function init(): void
{
self::$stack = new UrlStack();
# Set defaults
foreach (App::url()->getTypes() as $k => $v) {
if (empty($v['url'])) {
continue;
}
$p = '/' . preg_quote($v['url'], '/') . '/';
$v['representation'] = str_replace('%', '%%', $v['representation']);
$v['representation'] = preg_replace('/' . preg_quote($v['url'], '/') . '/', '%s', $v['representation'], 1, $c);
$v['representation'] = preg_replace($p, '%s', $v['representation'], 1, $c);
if ($c && is_string($v['representation'])) {
self::$stack->set(new UrlDescriptor(
$k,
$v['url'],
$v['representation'],
$v['handler'] ?? null
));
if ($c) {
self::$defaults[$k] = $v;
}
}
foreach (App::postTypes()->dump() as $pt) {
self::$pt_public2type[$pt->public_url] = $pt->type;
self::$pt_type2admin[$pt->type] = $pt->admin_url;
self::$url2post[$pt->public_url] = $pt->type;
self::$post_adm_url[$pt->type] = $pt->admin_url;
}
# Read user settings
@ -83,40 +79,38 @@ class MyUrlHandlers
*/
public static function overrideHandler(string $name, string $url): void
{
$desc = self::$stack->get($name);
if (is_null($desc->handler())) {
if (!isset(self::$defaults[$name])) {
return;
}
App::url()->register(
$name,
$url,
sprintf($desc->representation, $url),
$desc->handler()
sprintf(self::$defaults[$name]['representation'], $url),
self::$defaults[$name]['handler']
);
$type = self::$pt_public2type[$desc->url . '/%s'] ?? '';
if (!$type) {
return;
}
$k = self::$url2post[self::$defaults[$name]['url'] . '/%s'] ?? '';
if ($k) {
App::postTypes()->set(new PostType(
$type,
self::$pt_type2admin[$type],
$k,
self::$post_adm_url[$k],
App::url()->getBase($name) . '/%s'
));
}
}
/**
* Get default URLs handlers.
*
* @return array<string, string> The default URLs handlers
* @return array<string,string> The default URLs handlers
*/
public static function getDefaults(): array
{
$res = [];
foreach (self::$stack->dump() as $v) {
$res[$v->id] = $v->url;
foreach (self::$defaults as $k => $v) {
$res[$k] = $v['url'];
}
return $res;
@ -125,7 +119,7 @@ class MyUrlHandlers
/**
* Get custom blog URLs handlers.
*
* @return array<string, string> The blog URLs handlers
* @return array<string,string> The blog URLs handlers
*/
public static function getBlogHandlers(): array
{
@ -137,7 +131,7 @@ class MyUrlHandlers
/**
* Save custom URLs handlers.
*
* @param array<string, string> $handlers The custom URLs handlers
* @param array<string,string> $handlers The custom URLs handlers
*/
public static function saveBlogHandlers(array $handlers): void
{

20
src/Prepend.php
View File

@ -1,19 +1,21 @@
<?php
/**
* @brief myUrlHandlers, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Alex Pirine and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
use Dotclear\Core\Process;
/**
* @brief myUrlHandlers prepend class.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Prepend extends Process
{
public static function init(): bool

20
src/Uninstall.php
View File

@ -1,5 +1,15 @@
<?php
/**
* @brief myUrlHandlers, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Alex Pirine and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
@ -7,14 +17,6 @@ namespace Dotclear\Plugin\myUrlHandlers;
use Dotclear\Core\Process;
use Dotclear\Plugin\Uninstaller\Uninstaller;
/**
* @brief myUrlHandlers uninstall class.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Uninstall extends Process
{
public static function init(): bool

51
src/UrlDescriptor.php
View File

@ -1,51 +0,0 @@
<?php
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
/**
* @brief myUrlHandlers URL descriptor class.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class UrlDescriptor
{
/**
* URL handler callback.
*
* @var ?callable $handler
*/
private $handler = null;
/**
* Constructor.
*
* @param string $id The ID
* @param string $url The URL
* @param string $representation The representation
* @param ?callable $handler The callback
*/
public function __construct(
public readonly string $id,
public readonly string $url = '',
public readonly string $representation = '',
?callable $handler = null,
) {
// As PHP does not support callable property type.
$this->handler = $handler;
}
/**
* Get handler.
*
* @return ?callable The handler
*/
public function handler(): ?callable
{
return $this->handler;
}
}

69
src/UrlStack.php
View File

@ -1,69 +0,0 @@
<?php
declare(strict_types=1);
namespace Dotclear\Plugin\myUrlHandlers;
/**
* @brief myUrlHandlers URL descriptor stack class.
* @ingroup myUrlHandlers
*
* @author Alex Pirine (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class UrlStack
{
/**
* The stack of URL descriptors.
*
* @var array<string, UrlDescriptor>
*/
private array $stack = [];
/**
* Check if an handler is set.
*
* @param string $id The handler ID
*
* @return bool True if it exists
*/
public function has(string $id): bool
{
return array_key_exists($id, $this->stack);
}
/**
* Set an URL handler.
*
* @param UrlDescriptor $descriptor The URL descriptor
*/
public function set(UrlDescriptor $descriptor): void
{
$this->stack[$descriptor->id] = $descriptor;
}
/**
* Get an URL handler.
*
* If it does not exist, return an empty handler.
*
* @param string $id The handler ID
*
* @return UrlDescriptor The URL descriptor
*/
public function get(string $id): UrlDescriptor
{
return $this->stack[$id] ?? new UrlDescriptor($id);
}
/**
* Get URLs stack.
*
* @return array<string, UrlDescriptor>
*/
public function dump()
{
return $this->stack;
}
}