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