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