2 * Sone - SonePlugin.java - Copyright © 2010–2019 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 java.util.logging.Logger.*;
22 import java.util.logging.Logger;
23 import java.util.logging.*;
25 import net.pterodactylus.sone.core.*;
26 import net.pterodactylus.sone.fcp.*;
27 import net.pterodactylus.sone.freenet.wot.*;
28 import net.pterodactylus.sone.web.*;
30 import freenet.l10n.BaseL10n.*;
31 import freenet.l10n.*;
32 import freenet.pluginmanager.*;
33 import freenet.support.*;
34 import freenet.support.api.*;
36 import com.google.common.annotations.*;
37 import com.google.common.eventbus.*;
38 import com.google.common.cache.*;
39 import com.google.inject.*;
40 import com.google.inject.Module;
41 import com.google.inject.name.*;
42 import kotlin.jvm.functions.*;
45 * This class interfaces with Freenet. It is the class that is loaded by the
46 * node and starts up the whole Sone system.
48 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
50 private static final Logger soneLogger = getLogger("net.pterodactylus.sone");
53 /* initialize logging. */
54 soneLogger.setUseParentHandlers(false);
55 soneLogger.setLevel(Level.ALL);
56 soneLogger.addHandler(new Handler() {
57 private final LoadingCache<String, Class<?>> classCache = CacheBuilder.newBuilder()
58 .build(new CacheLoader<String, Class<?>>() {
60 public Class<?> load(String key) throws Exception {
61 return SonePlugin.class.getClassLoader().loadClass(key);
66 public void publish(LogRecord logRecord) {
67 int recordLevel = logRecord.getLevel().intValue();
68 Class<?> loggingClass = classCache.getUnchecked(logRecord.getLoggerName());
69 if (recordLevel < Level.FINE.intValue()) {
70 freenet.support.Logger.debug(loggingClass, logRecord.getMessage(), logRecord.getThrown());
71 } else if (recordLevel < Level.INFO.intValue()) {
72 freenet.support.Logger.minor(loggingClass, logRecord.getMessage(), logRecord.getThrown());
73 } else if (recordLevel < Level.WARNING.intValue()) {
74 freenet.support.Logger.normal(loggingClass, logRecord.getMessage(), logRecord.getThrown());
75 } else if (recordLevel < Level.SEVERE.intValue()) {
76 freenet.support.Logger.warning(loggingClass, logRecord.getMessage(), logRecord.getThrown());
78 freenet.support.Logger.error(loggingClass, logRecord.getMessage(), logRecord.getThrown());
92 /** The current year at time of release. */
93 private static final int YEAR = 2019;
94 private static final String SONE_HOMEPAGE = "USK@nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI,DuQSUZiI~agF8c-6tjsFFGuZ8eICrzWCILB60nT8KKo,AQACAAE/sone/";
95 private static final int LATEST_EDITION = 79;
98 private static final Logger logger = getLogger(SonePlugin.class.getName());
100 private final Function1<Module[], Injector> injectorCreator;
102 /** The plugin respirator. */
103 private PluginRespirator pluginRespirator;
108 /** The web interface. */
109 private WebInterface webInterface;
111 /** The FCP interface. */
112 private FcpInterface fcpInterface;
114 /** The l10n helper. */
115 private PluginL10n l10n;
117 /** The web of trust connector. */
118 private WebOfTrustConnector webOfTrustConnector;
120 public SonePlugin() {
121 this(Guice::createInjector);
125 public SonePlugin(Function1<Module[], Injector> injectorCreator) {
126 this.injectorCreator = injectorCreator;
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() {
160 public static String getPluginVersion() {
161 net.pterodactylus.sone.main.Version version = VersionParserKt.getParsedVersion();
162 return (version == null) ? "unknown" : version.getNice();
165 public int getYear() {
169 public String getHomepage() {
170 return SONE_HOMEPAGE + LATEST_EDITION;
173 public static long getLatestEdition() {
174 return LATEST_EDITION;
178 // FREDPLUGIN METHODS
185 public void runPlugin(PluginRespirator pluginRespirator) {
186 this.pluginRespirator = pluginRespirator;
188 Injector injector = createInjector();
189 core = injector.getInstance(Core.class);
191 /* create web of trust connector. */
192 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
194 /* create FCP interface. */
195 fcpInterface = injector.getInstance(FcpInterface.class);
197 /* create the web interface. */
198 webInterface = injector.getInstance(WebInterface.class);
202 webInterface.start();
203 webInterface.setFirstStart(injector.getInstance(Key.get(Boolean.class, Names.named("FirstStart"))));
204 webInterface.setNewConfig(injector.getInstance(Key.get(Boolean.class, Names.named("NewConfig"))));
208 protected Injector createInjector() {
209 FreenetModule freenetModule = new FreenetModule(pluginRespirator);
210 AbstractModule soneModule = new SoneModule(this, new EventBus());
211 Module webInterfaceModule = new WebInterfaceModule();
213 return createInjector(freenetModule, soneModule, webInterfaceModule);
217 protected Injector createInjector(Module... modules) {
218 return injectorCreator.invoke(modules);
225 public void terminate() {
227 /* stop the web interface. */
233 /* stop the web of trust connector. */
234 webOfTrustConnector.stop();
235 } catch (Throwable t1) {
236 logger.log(Level.SEVERE, "Error while shutting down!", t1);
238 deregisterLoggerHandlers();
242 private void deregisterLoggerHandlers() {
243 for (Handler handler : soneLogger.getHandlers()) {
244 soneLogger.removeHandler(handler);
249 // INTERFACE FredPluginFCP
256 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
257 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
261 // INTERFACE FredPluginL10n
268 public String getString(String key) {
269 return l10n.getBase().getString(key);
276 public void setLanguage(LANGUAGE newLanguage) {
277 l10n = new PluginL10n(this, newLanguage);
281 // INTERFACE FredPluginBaseL10n
288 public String getL10nFilesBasePath() {
296 public String getL10nFilesMask() {
297 return "sone.${lang}.properties";
304 public String getL10nOverrideFilesMask() {
305 return "sone.${lang}.override.properties";
312 public ClassLoader getPluginClassLoader() {
313 return SonePlugin.class.getClassLoader();
317 // INTERFACE FredPluginVersioned
324 public String getVersion() {
325 return getPluginVersion();