mrmsg.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 __MRMSG_H__
#define __MRMSG_H__
#ifdef __cplusplus
extern "C" {
#endif


typedef struct mrmailbox_t mrmailbox_t;
typedef struct mrparam_t   mrparam_t;
typedef struct sqlite3_stmt sqlite3_stmt;


typedef struct mrmsg_t
{
    uint32_t        m_id;
    #define         MR_MSG_ID_MARKER1       1
    #define         MR_MSG_ID_DAYMARKER     9
    #define         MR_MSG_ID_LAST_SPECIAL  9


    uint32_t        m_from_id;


    uint32_t        m_to_id;


    uint32_t        m_chat_id;


    time_t          m_timestamp;


    int             m_type;
    #define         MR_MSG_UNDEFINED        0
    #define         MR_MSG_TEXT            10
    #define         MR_MSG_IMAGE           20 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT */
    #define         MR_MSG_GIF             21 /*   - " -  */
    #define         MR_MSG_AUDIO           40 /* m_param may contain MRP_FILE, MRP_DURATION */
    #define         MR_MSG_VOICE           41 /*   - " -  */
    #define         MR_MSG_VIDEO           50 /* m_param may contain MRP_FILE, MRP_WIDTH, MRP_HEIGHT, MRP_DURATION */
    #define         MR_MSG_FILE            60 /* m_param may contain MRP_FILE  */


    int             m_state;
    #define         MR_STATE_UNDEFINED      0
    #define         MR_STATE_IN_FRESH      10
    #define         MR_STATE_IN_NOTICED    13
    #define         MR_STATE_IN_SEEN       16
    #define         MR_STATE_OUT_PENDING   20
    #define         MR_STATE_OUT_ERROR     24
    #define         MR_STATE_OUT_DELIVERED 26
    #define         MR_STATE_OUT_MDN_RCVD  28

    char*           m_text;

    mrparam_t*      m_param;                  
    int             m_starred;                
    int             m_is_msgrmsg;             
    mrmailbox_t*    m_mailbox;                
    char*           m_rfc724_mid;             
    char*           m_server_folder;          
    uint32_t        m_server_uid;             
} mrmsg_t;


mrmsg_t*        mrmsg_new                   ();
void            mrmsg_unref                 (mrmsg_t*);
void            mrmsg_empty                 (mrmsg_t*);

void            mrmsg_set_type              (mrmsg_t*, int type);
void            mrmsg_set_text              (mrmsg_t*, const char* text);
void            mrmsg_set_file              (mrmsg_t*, const char* file);

int             mrmsg_get_type              (mrmsg_t*);
int             mrmsg_get_state             (mrmsg_t*);
char*           mrmsg_get_text              (mrmsg_t*);
char*           mrmsg_get_file              (mrmsg_t*);
char*           mrmsg_get_filename          (mrmsg_t*);
mrpoortext_t*   mrmsg_get_mediainfo         (mrmsg_t*);
int             mrmsg_get_showpadlock       (mrmsg_t*);
mrpoortext_t*   mrmsg_get_summary           (mrmsg_t*, mrchat_t*);
char*           mrmsg_get_summarytext       (mrmsg_t*, int approx_characters);

int             mrmsg_is_increation         (mrmsg_t*);
void            mrmsg_save_param_to_disk    (mrmsg_t*);


/* library-private */
#define         MR_MSG_FIELDS                        " m.id,rfc724_mid,m.server_folder,m.server_uid,m.chat_id, m.from_id,m.to_id,m.timestamp, m.type,m.state,m.msgrmsg,m.txt, m.param,m.starred "
int             mrmsg_set_from_stmt__                (mrmsg_t*, sqlite3_stmt* row, int row_offset); /* row order is MR_MSG_FIELDS */
int             mrmsg_load_from_db__                 (mrmsg_t*, mrmailbox_t*, uint32_t id);
int             mrmsg_is_increation__                (const mrmsg_t*);
char*           mrmsg_get_summarytext_by_raw         (int type, const char* text, mrparam_t*, int approx_bytes); /* the returned value must be free()'d */
void            mrmsg_save_param_to_disk__           (mrmsg_t*);
void            mrmsg_guess_msgtype_from_suffix      (const char* pathNfilename, int* ret_msgtype, char** ret_mime);
void            mrmsg_get_authorNtitle_from_filename (const char* pathNfilename, char** ret_author, char** ret_title);

#define MR_MSG_NEEDS_ATTACHMENT(a)         ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_AUDIO || (a)==MR_MSG_VOICE || (a)==MR_MSG_VIDEO || (a)==MR_MSG_FILE)
#define MR_MSG_MAKE_FILENAME_SEARCHABLE(a) ((a)==MR_MSG_AUDIO || (a)==MR_MSG_FILE || (a)==MR_MSG_VIDEO ) /* add filename.ext (without path) to m_text? this is needed for the fulltext search. The extension is useful to get all PDF, all MP3 etc. */
#define MR_MSG_MAKE_SUFFIX_SEARCHABLE(a)   ((a)==MR_MSG_IMAGE || (a)==MR_MSG_GIF || (a)==MR_MSG_VOICE)

#define APPROX_SUBJECT_CHARS 32  /* as we do not cut inside words, this results in about 32-42 characters.
                                 Do not use too long subjects - we add a tag after the subject which gets truncated by the clients otherwise.
                                 It should also be very clear, the subject is _not_ the whole message.
                                 The value is also used for CC:-summaries */


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