src/main/java/net/pterodactylus/sone/main/SonePlugin.java

   1 /*
   2  * Sone - SonePlugin.java - Copyright © 2010–2013 David Roden
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.pterodactylus.sone.main;
  19
  20 import static com.google.common.base.Optional.of;
  21 import static java.util.logging.Logger.getLogger;
  22
  23 import java.io.File;
  24 import java.util.logging.Handler;
  25 import java.util.logging.Level;
  26 import java.util.logging.LogRecord;
  27 import java.util.logging.Logger;
  28
  29 import net.pterodactylus.sone.core.Core;
  30 import net.pterodactylus.sone.core.FreenetInterface;
  31 import net.pterodactylus.sone.core.WebOfTrustUpdater;
  32 import net.pterodactylus.sone.core.WebOfTrustUpdaterImpl;
  33 import net.pterodactylus.sone.database.Database;
  34 import net.pterodactylus.sone.database.PostBuilderFactory;
  35 import net.pterodactylus.sone.database.PostProvider;
  36 import net.pterodactylus.sone.database.PostReplyBuilderFactory;
  37 import net.pterodactylus.sone.database.SoneProvider;
  38 import net.pterodactylus.sone.database.memory.MemoryDatabase;
  39 import net.pterodactylus.sone.fcp.FcpInterface;
  40 import net.pterodactylus.sone.freenet.PluginStoreConfigurationBackend;
  41 import net.pterodactylus.sone.freenet.plugin.PluginConnector;
  42 import net.pterodactylus.sone.freenet.wot.Context;
  43 import net.pterodactylus.sone.freenet.wot.IdentityManager;
  44 import net.pterodactylus.sone.freenet.wot.IdentityManagerImpl;
  45 import net.pterodactylus.sone.freenet.wot.WebOfTrustConnector;
  46 import net.pterodactylus.sone.web.WebInterface;
  47 import net.pterodactylus.util.config.Configuration;
  48 import net.pterodactylus.util.config.ConfigurationException;
  49 import net.pterodactylus.util.config.MapConfigurationBackend;
  50 import net.pterodactylus.util.version.Version;
  51
  52 import com.google.common.base.Optional;
  53 import com.google.common.eventbus.EventBus;
  54 import com.google.inject.AbstractModule;
  55 import com.google.inject.Guice;
  56 import com.google.inject.Injector;
  57 import com.google.inject.Singleton;
  58 import com.google.inject.TypeLiteral;
  59 import com.google.inject.matcher.Matchers;
  60 import com.google.inject.spi.InjectionListener;
  61 import com.google.inject.spi.TypeEncounter;
  62 import com.google.inject.spi.TypeListener;
  63
  64 import freenet.client.async.DatabaseDisabledException;
  65 import freenet.l10n.BaseL10n.LANGUAGE;
  66 import freenet.l10n.PluginL10n;
  67 import freenet.node.Node;
  68 import freenet.pluginmanager.FredPlugin;
  69 import freenet.pluginmanager.FredPluginBaseL10n;
  70 import freenet.pluginmanager.FredPluginFCP;
  71 import freenet.pluginmanager.FredPluginL10n;
  72 import freenet.pluginmanager.FredPluginThreadless;
  73 import freenet.pluginmanager.FredPluginVersioned;
  74 import freenet.pluginmanager.PluginReplySender;
  75 import freenet.pluginmanager.PluginRespirator;
  76 import freenet.support.SimpleFieldSet;
  77 import freenet.support.api.Bucket;
  78
  79 /**
  80  * This class interfaces with Freenet. It is the class that is loaded by the
  81  * node and starts up the whole Sone system.
  82  *
  83  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  84  */
  85 public class SonePlugin implements FredPlugin, FredPluginFCP, FredPluginL10n, FredPluginBaseL10n, FredPluginThreadless, FredPluginVersioned {
  86
  87         static {
  88                 /* initialize logging. */
  89                 Logger soneLogger = getLogger("Sone");
  90                 soneLogger.addHandler(new Handler() {
  91                         @Override
  92                         public void publish(LogRecord logRecord) {
  93                                 int recordLevel = logRecord.getLevel().intValue();
  94                                 if (recordLevel < Level.FINE.intValue()) {
  95                                         freenet.support.Logger.debug(logRecord.getLoggerName(), logRecord.getMessage(), logRecord.getThrown());
  96                                 } else if (recordLevel < Level.INFO.intValue()) {
  97                                         freenet.support.Logger.minor(logRecord.getLoggerName(), logRecord.getMessage(), logRecord.getThrown());
  98                                 } else if (recordLevel < Level.WARNING.intValue()) {
  99                                         freenet.support.Logger.normal(logRecord.getLoggerName(), logRecord.getMessage(), logRecord.getThrown());
 100                                 } else if (recordLevel < Level.SEVERE.intValue()) {
 101                                         freenet.support.Logger.warning(logRecord.getLoggerName(), logRecord.getMessage(), logRecord.getThrown());
 102                                 } else {
 103                                         freenet.support.Logger.error(logRecord.getLoggerName(), logRecord.getMessage(), logRecord.getThrown());
 104                                 }
 105                         }
 106
 107                         @Override
 108                         public void flush() {
 109                         }
 110
 111                         @Override
 112                         public void close() {
 113                         }
 114                 });
 115         }
 116
 117         /** The version. */
 118         public static final Version VERSION = new Version(0, 8, 9);
 119
 120         /** The logger. */
 121         private static final Logger logger = getLogger("Sone.Plugin");
 122
 123         /** The plugin respirator. */
 124         private PluginRespirator pluginRespirator;
 125
 126         /** The core. */
 127         private Core core;
 128
 129         /** The web interface. */
 130         private WebInterface webInterface;
 131
 132         /** The FCP interface. */
 133         private FcpInterface fcpInterface;
 134
 135         /** The l10n helper. */
 136         private PluginL10n l10n;
 137
 138         /** The web of trust connector. */
 139         private WebOfTrustConnector webOfTrustConnector;
 140
 141         //
 142         // ACCESSORS
 143         //
 144
 145         /**
 146          * Returns the plugin respirator for this plugin.
 147          *
 148          * @return The plugin respirator
 149          */
 150         public PluginRespirator pluginRespirator() {
 151                 return pluginRespirator;
 152         }
 153
 154         /**
 155          * Returns the core started by this plugin.
 156          *
 157          * @return The core
 158          */
 159         public Core core() {
 160                 return core;
 161         }
 162
 163         /**
 164          * Returns the plugin’s l10n helper.
 165          *
 166          * @return The plugin’s l10n helper
 167          */
 168         public PluginL10n l10n() {
 169                 return l10n;
 170         }
 171
 172         //
 173         // FREDPLUGIN METHODS
 174         //
 175
 176         /**
 177          * {@inheritDoc}
 178          */
 179         @Override
 180         public void runPlugin(PluginRespirator pluginRespirator) {
 181                 this.pluginRespirator = pluginRespirator;
 182
 183                 /* create a configuration. */
 184                 Configuration oldConfiguration;
 185                 Configuration newConfiguration = null;
 186                 boolean firstStart = !new File("sone.properties").exists();
 187                 boolean newConfig = false;
 188                 try {
 189                         oldConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), false));
 190                         newConfiguration = oldConfiguration;
 191                 } catch (ConfigurationException ce1) {
 192                         newConfig = true;
 193                         logger.log(Level.INFO, "Could not load configuration file, trying plugin store…", ce1);
 194                         try {
 195                                 newConfiguration = new Configuration(new MapConfigurationBackend(new File("sone.properties"), true));
 196                                 logger.log(Level.INFO, "Created new configuration file.");
 197                         } catch (ConfigurationException ce2) {
 198                                 logger.log(Level.SEVERE, "Could not create configuration file, using Plugin Store!", ce2);
 199                         }
 200                         try {
 201                                 oldConfiguration = new Configuration(new PluginStoreConfigurationBackend(pluginRespirator));
 202                                 logger.log(Level.INFO, "Plugin store loaded.");
 203                         } catch (DatabaseDisabledException dde1) {
 204                                 logger.log(Level.SEVERE, "Could not load any configuration, using empty configuration!");
 205                                 oldConfiguration = new Configuration(new MapConfigurationBackend());
 206                         }
 207                 }
 208
 209                 final Configuration startConfiguration;
 210                 if ((newConfiguration != null) && (oldConfiguration != newConfiguration)) {
 211                         logger.log(Level.INFO, "Setting configuration to file-based configuration.");
 212                         startConfiguration = newConfiguration;
 213                 } else {
 214                         startConfiguration = oldConfiguration;
 215                 }
 216                 final EventBus eventBus = new EventBus();
 217
 218                 /* Freenet injector configuration. */
 219                 AbstractModule freenetModule = new AbstractModule() {
 220
 221                         @Override
 222                         @SuppressWarnings("synthetic-access")
 223                         protected void configure() {
 224                                 bind(PluginRespirator.class).toInstance(SonePlugin.this.pluginRespirator);
 225                                 bind(Node.class).toInstance(SonePlugin.this.pluginRespirator.getNode());
 226                         }
 227                 };
 228                 /* Sone injector configuration. */
 229                 AbstractModule soneModule = new AbstractModule() {
 230
 231                         @Override
 232                         protected void configure() {
 233                                 bind(EventBus.class).toInstance(eventBus);
 234                                 bind(Configuration.class).toInstance(startConfiguration);
 235                                 Context context = new Context("Sone");
 236                                 bind(Context.class).toInstance(context);
 237                                 bind(getOptionalContextTypeLiteral()).toInstance(of(context));
 238                                 bind(SonePlugin.class).toInstance(SonePlugin.this);
 239                                 bindListener(Matchers.any(), new TypeListener() {
 240
 241                                         @Override
 242                                         public <I> void hear(TypeLiteral<I> typeLiteral, TypeEncounter<I> typeEncounter) {
 243                                                 typeEncounter.register(new InjectionListener<I>() {
 244
 245                                                         @Override
 246                                                         public void afterInjection(I injectee) {
 247                                                                 eventBus.register(injectee);
 248                                                         }
 249                                                 });
 250                                         }
 251                                 });
 252                         }
 253
 254                         private TypeLiteral<Optional<Context>> getOptionalContextTypeLiteral() {
 255                                 return new TypeLiteral<Optional<Context>>() {
 256                                 };
 257                         }
 258
 259                 };
 260                 Injector injector = Guice.createInjector(freenetModule, soneModule);
 261                 core = injector.getInstance(Core.class);
 262
 263                 /* create web of trust connector. */
 264                 webOfTrustConnector = injector.getInstance(WebOfTrustConnector.class);
 265
 266                 /* create FCP interface. */
 267                 fcpInterface = injector.getInstance(FcpInterface.class);
 268
 269                 /* create the web interface. */
 270                 webInterface = injector.getInstance(WebInterface.class);
 271
 272                 /* start core! */
 273                 core.start();
 274                 webInterface.start();
 275                 webInterface.setFirstStart(firstStart);
 276                 webInterface.setNewConfig(newConfig);
 277         }
 278
 279         /**
 280          * {@inheritDoc}
 281          */
 282         @Override
 283         public void terminate() {
 284                 try {
 285                         /* stop the web interface. */
 286                         webInterface.stop();
 287
 288                         /* stop the core. */
 289                         core.stop();
 290
 291                         /* stop the web of trust connector. */
 292                         webOfTrustConnector.stop();
 293                 } catch (Throwable t1) {
 294                         logger.log(Level.SEVERE, "Error while shutting down!", t1);
 295                 }
 296         }
 297
 298         //
 299         // INTERFACE FredPluginFCP
 300         //
 301
 302         /**
 303          * {@inheritDoc}
 304          */
 305         @Override
 306         public void handle(PluginReplySender pluginReplySender, SimpleFieldSet parameters, Bucket data, int accessType) {
 307                 fcpInterface.handle(pluginReplySender, parameters, data, accessType);
 308         }
 309
 310         //
 311         // INTERFACE FredPluginL10n
 312         //
 313
 314         /**
 315          * {@inheritDoc}
 316          */
 317         @Override
 318         public String getString(String key) {
 319                 return l10n.getBase().getString(key);
 320         }
 321
 322         /**
 323          * {@inheritDoc}
 324          */
 325         @Override
 326         public void setLanguage(LANGUAGE newLanguage) {
 327                 l10n = new PluginL10n(this, newLanguage);
 328         }
 329
 330         //
 331         // INTERFACE FredPluginBaseL10n
 332         //
 333
 334         /**
 335          * {@inheritDoc}
 336          */
 337         @Override
 338         public String getL10nFilesBasePath() {
 339                 return "i18n";
 340         }
 341
 342         /**
 343          * {@inheritDoc}
 344          */
 345         @Override
 346         public String getL10nFilesMask() {
 347                 return "sone.${lang}.properties";
 348         }
 349
 350         /**
 351          * {@inheritDoc}
 352          */
 353         @Override
 354         public String getL10nOverrideFilesMask() {
 355                 return "sone.${lang}.override.properties";
 356         }
 357
 358         /**
 359          * {@inheritDoc}
 360          */
 361         @Override
 362         public ClassLoader getPluginClassLoader() {
 363                 return SonePlugin.class.getClassLoader();
 364         }
 365
 366         //
 367         // INTERFACE FredPluginVersioned
 368         //
 369
 370         /**
 371          * {@inheritDoc}
 372          */
 373         @Override
 374         public String getVersion() {
 375                 return VERSION.toString();
 376         }
 377
 378 }