Add JsonItemDataSource, small cleanup (#24)

Client: Fix onClick -> onPress

Author: MP3Martin

README.md

@@ -10,35 +10,49 @@
 
 ## Usage
 
+### Console / WEB UI
+
 1. Get the GameInv server
-    1. by downloading the [latest build from releases](https://github.com/MP3Martin/GameInv/releases/latest/)
+    1. by downloading the [latest build from releases](https://github.com/MP3Martin/GameInv/releases/latest/) (the one
+       with `.exe` and no `WPF` in its name)
     2. <details><summary>or ...</summary>or download the <a href="https://download-directory.github.io/?url=https%3A%2F%2Fgithub.com%2FMP3Martin%2FGameInv%2Ftree%2Fmain%2Fserver">server folder</a>, extract it and open it in your favourite IDE, install the required dependencies, modify the code however you want and run the program. Or just use any other way to build the project.</details>
 2. Run the program (the server)
 3. Press Y to enter the WS server mode.
-4. Press Y if you want to use [MySQL DB](#mysql). (has to be configured first, otherwise select N)
-5. Open https://mp3martin.github.io/GameInv/ in your browser and everything should connect automatically. Use the
+4. Open https://mp3martin.github.io/GameInv/ in your browser and everything should connect automatically. Use the
    cogwheel on the top right to change settings.
 
 > [!WARNING]  
-> Do not run the server publicly, it is just a demo/showcase and not advanced enough to be secure and handle attacks.
+> Do not run the server publicly, it is just a demo/showcase and not advanced enough to be perfectly secure and handle
+> attacks.
+
+### Windows desktop GUI (WPF)
+
+1. Get GameInv WPF by downloading
+   the [latest build from releases](https://github.com/MP3Martin/GameInv/releases/latest/) (the one with `.exe` and
+   `WPF` in its name)
+2. Run the program
 
 > [!IMPORTANT]  
 > Microsoft Defender sometimes reports the automatically built exes as a virus. The current fix is to allow the `.exe`
 > in Defender.
 
+> [!TIP]  
+> Read [configuration](#configuration)
+
 ## Configuration
 
 ### `.env`
 
 This program allows you to configure various options through the `.env` file or by setting environment variables. The
 `.env` file has to be placed in the same directory as the program executable. The [`.env.example`](server/.env.example)
-file provides a description for these settings, so read it. To use it, rename `.env.example` to `.env` and modify the
+file provides a description for these settings, **so read it**. To use it, rename `.env.example` to `.env` and modify
+the
 values as needed. Note that environment variables set in the system or command line must be prefixed with `GAMEINV_`,
 but the `.env` file does not require this prefix.
 
 ### MySQL
 
-If you want the items to be stored in a database (MySQL is currently the only supported one), then you have to connect
+If you want the items to be stored in a database (specifically MySQL), then you have to connect
 to / start a MySQL server and run the commands inside [gameinv.sql](server/gameinv.sql) to add the schema and the
 tables (find a tutorial elsewhere). Then [configure](#configuration) your program to use the MySQL DB.
 
@@ -47,7 +61,7 @@ tables (find a tutorial elsewhere). Then [configure](#configuration) your progra
 There is also a WPF GUI version of the project in [server/GameInv-WPF](server/GameInv-WPF). It only supports Windows 7+
 and no
 other OS. Tested on Windows 11. That version does not have a WebSocket client, does not have TUI and only has an
-integrated WPF GUI with optional DB connection. The usage is the same as in [usage](#usage), but skip steps 3 and 5. If
+integrated WPF GUI with optional DB connection. If
 you want to download a prebuilt `.exe`, then find the one that has `WPF` in its
 name [in the latest release](https://github.com/MP3Martin/GameInv/releases/latest/).
 

client/src/components/button/AddItemButton.jsx

@@ -15,7 +15,7 @@ export default function AddItemButton () {
 
   return (
     <>
-      <Button color={'primary'} startContent={<IconPlus />} onClick={() => {
+      <Button color={'primary'} startContent={<IconPlus />} onPress={() => {
         onOpen();
       }}>Add an item</Button>
       <ModifyItemModal isOpen={isOpen} onClose={onClose} onOpenChange={onOpenChange} />

client/src/components/button/DeleteItemButton.jsx

@@ -18,7 +18,7 @@ export default function DeleteItemButton ({ item }) {
   return (
     <>
       <Tooltip showArrow content="Delete item" placement="bottom">
-        <Button isIconOnly color="danger" onClick={onOpen}><IconTrash /></Button>
+        <Button isIconOnly color="danger" onPress={onOpen}><IconTrash /></Button>
       </Tooltip>
       <DeleteItemModal isOpen={isOpen} item={item} onClose={onClose} onOpenChange={onOpenChange} />
     </>

client/src/components/button/EditItemButton.jsx

@@ -17,7 +17,7 @@ export default function EditItemButton ({ item }) {
   return (
     <>
       <MyTooltip content="Edit item">
-        <Button isIconOnly variant={'light'} onClick={onOpen}>
+        <Button isIconOnly variant={'light'} onPress={onOpen}>
           <IconEdit className="text-default-500" size={28} />
         </Button>
       </MyTooltip>

client/src/components/button/SimulateTimeButton.jsx

@@ -15,7 +15,7 @@ export default function SimulateTimeButton () {
 
   return (
     <>
-      <Button color={'secondary'} startContent={<IconClock />} onClick={() => {
+      <Button color={'secondary'} startContent={<IconClock />} onPress={() => {
         onOpen();
       }}>Simulate time</Button>
       <SimulateTimeModal isOpen={isOpen} onClose={onClose} onOpenChange={onOpenChange} />

client/src/components/button/UseItemButton.jsx

@@ -23,7 +23,7 @@ export default function UseItemButton ({ item }) {
     <>
       <MyTooltip content="Use item">
         <Button isIconOnly isDisabled={locked || (item.damagePerUse == null)} isLoading={locked} variant={'light'}
-                onClick={() => {
+                onPress={() => {
                   _useItem(item);
                 }}><IconPick className="text-default-500" size={28} /></Button>
       </MyTooltip>

client/src/components/navbar/InfoButton.jsx

@@ -50,7 +50,7 @@ export default function InfoButton ({ tooltipPlacement = 'bottom' }) {
         </div>
       </div>
     } isOpen={isOpen} popoverPlacement={'bottom-end'} title="Info" tooltipPlacement={tooltipPlacement} trigger={
-      <Button isIconOnly size={'md'} variant={'light'} onClick={() => isOpen ? onClose : onOpen}>
+      <Button isIconOnly size={'md'} variant={'light'} onPress={() => isOpen ? onClose : onOpen}>
         <IconInfoCircle className="text-default-500" size={28} />
       </Button>
     } onOpenChange={onOpenChange} />

client/src/components/navbar/SettingsButton.jsx

@@ -17,7 +17,7 @@ export default function SettingsButton ({ tooltipPlacement = 'bottom' }) {
   return (
     <>
       <MyTooltip content="Settings" placement={tooltipPlacement}>
-        <Button isIconOnly size={'md'} variant={'light'} onClick={onOpen}>
+        <Button isIconOnly size={'md'} variant={'light'} onPress={onOpen}>
           <IconSettings className="text-default-500" size={28} />
         </Button>
       </MyTooltip>

server/.env.example

@@ -6,16 +6,38 @@
 #
 # Below are options available in the format of "OPTION_NAME (type, default value) - description"
 # If no default specified below and the option is not set (or has an empty value),
-# then the program may ask for it at runtime.
+# then the program may ask for it at runtime when in console mode. If the option has a default
+# value and no value is set (empty also means no value), then the program will automatically
+# use the default value.
 #
-# - USE_DB (bool) - whether to use MySQL DB
-# - DB_CONNECTION_STRING (string) - the connection string for MySQL
-# - USE_WS_SERVER (bool) - whether to use the WebSocket server (true) or console TUI (false)
+# - STORAGE_TYPE (string, "None") - which data storage to use
+#   - Possible values:
+#     - "None"  - do not save data (will lose data on exit)
+#     - "MySQL" - use MySQL DB; don't forget to set DB_CONNECTION_STRING
+#     - "JSON"  - use a .json file; default path is right next to the executable;
+#                 you can set STORAGE_FILE_PATH to change the path
+# - USE_WS_SERVER (bool) - whether to use the WebSocket server (true) or console TUI (false); ignored in
+#                          WPF mode. If value is not set and console/terminal mode is active,
+#                          a question prompt shows on launch.
+# - DB_CONNECTION_STRING (string, null) - the connection string for MySQL DB
+# - STORAGE_FILE_PATH (string, "GameInv.json") - path to the storage file; applicable only if STORAGE_TYPE is
+#                                                set to something that uses a file. On Windows, use slashes (/)
+#                                                instead of backslashes (\). You can sepcify an absolute or
+#                                                relative path. If only a directory path is specified, then the
+#                                                default file name ("GameInv.json") is automatically added.
 # - WS_URI (string, "ws://0.0.0.0:9081") - URI that the WebSocket server should start with
 # - WS_PASS (string, "changeme") - password for the WebSocket connection (set the same password for your client)
 
-USE_DB=
-DB_CONNECTION_STRING=
+# General options
+STORAGE_TYPE=
 USE_WS_SERVER=
+
+# Database
+DB_CONNECTION_STRING=
+
+# File
+STORAGE_FILE_PATH=
+
+# WebSocket
 WS_URI=
 WS_PASS=

server/GameInv-WPF/Init.cs

@@ -1,9 +1,7 @@
 global using static GameInv_WPF.UtilsNS.Utils;
-global using static GameInv.UtilsNS.Consts;
 global using static GameInv.UtilsNS.Consts.Colors;
 global using static GameInv.UtilsNS.Utils;
 using System.Runtime.InteropServices;
-using System.Windows;
 using GameInv_WPF.UtilsNS;
 using Pastel;
 using Sherlog;
@@ -23,46 +21,14 @@ public static GameInv.GameInv Initialize() {
             InitLogger();
             Log.Info("Starting...");
 
-            var useDb = MyEnv.GetBool("USE_DB");
-            if (useDb is null) {
-                switch (MessageBox.Show("Use database?",
-                            "Question", MessageBoxButton.YesNoCancel)) {
-                    case MessageBoxResult.Cancel or MessageBoxResult.None:
-                    {
-                        Environment.Exit(0);
-                        break;
-                    }
-                    case MessageBoxResult.Yes or MessageBoxResult.OK:
-                    {
-                        useDb = true;
-                        break;
-                    }
-                    case MessageBoxResult.No:
-                    {
-                        useDb = false;
-                        break;
-                    }
-                }
-
-                useDb ??= null!;
-            }
-
-            var dbConnectionString = MyEnv.GetString("DB_CONNECTION_STRING");
-            if ((bool)useDb && dbConnectionString is null) {
-                ErrorPresenter.Present(string.Format(Errors.NoDbConnectionString, EnvPrefix)); // TODO: try setting typeof clasnane
-                Environment.Exit(1);
-            }
-
-            var itemDataSource = (bool)useDb ? CreateItemDataSource(dbConnectionString!) : null;
+            CheckDbConnectionString(ErrorPresenter);
 
             Log.Info($"Creating a new instance of {nameof(GameInv).Pastel(Highlight)}...");
 
             try {
-                return new(ErrorPresenter, itemDataSource: itemDataSource);
+                return new(ErrorPresenter);
             } catch (Exception e) {
-                var msg = e.ToString();
-                Log.Error(msg);
-                ShowErrorMessageBox(msg);
+                ErrorPresenter.Present(e.ToString());
                 Environment.Exit(1);
             }
 

server/GameInv-WPF/UtilsNS/MessageBoxErrorPresenter.cs

@@ -1,11 +1,11 @@
-using GameInv.UtilsNS.ErrorPresenterNS;
+using GameInv.UtilsNS.ErrorPresenter;
 
 namespace GameInv_WPF.UtilsNS {
     public class MessageBoxErrorPresenter : IErrorPresenter {
-        public void Present(string message, Type? classType = null, bool pause = false) {
+        public void Present(string message, bool pause = false) {
             var log = GetLogger(GetCallerClassType());
 
-            log.Error(message);
+            log.Error("\n" + message);
             ShowErrorMessageBox(message);
         }
     }

server/GameInv-WPF/Windows/MainWindow/MainWindow.xaml.cs

@@ -23,6 +23,10 @@ public MainWindow() {
             Items = (ObservableCollection<Item>)_gameInv.Inventory.Items;
 
             DataContext = this;
+
+            Closing += (_, _) => {
+                _gameInv.OnClosing();
+            };
         }
 
         public ObservableCollection<Item> Items { get; } = null!;

server/GameInv/Db/IItemDataSource.cs renamed to server/GameInv/DataSource/IItemDataSource.cs

@@ -1,6 +1,6 @@
 using GameInv.ItemNS;
 
-namespace GameInv.Db {
+namespace GameInv.DataSource {
     public interface IItemDataSource {
         public string SourceName { get; }
 

server/GameInv/DataSource/JsonItemDataSource.cs

@@ -0,0 +1,106 @@
+using System.Text;
+using GameInv.ItemNS;
+using Newtonsoft.Json;
+
+namespace GameInv.DataSource {
+    public class JsonItemDataSource : IItemDataSource {
+        private static readonly Logger Log = GetLogger();
+        private readonly GameInv _gameInv;
+        private readonly ResettableCountdownTimer _saveTimer;
+        private bool _saving;
+        private string _storagePath = null!;
+
+        public JsonItemDataSource(GameInv gameInv) {
+            _gameInv = gameInv;
+            _saveTimer = new(SaveData, 1000);
+
+            _gameInv.Closing += MoreGuaranteedSaveData;
+        }
+
+        public string SourceName => "JSON file";
+
+        public IEnumerable<Item>? GetItems(out string? errorMessage) {
+            errorMessage = null;
+            void LogFileLocationInfo() {
+                Log.Info($"{SourceName} location: {_storagePath}");
+            }
+
+            try {
+                const string defaultFileName = "GameInv.json";
+                _storagePath = MyEnv.GetString("STORAGE_FILE_PATH") ?? defaultFileName;
+                _storagePath = Path.GetFullPath(_storagePath, AppDomain.CurrentDomain.BaseDirectory);
+                if (Directory.Exists(_storagePath)) {
+                    _storagePath = Path.Combine(_storagePath, defaultFileName);
+                }
+
+                if (!File.Exists(_storagePath)) {
+                    Log.Info($"{SourceName} doesn't exist, creating.");
+                    File.WriteAllText(_storagePath, "[]");
+                    LogFileLocationInfo();
+                    return [];
+                }
+
+                LogFileLocationInfo();
+
+                var saveData = File.ReadAllText(_storagePath, Encoding.UTF8);
+                var itemsAsItemData = JsonConvert.DeserializeObject<ItemData[]>(saveData);
+                var items = itemsAsItemData?.Select(i => (Item)i).ToArray();
+                return items;
+            } catch (Exception ex) {
+                errorMessage = FormatException(ex);
+                return null;
+            }
+        }
+
+        public bool UpdateItem(Item item) {
+            return ResetSaveTimer();
+        }
+
+        public bool UpdateItems(IEnumerable<Item> items) {
+            return ResetSaveTimer();
+        }
+
+        public bool RemoveItem(Item item) {
+            return ResetSaveTimer();
+        }
+
+        public bool RemoveItems(IEnumerable<Item> items) {
+            return ResetSaveTimer();
+        }
+
+        private void SaveData() {
+            if (_saving) return;
+            _saving = true;
+            Log.Info("Started saving...");
+            try {
+                var itemsAsItemData = _gameInv.Inventory.Select(i => (ItemData)i).ToArray();
+                var saveData = JsonConvert.SerializeObject(itemsAsItemData);
+                File.WriteAllText(_storagePath, saveData);
+                Log.Info($"Saved data to {SourceName}");
+            } catch (Exception ex) {
+                _gameInv.ErrorPresenter.Present("Error saving data.\n\n" + FormatException(ex));
+            } finally {
+                _saving = false;
+            }
+        }
+
+        /// <summary>
+        ///     Tries to wait for previous saving to finish and then calls <see cref="SaveData" />.
+        ///     Gives up after 5 seconds.
+        /// </summary>
+        private void MoreGuaranteedSaveData() {
+            const int timeoutSeconds = 5;
+            if (SpinWait.SpinUntil(() => _saving == false, timeoutSeconds * 1000)) {
+                SaveData();
+            } else {
+                _gameInv.ErrorPresenter.Present($"Previous save operation didn't finish " +
+                    $"in {timeoutSeconds}+ seconds. Some data may be lost.");
+            }
+        }
+
+        private bool ResetSaveTimer() {
+            _saveTimer.Reset();
+            return true;
+        }
+    }
+}