/*
* NEMESIS-FORUM.
* Copyright (C) 2002 David Laurent(lithium2@free.fr). All rights reserved.
*
* Copyright (c) 2000 The Apache Software Foundation. All rights reserved.
*
* Copyright (C) 2001 Yasna.com. All rights reserved.
*
* Copyright (C) 2000 CoolServlets.com. All rights reserved.
*
* NEMESIS-FORUM. is free software; you can redistribute it and/or
* modify it under the terms of the Apache Software License, Version 1.1,
* or (at your option) any later version.
*
* NEMESIS-FORUM core framework, NEMESIS-FORUM backoffice, NEMESIS-FORUM frontoffice
* application are parts of NEMESIS-FORUM and are distributed under
* same terms of licence.
*
*
* NEMESIS-FORUM includes software developed by the Apache Software Foundation (http://www.apache.org/)
* and software developed by CoolServlets.com (http://www.coolservlets.com).
* and software developed by Yasna.com (http://www.yasna.com).
*
*/
package org.nemesis.forum.impl;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.Iterator;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.nemesis.forum.Authorization;
import org.nemesis.forum.Forum;
import org.nemesis.forum.ForumFactory;
import org.nemesis.forum.ForumPermissions;
import org.nemesis.forum.ForumThread;
import org.nemesis.forum.Message;
import org.nemesis.forum.ProfileManager;
import org.nemesis.forum.exception.ForumAlreadyExistsException;
import org.nemesis.forum.exception.ForumMessageNotFoundException;
import org.nemesis.forum.exception.ForumNotFoundException;
import org.nemesis.forum.exception.ForumThreadNotFoundException;
import org.nemesis.forum.exception.UnauthorizedException;
import org.nemesis.forum.util.cache.Cache;
import org.nemesis.forum.util.cache.CacheableInteger;
import org.nemesis.forum.util.jdbc.DbConnectionManager;
/**
* Database implementation of the ForumFactory interface.
*/
public class DbForumFactory extends ForumFactory {
static protected Log log = LogFactory.getLog(DbForumFactory.class);
/** DATABASE QUERIES **/
private static final String FORUM_COUNT = "SELECT count(*) FROM yazdForum";
private static final String DELETE_FORUM = "DELETE FROM yazdForum WHERE forumID=?";
private static final String DELETE_FORUM_USER_PERMS = "DELETE FROM yazdUserPerm WHERE forumID=?";
private static final String DELETE_FORUM_GROUP_PERMS = "DELETE FROM yazdGroupPerm WHERE forumID=?";
private static final String DELETE_FORUM_PROPERTIES = "DELETE FROM yazdForumProp WHERE forumID=?";
private static final String GET_USER_PERMS = "SELECT DISTINCT permission FROM yazdUserPerm WHERE forumID=? " + "AND userID=?";
private static final String USERS_WITH_PERM = "SELECT DISTINCT userID FROM yazdUserPerm WHERE forumID=? AND permission=?";
private static final String GET_GROUP_PERMS = "SELECT DISTINCT permission from yazdGroupPerm WHERE forumID=? " + "AND groupID=?";
private static final String GROUPS_WITH_PERM = "SELECT DISTINCT groupID FROM yazdGroupPerm WHERE forumID=? AND permission=?";
private static final String ALL_MESSAGES = "SELECT messageID FROM yazdMessage";
private static final String DELETE_MESSAGE = "DELETE FROM yazdMessage WHERE messageID=?";
protected DbCacheManager cacheManager;
/**
* The profile manager provides access to users and groups.
*/
private ProfileManager profileManager;
/**
* Creates a new DbForumFactory.
*/
public DbForumFactory() {
cacheManager = new DbCacheManager();
profileManager = new DbProfileManager(this);
//searchIndexer = new DbSearchIndexer(this);
}
//FROM THE FORUMFACTORY INTERFACE//
public Forum createForum(String name, String description) throws UnauthorizedException, ForumAlreadyExistsException {
Forum newForum = null;
try {
Forum existingForum = getForum(name);
//The forum already exists since now exception, so:
throw new ForumAlreadyExistsException();
} catch (ForumNotFoundException fnfe) {
//The forum doesn't already exist so we can create a new one
newForum = new DbForum(name, description, this);
}
return newForum;
}
public void deleteForum(Forum forum) throws UnauthorizedException {
//First, remove forum from memory.
cacheManager.remove(DbCacheManager.FORUM_CACHE, new Integer(forum.getID()));
cacheManager.remove(DbCacheManager.USER_PERMS_CACHE, new Integer(forum.getID()));
cacheManager.remove(DbCacheManager.FORUM_ID_CACHE, forum.getName());
//Delete all messages and threads in the forum.
Iterator threads = forum.threads();
while (threads.hasNext()) {
ForumThread thread = (ForumThread) threads.next();
forum.deleteThread(thread);
}
//Now, delete all filters associated with the forum. We delete in
//reverse order since filter indexes will change if we don't delete
//the last filter entry.
int filterCount = forum.getForumMessageFilters().length;
for (int i = filterCount - 1; i >= 0; i--) {
forum.removeForumMessageFilter(i);
}
//Finally, delete the forum itself and all permissions and properties
//associated with it.
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(DELETE_FORUM);
pstmt.setInt(1, forum.getID());
pstmt.execute();
pstmt.close();
//User perms
pstmt = con.prepareStatement(DELETE_FORUM_USER_PERMS);
pstmt.setInt(1, forum.getID());
pstmt.execute();
pstmt.close();
//Group perms
pstmt = con.prepareStatement(DELETE_FORUM_GROUP_PERMS);
pstmt.setInt(1, forum.getID());
pstmt.execute();
pstmt.close();
//Properties
pstmt = con.prepareStatement(DELETE_FORUM_PROPERTIES);
pstmt.setInt(1, forum.getID());
pstmt.execute();
} catch (Exception sqle) {
log.error("Error in DbForumFactory:deleteForum()-",sqle);
} finally {
try {
pstmt.close();
} catch (Exception e) {
log.error("",e);
}
try {
con.close();
} catch (Exception e) {
log.error("",e);
}
}
}
public Iterator forumsModeration() { //this has to be revisited again
return null;
}
public Forum getForum(int forumID) throws ForumNotFoundException, UnauthorizedException {
//If cache is not enabled, do a new lookup of object
if (!cacheManager.isCacheEnabled()) {
return new DbForum(forumID, this);
}
//Cache is enabled.
Integer forumIDInteger = new Integer(forumID);
DbForum forum = (DbForum) cacheManager.get(DbCacheManager.FORUM_CACHE, forumIDInteger);
if (forum == null) {
forum = new DbForum(forumID, this);
cacheManager.add(DbCacheManager.FORUM_CACHE, forumIDInteger, forum);
}
return forum;
}
public Forum getForum(String name) throws ForumNotFoundException, UnauthorizedException {
//If cache is not enabled, do a new lookup of object
if (!cacheManager.isCacheEnabled()) {
Forum forum = new DbForum(name, this);
return forum;
}
//Cache is enabled.
CacheableInteger forumIDInteger = (CacheableInteger) cacheManager.get(DbCacheManager.FORUM_ID_CACHE, name);
//if id wan't found in cache, load it up and put it there.
if (forumIDInteger == null) {
Forum forum = new DbForum(name, this);
forumIDInteger = new CacheableInteger(new Integer(forum.getID()));
cacheManager.add(DbCacheManager.FORUM_ID_CACHE, name, forumIDInteger);
}
return getForum(forumIDInteger.getInteger().intValue());
}
public int getForumCount() {
int forumCount = 0;
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(FORUM_COUNT);
ResultSet rs = pstmt.executeQuery();
rs.next();
forumCount = rs.getInt(1);
} catch (SQLException sqle) {
log.error("DbForumFactory:getForumCount() failed: " , sqle);
} finally {
try {
pstmt.close();
} catch (Exception e) {
log.error("",e);
}
try {
con.close();
} catch (Exception e) {
log.error("",e);
}
}
return forumCount;
}
public Iterator forums() {
return new DbForumFactoryIterator(this);
}
public ProfileManager getProfileManager() {
return profileManager;
}
public int[] usersWithPermission(int permissionType) throws UnauthorizedException {
int[] users = new int[0];
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(USERS_WITH_PERM);
pstmt.setInt(1, -1);
pstmt.setInt(2, permissionType);
ResultSet rs = pstmt.executeQuery();
ArrayList userList = new ArrayList();
while (rs.next()) {
userList.add(new Integer(rs.getInt("userID")));
}
users = new int[userList.size()];
for (int i = 0; i < users.length; i++) {
users[i] = ((Integer) userList.get(i)).intValue();
}
} catch (SQLException sqle) {
log.error("",sqle);
} finally {
try {
pstmt.close();
} catch (Exception e) {
log.error("",e);
}
try {
con.close();
} catch (Exception e) {
log.error("",e);
}
}
return users;
}
public int[] groupsWithPermission(int permissionType) throws UnauthorizedException {
int[] groups = new int[0];
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(GROUPS_WITH_PERM);
pstmt.setInt(1, -1);
pstmt.setInt(2, permissionType);
ResultSet rs = pstmt.executeQuery();
ArrayList groupList = new ArrayList();
while (rs.next()) {
groupList.add(new Integer(rs.getInt("groupID")));
}
groups = new int[groupList.size()];
for (int i = 0; i < groups.length; i++) {
groups[i] = ((Integer) groupList.get(i)).intValue();
}
} catch (SQLException sqle) {
log.error("Error in DbForum.groupsWithPermission:" , sqle);
} finally {
try {
pstmt.close();
} catch (Exception e) {
log.error("",e);
}
try {
con.close();
} catch (Exception e) {
log.error("",e);
}
}
return groups;
}
public ForumPermissions getPermissions(Authorization authorization) {
int userID = authorization.getUserID();
//Get the user perm cache for this forum
Cache userPermCache = (Cache) getCacheManager().get(DbCacheManager.USER_PERMS_CACHE, new Integer(-1));
//Simple case: if cache is turned on and the user is already cached,
//we can simply return the cached permissions.
if (userPermCache != null) {
ForumPermissions permissions = (ForumPermissions) userPermCache.get(new Integer(userID));
if (permissions != null) {
return permissions;
}
}
//Not so simple case: cache is not turned on or the user permissions
//have not been cached yet.
boolean isAnonymous = (userID == -1);
boolean isUser = !isAnonymous;
ForumPermissions finalPermissions = ForumPermissions.none();
// check each forum for a specific permission
Iterator allForums = this.forums();
Forum forum;
ForumPermissions forumUserPermissions;
while (allForums.hasNext()) {
forum = (Forum) allForums.next();
forumUserPermissions = getUserPermissions(userID, forum.getID());
finalPermissions = new ForumPermissions(finalPermissions, forumUserPermissions);
}
//Step 1 - Get permissions for the User. This includes anonymous
//perms, "special user" perms, and the specific perms for the user.
if (isUser) {
ForumPermissions userPermissions = getUserPermissions(userID, -1);
//Combine permissions
finalPermissions = new ForumPermissions(finalPermissions, userPermissions);
}
//Add in anonymous perms.
ForumPermissions anonyPermissions = null;
if (userPermCache != null) {
anonyPermissions = (ForumPermissions) userPermCache.get(new Integer(-1));
}
//Otherwise, do our own lookup.
if (anonyPermissions == null) {
anonyPermissions = getUserPermissions(-1, -1);
//Add to cache so it will be there next time.
if (userPermCache != null) {
userPermCache.add(new Integer(-1), anonyPermissions);
}
}
//Combine permissions
finalPermissions = new ForumPermissions(finalPermissions, anonyPermissions);
//If they are a valid user, figure out "any user" permissions.
if (isUser) {
ForumPermissions specialUserPermissions = null;
//Check for cache
if (userPermCache != null) {
specialUserPermissions = (ForumPermissions) userPermCache.get(new Integer(0));
}
//Otherwise, do our own lookup.
if (specialUserPermissions == null) {
specialUserPermissions = getUserPermissions(0, -1);
//Add to cache so it will be there next time.
if (userPermCache != null) {
userPermCache.add(new Integer(0), specialUserPermissions);
}
}
//Combine permissions
finalPermissions = new ForumPermissions(finalPermissions, specialUserPermissions);
}
//Step 2 -- get Permissions for all groups the user is in.
int[] groups = ((DbProfileManager) getProfileManager()).getUserGroups(userID);
for (int i = 0; i < groups.length; i++) {
ForumPermissions groupPermissions = getGroupPermissions(groups[i], -1);
finalPermissions = new ForumPermissions(finalPermissions, groupPermissions);
}
//Finally, add user to cache so it will be there next time.
if (isUser && userPermCache != null) {
userPermCache.add(new Integer(userID), finalPermissions);
}
return finalPermissions;
}
public boolean hasPermission(int type) {
return true;
}
//OTHER METHODS//
/**
* Returns the cache manager object.
*/
public DbCacheManager getCacheManager() {
return cacheManager;
}
/**
* Cleans the database of "junk". This is currently defined as: <ul>
* <li> Messages with no subject or body.
* <li> Messages that do not belong to a thread.</ul>
*
* Please be aware that this method will <b>permanently</b> delete forum
* content. You may want to perform a database backup before calling this
* method.<p>
*
* This method requires two database connections and may take a long time
* to execute, as it must iterate through ever message record in the
* database.
* :TODO: WEB IHM cleanDatabase
*/
public void cleanDatabase() {
//Iterate through all forums, threads to delete unwanted messages.
Iterator forums = forums();
while (forums.hasNext()) {
Forum forum = (Forum) forums.next();
Iterator threads = forum.threads();
while (threads.hasNext()) {
try {
ForumThread thread = (ForumThread) threads.next();
Iterator messages = thread.messages();
while (messages.hasNext()) {
try {
Message message = (Message) messages.next();
if (/*message.getSubject() == null ||*/
message.getBody() == null) {
thread.deleteMessage(message);
}
} catch (Exception me) {
log.error("",me);
}
}
} catch (Exception te) {
log.error("",te);
}
}
}
/*
//Select all message ID's directly from the message table.
Connection con = null;
PreparedStatement pstmt = null;
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(ALL_MESSAGES);
ResultSet rs = pstmt.executeQuery();
while(rs.next()) {
try {
int messageID = rs.getInt(1);
//Convert to object
ForumMessage message = new DbForumMessage(messageID, this);
ForumThread thread = message.getForumThread();
if (thread == null) {
//manually delete this message from the database. It won't
//appear in any search indexes or in any threads, so this
//shouldn't have any side effects.
Connection con2 = null;
PreparedStatement pstmt2 = null;
try {
con2 = DbConnectionManager.getConnection();
pstmt2 = con.prepareStatement(DELETE_MESSAGE);
pstmt2.setInt(1, messageID);
pstmt2.execute();
}
catch( SQLException sqle ) {
}
finally {
try { pstmt2.close(); }
catch (Exception e) { log.error("",e); }
try { con2.close(); }
catch (Exception e) { log.error("",e); }
}
}
}
catch (ForumMessageNotFoundException fmnfe) {
}
}
}
catch( SQLException sqle ) {
}
finally {
try { pstmt.close(); }
catch (Exception e) { }
try { con.close(); }
catch (Exception e) { }
}
*/
}
/**
* Returns a thread specified by its id. Will return null
* if the thread is not in the forum. If cache is turned
* on, it will use it.
*/
public DbForumThread getThread(int threadID, DbForum forum) throws ForumThreadNotFoundException {
//If cache is not enabled, do a new lookup of object
if (!cacheManager.isCacheEnabled()) {
return new DbForumThread(threadID, forum, this);
}
//Cache is enabled.
Integer threadIDInteger = new Integer(threadID);
DbForumThread thread = (DbForumThread) cacheManager.get(DbCacheManager.THREAD_CACHE, threadIDInteger);
if (thread == null) {
thread = new DbForumThread(threadID, forum, this);
cacheManager.add(DbCacheManager.THREAD_CACHE, threadIDInteger, thread);
}
return thread;
}
/**
* Returns a message from the thread based on its id. If cache is turned
* on, it will use it.
*
* @param messageID the ID of the message to get from the thread.
*/
public DbForumMessage getMessage(int messageID) throws ForumMessageNotFoundException {
//If cache is not enabled, do a new lookup of object
if (!cacheManager.isCacheEnabled()) {
return new DbForumMessage(messageID, this);
}
//Cache is enabled.
Integer messageIDInteger = new Integer(messageID);
DbForumMessage message = (DbForumMessage) cacheManager.get(DbCacheManager.MESSAGE_CACHE, messageIDInteger);
if (message == null) {
//Load the message
message = new DbForumMessage(messageID, this);
//Add it to cache.
cacheManager.add(DbCacheManager.MESSAGE_CACHE, messageIDInteger, message);
}
return message;
}
/**
* Returns the permissions that a particular user has for the forum.
*/
protected ForumPermissions getUserPermissions(int userID, int forumID) {
Connection con = null;
PreparedStatement pstmt = null;
//Initialize a permissions array with no permissions.
boolean[] permissions = new boolean[8];
for (int i = 0; i < permissions.length; i++) {
permissions[i] = false;
}
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(GET_USER_PERMS);
pstmt.setInt(1, forumID);
pstmt.setInt(2, userID);
ResultSet rs = pstmt.executeQuery();
while (rs.next()) {
int newPerm = rs.getInt("permission");
permissions[newPerm] = true;
}
} catch (SQLException sqle) {
log.error("Error in DbForum.java:" , sqle);
} finally {
try {
pstmt.close();
} catch (Exception e) {
log.error("",e);
}
try {
con.close();
} catch (Exception e) {
log.error("",e);
}
}
return new ForumPermissions(permissions);
}
/**
* Returns the permissions that a particular group has for the forum.
*/
protected ForumPermissions getGroupPermissions(int groupID, int forumID) {
Connection con = null;
PreparedStatement pstmt = null;
//Initialize a permissions array with no permissions.
boolean[] permissions = new boolean[8];
for (int i = 0; i < permissions.length; i++) {
permissions[i] = false;
}
try {
con = DbConnectionManager.getConnection();
pstmt = con.prepareStatement(GET_GROUP_PERMS);
pstmt.setInt(1, forumID);
pstmt.setInt(2, groupID);
ResultSet rs = pstmt.executeQuery();
while (rs.next()) {
int newPerm = rs.getInt("permission");
permissions[newPerm] = true;
}
} catch (SQLException sqle) {
log.error("",sqle);
} finally {
try {
pstmt.close();
} catch (Exception e) {
log.error("",e);
}
try {
con.close();
} catch (Exception e) {
log.error("",e);
}
}
return new ForumPermissions(permissions);
}
}