code.delx.au - bg-scripts/blob - randombg.py

   1 #!/usr/bin/env python
   2
   3 VERSION = "2.0"
   4
   5
   6 import asyncore, asynchat, socket
   7 import os, os.path, random, sys, time
   8 from optparse import OptionParser
   9 import logging
  10 from logging import debug, info, warning, error, critical
  11 logging.basicConfig(format="%(levelname)s: %(message)s")
  12 try:
  13         import cPickle as pickle
  14 except ImportError:
  15         import pickle
  16
  17 try:
  18         # Required libraries
  19         import asyncsched
  20         import wallchanger
  21 except ImportError, e:
  22         critical("Missing libraries! Exiting...")
  23         sys.exit(1)
  24
  25
  26
  27
  28 def filter_images(filenames):
  29         extensions = ('.jpg', '.jpe', '.jpeg', '.png', '.gif', '.bmp')
  30         for filename in filenames:
  31                 _, ext = os.path.splitext(filename)
  32                 if ext.lower() in extensions:
  33                         yield filename
  34
  35 class BaseFileList(object):
  36         """Base file list implementation"""
  37         def __init__(self):
  38                 self.paths = []
  39
  40         def add_path(self, path):
  41                 self.paths.append(path)
  42
  43         def store_cache(self, filename):
  44                 try:
  45                         debug("Attempting to store cache")
  46                         fd = open(filename, 'wb')
  47                         pickle.dump(obj = self, file = fd, protocol = 2)
  48                         debug("Cache successfully stored")
  49                 except Exception, e:
  50                         warning("Storing cache: %s" % e)
  51
  52         def load_cache(self, filename):
  53                 try:
  54                         debug("Attempting to load cache from: %s" % filename)
  55                         self.paths.sort()
  56
  57                         fd = open(filename, 'rb')
  58                         tmp = pickle.load(fd)
  59
  60                         if tmp.__class__ != self.__class__:
  61                                 raise ValueError("Using different file list type")
  62
  63                         self.paths.sort()
  64                         if self.paths != getattr(tmp, "paths"):
  65                                 raise ValueError("Path list changed")
  66
  67                         for attr, value in tmp.__dict__.items():
  68                                 setattr(self, attr, value)
  69
  70                         return True
  71
  72                 except Exception, e:
  73                         warning("Loading cache: %s" % e)
  74                         return False
  75
  76         def scan_paths(self):
  77                 raise NotImplementedError()
  78
  79         def get_next_image(self):
  80                 raise NotImplementedError()
  81
  82         def get_prev_image(self):
  83                 raise NotImplementedError()
  84
  85         def get_current_image(self):
  86                 raise NotImplementedError()
  87
  88         def is_empty(self):
  89                 return True
  90
  91
  92 class RandomFileList(BaseFileList):
  93         def __init__(self):
  94                 super(RandomFileList, self).__init__()
  95                 self.list = []
  96                 self.last_image = None
  97
  98         def scan_paths(self):
  99                 for path in self.paths:
 100                         for dirpath, dirsnames, filenames in os.walk(path):
 101                                 for filename in filter_images(filenames):
 102                                         self.list.append(os.path.join(dirpath, filename))
 103
 104         def get_next_image(self):
 105                 n = random.randint(0, len(self.list)-1)
 106                 self.last_image = self.list[n]
 107                 debug("Picked file '%s' from list" % self.last_image)
 108                 return self.last_image
 109
 110         def get_current_image(self):
 111                 if self.last_image:
 112                         return self.last_image
 113                 else:
 114                         return self.get_next_image()
 115
 116         def is_empty(self):
 117                 return len(self.list) == 0
 118
 119
 120 class AllRandomFileList(BaseFileList):
 121         def __init__(self):
 122                 super(AllRandomFileList, self).__init__()
 123                 self.list = None
 124                 self.imagePointer = 0
 125
 126         # Scan the input directory, and then randomize the file list
 127         def scan_paths(self):
 128                 self.list = []
 129                 for path in self.paths:
 130                         debug('Scanning "%s"' % path)
 131                         for dirpath, dirsnames, filenames in os.walk(path):
 132                                 for filename in filter_images(filenames):
 133                                         debug('Adding file "%s"' % filename)
 134                                         self.list.append(os.path.join(dirpath, filename))
 135
 136                 random.shuffle(self.list)
 137
 138         def get_current_image(self):
 139                 return self.list[self.imagePointer]
 140
 141         def __inc_in_range(self, n, amount = 1, rangeMax = None, rangeMin = 0):
 142                 if rangeMax == None: rangeMax = len(self.list)
 143                 assert rangeMax > 0
 144                 return (n + amount) % rangeMax
 145
 146         def get_next_image(self):
 147                 self.imagePointer = self.__inc_in_range(self.imagePointer)
 148                 imageName = self.list[self.imagePointer]
 149                 debug("Picked file '%s' (pointer=%d) from list" % (imageName, self.imagePointer))
 150                 return imageName
 151
 152         def get_prev_image(self):
 153                 self.imagePointer = self.__inc_in_range(self.imagePointer, amount=-1)
 154                 imageName = self.list[self.imagePointer]
 155                 debug("Picked file '%s' (pointer=%d) from list" % (imageName, self.imagePointer))
 156                 return imageName
 157
 158         def is_empty(self):
 159                 return len(self.list) == 0
 160
 161 class FolderRandomFileList(BaseFileList):
 162         """A file list that will pick a file randomly within a directory. Each
 163         directory has the same chance of being chosen."""
 164         def __init__(self):
 165                 super(FolderRandomFileList, self).__init__()
 166                 self.directories = {}
 167                 self.last_image = None
 168
 169         def scan_paths(self):
 170                 for path in self.paths:
 171                         for dirpath, dirs, filenames in os.walk(path):
 172                                 debug('Scanning "%s" for images' % dirpath)
 173                                 if self.directories.has_key(dirpath):
 174                                         continue
 175                                 filenames = list(filter_images(filenames))
 176                                 if len(filenames):
 177                                         self.directories[dirpath] = filenames
 178                                         debug('Adding "%s" to "%s"' % (filenames, dirpath))
 179                                 else:
 180                                         debug("No images found in '%s'" % dirpath)
 181
 182         def get_next_image(self):
 183                 directory = random.choice(self.directories.keys())
 184                 debug('directory: "%s"' % directory)
 185                 filename = random.choice(self.directories[directory])
 186                 debug('filename: "%s"' % filename)
 187                 self.last_image = os.path.join(directory, filename)
 188                 return self.last_image
 189
 190         def get_current_image(self):
 191                 if self.last_image:
 192                         return self.last_image
 193                 else:
 194                         return self.get_next_image()
 195
 196         def is_empty(self):
 197                 return len(self.directories.values()) == 0
 198
 199
 200 class Cycler(object):
 201         def init(self, options, paths):
 202                 self.cycle_time = options.cycle_time
 203                 self.history_filename = options.history_filename
 204
 205                 debug("Initialising wallchanger")
 206                 wallchanger.init(options.background_colour, options.permanent)
 207
 208                 debug("Initialising file list")
 209                 if options.all_random:
 210                         self.filelist = AllRandomFileList()
 211                 elif options.folder_random:
 212                         self.filelist = FolderRandomFileList()
 213                 else:
 214                         self.filelist = RandomFileList()
 215
 216                 for path in paths:
 217                         self.filelist.add_path(path)
 218
 219                 if self.filelist.load_cache(self.history_filename):
 220                         debug("Loaded cache successfully")
 221                 else:
 222                         debug("Could not load cache")
 223                         self.filelist.scan_paths()
 224
 225                 if self.filelist.is_empty():
 226                         error("No images were found. Exiting...")
 227                         sys.exit(1)
 228
 229                 self.task = None
 230                 self.cmd_reload()
 231
 232         def finish(self):
 233                 self.filelist.store_cache(self.history_filename)
 234
 235         def find_files(self, options, paths):
 236                 return filelist
 237
 238         def cmd_reset(self):
 239                 def next():
 240                         image = self.filelist.get_next_image()
 241                         wallchanger.set_image(image)
 242                         self.task = None
 243                         self.cmd_reset()
 244
 245                 if self.task is not None:
 246                         self.task.cancel()
 247                 self.task = asyncsched.schedule(self.cycle_time, next)
 248                 debug("Reset timer for %s seconds" % self.cycle_time)
 249
 250         def cmd_reload(self):
 251                 image = self.filelist.get_current_image()
 252                 wallchanger.set_image(image)
 253                 self.cmd_reset()
 254
 255         def cmd_next(self):
 256                 image = self.filelist.get_next_image()
 257                 wallchanger.set_image(image)
 258                 self.cmd_reset()
 259
 260         def cmd_prev(self):
 261                 image = self.filelist.get_prev_image()
 262                 wallchanger.set_image(image)
 263                 self.cmd_reset()
 264
 265         def cmd_rescan(self):
 266                 self.filelist.scan_paths()
 267
 268         def cmd_pause(self):
 269                 if self.task is not None:
 270                         self.task.cancel()
 271                         self.task = None
 272
 273         def cmd_exit(self):
 274                 asyncsched.exit()
 275
 276 class Server(asynchat.async_chat):
 277         def __init__(self, cycler, conn, addr):
 278                 asynchat.async_chat.__init__(self, conn=conn)
 279                 self.cycler = cycler
 280                 self.ibuffer = []
 281                 self.set_terminator("\n")
 282
 283         def collect_incoming_data(self, data):
 284                 self.ibuffer.append(data)
 285
 286         def found_terminator(self):
 287                 line = "".join(self.ibuffer).lower()
 288                 self.ibuffer = []
 289                 prefix, cmd = line.split(None, 1)
 290                 if prefix != "cmd":
 291                         debug('Bad line received "%s"' % line)
 292                         return
 293                 if hasattr(self.cycler, "cmd_" + cmd):
 294                         debug('Executing command "%s"' % cmd)
 295                         getattr(self.cycler, "cmd_" + cmd)()
 296                 else:
 297                         debug('Unknown command received "%s"' % cmd)
 298
 299
 300
 301 class Listener(asyncore.dispatcher):
 302         def __init__(self, socket_filename, cycler):
 303                 asyncore.dispatcher.__init__(self)
 304                 self.cycler = cycler
 305                 self.create_socket(socket.AF_UNIX, socket.SOCK_STREAM)
 306                 self.bind(socket_filename)
 307                 self.listen(2) # Backlog = 2
 308
 309         def handle_accept(self):
 310                 conn, addr = self.accept()
 311                 Server(self.cycler, conn, addr)
 312
 313         def writable(self):
 314                 return False
 315
 316
 317 def do_server(options, paths):
 318         try:
 319                 cycler = Cycler()
 320                 listener = Listener(options.socket_filename, cycler)
 321                 # Initialisation of Cycler delayed so we grab the socket quickly
 322                 cycler.init(options, paths)
 323                 try:
 324                         asyncsched.loop()
 325                 except KeyboardInterrupt:
 326                         print
 327                 cycler.finish()
 328         finally:
 329                 # Make sure that the socket is cleaned up
 330                 try:
 331                         os.unlink(options.socket_filename)
 332                 except:
 333                         pass
 334
 335 def do_client(options, args):
 336         if len(args) == 0:
 337                 args = ["next"]
 338         sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
 339         sock.connect(options.socket_filename)
 340         sock = sock.makefile()
 341         for i, cmd in enumerate(args):
 342                 sock.write("cmd %s\n" % cmd)
 343                 if i+1 != len(args):
 344                         time.sleep(options.cycle_time)
 345         sock.close()
 346
 347 def do_oneshot(options, paths):
 348         cycler = Cycler()
 349         cycler.init(options, paths)
 350
 351 def build_parser():
 352         parser = OptionParser(version="%prog " + VERSION,
 353                 description = "Cycles through random background images.",
 354                 usage =
 355                         "\n(server) %prog [options] dir [dir2 ...]"
 356                         "\n(client) %prog [options] [next|prev|rescan|reload|pause] [...]"
 357                         "\nThe first instance to be run will be the server.\n"
 358                 )
 359         parser.add_option("-p", "--permanent",
 360                 action="store_true", dest="permanent", default=False,
 361                 help="Make the background permanent. Note: This will cause all machines logged in with this account to simultaneously change background [Default: %default]")
 362         parser.add_option("-v", '-d', "--verbose", "--debug",
 363                 action="count", dest="verbose", default=0,
 364                 help="Make the louder (good for debugging, or those who are curious)")
 365         parser.add_option("-b", "--background-colour",
 366                 action="store", type="string", dest="background_colour", default="black",
 367                 help="Change the default background colour that is displayed if the image is not in the correct aspect ratio [Default: %default]")
 368         parser.add_option("--all-random",
 369                 action="store_true", dest="all_random", default=False,
 370                 help="Make sure that all images have been displayed before repeating an image")
 371         parser.add_option("-1", "--oneshot",
 372                 action="store_true", dest="oneshot", default=False,
 373                 help="Set one random image and terminate immediately.")
 374         parser.add_option("--folder-random",
 375                 action="store_true", dest="folder_random", default=False,
 376                 help="Give each folder an equal chance of having an image selected from it")
 377         parser.add_option("--convert",
 378                 action="store_true", dest="convert", default=False,
 379                 help="Do conversions using ImageMagick or PIL, don't rely on the window manager")
 380         parser.add_option("--cycle-time",
 381                 action="store", type="int", default=1800, dest="cycle_time",
 382                 help="Cause the image to cycle every X seconds")
 383         parser.add_option("--socket",
 384                 action="store", type="string", dest="socket_filename", default=os.path.expanduser('~/.randombg_socket'),
 385                 help="Location of the command/control socket.")
 386         parser.add_option("--history-file",
 387                 action="store", type="string", dest="history_filename", default=os.path.expanduser('~/.randombg_historyfile'),
 388                 help="Stores the location of the last image to be loaded.")
 389         return parser
 390
 391 def main():
 392         parser = build_parser()
 393         options, args = parser.parse_args(sys.argv[1:])
 394
 395         if options.verbose == 1:
 396                 logging.getLogger().setLevel(logging.INFO)
 397         elif options.verbose >= 2:
 398                 logging.getLogger().setLevel(logging.DEBUG)
 399
 400         if options.oneshot:
 401                 do_oneshot(options, args)
 402
 403         if os.path.exists(options.socket_filename):
 404                 do_client(options, args)
 405         else:
 406                 do_server(options, args)
 407
 408
 409 if __name__ == "__main__":
 410         main()
 411