]> code.delx.au - bg-scripts/blobdiff - randombg.py
Merging the two loading function (in an attempt to fix the bugs in loading of cached...
[bg-scripts] / randombg.py
index f54183f490782e93d6c329826bf7a034840dc78f..00c7d5434eaa0871eacd8106ab0598f1c7c1f431 100755 (executable)
@@ -7,8 +7,12 @@ import asyncore, asynchat, socket
 import os, os.path, random, sys, time
 from optparse import OptionParser
 import logging
-from logging import debug, info, warning, error, critical
-logging.basicConfig(format="%(levelname)s: %(message)s")
+try:
+       logging.basicConfig(format="%(levelname)s: %(message)s")
+except TypeError:
+# Python 2.3's logging.basicConfig does not support parameters
+       logging.basicConfig()
+
 try:
        import cPickle as pickle
 except ImportError:
@@ -19,7 +23,7 @@ try:
        import asyncsched
        import wallchanger
 except ImportError, e:
-       critical("Missing libraries! Exiting...")
+       logging.critical("Missing libraries! Exiting...", exc_info=1)
        sys.exit(1)
 
 
@@ -34,17 +38,53 @@ def filter_images(filenames):
 
 class BaseFileList(object):
        """Base file list implementation"""
-       def scan_paths(self):
-               raise NotImplementedError()
+       def __init__(self):
+               self.paths = []
+               self.favourites = []
 
        def add_path(self, path):
-               raise NotImplementedError()
+               self.paths.append(path)
 
-       def store_cache(self, path):
-               pass
+       def store_cache(self, filename):
+               try:
+                       logging.debug("Attempting to store cache")
+                       fd = open(filename, 'wb')
+                       pickle.dump(self, fd, 2)
+                       logging.debug("Cache successfully stored")
+               except Exception, e:
+                       warning("Storing cache: %s" % e)
 
-       def load_cache(self, filename, rescanPaths = False):
-               pass
+       def load_cache(self, filename):
+               try:
+                       logging.debug("Attempting to load cache from: %s" % filename)
+                       self.paths.sort()
+
+                       fd = open(filename, 'rb')
+                       tmp = pickle.load(fd)
+
+                       if tmp.__class__ != self.__class__:
+                               raise ValueError("Using different file list type")
+
+                       tmp.paths.sort()
+                       if self.paths != tmp.paths:
+                               raise ValueError, "Path list changed"
+
+                       # Overwrite this object with the other
+                       for attr, value in tmp.__dict__.items():
+                               setattr(self, attr, value)
+
+                       return True
+
+               except Exception, e:
+                       logging.warning("Loading cache: %s" % e)
+                       return False
+
+       def add_to_favourites(self):
+               '''Adds the current image to the list of favourites'''
+               self.favourites.append(self.get_current_image())
+
+       def scan_paths(self):
+               raise NotImplementedError()
 
        def get_next_image(self):
                raise NotImplementedError()
@@ -61,8 +101,8 @@ class BaseFileList(object):
 
 class RandomFileList(BaseFileList):
        def __init__(self):
+               super(RandomFileList, self).__init__()
                self.list = []
-               self.paths = []
                self.last_image = None
 
        def scan_paths(self):
@@ -73,12 +113,12 @@ class RandomFileList(BaseFileList):
 
        def add_path(self, path):
                self.paths.append(path)
-               debug('Added path "%s" to the list' % path)
-       
+               logging.debug('Added path "%s" to the list' % path)
+
        def get_next_image(self):
                n = random.randint(0, len(self.list)-1)
                self.last_image = self.list[n]
-               debug("Picked file '%s' from list" % self.last_image)
+               logging.debug("Picked file '%s' from list" % self.last_image)
                return self.last_image
        
        def get_current_image(self):
@@ -93,51 +133,35 @@ class RandomFileList(BaseFileList):
 
 class AllRandomFileList(BaseFileList):
        def __init__(self):
+               super(AllRandomFileList, self).__init__()
                self.list = None
-               self.paths = []
                self.imagePointer = 0
 
        # Scan the input directory, and then randomize the file list
        def scan_paths(self):
-               debug("Scanning paths")
+               logging.debug("Scanning paths")
 
                self.list = []
                for path in self.paths:
-                       debug('Scanning "%s"' % path)
+                       logging.debug('Scanning "%s"' % path)
                        for dirpath, dirsnames, filenames in os.walk(path):
                                for filename in filter_images(filenames):
-                                       debug('Adding file "%s"' % filename)
+                                       logging.debug('Adding file "%s"' % filename)
                                        self.list.append(os.path.join(dirpath, filename))
 
                random.shuffle(self.list)
 
        def add_path(self, path):
                self.paths.append(path)
-               debug('Added path "%s" to the list' % path)
+               logging.debug('Added path "%s" to the list' % path)
 
        def store_cache(self, filename):
                try:
                        fd = open(filename, 'wb')
-                       pickle.dump(obj = self, file = fd, protocol = 2)
-                       debug("Cache successfully stored")
-               except Exception, e:
-                       warning("Storing cache: %s" % e)
-
-       def load_cache(self, filename, rescanPaths = False):
-               debug('Attempting to load cache from "%s"' % filename)
-               self.paths.sort()
-               try:
-                       fd = open(filename, 'rb')
-                       tmp = pickle.load(fd)
-                       if self.paths == tmp.paths:
-                               debug("Path lists match, copying properties")
-                               # Overwrite this object with the other
-                               for attr in ('list', 'imagePointer'):
-                                       setattr(self, attr, getattr(tmp, attr))
-                       else:
-                               debug("Ignoring cache, path lists do not match")
+                       pickle.dump(self, fd, 2)
+                       logging.debug("Cache successfully stored")
                except Exception, e:
-                       warning("Loading cache: %s" % e)
+                       logging.warning("Storing cache", exc_info=1)
 
        def get_current_image(self):
                return self.list[self.imagePointer]
@@ -150,22 +174,24 @@ class AllRandomFileList(BaseFileList):
        def get_next_image(self):
                self.imagePointer = self.__inc_in_range(self.imagePointer)
                imageName = self.list[self.imagePointer]
-               debug("Picked file '%s' (pointer=%d) from list" % (imageName, self.imagePointer))
+               logging.debug("Picked file '%s' (pointer=%d) from list" % (imageName, self.imagePointer))
                return imageName
 
        def get_prev_image(self):
                self.imagePointer = self.__inc_in_range(self.imagePointer, amount=-1)
                imageName = self.list[self.imagePointer]
-               debug("Picked file '%s' (pointer=%d) from list" % (imageName, self.imagePointer))
+               logging.debug("Picked file '%s' (pointer=%d) from list" % (imageName, self.imagePointer))
                return imageName
 
        def is_empty(self):
                return len(self.list) == 0
 
+
 class FolderRandomFileList(BaseFileList):
        """A file list that will pick a file randomly within a directory. Each
        directory has the same chance of being chosen."""
        def __init__(self):
+               super(FolderRandomFileList, self).__init__()
                self.directories = {}
                self.last_image = None
        
@@ -173,23 +199,23 @@ class FolderRandomFileList(BaseFileList):
                pass
        
        def add_path(self, path):
-               debug('Added path "%s" to the list' % path)
+               logging.debug('Added path "%s" to the list' % path)
                for dirpath, dirs, filenames in os.walk(path):
-                       debug('Scanning "%s" for images' % dirpath)
+                       logging.debug('Scanning "%s" for images' % dirpath)
                        if self.directories.has_key(dirpath):
                                continue
                        filenames = list(filter_images(filenames))
                        if len(filenames):
                                self.directories[dirpath] = filenames
-                               debug('Adding "%s" to "%s"' % (filenames, dirpath))
+                               logging.debug('Adding "%s" to "%s"' % (filenames, dirpath))
                        else:
-                               debug("No images found in '%s'" % dirpath)
+                               logging.debug("No images found in '%s'" % dirpath)
        
        def get_next_image(self):
                directory = random.choice(self.directories.keys())
-               debug('directory: "%s"' % directory)
+               logging.debug('directory: "%s"' % directory)
                filename = random.choice(self.directories[directory])
-               debug('filename: "%s"' % filename)
+               logging.debug('filename: "%s"' % filename)
                return os.path.join(directory, filename)
        
        def get_current_image(self):
@@ -203,14 +229,14 @@ class FolderRandomFileList(BaseFileList):
 
 
 class Cycler(object):
-       def init(self, options, paths):
+       def init(self, options, paths, oneshot=False):
                self.cycle_time = options.cycle_time
                self.history_filename = options.history_filename
 
-               debug("Initialising wallchanger")
-               wallchanger.init(options.background_colour, options.permanent)
+               logging.debug("Initialising wallchanger")
+               wallchanger.init(options.background_colour, options.permanent, options.convert)
 
-               debug("Initialising file list")
+               logging.debug("Initialising file list")
                if options.all_random:
                        self.filelist = AllRandomFileList()
                elif options.folder_random:
@@ -222,17 +248,20 @@ class Cycler(object):
                        self.filelist.add_path(path)
 
                if self.filelist.load_cache(self.history_filename):
-                       debug("Loaded cache successfully")
+                       logging.debug("Loaded cache successfully")
                else:
-                       debug("Could not load cache")
+                       logging.debug("Could not load cache")
                        self.filelist.scan_paths()
 
                if self.filelist.is_empty():
-                       error("No images were found. Exiting...")
+                       logging.error("No images were found. Exiting...")
                        sys.exit(1)
        
                self.task = None
-               self.cmd_reload()
+               if oneshot:
+                       self.cmd_next()
+               else:
+                       self.cmd_reload()
        
        def finish(self):
                self.filelist.store_cache(self.history_filename)
@@ -250,7 +279,8 @@ class Cycler(object):
                if self.task is not None:
                        self.task.cancel()
                self.task = asyncsched.schedule(self.cycle_time, next)
-               debug("Reset timer for %s seconds" % self.cycle_time)
+               logging.debug("Reset timer for %s seconds" % self.cycle_time)
+               self.filelist.store_cache(self.history_filename)
        
        def cmd_reload(self):
                image = self.filelist.get_current_image()
@@ -269,7 +299,6 @@ class Cycler(object):
        
        def cmd_rescan(self):
                self.filelist.scan_paths()
-               self.cmd_next()
        
        def cmd_pause(self):
                if self.task is not None:
@@ -279,6 +308,9 @@ class Cycler(object):
        def cmd_exit(self):
                asyncsched.exit()
 
+       def cmd_favourite(self):
+               self.filelist.add_to_favourites()
+
 class Server(asynchat.async_chat):
        def __init__(self, cycler, conn, addr):
                asynchat.async_chat.__init__(self, conn=conn)
@@ -294,14 +326,13 @@ class Server(asynchat.async_chat):
                self.ibuffer = []
                prefix, cmd = line.split(None, 1)
                if prefix != "cmd":
-                       debug('Bad line received "%s"' % line)
+                       logging.debug('Bad line received "%s"' % line)
                        return
                if hasattr(self.cycler, "cmd_" + cmd):
-                       debug('Executing command "%s"' % cmd)
+                       logging.debug('Executing command "%s"' % cmd)
                        getattr(self.cycler, "cmd_" + cmd)()
                else:
-                       debug('Unknown command received "%s"' % cmd)
-
+                       logging.debug('Unknown command received "%s"' % cmd)
 
 
 class Listener(asyncore.dispatcher):
@@ -346,13 +377,13 @@ def do_client(options, args):
        sock = sock.makefile()
        for i, cmd in enumerate(args):
                sock.write("cmd %s\n" % cmd)
-               if i+1 != len(args):
+               if i < len(args) - 1:
                        time.sleep(options.cycle_time)
        sock.close()
 
 def do_oneshot(options, paths):
        cycler = Cycler()
-       cycler.init(options, paths)
+       cycler.init(options, paths, oneshot=True)
 
 def build_parser():
        parser = OptionParser(version="%prog " + VERSION, 
@@ -405,13 +436,12 @@ def main():
        
        if options.oneshot:
                do_oneshot(options, args)
-
-       if os.path.exists(options.socket_filename):
-               do_client(options, args)
        else:
-               do_server(options, args)
+               if os.path.exists(options.socket_filename):
+                       do_client(options, args)
+               else:
+                       do_server(options, args)
 
 
 if __name__ == "__main__":
        main()
-