aggregation.cpp

/******************************************************************************
 *
 *  SPDX-FileCopyrightText: 2008 Szymon Tomasz Stefanek <pragma@kvirc.net>
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *
 *******************************************************************************/
 
#include "core/aggregation.h"
 
#include <QDataStream>
 
#include <KLocalizedString>
 
using namespace MessageList::Core;
 
static const int gAggregationCurrentVersion = 0x1009; // increase if you add new fields of change the meaning of some
 
Aggregation::Aggregation(const QString &name,
                         const QString &description,
                         Grouping grouping,
                         GroupExpandPolicy groupExpandPolicy,
                         Threading threading,
                         ThreadLeader threadLeader,
                         ThreadExpandPolicy threadExpandPolicy,
                         FillViewStrategy fillViewStrategy,
                         bool readOnly)
    : OptionSet(name, description, readOnly)
    , mGrouping(grouping)
    , mGroupExpandPolicy(groupExpandPolicy)
    , mThreading(threading)
    , mThreadLeader(threadLeader)
    , mThreadExpandPolicy(threadExpandPolicy)
    , mFillViewStrategy(fillViewStrategy)
{
}
 
Aggregation::Grouping Aggregation::grouping() const
{
    return mGrouping;
}
 
Aggregation::Aggregation(const Aggregation &opt)
 
    = default;
 
Aggregation::Aggregation()
    : OptionSet()
    , mGrouping(NoGrouping)
    , mGroupExpandPolicy(NeverExpandGroups)
    , mThreading(NoThreading)
    , mThreadLeader(TopmostMessage)
    , mThreadExpandPolicy(NeverExpandThreads)
    , mFillViewStrategy(FavorInteractivity)
{
}
 
bool Aggregation::load(QDataStream &stream)
{
    int val;
 
    stream >> val;
    if (val != gAggregationCurrentVersion) {
        return false; // b0rken (invalid version)
    }
 
    stream >> val;
    mGrouping = static_cast<Grouping>(val);
    switch (mGrouping) {
    case NoGrouping:
    case GroupByDate:
    case GroupByDateRange:
    case GroupBySenderOrReceiver:
    case GroupBySender:
    case GroupByReceiver:
        // ok
        break;
    default:
        // b0rken
        return false;
    }
 
    stream >> val; // Formerly contained group sorting
    stream >> val; // Formerly contained group sorting direction
 
    stream >> val;
    mGroupExpandPolicy = (GroupExpandPolicy)val;
    switch (mGroupExpandPolicy) {
    case NeverExpandGroups:
    case ExpandRecentGroups:
    case AlwaysExpandGroups:
        // ok
        break;
    default:
        // b0rken
        return false;
        break;
    }
 
    stream >> val;
    mThreading = (Threading)val;
    switch (mThreading) {
    case NoThreading:
    case PerfectOnly:
    case PerfectAndReferences:
    case PerfectReferencesAndSubject:
        // ok
        break;
    default:
        // b0rken
        return false;
    }
 
    stream >> val;
    mThreadLeader = (ThreadLeader)val;
    switch (mThreadLeader) {
    case MostRecentMessage:
    case TopmostMessage:
        // ok
        // FIXME: Should check that thread leaders setting matches grouping and threading settings.
        break;
    default:
        // b0rken
        return false;
    }
 
    stream >> val;
    mThreadExpandPolicy = (ThreadExpandPolicy)val;
    switch (mThreadExpandPolicy) {
    case NeverExpandThreads:
    case ExpandThreadsWithNewMessages:
    case ExpandThreadsWithUnreadMessages:
    case ExpandThreadsWithUnreadOrImportantMessages:
    case AlwaysExpandThreads:
        // ok
        break;
    default:
        // b0rken
        return false;
    }
 
    stream >> val; // Formerly contained message sorting
    stream >> val; // Formerly contained message sort direction
 
    stream >> val;
    mFillViewStrategy = (FillViewStrategy)val;
    switch (mFillViewStrategy) {
    case FavorSpeed:
    case FavorInteractivity:
    case BatchNoInteractivity:
        // ok
        break;
    default:
        // b0rken
        return false;
    }
 
    return true;
}
 
void Aggregation::save(QDataStream &stream) const
{
    stream << (int)gAggregationCurrentVersion;
    stream << (int)mGrouping;
    stream << 0; // Formerly group sorting
    stream << 0; // Formerly group sort direction
    stream << (int)mGroupExpandPolicy;
    stream << (int)mThreading;
    stream << (int)mThreadLeader;
    stream << (int)mThreadExpandPolicy;
    stream << 0; // Formerly message sorting
    stream << 0; // Formerly message sort direction
    stream << (int)mFillViewStrategy;
}
 
QList<QPair<QString, int>> Aggregation::enumerateGroupingOptions()
{
    return {{i18nc("No grouping of messages", "None"), NoGrouping},
            {i18n("By Exact Date (of Thread Leaders)"), GroupByDate},
            {i18n("By Smart Date Ranges (of Thread Leaders)"), GroupByDateRange},
            {i18n("By Smart Sender/Receiver"), GroupBySenderOrReceiver},
            {i18n("By Sender"), GroupBySender},
            {i18n("By Receiver"), GroupByReceiver}};
}
 
QList<QPair<QString, int>> Aggregation::enumerateGroupExpandPolicyOptions(Grouping g)
{
    QList<QPair<QString, int>> ret;
    if (g == NoGrouping) {
        return ret;
    }
    ret.append({i18n("Never Expand Groups"), NeverExpandGroups});
    if ((g == GroupByDate) || (g == GroupByDateRange)) {
        ret.append({i18n("Expand Recent Groups"), ExpandRecentGroups});
    }
    ret.append({i18n("Always Expand Groups"), AlwaysExpandGroups});
    return ret;
}
 
QList<QPair<QString, int>> Aggregation::enumerateThreadingOptions()
{
    return {{i18nc("No threading of messages", "None"), NoThreading},
            {i18n("Perfect Only"), PerfectOnly},
            {i18n("Perfect and by References"), PerfectAndReferences},
            {i18n("Perfect, by References and by Subject"), PerfectReferencesAndSubject}};
}
 
QList<QPair<QString, int>> Aggregation::enumerateThreadLeaderOptions(Grouping g, Threading t)
{
    QList<QPair<QString, int>> ret;
    if (t == NoThreading) {
        return ret;
    }
    ret.append({i18n("Topmost Message"), TopmostMessage});
    if ((g != GroupByDate) && (g != GroupByDateRange)) {
        return ret;
    }
    ret.append({i18n("Most Recent Message"), MostRecentMessage});
    return ret;
}
 
QList<QPair<QString, int>> Aggregation::enumerateThreadExpandPolicyOptions(Threading t)
{
    if (t == NoThreading) {
        return {};
    }
 
    return {{i18n("Never Expand Threads"), NeverExpandThreads},
            {i18n("Expand Threads With Unread Messages"), ExpandThreadsWithUnreadMessages},
            {i18n("Expand Threads With Unread or Important Messages"), ExpandThreadsWithUnreadOrImportantMessages},
            {i18n("Always Expand Threads"), AlwaysExpandThreads}};
}
 
QList<QPair<QString, int>> Aggregation::enumerateFillViewStrategyOptions()
{
    return {{i18n("Favor Interactivity"), FavorInteractivity}, {i18n("Favor Speed"), FavorSpeed}, {i18n("Batch Job (No Interactivity)"), BatchNoInteractivity}};
}