зеркало из https://github.com/mozilla/gecko-dev.git
276 строки
10 KiB
C
276 строки
10 KiB
C
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* The contents of this file are subject to the Netscape Public
|
|
* License Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
* implied. See the License for the specific language governing
|
|
* rights and limitations under the License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
|
|
#ifndef _DIRPREFS_H_
|
|
#define _DIRPREFS_H_
|
|
|
|
#define kCurrentListVersion 1
|
|
|
|
/* DIR_Server.dirType */
|
|
typedef enum
|
|
{
|
|
LDAPDirectory,
|
|
HTMLDirectory,
|
|
PABDirectory
|
|
} DirectoryType;
|
|
|
|
typedef enum
|
|
{
|
|
cn,
|
|
givenname,
|
|
sn,
|
|
mail,
|
|
telephonenumber,
|
|
o,
|
|
ou,
|
|
l,
|
|
street,
|
|
auth,
|
|
custom1,
|
|
custom2,
|
|
custom3,
|
|
custom4,
|
|
custom5
|
|
} DIR_AttributeId;
|
|
|
|
typedef enum
|
|
{
|
|
capLdapV3, /* LDAP v3.0 protocol */
|
|
capVirtualListView, /* Virtual list view */
|
|
|
|
kNumCaps /* must be last capability */
|
|
} DIR_ServerCaps;
|
|
|
|
/* The values in this enum control the kind of LDAP filter expression
|
|
* we send to the LDAP server to do name completion
|
|
*/
|
|
typedef enum
|
|
{
|
|
acsGivenAndSurname, /* do auto-complete using givenname and sn attributes */
|
|
acsCnForwards, /* do auto-complete assuming cn in F L order */
|
|
acsCnBackwards /* do auto-complete assuming cn in L, F order */
|
|
} DIR_AutoCompleteStyle;
|
|
|
|
|
|
typedef struct _DIR_ReplicationInfo
|
|
{
|
|
char *description; /* human readable description of replica */
|
|
char *fileName; /* file name of replication database */
|
|
char *filter; /* LDAP filter string which constrains the repl search */
|
|
int32 lastChangeNumber; /* Last change we saw -- start replicating here */
|
|
char *dataVersion; /* LDAP server's scoping of the lastChangeNumber */
|
|
/* this changes when the server's DB gets reloaded from LDIF */
|
|
char **excludedAttributes; /* list of attributes we shouldn't replicate */
|
|
int excludedAttributesCount; /* duh */
|
|
} DIR_ReplicationInfo;
|
|
|
|
|
|
typedef struct DIR_Server
|
|
{
|
|
char *description; /* human readable name */
|
|
char *serverName; /* network host name */
|
|
char *searchBase; /* DN suffix to search at */
|
|
char *fileName; /* XP path name of local DB */
|
|
char *prefId; /* name of this server's tree in JS prefs */
|
|
int port; /* network port number */
|
|
int maxHits; /* maximum number of hits to return */
|
|
XP_Bool isSecure; /* use SSL? */
|
|
XP_Bool saveResults;
|
|
XP_Bool efficientWildcards; /* server can match substrings */
|
|
char *lastSearchString; /* required if saving results */
|
|
DirectoryType dirType;
|
|
uint32 flags;
|
|
uint32 refCount; /* Use count for server */
|
|
|
|
/* site-configurable attributes and filters */
|
|
XP_List *customFilters;
|
|
XP_List *customAttributes;
|
|
char *tokenSeps;
|
|
XP_Bool stopFiltersOnHit;
|
|
XP_Bool isOffline;
|
|
|
|
/* site-configurable list of attributes whose values are DNs */
|
|
char **dnAttributes;
|
|
int dnAttributesCount;
|
|
|
|
/* site-configurable list of attributes we shouldn't display in HTML */
|
|
char **suppressedAttributes;
|
|
int suppressedAttributesCount;
|
|
|
|
/* site-configurable list of attributes for the Basic Search dialog */
|
|
DIR_AttributeId *basicSearchAttributes;
|
|
int basicSearchAttributesCount;
|
|
|
|
/* site-configurable URL to open LDAP results */
|
|
char *customDisplayUrl;
|
|
|
|
/* authentication fields */
|
|
XP_Bool enableAuth; /* Use DN and password when binding? */
|
|
XP_Bool savePassword; /* Remember the DN and password we gave? */
|
|
char *authDn; /* DN to give to authenticate as */
|
|
char *password; /* Password for the DN */
|
|
|
|
/* Ldap fields */
|
|
DIR_ReplicationInfo *replInfo;
|
|
char *searchPairList;
|
|
|
|
/* auto-complete fields */
|
|
DIR_AutoCompleteStyle autoCompleteStyle;
|
|
|
|
} DIR_Server;
|
|
|
|
|
|
XP_BEGIN_PROTOS
|
|
|
|
/* We are developing a new model for managing DIR_Servers. In the 4.0x world, the FEs managed each list.
|
|
Calls to FE_GetDirServer caused the FEs to manage and return the DIR_Server list. In our new view of the
|
|
world, the back end does most of the list management so we are going to have the back end create and
|
|
manage the list. Replace calls to FE_GetDirServers() with DIR_GetDirServers(). */
|
|
|
|
XP_List * DIR_GetDirServers(void);
|
|
int DIR_ShutDown(void); /* FEs should call this when the app is shutting down. It frees all DIR_Servers regardless of ref count values! */
|
|
|
|
int DIR_DecrementServerRefCount (DIR_Server *);
|
|
int DIR_IncrementServerRefCount (DIR_Server *);
|
|
|
|
/* We are trying to phase out use of FE_GetDirServers. The back end is now managing the dir server list. So you should
|
|
be calling DIR_GetDirServers instead. */
|
|
|
|
XP_List * FE_GetDirServers(void);
|
|
|
|
/* Since the strings in DIR_Server are allocated, we have bottleneck
|
|
* routines to help with memory mgmt
|
|
*/
|
|
int DIR_InitServer (DIR_Server *);
|
|
int DIR_ValidateServer (DIR_Server *);
|
|
int DIR_CopyServer (DIR_Server *in, DIR_Server **out);
|
|
XP_Bool DIR_AreServersSame (DIR_Server *first, DIR_Server *second);
|
|
|
|
int DIR_DeleteServer (DIR_Server *);
|
|
int DIR_DeleteServerList(XP_List *wholeList);
|
|
|
|
int DIR_GetLdapServers (XP_List *wholeList, XP_List *subList);
|
|
int DIR_ReorderLdapServers (XP_List *wholeList);
|
|
|
|
/* These two routines should be called to initialize and save
|
|
* directory preferences from the XP Java Script preferences
|
|
*/
|
|
int DIR_GetServerPreferences (XP_List **list, const char* pabFile);
|
|
int DIR_SaveServerPreferences (XP_List *wholeList);
|
|
|
|
/* This routine will clean up files for deleted directories */
|
|
int DIR_CleanUpServerPreferences(XP_List *deletedList);
|
|
|
|
|
|
#if 1
|
|
|
|
/* Returns a pointer into the list (not allocated, so don't free) */
|
|
int DIR_GetPersonalAddressBook (XP_List *wholeList, DIR_Server **pab);
|
|
int DIR_GetComposeNameCompletionAddressBook (XP_List *wholeList, DIR_Server **cab);
|
|
|
|
/* Returns an allocated list of all personal address books, excluding
|
|
* LDAP directories, replicated directories, and CABs
|
|
*/
|
|
int DIR_GetPersonalAddressBooks (XP_List *wholeList, XP_List * subList);
|
|
|
|
#else
|
|
XP_List *DIR_GetAddressBooksForCompletion (XP_List *wholeList);
|
|
#endif
|
|
|
|
void DIR_GetServerFileName(char** filename, const char* leafName);
|
|
void DIR_SetServerFileName(DIR_Server* pServer, const char* leafName);
|
|
|
|
/* APIs for site-configurability of LDAP attribute names and
|
|
* search filter behavior.
|
|
*
|
|
* Strings are NOT allocated, and arrays are NULL-terminated
|
|
*/
|
|
const char *DIR_GetAttributeName (DIR_Server *server, DIR_AttributeId id);
|
|
const char **DIR_GetAttributeStrings (DIR_Server *server, DIR_AttributeId id);
|
|
const char *DIR_GetFirstAttributeString (DIR_Server *server, DIR_AttributeId id);
|
|
const char *DIR_GetFilterString (DIR_Server *server);
|
|
const char *DIR_GetReplicationFilter (DIR_Server *server);
|
|
const char *DIR_GetTokenSeparators (DIR_Server *server);
|
|
XP_Bool DIR_RepeatFilterForTokens (DIR_Server *server, const char *filter);
|
|
XP_Bool DIR_SubstStarsForSpaces (DIR_Server *server, const char *filter);
|
|
XP_Bool DIR_UseCustomAttribute (DIR_Server *server, DIR_AttributeId id);
|
|
|
|
XP_Bool DIR_IsDnAttribute (DIR_Server *s, const char *attr);
|
|
XP_Bool DIR_IsAttributeExcludedFromHtml (DIR_Server *s, const char *attr);
|
|
|
|
int DIR_AttributeNameToId (const char *attrName, DIR_AttributeId *id);
|
|
|
|
/* APIs for authentication */
|
|
void DIR_SetAuthDN (DIR_Server *s, const char *dn);
|
|
void DIR_SetPassword (DIR_Server *s, const char *password);
|
|
|
|
/* APIs for unescaping LDAP special chars */
|
|
char *DIR_Unescape (const char *src, XP_Bool makeHtml);
|
|
XP_Bool DIR_IsEscapedAttribute (DIR_Server *s, const char *attrib);
|
|
|
|
/* API for building a URL */
|
|
char *DIR_BuildUrl (DIR_Server *s, const char *dn, XP_Bool forAddToAB);
|
|
|
|
/* Walks the list enforcing the rule that only one LDAP server can be configured for autocomplete */
|
|
void DIR_SetAutoCompleteEnabled (XP_List *list, DIR_Server *server, XP_Bool enabled);
|
|
|
|
/* Flags manipulation */
|
|
|
|
#define DIR_AUTO_COMPLETE_ENABLED 0x00000001 /* Directory is configured for autocomplete addressing */
|
|
#define DIR_ENABLE_AUTH 0x00000002 /* Directory is configured for LDAP simple authentication */
|
|
#define DIR_SAVE_PASSWORD 0x00000004
|
|
#define DIR_UTF8_DISABLED 0x00000008 /* not used by the FEs */
|
|
#define DIR_IS_SECURE 0x00000010
|
|
#define DIR_SAVE_RESULTS 0x00000020 /* not used by the FEs */
|
|
#define DIR_EFFICIENT_WILDCARDS 0x00000040 /* not used by the FEs */
|
|
#define DIR_REPLICATION_ENABLED 0x00000080 /* Directory is configured for offline use */
|
|
#define DIR_LDAP_PUBLIC_DIRECTORY 0x00000100 /* not used by the FEs */
|
|
#define DIR_LDAP_VERSION3 0x00000200 /* not used by the FEs */
|
|
#define DIR_LDAP_VIRTUALLISTVIEW 0x00000400 /* not used by the FEs */
|
|
#define DIR_LDAP_ROOTDSE_PARSED 0x00000800 /* not used by the FEs */
|
|
|
|
XP_Bool DIR_TestFlag (DIR_Server *server, uint32 flag);
|
|
void DIR_SetFlag (DIR_Server *server, uint32 flag);
|
|
void DIR_ClearFlag (DIR_Server *server, uint32 flag);
|
|
void DIR_ForceFlag (DIR_Server *server, uint32 flag, XP_Bool forceOnOrOff);
|
|
|
|
char *DIR_ConvertToServerCharSet (DIR_Server *s, char *src, int16 srcCsid);
|
|
char *DIR_ConvertFromServerCharSet (DIR_Server *s, char *src, int16 dstCsid);
|
|
|
|
#ifdef MOZ_LDAP
|
|
|
|
/* Does the LDAP client lib work for SSL */
|
|
#include "ldap.h"
|
|
|
|
int DIR_SetupSecureConnection (LDAP *l);
|
|
|
|
/* APIs for replication */
|
|
int DIR_ValidateRootDSE (DIR_Server *s, char *version, int32 first, int32 last);
|
|
int DIR_ParseRootDSE (DIR_Server *s, LDAP *ld, LDAPMessage *message);
|
|
|
|
#endif /* MOZ_LDAP */
|
|
|
|
XP_END_PROTOS
|
|
|
|
|
|
#endif /* dirprefs.h */
|