Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that loads eml-access.xml file containing ACL 

 *             for a metadata document into relational DB

 *  Copyright: 2000 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Jivka Bojilova

 *

 *   '$Author: daigle $'

 *     '$Date: 2009-08-14 14:22:13 -0700 (Fri, 14 Aug 2009) $'

 * '$Revision: 5025 $'

 *

 * 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 */

package edu.ucsb.nceas.metacat;

import java.io.*;

import java.sql.*;

import java.util.Stack;

import java.util.Vector;

import java.util.Hashtable;

import java.net.URL;

import java.net.MalformedURLException;

import org.apache.log4j.Logger;

import edu.ucsb.nceas.metacat.database.DBConnection;

import edu.ucsb.nceas.metacat.database.DBConnectionPool;

import edu.ucsb.nceas.metacat.util.DocumentUtil;

/** 

 * A Class that loads eml-access.xml file containing ACL for a metadata

 * document into relational DB. It extends DefaultHandler class to handle

 * SAX parsing events when processing the XML stream.

 */

public class AccessControlForSingleFile implements AccessControlInterface 

{

  private String docId;

  private String principal;

  private int    permission;

  private String permType;

  private String permOrder;

  private Logger logMetacat = Logger.getLogger(AccessControlForSingleFile.class);

  /**

   * Construct an instance of the AccessControlForSingleFile class.

   * @param myAccessNumber  the docid or docid with dev will be controlled

   * @param myprincipal  the principal will have permission

   * @param myPermission the permission will be given

   * @param myPermType  the permsission type, allow or deny

   * @param myPermOrder  the permission order, allowFirst or denyFirst

   */

  public AccessControlForSingleFile(String myAccessionNumber,

                                    String myPrincipalName,

                                    String myPermission,

                                    String myPermType,

                                    String myPermOrder) 

                                   throws Exception

  {

    try

    {

      //Get rid of dev if myaccessNumber has one;

      docId = DocumentUtil.getDocIdFromString(myAccessionNumber);

      if (docId == null || docId.equals(""))

      {

        throw new Exception("Docid couldn't be null");

      }

      // Check principal

      principal = myPrincipalName;

      if (principal == null || principal.equals(""))

      {

        throw new Exception("principal couldn't be null");

      }

      // get permission value

      permission = AccessControlList.intValue(myPermission);

      if (permission == -1)

      {

        throw new Exception("permission "+ myPermission + " is not valid");

      }

      // check permission type

      permType = myPermType;

      // if permtype is not allow or deny, throw a exception

      if (permType == null

          || (!permType.equals(AccessControlInterface.ALLOW)

          && !permType.equals(AccessControlInterface.DENY)))

      {

        throw new Exception("permtype should be "+AccessControlInterface.ALLOW+

                            " or " +AccessControlInterface.DENY);

      }

      // check permission order

      permOrder = myPermOrder;

      // If permission order is not allowFirst or denyFirst, default to denyFirst.

      if (permOrder == null || !permOrder.equals(AccessControlInterface.DENYFIRST)) {

        permOrder = AccessControlInterface.ALLOWFIRST;

      }

      //debugMessage

      logMetacat.info("docid in AccessControlForSingleFiel: " +

                                docId);

      logMetacat.info("principal in AccessControlForSingleFiel: " +

                                principal);

      logMetacat.info("permission in AccessControlForSingleFiel: " +

                                permission);

      logMetacat.info("permType in AccessControlForSingleFiel: " +

                                permType);

      logMetacat.info("permOrder in AccessControlForSingleFiel: " +

                                permOrder);

    }

    catch (Exception e)

    {

      logMetacat.error("Error in construct of AccessControlForSingle" +

                               "File for docid: " + docId + " : " + e.getMessage());

      throw e;

    }

  }

  /**

   * Method to insert records into xml_access table

   */

  public void insertPermissions() throws SQLException 

  {

    PreparedStatement pstmt = null;

    DBConnection conn = null;

    int serialNumber = -1;

    try

    {

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection

                               ("AccessControlForSingleFiel.insertPermissions");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement(

              "INSERT INTO xml_access " + 

              "(docid, principal_name, permission, perm_type, perm_order " +

              ") VALUES (?,?,?,?,?)");

      // Bind the values to the query

      pstmt.setString(1, docId);

      pstmt.setString(2, principal);

      pstmt.setInt(3, permission);

      pstmt.setString(4, permType);

      pstmt.setString(5, permOrder);

      //pstmt.setString(6, AccessControlInterface.ACLID);

      pstmt.execute();

    }//try

    catch (SQLException e)

    {

      logMetacat.error("Error in AccessControlForSingleFile.insert" +

                               "Permissions: " + e.getMessage());

      throw e;

    }

    finally

    {

      try

      {

        pstmt.close();

      }

      finally

      {

        DBConnectionPool.returnDBConnection(conn, serialNumber);

      }

    }

  }

  /**

   * 

   * @return true if the Access Control for this file already exists in the DB

   * @throws SQLException

   */

  public boolean accessControlExists() throws SQLException 

  {

	  boolean exists = false;

    PreparedStatement pstmt = null;

    DBConnection conn = null;

    int serialNumber = -1;

    try

    {

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection

                               ("AccessControlForSingleFiel.accessControlExists");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement(

              "SELECT * FROM xml_access " + 

              "WHERE docid = ? " +

              "AND principal_name = ? " +

              "AND permission = ? " +

              "AND perm_type = ? " +

              "AND perm_order =? ");

      // Bind the values to the query

      pstmt.setString(1, docId);

      pstmt.setString(2, principal);

      pstmt.setInt(3, permission);

      pstmt.setString(4, permType);

      pstmt.setString(5, permOrder);

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      exists = rs.next();

    }//try

    catch (SQLException e)

    {

      logMetacat.error("Error in AccessControlForSingleFile.accessControlExists: "

                               + e.getMessage());

      throw e;

    }

    finally

    {

      try

      {

        pstmt.close();

      }

      finally

      {

        DBConnectionPool.returnDBConnection(conn, serialNumber);

      }

    }

    return exists;

  }

  public String getAccessString() {

	  StringBuffer sb = new StringBuffer();

	  sb.append("<access>");

		  sb.append("<permOrder>");

		  sb.append(this.permOrder);

		  sb.append("</permOrder>");

		  sb.append("<permType>");

		  sb.append(this.permType);

		  sb.append("</permType>");

		  sb.append("<permission>");

		  sb.append(AccessControlList.txtValue(this.permission));

		  sb.append("</permission>");

		  sb.append("<principal>");

		  sb.append(this.principal);

		  sb.append("</principal>");

	  sb.append("</access>");

	  return sb.toString();

  }

}