diff options
| -rw-r--r-- | freeipa.spec.in | 3 | ||||
| -rw-r--r-- | ipaclient/plugins/dns.py | 19 | ||||
| -rw-r--r-- | ipaclient/remote_plugins/__init__.py | 14 | ||||
| -rw-r--r-- | ipaclient/remote_plugins/schema.py | 302 | ||||
| -rw-r--r-- | ipaclient/setup.py.in | 1 | ||||
| -rw-r--r-- | ipalib/__init__.py | 15 | ||||
| -rw-r--r-- | ipalib/plugable.py | 2 | ||||
| -rwxr-xr-x | makeaci | 4 | ||||
| -rwxr-xr-x | makeapi | 1 |
9 files changed, 352 insertions, 9 deletions
diff --git a/freeipa.spec.in b/freeipa.spec.in index 752b58656..57228bef8 100644 --- a/freeipa.spec.in +++ b/freeipa.spec.in @@ -1304,6 +1304,7 @@ fi %dir %{python_sitelib}/ipaclient %{python_sitelib}/ipaclient/*.py* %{python_sitelib}/ipaclient/plugins/*.py* +%{python_sitelib}/ipaclient/remote_plugins/*.py* %{python_sitelib}/ipaclient-*.egg-info @@ -1318,6 +1319,8 @@ fi %{python3_sitelib}/ipaclient/__pycache__/*.py* %{python3_sitelib}/ipaclient/plugins/*.py %{python3_sitelib}/ipaclient/plugins/__pycache__/*.py* +%{python3_sitelib}/ipaclient/remote_plugins/*.py +%{python3_sitelib}/ipaclient/remote_plugins/__pycache__/*.py* %{python3_sitelib}/ipaclient-*.egg-info %endif # with_python3 diff --git a/ipaclient/plugins/dns.py b/ipaclient/plugins/dns.py index 6fca7cd24..4defb7c33 100644 --- a/ipaclient/plugins/dns.py +++ b/ipaclient/plugins/dns.py @@ -28,6 +28,7 @@ from ipalib.dns import (get_record_rrtype, has_cli_options, iterate_rrparams_by_parts, record_name_format) +from ipalib.parameters import Bool from ipalib.plugable import Registry from ipalib import _, ngettext from ipapython.dnsutil import DNSName @@ -98,6 +99,24 @@ def prompt_missing_parts(rrtype, cmd, kw, prompt_optional=False): return user_options +class DNSZoneMethodOverride(MethodOverride): + def get_options(self): + for option in super(DNSZoneMethodOverride, self).get_options(): + if option.name == 'idnsallowdynupdate': + option = option.clone_retype(option.name, Bool) + yield option + + +@register(override=True) +class dnszone_add(DNSZoneMethodOverride): + pass + + +@register(override=True) +class dnszone_mod(DNSZoneMethodOverride): + pass + + @register(override=True) class dnsrecord_add(MethodOverride): no_option_msg = 'No options to add a specific record provided.\n' \ diff --git a/ipaclient/remote_plugins/__init__.py b/ipaclient/remote_plugins/__init__.py new file mode 100644 index 000000000..c59de0ca7 --- /dev/null +++ b/ipaclient/remote_plugins/__init__.py @@ -0,0 +1,14 @@ +# +# Copyright (C) 2016 FreeIPA Contributors see COPYING for license +# + +from . import schema + + +def get_package(api): + if api.env.in_tree: + from ipalib import plugins + else: + plugins = schema.get_package(api) + + return plugins diff --git a/ipaclient/remote_plugins/schema.py b/ipaclient/remote_plugins/schema.py new file mode 100644 index 000000000..7d1b1e4fa --- /dev/null +++ b/ipaclient/remote_plugins/schema.py @@ -0,0 +1,302 @@ +# +# Copyright (C) 2016 FreeIPA Contributors see COPYING for license +# + +import collections +import os.path +import sys +import types + +import six + +from ipaclient.plugins.rpcclient import rpcclient +from ipalib import Command +from ipalib import parameters, plugable +from ipalib.output import Output +from ipalib.parameters import Bool, DefaultFrom, Flag, Password, Str +from ipalib.text import ConcatenatedLazyText +from ipapython.dn import DN +from ipapython.dnsutil import DNSName + +if six.PY3: + unicode = str + +_TYPES = { + 'DN': DN, + 'DNSName': DNSName, + 'NoneType': type(None), + 'Sequence': collections.Sequence, + 'bool': bool, + 'dict': dict, + 'int': int, + 'list': list, + 'tuple': tuple, + 'unicode': unicode, +} + +_PARAMS = { + 'Decimal': parameters.Decimal, + 'DN': parameters.DNParam, + 'DNSName': parameters.DNSNameParam, + 'bool': parameters.Bool, + 'bytes': parameters.Bytes, + 'datetime': parameters.DateTime, + 'int': parameters.Int, + 'object': parameters.Any, + 'str': parameters.Str, +} + + +class SchemaCommand(Command): + def __fix_default_from(self, param): + api = self.api + name = self.name + param_name = param.name + keys = param.default_from.keys + + if keys: + def callback(*args): + kw = dict(zip(keys, args)) + result = api.Command.command_defaults( + name, + params=[param_name], + kw=kw, + )['result'] + return result.get(param_name) + else: + def callback(): + result = api.Command.command_defaults( + name, + params=[param_name], + )['result'] + return result.get(param_name) + + callback.__name__ = '{0}_{1}_default'.format(name, param_name) + + return param.clone(default_from=DefaultFrom(callback, *keys)) + + def get_args(self): + for arg in super(SchemaCommand, self).get_args(): + if arg.default_from is not None: + arg = self.__fix_default_from(arg) + yield arg + + def get_options(self): + skip = set() + for option in super(SchemaCommand, self).get_options(): + if option.name in skip: + continue + if option.name in ('all', 'raw'): + skip.add(option.name) + if option.default_from is not None: + option = self.__fix_default_from(option) + if (isinstance(option, Bool) and + option.autofill and + option.default is False): + option = option.clone_retype(option.name, Flag) + yield option + + +def _nope(): + pass + + +def _create_param_convert_scalar(cls): + def _convert_scalar(self, value, index=None): + if isinstance(value, unicode): + return value + return super(cls, self)._convert_scalar(value) + + return _convert_scalar + + +def _create_param(meta): + type_name = str(meta['type']) + sensitive = meta.get('sensitive', False) + + if type_name == 'str' and sensitive: + cls = Password + sensitive = False + else: + try: + cls = _PARAMS[type_name] + except KeyError: + cls = Str + + kwargs = {} + default = None + + for key, value in meta.items(): + if key in ('alwaysask', + 'autofill', + 'doc', + 'label', + 'multivalue', + 'no_convert', + 'option_group', + 'required', + 'sortorder'): + kwargs[key] = value + elif key in ('cli_metavar', + 'cli_name', + 'hint'): + kwargs[key] = str(value) + elif key == 'confirm' and issubclass(cls, parameters.Password): + kwargs[key] = value + elif key == 'default': + default = value + elif key == 'default_from_param': + kwargs['default_from'] = DefaultFrom(_nope, + *(str(k) for k in value)) + elif key in ('deprecated_cli_aliases', + 'exclude', + 'include'): + kwargs[key] = tuple(str(v) for v in value) + elif key in ('dnsrecord_extra', + 'dnsrecord_part', + 'no_option', + 'suppress_empty') and value: + kwargs.setdefault('flags', set()).add(key) + + if default is not None: + tmp = cls(str(meta['name']), **dict(kwargs, no_convert=False)) + if tmp.multivalue: + default = tuple(tmp._convert_scalar(d) for d in default) + else: + default = tmp._convert_scalar(default[0]) + kwargs['default'] = default + + param = cls(str(meta['name']), **kwargs) + + if sensitive: + object.__setattr__(param, 'password', True) + + return param + + +def _create_output(schema): + if schema.get('multivalue', False): + type_type = (tuple, list) + if not schema.get('required', True): + type_type = type_type + (type(None),) + else: + try: + type_type = _TYPES[schema['type']] + except KeyError: + type_type = None + else: + if not schema.get('required', True): + type_type = (type_type, type(None)) + + kwargs = {} + kwargs['type'] = type_type + + if 'doc' in schema: + kwargs['doc'] = schema['doc'] + + if schema.get('no_display', False): + kwargs['flags'] = ('no_display',) + + return Output(str(schema['name']), **kwargs) + + +def _create_command(schema): + name = str(schema['name']) + params = {m['name']: _create_param(m) for m in schema['params']} + + command = {} + command['name'] = name + if 'doc' in schema: + command['doc'] = ConcatenatedLazyText(['doc']) + if 'topic_topic' in schema: + command['topic'] = str(schema['topic_topic']) + else: + command['topic'] = None + if 'no_cli' in schema: + command['NO_CLI'] = schema['no_cli'] + command['takes_args'] = tuple( + params[n] for n in schema.get('args_param', [])) + command['takes_options'] = tuple( + params[n] for n in schema.get('options_param', [])) + command['has_output_params'] = tuple( + params[n] for n in schema.get('output_params_param', [])) + command['has_output'] = tuple( + _create_output(m) for m in schema['output']) + + return command + + +def _create_commands(schema): + return [_create_command(s) for s in schema] + + +def _create_topic(schema): + topic = {} + topic['name'] = str(schema['name']) + if 'doc' in schema: + topic['doc'] = ConcatenatedLazyText(schema['doc']) + if 'topic_topic' in schema: + topic['topic'] = str(schema['topic_topic']) + + return topic + + +def _create_topics(schema): + return [_create_topic(s) for s in schema] + + +def get_package(api): + package_name = '{}${}'.format(__name__, id(api)) + package_dir = '{}${}'.format(os.path.splitext(__file__)[0], id(api)) + + try: + return sys.modules[package_name] + except KeyError: + pass + + client = rpcclient(api) + client.finalize() + + client.connect(verbose=False) + try: + schema = client.forward(u'schema', version=u'2.170')['result'] + finally: + client.disconnect() + + commands = _create_commands(schema['commands']) + topics = _create_topics(schema['topics']) + + package = types.ModuleType(package_name) + package.__file__ = os.path.join(package_dir, '__init__.py') + package.modules = [] + sys.modules[package_name] = package + + module_name = '.'.join((package_name, 'commands')) + module = types.ModuleType(module_name) + module.__file__ = os.path.join(package_dir, 'commands.py') + module.register = plugable.Registry() + package.modules.append('commands') + sys.modules[module_name] = module + + for command in commands: + name = command.pop('name') + command = type(name, (SchemaCommand,), command) + command.__module__ = module_name + command = module.register()(command) + setattr(module, name, command) + + for topic in topics: + name = topic.pop('name') + module_name = '.'.join((package_name, name)) + try: + module = sys.modules[module_name] + except KeyError: + module = sys.modules[module_name] = types.ModuleType(module_name) + module.__file__ = os.path.join(package_dir, '{}.py'.format(name)) + module.__dict__.update(topic) + try: + module.__doc__ = module.doc + except AttributeError: + pass + + return package diff --git a/ipaclient/setup.py.in b/ipaclient/setup.py.in index 30fb5ba80..23249dfd0 100644 --- a/ipaclient/setup.py.in +++ b/ipaclient/setup.py.in @@ -62,6 +62,7 @@ def setup_package(): packages = [ "ipaclient", "ipaclient.plugins", + "ipaclient.remote_plugins", ], scripts=['../ipa'], data_files = [('share/man/man1', ["../ipa.1"])], diff --git a/ipalib/__init__.py b/ipalib/__init__.py index dffe2315e..0070e62db 100644 --- a/ipalib/__init__.py +++ b/ipalib/__init__.py @@ -907,15 +907,20 @@ class API(plugable.API): @property def packages(self): - import ipalib.plugins - result = (ipalib.plugins,) - if self.env.in_server: + import ipalib.plugins import ipaserver.plugins - result += (ipaserver.plugins,) + result = ( + ipalib.plugins, + ipaserver.plugins, + ) else: + import ipaclient.remote_plugins import ipaclient.plugins - result += (ipaclient.plugins,) + result = ( + ipaclient.remote_plugins.get_package(self), + ipaclient.plugins, + ) if self.env.context in ('installer', 'updates'): import ipaserver.install.plugins diff --git a/ipalib/plugable.py b/ipalib/plugable.py index b248a2c28..497b5450e 100644 --- a/ipalib/plugable.py +++ b/ipalib/plugable.py @@ -524,7 +524,7 @@ class API(ReadOnly): ) self.log.debug("importing all plugin modules in %s...", package_name) - modules = find_modules_in_dir(package_dir) + modules = getattr(package, 'modules', find_modules_in_dir(package_dir)) modules = ['.'.join((package_name, name)) for name in modules] for name in modules: @@ -88,6 +88,7 @@ def main(options): api.bootstrap( context='cli', in_server=False, + in_tree=True, debug=False, verbose=0, validate_api=True, @@ -98,9 +99,6 @@ def main(options): realm='IPA.EXAMPLE', ) - from ipaserver.plugins import ldap2 - api.add_module(ldap2) - from ipaserver.install.plugins import update_managed_permissions api.add_module(update_managed_permissions) @@ -458,6 +458,7 @@ def main(): cfg = dict( context='cli', in_server=False, + in_tree=True, debug=False, verbose=0, validate_api=True, |