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