# HG changeset patch # User Sverre Rabbelier # Date 1227983458 0 # Node ID 2ec30182e5f1555964a74ec1c6aa62d6b13375c5 # Parent e0bd276ffd82e1f995c379984627ff19b2d5d3c6 Move parameter construction into a seperate module This is part of an effort to make base.py less bloated and have it's methods be more cohesive. Patch by: Sverre Rabbelier diff -r e0bd276ffd82 -r 2ec30182e5f1 app/soc/views/helper/params.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/app/soc/views/helper/params.py Sat Nov 29 18:30:58 2008 +0000 @@ -0,0 +1,215 @@ +#!/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. + +"""Params related methods +""" + +__authors__ = [ + '"Sverre Rabbelier" ', + ] + + +from django import forms +from django.utils.translation import ugettext_lazy + +from soc.logic import cleaning +from soc.logic import dicts +from soc.views import helper +from soc.views.helper import access +from soc.views.helper import dynaform +from soc.views.helper import redirects + + +LIST_DESCRIPTION_FMT = ugettext_lazy( + 'List of %(name_plural)s in Google Open Source Programs.') + +DEF_SUBMIT_MSG_PARAM_NAME = 's' +DEF_SUBMIT_MSG_PROFILE_SAVED = 0 + + +def constructParams(params): + """Constructs a new params dictionary based on params + + Params usage: + The params dictionary is passed to getCreateForm and getEditForm, + see their docstring on how they use it. + + rights: The rights value is merged with a default rights + dictionary and then used as rights value. + url_name: The url_name value is used in constructing several + redirects as the first part of the url. + module_name: The module_name value is used in constructing the + location of several templates. It is expected that it matches + the part after "/templates/soc/" for this View. + name_plural: The name_plural argument is provided to the + LIST_DESCRIPTION when constructing the list_description field. + extra_dynainclude: The extra_dynainclude value is used when + constructing the create_dynainclude value. + extra_dynaexclude: The extra_dynaexclude value is used when + constructing the create_dynaexclude value. + logic: The logic value is used as argument to clean_new_link_id + from the cleaning module. + """ + + rights = {} + rights['unspecified'] = [] + rights['any_access'] = [access.checkIsLoggedIn] + rights['public'] = [access.checkIsUser] + rights['create'] = [access.checkIsDeveloper] + rights['edit'] = [access.checkIsDeveloper] + rights['delete'] = [access.checkIsDeveloper] + rights['list'] = [access.checkIsDeveloper] + + if 'rights' in params: + rights = dicts.merge(params['rights'], rights) + + new_params = {} + new_params['rights'] = rights + new_params['create_redirect'] = '/%(url_name)s' % params + new_params['edit_redirect'] = '/%(url_name)s/edit' % params + new_params['missing_redirect'] = '/%(url_name)s/create' % params + new_params['delete_redirect'] = '/%(url_name)s/list' % params + new_params['invite_redirect'] = '/request/list' + + new_params['sidebar'] = None + new_params['sidebar_defaults'] = [ + ('/%s/create', 'New %(name)s', 'create'), + ('/%s/list', 'List %(name_plural)s', 'list'), + ] + new_params['sidebar_additional'] = [] + + new_params['key_fields_prefix'] = [] + + new_params['django_patterns'] = None + new_params['django_patterns_defaults'] = [ + (r'^%(url_name)s/show/%(key_fields)s$', + 'soc.views.models.%s.public', 'Show %(name_short)s'), + (r'^%(url_name)s/create$', + 'soc.views.models.%s.create', 'Create %(name_short)s'), + (r'^%(url_name)s/create/%(key_fields)s$', + 'soc.views.models.%s.create', 'Create %(name_short)s'), + (r'^%(url_name)s/delete/%(key_fields)s$', + 'soc.views.models.%s.delete', 'Delete %(name_short)s'), + (r'^%(url_name)s/edit/%(key_fields)s$', + 'soc.views.models.%s.edit', 'Edit %(name_short)s'), + (r'^%(url_name)s/list$', + 'soc.views.models.%s.list', 'List %(name_plural)s'), + ] + + new_params['public_template'] = 'soc/%(module_name)s/public.html' % params + new_params['create_template'] = 'soc/models/edit.html' + new_params['edit_template'] = 'soc/models/edit.html' + new_params['list_template'] = 'soc/models/list.html' + new_params['invite_template'] = 'soc/models/invite.html' + + new_params['error_public'] = 'soc/%(module_name)s/error.html' % params + new_params['error_edit'] = 'soc/%(module_name)s/error.html' % params + + new_params['list_main'] = 'soc/list/main.html' + new_params['list_pagination'] = 'soc/list/pagination.html' + new_params['list_row'] = 'soc/%(module_name)s/list/row.html' % params + new_params['list_heading'] = 'soc/%(module_name)s/list/heading.html' % params + + new_params['list_action'] = (redirects.getEditRedirect, params) + new_params['list_params'] = { + 'list_action': 'action', + 'list_description': 'description', + 'list_main': 'main', + 'list_pagination': 'pagination', + 'list_row': 'row', + 'list_heading': 'heading', + } + + new_params['list_description'] = LIST_DESCRIPTION_FMT % params + new_params['save_message'] = [ugettext_lazy('Profile saved.')] + new_params['submit_msg_param_name'] = DEF_SUBMIT_MSG_PARAM_NAME + new_params['edit_params'] = { + DEF_SUBMIT_MSG_PARAM_NAME: DEF_SUBMIT_MSG_PROFILE_SAVED, + } + + new_params['dynabase'] = helper.forms.BaseForm + + new_params['create_dynainclude'] = [] + params.get('extra_dynainclude', []) + new_params['create_dynaexclude'] = ['scope', 'scope_path'] + \ + params.get('extra_dynaexclude', []) + new_params['create_dynafields'] = { + 'clean_link_id': cleaning.clean_new_link_id(params['logic']), + 'clean_feed_url': cleaning.clean_feed_url, + } + + dynafields = { + 'clean_link_id': cleaning.clean_link_id, + 'link_id': forms.CharField(widget=helper.widgets.ReadOnlyInput()), + } + dynafields.update(params.get('extra_dynafields', {})) + + new_params['edit_dynainclude'] = None + new_params['edit_dynaexclude'] = None + new_params['edit_dynafields'] = dynafields + + params = dicts.merge(params, new_params) + + # These need to be constructed separately, because they require + # parameters that can be defined either in params, or new_params. + if not 'create_form' in params: + params['create_form'] = getCreateForm(params) + + if not 'edit_form' in params: + params['edit_form'] = getEditForm(params) + + return params + +def getCreateForm(params): + """Constructs a new CreateForm using params + + Params usage: + dynabase: The dynabase value is used as the base argument to + dynaform.newDynaForm. + logic: The logic value is used to get the model argument to newDynaForm. + create_dynainclude: same as dynabase, but as dynainclude argument + create_dynaexclude: same as dynabase, but as dynaexclude argument + create_dynafields: same as dynabase, but as dynafields argument + """ + + create_form = dynaform.newDynaForm( + dynabase = params['dynabase'], + dynamodel = params['logic'].getModel(), + dynainclude = params['create_dynainclude'], + dynaexclude = params['create_dynaexclude'], + dynafields = params['create_dynafields'], + ) + + return create_form + +def getEditForm(params): + """Constructs a new EditForm using params + + Params usage: + create_form: The dynabase value is used as the dynaform argument + to dyanform.extendDynaForm. + edit_dynainclude: same as create_form, but as dynainclude argument + edit_dynaexclude: same as create_form, but as dynaexclude argument + edit_dynafields: same as create_form, but as dynafields argument + """ + + edit_form = dynaform.extendDynaForm( + dynaform = params['create_form'], + dynainclude = params['edit_dynainclude'], + dynaexclude = params['edit_dynaexclude'], + dynafields = params['edit_dynafields'], + ) + + return edit_form diff -r e0bd276ffd82 -r 2ec30182e5f1 app/soc/views/helper/redirects.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/app/soc/views/helper/redirects.py Sat Nov 29 18:30:58 2008 +0000 @@ -0,0 +1,31 @@ +#!/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. + +"""Redirect related methods +""" + +__authors__ = [ + '"Sverre Rabbelier" ', + ] + + +def getEditRedirect(entity, params): + """Returns the edit redirect for the specified entity + """ + + suffix = params['logic'].getKeySuffix(entity) + url_name = params['url_name'] + return '/%s/edit/%s' % (url_name, suffix) diff -r e0bd276ffd82 -r 2ec30182e5f1 app/soc/views/models/base.py --- a/app/soc/views/models/base.py Sat Nov 29 17:20:52 2008 +0000 +++ b/app/soc/views/models/base.py Sat Nov 29 18:30:58 2008 +0000 @@ -25,23 +25,19 @@ from django import http -from django import forms -from django.conf.urls import defaults from django.utils.translation import ugettext_lazy import soc.logic import soc.logic.lists import soc.views.helper.lists import soc.views.helper.responses +import soc.views.helper.params -from soc.logic import cleaning from soc.logic import dicts from soc.logic import models from soc.models import linkable from soc.views import helper from soc.views import out_of_band -from soc.views.helper import access -from soc.views.helper import dynaform class View(object): @@ -53,9 +49,6 @@ self._logic: the logic singleton for this entity """ - DEF_SUBMIT_MSG_PARAM_NAME = 's' - DEF_SUBMIT_MSG_PROFILE_SAVED = 0 - DEF_CREATE_NEW_ENTITY_MSG_FMT = ugettext_lazy( ' You can create a new %(entity_type)s by visiting' ' Create ' @@ -70,123 +63,9 @@ the fields it should contain, and how they are used. """ - rights = {} - rights['unspecified'] = [] - rights['any_access'] = [access.checkIsLoggedIn] - rights['public'] = [access.checkIsUser] - rights['create'] = [access.checkIsDeveloper] - rights['edit'] = [access.checkIsDeveloper] - rights['delete'] = [access.checkIsDeveloper] - rights['list'] = [access.checkIsDeveloper] - - if 'rights' in params: - rights = dicts.merge(params['rights'], rights) - - new_params = {} - new_params['rights'] = rights - new_params['create_redirect'] = '/%(url_name)s' % params - new_params['edit_redirect'] = '/%(url_name)s/edit' % params - new_params['missing_redirect'] = '/%(url_name)s/create' % params - new_params['delete_redirect'] = '/%(url_name)s/list' % params - new_params['invite_redirect'] = '/request/list' - - new_params['sidebar'] = None - new_params['sidebar_defaults'] = [ - ('/%s/create', 'New %(name)s', 'create'), - ('/%s/list', 'List %(name_plural)s', 'list'), - ] - new_params['sidebar_additional'] = [] - - new_params['key_fields_prefix'] = [] - - new_params['django_patterns'] = None - new_params['django_patterns_defaults'] = [ - (r'^%(url_name)s/show/%(key_fields)s$', - 'soc.views.models.%s.public', 'Show %(name_short)s'), - (r'^%(url_name)s/create$', - 'soc.views.models.%s.create', 'Create %(name_short)s'), - (r'^%(url_name)s/create/%(key_fields)s$', - 'soc.views.models.%s.create', 'Create %(name_short)s'), - (r'^%(url_name)s/delete/%(key_fields)s$', - 'soc.views.models.%s.delete', 'Delete %(name_short)s'), - (r'^%(url_name)s/edit/%(key_fields)s$', - 'soc.views.models.%s.edit', 'Edit %(name_short)s'), - (r'^%(url_name)s/list$', - 'soc.views.models.%s.list', 'List %(name_plural)s'), - ] - - new_params['public_template'] = 'soc/%(module_name)s/public.html' % params - new_params['create_template'] = 'soc/models/edit.html' - new_params['edit_template'] = 'soc/models/edit.html' - new_params['list_template'] = 'soc/models/list.html' - new_params['invite_template'] = 'soc/models/invite.html' - - new_params['error_public'] = 'soc/%(module_name)s/error.html' % params - new_params['error_edit'] = 'soc/%(module_name)s/error.html' % params - - new_params['list_main'] = 'soc/list/main.html' - new_params['list_pagination'] = 'soc/list/pagination.html' - new_params['list_row'] = 'soc/%(module_name)s/list/row.html' % params - new_params['list_heading'] = 'soc/%(module_name)s/list/heading.html' % params + self._params = helper.params.constructParams(params) + self._logic = params['logic'] - new_params['list_action'] = (self.getEditRedirect, None) - new_params['list_params'] = { - 'list_action': 'action', - 'list_description': 'description', - 'list_main': 'main', - 'list_pagination': 'pagination', - 'list_row': 'row', - 'list_heading': 'heading', - } - - description = ugettext_lazy('List of %(name_plural)s in Google Open Source Programs.') - new_params['list_description'] = description % params - new_params['save_message'] = [ugettext_lazy('Profile saved.')] - new_params['edit_params'] = { - self.DEF_SUBMIT_MSG_PARAM_NAME: self.DEF_SUBMIT_MSG_PROFILE_SAVED, - } - - new_params['dynabase'] = helper.forms.BaseForm - - new_params['create_dynainclude'] = [] + params.get('extra_dynainclude', []) - new_params['create_dynaexclude'] = ['scope', 'scope_path'] + \ - params.get('extra_dynaexclude', []) - new_params['create_dynafields'] = { - 'clean_link_id': cleaning.clean_new_link_id(params['logic']), - 'clean_feed_url': cleaning.clean_feed_url, - } - - dynafields = { - 'clean_link_id': cleaning.clean_link_id, - 'link_id': forms.CharField(widget=helper.widgets.ReadOnlyInput()), - } - dynafields.update(params.get('extra_dynafields', {})) - - new_params['edit_dynainclude'] = None - new_params['edit_dynaexclude'] = None - new_params['edit_dynafields'] = dynafields - - self._params = dicts.merge(params, new_params) - self._logic = self._params['logic'] - - # These need to be constructed seperately, because they require - # parameters that can be defined either in params, or new_params. - if 'create_form' not in self._params: - self._params['create_form'] = dynaform.newDynaForm( - dynabase = self._params['dynabase'], - dynamodel = self._logic.getModel(), - dynainclude = self._params['create_dynainclude'], - dynaexclude = self._params['create_dynaexclude'], - dynafields = self._params['create_dynafields'], - ) - - if 'edit_form' not in self._params: - self._params['edit_form'] = dynaform.extendDynaForm( - dynaform = self._params['create_form'], - dynainclude = self._params['edit_dynainclude'], - dynaexclude = self._params['edit_dynaexclude'], - dynafields = self._params['edit_dynafields'], - ) def public(self, request, page_name=None, params=None, **kwargs): """Displays the public page for the entity specified by **kwargs. @@ -411,6 +290,9 @@ existing entity. If the seed argument is present, it is passed as the 'initial' argument on construction. Otherwise, it is called with no arguments. + submit_msg_param_name: The submit_msg_param_name value is used + as the key part in the ?key=value construct for the submit + message parameter (see also save_message). Args: request: the django request object @@ -426,14 +308,14 @@ # Remove the params from the request, this is relevant only if # someone bookmarked a POST page. is_self_referrer = helper.requests.isReferrerSelf(request, suffix=suffix) - if request.GET.get(self.DEF_SUBMIT_MSG_PARAM_NAME): + if request.GET.get(params['submit_msg_param_name']): if (not entity) or (not is_self_referrer): return http.HttpResponseRedirect(request.path) if entity: # Note: no message will be displayed if parameter is not present context['notice'] = helper.requests.getSingleIndexedParamValue( - request, self.DEF_SUBMIT_MSG_PARAM_NAME, + request, params['submit_msg_param_name'], values=params['save_message']) # populate form with the existing entity @@ -576,14 +458,6 @@ return http.HttpResponseRedirect(redirect) - def getEditRedirect(self, entity, _): - """Returns the edit redirect for the specified entity - """ - - suffix = self._logic.getKeySuffix(entity) - url_name = self._params['url_name'] - return '/%s/edit/%s' % (url_name, suffix) - def _editPost(self, request, entity, fields): """Performs any required processing on the entity to post its edit page. diff -r e0bd276ffd82 -r 2ec30182e5f1 app/soc/views/models/user_self.py --- a/app/soc/views/models/user_self.py Sat Nov 29 17:20:52 2008 +0000 +++ b/app/soc/views/models/user_self.py Sat Nov 29 18:30:58 2008 +0000 @@ -179,7 +179,7 @@ if user: # is 'Profile saved' parameter present, but referrer was not ourself? # (e.g. someone bookmarked the GET that followed the POST submit) - if (request.GET.get(self.DEF_SUBMIT_MSG_PARAM_NAME) + if (request.GET.get(params['submit_msg_param_name']) and (not helper.requests.isReferrerSelf(request))): # redirect to aggressively remove 'Profile saved' query parameter return http.HttpResponseRedirect(request.path) @@ -188,13 +188,13 @@ # (may display no message if ?s=0 parameter is not present) context['notice'] = ( helper.requests.getSingleIndexedParamValue( - request, self.DEF_SUBMIT_MSG_PARAM_NAME, + request, params['submit_msg_param_name'], values=params['save_message'])) # populate form with the existing User entity form = UserForm(instance=user) else: - if request.GET.get(self.DEF_SUBMIT_MSG_PARAM_NAME): + if request.GET.get(params['submit_msg_param_name']): # redirect to aggressively remove 'Profile saved' query parameter return http.HttpResponseRedirect(request.path)