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