adblocksubscription.h

Go to the documentation of this file.

/* ============================================================
* Falkon - Qt web browser
* Copyright (C) 2010-2016  David Rosca <nowrep@gmail.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program.  If not, see <http://www.gnu.org/licenses/>.
* ============================================================ */
#ifndef ADBLOCKSUBSCRIPTION_H
#define ADBLOCKSUBSCRIPTION_H
 
#include <QVector>
#include <QUrl>
 
#include "qzcommon.h"
#include "adblockrule.h"
#include "adblocksearchtree.h"
 
class QUrl;
class QNetworkReply;
 
class FALKON_EXPORT AdBlockSubscription : public QObject
{
    Q_OBJECT
public:
    explicit AdBlockSubscription(const QString &title, QObject* parent = nullptr);
    ~AdBlockSubscription();
 
    QString title() const;
 
    QString filePath() const;
    void setFilePath(const QString &path);
 
    QUrl url() const;
    void setUrl(const QUrl &url);
 
    virtual void loadSubscription(const QStringList &disabledRules);
    virtual void saveSubscription();
 
    const AdBlockRule* rule(int offset) const;
    QVector<AdBlockRule*> allRules() const;
 
    const AdBlockRule* enableRule(int offset);
    const AdBlockRule* disableRule(int offset);
 
    virtual bool canEditRules() const;
    virtual bool canBeRemoved() const;
 
    virtual int addRule(AdBlockRule* rule);
    virtual bool removeRule(int offset);
    virtual const AdBlockRule* replaceRule(AdBlockRule* rule, int offset);
 
public Q_SLOTS:
    void updateSubscription();
 
Q_SIGNALS:
    void subscriptionChanged();
    void subscriptionUpdated();
    void subscriptionError(const QString &message);
 
protected Q_SLOTS:
    void subscriptionDownloaded();
 
protected:
    virtual bool saveDownloadedData(const QByteArray &data);
 
    QNetworkReply *m_reply;
    QVector<AdBlockRule*> m_rules;
 
private:
    QString m_title;
    QString m_filePath;
 
    QUrl m_url;
    bool m_updated;
};
 
class AdBlockCustomList : public AdBlockSubscription
{
    Q_OBJECT
public:
    explicit AdBlockCustomList(QObject* parent = nullptr);
 
    void loadSubscription(const QStringList &disabledRules) override;
    void saveSubscription() override;
 
    bool canEditRules() const override;
    bool canBeRemoved() const override;
 
    bool containsFilter(const QString &filter) const;
    bool removeFilter(const QString &filter);
 
    int addRule(AdBlockRule* rule) override;
    bool removeRule(int offset) override;
    const AdBlockRule* replaceRule(AdBlockRule* rule, int offset) override;
};
 
#endif // ADBLOCKSUBSCRIPTION_H