Split AdBlock rule in two classes to move the implementation out of it

In order to make special matching rules, we need specialization of the
implementation depending on the type of rule.

The previous AdBlockRule was entierly based on regexp. The new one
is only a factory to a AdBlockRuleImpl, and delegate everything to
this implementation.

This will allow faster specialization of the ad block rules in the
future.

5 files changed, 202 insertions, 84 deletions

diff --git a/src/adblock/adblockrule.cpp b/src/adblock/adblockrule.cpp
index 420caab3..8236f920 100644
--- a/src/adblock/adblockrule.cpp
+++ b/src/adblock/adblockrule.cpp
@@ -55,82 +55,9 @@
 // Self Includes
 #include "adblockrule.h"
 
-// Qt Includes
-#include <QStringList>
-#include <QUrl>
-
-static inline bool isRegExpFilter(const QString &filter)
-{
-    return filter.startsWith(QL1C('/')) && filter.endsWith(QL1C('/'));
-}
+#include "adblockrulefallbackimpl.h"
 
 AdBlockRule::AdBlockRule(const QString &filter)
 {
-    m_regExp.setCaseSensitivity(Qt::CaseInsensitive);
-    m_regExp.setPatternSyntax(QRegExp::RegExp2);
-
-    QString parsedLine = filter;
-
-    const int optionsNumber = parsedLine.lastIndexOf(QL1C('$'));
-    if (optionsNumber >= 0 && !isRegExpFilter(parsedLine)) {
-        const QStringList options(parsedLine.mid(optionsNumber + 1).split(QL1C(',')));
-        if (options.contains(QL1S("match-case")))
-            m_regExp.setCaseSensitivity(Qt::CaseSensitive);
-        parsedLine = parsedLine.left(optionsNumber);
-    }
-
-    if (isRegExpFilter(parsedLine))
-        parsedLine = parsedLine.mid(1, parsedLine.length() - 2);
-    else
-        parsedLine = convertPatternToRegExp(parsedLine);
-
-    m_regExp.setPattern(parsedLine);
-}
-
-
-// here return false means that rule doesn't match,
-// so that url is allowed
-// return true means "matched rule", so stop url!
-bool AdBlockRule::match(const QString &encodedUrl) const
-{
-    return m_regExp.indexIn(encodedUrl) != -1;
-}
-
-
-QString AdBlockRule::convertPatternToRegExp(const QString &wildcardPattern)
-{
-    QString pattern = wildcardPattern;
-
-    // remove multiple wildcards
-    pattern.replace(QRegExp(QL1S("\\*+")), QL1S("*"));
-
-    // remove anchors following separator placeholder
-    pattern.replace(QRegExp(QL1S("\\^\\|$")), QL1S("^"));
-
-    // remove leading wildcards
-    pattern.replace(QRegExp(QL1S("^(\\*)")), QL1S(""));
-
-    // remove trailing wildcards
-    pattern.replace(QRegExp(QL1S("(\\*)$")), QL1S(""));
-
-    // escape special symbols
-    pattern.replace(QRegExp(QL1S("(\\W)")), QL1S("\\\\1"));
-
-    // process extended anchor at expression start
-    pattern.replace(QRegExp(QL1S("^\\\\\\|\\\\\\|")), QL1S("^[\\w\\-]+:\\/+(?!\\/)(?:[^\\/]+\\.)?"));
-
-    // process separator placeholders
-    pattern.replace(QRegExp(QL1S("\\\\\\^")), QL1S("(?:[^\\w\\d\\-.%]|$)"));
-
-    // process anchor at expression start
-    pattern.replace(QRegExp(QL1S("^\\\\\\|")), QL1S("^"));
-
-    // process anchor at expression end
-    pattern.replace(QRegExp(QL1S("\\\\\\|$")), QL1S("$"));
-
-    // replace wildcards by .*
-    pattern.replace(QRegExp(QL1S("\\\\\\*")), QL1S(".*"));
-
-    // Finally, return...
-    return pattern;
+    m_implementation = QSharedPointer<AdBlockRuleImpl>(new AdBlockRuleFallbackImpl(filter));
 }
diff --git a/src/adblock/adblockrule.h b/src/adblock/adblockrule.h
index 1cd9ea49..04409688 100644
--- a/src/adblock/adblockrule.h
+++ b/src/adblock/adblockrule.h
@@ -58,25 +58,25 @@
 // Rekonq Includes
 #include "rekonq_defines.h"
 
-// Qt Includes
-#include <QtCore/QRegExp>
-#include <QtCore/QString>
+#include "adblockruleimpl.h"
 
-// Forward Includes
-class QUrl;
+#include <QSharedPointer>
 
+// Forward Includes
+class QString;
 
 class AdBlockRule
 {
 public:
     AdBlockRule(const QString &filter);
 
-    bool match(const QString &encodedUrl) const;
+    bool match(const QString &encodedUrl) const
+    {
+        return m_implementation->match(encodedUrl);
+    }
 
 private:
-    QString convertPatternToRegExp(const QString &wildcardPattern);
-
-    QRegExp m_regExp;
+    QSharedPointer<AdBlockRuleImpl> m_implementation;
 };
 
 
diff --git a/src/adblock/adblockrulefallbackimpl.cpp b/src/adblock/adblockrulefallbackimpl.cpp
new file mode 100644
index 00000000..decb895d
--- /dev/null
+++ b/src/adblock/adblockrulefallbackimpl.cpp
@@ -0,0 +1,105 @@
+/* ============================================================
+*
+* This file is a part of the rekonq project
+*
+* Copyright (C) 2010 by Benjamin Poulain <ikipou at gmail dot 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 2 of
+* the License or (at your option) version 3 or any later version
+* accepted by the membership of KDE e.V. (or its successor approved
+* by the membership of KDE e.V.), which shall act as a proxy
+* defined in Section 14 of version 3 of the license.
+*
+* 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/>.
+*
+* ============================================================ */
+
+// Self Includes
+#include "adblockrulefallbackimpl.h"
+
+// Rekonq Includes
+#include "rekonq_defines.h"
+
+// Qt Includes
+#include <QStringList>
+
+static inline bool isRegExpFilter(const QString &filter)
+{
+    return filter.startsWith(QL1C('/')) && filter.endsWith(QL1C('/'));
+}
+
+AdBlockRuleFallbackImpl::AdBlockRuleFallbackImpl(const QString &filter)
+    : AdBlockRuleImpl(filter)
+{
+    m_regExp.setCaseSensitivity(Qt::CaseInsensitive);
+    m_regExp.setPatternSyntax(QRegExp::RegExp2);
+
+    QString parsedLine = filter;
+
+    const int optionsNumber = parsedLine.lastIndexOf(QL1C('$'));
+    if (optionsNumber >= 0 && !isRegExpFilter(parsedLine)) {
+        const QStringList options(parsedLine.mid(optionsNumber + 1).split(QL1C(',')));
+        if (options.contains(QL1S("match-case")))
+            m_regExp.setCaseSensitivity(Qt::CaseSensitive);
+        parsedLine = parsedLine.left(optionsNumber);
+    }
+
+    if (isRegExpFilter(parsedLine))
+        parsedLine = parsedLine.mid(1, parsedLine.length() - 2);
+    else
+        parsedLine = convertPatternToRegExp(parsedLine);
+
+    m_regExp.setPattern(parsedLine);
+}
+
+bool AdBlockRuleFallbackImpl::match(const QString &encodedUrl) const
+{
+    return m_regExp.indexIn(encodedUrl) != -1;
+}
+
+QString AdBlockRuleFallbackImpl::convertPatternToRegExp(const QString &wildcardPattern)
+{
+    QString pattern = wildcardPattern;
+
+    // remove multiple wildcards
+    pattern.replace(QRegExp(QL1S("\\*+")), QL1S("*"));
+
+    // remove anchors following separator placeholder
+    pattern.replace(QRegExp(QL1S("\\^\\|$")), QL1S("^"));
+
+    // remove leading wildcards
+    pattern.replace(QRegExp(QL1S("^(\\*)")), QL1S(""));
+
+    // remove trailing wildcards
+    pattern.replace(QRegExp(QL1S("(\\*)$")), QL1S(""));
+
+    // escape special symbols
+    pattern.replace(QRegExp(QL1S("(\\W)")), QL1S("\\\\1"));
+
+    // process extended anchor at expression start
+    pattern.replace(QRegExp(QL1S("^\\\\\\|\\\\\\|")), QL1S("^[\\w\\-]+:\\/+(?!\\/)(?:[^\\/]+\\.)?"));
+
+    // process separator placeholders
+    pattern.replace(QRegExp(QL1S("\\\\\\^")), QL1S("(?:[^\\w\\d\\-.%]|$)"));
+
+    // process anchor at expression start
+    pattern.replace(QRegExp(QL1S("^\\\\\\|")), QL1S("^"));
+
+    // process anchor at expression end
+    pattern.replace(QRegExp(QL1S("\\\\\\|$")), QL1S("$"));
+
+    // replace wildcards by .*
+    pattern.replace(QRegExp(QL1S("\\\\\\*")), QL1S(".*"));
+
+    // Finally, return...
+    return pattern;
+}
diff --git a/src/adblock/adblockrulefallbackimpl.h b/src/adblock/adblockrulefallbackimpl.h
new file mode 100644
index 00000000..4e7ca555
--- /dev/null
+++ b/src/adblock/adblockrulefallbackimpl.h
@@ -0,0 +1,47 @@
+/* ============================================================
+*
+* This file is a part of the rekonq project
+*
+* Copyright (C) 2010 by Benjamin Poulain <ikipou at gmail dot 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 2 of
+* the License or (at your option) version 3 or any later version
+* accepted by the membership of KDE e.V. (or its successor approved
+* by the membership of KDE e.V.), which shall act as a proxy
+* defined in Section 14 of version 3 of the license.
+*
+* 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 ADBLOCKRULEFALLBACKIMPL_H
+#define ADBLOCKRULEFALLBACKIMPL_H
+
+#include "adblockruleimpl.h"
+
+// Qt Includes
+#include <QRegExp>
+#include <QString>
+
+class AdBlockRuleFallbackImpl : public AdBlockRuleImpl
+{
+public:
+    AdBlockRuleFallbackImpl(const QString &filter);
+    bool match(const QString &encodedUrl) const;
+
+private:
+    QString convertPatternToRegExp(const QString &wildcardPattern);
+
+    QRegExp m_regExp;
+};
+
+#endif // ADBLOCKRULEFALLBACKIMPL_H
diff --git a/src/adblock/adblockruleimpl.h b/src/adblock/adblockruleimpl.h
new file mode 100644
index 00000000..da367aeb
--- /dev/null
+++ b/src/adblock/adblockruleimpl.h
@@ -0,0 +1,39 @@
+/* ============================================================
+*
+* This file is a part of the rekonq project
+*
+* Copyright (C) 2010 by Benjamin Poulain <ikipou at gmail dot 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 2 of
+* the License or (at your option) version 3 or any later version
+* accepted by the membership of KDE e.V. (or its successor approved
+* by the membership of KDE e.V.), which shall act as a proxy
+* defined in Section 14 of version 3 of the license.
+*
+* 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 ADBLOCKRULEIMPL_H
+#define ADBLOCKRULEIMPL_H
+
+class QString;
+
+class AdBlockRuleImpl
+{
+public:
+    AdBlockRuleImpl(const QString &) {}
+    virtual ~AdBlockRuleImpl() {}
+    virtual bool match(const QString &encodedUrl) const = 0;
+};
+
+#endif // ADBLOCKRULEIMPL_H