]> git.argeo.org Git - lgpl/argeo-commons.git/blobdiff - org.argeo.security.core/src/org/argeo/osgi/useradmin/LdifUserAdmin.java
Improve and simplify OSGi Boot
[lgpl/argeo-commons.git] / org.argeo.security.core / src / org / argeo / osgi / useradmin / LdifUserAdmin.java
index fa4526ac6a6084b20464964831bf8b8bdefaeee6..521ae8bb6e89916c6b88ea490767658e8b3012fa 100644 (file)
@@ -1,5 +1,8 @@
 package org.argeo.osgi.useradmin;
 
+import static org.argeo.osgi.useradmin.LdifName.inetOrgPerson;
+import static org.argeo.osgi.useradmin.LdifName.objectClass;
+
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -7,29 +10,30 @@ import java.io.InputStream;
 import java.io.OutputStream;
 import java.util.ArrayList;
 import java.util.Dictionary;
+import java.util.HashSet;
 import java.util.Hashtable;
-import java.util.LinkedHashMap;
 import java.util.List;
-import java.util.Map;
+import java.util.Set;
 import java.util.SortedMap;
 import java.util.TreeMap;
 
-import javax.naming.InvalidNameException;
 import javax.naming.NamingEnumeration;
 import javax.naming.directory.Attributes;
 import javax.naming.ldap.LdapName;
+import javax.transaction.TransactionManager;
 
-import org.apache.commons.io.IOUtils;
+import org.argeo.util.naming.LdifParser;
+import org.argeo.util.naming.LdifWriter;
 import org.osgi.framework.Filter;
 import org.osgi.service.useradmin.Role;
-import org.osgi.service.useradmin.User;
 
-/** User admin implementation using LDIF file(s) as backend. */
+/**
+ * A user admin based on a LDIF files. Requires a {@link TransactionManager} and
+ * an open transaction for write access.
+ */
 public class LdifUserAdmin extends AbstractUserDirectory {
-       SortedMap<LdapName, DirectoryUser> users = new TreeMap<LdapName, DirectoryUser>();
-       SortedMap<LdapName, DirectoryGroup> groups = new TreeMap<LdapName, DirectoryGroup>();
-
-       private Map<String, Map<String, DirectoryUser>> userIndexes = new LinkedHashMap<String, Map<String, DirectoryUser>>();
+       private SortedMap<LdapName, DirectoryUser> users = new TreeMap<LdapName, DirectoryUser>();
+       private SortedMap<LdapName, DirectoryGroup> groups = new TreeMap<LdapName, DirectoryGroup>();
 
        public LdifUserAdmin(String uri, String baseDn) {
                this(fromUri(uri, baseDn));
@@ -42,14 +46,12 @@ public class LdifUserAdmin extends AbstractUserDirectory {
        public LdifUserAdmin(InputStream in) {
                super(new Hashtable<String, Object>());
                load(in);
-               setReadOnly(true);
-               setUri(null);
        }
 
        private static Dictionary<String, Object> fromUri(String uri, String baseDn) {
                Hashtable<String, Object> res = new Hashtable<String, Object>();
-               res.put(UserAdminProps.uri.property(), uri);
-               res.put(UserAdminProps.baseDn.property(), baseDn);
+               res.put(UserAdminConf.uri.name(), uri);
+               res.put(UserAdminConf.baseDn.name(), baseDn);
                return res;
        }
 
@@ -67,13 +69,14 @@ public class LdifUserAdmin extends AbstractUserDirectory {
        }
 
        public void save() {
-               if (getUri() == null || isReadOnly())
-                       throw new UserDirectoryException("Cannot save LDIF user admin");
+               if (getUri() == null)
+                       throw new UserDirectoryException("Cannot save LDIF user admin: no URI is set");
+               if (isReadOnly())
+                       throw new UserDirectoryException("Cannot save LDIF user admin: " + getUri() + " is read-only");
                try (FileOutputStream out = new FileOutputStream(new File(getUri()))) {
                        save(out);
                } catch (IOException e) {
-                       throw new UserDirectoryException("Cannot save user admin to "
-                                       + getUri(), e);
+                       throw new UserDirectoryException("Cannot save user admin to " + getUri(), e);
                }
        }
 
@@ -85,11 +88,10 @@ public class LdifUserAdmin extends AbstractUserDirectory {
                        for (LdapName name : users.keySet())
                                ldifWriter.writeEntry(name, users.get(name).getAttributes());
                } finally {
-                       IOUtils.closeQuietly(out);
+                       out.close();
                }
        }
 
-       @SuppressWarnings("unchecked")
        protected void load(InputStream in) {
                try {
                        users.clear();
@@ -99,46 +101,39 @@ public class LdifUserAdmin extends AbstractUserDirectory {
                        SortedMap<LdapName, Attributes> allEntries = ldifParser.read(in);
                        for (LdapName key : allEntries.keySet()) {
                                Attributes attributes = allEntries.get(key);
-                               NamingEnumeration<?> objectClasses = attributes.get(
-                                               "objectClass").getAll();
+                               // check for inconsistency
+                               Set<String> lowerCase = new HashSet<String>();
+                               NamingEnumeration<String> ids = attributes.getIDs();
+                               while (ids.hasMoreElements()) {
+                                       String id = ids.nextElement().toLowerCase();
+                                       if (lowerCase.contains(id))
+                                               throw new UserDirectoryException(key + " has duplicate id " + id);
+                                       lowerCase.add(id);
+                               }
+
+                               // analyse object classes
+                               NamingEnumeration<?> objectClasses = attributes.get(objectClass.name()).getAll();
+                               // System.out.println(key);
                                objectClasses: while (objectClasses.hasMore()) {
                                        String objectClass = objectClasses.next().toString();
-                                       if (objectClass.equals("inetOrgPerson")) {
+                                       // System.out.println(" " + objectClass);
+                                       if (objectClass.equals(inetOrgPerson.name())) {
                                                users.put(key, new LdifUser(this, key, attributes));
                                                break objectClasses;
-                                       } else if (objectClass.equals("groupOfNames")) {
+                                       } else if (objectClass.equals(getGroupObjectClass())) {
                                                groups.put(key, new LdifGroup(this, key, attributes));
                                                break objectClasses;
                                        }
                                }
                        }
-
-                       // indexes
-                       for (String attr : getIndexedUserProperties())
-                               userIndexes.put(attr, new TreeMap<String, DirectoryUser>());
-
-                       for (DirectoryUser user : users.values()) {
-                               Dictionary<String, ?> properties = user.getProperties();
-                               for (String attr : getIndexedUserProperties()) {
-                                       Object value = properties.get(attr);
-                                       if (value != null) {
-                                               DirectoryUser otherUser = userIndexes.get(attr).put(
-                                                               value.toString(), user);
-                                               if (otherUser != null)
-                                                       throw new UserDirectoryException("User " + user
-                                                                       + " and user " + otherUser
-                                                                       + " both have property " + attr
-                                                                       + " set to " + value);
-                                       }
-                               }
-                       }
                } catch (Exception e) {
-                       throw new UserDirectoryException(
-                                       "Cannot load user admin service from LDIF", e);
+                       throw new UserDirectoryException("Cannot load user admin service from LDIF", e);
                }
        }
 
        public void destroy() {
+               if (users == null || groups == null)
+                       throw new UserDirectoryException("User directory " + getBaseDn() + " is already destroyed");
                users.clear();
                users = null;
                groups.clear();
@@ -164,10 +159,17 @@ public class LdifUserAdmin extends AbstractUserDirectory {
                        res.addAll(users.values());
                        res.addAll(groups.values());
                } else {
-                       // Filter f = FrameworkUtil.createFilter(filter);
-                       for (DirectoryUser user : users.values())
+                       for (DirectoryUser user : users.values()) {
+                               // System.out.println("\n" + user.getName());
+                               // Dictionary<String, Object> props = user.getProperties();
+                               // for (Enumeration<String> keys = props.keys(); keys
+                               // .hasMoreElements();) {
+                               // String key = keys.nextElement();
+                               // System.out.println(" " + key + "=" + props.get(key));
+                               // }
                                if (f.match(user.getProperties()))
                                        res.add(user);
+                       }
                        for (DirectoryUser group : groups.values())
                                if (f.match(group.getProperties()))
                                        res.add(group);
@@ -175,38 +177,19 @@ public class LdifUserAdmin extends AbstractUserDirectory {
                return res;
        }
 
-       protected void doGetUser(String key, String value,
-                       List<DirectoryUser> collectedUsers) {
-               assert key != null;
-               DirectoryUser user = userIndexes.get(key).get(value);
-               if (user != null)
-                       collectedUsers.add(user);
-       }
-
        @Override
-       protected List<DirectoryGroup> getDirectGroups(User user) {
-               LdapName dn;
-               if (user instanceof LdifUser)
-                       dn = ((LdifUser) user).getDn();
-               else
-                       try {
-                               dn = new LdapName(user.getName());
-                       } catch (InvalidNameException e) {
-                               throw new UserDirectoryException("Badly formatted user name "
-                                               + user.getName(), e);
-                       }
-
-               List<DirectoryGroup> directGroups = new ArrayList<DirectoryGroup>();
+       protected List<LdapName> getDirectGroups(LdapName dn) {
+               List<LdapName> directGroups = new ArrayList<LdapName>();
                for (LdapName name : groups.keySet()) {
                        DirectoryGroup group = groups.get(name);
                        if (group.getMemberNames().contains(dn))
-                               directGroups.add(group);
+                               directGroups.add(group.getDn());
                }
                return directGroups;
        }
 
        @Override
-       protected void prepare(WorkingCopy wc) {
+       protected void prepare(UserDirectoryWorkingCopy wc) {
                // delete
                for (LdapName dn : wc.getDeletedUsers().keySet()) {
                        if (users.containsKey(dn))
@@ -214,19 +197,19 @@ public class LdifUserAdmin extends AbstractUserDirectory {
                        else if (groups.containsKey(dn))
                                groups.remove(dn);
                        else
-                               throw new UserDirectoryException("User to delete no found "
-                                               + dn);
+                               throw new UserDirectoryException("User to delete not found " + dn);
                }
                // add
                for (LdapName dn : wc.getNewUsers().keySet()) {
                        DirectoryUser user = wc.getNewUsers().get(dn);
-                       if (Role.USER == user.getType())
+                       if (users.containsKey(dn) || groups.containsKey(dn))
+                               throw new UserDirectoryException("User to create found " + dn);
+                       else if (Role.USER == user.getType())
                                users.put(dn, user);
                        else if (Role.GROUP == user.getType())
                                groups.put(dn, (DirectoryGroup) user);
                        else
-                               throw new UserDirectoryException("Unsupported role type "
-                                               + user.getType() + " for new user " + dn);
+                               throw new UserDirectoryException("Unsupported role type " + user.getType() + " for new user " + dn);
                }
                // modify
                for (LdapName dn : wc.getModifiedUsers().keySet()) {
@@ -237,19 +220,18 @@ public class LdifUserAdmin extends AbstractUserDirectory {
                        else if (groups.containsKey(dn))
                                user = groups.get(dn);
                        else
-                               throw new UserDirectoryException("User to modify no found "
-                                               + dn);
+                               throw new UserDirectoryException("User to modify no found " + dn);
                        user.publishAttributes(modifiedAttrs);
                }
        }
 
        @Override
-       protected void commit(WorkingCopy wc) {
+       protected void commit(UserDirectoryWorkingCopy wc) {
                save();
        }
 
        @Override
-       protected void rollback(WorkingCopy wc) {
+       protected void rollback(UserDirectoryWorkingCopy wc) {
                init();
        }