libcitadel/lib/libcitadel.h

   1 /*
   2  * $Id$
   3  *
   4  */
   5
   6
   7 #define LIBCITADEL_VERSION_NUMBER       104
   8
   9 /*
  10  * Here's a bunch of stupid magic to make the MIME parser portable.
  11  */
  12 #ifndef SIZ
  13 #define SIZ     4096
  14 #endif
  15
  16
  17 /*
  18  * View definitions.
  19  * Note that not all views are implemented in all clients.
  20  */
  21 #define VIEW_BBS                0       /* Bulletin board view */
  22 #define VIEW_MAILBOX            1       /* Mailbox summary */
  23 #define VIEW_ADDRESSBOOK        2       /* Address book view */
  24 #define VIEW_CALENDAR           3       /* Calendar view */
  25 #define VIEW_TASKS              4       /* Tasks view */
  26 #define VIEW_NOTES              5       /* Notes view */
  27 #define VIEW_WIKI               6       /* Wiki view */
  28 #define VIEW_CALBRIEF           7       /* Brief Calendar view */
  29 #define VIEW_JOURNAL            8       /* Journal view */
  30
  31
  32 #ifndef IsEmptyStr
  33 #define IsEmptyStr(a) ((a)[0] == '\0')
  34 #endif
  35
  36 /*
  37  * Misc declarations
  38  */
  39
  40 char *libcitadel_version_string(void);
  41 int libcitadel_version_number(void);
  42
  43
  44 /*
  45  * MIME parser declarations
  46  */
  47
  48 void extract_key(char *target, char *source, char *key);
  49
  50 void mime_parser(char *content_start, char *content_end,
  51                 void (*CallBack)
  52                         (char *cbname,
  53                         char *cbfilename,
  54                         char *cbpartnum,
  55                         char *cbdisp,
  56                         void *cbcontent,
  57                         char *cbtype,
  58                         char *cbcharset,
  59                         size_t cblength,
  60                         char *cbencoding,
  61                         void *cbuserdata),
  62                 void (*PreMultiPartCallBack)
  63                         (char *cbname,
  64                         char *cbfilename,
  65                         char *cbpartnum,
  66                         char *cbdisp,
  67                         void *cbcontent,
  68                         char *cbtype,
  69                         char *cbcharset,
  70                         size_t cblength,
  71                         char *cbencoding,
  72                         void *cbuserdata),
  73                 void (*PostMultiPartCallBack)
  74                         (char *cbname,
  75                         char *cbfilename,
  76                         char *cbpartnum,
  77                         char *cbdisp,
  78                         void *cbcontent,
  79                         char *cbtype,
  80                         char *cbcharset,
  81                         size_t cblength,
  82                         char *cbencoding,
  83                         void *cbuserdata),
  84                 void *userdata,
  85                 int dont_decode
  86                 );
  87
  88
  89
  90 char *fixed_partnum(char *);
  91 void mime_decode(char *partnum,
  92                  char *part_start, size_t length,
  93                  char *content_type, char *charset, char *encoding,
  94                  char *disposition,
  95                  char *name, char *filename,
  96                  void (*CallBack)
  97                   (char *cbname,
  98                    char *cbfilename,
  99                    char *cbpartnum,
 100                    char *cbdisp,
 101                    void *cbcontent,
 102                    char *cbtype,
 103                    char *cbcharset,
 104                    size_t cblength,
 105                    char *cbencoding,
 106                    void *cbuserdata),
 107                  void (*PreMultiPartCallBack)
 108                   (char *cbname,
 109                    char *cbfilename,
 110                    char *cbpartnum,
 111                    char *cbdisp,
 112                    void *cbcontent,
 113                    char *cbtype,
 114                    char *cbcharset,
 115                    size_t cblength,
 116                    char *cbencoding,
 117                    void *cbuserdata),
 118                  void (*PostMultiPartCallBack)
 119                   (char *cbname,
 120                    char *cbfilename,
 121                    char *cbpartnum,
 122                    char *cbdisp,
 123                    void *cbcontent,
 124                    char *cbtype,
 125                    char *cbcharset,
 126                    size_t cblength,
 127                    char *cbencoding,
 128                    void *cbuserdata),
 129                   void *userdata,
 130                   int dont_decode
 131 );
 132 void the_mime_parser(char *partnum,
 133                      char *content_start, char *content_end,
 134                      void (*CallBack)
 135                       (char *cbname,
 136                        char *cbfilename,
 137                        char *cbpartnum,
 138                        char *cbdisp,
 139                        void *cbcontent,
 140                        char *cbtype,
 141                        char *cbcharset,
 142                        size_t cblength,
 143                        char *cbencoding,
 144                        void *cbuserdata),
 145                      void (*PreMultiPartCallBack)
 146                       (char *cbname,
 147                        char *cbfilename,
 148                        char *cbpartnum,
 149                        char *cbdisp,
 150                        void *cbcontent,
 151                        char *cbtype,
 152                        char *cbcharset,
 153                        size_t cblength,
 154                        char *cbencoding,
 155                        void *cbuserdata),
 156                      void (*PostMultiPartCallBack)
 157                       (char *cbname,
 158                        char *cbfilename,
 159                        char *cbpartnum,
 160                        char *cbdisp,
 161                        void *cbcontent,
 162                        char *cbtype,
 163                        char *cbcharset,
 164                        size_t cblength,
 165                        char *cbencoding,
 166                        void *cbuserdata),
 167                       void *userdata,
 168                       int dont_decode
 169 );
 170
 171 const char *GuessMimeType(char *data, size_t dlen);
 172 const char* GuessMimeByFilename(const char *what, size_t len);
 173
 174
 175
 176 /* tools */
 177
 178
 179
 180 char *safestrncpy(char *dest, const char *src, size_t n);
 181 int num_tokens (const char *source, char tok);
 182 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 183 long grab_token(char **dest, const char *source, int parmnum, char separator);
 184 int extract_int (const char *source, int parmnum);
 185 long extract_long (const char *source, int parmnum);
 186 unsigned long extract_unsigned_long(const char *source, int parmnum);
 187 void CtdlInitBase64Table(void);
 188 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
 189 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
 190 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 191 void striplt(char *);
 192 int haschar(const char *st, int ch);
 193 void remove_token(char *source, int parmnum, char separator);
 194 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
 195 int is_msg_in_sequence_set(char *mset, long msgnum);
 196 char *memreadline(char *start, char *buf, int maxlen);
 197 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
 198 #define IsEmptyStr(a) ((a)[0] == '\0')
 199 #define num_parms(source)               num_tokens(source,(char)'|')
 200 void stripout(char *str, char leftboundary, char rightboundary);
 201 void stripallbut(char *str, char leftboundary, char rightboundary);
 202 char *myfgets(char *s, int size, FILE *stream);
 203 void urlesc(char *outbuf, size_t oblen, char *strbuf);
 204 char *CtdlTempFileName(char *prefix1, int prefix2);
 205 FILE *CtdlTempFile(void);
 206 void generate_uuid(char *buf);
 207 char *bmstrcasestr(char *text, char *pattern);
 208 void CtdlMakeTempFileName(char *name, int len);
 209 char *rfc2047encode(char *line, long length);
 210 int is_msg_in_mset(char *mset, long msgnum);
 211 int pattern2(char *search, char *patn);
 212 void stripltlen(char *, int *);
 213
 214
 215
 216 /* vCard stuff */
 217
 218 #define CTDL_VCARD_MAGIC        0xa1f9
 219
 220 /* This data structure represents a vCard object currently in memory. */
 221 struct vCard {
 222         int magic;
 223         int numprops;
 224         struct vCardProp {
 225                 char *name;
 226                 char *value;
 227         } *prop;
 228 };
 229
 230
 231 struct vCard *vcard_new(void);
 232 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
 233 struct vCard *vcard_load(char *);
 234 void vcard_free(struct vCard *);
 235 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
 236 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
 237                         int instance, int return_propname);
 238 char *vcard_serialize(struct vCard *);
 239 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
 240 void remove_charset_attribute(char *strbuf);
 241
 242 typedef struct HashList HashList;
 243
 244 typedef struct HashKey HashKey;
 245
 246 typedef struct HashPos HashPos;
 247
 248 typedef void (*DeleteHashDataFunc)(void * Data);
 249
 250
 251
 252 HashList *NewHash(void);
 253 void DeleteHash(HashList **Hash);
 254
 255
 256 int GetHash(HashList *Hash, char *HKey, long HKLen, void **Data);
 257
 258 void Put(HashList *Hash, char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
 259
 260 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
 261
 262 int GetHashKeys(HashList *Hash, const char ***List);
 263
 264 int PrintHash(HashList *Hash);
 265
 266 HashPos *GetNewHashPos(void);
 267 void DeleteHashPos(HashPos **DelMe);
 268
 269 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, char **HashKey, void **Data);