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.PostProvider;
28 import net.pterodactylus.sone.core.WebOfTrustUpdater;
29 import net.pterodactylus.sone.data.PostBuilderFactory;
30 import net.pterodactylus.sone.data.PostReplyBuilderFactory;
31 import net.pterodactylus.sone.data.impl.DefaultPostBuilderFactory;
32 import net.pterodactylus.sone.data.impl.DefaultPostReplyBuilderFactory;
33 import net.pterodactylus.sone.fcp.FcpInterface;
34 import net.pterodactylus.sone.freenet.PluginStoreConfigurationBackend;
35 import net.pterodactylus.sone.freenet.plugin.PluginConnector;
36 import net.pterodactylus.sone.freenet.wot.IdentityManager;
37 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
38 import net.pterodactylus.sone.web.WebInterface;
39 import net.pterodactylus.util.config.Configuration;
40 import net.pterodactylus.util.config.ConfigurationException;
41 import net.pterodactylus.util.config.MapConfigurationBackend;
42 import net.pterodactylus.util.logging.Logging;
43 import net.pterodactylus.util.logging.LoggingListener;
44 import net.pterodactylus.util.version.Version;
46 import com.google.common.eventbus.EventBus;
47 import com.google.inject.AbstractModule;
48 import com.google.inject.Guice;
49 import com.google.inject.Injector;
50 import com.google.inject.Singleton;
51 import com.google.inject.TypeLiteral;
52 import com.google.inject.matcher.Matchers;
53 import com.google.inject.name.Names;
54 import com.google.inject.spi.InjectionListener;
55 import com.google.inject.spi.TypeEncounter;
56 import com.google.inject.spi.TypeListener;
58 import freenet.client.async.DatabaseDisabledException;
59 import freenet.l10n.BaseL10n.LANGUAGE;
60 import freenet.l10n.PluginL10n;
61 import freenet.node.Node;
62 import freenet.pluginmanager.FredPlugin;
63 import freenet.pluginmanager.FredPluginBaseL10n;
64 import freenet.pluginmanager.FredPluginFCP;
65 import freenet.pluginmanager.FredPluginL10n;
66 import freenet.pluginmanager.FredPluginThreadless;
67 import freenet.pluginmanager.FredPluginVersioned;
68 import freenet.pluginmanager.PluginReplySender;
69 import freenet.pluginmanager.PluginRespirator;
70 import freenet.support.SimpleFieldSet;
71 import freenet.support.api.Bucket;
74 * This class interfaces with Freenet. It is the class that is loaded by the
75 * node and starts up the whole Sone system.
77 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
79 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
82 /* initialize logging. */
83 Logging.setup("sone");
84 Logging.addLoggingListener(new LoggingListener() {
87 public void logged(LogRecord logRecord) {
88 Class<?> loggerClass = Logging.getLoggerClass(logRecord.getLoggerName());
89 int recordLevel = logRecord.getLevel().intValue();
90 if (recordLevel < Level.FINE.intValue()) {
91 freenet.support.Logger.debug(loggerClass, logRecord.getMessage(), logRecord.getThrown());
92 } else if (recordLevel < Level.INFO.intValue()) {
93 freenet.support.Logger.minor(loggerClass, logRecord.getMessage(), logRecord.getThrown());
94 } else if (recordLevel < Level.WARNING.intValue()) {
95 freenet.support.Logger.normal(loggerClass, logRecord.getMessage(), logRecord.getThrown());
96 } else if (recordLevel < Level.SEVERE.intValue()) {
97 freenet.support.Logger.warning(loggerClass, logRecord.getMessage(), logRecord.getThrown());
99 freenet.support.Logger.error(loggerClass, logRecord.getMessage(), logRecord.getThrown());
106 public static final Version VERSION = new Version(0, 8, 4);
109 private static final Logger logger = Logging.getLogger(SonePlugin.class);
111 /** The plugin respirator. */
112 private PluginRespirator pluginRespirator;
117 /** The web interface. */
118 private WebInterface webInterface;
120 /** The FCP interface. */
121 private FcpInterface fcpInterface;
123 /** The l10n helper. */
124 private PluginL10n l10n;
126 /** The web of trust connector. */
127 private WebOfTrustConnector webOfTrustConnector;
134 * Returns the plugin respirator for this plugin.
136 * @return The plugin respirator
138 public PluginRespirator pluginRespirator() {
139 return pluginRespirator;
143 * Returns the core started by this plugin.
152 * Returns the plugin’s l10n helper.
154 * @return The plugin’s l10n helper
156 public PluginL10n l10n() {
161 // FREDPLUGIN METHODS
168 public void runPlugin(PluginRespirator pluginRespirator) {
169 this.pluginRespirator = pluginRespirator;
171 /* create a configuration. */
172 Configuration oldConfiguration;
173 Configuration newConfiguration = null;
174 boolean firstStart = !new File("sone.properties").exists();
175 boolean newConfig = false;
177 oldConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), false));
178 newConfiguration = oldConfiguration;
179 } catch (ConfigurationException ce1) {
181 logger.log(Level.INFO, "Could not load configuration file, trying plugin store…", ce1);
183 newConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), true));
184 logger.log(Level.INFO, "Created new configuration file.");
185 } catch (ConfigurationException ce2) {
186 logger.log(Level.SEVERE, "Could not create configuration file, using Plugin Store!", ce2);
189 oldConfiguration = new Configuration(new PluginStoreConfigurationBackend(pluginRespirator));
190 logger.log(Level.INFO, "Plugin store loaded.");
191 } catch (DatabaseDisabledException dde1) {
192 logger.log(Level.SEVERE, "Could not load any configuration, using empty configuration!");
193 oldConfiguration = new Configuration(new MapConfigurationBackend());
197 final Configuration startConfiguration = oldConfiguration;
198 final EventBus eventBus = new EventBus();
200 /* Freenet injector configuration. */
201 AbstractModule freenetModule = new AbstractModule() {
204 @SuppressWarnings("synthetic-access")
205 protected void configure() {
206 bind(PluginRespirator.class).toInstance(SonePlugin.this.pluginRespirator);
207 bind(Node.class).toInstance(SonePlugin.this.pluginRespirator.getNode());
210 /* Sone injector configuration. */
211 AbstractModule soneModule = new AbstractModule() {
214 protected void configure() {
215 bind(EventBus.class).toInstance(eventBus);
216 bind(Configuration.class).toInstance(startConfiguration);
217 bind(FreenetInterface.class).in(Singleton.class);
218 bind(PluginConnector.class).in(Singleton.class);
219 bind(WebOfTrustConnector.class).in(Singleton.class);
220 bind(WebOfTrustUpdater.class).in(Singleton.class);
221 bind(IdentityManager.class).in(Singleton.class);
222 bind(String.class).annotatedWith(Names.named("WebOfTrustContext")).toInstance("Sone");
223 bind(SonePlugin.class).toInstance(SonePlugin.this);
224 bind(FcpInterface.class).in(Singleton.class);
225 bind(PostBuilderFactory.class).to(DefaultPostBuilderFactory.class).in(Singleton.class);
226 bind(PostReplyBuilderFactory.class).to(DefaultPostReplyBuilderFactory.class).in(Singleton.class);
227 bind(PostProvider.class).to(Core.class).in(Singleton.class);
228 bindListener(Matchers.any(), new TypeListener() {
231 public <I> void hear(TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEncounter) {
232 typeEncounter.register(new InjectionListener<I>() {
235 public void afterInjection(I injectee) {
236 eventBus.register(injectee);
244 Injector injector = Guice.createInjector(freenetModule, soneModule);
245 core = injector.getInstance(Core.class);
247 /* create web of trust connector. */
248 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
250 /* create FCP interface. */
251 fcpInterface = injector.getInstance(FcpInterface.class);
252 core.setFcpInterface(fcpInterface);
254 /* create the web interface. */
255 webInterface = injector.getInstance(WebInterface.class);
257 boolean startupFailed = true;
262 if ((newConfiguration != null) && (oldConfiguration != newConfiguration)) {
263 logger.log(Level.INFO, "Setting configuration to file-based configuration.");
264 core.setConfiguration(newConfiguration);
266 webInterface.start();
267 webInterface.setFirstStart(firstStart);
268 webInterface.setNewConfig(newConfig);
269 startupFailed = false;
273 * we let the exception bubble up but shut the logging down so
274 * that the logfile is not swamped by the installed logging
275 * handlers of the failed instances.
286 public void terminate() {
288 /* stop the web interface. */
294 /* stop the web of trust connector. */
295 webOfTrustConnector.stop();
296 } catch (Throwable t1) {
297 logger.log(Level.SEVERE, "Error while shutting down!", t1);
299 /* shutdown logger. */
305 // INTERFACE FredPluginFCP
312 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
313 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
317 // INTERFACE FredPluginL10n
324 public String getString(String key) {
325 return l10n.getBase().getString(key);
332 public void setLanguage(LANGUAGE newLanguage) {
333 l10n = new PluginL10n(this, newLanguage);
337 // INTERFACE FredPluginBaseL10n
344 public String getL10nFilesBasePath() {
352 public String getL10nFilesMask() {
353 return "sone.${lang}.properties";
360 public String getL10nOverrideFilesMask() {
361 return "sone.${lang}.override.properties";
368 public ClassLoader getPluginClassLoader() {
369 return SonePlugin.class.getClassLoader();
373 // INTERFACE FredPluginVersioned
380 public String getVersion() {
381 return VERSION.toString();