src/de/todesbaum/jsite/application/UpdateChecker.java

   1 /*
   2  * jSite - UpdateChecker.java - Copyright © 2008–2011 David Roden
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18
  19 package de.todesbaum.jsite.application;
  20
  21 import java.io.IOException;
  22 import java.io.InputStream;
  23 import java.util.ArrayList;
  24 import java.util.List;
  25 import java.util.Properties;
  26 import java.util.logging.Level;
  27 import java.util.logging.Logger;
  28
  29 import de.todesbaum.jsite.main.Main;
  30 import de.todesbaum.jsite.main.Version;
  31 import de.todesbaum.util.freenet.fcp2.Client;
  32 import de.todesbaum.util.freenet.fcp2.ClientGet;
  33 import de.todesbaum.util.freenet.fcp2.Connection;
  34 import de.todesbaum.util.freenet.fcp2.Message;
  35 import de.todesbaum.util.freenet.fcp2.Persistence;
  36 import de.todesbaum.util.freenet.fcp2.ReturnType;
  37 import de.todesbaum.util.freenet.fcp2.Verbosity;
  38 import de.todesbaum.util.io.Closer;
  39
  40 /**
  41  * Checks for newer versions of jSite.
  42  *
  43  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  44  */
  45 public class UpdateChecker implements Runnable {
  46
  47         /** The logger. */
  48         private static final Logger logger = Logger.getLogger(UpdateChecker.class.getName());
  49
  50         /** Counter for connection names. */
  51         private static int counter = 0;
  52
  53         /** The edition for the update check URL. */
  54         private static final int UPDATE_EDITION = 11;
  55
  56         /** The URL for update checks. */
  57         private static final String UPDATE_KEY = "USK@e3myoFyp5avg6WYN16ImHri6J7Nj8980Fm~aQe4EX1U,QvbWT0ImE0TwLODTl7EoJx2NBnwDxTbLTE6zkB-eGPs,AQACAAE";
  58
  59         /** Object used for synchronization. */
  60         private final Object syncObject = new Object();
  61
  62         /** Update listeners. */
  63         private final List<UpdateListener> updateListeners = new ArrayList<UpdateListener>();
  64
  65         /** Whether the main thread should stop. */
  66         private boolean shouldStop = false;
  67
  68         /** Current last found edition of update key. */
  69         private int lastUpdateEdition = UPDATE_EDITION;
  70
  71         /** Last found version. */
  72         private Version lastVersion = Main.getVersion();
  73
  74         /** The freenet interface. */
  75         private final Freenet7Interface freenetInterface;
  76
  77         /**
  78          * Creates a new update checker that uses the given frame as its parent and
  79          * communications via the given freenet interface.
  80          *
  81          * @param freenetInterface
  82          *            The freenet interface
  83          */
  84         public UpdateChecker(Freenet7Interface freenetInterface) {
  85                 this.freenetInterface = freenetInterface;
  86         }
  87
  88         //
  89         // EVENT LISTENER MANAGEMENT
  90         //
  91
  92         /**
  93          * Adds an update listener to the list of registered listeners.
  94          *
  95          * @param updateListener
  96          *            The update listener to add
  97          */
  98         public void addUpdateListener(UpdateListener updateListener) {
  99                 updateListeners.add(updateListener);
 100         }
 101
 102         /**
 103          * Removes the given listener from the list of registered listeners.
 104          *
 105          * @param updateListener
 106          *            The update listener to remove
 107          */
 108         public void removeUpdateListener(UpdateListener updateListener) {
 109                 updateListeners.remove(updateListener);
 110         }
 111
 112         /**
 113          * Notifies all listeners that a version was found.
 114          *
 115          * @param foundVersion
 116          *            The version that was found
 117          * @param versionTimestamp
 118          *            The timestamp of the version
 119          */
 120         protected void fireUpdateFound(Version foundVersion, long versionTimestamp) {
 121                 for (UpdateListener updateListener : updateListeners) {
 122                         updateListener.foundUpdateData(foundVersion, versionTimestamp);
 123                 }
 124         }
 125
 126         //
 127         // ACCESSORS
 128         //
 129
 130         /**
 131          * Returns the latest version that was found.
 132          *
 133          * @return The latest found version
 134          */
 135         public Version getLatestVersion() {
 136                 return lastVersion;
 137         }
 138
 139         //
 140         // ACTIONS
 141         //
 142
 143         /**
 144          * Starts the update checker.
 145          */
 146         public void start() {
 147                 new Thread(this).start();
 148         }
 149
 150         /**
 151          * Stops the update checker.
 152          */
 153         public void stop() {
 154                 synchronized (syncObject) {
 155                         shouldStop = true;
 156                         syncObject.notifyAll();
 157                 }
 158         }
 159
 160         //
 161         // PRIVATE METHODS
 162         //
 163
 164         /**
 165          * Returns whether the update checker should stop.
 166          *
 167          * @return <code>true</code> if the update checker should stop,
 168          *         <code>false</code> otherwise
 169          */
 170         private boolean shouldStop() {
 171                 synchronized (syncObject) {
 172                         return shouldStop;
 173                 }
 174         }
 175
 176         /**
 177          * Creates the URI of the update file for the given edition.
 178          *
 179          * @param edition
 180          *            The edition number
 181          * @return The URI for the update file for the given edition
 182          */
 183         private String constructUpdateKey(int edition) {
 184                 return UPDATE_KEY + "/jSite/" + edition + "/jSite.properties";
 185         }
 186
 187         //
 188         // INTERFACE Runnable
 189         //
 190
 191         /**
 192          * {@inheritDoc}
 193          */
 194         public void run() {
 195                 Connection connection = freenetInterface.getConnection("jSite-" + ++counter + "-UpdateChecker");
 196                 try {
 197                         connection.connect();
 198                 } catch (IOException e1) {
 199                         e1.printStackTrace();
 200                 }
 201                 Client client = new Client(connection);
 202                 boolean checkNow = false;
 203                 int currentEdition = lastUpdateEdition;
 204                 while (!shouldStop()) {
 205                         checkNow = false;
 206                         logger.log(Level.FINE, "Trying " + constructUpdateKey(currentEdition));
 207                         ClientGet clientGet = new ClientGet("get-update-key");
 208                         clientGet.setUri(constructUpdateKey(currentEdition));
 209                         clientGet.setPersistence(Persistence.CONNECTION);
 210                         clientGet.setReturnType(ReturnType.direct);
 211                         clientGet.setVerbosity(Verbosity.ALL);
 212                         try {
 213                                 client.execute(clientGet);
 214                                 boolean stop = false;
 215                                 while (!stop) {
 216                                         Message message = client.readMessage();
 217                                         logger.log(Level.FINEST, "Received message: " + message);
 218                                         if (message == null) {
 219                                                 break;
 220                                         }
 221                                         if ("GetFailed".equals(message.getName())) {
 222                                                 if ("27".equals(message.get("code"))) {
 223                                                         String editionString = message.get("redirecturi").split("/")[2];
 224                                                         int editionNumber = -1;
 225                                                         try {
 226                                                                 editionNumber = Integer.parseInt(editionString);
 227                                                         } catch (NumberFormatException nfe1) {
 228                                                                 /* ignore. */
 229                                                         }
 230                                                         if (editionNumber != -1) {
 231                                                                 logger.log(Level.INFO, "Found new edition " + editionNumber);
 232                                                                 currentEdition = editionNumber;
 233                                                                 lastUpdateEdition = editionNumber;
 234                                                                 checkNow = true;
 235                                                                 break;
 236                                                         }
 237                                                 }
 238                                         }
 239                                         if ("AllData".equals(message.getName())) {
 240                                                 logger.log(Level.FINE, "Update data found.");
 241                                                 InputStream dataInputStream = null;
 242                                                 Properties properties = new Properties();
 243                                                 try {
 244                                                         dataInputStream = message.getPayloadInputStream();
 245                                                         properties.load(dataInputStream);
 246                                                 } finally {
 247                                                         Closer.close(dataInputStream);
 248                                                 }
 249
 250                                                 String foundVersionString = properties.getProperty("jSite.Version");
 251                                                 if (foundVersionString != null) {
 252                                                         Version foundVersion = Version.parse(foundVersionString);
 253                                                         if (foundVersion != null) {
 254                                                                 lastVersion = foundVersion;
 255                                                                 String versionTimestampString = properties.getProperty("jSite.Date");
 256                                                                 logger.log(Level.FINEST, "Version timestamp: " + versionTimestampString);
 257                                                                 long versionTimestamp = -1;
 258                                                                 try {
 259                                                                         versionTimestamp = Long.parseLong(versionTimestampString);
 260                                                                 } catch (NumberFormatException nfe1) {
 261                                                                         /* ignore. */
 262                                                                 }
 263                                                                 fireUpdateFound(foundVersion, versionTimestamp);
 264                                                                 stop = true;
 265                                                                 checkNow = true;
 266                                                                 ++currentEdition;
 267                                                         }
 268                                                 }
 269                                         }
 270                                 }
 271                         } catch (IOException e) {
 272                                 logger.log(Level.INFO, "Got IOException: " + e.getMessage());
 273                                 e.printStackTrace();
 274                         }
 275                         if (!checkNow && !shouldStop()) {
 276                                 synchronized (syncObject) {
 277                                         try {
 278                                                 syncObject.wait(15 * 60 * 1000);
 279                                         } catch (InterruptedException ie1) {
 280                                                 /* ignore. */
 281                                         }
 282                                 }
 283                         }
 284                 }
 285         }
 286
 287 }