org.argeo.cms/src/org/argeo/cms/internal/kernel/CmsState.java

   1 package org.argeo.cms.internal.kernel;
   2
   3 import static bitronix.tm.TransactionManagerServices.getTransactionManager;
   4 import static bitronix.tm.TransactionManagerServices.getTransactionSynchronizationRegistry;
   5 import static java.util.Locale.ENGLISH;
   6 import static org.argeo.cms.internal.auth.LocaleChoice.asLocaleList;
   7
   8 import java.io.File;
   9 import java.net.InetAddress;
  10 import java.net.UnknownHostException;
  11 import java.util.ArrayList;
  12 import java.util.Dictionary;
  13 import java.util.Hashtable;
  14 import java.util.List;
  15 import java.util.Locale;
  16 import java.util.UUID;
  17
  18 import javax.jcr.RepositoryFactory;
  19 import javax.transaction.TransactionManager;
  20 import javax.transaction.TransactionSynchronizationRegistry;
  21 import javax.transaction.UserTransaction;
  22
  23 import org.apache.commons.logging.Log;
  24 import org.apache.commons.logging.LogFactory;
  25 import org.argeo.cms.auth.AuthConstants;
  26 import org.argeo.cms.maintenance.MaintenanceUi;
  27 import org.argeo.node.NodeConstants;
  28 import org.argeo.node.NodeState;
  29 import org.argeo.util.LangUtils;
  30 import org.eclipse.rap.rwt.application.ApplicationConfiguration;
  31 import org.osgi.framework.Bundle;
  32 import org.osgi.framework.BundleContext;
  33 import org.osgi.framework.Constants;
  34 import org.osgi.framework.FrameworkUtil;
  35 import org.osgi.framework.ServiceReference;
  36 import org.osgi.service.cm.ManagedServiceFactory;
  37
  38 import bitronix.tm.BitronixTransactionManager;
  39 import bitronix.tm.BitronixTransactionSynchronizationRegistry;
  40 import bitronix.tm.TransactionManagerServices;
  41
  42 public class CmsState implements NodeState {
  43         private final Log log = LogFactory.getLog(CmsState.class);
  44         private final BundleContext bc = FrameworkUtil.getBundle(CmsState.class).getBundleContext();
  45
  46         // REFERENCES
  47         private Long availableSince;
  48
  49         // i18n
  50         private Locale defaultLocale;
  51         private List<Locale> locales = null;
  52
  53         private ThreadGroup threadGroup = new ThreadGroup("CMS");
  54         private KernelThread kernelThread;
  55         private List<Runnable> shutdownHooks = new ArrayList<>();
  56
  57         private final String stateUuid;
  58         private final boolean cleanState;
  59         private String hostname;
  60
  61         public CmsState(String stateUuid) {
  62                 this.stateUuid = stateUuid;
  63                 String frameworkUuid = KernelUtils.getFrameworkProp(Constants.FRAMEWORK_UUID);
  64                 this.cleanState = stateUuid.equals(frameworkUuid);
  65                 try {
  66                         this.hostname = InetAddress.getLocalHost().getHostName();
  67                 } catch (UnknownHostException e) {
  68                         log.error("Cannot set hostname", e);
  69                 }
  70
  71                 availableSince = System.currentTimeMillis();
  72                 if (log.isDebugEnabled())
  73                         log.debug("## CMS STARTED " + this.stateUuid + (cleanState ? " (clean state) " : " "));
  74
  75                 initI18n();
  76                 initServices();
  77
  78                 // kernel thread
  79                 kernelThread = new KernelThread(threadGroup, "Kernel Thread");
  80                 kernelThread.setContextClassLoader(getClass().getClassLoader());
  81                 kernelThread.start();
  82         }
  83
  84         private void initI18n() {
  85                 Object defaultLocaleValue = KernelUtils.getFrameworkProp(NodeConstants.I18N_DEFAULT_LOCALE);
  86                 defaultLocale = defaultLocaleValue != null ? new Locale(defaultLocaleValue.toString())
  87                                 : new Locale(ENGLISH.getLanguage());
  88                 locales = asLocaleList(KernelUtils.getFrameworkProp(NodeConstants.I18N_LOCALES));
  89         }
  90
  91         private void initServices() {
  92                 // JTA
  93                 initTransactionManager();
  94
  95                 // JCR
  96                 RepositoryServiceFactory repositoryServiceFactory = new RepositoryServiceFactory();
  97                 shutdownHooks.add(() -> repositoryServiceFactory.shutdown());
  98                 bc.registerService(ManagedServiceFactory.class, repositoryServiceFactory,
  99                                 LangUtils.init(Constants.SERVICE_PID, NodeConstants.NODE_REPOS_FACTORY_PID));
 100
 101                 NodeRepositoryFactory repositoryFactory = new NodeRepositoryFactory();
 102                 bc.registerService(RepositoryFactory.class, repositoryFactory, null);
 103
 104                 // Security
 105                 NodeUserAdmin userAdmin = new NodeUserAdmin(AuthConstants.ROLES_BASEDN);
 106                 shutdownHooks.add(() -> userAdmin.destroy());
 107                 Dictionary<String, Object> props = new Hashtable<>();
 108                 props.put(Constants.SERVICE_PID, NodeConstants.NODE_USER_ADMIN_PID);
 109                 bc.registerService(ManagedServiceFactory.class, userAdmin, props);
 110
 111                 // UI
 112                 bc.registerService(ApplicationConfiguration.class, new MaintenanceUi(),
 113                                 LangUtils.init(KernelConstants.CONTEXT_NAME_PROP, "system"));
 114                 bc.registerService(ApplicationConfiguration.class, new UserUi(),
 115                                 LangUtils.init(KernelConstants.CONTEXT_NAME_PROP, "user"));
 116         }
 117
 118         private void initTransactionManager() {
 119                 // TODO manage it in a managed service, as startup could be long
 120                 ServiceReference<TransactionManager> existingTm = bc.getServiceReference(TransactionManager.class);
 121                 if (existingTm != null) {
 122                         if (log.isDebugEnabled())
 123                                 log.debug("Using provided transaction manager " + existingTm);
 124                 }
 125                 bitronix.tm.Configuration tmConf = TransactionManagerServices.getConfiguration();
 126                 tmConf.setServerId(UUID.randomUUID().toString());
 127
 128                 Bundle bitronixBundle = FrameworkUtil.getBundle(bitronix.tm.Configuration.class);
 129                 File tmBaseDir = bitronixBundle.getDataFile(KernelConstants.DIR_TRANSACTIONS);
 130                 File tmDir1 = new File(tmBaseDir, "btm1");
 131                 tmDir1.mkdirs();
 132                 tmConf.setLogPart1Filename(new File(tmDir1, tmDir1.getName() + ".tlog").getAbsolutePath());
 133                 File tmDir2 = new File(tmBaseDir, "btm2");
 134                 tmDir2.mkdirs();
 135                 tmConf.setLogPart2Filename(new File(tmDir2, tmDir2.getName() + ".tlog").getAbsolutePath());
 136
 137                 BitronixTransactionManager transactionManager = getTransactionManager();
 138                 shutdownHooks.add(() -> transactionManager.shutdown());
 139                 BitronixTransactionSynchronizationRegistry transactionSynchronizationRegistry = getTransactionSynchronizationRegistry();
 140                 // register
 141                 bc.registerService(TransactionManager.class, transactionManager, null);
 142                 bc.registerService(UserTransaction.class, transactionManager, null);
 143                 bc.registerService(TransactionSynchronizationRegistry.class, transactionSynchronizationRegistry, null);
 144                 if (log.isDebugEnabled())
 145                         log.debug("Initialised default Bitronix transaction manager");
 146         }
 147
 148         void shutdown() {
 149                 applyShutdownHooks();
 150
 151                 if (kernelThread != null)
 152                         kernelThread.destroyAndJoin();
 153
 154                 if (log.isDebugEnabled())
 155                         log.debug("## CMS STOPPED");
 156         }
 157
 158         /** Apply shutdown hoos in reverse order. */
 159         private void applyShutdownHooks() {
 160                 for (int i = shutdownHooks.size() - 1; i >= 0; i--) {
 161                         try {
 162                                 shutdownHooks.get(i).run();
 163                         } catch (Exception e) {
 164                                 log.error("Could not run shutdown hook #" + i);
 165                         }
 166                 }
 167                 // Clean hanging Gogo shell thread
 168                 new GogoShellKiller().start();
 169         }
 170
 171         @Override
 172         public boolean isClean() {
 173                 return cleanState;
 174         }
 175
 176         @Override
 177         public Long getAvailableSince() {
 178                 return availableSince;
 179         }
 180
 181         /*
 182          * ACCESSORS
 183          */
 184         public Locale getDefaultLocale() {
 185                 return defaultLocale;
 186         }
 187
 188         public List<Locale> getLocales() {
 189                 return locales;
 190         }
 191
 192         public String getHostname() {
 193                 return hostname;
 194         }
 195
 196         /** Workaround for blocking Gogo shell by system shutdown. */
 197         private class GogoShellKiller extends Thread {
 198
 199                 public GogoShellKiller() {
 200                         super("Gogo Shell Killer");
 201                         setDaemon(true);
 202                 }
 203
 204                 @Override
 205                 public void run() {
 206                         ThreadGroup rootTg = getRootThreadGroup(null);
 207                         Thread gogoShellThread = findGogoShellThread(rootTg);
 208                         if (gogoShellThread == null)
 209                                 return;
 210                         while (getNonDaemonCount(rootTg) > 2) {
 211                                 try {
 212                                         Thread.sleep(100);
 213                                 } catch (InterruptedException e) {
 214                                         // silent
 215                                 }
 216                         }
 217                         gogoShellThread = findGogoShellThread(rootTg);
 218                         if (gogoShellThread == null)
 219                                 return;
 220                         System.exit(0);
 221                 }
 222         }
 223
 224         private static ThreadGroup getRootThreadGroup(ThreadGroup tg) {
 225                 if (tg == null)
 226                         tg = Thread.currentThread().getThreadGroup();
 227                 if (tg.getParent() == null)
 228                         return tg;
 229                 else
 230                         return getRootThreadGroup(tg.getParent());
 231         }
 232
 233         private static int getNonDaemonCount(ThreadGroup rootThreadGroup) {
 234                 Thread[] threads = new Thread[rootThreadGroup.activeCount()];
 235                 rootThreadGroup.enumerate(threads);
 236                 int nonDameonCount = 0;
 237                 for (Thread t : threads)
 238                         if (t != null && !t.isDaemon())
 239                                 nonDameonCount++;
 240                 return nonDameonCount;
 241         }
 242
 243         private static Thread findGogoShellThread(ThreadGroup rootThreadGroup) {
 244                 Thread[] threads = new Thread[rootThreadGroup.activeCount()];
 245                 rootThreadGroup.enumerate(threads, true);
 246                 for (Thread thread : threads) {
 247                         if (thread.getName().equals("Gogo shell"))
 248                                 return thread;
 249                 }
 250                 return null;
 251         }
 252
 253 }