~azzar1/unity/add-show-desktop-key

# IVLE - Informatics Virtual Learning Environment

# Copyright (C) 2007-2008 The University of Melbourne

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

# Module: TutorialService

# Author: Matt Giuca

# Date:   25/1/2008

# Provides the AJAX backend for the tutorial application.

# This allows several actions to be performed on the code the student has

# typed into one of the problem boxes.

# Calling syntax

# Path must be empty.

# The arguments determine what is to be done on this file.

# "problem" - The path to a problem file (including the .xml extension),

#    relative to the subjects base directory.

# "code" - Full text of the student's code being submitted.

# "action". May be "test". (More to come).

# Returns a JSON response string indicating the results.

import os

import cjson

import test

import conf

def handle(req):

    """Handler for Ajax backend TutorialService app."""

    # Set request attributes

    req.write_html_head_foot = False     # No HTML

    if req.path != "":

        req.throw_error(req.HTTP_BAD_REQUEST)

    # Get all the arguments, if POST.

    # Ignore arguments if not POST, since we aren't allowed to cause

    # side-effects on the server.

    fields = req.get_fieldstorage()

    act = fields.getfirst('action')

    problem = fields.getfirst('problem')

    code = fields.getfirst('code')

    if problem == None or code == None or act == None:

        req.throw_error(req.HTTP_BAD_REQUEST)

    act = act.value

    problem = problem.value

    code = code.value

    if act == "test":

        handle_test(req, problem, code, fields)

    else:

        req.throw_error(req.HTTP_BAD_REQUEST)

def handle_test(req, problem, code, fields):

    """Handles a test action."""

    # First normalise the path

    problem = os.path.normpath(problem)

    # Now if it begins with ".." or separator, then it's illegal

    if problem.startswith("..") or problem.startswith(os.sep):

        problemfile = None

    else:

        problemfile = os.path.join(conf.subjects_base, problem)

    try:

        problemfile = open(problemfile)

    except (TypeError, IOError):    # TypeError if problemfile == None

        req.throw_error(req.HTTP_NOT_FOUND)

    # Parse the file into a problem object using the test suite

    problem_obj = test.parse_tutorial_file(problemfile)

    problemfile.close()

    # Run the test cases. Get the result back as a JSONable object.

    # Return it.

    test_results = problem_obj.run_tests(code)

    req.write(cjson.encode(test_results))