mapiproxy/libmapiproxy/mapi_handles.c File Reference

API for MAPI handles management. More...

#include "mapiproxy/dcesrv_mapiproxy.h"
#include "libmapi/libmapi.h"
#include "libmapi/libmapi_private.h"
#include "libmapiproxy.h"

Functions

_PUBLIC_ enum MAPISTATUS mapi_handles_add (struct mapi_handles_context *handles_ctx, uint32_t container_handle, struct mapi_handles **rec)
_PUBLIC_ enum MAPISTATUS mapi_handles_delete (struct mapi_handles_context *handles_ctx, uint32_t handle)
_PUBLIC_ enum MAPISTATUS mapi_handles_get_private_data (struct mapi_handles *handle, void **private_data)
_PUBLIC_ struct
mapi_handles_context
mapi_handles_init (TALLOC_CTX *mem_ctx)
_PUBLIC_ enum MAPISTATUS mapi_handles_release (struct mapi_handles_context *handles_ctx)
_PUBLIC_ enum MAPISTATUS mapi_handles_search (struct mapi_handles_context *handles_ctx, uint32_t handle, struct mapi_handles **rec)
_PUBLIC_ enum MAPISTATUS mapi_handles_set_private_data (struct mapi_handles *handle, void *private_data)
static enum MAPISTATUS mapi_handles_tdb_free (struct mapi_handles_context *handles_ctx, uint32_t handle)
static enum MAPISTATUS mapi_handles_tdb_update (struct mapi_handles_context *handles_ctx, uint32_t handle, uint32_t container_handle)
static int mapi_handles_traverse_delete (TDB_CONTEXT *tdb_ctx, TDB_DATA key, TDB_DATA dbuf, void *state)
static int mapi_handles_traverse_null (TDB_CONTEXT *tdb_ctx, TDB_DATA key, TDB_DATA dbuf, void *state)

Detailed Description

API for MAPI handles management.


Function Documentation

_PUBLIC_ enum MAPISTATUS mapi_handles_add ( struct mapi_handles_context handles_ctx,
uint32_t  container_handle,
struct mapi_handles **  rec 
)

Add a handles to the database and return a pointer on created record

Parameters:
handles_ctxpointer to the MAPI handles context
container_handlethe container handle if available
recpointer on pointer to the MAPI handle structure the function returns
Returns:
MAPI_E_SUCCESS on success, otherwise MAPI error

References mapi_handles::handle, mapi_handles_context::last_handle, MAPI_HANDLES_RESERVED, MAPI_HANDLES_ROOT, mapi_handles_tdb_free(), mapi_handles_tdb_update(), mapi_handles_traverse_null(), mapi_handles::parent_handle, mapi_handles::private_data, and mapi_handles_context::tdb_ctx.

Referenced by EcDoRpc_RopCreateFolder(), EcDoRpc_RopCreateMessage(), EcDoRpc_RopGetAttachmentTable(), EcDoRpc_RopGetContentsTable(), EcDoRpc_RopGetHierarchyTable(), EcDoRpc_RopGetPermissionsTable(), EcDoRpc_RopGetRulesTable(), EcDoRpc_RopLogon(), EcDoRpc_RopOpenFolder(), EcDoRpc_RopOpenMessage(), EcDoRpc_RopOpenStream(), and EcDoRpc_RopRegisterNotification().

_PUBLIC_ enum MAPISTATUS mapi_handles_delete ( struct mapi_handles_context handles_ctx,
uint32_t  handle 
)

Remove the MAPI handle referenced by the handle parameter from the double chained list and mark its associated TDB record as null

Parameters:
handles_ctxpointer to the MAPI handles context
handlethe handle to delete
Returns:
MAPI_E_SUCCESS on success, otherwise MAPI error

References mapi_handles::handle, mapi_handles_context::handles, MAPI_HANDLES_RESERVED, mapi_handles_tdb_free(), mapi_handles_traverse_delete(), mapi_handles::next, and mapi_handles_context::tdb_ctx.

Referenced by EcDoRpc_RopRelease(), and mapi_handles_traverse_delete().

_PUBLIC_ struct mapi_handles_context* mapi_handles_init ( TALLOC_CTX *  mem_ctx) [read]

Initialize MAPI handles context

Parameters:
mem_ctxpointer to the memory context
Returns:
Allocated MAPI handles context on success, otherwise NULL

References mapi_handles_context::handles, mapi_handles_context::last_handle, and mapi_handles_context::tdb_ctx.

Referenced by emsmdbp_init().

_PUBLIC_ enum MAPISTATUS mapi_handles_release ( struct mapi_handles_context handles_ctx)

Release MAPI handles context

Parameters:
handles_ctxpointer to the MAPI handles context
Returns:
MAPI_E_SUCCESS on success, otherwise MAPI error

References mapi_handles_context::tdb_ctx.

Referenced by emsmdbp_mapi_handles_destructor().

_PUBLIC_ enum MAPISTATUS mapi_handles_set_private_data ( struct mapi_handles handle,
void *  private_data 
)

Set the private data associated to a MAPI handle

Parameters:
handlepointer to the MAPI handle structure
private_datapointer to the private data to associate to the MAPI handle
Returns:
MAPI_E_SUCCESS on success, otherwise MAPI error

References mapi_handles::private_data.

Referenced by EcDoRpc_RopCreateFolder(), EcDoRpc_RopCreateMessage(), EcDoRpc_RopGetContentsTable(), EcDoRpc_RopGetHierarchyTable(), EcDoRpc_RopLogon(), EcDoRpc_RopOpenFolder(), EcDoRpc_RopOpenMessage(), and EcDoRpc_RopOpenStream().

static enum MAPISTATUS mapi_handles_tdb_free ( struct mapi_handles_context handles_ctx,
uint32_t  handle 
) [static]

Set a TDB record data as null meaning it can be reused in the future.

Parameters:
handles_ctxpointer to the MAPI handles context
handlehandle key value to free
Returns:
MAPI_E_SUCCESS on success, otherwise MAPI error

References MAPI_HANDLES_NULL, MAPI_HANDLES_RESERVED, and mapi_handles_context::tdb_ctx.

Referenced by mapi_handles_add(), and mapi_handles_delete().

static enum MAPISTATUS mapi_handles_tdb_update ( struct mapi_handles_context handles_ctx,
uint32_t  handle,
uint32_t  container_handle 
) [static]

Update a TDB record

References mapi_handles_context::tdb_ctx.

Referenced by mapi_handles_add().

static int mapi_handles_traverse_delete ( TDB_CONTEXT *  tdb_ctx,
TDB_DATA  key,
TDB_DATA  dbuf,
void *  state 
) [static]

Traverse TDB database and search for records which dbuf value is set to state.

Parameters:
tdb_ctxpointer to the TDB context
keythe current TDB key
dbufthe current TDB value
statepointer on private data
Returns:
1 when a free record is found, otherwise 0

References mapi_handles_delete().

Referenced by mapi_handles_delete().

static int mapi_handles_traverse_null ( TDB_CONTEXT *  tdb_ctx,
TDB_DATA  key,
TDB_DATA  dbuf,
void *  state 
) [static]

Traverse TDB database and search for the first record which dbuf value is "null" string.

Parameters:
tdb_ctxpointer to the TDB context
keythe current TDB key
dbufthe current TDB value
statepointer on private data
Returns:
1 when a free record is found, otherwise 0

References mapi_handles::handle, and MAPI_HANDLES_NULL.

Referenced by mapi_handles_add().


Creative Commons License
Creative Commons Attribution icon Creative Commons Share Alike icon
This content is licensed under the Creative Commons
Attribution ShareAlike License v. 3.0:
http://creativecommons.org/licenses/by-sa/3.0/