servatrice/common/server.h

#ifndef SERVER_H
#define SERVER_H

#include <QObject>
#include <QStringList>
#include <QMap>
#include <QMultiMap>
#include <QMutex>
#include <QReadWriteLock>
#include "pb/commands.pb.h"
#include "pb/serverinfo_user.pb.h"
#include "server_player_reference.h"

class Server_DatabaseInterface;
class Server_Game;
class Server_Room;
class Server_ProtocolHandler;
class Server_AbstractUserInterface;
class GameReplay;
class IslMessage;
class SessionEvent;
class RoomEvent;
class DeckList;
class ServerInfo_Game;
class ServerInfo_Room;
class Response;
class GameEventContainer;
class CommandContainer;
class Command_JoinGame;

enum AuthenticationResult { NotLoggedIn = 0, PasswordRight = 1, UnknownUser = 2, WouldOverwriteOldSession = 3, UserIsBanned = 4, UsernameInvalid = 5, RegistrationRequired = 6 };
enum RegistrationResult { Accepted = 0, UserAlreadyExists = 1, EmailRequired = 2, UnauthenticatedServer = 3, TooManyRequests = 4, InvalidUsername = 5, ClientIsBanned = 6, RegistrationDisabled = 7, Failed = 8};

class Server : public QObject
{
    Q_OBJECT
signals:
    void pingClockTimeout();
    void sigSendIslMessage(const IslMessage &message, int serverId);
    void endSession(qint64 sessionId);
private slots:
    void broadcastRoomUpdate(const ServerInfo_Room &roomInfo, bool sendToIsl = false);
public:
    mutable QReadWriteLock clientsLock, roomsLock; // locking order: roomsLock before clientsLock
    Server(bool _threaded, QObject *parent = 0);
    ~Server();
    void setThreaded(bool _threaded) { threaded = _threaded; }
    AuthenticationResult loginUser(Server_ProtocolHandler *session, QString &name, const QString &password, QString &reason, int &secondsLeft);

    /**
    * Registers a user account.
    * @param ipAddress The address of the connection from the user
    * @param userName The username to attempt to register
    * @param emailAddress The email address to associate with the new account (and to use for activation)
    * @param banReason If the client is banned, the reason for the ban will be included in this string.
    * @param banSecondsRemaining If the client is banned, the time left will be included in this. 0 if the ban is permanent.
    * @return RegistrationResult member indicating whether it succeeded or failed.
    */
    RegistrationResult registerUserAccount(const QString &ipAddress, const Command_Register &cmd, QString &banReason, int &banSecondsRemaining);

    bool tooManyRegistrationAttempts(const QString &ipAddress);
    const QMap<int, Server_Room *> &getRooms() { return rooms; }
    
    Server_AbstractUserInterface *findUser(const QString &userName) const;
    const QMap<QString, Server_ProtocolHandler *> &getUsers() const { return users; }
    const QMap<qint64, Server_ProtocolHandler *> &getUsersBySessionId() const { return usersBySessionId; }
    void addClient(Server_ProtocolHandler *player);
    void removeClient(Server_ProtocolHandler *player);
    virtual QString getLoginMessage() const { return QString(); }
    
    virtual bool getGameShouldPing() const { return false; }
    virtual int getMaxGameInactivityTime() const { return 9999999; }
    virtual int getMaxPlayerInactivityTime() const { return 9999999; }
    virtual int getMessageCountingInterval() const { return 0; }
    virtual int getMaxMessageCountPerInterval() const { return 0; }
    virtual int getMaxMessageSizePerInterval() const { return 0; }
    virtual int getMaxGamesPerUser() const { return 0; }
    virtual int getCommandCountingInterval() const { return 0; }
    virtual int getMaxCommandCountPerInterval() const { return 0; }

    virtual bool getThreaded() const { return false; }

    Server_DatabaseInterface *getDatabaseInterface() const;
    int getNextLocalGameId() { QMutexLocker locker(&nextLocalGameIdMutex); return ++nextLocalGameId; }
    
    void sendIsl_Response(const Response &item, int serverId = -1, qint64 sessionId = -1);
    void sendIsl_SessionEvent(const SessionEvent &item, int serverId = -1, qint64 sessionId = -1);
    void sendIsl_GameEventContainer(const GameEventContainer &item, int serverId = -1, qint64 sessionId = -1);
    void sendIsl_RoomEvent(const RoomEvent &item, int serverId = -1, qint64 sessionId = -1);
    void sendIsl_GameCommand(const CommandContainer &item, int serverId, qint64 sessionId, int roomId, int playerId);
    void sendIsl_RoomCommand(const CommandContainer &item, int serverId, qint64 sessionId, int roomId);
    
    void addExternalUser(const ServerInfo_User &userInfo);
    void removeExternalUser(const QString &userName);
    const QMap<QString, Server_AbstractUserInterface *> &getExternalUsers() const { return externalUsers; }
    
    void addPersistentPlayer(const QString &userName, int roomId, int gameId, int playerId);
    void removePersistentPlayer(const QString &userName, int roomId, int gameId, int playerId);
    QList<PlayerReference> getPersistentPlayerReferences(const QString &userName) const;
private:
    bool threaded;
    QMultiMap<QString, PlayerReference> persistentPlayers;
    mutable QReadWriteLock persistentPlayersLock;
    int nextLocalGameId;
    QMutex nextLocalGameIdMutex;
protected slots:    
    void externalUserJoined(const ServerInfo_User &userInfo);
    void externalUserLeft(const QString &userName);
    void externalRoomUserJoined(int roomId, const ServerInfo_User &userInfo);
    void externalRoomUserLeft(int roomId, const QString &userName);
    void externalRoomSay(int roomId, const QString &userName, const QString &message);
    void externalRoomGameListChanged(int roomId, const ServerInfo_Game &gameInfo);
    void externalJoinGameCommandReceived(const Command_JoinGame &cmd, int cmdId, int roomId, int serverId, qint64 sessionId);
    void externalGameCommandContainerReceived(const CommandContainer &cont, int playerId, int serverId, qint64 sessionId);
    void externalGameEventContainerReceived(const GameEventContainer &cont, qint64 sessionId);
    void externalResponseReceived(const Response &resp, qint64 sessionId);
    
    virtual void doSendIslMessage(const IslMessage & /* msg */, int /* serverId */) { }
protected:
    void prepareDestroy();
    void setDatabaseInterface(Server_DatabaseInterface *_databaseInterface);
    QList<Server_ProtocolHandler *> clients;
    QMap<qint64, Server_ProtocolHandler *> usersBySessionId;
    QMap<QString, Server_ProtocolHandler *> users;
    QMap<qint64, Server_AbstractUserInterface *> externalUsersBySessionId;
    QMap<QString, Server_AbstractUserInterface *> externalUsers;
    QMap<int, Server_Room *> rooms;
    QMap<QThread *, Server_DatabaseInterface *> databaseInterfaces;
    
    int getUsersCount() const;
    int getGamesCount() const;
    void addRoom(Server_Room *newRoom);

    bool registrationEnabled;
    bool requireEmailForRegistration;
};

#endif