ConditionEditController.java

/**
* 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.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
*/

package org.olat.course.condition;

import java.util.List;

import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.Component;
import org.olat.core.gui.components.link.Link;
import org.olat.core.gui.components.link.LinkFactory;
import org.olat.core.gui.components.velocity.VelocityContainer;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.Event;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.control.controller.BasicController;
import org.olat.core.gui.translator.Translator;
import org.olat.core.logging.OLATRuntimeException;
import org.olat.core.util.Util;
import org.olat.course.condition.additionalconditions.AdditionalCondition;
import org.olat.course.condition.additionalconditions.PasswordCondition;
import org.olat.course.editor.CourseEditorEnv;
import org.olat.course.editor.EditorMainController;
import org.olat.course.nodes.AbstractAccessableCourseNode;
import org.olat.course.nodes.CourseNode;
import org.olat.course.run.userview.UserCourseEnvironment;
/**
 * Initial Date:  Apr 7, 2004
 * @author gnaegi
 * 
 * Comment: This controller can be used to display and edit OLAT node conditions. 
 * When the condition experssion has been changed, the controller will fire a Event.CHANGED_EVENT. 
 * See STCourseNodeEditController to get a usage example.
 */
public class ConditionEditController extends BasicController {
	
	//private static final String PACKAGE_EDITOR = Util.getPackageName(EditorMainController.class);
	private static final String VELOCITY_ROOT = Util.getPackageVelocityRoot(ConditionEditController.class);
	
	private VelocityContainer myContent;
	
	private ConditionConfigExpertForm conditionExpertForm;
	private Condition condition,validatedCondition;
	private List<CourseNode> nodeIdentList;
	
	private UserCourseEnvironment euce;
	private Link easyModeButton;
	private Link expertModeButton;
	private ConditionConfigEasyController conditionEasyCtrllr;
	// <OLATCE-91>
	private PasswordCondition passwordCondition;
	private Controller passwordConditionEditController;
	// </OLATCE-91>
		
	
	/**
	 * Create a controller which can edit a condition in easy and expert mode
	 * @param ureq User Request data
	 * @param wControl Owning window control
	 * @param euce 
	 * @param cond The condition which should be used to initialize the forms
	 * can then be used to embedd the condition form in your velocity container with $r.render("mainComponentName")
	 * @param nodeIdentList
	 */
	public ConditionEditController(UserRequest ureq, WindowControl wControl, UserCourseEnvironment euce,
			Condition cond, List<CourseNode> nodeIdentList) {
		this(ureq, wControl, cond, nodeIdentList, euce, false);
	}
	
	/**
	 * Create a controller which can edit a condition in easy and expert mode
	 * @param ureq User Request data
	 * @param wControl The window control
	 * @param groupMgr The course group manager
	 * @param cond The condition which should be used to initialize the forms
	 * @param formName Name of the condition form - must be unique within a HTML page
	 * @param nodeIdentList
	 * @param euce
	 * @param showPasswordAccess If you want to show the password condition
	 */
	public ConditionEditController(UserRequest ureq, WindowControl wControl,
				Condition cond, List<CourseNode> nodeIdentList, UserCourseEnvironment euce,
				boolean showPasswordAccess) {
		super(ureq, wControl);
		this.condition = cond;
		this.validatedCondition = cloneCondition(condition);
		if(this.condition==null) throw new OLATRuntimeException("CondititionEditController called with a NULL condition", new IllegalArgumentException());
		this.euce = euce;
		this.nodeIdentList = nodeIdentList;
		
		// Main component is a velocity container. It has a name choosen by the controller who
		// called this constructor
		myContent = createVelocityContainer("condedit");
		easyModeButton = LinkFactory.createButtonSmall("command.activate.easyMode", myContent, this);
		expertModeButton = LinkFactory.createButtonSmall("command.activate.expertMode", myContent, this);

		// init easy or expert mode form
		if (condition.isExpertMode()) {
			doExpertMode(ureq);
		} else {
			doEasyMode(ureq);
		}

		// <OLATCE-91>
		CourseEditorEnv courseEnv = euce.getCourseEditorEnv();
		CourseNode courseNode = courseEnv.getNode(courseEnv.getCurrentCourseNodeId());
		boolean isRootNode = courseEnv.getRootNodeId().equals(courseNode.getIdent());
		if(showPasswordAccess && courseNode instanceof AbstractAccessableCourseNode){
			AbstractAccessableCourseNode accessableCourseNode = (AbstractAccessableCourseNode)courseNode;
			for(AdditionalCondition addCond : accessableCourseNode.getAdditionalConditions()){
				if(addCond instanceof PasswordCondition){
					passwordCondition = (PasswordCondition) addCond;
				}
			}
			if ((passwordCondition == null) && (!isRootNode)) {
				passwordCondition = new PasswordCondition();
				accessableCourseNode.getAdditionalConditions().add(passwordCondition);
			}
			if ((passwordCondition != null) && (isRootNode)) {
				String pass = passwordCondition.getPassword();
				if ((pass == null) || (pass.length() == 0)) {
					accessableCourseNode.getAdditionalConditions().remove(passwordCondition);
					passwordCondition = null;
				}
			}
			if (passwordCondition != null) {
				passwordConditionEditController = passwordCondition.getEditorComponent(ureq, wControl);
				listenTo(passwordConditionEditController);
			}
		}
		// </OLATCE-91>
		
		putInitialPanel(myContent);
	}


	private Condition cloneCondition(Condition orig) {
		return orig.clone();
	}
	
	
	@Override
	protected void event(UserRequest ureq, org.olat.core.gui.control.Controller source, Event event) {
		if(source == conditionEasyCtrllr){
			if(event == Event.CHANGED_EVENT){
				//successfully changed condition - get condition - dispose and init cond
				validatedCondition = conditionEasyCtrllr.getCondition(); 
				condition = cloneCondition(validatedCondition);
				// Inform all listeners about the changed condition
				// this event goes to the NodeEditController and from there to the 
				// CourseEditorController which then saves the condition
				fireEvent(ureq, Event.CHANGED_EVENT);
			}
		} else if (source == conditionExpertForm) {
			if (event == Event.CANCELLED_EVENT) {
				this.validatedCondition = cloneCondition(condition);
				initExpertForm(ureq);
			}
			else if (event == Event.DONE_EVENT) {
				// Update condition data and switch to read only mode
				validatedCondition = conditionExpertForm.updateConditionFromFormData(validatedCondition); 
				condition = cloneCondition(validatedCondition);
				//we have copied the easy form data into the expert mode, we can clear now easy mode.
				validatedCondition.clearEasyConfig();
				
				// Inform all listeners about the changed condition
				fireEvent(ureq, Event.CHANGED_EVENT);
			}
		// <OLATCE-91>
		} else if (source == passwordConditionEditController ){
			fireEvent(ureq, event);
		// </OLATCE-91>
		}
	}

	
	/**
	 * @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 == easyModeButton){
			doEasyMode(ureq);
		}
		else if (source == expertModeButton){
			doExpertMode(ureq);
		}
	}
	
	private void doEasyMode(UserRequest ureq) {
		// cleanup first
		if (conditionExpertForm != null) {
			myContent.remove(conditionExpertForm.getInitialComponent());
		}
		
		// now initialize easy form
		initEasyForm(ureq);
		myContent.contextPut("isExpertMode", Boolean.FALSE);
	}

	private void initEasyForm(UserRequest ureq) {
		removeAsListenerAndDispose(conditionEasyCtrllr);
		conditionEasyCtrllr = new ConditionConfigEasyController(ureq, getWindowControl(), validatedCondition, nodeIdentList, euce.getCourseEditorEnv());
		listenTo(conditionEasyCtrllr);
		myContent.put("conditionEasyForm", conditionEasyCtrllr.getInitialComponent());		
	}
	
	private void doExpertMode(UserRequest ureq) {
		// cleanup first
		if (conditionEasyCtrllr != null) {
			myContent.remove(conditionEasyCtrllr.getInitialComponent());
			removeAsListenerAndDispose(conditionEasyCtrllr);
			conditionEasyCtrllr = null;
		}
		// now initialize expert form
		initExpertForm(ureq);
		myContent.contextPut("isExpertMode", Boolean.TRUE);
	}

	private void initExpertForm(UserRequest ureq) {
		removeAsListenerAndDispose(conditionExpertForm);
		conditionExpertForm = new ConditionConfigExpertForm(ureq, getWindowControl(), validatedCondition, euce);
		listenTo(conditionExpertForm);
		myContent.put("conditionExpertForm", conditionExpertForm.getInitialComponent());
	}

	/**
	 * Get the condition that has been configured by this controller
	 * @return Condition the configured condition
	 */
	public Condition getCondition() {
		return condition;
	}

	/**
	 * Get the condition editor wrapped as a generic accessability condition editor
	 * @param title The title of this access condition, displayed as header in the surrounding fieldset
	 * @return The wrapped condition editor component
	 */
	public VelocityContainer getWrappedDefaultAccessConditionVC(String title){
		Translator accessTranslator = Util.createPackageTranslator(EditorMainController.class, getLocale());
		VelocityContainer defaultAccessConditionView = new VelocityContainer("defaultAccessConditionView", VELOCITY_ROOT + "/defaultaccessedit.html", accessTranslator, null);
		defaultAccessConditionView.put("defaultAccessConditionView", myContent);
		if(passwordConditionEditController != null) {
			defaultAccessConditionView.put("pwcond", passwordConditionEditController.getInitialComponent());
			defaultAccessConditionView.contextPut("renderPW", true);
		}
		defaultAccessConditionView.contextPut("title", title);
		return defaultAccessConditionView;
	}
	
	/**
	 * 
	 * @see org.olat.core.gui.control.DefaultController#doDispose(boolean)
	 */
	@Override
	protected void doDispose() {
		// child controller disposed by basic controller
	}

}