src/collecty/bus.py

   1 #!/usr/bin/python3
   2 ###############################################################################
   3 #                                                                             #
   4 # collecty - A system statistics collection daemon for IPFire                 #
   5 # Copyright (C) 2015 IPFire development team                                  #
   6 #                                                                             #
   7 # This program is free software: you can redistribute it and/or modify        #
   8 # it under the terms of the GNU General Public License as published by        #
   9 # the Free Software Foundation, either version 3 of the License, or           #
  10 # (at your option) any later version.                                         #
  11 #                                                                             #
  12 # This program is distributed in the hope that it will be useful,             #
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of              #
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               #
  15 # GNU General Public License for more details.                                #
  16 #                                                                             #
  17 # You should have received a copy of the GNU General Public License           #
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.       #
  19 #                                                                             #
  20 ###############################################################################
  21
  22 import dbus
  23 import dbus.mainloop.glib
  24 import dbus.service
  25 import gi.repository.GLib
  26 import gi.repository.GObject
  27 import logging
  28 import threading
  29
  30 from .i18n import _
  31
  32 log = logging.getLogger("collecty.bus")
  33
  34 DOMAIN = "org.ipfire.collecty1"
  35
  36 class Bus(threading.Thread):
  37         def __init__(self, collecty):
  38                 threading.Thread.__init__(self)
  39                 self.daemon = True
  40
  41                 self.collecty = collecty
  42
  43                 # Initialise the main loop
  44                 gi.repository.GObject.threads_init()
  45                 dbus.mainloop.glib.threads_init()
  46                 dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
  47
  48                 self.loop = gi.repository.GLib.MainLoop()
  49
  50                 # Register the GraphGenerator interface
  51                 self.generator = GraphGenerator(self.collecty)
  52
  53         def run(self):
  54                 log.debug(_("Bus thread has started"))
  55
  56                 # Run the main loop
  57                 try:
  58                         self.loop.run()
  59                 except KeyboardInterrupt:
  60                         self.collecty.shutdown()
  61
  62                 log.debug(_("Bus thread has ended"))
  63
  64         def shutdown(self):
  65                 log.debug(_("Stopping bus thread"))
  66
  67                 # End the main loop
  68                 self.loop.quit()
  69
  70                 # Return when this thread has finished
  71                 return self.join()
  72
  73
  74 class GraphGenerator(dbus.service.Object):
  75         def __init__(self, collecty):
  76                 bus_name = dbus.service.BusName(DOMAIN, bus=dbus.SystemBus())
  77                 dbus.service.Object.__init__(self, bus_name, "/%s" % self.__class__.__name__)
  78
  79                 self.collecty = collecty
  80
  81         @dbus.service.method(DOMAIN, in_signature="s")
  82         def Backup(self, filename):
  83                 self.collecty.backup(filename)
  84
  85         @dbus.service.method(DOMAIN, in_signature="sa{sv}", out_signature="a{sv}")
  86         def GenerateGraph(self, template_name, kwargs):
  87                 """
  88                         Returns a graph generated from the given template and object.
  89                 """
  90                 graph = self.collecty.generate_graph(template_name, **kwargs)
  91
  92                 # Convert the graph back to normal Python format
  93                 if graph:
  94                         graph["image"] = dbus.ByteArray(graph["image"] or [])
  95
  96                 return graph
  97
  98         @dbus.service.method(DOMAIN, in_signature="", out_signature="a{sv}")
  99         def GraphInfo(self, template_name, kwargs):
 100                 """
 101                         Returns a dictionary with information about the graph.
 102                 """
 103                 return self.collecty.graph_info(template_name, **kwargs)
 104
 105         @dbus.service.method(DOMAIN, in_signature="sa{sv}", out_signature="a{sv}")
 106         def LastUpdate(self, template_name, kwargs):
 107                 """
 108                         Returns a graph generated from the given template and object.
 109                 """
 110                 last_update = self.collecty.last_update(template_name, **kwargs)
 111
 112                 # Serialise datetime as string
 113                 if last_update:
 114                         last_update["timestamp"] = last_update["timestamp"].isoformat()
 115
 116                 return last_update
 117
 118         @dbus.service.method(DOMAIN, in_signature="", out_signature="as")
 119         def ListTemplates(self):
 120                 """
 121                         Returns a list of all available templates
 122                 """
 123                 return [t.name for t in self.collecty.templates]
 124
 125         @dbus.service.method(DOMAIN, in_signature="", out_signature="s")
 126         def Version(self):
 127                 return COLLECTY_VERSION