LDAPUserVisitor.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); <br>
 * you may not use this file except in compliance with the License.<br>
 * You may obtain a copy of the License at the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <p>
 * Unless required by applicable law or agreed to in writing,<br>
 * software distributed under the License is distributed on an "AS IS" BASIS, <br>
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
 * See the License for the specific language governing permissions and <br>
 * limitations under the License.
 * <p>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.ldap.manager;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javax.naming.NamingEnumeration;
import javax.naming.NamingException;
import javax.naming.directory.Attribute;
import javax.naming.directory.Attributes;
import javax.naming.directory.SearchResult;

import org.olat.core.logging.OLog;
import org.olat.core.logging.Tracing;
import org.olat.core.util.StringHelper;
import org.olat.ldap.LDAPSyncConfiguration;
import org.olat.ldap.model.LDAPUser;

/**
 * 
 * Initial date: 24.11.2014<br>
 * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
 *
 */
public class LDAPUserVisitor implements LDAPVisitor {
	
	private static final OLog log = Tracing.createLoggerFor(LDAPUserVisitor.class);
	
	private final LDAPSyncConfiguration syncConfiguration;
	private final List<LDAPUser> ldapUserList = new ArrayList<LDAPUser>();
	
	public LDAPUserVisitor(LDAPSyncConfiguration syncConfiguration) {
		this.syncConfiguration = syncConfiguration;
	}
	
	public List<LDAPUser> getLdapUserList() {
		return ldapUserList;
	}

	@Override
	public void visit(SearchResult searchResult) throws NamingException {
		Attributes resAttribs = searchResult.getAttributes();
		String dn = searchResult.getNameInNamespace();
		
		LDAPUser ldapUser = new LDAPUser();
		ldapUser.setDn(dn);
		ldapUser.setAttributes(resAttribs);
		ldapUser.setCoach(hasAttributeValue(resAttribs, syncConfiguration.getCoachRoleAttribute(), syncConfiguration.getCoachRoleValue()));
		ldapUser.setAuthor(hasAttributeValue(resAttribs, syncConfiguration.getAuthorRoleAttribute(), syncConfiguration.getAuthorRoleValue()));
		ldapUser.setUserManager(hasAttributeValue(resAttribs, syncConfiguration.getUserManagerRoleAttribute(), syncConfiguration.getUserManagerRoleValue()));
		ldapUser.setGroupManager(hasAttributeValue(resAttribs, syncConfiguration.getGroupManagerRoleAttribute(), syncConfiguration.getGroupManagerRoleValue()));
		ldapUser.setQpoolManager(hasAttributeValue(resAttribs, syncConfiguration.getQpoolManagerRoleAttribute(), syncConfiguration.getQpoolManagerRoleValue()));
		ldapUser.setLearningResourceManager(hasAttributeValue(resAttribs, syncConfiguration.getLearningResourceManagerRoleAttribute(), syncConfiguration.getLearningResourceManagerRoleValue()));

		List<String> groupList = parseGroupList(resAttribs, syncConfiguration.getGroupAttribute(), syncConfiguration.getGroupAttributeSeparator());
		ldapUser.setGroupIds(groupList);
		List<String> coachedGroupList = parseGroupList(resAttribs, syncConfiguration.getCoachedGroupAttribute(), syncConfiguration.getCoachedGroupAttributeSeparator());
		ldapUser.setCoachedGroupIds(coachedGroupList);
		
		ldapUserList.add(ldapUser);
	}
	
	private List<String> parseGroupList(Attributes resAttribs, String attributeName, String attributeSeparator) {
		List<String> groupList = Collections.emptyList();
		if(StringHelper.containsNonWhitespace(attributeName)) {
			try {
				Attribute groupAttr = resAttribs.get(attributeName);
				if(groupAttr != null && groupAttr.get() instanceof String) {
					String groupString = (String)groupAttr.get();
					if(!"-".equals(groupString)) {
						String[] groupArr = groupString.split(attributeSeparator);
						groupList = new ArrayList<>(groupArr.length);
						for(String group:groupArr) {
							groupList.add(group);
						}
					}
				}
			} catch (Exception e) {
				log.error("");
			}
		}
		return groupList;
	}
	
	private boolean hasAttributeValue(Attributes resAttribs, String attribute, String value) {
		boolean hasAttributeValue = false;
		if(StringHelper.containsNonWhitespace(attribute) && StringHelper.containsNonWhitespace(value)) {
			try {
				Attribute attr = resAttribs.get(attribute);
				if(attr != null) {
					if(attr.size() == 1) {
						if(value.equals(attr.get())) {
							hasAttributeValue = true;
						}
					} else if(attr.size() > 1) {
						for(NamingEnumeration<?> valuEnum=attr.getAll(); valuEnum.hasMoreElements(); ) {
							Object nextValue = valuEnum.next();
							if(value.equals(nextValue)) {
								hasAttributeValue = true;
							}
						}
					}
				}
			} catch (Exception e) {
				log.error("");
			}
		}
		return hasAttributeValue;
	}
}