#xPc @ s d Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k
Z
d d k Z y d d k Z Wn e
j
o n Xd d k Z d d k Z d d k Z d d k Z d d k l Z l Z l Z l Z l Z l Z l Z l Z l Z l Z d d k l Z d d k l Z l! Z! l" Z" l# Z# l$ Z$ d d k% l& Z& d d k' l( Z( d Z) d Z* d
e i+ f d YZ, d e i- f d
YZ. d e i/ f d YZ0 d e i/ f d YZ1 d e i/ f d YZ2 e. e1 e2 f Z3 d e4 f d YZ5 d e i6 f d YZ7 d e i8 f d YZ9 d e i: f d YZ; e; e, e1 e. e0 f Z< d Z= d S( s+
Functionality for Command Line Interface.
iN(
t PublicErrort CommandErrort HelpErrort
InternalErrort NoSuchNamespaceErrort ValidationErrort NotFoundt NotConfiguredErrort PromptFailedt ConversionError( t CLI_TAB( t Passwordt Bytest Filet Strt StrEnum( t _( t API_VERSIONc C s | i d d S( sl
Takes a Python identifier and transforms it into form suitable for the
Command Line Interface.
R t -( t replace( t name( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt to_cli: s c C s t | i d d S( sh
Takes a string from the Command Line Interface and transforms it into a
Python identifier.
R R ( t strR ( t cli_name( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt from_cliC s t textuic B s e Z d Z d Z d$ d Z d Z d Z d Z d$ d Z d Z
d Z d$ d Z d$ d
Z
d d Z d d
Z d d e d Z d h d g e d Z d$ d$ d$ e d d d Z d$ d$ d$ e d d d Z e e d d d Z d Z d Z d Z d Z d Z d$ d Z d Z e d Z d Z d$ d$ e d Z! d$ d! Z" e d" Z# e d# Z$ RS(% s;
Backend plugin to nicely format output to stdout.
c C sw t i i oc yH t i t i t i t i d d d d d } t i d | d SWqs t
j
o d SXn d S( s
Return the width (in characters) of output tty.
If stdout is not a tty, this method will return ``None``.
t HHHHi i N( t syst stdoutt isattyt fcntlt ioctlt termiost
TIOCGWINSZt structt packt unpackt IOErrort None( t selft winsize( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
get_tty_widthP s c s t | t t f j o t d t t | f n t | d j o d S d j o t d | D St f d | D S( s
Return the max width (in characters) of a specified column.
For example:
>>> ui = textui()
>>> rows = [
... ('a', 'package'),
... ('an', 'egg'),
... ]
>>> ui.max_col_width(rows, col=0) # len('an')
2
>>> ui.max_col_width(rows, col=1) # len('package')
7
>>> ui.max_col_width(['a', 'cherry', 'py']) # len('cherry')
6
s rows: need %r or %r; got %ri c s s x | ] } t | Vq Wd S( N( t len( t .0t row( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pys y s c 3 s# x | ] } t | Vq Wd S( N( R* ( R+ R, ( t col( s. /usr/lib/python2.6/site-packages/ipalib/cli.pys z s N( t typet listt tuplet TypeErrorR* R& t max( R' t rowsR- ( ( R- s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
max_col_width` s
c C s% t | d d d j o d S| i S( Nt encodings UTF-8( t getattrR& R5 ( R' t stream( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt __get_encoding| s c sk t | t j o i t i } | i | St | t t f j o t f d | D S| S( s)
Decode text from stdin.
c 3 s" x | ] } i | Vq Wd S( N( t decode( R+ t v( R' ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pys s ( R. R t _textui__get_encodingR t stdinR9 R/ R0 ( R' t valueR5 ( ( R' s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR9 s c C s | i t i } | i | S( s3
Encode text for output to stdout.
( R; R R t encode( R' t unicode_textR5 ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR> s c C s+ | d j p
| d j o | | S| | S( Ni ( R& ( R' t nt singulart plural( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
choose_number s c C s) t | t j o t i | S| Sd S( s
Convert a binary value to base64. We know a value is binary
if it is a python str type, otherwise it is a plain string.
N( R. R t base64t b64encode( R' R= ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
encode_binary s c C s t | GHd S( s?
Print exactly like ``print`` statement would.
N( t unicode( R' t string( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_plain s c C sb | d j o | i } n | d j o) | t | j o | | d d } n t | GHd S( s
Force printing on a single line, using ellipsis if needed.
For example:
>>> ui = textui()
>>> ui.print_line('This line can fit!', width=18)
This line can fit!
>>> ui.print_line('This line wont quite fit!', width=18)
This line wont ...
The above example aside, you normally should not specify the
``width``. When you don't, it is automatically determined by calling
`textui.get_tty_width()`.
i s ...N( R& R) R* RG ( R' t textt width( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
print_line s
c C sI | d j o | i } n x% t i | i | D] } | GHq6 Wd S( s(
Print a paragraph, automatically word-wrapping to tty width.
For example:
>>> text = '''
... Python is a dynamic object-oriented programming language that can
... be used for many kinds of software development.
... '''
>>> ui = textui()
>>> ui.print_paragraph(text, width=45)
Python is a dynamic object-oriented
programming language that can be used for
many kinds of software development.
The above example aside, you normally should not specify the
``width``. When you don't, it is automatically determined by calling
`textui.get_tty_width()`.
The word-wrapping is done using the Python ``textwrap`` module. See:
http://docs.python.org/library/textwrap.html
N( R& R) t textwrapt wrapt strip( R' RJ RK t line( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_paragraph s
i c C s t | | GHd S( s{
Print at specified indentation level.
For example:
>>> ui = textui()
>>> ui.print_indented('One indentation level.')
One indentation level.
>>> ui.print_indented('Two indentation levels.', indent=2)
Two indentation levels.
>>> ui.print_indented('No indentation.', indent=0)
No indentation.
N( R
( R' RJ t indent( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_indented s c C s> x7 | D]/ \ } } | i d | | i | f | q Wd S( s
Print (key = value) pairs, one pair per line.
For example:
>>> items = [
... ('in_server', True),
... ('mode', u'production'),
... ]
>>> ui = textui()
>>> ui.print_keyval(items)
in_server = True
mode = u'production'
>>> ui.print_keyval(items, indent=0)
in_server = True
mode = u'production'
Also see `textui.print_indented`.
s %s = %rN( RS RF ( R' R3 RR t keyR= ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_keyval s s %s: %sc s t | t t f p' i | | i | f | n| o8 x| D]) } i | | i | f | qK Wnt f d | } t | d j oe t | d t t f j oH x@ | D]8 } d i | } i | | i | f | q Wd St | d j o d i | } n d S i } | ou | on d t
| d t | d f }
| t |
8} t i | | d t
} t | d j o
d
g } qn
| g } i | | | d f | x) | d D] } i d |
| f qWd S( s
Print an ldap attribute.
For example:
>>> attr = 'dn'
>>> ui = textui()
>>> ui.print_attribute(attr, u'dc=example,dc=com')
dn: dc=example,dc=com
>>> attr = 'objectClass'
>>> ui.print_attribute(attr, [u'top', u'someClass'], one_value_per_line=False)
objectClass: top, someClass
>>> ui.print_attribute(attr, [u'top', u'someClass'])
objectClass: top
objectClass: someClass
c s
i | S( ( RF ( R: ( R' ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt s i s : Ns , s %s%st i t break_long_wordsu i ( t
isinstanceR/ R0 RS RF t mapR* R. t joinR) R
RM RN t FalseRI ( R' t attrR= t formatRR t one_value_per_lineR: t lRJ t line_lent s_indentRP ( ( R' s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_attribute s< ' +0 ' t dnc sv f d } x0 | D]( j o | =q% q% Wx t D] | q^ Wd S( s+
Print an ldap entry dict.
c sY j o( i d d n! i d d d S( NRR R_ ( Rc ( t a( RR R] t attr_mapR' R_ t entry( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
print_attrE s
"N( t sorted( R' Rg RR Rf t
attr_orderR_ Rh ( ( RR R] Rf R' R_ Rg s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_entry1< s
c
C sP t } xC | D]; } | p d GHn t } | i | | | | | | | q
Wd S( Nt ( t TrueR\ t print_entry(
R' t entriest ordert labelst flagst print_allR^ RR t firstRg ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
print_entriesV s c
C s- t | t t f o t | } n | d j o t } t } n t } | d j ox|| D]p} | | j o q` n | i | | }
| i | g } | | } d | j o | d d g d g j o q` n t | t oa t i | d j o q` n | i
| |
d f | | i | | | | | | d | d n t | t t f oT t d | D o= | i
|
d | | | i | | | | | | | d n | i
|
| | | | | | =q` Wn | oJ xG t | D]5 } | i | | }
| i
| | | | | | qWn d S( s
t suppress_emptyu Rl i RR i c s s" x | ] } t | t Vq Wd S( N( RY t dict( R+ t val( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pys } s N( RY R/ R0 Rw R& Rm R\ t gett frontendt entry_countRS Rn t allRc Ru Ri (
R' Rg Rp Rq Rr Rs R^ RR R_ RT t labelt flagR= ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyRn _ sJ
&
i R c C sZ | t | } | o | i | | n | i | | | o | i | | n d S( s
Print a string with a dashed line above and/or below.
For example:
>>> ui = textui()
>>> ui.print_dashed('Dashed above and below.')
-----------------------
Dashed above and below.
-----------------------
>>> ui.print_dashed('Only dashed below.', above=False)
Only dashed below.
------------------
>>> ui.print_dashed('Only dashed above.', below=False)
------------------
Only dashed above.
N( R* RS ( R' RH t abovet belowRR t dasht dashes( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_dashed s c C s | i | d d d d d S( s
Print a primary header at indentation level 0.
For example:
>>> ui = textui()
>>> ui.print_h1('A primary header')
================
A primary header
================
RR i R t =N( R ( R' RJ ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_h1 s c C s | i | d d d d d S( s
Print a secondary header at indentation level 1.
For example:
>>> ui = textui()
>>> ui.print_h2('A secondary header')
------------------
A secondary header
------------------
RR i R R N( R ( R' RJ ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_h2 s c C s | i d t | d S( sb
Print a command name.
The typical use for this is to mark the start of output from a
command. For example, a hypothetical ``show_status`` command would
output something like this:
>>> ui = textui()
>>> ui.print_name('show_status')
------------
show-status:
------------
s %s:N( R R ( R' R ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
print_name s c C s | i | | d S( N( R ( R' t msgt output( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_header s c C s | i | d S( s
Print a summary at the end of a comand's output.
For example:
>>> ui = textui()
>>> ui.print_summary('Added user "jdoe"')
-----------------
Added user "jdoe"
-----------------
N( R ( R' R ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
print_summary s c C sC t | t j o t | } n | i | i | | | d S( s
Print a summary count.
The typical use for this is to print the number of items returned
by a command, especially when this return count can vary. This
preferably should be used as a summary and should be the final text
a command outputs.
For example:
>>> ui = textui()
>>> ui.print_count(1, '%d goose', '%d geese')
-------
1 goose
-------
>>> ui.print_count(['Don', 'Sue'], 'Found %d user', 'Found %d users')
-------------
Found 2 users
-------------
If ``count`` is not an integer, it must be a list or tuple, and then
``len(count)`` is used as the count.
N( R. t intR* R RC ( R' t countRA RB ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_count s c C s d t | GHd S( Ns
** %s **( RG ( R' RJ ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_error s c C sP y | i | | i | SWn) t t f j
o Ht d | n Xd S( s Prompt user for input
Handles encoding the prompt and decoding the input.
On end of stream or ctrl+c, raise PromptFailed.
R N( R9 R> t KeyboardInterruptt EOFErrorR ( R' t promptR} t prompt_func( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
prompt_helper s
c C s | i d | | f d S( Ns
>>> %s: %s( RI ( R' t attributet error( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt print_prompt_attribute_error s c C sZ | o d | } n d | } | d j o d | } n d | | f } | i | | S( s(
Prompt user for input.
u [%s]u %su %s: u %s [%s]: N( R& R ( R' R} t defaultt
get_valuest optionalR ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR s
c C s d
} | d
j o | o
d } q. d } n | o d | | f } n d | } xg t o_ | i | | i } | d j o t S| d j o t S| d
j o | d j o | SqV Wd
S(
s
Prompt user for yes/no input. This method returns True/False according
to user response.
Parameter "default" should be True, False or None
If Default parameter is not None, user can enter an empty input instead
of Yes/No answer. Value passed to Default is returned in that case.
If Default parameter is None, user is asked for Yes/No answer until
a correct answer is provided. Answer is then returned.
t Yest Nou %s Yes/No (default %s): u %s Yes/No: u yesu yu nu nou N( u yesu y( u nu no( R& Rm R t lowerR\ ( R' R} R t default_promptR t data( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt prompt_yesno& s"
c C s t i i o d t | } t t d t d | } x t ok | i | | d t i } | p | S| i | | d t i } | | j o | S| i t d qB Wn | i
t i i i Sd S( sx
Prompt user for a password or read it in via stdin depending
on whether there is a tty or not.
u %s: s! Enter %(label)s again to verify: R} R s Passwords do not match!N(
R R< R RG R Rw Rm R t getpassR R9 t readlineRO ( R' R} t confirmR t
repeat_promptt pw1t pw2( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt prompt_passwordJ s
c C s | i i p t i i o d St | } | d j o t d t d n d } x` | D]X } h } x$ | D] } | i | d | | RC RF RI RL RQ RS RU Rm Rc Rk Ru Rn R R R R R R R R t raw_inputR R R\ R R R R ( ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR K s@
8 / $ t helpc B sk e Z d Z e d f Z e Z d Z d Z d Z d Z
d Z d Z d Z
d Z RS(
s.
Display help for a command or topic.
s command?s ipalib.pluginsc C s# | t j o d S| i d d S( sp
Return last part of ``module`` name, or ``None`` if module is this file.
For example:
Nt .i( R t split( R' t module( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt _get_command_module s
c C se t i | p t | n t i | } t | d d } | d j o | i | d f } n | S( Nt topic( R t modulest
__import__R6 R& R ( R' t module_nameR R ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt _get_module_topic s
c C s8 t | i | d t | f } | | i | d s ( R t _builtinst Commandt NO_CLIR R R& t appendt _PLUGIN_BASE_MODULERG R R R R RO R R2 R* R t rsplitR t keyst _mtlt superR t _on_finalize( R' t cR R t mt docR R t _[1]( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR sD
)&,$!. 9Dc C s t | } d | i | f } | d j p
| d j o | i d S| | i j o | i | n2| | i j oq | i | } | i o t d | n t t
d t t
| i i GH| i
i i | i n | t i j o | i | n | d j os t d | i D } xf | i D]H } | i | } | i o q;n d t | i i | | i f GHq;Wn t d | d S( Ns %s.%st topicsR s Purpose: %st commandsc s s x | ] } t | Vq Wd S( N( R* ( R+ R ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pys s s %s %s( R R R& t print_topicsR t print_commandsR R R RG R R RO t Backendt clit build_parsert
print_helpR R R2 R R t ljustt summary( R' RT R R t cmdR t cname( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt run s0
*
,c C s t | i i } t t d GHd GHt t d GHxI | i D]> } t t d GHd t | i i | i | i
f GHqF Wd GHt t d GHx@ | D]8 } | i | } d t | i | i | d f GHq Wd GHt t d GHd S( Ns' Usage: ipa [global-options] COMMAND ...Rl s Built-in commands:s Help subtopics:s %s %ss Help topics:i s. Try `ipa --help` for a list of global options.( Ri R R RG R R R R R R R ( R' R R t tR ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR
s
+
)c C s3 | | i j o t | i | d t j oh x| i | d D]N } | i | d | d } | i | d } d t | i | | f GHq@ Wn| | i j o& | i | d } | i | d } n g } x | i D]} } t | i | d t j o q n | | i | d j o q n | i | d | d } | i | d | d } Pq Wd | i | f } t t t i | i
p d i } | | i j o& t
| d j o t d | n | GH| oO d GHt t d GHx6 | D]* } d t | i i | | i f GHqWn d GHd S(
Ni i i s %s %ss %s.%sRl R s Topic commands:s
( R R. Rw R R R RG R R R R RO R R* R R R ( R' R t subtopicR R R R R R ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR s> . &
)# ,( R R R R t
takes_argsR0 t
has_outputR R R R R R R R ( ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR s
6 t
show_mappingsc B s; e Z d Z e d d e d f Z e Z d Z RS( sA
Show mapping of LDAP attributes to command-line option.
t command_nameR} s Command namec C s t | } | | i j o t d | n | i | i } d
d g } t | d d } xc | D]X } | i o d | i j o qi n | i | i | i f t | t | i } qi Wx2 | D]* } t
| d i | d | d GHq Wd S( NR t Parameters LDAP attributes =========s ==============i t webuis : i ( R s LDAP attribute( s =========s ==============( R R R t optionsR* t excludeR R t
param_specR2 R R ( R' R t paramst outR t paramt item( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR K s
( R R R R R R R0 R R ( ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR @ s
t consolec B s e Z d Z e Z d Z RS( s) Start the IPA interactive Python console.c C s# t i d d t d | i d S( Ns' (Custom IPA interactive Python console)t localt api( t codet interactRw R ( R' ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR a s ( R R R R0 R R ( ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR \ s t show_apic B s2 e Z d Z d Z d Z d Z d d Z RS( s% Show attributes on dynamic API objects namespaces*c C sK | d j o t | i } n; x1 | D]) } | | i j o t d | q' q' W| } | i | } t d | D } | i i i d t } xl | D]d } | d d j o | o d GHn | o
t
} n d d | d | d i | | d f GHq Wt | d j o
d
} n d t | } | i i i
| d S( NR c s s# x | ] } t | d Vq Wd S( i N( R* ( R+ R` ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pys v s R i Rl s %s%s %rRW i i s 1 attribute shown.s %d attributes show.( R& R0 R R t _show_api__traverseR2 R R R Rm R\ R R* R ( R' t
namespacest namesR t linest mlRt RP R ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR m s2
c C s? g } x2 | D]* } | i | } | i d | | | q
W| S( Ns %s( R t _show_api__traverse_namespace( R' R R R t namespace( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt
__traverse s
i c C s | i | | | f x | D] } | | } | i | d | | f t | d p q n x\ | D]T } | | } t | t i o1 t | d j o | i | | | | d qe qe Wq Wd S( Ni t __iter__i i ( R t hasattrRY t plugablet NameSpaceR* R ( R' R R R t tabt member_namet memberR@ R] ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt __traverse_namespace s
&( s namespaces*( R R R R R R R ( ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyR h s
t Collectorc B s# e Z d Z d Z d Z RS( c C s t i | d h d S( Nt _Collector__options( t objectt __setattr__( R' ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt __init__ s c C su | | i j oA | i | } t | t j o | | f } qQ | | f } n | | i | R t reRM R R R R t socketR R R" RD t default_encoding_utf8t ImportErrorRz t backendR t utilt errorsR R R R R R R R R R t constantsR
t
parametersR R R
R R RJ R t ipapython.versionR R R R R R1 R R R R R t cli_application_commandsR R t IndentedHelpFormatterR R R t ExecutionerR Rr R ( ( ( s. /usr/lib/python2.6/site-packages/ipalib/cli.pyt s\ F( M 6 $