libcitadel/lib/libcitadel.h

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