def get_context_data(self, form, **kwargs):
"""Get context data.
Returns the template context for a step. You can overwrite this method
to add more data for all or some steps. This method returns a
dictionary containing the rendered form step. Available template
context variables are:
* all extra data stored in the storage backend
* `wizard` - a dictionary representation of the wizard instance
Example::
class MyWizard(WizardView):
def get_context_data(self, form, **kwargs):
context = super(MyWizard, self).get_context_data(form=form,
**kwargs)
if self.steps.current == 'my_step_name':
context.update({'another_var': True})
return context
"""
context = super(DynamicWizardView, self).get_context_data(
form=form, **kwargs
)
context.update(self.storage.extra_data)
context['wizard'] = {
'form': form,
'steps': self.steps,
'management_form': ManagementForm(prefix=self.prefix, initial={
'current_step': self.steps.current,
}),
}
return context
def post(self, *args, **kwargs):
"""
This method handles POST requests.
The wizard will render either the current step (if form validation
wasn't successful), the next step (if the current step was stored
successful) or the done view (if no more steps are available)
"""
# Look for a wizard_goto_step element in the posted data which
# contains a valid step name. If one was found, render the requested
# form. (This makes stepping back a lot easier).
wizard_goto_step = self.request.POST.get('wizard_goto_step', None)
if wizard_goto_step and wizard_goto_step in self.get_form_list():
return self.render_goto_step(wizard_goto_step)
# added this step to the default so I could skip steps if I wanted to
wizard_goto_done = self.request.POST.get('wizard_goto_done', None)
if wizard_goto_done is not None:
wizard_goto_done = True
else:
wizard_goto_done = False
# Check if form was refreshed
management_form = ManagementForm(self.request.POST, prefix=self.prefix)
if not management_form.is_valid():
raise SuspiciousOperation(
_('ManagementForm data is missing or has been tampered.'))
form_current_step = management_form.cleaned_data['current_step']
if (form_current_step != self.steps.current
and self.storage.current_step is not None):
# form refreshed, change current step
self.storage.current_step = form_current_step
# get the form for the current step
form = self.get_form(data=self.request.POST, files=self.request.FILES)
# and try to validate
if form.is_valid():
# if the form is valid, store the cleaned data and files.
self.storage.set_step_data(self.steps.current,
self.process_step(form))
self.storage.set_step_files(self.steps.current,
self.process_step_files(form))
# check if the user wants to skip the rest of the steps
if wizard_goto_done:
return self.render_done_to_current(form, self.steps.current,
**kwargs)
# check if the current step is the last step
if self.steps.current == self.steps.last:
# no more steps, render done view
return self.render_done(form, **kwargs)
else:
# proceed to the next step
return self.render_next_step(form)
return self.render(form)
def block_before_fieldsets(self, context, nodes):
context = context.update(dict(self.storage.extra_data))
context['wizard'] = {
'steps': self.steps,
'management_form': ManagementForm(prefix=self.prefix, initial={
'current_step': self.steps.current,
}),
}
nodes.append(loader.render_to_string('xadmin/blocks/model_form.before_fieldsets.wizard.html', context))
def block_before_fieldsets(self, context, nodes):
context = context.update(dict(self.storage.extra_data))
context["wizard"] = {
"steps":
self.steps,
"management_form":
ManagementForm(prefix=self.prefix,
initial={
"current_step": self.steps.current,
}),
}
nodes.append(
loader.render_to_string(
"xadmin/blocks/model_form.before_fieldsets.wizard.html",
context))
def prepare_form(self, __):
# init storage and step helper
self.prefix = normalize_name(self.__class__.__name__)
self.storage = get_storage(
self.storage_name,
self.prefix,
self.request,
getattr(self, "file_storage", None),
)
self.steps = StepsHelper(self)
self.wizard_goto_step = False
if self.request.method == "GET":
self.storage.reset()
self.storage.current_step = self.steps.first
self.admin_view.model_form = self.get_step_form()
else:
# Look for a wizard_goto_step element in the posted data which
# contains a valid step name. If one was found, render the requested
# form. (This makes stepping back a lot easier).
wizard_goto_step = self.request.POST.get("wizard_goto_step", None)
if wizard_goto_step and int(wizard_goto_step) < len(
self.get_form_list()):
obj = self.get_form_list().keys()
if six.PY3:
obj = [s for s in obj]
self.storage.current_step = obj[int(wizard_goto_step)]
self.admin_view.model_form = self.get_step_form()
self.wizard_goto_step = True
return
# Check if form was refreshed
management_form = ManagementForm(self.request.POST,
prefix=self.prefix)
if not management_form.is_valid():
raise ValidationError(
"ManagementForm data is missing or has been tampered.")
form_current_step = management_form.cleaned_data["current_step"]
if (form_current_step != self.steps.current
and self.storage.current_step is not None):
# form refreshed, change current step
self.storage.current_step = form_current_step
# get the form for the current step
self.admin_view.model_form = self.get_step_form()
def post(self, *args, **kwargs):
"""
Check if the current step is still available. It might not be if
conditions have changed.
"""
if self.steps.current not in self.steps.all:
logger.warning(
"Current step '%s' is no longer valid, returning "
"to last valid step in the wizard.", self.steps.current)
return self.render_goto_step(self.steps.all[-1])
# -- Duplicated code from upstream
# Look for a wizard_goto_step element in the posted data which
# contains a valid step name. If one was found, render the requested
# form. (This makes stepping back a lot easier).
wizard_goto_step = self.request.POST.get('wizard_goto_step', None)
if wizard_goto_step and wizard_goto_step in self.get_form_list():
return self.render_goto_step(wizard_goto_step)
# Check if form was refreshed
management_form = ManagementForm(self.request.POST, prefix=self.prefix)
if not management_form.is_valid():
raise ValidationError(
_('ManagementForm data is missing or has been tampered.'),
code='missing_management_form',
)
form_current_step = management_form.cleaned_data['current_step']
if (form_current_step != self.steps.current
and self.storage.current_step is not None):
# form refreshed, change current step
self.storage.current_step = form_current_step
# -- End duplicated code from upstream
# This is different from the first check, as this checks
# if the new step is available. See issue #65.
if self.steps.current not in self.steps.all:
logger.warning(
"Requested step '%s' is no longer valid, returning "
"to last valid step in the wizard.", self.steps.current)
return self.render_goto_step(self.steps.all[-1])
return super(IdempotentSessionWizardView, self).post(*args, **kwargs)
def post(self, *args, **kwargs):
"""Don't redirect if user presses the prev.
step button, save data instead. The rest of this is copied from
WizardView. We want to save data when hitting "back"!
"""
wizard_goto_step = self.request.POST.get("wizard_goto_step", None)
management_form = ManagementForm(self.request.POST, prefix=self.prefix)
if not management_form.is_valid():
raise ValidationError(
_("ManagementForm data is missing or has been tampered with."),
code="missing_management_form",
)
form_current_step = management_form.cleaned_data["current_step"]
if (
form_current_step != self.steps.current
and self.storage.current_step is not None
):
# form refreshed, change current step
self.storage.current_step = form_current_step
# get the form for the current step
form = self.get_form(data=self.request.POST, files=self.request.FILES)
# and try to validate
if form.is_valid():
# if the form is valid, store the cleaned data and files.
self.storage.set_step_data(self.steps.current, self.process_step(form))
self.storage.set_step_files(
self.steps.current, self.process_step_files(form)
)
# check if the current step is the last step
if wizard_goto_step and wizard_goto_step in self.get_form_list():
return self.render_goto_step(wizard_goto_step)
if self.steps.current == self.steps.last:
# no more steps, render done view
return self.render_done(form, **kwargs)
# proceed to the next step
return self.render_next_step(form)
return self.render(form)
def post(self, *args, **kwargs):
# Check if form was refreshed
management_form = ManagementForm(self.request.POST, prefix=self.prefix)
if not management_form.is_valid():
raise ValidationError(
'ManagementForm data is missing or has been tampered.',
code='missing_management_form',
)
form_current_step = management_form.cleaned_data['current_step']
if (form_current_step != self.steps.current
and self.storage.current_step is not None):
# form refreshed, change current step
self.storage.current_step = form_current_step
# get the form for the current step
form = self.get_form(data=self.request.POST, files=self.request.FILES)
# and try to validate
if form.is_valid():
# if the form is valid, store the cleaned data and files.
self.storage.set_step_data(self.steps.current,
self.process_step(form))
self.storage.set_step_files(self.steps.current,
self.process_step_files(form))
# this check was moved from beginning of the method (modification from original)
wizard_goto_step = self.request.POST.get('wizard_goto_step', None)
if wizard_goto_step and wizard_goto_step in self.get_form_list():
return self.render_goto_step(wizard_goto_step)
# check if the current step is the last step
# render done if "skip to end" has been sent (modification from original)
if self.steps.current == self.steps.last or wizard_goto_step == "end":
# no more steps, render done view
return self.render_done(form, **kwargs)
else:
# proceed to the next step
return self.render_next_step(form)
return self.render(form)
def post(self, request, *args, **kwargs):
management_form = ManagementForm(self.request.POST, prefix=self.prefix)
if not management_form.is_valid():
raise SuspiciousOperation(
'ManagementForm data is missing or has been tampered.')
self.storage.current_step = management_form.cleaned_data[
'current_step']
if request.POST.get('wizard_save_for_later'):
self.storage.set_step_data(self.steps.current, request.POST)
self.storage.mark_shared()
url = reverse('save-for-later')
return_url = quote(self.get_step_url(self.steps.current))
return redirect(f'{url}?return_url={return_url}')
elif 'wizard_browse_product' in request.POST:
url = self.get_step_url(constants.STEP_PRODUCT)
node_id = request.POST['wizard_browse_product']
if node_id:
url = f'{url}?node_id={node_id}#{node_id}'
else:
url = f'{url}#hierarchy-browser'
return redirect(url)
return super().post(request=request, *args, **kwargs)
def post(self, *args, **kwargs):
"""
Change the wizard default submit behaviour.
This is a copy of the wizards post method with the following
modifications:
- store the last form that already has been validated
- add wizard_store_and_goto_step handling
- add wizard_validate_and_goto_step handling
"""
# Check if form was refreshed
management_form = ManagementForm(self.request.POST, prefix=self.prefix)
if not management_form.is_valid():
raise ValidationError(
_('ManagementForm data is missing or has been tampered.'),
code='missing_management_form',
)
form_current_step = management_form.cleaned_data['current_step']
from_current_mismatch = (form_current_step != self.steps.current
and self.storage.current_step is not None)
if from_current_mismatch:
# form refreshed, change current step
self.storage.current_step = form_current_step
# get the form for the current step
form = self.get_form(data=self.request.POST, files=self.request.FILES)
# goto while storing but not validating (unsafe!)
wizard_goto_step = self.request.POST.get('wizard_store_and_goto_step')
if wizard_goto_step and wizard_goto_step in self.get_form_list():
self.storage.set_step_data(self.steps.current,
self.process_step(form))
self.storage.set_step_files(self.steps.current,
self.process_step_files(form))
self.max_stored = self.steps.current
return self.render_goto_step(wizard_goto_step)
# and try to validate
if form.is_valid():
# if the form is valid, store the cleaned data and files.
self.storage.set_step_data(self.steps.current,
self.process_step(form))
self.storage.set_step_files(self.steps.current,
self.process_step_files(form))
self.max_stored = self.steps.current
self.max_validated = self.steps.current
wizard_goto_step = self.request.POST.get(
'wizard_validate_and_goto_step')
if wizard_goto_step and wizard_goto_step in self.get_form_list():
return self.render_goto_step(wizard_goto_step)
# check if the current step is the last step
elif self.steps.current == self.steps.last:
# no more steps, render done view
return self.render_done(form, **kwargs)
else:
# proceed to the next step
return self.render_next_step(form)
return self.render(form)
