dbgroup.java

Jive Forums 1.0 src

/**
 * DbGroup.java
 * August 19, 2000
 *
 * Copyright (C) 2000 CoolServlets.com. All rights reserved.
 *
 * ===================================================================
 * The Apache Software License, Version 1.1
 *
 * 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. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by
 *        CoolServlets.com (http://www.coolservlets.com)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Jive" and "CoolServlets.com" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please
 *    contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Jive",
 *    nor may "Jive" appear in their name, without prior written
 *    permission of CoolServlets.com.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 COOLSERVLETS.COM OR
 * ITS 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 software consists of voluntary contributions made by many
 * individuals on behalf of CoolServlets.com. For more information
 * on CoolServlets.com, please see <http://www.coolservlets.com>.
 */

package com.coolservlets.forum.database;

import com.coolservlets.forum.*;
import com.coolservlets.util.*;
import java.util.*;
//JDK1.1// import com.sun.java.util.collections.*;
import java.text.*;
import java.sql.*;

/**
 * Database implementation of the Group interface. In development.
 */
public class DbGroup implements Group {

    /** DATABASE QUERIES **/
    private static final String ADD_ADMIN =
        "INSERT INTO jiveGroupUser(groupID,userID,administrator) VALUES(?,?,1)";
    private static final String REMOVE_ADMIN =
        "DELETE FROM jiveGroupUser WHERE groupID=? AND userID=? AND administrator=1";
    private static final String ADD_USER =
        "INSERT INTO jiveGroupUser(groupID,userID,administrator) VALUES(?,?,0)";
    private static final String REMOVE_USER =
        "DELETE FROM jiveGroupUser WHERE groupID=? AND userID=? AND administrator=0";
    private static final String ADMIN_TEST =
        "SELECT userID FROM jiveGroupUser WHERE groupID=? AND userID=? AND " +
        "administrator=1";
    private static final String MEMBER_TEST =
        "SELECT userID FROM jiveGroupUser WHERE groupID=? AND userID=?";
    private static final String ADMIN_COUNT =
        "SELECT count(*) FROM jiveGroupUser WHERE groupID=? " +
        "AND administrator=1";
    private static final String MEMBER_COUNT =
        "SELECT DISTINCT count(userID) FROM jiveGroupUser " +
        "WHERE groupID=?";
    private static final String LOAD_ADMINS =
        "SELECT userID FROM jiveGroupUser WHERE administrator=1 AND groupID=?";
    private static final String LOAD_USERS =
        "SELECT userID FROM jiveGroupUser WHERE groupID=?";

    private static final String LOAD_GROUP_BY_ID =
        "SELECT * FROM jiveGroup WHERE groupID=?";
    private static final String LOAD_GROUP_BY_NAME =
        "SELECT * FROM jiveGroup WHERE name=?";
    private static final String INSERT_GROUP =
        "INSERT INTO jiveGroup(name,description,groupID) VALUES(?,?,?)";
    private static final String SAVE_GROUP =
        "UPDATE jiveGroup SET name=?, description=? WHERE groupID=?";
               
    private int id;
    private String name = null;
    private String description = "";

    private ForumFactory factory;

    /**
     * Creates a new group.
     */
    protected DbGroup(String name, ForumFactory factory) {
        this.factory = factory;
        this.id = DbSequenceManager.nextID("Group");
        this.name = name;
        insertIntoDb();
    }

    /**
     * Loads a group from the database based on its id.
     */
    protected DbGroup(int id, ForumFactory factory)
            throws GroupNotFoundException
    {
        this.factory = factory;
        this.id = id;
        loadFromDb();
    }

    /**
     * Loads a group from the database based on its name. The implementation
     * of this method is rather hackish since it includes a fake parameter just
     * so that it can have a different method signature than the first
     * constructor. Even so, this methodology makes this class behave more like
     * our other classes, so we're gleefully leaving it this way. :)
     */
    protected DbGroup(String name, Object fake, ForumFactory factory)
            throws GroupNotFoundException
    {
        this.factory = factory;
        this.name = name;
        loadFromDb();
    }
    
    /**
     * Return the group id.
     */
    public int getID() {
        return id;
    }

    /**
     * Returns the group name.
     */
    public String getName() {
        return name;
    }

    /**
     * Sets the group name.
     *
     * @param name the new name for the group.
     *
     * @throws UnauthorizedException
     */
    public void setName(String name) throws UnauthorizedException {
        this.name = name;
    }

    /**
     * Returns the group description.
     */
    public String getDescription() {
        return description;
    }

    /**
     * Sets the group description.
     *
     * @param name the new description for the group.
     *
     * @throws UnauthorizedException
     */
    public void setDescription(String description)
            throws UnauthorizedException
    {
        this.description = description;
        saveToDb();
    }

    /**
     * Grants administrator privledges of the group to a user.
     *
     * @param user the User to grant adminstrative privledges to.
     *
     * @throws UnauthorizedException
     */
    public void addAdministrator(User user) throws UnauthorizedException {
        Connection con = null;
        PreparedStatement pstmt = null;
        try {
            con = DbConnectionManager.getConnection();
            pstmt = con.prepareStatement(ADD_ADMIN);
            pstmt.setInt(1, id);
            pstmt.setInt(2, user.getID());
            pstmt.execute();
        }
        catch( SQLException sqle ) {
            sqle.printStackTrace();
        }
        finally {
            try {  pstmt.close(); }
            catch (Exception e) { e.printStackTrace(); }
            try {  con.close();   }
            catch (Exception e) { e.printStackTrace(); }
        }
    }

    /**
     * Revokes administrator privledges of the group to a user.
     *
     * @param user the User to grant adminstrative privledges to.
     *
     * @throws UnauthorizedException
     */
    public void removeAdministrator(User user) throws UnauthorizedException {
        Connection con = null;
        PreparedStatement pstmt = null;
        try {
            con = DbConnectionManager.getConnection();
            pstmt = con.prepareStatement(REMOVE_ADMIN);
            pstmt.setInt(1, id);
            pstmt.setInt(2, user.getID());
            pstmt.execute();
        }
        catch( SQLException sqle ) {
            sqle.printStackTrace();
        }
        finally {
            try {  pstmt.close(); }
            catch (Exception e) { e.printStackTrace(); }
            try {  con.close();   }
            catch (Exception e) { e.printStackTrace(); }
        }
    }

    /**
     * Adds a user to the group.
     *
     * @param user the User to add to the group.
     *
     * @throws UnauthorizedException
     */
    public void addUser(User user) throws UnauthorizedException {
        Connection con = null;
        PreparedStatement pstmt = null;
        try {
            con = DbConnectionManager.getConnection();
            pstmt = con.prepareStatement(ADD_USER);
            pstmt.setInt(1, id);
            pstmt.setInt(2, user.getID());
            pstmt.execute();
        }
        catch( SQLException sqle ) {
            sqle.printStackTrace();
        }
        finally {
            try {  pstmt.close(); }
            catch (Exception e) { e.printStackTrace(); }
            try {  con.close();   }
            catch (Exception e) { e.printStackTrace(); }
        }
    }

    /**
     * Removes a user from the group.
     *
     * @param user the User to remove from the group.
     *
     * @throws UnauthorizedException
     */
    public void removeUser(User user) throws UnauthorizedException {
        Connection con = null;
        PreparedStatement pstmt = null;
        try {
            con = DbConnectionManager.getConnection();
            pstmt = con.prepareStatement(REMOVE_USER);
            pstmt.setInt(1, id);
            pstmt.setInt(2, user.getID());
            pstmt.execute();
        }
        catch( SQLException sqle ) {
            sqle.printStackTrace();
        }
        finally {
            try {  pstmt.close(); }
            catch (Exception e) { e.printStackTrace(); }
            try {  con.close();   }
            catch (Exception e) { e.printStackTrace(); }
        }
    }

    /**
     * Returns true if the User has group administrator permissions.
     */
    public boolean isAdministrator(User user) {
        boolean answer = false;
        Connection con = null;
        PreparedStatement pstmt = null;
        try {
            con = DbConnectionManager.getConnection();
            pstmt = con.prepareStatement(ADMIN_TEST);
            pstmt.setInt(1, id);
            pstmt.setInt(2, user.getID());
            ResultSet rs = pstmt.executeQuery();
            if (rs.next()) {