a
}|g4X @ s0 d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm
Z
dd
lm Z dd l m
Z
dd lmZ dd
lmZ ddlmZ ddlmZ eeZdZdZdZG dd dZe Z e
dZ G dd dZ G dd dZ e e e f ddd 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) constants) completer)util)osokcancelzO- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -c @ s e Zd ZddddZdS )_DisplayServiceNreturnc C s
d | _ d S Ndisplay)self r A/usr/lib/python3.9/site-packages/certbot/_internal/display/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 || _|| _d| _d S )NF)superr r r! skipped_interaction)r r r! __class__r r r 6 s
zFileDisplay.__init__TF)messagepausewrapr! decorater c C s~ |rt |}td| | j|r(dndd |r6dnd jtjt |d | j
|rz| |rpt d n
td 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
Notifying user: %s{line}{frame}{line} {msg}{line}
{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 notification< s"
zFileDisplay.notification)
r& choicesok_label cancel_label
help_labeldefaultcli_flagr!
unused_kwargsr c
K sJ | ||||}
|
dur t|
fS | || | t|\} } | | 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& r> r? r@ rA rB rC r! rD return_defaultcode selectionr r r menu] s zFileDisplay.menu)r& rB rC r! rD r c K sT | ||||}|dur t|fS td| d }t|}|dv rLtdfS 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)rF rG r
r3 r< CANCEL)r r& rB rC r! rD rK ansr r r input s
zFileDisplay.inputYesNo)r& yes_labelno_labelrB rC r! rD r c
K s | ||||}|dur |S t|}| jdjtjttj |d | j t
djt |t |d} | |d
s| |d rdS | |d
s| |d rPdS qPdS ) 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})r1 r2 z {yes}/{no}: )Zyesnor TF)rF r
r3 r r6 r7 r r8 r9 r: r< Zparens_around_char
startswithlowerupper)
r r& rW rX rB rC r! rD rK rS r r r yesno s(
zFileDisplay.yesno)r& tagsrB rC r! rD r c K s | ||||}|dur t|fS | || | jddd\}} |tkr| spddd tdt|d D } t | }
|
|
|} | r|| fS | j d t
j | j q |g fS q 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! rO c s s | ]}t |V qd S r )str).0xr r r z(FileDisplay.checklist..rE z!** Error - Invalid selection **%s)rF rG rH rT stripjoinrangerJ r
Zseparate_list_input_scrub_checklist_inputr r6 r r8 r: ) r r& r^ rB rC r! rD rK rL rS indicesZ
selected_tagsr r r checklist s&
"
zFileDisplay.checklist)promptrB rC r! r c C sN | |rdS |du rG rc z6FileDisplay._scrub_checklist_input..rE c s g | ]} |d qS )rE r rq r^ r r rs T rc )
ValueErrorlistdictfromkeyskeysrJ )r rh r^ Z indices_intrr r rt r rg : s
z"FileDisplay._scrub_checklist_input)r& r> r c C s |r t |d tr dd |D }| jtj | tj | jttj t|dD ]6\}}| d| }| jt | | jtj qX| jttj | j
dS )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 qS )r z - rE r )r` rP r r r rs b rc z+FileDisplay._print_menu..rE z: N)
isinstancetupler r6 r r8 r9 enumerater
r3 r: )r r& r> iZdescr2 r r r rH V s zFileDisplay._print_menu)max_r c C s d}|dkrdj |d}nd}|dk rt|}|dsD|drLtdfS z$t|}|dk sf||krnd}tW q ty | jd t j
| j Y q 0 q 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
rE zMSelect the appropriate number [1-{max_}] then [enter] (press 'c' to cancel): )r~ z@Press 1 [enter] to confirm the selection (press 'c' to cancel): rP rQ z{0}** Invalid input **{0})
r7 r
r< rZ rR rp ru r r6 r r8 r: rG )r r~ rM Z input_msgrS r r r rI s s*
z FileDisplay._get_valid_int_ans)TTFT)NNNNNF)NNF)rU rV NNF)NNF)NNF) r r r __doc__r boolr r_ r= r r r r rp r rN rT r] ri r rF r; ro r rg rH rI
__classcell__r r r$ r r 2 sf " $ , +
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_argsrD r c s t || _d S r )r" r r )r r r rD r$ r r r s
z NoninteractiveDisplay.__init__r, )r& rC extrar c C s8 d}||7 }|r |d| 7 }|r.|d |7 }t|S )zNReturn error to raise in case of an attempt to interact in noninteractive modez r? r@ rA rB rC rD r c K s& |du r | ||dt| t|fS )a_ Avoid displaying a menu.
: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 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 reprrG ) r r& r> r? r@ rA rB rC rD r r r rN s zNoninteractiveDisplay.menu)r& rB rC rD r c K s |du r| ||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 rG r r& rB rC rD r r r rT s
zNoninteractiveDisplay.input)r& rW rX rB rC rD r c K s |du r| |||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& rW rX rB rC rD r r r r] s
zNoninteractiveDisplay.yesno)r& r^ rB rC rD r c K s( |du r | ||d|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 re rG )r r& r^ rB rC rD r r r ri s z NoninteractiveDisplay.checklistc K s | |||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
)rT r r r r ro s z&NoninteractiveDisplay.directory_select)r, )FTT)NNNNN)NN)NNNN)NN)NN)r r r r r r r r_ r r
r r r r= r r r rp rN rT r] r ri ro r r r r$ r r sL
r 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 ru r r r r get_display$ s r )r r c C s
| t _dS )zqSet the display service.
:param Union[FileDisplay, NoninteractiveDisplay] display: the display service
N)r r r r r r set_display2 s r )"r Zloggingrl typingr r r r r r r r Zcertbotr
Zcertbot._internalr Zcertbot._internal.displayr r
Zcertbot.compatr Z getLoggerr r4 rG rR r9 r r r r r r r r r r r s:
h