def __init__(self, *args, **kwargs):
super(FakeFacilityForm, self).__init__(*args, **kwargs)
from course.utils import get_facilities_config
self.fields["facilities"] = forms.MultipleChoiceField(
choices=(
(name, name)
for name in get_facilities_config()),
widget=forms.CheckboxSelectMultiple,
required=False,
label=_("Facilities"),
help_text=_("Facilities you wish to pretend to be in"))
self.fields["custom_facilities"] = forms.CharField(
label=_("Custom facilities"),
required=False,
help_text=_("More (non-predefined) facility names, separated "
"by commas, which would like to pretend to be in"))
self.fields["add_pretend_facilities_header"] = forms.BooleanField(
required=False,
initial=True,
label=_("Add fake facililities header"),
help_text=_("Add a page header to every page rendered "
"while pretending to be in a facility, as a reminder "
"that this pretending is in progress."))
self.helper.add_input(
# Translators: "set" fake facility.
Submit("set", _("Set")))
self.helper.add_input(
# Translators: "unset" fake facility.
Submit("unset", _("Unset")))
def __init__(self, *args, **kwargs):
super(FakeFacilityForm, self).__init__(*args, **kwargs)
from course.utils import get_facilities_config
self.fields["facilities"] = forms.MultipleChoiceField(
choices=((name, name) for name in get_facilities_config()),
widget=forms.CheckboxSelectMultiple,
required=False,
label=_("Facilities"),
help_text=_("Facilities you wish to pretend to be in"))
self.fields["custom_facilities"] = forms.CharField(
label=_("Custom facilities"),
required=False,
help_text=_("More (non-predefined) facility names, separated "
"by commas, which would like to pretend to be in"))
self.fields["add_pretend_facilities_header"] = forms.BooleanField(
required=False,
initial=True,
label=_("Add fake facililities header"),
help_text=_("Add a page header to every page rendered "
"while pretending to be in a facility, as a reminder "
"that this pretending is in progress."))
self.helper.add_input(
# Translators: "set" fake facility.
Submit("set", _("Set")))
self.helper.add_input(
# Translators: "unset" fake facility.
Submit("unset", _("Unset")))
def __init__(self, *args, **kwargs):
super(FakeFacilityForm, self).__init__(*args, **kwargs)
from course.utils import get_facilities_config
self.fields["facilities"] = forms.MultipleChoiceField(
choices=(
(name, name)
for name in get_facilities_config()),
widget=forms.CheckboxSelectMultiple,
required=False,
label=_("Facilities"),
help_text=_("Facilities you wish to pretend to be in"))
self.fields["custom_facilities"] = forms.CharField(
label=_("Custom facilities"),
required=False,
help_text=_("More (non-predefined) facility names, separated "
"by commas, which would like to pretend to be in"))
self.helper.add_input(
# Translators: "set" fake facility.
Submit("set", _("Set")))
self.helper.add_input(
# Translators: "unset" fake facility.
Submit("unset", _("Unset")))
def is_from_exams_only_facility(request):
from course.utils import get_facilities_config
for name, props in six.iteritems(get_facilities_config(request)):
if not props.get("exams_only", False):
continue
# By now we know that this facility is exams-only
if name in request.relate_facilities:
return True
return False
def is_from_exams_only_facility(request):
from course.utils import get_facilities_config
for name, props in get_facilities_config(request).items():
if not props.get("exams_only", False):
continue
# By now we know that this facility is exams-only
if name in request.relate_facilities:
return True
return False
def validate_facility(vctx, location, facility):
from course.utils import get_facilities_config
facilities = get_facilities_config()
if facilities is None:
return
if facility not in facilities:
vctx.add_warning(
location,
_("Name of facility not recognized: '%(fac_name)s'. " "Known facility names: '%(known_fac_names)s'")
% {"fac_name": facility, "known_fac_names": ", ".join(facilities)},
)
def validate_facility(vctx, location, facility):
# type: (ValidationContext, Text, Text) -> None
from course.utils import get_facilities_config
facilities = get_facilities_config()
if facilities is None:
return
if facility not in facilities:
vctx.add_warning(location, _(
"Name of facility not recognized: '%(fac_name)s'. "
"Known facility names: '%(known_fac_names)s'")
% {
"fac_name": facility,
"known_fac_names": ", ".join(facilities),
})
def check_relate_settings(app_configs, **kwargs):
errors = []
# {{{ check RELATE_BASE_URL
relate_base_url = getattr(settings, RELATE_BASE_URL, None)
if relate_base_url is None:
errors.append(
RelateCriticalCheckMessage(msg=REQUIRED_CONF_ERROR_PATTERN %
{"location": RELATE_BASE_URL},
id="relate_base_url.E001"))
elif not isinstance(relate_base_url, str):
errors.append(
RelateCriticalCheckMessage(msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_BASE_URL,
"types": "str"
}),
id="relate_base_url.E002"))
elif not relate_base_url.strip():
errors.append(
RelateCriticalCheckMessage(
msg="%(location)s should not be an empty string" %
{"location": RELATE_BASE_URL},
id="relate_base_url.E003"))
# }}}
# {{{ check RELATE_EMAIL_APPELATION_PRIORITY_LIST
relate_email_appelation_priority_list = getattr(
settings, RELATE_EMAIL_APPELATION_PRIORITY_LIST, None)
if relate_email_appelation_priority_list is not None:
if not isinstance(relate_email_appelation_priority_list,
(list, tuple)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_EMAIL_APPELATION_PRIORITY_LIST,
"types": "list or tuple"
}),
id="relate_email_appelation_priority_list.E002"))
# }}}
# {{{ check EMAIL_CONNECTIONS
email_connections = getattr(settings, EMAIL_CONNECTIONS, None)
if email_connections is not None:
if not isinstance(email_connections, dict):
errors.append(
RelateCriticalCheckMessage(msg=(INSTANCE_ERROR_PATTERN % {
"location": EMAIL_CONNECTIONS,
"types": "dict"
}),
id="email_connections.E001"))
else:
for label, c in six.iteritems(email_connections):
if not isinstance(c, dict):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location":
"'%s' in '%s'" % (label, EMAIL_CONNECTIONS),
"types":
"dict"
}),
id="email_connections.E002"))
else:
if "backend" in c:
from django.utils.module_loading import import_string
try:
import_string(c["backend"])
except ImportError as e:
errors.append(
RelateCriticalCheckMessage(
msg=(GENERIC_ERROR_PATTERN % {
"location":
"'%s' in %s" %
(label, RELATE_FACILITIES),
"error_type":
type(e).__name__,
"error_str":
str(e)
}),
id="email_connections.E003"))
# }}}
# {{{ check RELATE_FACILITIES
relate_facilities_conf = getattr(settings, RELATE_FACILITIES, None)
if relate_facilities_conf is not None:
from course.utils import get_facilities_config
try:
facilities = get_facilities_config()
except Exception as e:
errors.append(
RelateCriticalCheckMessage(msg=(GENERIC_ERROR_PATTERN % {
"location": RELATE_FACILITIES,
"error_type": type(e).__name__,
"error_str": str(e)
}),
id="relate_facilities.E001"))
else:
if not isinstance(facilities, dict):
errors.append(
RelateCriticalCheckMessage(msg=(
"'%(location)s' must either be or return a dictionary"
% {
"location": RELATE_FACILITIES
}),
id="relate_facilities.E002"))
else:
for facility, conf in six.iteritems(facilities):
if not isinstance(conf, dict):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location":
"Facility `%s` in %s" %
(facility, RELATE_FACILITIES),
"types":
"dict"
}),
id="relate_facilities.E003"))
else:
ip_ranges = conf.get("ip_ranges", [])
if ip_ranges:
if not isinstance(ip_ranges, (list, tuple)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location":
"'ip_ranges' in facility `%s` in %s"
% (facilities, RELATE_FACILITIES),
"types":
"list or tuple"
}),
id="relate_facilities.E004"))
else:
for ip_range in ip_ranges:
try:
get_ip_network(ip_range)
except Exception as e:
errors.append(
RelateCriticalCheckMessage(
msg=(GENERIC_ERROR_PATTERN % {
"location":
"'ip_ranges' in "
"facility `%s` in %s" %
(facility,
RELATE_FACILITIES),
"error_type":
type(e).__name__,
"error_str":
str(e)
}),
id="relate_facilities.E005"))
else:
if not callable(relate_facilities_conf):
errors.append(
Warning(msg=(
"Faclity `%s` in %s is an open facility "
"as it has no configured `ip_ranges`" %
(facility, RELATE_FACILITIES)),
id="relate_facilities.W001"))
# }}}
# {{{ check RELATE_MAINTENANCE_MODE_EXCEPTIONS
relate_maintenance_mode_exceptions = getattr(
settings, RELATE_MAINTENANCE_MODE_EXCEPTIONS, None)
if relate_maintenance_mode_exceptions is not None:
if not isinstance(relate_maintenance_mode_exceptions, (list, tuple)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_MAINTENANCE_MODE_EXCEPTIONS,
"types": "list or tuple"
}),
id="relate_maintenance_mode_exceptions.E001"))
else:
for ip in relate_maintenance_mode_exceptions:
try:
get_ip_network(ip)
except Exception as e:
errors.append(
RelateCriticalCheckMessage(
msg=(GENERIC_ERROR_PATTERN % {
"location":
"ip/ip_ranges '%s' in %s" %
(ip, RELATE_FACILITIES),
"error_type":
type(e).__name__,
"error_str":
str(e)
}),
id="relate_maintenance_mode_exceptions.E002"))
# }}}
# {{{ check RELATE_SESSION_RESTART_COOLDOWN_SECONDS
relate_session_restart_cooldown_seconds = getattr(
settings, RELATE_SESSION_RESTART_COOLDOWN_SECONDS, None)
if relate_session_restart_cooldown_seconds is not None:
if not isinstance(relate_session_restart_cooldown_seconds,
(int, float)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_SESSION_RESTART_COOLDOWN_SECONDS,
"types": "int or float"
}),
id="relate_session_restart_cooldown_seconds.E001"))
else:
if relate_session_restart_cooldown_seconds < 0:
errors.append(
RelateCriticalCheckMessage(
msg=("%(location)s must be a positive number, "
"got %(value)s instead" % {
"location":
RELATE_SESSION_RESTART_COOLDOWN_SECONDS,
"value":
relate_session_restart_cooldown_seconds
}),
id="relate_session_restart_cooldown_seconds.E002"))
# }}}
# {{{ check RELATE_SESSION_RESTART_COOLDOWN_SECONDS
relate_ticket_minutes_valid_after_use = getattr(
settings, RELATE_TICKET_MINUTES_VALID_AFTER_USE, None)
if relate_ticket_minutes_valid_after_use is not None:
if not isinstance(relate_ticket_minutes_valid_after_use, (int, float)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_TICKET_MINUTES_VALID_AFTER_USE,
"types": "int or float"
}),
id="relate_ticket_minutes_valid_after_use.E001"))
else:
if relate_ticket_minutes_valid_after_use < 0:
errors.append(
RelateCriticalCheckMessage(
msg=("%(location)s must be a positive number, "
"got %(value)s instead" % {
"location":
RELATE_TICKET_MINUTES_VALID_AFTER_USE,
"value": relate_ticket_minutes_valid_after_use
}),
id="relate_ticket_minutes_valid_after_use.E002"))
# }}}
# {{{ check GIT_ROOT
git_root = getattr(settings, GIT_ROOT, None)
if git_root is None:
errors.append(
RelateCriticalCheckMessage(msg=REQUIRED_CONF_ERROR_PATTERN %
{"location": GIT_ROOT},
id="git_root.E001"))
elif not isinstance(git_root, str):
errors.append(
RelateCriticalCheckMessage(msg=INSTANCE_ERROR_PATTERN % {
"location": GIT_ROOT,
"types": "str"
},
id="git_root.E002"))
else:
import os
if not os.path.isdir(git_root):
errors.append(
RelateCriticalCheckMessage(msg=(
"`%(path)s` connfigured in %(location)s is not a valid path"
% {
"path": git_root,
"location": GIT_ROOT
}),
id="git_root.E003"))
else:
if not os.access(git_root, os.W_OK):
errors.append(
RelateCriticalCheckMessage(msg=(
"`%(path)s` connfigured in %(location)s is not writable "
"by RELATE" % {
"path": git_root,
"location": GIT_ROOT
}),
id="git_root.E004"))
if not os.access(git_root, os.R_OK):
errors.append(
RelateCriticalCheckMessage(msg=(
"`%(path)s` connfigured in %(location)s is not readable "
"by RELATE" % {
"path": git_root,
"location": GIT_ROOT
}),
id="git_root.E005"))
# }}}
return errors
def check_relate_settings(app_configs, **kwargs):
errors = []
# {{{ check RELATE_BASE_URL
relate_base_url = getattr(settings, RELATE_BASE_URL, None)
if relate_base_url is None:
errors.append(
RelateCriticalCheckMessage(msg=REQUIRED_CONF_ERROR_PATTERN %
{"location": RELATE_BASE_URL},
id="relate_base_url.E001"))
elif not isinstance(relate_base_url, str):
errors.append(
RelateCriticalCheckMessage(msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_BASE_URL,
"types": "str"
}),
id="relate_base_url.E002"))
elif not relate_base_url.strip():
errors.append(
RelateCriticalCheckMessage(
msg="%(location)s should not be an empty string" %
{"location": RELATE_BASE_URL},
id="relate_base_url.E003"))
# }}}
from accounts.utils import relate_user_method_settings
# check RELATE_EMAIL_APPELLATION_PRIORITY_LIST
errors.extend(
relate_user_method_settings.check_email_appellation_priority_list())
# check RELATE_CSV_SETTINGS
errors.extend(relate_user_method_settings.check_custom_full_name_method())
# check RELATE_USER_PROFILE_MASK_METHOD
errors.extend(relate_user_method_settings.check_user_profile_mask_method())
# {{{ check EMAIL_CONNECTIONS
email_connections = getattr(settings, EMAIL_CONNECTIONS, None)
if email_connections is not None:
if not isinstance(email_connections, dict):
errors.append(
RelateCriticalCheckMessage(msg=(INSTANCE_ERROR_PATTERN % {
"location": EMAIL_CONNECTIONS,
"types": "dict"
}),
id="email_connections.E001"))
else:
for label, c in six.iteritems(email_connections):
if not isinstance(c, dict):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location":
"'%s' in '%s'" % (label, EMAIL_CONNECTIONS),
"types":
"dict"
}),
id="email_connections.E002"))
else:
if "backend" in c:
try:
import_string(c["backend"])
except ImportError as e:
errors.append(
RelateCriticalCheckMessage(
msg=(GENERIC_ERROR_PATTERN % {
"location":
"'%s' in %s" %
(label, RELATE_FACILITIES),
"error_type":
type(e).__name__,
"error_str":
str(e)
}),
id="email_connections.E003"))
# }}}
# {{{ check RELATE_FACILITIES
relate_facilities_conf = getattr(settings, RELATE_FACILITIES, None)
if relate_facilities_conf is not None:
from course.utils import get_facilities_config
try:
facilities = get_facilities_config()
except Exception as e:
errors.append(
RelateCriticalCheckMessage(msg=(GENERIC_ERROR_PATTERN % {
"location": RELATE_FACILITIES,
"error_type": type(e).__name__,
"error_str": str(e)
}),
id="relate_facilities.E001"))
else:
if not isinstance(facilities, dict):
errors.append(
RelateCriticalCheckMessage(msg=(
"'%(location)s' must either be or return a dictionary"
% {
"location": RELATE_FACILITIES
}),
id="relate_facilities.E002"))
else:
for facility, conf in six.iteritems(facilities):
if not isinstance(conf, dict):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location":
"Facility `%s` in %s" %
(facility, RELATE_FACILITIES),
"types":
"dict"
}),
id="relate_facilities.E003"))
else:
ip_ranges = conf.get("ip_ranges", [])
if ip_ranges:
if not isinstance(ip_ranges, (list, tuple)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location":
"'ip_ranges' in facility `%s` in %s"
% (facilities, RELATE_FACILITIES),
"types":
"list or tuple"
}),
id="relate_facilities.E004"))
else:
for ip_range in ip_ranges:
try:
get_ip_network(ip_range)
except Exception as e:
errors.append(
RelateCriticalCheckMessage(
msg=(GENERIC_ERROR_PATTERN % {
"location":
"'ip_ranges' in "
"facility `%s` in %s" %
(facility,
RELATE_FACILITIES),
"error_type":
type(e).__name__,
"error_str":
str(e)
}),
id="relate_facilities.E005"))
else:
if not callable(relate_facilities_conf):
errors.append(
Warning(msg=(
"Faclity `%s` in %s is an open facility "
"as it has no configured `ip_ranges`" %
(facility, RELATE_FACILITIES)),
id="relate_facilities.W001"))
# }}}
# {{{ check RELATE_MAINTENANCE_MODE_EXCEPTIONS
relate_maintenance_mode_exceptions = getattr(
settings, RELATE_MAINTENANCE_MODE_EXCEPTIONS, None)
if relate_maintenance_mode_exceptions is not None:
if not isinstance(relate_maintenance_mode_exceptions, (list, tuple)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_MAINTENANCE_MODE_EXCEPTIONS,
"types": "list or tuple"
}),
id="relate_maintenance_mode_exceptions.E001"))
else:
for ip in relate_maintenance_mode_exceptions:
try:
get_ip_network(ip)
except Exception as e:
errors.append(
RelateCriticalCheckMessage(
msg=(GENERIC_ERROR_PATTERN % {
"location":
"ip/ip_ranges '%s' in %s" %
(ip, RELATE_FACILITIES),
"error_type":
type(e).__name__,
"error_str":
str(e)
}),
id="relate_maintenance_mode_exceptions.E002"))
# }}}
# {{{ check RELATE_SESSION_RESTART_COOLDOWN_SECONDS
relate_session_restart_cooldown_seconds = getattr(
settings, RELATE_SESSION_RESTART_COOLDOWN_SECONDS, None)
if relate_session_restart_cooldown_seconds is not None:
if not isinstance(relate_session_restart_cooldown_seconds,
(int, float)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_SESSION_RESTART_COOLDOWN_SECONDS,
"types": "int or float"
}),
id="relate_session_restart_cooldown_seconds.E001"))
else:
if relate_session_restart_cooldown_seconds < 0:
errors.append(
RelateCriticalCheckMessage(
msg=("%(location)s must be a positive number, "
"got %(value)s instead" % {
"location":
RELATE_SESSION_RESTART_COOLDOWN_SECONDS,
"value":
relate_session_restart_cooldown_seconds
}),
id="relate_session_restart_cooldown_seconds.E002"))
# }}}
# {{{ check RELATE_TICKET_MINUTES_VALID_AFTER_USE
relate_ticket_minutes_valid_after_use = getattr(
settings, RELATE_TICKET_MINUTES_VALID_AFTER_USE, None)
if relate_ticket_minutes_valid_after_use is not None:
if not isinstance(relate_ticket_minutes_valid_after_use, (int, float)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_TICKET_MINUTES_VALID_AFTER_USE,
"types": "int or float"
}),
id="relate_ticket_minutes_valid_after_use.E001"))
else:
if relate_ticket_minutes_valid_after_use < 0:
errors.append(
RelateCriticalCheckMessage(
msg=("%(location)s must be a positive number, "
"got %(value)s instead" % {
"location":
RELATE_TICKET_MINUTES_VALID_AFTER_USE,
"value": relate_ticket_minutes_valid_after_use
}),
id="relate_ticket_minutes_valid_after_use.E002"))
# }}}
# {{{ check GIT_ROOT
git_root = getattr(settings, GIT_ROOT, None)
if git_root is None:
errors.append(
RelateCriticalCheckMessage(msg=REQUIRED_CONF_ERROR_PATTERN %
{"location": GIT_ROOT},
id="git_root.E001"))
elif not isinstance(git_root, str):
errors.append(
RelateCriticalCheckMessage(msg=INSTANCE_ERROR_PATTERN % {
"location": GIT_ROOT,
"types": "str"
},
id="git_root.E002"))
else:
if not os.path.isdir(git_root):
errors.append(
RelateCriticalCheckMessage(msg=(
"`%(path)s` connfigured in %(location)s is not a valid path"
% {
"path": git_root,
"location": GIT_ROOT
}),
id="git_root.E003"))
else:
if not os.access(git_root, os.W_OK):
errors.append(
RelateCriticalCheckMessage(msg=(
"`%(path)s` connfigured in %(location)s is not writable "
"by RELATE" % {
"path": git_root,
"location": GIT_ROOT
}),
id="git_root.E004"))
if not os.access(git_root, os.R_OK):
errors.append(
RelateCriticalCheckMessage(msg=(
"`%(path)s` connfigured in %(location)s is not readable "
"by RELATE" % {
"path": git_root,
"location": GIT_ROOT
}),
id="git_root.E005"))
# }}}
# {{{ check RELATE_DISABLE_CODEHILITE_MARKDOWN_EXTENSION
relate_disable_codehilite_markdown_extension = getattr(
settings, RELATE_DISABLE_CODEHILITE_MARKDOWN_EXTENSION, None)
if relate_disable_codehilite_markdown_extension is not None:
if not isinstance(relate_disable_codehilite_markdown_extension, bool):
errors.append(
Warning(
msg="%(location)s is not a Boolean value: `%(value)s`, "
"assuming True" % {
"location":
RELATE_DISABLE_CODEHILITE_MARKDOWN_EXTENSION,
"value":
repr(relate_disable_codehilite_markdown_extension)
},
id="relate_disable_codehilite_markdown_extension.W001"))
elif not relate_disable_codehilite_markdown_extension:
errors.append(
Warning(
msg="%(location)s is set to False "
"(with 'markdown.extensions.codehilite' enabled'), "
"noticing that some pages with code fence markdown "
"might get crashed" % {
"location":
RELATE_DISABLE_CODEHILITE_MARKDOWN_EXTENSION,
"value":
repr(relate_disable_codehilite_markdown_extension)
},
id="relate_disable_codehilite_markdown_extension.W002"))
# }}}
# {{{ check LANGUAGES, why this is not done in django?
languages = settings.LANGUAGES
from django.utils.itercompat import is_iterable
if (isinstance(languages, six.string_types) or not is_iterable(languages)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": LANGUAGES,
"types": "an iterable (e.g., a list or tuple)."
}),
id="relate_languages.E001"))
else:
if any(
isinstance(choice, six.string_types) or not is_iterable(choice)
or len(choice) != 2 for choice in languages):
errors.append(
RelateCriticalCheckMessage(
msg=("'%s' must be an iterable containing "
"(language code, language description) tuples, just "
"like the format of LANGUAGES setting ("
"https://docs.djangoproject.com/en/dev/ref/settings/"
"#languages)" % LANGUAGES),
id="relate_languages.E002"))
else:
from collections import OrderedDict
options_dict = OrderedDict(tuple(settings.LANGUAGES))
all_lang_codes = [
lang_code
for lang_code, lang_descr in tuple(settings.LANGUAGES)
]
for lang_code in options_dict.keys():
if all_lang_codes.count(lang_code) > 1:
errors.append(
Warning(msg=(
"Duplicate language entries were found in "
"settings.LANGUAGES for '%s', '%s' will be used "
"as its language_description" %
(lang_code, options_dict[lang_code])),
id="relate_languages.W001"))
# }}}
# {{{ check RELATE_SITE_NAME
try:
site_name = settings.RELATE_SITE_NAME
if site_name is None:
errors.append(
RelateCriticalCheckMessage(msg=("%s must not be None" %
RELATE_SITE_NAME),
id="relate_site_name.E002"))
else:
if not isinstance(site_name, six.string_types):
errors.append(
RelateCriticalCheckMessage(msg=(INSTANCE_ERROR_PATTERN % {
"location":
"%s/%s" %
(RELATE_SITE_NAME, RELATE_CUTOMIZED_SITE_NAME),
"types":
"string"
}),
id="relate_site_name.E003"))
elif not site_name.strip():
errors.append(
RelateCriticalCheckMessage(
msg=("%s must not be an empty string" %
RELATE_SITE_NAME),
id="relate_site_name.E004"))
except AttributeError:
# This happens when RELATE_SITE_NAME is DELETED from settings.
errors.append(
RelateCriticalCheckMessage(msg=(REQUIRED_CONF_ERROR_PATTERN % {
"location": RELATE_SITE_NAME
}),
id="relate_site_name.E001"))
# }}}
# {{{ check RELATE_OVERRIDE_TEMPLATES_DIRS
relate_override_templates_dirs = getattr(settings,
RELATE_OVERRIDE_TEMPLATES_DIRS,
None)
if relate_override_templates_dirs is not None:
if (isinstance(relate_override_templates_dirs, six.string_types)
or not is_iterable(relate_override_templates_dirs)):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_OVERRIDE_TEMPLATES_DIRS,
"types": "an iterable (e.g., a list or tuple)."
}),
id="relate_override_templates_dirs.E001"))
else:
if any(not isinstance(directory, six.string_types)
for directory in relate_override_templates_dirs):
errors.append(
RelateCriticalCheckMessage(
msg=("'%s' must contain only string of paths." %
RELATE_OVERRIDE_TEMPLATES_DIRS),
id="relate_override_templates_dirs.E002"))
else:
for directory in relate_override_templates_dirs:
if not os.path.isdir(directory):
errors.append(
Warning(msg=(
"Invalid Templates Dirs item '%s' in '%s', "
"it will be ignored." %
(directory, RELATE_OVERRIDE_TEMPLATES_DIRS)),
id="relate_override_templates_dirs.W001"))
# }}}
# {{{ check RELATE_CUSTOM_PAGE_TYPES_REMOVED_DEADLINE
relate_custom_page_types_removed_deadline = getattr(
settings, RELATE_CUSTOM_PAGE_TYPES_REMOVED_DEADLINE, None)
if relate_custom_page_types_removed_deadline is not None:
from datetime import datetime
if not isinstance(relate_custom_page_types_removed_deadline, datetime):
errors.append(
RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN % {
"location": RELATE_CUSTOM_PAGE_TYPES_REMOVED_DEADLINE,
"types": "datetime.datetime"
}),
id="relate_custom_page_types_removed_deadline.E001"))
# }}}
return errors
def check_relate_settings(app_configs, **kwargs):
errors = []
# {{{ check RELATE_BASE_URL
relate_base_url = getattr(settings, RELATE_BASE_URL, None)
if relate_base_url is None:
errors.append(RelateCriticalCheckMessage(
msg=REQUIRED_CONF_ERROR_PATTERN % {"location": RELATE_BASE_URL},
id="relate_base_url.E001"
))
elif not isinstance(relate_base_url, str):
errors.append(RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN
% {"location": RELATE_BASE_URL, "types": "str"}),
id="relate_base_url.E002"
))
elif not relate_base_url.strip():
errors.append(RelateCriticalCheckMessage(
msg="%(location)s should not be an empty string"
% {"location": RELATE_BASE_URL},
id="relate_base_url.E003"
))
# }}}
from accounts.utils import relate_user_method_settings
# check RELATE_EMAIL_APPELLATION_PRIORITY_LIST
errors.extend(
relate_user_method_settings.check_email_appellation_priority_list())
# check RELATE_CSV_SETTINGS
errors.extend(relate_user_method_settings.check_custom_full_name_method())
# check RELATE_USER_PROFILE_MASK_METHOD
errors.extend(relate_user_method_settings.check_user_profile_mask_method())
# {{{ check EMAIL_CONNECTIONS
email_connections = getattr(settings, EMAIL_CONNECTIONS, None)
if email_connections is not None:
if not isinstance(email_connections, dict):
errors.append(RelateCriticalCheckMessage(
msg=(
INSTANCE_ERROR_PATTERN
% {"location": EMAIL_CONNECTIONS,
"types": "dict"}),
id="email_connections.E001"
))
else:
for label, c in six.iteritems(email_connections):
if not isinstance(c, dict):
errors.append(RelateCriticalCheckMessage(
msg=(
INSTANCE_ERROR_PATTERN
% {"location": "'%s' in '%s'"
% (label, EMAIL_CONNECTIONS),
"types": "dict"}),
id="email_connections.E002"
))
else:
if "backend" in c:
try:
import_string(c["backend"])
except ImportError as e:
errors.append(RelateCriticalCheckMessage(
msg=(
GENERIC_ERROR_PATTERN
% {
"location":
"'%s' in %s"
% (label, RELATE_FACILITIES),
"error_type": type(e).__name__,
"error_str": str(e)
}),
id="email_connections.E003")
)
# }}}
# {{{ check RELATE_FACILITIES
relate_facilities_conf = getattr(settings, RELATE_FACILITIES, None)
if relate_facilities_conf is not None:
from course.utils import get_facilities_config
try:
facilities = get_facilities_config()
except Exception as e:
errors.append(RelateCriticalCheckMessage(
msg=(
GENERIC_ERROR_PATTERN
% {
"location": RELATE_FACILITIES,
"error_type": type(e).__name__,
"error_str": str(e)
}),
id="relate_facilities.E001")
)
else:
if not isinstance(facilities, dict):
errors.append(RelateCriticalCheckMessage(
msg=(
"'%(location)s' must either be or return a dictionary"
% {"location": RELATE_FACILITIES}),
id="relate_facilities.E002")
)
else:
for facility, conf in six.iteritems(facilities):
if not isinstance(conf, dict):
errors.append(RelateCriticalCheckMessage(
msg=(
INSTANCE_ERROR_PATTERN
% {"location":
"Facility `%s` in %s"
% (facility, RELATE_FACILITIES),
"types": "dict"}),
id="relate_facilities.E003")
)
else:
ip_ranges = conf.get("ip_ranges", [])
if ip_ranges:
if not isinstance(ip_ranges, (list, tuple)):
errors.append(RelateCriticalCheckMessage(
msg=(
INSTANCE_ERROR_PATTERN
% {"location":
"'ip_ranges' in facility `%s` in %s"
% (facilities, RELATE_FACILITIES),
"types": "list or tuple"}),
id="relate_facilities.E004")
)
else:
for ip_range in ip_ranges:
try:
get_ip_network(ip_range)
except Exception as e:
errors.append(RelateCriticalCheckMessage(
msg=(
GENERIC_ERROR_PATTERN
% {
"location":
"'ip_ranges' in "
"facility `%s` in %s"
% (facility,
RELATE_FACILITIES),
"error_type": type(e).__name__,
"error_str": str(e)
}),
id="relate_facilities.E005")
)
else:
if not callable(relate_facilities_conf):
errors.append(Warning(
msg=(
"Faclity `%s` in %s is an open facility "
"as it has no configured `ip_ranges`"
% (facility, RELATE_FACILITIES)
),
id="relate_facilities.W001"
))
# }}}
# {{{ check RELATE_MAINTENANCE_MODE_EXCEPTIONS
relate_maintenance_mode_exceptions = getattr(
settings, RELATE_MAINTENANCE_MODE_EXCEPTIONS, None)
if relate_maintenance_mode_exceptions is not None:
if not isinstance(relate_maintenance_mode_exceptions, (list, tuple)):
errors.append(RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN
% {"location": RELATE_MAINTENANCE_MODE_EXCEPTIONS,
"types": "list or tuple"}),
id="relate_maintenance_mode_exceptions.E001")
)
else:
for ip in relate_maintenance_mode_exceptions:
try:
get_ip_network(ip)
except Exception as e:
errors.append(RelateCriticalCheckMessage(
msg=(
GENERIC_ERROR_PATTERN
% {"location":
"ip/ip_ranges '%s' in %s"
% (ip, RELATE_FACILITIES),
"error_type": type(e).__name__,
"error_str": str(e)
}),
id="relate_maintenance_mode_exceptions.E002")
)
# }}}
# {{{ check RELATE_SESSION_RESTART_COOLDOWN_SECONDS
relate_session_restart_cooldown_seconds = getattr(
settings, RELATE_SESSION_RESTART_COOLDOWN_SECONDS, None)
if relate_session_restart_cooldown_seconds is not None:
if not isinstance(relate_session_restart_cooldown_seconds, (int, float)):
errors.append(RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN
% {"location": RELATE_SESSION_RESTART_COOLDOWN_SECONDS,
"types": "int or float"}),
id="relate_session_restart_cooldown_seconds.E001")
)
else:
if relate_session_restart_cooldown_seconds < 0:
errors.append(RelateCriticalCheckMessage(
msg=(
"%(location)s must be a positive number, "
"got %(value)s instead"
% {"location": RELATE_SESSION_RESTART_COOLDOWN_SECONDS,
"value": relate_session_restart_cooldown_seconds}),
id="relate_session_restart_cooldown_seconds.E002")
)
# }}}
# {{{ check RELATE_TICKET_MINUTES_VALID_AFTER_USE
relate_ticket_minutes_valid_after_use = getattr(
settings, RELATE_TICKET_MINUTES_VALID_AFTER_USE, None)
if relate_ticket_minutes_valid_after_use is not None:
if not isinstance(relate_ticket_minutes_valid_after_use, (int, float)):
errors.append(RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN
% {"location": RELATE_TICKET_MINUTES_VALID_AFTER_USE,
"types": "int or float"}),
id="relate_ticket_minutes_valid_after_use.E001")
)
else:
if relate_ticket_minutes_valid_after_use < 0:
errors.append(RelateCriticalCheckMessage(
msg=(
"%(location)s must be a positive number, "
"got %(value)s instead"
% {"location": RELATE_TICKET_MINUTES_VALID_AFTER_USE,
"value": relate_ticket_minutes_valid_after_use}),
id="relate_ticket_minutes_valid_after_use.E002")
)
# }}}
# {{{ check GIT_ROOT
git_root = getattr(settings, GIT_ROOT, None)
if git_root is None:
errors.append(RelateCriticalCheckMessage(
msg=REQUIRED_CONF_ERROR_PATTERN % {"location": GIT_ROOT},
id="git_root.E001"
))
elif not isinstance(git_root, str):
errors.append(RelateCriticalCheckMessage(
msg=INSTANCE_ERROR_PATTERN % {"location": GIT_ROOT, "types": "str"},
id="git_root.E002"
))
else:
if not os.path.isdir(git_root):
errors.append(RelateCriticalCheckMessage(
msg=("`%(path)s` configured in %(location)s is not a valid path"
% {"path": git_root, "location": GIT_ROOT}),
id="git_root.E003"
))
else:
if not os.access(git_root, os.W_OK):
errors.append(RelateCriticalCheckMessage(
msg=("`%(path)s` configured in %(location)s is not writable "
"by RELATE"
% {"path": git_root, "location": GIT_ROOT}),
id="git_root.E004"
))
if not os.access(git_root, os.R_OK):
errors.append(RelateCriticalCheckMessage(
msg=("`%(path)s` configured in %(location)s is not readable "
"by RELATE"
% {"path": git_root, "location": GIT_ROOT}),
id="git_root.E005"
))
# }}}
# {{{ check RELATE_DISABLE_CODEHILITE_MARKDOWN_EXTENSION
relate_disable_codehilite_markdown_extension = getattr(
settings, RELATE_DISABLE_CODEHILITE_MARKDOWN_EXTENSION, None)
if relate_disable_codehilite_markdown_extension is not None:
if not isinstance(relate_disable_codehilite_markdown_extension, bool):
errors.append(
Warning(
msg="%(location)s is not a Boolean value: `%(value)s`, "
"assuming True"
% {"location":
RELATE_DISABLE_CODEHILITE_MARKDOWN_EXTENSION,
"value":
repr(relate_disable_codehilite_markdown_extension)},
id="relate_disable_codehilite_markdown_extension.W001"))
elif not relate_disable_codehilite_markdown_extension:
errors.append(
Warning(
msg="%(location)s is set to False "
"(with 'markdown.extensions.codehilite' enabled'), "
"noticing that some pages with code fence markdown "
"might get crashed"
% {"location":
RELATE_DISABLE_CODEHILITE_MARKDOWN_EXTENSION,
"value":
repr(relate_disable_codehilite_markdown_extension)},
id="relate_disable_codehilite_markdown_extension.W002"))
# }}}
# {{{ check LANGUAGES, why this is not done in django?
languages = settings.LANGUAGES
from django.utils.itercompat import is_iterable
if (isinstance(languages, six.string_types)
or not is_iterable(languages)):
errors.append(RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN
% {"location": LANGUAGES,
"types": "an iterable (e.g., a list or tuple)."}),
id="relate_languages.E001")
)
else:
if any(isinstance(choice, six.string_types)
or not is_iterable(choice) or len(choice) != 2
for choice in languages):
errors.append(RelateCriticalCheckMessage(
msg=("'%s' must be an iterable containing "
"(language code, language description) tuples, just "
"like the format of LANGUAGES setting ("
"https://docs.djangoproject.com/en/dev/ref/settings/"
"#languages)" % LANGUAGES),
id="relate_languages.E002")
)
else:
from collections import OrderedDict
options_dict = OrderedDict(tuple(settings.LANGUAGES))
all_lang_codes = [lang_code for lang_code, lang_descr
in tuple(settings.LANGUAGES)]
for lang_code in options_dict.keys():
if all_lang_codes.count(lang_code) > 1:
errors.append(Warning(
msg=(
"Duplicate language entries were found in "
"settings.LANGUAGES for '%s', '%s' will be used "
"as its language_description"
% (lang_code, options_dict[lang_code])),
id="relate_languages.W001"
))
# }}}
# {{{ check RELATE_SITE_NAME
try:
site_name = settings.RELATE_SITE_NAME
if site_name is None:
errors.append(
RelateCriticalCheckMessage(
msg=("%s must not be None" % RELATE_SITE_NAME),
id="relate_site_name.E002")
)
else:
if not isinstance(site_name, six.string_types):
errors.append(RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN
% {"location": "%s/%s" % (RELATE_SITE_NAME,
RELATE_CUTOMIZED_SITE_NAME),
"types": "string"}),
id="relate_site_name.E003"))
elif not site_name.strip():
errors.append(RelateCriticalCheckMessage(
msg=("%s must not be an empty string" % RELATE_SITE_NAME),
id="relate_site_name.E004"))
except AttributeError:
# This happens when RELATE_SITE_NAME is DELETED from settings.
errors.append(
RelateCriticalCheckMessage(
msg=(REQUIRED_CONF_ERROR_PATTERN
% {"location": RELATE_SITE_NAME}),
id="relate_site_name.E001")
)
# }}}
# {{{ check RELATE_OVERRIDE_TEMPLATES_DIRS
relate_override_templates_dirs = getattr(settings,
RELATE_OVERRIDE_TEMPLATES_DIRS, None)
if relate_override_templates_dirs is not None:
if (isinstance(relate_override_templates_dirs, six.string_types)
or not is_iterable(relate_override_templates_dirs)):
errors.append(RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN
% {"location": RELATE_OVERRIDE_TEMPLATES_DIRS,
"types": "an iterable (e.g., a list or tuple)."}),
id="relate_override_templates_dirs.E001"))
else:
if any(not isinstance(directory, six.string_types)
for directory in relate_override_templates_dirs):
errors.append(RelateCriticalCheckMessage(
msg=("'%s' must contain only string of paths."
% RELATE_OVERRIDE_TEMPLATES_DIRS),
id="relate_override_templates_dirs.E002"))
else:
for directory in relate_override_templates_dirs:
if not os.path.isdir(directory):
errors.append(
Warning(
msg=(
"Invalid Templates Dirs item '%s' in '%s', "
"it will be ignored."
% (directory, RELATE_OVERRIDE_TEMPLATES_DIRS)),
id="relate_override_templates_dirs.W001"
))
# }}}
# {{{ check RELATE_CUSTOM_PAGE_TYPES_REMOVED_DEADLINE
relate_custom_page_types_removed_deadline = getattr(
settings, RELATE_CUSTOM_PAGE_TYPES_REMOVED_DEADLINE, None)
if relate_custom_page_types_removed_deadline is not None:
from datetime import datetime
if not isinstance(relate_custom_page_types_removed_deadline, datetime):
errors.append(RelateCriticalCheckMessage(
msg=(INSTANCE_ERROR_PATTERN
% {"location": RELATE_CUSTOM_PAGE_TYPES_REMOVED_DEADLINE,
"types": "datetime.datetime"}),
id="relate_custom_page_types_removed_deadline.E001"))
# }}}
return errors
