2 * Sone - SonePlugin.java - Copyright © 2010–2020 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 javax.annotation.Nonnull;
27 import net.pterodactylus.sone.core.*;
28 import net.pterodactylus.sone.core.event.*;
29 import net.pterodactylus.sone.fcp.*;
30 import net.pterodactylus.sone.freenet.wot.*;
31 import net.pterodactylus.sone.web.*;
32 import net.pterodactylus.sone.web.notification.NotificationHandler;
33 import net.pterodactylus.sone.web.notification.NotificationHandlerModule;
35 import freenet.l10n.BaseL10n.*;
36 import freenet.l10n.*;
37 import freenet.pluginmanager.*;
38 import freenet.support.*;
39 import freenet.support.api.*;
41 import com.google.common.annotations.*;
42 import com.google.common.eventbus.*;
43 import com.google.common.cache.*;
44 import com.google.inject.*;
45 import com.google.inject.name.*;
46 import kotlin.jvm.functions.*;
49 * This class interfaces with Freenet. It is the class that is loaded by the
50 * node and starts up the whole Sone system.
52 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
54 private static final Logger soneLogger = getLogger("net.pterodactylus.sone");
57 /* initialize logging. */
58 soneLogger.setUseParentHandlers(false);
59 soneLogger.setLevel(Level.ALL);
60 soneLogger.addHandler(new Handler() {
61 private final LoadingCache<String, Class<?>> classCache = CacheBuilder.newBuilder()
62 .build(new CacheLoader<String, Class<?>>() {
64 public Class<?> load(@Nonnull String key) throws Exception {
65 return SonePlugin.class.getClassLoader().loadClass(key);
70 public void publish(LogRecord logRecord) {
71 int recordLevel = logRecord.getLevel().intValue();
72 Class<?> loggingClass = classCache.getUnchecked(logRecord.getLoggerName());
73 if (recordLevel < Level.FINE.intValue()) {
74 freenet.support.Logger.debug(loggingClass, logRecord.getMessage(), logRecord.getThrown());
75 } else if (recordLevel < Level.INFO.intValue()) {
76 freenet.support.Logger.minor(loggingClass, logRecord.getMessage(), logRecord.getThrown());
77 } else if (recordLevel < Level.WARNING.intValue()) {
78 freenet.support.Logger.normal(loggingClass, logRecord.getMessage(), logRecord.getThrown());
79 } else if (recordLevel < Level.SEVERE.intValue()) {
80 freenet.support.Logger.warning(loggingClass, logRecord.getMessage(), logRecord.getThrown());
82 freenet.support.Logger.error(loggingClass, logRecord.getMessage(), logRecord.getThrown());
96 /** The current year at time of release. */
97 private static final int YEAR = 2020;
98 private static final String SONE_HOMEPAGE = "USK@nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI,DuQSUZiI~agF8c-6tjsFFGuZ8eICrzWCILB60nT8KKo,AQACAAE/sone/";
99 private static final int LATEST_EDITION = 80;
102 private static final Logger logger = getLogger(SonePlugin.class.getName());
104 private final Function1<Module[], Injector> injectorCreator;
106 /** The plugin respirator. */
107 private PluginRespirator pluginRespirator;
112 /** The event bus. */
113 private EventBus eventBus;
115 /** The web interface. */
116 private WebInterface webInterface;
118 /** The FCP interface. */
119 private FcpInterface fcpInterface;
121 /** The l10n helper. */
122 private PluginL10n l10n;
124 /** The web of trust connector. */
125 private WebOfTrustConnector webOfTrustConnector;
127 public SonePlugin() {
128 this(Guice::createInjector);
132 public SonePlugin(Function1<Module[], Injector> injectorCreator) {
133 this.injectorCreator = injectorCreator;
141 * Returns the plugin respirator for this plugin.
143 * @return The plugin respirator
145 public PluginRespirator pluginRespirator() {
146 return pluginRespirator;
150 * Returns the core started by this plugin.
159 * Returns the plugin’s l10n helper.
161 * @return The plugin’s l10n helper
163 public PluginL10n l10n() {
167 public static String getPluginVersion() {
168 net.pterodactylus.sone.main.Version version = VersionParserKt.getParsedVersion();
169 return (version == null) ? "unknown" : version.getNice();
172 public int getYear() {
176 public String getHomepage() {
177 return SONE_HOMEPAGE + LATEST_EDITION;
180 public static long getLatestEdition() {
181 return LATEST_EDITION;
185 // FREDPLUGIN METHODS
192 public void runPlugin(PluginRespirator pluginRespirator) {
193 this.pluginRespirator = pluginRespirator;
195 Injector injector = createInjector();
196 core = injector.getInstance(Core.class);
198 /* create web of trust connector. */
199 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
201 /* create FCP interface. */
202 fcpInterface = injector.getInstance(FcpInterface.class);
204 /* create the web interface. */
205 webInterface = injector.getInstance(WebInterface.class);
207 /* we need to request this to install all notification handlers. */
208 injector.getInstance(NotificationHandler.class);
210 /* and this is required to shutdown all tickers. */
211 injector.getInstance(TickerShutdown.class);
216 /* start the web interface! */
217 webInterface.start();
219 /* send some events on startup */
220 eventBus = injector.getInstance(EventBus.class);
223 if (injector.getInstance(Key.get(Boolean.class, Names.named("FirstStart")))) {
224 eventBus.post(new FirstStart());
227 if (injector.getInstance(Key.get(Boolean.class, Names.named("NewConfig")))) {
228 eventBus.post(new ConfigNotRead());
232 eventBus.post(new Startup());
236 protected Injector createInjector() {
237 FreenetModule freenetModule = new FreenetModule(pluginRespirator);
238 AbstractModule soneModule = new SoneModule(this, new EventBus());
239 Module webInterfaceModule = new WebInterfaceModule();
240 Module notificationHandlerModule = new NotificationHandlerModule();
242 return createInjector(freenetModule, soneModule, webInterfaceModule, notificationHandlerModule);
246 protected Injector createInjector(Module... modules) {
247 return injectorCreator.invoke(modules);
254 public void terminate() {
255 /* send shutdown event. */
256 eventBus.post(new Shutdown());
259 /* stop the web interface. */
265 /* stop the web of trust connector. */
266 webOfTrustConnector.stop();
267 } catch (Throwable t1) {
268 logger.log(Level.SEVERE, "Error while shutting down!", t1);
270 deregisterLoggerHandlers();
274 private void deregisterLoggerHandlers() {
275 for (Handler handler : soneLogger.getHandlers()) {
276 soneLogger.removeHandler(handler);
281 // INTERFACE FredPluginFCP
288 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
289 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
293 // INTERFACE FredPluginL10n
300 public String getString(String key) {
301 return l10n.getBase().getString(key);
308 public void setLanguage(LANGUAGE newLanguage) {
309 l10n = new PluginL10n(this, newLanguage);
313 // INTERFACE FredPluginBaseL10n
320 public String getL10nFilesBasePath() {
328 public String getL10nFilesMask() {
329 return "sone.${lang}.properties";
336 public String getL10nOverrideFilesMask() {
337 return "sone.${lang}.override.properties";
344 public ClassLoader getPluginClassLoader() {
345 return SonePlugin.class.getClassLoader();
349 // INTERFACE FredPluginVersioned
356 public String getVersion() {
357 return getPluginVersion();