net.fckeditor.handlers.RequestCycleHandler Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-core Show documentation
This Java library enables the FCKeditor to be used in a Servlet/J2EE environment. It provides JSP tags for creating a FCKeditor instance and a Servlet handling server-side user files and folders.
There is a newer version: 2.6
Show newest version
/*
 * FCKeditor - The text editor for Internet - http://www.fckeditor.net
 * Copyright (C) 2004-2009 Frederico Caldeira Knabben
 * 
 * == BEGIN LICENSE ==
 * 
 * Licensed under the terms of any of the following licenses at your
 * choice:
 * 
 *  - GNU General Public License Version 2 or later (the "GPL")
 *    http://www.gnu.org/licenses/gpl.html
 * 
 *  - GNU Lesser General Public License Version 2.1 or later (the "LGPL")
 *    http://www.gnu.org/licenses/lgpl.html
 * 
 *  - Mozilla Public License Version 1.1 or later (the "MPL")
 *    http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * == END LICENSE ==
 */
package net.fckeditor.handlers;

import javax.servlet.http.HttpServletRequest;

import net.fckeditor.connector.Connector;
import net.fckeditor.requestcycle.UserAction;
import net.fckeditor.requestcycle.UserPathBuilder;
import net.fckeditor.tool.Utils;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Handles the {@link UserAction} and {@link UserPathBuilder} interfaces. 

 * This class instantiates the the chosen implementations and acts as a proxy
 * for their methods/access.
 * 
 * @version $Id: RequestCycleHandler.java 3759 2009-06-22 20:02:26Z mosipov $
 */
public class RequestCycleHandler {
	private static final Logger logger = LoggerFactory
			.getLogger(RequestCycleHandler.class);
	private static UserAction userAction = null;
	private static UserPathBuilder userPathBuilder = null;

	static {
		// If there are more objects to instantiate in future, we could solve
		// the following by reflection!

		// 1. try to instantiate the UserAction object
		String className = PropertiesLoader.getUserActionImpl();
		if (Utils.isEmpty(className))
			logger.error("Empty UserAction implementation class name provided");
		else {
			try {
				Class clazz = Class.forName(className);
				userAction = (UserAction) clazz.newInstance();
				logger.info("UserAction initialized to {}", className);
			} catch (Throwable e) {
				logger.error("UserAction implementation {} could not be instantiated", className);
				throw new RuntimeException("UserAction implementation " + className + " could not be instantiated", e); //$NON-NLS-1$
			}
		}

		// 2. try to instantiate the UserPathBuilder object
		className = PropertiesLoader.getUserPathBuilderImpl();
		if (Utils.isEmpty(className))
			logger.error("Empty UserPathBuilder implementation class name provided");
		else {
			try {
				Class clazz = Class.forName(className);
				userPathBuilder = (UserPathBuilder) clazz.newInstance();
				logger.info("UserPathBuilder initialized to {}", className);
			} catch (Throwable e) {
				logger.error("UserPathBuilder implementation {} could not be instantiated", className);
				throw new RuntimeException("UserPathBuilder implementation " + className + " could not be instantiated", e); //$NON-NLS-1$
			}
		}
	}

	/**
	 * Just a wrapper to
	 * {@link UserAction#isEnabledForFileBrowsing(HttpServletRequest)}.
	 * 
	 * @return {@link UserAction#isEnabledForFileBrowsing(HttpServletRequest)}
	 *         or false if {@link UserAction} isn't set.
	 * @see #isGetResourcesEnabled(HttpServletRequest)
	 * @deprecated Method will be removed in FCKeditor.Java 2.6, user
	 *             {@link #isGetResourcesEnabled(HttpServletRequest)}.
	 */
	@Deprecated
	public static boolean isEnabledForFileBrowsing(
			final HttpServletRequest request) {
		return (userAction != null && userAction
				.isEnabledForFileBrowsing(request));
	}
	
	/**
	 * Returns true if user is allowed to list resources. The
	 * behavior is specified by the current UserAction instance.
	 * 
	 * @param request
	 *            current user request instance
	 * @return true if user is allowed to list resources, false otherwise
	 * @see UserAction#isEnabledForFileBrowsing(HttpServletRequest)
	 */
	public static boolean isGetResourcesEnabled(final HttpServletRequest request) {
		return userAction.isEnabledForFileBrowsing(request);
	}

	/**
	 * Just a wrapper to
	 * {@link UserAction#isEnabledForFileUpload(HttpServletRequest)}.
	 * 
	 * @return {@link UserAction#isEnabledForFileUpload(HttpServletRequest)} or
	 *         false if {@link UserAction} isn't set.
	 * @see #isFileUploadEnabled(HttpServletRequest)
	 * @deprecated Method will be removed in FCKeditor.Java 2.6,
	 *             {@link #isFileUploadEnabled(HttpServletRequest)}.
	 */
	public static boolean isEnabledForFileUpload(
			final HttpServletRequest request) {
		return (userAction != null && userAction
				.isEnabledForFileUpload(request));
	}
	
	/**
	 * Returns true if user is allowed to upload files. The
	 * behavior is specified by the current UserAction instance.
	 * 
	 * @param request
	 *            current user request instance
	 * @return true if user is allowed to upload files, false otherwise
	 * @see UserAction#isEnabledForFileUpload(HttpServletRequest)
	 */
	public static boolean isFileUploadEnabled(HttpServletRequest request) {
		return userAction.isEnabledForFileUpload(request);
	}

	/**
	 * Returns true if user is allowed to create folders. The
	 * behavior is specified by the current UserAction instance.
	 * 
	 * @param request
	 *            current user request instance
	 * @return true if user is allowed to create folders, false otherwise
	 * @see UserAction#isEnabledForFileBrowsing(HttpServletRequest)
	 */
	public static boolean isCreateFolderEnabled(final HttpServletRequest request) {
		return userAction.isCreateFolderEnabled(request);
	}

	/**
	 * Returns the current userfiles path. The path is specified by the current
	 * UserPathBuilder instance.
	 * 
	 * @param request
	 *            current user request instance
	 * @return current userfiles path
	 * @see UserPathBuilder#getUserFilesPath(HttpServletRequest)
	 */
	public static String getUserFilesPath(final HttpServletRequest request) {
		return userPathBuilder.getUserFilesPath(request);
	}

	/**
	 * Returns the current absolute userfiles path. The path is specified by the
	 * current UserPathBuilder instance. 

	 * Note that the path is absolute to the underlying system of the current
	 * {@link Connector} instance.
	 * 
	 * @param request
	 *            current user request instance
	 * @return current absolute userfiles path
	 * @see UserPathBuilder#getUserFilesAbsolutePath(HttpServletRequest)
	 */
	public static String getUserFilesAbsolutePath(final HttpServletRequest request) {
		return userPathBuilder.getUserFilesAbsolutePath(request);
	}
}