Mercurial > hg > xemacs-beta
view modules/ldap/eldap.c @ 5127:a9c41067dd88 ben-lisp-object
more cleanups, terminology clarification, lots of doc work
-------------------- ChangeLog entries follow: --------------------
man/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* internals/internals.texi (Introduction to Allocation):
* internals/internals.texi (Integers and Characters):
* internals/internals.texi (Allocation from Frob Blocks):
* internals/internals.texi (lrecords):
* internals/internals.texi (Low-level allocation):
Rewrite section on allocation of Lisp objects to reflect the new
reality. Remove references to nonexistent XSETINT and XSETCHAR.
modules/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* postgresql/postgresql.c (allocate_pgconn):
* postgresql/postgresql.c (allocate_pgresult):
* postgresql/postgresql.h (struct Lisp_PGconn):
* postgresql/postgresql.h (struct Lisp_PGresult):
* ldap/eldap.c (allocate_ldap):
* ldap/eldap.h (struct Lisp_LDAP):
Same changes as in src/ dir. See large log there in ChangeLog,
but basically:
ALLOC_LISP_OBJECT -> ALLOC_NORMAL_LISP_OBJECT
LISP_OBJECT_HEADER -> NORMAL_LISP_OBJECT_HEADER
../hlo/src/ChangeLog addition:
2010-03-05 Ben Wing <ben@xemacs.org>
* alloc.c:
* alloc.c (old_alloc_sized_lcrecord):
* alloc.c (very_old_free_lcrecord):
* alloc.c (copy_lisp_object):
* alloc.c (zero_sized_lisp_object):
* alloc.c (zero_nonsized_lisp_object):
* alloc.c (lisp_object_storage_size):
* alloc.c (free_normal_lisp_object):
* alloc.c (FREE_FIXED_TYPE_WHEN_NOT_IN_GC):
* alloc.c (ALLOC_FROB_BLOCK_LISP_OBJECT):
* alloc.c (Fcons):
* alloc.c (noseeum_cons):
* alloc.c (make_float):
* alloc.c (make_bignum):
* alloc.c (make_bignum_bg):
* alloc.c (make_ratio):
* alloc.c (make_ratio_bg):
* alloc.c (make_ratio_rt):
* alloc.c (make_bigfloat):
* alloc.c (make_bigfloat_bf):
* alloc.c (size_vector):
* alloc.c (make_compiled_function):
* alloc.c (Fmake_symbol):
* alloc.c (allocate_extent):
* alloc.c (allocate_event):
* alloc.c (make_key_data):
* alloc.c (make_button_data):
* alloc.c (make_motion_data):
* alloc.c (make_process_data):
* alloc.c (make_timeout_data):
* alloc.c (make_magic_data):
* alloc.c (make_magic_eval_data):
* alloc.c (make_eval_data):
* alloc.c (make_misc_user_data):
* alloc.c (Fmake_marker):
* alloc.c (noseeum_make_marker):
* alloc.c (size_string_direct_data):
* alloc.c (make_uninit_string):
* alloc.c (make_string_nocopy):
* alloc.c (mark_lcrecord_list):
* alloc.c (alloc_managed_lcrecord):
* alloc.c (free_managed_lcrecord):
* alloc.c (sweep_lcrecords_1):
* alloc.c (malloced_storage_size):
* buffer.c (allocate_buffer):
* buffer.c (compute_buffer_usage):
* buffer.c (DEFVAR_BUFFER_LOCAL_1):
* buffer.c (nuke_all_buffer_slots):
* buffer.c (common_init_complex_vars_of_buffer):
* buffer.h (struct buffer_text):
* buffer.h (struct buffer):
* bytecode.c:
* bytecode.c (make_compiled_function_args):
* bytecode.c (size_compiled_function_args):
* bytecode.h (struct compiled_function_args):
* casetab.c (allocate_case_table):
* casetab.h (struct Lisp_Case_Table):
* charset.h (struct Lisp_Charset):
* chartab.c (fill_char_table):
* chartab.c (Fmake_char_table):
* chartab.c (make_char_table_entry):
* chartab.c (copy_char_table_entry):
* chartab.c (Fcopy_char_table):
* chartab.c (put_char_table):
* chartab.h (struct Lisp_Char_Table_Entry):
* chartab.h (struct Lisp_Char_Table):
* console-gtk-impl.h (struct gtk_device):
* console-gtk-impl.h (struct gtk_frame):
* console-impl.h (struct console):
* console-msw-impl.h (struct Lisp_Devmode):
* console-msw-impl.h (struct mswindows_device):
* console-msw-impl.h (struct msprinter_device):
* console-msw-impl.h (struct mswindows_frame):
* console-msw-impl.h (struct mswindows_dialog_id):
* console-stream-impl.h (struct stream_console):
* console-stream.c (stream_init_console):
* console-tty-impl.h (struct tty_console):
* console-tty-impl.h (struct tty_device):
* console-tty.c (allocate_tty_console_struct):
* console-x-impl.h (struct x_device):
* console-x-impl.h (struct x_frame):
* console.c (allocate_console):
* console.c (nuke_all_console_slots):
* console.c (DEFVAR_CONSOLE_LOCAL_1):
* console.c (common_init_complex_vars_of_console):
* data.c (make_weak_list):
* data.c (make_weak_box):
* data.c (make_ephemeron):
* database.c:
* database.c (struct Lisp_Database):
* database.c (allocate_database):
* database.c (finalize_database):
* device-gtk.c (allocate_gtk_device_struct):
* device-impl.h (struct device):
* device-msw.c:
* device-msw.c (mswindows_init_device):
* device-msw.c (msprinter_init_device):
* device-msw.c (finalize_devmode):
* device-msw.c (allocate_devmode):
* device-tty.c (allocate_tty_device_struct):
* device-x.c (allocate_x_device_struct):
* device.c:
* device.c (nuke_all_device_slots):
* device.c (allocate_device):
* dialog-msw.c (handle_question_dialog_box):
* elhash.c:
* elhash.c (struct Lisp_Hash_Table):
* elhash.c (finalize_hash_table):
* elhash.c (make_general_lisp_hash_table):
* elhash.c (Fcopy_hash_table):
* elhash.h (htentry):
* emacs.c (main_1):
* eval.c:
* eval.c (size_multiple_value):
* event-stream.c (finalize_command_builder):
* event-stream.c (allocate_command_builder):
* event-stream.c (free_command_builder):
* event-stream.c (event_stream_generate_wakeup):
* event-stream.c (event_stream_resignal_wakeup):
* event-stream.c (event_stream_disable_wakeup):
* event-stream.c (event_stream_wakeup_pending_p):
* events.h (struct Lisp_Timeout):
* events.h (struct command_builder):
* extents-impl.h:
* extents-impl.h (struct extent_auxiliary):
* extents-impl.h (struct extent_info):
* extents-impl.h (set_extent_no_chase_aux_field):
* extents-impl.h (set_extent_no_chase_normal_field):
* extents.c:
* extents.c (gap_array_marker):
* extents.c (gap_array):
* extents.c (extent_list_marker):
* extents.c (extent_list):
* extents.c (stack_of_extents):
* extents.c (gap_array_make_marker):
* extents.c (extent_list_make_marker):
* extents.c (allocate_extent_list):
* extents.c (SLOT):
* extents.c (mark_extent_auxiliary):
* extents.c (allocate_extent_auxiliary):
* extents.c (attach_extent_auxiliary):
* extents.c (size_gap_array):
* extents.c (finalize_extent_info):
* extents.c (allocate_extent_info):
* extents.c (uninit_buffer_extents):
* extents.c (allocate_soe):
* extents.c (copy_extent):
* extents.c (vars_of_extents):
* extents.h:
* faces.c (allocate_face):
* faces.h (struct Lisp_Face):
* faces.h (struct face_cachel):
* file-coding.c:
* file-coding.c (finalize_coding_system):
* file-coding.c (sizeof_coding_system):
* file-coding.c (Fcopy_coding_system):
* file-coding.h (struct Lisp_Coding_System):
* file-coding.h (MARKED_SLOT):
* fns.c (size_bit_vector):
* font-mgr.c:
* font-mgr.c (finalize_fc_pattern):
* font-mgr.c (print_fc_pattern):
* font-mgr.c (Ffc_pattern_p):
* font-mgr.c (Ffc_pattern_create):
* font-mgr.c (Ffc_name_parse):
* font-mgr.c (Ffc_name_unparse):
* font-mgr.c (Ffc_pattern_duplicate):
* font-mgr.c (Ffc_pattern_add):
* font-mgr.c (Ffc_pattern_del):
* font-mgr.c (Ffc_pattern_get):
* font-mgr.c (fc_config_create_using):
* font-mgr.c (fc_strlist_to_lisp_using):
* font-mgr.c (fontset_to_list):
* font-mgr.c (Ffc_config_p):
* font-mgr.c (Ffc_config_up_to_date):
* font-mgr.c (Ffc_config_build_fonts):
* font-mgr.c (Ffc_config_get_cache):
* font-mgr.c (Ffc_config_get_fonts):
* font-mgr.c (Ffc_config_set_current):
* font-mgr.c (Ffc_config_get_blanks):
* font-mgr.c (Ffc_config_get_rescan_interval):
* font-mgr.c (Ffc_config_set_rescan_interval):
* font-mgr.c (Ffc_config_app_font_add_file):
* font-mgr.c (Ffc_config_app_font_add_dir):
* font-mgr.c (Ffc_config_app_font_clear):
* font-mgr.c (size):
* font-mgr.c (Ffc_config_substitute):
* font-mgr.c (Ffc_font_render_prepare):
* font-mgr.c (Ffc_font_match):
* font-mgr.c (Ffc_font_sort):
* font-mgr.c (finalize_fc_config):
* font-mgr.c (print_fc_config):
* font-mgr.h:
* font-mgr.h (struct fc_pattern):
* font-mgr.h (XFC_PATTERN):
* font-mgr.h (struct fc_config):
* font-mgr.h (XFC_CONFIG):
* frame-gtk.c (allocate_gtk_frame_struct):
* frame-impl.h (struct frame):
* frame-msw.c (mswindows_init_frame_1):
* frame-x.c (allocate_x_frame_struct):
* frame.c (nuke_all_frame_slots):
* frame.c (allocate_frame_core):
* gc.c:
* gc.c (GC_CHECK_NOT_FREE):
* glyphs.c (finalize_image_instance):
* glyphs.c (allocate_image_instance):
* glyphs.c (Fcolorize_image_instance):
* glyphs.c (allocate_glyph):
* glyphs.c (unmap_subwindow_instance_cache_mapper):
* glyphs.c (register_ignored_expose):
* glyphs.h (struct Lisp_Image_Instance):
* glyphs.h (struct Lisp_Glyph):
* glyphs.h (struct glyph_cachel):
* glyphs.h (struct expose_ignore):
* gui.c (allocate_gui_item):
* gui.h (struct Lisp_Gui_Item):
* keymap.c (struct Lisp_Keymap):
* keymap.c (make_keymap):
* lisp.h:
* lisp.h (struct Lisp_String_Direct_Data):
* lisp.h (struct Lisp_String_Indirect_Data):
* lisp.h (struct Lisp_Vector):
* lisp.h (struct Lisp_Bit_Vector):
* lisp.h (DECLARE_INLINE_LISP_BIT_VECTOR):
* lisp.h (struct weak_box):
* lisp.h (struct ephemeron):
* lisp.h (struct weak_list):
* lrecord.h:
* lrecord.h (struct lrecord_implementation):
* lrecord.h (MC_ALLOC_CALL_FINALIZER):
* lrecord.h (struct lcrecord_list):
* lstream.c (finalize_lstream):
* lstream.c (sizeof_lstream):
* lstream.c (Lstream_new):
* lstream.c (Lstream_delete):
* lstream.h (struct lstream):
* marker.c:
* marker.c (finalize_marker):
* marker.c (compute_buffer_marker_usage):
* mule-charset.c:
* mule-charset.c (make_charset):
* mule-charset.c (compute_charset_usage):
* objects-impl.h (struct Lisp_Color_Instance):
* objects-impl.h (struct Lisp_Font_Instance):
* objects-tty-impl.h (struct tty_color_instance_data):
* objects-tty-impl.h (struct tty_font_instance_data):
* objects-tty.c (tty_initialize_color_instance):
* objects-tty.c (tty_initialize_font_instance):
* objects.c (finalize_color_instance):
* objects.c (Fmake_color_instance):
* objects.c (finalize_font_instance):
* objects.c (Fmake_font_instance):
* objects.c (reinit_vars_of_objects):
* opaque.c:
* opaque.c (sizeof_opaque):
* opaque.c (make_opaque_ptr):
* opaque.c (free_opaque_ptr):
* opaque.h:
* opaque.h (Lisp_Opaque):
* opaque.h (Lisp_Opaque_Ptr):
* print.c (printing_unreadable_lcrecord):
* print.c (external_object_printer):
* print.c (debug_p4):
* process.c (finalize_process):
* process.c (make_process_internal):
* procimpl.h (struct Lisp_Process):
* rangetab.c (Fmake_range_table):
* rangetab.c (Fcopy_range_table):
* rangetab.h (struct Lisp_Range_Table):
* scrollbar.c:
* scrollbar.c (create_scrollbar_instance):
* scrollbar.c (compute_scrollbar_instance_usage):
* scrollbar.h (struct scrollbar_instance):
* specifier.c (finalize_specifier):
* specifier.c (sizeof_specifier):
* specifier.c (set_specifier_caching):
* specifier.h (struct Lisp_Specifier):
* specifier.h (struct specifier_caching):
* symeval.h:
* symeval.h (SYMBOL_VALUE_MAGIC_P):
* symeval.h (DEFVAR_SYMVAL_FWD):
* symsinit.h:
* syntax.c (init_buffer_syntax_cache):
* syntax.h (struct syntax_cache):
* toolbar.c:
* toolbar.c (allocate_toolbar_button):
* toolbar.c (update_toolbar_button):
* toolbar.h (struct toolbar_button):
* tooltalk.c (struct Lisp_Tooltalk_Message):
* tooltalk.c (make_tooltalk_message):
* tooltalk.c (struct Lisp_Tooltalk_Pattern):
* tooltalk.c (make_tooltalk_pattern):
* ui-gtk.c:
* ui-gtk.c (allocate_ffi_data):
* ui-gtk.c (emacs_gtk_object_finalizer):
* ui-gtk.c (allocate_emacs_gtk_object_data):
* ui-gtk.c (allocate_emacs_gtk_boxed_data):
* ui-gtk.h:
* window-impl.h (struct window):
* window-impl.h (struct window_mirror):
* window.c (finalize_window):
* window.c (allocate_window):
* window.c (new_window_mirror):
* window.c (mark_window_as_deleted):
* window.c (make_dummy_parent):
* window.c (compute_window_mirror_usage):
* window.c (compute_window_usage):
Overall point of this change and previous ones in this repository:
(1) Introduce new, clearer terminology: everything other than int
or char is a "record" object, which comes in two types: "normal
objects" and "frob-block objects". Fix up all places that
referred to frob-block objects as "simple", "basic", etc.
(2) Provide an advertised interface for doing operations on Lisp
objects, including creating new types, that is clean and
consistent in its naming, uses the above-referenced terms and
avoids referencing "lrecords", "old lcrecords", etc., which should
hide under the surface.
(3) Make the size_in_bytes and finalizer methods take a
Lisp_Object rather than a void * for consistency with other methods.
(4) Separate finalizer method into finalizer and disksaver, so
that normal finalize methods don't have to worry about disksaving.
Other specifics:
(1) Renaming:
LISP_OBJECT_HEADER -> NORMAL_LISP_OBJECT_HEADER
ALLOC_LISP_OBJECT -> ALLOC_NORMAL_LISP_OBJECT
implementation->basic_p -> implementation->frob_block_p
ALLOCATE_FIXED_TYPE_AND_SET_IMPL -> ALLOC_FROB_BLOCK_LISP_OBJECT
*FCCONFIG*, wrap_fcconfig -> *FC_CONFIG*, wrap_fc_config
*FCPATTERN*, wrap_fcpattern -> *FC_PATTERN*, wrap_fc_pattern
(the last two changes make the naming of these macros consistent
with the naming of all other macros, since the objects are named
fc-config and fc-pattern with a hyphen)
(2) Lots of documentation fixes in lrecord.h.
(3) Eliminate macros for copying, freeing, zeroing objects, getting
their storage size. Instead, new functions:
zero_sized_lisp_object()
zero_nonsized_lisp_object()
lisp_object_storage_size()
free_normal_lisp_object()
(copy_lisp_object() already exists)
LISP_OBJECT_FROB_BLOCK_P() (actually a macro)
Eliminated:
free_lrecord()
zero_lrecord()
copy_lrecord()
copy_sized_lrecord()
old_copy_lcrecord()
old_copy_sized_lcrecord()
old_zero_lcrecord()
old_zero_sized_lcrecord()
LISP_OBJECT_STORAGE_SIZE()
COPY_SIZED_LISP_OBJECT()
COPY_SIZED_LCRECORD()
COPY_LISP_OBJECT()
ZERO_LISP_OBJECT()
FREE_LISP_OBJECT()
(4) Catch the remaining places where lrecord stuff was used directly
and use the advertised interface, e.g. alloc_sized_lrecord() ->
ALLOC_SIZED_LISP_OBJECT().
(5) Make certain statically-declared pseudo-objects
(buffer_local_flags, console_local_flags) have their lheader
initialized correctly, so things like copy_lisp_object() can work
on them. Make extent_auxiliary_defaults a proper heap object
Vextent_auxiliary_defaults, and make extent auxiliaries dumpable
so that this object can be dumped. allocate_extent_auxiliary()
now just creates the object, and attach_extent_auxiliary()
creates an extent auxiliary and attaches to an extent, like the
old allocate_extent_auxiliary().
(6) Create EXTENT_AUXILIARY_SLOTS macro, similar to the foo-slots.h
files but in a macro instead of a file. The purpose is to avoid
duplication when iterating over all the slots in an extent auxiliary.
Use it.
(7) In lstream.c, don't zero out object after allocation because
allocation routines take care of this.
(8) In marker.c, fix a mistake in computing marker overhead.
(9) In print.c, clean up printing_unreadable_lcrecord(),
external_object_printer() to avoid lots of ifdef NEW_GC's.
(10) Separate toolbar-button allocation into a separate
allocate_toolbar_button() function for use in the example code
in lrecord.h.
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Fri, 05 Mar 2010 04:08:17 -0600 |
parents | b5df3737028a |
children | 0dcd22290039 |
line wrap: on
line source
/* LDAP client interface for XEmacs. Copyright (C) 1998 Free Software Foundation, Inc. Copyright (C) 2004, 2005, 2010 Ben Wing. This file is part of XEmacs. XEmacs 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; either version 2, or (at your option) any later version. XEmacs 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 XEmacs; see the file COPYING. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ /* Synched up with: Not in FSF. */ /* Author: Oscar Figueiredo with lots of support from Hrvoje Niksic */ /* This file provides lisp primitives for access to an LDAP library conforming to the API defined in RFC 1823. It has been tested with: - UMich LDAP 3.3 (http://www.umich.edu/~dirsvcs/ldap/) - OpenLDAP 1.2 (http://www.openldap.org/) - Netscape's LDAP SDK (http://developer.netscape.com/) */ #include <config.h> #include "lisp.h" #include "opaque.h" #include "sysdep.h" #include "buffer.h" #include "process.h" /* for report_process_error */ #ifdef HAVE_SHLIB # include "emodules.h" #endif #include <errno.h> #include "eldap.h" static Fixnum ldap_default_port; static Lisp_Object Vldap_default_base; static Lisp_Object Qeldap; /* Needed by the lrecord definition */ Lisp_Object Qldapp; /* ldap-open plist keywords */ static Lisp_Object Qport, Qauth, Qbinddn, Qpasswd, Qderef, Qtimelimit, Qsizelimit; /* Search scope limits */ static Lisp_Object Qbase, Qonelevel, Qsubtree; /* Authentication methods */ static Lisp_Object Qkrbv41, Qkrbv42; /* Deref policy */ static Lisp_Object Qnever, Qalways, Qfind; /* Modification types (Qdelete is defined in general.c) */ static Lisp_Object Qadd, Qreplace; /************************************************************************/ /* Utility Functions */ /************************************************************************/ static DECLARE_DOESNT_RETURN (signal_ldap_error (LDAP *, LDAPMessage *, int)); static DOESNT_RETURN signal_ldap_error (LDAP *ld, #if defined HAVE_LDAP_PARSE_RESULT || defined HAVE_LDAP_RESULT2ERROR LDAPMessage *res, #else LDAPMessage *UNUSED (res), #endif int ldap_err) { if (ldap_err <= 0) { #if defined HAVE_LDAP_PARSE_RESULT int err; ldap_err = ldap_parse_result (ld, res, &err, NULL, NULL, NULL, NULL, 0); if (ldap_err == LDAP_SUCCESS) ldap_err = err; #elif defined HAVE_LDAP_GET_LDERRNO ldap_err = ldap_get_lderrno (ld, NULL, NULL); #elif defined HAVE_LDAP_RESULT2ERROR ldap_err = ldap_result2error (ld, res, 0); #else ldap_err = ld->ld_errno; #endif } invalid_operation ("LDAP error", build_extstring (ldap_err2string (ldap_err), Qnative)); } /************************************************************************/ /* ldap lrecord basic functions */ /************************************************************************/ static Lisp_Object make_ldap (Lisp_LDAP *ldap) { return wrap_ldap (ldap); } static const struct memory_description ldap_description [] = { { XD_LISP_OBJECT, offsetof (struct Lisp_LDAP, host) }, { XD_END } }; static Lisp_Object mark_ldap (Lisp_Object obj) { return XLDAP (obj)->host; } static void print_ldap (Lisp_Object obj, Lisp_Object printcharfun, int UNUSED (escapeflag)) { Lisp_LDAP *ldap = XLDAP (obj); if (print_readably) printing_unreadable_object ("#<ldap %s>", XSTRING_DATA (ldap->host)); write_fmt_string_lisp (printcharfun, "#<ldap %S", 1, ldap->host); if (!ldap->ld) write_ascstring (printcharfun,"(dead) "); write_fmt_string (printcharfun, " 0x%lx>", (long)ldap); } static Lisp_LDAP * allocate_ldap (void) { Lisp_LDAP *ldap = XLDAP (ALLOC_NORMAL_LISP_OBJECT (ldap)); ldap->ld = NULL; ldap->host = Qnil; return ldap; } static void finalize_ldap (void *header) { Lisp_LDAP *ldap = (Lisp_LDAP *) header; if (ldap->ld) ldap_unbind (ldap->ld); ldap->ld = NULL; } DEFINE_NODUMP_LISP_OBJECT ("ldap", ldap, mark_ldap, print_ldap, finalize_ldap, NULL, NULL, ldap_description, Lisp_LDAP); /************************************************************************/ /* Basic ldap accessors */ /************************************************************************/ /* ###autoload */ DEFUN ("ldapp", Fldapp, 1, 1, 0, /* Return t if OBJECT is a LDAP connection. */ (object)) { return LDAPP (object) ? Qt : Qnil; } DEFUN ("ldap-host", Fldap_host, 1, 1, 0, /* Return the server host of the connection LDAP, as a string. */ (ldap)) { CHECK_LDAP (ldap); return (XLDAP (ldap))->host; } DEFUN ("ldap-live-p", Fldap_live_p, 1, 1, 0, /* Return t if LDAP is an active LDAP connection. */ (ldap)) { CHECK_LDAP (ldap); return (XLDAP (ldap))->ld ? Qt : Qnil; } /************************************************************************/ /* Opening/Closing a LDAP connection */ /************************************************************************/ /* ###autoload */ DEFUN ("ldap-open", Fldap_open, 1, 2, 0, /* Open a LDAP connection to HOST. PLIST is a plist containing additional parameters for the connection. Valid keys in that list are: `port' the TCP port to use for the connection if different from `ldap-default-port'. `auth' is the authentication method to use, possible values depend on the LDAP library XEmacs was compiled with: `simple', `krbv41' and `krbv42'. `binddn' is the distinguished name of the user to bind as (in RFC 1779 syntax). `passwd' is the password to use for simple authentication. `deref' is one of the symbols `never', `always', `search' or `find'. `timelimit' is the timeout limit for the connection in seconds. `sizelimit' is the maximum number of matches to return. */ (host, plist)) { /* This function can GC */ Lisp_LDAP *ldap; LDAP *ld; int ldap_port = 0; int ldap_auth = LDAP_AUTH_SIMPLE; Extbyte *ldap_binddn = NULL; Extbyte *ldap_password = NULL; int ldap_deref = LDAP_DEREF_NEVER; int ldap_timelimit = 0; int ldap_sizelimit = 0; int err; CHECK_STRING (host); { EXTERNAL_PROPERTY_LIST_LOOP_3 (keyword, value, plist) { /* TCP Port */ if (EQ (keyword, Qport)) { CHECK_INT (value); ldap_port = XINT (value); } /* Authentication method */ if (EQ (keyword, Qauth)) { if (EQ (value, Qsimple)) ldap_auth = LDAP_AUTH_SIMPLE; #ifdef LDAP_AUTH_KRBV41 else if (EQ (value, Qkrbv41)) ldap_auth = LDAP_AUTH_KRBV41; #endif #ifdef LDAP_AUTH_KRBV42 else if (EQ (value, Qkrbv42)) ldap_auth = LDAP_AUTH_KRBV42; #endif else invalid_constant ("Invalid authentication method", value); } /* Bind DN */ else if (EQ (keyword, Qbinddn)) { CHECK_STRING (value); ldap_binddn = LISP_STRING_TO_EXTERNAL (value, Qnative); } /* Password */ else if (EQ (keyword, Qpasswd)) { CHECK_STRING (value); ldap_password = LISP_STRING_TO_EXTERNAL (value, Qnative); } /* Deref */ else if (EQ (keyword, Qderef)) { if (EQ (value, Qnever)) ldap_deref = LDAP_DEREF_NEVER; else if (EQ (value, Qsearch)) ldap_deref = LDAP_DEREF_SEARCHING; else if (EQ (value, Qfind)) ldap_deref = LDAP_DEREF_FINDING; else if (EQ (value, Qalways)) ldap_deref = LDAP_DEREF_ALWAYS; else invalid_constant ("Invalid deref value", value); } /* Timelimit */ else if (EQ (keyword, Qtimelimit)) { CHECK_INT (value); ldap_timelimit = XINT (value); } /* Sizelimit */ else if (EQ (keyword, Qsizelimit)) { CHECK_INT (value); ldap_sizelimit = XINT (value); } } } if (ldap_port == 0) { ldap_port = ldap_default_port; } /* Connect to the server and bind */ slow_down_interrupts (); ld = ldap_open (LISP_STRING_TO_EXTERNAL (host, Qnative), ldap_port); speed_up_interrupts (); if (ld == NULL ) report_process_error ("Failed connecting to host", host); #ifdef HAVE_LDAP_SET_OPTION if ((err = ldap_set_option (ld, LDAP_OPT_DEREF, (void *)&ldap_deref)) != LDAP_SUCCESS) signal_ldap_error (ld, NULL, err); if ((err = ldap_set_option (ld, LDAP_OPT_TIMELIMIT, (void *)&ldap_timelimit)) != LDAP_SUCCESS) signal_ldap_error (ld, NULL, err); if ((err = ldap_set_option (ld, LDAP_OPT_SIZELIMIT, (void *)&ldap_sizelimit)) != LDAP_SUCCESS) signal_ldap_error (ld, NULL, err); if ((err = ldap_set_option (ld, LDAP_OPT_REFERRALS, LDAP_OPT_ON)) != LDAP_SUCCESS) signal_ldap_error (ld, NULL, err); if ((err = ldap_set_option (ld, LDAP_OPT_RESTART, LDAP_OPT_ON)) != LDAP_SUCCESS) signal_ldap_error (ld, NULL, err); #else /* not HAVE_LDAP_SET_OPTION */ ld->ld_deref = ldap_deref; ld->ld_timelimit = ldap_timelimit; ld->ld_sizelimit = ldap_sizelimit; #ifdef LDAP_REFERRALS ld->ld_options = LDAP_OPT_REFERRALS; #else /* not LDAP_REFERRALS */ ld->ld_options = 0; #endif /* not LDAP_REFERRALS */ /* XEmacs uses interrupts (SIGIO,SIGALRM), LDAP calls need to ignore them */ ld->ld_options |= LDAP_OPT_RESTART; #endif /* not HAVE_LDAP_SET_OPTION */ err = ldap_bind_s (ld, ldap_binddn, ldap_password, ldap_auth); if (err != LDAP_SUCCESS) { signal_error (Qprocess_error, "Failed binding to the server", build_extstring (ldap_err2string (err), Qnative)); } ldap = allocate_ldap (); ldap->ld = ld; ldap->host = host; return make_ldap (ldap); } DEFUN ("ldap-close", Fldap_close, 1, 1, 0, /* Close an LDAP connection. */ (ldap)) { Lisp_LDAP *lldap; CHECK_LIVE_LDAP (ldap); lldap = XLDAP (ldap); ldap_unbind (lldap->ld); lldap->ld = NULL; return Qnil; } /************************************************************************/ /* Working on a LDAP connection */ /************************************************************************/ struct ldap_unwind_struct { LDAPMessage *res; struct berval **vals; }; static Lisp_Object ldap_search_unwind (Lisp_Object unwind_obj) { struct ldap_unwind_struct *unwind = (struct ldap_unwind_struct *) get_opaque_ptr (unwind_obj); if (unwind->res) ldap_msgfree (unwind->res); if (unwind->vals) ldap_value_free_len (unwind->vals); return Qnil; } /* The following function is called `ldap-search-basic' instead of */ /* plain `ldap-search' to maintain compatibility with the XEmacs 21.1 */ /* API where `ldap-search' was the name of the high-level search */ /* function */ DEFUN ("ldap-search-basic", Fldap_search_basic, 2, 8, 0, /* Perform a search on an open LDAP connection. LDAP is an LDAP connection object created with `ldap-open'. FILTER is a filter string for the search as described in RFC 1558. BASE is the distinguished name at which to start the search. SCOPE is one of the symbols `base', `onelevel' or `subtree' indicating the scope of the search. ATTRS is a list of strings indicating which attributes to retrieve for each matching entry. If nil return all available attributes. If ATTRSONLY is non-nil then only the attributes are retrieved, not the associated values. If WITHDN is non-nil each entry in the result will be prepended with its distinguished name DN. If VERBOSE is non-nil progress messages will be echoed. The function returns a list of matching entries. Each entry is itself an alist of attribute/value pairs optionally preceded by the DN of the entry according to the value of WITHDN. */ (ldap, filter, base, scope, attrs, attrsonly, withdn, verbose)) { /* This function can GC */ /* Vars for query */ LDAP *ld; LDAPMessage *e; BerElement *ptr; Extbyte *a, *dn, *bs, *filt; int i, rc; int matches; struct ldap_unwind_struct unwind; int ldap_scope = LDAP_SCOPE_SUBTREE; Extbyte **ldap_attributes = NULL; int speccount = specpdl_depth (); Lisp_Object list = Qnil; Lisp_Object entry = Qnil; Lisp_Object result = Qnil; struct gcpro gcpro1, gcpro2, gcpro3; GCPRO3 (list, entry, result); unwind.res = NULL; unwind.vals = NULL; /* Do all the parameter checking */ CHECK_LIVE_LDAP (ldap); ld = XLDAP (ldap)->ld; /* Filter */ CHECK_STRING (filter); /* Search base */ if (NILP (base)) { base = Vldap_default_base; } if (!NILP (base)) { CHECK_STRING (base); } /* Search scope */ if (!NILP (scope)) { if (EQ (scope, Qbase)) ldap_scope = LDAP_SCOPE_BASE; else if (EQ (scope, Qonelevel)) ldap_scope = LDAP_SCOPE_ONELEVEL; else if (EQ (scope, Qsubtree)) ldap_scope = LDAP_SCOPE_SUBTREE; else invalid_constant ("Invalid scope", scope); } /* Attributes to search */ if (!NILP (attrs)) { CHECK_CONS (attrs); ldap_attributes = alloca_array (char *, 1 + XINT (Flength (attrs))); i = 0; { EXTERNAL_LIST_LOOP_2 (current, attrs) { CHECK_STRING (current); ldap_attributes[i] = LISP_STRING_TO_EXTERNAL (current, Qnative); ++i; } } ldap_attributes[i] = NULL; } /* Attributes only ? */ CHECK_SYMBOL (attrsonly); /* Perform the search */ bs = NILP (base) ? (Extbyte *) "" : LISP_STRING_TO_EXTERNAL (base, Qnative); filt = NILP (filter) ? (Extbyte *) "" : LISP_STRING_TO_EXTERNAL (filter, Qnative); if (ldap_search (ld, bs, ldap_scope, filt, ldap_attributes, NILP (attrsonly) ? 0 : 1) == -1) { signal_ldap_error (ld, NULL, 0); } /* Ensure we don't exit without cleaning up */ record_unwind_protect (ldap_search_unwind, make_opaque_ptr (&unwind)); /* Build the results list */ matches = 0; rc = ldap_result (ld, LDAP_RES_ANY, 0, NULL, &unwind.res); while (rc == LDAP_RES_SEARCH_ENTRY) { QUIT; matches ++; e = ldap_first_entry (ld, unwind.res); /* #### This call to message() is pretty fascist, because it destroys the current echo area contents, even when invoked from Lisp. It should use echo_area_message() instead, and restore the old echo area contents later. */ if (! NILP (verbose)) message ("Parsing ldap results... %d", matches); entry = Qnil; /* Get the DN if required */ if (! NILP (withdn)) { dn = ldap_get_dn (ld, e); if (dn == NULL) signal_ldap_error (ld, e, 0); entry = Fcons (build_extstring (dn, Qnative), Qnil); } for (a = ldap_first_attribute (ld, e, &ptr); a != NULL; a = ldap_next_attribute (ld, e, ptr)) { list = Fcons (build_extstring (a, Qnative), Qnil); unwind.vals = ldap_get_values_len (ld, e, a); if (unwind.vals != NULL) { for (i = 0; unwind.vals[i] != NULL; i++) { list = Fcons (make_extstring ((Extbyte *) unwind.vals[i]->bv_val, unwind.vals[i]->bv_len, Qnative), list); } } entry = Fcons (Fnreverse (list), entry); ldap_value_free_len (unwind.vals); unwind.vals = NULL; } result = Fcons (Fnreverse (entry), result); ldap_msgfree (unwind.res); unwind.res = NULL; rc = ldap_result (ld, LDAP_RES_ANY, 0, NULL, &(unwind.res)); } #if defined HAVE_LDAP_PARSE_RESULT { int rc2 = ldap_parse_result (ld, unwind.res, &rc, NULL, NULL, NULL, NULL, 0); if (rc2 != LDAP_SUCCESS) rc = rc2; } #else if (rc == 0) signal_ldap_error (ld, NULL, LDAP_TIMELIMIT_EXCEEDED); if (rc == -1) signal_ldap_error (ld, unwind.res, (unwind.res==NULL) ? ld->ld_errno : 0); #if defined HAVE_LDAP_RESULT2ERROR rc = ldap_result2error (ld, unwind.res, 0); #endif #endif if (rc != LDAP_SUCCESS) signal_ldap_error (ld, NULL, rc); ldap_msgfree (unwind.res); unwind.res = (LDAPMessage *)NULL; /* #### See above for calling message(). */ if (! NILP (verbose)) message ("Parsing ldap results... done"); unbind_to (speccount); UNGCPRO; return Fnreverse (result); } DEFUN ("ldap-add", Fldap_add, 3, 3, 0, /* Add an entry to an LDAP directory. LDAP is an LDAP connection object created with `ldap-open'. DN is the distinguished name of the entry to add. ENTRY is an entry specification, i.e., a list of cons cells containing attribute/value string pairs. */ (ldap, dn, entry)) { LDAP *ld; LDAPMod *ldap_mods, **ldap_mods_ptrs; struct berval *bervals; int rc; int i, j; Elemcount len; Lisp_Object values = Qnil; struct gcpro gcpro1; GCPRO1 (values); /* Do all the parameter checking */ CHECK_LIVE_LDAP (ldap); ld = XLDAP (ldap)->ld; /* Check the DN */ CHECK_STRING (dn); /* Check the entry */ CHECK_CONS (entry); if (NILP (entry)) invalid_operation ("Cannot add void entry", entry); /* Build the ldap_mods array */ len = (Elemcount) XINT (Flength (entry)); ldap_mods = alloca_array (LDAPMod, len); ldap_mods_ptrs = alloca_array (LDAPMod *, 1 + len); i = 0; { EXTERNAL_LIST_LOOP_2 (current, entry) { CHECK_CONS (current); CHECK_STRING (XCAR (current)); ldap_mods_ptrs[i] = &(ldap_mods[i]); ldap_mods[i].mod_type = LISP_STRING_TO_EXTERNAL (XCAR (current), Qnative); ldap_mods[i].mod_op = LDAP_MOD_ADD | LDAP_MOD_BVALUES; values = XCDR (current); if (CONSP (values)) { len = (Elemcount) XINT (Flength (values)); bervals = alloca_array (struct berval, len); ldap_mods[i].mod_vals.modv_bvals = alloca_array (struct berval *, 1 + len); j = 0; { EXTERNAL_LIST_LOOP_2 (cur2, values) { CHECK_STRING (cur2); ldap_mods[i].mod_vals.modv_bvals[j] = &(bervals[j]); TO_EXTERNAL_FORMAT (LISP_STRING, cur2, ALLOCA, (bervals[j].bv_val, bervals[j].bv_len), Qnative); j++; } } ldap_mods[i].mod_vals.modv_bvals[j] = NULL; } else { CHECK_STRING (values); bervals = alloca_array (struct berval, 1); ldap_mods[i].mod_vals.modv_bvals = alloca_array (struct berval *, 2); ldap_mods[i].mod_vals.modv_bvals[0] = &(bervals[0]); TO_EXTERNAL_FORMAT (LISP_STRING, values, ALLOCA, (bervals[0].bv_val, bervals[0].bv_len), Qnative); ldap_mods[i].mod_vals.modv_bvals[1] = NULL; } i++; } } ldap_mods_ptrs[i] = NULL; rc = ldap_add_s (ld, LISP_STRING_TO_EXTERNAL (dn, Qnative), ldap_mods_ptrs); if (rc != LDAP_SUCCESS) signal_ldap_error (ld, NULL, rc); UNGCPRO; return Qnil; } DEFUN ("ldap-modify", Fldap_modify, 3, 3, 0, /* Add an entry to an LDAP directory. LDAP is an LDAP connection object created with `ldap-open'. DN is the distinguished name of the entry to modify. MODS is a list of modifications to apply. A modification is a list of the form (MOD-OP ATTR VALUE1 VALUE2 ...) MOD-OP and ATTR are mandatory, VALUEs are optional depending on MOD-OP. MOD-OP is the type of modification, one of the symbols `add', `delete' or `replace'. ATTR is the LDAP attribute type to modify. */ (ldap, dn, mods)) { LDAP *ld; LDAPMod *ldap_mods, **ldap_mods_ptrs; struct berval *bervals; int i, j, rc; Lisp_Object mod_op; Elemcount len; Lisp_Object values = Qnil; struct gcpro gcpro1; /* Do all the parameter checking */ CHECK_LIVE_LDAP (ldap); ld = XLDAP (ldap)->ld; /* Check the DN */ CHECK_STRING (dn); /* Check the entry */ CHECK_CONS (mods); if (NILP (mods)) return Qnil; /* Build the ldap_mods array */ len = (Elemcount) XINT (Flength (mods)); ldap_mods = alloca_array (LDAPMod, len); ldap_mods_ptrs = alloca_array (LDAPMod *, 1 + len); i = 0; GCPRO1 (values); { EXTERNAL_LIST_LOOP_2 (current, mods) { CHECK_CONS (current); CHECK_SYMBOL (XCAR (current)); mod_op = XCAR (current); ldap_mods_ptrs[i] = &(ldap_mods[i]); ldap_mods[i].mod_op = LDAP_MOD_BVALUES; if (EQ (mod_op, Qadd)) ldap_mods[i].mod_op |= LDAP_MOD_ADD; else if (EQ (mod_op, Qdelete)) ldap_mods[i].mod_op |= LDAP_MOD_DELETE; else if (EQ (mod_op, Qreplace)) ldap_mods[i].mod_op |= LDAP_MOD_REPLACE; else invalid_constant ("Invalid LDAP modification type", mod_op); current = XCDR (current); CHECK_STRING (XCAR (current)); ldap_mods[i].mod_type = LISP_STRING_TO_EXTERNAL (XCAR (current), Qnative); values = XCDR (current); len = (Elemcount) XINT (Flength (values)); bervals = alloca_array (struct berval, len); ldap_mods[i].mod_vals.modv_bvals = alloca_array (struct berval *, 1 + len); j = 0; { EXTERNAL_LIST_LOOP_2 (cur2, values) { CHECK_STRING (cur2); ldap_mods[i].mod_vals.modv_bvals[j] = &(bervals[j]); TO_EXTERNAL_FORMAT (LISP_STRING, cur2, ALLOCA, (bervals[j].bv_val, bervals[j].bv_len), Qnative); j++; } ldap_mods[i].mod_vals.modv_bvals[j] = NULL; i++; } } } ldap_mods_ptrs[i] = NULL; rc = ldap_modify_s (ld, LISP_STRING_TO_EXTERNAL (dn, Qnative), ldap_mods_ptrs); if (rc != LDAP_SUCCESS) signal_ldap_error (ld, NULL, rc); UNGCPRO; return Qnil; } DEFUN ("ldap-delete", Fldap_delete, 2, 2, 0, /* Delete an entry to an LDAP directory. LDAP is an LDAP connection object created with `ldap-open'. DN is the distinguished name of the entry to delete. */ (ldap, dn)) { LDAP *ld; int rc; /* Check parameters */ CHECK_LIVE_LDAP (ldap); ld = XLDAP (ldap)->ld; CHECK_STRING (dn); rc = ldap_delete_s (ld, LISP_STRING_TO_EXTERNAL (dn, Qnative)); if (rc != LDAP_SUCCESS) signal_ldap_error (ld, NULL, rc); return Qnil; } void syms_of_eldap (void) { INIT_LISP_OBJECT (ldap); DEFSYMBOL (Qeldap); DEFSYMBOL (Qldapp); DEFSYMBOL (Qport); DEFSYMBOL (Qauth); DEFSYMBOL (Qbinddn); DEFSYMBOL (Qpasswd); DEFSYMBOL (Qderef); DEFSYMBOL (Qtimelimit); DEFSYMBOL (Qsizelimit); DEFSYMBOL (Qbase); DEFSYMBOL (Qonelevel); DEFSYMBOL (Qsubtree); DEFSYMBOL (Qkrbv41); DEFSYMBOL (Qkrbv42); DEFSYMBOL (Qnever); DEFSYMBOL (Qalways); DEFSYMBOL (Qfind); DEFSYMBOL (Qadd); DEFSYMBOL (Qreplace); DEFSUBR (Fldapp); DEFSUBR (Fldap_host); DEFSUBR (Fldap_live_p); DEFSUBR (Fldap_open); DEFSUBR (Fldap_close); DEFSUBR (Fldap_search_basic); DEFSUBR (Fldap_add); DEFSUBR (Fldap_modify); DEFSUBR (Fldap_delete); } void vars_of_eldap (void) { Fprovide (Qeldap); ldap_default_port = LDAP_PORT; Vldap_default_base = Qnil; DEFVAR_INT ("ldap-default-port", &ldap_default_port /* Default TCP port for LDAP connections. Initialized from the LDAP library. Default value is 389. */ ); DEFVAR_LISP ("ldap-default-base", &Vldap_default_base /* Default base for LDAP searches. This is a string using the syntax of RFC 1779. For instance, "o=ACME, c=US" limits the search to the Acme organization in the United States. */ ); } #ifdef HAVE_SHLIB EXTERN_C void unload_eldap (void); void unload_eldap (void) { /* Remove defined types */ UNDEF_LISP_OBJECT (ldap); /* Remove staticpro'ing of symbols */ unstaticpro_nodump (&Qeldap); unstaticpro_nodump (&Qldapp); unstaticpro_nodump (&Qport); unstaticpro_nodump (&Qauth); unstaticpro_nodump (&Qbinddn); unstaticpro_nodump (&Qpasswd); unstaticpro_nodump (&Qderef); unstaticpro_nodump (&Qtimelimit); unstaticpro_nodump (&Qsizelimit); unstaticpro_nodump (&Qbase); unstaticpro_nodump (&Qonelevel); unstaticpro_nodump (&Qsubtree); unstaticpro_nodump (&Qkrbv41); unstaticpro_nodump (&Qkrbv42); unstaticpro_nodump (&Qnever); unstaticpro_nodump (&Qalways); unstaticpro_nodump (&Qfind); unstaticpro_nodump (&Qadd); unstaticpro_nodump (&Qreplace); } #endif /* HAVE_SHLIB */