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