add findLabeldId method for article filtering

resources/desktop/com.github.rssguard.appdata.xml

@@ -26,7 +26,7 @@
   <url type="donation">https://github.com/sponsors/martinrotter</url>
   <content_rating type="oars-1.1" />
   <releases>
-    <release version="4.2.2" date="2022-05-12"/>
+    <release version="4.2.2" date="2022-05-13"/>
   </releases>
   <content_rating type="oars-1.0">
     <content_attribute id="violence-cartoon">none</content_attribute>

resources/docs/Documentation.md

@@ -139,6 +139,7 @@ Here is the reference of methods and properties of types available in your filte
 | Property  | `isImportant`                 | `Boolean`     | ❌         | ✅            | Is message important?
 | Property  | `isDeleted`                   | `Boolean`     | ❌         | ❌            | Is message placed in recycle bin?
 | Method    | `isAlreadyInDatabase(DuplicateCheck)` | `Boolean` | ❌         | ❌            | Allows you to test if this particular message is already stored in RSS Guard's DB.
+| Method    | `findLabelId(String)`         | `String`     | ❌         | ❌            | You enter title of the label and method returns `customId` of label which then can be used in  `assignLabel()` and `deassignLabel` methods.
 | Method    | `assignLabel(String)`         | `Boolean`     | ❌         | ❌            | Assigns label to this message. The passed `String` value is the `customId` property of `Label` type. See its API reference for relevant info.
 | Method    | `deassignLabel(String)`       | `Boolean`     | ❌         | ❌            | Removes label from this message. The passed `String` value is the `customId` property of `Label` type. See its API reference for relevant info.
 | Property  | `runningFilterWhenFetching`   | `Boolean`     | ✅         | ❌            | Returns `true` if current run of the message filter is done when message is fetched. Returns `false` if message filter runs manually, for example from `Article filters` window.

src/librssguard/core/messageobject.cpp

@@ -9,8 +9,12 @@
 #include <QSqlError>
 #include <QSqlQuery>
 
-MessageObject::MessageObject(QSqlDatabase* db, const QString& feed_custom_id, int account_id,
-                             const QList<Label*>& available_labels, bool is_new_message, QObject* parent)
+MessageObject::MessageObject(QSqlDatabase* db,
+                             const QString& feed_custom_id,
+                             int account_id,
+                             const QList<Label*>& available_labels,
+                             bool is_new_message,
+                             QObject* parent)
   : QObject(parent), m_db(db), m_feedCustomId(feed_custom_id), m_accountId(account_id), m_message(nullptr),
     m_availableLabels(available_labels), m_runningAfterFetching(is_new_message) {}
 
@@ -70,8 +74,7 @@ bool MessageObject::isDuplicateWithAttribute(MessageObject::DuplicateCheck attri
   QString full_query = QSL("SELECT COUNT(*) FROM Messages WHERE ") + where_clauses.join(QSL(" AND ")) + QSL(";");
 
   qDebugNN << LOGSEC_MESSAGEMODEL
-           << "Prepared query for MSG duplicate identification is:"
-           << QUOTE_W_SPACE_DOT(full_query);
+           << "Prepared query for MSG duplicate identification is:" << QUOTE_W_SPACE_DOT(full_query);
 
   q.setForwardOnly(true);
   q.prepare(full_query);
@@ -81,22 +84,17 @@ bool MessageObject::isDuplicateWithAttribute(MessageObject::DuplicateCheck attri
   }
 
   if (q.exec() && q.next()) {
-    qDebugNN << LOGSEC_DB
-             << "Executed SQL for message duplicates check:"
+    qDebugNN << LOGSEC_DB << "Executed SQL for message duplicates check:"
              << QUOTE_W_SPACE_DOT(DatabaseFactory::lastExecutedQuery(q));
 
     if (q.record().value(0).toInt() > 0) {
       // Whoops, we have the "same" message in database.
-      qDebugNN << LOGSEC_CORE
-               << "Message"
-               << QUOTE_W_SPACE(title())
-               << "was identified as duplicate by filter script.";
+      qDebugNN << LOGSEC_CORE << "Message" << QUOTE_W_SPACE(title()) << "was identified as duplicate by filter script.";
       return true;
     }
   }
   else if (q.lastError().isValid()) {
-    qWarningNN << LOGSEC_CORE
-               << "Error when checking for duplicate messages via filtering system, error:"
+    qWarningNN << LOGSEC_CORE << "Error when checking for duplicate messages via filtering system, error:"
                << QUOTE_W_SPACE_DOT(q.lastError().text());
   }
 
@@ -142,6 +140,14 @@ bool MessageObject::deassignLabel(const QString& label_custom_id) const {
   }
 }
 
+QString MessageObject::findLabelId(const QString& label_title) const {
+  Label* found_lbl = boolinq::from(m_availableLabels).firstOrDefault([label_title](Label* lbl) {
+    return lbl->title().toLower() == label_title.toLower();
+  });
+
+  return found_lbl != nullptr ? found_lbl->customId() : QString();
+}
+
 QString MessageObject::title() const {
   return m_message->m_title;
 }

src/librssguard/core/messageobject.h

@@ -89,6 +89,9 @@ class MessageObject : public QObject {
     // Returns true if label was now removed or if it is not assigned to the message at all.
     Q_INVOKABLE bool deassignLabel(const QString& label_custom_id) const;
 
+    // Returns label custom ID given label title.
+    Q_INVOKABLE QString findLabelId(const QString& label_title) const;
+
     // Returns list of assigned and available messages.
     QList<Label*> assignedLabels() const;
     QList<Label*> availableLabels() const;
@@ -146,13 +149,11 @@ class MessageObject : public QObject {
     bool m_runningAfterFetching;
 };
 
-inline MessageObject::DuplicateCheck operator|(MessageObject::DuplicateCheck lhs,
-                                               MessageObject::DuplicateCheck rhs) {
+inline MessageObject::DuplicateCheck operator|(MessageObject::DuplicateCheck lhs, MessageObject::DuplicateCheck rhs) {
   return static_cast<MessageObject::DuplicateCheck>(int(lhs) | int(rhs));
 }
 
-inline MessageObject::DuplicateCheck operator&(MessageObject::DuplicateCheck lhs,
-                                               MessageObject::DuplicateCheck rhs) {
+inline MessageObject::DuplicateCheck operator&(MessageObject::DuplicateCheck lhs, MessageObject::DuplicateCheck rhs) {
   return static_cast<MessageObject::DuplicateCheck>(int(lhs) & int(rhs));
 }