2021-10-15 03:58:13 +03:00
|
|
|
from app.utils.misc import read_config_bool
|
2021-03-21 04:21:41 +03:00
|
|
|
from flask import current_app
|
|
|
|
import os
|
2021-10-21 05:01:04 +03:00
|
|
|
import re
|
2021-03-21 04:21:41 +03:00
|
|
|
|
|
|
|
|
2020-05-13 02:15:53 +03:00
|
|
|
class Config:
|
|
|
|
def __init__(self, **kwargs):
|
2021-03-21 04:21:41 +03:00
|
|
|
app_config = current_app.config
|
2021-03-28 21:24:57 +03:00
|
|
|
self.url = os.getenv('WHOOGLE_CONFIG_URL', '')
|
2021-04-26 18:37:03 +03:00
|
|
|
self.lang_search = os.getenv('WHOOGLE_CONFIG_SEARCH_LANGUAGE', '')
|
2021-03-28 21:24:57 +03:00
|
|
|
self.lang_interface = os.getenv('WHOOGLE_CONFIG_LANGUAGE', '')
|
2021-04-12 23:40:59 +03:00
|
|
|
self.style = os.getenv(
|
|
|
|
'WHOOGLE_CONFIG_STYLE',
|
|
|
|
open(os.path.join(app_config['STATIC_FOLDER'],
|
|
|
|
'css/variables.css')).read())
|
2021-05-07 18:45:53 +03:00
|
|
|
self.block = os.getenv('WHOOGLE_CONFIG_BLOCK', '')
|
2021-10-21 05:01:04 +03:00
|
|
|
self.block_title = os.getenv('WHOOGLE_CONFIG_BLOCK_TITLE', '')
|
|
|
|
self.block_url = os.getenv('WHOOGLE_CONFIG_BLOCK_URL', '')
|
2021-03-28 21:24:57 +03:00
|
|
|
self.ctry = os.getenv('WHOOGLE_CONFIG_COUNTRY', '')
|
Improve public instance session management (#480)
This introduces a new approach to handling user sessions, which should
allow for users to set more reliable config settings on public instances.
Previously, when a user with cookies disabled would update their config,
this would modify the app's default config file, which would in turn
cause new users to inherit these settings when visiting the app for the
first time and cause users to inherit these settings when their current
session cookie expired (which was after 30 days by default I believe).
There was also some half-baked logic for determining on the backend
whether or not a user had cookies disabled, which lead to some issues
with out of control session file creation by Flask.
Now, when a user visits the site, their initial request is forwarded to
a session/<session id> endpoint, and during that subsequent request
their current session id is matched against the one found in the url. If
the ids match, the user has cookies enabled. If not, their original
request is modified with a 'cookies_disabled' query param that tells
Flask not to bother trying to set up a new session for that user, and
instead just use the app's fallback Fernet key for encryption and the
default config.
Since attempting to create a session for a user with cookies disabled
creates a new session file, there is now also a clean-up routine included
in the new session decorator, which will remove all sessions that don't
include a valid key in the dict. NOTE!!! This means that current user
sessions on public instances will be cleared once this update is merged
in. In the long run that's a good thing though, since this will allow session
mgmt to be a lot more reliable overall for users regardless of their cookie
preference.
Individual user sessions still use a unique Fernet key for encrypting queries,
but users with cookies disabled will use the default app key for encryption
and decryption.
Sessions are also now (semi)permanent and have a lifetime of 1 year.
2021-11-18 05:35:30 +03:00
|
|
|
self.theme = os.getenv('WHOOGLE_CONFIG_THEME', 'system')
|
2021-04-14 17:42:41 +03:00
|
|
|
self.safe = read_config_bool('WHOOGLE_CONFIG_SAFE')
|
2021-06-28 17:26:51 +03:00
|
|
|
self.dark = read_config_bool('WHOOGLE_CONFIG_DARK') # deprecated
|
2021-04-14 17:42:41 +03:00
|
|
|
self.alts = read_config_bool('WHOOGLE_CONFIG_ALTS')
|
|
|
|
self.nojs = read_config_bool('WHOOGLE_CONFIG_NOJS')
|
|
|
|
self.tor = read_config_bool('WHOOGLE_CONFIG_TOR')
|
2021-03-28 21:24:57 +03:00
|
|
|
self.near = os.getenv('WHOOGLE_CONFIG_NEAR', '')
|
2021-04-14 17:42:41 +03:00
|
|
|
self.new_tab = read_config_bool('WHOOGLE_CONFIG_NEW_TAB')
|
2021-04-16 17:16:14 +03:00
|
|
|
self.view_image = read_config_bool('WHOOGLE_CONFIG_VIEW_IMAGE')
|
2021-04-14 17:42:41 +03:00
|
|
|
self.get_only = read_config_bool('WHOOGLE_CONFIG_GET_ONLY')
|
2021-10-26 00:49:09 +03:00
|
|
|
self.accept_language = False
|
2021-04-16 17:16:14 +03:00
|
|
|
|
2020-12-18 00:06:47 +03:00
|
|
|
self.safe_keys = [
|
|
|
|
'lang_search',
|
|
|
|
'lang_interface',
|
|
|
|
'ctry',
|
2021-06-28 17:26:51 +03:00
|
|
|
'dark',
|
|
|
|
'theme'
|
2020-12-18 00:06:47 +03:00
|
|
|
]
|
2020-05-13 02:15:53 +03:00
|
|
|
|
2021-04-12 23:40:59 +03:00
|
|
|
# Skip setting custom config if there isn't one
|
|
|
|
if kwargs:
|
2021-04-26 18:37:03 +03:00
|
|
|
mutable_attrs = self.get_mutable_attrs()
|
|
|
|
for attr in mutable_attrs:
|
|
|
|
if attr in kwargs.keys():
|
2021-04-12 23:40:59 +03:00
|
|
|
setattr(self, attr, kwargs[attr])
|
2021-04-26 18:37:03 +03:00
|
|
|
elif attr not in kwargs.keys() and mutable_attrs[attr] == bool:
|
|
|
|
setattr(self, attr, False)
|
2020-05-13 02:15:53 +03:00
|
|
|
|
|
|
|
def __getitem__(self, name):
|
|
|
|
return getattr(self, name)
|
|
|
|
|
|
|
|
def __setitem__(self, name, value):
|
|
|
|
return setattr(self, name, value)
|
|
|
|
|
|
|
|
def __delitem__(self, name):
|
|
|
|
return delattr(self, name)
|
|
|
|
|
|
|
|
def __contains__(self, name):
|
2020-05-23 23:27:23 +03:00
|
|
|
return hasattr(self, name)
|
2020-11-11 08:40:49 +03:00
|
|
|
|
2021-04-12 23:40:59 +03:00
|
|
|
def get_mutable_attrs(self):
|
2021-04-26 18:37:03 +03:00
|
|
|
return {name: type(attr) for name, attr in self.__dict__.items()
|
2021-04-12 23:40:59 +03:00
|
|
|
if not name.startswith("__")
|
2021-04-14 17:42:41 +03:00
|
|
|
and (type(attr) is bool or type(attr) is str)}
|
2021-04-12 23:40:59 +03:00
|
|
|
|
2020-11-11 08:40:49 +03:00
|
|
|
def is_safe_key(self, key) -> bool:
|
|
|
|
"""Establishes a group of config options that are safe to set
|
|
|
|
in the url.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
key (str) -- the key to check against
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
bool -- True/False depending on if the key is in the "safe"
|
|
|
|
array
|
|
|
|
"""
|
|
|
|
|
2020-12-18 00:06:47 +03:00
|
|
|
return key in self.safe_keys
|
2020-11-11 08:40:49 +03:00
|
|
|
|
2021-05-25 00:03:02 +03:00
|
|
|
def get_localization_lang(self):
|
|
|
|
"""Returns the correct language to use for localization, but falls
|
|
|
|
back to english if not set.
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
str -- the localization language string
|
|
|
|
"""
|
|
|
|
if (self.lang_interface and
|
|
|
|
self.lang_interface in current_app.config['TRANSLATIONS']):
|
|
|
|
return self.lang_interface
|
|
|
|
|
|
|
|
return 'lang_en'
|
|
|
|
|
2020-11-11 08:40:49 +03:00
|
|
|
def from_params(self, params) -> 'Config':
|
|
|
|
"""Modify user config with search parameters. This is primarily
|
|
|
|
used for specifying configuration on a search-by-search basis on
|
|
|
|
public instances.
|
|
|
|
|
|
|
|
Args:
|
|
|
|
params -- the url arguments (can be any deemed safe by is_safe())
|
|
|
|
|
|
|
|
Returns:
|
|
|
|
Config -- a modified config object
|
|
|
|
"""
|
|
|
|
for param_key in params.keys():
|
|
|
|
if not self.is_safe_key(param_key):
|
|
|
|
continue
|
|
|
|
self[param_key] = params.get(param_key)
|
|
|
|
return self
|