source: main/trunk/greenstone3/src/java/org/greenstone/gsdl3/util/DerbyWrapper.java@ 27316

/*
 *    DerbyWrapper.java
 *    Copyright (C) 2008 New Zealand Digital Library, http://www.nzdl.org
 *
 *    This program is free software; you can redistribute it and/or modify
 *    it under the terms of the GNU General Public License as published by
 *    the Free Software Foundation; either version 2 of the License, or
 *    (at your option) any later version.
 *
 *    This program is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *    GNU General Public License for more details.
 *
 *    You should have received a copy of the GNU General Public License
 *    along with this program; if not, write to the Free Software
 *    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package org.greenstone.gsdl3.util;

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.ArrayList;
import java.util.HashMap;

import org.greenstone.gsdl3.service.Authentication;

public class DerbyWrapper
{
    static final String PROTOCOL = "jdbc:derby:";
    static final String DRIVER = "org.apache.derby.jdbc.EmbeddedDriver";
    static final String USERSDB = "usersDB";
    static final String USERS = "users";
    static final String ROLES = "roles";
    private Connection conn = null;
    private Statement state = null;
    private String protocol_str;

    public DerbyWrapper()
    {
    }

    public DerbyWrapper(String dbpath)
    {
        connectDatabase(dbpath, false);
    }

    public void connectDatabase(String dbpath, boolean create_database)
    {
        try
        {
            Class.forName(DRIVER).newInstance();
            //System.out.println("Loaded the embedded driver.");
            protocol_str = PROTOCOL + dbpath;
            if (create_database)
            {
                conn = DriverManager.getConnection(protocol_str + ";create=true");
            }
            else
            {
                conn = DriverManager.getConnection(protocol_str);
            }
            state = conn.createStatement();
        }
        catch (Throwable e)
        {
            System.out.println("exception thrown:");
            if (e instanceof SQLException)
            {
                printSQLError((SQLException) e);
            }
            else
            {
                e.printStackTrace();
            }
        }
    }

    public void closeDatabase()
    {
        //state = null;
        //conn = null;
        boolean gotSQLExc = false;
        try
        {
            //  shutdown the database
            DriverManager.getConnection(protocol_str + ";shutdown=true");

        }
        catch (SQLException se)
        {
            // this is good (i.e. what Derby is designed to do on a successful shutdown)
            gotSQLExc = true;
        }
        catch (Exception e)
        {
            e.printStackTrace();
        }

        if (!gotSQLExc)
        {
            System.err.println("Warning: Derby Database did not shut down normally");
        }
    }

    public static void shutdownDatabaseServer()
    {
        boolean gotSQLExc = false;

        try
        {
            //  shutdown the whole server
            DriverManager.getConnection(PROTOCOL + ";shutdown=true");

        }
        catch (SQLException se)
        {
            // this is good (i.e. what Derby is designed to do on a successful shutdown)
            gotSQLExc = true;
            //System.out.println("Shutdown returned: " + se);
        }
        catch (Exception e)
        {

            e.printStackTrace();
        }
        if (!gotSQLExc)
        {
            System.err.println("Warning: Derby did not shut down normally");
        }

    }

    public void createDatabase()
    {
        try
        {
            conn.setAutoCommit(false);
            state.execute("create table users (username varchar(40) not null, password varchar(40) not null, accountstatus varchar(10), comment varchar(100), email varchar(40), primary key(username))");
            state.execute("create table roles (username varchar(40) not null, role varchar(40) not null, primary key (username, role))");
            state.execute("insert into " + USERS + " values ('admin', '" + Authentication.hashPassword("admin") + "', 'true', 'change the password for this account as soon as possible', '')");
            state.execute("insert into " + ROLES + " values ('admin', 'administrator')");
            state.execute("insert into " + ROLES + " values ('admin', 'all-collections-editor')");
            conn.commit();
        }
        catch (Exception ex)
        {
            ex.printStackTrace();
        }
    }

    public UserQueryResult listAllUser() throws SQLException
    {
        UserQueryResult userQueryResult = new UserQueryResult();
        String sql_list_all_user = "SELECT username, password, accountstatus, email, comment FROM " + USERS;

        ArrayList<HashMap<String, String>> users = new ArrayList<HashMap<String, String>>();
        ResultSet rs = state.executeQuery(sql_list_all_user);
        while (rs.next())
        {
            HashMap<String, String> user = new HashMap<String, String>();
            user.put("username", rs.getString("username"));
            user.put("password", rs.getString("password"));
            user.put("as", rs.getString("accountstatus"));
            user.put("comment", rs.getString("comment"));
            user.put("email", rs.getString("email"));

            users.add(user);
        }

        for (HashMap<String, String> user : users)
        {
            ResultSet gs = state.executeQuery("SELECT role FROM roles WHERE username = '" + user.get("username") + "'");
            String group = "";
            while (gs.next())
            {
                if (!group.equals(""))
                {
                    group += ",";
                }
                group += gs.getString("role");
            }
            userQueryResult.addUserTerm(user.get("username"), user.get("password"), group, user.get("as"), user.get("comment"), user.get("email"));
        }

        if (userQueryResult.getSize() == 0)
        {
            System.out.println("couldn't find any users");
            return null;
        }
        else
        {
            return userQueryResult;
        }
    }

    public boolean addUser(String username, String password, String groups, String accountstatus, String comment, String email)
    {
        try
        {
            conn.setAutoCommit(false);
            String sql_insert_user = "insert into " + USERS + " values ('" + username + "', '" + password + "', '" + accountstatus + "', '" + comment + "', '" + email + "')";
            state.execute(sql_insert_user);

            String[] groupArray = groups.split(",");
            for (String g : groupArray)
            {
                String sql_insert_group = "insert into " + ROLES + " values ('" + username + "', '" + g + "')";
                state.execute(sql_insert_group);
            }

            conn.commit();
        }
        catch (Throwable e)
        {
            System.out.println("exception thrown:");
            if (e instanceof SQLException)
            {
                printSQLError((SQLException) e);
            }
            else
            {
                e.printStackTrace();
            }
            closeDatabase();
            System.out.println("Error:" + e.getMessage());
            return false;
        }

        return true;
    }

    public boolean deleteUser(String del_username)
    {
        try
        {
            conn.setAutoCommit(false);
            String sql_delete_user = "delete from " + USERS + " where username='" + del_username + "'";
            String sql_delete_groups = "delete from " + ROLES + " where username='" + del_username + "'";
            state.execute(sql_delete_user);
            state.execute(sql_delete_groups);
            conn.commit();
        }
        catch (Throwable e)
        {
            System.out.println("exception thrown:");
            if (e instanceof SQLException)
            {
                printSQLError((SQLException) e);
            }
            else
            {
                e.printStackTrace();
            }
            closeDatabase();
            return false;
        }
        return true;
    }

    public boolean deleteAllUser() throws SQLException
    {
        conn.setAutoCommit(false);
        try
        {
            state.execute("delete from " + USERS);
            state.execute("delete from " + ROLES);
            conn.commit();
        }
        catch (Throwable e)
        {
            System.out.println("exception thrown:");
            if (e instanceof SQLException)
            {
                printSQLError((SQLException) e);
            }
            else
            {
                e.printStackTrace();
            }
            closeDatabase();
            return false;
        }
        return true;
    }

    public UserQueryResult findUser(String username, String password)
    {
        UserQueryResult userQueryResult = new UserQueryResult();

        try
        {
            conn.setAutoCommit(false);
        }
        catch (Exception ex)
        {
            ex.printStackTrace();
            return null;
        }

        String sql_find_user = "SELECT  username, password, accountstatus, comment, email FROM " + USERS;
        String append_sql = "";

        if (username != null)
        {
            append_sql = " WHERE username = '" + username + "'";
        }
        if (password != null)
        {
            if (append_sql.equals(""))
            {
                append_sql = " WHERE password = '" + password + "'";
            }
            else
            {
                append_sql += " and password = '" + password + "'";
            }
        }
        if (!append_sql.equals(""))
        {
            sql_find_user += append_sql;
        }

        try
        {
            ArrayList<HashMap<String, String>> users = new ArrayList<HashMap<String, String>>();
            ResultSet rs = state.executeQuery(sql_find_user);
            while (rs.next())
            {
                HashMap<String, String> user = new HashMap<String, String>();
                user.put("username", rs.getString("username"));
                user.put("password", rs.getString("password"));
                user.put("as", rs.getString("accountstatus"));
                user.put("comment", rs.getString("comment"));
                user.put("email", rs.getString("email"));

                users.add(user);
            }
            conn.commit();

            for (HashMap<String, String> user : users)
            {
                ResultSet gs = state.executeQuery("SELECT role FROM " + ROLES + " WHERE username = '" + user.get("username") + "'");

                String group = "";
                while (gs.next())
                {
                    if (!group.equals(""))
                    {
                        group += ",";
                    }
                    group += gs.getString("role");
                }

                userQueryResult.addUserTerm(user.get("username"), user.get("password"), group, user.get("as"), user.get("comment"), user.get("email"));
            }
        }
        catch (Exception ex)
        {
            ex.printStackTrace();
            return null;
        }

        if (userQueryResult.getSize() > 0)
        {
            return userQueryResult;
        }
        else
        {
            return null;
        }
    }

    // findUser(null) will return all users, which is why a UserQueryResult 
    // (a vector of UserTermInfo) is returned
    public UserQueryResult findUser(String username) throws SQLException
    {
        UserQueryResult userQueryResult = new UserQueryResult();

        conn.setAutoCommit(false);
        String sql_find_user = "SELECT  username, password, accountstatus, comment, email FROM " + USERS;
        String append_sql = "";

        if (username != null)
        {
            append_sql = " WHERE username = '" + username + "'";
        }
        if (!append_sql.equals(""))
        {
            sql_find_user += append_sql;
        }

        ArrayList<HashMap<String, String>> users = new ArrayList<HashMap<String, String>>();
        ResultSet rs = state.executeQuery(sql_find_user);
        while (rs.next())
        {
            HashMap<String, String> user = new HashMap<String, String>();
            user.put("username", rs.getString("username"));
            user.put("password", rs.getString("password"));
            user.put("as", rs.getString("accountstatus"));
            user.put("comment", rs.getString("comment"));
            user.put("email", rs.getString("email"));

            users.add(user);
        }
        conn.commit();

        for (HashMap<String, String> user : users)
        {
            ResultSet gs = state.executeQuery("SELECT role FROM " + ROLES + " WHERE username = '" + user.get("username") + "'");

            String group = "";
            while (gs.next())
            {
                if (!group.equals(""))
                {
                    group += ",";
                }
                group += gs.getString("role");
            }

            userQueryResult.addUserTerm(user.get("username"), user.get("password"), group, user.get("as"), user.get("comment"), user.get("email"));
        }

        if (userQueryResult.getSize() > 0)
        {
            return userQueryResult;
        }
        else
        {
            System.out.println("couldn't find the user");
            return null;
        }
    }

    public String modifyUserInfo(String username, String new_password, String groups, String accountstatus, String comment, String email)
    {
        try
        {
            conn.setAutoCommit(false);
            String sql_modify_user_info = "update " + USERS + " set ";

            boolean needComma = false;
            if (new_password != null && !new_password.equals(""))
            {
                sql_modify_user_info += "password='" + new_password + "'";
                needComma = true;
            }

            if (accountstatus != null && comment != null)
            {
                sql_modify_user_info += (needComma ? "," : "") + " accountstatus='" + accountstatus + "'" + ", comment='" + comment + "'";
                needComma = true;
            }

            if (email != null)
            {
                sql_modify_user_info += (needComma ? "," : "") + " email='" + email + "'";
            }

            sql_modify_user_info += " where username='" + username + "'";
            state.execute(sql_modify_user_info);

            String sql_delete_groups = "delete from " + ROLES + " where username='" + username + "'";
            state.execute(sql_delete_groups);

            String[] groupsArray = groups.split(",");
            for (String g : groupsArray)
            {
                String sql_insert_group = "insert into " + ROLES + " values ('" + username + "', '" + g + "')";
                state.execute(sql_insert_group);
            }

            conn.commit();
        }
        catch (Throwable e)
        {
            System.out.println("exception thrown:");
            if (e instanceof SQLException)
            {
                printSQLError((SQLException) e);
            }
            else
            {
                e.printStackTrace();
            }
            closeDatabase();
            return "Error:" + e.getMessage();
        }
        return "succeed";
    }

    public void db2txt()
    {
        System.err.println(db2txtString());
    }

    public String db2txtString()
    {
        //String db2txt = "Error in converting db2txt string.";
        String db2txt = "";
        try
        {
            conn.setAutoCommit(false); // An exception at this line can happen when the GS3 tomcat server is already running
                                        // and GS3 is already accessing the usersDB when this function independently tries to
                                        // connect to it (via usersDB2txt.java's main(). For an explanation of the possible 
                                        // reasons, see http://db.apache.org/derby/papers/DerbyTut/embedded_intro.html
                                        // section "Embedded Derby supports multiple users in one JVM".
            String sql_list_all_user = "select username, password, accountstatus, comment, email from " + USERS;
            ResultSet rs = state.executeQuery(sql_list_all_user);

            ArrayList<HashMap<String, String>> infoMap = new ArrayList<HashMap<String, String>>();

            while (rs.next())
            {
                HashMap<String, String> userMap = new HashMap<String, String>();
                userMap.put("username", rs.getString("username"));
                userMap.put("password", rs.getString("password"));
                userMap.put("status", rs.getString("accountstatus"));
                userMap.put("comment", rs.getString("comment"));
                userMap.put("email", rs.getString("email"));
                infoMap.add(userMap);
            }
            conn.commit();

            StringBuffer buffer = new StringBuffer();//("-------------------------------------");
            for (HashMap<String, String> user : infoMap)
            {
                ResultSet groupsSet = state.executeQuery("SELECT role FROM " + ROLES + " WHERE username = '" + user.get("username") + "'");
                String returnedGroups = "";
                while (groupsSet.next())
                {
                    if (!returnedGroups.equals(""))
                    {
                        returnedGroups += ",";
                    }
                    returnedGroups += groupsSet.getString("role");
                }
                conn.commit();

                buffer.append("USERNAME = " + user.get("username"));
                buffer.append("\nPASSWORD = " + user.get("password"));
                buffer.append("\nGROUPS = " + returnedGroups);
                buffer.append("\nSTATUS = " + user.get("status"));
                buffer.append("\nCOMMENT = " + user.get("comment"));
                buffer.append("\nEMAIL = " + user.get("email"));
                buffer.append("\n-------------------------------------\n");
            }
            db2txt = buffer.toString();

            conn.commit();
            closeDatabase();
        }
        catch (Exception ex)
        {
            ex.printStackTrace();
        }
        finally
        {
            return db2txt;
        }
    }

    static void printSQLError(SQLException e)
    {
        while (e != null)
        {
            System.out.println(e.toString());
            e = e.getNextException();
        }
    }
}