Metacat

/*

 * ClientViewHelper.java

 *

 * Created on June 25, 2007, 9:57 AM

 *

 * To change this template, choose Tools | Template Manager

 * and open the template in the editor.

 */

package edu.ucsb.nceas.metacat.clientview;

import com.oreilly.servlet.multipart.FilePart;

import com.oreilly.servlet.multipart.MultipartParser;

import com.oreilly.servlet.multipart.ParamPart;

import com.oreilly.servlet.multipart.Part;

import edu.ucsb.nceas.metacat.McdbDocNotFoundException;

import edu.ucsb.nceas.metacat.accesscontrol.AccessControlForSingleFile;

import edu.ucsb.nceas.metacat.accesscontrol.AccessControlList;

import edu.ucsb.nceas.metacat.accesscontrol.XMLAccessAccess;

import edu.ucsb.nceas.metacat.client.MetacatInaccessibleException;

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

import edu.ucsb.nceas.utilities.access.DocInfoHandler;

import edu.ucsb.nceas.utilities.access.XMLAccessDAO;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.Reader;

import java.io.StringReader;

import java.util.HashMap;

import java.util.Vector;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.http.HttpSession;

import javax.xml.xpath.XPath;

import javax.xml.xpath.XPathConstants;

import javax.xml.xpath.XPathExpressionException;

import javax.xml.xpath.XPathFactory;

import org.w3c.dom.Node;

import org.w3c.dom.NodeList;

import org.xml.sax.ErrorHandler;

import org.xml.sax.InputSource;

import org.xml.sax.SAXException;

import org.xml.sax.XMLReader;

import org.xml.sax.helpers.XMLReaderFactory;

/**

 *

 * @author barteau

 */

public class ClientViewHelper {

    private XPath                                       xpath = XPathFactory.newInstance().newXPath();

    private HttpSession                                 clientSession;

    private ClientView                                  clientViewBean = null;

    private MetacatClient                               metacatClient = null;

    private boolean                                     loggedIn = false;

    private Document                                    metadataDoc = null;

    private int                                         sizeLimit;

    private String                                      contactName = "";

    public static final String                          PERMISSION_TYPE_DISALLOW = "deny";

     * for initializing.

     * @param request HttpServletRequest, sent from the client browser.

     * @throws edu.ucsb.nceas.metacat.client.MetacatInaccessibleException Thrown

    public ClientViewHelper(HttpServletRequest request) throws MetacatInaccessibleException {

        context = request.getContextPath();

    }

    /**

     * Creates a new instance of ClientViewHelper, using parameter values

     * for initializing.  This constructor is plain java code so it's the portal of

     * choice for JUnit testing.

     * @param host The host with port (if needed), such as "localhost:8084".

     * @param context The application root context.

     * @param bean ClientView instance, with pre-populated values.

     * @throws edu.ucsb.nceas.metacat.client.MetacatInaccessibleException thrown

     */

    public ClientViewHelper(String host, String context, ClientView bean) throws MetacatInaccessibleException {

        clientViewBean = bean;

        init(host, context);

    }

    private void init(String host, String context) throws MetacatInaccessibleException {

        String                              metacatPath = "http://%1s%2s/metacat";

        String                              tmp;

        metacatPath = tmp.replaceFirst("%2s", context);

        	sizeLimit =

        	throw new MetacatInaccessibleException(pnfe.getMessage());

        }

     * Main web API method for handling various actions.

     * @param request HttpServletRequest

     * @param response HttpServletResponse

     * @return String message

     */

            if (clientViewBean == null) {

            	//make a new one and shove it in the session

            	clientViewBean = new ClientView();

            	clientSession.setAttribute(ClientView.CLIENT_VIEW_BEAN, clientViewBean);

            }

        }

        if (clientViewBean != null) {

            action = clientViewBean.getAction();

            contentType = request.getContentType();

            if (action == null || action.equals("")) {

                } else {

                    action = request.getParameter("action");

                    clientViewBean.setMetaFileDocId(request.getParameter("metadataDocId"));

                    clientViewBean.setQformat(request.getParameter("qformat"));

                    clientViewBean.setContentStandard(request.getParameter("contentStandard"));

                    responseMap = handleClientRequest(null);

                    //*** Now that the action has been processed, clear it.

                    clientViewBean.setAction("");

//                    	HttpSession session = request.getSession(false);

//                    	session.setAttribute("ClientViewHelper", this);

                    	Cookie jSessionCookie = new Cookie("JSESSIONID", clientViewBean.getSessionid());

                    	response.addCookie(jSessionCookie);

                    }

                    responseMap = handleClientRequest(null);

                    clientViewBean.setAction("");

                } else if (action.equals("Upload")) {

                    try {

                        //*** Init the MultipartParser.

                        multipartParser = new MultipartParser(request, sizeLimit * 1024 * 1024);

                        responseMap = handleClientRequest(multipartParser);

                    } catch (IOException ex) {

                    }

                    clientViewBean.setAction("");

                } else if (action.equals("Download")) {

                    responseMap = handleClientRequest(null);

                    try {

                        handleDownloadResponse(responseMap, response);

                    } catch (IOException ex) {

                    }

                } else if (action.equals("Set Access")) {

                    responseMap = handleClientRequest(null);

                    clientViewBean.setAction("");

                } else {

                    responseMap = handleClientRequest(null);

                }

                result = (String) responseMap.get("message");

            }

        } else {

            result = "ClientViewHelper.clientRequest: ClientView bean is not instantiated.";

        }

        return(result);

    }

    /**

     * Main method for handling various actions.

     *

     * Note: This is mostly plain java code so it is JUnit friendly

     * (pass null as the MulipartParser).

     *

     * @param multipartParser Only needed if the action is "Upload".

     * @return HashMap containing "message", and possibly several other values.  If

     * the action is Download, than this will contain all needed values

     * to pass to handleDownloadResponse.

     */

        if (clientViewBean != null) {

            action = clientViewBean.getAction();

            if (action != null) {

                    if (action.equals("Login")) {

                        tmp = LDAP_TEMPLATE.replaceFirst("%1s", clientViewBean.getUsername());

                        posted_ldapUserName = tmp.replaceFirst("%2s", clientViewBean.getOrganization());

//                        	metacatClient.setSessionId(metacatSessionId);

//                        }

                        setLoggedIn(serverResponse);

                        if (isLoggedIn()) {

                            clientViewBean.setSessionid(metacatClient.getSessionId());

                    } else if (action.equals("Logout")) {

                        setLoggedIn(result);

                        result = parseXml("message", result);

                        clientViewBean.setMessage(ClientView.LOGIN_MESSAGE, result);

                        if (!isLoggedIn()) {

                            clientViewBean.setUsername("");

                            clientViewBean.setPassword("");

                            clientViewBean.setOrganization("");

                            clientViewBean.setSessionid(null);

                        }

                    } else if (action.equals("Delete")) {

                        ClientFgdcHelper.clientDeleteRequest(clientViewBean, this);

                        clientViewBean.setAction("read"); //*** Set for re-query.

                        //*** Note: the clientViewBean will already have the updated Meta Doc Id.

                                result = "ClientViewHelper.handleClientRequest: MultipartParser is not instantiated.";

                            else

                                result = handlePackageUpload(clientViewBean, multipartParser);

                        } else {

                            result = "You must be logged in to perform an upload.";

                        clientViewBean.setMessage(ClientView.SELECT_MESSAGE, result);

                        clientViewBean.setMessage(ClientView.UPDATE_MESSAGE, result);

                        result = action + " action not recognized.";

                    clientViewBean.setMessage(ClientView.ERROR_MESSAGE, result);

            }

        } else {

        return(responseMap);

    /**

     * This is a convenience method to reduce the amount of code in a Metacat Client.

     * It handles creating/reusing (per session) an instance of a ClientViewHelper.

     * @param request Since this is intended to be used by an Http client, it is passed the

     * available "request" variable (the HttpServletRequest).

     * @throws edu.ucsb.nceas.metacat.client.MetacatInaccessibleException Received by MetacatFactory.

     * @return ClientViewHelper instance.

     */

    public static ClientViewHelper clientViewHelperInstance(HttpServletRequest request) {

        if (result == null) {

            try {

                result = new ClientViewHelper(request);

                request.getSession().setAttribute("ClientViewHelper", result);

            } catch (MetacatInaccessibleException ex) {

                ex.printStackTrace();

            }

        }

        	result.clientViewBean = (ClientView) request.getSession().getAttribute(ClientView.CLIENT_VIEW_BEAN);

            if (result.clientViewBean == null) {

            	//make a new one and shove it in the session

            	result.clientViewBean = new ClientView();

            	request.getSession().setAttribute(ClientView.CLIENT_VIEW_BEAN, result.clientViewBean);

            }

        }

        boolean oldLoginValue = result.loggedIn;

        }

        if (!oldLoginValue || result.loggedIn) {

        	result.clientViewBean.setMessage(ClientView.UPLOAD_MESSAGE, "");

        }

    }

    /**

     * A convenience method to be used by client code that requires

     * the user to be logged in.  NOTE: setUser() must have been called first,

     * otherwise it will always return false.

     * @return boolean  true if user has logged in for this session, false otherwise.

     */

    public boolean isLoggedIn() {

        return(loggedIn);

    }

    /**

     * After calling "login(ldapUserName, pwd)", call this with the username

     * and servers response message.  You can than use isLoggedIn() to determine if

     * the user is logged in, getLoginResponseElement(), etc.  The user name will also

     * used by calls to doMetadataUpload() for Document Id creation (scope).

     * @param userName User name

     * @param serverResponse XML login response sent from Metacat.

     */

    public void setLoggedIn(String serverResponse) {

        this.loggedIn = isLoggedIn;

    }

    public void setUserName(String userName) {

        clientViewBean.setUsername(userName);

    }

        Document                    doc;

        try {

            doc = XMLUtilities.getXMLReaderAsDOMDocument(new StringReader(xml));

            result = (String) xpath.evaluate(elementName, doc.getDocumentElement(), XPathConstants.STRING);

            if (result != null)

                result = result.trim();

        } catch (IOException ex) {

            ex.printStackTrace();

        } catch (XPathExpressionException ex) {

            ex.printStackTrace();

        }

        return(result);

    }

        TreeMap                             allDocIds;

        if (!clientViewBean.getPathValue().equals("")) {

            allDocIds = getSelectQueryMap();

            result = ClientHtmlHelper.mapToHtmlSelect(allDocIds, "docId", "width: 240", 10);

        }

        return(result);

    }

    /**

     * Handles metadata file and data file uploads for inserting new

     * Metacat data packages.  Note: if content type is not "multipart/form-data",

     * nothing will happen.

     * @param request HTTP request.

     * @return A 1-line status message for the user.

     */

        String                      fileInfo[];

        int                         sizeLimit, idx;

        InputStream                 inputStream;

        HashMap                     paramsMap, dataDocIDs;

        //*** Get the First file, which should be the metadata file.

        paramsMap = new HashMap();

        if (metaFileName.toLowerCase().endsWith(".xml")) {

            setMetadataDoc(inputStream);

            //*** Get the Metadata File's DOC ID.

            scope = scope.replaceAll(" ", "_");

            scope = scope.toLowerCase();

            lastDocId = getMetacatClient().getLastDocid(scope);

            metaDocId = lastDocId = nextDocId(lastDocId, scope);

            //*** Loop thru all of the data files, get fileName and inputStream.

            dataDocIDs = new HashMap();

                //*** Get the data file's DOC ID.

                lastDocId = nextDocId;

            if (ClientFgdcHelper.isFGDC(getMetadataDoc())) {

                //TODO add other types of metadata grammars here...

                System.out.println("ClientViewHelper.handlePackageUpload: not an FGDC file = " + fileName);

                result = fileName + " is not an FGDC file.  Files not uploaded.";

                sendIt = false;

            }

            if (sendIt) {

                //*** Upload the metadata file to metacat.

                reader = XMLUtilities.getDOMTreeAsReader(metadataDoc.getDocumentElement(), false);

                getMetacatClient().insert(metaDocId, reader, null);

                result = "MetaCat Package Inserted:  the Document Identifier is " + metaDocId;

                reader.close();

                if (paramsMap.containsKey("publicAccess")) {

                    docIdStack.addAll(dataDocIDs.keySet());

                    setPublicAccess(this.PERMISSION_TYPE_ALLOW, metaDocId, docIdStack);

        } else {

            result = "The first file must be an XML Metadata file.  Files not uploaded.";

        }

        if (inputStream != null)

            inputStream.close();

        return(result);

    }

        String                      docId, lst = metaDocId, permOrder;

        else

        setPublicReadAccess(permissionType, metaDocId) ;

        while(!docIdStack.isEmpty()) {

            docId = (String) docIdStack.pop();

            setPublicReadAccess(permissionType, docId);

        }

        result = "Changed public read access to '" + permissionType + "' for " + result + lst;

        return(result);

    }

     * Set up public access by using accessblock to replace old success rules.

     * First, we need to get original access rules.

     * Second, remove all access rules of the user public, then add the new rules.

     */

    private void setPublicReadAccess(String permissionType, String docid)

      Vector<XMLAccessDAO> accessList = parseAccessXMLBlock(docid, originalAccessBlock);

      if(accessList != null  && !accessList.isEmpty()) {

        //there are some access rules in the metacat server for this docid

        XMLAccessDAO rule = accessList.elementAt(0);

        //we should persist the perm order from original access block

        String permOrder = rule.getPermOrder();

        //remove all public access rule but preserver other access rules.

        removeAllPublicAccessRules(accessList);

        //generate a new access rule and add it to the list

        XMLAccessDAO newRule = generateXMLAccessDAO(docid, AccessControlInterface.PUBLIC,

            AccessControlInterface.READSTRING, permissionType, permOrder);

        accessList.add(newRule);

      } else {

        //generate a new access rule and add it to the list

        accessList = new Vector<XMLAccessDAO>();

        XMLAccessDAO newRule = generateXMLAccessDAO(docid, AccessControlInterface.PUBLIC,

            AccessControlInterface.READSTRING, permissionType, AccessControlInterface.ALLOWFIRST);

        accessList.add(newRule);

      }

      //transform the new XMLAccessDAO object list to the String

      AccessControlForSingleFile controller = new AccessControlForSingleFile(docid);

      String accessBlock = controller.getAccessString(accessList);

      //send the access block to the metacat

      getMetacatClient().setAccess(docid, accessBlock);

    }

    /*

     * Parse the access xml block to get access rule list object.

     */

    private Vector<XMLAccessDAO> parseAccessXMLBlock(String docId, String accessXMLBlock) throws AccessControlException{

      try {

        // use DocInfoHandler to parse the access section into DAO objects

        XMLReader parser = null;

        DocInfoHandler docInfoHandler = new DocInfoHandler(docId);

        ContentHandler chandler = docInfoHandler;

        // Get an instance of the parser

        String parserName = PropertyService.getProperty("xml.saxparser");

        parser = XMLReaderFactory.createXMLReader(parserName);

        // Turn off validation

        parser.setFeature("http://xml.org/sax/features/validation", false);

        parser.setContentHandler((ContentHandler)chandler);

        parser.setErrorHandler((ErrorHandler)chandler);

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

        XMLAccessAccess xmlAccessAccess = new XMLAccessAccess();

         Vector<XMLAccessDAO> accessRuleList = docInfoHandler.getAccessControlList();

         return accessRuleList;

      } catch (PropertyNotFoundException pnfe) {

        throw new AccessControlException("ClientViewHelper.parseAccessXMLBlock - "

            + "property error when replacing permissions: " + pnfe.getMessage());

      } catch (AccessException ae) {

        throw new AccessControlException("ClientViewHelper.parseAccessXMLBlock - "

            + "DB access error when replacing permissions: " + ae.getMessage());

      } catch (SAXException se) {

        throw new AccessControlException("ClientViewHelper.parseAccessXMLBlock - "

            + "SAX error when replacing permissions: " + se.getMessage());

      } catch(IOException ioe) {

        throw new AccessControlException("ClientViewHelper.parseAccessXMLBlock - "

            + "I/O error when replacing permissions: " + ioe.getMessage());

      }

    }

    /*

     * Populate xmlAccessDAO object with the some parameters.

     */

    private XMLAccessDAO generateXMLAccessDAO(String docid, String principalName,

      String localId = DocumentUtil.getDocIdFromString(docid);

      int rev = DocumentUtil.getRevisionFromAccessionNumber(docid);

      String identifier = IdentifierManager.getInstance().getGUID(localId, rev);

      xmlAccessDAO.setPermission(Integer.valueOf(AccessControlList.intValue(permission)).longValue());

      xmlAccessDAO.setPermType(permType);

      xmlAccessDAO.setPermOrder(permOrder);

      return xmlAccessDAO;

    }

    /*

     * Remove every access rule for user public from the specified access rule list

     */

    private void removeAllPublicAccessRules(Vector<XMLAccessDAO> accessList) {

      if(accessList != null && !accessList.isEmpty()) {

        Vector<Integer> removingIndexList = new Vector<Integer>();

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

          XMLAccessDAO rule = accessList.elementAt(i);

          if(rule != null && rule.getPrincipalName() != null && rule.getPrincipalName().equalsIgnoreCase(AccessControlInterface.PUBLIC)) {

            //store the index which should be remove

            removingIndexList.add(new Integer(i));

          }

        }

        if(!removingIndexList.isEmpty()) {

          for(int i=removingIndexList.size()-1; i>=0; i--) {

            accessList.remove(removingIndexList.elementAt(i).intValue());

          }

       }

      }

    }

        Stack                       dataDocIDs;

        String                      result = "", xpathExpr = null;

        setMetadataDoc(metaDocId);

        //*** Build list of sub-documents.

        if (clientViewBean.getContentStandard().equals(ClientView.FEDERAL_GEOGRAPHIC_DATA_COMMITTEE)) {

            xpathExpr = ClientFgdcHelper.SUB_DOCS_PATH;

        } else if (clientViewBean.getContentStandard().equals(ClientView.ECOLOGICAL_METADATA_LANGUAGE)) {

            xpathExpr = null; //TODO  - EML

        }

        if (xpathExpr != null) {

            dataDocIDs = getNodeTextStack(xpath, xpathExpr, getMetadataDoc().getDocumentElement());

            result = setPublicAccess(permissionType, metaDocId, dataDocIDs);

        }

        return(result);

    }