2 * Sone - SonePlugin.java - Copyright © 2010–2013 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.main;
20 import static com.google.common.base.Optional.of;
23 import java.util.logging.Level;
24 import java.util.logging.LogRecord;
25 import java.util.logging.Logger;
27 import net.pterodactylus.sone.core.Core;
28 import net.pterodactylus.sone.core.FreenetInterface;
29 import net.pterodactylus.sone.core.WebOfTrustUpdater;
30 import net.pterodactylus.sone.core.WebOfTrustUpdaterImpl;
31 import net.pterodactylus.sone.database.Database;
32 import net.pterodactylus.sone.database.PostBuilderFactory;
33 import net.pterodactylus.sone.database.PostProvider;
34 import net.pterodactylus.sone.database.PostReplyBuilderFactory;
35 import net.pterodactylus.sone.database.SoneProvider;
36 import net.pterodactylus.sone.database.memory.MemoryDatabase;
37 import net.pterodactylus.sone.fcp.FcpInterface;
38 import net.pterodactylus.sone.freenet.PluginStoreConfigurationBackend;
39 import net.pterodactylus.sone.freenet.plugin.PluginConnector;
40 import net.pterodactylus.sone.freenet.wot.Context;
41 import net.pterodactylus.sone.freenet.wot.IdentityManager;
42 import net.pterodactylus.sone.freenet.wot.IdentityManagerImpl;
43 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
44 import net.pterodactylus.sone.web.WebInterface;
45 import net.pterodactylus.util.config.Configuration;
46 import net.pterodactylus.util.config.ConfigurationException;
47 import net.pterodactylus.util.config.MapConfigurationBackend;
48 import net.pterodactylus.util.logging.Logging;
49 import net.pterodactylus.util.logging.LoggingListener;
50 import net.pterodactylus.util.version.Version;
52 import com.google.common.base.Optional;
53 import com.google.common.eventbus.EventBus;
54 import com.google.inject.AbstractModule;
55 import com.google.inject.Guice;
56 import com.google.inject.Injector;
57 import com.google.inject.Singleton;
58 import com.google.inject.TypeLiteral;
59 import com.google.inject.matcher.Matchers;
60 import com.google.inject.spi.InjectionListener;
61 import com.google.inject.spi.TypeEncounter;
62 import com.google.inject.spi.TypeListener;
64 import freenet.client.async.DatabaseDisabledException;
65 import freenet.l10n.BaseL10n.LANGUAGE;
66 import freenet.l10n.PluginL10n;
67 import freenet.node.Node;
68 import freenet.pluginmanager.FredPlugin;
69 import freenet.pluginmanager.FredPluginBaseL10n;
70 import freenet.pluginmanager.FredPluginFCP;
71 import freenet.pluginmanager.FredPluginL10n;
72 import freenet.pluginmanager.FredPluginThreadless;
73 import freenet.pluginmanager.FredPluginVersioned;
74 import freenet.pluginmanager.PluginReplySender;
75 import freenet.pluginmanager.PluginRespirator;
76 import freenet.support.SimpleFieldSet;
77 import freenet.support.api.Bucket;
80 * This class interfaces with Freenet. It is the class that is loaded by the
81 * node and starts up the whole Sone system.
83 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
85 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
88 /* initialize logging. */
89 Logging.setup("sone");
90 Logging.addLoggingListener(new LoggingListener() {
93 public void logged(LogRecord logRecord) {
94 Class<?> loggerClass = Logging.getLoggerClass(logRecord.getLoggerName());
95 int recordLevel = logRecord.getLevel().intValue();
96 if (recordLevel < Level.FINE.intValue()) {
97 freenet.support.Logger.debug(loggerClass, logRecord.getMessage(), logRecord.getThrown());
98 } else if (recordLevel < Level.INFO.intValue()) {
99 freenet.support.Logger.minor(loggerClass, logRecord.getMessage(), logRecord.getThrown());
100 } else if (recordLevel < Level.WARNING.intValue()) {
101 freenet.support.Logger.normal(loggerClass, logRecord.getMessage(), logRecord.getThrown());
102 } else if (recordLevel < Level.SEVERE.intValue()) {
103 freenet.support.Logger.warning(loggerClass, logRecord.getMessage(), logRecord.getThrown());
105 freenet.support.Logger.error(loggerClass, logRecord.getMessage(), logRecord.getThrown());
112 public static final Version VERSION = new Version(0, 8, 9);
115 private static final Logger logger = Logging.getLogger(SonePlugin.class);
117 /** The plugin respirator. */
118 private PluginRespirator pluginRespirator;
123 /** The web interface. */
124 private WebInterface webInterface;
126 /** The FCP interface. */
127 private FcpInterface fcpInterface;
129 /** The l10n helper. */
130 private PluginL10n l10n;
132 /** The web of trust connector. */
133 private WebOfTrustConnector webOfTrustConnector;
140 * Returns the plugin respirator for this plugin.
142 * @return The plugin respirator
144 public PluginRespirator pluginRespirator() {
145 return pluginRespirator;
149 * Returns the core started by this plugin.
158 * Returns the plugin’s l10n helper.
160 * @return The plugin’s l10n helper
162 public PluginL10n l10n() {
167 // FREDPLUGIN METHODS
174 public void runPlugin(PluginRespirator pluginRespirator) {
175 this.pluginRespirator = pluginRespirator;
177 /* create a configuration. */
178 Configuration oldConfiguration;
179 Configuration newConfiguration = null;
180 boolean firstStart = !new File("sone.properties").exists();
181 boolean newConfig = false;
183 oldConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), false));
184 newConfiguration = oldConfiguration;
185 } catch (ConfigurationException ce1) {
187 logger.log(Level.INFO, "Could not load configuration file, trying plugin store…", ce1);
189 newConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), true));
190 logger.log(Level.INFO, "Created new configuration file.");
191 } catch (ConfigurationException ce2) {
192 logger.log(Level.SEVERE, "Could not create configuration file, using Plugin Store!", ce2);
195 oldConfiguration = new Configuration(new PluginStoreConfigurationBackend(pluginRespirator));
196 logger.log(Level.INFO, "Plugin store loaded.");
197 } catch (DatabaseDisabledException dde1) {
198 logger.log(Level.SEVERE, "Could not load any configuration, using empty configuration!");
199 oldConfiguration = new Configuration(new MapConfigurationBackend());
203 final Configuration startConfiguration;
204 if ((newConfiguration != null) && (oldConfiguration != newConfiguration)) {
205 logger.log(Level.INFO, "Setting configuration to file-based configuration.");
206 startConfiguration = newConfiguration;
208 startConfiguration = oldConfiguration;
210 final EventBus eventBus = new EventBus();
212 /* Freenet injector configuration. */
213 AbstractModule freenetModule = new AbstractModule() {
216 @SuppressWarnings("synthetic-access")
217 protected void configure() {
218 bind(PluginRespirator.class).toInstance(SonePlugin.this.pluginRespirator);
219 bind(Node.class).toInstance(SonePlugin.this.pluginRespirator.getNode());
222 /* Sone injector configuration. */
223 AbstractModule soneModule = new AbstractModule() {
226 protected void configure() {
227 bind(EventBus.class).toInstance(eventBus);
228 bind(Configuration.class).toInstance(startConfiguration);
229 Context context = new Context("Sone");
230 bind(Context.class).toInstance(context);
231 bind(getOptionalContextTypeLiteral()).toInstance(of(context));
232 bind(SonePlugin.class).toInstance(SonePlugin.this);
233 bindListener(Matchers.any(), new TypeListener() {
236 public <I> void hear(TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEncounter) {
237 typeEncounter.register(new InjectionListener<I>() {
240 public void afterInjection(I injectee) {
241 eventBus.register(injectee);
248 private TypeLiteral<Optional<Context>> getOptionalContextTypeLiteral() {
249 return new TypeLiteral<Optional<Context>>() {
254 Injector injector = Guice.createInjector(freenetModule, soneModule);
255 core = injector.getInstance(Core.class);
257 /* create web of trust connector. */
258 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
260 /* create FCP interface. */
261 fcpInterface = injector.getInstance(FcpInterface.class);
262 core.setFcpInterface(fcpInterface);
264 /* create the web interface. */
265 webInterface = injector.getInstance(WebInterface.class);
267 boolean startupFailed = true;
272 webInterface.start();
273 webInterface.setFirstStart(firstStart);
274 webInterface.setNewConfig(newConfig);
275 startupFailed = false;
279 * we let the exception bubble up but shut the logging down so
280 * that the logfile is not swamped by the installed logging
281 * handlers of the failed instances.
292 public void terminate() {
294 /* stop the web interface. */
300 /* stop the web of trust connector. */
301 webOfTrustConnector.stop();
302 } catch (Throwable t1) {
303 logger.log(Level.SEVERE, "Error while shutting down!", t1);
305 /* shutdown logger. */
311 // INTERFACE FredPluginFCP
318 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
319 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
323 // INTERFACE FredPluginL10n
330 public String getString(String key) {
331 return l10n.getBase().getString(key);
338 public void setLanguage(LANGUAGE newLanguage) {
339 l10n = new PluginL10n(this, newLanguage);
343 // INTERFACE FredPluginBaseL10n
350 public String getL10nFilesBasePath() {
358 public String getL10nFilesMask() {
359 return "sone.${lang}.properties";
366 public String getL10nOverrideFilesMask() {
367 return "sone.${lang}.override.properties";
374 public ClassLoader getPluginClassLoader() {
375 return SonePlugin.class.getClassLoader();
379 // INTERFACE FredPluginVersioned
386 public String getVersion() {
387 return VERSION.toString();