events.py 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185
  1. #!/usr/bin/python2 -O
  2. # vim: fileencoding=utf-8
  3. #
  4. # The Qubes OS Project, https://www.qubes-os.org/
  5. #
  6. # Copyright (C) 2014-2015 Joanna Rutkowska <joanna@invisiblethingslab.com>
  7. # Copyright (C) 2014-2015 Wojtek Porczyk <woju@invisiblethingslab.com>
  8. #
  9. # This program is free software; you can redistribute it and/or modify
  10. # it under the terms of the GNU General Public License as published by
  11. # the Free Software Foundation; either version 2 of the License, or
  12. # (at your option) any later version.
  13. #
  14. # This program is distributed in the hope that it will be useful,
  15. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. # GNU General Public License for more details.
  18. #
  19. # You should have received a copy of the GNU General Public License along
  20. # with this program; if not, write to the Free Software Foundation, Inc.,
  21. # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22. #
  23. '''Qubes events.
  24. Events are fired when something happens, like VM start or stop, property change
  25. etc.
  26. '''
  27. import collections
  28. def handler(*events):
  29. '''Event handler decorator factory.
  30. To hook an event, decorate a method in your plugin class with this
  31. decorator.
  32. It probably makes no sense to specify more than one handler for specific
  33. event in one class, because handlers are not run concurrently and there is
  34. no guarantee of the order of execution.
  35. .. note::
  36. For hooking events from extensions, see :py:func:`qubes.ext.handler`.
  37. :param str event: event type
  38. '''
  39. def decorator(func):
  40. # pylint: disable=missing-docstring
  41. func.ha_events = events
  42. return func
  43. return decorator
  44. def ishandler(obj):
  45. '''Test if a method is hooked to an event.
  46. :param object o: suspected hook
  47. :return: :py:obj:`True` when function is a hook, :py:obj:`False` otherwise
  48. :rtype: bool
  49. '''
  50. return callable(obj) \
  51. and hasattr(obj, 'ha_events')
  52. class EmitterMeta(type):
  53. '''Metaclass for :py:class:`Emitter`'''
  54. def __init__(cls, name, bases, dict_):
  55. super(EmitterMeta, cls).__init__(name, bases, dict_)
  56. cls.__handlers__ = collections.defaultdict(set)
  57. try:
  58. propnames = set(prop.__name__ for prop in cls.property_list())
  59. except AttributeError:
  60. propnames = set()
  61. for attr in dict_:
  62. if attr in propnames:
  63. # we have to be careful, not to getattr() on properties which
  64. # may be unset
  65. continue
  66. attr = dict_[attr]
  67. if not ishandler(attr):
  68. continue
  69. for event in attr.ha_events:
  70. cls.add_handler(event, attr)
  71. class Emitter(object):
  72. '''Subject that can emit events.
  73. By default all events are disabled not to interfere with loading from XML.
  74. To enable event dispatch, set :py:attr:`events_enabled` to :py:obj:`True`.
  75. '''
  76. __metaclass__ = EmitterMeta
  77. def __init__(self, *args, **kwargs):
  78. super(Emitter, self).__init__(*args, **kwargs)
  79. if not hasattr(self, 'events_enabled'):
  80. self.events_enabled = False
  81. @classmethod
  82. def add_handler(cls, event, func):
  83. '''Add event handler to subject's class.
  84. :param str event: event identificator
  85. :param collections.Callable handler: handler callable
  86. '''
  87. # pylint: disable=no-member
  88. cls.__handlers__[event].add(func)
  89. def _fire_event_in_order(self, order, event, *args, **kwargs):
  90. '''Fire event for classes in given order.
  91. Do not use this method. Use :py:meth:`fire_event` or
  92. :py:meth:`fire_event_pre`.
  93. '''
  94. if not self.events_enabled:
  95. return
  96. effects = []
  97. for cls in order:
  98. if not hasattr(cls, '__handlers__'):
  99. continue
  100. for func in sorted(cls.__handlers__[event],
  101. key=(lambda handler: hasattr(handler, 'ha_bound')),
  102. reverse=True):
  103. effect = func(self, event, *args, **kwargs)
  104. if effect is not None:
  105. effects.extend(effect)
  106. return effects
  107. def fire_event(self, event, *args, **kwargs):
  108. '''Call all handlers for an event.
  109. Handlers are called for class and all parent classess, in **reversed**
  110. method resolution order. For each class first are called bound handlers
  111. (specified in class definition), then handlers from extensions. Aside
  112. from above, remaining order is undefined.
  113. .. seealso::
  114. :py:meth:`fire_event_pre`
  115. :param str event: event identificator
  116. :returns: list of effects
  117. All *args* and *kwargs* are passed verbatim. They are different for
  118. different events.
  119. '''
  120. return self._fire_event_in_order(reversed(self.__class__.__mro__),
  121. event, *args, **kwargs)
  122. def fire_event_pre(self, event, *args, **kwargs):
  123. '''Call all handlers for an event.
  124. Handlers are called for class and all parent classess, in **true**
  125. method resolution order. This is intended for ``-pre-`` events, where
  126. order of invocation should be reversed.
  127. .. seealso::
  128. :py:meth:`fire_event`
  129. :param str event: event identificator
  130. :returns: list of effects
  131. All *args* and *kwargs* are passed verbatim. They are different for
  132. different events.
  133. '''
  134. return self._fire_event_in_order(self.__class__.__mro__,
  135. event, *args, **kwargs)