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$'

 *     '$Date$'

 * '$Revision$'

 * 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

import java.io.StringReader;

import java.sql.PreparedStatement;

import java.sql.ResultSet;

import java.sql.SQLException;

import java.util.Vector;

import org.xml.sax.EntityResolver;

import org.xml.sax.ErrorHandler;

import org.xml.sax.XMLReader;

import edu.ucsb.nceas.metacat.DBEntityResolver;

import edu.ucsb.nceas.metacat.DocumentImpl;

import edu.ucsb.nceas.metacat.McdbException;

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

import edu.ucsb.nceas.utilities.PropertyNotFoundException;

 * 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.

 */

                               implements AccessControlInterface

{

//  private static String isnull = DatabaseService.getDBAdapter().getIsNULLFunction();

  private Stack elementStack;

  private String 	doctype;

  private String 	systemid;

  private Vector resourceURL;

  private Vector resourceID;

  private String permType;

  private String permOrder;

  private String beginTime;

  private String endTime;

  private int    ticketCount;

  private Vector aclObjects = new Vector();

  private String tagName = "";

  private static Logger logMetacat = Logger.getLogger(AccessControlList.class);

   * Construct an instance of the AccessControlList class.

   * and from "getaccesscontrol" action

   * Construct an instance of the AccessControlList class.

   *

   * @param conn the JDBC connection where acl data are loaded

   *        resides.

		this.parserName = parserName;

		this.processingDTD = false;

		this.elementStack = new Stack();

		this.groups = groups;

		this.aclid = aclid;

		this.resourceURL = new Vector();

		this.resourceID = new Vector();

		this.principal = new Vector();

		this.permission = 0;

		this.ticketCount = 0;

		// this.publicAcc = null;

		this.serverCode = serverCode;

		DocumentImpl acldoc = new DocumentImpl(aclid + sep + rev);

		String acl = acldoc.toString();

		this.rev = acldoc.getRev();

		// Initialize the parse

		XMLReader parser = initializeParser();

		// parse the access file and write the info to xml_access

			parser.parse(new InputSource(new StringReader(acl)));

		} else {

			throw new McdbException("Could not retrieve access control list for:  " + aclid + sep + rev);

		}

// * Construct an instance of the AccessControlList class.

//   * It is used from command line execution.

//   *

//   * @param conn the JDBC connection where acl data are loaded

//   * @param docid the Accession# of the document with the acl data

//   * @param aclfilename the name of acl file containing acl data

//   * @param user the user connected to MetaCat servlet and owns the document

//   * @param groups the groups to which user belongs

//   */

//  public AccessControlList( Connection conn, String aclid, String aclfilename,

//                           String user, String[] groups )

//                  throws SAXException, IOException, McdbException

//  {

//    this(conn, aclid, new FileReader(new File(aclfilename).toString()),

//         user, groups, 1);

//  }

  {

    XMLReader parser = null;

    // Get an instance of the parser

    parser = XMLReaderFactory.createXMLReader(parserName);

    // Set Handlers in the parser

    // Set the EntityReslover to DBEntityResolver instance

  /**

  public void startDocument() throws SAXException

  {

    //delete all previously submitted permissions @ relations

    //this happens only on UPDATE of the access file

    try {

        deletePermissionsForRelatedResources(aclid);

      }

    } catch (SQLException sqle) {

      throw new SAXException(sqle);

    }

  }

  /**

   * the acl information in class variables.

   */

  public void startElement (String uri, String localName,

                            String qName, Attributes atts)

         throws SAXException

  {

    if(localName.equals("allow"))

    {

      tagName = "allow";

    }

    else if(localName.equals("deny"))

    {

      tagName = "deny";

    }

    if (atts != null) {

      int len = atts.getLength();

      for (int i = 0; i < len; i++) {

        currentNode.setAttribute(atts.getLocalName(i), atts.getValue(i));

      }

    }

  }

  /**

   * the acl information in class variables.

         throws SAXException

  {

    {

      return;

    }

    String currentTag = currentNode.getTagName();

          permission = permission | READ;

        } else if ( inputString.trim().toUpperCase().equals("WRITE") ) {

          permission = permission | WRITE;

        {

          permission = permission | ALL;

        beginTime = inputString.trim();

        endTime = inputString.trim();

        try {

          ticketCount = (new Integer(inputString.trim())).intValue();

        } catch (NumberFormatException nfe) {

          throw new SAXException("Wrong integer format for:" + inputString);

        }

  }

  /**

   * the acl information in class variables.

   */

  public void endElement (String uri, String localName, String qName)

         throws SAXException

  {

    String leavingTagName = leaving.getTagName();

         leavingTagName.equals("deny")    ) {

      if ( permission > 0 ) {

        try {

          for (int i=0; i < aclObjects.size(); i++) {

            // docid of the current object

            String docid = (String)aclObjects.elementAt(i);

            //docid = docID.getIdentifier();

            // the docid get here has revision number, so we need to

            // remove it.

          }

            DocumentIdentifier aclIdItself = new DocumentIdentifier(aclid);

            String aclIdString = aclIdItself.getIdentifier();

            insertPermissions(aclIdString,leavingTagName);

          throw new SAXException(sqle);

          throw new SAXException(e);

      }

      endTime = null;

      ticketCount = 0;

  }

    * SAX Handler that receives notification of DOCTYPE. Sets the DTD.

    * @param name name of the DTD

    * @param publicId Public Identifier of the DTD

    * @param systemId System Identifier of the DTD

    */

              throws SAXException {

    docname = name;

    doctype = publicId;

    systemid = systemId;

  }

  /**

   * @param name name of the entity

  public void startEntity(String name) throws SAXException {

    if (name.equals("[dtd]")) {

      processingDTD = true;

    }

  }

  /**

   * @param name name of the entity

  public void endEntity(String name) throws SAXException {

    if (name.equals("[dtd]")) {

      processingDTD = false;

    }

  }

  /**

  public String getDocname() {

    return docname;

  }

  /**

  public boolean processingDTD() {

    return processingDTD;

  }

  private Vector getACLObjects(String aclid)

  {

    int serialNumber = -1;

    PreparedStatement pstmt = null;

    try

    {

      //get connection from DBConnectionPool

      conn=DBConnectionPool.getDBConnection("AccessControlList.getACLObject");

      serialNumber=conn.getCheckOutSerialNumber();

      // delete all acl records for resources related to @aclid if any

      pstmt = conn.prepareStatement(

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      boolean hasRows = rs.next();

      while (hasRows) {

        //System.out.println("add acl object into vector !!!!!!!!!!!!!!!!!"+object);

        aclObjects.addElement(object);

      }//whil

    {

      throw e;

    }

    finally

    {

      try

      {

        pstmt.close();

      }

      finally

      {

        //retrun DBConnection

        DBConnectionPool.returnDBConnection(conn,serialNumber);

      }

    }

    return aclObjects;

  private void deletePermissionsForRelatedResources(String aclid)

  {

    //int serialNumber = -1;

    {

      //check out DBConenction

      //conn=DBConnectionPool.getDBConnection("AccessControlList.deltePerm");

      //serialNumber=conn.getCheckOutSerialNumber();

      pstmt.setString(1, aclid);

      connection.increaseUsageCount(1);

      pstmt.execute();

      //conn.increaseUsageCount(1);

    }

    catch (SQLException e)

    {

      throw e;

    }

    finally

    {

      //DBConnectionPool.returnDBConnection(conn,serialNumber);

    }

   * The DBConnection it is use is class field. Because we want to keep rollback

   * features and it need use same connection

  */

    //DBConnection conn = null;

    //int serialNumber = -1;

      //conn=DBConnectionPool.getDBConnection("AccessControlList.insertPerm");

      //serialNumber=conn.getCheckOutSerialNumber();

      pstmt = connection.prepareStatement(

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

      connection.increaseUsageCount(1);

      pstmt.setString(4, permType);

      pstmt.setString(5, permOrder);

      //incrase usagecount for DBConnection

      //conn.increaseUsageCount(1);

        prName = (String)principal.elementAt(j);

        pstmt.setString(2, prName);

      /*

        // check if there are conflict with permission's order

        String permOrderOpos = permOrder;

        int perm = getPermissions(permission, prName, docid, permOrder);

        if (  perm != 0 ) {

          if ( permOrder.equals("allowFirst") ) {

            permOrderOpos = "denyFirst";

          } else if ( permOrder.equals("denyFirst") ) {

            permOrderOpos = "allowFirst";

                    " for \"" + prName + "\" on document #" + docid +

                    " has/have been used with \"" + permOrderOpos + "\"");

      throw new

      SQLException("AccessControlList.insertPermissions(): " + e.getMessage());

    {

      pstmt.close();

      //return the DBConnection

      //DBConnectionPool.returnDBConnection(conn, serialNumber);

    }

  private int getPermissions(int permission, String principal,

                             String docid, String permOrder)

          throws SQLException

  {

    DBConnection conn = null;

    int serialNumber = -1;

    try

    {

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection("AccessControlList.getPermissions");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement(

            "AND principal_name = ? " +

            "AND perm_order NOT = ?");

      pstmt.setString(2, principal);

      pstmt.setString(3, permOrder);

      ResultSet rs = pstmt.getResultSet();

      boolean hasRow = rs.next();

      int perm = 0;

      while ( hasRow ) {

        perm = rs.getInt(1);

        perm = permission & perm;

        if ( perm != 0 ) {

          pstmt.close();

          return perm;

        }

        hasRow = rs.next();

      }

    }//try

    catch (SQLException e)

    {

      throw e;

    }

    finally

    {

      try

      {

      {

        DBConnectionPool.returnDBConnection(conn, serialNumber);

      }

    return 0;

  }

	public static int intValue(String permission) {

		{

		    thisPermission = new Integer(permission).intValue();

		    {

		        return thisPermission;

		    }

		    else

		    {

		        thisPermission = -1;

		    }

		catch(Exception e)

			thisPermission |= CHMOD;

		}

		if (permission.toUpperCase().contains(READSTRING)) {

			thisPermission |= READ;

		}

		if (permission.toUpperCase().contains(WRITESTRING)) {

			thisPermission |= WRITE;

		}

		if (permission.toUpperCase().contains(ALLSTRING)) {

			thisPermission |= ALL;

		}

  /* Get the text value of READ, WRITE, CHMOD or ALL. */

	public static String txtValue(int permission) {

		StringBuffer txtPerm = new StringBuffer();

		if ((permission & ALL) == ALL) {

			return ALLSTRING;

		}

		if ((permission & CHMOD) == CHMOD) {

			txtPerm.append(CHMODSTRING);

		}

		if ((permission & READ) == READ) {

			if (txtPerm.length() > 0)

				txtPerm.append(",");

			txtPerm.append(READSTRING);

		}

		if ((permission & WRITE) == WRITE) {

			if (txtPerm.length() > 0)

				txtPerm.append(",");

			txtPerm.append(WRITESTRING);

		}

	}

  /* Get the flag for public "read" access for @docid from db conn. */

  private String getPublicAccess(String docid) throws SQLException {

    int publicAcc = 0;

    DBConnection conn = null;

    int serialNumber = -1;

    try

    {

      //check out DBConnection

      conn=DBConnectionPool.getDBConnection("AccessControlList.getPublicAcces");

      serialNumber=conn.getCheckOutSerialNumber();

      pstmt = conn.prepareStatement("SELECT public_access FROM xml_documents " +

      pstmt.execute();

      ResultSet rs = pstmt.getResultSet();

      boolean hasRow = rs.next();

      if ( hasRow ) {

        publicAcc = rs.getInt(1);

      }

      return (publicAcc == 1) ? "yes" : "no";

    {

      try

      {

        pstmt.close();

      }

      finally

      {

        DBConnectionPool.returnDBConnection(conn, serialNumber);

      }

    }

  /* Get SystemID for @publicID from Metacat DB Catalog. */

		PreparedStatement pstmt = null;

		DBConnection conn = null;

		int serialNumber = -1;