2 * Sone - SonePlugin.java - Copyright © 2010–2016 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;
20 import static com.google.common.base.Optional.of;
21 import static java.util.logging.Logger.getLogger;
24 import java.util.logging.Handler;
25 import java.util.logging.Level;
26 import java.util.logging.LogRecord;
27 import java.util.logging.Logger;
29 import net.pterodactylus.sone.core.Core;
30 import net.pterodactylus.sone.fcp.FcpInterface;
31 import net.pterodactylus.sone.freenet.PluginStoreConfigurationBackend;
32 import net.pterodactylus.sone.freenet.wot.Context;
33 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
34 import net.pterodactylus.sone.web.WebInterface;
35 import net.pterodactylus.util.config.Configuration;
36 import net.pterodactylus.util.config.ConfigurationException;
37 import net.pterodactylus.util.config.MapConfigurationBackend;
38 import net.pterodactylus.util.version.Version;
40 import com.google.common.base.Optional;
41 import com.google.common.cache.CacheBuilder;
42 import com.google.common.cache.CacheLoader;
43 import com.google.common.cache.LoadingCache;
44 import com.google.common.eventbus.EventBus;
45 import com.google.inject.AbstractModule;
46 import com.google.inject.Guice;
47 import com.google.inject.Injector;
48 import com.google.inject.TypeLiteral;
49 import com.google.inject.matcher.Matchers;
50 import com.google.inject.spi.InjectionListener;
51 import com.google.inject.spi.TypeEncounter;
52 import com.google.inject.spi.TypeListener;
54 import freenet.client.async.PersistenceDisabledException;
55 import freenet.l10n.BaseL10n.LANGUAGE;
56 import freenet.l10n.PluginL10n;
57 import freenet.node.Node;
58 import freenet.pluginmanager.FredPlugin;
59 import freenet.pluginmanager.FredPluginBaseL10n;
60 import freenet.pluginmanager.FredPluginFCP;
61 import freenet.pluginmanager.FredPluginL10n;
62 import freenet.pluginmanager.FredPluginThreadless;
63 import freenet.pluginmanager.FredPluginVersioned;
64 import freenet.pluginmanager.PluginReplySender;
65 import freenet.pluginmanager.PluginRespirator;
66 import freenet.support.SimpleFieldSet;
67 import freenet.support.api.Bucket;
70 * This class interfaces with Freenet. It is the class that is loaded by the
71 * node and starts up the whole Sone system.
73 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
75 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
77 private static final Logger soneLogger = getLogger("net.pterodactylus.sone");
80 /* initialize logging. */
81 soneLogger.setUseParentHandlers(false);
82 soneLogger.addHandler(new Handler() {
83 private final LoadingCache<String, Class<?>> classCache = CacheBuilder.newBuilder()
84 .build(new CacheLoader<String, Class<?>>() {
86 public Class<?> load(String key) throws Exception {
87 return Class.forName(key);
92 public void publish(LogRecord logRecord) {
93 int recordLevel = logRecord.getLevel().intValue();
94 Class<?> loggingClass = classCache.getUnchecked(logRecord.getLoggerName());
95 if (recordLevel < Level.FINE.intValue()) {
96 freenet.support.Logger.debug(loggingClass, logRecord.getMessage(), logRecord.getThrown());
97 } else if (recordLevel < Level.INFO.intValue()) {
98 freenet.support.Logger.minor(loggingClass, logRecord.getMessage(), logRecord.getThrown());
99 } else if (recordLevel < Level.WARNING.intValue()) {
100 freenet.support.Logger.normal(loggingClass, logRecord.getMessage(), logRecord.getThrown());
101 } else if (recordLevel < Level.SEVERE.intValue()) {
102 freenet.support.Logger.warning(loggingClass, logRecord.getMessage(), logRecord.getThrown());
104 freenet.support.Logger.error(loggingClass, logRecord.getMessage(), logRecord.getThrown());
109 public void flush() {
113 public void close() {
119 private static final Version VERSION = new Version(0, 9, 6);
121 /** The current year at time of release. */
122 private static final int YEAR = 2016;
123 private static final String SONE_HOMEPAGE = "USK@nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI,DuQSUZiI~agF8c-6tjsFFGuZ8eICrzWCILB60nT8KKo,AQACAAE/sone/";
124 private static final int LATEST_EDITION = 73;
127 private static final Logger logger = getLogger(SonePlugin.class.getName());
129 /** The plugin respirator. */
130 private PluginRespirator pluginRespirator;
135 /** The web interface. */
136 private WebInterface webInterface;
138 /** The FCP interface. */
139 private FcpInterface fcpInterface;
141 /** The l10n helper. */
142 private PluginL10n l10n;
144 /** The web of trust connector. */
145 private WebOfTrustConnector webOfTrustConnector;
152 * Returns the plugin respirator for this plugin.
154 * @return The plugin respirator
156 public PluginRespirator pluginRespirator() {
157 return pluginRespirator;
161 * Returns the core started by this plugin.
170 * Returns the plugin’s l10n helper.
172 * @return The plugin’s l10n helper
174 public PluginL10n l10n() {
178 public static String getPluginVersion() {
179 return VERSION.toString();
182 public static int getYear() {
186 public static String getHomepage() {
187 return SONE_HOMEPAGE + LATEST_EDITION;
190 public static long getLatestEdition() {
191 return LATEST_EDITION;
195 // FREDPLUGIN METHODS
202 public void runPlugin(PluginRespirator pluginRespirator) {
203 this.pluginRespirator = pluginRespirator;
205 /* create a configuration. */
206 Configuration oldConfiguration;
207 Configuration newConfiguration = null;
208 boolean firstStart = !new File("sone.properties").exists();
209 boolean newConfig = false;
211 oldConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), false));
212 newConfiguration = oldConfiguration;
213 } catch (ConfigurationException ce1) {
215 logger.log(Level.INFO, "Could not load configuration file, trying plugin store…", ce1);
217 newConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), true));
218 logger.log(Level.INFO, "Created new configuration file.");
219 } catch (ConfigurationException ce2) {
220 logger.log(Level.SEVERE, "Could not create configuration file, using Plugin Store!", ce2);
223 oldConfiguration = new Configuration(new PluginStoreConfigurationBackend(pluginRespirator));
224 logger.log(Level.INFO, "Plugin store loaded.");
225 } catch (PersistenceDisabledException pde1) {
226 logger.log(Level.SEVERE, "Could not load any configuration, using empty configuration!");
227 oldConfiguration = new Configuration(new MapConfigurationBackend());
231 final Configuration startConfiguration;
232 if ((newConfiguration != null) && (oldConfiguration != newConfiguration)) {
233 logger.log(Level.INFO, "Setting configuration to file-based configuration.");
234 startConfiguration = newConfiguration;
236 startConfiguration = oldConfiguration;
238 final EventBus eventBus = new EventBus();
240 /* Freenet injector configuration. */
241 AbstractModule freenetModule = new AbstractModule() {
244 @SuppressWarnings("synthetic-access")
245 protected void configure() {
246 bind(PluginRespirator.class).toInstance(SonePlugin.this.pluginRespirator);
247 bind(Node.class).toInstance(SonePlugin.this.pluginRespirator.getNode());
250 /* Sone injector configuration. */
251 AbstractModule soneModule = new AbstractModule() {
254 protected void configure() {
255 bind(EventBus.class).toInstance(eventBus);
256 bind(Configuration.class).toInstance(startConfiguration);
257 Context context = new Context("Sone");
258 bind(Context.class).toInstance(context);
259 bind(getOptionalContextTypeLiteral()).toInstance(of(context));
260 bind(SonePlugin.class).toInstance(SonePlugin.this);
261 bind(Version.class).toInstance(VERSION);
262 if (startConfiguration.getBooleanValue("Developer.LoadFromFilesystem").getValue(false)) {
263 String path = startConfiguration.getStringValue("Developer.FilesystemPath").getValue(null);
265 bind(Loaders.class).toInstance(new DebugLoaders(path));
268 bindListener(Matchers.any(), new TypeListener() {
271 public <I> void hear(TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEncounter) {
272 typeEncounter.register(new InjectionListener<I>() {
275 public void afterInjection(I injectee) {
276 eventBus.register(injectee);
283 private TypeLiteral<Optional<Context>> getOptionalContextTypeLiteral() {
284 return new TypeLiteral<Optional<Context>>() {
289 Injector injector = Guice.createInjector(freenetModule, soneModule);
290 core = injector.getInstance(Core.class);
292 /* create web of trust connector. */
293 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
295 /* create FCP interface. */
296 fcpInterface = injector.getInstance(FcpInterface.class);
298 /* create the web interface. */
299 webInterface = injector.getInstance(WebInterface.class);
303 webInterface.start();
304 webInterface.setFirstStart(firstStart);
305 webInterface.setNewConfig(newConfig);
312 public void terminate() {
314 /* stop the web interface. */
320 /* stop the web of trust connector. */
321 webOfTrustConnector.stop();
322 } catch (Throwable t1) {
323 logger.log(Level.SEVERE, "Error while shutting down!", t1);
325 deregisterLoggerHandlers();
329 private void deregisterLoggerHandlers() {
330 for (Handler handler : soneLogger.getHandlers()) {
331 soneLogger.removeHandler(handler);
336 // INTERFACE FredPluginFCP
343 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
344 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
348 // INTERFACE FredPluginL10n
355 public String getString(String key) {
356 return l10n.getBase().getString(key);
363 public void setLanguage(LANGUAGE newLanguage) {
364 l10n = new PluginL10n(this, newLanguage);
368 // INTERFACE FredPluginBaseL10n
375 public String getL10nFilesBasePath() {
383 public String getL10nFilesMask() {
384 return "sone.${lang}.properties";
391 public String getL10nOverrideFilesMask() {
392 return "sone.${lang}.override.properties";
399 public ClassLoader getPluginClassLoader() {
400 return SonePlugin.class.getClassLoader();
404 // INTERFACE FredPluginVersioned
411 public String getVersion() {
412 return VERSION.toString();