From 9ac33db795c8f3626eac98b6aa5f5d3b02def2bc Mon Sep 17 00:00:00 2001
From: Mat <m.falkowski@dotmat.de>
Date: Sat, 6 May 2023 07:38:36 +0200
Subject: [PATCH] Fix overwriting existing values in config.json in auto (#418)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

`jq` merge direction in this case is right to left so if the user had
set up custom paths it would replace them with the default ones.

This PR switches the direction to use the defaults as fallback instead
of overwriting user settings.

----
Didn't want to create an issue for the tiny change.

Thanks for your work on the repo, it saved me a lot of time, 👍

---------

Co-authored-by: AbdBarho <ka70911@gmail.com>
---
 .gitignore                           |  4 ++
 services/AUTOMATIC1111/config.json   | 10 ----
 services/AUTOMATIC1111/config.py     | 78 ++++++++++++++++++++++++++++
 services/AUTOMATIC1111/entrypoint.sh |  4 +-
 4 files changed, 84 insertions(+), 12 deletions(-)
 delete mode 100644 services/AUTOMATIC1111/config.json
 create mode 100644 services/AUTOMATIC1111/config.py

diff --git a/.gitignore b/.gitignore
index f64b472..2a011a1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,6 @@
 /.devcontainer
 /docker-compose.override.yml
+
+# VSCode specific
+*.code-workspace
+/.vscode
diff --git a/services/AUTOMATIC1111/config.json b/services/AUTOMATIC1111/config.json
deleted file mode 100644
index 7fff2b7..0000000
--- a/services/AUTOMATIC1111/config.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
-  "outdir_samples": "",
-  "outdir_txt2img_samples": "/output/txt2img",
-  "outdir_img2img_samples": "/output/img2img",
-  "outdir_extras_samples": "/output/extras",
-  "outdir_txt2img_grids": "/output/txt2img-grids",
-  "outdir_img2img_grids": "/output/img2img-grids",
-  "outdir_save": "/output/saved",
-  "font": "DejaVuSans.ttf"
-}
diff --git a/services/AUTOMATIC1111/config.py b/services/AUTOMATIC1111/config.py
new file mode 100644
index 0000000..b8d699e
--- /dev/null
+++ b/services/AUTOMATIC1111/config.py
@@ -0,0 +1,78 @@
+#!/usr/bin/env python3
+
+"""Checks and sets default values for config.json before starting the container."""
+
+import json
+import re
+import os.path
+import sys
+
+DEFAULT_FILEPATH = '/data/config/auto/config.json'
+
+DEFAULT_OUTDIRS = {
+  "outdir_samples": "",
+  "outdir_txt2img_samples": "/output/txt2img",
+  "outdir_img2img_samples": "/output/img2img",
+  "outdir_extras_samples": "/output/extras",
+  "outdir_grids": "",
+  "outdir_txt2img_grids": "/output/txt2img-grids",
+  "outdir_img2img_grids": "/output/img2img-grids",
+  "outdir_save": "/output/saved",
+  "outdir_init_images": "/output/init-images",
+}
+RE_VALID_OUTDIR = re.compile(r"(^/output(/\.?[\w\-\_]+)+/?$)|(^\s?$)")
+
+DEFAULT_OTHER = {
+  "font": "DejaVuSans.ttf",
+}
+
+def dict_to_json_file(target_file: str, data: dict):
+  """Write dictionary to specified json file"""
+
+  with open(target_file, 'w') as f:
+    json.dump(data, f)
+
+def json_file_to_dict(config_file: str) -> dict|None:
+   """Load json file into a dictionary. Return None if file does not exist."""
+
+   if os.path.isfile(config_file):
+    with open(config_file, 'r') as f:
+      return json.load(f)
+   else:
+      return None
+
+def replace_if_invalid(value: str, replacement: str, pattern: str|re.Pattern[str]) -> str:
+  """Returns original value if valid, fallback value if invalid"""
+
+  if re.match(pattern, value):
+    return value
+  else:
+    return replacement
+
+def check_and_replace_config(config_file: str, target_file: str = None):
+  """Checks given file for invalid values. Replaces those with fallback values (default: overwrites file)."""
+
+  # Get current user config, or empty if file does not exists
+  data = json_file_to_dict(config_file) or {}
+
+  # Check and fix output directories
+  for k, def_val in DEFAULT_OUTDIRS.items():
+    if k not in data:
+      data[k] = def_val
+    else:
+      data[k] = replace_if_invalid(value=data[k], replacement=def_val, pattern=RE_VALID_OUTDIR)
+
+  # Check and fix other default settings
+  for k, def_val in DEFAULT_OTHER.items():
+    if k not in data:
+      data[k] = def_val
+
+  # Write results to file
+  dict_to_json_file(target_file or config_file, data)
+
+if __name__ == '__main__':
+  if len(sys.argv) > 1:
+    check_and_replace_config(*sys.argv[1:])
+  else:
+    check_and_replace_config(DEFAULT_FILEPATH)
+
diff --git a/services/AUTOMATIC1111/entrypoint.sh b/services/AUTOMATIC1111/entrypoint.sh
index 5f9e243..54e709c 100755
--- a/services/AUTOMATIC1111/entrypoint.sh
+++ b/services/AUTOMATIC1111/entrypoint.sh
@@ -8,8 +8,8 @@ mkdir -p /data/config/auto/scripts/
 find "${ROOT}/scripts/" -maxdepth 1 -type l -delete
 cp -vrfTs /data/config/auto/scripts/ "${ROOT}/scripts/"
 
-cp -n /docker/config.json /data/config/auto/config.json
-jq '. * input' /data/config/auto/config.json /docker/config.json | sponge /data/config/auto/config.json
+# Set up config file
+python /docker/config.py /data/config/auto/config.json
 
 if [ ! -f /data/config/auto/ui-config.json ]; then
   echo '{}' >/data/config/auto/ui-config.json