Add unit test for sone template page and fix parameter encoding
[Sone.git] / src / main / java / net / pterodactylus / sone / main / SonePlugin.java
1 /*
2  * Sone - SonePlugin.java - Copyright © 2010–2016 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.main;
19
20 import static com.google.common.base.Optional.of;
21 import static java.util.logging.Logger.getLogger;
22
23 import java.io.File;
24 import java.util.logging.Handler;
25 import java.util.logging.Level;
26 import java.util.logging.LogRecord;
27 import java.util.logging.Logger;
28
29 import net.pterodactylus.sone.core.Core;
30 import net.pterodactylus.sone.fcp.FcpInterface;
31 import net.pterodactylus.sone.freenet.PluginStoreConfigurationBackend;
32 import net.pterodactylus.sone.freenet.wot.Context;
33 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
34 import net.pterodactylus.sone.web.WebInterface;
35 import net.pterodactylus.util.config.Configuration;
36 import net.pterodactylus.util.config.ConfigurationException;
37 import net.pterodactylus.util.config.MapConfigurationBackend;
38 import net.pterodactylus.util.version.Version;
39
40 import com.google.common.base.Optional;
41 import com.google.common.cache.CacheBuilder;
42 import com.google.common.cache.CacheLoader;
43 import com.google.common.cache.LoadingCache;
44 import com.google.common.eventbus.EventBus;
45 import com.google.inject.AbstractModule;
46 import com.google.inject.Guice;
47 import com.google.inject.Injector;
48 import com.google.inject.TypeLiteral;
49 import com.google.inject.matcher.Matchers;
50 import com.google.inject.spi.InjectionListener;
51 import com.google.inject.spi.TypeEncounter;
52 import com.google.inject.spi.TypeListener;
53
54 import freenet.client.async.PersistenceDisabledException;
55 import freenet.l10n.BaseL10n.LANGUAGE;
56 import freenet.l10n.PluginL10n;
57 import freenet.node.Node;
58 import freenet.pluginmanager.FredPlugin;
59 import freenet.pluginmanager.FredPluginBaseL10n;
60 import freenet.pluginmanager.FredPluginFCP;
61 import freenet.pluginmanager.FredPluginL10n;
62 import freenet.pluginmanager.FredPluginThreadless;
63 import freenet.pluginmanager.FredPluginVersioned;
64 import freenet.pluginmanager.PluginReplySender;
65 import freenet.pluginmanager.PluginRespirator;
66 import freenet.support.SimpleFieldSet;
67 import freenet.support.api.Bucket;
68
69 /**
70  * This class interfaces with Freenet. It is the class that is loaded by the
71  * node and starts up the whole Sone system.
72  *
73  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
74  */
75 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
76
77         private static final Logger soneLogger = getLogger("net.pterodactylus.sone");
78
79         static {
80                 /* initialize logging. */
81                 soneLogger.setUseParentHandlers(false);
82                 soneLogger.addHandler(new Handler() {
83                         private final LoadingCache<String, Class<?>> classCache = CacheBuilder.newBuilder()
84                                         .build(new CacheLoader<String, Class<?>>() {
85                                                 @Override
86                                                 public Class<?> load(String key) throws Exception {
87                                                         return Class.forName(key);
88                                                 }
89                                         });
90
91                         @Override
92                         public void publish(LogRecord logRecord) {
93                                 int recordLevel = logRecord.getLevel().intValue();
94                                 Class<?> loggingClass = classCache.getUnchecked(logRecord.getLoggerName());
95                                 if (recordLevel < Level.FINE.intValue()) {
96                                         freenet.support.Logger.debug(loggingClass, logRecord.getMessage(), logRecord.getThrown());
97                                 } else if (recordLevel < Level.INFO.intValue()) {
98                                         freenet.support.Logger.minor(loggingClass, logRecord.getMessage(), logRecord.getThrown());
99                                 } else if (recordLevel < Level.WARNING.intValue()) {
100                                         freenet.support.Logger.normal(loggingClass, logRecord.getMessage(), logRecord.getThrown());
101                                 } else if (recordLevel < Level.SEVERE.intValue()) {
102                                         freenet.support.Logger.warning(loggingClass, logRecord.getMessage(), logRecord.getThrown());
103                                 } else {
104                                         freenet.support.Logger.error(loggingClass, logRecord.getMessage(), logRecord.getThrown());
105                                 }
106                         }
107
108                         @Override
109                         public void flush() {
110                         }
111
112                         @Override
113                         public void close() {
114                         }
115                 });
116         }
117
118         /** The version. */
119         private static final Version VERSION = new Version(0, 9, 6);
120
121         /** The current year at time of release. */
122         private static final int YEAR = 2016;
123         private static final String SONE_HOMEPAGE = "USK@nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI,DuQSUZiI~agF8c-6tjsFFGuZ8eICrzWCILB60nT8KKo,AQACAAE/sone/";
124         private static final int LATEST_EDITION = 73;
125
126         /** The logger. */
127         private static final Logger logger = getLogger(SonePlugin.class.getName());
128
129         /** The plugin respirator. */
130         private PluginRespirator pluginRespirator;
131
132         /** The core. */
133         private Core core;
134
135         /** The web interface. */
136         private WebInterface webInterface;
137
138         /** The FCP interface. */
139         private FcpInterface fcpInterface;
140
141         /** The l10n helper. */
142         private PluginL10n l10n;
143
144         /** The web of trust connector. */
145         private WebOfTrustConnector webOfTrustConnector;
146
147         //
148         // ACCESSORS
149         //
150
151         /**
152          * Returns the plugin respirator for this plugin.
153          *
154          * @return The plugin respirator
155          */
156         public PluginRespirator pluginRespirator() {
157                 return pluginRespirator;
158         }
159
160         /**
161          * Returns the core started by this plugin.
162          *
163          * @return The core
164          */
165         public Core core() {
166                 return core;
167         }
168
169         /**
170          * Returns the plugin’s l10n helper.
171          *
172          * @return The plugin’s l10n helper
173          */
174         public PluginL10n l10n() {
175                 return l10n;
176         }
177
178         public static String getPluginVersion() {
179                 return VERSION.toString();
180         }
181
182         public static int getYear() {
183                 return YEAR;
184         }
185
186         public static String getHomepage() {
187                 return SONE_HOMEPAGE + LATEST_EDITION;
188         }
189
190         public static long getLatestEdition() {
191                 return LATEST_EDITION;
192         }
193
194         //
195         // FREDPLUGIN METHODS
196         //
197
198         /**
199          * {@inheritDoc}
200          */
201         @Override
202         public void runPlugin(PluginRespirator pluginRespirator) {
203                 this.pluginRespirator = pluginRespirator;
204
205                 /* create a configuration. */
206                 Configuration oldConfiguration;
207                 Configuration newConfiguration = null;
208                 boolean firstStart = !new File("sone.properties").exists();
209                 boolean newConfig = false;
210                 try {
211                         oldConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), false));
212                         newConfiguration = oldConfiguration;
213                 } catch (ConfigurationException ce1) {
214                         newConfig = true;
215                         logger.log(Level.INFO, "Could not load configuration file, trying plugin store…", ce1);
216                         try {
217                                 newConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), true));
218                                 logger.log(Level.INFO, "Created new configuration file.");
219                         } catch (ConfigurationException ce2) {
220                                 logger.log(Level.SEVERE, "Could not create configuration file, using Plugin Store!", ce2);
221                         }
222                         try {
223                                 oldConfiguration = new Configuration(new PluginStoreConfigurationBackend(pluginRespirator));
224                                 logger.log(Level.INFO, "Plugin store loaded.");
225                         } catch (PersistenceDisabledException pde1) {
226                                 logger.log(Level.SEVERE, "Could not load any configuration, using empty configuration!");
227                                 oldConfiguration = new Configuration(new MapConfigurationBackend());
228                         }
229                 }
230
231                 final Configuration startConfiguration;
232                 if ((newConfiguration != null) && (oldConfiguration != newConfiguration)) {
233                         logger.log(Level.INFO, "Setting configuration to file-based configuration.");
234                         startConfiguration = newConfiguration;
235                 } else {
236                         startConfiguration = oldConfiguration;
237                 }
238                 final EventBus eventBus = new EventBus();
239
240                 /* Freenet injector configuration. */
241                 AbstractModule freenetModule = new AbstractModule() {
242
243                         @Override
244                         @SuppressWarnings("synthetic-access")
245                         protected void configure() {
246                                 bind(PluginRespirator.class).toInstance(SonePlugin.this.pluginRespirator);
247                                 bind(Node.class).toInstance(SonePlugin.this.pluginRespirator.getNode());
248                         }
249                 };
250                 /* Sone injector configuration. */
251                 AbstractModule soneModule = new AbstractModule() {
252
253                         @Override
254                         protected void configure() {
255                                 bind(EventBus.class).toInstance(eventBus);
256                                 bind(Configuration.class).toInstance(startConfiguration);
257                                 Context context = new Context("Sone");
258                                 bind(Context.class).toInstance(context);
259                                 bind(getOptionalContextTypeLiteral()).toInstance(of(context));
260                                 bind(SonePlugin.class).toInstance(SonePlugin.this);
261                                 bind(Version.class).toInstance(VERSION);
262                                 if (startConfiguration.getBooleanValue("Developer.LoadFromFilesystem").getValue(false)) {
263                                         String path = startConfiguration.getStringValue("Developer.FilesystemPath").getValue(null);
264                                         if (path != null) {
265                                                 bind(Loaders.class).toInstance(new DebugLoaders(path));
266                                         }
267                                 }
268                                 bindListener(Matchers.any(), new TypeListener() {
269
270                                         @Override
271                                         public <I> void hear(TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEncounter) {
272                                                 typeEncounter.register(new InjectionListener<I>() {
273
274                                                         @Override
275                                                         public void afterInjection(I injectee) {
276                                                                 eventBus.register(injectee);
277                                                         }
278                                                 });
279                                         }
280                                 });
281                         }
282
283                         private TypeLiteral<Optional<Context>> getOptionalContextTypeLiteral() {
284                                 return new TypeLiteral<Optional<Context>>() {
285                                 };
286                         }
287
288                 };
289                 Injector injector = Guice.createInjector(freenetModule, soneModule);
290                 core = injector.getInstance(Core.class);
291
292                 /* create web of trust connector. */
293                 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
294
295                 /* create FCP interface. */
296                 fcpInterface = injector.getInstance(FcpInterface.class);
297
298                 /* create the web interface. */
299                 webInterface = injector.getInstance(WebInterface.class);
300
301                 /* start core! */
302                 core.start();
303                 webInterface.start();
304                 webInterface.setFirstStart(firstStart);
305                 webInterface.setNewConfig(newConfig);
306         }
307
308         /**
309          * {@inheritDoc}
310          */
311         @Override
312         public void terminate() {
313                 try {
314                         /* stop the web interface. */
315                         webInterface.stop();
316
317                         /* stop the core. */
318                         core.stop();
319
320                         /* stop the web of trust connector. */
321                         webOfTrustConnector.stop();
322                 } catch (Throwable t1) {
323                         logger.log(Level.SEVERE, "Error while shutting down!", t1);
324                 } finally {
325                         deregisterLoggerHandlers();
326                 }
327         }
328
329         private void deregisterLoggerHandlers() {
330                 for (Handler handler : soneLogger.getHandlers()) {
331                         soneLogger.removeHandler(handler);
332                 }
333         }
334
335         //
336         // INTERFACE FredPluginFCP
337         //
338
339         /**
340          * {@inheritDoc}
341          */
342         @Override
343         public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
344                 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
345         }
346
347         //
348         // INTERFACE FredPluginL10n
349         //
350
351         /**
352          * {@inheritDoc}
353          */
354         @Override
355         public String getString(String key) {
356                 return l10n.getBase().getString(key);
357         }
358
359         /**
360          * {@inheritDoc}
361          */
362         @Override
363         public void setLanguage(LANGUAGE newLanguage) {
364                 l10n = new PluginL10n(this, newLanguage);
365         }
366
367         //
368         // INTERFACE FredPluginBaseL10n
369         //
370
371         /**
372          * {@inheritDoc}
373          */
374         @Override
375         public String getL10nFilesBasePath() {
376                 return "i18n";
377         }
378
379         /**
380          * {@inheritDoc}
381          */
382         @Override
383         public String getL10nFilesMask() {
384                 return "sone.${lang}.properties";
385         }
386
387         /**
388          * {@inheritDoc}
389          */
390         @Override
391         public String getL10nOverrideFilesMask() {
392                 return "sone.${lang}.override.properties";
393         }
394
395         /**
396          * {@inheritDoc}
397          */
398         @Override
399         public ClassLoader getPluginClassLoader() {
400                 return SonePlugin.class.getClassLoader();
401         }
402
403         //
404         // INTERFACE FredPluginVersioned
405         //
406
407         /**
408          * {@inheritDoc}
409          */
410         @Override
411         public String getVersion() {
412                 return VERSION.toString();
413         }
414
415 }