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

equal deleted inserted replaced

-:849956450d69
+:a023b71ce125
 __authors__ = [
 '"Daniel Diniz" <ajaksu@gmail.com>',
 '"James Levy" <jamesalexanderlevy@gmail.com>',
 ]
 import csv
 import datetime
 import re
 import StringIO
 import string
-from google.appengine.ext import db
 from django import forms
 from django import http
 from django.utils import simplejson
+from google.appengine.ext import db
 from soc.cache import home
 from soc.logic import cleaning
 from soc.logic import dicts
+from soc.logic.models.survey import logic as survey_logic
+from soc.logic.models.survey import results_logic
 from soc.logic.models.survey import GRADES
-from soc.logic.models.survey import logic as survey_logic
-from soc.logic.models.survey import project_logic
-from soc.logic.models.survey import grading_logic
-from soc.logic.models.survey_record import logic as results_logic
-from soc.logic.models.survey_record import updateSurveyRecord
 from soc.logic.models.user import logic as user_logic
 from soc.models.survey import Survey
 from soc.models.survey_record import SurveyRecord
 from soc.models.user import User
 from soc.views import out_of_band
 # TODO: read/write access needs to match survey
 # TODO: usage requirements
 rights = access.Checker(params)
 rights['any_access'] = ['allow']
-rights['show'] = [('checkIsSurveyReadable', survey_logic)]
+rights['show'] = ['checkIsSurveyReadable']
 rights['create'] = ['checkIsUser']
-rights['edit'] = [('checkIsSurveyWritable', survey_logic)]
+rights['edit'] = ['checkIsSurveyWritable']
-rights['delete'] = [('checkIsSurveyWritable', survey_logic)]
+rights['delete'] = ['checkIsSurveyWritable']
 rights['list'] = ['checkDocumentList']
 rights['pick'] = ['checkDocumentPick']
+rights['grade'] = ['checkIsSurveyGradable']
 new_params = {}
-# TODO(ajaksu) pass logic in a way views can use them
 new_params['logic'] = survey_logic
 new_params['rights'] = rights
 new_params['name'] = "Survey"
 new_params['pickable'] = True
 'soc.views.models.%(module_name)s.json',
 'Export %(name)s as JSON'),
 (r'^%(url_name)s/(?P<access_type>results)/%(scope)s$',
 'soc.views.models.%(module_name)s.results',
 'View survey results for %(name)s'),
+(r'^%(url_name)s/(?P<access_type>show)/user/(?P<link_id>)\w+$',
+'soc.views.models.%(module_name)s.results',
+'View survey results for user'),
 ]
 new_params['export_content_type'] = 'text/text'
 new_params['export_extension'] = '.csv'
 new_params['export_function'] = to_csv
 params=params, filter=kwargs)
 def _public(self, request, entity, context):
 """Survey taking and result display handler.
 Args:
 request: the django request object
 entity: the entity to make public
 context: the context object
 -- Taking Survey Pages Are Not 'Public' --
 For surveys, the "public" page is actually the access-protected
 survey-taking page.
 The project selected while taking a survey determines how this_user
 SurveyRecord will be linked to other SurveyRecords.
 --- Deadlines ---
-A deadline can also be used as a conditional for updating values,
+A survey_end can also be used as a conditional for updating values,
 we have a special read_only UI and a check on the POST handler for this.
 Passing read_only=True here allows one to fetch the read_only view.
 """
 # check ACL
 # not submitting completed survey OR we're ignoring late submission
 pass
 else:
 # save/update the submitted survey
 context['notice'] = "Survey Submission Saved"
-survey_record = updateSurveyRecord(user, survey, survey_record,
+survey_record = survey_logic.updateSurveyRecord(user, survey,
-request.POST)
+survey_record, request.POST)
 survey_content = survey.survey_content
 if not survey_record and read_only:
-# no recorded answers, we're either past deadline or want to see answers
+# no recorded answers, we're either past survey_end or want to see answers
 is_same_user = user.key() == user_logic.getForCurrentAccount().key()
 if not can_write or not is_same_user:
 # If user who can edit looks at her own taking page, show the default
 # form as readonly. Otherwise, below, show nothing.
 context['read_only'] = read_only
 context['project'] = project
 return True
 def getStatus(self, request, context, user, survey):
-"""Determine if the survey is available for taking, check user rights.
+"""Determine if we're past survey_end or before survey_start, check user rights.
 """
 read_only = (context.get("read_only", False) or
 request.GET.get("read_only", False) or
 request.POST.get("read_only", False)
 )
 now = datetime.datetime.now()
-# check survey end date, see check for start below
+# check survey_end, see check for survey_start below
 if survey.survey_end and now > survey.survey_end:
-# are we already passed the deadline?
+# are we already passed the survey_end?
 context["notice"] = "The Deadline For This Survey Has Passed"
 read_only = True
 # check if user can edit this survey
 params = dict(prefix=survey.prefix, scope_path=survey.scope_path)
 checker = access.rights_logic.Checker(survey.prefix)
 roles = checker.getMembership(survey.write_access)
 rights = self._params['rights']
 can_write = access.Checker.hasMembership(rights, roles, params)
 not_ready = False
-# check if we're past the start date
+# check if we're past the survey_start date
 if survey.survey_start and now < survey.survey_start:
 not_ready = True
-# only users that can edit a survey should see it before it can be taken
+# only users that can edit a survey should see it before survey_start
 if not can_write:
 context["notice"] = "There is no such survey available."
 return False
 else:
 context["notice"] = "This survey is not open for taking yet."
 """Set help_text and status for template use.
 """
 if not read_only:
 if not survey.survey_end:
-deadline_text = ""
+survey_end_text = ""
 else:
-deadline_text = " by " + str(
+survey_end_text = " by " + str(
 survey.survey_end.strftime("%A, %d. %B %Y %I:%M%p"))
 if survey_record:
-help_text = "Edit and re-submit this survey" + deadline_text + "."
+help_text = "Edit and re-submit this survey" + survey_end_text + "."
 status = "edit"
 else:
-help_text = "Please complete this survey" + deadline_text + "."
+help_text = "Please complete this survey" + survey_end_text + "."
 status = "create"
 else:
 help_text = "Read-only view."
 status = "view"
 survey_h=entity.survey_content)
 context.update(local)
 params['edit_form'] = HelperForm(params['edit_form'])
 if entity.survey_end and datetime.datetime.now() > entity.survey_end:
-# are we already passed the survey end date?
+# are we already passed the survey_end?
-context["passed_deadline"] = True
+context["passed_survey_end"] = True
 return super(View, self).editGet(request, entity, context, params=params)
 def getMenusForScope(self, entity, params):
-"""List featured surveys iff after they are availble to be taken.
+"""List featured surveys if after the survey_start date and before survey_end.
 """
 # only list surveys for registered users
 user = user_logic.getForCurrentAccount()
 if not user:
 # cache ACL for a given entity.read_access
 survey_rights[entity.read_access] = can_read
 if not can_read:
-continue
+pass#continue
 elif not survey_rights[entity.read_access]:
-continue
+pass#continue
-# omit if either before start or after end
+# omit if either before survey_start or after survey_end
 if entity.survey_start and entity.survey_start > now:
-continue
+pass#continue
 if entity.survey_end and entity.survey_end < now:
-continue
+pass#continue
+taken_status = ""
+taken_status = "(new)"
 #TODO only if a document is readable it might be added
 submenu = (redirects.getPublicRedirect(entity, self._params),
-entity.short_name, 'show')
+'Survey ' +  taken_status + ': ' + entity.short_name,
+'show')
 submenus.append(submenu)
 return submenus
-# TODO the following two methods should move to GradingProjectSurvey
 def activate(self, request, **kwargs):
 """This is a hack to support the 'Enable grades' button.
 """
 self.activateGrades(request)
 redirect_path = request.path.replace('/activate/', '/edit/') + '?activate=1'
 def viewResults(self, request, access_type, page_name=None,
 params=None, **kwargs):
 """View for SurveyRecord and SurveyRecordGroup.
 """
-entity, context = self.getContextEntity(request, page_name, params, kwargs)
-if context is None:
-# user cannot see this page, return error response
-return entity
-can_write = False
-rights = self._params['rights']
-try:
-rights.checkIsSurveyWritable({'key_name': entity.key().name(),
-'prefix': entity.prefix,
-'scope_path': entity.scope_path,
-'link_id': entity.link_id,},
-'key_name')
-can_write = True
-except out_of_band.AccessViolation:
-pass
 user = user_logic.getForCurrentAccount()
-filter = self._params.get('filter') or {}
+# TODO(ajaksu) use the named parameter link_id from the re
+if request.path == '/survey/show/user/' + user.link_id:
-# if user can edit the survey, show everyone's results
+records = tuple(user.surveys_taken.run())
-if can_write:
+context = responses.getUniversalContext(request)
-filter['survey'] = entity
+context['content'] = records[0].survey.survey_content
+responses.useJavaScript(context, params['js_uses_all'])
+context['page_name'] = u'Your survey records.'
 else:
-filter.update({'user': user, 'survey': entity})
+entity, context = self.getContextEntity(request, page_name,
+params, kwargs)
-limit = self._params.get('limit') or 1000
-offset = self._params.get('offset') or 0
+if context is None:
-order = self._params.get('order') or []
+# user cannot see this page, return error response
-idx = self._params.get('idx') or 0
+return entity
+context['content'] = entity.survey_content
-records = results_logic.getForFields(filter=filter, limit=limit,
+can_write = False
-offset=offset, order=order)
+rights = self._params['rights']
+try:
+rights.checkIsSurveyWritable({'key_name': entity.key().name(),
+'prefix': entity.prefix,
+'scope_path': entity.scope_path,
+'link_id': entity.link_id,},
+'key_name')
+can_write = True
+except out_of_band.AccessViolation:
+pass
+filter = self._params.get('filter') or {}
+# if user can edit the survey, show everyone's results
+if can_write:
+filter['survey'] = entity
+else:
+filter.update({'user': user, 'survey': entity})
+limit = self._params.get('limit') or 1000
+offset = self._params.get('offset') or 0
+order = self._params.get('order') or []
+idx = self._params.get('idx') or 0
+records = results_logic.getForFields(filter=filter, limit=limit,
+offset=offset, order=order)
 updates = dicts.rename(params, params['list_params'])
 context.update(updates)
 context['results'] = records, records
-context['content'] = entity.survey_content
 template = 'soc/survey/results_page.html'
 return responses.respond(request, template, context=context)
 @decorators.merge_params
 header = _get_csv_header(survey)
 leading = ['user', 'created', 'modified']
 properties = leading + survey.survey_content.orderedProperties()
 try:
-first = survey.getRecords().run().next()
+first = survey.survey_records.run().next()
 except StopIteration:
 # bail out early if survey_records.run() is empty
 return header, survey.link_id
 # generate results list
-recs = survey.getRecords().run()
+recs = survey.survey_records.run()
 recs = _get_records(recs, properties)
 # write results to CSV
 output = StringIO.StringIO()
 writer = csv.writer(output)

changeset 2455	a023b71ce125
parent 2448	325e08ee9d25
child 2463	05af53239799