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