Add Plex config flow support (#26548)
* Add config flow support * Log error on failed connection * Review comments * Unused errors * Move form to step * Use instance var instead of passing argument * Only share servers created by component * Return errors early to avoid try:else * Separate debug for validation vs setup * Unnecessary * Unnecessary checks * Combine import flows, move logic to component * Use config entry discovery handler * Temporary lint fix * Filter out servers already configured * Remove manual config flow * Skip discovery if a config exists * Swap conditional to reduce indenting * Only discover when no configs created or creating * Un-nest function * Proper async use * Move legacy file import to discovery * Fix, bad else * Separate validate step * Unused without manual setup step * Async oops * First attempt at tests * Test cleanup * Full test coverage for config_flow, enable tests * Lint * Fix lint vs black * Add test init * Add test package requirement * Actually run script * Use 'not None' convention * Group exceptions by result * Improve logic, add new error and test * Test cleanup * Add more asserts
This commit is contained in:
1 parent
246a611a7c
commit
2d12bac0e2
17 files changed
+836
-172
No files matched your search
@@ -5,7 +5,7 @@ import plexapi.exceptions
|
||||
import requests.exceptions
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.discovery import SERVICE_PLEX
|
||||
from homeassistant import config_entries
|
||||
from homeassistant.components.media_player import DOMAIN as MP_DOMAIN
|
||||
from homeassistant.const import (
|
||||
CONF_HOST,
|
||||
@@ -16,20 +16,18 @@ from homeassistant.const import (
|
||||
CONF_VERIFY_SSL,
|
||||
)
|
||||
from homeassistant.helpers import config_validation as cv
|
||||
from homeassistant.helpers import discovery
|
||||
from homeassistant.util.json import load_json, save_json
|
||||
|
||||
from .const import (
|
||||
CONF_SERVER,
|
||||
CONF_USE_EPISODE_ART,
|
||||
CONF_SHOW_ALL_CONTROLS,
|
||||
CONF_SERVER,
|
||||
DEFAULT_PORT,
|
||||
DEFAULT_SSL,
|
||||
DEFAULT_VERIFY_SSL,
|
||||
DOMAIN as PLEX_DOMAIN,
|
||||
PLATFORMS,
|
||||
PLEX_CONFIG_FILE,
|
||||
PLEX_MEDIA_PLAYER_OPTIONS,
|
||||
PLEX_SERVER_CONFIG,
|
||||
SERVERS,
|
||||
)
|
||||
from .server import PlexServer
|
||||
@@ -58,151 +56,76 @@ SERVER_CONFIG_SCHEMA = vol.Schema(
|
||||
|
||||
CONFIG_SCHEMA = vol.Schema({PLEX_DOMAIN: SERVER_CONFIG_SCHEMA}, extra=vol.ALLOW_EXTRA)
|
||||
|
||||
CONFIGURING = "configuring"
|
||||
_LOGGER = logging.getLogger(__package__)
|
||||
|
||||
|
||||
def setup(hass, config):
|
||||
"""Set up the Plex component."""
|
||||
|
||||
def server_discovered(service, info):
|
||||
"""Pass back discovered Plex server details."""
|
||||
if hass.data[PLEX_DOMAIN][SERVERS]:
|
||||
_LOGGER.debug("Plex server already configured, ignoring discovery.")
|
||||
return
|
||||
_LOGGER.debug("Discovered Plex server: %s:%s", info["host"], info["port"])
|
||||
setup_plex(discovery_info=info)
|
||||
|
||||
def setup_plex(config=None, discovery_info=None, configurator_info=None):
|
||||
"""Return assembled server_config dict."""
|
||||
json_file = hass.config.path(PLEX_CONFIG_FILE)
|
||||
file_config = load_json(json_file)
|
||||
host_and_port = None
|
||||
|
||||
if config:
|
||||
server_config = config
|
||||
if CONF_HOST in server_config:
|
||||
host_and_port = (
|
||||
f"{server_config.pop(CONF_HOST)}:{server_config.pop(CONF_PORT)}"
|
||||
)
|
||||
if MP_DOMAIN in server_config:
|
||||
hass.data[PLEX_MEDIA_PLAYER_OPTIONS] = server_config.pop(MP_DOMAIN)
|
||||
elif file_config:
|
||||
_LOGGER.debug("Loading config from %s", json_file)
|
||||
host_and_port, server_config = file_config.popitem()
|
||||
server_config[CONF_VERIFY_SSL] = server_config.pop("verify")
|
||||
elif discovery_info:
|
||||
server_config = {}
|
||||
host_and_port = f"{discovery_info[CONF_HOST]}:{discovery_info[CONF_PORT]}"
|
||||
elif configurator_info:
|
||||
server_config = configurator_info
|
||||
host_and_port = server_config["host_and_port"]
|
||||
else:
|
||||
discovery.listen(hass, SERVICE_PLEX, server_discovered)
|
||||
return True
|
||||
|
||||
if host_and_port:
|
||||
use_ssl = server_config.get(CONF_SSL, DEFAULT_SSL)
|
||||
http_prefix = "https" if use_ssl else "http"
|
||||
server_config[CONF_URL] = f"{http_prefix}://{host_and_port}"
|
||||
|
||||
plex_server = PlexServer(server_config)
|
||||
try:
|
||||
plex_server.connect()
|
||||
except requests.exceptions.ConnectionError as error:
|
||||
_LOGGER.error(
|
||||
"Plex server could not be reached, please verify host and port: [%s]",
|
||||
error,
|
||||
)
|
||||
return False
|
||||
except (
|
||||
plexapi.exceptions.BadRequest,
|
||||
plexapi.exceptions.Unauthorized,
|
||||
plexapi.exceptions.NotFound,
|
||||
) as error:
|
||||
_LOGGER.error(
|
||||
"Connection to Plex server failed, please verify token and SSL settings: [%s]",
|
||||
error,
|
||||
)
|
||||
request_configuration(host_and_port)
|
||||
return False
|
||||
else:
|
||||
hass.data[PLEX_DOMAIN][SERVERS][
|
||||
plex_server.machine_identifier
|
||||
] = plex_server
|
||||
|
||||
if host_and_port in hass.data[PLEX_DOMAIN][CONFIGURING]:
|
||||
request_id = hass.data[PLEX_DOMAIN][CONFIGURING].pop(host_and_port)
|
||||
configurator = hass.components.configurator
|
||||
configurator.request_done(request_id)
|
||||
_LOGGER.debug("Discovery configuration done")
|
||||
if configurator_info:
|
||||
# Write plex.conf if created via discovery/configurator
|
||||
save_json(
|
||||
hass.config.path(PLEX_CONFIG_FILE),
|
||||
{
|
||||
host_and_port: {
|
||||
CONF_TOKEN: server_config[CONF_TOKEN],
|
||||
CONF_SSL: use_ssl,
|
||||
"verify": server_config[CONF_VERIFY_SSL],
|
||||
}
|
||||
},
|
||||
)
|
||||
|
||||
if not hass.data.get(PLEX_MEDIA_PLAYER_OPTIONS):
|
||||
hass.data[PLEX_MEDIA_PLAYER_OPTIONS] = MEDIA_PLAYER_SCHEMA({})
|
||||
|
||||
for platform in PLATFORMS:
|
||||
hass.helpers.discovery.load_platform(
|
||||
platform, PLEX_DOMAIN, {}, original_config
|
||||
)
|
||||
|
||||
return True
|
||||
|
||||
def request_configuration(host_and_port):
|
||||
"""Request configuration steps from the user."""
|
||||
configurator = hass.components.configurator
|
||||
if host_and_port in hass.data[PLEX_DOMAIN][CONFIGURING]:
|
||||
configurator.notify_errors(
|
||||
hass.data[PLEX_DOMAIN][CONFIGURING][host_and_port],
|
||||
"Failed to register, please try again.",
|
||||
)
|
||||
return
|
||||
|
||||
def plex_configuration_callback(data):
|
||||
"""Handle configuration changes."""
|
||||
config = {
|
||||
"host_and_port": host_and_port,
|
||||
CONF_TOKEN: data.get("token"),
|
||||
CONF_SSL: cv.boolean(data.get("ssl")),
|
||||
CONF_VERIFY_SSL: cv.boolean(data.get("verify_ssl")),
|
||||
}
|
||||
setup_plex(configurator_info=config)
|
||||
|
||||
hass.data[PLEX_DOMAIN][CONFIGURING][
|
||||
host_and_port
|
||||
] = configurator.request_config(
|
||||
"Plex Media Server",
|
||||
plex_configuration_callback,
|
||||
description="Enter the X-Plex-Token",
|
||||
entity_picture="/static/images/logo_plex_mediaserver.png",
|
||||
submit_caption="Confirm",
|
||||
fields=[
|
||||
{"id": "token", "name": "X-Plex-Token", "type": ""},
|
||||
{"id": "ssl", "name": "Use SSL", "type": ""},
|
||||
{"id": "verify_ssl", "name": "Verify SSL", "type": ""},
|
||||
],
|
||||
)
|
||||
|
||||
# End of inner functions.
|
||||
|
||||
original_config = config
|
||||
|
||||
hass.data.setdefault(PLEX_DOMAIN, {SERVERS: {}, CONFIGURING: {}})
|
||||
|
||||
if hass.data[PLEX_DOMAIN][SERVERS]:
|
||||
_LOGGER.debug("Plex server already configured")
|
||||
return False
|
||||
hass.data.setdefault(PLEX_DOMAIN, {SERVERS: {}})
|
||||
|
||||
plex_config = config.get(PLEX_DOMAIN, {})
|
||||
return setup_plex(config=plex_config)
|
||||
if plex_config:
|
||||
_setup_plex(hass, plex_config)
|
||||
|
||||
return True
|
||||
|
||||
|
||||
def _setup_plex(hass, config):
|
||||
"""Pass configuration to a config flow."""
|
||||
server_config = dict(config)
|
||||
if MP_DOMAIN in server_config:
|
||||
hass.data[PLEX_MEDIA_PLAYER_OPTIONS] = server_config.pop(MP_DOMAIN)
|
||||
if CONF_HOST in server_config:
|
||||
prefix = "https" if server_config.pop(CONF_SSL) else "http"
|
||||
server_config[
|
||||
CONF_URL
|
||||
] = f"{prefix}://{server_config.pop(CONF_HOST)}:{server_config.pop(CONF_PORT)}"
|
||||
hass.async_create_task(
|
||||
hass.config_entries.flow.async_init(
|
||||
PLEX_DOMAIN,
|
||||
context={"source": config_entries.SOURCE_IMPORT},
|
||||
data=server_config,
|
||||
)
|
||||
)
|
||||
|
||||
|
||||
async def async_setup_entry(hass, entry):
|
||||
"""Set up Plex from a config entry."""
|
||||
server_config = entry.data[PLEX_SERVER_CONFIG]
|
||||
|
||||
plex_server = PlexServer(server_config)
|
||||
try:
|
||||
await hass.async_add_executor_job(plex_server.connect)
|
||||
except requests.exceptions.ConnectionError as error:
|
||||
_LOGGER.error(
|
||||
"Plex server (%s) could not be reached: [%s]",
|
||||
server_config[CONF_URL],
|
||||
error,
|
||||
)
|
||||
return False
|
||||
except (
|
||||
plexapi.exceptions.BadRequest,
|
||||
plexapi.exceptions.Unauthorized,
|
||||
plexapi.exceptions.NotFound,
|
||||
) as error:
|
||||
_LOGGER.error(
|
||||
"Login to %s failed, verify token and SSL settings: [%s]",
|
||||
server_config[CONF_SERVER],
|
||||
error,
|
||||
)
|
||||
return False
|
||||
|
||||
_LOGGER.debug(
|
||||
"Connected to: %s (%s)", plex_server.friendly_name, plex_server.url_in_use
|
||||
)
|
||||
hass.data[PLEX_DOMAIN][SERVERS][plex_server.machine_identifier] = plex_server
|
||||
|
||||
if not hass.data.get(PLEX_MEDIA_PLAYER_OPTIONS):
|
||||
hass.data[PLEX_MEDIA_PLAYER_OPTIONS] = MEDIA_PLAYER_SCHEMA({})
|
||||
|
||||
for platform in PLATFORMS:
|
||||
hass.async_create_task(
|
||||
hass.config_entries.async_forward_entry_setup(entry, platform)
|
||||
)
|
||||
|
||||
return True
|
||||
Reference in new issue
Block a user