PublishStep01.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.editor;

import java.util.ArrayList;
import java.util.List;

import org.olat.core.CoreSpringFactory;
import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.form.flexible.FormItemContainer;
import org.olat.core.gui.components.form.flexible.elements.SingleSelection;
import org.olat.core.gui.components.form.flexible.impl.Form;
import org.olat.core.gui.components.form.flexible.impl.FormLayoutContainer;
import org.olat.core.gui.control.Controller;
import org.olat.core.gui.control.WindowControl;
import org.olat.core.gui.control.generic.wizard.BasicStep;
import org.olat.core.gui.control.generic.wizard.PrevNextFinishConfig;
import org.olat.core.gui.control.generic.wizard.Step;
import org.olat.core.gui.control.generic.wizard.StepFormBasicController;
import org.olat.core.gui.control.generic.wizard.StepFormController;
import org.olat.core.gui.control.generic.wizard.StepsEvent;
import org.olat.core.gui.control.generic.wizard.StepsRunContext;
import org.olat.core.gui.translator.Translator;
import org.olat.core.util.Util;
import org.olat.course.ICourse;
import org.olat.login.LoginModule;
import org.olat.repository.RepositoryEntry;
import org.olat.repository.RepositoryModule;
import org.olat.repository.RepositoryService;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * Description:<br>
 * Select the BARG level
 * 
 * <P>
 * Initial Date:  21.01.2008 <br>
 * @author patrickb
 */
class PublishStep01 extends BasicStep {

	private PrevNextFinishConfig prevNextConfig;

	public PublishStep01(UserRequest ureq, ICourse course, boolean hasPublishableChanges, boolean hasCatalog) {
		super(ureq);
		setI18nTitleAndDescr("publish.access.header", null);
		
		RepositoryModule repositoryModule = CoreSpringFactory.getImpl(RepositoryModule.class);
		if(repositoryModule.isCatalogEnabled()) {
			setNextStep(new PublishStepCatalog(ureq, course, hasPublishableChanges));
			if(hasCatalog) {
				prevNextConfig = PrevNextFinishConfig.BACK_NEXT_FINISH;
			} else {
				prevNextConfig = PrevNextFinishConfig.BACK_NEXT;
			}
		} else if(hasPublishableChanges) {
			setNextStep(new PublishStep00a(ureq));
			prevNextConfig = PrevNextFinishConfig.BACK_NEXT_FINISH;
		} else {
			setNextStep(Step.NOSTEP);
			prevNextConfig = PrevNextFinishConfig.BACK_FINISH;
		}
	}

	/**
	 * @see org.olat.core.gui.control.generic.wizard.BasicStep#getInitialPrevNextFinishConfig()
	 */
	@Override
	public PrevNextFinishConfig getInitialPrevNextFinishConfig() {
		//can go back and finish immediately
		return prevNextConfig;
	}

	/**
	 * @see org.olat.core.gui.control.generic.wizard.BasicStep#getStepController(org.olat.core.gui.UserRequest, org.olat.core.gui.control.WindowControl, org.olat.core.gui.control.generic.wizard.StepsRunContext, org.olat.core.gui.components.form.flexible.impl.Form)
	 */
	@Override
	public StepFormController getStepController(UserRequest ureq, WindowControl wControl, StepsRunContext stepsRunContext, Form form) {
		return new PublishStep01AccessForm(ureq, wControl, form, stepsRunContext);
	}

	class PublishStep01AccessForm extends StepFormBasicController {

		private SingleSelection accessSelbox;
		private String selectedAccess;
		
		@Autowired
		private LoginModule loginModule;

		PublishStep01AccessForm(UserRequest ureq, WindowControl control, Form rootForm, StepsRunContext runContext) {
			super(ureq, control, rootForm, runContext, LAYOUT_VERTICAL, null);
			selectedAccess = (String) getFromRunContext("selectedCourseAccess");
			initForm(ureq);
		}

		@Override
		protected void doDispose() {
			//
		}

		@Override
		protected void formOK(UserRequest ureq) {
			String newAccess = accessSelbox.getKey(accessSelbox.getSelected());
			if(!selectedAccess.equals(newAccess)){
				//only change if access was changed
				addToRunContext("changedaccess", newAccess);
			}

			fireEvent(ureq, StepsEvent.ACTIVATE_NEXT);
		}

		@Override
		protected void initForm(FormItemContainer formLayout, Controller listener, UserRequest ureq) {
			Translator pt = Util.createPackageTranslator(RepositoryService.class, getLocale(), getTranslator());
			
			FormLayoutContainer fic = FormLayoutContainer.createCustomFormLayout("access", pt, velocity_root + "/publish_courseaccess.html");
			formLayout.add(fic);
			RepositoryModule repositoryModule = CoreSpringFactory.getImpl(RepositoryModule.class);
			fic.contextPut("catalogEnabled", repositoryModule.isCatalogEnabled());

			List<String> keyList = new ArrayList<String>();
			keyList.add(Integer.toString(RepositoryEntry.ACC_OWNERS));
			keyList.add(Integer.toString(RepositoryEntry.ACC_OWNERS_AUTHORS));
			keyList.add(Integer.toString(RepositoryEntry.ACC_USERS));
			if(loginModule.isGuestLoginLinksEnabled()) {
				keyList.add(Integer.toString(RepositoryEntry.ACC_USERS_GUESTS));
			}
			keyList.add(RepositoryEntry.MEMBERS_ONLY);
			String[] keys = keyList.toArray(new String[keyList.size()]);

			List<String> valueList = new ArrayList<String>();
			valueList.add(pt.translate("cif.access.owners"));
			valueList.add(pt.translate("cif.access.owners_authors"));
			valueList.add(pt.translate("cif.access.users"));
			if(loginModule.isGuestLoginLinksEnabled()) {
				valueList.add(pt.translate("cif.access.users_guests"));
			}
			valueList.add(pt.translate("cif.access.membersonly"));
			String[] values = valueList.toArray(new String[valueList.size()]);

			//use the addDropDownSingleselect method with null as label i18n - key, because there is no label to set. OLAT-3682
			accessSelbox = uifactory.addDropdownSingleselect("accessBox",null, fic, keys, values, null);
			accessSelbox.setElementCssClass("o_sel_course_publish_access");
			if(!loginModule.isGuestLoginLinksEnabled() && "4".equals(selectedAccess)) {//no guest but BARG
				accessSelbox.select("3", true);//-> set BAR-
			} else {
				boolean found = false;
				for(String key:keys) {
					if(key.equals(selectedAccess)) {
						accessSelbox.select(key, true);
						found = true;
						break;
					}
				}
				
				if(!found) {//probably 0
					accessSelbox.select(keys[0], true);
				}
			}
		}
	}
}