src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java

   1 /*
   2  * Sone - FcpInterface.java - Copyright © 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 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.fcp;
  19
  20 import java.util.Collections;
  21 import java.util.HashMap;
  22 import java.util.Map;
  23 import java.util.logging.Level;
  24 import java.util.logging.Logger;
  25
  26 import net.pterodactylus.sone.core.Core;
  27 import net.pterodactylus.sone.freenet.fcp.Command;
  28 import net.pterodactylus.sone.freenet.fcp.Command.AccessType;
  29 import net.pterodactylus.sone.freenet.fcp.Command.ErrorResponse;
  30 import net.pterodactylus.sone.freenet.fcp.Command.Response;
  31 import net.pterodactylus.sone.freenet.fcp.FcpException;
  32 import net.pterodactylus.util.logging.Logging;
  33 import freenet.pluginmanager.FredPluginFCP;
  34 import freenet.pluginmanager.PluginNotFoundException;
  35 import freenet.pluginmanager.PluginReplySender;
  36 import freenet.support.SimpleFieldSet;
  37 import freenet.support.api.Bucket;
  38
  39 /**
  40  * Implementation of an FCP interface for other clients or plugins to
  41  * communicate with Sone.
  42  *
  43  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  44  */
  45 public class FcpInterface {
  46
  47         /** The logger. */
  48         private static final Logger logger = Logging.getLogger(FcpInterface.class);
  49
  50         /** Whether the FCP interface is currently active. */
  51         private volatile boolean active;
  52
  53         /** All available FCP commands. */
  54         private final Map<String, Command> commands = Collections.synchronizedMap(new HashMap<String, Command>());
  55
  56         /**
  57          * Creates a new FCP interface.
  58          *
  59          * @param core
  60          *            The core
  61          */
  62         public FcpInterface(Core core) {
  63                 commands.put("Version", new VersionCommand());
  64                 commands.put("GetLocalSones", new GetLocalSonesCommand(core));
  65                 commands.put("GetPosts", new GetPostsCommand(core));
  66                 commands.put("GetPostFeed", new GetPostFeedCommand(core));
  67         }
  68
  69         //
  70         // ACCESSORS
  71         //
  72
  73         /**
  74          * Sets whether the FCP interface should handle requests. If {@code active}
  75          * is {@code false}, all requests are answered with an error.
  76          *
  77          * @param active
  78          *            {@code true} to activate the FCP interface, {@code false} to
  79          *            deactivate the FCP interface
  80          */
  81         public void setActive(boolean active) {
  82                 this.active = active;
  83         }
  84
  85         //
  86         // ACTIONS
  87         //
  88
  89         /**
  90          * Handles a plugin FCP request.
  91          *
  92          * @param pluginReplySender
  93          *            The reply sender
  94          * @param parameters
  95          *            The message parameters
  96          * @param data
  97          *            The message data (may be {@code null})
  98          * @param accessType
  99          *            One of {@link FredPluginFCP#ACCESS_DIRECT},
 100          *            {@link FredPluginFCP#ACCESS_FCP_FULL},
 101          *            {@link FredPluginFCP#ACCESS_FCP_RESTRICTED}
 102          */
 103         public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
 104                 if (!active) {
 105                         try {
 106                                 sendReply(pluginReplySender, null, new ErrorResponse(400, "FCP Interface deactivated"));
 107                         } catch (PluginNotFoundException pnfe1) {
 108                                 logger.log(Level.FINE, "Could not set error to plugin.", pnfe1);
 109                         }
 110                         return;
 111                 }
 112                 Command command = commands.get(parameters.get("Message"));
 113                 try {
 114                         if (command == null) {
 115                                 sendReply(pluginReplySender, null, new ErrorResponse("Unrecognized Message: " + parameters.get("Message")));
 116                                 return;
 117                         }
 118                         String identifier = parameters.get("Identifier");
 119                         if ((identifier == null) || (identifier.length() == 0)) {
 120                                 sendReply(pluginReplySender, null, new ErrorResponse("Missing Identifier."));
 121                                 return;
 122                         }
 123                         try {
 124                                 Response response = command.execute(parameters, data, AccessType.values()[accessType]);
 125                                 sendReply(pluginReplySender, identifier, response);
 126                         } catch (FcpException fe1) {
 127                                 sendReply(pluginReplySender, identifier, new ErrorResponse("Error executing command: " + fe1.getMessage()));
 128                         }
 129                 } catch (PluginNotFoundException pnfe1) {
 130                         logger.log(Level.WARNING, "Could not find destination plugin: " + pluginReplySender);
 131                 }
 132         }
 133
 134         //
 135         // PRIVATE METHODS
 136         //
 137
 138         /**
 139          * Sends the given response to the given plugin.
 140          *
 141          * @param pluginReplySender
 142          *            The reply sender
 143          * @param identifier
 144          *            The identifier (may be {@code null})
 145          * @param response
 146          *            The response to send
 147          * @throws PluginNotFoundException
 148          *             if the plugin can not be found
 149          */
 150         private void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException {
 151                 SimpleFieldSet replyParameters = response.getReplyParameters();
 152                 if (identifier != null) {
 153                         replyParameters.putOverwrite("Identifier", identifier);
 154                 }
 155                 if (response.hasData()) {
 156                         pluginReplySender.send(replyParameters, response.getData());
 157                 } else if (response.hasBucket()) {
 158                         pluginReplySender.send(replyParameters, response.getBucket());
 159                 } else {
 160                         pluginReplySender.send(replyParameters);
 161                 }
 162         }
 163
 164 }