From 9e78909ff2a225782feed8fb09802202c450bd73 Mon Sep 17 00:00:00 2001 From: =?utf8?q?David=20=E2=80=98Bombe=E2=80=99=20Roden?= Date: Sun, 9 Jan 2011 21:48:06 +0100 Subject: [PATCH] Add update checker. --- .../net/pterodactylus/sone/core/UpdateChecker.java | 233 +++++++++++++++++++++ .../pterodactylus/sone/core/UpdateListener.java | 42 ++++ .../sone/core/UpdateListenerManager.java | 55 +++++ 3 files changed, 330 insertions(+) create mode 100644 src/main/java/net/pterodactylus/sone/core/UpdateChecker.java create mode 100644 src/main/java/net/pterodactylus/sone/core/UpdateListener.java create mode 100644 src/main/java/net/pterodactylus/sone/core/UpdateListenerManager.java diff --git a/src/main/java/net/pterodactylus/sone/core/UpdateChecker.java b/src/main/java/net/pterodactylus/sone/core/UpdateChecker.java new file mode 100644 index 0000000..0839cb9 --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/core/UpdateChecker.java @@ -0,0 +1,233 @@ +/* + * Sone - UpdateChecker.java - Copyright © 2011 David Roden + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.sone.core; + +import java.io.IOException; +import java.io.InputStream; +import java.io.InputStreamReader; +import java.net.MalformedURLException; +import java.util.Date; +import java.util.Properties; +import java.util.logging.Level; +import java.util.logging.Logger; + +import net.pterodactylus.sone.main.SonePlugin; +import net.pterodactylus.util.collection.Pair; +import net.pterodactylus.util.io.Closer; +import net.pterodactylus.util.logging.Logging; +import net.pterodactylus.util.version.Version; +import freenet.client.FetchResult; +import freenet.keys.FreenetURI; +import freenet.support.api.Bucket; + +/** + * Watches the official Sone homepage for new releases. + * + * @author David ‘Bombe’ Roden + */ +public class UpdateChecker { + + /** The logger. */ + private static final Logger logger = Logging.getLogger(UpdateChecker.class); + + /** The key of the Sone homepage. */ + private static final String SONE_HOMEPAGE = "USK@nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI,DuQSUZiI~agF8c-6tjsFFGuZ8eICrzWCILB60nT8KKo,AQACAAE/sone/"; + + /** The current latest known edition. */ + private static final int LATEST_EDITION = 23; + + /** The Freenet interface. */ + private final FreenetInterface freenetInterface; + + /** The update listener manager. */ + private final UpdateListenerManager updateListenerManager = new UpdateListenerManager(); + + /** The current URI of the homepage. */ + private FreenetURI currentUri; + + /** The current latest known version. */ + private Version currentLatestVersion = SonePlugin.VERSION; + + /** The release date of the latest version. */ + private long latestVersionDate; + + /** + * Creates a new update checker. + * + * @param freenetInterface + * The freenet interface to use + */ + public UpdateChecker(FreenetInterface freenetInterface) { + this.freenetInterface = freenetInterface; + } + + // + // EVENT LISTENER MANAGEMENT + // + + /** + * Adds the given listener to the list of registered listeners. + * + * @param updateListener + * The listener to add + */ + public void addUpdateListener(UpdateListener updateListener) { + updateListenerManager.addListener(updateListener); + } + + /** + * Removes the given listener from the list of registered listeners. + * + * @param updateListener + * The listener to remove + */ + public void removeUpdateListener(UpdateListener updateListener) { + updateListenerManager.removeListener(updateListener); + } + + // + // ACCESSORS + // + + /** + * Returns whether a version that is later than the currently running + * version has been found. + * + * @return {@code true} if a new version was found + */ + public boolean hasLatestVersion() { + return currentLatestVersion.compareTo(SonePlugin.VERSION) > 0; + } + + /** + * Returns the latest version. If no new latest version has been found, the + * current version is returned. + * + * @return The latest known version + */ + public Version getLatestVersion() { + return currentLatestVersion; + } + + /** + * Returns the release time of the latest version. If no new latest version + * has been found, the returned value is undefined. + * + * @return The release time of the latest version, if a new version was + * found + */ + public long getLatestVersionDate() { + return latestVersionDate; + } + + // + // ACTIONS + // + + /** + * Starts the update checker. + */ + public void start() { + try { + currentUri = new FreenetURI(SONE_HOMEPAGE + LATEST_EDITION); + } catch (MalformedURLException mue1) { + /* this can not really happen unless I screw up. */ + logger.log(Level.SEVERE, "Sone Homepage URI invalid!", mue1); + } + freenetInterface.registerUsk(currentUri, new FreenetInterface.Callback() { + + @Override + @SuppressWarnings("synthetic-access") + public void editionFound(FreenetURI uri, long edition, boolean newKnownGood, boolean newSlot) { + logger.log(Level.FINEST, "Found update for %s: %d, %s, %s", new Object[] { uri, edition, newKnownGood, newSlot }); + if (newKnownGood || newSlot) { + Pair uriResult = freenetInterface.fetchUri(uri.setMetaString(new String[] { "sone.properties" })); + if (uriResult == null) { + logger.log(Level.WARNING, "Could not fetch properties of latest homepage: %s", uri); + return; + } + Bucket resultBucket = uriResult.getRight().asBucket(); + try { + parseProperties(resultBucket.getInputStream()); + } catch (IOException ioe1) { + logger.log(Level.WARNING, "Could not parse sone.properties of " + uri, ioe1); + } finally { + resultBucket.free(); + } + } + } + }); + } + + /** + * Stops the update checker. + */ + public void stop() { + freenetInterface.unregisterUsk(currentUri); + } + + // + // PRIVATE ACTIONS + // + + /** + * Parses the properties of the latest version and fires events, if + * necessary. + * + * @see UpdateListener#updateFound(Version, long) + * @see UpdateListenerManager#fireUpdateFound(Version, long) + * @param propertiesInputStream + * The input stream to parse + * @throws IOException + * if an I/O error occured + */ + private void parseProperties(InputStream propertiesInputStream) throws IOException { + Properties properties = new Properties(); + InputStreamReader inputStreamReader = null; + try { + inputStreamReader = new InputStreamReader(propertiesInputStream, "UTF-8"); + properties.load(inputStreamReader); + } finally { + Closer.close(inputStreamReader); + } + String versionString = properties.getProperty("CurrentVersion/Version"); + String releaseTimeString = properties.getProperty("CurrentVersion/ReleaseTime"); + if ((versionString == null) || (releaseTimeString == null)) { + logger.log(Level.INFO, "Invalid data parsed from properties."); + return; + } + Version version = Version.parse(versionString); + long releaseTime = 0; + try { + releaseTime = Long.parseLong(releaseTimeString); + } catch (NumberFormatException nfe1) { + /* ignore. */ + } + if ((version == null) || (releaseTime == 0)) { + logger.log(Level.INFO, "Could not parse data from properties."); + return; + } + if (version.compareTo(currentLatestVersion) > 0) { + currentLatestVersion = version; + latestVersionDate = releaseTime; + logger.log(Level.INFO, "Found new version: %s (%tc)", new Object[] { version, new Date(releaseTime) }); + updateListenerManager.fireUpdateFound(version, releaseTime); + } + } + +} diff --git a/src/main/java/net/pterodactylus/sone/core/UpdateListener.java b/src/main/java/net/pterodactylus/sone/core/UpdateListener.java new file mode 100644 index 0000000..1469afa --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/core/UpdateListener.java @@ -0,0 +1,42 @@ +/* + * Sone - UpdateListener.java - Copyright © 2011 David Roden + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.sone.core; + +import java.util.EventListener; + +import net.pterodactylus.util.version.Version; + +/** + * Listener interface for {@link UpdateChecker} events. + * + * @author David ‘Bombe’ Roden + */ +public interface UpdateListener extends EventListener { + + /** + * Notifies a listener that a newer version than the current version was + * found. + * + * @param version + * The version that was found + * @param releaseTime + * The release time of the version + */ + public void updateFound(Version version, long releaseTime); + +} diff --git a/src/main/java/net/pterodactylus/sone/core/UpdateListenerManager.java b/src/main/java/net/pterodactylus/sone/core/UpdateListenerManager.java new file mode 100644 index 0000000..3f3b21f --- /dev/null +++ b/src/main/java/net/pterodactylus/sone/core/UpdateListenerManager.java @@ -0,0 +1,55 @@ +/* + * Sone - UpdateListenerManager.java - Copyright © 2011 David Roden + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +package net.pterodactylus.sone.core; + +import net.pterodactylus.util.event.AbstractListenerManager; +import net.pterodactylus.util.version.Version; + +/** + * Listener manager for {@link UpdateListener} events. + * + * @author David ‘Bombe’ Roden + */ +public class UpdateListenerManager extends AbstractListenerManager { + + /** + * Creates a new update listener manager. + */ + public UpdateListenerManager() { + super(null); + } + + // + // ACTIONS + // + + /** + * Notifies all listeners that a new version has been found. + * + * @param version + * The new version + * @param releaseTime + * The release time of the new version + */ + void fireUpdateFound(Version version, long releaseTime) { + for (UpdateListener updateListener : getListeners()) { + updateListener.updateFound(version, releaseTime); + } + } + +} -- 2.7.4