U ](U@sdZddlZddlZddlZddlZddlmZddlmZddlm Z ddl m Z ddl m Z ddl mZeeZd Zd Zd Zd Zd ZdZddZdddZeje jGdddeZddZeje jGdddeZ ddZ!ddZ"dS)zCertbot display.N) constants)errors) interfaces)misc)os) completerHokZcancelhelpZesczO- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -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_lines%s  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_timeout;s   rcseZdZdZfddZdddZd 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"_szFileDisplay.__init__TFcCsT|r t|}|jdjdt|d|j|rP||rFtdn t ddS)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 +{line}{frame}{line}{msg}{line}{frame}{line}r rframerzPress Enter to Continuez!Not pausing for user confirmationN) rr#rformat SIDE_FRAMEr _can_interactrloggerdebug)r&messagepausewrapr$rrr notificationes    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&r1choicesok_label cancel_label help_labeldefaultcli_flagr$ unused_kwargscode selectionrrrmenu}s  zFileDisplay.menucKsP|||||rt|fStd|d}t|}|dks@|dkrHtdfSt|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)r6r7rrCANCEL)r&r1r?r@r$rAansrrrinputszFileDisplay.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})r+rz {yes}/{no}: )ZyesZnorTFN)r6rr#rr,rlinesepr-rr_parens_around_char startswithlowerupper) r&r1 yes_labelno_labelr?r@r$rArIrrryesnos*  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$rEcss|]}t|VqdSNstr).0xrrr sz(FileDisplay.checklist..r5z!** Error - Invalid selection **%sN)r6r7r8rJstriprranger:separate_list_input_scrub_checklist_inputr#rrrMr) r&r1tagsr?r@r$rArBrIindicesZ selected_tagsrrr checklists$  "  zFileDisplay.checklistcCsT||rdS|dkr>d|}|r2|d|7}t|ntd||dSdS)aShould 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 FNz-Unable to get an answer for the question: {0}zA You can provide an answer on the command line with the {0} flag.z-Falling back to default %s for the prompt: %sT)r.r,rErrorr/r0)r&rr?r@r$rrrrr6 s"   zFileDisplay._return_defaultcCs@|js|stjr"|jr"dS|js`sz6FileDisplay._scrub_checklist_input..r5csg|]}|dqS)r5rrgr_rrrils) ValueErrorlistsetr:)r&r`r_rhrrjrr^Ss    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 - %srr5r)rXrFrrrriysz+FileDisplay._print_menu..z{new}{msg}{new})newrr5z {num}: {desc})ZnumdescN) isinstancetupler#rr,rrMr- enumeraterr)r&r1r;irorrrrr8ns zFileDisplay._print_menucCsd}|dkrdj|d}nd}|dkrt|}|dsB|drJtdfSz$t|}|dksd||krld}tWqtk r|jdtj |j YqXqt |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 r5zMSelect the appropriate number [1-{max_}] then [enter] (press 'c' to cancel): )max_z@Press 1 [enter] to confirm the selection (press 'c' to cancel): rFrGz{0}** Invalid input **{0}) r,rrOrHrfrkr#rrrMrr7)r&rurCZ input_msgrIrrrr9s*  zFileDisplay._get_valid_int_ans)TTF)NNNNNF)NNF)rKrLNNF)NNF)NNF)__name__ __module__ __qualname____doc__r"r4rDrJrTrar6r.rer^r8r9 __classcell__rrr'rr Ys@   !  * * r cCs4d|}|r|d|7}|dk s0|s0t|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} flagN)r,AssertionError)rr?r@r$rrrrassert_valid_calls r|csfeZdZdZfddZdddZdd d Zdd d ZdddZdddZ dddZ dddZ Z S)NoninteractiveDisplayzEAn iDisplay implementation that never asks for interactive user inputcstt|||_dSrU)r!r}r"r#)r&r#Z unused_argsrAr'rrr"szNoninteractiveDisplay.__init__cCs<d}||7}|r|d|7}|r.|d|7}t|dS)zBError out 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: )rreprr7) r&r1r;r<r=r>r?r@rArrrrDszNoninteractiveDisplay.menucKs|dkr|||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)rr7r&r1r?r@rArrrrJs  zNoninteractiveDisplay.inputcKs|dkr||||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&r1rRrSr?r@rArrrrT s  zNoninteractiveDisplay.yesnocKs$|dkr|||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? )rrr7)r&r1r_r?r@rArrrraszNoninteractiveDisplay.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 )rJrrrrre-sz&NoninteractiveDisplay.directory_select)r~)FT)NNNNN)NN)NNNN)NN)NN) rvrwrxryr"rr4rDrJrTrarerzrrr'rr}s(      r}cCs|dd}dd|DS)zSeparate a comma or space separated list. :param str input_: input from the user :returns: strings :rtype: list ,rEcSsg|] }t|qSrrV)rXstringrrrriNsz'separate_list_input..)replacesplit)Zinput_Z no_commasrrrr]Bs r]cCsdj|d|dddS)znPlace parens around first character of label. :param str label: Must contain at least one character z({first}){rest}rr5N)firstrest)r,)ZlabelrrrrNQsrN)Nr)#ryZloggingrrZzope.interfacezopeZcertbotrrrZcertbot.compatrrZcertbot.displayrZ getLoggerrvr/ZWIDTHr7rHZHELPZESCr-rrZ interfaceZ implementerZIDisplayobjectr r|r}r]rNrrrrs8         X