2 * Sone - FcpInterface.java - Copyright © 2011–2016 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;
21 import static java.util.logging.Logger.getLogger;
23 import java.util.HashMap;
25 import java.util.concurrent.atomic.AtomicBoolean;
26 import java.util.concurrent.atomic.AtomicReference;
27 import java.util.logging.Level;
28 import java.util.logging.Logger;
30 import javax.inject.Singleton;
32 import net.pterodactylus.sone.core.Core;
33 import net.pterodactylus.sone.fcp.event.FcpInterfaceActivatedEvent;
34 import net.pterodactylus.sone.fcp.event.FcpInterfaceDeactivatedEvent;
35 import net.pterodactylus.sone.fcp.event.FullAccessRequiredChanged;
36 import net.pterodactylus.sone.freenet.fcp.Command.AccessType;
37 import net.pterodactylus.sone.freenet.fcp.Command.ErrorResponse;
38 import net.pterodactylus.sone.freenet.fcp.Command.Response;
40 import freenet.pluginmanager.FredPluginFCP;
41 import freenet.pluginmanager.PluginNotFoundException;
42 import freenet.pluginmanager.PluginReplySender;
43 import freenet.support.SimpleFieldSet;
44 import freenet.support.api.Bucket;
46 import com.google.common.annotations.VisibleForTesting;
47 import com.google.common.eventbus.Subscribe;
48 import com.google.inject.Inject;
51 * Implementation of an FCP interface for other clients or plugins to
52 * communicate with Sone.
54 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
57 public class FcpInterface {
60 * The action level that full access for the FCP connection is required.
62 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
64 public enum FullAccessRequired {
66 /** No action requires full access. */
69 /** All writing actions require full access. */
72 /** All actions require full access. */
78 private static final Logger logger = getLogger(FcpInterface.class.getName());
80 /** Whether the FCP interface is currently active. */
81 private final AtomicBoolean active = new AtomicBoolean();
83 /** What function full access is required for. */
84 private final AtomicReference<FullAccessRequired> fullAccessRequired = new AtomicReference<FullAccessRequired>(FullAccessRequired.ALWAYS);
86 /** All available FCP commands. */
87 private final Map<String, AbstractSoneCommand> commands;
90 * Creates a new FCP interface.
96 public FcpInterface(Core core, CommandSupplier commandSupplier) {
97 commands = commandSupplier.supplyCommands(core);
109 private void setActive(boolean active) {
110 this.active.set(active);
114 FullAccessRequired getFullAccessRequired() {
115 return fullAccessRequired.get();
118 private void setFullAccessRequired(FullAccessRequired fullAccessRequired) {
119 this.fullAccessRequired.set(checkNotNull(fullAccessRequired, "fullAccessRequired must not be null"));
127 * Handles a plugin FCP request.
129 * @param pluginReplySender
132 * The message parameters
134 * The message data (may be {@code null})
136 * One of {@link FredPluginFCP#ACCESS_DIRECT},
137 * {@link FredPluginFCP#ACCESS_FCP_FULL},
138 * {@link FredPluginFCP#ACCESS_FCP_RESTRICTED}
140 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
142 sendErrorReply(pluginReplySender, null, 503, "FCP Interface deactivated");
145 AbstractSoneCommand command = commands.get(parameters.get("Message"));
146 if ((accessType == FredPluginFCP.ACCESS_FCP_RESTRICTED) && (((fullAccessRequired.get() == FullAccessRequired.WRITING) && command.requiresWriteAccess()) || (fullAccessRequired.get() == FullAccessRequired.ALWAYS))) {
147 sendErrorReply(pluginReplySender, null, 401, "Not authorized");
150 if (command == null) {
151 sendErrorReply(pluginReplySender, null, 404, "Unrecognized Message: " + parameters.get("Message"));
154 String identifier = parameters.get("Identifier");
155 if ((identifier == null) || (identifier.length() == 0)) {
156 sendErrorReply(pluginReplySender, null, 400, "Missing Identifier.");
160 Response response = command.execute(parameters, data, AccessType.values()[accessType]);
161 sendReply(pluginReplySender, identifier, response);
162 } catch (Exception e1) {
163 logger.log(Level.WARNING, "Could not process FCP command “%s”.", command);
164 sendErrorReply(pluginReplySender, identifier, 500, "Error executing command: " + e1.getMessage());
168 private void sendErrorReply(PluginReplySender pluginReplySender, String identifier, int errorCode, String message) {
170 sendReply(pluginReplySender, identifier, new ErrorResponse(errorCode, message));
171 } catch (PluginNotFoundException pnfe1) {
172 logger.log(Level.FINE, "Could not send error to plugin.", pnfe1);
181 * Sends the given response to the given plugin.
183 * @param pluginReplySender
186 * The identifier (may be {@code null})
188 * The response to send
189 * @throws PluginNotFoundException
190 * if the plugin can not be found
192 private static void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException {
193 SimpleFieldSet replyParameters = response.getReplyParameters();
194 if (identifier != null) {
195 replyParameters.putOverwrite("Identifier", identifier);
197 if (response.hasData()) {
198 pluginReplySender.send(replyParameters, response.getData());
199 } else if (response.hasBucket()) {
200 pluginReplySender.send(replyParameters, response.getBucket());
202 pluginReplySender.send(replyParameters);
207 public void fcpInterfaceActivated(FcpInterfaceActivatedEvent fcpInterfaceActivatedEvent) {
212 public void fcpInterfaceDeactivated(FcpInterfaceDeactivatedEvent fcpInterfaceDeactivatedEvent) {
217 public void fullAccessRequiredChanged(FullAccessRequiredChanged fullAccessRequiredChanged) {
218 setFullAccessRequired(fullAccessRequiredChanged.getFullAccessRequired());
222 public static class CommandSupplier {
224 public Map<String, AbstractSoneCommand> supplyCommands(Core core) {
225 Map<String, AbstractSoneCommand> commands = new HashMap<>();
226 commands.put("Version", new VersionCommand(core));
227 commands.put("GetLocalSones", new GetLocalSonesCommand(core));
228 commands.put("GetSones", new GetSonesCommand(core));
229 commands.put("GetSone", new GetSoneCommand(core));
230 commands.put("GetPost", new GetPostCommand(core));
231 commands.put("GetPosts", new GetPostsCommand(core));
232 commands.put("GetPostFeed", new GetPostFeedCommand(core));
233 commands.put("LockSone", new LockSoneCommand(core));
234 commands.put("UnlockSone", new UnlockSoneCommand(core));
235 commands.put("LikePost", new LikePostCommand(core));
236 commands.put("LikeReply", new LikeReplyCommand(core));
237 commands.put("CreatePost", new CreatePostCommand(core));
238 commands.put("CreateReply", new CreateReplyCommand(core));
239 commands.put("DeletePost", new DeletePostCommand(core));
240 commands.put("DeleteReply", new DeleteReplyCommand(core));