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