server_game.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2008 by Max-Wilhelm Bruker   *
 *   brukie@laptop   *
 *                                                                         *
 *   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.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef SERVERGAME_H
#define SERVERGAME_H
 
#include "../server_response_containers.h"
#include "libcockatrice/protocol/pb/game_event_context.pb.h"
 
// IWYU pragma: keep
// ServerInfo_Game is passed by value to the gameInfoChanged() signal, so the
// moc-generated code needs the complete type.
#include <QDateTime>
#include <QList>
#include <QMap>
#include <QObject>
#include <QRecursiveMutex>
#include <QScopedPointer>
#include <QSet>
#include <QString>
#include <QtGlobal>
#include <atomic>
#include <libcockatrice/protocol/pb/event_leave.pb.h>
#include <libcockatrice/protocol/pb/response.pb.h>
#include <libcockatrice/protocol/pb/serverinfo_game.pb.h>
#include <qtmetamacros.h>
 
class QTimer;
class GameEventContainer;
class GameReplay;
class Server_Room;
class Server_AbstractPlayer;
class Server_AbstractParticipant;
class ServerInfo_User;
class ServerInfo_Game;
class Server_AbstractUserInterface;
class Event_GameStateChanged;
class Server_DeckValidationStrategy;
class Server_GameLifecycleStrategy;
class Server_MatchResultStrategy;
namespace google
{
namespace protobuf
{
class Message;
} // namespace protobuf
} // namespace google
struct GameConfig;
 
class Server_Game : public QObject
{
    Q_OBJECT
private:
    Server_Room *room;
    int nextPlayerId;
    std::atomic<qint64> nextArrowId = 1;
    int hostId;
    ServerInfo_User *creatorInfo;
    QMap<int, Server_AbstractParticipant *> participants;
    QSet<QString> allPlayersEver, allSpectatorsEver;
    bool gameStarted;
    bool gameClosed;
    int gameId;
    QString description;
    QString password;
    int maxPlayers;
    QList<int> gameTypes;
    int activePlayer, activePhase;
    bool onlyBuddies, onlyRegistered;
    bool spectatorsAllowed;
    bool spectatorsNeedPassword;
    bool spectatorsCanTalk;
    bool spectatorsSeeEverything;
    int startingLifeTotal;
    bool shareDecklistsOnLoad;
    int inactivityCounter;
    int startTimeOfThisGame, secondsElapsed;
    bool firstGameStarted;
    bool turnOrderReversed;
    QDateTime startTime;
    QTimer *pingClock;
    QList<GameReplay *> replayList;
    GameReplay *currentReplay;
 
    QScopedPointer<Server_DeckValidationStrategy> deckValidationStrategy;
 
    QScopedPointer<Server_GameLifecycleStrategy> lifecycleStrategy;
 
    QScopedPointer<Server_MatchResultStrategy> matchResultStrategy;
 
    void createGameStateChangedEvent(Event_GameStateChanged *event,
                                     Server_AbstractParticipant *recipient,
                                     bool omniscient,
                                     bool withUserInfo);
    void storeGameInformation();
signals:
    void sigStartGameIfReady(bool override);
    void gameInfoChanged(ServerInfo_Game gameInfo);
private slots:
    void pingClockTimeout();
    void doStartGameIfReady(bool forceStartGame = false);
 
public:
    mutable QRecursiveMutex gameMutex;
    Server_Game(const GameConfig &config, Server_Room *parent);
    ~Server_Game() override;
    Server_Room *getRoom() const
    {
        return room;
    }
    void getInfo(ServerInfo_Game &result) const;
    int getHostId() const
    {
        return hostId;
    }
    ServerInfo_User *getCreatorInfo() const
    {
        return creatorInfo;
    }
    bool getGameStarted() const
    {
        return gameStarted;
    }
    int getPlayerCount() const;
    int getCardsInGame() const;
    int getSpectatorCount() const;
    QMap<int, Server_AbstractPlayer *> getPlayers() const;
    Server_AbstractPlayer *getPlayer(int id) const;
    const QMap<int, Server_AbstractParticipant *> &getParticipants() const
    {
        return participants;
    }
    int getGameId() const
    {
        return gameId;
    }
    QString getDescription() const
    {
        return description;
    }
    QString getPassword() const
    {
        return password;
    }
    int getMaxPlayers() const
    {
        return maxPlayers;
    }
    bool getSpectatorsAllowed() const
    {
        return spectatorsAllowed;
    }
    bool getSpectatorsNeedPassword() const
    {
        return spectatorsNeedPassword;
    }
    bool getSpectatorsCanTalk() const
    {
        return spectatorsCanTalk;
    }
    bool getSpectatorsSeeEverything() const
    {
        return spectatorsSeeEverything;
    }
    int getStartingLifeTotal() const
    {
        return startingLifeTotal;
    }
    bool getShareDecklistsOnLoad() const
    {
        return shareDecklistsOnLoad;
    }
    Response::ResponseCode
    checkJoin(ServerInfo_User *user, const QString &_password, bool spectator, bool overrideRestrictions, bool asJudge);
    bool containsUser(const QString &userName) const;
    void addPlayer(Server_AbstractUserInterface *userInterface,
                   ResponseContainer &rc,
                   bool spectator,
                   bool judge,
                   bool broadcastUpdate = true);
    void removeParticipant(Server_AbstractParticipant *participant, Event_Leave::LeaveReason reason);
    void removeArrowsRelatedToPlayer(GameEventStorage &ges, Server_AbstractPlayer *player);
    void unattachCards(GameEventStorage &ges, Server_AbstractPlayer *player);
    bool kickParticipant(int playerId);
    void startGameIfReady(bool forceStartGame);
    void stopGameIfFinished();
    int getActivePlayer() const
    {
        return activePlayer;
    }
    int getActivePhase() const
    {
        return activePhase;
    }
    void setActivePlayer(int newPlayer);
    void setActivePhase(int newPhase);
    qint64 generateArrowId();
    void removeArrows(int newPhase, bool force = false);
    void nextTurn();
    int getSecondsElapsed() const
    {
        return secondsElapsed;
    }
    bool reverseTurnOrder()
    {
        return turnOrderReversed = !turnOrderReversed;
    }
 
    void createGameJoinedEvent(Server_AbstractParticipant *participant, ResponseContainer &rc, bool resuming);
 
    GameEventContainer *
    prepareGameEvent(const ::google::protobuf::Message &gameEvent, int playerId, GameEventContext *context = 0);
    GameEventContext prepareGameEventContext(const ::google::protobuf::Message &gameEventContext);
 
    void sendGameStateToPlayers();
    void sendGameEventContainer(GameEventContainer *cont,
                                GameEventStorageItem::EventRecipients recipients = GameEventStorageItem::SendToPrivate |
                                                                                   GameEventStorageItem::SendToOthers,
                                int privatePlayerId = -1);
    void returnCardsFromPlayer(GameEventStorage &ges, Server_AbstractPlayer *player);

    Server_DeckValidationStrategy *getDeckValidationStrategy() const
    {
        return deckValidationStrategy.data();
    }

    void setDeckValidationStrategy(Server_DeckValidationStrategy *strategy);

    Server_GameLifecycleStrategy *getLifecycleStrategy() const
    {
        return lifecycleStrategy.data();
    }
};
 
#endif