masterclient.h

//------------------------------------------------------------------------------
// masterclient.h
//------------------------------------------------------------------------------
//
// 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 Braden "Blzut3" Obrzut <admin@maniacsvault.net>
//------------------------------------------------------------------------------

#ifndef __MASTERSERVER_H__
#define __MASTERSERVER_H__

#include <QHostAddress>
#include <QList>
#include <QObject>

#include "dptr.h"
#include "global.h"
#include "polymorphism.h"
#include "serverapi/serverptr.h"

class Message;
class EnginePlugin;
class Server;
class QFile;
class QUdpSocket;

class MAIN_EXPORT MasterClient : public QObject
{
        Q_OBJECT

public:
        enum Response
        {
                RESPONSE_GOOD, // Data is available
                RESPONSE_TIMEOUT, // Server didn't respond at all
                RESPONSE_WAIT, // Server responded with "wait"
                RESPONSE_BAD, // Probably refreshing too quickly
                RESPONSE_BANNED, // Won't receive data from this server ever.
                RESPONSE_NO_RESPONSE_YET, // "Dummy" response for servers that weren't refreshed yet
                RESPONSE_PENDING, // Waiting for additional packets
                RESPONSE_REPLY, // Ask the refresher to call createSendRequest again
                RESPONSE_OLD, // Client too old.
        };

        MasterClient();
        virtual ~MasterClient() override;

        void clearServers();

        QString engineName() const;

        bool isAddressSame(const QHostAddress &address, unsigned short port) const;

        bool isEnabled() const;
        bool isTimeouted() const;

        QString masterBanHelp() const;

        void notifyResponse(Response response);
        int numServers() const;
        ServerPtr operator[] (int index) const;

        virtual const EnginePlugin *plugin() const = 0;

        void pushPacketToCache(const QByteArray &data);
        void resetPacketCaching();

        Response readResponse(const QByteArray &data);

        bool sendRequest(QUdpSocket *socket);

        const QList<ServerPtr> &servers() const;

        void updateAddress();

public slots:
        virtual void refreshStarts();

        void setEnabled(bool b);

        void timeoutRefresh();

signals:
        void listUpdated();

        void message(const QString &title, const QString &content, bool isError);

        void messageImportant(const Message &message);

protected:
        QHostAddress address() const;

        virtual QByteArray createServerListRequest() = 0;

        void emptyServerList();

        POLYMORPHIC_SETTER_DECLARE_CONST(QString, MasterClient, masterBanHelp, ())
        QString masterBanHelp_default() const;

        unsigned short port() const;

        bool preparePacketCache(bool write);

        virtual Response readMasterResponse(const QByteArray &data) = 0;

        void readPacketCache();
        void registerNewServer(ServerPtr server);

        void setTimeouted(bool b);

        virtual void timeoutRefreshEx();

private:
        DPtr<MasterClient> d;

        void emitBannedMessage();
};

#endif /* __MASTERSERVER_H__ */