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