libcitadel/lib/libcitadel.h

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