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