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