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       770
  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 #define strof(a) #a
  28
  29 /* Logging levels - correspond to syslog(3) */
  30 enum LogLevel {
  31         /* When about to exit the server for an unrecoverable error */
  32          CTDL_EMERG,    /* system is unusable */
  33         /* Manual intervention is required to avoid an abnormal exit */
  34          CTDL_ALERT,    /* action must be taken immediately */
  35         /* The server can continue to run with degraded functionality */
  36          CTDL_CRIT,     /* critical conditions */
  37         /* An error occurs but the server continues to run normally */
  38          CTDL_ERR,      /* error conditions */
  39         /* An abnormal condition was detected; server will continue normally */
  40          CTDL_WARNING,  /* warning conditions */
  41         /* Normal messages (login/out, activity, etc.) */
  42          CTDL_NOTICE,   /* normal but significant condition */
  43         /* Unimportant progress messages, etc. */
  44          CTDL_INFO,     /* informational */
  45         /* Debugging messages */
  46          CTDL_DEBUG     /* debug-level messages */
  47 };
  48
  49 typedef enum AXLevel {
  50         AxDeleted = 0,
  51         AxNewU = 1,
  52         AxProbU = 2,
  53         AxLocU = 3,
  54         AxNetU = 4,
  55         AxPrefU = 5,
  56         AxAideU = 6
  57 }eUsrAxlvl;
  58
  59 enum RoomNetCfg {
  60         subpending,
  61         unsubpending,
  62         lastsent, /* Server internal use only */
  63         ignet_push_share,
  64         listrecp,
  65         digestrecp,
  66         pop3client,
  67         rssclient,
  68         participate,
  69         maxRoomNetCfg
  70 };
  71
  72
  73 typedef enum __GPEXWhichPolicy {
  74         roompolicy,
  75         floorpolicy,
  76         sitepolicy,
  77         mailboxespolicy
  78 }GPEXWhichPolicy;
  79
  80 /*
  81  * View definitions.
  82  * Note that not all views are implemented in all clients.
  83  */
  84 #define VIEW_BBS                0       /* Bulletin board view */
  85 #define VIEW_MAILBOX            1       /* Mailbox summary */
  86 #define VIEW_ADDRESSBOOK        2       /* Address book view */
  87 #define VIEW_CALENDAR           3       /* Calendar view */
  88 #define VIEW_TASKS              4       /* Tasks view */
  89 #define VIEW_NOTES              5       /* Notes view */
  90 #define VIEW_WIKI               6       /* Wiki view */
  91 #define VIEW_CALBRIEF           7       /* Brief Calendar view */
  92 #define VIEW_JOURNAL            8       /* Journal view */
  93 #define VIEW_BLOG               9       /* Blog view (not yet implemented) */
  94
  95
  96 #ifndef IsEmptyStr
  97 #define IsEmptyStr(a) ((a)[0] == '\0')
  98 #endif
  99
 100 /*
 101  * another word to indicate n/a for a pointer if NULL already has a "meaning"
 102  */
 103 extern const char *StrBufNOTNULL;
 104
 105 /*
 106  * Misc declarations
 107  */
 108
 109 char *libcitadel_version_string(void);
 110 int libcitadel_version_number(void);
 111 void StartLibCitadel(size_t basesize);
 112 void ShutDownLibCitadel(void);
 113
 114 /*
 115  * MIME parser declarations
 116  */
 117
 118 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
 119
 120 void mime_parser(char *content_start, char *content_end,
 121                 void (*CallBack)
 122                         (char *cbname,
 123                         char *cbfilename,
 124                         char *cbpartnum,
 125                         char *cbdisp,
 126                         void *cbcontent,
 127                         char *cbtype,
 128                         char *cbcharset,
 129                         size_t cblength,
 130                         char *cbencoding,
 131                         char *cbid,
 132                         void *cbuserdata),
 133                 void (*PreMultiPartCallBack)
 134                         (char *cbname,
 135                         char *cbfilename,
 136                         char *cbpartnum,
 137                         char *cbdisp,
 138                         void *cbcontent,
 139                         char *cbtype,
 140                         char *cbcharset,
 141                         size_t cblength,
 142                         char *cbencoding,
 143                         char *cbid,
 144                         void *cbuserdata),
 145                 void (*PostMultiPartCallBack)
 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                         char *cbid,
 156                         void *cbuserdata),
 157                 void *userdata,
 158                 int dont_decode
 159 );
 160
 161
 162
 163 char *fixed_partnum(char *);
 164 void mime_decode(char *partnum,
 165                  char *part_start, size_t length,
 166                  char *content_type, char *charset, char *encoding,
 167                  char *disposition,
 168                  char *id,
 169                  char *name, char *filename,
 170                  void (*CallBack)
 171                   (char *cbname,
 172                    char *cbfilename,
 173                    char *cbpartnum,
 174                    char *cbdisp,
 175                    void *cbcontent,
 176                    char *cbtype,
 177                    char *cbcharset,
 178                    size_t cblength,
 179                    char *cbencoding,
 180                    char *cbid,
 181                    void *cbuserdata),
 182                  void (*PreMultiPartCallBack)
 183                   (char *cbname,
 184                    char *cbfilename,
 185                    char *cbpartnum,
 186                    char *cbdisp,
 187                    void *cbcontent,
 188                    char *cbtype,
 189                    char *cbcharset,
 190                    size_t cblength,
 191                    char *cbencoding,
 192                    char *cbid,
 193                    void *cbuserdata),
 194                  void (*PostMultiPartCallBack)
 195                   (char *cbname,
 196                    char *cbfilename,
 197                    char *cbpartnum,
 198                    char *cbdisp,
 199                    void *cbcontent,
 200                    char *cbtype,
 201                    char *cbcharset,
 202                    size_t cblength,
 203                    char *cbencoding,
 204                    char *cbid,
 205                    void *cbuserdata),
 206                   void *userdata,
 207                   int dont_decode
 208 );
 209 void the_mime_parser(char *partnum,
 210                      char *content_start, char *content_end,
 211                      void (*CallBack)
 212                       (char *cbname,
 213                        char *cbfilename,
 214                        char *cbpartnum,
 215                        char *cbdisp,
 216                        void *cbcontent,
 217                        char *cbtype,
 218                        char *cbcharset,
 219                        size_t cblength,
 220                        char *cbencoding,
 221                        char *cbid,
 222                        void *cbuserdata),
 223                      void (*PreMultiPartCallBack)
 224                       (char *cbname,
 225                        char *cbfilename,
 226                        char *cbpartnum,
 227                        char *cbdisp,
 228                        void *cbcontent,
 229                        char *cbtype,
 230                        char *cbcharset,
 231                        size_t cblength,
 232                        char *cbencoding,
 233                        char *cbid,
 234                        void *cbuserdata),
 235                      void (*PostMultiPartCallBack)
 236                       (char *cbname,
 237                        char *cbfilename,
 238                        char *cbpartnum,
 239                        char *cbdisp,
 240                        void *cbcontent,
 241                        char *cbtype,
 242                        char *cbcharset,
 243                        size_t cblength,
 244                        char *cbencoding,
 245                        char *cbid,
 246                        void *cbuserdata),
 247                       void *userdata,
 248                       int dont_decode
 249 );
 250
 251 typedef struct StrBuf StrBuf;
 252
 253 typedef struct _ConstStr {
 254         const char *Key;
 255         long len;
 256 }ConstStr;
 257 #define CKEY(a) (a).Key, (a).len
 258
 259 StrBuf* NewStrBuf(void);
 260 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
 261 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
 262 long StrBufShrinkToFit(StrBuf *Buf, int Force);
 263 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
 264
 265 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
 266 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
 267 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
 268 void FreeStrBuf (StrBuf **FreeMe);
 269 char *SmashStrBuf (StrBuf **SmashMe);
 270 void HFreeStrBuf (void *VFreeMe);
 271 int FlushStrBuf(StrBuf *buf);
 272 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
 273
 274 const char *ChrPtr(const StrBuf *Str);
 275 int StrLength(const StrBuf *Str);
 276 #define SKEY(a) ChrPtr(a), StrLength(a)
 277 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
 278
 279 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
 280 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
 281 #define NNN_TERM 1
 282 #define O_TERM 0
 283 int StrBufReadBLOBBuffered(StrBuf *Buf,
 284                            StrBuf *IOBuf,
 285                            const char **BufPos,
 286                            int *fd,
 287                            int append,
 288                            long nBytes,
 289                            int check,
 290                            const char **Error);
 291 int StrBufTCP_read_buffered_line(StrBuf *Line,
 292                                  StrBuf *buf,
 293                                  int *fd,
 294                                  int timeout,
 295                                  int selectresolution,
 296                                  const char **Error);
 297 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
 298                                       StrBuf *buf,
 299                                       const char **Pos,
 300                                       int *fd,
 301                                       int timeout,
 302                                       int selectresolution,
 303                                       const char **Error);
 304
 305 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
 306 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
 307 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
 308
 309 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
 310 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
 311 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
 312 int StrBufNum_tokens(const StrBuf *source, char tok);
 313 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
 314
 315 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
 316 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
 317 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
 318 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
 319 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
 320 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
 321
 322
 323 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
 324 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
 325 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
 326 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
 327 #ifdef SHOW_ME_VAPPEND_PRINTF
 328 /* so owe don't create an include depndency, this is just visible on demand. */
 329 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
 330 #endif
 331 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
 332 void StrBufCutLeft(StrBuf *Buf, int nChars);
 333 void StrBufCutRight(StrBuf *Buf, int nChars);
 334 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
 335 void StrBufTrim(StrBuf *Buf);
 336 void StrBufUpCase(StrBuf *Buf);
 337 void StrBufLowerCase(StrBuf *Buf);
 338 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
 339 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
 340 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
 341
 342 void StrBufToUnixLF(StrBuf *buf);
 343 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
 344
 345 int CompressBuffer(StrBuf *Buf);
 346 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
 347 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
 348 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
 349 int StrBufDecodeBase64(StrBuf *Buf);
 350 int StrBufDecodeHex(StrBuf *Buf);
 351 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
 352 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
 353 #define LB                      (1)             /* Internal escape chars */
 354 #define RB                      (2)
 355 #define QU                      (3)
 356 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
 357 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
 358 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
 359 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 360 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
 361 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 362 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 363
 364 long StrTol(const StrBuf *Buf);
 365 int StrToi(const StrBuf *Buf);
 366 int StrBufIsNumber(const StrBuf *Buf);
 367 long StrBuf_Utf8StrLen(StrBuf *Buf);
 368 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
 369
 370 const char *GuessMimeType(const char *data, size_t dlen);
 371 const char* GuessMimeByFilename(const char *what, size_t len);
 372
 373 /* Run once at Programstart */
 374 int LoadIconDir(const char *DirName);
 375
 376 /* Select the icon for a given MIME type */
 377 const char *GetIconFilename(char *MimeType, size_t len);
 378
 379
 380 /* tools */
 381
 382
 383 int safestrncpy(char *dest, const char *src, size_t n);
 384 int num_tokens (const char *source, char tok);
 385 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 386 long grab_token(char **dest, const char *source, int parmnum, char separator);
 387 int extract_int (const char *source, int parmnum);
 388 long extract_long (const char *source, int parmnum);
 389 unsigned long extract_unsigned_long(const char *source, int parmnum);
 390 void CtdlInitBase64Table(void);
 391 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
 392 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
 393 unsigned int decode_hex(char *Source);
 394 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 395 void StripSlashes(char *Dir, int TrailingSlash);
 396 size_t striplt(char *);
 397 int haschar(const char *st, int ch);
 398 void remove_token(char *source, int parmnum, char separator);
 399 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
 400 int is_msg_in_sequence_set(const char *mset, long msgnum);
 401 const char *memreadline(const char *start, char *buf, int maxlen);
 402 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
 403 #define IsEmptyStr(a) ((a)[0] == '\0')
 404 #define num_parms(source)               num_tokens(source,(char)'|')
 405 int stripout(char *str, char leftboundary, char rightboundary);
 406 void stripallbut(char *str, char leftboundary, char rightboundary);
 407 char *myfgets(char *s, int size, FILE *stream);
 408 void urlesc(char *outbuf, size_t oblen, char *strbuf);
 409 char *CtdlTempFileName(char *prefix1, int prefix2);
 410 FILE *CtdlTempFile(void);
 411 void generate_uuid(char *buf);
 412 const char *bmstrcasestr(const char *text, const char *pattern);
 413 const char *bmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
 414 void CtdlMakeTempFileName(char *name, int len);
 415 char *rfc2047encode(char *line, long length);
 416 int is_msg_in_mset(const char *mset, long msgnum);
 417 int pattern2(char *search, char *patn);
 418 void stripltlen(char *, int *);
 419 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
 420 void LoadEntityList(char *FileName);
 421
 422
 423
 424 /* vCard stuff */
 425
 426 #define CTDL_VCARD_MAGIC        0xa1f9
 427
 428 /* This data structure represents a vCard object currently in memory. */
 429 struct vCard {
 430         int magic;
 431         int numprops;
 432         struct vCardProp {
 433                 char *name;
 434                 char *value;
 435         } *prop;
 436 };
 437
 438
 439 struct vCard *vcard_new(void);
 440 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
 441 struct vCard *vcard_load(char *vtext);
 442 struct vCard *VCardLoad(StrBuf *vbtext);
 443
 444 void vcard_free(struct vCard *);
 445 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
 446 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
 447                         int instance, int return_propname);
 448 char *vcard_serialize(struct vCard *);
 449 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
 450 void remove_charset_attribute(char *strbuf);
 451 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
 452
 453 /*
 454  * Hash list implementation for Citadel
 455  */
 456 #define HKEY(a) a, (sizeof(a) - 1)
 457
 458 typedef struct HashList HashList;
 459
 460 typedef struct HashKey HashKey;
 461
 462 typedef struct HashPos HashPos;
 463
 464 typedef void (*DeleteHashDataFunc)(void * Data);
 465 typedef const char *(*PrintHashContent)(void * Data);
 466 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
 467 typedef int (*HashFunc)(const char *Str, long Len);
 468 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
 469 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
 470
 471 int Flathash(const char *str, long len);
 472 #define IKEY(a) (const char*) &a, sizeof(a)
 473
 474 HashList *NewHash(int Uniq, HashFunc F);
 475 void DeleteHash(HashList **Hash);
 476 void HDeleteHash(void *vHash);
 477 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
 478 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
 479 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
 480 int GetHashKeys(HashList *Hash, char ***List);
 481 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
 482 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
 483 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
 484 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
 485 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
 486 int GetHashPosCounter(HashList *Hash, HashPos *At);
 487 void DeleteHashPos(HashPos **DelMe);
 488 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
 489 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
 490 void SortByHashKey(HashList *Hash, int Order);
 491 void SortByHashKeyStr(HashList *Hash);
 492 int GetCount(HashList *Hash);
 493 const void *GetSearchPayload(const void *HashVoid);
 494 void SortByPayload(HashList *Hash, CompareFunc SortBy);
 495 void generic_free_handler(void *ptr);
 496 void reference_free_handler(void *ptr);
 497 int HashLittle(const void *key, size_t length);
 498
 499
 500 void convert_spaces_to_underscores(char *str);
 501
 502 /*
 503  * Convert 4 bytes char into an Integer.
 504  * usefull for easy inexpensive hashing
 505  * of for char strings.
 506  */
 507 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
 508
 509 /* vNote implementation */
 510
 511 #define CTDL_VNOTE_MAGIC        0xa1fa
 512
 513 struct vnote {
 514         int magic;
 515         char *uid;
 516         char *summary;
 517         char *body;
 518         int pos_left;
 519         int pos_top;
 520         int pos_width;
 521         int pos_height;
 522         int color_red;
 523         int color_green;
 524         int color_blue;
 525 };
 526
 527
 528
 529 struct vnote *vnote_new(void);
 530 struct vnote *vnote_new_from_str(char *s);
 531 void vnote_free(struct vnote *v);
 532 char *vnote_serialize(struct vnote *v);
 533 void vnote_serialize_output_field(char *append_to, char *field, char *label);
 534
 535
 536
 537
 538 /*
 539  * Create JSON style structures in C plus serialize them to one string
 540  */
 541
 542 typedef struct JsonValue JsonValue;
 543
 544
 545 void DeleteJSONValue(void *vJsonValue);
 546
 547 JsonValue *NewJsonObject(const char *Key, long keylen);
 548
 549 JsonValue *NewJsonArray(const char *Key, long keylen);
 550
 551 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
 552
 553 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
 554
 555 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
 556
 557 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
 558
 559 JsonValue *NewJsonNull(const char *Key, long keylen);
 560
 561 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
 562
 563 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
 564
 565 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
 566
 567 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
 568
 569
 570
 571 /*
 572  * Citadels Wildfire implementation, see
 573  * http://www.firephp.org/Wiki/Reference/Protocol
 574  * and http://wildfirehq.org/ for details
 575  */
 576 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
 577
 578 typedef enum _WF_MessageType {
 579         eLOG,
 580         eINFO,
 581         eWARN,
 582         eERROR,
 583         eTRACE,
 584         eEXCEPTION
 585 } WF_MessageType;
 586
 587 JsonValue *WildFireException(const char *Filename, long FileLen,
 588                              long LineNo,
 589                              StrBuf *Message,
 590                              int StackOffset);
 591
 592 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
 593
 594 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
 595                                    long LineNo,
 596                                    const char *Message, long len,
 597                                    WF_MessageType Type);
 598
 599 JsonValue *WildFireMessage(const char *Filename, long fnlen,
 600                            long lineno,
 601                            StrBuf *Msg,
 602                            WF_MessageType Type);
 603
 604 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
 605
 606 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
 607
 608 #define WF_MAJOR "1"
 609 #define WF_STRUCTINDEX "1"
 610 #define WF_SUB "1"
 611
 612
 613 #endif  // LIBCITADEL_H