Attachment 309683 Details for Bug 450989 – New memberof_config.c source file

New memberof_config.c source file

memberof_config.c (text/plain), 9.75 KB, created by Nathan Kinder on 2008-06-17 23:21:46 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Nathan Kinder

Created: 2008-06-17 23:21:46 UTC

Size: 9.75 KB

patch

obsolete

>/** BEGIN COPYRIGHT BLOCK
> * This Program 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 2 of the License.
> * 
> * This Program 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, write to the Free Software Foundation, Inc., 59 Temple
> * Place, Suite 330, Boston, MA 02111-1307 USA.
> * 
> * In addition, as a special exception, Red Hat, Inc. gives You the additional
> * right to link the code of this Program with code not covered under the GNU
> * General Public License ("Non-GPL Code") and to distribute linked combinations
> * including the two, subject to the limitations in this paragraph. Non-GPL Code
> * permitted under this exception must only link to the code of this Program
> * through those well defined interfaces identified in the file named EXCEPTION
> * found in the source code files (the "Approved Interfaces"). The files of
> * Non-GPL Code may instantiate templates or use macros or inline functions from
> * the Approved Interfaces without causing the resulting work to be covered by
> * the GNU General Public License. Only Red Hat, Inc. may make changes or
> * additions to the list of Approved Interfaces. You must obey the GNU General
> * Public License in all respects for all of the Program code and other code used
> * in conjunction with the Program except the Non-GPL Code covered by this
> * exception. If you modify this file, you may extend this exception to your
> * version of the file, but you are not obligated to do so. If you do not wish to
> * provide this exception without modification, you must delete this exception
> * statement from your version and license this file solely under the GPL without
> * exception. 
> * 
> * 
> * Copyright (C) 2008 Red Hat, Inc.
> * All rights reserved.
> * END COPYRIGHT BLOCK **/
>
>#ifdef HAVE_CONFIG_H
>#  include <config.h>
>#endif
>
>/*
> * memberof_config.c - configuration-related code for memberOf plug-in
> *
> */
>
>#include <plstr.h>
>
>#include "memberof.h"
>
>#define MEMBEROF_CONFIG_FILTER "(objectclass=*)"
>
>/*
> * The configuration attributes are contained in the plugin entry e.g.
> * cn=MemberOf Plugin,cn=plugins,cn=config
> *
> * Configuration is a two step process.  The first pass is a validation step which
> * occurs pre-op - check inputs and error out if bad.  The second pass actually
> * applies the changes to the run time config.
> */
>
>
>/*
> * function prototypes
> */ 
>static int memberof_validate_config (Slapi_PBlock *pb, Slapi_Entry* entryBefore, Slapi_Entry* e, 
>										 int *returncode, char *returntext, void *arg);
>static int memberof_apply_config (Slapi_PBlock *pb, Slapi_Entry* entryBefore, Slapi_Entry* e, 
>										 int *returncode, char *returntext, void *arg);
>static int memberof_search (Slapi_PBlock *pb, Slapi_Entry* entryBefore, Slapi_Entry* e, 
>								int *returncode, char *returntext, void *arg)
>{
>	return SLAPI_DSE_CALLBACK_OK;
>}
>
>/*
> * static variables
> */
>/* This is the main configuration which is updated from dse.ldif.  The
> * config will be copied when it is used by the plug-in to prevent it
> * being changed out from under a running memberOf operation. */
>static MemberOfConfig theConfig;
>static int		inited = 0;
>
>
>static int dont_allow_that(Slapi_PBlock *pb, Slapi_Entry* entryBefore, Slapi_Entry* e, 
>						   int *returncode, char *returntext, void *arg)
>{
>	*returncode = LDAP_UNWILLING_TO_PERFORM;
>	return SLAPI_DSE_CALLBACK_ERROR;
>}
>
>/*
> * memberof_config()
> *
> * Read configuration and create a configuration data structure.
> * This is called after the server has configured itself so we can
> * perform checks with regards to suffixes if it ever becomes
> * necessary.
> * Returns an LDAP error code (LDAP_SUCCESS if all goes well).
> */
>int
>memberof_config(Slapi_Entry *config_e)
>{
>	int returncode = LDAP_SUCCESS;
>	char returntext[SLAPI_DSE_RETURNTEXT_SIZE];
>
>	if ( inited ) {
>		slapi_log_error( SLAPI_LOG_FATAL, MEMBEROF_PLUGIN_SUBSYSTEM,
>						 "only one memberOf plugin instance can be used\n" );
>		return( LDAP_PARAM_ERROR );
>	}
>
>	theConfig.cfglock = slapi_new_mutex();
>
>	/* initialize fields */
>	if (SLAPI_DSE_CALLBACK_OK == memberof_validate_config(NULL, NULL, config_e,
>							&returncode, returntext, NULL)) {
>		memberof_apply_config(NULL, NULL, config_e,
>					&returncode, returntext, NULL);
>	}
>
>	/* config DSE must be initialized before we get here */
>	if (returncode == LDAP_SUCCESS) {
>		const char *config_dn = slapi_entry_get_dn_const(config_e);
>		slapi_config_register_callback(SLAPI_OPERATION_MODIFY, DSE_FLAG_PREOP, config_dn, LDAP_SCOPE_BASE,
>									   MEMBEROF_CONFIG_FILTER, memberof_validate_config,NULL);
>		slapi_config_register_callback(SLAPI_OPERATION_MODIFY, DSE_FLAG_POSTOP, config_dn, LDAP_SCOPE_BASE,
>									   MEMBEROF_CONFIG_FILTER, memberof_apply_config,NULL);
>		slapi_config_register_callback(SLAPI_OPERATION_MODRDN, DSE_FLAG_PREOP, config_dn, LDAP_SCOPE_BASE,
>									   MEMBEROF_CONFIG_FILTER, dont_allow_that, NULL);
>		slapi_config_register_callback(SLAPI_OPERATION_DELETE, DSE_FLAG_PREOP, config_dn, LDAP_SCOPE_BASE,
>									   MEMBEROF_CONFIG_FILTER, dont_allow_that, NULL);
>		slapi_config_register_callback(SLAPI_OPERATION_SEARCH, DSE_FLAG_PREOP, config_dn, LDAP_SCOPE_BASE,
>									   MEMBEROF_CONFIG_FILTER, memberof_search,NULL);
>	}
>
>	inited = 1;
>
>	if (returncode != LDAP_SUCCESS) {
>		slapi_log_error(SLAPI_LOG_FATAL, MEMBEROF_PLUGIN_SUBSYSTEM,
>				"Error %d: %s\n", returncode, returntext);
>        }
>
>	return returncode;
>}
>
>
>/*
> * memberof_validate_config()
> *
> * Validate the pending changes in the e entry.
> */
>static int 
>memberof_validate_config (Slapi_PBlock *pb, Slapi_Entry* entryBefore, Slapi_Entry* e, 
>	int *returncode, char *returntext, void *arg)
>{
>	Slapi_Attr *attr = NULL;
>
>	*returncode = LDAP_UNWILLING_TO_PERFORM; /* be pessimistic */
>
>	/* Make sure both the group attr and the memberOf attr
>	 * config atributes are supplied.  We don't care about &attr
>	 * here, but slapi_entry_attr_find() requires us to pass it. */
>	if (!slapi_entry_attr_find(e, MEMBEROF_GROUP_ATTR, &attr) &&
>		!slapi_entry_attr_find(e, MEMBEROF_ATTR, &attr))
>	{
>		*returncode = LDAP_SUCCESS;
>	} else {
>		PR_snprintf(returntext, SLAPI_DSE_RETURNTEXT_SIZE,
>			"The %s and %s configuration attributes must be provided",
>			MEMBEROF_GROUP_ATTR, MEMBEROF_ATTR); 
>	}
>
>	if (*returncode != LDAP_SUCCESS)
>	{
>		return SLAPI_DSE_CALLBACK_ERROR;
>	}
>	else
>	{
>		return SLAPI_DSE_CALLBACK_OK;
>	}
>}
>
>
>/*
> * memberof_apply_config()
> *
> * Apply the pending changes in the e entry to our config struct.
> * memberof_validate_config()  must have already been called.
> */
>static int 
>memberof_apply_config (Slapi_PBlock *pb, Slapi_Entry* entryBefore, Slapi_Entry* e, 
>	int *returncode, char *returntext, void *arg)
>{
>	char *groupattr = NULL;
>	char *memberof_attr = NULL;
>	char *filter_str = NULL;
>
>	*returncode = LDAP_SUCCESS;
>
>	groupattr = slapi_entry_attr_get_charptr(e, MEMBEROF_GROUP_ATTR);
>        memberof_attr = slapi_entry_attr_get_charptr(e, MEMBEROF_ATTR);
>
>	/* We want to be sure we don't change the config in the middle of
>	 * a memberOf operation, so we obtain the lock here */
>	memberof_lock_config();
>
>	if (!theConfig.groupattr ||
>		(groupattr && PL_strcmp(theConfig.groupattr, groupattr))) {
>		slapi_ch_free_string(&theConfig.groupattr);
>		theConfig.groupattr = groupattr;
>		groupattr = NULL; /* config now owns memory */
>
>		/* The filter is based off of the groupattr, so we
>		 * update it here too. */
>		slapi_filter_free(theConfig.group_filter, 1);
>		filter_str = slapi_ch_smprintf("(%s=*)", theConfig.groupattr);
>		theConfig.group_filter = slapi_str2filter(filter_str);
>		slapi_ch_free_string(&filter_str);
>	}
>
>	if (!theConfig.memberof_attr ||
>		(memberof_attr && PL_strcmp(theConfig.memberof_attr, memberof_attr))) {
>		slapi_ch_free_string(&theConfig.memberof_attr);
>		theConfig.memberof_attr = memberof_attr;
>		memberof_attr = NULL; /* config now owns memory */
>	}
>
>	/* release the lock */
>	memberof_unlock_config();
>
>	slapi_ch_free_string(&groupattr);
>	slapi_ch_free_string(&memberof_attr);
>
>	if (*returncode != LDAP_SUCCESS)
>	{
>		return SLAPI_DSE_CALLBACK_ERROR;
>	}
>	else
>	{
>		return SLAPI_DSE_CALLBACK_OK;
>	}
>}
>
>/*
> * memberof_copy_config()
> *
> * Makes a copy of the config in src.  This function will free the
> * elements of dest if they already exist.  This should only be called
> * if you hold the memberof config lock if src was obtained with
> * memberof_get_config().
> */
>void
>memberof_copy_config(MemberOfConfig *dest, MemberOfConfig *src)
>{
>	if (dest && src)
>	{
>		/* Check if the copy is already up to date */
>		if (!dest->groupattr || (src->groupattr
>			&& PL_strcmp(dest->groupattr, src->groupattr)))
>		{
>			slapi_ch_free_string(&dest->groupattr);
>			dest->groupattr = slapi_ch_strdup(src->groupattr);
>			slapi_filter_free(dest->group_filter, 1);
>			dest->group_filter = slapi_filter_dup(src->group_filter);
>		}
>
>		if (!dest->memberof_attr || (src->memberof_attr
>			&& PL_strcmp(dest->memberof_attr, src->memberof_attr)))
>		{
>			slapi_ch_free_string(&dest->memberof_attr);
>			dest->memberof_attr = slapi_ch_strdup(src->memberof_attr);
>		}
>	}
>}
>
>/*
> * memberof_get_config()
> *
> * Returns a pointer to the main config.  You should call
> * memberof_lock_config() first so the main config doesn't
> * get modified out from under you.
> */
>MemberOfConfig *
>memberof_get_config()
>{
>	return &theConfig;
>}
>
>/*
> * memberof_lock_config()
> *
> * Locks the main config to prevent it from being changed
> * out from under you.
> */
>void
>memberof_lock_config()
>{
>	slapi_lock_mutex(theConfig.cfglock);
>}
>
>/*
> * memberof_unlock_config()
> *
> * Unlocks the main config.
> */
>void
>memberof_unlock_config()
>{
>	slapi_unlock_mutex(theConfig.cfglock);
>}

Actions: View

Attachments on bug 450989: 309023 | 309024 | 309025 | 309681 | 309682 | 309683 | 309753 | 309754 | 309755 | 309804 | 309805 | 309806