Added server/client feature set communication

cockatrice/src/abstractclient.cpp

@@ -19,6 +19,7 @@
 #include "get_pb_extension.h"
 #include <google/protobuf/descriptor.h>
 #include "client_metatypes.h"
+#include "featureset.h"
 
 AbstractClient::AbstractClient(QObject *parent)
     : QObject(parent), nextCmdId(0), status(StatusDisconnected)
@@ -45,6 +46,10 @@ AbstractClient::AbstractClient(QObject *parent)
     qRegisterMetaType<ServerInfo_User>("ServerInfo_User");
     qRegisterMetaType<QList<ServerInfo_User> >("QList<ServerInfo_User>");
     qRegisterMetaType<Event_ReplayAdded>("Event_ReplayAdded");
+    qRegisterMetaType<QList<QString> >("missingFeatures");
+
+    FeatureSet features;
+    features.initalizeFeatureList(clientFeatures);
     
     connect(this, SIGNAL(sigQueuePendingCommand(PendingCommand *)), this, SLOT(queuePendingCommand(PendingCommand *)));
 }

cockatrice/src/abstractclient.h

@@ -25,6 +25,7 @@ class Event_NotifyUser;
 class Event_ConnectionClosed;
 class Event_ServerShutdown;
 class Event_ReplayAdded;
+class FeatureSet;
 
 enum ClientStatus {
     StatusDisconnected,
@@ -96,6 +97,8 @@ public:
     static PendingCommand *prepareRoomCommand(const ::google::protobuf::Message &cmd, int roomId);
     static PendingCommand *prepareModeratorCommand(const ::google::protobuf::Message &cmd);
     static PendingCommand *prepareAdminCommand(const ::google::protobuf::Message &cmd);
+
+    QMap<QString, bool> clientFeatures;
 };
 
 #endif

cockatrice/src/client_metatypes.h

@@ -24,6 +24,6 @@ Q_DECLARE_METATYPE(Event_UserMessage)
 Q_DECLARE_METATYPE(ServerInfo_User)
 Q_DECLARE_METATYPE(QList<ServerInfo_User>)
 Q_DECLARE_METATYPE(Event_ReplayAdded)
-
+Q_DECLARE_METATYPE(QList<QString>)
 
 #endif

cockatrice/src/dlg_settings.cpp

@@ -45,6 +45,7 @@ GeneralSettingsPage::GeneralSettingsPage()
 
     picDownloadCheckBox.setChecked(settingsCache->getPicDownload());
     picDownloadHqCheckBox.setChecked(settingsCache->getPicDownloadHq());
+    updateNotificationCheckBox.setChecked(settingsCache->getNotifyAboutUpdates());
 
     pixmapCacheEdit.setMinimum(PIXMAPCACHE_SIZE_MIN);
     // 2047 is the max value to avoid overflowing of QPixmapCache::setCacheLimit(int size)
@@ -64,19 +65,21 @@ GeneralSettingsPage::GeneralSettingsPage()
     connect(&picDownloadHqCheckBox, SIGNAL(stateChanged(int)), settingsCache, SLOT(setPicDownloadHq(int)));
     connect(&pixmapCacheEdit, SIGNAL(valueChanged(int)), settingsCache, SLOT(setPixmapCacheSize(int)));
     connect(&picDownloadHqCheckBox, SIGNAL(clicked(bool)), this, SLOT(setEnabledStatus(bool)));
+    connect(&updateNotificationCheckBox, SIGNAL(stateChanged(int)), settingsCache, SLOT(setNotifyAboutUpdate(int)));
     connect(highQualityURLEdit, SIGNAL(textChanged(QString)), settingsCache, SLOT(setPicUrlHq(QString)));
 
     QGridLayout *personalGrid = new QGridLayout;
     personalGrid->addWidget(&languageLabel, 0, 0);
     personalGrid->addWidget(&languageBox, 0, 1);
-    personalGrid->addWidget(&pixmapCacheLabel, 1, 0, 1, 1);
-    personalGrid->addWidget(&pixmapCacheEdit, 1, 1, 1, 1);
-    personalGrid->addWidget(&picDownloadCheckBox, 2, 0, 1, 2);
-    personalGrid->addWidget(&picDownloadHqCheckBox, 3, 0, 1, 2);
-    personalGrid->addWidget(&clearDownloadedPicsButton, 4, 0, 1, 1);
-    personalGrid->addWidget(&highQualityURLLabel, 5, 0, 1, 1);
-    personalGrid->addWidget(highQualityURLEdit, 5, 1, 1, 1);
-    personalGrid->addWidget(&highQualityURLLinkLabel, 6, 1, 1, 1);
+    personalGrid->addWidget(&pixmapCacheLabel, 1, 0);
+    personalGrid->addWidget(&pixmapCacheEdit, 1, 1);
+    personalGrid->addWidget(&updateNotificationCheckBox, 2, 0);
+    personalGrid->addWidget(&picDownloadCheckBox, 3, 0);
+    personalGrid->addWidget(&picDownloadHqCheckBox, 4, 0);
+    personalGrid->addWidget(&highQualityURLLabel, 5, 0);
+    personalGrid->addWidget(highQualityURLEdit, 5, 1);
+    personalGrid->addWidget(&highQualityURLLinkLabel, 6, 1);
+    personalGrid->addWidget(&clearDownloadedPicsButton, 6, 0);
     
     highQualityURLLinkLabel.setTextInteractionFlags(Qt::LinksAccessibleByMouse);
     highQualityURLLinkLabel.setOpenExternalLinks(true);
@@ -246,6 +249,7 @@ void GeneralSettingsPage::retranslateUi()
     highQualityURLLabel.setText(tr("Custom Card Download URL:"));
     highQualityURLLinkLabel.setText(QString("<a href='%1'>%2</a>").arg(LINKING_FAQ_URL).arg(tr("Linking FAQ")));
     clearDownloadedPicsButton.setText(tr("Reset/Clear Downloaded Pictures"));
+    updateNotificationCheckBox.setText(tr("Notify when new client features are available"));
 }
 
 void GeneralSettingsPage::setEnabledStatus(bool status)
@@ -914,3 +918,4 @@ void DlgSettings::retranslateUi()
     for (int i = 0; i < pagesWidget->count(); i++)
         dynamic_cast<AbstractSettingsPage *>(pagesWidget->widget(i))->retranslateUi();
 }
+

cockatrice/src/dlg_settings.h

@@ -60,6 +60,7 @@ private:
     QComboBox languageBox;
     QCheckBox picDownloadCheckBox;
     QCheckBox picDownloadHqCheckBox;
+    QCheckBox updateNotificationCheckBox;
     QLabel languageLabel;
     QLabel pixmapCacheLabel;
     QLabel deckPathLabel;

cockatrice/src/main.cpp

@@ -33,7 +33,6 @@
 #include <QSystemTrayIcon>
 #include "QtNetwork/QNetworkInterface"
 #include <QCryptographicHash>
-
 #include "main.h"
 #include "window_main.h"
 #include "dlg_settings.h"
@@ -43,6 +42,7 @@
 #include "pixmapgenerator.h"
 #include "rng_sfmt.h"
 #include "soundengine.h"
+#include "featureset.h"
 
 //Q_IMPORT_PLUGIN(qjpeg)
 

cockatrice/src/remoteclient.cpp

+#include <QList>
 #include <QTimer>
 #include <QThread>
 #include "remoteclient.h"
@@ -81,7 +82,6 @@ void RemoteClient::processServerIdentificationEvent(const Event_ServerIdentifica
         cmdRegister.set_country(country.toStdString());
         cmdRegister.set_real_name(realName.toStdString());
         cmdRegister.set_clientid(settingsCache->getClientID().toStdString());
-
         PendingCommand *pend = prepareSessionCommand(cmdRegister);
         connect(pend, SIGNAL(finished(Response, CommandContainer, QVariant)), this, SLOT(registerResponse(Response)));
         sendCommand(pend);
@@ -105,8 +105,7 @@ void RemoteClient::processServerIdentificationEvent(const Event_ServerIdentifica
     doLogin();
 }
 
-void RemoteClient::doLogin()
-{
+void RemoteClient::doLogin() {
     setStatus(StatusLoggingIn);
 
     Command_Login cmdLogin;
@@ -114,6 +113,13 @@ void RemoteClient::doLogin()
     cmdLogin.set_password(password.toStdString());
     cmdLogin.set_clientid(settingsCache->getClientID().toStdString());
     cmdLogin.set_clientver(VERSION_STRING);
+
+    if (!clientFeatures.isEmpty()) {
+        QMap<QString, bool>::iterator i;
+        for (i = clientFeatures.begin(); i != clientFeatures.end(); ++i)
+            cmdLogin.add_clientfeatures(i.key().toStdString().c_str());
+    }
+
     PendingCommand *pend = prepareSessionCommand(cmdLogin);
     connect(pend, SIGNAL(finished(Response, CommandContainer, QVariant)), this, SLOT(loginResponse(Response)));
     sendCommand(pend);
@@ -140,8 +146,17 @@ void RemoteClient::loginResponse(const Response &response)
         for (int i = resp.ignore_list_size() - 1; i >= 0; --i)
             ignoreList.append(resp.ignore_list(i));
         emit ignoreListReceived(ignoreList);
+
+        if (resp.missing_features_size() > 0 && settingsCache->getNotifyAboutUpdates())
+                emit notifyUserAboutUpdate();
+
     } else {
-        emit loginError(response.response_code(), QString::fromStdString(resp.denied_reason_str()), resp.denied_end_time());
+        QList<QString> missingFeatures;
+        if (resp.missing_features_size() > 0) {
+            for (int i = 0; i < resp.missing_features_size(); ++i)
+                missingFeatures << QString::fromStdString(resp.missing_features(i));
+        }
+        emit loginError(response.response_code(), QString::fromStdString(resp.denied_reason_str()), resp.denied_end_time(), missingFeatures);
         setStatus(StatusDisconnecting);
     }
 }

cockatrice/src/remoteclient.h

@@ -11,7 +11,7 @@ class RemoteClient : public AbstractClient {
 signals:
     void maxPingTime(int seconds, int maxSeconds);
     void serverTimeout();
-    void loginError(Response::ResponseCode resp, QString reasonStr, quint32 endTime);
+    void loginError(Response::ResponseCode resp, QString reasonStr, quint32 endTime, QList<QString> missingFeatures);
     void registerError(Response::ResponseCode resp, QString reasonStr, quint32 endTime);
     void activateError();
     void socketError(const QString &errorString);
@@ -21,6 +21,7 @@ signals:
     void sigRegisterToServer(const QString &hostname, unsigned int port, const QString &_userName, const QString &_password, const QString &_email, const int _gender, const QString &_country, const QString &_realname);
     void sigActivateToServer(const QString &_token);
     void sigDisconnectFromServer();
+    void notifyUserAboutUpdate();
 private slots:
     void slotConnected();
     void readData();

cockatrice/src/settingscache.cpp

@@ -130,6 +130,7 @@ SettingsCache::SettingsCache()
     if(!QFile(settingsPath+"global.ini").exists())
         translateLegacySettings();
 
+    notifyAboutUpdates = settings->value("personal/updatenotification", true).toBool();
     lang = settings->value("personal/lang").toString();
     keepalive = settings->value("personal/keepalive", 5).toInt();
     deckPath = settings->value("paths/decks").toString();
@@ -620,4 +621,10 @@ void SettingsCache::setRememberGameSettings(const bool _rememberGameSettings)
 {
     rememberGameSettings = _rememberGameSettings;
     settings->setValue("game/remembergamesettings", rememberGameSettings);
+}
+
+void SettingsCache::setNotifyAboutUpdate(int _notifyaboutupdate)
+{
+    notifyAboutUpdates = _notifyaboutupdate;
+    settings->setValue("personal/updatenotification", notifyAboutUpdates);
 }
\ No newline at end of file

cockatrice/src/settingscache.h

@@ -58,6 +58,7 @@ private:
     QByteArray mainWindowGeometry;
     QString lang;
     QString deckPath, replaysPath, picsPath, cardDatabasePath, tokenDatabasePath, themeName;
+    bool notifyAboutUpdates;
     bool picDownload;
     bool picDownloadHq;
     bool notificationsEnabled;
@@ -129,6 +130,7 @@ public:
     bool getPicDownloadHq() const { return picDownloadHq; }
     bool getNotificationsEnabled() const { return notificationsEnabled; }
     bool getSpectatorNotificationsEnabled() const { return spectatorNotificationsEnabled; }
+    bool getNotifyAboutUpdates() const { return notifyAboutUpdates; }
 
     bool getDoubleClickToPlay() const { return doubleClickToPlay; }
     bool getPlayToStack() const { return playToStack; }
@@ -251,6 +253,7 @@ public slots:
     void setSpectatorsCanTalk(const bool _spectatorsCanTalk);
     void setSpectatorsCanSeeEverything(const bool _spectatorsCanSeeEverything);
     void setRememberGameSettings(const bool _rememberGameSettings);
+    void setNotifyAboutUpdate(int _notifyaboutupdate);
 };
 
 extern SettingsCache *settingsCache;

cockatrice/src/window_main.cpp

@@ -30,6 +30,7 @@
 #include <QDateTime>
 #include <QSystemTrayIcon>
 #include <QApplication>
+
 #if QT_VERSION < 0x050000
     #include <QtGui/qtextdocument.h> // for Qt::escape()
 #endif
@@ -293,9 +294,23 @@ void MainWindow::serverTimeout()
     actConnect();
 }
 
-void MainWindow::loginError(Response::ResponseCode r, QString reasonStr, quint32 endTime)
+void MainWindow::loginError(Response::ResponseCode r, QString reasonStr, quint32 endTime, QList<QString> missingFeatures)
 {
     switch (r) {
+        case Response::RespClientUpdateRequired: {
+            QString formatedMissingFeatures;
+            formatedMissingFeatures = "Missing Features: ";
+            for (int i = 0; i < missingFeatures.size(); ++i)
+                formatedMissingFeatures.append(QString("\n     %1").arg(QChar(0x2022)) + " " + missingFeatures.value(i)   );
+
+            QMessageBox msgBox;
+            msgBox.setIcon(QMessageBox::Critical);
+            msgBox.setWindowTitle(tr("Failed Login"));
+            msgBox.setText(tr("Your client does not support features that the server requires, please update your client and try again."));
+            msgBox.setDetailedText(formatedMissingFeatures);
+            msgBox.exec();
+            break;
+        }
         case Response::RespWrongPassword:
             QMessageBox::critical(this, tr("Error"), tr("Incorrect username or password. Please check your authentication information and try again."));
             break;
@@ -561,13 +576,13 @@ MainWindow::MainWindow(QWidget *parent)
     client = new RemoteClient;
     connect(client, SIGNAL(connectionClosedEventReceived(const Event_ConnectionClosed &)), this, SLOT(processConnectionClosedEvent(const Event_ConnectionClosed &)));
     connect(client, SIGNAL(serverShutdownEventReceived(const Event_ServerShutdown &)), this, SLOT(processServerShutdownEvent(const Event_ServerShutdown &)));
-    connect(client, SIGNAL(loginError(Response::ResponseCode, QString, quint32)), this, SLOT(loginError(Response::ResponseCode, QString, quint32)));
+    connect(client, SIGNAL(loginError(Response::ResponseCode, QString, quint32, QList<QString>)), this, SLOT(loginError(Response::ResponseCode, QString, quint32, QList<QString>)));
     connect(client, SIGNAL(socketError(const QString &)), this, SLOT(socketError(const QString &)));
     connect(client, SIGNAL(serverTimeout()), this, SLOT(serverTimeout()));
     connect(client, SIGNAL(statusChanged(ClientStatus)), this, SLOT(statusChanged(ClientStatus)));
     connect(client, SIGNAL(protocolVersionMismatch(int, int)), this, SLOT(protocolVersionMismatch(int, int)));
     connect(client, SIGNAL(userInfoChanged(const ServerInfo_User &)), this, SLOT(userInfoReceived(const ServerInfo_User &)), Qt::BlockingQueuedConnection);
-
+    connect(client, SIGNAL(notifyUserAboutUpdate()), this, SLOT(notifyUserAboutUpdate()));
     connect(client, SIGNAL(registerAccepted()), this, SLOT(registerAccepted()));
     connect(client, SIGNAL(registerAcceptedNeedsActivate()), this, SLOT(registerAcceptedNeedsActivate()));
     connect(client, SIGNAL(registerError(Response::ResponseCode, QString, quint32)), this, SLOT(registerError(Response::ResponseCode, QString, quint32)));
@@ -795,3 +810,8 @@ void MainWindow::refreshShortcuts()
     aExit->setShortcuts(settingsCache->shortcuts().getShortcut("MainWindow/aExit"));
     aCheckCardUpdates->setShortcuts(settingsCache->shortcuts().getShortcut("MainWindow/aCheckCardUpdates"));
 }
+
+void MainWindow::notifyUserAboutUpdate()
+{
+    QMessageBox::information(this, tr("Information"), tr("Your client appears to be missing features that the server supports.\nThis usually means that your client version is out of date,pleae check to see if there is a new client available for download."));
+}

cockatrice/src/window_main.h

@@ -20,6 +20,7 @@
 #ifndef WINDOW_H
 #define WINDOW_H
 
+#include <QList>
 #include <QMainWindow>
 #include <QSystemTrayIcon>
 #include <QProcess>
@@ -42,7 +43,7 @@ private slots:
     void processConnectionClosedEvent(const Event_ConnectionClosed &event);
     void processServerShutdownEvent(const Event_ServerShutdown &event);
     void serverTimeout();
-    void loginError(Response::ResponseCode r, QString reasonStr, quint32 endTime);
+    void loginError(Response::ResponseCode r, QString reasonStr, quint32 endTime, QList<QString> missingFeatures);
     void registerError(Response::ResponseCode r, QString reasonStr, quint32 endTime);
     void activateError();
     void socketError(const QString &errorStr);
@@ -53,7 +54,7 @@ private slots:
     void activateAccepted();
     void localGameEnded();
     void pixmapCacheSizeChanged(int newSizeInMBs);
-
+    void notifyUserAboutUpdate();
     void actConnect();
     void actDisconnect();
     void actSinglePlayer();

common/CMakeLists.txt

@@ -7,6 +7,7 @@ add_subdirectory(pb)
 
 SET(common_SOURCES
     decklist.cpp
+    featureset.cpp
     get_pb_extension.cpp
     rng_abstract.cpp
     rng_sfmt.cpp

common/featureset.cpp

+#include "featureset.h"
+#include <QMap>
+#include <QDebug>
+
+FeatureSet::FeatureSet()
+{
+
+}
+
+QMap<QString, bool> FeatureSet::getDefaultFeatureList() {
+    initalizeFeatureList(featureList);
+    return featureList;
+}
+
+void FeatureSet::initalizeFeatureList(QMap<QString, bool> &featureList){
+    featureList.insert("client_id", false);
+    featureList.insert("client_ver", false);
+    featureList.insert("feature_set", false);
+}
+
+void FeatureSet::enableRequiredFeature(QMap<QString, bool> &featureList, QString featureName){
+    if (featureList.contains(featureName))
+        featureList.insert(featureName,true);
+}
+
+void FeatureSet::disableRequiredFeature(QMap<QString, bool> &featureList, QString featureName){
+    if (featureList.contains(featureName))
+        featureList.insert(featureName,false);
+}
+
+QMap<QString, bool> FeatureSet::addFeature(QMap<QString, bool> &featureList, QString featureName, bool isFeatureRequired){
+    featureList.insert(featureName,isFeatureRequired);
+    return featureList;
+}
+
+QMap<QString, bool> FeatureSet::identifyMissingFeatures(QMap<QString, bool> suppliedFeatures, QMap<QString, bool> requiredFeatures){
+    QMap<QString, bool> missingList;
+    QMap<QString, bool>::iterator i;
+    for (i = requiredFeatures.begin(); i != requiredFeatures.end(); ++i) {
+        if (!suppliedFeatures.contains(i.key())) {
+            missingList.insert(i.key(), i.value());
+        }
+    }
+    return missingList;
+}
+
+bool FeatureSet::isRequiredFeaturesMissing(QMap<QString, bool> suppliedFeatures, QMap<QString, bool> requiredFeatures) {
+    QMap<QString, bool>::iterator i;
+    for (i = requiredFeatures.begin(); i != requiredFeatures.end(); ++i) {
+        if (i.value() && suppliedFeatures.contains(i.key())) {
+                return true;
+        }
+    }
+    return false;
+}

common/featureset.h

+#ifndef FEATURESET_H
+#define FEATURESET_H
+
+#include <QMap>
+#include <QSet>
+#include <QString>
+
+class FeatureSet
+{
+public:
+    FeatureSet();
+    QMap<QString, bool> getDefaultFeatureList();
+    void initalizeFeatureList(QMap<QString, bool> &featureList);
+    void enableRequiredFeature(QMap<QString, bool> &featureList, QString featureName);
+    void disableRequiredFeature(QMap<QString, bool> &featureList, QString featureName);
+    QMap<QString, bool> addFeature(QMap<QString, bool> &featureList, QString featureName, bool isFeatureRequired);
+    QMap<QString, bool> identifyMissingFeatures(QMap<QString, bool> featureListToCheck, QMap<QString, bool> featureListToCompareTo);
+    bool isRequiredFeaturesMissing(QMap<QString, bool> featureListToCheck, QMap<QString, bool> featureListToCompareTo);
+private:
+    QMap<QString, bool> featureList;
+};
+
+
+#endif // FEEATURESET_H

common/pb/response.proto

@@ -37,6 +37,7 @@ message Response {
         RespActivationFailed = 32; // Server didn't accept a reg user activation token
         RespRegistrationAcceptedNeedsActivation = 33; // Server accepted cient registration, but it will need token activation
         RespClientIdRequired = 34; // Server requires client to generate and send its client id before allowing access
+        RespClientUpdateRequired = 35; // Client is missing features that the server is requiring
     }
     enum ResponseType {
         JOIN_ROOM = 1000;

common/pb/response_login.proto

@@ -11,4 +11,5 @@ message Response_Login {
     repeated ServerInfo_User ignore_list = 3;
     optional string denied_reason_str = 4;
     optional uint64 denied_end_time = 5;
+    repeated string missing_features = 6;
 }

common/pb/session_commands.proto

@@ -46,6 +46,7 @@ message Command_Login {
     optional string password = 2;
     optional string clientid = 3;
     optional string clientver = 4;
+    repeated string clientfeatures = 5;
 }
 
 message Command_Message {

common/server.cpp

@@ -32,6 +32,7 @@
 #include "pb/session_event.pb.h"
 #include "pb/event_connection_closed.pb.h"
 #include "pb/isl_message.pb.h"
+#include "featureset.h"
 #include <QCoreApplication>
 #include <QThread>
 #include <QDebug>

common/server.h

@@ -51,10 +51,10 @@ public:
     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; }
+    virtual QMap<QString, bool> getServerRequiredFeatureList() const { return QMap<QString, bool>(); }
     void addClient(Server_ProtocolHandler *player);
     void removeClient(Server_ProtocolHandler *player);
     virtual QString getLoginMessage() const { return QString(); }
-
     virtual bool permitUnregisteredUsers() const { return true; }
     virtual bool getGameShouldPing() const { return false; }
     virtual bool getClientIdRequired() const { return false; }
@@ -94,6 +94,7 @@ private:
     mutable QReadWriteLock persistentPlayersLock;
     int nextLocalGameId;
     QMutex nextLocalGameIdMutex;
+
 protected slots:
     void externalUserJoined(const ServerInfo_User &userInfo);
     void externalUserLeft(const QString &userName);