X-Git-Url: https://git.pterodactylus.net/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Fnet%2Fpterodactylus%2Fsone%2Ffcp%2FFcpInterface.java;h=551dc4f67747522c77ae6bf527cb2057d5fc2c68;hb=5bcdc1b924c598b1e59551d44e2302ef29258dad;hp=46ee5c2ee4e5d025e33f79976a133179269911d9;hpb=d2a84d3d722e9c3df68cd5b7f86d8bf9372d7e2b;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 46ee5c2..551dc4f 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;
@@ -24,33 +26,58 @@ import java.util.logging.Level;
 import java.util.logging.Logger;
 
 import net.pterodactylus.sone.core.Core;
+import net.pterodactylus.sone.core.Options.Option;
+import net.pterodactylus.sone.core.Options.OptionWatcher;
 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 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.inject.Inject;
+import com.google.inject.Singleton;
+
 /**
  * Implementation of an FCP interface for other clients or plugins to
  * communicate with Sone.
  *
  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  */
+@Singleton
 public class FcpInterface {
 
+	/**
+	 * The action level that full access for the FCP connection is required.
+	 *
+	 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
+	 */
+	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<String, AbstractSoneCommand> commands = Collections.synchronizedMap(new HashMap<String, AbstractSoneCommand>());
@@ -61,12 +88,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));
@@ -79,6 +111,11 @@ public class FcpInterface {
 	// ACCESSORS
 	//
 
+	@VisibleForTesting
+	boolean isActive() {
+		return active;
+	}
+
 	/**
 	 * Sets whether the FCP interface should handle requests. If {@code active}
 	 * is {@code false}, all requests are answered with an error.
@@ -91,15 +128,19 @@ public class FcpInterface {
 		this.active = active;
 	}
 
+	@VisibleForTesting
+	FullAccessRequired getFullAccessRequired() {
+		return fullAccessRequired;
+	}
+
 	/**
-	 * 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");
 	}
 
 	//
@@ -130,9 +171,9 @@ public class FcpInterface {
 			return;
 		}
 		AbstractSoneCommand command = commands.get(parameters.get("Message"));
-		if (allowWriteFromFullAccessOnly && command.requiresWriteAccess() && (accessType == FredPluginFCP.ACCESS_FCP_RESTRICTED)) {
+		if ((accessType == FredPluginFCP.ACCESS_FCP_RESTRICTED) && (((fullAccessRequired == FullAccessRequired.WRITING) && command.requiresWriteAccess()) || (fullAccessRequired == FullAccessRequired.ALWAYS))) {
 			try {
-				sendReply(pluginReplySender, null, new ErrorResponse(401, "No Write Access"));
+				sendReply(pluginReplySender, null, new ErrorResponse(401, "Not authorized"));
 			} catch (PluginNotFoundException pnfe1) {
 				logger.log(Level.FINE, "Could not set error to plugin.", pnfe1);
 			}
@@ -151,8 +192,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);
@@ -175,7 +217,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);
@@ -189,4 +231,22 @@ public class FcpInterface {
 		}
 	}
 
+	public class SetActive implements OptionWatcher<Boolean> {
+
+		@Override
+		public void optionChanged(Option<Boolean> option, Boolean oldValue, Boolean newValue) {
+			setActive(newValue);
+		}
+
+	}
+
+	public class SetFullAccessRequired implements OptionWatcher<Integer> {
+
+		@Override
+		public void optionChanged(Option<Integer> option, Integer oldValue, Integer newValue) {
+			setFullAccessRequired(FullAccessRequired.values()[newValue]);
+		}
+
+	}
+
 }