Add ldapurl command

[openldap] / clients / tools / common.h

diff --git a/clients/tools/common.h b/clients/tools/common.h
index a0ce71c56918fc711b920d1cfcb5aeea27dc2a2a..025152d1d4532fff295adc36cf3ea1d0cfefa0f6 100644 (file)
--- a/clients/tools/common.h
+++ b/clients/tools/common.h
@@ -2,7 +2,7 @@
 /* $OpenLDAP$ */
 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
  *
- * Copyright 1998-2005 The OpenLDAP Foundation.
+ * Copyright 1998-2008 The OpenLDAP Foundation.
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -24,56 +24,90 @@
 
 LDAP_BEGIN_DECL
 
-/* Defined and set in common.c */
-extern int   authmethod;
-extern char *binddn;
-extern int   contoper;
-extern int   debug;
-extern char *infile;
-extern char *ldapuri;
-extern char *ldaphost;
-extern int   ldapport;
+typedef enum tool_type_t {
+       TOOL_SEARCH     = 0x01U,
+       TOOL_COMPARE    = 0x02U,
+       TOOL_ADD        = 0x04U,
+       TOOL_DELETE     = 0x08U,
+       TOOL_MODIFY     = 0x10U,
+       TOOL_MODRDN     = 0x20U,
+
+       TOOL_EXOP       = 0x40U,
+
+       TOOL_WHOAMI     = TOOL_EXOP | 0x100U,
+       TOOL_PASSWD     = TOOL_EXOP | 0x200U,
+
+       TOOL_WRITE      = (TOOL_ADD|TOOL_DELETE|TOOL_MODIFY|TOOL_MODRDN),
+       TOOL_READ       = (TOOL_SEARCH|TOOL_COMPARE),
+
+       TOOL_ALL        = 0xFFU
+} tool_type_t;
+
+
+/* input-related vars */
+
+/* misc. parameters */
+extern tool_type_t     tool_type;
+extern int             contoper;
+extern int             debug;
+extern char            *infile;
+extern int             dont;
+extern int             referrals;
+extern int             verbose;
+extern int             ldif;
+extern char            *prog;
+
+/* connection */
+extern char            *ldapuri;
+extern char            *ldaphost;
+extern int             ldapport;
+extern int             use_tls;
+extern int             protocol;
+extern int             version;
+
+/* authc/authz */
+extern int             authmethod;
+extern char            *binddn;
+extern int             want_bindpw;
+extern struct berval   passwd;
+extern char            *pw_file;
 #ifdef HAVE_CYRUS_SASL
-extern unsigned sasl_flags;
-extern char    *sasl_realm;
-extern char    *sasl_authc_id;
-extern char    *sasl_authz_id;
-extern char    *sasl_mech;
-extern char    *sasl_secprops;
+extern unsigned                sasl_flags;
+extern char            *sasl_realm;
+extern char            *sasl_authc_id;
+extern char            *sasl_authz_id;
+extern char            *sasl_mech;
+extern char            *sasl_secprops;
 #endif
-extern int   use_tls;
-
-extern char *assertion;
-extern char *authzid;
-extern int   manageDIT;
-extern int   manageDSAit;
-extern int   noop;
-extern int   ppolicy;
-extern int     preread, postread;
+
+/* controls */
+extern char            *assertion;
+extern char            *authzid;
+extern int             manageDIT;
+extern int             manageDSAit;
+extern int             noop;
+extern int             ppolicy;
+extern int             preread, postread;
+extern ber_int_t       pr_morePagedResults;
+extern struct berval   pr_cookie;
 #ifdef LDAP_CONTROL_X_CHAINING_BEHAVIOR
-extern int     chaining;
+extern int             chaining;
 #endif /* LDAP_CONTROL_X_CHAINING_BEHAVIOR */
 
-extern int   not;
-extern int   want_bindpw;
-extern struct berval passwd;
-extern char *pw_file;
-extern int   referrals;
-extern int   protocol;
-extern int   verbose;
-extern int   version;
+/* options */
+extern struct timeval  nettimeout;
 
 /* Defined in common.c, set in main() */
-extern char *prog;
-extern const char __Version[];
+extern const char      __Version[];
 
 /* Defined in main program */
-extern const char options[];
+extern const char      options[];
+
 void usage LDAP_P(( void )) LDAP_GCCATTR((noreturn));
 int handle_private_option LDAP_P(( int i ));
 
 /* Defined in common.c */
-void tool_init LDAP_P(( void ));
+void tool_init LDAP_P(( tool_type_t type ));
 void tool_common_usage LDAP_P(( void ));
 void tool_args LDAP_P(( int, char ** ));
 LDAP *tool_conn_setup LDAP_P(( int dont, void (*private_setup)( LDAP * ) ));
@@ -83,12 +117,16 @@ void tool_destroy LDAP_P(( void ));
 void tool_server_controls LDAP_P(( LDAP *, LDAPControl *, int ));
 int tool_check_abandon LDAP_P(( LDAP *ld, int msgid ));
 void tool_perror LDAP_P((
-       char *func,
+       const char *func,
        int err,
-       char *extra,
-       char *matched,
-       char *info,
+       const char *extra,
+       const char *matched,
+       const char *info,
        char **refs ));
+void tool_print_ctrls LDAP_P(( LDAP *ld, LDAPControl **ctrls ));
+int tool_write_ldif LDAP_P(( int type, char *name, char *value, ber_len_t vallen ));
+int tool_is_oid LDAP_P(( const char *s ));
+
 
 LDAP_END_DECL