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_ctx	pointer to the MAPI handles context
container_handle	the container handle if available
rec	pointer 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::tdb_ctx, MAPI_HANDLES_RESERVED, mapi_handles_traverse_null(), mapi_handles_tdb_update(), mapi_handles_tdb_free(), mapi_handles::parent_handle, mapi_handles::private_data, mapi_handles_context::last_handle, and MAPI_HANDLES_ROOT.

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

_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_ctx	pointer to the MAPI handles context
handle	the handle to delete

Returns:

MAPI_E_SUCCESS on success, otherwise MAPI error

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

Referenced by mapi_handles_traverse_delete(), and EcDoRpc_RopRelease().

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

Get the private data associated to a MAPI handle

Parameters:

handle	pointer to the MAPI handle structure
private_data	pointer on pointer to the private data the function returns

Returns:

MAPI_E_SUCCESS on success, otherwise MAPI_E_NOT_FOUND

References mapi_handles::private_data.

Referenced by emsmdbp_is_mapistore(), emsmdbp_is_mailboxstore(), emsmdbp_get_contextID(), emsmdbp_object_get_folder_handle_by_fid(), emsmdbp_object_table_init(), emsmdbp_object_message_init(), emsmdbp_object_stream_init(), RopOpenFolder_GenericFolder(), EcDoRpc_RopGetHierarchyTable(), EcDoRpc_RopGetContentsTable(), EcDoRpc_RopCreateGenericFolder(), EcDoRpc_RopCreateFolder(), EcDoRpc_RopDeleteFolder(), EcDoRpc_RopDeleteMessages(), RopEmptyFolder_GenericFolder(), EcDoRpc_RopOpenMessage(), EcDoRpc_RopCreateMessage(), EcDoRpc_RopSaveChangesMessage(), EcDoRpc_RopReloadCachedInformation(), EcDoRpc_RopGetPropertiesSpecific(), EcDoRpc_RopSetProperties(), EcDoRpc_RopReadStream(), EcDoRpc_RopWriteStream(), RopSetReceiveFolder(), RopGetReceiveFolder(), EcDoRpc_RopSetColumns(), EcDoRpc_RopQueryRows(), EcDoRpc_RopQueryPosition(), EcDoRpc_RopFindRow(), EcDoRpc_RopSubmitMessage(), EcDoRpc_RopGetRulesTable(), and EcDoRpc_RopModifyRules().

_PUBLIC_ struct mapi_handles_context* mapi_handles_init

(

TALLOC_CTX *

mem_ctx

)

[read]

Initialize MAPI handles context

Parameters:

mem_ctx

pointer to the memory context

Returns:

Allocated MAPI handles context on success, otherwise NULL

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

Referenced by emsmdbp_init().

_PUBLIC_ enum MAPISTATUS mapi_handles_release

(

struct mapi_handles_context *

handles_ctx

)

Release MAPI handles context

Parameters:

handles_ctx

pointer 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_search	(	struct mapi_handles_context *	handles_ctx,
		uint32_t	handle,
		struct mapi_handles **	rec
	)

Search for a record in the TDB database

Parameters:

handles_ctx	pointer to the MAPI handles context
handle	MAPI handle to lookup
rec	pointer to the MAPI handle structure the function returns

Returns:

MAPI_E_SUCCESS on success, otherwise MAPI error

References mapi_handles_context::tdb_ctx, MAPI_HANDLES_RESERVED, MAPI_HANDLES_NULL, mapi_handles_context::handles, mapi_handles::next, and mapi_handles::handle.

Referenced by EcDoRpc_RopOpenFolder(), EcDoRpc_RopGetHierarchyTable(), EcDoRpc_RopGetContentsTable(), EcDoRpc_RopCreateFolder(), EcDoRpc_RopDeleteFolder(), EcDoRpc_RopDeleteMessages(), EcDoRpc_RopEmptyFolder(), EcDoRpc_RopOpenMessage(), EcDoRpc_RopCreateMessage(), EcDoRpc_RopSaveChangesMessage(), EcDoRpc_RopReloadCachedInformation(), EcDoRpc_RopGetPropertiesSpecific(), EcDoRpc_RopSetProperties(), EcDoRpc_RopOpenStream(), EcDoRpc_RopReadStream(), EcDoRpc_RopWriteStream(), RopSetReceiveFolder(), RopGetReceiveFolder(), EcDoRpc_RopSetColumns(), EcDoRpc_RopQueryRows(), EcDoRpc_RopQueryPosition(), EcDoRpc_RopFindRow(), EcDoRpc_RopSubmitMessage(), EcDoRpc_RopGetRulesTable(), and EcDoRpc_RopModifyRules().

_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:

handle	pointer to the MAPI handle structure
private_data	pointer 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_RopOpenFolder(), EcDoRpc_RopGetHierarchyTable(), EcDoRpc_RopGetContentsTable(), EcDoRpc_RopCreateFolder(), EcDoRpc_RopOpenMessage(), EcDoRpc_RopCreateMessage(), EcDoRpc_RopOpenStream(), and EcDoRpc_RopLogon().

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_ctx	pointer to the MAPI handles context
handle	handle key value to free

Returns:

MAPI_E_SUCCESS on success, otherwise MAPI error

References mapi_handles_context::tdb_ctx, MAPI_HANDLES_RESERVED, and MAPI_HANDLES_NULL.

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_ctx	pointer to the TDB context
key	the current TDB key
dbuf	the current TDB value
state	pointer 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_ctx	pointer to the TDB context
key	the current TDB key
dbuf	the current TDB value
state	pointer 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().