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=3a64bbf1c36b2281a8f0095a8652b8b94fd7b321;hb=2bacfa78f3191fd9847574a6c8b218a4882844a4;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..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 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,31 +17,75 @@ 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.freenet.fcp.Command; -import net.pterodactylus.sone.freenet.fcp.FcpException; +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 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; +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. + */ + 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 = getLogger(FcpInterface.class.getName()); + + /** Whether the FCP interface is currently active. */ + private final AtomicBoolean active = new AtomicBoolean(); + + /** What function full access is required for. */ + 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. @@ -49,12 +93,38 @@ public class FcpInterface { * @param core * The core */ - public FcpInterface(Core core) { - commands.put("Version", new VersionCommand()); - commands.put("GetLocalSones", new GetLocalSonesCommand(core)); - commands.put("GetPostFeed", new GetPostFeedCommand(core)); + @Inject + public FcpInterface(Core core, CommandSupplier commandSupplier, AccessAuthorizer accessAuthorizer) { + commands = commandSupplier.supplyCommands(core); + this.accessAuthorizer = accessAuthorizer; } + // + // ACCESSORS + // + + @VisibleForTesting + boolean isActive() { + return active.get(); + } + + 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")); + } + + // + // ACTIONS + // + /** * Handles a plugin FCP request. * @@ -70,32 +140,112 @@ 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")); + 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 (command == null) { - /* TODO - return error? */ + sendErrorReply(pluginReplySender, identifier, 404, "Unrecognized Message: " + parameters.get("Message")); return; } - String identifier = parameters.get("Identifier"); - if ((identifier == null) || (identifier.length() == 0)) { - /* TODO - return error? */ + if (!accessAuthorizer.authorized(AccessType.values()[accessType], fullAccessRequired.get(), command.requiresWriteAccess())) { + sendErrorReply(pluginReplySender, identifier, 401, "Not authorized"); 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); - } - } catch (FcpException fe1) { - /* TODO - log, report */ + 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 { + sendReply(pluginReplySender, identifier, new ErrorResponse(errorCode, message)); } catch (PluginNotFoundException pnfe1) { - /* TODO - log */ + logger.log(Level.FINE, "Could not send error to plugin.", pnfe1); + } + } + + // + // 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 static void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException { + SimpleFieldSet replyParameters = response.getReplyParameters(); + if (identifier != null) { + replyParameters.putOverwrite("Identifier", identifier); } + 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); + } + } }