Net::DNSUpdater Class Reference

#include <dnsupdater.h>

Inheritance diagram for Net::DNSUpdater:

Collaboration diagram for Net::DNSUpdater:

Public Slots
void	updateCredentials ()

Public Member Functions
	DNSUpdater (QObject *parent=nullptr)
	~DNSUpdater ()

Static Public Member Functions
static QUrl	getRegistrationUrl (DNS::Service service)

Private Types
enum	State { OK , INVALID_CREDS , FATAL }

Private Slots
void	checkPublicIP ()
void	ipRequestFinished (const DownloadResult &result)
void	updateDNSService ()
void	ipUpdateFinished (const DownloadResult &result)

Private Member Functions
QString	getUpdateUrl () const
void	processIPUpdateReply (const QString &reply)

Private Attributes
QHostAddress	m_lastIP
QDateTime	m_lastIPCheckTime
QTimer	m_ipCheckTimer
int	m_state
DNS::Service	m_service
QString	m_domain
QString	m_username
QString	m_password

Static Private Attributes
static const int	IP_CHECK_INTERVAL_MS = 1800000

Detailed Description

Definition at line 43 of file dnsupdater.h.

Member Enumeration Documentation

State

enum Net::DNSUpdater::State

private

Enumerator
OK
INVALID_CREDS
FATAL

Definition at line 63 of file dnsupdater.h.

        {
            OK,
            INVALID_CREDS,
            FATAL
        };

Constructor & Destructor Documentation

DNSUpdater()

DNSUpdater::DNSUpdater ( QObject *  parent = nullptr )

explicit

Definition at line 41 of file dnsupdater.cpp.

    : QObject(parent)
    , m_state(OK)
    , m_service(DNS::Service::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, &QTimer::timeout, this, &DNSUpdater::checkPublicIP);
    m_ipCheckTimer.start();
 
    // Check lastUpdate to avoid flooding
    if (!m_lastIPCheckTime.isValid()
        || (m_lastIPCheckTime.secsTo(QDateTime::currentDateTime()) * 1000 > IP_CHECK_INTERVAL_MS))
        {
        checkPublicIP();
    }
}

References checkPublicIP(), Preferences::getDNSLastIP(), Preferences::getDNSLastUpd(), Preferences::instance(), IP_CHECK_INTERVAL_MS, m_ipCheckTimer, m_lastIP, m_lastIPCheckTime, and updateCredentials().

Here is the call graph for this function:

~DNSUpdater()

DNSUpdater::~DNSUpdater

(

)

Definition at line 66 of file dnsupdater.cpp.

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

References Preferences::instance(), m_lastIP, m_lastIPCheckTime, Preferences::setDNSLastIP(), and Preferences::setDNSLastUpd().

Here is the call graph for this function:

Member Function Documentation

checkPublicIP

void DNSUpdater::checkPublicIP ( )

privateslot

Definition at line 74 of file dnsupdater.cpp.

{
    Q_ASSERT(m_state == OK);
 
    DownloadManager::instance()->download(
                DownloadRequest("http://checkip.dyndns.org").userAgent("qBittorrent/" QBT_VERSION_2)
                , this, &DNSUpdater::ipRequestFinished);
 
    m_lastIPCheckTime = QDateTime::currentDateTime();
}

References Net::DownloadManager::download(), Net::DownloadManager::instance(), ipRequestFinished(), m_lastIPCheckTime, m_state, and OK.

Referenced by DNSUpdater(), and updateCredentials().

Here is the call graph for this function:

Here is the caller graph for this function:

getRegistrationUrl()

QUrl DNSUpdater::getRegistrationUrl ( DNS::Service  service )

static

Definition at line 299 of file dnsupdater.cpp.

{
    switch (service)
    {
    case DNS::Service::DynDNS:
        return {"https://account.dyn.com/entrance/"};
    case DNS::Service::NoIP:
        return {"https://www.noip.com/remote-access"};
    default:
        Q_ASSERT(false);
        break;
    }
    return {};
}

References DNS::DynDNS, and DNS::NoIP.

Referenced by OptionsDialog::on_registerDNSBtn_clicked().

Here is the caller graph for this function:

getUpdateUrl()

QString DNSUpdater::getUpdateUrl ( ) const

private

Definition at line 131 of file dnsupdater.cpp.

{
    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::Service::DynDNS:
        url.setHost("members.dyndns.org");
        break;
    case DNS::Service::NoIP:
        url.setHost("dynupdate.no-ip.com");
        break;
    default:
        qWarning() << "Unrecognized Dynamic DNS service!";
        Q_ASSERT(false);
        break;
    }
    url.setPath("/nic/update");
 
    QUrlQuery urlQuery(url);
    urlQuery.addQueryItem("hostname", m_domain);
    urlQuery.addQueryItem("myip", m_lastIP.toString());
    url.setQuery(urlQuery);
    Q_ASSERT(url.isValid());
 
    qDebug() << Q_FUNC_INFO << url.toString();
    return url.toString();
}

References DNS::DynDNS, m_domain, m_lastIP, m_password, m_service, m_username, and DNS::NoIP.

Referenced by updateDNSService().

Here is the caller graph for this function:

ipRequestFinished

void DNSUpdater::ipRequestFinished ( const DownloadResult &  result )

privateslot

Definition at line 85 of file dnsupdater.cpp.

{
    if (result.status != DownloadStatus::Success)
    {
        qWarning() << "IP request failed:" << result.errorString;
        return;
    }
 
    // Parse response
    const QRegularExpressionMatch ipRegexMatch = QRegularExpression("Current IP Address:\\s+([^<]+)</body>").match(result.data);
    if (ipRegexMatch.hasMatch())
    {
        QString ipStr = ipRegexMatch.captured(1);
        qDebug() << Q_FUNC_INFO << "Regular expression captured the following IP:" << ipStr;
        QHostAddress newIp(ipStr);
        if (!newIp.isNull())
        {
            if (m_lastIP != newIp)
            {
                qDebug() << Q_FUNC_INFO << "The IP address changed, report the change to DynDNS...";
                qDebug() << m_lastIP.toString() << "->" << newIp.toString();
                m_lastIP = newIp;
                updateDNSService();
            }
        }
        else
        {
            qWarning() << Q_FUNC_INFO << "Failed to construct a QHostAddress from the IP string";
        }
    }
    else
    {
        qWarning() << Q_FUNC_INFO << "Regular expression failed to capture the IP address";
    }
}

References Net::DownloadResult::data, Net::DownloadResult::errorString, m_lastIP, Net::DownloadResult::status, Net::Success, and updateDNSService().

Referenced by checkPublicIP().

Here is the call graph for this function:

Here is the caller graph for this function:

ipUpdateFinished

void DNSUpdater::ipUpdateFinished ( const DownloadResult &  result )

privateslot

Definition at line 169 of file dnsupdater.cpp.

{
    if (result.status == DownloadStatus::Success)
        processIPUpdateReply(result.data);
    else
        qWarning() << "IP update failed:" << result.errorString;
}

References Net::DownloadResult::data, Net::DownloadResult::errorString, processIPUpdateReply(), Net::DownloadResult::status, and Net::Success.

Referenced by updateDNSService().

Here is the call graph for this function:

Here is the caller graph for this function:

processIPUpdateReply()

void DNSUpdater::processIPUpdateReply ( const QString &  reply )

private

Definition at line 177 of file dnsupdater.cpp.

{
    Logger *const logger = Logger::instance();
    qDebug() << Q_FUNC_INFO << reply;
    const 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 below 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 submit a bug report 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 submit a bug report 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;
    }
}

References Logger::addMessage(), Log::CRITICAL, FATAL, Log::INFO, Logger::instance(), INVALID_CREDS, m_ipCheckTimer, m_lastIP, and m_state.

Referenced by ipUpdateFinished().

Here is the call graph for this function:

Here is the caller graph for this function:

updateCredentials

void DNSUpdater::updateCredentials ( )

slot

Definition at line 238 of file dnsupdater.cpp.

{
    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();
        const QRegularExpressionMatch domainRegexMatch = QRegularExpression("^(?:(?!\\d|-)[a-zA-Z0-9\\-]{1,63}\\.)+[a-zA-Z]{2,}$").match(m_domain);
        if (!domainRegexMatch.hasMatch())
        {
            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();
    }
}

References Logger::addMessage(), checkPublicIP(), Log::CRITICAL, FATAL, Preferences::getDynDNSPassword(), Preferences::getDynDNSService(), Preferences::getDynDNSUsername(), Preferences::getDynDomainName(), Logger::instance(), Preferences::instance(), INVALID_CREDS, m_domain, m_ipCheckTimer, m_lastIP, m_password, m_service, m_state, m_username, and OK.

Referenced by DNSUpdater().

Here is the call graph for this function:

Here is the caller graph for this function:

updateDNSService

void DNSUpdater::updateDNSService ( )

privateslot

Definition at line 121 of file dnsupdater.cpp.

{
    qDebug() << Q_FUNC_INFO;
 
    m_lastIPCheckTime = QDateTime::currentDateTime();
    DownloadManager::instance()->download(
                DownloadRequest(getUpdateUrl()).userAgent("qBittorrent/" QBT_VERSION_2)
                , this, &DNSUpdater::ipUpdateFinished);
}

References Net::DownloadManager::download(), getUpdateUrl(), Net::DownloadManager::instance(), ipUpdateFinished(), and m_lastIPCheckTime.

Referenced by ipRequestFinished().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

IP_CHECK_INTERVAL_MS

const int Net::DNSUpdater::IP_CHECK_INTERVAL_MS = 1800000

staticprivate

Definition at line 70 of file dnsupdater.h.

Referenced by DNSUpdater().

m_domain

QString Net::DNSUpdater::m_domain

private

Definition at line 81 of file dnsupdater.h.

Referenced by getUpdateUrl(), and updateCredentials().

m_ipCheckTimer

QTimer Net::DNSUpdater::m_ipCheckTimer

private

Definition at line 77 of file dnsupdater.h.

Referenced by DNSUpdater(), processIPUpdateReply(), and updateCredentials().

m_lastIP

QHostAddress Net::DNSUpdater::m_lastIP

private

Definition at line 75 of file dnsupdater.h.

Referenced by DNSUpdater(), getUpdateUrl(), ipRequestFinished(), processIPUpdateReply(), updateCredentials(), and ~DNSUpdater().

m_lastIPCheckTime

QDateTime Net::DNSUpdater::m_lastIPCheckTime

private

Definition at line 76 of file dnsupdater.h.

Referenced by checkPublicIP(), DNSUpdater(), updateDNSService(), and ~DNSUpdater().

m_password

QString Net::DNSUpdater::m_password

private

Definition at line 83 of file dnsupdater.h.

Referenced by getUpdateUrl(), and updateCredentials().

m_service

DNS::Service Net::DNSUpdater::m_service

private

Definition at line 80 of file dnsupdater.h.

Referenced by getUpdateUrl(), and updateCredentials().

m_state

int Net::DNSUpdater::m_state

private

Definition at line 78 of file dnsupdater.h.

Referenced by checkPublicIP(), processIPUpdateReply(), and updateCredentials().

m_username

QString Net::DNSUpdater::m_username

private

Definition at line 82 of file dnsupdater.h.

Referenced by getUpdateUrl(), and updateCredentials().

---

The documentation for this class was generated from the following files:

• src/base/net/dnsupdater.h
• src/base/net/dnsupdater.cpp