presentation/QuickRuleSuggest.cpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | // Rule suggestions from manual moves (Sprint 95 S95.4.5, D-12, RJ5): part of | ||
| 2 | // QuickRulesBackend, split from QuickRuleMailFlow.cpp for the size limits of | ||
| 3 | // sprint95-units.json. | ||
| 4 | #include "QuickRulesBackend.h" | ||
| 5 | |||
| 6 | #include "RuleDraftFactory.h" | ||
| 7 | |||
| 8 | #include <QDateTime> | ||
| 9 | #include <QDir> | ||
| 10 | #include <QLoggingCategory> | ||
| 11 | |||
| 12 | Q_DECLARE_LOGGING_CATEGORY(lcRulesBackend) | ||
| 13 | |||
| 14 | |||
| 15 | // The suggestion key is the sender address, or "list:<id>" for mailing | ||
| 16 | // list mail (S95.1.11): a list is sorted by its identity, not its senders. | ||
| 17 | namespace { | ||
| 18 |
1/1✓ Branch 3 → 4 taken 35 times.
|
35 | bool isListKey(const QString &key) { return key.startsWith(QLatin1String("list:")); } |
| 19 |
2/2✓ Branch 3 → 4 taken 1 time.
✓ Branch 3 → 5 taken 1 time.
|
2 | QString keyLabel(const QString &key) { return isListKey(key) ? key.mid(5) : key; } |
| 20 | } // namespace | ||
| 21 | |||
| 22 | 18 | void QuickRulesBackend::recordManualMove(const QString &senderAddress, const QString &listId, const QString &imapPath) { | |
| 23 |
2/3✓ Branch 3 → 4 taken 18 times.
✗ Branch 3 → 5 not taken.
✓ Branch 4 → 6 taken 18 times.
|
18 | const auto account = m_deps.account ? m_deps.account() : std::nullopt; |
| 24 |
1/1✓ Branch 6 → 7 taken 18 times.
|
18 | const SieveSession *s = session(); |
| 25 |
11/16✓ Branch 8 → 9 taken 18 times.
✗ Branch 8 → 18 not taken.
✓ Branch 10 → 11 taken 18 times.
✗ Branch 10 → 18 not taken.
✓ Branch 11 → 12 taken 18 times.
✗ Branch 11 → 18 not taken.
✓ Branch 12 → 13 taken 18 times.
✓ Branch 13 → 14 taken 18 times.
✗ Branch 13 → 18 not taken.
✓ Branch 15 → 16 taken 18 times.
✗ Branch 15 → 19 not taken.
✓ Branch 16 → 17 taken 18 times.
✓ Branch 17 → 18 taken 4 times.
✓ Branch 17 → 19 taken 14 times.
✓ Branch 20 → 21 taken 4 times.
✓ Branch 20 → 22 taken 14 times.
|
18 | if (!account || !available() || !s || readOnly() || (m_deps.suggestionsEnabled && !m_deps.suggestionsEnabled())) |
| 26 | 4 | return; | |
| 27 |
4/4✓ Branch 23 → 24 taken 14 times.
✓ Branch 24 → 25 taken 14 times.
✓ Branch 28 → 29 taken 14 times.
✓ Branch 29 → 30 taken 14 times.
|
28 | m_suggestions.setFile(QDir(storageDirectory(account->id)).filePath(QStringLiteral("suggestions.json"))); |
| 28 |
10/16✓ Branch 36 → 37 taken 11 times.
✓ Branch 36 → 38 taken 3 times.
✓ Branch 38 → 39 taken 3 times.
✓ Branch 42 → 43 taken 3 times.
✓ Branch 43 → 44 taken 3 times.
✓ Branch 43 → 45 taken 11 times.
✓ Branch 45 → 46 taken 3 times.
✓ Branch 45 → 47 taken 11 times.
✓ Branch 47 → 48 taken 3 times.
✓ Branch 47 → 49 taken 11 times.
✗ Branch 183 → 184 not taken.
✗ Branch 183 → 185 not taken.
✗ Branch 187 → 188 not taken.
✗ Branch 187 → 189 not taken.
✗ Branch 191 → 192 not taken.
✗ Branch 191 → 193 not taken.
|
17 | const QString key = listId.isEmpty() ? senderAddress : QStringLiteral("list:") + listId.toLower(); |
| 29 |
2/2✓ Branch 49 → 50 taken 14 times.
✓ Branch 50 → 51 taken 14 times.
|
14 | const auto suggestion = m_suggestions.record(key, imapPath, QDateTime::currentDateTimeUtc()); |
| 30 |
2/2✓ Branch 53 → 54 taken 10 times.
✓ Branch 53 → 55 taken 4 times.
|
14 | if (!suggestion) |
| 31 | 10 | return; | |
| 32 |
1/1✓ Branch 57 → 58 taken 4 times.
|
4 | m_suggestions.markOffered(suggestion->sender, suggestion->folder); |
| 33 | // Nothing to suggest when a rule already files this mail there. | ||
| 34 | 4 | MailHeader header; | |
| 35 |
3/3✓ Branch 59 → 60 taken 4 times.
✓ Branch 60 → 61 taken 1 time.
✓ Branch 60 → 62 taken 3 times.
|
4 | header.from = isListKey(key) ? senderAddress : key; |
| 36 |
4/4✓ Branch 64 → 65 taken 4 times.
✓ Branch 65 → 66 taken 1 time.
✓ Branch 65 → 67 taken 3 times.
✓ Branch 66 → 68 taken 1 time.
|
4 | header.listId = isListKey(key) ? key.mid(5) : QString(); |
| 37 |
1/1✓ Branch 70 → 71 taken 4 times.
|
4 | header.recipientsKnown = isListKey(key); |
| 38 |
1/1✓ Branch 71 → 72 taken 4 times.
|
4 | const QString target = sieveNameFor(imapPath); |
| 39 |
6/6✓ Branch 73 → 74 taken 4 times.
✓ Branch 75 → 76 taken 4 times.
✓ Branch 78 → 79 taken 4 times.
✓ Branch 79 → 80 taken 4 times.
✓ Branch 109 → 81 taken 1 time.
✓ Branch 109 → 110 taken 3 times.
|
4 | for (const int index : RuleMatcher::matchingBlocks(s->document(), messageFor(header, {}))) { |
| 40 |
1/2✓ Branch 106 → 86 taken 1 time.
✗ Branch 106 → 107 not taken.
|
1 | for (const Sieve::Action &action : s->document().blocks.at(index).rule.actions) |
| 41 |
3/6✓ Branch 87 → 88 taken 1 time.
✗ Branch 87 → 91 not taken.
✓ Branch 89 → 90 taken 1 time.
✗ Branch 89 → 91 not taken.
✓ Branch 92 → 93 taken 1 time.
✗ Branch 92 → 104 not taken.
|
1 | if (action.kind == Sieve::Action::Kind::FileInto && action.target == target) { |
| 42 |
5/5✓ Branch 93 → 94 taken 1 time.
✓ Branch 97 → 98 taken 1 time.
✓ Branch 98 → 99 taken 1 time.
✓ Branch 102 → 95 taken 1 time.
✓ Branch 102 → 103 taken 1 time.
|
2 | qCDebug(lcRulesBackend) << "Suggestion skipped: a rule already covers the pair"; |
| 43 | 1 | return; | |
| 44 | } | ||
| 45 | 4 | } | |
| 46 |
9/9✓ Branch 114 → 116 taken 3 times.
✓ Branch 119 → 120 taken 3 times.
✓ Branch 120 → 121 taken 3 times.
✓ Branch 122 → 123 taken 3 times.
✓ Branch 123 → 124 taken 3 times.
✓ Branch 124 → 125 taken 3 times.
✓ Branch 125 → 126 taken 3 times.
✓ Branch 129 → 117 taken 3 times.
✓ Branch 129 → 130 taken 3 times.
|
6 | qCInfo(lcRulesBackend) << "Suggesting a rule after" << suggestion->count << "moves, list" << isListKey(key); |
| 47 |
1/1✓ Branch 130 → 131 taken 3 times.
|
3 | const QString message = isListKey(key) |
| 48 |
3/7✓ Branch 132 → 133 taken 1 time.
✓ Branch 141 → 142 taken 1 time.
✓ Branch 141 → 143 taken 2 times.
✗ Branch 223 → 224 not taken.
✗ Branch 223 → 225 not taken.
✗ Branch 227 → 228 not taken.
✗ Branch 227 → 229 not taken.
|
4 | ? tr("You moved mail of the list %1 to %2 several times. Always do this?").arg(keyLabel(key), target) |
| 49 |
10/12✓ Branch 131 → 132 taken 1 time.
✓ Branch 131 → 135 taken 2 times.
✓ Branch 133 → 134 taken 1 time.
✓ Branch 134 → 137 taken 1 time.
✓ Branch 135 → 136 taken 2 times.
✓ Branch 136 → 137 taken 2 times.
✓ Branch 137 → 138 taken 2 times.
✓ Branch 137 → 139 taken 1 time.
✓ Branch 139 → 140 taken 1 time.
✓ Branch 139 → 141 taken 2 times.
✗ Branch 219 → 220 not taken.
✗ Branch 219 → 221 not taken.
|
4 | : tr("You moved mail from %1 to %2 several times. Always do this?").arg(key, target); |
| 50 |
1/1✓ Branch 143 → 144 taken 3 times.
|
3 | emit ruleSuggested(message, key, imapPath); |
| 51 | 42 | } | |
| 52 | |||
| 53 | 6 | QVariantMap QuickRulesBackend::suggestionContext(const QString &key, const QString &imapPath) { | |
| 54 |
2/3✓ Branch 3 → 4 taken 6 times.
✗ Branch 3 → 5 not taken.
✓ Branch 4 → 6 taken 6 times.
|
6 | const auto account = m_deps.account ? m_deps.account() : std::nullopt; |
| 55 | 6 | QStringList own; | |
| 56 |
1/2✓ Branch 7 → 8 taken 6 times.
✗ Branch 7 → 17 not taken.
|
6 | if (account) |
| 57 |
2/4✓ Branch 14 → 15 taken 12 times.
✓ Branch 14 → 16 taken 6 times.
✗ Branch 130 → 131 not taken.
✗ Branch 130 → 132 not taken.
|
18 | own = {account->email, account->imap.username}; |
| 58 | 6 | RuleDraftFactory::MailFacts facts; | |
| 59 |
3/3✓ Branch 17 → 18 taken 6 times.
✓ Branch 18 → 19 taken 1 time.
✓ Branch 18 → 23 taken 5 times.
|
6 | if (isListKey(key)) |
| 60 |
1/1✓ Branch 19 → 20 taken 1 time.
|
1 | facts.listId = key.mid(5); |
| 61 | else | ||
| 62 |
1/1✓ Branch 23 → 24 taken 5 times.
|
5 | facts.sender = key.toLower(); |
| 63 |
1/1✓ Branch 27 → 28 taken 6 times.
|
6 | const SieveSession *s = session(); |
| 64 |
4/7✓ Branch 32 → 33 taken 6 times.
✗ Branch 32 → 37 not taken.
✓ Branch 33 → 34 taken 6 times.
✗ Branch 33 → 37 not taken.
✓ Branch 34 → 35 taken 6 times.
✓ Branch 35 → 36 taken 6 times.
✗ Branch 35 → 37 not taken.
|
12 | return {{QStringLiteral("available"), available() && s != nullptr && !readOnly()}, |
| 65 |
2/2✓ Branch 42 → 43 taken 6 times.
✓ Branch 43 → 44 taken 6 times.
|
12 | {QStringLiteral("chips"), RuleDraftFactory::chipMaps(RuleDraftFactory::chips(facts, own))}, |
| 66 |
1/1✓ Branch 48 → 49 taken 6 times.
|
12 | {QStringLiteral("folder"), sieveNameFor(imapPath)}, |
| 67 | 12 | {QStringLiteral("predicted"), false}, | |
| 68 | 18 | {QStringLiteral("scopePath"), QStringLiteral("INBOX")}, | |
| 69 |
1/1✓ Branch 67 → 68 taken 6 times.
|
18 | {QStringLiteral("scopeName"), sieveNameFor(QStringLiteral("INBOX"))}, |
| 70 |
2/4✓ Branch 72 → 73 taken 6 times.
✗ Branch 72 → 76 not taken.
✓ Branch 74 → 75 taken 6 times.
✗ Branch 74 → 76 not taken.
|
12 | {QStringLiteral("stop"), s && s->document().style.stopByDefault}, |
| 71 | 12 | {QStringLiteral("sender"), facts.sender}, | |
| 72 |
6/8✓ Branch 85 → 86 taken 6 times.
✓ Branch 86 → 87 taken 1 time.
✓ Branch 86 → 88 taken 5 times.
✓ Branch 91 → 92 taken 5 times.
✓ Branch 95 → 96 taken 54 times.
✓ Branch 95 → 97 taken 6 times.
✗ Branch 142 → 143 not taken.
✗ Branch 142 → 144 not taken.
|
77 | {QStringLiteral("name"), isListKey(key) ? facts.listId : facts.sender.section(QLatin1Char('@'), 1)}}; |
| 73 | 78 | } | |
| 74 | |||
| 75 | 1 | void QuickRulesBackend::silenceSuggestions(const QString &key) { | |
| 76 | 1 | m_suggestions.silenceSender(key); | |
| 77 |
4/4✓ Branch 3 → 4 taken 1 time.
✓ Branch 5 → 6 taken 1 time.
✓ Branch 6 → 7 taken 1 time.
✓ Branch 7 → 8 taken 1 time.
|
2 | emit toast(tr("No more rule suggestions for %1").arg(keyLabel(key)), false); |
| 78 | 1 | } | |
| 79 | |||
| 80 | 3 | QString QuickRulesBackend::acceptSuggestion(const QString &key, const QString &imapPath) { | |
| 81 |
1/1✓ Branch 2 → 3 taken 3 times.
|
3 | const QVariantMap context = suggestionContext(key, imapPath); |
| 82 |
7/7✓ Branch 3 → 4 taken 3 times.
✓ Branch 4 → 5 taken 1 time.
✓ Branch 4 → 8 taken 2 times.
✓ Branch 11 → 12 taken 2 times.
✓ Branch 11 → 13 taken 1 time.
✓ Branch 13 → 14 taken 1 time.
✓ Branch 13 → 15 taken 2 times.
|
6 | const QString chipKey = isListKey(key) ? QStringLiteral("list") : QStringLiteral("sender"); |
| 83 | 3 | QList<QVariantMap> conditions; | |
| 84 |
6/6✓ Branch 19 → 20 taken 3 times.
✓ Branch 20 → 21 taken 3 times.
✓ Branch 25 → 26 taken 3 times.
✓ Branch 26 → 27 taken 3 times.
✓ Branch 61 → 28 taken 3 times.
✓ Branch 61 → 62 taken 3 times.
|
9 | for (const QVariant &chip : context.value(QStringLiteral("chips")).toList()) |
| 85 |
5/5✓ Branch 29 → 30 taken 3 times.
✓ Branch 34 → 35 taken 3 times.
✓ Branch 35 → 36 taken 3 times.
✓ Branch 43 → 44 taken 2 times.
✓ Branch 43 → 59 taken 1 time.
|
6 | if (chip.toMap().value(QStringLiteral("key")).toString() == chipKey) |
| 86 |
4/4✓ Branch 44 → 45 taken 2 times.
✓ Branch 49 → 50 taken 2 times.
✓ Branch 50 → 51 taken 2 times.
✓ Branch 51 → 52 taken 2 times.
|
7 | conditions.append(chip.toMap().value(QStringLiteral("condition")).toMap()); |
| 87 |
2/2✓ Branch 64 → 65 taken 1 time.
✓ Branch 64 → 70 taken 2 times.
|
3 | if (conditions.isEmpty()) |
| 88 |
2/2✓ Branch 65 → 66 taken 1 time.
✓ Branch 66 → 67 taken 1 time.
|
1 | return refuseEdit(tr("This sender can't be used in a rule.")); |
| 89 |
2/2✓ Branch 86 → 87 taken 2 times.
✓ Branch 87 → 88 taken 2 times.
|
4 | const QVariantMap draft = RuleDraftFactory::draft(conditions, context.value(QStringLiteral("folder")).toString(), false, |
| 90 |
2/2✓ Branch 80 → 81 taken 2 times.
✓ Branch 81 → 82 taken 2 times.
|
6 | false, context.value(QStringLiteral("stop")).toBool(), |
| 91 |
3/3✓ Branch 74 → 75 taken 2 times.
✓ Branch 75 → 76 taken 2 times.
✓ Branch 88 → 89 taken 2 times.
|
10 | context.value(QStringLiteral("name")).toString()); |
| 92 |
1/1✓ Branch 104 → 105 taken 2 times.
|
2 | return saveRule(-1, draft, {}, true); |
| 93 | 3 | } | |
| 94 | |||
| 95 | // --- junk rules (S95.5.2) ---------------------------------------------------------------- | ||
| 96 | |||
| 97 | 5 | void QuickRulesBackend::offerJunkRule(const QString &sender) { | |
| 98 |
1/1✓ Branch 2 → 3 taken 5 times.
|
5 | const SieveSession *s = session(); |
| 99 |
9/12✓ Branch 4 → 5 taken 4 times.
✓ Branch 4 → 12 taken 1 time.
✓ Branch 5 → 6 taken 4 times.
✗ Branch 5 → 12 not taken.
✓ Branch 6 → 7 taken 4 times.
✓ Branch 7 → 8 taken 4 times.
✗ Branch 7 → 12 not taken.
✓ Branch 10 → 11 taken 4 times.
✗ Branch 11 → 12 not taken.
✓ Branch 11 → 13 taken 4 times.
✓ Branch 14 → 15 taken 1 time.
✓ Branch 14 → 16 taken 4 times.
|
5 | if (!available() || !s || readOnly() || !sender.contains(QLatin1Char('@'))) |
| 100 | 3 | return; | |
| 101 | // Nothing to offer when a rule already sends this sender's mail to Junk | ||
| 102 | // (or discards it). | ||
| 103 |
1/1✓ Branch 16 → 17 taken 4 times.
|
4 | const SieveMailboxDirectory directory = mailboxDirectory(); |
| 104 |
2/2✓ Branch 20 → 21 taken 4 times.
✓ Branch 21 → 22 taken 4 times.
|
4 | const QString junkName = directory.sieveName(directory.folderForSpecialUse(QStringLiteral("\\Junk"))); |
| 105 | 4 | MailHeader header; | |
| 106 | 4 | header.from = sender; | |
| 107 |
6/6✓ Branch 28 → 29 taken 4 times.
✓ Branch 30 → 31 taken 4 times.
✓ Branch 33 → 34 taken 4 times.
✓ Branch 34 → 35 taken 4 times.
✓ Branch 60 → 36 taken 2 times.
✓ Branch 60 → 61 taken 2 times.
|
4 | for (const int index : RuleMatcher::matchingBlocks(s->document(), messageFor(header, {}))) |
| 108 |
1/2✓ Branch 57 → 41 taken 2 times.
✗ Branch 57 → 58 not taken.
|
2 | for (const Sieve::Action &action : s->document().blocks.at(index).rule.actions) |
| 109 |
1/2✓ Branch 42 → 43 taken 2 times.
✗ Branch 42 → 51 not taken.
|
4 | if (action.kind == Sieve::Action::Kind::Discard || |
| 110 |
3/4✓ Branch 43 → 44 taken 2 times.
✗ Branch 43 → 52 not taken.
✓ Branch 46 → 47 taken 1 time.
✓ Branch 46 → 51 taken 1 time.
|
4 | (action.kind == Sieve::Action::Kind::FileInto && |
| 111 |
3/6✓ Branch 48 → 49 taken 1 time.
✗ Branch 48 → 52 not taken.
✓ Branch 50 → 51 taken 1 time.
✗ Branch 50 → 52 not taken.
✓ Branch 53 → 54 taken 2 times.
✗ Branch 53 → 55 not taken.
|
5 | (action.specialUse == QLatin1String("\\Junk") || (!junkName.isEmpty() && action.target == junkName)))) |
| 112 |
2/2✓ Branch 63 → 64 taken 2 times.
✓ Branch 63 → 66 taken 2 times.
|
4 | return; |
| 113 |
5/5✓ Branch 65 → 67 taken 2 times.
✓ Branch 67 → 68 taken 2 times.
✓ Branch 69 → 70 taken 2 times.
✓ Branch 70 → 71 taken 2 times.
✓ Branch 71 → 72 taken 2 times.
|
4 | emit junkRuleOffered(tr("Moved to Junk. Always treat mail from %1 as junk?").arg(sender.toLower()), sender.toLower()); |
| 114 | 8 | } | |
| 115 | |||
| 116 | 3 | QString QuickRulesBackend::acceptJunkRule(const QString &sender) { | |
| 117 |
1/1✓ Branch 3 → 4 taken 3 times.
|
3 | const QVariantMap context = suggestionContext(sender, QString()); |
| 118 | 3 | QList<QVariantMap> conditions; | |
| 119 |
6/6✓ Branch 9 → 10 taken 3 times.
✓ Branch 10 → 11 taken 3 times.
✓ Branch 15 → 16 taken 3 times.
✓ Branch 16 → 17 taken 3 times.
✓ Branch 52 → 18 taken 4 times.
✓ Branch 52 → 53 taken 3 times.
|
10 | for (const QVariant &chip : context.value(QStringLiteral("chips")).toList()) |
| 120 |
5/5✓ Branch 20 → 21 taken 4 times.
✓ Branch 25 → 26 taken 4 times.
✓ Branch 26 → 27 taken 4 times.
✓ Branch 34 → 35 taken 2 times.
✓ Branch 34 → 50 taken 2 times.
|
8 | if (chip.toMap().value(QStringLiteral("key")).toString() == QLatin1String("sender")) |
| 121 |
4/4✓ Branch 35 → 36 taken 2 times.
✓ Branch 40 → 41 taken 2 times.
✓ Branch 41 → 42 taken 2 times.
✓ Branch 42 → 43 taken 2 times.
|
7 | conditions.append(chip.toMap().value(QStringLiteral("condition")).toMap()); |
| 122 |
2/2✓ Branch 55 → 56 taken 1 time.
✓ Branch 55 → 61 taken 2 times.
|
3 | if (conditions.isEmpty()) |
| 123 |
2/2✓ Branch 56 → 57 taken 1 time.
✓ Branch 57 → 58 taken 1 time.
|
1 | return refuseEdit(tr("This sender can't be used in a rule.")); |
| 124 | 4 | QVariantMap draft = RuleDraftFactory::draft(conditions, QString(), false, false, true, | |
| 125 |
4/4✓ Branch 61 → 62 taken 2 times.
✓ Branch 63 → 64 taken 2 times.
✓ Branch 64 → 65 taken 2 times.
✓ Branch 66 → 67 taken 2 times.
|
8 | tr("Junk: %1").arg(sender.toLower())); |
| 126 |
5/9✓ Branch 85 → 86 taken 2 times.
✓ Branch 91 → 92 taken 2 times.
✓ Branch 91 → 93 taken 2 times.
✓ Branch 95 → 96 taken 2 times.
✓ Branch 95 → 97 taken 2 times.
✗ Branch 190 → 191 not taken.
✗ Branch 190 → 192 not taken.
✗ Branch 196 → 197 not taken.
✗ Branch 196 → 198 not taken.
|
12 | draft.insert(QStringLiteral("actions"), QVariantList{QVariantMap{{QStringLiteral("kind"), QStringLiteral("junk")}}}); |
| 127 |
1/1✓ Branch 102 → 103 taken 2 times.
|
2 | return saveRule(-1, draft, {}, true); |
| 128 | 7 | } | |
| 129 |