refresher.cpp

//------------------------------------------------------------------------------
// refresher.cpp
//------------------------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301  USA
//
//------------------------------------------------------------------------------
// Copyright (C) 2009 "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#include "refresher.h"

#include "configuration/doomseekerconfig.h"
#include "configuration/queryspeed.h"
#include "log.h"
#include "plugins/pluginloader.h"
#include "refresher/canrefreshserver.h"
#include "refresher/udpsocketpool.h"
#include "serverapi/masterclient.h"
#include "serverapi/mastermanager.h"
#include "serverapi/server.h"

#include <QElapsedTimer>
#include <QHash>
#include <QList>
#include <QMutex>
#include <QMutexLocker>
#if QT_VERSION >= 0x060000
#include <QRandomGenerator>
#endif
#include <QRunnable>
#include <QSet>
#include <QThread>
#include <QTimer>

class ServerRefreshTime
{
public:
        QWeakPointer<Server> server;
        QElapsedTimer time;

        ServerRefreshTime(ServerPtr server)
        {
                this->server = server;
                time.start();
        }

        bool operator==(const ServerRefreshTime &other) const
        {
                return server == other.server;
        }
};

class Refresher::Data
{
public:
        typedef QHash<MasterClient *, MasterClientInfo *> MasterHashtable;
        typedef QHash<MasterClient *, MasterClientInfo *>::iterator MasterHashtableIt;

        QTime batchTime;
        bool bSleeping;
        bool bKeepRunning;
        int delayBetweenResends;
        QTimer flushPendingDatagramsTimer;
        MasterHashtable registeredMasters;

        QList<QWeakPointer<Server> > unchallengedServers;
        QList<ServerRefreshTime> refreshingServers;
        UdpSocketPool socketPool;
        QSet<MasterClient *> unchallengedMasters;

        bool hasAnyServers() const
        {
                return !unchallengedServers.isEmpty() || !refreshingServers.isEmpty();
        }

        bool isServerRegistered(const ServerPtr &server) const
        {
                return unchallengedServers.contains(server) ||
                        refreshingServers.contains(ServerRefreshTime(server));
        }

        ServerPtr popNextUnchallengedServer()
        {
                while (!unchallengedServers.isEmpty())
                {
                        // Temporary fix #4083 to keep Qt 6 compiling
                        #if QT_VERSION >= 0x060000
                        #define qrand() QRandomGenerator::global()->generate()
                        #endif

                        // Take a random server so that they aren't favored by the order
                        // in which they were presented by the plugin.
                        quint32 index = static_cast<quint32>(qrand()) % unchallengedServers.size();
                        ServerPtr server = unchallengedServers.takeAt(index).toStrongRef();
                        if (!server.isNull())
                        {
                                return server;
                        }
                }
                return ServerPtr();
        }

        QUdpSocket *socket(const ServerPtr &server)
        {
                return socketPool.acquire(server->address(), server->port());
        }
};


class Refresher::MasterClientInfo
{
public:
        MasterClientInfo(Refresher *parent)
        {
                connect(&lastChallengeTimer, SIGNAL(timeout()),
                        parent, SLOT(attemptTimeoutMasters()));
                lastChallengeTimer.setSingleShot(true);
                lastChallengeTimer.setInterval(MASTER_SERVER_TIMEOUT_DELAY);
        }

        void fireLastChallengeSentTimer()
        {
                lastChallengeTimer.start();
        }

        bool isLastChallengeTimerActive() const
        {
                return lastChallengeTimer.isActive();
        }

private:
        QTimer lastChallengeTimer;
};


Refresher *Refresher::staticInstance = nullptr;
QMutex Refresher::instanceMutex;

Refresher::Refresher()
{
        d = new Data;
        d->bSleeping = true;
        d->bKeepRunning = true;
        d->delayBetweenResends = 1000;

        this->connect(&d->flushPendingDatagramsTimer, SIGNAL(timeout()), SLOT(readAllPendingDatagrams()));
        this->connect(&d->socketPool, SIGNAL(readyRead()), SLOT(readAllPendingDatagrams()));
        d->flushPendingDatagramsTimer.start(1000);
}

Refresher::~Refresher()
{
        delete d;
}

void Refresher::attemptTimeoutMasters()
{
        QList<MasterClient *> masters = d->registeredMasters.keys();
        for (MasterClient *master : masters)
        {
                MasterClientInfo *pMasterInfo = d->registeredMasters[master];
                if (!pMasterInfo->isLastChallengeTimerActive())
                {
                        master->timeoutRefresh();
                }
        }
}

void Refresher::concludeRefresh()
{
        d->bSleeping = true;
        d->socketPool.releaseAll();
        emit sleepingModeEnter();
}

Refresher *Refresher::instance()
{
        if (staticInstance == nullptr)
        {
                QMutexLocker locker(&instanceMutex);
                if (staticInstance == nullptr)
                {
                        staticInstance = new Refresher();
                }
        }
        return staticInstance;
}

bool Refresher::isInstantiated()
{
        return staticInstance != nullptr;
}

void Refresher::deinstantiate()
{
        QMutexLocker locker(&instanceMutex);
        if (isInstantiated())
        {
                delete staticInstance;
                staticInstance = nullptr;
        }
}

ServerPtr Refresher::findRefreshingServer(const QHostAddress &address,
        unsigned short port)
{
        for (auto it = d->refreshingServers.begin(); it != d->refreshingServers.end();)
        {
                ServerPtr server = it->server.toStrongRef();
                if (server.isNull())
                {
                        it = d->refreshingServers.erase(it);
                        continue;
                }
                if (server->address().toIPv4Address() == address.toIPv4Address() && server->port() == port)
                {
                        return server;
                }
                ++it;
        }
        return ServerPtr();
}

bool Refresher::isAnythingToRefresh() const
{
        return d->hasAnyServers() || !d->registeredMasters.isEmpty() || !d->unchallengedMasters.isEmpty();
}

void Refresher::masterFinishedRefreshing()
{
        auto pMaster = static_cast<MasterClient *>(sender());
        unregisterMaster(pMaster);

        QTimer::singleShot(0, this, [this]()
                {
                        if (!isAnythingToRefresh())
                        {
                                concludeRefresh();
                        }
                });

        emit finishedQueryingMaster(pMaster);
}

void Refresher::quit()
{
        d->bKeepRunning = false;
}

void Refresher::registerMaster(MasterClient *pMaster)
{
        if (!d->registeredMasters.contains(pMaster))
        {
                auto pMasterInfo = new MasterClientInfo(this);
                this->connect(pMaster, SIGNAL(listUpdated()), SLOT(masterFinishedRefreshing()));

                d->registeredMasters.insert(pMaster, pMasterInfo);
                d->unchallengedMasters.insert(pMaster);
                emit block();

                if (d->registeredMasters.size() == 1)
                {
                        if (d->bSleeping)
                        {
                                d->bSleeping = false;
                                emit sleepingModeExit();
                        }
                        QTimer::singleShot(20, this, SLOT(sendMasterQueries()));
                }
        }
}

bool Refresher::registerServer(ServerPtr server)
{
        bool hadAnyServers = d->hasAnyServers();
        if (!d->isServerRegistered(server))
        {
                CanRefreshServer refreshChecker(server.data());
                if (!refreshChecker.shouldRefresh())
                {
                        return false;
                }
                d->unchallengedServers.append(server);
                if (!server->isCustom() && !server->isLan())
                {
                        emit block();
                }

                server->refreshStarts();
                if (!hadAnyServers && d->hasAnyServers())
                {
                        if (d->bSleeping)
                        {
                                d->bSleeping = false;
                                emit sleepingModeExit();
                        }
                        QTimer::singleShot(20, this, SLOT(sendServerQueries()));
                }
        }
        return true;
}

void Refresher::readAllPendingDatagrams()
{
        while (d->socketPool.hasPendingDatagrams() && d->bKeepRunning)
        {
                readPendingDatagram();
        }
}

void Refresher::readPendingDatagram()
{
        QHostAddress address;
        quint16 port = 0;
        QByteArray dataArray = d->socketPool.readNextDatagram(&address, &port);

        if (tryReadDatagramByMasterClient(address, port, dataArray))
        {
                return;
        }
        tryReadDatagramByServer(address, port, dataArray);
}

void Refresher::sendMasterQueries()
{
        while (!d->unchallengedMasters.isEmpty())
        {
                MasterClient *pMaster = *d->unchallengedMasters.begin();

                MasterClientInfo *pMasterInfo = d->registeredMasters[pMaster];
                pMasterInfo->fireLastChallengeSentTimer();

                pMaster->refreshStarts();
                pMaster->sendRequest(d->socketPool.acquireMasterSocket());
                d->unchallengedMasters.remove(pMaster);
        }
}

void Refresher::sendServerQueries()
{
        if (!d->bKeepRunning)
        {
                return;
        }

        if (d->hasAnyServers())
        {
                startNewServerRefresh();
                resendCurrentServerRefreshesIfTimeout();
                // Call self. This will continue until there's nothing more
                // to refresh. Also make sure that there is at least some
                // delay between calls or Doomseeker will hog CPU.
                QTimer::singleShot(qMax(1, gConfig.doomseeker.querySpeed().intervalBetweenServers),
                        this, SLOT(sendServerQueries()));
        }
        else
        {
                if (!isAnythingToRefresh())
                {
                        concludeRefresh();
                }
        }
}

void Refresher::setDelayBetweenResends(int delay)
{
        d->delayBetweenResends = qMax(delay, 100);
}

bool Refresher::start()
{
        return d->socketPool.acquireMasterSocket() != nullptr;
}

void Refresher::startNewServerRefresh()
{
        // Copy the list as the original will be modified.
        // We don't want to confuse the foreach.
        ServerPtr server = d->popNextUnchallengedServer();
        if (!server.isNull())
        {
                if (server->sendRefreshQuery(d->socket(server)))
                {
                        d->refreshingServers.append(server);
                }
        }
}

void Refresher::resendCurrentServerRefreshesIfTimeout()
{
        for (auto it = d->refreshingServers.begin(); it != d->refreshingServers.end();)
        {
                ServerRefreshTime &refreshOp = *it;
                ServerPtr server = refreshOp.server.toStrongRef();
                if (server.isNull())
                {
                        it = d->refreshingServers.erase(it);
                        continue;
                }

                if (refreshOp.time.elapsed() > d->delayBetweenResends)
                {
                        if (server->sendRefreshQuery(d->socket(server)))
                        {
                                refreshOp.time.start();
                        }
                        else
                        {
                                it = d->refreshingServers.erase(it);
                                continue;
                        }
                }
                ++it;
        }
}

bool Refresher::tryReadDatagramByMasterClient(QHostAddress &address,
        unsigned short port, QByteArray &packet)
{
        for (MasterClient *pMaster : d->registeredMasters.keys())
        {
                if (!d->bKeepRunning)
                {
                        return true;
                }
                if (pMaster->isAddressSame(address, port))
                {
                        MasterClient::Response response = pMaster->readResponse(packet);
                        switch (response)
                        {
                        case MasterClient::RESPONSE_BANNED:
                        case MasterClient::RESPONSE_WAIT:
                        case MasterClient::RESPONSE_BAD:
                        case MasterClient::RESPONSE_OLD:
                                pMaster->notifyResponse(response);
                                unregisterMaster(pMaster);
                                return true;
                        case MasterClient::RESPONSE_REPLY:
                                pMaster->sendRequest(d->socketPool.acquireMasterSocket());
                                return true;
                        default:
                                return true;
                        }
                }
        }
        return false;
}

bool Refresher::tryReadDatagramByServer(const QHostAddress &address,
        unsigned short port, QByteArray &packet)
{
        if (!d->bKeepRunning)
        {
                return true;
        }
        ServerPtr server = findRefreshingServer(address, port);
        if (!server.isNull())
        {
                // Store the state of request read.
                int response = server->readRefreshQueryResponse(packet);
                switch (response)
                {
                case Server::RESPONSE_REPLY:
                        if (server->sendRefreshQuery(d->socket(server)))
                        {
                                // Reset timer
                                ServerRefreshTime refreshOp(server);
                                d->refreshingServers.removeAll(refreshOp);
                                d->refreshingServers.append(refreshOp);
                                break;
                        }
                        response = Server::RESPONSE_BAD;
                        [[gnu::fallthrough]];
                default:
                        d->refreshingServers.removeAll(ServerRefreshTime(server));
                        server->refreshStops(static_cast<Server::Response>(response));
                        return true;

                case Server::RESPONSE_PENDING:
                {
                        // Reset timer
                        ServerRefreshTime refreshOp(server);
                        d->refreshingServers.removeAll(refreshOp);
                        d->refreshingServers.append(refreshOp);
                        break;
                }
                }
        }
        return false;
}

void Refresher::unregisterMaster(MasterClient *pMaster)
{
        pMaster->disconnect(this);
        Data::MasterHashtableIt it = d->registeredMasters.find(pMaster);
        if (it != d->registeredMasters.end())
        {
                MasterClientInfo *pMasterInfo = it.value();
                delete pMasterInfo;
                d->registeredMasters.erase(it);
        }
}