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.Collections;
22 import java.util.logging.Level;
23 import java.util.logging.LogRecord;
24 import java.util.logging.Logger;
26 import net.pterodactylus.sone.core.Core;
27 import net.pterodactylus.sone.core.FreenetInterface;
28 import net.pterodactylus.sone.freenet.PluginStoreConfigurationBackend;
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.config.XMLConfigurationBackend;
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.FredPluginL10n;
45 import freenet.pluginmanager.FredPluginThreadless;
46 import freenet.pluginmanager.FredPluginVersioned;
47 import freenet.pluginmanager.PluginRespirator;
48 import freenet.pluginmanager.PluginStore;
51 * This class interfaces with Freenet. It is the class that is loaded by the
52 * node and starts up the whole Sone system.
54 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
56 public class SonePlugin implements FredPlugin, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
59 /* initialize logging. */
60 Logging.setup("sone");
61 Logging.addLoggingListener(new LoggingListener() {
64 public void logged(LogRecord logRecord) {
65 Class<?> loggerClass = Logging.getLoggerClass(logRecord.getLoggerName());
66 int recordLevel = logRecord.getLevel().intValue();
67 if (recordLevel < Level.FINE.intValue()) {
68 freenet.support.Logger.debug(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
69 } else if (recordLevel < Level.INFO.intValue()) {
70 freenet.support.Logger.minor(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
71 } else if (recordLevel < Level.WARNING.intValue()) {
72 freenet.support.Logger.normal(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
73 } else if (recordLevel < Level.SEVERE.intValue()) {
74 freenet.support.Logger.warning(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
76 freenet.support.Logger.error(loggerClass, String.format(logRecord.getMessage(), logRecord.getParameters()), logRecord.getThrown());
84 public static final Version VERSION = new Version("RC3", 0, 1);
87 private static final Logger logger = Logging.getLogger(SonePlugin.class);
89 /** The plugin respirator. */
90 private PluginRespirator pluginRespirator;
95 /** The web interface. */
96 private WebInterface webInterface;
98 /** The l10n helper. */
99 private PluginL10n l10n;
101 /** The plugin store. */
102 private PluginStore pluginStore;
109 * Returns the plugin respirator for this plugin.
111 * @return The plugin respirator
113 public PluginRespirator pluginRespirator() {
114 return pluginRespirator;
118 * Returns the core started by this plugin.
127 * Returns the plugin’s l10n helper.
129 * @return The plugin’s l10n helper
131 public PluginL10n l10n() {
136 // FREDPLUGIN METHODS
143 public void runPlugin(PluginRespirator pluginRespirator) {
144 this.pluginRespirator = pluginRespirator;
146 /* create a configuration. */
147 Configuration configuration;
149 configuration = new Configuration(new PluginStoreConfigurationBackend(pluginStore = pluginRespirator.getStore()));
150 } catch (DatabaseDisabledException dde1) {
151 logger.log(Level.WARNING, "Could not load plugin store, using XML files.");
153 configuration = new Configuration(new XMLConfigurationBackend(new File("sone.xml"), true));
154 } catch (ConfigurationException ce1) {
155 logger.log(Level.SEVERE, "Could not load or create the “sone.xml” configuration file!");
156 configuration = new Configuration(new MapConfigurationBackend(Collections.<String, String> emptyMap()));
160 /* create freenet interface. */
161 FreenetInterface freenetInterface = new FreenetInterface(pluginRespirator.getNode(), pluginRespirator.getHLSimpleClient());
163 /* create web of trust connector. */
164 PluginConnector pluginConnector = new PluginConnector(pluginRespirator);
165 WebOfTrustConnector webOfTrustConnector = new WebOfTrustConnector(pluginConnector);
167 /* create the web interface. */
168 webInterface = new WebInterface(this);
172 core.configuration(configuration);
173 core.freenetInterface(freenetInterface);
174 core.setWebOfTrustConnector(webOfTrustConnector);
177 boolean startupFailed = true;
180 webInterface.start();
181 startupFailed = false;
185 * we let the exception bubble up but shut the logging down so
186 * that the logfile is not swamped by the installed logging
187 * handlers of the failed instances.
198 public void terminate() {
200 /* stop the web interface. */
206 /* TODO wait for core to stop? */
208 pluginRespirator.putStore(pluginStore);
209 } catch (DatabaseDisabledException dde1) {
210 logger.log(Level.WARNING, "Could not store plugin store, database is disabled.", dde1);
214 /* shutdown logger. */
220 // INTERFACE FredPluginL10n
227 public String getString(String key) {
228 return l10n.getBase().getString(key);
235 public void setLanguage(LANGUAGE newLanguage) {
236 l10n = new PluginL10n(this, newLanguage);
240 // INTERFACE FredPluginBaseL10n
247 public String getL10nFilesBasePath() {
255 public String getL10nFilesMask() {
256 return "sone.${lang}.properties";
263 public String getL10nOverrideFilesMask() {
264 return "sone.${lang}.override.properties";
271 public ClassLoader getPluginClassLoader() {
272 return SonePlugin.class.getClassLoader();
276 // INTERFACE FredPluginVersioned
283 public String getVersion() {
284 return VERSION.toString();