libcitadel/lib/libcitadel.h

   1 /*
   2  * Header file for libcitadel
   3  *
   4  * Copyright (c) 1987-2013 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       829
  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 typedef enum __RoomNetCfg {
  52         subpending        = 0,
  53         unsubpending      = 1,
  54         lastsent          = 2, /* Server internal use only */
  55         ignet_push_share  = 3,
  56         listrecp          = 4,
  57         digestrecp        = 5,
  58         pop3client        = 6,
  59         rssclient         = 7,
  60         participate       = 8,
  61         roommailalias     = 9,
  62         maxRoomNetCfg
  63 } RoomNetCfg;
  64
  65 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
  66         GNET_POP3_HOST = 1,
  67         GNET_POP3_USER = 2,
  68         GNET_POP3_PASS = 4,
  69         GNET_POP3_DONT_DELETE_REMOTE = 4,
  70         GNET_POP3_INTERVAL = 5
  71 };
  72
  73 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
  74         GNET_IGNET_NODE = 1,
  75         GNET_IGNET_ROOM = 2
  76 };
  77
  78 typedef enum __GPEXWhichPolicy {
  79         roompolicy,
  80         floorpolicy,
  81         sitepolicy,
  82         mailboxespolicy,
  83         maxpolicy
  84 }GPEXWhichPolicy;
  85
  86 /*
  87  * View definitions.
  88  * Note that not all views are implemented in all clients.
  89  */
  90 typedef enum _room_views {
  91         VIEW_BBS                = 0,    /* Bulletin board view */
  92         VIEW_MAILBOX            = 1,    /* Mailbox summary */
  93         VIEW_ADDRESSBOOK        = 2,    /* Address book view */
  94         VIEW_CALENDAR           = 3,    /* Calendar view */
  95         VIEW_TASKS              = 4,    /* Tasks view */
  96         VIEW_NOTES              = 5,    /* Notes view */
  97         VIEW_WIKI               = 6,    /* Wiki view */
  98         VIEW_CALBRIEF           = 7,    /* Brief Calendar view */
  99         VIEW_JOURNAL            = 8,    /* Journal view */
 100         VIEW_DRAFTS             = 9,    /* Drafts view */
 101         VIEW_BLOG               = 10,   /* Blog view */
 102         VIEW_QUEUE              = 11,   /* SMTP/... QUEUE rooms */
 103         VIEW_WIKIMD             = 12,   /* Markdown Wiki view */
 104         VIEW_MAX,
 105         VIEW_JSON_LIST,
 106 } ROOM_VIEWS;
 107
 108 #define BLOG_EUIDBUF_SIZE       40
 109
 110 #ifndef IsEmptyStr
 111 #define IsEmptyStr(a) ((a)[0] == '\0')
 112 #endif
 113
 114
 115 /*
 116  * another word to indicate n/a for a pointer if NULL already has a "meaning"
 117  */
 118 extern const char *StrBufNOTNULL;
 119
 120 /*
 121  * Misc declarations
 122  */
 123
 124 char *libcitadel_version_string(void);
 125 int libcitadel_version_number(void);
 126 void StartLibCitadel(size_t basesize);
 127 void ShutDownLibCitadel(void);
 128
 129 /*
 130  * MIME parser declarations
 131  */
 132
 133 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
 134
 135
 136 typedef void (*MimeParserCallBackType)(char *cbname,
 137                                        char *cbfilename,
 138                                        char *cbpartnum,
 139                                        char *cbdisp,
 140                                        void *cbcontent,
 141                                        char *cbtype,
 142                                        char *cbcharset,
 143                                        size_t cblength,
 144                                        char *cbencoding,
 145                                        char *cbid,
 146                                        void *cbuserdata);
 147
 148 void mime_parser(char *content_start, char *content_end,
 149                  MimeParserCallBackType CallBack,
 150                  MimeParserCallBackType PreMultiPartCallBack,
 151                  MimeParserCallBackType PostMultiPartCallBack,
 152                  void *userdata,
 153                  int dont_decode);
 154
 155
 156
 157 char *fixed_partnum(char *);
 158 void mime_decode(char *partnum,
 159                  char *part_start, size_t length,
 160                  char *content_type, char *charset, char *encoding,
 161                  char *disposition,
 162                  char *id,
 163                  char *name, char *filename,
 164                  MimeParserCallBackType CallBack,
 165                  MimeParserCallBackType PreMultiPartCallBack,
 166                  MimeParserCallBackType PostMultiPartCallBack,
 167                  void *userdata,
 168                  int dont_decode);
 169 int mime_decode_now (char *part_start,
 170                      size_t length,
 171                      char *encoding,
 172                      char **decoded,
 173                      size_t *bytes_decoded);
 174 void the_mime_parser(char *partnum,
 175                      char *content_start, char *content_end,
 176                      MimeParserCallBackType CallBack,
 177                      MimeParserCallBackType PreMultiPartCallBack,
 178                      MimeParserCallBackType PostMultiPartCallBack,
 179                      void *userdata,
 180                      int dont_decode);
 181
 182 typedef struct StrBuf StrBuf;
 183
 184 #define strof(a) #a
 185 #define CStrOf(a) #a, sizeof(#a) - 1
 186 typedef struct _ConstStr {
 187         const char *Key;
 188         long len;
 189 }ConstStr;
 190 #define CKEY(a) (a).Key, (a).len
 191
 192 StrBuf* NewStrBuf(void);
 193 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
 194 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
 195 long StrBufShrinkToFit(StrBuf *Buf, int Force);
 196 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
 197 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
 198
 199 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
 200 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
 201 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
 202 void FreeStrBuf (StrBuf **FreeMe);
 203 char *SmashStrBuf (StrBuf **SmashMe);
 204 void HFreeStrBuf (void *VFreeMe);
 205 int FlushStrBuf(StrBuf *buf);
 206 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
 207
 208 const char *ChrPtr(const StrBuf *Str);
 209 int StrLength(const StrBuf *Str);
 210 #define SKEY(a) ChrPtr(a), StrLength(a)
 211 void StrBufAsciify(StrBuf *Buf, const char repl);
 212 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
 213 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
 214
 215 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
 216 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
 217 #define NNN_TERM 1
 218 #define O_TERM 0
 219 int StrBufReadBLOBBuffered(StrBuf *Buf,
 220                            StrBuf *IOBuf,
 221                            const char **BufPos,
 222                            int *fd,
 223                            int append,
 224                            long nBytes,
 225                            int check,
 226                            const char **Error);
 227 int StrBufTCP_read_buffered_line(StrBuf *Line,
 228                                  StrBuf *buf,
 229                                  int *fd,
 230                                  int timeout,
 231                                  int selectresolution,
 232                                  const char **Error);
 233 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
 234                                       StrBuf *buf,
 235                                       const char **Pos,
 236                                       int *fd,
 237                                       int timeout,
 238                                       int selectresolution,
 239                                       const char **Error);
 240
 241 typedef enum _eReadState {
 242         eReadFail,
 243         eReadSuccess,
 244         eMustReadMore,
 245         eBufferNotEmpty
 246 } eReadState;
 247
 248 typedef struct _file_buffer {
 249         StrBuf *Buf;
 250         const char *ReadWritePointer;
 251         int fd;
 252         int LineCompleted;
 253         int nBlobBytesWanted;
 254 } IOBuffer;
 255
 256
 257 typedef struct __fd_iobuffer {
 258         IOBuffer *IOB;
 259         int OtherFD;
 260         int SplicePipe[2];
 261         int PipeSize;
 262         long TotalSendSize;
 263         loff_t TotalSentAlready;
 264         loff_t TotalReadAlready;
 265         long ChunkSize;
 266         long ChunkSendRemain;
 267         StrBuf *ChunkBuffer; /* just used if we don't have sendfile */
 268 } FDIOBuffer;
 269
 270
 271 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize);
 272 void FDIOBufferDelete(FDIOBuffer *FDB);
 273 int FileSendChunked(FDIOBuffer *FDB, const char **Err);
 274 int FileRecvChunked(FDIOBuffer *FDB, const char **Err);
 275 int FileMoveChunked(FDIOBuffer *FDB, const char **Err);
 276 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error);
 277
 278 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
 279 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
 280
 281 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
 282 eReadState StrBufCheckBuffer(IOBuffer *FB);
 283 long IOBufferStrLength(IOBuffer *FB);
 284
 285 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
 286 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
 287 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
 288 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
 289 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
 290
 291 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
 292 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
 293 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
 294 int StrBufNum_tokens(const StrBuf *source, char tok);
 295 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
 296
 297 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
 298 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
 299 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
 300 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
 301 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
 302 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
 303
 304
 305 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
 306 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
 307 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
 308 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
 309 #ifdef SHOW_ME_VAPPEND_PRINTF
 310 /* so owe don't create an include depndency, this is just visible on demand. */
 311 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
 312 #endif
 313 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
 314 void StrBufCutLeft(StrBuf *Buf, int nChars);
 315 void StrBufCutRight(StrBuf *Buf, int nChars);
 316 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
 317 void StrBufTrim(StrBuf *Buf);
 318 void StrBufSpaceToBlank(StrBuf *Buf);
 319 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
 320 void StrBufUpCase(StrBuf *Buf);
 321 void StrBufLowerCase(StrBuf *Buf);
 322 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
 323 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
 324 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
 325
 326 void StrBufToUnixLF(StrBuf *buf);
 327 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
 328
 329 int CompressBuffer(StrBuf *Buf);
 330 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
 331 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
 332 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
 333                           const StrBuf *DecodeMe,
 334                           const StrBuf* DefaultCharset,
 335                           StrBuf *FoundCharset,
 336                           StrBuf *ConvertBuf,
 337                           StrBuf *ConvertBuf2);
 338 /* deprecated old version: */
 339 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
 340
 341 typedef enum __eStreamType {
 342         eBase64Encode,
 343         eBase64Decode,
 344         eZLibEncode,
 345         eZLibDecode,
 346         eEmtyCodec
 347 } eStreamType;
 348
 349 void *StrBufNewStreamContext(eStreamType type);
 350 void StrBufDestroyStreamContext(eStreamType type, void **Stream);
 351 void StrBufStreamTranscode(eStreamType type, IOBuffer *Target, IOBuffer *In, const char* pIn, long pInLen, void *Stream, int LastChunk);
 352
 353 int StrBufDecodeBase64(StrBuf *Buf);
 354 int StrBufDecodeBase64To(const StrBuf *BufIn, StrBuf *BufOut);
 355 int StrBufDecodeHex(StrBuf *Buf);
 356 StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe);
 357 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
 358 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
 359                                            StrBuf *UserName,
 360                                            StrBuf *EmailAddress,
 361                                            StrBuf *EncBuf);
 362 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
 363 #define LB                      (1)             /* Internal escape chars */
 364 #define RB                      (2)
 365 #define QU                      (3)
 366 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
 367 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
 368 void StrBufXMLEscAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int OverrideLowChars);
 369 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
 370 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
 371 void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks);
 372 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
 373 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 374 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
 375 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 376 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 377
 378 long StrTol(const StrBuf *Buf);
 379 int StrToi(const StrBuf *Buf);
 380 int StrBufIsNumber(const StrBuf *Buf);
 381 long StrBuf_Utf8StrLen(StrBuf *Buf);
 382 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
 383
 384 const char *GuessMimeType(const char *data, size_t dlen);
 385 const char* GuessMimeByFilename(const char *what, size_t len);
 386
 387 /* Run once at Programstart */
 388 int LoadIconDir(const char *DirName);
 389
 390 /* Select the icon for a given MIME type */
 391 const char *GetIconFilename(char *MimeType, size_t len);
 392
 393
 394 /* URL parsing & connection data */
 395 typedef struct ParsedURL ParsedURL;
 396 struct ParsedURL {
 397         int Priority;
 398         StrBuf *URL;
 399         StrBuf *UrlWithoutCred;
 400         StrBuf *CurlCreds;
 401         unsigned Port;
 402         const char *Host;
 403         const char *User;
 404         const char *Pass;
 405         const char *LocalPart;
 406         const char *PlainUrl;
 407         int IsIP;
 408         int IPv6;
 409         int af;
 410         struct hostent *HEnt;
 411         struct sockaddr_in6 Addr;
 412         ParsedURL *Next;
 413         int IsRelay;
 414         StrBuf *UsrName;
 415         StrBuf *Password;
 416 };
 417
 418 void FreeURL(ParsedURL** Url);
 419 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
 420 void CurlPrepareURL(ParsedURL *Url);
 421
 422 /* tools */
 423
 424
 425 int safestrncpy(char *dest, const char *src, size_t n);
 426 int num_tokens (const char *source, char tok);
 427 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 428 long grab_token(char **dest, const char *source, int parmnum, char separator);
 429 int extract_int (const char *source, int parmnum);
 430 long extract_long (const char *source, int parmnum);
 431 unsigned long extract_unsigned_long(const char *source, int parmnum);
 432 void CtdlInitBase64Table(void);
 433 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
 434 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
 435 unsigned int decode_hex(char *Source);
 436 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 437 void StripSlashes(char *Dir, int TrailingSlash);
 438 size_t striplt(char *);
 439 int haschar(const char *st, int ch);
 440 void remove_token(char *source, int parmnum, char separator);
 441 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
 442 int is_msg_in_sequence_set(const char *mset, long msgnum);
 443 char *memreadline(char *start, char *buf, int maxlen);
 444 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
 445 const char *cmemreadline(const char *start, char *buf, int maxlen);
 446 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
 447 #define IsEmptyStr(a) ((a)[0] == '\0')
 448 #define num_parms(source)               num_tokens(source,(char)'|')
 449 int stripout(char *str, char leftboundary, char rightboundary);
 450 long stripallbut(char *str, char leftboundary, char rightboundary);
 451 char *myfgets(char *s, int size, FILE *stream);
 452 void urlesc(char *outbuf, size_t oblen, char *strbuf);
 453 char *CtdlTempFileName(char *prefix1, int prefix2);
 454 FILE *CtdlTempFile(void);
 455 void generate_uuid(char *buf);
 456 char *bmstrcasestr(char *text, const char *pattern);
 457 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
 458 const char *cbmstrcasestr(const char *text, const char *pattern);
 459 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
 460 void CtdlMakeTempFileName(char *name, int len);
 461 char *rfc2047encode(const char *line, long length);
 462 int is_msg_in_mset(const char *mset, long msgnum);
 463 int pattern2(char *search, char *patn);
 464 void stripltlen(char *, int *);
 465 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
 466 void LoadEntityList(char *FileName);
 467
 468
 469
 470 /* vCard stuff */
 471
 472 #define CTDL_VCARD_MAGIC        0xa1f9
 473
 474 /* This data structure represents a vCard object currently in memory. */
 475 struct vCard {
 476         int magic;
 477         int numprops;
 478         struct vCardProp {
 479                 char *name;
 480                 char *value;
 481         } *prop;
 482 };
 483
 484
 485 struct vCard *vcard_new(void);
 486 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
 487 struct vCard *vcard_load(char *vtext);
 488 struct vCard *VCardLoad(StrBuf *vbtext);
 489
 490 void vcard_free(struct vCard *);
 491 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
 492 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
 493                         int instance, int return_propname);
 494 char *vcard_serialize(struct vCard *);
 495 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
 496 void remove_charset_attribute(char *strbuf);
 497 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
 498
 499 /*
 500  * Hash list implementation for Citadel
 501  */
 502 #define HKEY(a) a, (sizeof(a) - 1)
 503
 504 typedef struct HashList HashList;
 505
 506 typedef struct HashKey HashKey;
 507
 508 typedef struct HashPos HashPos;
 509
 510 typedef void (*DeleteHashDataFunc)(void * Data);
 511 typedef const char *(*PrintHashContent)(void * Data);
 512 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
 513 typedef long (*HashFunc)(const char *Str, long Len);
 514 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
 515 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
 516
 517 long Flathash(const char *str, long len);
 518 long lFlathash(const char *str, long len);
 519 #define IKEY(a) (const char*) &a, sizeof(a)
 520 #define LKEY(a) (const char*) &a, sizeof(a)
 521
 522 int TestValidateHash(HashList *TestHash);
 523
 524 HashList *NewHash(int Uniq, HashFunc F);
 525 void DeleteHash(HashList **Hash);
 526 void DeleteHashContent(HashList **Hash);
 527 void HDeleteHash(void *vHash);
 528 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
 529 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
 530 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
 531 int GetHashKeys(HashList *Hash, char ***List);
 532 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
 533 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
 534 HashPos *GetNewHashPos(const HashList *Hash, int StepWidth);
 535 void RewindHashPos(const HashList *Hash, HashPos *it, int StepWidth);
 536 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
 537 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
 538 int GetHashPosCounter(HashList *Hash, HashPos *At);
 539 void DeleteHashPos(HashPos **DelMe);
 540 int NextHashPos(HashList *Hash, HashPos *At);
 541 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
 542 int GetNextHashPos(const HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
 543 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
 544 void SortByHashKey(HashList *Hash, int Order);
 545 void SortByHashKeyStr(HashList *Hash);
 546 int GetCount(HashList *Hash);
 547 const void *GetSearchPayload(const void *HashVoid);
 548 void SortByPayload(HashList *Hash, CompareFunc SortBy);
 549 void reference_free_handler(void *ptr);
 550 int HashLittle(const void *key, size_t length);
 551
 552 typedef struct MSet MSet;
 553 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
 554 int IsInMSetList(MSet *MSetList, long MsgNo);
 555 void DeleteMSet(MSet **FreeMe);
 556
 557 void convert_spaces_to_underscores(char *str);
 558 int CheckEncode(const char *pch, long len, const char *pche);
 559
 560 /*
 561  * Convert 4 bytes char into an Integer.
 562  * usefull for easy inexpensive hashing
 563  * of for char strings.
 564  */
 565 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
 566
 567 /* vNote implementation */
 568
 569 #define CTDL_VNOTE_MAGIC        0xa1fa
 570
 571 struct vnote {
 572         int magic;
 573         char *uid;
 574         char *summary;
 575         char *body;
 576         int pos_left;
 577         int pos_top;
 578         int pos_width;
 579         int pos_height;
 580         int color_red;
 581         int color_green;
 582         int color_blue;
 583 };
 584
 585
 586
 587 struct vnote *vnote_new(void);
 588 struct vnote *vnote_new_from_str(char *s);
 589 void vnote_free(struct vnote *v);
 590 char *vnote_serialize(struct vnote *v);
 591 void vnote_serialize_output_field(char *append_to, char *field, char *label);
 592
 593
 594
 595
 596 /*
 597  * Create JSON style structures in C plus serialize them to one string
 598  */
 599
 600 typedef struct JsonValue JsonValue;
 601
 602
 603 void DeleteJSONValue(void *vJsonValue);
 604
 605 JsonValue *NewJsonObject(const char *Key, long keylen);
 606
 607 JsonValue *NewJsonArray(const char *Key, long keylen);
 608
 609 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
 610
 611 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
 612
 613 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
 614
 615 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
 616
 617 JsonValue *NewJsonNull(const char *Key, long keylen);
 618
 619 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
 620
 621 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
 622
 623 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
 624
 625 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
 626
 627
 628
 629 /*
 630  * Citadels Wildfire implementation, see
 631  * http://www.firephp.org/Wiki/Reference/Protocol
 632  * and http://wildfirehq.org/ for details
 633  */
 634 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
 635
 636 typedef enum _WF_MessageType {
 637         eLOG,
 638         eINFO,
 639         eWARN,
 640         eERROR,
 641         eTRACE,
 642         eEXCEPTION
 643 } WF_MessageType;
 644
 645 JsonValue *WildFireException(const char *Filename, long FileLen,
 646                              long LineNo,
 647                              StrBuf *Message,
 648                              int StackOffset);
 649
 650 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
 651
 652 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
 653                                    long LineNo,
 654                                    const char *Message, long len,
 655                                    WF_MessageType Type);
 656
 657 JsonValue *WildFireMessage(const char *Filename, long fnlen,
 658                            long lineno,
 659                            StrBuf *Msg,
 660                            WF_MessageType Type);
 661
 662 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
 663
 664 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
 665
 666 #define WF_MAJOR "1"
 667 #define WF_STRUCTINDEX "1"
 668 #define WF_SUB "1"
 669
 670 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
 671
 672 /* Convenience function to "perform a function and cut a log record if result != 0" */
 673 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
 674
 675 /* a nice consistent place to define how we turn a message id into a thread id hash */
 676 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
 677
 678 #ifdef __cplusplus
 679 extern "C" {
 680 #endif
 681
 682 #define CFG_SMTP_FROM_FILTERALL 0
 683 #define CFG_SMTP_FROM_NOFILTER 1
 684 #define CFG_SMTP_FROM_CORRECT 2
 685 #define CFG_SMTP_FROM_REJECT 3
 686 /*
 687  * MIME types used in Citadel for configuration stuff
 688  */
 689 #define SPOOLMIME       "application/x-citadel-delivery-list"
 690 #define INTERNETCFG     "application/x-citadel-internet-config"
 691 #define IGNETCFG        "application/x-citadel-ignet-config"
 692 #define IGNETMAP        "application/x-citadel-ignet-map"
 693 #define FILTERLIST      "application/x-citadel-filter-list"
 694 #define SIEVECONFIG     "application/x-citadel-sieve-config"
 695 #define XMPPMORTUARY    "application/x-citadel-xmpp-mortuary"
 696 #define INTERNETCFG     "application/x-citadel-internet-config"
 697
 698 #define FILE_MAILALIAS       "__MAIL_ALIAS__"
 699
 700 #define LISTING_FOLLOWS         100
 701 #define CIT_OK                  200
 702 #define MORE_DATA               300
 703 #define SEND_LISTING            400
 704 #define ERROR                   500
 705 #define BINARY_FOLLOWS          600
 706 #define SEND_BINARY             700
 707 #define START_CHAT_MODE         800
 708
 709 #define INTERNAL_ERROR          10
 710 #define TOO_BIG                 11
 711 #define ILLEGAL_VALUE           12
 712 #define NOT_LOGGED_IN           20
 713 #define CMD_NOT_SUPPORTED       30
 714 #define SERVER_SHUTTING_DOWN    31
 715 #define PASSWORD_REQUIRED       40
 716 #define ALREADY_LOGGED_IN       41
 717 #define USERNAME_REQUIRED       42
 718 #define HIGHER_ACCESS_REQUIRED  50
 719 #define MAX_SESSIONS_EXCEEDED   51
 720 #define RESOURCE_BUSY           52
 721 #define RESOURCE_NOT_OPEN       53
 722 #define NOT_HERE                60
 723 #define INVALID_FLOOR_OPERATION 61
 724 #define NO_SUCH_USER            70
 725 #define FILE_NOT_FOUND          71
 726 #define ROOM_NOT_FOUND          72
 727 #define NO_SUCH_SYSTEM          73
 728 #define ALREADY_EXISTS          74
 729 #define MESSAGE_NOT_FOUND       75
 730
 731 #define ASYNC_MSG               900
 732 #define ASYNC_GEXP              02
 733
 734 #define QR_PERMANENT    1               /* Room does not purge              */
 735 #define QR_INUSE        2               /* Set if in use, clear if avail    */
 736 #define QR_PRIVATE      4               /* Set for any type of private room */
 737 #define QR_PASSWORDED   8               /* Set if there's a password too    */
 738 #define QR_GUESSNAME    16              /* Set if it's a guessname room     */
 739 #define QR_DIRECTORY    32              /* Directory room                   */
 740 #define QR_UPLOAD       64              /* Allowed to upload                */
 741 #define QR_DOWNLOAD     128             /* Allowed to download              */
 742 #define QR_VISDIR       256             /* Visible directory                */
 743 #define QR_ANONONLY     512             /* Anonymous-Only room              */
 744 #define QR_ANONOPT      1024            /* Anonymous-Option room            */
 745 #define QR_NETWORK      2048            /* Shared network room              */
 746 #define QR_PREFONLY     4096            /* Preferred status needed to enter */
 747 #define QR_READONLY     8192            /* Admin status required to post     */
 748 #define QR_MAILBOX      16384           /* Set if this is a private mailbox */
 749
 750 #define QR2_SYSTEM      1               /* System room; hide by default     */
 751 #define QR2_SELFLIST    2               /* Self-service mailing list mgmt   */
 752 #define QR2_COLLABDEL   4               /* Anyone who can post can delete   */
 753 #define QR2_SUBJECTREQ  8               /* Subject strongly recommended */
 754 #define QR2_SMTP_PUBLIC 16              /* Listservice Subscribers may post */
 755 #define QR2_MODERATED   32              /* Listservice aide has to permit posts  */
 756
 757 #define US_NEEDVALID    1               /* User needs to be validated       */
 758 #define US_EXTEDIT      2               /* Always use external editor       */
 759 #define US_PERM         4               /* Permanent user                   */
 760 #define US_LASTOLD      16              /* Print last old message with new  */
 761 #define US_EXPERT       32              /* Experienced user                 */
 762 #define US_UNLISTED     64              /* Unlisted userlog entry           */
 763 #define US_NOPROMPT     128             /* Don't prompt after each message  */
 764 #define US_PROMPTCTL    256             /* <N>ext & <S>top work at prompt   */
 765 #define US_DISAPPEAR    512             /* Use "disappearing msg prompts"   */
 766 #define US_REGIS        1024            /* Registered user                  */
 767 #define US_PAGINATOR    2048            /* Pause after each screen of text  */
 768 #define US_INTERNET     4096            /* Internet mail privileges         */
 769 #define US_FLOORS       8192            /* User wants to see floors         */
 770 #define US_COLOR        16384           /* User wants ANSI color support    */
 771 #define US_USER_SET     (US_LASTOLD | US_EXPERT | US_UNLISTED | \
 772                         US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
 773                         US_FLOORS | US_COLOR | US_PROMPTCTL | US_EXTEDIT)
 774
 775 #define UA_KNOWN                2       /* Room appears in a 'known rooms' list */
 776 #define UA_GOTOALLOWED          4       /* User may goto this room if specified by exact name */
 777 #define UA_HASNEWMSGS           8       /* Unread messages exist in this room */
 778 #define UA_ZAPPED               16      /* User has forgotten (zapped) this room */
 779 #define UA_POSTALLOWED          32      /* User may post top-level messages here */
 780 #define UA_ADMINALLOWED         64      /* Admin or Room Admin rights exist here */
 781 #define UA_DELETEALLOWED        128     /* User is allowed to delete messages from this room */
 782 #define UA_REPLYALLOWED         256     /* User is allowed to reply to existing messages here */
 783 /* runtime flag extracted from goto reply; not db persistant, should be moved if new flags added */
 784 #define UA_ISTRASH              512     /* Only available in room view... */
 785
 786 #ifdef __cplusplus
 787 }
 788 #endif
 789
 790 #endif  // LIBCITADEL_H