mirror/FreshRSS
0
0
Fork 0
mirror of https://github.com/FreshRSS/FreshRSS.git synced 2025-12-24 05:57:45 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add entry_before_update and entry_before_add hooks (#7977)

Browse Source 
Discussion: https://github.com/FreshRSS/FreshRSS/discussions/7973

Changes proposed in this pull request:

- Add new extension hook "entry_before_add"
- Add new extension hook "entry_before_update"

How to test the feature manually:

1. Create extension that uses the hooks and confirm they are invoked correctly.

Extension to use for testing
https://github.com/rnkln/freshrss-xExtension-Discord/pull/2
This commit is contained in:
KleinMann
2025-09-18 23:44:17 +02:00
committed by GitHub
parent 055342118f
commit d670bf1e72
5 changed files with 43 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
app/Controllers/feedController.php
View File

@@ -639,6 +639,12 @@ class FreshRSS_feed_Controller extends FreshRSS_ActionController {
// If the entry has changed, there is a good chance for the full content to have changed as well.
$entry->loadCompleteContent(true);
$entry = Minz_ExtensionManager::callHook('entry_before_update', $entry);
if (!($entry instanceof FreshRSS_Entry)) {
// An extension has returned a null value, there is nothing to insert.
continue;
}
$entryDAO->updateEntry($entry->toArray());
}
} else {
@@ -672,6 +678,12 @@ class FreshRSS_feed_Controller extends FreshRSS_ActionController {
$feed->pubSubHubbubError(true);
}
$entry = Minz_ExtensionManager::callHook('entry_before_add', $entry);
if (!($entry instanceof FreshRSS_Entry)) {
// An extension has returned a null value, there is nothing to insert.
continue;
}
if ($entryDAO->addEntry($entry->toArray(), true)) {
$nbNewArticles++;
}

13
app/Controllers/importExportController.php
View File

@@ -485,9 +485,22 @@ class FreshRSS_importExport_Controller extends FreshRSS_ActionController {
}
if (isset($existingHashForGuids['f_' . $feed_id][$entry->guid()])) {
$entry = Minz_ExtensionManager::callHook('entry_before_update', $entry);
if (!($entry instanceof FreshRSS_Entry)) {
// An extension has returned a null value, there is nothing to insert.
continue;
}
$ok = $this->entryDAO->updateEntry($entry->toArray());
} else {
$entry->_lastSeen(time());
$entry = Minz_ExtensionManager::callHook('entry_before_add', $entry);
if (!($entry instanceof FreshRSS_Entry)) {
// An extension has returned a null value, there is nothing to insert.
continue;
}
$ok = $this->entryDAO->addEntry($entry->toArray());
}

2
docs/en/developers/03_Backend/05_Extensions.md
View File

@@ -178,6 +178,8 @@ Example response for a `query_icon_info` request:
* `entry_auto_unread` (`function(FreshRSS_Entry $entry, string $why): void`): Triggered when an entry is automatically marked as unread. The *why* parameter supports the rules {`updated_article`}.
* `entry_before_display` (`function($entry) -> Entry | null`): will be executed every time an entry is rendered. The entry itself (instance of FreshRSS\_Entry) will be passed as parameter.
* `entry_before_insert` (`function($entry) -> Entry | null`): will be executed when a feed is refreshed and new entries will be imported into the database. The new entry (instance of FreshRSS\_Entry) will be passed as parameter.
* `entry_before_add` (`function($entry) -> Entry | null`): will be executed when a feed is refreshed and just before an entry is added to the database. Useful for reading the final state of the entry after filter actions have been applied. The new entry (instance of FreshRSS\_Entry) will be passed as parameter.
* `entry_before_update` (`function($entry) -> Entry | null`): will be executed when a feed is refreshed and just before an entry is updated in the database. Useful for reading the final state of the entry after filter actions have been applied. The updated entry (instance of FreshRSS\_Entry) will be passed as parameter.
* `feed_before_actualize` (`function($feed) -> Feed | null`): will be executed when a feed is updated. The feed (instance of FreshRSS\_Feed) will be passed as parameter.
* `feed_before_insert` (`function($feed) -> Feed | null`): will be executed when a new feed is imported into the database. The new feed (instance of FreshRSS\_Feed) will be passed as parameter.
* `freshrss_init` (`function() -> none`): will be executed at the end of the initialization of FreshRSS, useful to initialize components or to do additional access checks.

8
docs/fr/developers/03_Backend/05_Extensions.md
View File

@@ -235,6 +235,14 @@ The following events are available:
executed when a feed is refreshed and new entries will be imported into
the database. The new entry (instance of FreshRSS\_Entry) will be passed
as parameter.
* `entry_before_add` (`function($entry) -> Entry | null`): will be
executed when a feed is refreshed and just before an entry is added to the database.
Useful for reading the final state of the entry after filter actions have been applied.
The new entry (instance of FreshRSS\_Entry) will be passed as parameter.
* `entry_before_update` (`function($entry) -> Entry | null`): will be
executed when a feed is refreshed and just before an entry is updated in the database.
Useful for reading the final state of the entry after filter actions have been applied.
The updated entry (instance of FreshRSS\_Entry) will be passed as parameter.
* `entries_favorite` (`function(array $ids, bool $is_favorite): void`):
will be executed when some entries are marked or unmarked as favorites (starred)
* `feed_before_actualize` (`function($feed) -> Feed | null`): will be

8
lib/Minz/ExtensionManager.php
View File

@@ -62,6 +62,14 @@ final class Minz_ExtensionManager {
'list' => [],
'signature' => 'OneToOne',
],
'entry_before_add' => [ // function($entry) -> Entry | null
'list' => [],
'signature' => 'OneToOne',
],
'entry_before_update' => [ // function($entry) -> Entry | null
'list' => [],
'signature' => 'OneToOne',
],
'feed_before_actualize' => [ // function($feed) -> Feed | null
'list' => [],
'signature' => 'OneToOne',