958e522d40
Currently themes machinery works in such way that if we rely on default theme in our branded theme, we have to include them both into AVAILABLE_THEMES setting, otherwise default theme assets will be unavailable and the branded theme assets compilation will fail. On the other hand, mentioning them both leads to theme picker being shown - which we would like to avoid (per marketing wish). SELECTABLE_THEMES setting was added to allow limiting the user facing themes by configuration. Closes-bug: #1564543 Co-Authored-By: Ivan Kolodyazhny <e0ne@e0ne.info> Change-Id: Ic00a9201d2d352685b1089a37a25987b75d6636d
113 lines
4.0 KiB
Python
113 lines
4.0 KiB
Python
# Copyright 2016 Hewlett Packard Enterprise Software, LLC
|
|
# All Rights Reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
# not use this file except in compliance with the License. You may obtain
|
|
# a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
|
|
import logging
|
|
import os
|
|
|
|
from django.utils.translation import pgettext_lazy
|
|
|
|
|
|
def get_theme_static_dirs(available_themes, collection_dir, root):
|
|
static_dirs = []
|
|
# Collect and expose the themes that have been configured
|
|
for theme in available_themes:
|
|
theme_name, theme_label, theme_path = theme
|
|
theme_url = os.path.join(collection_dir, theme_name)
|
|
theme_path = os.path.join(root, theme_path)
|
|
if os.path.exists(os.path.join(theme_path, 'static')):
|
|
# Only expose the subdirectory 'static' if it exists from a custom
|
|
# theme, allowing other logic to live with a theme that we might
|
|
# not want to expose statically
|
|
theme_path = os.path.join(theme_path, 'static')
|
|
|
|
static_dirs.append(
|
|
(theme_url, theme_path),
|
|
)
|
|
|
|
return static_dirs
|
|
|
|
|
|
def get_available_themes(available_themes, custom_path, default_path,
|
|
default_theme, selectable_themes):
|
|
new_theme_list = []
|
|
# We can only support one path at a time, because of static file
|
|
# collection.
|
|
custom_ndx = -1
|
|
default_ndx = -1
|
|
default_theme_ndx = -1
|
|
for ndx, each_theme in enumerate(available_themes):
|
|
|
|
# Maintain Backward Compatibility for CUSTOM_THEME_PATH
|
|
if custom_path:
|
|
if each_theme[2] == custom_path:
|
|
custom_ndx = ndx
|
|
|
|
# Maintain Backward Compatibility for DEFAULT_THEME_PATH
|
|
if default_path:
|
|
if each_theme[0] == 'default':
|
|
default_ndx = ndx
|
|
each_theme = (
|
|
'default',
|
|
pgettext_lazy('Default style theme', 'Default'),
|
|
default_path
|
|
)
|
|
|
|
# Make sure that DEFAULT_THEME is configured for use
|
|
if each_theme[0] == default_theme:
|
|
default_theme_ndx = ndx
|
|
|
|
new_theme_list.append(each_theme)
|
|
|
|
if custom_ndx != -1:
|
|
# If CUSTOM_THEME_PATH is set, then we should set that as the default
|
|
# theme to make sure that upgrading Horizon doesn't jostle anyone
|
|
default_theme = available_themes[custom_ndx][0]
|
|
logging.warning("Your AVAILABLE_THEMES already contains your "
|
|
"CUSTOM_THEME_PATH, therefore using configuration in "
|
|
"AVAILABLE_THEMES for %s.", custom_path)
|
|
|
|
elif custom_path is not None:
|
|
new_theme_list.append(
|
|
('custom',
|
|
pgettext_lazy('Custom style theme', 'Custom'),
|
|
custom_path)
|
|
)
|
|
default_theme = 'custom'
|
|
|
|
# If 'default' isn't present at all, add it with the default_path
|
|
if default_ndx == -1 and default_path is not None:
|
|
new_theme_list.append(
|
|
('default',
|
|
pgettext_lazy('Default style theme', 'Default'),
|
|
default_path)
|
|
)
|
|
|
|
# If default is not configured, we have to set one,
|
|
# just grab the first theme
|
|
if default_theme_ndx == -1 and custom_ndx == -1:
|
|
default_theme = available_themes[0][0]
|
|
|
|
if selectable_themes is None:
|
|
selectable_themes = new_theme_list
|
|
|
|
if default_theme not in [x[0] for x in selectable_themes]:
|
|
default_theme = selectable_themes[0][0]
|
|
logging.warning("Your DEFAULT_THEME is not configured in your "
|
|
"selectable themes, therefore using %s as your "
|
|
"default theme." % default_theme)
|
|
|
|
return new_theme_list, selectable_themes, default_theme
|