jforum.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: Mar 3, 2003 / 11:43:35 AM
 * The JForum Project
 * http://www.jforum.net
 */
package net.jforum;

import java.io.BufferedWriter;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.sql.Connection;
import java.util.Date;
import java.util.HashMap;

import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import net.jforum.entities.User;
import net.jforum.entities.UserSession;
import net.jforum.exceptions.ExceptionWriter;
import net.jforum.exceptions.ForumStartupException;
import net.jforum.model.DataAccessDriver;
import net.jforum.model.UserSessionModel;
import net.jforum.repository.ModulesRepository;
import net.jforum.repository.RankingRepository;
import net.jforum.repository.SecurityRepository;
import net.jforum.repository.SmiliesRepository;
import net.jforum.security.SecurityConstants;
import net.jforum.util.I18n;
import net.jforum.util.MD5;
import net.jforum.util.preferences.ConfigKeys;
import net.jforum.util.preferences.SystemGlobals;

import org.apache.log4j.Logger;

import freemarker.template.Template;

/**
 * Front Controller.
 * 
 * @author Rafael Steil
 * @version $Id: JForum.java,v 1.65 2005/02/16 20:33:49 rafaelsteil Exp $
 */
public class JForum extends JForumCommonServlet 
{
	private static boolean isDatabaseUp;
	private static Logger logger = Logger.getLogger(JForum.class);
	
	public void init(ServletConfig config) throws ServletException
	{
		super.init(config);
		
		// Start database
		isDatabaseUp = ForumStartup.startDatabase();
		
		// Configure ThreadLocal
		DataHolder dh = new DataHolder();
		Connection conn;
		
		try {
			conn = DBConnection.getImplementation().getConnection();
		}
		catch (Exception e) {
			throw new ForumStartupException("Error while starting jforum", e);
		}
		
		dh.setConnection(conn);
		JForum.setThreadLocalData(dh);
		
		// Init general forum stuff
		ForumStartup.startForumRepository();
		RankingRepository.loadRanks();
		SmiliesRepository.loadSmilies();
		
		// Finalize
		if (conn != null) {
			try {
				DBConnection.getImplementation().releaseConnection(conn);
			}
			catch (Exception e) {}
		}
		
		JForum.setThreadLocalData(null);
	}
	
	private void checkCookies() throws Exception
	{
		if (SessionFacade.getUserSession() == null) {
			UserSession userSession = new UserSession();
			userSession.setSessionId(JForum.getRequest().getSession().getId());

			String cookieName = SystemGlobals.getValue(ConfigKeys.COOKIE_NAME_DATA);
			
			Cookie cookie = JForum.getCookie(cookieName);
			Cookie hashCookie = JForum.getCookie(SystemGlobals.getValue(ConfigKeys.COOKIE_USER_HASH));
			Cookie autoLoginCookie = JForum.getCookie(SystemGlobals.getValue(ConfigKeys.COOKIE_AUTO_LOGIN));
			
			// If we don't have any cookie yet, then we should set it with the default values
			if (hashCookie == null || cookie == null 
					|| cookie.getValue().equals(SystemGlobals.getValue(ConfigKeys.ANONYMOUS_USER_ID))
					|| (autoLoginCookie == null || !"1".equals(autoLoginCookie.getValue()))) {
				userSession.makeAnonymous();
			}
			else {
				String uid = cookie.getValue();
				String uidHash = hashCookie.getValue();
				
				String securityHash = SystemGlobals.getValue(ConfigKeys.USER_HASH_SEQUENCE);
				
				if ((uid != null && !uid.equals(""))
						&& (securityHash != null && !securityHash.equals(""))
						&& (MD5.crypt(securityHash + uid).equals(uidHash))) {
					int userId = Integer.parseInt(uid);
					userSession.setUserId(userId);
					
					UserSession tmpUs = null;
					
					User user = DataAccessDriver.getInstance().newUserModel().selectById(userId);
					if (user == null || user.getId() != userId) {
						userSession.makeAnonymous();
					}
					else {
						userSession.dataToUser(user);
	
						// As an user may come back to the forum before its
						// last visit's session expires, we should check for
						// existent user information and then, if found, store
						// it to the database before getting his information back.
						String sessionId = SessionFacade.isUserInSession(userId);
						if (sessionId != null) {
							SessionFacade.storeSessionData(sessionId, JForum.getConnection());
							tmpUs = SessionFacade.getUserSession(sessionId);
							SessionFacade.remove(sessionId);
						}
						else {
							UserSessionModel sm = DataAccessDriver.getInstance().newUserSessionModel();
							tmpUs = sm.selectById(userSession, JForum.getConnection());
						}
						
						if (tmpUs == null) {
							userSession.setLastVisit(new Date(System.currentTimeMillis()));
						}
						else {
							// Update last visit and session start time
							userSession.setLastVisit(new Date(tmpUs.getStartTime().getTime() + tmpUs.getSessionTime()));
						}
						
						// If the execution point gets here, then the user
						// has chosen "autoLogin"
						userSession.setAutoLogin(true);
						SessionFacade.setAttribute("logged", "1");
	
						I18n.load(user.getLang());
					}
				}
				else {
					userSession.makeAnonymous();
				}
			}
			
			SessionFacade.add(userSession);
			SessionFacade.setAttribute(ConfigKeys.TOPICS_TRACKING, new HashMap());
		}
		else {
			SessionFacade.getUserSession().updateSessionTime();
		}
	}
	
	protected void setupTemplateContext()
	{
		JForum.getContext().put("contextPath", JForum.getRequest().getContextPath());
		JForum.getContext().put("serverName", JForum.getRequest().getServerName());
		JForum.getContext().put("templateName", SystemGlobals.getValue(ConfigKeys.TEMPLATE_NAME));
		JForum.getContext().put("extension", SystemGlobals.getValue(ConfigKeys.SERVLET_EXTENSION));
		JForum.getContext().put("serverPort", Integer.toString(JForum.getRequest().getServerPort()));
		JForum.getContext().put("I18n", I18n.getInstance());
		JForum.getContext().put("imagesI18n", SystemGlobals.getValue(ConfigKeys.I18N_IMAGES_DIR));
		JForum.getContext().put("version", SystemGlobals.getValue(ConfigKeys.VERSION));
		JForum.getContext().put("forumTitle", SystemGlobals.getValue(ConfigKeys.FORUM_PAGE_TITLE));
		JForum.getContext().put("pageTitle", SystemGlobals.getValue(ConfigKeys.FORUM_PAGE_TITLE));
		JForum.getContext().put("metaKeywords", SystemGlobals.getValue(ConfigKeys.FORUM_PAGE_METATAG_KEYWORDS));
		JForum.getContext().put("metaDescription", SystemGlobals.getValue(ConfigKeys.FORUM_PAGE_METATAG_DESCRIPTION));
		JForum.getContext().put("forumLink", SystemGlobals.getValue(ConfigKeys.FORUM_LINK));
		JForum.getContext().put("homepageLink", SystemGlobals.getValue(ConfigKeys.HOMEPAGE_LINK));
		JForum.getContext().put("encoding", SystemGlobals.getValue(ConfigKeys.ENCODING));
		JForum.getContext().put("bookmarksEnabled", SecurityRepository.canAccess(SecurityConstants.PERM_BOOKMARKS_ENABLED));
		JForum.getContext().put("JForumContext", new JForumContext(JForum.getRequest().getContextPath(), 
				SystemGlobals.getValue(ConfigKeys.SERVLET_EXTENSION), JForum.getRequest(),JForum.getResponse()));
	}
	
	public void service(HttpServletRequest req, HttpServletResponse response) throws IOException, ServletException
	{
		Writer out = null;
		Connection conn = null;
		boolean autoCommitStatus = true;
		boolean useTransactions = SystemGlobals.getBoolValue(ConfigKeys.DATABASE_USE_TRANSACTIONS);
		
		try {
			// Initializes thread local data
			DataHolder dataHolder = new DataHolder();
			localData.set(dataHolder);

			String encoding = SystemGlobals.getValue(ConfigKeys.ENCODING);

			// Request
			ActionServletRequest request = new ActionServletRequest(req);

			dataHolder.setResponse(response);
			dataHolder.setRequest(request);
			
			if (!isDatabaseUp) {
				ForumStartup.startDatabase();
			}
			
			if (isDatabaseUp) {
				conn = DBConnection.getImplementation().getConnection();
				dataHolder.setConnection(conn);
				
				if (useTransactions) {
					autoCommitStatus = conn.getAutoCommit();
					conn.setAutoCommit(false);
				}
			}
			
			localData.set(dataHolder);
			
			// Verify cookies
			this.checkCookies();
			
			// Context
			this.setupTemplateContext();
			
			boolean logged = false;
			if ("1".equals(SessionFacade.getAttribute("logged"))) {
				logged = true;
			}
			
			JForum.getContext().put("logged", logged);
			
			// Process security data
			SecurityRepository.load(SessionFacade.getUserSession().getUserId());

			String module = request.getModule();
			
			// Gets the module class name
			String moduleClass = ModulesRepository.getModuleClass(module);
			
			JForum.getContext().put("moduleName", module);
			JForum.getContext().put("action", request.getAction());
			
			JForum.getContext().put("securityHash", MD5.crypt(request.getSession().getId()));
			JForum.getContext().put("session", SessionFacade.getUserSession());
		
			if (moduleClass != null) {
				// Here we go, baby
				Command c = (Command)Class.forName(moduleClass).newInstance();
				Template template = c.process(request, response, conn, JForum.getContext());

				DataHolder dh = (DataHolder)localData.get();
				if (dh.getRedirectTo() == null) {
					String contentType = dh.getContentType();
					if (contentType == null) {
						contentType = "text/html; charset=" + encoding;
					}
					
					response.setContentType(contentType);
					
					// Binary content are expected to be fully 
					// handled in the action, including outputstream
					// manipulation
					if (!dh.isBinaryContent()) {
						out = new BufferedWriter(new OutputStreamWriter(response.getOutputStream(), encoding));
						template.process(JForum.getContext(), out);
						out.flush();
					}
				}
			}
			
			if (useTransactions) {
				if (!JForum.cancelCommit()) {
					conn.commit();
				}
				else {
					conn.rollback();
				}
			}
		}
		catch (Exception e) {
			if (useTransactions && conn != null) {
				try {
					conn.rollback();
				}
				catch (Exception dbe) {
					dbe.printStackTrace();
				}
			}
			
			if (e.toString().indexOf("ClientAbortException") == -1) {
				response.setContentType("text/html");
				if (out != null) {
					new ExceptionWriter().handleExceptionData(e, out);
				}
				else {
					new ExceptionWriter().handleExceptionData(e, new BufferedWriter(new OutputStreamWriter(response.getOutputStream())));
				}
			}
		}
		finally {
			try {
				if (conn != null) {
					if (useTransactions) {
						conn.setAutoCommit(autoCommitStatus);
					}
				
					DBConnection.getImplementation().releaseConnection(conn);
				}
				
				if (out != null) {
					out.close();
				}
			}
			catch (Exception e) {
				e.printStackTrace();
			}
			
			DataHolder dh = (DataHolder)localData.get();
			if (dh != null) {
				String redirectTo = dh.getRedirectTo();
				if (redirectTo != null) {
					response.sendRedirect(redirectTo);
				}
			}
			
			localData.set(null);
		}		
	}
	
	/** 
	 * @see javax.servlet.GenericServlet#destroy()
	 */
	public void destroy() {
		super.destroy();
		System.out.println("destroying jforum...");
		
		try {
			DBConnection.getImplementation().realReleaseAllConnections();
		}
		catch (Exception e) {}
	}
}