1
mirror of https://invent.kde.org/network/falkon.git synced 2024-11-11 17:42:10 +01:00
falkonOfficial/src/lib/adblock/adblocksubscription.h
nowrep 847469e0be AdBlock: Support for element hiding rules & improved performance
- improved performance with not using regexps when not necessary
- added support for element hiding even with domain restrictions
- almost all types of rules are supported now
   * exceptions are only some special cases when rule has
     unssuported options (part of rule after $ character)
   * those rules are ignored
2012-06-25 16:07:25 +02:00

150 lines
4.7 KiB
C++

/* ============================================================
* QupZilla - WebKit based browser
* Copyright (C) 2010-2012 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/>.
* ============================================================ */
/**
* Copyright (c) 2009, Benjamin C. Meyer <ben@meyerhome.net>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the Benjamin Meyer nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#ifndef ADBLOCKSUBSCRIPTION_H
#define ADBLOCKSUBSCRIPTION_H
#include <QList>
#include <QUrl>
#include "qz_namespace.h"
#include "adblockrule.h"
class QNetworkReply;
class QUrl;
class QT_QUPZILLA_EXPORT AdBlockSubscription : public QObject
{
Q_OBJECT
public:
explicit AdBlockSubscription(const QString &title, QObject* parent = 0);
QString title() const;
QString filePath() const;
void setFilePath(const QString &path);
QUrl url() const;
void setUrl(const QUrl &url);
virtual void loadSubscription();
virtual void saveSubscription();
const AdBlockRule* allow(const QString &urlDomain, const QString &urlString) const;
const AdBlockRule* block(const QString &urlDomain, const QString &urlString) const;
QString elementHidingRules() const;
QString elementHidingRulesForDomain(const QString &domain) const;
QList<AdBlockRule> allRules() const;
void enableRule(int offset);
void disableRule(int offset);
virtual bool canEditRules() const;
virtual bool canBeRemoved() const;
virtual int addRule(const AdBlockRule &rule);
virtual bool removeRule(int offset);
virtual bool replaceRule(const AdBlockRule &rule, int offset);
public slots:
void updateSubscription();
signals:
void subscriptionUpdated();
protected slots:
void subscriptionDownloaded();
protected:
virtual void saveDownloadedData(QByteArray &data);
void populateCache();
QNetworkReply* m_reply;
QList<AdBlockRule> m_rules;
QString m_elementHidingRules;
// sorted list
QList<const AdBlockRule*> m_networkExceptionRules;
QList<const AdBlockRule*> m_networkBlockRules;
QList<const AdBlockRule*> m_domainRestrictedCssRules;
private:
QString m_title;
QString m_filePath;
QUrl m_url;
};
class AdBlockEasyList : public AdBlockSubscription
{
Q_OBJECT
public:
explicit AdBlockEasyList(QObject* parent = 0);
bool canBeRemoved() const;
protected:
void saveDownloadedData(QByteArray &data);
};
class AdBlockCustomList : public AdBlockSubscription
{
Q_OBJECT
public:
explicit AdBlockCustomList(QObject* parent = 0);
bool canEditRules() const;
bool canBeRemoved() const;
int addRule(const AdBlockRule &rule);
bool removeRule(int offset);
bool replaceRule(const AdBlockRule &rule, int offset);
};
#endif // ADBLOCKSUBSCRIPTION_H