py_tasks_melange: comparison app/soc/views/models/base.py

equal deleted inserted replaced

-:33942ff6e71b
+:c55195361cb6
 """Helpers functions for displaying views.
 """
 __authors__ = [
-'"Todd Larsen" <tlarsen@google.com>',
 '"Sverre Rabbelier" <sverer@rabbelier.nl>',
-'"Pawel Solyga" <pawel.solyga@gmail.com>',
 ]
 from django import http
 from django.utils.translation import ugettext_lazy
 import soc.logic.out_of_band
 import soc.views.helper.lists
 import soc.views.helper.responses
 import soc.views.out_of_band
+from soc.logic import dicts
 from soc.logic import models
 from soc.logic import validate
 from soc.views import simple
 from soc.views import helper
 from soc.views.helper import access
 on the the child-classes to define the following fields:
 self._logic: the logic singleton for this entity
 """
+DEF_SUBMIT_MSG_PARAM_NAME = 's'
+DEF_CREATE_NEW_ENTITY_MSG = ugettext_lazy(
+' You can create a new %(model_type)s by visiting'
+' <a href="%(create)s">Create '
+'a New %(Type)s</a> page.')
 def __init__(self, params=None, rights=None):
 """
 Args:
 rights: This dictionary should be filled with the access check
-functions that should be called
+functions that should be called, it will be modified in-place.
 params: This dictionary should be filled with the parameters
-specific to this entity.
+specific to this entity, required fields are:
+name: the name of the entity (names should have sentence-style caps)
+name_short: the short form name of the name ('org' vs 'organization')
+name_plural: the plural form of the name
+edit_form: the class of the Django form to be used when editing
+create_form: the class of the Django form to be used when creating
+edit_template: the Django template to be used for editing
+public_template: the Django template to be used as public page
+list_template: the Django template to be used as list page
+lists_template: the Django templates to search for the list page
+delete_redirect: the Django template to redirect to on delete
+create_redirect: the Django template to redirect to after creation
+save_message: the message to display when the entity is saved
+edit_params: the params to use when editing
 """
 new_rights = {}
-new_rights['base'] = [access.checkIsLoggedIn]
+new_rights['any_access'] = [access.checkIsLoggedIn]
-self._rights = soc.logic.dicts.mergeDicts(rights, new_rights)
+self._rights = dicts.merge(rights, new_rights)
 self._params = params
-self.DEF_SUBMIT_MSG_PARAM_NAME = 's'
-self.DEF_CREATE_NEW_ENTITY_MSG = ugettext_lazy(
-' You can create a new %(model_type)s by visiting'
-' <a href="%(create)s">Create '
-'a New %(Type)s</a> page.')
 def public(self, request, page=None, **kwargs):
 """Displays the public page for the entity specified by **kwargs
 Args:
 def editGet(self, request, entity, context):
 """Same as edit, but on GET
 """
 #TODO(SRabbelier) Construct a suffix
 suffix = None
-is_self_referrer = helper.requests.isReferrerSelf(request, suffix=suffix)
 # Remove the params from the request, this is relevant only if
 # someone bookmarked a POST page.
-if request.GET.get(self.DEF_SUBMIT_MSG_PARAM_NAME):
+is_self_referrer = helper.requests.isReferrerSelf(request, suffix=suffix)
+if request.GET.get(DEF_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,
+request, DEF_SUBMIT_MSG_PARAM_NAME,
-self.DEF_SUBMIT_MSG_PARAM_NAME,
+values=self._params['save_message'])
-values=self._params['save_message'])
 # populate form with the existing entity
 form = self._params['edit_form'](instance=entity)
 else:
 form = self._params['create_form']()
 context['form'] = form
 context['entity'] = entity
 context['entity_type'] = self._params['name']
 context['entity_type_plural'] = self._params['name_plural']
-template = self._params['create_template']
+template = self._params['edit_template']
 return helper.responses.respond(request, template, context)
 def list(self, request, page=None):
 """Displays the list page for the entity type
 if not entity:
 #TODO: Create a proper error page for this
 return http.HttpResponseRedirect('/')
 if not self._logic.isDeletable(entity):
-# TODO: Direct user to page telling them they can't delete that entity, and why
+# TODO: Update the notice area telling the user they can't delete the entity
 pass
 self._logic.delete(entity)
 redirect = self._params['delete_redirect']
 request: The django request object
 entity: the entity to make public
 fields: The new field values
 """
-pass
+raise NotImplementedError
 def checkUnspecified(self, access_type, request):
 """Checks whether an unspecified access_type should be allowed
 Args:
 False: If a check failed, in this case self._response will contain
 the response provided by the failed access check.
 """
 if access_type not in self._rights:
+# No checks defined, so do the 'generic check' and bail out
 self.checkUnspecified(access_type, request)
 return
 # Call each access checker
-for check in self._rights['base']:
+for check in self._rights['any_access']:
 check(request)
 for check in self._rights[access_type]:
 check(request)
-# All checks were successfull
-return
 def collectCleanedFields(self, form):
 """Collects all cleaned fields from form and returns them
 Args:
 form: The form from which the cleaned fields should be collected

changeset 387	c55195361cb6
parent 373	dcd7013ae0d5
child 389	9b873166d7d5