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

release 2023.10.13

master v2023.10.13
Jean-Christian Paul Denis 2023-10-13 23:45:58 +02:00
parent d32c8525e7
commit 742692f9db
Signed by: JcDenis
GPG Key ID: 1B5B8C5B90B6C951
9 changed files with 122 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
CHANGELOG.md
View File

@ -1,3 +1,9 @@
simplyFavicon 2023.10.13
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Upgrade to Dotclear 2.28
simplyFavicon 2023.08.13 simplyFavicon 2023.08.13
=========================================================== ===========================================================
* Require Dotclear 2.27 * Require Dotclear 2.27

30
README.md
View File

@ -1,26 +1,23 @@
# README # README
[![Release](https://img.shields.io/badge/release-2023.08.13-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/simplyFavicon/releases) [![Release](https://img.shields.io/badge/release-2023.10.13-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/simplyFavicon/releases)
[![Date](https://img.shields.io/badge/date-2023.08.13-c44d58.svg)](https://git.dotclear.watch/JcDenis/simplyFavicon/releases) ![Date](https://img.shields.io/badge/date-2023.10.13-c44d58.svg)
[![Dotclear](https://img.shields.io/badge/dotclear-v2.27-137bbb.svg)](https://fr.dotclear.org/download) [![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/simplyFavicon) [![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/simplyFavicon)
[![License](https://img.shields.io/github/license/JcDenis/simplyFavicon)](https://git.dotclear.watch/JcDenis/simplyFavicon/blob/master/LICENSE) [![License](https://img.shields.io/github/license/JcDenis/simplyFavicon)](https://git.dotclear.watch/JcDenis/simplyFavicon/blob/master/LICENSE)
## WHAT IS simplyFavicon ? ## ABOUT
_simplyFavicon_ 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 adds a favicon to your blog. > Add a favicon to your blog.
## REQUIREMENTS ## REQUIREMENTS
_simplyFavicon_ requires: * Dotclear 2.28
* PHP 8.1+
* A readable public directory
* Administrator permissions * Administrator permissions
* Dotclear 2.27
* PHP 7.4+
* A readable public directory.
## USAGE ## USAGE
@ -33,12 +30,13 @@ simplyFavicon add required code to public page to show favicon on browser.
## LINKS ## LINKS
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html) * [License](https://git.dotclear.watch/JcDenis/simplyFavicon/src/branch/master/LICENSE)
* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/simplyFavicon) or [GitHub Page](https://github.com/JcDenis/simplyFavicon) * [Packages & details](https://git.dotclear.watch/JcDenis/simplyFavicon/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/simplyFavicon))
* Packages & details : [Gitea Page](https://git.dotclear.watch/JcDenis/simplyFavicon/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/simplyFavicon) * [Sources & contributions](https://git.dotclear.watch/JcDenis/simplyFavicon) (or on [GitHub](https://github.com/JcDenis/simplyFavicon))
* [Issues & security](https://git.dotclear.watch/JcDenis/simplyFavicon/issues) (or on [GitHub](https://github.com/JcDenis/simplyFavicon/issues))
## CONTRIBUTORS ## CONTRIBUTORS
* Jean-Christian Denis * Jean-Christian Denis (author)
You are welcome to contribute to this code. You are welcome to contribute to this code.

24
_define.php
View File

@ -10,9 +10,19 @@
* @copyright 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')) { /*
return; * @file
} * @brief The simplyFavicon pacKman definition
* @ingroup simplyFavicon
*
* @defgroup simplyFavicon Plugin simplyFavicon.
*
* Multi-agents favicon.
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
declare(strict_types=1);
$this->registerModule( $this->registerModule(
'Simply favicon', 'Simply favicon',
@ -20,11 +30,9 @@ $this->registerModule(
'Jean-Christian Denis', 'Jean-Christian Denis',
'2023.08.13', '2023.08.13',
[ [
'requires' => [['core', '2.27']], 'requires' => [['core', '2.28']],
'permissions' => dcCore::app()->auth->makePermissions([ 'permissions' => 'My',
dcCore::app()->auth::PERMISSION_ADMIN, 'settings' => [
]),
'settings' => [
'blog' => '#params.' . basename(__DIR__) . '_params', 'blog' => '#params.' . basename(__DIR__) . '_params',
], ],
'type' => 'plugin', 'type' => 'plugin',

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="simplyFavicon"> <module id="simplyFavicon">
<name>Simply favicon</name> <name>Simply favicon</name>
<version>2023.08.13</version> <version>2023.10.13</version>
<author>Jean-Christian Denis</author> <author>Jean-Christian Denis</author>
<desc>Multi-agents favicon</desc> <desc>Multi-agents favicon</desc>
<file>https://git.dotclear.watch/JcDenis/simplyFavicon/releases/download/v2023.08.13/plugin-simplyFavicon.zip</file> <file>https://git.dotclear.watch/JcDenis/simplyFavicon/releases/download/v2023.10.13/plugin-simplyFavicon.zip</file>
<da:dcmin>2.27</da:dcmin> <da:dcmin>2.28</da:dcmin>
<da:details>https://git.dotclear.watch/JcDenis/simplyFavicon/src/branch/master/README.md</da:details> <da:details>https://git.dotclear.watch/JcDenis/simplyFavicon/src/branch/master/README.md</da:details>
<da:support>https://git.dotclear.watch/JcDenis/simplyFavicon/issues</da:support> <da:support>https://git.dotclear.watch/JcDenis/simplyFavicon/issues</da:support>
</module> </module>

36
src/Backend.php
View File

@ -1,21 +1,11 @@
<?php <?php
/**
* @brief simplyFavicon, 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\simplyFavicon; namespace Dotclear\Plugin\simplyFavicon;
use dcCore; use Dotclear\App;
use dcSettings; use Dotclear\Core\BlogSettings;
use Dotclear\Core\Process; use Dotclear\Core\Process;
use Dotclear\Helper\File\Path; use Dotclear\Helper\File\Path;
use Dotclear\Helper\Html\Form\{ use Dotclear\Helper\Html\Form\{
@ -26,6 +16,13 @@ use Dotclear\Helper\Html\Form\{
Para Para
}; };
/**
* @brief simplyFavicon backend class.
* @ingroup simplyFavicon
*
* @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
@ -39,18 +36,17 @@ class Backend extends Process
return false; return false;
} }
dcCore::app()->addBehaviors([ App::behavior()->addBehaviors([
'adminBlogPreferencesFormV2' => function (dcSettings $blog_settings): void { 'adminBlogPreferencesFormV2' => function (BlogSettings $blog_settings): void {
// nullsafe if (!App::blog()->isDefined()) {
if (is_null(dcCore::app()->blog)) {
return; return;
} }
$exists = []; $exists = [];
$path = Path::fullFromRoot((string) $blog_settings->get('system')->get('public_path'), DC_ROOT); $path = Path::fullFromRoot((string) $blog_settings->get('system')->get('public_path'), App::config()->dotclearRoot());
foreach (['ico', 'png', 'bmp', 'gif', 'jpg', 'mng'] as $ext) { foreach (['ico', 'png', 'bmp', 'gif', 'jpg', 'mng'] as $ext) {
if (file_exists($path . '/favicon.' . $ext)) { if (file_exists($path . '/favicon.' . $ext)) {
$url = dcCore::app()->blog->url . dcCore::app()->url->getURLFor('simplyFavicon', $ext); $url = App::blog()->url() . App::url()->getURLFor('simplyFavicon', $ext);
$exists[] = '<li><a href="' . $url . '">' . $url . '</a></li>'; $exists[] = '<li><a href="' . $url . '">' . $url . '</a></li>';
} }
} }
@ -82,7 +78,7 @@ class Backend extends Process
) . ) .
'</div></div><br class="clear" /></div>'; '</div></div><br class="clear" /></div>';
}, },
'adminBeforeBlogSettingsUpdate' => function (dcSettings $blog_settings): void { 'adminBeforeBlogSettingsUpdate' => function (BlogSettings $blog_settings): void {
$blog_settings->get('system')->put('simply_favicon', !empty($_POST['simply_favicon'])); $blog_settings->get('system')->put('simply_favicon', !empty($_POST['simply_favicon']));
}, },
]); ]);

33
src/Frontend.php
View File

@ -1,23 +1,20 @@
<?php <?php
/**
* @brief simplyFavicon, 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\simplyFavicon; namespace Dotclear\Plugin\simplyFavicon;
use dcCore; use Dotclear\App;
use Dotclear\Core\Process; use Dotclear\Core\Process;
use Dotclear\Helper\File\Path; use Dotclear\Helper\File\Path;
/**
* @brief simplyFavicon frontend class.
* @ingroup simplyFavicon
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Frontend extends Process class Frontend extends Process
{ {
public static function init(): bool public static function init(): bool
@ -31,16 +28,16 @@ class Frontend extends Process
return false; return false;
} }
dcCore::app()->addBehavior('publicHeadContent', function (): void { App::behavior()->addBehavior('publicHeadContent', function (): void {
if (is_null(dcCore::app()->blog) || !dcCore::app()->blog->settings->get('system')->get('simply_favicon')) { if (!App::blog()->isDefined() || !App::blog()->settings()->get('system')->get('simply_favicon')) {
return; return;
} }
$public_path = Path::fullFromRoot(dcCore::app()->blog->settings->get('system')->get('public_path'), DC_ROOT) . '/favicon.'; $public_path = Path::fullFromRoot(App::blog()->settings()->get('system')->get('public_path'), App::config()->dotclearRoot()) . '/favicon.';
$public_url = dcCore::app()->blog->url . dcCore::app()->url->getBase('simplyFavicon') . '.'; $public_url = App::blog()->url() . App::url()->getBase('simplyFavicon') . '.';
// ico : IE6 // ico : IE6
if (file_exists($public_path . 'ico') && '?' != substr(dcCore::app()->blog->url, -1)) { if (file_exists($public_path . 'ico') && '?' != substr(App::blog()->url(), -1)) {
echo echo
'<link rel="SHORTCUT ICON" type="image/x-icon" href="' . $public_url . 'ico" />' . "\n"; '<link rel="SHORTCUT ICON" type="image/x-icon" href="' . $public_url . 'ico" />' . "\n";
} }
@ -49,7 +46,7 @@ class Frontend extends Process
echo echo
'<link rel="apple-touch-icon" href="' . $public_url . 'png" />' . "\n" . '<link rel="apple-touch-icon" href="' . $public_url . 'png" />' . "\n" .
'<link rel="icon" type="image/png" href="' . $public_url . 'png" />' . "\n"; '<link rel="icon" type="image/png" href="' . $public_url . 'png" />' . "\n";
// all others // all others
} else { } else {
foreach (UrlHandler::$mimetypes as $ext => $mime) { foreach (UrlHandler::$mimetypes as $ext => $mime) {
if (in_array($ext, ['ico', 'png'])) { if (in_array($ext, ['ico', 'png'])) {

33
src/My.php
View File

@ -1,21 +1,32 @@
<?php <?php
/**
* @brief simplyFavicon, 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\simplyFavicon; namespace Dotclear\Plugin\simplyFavicon;
use Dotclear\App;
use Dotclear\Module\MyPlugin; use Dotclear\Module\MyPlugin;
/**
* @brief simplyFavicon My helper.
* @ingroup simplyFavicon
*
* @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
{ {
protected static function checkCustomContext(int $context): ?bool
{
return match ($context) {
// Limit BACKEND to admin
self::BACKEND => App::task()->checkContext('BACKEND')
&& App::blog()->isDefined()
&& App::auth()->check(App::auth()->makePermissions([
App::auth()::PERMISSION_ADMIN,
]), App::blog()->id()),
default => null,
};
}
} }

25
src/Prepend.php
View File

@ -1,22 +1,19 @@
<?php <?php
/**
* @brief simplyFavicon, 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\simplyFavicon; namespace Dotclear\Plugin\simplyFavicon;
use dcCore; use Dotclear\App;
use Dotclear\Core\Process; use Dotclear\Core\Process;
/**
* @brief simplyFavicon prepend class.
* @ingroup simplyFavicon
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class Prepend extends Process class Prepend extends Process
{ {
public static function init(): bool public static function init(): bool
@ -30,11 +27,11 @@ class Prepend extends Process
return false; return false;
} }
dcCore::app()->url->register( App::url()->register(
'simplyFavicon', 'simplyFavicon',
'favicon', 'favicon',
'^favicon.(.*?)$', '^favicon.(.*?)$',
[UrlHandler::class, 'simplyFaviconUrl'] UrlHandler::simplyFaviconUrl(...)
); );
return true; return true;

37
src/UrlHandler.php
View File

@ -1,25 +1,27 @@
<?php <?php
/**
* @brief simplyFavicon, 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\simplyFavicon; namespace Dotclear\Plugin\simplyFavicon;
use dcCore; use Dotclear\App;
use dcUrlHandlers; use Dotclear\Core\Frontend\Url;
use Dotclear\Helper\File\Path; use Dotclear\Helper\File\Path;
class UrlHandler extends dcUrlHandlers /**
* @brief simplyFavicon frontend URL handler.
* @ingroup simplyFavicon
*
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/
class UrlHandler extends Url
{ {
/**
* Mime types.
*
* @var array<string,string> $mimetypes
*/
public static array $mimetypes = [ public static array $mimetypes = [
'ico' => 'image/x-icon', 'ico' => 'image/x-icon',
'png' => 'image/png', 'png' => 'image/png',
@ -31,14 +33,13 @@ class UrlHandler extends dcUrlHandlers
public static function simplyFaviconUrl(string $arg): void public static function simplyFaviconUrl(string $arg): void
{ {
// nullsafe if (!App::blog()->isDefined()) {
if (is_null(dcCore::app()->blog)) {
return; return;
} }
$public_path = Path::fullFromRoot(dcCore::app()->blog->settings->get('system')->get('public_path'), DC_ROOT); $public_path = Path::fullFromRoot(App::blog()->settings()->get('system')->get('public_path'), App::config()->dotclearRoot());
if (dcCore::app()->blog->settings->get('system')->get('simply_favicon') if (App::blog()->settings()->get('system')->get('simply_favicon')
&& !empty($arg) && !empty($arg)
&& array_key_exists($arg, self::$mimetypes) && array_key_exists($arg, self::$mimetypes)
&& file_exists($public_path . '/favicon.' . $arg) && file_exists($public_path . '/favicon.' . $arg)