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("GetPost", new GetPostCommand(core));
  66                 commands.put("GetPosts", new GetPostsCommand(core));
  67                 commands.put("GetPostFeed", new GetPostFeedCommand(core));
  68                 commands.put("LikePost", new LikePostCommand(core));
  69                 commands.put("LikeReply", new LikeReplyCommand(core));
  70                 commands.put("CreatePost", new CreatePostCommand(core));
  71         }
  72
  73         //
  74         // ACCESSORS
  75         //
  76
  77         /**
  78          * Sets whether the FCP interface should handle requests. If {@code active}
  79          * is {@code false}, all requests are answered with an error.
  80          *
  81          * @param active
  82          *            {@code true} to activate the FCP interface, {@code false} to
  83          *            deactivate the FCP interface
  84          */
  85         public void setActive(boolean active) {
  86                 this.active = active;
  87         }
  88
  89         //
  90         // ACTIONS
  91         //
  92
  93         /**
  94          * Handles a plugin FCP request.
  95          *
  96          * @param pluginReplySender
  97          *            The reply sender
  98          * @param parameters
  99          *            The message parameters
 100          * @param data
 101          *            The message data (may be {@code null})
 102          * @param accessType
 103          *            One of {@link FredPluginFCP#ACCESS_DIRECT},
 104          *            {@link FredPluginFCP#ACCESS_FCP_FULL},
 105          *            {@link FredPluginFCP#ACCESS_FCP_RESTRICTED}
 106          */
 107         public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
 108                 if (!active) {
 109                         try {
 110                                 sendReply(pluginReplySender, null, new ErrorResponse(400, "FCP Interface deactivated"));
 111                         } catch (PluginNotFoundException pnfe1) {
 112                                 logger.log(Level.FINE, "Could not set error to plugin.", pnfe1);
 113                         }
 114                         return;
 115                 }
 116                 Command command = commands.get(parameters.get("Message"));
 117                 try {
 118                         if (command == null) {
 119                                 sendReply(pluginReplySender, null, new ErrorResponse("Unrecognized Message: " + parameters.get("Message")));
 120                                 return;
 121                         }
 122                         String identifier = parameters.get("Identifier");
 123                         if ((identifier == null) || (identifier.length() == 0)) {
 124                                 sendReply(pluginReplySender, null, new ErrorResponse("Missing Identifier."));
 125                                 return;
 126                         }
 127                         try {
 128                                 Response response = command.execute(parameters, data, AccessType.values()[accessType]);
 129                                 sendReply(pluginReplySender, identifier, response);
 130                         } catch (FcpException fe1) {
 131                                 sendReply(pluginReplySender, identifier, new ErrorResponse("Error executing command: " + fe1.getMessage()));
 132                         }
 133                 } catch (PluginNotFoundException pnfe1) {
 134                         logger.log(Level.WARNING, "Could not find destination plugin: " + pluginReplySender);
 135                 }
 136         }
 137
 138         //
 139         // PRIVATE METHODS
 140         //
 141
 142         /**
 143          * Sends the given response to the given plugin.
 144          *
 145          * @param pluginReplySender
 146          *            The reply sender
 147          * @param identifier
 148          *            The identifier (may be {@code null})
 149          * @param response
 150          *            The response to send
 151          * @throws PluginNotFoundException
 152          *             if the plugin can not be found
 153          */
 154         private void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException {
 155                 SimpleFieldSet replyParameters = response.getReplyParameters();
 156                 if (identifier != null) {
 157                         replyParameters.putOverwrite("Identifier", identifier);
 158                 }
 159                 if (response.hasData()) {
 160                         pluginReplySender.send(replyParameters, response.getData());
 161                 } else if (response.hasBucket()) {
 162                         pluginReplySender.send(replyParameters, response.getBucket());
 163                 } else {
 164                         pluginReplySender.send(replyParameters);
 165                 }
 166         }
 167
 168 }