@@ -35,9 +35,10 @@ class ValidationException(Exception):
35class Setting:
35class Setting:
36 """Base class of user settings"""
36 """Base class of user settings"""
38− def __init__(self, default_value, **kwargs):
38+ def __init__(self, default_value, locked=False, **kwargs):
39 super().__init__()
39 super().__init__()
40 self.value = default_value
40 self.value = default_value
41 for key, value in kwargs.items():
42 for key, value in kwargs.items():
42 setattr(self, key, value)
43 setattr(self, key, value)
@@ -115,6 +116,9 @@ class MultipleChoiceSetting(EnumStringSetting):
115 self.value = elements
116 self.value = elements
117 def parse_form(self, data): # pylint: disable=missing-function-docstring
118 def parse_form(self, data): # pylint: disable=missing-function-docstring
118 self.value = []
122 self.value = []
119 for choice in data:
123 for choice in data:
120 if choice in self.choices and choice not in self.value: # pylint: disable=no-member
124 if choice in self.choices and choice not in self.value: # pylint: disable=no-member
@@ -149,6 +153,9 @@ class SetSetting(Setting):
149 self.values.add(element)
153 self.values.add(element)
151 def parse_form(self, data): # pylint: disable=missing-function-docstring
155 def parse_form(self, data): # pylint: disable=missing-function-docstring
152 elements = data.split(',')
159 elements = data.split(',')
153 self.values = set(elements) # pylint: disable=attribute-defined-outside-init
160 self.values = set(elements) # pylint: disable=attribute-defined-outside-init
@@ -233,6 +240,9 @@ class SwitchableSetting(Setting):
233 self.enabled = set(data[ENABLED].split(','))
240 self.enabled = set(data[ENABLED].split(','))
235 def parse_form(self, items): # pylint: disable=missing-function-docstring
242 def parse_form(self, items): # pylint: disable=missing-function-docstring
236 items = self.transform_form_items(items)
246 items = self.transform_form_items(items)
237 self.disabled = set() # pylint: disable=attribute-defined-outside-init
247 self.disabled = set() # pylint: disable=attribute-defined-outside-init
238 self.enabled = set() # pylint: disable=attribute-defined-outside-init
248 self.enabled = set() # pylint: disable=attribute-defined-outside-init
@@ -317,22 +327,28 @@ class Preferences:
318 self.key_value_settings = {
328 self.key_value_settings = {
319 'categories': MultipleChoiceSetting(
329 'categories': MultipleChoiceSetting(
331+ is_locked('categories'),
320− ['general'], choices=categories + ['none']
332+ choices=categories + ['none']
322 'language': SearchLanguageSetting(
334 'language': SearchLanguageSetting(
323 settings['search'].get('default_lang', ''),
335 settings['search'].get('default_lang', ''),
336+ is_locked('language'),
324 choices=list(LANGUAGE_CODES) + ['']
337 choices=list(LANGUAGE_CODES) + ['']
326 'locale': EnumStringSetting(
339 'locale': EnumStringSetting(
327 settings['ui'].get('default_locale', ''),
340 settings['ui'].get('default_locale', ''),
341+ is_locked('locale'),
328 choices=list(settings['locales'].keys()) + ['']
342 choices=list(settings['locales'].keys()) + ['']
330 'autocomplete': EnumStringSetting(
344 'autocomplete': EnumStringSetting(
331 settings['search'].get('autocomplete', ''),
345 settings['search'].get('autocomplete', ''),
346+ is_locked('autocomplete'),
332 choices=list(autocomplete.backends.keys()) + ['']
347 choices=list(autocomplete.backends.keys()) + ['']
334 'image_proxy': MapSetting(
349 'image_proxy': MapSetting(
335 settings['server'].get('image_proxy', False),
350 settings['server'].get('image_proxy', False),
351+ is_locked('image_proxy'),
337 '': settings['server'].get('image_proxy', 0),
353 '': settings['server'].get('image_proxy', 0),
338 '0': False,
354 '0': False,
@@ -343,10 +359,12 @@ class Preferences:
344 'method': EnumStringSetting(
360 'method': EnumStringSetting(
345 settings['server'].get('method', 'POST'),
361 settings['server'].get('method', 'POST'),
362+ is_locked('method'),
346 choices=('GET', 'POST')
363 choices=('GET', 'POST')
348 'safesearch': MapSetting(
365 'safesearch': MapSetting(
349 settings['search'].get('safe_search', 0),
366 settings['search'].get('safe_search', 0),
367+ is_locked('safesearch'),
@@ -355,10 +373,12 @@ class Preferences:
356 'theme': EnumStringSetting(
374 'theme': EnumStringSetting(
357 settings['ui'].get('default_theme', 'oscar'),
375 settings['ui'].get('default_theme', 'oscar'),
358 choices=themes
377 choices=themes
360 'results_on_new_tab': MapSetting(
379 'results_on_new_tab': MapSetting(
361 settings['ui'].get('results_on_new_tab', False),
380 settings['ui'].get('results_on_new_tab', False),
381+ is_locked('results_on_new_tab'),
363 '0': False,
383 '0': False,
364 '1': True,
384 '1': True,
@@ -367,10 +387,13 @@ class Preferences:
369 'doi_resolver': MultipleChoiceSetting(
389 'doi_resolver': MultipleChoiceSetting(
391+ is_locked('doi_resolver'),
370− ['oadoi.org'], choices=DOI_RESOLVERS
392+ choices=DOI_RESOLVERS
372 'oscar-style': EnumStringSetting(
394 'oscar-style': EnumStringSetting(
373 settings['ui'].get('theme_args', {}).get('oscar_style', 'logicodev'),
395 settings['ui'].get('theme_args', {}).get('oscar_style', 'logicodev'),
396+ is_locked('oscar-style'),
374 choices=['', 'logicodev', 'logicodev-dark', 'pointhi']),
397 choices=['', 'logicodev', 'logicodev-dark', 'pointhi']),
@@ -383,6 +406,8 @@ class Preferences:
383 """Return preferences as URL parameters"""
406 """Return preferences as URL parameters"""
384 settings_kv = {}
407 settings_kv = {}
385 for k, v in self.key_value_settings.items():
408 for k, v in self.key_value_settings.items():
386 if isinstance(v, MultipleChoiceSetting):
411 if isinstance(v, MultipleChoiceSetting):
387 settings_kv[k] = ','.join(v.get_value())
412 settings_kv[k] = ','.join(v.get_value())
@@ -410,6 +435,8 @@ class Preferences:
410 """parse preferences from request (``flask.request.form``)"""
435 """parse preferences from request (``flask.request.form``)"""
411 for user_setting_name, user_setting in input_data.items():
436 for user_setting_name, user_setting in input_data.items():
412 if user_setting_name in self.key_value_settings:
437 if user_setting_name in self.key_value_settings:
438+ if self.key_value_settings[user_setting_name].locked:
413 self.key_value_settings[user_setting_name].parse(user_setting)
440 self.key_value_settings[user_setting_name].parse(user_setting)
414 elif user_setting_name == 'disabled_engines':
441 elif user_setting_name == 'disabled_engines':
415 self.engines.parse_cookie((input_data.get('disabled_engines', ''),
442 self.engines.parse_cookie((input_data.get('disabled_engines', ''),
@@ -464,6 +491,8 @@ class Preferences:
464 """Save cookie in the HTTP reponse obect
491 """Save cookie in the HTTP reponse obect
466 for user_setting_name, user_setting in self.key_value_settings.items():
493 for user_setting_name, user_setting in self.key_value_settings.items():
494+ if self.key_value_settings[user_setting_name].locked:
467 user_setting.save(user_setting_name, resp)
496 user_setting.save(user_setting_name, resp)
468 self.engines.save(resp)
497 self.engines.save(resp)
469 self.plugins.save(resp)
498 self.plugins.save(resp)
@@ -482,3 +511,13 @@ class Preferences:
484 return valid
513 return valid
516+def is_locked(setting_name):
517+ """Checks if a given setting name is locked by settings.yml
519+ if 'preferences' not in settings:
521+ if 'lock' not in settings['preferences']:
523+ return setting_name in settings['preferences']['lock']