dlls/wldap32/control.c

   1 /*
   2  * WLDAP32 - LDAP support for Wine
   3  *
   4  * Copyright 2005 Hans Leidekker
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  19  */
  20
  21 #include <stdarg.h>
  22 #include "windef.h"
  23 #include "winbase.h"
  24 #include "winnls.h"
  25 #include "winldap.h"
  26
  27 #include "wine/debug.h"
  28 #include "winldap_private.h"
  29
  30 WINE_DEFAULT_DEBUG_CHANNEL(wldap32);
  31
  32 /***********************************************************************
  33  *      ldap_control_freeA     (WLDAP32.@)
  34  *
  35  * See ldap_control_freeW.
  36  */
  37 ULONG CDECL ldap_control_freeA( LDAPControlA *control )
  38 {
  39     TRACE( "(%p)\n", control );
  40     controlfreeA( control );
  41     return LDAP_SUCCESS;
  42 }
  43
  44 /***********************************************************************
  45  *      ldap_control_freeW     (WLDAP32.@)
  46  *
  47  * Free an LDAPControl structure.
  48  *
  49  * PARAMS
  50  *  control  [I] LDAPControl structure to free.
  51  *
  52  * RETURNS
  53  *  LDAP_SUCCESS
  54  */
  55 ULONG CDECL ldap_control_freeW( LDAPControlW *control )
  56 {
  57     TRACE( "(%p)\n", control );
  58     controlfreeW( control );
  59     return LDAP_SUCCESS;
  60 }
  61
  62 /***********************************************************************
  63  *      ldap_controls_freeA     (WLDAP32.@)
  64  *
  65  * See ldap_controls_freeW.
  66  */
  67 ULONG CDECL ldap_controls_freeA( LDAPControlA **controls )
  68 {
  69     TRACE( "(%p)\n", controls );
  70     controlarrayfreeA( controls );
  71     return LDAP_SUCCESS;
  72 }
  73
  74 /***********************************************************************
  75  *      ldap_controls_freeW     (WLDAP32.@)
  76  *
  77  * Free an array of LDAPControl structures.
  78  *
  79  * PARAMS
  80  *  controls  [I] Array of LDAPControl structures to free.
  81  *
  82  * RETURNS
  83  *  LDAP_SUCCESS
  84  */
  85 ULONG CDECL ldap_controls_freeW( LDAPControlW **controls )
  86 {
  87     TRACE( "(%p)\n", controls );
  88     controlarrayfreeW( controls );
  89     return LDAP_SUCCESS;
  90 }
  91
  92 /***********************************************************************
  93  *      ldap_create_sort_controlA     (WLDAP32.@)
  94  *
  95  * See ldap_create_sort_controlW.
  96  */
  97 ULONG CDECL ldap_create_sort_controlA( LDAP *ld, LDAPSortKeyA **sortkey, UCHAR critical, LDAPControlA **control )
  98 {
  99     ULONG ret;
 100     LDAPSortKeyW **sortkeyW;
 101     LDAPControlW *controlW;
 102
 103     TRACE( "(%p, %p, 0x%02x, %p)\n", ld, sortkey, critical, control );
 104
 105     if (!ld || !sortkey || !control) return LDAP_PARAM_ERROR;
 106
 107     if (!(sortkeyW = sortkeyarrayAtoW( sortkey ))) return LDAP_NO_MEMORY;
 108
 109     ret = ldap_create_sort_controlW( ld, sortkeyW, critical, &controlW );
 110     if (ret == LDAP_SUCCESS)
 111     {
 112         LDAPControlA *controlA = controlWtoA( controlW );
 113         if (controlA) *control = controlA;
 114         else ret = LDAP_NO_MEMORY;
 115         ldap_control_freeW( controlW );
 116     }
 117
 118     sortkeyarrayfreeW( sortkeyW );
 119     return ret;
 120 }
 121
 122 /***********************************************************************
 123  *      ldap_create_sort_controlW     (WLDAP32.@)
 124  *
 125  * Create a control for server sorted search results.
 126  *
 127  * PARAMS
 128  *  ld       [I] Pointer to an LDAP context.
 129  *  sortkey  [I] Array of LDAPSortKey structures, each specifying an
 130  *               attribute to use as a sort key, a matching rule and
 131  *               the sort order (ascending or descending).
 132  *  critical [I] Tells the server this control is critical to the
 133  *               search operation.
 134  *  control  [O] LDAPControl created.
 135  *
 136  * RETURNS
 137  *  Success: LDAP_SUCCESS
 138  *  Failure: An LDAP error code.
 139  *
 140  * NOTES
 141  *  Pass the created control as a server control in subsequent calls
 142  *  to ldap_search_ext(_s) to obtain sorted search results.
 143  */
 144 ULONG CDECL ldap_create_sort_controlW( LDAP *ld, LDAPSortKeyW **sortkey, UCHAR critical, LDAPControlW **control )
 145 {
 146     ULONG ret;
 147     LDAPSortKeyU **sortkeyU;
 148     LDAPControlU *controlU;
 149
 150     TRACE( "(%p, %p, 0x%02x, %p)\n", ld, sortkey, critical, control );
 151
 152     if (!ld || !sortkey || !control) return LDAP_PARAM_ERROR;
 153
 154     if (!(sortkeyU = sortkeyarrayWtoU( sortkey ))) return LDAP_NO_MEMORY;
 155
 156     ret = map_error( ldap_funcs->fn_ldap_create_sort_control( CTX(ld), sortkeyU, critical, &controlU ) );
 157     if (ret == LDAP_SUCCESS)
 158     {
 159         LDAPControlW *controlW = controlUtoW( controlU );
 160         if (controlW) *control = controlW;
 161         else ret = LDAP_NO_MEMORY;
 162         ldap_funcs->fn_ldap_control_free( controlU );
 163     }
 164
 165     sortkeyarrayfreeU( sortkeyU );
 166     return ret;
 167 }
 168
 169 /***********************************************************************
 170  *      ldap_create_vlv_controlA     (WLDAP32.@)
 171  *
 172  * See ldap_create_vlv_controlW.
 173  */
 174 INT CDECL ldap_create_vlv_controlA( LDAP *ld, LDAPVLVInfo *info, UCHAR critical, LDAPControlA **control )
 175 {
 176     INT ret;
 177     LDAPControlW *controlW;
 178
 179     TRACE( "(%p, %p, 0x%02x, %p)\n", ld, info, critical, control );
 180
 181     if (!ld || !control) return ~0u;
 182
 183     ret = ldap_create_vlv_controlW( ld, info, critical, &controlW );
 184     if (ret == LDAP_SUCCESS)
 185     {
 186         LDAPControlA *controlA = controlWtoA( controlW );
 187         if (controlA) *control = controlA;
 188         else ret = LDAP_NO_MEMORY;
 189         ldap_control_freeW( controlW );
 190     }
 191
 192     return ret;
 193 }
 194
 195 /***********************************************************************
 196  *      ldap_create_vlv_controlW     (WLDAP32.@)
 197  *
 198  * Create a virtual list view control.
 199  *
 200  * PARAMS
 201  *  ld       [I] Pointer to an LDAP context.
 202  *  info     [I] LDAPVLVInfo structure specifying a list view window.
 203  *  critical [I] Tells the server this control is critical to the
 204  *               search operation.
 205  *  control  [O] LDAPControl created.
 206  *
 207  * RETURNS
 208  *  Success: LDAP_SUCCESS
 209  *  Failure: An LDAP error code.
 210  *
 211  * NOTES
 212  *  Pass the created control in conjunction with a sort control as
 213  *  server controls in subsequent calls to ldap_search_ext(_s). The
 214  *  server will then return a sorted, contiguous subset of results
 215  *  that meets the criteria specified in the LDAPVLVInfo structure.
 216  */
 217 INT CDECL ldap_create_vlv_controlW( LDAP *ld, LDAPVLVInfo *info, UCHAR critical, LDAPControlW **control )
 218 {
 219     ULONG ret;
 220     LDAPVLVInfoU *infoU = NULL;
 221     LDAPControlU *controlU;
 222
 223     TRACE( "(%p, %p, 0x%02x, %p)\n", ld, info, critical, control );
 224
 225     if (!ld || !control) return ~0u;
 226
 227     if (info && !(infoU = vlvinfoWtoU( info ))) return LDAP_NO_MEMORY;
 228
 229     ret = map_error( ldap_funcs->fn_ldap_create_vlv_control( CTX(ld), infoU, &controlU ) );
 230     if (ret == LDAP_SUCCESS)
 231     {
 232         LDAPControlW *controlW = controlUtoW( controlU );
 233         if (controlW) *control = controlW;
 234         else ret = LDAP_NO_MEMORY;
 235         ldap_funcs->fn_ldap_control_free( controlU );
 236     }
 237
 238     vlvinfofreeU( infoU );
 239     return ret;
 240 }
 241
 242 static inline void bv_val_dup( const struct berval *src, struct berval *dst )
 243 {
 244     if ((dst->bv_val = RtlAllocateHeap( GetProcessHeap(), 0 , src->bv_len )))
 245     {
 246         memcpy( dst->bv_val, src->bv_val, src->bv_len );
 247         dst->bv_len = src->bv_len;
 248     }
 249     else
 250         dst->bv_len = 0;
 251 }
 252
 253 /***********************************************************************
 254  *      ldap_encode_sort_controlA     (WLDAP32.@)
 255  *
 256  * See ldap_encode_sort_controlW.
 257  */
 258 ULONG CDECL ldap_encode_sort_controlA( LDAP *ld, LDAPSortKeyA **sortkeys, LDAPControlA *ret, BOOLEAN critical )
 259 {
 260     LDAPControlA *control;
 261     ULONG result;
 262
 263     if ((result = ldap_create_sort_controlA( ld, sortkeys, critical, &control )) == LDAP_SUCCESS)
 264     {
 265         ret->ldctl_oid = strdupU(control->ldctl_oid);
 266         bv_val_dup( &control->ldctl_value, &ret->ldctl_value );
 267         ret->ldctl_iscritical = control->ldctl_iscritical;
 268         ldap_control_freeA( control );
 269     }
 270     return result;
 271 }
 272
 273 /***********************************************************************
 274  *      ldap_encode_sort_controlW     (WLDAP32.@)
 275  *
 276  * Create a control for server sorted search results.
 277  *
 278  * PARAMS
 279  *  ld       [I] Pointer to an LDAP context.
 280  *  sortkey  [I] Array of LDAPSortKey structures, each specifying an
 281  *               attribute to use as a sort key, a matching rule and
 282  *               the sort order (ascending or descending).
 283  *  critical [I] Tells the server this control is critical to the
 284  *               search operation.
 285  *  control  [O] LDAPControl created.
 286  *
 287  * RETURNS
 288  *  Success: LDAP_SUCCESS
 289  *  Failure: An LDAP error code.
 290  *
 291  * NOTES
 292  *  This function is obsolete. Use its equivalent
 293  *  ldap_create_sort_control instead.
 294  */
 295 ULONG CDECL ldap_encode_sort_controlW( LDAP *ld, LDAPSortKeyW **sortkeys, LDAPControlW *ret, BOOLEAN critical )
 296 {
 297     LDAPControlW *control;
 298     ULONG result;
 299
 300     if ((result = ldap_create_sort_controlW( ld, sortkeys, critical, &control )) == LDAP_SUCCESS)
 301     {
 302         ret->ldctl_oid = strdupW(control->ldctl_oid);
 303         bv_val_dup( &control->ldctl_value, &ret->ldctl_value );
 304         ret->ldctl_iscritical = control->ldctl_iscritical;
 305         ldap_control_freeW( control );
 306     }
 307     return result;
 308 }
 309
 310 /***********************************************************************
 311  *      ldap_free_controlsA     (WLDAP32.@)
 312  *
 313  * See ldap_free_controlsW.
 314  */
 315 ULONG CDECL ldap_free_controlsA( LDAPControlA **controls )
 316 {
 317     return ldap_controls_freeA( controls );
 318 }
 319
 320 /***********************************************************************
 321  *      ldap_free_controlsW     (WLDAP32.@)
 322  *
 323  * Free an array of LDAPControl structures.
 324  *
 325  * PARAMS
 326  *  controls  [I] Array of LDAPControl structures to free.
 327  *
 328  * RETURNS
 329  *  LDAP_SUCCESS
 330  *
 331  * NOTES
 332  *  Obsolete, use ldap_controls_freeW.
 333  */
 334 ULONG CDECL ldap_free_controlsW( LDAPControlW **controls )
 335 {
 336     return ldap_controls_freeW( controls );
 337 }