\\U@sidZddlZddlZddlZddlZddlZddlmZddlm Z ddlm Z ddlm Z ddl m Z ejeZdZd Zd Zd Zd Zd ddZddZddddZejje jGdddeZddZejje jGdddeZddZ ddZ!dS)zCertbot display.N)compat) constants) interfaces)errors) completerHokZcancelhelpescz- '-c CsU|j}g}x3|D]+}|jtj|dddddqWdj|S)zFormat lines nicely to 80 chars. :param str msg: Original message :returns: Formatted message respecting newlines in message :rtype: str PZbreak_long_wordsFZbreak_on_hyphens ) splitlinesappendtextwrapZfilljoin)msglinesZfixed_lliner6/usr/lib/python3/dist-packages/certbot/display/util.py _wrap_lines%s   rg@cCsN|r#tjj|tjjtj||}|sAt|jdS)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 r cseZdZdZfddZdddddZddddddd d Zdddd d Zd ddddddZdddddZ ddZ ddZ dddddZ ddZ ddZddZS) FileDisplayzFile-based display.cs2tt|j||_||_d|_dS)NF)superr!__init__outfileforce_interactiveskipped_interaction)selfr$r%) __class__rrr#_s  zFileDisplay.__init__TFcCs}|rt|}|jjdjdtjdtd||jj|ry|j|rlt dn t j 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 z+{line}{frame}{line}{msg}{line}{frame}{line}rframerzPress Enter to Continuez!Not pausing for user confirmationN) rr$rformatoslinesep SIDE_FRAMEr _can_interactr loggerdebug)r'messagepausewrapr%rrr notificationes      zFileDisplay.notificationNc Ks[|j||||r"t|fS|j|||jt|\} } | | 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.menucKsr|j||||r"t|fStd|d}t|}|dksZ|dkrdtdfSt|fSdS)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-1N)r6r7rr CANCEL)r'r1r?r@r%rAansrrrinputs   zFileDisplay.inputZYesZNoc Ks|j||||r|St|}|jjdjtjdttjd||jjxt djdt |dt |}|j |dj s|j |dj rdS|j |dj s|j |dj rgd SqgWd S) 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}: yesnorTFN)r6rr$rr*r+r,r-rr _parens_around_char startswithlowerupper) r'r1 yes_labelno_labelr?r@r%rArIrrryesnos      zFileDisplay.yesnoc Ks |j||||r"t|fSx|j|||jddd\}}|tkrt|jdkrdjddtdt|dD}t|} |j | |} | r|| fS|j j d t j |j jq%|gfSq%Wd 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 shownr%TrrEcss|]}t|VqdS)N)str).0xrrr sz(FileDisplay.checklist..r5z!** Error - Invalid selection **%sN)r6r7r8rJr:striprrangeseparate_list_input_scrub_checklist_inputr$rr+r,r) r'r1tagsr?r@r%rArBrIindicesZ selected_tagsrrr checklists"   /   zFileDisplay.checklistcCst|j|rdS|dkrYdj|}|rG|dj|7}tj|ntjd||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%rrrrr6s   zFileDisplay._return_defaultcCsZ|js-|s-tjjr1|jjr1dS|jsVtjdtj d|_dS)zCan 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 TzSkipped 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.F) r%rstdinisattyr$r&r/ZwarningrZFORCE_INTERACTIVE_FLAG)r'r%rrrr..s    zFileDisplay._can_interactc Ks.tj|j||||SWdQRXdS)a 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)rZ CompleterrJ)r'r1r?r@r%rArrrdirectory_selectDs zFileDisplay.directory_selectc sydd|D}Wntk r/gSYnXtt|}x0|D](}|dksm|tkrIgSqIWfdd|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)int)rUindexrrr cs z6FileDisplay._scrub_checklist_input..r5csg|]}|dqS)r5r)rUrd)r\rrreos ) ValueErrorlistsetr:)r'r]r\rdr)r\rr[Vs    z"FileDisplay._scrub_checklist_inputcCs|r,t|dtr,dd|D}|jjdjdtjd||jjttjx^t|dD]M\}}djd |d |}|jjt ||jjtjqxW|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) rcSs(g|]}d|d|dfqS)z%s - %srr5r)rUrFrrrre|s z+FileDisplay._print_menu..z{new}{msg}{new}newrr5z {num}: {desc}ZnumdescN) isinstancetupler$rr*r+r,r- enumeraterr)r'r1r;irjrrrrr8qs  zFileDisplay._print_menuc Csd}|dkr'djd|}nd}x|dkrt|}|jdsf|jdrptd fSy4t|}|dks||krd }tWq0tk r|jjdjtj |jj Yq0Xq0Wt |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}rprp) r*r rNrHrcrfr$rr+r,rr7)r'rorCZ input_msgrIrrrr9s&          zFileDisplay._get_valid_int_ans)__name__ __module__ __qualname____doc__r#r4rDrJrSr^r6r.rbr[r8r9rr)r(rr!Ys(   )*    r!cCsJdj|}|r(|dj|7}|dk sF|sFt|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   rvcseZdZdZfddZdddZddd d Zd d d d d d d Zd d ddZd d d d ddZ d d ddZ d d ddZ S)NoninteractiveDisplayzEAn iDisplay implementation that never asks for interactive user inputcs tt|j||_dS)N)r"rwr#r$)r'r$Z unused_argsrA)r(rrr#szNoninteractiveDisplay.__init__cCsPd}||7}|r$|d|7}|r=|dj|7}tj|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: )ryreprr7) r'r1r;r<r=r>r?r@rArrrrDs zNoninteractiveDisplay.menucKs-|dkr|j||n t|fSdS)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)ryr7)r'r1r?r@rArrrrJs zNoninteractiveDisplay.inputcKs'|dkr|j||n|SdS)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)ry)r'r1rQrRr?r@rArrrrSs zNoninteractiveDisplay.yesnocKs9|dkr+|j||dj|n t|fSdS)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? )ryrr7)r'r1r\r?r@rArrrr^"s zNoninteractiveDisplay.checklistcKs|j|||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 )rJ)r'r1r?r@rArrrrb5sz&NoninteractiveDisplay.directory_select) rqrrrsrtr#ryr4rDrJrSr^rbrr)r(rrws  rwcCs)|jdd}dd|jDS)zSeparate a comma or space separated list. :param str input_: input from the user :returns: strings :rtype: list ,rEcSsg|]}t|qSr)rT)rUstringrrrreVs z'separate_list_input..)replacesplit)Zinput_Z no_commasrrrrZJs rZcCs$djd|dd|ddS)znPlace parens around first character of label. :param str label: Must contain at least one character z({first}){rest}firstrrestr5N)r*)ZlabelrrrrMYsrM)"rtZloggingr+rrZzope.interfacezopeZcertbotrrrrZcertbot.displayrZ getLoggerrqr/ZWIDTHr7rHZHELPZESCr-rr Z interfaceZ implementerZIDisplayobjectr!rvrwrZrMrrrrs6       Z