LdapPosixGroupsUtils.java

/////////////////////////////////////////////////////////////////////////////
//
// Project ProjectForge Community Edition
//         www.projectforge.org
//
// Copyright (C) 2001-2014 Kai Reinhard (k.reinhard@micromata.de)
//
// ProjectForge is dual-licensed.
//
// This community edition is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License as published
// by the Free Software Foundation; version 3 of the License.
//
// This community edition is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
// Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, see http://www.gnu.org/licenses/.
//
/////////////////////////////////////////////////////////////////////////////

package org.projectforge.ldap;

import java.util.Collection;

import org.apache.commons.lang.ObjectUtils;
import org.projectforge.registry.Registry;
import org.projectforge.user.GroupDO;
import org.projectforge.user.UserGroupCache;

/**
 * @author Kai Reinhard (k.reinhard@micromata.de)
 */
public class LdapPosixGroupsUtils
{
  private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LdapPosixGroupsUtils.class);

  /**
   * Get all given gid numbers of all ProjectForge groups including any deleted group and get the next highest and free number. The number is
   * 1000 if no gid number (with a value greater than 999) is found.
   */
  public static int getNextFreeGidNumber()
  {
    final UserGroupCache userGroupCache = Registry.instance().getUserGroupCache();
    final Collection<GroupDO> allGroups = userGroupCache.getAllGroups();
    int currentMaxNumber = 999;
    for (final GroupDO group : allGroups) {
      final LdapGroupValues ldapGroupValues = GroupDOConverter.readLdapGroupValues(group.getLdapValues());
      if (ldapGroupValues == null) {
        continue;
      }
      if (ldapGroupValues.getGidNumber() != null && ldapGroupValues.getGidNumber().intValue() > currentMaxNumber) {
        currentMaxNumber = ldapGroupValues.getGidNumber();
      }
    }
    return currentMaxNumber + 1;
  }

  /**
   * For preventing double gidNumbers.
   * @param currentGroup
   * @param gidNumber
   * @return Returns true if any group (also deleted group) other than the given group has the given gidNumber, otherwise false.
   */
  public static boolean isGivenNumberFree(final GroupDO currentGroup, final int gidNumber)
  {
    final UserGroupCache userGroupCache = Registry.instance().getUserGroupCache();
    final Collection<GroupDO> allGroups = userGroupCache.getAllGroups();
    for (final GroupDO group : allGroups) {
      final LdapGroupValues ldapGroupValues = GroupDOConverter.readLdapGroupValues(group.getLdapValues());
      if (ObjectUtils.equals(group.getId(), currentGroup.getId()) == true) {
        // The current group may have the given gidNumber already, so ignore this entry.
        continue;
      }
      if (ldapGroupValues != null && ldapGroupValues.getGidNumber() != null && ldapGroupValues.getGidNumber().intValue() == gidNumber) {
        // Number isn't free.
        log.info("The gidNumber (posix account) '" + gidNumber + "' is already occupied by group: " + group);
        return false;
      }
    }
    return true;
  }

  /**
   * Sets next free gid.
   * @param ldapGroupValues
   * @param group
   */
  public static void setDefaultValues(final LdapGroupValues ldapGroupValues)
  {
    ldapGroupValues.setGidNumber(getNextFreeGidNumber());
  }
}