libcitadel/lib/libcitadel.h

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