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.fcp.FcpInterface;
29 import net.pterodactylus.sone.freenet.plugin.PluginConnector;
30 import net.pterodactylus.sone.freenet.wot.IdentityManager;
31 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
32 import net.pterodactylus.sone.web.WebInterface;
33 import net.pterodactylus.util.config.Configuration;
34 import net.pterodactylus.util.config.ConfigurationException;
35 import net.pterodactylus.util.config.MapConfigurationBackend;
36 import net.pterodactylus.util.logging.Logging;
37 import net.pterodactylus.util.logging.LoggingListener;
38 import net.pterodactylus.util.version.Version;
39 import freenet.client.async.DatabaseDisabledException;
40 import freenet.l10n.BaseL10n.LANGUAGE;
41 import freenet.l10n.PluginL10n;
42 import freenet.pluginmanager.FredPlugin;
43 import freenet.pluginmanager.FredPluginBaseL10n;
44 import freenet.pluginmanager.FredPluginFCP;
45 import freenet.pluginmanager.FredPluginL10n;
46 import freenet.pluginmanager.FredPluginThreadless;
47 import freenet.pluginmanager.FredPluginVersioned;
48 import freenet.pluginmanager.PluginReplySender;
49 import freenet.pluginmanager.PluginRespirator;
50 import freenet.support.SimpleFieldSet;
51 import freenet.support.api.Bucket;
54 * This class interfaces with Freenet. It is the class that is loaded by the
55 * node and starts up the whole Sone system.
57 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
59 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
62 /* initialize logging. */
63 Logging.setup("sone");
64 Logging.addLoggingListener(new LoggingListener() {
67 public void logged(LogRecord logRecord) {
68 Class<?> loggerClass = Logging.getLoggerClass(logRecord.getLoggerName());
69 int recordLevel = logRecord.getLevel().intValue();
70 if (recordLevel < Level.FINE.intValue()) {
71 freenet.support.Logger.debug(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
72 } else if (recordLevel < Level.INFO.intValue()) {
73 freenet.support.Logger.minor(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
74 } else if (recordLevel < Level.WARNING.intValue()) {
75 freenet.support.Logger.normal(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
76 } else if (recordLevel < Level.SEVERE.intValue()) {
77 freenet.support.Logger.warning(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
79 freenet.support.Logger.error(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
86 public static final Version VERSION = new Version(0, 6);
89 private static final Logger logger = Logging.getLogger(SonePlugin.class);
91 /** The plugin respirator. */
92 private PluginRespirator pluginRespirator;
97 /** The web interface. */
98 private WebInterface webInterface;
100 /** The FCP interface. */
101 private FcpInterface fcpInterface;
103 /** The l10n helper. */
104 private PluginL10n l10n;
106 /** The identity manager. */
107 private IdentityManager identityManager;
114 * Returns the plugin respirator for this plugin.
116 * @return The plugin respirator
118 public PluginRespirator pluginRespirator() {
119 return pluginRespirator;
123 * Returns the core started by this plugin.
132 * Returns the plugin’s l10n helper.
134 * @return The plugin’s l10n helper
136 public PluginL10n l10n() {
141 // FREDPLUGIN METHODS
148 public void runPlugin(PluginRespirator pluginRespirator) {
149 this.pluginRespirator = pluginRespirator;
151 /* create a configuration. */
152 Configuration oldConfiguration;
153 Configuration newConfiguration = null;
154 boolean firstStart = !new File("sone.properties").exists();
155 boolean newConfig = false;
157 oldConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), false));
158 newConfiguration = oldConfiguration;
159 } catch (ConfigurationException ce1) {
161 logger.log(Level.INFO, "Could not load configuration file, trying plugin store…", ce1);
163 newConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), true));
164 logger.log(Level.INFO, "Created new configuration file.");
165 } catch (ConfigurationException ce2) {
166 logger.log(Level.SEVERE, "Could not create configuration file, using Plugin Store!", ce2);
169 oldConfiguration = new Configuration(new PluginStoreConfigurationBackend(pluginRespirator));
170 logger.log(Level.INFO, "Plugin store loaded.");
171 } catch (DatabaseDisabledException dde1) {
172 logger.log(Level.SEVERE, "Could not load any configuration, using empty configuration!");
173 oldConfiguration = new Configuration(new MapConfigurationBackend());
177 boolean startupFailed = true;
179 /* create freenet interface. */
180 FreenetInterface freenetInterface = new FreenetInterface(pluginRespirator.getNode());
182 /* create web of trust connector. */
183 PluginConnector pluginConnector = new PluginConnector(pluginRespirator);
184 WebOfTrustConnector webOfTrustConnector = new WebOfTrustConnector(pluginConnector);
185 identityManager = new IdentityManager(webOfTrustConnector);
186 identityManager.setContext("Sone");
189 core = new Core(oldConfiguration, freenetInterface, identityManager);
191 /* create the web interface. */
192 webInterface = new WebInterface(this);
193 core.addCoreListener(webInterface);
195 /* create FCP interface. */
196 fcpInterface = new FcpInterface(core);
198 /* create the identity manager. */
199 identityManager.addIdentityListener(core);
203 if ((newConfiguration != null) && (oldConfiguration != newConfiguration)) {
204 logger.log(Level.INFO, "Setting configuration to file-based configuration.");
205 core.setConfiguration(newConfiguration);
207 webInterface.start();
208 webInterface.setFirstStart(firstStart);
209 webInterface.setNewConfig(newConfig);
210 identityManager.start();
211 startupFailed = false;
215 * we let the exception bubble up but shut the logging down so
216 * that the logfile is not swamped by the installed logging
217 * handlers of the failed instances.
228 public void terminate() {
230 /* stop the web interface. */
236 /* stop the identity manager. */
237 identityManager.stop();
238 } catch (Throwable t1) {
239 logger.log(Level.SEVERE, "Error while shutting down!", t1);
241 /* shutdown logger. */
247 // INTERFACE FredPluginFCP
254 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
255 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
259 // INTERFACE FredPluginL10n
266 public String getString(String key) {
267 return l10n.getBase().getString(key);
274 public void setLanguage(LANGUAGE newLanguage) {
275 l10n = new PluginL10n(this, newLanguage);
279 // INTERFACE FredPluginBaseL10n
286 public String getL10nFilesBasePath() {
294 public String getL10nFilesMask() {
295 return "sone.${lang}.properties";
302 public String getL10nOverrideFilesMask() {
303 return "sone.${lang}.override.properties";
310 public ClassLoader getPluginClassLoader() {
311 return SonePlugin.class.getClassLoader();
315 // INTERFACE FredPluginVersioned
322 public String getVersion() {
323 return VERSION.toString();