3

�d[e]��@s�
dZd
dl
Z
d
dlZd
dlmZ
d
dlmZ
d
dlmZ
d
dl	m
Z
mZ
d
dlm
Z
mZmZmZ
d
dlmZ
d
d	lmZ
d
d
lmZmZmZ
d
dlmZ
d
dlmZmZmZmZmZmZm Z 
d
d
l!m"Z"m#Z#
d
dl$m%Z%m&Z&
d
dl'm(Z(m)Z)m*Z*
ej+r�e,Z-e
j.e/�
Z0dZ1dd�Z2dd�Z3dd�Z4Gdd�de
�Z5iZ6Gdd�de5�Z7Gdd�de7�Z8Gdd�de7�Z9Gdd �d e5�Z:Gd!d"�d"e
�Z;Gd#d$�d$e;e7�Z<Gd%d&�d&e
�Z=dS)'z)
Base classes for all front-end plugins.
�N)
�API_VERSION)
�
APIVersion)
�	NameSpace)�Plugin�APINameSpace)�create_param�Param�Str�Flag)
�create_signature)
�Password)�Output�Entry�
ListOfEntries)
�
_)�ZeroArgumentError�MaxArgumentError�OverlapError�VersionError�OptionError�ValidationError�ConversionError)�errors�messages)�context�
context_frame)�
classproperty�classobjectproperty�json_serializeZvalidation_rulec

Cs t|t
�st�
t|t
d
�
|S)NT)�hasattr�	RULE_FLAG�AssertionError�setattr)
�obj�r$�/usr/lib/python3.6/frontend.py�rule2s


r&c

Cst|�
ot
|td
�dkS)NFT)�callable�getattrr )
r#r$r$r%�is_rule7s
r)c
CsHd
}
x>|D]6}t||�
t
kr0|
t||�
}
q
|
t||�
}
q
W|
S)z�
    Return the number of entries in an entry. This is primarly for the
    failed output parameter so we don't print empty values.

    We also use this to determine if a non-zero return value is needed.
    r
)�type�dict�entry_count�len)�entryZnum_entries�
fr$r$r%r,;s



r,c@s>eZ
dZd
ZdZd
dd�
Zddd�
Zdd	d
�
Zedd��
Z	dS)�HasParama�
    Base class for plugins that have `Param` `NameSpace` attributes.

    Subclasses of `HasParam` will on one or more attributes store `NameSpace`
    instances containing zero or more `Param` instances.  These parameters might
    describe, for example, the arguments and options a command takes, or the
    attributes an LDAP entry can include, or whatever else the subclass sees
    fit.

    Although the interface a subclass must implement is very simple, it must
    conform to a specific naming convention: if you want a namespace
    ``SubClass.foo``, you must define a ``Subclass.takes_foo`` attribute and a
    ``SubCLass.get_foo()`` method, and you may optionally define a
    ``SubClass.check_foo()`` method.


    A quick big-picture example
    ===========================

    Say you want the ``options`` instance attribute on your subclass to be a
    `Param` `NameSpace`... then according to the enforced naming convention,
    your subclass must define a ``takes_options`` attribute and a
    ``get_options()`` method.  For example:

    >>> from ipalib import Str, Int
    >>> class Example(HasParam):
    ...
    ...     options = None  # This will be replaced with your namespace
    ...
    ...     takes_options = (Str('one'), Int('two'))
    ...
    ...     def get_options(self):
    ...         return self._get_param_iterable('options')
    ...
    >>> eg = Example()

    The ``Example.takes_options`` attribute is a ``tuple`` defining the
    parameters you want your ``Example.options`` namespace to contain.  Your
    ``Example.takes_options`` attribute will be accessed via
    `HasParam._get_param_iterable()`, which, among other things, enforces the
    ``('takes_' + name)`` naming convention.  For example:

    >>> eg._get_param_iterable('options')
    (Str('one'), Int('two'))

    The ``Example.get_options()`` method simply returns
    ``Example.takes_options`` by calling `HasParam._get_param_iterable()`.  Your
    ``Example.get_options()`` method will be called via
    `HasParam._filter_param_by_context()`, which, among other things, enforces
    the ``('get_' + name)`` naming convention.  For example:

    >>> list(eg._filter_param_by_context('options'))
    [Str('one'), Int('two')]

    At this point, the ``eg.options`` instance attribute is still ``None``:

    >>> eg.options is None
    True

    `HasParam._create_param_namespace()` will create the ``eg.options``
    namespace from the parameters yielded by
    `HasParam._filter_param_by_context()`.  For example:

    >>> eg._create_param_namespace('options')
    >>> eg.options
    NameSpace(<2 members>, sort=False)
    >>> list(eg.options)  # Like dict.__iter__()
    ['one', 'two']

    Your subclass can optionally define a ``check_options()`` method to perform
    sanity checks.  If it exists, the ``check_options()`` method is called by
    `HasParam._create_param_namespace()` with a single value, the `NameSpace`
    instance it created.  For example:

    >>> class Example2(Example):
    ...
    ...     def check_options(self, namespace):
    ...         for param in namespace():  # Like dict.itervalues()
    ...             if param.name == 'three':
    ...                 raise ValueError("I dislike the param 'three'")
    ...         print '  ** Looks good! **'  # Note output below
    ...
    >>> eg = Example2()
    >>> eg._create_param_namespace('options')
      ** Looks good! **
    >>> eg.options
    NameSpace(<2 members>, sort=False)

    However, if we subclass again and add a `Param` named ``'three'``:

    >>> class Example3(Example2):
    ...
    ...     takes_options = (Str('one'), Int('two'), Str('three'))
    ...
    >>> eg = Example3()
    >>> eg._create_param_namespace('options')
    Traceback (most recent call last):
      ...
    ValueError: I dislike the param 'three'
    >>> eg.options is None  # eg.options was not set
    True


    The Devil and the details
    =========================

    In the above example, ``takes_options`` is a ``tuple``, but it can also be
    a param spec (see `create_param()`), or a callable that returns an iterable
    containing one or more param spec.  Regardless of how ``takes_options`` is
    defined, `HasParam._get_param_iterable()` will return a uniform iterable,
    conveniently hiding the details.

    The above example uses the simplest ``get_options()`` method possible, but
    you could instead implement a ``get_options()`` method that would, for
    example, produce (or withhold) certain parameters based on the whether
    certain plugins are loaded.

    Think of ``takes_options`` as declarative, a simple definition of *what*
    parameters should be included in the namespace.  You should only implement
    a ``takes_options()`` method if a `Param` must reference attributes on your
    plugin instance (for example, for validation rules); you should not use a
    ``takes_options()`` method to filter the parameters or add any other
    procedural behaviour.

    On the other hand, think of the ``get_options()`` method as imperative, a
    procedure for *how* the parameters should be created and filtered.  In the
    example above the *how* just returns the *what* unchanged, but arbitrary
    logic can be implemented in the ``get_options()`` method.  For example, you
    might filter certain parameters from ``takes_options`` base on some
    criteria, or you might insert additional parameters provided by other
    plugins.

    The typical use case for using ``get_options()`` this way is to procedurally
    generate the arguments and options for all the CRUD commands operating on a
    specific LDAP object: the `Object` plugin defines the possible LDAP entry
    attributes (as `Param`), and then the CRUD commands intelligently build
    their ``args`` and ``options`` namespaces based on which attribute is the
    primary key.  In this way new LDAP attributes (aka parameters) can be added
    to the single point of definition (the `Object` plugin), and all the
    corresponding CRUD commands pick up these new parameters without requiring
    modification.  For an example of how this is done, see the
    `ipalib.crud.Create` base class.

    However, there is one type of filtering you should not implement in your
    ``get_options()`` method, because it's already provided at a higher level:
    you should not filter parameters based on the value of ``api.env.context``
    nor (preferably) on any values in ``api.env``.
    `HasParam._filter_param_by_context()` already does this by calling
    `Param.use_in_context()` for each parameter.  Although the base
    `Param.use_in_context()` implementation makes a decision solely on the value
    of ``api.env.context``, subclasses can override this with implementations
    that consider arbitrary ``api.env`` values.
    F�takescCsp|d
|
}t||d�}t
|�
tkr(|St|ttf�r<|f
St|�
rJ|�S|dkrXt�Std|j||f�
�
dS)a�
        Return an iterable of params defined by the attribute named ``name``.

        A sequence of params can be defined one of three ways: as a ``tuple``;
        as a callable that returns an iterable; or as a param spec (a `Param` or
        ``str`` instance).  This method returns a uniform iterable regardless of
        how the param sequence was defined.

        For example, when defined with a tuple:

        >>> class ByTuple(HasParam):
        ...     takes_args = (Param('foo'), Param('bar'))
        ...
        >>> by_tuple = ByTuple()
        >>> list(by_tuple._get_param_iterable('args'))
        [Param('foo'), Param('bar')]

        Or you can define your param sequence with a callable when you need to
        reference attributes on your plugin instance (for validation rules,
        etc.).  For example:

        >>> class ByCallable(HasParam):
        ...     def takes_args(self):
        ...         yield Param('foo', self.validate_foo)
        ...         yield Param('bar', self.validate_bar)
        ...
        ...     def validate_foo(self, _, value, **kw):
        ...         if value != 'Foo':
        ...             return _("must be 'Foo'")
        ...
        ...     def validate_bar(self, _, value, **kw):
        ...         if value != 'Bar':
        ...             return _("must be 'Bar'")
        ...
        >>> by_callable = ByCallable()
        >>> list(by_callable._get_param_iterable('args'))
        [Param('foo', validate_foo), Param('bar', validate_bar)]

        Lastly, as a convenience for when a param sequence contains a single
        param, your defining attribute may a param spec (either a `Param`
        or an ``str`` instance).  For example:

        >>> class BySpec(HasParam):
        ...     takes_args = Param('foo')
        ...     takes_options = 'bar?'
        ...
        >>> by_spec = BySpec()
        >>> list(by_spec._get_param_iterable('args'))
        [Param('foo')]
        >>> list(by_spec._get_param_iterable('options'))
        ['bar?']

        For information on how an ``str`` param spec is interpreted, see the
        `create_param()` and `parse_param_spec()` functions in the
        `ipalib.parameters` module.

        Also see `HasParam._filter_param_by_context()`.
        rNz0%s.%s must be a tuple, callable, or spec; got %r)	r(r*�tuple�
isinstancer�strr'�	TypeError�name)�selfr6�verbZsrc_name�srcr$r$r%�_get_param_iterable�s;











zHasParam._get_param_iterableNccs�t|d
|�}d|
}t
||�s0td|j|f�
�
t||�}t|�
sVtd|j||f�
�
x.|�D]$}t|�
}|dks||j|�
r^|V
q^WdS)aK
        Filter params on attribute named ``name`` by environment ``env``.

        For example:

        >>> from ipalib.config import Env
        >>> class Example(HasParam):
        ...
        ...     takes_args = (
        ...         Str('foo_only', include=['foo']),
        ...         Str('not_bar', exclude=['bar']),
        ...         'both',
        ...     )
        ...
        ...     def get_args(self):
        ...         return self._get_param_iterable('args')
        ...
        ...
        >>> eg = Example()
        >>> foo = Env(context='foo')
        >>> bar = Env(context='bar')
        >>> another = Env(context='another')
        >>> (foo.context, bar.context, another.context)
        (u'foo', u'bar', u'another')
        >>> list(eg._filter_param_by_context('args', foo))
        [Str('foo_only', include=['foo']), Str('not_bar', exclude=['bar']), Str('both')]
        >>> list(eg._filter_param_by_context('args', bar))
        [Str('both')]
        >>> list(eg._filter_param_by_context('args', another))
        [Str('not_bar', exclude=['bar']), Str('both')]
        �envZget_z%s.%s()z %s.%s must be a callable; got %rN)r(r�NotImplementedErrorr6r'r5rZuse_in_context)r7r6r;Zget_name�get�spec�paramr$r$r%�_filter_param_by_context5
s 











z!HasParam._filter_param_by_contextcCsNt|j
|
|�d
d�}|jj�s>t|d|
d�}t|�
r>||�

t||
|�
dS)NF)
�sortZcheck_)rr@�apiZis_production_moder(r'r")r7r6r;�	namespaceZcheckr$r$r%�_create_param_namespacee
s








z HasParam._create_param_namespacec


Cstj
S)
N)rZ
current_frame)
r7r$r$r%rp
szHasParam.context)
r1)
N)
N)
�__name__�
__module__�__qualname__�__doc__�NO_CLIr:r@rD�propertyrr$r$r$r%r0Ls
K
0
r0cs
eZ
dZd
Ze�Ze�Zejd�
Z	ejd�
Z
ejd�
Zejd�
ZdZ
dZejd�
ZdaZejd
�
Ze�Ze�ZdZed�
ZdbZeZed
d��
Zee�
Zeedd��
�
Ze dd��
Z!dd�Z"dd�Z#dd�Z$dd�Z%dd�Z&dd�Z'dd �Z(d!d"�Z)d#d$�Z*d%d&�Z+d'd(�Z,dd)e-�dfd*d+�
Z.d,d-�Z/d.d/�Z0dcd0d1�
Z1d2d3�Z2d4d5�Z3d6d7�Z4d8d9�Z5d:d;�Z6d<d=�Z7d>d?�Z8�f
d@dA�Z9dBdC�Z:dDdE�Z;dFdG�Z<dHdI�Z=ef
dJdK�
Z>dLdM�Z?dNdO�Z@dPdQ�ZAdRdS�ZBddZCdWdX�ZDedYdZ��
ZEeded[d\�
�
ZFedfd]d^�
�
ZGd_d`�ZH�ZIS)g�Commanda�
    A public IPA atomic operation.

    All plugins that subclass from `Command` will be automatically available
    as a CLI command and as an XML-RPC method.

    Plugins that subclass from Command are registered in the ``api.Command``
    namespace. For example:

    >>> from ipalib import create_api
    >>> api = create_api()
    >>> class my_command(Command):
    ...     pass
    ...
    >>> api.add_plugin(my_command)
    >>> api.finalize()
    >>> list(api.Command)
    [<class '__main__.my_command'>]
    >>> api.Command.my_command # doctest:+ELLIPSIS
    ipalib.frontend.my_command()

    This class's subclasses allow different types of callbacks to be added and
    removed to them.
    Registering a callback is done either by ``register_callback``, or by
    defining a ``<type>_callback`` method.

    Subclasses should define the `callback_types` attribute as a tuple of
    allowed callback types.
    �args�options�params�params_by_defaultNT�output�result�
output_paramsz1Results are truncated, try a more specific search�interactive_promptc

Cs|jj
d
�
dS)N�
.�)rF�
rpartition)
�clsr$r$r%Z__topic_getter�
szCommand.__topic_gettercCsRt|d
�r|j
S|j�r"d|_
dS|
dkr@ddlm}
||d�
}
t|
�
|_
}|S)N�
_signaturer
)
rB)rrX�__subclasses__�ipalibrBr)rWr#rBZ	signaturer$r$r%�
__signature__�
s








zCommand.__signature__c


Cs|jS)
N)
�	full_name)
r7r$r$r%�forwarded_name�
szCommand.forwarded_namec
Os6|j�
t
��
ttd
d�|j_|j|
|�
SQRXdS)z�
        Perform validation and then execute the command.

        If not in a server context, the call will be forwarded over
        XML-RPC and the executed an the nearest IPA server.
        �	principalN)Zensure_finalizedrr(rr^�_Command__do_call)r7rLrMr$r$r%�__call__�
s


zCommand.__call__c
Os�
g|j_
d
|kr$|jt|d
�
�

nH|jjjrD|jjjrDd|d
<n(|j|d
<|jjjrl|j	t
j|jd�
�

|j|
|�
}t
jd|jdj|jf|�
�
�
|jjjr�|j|jf|�
�

|jf|�
}|jf|�
}t
jd|jdj|jf|�
�
�
|jjjr�|jf|�

|jf|�
\}
}|j|
|�
}t|t��
rLx$|jj
D]}t
j	|d
||�
�
q0Wt|t��
r|d|jk�
r|d|k�
r||j|�
|d<|j�
r�|j�
s�|dk	�
r�|j||d
�
|S)N�versionz2.0)
Zserver_versionzraw: %s(%s)z, z%s(%s)�summary)r�_Command__messages�verify_client_version�unicoderBr;Zskip_version_check�	in_server�api_version�add_messagerZVersionMissing�args_options_2_params�logger�debugr6�join�
_repr_iter�update�get_default�	normalize�convert�validate�params_2_args_options�runr3r+rP�get_summary_default�use_output_validation�validate_output)r7rLrMrN�ret�messager$r$r%Z	__do_call�
s@































zCommand.__do_callcCs|jj
j|
�

dS)
N)rrc�append)r7ryr$r$r%rh
s
zCommand.add_messagec
ksrx.|j�D]"}|
j
|jd
�}t|j|�
�
V
q
Wx<|j�D]0}|j|
krJq:|
|j}d|j|j|�
fV
q:Wd
S)af
        Iterate through ``repr()`` of *safe* values of args and options.

        This method uses `parameters.Param.safe_value()` to mask passwords when
        logging.  Logging the exact call is extremely useful, but we obviously
        don't want to log the cleartext password.

        For example:

        >>> class my_cmd(Command):
        ...     takes_args = ('login',)
        ...     takes_options=(Password('passwd'),)
        ...
        >>> c = my_cmd()
        >>> c.finalize()
        >>> list(c._repr_iter(login=u'Okay.', passwd=u'Private!'))
        ["u'Okay.'", "passwd=u'********'"]
        Nz%s=%r)rLr=r6�reprZ
safe_valuerM)r7rN�arg�value�optionr$r$r%rms








zCommand._repr_iterc
Os�|jd
k	r>t
|
�
|jkr>|jdkr.t|jd�
�
t|j|jd��
t|j|�
�
}t
|
�
dkr�t|j|
�
�
}t|�
j	|�
}t
|�
dkr�t
t|�
d�
�
|j|�

|S)z4
        Merge (args, options) into params.
        Nr
)
r6)r6�count)
�names)
�max_argsr-rr6rr+�_Command__options_2_params�_Command__args_2_params�set�intersectionr�sortedrn)r7rLrMrNZarg_kwr�r$r$r%ri s












zCommand.args_options_2_paramsccs�d
}x�t|j
��
D]�\}}|s$t�
t|
�
|kr�|jr�d}t|
�
|dkrpt|
|�
ttfkrp|j|
|fV
q�|j|
|d�fV
q�|j|
|fV
qPqWdS)NFT�
)	�	enumeraterLr!r-�
multivaluer*�listr2r6)r7�valuesr��
ir|r$r$r%Z__args_2_params1s







$
zCommand.__args_2_paramsccsTx&|jD]}||
kr||
j
|�
fV
qWt|
�
j|j�
}|rPttd
�
|j
�d��
dS)NzUnknown option: %(option)s)
r~)rN�popr��
difference�internal_optionsrr)r7rMr6Zunused_keysr$r$r%Z__options_2_paramsAs





zCommand.__options_2_paramsc
Os|j|
|�
}t
|j|�
�
S)
zK
        Creates a LDAP entry from attributes in args and options.
        )rir+�_Command__attributes_2_entry)r7rLrM�kwr$r$r%�args_options_2_entryKs
zCommand.args_options_2_entryccsXxR|jD]H}|j|j
r||
kr|
|}t|t�rB|t|�
fV
q||
|fV
qWdS)
N)rNZ	attributer3r2r�)r7r�r6r}r$r$r%Z__attributes_2_entryRs





zCommand.__attributes_2_entryc
Kspt�}t
|j|
�
�
}d
}xN|jD]D}y|
|}Wntk
rJ


d}w YnX|r\||f
7}q |||<q W||fS)z4
        Split params into (args, options).
        TF)r2r+�_Command__params_2_optionsrL�KeyError)r7rNrLrMZis_argr6r}r$r$r%rs[s








zCommand.params_2_args_optionsccs*x$|jD]}||
kr||
|fV
qWdS)
N)
rM)r7rNr6r$r$r%Z__params_2_optionsps


zCommand.__params_2_optionsFcCs�|d
kr|
j}xr|j
jj|||d�}|j�s0d
Sy|
|f
|�
Sttfk
r|
}
z |j
jjt|�
t|j	�
�
WYd
d
}~XqXqWd
S)zm
        Prompts the user for the value of given parameter.

        Returns the parameter instance.
        N)
�optional)
�label�Backend�textui�prompt�striprrZprint_prompt_attribute_errorre�error)r7r?�defaultr�r�r��raw�
er$r$r%�prompt_paramus





zCommand.prompt_paramc
st�f
d
d�|
j
�D�
�
S)a�

        Return a dictionary of normalized values.

        For example:

        >>> class my_command(Command):
        ...     takes_options = (
        ...         Param('first', normalizer=lambda value: value.lower()),
        ...         Param('last'),
        ...     )
        ...
        >>> c = my_command()
        >>> c.finalize()
        >>> c.normalize(first=u'JOHN', last=u'DOE')
        {'last': u'DOE', 'first': u'john'}
        c
3s&|]\}
}|
�j|
j
|�
fV
qdS)
N)rNrp)�.0�
k�
v)
r7r$r%�	<genexpr>�sz$Command.normalize.<locals>.<genexpr>)r+�items)r7r�r$)
r7r%rp�s
zCommand.normalizec
st�f
d
d�|
j
�D�
�
S)a�

        Return a dictionary of values converted to correct type.

        >>> from ipalib import Int
        >>> class my_command(Command):
        ...     takes_args = (
        ...         Int('one'),
        ...         'two',
        ...     )
        ...
        >>> c = my_command()
        >>> c.finalize()
        >>> c.convert(one=1, two=2)
        {'two': u'2', 'one': 1}
        c
3s&|]\}
}|
�j|
j
|�
fV
qdS)
N)rNrq)r�r�r�)
r7r$r%r��sz"Command.convert.<locals>.<genexpr>)r+r�)r7r�r$)
r7r%rq�s
zCommand.convertcs.|
d
kr�f
dd�|j�D�
}
t
|j|
���
S)a�

        Return a dictionary of defaults for all missing required values.

        For example:

        >>> from ipalib import Str
        >>> class my_command(Command):
        ...     takes_args = Str('color', default=u'Red')
        ...
        >>> c = my_command()
        >>> c.finalize()
        >>> c.get_default()
        {'color': u'Red'}
        >>> c.get_default(color=u'Yellow')
        {}
        Nc
s(g|] }
|
j�kr|
j
s|
jr|
j�qSr$)r6�requiredZautofill)r��
p)
r�r$r%�
<listcomp>�s
z'Command.get_default.<locals>.<listcomp>)rNr+�_Command__get_default_iter)r7Z_paramsr�r$)
r�r%ro�s
zCommand.get_defaultcKst|j
|
g
|��
}|j|
�
S)
z=
        Return default value for parameter `_name`.
        )r+r�r=)r7�_namer�r�r$r$r%�get_default_of�s
zCommand.get_default_ofc	cs"
t�}xNt
|j�
D]@}|j|
ks*|j|kr|jd
kr6qx|jjD]}|j|�

q@WqWx�|j�D]�}d
}d}|j|kr�|j|kr�|||jf
|�
}|jjj	r�|j
|dd�
|||j<n4|d|�
}|jjj	r�|j
|�

|d
k	r�|||j<d}|j|
kr`|�
s|jf|�
}|d
k	r`|j|fV
q`Wd
S)z^
        Generator method used by `Command.get_default` and `Command.get_default_of`.
        NFT)
�supplied)
N)r��reversedrOr6�default_from�keys�addrBr;rfrrro)	r7rNr�Zdepr?r6r�Z
hasdefaultr}r$r$r%Z__get_default_iter�s6






























zCommand.__get_default_iterc
Ks8x2|j�D]&}|
j
|jd
�}|j||j|
kd�
q
Wd
S)z�
        Validate all values.

        If any value fails the validation, `ipalib.errors.ValidationError`
        (or a subclass thereof) will be raised.
        N)
r�)rNr=r6rr)r7r�r?r}r$r$r%rrs

zCommand.validatec
Csdt|j
�
}yt|
�
}Wn(tk
r>


t|
|j
|jjd
��
YnX|j|jkr`t|
|j
|jjd
��
dS)a

        Compare the version the client provided to the version of the
        server.

        If the client major version does not match then return an error.
        If the client minor version is less than or equal to the server
        then let the request proceed.
        )ZcverZsver�serverN)rrg�
ValueErrorrr;Z
xmlrpc_uri�major)r7Zclient_versionZ
server_apiverZ
client_apiverr$r$r%rd
s	









zCommand.verify_client_versionc
Os"|jj
jr|j|
|�
S|j|
|�
S)
a�

        Dispatch to `Command.execute` or `Command.forward`.

        If running in a server context, `Command.execute` is called and the
        actually work this command performs is executed locally.

        If running in a non-server context, `Command.forward` is called,
        which forwards this call over RPC to the exact same command
        on the nearest IPA server and the actual work this command
        performs is executed remotely.
        )rBr;rf�execute�forward)r7rLrMr$r$r%rt#s


zCommand.runc
Ostd
|j
�
�
dS)a�

        Perform the actual work this command does.

        This method should be implemented only against functionality
        in self.api.Backend.  For example, a hypothetical
        user_add.execute() might be implemented like this:

        >>> class user_add(Command):
        ...     def execute(self, **kw):
        ...         return self.api.Backend.ldap.add(**kw)
        ...
        z%s.execute()N)r<r6)r7rLr�r$r$r%r�3s
zCommand.executec
Os�y|jj
j|jf
|
�|�
Stjk
r�
}
zJ|jjjd
kr<�t	|dd�}|dksZ||j
kr\�tj|j
|jd�
�
WYdd}~XnXdS)zG
        Forward call over RPC to this same command on server.
        Zclir6N)
r6)r�Z	rpcclientr�r]rZRequirementErrorrBr;rr(rN�cli_name)r7rLr�r�r6r$r$r%r�Bs









zCommand.forwardc

s0
|jd
�

t
|j�
dks&|jdjr4t
|j�
|_nd|_|jd�

t|j��
t|j��
}
dd�}tt|
|d�d	d
�|_	g}xt|
D]l}t
|�
}xR|
D]J}|j
dkr�q�|j|j
jkr�q�yt
||j|�
�}Wq�tk
r�


Yq�Xq�W|j||�
q�Wt|d	d
�|_t|j�d	d
�|_|jd�

tt|�j�
dS)
a�

        Finalize plugin initialization.

        This method creates the ``args``, ``options``, and ``params``
        namespaces.  This is not done in `Command.__init__` because
        subclasses (like `crud.Add`) might need to access other plugins
        loaded in self.api to determine what their custom `Command.get_args`
        and `Command.get_options` methods should yield.
        rLr
r�NrMc

Ss,|jr(|j
d
kr|j
S|jdkr$d
SdSdS)Nr
r�rU)r�Z	sortorderr�)
r�r$r$r%�get_keybs








z%Command._on_finalize.<locals>.get_key)
�keyF)
rArR���)rDr-rLr�r�r2rMrr�rNr�r6r��min�indexr��insertrO�_iter_outputrP�superrK�_on_finalize)r7Z
params_nosortr�rNr��pos�
j)
�	__class__r$r%r�Qs6
































zCommand._on_finalizec
cs�t|j
�
tk	r,td
|jtt|j
�
|j
f�
�
xXt|j
�
D]J\}
}t|t�rRt|�
}t|t�s|td|j|
ttft|�
|f�
�
|V
q8WdS)Nz&%s.has_output: need a %r; got a %r: %rz*%s.has_output[%d]: need a %r; got a %r: %r)	r*�
has_outputr2r5r6r�r3r4r
)r7r��
or$r$r%r��s









zCommand._iter_outputc
csx|jd
�
D]
}
|
V
qWdS)aM

        Iterate through parameters for ``Command.args`` namespace.

        This method gets called by `HasParam._create_param_namespace()`.

        Subclasses can override this to customize how the arguments are
        determined.  For an example of why this can be useful, see the
        `ipalib.crud.Create` subclass.
        rLN)
r:)r7r|r$r$r%�get_args�s

zCommand.get_argscCsnd
}d
}x`|
�D]V}|r@|jr@t
d|j|jdd�|
�D�
f�
�
|rRt
d|j�
�
|js\d}|jrd}qWdS)z{
        Sanity test for args namespace.

        This method gets called by `HasParam._create_param_namespace()`.
        Fz7%s: required argument after optional in %s arguments %sc
Ssg|]
}
|
j�qSr$)
Z
param_spec)r��
xr$r$r%r��sz&Command.check_args.<locals>.<listcomp>z)%s: only final argument can be multivalueTN)r�r�r6r�)r7rLr�r�r|r$r$r%�
check_args�s











zCommand.check_argsc
cs�x|jd
�
D]
}
|
V
qWxR|j
D]H}t|ttf�r"tddtd�
ddg
d�V
tddtd�
ddg
d�V
Pq"Wtd	td
�
dddgd�V
d
S)a'
        Iterate through parameters for ``Command.options`` namespace.

        This method gets called by `HasParam._create_param_namespace()`.

        For commands that return entries two special options are generated:
        --all   makes the command retrieve/display all attributes
        --raw   makes the command display attributes as they are stored

        Subclasses can override this to customize how the arguments are
        determined.  For an example of why this can be useful, see the
        `ipalib.crud.Create` subclass.
        rM�allzJRetrieve and print all attributes from the server. Affects command output.Zwebui�	no_output)r��doc�exclude�flagsr�zBPrint entries as stored on the server. Only affects output format.zversion?z@Client version. Used to determine if server will accept request.Z	no_option)r�r�r�N)r:r�r3rrr
rr	)r7r~r�r$r$r%�get_options�s&
















zCommand.get_optionsc
Cs
d
|j}t
|
t�s,td|tt|
�
|
f�
�
t|j�
}t|
�
tdg
�
}||kr�||}|rrtd|t|�
|
f�
�
||}|r�td|t|�
|
f�
�
xf|j�D]Z}|
|j}	|jdkp�t
|	|j�s�td||j|jt|	�
|	f�
�
t	|j
�
r�|j
||	|�
q�WdS)zY
        Validate the return value to make sure it meets the interface contract.
        z%s.validate_output()z%s: need a %r; got a %r: %rrz%s: missing keys %r in %rz%s: unexpected keys %r in %rNz%%s:
  output[%r]: need %r; got %r: %r)r6r3r+r5r*r�rPr�r�r'rr)
r7rPra�niceZexpected_setZ
actual_setZmissingZextrar�r}r$r$r%rw�s,





















zCommand.validate_outputc
cs"x|jd
dd�D]
}
|
V
qWdS)NrRZhas)
r8)
r:)r7r?r$r$r%�get_output_params�s

zCommand.get_output_paramscCs|jr|j|
SdSdS)
N)
�msg_summary)r7rPr$r$r%ru�s


zCommand.get_summary_defaultcCsvtt
jt
jt
jt
jd
�}xX|
jdf�D]H}y||d}Wn$tk
r^


t
jd�

t
j}YnX||jd�
�

q&WdS)N)rk�info�warningr�rr*z'Server sent a message with a wrong typery)r+rjrkr�r�r�r=r�)r7rPZlogger_functionsryZfunctionr$r$r%�log_messagess












zCommand.log_messagescOs�
t|t
�sd
Sd}|j|�

g}i}i}x8|j�D],}	|j|	j�

t|	j�
||	j<|	j||	j<q2W|j	dd�r�|j
dd�
d}
nd}
|j	dd�r�d
}�
x\|jD�
]P}|j|}d|jkr�q�|j	|�
}
|d	kr�q�|j�d
kr�|
dkr�d}n"|j�dk�
r
t
|
�
dk�
rq�d}t|t��
r*|
j|
||||
�
q�t|
ttf��
rN|
j|
||||
�
q�t|t��
rn|
j|
||||
�
q�t|
t
��
r�|
j|
||||
�
q�t|
t��
r�|d
k�
r�|
j|
�

n
|
j|
�

q�t|
t��
r�q�t|
t�r�|
j|
dt|j|j�
�
q�W|S)a
        Generic output method. Prints values the output argument according
        to their type and self.output.

        Entry attributes are labeled and printed in the order specified in
        self.output_params. Attributes that aren't present in
        self.output_params are not printed unless the command was invokend
        with the --all option. Attribute labelling is disabled if the --raw
        option was given.

        Subclasses can override this method, if custom output is needed.
        Nr
r�FZdnTr�Z
no_displayr}rr�Zfailedrbz%s %%d)r3r+r�rRrzr6rer�r�r=r�rP�lowerr,rZ
print_entriesr2r�rZprint_entryZ
print_summaryZprint_indented�bool�intZprint_countr�)r7r�rPrLrM�rv�orderZlabelsr�r�Z	print_allr�ZoutprQr$r$r%�output_for_clis^






































 zCommand.output_for_clir6r�rIc
s<t�f
d
d��j
D�
�
}
t�j��
|
d<t�j��
|
d<|
S)Nc
3s|]}
|
t�|
�fV
qdS)
N)
r()r��
a)
r7r$r%r�esz#Command.__json__.<locals>.<genexpr>�
takes_args�
takes_options)r+�json_friendly_attributesr�r�r�)r7�	json_dictr$)
r7r%�__json__cs



zCommand.__json__ccsbtj
|
i�j
|d
g
�}xF|D]>}|d
krTyt|d|
�V
WqZtk
rP


YqZXq|V
qWd
S)z!Yield callbacks of the given typeNz%s_callback)�_callback_registryr=r(�AttributeError)rW�
callback_type�	callbacks�callbackr$r$r%�
get_callbacksms






zCommand.get_callbackscCs~|
|jkst
�
t|�
st
�
tj|
i�
yt|
|}Wn&tk
r\


d
g
}t|
|<YnX|rp|jd|�
n
|j|�

d
S)a�
Register a callback

        :param callback_type: The callback type (e.g. 'pre', 'post')
        :param callback: The callable added
        :param first: If true, the new callback will be added before all
            existing callbacks; otherwise it's added after them

        Note that callbacks registered this way will be attached to this class
        only, not to its subclasses.
        Nr
)�callback_typesr!r'r��
setdefaultr�r�rz)rWr�r��firstr�r$r$r%�register_callback|s







zCommand.register_callbackcCs|jd
|
|�
dS)z9Shortcut for register_callback('interactive_prompt', ...)rSN)
r�)rWr�r�r$r$r%�$register_interactive_prompt_callback�sz,Command.register_interactive_prompt_callbackc
CsdS)
Nr$)r7r�r$r$r%�interactive_prompt_callback�s
z#Command.interactive_prompt_callback)
rQ)
rS)
N)r6r�rI)
F)
F)JrErFrGrHr2r�r�r�
finalize_attrrLrMrNrOr#rvrPr�rRZhas_output_paramsr�r�rZ
msg_truncatedr�rrg�classmethodZ_Command__topic_getterrZtopicrr[rJr]r`r_rhrmrir�r�r�r�rsr�r+r�rprqror�r�rrrdrtr�r�r�r�r�r�r�rwr�rur�r�r�r�r�r�r�r��
__classcell__r$r$)
r�r%rKx
s�
















(
	

-2
%N


rKc@s*eZ
dZd
Zeded�
d�f
Zdd�ZdS)�
LocalOrRemotea[

    A command that is explicitly executed locally or remotely.

    This is for commands that makes sense to execute either locally or
    remotely to return a perhaps different result.  The best example of
    this is the `ipalib.plugins.f_misc.env` plugin which returns the
    key/value pairs describing the configuration state: it can be
    zserver?z,Forward to server instead of running locally)
r�c
Os.|jd
d�r"|j
jr"|j|
|�
S|j|
|�
S)aw

        Dispatch to forward() or execute() based on ``server`` option.

        When running in a client context, this command is executed remotely if
        ``options['server']`` is true; otherwise it is executed locally.

        When running in a server context, this command is always executed
        locally and the value of ``options['server']`` is ignored.
        r�F)r=r;rfr�r�)r7rLrMr$r$r%rt�s


zLocalOrRemote.runN)rErFrGrHr
rr�rtr$r$r$r%r��s
r�c@s eZ
dZd
Zdd�Zdd�ZdS)�Localz�
    A command that is explicitly executed locally.

    This is for commands that makes sense to execute only locally
    such as the help command.
    c
Os|j|
|�
S)
z.
        Dispatch to forward() onlly.
        )
r�)r7rLrMr$r$r%rt�sz	Local.runc
Os|j|
|�
S)
N)
r�)r7rLrMr$r$r%r��s
z
Local.forwardN)rErFrGrHrtr�r$r$r$r%r��sr�cs�eZ
dZejd
�
Zejd�
Zejd�
Zejd�
Zejd�
Z	dZ
e�Z�f
dd�Z
d	d
�Zdd�Zd
d�Zdd�ZdZdd�Z�ZS)�Object�backend�methodsrN�primary_key�params_minus_pkNc
s�t|j
d
�
ddd�|_|jd�

dd�|j�D�
}
t|
�
dkr`td	|jd
jdd�|
D�
�
f�
�
t|
�
dkr�|
d
|_	tdd�|j�D�
dd�|_
nd|_	|j|_
d|jkr�|j|jj
kr�|jj
|j|_tt|�j�
dS)N�MethodF�	attr_name)rAZ	name_attrrNc
Ssg|]}
|
jr|
�qSr$)
r�)r�r�r$r$r%r��sz'Object._on_finalize.<locals>.<listcomp>r�z)%s (Object) has multiple primary keys: %sz, c
ss|]}
|
jV
qdS)
N)
r6)r�r�r$r$r%r��sz&Object._on_finalize.<locals>.<genexpr>r
c
Ssg|]}
|
js|
�qSr$)
r�)r�r�r$r$r%r��s)
rAr�)r�_Object__get_attrsr�rDrNr-r�r6rlr�r�rB�backend_namer�r�r�r�r�)r7Zpkeys)
r�r$r%r��s$














zObject._on_finalizec
gs`t|
�
d
kr(t
|
dttf�r(|
d}
t|
�
}x*|j�D]}|j|ks:||krRq:|V
q:WdS)zA
        Yield all Param whose name is not in ``names``.
        r�r
N)r-r3rr4�	frozensetrNr6)r7r�Zminusr?r$r$r%�params_minus�s 





zObject.params_minusc
Ostd
|j
�
�
dS)z'
        Construct an LDAP DN.
        z%s.get_dn()N)r<r6)r7rL�kwargsr$r$r%�get_dn
sz
Object.get_dnccs^|
|jkrdS|j|
}t
|�
tks(t�
x0|�D]&}|||jk	rDq0|j|jkr0|V
q0WdS)
N)rBr*rr!r6�obj_name)r7r6rCZpluginr$r$r%Z__get_attrss










zObject.__get_attrsc
cs4x.|jd
�
D] }
t
|
ttf�s"t�
t|
�
V
qWdS)zR
        This method gets called by `HasParam._create_param_namespace()`.
        rNN)r:r3r4rr!r)r7r>r$r$r%�
get_paramss

zObject.get_paramsr6�takes_paramsc
s<t�f
d
d��j
D�
�
}
�jr*�jj|
d<t�j�
|
d<|
S)Nc
3s |]}
|
tt
�|
��
fV
qdS)
N)rr()r�r�)
r7r$r%r� s
z"Object.__json__.<locals>.<genexpr>r�r�)r+r�r�r6r�r�)r7r�r$)
r7r%r�s






zObject.__json__)r6r�)rErFrGrr�r�r�rNr�r�r�r2r�r�r�r�r�r�r�r�r�r$r$)
r�r%r��s









	r�c@sDeZ
dZd
ZdZedd��
Zedd��
Zedd��
Zed	d
��
Z	dS)�	Attributea]
    Base class implementing the attribute-to-object association.

    `Attribute` plugins are associated with an `Object` plugin to group
    a common set of commands that operate on a common set of parameters.

    The association between attribute and object is done using a simple
    naming convention: the first part of the plugin class name (up to the
    first underscore) is the object name, and rest is the attribute name,
    as this table shows:

    ===============  ===========  ==============
    Class name       Object name  Attribute name
    ===============  ===========  ==============
    noun_verb        noun         verb
    user_add         user         add
    user_first_name  user         first_name
    ===============  ===========  ==============

    For example:

    >>> class user_add(Attribute):
    ...     pass
    ...
    >>> instance = user_add()
    >>> instance.obj_name
    'user'
    >>> instance.attr_name
    'add'

    In practice the `Attribute` class is not used directly, but rather is
    only the base class for the `Method` class.  Also see the `Object` class.
    �
1c

Cs|jj
d
�
dS)Nrr
)r6�	partition)
r7r$r$r%r�MszAttribute.obj_namec

Cs|jdk	r|jj
SdSdS)
N)r#r\)
r7r$r$r%�
obj_full_nameQs

zAttribute.obj_full_namec
Cs.d
j|j
�
}
|jj|
�
st�
|jt|
�
d�S)Nz{}_)�formatr�r6�
startswithr!r-)r7�prefixr$r$r%r�Xs

zAttribute.attr_namec

Cs0|jdk	r(|j
dk	r(|jj|j|j
fSdSdS)
N)r��obj_versionrBr�)
r7r$r$r%r#^s
z
Attribute.objN)
rErFrGrHr
rJr�r
r�r#r$r$r$r%r
)s!
r
cs(eZ
dZd
ZdZdZ�f
dd�Z�ZS)r�a�
    A command with an associated object.

    A `Method` plugin must have a corresponding `Object` plugin.  The
    association between object and method is done through a simple naming
    convention: the first part of the method name (up to the first under
    score) is the object name, as the examples in this table show:

    =============  ===========  ==============
    Method name    Object name  Attribute name
    =============  ===========  ==============
    user_add       user         add
    noun_verb      noun         verb
    door_open_now  door         open_now
    =============  ===========  ==============

    There are three different places a method can be accessed.  For example,
    say you created a `Method` plugin and its corresponding `Object` plugin
    like this:

    >>> from ipalib import create_api
    >>> api = create_api()
    >>> class user_add(Method):
    ...     def run(self, **options):
    ...             return dict(result='Added the user!')
    ...
    >>> class user(Object):
    ...     pass
    ...
    >>> api.add_plugin(user_add)
    >>> api.add_plugin(user)
    >>> api.finalize()

    First, the ``user_add`` plugin can be accessed through the ``api.Method``
    namespace:

    >>> list(api.Method)
    [<class '__main__.user_add'>]
    >>> api.Method.user_add(version=u'2.88')  # Will call user_add.run()
    {'result': 'Added the user!'}

    (The "version" argument is the API version to use.
    The current API version can be found in ipalib.version.API_VERSION.)

    Second, because `Method` is a subclass of `Command`, the ``user_add``
    plugin can also be accessed through the ``api.Command`` namespace:

    >>> list(api.Command)
    [<class '__main__.user_add'>]
    >>> api.Command.user_add(version=u'2.88') # Will call user_add.run()
    {'result': 'Added the user!'}

    And third, ``user_add`` can be accessed as an attribute on the ``user``
    `Object`:

    >>> list(api.Object)
    [<class '__main__.user'>]
    >>> list(api.Object.user.methods)
    ['add']
    >>> api.Object.user.methods.add(version=u'2.88') # Will call user_add.run()
    {'result': 'Added the user!'}

    The `Attribute` base class implements the naming convention for the
    attribute-to-object association.  Also see the `Object` class.
    Fc
#sR|jdk	r0x$|jj
�D]}
d
|
jkr&q|
V
qWxtt|�j�D]
}
|
V
q@WdS)Nr�)r#rNr�r�r�r�)r7r?)
r�r$r%r��s









zMethod.get_output_params)rErFrGrHZextra_options_firstZextra_args_firstr�r�r$r$)
r�r%r�fsA

r�c@s eZ
dZd
Zdd�Zdd�ZdS)�Updatera�
    An LDAP update with an associated object (always update).

    All plugins that subclass from `Updater` will be automatically available
    as a server update function.

    Plugins that subclass from Updater are registered in the ``api.Updater``
    namespace. For example:

    >>> from ipalib import create_api
    >>> api = create_api()
    >>> class my(Object):
    ...     pass
    ...
    >>> api.add_plugin(my)
    >>> class my_update(Updater):
    ...     pass
    ...
    >>> api.add_plugin(my_update)
    >>> api.finalize()
    >>> list(api.Updater)
    [<class '__main__.my_update'>]
    >>> api.Updater.my_update # doctest:+ELLIPSIS
    ipalib.frontend.my_update()
    c
Kstd
|j
�
�
dS)Nz%s.execute())r<r6)r7rMr$r$r%r��s
zUpdater.executec
Kstj
d
|j�
|jf|
�
S)Nzraw: %s)rjrkr6r�)r7rMr$r$r%r`�s


zUpdater.__call__N)rErFrGrHr�r`r$r$r$r%r
�s
r
)>rHZloggingZsixZipapython.versionrZipapython.ipautilrZipalib.baserZipalib.plugablerrZipalib.parametersrrr	r
rrZ
ipalib.outputr
rrZipalib.textrZ
ipalib.errorsrrrrrrrrZrrZipalib.requestrrZipalib.utilrrrZPY3r4reZ	getLoggerrErjr r&r)r,r0r�rKr�r�r�r
r�r
r$r$r$r%�<module>sN









$



++[=O