X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ffcp%2FFcpInterface.java;h=2c7355d4c7de54779f2eb781eb17dbd52a418e58;hb=0a4b6fc252003c71f4bdef09560e87982838d9c8;hp=e66bb8d8293b354eead3f3180a5306e33429211e;hpb=c2233cceb10f4403a7dd63dfc42fe8d1e4bdb07f;p=Sone.git diff --git a/src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java b/src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java index e66bb8d..2c7355d 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–2013 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 @@ -17,6 +17,8 @@ package net.pterodactylus.sone.fcp; +import static com.google.common.base.Preconditions.checkNotNull; + import java.util.Collections; import java.util.HashMap; import java.util.Map; @@ -27,14 +29,17 @@ import net.pterodactylus.sone.core.Core; 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 com.google.inject.Inject; + import freenet.pluginmanager.FredPluginFCP; import freenet.pluginmanager.PluginNotFoundException; import freenet.pluginmanager.PluginReplySender; import freenet.support.SimpleFieldSet; import freenet.support.api.Bucket; +import com.google.common.annotations.VisibleForTesting; /** * Implementation of an FCP interface for other clients or plugins to * communicate with Sone. @@ -43,14 +48,32 @@ 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; - /** Whether to allow write access from full access hosts only. */ - private volatile boolean allowWriteFromFullAccessOnly; + /** 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()); @@ -61,13 +84,17 @@ public class FcpInterface { * @param core * The core */ + @Inject public FcpInterface(Core core) { 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("LockSone", new LockSoneCommand(core)); + commands.put("UnlockSone", new UnlockSoneCommand(core)); commands.put("LikePost", new LikePostCommand(core)); commands.put("LikeReply", new LikeReplyCommand(core)); commands.put("CreatePost", new CreatePostCommand(core)); @@ -80,6 +107,11 @@ public class FcpInterface { // ACCESSORS // + @VisibleForTesting + void addCommand(String name, AbstractSoneCommand command) { + commands.put(name, command); + } + /** * Sets whether the FCP interface should handle requests. If {@code active} * is {@code false}, all requests are answered with an error. @@ -93,14 +125,13 @@ public class FcpInterface { } /** - * Sets whether write access is only allowed from full access hosts. + * Sets the action level for which full FCP access is required. * - * @param allowWriteFromFullAccessOnly - * {@code true} to allow write access only from full access - * hosts, {@code false} to always allow write access + * @param fullAccessRequired + * The action level for which full FCP access is required */ - public void setAllowWriteFromFullAccessOnly(boolean allowWriteFromFullAccessOnly) { - this.allowWriteFromFullAccessOnly = allowWriteFromFullAccessOnly; + public void setFullAccessRequired(FullAccessRequired fullAccessRequired) { + this.fullAccessRequired = checkNotNull(fullAccessRequired, "fullAccessRequired must not be null"); } // @@ -122,24 +153,16 @@ public class FcpInterface { * {@link FredPluginFCP#ACCESS_FCP_RESTRICTED} */ public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) { - if (!active) { - try { + try { + if (!active) { sendReply(pluginReplySender, null, new ErrorResponse(400, "FCP Interface deactivated")); - } catch (PluginNotFoundException pnfe1) { - logger.log(Level.FINE, "Could not set error to plugin.", pnfe1); + return; } - return; - } - AbstractSoneCommand command = commands.get(parameters.get("Message")); - if (allowWriteFromFullAccessOnly && command.requiresWriteAccess() && (accessType == FredPluginFCP.ACCESS_FCP_RESTRICTED)) { - try { - sendReply(pluginReplySender, null, new ErrorResponse(401, "No Write Access")); - } catch (PluginNotFoundException pnfe1) { - logger.log(Level.FINE, "Could not set error to plugin.", pnfe1); + AbstractSoneCommand command = commands.get(parameters.get("Message")); + if ((accessType == FredPluginFCP.ACCESS_FCP_RESTRICTED) && (((fullAccessRequired == FullAccessRequired.WRITING) && command.requiresWriteAccess()) || (fullAccessRequired == FullAccessRequired.ALWAYS))) { + sendReply(pluginReplySender, null, new ErrorResponse(401, "Not authorized")); + return; } - return; - } - try { if (command == null) { sendReply(pluginReplySender, null, new ErrorResponse("Unrecognized Message: " + parameters.get("Message"))); return; @@ -152,8 +175,9 @@ public class FcpInterface { try { Response response = command.execute(parameters, data, AccessType.values()[accessType]); sendReply(pluginReplySender, identifier, response); - } catch (FcpException fe1) { - sendReply(pluginReplySender, identifier, new ErrorResponse("Error executing command: " + fe1.getMessage())); + } catch (Exception e1) { + logger.log(Level.WARNING, "Could not process FCP command “%s”.", command); + sendReply(pluginReplySender, identifier, new ErrorResponse("Error executing command: " + e1.getMessage())); } } catch (PluginNotFoundException pnfe1) { logger.log(Level.WARNING, "Could not find destination plugin: " + pluginReplySender); @@ -176,7 +200,7 @@ public class FcpInterface { * @throws PluginNotFoundException * if the plugin can not be found */ - private void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException { + private static void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException { SimpleFieldSet replyParameters = response.getReplyParameters(); if (identifier != null) { replyParameters.putOverwrite("Identifier", identifier);