Qubes/core-admin
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

qubes/admin: Add listing of API methods

Browse Source
This commit is contained in:
Wojtek Porczyk 2017-06-19 17:37:10 +02:00 committed by Marek Marczykowski-Górecki
parent 26013122a0
commit 3e0d01cfb9
No known key found for this signature in database
GPG Key ID: 063938BA42CFA724
1 changed files with 27 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
qubes/api/__init__.py
View File

@ -41,7 +41,7 @@ class PermissionDenied(Exception):
pass pass
def method(name, *, no_payload=False, endpoints=None): def method(name, *, no_payload=False, endpoints=None, **classifiers):
'''Decorator factory for methods intended to appear in API. '''Decorator factory for methods intended to appear in API.
The decorated method can be called from public API using a child of The decorated method can be called from public API using a child of
@ -75,11 +75,14 @@ def method(name, *, no_payload=False, endpoints=None):
# pylint: disable=protected-access # pylint: disable=protected-access
if endpoints is None: if endpoints is None:
func._rpcname = ((name, None),) func.rpcnames = ((name, None),)
else: else:
func._rpcname = tuple( func.rpcnames = tuple(
(name.format(endpoint=endpoint), endpoint) (name.format(endpoint=endpoint), endpoint)
for endpoint in endpoints) for endpoint in endpoints)
func.classifiers = classifiers
return func return func
return decorator return decorator
@ -133,43 +136,45 @@ class AbstractQubesAPI(object):
#: is this operation cancellable? #: is this operation cancellable?
self.cancellable = False self.cancellable = False
untrusted_candidates = [] candidates = list(self.list_methods(self.method))
for attr in dir(self):
func = getattr(self, attr)
if not candidates:
raise ProtocolError('no such method: {!r}'.format(self.method))
assert len(candidates) == 1, \
'multiple candidates for method {!r}'.format(self.method)
#: the method to execute
self._handler = candidates[0]
self._running_handler = None
@classmethod
def list_methods(cls, select_method=None):
for attr in dir(cls):
func = getattr(cls, attr)
if not callable(func): if not callable(func):
continue continue
try: try:
# pylint: disable=protected-access # pylint: disable=protected-access
for mname, endpoint in func._rpcname: rpcnames = func.rpcnames
if mname != self.method:
continue
untrusted_candidates.append((func, endpoint))
except AttributeError: except AttributeError:
continue continue
if not untrusted_candidates: for mname, endpoint in rpcnames:
raise ProtocolError('no such method: {!r}'.format(self.method)) if select_method is None or mname == select_method:
yield (func, mname, endpoint)
assert len(untrusted_candidates) == 1, \
'multiple candidates for method {!r}'.format(self.method)
#: the method to execute
self._handler = untrusted_candidates[0]
self._running_handler = None
del untrusted_candidates
def execute(self, *, untrusted_payload): def execute(self, *, untrusted_payload):
'''Execute management operation. '''Execute management operation.
This method is a coroutine. This method is a coroutine.
''' '''
handler, endpoint = self._handler handler, _, endpoint = self._handler
kwargs = {} kwargs = {}
if endpoint is not None: if endpoint is not None:
kwargs['endpoint'] = endpoint kwargs['endpoint'] = endpoint
self._running_handler = asyncio.ensure_future(handler( self._running_handler = asyncio.ensure_future(handler(self,
untrusted_payload=untrusted_payload, **kwargs)) untrusted_payload=untrusted_payload, **kwargs))
return self._running_handler return self._running_handler