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

   1 package org.argeo.cms.internal.kernel;
   2
   3 import java.io.IOException;
   4 import java.io.InputStream;
   5 import java.io.Writer;
   6 import java.nio.file.Files;
   7 import java.nio.file.Path;
   8 import java.util.ArrayList;
   9 import java.util.Dictionary;
  10 import java.util.List;
  11 import java.util.SortedMap;
  12 import java.util.TreeMap;
  13
  14 import javax.naming.InvalidNameException;
  15 import javax.naming.directory.Attributes;
  16 import javax.naming.directory.BasicAttributes;
  17 import javax.naming.ldap.LdapName;
  18 import javax.naming.ldap.Rdn;
  19
  20 import org.apache.commons.logging.Log;
  21 import org.apache.commons.logging.LogFactory;
  22 import org.argeo.cms.CmsException;
  23 import org.argeo.naming.AttributesDictionary;
  24 import org.argeo.naming.LdifParser;
  25 import org.argeo.naming.LdifWriter;
  26 import org.argeo.node.NodeConstants;
  27 import org.argeo.osgi.useradmin.UserAdminConf;
  28 import org.osgi.framework.BundleContext;
  29 import org.osgi.framework.FrameworkUtil;
  30 import org.osgi.service.cm.Configuration;
  31 import org.osgi.service.cm.ConfigurationAdmin;
  32 import org.osgi.service.cm.ConfigurationEvent;
  33 import org.osgi.service.cm.ConfigurationListener;
  34
  35 class DeployConfig implements ConfigurationListener {
  36         private final Log log = LogFactory.getLog(getClass());
  37         private final BundleContext bc = FrameworkUtil.getBundle(getClass()).getBundleContext();
  38
  39         private static Path deployConfigPath = KernelUtils.getOsgiInstancePath(KernelConstants.DEPLOY_CONFIG_PATH);
  40         private SortedMap<LdapName, Attributes> deployConfigs = new TreeMap<>();
  41         private final DataModels dataModels;
  42
  43         public DeployConfig(ConfigurationAdmin configurationAdmin, DataModels dataModels, boolean isClean) {
  44                 this.dataModels = dataModels;
  45                 // ConfigurationAdmin configurationAdmin =
  46                 // bc.getService(bc.getServiceReference(ConfigurationAdmin.class));
  47                 try {
  48                         boolean isFirstInit = false;
  49                         if (!isInitialized()) { // first init
  50                                 isFirstInit = true;
  51                                 firstInit();
  52                         }
  53                         init(configurationAdmin, isClean, isFirstInit);
  54                 } catch (IOException e) {
  55                         throw new CmsException("Could not init deploy configs", e);
  56                 }
  57                 // FIXME check race conditions during initialization
  58                 // bc.registerService(ConfigurationListener.class, this, null);
  59         }
  60
  61         private void firstInit() throws IOException {
  62                 log.info("## FIRST INIT ##");
  63                 Files.createDirectories(deployConfigPath.getParent());
  64
  65                 // FirstInit firstInit = new FirstInit();
  66                 InitUtils.prepareFirstInitInstanceArea();
  67
  68                 if (!Files.exists(deployConfigPath))
  69                         deployConfigs = new TreeMap<>();
  70                 else// config file could have juste been copied by preparation
  71                         try (InputStream in = Files.newInputStream(deployConfigPath)) {
  72                                 deployConfigs = new LdifParser().read(in);
  73                         }
  74                 save();
  75         }
  76
  77         private void setFromFrameworkProperties(boolean isFirstInit) {
  78                 // node repository
  79                 Dictionary<String, Object> nodeConfig = InitUtils
  80                                 .getNodeRepositoryConfig(getProps(NodeConstants.NODE_REPOS_FACTORY_PID, NodeConstants.NODE));
  81                 // node repository is mandatory
  82                 putFactoryDeployConfig(NodeConstants.NODE_REPOS_FACTORY_PID, nodeConfig);
  83
  84                 // additional repositories
  85                 dataModels: for (DataModels.DataModel dataModel : dataModels.getNonAbstractDataModels()) {
  86                         if (NodeConstants.NODE.equals(dataModel.getName()))
  87                                 continue dataModels;
  88                         Dictionary<String, Object> config = InitUtils.getRepositoryConfig(dataModel.getName(),
  89                                         getProps(NodeConstants.NODE_REPOS_FACTORY_PID, dataModel.getName()));
  90                         if (config.size() != 0)
  91                                 putFactoryDeployConfig(NodeConstants.NODE_REPOS_FACTORY_PID, config);
  92                 }
  93
  94                 // user admin
  95                 List<Dictionary<String, Object>> userDirectoryConfigs = InitUtils.getUserDirectoryConfigs();
  96                 if (userDirectoryConfigs.size() != 0) {
  97                         List<String> activeCns = new ArrayList<>();
  98                         for (int i = 0; i < userDirectoryConfigs.size(); i++) {
  99                                 Dictionary<String, Object> userDirectoryConfig = userDirectoryConfigs.get(i);
 100                                 String cn = UserAdminConf.baseDnHash(userDirectoryConfig);
 101                                 activeCns.add(cn);
 102                                 userDirectoryConfig.put(NodeConstants.CN, cn);
 103                                 putFactoryDeployConfig(NodeConstants.NODE_USER_ADMIN_PID, userDirectoryConfig);
 104                         }
 105                         // disable others
 106                         LdapName userAdminFactoryName = serviceFactoryDn(NodeConstants.NODE_USER_ADMIN_PID);
 107                         for (LdapName name : deployConfigs.keySet()) {
 108                                 if (name.startsWith(userAdminFactoryName) && !name.equals(userAdminFactoryName)) {
 109                                         try {
 110                                                 Attributes attrs = deployConfigs.get(name);
 111                                                 String cn = name.getRdn(name.size() - 1).getValue().toString();
 112                                                 if (!activeCns.contains(cn)) {
 113                                                         attrs.put(UserAdminConf.disabled.name(), "true");
 114                                                 }
 115                                         } catch (Exception e) {
 116                                                 throw new CmsException("Cannot disable user directory " + name, e);
 117                                         }
 118                                 }
 119                         }
 120                 }
 121
 122                 // http server
 123                 Dictionary<String, Object> webServerConfig = InitUtils
 124                                 .getHttpServerConfig(getProps(KernelConstants.JETTY_FACTORY_PID, NodeConstants.DEFAULT));
 125                 if (!webServerConfig.isEmpty()) {
 126                         webServerConfig.put("customizer.class", "org.argeo.equinox.jetty.WebSocketJettyCustomizer");
 127                         putFactoryDeployConfig(KernelConstants.JETTY_FACTORY_PID, webServerConfig);
 128                 }
 129                 save();
 130         }
 131
 132         private void init(ConfigurationAdmin configurationAdmin, boolean isClean, boolean isFirstInit) throws IOException {
 133
 134                 try (InputStream in = Files.newInputStream(deployConfigPath)) {
 135                         deployConfigs = new LdifParser().read(in);
 136                 }
 137                 if (isClean) {
 138                         setFromFrameworkProperties(isFirstInit);
 139                         for (LdapName dn : deployConfigs.keySet()) {
 140                                 Rdn lastRdn = dn.getRdn(dn.size() - 1);
 141                                 LdapName prefix = (LdapName) dn.getPrefix(dn.size() - 1);
 142                                 if (prefix.toString().equals(NodeConstants.DEPLOY_BASEDN)) {
 143                                         if (lastRdn.getType().equals(NodeConstants.CN)) {
 144                                                 // service
 145                                                 String pid = lastRdn.getValue().toString();
 146                                                 Configuration conf = configurationAdmin.getConfiguration(pid);
 147                                                 AttributesDictionary dico = new AttributesDictionary(deployConfigs.get(dn));
 148                                                 conf.update(dico);
 149                                         } else {
 150                                                 // service factory definition
 151                                         }
 152                                 } else {
 153                                         // service factory service
 154                                         Rdn beforeLastRdn = dn.getRdn(dn.size() - 2);
 155                                         assert beforeLastRdn.getType().equals(NodeConstants.OU);
 156                                         String factoryPid = beforeLastRdn.getValue().toString();
 157                                         Configuration conf = configurationAdmin.createFactoryConfiguration(factoryPid.toString(), null);
 158                                         AttributesDictionary dico = new AttributesDictionary(deployConfigs.get(dn));
 159                                         conf.update(dico);
 160                                 }
 161                         }
 162                 }
 163                 // TODO check consistency if not clean
 164         }
 165
 166         @Override
 167         public void configurationEvent(ConfigurationEvent event) {
 168                 try {
 169                         if (ConfigurationEvent.CM_UPDATED == event.getType()) {
 170                                 ConfigurationAdmin configurationAdmin = bc.getService(event.getReference());
 171                                 Configuration conf = configurationAdmin.getConfiguration(event.getPid(), null);
 172                                 LdapName serviceDn = null;
 173                                 String factoryPid = conf.getFactoryPid();
 174                                 if (factoryPid != null) {
 175                                         LdapName serviceFactoryDn = serviceFactoryDn(factoryPid);
 176                                         if (deployConfigs.containsKey(serviceFactoryDn)) {
 177                                                 for (LdapName dn : deployConfigs.keySet()) {
 178                                                         if (dn.startsWith(serviceFactoryDn)) {
 179                                                                 Rdn lastRdn = dn.getRdn(dn.size() - 1);
 180                                                                 assert lastRdn.getType().equals(NodeConstants.CN);
 181                                                                 Object value = conf.getProperties().get(lastRdn.getType());
 182                                                                 assert value != null;
 183                                                                 if (value.equals(lastRdn.getValue())) {
 184                                                                         serviceDn = dn;
 185                                                                         break;
 186                                                                 }
 187                                                         }
 188                                                 }
 189
 190                                                 Object cn = conf.getProperties().get(NodeConstants.CN);
 191                                                 if (cn == null)
 192                                                         throw new IllegalArgumentException("Properties must contain cn");
 193                                                 if (serviceDn == null) {
 194                                                         putFactoryDeployConfig(factoryPid, conf.getProperties());
 195                                                 } else {
 196                                                         Attributes attrs = deployConfigs.get(serviceDn);
 197                                                         assert attrs != null;
 198                                                         AttributesDictionary.copy(conf.getProperties(), attrs);
 199                                                 }
 200                                                 save();
 201                                                 if (log.isDebugEnabled())
 202                                                         log.debug("Updated deploy config " + serviceDn(factoryPid, cn.toString()));
 203                                         } else {
 204                                                 // ignore non config-registered service factories
 205                                         }
 206                                 } else {
 207                                         serviceDn = serviceDn(event.getPid());
 208                                         if (deployConfigs.containsKey(serviceDn)) {
 209                                                 Attributes attrs = deployConfigs.get(serviceDn);
 210                                                 assert attrs != null;
 211                                                 AttributesDictionary.copy(conf.getProperties(), attrs);
 212                                                 save();
 213                                                 if (log.isDebugEnabled())
 214                                                         log.debug("Updated deploy config " + serviceDn);
 215                                         } else {
 216                                                 // ignore non config-registered services
 217                                         }
 218                                 }
 219                         }
 220                 } catch (Exception e) {
 221                         log.error("Could not handle configuration event", e);
 222                 }
 223         }
 224
 225         void putFactoryDeployConfig(String factoryPid, Dictionary<String, Object> props) {
 226                 Object cn = props.get(NodeConstants.CN);
 227                 if (cn == null)
 228                         throw new IllegalArgumentException("cn must be set in properties");
 229                 LdapName serviceFactoryDn = serviceFactoryDn(factoryPid);
 230                 if (!deployConfigs.containsKey(serviceFactoryDn))
 231                         deployConfigs.put(serviceFactoryDn, new BasicAttributes(NodeConstants.OU, factoryPid));
 232                 LdapName serviceDn = serviceDn(factoryPid, cn.toString());
 233                 Attributes attrs = new BasicAttributes();
 234                 AttributesDictionary.copy(props, attrs);
 235                 deployConfigs.put(serviceDn, attrs);
 236         }
 237
 238         void putDeployConfig(String servicePid, Dictionary<String, Object> props) {
 239                 LdapName serviceDn = serviceDn(servicePid);
 240                 Attributes attrs = new BasicAttributes(NodeConstants.CN, servicePid);
 241                 AttributesDictionary.copy(props, attrs);
 242                 deployConfigs.put(serviceDn, attrs);
 243         }
 244
 245         void save() {
 246                 try (Writer writer = Files.newBufferedWriter(deployConfigPath)) {
 247                         new LdifWriter(writer).write(deployConfigs);
 248                 } catch (IOException e) {
 249                         // throw new CmsException("Cannot save deploy configs", e);
 250                         log.error("Cannot save deploy configs", e);
 251                 }
 252         }
 253
 254         boolean isStandalone(String dataModelName) {
 255                 return getProps(NodeConstants.NODE_REPOS_FACTORY_PID, dataModelName) != null;
 256         }
 257
 258         /*
 259          * UTILITIES
 260          */
 261         private LdapName serviceFactoryDn(String factoryPid) {
 262                 try {
 263                         return new LdapName(NodeConstants.OU + "=" + factoryPid + "," + NodeConstants.DEPLOY_BASEDN);
 264                 } catch (InvalidNameException e) {
 265                         throw new IllegalArgumentException("Cannot generate DN from " + factoryPid, e);
 266                 }
 267         }
 268
 269         private LdapName serviceDn(String servicePid) {
 270                 try {
 271                         return new LdapName(NodeConstants.CN + "=" + servicePid + "," + NodeConstants.DEPLOY_BASEDN);
 272                 } catch (InvalidNameException e) {
 273                         throw new IllegalArgumentException("Cannot generate DN from " + servicePid, e);
 274                 }
 275         }
 276
 277         private LdapName serviceDn(String factoryPid, String cn) {
 278                 try {
 279                         return (LdapName) serviceFactoryDn(factoryPid).add(new Rdn(NodeConstants.CN, cn));
 280                 } catch (InvalidNameException e) {
 281                         throw new IllegalArgumentException("Cannot generate DN from " + factoryPid + " and " + cn, e);
 282                 }
 283         }
 284
 285         Dictionary<String, Object> getProps(String factoryPid, String cn) {
 286                 Attributes attrs = deployConfigs.get(serviceDn(factoryPid, cn));
 287                 if (attrs != null)
 288                         return new AttributesDictionary(attrs);
 289                 else
 290                         return null;
 291         }
 292
 293         static boolean isInitialized() {
 294                 return Files.exists(deployConfigPath);
 295         }
 296
 297 }