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