onoff/dbusutils.py

   1 import argparse
   2 import logging
   3 import socket
   4
   5 import dbus
   6 import dbus.service
   7 from gi.repository import GObject
   8
   9 logger = logging.getLogger("onoff.dbusutils")
  10
  11 object_prefix = "/de/subdivi/onoff0"
  12 default_busname = "de.subdivi.onoff0"
  13
  14 dbus_options = argparse.ArgumentParser(add_help=False)
  15 dbus_options.add_argument("--bus", default="session",
  16                           choices=("system", "session"),
  17                           help="which bus to use (default: %(default)s)")
  18 dbus_options.add_argument("--busname", type=str, default=default_busname,
  19                           help="which busname (i.e. client) to use " +
  20                                "(default: %(default)s)")
  21 dbus_options.add_argument("--device", type=str, required=True,
  22                           help="which device to control")
  23
  24 def get_dbus_proxy(namespace):
  25     """
  26     @param namespace: a namespace returned from a dbus_options argument parser
  27     @returns: a dbus object proxy
  28     """
  29     if namespace.bus == "session":
  30         bus = dbus.SessionBus()
  31     elif namespace.bus == "system":
  32         bus = dbus.SystemBus()
  33     else:
  34         raise AssertionError("namespace.bus %r is neither session nor system",
  35                              namespace.bus)
  36     objname = "%s/%s" % (object_prefix, namespace.device)
  37     return bus.get_object(namespace.busname, objname)
  38
  39 def socketpair():
  40     """Create a socket pair where the latter end is already wrapped for
  41     transmission over dbus.
  42
  43     @rtype: (socket, dbus.types.UnixFd)
  44     """
  45     s1, s2 = socket.socketpair()
  46     s3 = dbus.types.UnixFd(s2)
  47     s2.close()
  48     return s1, s3
  49
  50 class OnoffControl(dbus.service.Object):
  51     domain = default_busname
  52     path = object_prefix
  53
  54     def __init__(self, bus, name, device):
  55         """
  56         @type bus: dbus.Bus
  57         @type name: str
  58         @type device: OnoffDevice
  59         """
  60         busname = dbus.service.BusName(self.domain, bus=bus)
  61         dbus.service.Object.__init__(self, busname, "%s/%s" % (self.path, name))
  62         self.device = device
  63         self.usecount = 0
  64         device.notify.add(self.changestate)
  65
  66     @dbus.service.signal(domain, signature="q")
  67     def changestate(self, state):
  68         logger.debug("emitting state %d", state)
  69
  70     @dbus.service.method(domain, out_signature="q")
  71     def state(self):
  72         return self.device.state
  73
  74     @dbus.service.method(domain, in_signature="q", out_signature="q")
  75     def activatetime(self, duration):
  76         """Activate the device for a given number of seconds."""
  77         logger.info("activatetime %d", duration)
  78         GObject.timeout_add(duration * 1000, self.unuse)
  79         return self.use()
  80
  81     @dbus.service.method(domain, in_signature="", out_signature="qh")
  82     def activatefd(self):
  83         """Activate a device until the returned file descriptor is closed."""
  84         logger.info("activatefd")
  85         notifyfd, retfd = socketpair()
  86         def callback(fd, _):
  87             logger.info("fd %d completed", fd.fileno())
  88             fd.close()
  89             self.unuse()
  90             return False
  91         GObject.io_add_watch(notifyfd, GObject.IO_HUP|GObject.IO_ERR, callback)
  92         return (self.use(), retfd)
  93
  94     def use(self):
  95         self.usecount += 1
  96         if self.usecount <= 1:
  97             self.device.activate()
  98         return self.device.state
  99
 100     def unuse(self):
 101         self.usecount -= 1
 102         if not self.usecount:
 103             self.device.deactivate()
 104         else:
 105             logger.debug("%d users left", self.usecount)
 106         return False