rssguard/src/network-web/adblock/adblockicon.cpp

// This file is part of RSS Guard.
//
// Copyright (C) 2014-2015 by Martin Rotter <rotter.martinos@gmail.com>
// Copyright (C) 2010-2014 by David Rosca <nowrep@gmail.com>
//
// RSS Guard 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.
//
// RSS Guard 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 RSS Guard. If not, see <http://www.gnu.org/licenses/>.

#include "network-web/adblock/adblockicon.h"

#include "network-web/adblock/adblockrule.h"
#include "network-web/adblock/adblockmanager.h"
#include "network-web/adblock/adblocksubscription.h"
#include "network-web/webpage.h"
#include "network-web/webbrowser.h"
#include "miscellaneous/application.h"
#include "gui/plaintoolbutton.h"
#include "gui/formmain.h"
#include "gui/tabwidget.h"

#include <QMenu>
#include <QMouseEvent>
#include <QTimer>
#include <QWebFrame>


AdBlockIcon::AdBlockIcon(QWidget *window, QWidget *parent)
  : PlainToolButton(parent), m_window(window), m_menuAction(NULL), m_flashTimer(NULL), m_timerTicks(NULL), m_enabled(false) {
  connect(this, SIGNAL(clicked(QPoint)), this, SLOT(showMenu(QPoint)));
  connect(AdBlockManager::instance(), SIGNAL(enabledChanged(bool)), this, SLOT(setEnabled(bool)));
}

void AdBlockIcon::popupBlocked(const QString &rule_string, const QUrl &url) {
  int index = rule_string.lastIndexOf(QLatin1String(" ("));
  const QString subscription_ame = rule_string.left(index);
  const QString filter = rule_string.mid(index + 2, rule_string.size() - index - 3);
  AdBlockSubscription* subscription = AdBlockManager::instance()->subscriptionByName(subscription_ame);

  if (filter.isEmpty() || !subscription) {
    return;
  }

  QPair<AdBlockRule*,QUrl> pair;
  pair.first = new AdBlockRule(filter, subscription);
  pair.second = url;
  m_blockedPopups.append(pair);

  //!** FIXME
  //    mApp->desktopNotifications()->showNotification(QPixmap(":images/images/adblock_big.png"), tr("Blocked popup window"), tr("AdBlock blocked unwanted popup window."));

  if (m_flashTimer == NULL) {
    m_flashTimer = new QTimer(this);
  }

  if (m_flashTimer->isActive()) {
    stopAnimation();
  }

  m_flashTimer->setInterval(500);
  m_flashTimer->start();

  connect(m_flashTimer, SIGNAL(timeout()), this, SLOT(animateIcon()));
}

QAction *AdBlockIcon::menuAction() {
  if (m_menuAction == NULL) {
    m_menuAction = new QAction(tr("Adblock"), this);
    m_menuAction->setMenu(new QMenu(this));

    connect(m_menuAction->menu(), SIGNAL(aboutToShow()), this, SLOT(createMenu()));
  }

  m_menuAction->setIcon(m_enabled ? qApp->icons()->fromTheme("web-adblock") : qApp->icons()->fromTheme("web-adblock"));

  return m_menuAction;
}

void AdBlockIcon::activate() {
  setEnabled(AdBlockManager::instance()->shouldBeEnabled());
}

void AdBlockIcon::createMenu(QMenu *menu) {
  if (menu == NULL) {
    menu = qobject_cast<QMenu*>(sender());

    if (menu == NULL) {
      return;
    }
  }

  menu->clear();

  AdBlockManager *manager = AdBlockManager::instance();
  AdBlockCustomList *custom_list = manager->customList();

  WebPage* page = qApp->mainForm()->tabWidget()->currentWidget()->webBrowser()->view()->page();
  const QUrl page_url = page->mainFrame()->url();

  menu->addAction(tr("Show Adblock &settings"), manager, SLOT(showDialog()));
  menu->addSeparator();

  if (!page_url.host().isEmpty() && m_enabled && manager->canRunOnScheme(page_url.scheme())) {
    const QString host = page_url.host().contains(QLatin1String("www.")) ? page_url.host().mid(4) : page_url.host();
    const QString host_filter = QString("@@||%1^$document").arg(host);
    const QString page_filter = QString("@@|%1|$document").arg(page_url.toString());

    QAction *act;

    act = menu->addAction(tr("Disable on %1").arg(host));
    act->setCheckable(true);
    act->setChecked(custom_list->containsFilter(host_filter));
    act->setData(host_filter);
    connect(act, SIGNAL(triggered()), this, SLOT(toggleCustomFilter()));

    act = menu->addAction(tr("Disable only on this page"));
    act->setCheckable(true);
    act->setChecked(custom_list->containsFilter(page_filter));
    act->setData(page_filter);
    connect(act, SIGNAL(triggered()), this, SLOT(toggleCustomFilter()));

    menu->addSeparator();
  }

  if (!m_blockedPopups.isEmpty()) {
    menu->addAction(tr("Blocked popup windows"))->setEnabled(false);

    for (int i = 0; i < m_blockedPopups.count(); i++) {
      const QPair<AdBlockRule*,QUrl> &pair = m_blockedPopups.at(i);

      QString address = pair.second.toString().right(55);
      QString actionText = tr("%1 with (%2)").arg(address,
                                                  pair.first->filter()).replace(QLatin1Char('&'), QLatin1String("&&"));

      QAction *action = menu->addAction(actionText, manager, SLOT(showRule()));
      action->setData(QVariant::fromValue((void*)pair.first));
    }
  }

  menu->addSeparator();

  QVector<WebPage::AdBlockedEntry> entries = page->adBlockedEntries();

  if (entries.isEmpty()) {
    menu->addAction(tr("No content blocked"))->setEnabled(false);
  }
  else {
    menu->addAction(tr("Blocked some content - click to edit rule"))->setEnabled(false);

    foreach (const WebPage::AdBlockedEntry &entry, entries) {
      QString address = entry.url.toString().right(55);
      QString action_text = tr("%1 with (%2)").arg(address,
                                                   entry.rule->filter()).replace(QLatin1Char('&'), QLatin1String("&&"));

      QAction *action = menu->addAction(action_text, manager, SLOT(showRule()));
      action->setData(QVariant::fromValue((void*)entry.rule));
    }
  }
}

void AdBlockIcon::showMenu(const QPoint &pos) {
  QMenu menu;
  createMenu(&menu);
  menu.exec(pos);
}

void AdBlockIcon::toggleCustomFilter() {
  QAction *action = qobject_cast<QAction*>(sender());

  if (action == NULL) {
    return;
  }

  const QString filter = action->data().toString();
  AdBlockManager* manager = AdBlockManager::instance();
  AdBlockCustomList* custom_list = manager->customList();

  if (custom_list->containsFilter(filter)) {
    custom_list->removeFilter(filter);
  }
  else {
    AdBlockRule *rule = new AdBlockRule(filter, custom_list);
    custom_list->addRule(rule);
  }
}

void AdBlockIcon::animateIcon() {
  m_timerTicks++;

  if (m_timerTicks > 10) {
    stopAnimation();
    return;
  }

  if (icon().isNull()) {
    setIcon(qApp->icons()->fromTheme("web-adblock"));
  }
  else {
    setIcon(QIcon());
  }
}

void AdBlockIcon::stopAnimation() {
  m_timerTicks = 0;
  m_flashTimer->stop();

  disconnect(m_flashTimer, SIGNAL(timeout()), this, SLOT(animateIcon()));
  setEnabled(m_enabled);
}

void AdBlockIcon::setEnabled(bool enabled) {
  if (enabled) {
    setToolTip(tr("Adblock - up and running"));
    setIcon(qApp->icons()->fromTheme("web-adblock"));
  }
  else {
    setToolTip(tr("Adblock - not running"));
    setIcon(qApp->icons()->fromTheme("web-adblock-disabled"));
  }

  m_enabled = enabled;
}

void AdBlockIcon::mouseReleaseEvent(QMouseEvent *event) {
  if (event->button() == Qt::LeftButton) {
      emit clicked(event->globalPos());
  }
  else {
    QToolButton::mouseReleaseEvent(event);
  }
}

AdBlockIcon::~AdBlockIcon() {
  qDebug("Destroying AdBlockIcon instance.");
}