Convert “Sone insert was aborted” into EventBus-based event.
[Sone.git] / src / main / java / net / pterodactylus / sone / fcp / FcpInterface.java
1 /*
2  * Sone - FcpInterface.java - Copyright © 2011–2012 David Roden
3  *
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.
8  *
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.
13  *
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/>.
16  */
17
18 package net.pterodactylus.sone.fcp;
19
20 import java.util.Collections;
21 import java.util.HashMap;
22 import java.util.Map;
23 import java.util.logging.Level;
24 import java.util.logging.Logger;
25
26 import net.pterodactylus.sone.core.Core;
27 import net.pterodactylus.sone.freenet.fcp.Command.AccessType;
28 import net.pterodactylus.sone.freenet.fcp.Command.ErrorResponse;
29 import net.pterodactylus.sone.freenet.fcp.Command.Response;
30 import net.pterodactylus.util.logging.Logging;
31 import net.pterodactylus.util.validation.Validation;
32
33 import com.google.inject.Inject;
34
35 import freenet.pluginmanager.FredPluginFCP;
36 import freenet.pluginmanager.PluginNotFoundException;
37 import freenet.pluginmanager.PluginReplySender;
38 import freenet.support.SimpleFieldSet;
39 import freenet.support.api.Bucket;
40
41 /**
42  * Implementation of an FCP interface for other clients or plugins to
43  * communicate with Sone.
44  *
45  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
46  */
47 public class FcpInterface {
48
49         /**
50          * The action level that full access for the FCP connection is required.
51          *
52          * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
53          */
54         public enum FullAccessRequired {
55
56                 /** No action requires full access. */
57                 NO,
58
59                 /** All writing actions require full access. */
60                 WRITING,
61
62                 /** All actions require full access. */
63                 ALWAYS,
64
65         }
66
67         /** The logger. */
68         private static final Logger logger = Logging.getLogger(FcpInterface.class);
69
70         /** Whether the FCP interface is currently active. */
71         private volatile boolean active;
72
73         /** What function full access is required for. */
74         private volatile FullAccessRequired fullAccessRequired = FullAccessRequired.ALWAYS;
75
76         /** All available FCP commands. */
77         private final Map<String, AbstractSoneCommand> commands = Collections.synchronizedMap(new HashMap<String, AbstractSoneCommand>());
78
79         /**
80          * Creates a new FCP interface.
81          *
82          * @param core
83          *            The core
84          */
85         @Inject
86         public FcpInterface(Core core) {
87                 commands.put("Version", new VersionCommand(core));
88                 commands.put("GetLocalSones", new GetLocalSonesCommand(core));
89                 commands.put("GetSones", new GetSonesCommand(core));
90                 commands.put("GetSone", new GetSoneCommand(core));
91                 commands.put("GetPost", new GetPostCommand(core));
92                 commands.put("GetPosts", new GetPostsCommand(core));
93                 commands.put("GetPostFeed", new GetPostFeedCommand(core));
94                 commands.put("LikePost", new LikePostCommand(core));
95                 commands.put("LikeReply", new LikeReplyCommand(core));
96                 commands.put("CreatePost", new CreatePostCommand(core));
97                 commands.put("CreateReply", new CreateReplyCommand(core));
98                 commands.put("DeletePost", new DeletePostCommand(core));
99                 commands.put("DeleteReply", new DeleteReplyCommand(core));
100         }
101
102         //
103         // ACCESSORS
104         //
105
106         /**
107          * Sets whether the FCP interface should handle requests. If {@code active}
108          * is {@code false}, all requests are answered with an error.
109          *
110          * @param active
111          *            {@code true} to activate the FCP interface, {@code false} to
112          *            deactivate the FCP interface
113          */
114         public void setActive(boolean active) {
115                 this.active = active;
116         }
117
118         /**
119          * Sets the action level for which full FCP access is required.
120          *
121          * @param fullAccessRequired
122          *            The action level for which full FCP access is required
123          */
124         public void setFullAccessRequired(FullAccessRequired fullAccessRequired) {
125                 Validation.begin().isNotNull("FullAccessRequired", fullAccessRequired).check();
126                 this.fullAccessRequired = fullAccessRequired;
127         }
128
129         //
130         // ACTIONS
131         //
132
133         /**
134          * Handles a plugin FCP request.
135          *
136          * @param pluginReplySender
137          *            The reply sender
138          * @param parameters
139          *            The message parameters
140          * @param data
141          *            The message data (may be {@code null})
142          * @param accessType
143          *            One of {@link FredPluginFCP#ACCESS_DIRECT},
144          *            {@link FredPluginFCP#ACCESS_FCP_FULL},
145          *            {@link FredPluginFCP#ACCESS_FCP_RESTRICTED}
146          */
147         public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
148                 if (!active) {
149                         try {
150                                 sendReply(pluginReplySender, null, new ErrorResponse(400, "FCP Interface deactivated"));
151                         } catch (PluginNotFoundException pnfe1) {
152                                 logger.log(Level.FINE, "Could not set error to plugin.", pnfe1);
153                         }
154                         return;
155                 }
156                 AbstractSoneCommand command = commands.get(parameters.get("Message"));
157                 if ((accessType == FredPluginFCP.ACCESS_FCP_RESTRICTED) && (((fullAccessRequired == FullAccessRequired.WRITING) && command.requiresWriteAccess()) || (fullAccessRequired == FullAccessRequired.ALWAYS))) {
158                         try {
159                                 sendReply(pluginReplySender, null, new ErrorResponse(401, "Not authorized"));
160                         } catch (PluginNotFoundException pnfe1) {
161                                 logger.log(Level.FINE, "Could not set error to plugin.", pnfe1);
162                         }
163                         return;
164                 }
165                 try {
166                         if (command == null) {
167                                 sendReply(pluginReplySender, null, new ErrorResponse("Unrecognized Message: " + parameters.get("Message")));
168                                 return;
169                         }
170                         String identifier = parameters.get("Identifier");
171                         if ((identifier == null) || (identifier.length() == 0)) {
172                                 sendReply(pluginReplySender, null, new ErrorResponse("Missing Identifier."));
173                                 return;
174                         }
175                         try {
176                                 Response response = command.execute(parameters, data, AccessType.values()[accessType]);
177                                 sendReply(pluginReplySender, identifier, response);
178                         } catch (Exception e1) {
179                                 logger.log(Level.WARNING, "Could not process FCP command “%s”.", command);
180                                 sendReply(pluginReplySender, identifier, new ErrorResponse("Error executing command: " + e1.getMessage()));
181                         }
182                 } catch (PluginNotFoundException pnfe1) {
183                         logger.log(Level.WARNING, "Could not find destination plugin: " + pluginReplySender);
184                 }
185         }
186
187         //
188         // PRIVATE METHODS
189         //
190
191         /**
192          * Sends the given response to the given plugin.
193          *
194          * @param pluginReplySender
195          *            The reply sender
196          * @param identifier
197          *            The identifier (may be {@code null})
198          * @param response
199          *            The response to send
200          * @throws PluginNotFoundException
201          *             if the plugin can not be found
202          */
203         private static void sendReply(PluginReplySender pluginReplySender, String identifier, Response response) throws PluginNotFoundException {
204                 SimpleFieldSet replyParameters = response.getReplyParameters();
205                 if (identifier != null) {
206                         replyParameters.putOverwrite("Identifier", identifier);
207                 }
208                 if (response.hasData()) {
209                         pluginReplySender.send(replyParameters, response.getData());
210                 } else if (response.hasBucket()) {
211                         pluginReplySender.send(replyParameters, response.getBucket());
212                 } else {
213                         pluginReplySender.send(replyParameters);
214                 }
215         }
216
217 }