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 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.Module;
46 import com.google.inject.name.*;
47 import kotlin.jvm.functions.*;
50 * This class interfaces with Freenet. It is the class that is loaded by the
51 * node and starts up the whole Sone system.
53 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
55 private static final Logger soneLogger = getLogger("net.pterodactylus.sone");
58 /* initialize logging. */
59 soneLogger.setUseParentHandlers(false);
60 soneLogger.setLevel(Level.ALL);
61 soneLogger.addHandler(new Handler() {
62 private final LoadingCache<String, Class<?>> classCache = CacheBuilder.newBuilder()
63 .build(new CacheLoader<String, Class<?>>() {
65 public Class<?> load(@Nonnull String key) throws Exception {
66 return SonePlugin.class.getClassLoader().loadClass(key);
71 public void publish(LogRecord logRecord) {
72 int recordLevel = logRecord.getLevel().intValue();
73 Class<?> loggingClass = classCache.getUnchecked(logRecord.getLoggerName());
74 if (recordLevel < Level.FINE.intValue()) {
75 freenet.support.Logger.debug(loggingClass, logRecord.getMessage(), logRecord.getThrown());
76 } else if (recordLevel < Level.INFO.intValue()) {
77 freenet.support.Logger.minor(loggingClass, logRecord.getMessage(), logRecord.getThrown());
78 } else if (recordLevel < Level.WARNING.intValue()) {
79 freenet.support.Logger.normal(loggingClass, logRecord.getMessage(), logRecord.getThrown());
80 } else if (recordLevel < Level.SEVERE.intValue()) {
81 freenet.support.Logger.warning(loggingClass, logRecord.getMessage(), logRecord.getThrown());
83 freenet.support.Logger.error(loggingClass, logRecord.getMessage(), logRecord.getThrown());
97 /** The current year at time of release. */
98 private static final int YEAR = 2019;
99 private static final String SONE_HOMEPAGE = "USK@nwa8lHa271k2QvJ8aa0Ov7IHAV-DFOCFgmDt3X6BpCI,DuQSUZiI~agF8c-6tjsFFGuZ8eICrzWCILB60nT8KKo,AQACAAE/sone/";
100 private static final int LATEST_EDITION = 79;
103 private static final Logger logger = getLogger(SonePlugin.class.getName());
105 private final Function1<Module[], Injector> injectorCreator;
107 /** The plugin respirator. */
108 private PluginRespirator pluginRespirator;
113 /** The event bus. */
114 private EventBus eventBus;
116 /** The web interface. */
117 private WebInterface webInterface;
119 /** The FCP interface. */
120 private FcpInterface fcpInterface;
122 /** The l10n helper. */
123 private PluginL10n l10n;
125 /** The web of trust connector. */
126 private WebOfTrustConnector webOfTrustConnector;
128 public SonePlugin() {
129 this(Guice::createInjector);
133 public SonePlugin(Function1<Module[], Injector> injectorCreator) {
134 this.injectorCreator = injectorCreator;
142 * Returns the plugin respirator for this plugin.
144 * @return The plugin respirator
146 public PluginRespirator pluginRespirator() {
147 return pluginRespirator;
151 * Returns the core started by this plugin.
160 * Returns the plugin’s l10n helper.
162 * @return The plugin’s l10n helper
164 public PluginL10n l10n() {
168 public static String getPluginVersion() {
169 net.pterodactylus.sone.main.Version version = VersionParserKt.getParsedVersion();
170 return (version == null) ? "unknown" : version.getNice();
173 public int getYear() {
177 public String getHomepage() {
178 return SONE_HOMEPAGE + LATEST_EDITION;
181 public static long getLatestEdition() {
182 return LATEST_EDITION;
186 // FREDPLUGIN METHODS
193 public void runPlugin(PluginRespirator pluginRespirator) {
194 this.pluginRespirator = pluginRespirator;
196 Injector injector = createInjector();
197 core = injector.getInstance(Core.class);
199 /* create web of trust connector. */
200 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
202 /* create FCP interface. */
203 fcpInterface = injector.getInstance(FcpInterface.class);
205 /* create the web interface. */
206 webInterface = injector.getInstance(WebInterface.class);
208 /* we need to request this to install all notification handlers. */
209 injector.getInstance(NotificationHandler.class);
211 /* and this is required to shutdown all tickers. */
212 injector.getInstance(TickerShutdown.class);
217 /* start the web interface! */
218 webInterface.start();
220 /* send some events on startup */
221 eventBus = injector.getInstance(EventBus.class);
224 if (injector.getInstance(Key.get(Boolean.class, Names.named("FirstStart")))) {
225 eventBus.post(new FirstStart());
228 if (injector.getInstance(Key.get(Boolean.class, Names.named("NewConfig")))) {
229 eventBus.post(new ConfigNotRead());
233 eventBus.post(new Startup());
237 protected Injector createInjector() {
238 FreenetModule freenetModule = new FreenetModule(pluginRespirator);
239 AbstractModule soneModule = new SoneModule(this, new EventBus());
240 Module webInterfaceModule = new WebInterfaceModule();
241 Module notificationHandlerModule = new NotificationHandlerModule();
243 return createInjector(freenetModule, soneModule, webInterfaceModule, notificationHandlerModule);
247 protected Injector createInjector(Module... modules) {
248 return injectorCreator.invoke(modules);
255 public void terminate() {
256 /* send shutdown event. */
257 eventBus.post(new Shutdown());
260 /* stop the web interface. */
266 /* stop the web of trust connector. */
267 webOfTrustConnector.stop();
268 } catch (Throwable t1) {
269 logger.log(Level.SEVERE, "Error while shutting down!", t1);
271 deregisterLoggerHandlers();
275 private void deregisterLoggerHandlers() {
276 for (Handler handler : soneLogger.getHandlers()) {
277 soneLogger.removeHandler(handler);
282 // INTERFACE FredPluginFCP
289 public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
290 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
294 // INTERFACE FredPluginL10n
301 public String getString(String key) {
302 return l10n.getBase().getString(key);
309 public void setLanguage(LANGUAGE newLanguage) {
310 l10n = new PluginL10n(this, newLanguage);
314 // INTERFACE FredPluginBaseL10n
321 public String getL10nFilesBasePath() {
329 public String getL10nFilesMask() {
330 return "sone.${lang}.properties";
337 public String getL10nOverrideFilesMask() {
338 return "sone.${lang}.override.properties";
345 public ClassLoader getPluginClassLoader() {
346 return SonePlugin.class.getClassLoader();
350 // INTERFACE FredPluginVersioned
357 public String getVersion() {
358 return getPluginVersion();