src/main/java/net/pterodactylus/sone/core/FreenetInterface.java

   1 /*
   2  * FreenetSone - FreenetInterface.java - Copyright © 2010 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 3 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, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sone.core;
  19
  20 import java.util.HashMap;
  21 import java.util.logging.Level;
  22 import java.util.logging.Logger;
  23
  24 import net.pterodactylus.util.logging.Logging;
  25 import net.pterodactylus.util.service.AbstractService;
  26 import freenet.client.FetchException;
  27 import freenet.client.FetchResult;
  28 import freenet.client.HighLevelSimpleClient;
  29 import freenet.client.InsertException;
  30 import freenet.keys.FreenetURI;
  31 import freenet.node.Node;
  32
  33 /**
  34  * Contains all necessary functionality for interacting with the Freenet node.
  35  *
  36  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  37  */
  38 public class FreenetInterface extends AbstractService {
  39
  40         /** The logger. */
  41         private static final Logger logger = Logging.getLogger(FreenetInterface.class);
  42
  43         /** The node to interact with. */
  44         @SuppressWarnings("unused")
  45         private final Node node;
  46
  47         /** The high-level client to use for requests. */
  48         private final HighLevelSimpleClient client;
  49
  50         /**
  51          * Creates a new Freenet interface.
  52          *
  53          * @param node
  54          *            The node to interact with
  55          * @param client
  56          *            The high-level client
  57          */
  58         public FreenetInterface(Node node, HighLevelSimpleClient client) {
  59                 this.node = node;
  60                 this.client = client;
  61         }
  62
  63         //
  64         // ACTIONS
  65         //
  66
  67         /**
  68          * Fetches the given URI.
  69          *
  70          * @param uri
  71          *            The URI to fetch
  72          * @return The result of the fetch, or {@code null} if an error occured
  73          */
  74         public FetchResult fetchUri(FreenetURI uri) {
  75                 logger.entering(FreenetInterface.class.getName(), "fetchUri(FreenetURI)", uri);
  76                 FetchResult fetchResult = null;
  77                 try {
  78                         fetchResult = client.fetch(uri);
  79                 } catch (FetchException fe1) {
  80                         logger.log(Level.WARNING, "Could not fetch “" + uri + "”!", fe1);
  81                 } finally {
  82                         logger.exiting(FreenetInterface.class.getName(), "fetchUri(FreenetURI)", fetchResult);
  83                 }
  84                 return fetchResult;
  85         }
  86
  87         /**
  88          * Creates a key pair.
  89          *
  90          * @return The request key at index 0, the insert key at index 1
  91          */
  92         public String[] generateKeyPair() {
  93                 FreenetURI[] keyPair = client.generateKeyPair("");
  94                 return new String[] { keyPair[1].toString(), keyPair[0].toString() };
  95         }
  96
  97         /**
  98          * Inserts a directory into Freenet.
  99          *
 100          * @param insertUri
 101          *            The insert URI
 102          * @param manifestEntries
 103          *            The directory entries
 104          * @param defaultFile
 105          *            The name of the default file
 106          * @return The generated URI
 107          * @throws SoneException
 108          *             if an insert error occurs
 109          */
 110         public FreenetURI insertDirectory(FreenetURI insertUri, HashMap<String, Object> manifestEntries, String defaultFile) throws SoneException {
 111                 try {
 112                         return client.insertManifest(insertUri, manifestEntries, defaultFile);
 113                 } catch (InsertException ie1) {
 114                         throw new SoneException(null, ie1);
 115                 }
 116         }
 117
 118 }