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