email-common-use/include/email-internal-types.h

   1 /*
   2 *  email-service
   3 *
   4 * Copyright (c) 2012 - 2013 Samsung Electronics Co., Ltd. All rights reserved.
   5 *
   6 * Contact: Kyuho Jo <kyuho.jo@samsung.com>, Sunghyun Kwon <sh0701.kwon@samsung.com>
   7 *
   8 * Licensed under the Apache License, Version 2.0 (the "License");
   9 * you may not use this file except in compliance with the License.
  10 * You may obtain a copy of the License at
  11 *
  12 * http://www.apache.org/licenses/LICENSE-2.0
  13 *
  14 * Unless required by applicable law or agreed to in writing, software
  15 * distributed under the License is distributed on an "AS IS" BASIS,
  16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17 * See the License for the specific language governing permissions and
  18 * limitations under the License.
  19 *
  20 */
  21
  22
  23 /******************************************************************************
  24  * File :  email-internal-types.h
  25  * Desc :  defines data structures and macros
  26  *
  27  * Auth :
  28  *
  29  * History :
  30  *    2011.04.05  :  created
  31  *****************************************************************************/
  32 #ifndef __EMAIL_INTERNAL_TYPES_H__
  33 #define __EMAIL_INTERNAL_TYPES_H__
  34
  35 #include "email-types.h"
  36
  37 #ifdef __cplusplus
  38 extern "C"
  39 {
  40 #endif /*  __cplusplus */
  41
  42 #ifndef INTERNAL_FUNC
  43 #define INTERNAL_FUNC __attribute__((visibility("default")))
  44 #endif
  45
  46 /* ----------------------------------------------------------------------------- */
  47 /*  Feature definitions */
  48 #define __FEATURE_USING_ACCOUNT_SVC__
  49 #define __FEATURE_BACKUP_ACCOUNT__
  50 #define __FEATURE_MOVE_TO_OUTBOX_FIRST__
  51 /*  #define __FEATURE_PARTIAL_BODY_FOR_POP3__ */
  52 /*  #define __FEATURE_KEEP_CONNECTION__  */
  53 /*  #define __FEATURE_DRM__ */
  54 #define __FEATURE_PARTIAL_BODY_DOWNLOAD__
  55 #define __FEATURE_HEADER_OPTIMIZATION__
  56 #define __FEATURE_SEND_OPTMIZATION__
  57 #define __FEATURE_DOWNLOAD_BODY_ATTACHMENT_OPTIMIZATION__
  58 #define __FEATURE_BULK_DELETE_MOVE_UPDATE_REQUEST_OPTI__
  59 #define __FEATURE_SYNC_CLIENT_TO_SERVER__
  60 #define __FEATURE_AUTO_POLLING__
  61 #define __FEATURE_DEBUG_LOG__
  62 #define __FEATURE_USE_SHARED_MUTEX_FOR_GENERATING_MAIL_ID__
  63 #define __FEATURE_XLIST_SUPPORT__
  64 #define __FEATURE_SUPPORT_REPORT_MAIL__
  65 #define __FEATURE_SUPPORT_IMAP_ID__
  66 #define __FEATURE_SUPPORT_SYNC_STATE_ON_NOTI_BAR__
  67 #define __FEATURE_SUPPORT_VALIDATION_SYSTEM__
  68 #define __FEATURE_PROGRESS_IN_OUTBOX__
  69 /*  #define __FEATURE_USE_SHARED_MUTEX_FOR_PROTECTED_FUNC_CALL__ */
  70 /*  #define __FEATURE_IMAP_IDLE__ */
  71
  72
  73 /* ----------------------------------------------------------------------------- */
  74 /*  Macro */
  75 #ifndef NULL
  76 #define NULL (char *)0
  77 #endif
  78
  79 #define SESSION_MAX                             5
  80 #define IMAP_2004_LOG                       1
  81 #define TEXT_SIZE                           161
  82 #define MAILBOX_COUNT                       6
  83 #define PARTIAL_DOWNLOAD_SIZE               1024
  84 #define PARTIAL_BODY_SIZE_IN_BYTES          15360     /*  Partial Body download - 15K */
  85 #define NO_LIMITATION                       0
  86 #define MAX_MAILBOX_TYPE                    100
  87 #define EMAIL_SYNC_ALL_MAILBOX              1
  88 #define EMAIL_ATTACHMENT_MAX_COUNT          512
  89 #define DOWNLOAD_MAX_BUFFER_SIZE            8000
  90 #define LOCAL_MAX_BUFFER_SIZE               1000000
  91 #define IMAP_MAX_COMMAND_LENGTH             1000
  92 #define DOWNLOAD_NOTI_INTERVAL_PERCENT      5         /*  notify every 5% */
  93 #define DOWNLOAD_NOTI_INTERVAL_SIZE         51200     /*  notify every 50k */
  94 #define MAX_PATH                            4096      /* /usr/src/linux-2.4.20-8/include/linux/limits.h */
  95 #define DATETIME_LENGTH                     16
  96 #define MAIL_ID_STRING_LENGTH               10
  97 #define MAILBOX_ID_STRING_LENGTH            10
  98 #define EMAIL_LIMITATION_FREE_SPACE         (5) /*  This value is 5MB */
  99 #define EMAIL_MAIL_MAX_COUNT                5000
 100 #define HTML_EXTENSION_STRING               ".htm"
 101 #define MAX_PATH_HTML                       256
 102 #define MAX_ACTIVE_TASK                     10
 103
 104 #define DIR_SEPERATOR                       "/"
 105
 106 #define USERDATA_PATH                       "/opt/usr"
 107 #define DATA_PATH                           "/opt/usr/data"
 108 #define DB_PATH                             "/opt/usr/dbspace"
 109 #define EMAIL_SERVICE_DB_FILE_PATH          "/opt/usr/dbspace/.email-service.db"
 110
 111 #define EMAILPATH                                               DATA_PATH"/email"
 112 #define MAILHOME                                                DATA_PATH"/email/.email_data"
 113 #define MAILTEMP                            MAILHOME"/tmp"
 114 #define DIRECTORY_PERMISSION                0755
 115
 116 #define MIME_SUBTYPE_DRM_OBJECT             "vnd.oma.drm.message"
 117 #define MIME_SUBTYPE_DRM_RIGHTS             "vnd.oma.drm.rights+xml"
 118 #define MIME_SUBTYPE_DRM_DCF                "vnd.oma.drm.dcf"
 119
 120 #define SHM_FILE_FOR_DB_LOCK                "/.email_shm_db_lock"
 121
 122 #define NATIVE_EMAIL_APPLICATION_PKG        "com.samsung.email"
 123
 124 #define IMAP_ID_OS                          "TIZEN"
 125 #define IMAP_ID_OS_VERSION                  "2.0b"
 126 #define IMAP_ID_VENDOR                      "Samsung Mobile"
 127 #define IMAP_ID_DEVICE_NAME                 "GT-I8800_EUR_XX"
 128 #define IMAP_ID_AGUID                       "1"
 129 #define IMAP_ID_ACLID                       "Samsung"
 130
 131 #ifdef __FEATURE_USE_SHARED_MUTEX_FOR_GENERATING_MAIL_ID__
 132 #define SHM_FILE_FOR_MAIL_ID_LOCK           "/.email_shm_mail_id_lock"
 133 #endif /* __FEATURE_USE_SHARED_MUTEX_FOR_GENERATING_MAIL_ID__ */
 134
 135 #define CR                                  '\r'
 136 #define LF                                  '\n'
 137 #define SPACE                               ' '
 138 #define TAB                                 '\t'
 139 #define NULL_CHAR                           '\0'
 140 #define TAB_STRING                          "\t"
 141 #define CR_STRING                           "\r"
 142 #define LF_STRING                           "\n"
 143 #define CRLF_STRING                         "\r\n"
 144
 145 #define GRAB_TYPE_TEXT                      1        /*  retrieve text and attachment list */
 146 #define GRAB_TYPE_ATTACHMENT                2        /*  retrieve attachment */
 147
 148 #define SAVE_TYPE_SIZE                      1        /*  only get content size */
 149 #define SAVE_TYPE_BUFFER                    2        /*  save content to buffer */
 150 #define SAVE_TYPE_FILE                      3        /*  save content to temporary file */
 151
 152 #define FINISH_OFF_IF_CANCELED              if (!emcore_check_thread_status()) { err = EMAIL_ERROR_CANCELLED; goto FINISH_OFF; }
 153 #define CHECK_JOB_CANCELED()                {if (!emcore_check_thread_status()) goto JOB_CANCEL; }
 154
 155 #define SNPRINTF(buff, size, format, args...)  snprintf(buff, size, format, ##args)
 156 #define SNPRINTF_OFFSET(base_buf, offset, base_size, format, args...) \
 157                         ({\
 158                                 int _offset = offset;\
 159                                 snprintf(base_buf + _offset, base_size - _offset - 1, format, ##args);\
 160                         })
 161
 162 #define THREAD_CREATE(tv, func, param, err)       { EM_DEBUG_LOG("THREAD_CREATE "#tv); err = pthread_create(&tv, NULL, func, param); }
 163 #define THREAD_CREATE_JOINABLE(tv, func, err)     { pthread_attr_t attr; EM_DEBUG_LOG("THREAD_CREATE_JOINABLE "#tv); \
 164                                                    pthread_attr_init(&attr); pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_JOINABLE);\
 165                                                    err = pthread_create(&tv, &attr, func, NULL); pthread_attr_destroy(&attr); }
 166 #define THREAD_JOIN(tv)                           {EM_DEBUG_LOG("THREAD_JOIN "#tv); pthread_join(tv, NULL); }
 167 #define THREAD_SELF()                             pthread_self()
 168 #define THREAD_DETACH(tv)                         pthread_detach(tv)
 169 #define INITIALIZE_CRITICAL_SECTION(cs)           {EM_DEBUG_LOG("INITIALIZE_CRITICAL_SECTION "#cs); pthread_mutex_init(&cs, NULL); }
 170 #define ENTER_CRITICAL_SECTION(cs)                {EM_DEBUG_LOG("ENTER_CRITICAL_SECTION "#cs); pthread_mutex_lock(&cs); }
 171 #define TRY_ENTER_CRITICAL_SECTION(cs)            {EM_DEBUG_LOG("TRY_ENTER_CRITICAL_SECTION "#cs); pthread_mutex_trylock(&cs); }
 172 #define LEAVE_CRITICAL_SECTION(cs)                {EM_DEBUG_LOG("LEAVE_CRITICAL_SECTION "#cs); pthread_mutex_unlock(&cs); }
 173 #define DELETE_CRITICAL_SECTION(cs)               {EM_DEBUG_LOG("DELETE_CRITICAL_SECTION "#cs); pthread_mutex_destroy(&cs); }
 174
 175 #define INITIALIZE_CONDITION_VARIABLE(cv)         {EM_DEBUG_LOG("INITIALIZE_CONDITION_VARIABLE "#cv); pthread_cond_init(&cv, NULL); }
 176 #define SLEEP_CONDITION_VARIABLE(cv, cs)          {EM_DEBUG_LOG("SLEEP_CONDITION_VARIABLE "#cv); pthread_cond_wait(&cv, &cs); }
 177 #define WAKE_CONDITION_VARIABLE(cv)               {EM_DEBUG_LOG("WAKE_CONDITION_VARIABLE "#cv); pthread_cond_signal(&cv); }
 178 #define DELETE_CONDITION_VARIABLE(cv)             {EM_DEBUG_LOG("DELETE_CONDITION_VARIABLE "#cv); pthread_cond_destroy(&cv); }
 179
 180 #define INITIALIZE_RECURSIVE_CRITICAL_SECTION(cs) { EM_DEBUG_LOG("INITIALIZE_RECURSIVE_CRITICAL_SECTION "#cs);  \
 181                                                    if (cs == NULL) {pthread_mutex_lock(&_send_event_available_lock); pthread_mutexattr_t attr; cs = (pthread_mutex_t *)malloc(sizeof(pthread_mutex_t));\
 182                                                    pthread_mutexattr_init(&attr); pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_RECURSIVE_NP);\
 183                                                    pthread_mutex_init(cs, &attr);pthread_mutexattr_destroy(&attr); pthread_mutex_unlock(&_send_event_available_lock);}}
 184 #define ENTER_RECURSIVE_CRITICAL_SECTION(cs)      {EM_DEBUG_LOG("ENTER_RECURSIVE_CRITICAL_SECTION "#cs); if(cs) pthread_mutex_lock(cs);}
 185 #define TRY_ENTER_RECURSIVE_CRITICAL_SECTION(cs)  {EM_DEBUG_LOG("TRY_ENTER_RECURSIVE_CRITICAL_SECTION "#cs); if(cs)  pthread_mutex_trylock(cs);}
 186 #define LEAVE_RECURSIVE_CRITICAL_SECTION(cs)      {EM_DEBUG_LOG("LEAVE_RECURSIVE_CRITICAL_SECTION "#cs); if(cs) pthread_mutex_unlock(cs);}
 187 #define DELETE_RECURSIVE_CRITICAL_SECTION(cs)     {EM_DEBUG_LOG("DELETE_RECURSIVE_CRITICAL_SECTION "#cs); if(cs) pthread_mutex_destroy(cs);}
 188 typedef pthread_t thread_t;
 189
 190 #define SMTP_RESPONSE_OK                        250
 191 #define SMTP_RESPONSE_READY                     354
 192 #define SMTP_RESPONSE_CONNECTION_BROKEN 421
 193 #define SMTP_RESPONSE_WANT_AUTH             505
 194 #define SMTP_RESPONSE_WANT_AUTH2            530
 195 #define SMTP_RESPONSE_UNAVAIL               550
 196
 197 #define VCONF_KEY_LATEST_MAIL_ID        "db/private/email-service/latest_mail_id"
 198 #define VCONF_KEY_DEFAULT_ACCOUNT_ID    "db/private/email-service/default_account_id"
 199 #define VCONF_KEY_NOTI_PRIVATE_ID       "db/private/email-service/noti_private_id"
 200
 201 #define OUTMODE "wb"
 202 #define INMODE "rb"
 203 #define READMODE "r"
 204
 205 #define TYPEPKCS7_SIGN 10
 206 #define TYPEPKCS7_MIME 11
 207
 208 #define INLINE_ATTACHMENT    1
 209 #define ATTACHMENT           2
 210
 211 /* __FEATURE_LOCAL_ACTIVITY__ supported
 212 #define BULK_OPERATION_COUNT              50
 213 #define ALL_ACTIVITIES                    0
 214 */
 215
 216 /* ----------------------------------------------------------------------------- */
 217 /*  Type */
 218 typedef enum
 219 {
 220         _SERVICE_THREAD_TYPE_NONE      = 0,
 221         _SERVICE_THREAD_TYPE_RECEIVING = 1,
 222         _SERVICE_THREAD_TYPE_SENDING   = 2,
 223 #ifdef __FEATURE_PARTIAL_BODY_DOWNLOAD__
 224         _SERVICE_THREAD_TYPE_PBD       = 3,
 225 #endif /*  __FEATURE_PARTIAL_BODY_DOWNLOAD__ */
 226 } email_service_thread_type;
 227
 228
 229 typedef enum
 230 {
 231         EMAIL_PROTOCOL_NONE                        = 0,
 232         EMAIL_PROTOCOL_POP3                        = 1,
 233         EMAIL_PROTOCOL_IMAP                        = 2,
 234         EMAIL_PROTOCOL_SMTP                        = 3,
 235 } email_protocol_type_t;
 236
 237 typedef enum
 238 {
 239         ACCOUNT_SVC_SYNC_STATUS_RUNNING            = 0,
 240         ACCOUNT_SVC_SYNC_STATUS_IDLE               = 1,
 241         ACCOUNT_SVC_SYNC_STATUS_OFF                = 2,
 242 } email_account_svc_sync_status;
 243
 244 typedef enum {
 245         SET_TYPE_SET        = 1,
 246         SET_TYPE_UNION      = 2,
 247         SET_TYPE_MINUS      = 3,
 248         SET_TYPE_INTERSECT  = 4 /* Not supported */
 249 } email_set_type_t;
 250
 251 #ifdef __FEATURE_KEEP_CONNECTION__
 252 enum
 253 {
 254         EMAIL_STREAM_STATUS_DISCONNECTED = 0,
 255         EMAIL_STREAM_STATUS_CONNECTED = 1
 256 } ;
 257 #endif /* __FEATURE_KEEP_CONNECTION__ */
 258
 259 enum
 260 {
 261         EXTENSION_JPEG   = 0,
 262         EXTENSION_JPG    = 1,
 263         EXTENSION_PNG    = 2,
 264         EXTENSION_GIF    = 3,
 265         EXTENSION_BMP    = 4,
 266         EXTENSION_PIC    = 5,
 267         EXTENSION_AGIF   = 6,
 268         EXTENSION_TIF    = 7,
 269         EXTENSION_WBMP   = 8,
 270         EXTENSION_P7S    = 9,
 271         EXTENSION_P7M    = 10
 272 };
 273
 274 /*  event information */
 275 typedef struct
 276 {
 277         int                      account_id;         /*  in general, account id */
 278         email_event_type_t         type;
 279         email_event_status_type_t  status;
 280         char                    *event_param_data_1; /*  in general, mailbox name (exception in emcore_send_mail, emcore_send_saved_mail it is email_option_t **/
 281         char                    *event_param_data_2;
 282         char                    *event_param_data_3;
 283         int                      event_param_data_4;
 284         int                      event_param_data_5;
 285         int                      event_param_data_6; /* in general, notification parameter #1 */
 286         int                      event_param_data_7; /* in general, notification parameter #2 */
 287         int                      event_param_data_8;
 288 } email_event_t;
 289
 290
 291 typedef struct
 292 {
 293         int   num;
 294         void *data;
 295 } email_callback_holder_t;
 296
 297
 298 typedef struct email_search_key_t email_search_key_t;
 299 struct email_search_key_t
 300 {
 301         int               type;
 302         char             *value;
 303         email_search_key_t *next;
 304 };
 305
 306 typedef struct
 307 {
 308         int                  tid;
 309         email_protocol_type_t  protocol;
 310         void                *stream;
 311         int                  auth;
 312         int                  network;
 313         int                  error;
 314         int                  status;
 315 } email_session_t;
 316
 317 typedef struct
 318 {
 319         int                    mailbox_id;                 /**< Unique id on mailbox table.*/
 320         char                  *mailbox_name;               /**< Specifies the path of mailbox.*/
 321         email_mailbox_type_e   mailbox_type;               /**< Specifies the type of mailbox */
 322         char                  *alias;                      /**< Specifies the display name of mailbox.*/
 323         int                    unread_count;               /**< Specifies the Unread Mail count in the mailbox.*/
 324         int                    total_mail_count_on_local;  /**< Specifies the total number of mails in the mailbox in the local DB.*/
 325         int                    total_mail_count_on_server; /**< Specifies the total number of mails in the mailbox in the mail server.*/
 326         int                    local;                      /**< Specifies the local mailbox.*/
 327         int                    synchronous;                /**< Specifies the mailbox with synchronized the server.*/
 328         int                    account_id;                 /**< Specifies the account ID for mailbox.*/
 329         int                    has_archived_mails;         /**< Specifies the archived mails.*/
 330         int                    mail_slot_size;             /**< Specifies how many mails can be stored in local mailbox.*/
 331         int                    no_select;                  /**< Specifies the 'no_select' attribute from xlist.*/
 332         void                  *user_data;                  /**< Specifies the internal data.*/
 333         void                  *mail_stream;                /**< Specifies the internal data.*/
 334 } email_internal_mailbox_t;
 335
 336 #ifdef __FEATURE_KEEP_CONNECTION__
 337 typedef struct email_connection_info
 338 {
 339         int                    account_id;
 340         int                    sending_server_stream_status;
 341         void                  *sending_server_stream;
 342         int                    receiving_server_stream_status;
 343         void                  *receiving_server_stream;
 344         struct email_connection_info *next;
 345 } email_connection_info_t;
 346 #endif /* __FEATURE_KEEP_CONNECTION__ */
 347
 348 typedef struct
 349 {
 350         char *contact_name;
 351         char *email_address;
 352         char *alias;
 353         int   storage_type;
 354         int   contact_id;
 355 } email_mail_contact_info_t;
 356
 357 /*  global account list */
 358 typedef struct email_account_list {
 359     email_account_t *account;
 360     struct email_account_list *next;
 361 } email_account_list_t;
 362
 363 typedef struct {
 364         int                task_id;
 365         email_task_type_t  task_type;
 366         thread_t           thread_id;
 367 } email_active_task_t;
 368
 369 typedef void (*email_event_callback)(int total, int done, int status, int account_id, int mail_id, int handle, void *user_data, int error);
 370
 371 /* ----------------------------------------------------------------------------- */
 372 /*  Please contact Himanshu [h.gahlaut@samsung.com] for any explanation in code here under __FEATURE_PARTIAL_BODY_DOWNLOAD__ MACRO */
 373 #ifdef __FEATURE_PARTIAL_BODY_DOWNLOAD__
 374 typedef enum
 375 {
 376         ACTIVITY_PARTIAL_BODY_DOWNLOAD_IMAP4 = 1,
 377         ACTIVITY_PARTIAL_BODY_DOWNLOAD_POP3_WAIT,
 378         ACTIVITY_PARTIAL_BODY_DOWNLOAD_POP3_ACTIVE
 379 }       email_pdb_activity_type_e;
 380
 381 typedef struct
 382 {
 383     int account_id;
 384     int mail_id;
 385     unsigned long server_mail_id;
 386     int activity_id;
 387     int mailbox_id;
 388     char *mailbox_name;
 389     email_event_type_t event_type;   /*  Event Type Null means event is created from local activitys    */
 390     int activity_type;             /*  Activity Type Null means event is created from event queue */
 391
 392 } email_event_partial_body_thd;
 393 #endif /*  __FEATURE_PARTIAL_BODY_DOWNLOAD__ */
 394
 395 #ifdef __cplusplus
 396 }
 397 #endif /*  __cplusplus */
 398
 399 #endif /*  __EMAIL_INTERNAL_TYPES_H__ */