2 * Sone - FcpInterface.java - Copyright © 2011 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 java.util.Collections;
21 import java.util.HashMap;
24 import net.pterodactylus.sone.core.Core;
25 import net.pterodactylus.sone.freenet.fcp.Command;
26 import net.pterodactylus.sone.freenet.fcp.FcpException;
27 import net.pterodactylus.sone.freenet.fcp.Command.AccessType;
28 import net.pterodactylus.sone.freenet.fcp.Command.Reply;
29 import freenet.pluginmanager.FredPluginFCP;
30 import freenet.pluginmanager.PluginNotFoundException;
31 import freenet.pluginmanager.PluginReplySender;
32 import freenet.support.SimpleFieldSet;
33 import freenet.support.api.Bucket;
36 * Implementation of an FCP interface for other clients or plugins to
37 * communicate with Sone.
39 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
41 public class FcpInterface {
43 /** All available FCP commands. */
44 private final Map<String, Command> commands = Collections.synchronizedMap(new HashMap<String, Command>());
47 * Creates a new FCP interface.
52 public FcpInterface(Core core) {
53 commands.put("Version", new VersionCommand());
54 commands.put("GetPostFeed", new GetPostFeedCommand(core));
58 * Handles a plugin FCP request.
60 * @param pluginReplySender
63 * The message parameters
65 * The message data (may be {@code null})
67 * One of {@link FredPluginFCP#ACCESS_DIRECT},
68 * {@link FredPluginFCP#ACCESS_FCP_FULL},
69 * {@link FredPluginFCP#ACCESS_FCP_RESTRICTED}
71 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
72 Command command = commands.get(parameters.get("Message"));
73 if (command == null) {
74 /* TODO - return error? */
77 String identifier = parameters.get("Identifier");
78 if ((identifier == null) || (identifier.length() == 0)) {
79 /* TODO - return error? */
83 Reply reply = command.execute(parameters, data, AccessType.values()[accessType]);
84 SimpleFieldSet replyParameters = reply.getReplyParameters();
85 replyParameters.putOverwrite("Identifier", identifier);
86 if (reply.hasData()) {
87 pluginReplySender.send(replyParameters, reply.getData());
88 } else if (reply.hasBucket()) {
89 pluginReplySender.send(replyParameters, reply.getBucket());
91 pluginReplySender.send(replyParameters);
93 } catch (FcpException fe1) {
94 /* TODO - log, report */
95 } catch (PluginNotFoundException pnfe1) {