Source code for qubes.ext

# The Qubes OS Project,
# Copyright (C) 2014-2015  Joanna Rutkowska <>
# Copyright (C) 2014-2015  Wojtek Porczyk <>
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# Lesser General Public License for more details.
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, see <>.

'''Qubes extensions.

Extensions provide additional features (like application menus) found only on
some systems. They may be OS- or architecture-dependent or custom-developed for
particular customer.

import pkg_resources

[docs]class Extension: '''Base class for all extensions ''' # pylint: disable=too-few-public-methods def __new__(cls): if '_instance' not in cls.__dict__: cls._instance = super(Extension, cls).__new__(cls) for name in cls.__dict__: attr = getattr(cls._instance, name) if not continue if attr.ha_vm is not None: for event in attr.ha_events: attr.ha_vm.__handlers__[event].add(attr) else: # global hook for event in attr.ha_events: # pylint: disable=no-member qubes.Qubes.__handlers__[event].add(attr) return cls._instance
def get_extensions(): return set(ext.load()() for ext in pkg_resources.iter_entry_points('qubes.ext'))
[docs]def handler(*events, **kwargs): '''Event handler decorator factory. To hook an event, decorate a method in your plugin class with this decorator. You may hook both per-vm-class and global events. .. note:: This decorator is intended only for extensions! For regular use in the core, see :py:func:``. :param str event: event type :param type vm: VM to hook (leave as None to hook all VMs) :param bool system: when :py:obj:`True`, hook is system-wide (not attached \ to any VM) ''' def decorator(func): func.ha_events = events if kwargs.get('system', False): func.ha_vm = None elif 'vm' in kwargs: func.ha_vm = kwargs['vm'] else: func.ha_vm = qubes.vm.BaseVM return func return decorator