a `f[@sdZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z ddl m Z ddlmZddlmZdd lmZeeZd Zd Zd Zd ZdZdZddZd#ddZddZej e j!Gddde"Z#ddZ$ej e j!Gddde"Z%ddZ&dd Z'd!d"Z(dS)$a$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`. N)List)errors) interfaces) constants) completer)misc)osHokZcancelhelpZesczO- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -c Cs8|}g}|D]}|tj|ddddqd|S)zFormat lines nicely to 80 chars. :param str msg: Original message :returns: Formatted message respecting newlines in message :rtype: str PF)Zbreak_long_wordsZbreak_on_hyphens ) splitlinesappendtextwrapZfilljoin)msglinesZfixed_lliner6/usr/lib/python3/dist-packages/certbot/display/util.py _wrap_lines1s  r@cCs8|rtj|tjt||}|s.t|dS)aGet 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 r )sysstdoutwriteflushrZreadline_with_timeoutEOFErrorrstrip)promptZtimeoutrrrrinput_with_timeoutGs   r cCs tjtjj|dddddS)zMDisplay a basic status message. :param str msg: message to display F)pausedecoratewrapN)zopeZ componentZ getUtilityrIDisplay notification)rrrrnotifyesr'cseZdZdZfddZdddZd d d Zd!d d Zd"ddZd#ddZ ddZ ddZ d$ddZ ddZ ddZddZZS)% FileDisplayzFile-based display.cs$tt|||_||_d|_dS)NF)superr(__init__outfileforce_interactiveskipped_interaction)selfr+r, __class__rrr*vszFileDisplay.__init__TFcCsz|r t|}td||j|r&dndd|r4dndjtjt|d|j |rv| |rlt dn tdd S) aDisplays 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}rframerzPress Enter to Continuez!Not pausing for user confirmationN) rloggerdebugr+rformatrlinesep SIDE_FRAMEr _can_interactr )r.messager!r#r,r"rrrr&|s"      zFileDisplay.notificationNc KsB|||||rt|fS||||t|\} } | | dfS)aCDisplay 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 )_return_defaultOK _print_menu_get_valid_int_anslen) r.r>choicesok_label cancel_label help_labeldefaultcli_flagr, unused_kwargscode selectionrrrmenus  zFileDisplay.menucKsH|||||rt|fStd|d}t|}|dvr@tdfSt|fS)aAccept 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 z%s (Enter 'c' to cancel): )cCz-1)r@rArr CANCEL)r.r>rIrJr,rKansrrrinputszFileDisplay.inputYesNoc Ks|||||r|St|}|jdjtjttj|d|jt djt |t |d}| |d s| |d rdS| |d s| |d rFdSqFdS) aQuery 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 z{0}{frame}{msg}{0}{frame})r7rz {yes}/{no}: )ZyesZnorTFN)r@rr+rr:rr;r<rr _parens_around_char startswithlowerupper) r.r> yes_labelno_labelrIrJr,rKrSrrryesnos&  zFileDisplay.yesnoc Ks|||||rt|fS||||jddd\}}|tkr|shdddtdt|dD}t|} | | |} | r|| fS|j dt j |j q|gfSqd S) aCDisplay 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 zrSelect the appropriate numbers separated by commas and/or spaces, or leave input blank to select all options shownT)r,rOcss|]}t|VqdSNstr).0xrrr "z(FileDisplay.checklist..r?z!** Error - Invalid selection **%sN)r@rArBrTstriprrangerDseparate_list_input_scrub_checklist_inputr+rrr;r) r.r>tagsrIrJr,rKrLrSindicesZ selected_tagsrrr checklists$  "  zFileDisplay.checklistcCsN||rdS|durrIrJr,rKrrrdirectory_select`s zFileDisplay.directory_selectcsnzdd|D}Wnty(gYS0tt|}|D] }|dksR|tkr:gSq:fdd|DS)zValidate 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` cSsg|] }t|qSr)intraindexrrr ~rdz6FileDisplay._scrub_checklist_input..r?csg|]}|dqS)r?rrqrirrrsrd) ValueErrorlistsetrD)r.rjrirrrrtrrhrs     z"FileDisplay._scrub_checklist_inputcCs|r t|dtr dd|D}|jdjtj|d|jttjt|dD]4\}}dj||d}|jt ||jtjqT|jttj|j 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) rcSs g|]}d|d|dfqS)z%s - %srr?r)rarPrrrrsrdz+FileDisplay._print_menu..z{new}{msg}{new})newrr?z {num}: {desc})ZnumdescN) isinstancetupler+rr:rr;r< enumeraterr)r.r>rEiryrrrrrBs zFileDisplay._print_menucCsd}|dkrdj|d}nd}|dkrt|}|dsB|drJtdfSz$t|}|dksd||krld}tWqty|jdtj |j Yq0qt |fS) a5Get 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): )max_z@Press 1 [enter] to confirm the selection (press 'c' to cancel): rPrQz{0}** Invalid input **{0}) r:r rXrRrprur+rrr;rrA)r.rrMZ input_msgrSrrrrCs*   zFileDisplay._get_valid_int_ans)TTFT)NNNNNF)NNF)rUrVNNF)NNF)NNF)__name__ __module__ __qualname____doc__r*r&rNrTr]rkr@r=rorhrBrC __classcell__rrr/rr(qs6  " !  * ) r(cCs4d|}|r|d|7}|dus0|s0J|dS)aNVerify 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 z*Invalid IDisplay call for this prompt: {0}z7 You can set an answer to this prompt with the {0} flagNr:)rrIrJr,rrrrassert_valid_calls rcsfeZdZdZfddZdddZdd d Zdd d ZdddZdddZ dddZ dddZ Z S)NoninteractiveDisplayzEAn iDisplay implementation that never asks for interactive user inputcstt|||_dSr^)r)rr*r+)r.r+Z unused_argsrKr/rrr*szNoninteractiveDisplay.__init__r3cCs<d}||7}|r|d|7}|r.|d|7}t|dS)zBError out in case of an attempt to interact in noninteractive modezrJZextrarrrr_interaction_fails z'NoninteractiveDisplay._interaction_failFTcKsX|r t|}td||j|r&dndd|r4dndjtjt|d|j dS)aeDisplays 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 r1r2r3r4r5r6N) rr8r9r+rr:rr;r<r)r.r>r!r#r"rKrrrr&s    z"NoninteractiveDisplay.notificationNc Ks&|dur|||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: )rreprrA) r.r>rErFrGrHrIrJrKrrrrNszNoninteractiveDisplay.menucKs|dur|||t|fS)aKAccept 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)rrAr.r>rIrJrKrrrrT s  zNoninteractiveDisplay.inputcKs|dur||||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>r[r\rIrJrKrrrr]0s  zNoninteractiveDisplay.yesnocKs$|dur|||d|t|fS)ajDisplay 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? )rrrA)r.r>rirIrJrKrrrrk@szNoninteractiveDisplay.checklistcKs||||S)aSimulate 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 )rTrrrrroRsz&NoninteractiveDisplay.directory_select)r3)FTT)NNNNN)NN)NNNN)NN)NN) rrrrr*rr&rNrTr]rkrorrrr/rrs"      rcCs|dd}dd|DS)zSeparate a comma or space separated list. :param str input_: input from the user :returns: strings :rtype: list ,rOcSsg|] }t|qSrr_)rastringrrrrssrdz'separate_list_input..)replacesplit)Zinput_Z no_commasrrrrggs rgcCsdj|d|dddS)znPlace parens around first character of label. :param str label: Must contain at least one character z({first}){rest}rr?N)firstrestr)ZlabelrrrrWvsrWcCsJ|sdSt|}|dkr |dS|dkr2d|Sd|d|dSdS)aMSummarizes 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 r3r?rz and z{0} and {1} more domainsN)rDrr:)Zdomainslrrrsummarize_domain_lists  r)Nr))rZloggingrrZzope.interfacer$Zzope.componentZacme.magic_typingrZcertbotrrZcertbot._internalrZcertbot._internal.displayrZcertbot.compatrrZ getLoggerrr8ZWIDTHrArRZHELPZESCr<rr r'Z interfaceZ implementerr%objectr(rrrgrWrrrrrsB           ^