mrmailbox.h

/*******************************************************************************
 *
 *                              Delta Chat Core
 *                      Copyright (C) 2017 Björn Petersen
 *                   Contact: r10s@b44t.com, http://b44t.com
 *
 * This program 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 3 of the License, or (at your option) any later
 * version.
 *
 * This program 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
 * this program.  If not, see http://www.gnu.org/licenses/ .
 *
 ******************************************************************************/


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


#define MR_VERSION_MAJOR    0
#define MR_VERSION_MINOR    11
#define MR_VERSION_REVISION 1


#include <pthread.h>
#include <libetpan/libetpan.h> /* defines uint16_t */
#include "mrarray.h"
#include "mrchatlist.h"
#include "mrchat.h"
#include "mrmsg.h"
#include "mrcontact.h"
#include "mrlot.h"
#include "mrparam.h"
#include "mrevent.h"

typedef struct mrmailbox_t    mrmailbox_t;
typedef struct mrimap_t       mrimap_t;
typedef struct mrsmtp_t       mrsmtp_t;
typedef struct mrsqlite3_t    mrsqlite3_t;
typedef struct mrjob_t        mrjob_t;
typedef struct mrmimeparser_t mrmimeparser_t;


typedef uintptr_t (*mrmailboxcb_t) (mrmailbox_t*, int event, uintptr_t data1, uintptr_t data2);


typedef struct mrmailbox_t
{
    #define          MR_MAILBOX_MAGIC         0x11a11807
    uint32_t         m_magic;                 
    void*            m_userdata;              
    char*            m_dbfile;                
    char*            m_blobdir;               
    mrsqlite3_t*     m_sql;                   
    mrimap_t*        m_imap;                  
    mrsmtp_t*        m_smtp;                  
    pthread_t        m_job_thread;            
    pthread_cond_t   m_job_cond;              
    pthread_mutex_t  m_job_condmutex;         
    int              m_job_condflag;          
    int              m_job_do_exit;           
    mrmailboxcb_t    m_cb;                    
    char*            m_os_name;               
    uint32_t         m_cmdline_sel_chat_id;   
    int              m_wake_lock;             
    pthread_mutex_t  m_wake_lock_critical;    
    int              m_e2ee_enabled;          
    #define          MR_LOG_RINGBUF_SIZE 200
    pthread_mutex_t  m_log_ringbuf_critical;  
    char*            m_log_ringbuf[MR_LOG_RINGBUF_SIZE];
    time_t           m_log_ringbuf_times[MR_LOG_RINGBUF_SIZE];
    int              m_log_ringbuf_pos;       
} mrmailbox_t;


/* create/open/connect */
mrmailbox_t*    mrmailbox_new               (mrmailboxcb_t, void* userdata, const char* os_name);
void            mrmailbox_unref             (mrmailbox_t*);

int             mrmailbox_open              (mrmailbox_t*, const char* dbfile, const char* blobdir);
void            mrmailbox_close             (mrmailbox_t*);
int             mrmailbox_is_open           (const mrmailbox_t*);

int             mrmailbox_set_config        (mrmailbox_t*, const char* key, const char* value);
char*           mrmailbox_get_config        (mrmailbox_t*, const char* key, const char* def);
int             mrmailbox_set_config_int    (mrmailbox_t*, const char* key, int32_t value);
int32_t         mrmailbox_get_config_int    (mrmailbox_t*, const char* key, int32_t def);
char*           mrmailbox_get_version_str   (void);

int             mrmailbox_configure_and_connect(mrmailbox_t*);
void            mrmailbox_stop_ongoing_process(mrmailbox_t*);
int             mrmailbox_is_configured     (mrmailbox_t*);

void            mrmailbox_connect           (mrmailbox_t*);
void            mrmailbox_disconnect        (mrmailbox_t*);

char*           mrmailbox_get_info          (mrmailbox_t*);


/* Handle chatlists */
#define         MR_GCL_ARCHIVED_ONLY        0x01
#define         MR_GCL_NO_SPECIALS          0x02
mrchatlist_t*   mrmailbox_get_chatlist      (mrmailbox_t*, int flags, const char* query);


/* Handle chats */
uint32_t        mrmailbox_create_chat_by_contact_id (mrmailbox_t*, uint32_t contact_id);
uint32_t        mrmailbox_get_chat_id_by_contact_id (mrmailbox_t*, uint32_t contact_id);

uint32_t        mrmailbox_send_text_msg     (mrmailbox_t*, uint32_t chat_id, const char* text_to_send);
uint32_t        mrmailbox_send_image_msg    (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int width, int height);
uint32_t        mrmailbox_send_video_msg    (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int width, int height, int duration);
uint32_t        mrmailbox_send_voice_msg    (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int duration);
uint32_t        mrmailbox_send_audio_msg    (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime, int duration, const char* author, const char* trackname);
uint32_t        mrmailbox_send_file_msg     (mrmailbox_t*, uint32_t chat_id, const char* file, const char* filemime);
uint32_t        mrmailbox_send_vcard_msg    (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
void            mrmailbox_set_draft         (mrmailbox_t*, uint32_t chat_id, const char*);

#define         MR_GCM_ADDDAYMARKER         0x01
mrarray_t*      mrmailbox_get_chat_msgs     (mrmailbox_t*, uint32_t chat_id, uint32_t flags, uint32_t marker1before);
int             mrmailbox_get_total_msg_count (mrmailbox_t*, uint32_t chat_id);
int             mrmailbox_get_fresh_msg_count (mrmailbox_t*, uint32_t chat_id);
mrarray_t*      mrmailbox_get_fresh_msgs    (mrmailbox_t*);
void            mrmailbox_marknoticed_chat  (mrmailbox_t*, uint32_t chat_id);
mrarray_t*      mrmailbox_get_chat_media    (mrmailbox_t*, uint32_t chat_id, int msg_type, int or_msg_type);
uint32_t        mrmailbox_get_next_media    (mrmailbox_t*, uint32_t curr_msg_id, int dir);

void            mrmailbox_archive_chat      (mrmailbox_t*, uint32_t chat_id, int archive);
void            mrmailbox_delete_chat       (mrmailbox_t*, uint32_t chat_id);

mrarray_t*      mrmailbox_get_chat_contacts (mrmailbox_t*, uint32_t chat_id);
mrarray_t*      mrmailbox_search_msgs       (mrmailbox_t*, uint32_t chat_id, const char* query);

mrchat_t*       mrmailbox_get_chat          (mrmailbox_t*, uint32_t chat_id);


/* Handle group chats */
uint32_t        mrmailbox_create_group_chat        (mrmailbox_t*, const char* name);
int             mrmailbox_is_contact_in_chat       (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
int             mrmailbox_add_contact_to_chat      (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
int             mrmailbox_remove_contact_from_chat (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
int             mrmailbox_set_chat_name            (mrmailbox_t*, uint32_t chat_id, const char* name);
int             mrmailbox_set_chat_profile_image   (mrmailbox_t*, uint32_t chat_id, const char* image);


/* Handle messages */
char*           mrmailbox_get_msg_info      (mrmailbox_t*, uint32_t msg_id);
void            mrmailbox_delete_msgs       (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
void            mrmailbox_forward_msgs      (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, uint32_t chat_id);
void            mrmailbox_marknoticed_contact (mrmailbox_t*, uint32_t contact_id);
void            mrmailbox_markseen_msgs     (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt);
void            mrmailbox_star_msgs         (mrmailbox_t*, const uint32_t* msg_ids, int msg_cnt, int star);
mrmsg_t*        mrmailbox_get_msg           (mrmailbox_t*, uint32_t msg_id);


/* Handle contacts */
uint32_t        mrmailbox_create_contact    (mrmailbox_t*, const char* name, const char* addr);
int             mrmailbox_add_address_book  (mrmailbox_t*, const char*);
mrarray_t*      mrmailbox_get_known_contacts (mrmailbox_t*, const char* query);
int             mrmailbox_get_blocked_count (mrmailbox_t*);
mrarray_t*      mrmailbox_get_blocked_contacts (mrmailbox_t*);
void            mrmailbox_block_contact     (mrmailbox_t*, uint32_t contact_id, int block);
char*           mrmailbox_get_contact_encrinfo (mrmailbox_t*, uint32_t contact_id);
int             mrmailbox_delete_contact    (mrmailbox_t*, uint32_t contact_id);
mrcontact_t*    mrmailbox_get_contact       (mrmailbox_t*, uint32_t contact_id);


/* Import/export and Tools */
#define         MR_IMEX_EXPORT_SELF_KEYS      1 /* param1 is a directory where the keys are written to */
#define         MR_IMEX_IMPORT_SELF_KEYS      2 /* param1 is a directory where the keys are searched in and read from */
#define         MR_IMEX_EXPORT_BACKUP        11 /* param1 is a directory where the backup is written to */
#define         MR_IMEX_IMPORT_BACKUP        12 /* param1 is the file with the backup to import */
#define         MR_BAK_PREFIX                "delta-chat"
#define         MR_BAK_SUFFIX                "bak"
int             mrmailbox_imex              (mrmailbox_t*, int what, const char* param1, const char* param2);
char*           mrmailbox_imex_has_backup   (mrmailbox_t*, const char* dir);
int             mrmailbox_check_password    (mrmailbox_t*, const char* pw);
char*           mrmailbox_initiate_key_transfer(mrmailbox_t*);
int             mrmailbox_continue_key_transfer(mrmailbox_t*, uint32_t msg_id, const char* setup_code);
void            mrmailbox_heartbeat         (mrmailbox_t*);


/* logging */
void            mrmailbox_log_error         (mrmailbox_t*, int code, const char* msg, ...);
void            mrmailbox_log_error_if      (int* condition, mrmailbox_t*, int code, const char* msg, ...);
void            mrmailbox_log_warning       (mrmailbox_t*, int code, const char* msg, ...);
void            mrmailbox_log_info          (mrmailbox_t*, int code, const char* msg, ...);
void            mrmailbox_log_vprintf       (mrmailbox_t*, int event, int code, const char* msg, va_list);
int             mrmailbox_get_thread_index  (void);


/* error codes */
#define         MR_ERR_SELF_NOT_IN_GROUP    1
#define         MR_ERR_NONETWORK            2


/* deprecated functions */
int             mrchat_set_draft            (mrchat_t*, const char* msg);   /* deprecated - use mrmailbox_set_draft() instead */
#define         mrpoortext_t                mrlot_t
#define         mrpoortext_unref            mrlot_unref
#define         mrmailbox_imex_cancel       mrmailbox_stop_ongoing_process
#define         mrmailbox_configure_cancel  mrmailbox_stop_ongoing_process


/* library-internal */
uint32_t        mrmailbox_send_msg_object                         (mrmailbox_t*, uint32_t chat_id, mrmsg_t*);
void            mrmailbox_connect_to_imap                         (mrmailbox_t*, mrjob_t*);
void            mrmailbox_wake_lock                               (mrmailbox_t*);
void            mrmailbox_wake_unlock                             (mrmailbox_t*);
int             mrmailbox_poke_eml_file                           (mrmailbox_t*, const char* file);
int             mrmailbox_is_reply_to_known_message__             (mrmailbox_t*, mrmimeparser_t*);
int             mrmailbox_is_reply_to_messenger_message__         (mrmailbox_t*, mrmimeparser_t*);
time_t          mrmailbox_correct_bad_timestamp__                 (mrmailbox_t* ths, uint32_t chat_id, uint32_t from_id, time_t desired_timestamp, int is_fresh_msg);
void            mrmailbox_add_or_lookup_contacts_by_mailbox_list__(mrmailbox_t* ths, struct mailimf_mailbox_list* mb_list, int origin, mrarray_t* ids, int* check_self);
void            mrmailbox_add_or_lookup_contacts_by_address_list__(mrmailbox_t* ths, struct mailimf_address_list* adr_list, int origin, mrarray_t* ids, int* check_self);
int             mrmailbox_get_archived_count__                    (mrmailbox_t*);
int             mrmailbox_reset_tables                            (mrmailbox_t*, int bits); /* reset tables but leaves server configuration, 1=jobs, 2=e2ee, 8=rest but server config */
size_t          mrmailbox_get_real_contact_cnt__                  (mrmailbox_t*);
uint32_t        mrmailbox_add_or_lookup_contact__                 (mrmailbox_t*, const char* display_name /*can be NULL*/, const char* addr_spec, int origin, int* sth_modified);
int             mrmailbox_get_contact_origin__                    (mrmailbox_t*, uint32_t id, int* ret_blocked);
int             mrmailbox_is_contact_blocked__                    (mrmailbox_t*, uint32_t id);
int             mrmailbox_real_contact_exists__                   (mrmailbox_t*, uint32_t id);
int             mrmailbox_contact_addr_equals__                   (mrmailbox_t*, uint32_t contact_id, const char* other_addr);
void            mrmailbox_scaleup_contact_origin__                (mrmailbox_t*, uint32_t contact_id, int origin);
void            mrmailbox_unarchive_chat__                        (mrmailbox_t*, uint32_t chat_id);
size_t          mrmailbox_get_chat_cnt__                          (mrmailbox_t*);
uint32_t        mrmailbox_create_or_lookup_nchat_by_contact_id__  (mrmailbox_t*, uint32_t contact_id);
uint32_t        mrmailbox_lookup_real_nchat_by_contact_id__       (mrmailbox_t*, uint32_t contact_id);
int             mrmailbox_get_total_msg_count__                   (mrmailbox_t*, uint32_t chat_id);
int             mrmailbox_get_fresh_msg_count__                   (mrmailbox_t*, uint32_t chat_id);
uint32_t        mrmailbox_get_last_deaddrop_fresh_msg__           (mrmailbox_t*);
void            mrmailbox_send_msg_to_smtp                        (mrmailbox_t*, mrjob_t*);
void            mrmailbox_send_msg_to_imap                        (mrmailbox_t*, mrjob_t*);
int             mrmailbox_add_contact_to_chat__                   (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
int             mrmailbox_is_contact_in_chat__                    (mrmailbox_t*, uint32_t chat_id, uint32_t contact_id);
int             mrmailbox_get_chat_contact_count__                (mrmailbox_t*, uint32_t chat_id);
int             mrmailbox_group_explicitly_left__                 (mrmailbox_t*, const char* grpid);
void            mrmailbox_set_group_explicitly_left__             (mrmailbox_t*, const char* grpid);
size_t          mrmailbox_get_real_msg_cnt__                      (mrmailbox_t*); /* the number of messages assigned to real chat (!=deaddrop, !=trash) */
size_t          mrmailbox_get_deaddrop_msg_cnt__                  (mrmailbox_t*);
int             mrmailbox_rfc724_mid_cnt__                        (mrmailbox_t*, const char* rfc724_mid);
int             mrmailbox_rfc724_mid_exists__                     (mrmailbox_t*, const char* rfc724_mid, char** ret_server_folder, uint32_t* ret_server_uid);
void            mrmailbox_update_server_uid__                     (mrmailbox_t*, const char* rfc724_mid, const char* server_folder, uint32_t server_uid);
void            mrmailbox_update_msg_chat_id__                    (mrmailbox_t*, uint32_t msg_id, uint32_t chat_id);
void            mrmailbox_update_msg_state__                      (mrmailbox_t*, uint32_t msg_id, int state);
void            mrmailbox_delete_msg_on_imap                      (mrmailbox_t* mailbox, mrjob_t* job);
int             mrmailbox_mdn_from_ext__                          (mrmailbox_t*, uint32_t from_id, const char* rfc724_mid, uint32_t* ret_chat_id, uint32_t* ret_msg_id); /* returns 1 if an event should be send */
void            mrmailbox_send_mdn                                (mrmailbox_t*, mrjob_t* job);
void            mrmailbox_markseen_msg_on_imap                    (mrmailbox_t* mailbox, mrjob_t* job);
void            mrmailbox_markseen_mdn_on_imap                    (mrmailbox_t* mailbox, mrjob_t* job);


/* library private: end-to-end-encryption */
#define MR_E2EE_DEFAULT_ENABLED  1
#define MR_MDNS_DEFAULT_ENABLED  1

typedef struct mrmailbox_e2ee_helper_t {
    int   m_encryption_successfull;
    void* m_cdata_to_free;
} mrmailbox_e2ee_helper_t;

void            mrmailbox_e2ee_encrypt      (mrmailbox_t*, const clist* recipients_addr, int e2ee_guaranteed, int encrypt_to_self, struct mailmime* in_out_message, mrmailbox_e2ee_helper_t*);
int             mrmailbox_e2ee_decrypt      (mrmailbox_t*, struct mailmime* in_out_message, int* ret_validation_errors); /* returns 1 if sth. was decrypted, 0 in other cases */
void            mrmailbox_e2ee_thanks       (mrmailbox_e2ee_helper_t*); /* frees data referenced by "mailmime" but not freed by mailmime_free(). After calling mre2ee_unhelp(), in_out_message cannot be used any longer! */
int             mrmailbox_ensure_secret_key_exists (mrmailbox_t*); /* makes sure, the private key exists, needed only for exporting keys and the case no message was sent before */
char*           mrmailbox_create_setup_code (mrmailbox_t*);
int             mrmailbox_render_setup_file (mrmailbox_t* mailbox, const char* passphrase, char** ret_msg);

extern int      mr_shall_stop_ongoing;
int             mrmailbox_alloc_ongoing     (mrmailbox_t*);
void            mrmailbox_free_ongoing      (mrmailbox_t*);


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