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