/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <p>
*/
package org.olat.modules.iq;
import java.io.File;
import java.util.Iterator;
import java.util.Set;
import org.apache.log4j.Logger;
import org.dom4j.Document;
import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.Component;
import org.olat.core.gui.components.htmlheader.jscss.JSAndCSSComponent;
import org.olat.core.gui.components.link.Link;
import org.olat.core.gui.components.link.LinkFactory;
import org.olat.core.gui.components.progressbar.ProgressBar;
import org.olat.core.gui.components.velocity.VelocityContainer;
import org.olat.core.gui.control.DefaultController;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.control.winmgr.BackHandler;
import org.olat.core.gui.translator.PackageTranslator;
import org.olat.core.gui.translator.Translator;
import org.olat.core.logging.AssertException;
import org.olat.core.logging.activity.LearningResourceLoggingAction;
import org.olat.core.logging.activity.StringResourceableType;
import org.olat.core.logging.activity.ThreadLocalUserActivityLogger;
import org.olat.core.util.StringHelper;
import org.olat.core.util.Util;
import org.olat.course.nodes.iq.IQEditController;
import org.olat.ims.qti.QTIConstants;
import org.olat.ims.qti.container.AssessmentContext;
import org.olat.ims.qti.navigator.Navigator;
import org.olat.ims.qti.process.AssessmentFactory;
import org.olat.ims.qti.process.AssessmentInstance;
import org.olat.ims.qti.process.FilePersister;
import org.olat.ims.qti.process.ImsRepositoryResolver;
import org.olat.ims.qti.process.Persister;
import org.olat.ims.qti.process.Resolver;
import org.olat.modules.ModuleConfiguration;
import org.olat.repository.RepositoryEntry;
import org.olat.repository.RepositoryManager;
import org.olat.util.logging.activity.LoggingResourceable;
/**
* @author Felix Jost
*/
public class IQDisplayController extends DefaultController implements BackHandler {
private static final String PACKAGE = Util.getPackageName(IQDisplayController.class);
private static final String VELOCITY_ROOT = Util.getPackageVelocityRoot(IQDisplayController.class);
private static Logger log = Logger.getLogger(IQDisplayController.class.getName());
// used for logging
private static final String IMSQTI = "IMSQTI";
private VelocityContainer myContent;
private Translator translator;
private String repositorySoftkey = null;
private Resolver resolver = null;
private Persister persister = null;
private ProgressBar qtiscoreprogress, qtiquestionprogress;
private IQComponent qticomp;
private IQStatus qtistatus;
private IQManager iqm;
private IQSecurityCallback iqsec;
private ModuleConfiguration modConfig;
// TODO: make nicer separation
private long callingResId = 0;
private String callingResDetail = "";
private boolean ready;
private Link closeButton;
/**
* IMS QTI Display Controller used by the course nodes
*
* concurrency protection is solved on IQManager.
* -> do not make constructor public
* -> create controller only via IQManager
*
* @param moduleConfiguration
* @param secCallback
* @param ureq
* @param wControl
* @param callingResId
* @param callingResDetail
*/
IQDisplayController(ModuleConfiguration moduleConfiguration, IQSecurityCallback secCallback, UserRequest ureq,
WindowControl wControl, long callingResId, String callingResDetail) {
super(wControl);
ThreadLocalUserActivityLogger.log(LearningResourceLoggingAction.LEARNING_RESOURCE_OPEN, getClass());
this.modConfig = moduleConfiguration;
this.callingResId = callingResId;
this.callingResDetail = callingResDetail;
this.repositorySoftkey = (String) moduleConfiguration.get(IQEditController.CONFIG_KEY_REPOSITORY_SOFTKEY);
init(secCallback, ureq);
}
/**
* IMS QTI Display Controller used by QTI Editor for preview.
*
* concurrency protection is solved on IQManager.
* -> do not make constructor public
* -> create controller only via IQManager
*
* @param resolver
* @param type
* @param secCallback
* @param ureq
* @param wControl
*/
IQDisplayController(Resolver resolver, String type, IQSecurityCallback secCallback, UserRequest ureq, WindowControl wControl) {
super(wControl);
ThreadLocalUserActivityLogger.log(LearningResourceLoggingAction.LEARNING_RESOURCE_OPEN, getClass());
this.modConfig = new ModuleConfiguration();
modConfig.set(IQEditController.CONFIG_KEY_ENABLEMENU, Boolean.TRUE);
modConfig.set(IQEditController.CONFIG_KEY_TYPE, type);
modConfig.set(IQEditController.CONFIG_KEY_SEQUENCE, AssessmentInstance.QMD_ENTRY_SEQUENCE_ITEM);
modConfig.set(IQEditController.CONFIG_KEY_SCOREPROGRESS, Boolean.TRUE);
modConfig.set(IQEditController.CONFIG_KEY_QUESTIONPROGRESS, Boolean.FALSE);
modConfig.set(IQEditController.CONFIG_KEY_ENABLECANCEL, Boolean.TRUE);
modConfig.set(IQEditController.CONFIG_KEY_ENABLESUSPEND, Boolean.FALSE);
modConfig.set(IQEditController.CONFIG_KEY_SUMMARY, AssessmentInstance.QMD_ENTRY_SUMMARY_DETAILED);
modConfig.set(IQEditController.CONFIG_KEY_RENDERMENUOPTION, Boolean.FALSE);
this.resolver = resolver;
this.persister = null;
init(secCallback, ureq);
}
private void init(IQSecurityCallback secCallback, UserRequest ureq) {
this.iqsec = secCallback;
this.translator = new PackageTranslator(PACKAGE, ureq.getLocale());
this.ready = false;
// acquire the back-handling, so that (unintended) back-clicks will not throw you out of a test, but shows a message instead.
getWindowControl().getWindowBackOffice().acquireBackHandling(this);
iqm = IQManager.getInstance();
myContent = new VelocityContainer("olatmodiqrun", VELOCITY_ROOT + "/qti.html", translator, this);
// Check if fibautocompl.js and fibautocompl.css exists for enhance FIB autocomplete feature
Resolver autcompResolver = null;
if (resolver == null){
RepositoryEntry re = RepositoryManager.getInstance().lookupRepositoryEntryBySoftkey(repositorySoftkey, true);
autcompResolver = new ImsRepositoryResolver(re.getKey());
} else {
autcompResolver = this.resolver;
}
if (autcompResolver != null && autcompResolver.hasAutocompleteFiles()) {
// Add Autocomplte JS and CSS file to header
StringBuilder sb = new StringBuilder();
// must be like <script type="text/javascript" src="/olat/secstatic/qti/74579818809617/_unzipped_/fibautocompl.js"></script>
sb.append("<script type=\"text/javascript\" src=\"").append(autcompResolver.getStaticsBaseURI()).append("/").append(ImsRepositoryResolver.QTI_FIB_AUTOCOMPLETE_JS_FILE).append("\"></script>\n");
// must be like <link rel="StyleSheet" href="/olat/secstatic/qti/74579818809617/_unzipped_/fibautocompl.css" type="text/css" media="screen, print">
sb.append("<link rel=\"StyleSheet\" href=\"").append(autcompResolver.getStaticsBaseURI()).append("/").append(ImsRepositoryResolver.QTI_FIB_AUTOCOMPLETE_CSS_FILE).append("\" type=\"text/css\" media=\"screen\" >\n");
JSAndCSSComponent autoCompleteJsCss = new JSAndCSSComponent("auto_complete_js_css", this.getClass(), null, null, true, sb.toString());
myContent.put("autoCompleteJsCss", autoCompleteJsCss);
}
closeButton = LinkFactory.createButton("close", myContent, this);
qtiscoreprogress = new ProgressBar("qtiscoreprogress", 150, 0, 0, "");
myContent.put("qtiscoreprogress", qtiscoreprogress);
Boolean displayScoreProgress = (Boolean) modConfig.get(IQEditController.CONFIG_KEY_SCOREPROGRESS);
if (displayScoreProgress == null) displayScoreProgress = Boolean.TRUE; // migration,
// display
// menu
if (!displayScoreProgress.booleanValue()) qtiscoreprogress.setVisible(false);
myContent.contextPut("displayScoreProgress", displayScoreProgress);
qtiquestionprogress = new ProgressBar("qtiquestionprogress", 150, 0, 0, "");
myContent.put("qtiquestionprogress", qtiquestionprogress);
Boolean displayQuestionProgress = (Boolean) modConfig.get(IQEditController.CONFIG_KEY_QUESTIONPROGRESS);
if (displayQuestionProgress == null) displayQuestionProgress = Boolean.FALSE; // migration,
// don't
// display
// progress
if (!displayQuestionProgress.booleanValue()) qtiquestionprogress.setVisible(false);
myContent.contextPut("displayQuestionProgress", displayQuestionProgress);
Boolean displayMenu = (Boolean) modConfig.get(IQEditController.CONFIG_KEY_DISPLAYMENU);
if (displayMenu == null) displayMenu = Boolean.TRUE; // migration
myContent.contextPut("displayMenu", displayMenu);
Boolean enableCancel = (Boolean) modConfig.get(IQEditController.CONFIG_KEY_ENABLECANCEL);
if (enableCancel == null) {
if (modConfig.get(IQEditController.CONFIG_KEY_TYPE).equals(AssessmentInstance.QMD_ENTRY_TYPE_ASSESS)) enableCancel = Boolean.FALSE; // migration:
// disable
// cancel
// for
// assessments
else enableCancel = Boolean.TRUE; // migration: enable otherwise
}
myContent.contextPut("enableCancel", enableCancel);
Boolean enableSuspend = (Boolean) modConfig.get(IQEditController.CONFIG_KEY_ENABLESUSPEND);
if (enableSuspend == null) enableSuspend = Boolean.FALSE; // migration
myContent.contextPut("enableSuspend", enableSuspend);
qtistatus = new IQStatus(translator);
qtistatus.setPreview(iqsec.isPreview());
myContent.contextPut("qtistatus", qtistatus);
setInitialComponent(myContent);
// get the assessment
AssessmentInstance ai = null;
//
// IQManagers synchronizes display controller creation with qti editor, please see comment in qti editor
//
//synchronized (QTIEditorMainController.IS_SAVING) {
//QTIEditorMainController.IS_SAVING_RWL.readLock().lock();
//lock is now checked in the IQManager -> see there
//try{
if (repositorySoftkey != null) { // instantiate from repository
// build path information which will be used to store tempory qti file
String resourcePathInfo = this.callingResId + File.separator + this.callingResDetail;
ai = AssessmentFactory.createAssessmentInstance(ureq.getIdentity(), modConfig, iqsec.isPreview(),resourcePathInfo);
} else if (resolver != null) { // instantiate from given resolver
ai = AssessmentFactory.createAssessmentInstance(resolver, persister, modConfig);
}
//}finally{
//QTIEditorMainController.IS_SAVING_RWL.readLock().unlock();
//}
//}
// check for null instance or instance with no items
if (ai == null || ai.getAssessmentContext().getSectionContext(0).getItemContextCount() == 0) throw new AssertException(
"Assessment Instance was null or no sections/items found.");
if (!iqsec.isAllowed(ai)) { // security check
getWindowControl().setError(translator.translate("status.notallowed"));
return;
}
if (iqsec.attemptsLeft(ai) < 1) { // security check
// note: important: do not check on == 0 since the nr of attempts can be
// republished for the same test with a smaller number as the latest time.
getWindowControl().setInfo(translator.translate(ai.isSurvey() ? "status.survey.nomoreattempts" : "status.assess.nomoreattempts"));
return;
}
if (ai.isResuming()) {
getWindowControl().setInfo(translator.translate(ai.isSurvey() ? "status.survey.resumed" : "status.assess.resumed"));
}
ai.setPreview(iqsec.isPreview());
/*
* menu render option: render only section titles or titles and questions.
*/
Object tmp = modConfig.get(IQEditController.CONFIG_KEY_RENDERMENUOPTION);
Boolean renderSectionsOnly;
if (tmp == null) {
// migration
modConfig.set(IQEditController.CONFIG_KEY_RENDERMENUOPTION, Boolean.FALSE);
renderSectionsOnly = Boolean.FALSE;
}else {
renderSectionsOnly = (Boolean)tmp;
}
boolean enabledMenu = ((Boolean)modConfig.get(IQEditController.CONFIG_KEY_ENABLEMENU)).booleanValue();
boolean itemPageSequence = ((String)modConfig.get(IQEditController.CONFIG_KEY_SEQUENCE)).equals(AssessmentInstance.QMD_ENTRY_SEQUENCE_ITEM);
IQMenuDisplayConf mdc = new IQMenuDisplayConf(renderSectionsOnly.booleanValue(), enabledMenu, itemPageSequence);
qticomp = new IQComponent("qticomponent", translator, ai,mdc);
qticomp.addListener(this);
myContent.put("qticomp", qticomp);
if (!ai.isResuming()) {
Navigator navigator = ai.getNavigator();
navigator.startAssessment();
}
qtistatus.update(ai);
if (!qtistatus.isSurvey()) {
qtiscoreprogress.setMax(ai.getAssessmentContext().getMaxScore());
qtiscoreprogress.setActual(ai.getAssessmentContext().getScore());
}
qtiquestionprogress.setMax(Integer.parseInt(qtistatus.getMaxQuestions()));
qtiquestionprogress.setActual(Integer.parseInt(qtistatus.getQuestionPos()));
ready = true;
}
/**
* Wether the qti is ready to be launched.
*
* @return boolean
*/
public boolean isReady() {
return ready;
}
/**
* @see org.olat.core.gui.control.DefaultController#event(org.olat.core.gui.UserRequest,
* org.olat.core.gui.components.Component, org.olat.core.gui.control.Event)
*/
public void event(UserRequest ureq, Component source, Event event) {
if (source == myContent || source == qticomp) { // those must be links
String wfCommand = event.getCommand();
logAudit(ureq);
// process workflow
if (qticomp == null || qticomp.getAssessmentInstance() == null) { throw new RuntimeException("AssessmentInstance not valid."); }
AssessmentInstance ai = qticomp.getAssessmentInstance();
Navigator navig = ai.getNavigator();
if (wfCommand.equals("sitse")) { // submitItemorSection
navig.submitItems(iqm.getItemsInput(ureq)); //
if (ai.isClosed()) { // do all the finishing stuff
event(ureq, source, new Event(QTIConstants.QTI_WF_SUBMIT));
return;
}
} else if (wfCommand.equals("sflash")) { // submit flash answer
navig.submitItems(iqm.getItemsInput(ureq)); //
if (ai.isClosed()) { // do all the finishing stuff
event(ureq, source, new Event(QTIConstants.QTI_WF_SUBMIT));
return;
}
} else if (wfCommand.equals("git")) { // goToItem
String seid = ureq.getParameter("seid");
String itid = ureq.getParameter("itid");
if (seid!=null && seid.length()!=0 && itid!=null && itid.length()!=0) {
int sectionPos = Integer.parseInt(seid);
int itemPos = Integer.parseInt(itid);
navig.goToItem(sectionPos, itemPos);
}
} else if (wfCommand.equals("gse")) { // goToSection
String seid = ureq.getParameter("seid");
if (seid!=null && seid.length()!=0) {
int sectionPos = Integer.parseInt(seid);
navig.goToSection(sectionPos);
}
} else if (wfCommand.equals(QTIConstants.QTI_WF_SUBMIT)) { // submit
// Assessment
navig.submitAssessment();
// Persist data in all cases: test, selftest, surveys except previews
// In case of survey, data will be anonymized when reading from the
// table (using the archiver)
if (!qtistatus.isPreview()) {
iqm.persistResults(ai, callingResId, callingResDetail, ureq);
getWindowControl().setInfo(translator.translate("status.results.saved"));
} else {
getWindowControl().setInfo(translator.translate("status.results.notsaved"));
}
if (!qtistatus.isSurvey()) { // for test and self-assessment, generate
// detailed results
Document docResReporting = iqm.getResultsReporting(ai, ureq);
if (!iqsec.isPreview()) {
FilePersister.createResultsReporting(docResReporting, ureq.getIdentity(), ai.getFormattedType(), ai.getAssessID());
// Send score and passed to parent controller. Maybe it is necessary
// to save some data there
// Do this now and not later, maybe user will never click on
// 'close'...
AssessmentContext ac = ai.getAssessmentContext();
fireEvent(ureq, new IQSubmittedEvent(ac.getScore(), ac.isPassed(), ai.getAssessID()));
}
Boolean showResultsOnFinishObj = (Boolean)modConfig.get(IQEditController.CONFIG_KEY_RESULT_ON_FINISH);
boolean showResultsOnFinish = showResultsOnFinishObj==null || showResultsOnFinishObj!=null && showResultsOnFinishObj.booleanValue();
if (ai.getSummaryType() == AssessmentInstance.SUMMARY_NONE || !showResultsOnFinish) {
// do not display results reporting
myContent.contextPut("displayreporting", Boolean.FALSE);
} else { // display results reporting
String resReporting = iqm.transformResultsReporting(docResReporting, ureq.getLocale(), ai.getSummaryType() );
myContent.contextPut("resreporting", resReporting);
myContent.contextPut("displayreporting", Boolean.TRUE);
}
myContent.setPage(VELOCITY_ROOT + "/result.html");
} else {
// Send also finished event in case of survey
fireEvent(ureq, new IQSubmittedEvent());
}
} else if (wfCommand.equals(QTIConstants.QTI_WF_CANCEL)) { // cancel
// assessment
navig.cancelAssessment();
} else if (wfCommand.equals(QTIConstants.QTI_WF_SUSPEND)) { // suspend
// assessment
// just close the controller
fireEvent(ureq, Event.DONE_EVENT);
return;
} else if (wfCommand.equals("close")) {
qtistatus.update(null);
// Parent controller need to pop, if they pushed previously
fireEvent(ureq, Event.DONE_EVENT);
return;
}
qtistatus.update(ai);
if (!qtistatus.isSurvey()) qtiscoreprogress.setActual(ai.getAssessmentContext().getScore());
qtiquestionprogress.setActual(ai.getAssessmentContext().getItemPosWithinAssessment());
} else if (source == closeButton){ // close component
qtistatus.update(null);
// Parent controller need to pop, if they pushed previously
fireEvent(ureq, Event.DONE_EVENT);
return;
}
}
/**
* @param ureq
*/
private void logAudit(UserRequest ureq) {
Set params = ureq.getParameterSet();
StringBuilder sb = new StringBuilder();
for (Iterator iter = params.iterator(); iter.hasNext();) {
String paramName = (String) iter.next();
sb.append("|");
sb.append(paramName);
sb.append("=");
sb.append(ureq.getParameter(paramName));
}
log.info("qti audit logging: hreq=" + ureq.getHttpReq().getRequestURL() + ", params=" + sb.toString());
String command = ureq.getParameter("cid");
String qtiDetails = LoggingResourceable.restrictStringLength("cid="+command+StringHelper.stripLineBreaks(sb.toString()), LoggingResourceable.MAX_NAME_LEN);
ThreadLocalUserActivityLogger.log(QTILoggingAction.QTI_AUDIT, getClass(),
LoggingResourceable.wrapNonOlatResource(StringResourceableType.qtiParams, "", qtiDetails));
}
/**
* @see org.olat.core.gui.control.DefaultController#doDispose(boolean)
*/
protected void doDispose() {
// we are finished with the test, allow the use of the browser-back button again.
getWindowControl().getWindowBackOffice().releaseBackHandling(this);
}
/**
*
*/
public void browserBackOrForward(UserRequest ureq, int diff) {
// user is using back -> simply warn, do nothing more.
getWindowControl().setWarning(translator.translate("test.nobackusage"));
}
}