2009-05-17 11:34:55 +00:00
|
|
|
#!/usr/bin/python
|
|
|
|
# vim: set fileencoding=utf-8
|
|
|
|
|
|
|
|
from django.http import HttpResponse, Http404, \
|
|
|
|
HttpResponsePermanentRedirect, HttpResponseRedirect
|
|
|
|
from django.template import RequestContext, Context, Template, loader
|
|
|
|
from django.views.decorators.cache import cache_control
|
|
|
|
from django.core.urlresolvers import reverse
|
2009-12-23 08:42:53 +00:00
|
|
|
from django.contrib.auth.decorators import login_required, permission_required
|
2009-05-17 11:34:55 +00:00
|
|
|
from django.shortcuts import render_to_response, get_object_or_404
|
|
|
|
from django.contrib.sites.models import Site
|
|
|
|
from django.db import transaction
|
|
|
|
from django.conf import settings
|
|
|
|
from datetime import datetime
|
|
|
|
from django.utils import translation
|
2010-04-18 17:20:54 +00:00
|
|
|
from django.utils.translation import ugettext_lazy as _
|
2009-12-24 11:41:38 +00:00
|
|
|
from questionnaire import QuestionProcessors
|
|
|
|
from questionnaire import questionnaire_done
|
|
|
|
from questionnaire import questionset_done
|
|
|
|
from questionnaire import AnswerException
|
|
|
|
from questionnaire import Processors
|
|
|
|
from questionnaire.models import *
|
|
|
|
from questionnaire.parsers import *
|
|
|
|
from questionnaire.emails import send_emails, _send_email
|
2011-12-15 13:13:17 +00:00
|
|
|
from questionnaire.utils import numal_sort, numal0_sort, split_numal
|
2009-12-24 11:41:38 +00:00
|
|
|
import smtplib
|
2009-05-17 11:34:55 +00:00
|
|
|
import logging
|
2009-12-24 11:41:38 +00:00
|
|
|
import random
|
|
|
|
import rfc822
|
|
|
|
import time
|
|
|
|
import md5
|
|
|
|
import os
|
2011-11-30 09:00:33 +00:00
|
|
|
import re
|
2009-05-17 11:34:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
def r2r(tpl, request, **contextdict):
|
|
|
|
"Shortcut to use RequestContext instead of Context in templates"
|
|
|
|
contextdict['request'] = request
|
|
|
|
return render_to_response(tpl, contextdict, context_instance = RequestContext(request))
|
|
|
|
|
|
|
|
|
|
|
|
def get_runinfo(random):
|
|
|
|
"Return the RunInfo entry with the provided random key"
|
2009-06-15 16:07:14 +00:00
|
|
|
res = RunInfo.objects.filter(random=random.lower())
|
2009-05-17 11:34:55 +00:00
|
|
|
if res:
|
|
|
|
return res[0]
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
|
|
def get_question(number, questionnaire):
|
|
|
|
"Return the specified Question (by number) from the specified Questionnaire"
|
|
|
|
res = Question.objects.filter(number=number, questionset__questionnaire=questionnaire)
|
|
|
|
if res:
|
|
|
|
return res[0]
|
|
|
|
return None
|
|
|
|
|
|
|
|
|
|
|
|
def delete_answer(question, subject, runid):
|
|
|
|
"Delete the specified question/subject/runid combination from the Answer table"
|
|
|
|
Answer.objects.filter(subject=subject, runid=runid, question=question).delete()
|
|
|
|
|
|
|
|
|
|
|
|
def add_answer(runinfo, question, answer_dict):
|
|
|
|
"""
|
|
|
|
Add an Answer to a Question for RunInfo, given the relevant form input
|
|
|
|
|
|
|
|
answer_dict contains the POST'd elements for this question, minus the
|
|
|
|
question_{number} prefix. The question_{number} form value is accessible
|
|
|
|
with the ANSWER key.
|
|
|
|
"""
|
|
|
|
answer = Answer()
|
|
|
|
answer.question = question
|
|
|
|
answer.subject = runinfo.subject
|
|
|
|
answer.runid = runinfo.runid
|
|
|
|
|
|
|
|
type = question.get_type()
|
|
|
|
|
|
|
|
if "ANSWER" not in answer_dict:
|
|
|
|
answer_dict['ANSWER'] = None
|
|
|
|
|
|
|
|
if type in Processors:
|
|
|
|
answer.answer = Processors[type](question, answer_dict) or ''
|
|
|
|
else:
|
|
|
|
raise AnswerException("No Processor defined for question type %s" % type)
|
|
|
|
|
|
|
|
# first, delete all existing answers to this question for this particular user+run
|
|
|
|
delete_answer(question, runinfo.subject, runinfo.runid)
|
|
|
|
# then save the new answer to the database
|
|
|
|
answer.save()
|
|
|
|
return True
|
|
|
|
|
|
|
|
|
|
|
|
def questionset_satisfies_checks(questionset, runinfo):
|
|
|
|
"Return True is RunInfo satisfied checks for the specified QuestionSet"
|
|
|
|
checks = parse_checks(questionset.checks)
|
|
|
|
for check, value in checks.items():
|
|
|
|
if check == 'maleonly' and runinfo.subject.gender != 'male':
|
|
|
|
return False
|
|
|
|
if check == 'femaleonly' and runinfo.subject.gender != 'female':
|
|
|
|
return False
|
|
|
|
if check == 'shownif' and value and value.strip():
|
|
|
|
depparser = BooleanParser(dep_check, runinfo, {})
|
|
|
|
res = depparser.parse(value)
|
|
|
|
if not res:
|
|
|
|
return False
|
2011-12-21 13:53:00 +00:00
|
|
|
|
|
|
|
import pdb; pdb.set_trace()
|
|
|
|
if check =='iftag' and value and value.strip():
|
|
|
|
if not has_tag(runinfo, tag=value):
|
|
|
|
return False
|
|
|
|
|
2009-05-17 11:34:55 +00:00
|
|
|
return True
|
|
|
|
|
|
|
|
|
|
|
|
def redirect_to_qs(runinfo):
|
|
|
|
"Redirect to the correct and current questionset URL for this RunInfo"
|
|
|
|
url = reverse("questionset",
|
|
|
|
args=[ runinfo.random, runinfo.questionset.sortid ])
|
|
|
|
return HttpResponseRedirect(url)
|
|
|
|
|
|
|
|
|
|
|
|
@transaction.commit_on_success
|
|
|
|
def questionnaire(request, runcode=None, qs=None):
|
|
|
|
"""
|
|
|
|
Process submitted answers (if present) and redirect to next page
|
|
|
|
|
|
|
|
If this is a POST request, parse the submitted data in order to store
|
|
|
|
all the submitted answers. Then return to the next questionset or
|
|
|
|
return a completed response.
|
|
|
|
|
|
|
|
If this isn't a POST request, redirect to the main page.
|
|
|
|
|
|
|
|
We only commit on success, to maintain consistency. We also specifically
|
|
|
|
rollback if there were errors processing the answers for this questionset.
|
|
|
|
"""
|
|
|
|
|
|
|
|
# if runcode provided as query string, redirect to the proper page
|
2009-12-23 08:42:53 +00:00
|
|
|
if not runcode:
|
|
|
|
if not request.GET.get('runcode', None):
|
|
|
|
return HttpResponseRedirect("/")
|
2009-05-17 11:34:55 +00:00
|
|
|
return HttpResponseRedirect(
|
|
|
|
reverse("questionnaire",
|
|
|
|
args=[request.GET['runcode']]))
|
|
|
|
|
|
|
|
runinfo = get_runinfo(runcode)
|
|
|
|
|
|
|
|
if not runinfo:
|
|
|
|
transaction.commit()
|
|
|
|
return HttpResponseRedirect('/')
|
|
|
|
|
2009-06-15 17:05:59 +00:00
|
|
|
if not qs:
|
2009-05-17 11:34:55 +00:00
|
|
|
# Only change the language to the subjects choice for the initial
|
|
|
|
# questionnaire page (may be a direct link from an email)
|
|
|
|
if hasattr(request, 'session'):
|
|
|
|
request.session['django_language'] = runinfo.subject.language
|
|
|
|
translation.activate(runinfo.subject.language)
|
|
|
|
|
2009-06-15 17:05:59 +00:00
|
|
|
if 'lang' in request.GET:
|
|
|
|
return set_language(request, runinfo, request.path)
|
|
|
|
|
2009-05-17 11:34:55 +00:00
|
|
|
# --------------------------------
|
|
|
|
# --- Handle non-POST requests ---
|
|
|
|
# --------------------------------
|
|
|
|
|
|
|
|
if request.method != "POST":
|
|
|
|
if qs is not None:
|
|
|
|
qs = get_object_or_404(QuestionSet, sortid=qs, questionnaire=runinfo.questionset.questionnaire)
|
|
|
|
if runinfo.random.startswith('test:'):
|
|
|
|
pass # ok for testing
|
|
|
|
elif qs.sortid > runinfo.questionset.sortid:
|
|
|
|
# you may jump back, but not forwards
|
|
|
|
return redirect_to_qs(runinfo)
|
|
|
|
runinfo.questionset = qs
|
|
|
|
runinfo.save()
|
|
|
|
transaction.commit()
|
|
|
|
# no questionset id in URL, so redirect to the correct URL
|
|
|
|
if qs is None:
|
|
|
|
return redirect_to_qs(runinfo)
|
|
|
|
return show_questionnaire(request, runinfo)
|
|
|
|
|
|
|
|
# -------------------------------------
|
|
|
|
# --- Process POST with QuestionSet ---
|
|
|
|
# -------------------------------------
|
|
|
|
|
|
|
|
# if the submitted page is different to what runinfo says, update runinfo
|
|
|
|
# XXX - do we really want this?
|
|
|
|
qs = request.POST.get('questionset_id', None)
|
|
|
|
try:
|
|
|
|
qsobj = QuestionSet.objects.filter(pk=qs)[0]
|
|
|
|
if qsobj.questionnaire == runinfo.questionset.questionnaire:
|
|
|
|
if runinfo.questionset != qsobj:
|
|
|
|
runinfo.questionset = qsobj
|
|
|
|
runinfo.save()
|
|
|
|
except:
|
|
|
|
pass
|
|
|
|
|
|
|
|
questionnaire = runinfo.questionset.questionnaire
|
|
|
|
questionset = runinfo.questionset
|
|
|
|
|
|
|
|
# to confirm that we have the correct answers
|
|
|
|
expected = questionset.questions()
|
|
|
|
|
|
|
|
items = request.POST.items()
|
|
|
|
extra = {} # question_object => { "ANSWER" : "123", ... }
|
|
|
|
|
|
|
|
# this will ensure that each question will be processed, even if we did not receive
|
|
|
|
# any fields for it. Also works to ensure the user doesn't add extra fields in
|
|
|
|
for x in expected:
|
|
|
|
items.append( (u'question_%s_Trigger953' % x.number, None) )
|
|
|
|
|
|
|
|
# generate the answer_dict for each question, and place in extra
|
|
|
|
for item in items:
|
|
|
|
key, value = item[0], item[1]
|
|
|
|
if key.startswith('question_'):
|
|
|
|
answer = key.split("_", 2)
|
|
|
|
question = get_question(answer[1], questionnaire)
|
|
|
|
if not question:
|
|
|
|
logging.warn("Unknown question when processing: %s" % answer[1])
|
|
|
|
continue
|
|
|
|
extra[question] = ans = extra.get(question, {})
|
|
|
|
if(len(answer) == 2):
|
|
|
|
ans['ANSWER'] = value
|
|
|
|
elif(len(answer) == 3):
|
|
|
|
ans[answer[2]] = value
|
|
|
|
else:
|
|
|
|
logging.warn("Poorly formed form element name: %r" % answer)
|
|
|
|
continue
|
|
|
|
extra[question] = ans
|
|
|
|
|
|
|
|
errors = {}
|
|
|
|
for question, ans in extra.items():
|
|
|
|
if u"Trigger953" not in ans:
|
|
|
|
logging.warn("User attempted to insert extra question (or it's a bug)")
|
|
|
|
continue
|
|
|
|
try:
|
|
|
|
cd = question.getcheckdict()
|
|
|
|
# requiredif is the new way
|
|
|
|
depon = cd.get('requiredif',None) or cd.get('dependent',None)
|
|
|
|
if depon:
|
|
|
|
depparser = BooleanParser(dep_check, runinfo, extra)
|
|
|
|
if not depparser.parse(depon):
|
|
|
|
# if check is not the same as answer, then we don't care
|
|
|
|
# about this question plus we should delete it from the DB
|
|
|
|
delete_answer(question, runinfo.subject, runinfo.runid)
|
|
|
|
if cd.get('store', False):
|
|
|
|
runinfo.set_cookie(question.number, None)
|
|
|
|
continue
|
|
|
|
add_answer(runinfo, question, ans)
|
|
|
|
if cd.get('store', False):
|
|
|
|
runinfo.set_cookie(question.number, ans['ANSWER'])
|
|
|
|
except AnswerException, e:
|
|
|
|
errors[question.number] = e
|
|
|
|
except Exception:
|
|
|
|
logging.exception("Unexpected Exception")
|
|
|
|
transaction.rollback()
|
|
|
|
raise
|
|
|
|
|
|
|
|
if len(errors) > 0:
|
|
|
|
res = show_questionnaire(request, runinfo, errors=errors)
|
|
|
|
transaction.rollback()
|
|
|
|
return res
|
|
|
|
|
|
|
|
questionset_done.send(sender=None,runinfo=runinfo,questionset=questionset)
|
|
|
|
|
|
|
|
next = questionset.next()
|
|
|
|
while next and not questionset_satisfies_checks(next, runinfo):
|
|
|
|
next = next.next()
|
|
|
|
runinfo.questionset = next
|
|
|
|
runinfo.save()
|
|
|
|
|
|
|
|
if next is None: # we are finished
|
|
|
|
hist = RunInfoHistory()
|
|
|
|
hist.subject = runinfo.subject
|
|
|
|
hist.runid = runinfo.runid
|
|
|
|
hist.completed = datetime.now()
|
|
|
|
hist.save()
|
|
|
|
|
|
|
|
questionnaire_done.send(sender=None, runinfo=runinfo,
|
|
|
|
questionnaire=questionnaire)
|
|
|
|
|
|
|
|
redirect_url = questionnaire.redirect_url
|
|
|
|
for x,y in (('$LANG', translation.get_language()),
|
|
|
|
('$SUBJECTID', runinfo.subject.id),
|
|
|
|
('$RUNID', runinfo.runid),):
|
|
|
|
redirect_url = redirect_url.replace(x, str(y))
|
|
|
|
|
|
|
|
if runinfo.runid in ('12345', '54321') \
|
|
|
|
or runinfo.runid.startswith('test:'):
|
|
|
|
runinfo.questionset = QuestionSet.objects.filter(questionnaire=questionnaire).order_by('sortid')[0]
|
|
|
|
runinfo.save()
|
|
|
|
else:
|
|
|
|
runinfo.delete()
|
|
|
|
transaction.commit()
|
|
|
|
if redirect_url:
|
|
|
|
return HttpResponseRedirect(redirect_url)
|
|
|
|
return r2r("questionnaire/complete.$LANG.html", request)
|
|
|
|
|
|
|
|
transaction.commit()
|
|
|
|
return redirect_to_qs(runinfo)
|
|
|
|
|
|
|
|
|
|
|
|
def get_progress(percent):
|
|
|
|
"Based on a percentage as a float, calculate percentage needed for CSS progress bar"
|
|
|
|
if int(percent) >= 1:
|
|
|
|
return 100, "1"
|
|
|
|
pc = "-%s" % (120 - int(percent * 120) + 1)
|
|
|
|
return (int(percent * 100), pc)
|
|
|
|
|
|
|
|
|
|
|
|
def show_questionnaire(request, runinfo, errors={}):
|
|
|
|
"""
|
|
|
|
Return the QuestionSet template
|
|
|
|
|
|
|
|
Also add the javascript dependency code.
|
|
|
|
"""
|
|
|
|
questions = runinfo.questionset.questions()
|
|
|
|
total = len(runinfo.questionset.questionnaire.questionsets())
|
|
|
|
|
|
|
|
qlist = []
|
|
|
|
jsinclude = [] # js files to include
|
|
|
|
cssinclude = [] # css files to include
|
|
|
|
jstriggers = []
|
|
|
|
qvalues = {}
|
2011-11-30 09:00:33 +00:00
|
|
|
|
2011-09-28 10:31:08 +00:00
|
|
|
# initialize qvalues
|
|
|
|
for k,v in runinfo.get_cookiedict().items():
|
|
|
|
qvalues[k] = v
|
|
|
|
|
2009-05-17 11:34:55 +00:00
|
|
|
for question in questions:
|
|
|
|
Type = question.get_type()
|
|
|
|
_qnum, _qalpha = split_numal(question.number)
|
|
|
|
if _qalpha:
|
|
|
|
_qalpha_class = ord(_qalpha[-1]) % 2 and 'odd' or 'even'
|
|
|
|
qdict = {
|
|
|
|
'template' : 'questionnaire/%s.html' % (Type),
|
|
|
|
'qnum' : _qnum,
|
|
|
|
'qalpha' : _qalpha,
|
|
|
|
'qtype' : Type,
|
|
|
|
'qnum_class' : (_qnum % 2 == 0) and " qeven" or " qodd",
|
|
|
|
'qalpha_class' : _qalpha and (ord(_qalpha[-1]) % 2 \
|
|
|
|
and ' alodd' or ' aleven') or '',
|
|
|
|
}
|
2011-12-14 08:41:43 +00:00
|
|
|
#If the question has a magic string that refers to an answer to a
|
|
|
|
# previous question, fetch the answer and replace the magic string.
|
2011-11-30 09:00:33 +00:00
|
|
|
# To be able to fetch the cookie with the answer it has to be stored
|
|
|
|
# using additional checks
|
|
|
|
if qvalues:
|
|
|
|
magic = 'subst_with_ans_'
|
|
|
|
regex =r'subst_with_ans_(\d+)'
|
|
|
|
|
|
|
|
replacements = re.findall(regex, question.text)
|
|
|
|
text_attributes = [a for a in dir(question) if a.startswith('text_')]
|
|
|
|
|
|
|
|
for answerid in replacements:
|
|
|
|
|
|
|
|
target = magic + answerid
|
|
|
|
replacement = qvalues.get(answerid, '')
|
|
|
|
|
|
|
|
for attr in text_attributes:
|
|
|
|
oldtext = getattr(question, attr)
|
|
|
|
newtext = oldtext.replace(target, replacement)
|
|
|
|
|
|
|
|
setattr(question, attr, newtext)
|
2009-05-17 11:34:55 +00:00
|
|
|
|
|
|
|
# add javascript dependency checks
|
|
|
|
cd = question.getcheckdict()
|
|
|
|
depon = cd.get('requiredif',None) or cd.get('dependent',None)
|
|
|
|
if depon:
|
|
|
|
# extra args to BooleanParser are not required for toString
|
|
|
|
parser = BooleanParser(dep_check)
|
|
|
|
qdict['checkstring'] = ' checks="%s"' % parser.toString(depon)
|
|
|
|
jstriggers.append('qc_%s' % question.number)
|
|
|
|
if 'default' in cd:
|
|
|
|
qvalues[question.number] = cd['default']
|
|
|
|
if Type in QuestionProcessors:
|
|
|
|
qdict.update(QuestionProcessors[Type](request, question))
|
|
|
|
if 'jsinclude' in qdict:
|
|
|
|
if qdict['jsinclude'] not in jsinclude:
|
|
|
|
jsinclude.extend(qdict['jsinclude'])
|
|
|
|
if 'cssinclude' in qdict:
|
|
|
|
if qdict['cssinclude'] not in cssinclude:
|
|
|
|
cssinclude.extend(qdict['jsinclude'])
|
|
|
|
if 'jstriggers' in qdict:
|
|
|
|
jstriggers.extend(qdict['jstriggers'])
|
|
|
|
if 'qvalue' in qdict:
|
|
|
|
qvalues[question.number] = qdict['qvalue']
|
|
|
|
qlist.append( (question, qdict) )
|
|
|
|
|
|
|
|
progress = None
|
|
|
|
if runinfo.questionset.sortid != 0:
|
|
|
|
progress = get_progress(runinfo.questionset.sortid / float(total))
|
|
|
|
|
|
|
|
if request.POST:
|
|
|
|
for k,v in request.POST.items():
|
|
|
|
if k.startswith("question_"):
|
|
|
|
s = k.split("_")
|
2010-03-01 17:12:40 +00:00
|
|
|
if len(s) == 4:
|
|
|
|
qvalues[s[1]+'_'+v] = '1' # evaluates true in JS
|
2010-12-06 19:31:46 +00:00
|
|
|
elif len(s) == 3 and s[2] == 'comment':
|
|
|
|
qvalues[s[1]+'_'+s[2]] = v
|
2010-03-01 17:12:40 +00:00
|
|
|
else:
|
2009-05-17 11:34:55 +00:00
|
|
|
qvalues[s[1]] = v
|
|
|
|
|
|
|
|
r = r2r("questionnaire/questionset.html", request,
|
|
|
|
questionset=runinfo.questionset,
|
|
|
|
runinfo=runinfo,
|
|
|
|
errors=errors,
|
|
|
|
qlist=qlist,
|
|
|
|
progress=progress,
|
|
|
|
triggers=jstriggers,
|
|
|
|
qvalues=qvalues,
|
|
|
|
jsinclude=jsinclude,
|
|
|
|
cssinclude=cssinclude)
|
|
|
|
r['Cache-Control'] = 'no-cache'
|
2009-06-15 17:05:59 +00:00
|
|
|
r['Expires'] = "Thu, 24 Jan 1980 00:00:00 GMT"
|
2009-05-17 11:34:55 +00:00
|
|
|
return r
|
|
|
|
|
|
|
|
|
2009-06-15 17:05:59 +00:00
|
|
|
def set_language(request, runinfo=None, next=None):
|
|
|
|
"""
|
|
|
|
Change the language, save it to runinfo if provided, and
|
|
|
|
redirect to the provided URL (or the last URL).
|
|
|
|
Can also be used by a url handler, w/o runinfo & next.
|
|
|
|
"""
|
|
|
|
if not next:
|
|
|
|
next = request.REQUEST.get('next', None)
|
|
|
|
if not next:
|
|
|
|
next = request.META.get('HTTP_REFERER', None)
|
|
|
|
if not next:
|
|
|
|
next = '/'
|
|
|
|
response = HttpResponseRedirect(next)
|
|
|
|
response['Expires'] = "Thu, 24 Jan 1980 00:00:00 GMT"
|
|
|
|
if request.method == 'GET':
|
|
|
|
lang_code = request.GET.get('lang', None)
|
|
|
|
if lang_code and translation.check_for_language(lang_code):
|
|
|
|
if hasattr(request, 'session'):
|
|
|
|
request.session['django_language'] = lang_code
|
|
|
|
else:
|
|
|
|
response.set_cookie(settings.LANGUAGE_COOKIE_NAME, lang_code)
|
|
|
|
if runinfo:
|
|
|
|
runinfo.subject.language = lang_code
|
|
|
|
runinfo.subject.save()
|
|
|
|
return response
|
|
|
|
|
|
|
|
|
2010-03-23 16:03:19 +00:00
|
|
|
def _table_headers(questions):
|
|
|
|
"""
|
|
|
|
Return the header labels for a set of questions as a list of strings.
|
|
|
|
|
|
|
|
This will create separate columns for each multiple-choice possiblity
|
|
|
|
and freeform options, to avoid mixing data types and make charting easier.
|
|
|
|
"""
|
|
|
|
ql = list(questions.distinct('number'))
|
|
|
|
ql.sort(lambda x, y: numal_sort(x.number, y.number))
|
|
|
|
columns = []
|
|
|
|
for q in ql:
|
|
|
|
if q.type == 'choice-yesnocomment':
|
|
|
|
columns.extend([q.number, q.number + "-freeform"])
|
|
|
|
elif q.type == 'choice-freeform':
|
|
|
|
columns.extend([q.number, q.number + "-freeform"])
|
|
|
|
elif q.type.startswith('choice-multiple'):
|
|
|
|
cl = [c.value for c in q.choice_set.all()]
|
|
|
|
cl.sort(numal_sort)
|
|
|
|
columns.extend([q.number + '-' + value for value in cl])
|
|
|
|
if q.type == 'choice-multiple-freeform':
|
|
|
|
columns.append(q.number + '-freeform')
|
|
|
|
else:
|
|
|
|
columns.append(q.number)
|
|
|
|
return columns
|
|
|
|
|
|
|
|
|
|
|
|
|
2009-12-23 08:42:53 +00:00
|
|
|
@permission_required("questionnaire.export")
|
2009-05-17 11:34:55 +00:00
|
|
|
def export_csv(request, qid): # questionnaire_id
|
|
|
|
"""
|
|
|
|
For a given questionnaire id, generaete a CSV containing all the
|
|
|
|
answers for all subjects.
|
|
|
|
"""
|
2010-12-22 16:32:25 +00:00
|
|
|
import tempfile, csv, cStringIO, codecs
|
2009-05-17 11:34:55 +00:00
|
|
|
from django.core.servers.basehttp import FileWrapper
|
|
|
|
|
2010-12-22 16:32:25 +00:00
|
|
|
class UnicodeWriter:
|
|
|
|
"""
|
|
|
|
COPIED from http://docs.python.org/library/csv.html example:
|
|
|
|
|
|
|
|
A CSV writer which will write rows to CSV file "f",
|
|
|
|
which is encoded in the given encoding.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self, f, dialect=csv.excel, encoding="utf-8", **kwds):
|
|
|
|
# Redirect output to a queue
|
|
|
|
self.queue = cStringIO.StringIO()
|
|
|
|
self.writer = csv.writer(self.queue, dialect=dialect, **kwds)
|
|
|
|
self.stream = f
|
|
|
|
self.encoder = codecs.getincrementalencoder(encoding)()
|
|
|
|
|
|
|
|
def writerow(self, row):
|
|
|
|
self.writer.writerow([s.encode("utf-8") for s in row])
|
|
|
|
# Fetch UTF-8 output from the queue ...
|
|
|
|
data = self.queue.getvalue()
|
|
|
|
data = data.decode("utf-8")
|
|
|
|
# ... and reencode it into the target encoding
|
|
|
|
data = self.encoder.encode(data)
|
|
|
|
# write to the target stream
|
|
|
|
self.stream.write(data)
|
|
|
|
# empty queue
|
|
|
|
self.queue.truncate(0)
|
|
|
|
|
|
|
|
def writerows(self, rows):
|
|
|
|
for row in rows:
|
|
|
|
self.writerow(row)
|
|
|
|
|
2009-05-17 11:34:55 +00:00
|
|
|
fd = tempfile.TemporaryFile()
|
2010-04-20 01:12:39 +00:00
|
|
|
|
|
|
|
questionnaire = get_object_or_404(Questionnaire, pk=int(qid))
|
|
|
|
headings, answers = answer_export(questionnaire)
|
|
|
|
|
2010-12-22 16:32:25 +00:00
|
|
|
writer = UnicodeWriter(fd)
|
2010-04-20 01:12:39 +00:00
|
|
|
writer.writerow([u'subject', u'runid'] + headings)
|
|
|
|
for subject, runid, answer_row in answers:
|
|
|
|
row = ["%s/%s" % (subject.id, subject.state), runid] + [
|
2010-12-22 16:32:25 +00:00
|
|
|
a if a else '--' for a in answer_row]
|
2010-04-20 01:12:39 +00:00
|
|
|
writer.writerow(row)
|
|
|
|
|
|
|
|
response = HttpResponse(FileWrapper(fd), mimetype="text/csv")
|
|
|
|
response['Content-Length'] = fd.tell()
|
|
|
|
response['Content-Disposition'] = 'attachment; filename="export-%s.csv"' % qid
|
|
|
|
fd.seek(0)
|
|
|
|
return response
|
|
|
|
|
|
|
|
def answer_export(questionnaire, answers=None):
|
|
|
|
"""
|
|
|
|
questionnaire -- questionnaire model for export
|
|
|
|
answers -- query set of answers to include in export, defaults to all
|
|
|
|
|
2010-12-22 16:32:25 +00:00
|
|
|
Return a flat dump of column headings and all the answers for a
|
|
|
|
questionnaire (in query set answers) in the form (headings, answers)
|
|
|
|
where headings is:
|
2010-04-20 01:12:39 +00:00
|
|
|
['question1 number', ...]
|
|
|
|
and answers is:
|
|
|
|
[(subject1, 'runid1', ['answer1.1', ...]), ... ]
|
|
|
|
|
|
|
|
The headings list might include items with labels like
|
|
|
|
'questionnumber-freeform'. Those columns will contain all the freeform
|
|
|
|
answers for that question (separated from the other answer data).
|
2010-12-22 16:32:25 +00:00
|
|
|
|
|
|
|
Multiple choice questions will have one column for each choice with
|
|
|
|
labels like 'questionnumber-choice'.
|
|
|
|
|
|
|
|
The items in the answers list are unicode strings or empty strings
|
|
|
|
if no answer was given. The number of elements in each answer list will
|
|
|
|
always match the number of headings.
|
2010-04-20 01:12:39 +00:00
|
|
|
"""
|
|
|
|
if answers is None:
|
|
|
|
answers = Answer.objects.all()
|
|
|
|
answers = answers.filter(
|
|
|
|
question__questionset__questionnaire=questionnaire).order_by(
|
|
|
|
'subject', 'runid', 'question__questionset__sortid', 'question__number')
|
2010-12-23 15:21:29 +00:00
|
|
|
answers = answers.select_related()
|
|
|
|
questions = Question.objects.filter(
|
|
|
|
questionset__questionnaire=questionnaire)
|
|
|
|
headings = _table_headers(questions)
|
2010-04-20 01:12:39 +00:00
|
|
|
|
2009-05-17 11:34:55 +00:00
|
|
|
coldict = {}
|
2010-04-20 01:12:39 +00:00
|
|
|
for num, col in enumerate(headings): # use coldict to find column indexes
|
2010-03-23 16:03:19 +00:00
|
|
|
coldict[col] = num
|
2010-12-23 15:21:29 +00:00
|
|
|
# collect choices for each question
|
|
|
|
qchoicedict = {}
|
|
|
|
for q in questions:
|
|
|
|
qchoicedict[q.id] = [x[0] for x in q.choice_set.values_list('value')]
|
|
|
|
|
2010-03-23 16:03:19 +00:00
|
|
|
runid = subject = None
|
2010-04-20 01:12:39 +00:00
|
|
|
out = []
|
2010-03-23 16:03:19 +00:00
|
|
|
row = []
|
2009-05-17 11:34:55 +00:00
|
|
|
for answer in answers:
|
|
|
|
if answer.runid != runid or answer.subject != subject:
|
2010-03-23 16:03:19 +00:00
|
|
|
if row:
|
2010-04-20 01:12:39 +00:00
|
|
|
out.append((subject, runid, row))
|
2009-05-17 11:34:55 +00:00
|
|
|
runid = answer.runid
|
|
|
|
subject = answer.subject
|
2010-12-22 16:32:25 +00:00
|
|
|
row = [""] * len(headings)
|
2010-04-18 17:20:11 +00:00
|
|
|
ans = answer.split_answer()
|
2011-09-28 13:45:46 +00:00
|
|
|
if type(ans) == int:
|
|
|
|
ans = str(ans)
|
2010-03-23 16:03:19 +00:00
|
|
|
for choice in ans:
|
|
|
|
col = None
|
|
|
|
if type(choice) == list:
|
|
|
|
# freeform choice
|
|
|
|
choice = choice[0]
|
|
|
|
col = coldict.get(answer.question.number + '-freeform', None)
|
2010-04-20 17:22:43 +00:00
|
|
|
if col is None: # look for enumerated choice column (multiple-choice)
|
2010-03-23 16:03:19 +00:00
|
|
|
col = coldict.get(answer.question.number + '-' + choice, None)
|
2010-04-20 17:22:43 +00:00
|
|
|
if col is None: # single-choice items
|
2010-12-23 15:21:29 +00:00
|
|
|
if ((not qchoicedict[answer.question.id]) or
|
|
|
|
choice in qchoicedict[answer.question.id]):
|
2010-04-08 14:45:27 +00:00
|
|
|
col = coldict.get(answer.question.number, None)
|
2010-04-20 17:22:43 +00:00
|
|
|
if col is None: # last ditch, if not found throw it in a freeform column
|
2010-03-23 16:03:19 +00:00
|
|
|
col = coldict.get(answer.question.number + '-freeform', None)
|
2010-04-20 17:22:43 +00:00
|
|
|
if col is not None:
|
2010-12-22 16:32:25 +00:00
|
|
|
row[col] = choice
|
2009-05-17 11:34:55 +00:00
|
|
|
# and don't forget about the last one
|
2010-03-23 16:03:19 +00:00
|
|
|
if row:
|
2010-04-20 01:12:39 +00:00
|
|
|
out.append((subject, runid, row))
|
|
|
|
return headings, out
|
2009-05-17 11:34:55 +00:00
|
|
|
|
2010-04-18 17:20:54 +00:00
|
|
|
def answer_summary(questionnaire, answers=None):
|
|
|
|
"""
|
|
|
|
questionnaire -- questionnaire model for summary
|
|
|
|
answers -- query set of answers to include in summary, defaults to all
|
|
|
|
|
|
|
|
Return a summary of the answer totals in answer_qs in the form:
|
|
|
|
[('q1', 'question1 text',
|
|
|
|
[('choice1', 'choice1 text', num), ...],
|
|
|
|
['freeform1', ...]), ...]
|
|
|
|
|
|
|
|
questions are returned in questionnaire order
|
|
|
|
choices are returned in question order
|
|
|
|
freeform options are case-insensitive sorted
|
|
|
|
"""
|
|
|
|
|
2010-04-19 15:57:57 +00:00
|
|
|
if answers is None:
|
2010-04-18 17:20:54 +00:00
|
|
|
answers = Answer.objects.all()
|
|
|
|
answers = answers.filter(question__questionset__questionnaire=questionnaire)
|
|
|
|
questions = Question.objects.filter(
|
|
|
|
questionset__questionnaire=questionnaire).order_by(
|
|
|
|
'questionset__sortid', 'number')
|
|
|
|
|
|
|
|
summary = []
|
|
|
|
for question in questions:
|
|
|
|
total = 0
|
|
|
|
q_type = question.get_type()
|
|
|
|
if q_type.startswith('choice-yesno'):
|
|
|
|
choices = [('yes', _('Yes')), ('no', _('No'))]
|
|
|
|
if 'dontknow' in q_type:
|
|
|
|
choices.append(('dontknow', _("Don't Know")))
|
|
|
|
elif q_type.startswith('choice'):
|
|
|
|
choices = [(c.value, c.text) for c in question.choices()]
|
|
|
|
else:
|
|
|
|
choices = []
|
|
|
|
choice_totals = dict([(k, 0) for k, v in choices])
|
|
|
|
freeforms = []
|
|
|
|
for a in answers.filter(question=question):
|
|
|
|
ans = a.split_answer()
|
|
|
|
for choice in ans:
|
|
|
|
if type(choice) == list:
|
|
|
|
freeforms.extend(choice)
|
|
|
|
elif choice in choice_totals:
|
|
|
|
choice_totals[choice] += 1
|
|
|
|
else:
|
|
|
|
# be tolerant of improperly marked data
|
|
|
|
freeforms.append(choice)
|
|
|
|
freeforms.sort(numal_sort)
|
|
|
|
summary.append((question.number, question.text, [
|
|
|
|
(n, t, choice_totals[n]) for (n, t) in choices], freeforms))
|
|
|
|
return summary
|
|
|
|
|
2011-12-21 13:53:00 +00:00
|
|
|
def has_tag(runinfo, tag):
|
|
|
|
""" Returns true if the given runinfo contains the given tag. """
|
|
|
|
return tag in [t.strip() for t in runinfo.tags.split(',')]
|
2009-05-17 11:34:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
def dep_check(expr, runinfo, answerdict):
|
|
|
|
"""
|
|
|
|
Given a comma separated question number and expression, determine if the
|
|
|
|
provided answer to the question number satisfies the expression.
|
|
|
|
|
|
|
|
If the expression starts with >, >=, <, or <=, compare the rest of
|
|
|
|
the expression numerically and return False if it's not able to be
|
|
|
|
converted to an integer.
|
|
|
|
|
|
|
|
If the expression starts with !, return true if the rest of the expression
|
|
|
|
does not match the answer.
|
|
|
|
|
|
|
|
Otherwise return true if the expression matches the answer.
|
|
|
|
|
|
|
|
If there is no comma and only a question number, it checks if the answer
|
|
|
|
is "yes"
|
|
|
|
|
|
|
|
When looking up the answer, it first checks if it's in the answerdict,
|
|
|
|
then it checks runinfo's cookies, then it does a database lookup to find
|
|
|
|
the answer.
|
|
|
|
|
|
|
|
The use of the comma separator is purely historical.
|
|
|
|
"""
|
|
|
|
questionnaire = runinfo.questionset.questionnaire
|
|
|
|
if "," not in expr:
|
|
|
|
expr = expr + ",yes"
|
|
|
|
check_questionnum, check_answer = expr.split(",",1)
|
|
|
|
try:
|
|
|
|
check_question = Question.objects.get(number=check_questionnum,
|
|
|
|
questionset__questionnaire = questionnaire)
|
|
|
|
except Question.DoesNotExist:
|
|
|
|
return False
|
|
|
|
if check_question in answerdict:
|
2010-03-01 17:12:40 +00:00
|
|
|
# test for membership in multiple choice questions
|
|
|
|
# FIXME: only checking answerdict
|
|
|
|
for k, v in answerdict[check_question].items():
|
|
|
|
if not k.startswith('multiple_'):
|
|
|
|
continue
|
|
|
|
if check_answer.startswith("!"):
|
|
|
|
if check_answer[1:].strip() == v.strip():
|
|
|
|
return False
|
|
|
|
elif check_answer.strip() == v.strip():
|
|
|
|
return True
|
2009-05-17 11:34:55 +00:00
|
|
|
actual_answer = answerdict[check_question].get('ANSWER', '')
|
|
|
|
elif runinfo.get_cookie(check_questionnum, False):
|
|
|
|
actual_answer = runinfo.get_cookie(check_questionnum)
|
|
|
|
else:
|
|
|
|
# retrieve from database
|
|
|
|
logging.warn("Put `store` in checks field for question %s" \
|
|
|
|
% check_questionnum)
|
|
|
|
ansobj = Answer.objects.filter(question=check_question,
|
|
|
|
runid=runinfo.runid, subject=runinfo.subject)
|
|
|
|
if ansobj:
|
2010-04-20 12:35:48 +00:00
|
|
|
actual_answer = ansobj[0].split_answer()[0]
|
2009-05-17 11:34:55 +00:00
|
|
|
else:
|
|
|
|
actual_answer = None
|
|
|
|
if actual_answer is None:
|
|
|
|
actual_answer = u''
|
|
|
|
if check_answer[0:1] in "<>":
|
|
|
|
try:
|
|
|
|
actual_answer = float(actual_answer)
|
|
|
|
if check_answer[1:2] == "=":
|
|
|
|
check_value = float(check_answer[2:])
|
|
|
|
else:
|
|
|
|
check_value = float(check_answer[1:])
|
|
|
|
except:
|
|
|
|
logging.error("ERROR: must use numeric values with < <= => > checks (%r)" % check_question)
|
|
|
|
return False
|
|
|
|
if check_answer.startswith("<="):
|
|
|
|
return actual_answer <= check_value
|
|
|
|
if check_answer.startswith(">="):
|
|
|
|
return actual_answer >= check_value
|
|
|
|
if check_answer.startswith("<"):
|
|
|
|
return actual_answer < check_value
|
|
|
|
if check_answer.startswith(">"):
|
|
|
|
return actual_answer > check_value
|
|
|
|
if check_answer.startswith("!"):
|
|
|
|
return check_answer[1:].strip() != actual_answer.strip()
|
|
|
|
return check_answer.strip() == actual_answer.strip()
|
|
|
|
|
2009-12-23 08:42:53 +00:00
|
|
|
@permission_required("questionnaire.management")
|
2009-05-17 11:34:55 +00:00
|
|
|
def send_email(request, runinfo_id):
|
|
|
|
if request.method != "POST":
|
|
|
|
return HttpResponse("This page MUST be called as a POST request.")
|
|
|
|
runinfo = get_object_or_404(RunInfo, pk=int(runinfo_id))
|
|
|
|
successful = _send_email(runinfo)
|
|
|
|
return r2r("emailsent.html", request, runinfo=runinfo, successful=successful)
|
2009-12-24 11:41:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
def generate_run(request, questionnaire_id):
|
|
|
|
"""
|
|
|
|
A view that can generate a RunID instance anonymously,
|
|
|
|
and then redirect to the questionnaire itself.
|
|
|
|
|
|
|
|
It uses a Subject with the givenname of 'Anonymous' and the
|
|
|
|
surname of 'User'. If this Subject does not exist, it will
|
|
|
|
be created.
|
|
|
|
|
|
|
|
This can be used with a URL pattern like:
|
|
|
|
(r'^take/(?P<questionnaire_id>[0-9]+)/$', 'questionnaire.views.generate_run'),
|
|
|
|
"""
|
|
|
|
qu = get_object_or_404(Questionnaire, id=questionnaire_id)
|
|
|
|
qs = qu.questionsets()[0]
|
|
|
|
su = Subject.objects.filter(givenname='Anonymous', surname='User')[0:1]
|
|
|
|
if su:
|
|
|
|
su = su[0]
|
|
|
|
else:
|
|
|
|
su = Subject(givenname='Anonymous', surname='User')
|
|
|
|
su.save()
|
|
|
|
hash = md5.new()
|
|
|
|
hash.update("".join(map(lambda i: chr(random.randint(0, 255)), range(16))))
|
|
|
|
hash.update(settings.SECRET_KEY)
|
|
|
|
key = hash.hexdigest()
|
|
|
|
run = RunInfo(subject=su, random=key, runid=key, questionset=qs)
|
|
|
|
run.save()
|
|
|
|
return HttpResponseRedirect(reverse('questionnaire', kwargs={'runcode': key}))
|
|
|
|
|