FreshRSS/rssguard
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Enum values now avaialble via names in filtering logic, updated docs, removed some crazy stuff.

Browse Source
This commit is contained in:
Martin Rotter 2020-11-18 09:40:26 +01:00
parent 3940afe1e6
commit 5cc2896c94
7 changed files with 81 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
resources/docs/Message-filters.md
View File

@ -19,9 +19,9 @@ Message filter consists of arbitrary JavaScript code which must provide function
function filterMessage() { }
```
This function must be fast and must return integer values which belong to enumeration [`FilteringAction`](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h#L83). For example, your function must return `2` to block the message which is subsequently NOT saved into database. For easier usage, RSS Guard 3.7.1+ offers named variables for this, which are called `MSG_ACCEPT` and `MSG_IGNORE`.
This function must be fast and must return values which belong to enumeration `FilteringAction` from this [file](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h). You can you either direct numerical value of each enumerant, for example `2` or you can use self-descriptive enumerant name, for example `MessageObject.Ignore`. Named enumerants are supported in RSS Guard 3.8.1+. RSS Guard 3.7.1+ also offers names `MSG_ACCEPT` and `MSG_IGNORE` as aliases for `MessageObject.Accept` and `MessageObject.Ignore`.
Each message is accessible in your script via global variable named `msg` of type [`MessageObject`](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h#L118). Some properties are writable, allowing you to change contents of the message before it is written to DB. You can mark message important, parse its description or perhaps change author name or even assign some label to it!!!
Each message is accessible in your script via global variable named `msg` of type `MessageObject`, see this [file](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h) for the declaration. Some properties are writable, allowing you to change contents of the message before it is written to DB. You can mark message important, parse its description or perhaps change author name or even assign some label to it!!!
RSS Guard 3.8.0+ offers also list of labels assigned to each message. You can therefore do actions in your filtering script based on which labels are assigned to the message. The property is called `assignedLabels` and is array of `Label` objects. Each `Label` in the array offers these properties: `title` (title of the label), `color` (color of the label) and `customId` (account-specific ID of the label). If you change assigned labels to the message, then the change will be eventually synchronized back to server if respective plugin supports it.
@ -29,9 +29,10 @@ Passed message also offers special function
```js
MessageObject.isDuplicateWithAttribute(DuplicationAttributeCheck)
```
which allows you to perform runtime check for existence of the message in RSS Guard's database. The parameter is integer value from enumeration [`DuplicationAttributeCheck`](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h#L91) and specifies how exactly you want to determine if given message is "duplicate".
For example if you want to check if there is already another message with same author in database, then you call `msg.isDuplicateWithAttribute(4)`. Enumeration even supports "flags" approach, thus you can combine multiple checks via bitwise `OR` operation in single call, for example like this: `msg.isDuplicateWithAttribute(4 | 16)`.
which allows you to perform runtime check for existence of the message in RSS Guard's database. The parameter is integer value from enumeration `DuplicationAttributeCheck` from this [file](https://github.com/martinrotter/rssguard/blob/master/src/librssguard/core/message.h) and specifies how exactly you want to determine if given message is "duplicate". Again, you can use direct integer value or enumerant name.
For example if you want to check if there is already another message with same author in database, then you call `msg.isDuplicateWithAttribute(MessageObject.SameAuthor)`. Enumeration even supports "flags" approach, thus you can combine multiple checks via bitwise `OR` operation in single call, for example like this: `msg.isDuplicateWithAttribute(MessageObject.SameAuthor | MessageObject.SameUrl)`.
## API reference
Here is the reference of methods and properties of some types available in your filtering scipts.
@ -51,7 +52,7 @@ Here is the reference of methods and properties of some types available in your
| `Date created` | Date/time of the message. |
| `Boolean isRead` | Is message read? |
| `Boolean isImportant` | Is message important? |
| `Boolean isDuplicateWithAttribute(Integer)` | Allows you to test if this particular message is already stored in RSS Guard's DB. |
| `Boolean isDuplicateWithAttribute(DuplicationAttributeCheck)` | Allows you to test if this particular message is already stored in RSS Guard's DB. |
| `Boolean assignLabel(String)` | Assigns label to this message. The passed `String` value is the `customId` property of `Label` type. See its API reference for relevant info. Available in RSS Guard 3.8.1+. |
| `Boolean deassignLabel(String)` | Removes label from this message. The passed `String` value is the `customId` property of `Label` type. See its API reference for relevant info. Available in RSS Guard 3.8.1+. |
@ -68,10 +69,10 @@ Accept only messages from "Bob" while also marking them important.
function filterMessage() {
if (msg.author == "Bob") {
msg.isImportant = true;
return MSG_ACCEPT;
return MessageObject.Accept;
}
else {
return MSG_IGNORE;
return MessageObject.Ignore;
}
}
```
@ -80,7 +81,7 @@ Replace all dogs with cats!
```js
function filterMessage() {
msg.title = msg.title.replace("dogs", "cats");
return MSG_ACCEPT;
return MessageObject.Accept;
}
```
@ -106,18 +107,18 @@ function filterMessage() {
}
console.log();
return MSG_ACCEPT;
return MessageObject.Accept;
}
```
Make sure that your receive only one message with particular URL and all other messages with same URL are subsequently ignored.
```js
function filterMessage() {
if (msg.isDuplicateWithAttribute(2)) {
return MSG_IGNORE;
if (msg.isDuplicateWithAttribute(MessageObject.SameUrl)) {
return MessageObject.Ignore;
}
else {
return MSG_ACCEPT;
return MessageObject.Accept;
}
}
```

6
src/librssguard/core/feeddownloader.cpp
View File

@ -152,18 +152,18 @@ void FeedDownloader::updateOneFeed(Feed* feed) {
tmr.restart();
try {
FilteringAction decision = msg_filter->filterMessage(&filter_engine);
MessageObject::FilteringAction decision = msg_filter->filterMessage(&filter_engine);
qDebugNN << LOGSEC_FEEDDOWNLOADER
<< "Running filter script, it took " << tmr.nsecsElapsed() / 1000 << " microseconds.";
switch (decision) {
case FilteringAction::Accept:
case MessageObject::FilteringAction::Accept:
// Message is normally accepted, it could be tweaked by the filter.
continue;
case FilteringAction::Ignore:
case MessageObject::FilteringAction::Ignore:
// Remove the message, we do not want it.
remove_msg = true;

21
src/librssguard/core/message.cpp
View File

@ -169,38 +169,29 @@ void MessageObject::setMessage(Message* message) {
m_message = message;
}
bool MessageObject::isDuplicateWithAttribute(int attribute_check) const {
if (attribute_check <= 0) {
qCriticalNN << LOGSEC_MESSAGEMODEL
<< "Bad DuplicationAttributeCheck value '"
<< attribute_check
<< "' was passed from JS filter script.";
return true;
}
bool MessageObject::isDuplicateWithAttribute(MessageObject::DuplicationAttributeCheck attribute_check) const {
// Check database according to duplication attribute_check.
DuplicationAttributeCheck attrs = static_cast<DuplicationAttributeCheck>(attribute_check);
QSqlQuery q(*m_db);
QStringList where_clauses;
QList<QPair<QString, QVariant>> bind_values;
// Now we construct the query according to parameter.
if ((attrs& DuplicationAttributeCheck::SameTitle) == DuplicationAttributeCheck::SameTitle) {
if ((attribute_check& DuplicationAttributeCheck::SameTitle) == DuplicationAttributeCheck::SameTitle) {
where_clauses.append(QSL("title = :title"));
bind_values.append({ ":title", title() });
}
if ((attrs& DuplicationAttributeCheck::SameUrl) == DuplicationAttributeCheck::SameUrl) {
if ((attribute_check& DuplicationAttributeCheck::SameUrl) == DuplicationAttributeCheck::SameUrl) {
where_clauses.append(QSL("url = :url"));
bind_values.append({ ":url", url() });
}
if ((attrs& DuplicationAttributeCheck::SameAuthor) == DuplicationAttributeCheck::SameAuthor) {
if ((attribute_check& DuplicationAttributeCheck::SameAuthor) == DuplicationAttributeCheck::SameAuthor) {
where_clauses.append(QSL("author = :author"));
bind_values.append({ ":author", author() });
}
if ((attrs& DuplicationAttributeCheck::SameDateCreated) == DuplicationAttributeCheck::SameDateCreated) {
if ((attribute_check& DuplicationAttributeCheck::SameDateCreated) == DuplicationAttributeCheck::SameDateCreated) {
where_clauses.append(QSL("date_created = :date_created"));
bind_values.append({ ":date_created", created().toMSecsSinceEpoch() });
}
@ -208,7 +199,7 @@ bool MessageObject::isDuplicateWithAttribute(int attribute_check) const {
where_clauses.append(QSL("account_id = :account_id"));
bind_values.append({ ":account_id", accountId() });
if ((attrs& DuplicationAttributeCheck::AllFeedsSameAccount) != DuplicationAttributeCheck::AllFeedsSameAccount) {
if ((attribute_check& DuplicationAttributeCheck::AllFeedsSameAccount) != DuplicationAttributeCheck::AllFeedsSameAccount) {
// Limit to current feed.
where_clauses.append(QSL("feed = :feed"));
bind_values.append({ ":feed", feedCustomId() });

78
src/librssguard/core/message.h
View File

@ -82,41 +82,6 @@ QDataStream& operator>>(QDataStream& in, Message& myObj);
uint qHash(const Message& key, uint seed);
uint qHash(const Message& key);
enum class FilteringAction {
// Message is normally accepted and stored in DB.
Accept = 1,
// Message is ignored and now stored in DB.
Ignore = 2
};
enum class DuplicationAttributeCheck {
// Message with same title in DB.
SameTitle = 1,
// Message with same URL in DB.
SameUrl = 2,
// Message with same author in DB.
SameAuthor = 4,
// Messages with same creation date in DB.
SameDateCreated = 8,
// Compare with all messages from the account not only with messages from same feed.
// Note that this value must be used via bitwise OR with other values,
// for example 2 | 4 | 16.
AllFeedsSameAccount = 16
};
inline DuplicationAttributeCheck operator|(DuplicationAttributeCheck lhs, DuplicationAttributeCheck rhs) {
return static_cast<DuplicationAttributeCheck>(int(lhs) | int(rhs));
}
inline DuplicationAttributeCheck operator&(DuplicationAttributeCheck lhs, DuplicationAttributeCheck rhs) {
return static_cast<DuplicationAttributeCheck>(int(lhs) & int(rhs));
}
class MessageObject : public QObject {
Q_OBJECT
@ -133,6 +98,37 @@ class MessageObject : public QObject {
Q_PROPERTY(bool isImportant READ isImportant WRITE setIsImportant)
public:
enum class FilteringAction {
// Message is normally accepted and stored in DB.
Accept = 1,
// Message is ignored and now stored in DB.
Ignore = 2
};
Q_ENUM(FilteringAction)
enum class DuplicationAttributeCheck {
// Message with same title in DB.
SameTitle = 1,
// Message with same URL in DB.
SameUrl = 2,
// Message with same author in DB.
SameAuthor = 4,
// Messages with same creation date in DB.
SameDateCreated = 8,
// Compare with all messages from the account not only with messages from same feed.
// Note that this value must be used via bitwise OR with other values,
// for example 2 | 4 | 16.
AllFeedsSameAccount = 16
};
Q_ENUM(DuplicationAttributeCheck)
explicit MessageObject(QSqlDatabase* db, const QString& feed_custom_id,
int account_id, QList<Label*> available_labels,
QObject* parent = nullptr);
@ -142,7 +138,7 @@ class MessageObject : public QObject {
// Check if message is duplicate with another messages in DB.
// Parameter "attribute_check" is DuplicationAttributeCheck enum
// value casted to int.
Q_INVOKABLE bool isDuplicateWithAttribute(int attribute_check) const;
Q_INVOKABLE bool isDuplicateWithAttribute(DuplicationAttributeCheck attribute_check) const;
// Adds given label to list of assigned labels to this message.
// Returns true if label was assigned now or if the message already has it assigned.
@ -189,4 +185,14 @@ class MessageObject : public QObject {
QList<Label*> m_availableLabels;
};
inline MessageObject::DuplicationAttributeCheck operator|(MessageObject::DuplicationAttributeCheck lhs,
MessageObject::DuplicationAttributeCheck rhs) {
return static_cast<MessageObject::DuplicationAttributeCheck>(int(lhs) | int(rhs));
}
inline MessageObject::DuplicationAttributeCheck operator&(MessageObject::DuplicationAttributeCheck lhs,
MessageObject::DuplicationAttributeCheck rhs) {
return static_cast<MessageObject::DuplicationAttributeCheck>(int(lhs) & int(rhs));
}
#endif // MESSAGE_H

10
src/librssguard/core/messagefilter.cpp
View File

@ -7,7 +7,7 @@
MessageFilter::MessageFilter(int id, QObject* parent) : QObject(parent), m_id(id) {}
FilteringAction MessageFilter::filterMessage(QJSEngine* engine) {
MessageObject::FilteringAction MessageFilter::filterMessage(QJSEngine* engine) {
// NOTE: Filter is represented by JavaScript code, each filter must define
// function with "filterMessage()" prototype. There is a global "msg" object
// representing "message" available.
@ -56,7 +56,7 @@ FilteringAction MessageFilter::filterMessage(QJSEngine* engine) {
throw FilteringException(error, message);
}
return FilteringAction(filter_output.toInt());
return MessageObject::FilteringAction(filter_output.toInt());
}
int MessageFilter::id() const {
@ -81,13 +81,15 @@ void MessageFilter::setScript(const QString& script) {
void MessageFilter::initializeFilteringEngine(QJSEngine& engine, MessageObject* message_wrapper) {
engine.installExtensions(QJSEngine::Extension::ConsoleExtension);
engine.globalObject().setProperty("MSG_ACCEPT", int(FilteringAction::Accept));
engine.globalObject().setProperty("MSG_IGNORE", int(FilteringAction::Ignore));
engine.globalObject().setProperty("MSG_ACCEPT", int(MessageObject::FilteringAction::Accept));
engine.globalObject().setProperty("MSG_IGNORE", int(MessageObject::FilteringAction::Ignore));
// Register the wrapper.
auto js_object = engine.newQObject(message_wrapper);
auto js_meta_object = engine.newQMetaObject(&message_wrapper->staticMetaObject);
engine.globalObject().setProperty("msg", js_object);
engine.globalObject().setProperty(message_wrapper->staticMetaObject.className(), js_meta_object);
}
void MessageFilter::setId(int id) {

2
src/librssguard/core/messagefilter.h
View File

@ -16,7 +16,7 @@ class MessageFilter : public QObject {
public:
explicit MessageFilter(int id = -1, QObject* parent = nullptr);
FilteringAction filterMessage(QJSEngine* engine);
MessageObject::FilteringAction filterMessage(QJSEngine* engine);
int id() const;
void setId(int id);

14
src/librssguard/gui/dialogs/formmessagefiltersmanager.cpp
View File

@ -148,7 +148,12 @@ void FormMessageFiltersManager::testFilter() {
// Perform per-message filtering.
QJSEngine filter_engine;
QSqlDatabase database = qApp->database()->connection(metaObject()->className());
MessageObject msg_obj(&database, QString::number(NO_PARENT_CATEGORY), NO_PARENT_CATEGORY, {});
MessageObject msg_obj(&database,
QString::number(NO_PARENT_CATEGORY),
selectedAccount() != nullptr
? selectedAccount()->accountId()
: NO_PARENT_CATEGORY,
{});
auto* fltr = selectedFilter();
Message msg = testingMessage();
@ -157,11 +162,11 @@ void FormMessageFiltersManager::testFilter() {
msg_obj.setMessage(&msg);
try {
FilteringAction decision = fltr->filterMessage(&filter_engine);
MessageObject::FilteringAction decision = fltr->filterMessage(&filter_engine);
m_ui.m_txtErrors->setTextColor(decision == FilteringAction::Accept ? Qt::GlobalColor::darkGreen : Qt::GlobalColor::red);
m_ui.m_txtErrors->setTextColor(decision == MessageObject::FilteringAction::Accept ? Qt::GlobalColor::darkGreen : Qt::GlobalColor::red);
QString answer = tr("Message will be %1.\n\n").arg(decision == FilteringAction::Accept
QString answer = tr("Message will be %1.\n\n").arg(decision == MessageObject::FilteringAction::Accept
? tr("ACCEPTED")
: tr("REJECTED"));
@ -341,6 +346,7 @@ void FormMessageFiltersManager::initializeTestingMessage() {
Message FormMessageFiltersManager::testingMessage() const {
Message msg;
msg.m_feedId = NO_PARENT_CATEGORY;
msg.m_url = m_ui.m_txtSampleUrl->text();
msg.m_title = m_ui.m_txtSampleTitle->text();
msg.m_author = m_ui.m_txtSampleAuthor->text();