auto-join rehosted games

src/main/java/com/faforever/client/chat/ChatService.java

@@ -5,6 +5,7 @@
 import javafx.beans.property.ReadOnlyObjectProperty;
 import javafx.collections.MapChangeListener;
 
+import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 
 public interface ChatService {
@@ -23,6 +24,8 @@ public interface ChatService {
 
   ChatChannelUser getOrCreateChatUser(String username, String channel, boolean isModerator);
 
+  Set<String> getUserChannels(String username);
+
   void addUsersListener(String channelName, MapChangeListener<String, ChatChannelUser> listener);
 
   void addChatUsersByNameListener(MapChangeListener<String, ChatChannelUser> listener);

src/main/java/com/faforever/client/chat/MockChatService.java

@@ -28,7 +28,9 @@
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.HashMap;
+import java.util.HashSet;
 import java.util.Map;
+import java.util.Set;
 import java.util.Timer;
 import java.util.TimerTask;
 import java.util.concurrent.CompletableFuture;
@@ -106,6 +108,11 @@ public Channel getOrCreateChannel(String channelName) {
     return channelUserListListeners.get(channelName);
   }
 
+  @Override
+  public Set<String> getUserChannels(String username) {
+    return new HashSet<>();
+  }
+
   @Override
   public ChatChannelUser getOrCreateChatUser(String username, String channel, boolean isModerator) {
     return null;

src/main/java/com/faforever/client/chat/PircBotXChatService.java

@@ -74,10 +74,12 @@
 import java.time.Instant;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.Set;
 import java.util.TreeMap;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ConcurrentHashMap;
@@ -229,6 +231,16 @@ private ChatChannelUser getOrCreateChatUser(User user, String channelName) {
     return getOrCreateChatUser(username, channelName, isModerator);
   }
 
+  public Set<String> getUserChannels(String username) {
+    Set<String> channelNames = new HashSet<String>();
+    channels.forEach((channelName, channel) -> {
+      if (channel.getUser(username) != null) {
+        channelNames.add(channelName);
+      }
+    });
+    return channelNames;
+  }
+
   private void onMotd(MotdEvent event) {
     sendIdentify(event.getBot().getConfiguration());
   }

src/main/java/com/faforever/client/game/GameService.java

@@ -1,5 +1,6 @@
 package com.faforever.client.game;
 
+import com.faforever.client.chat.ChatService;
 import com.faforever.client.config.ClientProperties;
 import com.faforever.client.discord.DiscordRichPresenceService;
 import com.faforever.client.fa.CloseGameEvent;
@@ -25,6 +26,7 @@
 import com.faforever.client.patch.GameUpdater;
 import com.faforever.client.player.Player;
 import com.faforever.client.player.PlayerService;
+import com.faforever.client.player.SocialStatus;
 import com.faforever.client.preferences.NotificationsPrefs;
 import com.faforever.client.preferences.PreferencesService;
 import com.faforever.client.rankedmatch.MatchmakerInfoMessage;
@@ -146,6 +148,7 @@ public class GameService implements InitializingBean {
   private final DiscordRichPresenceService discordRichPresenceService;
   private final ReplayServer replayServer;
   private final ReconnectTimerService reconnectTimerService;
+  private final ChatService chatService;
 
   @VisibleForTesting
   RatingMode ratingMode;
@@ -179,7 +182,9 @@ public GameService(ClientProperties clientProperties,
                      PlatformService platformService,
                      DiscordRichPresenceService discordRichPresenceService,
                      ReplayServer replayServer,
-                     ReconnectTimerService reconnectTimerService) {
+                     ReconnectTimerService reconnectTimerService,
+                     ChatService chatService) {
+
     this.fafService = fafService;
     this.totalAnnihilationService = totalAnnihilationService;
     this.mapService = mapService;
@@ -197,6 +202,7 @@ public GameService(ClientProperties clientProperties,
     this.discordRichPresenceService = discordRichPresenceService;
     this.replayServer = replayServer;
     this.reconnectTimerService = reconnectTimerService;
+    this.chatService = chatService;
 
     ircHostAndPort = String.format("%s:%d", clientProperties.getIrc().getHost(), 6667);//clientProperties.getIrc().getPort());
     faWindowTitle = clientProperties.getForgedAlliance().getWindowTitle();
@@ -795,9 +801,11 @@ private void onGameInfo(GameInfoMessage gameInfoMessage) {
     Optional<Player> currentPlayerOptional = playerService.getCurrentPlayer();
 
     Game game = createOrUpdateGame(gameInfoMessage);
+    final boolean isGameCurrentGame = Objects.equals(currentGame.get(), game);  // some control paths null out currentGame but we still need to remember this
+
     if (GameStatus.ENDED == game.getStatus()) {
       removeGame(gameInfoMessage);
-      if (!currentPlayerOptional.isPresent() || !Objects.equals(currentGame.get(), game)) {
+      if (!currentPlayerOptional.isPresent() || !isGameCurrentGame) {
         return;
       }
       synchronized (currentGame) {
@@ -819,7 +827,7 @@ private void onGameInfo(GameInfoMessage gameInfoMessage) {
           log.info("[onGameInfo] currentGame(game) because currentPlayerInGame && game.isOpen()");
           currentGame.set(game);
         }
-      } else if (Objects.equals(currentGame.get(), game) && !currentPlayerInGame) {
+      } else if (isGameCurrentGame && !currentPlayerInGame) {
         synchronized (currentGame) {
           log.info("[onGameInfo] currentGame(null) because !currentPlayerInGame");
           currentGame.set(null);
@@ -835,6 +843,46 @@ private void onGameInfo(GameInfoMessage gameInfoMessage) {
         platformService.focusWindow(faWindowTitle);
       }
     });
+
+    if (currentPlayerOptional.isPresent()) {
+      Player currentPlayer = currentPlayerOptional.get();
+      Player hostPlayer = playerService.getPlayerForUsername(game.getHost()).get();
+      Set<String> playerChannels = chatService.getUserChannels(hostPlayer.getUsername());
+      Set<String> currentPlayerChannels = chatService.getUserChannels(currentPlayer.getUsername());
+
+      if (
+          // auto-join if enabled in preferences
+          preferencesService.getPreferences().getAutoJoinEnabled() &&
+
+          // don't try to join own games ... and don't join a foe's game as a way to prevent griefing
+          hostPlayer.getSocialStatus() != SocialStatus.SELF && hostPlayer.getSocialStatus() != SocialStatus.FOE &&
+
+          // game is ripe for joining
+          (hostPlayer.getStatus() == PlayerStatus.HOSTING || hostPlayer.getStatus() == PlayerStatus.HOSTED) &&
+          (game.getStatus() == GameStatus.STAGING || game.getStatus() == GameStatus.BATTLEROOM) &&
+
+          // we don't want to auto-join if we're joined another game already
+          currentPlayer.getStatus() == PlayerStatus.IDLE &&
+          getCurrentGame() == null &&
+
+          // we don't want to rejoin the game we just left (NB getCurrentGame is nulled out on leaving a game.  But isGameCurrentGame is initialised before that)
+          !isGameCurrentGame &&
+
+          // can't join until this information is available
+          game.getMapArchiveName() != null &&
+          game.getMapCrc() != null &&
+
+          // host can prevent auto joins by setting a password
+          !game.isPasswordProtected() &&
+
+          // only auto-join if host shares a common chat channel with us
+          chatService.getUserChannels(currentPlayer.getUsername()).stream().anyMatch(channel ->
+              channel.startsWith("#") && !chatService.isDefaultChannel(channel) && playerChannels.contains(channel))) {
+
+        log.info("auto-joining game: {}", game);
+        this.joinGame(game, null);
+      }
+    }
   }
 
   private Game createOrUpdateGame(GameInfoMessage gameInfoMessage) {
@@ -892,7 +940,6 @@ private double calcAverageRating(GameInfoMessage gameInfoMessage) {
   }
 
   private void updateFromGameInfo(GameInfoMessage gameInfoMessage, Game game) {
-
     game.setId(gameInfoMessage.getUid());
     game.setHost(gameInfoMessage.getHost());
     game.setTitle(StringEscapeUtils.unescapeHtml4(gameInfoMessage.getTitle()));

src/main/java/com/faforever/client/map/MapService.java

@@ -436,8 +436,9 @@ public boolean isOfficialMap(String mapName) {
     return officialMaps.stream().anyMatch(name -> name.equalsIgnoreCase(mapName));
   }
 
-  public boolean isOfficialArchive(Path archiveName) {
-    return officialMapArchives.stream().anyMatch(name -> name.equalsIgnoreCase(archiveName.toString()));
+  public boolean isOfficialArchive(Path archivePath) {
+    String archvieFileName = archivePath.getFileName().toString();
+    return officialMapArchives.stream().anyMatch(name -> name.equalsIgnoreCase(archvieFileName));
   }
 
   /**

src/main/java/com/faforever/client/preferences/Preferences.java

@@ -46,6 +46,7 @@ public class Preferences {
   private final BooleanProperty proactiveResendEnabled;
   private final BooleanProperty ircIntegrationEnabled;
   private final BooleanProperty autoLaunchEnabled;
+  private final BooleanProperty autoJoinEnabled;
   private final BooleanProperty requireUacEnabled;
   // end TA options
   private final ListProperty<String> ignoredNotifications;
@@ -89,6 +90,7 @@ public Preferences() {
     proactiveResendEnabled = new SimpleBooleanProperty(false);
     ircIntegrationEnabled = new SimpleBooleanProperty(false);
     autoLaunchEnabled = new SimpleBooleanProperty(false);
+    autoJoinEnabled = new SimpleBooleanProperty(false);
     requireUacEnabled = new SimpleBooleanProperty(false);
     disallowJoinsViaDiscord = new SimpleBooleanProperty();
     showGameDetailsSidePane = new SimpleBooleanProperty(false);
@@ -156,6 +158,10 @@ public BooleanProperty getAutoLaunchEnabledProperty() {
     return autoLaunchEnabled;
   }
 
+  public BooleanProperty getAutoJoinEnabledProperty() {
+    return autoJoinEnabled;
+  }
+
   public BooleanProperty getRequireUacEnabledProperty() {
     return requireUacEnabled;
   }
@@ -176,6 +182,10 @@ public boolean getAutoLaunchEnabled() {
     return autoLaunchEnabled.get();
   }
 
+  public boolean getAutoJoinEnabled() {
+    return autoJoinEnabled.get();
+  }
+
   public boolean getRequireUacEnabled() {
     return requireUacEnabled.get();
   }

src/main/java/com/faforever/client/preferences/ui/SettingsController.java

@@ -106,6 +106,7 @@ public class SettingsController implements Controller<Node> {
   public CheckBox proactiveResendToggle;
   public CheckBox enableIrcIntegrationToggle;
   public CheckBox enableAutoLaunchToggle;
+  public CheckBox enableAutoJoinToggle;
   public CheckBox requireUacToggle;
   public TableView<TotalAnnihilationPrefs> gameLocationTableView;
   public TableColumn<TotalAnnihilationPrefs, String> gameLocationModTableColumn;
@@ -339,6 +340,7 @@ public void initialize() {
     proactiveResendToggle.selectedProperty().bindBidirectional(preferences.getProactiveResendEnabledProperty());
     enableIrcIntegrationToggle.selectedProperty().bindBidirectional(preferences.getIrcIntegrationEnabledProperty());
     enableAutoLaunchToggle.selectedProperty().bindBidirectional(preferences.getAutoLaunchEnabledProperty());
+    enableAutoJoinToggle.selectedProperty().bindBidirectional(preferences.getAutoJoinEnabledProperty());
     requireUacToggle.selectedProperty().bindBidirectional(preferences.getRequireUacEnabledProperty());
     updateGameLocationTable();
 

src/main/resources/i18n/messages.properties

@@ -820,3 +820,5 @@ game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
 game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_cs.properties

@@ -738,4 +738,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_de.properties

@@ -815,4 +815,6 @@ game.start.tooltip = Ihre Freunde wollen spielen! Klicken Sie hier um TA zu star
 game.leave = Verlassen
 game.start = Starten
 chat.currentGame = Ihr beigetretenes/gehostetes Spiel
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_es.properties

@@ -690,4 +690,6 @@ game.start.tooltip=Tus amigos quieren jugar!\nHaga clic para empezar TA.
 game.leave=Dejar
 game.start=Lanzar
 chat.currentGame=Crear/Conectar a una partida
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_fr.properties

@@ -814,4 +814,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_it.properties

@@ -884,4 +884,6 @@ game.start.tooltip=I tuoi amici vogliono giocare!\nClicca per lanciare TA
 game.leave=Abbandona
 game.start=Inizia
 chat.currentGame=La tua partita
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_iw.properties

@@ -714,4 +714,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_nl.properties

@@ -788,4 +788,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_pl.properties

@@ -685,4 +685,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_ru.properties

@@ -809,4 +809,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_tr.properties

@@ -781,4 +781,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_uk.properties

@@ -678,4 +678,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime

src/main/resources/i18n/messages_zh.properties

@@ -680,4 +680,6 @@ game.start.tooltip=Your friends want to play!\nClick to start TA
 game.leave=Leave
 game.start=Start
 chat.currentGame=Your Hosted/Joined Game
-game.create.install=Set Game Location
+game.create.install=Set Game Location
+settings.fa.enableAutoJoin=Auto-Join Rehosted Games
+settings.fa.enableAutoJoin.description=Auto-join any game created by someone in the same chat channel as yourself.  Of course this does not apply to the default chat channel #coreprime