Gabriel Hurley c11cd9d1c5 Implements AJAX form posting.
This is somewhat of a hack for Essex, since the long-term solution
is a reworking of the way AJAX is handled. But it solves problems
in the interim and provides a significantly better experience.

Thanks to Andy Chong for pushing forward with the initial attempts
which lead to this patch.

Fixes bug 943518.

Change-Id: Ia65d926d3d406b07301e23b4c87de60c66ddec75
2012-03-21 18:33:50 -07:00

85 lines
3.1 KiB
Python

# vim: tabstop=4 shiftwidth=4 softtabstop=4
# Copyright 2012 Nebula, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import os
from django import http
from django.views import generic
class ModalFormView(generic.TemplateView):
form_class = None
initial = {}
context_form_name = "form"
context_object_name = "object"
def get_template_names(self):
if self.request.is_ajax():
if not hasattr(self, "ajax_template_name"):
# Transform standard template name to ajax name (leading "_")
bits = list(os.path.split(self.template_name))
bits[1] = "".join(("_", bits[1]))
self.ajax_template_name = os.path.join(*bits)
template = self.ajax_template_name
else:
template = self.template_name
return template
def get_object(self, *args, **kwargs):
return None
def get_initial(self):
return self.initial
def get_form_kwargs(self):
kwargs = {'initial': self.get_initial()}
return kwargs
def maybe_handle(self):
if not self.form_class:
raise AttributeError('You must specify a SelfHandlingForm class '
'for the "form_class" attribute on %s.'
% self.__class__.__name__)
if not hasattr(self, "form"):
form = self.form_class
kwargs = self.get_form_kwargs()
self.form, self.handled = form.maybe_handle(self.request, **kwargs)
return self.form, self.handled
def get(self, request, *args, **kwargs):
self.object = self.get_object(*args, **kwargs)
form, handled = self.maybe_handle()
if handled:
if self.request.is_ajax():
# TODO(gabriel): This is not a long-term solution to how
# AJAX should be handled, but it's an expedient solution
# until the blueprint for AJAX handling is architected
# and implemented.
response = http.HttpResponse()
response['X-Horizon-Location'] = handled['location']
return response
return handled
context = self.get_context_data(**kwargs)
context[self.context_form_name] = form
context[self.context_object_name] = self.object
if self.request.is_ajax():
context['hide'] = True
return self.render_to_response(context)
def post(self, request, *args, **kwargs):
""" Placeholder to allow POST; handled the same as GET. """
return self.get(self, request, *args, **kwargs)