core-admin/qubes/ext/__init__.py
Wojtek Porczyk fcdb579bab core3: qubesmanager notifying extension
core/notify.py was excavated and tray notifying remnants were moved to
qubes.log. They are unused as yet.

Also extension events are fixed.
2015-10-05 12:46:14 +02:00

107 lines
3.2 KiB
Python

#!/usr/bin/python2 -O
# vim: fileencoding=utf-8
#
# The Qubes OS Project, https://www.qubes-os.org/
#
# Copyright (C) 2014-2015 Joanna Rutkowska <joanna@invisiblethingslab.com>
# Copyright (C) 2014-2015 Wojtek Porczyk <woju@invisiblethingslab.com>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
'''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 inspect
import qubes.events
import qubes.plugins
class ExtensionPlugin(qubes.plugins.Plugin):
'''Metaclass for :py:class:`Extension`'''
def __init__(cls, name, bases, dict_):
super(ExtensionPlugin, cls).__init__(name, bases, dict_)
cls._instance = None
def __call__(cls, *args, **kwargs):
if cls._instance is None:
cls._instance = super(ExtensionPlugin, cls).__call__(
*args, **kwargs)
return cls._instance
class Extension(object):
'''Base class for all extensions
:param qubes.Qubes app: application object
''' # pylint: disable=too-few-public-methods
__metaclass__ = ExtensionPlugin
def __init__(self, app):
self.app = app
for name in dir(self):
attr = getattr(self, name)
if not qubes.events.ishandler(attr):
continue
if attr.ha_vm is not None:
for event in attr.ha_events:
attr.ha_vm.add_handler(event, attr)
else:
# global hook
for event in attr.ha_events:
self.app.add_handler(event, attr)
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:`qubes.events.handler`.
: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
__all__ = ['Extension', 'ExtensionPlugin', 'handler'] \
+ qubes.plugins.load(__file__)