io.logspace.agent.shaded.terracotta.quartz.UpdateChecker Maven / Gradle / Ivy
/*
* All content copyright Terracotta, Inc., unless otherwise indicated. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy
* of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
*/
package io.logspace.agent.shaded.terracotta.quartz;
import io.logspace.agent.shaded.quartz.core.QuartzScheduler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.InetAddress;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLConnection;
import java.net.URLEncoder;
import java.util.Properties;
import java.util.TimerTask;
/**
* Check for updates and alert users if an update is available
*
* @author Hung Huynh
*/
public class UpdateChecker extends TimerTask {
private static final Logger LOG = LoggerFactory.getLogger(UpdateChecker.class);
private static final long MILLIS_PER_SECOND = 1000L;
private static final String UNKNOWN = "UNKNOWN";
private static final String UPDATE_CHECK_URL = "http://www.terracotta.org/kit/reflector?kitID=quartz&pageID=update.properties";
private static final long START_TIME = System.currentTimeMillis();
private static final String PRODUCT_NAME = "Quartz Terracotta";
/**
* Run the update check
*/
@Override
public void run() {
checkForUpdate();
}
/**
* This method ensures that there will be no exception thrown.
*/
public void checkForUpdate() {
try {
if (!Boolean.getBoolean("io.logspace.agent.shaded.terracotta.quartz.skipUpdateCheck")) {
doCheck();
}
} catch (Throwable t) {
LOG.debug("Update check failed: " + t.toString());
}
}
private void doCheck() throws IOException {
LOG.debug("Checking for update...");
URL updateUrl = buildUpdateCheckUrl();
Properties updateProps = getUpdateProperties(updateUrl);
String currentVersion = getQuartzVersion();
String propVal = updateProps.getProperty("general.notice");
if (notBlank(propVal)) {
LOG.info(propVal);
}
propVal = updateProps.getProperty(currentVersion + ".notices");
if (notBlank(propVal)) {
LOG.info(propVal);
}
propVal = updateProps.getProperty(currentVersion + ".updates");
if (notBlank(propVal)) {
StringBuilder sb = new StringBuilder();
String[] newVersions = propVal.split(",");
for (int i = 0; i < newVersions.length; i++) {
String newVersion = newVersions[i].trim();
if (i > 0) {
sb.append(", ");
}
sb.append(newVersion);
propVal = updateProps.getProperty(newVersion + ".release-notes");
if (notBlank(propVal)) {
sb.append(" [");
sb.append(propVal);
sb.append("]");
}
}
if (sb.length() > 0) {
LOG.info("New update(s) found: " + sb.toString());
}
} else {
// Do nothing at all (ever) on no updates found (DEV-3799)
}
}
private String getQuartzVersion() {
return String.format("%s.%s.%s", QuartzScheduler.getVersionMajor(), QuartzScheduler.getVersionMinor(),
QuartzScheduler.getVersionIteration());
}
private Properties getUpdateProperties(URL updateUrl) throws IOException {
URLConnection connection = updateUrl.openConnection();
InputStream in = connection.getInputStream();
try {
Properties props = new Properties();
props.load(connection.getInputStream());
return props;
} finally {
if (in != null) {
in.close();
}
}
}
private URL buildUpdateCheckUrl() throws MalformedURLException, UnsupportedEncodingException {
String url = System.getProperty("quartz.update-check.url", UPDATE_CHECK_URL);
String connector = url.indexOf('?') > 0 ? "&" : "?";
return new URL(url + connector + buildParamsString());
}
private String buildParamsString() throws UnsupportedEncodingException {
StringBuilder sb = new StringBuilder();
sb.append("id=");
sb.append(getClientId());
sb.append("&os-name=");
sb.append(urlEncode(getProperty("os.name")));
sb.append("&jvm-name=");
sb.append(urlEncode(getProperty("java.vm.name")));
sb.append("&jvm-version=");
sb.append(urlEncode(getProperty("java.version")));
sb.append("&platform=");
sb.append(urlEncode(getProperty("os.arch")));
sb.append("&tc-version=");
sb.append(urlEncode(getQuartzVersion()));
sb.append("&tc-product=");
sb.append(urlEncode(PRODUCT_NAME));
sb.append("&source=");
sb.append(urlEncode(PRODUCT_NAME));
sb.append("&uptime-secs=");
sb.append(getUptimeInSeconds());
sb.append("&patch=");
sb.append(urlEncode(UNKNOWN));
return sb.toString();
}
private long getUptimeInSeconds() {
long uptime = System.currentTimeMillis() - START_TIME;
return uptime > 0 ? (uptime / MILLIS_PER_SECOND) : 0;
}
private int getClientId() {
try {
return InetAddress.getLocalHost().hashCode();
} catch (Throwable t) {
return 0;
}
}
private String urlEncode(String param) throws UnsupportedEncodingException {
return URLEncoder.encode(param, "UTF-8");
}
private String getProperty(String prop) {
return System.getProperty(prop, UNKNOWN);
}
private boolean notBlank(String s) {
return s != null && s.trim().length() > 0;
}
public static void main(String[] args) {
new UpdateChecker().run();
}
}