ó Y[c@sVdZddlZddlZddlZddlZddlZddlZddlm Z ddlm Z ddlm Z ddl m Z ejeƒZdZdZd Zd Zd Zd d dZd„Zedd„Zejje jƒdefd„ƒYƒZd„Zejje jƒdefd„ƒYƒZ d„Z!d„Z"dS(sCertbot display.iÿÿÿÿN(t constants(t interfaces(terrors(t completeriHtoktcancelthelptescs- i't-c CsX|jƒ}g}x3|D]+}|jtj|ddtdtƒƒqWtjj|ƒS(sœFormat lines nicely to 80 chars. :param str msg: Original message :returns: Formatted message respecting newlines in message :rtype: str iPtbreak_long_wordstbreak_on_hyphens(t splitlinestappendttextwraptfilltFalsetostlineseptjoin(tmsgtlinestfixed_ltline((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyt _wrap_lines%s   g”á@cCsš|r&tjj|ƒtjjƒntjtjggg|ƒ\}}}|sntjdj|ƒƒ‚n|dj ƒ}|st ‚n|j dƒS(sGet 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,Timed out waiting for answer to prompt '{0}'is ( tsyststdouttwritetflushtselecttstdinRtErrortformattreadlinetEOFErrortrstrip(tpromptttimeouttrlistt_R((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pytinput_with_timeout;s' t FileDisplaycBs¿eZdZd„Zeeed„Zddddded„Zdded„Z dddded„Z dded„Z d „Z d „Z dded „Zd „Zd „Zd„ZRS(sFile-based display.cCs2tt|ƒjƒ||_||_t|_dS(N(tsuperR(t__init__toutfiletforce_interactiveRtskipped_interaction(tselfR+R,((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR*ds  cCsƒ|rt|ƒ}n|jjdjdtjdtd|ƒƒ|jjƒ|r|j|ƒrot dƒqt j dƒndS(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 s+{line}{frame}{line}{msg}{line}{frame}{line}RtframeRsPress Enter to Continues!Not pausing for user confirmationN( RR+RRRRt SIDE_FRAMERt _can_interactR'tloggertdebug(R.tmessagetpausetwrapR,((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyt notificationjs     c Ks[|j||||ƒr"t|fS|j||ƒ|jt|ƒƒ\} } | | dfS(sCDisplay 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_defaulttOKt _print_menut_get_valid_int_anstlen( R.R4tchoicestok_labelt cancel_labelt help_labeltdefaulttcli_flagR,t unused_kwargstcodet selection((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pytmenu‚s  cKsr|j||||ƒr"t|fStd|ƒd}t|ƒ}|dksZ|dkrdtdfSt|fSdS(sAccept 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 tctCs-1N(R8R9RR'tCANCEL(R.R4RARBR,RCtans((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pytinput¤s   tYestNoc Ks |j||||ƒr|St|ƒ}|jjdjtjdttjd|ƒƒ|jjƒx t rt djdt |ƒdt |ƒƒƒ}|j |dj ƒƒsÉ|j |djƒƒrÍt S|j |dj ƒƒsÿ|j |djƒƒrgtSqgWdS( 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}R/Rs {yes}/{no}: tyestnoiN(R8RR+RRRRR0RtTrueR't_parens_around_chart startswithtlowertupperR( R.R4t yes_labeltno_labelRARBR,RCRK((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pytyesnoÀs       c Ks|j||||ƒr"t|fSxçtr |j||ƒ|jddtƒ\}}|tkrþt|jƒƒdkr©djd„tdt|ƒdƒDƒƒ}nt |ƒ} |j | |ƒ} | r×|| fS|j j dt jƒ|j jƒq%|gfSq%WdS( sCDisplay 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 srSelect the appropriate numbers separated by commas and/or spaces, or leave input blank to select all options shownR,iRGcss|]}t|ƒVqdS(N(tstr(t.0tx((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pys sis!** Error - Invalid selection **%sN(R8R9RQR:RLR<tstripRtrangetseparate_list_inputt_scrub_checklist_inputR+RRRR( R.R4ttagsRARBR,RCRDRKtindicest selected_tags((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyt checklistês"    /   cCsw|j|ƒrtS|dkr\dj|ƒ}|rJ|dj|ƒ7}ntj|ƒ‚ntjd||ƒtSdS(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( R1RtNoneRRRR2R3RQ(R.R#RARBR,R((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR8s   cCs]|js-|s-tjjƒr1|jjƒr1tS|jsYtjdt j ƒt|_nt 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 sSkipped 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.( R,RRtisattyR+RQR-R2twarningRtFORCE_INTERACTIVE_FLAGR(R.R,((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR13s    c Ks-tjƒ|j||||ƒSWdQXdS(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(Rt CompleterRL(R.R4RARBR,RC((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pytdirectory_selectIs cCsœy#g|D]}t|ƒ^q }Wntk r7gSXtt|ƒƒ}x0|D](}|dksu|t|ƒkrQgSqQWg|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(tintt ValueErrortlisttsetR<(R.RaR`tindex((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR_[s #  cCs |rGt|dtƒrGg|D]}d|d|df^q }n|jjdjdtjd|ƒƒ|jjttjƒx^t|dƒD]M\}}djd|d |ƒ}|jjt |ƒƒ|jjtjƒq“W|jjttjƒ|jj ƒ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) is%s - %sis{new}{msg}{new}tnewRs {num}: {desc}tnumtdescN( t isinstancettupleR+RRRRR0t enumerateRR(R.R4R=RHtiRqR((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR:vs . cCsòd}|dkr'djd|ƒ}nd}x¸|dkrçt|ƒ}|jdƒsf|jdƒrptdfSy7t|ƒ}|dks—||kr¦d}t‚nWq0tk rã|jjdjtj ƒƒ|jj ƒq0Xq0Wt |fS( s5Get 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ÿÿÿÿisMSelect the appropriate number [1-{max_}] then [enter] (press 'c' to cancel): tmax_s@Press 1 [enter] to confirm the selection (press 'c' to cancel): RHRIs{0}** Invalid input **{0}( RR'RSRJRjRkR+RRRRR9(R.RvREt input_msgRK((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR;“s&          N(t__name__t __module__t__doc__R*RQRR7RdRFRLRXRcR8R1RiR_R:R;(((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR(^s(   )*     cCsMdj|ƒ}|r+|dj|ƒ7}n|dk sI|sIt|ƒ‚dS(sNVerify 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(RRdtAssertionError(R#RARBR,R((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pytassert_valid_call¸s   tNoninteractiveDisplaycBsŒeZdZd„Zdd„Zeed„Zd 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( sEAn iDisplay implementation that never asks for interactive user inputcOs tt|ƒjƒ||_dS(N(R)R}R*R+(R.R+t unused_argsRC((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR*ÎstcCsVd}||7}|r'|d|7}n|rC|dj|ƒ7}ntj|ƒ‚dS(sBError 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(RRtMissingCommandlineFlag(R.R4RBtextraR((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyt_interaction_failÒs cKsQ|rt|ƒ}n|jjdjdtjdtd|ƒƒ|jjƒdS(sDisplays 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 s+{line}{frame}{line}{msg}{line}{frame}{line}RR/RN(RR+RRRRR0R(R.R4R5R6RC((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR7Üs   c Ks6|dkr,|j||dt|ƒƒnt|fS(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(RdR‚treprR9( R.R4R=R>R?R@RARBRC((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyRFìs  cKs-|dkr|j||ƒn t|fSdS(sKAccept 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(RdR‚R9(R.R4RARBRC((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyRLs cKs'|dkr|j||ƒn|SdS(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(RdR‚(R.R4RVRWRARBRC((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyRXs cKs9|dkr+|j||dj|ƒƒn t|fSdS(sjDisplay 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(RdR‚RR9(R.R4R`RARBRC((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyRc's cKs|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 (RL(R.R4RARBRC((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyRi:sN(RxRyRzR*R‚RRQR7RdRFRLRXRcRi(((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR}Ês   cCs5|jddƒ}g|jƒD]}t|ƒ^qS(sƒSeparate a comma or space separated list. :param str input_: input from the user :returns: strings :rtype: list t,RG(treplacetsplitRY(tinput_t no_commaststring((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyR^Os cCsdjd|dd|dƒS(snPlace parens around first character of label. :param str label: Must contain at least one character s({first}){rest}tfirstitresti(R(tlabel((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyRR^s(#RztloggingRRRR tzope.interfacetzopetcertbotRRRtcertbot.displayRt getLoggerRxR2tWIDTHR9RJtHELPtESCR0RRdR't interfacet implementertIDisplaytobjectR(R|R}R^RR(((s8/usr/lib/python2.7/dist-packages/certbot/display/util.pyts6       #ÿZ „