]> git.sur5r.net Git - openldap/blobdiff - libraries/libldap/ldap-int.h
Added the functions ldap_rename2() and ldap_rename2_s() to support LDAP
[openldap] / libraries / libldap / ldap-int.h
index 7948578895fe4aa2562c13d5a3808b3c83332733..9f27a0a6a347086c52114095720f0fe6ba06170a 100644 (file)
@@ -1,4 +1,8 @@
 /*
+ * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
+ * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
+ */
+/*  Portions
  *  Copyright (c) 1995 Regents of the University of Michigan.
  *  All rights reserved.
  *
 #ifndef        _LDAP_INT_H
 #define        _LDAP_INT_H 1
 
-#ifdef LDAP_COMPILING_R
+#ifdef LDAP_R_COMPILE
 #define LDAP_THREAD_SAFE 1
 #endif
 
 #include "../liblber/lber-int.h"
+
+#define ldap_debug     (openldap_ldap_global_options.ldo_debug)
+#undef Debug
+#define Debug( level, fmt, arg1, arg2, arg3 ) \
+       ldap_log_printf( NULL, (level), (fmt), (arg1), (arg2), (arg3) )
+
 #include "ldap_log.h"
+
 #include "ldap.h"
 
+#include "ldap_pvt.h"
+
 LDAP_BEGIN_DECL
 
 #define LDAP_URL_PREFIX         "ldap://"
@@ -66,22 +79,107 @@ struct ldapmsg {
  * which have global defaults.
  */
 struct ldapoptions {
+       int             ldo_debug;
+
        int             ldo_version;    /* version to connect at */
        int             ldo_deref;
        int             ldo_timelimit;
        int             ldo_sizelimit;
 
+       int             ldo_defport;
        char*   ldo_defbase;
        char*   ldo_defhost;
-       int             ldo_defport;
 
        int             ldo_cldaptries; /* connectionless search retry count */
        int             ldo_cldaptimeout;/* time between retries */
        int             ldo_refhoplimit;        /* limit on referral nesting */
 
+       /* LDAPv3 server and client controls */
+       LDAPControl     **ldo_server_controls;
+       LDAPControl **ldo_client_controls;
+       
        LDAP_BOOLEANS ldo_booleans;     /* boolean options */
 };
 
+#ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
+/*
+ * structure for tracking LDAP server host, ports, DNs, etc.
+ */
+typedef struct ldap_server {
+       char                    *lsrv_host;
+       char                    *lsrv_dn;       /* if NULL, use default */
+       int                     lsrv_port;
+       struct ldap_server      *lsrv_next;
+} LDAPServer;
+
+
+/*
+ * structure for representing an LDAP server connection
+ */
+typedef struct ldap_conn {
+       Sockbuf                 *lconn_sb;
+       int                     lconn_refcnt;
+       time_t          lconn_lastused; /* time */
+       int                     lconn_status;
+#define LDAP_CONNST_NEEDSOCKET         1
+#define LDAP_CONNST_CONNECTING         2
+#define LDAP_CONNST_CONNECTED          3
+       LDAPServer              *lconn_server;
+       char                    *lconn_krbinstance;
+       struct ldap_conn        *lconn_next;
+       BerElement              lconn_ber;/* ber receiving on this conn. */
+} LDAPConn;
+
+
+/*
+ * structure used to track outstanding requests
+ */
+typedef struct ldapreq {
+       int             lr_msgid;       /* the message id */
+       int             lr_status;      /* status of request */
+#define LDAP_REQST_INPROGRESS  1
+#define LDAP_REQST_CHASINGREFS 2
+#define LDAP_REQST_NOTCONNECTED        3
+#define LDAP_REQST_WRITING     4
+       int             lr_outrefcnt;   /* count of outstanding referrals */
+       int             lr_origid;      /* original request's message id */
+       int             lr_parentcnt;   /* count of parent requests */
+       int             lr_res_msgtype; /* result message type */
+       int             lr_res_errno;   /* result LDAP errno */
+       char            *lr_res_error;  /* result error string */
+       char            *lr_res_matched;/* result matched DN string */
+       BerElement      *lr_ber;        /* ber encoded request contents */
+       LDAPConn        *lr_conn;       /* connection used to send request */
+       struct ldapreq  *lr_parent;     /* request that spawned this referral */
+       struct ldapreq  *lr_refnext;    /* next referral spawned */
+       struct ldapreq  *lr_prev;       /* previous request */
+       struct ldapreq  *lr_next;       /* next request */
+} LDAPRequest;
+#endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
+
+/*
+ * structure for client cache
+ */
+#define LDAP_CACHE_BUCKETS     31      /* cache hash table size */
+typedef struct ldapcache {
+       LDAPMessage     *lc_buckets[LDAP_CACHE_BUCKETS];/* hash table */
+       LDAPMessage     *lc_requests;                   /* unfulfilled reqs */
+       long            lc_timeout;                     /* request timeout */
+       long            lc_maxmem;                      /* memory to use */
+       long            lc_memused;                     /* memory in use */
+       int             lc_enabled;                     /* enabled? */
+       unsigned long   lc_options;                     /* options */
+#define LDAP_CACHE_OPT_CACHENOERRS     0x00000001
+#define LDAP_CACHE_OPT_CACHEALLERRS    0x00000002
+}  LDAPCache;
+#define NULLLDCACHE ((LDAPCache *)NULL)
+
+/*
+ * handy macro for checking if handle is connectionless
+ */
+
+#define LDAP_IS_CLDAP(ld) ((ld)->ld_cldapnaddr>0)
+
 /*
  * structure representing an ldap connection
  */
@@ -127,8 +225,14 @@ struct ldap {
        int             *ld_abandoned;  /* array of abandoned requests */
        char            ld_attrbuffer[LDAP_MAX_ATTR_LEN];
        LDAPCache       *ld_cache;      /* non-null if cache is initialized */
-       char            *ld_cldapdn;    /* DN used in connectionless search */
-
+       /* stuff used by connectionless searches. */
+       char            *ld_cldapdn;    /* DN used in connectionless search */
+       int             ld_cldapnaddr; /* number of addresses */
+       void            **ld_cldapaddrs;/* addresses to send request to */
+#ifndef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS       
+       /* BerElement that this connection is receiving. */
+       BerElement      ld_ber;
+#endif 
        /* do not mess with the rest though */
        BERTranslateProc ld_lber_encode_translate_proc;
        BERTranslateProc ld_lber_decode_translate_proc;
@@ -150,6 +254,11 @@ extern int openldap_ldap_initialized;
 extern struct ldapoptions openldap_ldap_global_options;
 void openldap_ldap_initialize LDAP_P((void));
 
+/*
+ * in print.c
+ */
+int ldap_log_printf LDAP_P((LDAP *ld, int level, char *fmt, ...));
+
 /*
  * in cache.c
  */
@@ -158,6 +267,13 @@ void ldap_add_request_to_cache LDAP_P(( LDAP *ld, unsigned long msgtype,
 void ldap_add_result_to_cache LDAP_P(( LDAP *ld, LDAPMessage *result ));
 int ldap_check_cache LDAP_P(( LDAP *ld, unsigned long msgtype, BerElement *request ));
 
+/*
+ * in controls.c
+ */
+LDAPControl *ldap_control_dup LDAP_P(( LDAPControl *ctrl ));
+LDAPControl **ldap_controls_dup LDAP_P(( LDAPControl **ctrl ));
+int ldap_get_ber_controls LDAP_P(( BerElement *be, LDAPControl ***cp));
+
 /*
  * in dsparse.c
  */
@@ -277,30 +393,6 @@ int ldap_8859_to_t61( char **bufp, unsigned long *buflenp, int free_input );
 #endif /* LDAP_CHARSET_8859 == LDAP_DEFAULT_CHARSET */
 #endif /* STR_TRANSLATION && LDAP_DEFAULT_CHARSET */
 
-/*
- * in util_r.c
- * 
- */
-
-struct hostent;        /* avoid pulling in <netdb.h> */
-
-extern char *ldap_int_strtok( char *str, const char *delim, char **pos );
-extern char *ldap_int_ctime( const time_t *tp, char *buf );
-extern int ldap_int_gethostbyname_a(
-       const char *name, 
-       struct hostent *resbuf,
-       char **buf,
-       struct hostent **result,
-       int *herrno_ptr );
-extern int ldap_int_gethostbyaddr_a(
-       const char *addr,
-       int len,
-       int type,
-       struct hostent *resbuf,
-       char **buf,
-       struct hostent **result,
-       int *herrno_ptr );
-
 LDAP_END_DECL
 
 #endif /* _LDAP_INT_H */