Evaluate/projects/deltachat-core/c/dc_contact.h

#ifndef __DC_CONTACT_H__
#define __DC_CONTACT_H__
#ifdef __cplusplus
extern "C" {
#endif


#include "dc_contact.h"
#include "dc_apeerstate.h"


/** the structure behind dc_contact_t */
struct _dc_contact
{
	/** @privatesection */

	uint32_t        magic;
	dc_context_t*   context;

	/**
	 * The contact ID.
	 *
	 * Special message IDs:
	 * - DC_CONTACT_ID_SELF (1) - this is the owner of the account with the email-address set by dc_set_config() using "addr".
	 *
	 * Normal contact IDs are larger than these special ones (larger than DC_CONTACT_ID_LAST_SPECIAL).
	 */
	uint32_t        id;
	char*           name;     /**< Contact name.  It is recommended to use dc_contact_get_name(), dc_contact_get_display_name() or dc_contact_get_name_n_addr() to access this field. May be NULL or empty, initially set to #authname. */
	char*           authname; /**< Name authorized by the contact himself. Only this name may be spread to others, e.g. in To:-lists. May be NULL or empty. It is recommended to use dc_contact_get_name(),  dc_contact_get_display_name() or dc_contact_get_name_n_addr() to access this field. */
	char*           addr;     /**< E-Mail-Address of the contact. It is recommended to use dc_contact_get_addr() to access this field. May be NULL. */
	int             blocked;  /**< Blocked state. Use dc_contact_is_blocked() to access this field. */
	int             origin;   /**< The origin/source of the contact. One of the DC_ORIGIN_* constants. */
};

#define DC_ORIGIN_INCOMING_UNKNOWN_FROM      0x10 /* From: of incoming messages of unknown sender */
#define DC_ORIGIN_INCOMING_UNKNOWN_CC        0x20 /* Cc: of incoming messages of unknown sender */
#define DC_ORIGIN_INCOMING_UNKNOWN_TO        0x40 /* To: of incoming messages of unknown sender */
#define DC_ORIGIN_UNHANDLED_QR_SCAN          0x80 /* address scanned but not verified */
#define DC_ORIGIN_INCOMING_REPLY_TO         0x100 /* Reply-To: of incoming message of known sender */
#define DC_ORIGIN_INCOMING_CC               0x200 /* Cc: of incoming message of known sender */
#define DC_ORIGIN_INCOMING_TO               0x400 /* additional To:'s of incoming message of known sender */
#define DC_ORIGIN_CREATE_CHAT               0x800 /* a chat was manually created for this user, but no message yet sent */
#define DC_ORIGIN_OUTGOING_BCC             0x1000 /* message sent by us */
#define DC_ORIGIN_OUTGOING_CC              0x2000 /* message sent by us */
#define DC_ORIGIN_OUTGOING_TO              0x4000 /* message sent by us */
#define DC_ORIGIN_INTERNAL                0x40000 /* internal use */
#define DC_ORIGIN_ADRESS_BOOK             0x80000 /* address is in our address book */
#define DC_ORIGIN_SECUREJOIN_INVITED    0x1000000 /* set on Alice's side for contacts like Bob that have scanned the QR code offered by her. Only means the contact has once been established using the "securejoin" procedure in the past, getting the current key verification status requires calling dc_contact_is_verified() ! */
#define DC_ORIGIN_SECUREJOIN_JOINED     0x2000000 /* set on Bob's side for contacts scanned and verified from a QR code. Only means the contact has once been established using the "securejoin" procedure in the past, getting the current key verification status requires calling dc_contact_is_verified() ! */
#define DC_ORIGIN_MANUALLY_CREATED      0x4000000 /* contact added mannually by dc_create_contact(), this should be the largets origin as otherwise the user cannot modify the names */

#define DC_ORIGIN_MIN_CONTACT_LIST    (DC_ORIGIN_INCOMING_REPLY_TO) /* contacts with at least this origin value are shown in the contact list */
#define DC_ORIGIN_MIN_VERIFIED        (DC_ORIGIN_INCOMING_REPLY_TO) /* contacts with at least this origin value are verified and known not to be spam */
#define DC_ORIGIN_MIN_START_NEW_NCHAT (0x7FFFFFFF)                  /* contacts with at least this origin value start a new "normal" chat, defaults to off */

int          dc_contact_load_from_db             (dc_contact_t*, dc_sqlite3_t*, uint32_t contact_id);
int          dc_contact_is_verified_ex           (dc_contact_t*, const dc_apeerstate_t*);


// Working with names
void         dc_normalize_name                   (char* full_name);
char*        dc_get_first_name                   (const char* full_name);


// Working with e-mail-addresses
int          dc_addr_cmp                         (const char* addr1, const char* addr2);
char*        dc_addr_normalize                   (const char* addr);
int          dc_addr_equals_self                 (dc_context_t*, const char* addr);
int          dc_addr_equals_contact              (dc_context_t*, const char* addr, uint32_t contact_id);


// Context functions to work with contacts
size_t       dc_get_real_contact_cnt             (dc_context_t*);
uint32_t     dc_add_or_lookup_contact            (dc_context_t*, const char* display_name /*can be NULL*/, const char* addr_spec, int origin, int* sth_modified);
int          dc_get_contact_origin               (dc_context_t*, uint32_t contact_id, int* ret_blocked);
int          dc_is_contact_blocked               (dc_context_t*, uint32_t contact_id);
int          dc_real_contact_exists              (dc_context_t*, uint32_t contact_id);
void         dc_scaleup_contact_origin           (dc_context_t*, uint32_t contact_id, int origin);


#ifdef __cplusplus
} /* /extern "C" */
#endif
#endif /* __DC_CONTACT_H__ */