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