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;
22 import static net.pterodactylus.sone.fcp.FcpInterface.FullAccessRequired.NO;
23 import static net.pterodactylus.sone.fcp.FcpInterface.FullAccessRequired.WRITING;
24 import static net.pterodactylus.sone.freenet.fcp.Command.AccessType.RESTRICTED_FCP;
26 import java.util.HashMap;
28 import java.util.concurrent.atomic.AtomicBoolean;
29 import java.util.concurrent.atomic.AtomicReference;
30 import java.util.logging.Level;
31 import java.util.logging.Logger;
33 import javax.annotation.Nonnull;
34 import javax.inject.Singleton;
36 import net.pterodactylus.sone.core.Core;
37 import net.pterodactylus.sone.fcp.event.FcpInterfaceActivatedEvent;
38 import net.pterodactylus.sone.fcp.event.FcpInterfaceDeactivatedEvent;
39 import net.pterodactylus.sone.fcp.event.FullAccessRequiredChanged;
40 import net.pterodactylus.sone.freenet.fcp.Command.AccessType;
41 import net.pterodactylus.sone.freenet.fcp.Command.ErrorResponse;
42 import net.pterodactylus.sone.freenet.fcp.Command.Response;
44 import freenet.pluginmanager.FredPluginFCP;
45 import freenet.pluginmanager.PluginNotFoundException;
46 import freenet.pluginmanager.PluginReplySender;
47 import freenet.support.SimpleFieldSet;
48 import freenet.support.api.Bucket;
50 import com.google.common.annotations.VisibleForTesting;
51 import com.google.common.eventbus.Subscribe;
52 import com.google.inject.Inject;
55 * Implementation of an FCP interface for other clients or plugins to
56 * communicate with Sone.
58 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
61 public class FcpInterface {
64 * The action level that full access for the FCP connection is required.
66 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
68 public enum FullAccessRequired {
70 /** No action requires full access. */
73 /** All writing actions require full access. */
76 /** All actions require full access. */
82 private static final Logger logger = getLogger(FcpInterface.class.getName());
84 /** Whether the FCP interface is currently active. */
85 private final AtomicBoolean active = new AtomicBoolean();
87 /** What function full access is required for. */
88 private final AtomicReference<FullAccessRequired> fullAccessRequired = new AtomicReference<FullAccessRequired>(FullAccessRequired.ALWAYS);
90 /** All available FCP commands. */
91 private final Map<String, AbstractSoneCommand> commands;
92 private final AccessAuthorizer accessAuthorizer;
95 * Creates a new FCP interface.
101 public FcpInterface(Core core, CommandSupplier commandSupplier, AccessAuthorizer accessAuthorizer) {
102 commands = commandSupplier.supplyCommands(core);
103 this.accessAuthorizer = accessAuthorizer;
115 private void setActive(boolean active) {
116 this.active.set(active);
120 FullAccessRequired getFullAccessRequired() {
121 return fullAccessRequired.get();
124 private void setFullAccessRequired(FullAccessRequired fullAccessRequired) {
125 this.fullAccessRequired.set(checkNotNull(fullAccessRequired, "fullAccessRequired must not be null"));
133 * Handles a plugin FCP request.
135 * @param pluginReplySender
138 * The message parameters
140 * The message data (may be {@code null})
142 * One of {@link FredPluginFCP#ACCESS_DIRECT},
143 * {@link FredPluginFCP#ACCESS_FCP_FULL},
144 * {@link FredPluginFCP#ACCESS_FCP_RESTRICTED}
146 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
147 String identifier = parameters.get("Identifier");
148 if ((identifier == null) || (identifier.length() == 0)) {
149 sendErrorReply(pluginReplySender, null, 400, "Missing Identifier.");
153 sendErrorReply(pluginReplySender, identifier, 503, "FCP Interface deactivated");
156 AbstractSoneCommand command = commands.get(parameters.get("Message"));
157 if (command == null) {
158 sendErrorReply(pluginReplySender, identifier, 404, "Unrecognized Message: " + parameters.get("Message"));
161 if (!accessAuthorizer.authorized(AccessType.values()[accessType], fullAccessRequired.get(), command.requiresWriteAccess())) {
162 sendErrorReply(pluginReplySender, identifier, 401, "Not authorized");
166 Response response = command.execute(parameters);
167 sendReply(pluginReplySender, identifier, response);
168 } catch (Exception e1) {
169 logger.log(Level.WARNING, "Could not process FCP command “%s”.", command);
170 sendErrorReply(pluginReplySender, identifier, 500, "Error executing command: " + e1.getMessage());
174 private void sendErrorReply(PluginReplySender pluginReplySender, String identifier, int errorCode, String message) {
176 sendReply(pluginReplySender, identifier, new ErrorResponse(errorCode, message));
177 } catch (PluginNotFoundException pnfe1) {
178 logger.log(Level.FINE, "Could not send error to plugin.", pnfe1);
187 * Sends the given response to the given plugin.
189 * @param pluginReplySender
192 * The identifier (may be {@code null})
194 * The response to send
195 * @throws PluginNotFoundException
196 * if the plugin can not be found
198 private static void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException {
199 SimpleFieldSet replyParameters = response.getReplyParameters();
200 if (identifier != null) {
201 replyParameters.putOverwrite("Identifier", identifier);
203 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));
247 public static class AccessAuthorizer {
249 public boolean authorized(@Nonnull AccessType accessType, @Nonnull FullAccessRequired fullAccessRequired, boolean commandRequiresWriteAccess) {
250 return (accessType != RESTRICTED_FCP) || (fullAccessRequired == NO) || ((fullAccessRequired == WRITING) && !commandRequiresWriteAccess);