com.jcabi.w3c.DefaultCssValidator Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2011-2022, jcabi.com
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met: 1) Redistributions of source code must retain the above
 * copyright notice, this list of conditions and the following
 * disclaimer. 2) Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided
 * with the distribution. 3) Neither the name of the jcabi.com nor
 * the names of its contributors may be used to endorse or promote
 * products derived from this software without specific prior written
 * permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
 * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.jcabi.w3c;

import com.jcabi.aspects.Immutable;
import com.jcabi.http.Request;
import com.jcabi.http.Response;
import com.jcabi.http.request.JdkRequest;
import com.jcabi.http.response.XmlResponse;
import com.jcabi.log.Logger;
import com.jcabi.xml.XML;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URI;
import java.util.Arrays;
import java.util.List;
import java.util.regex.Pattern;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.UriBuilder;
import lombok.EqualsAndHashCode;
import lombok.ToString;

/**
 * Default implementation of CSS validator.
 *
 * @see W3C API
 * @since 0.1
 */
@Immutable
@ToString
@EqualsAndHashCode(callSuper = false, of = "uri")
final class DefaultCssValidator
    extends AbstractBaseValidator implements Validator {

    /**
     * The URI to use in W3C.
     */
    private final transient String uri;

    /**
     * Public ctor.
     * @param entry Entry point to use
     */
    DefaultCssValidator(final URI entry) {
        super();
        this.uri = entry.toString();
    }

    @Override
    public ValidationResponse validate(final String css)
        throws IOException {
        final ValidationResponse response;
        final Pattern pattern = Pattern.compile(
            ".*^/\\* JIGSAW IGNORE: [^\\n]+\\*/$.*",
            Pattern.MULTILINE | Pattern.DOTALL
        );
        try {
            if (pattern.matcher(css).matches()) {
                response = AbstractBaseValidator.success("");
            } else {
                response = this.processed(css);
            }
        } catch (final IllegalArgumentException ex) {
            throw new IOException(ex);
        }
        return response;
    }

    /**
     * Return a response after real processing of the CSS.
     * @param css The CSS stylesheet to check
     * @return The response
     * @throws IOException if fails
     */
    private ValidationResponse processed(final String css) throws IOException {
        final Request req = this.request(
            AbstractBaseValidator.entity(
                "file", DefaultCssValidator.filter(css), "text/css"
            )
        );
        final Response response = DefaultCssValidator.correct(req.fetch());
        return DefaultCssValidator.build(
            response.as(XmlResponse.class)
                .registerNs("env", "http://www.w3.org/2003/05/soap-envelope")
                .registerNs("m", "http://www.w3.org/2005/07/css-validator")
                .assertXPath("//m:validity")
                .assertXPath("//m:checkedby")
                .xml()
        );
    }

    /**
     * Send request and return response.
     * @param entity The entity to POST
     * @return The response
     */
    private Request request(final String entity) {
        return new JdkRequest(this.uri)
            .method(Request.POST)
            .body().set(entity).back()
            .header(HttpHeaders.USER_AGENT, AbstractBaseValidator.USER_AGENT)
            .header(HttpHeaders.ACCEPT, "application/soap+xml")
            .header(
                HttpHeaders.CONTENT_TYPE,
                Logger.format(
                    "%s; boundary=%s",
                    MediaType.MULTIPART_FORM_DATA,
                    AbstractBaseValidator.BOUNDARY
                )
            );
    }

    /**
     * Build response from XML.
     * @param soap The response
     * @return The validation response just built
     */
    private static ValidationResponse build(final XML soap) {
        final DefaultValidationResponse resp = new DefaultValidationResponse(
            "true".equals(
                AbstractBaseValidator.textOf(soap.xpath("//m:validity/text()"))
            ),
            UriBuilder.fromUri(
                AbstractBaseValidator.textOf(soap.xpath("//m:checkedby/text()"))
            ).build(),
            AbstractBaseValidator.textOf(soap.xpath("//m:doctype/text()")),
            AbstractBaseValidator.charset(
                AbstractBaseValidator.textOf(soap.xpath("//m:charset/text()"))
            )
        );
        for (final XML node : soap.nodes("//m:error")) {
            resp.addError(DefaultCssValidator.defect(node));
        }
        for (final XML node : soap.nodes("//m:warning")) {
            resp.addWarning(DefaultCssValidator.defect(node));
        }
        return resp;
    }

    /**
     * Convert SOAP node to defect.
     * @param node The node
     * @return The defect
     */
    private static Defect defect(final XML node) {
        return new Defect(
            AbstractBaseValidator.intOf(node.xpath("m:line/text()")),
            AbstractBaseValidator.intOf(node.xpath("m:col/text()")),
            AbstractBaseValidator.textOf(node.xpath("m:source/text()")),
            AbstractBaseValidator.textOf(node.xpath("m:explanation/text()")),
            AbstractBaseValidator.textOf(node.xpath("m:messageid/text()")),
            AbstractBaseValidator.textOf(node.xpath("m:message/text()"))
        );
    }

    /**
     * Check if response from W3C contains some bad status.
     * @param response Response from W3c.
     * @return Response passed as parameter.
     * @throws IOException when has some bad status.
     */
    private static Response correct(final Response response)
        throws IOException {
        final List statuses = Arrays.asList(
            HttpURLConnection.HTTP_INTERNAL_ERROR,
            HttpURLConnection.HTTP_NOT_IMPLEMENTED,
            HttpURLConnection.HTTP_BAD_GATEWAY,
            HttpURLConnection.HTTP_UNAVAILABLE,
            HttpURLConnection.HTTP_GATEWAY_TIMEOUT,
            HttpURLConnection.HTTP_VERSION
        );
        if (statuses.contains(response.status())) {
            throw new IOException(
                String.format(
                    "Bad status from W3C server: %1d",
                    response.status()
                )
            );
        }
        return response;
    }

    /**
     * Exclude problematic lines from CSS.
     * @param css The css document
     * @return New document, with lines excluded
     */
    private static String filter(final String css) {
        return Pattern.compile(
            "^/\\* JIGSAW: [^\\n]+\\*/$",
            Pattern.MULTILINE | Pattern.DOTALL
        ).matcher(css).replaceAll("");
    }

}