working on self assessment

common/lib/xmodule/xmodule/capa_module.py

@@ -29,10 +29,10 @@ TIMEDELTA_REGEX = re.compile(r'^((?P<days>\d+?) day(?:s?))?(\s)?((?P<hours>\d+?)
 
 def only_one(lst, default="", process=lambda x: x):
     """
-    If lst is empty, returns default
-    If lst has a single element, applies process to that element and returns it
-    Otherwise, raises an exeception
-    """
+If lst is empty, returns default
+If lst has a single element, applies process to that element and returns it
+Otherwise, raises an exeception
+"""
     if len(lst) == 0:
         return default
     elif len(lst) == 1:
@@ -43,14 +43,14 @@ def only_one(lst, default="", process=lambda x: x):
 
 def parse_timedelta(time_str):
     """
-    time_str: A string with the following components:
-        <D> day[s] (optional)
-        <H> hour[s] (optional)
-        <M> minute[s] (optional)
-        <S> second[s] (optional)
-
-    Returns a datetime.timedelta parsed from the string
-    """
+time_str: A string with the following components:
+<D> day[s] (optional)
+<H> hour[s] (optional)
+<M> minute[s] (optional)
+<S> second[s] (optional)
+
+Returns a datetime.timedelta parsed from the string
+"""
     parts = TIMEDELTA_REGEX.match(time_str)
     if not parts:
         return
@@ -71,9 +71,9 @@ class ComplexEncoder(json.JSONEncoder):
 
 class CapaModule(XModule):
     '''
-    An XModule implementing LonCapa format problems, implemented by way of
-    capa.capa_problem.LoncapaProblem
-    '''
+An XModule implementing LonCapa format problems, implemented by way of
+capa.capa_problem.LoncapaProblem
+'''
     icon_class = 'problem'
 
     js = {'coffee': [resource_string(__name__, 'js/src/capa/display.coffee'),
@@ -175,9 +175,9 @@ class CapaModule(XModule):
     @property
     def rerandomize(self):
         """
-        Property accessor that returns self.metadata['rerandomize'] in a
-        canonical form
-        """
+Property accessor that returns self.metadata['rerandomize'] in a
+canonical form
+"""
         rerandomize = self.metadata.get('rerandomize', 'always')
         if rerandomize in ("", "always", "true"):
             return "always"
@@ -203,7 +203,7 @@ class CapaModule(XModule):
 
     def get_progress(self):
         ''' For now, just return score / max_score
-        '''
+'''
         d = self.get_score()
         score = d['score']
         total = d['total']
@@ -224,7 +224,7 @@ class CapaModule(XModule):
 
     def get_problem_html(self, encapsulate=True):
         '''Return html for the problem. Adds check, reset, save buttons
-        as necessary based on the problem config and state.'''
+as necessary based on the problem config and state.'''
 
         try:
             html = self.lcp.get_html()
@@ -266,7 +266,7 @@ class CapaModule(XModule):
                 # Prepend a scary warning to the student
                 warning = '<div class="capa_reset">'\
                           '<h2>Warning: The problem has been reset to its initial state!</h2>'\
-                           'The problem\'s state was corrupted by an invalid submission. ' \
+                          'The problem\'s state was corrupted by an invalid submission. '\
                           'The submission consisted of:'\
                           '<ul>'
                 for student_answer in student_answers.values():
@@ -358,14 +358,14 @@ class CapaModule(XModule):
 
     def handle_ajax(self, dispatch, get):
         '''
-        This is called by courseware.module_render, to handle an AJAX call.
-        "get" is request.POST.
-
-        Returns a json dictionary:
-        { 'progress_changed' : True/False,
-          'progress' : 'none'/'in_progress'/'done',
-          <other request-specific values here > }
-        '''
+This is called by courseware.module_render, to handle an AJAX call.
+"get" is request.POST.
+
+Returns a json dictionary:
+{ 'progress_changed' : True/False,
+'progress' : 'none'/'in_progress'/'done',
+<other request-specific values here > }
+'''
         handlers = {
             'problem_get': self.get_problem,
             'problem_check': self.check_problem,
@@ -398,7 +398,7 @@ class CapaModule(XModule):
 
     def answer_available(self):
         ''' Is the user allowed to see an answer?
-        '''
+'''
         if self.show_answer == '':
             return False
 
@@ -425,14 +425,14 @@ class CapaModule(XModule):
 
     def update_score(self, get):
         """
-        Delivers grading response (e.g. from asynchronous code checking) to
-            the capa problem, so its score can be updated
+Delivers grading response (e.g. from asynchronous code checking) to
+the capa problem, so its score can be updated
 
-        'get' must have a field 'response' which is a string that contains the
-            grader's response
+'get' must have a field 'response' which is a string that contains the
+grader's response
 
-        No ajax return is needed. Return empty dict.
-        """
+No ajax return is needed. Return empty dict.
+"""
         queuekey = get['queuekey']
         score_msg = get['xqueue_body']
         self.lcp.update_score(score_msg, queuekey)
@@ -441,10 +441,10 @@ class CapaModule(XModule):
 
     def get_answer(self, get):
         '''
-        For the "show answer" button.
+For the "show answer" button.
 
-        Returns the answers: {'answers' : answers}
-        '''
+Returns the answers: {'answers' : answers}
+'''
         event_info = dict()
         event_info['problem_id'] = self.location.url()
         self.system.track_function('show_answer', event_info)
@@ -469,18 +469,18 @@ class CapaModule(XModule):
     # Figure out if we should move these to capa_problem?
     def get_problem(self, get):
         ''' Return results of get_problem_html, as a simple dict for json-ing.
-        { 'html': <the-html> }
+{ 'html': <the-html> }
 
-            Used if we want to reconfirm we have the right thing e.g. after
-            several AJAX calls.
-        '''
+Used if we want to reconfirm we have the right thing e.g. after
+several AJAX calls.
+'''
         return {'html': self.get_problem_html(encapsulate=False)}
 
     @staticmethod
     def make_dict_of_responses(get):
         '''Make dictionary of student responses (aka "answers")
-        get is POST dictionary.
-        '''
+get is POST dictionary.
+'''
         answers = dict()
         for key in get:
             # e.g. input_resistor_1 ==> resistor_1
@@ -500,11 +500,11 @@ class CapaModule(XModule):
 
     def check_problem(self, get):
         ''' Checks whether answers to a problem are correct, and
-            returns a map of correct/incorrect answers:
+returns a map of correct/incorrect answers:
 
-            {'success' : bool,
-             'contents' : html}
-            '''
+{'success' : bool,
+'contents' : html}
+'''
         event_info = dict()
         event_info['state'] = self.lcp.get_state()
         event_info['problem_id'] = self.location.url()
@@ -567,20 +567,20 @@ class CapaModule(XModule):
         # 'success' will always be incorrect
         event_info['correct_map'] = correct_map.get_dict()
         event_info['success'] = success
-	event_info['attempts'] = self.attempts
-        self.system.track_function('save_problem_check', event_info)
+event_info['attempts'] = self.attempts
+self.system.track_function('save_problem_check', event_info)
 
-	if hasattr(self.system,'psychometrics_handler'):	# update PsychometricsData using callback
+if hasattr(self.system,'psychometrics_handler'):	# update PsychometricsData using callback
     self.system.psychometrics_handler(self.get_instance_state())
 
-        # render problem into HTML
-        html = self.get_problem_html(encapsulate=False)
+# render problem into HTML
+html = self.get_problem_html(encapsulate=False)
 
-        return {'success': success,
+return {'success': success,
         'contents': html,
         }
 
-    def save_problem(self, get):
+def save_problem(self, get):
     '''
     Save the passed in answers.
     Returns a dict { 'success' : bool, ['error' : error-msg]},
@@ -614,7 +614,7 @@ class CapaModule(XModule):
     self.system.track_function('save_problem_fail', event_info)
     return {'success': True}
 
-    def reset_problem(self, get):
+def reset_problem(self, get):
     ''' Changes problem state to unfinished -- removes student answers,
     and causes problem to rerender itself.
 
@@ -654,9 +654,9 @@ class CapaModule(XModule):
 
 class CapaDescriptor(RawDescriptor):
     """
-    Module implementing problems in the LON-CAPA format,
-    as implemented by capa.capa_problem
-    """
+Module implementing problems in the LON-CAPA format,
+as implemented by capa.capa_problem
+"""
 
     module_class = CapaModule
 

common/lib/xmodule/xmodule/self_assessment_module.py

@@ -108,6 +108,341 @@ class SelfAssessmentModule(XModule):
             'ajax_url': self.system.ajax_url,
             })
 
+    def get_problem_html(self, encapsulate=True):
+        '''Return html for the problem.  Adds check, reset, save buttons
+        as necessary based on the problem config and state.'''
+
+        try:
+            html = self.lcp.get_html()
+        except Exception, err:
+            log.exception(err)
+
+            # TODO (vshnayder): another switch on DEBUG.
+            if self.system.DEBUG:
+                msg = (
+                    '[courseware.capa.capa_module] <font size="+1" color="red">'
+                    'Failed to generate HTML for problem %s</font>' %
+                    (self.location.url()))
+                msg += '<p>Error:</p><p><pre>%s</pre></p>' % str(err).replace('<', '&lt;')
+                msg += '<p><pre>%s</pre></p>' % traceback.format_exc().replace('<', '&lt;')
+                html = msg
+            else:
+                # We're in non-debug mode, and possibly even in production. We want
+                #   to avoid bricking of problem as much as possible
+
+                # Presumably, student submission has corrupted LoncapaProblem HTML.
+                #   First, pull down all student answers
+                student_answers = self.lcp.student_answers
+                answer_ids = student_answers.keys()
+
+                # Some inputtypes, such as dynamath, have additional "hidden" state that
+                #   is not exposed to the student. Keep those hidden
+                # TODO: Use regex, e.g. 'dynamath' is suffix at end of answer_id
+                hidden_state_keywords = ['dynamath']
+                for answer_id in answer_ids:
+                    for hidden_state_keyword in hidden_state_keywords:
+                        if answer_id.find(hidden_state_keyword) >= 0:
+                            student_answers.pop(answer_id)
+
+                #   Next, generate a fresh LoncapaProblem
+                self.lcp = LoncapaProblem(self.definition['data'], self.location.html_id(),
+                    state=None, # Tabula rasa
+                    seed=self.seed, system=self.system)
+
+                # Prepend a scary warning to the student
+                warning  = '<div class="capa_reset">'\
+                           '<h2>Warning: The problem has been reset to its initial state!</h2>'\
+                           'The problem\'s state was corrupted by an invalid submission. '\
+                           'The submission consisted of:'\
+                           '<ul>'
+                for student_answer in student_answers.values():
+                    if student_answer != '':
+                        warning += '<li>' + cgi.escape(student_answer) + '</li>'
+                warning += '</ul>'\
+                           'If this error persists, please contact the course staff.'\
+                           '</div>'
+
+                html = warning
+                try:
+                    html += self.lcp.get_html()
+                except Exception, err: # Couldn't do it. Give up
+                    log.exception(err)
+                    raise
+
+        content = {'name': self.display_name,
+                   'html': html,
+                   'weight': self.descriptor.weight,
+                   }
+
+        # We using strings as truthy values, because the terminology of the
+        # check button is context-specific.
+
+        # Put a "Check" button if unlimited attempts or still some left
+        if self.max_attempts is None or self.attempts < self.max_attempts-1:
+            check_button = "Check"
+        else:
+            # Will be final check so let user know that
+            check_button = "Final Check"
+
+        reset_button = True
+        save_button = True
+
+        # If we're after deadline, or user has exhausted attempts,
+        # question is read-only.
+        if self.closed():
+            check_button = False
+            reset_button = False
+            save_button = False
+
+        # User submitted a problem, and hasn't reset. We don't want
+        # more submissions.
+        if self.lcp.done and self.rerandomize == "always":
+            check_button = False
+            save_button = False
+
+        # Only show the reset button if pressing it will show different values
+        if self.rerandomize not in ["always", "onreset"]:
+            reset_button = False
+
+        # User hasn't submitted an answer yet -- we don't want resets
+        if not self.lcp.done:
+            reset_button = False
+
+        # We may not need a "save" button if infinite number of attempts and
+        # non-randomized. The problem author can force it. It's a bit weird for
+        # randomization to control this; should perhaps be cleaned up.
+        if (self.force_save_button == "false") and (self.max_attempts is None and self.rerandomize != "always"):
+            save_button = False
+
+        context = {'problem': content,
+                   'id': self.id,
+                   'check_button': check_button,
+                   'reset_button': reset_button,
+                   'save_button': save_button,
+                   'answer_available': self.answer_available(),
+                   'ajax_url': self.system.ajax_url,
+                   'attempts_used': self.attempts,
+                   'attempts_allowed': self.max_attempts,
+                   'progress': self.get_progress(),
+                   }
+
+        html = self.system.render_template('problem.html', context)
+        if encapsulate:
+            html = '<div id="problem_{id}" class="problem" data-url="{ajax_url}">'.format(
+                id=self.location.html_id(), ajax_url=self.system.ajax_url) + html + "</div>"
+
+        # cdodge: OK, we have to do two rounds of url reference subsitutions
+        # one which uses the 'asset library' that is served by the contentstore and the
+        # more global /static/ filesystem based static content.
+        # NOTE: rewrite_content_links is defined in XModule
+        # This is a bit unfortunate and I'm sure we'll try to considate this into
+        # a one step process.
+        html = rewrite_links(html, self.rewrite_content_links)
+
+        # now do the substitutions which are filesystem based, e.g. '/static/' prefixes
+        return self.system.replace_urls(html, self.metadata['data_dir'])
+
+    def handle_ajax(self, dispatch, get):
+        '''
+        This is called by courseware.module_render, to handle an AJAX call.
+        "get" is request.POST.
+
+        Returns a json dictionary:
+        { 'progress_changed' : True/False,
+          'progress' : 'none'/'in_progress'/'done',
+          <other request-specific values here > }
+        '''
+        handlers = {
+            'problem_get': self.get_problem,
+            'problem_check': self.check_problem,
+            'problem_reset': self.reset_problem,
+            'problem_save': self.save_problem,
+            'problem_show': self.get_answer,
+            'score_update': self.update_score,
+            }
+
+        if dispatch not in handlers:
+            return 'Error'
+
+        before = self.get_progress()
+        d = handlers[dispatch](get)
+        after = self.get_progress()
+        d.update({
+            'progress_changed': after != before,
+            'progress_status': Progress.to_js_status_str(after),
+            })
+        return json.dumps(d, cls=ComplexEncoder)
+
+    def closed(self):
+            ''' Is the student still allowed to submit answers? '''
+        if self.attempts == self.max_attempts:
+            return True
+        if self.close_date is not None and datetime.datetime.utcnow() > self.close_date:
+            return True
+
+        return False
+
+    def answer_available(self):
+        ''' Is the user allowed to see an answer?
+        '''
+        if self.show_answer == '':
+            return False
+
+        if self.show_answer == "never":
+            return False
+
+        # Admins can see the answer, unless the problem explicitly prevents it
+        if self.system.user_is_staff:
+            return True
+
+        if self.show_answer == 'attempted':
+            return self.attempts > 0
+
+        if self.show_answer == 'answered':
+            return self.lcp.done
+
+        if self.show_answer == 'closed':
+            return self.closed()
+
+        if self.show_answer == 'always':
+            return True
+
+        return False
+
+    # Figure out if we should move these to capa_problem?
+    def get_problem(self, get):
+        ''' Return results of get_problem_html, as a simple dict for json-ing.
+        { 'html': <the-html> }
+
+            Used if we want to reconfirm we have the right thing e.g. after
+            several AJAX calls.
+        '''
+        return {'html': self.get_problem_html(encapsulate=False)}
+
+        @staticmethod
+    def make_dict_of_responses(get):
+        '''Make dictionary of student responses (aka "answers")
+        get is POST dictionary.
+        '''
+        answers = dict()
+        for key in get:
+            # e.g. input_resistor_1 ==> resistor_1
+            _, _, name = key.partition('_')
+
+            # This allows for answers which require more than one value for
+            # the same form input (e.g. checkbox inputs). The convention is that
+            # if the name ends with '[]' (which looks like an array), then the
+            # answer will be an array.
+            if not name.endswith('[]'):
+                answers[name] = get[key]
+            else:
+                name = name[:-2]
+                answers[name] = get.getlist(key)
+
+        return answers
+
+    def check_problem(self, get):
+        ''' Checks whether answers to a problem are correct, and
+            returns a map of correct/incorrect answers:
+
+            {'success' : bool,
+             'contents' : html}
+        '''
+        event_info = dict()
+        event_info['state'] = self.lcp.get_state()
+        event_info['problem_id'] = self.location.url()
+
+        answers = self.make_dict_of_responses(get)
+        event_info['answers'] = convert_files_to_filenames(answers)
+
+        parsed_answer=False
+        if(answer[answers.keys()[0]]=="True"):
+            parsed_answer=True
+
+        # Too late. Cannot submit
+        if self.closed():
+            event_info['failure'] = 'closed'
+            self.system.track_function('save_problem_check_fail', event_info)
+            raise NotFoundError('Problem is closed')
+
+        try:
+            old_state = self.lcp.get_state()
+            lcp_id = self.lcp.problem_id
+            correct_map = self.lcp.grade_answers(answers)
+            correct_map.set(correctness=parsed_answer)
+        except StudentInputError as inst:
+            # TODO (vshnayder): why is this line here?
+            #self.lcp = LoncapaProblem(self.definition['data'],
+            #                          id=lcp_id, state=old_state, system=self.system)
+            log.exception("StudentInputError in capa_module:problem_check")
+            return {'success': inst.message}
+        except Exception, err:
+            # TODO: why is this line here?
+            #self.lcp = LoncapaProblem(self.definition['data'],
+            #                          id=lcp_id, state=old_state, system=self.system)
+            if self.system.DEBUG:
+                msg = "Error checking problem: " + str(err)
+                msg += '\nTraceback:\n' + traceback.format_exc()
+                return {'success': msg}
+            log.exception("Error in capa_module problem checking")
+            raise Exception("error in capa_module")
+
+        self.attempts = self.attempts + 1
+        self.lcp.done = True
+
+        # success = correct if ALL questions in this problem are correct
+        success = 'correct'
+        for answer_id in correct_map:
+            if not correct_map.is_correct(answer_id):
+                success = 'incorrect'
+
+        # NOTE: We are logging both full grading and queued-grading submissions. In the latter,
+        #       'success' will always be incorrect
+        event_info['correct_map'] = correct_map.get_dict()
+        event_info['success'] = success
+        event_info['attempts'] = self.attempts
+        self.system.track_function('save_problem_check', event_info)
+
+        # render problem into HTML
+        html = self.get_problem_html(encapsulate=False)
+
+        return {'success': success,
+                'contents': html,
+                }
+
+    def save_problem(self, get):
+        '''
+        Save the passed in answers.
+        Returns a dict { 'success' : bool, ['error' : error-msg]},
+        with the error key only present if success is False.
+        '''
+        event_info = dict()
+        event_info['state'] = self.lcp.get_state()
+        event_info['problem_id'] = self.location.url()
+
+        answers = self.make_dict_of_responses(get)
+        event_info['answers'] = answers
+
+        # Too late. Cannot submit
+        if self.closed():
+            event_info['failure'] = 'closed'
+            self.system.track_function('save_problem_fail', event_info)
+            return {'success': False,
+                    'error': "Problem is closed"}
+
+        # Problem submitted. Student should reset before saving
+        # again.
+        if self.lcp.done and self.rerandomize == "always":
+            event_info['failure'] = 'done'
+            self.system.track_function('save_problem_fail', event_info)
+            return {'success': False,
+                    'error': "Problem needs to be reset prior to save."}
+
+        self.lcp.student_answers = answers
+
+        # TODO: should this be save_problem_fail?  Looks like success to me...
+        self.system.track_function('save_problem_fail', event_info)
+        return {'success': True}
 
 
 class SelfAssessmentDescriptor(XmlDescriptor, EditingDescriptor):