/* * Copyright (C) 2000 Helix Code Inc. * * Authors: Michael Zucchi * * 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 2 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, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA */ #ifndef _CAMEL_FOLDER_SUMMARY_H #define _CAMEL_FOLDER_SUMMARY_H #include #include #include #include #include #define CAMEL_FOLDER_SUMMARY(obj) CAMEL_CHECK_CAST (obj, camel_folder_summary_get_type (), CamelFolderSummary) #define CAMEL_FOLDER_SUMMARY_CLASS(klass) CAMEL_CHECK_CLASS_CAST (klass, camel_folder_summary_get_type (), CamelFolderSummaryClass) #define IS_CAMEL_FOLDER_SUMMARY(obj) CAMEL_CHECK_TYPE (obj, camel_folder_summary_get_type ()) /*typedef struct _CamelFolderSummary CamelFolderSummary;*/ typedef struct _CamelFolderSummaryClass CamelFolderSummaryClass; /* A tree of message content info structures describe the content structure of the message (if it has any) */ typedef struct _CamelMessageContentInfo { struct _CamelMessageContentInfo *next; struct _CamelMessageContentInfo *childs; struct _CamelMessageContentInfo *parent; struct _header_content_type *type; char *id; char *description; char *encoding; /* information about where this object lives in the stream. if pos is -1 these are all invalid */ off_t pos; off_t bodypos; off_t endpos; } CamelMessageContentInfo; /* system flag bits */ enum _CamelMessageFlags { CAMEL_MESSAGE_ANSWERED = 1<<0, CAMEL_MESSAGE_DELETED = 1<<1, CAMEL_MESSAGE_DRAFT = 1<<2, CAMEL_MESSAGE_FLAGGED = 1<<3, CAMEL_MESSAGE_SEEN = 1<<4, /* following flags are for the folder, and are not really permanent flags */ CAMEL_MESSAGE_FOLDER_FLAGGED = 1<<16, /* for use by the folder implementation */ CAMEL_MESSAGE_USER = 1<<31 /* supports user flags */ }; typedef struct _CamelFlag { struct _CamelFlag *next; char name[1]; /* name allocated as part of the structure */ } CamelFlag; typedef struct _CamelTag { struct _CamelTag *next; char *value; char name[1]; /* name allocated as part of the structure */ } CamelTag; /* information about a given object */ typedef struct { /* public fields */ gchar *subject; gchar *from; gchar *to; gchar *cc; gchar *uid; guint32 flags; guint32 size; time_t date_sent; time_t date_received; /* Message-ID / References structures */ char *message_id; /* for this message */ struct _header_references *references; /* from parent to root */ struct _CamelFlag *user_flags; struct _CamelTag *user_tags; /* tree of content description - NULL if it is not available */ CamelMessageContentInfo *content; } CamelMessageInfo; enum _CamelFolderSummaryFlags { CAMEL_SUMMARY_DIRTY = 1<<0, }; struct _CamelFolderSummary { CamelObject parent; struct _CamelFolderSummaryPrivate *priv; /* header info */ guint32 version; /* version of file required, should be set by implementors */ guint32 flags; /* flags */ guint32 nextuid; /* next uid? */ guint32 saved_count; /* how many were saved/loaded */ time_t time; /* timestamp for this summary (for implementors to use) */ /* sizes of memory objects */ guint32 message_info_size; guint32 content_info_size; char *summary_path; gboolean build_content; /* do we try and parse/index the content, or not? */ GPtrArray *messages; /* CamelMessageInfo's */ GHashTable *messages_uid; /* CamelMessageInfo's by uid */ }; struct _CamelFolderSummaryClass { CamelObjectClass parent_class; /* load/save the global info */ int (*summary_header_load)(CamelFolderSummary *, FILE *); int (*summary_header_save)(CamelFolderSummary *, FILE *); /* create/save/load an individual message info */ CamelMessageInfo * (*message_info_new)(CamelFolderSummary *, struct _header_raw *); CamelMessageInfo * (*message_info_new_from_parser)(CamelFolderSummary *, CamelMimeParser *); CamelMessageInfo * (*message_info_load)(CamelFolderSummary *, FILE *); int (*message_info_save)(CamelFolderSummary *, FILE *, CamelMessageInfo *); void (*message_info_free)(CamelFolderSummary *, CamelMessageInfo *); /* save/load individual content info's */ CamelMessageContentInfo * (*content_info_new)(CamelFolderSummary *, struct _header_raw *); CamelMessageContentInfo * (*content_info_new_from_parser)(CamelFolderSummary *, CamelMimeParser *); CamelMessageContentInfo * (*content_info_load)(CamelFolderSummary *, FILE *); int (*content_info_save)(CamelFolderSummary *, FILE *, CamelMessageContentInfo *); void (*content_info_free)(CamelFolderSummary *, CamelMessageContentInfo *); }; guint camel_folder_summary_get_type (void); CamelFolderSummary *camel_folder_summary_new (void); void camel_folder_summary_set_filename(CamelFolderSummary *, const char *); void camel_folder_summary_set_index(CamelFolderSummary *, ibex *); void camel_folder_summary_set_build_content(CamelFolderSummary *, gboolean state); guint32 camel_folder_summary_next_uid (CamelFolderSummary *s); char *camel_folder_summary_next_uid_string (CamelFolderSummary *s); void camel_folder_summary_set_uid (CamelFolderSummary *s, guint32 uid); /* load/save the summary in its entirety */ int camel_folder_summary_load(CamelFolderSummary *); int camel_folder_summary_save(CamelFolderSummary *); /* set the dirty bit on the summary */ void camel_folder_summary_touch(CamelFolderSummary *s); /* add a new raw summary item */ void camel_folder_summary_add(CamelFolderSummary *, CamelMessageInfo *info); /* build/add raw summary items */ CamelMessageInfo *camel_folder_summary_add_from_header(CamelFolderSummary *, struct _header_raw *); CamelMessageInfo *camel_folder_summary_add_from_parser(CamelFolderSummary *, CamelMimeParser *); /* removes a summary item, doesn't fix content offsets */ void camel_folder_summary_remove(CamelFolderSummary *s, CamelMessageInfo *info); void camel_folder_summary_remove_uid(CamelFolderSummary *s, const char *uid); void camel_folder_summary_remove_index(CamelFolderSummary *s, int); /* remove all items */ void camel_folder_summary_clear(CamelFolderSummary *s); /* lookup functions */ int camel_folder_summary_count(CamelFolderSummary *); CamelMessageInfo *camel_folder_summary_index(CamelFolderSummary *, int); CamelMessageInfo *camel_folder_summary_uid(CamelFolderSummary *, const char *uid); /* shift content ... */ void camel_folder_summary_offset_content(CamelMessageContentInfo *content, off_t offset); /* summary formatting utils */ char *camel_folder_summary_format_address (struct _header_raw *h, const char *name); char *camel_folder_summary_format_string (struct _header_raw *h, const char *name); /* summary file loading/saving helper functions */ int camel_folder_summary_encode_fixed_int32(FILE *, gint32); int camel_folder_summary_decode_fixed_int32(FILE *, gint32 *); int camel_folder_summary_encode_uint32(FILE *, guint32); int camel_folder_summary_decode_uint32(FILE *, guint32 *); int camel_folder_summary_encode_time_t(FILE *out, time_t value); int camel_folder_summary_decode_time_t(FILE *in, time_t *dest); int camel_folder_summary_encode_string(FILE *, char *); int camel_folder_summary_decode_string(FILE *, char **); /* basically like strings, but certain keywords can be compressed and de-cased */ int camel_folder_summary_encode_token(FILE *, char *); int camel_folder_summary_decode_token(FILE *, char **); /* message flag operations */ gboolean camel_flag_get(CamelFlag **list, const char *name); void camel_flag_set(CamelFlag **list, const char *name, gboolean state); int camel_flag_list_size(CamelFlag **list); void camel_flag_list_free(CamelFlag **list); /* message tag operations */ const char *camel_tag_get(CamelTag **list, const char *name); void camel_tag_set(CamelTag **list, const char *name, const char *value); int camel_tag_list_size(CamelTag **list); void camel_tag_list_free(CamelTag **list); /* message info utils */ void camel_message_info_dup_to(const CamelMessageInfo *from, CamelMessageInfo *to); void camel_message_info_free(CamelMessageInfo *mi); #endif /* ! _CAMEL_FOLDER_SUMMARY_H */