source: CMDIValidator/trunk/cmdi-validator-core/src/main/java/eu/clarin/cmdi/validator/extensions/CheckHandlesExtension.java @ 5402

/**
 * This software is copyright (c) 2014 by
 *  - Institut fuer Deutsche Sprache (http://www.ids-mannheim.de)
 * This is free software. You can redistribute it
 * and/or modify it under the terms described in
 * the GNU General Public License v3 of which you
 * should have received a copy. Otherwise you can download
 * it from
 *
 *   http://www.gnu.org/licenses/gpl-3.0.txt
 *
 * @copyright Institut fuer Deutsche Sprache (http://www.ids-mannheim.de)
 *
 * @license http://www.gnu.org/licenses/gpl-3.0.txt
 *  GNU General Public License v3
 */
package eu.clarin.cmdi.validator.extensions;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;

import org.apache.http.HttpStatus;
import net.sf.saxon.s9api.SaxonApiException;
import net.sf.saxon.s9api.XPathCompiler;
import net.sf.saxon.s9api.XPathExecutable;
import net.sf.saxon.s9api.XPathSelector;
import net.sf.saxon.s9api.XdmItem;
import net.sf.saxon.s9api.XdmNode;
import eu.clarin.cmdi.validator.CMDIValidatorException;
import eu.clarin.cmdi.validator.CMDIValidatorExtension;
import eu.clarin.cmdi.validator.CMDIValidatorInitException;
import eu.clarin.cmdi.validator.CMDIWriteableValidationReport;
import eu.clarin.cmdi.validator.utils.HandleResolver;
import eu.clarin.cmdi.validator.utils.LocationUtils;

public class CheckHandlesExtension extends CMDIValidatorExtension {
    private static final String XPATH = "//*:ResourceProxy[*:ResourceType/text() = 'Resource' or *:ResourceType/text() = 'Metadata']/*:ResourceRef";
    private static final String HDL_SCHEME = "hdl";
    private static final String HDL_PROXY_HTTP = "http";
    private static final String HDL_PROXY_HTTPS = "https";
    private static final String HDL_PROXY_HOST = "hdl.handle.net";
    private static final String URN_SCHEME = "urn";
    private final boolean resolveHandles;
    private HandleResolver resolver = null;
    private XPathExecutable xpath;


    public CheckHandlesExtension(boolean resolveHandles) {
        this.resolveHandles = resolveHandles;
    }


    public boolean isResolvingHandles() {
        return resolveHandles;
    }


    public HandleResolver.Statistics getStatistics() {
        return (resolver != null) ? resolver.getStatistics() : null;
    }


    @Override
    protected void doInitialize() throws CMDIValidatorInitException {
        if (resolveHandles) {
            this.resolver = new HandleResolver();
        }

        try {
            final XPathCompiler compiler = processor.newXPathCompiler();
            this.xpath = compiler.compile(XPATH);
        } catch (SaxonApiException e) {
            throw new CMDIValidatorInitException(
                    "error initializing check handle extension", e);
        }
    }


    @Override
    public void validate(final XdmNode document,
            final CMDIWriteableValidationReport report)
            throws CMDIValidatorException {
        try {
            XPathSelector selector = xpath.load();
            selector.setContextItem(document);
            for (XdmItem item : selector) {
                String handle = null;
                final int line   = LocationUtils.getLineNumber(item);
                final int column = LocationUtils.getColumnNumber(item);
                final String h = item.getStringValue();
                if (h != null) {
                    handle = h.trim();
                    if (handle.isEmpty()) {
                        handle = null;
                    } else {
                        if (!handle.equals(h)) {
                            report.reportWarning(line, column, "handle '" + h +
                                    "' contains leading or tailing spaces " +
                                    "within <ResourceRef> element");
                        }
                    }
                }

                if (handle != null) {
                    checkHandleURISyntax(report, handle, line, column);
                } else {
                    report.reportError(line, column,
                            "invalid handle (<ResourceRef> was empty)");
                }
            }
        } catch (SaxonApiException e) {
            throw new CMDIValidatorException("failed to check handles", e);
        }
    }


    private void checkHandleURISyntax(
            final CMDIWriteableValidationReport report, final String handle,
            final int line, final int column) throws CMDIValidatorException {
        try {
            final URI uri = new URI(handle);
            if (HDL_SCHEME.equalsIgnoreCase(uri.getScheme())) {
                String path = uri.getSchemeSpecificPart();
                if (!path.startsWith("/")) {
                    path = "/" + path;
                }
                try {
                    final URI actionableURI =
                            new URI(HDL_PROXY_HTTP, HDL_PROXY_HOST, path, null);
                    checkHandleResolves(report, actionableURI, line, column);
                } catch (URISyntaxException e) {
                    /* should not happen */
                    throw new CMDIValidatorException(
                            "created an invalid URI", e);
                }
            } else if (URN_SCHEME.equals(uri.getScheme())) {
                if (resolveHandles) {
                    report.reportInfo(line, column, "PID '" + handle +
                            "' skipped, because URN resolving is not supported");
                } else {
                    report.reportInfo(line, column, "PID '" + handle +
                            "' skipped, because URN sytax checking is not supported");
                }
            } else if (HDL_PROXY_HTTP.equalsIgnoreCase(uri.getScheme()) ||
                    HDL_PROXY_HTTPS.equalsIgnoreCase(uri.getScheme())) {
                if (uri.getHost() != null) {
                    if (!HDL_PROXY_HOST.equalsIgnoreCase(uri.getHost())) {
                        report.reportError(line, column,
                                "The URI of PID '" + handle +
                                "' contains an unexpected host part of '" +
                                uri.getHost() + "'");
                    }
                    checkHandleResolves(report, uri, line, column);
                } else {
                    report.reportError(line, column, "The URI of PID '" +
                            handle + "' is missing the host part");
                }
            } else {
                if (uri.getScheme() != null) {
                    report.reportError(line, column,
                            "The URI of PID '" + handle +
                            "' contains an unexpected schema part of '" +
                            uri.getScheme() + "'");
                } else {
                    report.reportError(line, column, "The URI of PID '" +
                            handle + "' is missing a proper schema part");
                }
            }
        } catch (URISyntaxException e) {
            report.reportError(line, column, "PID '" + handle +
                    "' is not a well-formed URI: " + e.getMessage());
        }
    }


    private void checkHandleResolves(
            final CMDIWriteableValidationReport result, final URI uri,
            final int line, final int column) throws CMDIValidatorException {
        if (resolver != null) {
            try {
                int code = resolver.resolve(uri);
                switch (code) {
                case HttpStatus.SC_OK:
                    /* no special message in this case */
                    break;
                case HttpStatus.SC_UNAUTHORIZED:
                    /* FALL-THROUGH */
                case HttpStatus.SC_FORBIDDEN:
                    result.reportInfo(line, column, "PID '" + uri +
                            "' resolved to an access protected resource (" +
                            code + ")");
                    break;
                case HttpStatus.SC_NOT_FOUND:
                    result.reportError(line, column, "PID '" + uri +
                            "' resolved to an non-existing resource (" +
                            code + ")");
                    break;
                case HandleResolver.TIMEOUT:
                    result.reportWarning(line, column,
                            "Timeout while resolving PID '" + uri + "'");
                    break;
                case HandleResolver.UNKNOWN_HOST:
                    result.reportWarning(line, column,
                            "Unable to resolve host '" + uri.getHost() +
                            "' while resolving PID '" + uri + "'");
                    break;
                case HandleResolver.ERROR:
                    result.reportWarning(line, column,
                            "An error occurred while resolving PID '" +
                            uri + "'");
                    break;
                default:
                    result.reportWarning(-line, column, "PID '" + uri +
                            "' resolved with an unexpected result (" +
                            code + ")");
                    break;
                } // switch
            } catch (IOException e) {
                throw new CMDIValidatorException(
                        "error while resolving handle '" + uri + "'", e);
            }
        }
    }

} // CheckHandleExtension