libcitadel/lib/libcitadel.h

   1 /*
   2  * $Id$
   3  *
   4  */
   5
   6
   7 /* protect against double includes */
   8 #ifndef LIBCITADEL_H
   9 #define LIBCITADEL_H
  10
  11
  12 /*
  13  * since we reference time_t...
  14  */
  15 #include <time.h>
  16 #include <stdlib.h>
  17 #include <stdarg.h>
  18 #define LIBCITADEL_VERSION_NUMBER       738
  19
  20 /*
  21  * Here's a bunch of stupid magic to make the MIME parser portable.
  22  */
  23 #ifndef SIZ
  24 #define SIZ     4096
  25 #endif
  26
  27
  28 /* Logging levels - correspond to syslog(3) */
  29 enum LogLevel {
  30         /* When about to exit the server for an unrecoverable error */
  31          CTDL_EMERG,    /* system is unusable */
  32         /* Manual intervention is required to avoid an abnormal exit */
  33          CTDL_ALERT,    /* action must be taken immediately */
  34         /* The server can continue to run with degraded functionality */
  35          CTDL_CRIT,     /* critical conditions */
  36         /* An error occurs but the server continues to run normally */
  37          CTDL_ERR,      /* error conditions */
  38         /* An abnormal condition was detected; server will continue normally */
  39          CTDL_WARNING,  /* warning conditions */
  40         /* Normal messages (login/out, activity, etc.) */
  41          CTDL_NOTICE,   /* normal but significant condition */
  42         /* Unimportant progress messages, etc. */
  43          CTDL_INFO,     /* informational */
  44         /* Debugging messages */
  45          CTDL_DEBUG     /* debug-level messages */
  46 };
  47
  48
  49 /*
  50  * View definitions.
  51  * Note that not all views are implemented in all clients.
  52  */
  53 #define VIEW_BBS                0       /* Bulletin board view */
  54 #define VIEW_MAILBOX            1       /* Mailbox summary */
  55 #define VIEW_ADDRESSBOOK        2       /* Address book view */
  56 #define VIEW_CALENDAR           3       /* Calendar view */
  57 #define VIEW_TASKS              4       /* Tasks view */
  58 #define VIEW_NOTES              5       /* Notes view */
  59 #define VIEW_WIKI               6       /* Wiki view */
  60 #define VIEW_CALBRIEF           7       /* Brief Calendar view */
  61 #define VIEW_JOURNAL            8       /* Journal view */
  62
  63
  64 #ifndef IsEmptyStr
  65 #define IsEmptyStr(a) ((a)[0] == '\0')
  66 #endif
  67
  68 /*
  69  * Misc declarations
  70  */
  71
  72 char *libcitadel_version_string(void);
  73 int libcitadel_version_number(void);
  74
  75
  76 /*
  77  * MIME parser declarations
  78  */
  79
  80 void extract_key(char *target, char *source, char *key);
  81
  82 void mime_parser(char *content_start, char *content_end,
  83                 void (*CallBack)
  84                         (char *cbname,
  85                         char *cbfilename,
  86                         char *cbpartnum,
  87                         char *cbdisp,
  88                         void *cbcontent,
  89                         char *cbtype,
  90                         char *cbcharset,
  91                         size_t cblength,
  92                         char *cbencoding,
  93                         void *cbuserdata),
  94                 void (*PreMultiPartCallBack)
  95                         (char *cbname,
  96                         char *cbfilename,
  97                         char *cbpartnum,
  98                         char *cbdisp,
  99                         void *cbcontent,
 100                         char *cbtype,
 101                         char *cbcharset,
 102                         size_t cblength,
 103                         char *cbencoding,
 104                         void *cbuserdata),
 105                 void (*PostMultiPartCallBack)
 106                         (char *cbname,
 107                         char *cbfilename,
 108                         char *cbpartnum,
 109                         char *cbdisp,
 110                         void *cbcontent,
 111                         char *cbtype,
 112                         char *cbcharset,
 113                         size_t cblength,
 114                         char *cbencoding,
 115                         void *cbuserdata),
 116                 void *userdata,
 117                 int dont_decode
 118                 );
 119
 120
 121
 122 char *fixed_partnum(char *);
 123 void mime_decode(char *partnum,
 124                  char *part_start, size_t length,
 125                  char *content_type, char *charset, char *encoding,
 126                  char *disposition,
 127                  char *name, char *filename,
 128                  void (*CallBack)
 129                   (char *cbname,
 130                    char *cbfilename,
 131                    char *cbpartnum,
 132                    char *cbdisp,
 133                    void *cbcontent,
 134                    char *cbtype,
 135                    char *cbcharset,
 136                    size_t cblength,
 137                    char *cbencoding,
 138                    void *cbuserdata),
 139                  void (*PreMultiPartCallBack)
 140                   (char *cbname,
 141                    char *cbfilename,
 142                    char *cbpartnum,
 143                    char *cbdisp,
 144                    void *cbcontent,
 145                    char *cbtype,
 146                    char *cbcharset,
 147                    size_t cblength,
 148                    char *cbencoding,
 149                    void *cbuserdata),
 150                  void (*PostMultiPartCallBack)
 151                   (char *cbname,
 152                    char *cbfilename,
 153                    char *cbpartnum,
 154                    char *cbdisp,
 155                    void *cbcontent,
 156                    char *cbtype,
 157                    char *cbcharset,
 158                    size_t cblength,
 159                    char *cbencoding,
 160                    void *cbuserdata),
 161                   void *userdata,
 162                   int dont_decode
 163 );
 164 void the_mime_parser(char *partnum,
 165                      char *content_start, char *content_end,
 166                      void (*CallBack)
 167                       (char *cbname,
 168                        char *cbfilename,
 169                        char *cbpartnum,
 170                        char *cbdisp,
 171                        void *cbcontent,
 172                        char *cbtype,
 173                        char *cbcharset,
 174                        size_t cblength,
 175                        char *cbencoding,
 176                        void *cbuserdata),
 177                      void (*PreMultiPartCallBack)
 178                       (char *cbname,
 179                        char *cbfilename,
 180                        char *cbpartnum,
 181                        char *cbdisp,
 182                        void *cbcontent,
 183                        char *cbtype,
 184                        char *cbcharset,
 185                        size_t cblength,
 186                        char *cbencoding,
 187                        void *cbuserdata),
 188                      void (*PostMultiPartCallBack)
 189                       (char *cbname,
 190                        char *cbfilename,
 191                        char *cbpartnum,
 192                        char *cbdisp,
 193                        void *cbcontent,
 194                        char *cbtype,
 195                        char *cbcharset,
 196                        size_t cblength,
 197                        char *cbencoding,
 198                        void *cbuserdata),
 199                       void *userdata,
 200                       int dont_decode
 201 );
 202
 203 typedef struct StrBuf StrBuf;
 204
 205 StrBuf* NewStrBuf(void);
 206 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
 207 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
 208 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
 209 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
 210 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
 211 void FreeStrBuf (StrBuf **FreeMe);
 212 void HFreeStrBuf (void *VFreeMe);
 213 int FlushStrBuf(StrBuf *buf);
 214
 215 const char *ChrPtr(const StrBuf *Str);
 216 int StrLength(const StrBuf *Str);
 217 #define SKEY(a) ChrPtr(a), StrLength(a)
 218 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
 219
 220 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
 221 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
 222 int StrBufTCP_read_buffered_line(StrBuf *Line,
 223                                  StrBuf *buf,
 224                                  int *fd,
 225                                  int timeout,
 226                                  int selectresolution,
 227                                  const char **Error);
 228
 229 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
 230 int StrBufSub(StrBuf *dest, const StrBuf *Source, size_t Offset, size_t nChars);
 231 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
 232 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
 233 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
 234 inline int StrBufNum_tokens(const StrBuf *source, char tok);
 235 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
 236
 237 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, size_t Offset);
 238 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, size_t Offset);
 239 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
 240 #ifdef SHOW_ME_VAPPEND_PRINTF
 241 /* so owe don't create an include depndency, this is just visible on demand. */
 242 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
 243 #endif
 244 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
 245 void StrBufCutLeft(StrBuf *Buf, int nChars);
 246 void StrBufCutRight(StrBuf *Buf, int nChars);
 247 void StrBufUpCase(StrBuf *Buf);
 248 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
 249 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
 250
 251 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
 252
 253 int CompressBuffer(StrBuf *Buf);
 254 int StrBufDecodeBase64(StrBuf *Buf);
 255 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
 256 #define LB                      (1)             /* Internal escape chars */
 257 #define RB                      (2)
 258 #define QU                      (3)
 259 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
 260 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
 261 void StrMsgEscAppend(StrBuf *Target, StrBuf *Source, const char *PlainIn);
 262
 263 long StrTol(const StrBuf *Buf);
 264 int StrToi(const StrBuf *Buf);
 265
 266 const char *GuessMimeType(const char *data, size_t dlen);
 267 const char* GuessMimeByFilename(const char *what, size_t len);
 268
 269 /* Run once at Programstart */
 270 int LoadIconDir(const char *DirName);
 271
 272 /* Select the icon for a given MIME type */
 273 const char *GetIconFilename(char *MimeType, size_t len);
 274
 275 void ShutDownLibCitadel(void);
 276
 277
 278 /* tools */
 279
 280 int Ctdl_IsUtf8SequenceStart(char Char);
 281 int Ctdl_GetUtf8SequenceLength(char Char);
 282 int Ctdl_Utf8StrLen(char *str);
 283 char *Ctdl_Utf8StrCut(char *str, int maxlen);
 284
 285
 286 int safestrncpy(char *dest, const char *src, size_t n);
 287 int num_tokens (const char *source, char tok);
 288 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 289 long grab_token(char **dest, const char *source, int parmnum, char separator);
 290 int extract_int (const char *source, int parmnum);
 291 long extract_long (const char *source, int parmnum);
 292 unsigned long extract_unsigned_long(const char *source, int parmnum);
 293 void CtdlInitBase64Table(void);
 294 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
 295 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
 296 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 297 void striplt(char *);
 298 int haschar(const char *st, int ch);
 299 void remove_token(char *source, int parmnum, char separator);
 300 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
 301 int is_msg_in_sequence_set(char *mset, long msgnum);
 302 char *memreadline(char *start, char *buf, int maxlen);
 303 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
 304 #define IsEmptyStr(a) ((a)[0] == '\0')
 305 #define num_parms(source)               num_tokens(source,(char)'|')
 306 void stripout(char *str, char leftboundary, char rightboundary);
 307 void stripallbut(char *str, char leftboundary, char rightboundary);
 308 char *myfgets(char *s, int size, FILE *stream);
 309 void urlesc(char *outbuf, size_t oblen, char *strbuf);
 310 char *CtdlTempFileName(char *prefix1, int prefix2);
 311 FILE *CtdlTempFile(void);
 312 void generate_uuid(char *buf);
 313 char *bmstrcasestr(char *text, char *pattern);
 314 void CtdlMakeTempFileName(char *name, int len);
 315 char *rfc2047encode(char *line, long length);
 316 int is_msg_in_mset(char *mset, long msgnum);
 317 int pattern2(char *search, char *patn);
 318 void stripltlen(char *, int *);
 319 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
 320 void LoadEntityList(char *FileName);
 321
 322
 323
 324 /* vCard stuff */
 325
 326 #define CTDL_VCARD_MAGIC        0xa1f9
 327
 328 /* This data structure represents a vCard object currently in memory. */
 329 struct vCard {
 330         int magic;
 331         int numprops;
 332         struct vCardProp {
 333                 char *name;
 334                 char *value;
 335         } *prop;
 336 };
 337
 338
 339 struct vCard *vcard_new(void);
 340 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
 341 struct vCard *vcard_load(char *);
 342 void vcard_free(struct vCard *);
 343 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
 344 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
 345                         int instance, int return_propname);
 346 char *vcard_serialize(struct vCard *);
 347 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
 348 void remove_charset_attribute(char *strbuf);
 349 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
 350
 351 /*
 352  * Hash list implementation for Citadel
 353  */
 354 #define HKEY(a) a, sizeof(a) - 1
 355 typedef struct HashList HashList;
 356
 357 typedef struct HashKey HashKey;
 358
 359 typedef struct HashPos HashPos;
 360
 361 typedef void (*DeleteHashDataFunc)(void * Data);
 362 typedef const char *(*PrintHashContent)(void * Data);
 363 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
 364 typedef int (*HashFunc)(const char *Str, long Len);
 365 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
 366 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
 367
 368 HashList *NewHash(int Uniq, HashFunc F);
 369 void DeleteHash(HashList **Hash);
 370 void HDeleteHash(void *vHash);
 371 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
 372 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
 373 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
 374 int GetHashKeys(HashList *Hash, char ***List);
 375 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
 376 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
 377 HashPos *GetNewHashPos(void);
 378 void DeleteHashPos(HashPos **DelMe);
 379 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
 380 void SortByHashKey(HashList *Hash, int Order);
 381 void SortByHashKeyStr(HashList *Hash);
 382 int GetCount(HashList *Hash);
 383 const void *GetSearchPayload(const void *HashVoid);
 384 void SortByPayload(HashList *Hash, CompareFunc SortBy);
 385 void generic_free_handler(void *ptr);
 386
 387
 388 void convert_spaces_to_underscores(char *str);
 389
 390 /*
 391  * Convert 4 bytes char into an Integer.
 392  * usefull for easy inexpensive hashing
 393  * of for char strings.
 394  */
 395 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
 396
 397 /* vNote implementation */
 398
 399 #define CTDL_VNOTE_MAGIC        0xa1fa
 400
 401 struct vnote {
 402         int magic;
 403         char *uid;
 404         char *summary;
 405         char *body;
 406         int pos_left;
 407         int pos_top;
 408         int pos_width;
 409         int pos_height;
 410         int color_red;
 411         int color_green;
 412         int color_blue;
 413 };
 414
 415
 416
 417 struct vnote *vnote_new(void);
 418 struct vnote *vnote_new_from_str(char *s);
 419 void vnote_free(struct vnote *v);
 420 char *vnote_serialize(struct vnote *v);
 421 void vnote_serialize_output_field(char *append_to, char *field, char *label);
 422
 423
 424 #endif  // LIBCITADEL_H