JcDenis/cleanURLs
1
0
Fork 0
Code Issues Pull Requests Releases 3 Activity

Compare commits

base: JcDenis:v1.5
Branches Tags
JcDenis:master
JcDenis:v1.6.1
JcDenis:v1.6
JcDenis:v1.5
..
compare: JcDenis:master
Branches Tags
JcDenis:master
JcDenis:v1.6.1
JcDenis:v1.6
JcDenis:v1.5

4 Commits
v1.5 ... master

Author SHA1 Message Date
Jean-Christian Denis
5883ca1af2
cosmetic clean 2023-10-15 21:06:31 +02:00
Jean-Christian Denis
5d5ccaf9b0
release 1.6 2023-10-07 22:18:57 +02:00
Jean-Christian Denis
7f7af28bde
fix ZIP URL 2023-08-07 23:15:01 +02:00
Jean-Christian Denis
e41cf367bd
use static badge 2023-08-07 00:56:16 +02:00
7 changed files with 100 additions and 92 deletions
Show Stats Expand all files Collapse all files

12
CHANGELOG.md
View File

@ -1,3 +1,15 @@
cleanURLs 1.6.1 - 2023.10.15
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1+
* Cosmetic clean
cleanURLs 1.6 - 2023.10.07
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1+
* Upgrade to Dotclear 2.28
cleanURLs 1.5 - 2023.08.06 cleanURLs 1.5 - 2023.08.06
=========================================================== ===========================================================
* Require Dotclear 2.27 * Require Dotclear 2.27

32
README.md
View File

@ -1,24 +1,20 @@
# README # README
[![Release](https://img.shields.io/github/v/release/JcDenis/cleanURLs)](https://git.dotclear.watch/JcDenis/cleanURLs/releases) [![Release](https://img.shields.io/badge/release-1.6.1-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/cleanURLs/releases)
[![Date](https://img.shields.io/github/release-date/JcDenis/cleanURLs)](https://git.dotclear.watch/JcDenis/cleanURLs/releases) ![Date](https://img.shields.io/badge/date-2023.10.15-c44d58.svg)
[![Issues](https://img.shields.io/github/issues/JcDenis/cleanURLs)](https://git.dotclear.watch/JcDenis/cleanURLs/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/cleanURLs)
[![Dotaddict](https://img.shields.io/badge/dotaddict-official-green.svg)](https://plugins.dotaddict.org/dc2/details/cleanURLs) [![License](https://img.shields.io/badge/license-GPL--3.0-ececec.svg)](https://git.dotclear.watch/JcDenis/cleanURLs/src/branch/master/LICENSE)
[![License](https://img.shields.io/github/license/JcDenis/cleanURLs)](https://git.dotclear.watch/JcDenis/cleanURLs/blob/master/LICENSE)
## WHAT IS ENHANCEPOSTCONTENT ? ## ABOUT
"Clean URLs" is a plugin for the open-source _cleanUrls_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
web publishing software called Dotclear.
It removes diacritics and punctuation from URLs... > It removes diacritics and punctuation from URLs...
## REQUIREMENTS ## REQUIREMENTS
_cleanURLs_ requires: * Dotclear 2.28
* Dotclear 2.27
## USAGE ## USAGE
@ -29,14 +25,14 @@ Then when a post is created, it's URL is cleaned automagically.
## LINKS ## LINKS
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html) * [License](https://git.dotclear.watch/JcDenis/cleanURLs/src/branch/master/LICENSE)
* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/cleanURLs) or [GitHub Page](https://github.com/JcDenis/cleanURLs) * [Packages & details](https://git.dotclear.watch/JcDenis/cleanURLs/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/cleanURLs))
* Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/cleanURLs/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/cleanURLs) * [Sources & contributions](https://git.dotclear.watch/JcDenis/cleanURLs) (or on [GitHub](https://github.com/JcDenis/cleanURLs))
* Discuss and help : [Dotclear Forum](http://forum.dotclear.org/viewtopic.php?id=40876) * [Issues & security](https://git.dotclear.watch/JcDenis/cleanURLs/issues) (or on [GitHub](https://github.com/JcDenis/cleanURLs/issues))
## CONTRIBUTORS ## CONTRIBUTORS
* Pierre Rudloff (author) * Pierre Rudloff (author)
* Jean-Christian Denis * Jean-Christian Denis (latest)
You are welcome to contribute to this code. You are welcome to contribute to this code.

27
_define.php
View File

@ -1,30 +1,27 @@
<?php <?php
/** /**
* @brief cleanURLs, a plugin for Dotclear 2 * @file
* @brief The plugin cleanURLs definition
* @ingroup cleanURLs
* *
* @package Dotclear * @defgroup cleanURLs Plugin cleanURLs.
* @subpackage Plugin
* *
* @author Pierre Rudloff and contributors * Removes diacritics and punctuation from URLs.
* *
* @copyright Jean-Christian Denis * @author Pierre Rudloff (author)
* @copyright GPL-3.0 https://www.gnu.org/licenses/gpl-2.0.html * @author Jean-Christian Denis (latest)
* @copyright GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html
*/ */
if (!defined('DC_RC_PATH')) { declare(strict_types=1);
return;
}
$this->registerModule( $this->registerModule(
'Clean URLs', 'Clean URLs',
'Removes diacritics and punctuation from URLs', 'Removes diacritics and punctuation from URLs',
'Pierre Rudloff and contributors', 'Pierre Rudloff and contributors',
'1.5', '1.6.1',
[ [
'requires' => [['core', '2.27']], 'requires' => [['core', '2.28']],
'permissions' => dcCore::app()->auth->makePermissions([ 'permissions' => 'My',
dcCore::app()->auth::PERMISSION_USAGE,
dcCore::app()->auth::PERMISSION_CONTENT_ADMIN,
]),
'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="cleanURLs"> <module id="cleanURLs">
<name>Clean URLs</name> <name>Clean URLs</name>
<version>1.5</version> <version>1.6.1</version>
<author>Pierre Rudloff and contributors</author> <author>Pierre Rudloff and contributors</author>
<desc>Removes diacritics and punctuation from URLs</desc> <desc>Removes diacritics and punctuation from URLs</desc>
<file>https://gitea.dotclear.watch/JcDenis/cleanURLs/releases/download/v1.5/plugin-cleanURLs.zip</file> <file>https://git.dotclear.watch/JcDenis/cleanURLs/releases/download/v1.6.1/plugin-cleanURLs.zip</file>
<da:dcmin>2.27</da:dcmin> <da:dcmin>2.28</da:dcmin>
<da:details>https://git.dotclear.watch/JcDenis/cleanURLs/src/branch/master/README.md</da:details> <da:details>https://git.dotclear.watch/JcDenis/cleanURLs/src/branch/master/README.md</da:details>
<da:support>https://git.dotclear.watch/JcDenis/cleanURLs/issues</da:support> <da:support>https://git.dotclear.watch/JcDenis/cleanURLs/issues</da:support>
</module> </module>

56
src/CleanURLs.php
View File

@ -1,42 +1,48 @@
<?php <?php
/**
* @brief cleanURLs, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Pierre Rudloff and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html
*/
declare(strict_types=1); declare(strict_types=1);
namespace Dotclear\Plugin\cleanURLs; namespace Dotclear\Plugin\cleanURLs;
use dcBlog; use Dotclear\Interface\Core\BlogInterface;
use Dotclear\Database\Cursor; use Dotclear\Database\Cursor;
/** /**
* Class to remove problematic characters from URLs * @brief cleanURLs main class.
* @ingroup cleanURLs
* *
* PHP Version 5 * @author Pierre Rudloff (author)
* * @author Jean-Christian Denis (latest)
* @category Plugin * @copyright GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html
* @package CleanURLs */
* @author Pierre Rudloff <contact@rudloff.pro>
* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License
* @link http://rudloff.pro
* */
class CleanURLs class CleanURLs
{ {
/**
* Chars to convert from.
*
* @var string CONVERT_FROM_CHARS
*/
public const CONVERT_FROM_CHARS = ',!.?;:@$«»°*'; public const CONVERT_FROM_CHARS = ',!.?;:@$«»°*';
/**
* Chars to convert to.
*
* @var string CONVERT_TO_CHAR
*/
public const CONVERT_TO_CHAR = '-'; public const CONVERT_TO_CHAR = '-';
/** @var string $convert_from_chars List of special chars to convert */ /**
* List of special chars to convert.
*
* @var string $convert_from_chars
*/
public static string $convert_from_chars = self::CONVERT_FROM_CHARS; public static string $convert_from_chars = self::CONVERT_FROM_CHARS;
/** @var string $convert_to_char A char to convert to */ /**
* A char to convert to.
*
* @var string $convert_to_char
*/
public static string $convert_to_char = self::CONVERT_TO_CHAR; public static string $convert_to_char = self::CONVERT_TO_CHAR;
/** /**
@ -269,10 +275,10 @@ class CleanURLs
/** /**
* Clean post URLs from diacritics and punctuation. * Clean post URLs from diacritics and punctuation.
* *
* @param dcBlog $blog The blog instance * @param Blog $blog The blog instance
* @param Cursor $cur The post Cursor * @param Cursor $cur The post Cursor
* */ * */
public static function cleanPost(dcBlog $blog, Cursor $cur): void public static function cleanPost(BlogInterface $blog, Cursor $cur): void
{ {
$cur->setField('post_url', self::cleanStr($cur->getField('post_url'))); $cur->setField('post_url', self::cleanStr($cur->getField('post_url')));
} }

21
src/My.php
View File

@ -1,21 +1,20 @@
<?php <?php
/**
* @brief cleanURLs, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Pierre Rudloff and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html
*/
declare(strict_types=1); declare(strict_types=1);
namespace Dotclear\Plugin\cleanURLs; namespace Dotclear\Plugin\cleanURLs;
use Dotclear\Module\MyPlugin; use Dotclear\Module\MyPlugin;
/**
* @brief cleanURLs My helper.
* @ingroup cleanURLs
*
* @author Pierre Rudloff (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html
*/
class My extends MyPlugin class My extends MyPlugin
{ {
// Use default permissions
} }

24
src/Prepend.php
View File

@ -1,22 +1,20 @@
<?php <?php
/**
* @brief cleanURLs, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Pierre Rudloff and contributors
*
* @copyright Jean-Christian Denis
* @copyright GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html
*/
declare(strict_types=1); declare(strict_types=1);
namespace Dotclear\Plugin\cleanURLs; namespace Dotclear\Plugin\cleanURLs;
use dcCore; use Dotclear\App;
use Dotclear\Core\Process; use Dotclear\Core\Process;
/**
* @brief cleanURLs prepend class.
* @ingroup cleanURLs
*
* @author Pierre Rudloff (author)
* @author Jean-Christian Denis (latest)
* @copyright GPL-3.0 https://www.gnu.org/licenses/gpl-3.0.html
*/
class Prepend extends Process class Prepend extends Process
{ {
public static function init(): bool public static function init(): bool
@ -30,7 +28,7 @@ class Prepend extends Process
return false; return false;
} }
dcCore::app()->addBehavior('coreBeforePostCreate', [CleanURLs::class, 'cleanPost']); App::behavior()->addBehavior('coreBeforePostCreate', CleanURLs::cleanPost(...));
return true; return true;
} }