antispamconfig.h

/*
    antispamconfig.h
 
    This file is part of KMail, the KDE mail client.
    SPDX-FileCopyrightText: 2004 Patrick Audley <paudley@blackcat.ca>
    SPDX-FileCopyrightText: 2004 Ingo Kloecker <kloecker@kde.org>
 
    SPDX-License-Identifier: GPL-2.0-or-later
*/
 
#pragma once
 
#include <QList>
#include <QRegularExpression>
 
class QString;
 
namespace MessageViewer
{
/// Valid types of SpamAgent
enum SpamAgentTypes {
    SpamAgentNone, //!< Invalid SpamAgent, skip this agent
    SpamAgentBool, //!< Simple Yes or No (Razor)
    SpamAgentFloat, //!< For straight percentages between 0.0 and 1.0 (BogoFilter)
    SpamAgentFloatLarge, //!< For straight percentages between 0.0 and 100.0
    SpamAgentAdjustedFloat, //!< Use this when we need to compare against a threshold (SpamAssasssin)
};
 
class SpamAgent
{
public:
    SpamAgent()
        : mType(SpamAgentNone)
    {
    }
 
    SpamAgent(const QString &name,
              SpamAgentTypes type,
              const QByteArray &field,
              const QByteArray &cfield,
              const QRegularExpression &score,
              const QRegularExpression &threshold,
              const QRegularExpression &confidence)
        : mName(name)
        , mType(type)
        , mField(field)
        , mConfidenceField(cfield)
        , mScore(score)
        , mThreshold(threshold)
        , mConfidence(confidence)
    {
    }
 
    [[nodiscard]] QString name() const
    {
        return mName;
    }
 
    [[nodiscard]] SpamAgentTypes scoreType() const
    {
        return mType;
    }
 
    [[nodiscard]] QByteArray header() const
    {
        return mField;
    }
 
    [[nodiscard]] QByteArray confidenceHeader() const
    {
        return mConfidenceField;
    }
 
    [[nodiscard]] QRegularExpression scorePattern() const
    {
        return mScore;
    }
 
    [[nodiscard]] QRegularExpression thresholdPattern() const
    {
        return mThreshold;
    }
 
    [[nodiscard]] QRegularExpression confidencePattern() const
    {
        return mConfidence;
    }
 
private:
    QString mName;
    SpamAgentTypes mType;
    QByteArray mField;
    QByteArray mConfidenceField;
    QRegularExpression mScore;
    QRegularExpression mThreshold;
    QRegularExpression mConfidence;
};
using SpamAgents = QList<SpamAgent>;
 
class AntiSpamConfigSingletonProvider;
 
/**
    @short Singleton to manage loading the kmail.antispamrc file.
    @author Patrick Audley <paudley@blackcat.ca>
 
    Use of this config-manager class is straight forward.  Since it
    is a singleton object, all you have to do is obtain an instance
    by calling @p SpamConfig::instance() and use any of the
    public member functions.
  */
class AntiSpamConfig
{
    friend class AntiSpamConfigSingletonProvider;
 
private:
    AntiSpamConfig();
 
public:
    ~AntiSpamConfig();
 
    static AntiSpamConfig *instance();
 
    /**
     * Returns a list of all agents found on the system. This
     * might list SA twice, if both the C and the Perl version are present.
     */
    const SpamAgents agents() const;
 
    /**
     * Returns a list of unique agents, found on the system. SpamAssassin will
     * only be listed once, even if both the C and the Perl version are
     * installed.
     */
    const SpamAgents uniqueAgents() const;
 
private:
    SpamAgents mAgents;
 
    void readConfig();
};
}