Add soc.views.simple containing (initially) two simple template views.
templateWithLinkName() is a view that can replace most public() read-only
views. errorResponse() is a view that renders an error page for
out_of_band.ErrorResponse exceptions. Also, change response_helpers.respond()
to accept keyword arguments to pass to http.HttpResponse(). (errorResponse()
makes use of this new respond() feature.)
Patch by: Todd Larsen
Review by: to-be-reviewed
#!/usr/bin/python2.5
#
# Copyright 2008 the Melange authors.
#
# 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.
"""Simple views that depend entirely on the template and context.
simpleWithLinkName: a simple template view for URLs with a linkname
errorResponse: renders an out_of_band.ErrorResponse page
"""
__authors__ = [
'"Todd Larsen" <tlarsen@google.com>',
]
from django import http
from django.template import loader
from soc.logic import out_of_band
from soc.logic.site import id_user
from soc.views.helpers import response_helpers
from soc.views.helpers import template_helpers
def templateWithLinkName(request,
template='soc/base.html', linkname=None,
context=None):
"""A simple template view that expects a linkname extracted from the URL.
Args:
request: the standard Django HTTP request object
template: the template to use for rendering the view (or a search list
of templates)
linkname: a site-unique "linkname" (usually extracted from the URL)
context: the context dict supplied to the template, which is modified
(so supply a copy if such modification is not acceptable)
linkname: the linkname parameter is added to the context
linkname_user: if the linkname exists for a User, that User
is added to the context
Returns:
A subclass of django.http.HttpResponse containing the generated page.
"""
context['linkname'] = linkname
context = response_helpers.getUniversalContext(request, context=context)
try:
context['linkname_user'] = id_user.getUserIfLinkName(linkname)
except out_of_band.ErrorResponse, error:
return errorResponse(request, error, template, context)
return response_helpers.respond(request, template, context)
DEF_ERROR_TMPL = 'soc/error.html'
def errorResponse(request, error, template, context):
"""Displays an error page for an out_of_band.ErrorResponse exception.
Args:
request: the standard Django HTTP request object
error: an out_of_band.ErrorResponse exception
template: the "sibling" template (or a search list of such templates)
from which to construct the error.html template name (or names)
context: the context dict supplied to the template, which is modified
(so supply a copy if such modification is not acceptable)
error_message: the error message string from error.message
error_status: error.response_args['status'], or None if a status code
was not supplied to the ErrorResponse
"""
context = response_helpers.getUniversalContext(request, context=context)
# make a list of possible "sibling" templates, then append a default
error_templates = template_helpers.makeSiblingTemplatesList(template,
'error.html')
error_templates.append(DEF_ERROR_TMPL)
context['error_status'] = error.response_args.get('status')
context['error_message'] = error.message
return response_helpers.respond(request, error_templates, context=context,
response_args=error.response_args)