libcitadel/lib/libcitadel.h

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