Rename packages in order to make future stable documentation clearer.
[lgpl/argeo-commons.git] / org.argeo.cms / src / org / argeo / cms / internal / kernel / KernelUtils.java
index c1e20892456fd26792956f3ce2532a3ddce9738c..bf8e8d38e462a58a6821e5a41c4bed69b53a092a 100644 (file)
@@ -2,25 +2,51 @@ package org.argeo.cms.internal.kernel;
 
 import java.io.File;
 import java.io.IOException;
+import java.io.PrintStream;
 import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.security.PrivilegedAction;
+import java.security.URIParameter;
 import java.util.Dictionary;
-import java.util.Enumeration;
 import java.util.Hashtable;
 import java.util.Properties;
+import java.util.TreeMap;
+import java.util.TreeSet;
 
+import javax.jcr.Repository;
+import javax.jcr.RepositoryException;
+import javax.jcr.Session;
 import javax.security.auth.Subject;
 import javax.security.auth.login.LoginContext;
 import javax.security.auth.login.LoginException;
-import javax.servlet.http.HttpServletRequest;
 
 import org.apache.commons.logging.Log;
+import org.argeo.api.DataModelNamespace;
+import org.argeo.api.NodeConstants;
 import org.argeo.cms.CmsException;
-import org.argeo.cms.auth.AuthConstants;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.BundleContext;
+import org.osgi.framework.FrameworkUtil;
+import org.osgi.util.tracker.ServiceTracker;
 
 /** Package utilities */
 class KernelUtils implements KernelConstants {
-       private final static String OSGI_INSTANCE_AREA = "osgi.instance.area";
-       private final static String OSGI_CONFIGURATION_AREA = "osgi.configuration.area";
+       final static String OSGI_INSTANCE_AREA = "osgi.instance.area";
+       final static String OSGI_CONFIGURATION_AREA = "osgi.configuration.area";
+
+       static void setJaasConfiguration(URL jaasConfigurationUrl) {
+               try {
+                       URIParameter uriParameter = new URIParameter(jaasConfigurationUrl.toURI());
+                       javax.security.auth.login.Configuration jaasConfiguration = javax.security.auth.login.Configuration
+                                       .getInstance("JavaLoginConfig", uriParameter);
+                       javax.security.auth.login.Configuration.setConfiguration(jaasConfiguration);
+               } catch (Exception e) {
+                       throw new CmsException("Cannot set configuration " + jaasConfigurationUrl, e);
+               }
+       }
 
        static Dictionary<String, ?> asDictionary(Properties props) {
                Hashtable<String, Object> hashtable = new Hashtable<String, Object>();
@@ -35,44 +61,47 @@ class KernelUtils implements KernelConstants {
                try {
                        props.load(cl.getResourceAsStream(resource));
                } catch (IOException e) {
-                       throw new CmsException("Cannot load " + resource
-                                       + " from classpath", e);
+                       throw new CmsException("Cannot load " + resource + " from classpath", e);
                }
                return asDictionary(props);
        }
 
+       static File getExecutionDir(String relativePath) {
+               File executionDir = new File(getFrameworkProp("user.dir"));
+               if (relativePath == null)
+                       return executionDir;
+               try {
+                       return new File(executionDir, relativePath).getCanonicalFile();
+               } catch (IOException e) {
+                       throw new CmsException("Cannot get canonical file", e);
+               }
+       }
+
        static File getOsgiInstanceDir() {
-               return new File(Activator.getBundleContext()
-                               .getProperty(OSGI_INSTANCE_AREA).substring("file:".length()))
+               return new File(getBundleContext().getProperty(OSGI_INSTANCE_AREA).substring("file:".length()))
                                .getAbsoluteFile();
        }
 
-       static String getOsgiInstancePath(String relativePath) {
-               try {
-                       if (relativePath == null)
-                               return getOsgiInstanceDir().getCanonicalPath();
-                       else
-                               return new File(getOsgiInstanceDir(), relativePath)
-                                               .getCanonicalPath();
-               } catch (IOException e) {
-                       throw new CmsException("Cannot get instance path for "
-                                       + relativePath, e);
-               }
+       static Path getOsgiInstancePath(String relativePath) {
+               return Paths.get(getOsgiInstanceUri(relativePath));
+       }
+
+       static URI getOsgiInstanceUri(String relativePath) {
+               String osgiInstanceBaseUri = getFrameworkProp(OSGI_INSTANCE_AREA);
+               return safeUri(osgiInstanceBaseUri + (relativePath != null ? relativePath : ""));
        }
 
        static File getOsgiConfigurationFile(String relativePath) {
                try {
-                       return new File(new URI(Activator.getBundleContext().getProperty(
-                                       OSGI_CONFIGURATION_AREA)
-                                       + relativePath)).getCanonicalFile();
+                       return new File(new URI(getBundleContext().getProperty(OSGI_CONFIGURATION_AREA) + relativePath))
+                                       .getCanonicalFile();
                } catch (Exception e) {
-                       throw new CmsException("Cannot get configuration file for "
-                                       + relativePath, e);
+                       throw new CmsException("Cannot get configuration file for " + relativePath, e);
                }
        }
 
        static String getFrameworkProp(String key, String def) {
-               String value = Activator.getBundleContext().getProperty(key);
+               String value = getBundleContext().getProperty(key);
                if (value == null)
                        return def;
                return value;
@@ -83,48 +112,121 @@ class KernelUtils implements KernelConstants {
        }
 
        // Security
-       static Subject anonymousLogin() {
-               Subject subject = new Subject();
-               LoginContext lc;
+       // static Subject anonymousLogin() {
+       // Subject subject = new Subject();
+       // LoginContext lc;
+       // try {
+       // lc = new LoginContext(NodeConstants.LOGIN_CONTEXT_USER, subject);
+       // lc.login();
+       // return subject;
+       // } catch (LoginException e) {
+       // throw new CmsException("Cannot login as anonymous", e);
+       // }
+       // }
+
+       static void logFrameworkProperties(Log log) {
+               BundleContext bc = getBundleContext();
+               for (Object sysProp : new TreeSet<Object>(System.getProperties().keySet())) {
+                       log.debug(sysProp + "=" + bc.getProperty(sysProp.toString()));
+               }
+               // String[] keys = { Constants.FRAMEWORK_STORAGE,
+               // Constants.FRAMEWORK_OS_NAME, Constants.FRAMEWORK_OS_VERSION,
+               // Constants.FRAMEWORK_PROCESSOR, Constants.FRAMEWORK_SECURITY,
+               // Constants.FRAMEWORK_TRUST_REPOSITORIES,
+               // Constants.FRAMEWORK_WINDOWSYSTEM, Constants.FRAMEWORK_VENDOR,
+               // Constants.FRAMEWORK_VERSION, Constants.FRAMEWORK_STORAGE_CLEAN,
+               // Constants.FRAMEWORK_LANGUAGE, Constants.FRAMEWORK_UUID };
+               // for (String key : keys)
+               // log.debug(key + "=" + bc.getProperty(key));
+       }
+
+       static void printSystemProperties(PrintStream out) {
+               TreeMap<String, String> display = new TreeMap<>();
+               for (Object key : System.getProperties().keySet())
+                       display.put(key.toString(), System.getProperty(key.toString()));
+               for (String key : display.keySet())
+                       out.println(key + "=" + display.get(key));
+       }
+
+       static Session openAdminSession(Repository repository) {
+               return openAdminSession(repository, null);
+       }
+
+       static Session openAdminSession(final Repository repository, final String workspaceName) {
+               ClassLoader currentCl = Thread.currentThread().getContextClassLoader();
+               Thread.currentThread().setContextClassLoader(KernelUtils.class.getClassLoader());
+               LoginContext loginContext;
                try {
-                       lc = new LoginContext(AuthConstants.LOGIN_CONTEXT_ANONYMOUS,
-                                       subject);
-                       lc.login();
-                       return subject;
-               } catch (LoginException e) {
-                       throw new CmsException("Cannot login as anonymous", e);
+                       loginContext = new LoginContext(NodeConstants.LOGIN_CONTEXT_DATA_ADMIN);
+                       loginContext.login();
+               } catch (LoginException e1) {
+                       throw new CmsException("Could not login as data admin", e1);
+               } finally {
+                       Thread.currentThread().setContextClassLoader(currentCl);
                }
+               return Subject.doAs(loginContext.getSubject(), new PrivilegedAction<Session>() {
+
+                       @Override
+                       public Session run() {
+                               try {
+                                       return repository.login(workspaceName);
+                               } catch (RepositoryException e) {
+                                       throw new CmsException("Cannot open admin session", e);
+                               }
+                       }
+
+               });
        }
 
-       // @Deprecated
-       // static void anonymousLogin(AuthenticationManager authenticationManager) {
-       // try {
-       // List<GrantedAuthorityPrincipal> anonAuthorities = Collections
-       // .singletonList(new GrantedAuthorityPrincipal(
-       // KernelHeader.ROLE_ANONYMOUS));
-       // UserDetails anonUser = new User(KernelHeader.USERNAME_ANONYMOUS,
-       // "", true, true, true, true, anonAuthorities);
-       // AnonymousAuthenticationToken anonToken = new
-       // AnonymousAuthenticationToken(
-       // DEFAULT_SECURITY_KEY, anonUser, anonAuthorities);
-       // Authentication authentication = authenticationManager
-       // .authenticate(anonToken);
-       // SecurityContextHolder.getContext()
-       // .setAuthentication(authentication);
-       // } catch (Exception e) {
-       // throw new CmsException("Cannot authenticate", e);
-       // }
-       // }
+       static void asyncOpen(ServiceTracker<?, ?> st) {
+               Runnable run = new Runnable() {
+
+                       @Override
+                       public void run() {
+                               st.open();
+                       }
+               };
+               Activator.getInternalExecutorService().execute(run);
+//             new Thread(run, "Open service tracker " + st).start();
+       }
+
+       /**
+        * @return the {@link BundleContext} of the {@link Bundle} which provided this
+        *         class, never null.
+        * @throws CmsException if the related bundle is not active
+        */
+       static BundleContext getBundleContext(Class<?> clzz) {
+               Bundle bundle = FrameworkUtil.getBundle(clzz);
+               BundleContext bc = bundle.getBundleContext();
+               if (bc == null)
+                       throw new CmsException("Bundle " + bundle.getSymbolicName() + " is not active");
+               return bc;
+       }
+
+       static BundleContext getBundleContext() {
+               return getBundleContext(KernelUtils.class);
+       }
 
-       // HTTP
-       static void logRequestHeaders(Log log, HttpServletRequest request) {
-               if (!log.isDebugEnabled())
-                       return;
-               for (Enumeration<String> headerNames = request.getHeaderNames(); headerNames
-                               .hasMoreElements();) {
-                       String headerName = headerNames.nextElement();
-                       Object headerValue = request.getHeader(headerName);
-                       log.debug(headerName + ": " + headerValue);
+       static boolean asBoolean(String value) {
+               if (value == null)
+                       return false;
+               switch (value) {
+               case "true":
+                       return true;
+               case "false":
+                       return false;
+               default:
+                       throw new CmsException("Unsupported value for attribute " + DataModelNamespace.ABSTRACT + ": " + value);
+               }
+       }
+
+       private static URI safeUri(String uri) {
+               if (uri == null)
+                       throw new CmsException("URI cannot be null");
+               try {
+                       return new URI(uri);
+               } catch (URISyntaxException e) {
+                       throw new CmsException("Dadly formatted URI " + uri, e);
                }
        }