org.opencastproject.adminui.endpoint.VersionEndpoint Maven / Gradle / Ivy
/*
* Licensed to The Apereo Foundation under one or more contributor license
* agreements. See the NOTICE file distributed with this work for additional
* information regarding copyright ownership.
*
*
* The Apereo Foundation licenses this file to you under the Educational
* Community 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://opensource.org/licenses/ecl2.txt
*
* 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 org.opencastproject.adminui.endpoint;
import static org.apache.http.HttpStatus.SC_OK;
import org.opencastproject.util.doc.rest.RestQuery;
import org.opencastproject.util.doc.rest.RestResponse;
import org.opencastproject.util.doc.rest.RestService;
import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;
import org.apache.commons.io.IOUtils;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.HttpClientBuilder;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
import java.lang.reflect.Type;
import java.util.Map;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
@Path("/")
@RestService(name = "VersionService", title = "Version service",
abstractText = "Provides latest opencast version",
notes = { "This service offers the GET method to retrieve the latest opencast version from https://api.github.com ."})
@Component(
immediate = true,
service = VersionEndpoint.class,
property = {
"service.description=Admin UI - Latest Version Endpoint",
"opencast.service.type=org.opencastproject.adminui.endpoint.VersionEndpoint",
"opencast.service.path=/admin-ng/oc-version"
}
)
public class VersionEndpoint {
/** The logging facility */
private static final Logger logger = LoggerFactory.getLogger(VersionEndpoint.class);
/** The version */
private String version = "";
/** GitHub URL */
private static final String URL = "https://api.github.com/repos/opencast/opencast/releases";
/** The date */
private long lastUpdated = 0;
private static final Gson gson = new Gson();
private static final Type mapArrayType = new TypeToken[]>() { }.getType();
/** OSGi callback. */
@Activate
protected void activate() {
logger.info("Activate the Admin ui - Latest version endpoint");
}
@GET
@Path("version.json")
@Produces(MediaType.APPLICATION_JSON)
@RestQuery(name = "latestversion", description = "Returns the latest Opencast version",
returnDescription = "Returns the latest Opencast version retrieved from GitHub",
responses = { @RestResponse(responseCode = SC_OK, description = "The latest Opencast version.") })
public String getVersion() {
if (System.currentTimeMillis() / 1000L - lastUpdated >= 3600) {
updateVersion();
}
return gson.toJson(version);
}
private synchronized void updateVersion() {
if (System.currentTimeMillis() / 1000L - lastUpdated < 3600) {
return;
}
HttpClient client = HttpClientBuilder.create().useSystemProperties().build();
HttpGet request = new HttpGet(URL);
final String responseString;
try {
HttpResponse response = client.execute(request);
responseString = IOUtils.toString(response.getEntity().getContent(), "utf-8");
} catch (IOException e) {
// Be silent about not reaching GitHub. It's not the end of the world and we don't want to spam the logs.
logger.debug("Could not get version from GitHub", e);
return;
}
try {
Map[] data = gson.fromJson(responseString, mapArrayType);
double latestVersion = 0;
for (Map release : data) {
if (Double.parseDouble((String) release.get("tag_name")) > latestVersion) {
latestVersion = Double.parseDouble((String) release.get("tag_name"));
version = (String) release.get("tag_name");
}
}
lastUpdated = System.currentTimeMillis() / 1000L;
} catch (Exception e) {
logger.warn("Error while parsing the Opencast version from GitHub", e);
}
}
}