2 * FreenetSone - SonePlugin.java - Copyright © 2010 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.freenet.PluginStoreConfigurationBackend;
28 import net.pterodactylus.sone.freenet.wot.IdentityManager;
29 import net.pterodactylus.sone.freenet.wot.PluginConnector;
30 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
31 import net.pterodactylus.sone.web.WebInterface;
32 import net.pterodactylus.util.config.Configuration;
33 import net.pterodactylus.util.config.ConfigurationException;
34 import net.pterodactylus.util.config.MapConfigurationBackend;
35 import net.pterodactylus.util.logging.Logging;
36 import net.pterodactylus.util.logging.LoggingListener;
37 import net.pterodactylus.util.version.Version;
38 import freenet.client.async.DatabaseDisabledException;
39 import freenet.l10n.BaseL10n.LANGUAGE;
40 import freenet.l10n.PluginL10n;
41 import freenet.pluginmanager.FredPlugin;
42 import freenet.pluginmanager.FredPluginBaseL10n;
43 import freenet.pluginmanager.FredPluginL10n;
44 import freenet.pluginmanager.FredPluginThreadless;
45 import freenet.pluginmanager.FredPluginVersioned;
46 import freenet.pluginmanager.PluginRespirator;
47 import freenet.pluginmanager.PluginStore;
50 * This class interfaces with Freenet. It is the class that is loaded by the
51 * node and starts up the whole Sone system.
53 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
55 public class SonePlugin implements FredPlugin, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
58 /* initialize logging. */
59 Logging.setup("sone");
60 Logging.addLoggingListener(new LoggingListener() {
63 public void logged(LogRecord logRecord) {
64 Class<?> loggerClass = Logging.getLoggerClass(logRecord.getLoggerName());
65 int recordLevel = logRecord.getLevel().intValue();
66 if (recordLevel < Level.FINE.intValue()) {
67 freenet.support.Logger.debug(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
68 } else if (recordLevel < Level.INFO.intValue()) {
69 freenet.support.Logger.minor(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
70 } else if (recordLevel < Level.WARNING.intValue()) {
71 freenet.support.Logger.normal(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
72 } else if (recordLevel < Level.SEVERE.intValue()) {
73 freenet.support.Logger.warning(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
75 freenet.support.Logger.error(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
82 public static final Version VERSION = new Version(0, 3);
85 private static final Logger logger = Logging.getLogger(SonePlugin.class);
87 /** The plugin respirator. */
88 private PluginRespirator pluginRespirator;
93 /** The web interface. */
94 private WebInterface webInterface;
96 /** The l10n helper. */
97 private PluginL10n l10n;
99 /** The plugin store. */
100 private PluginStore pluginStore;
102 /** The identity manager. */
103 private IdentityManager identityManager;
110 * Returns the plugin respirator for this plugin.
112 * @return The plugin respirator
114 public PluginRespirator pluginRespirator() {
115 return pluginRespirator;
119 * Returns the core started by this plugin.
128 * Returns the plugin’s l10n helper.
130 * @return The plugin’s l10n helper
132 public PluginL10n l10n() {
137 // FREDPLUGIN METHODS
144 public void runPlugin(PluginRespirator pluginRespirator) {
145 this.pluginRespirator = pluginRespirator;
147 /* create a configuration. */
148 Configuration oldConfiguration;
149 Configuration newConfiguration = null;
151 oldConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), false));
152 newConfiguration = oldConfiguration;
153 } catch (ConfigurationException ce1) {
154 logger.log(Level.INFO, "Could not load configuration file, trying plugin store…");
156 newConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), true));
157 } catch (ConfigurationException ce2) {
158 logger.log(Level.SEVERE, "Could not create configuration file, using Plugin Store!");
161 oldConfiguration = new Configuration(new PluginStoreConfigurationBackend(pluginRespirator));
162 logger.log(Level.INFO, "Plugin store loaded.");
163 } catch (DatabaseDisabledException dde1) {
164 logger.log(Level.SEVERE, "Could not load any configuration, using in-memory configuration!");
165 oldConfiguration = new Configuration(new MapConfigurationBackend());
169 /* create freenet interface. */
170 FreenetInterface freenetInterface = new FreenetInterface(pluginRespirator.getNode(), pluginRespirator.getHLSimpleClient());
172 /* create web of trust connector. */
173 PluginConnector pluginConnector = new PluginConnector(pluginRespirator);
174 WebOfTrustConnector webOfTrustConnector = new WebOfTrustConnector(pluginConnector);
175 identityManager = new IdentityManager(webOfTrustConnector);
176 identityManager.setContext("Sone");
179 core = new Core(oldConfiguration, freenetInterface, identityManager);
181 /* create the web interface. */
182 webInterface = new WebInterface(this);
183 core.addCoreListener(webInterface);
185 /* create the identity manager. */
186 identityManager.addIdentityListener(core);
189 boolean startupFailed = true;
192 if ((newConfiguration != null) && (oldConfiguration != newConfiguration)) {
193 logger.log(Level.INFO, "Setting configuration to file-based configuration.");
194 core.setConfiguration(newConfiguration);
196 webInterface.start();
197 identityManager.start();
198 startupFailed = false;
202 * we let the exception bubble up but shut the logging down so
203 * that the logfile is not swamped by the installed logging
204 * handlers of the failed instances.
215 public void terminate() {
217 /* stop the web interface. */
223 /* stop the identity manager. */
224 identityManager.stop();
226 /* TODO wait for core to stop? */
228 pluginRespirator.putStore(pluginStore);
229 } catch (DatabaseDisabledException dde1) {
230 logger.log(Level.WARNING, "Could not store plugin store, database is disabled.", dde1);
234 /* shutdown logger. */
240 // INTERFACE FredPluginL10n
247 public String getString(String key) {
248 return l10n.getBase().getString(key);
255 public void setLanguage(LANGUAGE newLanguage) {
256 l10n = new PluginL10n(this, newLanguage);
260 // INTERFACE FredPluginBaseL10n
267 public String getL10nFilesBasePath() {
275 public String getL10nFilesMask() {
276 return "sone.${lang}.properties";
283 public String getL10nOverrideFilesMask() {
284 return "sone.${lang}.override.properties";
291 public ClassLoader getPluginClassLoader() {
292 return SonePlugin.class.getClassLoader();
296 // INTERFACE FredPluginVersioned
303 public String getVersion() {
304 return VERSION.toString();