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

 *    Release: @release@

 *

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

package edu.ucsb.nceas.metacat;

import java.io.*;

import java.sql.*;

import java.util.Stack;

import java.util.Vector;

import java.net.URL;

import java.net.MalformedURLException;

import org.xml.sax.Attributes;

import org.xml.sax.InputSource;

import org.xml.sax.EntityResolver;

import org.xml.sax.ErrorHandler;

import org.xml.sax.SAXParseException;

import org.xml.sax.XMLReader;

import org.xml.sax.helpers.XMLReaderFactory;

import org.xml.sax.helpers.DefaultHandler;

 * 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 AccessControlList extends DefaultHandler {

  private static final int WRITE = 2;

  private static final int READ = 4;

  private static String sysdate = MetaCatUtil.dbAdapter.getDateTimeFunction();

  private static String isnull = MetaCatUtil.dbAdapter.getIsNULLFunction();

  private Stack elementStack;

  private String  group;

  private String 	doctype;

  private String 	systemid;

  private Vector resourceURL;

  private Vector resourceID;

  private String permType;

  private String permOrder;

  private String endTime;

  private int    ticketCount;

   * 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

   * @param group the group to which user belongs

   * @param serverCode the serverid from xml_replication on which this document

   *        resides.

  {

    // Get an instance of the parser

    MetaCatUtil util = new MetaCatUtil();

    String parserName = util.getOption("saxparser");

    this.conn = conn;

    this.parserName = parserName;

    this.group = group;

    this.resourceID = new Vector();

    this.ticketCount = 0;

    XMLReader parser = initializeParser();

    parser.parse(new InputSource(acl));

  }

   * 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 group the group to which user belongs

                           String user, String group )

  {

  {

    XMLReader parser = null;

    // Get an instance of the parser

    parser = XMLReaderFactory.createXMLReader(parserName);

    // Set Handlers in the parser

    // Set the EntityReslover to DBEntityResolver instance

    EntityResolver eresolver = new DBEntityResolver(conn,this,null);

    parser.setEntityResolver((EntityResolver)eresolver);

    return parser;

  }

  /**

  public void startDocument() throws SAXException

  {

    //delete all previously submitted permissions @ relations

    //this happens only on UPDATE of the access file

    try {

      if ( aclid != null ) {

        //first delete all permissions for resources related to @aclid if any

        deletePermissionsForRelatedResources(aclid);

        //then delete all relations with docid of @aclid if any

        deleteRelations(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

  {

    BasicNode currentNode = new BasicNode(localName);

    if (atts != null) {

      int len = atts.getLength();

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

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

      }

    }

      permOrder = currentNode.getAttribute("order");

  }

  /**

   * the acl information in class variables.

   */

  public void characters(char ch[], int start, int length)

         throws SAXException

  {

    String inputString = new String(ch, start, length);

    BasicNode currentNode = (BasicNode)elementStack.peek();

    String currentTag = currentNode.getTagName();

      String docid = getDocid(inputString);

      // URL string of the current resource

      // docurl is declared in the class

      try {

        docurl = (new URL(inputString)).toString();

      } catch (MalformedURLException murle) {

        throw new SAXException(murle.getMessage());

      }

      // collect them in Vector variables

      resourceID.addElement(docid);

      resourceURL.addElement(docurl);

      // if it is the local server (originator of the document),

      // check for permission for @user on resource is needed

        boolean hasPermission = false;

        try {

          hasPermission = hasPermission("ALL",user,docid);

          if ( !hasPermission && group != null ) {

            hasPermission = hasPermission("ALL",group,docid);

          }

        } catch (SQLException e) {

          throw new SAXException(e.getMessage());

          throw new SAXException(

          "Permission denied for setting access control on " + docid);

        }

        permission = permission | READ;

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

        permission = permission | WRITE;

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

        permission = permission | ALL;

        throw new SAXException("Unknown permission type: " + inputString);

        endTime = inputString.substring(inputString.indexOf(" ")+1);

        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();

    if ( leavingTagName.equals("resourceIdentifier") ) {

      } catch (SQLException sqle) {

        throw new SAXException(sqle);

      }

                leavingTagName.equals("deny")    ) {

        try {

          throw new SAXException(sqle);

        }

      }

      endTime = null;

      ticketCount = 0;

      if ( publicAcc != null ) {

          throw new SAXException(sqle);

      }

      // reset the resource

      resourceURL = new Vector();

  }

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

//    processingDTD = true;

  }

  /**

   * @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 void deleteRelations(String docid)

  {

    stmt.execute("DELETE FROM xml_relation WHERE docid='" + docid + "'");

    stmt.close();

  }

          throws SQLException

  {

    String aclURL = "metacat://" + server + "/?docid=" + aclid;

    // insert relationship

    PreparedStatement pstmt;

    pstmt = conn.prepareStatement(

            "INSERT INTO xml_relation (docid,subject,relationship,object) " +

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

    pstmt.setString(1, aclid);

    pstmt.setString(2, aclURL);

    pstmt.setString(3, "isaclfor");

    pstmt.setString(4, resourceURL);

    pstmt.execute();

    pstmt.close();

  }

  {

      pstmt = conn.prepareStatement(

              "INSERT INTO xml_access " +

              "begin_time,end_time,ticket_count, accessfileid) VALUES " +

              "(?,?,?,?,?,to_date(?,'mm/dd/yy'),to_date(?,'mm/dd/yy'),?,?)");

      pstmt.setString(4, permType);

      pstmt.setString(5, permOrder);

      pstmt.setString(6, beginTime);

      pstmt.setString(7, endTime);

        pstmt.setString(8, "" + ticketCount);

      } else {

      String prName;

        pstmt.setString(1, docid);

          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";

            }

            throw new SQLException("Permission(s) " + txtValue(perm) +

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

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

          }

      throw new

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

  }

          throws SQLException

  {

    try {

      PreparedStatement pstmt;

      pstmt = conn.prepareStatement(

              "UPDATE xml_documents SET public_access = ?" +

        pstmt.setString(1, null);

      } else if ( publicAcc.toUpperCase().equals("YES") ) {

      } else {

        pstmt.setInt(1, 0);

      }

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

        pstmt.setString(2, (String)resourceID.elementAt(i));

        pstmt.execute();

      }

    } catch (SQLException e) {

      throw new

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

  }

  private int getPermissions(int permission, String principal,

                             String docid, String permOrder)

          throws SQLException

  {

    PreparedStatement pstmt;

    pstmt = conn.prepareStatement(

            "SELECT permission FROM xml_access " +

            "AND principal_name = ? " +

            "AND perm_order NOT = ?");

    pstmt.setString(2, principal);

    pstmt.setString(3, permOrder);

    pstmt.execute();

    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();

    }

    pstmt.close();

    return 0;

  }

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

  private int intValue ( String permission )

  {

    if ( permission.equals("READ") ) {

      return READ;

    } else if ( permission.equals("WRITE") ) {

      return WRITE;

    } else if ( permission.equals("ALL") ) {

      return ALL;

    }

    return -1;

  }

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

  private String txtValue ( int permission )

  {

    StringBuffer txtPerm = new StringBuffer("\"");

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

      txtPerm.append("read");

    }

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

      if ( txtPerm.length() > 0 ) txtPerm.append(",");

      txtPerm.append("write");

    }

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

      if ( txtPerm.length() > 0 ) txtPerm.append(",");

      txtPerm.append("all");

    }

    return txtPerm.append("\"").toString();

  }

  /* Read docid from @url. */

  private String getDocid ( String url ) throws SAXException

  {

    MetaCatUtil util = new MetaCatUtil();

    try {

      URL urlobj = new URL(url);

      Hashtable urlParams = util.parseQuery(urlobj.getQuery());

      if ( urlParams.containsKey("docid") ) {

        return (String)urlParams.get("docid"); // return the docid value

      } else {

        throw new

        SAXException("\"docid\" not specified within " + url);

      }

    } catch (MalformedURLException e) {

      throw new SAXException(e.getMessage());

    }

  }

  /**

    * Check from db connection if @principal has @permission on @resourceID.

    * @param permission permission type to check for

    * @param principal name of principal to check for @permission

    * @param resourceID resource identifier to check on

    */

  {

    PreparedStatement pstmt;

      try {

        boolean hasRow = rs.next();

        pstmt.close();

        if (hasRow) {

          return true;

        }

//System.out.println("Passed the check for public access");

      } catch (SQLException e) {

        throw new

                     "Error checking public access for document #"+resourceID+

                     ". " + e.getMessage());

    // since owner of resource has all permission on it,

      try {

        ResultSet rs = pstmt.getResultSet();

        boolean hasRow = rs.next();

        pstmt.close();

        if (hasRow) {

          return true;

      } catch (SQLException e) {

        throw new

                     "Error checking ownership for " + principal +

                     " on document #" + resourceID + ". " + e.getMessage());

      int ticketCount = 0;

      String permOrder = "";

      try {

                "FROM xml_access " +

                "AND principal_name = ? " +

                "AND perm_type = ? " +

                " BETWEEN " + isnull + "(begin_time," + sysdate + ") " +