• Doomseeker
• Wadseeker
• Download
• Tracker
• Mercurial
• Docs

src/core/serverapi/server.h

//------------------------------------------------------------------------------
// server.h
//------------------------------------------------------------------------------
//
// 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.
//
//------------------------------------------------------------------------------
// Copyright (C) 2009 "Blzut3" <admin@maniacsvault.net>
//------------------------------------------------------------------------------

#ifndef __SERVER_H__
#define __SERVER_H__

#include <QColor>
#include <QDir>
#include <QFileInfo>
#include <QList>
#include <QProcess>
#include <QObject>
#include <QHostAddress>
#include <QHostInfo>
#include <QString>
#include <QMetaType>
#include <QThread>
#include <QTime>
#include <QUdpSocket>

#include "serverapi/rconprotocol.h"
#include "serverapi/player.h"
#include "serverapi/serverstructs.h"
#include "global.h"

class Binaries;
class GameRunner;
class PlayersList;
class EnginePlugin;
class TooltipGenerator;
class QPixmap;

// Some ports support optional wads.
class MAIN_EXPORT PWad
{
        public:
                PWad(const QString &name, bool optional=false) : name(name), optional(optional) {}

                QString name;
                bool    optional;
};

class MAIN_EXPORT Server : 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 recieve data from this server ever.
                        RESPONSE_NO_RESPONSE_YET        // "Dummy" response for servers that weren't refreshed yet
                };

                Server(const QHostAddress &address, unsigned short port);
                virtual ~Server();

                virtual Binaries*                                               binaries() const;

                virtual QString         engineName() const;

                void lookupHost();

                const QHostAddress      &address() const { return serverAddress; }
                QString                         addressWithPort() const { return QString("%1:%2").arg(address().toString()).arg(port()); }
                const QString&          connectPassword() const { return passwordConnect; }
                const QString&          eMail() const { return email; }
                const DMFlags           &gameFlags() const { return dmFlags; }
                const GameMode          &gameMode() const { return currentGameMode; }
                unsigned char           gameSkill() const { return skill; }
                virtual bool            hasRcon() const { return false; }
                QString                         hostName(bool forceAddress=false) const;
                const QPixmap           &icon() const;
                bool                            isBroadcastingToLAN() const { return broadcastToLAN; }
                bool                            isBroadcastingToMaster() const { return broadcastToMaster; }
                bool                            isCustom() const { return custom; }
                bool                            isEmpty() const;
                bool                            isFull() const;
                bool                            isKnown() const { return bKnown; }
                bool                            isLocked() const { return locked; }
                bool                            isRefreshable() const;
                bool                            isSecured() const { return bSecureServer; }
                bool                            isSetToDelete() const { return bDelete; }
                const QString           &iwadName() const { return iwad; }
                const QString&          joinPassword() const { return passwordJoin; }
                int                                     lastResponse() const { return response; }
                const QString           &map() const { return mapName; }
                const QStringList&      mapsList() const { return mapList; }
                unsigned short          maximumClients() const { return maxPlayers > maxClients ? maxPlayers : maxClients; }
                unsigned short          maximumPlayers() const { return maxPlayers; }
                const QString&          messageOfTheDay() const { return motd; }
                virtual const GameCVar  *modifier() const { return NULL; }
                const QString           &name() const { return serverName; }
                int                                     numFreeClientSlots() const;
                int                                     numFreeJoinSlots() const;
                int                                     numFreeSpectatorSlots() const;
                int                                     numWads() const { return wads.size(); }
                unsigned int            ping() const { return currentPing; }
                const Player&           player(int index) const;
                const PlayersList*      playersList() const { return players; }
                unsigned short          port() const { return serverPort; }
                const QList<PWad>&      pwads() const { return wads; }
                bool                            randomMapRotation() const { return mapRandomRotation; }
                virtual RConProtocol    *rcon() { return NULL; }
                const QString&          rconPassword() const { return passwordRCon; }
                unsigned int            score(int team=0) const { return scores[team]; }
                unsigned int            scoreLimit() const { return serverScoreLimit; }
                virtual QRgb            teamColor(int team) const;
                virtual QString         teamName(int team) const { return team < MAX_TEAMS && team >= 0 ? teamNames[team] : ""; }
                unsigned short          timeLeft() const { return serverTimeLeft; }
                unsigned short          timeLimit() const { return serverTimeLimit; }
                const QString           version() const { return serverVersion; }
                const PWad                      &wad(int index) const { return wads[index]; }
                const QString           &website() const { return webSite; }

                void                            setBroadcastToLAN(bool b) { broadcastToLAN = b; }
                void                            setBroadcastToMaster(bool b) { broadcastToMaster = b; }
                void                            setHostEmail(const QString& mail) { email = mail; }
                void                            setGameMode(const GameMode& gameMode) { currentGameMode = gameMode; }
                void                            setMap(const QString& name) { mapName = name; }
                void                            setMapList(const QStringList& maplist) { mapList = maplist; }
                void                            setMaximumClients(unsigned short i) { maxClients = i; }
                void                            setMaximumPlayers(unsigned short i) { maxPlayers = i; }
                void                            setMOTD(const QString& message) { motd = message; }
                void                            setName(const QString& name) { serverName = name; }
                void                            setPasswordConnect(const QString& str) { passwordConnect = str; }
                void                            setPasswordJoin(const QString& str) { passwordJoin = str; }
                void                            setPasswordRCon(const QString& str) { passwordRCon = str; }
                void                            setPort(unsigned short i) { serverPort = i; }
                void                            setRandomMapRotation(bool b) { mapRandomRotation = b; }
                void                            setSkill(unsigned char newSkill) { skill = newSkill; }
                void                            setWebsite(const QString& site) { webSite = site; }

                void                            setCustom(bool b) { custom = b; }
                void                            setToDelete(bool b);

                virtual GameRunner*     gameRunner() const;

                void                            refreshStarts();

                void                            refreshStops(Response response);

                Response readRefreshQueryResponse(QByteArray& data);

                bool                            sendRefreshQuery(QUdpSocket* socket);

                bool                            isRefreshing() const { return bIsRefreshing; }

                virtual const EnginePlugin*             plugin() const = 0;

                virtual TooltipGenerator*       tooltipGenerator() const;

                friend class ServerPointer;

        public slots:
                bool                    refresh();

        signals:
                void                            begunRefreshing(Server* server);
                void                            updated(Server *server, int response);

        protected:
                void                            clearDMFlags();

                void                            emitUpdated(int response) { emit updated(this, response); }

                virtual Response                readRequest(QByteArray &data)=0;

                virtual bool            sendRequest(QByteArray &data)=0;

                bool                            bDelete;
                bool                            bKnown;

                bool                            bPingIsSet;

                bool                            bSecureServer;
                bool                            broadcastToLAN;
                bool                            broadcastToMaster;
                GameMode                        currentGameMode;
                unsigned int            currentPing;
                bool                            custom;
                DMFlags                         dmFlags;
                QString                         email;
                QString                         iwad;
                bool                            locked;
                QStringList                     mapList;
                QString                         mapName;
                bool                            mapRandomRotation;
                unsigned short          maxClients;
                unsigned short          maxPlayers;
                QString                         motd;
                QString                         passwordConnect;
                QString                         passwordJoin;
                QString                         passwordRCon;
                PlayersList*            players;
                Response                        response;
                unsigned int            scores[MAX_TEAMS];
                QString                         serverName;
                unsigned int            serverScoreLimit;
                unsigned short          serverTimeLeft;
                unsigned short          serverTimeLimit;
                QString                         serverVersion;
                unsigned char           skill;
                QList<PWad>                     wads;
                QString                         webSite;

                static QString          teamNames[];

                QTime                           time;

        protected slots:
                void                            setHostName(QHostInfo host);

        private:
                Q_DISABLE_COPY(Server)

                
                bool                            bIsRefreshing;
                QHostAddress            serverAddress;
                QHostInfo                       serverHost;
                unsigned short          serverPort;

                int                                     triesLeft; 

                void                            setResponse(Response response);
};

class MAIN_EXPORT ServerPointer
{
        private:
                void copy(const ServerPointer& copyin)
                {
                        ptr = copyin.ptr;
                }

        public:
                Server* ptr;

                ServerPointer() {}
                ServerPointer(Server* s)
                {
                        ptr = s;
                }

                ServerPointer(const ServerPointer& copyin)
                {
                        copy(copyin);
                }

                ServerPointer& operator=(const ServerPointer& rhs)
                {
                        if (this != &rhs)
                        {
                                copy(rhs);
                        }

                        return *this;
                }
                ~ServerPointer() {}

                bool operator==(const Server* fPtr) const
                {
                        return (ptr == fPtr);
                }

                friend bool operator==(const Server* fPtr, const ServerPointer& ref)
                {
                        return (fPtr == ref.ptr);
                }

                Server* operator->()
                {
                        return ptr;
                }
};

Q_DECLARE_METATYPE(ServerPointer)

#endif /* __SERVER_H__ */

   

Doomseeker © 2009-2018 The Doomseeker Team