Add missing dots in soc.views.helper.redirects module function docstrings.
Patch by: Pawel Solyga
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."""Views for Requests."""__authors__ = [ '"Sverre Rabbelier" <sverre@rabbelier.nl>', '"Lennard de Rijk" <ljvderijk@gmail.com>', '"Pawel Solyga" <pawel.solyga@gmail.com>', ]from google.appengine.api import usersfrom django import formsfrom django import httpfrom django.core import urlresolversfrom django.utils.translation import ugettext_lazyfrom soc.logic import cleaningfrom soc.logic import dictsfrom soc.logic.models import sponsor as sponsor_logicfrom soc.logic.models import user as user_logicfrom soc.views import helperfrom soc.views import out_of_bandfrom soc.views.helper import accessfrom soc.views.helper import decoratorsfrom soc.views.helper import redirectsfrom soc.views.helper import responsesfrom soc.views.helper import widgetsfrom soc.views.models import baseimport soc.models.requestimport soc.logic.models.requestimport soc.logic.dictsimport soc.views.helperimport soc.views.helper.listsimport soc.views.helper.responsesclass View(base.View): """View methods for the Request model. """ def __init__(self, params=None): """Defines the fields and methods required for the base View class to provide the user with list, public, create, edit and delete views. Params: params: a dict with params for this View """ rights = {} rights['listSelf'] = [access.checkAgreesToSiteToS] rights['create'] = [access.deny] rights['edit'] = [access.checkIsDeveloper] rights['process_invite'] = [access.checkIsMyGroupAcceptedRequest] rights['list'] = [access.checkIsDeveloper] rights['delete'] = [access.checkIsDeveloper] new_params = {} new_params['rights'] = rights new_params['logic'] = soc.logic.models.request.logic new_params['name'] = "Request" new_params['sidebar_defaults'] = [('/%s/list', 'List %(name_plural)s', 'list')] new_params['save_message'] = [ugettext_lazy('Request saved.')] new_params['extra_dynaexclude'] = ['state', 'role_verbose'] # TODO(ljvderijk) add clean field that checks to see if the user already has # the role that's been entered in the create form fields new_params['create_extra_dynafields'] = { 'role' : forms.CharField(widget=widgets.ReadOnlyInput(), required=True), 'clean_link_id': cleaning.clean_existing_user('link_id') } new_params['edit_extra_dynafields'] = { 'scope_path': forms.CharField(widget=forms.HiddenInput, required=True), } patterns = [(r'^%(url_name)s/(?P<access_type>invite)/%(lnp)s$', 'soc.views.models.%(module_name)s.invite', 'Create invite for %(name_plural)s'), (r'^%(url_name)s/(?P<access_type>process_invite)/%(key_fields)s$', 'soc.views.models.%(module_name)s.processInvite', 'Process Invite to for a Role')] new_params['extra_django_patterns'] = patterns new_params['invite_processing_template'] = 'soc/request/process_invite.html' params = dicts.merge(params, new_params) super(View, self).__init__(params=params) @decorators.merge_params @decorators.check_access def processInvite(self, request, access_type, page_name=None, params=None, **kwargs): """Creates the page upon which an invite can be processed. Args: request: the standard Django HTTP request object access_type : the name of the access type which should be checked context: dictionary containing the context for this view params: a dict with params for this View kwargs: the Key Fields for the specified entity """ # get the context for this webpage context = responses.getUniversalContext(request) context['page_name'] = page_name request_logic = params['logic'] # get the request entity using the information from kwargs fields = {'link_id' : kwargs['link_id'], 'scope_path' : kwargs['scope_path'], 'role' : kwargs['role'], 'state' : 'group_accepted'} request_entity = request_logic.getForFields(fields, unique=True) get_dict = request.GET if 'status' in get_dict.keys(): if get_dict['status'] == 'rejected': # this invite has been rejected mark as rejected request_logic.updateModelProperties(request_entity, { 'state' : 'rejected'}) # redirect to user role overview return http.HttpResponseRedirect('/user/roles') # put the entity in the context context['entity'] = request_entity context['module_name'] = params['module_name'] context['invite_accepted_redirect'] = ( redirects.getInviteAcceptedRedirect(request_entity, self._params)) #display the invite processing page using the appropriate template template = params['invite_processing_template'] return responses.respond(request, template, context=context) @decorators.merge_params @decorators.check_access def listSelf(self, request, access_type, page_name=None, params=None, **kwargs): """Displays the unhandled requests for this user. Args: request: the standard Django HTTP request object page_name: the page name displayed in templates as page and header title params: a dict with params for this View kwargs: not used """ # get the current user properties = {'account': users.get_current_user()} user_entity = user_logic.logic.getForFields(properties, unique=True) # construct the Unhandled Invites list # only select the Invites for this user that haven't been handled yet filter = {'link_id': user_entity.link_id, 'state' : 'group_accepted'} uh_params = params.copy() uh_params['list_action'] = (redirects.getInviteProcessRedirect, None) uh_params['list_description'] = ugettext_lazy( "An overview of your unhandled invites.") uh_list = helper.lists.getListContent( request, uh_params, filter, 0) # construct the Open Requests list # only select the requests from the user # that haven't been accepted by an admin yet filter = {'link_id' : user_entity.link_id, 'state' : 'new'} ar_params = params.copy() ar_params['list_description'] = ugettext_lazy( "List of your pending requests.") ar_list = helper.lists.getListContent( request, ar_params, filter, 1) # fill contents with all the needed lists contents = [uh_list, ar_list] # call the _list method from base to display the list return self._list(request, params, contents, page_name)view = View()create = view.createedit = view.editdelete = view.deletelist = view.listlist_self = view.listSelfprocessInvite = view.processInvitepublic = view.publicexport = view.export