2022-08-04 06:40:33 +00:00
|
|
|
|
import os
|
2018-01-11 12:10:27 +00:00
|
|
|
|
import json
|
|
|
|
|
|
2016-09-03 11:05:50 +00:00
|
|
|
|
from django.db import models
|
2018-01-22 03:38:40 +00:00
|
|
|
|
from django.db.utils import ProgrammingError, OperationalError
|
2018-01-11 12:10:27 +00:00
|
|
|
|
from django.utils.translation import ugettext_lazy as _
|
2021-01-26 09:54:12 +00:00
|
|
|
|
from django.conf import settings
|
2022-08-04 06:40:33 +00:00
|
|
|
|
from django.core.files.storage import default_storage
|
|
|
|
|
from django.core.files.base import ContentFile
|
|
|
|
|
from django.core.files.uploadedfile import InMemoryUploadedFile
|
2018-01-11 12:10:27 +00:00
|
|
|
|
|
2021-01-26 09:54:12 +00:00
|
|
|
|
from common.utils import signer, get_logger
|
|
|
|
|
|
|
|
|
|
logger = get_logger(__name__)
|
2018-09-03 03:24:25 +00:00
|
|
|
|
|
2018-01-11 12:10:27 +00:00
|
|
|
|
|
|
|
|
|
class SettingQuerySet(models.QuerySet):
|
|
|
|
|
def __getattr__(self, item):
|
2020-04-29 06:32:51 +00:00
|
|
|
|
queryset = list(self)
|
|
|
|
|
instances = [i for i in queryset if i.name == item]
|
2018-01-11 12:10:27 +00:00
|
|
|
|
if len(instances) == 1:
|
|
|
|
|
return instances[0]
|
|
|
|
|
else:
|
|
|
|
|
return Setting()
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class SettingManager(models.Manager):
|
|
|
|
|
def get_queryset(self):
|
|
|
|
|
return SettingQuerySet(self.model, using=self._db)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class Setting(models.Model):
|
|
|
|
|
name = models.CharField(max_length=128, unique=True, verbose_name=_("Name"))
|
2021-09-09 06:00:50 +00:00
|
|
|
|
value = models.TextField(verbose_name=_("Value"), null=True, blank=True)
|
2022-11-04 06:22:38 +00:00
|
|
|
|
category = models.CharField(max_length=128, default="default", verbose_name=_('Category'))
|
|
|
|
|
encrypted = models.BooleanField(default=False, verbose_name=_('Encrypted'))
|
2018-01-11 12:10:27 +00:00
|
|
|
|
enabled = models.BooleanField(verbose_name=_("Enabled"), default=True)
|
|
|
|
|
comment = models.TextField(verbose_name=_("Comment"))
|
|
|
|
|
|
|
|
|
|
objects = SettingManager()
|
2019-12-05 07:09:25 +00:00
|
|
|
|
cache_key_prefix = '_SETTING_'
|
2018-01-11 12:10:27 +00:00
|
|
|
|
|
|
|
|
|
def __str__(self):
|
|
|
|
|
return self.name
|
|
|
|
|
|
2022-12-09 05:05:34 +00:00
|
|
|
|
def is_name(self, name):
|
|
|
|
|
return self.name == name
|
|
|
|
|
|
2018-01-12 07:43:26 +00:00
|
|
|
|
@property
|
2018-01-20 14:22:09 +00:00
|
|
|
|
def cleaned_value(self):
|
2018-01-12 07:43:26 +00:00
|
|
|
|
try:
|
2018-09-03 03:24:25 +00:00
|
|
|
|
value = self.value
|
|
|
|
|
if self.encrypted:
|
|
|
|
|
value = signer.unsign(value)
|
2018-12-21 07:47:52 +00:00
|
|
|
|
if not value:
|
|
|
|
|
return None
|
2018-09-03 03:24:25 +00:00
|
|
|
|
value = json.loads(value)
|
|
|
|
|
return value
|
2018-01-12 07:43:26 +00:00
|
|
|
|
except json.JSONDecodeError:
|
|
|
|
|
return None
|
|
|
|
|
|
2018-01-20 14:22:09 +00:00
|
|
|
|
@cleaned_value.setter
|
|
|
|
|
def cleaned_value(self, item):
|
|
|
|
|
try:
|
|
|
|
|
v = json.dumps(item)
|
2018-09-03 03:24:25 +00:00
|
|
|
|
if self.encrypted:
|
|
|
|
|
v = signer.sign(v)
|
2018-01-20 14:22:09 +00:00
|
|
|
|
self.value = v
|
|
|
|
|
except json.JSONDecodeError as e:
|
|
|
|
|
raise ValueError("Json dump error: {}".format(str(e)))
|
|
|
|
|
|
2018-01-11 12:10:27 +00:00
|
|
|
|
@classmethod
|
|
|
|
|
def refresh_all_settings(cls):
|
2018-01-22 03:38:40 +00:00
|
|
|
|
try:
|
|
|
|
|
settings_list = cls.objects.all()
|
|
|
|
|
for setting in settings_list:
|
|
|
|
|
setting.refresh_setting()
|
|
|
|
|
except (ProgrammingError, OperationalError):
|
|
|
|
|
pass
|
2018-01-11 12:10:27 +00:00
|
|
|
|
|
2021-01-26 09:54:12 +00:00
|
|
|
|
@classmethod
|
|
|
|
|
def refresh_item(cls, name):
|
|
|
|
|
item = cls.objects.filter(name=name).first()
|
|
|
|
|
if not item:
|
|
|
|
|
return
|
|
|
|
|
item.refresh_setting()
|
|
|
|
|
|
2018-01-11 12:10:27 +00:00
|
|
|
|
def refresh_setting(self):
|
2022-02-28 11:28:58 +00:00
|
|
|
|
setattr(settings, self.name, self.cleaned_value)
|
2021-09-16 10:57:09 +00:00
|
|
|
|
self.refresh_keycloak_to_openid_if_need()
|
2021-01-26 09:54:12 +00:00
|
|
|
|
|
2021-09-16 10:57:09 +00:00
|
|
|
|
def refresh_keycloak_to_openid_if_need(self):
|
|
|
|
|
watch_config_names = [
|
|
|
|
|
'AUTH_OPENID', 'AUTH_OPENID_REALM_NAME', 'AUTH_OPENID_SERVER_URL',
|
|
|
|
|
'AUTH_OPENID_PROVIDER_ENDPOINT', 'AUTH_OPENID_KEYCLOAK'
|
|
|
|
|
]
|
|
|
|
|
if self.name not in watch_config_names:
|
|
|
|
|
# 不在监听的配置中, 不需要刷新
|
|
|
|
|
return
|
|
|
|
|
auth_keycloak = self.__class__.objects.filter(name='AUTH_OPENID_KEYCLOAK').first()
|
|
|
|
|
if not auth_keycloak or not auth_keycloak.cleaned_value:
|
|
|
|
|
# 关闭 Keycloak 方式的配置, 不需要刷新
|
|
|
|
|
return
|
|
|
|
|
|
|
|
|
|
from jumpserver.conf import Config
|
|
|
|
|
config_names = [
|
|
|
|
|
'AUTH_OPENID', 'AUTH_OPENID_REALM_NAME',
|
|
|
|
|
'AUTH_OPENID_SERVER_URL', 'AUTH_OPENID_PROVIDER_ENDPOINT'
|
|
|
|
|
]
|
|
|
|
|
# 获取当前 keycloak 配置
|
|
|
|
|
keycloak_config = {}
|
|
|
|
|
for name in config_names:
|
|
|
|
|
setting = self.__class__.objects.filter(name=name).first()
|
|
|
|
|
if not setting:
|
|
|
|
|
continue
|
|
|
|
|
value = setting.cleaned_value
|
|
|
|
|
keycloak_config[name] = value
|
|
|
|
|
|
|
|
|
|
# 转化 keycloak 配置为 openid 配置
|
|
|
|
|
openid_config = Config.convert_keycloak_to_openid(keycloak_config)
|
|
|
|
|
if not openid_config:
|
|
|
|
|
return
|
|
|
|
|
# 刷新 settings
|
|
|
|
|
for key, value in openid_config.items():
|
|
|
|
|
setattr(settings, key, value)
|
2022-02-21 08:47:14 +00:00
|
|
|
|
self.__class__.update_or_create(key, value, encrypted=False, category=self.category)
|
2021-09-16 10:57:09 +00:00
|
|
|
|
|
2022-08-04 06:40:33 +00:00
|
|
|
|
@classmethod
|
|
|
|
|
def save_to_file(cls, value: InMemoryUploadedFile):
|
|
|
|
|
filename = value.name
|
|
|
|
|
filepath = f'settings/{filename}'
|
|
|
|
|
path = default_storage.save(filepath, ContentFile(value.read()))
|
|
|
|
|
url = default_storage.url(path)
|
|
|
|
|
return url
|
|
|
|
|
|
2021-01-26 09:54:12 +00:00
|
|
|
|
@classmethod
|
|
|
|
|
def update_or_create(cls, name='', value='', encrypted=False, category=''):
|
|
|
|
|
"""
|
|
|
|
|
不能使用 Model 提供的,update_or_create 因为这里有 encrypted 和 cleaned_value
|
|
|
|
|
:return: (changed, instance)
|
|
|
|
|
"""
|
|
|
|
|
setting = cls.objects.filter(name=name).first()
|
|
|
|
|
changed = False
|
|
|
|
|
if not setting:
|
|
|
|
|
setting = Setting(name=name, encrypted=encrypted, category=category)
|
2022-08-04 06:40:33 +00:00
|
|
|
|
|
|
|
|
|
if isinstance(value, InMemoryUploadedFile):
|
|
|
|
|
value = cls.save_to_file(value)
|
|
|
|
|
|
2021-01-26 09:54:12 +00:00
|
|
|
|
if setting.cleaned_value != value:
|
|
|
|
|
setting.encrypted = encrypted
|
|
|
|
|
setting.cleaned_value = value
|
|
|
|
|
setting.save()
|
|
|
|
|
changed = True
|
|
|
|
|
return changed, setting
|
2018-01-12 07:43:26 +00:00
|
|
|
|
|
2018-01-11 12:10:27 +00:00
|
|
|
|
class Meta:
|
2019-03-04 07:38:59 +00:00
|
|
|
|
db_table = "settings_setting"
|
2022-02-17 12:13:31 +00:00
|
|
|
|
verbose_name = _("System setting")
|
2022-03-10 03:25:33 +00:00
|
|
|
|
permissions = [
|
|
|
|
|
('change_email', _('Can change email setting')),
|
|
|
|
|
('change_auth', _('Can change auth setting')),
|
2022-03-14 09:10:34 +00:00
|
|
|
|
('change_systemmsgsubscription', _('Can change system msg sub setting')),
|
2022-03-10 03:25:33 +00:00
|
|
|
|
('change_sms', _('Can change sms setting')),
|
|
|
|
|
('change_security', _('Can change security setting')),
|
|
|
|
|
('change_clean', _('Can change clean setting')),
|
2022-03-10 12:16:13 +00:00
|
|
|
|
('change_interface', _('Can change interface setting')),
|
|
|
|
|
('change_license', _('Can change license setting')),
|
|
|
|
|
('change_terminal', _('Can change terminal setting')),
|
2022-03-10 03:25:33 +00:00
|
|
|
|
('change_other', _('Can change other setting')),
|
|
|
|
|
]
|