]> code.delx.au - bg-scripts/blobdiff - wallchanger.py
Replace KDE/WindowMaker with XFCE4/xloadimage
[bg-scripts] / wallchanger.py
index b20c0683b84404326f3afd5f2b1fdc27d639a74b..2bbd6f95179db90331052c7387e5e0fdf0bb2ca2 100755 (executable)
@@ -1,11 +1,16 @@
-#!/usr/bin/env python
+#!/usr/bin/env python2
+
 # Copyright 2008 Greg Darke <greg@tsukasa.net.au>
 # Copyright 2008 James Bunton <jamesbunton@fastmail.fm>
 # Licensed for distribution under the GPL version 2, check COPYING for details
 # This is a cross platform/cross window manager way to change your wallpaper
 
-import commands, sys, os, os.path, subprocess, time
-from logging import debug, info, warning
+import commands, sys, os, os.path, time
+import logging
+try:
+       import PIL, PIL.Image
+except ImportError:
+       PIL = None
 
 __all__ = ("init", "set_image")
 
@@ -13,17 +18,26 @@ __all__ = ("init", "set_image")
 changers = []
 
 def set_image(filename):
-       info("Setting image: %s" % filename)
+       logging.info("Setting image: %s", filename)
        for changer in changers:
                if not changer.set_image(filename):
-                       warning("Failed to set background: wallchanger.set_image(%s), changer=%s" % (filename, changer))
+                       logging.warning("Failed to set background: wallchanger.set_image(%s), changer=%s", filename, changer)
+
+def check_cmd(cmd):
+       return commands.getstatusoutput(cmd)[0] == 0
 
 def init(*args, **kwargs):
        """Desktop Changer factory"""
 
-       debug("Testing for OSX (NonX11)")
-       if commands.getstatusoutput("ps ax -o command -c|grep -q WindowServer")[0] == 0:
-               changers.append(OSXChanger(*args, **kwargs))
+       classes = []
+
+       if sys.platform == "win32":
+               classes.append(WIN32Changer)
+               return
+
+       logging.debug("Testing for OSX (NonX11)")
+       if check_cmd("ps ax -o command -c|grep -q WindowServer"):
+               classes.append(OSXChanger)
 
        if 'DISPLAY' not in os.environ or os.environ['DISPLAY'].startswith('/tmp/launch'):
                # X11 is not running
@@ -31,40 +45,77 @@ def init(*args, **kwargs):
        else:
                if os.uname()[0] == 'Darwin':
                        # Try to detect if the X11 server is running on OSX
-                       if commands.getstatusoutput("ps ax -o command|grep -q '/.*X11 .* %s'" % os.environ['DISPLAY'])[0] != 0:
+                       if check_cmd("ps ax -o command|grep -q '^/.*X11 .* %s'" % os.environ['DISPLAY']):
                                # X11 is not running for this display
                                return
 
-       debug("Testing for KDE")
-       if commands.getstatusoutput("xwininfo -name 'KDE Desktop'")[0] == 0:
-               changers.append(KDEChanger(*args, **kwargs))
+       logging.debug("Testing for XFCE4")
+       if check_cmd("xwininfo -name 'xfce4-session'"):
+               classes.append(Xfce4Changer)
+
+       logging.debug("Testing for Gnome")
+       if check_cmd("xwininfo -name 'gnome-settings-daemon'"):
+               if check_cmd("gsettings get org.gnome.desktop.background picture-uri"):
+                       classes.append(Gnome3Changer)
+               else:
+                       classes.append(Gnome2Changer)
 
-       debug("Testing for Gnome")
-       if commands.getstatusoutput("xwininfo -name 'gnome-session'")[0] == 0:
-               changers.append(GnomeChanger(*args, **kwargs))
+       logging.debug("Testing for xloadimage")
+       if check_cmd("which xloadimage"):
+               classes.append(XLoadImageChanger)
 
-       debug("Testing for WMaker")
-       if commands.getstatusoutput("xlsclients | grep -qi wmaker")[0] == 0:
-               changers.append(WMakerChanger(*args, **kwargs))
-       
-       if len(changers) == 0:
+       if len(classes) == 0:
                raise Exception("Unknown window manager")
 
+       for klass in classes:
+               changers.append(klass(*args, **kwargs))
+
 
 class BaseChanger(object):
        name = "undefined"
-       def __init__(self, background_color='black', permanent=False, convert=False):
-               info('Determined the window manager is "%s"' % self.name)
+       def __init__(self, background_color='black', convert=False):
+               logging.info('Determined the window manager is "%s"', self.name)
                self.background_color = background_color
-               self.permanent = permanent
                self.convert = convert
 
+       try:
+               def _exec_cmd(self, cmd):
+                       import subprocess
+                       return subprocess.Popen(cmd, stdout=sys.stdout, stderr=sys.stderr, stdin=None).wait()
+
+       except ImportError:
+               # A simple implementation of subprocess for python2.4
+               def _exec_cmd(self, cmd):
+                       """Runs a program given in cmd"""
+                       return os.spawnvp(os.P_WAIT, cmd[0], cmd)
+
        def set_image(self, filename):
                raise NotImplementedError()
 
-class WMakerChanger(BaseChanger):
-       name = "WindowMaker"
-       _ConvertedWallpaperLocation = '/tmp/wallpapers_wmaker/'
+       def convert_image_format(self, filename, format='BMP', allowAlpha=False, extension='.bmp'):
+               """Convert the image to another format, and store it in a local place"""
+               if not os.path.exists(filename):
+                       logger.warn('The input file "%s" does not exist, so it will not be converted', filename)
+                       return filename, False
+               if PIL is None:
+                       logger.warn('PIL could not be found, not converting image format')
+                       return filename, False
+
+               self.remove_old_image_cache()
+               output_name = os.path.join(self._ConvertedWallpaperLocation, '%s%s' % (time.time(), extension))
+               img = PIL.Image.open(filename)
+
+               # Remove the alpha channel if the user doens't want it
+               if not allowAlpha and img.mode == 'RGBA':
+                       img = img.convert('RGB')
+               img.save(output_name, format)
+
+               return output_name, True
+
+
+class XLoadImageChanger(BaseChanger):
+       name = "xloadimage"
+       _ConvertedWallpaperLocation = '/tmp/wallpapers_xloadimage/'
        def remove_old_image_cache(self):
                """Cleans up any old temp images"""
                if not os.path.isdir(self._ConvertedWallpaperLocation):
@@ -75,32 +126,28 @@ class WMakerChanger(BaseChanger):
                        for dirname in dirnames:
                                os.unlink(os.path.join(fullpath, dirname))
 
-       def convert_image_format(self, file):
+       def convert_image_format(self, filename):
                """Convert the image to a png, and store it in a local place"""
                self.remove_old_image_cache()
                output_name = os.path.join(self._ConvertedWallpaperLocation, '%s.png' % time.time())
-               cmd = ["convert", '-resize', '1280', '-gravity', 'Center', '-crop', '1280x800+0+0', file, output_name]
-               debug("""Convert command: '"%s"'""" % '" "'.join(cmd))
-               return output_name, subprocess.Popen(cmd, stdout=sys.stdout, stderr=sys.stderr, stdin=None).wait()
+               cmd = ["convert", filename, output_name]
+               logging.debug("""Convert command: '"%s"'""", '" "'.join(cmd))
+               return output_name, self._exec_cmd(cmd)
 
-       def set_image(self, file):
+       def set_image(self, filename):
                if self.convert:
-                       file, convert_status = self.convert_image_format(file)
+                       filename, convert_status = self.convert_image_format(filename)
                        if convert_status:
-                               debug('Convert failed')
-               cmd = ["wmsetbg", 
-                       "-b", self.background_color, # Sets the background colour to be what the user specified
-                       "-S", # 'Smooth' (WTF?)
-                       "-e", # Center the image on the screen (only affects when the image in no the in the correct aspect ratio
-###                    "-a", # scale the image, keeping the aspect ratio
-                       "-u", # Force this to be the default background
-                       "-d"  # dither
-                       ]
-               if self.permanent:
-                       cmd += ["-u"] # update the wmaker database
-               cmd += [file]
-               debug('''WMaker bgset command: "'%s'"''' % "' '".join(cmd))
-               return not subprocess.Popen(cmd, stdout=sys.stdout, stderr=sys.stderr, stdin=None).wait()
+                               logging.debug('Convert failed')
+               cmd = [
+                       "xloadimage",
+                       "-onroot",
+                       "-fullscreen",
+                       "-border", "black",
+                       filename,
+               ]
+               logging.debug('''WMaker bgset command: "'%s'"''', "' '".join(cmd))
+               return not self._exec_cmd(cmd)
 
 class OSXChanger(BaseChanger):
        name = "Mac OS X"
@@ -109,7 +156,6 @@ class OSXChanger(BaseChanger):
 
        def __init__(self, *args, **kwargs):
                BaseChanger.__init__(self, *args, **kwargs)
-               self.fix_desktop_plist()
 
        def remove_old_image_cache(self):
                """Cleans up any old temp images"""
@@ -121,20 +167,17 @@ class OSXChanger(BaseChanger):
                        for dirname in dirnames:
                                os.unlink(os.path.join(fullpath, dirname))
 
-       def convert_image_format(self, file):
+       def convert_image_format(self, filename):
                """Convert the image to a png, and store it in a local place"""
                self.remove_old_image_cache()
                output_name = os.path.join(self._ConvertedWallpaperLocation, '%s.png' % time.time())
                try:
-                       import PIL, PIL.Image
-                       img = PIL.Image.open(file)
-                       img.save(output_name, "PNG")
-                       return output_name, True
+                       return super(OSXChanger, self).convert_image_format(filename, format='PNG', extension='.png')
                except ImportError:
-                       debug('Could not load PIL, going to try just copying the image')
+                       logging.debug('Could not load PIL, going to try just copying the image')
                        import shutil
-                       output_name = os.path.join(self._ConvertedWallpaperLocation, os.path.basename(file))
-                       shutil.copyfile(file, output_name)
+                       output_name = os.path.join(self._ConvertedWallpaperLocation, os.path.basename(filename))
+                       shutil.copyfile(filename, output_name)
                        return output_name, True
 
        def fix_desktop_plist(self):
@@ -150,47 +193,89 @@ class OSXChanger(BaseChanger):
                        # Store the plist again (Make sure we write it out atomically -- Don't want to break finder)
                        desktop_plist.writeToFile_atomically_(self._DesktopPlistLocation, True)
                except ImportError:
-                       debug('Could not import the Foundation module, you may have problems with dual screens')
+                       logging.debug('Could not import the Foundation module, you may have problems with dual screens')
 
        def set_image(self, filename):
+               self.fix_desktop_plist()
                if self.convert:
                        filename, ret = self.convert_image_format(filename)
                        if not ret:
-                               debug("Convert failed")
+                               logging.debug("Convert failed")
                                return False
                cmd = """osascript -e 'tell application "finder" to set desktop picture to posix file "%s"'""" % filename
-               debug(cmd)
+               logging.debug(cmd)
                return not commands.getstatusoutput(cmd)[0]
 
-class GnomeChanger(BaseChanger):
-       name = "Gnome"
-       def set_image(self, file):
-               cmd = ['gconftool-2', '--type', 'string', '--set', '/desktop/gnome/background/picture_filename', file]
-               debug(cmd)
-               return not subprocess.Popen(cmd, stdout=sys.stdout, stderr=sys.stderr, stdin=None).wait()
-
-class KDEChanger(BaseChanger):
-       name = "KDE"
-       def set_image(self, file):
-               cmds = []
-               for group in ('Desktop0', 'Desktop0Screen0'):
-                       base = ['kwriteconfig', '--file', 'kdesktoprc', '--group', group, '--key']
-                       cmds.append(base + ['Wallpaper', file])
-                       cmds.append(base + ['UseSHM', '--type', 'bool', 'true'])
-                       cmds.append(base + ['WallpaperMode', 'ScaleAndCrop'])
-                       cmds.append(base + ['MultiWallpaperMode', 'NoMulti'])
-
-               cmds.append(['dcop', 'kdesktop', 'KBackgroundIface', 'configure'])
-               for cmd in cmds:
-                       debug(cmd)
-                       if subprocess.Popen(cmd, stdout=sys.stdout, stderr=sys.stderr, stdin=None).wait() != 0:
+class WIN32Changer(BaseChanger):
+       name = "Windows"
+       _ConvertedWallpaperLocation = os.path.join(os.environ.get('APPDATA', os.path.expanduser('~')), 'wallchanger')
+
+       def __init__(self, *args, **kwargs):
+               BaseChanger.__init__(self, *args, **kwargs)
+               if not self.convert:
+                       logging.warn('Running on windows, but convert is not set')
+
+       def remove_old_image_cache(self):
+               """Cleans up any old temp images"""
+               if not os.path.isdir(self._ConvertedWallpaperLocation):
+                       os.mkdir(self._ConvertedWallpaperLocation)
+               for fullpath, filenames, dirnames in os.walk(self._ConvertedWallpaperLocation, topdown=False):
+                       for filename in filenames:
+                               os.unlink(os.path.join(fullpath, filename))
+                       for dirname in dirnames:
+                               os.unlink(os.path.join(fullpath, dirname))
+
+       def set_image(self, filename):
+               import ctypes
+               user32 = ctypes.windll.user32
+
+               # Taken from the Platform SDK
+               SPI_SETDESKWALLPAPER = 20
+               SPIF_SENDWININICHANGE = 2
+
+               if self.convert:
+                       filename, ret = self.convert_image_format(filename)
+                       if not ret:
+                               logging.debug("Convert failed")
                                return False
 
+               # Parameters for SystemParametersInfoA are:
+               # (UINT uiAction, UINT uiParam, PVOID pvParam, UINT fWinIni)
+               user32.SystemParametersInfoA(
+                       SPI_SETDESKWALLPAPER,
+                       0,
+                       filename,
+                       SPIF_SENDWININICHANGE,
+               )
                return True
 
+class Gnome2Changer(BaseChanger):
+       name = "Gnome"
+       def set_image(self, filename):
+               cmd = ['gconftool-2', '--type', 'string', '--set', '/desktop/gnome/background/picture_filename', filename]
+               logging.debug(cmd)
+               return not self._exec_cmd(cmd)
+
+class Gnome3Changer(BaseChanger):
+       name = "Gnome3"
+       def set_image(self, filename):
+               cmd = ['gsettings', 'set', 'org.gnome.desktop.background', 'picture-uri', 'file://'+filename]
+               logging.debug(cmd)
+               return not self._exec_cmd(cmd)
+
+class Xfce4Changer(BaseChanger):
+       name = "XFCE4"
+       def set_image(self, filename):
+               cmd = [
+                       "xfconf-query",
+                       "-c", "xfce4-desktop",
+                       "-p", "/backdrop/screen0/monitor0/image-path",
+                       "-s", filename,
+               ]
+               logging.debug(cmd)
+               return not self._exec_cmd(cmd)
 
 def main(filename):
-       import logging
        logging.basicConfig(level=logging.DEBUG, format="%(levelname)s: %(message)s")
        init()
        set_image(filename)