2 * Sone - FcpInterface.java - Copyright © 2011–2013 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.fcp;
20 import static com.google.common.base.Preconditions.checkNotNull;
22 import java.util.Collections;
23 import java.util.HashMap;
25 import java.util.logging.Level;
26 import java.util.logging.Logger;
28 import net.pterodactylus.sone.core.Core;
29 import net.pterodactylus.sone.core.Options.Option;
30 import net.pterodactylus.sone.core.Options.OptionWatcher;
31 import net.pterodactylus.sone.freenet.fcp.Command.AccessType;
32 import net.pterodactylus.sone.freenet.fcp.Command.ErrorResponse;
33 import net.pterodactylus.sone.freenet.fcp.Command.Response;
34 import net.pterodactylus.util.logging.Logging;
36 import freenet.pluginmanager.FredPluginFCP;
37 import freenet.pluginmanager.PluginNotFoundException;
38 import freenet.pluginmanager.PluginReplySender;
39 import freenet.support.SimpleFieldSet;
40 import freenet.support.api.Bucket;
42 import com.google.common.annotations.VisibleForTesting;
43 import com.google.inject.Inject;
46 * Implementation of an FCP interface for other clients or plugins to
47 * communicate with Sone.
49 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
51 public class FcpInterface {
54 * The action level that full access for the FCP connection is required.
56 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
58 public enum FullAccessRequired {
60 /** No action requires full access. */
63 /** All writing actions require full access. */
66 /** All actions require full access. */
72 private static final Logger logger = Logging.getLogger(FcpInterface.class);
74 /** Whether the FCP interface is currently active. */
75 private volatile boolean active;
77 /** What function full access is required for. */
78 private volatile FullAccessRequired fullAccessRequired = FullAccessRequired.ALWAYS;
80 /** All available FCP commands. */
81 private final Map<String, AbstractSoneCommand> commands = Collections.synchronizedMap(new HashMap<String, AbstractSoneCommand>());
84 * Creates a new FCP interface.
90 public FcpInterface(Core core) {
91 commands.put("Version", new VersionCommand(core));
92 commands.put("GetLocalSones", new GetLocalSonesCommand(core));
93 commands.put("GetSones", new GetSonesCommand(core));
94 commands.put("GetSone", new GetSoneCommand(core));
95 commands.put("GetPost", new GetPostCommand(core));
96 commands.put("GetPosts", new GetPostsCommand(core));
97 commands.put("GetPostFeed", new GetPostFeedCommand(core));
98 commands.put("LockSone", new LockSoneCommand(core));
99 commands.put("UnlockSone", new UnlockSoneCommand(core));
100 commands.put("LikePost", new LikePostCommand(core));
101 commands.put("LikeReply", new LikeReplyCommand(core));
102 commands.put("CreatePost", new CreatePostCommand(core));
103 commands.put("CreateReply", new CreateReplyCommand(core));
104 commands.put("DeletePost", new DeletePostCommand(core));
105 commands.put("DeleteReply", new DeleteReplyCommand(core));
118 * Sets whether the FCP interface should handle requests. If {@code active}
119 * is {@code false}, all requests are answered with an error.
122 * {@code true} to activate the FCP interface, {@code false} to
123 * deactivate the FCP interface
125 public void setActive(boolean active) {
126 this.active = active;
130 * Sets the action level for which full FCP access is required.
132 * @param fullAccessRequired
133 * The action level for which full FCP access is required
135 public void setFullAccessRequired(FullAccessRequired fullAccessRequired) {
136 this.fullAccessRequired = checkNotNull(fullAccessRequired, "fullAccessRequired must not be null");
144 * Handles a plugin FCP request.
146 * @param pluginReplySender
149 * The message parameters
151 * The message data (may be {@code null})
153 * One of {@link FredPluginFCP#ACCESS_DIRECT},
154 * {@link FredPluginFCP#ACCESS_FCP_FULL},
155 * {@link FredPluginFCP#ACCESS_FCP_RESTRICTED}
157 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
160 sendReply(pluginReplySender, null, new ErrorResponse(400, "FCP Interface deactivated"));
161 } catch (PluginNotFoundException pnfe1) {
162 logger.log(Level.FINE, "Could not set error to plugin.", pnfe1);
166 AbstractSoneCommand command = commands.get(parameters.get("Message"));
167 if ((accessType == FredPluginFCP.ACCESS_FCP_RESTRICTED) && (((fullAccessRequired == FullAccessRequired.WRITING) && command.requiresWriteAccess()) || (fullAccessRequired == FullAccessRequired.ALWAYS))) {
169 sendReply(pluginReplySender, null, new ErrorResponse(401, "Not authorized"));
170 } catch (PluginNotFoundException pnfe1) {
171 logger.log(Level.FINE, "Could not set error to plugin.", pnfe1);
176 if (command == null) {
177 sendReply(pluginReplySender, null, new ErrorResponse("Unrecognized Message: " + parameters.get("Message")));
180 String identifier = parameters.get("Identifier");
181 if ((identifier == null) || (identifier.length() == 0)) {
182 sendReply(pluginReplySender, null, new ErrorResponse("Missing Identifier."));
186 Response response = command.execute(parameters, data, AccessType.values()[accessType]);
187 sendReply(pluginReplySender, identifier, response);
188 } catch (Exception e1) {
189 logger.log(Level.WARNING, "Could not process FCP command “%s”.", command);
190 sendReply(pluginReplySender, identifier, new ErrorResponse("Error executing command: " + e1.getMessage()));
192 } catch (PluginNotFoundException pnfe1) {
193 logger.log(Level.WARNING, "Could not find destination plugin: " + pluginReplySender);
202 * Sends the given response to the given plugin.
204 * @param pluginReplySender
207 * The identifier (may be {@code null})
209 * The response to send
210 * @throws PluginNotFoundException
211 * if the plugin can not be found
213 private static void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException {
214 SimpleFieldSet replyParameters = response.getReplyParameters();
215 if (identifier != null) {
216 replyParameters.putOverwrite("Identifier", identifier);
218 if (response.hasData()) {
219 pluginReplySender.send(replyParameters, response.getData());
220 } else if (response.hasBucket()) {
221 pluginReplySender.send(replyParameters, response.getBucket());
223 pluginReplySender.send(replyParameters);
227 public class SetActive implements OptionWatcher<Boolean> {
230 public void optionChanged(Option<Boolean> option, Boolean oldValue, Boolean newValue) {