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

Compare commits

base: JcDenis:v2023.08.12
Branches Tags
JcDenis:master
JcDenis:v2023.11.04
JcDenis:v2023.10.19
JcDenis:v2023.08.12
...
compare: JcDenis:master
Branches Tags
JcDenis:master
JcDenis:v2023.11.04
JcDenis:v2023.10.19
JcDenis:v2023.08.12

3 Commits
v2023.08.1 ... master

Author SHA1 Message Date
Jean-Christian Paul Denis 411ea6cbed
miss this one 2023-11-04 21:26:11 +01:00
Jean-Christian Paul Denis 02a44ac22a
code review 2023-11-04 21:22:19 +01:00
Jean-Christian Paul Denis a1470bd16f
upgrade to dotclear 2.28 2023-10-19 22:59:35 +02:00
11 changed files with 202 additions and 243 deletions
Show Stats Expand all files Collapse all files

13
CHANGELOG.md
View File

@ -1,3 +1,16 @@
postExpired 2023.11.04
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Fix typo
* Code review (phpstan)
postExpired 2023.10.19
===========================================================
* Require Dotclear 2.28
* Require PHP 8.1
* Upgrade to Dotclear 2.28
postExpired 2023.08.13 postExpired 2023.08.13
=========================================================== ===========================================================
* Require Dotclear 2.27 * Require Dotclear 2.27

35
README.md
View File

@ -1,26 +1,22 @@
# README # README
[![Release](https://img.shields.io/badge/release-2023.08.13-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/postExpired/releases) [![Release](https://img.shields.io/badge/release-2023.11.04-a2cbe9.svg)](https://git.dotclear.watch/JcDenis/postExpired/releases)
[![Date](https://img.shields.io/badge/date-2023.08.13-c44d58.svg)](https://git.dotclear.watch/JcDenis/postExpired/releases) ![Date](https://img.shields.io/badge/date-2023.11.04-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/postExpired) [![Dotaddict](https://img.shields.io/badge/dotaddict-official-9ac123.svg)](https://plugins.dotaddict.org/dc2/details/postExpired)
[![License](https://img.shields.io/github/license/JcDenis/postExpired)](https://git.dotclear.watch/JcDenis/postExpired/blob/master/LICENSE) [![License](https://img.shields.io/badge/license-GPL--2.0-ececec.svg)](https://git.dotclear.watch/JcDenis/postExpired/src/branch/master/LICENSE)
## WHAT IS POSTEXPIRED ? ## ABOUT
Post expired is a plugin for the open-source _postExpired_ is a plugin for the open-source web publishing software called [Dotclear](https://www.dotclear.org).
web publishing software called Dotclear.
It add options to the sidebar of post edition page > Add options to the sidebar of post edition page to change some options of a post at a given time.
to change some options of a post at a given time.
## REQUIREMENTS ## REQUIREMENTS
_postExpired_ requires: * Dotclear 2.28
* PHP 8.1+
* contentadmin permissions * Dotclear contentadmin permissions
* Dotclear 2.27
* PHP 7.4+
## USAGE ## USAGE
@ -39,13 +35,14 @@ Notes:
## LINKS ## LINKS
* License : [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/lgpl-2.0.html) * [License](https://git.dotclear.watch/JcDenis/postExpired/src/branch/master/LICENSE)
* Source & contribution : [Gitea Page](https://git.dotclear.watch/JcDenis/postExpired) or [GitHub Page](https://github.com/JcDenis/postExpired) * [Packages & details](https://git.dotclear.watch/JcDenis/postExpired/releases) (or on [Dotaddict](https://plugins.dotaddict.org/dc2/details/postExpired))
* Packages & details: [Gitea Page](https://git.dotclear.watch/JcDenis/postExpired/releases) or [Dotaddict Page](https://plugins.dotaddict.org/dc2/details/postExpired) * [Sources & contributions](https://git.dotclear.watch/JcDenis/postExpired) (or on [GitHub](https://github.com/JcDenis/postExpired))
* Discuss & help : [Dotclear Forum](https://forum.dotclear.org/viewtopic.php?id=42305) * [Issues & security](https://git.dotclear.watch/JcDenis/postExpired/issues) (or on [GitHub](https://github.com/JcDenis/postExpired/issues))
* [Discuss & help](https://forum.dotclear.org/viewtopic.php?id=42305)
## 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.

25
_define.php
View File

@ -1,30 +1,27 @@
<?php <?php
/** /**
* @brief postExpired, a plugin for Dotclear 2 * @file
* @brief The plugin postExpired definition
* @ingroup postExpired
* *
* @package Dotclear * @defgroup postExpired Plugin postExpired.
* @subpackage Plugin
* *
* @author Jean-Christian Denis and Contributors * Change entries options at a given date.
* *
* @copyright Jean-Christian Denis * @author Tomtom (author)
* @author Jean-Christian Denis (latest)
* @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')) { declare(strict_types=1);
return null;
}
$this->registerModule( $this->registerModule(
'Expired entries', 'Expired entries',
'Change entries options at a given date', 'Change entries options at a given date',
'Jean-Christian Denis and Contributors', 'Jean-Christian Denis and Contributors',
'2023.08.13', '2023.11.04',
[ [
'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="postExpired"> <module id="postExpired">
<name>Expired entries</name> <name>Expired entries</name>
<version>2023.08.13</version> <version>2023.11.04</version>
<author>Jean-Christian Denis and Contributors</author> <author>Jean-Christian Denis and Contributors</author>
<desc>Change entries options at a given date</desc> <desc>Change entries options at a given date</desc>
<file>https://git.dotclear.watch/JcDenis/postExpired/releases/download/v2023.08.13/plugin-postExpired.zip</file> <file>https://git.dotclear.watch/JcDenis/postExpired/releases/download/v2023.11.04/plugin-postExpired.zip</file>
<da:dcmin>2.27</da:dcmin> <da:dcmin>2.28</da:dcmin>
<da:details>https://git.dotclear.watch/JcDenis/postExpired/src/branch/master/README.md</da:details> <da:details>https://git.dotclear.watch/JcDenis/postExpired/src/branch/master/README.md</da:details>
<da:support>https://git.dotclear.watch/JcDenis/postExpired/issues</da:support> <da:support>https://git.dotclear.watch/JcDenis/postExpired/issues</da:support>
</module> </module>

47
src/Backend.php
View File

@ -1,22 +1,19 @@
<?php <?php
/**
* @brief postExpired, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Jean-Christian Denis and Contributors
*
* @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\postExpired; namespace Dotclear\Plugin\postExpired;
use dcCore; use Dotclear\App;
use Dotclear\Core\Process; use Dotclear\Core\Process;
/**
* @brief postExpired backend class.
* @ingroup postExpired
*
* @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
@ -30,19 +27,19 @@ class Backend extends Process
return false; return false;
} }
dcCore::app()->addBehaviors([ App::behavior()->addBehaviors([
'adminPostsActions' => [BackendBehaviors::class, 'adminPostsActions'], 'adminPostsActions' => BackendBehaviors::adminPostsActions(...),
'adminPagesActions' => [BackendBehaviors::class, 'adminPostsActions'], 'adminPagesActions' => BackendBehaviors::adminPostsActions(...),
'adminPostHeaders' => [BackendBehaviors::class, 'adminPostHeaders'], 'adminPostHeaders' => BackendBehaviors::adminPostHeaders(...),
'adminPageHeaders' => [BackendBehaviors::class, 'adminPostHeaders'], 'adminPageHeaders' => BackendBehaviors::adminPostHeaders(...),
'adminPostFormItems' => [BackendBehaviors::class, 'adminPostFormItems'], 'adminPostFormItems' => BackendBehaviors::adminPostFormItems(...),
'adminPageFormItems' => [BackendBehaviors::class, 'adminPostFormItems'], 'adminPageFormItems' => BackendBehaviors::adminPostFormItems(...),
'adminBeforePostDelete' => [BackendBehaviors::class, 'adminBeforePostDelete'], 'adminBeforePostDelete' => BackendBehaviors::adminBeforePostDelete(...),
'adminBeforePageDelete' => [BackendBehaviors::class, 'adminBeforePostDelete'], 'adminBeforePageDelete' => BackendBehaviors::adminBeforePostDelete(...),
'adminAfterPostUpdate' => [BackendBehaviors::class, 'adminAfterPostSave'], 'adminAfterPostUpdate' => BackendBehaviors::adminAfterPostSave(...),
'adminAfterPageUpdate' => [BackendBehaviors::class, 'adminAfterPostSave'], 'adminAfterPageUpdate' => BackendBehaviors::adminAfterPostSave(...),
'adminAfterPostCreate' => [BackendBehaviors::class, 'adminAfterPostSave'], 'adminAfterPostCreate' => BackendBehaviors::adminAfterPostSave(...),
'adminAfterPageCreate' => [BackendBehaviors::class, 'adminAfterPostSave'], 'adminAfterPageCreate' => BackendBehaviors::adminAfterPostSave(...),
]); ]);
return true; return true;

77
src/BackendBehaviors.php
View File

@ -1,22 +1,12 @@
<?php <?php
/**
* @brief postExpired, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Jean-Christian Denis and Contributors
*
* @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\postExpired; namespace Dotclear\Plugin\postExpired;
use ArrayObject; use ArrayObject;
use DateTimeZone; use DateTimeZone;
use dcCore; use Dotclear\App;
use Dotclear\Core\Backend\Action\ActionsPosts; use Dotclear\Core\Backend\Action\ActionsPosts;
use Dotclear\Core\Backend\{ use Dotclear\Core\Backend\{
Notices, Notices,
@ -44,9 +34,11 @@ use Dotclear\Helper\Html\Html;
use Exception; use Exception;
/** /**
* @ingroup DC_PLUGIN_POSTEXPIRED * @brief postExpired backend behaviors class.
* @brief Scheduled post change - admin methods. * @ingroup postExpired
* @since 2.6 *
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/ */
class BackendBehaviors class BackendBehaviors
{ {
@ -63,7 +55,7 @@ class BackendBehaviors
__('Add expired date') => 'post_expired_add', __('Add expired date') => 'post_expired_add',
], ],
], ],
[self::class, 'callbackAdd'] self::callbackAdd(...)
); );
$pa->addAction( $pa->addAction(
@ -72,7 +64,7 @@ class BackendBehaviors
__('Remove expired date') => 'post_expired_remove', __('Remove expired date') => 'post_expired_remove',
], ],
], ],
[self::class, 'callbackRemove'] self::callbackRemove(...)
); );
} }
@ -89,8 +81,8 @@ class BackendBehaviors
/** /**
* Add form to post sidebar. * Add form to post sidebar.
* *
* @param ArrayObject $main_items Main items * @param ArrayObject<string, mixed> $main_items Main items
* @param ArrayObject $sidebar_items Sidebar items * @param ArrayObject<string, mixed> $sidebar_items Sidebar items
* @param ?MetaRecord $post Post record or null * @param ?MetaRecord $post Post record or null
*/ */
public static function adminPostFormItems(ArrayObject $main_items, ArrayObject $sidebar_items, ?MetaRecord $post): void public static function adminPostFormItems(ArrayObject $main_items, ArrayObject $sidebar_items, ?MetaRecord $post): void
@ -147,7 +139,7 @@ class BackendBehaviors
* Posts actions callback to add expired date. * Posts actions callback to add expired date.
* *
* @param ActionsPosts $pa ActionsPosts instance * @param ActionsPosts $pa ActionsPosts instance
* @param ArrayObject $post _POST actions * @param ArrayObject<string, mixed> $post _POST actions
*/ */
public static function callbackAdd(ActionsPosts $pa, ArrayObject $post): void public static function callbackAdd(ActionsPosts $pa, ArrayObject $post): void
{ {
@ -169,8 +161,8 @@ class BackendBehaviors
) )
) { ) {
foreach ($posts_ids as $post_id) { foreach ($posts_ids as $post_id) {
self::delPostExpired($post_id); self::delPostExpired((int) $post_id);
self::setPostExpired($post_id, $post); self::setPostExpired((int) $post_id, $post);
} }
Notices::addSuccessNotice(__('Expired date added.')); Notices::addSuccessNotice(__('Expired date added.'));
@ -183,7 +175,7 @@ class BackendBehaviors
$pa->beginPage( $pa->beginPage(
Page::breadcrumb([ Page::breadcrumb([
Html::escapeHTML(dcCore::app()->blog->name) => '', Html::escapeHTML(App::blog()->name()) => '',
$pa->getCallerTitle() => $pa->getRedirection(true), $pa->getCallerTitle() => $pa->getRedirection(true),
__('Add expired date to this selection') => '', __('Add expired date to this selection') => '',
]), ]),
@ -197,7 +189,7 @@ class BackendBehaviors
(new Para())->items([ (new Para())->items([
... self::fieldsPostExpired($posts->f('post_type'), null, false), ... self::fieldsPostExpired($posts->f('post_type'), null, false),
... $pa->hiddenFields(), ... $pa->hiddenFields(),
dcCore::app()->formNonce(false), App::nonce()->formNonce(),
(new Hidden(['action'], 'post_expired_add')), (new Hidden(['action'], 'post_expired_add')),
(new Submit(['do']))->value(__('Save')), (new Submit(['do']))->value(__('Save')),
]), ]),
@ -211,7 +203,7 @@ class BackendBehaviors
* Posts actions callback to add expired date. * Posts actions callback to add expired date.
* *
* @param ActionsPosts $pa ActionsPosts instance * @param ActionsPosts $pa ActionsPosts instance
* @param ArrayObject $post _POST actions * @param ArrayObject<string, mixed> $post _POST actions
*/ */
public static function callbackRemove(ActionsPosts $pa, ArrayObject $post): void public static function callbackRemove(ActionsPosts $pa, ArrayObject $post): void
{ {
@ -223,7 +215,7 @@ class BackendBehaviors
// Delete expired date // Delete expired date
foreach ($posts_ids as $post_id) { foreach ($posts_ids as $post_id) {
self::delPostExpired($post_id); self::delPostExpired((int) $post_id);
} }
Notices::addSuccessNotice(__('Expired date deleted.')); Notices::addSuccessNotice(__('Expired date deleted.'));
@ -237,14 +229,14 @@ class BackendBehaviors
*/ */
private static function delPostExpired(int $post_id): void private static function delPostExpired(int $post_id): void
{ {
dcCore::app()->meta->delPostMeta($post_id, My::META_TYPE); App::meta()->delPostMeta($post_id, My::META_TYPE);
} }
/** /**
* Save expired date. * Save expired date.
* *
* @param int $post_id Post id * @param int $post_id Post id
* @param ArrayObject $post _POST fields * @param ArrayObject<string, mixed> $post _POST fields
*/ */
private static function setPostExpired(int $post_id, ArrayObject $post): void private static function setPostExpired(int $post_id, ArrayObject $post): void
{ {
@ -281,7 +273,7 @@ class BackendBehaviors
$post_expired['newpassword'] = (string) $post['post_expired_newpassword']; $post_expired['newpassword'] = (string) $post['post_expired_newpassword'];
} }
dcCore::app()->meta->setPostMeta( App::meta()->setPostMeta(
$post_id, $post_id,
My::META_TYPE, My::META_TYPE,
My::encode($post_expired) My::encode($post_expired)
@ -294,14 +286,15 @@ class BackendBehaviors
* @param string $post_type Posts type * @param string $post_type Posts type
* @param null|int $post_id Post ID * @param null|int $post_id Post ID
* @param bool $render Render fileds to HTML * @param bool $render Render fileds to HTML
* @return array Array of object form fields *
* @return array<string, string|Para> Array of object form fields
*/ */
private static function fieldsPostExpired(string $post_type, ?int $post_id = null, bool $render = true): array private static function fieldsPostExpired(string $post_type, ?int $post_id = null, bool $render = true): array
{ {
$fields = $post_expired = []; $fields = $post_expired = [];
if ($post_id) { if ($post_id) {
$rs = dcCore::app()->meta->getMetadata([ $rs = App::meta()->getMetadata([
'meta_type' => My::META_TYPE, 'meta_type' => My::META_TYPE,
'post_id' => $post_id, 'post_id' => $post_id,
'limit' => 1, 'limit' => 1,
@ -328,7 +321,7 @@ class BackendBehaviors
$fields['post_expired_category'] = (new Para())->items([ $fields['post_expired_category'] = (new Para())->items([
(new Label(__('Category:'), Label::OUTSIDE_LABEL_BEFORE))->for('post_expired_category'), (new Label(__('Category:'), Label::OUTSIDE_LABEL_BEFORE))->for('post_expired_category'),
(new Select('post_expired_category'))->default(empty($post_expired['category']) ? '' : $post_expired['category'])->items(self::categoriesCombo( (new Select('post_expired_category'))->default(empty($post_expired['category']) ? '' : $post_expired['category'])->items(self::categoriesCombo(
dcCore::app()->blog->getCategories( App::blog()->getCategories(
['post_type' => 'post'] ['post_type' => 'post']
) )
)), )),
@ -354,15 +347,17 @@ class BackendBehaviors
(new Checkbox('post_expired_password', !empty($post_expired['password'])))->value(1), (new Checkbox('post_expired_password', !empty($post_expired['password'])))->value(1),
(new Label(__('Change password'), Label::OUTSIDE_LABEL_AFTER))->for('post_expired_password')->class('classic'), (new Label(__('Change password'), Label::OUTSIDE_LABEL_AFTER))->for('post_expired_password')->class('classic'),
(new Label(__('New password:'), Label::OUTSIDE_LABEL_BEFORE))->for('post_expired_newpassword'), (new Label(__('New password:'), Label::OUTSIDE_LABEL_BEFORE))->for('post_expired_newpassword'),
(new Input('post_expired_newpassword'))->size(65)->maxlenght(255)->class('maximal')->value(empty($post_expired['newpassword']) ? '' : $post_expired['newpassword']), (new Input('post_expired_newpassword'))->size(65)->maxlength(255)->class('maximal')->value(empty($post_expired['newpassword']) ? '' : $post_expired['newpassword']),
(new Note())->text(__('Leave empty to remove it'))->class('form-note'), (new Note())->text(__('Leave empty to remove it'))->class('form-note'),
]); ]);
if ($render) { if ($render) {
foreach ($fields as $k => $v) { foreach ($fields as $k => $v) {
if (!is_string($v)) {
$fields[$k] = $v->render(); $fields[$k] = $v->render();
} }
} }
}
return $fields; return $fields;
} }
@ -372,7 +367,7 @@ class BackendBehaviors
* *
* @param MetaRecord $categories Categories recordset * @param MetaRecord $categories Categories recordset
* *
* @return array Categorires combo * @return array<int|string, string|Option> Categorires combo
*/ */
private static function categoriesCombo(MetaRecord $categories): array private static function categoriesCombo(MetaRecord $categories): array
{ {
@ -383,7 +378,7 @@ class BackendBehaviors
]; ];
try { try {
$categories = dcCore::app()->blog->getCategories( $categories = App::blog()->getCategories(
['post_type' => 'post'] ['post_type' => 'post']
); );
while ($categories->fetch()) { while ($categories->fetch()) {
@ -402,7 +397,7 @@ class BackendBehaviors
/** /**
* Custom status combo. * Custom status combo.
* *
* @return array Status combo * @return array<string, string> Status combo
*/ */
private static function statusCombo(): array private static function statusCombo(): array
{ {
@ -417,7 +412,7 @@ class BackendBehaviors
/** /**
* Custom selection combo. * Custom selection combo.
* *
* @return array Selection combo * @return array<string, string> Selection combo
*/ */
private static function selectedCombo(): array private static function selectedCombo(): array
{ {
@ -431,7 +426,7 @@ class BackendBehaviors
/** /**
* Custom comment status combo. * Custom comment status combo.
* *
* @return array Comment status combo * @return array<string, string> Comment status combo
*/ */
private static function commentCombo(): array private static function commentCombo(): array
{ {
@ -445,7 +440,7 @@ class BackendBehaviors
/** /**
* Custom trackback status combo. * Custom trackback status combo.
* *
* @return array Trackback status combo * @return array<string, string> Trackback status combo
*/ */
private static function trackbackCombo(): array private static function trackbackCombo(): array
{ {
@ -465,7 +460,7 @@ class BackendBehaviors
*/ */
private static function dateFromUser(string $date): string private static function dateFromUser(string $date): string
{ {
$u = !isset(dcCore::app()->auth) ? 'UTC' : dcCore::app()->auth->getInfo('user_tz'); $u = App::auth()->getInfo('user_tz') ?? 'UTC';
$d = date_create($date, new DateTimeZone($u)); $d = date_create($date, new DateTimeZone($u));
return $d ? date_format($d->setTimezone(new DateTimeZone('UTC')), 'Y-m-d H:i:00') : ''; return $d ? date_format($d->setTimezone(new DateTimeZone('UTC')), 'Y-m-d H:i:00') : '';
@ -480,7 +475,7 @@ class BackendBehaviors
*/ */
private static function dateToUser(string $date): string private static function dateToUser(string $date): string
{ {
$u = !isset(dcCore::app()->auth) ? 'UTC' : dcCore::app()->auth->getInfo('user_tz'); $u = App::auth()->getInfo('user_tz') ?? 'UTC';
$d = date_create($date, new DateTimeZone('UTC')); $d = date_create($date, new DateTimeZone('UTC'));
return $d ? date_format($d->setTimezone(new DateTimeZone($u)), 'Y-m-d\TH:i') : ''; return $d ? date_format($d->setTimezone(new DateTimeZone($u)), 'Y-m-d\TH:i') : '';

43
src/Frontend.php
View File

@ -1,22 +1,19 @@
<?php <?php
/**
* @brief postExpired, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Jean-Christian Denis and Contributors
*
* @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\postExpired; namespace Dotclear\Plugin\postExpired;
use dcCore; use Dotclear\App;
use Dotclear\Core\Process; use Dotclear\Core\Process;
/**
* @brief postExpired frontend class.
* @ingroup postExpired
*
* @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
@ -35,27 +32,27 @@ class Frontend extends Process
__('This entry has no expiration date'); __('This entry has no expiration date');
# launch update only on public home page and feed # launch update only on public home page and feed
if (in_array(dcCore::app()->url->type, ['default', 'feed'])) { if (in_array(App::url()->type, ['default', 'feed'])) {
dcCore::app()->addBehavior( App::behavior()->addBehavior(
'publicBeforeDocumentV2', 'publicBeforeDocumentV2',
[FrontendBehaviors::class, 'publicBeforeDocumentV2'] FrontendBehaviors::publicBeforeDocumentV2(...)
); );
} }
dcCore::app()->addBehavior( App::behavior()->addBehavior(
'coreBlogGetPosts', 'coreBlogGetPosts',
[FrontendBehaviors::class, 'coreBlogGetPosts'] FrontendBehaviors::coreBlogGetPosts(...)
); );
dcCore::app()->tpl->addBlock( App::frontend()->template()->addBlock(
'EntryExpiredIf', 'EntryExpiredIf',
[FrontendTemplate::class, 'EntryExpiredIf'] FrontendTemplate::EntryExpiredIf(...)
); );
dcCore::app()->tpl->addValue( App::frontend()->template()->addValue(
'EntryExpiredDate', 'EntryExpiredDate',
[FrontendTemplate::class, 'EntryExpiredDate'] FrontendTemplate::EntryExpiredDate(...)
); );
dcCore::app()->tpl->addValue( App::frontend()->template()->addValue(
'EntryExpiredTime', 'EntryExpiredTime',
[FrontendTemplate::class, 'EntryExpiredTime'] FrontendTemplate::EntryExpiredTime(...)
); );
return true; return true;

42
src/FrontendBehaviors.php
View File

@ -1,23 +1,11 @@
<?php <?php
/**
* @brief postExpired, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Jean-Christian Denis and Contributors
*
* @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\postExpired; namespace Dotclear\Plugin\postExpired;
use DateTimeZone; use DateTimeZone;
use dcBlog; use Dotclear\App;
use dcCore;
use dcMeta;
use Dotclear\Database\MetaRecord; use Dotclear\Database\MetaRecord;
use Dotclear\Database\Statement\{ use Dotclear\Database\Statement\{
JoinStatement, JoinStatement,
@ -25,9 +13,11 @@ use Dotclear\Database\Statement\{
}; };
/** /**
* @ingroup DC_PLUGIN_POSTEXPIRED * @brief postExpired frontend behaviors class.
* @brief Scheduled post change - public methods. * @ingroup postExpired
* @since 2.6 *
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/ */
class FrontendBehaviors class FrontendBehaviors
{ {
@ -38,7 +28,7 @@ class FrontendBehaviors
{ {
// Get expired dates and post_id // Get expired dates and post_id
$sql = new SelectStatement(); $sql = new SelectStatement();
$posts = $sql->from($sql->as(dcCore::app()->prefix . dcBlog::POST_TABLE_NAME, 'P')) $posts = $sql->from($sql->as(App::con()->prefix() . App::blog()::POST_TABLE_NAME, 'P'))
->columns([ ->columns([
'P.post_id', 'P.post_id',
'P.post_tz', 'P.post_tz',
@ -47,11 +37,11 @@ class FrontendBehaviors
->join( ->join(
(new JoinStatement()) (new JoinStatement())
->inner() ->inner()
->from($sql->as(dcCore::app()->prefix . dcMeta::META_TABLE_NAME, 'META')) ->from($sql->as(App::con()->prefix() . App::meta()::META_TABLE_NAME, 'META'))
->on('META.post_id = P.post_id') ->on('META.post_id = P.post_id')
->statement() ->statement()
) )
->where('blog_id = ' . $sql->quote((string) dcCore::app()->blog->id)) ->where('blog_id = ' . $sql->quote(App::blog()->id()))
->and('META.meta_type = ' . $sql->quote(My::META_TYPE)) ->and('META.meta_type = ' . $sql->quote(My::META_TYPE))
->select(); ->select();
@ -65,7 +55,7 @@ class FrontendBehaviors
$now_tz = (int) date_format(date_create('now', $utc), 'U'); $now_tz = (int) date_format(date_create('now', $utc), 'U');
// Prepared post Cursor // Prepared post Cursor
$post_cur = dcCore::app()->con->openCursor(dcCore::app()->prefix . dcBlog::POST_TABLE_NAME); $post_cur = App::blog()->openPostCursor();
// Loop through marked posts // Loop through marked posts
$updated = false; $updated = false;
@ -79,8 +69,8 @@ class FrontendBehaviors
if ($now_tz > $meta_tz) { if ($now_tz > $meta_tz) {
// Delete meta for expired date // Delete meta for expired date
dcCore::app()->auth->sudo( App::auth()->sudo(
[dcCore::app()->meta, 'delPostMeta'], App::meta()->delPostMeta(...),
$posts->f('post_id'), $posts->f('post_id'),
My::META_TYPE My::META_TYPE
); );
@ -135,7 +125,7 @@ class FrontendBehaviors
// Update post // Update post
$post_cur->update( $post_cur->update(
'WHERE post_id = ' . $posts->f('post_id') . ' ' . 'WHERE post_id = ' . $posts->f('post_id') . ' ' .
"AND blog_id = '" . dcCore::app()->con->escapeStr((string) dcCore::app()->blog->id) . "' " "AND blog_id = '" . App::con()->escapeStr(App::blog()->id()) . "' "
); );
$updated = true; $updated = true;
@ -144,7 +134,7 @@ class FrontendBehaviors
// Say blog is updated // Say blog is updated
if ($updated) { if ($updated) {
dcCore::app()->blog->triggerBlog(); App::blog()->triggerBlog();
} }
} }
@ -155,6 +145,6 @@ class FrontendBehaviors
*/ */
public static function coreBlogGetPosts(MetaRecord $rs): void public static function coreBlogGetPosts(MetaRecord $rs): void
{ {
$rs->extend('rsExtPostExpired'); $rs->extend(rsExtPostExpired::class);
} }
} }

55
src/FrontendTemplate.php
View File

@ -1,35 +1,26 @@
<?php <?php
/**
* @brief postExpired, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Jean-Christian Denis and Contributors
*
* @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\postExpired; namespace Dotclear\Plugin\postExpired;
use ArrayObject; use ArrayObject;
use dcCore; use Dotclear\App;
use dcTemplate;
use Dotclear\Helper\Date; use Dotclear\Helper\Date;
/** /**
* @ingroup DC_PLUGIN_POSTEXPIRED * @brief postExpired frontend template class.
* @brief Scheduled post change - template methods. * @ingroup postExpired
* @since 2.6 *
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/ */
class FrontendTemplate class FrontendTemplate
{ {
/** /**
* Template condition to check if there is an expired date. * Template condition to check if there is an expired date.
* *
* @param ArrayObject $attr Block attributes * @param ArrayObject<string, mixed> $attr Block attributes
* @param string $content Block content * @param string $content Block content
* *
* @return string * @return string
@ -38,13 +29,13 @@ class FrontendTemplate
{ {
$if = []; $if = [];
$operator = isset($attr['operator']) ? $operator = isset($attr['operator']) ?
dcTemplate::getOperator($attr['operator']) : '&&'; App::frontend()->template()->getOperator($attr['operator']) : '&&';
if (isset($attr['has_date'])) { if (isset($attr['has_date'])) {
$sign = (bool) $attr['has_date'] ? '!' : '='; $sign = (bool) $attr['has_date'] ? '!' : '=';
$if[] = '(null ' . $sign . '== dcCore::app()->ctx->posts->postExpiredDate())'; $if[] = '(null ' . $sign . '== App::frontend()->context()->posts->postExpiredDate())';
} else { } else {
$if[] = '(null !== dcCore::app()->ctx->posts->postExpiredDate())'; $if[] = '(null !== App::frontend()->context()->posts->postExpiredDate())';
} }
return return
@ -56,7 +47,7 @@ class FrontendTemplate
/** /**
* Template for expired date. * Template for expired date.
* *
* @param ArrayObject $attr Value attributes * @param ArrayObject<string, mixed> $attr Value attributes
* *
* @return string * @return string
*/ */
@ -64,38 +55,38 @@ class FrontendTemplate
{ {
$format = !empty($attr['format']) ? $format = !empty($attr['format']) ?
addslashes($attr['format']) : ''; addslashes($attr['format']) : '';
$f = dcCore::app()->tpl->getFilters($attr); $f = App::frontend()->template()->getFilters($attr);
if (!empty($attr['rfc822'])) { if (!empty($attr['rfc822'])) {
$res = sprintf($f, Date::class . '::rfc822(strtotime(dcCore::app()->ctx->posts->postExpiredDate()),dcCore::app()->ctx->posts->post_tz)'); $res = sprintf($f, Date::class . '::rfc822(strtotime(App::frontend()->context()->posts->postExpiredDate()),App::frontend()->context()->posts->post_tz)');
} elseif (!empty($attr['iso8601'])) { } elseif (!empty($attr['iso8601'])) {
$res = sprintf($f, Date::class . '::iso8601(strtotime(dcCore::app()->ctx->posts->postExpiredDate(),dcCore::app()->ctx->posts->post_tz)'); $res = sprintf($f, Date::class . '::iso8601(strtotime(App::frontend()->context()->posts->postExpiredDate(),App::frontend()->context()->posts->post_tz)');
} elseif ($format) { } elseif ($format) {
$res = sprintf($f, Date::class . "::dt2str('" . $format . "',dcCore::app()->ctx->posts->postExpiredDate())"); $res = sprintf($f, Date::class . "::dt2str('" . $format . "',App::frontend()->context()->posts->postExpiredDate())");
} else { } else {
$res = sprintf($f, Date::class . '::dt2str(dcCore::app()->blog->settings->system->date_format,dcCore::app()->ctx->posts->postExpiredDate())'); $res = sprintf($f, Date::class . '::dt2str(App::blog()->settings()->system->date_format,App::frontend()->context()->posts->postExpiredDate())');
} }
return '<?php if (null !== dcCore::app()->ctx->posts->postExpiredDate()) { echo ' . $res . '; } ?>'; return '<?php if (null !== App::frontend()->context()->posts->postExpiredDate()) { echo ' . $res . '; } ?>';
} }
/** /**
* Template for expired time. * Template for expired time.
* *
* @param ArrayObject $attr Value attributes * @param ArrayObject<string, mixed> $attr Value attributes
* *
* @return string * @return string
*/ */
public static function EntryExpiredTime(ArrayObject $attr): string public static function EntryExpiredTime(ArrayObject $attr): string
{ {
return return
'<?php if (null !== dcCore::app()->ctx->posts->postExpiredDate()) { echo ' . sprintf( '<?php if (null !== App::frontend()->context()->posts->postExpiredDate()) { echo ' . sprintf(
dcCore::app()->tpl->getFilters($attr), App::frontend()->template()->getFilters($attr),
Date::class . '::dt2str(' . Date::class . '::dt2str(' .
( (
!empty($attr['format']) ? !empty($attr['format']) ?
"'" . addslashes($attr['format']) . "'" : 'dcCore::app()->blog->settings->system->time_format' "'" . addslashes($attr['format']) . "'" : 'App::blog()->settings()->system->time_format'
) . ',dcCore::app()->ctx->posts->postExpiredDate())' ) . ',App::frontend()->context()->posts->postExpiredDate())'
) . '; } ?>'; ) . '; } ?>';
} }
} }

36
src/My.php
View File

@ -1,46 +1,30 @@
<?php <?php
/**
* @brief postExpired, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Jean-Christian Denis and Contributors
*
* @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\postExpired; namespace Dotclear\Plugin\postExpired;
use dcCore;
use Dotclear\Module\MyPlugin; use Dotclear\Module\MyPlugin;
/** /**
* This module definiton. * @brief postExpired My helper.
* @ingroup postExpired
*
* @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 string This module meta type */ /** @var string This module meta type */
public const META_TYPE = 'post_expired'; public const META_TYPE = 'post_expired';
public static function checkCustomContext(int $context): ?bool
{
return $context !== My::BACKEND ? null :
defined('DC_CONTEXT_ADMIN')
&& dcCore::app()->auth->check(dcCore::app()->auth->makePermissions([
dcCore::app()->auth::PERMISSION_CONTENT_ADMIN,
]), dcCore::app()->blog->id);
}
/** /**
* Encode Expired Date settings. * Encode Expired Date settings.
* *
* This is saved into post_meta as meta_id value, * This is saved into post_meta as meta_id value,
* so this must be less than 255 caracters. * so this must be less than 255 caracters.
* *
* @param array $in Array of options * @param array<string, string> $in Array of options
* *
* @return string "Serialized" options * @return string "Serialized" options
*/ */
@ -59,16 +43,18 @@ class My extends MyPlugin
* *
* @param string $in "Serialized" options * @param string $in "Serialized" options
* *
* @return array Array of options * @return array<string, string> Array of options
*/ */
public static function decode(string $in): array public static function decode(string $in): array
{ {
$out = []; $out = [];
foreach (explode(';', $in) as $v) { foreach (explode(';', $in) as $v) {
$v = explode('|', $v); $v = explode('|', $v);
$out[$v[0]] = $v[1]; $out[(string) $v[0]] = (string) $v[1];
} }
return $out; return $out;
} }
// Use default permissions
} }

36
src/RsExtPostExpired.php
View File

@ -1,31 +1,27 @@
<?php <?php
/**
* @brief postExpired, a plugin for Dotclear 2
*
* @package Dotclear
* @subpackage Plugin
*
* @author Jean-Christian Denis and Contributors
*
* @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\postExpired; namespace Dotclear\Plugin\postExpired;
use dcCore; use Dotclear\App;
use Dotclear\Database\MetaRecord; use Dotclear\Database\MetaRecord;
use rsExtPost; use Dotclear\Schema\Extension\Post;
/** /**
* @ingroup DC_PLUGIN_POSTEXPIRED * @brief postExpired record extension class.
* @brief Scheduled post change - extends recordset. * @ingroup postExpired
* @since 2.6 *
* @author Jean-Christian Denis
* @copyright GPL-2.0 https://www.gnu.org/licenses/gpl-2.0.html
*/ */
class rsExtPostExpired extends rsExtPost class rsExtPostExpired extends Post
{ {
/** @var array $memory Memory to prevent redondant call */ /**
* Memory to prevent redondant call.
*
* @var array<string, string> $memory
*/
protected static array $memory = []; protected static array $memory = [];
/** /**
@ -38,7 +34,7 @@ class rsExtPostExpired extends rsExtPost
public static function postExpiredDate(MetaRecord $rs): string public static function postExpiredDate(MetaRecord $rs): string
{ {
if (!static::$memory[$rs->f('post_id')]) { if (!static::$memory[$rs->f('post_id')]) {
$rs_date = dcCore::app()->meta->getMetadata([ $rs_date = App::meta()->getMetadata([
'meta_type' => My::META_TYPE, 'meta_type' => My::META_TYPE,
'post_id' => $rs->f('post_id'), 'post_id' => $rs->f('post_id'),
'limit' => 1, 'limit' => 1,
@ -49,7 +45,7 @@ class rsExtPostExpired extends rsExtPost
} }
$v = My::decode($rs_date->f('meta_id')); $v = My::decode($rs_date->f('meta_id'));
static::$memory[$rs->f('post_id')] = $v['date']; static::$memory[(string) $rs->f('post_id')] = (string) $v['date'];
} }
return static::$memory[$rs->f('post_id')]; return static::$memory[$rs->f('post_id')];