Server : Apache/2.4.62 (Unix) OpenSSL/1.0.2k-fips System : Linux server1.richineiserver.com 3.10.0-1160.119.1.el7.x86_64 #1 SMP Tue Jun 4 14:43:51 UTC 2024 x86_64 User : fdshops ( 1003) PHP Version : 8.2.21 Disable Function : NONE Directory : /lib/python2.7/site-packages/certbot/display/ |
�
���_c @ s� d Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z d d l m
Z
d d l m Z d d l m
Z
d d l m Z d d l m Z d d l m Z e j e � Z d
Z d Z d Z d
Z d Z d d d Z d � Z e d d � Z d � Z e j j! e j" � d e# f d � � Y� Z$ d � Z% e j j! e j" � d e# f d � � Y� Z& d � Z' d � Z( d � Z) d S( s$ Certbot display.
This module (`certbot.display.util`) or its companion `certbot.display.ops`
should be used whenever:
- Displaying status information to the user on the terminal
- Collecting information from the user via prompts
Other messages can use the `logging` module. See `log.py`.
i����N( t List( t errors( t
interfaces( t constants( t completer( t misc( t osiH t okt cancelt helpt escs - i' t -c C sU | j � } g } x3 | D]+ } | j t j | d d t d t �� q Wd j | � S( s� Format lines nicely to 80 chars.
:param str msg: Original message
:returns: Formatted message respecting newlines in message
:rtype: str
iP t break_long_wordst break_on_hyphenss
( t
splitlinest appendt textwrapt fillt Falset join( t msgt linest fixed_lt line( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt _wrap_lines1 s
g ��@c C sT | r& t j j | � t j j � n t j | | � } | sG t � n | j d � S( s Get user input with a timeout.
Behaves the same as six.moves.input, however, an error is raised if
a user doesn't answer after timeout seconds. The default timeout
value was chosen to place it just under 12 hours for users following
our advice and running Certbot twice a day.
:param str prompt: prompt to provide for input
:param float timeout: maximum number of seconds to wait for input
:returns: user response
:rtype: str
:raises errors.Error if no answer is given before the timeout
s
( t syst stdoutt writet flushR t readline_with_timeoutt EOFErrort rstrip( t promptt timeoutR ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt input_with_timeoutG s c C s2 t j j t j � j | d t d t d t �d S( sM Display a basic status message.
:param str msg: message to display
t pauset decoratet wrapN( t zopet componentt
getUtilityR t IDisplayt notificationR ( R ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt notifye s t FileDisplayc B s� e Z d Z d � Z e e e e d � Z d d d d d e d � Z d d e d � Z d d d d e d � Z
d d e d � Z d � Z d
� Z
d d e d � Z d � Z d
� Z d � Z RS( s File-based display.c C s2 t t | � j � | | _ | | _ t | _ d S( N( t superR, t __init__t outfilet force_interactiveR t skipped_interaction( t selfR/ R0 ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR. v s c C s� | r t | � } n t j d | � | j j | r: d n d d | rM d n d j d t j d t d | � � | j j � | r� | j
| � r� t d � q� t j d
� n d S( s 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
s Notifying user: %ss {line}{frame}{line}t s {msg}{line}s
{frame}{line}R t frameR s Press Enter to Continues! Not pausing for user confirmationN( R t loggert debugR/ R t formatR t linesept
SIDE_FRAMER t
_can_interactR" ( R2 t messageR# R% R0 R$ ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR* | s
c K s[ | j | | | | � r" t | f S| j | | � | j t | � � \ }
} |
| d f S( sC 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
i ( t _return_defaultt OKt _print_menut _get_valid_int_anst len( R2 R; t choicest ok_labelt cancel_labelt
help_labelt defaultt cli_flagR0 t
unused_kwargst codet selection( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt menu� s
c K sb | j | | | | � r" t | f St d | � d } t | � } | d k rX t d f St | f S( s 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
s %s (Enter 'c' to cancel):t t ct Cs -1( RL RM ( R< R= R R" t CANCEL( R2 R; RE RF R0 RG t ans( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt input� s
t Yest Noc K s | j | | | | � r | St | � } | j j d j t j d t t j d | �� | j j � x� t rt
d j d t | � d t | � � � } | j | d j
� � s� | j | d j � � r� t S| j | d j
� � s� | j | d j � � rg t Sqg Wd S( s� 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
s {0}{frame}{msg}{0}{frame}R4 R s {yes}/{no}: t yest noi N( R< R R/ R R7 R R8 R9 R t TrueR" t _parens_around_chart
startswitht lowert upperR ( R2 R; t yes_labelt no_labelRE RF R0 RG RO ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt yesno� s
c K s | j | | | | � r" t | f Sx� t r� | j | | � | j d d t �\ } } | t k r� | j � s� d j d � t d t | � d � D� � } n t | � } | j
| | � }
|
r� | |
f S| j j d t
j � | j j � q% | g f Sq% Wd S( sC 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
sr Select the appropriate numbers separated by commas and/or spaces, or leave input blank to select all options shownR0 RK c s s | ] } t | � Vq d S( N( t str( t .0t x( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pys <genexpr>" s i s! ** Error - Invalid selection **%sN( R< R= RU R> RP t stripR t rangeR@ t separate_list_inputt _scrub_checklist_inputR/ R R R8 R ( R2 R; t tagsRE RF R0 RG RH RO t indicest
selected_tags( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt checklist s"
/
c C ss | j | � r t S| d k r\ d j | � } | rJ | d j | � 7} n t j | � � n t j d | | � t S( s� Should we return the default instead of prompting the user?
:param str prompt: prompt for the user
:param default: default answer to prompt
:param str cli_flag: command line option for setting an answer
to this question
:param bool force_interactive: if interactivity is forced by the
IDisplay call
:returns: True if we should return the default without prompting
:rtype: bool
s- Unable to get an answer for the question:
{0}sA
You can provide an answer on the command line with the {0} flag.s- Falling back to default %s for the prompt:
%sN( R: R t NoneR7 R t ErrorR5 R6 RU ( R2 R RE RF R0 R ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR< - s
c C s] | j s- | s- t j j � r1 | j j � r1 t S| j sY t j d t j
� t | _ n t S( s� Can we safely interact with the user?
:param bool force_interactive: if interactivity is forced by the
IDisplay call
:returns: True if the display can interact with the user
:rtype: bool
s� Skipped user interaction because Certbot doesn't appear to be running in a terminal. You should probably include --non-interactive or %s on the command line.( R0 R t stdint isattyR/ RU R1 R5 t warningR t FORCE_INTERACTIVE_FLAGR ( R2 R0 ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR: J s
c K s- t j � � | j | | | | � SWd QXd S( s
Display a directory selection screen.
: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
:param bool force_interactive: True if it's safe to prompt the user
because it won't cause any workflow regressions
:returns: tuple of the form (`code`, `string`) where
`code` - display exit code
`string` - input entered by the user
N( R t CompleterRP ( R2 R; RE RF R0 RG ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt directory_select` s
c C s� y# g | D] } t | � ^ q
} Wn t k
r7 g SXt t | � � } x0 | D]( } | d k su | t | � k rQ g SqQ Wg | D] } | | d ^ q� S( s� Validate input and transform indices to appropriate tags.
:param list indices: input
:param list tags: Original tags of the checklist
:returns: valid tags the user selected
:rtype: :class:`list` of :class:`str`
i ( t intt
ValueErrort listt setR@ ( R2 Re Rd t index( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyRc r s #
c C s | rG t | d t � rG g | D] } d | d | d f ^ q } n | j j d j d t j d | � � | j j t t j � x^ t | d � D]M \ } } d j d | d | � } | j j t | � � | j j t j � q� W| j j t t j � | j j
� d
S( s� Print 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)
i s %s - %si s {new}{msg}{new}t newR s
{num}: {desc}t numt descN( t
isinstancet tupleR/ R R7 R R8 R9 t enumerateR R ( R2 R; RA RL t iRw R ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR> � s
. c C s� d } | d k r' d j d | � } n d } x� | d k r� t | � } | j d � sf | j d � rp t d f Sy7 t | � } | d k s� | | k r� d } t � n Wq0 t k
r� | j j d j t j � � | j j
� q0 Xq0 Wt | f S( s5 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
i����i sM Select the appropriate number [1-{max_}] then [enter] (press 'c' to cancel): t max_s@ Press 1 [enter] to confirm the selection (press 'c' to cancel): RL RM s {0}** Invalid input **{0}( R7 R" RW RN Rp Rq R/ R R R8 R R= ( R2 R| RI t input_msgRO ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR? � s&
N( t __name__t
__module__t __doc__R. RU R R* Rh RJ RP R\ Rg R< R: Ro Rc R> R? ( ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR, q s* )( c C s/ d j | � } | r+ | d j | � 7} n d S( sN Verify that provided arguments is a valid IDisplay call.
:param str prompt: prompt for the user
:param default: default answer to prompt
:param str cli_flag: command line option for setting an answer
to this question
:param bool force_interactive: if interactivity is forced by the
IDisplay call
s* Invalid IDisplay call for this prompt:
{0}s7
You can set an answer to this prompt with the {0} flagN( R7 ( R RE RF R0 R ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt assert_valid_call� s
t NoninteractiveDisplayc B s� e Z d Z d � Z d d � Z e e e d � Z d
d
d
d
d
d � Z d
d
d � Z
d
d
d
d
d � Z d
d
d � Z d
d
d � Z
RS( sE An iDisplay implementation that never asks for interactive user inputc O s t t | � j � | | _ d S( N( R- R� R. R/ ( R2 R/ t unused_argsRG ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR. � s R3 c C sV d } | | 7} | r' | d | 7} n | rC | d j | � 7} n t j | � � d S( sB Error out in case of an attempt to interact in noninteractive modes< Missing command line flag or config entry for this setting:
s
s&
(You can set this with the {0} flag)N( R7 R t MissingCommandlineFlag( R2 R; RF t extraR ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt _interaction_fail� s
c K s� | r t | � } n t j d | � | j j | r: d n d d | rM d n d j d t j d t d | � � | j j � d S(
se Displays a notification without waiting for user acceptance.
:param str message: Message to display to stdout
:param bool pause: The NoninteractiveDisplay waits for no keyboard
:param bool wrap: Whether or not the application should wrap text
:param bool decorate: Whether to apply a decorated frame to the message
s Notifying user: %ss {line}{frame}{line}R3 s {msg}{line}s
{frame}{line}R R4 R N(
R R5 R6 R/ R R7 R R8 R9 R ( R2 R; R# R% R$ RG ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR* � s c K s6 | d k r, | j | | d t | � � n t | f S( s_ 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
s Choices: N( Rh R� t reprR= ( R2 R; RA RB RC RD RE RF RG ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyRJ s c K s) | d k r | j | | � n t | f S( sK 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( Rh R� R= ( R2 R; RE RF RG ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyRP s c K s# | d k r | j | | � n | S( s+ 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( Rh R� ( R2 R; RZ R[ RE RF RG ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR\ 0 s c K s5 | d k r+ | j | | d j | � � n t | f S( sj 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
s ? N( Rh R� R R= ( R2 R; Rd RE RF RG ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyRg @ s c K s | j | | | � S( s� 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
( RP ( R2 R; RE RF RG ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyRo R s N( R~ R R� R. R� R RU R* Rh RJ RP R\ Rg Ro ( ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyR� � s
c C s5 | j d d � } g | j � D] } t | � ^ q S( s� Separate a comma or space separated list.
:param str input_: input from the user
:returns: strings
:rtype: list
t ,RK ( t replacet splitR] ( t input_t no_commast string( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyRb g s c C s d j d | d d | d � S( sn Place parens around first character of label.
:param str label: Must contain at least one character
s ({first}){rest}t firsti t resti ( R7 ( t label( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyRV v s c C s_ | s
d St | � } | d k r* | d S| d k rC d j | � Sd j | d | d � Sd S( sM Summarizes a list of domains in the format of:
example.com.com and N more domains
or if there is are only two domains:
example.com and www.example.com
or if there is only one domain:
example.com
:param list domains: `str` list of domains
:returns: the domain list summary
:rtype: str
R3 i i i s and s {0} and {1} more domainsN( R@ R R7 ( t domainst l( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt summarize_domain_list s
(* R� t loggingR R t zope.interfaceR& t zope.componentt acme.magic_typingR t certbotR R t certbot._internalR t certbot._internal.displayR t certbot.compatR R t getLoggerR~ R5 t WIDTHR= RN t HELPt ESCR9 R Rh R" R+ t interfacet implementerR) t objectR, R� R� Rb RV R� ( ( ( s8 /usr/lib/python2.7/site-packages/certbot/display/util.pyt <module> s> � ] �