Merge pull request automatic-ripping-machine#1694 from xieve/fix-read-only

[BUGFIX] Gracefully handle read-only config files

Author: microtechno9000

VERSION

@@ -1 +1 @@
-2.22.2
+2.22.3

arm/config/config.py

@@ -30,48 +30,46 @@ def _load_abcde(fp):
 
 # arm config, open and read yaml contents
 # handle arm.yaml migration here
-# 1. Load both current and template arm.yaml
+# Load user config
 cur_cfg = _load_config(arm_config_path)
-new_cfg = _load_config(os.path.join(cur_cfg['INSTALLPATH'], "setup/arm.yaml"))
+# Load template config
+arm_config = _load_config(os.path.join(cur_cfg["INSTALLPATH"], "setup/arm.yaml"))
 
-# 2. If the dicts do not have the same number of keys
-if len(cur_cfg) != len(new_cfg):
-    # 3. Update new dict with current values
-    for key in cur_cfg:
-        if key in new_cfg:
-            new_cfg[key] = cur_cfg[key]
+# Update the template config with the user's values
+arm_config.update(cur_cfg)
 
-    # 4. Save the dictionary
-    with open(
+try:
+    # Save the dictionary
+    with open(arm_config_path, "w") as settings_file:
+        with open(
             os.path.join(cur_cfg["INSTALLPATH"], "arm/ui/comments.json"),
             "r",
-    ) as comments_file:
-        comments = json.load(comments_file)
-
-    arm_cfg = comments['ARM_CFG_GROUPS']['BEGIN'] + "\n\n"
-    for key, value in dict(new_cfg).items():
-        # Add any grouping comments
-        arm_cfg += config_utils.arm_yaml_check_groups(comments, key)
-        # Check for comments for this key in comments.json, add them if they exist
-        try:
-            arm_cfg += "\n" + comments[str(key)] + "\n" if comments[str(key)] != "" else ""
-        except KeyError:
-            arm_cfg += "\n"
-        # test if key value is an int
-        value = str(value)  # just change the type to keep things as expected
-        try:
-            post_value = int(value)
-            arm_cfg += f"{key}: {post_value}\n"
-        except ValueError:
-            # Test if value is Boolean
-            arm_cfg += config_utils.arm_yaml_test_bool(key, value)
-
-    # this handles the truncation
-    with open(arm_config_path, "w") as settings_file:
+        ) as comments_file:
+            comments = json.load(comments_file)
+
+        arm_cfg = comments["ARM_CFG_GROUPS"]["BEGIN"] + "\n\n"
+        for key, value in dict(arm_config).items():
+            # Add any grouping comments
+            arm_cfg += config_utils.arm_yaml_check_groups(comments, key)
+            # Check for comments for this key in comments.json, add them if they exist
+            try:
+                if comment := comments[str(key)]:
+                    arm_cfg += f"\n{comment}\n"
+            except KeyError:
+                arm_cfg += "\n"
+            # test if key value is an int
+            value = str(value)  # just change the type to keep things as expected
+            try:
+                post_value = int(value)
+                arm_cfg += f"{key}: {post_value}\n"
+            except ValueError:
+                # Test if value is Boolean
+                arm_cfg += config_utils.arm_yaml_test_bool(key, value)
+
         settings_file.write(arm_cfg)
         settings_file.close()
-
-arm_config = _load_config(arm_config_path)
+except OSError:
+    pass
 
 # abcde config file, open and read contents
 abcde_config_path = arm_config["ABCDE_CONFIG_FILE"]

arm/ui/settings/settings.py

@@ -56,6 +56,10 @@ def mask_last(value, n=4):
     return value[:-n] + '*' * n if len(value) > n else '*' * len(value)
 
 
+def is_read_only(path: os.PathLike) -> bool:
+    return not os.access(path, os.W_OK)
+
+
 route_settings.add_app_template_filter(mask_last, name='mask_last')
 
 
@@ -134,7 +138,10 @@ def settings():
                            arm_path=arm_path,
                            media_path=media_path,
                            drives=drives,
-                           form_drive=form_drive)
+                           form_drive=form_drive,
+                           ripper_read_only=is_read_only(cfg.arm_config_path),
+                           apprise_read_only=is_read_only(cfg.apprise_config_path),
+                           abcde_read_only=is_read_only(cfg.abcde_config_path))
 
 
 def check_hw_transcode_support():
@@ -185,16 +192,19 @@ def save_settings():
         # Build the new arm.yaml with updated values from the user
         arm_cfg = ui_utils.build_arm_cfg(request.form.to_dict(), comments)
         # Save updated arm.yaml
-        with open(cfg.arm_config_path, "w") as settings_file:
-            settings_file.write(arm_cfg)
-            settings_file.close()
-        success = True
-        importlib.reload(cfg)
-        # Set the ARM Log level to the config
-        app.logger.info(f"Setting log level to: {cfg.arm_config['LOGLEVEL']}")
-        app.logger.setLevel(cfg.arm_config['LOGLEVEL'])
+        try:
+            with open(cfg.arm_config_path, "w") as settings_file:
+                settings_file.write(arm_cfg)
+                settings_file.close()
+            success = True
+            importlib.reload(cfg)
+            # Set the ARM Log level to the config
+            app.logger.info(f"Setting log level to: {cfg.arm_config['LOGLEVEL']}")
+            app.logger.setLevel(cfg.arm_config['LOGLEVEL'])
+        except OSError as e:
+            # arm.yaml is read-only
+            app.logger.error(f"{cfg.arm_config_path} is read-only", exc_info=e)
 
-    # If we get to here there was no post data
     return {'success': success, 'settings': cfg.arm_config, 'form': 'arm ripper settings'}
 
 
@@ -246,12 +256,15 @@ def save_abcde():
         # Windows machines can put \r\n instead of \n newlines, which corrupts the config file
         clean_abcde_str = '\n'.join(abcde_cfg_str.splitlines())
         # Save updated abcde.conf
-        with open(cfg.abcde_config_path, "w") as abcde_file:
-            abcde_file.write(clean_abcde_str)
-            abcde_file.close()
-        success = True
-        # Update the abcde config
-        cfg.abcde_config = clean_abcde_str
+        try:
+            with open(cfg.abcde_config_path, "w") as abcde_file:
+                abcde_file.write(clean_abcde_str)
+                abcde_file.close()
+            success = True
+            # Update the abcde config
+            cfg.abcde_config = clean_abcde_str
+        except OSError as e:
+            app.logger.error(f"{cfg.abcde_config_path} is read-only", exc_info=e)
 
     # If we get to here, there was no post-data
     return {'success': success,
@@ -273,11 +286,14 @@ def save_apprise_cfg():
         # Save updated apprise.yaml
         # Build the new arm.yaml with updated values from the user
         apprise_cfg = ui_utils.build_apprise_cfg(request.form.to_dict())
-        with open(cfg.apprise_config_path, "w") as settings_file:
-            settings_file.write(apprise_cfg)
-            settings_file.close()
-        success = True
-        importlib.reload(cfg)
+        try:
+            with open(cfg.apprise_config_path, "w") as settings_file:
+                settings_file.write(apprise_cfg)
+                settings_file.close()
+            success = True
+            importlib.reload(cfg)
+        except OSError as e:
+            app.logger.error(f"{cfg.apprise_config_path} is read-only", exc_info=e)
     # If we get to here there was no post data
     return {'success': success, 'settings': cfg.apprise_config, 'form': 'Apprise config'}
 

arm/ui/settings/templates/settings/abcde.html

@@ -7,7 +7,13 @@ <h4> Music Config </h4>
                     {{ form.hidden_tag() }}
                     <label for="abcdeConfigText">ABCDE Config:</label>
                     <textarea id="abcdeConfigText" name="abcdeConfig" spellcheck="false"
-                              class="w-100 form-control min-vh-100">{{ abcde_cfg }}</textarea>
+                              class="w-100 form-control min-vh-100"
+                              {% if abcde_read_only %}
+                                disabled="" title="abcde.conf is read-only"
+                              {% endif %}
+                              >
+                              {{ abcde_cfg }}
+                            </textarea>
                     <br>
                     <button id="abcdeConfigSubmit" class="btn btn-secondary btn-lg btn-block"
                             form="abcdeSettings">Submit

arm/ui/settings/templates/settings/apprise.html

@@ -11,7 +11,10 @@ <h4> Apprise Notification Service </h4>
                 <span class="input-group-text" id="{{ k }}">{{ k }}: </span>
             </div>
             <input type="text" class="form-control" aria-label="{{ k }}" name="{{ k }}" placeholder="{{ v }}"
-                   value="{{ v }}" aria-describedby="{{ k }}">
+                   value="{{ v }}" aria-describedby="{{ k }}"
+                   {% if apprise_read_only %}
+                     disabled="" title="apprise.yaml is read-only"
+                   {% endif %}>
         </div>
         {% endfor %}
         <button id="apprise_cfg" class="btn btn-secondary btn-lg btn-block" form="appriseCfg"

arm/ui/settings/templates/settings/ripper.html

@@ -9,7 +9,10 @@ <h4> Ripper ARM Settings </h4>
                         <span class="input-group-text" id="{{ k }}">{{ k }}: </span>
                     </div>
                     <input type="text" class="form-control" aria-label="{{ k }}" name="{{ k }}"
-                           placeholder="{{ v }}" value="{{ v }}" aria-describedby="{{ k }}">
+                           placeholder="{{ v }}" value="{{ v }}" aria-describedby="{{ k }}"
+                           {% if ripper_read_only %}
+                             disabled="" title="arm.yaml is read-only"
+                           {% endif %}>
                     <a class="popovers" onClick='return false;' href=""
                        data-content="{{ jsoncomments[k]| replace("#", "\n") }}" rel="popover"
                        data-placement="top" data-original-title="{{ k }}">