3
گa~Z @ sp d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm
Z
dd
lm Z ddl Z
ddlZ
dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ ddlmZ ejeZdZ dZ dd d Z G dd dZ e Z e
dZ!e
j"j#ej$G dd dZ%e
j"j#ej$G dd d Z&e e%e&f d d d Z'e e%e&f dd d!d"Z(dS )#zFThis modules define the actual display implementations used in Certbot N)Any)Iterable)List)Optional)TextIO)Tuple)TypeVar)Union)errors)
interfaces) constants) completer)util)osokZcancelz- ' -c @ s e Zd ZddddZdS )_DisplayServiceN)returnc C s
d | _ d S )N)display)self r /usr/lib/python3.6/obj.py__init__, s z_DisplayService.__init__)__name__
__module__ __qualname__r r r r r r + s r Tc
s e Zd ZdZeedd fdd Zd*eeeeeddd d
Zd+ee e
e eef e
e f e e e e e e e e
e e eee ee
f d
d d
Zd,ee e e e eee eef dddZd-eeee e e e eeedddZd.ee
e e e
e e e eee ee
e f dddZee e e e ee e dddZeed d d Zd/ee e e e eee eef dd d Zee ee
f e
e e
e d!d"d#Zee e
e eef e
e f dd$d%d&Ze
e ee
f d'd(d)Z ZS )0 FileDisplayzFile-based display.N)outfileforce_interactiver c s t j || _|| _d| _d S )NF)superr r r skipped_interaction)r r r ) __class__r r r < s
zFileDisplay.__init__TF)messagepausewrapr decorater c C s~ |rt j|}tjd| | jj|r(dndd |r6dnd jtjt |d | jj
|rz| j |rpt j d n
tjd d S )
a Displays a notification and waits for user acceptance.
:param str message: Message to display
:param bool pause: Whether or not the program should pause for the
user's confirmation
:param bool wrap: Whether or not the application should wrap text
:param bool force_interactive: True if it's safe to prompt the user
because it won't cause any workflow regressions
:param bool decorate: Whether to surround the message with a
decorated frame
zNotifying user: %sz{line}{frame}{line} z {msg}{line}z
{frame}{line})lineframemsgzPress Enter to Continuez!Not pausing for user confirmationN)
r
wrap_linesloggerdebugr writeformatr linesep
SIDE_FRAMEflush
_can_interactinput_with_timeout)r r$ r% r& r r' r r r notificationB s
zFileDisplay.notification)
r$ choicesok_label cancel_label
help_labeldefaultcli_flagr
unused_kwargsr c
K sJ | j ||||}
|
dk r t|
fS | j|| | jt|\} } | | d fS )aC Display a menu.
.. todo:: This doesn't enable the help label/button (I wasn't sold on
any interface I came up with for this). It would be a nice feature
:param str message: title of menu
:param choices: Menu lines, len must be > 0
:type choices: list of tuples (tag, item) or
list of descriptions (tags will be enumerated)
:param default: default value to return (if one exists)
:param str cli_flag: option used to set this value with the CLI
:param bool force_interactive: True if it's safe to prompt the user
because it won't cause any workflow regressions
:returns: tuple of (`code`, `index`) where
`code` - str display exit code
`index` - int index of the user's selection
:rtype: tuple
N )_return_defaultOK _print_menu_get_valid_int_anslen)
r r$ r7 r8 r9 r: r; r< r r= return_defaultcode selectionr r r menuc s zFileDisplay.menu)r$ r; r< r r= r c K sT | j ||||}|dk r t|fS tjd| d }tj|}|dkrLtdfS t|fS )a Accept input from the user.
:param str message: message to display to the user
:param default: default value to return (if one exists)
:param str cli_flag: option used to set this value with the CLI
:param bool force_interactive: True if it's safe to prompt the user
because it won't cause any workflow regressions
:returns: tuple of (`code`, `input`) where
`code` - str display exit code
`input` - str of the user's input
:rtype: tuple
Nz%s (Enter 'c' to cancel): cCz-1)rI rJ )r? r@ r r, r5 CANCEL)r r$ r; r< r r= rD ansr r r input s
zFileDisplay.inputYesNo)r$ yes_labelno_labelr; r< r r= r c
K s | j ||||}|dk r |S tj|}| jjdjtjttj |d | jj xttj
djtj |tj |d} | j |d j
s| j |d j rdS | j |d j
s| j |d j rRdS qRW dS ) a Query the user with a yes/no question.
Yes and No label must begin with different letters, and must contain at
least one letter each.
:param str message: question for the user
:param str yes_label: Label of the "Yes" parameter
:param str no_label: Label of the "No" parameter
:param default: default value to return (if one exists)
:param str cli_flag: option used to set this value with the CLI
:param bool force_interactive: True if it's safe to prompt the user
because it won't cause any workflow regressions
:returns: True for "Yes", False for "No"
:rtype: bool
Nz{0}{frame}{msg}{0}{frame})r* r+ z {yes}/{no}: )yesnor TF)r? r r, r r/ r0 r r1 r2 r3 r5 Zparens_around_char
startswithlowerupper)
r r$ rP rQ r; r< r r= rD rL r r r yesno s"
zFileDisplay.yesno)r$ tagsr; r< r r= r c K s | j ||||}|dk r t|fS x| j|| | jddd\}} |tkr| j srdjdd tdt|d D } tj | }
| j
|
|} | r|| fS | j j d t
j | j j q"|g fS q"W dS )
aC Display a checklist.
:param str message: Message to display to user
:param list tags: `str` tags to select, len(tags) > 0
:param default: default value to return (if one exists)
:param str cli_flag: option used to set this value with the CLI
:param bool force_interactive: True if it's safe to prompt the user
because it won't cause any workflow regressions
:returns: tuple of (`code`, `tags`) where
`code` - str display exit code
`tags` - list of selected tags
:rtype: tuple
NzrSelect the appropriate numbers separated by commas and/or spaces, or leave input blank to select all options shownT)r rH c s s | ]}t |V qd S )N)str).0xr r r s z(FileDisplay.checklist..r> z!** Error - Invalid selection **%s)r? r@ rA rM stripjoinrangerC r Zseparate_list_input_scrub_checklist_inputr r/ r r1 r3 ) r r$ rX r; r< r r= rD rE rL indicesZ
selected_tagsr r r checklist s$ "
zFileDisplay.checklist)promptr; r< r r c C sN | j |rdS |dkrM s z6FileDisplay._scrub_checklist_input..r> c s g | ]} |d qS )r> r )rZ rj )rX r r rk Y s )
ValueErrorlistsetrC )r ra rX Z indices_intrj r )rX r r` @ s
z"FileDisplay._scrub_checklist_input)r$ r7 r c C s |r t |d tr dd |D }| jjdjtj|d | jjttj xDt|dD ]6\}}dj||d}| jjt j
| | jjtj qVW | jjttj | jj d S )
zPrint a menu on the screen.
:param str message: title of menu
:param choices: Menu lines
:type choices: list of tuples (tag, item) or
list of descriptions (tags will be enumerated)
r c S s g | ]}d |d |d f qS )z%s - %sr r> r )rZ rI r r r rk g s z+FileDisplay._print_menu..z{new}{msg}{new})newr+ r> z
{num}: {desc})ZnumdescN)
isinstancetupler r/ r0 r r1 r2 enumerater r, r3 )r r$ r7 irp r+ r r r rA [ s zFileDisplay._print_menu)max_r c C s d}|dkrdj |d}nd}x|dk rtj|}|jdsF|jdrNtd fS y$t|}|dk sh||krpd
}tW q tk
r | jjdj t j
| jj Y q X q W t |fS ) a5 Get a numerical selection.
:param int max: The maximum entry (len of choices), must be positive
:returns: tuple of the form (`code`, `selection`) where
`code` - str display exit code ('ok' or cancel')
`selection` - int user's selection
:rtype: tuple
r> zMSelect the appropriate number [1-{max_}] then [enter] (press 'c' to cancel): )ru z@Press 1 [enter] to confirm the selection (press 'c' to cancel): rI rJ z{0}** Invalid input **{0}rv rv )
r0 r r5 rT rK ri rl r r/ r r1 r3 r@ )r ru rF Z input_msgrL r r r rB y s&
z FileDisplay._get_valid_int_ans)TTFT)NNNNNF)NNF)rN rO NNF)NNF)NNF) r r r __doc__r boolr rY r6 r r r r ri r rG rM rW rb r r? r4 rh r r` rA rB
__classcell__r r )r# r r 7 s6 ! > * &* ) ( r c sh e Zd ZdZeeedd fdd Zd eee ee j
ddd Z d ee e e edd d
dZ
d eeeeeef ee f ee ee ee ee ee eeeef d ddZd eee ee eeeef dddZd!eee ee ee ee ee dddZd"eee eee ee eeeee f dddZd#eee ee eeeef ddd Z ZS )$NoninteractiveDisplayzKA display utility implementation that never asks for interactive user inputN)r unused_argsr= r c s t j || _d S )N)r! r r )r r r{ r= )r# r r r s
z NoninteractiveDisplay.__init__r( )r$ r< extrar c C s8 d}||7 }|r |d| 7 }|r.|dj |7 }tj|S )zNReturn error to raise in case of an attempt to interact in noninteractive modez 0
:type choices: list of tuples (tag, item) or
list of descriptions (tags will be enumerated)
:param int default: the default choice
:param dict kwargs: absorbs various irrelevant labelling arguments
:returns: tuple of (`code`, `index`) where
`code` - str display exit code
`index` - int index of the user's selection
:rtype: tuple
:raises errors.MissingCommandlineFlag: if there was no default
Nz Choices: )r reprr@ ) r r$ r7 r8 r9 r: r; r< r= r r r rG s zNoninteractiveDisplay.menu)r$ r; r< r= r c K s |dkr| j ||t|fS )aK Accept input from the user.
:param str message: message to display to the user
:returns: tuple of (`code`, `input`) where
`code` - str display exit code
`input` - str of the user's input
:rtype: tuple
:raises errors.MissingCommandlineFlag: if there was no default
N)r r@ )r r$ r; r< r= r r r rM s
zNoninteractiveDisplay.input)r$ rP rQ r; r< r= r c K s |dkr| j |||S )a+ Decide Yes or No, without asking anybody
:param str message: question for the user
:param dict kwargs: absorbs yes_label, no_label
:raises errors.MissingCommandlineFlag: if there was no default
:returns: True for "Yes", False for "No"
:rtype: bool
N)r )r r$ rP rQ r; r< r= r r r rW s
zNoninteractiveDisplay.yesno)r$ rX r; r< r= r c K s( |dkr | j ||dj|d t|fS )aj Display a checklist.
:param str message: Message to display to user
:param list tags: `str` tags to select, len(tags) > 0
:param dict kwargs: absorbs default_status arg
:returns: tuple of (`code`, `tags`) where
`code` - str display exit code
`tags` - list of selected tags
:rtype: tuple
Nz? ?)r r^ r@ )r r$ rX r; r< r= r r r rb s z NoninteractiveDisplay.checklistc K s | j |||S )a Simulate prompting the user for a directory.
This function returns default if it is not ``None``, otherwise,
an exception is raised explaining the problem. If cli_flag is
not ``None``, the error message will include the flag that can
be used to set this value with the CLI.
:param str message: prompt to give the user
:param default: default value to return (if one exists)
:param str cli_flag: option used to set this value with the CLI
:returns: tuple of the form (`code`, `string`) where
`code` - int display exit code
`string` - input entered by the user
)rM )r r$ r; r< r= r r r rh s z&NoninteractiveDisplay.directory_select)r( )FTT)NNNNN)NN)NNNN)NN)NN)r r r rw r r r rY r r
r~ r rx r6 r r r ri rG rM rW r rb rh ry r r )r# r rz s"
T 6 rz )r c C s t jstdt jS )zGet the display utility.
:return: the display utility
:rtype: Union[FileDisplay, NoninteractiveDisplay]
:raise: ValueError if the display utility is not configured yet.
zlThis function was called too early in Certbot's execution as the display utility hasn't been configured yet.)_SERVICEr rl r r r r get_display- s r )r r c C s t jj| tj | t_dS )zqSet the display service.
:param Union[FileDisplay, NoninteractiveDisplay] display: the display service
N)zopeZ componentZprovideUtilityr IDisplayr r )r r r r set_display; s r ))rw Zloggingre Ztypingr r r r r r r r Zzope.componentr Zzope.interfaceZcertbotr
r Zcertbot._internalr Zcertbot._internal.displayr
r Zcertbot.compatr Z getLoggerr r- r@ rK r2 r r r Z interfaceZ implementerr r rz r r r r r r s@
k