Java tutorial
/********************************************************************************** * $URL$ * $Id$ *********************************************************************************** * * Copyright (c) 2008, 2009, 2010, 2011, 2013, 2014 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 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.PopulatingSet; import org.etudes.ambrosia.api.Values; import org.etudes.ambrosia.api.PopulatingSet.Factory; import org.etudes.ambrosia.api.PopulatingSet.Id; import org.etudes.ambrosia.util.ControllerImpl; import org.etudes.mneme.api.Assessment; import org.etudes.mneme.api.AssessmentPermissionException; import org.etudes.mneme.api.AssessmentPolicyException; import org.etudes.mneme.api.AssessmentService; import org.etudes.mneme.api.AssessmentType; import org.etudes.mneme.api.AttachmentService; import org.etudes.mneme.api.Part; import org.etudes.mneme.api.PartDetail; import org.etudes.mneme.api.Pool; import org.etudes.mneme.api.PoolService; import org.etudes.mneme.api.Question; import org.etudes.mneme.api.QuestionService; import org.sakaiproject.entity.api.EntityManager; import org.sakaiproject.entity.api.Reference; import org.sakaiproject.exception.IdUnusedException; import org.sakaiproject.site.api.Site; import org.sakaiproject.site.api.SiteService; import org.sakaiproject.site.api.ToolConfiguration; import org.sakaiproject.tool.api.ToolManager; import org.sakaiproject.util.StringUtil; import org.sakaiproject.util.Web; /** * The /assessment_edit view for the mneme tool. */ public class AssessmentEditView extends ControllerImpl { /** Our log. */ private static Log M_log = LogFactory.getLog(AssessmentEditView.class); /** Assessment service. */ protected AssessmentService assessmentService = null; /** Dependency: AttachmentService. */ protected AttachmentService attachmentService = null; /** Dependency: EntityManager. */ protected EntityManager entityManager = null; /** Dependency: Pool service. */ protected PoolService poolService = null; /** Dependency: Question service. */ protected QuestionService questionService = null; /** Dependency: SiteService */ protected SiteService siteService = 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 { // aid, return if (params.length < 3) { throw new IllegalArgumentException(); } String assessmentId = params[2]; String destination = null; if (params.length > 3) { destination = "/" + StringUtil.unsplit(params, 3, params.length - 3, "/"); } // if not specified, go to the main assessment view else { destination = "/assessments"; } context.put("return", destination); Assessment assessment = assessmentService.getAssessment(assessmentId); if (assessment == null) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.invalid))); return; } // security check if (!assessmentService.allowEditAssessment(assessment)) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); return; } // check for formal course evaluation permission if (assessmentService.allowSetFormalCourseEvaluation(assessment.getContext())) { context.put("allowEval", Boolean.TRUE); } // // clear the assessment of any empty parts (if not mint, which would end up causing it to become a stale mint and vanish!) // if (!assessment.getMint()) // { // try // { // assessment.getParts().removeEmptyParts(); // this.assessmentService.saveAssessment(assessment); // } // catch (AssessmentPermissionException e) // { // // redirect to error // res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); // return; // } // catch (AssessmentPolicyException e) // { // // redirect to error // res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.policy))); // return; // } // } try { Site site = this.siteService.getSite(toolManager.getCurrentPlacement().getContext()); ToolConfiguration config = site.getToolForCommonId("sakai.mneme"); if (config != null) toolId = config.getId(); context.put("toolId", toolId); } catch (IdUnusedException e) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); return; } // collect information: the selected assessment context.put("assessment", assessment); context.put("details", assessment.getParts().getPhantomDetails()); // value holders for the selection check boxes Values values = this.uiService.newValues(); context.put("ids", values); // 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 { // sort, aid, return if (params.length < 3) { throw new IllegalArgumentException(); } String assessmentId = params[2]; String returnDestination = null; if (params.length > 3) { returnDestination = "/" + StringUtil.unsplit(params, 3, params.length - 3, "/"); } // if not specified, go to the main assessment view else { returnDestination = "/assessments"; } final Assessment assessment = assessmentService.getAssessment(assessmentId); if (assessment == null) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.invalid))); return; } // security check if (!assessmentService.allowEditAssessment(assessment)) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); return; } // for editing the points PopulatingSet details = uiService.newPopulatingSet(new Factory() { public Object get(String id) { PartDetail detail = assessment.getParts().getDetailId(id); return detail; } }, new Id() { public String getId(Object o) { return ((PartDetail) o).getId(); } }); context.put("details", details); // setup the model: the selected assessment context.put("assessment", assessment); // value holders for the selection check boxes Values values = this.uiService.newValues(); context.put("ids", values); // for the upload of attachments Upload upload = new Upload(this.toolManager.getCurrentPlacement().getContext(), AttachmentService.DOCS_AREA, this.attachmentService); context.put("upload", upload); // read the form String destination = uiService.decode(req, context); // save the attachments upload if (upload.getUpload() != null) { assessment.getPresentation().addAttachment(upload.getUpload()); } // handle an attachments remove if (destination.startsWith("REMOVE:")) { String[] parts = StringUtil.split(destination, ":"); if (parts.length != 2) { throw new IllegalArgumentException(); } String refString = parts[1]; Reference ref = this.entityManager.newReference(refString); // remove from the assessment, but since the attachment was in the site's mneme docs and generally available, don't remove it assessment.getPresentation().removeAttachment(ref); // this.attachmentService.removeAttachment(ref); // stay here destination = context.getDestination(); } try { if (destination.equals("ADD")) { // use the first part, adding one if needed Part part = assessment.getParts().getFirst(); if (part == null) { part = assessment.getParts().addPart(); } // the assessment's pool, saving in case this is the creation of the pool Pool pool = assessment.getPool(); this.assessmentService.saveAssessment(assessment); // create a question - mc for test, essay for assignment, likert for survey assessment types String type = "mneme:MultipleChoice"; if (AssessmentType.assignment == assessment.getType()) { type = "mneme:Essay"; } else if (AssessmentType.survey == assessment.getType()) { type = "mneme:LikertScale"; } // create the question of the appropriate type (all the way to save) Question newQuestion = null; try { newQuestion = this.questionService.newQuestion(pool, type); } catch (AssessmentPermissionException e) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); return; } // create URL for add questions destination = "/question_edit/" + newQuestion.getId() + "/" + assessmentId + "/" + part.getId() + "/assessment_edit/" + assessmentId + returnDestination; } else if (destination.equals("DRAW")) { // use the first part, adding one if needed Part part = assessment.getParts().getFirst(); if (part == null) { part = assessment.getParts().addPart(); } // save this.assessmentService.saveAssessment(assessment); // create URL for select questions destination = "/draw_questions/" + assessmentId + "/" + part.getId() + "/0A/" + "assessment_edit/" + assessmentId + returnDestination; } else if (destination.equals("SELECT")) { // use the first part, adding one if needed Part part = assessment.getParts().getFirst(); if (part == null) { part = assessment.getParts().addPart(); } // save this.assessmentService.saveAssessment(assessment); // create URL for select questions destination = "/select_add_mpart_question/" + assessmentId + "/" + part.getId() + "/0A/-/0/0/B/" + "assessment_edit/" + assessmentId + returnDestination; } else if (destination.equals("REMOVE")) { // detail ids selected for removal for (String id : values.getValues()) { assessment.getParts().removeDetail(id); } // save this.assessmentService.saveAssessment(assessment); destination = context.getDestination(); } else if (destination.equals("PARTS")) { // save this.assessmentService.saveAssessment(assessment); destination = "/part_manage/" + assessmentId + "/assessment_edit/" + assessmentId + returnDestination; } else if (destination.equals("INSTRUCTIONS")) { // save this.assessmentService.saveAssessment(assessment); destination = "/instructions_edit/" + assessmentId + "/assessment_edit/" + assessmentId + returnDestination; } else if (destination.equals("REORDER") || (destination.equals("SAVE"))) { // save this.assessmentService.saveAssessment(assessment); destination = context.getDestination(); } else if (destination.equals("MOVE")) { // save this.assessmentService.saveAssessment(assessment); // format the selected ids StringBuilder buf = new StringBuilder(); for (String id : values.getValues()) { buf.append(id); buf.append("+"); } buf.setLength(buf.length() - 1); // destination to the detail move view destination = "/detail_move/" + assessmentId + "/" + buf.toString() + "/assessment_edit/" + assessmentId + returnDestination; } else if (destination.equals("SURVEY")) { // change to survey assessment.setType(AssessmentType.survey); // save this.assessmentService.saveAssessment(assessment); destination = context.getDestination(); } else if (destination.equals("EVALSEND")) { this.assessmentService.saveAssessment(assessment); destination = context.getDestination(); this.assessmentService.sendEvalNotification(assessment); } else { this.assessmentService.saveAssessment(assessment); } } catch (AssessmentPermissionException e) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.unauthorized))); return; } catch (AssessmentPolicyException e) { // redirect to error res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, "/error/" + Errors.policy))); return; } // redirect to the next destination res.sendRedirect(res.encodeRedirectURL(Web.returnUrl(req, destination))); } /** * Set the AssessmentService. * * @param service * The AssessmentService. */ public void setAssessmentService(AssessmentService service) { this.assessmentService = service; } /** * Set the AttachmentService. * * @param service * The AttachmentService. */ public void setAttachmentService(AttachmentService service) { this.attachmentService = service; } /** * Set the EntityManager. * * @param manager * The EntityManager. */ public void setEntityManager(EntityManager manager) { entityManager = manager; } /** * @param poolService * the poolService to set */ public void setPoolService(PoolService poolService) { this.poolService = poolService; } /** * @param questionService * the questionService to set */ public void setQuestionService(QuestionService questionService) { this.questionService = questionService; } /** * @param siteService * the siteService to set */ public void setSiteService(SiteService siteService) { this.siteService = siteService; } /** * Set the tool manager. * * @param manager * The tool manager. */ public void setToolManager(ToolManager manager) { toolManager = manager; } }