ad-promise/lib/services/service.findGroups.js

This is a fork of the gheeres node-activedirectory. It fixes some issues with timeouts with very large AD-Groups as well as returning also promises so you won't have to use callbacks

const _                                 = require('underscore');
const Group                             = require('../models/group');
const joinAttributes                    = require('./internal/service.joinAttributes');
const getRequiredLdapAttributesForGroup = require('./internal/service.getRequiredLdapAttributesForUser');
const includeGroupMembershipFor         = require('./internal/service.includeGroupMembershipFor');
const search                            = require('./internal/service.search');
const truncateLogOutput                 = require('./internal/service.truncateLogOutput');
const pickAttributes                    = require('./internal/service.pickAttributes');
const getCompoundFilter                 = require('./internal/service.getCompoundFilter');
const isGroupResult                     = require('./internal/service.isGroupResult');
const log                               = require('./internal/service.log');

const getGroupMembershipForDN           = require('./service.getGroupMembershipForDn');

const defaultAttributes                   = require('../configs/config.defaultAttributes');
const updateBaseDn                      = require('./internal/service.updateBaseDn');


/**
 * Perform a generic search for groups that match the specified filter. The default LDAP filter for groups is
 * specified as (&(objectClass=group)(!(objectClass=computer))(!(objectClass=user))(!(objectClass=person)))
 *
 * @public
 * @param {Object} [opts] Optional LDAP query string parameters to execute. { scope: '', filter: '', attributes: [ '', '', ... ], sizeLimit: 0, timelimit: 0 }. Optionally, if only a string is provided, then the string is assumed to be an LDAP filter that will be appended as the last parameter in the default LDAP filter.
 * @param {Function} callback The callback to execute when completed. callback(err: {Object}, groups: [ Group ])
 */
function findGroups(opts, callback) {
    var self = this;
    return new Promise((resolve, reject) => {
        var defaultGroupFilter = '(objectClass=group)(!(objectClass=computer))(!(objectClass=user))(!(objectClass=person))';

        if (typeof (opts) === 'function') {
            callback = opts;
            opts = '';
        }
        if ((typeof (opts) === 'string') && (opts)) {
            opts = {
                filter: '(&' + defaultGroupFilter + getCompoundFilter(opts) + ')'
            };
        }

        log.trace('findGroups(%j)', opts);

        var localOpts = _.defaults(_.omit(opts || {}, 'attributes'), {
            filter: '(&' + defaultGroupFilter + ')',
            scope: 'sub',
            attributes: joinAttributes((opts || {}).attributes || defaultAttributes.group || [], getRequiredLdapAttributesForGroup(opts),
                ['groupType'])
        });
        updateBaseDn(self, "group");
        search.call(self, localOpts, function onSearch(err, results) {
            if (err) {
                if (callback){
                    callback(err);
                }   
                return reject(err);
            }

            if ((!results) || (results.length === 0)) {
                log.warn('No groups found matching query "%s"', truncateLogOutput(localOpts.filter));
                if (callback){
                    callback(null, []);
                }
                return resolve([]);
            }

            var groups = [];
                    
            for(ind in results){
                let result = results[ind];
                if (isGroupResult(results[ind])){
                    var group = new Group(pickAttributes(result, (opts || {}).attributes || defaultAttributes.user));
                    groups.push(group);
                    // Also retrieving user group memberships?
                    if (includeGroupMembershipFor(opts, 'group')) {
                        getGroupMembershipForDN.call(self, opts, group.dn, function (err, groups) {
                            if (err){                            
                                if(callback){
                                    callback(err, null);
                                }                               
                                return reject(err);;
                            }

                            group.groups = groups;
                            self.emit('group', group);
                        });
                    } else {
                        self.emit('group', group);
                    }
                }                
            }
            if(callback){
                callback(null, groups)
            }
            return resolve(groups);       
        });
    });    
};

module.exports = findGroups;