[GamesModel] Rename 'Creator' column to 'Host' (#7083)

* [GamesModel] Rename 'Creator' column to 'Host' (#2108)


Took 5 minutes

* Actually re-broadcast host change

Took 8 minutes

---------

Co-authored-by: Lukas Brübach <Bruebach.Lukas@bdosecurity.de>

cockatrice/src/interface/widgets/dialogs/dlg_filter_games.cpp

@@ -57,16 +57,16 @@ DlgFilterGames::DlgFilterGames(const QMap<int, QString> &_allGameTypes,
     gameNameFilterEdit->setText(filters.gameNameFilter);
     auto *gameNameFilterLabel = new QLabel(tr("Game &description:"));
     gameNameFilterLabel->setBuddy(gameNameFilterEdit);
-    creatorNameFilterEdit = new QLineEdit;
+    hostNameFilterEdit = new QLineEdit;
-    creatorNameFilterEdit->setText(filters.creatorNameFilters.join(", "));
+    hostNameFilterEdit->setText(filters.hostNameFilters.join(", "));
-    auto *creatorNameFilterLabel = new QLabel(tr("&Creator name:"));
+    auto *hostNameFilterLabel = new QLabel(tr("&Host name:"));
-    creatorNameFilterLabel->setBuddy(creatorNameFilterEdit);
+    hostNameFilterLabel->setBuddy(hostNameFilterEdit);
 
     auto *generalGrid = new QGridLayout;
     generalGrid->addWidget(gameNameFilterLabel, 0, 0);
     generalGrid->addWidget(gameNameFilterEdit, 0, 1);
-    generalGrid->addWidget(creatorNameFilterLabel, 1, 0);
+    generalGrid->addWidget(hostNameFilterLabel, 1, 0);
-    generalGrid->addWidget(creatorNameFilterEdit, 1, 1);
+    generalGrid->addWidget(hostNameFilterEdit, 1, 1);
     generalGrid->addWidget(maxGameAgeLabel, 2, 0);
     generalGrid->addWidget(maxGameAgeComboBox, 2, 1);
     generalGroupBox = new QGroupBox(tr("General"));
@@ -193,7 +193,7 @@ GameFilterConfigs DlgFilterGames::getFilters() const
             hideNotBuddyCreatedGames->isChecked(),
             hideOpenDecklistGames->isChecked(),
             gameNameFilterEdit->text(),
-            getCreatorNameFilters(),
+            getHostNameFilters(),
             getGameTypeFilter(),
             maxPlayersFilterMinSpinBox->value(),
             maxPlayersFilterMaxSpinBox->value(),
@@ -216,9 +216,9 @@ void DlgFilterGames::toggleSpectatorCheckboxEnabledness(bool spectatorsEnabled)
     showOnlyIfSpectatorsCanSeeHands->setDisabled(!spectatorsEnabled);
 }
 
-QStringList DlgFilterGames::getCreatorNameFilters() const
+QStringList DlgFilterGames::getHostNameFilters() const
 {
-    return creatorNameFilterEdit->text().split(",", Qt::SkipEmptyParts);
+    return hostNameFilterEdit->text().split(",", Qt::SkipEmptyParts);
 }
 
 QSet<int> DlgFilterGames::getGameTypeFilter() const

cockatrice/src/interface/widgets/dialogs/dlg_filter_games.h

@@ -35,7 +35,7 @@ private:
     QCheckBox *hideNotBuddyCreatedGames;
     QCheckBox *hideOpenDecklistGames;
     QLineEdit *gameNameFilterEdit;
-    QLineEdit *creatorNameFilterEdit;
+    QLineEdit *hostNameFilterEdit;
     QMap<int, QCheckBox *> gameTypeFilterCheckBoxes;
     QSpinBox *maxPlayersFilterMinSpinBox;
     QSpinBox *maxPlayersFilterMaxSpinBox;
@@ -50,7 +50,7 @@ private:
     const GamesProxyModel *gamesProxyModel;
     const QMap<QTime, QString> gameAgeMap;
 
-    [[nodiscard]] QStringList getCreatorNameFilters() const;
+    [[nodiscard]] QStringList getHostNameFilters() const;
     [[nodiscard]] QSet<int> getGameTypeFilter() const;
     [[nodiscard]] QTime getMaxGameAge() const;
     [[nodiscard]] bool getShowSpectatorPasswordProtected() const;

cockatrice/src/interface/widgets/server/game_filter_configs.h

@@ -19,7 +19,7 @@ struct GameFilterConfigs
     bool hideNotBuddyCreatedGames = false;
     bool hideOpenDecklistGames = false;
     QString gameNameFilter = "";
-    QStringList creatorNameFilters = {};
+    QStringList hostNameFilters = {};
     QSet<int> gameTypeFilter = {};
     int maxPlayersFilterMin = DEFAULT_MAX_PLAYERS_MIN;
     int maxPlayersFilterMax = DEFAULT_MAX_PLAYERS_MAX;

cockatrice/src/interface/widgets/server/games_model.cpp

@@ -17,13 +17,27 @@ enum GameListColumn
     ROOM,
     CREATED,
     DESCRIPTION,
-    CREATOR,
+    HOST,
     GAME_TYPE,
     RESTRICTIONS,
     PLAYERS,
     SPECTATORS
 };
 
+namespace
+{
+/**
+ * @brief Returns the user info of the game's current host, falling back to the creator.
+ *
+ * The server only sends host_info once a host transfer has happened, so older
+ * servers and freshly created games fall back to the original creator.
+ */
+const ServerInfo_User &getGameHost(const ServerInfo_Game &game)
+{
+    return game.has_host_info() ? game.host_info() : game.creator_info();
+}
+} // namespace
+
 const QString GamesModel::getGameCreatedString(const int secs)
 {
     static const QTime zeroTime{0, 0};
@@ -110,16 +124,16 @@ QVariant GamesModel::data(const QModelIndex &index, int role) const
                 default:
                     return QVariant();
             }
-        case CREATOR: {
+        case HOST: {
             switch (role) {
                 case SORT_ROLE:
                 case Qt::DisplayRole:
-                    return QString::fromStdString(gameentry.creator_info().name());
+                    return QString::fromStdString(getGameHost(gameentry).name());
                 case Qt::DecorationRole: {
-                    return UserLevelPixmapGenerator::generateIcon(
+                    const ServerInfo_User &host = getGameHost(gameentry);
-                        13, UserLevelFlags(gameentry.creator_info().user_level()),
+                    return UserLevelPixmapGenerator::generateIcon(13, UserLevelFlags(host.user_level()),
-                        gameentry.creator_info().pawn_colors(), false,
+                                                                  host.pawn_colors(), false,
-                        QString::fromStdString(gameentry.creator_info().privlevel()));
+                                                                  QString::fromStdString(host.privlevel()));
                 }
                 default:
                     return QVariant();
@@ -233,8 +247,8 @@ QVariant GamesModel::headerData(int section, Qt::Orientation /*orientation*/, in
         }
         case DESCRIPTION:
             return tr("Description");
-        case CREATOR:
+        case HOST:
-            return tr("Creator");
+            return tr("Host");
         case GAME_TYPE:
             return tr("Type");
         case RESTRICTIONS:
@@ -347,7 +361,7 @@ void GamesProxyModel::loadFilterParameters(const QMap<int, QString> &allGameType
                     gameFilters.isHideFullGames(), gameFilters.isHideGamesThatStarted(),
                     gameFilters.isHidePasswordProtectedGames(), gameFilters.isHideNotBuddyCreatedGames(),
                     gameFilters.isHideOpenDecklistGames(), gameFilters.getGameNameFilter(),
-                    gameFilters.getCreatorNameFilters(), newGameTypeFilter, gameFilters.getMinPlayers(),
+                    gameFilters.getHostNameFilters(), newGameTypeFilter, gameFilters.getMinPlayers(),
                     gameFilters.getMaxPlayers(), gameFilters.getMaxGameAge(),
                     gameFilters.isShowOnlyIfSpectatorsCanWatch(), gameFilters.isShowSpectatorPasswordProtected(),
                     gameFilters.isShowOnlyIfSpectatorsCanChat(), gameFilters.isShowOnlyIfSpectatorsCanSeeHands()});
@@ -364,7 +378,7 @@ void GamesProxyModel::saveFilterParameters(const QMap<int, QString> &allGameType
     gameFilters.setHideNotBuddyCreatedGames(filters.hideNotBuddyCreatedGames);
     gameFilters.setHideOpenDecklistGames(filters.hideOpenDecklistGames);
     gameFilters.setGameNameFilter(filters.gameNameFilter);
-    gameFilters.setCreatorNameFilters(filters.creatorNameFilters);
+    gameFilters.setHostNameFilters(filters.hostNameFilters);
 
     QMapIterator<int, QString> gameTypeIterator(allGameTypes);
     while (gameTypeIterator.hasNext()) {
@@ -409,11 +423,11 @@ bool GamesProxyModel::filterAcceptsRow(int sourceRow) const
         return false;
     }
     if (filters.hideIgnoredUserGames &&
-        userListProxy->isUserIgnored(QString::fromStdString(game.creator_info().name()))) {
+        userListProxy->isUserIgnored(QString::fromStdString(getGameHost(game).name()))) {
         return false;
     }
     if (filters.hideNotBuddyCreatedGames &&
-        !userListProxy->isUserBuddy(QString::fromStdString(game.creator_info().name()))) {
+        !userListProxy->isUserBuddy(QString::fromStdString(getGameHost(game).name()))) {
         return false;
     }
     if (filters.hideFullGames && game.player_count() == game.max_players()) {
@@ -435,10 +449,10 @@ bool GamesProxyModel::filterAcceptsRow(int sourceRow) const
             return false;
         }
     }
-    if (!filters.creatorNameFilters.isEmpty()) {
+    if (!filters.hostNameFilters.isEmpty()) {
         bool found = false;
-        for (const auto &createNameFilter : filters.creatorNameFilters) {
+        for (const auto &hostNameFilter : filters.hostNameFilters) {
-            if (QString::fromStdString(game.creator_info().name()).contains(createNameFilter, Qt::CaseInsensitive)) {
+            if (QString::fromStdString(getGameHost(game).name()).contains(hostNameFilter, Qt::CaseInsensitive)) {
                 found = true;
             }
         }

libcockatrice_network/libcockatrice/network/server/remote/game/server_game.cpp

@@ -526,10 +526,7 @@ void Server_Game::addPlayer(Server_AbstractUserInterface *userInterface,
 
     if (broadcastUpdate) {
         ServerInfo_Game gameInfo;
-        gameInfo.set_room_id(room->getId());
+        getInfo(gameInfo);
-        gameInfo.set_game_id(gameId);
-        gameInfo.set_player_count(getPlayerCount());
-        gameInfo.set_spectators_count(getSpectatorCount());
         emit gameInfoChanged(gameInfo);
     }
 
@@ -588,10 +585,7 @@ void Server_Game::removeParticipant(Server_AbstractParticipant *participant, Eve
     }
 
     ServerInfo_Game gameInfo;
-    gameInfo.set_room_id(room->getId());
+    getInfo(gameInfo);
-    gameInfo.set_game_id(gameId);
-    gameInfo.set_player_count(getPlayerCount());
-    gameInfo.set_spectators_count(getSpectatorCount());
     emit gameInfoChanged(gameInfo);
 }
 
@@ -847,6 +841,12 @@ void Server_Game::getInfo(ServerInfo_Game &result) const
         result.set_player_count(getPlayerCount());
         result.set_started(gameStarted);
         result.mutable_creator_info()->CopyFrom(*getCreatorInfo());
+        const Server_AbstractParticipant *host = participants.value(hostId, nullptr);
+        if (host != nullptr) {
+            result.mutable_host_info()->CopyFrom(*host->getUserInfo());
+        } else {
+            result.mutable_host_info()->CopyFrom(*getCreatorInfo());
+        }
         result.set_only_buddies(onlyBuddies);
         result.set_only_registered(onlyRegistered);
         result.set_spectators_allowed(getSpectatorsAllowed());

libcockatrice_protocol/libcockatrice/protocol/pb/serverinfo_game.proto

@@ -62,4 +62,7 @@ message ServerInfo_Game {
 
     // whether the game is closed. Closed games are finished and can't be interacted with
     optional bool closed = 52;
+
+    // the current host of the game, which may differ from the creator after a host transfer
+    optional ServerInfo_User host_info = 53;
 }

libcockatrice_settings/libcockatrice/settings/game_filters_settings.cpp

@@ -104,14 +104,14 @@ QString GameFiltersSettings::getGameNameFilter() const
     return getValue("gameNameFilter").toString();
 }
 
-void GameFiltersSettings::setCreatorNameFilters(QStringList creatorName)
+void GameFiltersSettings::setHostNameFilters(QStringList hostName)
 {
-    setValue(creatorName, "creatorNameFilter");
+    setValue(hostName, "hostNameFilter");
 }
 
-QStringList GameFiltersSettings::getCreatorNameFilters() const
+QStringList GameFiltersSettings::getHostNameFilters() const
 {
-    return getValue("creatorNameFilter").toStringList();
+    return getValue("hostNameFilter").toStringList();
 }
 
 void GameFiltersSettings::setMinPlayers(int min)

libcockatrice_settings/libcockatrice/settings/game_filters_settings.h

@@ -24,7 +24,7 @@ public:
     bool isHideNotBuddyCreatedGames() const;
     bool isHideOpenDecklistGames() const;
     QString getGameNameFilter() const;
-    QStringList getCreatorNameFilters() const;
+    QStringList getHostNameFilters() const;
     int getMinPlayers() const;
     int getMaxPlayers() const;
     QTime getMaxGameAge() const;
@@ -42,7 +42,7 @@ public:
     void setHidePasswordProtectedGames(bool hide);
     void setHideNotBuddyCreatedGames(bool hide);
     void setGameNameFilter(QString gameName);
-    void setCreatorNameFilters(QStringList creatorName);
+    void setHostNameFilters(QStringList hostName);
     void setMinPlayers(int min);
     void setMaxPlayers(int max);
     void setMaxGameAge(const QTime &maxGameAge);