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;
21 import java.util.logging.Level;
22 import java.util.logging.LogRecord;
23 import java.util.logging.Logger;
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.data.impl.DefaultPostBuilderFactory;
29 import net.pterodactylus.sone.data.impl.DefaultPostReplyBuilderFactory;
30 import net.pterodactylus.sone.database.PostBuilderFactory;
31 import net.pterodactylus.sone.database.PostDatabase;
32 import net.pterodactylus.sone.database.PostProvider;
33 import net.pterodactylus.sone.database.PostReplyBuilderFactory;
34 import net.pterodactylus.sone.database.SoneProvider;
35 import net.pterodactylus.sone.database.memory.MemoryPostDatabase;
36 import net.pterodactylus.sone.fcp.FcpInterface;
37 import net.pterodactylus.sone.freenet.PluginStoreConfigurationBackend;
38 import net.pterodactylus.sone.freenet.plugin.PluginConnector;
39 import net.pterodactylus.sone.freenet.wot.IdentityManager;
40 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
41 import net.pterodactylus.sone.web.WebInterface;
42 import net.pterodactylus.util.config.Configuration;
43 import net.pterodactylus.util.config.ConfigurationException;
44 import net.pterodactylus.util.config.MapConfigurationBackend;
45 import net.pterodactylus.util.logging.Logging;
46 import net.pterodactylus.util.logging.LoggingListener;
47 import net.pterodactylus.util.version.Version;
49 import com.google.common.eventbus.EventBus;
50 import com.google.inject.AbstractModule;
51 import com.google.inject.Guice;
52 import com.google.inject.Injector;
53 import com.google.inject.Singleton;
54 import com.google.inject.TypeLiteral;
55 import com.google.inject.matcher.Matchers;
56 import com.google.inject.name.Names;
57 import com.google.inject.spi.InjectionListener;
58 import com.google.inject.spi.TypeEncounter;
59 import com.google.inject.spi.TypeListener;
61 import freenet.client.async.DatabaseDisabledException;
62 import freenet.l10n.BaseL10n.LANGUAGE;
63 import freenet.l10n.PluginL10n;
64 import freenet.node.Node;
65 import freenet.pluginmanager.FredPlugin;
66 import freenet.pluginmanager.FredPluginBaseL10n;
67 import freenet.pluginmanager.FredPluginFCP;
68 import freenet.pluginmanager.FredPluginL10n;
69 import freenet.pluginmanager.FredPluginThreadless;
70 import freenet.pluginmanager.FredPluginVersioned;
71 import freenet.pluginmanager.PluginReplySender;
72 import freenet.pluginmanager.PluginRespirator;
73 import freenet.support.SimpleFieldSet;
74 import freenet.support.api.Bucket;
77 * This class interfaces with Freenet. It is the class that is loaded by the
78 * node and starts up the whole Sone system.
80 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
82 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
85 /* initialize logging. */
86 Logging.setup("sone");
87 Logging.addLoggingListener(new LoggingListener() {
90 public void logged(LogRecord logRecord) {
91 Class<?> loggerClass = Logging.getLoggerClass(logRecord.getLoggerName());
92 int recordLevel = logRecord.getLevel().intValue();
93 if (recordLevel < Level.FINE.intValue()) {
94 freenet.support.Logger.debug(loggerClass, logRecord.getMessage(), logRecord.getThrown());
95 } else if (recordLevel < Level.INFO.intValue()) {
96 freenet.support.Logger.minor(loggerClass, logRecord.getMessage(), logRecord.getThrown());
97 } else if (recordLevel < Level.WARNING.intValue()) {
98 freenet.support.Logger.normal(loggerClass, logRecord.getMessage(), logRecord.getThrown());
99 } else if (recordLevel < Level.SEVERE.intValue()) {
100 freenet.support.Logger.warning(loggerClass, logRecord.getMessage(), logRecord.getThrown());
102 freenet.support.Logger.error(loggerClass, logRecord.getMessage(), logRecord.getThrown());
109 public static final Version VERSION = new Version(0, 8, 4);
112 private static final Logger logger = Logging.getLogger(SonePlugin.class);
114 /** The plugin respirator. */
115 private PluginRespirator pluginRespirator;
120 /** The web interface. */
121 private WebInterface webInterface;
123 /** The FCP interface. */
124 private FcpInterface fcpInterface;
126 /** The l10n helper. */
127 private PluginL10n l10n;
129 /** The web of trust connector. */
130 private WebOfTrustConnector webOfTrustConnector;
137 * Returns the plugin respirator for this plugin.
139 * @return The plugin respirator
141 public PluginRespirator pluginRespirator() {
142 return pluginRespirator;
146 * Returns the core started by this plugin.
155 * Returns the plugin’s l10n helper.
157 * @return The plugin’s l10n helper
159 public PluginL10n l10n() {
164 // FREDPLUGIN METHODS
171 public void runPlugin(PluginRespirator pluginRespirator) {
172 this.pluginRespirator = pluginRespirator;
174 /* create a configuration. */
175 Configuration oldConfiguration;
176 Configuration newConfiguration = null;
177 boolean firstStart = !new File("sone.properties").exists();
178 boolean newConfig = false;
180 oldConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), false));
181 newConfiguration = oldConfiguration;
182 } catch (ConfigurationException ce1) {
184 logger.log(Level.INFO, "Could not load configuration file, trying plugin store…", ce1);
186 newConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), true));
187 logger.log(Level.INFO, "Created new configuration file.");
188 } catch (ConfigurationException ce2) {
189 logger.log(Level.SEVERE, "Could not create configuration file, using Plugin Store!", ce2);
192 oldConfiguration = new Configuration(new PluginStoreConfigurationBackend(pluginRespirator));
193 logger.log(Level.INFO, "Plugin store loaded.");
194 } catch (DatabaseDisabledException dde1) {
195 logger.log(Level.SEVERE, "Could not load any configuration, using empty configuration!");
196 oldConfiguration = new Configuration(new MapConfigurationBackend());
200 final Configuration startConfiguration = oldConfiguration;
201 final EventBus eventBus = new EventBus();
203 /* Freenet injector configuration. */
204 AbstractModule freenetModule = new AbstractModule() {
207 @SuppressWarnings("synthetic-access")
208 protected void configure() {
209 bind(PluginRespirator.class).toInstance(SonePlugin.this.pluginRespirator);
210 bind(Node.class).toInstance(SonePlugin.this.pluginRespirator.getNode());
213 /* Sone injector configuration. */
214 AbstractModule soneModule = new AbstractModule() {
217 protected void configure() {
218 bind(Core.class).in(Singleton.class);
219 bind(MemoryPostDatabase.class).in(Singleton.class);
220 bind(EventBus.class).toInstance(eventBus);
221 bind(Configuration.class).toInstance(startConfiguration);
222 bind(FreenetInterface.class).in(Singleton.class);
223 bind(PluginConnector.class).in(Singleton.class);
224 bind(WebOfTrustConnector.class).in(Singleton.class);
225 bind(WebOfTrustUpdater.class).in(Singleton.class);
226 bind(IdentityManager.class).in(Singleton.class);
227 bind(String.class).annotatedWith(Names.named("WebOfTrustContext")).toInstance("Sone");
228 bind(SonePlugin.class).toInstance(SonePlugin.this);
229 bind(FcpInterface.class).in(Singleton.class);
230 bind(PostDatabase.class).to(MemoryPostDatabase.class);
231 bind(PostBuilderFactory.class).to(MemoryPostDatabase.class);
232 bind(PostReplyBuilderFactory.class).to(DefaultPostReplyBuilderFactory.class).in(Singleton.class);
233 bind(SoneProvider.class).to(Core.class).in(Singleton.class);
234 bind(PostProvider.class).to(MemoryPostDatabase.class);
235 bindListener(Matchers.any(), new TypeListener() {
238 public <I> void hear(TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEncounter) {
239 typeEncounter.register(new InjectionListener<I>() {
242 public void afterInjection(I injectee) {
243 eventBus.register(injectee);
251 Injector injector = Guice.createInjector(freenetModule, soneModule);
252 core = injector.getInstance(Core.class);
254 /* create web of trust connector. */
255 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
257 /* create FCP interface. */
258 fcpInterface = injector.getInstance(FcpInterface.class);
259 core.setFcpInterface(fcpInterface);
261 /* create the web interface. */
262 webInterface = injector.getInstance(WebInterface.class);
264 boolean startupFailed = true;
269 if ((newConfiguration != null) && (oldConfiguration != newConfiguration)) {
270 logger.log(Level.INFO, "Setting configuration to file-based configuration.");
271 core.setConfiguration(newConfiguration);
273 webInterface.start();
274 webInterface.setFirstStart(firstStart);
275 webInterface.setNewConfig(newConfig);
276 startupFailed = false;
280 * we let the exception bubble up but shut the logging down so
281 * that the logfile is not swamped by the installed logging
282 * handlers of the failed instances.
293 public void terminate() {
295 /* stop the web interface. */
301 /* stop the web of trust connector. */
302 webOfTrustConnector.stop();
303 } catch (Throwable t1) {
304 logger.log(Level.SEVERE, "Error while shutting down!", t1);
306 /* shutdown logger. */
312 // INTERFACE FredPluginFCP
319 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
320 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
324 // INTERFACE FredPluginL10n
331 public String getString(String key) {
332 return l10n.getBase().getString(key);
339 public void setLanguage(LANGUAGE newLanguage) {
340 l10n = new PluginL10n(this, newLanguage);
344 // INTERFACE FredPluginBaseL10n
351 public String getL10nFilesBasePath() {
359 public String getL10nFilesMask() {
360 return "sone.${lang}.properties";
367 public String getL10nOverrideFilesMask() {
368 return "sone.${lang}.override.properties";
375 public ClassLoader getPluginClassLoader() {
376 return SonePlugin.class.getClassLoader();
380 // INTERFACE FredPluginVersioned
387 public String getVersion() {
388 return VERSION.toString();