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