Move all JCR servlets to OSGi WhiteBoard.
[lgpl/argeo-commons.git] / org.argeo.cms / src / org / argeo / cms / internal / kernel / CmsDeployment.java
index 59d8c910f9640c287d564d924ac5da48db1a378a..51feed9214aeab6065217a125acaf17bc1037259 100644 (file)
@@ -1,12 +1,16 @@
 package org.argeo.cms.internal.kernel;
 
-import static org.argeo.node.DataModelNamespace.CMS_DATA_MODEL_NAMESPACE;
+import static org.argeo.api.DataModelNamespace.CMS_DATA_MODEL_NAMESPACE;
+import static org.osgi.service.http.whiteboard.HttpWhiteboardConstants.HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX;
 
 import java.io.File;
+import java.io.IOException;
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.lang.management.ManagementFactory;
 import java.net.URL;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.HashSet;
@@ -19,6 +23,7 @@ import javax.jcr.Repository;
 import javax.jcr.RepositoryException;
 import javax.jcr.Session;
 import javax.security.auth.callback.CallbackHandler;
+import javax.servlet.Servlet;
 import javax.transaction.UserTransaction;
 
 import org.apache.commons.logging.Log;
@@ -26,15 +31,18 @@ import org.apache.commons.logging.LogFactory;
 import org.apache.jackrabbit.commons.cnd.CndImporter;
 import org.apache.jackrabbit.core.RepositoryContext;
 import org.apache.jackrabbit.core.RepositoryImpl;
+import org.argeo.api.DataModelNamespace;
+import org.argeo.api.NodeConstants;
+import org.argeo.api.NodeDeployment;
+import org.argeo.api.NodeState;
+import org.argeo.api.security.CryptoKeyring;
+import org.argeo.api.security.Keyring;
 import org.argeo.cms.ArgeoNames;
 import org.argeo.cms.CmsException;
+import org.argeo.cms.internal.http.CmsRemotingServlet;
+import org.argeo.cms.internal.http.CmsWebDavServlet;
+import org.argeo.cms.internal.http.HttpUtils;
 import org.argeo.jcr.JcrUtils;
-import org.argeo.node.DataModelNamespace;
-import org.argeo.node.NodeConstants;
-import org.argeo.node.NodeDeployment;
-import org.argeo.node.NodeState;
-import org.argeo.node.security.CryptoKeyring;
-import org.argeo.node.security.Keyring;
 import org.argeo.osgi.useradmin.UserAdminConf;
 import org.argeo.util.LangUtils;
 import org.eclipse.equinox.http.jetty.JettyConfigurator;
@@ -42,6 +50,7 @@ import org.osgi.framework.Bundle;
 import org.osgi.framework.BundleContext;
 import org.osgi.framework.Constants;
 import org.osgi.framework.FrameworkUtil;
+import org.osgi.framework.InvalidSyntaxException;
 import org.osgi.framework.ServiceReference;
 import org.osgi.framework.wiring.BundleCapability;
 import org.osgi.framework.wiring.BundleWire;
@@ -49,27 +58,27 @@ import org.osgi.framework.wiring.BundleWiring;
 import org.osgi.service.cm.Configuration;
 import org.osgi.service.cm.ConfigurationAdmin;
 import org.osgi.service.cm.ManagedService;
+import org.osgi.service.http.HttpService;
+import org.osgi.service.http.whiteboard.HttpWhiteboardConstants;
 import org.osgi.service.useradmin.Group;
 import org.osgi.service.useradmin.Role;
 import org.osgi.service.useradmin.UserAdmin;
 import org.osgi.util.tracker.ServiceTracker;
 
+/** Implementation of a CMS deployment. */
 public class CmsDeployment implements NodeDeployment {
-       // private final static String LEGACY_JCR_REPOSITORY_ALIAS =
-       // "argeo.jcr.repository.alias";
-
        private final Log log = LogFactory.getLog(getClass());
        private final BundleContext bc = FrameworkUtil.getBundle(getClass()).getBundleContext();
 
        private DataModels dataModels;
        private DeployConfig deployConfig;
-       private HomeRepository homeRepository;
 
        private Long availableSince;
 
-       private final boolean cleanState;
+//     private final boolean cleanState;
 
-       private NodeHttp nodeHttp;
+//     private NodeHttp nodeHttp;
+       private String webDavConfig = HttpUtils.WEBDAV_CONFIG;
 
        private boolean argeoDataModelExtensionsAvailable = false;
 
@@ -80,26 +89,29 @@ public class CmsDeployment implements NodeDeployment {
        private boolean httpAvailable = false;
 
        public CmsDeployment() {
-               ServiceReference<NodeState> nodeStateSr = bc.getServiceReference(NodeState.class);
-               if (nodeStateSr == null)
-                       throw new CmsException("No node state available");
+//             ServiceReference<NodeState> nodeStateSr = bc.getServiceReference(NodeState.class);
+//             if (nodeStateSr == null)
+//                     throw new CmsException("No node state available");
 
-               NodeState nodeState = bc.getService(nodeStateSr);
-               cleanState = nodeState.isClean();
+//             NodeState nodeState = bc.getService(nodeStateSr);
+//             cleanState = nodeState.isClean();
 
-               nodeHttp = new NodeHttp(cleanState);
+//             nodeHttp = new NodeHttp();
                dataModels = new DataModels(bc);
                initTrackers();
        }
 
        private void initTrackers() {
-               ServiceTracker<?, ?> httpSt = new ServiceTracker<NodeHttp, NodeHttp>(bc, NodeHttp.class, null) {
+               ServiceTracker<?, ?> httpSt = new ServiceTracker<HttpService, HttpService>(bc, HttpService.class, null) {
 
                        @Override
-                       public NodeHttp addingService(ServiceReference<NodeHttp> reference) {
+                       public HttpService addingService(ServiceReference<HttpService> sr) {
                                httpAvailable = true;
+                               Object httpPort = sr.getProperty("http.port");
+                               Object httpsPort = sr.getProperty("https.port");
+                               log.info(httpPortsMsg(httpPort, httpsPort));
                                checkReadiness();
-                               return super.addingService(reference);
+                               return super.addingService(sr);
                        }
                };
                // httpSt.open();
@@ -127,17 +139,17 @@ public class CmsDeployment implements NodeDeployment {
                        @Override
                        public ConfigurationAdmin addingService(ServiceReference<ConfigurationAdmin> reference) {
                                ConfigurationAdmin configurationAdmin = bc.getService(reference);
-                               deployConfig = new DeployConfig(configurationAdmin, dataModels, cleanState);
+                               boolean isClean;
+                               try {
+                                       Configuration[] confs = configurationAdmin
+                                                       .listConfigurations("(service.factoryPid=" + NodeConstants.NODE_USER_ADMIN_PID + ")");
+                                       isClean = confs == null || confs.length == 0;
+                               } catch (Exception e) {
+                                       throw new CmsException("Cannot analize clean state", e);
+                               }
+                               deployConfig = new DeployConfig(configurationAdmin, dataModels, isClean);
                                httpExpected = deployConfig.getProps(KernelConstants.JETTY_FACTORY_PID, "default") != null;
                                try {
-                                       // Configuration[] configs = configurationAdmin
-                                       // .listConfigurations("(service.factoryPid=" +
-                                       // NodeConstants.NODE_REPOS_FACTORY_PID + ")");
-                                       // for (Configuration config : configs) {
-                                       // Object cn = config.getProperties().get(NodeConstants.CN);
-                                       // if (log.isDebugEnabled())
-                                       // log.debug("Standalone repo cn: " + cn);
-                                       // }
                                        Configuration[] configs = configurationAdmin
                                                        .listConfigurations("(service.factoryPid=" + NodeConstants.NODE_USER_ADMIN_PID + ")");
 
@@ -162,6 +174,10 @@ public class CmsDeployment implements NodeDeployment {
                KernelUtils.asyncOpen(confAdminSt);
        }
 
+       private String httpPortsMsg(Object httpPort, Object httpsPort) {
+               return (httpPort != null ? "HTTP " + httpPort + " " : " ") + (httpsPort != null ? "HTTPS " + httpsPort : "");
+       }
+
        private void addStandardSystemRoles(UserAdmin userAdmin) {
                // we assume UserTransaction is already available (TODO make it more robust)
                UserTransaction userTransaction = bc.getService(bc.getServiceReference(UserTransaction.class));
@@ -196,8 +212,17 @@ public class CmsDeployment implements NodeDeployment {
        }
 
        public void shutdown() {
-               if (nodeHttp != null)
-                       nodeHttp.destroy();
+//             if (nodeHttp != null)
+//                     nodeHttp.destroy();
+
+               try {
+                       for (ServiceReference<JackrabbitLocalRepository> sr : bc
+                                       .getServiceReferences(JackrabbitLocalRepository.class, null)) {
+                               bc.getService(sr).destroy();
+                       }
+               } catch (InvalidSyntaxException e1) {
+                       log.error("Cannot sclean repsoitories", e1);
+               }
 
                try {
                        JettyConfigurator.stopServer(KernelConstants.DEFAULT_JETTY_SERVER);
@@ -260,7 +285,7 @@ public class CmsDeployment implements NodeDeployment {
                }
 
                // home
-               prepareDataModel(NodeConstants.NODE, deployedNodeRepository);
+               prepareDataModel(NodeConstants.NODE_REPOSITORY, deployedNodeRepository);
        }
 
        private void prepareHomeRepository(RepositoryImpl deployedRepository) {
@@ -276,12 +301,12 @@ public class CmsDeployment implements NodeDeployment {
                        JcrUtils.logoutQuietly(adminSession);
                }
 
-               Hashtable<String, String> regProps = new Hashtable<String, String>();
-               regProps.put(NodeConstants.CN, NodeConstants.HOME);
-               // regProps.put(LEGACY_JCR_REPOSITORY_ALIAS, NodeConstants.HOME);
-               homeRepository = new HomeRepository(deployedRepository, false);
-               // register
-               bc.registerService(Repository.class, homeRepository, regProps);
+               // Publish home with the highest service ranking
+               Hashtable<String, Object> regProps = new Hashtable<>();
+               regProps.put(NodeConstants.CN, NodeConstants.EGO_REPOSITORY);
+               regProps.put(Constants.SERVICE_RANKING, Integer.MAX_VALUE);
+               Repository egoRepository = new EgoRepository(deployedRepository, false);
+               bc.registerService(Repository.class, egoRepository, regProps);
 
                // Keyring only if Argeo extensions are available
                if (argeoDataModelExtensionsAvailable) {
@@ -289,7 +314,7 @@ public class CmsDeployment implements NodeDeployment {
 
                                @Override
                                public CallbackHandler addingService(ServiceReference<CallbackHandler> reference) {
-                                       NodeKeyRing nodeKeyring = new NodeKeyRing(homeRepository);
+                                       NodeKeyRing nodeKeyring = new NodeKeyRing(egoRepository);
                                        CallbackHandler callbackHandler = bc.getService(reference);
                                        nodeKeyring.setDefaultCallbackHandler(callbackHandler);
                                        bc.registerService(LangUtils.names(Keyring.class, CryptoKeyring.class, ManagedService.class),
@@ -310,7 +335,7 @@ public class CmsDeployment implements NodeDeployment {
                                BundleWiring wiring = bundle.adapt(BundleWiring.class);
                                if (wiring == null)
                                        continue bundles;
-                               if (NodeConstants.NODE.equals(cn))// process all data models
+                               if (NodeConstants.NODE_REPOSITORY.equals(cn))// process all data models
                                        processWiring(cn, adminSession, wiring, processed, false);
                                else {
                                        List<BundleCapability> capabilities = wiring.getCapabilities(CMS_DATA_MODEL_NAMESPACE);
@@ -388,7 +413,7 @@ public class CmsDeployment implements NodeDeployment {
                boolean publishLocalRepo;
                if (isStandalone && name.equals(cn))// includes the node itself
                        publishLocalRepo = true;
-               else if (!isStandalone && cn.equals(NodeConstants.NODE))
+               else if (!isStandalone && cn.equals(NodeConstants.NODE_REPOSITORY))
                        publishLocalRepo = true;
                else
                        publishLocalRepo = false;
@@ -398,12 +423,21 @@ public class CmsDeployment implements NodeDeployment {
 
        private void publishLocalRepo(String dataModelName, Repository repository) {
                Hashtable<String, Object> properties = new Hashtable<>();
-               // properties.put(LEGACY_JCR_REPOSITORY_ALIAS, name);
                properties.put(NodeConstants.CN, dataModelName);
-               if (dataModelName.equals(NodeConstants.NODE))
-                       properties.put(Constants.SERVICE_RANKING, Integer.MAX_VALUE);
-               LocalRepository localRepository = new LocalRepository(repository, dataModelName);
-               bc.registerService(Repository.class, localRepository, properties);
+               LocalRepository localRepository;
+               String[] classes;
+               if (repository instanceof RepositoryImpl) {
+                       localRepository = new JackrabbitLocalRepository((RepositoryImpl) repository, dataModelName);
+                       classes = new String[] { Repository.class.getName(), LocalRepository.class.getName(),
+                                       JackrabbitLocalRepository.class.getName() };
+               } else {
+                       localRepository = new LocalRepository(repository, dataModelName);
+                       classes = new String[] { Repository.class.getName(), LocalRepository.class.getName() };
+               }
+               bc.registerService(classes, localRepository, properties);
+
+               // TODO make it configurable
+               registerRepositoryServlets(dataModelName, localRepository);
                if (log.isTraceEnabled())
                        log.trace("Published data model " + dataModelName);
        }
@@ -417,6 +451,54 @@ public class CmsDeployment implements NodeDeployment {
                return availableSince != null;
        }
 
+       protected void registerRepositoryServlets(String alias, Repository repository) {
+               registerRemotingServlet(alias, repository);
+               registerWebdavServlet(alias, repository);
+       }
+
+       protected void registerWebdavServlet(String alias, Repository repository) {
+               CmsWebDavServlet webdavServlet = new CmsWebDavServlet(alias, repository);
+               Hashtable<String, String> ip = new Hashtable<>();
+               ip.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX + CmsWebDavServlet.INIT_PARAM_RESOURCE_CONFIG, webDavConfig);
+               ip.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX + CmsWebDavServlet.INIT_PARAM_RESOURCE_PATH_PREFIX,
+                               "/" + alias);
+
+               ip.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_SERVLET_PATTERN, "/" + alias + "/*");
+               ip.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT,
+                               "(" + HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_PATH + "=" + NodeConstants.PATH_DATA + ")");
+               bc.registerService(Servlet.class, webdavServlet, ip);
+       }
+
+       protected void registerRemotingServlet(String alias, Repository repository) {
+               CmsRemotingServlet remotingServlet = new CmsRemotingServlet(alias, repository);
+               Hashtable<String, String> ip = new Hashtable<>();
+               ip.put(NodeConstants.CN, alias);
+               // Properties ip = new Properties();
+               ip.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX + CmsRemotingServlet.INIT_PARAM_RESOURCE_PATH_PREFIX,
+                               "/" + alias);
+               ip.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX + CmsRemotingServlet.INIT_PARAM_AUTHENTICATE_HEADER,
+                               "Negotiate");
+
+               // Looks like a bug in Jackrabbit remoting init
+               Path tmpDir;
+               try {
+                       tmpDir = Files.createTempDirectory("remoting_" + alias);
+               } catch (IOException e) {
+                       throw new CmsException("Cannot create temp directory for remoting servlet", e);
+               }
+               ip.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX + CmsRemotingServlet.INIT_PARAM_HOME, tmpDir.toString());
+               ip.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX + CmsRemotingServlet.INIT_PARAM_TMP_DIRECTORY,
+                               "remoting_" + alias);
+               ip.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX + CmsRemotingServlet.INIT_PARAM_PROTECTED_HANDLERS_CONFIG,
+                               HttpUtils.DEFAULT_PROTECTED_HANDLERS);
+               ip.put(HTTP_WHITEBOARD_SERVLET_INIT_PARAM_PREFIX + CmsRemotingServlet.INIT_PARAM_CREATE_ABSOLUTE_URI, "false");
+
+               ip.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_SERVLET_PATTERN, "/" + alias + "/*");
+               ip.put(HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_SELECT,
+                               "(" + HttpWhiteboardConstants.HTTP_WHITEBOARD_CONTEXT_PATH + "=" + NodeConstants.PATH_JCR + ")");
+               bc.registerService(Servlet.class, remotingServlet, ip);
+       }
+
        private class RepositoryContextStc extends ServiceTracker<RepositoryContext, RepositoryContext> {
 
                public RepositoryContextStc() {
@@ -428,10 +510,11 @@ public class CmsDeployment implements NodeDeployment {
                        RepositoryContext repoContext = bc.getService(reference);
                        String cn = (String) reference.getProperty(NodeConstants.CN);
                        if (cn != null) {
-                               if (cn.equals(NodeConstants.NODE)) {
+                               if (cn.equals(NodeConstants.NODE_REPOSITORY)) {
                                        prepareNodeRepository(repoContext.getRepository());
                                        // TODO separate home repository
                                        prepareHomeRepository(repoContext.getRepository());
+                                       registerRepositoryServlets(cn, repoContext.getRepository());
                                        nodeAvailable = true;
                                        checkReadiness();
                                } else {