ParserXmlUserfile.java

/* The contents of this file are subject to the license and copyright terms
 * detailed in the license directory at the root of the source tree (also 
 * available online at http://fedora-commons.org/license/).
 */
package fedora.server.security.servletfilters.xmluserfile;

import java.io.IOException;
import java.io.InputStream;

import java.util.HashSet;
import java.util.Hashtable;
import java.util.Map;
import java.util.Set;

import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

import fedora.server.security.servletfilters.FinishedParsingException;

public class ParserXmlUserfile
        extends DefaultHandler {

    protected static Log log = LogFactory.getLog(ParserXmlUserfile.class);

    private SAXParser m_parser;

    private final InputStream m_xmlStream;

    public ParserXmlUserfile(InputStream xmlStream)
            throws IOException {
        log.debug(this.getClass().getName() + ".init<> " + " begin");

        m_xmlStream = xmlStream;
        try {
            SAXParserFactory spf = SAXParserFactory.newInstance();
            log.debug(this.getClass().getName() + ".init<> "
                    + " after newInstance");
            spf.setNamespaceAware(true);
            log.debug(this.getClass().getName() + ".init<> "
                    + " after setNamespaceAware");
            m_parser = spf.newSAXParser();
            log.debug(this.getClass().getName() + ".init<> "
                    + " after newSAXParser");
        } catch (Exception e) {
            e.printStackTrace();
            throw new IOException("Error getting XML parser: " + e.getMessage());
        } catch (Throwable t) {
            log.fatal(this.getClass().getName() + ".init<> "
                    + " caught me throwable");
            t.printStackTrace();
            log.fatal(this.getClass().getName() + ".populateCacheElement() "
                    + t);
            log.fatal(this.getClass().getName() + ".populateCacheElement() "
                    + t.getMessage() + " "
                    + (t.getCause() == null ? "" : t.getCause().getMessage()));
        }
    }

    private String username = null;

    private String password = null;

    private Boolean authenticated = null;

    private Map namedAttributes = null;

    private String attributeName = null;

    private Set attributeValues = null;

    public final Boolean getAuthenticated() {
        return authenticated;
    }

    public final Map getNamedAttributes() {
        return namedAttributes;
    }

    private StringBuffer value = null;

    private boolean inValue = false;

    private boolean foundUser = false;

    @Override
    public void startElement(String uri,
                             String localName,
                             String qName,
                             Attributes a) throws SAXException {
        if (localName.equals("users")) {
            log.debug("<users> foundUser==" + foundUser);
        } else if (localName.equals("user")) {
            log.debug("<user> foundUser==" + foundUser);
            log.debug("<<user>> this node username==" + a.getValue("name")
                    + " password==" + a.getValue("password"));
            if (username.equals(a.getValue("name"))) {
                foundUser = true;
                authenticated =
                        Boolean.valueOf(password != null
                                && password.equals(a.getValue("password")));
            }
        } else if (localName.equals("attribute")) {
            log.debug("<attribute> foundUser==" + foundUser);
            if (foundUser) {
                attributeName = a.getValue("name");
                attributeValues = new HashSet();
                log.debug("attributeName==" + attributeName);
            }
        } else if (localName.equals("value")) {
            log.debug("<value> foundUser==" + foundUser);
            inValue = true;
        }
    }

    @Override
    public void endElement(String uri, String localName, String qName)
            throws SAXException {
        if (localName.equals("users")) {
            log.debug("</users> foundUser==" + foundUser);
            authenticated = Boolean.FALSE;
        } else if (localName.equals("user")) {
            log.debug("</user> foundUser==" + foundUser);
            if (foundUser) {
                log.debug("at </user> (quick audit)");
                log.debug("authenticated==" + authenticated);
                log.debug("namedAttributes n==" + namedAttributes.size());
                throw new FinishedParsingException("");
            }
        } else if (localName.equals("attribute")) {
            log.debug("</attribute> foundUser==" + foundUser);
            if (foundUser) {
                log.debug("set n==" + attributeValues.size());
                namedAttributes.put(attributeName, attributeValues);
                log.debug("just added values for " + attributeName);
            }
            attributeName = null;
            attributeValues = null;
        } else if (localName.equals("value")) {
            log.debug("</value> foundUser==" + foundUser);
            if (foundUser) {
                attributeValues.add(value.toString());
                log.debug("just added " + value);
            }
            log.debug("quick audit of value string ==" + value);
            value.setLength(0);
            inValue = false;
        }
    }

    @Override
    public void characters(char[] ch, int start, int length) {
        if (inValue && foundUser && value != null) {
            value.append(ch, start, length);
            log.debug("characters called start==" + start + " length=="
                    + length);
        }
    }

    public void parse(String username, String password) throws IOException,
            FinishedParsingException {
        this.username = username;
        this.password = password;
        try {
            value = new StringBuffer();
            authenticated = null;
            namedAttributes = new Hashtable();
            foundUser = false;
            m_parser.parse(m_xmlStream, this);
        } catch (FinishedParsingException fpe) {
            throw fpe;
        } catch (Throwable e) {
            e.printStackTrace();
            throw new IOException("Error parsing XML: " + e.getMessage());
        }
    }

}