mirror of
https://github.com/certbot/certbot.git
synced 2026-02-26 11:20:36 -05:00
f51d345d5b
Remove unused help-related display code. When NcursesDisplay was
removed[1], help was deprecated. This change removes the remaining
bits and pieces of code.
Remove unused escape-related display code. When NcursesDisplay was
removed[1], escape was deprecated. This change removes the remaining
bits and pieces of code.
Remove uses of unused menu parameters.
Remove unused default_status/default_state argument from checklist.
(This seems safe because not only is it unused, the parameter has
different names in the interface and implementation)
1 - d54cb76432
Resolves #4795.
95 lines
3.1 KiB
Python
95 lines
3.1 KiB
Python
"""Contains UI methods for Apache operations."""
|
|
import logging
|
|
import os
|
|
|
|
import zope.component
|
|
|
|
from certbot import errors
|
|
from certbot import interfaces
|
|
|
|
import certbot.display.util as display_util
|
|
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
def select_vhost(domain, vhosts):
|
|
"""Select an appropriate Apache Vhost.
|
|
|
|
:param vhosts: Available Apache Virtual Hosts
|
|
:type vhosts: :class:`list` of type `~obj.Vhost`
|
|
|
|
:returns: VirtualHost or `None`
|
|
:rtype: `~obj.Vhost` or `None`
|
|
|
|
"""
|
|
if not vhosts:
|
|
return None
|
|
while True:
|
|
code, tag = _vhost_menu(domain, vhosts)
|
|
if code == display_util.OK:
|
|
return vhosts[tag]
|
|
else:
|
|
return None
|
|
|
|
|
|
def _vhost_menu(domain, vhosts):
|
|
"""Select an appropriate Apache Vhost.
|
|
|
|
:param vhosts: Available Apache Virtual Hosts
|
|
:type vhosts: :class:`list` of type `~obj.Vhost`
|
|
|
|
:returns: Display tuple - ('code', tag')
|
|
:rtype: `tuple`
|
|
|
|
"""
|
|
# Free characters in the line of display text (9 is for ' | ' formatting)
|
|
free_chars = display_util.WIDTH - len("HTTPS") - len("Enabled") - 9
|
|
|
|
if free_chars < 2:
|
|
logger.debug("Display size is too small for "
|
|
"certbot_apache.display_ops._vhost_menu()")
|
|
# This runs the edge off the screen, but it doesn't cause an "error"
|
|
filename_size = 1
|
|
disp_name_size = 1
|
|
else:
|
|
# Filename is a bit more important and probably longer with 000-*
|
|
filename_size = int(free_chars * .6)
|
|
disp_name_size = free_chars - filename_size
|
|
|
|
choices = []
|
|
for vhost in vhosts:
|
|
if len(vhost.get_names()) == 1:
|
|
disp_name = next(iter(vhost.get_names()))
|
|
elif len(vhost.get_names()) == 0:
|
|
disp_name = ""
|
|
else:
|
|
disp_name = "Multiple Names"
|
|
|
|
choices.append(
|
|
"{fn:{fn_size}s} | {name:{name_size}s} | {https:5s} | "
|
|
"{active:7s}".format(
|
|
fn=os.path.basename(vhost.filep)[:filename_size],
|
|
name=disp_name[:disp_name_size],
|
|
https="HTTPS" if vhost.ssl else "",
|
|
active="Enabled" if vhost.enabled else "",
|
|
fn_size=filename_size,
|
|
name_size=disp_name_size)
|
|
)
|
|
|
|
try:
|
|
code, tag = zope.component.getUtility(interfaces.IDisplay).menu(
|
|
"We were unable to find a vhost with a ServerName "
|
|
"or Address of {0}.{1}Which virtual host would you "
|
|
"like to choose?\n(note: conf files with multiple "
|
|
"vhosts are not yet supported)".format(domain, os.linesep),
|
|
choices, force_interactive=True)
|
|
except errors.MissingCommandlineFlag:
|
|
msg = ("Encountered vhost ambiguity but unable to ask for user guidance in "
|
|
"non-interactive mode. Currently Certbot needs each vhost to be "
|
|
"in its own conf file, and may need vhosts to be explicitly "
|
|
"labelled with ServerName or ServerAlias directives.")
|
|
logger.warning(msg)
|
|
raise errors.MissingCommandlineFlag(msg)
|
|
|
|
return code, tag
|