X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ffcp%2FFcpInterface.java;h=128d46a33eb1a6fdc05dfe75946ac3113d7357b1;hp=3a64bbf1c36b2281a8f0095a8652b8b94fd7b321;hb=a47643aed43d118ca68044f95451bb5374cdb332;hpb=6a426e5c3a82f3e63a8763d2a5ad57f311bc6065 diff --git a/src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java b/src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java index 3a64bbf..128d46a 100644 --- a/src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java +++ b/src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java @@ -1,5 +1,5 @@ /* - * Sone - FcpInterface.java - Copyright © 2011 David Roden + * Sone - FcpInterface.java - Copyright © 2011–2012 David Roden * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -20,12 +20,16 @@ package net.pterodactylus.sone.fcp; import java.util.Collections; import java.util.HashMap; import java.util.Map; +import java.util.logging.Level; +import java.util.logging.Logger; import net.pterodactylus.sone.core.Core; -import net.pterodactylus.sone.freenet.fcp.Command; -import net.pterodactylus.sone.freenet.fcp.FcpException; import net.pterodactylus.sone.freenet.fcp.Command.AccessType; +import net.pterodactylus.sone.freenet.fcp.Command.ErrorResponse; import net.pterodactylus.sone.freenet.fcp.Command.Response; +import net.pterodactylus.sone.freenet.fcp.FcpException; +import net.pterodactylus.util.logging.Logging; +import net.pterodactylus.util.validation.Validation; import freenet.pluginmanager.FredPluginFCP; import freenet.pluginmanager.PluginNotFoundException; import freenet.pluginmanager.PluginReplySender; @@ -40,8 +44,35 @@ import freenet.support.api.Bucket; */ public class FcpInterface { + /** + * The action level that full access for the FCP connection is required. + * + * @author David ‘Bombe’ Roden + */ + public enum FullAccessRequired { + + /** No action requires full access. */ + NO, + + /** All writing actions require full access. */ + WRITING, + + /** All actions require full access. */ + ALWAYS, + + } + + /** The logger. */ + private static final Logger logger = Logging.getLogger(FcpInterface.class); + + /** Whether the FCP interface is currently active. */ + private volatile boolean active; + + /** What function full access is required for. */ + private volatile FullAccessRequired fullAccessRequired = FullAccessRequired.ALWAYS; + /** All available FCP commands. */ - private final Map commands = Collections.synchronizedMap(new HashMap()); + private final Map commands = Collections.synchronizedMap(new HashMap()); /** * Creates a new FCP interface. @@ -50,11 +81,52 @@ public class FcpInterface { * The core */ public FcpInterface(Core core) { - commands.put("Version", new VersionCommand()); + commands.put("Version", new VersionCommand(core)); commands.put("GetLocalSones", new GetLocalSonesCommand(core)); + commands.put("GetSones", new GetSonesCommand(core)); + commands.put("GetSone", new GetSoneCommand(core)); + commands.put("GetPost", new GetPostCommand(core)); + commands.put("GetPosts", new GetPostsCommand(core)); commands.put("GetPostFeed", new GetPostFeedCommand(core)); + commands.put("LikePost", new LikePostCommand(core)); + commands.put("LikeReply", new LikeReplyCommand(core)); + commands.put("CreatePost", new CreatePostCommand(core)); + commands.put("CreateReply", new CreateReplyCommand(core)); + commands.put("DeletePost", new DeletePostCommand(core)); + commands.put("DeleteReply", new DeleteReplyCommand(core)); + } + + // + // ACCESSORS + // + + /** + * Sets whether the FCP interface should handle requests. If {@code active} + * is {@code false}, all requests are answered with an error. + * + * @param active + * {@code true} to activate the FCP interface, {@code false} to + * deactivate the FCP interface + */ + public void setActive(boolean active) { + this.active = active; + } + + /** + * Sets the action level for which full FCP access is required. + * + * @param fullAccessRequired + * The action level for which full FCP access is required + */ + public void setFullAccessRequired(FullAccessRequired fullAccessRequired) { + Validation.begin().isNotNull("FullAccessRequired", fullAccessRequired).check(); + this.fullAccessRequired = fullAccessRequired; } + // + // ACTIONS + // + /** * Handles a plugin FCP request. * @@ -70,31 +142,72 @@ public class FcpInterface { * {@link FredPluginFCP#ACCESS_FCP_RESTRICTED} */ public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) { - Command command = commands.get(parameters.get("Message")); - if (command == null) { - /* TODO - return error? */ + if (!active) { + try { + sendReply(pluginReplySender, null, new ErrorResponse(400, "FCP Interface deactivated")); + } catch (PluginNotFoundException pnfe1) { + logger.log(Level.FINE, "Could not set error to plugin.", pnfe1); + } return; } - String identifier = parameters.get("Identifier"); - if ((identifier == null) || (identifier.length() == 0)) { - /* TODO - return error? */ + AbstractSoneCommand command = commands.get(parameters.get("Message")); + if ((accessType == FredPluginFCP.ACCESS_FCP_RESTRICTED) && (((fullAccessRequired == FullAccessRequired.WRITING) && command.requiresWriteAccess()) || (fullAccessRequired == FullAccessRequired.ALWAYS))) { + try { + sendReply(pluginReplySender, null, new ErrorResponse(401, "Not authorized")); + } catch (PluginNotFoundException pnfe1) { + logger.log(Level.FINE, "Could not set error to plugin.", pnfe1); + } return; } try { - Response reply = command.execute(parameters, data, AccessType.values()[accessType]); - SimpleFieldSet replyParameters = reply.getReplyParameters(); - replyParameters.putOverwrite("Identifier", identifier); - if (reply.hasData()) { - pluginReplySender.send(replyParameters, reply.getData()); - } else if (reply.hasBucket()) { - pluginReplySender.send(replyParameters, reply.getBucket()); - } else { - pluginReplySender.send(replyParameters); + if (command == null) { + sendReply(pluginReplySender, null, new ErrorResponse("Unrecognized Message: " + parameters.get("Message"))); + return; + } + String identifier = parameters.get("Identifier"); + if ((identifier == null) || (identifier.length() == 0)) { + sendReply(pluginReplySender, null, new ErrorResponse("Missing Identifier.")); + return; + } + try { + Response response = command.execute(parameters, data, AccessType.values()[accessType]); + sendReply(pluginReplySender, identifier, response); + } catch (FcpException fe1) { + logger.log(Level.WARNING, "Could not process FCP command “%s”.", command); + sendReply(pluginReplySender, identifier, new ErrorResponse("Error executing command: " + fe1.getMessage())); } - } catch (FcpException fe1) { - /* TODO - log, report */ } catch (PluginNotFoundException pnfe1) { - /* TODO - log */ + logger.log(Level.WARNING, "Could not find destination plugin: " + pluginReplySender); + } + } + + // + // PRIVATE METHODS + // + + /** + * Sends the given response to the given plugin. + * + * @param pluginReplySender + * The reply sender + * @param identifier + * The identifier (may be {@code null}) + * @param response + * The response to send + * @throws PluginNotFoundException + * if the plugin can not be found + */ + private void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException { + SimpleFieldSet replyParameters = response.getReplyParameters(); + if (identifier != null) { + replyParameters.putOverwrite("Identifier", identifier); + } + if (response.hasData()) { + pluginReplySender.send(replyParameters, response.getData()); + } else if (response.hasBucket()) { + pluginReplySender.send(replyParameters, response.getBucket()); + } else { + pluginReplySender.send(replyParameters); } }