167 lines
4.6 KiB
Python
167 lines
4.6 KiB
Python
"""
|
|
Django views for interacting with common models
|
|
"""
|
|
|
|
# -*- coding: utf-8 -*-
|
|
from __future__ import unicode_literals
|
|
|
|
import os
|
|
|
|
from django.utils.translation import ugettext_lazy as _
|
|
from django.forms import CheckboxInput, Select
|
|
from django.conf import settings
|
|
from django.core.files.storage import FileSystemStorage
|
|
|
|
from formtools.wizard.views import SessionWizardView
|
|
|
|
from InvenTree.views import AjaxUpdateView
|
|
from InvenTree.helpers import str2bool
|
|
|
|
from . import models
|
|
from . import forms
|
|
|
|
|
|
class SettingEdit(AjaxUpdateView):
|
|
"""
|
|
View for editing an InvenTree key:value settings object,
|
|
(or creating it if the key does not already exist)
|
|
"""
|
|
|
|
model = models.InvenTreeSetting
|
|
ajax_form_title = _('Change Setting')
|
|
form_class = forms.SettingEditForm
|
|
ajax_template_name = "common/edit_setting.html"
|
|
|
|
def get_context_data(self, **kwargs):
|
|
"""
|
|
Add extra context information about the particular setting object.
|
|
"""
|
|
|
|
ctx = super().get_context_data(**kwargs)
|
|
|
|
setting = self.get_object()
|
|
|
|
ctx['key'] = setting.key
|
|
ctx['value'] = setting.value
|
|
ctx['name'] = models.InvenTreeSetting.get_setting_name(setting.key)
|
|
ctx['description'] = models.InvenTreeSetting.get_setting_description(setting.key)
|
|
|
|
return ctx
|
|
|
|
def get_form(self):
|
|
"""
|
|
Override default get_form behaviour
|
|
"""
|
|
|
|
form = super().get_form()
|
|
|
|
setting = self.get_object()
|
|
|
|
choices = setting.choices()
|
|
|
|
if choices is not None:
|
|
form.fields['value'].widget = Select(choices=choices)
|
|
elif setting.is_bool():
|
|
form.fields['value'].widget = CheckboxInput()
|
|
|
|
self.object.value = str2bool(setting.value)
|
|
form.fields['value'].value = str2bool(setting.value)
|
|
|
|
name = models.InvenTreeSetting.get_setting_name(setting.key)
|
|
|
|
if name:
|
|
form.fields['value'].label = name
|
|
|
|
description = models.InvenTreeSetting.get_setting_description(setting.key)
|
|
|
|
if description:
|
|
form.fields['value'].help_text = description
|
|
|
|
return form
|
|
|
|
def validate(self, setting, form):
|
|
"""
|
|
Perform custom validation checks on the form data.
|
|
"""
|
|
|
|
data = form.cleaned_data
|
|
|
|
value = data.get('value', None)
|
|
|
|
if setting.choices():
|
|
"""
|
|
If a set of choices are provided for a given setting,
|
|
the provided value must be one of those choices.
|
|
"""
|
|
|
|
choices = [choice[0] for choice in setting.choices()]
|
|
|
|
if value not in choices:
|
|
form.add_error('value', _('Supplied value is not allowed'))
|
|
|
|
if setting.is_bool():
|
|
"""
|
|
If a setting is defined as a boolean setting,
|
|
the provided value must look somewhat like a boolean value!
|
|
"""
|
|
|
|
if not str2bool(value, test=True) and not str2bool(value, test=False):
|
|
form.add_error('value', _('Supplied value must be a boolean'))
|
|
|
|
|
|
class MultiStepFormView(SessionWizardView):
|
|
""" Setup basic methods of multi-step form
|
|
|
|
form_list: list of forms
|
|
form_steps_description: description for each form
|
|
"""
|
|
|
|
form_list = []
|
|
form_steps_template = []
|
|
form_steps_description = []
|
|
file_manager = None
|
|
media_folder = ''
|
|
file_storage = FileSystemStorage(settings.MEDIA_ROOT)
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
""" Override init method to set media folder """
|
|
super().__init__(*args, **kwargs)
|
|
|
|
self.process_media_folder()
|
|
|
|
def process_media_folder(self):
|
|
""" Process media folder """
|
|
|
|
if self.media_folder:
|
|
media_folder_abs = os.path.join(settings.MEDIA_ROOT, self.media_folder)
|
|
if not os.path.exists(media_folder_abs):
|
|
os.mkdir(media_folder_abs)
|
|
self.file_storage = FileSystemStorage(location=media_folder_abs)
|
|
|
|
def get_template_names(self):
|
|
""" Select template """
|
|
|
|
try:
|
|
# Get template
|
|
template = self.form_steps_template[self.steps.index]
|
|
except IndexError:
|
|
return self.template_name
|
|
|
|
return template
|
|
|
|
def get_context_data(self, **kwargs):
|
|
""" Update context data """
|
|
|
|
# Retrieve current context
|
|
context = super().get_context_data(**kwargs)
|
|
|
|
# Get form description
|
|
try:
|
|
description = self.form_steps_description[self.steps.index]
|
|
except IndexError:
|
|
description = ''
|
|
# Add description to form steps
|
|
context.update({'description': description})
|
|
|
|
return context
|