viewcommon.java

个人认为是最好的Java论坛源码

/*
 * Copyright (c) 2003, Rafael Steil
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, 
 * with or without modification, are permitted provided 
 * that the following conditions are met:
 * 
 * 1) Redistributions of source code must retain the above 
 * copyright notice, this list of conditions and the 
 * following  disclaimer.
 * 2)  Redistributions in binary form must reproduce the 
 * above copyright notice, this list of conditions and 
 * the following disclaimer in the documentation and/or 
 * other materials provided with the distribution.
 * 3) Neither the name of "Rafael Steil" nor 
 * the names of its contributors may be used to endorse 
 * or promote products derived from this software without 
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT 
 * HOLDERS AND CONTRIBUTORS "AS IS" AND ANY 
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, 
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, 
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 
 * IN CONTRACT, STRICT LIABILITY, OR TORT 
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
 * 
 * This file creation date: 02/04/2004 - 20:31:35
 * The JForum Project
 * http://www.jforum.net
 */
package net.jforum.view.forum.common;

import java.util.Map;

import net.jforum.Command;
import net.jforum.JForum;
import net.jforum.SessionFacade;
import net.jforum.exceptions.RequestEmptyException;
import net.jforum.repository.ModulesRepository;
import net.jforum.util.preferences.ConfigKeys;
import net.jforum.util.preferences.SystemGlobals;

import org.apache.log4j.Logger;

/**
 * @author Rafael Steil
 * @version $Id: ViewCommon.java,v 1.4 2005/01/18 20:59:43 rafaelsteil Exp $
 */
public final class ViewCommon
{
	private static final Logger logger = Logger.getLogger(ViewCommon.class);
	
	public static void contextToLogin() 
	{
		JForum.getContext().put("moduleAction", "forum_login.htm");
		String uri = JForum.getRequest().getRequestURI();
		String query = JForum.getRequest().getQueryString();
		String path = query == null ? uri : uri + "?" + query;

		JForum.getContext().put("returnPath", path);
	}
	
	/**
	 * Returns the initial page to start fetching records from.
	 *   
	 * @return The initial page number
	 */
	public static int getStartPage()
	{
		String s = JForum.getRequest().getParameter("start");
		int start = 0;
		
		if (s == null || s.trim().equals("")) {
			start = 0;
		}
		else {
			start = Integer.parseInt(s);
			
			if (start < 0) {
				start = 0;
			}
		}
		
		return start;
	}
	
	/**
	 * Gets the forum base link.
	 * The returned link has a trailing slash
	 * @return The forum link, with the trailing slash
	 */
	public static String getForumLink()
	{
		String forumLink = SystemGlobals.getValue(ConfigKeys.FORUM_LINK);
		if (!forumLink.endsWith("/")) {
			forumLink += "/";
		}
		
		return forumLink;
	}

	/**
	 * Checks if some request needs to be reprocessed. 
	 * This is likely to happen when @link net.jforum.ActionServletRequest#dumpRequest()
	 * is stored in the session. 
	 * 
	 * @return <code>true</code> of <code>false</code>, depending of the status.
	 */
	public static boolean needReprocessRequest()
	{
		return (SessionFacade.getAttribute(ConfigKeys.REQUEST_DUMP) != null);
	}
	
	/**
	 * Reprocess a request. 
	 * The request data should be in the session, held by the key
	 * <code>ConfigKeys.REQUEST_DUMP</code> and the value as
	 * a <code>java.util.Map</code>. Usual behaviour is to have the return
	 * of @link net.jforum.ActionServletRequest#dumpRequest().
	 * @throws Exception, RequestEmptyException
	 */
	public static void reprocessRequest() throws Exception
	{
		Map data = (Map)SessionFacade.getAttribute(ConfigKeys.REQUEST_DUMP);
		if (data == null) {
			throw new RequestEmptyException("A call to ViewCommon#reprocessRequest() was made, but no data found");
		}
		
		String module = (String)data.get("module");
		String action = (String)data.get("action");
		
		if (module == null || action == null) {
			throw new RequestEmptyException("A call to ViewCommon#reprocessRequest() was made, "
					+ "but no module or action name was found");
		}
		
		JForum.getRequest().restoreDump(data);
		SessionFacade.removeAttribute(ConfigKeys.REQUEST_DUMP);
		
		String moduleClass = ModulesRepository.getModuleClass(module);
		((Command)Class.forName(moduleClass).newInstance()).process(JForum.getRequest(),
				JForum.getResponse(), JForum.getConnection(), JForum.getContext());
	}
}