500 lines
16 KiB
Python
500 lines
16 KiB
Python
"""Handle the frontend for Home Assistant."""
|
|
import asyncio
|
|
import hashlib
|
|
import json
|
|
import logging
|
|
import os
|
|
|
|
from aiohttp import web
|
|
import voluptuous as vol
|
|
import homeassistant.helpers.config_validation as cv
|
|
|
|
from homeassistant.config import find_config_file, load_yaml_config_file
|
|
from homeassistant.const import CONF_NAME, EVENT_THEMES_UPDATED
|
|
from homeassistant.core import callback
|
|
from homeassistant.loader import bind_hass
|
|
from homeassistant.components.http import HomeAssistantView
|
|
from homeassistant.components.http.auth import is_trusted_ip
|
|
|
|
DOMAIN = 'frontend'
|
|
DEPENDENCIES = ['api', 'websocket_api']
|
|
REQUIREMENTS = ['home-assistant-frontend==20171027.1']
|
|
|
|
URL_PANEL_COMPONENT = '/frontend/panels/{}.html'
|
|
URL_PANEL_COMPONENT_FP = '/frontend/panels/{}-{}.html'
|
|
|
|
POLYMER_PATH = os.path.join(os.path.dirname(__file__),
|
|
'home-assistant-polymer/')
|
|
FINAL_PATH = os.path.join(POLYMER_PATH, 'final')
|
|
|
|
CONF_THEMES = 'themes'
|
|
CONF_EXTRA_HTML_URL = 'extra_html_url'
|
|
CONF_FRONTEND_REPO = 'development_repo'
|
|
DEFAULT_THEME_COLOR = '#03A9F4'
|
|
MANIFEST_JSON = {
|
|
'background_color': '#FFFFFF',
|
|
'description': 'Open-source home automation platform running on Python 3.',
|
|
'dir': 'ltr',
|
|
'display': 'standalone',
|
|
'icons': [],
|
|
'lang': 'en-US',
|
|
'name': 'Home Assistant',
|
|
'short_name': 'Assistant',
|
|
'start_url': '/',
|
|
'theme_color': DEFAULT_THEME_COLOR
|
|
}
|
|
|
|
for size in (192, 384, 512, 1024):
|
|
MANIFEST_JSON['icons'].append({
|
|
'src': '/static/icons/favicon-{}x{}.png'.format(size, size),
|
|
'sizes': '{}x{}'.format(size, size),
|
|
'type': 'image/png'
|
|
})
|
|
|
|
DATA_FINALIZE_PANEL = 'frontend_finalize_panel'
|
|
DATA_PANELS = 'frontend_panels'
|
|
DATA_EXTRA_HTML_URL = 'frontend_extra_html_url'
|
|
DATA_THEMES = 'frontend_themes'
|
|
DATA_DEFAULT_THEME = 'frontend_default_theme'
|
|
DEFAULT_THEME = 'default'
|
|
|
|
PRIMARY_COLOR = 'primary-color'
|
|
|
|
# To keep track we don't register a component twice (gives a warning)
|
|
# _REGISTERED_COMPONENTS = set()
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
CONFIG_SCHEMA = vol.Schema({
|
|
DOMAIN: vol.Schema({
|
|
vol.Optional(CONF_FRONTEND_REPO): cv.isdir,
|
|
vol.Optional(CONF_THEMES): vol.Schema({
|
|
cv.string: {cv.string: cv.string}
|
|
}),
|
|
vol.Optional(CONF_EXTRA_HTML_URL):
|
|
vol.All(cv.ensure_list, [cv.string]),
|
|
}),
|
|
}, extra=vol.ALLOW_EXTRA)
|
|
|
|
SERVICE_SET_THEME = 'set_theme'
|
|
SERVICE_RELOAD_THEMES = 'reload_themes'
|
|
SERVICE_SET_THEME_SCHEMA = vol.Schema({
|
|
vol.Required(CONF_NAME): cv.string,
|
|
})
|
|
|
|
|
|
class AbstractPanel:
|
|
"""Abstract class for panels."""
|
|
|
|
# Name of the webcomponent
|
|
component_name = None
|
|
|
|
# Icon to show in the sidebar (optional)
|
|
sidebar_icon = None
|
|
|
|
# Title to show in the sidebar (optional)
|
|
sidebar_title = None
|
|
|
|
# Url to the webcomponent
|
|
webcomponent_url = None
|
|
|
|
# Url to show the panel in the frontend
|
|
frontend_url_path = None
|
|
|
|
# Config to pass to the webcomponent
|
|
config = None
|
|
|
|
@asyncio.coroutine
|
|
def async_register(self, hass):
|
|
"""Register panel with HASS."""
|
|
panels = hass.data.get(DATA_PANELS)
|
|
if panels is None:
|
|
panels = hass.data[DATA_PANELS] = {}
|
|
|
|
if self.frontend_url_path in panels:
|
|
_LOGGER.warning("Overwriting component %s", self.frontend_url_path)
|
|
|
|
if DATA_FINALIZE_PANEL in hass.data:
|
|
yield from hass.data[DATA_FINALIZE_PANEL](self)
|
|
|
|
panels[self.frontend_url_path] = self
|
|
|
|
@callback
|
|
def async_register_index_routes(self, router, index_view):
|
|
"""Register routes for panel to be served by index view."""
|
|
router.add_route(
|
|
'get', '/{}'.format(self.frontend_url_path), index_view.get)
|
|
router.add_route(
|
|
'get', '/{}/{{extra:.+}}'.format(self.frontend_url_path),
|
|
index_view.get)
|
|
|
|
def as_dict(self):
|
|
"""Panel as dictionary."""
|
|
return {
|
|
'component_name': self.component_name,
|
|
'icon': self.sidebar_icon,
|
|
'title': self.sidebar_title,
|
|
'url': self.webcomponent_url,
|
|
'url_path': self.frontend_url_path,
|
|
'config': self.config,
|
|
}
|
|
|
|
|
|
class BuiltInPanel(AbstractPanel):
|
|
"""Panel that is part of hass_frontend."""
|
|
|
|
def __init__(self, component_name, sidebar_title, sidebar_icon,
|
|
frontend_url_path, config):
|
|
"""Initialize a built-in panel."""
|
|
self.component_name = component_name
|
|
self.sidebar_title = sidebar_title
|
|
self.sidebar_icon = sidebar_icon
|
|
self.frontend_url_path = frontend_url_path or component_name
|
|
self.config = config
|
|
|
|
@asyncio.coroutine
|
|
def async_finalize(self, hass, frontend_repository_path):
|
|
"""Finalize this panel for usage.
|
|
|
|
If frontend_repository_path is set, will be prepended to path of
|
|
built-in components.
|
|
"""
|
|
panel_path = 'panels/ha-panel-{}.html'.format(self.component_name)
|
|
|
|
if frontend_repository_path is None:
|
|
import hass_frontend
|
|
|
|
self.webcomponent_url = \
|
|
'/static/panels/ha-panel-{}-{}.html'.format(
|
|
self.component_name,
|
|
hass_frontend.FINGERPRINTS[panel_path])
|
|
|
|
else:
|
|
# Dev mode
|
|
self.webcomponent_url = \
|
|
'/home-assistant-polymer/panels/{}/ha-panel-{}.html'.format(
|
|
self.component_name, self.component_name)
|
|
|
|
|
|
class ExternalPanel(AbstractPanel):
|
|
"""Panel that is added by a custom component."""
|
|
|
|
REGISTERED_COMPONENTS = set()
|
|
|
|
def __init__(self, component_name, path, md5, sidebar_title, sidebar_icon,
|
|
frontend_url_path, config):
|
|
"""Initialize an external panel."""
|
|
self.component_name = component_name
|
|
self.path = path
|
|
self.md5 = md5
|
|
self.sidebar_title = sidebar_title
|
|
self.sidebar_icon = sidebar_icon
|
|
self.frontend_url_path = frontend_url_path or component_name
|
|
self.config = config
|
|
|
|
@asyncio.coroutine
|
|
def async_finalize(self, hass, frontend_repository_path):
|
|
"""Finalize this panel for usage.
|
|
|
|
frontend_repository_path is set, will be prepended to path of built-in
|
|
components.
|
|
"""
|
|
try:
|
|
if self.md5 is None:
|
|
yield from hass.async_add_job(_fingerprint, self.path)
|
|
except OSError:
|
|
_LOGGER.error('Cannot find or access %s at %s',
|
|
self.component_name, self.path)
|
|
hass.data[DATA_PANELS].pop(self.frontend_url_path)
|
|
|
|
self.webcomponent_url = \
|
|
URL_PANEL_COMPONENT_FP.format(self.component_name, self.md5)
|
|
|
|
if self.component_name not in self.REGISTERED_COMPONENTS:
|
|
hass.http.register_static_path(self.webcomponent_url, self.path)
|
|
self.REGISTERED_COMPONENTS.add(self.component_name)
|
|
|
|
|
|
@bind_hass
|
|
@asyncio.coroutine
|
|
def async_register_built_in_panel(hass, component_name, sidebar_title=None,
|
|
sidebar_icon=None, frontend_url_path=None,
|
|
config=None):
|
|
"""Register a built-in panel."""
|
|
panel = BuiltInPanel(component_name, sidebar_title, sidebar_icon,
|
|
frontend_url_path, config)
|
|
yield from panel.async_register(hass)
|
|
|
|
|
|
@bind_hass
|
|
@asyncio.coroutine
|
|
def async_register_panel(hass, component_name, path, md5=None,
|
|
sidebar_title=None, sidebar_icon=None,
|
|
frontend_url_path=None, config=None):
|
|
"""Register a panel for the frontend.
|
|
|
|
component_name: name of the web component
|
|
path: path to the HTML of the web component
|
|
(required unless url is provided)
|
|
md5: the md5 hash of the web component (for versioning in url, optional)
|
|
sidebar_title: title to show in the sidebar (optional)
|
|
sidebar_icon: icon to show next to title in sidebar (optional)
|
|
url_path: name to use in the url (defaults to component_name)
|
|
config: config to be passed into the web component
|
|
"""
|
|
panel = ExternalPanel(component_name, path, md5, sidebar_title,
|
|
sidebar_icon, frontend_url_path, config)
|
|
yield from panel.async_register(hass)
|
|
|
|
|
|
@bind_hass
|
|
@callback
|
|
def add_extra_html_url(hass, url):
|
|
"""Register extra html url to load."""
|
|
url_set = hass.data.get(DATA_EXTRA_HTML_URL)
|
|
if url_set is None:
|
|
url_set = hass.data[DATA_EXTRA_HTML_URL] = set()
|
|
url_set.add(url)
|
|
|
|
|
|
def add_manifest_json_key(key, val):
|
|
"""Add a keyval to the manifest.json."""
|
|
MANIFEST_JSON[key] = val
|
|
|
|
|
|
@asyncio.coroutine
|
|
def async_setup(hass, config):
|
|
"""Set up the serving of the frontend."""
|
|
hass.http.register_view(ManifestJSONView)
|
|
|
|
conf = config.get(DOMAIN, {})
|
|
|
|
repo_path = conf.get(CONF_FRONTEND_REPO)
|
|
is_dev = repo_path is not None
|
|
|
|
if is_dev:
|
|
hass.http.register_static_path("/home-assistant-polymer", repo_path)
|
|
hass.http.register_static_path(
|
|
"/static/translations",
|
|
os.path.join(repo_path, "build/translations"))
|
|
sw_path = os.path.join(repo_path, "build/service_worker.js")
|
|
static_path = os.path.join(repo_path, 'hass_frontend')
|
|
else:
|
|
import hass_frontend
|
|
frontend_path = hass_frontend.where()
|
|
sw_path = os.path.join(frontend_path, "service_worker.js")
|
|
static_path = frontend_path
|
|
|
|
hass.http.register_static_path("/service_worker.js", sw_path, False)
|
|
hass.http.register_static_path("/robots.txt",
|
|
os.path.join(static_path, "robots.txt"))
|
|
hass.http.register_static_path("/static", static_path)
|
|
|
|
local = hass.config.path('www')
|
|
if os.path.isdir(local):
|
|
hass.http.register_static_path("/local", local)
|
|
|
|
index_view = IndexView(is_dev)
|
|
hass.http.register_view(index_view)
|
|
|
|
@asyncio.coroutine
|
|
def finalize_panel(panel):
|
|
"""Finalize setup of a panel."""
|
|
yield from panel.async_finalize(hass, repo_path)
|
|
panel.async_register_index_routes(hass.http.app.router, index_view)
|
|
|
|
yield from asyncio.wait([
|
|
async_register_built_in_panel(hass, panel)
|
|
for panel in ('dev-event', 'dev-info', 'dev-service', 'dev-state',
|
|
'dev-template', 'dev-mqtt', 'kiosk')], loop=hass.loop)
|
|
|
|
hass.data[DATA_FINALIZE_PANEL] = finalize_panel
|
|
|
|
# Finalize registration of panels that registered before frontend was setup
|
|
# This includes the built-in panels from line above.
|
|
yield from asyncio.wait(
|
|
[finalize_panel(panel) for panel in hass.data[DATA_PANELS].values()],
|
|
loop=hass.loop)
|
|
|
|
if DATA_EXTRA_HTML_URL not in hass.data:
|
|
hass.data[DATA_EXTRA_HTML_URL] = set()
|
|
|
|
for url in conf.get(CONF_EXTRA_HTML_URL, []):
|
|
add_extra_html_url(hass, url)
|
|
|
|
yield from async_setup_themes(hass, conf.get(CONF_THEMES))
|
|
|
|
return True
|
|
|
|
|
|
@asyncio.coroutine
|
|
def async_setup_themes(hass, themes):
|
|
"""Set up themes data and services."""
|
|
hass.http.register_view(ThemesView)
|
|
hass.data[DATA_DEFAULT_THEME] = DEFAULT_THEME
|
|
if themes is None:
|
|
hass.data[DATA_THEMES] = {}
|
|
return
|
|
|
|
hass.data[DATA_THEMES] = themes
|
|
|
|
@callback
|
|
def update_theme_and_fire_event():
|
|
"""Update theme_color in manifest."""
|
|
name = hass.data[DATA_DEFAULT_THEME]
|
|
themes = hass.data[DATA_THEMES]
|
|
if name != DEFAULT_THEME and PRIMARY_COLOR in themes[name]:
|
|
MANIFEST_JSON['theme_color'] = themes[name][PRIMARY_COLOR]
|
|
else:
|
|
MANIFEST_JSON['theme_color'] = DEFAULT_THEME_COLOR
|
|
hass.bus.async_fire(EVENT_THEMES_UPDATED, {
|
|
'themes': themes,
|
|
'default_theme': name,
|
|
})
|
|
|
|
@callback
|
|
def set_theme(call):
|
|
"""Set backend-prefered theme."""
|
|
data = call.data
|
|
name = data[CONF_NAME]
|
|
if name == DEFAULT_THEME or name in hass.data[DATA_THEMES]:
|
|
_LOGGER.info("Theme %s set as default", name)
|
|
hass.data[DATA_DEFAULT_THEME] = name
|
|
update_theme_and_fire_event()
|
|
else:
|
|
_LOGGER.warning("Theme %s is not defined.", name)
|
|
|
|
@callback
|
|
def reload_themes(_):
|
|
"""Reload themes."""
|
|
path = find_config_file(hass.config.config_dir)
|
|
new_themes = load_yaml_config_file(path)[DOMAIN].get(CONF_THEMES, {})
|
|
hass.data[DATA_THEMES] = new_themes
|
|
if hass.data[DATA_DEFAULT_THEME] not in new_themes:
|
|
hass.data[DATA_DEFAULT_THEME] = DEFAULT_THEME
|
|
update_theme_and_fire_event()
|
|
|
|
descriptions = yield from hass.async_add_job(
|
|
load_yaml_config_file,
|
|
os.path.join(os.path.dirname(__file__), 'services.yaml'))
|
|
|
|
hass.services.async_register(DOMAIN, SERVICE_SET_THEME,
|
|
set_theme,
|
|
descriptions[SERVICE_SET_THEME],
|
|
SERVICE_SET_THEME_SCHEMA)
|
|
hass.services.async_register(DOMAIN, SERVICE_RELOAD_THEMES, reload_themes,
|
|
descriptions[SERVICE_RELOAD_THEMES])
|
|
|
|
|
|
class IndexView(HomeAssistantView):
|
|
"""Serve the frontend."""
|
|
|
|
url = '/'
|
|
name = 'frontend:index'
|
|
requires_auth = False
|
|
extra_urls = ['/states', '/states/{extra}']
|
|
|
|
def __init__(self, use_repo):
|
|
"""Initialize the frontend view."""
|
|
from jinja2 import FileSystemLoader, Environment
|
|
|
|
self.use_repo = use_repo
|
|
self.templates = Environment(
|
|
autoescape=True,
|
|
loader=FileSystemLoader(
|
|
os.path.join(os.path.dirname(__file__), 'templates/')
|
|
)
|
|
)
|
|
|
|
@asyncio.coroutine
|
|
def get(self, request, extra=None):
|
|
"""Serve the index view."""
|
|
hass = request.app['hass']
|
|
|
|
if self.use_repo:
|
|
core_url = '/home-assistant-polymer/build/core.js'
|
|
compatibility_url = \
|
|
'/home-assistant-polymer/build/compatibility.js'
|
|
ui_url = '/home-assistant-polymer/src/home-assistant.html'
|
|
icons_fp = ''
|
|
icons_url = '/static/mdi.html'
|
|
else:
|
|
import hass_frontend
|
|
core_url = '/static/core-{}.js'.format(
|
|
hass_frontend.FINGERPRINTS['core.js'])
|
|
compatibility_url = '/static/compatibility-{}.js'.format(
|
|
hass_frontend.FINGERPRINTS['compatibility.js'])
|
|
ui_url = '/static/frontend-{}.html'.format(
|
|
hass_frontend.FINGERPRINTS['frontend.html'])
|
|
icons_fp = '-{}'.format(hass_frontend.FINGERPRINTS['mdi.html'])
|
|
icons_url = '/static/mdi{}.html'.format(icons_fp)
|
|
|
|
if request.path == '/':
|
|
panel = 'states'
|
|
else:
|
|
panel = request.path.split('/')[1]
|
|
|
|
if panel == 'states':
|
|
panel_url = ''
|
|
else:
|
|
panel_url = hass.data[DATA_PANELS][panel].webcomponent_url
|
|
|
|
no_auth = 'true'
|
|
if hass.config.api.api_password and not is_trusted_ip(request):
|
|
# do not try to auto connect on load
|
|
no_auth = 'false'
|
|
|
|
template = yield from hass.async_add_job(
|
|
self.templates.get_template, 'index.html')
|
|
|
|
# pylint is wrong
|
|
# pylint: disable=no-member
|
|
# This is a jinja2 template, not a HA template so we call 'render'.
|
|
resp = template.render(
|
|
core_url=core_url, ui_url=ui_url,
|
|
compatibility_url=compatibility_url, no_auth=no_auth,
|
|
icons_url=icons_url, icons=icons_fp,
|
|
panel_url=panel_url, panels=hass.data[DATA_PANELS],
|
|
dev_mode=self.use_repo,
|
|
theme_color=MANIFEST_JSON['theme_color'],
|
|
extra_urls=hass.data[DATA_EXTRA_HTML_URL])
|
|
|
|
return web.Response(text=resp, content_type='text/html')
|
|
|
|
|
|
class ManifestJSONView(HomeAssistantView):
|
|
"""View to return a manifest.json."""
|
|
|
|
requires_auth = False
|
|
url = '/manifest.json'
|
|
name = 'manifestjson'
|
|
|
|
@asyncio.coroutine
|
|
def get(self, request): # pylint: disable=no-self-use
|
|
"""Return the manifest.json."""
|
|
msg = json.dumps(MANIFEST_JSON, sort_keys=True).encode('UTF-8')
|
|
return web.Response(body=msg, content_type="application/manifest+json")
|
|
|
|
|
|
class ThemesView(HomeAssistantView):
|
|
"""View to return defined themes."""
|
|
|
|
requires_auth = False
|
|
url = '/api/themes'
|
|
name = 'api:themes'
|
|
|
|
@callback
|
|
def get(self, request):
|
|
"""Return themes."""
|
|
hass = request.app['hass']
|
|
|
|
return self.json({
|
|
'themes': hass.data[DATA_THEMES],
|
|
'default_theme': hass.data[DATA_DEFAULT_THEME],
|
|
})
|
|
|
|
|
|
def _fingerprint(path):
|
|
"""Fingerprint a file."""
|
|
with open(path) as fil:
|
|
return hashlib.md5(fil.read().encode('utf-8')).hexdigest()
|