camel/camel-folder-summary.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  *  Copyright (C) 2000 Ximian Inc.
   4  *
   5  *  Authors: Michael Zucchi <notzed@ximian.com>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of version 2 of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  */
  21
  22 #ifndef _CAMEL_FOLDER_SUMMARY_H
  23 #define _CAMEL_FOLDER_SUMMARY_H
  24
  25 #include <stdio.h>
  26 #include <time.h>
  27 #include <camel/camel-mime-parser.h>
  28 #include <camel/camel-object.h>
  29 #include <camel/camel-index.h>
  30
  31 #define CAMEL_FOLDER_SUMMARY_TYPE         camel_folder_summary_get_type ()
  32 #define CAMEL_FOLDER_SUMMARY(obj)         CAMEL_CHECK_CAST (obj, camel_folder_summary_get_type (), CamelFolderSummary)
  33 #define CAMEL_FOLDER_SUMMARY_CLASS(klass) CAMEL_CHECK_CLASS_CAST (klass, camel_folder_summary_get_type (), CamelFolderSummaryClass)
  34 #define CAMEL_IS_FOLDER_SUMMARY(obj)      CAMEL_CHECK_TYPE (obj, camel_folder_summary_get_type ())
  35
  36 G_BEGIN_DECLS
  37
  38 struct _CamelFolder;
  39
  40 /*typedef struct _CamelFolderSummary      CamelFolderSummary;*/
  41 typedef struct _CamelFolderSummaryClass CamelFolderSummaryClass;
  42
  43 typedef struct _CamelMessageInfo CamelMessageInfo;
  44 typedef struct _CamelMessageInfoBase CamelMessageInfoBase;
  45
  46 typedef struct _CamelFolderMetaSummary CamelFolderMetaSummary;
  47
  48 /* A tree of message content info structures
  49    describe the content structure of the message (if it has any) */
  50 struct _CamelMessageContentInfo {
  51         struct _CamelMessageContentInfo *next;
  52
  53         struct _CamelMessageContentInfo *childs;
  54         struct _CamelMessageContentInfo *parent;
  55
  56         CamelContentType *type;
  57         char *id;
  58         char *description;
  59         char *encoding;         /* this should be an enum?? */
  60         guint32 size;
  61 };
  62
  63 /* system flag bits */
  64 typedef enum _CamelMessageFlags {
  65         CAMEL_MESSAGE_ANSWERED = 1<<0,
  66         CAMEL_MESSAGE_DELETED = 1<<1,
  67         CAMEL_MESSAGE_DRAFT = 1<<2,
  68         CAMEL_MESSAGE_FLAGGED = 1<<3,
  69         CAMEL_MESSAGE_SEEN = 1<<4,
  70
  71         /* these aren't really system flag bits, but are convenience flags */
  72         CAMEL_MESSAGE_ATTACHMENTS = 1<<5,
  73         CAMEL_MESSAGE_ANSWERED_ALL = 1<<6,
  74         CAMEL_MESSAGE_JUNK = 1<<7,
  75         CAMEL_MESSAGE_SECURE = 1<<8,
  76         CAMEL_MESSAGE_USER_NOT_DELETABLE = 1<<9,
  77         CAMEL_MESSAGE_HIDDEN = 1<<10,
  78
  79         /* following flags are for the folder, and are not really permanent flags */
  80         CAMEL_MESSAGE_FOLDER_FLAGGED = 1<<16, /* for use by the folder implementation */
  81
  82         /* flags after 1<<16 are used by camel providers,
  83            if adding non permanent flags, add them to the end  */
  84
  85         CAMEL_MESSAGE_JUNK_LEARN = 1<<30, /* used when setting CAMEL_MESSAGE_JUNK flag
  86                                              to say that we request junk plugin
  87                                              to learn that message as junk/non junk */
  88         CAMEL_MESSAGE_USER = 1<<31 /* supports user flags */
  89 } CamelMessageFlags;
  90
  91 /* Changes to system flags will NOT trigger a folder changed event */
  92 #define CAMEL_MESSAGE_SYSTEM_MASK (0xffff << 16)
  93
  94 typedef struct _CamelFlag {
  95         struct _CamelFlag *next;
  96         char name[1];           /* name allocated as part of the structure */
  97 } CamelFlag;
  98
  99 typedef struct _CamelTag {
 100         struct _CamelTag *next;
 101         char *value;
 102         char name[1];           /* name allocated as part of the structure */
 103 } CamelTag;
 104
 105 /* a summary messageid is a 64 bit identifier (partial md5 hash) */
 106 typedef struct _CamelSummaryMessageID {
 107         union {
 108                 guint64 id;
 109                 unsigned char hash[8];
 110                 struct {
 111                         guint32 hi;
 112                         guint32 lo;
 113                 } part;
 114         } id;
 115 } CamelSummaryMessageID;
 116
 117 /* summary references is a fixed size array of references */
 118 typedef struct _CamelSummaryReferences {
 119         int size;
 120         CamelSummaryMessageID references[1];
 121 } CamelSummaryReferences;
 122
 123 /* accessor id's */
 124 enum {
 125         CAMEL_MESSAGE_INFO_SUBJECT,
 126         CAMEL_MESSAGE_INFO_FROM,
 127         CAMEL_MESSAGE_INFO_TO,
 128         CAMEL_MESSAGE_INFO_CC,
 129         CAMEL_MESSAGE_INFO_MLIST,
 130
 131         CAMEL_MESSAGE_INFO_FLAGS,
 132         CAMEL_MESSAGE_INFO_SIZE,
 133
 134         CAMEL_MESSAGE_INFO_DATE_SENT,
 135         CAMEL_MESSAGE_INFO_DATE_RECEIVED,
 136
 137         CAMEL_MESSAGE_INFO_MESSAGE_ID,
 138         CAMEL_MESSAGE_INFO_REFERENCES,
 139         CAMEL_MESSAGE_INFO_USER_FLAGS,
 140         CAMEL_MESSAGE_INFO_USER_TAGS,
 141
 142         CAMEL_MESSAGE_INFO_LAST
 143 };
 144
 145 /* information about a given message, use accessors */
 146 struct _CamelMessageInfo {
 147         CamelFolderSummary *summary;
 148
 149         guint32 refcount;       /* ??? */
 150         char *uid;
 151 };
 152
 153 /* For classes wishing to do the provided i/o, or for anonymous users,
 154  * they must subclass or use this messageinfo structure */
 155 /* Otherwise they can do their own thing entirely */
 156 struct _CamelMessageInfoBase {
 157         CamelFolderSummary *summary;
 158
 159         guint32 refcount;       /* ??? */
 160         char *uid;
 161
 162         const char *subject;
 163         const char *from;
 164         const char *to;
 165         const char *cc;
 166         const char *mlist;
 167
 168         guint32 flags;
 169         guint32 size;
 170
 171         time_t date_sent;
 172         time_t date_received;
 173
 174         CamelSummaryMessageID message_id;
 175         CamelSummaryReferences *references;/* from parent to root */
 176
 177         struct _CamelFlag *user_flags;
 178         struct _CamelTag *user_tags;
 179
 180         /* tree of content description - NULL if it is not available */
 181         CamelMessageContentInfo *content;
 182 };
 183
 184 /* probably do this as well, removing CamelFolderChangeInfo and interfaces
 185 typedef struct _CamelChangeInfo CamelChangeInfo;
 186 struct _CamelChangeInfo {
 187         GPtrArray *added;
 188         GPtrArray *removed;
 189         GPtrArray *changed;
 190         GPtrArray *recent;
 191 };
 192 */
 193
 194 typedef enum _CamelFolderSummaryFlags {
 195         CAMEL_SUMMARY_DIRTY = 1<<0,
 196 } CamelFolderSummaryFlags;
 197
 198 struct _CamelFolderSummary {
 199         CamelObject parent;
 200
 201         struct _CamelFolderSummaryPrivate *priv;
 202
 203         /* header info */
 204         guint32 version;        /* version of file loaded/loading */
 205         guint32 flags;          /* flags */
 206         guint32 nextuid;        /* next uid? */
 207         time_t time;            /* timestamp for this summary (for implementors to use) */
 208         guint32 saved_count;    /* how many were saved/loaded */
 209         guint32 unread_count;   /* handy totals */
 210         guint32 deleted_count;
 211         guint32 junk_count;
 212
 213         /* sizes of memory objects */
 214         guint32 message_info_size;
 215         guint32 content_info_size;
 216
 217         /* memory allocators (setup automatically) */
 218         struct _EMemChunk *message_info_chunks;
 219         struct _EMemChunk *content_info_chunks;
 220
 221         char *summary_path;
 222         gboolean build_content; /* do we try and parse/index the content, or not? */
 223
 224         GPtrArray *messages;    /* CamelMessageInfo's */
 225         GHashTable *messages_uid; /* CamelMessageInfo's by uid */
 226
 227         struct _CamelFolder *folder; /* parent folder, for events */
 228         struct _CamelFolderMetaSummary *meta_summary; /* Meta summary */
 229 };
 230
 231 struct _CamelFolderSummaryClass {
 232         CamelObjectClass parent_class;
 233
 234         /* load/save the global info */
 235         int (*summary_header_load)(CamelFolderSummary *, FILE *);
 236         int (*summary_header_save)(CamelFolderSummary *, FILE *);
 237
 238         /* create/save/load an individual message info */
 239         CamelMessageInfo * (*message_info_new_from_header)(CamelFolderSummary *, struct _camel_header_raw *);
 240         CamelMessageInfo * (*message_info_new_from_parser)(CamelFolderSummary *, CamelMimeParser *);
 241         CamelMessageInfo * (*message_info_new_from_message)(CamelFolderSummary *, CamelMimeMessage *);
 242         CamelMessageInfo * (*message_info_load)(CamelFolderSummary *, FILE *);
 243         int                (*message_info_save)(CamelFolderSummary *, FILE *, CamelMessageInfo *);
 244         int                (*meta_message_info_save)(CamelFolderSummary *, FILE *, FILE *, CamelMessageInfo *);
 245
 246         void               (*message_info_free)(CamelFolderSummary *, CamelMessageInfo *);
 247         CamelMessageInfo * (*message_info_clone)(CamelFolderSummary *, const CamelMessageInfo *);
 248
 249         /* save/load individual content info's */
 250         CamelMessageContentInfo * (*content_info_new_from_header)(CamelFolderSummary *, struct _camel_header_raw *);
 251         CamelMessageContentInfo * (*content_info_new_from_parser)(CamelFolderSummary *, CamelMimeParser *);
 252         CamelMessageContentInfo * (*content_info_new_from_message)(CamelFolderSummary *, CamelMimePart *);
 253         CamelMessageContentInfo * (*content_info_load)(CamelFolderSummary *, FILE *);
 254         int                       (*content_info_save)(CamelFolderSummary *, FILE *, CamelMessageContentInfo *);
 255         void                      (*content_info_free)(CamelFolderSummary *, CamelMessageContentInfo *);
 256
 257         /* get the next uid */
 258         char *(*next_uid_string)(CamelFolderSummary *);
 259
 260         /* virtual accessors on messageinfo's */
 261         const void *(*info_ptr)(const CamelMessageInfo *mi, int id);
 262         guint32     (*info_uint32)(const CamelMessageInfo *mi, int id);
 263         time_t      (*info_time)(const CamelMessageInfo *mi, int id);
 264
 265         gboolean    (*info_user_flag)(const CamelMessageInfo *mi, const char *id);
 266         const char *(*info_user_tag)(const CamelMessageInfo *mi, const char *id);
 267
 268         /* set accessors for the modifyable bits */
 269 #if 0
 270         void (*info_set_ptr)(CamelMessageInfo *mi, int id, const void *val);
 271         void (*info_set_uint32)(CamelMessageInfo *mi, int id, guint32 val);
 272         void (*info_set_time)(CamelMessageInfo *mi, int id, time_t val);
 273         void (*info_set_references)(CamelMessageInfo *mi, CamelSummaryReferences *);
 274 #endif
 275         gboolean (*info_set_user_flag)(CamelMessageInfo *mi, const char *id, gboolean state);
 276         gboolean (*info_set_user_tag)(CamelMessageInfo *mi, const char *id, const char *val);
 277         gboolean (*info_set_flags)(CamelMessageInfo *mi, guint32 mask, guint32 set);
 278 };
 279
 280 /* Meta-summary info */
 281 struct _CamelFolderMetaSummary {
 282         guint32 major;          /* Major version of meta-summary */
 283         guint32 minor;          /* Minor version of meta-summary */
 284         guint32 uid_len;        /* Length of UID (for implementors to use) */
 285         gboolean msg_expunged;  /* Whether any message is expunged or not */
 286         char *path;             /* Path to meta-summary-file */
 287 };
 288
 289 CamelType                        camel_folder_summary_get_type  (void);
 290 CamelFolderSummary      *camel_folder_summary_new       (struct _CamelFolder *folder);
 291
 292 void camel_folder_summary_set_filename(CamelFolderSummary *summary, const char *filename);
 293 void camel_folder_summary_set_index(CamelFolderSummary *summary, CamelIndex *index);
 294 void camel_folder_summary_set_build_content(CamelFolderSummary *summary, gboolean state);
 295
 296 guint32  camel_folder_summary_next_uid        (CamelFolderSummary *summary);
 297 char    *camel_folder_summary_next_uid_string (CamelFolderSummary *summary);
 298 void     camel_folder_summary_set_uid         (CamelFolderSummary *summary, guint32 uid);
 299
 300 /* load/save the summary in its entirety */
 301 int camel_folder_summary_load(CamelFolderSummary *summary);
 302 int camel_folder_summary_save(CamelFolderSummary *summary);
 303
 304 /* only load the header */
 305 int camel_folder_summary_header_load(CamelFolderSummary *summary);
 306
 307 /* set the dirty bit on the summary */
 308 void camel_folder_summary_touch(CamelFolderSummary *summary);
 309
 310 /* add a new raw summary item */
 311 void camel_folder_summary_add(CamelFolderSummary *summary, CamelMessageInfo *info);
 312
 313 /* build/add raw summary items */
 314 CamelMessageInfo *camel_folder_summary_add_from_header(CamelFolderSummary *summary, struct _camel_header_raw *headers);
 315 CamelMessageInfo *camel_folder_summary_add_from_parser(CamelFolderSummary *summary, CamelMimeParser *parser);
 316 CamelMessageInfo *camel_folder_summary_add_from_message(CamelFolderSummary *summary, CamelMimeMessage *message);
 317
 318 /* Just build raw summary items */
 319 CamelMessageInfo *camel_folder_summary_info_new_from_header(CamelFolderSummary *summary, struct _camel_header_raw *headers);
 320 CamelMessageInfo *camel_folder_summary_info_new_from_parser(CamelFolderSummary *summary, CamelMimeParser *parser);
 321 CamelMessageInfo *camel_folder_summary_info_new_from_message(CamelFolderSummary *summary, CamelMimeMessage *message);
 322
 323 CamelMessageContentInfo *camel_folder_summary_content_info_new(CamelFolderSummary *summary);
 324 void camel_folder_summary_content_info_free(CamelFolderSummary *summary, CamelMessageContentInfo *ci);
 325
 326 /* removes a summary item, doesn't fix content offsets */
 327 void camel_folder_summary_remove(CamelFolderSummary *summary, CamelMessageInfo *info);
 328 void camel_folder_summary_remove_uid(CamelFolderSummary *summary, const char *uid);
 329 void camel_folder_summary_remove_index(CamelFolderSummary *summary, int index);
 330 void camel_folder_summary_remove_range(CamelFolderSummary *summary, int start, int end);
 331
 332 /* remove all items */
 333 void camel_folder_summary_clear(CamelFolderSummary *summary);
 334
 335 /* lookup functions */
 336 int camel_folder_summary_count(CamelFolderSummary *summary);
 337 CamelMessageInfo *camel_folder_summary_index(CamelFolderSummary *summary, int index);
 338 CamelMessageInfo *camel_folder_summary_uid(CamelFolderSummary *summary, const char *uid);
 339 GPtrArray *camel_folder_summary_array(CamelFolderSummary *summary);
 340 void camel_folder_summary_array_free(CamelFolderSummary *summary, GPtrArray *array);
 341
 342 /* basically like strings, but certain keywords can be compressed and de-cased */
 343 int camel_folder_summary_encode_token(FILE *out, const char *str);
 344 int camel_folder_summary_decode_token(FILE *in, char **str);
 345
 346 /* message flag operations */
 347 gboolean        camel_flag_get(CamelFlag **list, const char *name);
 348 gboolean        camel_flag_set(CamelFlag **list, const char *name, gboolean state);
 349 gboolean        camel_flag_list_copy(CamelFlag **to, CamelFlag **from);
 350 int             camel_flag_list_size(CamelFlag **list);
 351 void            camel_flag_list_free(CamelFlag **list);
 352
 353 guint32         camel_system_flag (const char *name);
 354 gboolean        camel_system_flag_get (guint32 flags, const char *name);
 355
 356 /* message tag operations */
 357 const char      *camel_tag_get(CamelTag **list, const char *name);
 358 gboolean        camel_tag_set(CamelTag **list, const char *name, const char *value);
 359 gboolean        camel_tag_list_copy(CamelTag **to, CamelTag **from);
 360 int             camel_tag_list_size(CamelTag **list);
 361 void            camel_tag_list_free(CamelTag **list);
 362
 363 /* Summary may be null */
 364 /* Use anonymous pointers to avoid tons of cast crap */
 365 void *camel_message_info_new(CamelFolderSummary *summary);
 366 void camel_message_info_ref(void *info);
 367 CamelMessageInfo *camel_message_info_new_from_header(CamelFolderSummary *summary, struct _camel_header_raw *header);
 368 void camel_message_info_free(void *info);
 369 void *camel_message_info_clone(const void *info);
 370
 371 /* accessors */
 372 const void *camel_message_info_ptr(const CamelMessageInfo *mi, int id);
 373 guint32 camel_message_info_uint32(const CamelMessageInfo *mi, int id);
 374 time_t camel_message_info_time(const CamelMessageInfo *mi, int id);
 375
 376 #define camel_message_info_uid(mi) ((const char *)((const CamelMessageInfo *)mi)->uid)
 377
 378 #define camel_message_info_subject(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_SUBJECT))
 379 #define camel_message_info_from(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_FROM))
 380 #define camel_message_info_to(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_TO))
 381 #define camel_message_info_cc(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_CC))
 382 #define camel_message_info_mlist(mi) ((const char *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_MLIST))
 383
 384 #define camel_message_info_flags(mi) camel_message_info_uint32((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_FLAGS)
 385 #define camel_message_info_size(mi) camel_message_info_uint32((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_SIZE)
 386
 387 #define camel_message_info_date_sent(mi) camel_message_info_time((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_DATE_SENT)
 388 #define camel_message_info_date_received(mi) camel_message_info_time((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_DATE_RECEIVED)
 389
 390 #define camel_message_info_message_id(mi) ((const CamelSummaryMessageID *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_MESSAGE_ID))
 391 #define camel_message_info_references(mi) ((const CamelSummaryReferences *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_REFERENCES))
 392 #define camel_message_info_user_flags(mi) ((const CamelFlag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_FLAGS))
 393 #define camel_message_info_user_tags(mi) ((const CamelTag *)camel_message_info_ptr((const CamelMessageInfo *)mi, CAMEL_MESSAGE_INFO_USER_TAGS))
 394
 395 gboolean camel_message_info_user_flag(const CamelMessageInfo *mi, const char *id);
 396 const char *camel_message_info_user_tag(const CamelMessageInfo *mi, const char *id);
 397
 398 gboolean camel_message_info_set_flags(CamelMessageInfo *mi, guint32 mask, guint32 set);
 399 gboolean camel_message_info_set_user_flag(CamelMessageInfo *mi, const char *id, gboolean state);
 400 gboolean camel_message_info_set_user_tag(CamelMessageInfo *mi, const char *id, const char *val);
 401
 402 /* debugging functions */
 403 void camel_content_info_dump (CamelMessageContentInfo *ci, int depth);
 404
 405 void camel_message_info_dump (CamelMessageInfo *mi);
 406
 407 G_END_DECLS
 408
 409 #endif /* ! _CAMEL_FOLDER_SUMMARY_H */