X-Git-Url: https://git.pterodactylus.net/?p=Sone.git;a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ffcp%2FFcpInterface.java;h=e190aef74e6999da7d1f48d0ea7eb9e48d6eb6bf;hp=a0e3c40371a041deddc4b56757c7a6446eb63454;hb=2bacfa78f3191fd9847574a6c8b218a4882844a4;hpb=5d8f3ac133544177412ec3c533e5f5f92a7b1c35 diff --git a/src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java b/src/main/java/net/pterodactylus/sone/fcp/FcpInterface.java index a0e3c40..e190aef 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–2012 David Roden + * Sone - FcpInterface.java - Copyright © 2011–2016 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,20 +17,29 @@ package net.pterodactylus.sone.fcp; -import java.util.Collections; +import static com.google.common.base.Preconditions.checkNotNull; +import static java.util.logging.Logger.getLogger; +import static net.pterodactylus.sone.fcp.FcpInterface.FullAccessRequired.NO; +import static net.pterodactylus.sone.fcp.FcpInterface.FullAccessRequired.WRITING; +import static net.pterodactylus.sone.freenet.fcp.Command.AccessType.RESTRICTED_FCP; + import java.util.HashMap; import java.util.Map; +import java.util.concurrent.atomic.AtomicBoolean; +import java.util.concurrent.atomic.AtomicReference; import java.util.logging.Level; import java.util.logging.Logger; +import javax.annotation.Nonnull; +import javax.inject.Singleton; + import net.pterodactylus.sone.core.Core; +import net.pterodactylus.sone.fcp.event.FcpInterfaceActivatedEvent; +import net.pterodactylus.sone.fcp.event.FcpInterfaceDeactivatedEvent; +import net.pterodactylus.sone.fcp.event.FullAccessRequiredChanged; 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.util.logging.Logging; -import net.pterodactylus.util.validation.Validation; - -import com.google.inject.Inject; import freenet.pluginmanager.FredPluginFCP; import freenet.pluginmanager.PluginNotFoundException; @@ -38,18 +47,19 @@ import freenet.pluginmanager.PluginReplySender; import freenet.support.SimpleFieldSet; import freenet.support.api.Bucket; +import com.google.common.annotations.VisibleForTesting; +import com.google.common.eventbus.Subscribe; +import com.google.inject.Inject; + /** * Implementation of an FCP interface for other clients or plugins to * communicate with Sone. - * - * @author David ‘Bombe’ Roden */ +@Singleton public class FcpInterface { /** * The action level that full access for the FCP connection is required. - * - * @author David ‘Bombe’ Roden */ public enum FullAccessRequired { @@ -65,16 +75,17 @@ public class FcpInterface { } /** The logger. */ - private static final Logger logger = Logging.getLogger(FcpInterface.class); + private static final Logger logger = getLogger(FcpInterface.class.getName()); /** Whether the FCP interface is currently active. */ - private volatile boolean active; + private final AtomicBoolean active = new AtomicBoolean(); /** What function full access is required for. */ - private volatile FullAccessRequired fullAccessRequired = FullAccessRequired.ALWAYS; + private final AtomicReference fullAccessRequired = new AtomicReference<>(FullAccessRequired.ALWAYS); /** All available FCP commands. */ - private final Map commands = Collections.synchronizedMap(new HashMap()); + private final Map commands; + private final AccessAuthorizer accessAuthorizer; /** * Creates a new FCP interface. @@ -83,47 +94,31 @@ public class FcpInterface { * 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("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)); + public FcpInterface(Core core, CommandSupplier commandSupplier, AccessAuthorizer accessAuthorizer) { + commands = commandSupplier.supplyCommands(core); + this.accessAuthorizer = accessAuthorizer; } // // 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; + @VisibleForTesting + boolean isActive() { + return active.get(); } - /** - * 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; + private void setActive(boolean active) { + this.active.set(active); + } + + @VisibleForTesting + FullAccessRequired getFullAccessRequired() { + return fullAccessRequired.get(); + } + + private void setFullAccessRequired(FullAccessRequired fullAccessRequired) { + this.fullAccessRequired.set(checkNotNull(fullAccessRequired, "fullAccessRequired must not be null")); } // @@ -145,42 +140,38 @@ public class FcpInterface { * {@link FredPluginFCP#ACCESS_FCP_RESTRICTED} */ public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) { - 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); - } + String identifier = parameters.get("Identifier"); + if ((identifier == null) || (identifier.length() == 0)) { + sendErrorReply(pluginReplySender, null, 400, "Missing Identifier."); + return; + } + if (!active.get()) { + sendErrorReply(pluginReplySender, identifier, 503, "FCP Interface deactivated"); return; } 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); - } + if (command == null) { + sendErrorReply(pluginReplySender, identifier, 404, "Unrecognized Message: " + parameters.get("Message")); return; } + if (!accessAuthorizer.authorized(AccessType.values()[accessType], fullAccessRequired.get(), command.requiresWriteAccess())) { + sendErrorReply(pluginReplySender, identifier, 401, "Not authorized"); + return; + } + try { + Response response = command.execute(parameters); + sendReply(pluginReplySender, identifier, response); + } catch (Exception e1) { + logger.log(Level.WARNING, "Could not process FCP command “%s”.", command); + sendErrorReply(pluginReplySender, identifier, 500, "Error executing command: " + e1.getMessage()); + } + } + + private void sendErrorReply(PluginReplySender pluginReplySender, String identifier, int errorCode, String message) { try { - 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 (Exception e1) { - logger.log(Level.WARNING, "Could not process FCP command “%s”.", command); - sendReply(pluginReplySender, identifier, new ErrorResponse("Error executing command: " + e1.getMessage())); - } + sendReply(pluginReplySender, identifier, new ErrorResponse(errorCode, message)); } catch (PluginNotFoundException pnfe1) { - logger.log(Level.WARNING, "Could not find destination plugin: " + pluginReplySender); + logger.log(Level.FINE, "Could not send error to plugin.", pnfe1); } } @@ -205,13 +196,56 @@ public class FcpInterface { 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); + pluginReplySender.send(replyParameters); + } + + @Subscribe + public void fcpInterfaceActivated(FcpInterfaceActivatedEvent fcpInterfaceActivatedEvent) { + setActive(true); + } + + @Subscribe + public void fcpInterfaceDeactivated(FcpInterfaceDeactivatedEvent fcpInterfaceDeactivatedEvent) { + setActive(false); + } + + @Subscribe + public void fullAccessRequiredChanged(FullAccessRequiredChanged fullAccessRequiredChanged) { + setFullAccessRequired(fullAccessRequiredChanged.getFullAccessRequired()); + } + + @Singleton + public static class CommandSupplier { + + public Map supplyCommands(Core core) { + Map commands = new HashMap<>(); + 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)); + commands.put("CreateReply", new CreateReplyCommand(core)); + commands.put("DeletePost", new DeletePostCommand(core)); + commands.put("DeleteReply", new DeleteReplyCommand(core)); + return commands; + } + + } + + @Singleton + public static class AccessAuthorizer { + + public boolean authorized(@Nonnull AccessType accessType, @Nonnull FullAccessRequired fullAccessRequired, boolean commandRequiresWriteAccess) { + return (accessType != RESTRICTED_FCP) || (fullAccessRequired == NO) || ((fullAccessRequired == WRITING) && !commandRequiresWriteAccess); } + } }