feat: allow passing an image file to 'file' option

refs: #275

Author: luisbocanegra

pyproject.toml

@@ -23,6 +23,7 @@ dependencies = [
     "numpy>=1.20",
     "pillow>=9.2.0",
     "materialyoucolor>=2.0.8",
+    "python-magic>=0.4.27",
 ]
 
 [project.scripts]

src/kde_material_you_colors/data/sample_config.conf

@@ -10,11 +10,14 @@
 # Default is 0
 monitor = 0
 
-# File containing absolute path of an image (Takes precedence over automatic wallpaper detection)
+# Custom file for color generation
+# Can take a image file or a plain text file containing absolute path of the image
+# Takes precedence over automatic wallpaper detection
 # Commented by default
 #file = /tmp/000_eDP-1_current_wallpaper
 
-# Custom color used to generate M3 color scheme (Takes precedence over automatic wallpaper detection, monitor and file options)
+# Custom color used to generate M3 color scheme
+# Takes precedence over automatic wallpaper detection, monitor and file options
 # Accepted values are hex (e.g #ff0000) and rgb (e.g 255,0,0) colors (rgb is converted to hex)
 #color = 255,0,1
 

src/kde_material_you_colors/main.py

@@ -42,7 +42,7 @@ def main():
         "--file",
         "-f",
         type=str,
-        help="Text file that contains wallpaper absolute path (Takes precedence over automatic wallpaper detection and --color options)",
+        help="Image or plain text file containing the absolute path of an image (Takes precedence over automatic wallpaper detection and --color options)",
         default=None,
         metavar="<filename>",
     )

src/kde_material_you_colors/utils/file_utils.py

@@ -1,7 +1,8 @@
-import PIL
-import PIL.Image
 import os
 import hashlib
+import PIL
+import PIL.Image
+import magic
 
 
 def get_last_modification(file):
@@ -64,3 +65,20 @@ def get_file_sha1(file_path):
                     return file_sha1
             except Exception as e:
                 print(f"Error:\n{e}")
+
+
+def is_plain_text(file_path):
+    """Check if a file is plain text
+
+    Args:
+        file_path (str): Absolute path of file
+    Returns:
+        bool: True if plain text, False otherwise
+    """
+    if file_path is not None:
+        if os.path.exists(file_path):
+            try:
+                return magic.from_file(file_path, mime=True) == "text/plain"
+            except Exception as e:
+                print(f"Error:\n{e}")
+                return False

src/kde_material_you_colors/utils/wallpaper_utils.py

@@ -8,6 +8,7 @@
 from kde_material_you_colors.utils import math_utils
 from kde_material_you_colors.utils import kwin_utils
 from kde_material_you_colors.config import Configs
+from kde_material_you_colors.utils.file_utils import is_plain_text
 
 
 class WallpaperReader:
@@ -54,15 +55,23 @@ def validate_file(self):
             # TODO: detect image file too
             self._type = "image"
             if os.path.exists(self._file):
-                with open(self._file, encoding="utf-8") as text_file:
-                    wallpaper = str(text_file.read()).replace("file://", "").strip()
-                    if wallpaper:
-                        self._source = wallpaper
+                if is_plain_text(self._file):
+                    with open(self._file, encoding="utf-8") as text_file:
+                        self._source = (
+                            str(text_file.read()).replace("file://", "").strip()
+                        )
+                else:
+                    self._source = self._file
             else:
                 error = f"File '{self._file}' does not exist"
                 logging.error(error)
                 self._error = error
 
+            if self._source and not os.path.exists(self._source):
+                error = f"Resolved file '{self._source}' does not exist"
+                logging.error(error)
+                self._error = error
+
     @property
     def plugin(self):
         return self._plugin