SharedFolderDisplayController.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.modules.sharedfolder;

import java.util.List;

import org.olat.core.commons.modules.bc.FolderRunController;
import org.olat.core.gui.UserRequest;
import org.olat.core.gui.components.Component;
import org.olat.core.gui.components.velocity.VelocityContainer;
import org.olat.core.gui.control.Controller;
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.generic.dtabs.Activateable2;
import org.olat.core.gui.translator.Translator;
import org.olat.core.id.OLATResourceable;
import org.olat.core.id.context.BusinessControlFactory;
import org.olat.core.id.context.ContextEntry;
import org.olat.core.id.context.StateEntry;
import org.olat.core.logging.activity.LearningResourceLoggingAction;
import org.olat.core.logging.activity.OlatResourceableType;
import org.olat.core.logging.activity.ThreadLocalUserActivityLogger;
import org.olat.core.util.StringHelper;
import org.olat.core.util.Util;
import org.olat.core.util.vfs.VFSContainer;
import org.olat.core.util.vfs.VFSItem;
import org.olat.core.util.vfs.callbacks.ReadOnlyCallback;
import org.olat.modules.cp.WebsiteDisplayController;
import org.olat.util.logging.activity.LoggingResourceable;

/**
 * Displays the SharedFolder likewise a webserver. If it exists a file like
 * index.htm(l) or default.htm(l), this will be displayed, otherwise the
 * directory listing.
 * <P>
 * Initial Date: Sept 2, 2005 <br>
 * 
 * @author Alexander Schneider
 */
public class SharedFolderDisplayController extends DefaultController implements Activateable2 {
	private static final String VELOCITY_ROOT = Util.getPackageVelocityRoot(SharedFolderDisplayController.class);

	/**
	 * Name of a file (1. priority) that prevents directory listing in the
	 * sharedfolder, if it exists
	 */
	private static final String INDEXDOTHTML = "index.html";

	/**
	 * Name of a file (2. priority) that prevents directory listing in the
	 * sharedfolder, if it exists
	 */
	private static final String INDEXDOTHTM = "index.htm";

	/**
	 * Name of a file (3. priority) that prevents directory listing in the
	 * sharedfolder, if it exists
	 */
	private static final String DEFAULTDOTHTML = "default.html";

	/**
	 * Name of a file (4. priority) that prevents directory listing in the
	 * sharedfolder, if it exists
	 */
	private static final String DEFAULTDOTHTM = "default.htm";

	private Translator translator;
	private VelocityContainer vcDisplay;

	private Controller controller;

	/**
	 * @param res
	 * @param ureq
	 * @param wControl
	 * @param previewBackground
	 */
	public SharedFolderDisplayController(UserRequest ureq, WindowControl wControl, VFSContainer sharedFolder, OLATResourceable ores) {
		super(wControl);
		addLoggingResourceable(LoggingResourceable.wrap(ores, OlatResourceableType.genRepoEntry));
		ThreadLocalUserActivityLogger.log(LearningResourceLoggingAction.LEARNING_RESOURCE_OPEN, getClass());
		translator = Util.createPackageTranslator(SharedFolderDisplayController.class, ureq.getLocale());

		vcDisplay = new VelocityContainer("main", VELOCITY_ROOT + "/display.html", translator, this);

		VFSItem item = null;
		item = sharedFolder.resolve(INDEXDOTHTML);
		if (item == null) item = sharedFolder.resolve(INDEXDOTHTM);
		if (item == null) item = sharedFolder.resolve(DEFAULTDOTHTML);
		if (item == null) item = sharedFolder.resolve(DEFAULTDOTHTM);

		if (item == null) {
			sharedFolder.setLocalSecurityCallback(new ReadOnlyCallback());
			controller = new FolderRunController(sharedFolder, true, true, false, ureq, getWindowControl());
			controller.addControllerListener(this);
		} else {
			controller = new WebsiteDisplayController(ureq, getWindowControl(), sharedFolder, item.getName());
		}
		vcDisplay.put("displayer", controller.getInitialComponent());


		setInitialComponent(vcDisplay);
	}
	
	@Override
	public void activate(UserRequest ureq, List<ContextEntry> entries, StateEntry state) {
		if(entries == null || entries.isEmpty()) return;
		
		String path = BusinessControlFactory.getInstance().getPath(entries.get(0));
		if(StringHelper.containsNonWhitespace(path) && controller instanceof FolderRunController) {
			((FolderRunController)controller).activatePath(ureq, path);
		}
	}

	/**
	 * @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)
	 */
	@Override
	public void event(UserRequest ureq, Component source, Event event) {
		// nothing to do
	}

	/**
	 * @see org.olat.core.gui.control.DefaultController#doDispose(boolean)
	 */
	protected void doDispose() {
		ThreadLocalUserActivityLogger.log(LearningResourceLoggingAction.LEARNING_RESOURCE_CLOSE, getClass());
		if (controller != null) {
			controller.dispose();
			controller = null;
		}
	}
}