#352: Add custom map directory file watcher #358

alexlambson · 2022-08-02T03:49:54Z

Add a file watcher that will detect when a map is added or deleted, then update the game mode dropdown according to the new map list
Add and use CustomMapsDirectory field to MapLoader to avoid hard coded strings.
Add GetLoadedMapBySha1 to remove some duplicate GameModeMaps.Find().
Add a function RefreshGameModeDropdown to modify the dropdown after client is loaded. The function is a bit complicated due to doing inline modifications to the items and keeping the selected mode.

Issue: #352

github-actions · 2022-08-02T03:52:35Z

Nightly build for this pull request:

artifacts.zip
This comment is automatic and is meant to allow guests to get latest automatic builds without registering. It is updated on every successful build.

DXMainClient/Domain/Multiplayer/MapLoader.cs

- Add a file watcher that will detect when a map is added or deleted, then update the game mode dropdown according to the new map list - Add and use `CustomMapsDirectory` field to `MapLoader` to avoid hard coded strings. - Add `GetLoadedMapBySha1` to remove some duplicate `GameModeMaps.Find()`. - Add a function `RefreshGameModeDropdown` to modify the dropdown after client is loaded. The function is a bit complicated due to doing inline modifications to the items and keeping the selected mode. Issue: CnCNet#352 PR: CnCNet#358

… then update the game mode dropdown according to the new map list - Add and use `CustomMapsDirectory` field to `MapLoader` to avoid hard coded strings. - Add `GetLoadedMapBySha1` to remove some duplicate `GameModeMaps.Find()`. - Add a function `RefreshGameModeDropdown` to modify the dropdown after client is loaded. The function is a bit complicated due to doing inline modifications to the items and keeping the selected mode. Issue: CnCNet#352 PR: CnCNet#358

DXMainClient/Domain/Multiplayer/MapLoader.cs

- Address review fedback - Use safe path everywhere - Remove maps if they are renamed and their file extension changes Issue: CnCNet#352 PR: CnCNet#358

DXMainClient/Domain/Multiplayer/MapLoader.cs

DXMainClient/DXGUI/Multiplayer/GameLobby/CnCNetGameLobby.cs

Metadorius

Apparently I wrote a(n incomplete I think) review on some stylistical stuff and forgot to publish it, so I'll leave it here, better late than never :P

DXMainClient/DXGUI/Multiplayer/GameLobby/GameLobbyBase.cs

DXMainClient/Domain/Multiplayer/MapLoader.cs

- Address review feedback - Use safe path everywhere - Remove maps if they are renamed and their file extension changes - Remove unnecessary file watcher filters - sha1 -> SHA-1 Issue: CnCNet#352 PR: CnCNet#358

alexlambson · 2022-10-16T02:11:06Z

I think I addressed all the feedback

Metadorius

You missed some of my earlier stylistical comments and there's something wrong in your code that CI fails, otherwise IMO it's fine.

DXMainClient/Domain/Multiplayer/MapLoader.cs

DXMainClient/Domain/Multiplayer/MapLoaderEventArgs.cs

Rampastring

Does this currently handle a case where existing custom maps are modified? If that is done, the SHA1 for the map in question needs to be recalculated. See FileSystemWatcher.Changed event.

DXMainClient/Domain/Multiplayer/MapLoader.cs

alexlambson · 2022-11-04T04:14:19Z

Does this currently handle a case where existing custom maps are modified? If that is done, the SHA1 for the map in question needs to be recalculated. See FileSystemWatcher.Changed event.

It does not, but the map will still load if you try to play it. The Client can already handle that case. I often just save the map in FA2 then just click "play" and it works.

- Address review feedback to fix comments, make handlers private, and switch one-liners to expressions - Switch MapSharer to download zip to a temp directory to avoid race condition with map file watcher. Issue: CnCNet#352 PR: CnCNet#358

… then update the game mode dropdown according to the new map list - Add and use `CustomMapsDirectory` field to `MapLoader` to avoid hard coded strings. - Add `GetLoadedMapBySha1` to remove some duplicate `GameModeMaps.Find()`. - Add a function `RefreshGameModeDropdown` to modify the dropdown after client is loaded. The function is a bit complicated due to doing inline modifications to the items and keeping the selected mode. Issue: CnCNet#352 PR: CnCNet#358

- Address review feedback - Use safe path everywhere - Remove maps if they are renamed and their file extension changes - Remove unnecessary file watcher filters - sha1 -> SHA-1 Issue: CnCNet#352 PR: CnCNet#358

- Address review feedback to fix comments, make handlers private, and switch one-liners to expressions - Switch MapSharer to download zip to a temp directory to avoid race condition with map file watcher. - Add https://mapdb.cncnet.org/search/ to `downloadmap` help message Issue: CnCNet#352 PR: CnCNet#358

alexlambson · 2022-11-04T07:38:13Z

DXMainClient/DXGUI/Multiplayer/GameLobby/CnCNetGameLobby.cs

@@ -1595,32 +1595,23 @@ private void MapSharer_HandleMapDownloadComplete(SHA1EventArgs e)
        {
            string mapFileName = MapSharer.GetMapFileName(e.SHA1, e.MapName);
            Logger.Log("Map " + mapFileName + " downloaded, parsing.");
-            string mapPath = "Maps/Custom/" + mapFileName;
-            Map map = MapLoader.LoadCustomMap(mapPath, out string returnMessage);


This is now handled by the file watcher to prevent a race condition

alexlambson · 2022-11-04T07:39:37Z

DXMainClient/Domain/Multiplayer/CnCNet/MapSharer.cs

@@ -365,18 +365,27 @@ public static string GetMapFileName(string sha1, string mapName)

        private static string DownloadMain(string sha1, string myGame, string mapName, out bool success)
        {
-            string customMapsDirectory = SafePath.CombineDirectoryPath(ProgramConstants.GamePath, "Maps", "Custom");
+            string customMapsPath = SafePath.CombineDirectoryPath(ProgramConstants.GamePath, "Maps", "Custom");
+            string tempDownloadPath = SafePath.CombineDirectoryPath(ProgramConstants.GamePath, "Maps", "temp");


Use a temporary download directory so that the filewatcher doesn't prematurely load the .map file before it is fully extracted and renamed.

- Address review feedback to fix comments, make handlers private, and switch one-liners to expressions - Switch MapSharer to download zip to a temp directory to avoid race condition with map file watcher. - Add https://mapdb.cncnet.org/search/ to `downloadmap` help message Issue: CnCNet#352 PR: CnCNet#358

alexlambson commented Aug 2, 2022

View reviewed changes

DXMainClient/Domain/Multiplayer/MapLoader.cs Show resolved Hide resolved

alexlambson force-pushed the feat/352-map-file-watcher branch from 52edcd8 to d295e8f Compare August 2, 2022 15:49

alexlambson force-pushed the feat/352-map-file-watcher branch from d295e8f to e75ed55 Compare August 2, 2022 16:29

alexlambson force-pushed the feat/352-map-file-watcher branch from e75ed55 to 664c890 Compare September 26, 2022 04:58

alexlambson force-pushed the feat/352-map-file-watcher branch from 664c890 to 96d0a2e Compare September 26, 2022 05:30

alexlambson requested review from Metadorius and Rans4ckeR September 26, 2022 05:56

Rans4ckeR requested changes Sep 26, 2022

View reviewed changes

DXMainClient/Domain/Multiplayer/MapLoader.cs Outdated Show resolved Hide resolved

DXMainClient/Domain/Multiplayer/MapLoader.cs Outdated Show resolved Hide resolved

alexlambson force-pushed the feat/352-map-file-watcher branch from dddfee1 to 10e0e6c Compare October 1, 2022 02:04

SadPencil requested changes Oct 1, 2022

View reviewed changes

Rans4ckeR reviewed Oct 1, 2022

View reviewed changes

DXMainClient/DXGUI/Multiplayer/GameLobby/CnCNetGameLobby.cs Outdated Show resolved Hide resolved

Metadorius reviewed Oct 9, 2022

View reviewed changes

alexlambson force-pushed the feat/352-map-file-watcher branch from 10e0e6c to 87c34b5 Compare October 16, 2022 02:10

Metadorius requested changes Oct 18, 2022

View reviewed changes

DXMainClient/Domain/Multiplayer/MapLoader.cs Outdated Show resolved Hide resolved

DXMainClient/Domain/Multiplayer/MapLoaderEventArgs.cs Outdated Show resolved Hide resolved

Rampastring requested changes Oct 18, 2022

View reviewed changes

DXMainClient/Domain/Multiplayer/MapLoader.cs Outdated Show resolved Hide resolved

DXMainClient/Domain/Multiplayer/MapLoader.cs Outdated Show resolved Hide resolved

alexlambson added 2 commits November 4, 2022 01:28

CnCNet#352: Add custom map file watcher

d102a6d

- Address review feedback - Use safe path everywhere - Remove maps if they are renamed and their file extension changes - Remove unnecessary file watcher filters - sha1 -> SHA-1 Issue: CnCNet#352 PR: CnCNet#358

alexlambson force-pushed the feat/352-map-file-watcher branch from 537d724 to 1112f70 Compare November 4, 2022 07:29

alexlambson force-pushed the feat/352-map-file-watcher branch from 674a875 to 1112f70 Compare November 4, 2022 07:30

alexlambson force-pushed the feat/352-map-file-watcher branch from 1112f70 to 4af348c Compare November 4, 2022 07:32

alexlambson force-pushed the feat/352-map-file-watcher branch from 4af348c to f43f3f5 Compare November 4, 2022 07:37

alexlambson commented Nov 4, 2022

View reviewed changes

alexlambson force-pushed the feat/352-map-file-watcher branch from f43f3f5 to 55bfd57 Compare November 4, 2022 07:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#352: Add custom map directory file watcher #358

#352: Add custom map directory file watcher #358

alexlambson commented Aug 2, 2022

github-actions bot commented Aug 2, 2022 •

edited

Loading

Metadorius left a comment

alexlambson commented Oct 16, 2022

Metadorius left a comment •

edited

Loading

Rampastring left a comment

alexlambson commented Nov 4, 2022

alexlambson Nov 4, 2022

alexlambson Nov 4, 2022

#352: Add custom map directory file watcher #358

Are you sure you want to change the base?

#352: Add custom map directory file watcher #358

Conversation

alexlambson commented Aug 2, 2022

github-actions bot commented Aug 2, 2022 • edited Loading

Metadorius left a comment

Choose a reason for hiding this comment

alexlambson commented Oct 16, 2022

Metadorius left a comment • edited Loading

Choose a reason for hiding this comment

Rampastring left a comment

Choose a reason for hiding this comment

alexlambson commented Nov 4, 2022

alexlambson Nov 4, 2022

Choose a reason for hiding this comment

alexlambson Nov 4, 2022

Choose a reason for hiding this comment

github-actions bot commented Aug 2, 2022 •

edited

Loading

Metadorius left a comment •

edited

Loading