src/net/pterodactylus/jsite/core/NodeManager.java

   1 /*
   2  * jSite2 - FcpCollector.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.jsite.core;
  21
  22 import java.beans.PropertyChangeEvent;
  23 import java.beans.PropertyChangeListener;
  24 import java.io.File;
  25 import java.io.FileInputStream;
  26 import java.io.FileOutputStream;
  27 import java.io.IOException;
  28 import java.io.InputStream;
  29 import java.io.OutputStream;
  30 import java.net.UnknownHostException;
  31 import java.util.ArrayList;
  32 import java.util.Collections;
  33 import java.util.HashMap;
  34 import java.util.Iterator;
  35 import java.util.List;
  36 import java.util.Map;
  37 import java.util.Properties;
  38 import java.util.logging.Level;
  39 import java.util.logging.Logger;
  40
  41 import net.pterodactylus.fcp.highlevel.HighLevelClient;
  42 import net.pterodactylus.fcp.highlevel.HighLevelClientListener;
  43 import net.pterodactylus.fcp.highlevel.HighLevelException;
  44 import net.pterodactylus.fcp.highlevel.KeyGenerationResult;
  45 import net.pterodactylus.jsite.util.IdGenerator;
  46 import net.pterodactylus.util.io.Closer;
  47 import net.pterodactylus.util.logging.Logging;
  48 import net.pterodactylus.util.number.Hex;
  49
  50 /**
  51  * TODO
  52  *
  53  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  54  */
  55 public class NodeManager implements Iterable<Node>, PropertyChangeListener, HighLevelClientListener {
  56
  57         /** Logger. */
  58         private static final Logger logger = Logging.getLogger(NodeManager.class.getName());
  59
  60         /** The FCP client name. */
  61         private final String clientName;
  62
  63         /** The directory for the configuration. */
  64         private final String directory;
  65
  66         /** Object used for synchronization. */
  67         private final Object syncObject = new Object();
  68
  69         /** Node listener support. */
  70         private final NodeListenerSupport nodeListenerSupport = new NodeListenerSupport();
  71
  72         /** All nodes. */
  73         private final List<Node> nodes = Collections.synchronizedList(new ArrayList<Node>());
  74
  75         /** Map from node ID to node. */
  76         private final Map<String, Node> idNodes = Collections.synchronizedMap(new HashMap<String, Node>());
  77
  78         /** All FCP connections. */
  79         private final Map<Node, HighLevelClient> nodeClients = Collections.synchronizedMap(new HashMap<Node, HighLevelClient>());
  80
  81         /** Maps nodes to high-level clients. */
  82         private final Map<HighLevelClient, Node> clientNodes = Collections.synchronizedMap(new HashMap<HighLevelClient, Node>());
  83
  84         /** Collection of currently connected nodes. */
  85         private final Set<Node> connectedNodes = Collections.synchronizedSet(new HashSet<Node>());
  86
  87         /**
  88          * Creates a new FCP collector.
  89          *
  90          * @param clientName
  91          *            The name of the FCP client
  92          * @param directory
  93          *            The directory in which to store the nodes
  94          */
  95         public NodeManager(String clientName, String directory) {
  96                 this.clientName = clientName;
  97                 this.directory = directory;
  98         }
  99
 100         //
 101         // EVENT MANAGEMENT
 102         //
 103
 104         /**
 105          * Adds the given listener to the list of listeners.
 106          *
 107          * @param nodeListener
 108          *            The listener to add
 109          */
 110         public void addNodeListener(NodeListener nodeListener) {
 111                 nodeListenerSupport.addListener(nodeListener);
 112         }
 113
 114         /**
 115          * Removes the given listener from the list of listeners.
 116          *
 117          * @param nodeListener
 118          *            The listener to remove
 119          */
 120         public void removeNodeListener(NodeListener nodeListener) {
 121                 nodeListenerSupport.removeListener(nodeListener);
 122         }
 123
 124         //
 125         // ACCESSORS
 126         //
 127
 128         /**
 129          * Returns the directory in which the nodes are stored.
 130          *
 131          * @return The directory the nodes are stored in
 132          */
 133         public String getDirectory() {
 134                 return directory;
 135         }
 136
 137         /**
 138          * Checks whether the given node is already connected.
 139          *
 140          * @param node
 141          *            The node to check
 142          * @return <code>true</code> if the node is already connected,
 143          *         <code>false</code> otherwise
 144          */
 145         public boolean hasNode(Node node) {
 146                 return nodes.contains(node);
 147         }
 148
 149         /**
 150          * {@inheritDoc}
 151          */
 152         public Iterator<Node> iterator() {
 153                 return nodes.iterator();
 154         }
 155
 156         //
 157         // ACTIONS
 158         //
 159
 160         /**
 161          * Loads nodes.
 162          *
 163          * @throws IOException
 164          *             if an I/O error occurs loading the nodes
 165          */
 166         public void load() throws IOException {
 167                 logger.log(Level.FINEST, "load()");
 168                 File directoryFile = new File(directory);
 169                 File nodeFile = new File(directoryFile, "nodes.properties");
 170                 if (!nodeFile.exists() || !nodeFile.isFile() || !nodeFile.canRead()) {
 171                         return;
 172                 }
 173                 Properties nodeProperties = new Properties();
 174                 InputStream nodeInputStream = null;
 175                 try {
 176                         nodeInputStream = new FileInputStream(nodeFile);
 177                         nodeProperties.load(nodeInputStream);
 178                 } finally {
 179                         Closer.close(nodeInputStream);
 180                 }
 181                 int nodeIndex = -1;
 182                 List<Node> loadedNodes = new ArrayList<Node>();
 183                 while (nodeProperties.containsKey("nodes." + ++nodeIndex + ".name")) {
 184                         String nodePrefix = "nodes." + nodeIndex;
 185                         String nodeId = nodeProperties.getProperty(nodePrefix + ".id");
 186                         if (nodeId == null) {
 187                                 nodeId = Hex.toHex(IdGenerator.generateId());
 188                         }
 189                         String nodeName = nodeProperties.getProperty(nodePrefix + ".name");
 190                         if (!Verifier.verifyNodeName(nodeName)) {
 191                                 logger.log(Level.WARNING, "invalid node name “" + nodeName + "”, skipping…");
 192                                 continue;
 193                         }
 194                         String nodeHostname = nodeProperties.getProperty(nodePrefix + ".hostname");
 195                         if (!Verifier.verifyHostname(nodeHostname)) {
 196                                 logger.log(Level.WARNING, "invalid host name “" + nodeHostname + "”");
 197                                 /* not fatal, might be valid later on. */
 198                         }
 199                         String nodePortString = nodeProperties.getProperty(nodePrefix + ".port");
 200                         if (!Verifier.verifyPort(nodePortString)) {
 201                                 logger.log(Level.WARNING, "invalid port number “" + nodePortString + "”, skipping…");
 202                                 continue;
 203                         }
 204                         int nodePort = -1;
 205                         try {
 206                                 nodePort = Integer.valueOf(nodePortString);
 207                         } catch (NumberFormatException nfe1) {
 208                                 /* shouldn't happen, port number was checked before. */
 209                                 logger.log(Level.SEVERE, "invalid port number “" + nodePortString + "”, check failed! skipping…");
 210                                 continue;
 211                         }
 212                         Node newNode = new Node();
 213                         newNode.setId(nodeId);
 214                         newNode.setName(nodeName);
 215                         newNode.setHostname(nodeHostname);
 216                         newNode.setPort(nodePort);
 217                         loadedNodes.add(newNode);
 218                 }
 219                 logger.log(Level.FINE, "loaded " + loadedNodes.size() + " nodes from config");
 220                 synchronized (syncObject) {
 221                         nodes.clear();
 222                         for (Node node : loadedNodes) {
 223                                 addNode(node);
 224                         }
 225                 }
 226         }
 227
 228         /**
 229          * Saves all configured nodes.
 230          *
 231          * @throws IOException
 232          *             if an I/O error occurs saving the nodes
 233          */
 234         public void save() throws IOException {
 235                 logger.log(Level.FINEST, "save()");
 236                 File directoryFile = new File(directory);
 237                 if (!directoryFile.exists()) {
 238                         if (!directoryFile.mkdirs()) {
 239                                 throw new IOException("could not create directory: " + directory);
 240                         }
 241                 }
 242                 Properties nodeProperties = new Properties();
 243                 int nodeIndex = -1;
 244                 for (Node node : nodes) {
 245                         String nodePrefix = "nodes." + ++nodeIndex;
 246                         nodeProperties.setProperty(nodePrefix + ".id", node.getId());
 247                         nodeProperties.setProperty(nodePrefix + ".name", node.getName());
 248                         nodeProperties.setProperty(nodePrefix + ".hostname", node.getHostname());
 249                         nodeProperties.setProperty(nodePrefix + ".port", String.valueOf(node.getPort()));
 250                 }
 251                 File projectFile = new File(directoryFile, "nodes.properties");
 252                 OutputStream nodeOutputStream = null;
 253                 try {
 254                         nodeOutputStream = new FileOutputStream(projectFile);
 255                         nodeProperties.store(nodeOutputStream, "jSite nodes");
 256                 } finally {
 257                         Closer.close(nodeOutputStream);
 258                 }
 259         }
 260
 261         /**
 262          * Adds the given node to this manager.
 263          *
 264          * @see #connect(Node)
 265          * @param node
 266          *            The node to connect to
 267          * @return <code>true</code> if the node was added, <code>false</code> if
 268          *         the node was not added because it was already known
 269          */
 270         public boolean addNode(Node node) {
 271                 logger.log(Level.FINEST, "addNode(node=" + node + ")");
 272                 if (nodes.contains(node)) {
 273                         logger.log(Level.WARNING, "was told to add already known node: " + node);
 274                         return false;
 275                 }
 276                 node.addPropertyChangeListener(this);
 277                 HighLevelClient highLevelClient = new HighLevelClient(clientName);
 278                 nodes.add(node);
 279                 idNodes.put(node.getId(), node);
 280                 clientNodes.put(highLevelClient, node);
 281                 nodeClients.put(node, highLevelClient);
 282                 highLevelClient.addHighLevelClientListener(this);
 283                 nodeListenerSupport.fireNodeAdded(node);
 284                 return true;
 285         }
 286
 287         /**
 288          * Removes the given node from the node manager, disconnecting it if it is
 289          * currently connected.
 290          *
 291          * @param node
 292          *            The node to remove
 293          */
 294         public void removeNode(Node node) {
 295                 logger.log(Level.FINEST, "removeNode(node=" + node + ")");
 296                 synchronized (syncObject) {
 297                         if (!nodes.contains(node)) {
 298                                 return;
 299                         }
 300                         if (nodeClients.containsKey(node)) {
 301                                 disconnect(node);
 302                         }
 303                         nodes.remove(node);
 304                         idNodes.remove(node.getId());
 305                         node.removePropertyChangeListener(this);
 306                         nodeListenerSupport.fireNodeRemoved(node);
 307                 }
 308         }
 309
 310         /**
 311          * Tries to establish a connection with the given node.
 312          *
 313          * @param node
 314          *            The node to connect to
 315          */
 316         public void connect(Node node) {
 317                 logger.log(Level.FINEST, "connect(node=" + node + ")");
 318                 HighLevelClient highLevelClient;
 319                 highLevelClient = nodeClients.get(node);
 320                 if (highLevelClient == null) {
 321                         logger.log(Level.WARNING, "was told to connect to unknown node: " + node);
 322                         return;
 323                 }
 324                 try {
 325                         highLevelClient.connect(node.getHostname(), node.getPort());
 326                 } catch (UnknownHostException uhe1) {
 327                         nodeListenerSupport.fireNodeConnectionFailed(node, uhe1);
 328                 } catch (IOException ioe1) {
 329                         nodeListenerSupport.fireNodeConnectionFailed(node, ioe1);
 330                 }
 331         }
 332
 333         /**
 334          * Disconnects the given node without removing it.
 335          *
 336          * @param node
 337          *            The node to disconnect
 338          */
 339         public void disconnect(Node node) {
 340                 logger.log(Level.FINEST, "disconnect(node=" + node + ")");
 341                 synchronized (syncObject) {
 342                         if (!nodes.contains(node)) {
 343                                 return;
 344                         }
 345                         HighLevelClient highLevelClient = nodeClients.get(node);
 346                         highLevelClient.disconnect();
 347                 }
 348         }
 349
 350         /**
 351          * Returns a list of all nodes.
 352          *
 353          * @return A list of all nodes
 354          */
 355         public List<Node> getNodes() {
 356                 return Collections.unmodifiableList(nodes);
 357         }
 358
 359         /**
 360          * Returns the high-level client for a given node.
 361          *
 362          * @param node
 363          *            The node to get a high-level client for
 364          * @return The high-level client for a node, or <code>null</code> if the
 365          *         node was disconnected or removed
 366          */
 367         public HighLevelClient getHighLevelClient(Node node) {
 368                 return nodeClients.get(node);
 369         }
 370
 371         /**
 372          * Returns the node for a high-level client.
 373          *
 374          * @param highLevelClient
 375          *            The high-level client to get the node for
 376          * @return The node for the high-level client, or <code>null</code> if the
 377          *         high-level client is not known
 378          */
 379         public Node getNode(HighLevelClient highLevelClient) {
 380                 return clientNodes.get(highLevelClient);
 381         }
 382
 383         /**
 384          * Returns the node identified by the given ID.
 385          *
 386          * @param id
 387          *            The ID of the node
 388          * @return The node with the given ID, or <code>null</code> if no such node
 389          *         was found
 390          */
 391         Node getNode(String id) {
 392                 return idNodes.get(id);
 393         }
 394
 395         /**
 396          * Generates a new SSK key pair.
 397          *
 398          * @return An array with the private key at index <code>0</code> and the
 399          *         public key at index <code>1</code>
 400          * @throws IOException
 401          *             if an I/O error occurs communicating with the node
 402          * @throws JSiteException
 403          *             if there is a problem with the node
 404          */
 405         public String[] generateKeyPair() throws IOException, JSiteException {
 406                 logger.log(Level.FINEST, "generateKeyPair()");
 407                 if (nodes.isEmpty()) {
 408                         throw new NoNodeException("no node configured");
 409                 }
 410                 Node node = nodes.get(0);
 411                 HighLevelClient highLevelClient = nodeClients.get(node);
 412                 try {
 413                         KeyGenerationResult keyGenerationResult = highLevelClient.generateKey().getResult();
 414                         return new String[] { keyGenerationResult.getInsertURI(), keyGenerationResult.getRequestURI() };
 415                 } catch (HighLevelException hle1) {
 416                         throw new BackendException(hle1);
 417                 } catch (InterruptedException e) {
 418                         /* ignore. */
 419                 }
 420                 return null;
 421         }
 422
 423         //
 424         // PRIVATE METHODS
 425         //
 426
 427         //
 428         // INTERFACE HighLevelClientListener
 429         //
 430
 431         /**
 432          * {@inheritDoc}
 433          */
 434         public void clientConnected(HighLevelClient highLevelClient) {
 435                 logger.log(Level.FINEST, "clientConnected(highLevelClient=" + highLevelClient + ")");
 436                 Node node = clientNodes.get(highLevelClient);
 437                 if (node == null) {
 438                         logger.log(Level.WARNING, "got event for unknown client");
 439                         return;
 440                 }
 441                 nodeListenerSupport.fireNodeConnected(node);
 442         }
 443
 444         /**
 445          * {@inheritDoc}
 446          */
 447         public void clientDisconnected(HighLevelClient highLevelClient, Throwable throwable) {
 448                 logger.log(Level.FINEST, "clientDisconnected(highLevelClient=" + highLevelClient + ",throwable=" + throwable + ")");
 449                 synchronized (syncObject) {
 450                         Node node = clientNodes.get(highLevelClient);
 451                         if (node == null) {
 452                                 logger.log(Level.WARNING, "got event for unknown client");
 453                                 return;
 454                         }
 455                         nodeListenerSupport.fireNodeDisconnected(node, throwable);
 456                 }
 457         }
 458
 459         //
 460         // INTERFACE PropertyChangeListener
 461         //
 462
 463         /**
 464          * {@inheritDoc}
 465          */
 466         public void propertyChange(PropertyChangeEvent propertyChangeEvent) {
 467                 Object eventSource = propertyChangeEvent.getSource();
 468                 if (eventSource instanceof Node) {
 469                         String propertyName = propertyChangeEvent.getPropertyName();
 470                         if ("hostname".equals(propertyName) || "port".equals(propertyName)) {
 471                                 Node node = (Node) eventSource;
 472                                 HighLevelClient highLevelClient = nodeClients.get(node);
 473                                 if (highLevelClient == null) {
 474                                         logger.log(Level.WARNING, "got property change event for unknown node: " + node);
 475                                         return;
 476                                 }
 477                                 if (highLevelClient.isConnected()) {
 478                                         highLevelClient.disconnect();
 479                                         try {
 480                                                 highLevelClient.connect(node.getHostname(), node.getPort());
 481                                         } catch (UnknownHostException uhe1) {
 482                                                 nodeListenerSupport.fireNodeConnectionFailed(node, uhe1);
 483                                         } catch (IOException ioe1) {
 484                                                 nodeListenerSupport.fireNodeConnectionFailed(node, ioe1);
 485                                         }
 486                                 }
 487                         }
 488                 }
 489         }
 490
 491 }