def add_job(task, inputdata, debug=False):
""" Add a job in the queue and returns a submission id.
task is a Task instance and inputdata is the input as a dictionary
If debug is true, more debug data will be saved
"""
if not User.is_logged_in():
raise Exception("A user must be logged in to submit an object")
username = User.get_username()
course = FrontendCourse(task.get_course_id())
obj = {
"courseid": task.get_course_id(),
"taskid": task.get_id(),
"input": get_gridfs().put(
json.dumps(inputdata)),
"status": "waiting",
"submitted_on": datetime.now()}
if course.is_group_course() and username not in course.get_staff(True):
group = get_database().groups.find_one({"course_id": task.get_course_id(), "users": username})
obj.update({"username": group["users"]})
else:
obj.update({"username": [username]})
submissionid = get_database().submissions.insert(obj)
PluginManager.get_instance().call_hook("new_submission", submissionid=submissionid, submission=obj, inputdata=inputdata)
get_job_manager().new_job(task, inputdata, (lambda job: _job_done_callback(submissionid, task, job)), "Frontend - {}".format(username), debug)
return submissionid
def add_batch_job(course, container_name, inputdata, launcher_name=None, skip_permission=False):
"""
Add a job in the queue and returns a batch job id.
inputdata is a dict containing all the keys of get_batch_container_metadata(container_name)[2] BUT the keys "course" and "submission" IF their
type is "file". (the content of the course and the submission will be automatically included by this function.)
The values associated are file-like objects for "file" types and strings for "text" types.
"""
if not skip_permission:
if not User.is_logged_in():
raise Exception("A user must be logged in to submit an object")
username = User.get_username()
launcher_name = launcher_name or username
if username not in course.get_admins():
raise Exception("The user must be an administrator to start a batch job")
if container_name not in INGIniousConfiguration.get("batch_containers", []):
raise Exception("This batch container is not allowed to be started")
container_args = get_job_manager().get_batch_container_metadata(container_name)[2]
if container_args is None:
raise Exception("This batch container is not available")
# Download the course content and submissions and add them to the input
if "course" in container_args and container_args["course"]["type"] == "file" and "course" not in inputdata:
inputdata["course"] = _get_course_data(course)
if "submissions" in container_args and container_args["submissions"]["type"] == "file" and "submissions" not in inputdata:
inputdata["submissions"] = _get_submissions_data(course)
obj = {"courseid": course.get_id(), 'container_name': container_name, "submitted_on": datetime.now()}
batch_job_id = get_database().batch_jobs.insert(obj)
launcher_name = launcher_name or "plugin"
get_job_manager().new_batch_job(container_name, inputdata, lambda r: _batch_job_done_callback(batch_job_id, r),
launcher_name="Frontend - {}".format(launcher_name))
return batch_job_id
def get_batch_container_metadata(container_name):
"""
Returns the arguments needed by a particular batch container.
:returns: a tuple in the form
("container title",
"container description in restructuredtext",
{"key":
{
"type:" "file", #or "text",
"path": "path/to/file/inside/input/dir", #not mandatory in file, by default "key"
"name": "name of the field", #not mandatory in file, default "key"
"description": "a short description of what this field is used for" #not mandatory, default ""
}
}
)
"""
if container_name not in INGIniousConfiguration.get("batch_containers", []):
raise Exception("This batch container is not allowed to be started")
return get_job_manager().get_batch_container_metadata(container_name)
