QED Administrator Console

com/quadcap/app/qed/AdminSession.java

Go to the documentation of this file.

package com.quadcap.app.qed;

/* Copyright 1999 - 2003 Quadcap Software.  All rights reserved.
 *
 * This software is distributed under the Quadcap Free Software License.
 * This software may be used or modified for any purpose, personal or
 * commercial.  Open Source redistributions are permitted.  Commercial
 * redistribution of larger works derived from, or works which bundle
 * this software requires a "Commercial Redistribution License"; see
 * http://www.quadcap.com/purchase.
 *
 * Redistributions qualify as "Open Source" under  one of the following terms:
 *   
 *    Redistributions are made at no charge beyond the reasonable cost of
 *    materials and delivery.
 *
 *    Redistributions are accompanied by a copy of the Source Code or by an
 *    irrevocable offer to provide a copy of the Source Code for up to three
 *    years at the cost of materials and delivery.  Such redistributions
 *    must allow further use, modification, and redistribution of the Source
 *    Code under substantially the same terms as this license.
 *
 * Redistributions of source code must retain the copyright notices as they
 * appear in each source code file, these license terms, and the
 * disclaimer/limitation of liability set forth as paragraph 6 below.
 *
 * Redistributions in binary form must reproduce this Copyright Notice,
 * these license terms, and the disclaimer/limitation of liability set
 * forth as paragraph 6 below, in the documentation and/or other materials
 * provided with the distribution.
 *
 * The Software is provided on an "AS IS" basis.  No warranty is
 * provided that the Software is free of defects, or fit for a
 * particular purpose.  
 *
 * Limitation of Liability. Quadcap Software shall not be liable
 * for any damages suffered by the Licensee or any third party resulting
 * from use of the Software.
 */

import java.io.File;

import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Properties;
import java.util.Vector;

//-//#ifdef JDK11
//-import com.quadcap.io.URLDecoder;
//#else
import java.net.URLDecoder;
//#endif

import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

import javax.servlet.ServletException;

import javax.servlet.http.HttpServletRequest;

import com.quadcap.sql.Database;

import com.quadcap.jdbc.JdbcDriver;

import com.quadcap.util.ConfigString;
import com.quadcap.util.Debug;

/**
 * A JavaBean which encapsulates administrative access to QED databases running
 * in this JVM.
 *
 * @author Stan Bailes
 */
public class AdminSession {
    String                      page            = "login.jsp";
    JdbcDriver                  qedDriver       = null;
    boolean                     isAuthenticated = false;
    String                      auth            = "admin";
    ConfigString                adminUser;
    ConfigString                adminPassword;
    Hashtable                   connections     = new Hashtable();

    /**
     * Construct a new admin session
     */
    public AdminSession() {
        adminUser = ConfigString.find("qed.admin.user", null);
        adminPassword = ConfigString.find("qed.admin.password", null);
        if (adminUser.getValue() == null) {
            Debug.println(0, "**** Since no configuration value was " +
                          "supplied for the config variable 'qed.admin.user'" +
                          ", authentication is disabled");
            isAuthenticated = true;
        }
    }

    /*{com.quadcap.app.qed.AdminSession.xml-0}
     *
     */
    
    /**
     * Return true if this session has been authenticated
     */
    public boolean isAuthenticated() { return isAuthenticated; }

    /**
     * Remember which page we're displaying in the body frame
     */
    public void setPage(String page) { this.page = page; }

    /**
     * Return the last page visited in the body frame
     */
    public String getPage() { return page; }

    /**
     * Return the QED JDBC Driver instance.  There should be only one.
     */
    public JdbcDriver getDriver() {
        if (qedDriver == null) {
            try {
                Class.forName("com.quadcap.jdbc.JdbcDriver");
            } catch (Exception e) {
                Debug.print(e);
                throw new RuntimeException("Can't get QED driver");
            }
            Enumeration e = DriverManager.getDrivers();
            while (e.hasMoreElements()) {
                Object obj = e.nextElement();
                if (obj instanceof JdbcDriver) {
                    qedDriver = (JdbcDriver)obj;
                    break;
                }
            }
        }
        return qedDriver;
    }
    
    /**
     * Return an enumeration of strings containing the names of all open
     * databases.
     */
    public Enumeration getDatabaseNames() {
        JdbcDriver driver = getDriver();
        if (driver == null) {
            return (new Vector()).elements();
        }
        return driver.getDatabaseNames();
    }

    /**
     * Return the opened database with the specified name.
     */
    private Database findDatabase(String name) {
        JdbcDriver driver = getDriver();
        if (driver == null) return null;
        return driver.getDatabase(name);
    }

    /**
     * Return the opened database with the specified name.
     */
    public Database getDatabase(String name) throws SQLException {
        Database db = null;
        Connection conn = getConnection(name);
        if (conn != null) {
            if (conn instanceof com.quadcap.jdbc.Connection) {
                db = ((com.quadcap.jdbc.Connection)conn).getDatabase();
            }
        }
        return db;
    }

    /**
     * Return a new connection for the specified database.
     */
    public Connection getConnection(String name, 
                                    boolean create, boolean force) 
        throws SQLException 
    {
        name = new File(name).getAbsolutePath();
        Connection conn = (Connection)connections.get(name);
        if (conn == null) {
            Database db = findDatabase(name);
            if (db == null) {
                Properties props = new Properties();
                if (create) props.put("create", "true");
                if (force) props.put("force", "true");
                props.put("user", auth);
                String url = "jdbc:qed:" + name;
                conn = getDriver().connect(url, props);
            } else {
                conn = getDriver().makeConnection(db, adminUser.getValue(),
                                                  adminPassword.getValue());
            }
            if (conn != null) {
                connections.put(name, conn);
            }
        }
        return conn;
    }

    /**
     * Return a new connection for the specified database.
     */
    public Connection getConnection(String name) throws SQLException {
        return getConnection(name, false, false);
    }

    /**
     * Close all open connections held by this session
     */
    void closeConnections() {
        Enumeration e = connections.elements();
        while (e.hasMoreElements()) {
            try {
                ((Connection)e.nextElement()).close();
            } catch (Throwable t) {}
        }
        connections = new Hashtable();
    }

    /**
     * jsp helper to build radio button checklists.
     */
    public static String isSel(String sel, String val) {
        if (sel != null && val != null && sel.equals(val)) {
            return " checked ";
        } else {
            return "";
        }
    }

    /**
     * jsp helper to build radio button checklists.
     */
    public static String isSet(int pos, int val) {
        if (((val >> pos) & 1) == 1) {
            return " checked ";
        } else {
            return "";
        }
    }

    /**
     * jsp helper to format time from backup time (minutes since midnite)
     */
    static char[] digits = {'0','1','2','3','4','5','6','7','8','9'};
    public static String lz2(int num) {
        if (num < 10) {
            return "0" + digits[num];
        } else {
            return "" + digits[(num/10)%10] + digits[num%10];
        }
    }

    /**
     * Login action
     */
    private void login(Properties p) {
        String admin = adminUser.getValue();
        if (admin != null) {
            String user = p.getProperty("user");
            if (user != null && user.equals(admin)) {
                String pass = p.getProperty("password");
                String adminpass = adminPassword.getValue();
                if (pass != null &&
                    (adminpass == null || pass.equals(adminpass))) {
                    isAuthenticated = true;
                    this.auth = admin;
                }
            }
        }
    }

    /**
     * Open action
     */
    private void open(Properties p) throws SQLException {
        String name = p.getProperty("dbName");
        name = new File(name).getAbsolutePath();
        boolean create =
            p.getProperty("create", "false").equalsIgnoreCase("true");
        boolean force =
            p.getProperty("force", "false").equalsIgnoreCase("true");
        getConnection(name, create, force);
    }

    /**
     * Close action
     */
    private void close(Properties p) {
        String name = p.getProperty("dbName");
        name = new File(name).getAbsolutePath();
        Connection conn = (Connection)connections.get(name);
        if (conn != null) {
            try {
                conn.close();
            } catch (Throwable t) {
                Debug.print(t);
            }
            connections.remove(name);
        }
    }

    /**
     * Logout action
     */
    private void logout(Properties p) {
        if (adminUser.getValue() != null) {
            isAuthenticated = false;
            closeConnections();
        }
    }

    /**
     * The main request handler.  Determine which action is to be invoked
     * and dispatch the appropriate routine.
     *
     * @param req the http request
     * @exception ServletException may be thrown
     */
    public void handleRequest(HttpServletRequest req) 
        throws ServletException, SQLException
    {
        String action = req.getParameter("action");
        if (action != null) {
            Properties p = getRequestProperties(req);
            Debug.println(4, "admin(" + action + "): " + p);
            if (action.equals("login")) {
                login(p);
            } else if (action.equals("logout")) {
                logout(p);
            } else if (!isAuthenticated()) {
                throw new ServletException("not logged in");
            } else if (action.equals("open")) {
                open(p);
            } else if (action.equals("close")) {
                close(p);
            } else {
                throw new ServletException("bad action");
            }
        } else if (!isAuthenticated()) {
            throw new ServletException("not logged in");
        }
    }

    /**
     * Build a Properties object containing all of the request parameters.
     *
     * @param req the http request
     * @return the request parameters
     */
    public Properties getRequestProperties(HttpServletRequest req) {
        Properties p = new Properties();
        Enumeration e = req.getParameterNames();
        while (e.hasMoreElements()) {
            String name = (String)e.nextElement();
            String val = req.getParameter(name);
            try {
                val = URLDecoder.decode(val);
            } catch (Throwable ex) {}
            p.put(name, val);
        }
        return p;
    }

}