fix #83, add --dont-change

Author: boramalper

himawaripy/__main__.py

@@ -25,7 +25,7 @@
 
 
 # Semantic Versioning: Major, Minor, Patch
-HIMAWARIPY_VERSION = (2, 0, 1)
+HIMAWARIPY_VERSION = (2, 1, 0)
 counter = None
 HEIGHT = 550
 WIDTH = 550
@@ -62,8 +62,7 @@ def download_chunk(args):
 
     # If the tile data is 2867 bytes, it is a blank "No Image" tile.
     if tiledata.__sizeof__() == 2867:
-        print('No image available for {}.'.format(strftime("%Y/%m/%d %H:%M:%S", latest)))
-        os._exit(3)
+        sys.exit('No image available for {}.'.format(strftime("%Y/%m/%d %H:%M:%S", latest)))
 
     with counter.get_lock():
         counter.value += 1
@@ -96,6 +95,8 @@ def parse_args():
     parser.add_argument("--output-dir", type=str, dest="output_dir",
                         help="directory to save the temporary background image",
                         default=appdirs.user_cache_dir(appname="himawaripy", appauthor=False))
+    parser.add_argument("--dont-change", action="store_true", dest="dont_change", default=False,
+                        help="don't change the wallpaper (just download it)")
 
     args = parser.parse_args()
 
@@ -176,8 +177,12 @@ def thread_main(args):
     os.makedirs(path.dirname(output_file), exist_ok=True)
     png.save(output_file, "PNG")
 
-    if not set_background(output_file):
-        sys.exit("Your desktop environment '{}' is not supported!\n".format(get_desktop_environment()))
+    if not args.dont_change:
+        r = set_background(output_file)
+        if not r:
+            sys.exit("Your desktop environment '{}' is not supported!\n".format(get_desktop_environment()))
+    else:
+        print("Not changing your wallpaper as requested.")
 
 
 def main():

himawaripy/utils.py

@@ -8,70 +8,74 @@
 def set_background(file_path):
     de = get_desktop_environment()
 
-    if de in ["gnome", "unity", "cinnamon", "pantheon", "gnome-classic"]:
-        # Because of a bug and stupid design of gsettings, see http://askubuntu.com/a/418521/388226
-        if de == "unity":
-            subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "draw-background", "false"])
-        subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "picture-uri", "file://" + file_path])
-        subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "picture-options", "scaled"])
-        subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "primary-color", "#000000"])
-        if de == "unity":
-            subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "draw-background", "true"])
-    elif de == "mate":
-        subprocess.call(["gsettings", "set", "org.mate.background", "picture-filename", file_path])
-    elif de == 'i3':
-        subprocess.call(['feh','--bg-max',file_path])
-    elif de == "xfce4":
-        # Xfce4 displays to change the background of
-        displays = subprocess.getoutput('xfconf-query --channel xfce4-desktop --list | grep last-image').split()
-
-        for display in displays:
-            subprocess.call(["xfconf-query", "--channel", "xfce4-desktop", "--property", display, "--set", file_path])
-    elif de == "lxde":
-        subprocess.call(["pcmanfm", "--set-wallpaper", file_path, "--wallpaper-mode=fit", ])
-    elif de == "mac":
+    if de == "mac":
         subprocess.call(["osascript", "-e",
                          'tell application "System Events"\n'
                          'set theDesktops to a reference to every desktop\n'
                          'repeat with aDesktop in theDesktops\n'
                          'set the picture of aDesktop to \"' + file_path + '"\nend repeat\nend tell'])
-    elif de == "kde":
-        if plasma_version() > LooseVersion("5.7"):
-            ''' Command per https://github.com/boramalper/himawaripy/issues/57
-
-                Sets 'FillMode' to 1, which is "Scaled, Keep Proportions"
-                Forces 'Color' to black, which sets the background colour.
-            '''
-            script = 'var a = desktops();' \
-                     'for (i = 0; i < a.length; i++) {{' \
-                     'd = a[i];d.wallpaperPlugin = "org.kde.image";' \
-                     'd.currentConfigGroup = Array("Wallpaper", "org.kde.image", "General");' \
-                     'd.writeConfig("Image", "file://{}");' \
-                     'd.writeConfig("FillMode", 1);' \
-                     'd.writeConfig("Color", "#000");' \
-                     '}}'
-            try:
-                subprocess.check_output(["qdbus", "org.kde.plasmashell", "/PlasmaShell",
-                                         "org.kde.PlasmaShell.evaluateScript", script.format(file_path)])
-            except subprocess.CalledProcessError as e:
-                if "Widgets are locked" in e.output.decode("utf-8"):
-                    print("Cannot change the wallpaper while widgets are locked! (unlock the widgets)")
-                else:
-                    raise e
+    else:  # Linux
+        # gsettings requires it.
+        fetch_envvar("DBUS_SESSION_BUS_ADDRESS")
+        # feh and nitrogen (might) require it.
+        fetch_envvar("DISPLAY")
+
+        if de in ["gnome", "unity", "cinnamon", "pantheon", "gnome-classic"]:
+            # Because of a bug and stupid design of gsettings, see http://askubuntu.com/a/418521/388226
+            if de == "unity":
+                subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "draw-background", "false"])
+            subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "picture-uri", "file://" + file_path])
+            subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "picture-options", "scaled"])
+            subprocess.call(["gsettings", "set", "org.gnome.desktop.background", "primary-color", "#000000"])
+            if de == "unity":
+                assert os.system('bash -c "gsettings set org.gnome.desktop.background draw-background true"') == 0
+        elif de == "mate":
+            subprocess.call(["gsettings", "set", "org.mate.background", "picture-filename", file_path])
+        elif de == 'i3':
+            subprocess.call(['feh', '--bg-max', file_path])
+        elif de == "xfce4":
+            # Xfce4 displays to change the background of
+            displays = subprocess.getoutput('xfconf-query --channel xfce4-desktop --list | grep last-image').split()
+
+            for display in displays:
+                subprocess.call(["xfconf-query", "--channel", "xfce4-desktop", "--property", display, "--set", file_path])
+        elif de == "lxde":
+            subprocess.call(["pcmanfm", "--set-wallpaper", file_path, "--wallpaper-mode=fit", ])
+        elif de == "kde":
+            if plasma_version() > LooseVersion("5.7"):
+                ''' Command per https://github.com/boramalper/himawaripy/issues/57
+    
+                    Sets 'FillMode' to 1, which is "Scaled, Keep Proportions"
+                    Forces 'Color' to black, which sets the background colour.
+                '''
+                script = 'var a = desktops();' \
+                         'for (i = 0; i < a.length; i++) {{' \
+                         'd = a[i];d.wallpaperPlugin = "org.kde.image";' \
+                         'd.currentConfigGroup = Array("Wallpaper", "org.kde.image", "General");' \
+                         'd.writeConfig("Image", "file://{}");' \
+                         'd.writeConfig("FillMode", 1);' \
+                         'd.writeConfig("Color", "#000");' \
+                         '}}'
+                try:
+                    subprocess.check_output(["qdbus", "org.kde.plasmashell", "/PlasmaShell",
+                                             "org.kde.PlasmaShell.evaluateScript", script.format(file_path)])
+                except subprocess.CalledProcessError as e:
+                    if "Widgets are locked" in e.output.decode("utf-8"):
+                        print("Cannot change the wallpaper while widgets are locked! (unlock the widgets)")
+                    else:
+                        raise e
+            else:
+                print("Couldn't detect plasmashell 5.7 or higher.")
+        elif has_program("feh"):
+            print("Couldn't detect your desktop environment ('{}'), but you have "
+                  "'feh' installed so we will use it...".format(de))
+            subprocess.call(["feh", "--bg-max", file_path])
+        elif has_program("nitrogen"):
+            print("Couldn't detect your desktop environment ('{}'), but you have "
+                  "'nitrogen' installed so we will use it...".format(de))
+            subprocess.call(["nitrogen", "--restore"])
         else:
-            print("Couldn't detect plasmashell 5.7 or higher.")
-    elif has_program("feh"):
-        print("Couldn't detect your desktop environment ('{}'), but you have "
-              "'feh' installed so we will use it...".format(de))
-        os.environ['DISPLAY'] = ':0'
-        subprocess.call(["feh", "--bg-max", file_path])
-    elif has_program("nitrogen"):
-        print("Couldn't detect your desktop environment ('{}'), but you have "
-              "'nitrogen' installed so we will use it...".format(de))
-        os.environ["DISPLAY"] = ':0'
-        subprocess.call(["nitrogen", "--restore"])
-    else:
-        return False
+            return False
 
     return True
 
@@ -87,8 +91,11 @@ def get_desktop_environment():
     elif sys.platform == "darwin":
         return "mac"
     else:  # Most likely either a POSIX system or something not much common
+        fetch_envvar("DESKTOP_SESSION")
         desktop_session = os.environ.get("DESKTOP_SESSION")
-        if desktop_session is not None:  # Easier to match if we don't have to deal with caracter cases
+
+        if desktop_session is not None:
+            # Easier to match if we don't have to deal with character cases
             desktop_session = desktop_session.lower()
             if desktop_session in ["gnome", "unity", "cinnamon", "mate", "xfce4", "lxde", "fluxbox",
                                    "blackbox", "openbox", "icewm", "jwm", "afterstep", "trinity", "kde", "pantheon",
@@ -111,6 +118,10 @@ def get_desktop_environment():
                 return "windowmaker"
             elif desktop_session.startswith("peppermint"):
                 return "gnome"
+
+        fetch_envvar("KDE_FULL_SESSION")
+        fetch_envvar("GNOME_DESKTOP_SESSION_ID")
+
         if os.environ.get('KDE_FULL_SESSION') == 'true':
             return "kde"
         elif os.environ.get('GNOME_DESKTOP_SESSION_ID'):
@@ -122,18 +133,19 @@ def get_desktop_environment():
         elif is_running("ksmserver"):
             return "kde"
 
-    # We couldn't detect it so far, so let's try one last time
-    current_desktop = os.environ.get("XDG_CURRENT_DESKTOP")
-    if current_desktop:
-        current_desktop = current_desktop.lower()
-        if current_desktop in ["gnome", "unity", "kde", "gnome-classic", "mate"]:
-            return current_desktop
+        # We couldn't detect it so far, so let's try one last time
+        fetch_envvar("XDG_CURRENT_DESKTOP")
+        current_desktop = os.environ.get("XDG_CURRENT_DESKTOP")
+        if current_desktop:
+            current_desktop = current_desktop.lower()
+            if current_desktop in ["gnome", "unity", "kde", "gnome-classic", "mate"]:
+                return current_desktop
 
-        # Special Cases
-        elif current_desktop == "xfce":
-            return "xfce4"
-        elif current_desktop == "x-cinnamon":
-            return "cinnamon"
+            # Special Cases
+            elif current_desktop == "xfce":
+                return "xfce4"
+            elif current_desktop == "x-cinnamon":
+                return "cinnamon"
 
     return "unknown"
 
@@ -162,3 +174,30 @@ def is_running(process):
         return True
     except subprocess.CalledProcessError:
         return False
+
+
+def fetch_envvar(varname):
+    """
+    When himawaripy is called by cron or an init, the environment variables that
+    are available to us is severely limited, causing problems with some
+    processes we call (such as gsetings [due to lack of
+    $DBUS_SESSION_BUS_ADDRESS for instance]).
+
+    To try fix this issue as much as we can, without resorting to additional
+    shell scripts, we try fetching values of the environment variables we are
+    interested in (before we access them!) from another process. pulseauido
+    seemed to me a good choice, for it's available virtually on all desktop
+    installations (regardless of DE), and seem to have all the environment
+    variables that we are (potentially) interested in (*e.g.* gdm does NOT have
+    $DISPLAY whereas pulseaudio do!)
+    """
+
+    if varname in os.environ:
+        return
+
+    val = os.popen('bash -c "grep -z ^{}= /proc/$(pgrep -n pulseaudio)/environ | cut -d= -f2-"'.format(varname)).read().strip("\0\n")
+    if val:
+        print("Fetched env. var. {} as `{}`".format(varname, val))
+        os.environ[varname] = val
+    else:
+        print("Could NOT retrieve env. var. {}".format(varname))

setup.py

@@ -1,16 +1,19 @@
 from setuptools import setup, find_packages
 
+with open("README.md", "r") as f:
+    long_description = f.read()
 
 setup(
     name="himawaripy",
-    version="2.0.1",
+    version="2.1.0",
     url="http://labs.boramalper.org/himawaripy",
-    author="Mert Bora Alper",
+    author="Bora M. Alper",
     author_email="bora@boramalper.org",
     license="MIT",
-    description="Set near-realtime picture of Earth as your desktop background",
-    long_description="himawaripy is a Python 3 script that fetches near-realtime (10 minutes delayed) picture of Earth "
-                     "as its taken by Himawari 8 (ひまわり8号) and sets it as your desktop background.",
+    description="himawaripy is a Python 3 script that fetches near-realtime (10 minutes delayed) picture of Earth "
+                "as its taken by Himawari 8 (ひまわり8号) and sets it as your desktop background.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
     install_requires=["appdirs", "pillow", "python-dateutil"],
     packages=find_packages(),
     entry_points={"console_scripts": ["himawaripy=himawaripy.__main__:main"]},