org.hudsonci.plugins.snapshotmonitor.internal.SimpleMetadataChecker Maven / Gradle / Ivy

Go to download
/**
 * The MIT License
 *
 * Copyright (c) 2010-2011 Sonatype, Inc. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package org.hudsonci.plugins.snapshotmonitor.internal;

import hudson.util.IOException2;
import org.hudsonci.utils.io.Closer;
import org.hudsonci.maven.model.MavenCoordinatesDTO;
import com.thoughtworks.xstream.core.util.Base64Encoder;
import org.apache.maven.artifact.repository.metadata.Metadata;
import org.apache.maven.artifact.repository.metadata.io.xpp3.MetadataXpp3Reader;
import org.hudsonci.plugins.snapshotmonitor.MetadataChecker;
import org.hudsonci.plugins.snapshotmonitor.model.WatchedDependency;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;

/**
 * Checks {@link Metadata} instances for the last updated time.
 *
 * @author Jason Dillon
 * @since 2.1.0
 */
public class SimpleMetadataChecker
    implements MetadataChecker
{
    private static final Logger log = LoggerFactory.getLogger(SimpleMetadataChecker.class);

    /** The URL of the Maven repository. */
    private final URL baseUrl;

    /** Http basic auth value; if user/pass configured. */
    private final String auth;

    public SimpleMetadataChecker(String baseUrl, final String user, final String password) {
        assert baseUrl != null;

        // Append / to URL if it needs one, else URL(URL,String) won't behave as we want
        if (!baseUrl.endsWith("/")) {
            baseUrl += "/";
        }

        try {
            this.baseUrl = new URL(baseUrl);
        }
        catch (MalformedURLException e) {
            throw new RuntimeException(e);
        }

        // If we need auth, then setup the Authorization header value
        if (user != null && password != null) {
            this.auth = "Basic " + new Base64Encoder().encode((user + ":" + password).getBytes());
        }
        else {
            this.auth = null;
        }
    }

    private Metadata load(final String path) throws IOException {
        assert path != null;

        URL url = new URL(baseUrl, path);
        log.debug("Checking: {} ({})", url, path);

        URLConnection c = url.openConnection();
        if (auth != null) {
            c.setRequestProperty("Authorization", auth);
        }

        MetadataXpp3Reader reader = new MetadataXpp3Reader();
        BufferedReader input = new BufferedReader(new InputStreamReader(c.getInputStream()));
        Metadata data;
        try {
            data = reader.read(input, false);
        }
        catch (Exception e) {
            throw new IOException2("Failed to parse: " + path, e);
        }
        finally {
            Closer.close(input);

            try {
                if (c instanceof HttpURLConnection) {
                    HttpURLConnection.class.cast(c).disconnect();
                }
            }
            catch (Exception ignore) {
                // ignore
            }
        }

        return data;
    }

    public String getPath(final MavenCoordinatesDTO artifact) {
        assert artifact != null;
        return String.format("%s/%s/%s/maven-metadata.xml", artifact.getGroupId().replace('.', '/'), artifact.getArtifactId(), artifact.getVersion());
    }

    private Metadata load(final WatchedDependency dependency) throws IOException {
        assert dependency != null;
        return load(getPath(dependency));
    }

    /**
     * Returns the last-updated date for the given dependency, or 0 if unavailable.
     */
    public long check(final WatchedDependency dependency) throws IOException {
        Metadata md = load(dependency);
        if (md.getVersioning() == null) {
            return 0;
        }
        String tmp = md.getVersioning().getLastUpdated();
        log.trace("Last-updated: {}", tmp);
        if (tmp == null) {
            return 0;
        }
        return Long.parseLong(tmp);
    }
}