qBittorrent/src/core/dnsupdater.cpp

/*
 * Bittorrent Client using Qt4 and libtorrent.
 * Copyright (C) 2011  Christophe Dumez
 *
 * 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) 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * In addition, as a special exception, the copyright holders give permission to
 * link this program with the OpenSSL project's "OpenSSL" library (or with
 * modified versions of it that use the same license as the "OpenSSL" library),
 * and distribute the linked executables. You must obey the GNU General Public
 * License in all respects for all of the code used other than "OpenSSL".  If you
 * modify file(s), you may extend this exception to your version of the file(s),
 * but you are not obligated to do so. If you do not wish to do so, delete this
 * exception statement from your version.
 *
 * Contact : chris@qbittorrent.org
 */

#include <QNetworkAccessManager>
#include <QDebug>
#include <QRegExp>
#include <QStringList>
#if (QT_VERSION >= QT_VERSION_CHECK(5, 0, 0))
#include <QUrlQuery>
#endif
#include "dnsupdater.h"
#include "logger.h"

DNSUpdater::DNSUpdater(QObject *parent) :
  QObject(parent), m_state(OK), m_service(DNS::NONE)
{
  updateCredentials();

  // Load saved settings from previous session
  const Preferences* const pref = Preferences::instance();
  m_lastIPCheckTime = pref->getDNSLastUpd();
  m_lastIP = QHostAddress(pref->getDNSLastIP());

  // Start IP checking timer
  m_ipCheckTimer.setInterval(IP_CHECK_INTERVAL_MS);
  connect(&m_ipCheckTimer, SIGNAL(timeout()), SLOT(checkPublicIP()));
  m_ipCheckTimer.start();

  // Check lastUpdate to avoid flooding
  if (!m_lastIPCheckTime.isValid() ||
      m_lastIPCheckTime.secsTo(QDateTime::currentDateTime())*1000 > IP_CHECK_INTERVAL_MS) {
    checkPublicIP();
  }
}

DNSUpdater::~DNSUpdater() {
  // Save lastupdate time and last ip
  Preferences* const pref = Preferences::instance();
  pref->setDNSLastUpd(m_lastIPCheckTime);
  pref->setDNSLastIP(m_lastIP.toString());
}

void DNSUpdater::checkPublicIP()
{
  Q_ASSERT(m_state == OK);
  QNetworkAccessManager *manager = new QNetworkAccessManager(this);
  connect(manager, SIGNAL(finished(QNetworkReply*)),
          SLOT(ipRequestFinished(QNetworkReply*)));
  m_lastIPCheckTime = QDateTime::currentDateTime();
  QNetworkRequest request;
  request.setUrl(QUrl("http://checkip.dyndns.org"));
  request.setRawHeader("User-Agent", "qBittorrent/" VERSION" chris@qbittorrent.org");
  manager->get(request);
}

void DNSUpdater::ipRequestFinished(QNetworkReply *reply)
{
  qDebug() << Q_FUNC_INFO;
  if (reply->error()) {
    // Error
    qWarning() << Q_FUNC_INFO << "Error:" << reply->errorString();
  } else {
    // Parse response
    QRegExp ipregex("Current IP Address:\\s+([^<]+)</body>");
    QString ret = reply->readAll();
    if (ipregex.indexIn(ret) >= 0) {
      QString ip_str = ipregex.cap(1);
      qDebug() << Q_FUNC_INFO << "Regular expression captured the following IP:" << ip_str;
      QHostAddress new_ip(ip_str);
      if (!new_ip.isNull()) {
        if (m_lastIP != new_ip) {
          qDebug() << Q_FUNC_INFO << "The IP address changed, report the change to DynDNS...";
          qDebug() << m_lastIP.toString() << "->" << new_ip.toString();
          m_lastIP = new_ip;
          updateDNSService();
        }
      } else {
        qWarning() << Q_FUNC_INFO << "Failed to construct a QHostAddress from the IP string";
      }
    } else {
      qWarning() << Q_FUNC_INFO << "Regular expression failed ot capture the IP address";
    }
  }
  // Clean up
  reply->deleteLater();
  sender()->deleteLater();
}

void DNSUpdater::updateDNSService()
{
  qDebug() << Q_FUNC_INFO;
  // Prepare request
  QNetworkAccessManager *manager = new QNetworkAccessManager(this);
  connect(manager, SIGNAL(finished(QNetworkReply*)),
          SLOT(ipUpdateFinished(QNetworkReply*)));
  m_lastIPCheckTime = QDateTime::currentDateTime();
  QNetworkRequest request;
  request.setUrl(getUpdateUrl());
  request.setRawHeader("User-Agent", "qBittorrent/" VERSION" chris@qbittorrent.org");
  manager->get(request);
}

QUrl DNSUpdater::getUpdateUrl() const
{
  QUrl url;
#ifdef QT_NO_OPENSSL
  url.setScheme("http");
#else
  url.setScheme("https");
#endif
  url.setUserName(m_username);
  url.setPassword(m_password);

  Q_ASSERT(!m_lastIP.isNull());
  // Service specific
  switch(m_service) {
  case DNS::DYNDNS:
    url.setHost("members.dyndns.org");
    break;
  case DNS::NOIP:
    url.setHost("dynupdate.no-ip.com");
    break;
  default:
    qWarning() << "Unrecognized Dynamic DNS service!";
    Q_ASSERT(0);
  }
  url.setPath("/nic/update");

#if (QT_VERSION < QT_VERSION_CHECK(5, 0, 0))
  url.addQueryItem("hostname", m_domain);
  url.addQueryItem("myip", m_lastIP.toString());
#else
  QUrlQuery urlQuery(url);
  urlQuery.addQueryItem("hostname", m_domain);
  urlQuery.addQueryItem("myip", m_lastIP.toString());
  url.setQuery(urlQuery);
#endif
  Q_ASSERT(url.isValid());

  qDebug() << Q_FUNC_INFO << url.toString();
  return url;
}

void DNSUpdater::ipUpdateFinished(QNetworkReply *reply)
{
  if (reply->error()) {
    // Error
    qWarning() << Q_FUNC_INFO << "Error:" << reply->errorString();
  } else {
    // Pase reply
    processIPUpdateReply(reply->readAll());
  }
  // Clean up
  reply->deleteLater();
  sender()->deleteLater();
}

void DNSUpdater::processIPUpdateReply(const QString &reply)
{
  Logger* const logger = Logger::instance();
  qDebug() << Q_FUNC_INFO << reply;
  QString code = reply.split(" ").first();
  qDebug() << Q_FUNC_INFO << "Code:" << code;
  if (code == "good" || code == "nochg") {
    logger->addMessage(tr("Your dynamic DNS was successfully updated."), Log::INFO);
    return;
  }
  if (code == "911" || code == "dnserr") {
    logger->addMessage(tr("Dynamic DNS error: The service is temporarily unavailable, it will be retried in 30 minutes."), Log::CRITICAL);
    m_lastIP.clear();
    // It will retry in 30 minutes because the timer was not stopped
    return;
  }
  // Everything bellow is an error, stop updating until the user updates something
  m_ipCheckTimer.stop();
  m_lastIP.clear();
  if (code == "nohost") {
    logger->addMessage(tr("Dynamic DNS error: hostname supplied does not exist under specified account."), Log::CRITICAL);
    m_state = INVALID_CREDS;
    return;
  }
  if (code == "badauth") {
    logger->addMessage(tr("Dynamic DNS error: Invalid username/password."), Log::CRITICAL);
    m_state = INVALID_CREDS;
    return;
  }
  if (code == "badagent") {
    logger->addMessage(tr("Dynamic DNS error: qBittorrent was blacklisted by the service, please report a bug at http://bugs.qbittorrent.org."),
                       Log::CRITICAL);
    m_state = FATAL;
    return;
  }
  if (code == "!donator") {
    logger->addMessage(tr("Dynamic DNS error: %1 was returned by the service, please report a bug at http://bugs.qbittorrent.org.").arg("!donator"),
                       Log::CRITICAL);
    m_state = FATAL;
    return;
  }
  if (code == "abuse") {
    logger->addMessage(tr("Dynamic DNS error: Your username was blocked due to abuse."), Log::CRITICAL);
    m_state = FATAL;
    return;
  }
}

void DNSUpdater::updateCredentials()
{
  if (m_state == FATAL) return;
  Preferences* const pref = Preferences::instance();
  Logger* const logger = Logger::instance();
  bool change = false;
  // Get DNS service information
  if (m_service != pref->getDynDNSService()) {
    m_service = pref->getDynDNSService();
    change = true;
  }
  if (m_domain != pref->getDynDomainName()) {
    m_domain = pref->getDynDomainName();
    QRegExp domain_regex("^(?:(?!\\d|-)[a-zA-Z0-9\\-]{1,63}\\.)+[a-zA-Z]{2,}$");
    if (domain_regex.indexIn(m_domain) < 0) {
      logger->addMessage(tr("Dynamic DNS error: supplied domain name is invalid."), Log::CRITICAL);
      m_lastIP.clear();
      m_ipCheckTimer.stop();
      m_state = INVALID_CREDS;
      return;
    }
    change = true;
  }
  if (m_username != pref->getDynDNSUsername()) {
    m_username = pref->getDynDNSUsername();
    if (m_username.length() < 4) {
      logger->addMessage(tr("Dynamic DNS error: supplied username is too short."), Log::CRITICAL);
      m_lastIP.clear();
      m_ipCheckTimer.stop();
      m_state = INVALID_CREDS;
      return;
    }
    change = true;
  }
  if (m_password != pref->getDynDNSPassword()) {
    m_password = pref->getDynDNSPassword();
    if (m_password.length() < 4) {
      logger->addMessage(tr("Dynamic DNS error: supplied password is too short."), Log::CRITICAL);
      m_lastIP.clear();
      m_ipCheckTimer.stop();
      m_state = INVALID_CREDS;
      return;
    }
    change = true;
  }

  if (m_state == INVALID_CREDS && change) {
    m_state = OK; // Try again
    m_ipCheckTimer.start();
    checkPublicIP();
  }
}

QUrl DNSUpdater::getRegistrationUrl(int service)
{
  switch(service) {
  case DNS::DYNDNS:
    return QUrl("https://www.dyndns.com/account/services/hosts/add.html");
  case DNS::NOIP:
    return QUrl("http://www.no-ip.com/services/managed_dns/free_dynamic_dns.html");
  default:
    Q_ASSERT(0);
  }
  return QUrl();
}