Java tutorial
/********************************************************************************** * $URL$ * $Id$ *********************************************************************************** * * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Etudes, Inc. * * Portions completed before September 1, 2008 * Copyright (c) 2007, 2008 The Regents of the University of Michigan & Foothill College, ETUDES Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * **********************************************************************************/ package org.etudes.mneme.tool; import java.io.IOException; import java.util.Date; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.etudes.ambrosia.api.Context; import org.etudes.ambrosia.api.UiService; import org.etudes.ambrosia.util.ControllerImpl; import org.etudes.mneme.api.AssessmentClosedException; import org.etudes.mneme.api.AssessmentPermissionException; import org.etudes.mneme.api.AssessmentService; import org.etudes.mneme.api.Submission; import org.etudes.mneme.api.SubmissionCompletedException; import org.etudes.mneme.api.SubmissionService; import org.sakaiproject.tool.api.ToolManager; import org.sakaiproject.util.StringUtil; import org.sakaiproject.util.Web; /** * The /question view for the mneme tool. */ public class TocView extends ControllerImpl { /** Our log. */ private static Log M_log = LogFactory.getLog(TocView.class); /** * Handle the many cases of a post that completes the submission * * @param req * Servlet request. * @param res * Servlet response. * @param context * The UiContext. * @param submissionId * the selected submission id. * @param uiService * the UI service. * @param assessmentService * the Assessment service. * @param returnDestination * The final return destination path. */ protected static void submissionCompletePost(HttpServletRequest req, HttpServletResponse res, Context context, String submissionId, UiService uiService, SubmissionService assessmentService, String returnDestination) throws IOException { // if (!context.getPostExpected()) // { // // redirect to error // res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unexpected))); // return; // } // read form String destination = uiService.decode(req, context); Boolean autoComplete = Boolean.FALSE; boolean destinationOkOverride = false; Submission submission = assessmentService.getSubmission(submissionId); if (destination.equals("SUBMIT")) { // if linear, or the submission is all answered, we can go to submitted if ((!submission.getAssessment().getRandomAccess()) || (submission.getIsAnswered())) { destination = "/submitted/" + submissionId + returnDestination; // we will complete below } // if not linear, and there are unanswered parts, send to final review else { destination = "/final_review/" + submissionId + returnDestination; // we do not want to complete - redirect now res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, destination))); return; } } else if (destination.equals("AUTO")) { // check if this submission is really done (time over, past deadline) if (submission.getIsOver(new Date(), 0)) { autoComplete = Boolean.TRUE; destination = "/submitted/" + submissionId + returnDestination; } else { // if for some reason we are here (AUTO) but the submission is not yet really over, just return to list destination = "/list"; // we do not want to complete - redirect now res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, destination))); return; } } // we need to be headed to submitted... if (!destination.startsWith("/submitted")) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.invalidpost))); return; } try { assessmentService.completeSubmission(submission, autoComplete); // if no exception, it worked! redirect res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, destination))); return; } catch (AssessmentClosedException e) { } catch (SubmissionCompletedException e) { } catch (AssessmentPermissionException e) { } // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); } /** Dependency: AssessmentService. */ protected AssessmentService assessmentService = null; /** Dependency: SubmissionService. */ protected SubmissionService submissionService = null; /** tool manager reference. */ protected ToolManager toolManager = null; /** * Shutdown. */ public void destroy() { M_log.info("destroy()"); } /** * {@inheritDoc} */ public void get(HttpServletRequest req, HttpServletResponse res, Context context, String[] params) throws IOException { // we need one parameter (sid) then return if (params.length < 3) { throw new IllegalArgumentException(); } String submissionId = params[2]; String destination = null; if (params.length > 3) { destination = "/" + StringUtil.unsplit(params, 3, params.length - 3, "/"); } // if not specified, go to the main list view else { destination = "/list"; } context.put("return", destination); Submission submission = submissionService.getSubmission(submissionId); if (submission == null) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.invalid))); return; } if (!submissionService.allowCompleteSubmission(submission)) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); return; } // validity check if (!submission.getAssessment().getIsValid()) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); return; } // linear is not allowed in here if (!submission.getAssessment().getRandomAccess()) { // redirect to error res.sendRedirect( res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.linear + "/" + submissionId))); return; } // collect information: the selected assessment (id the request) context.put("submission", submission); context.put("finalReview", Boolean.FALSE); // for the tool navigation if (this.assessmentService.allowManageAssessments(toolManager.getCurrentPlacement().getContext())) { context.put("maintainer", Boolean.TRUE); } // render uiService.render(ui, context); } /** * Final initialization, once all dependencies are set. */ public void init() { super.init(); M_log.info("init()"); } /** * {@inheritDoc} */ public void post(HttpServletRequest req, HttpServletResponse res, Context context, String[] params) throws IOException { // sid then return if (params.length < 3) { throw new IllegalArgumentException(); } String returnDestination = null; if (params.length > 3) { returnDestination = "/" + StringUtil.unsplit(params, 3, params.length - 3, "/"); } // if not specified, go to the main list view else { returnDestination = "/list"; } // read form String destination = this.uiService.decode(req, context); // if other than the /submitted destination, just go there if ((!destination.startsWith("/submitted")) && (!destination.equals("AUTO"))) { res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, destination))); return; } String submissionId = params[2]; // this post is from the timer, or the "submit" button, and completes the submission submissionCompletePost(req, res, context, submissionId, this.uiService, this.submissionService, returnDestination); } /** * Set the assessment service. * * @param service * The assessment service. */ public void setAssessmentService(AssessmentService service) { this.assessmentService = service; } /** * Set the submission service. * * @param service * The submission service. */ public void setSubmissionService(SubmissionService service) { this.submissionService = service; } /** * Set the tool manager. * * @param manager * The tool manager. */ public void setToolManager(ToolManager manager) { toolManager = manager; } }