STRBUF: add wrapper to do source -> target buffer base 64 decoding
[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       829
32
33 /*
34  * Here's a bunch of stupid magic to make the MIME parser portable.
35  */
36 #ifndef SIZ
37 #define SIZ     4096
38 #endif
39
40
41 typedef enum AXLevel {
42         AxDeleted = 0,
43         AxNewU = 1,
44         AxProbU = 2,
45         AxLocU = 3,
46         AxNetU = 4,
47         AxPrefU = 5,
48         AxAideU = 6
49 }eUsrAxlvl;
50
51 typedef enum __RoomNetCfg {
52         subpending,
53         unsubpending,
54         lastsent, /* Server internal use only */
55         ignet_push_share,
56         listrecp,
57         digestrecp,
58         pop3client,
59         rssclient,
60         participate,
61         roommailalias,
62         maxRoomNetCfg
63 } RoomNetCfg;
64
65 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
66         GNET_POP3_HOST = 1,
67         GNET_POP3_USER = 2,
68         GNET_POP3_PASS = 4,
69         GNET_POP3_DONT_DELETE_REMOTE = 4,
70         GNET_POP3_INTERVAL = 5
71 };
72
73 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
74         GNET_IGNET_NODE = 1,
75         GNET_IGNET_ROOM = 2
76 };
77
78 typedef enum __GPEXWhichPolicy {
79         roompolicy,
80         floorpolicy,
81         sitepolicy,
82         mailboxespolicy,
83         maxpolicy
84 }GPEXWhichPolicy;
85
86 /*
87  * View definitions.
88  * Note that not all views are implemented in all clients.
89  */
90 typedef enum _room_views {
91         VIEW_BBS                = 0,    /* Bulletin board view */
92         VIEW_MAILBOX            = 1,    /* Mailbox summary */
93         VIEW_ADDRESSBOOK        = 2,    /* Address book view */
94         VIEW_CALENDAR           = 3,    /* Calendar view */
95         VIEW_TASKS              = 4,    /* Tasks view */
96         VIEW_NOTES              = 5,    /* Notes view */
97         VIEW_WIKI               = 6,    /* Wiki view */
98         VIEW_CALBRIEF           = 7,    /* Brief Calendar view */
99         VIEW_JOURNAL            = 8,    /* Journal view */
100         VIEW_DRAFTS             = 9,    /* Drafts view */
101         VIEW_BLOG               = 10,   /* Blog view */
102         VIEW_QUEUE              = 11,   /* SMTP/... QUEUE rooms */
103         VIEW_WIKIMD             = 12,   /* Markdown Wiki view */
104         VIEW_MAX,
105         VIEW_JSON_LIST,
106 } ROOM_VIEWS;
107
108 #define BLOG_EUIDBUF_SIZE       40
109
110 #ifndef IsEmptyStr
111 #define IsEmptyStr(a) ((a)[0] == '\0')
112 #endif
113
114
115 /*
116  * another word to indicate n/a for a pointer if NULL already has a "meaning"
117  */
118 extern const char *StrBufNOTNULL;
119
120 /*
121  * Misc declarations
122  */
123
124 char *libcitadel_version_string(void);
125 int libcitadel_version_number(void);
126 void StartLibCitadel(size_t basesize);
127 void ShutDownLibCitadel(void);
128
129 /*
130  * MIME parser declarations
131  */
132
133 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
134
135
136 typedef void (*MimeParserCallBackType)(char *cbname,
137                                        char *cbfilename,
138                                        char *cbpartnum,
139                                        char *cbdisp,
140                                        void *cbcontent,
141                                        char *cbtype,
142                                        char *cbcharset,
143                                        size_t cblength,
144                                        char *cbencoding,
145                                        char *cbid,
146                                        void *cbuserdata);
147
148 void mime_parser(char *content_start, char *content_end,
149                  MimeParserCallBackType CallBack,
150                  MimeParserCallBackType PreMultiPartCallBack,
151                  MimeParserCallBackType PostMultiPartCallBack,
152                  void *userdata,
153                  int dont_decode);
154
155
156
157 char *fixed_partnum(char *);
158 void mime_decode(char *partnum,
159                  char *part_start, size_t length,
160                  char *content_type, char *charset, char *encoding,
161                  char *disposition,
162                  char *id,
163                  char *name, char *filename,
164                  MimeParserCallBackType CallBack,
165                  MimeParserCallBackType PreMultiPartCallBack,
166                  MimeParserCallBackType PostMultiPartCallBack,
167                  void *userdata,
168                  int dont_decode);
169 int mime_decode_now (char *part_start, 
170                      size_t length,
171                      char *encoding,
172                      char **decoded,
173                      size_t *bytes_decoded);
174 void the_mime_parser(char *partnum,
175                      char *content_start, char *content_end,
176                      MimeParserCallBackType CallBack,
177                      MimeParserCallBackType PreMultiPartCallBack,
178                      MimeParserCallBackType PostMultiPartCallBack,
179                      void *userdata,
180                      int dont_decode);
181
182 typedef struct StrBuf StrBuf;
183
184 #define strof(a) #a
185 #define CStrOf(a) #a, sizeof(#a) - 1
186 typedef struct _ConstStr {
187         const char *Key;
188         long len;
189 }ConstStr;
190 #define CKEY(a) (a).Key, (a).len
191
192 StrBuf* NewStrBuf(void);
193 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
194 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
195 long StrBufShrinkToFit(StrBuf *Buf, int Force);
196 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
197 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
198
199 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
200 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
201 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
202 void FreeStrBuf (StrBuf **FreeMe);
203 char *SmashStrBuf (StrBuf **SmashMe);
204 void HFreeStrBuf (void *VFreeMe);
205 int FlushStrBuf(StrBuf *buf);
206 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
207
208 const char *ChrPtr(const StrBuf *Str);
209 int StrLength(const StrBuf *Str);
210 #define SKEY(a) ChrPtr(a), StrLength(a)
211 void StrBufAsciify(StrBuf *Buf, const char repl);
212 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
213 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
214
215 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
216 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
217 #define NNN_TERM 1
218 #define O_TERM 0
219 int StrBufReadBLOBBuffered(StrBuf *Buf, 
220                            StrBuf *IOBuf, 
221                            const char **BufPos,
222                            int *fd, 
223                            int append, 
224                            long nBytes, 
225                            int check, 
226                            const char **Error);
227 int StrBufTCP_read_buffered_line(StrBuf *Line, 
228                                  StrBuf *buf, 
229                                  int *fd, 
230                                  int timeout, 
231                                  int selectresolution, 
232                                  const char **Error);
233 int StrBufTCP_read_buffered_line_fast(StrBuf *Line, 
234                                       StrBuf *buf, 
235                                       const char **Pos,
236                                       int *fd, 
237                                       int timeout, 
238                                       int selectresolution, 
239                                       const char **Error);
240
241 typedef enum _eReadState {
242         eReadFail,
243         eReadSuccess,
244         eMustReadMore, 
245         eBufferNotEmpty
246 } eReadState;
247
248 typedef struct _file_buffer {
249         StrBuf *Buf;
250         const char *ReadWritePointer;
251         int fd;
252         int LineCompleted;
253         int nBlobBytesWanted;
254 } IOBuffer;
255
256
257 typedef struct __fd_iobuffer {
258         IOBuffer *IOB;
259         int OtherFD;
260         int SplicePipe[2];
261         int PipeSize;
262         long TotalSendSize;
263         loff_t TotalSentAlready;
264         loff_t TotalReadAlready;
265         long ChunkSize;
266         long ChunkSendRemain;
267         StrBuf *ChunkBuffer; /* just used if we don't have sendfile */
268 } FDIOBuffer;
269
270
271 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize);
272 void FDIOBufferDelete(FDIOBuffer *FDB);
273 int FileSendChunked(FDIOBuffer *FDB, const char **Err);
274 int FileRecvChunked(FDIOBuffer *FDB, const char **Err);
275 int FileMoveChunked(FDIOBuffer *FDB, const char **Err);
276 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error);
277
278 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
279 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
280
281 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
282 eReadState StrBufCheckBuffer(IOBuffer *FB);
283 long IOBufferStrLength(IOBuffer *FB);
284
285 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
286 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
287 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
288 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
289 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
290
291 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
292 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
293 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
294 int StrBufNum_tokens(const StrBuf *source, char tok);
295 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
296
297 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
298 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
299 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
300 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
301 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
302 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
303
304
305 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
306 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
307 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
308 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
309 #ifdef SHOW_ME_VAPPEND_PRINTF
310 /* so owe don't create an include depndency, this is just visible on demand. */
311 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
312 #endif
313 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
314 void StrBufCutLeft(StrBuf *Buf, int nChars);
315 void StrBufCutRight(StrBuf *Buf, int nChars);
316 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
317 void StrBufTrim(StrBuf *Buf);
318 void StrBufSpaceToBlank(StrBuf *Buf);
319 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
320 void StrBufUpCase(StrBuf *Buf);
321 void StrBufLowerCase(StrBuf *Buf);
322 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
323 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
324 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
325
326 void StrBufToUnixLF(StrBuf *buf);
327 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
328
329 int CompressBuffer(StrBuf *Buf);
330 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
331 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
332 void StrBuf_RFC822_2_Utf8(StrBuf *Target, 
333                           const StrBuf *DecodeMe, 
334                           const StrBuf* DefaultCharset, 
335                           StrBuf *FoundCharset, 
336                           StrBuf *ConvertBuf, 
337                           StrBuf *ConvertBuf2);
338 /* deprecated old version: */
339 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
340
341 int StrBufDecodeBase64(StrBuf *Buf);
342 int StrBufDecodeBase64To(const StrBuf *BufIn, StrBuf *BufOut);
343 int StrBufDecodeHex(StrBuf *Buf);
344 StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe);
345 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
346 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp, 
347                                            StrBuf *UserName, 
348                                            StrBuf *EmailAddress,
349                                            StrBuf *EncBuf);
350 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
351 #define LB                      (1)             /* Internal escape chars */
352 #define RB                      (2)
353 #define QU                      (3)
354 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
355 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
356 void StrBufXMLEscAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int OverrideLowChars);
357 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
358 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
359 void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks);
360 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
361 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
362 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
363 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
364 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
365
366 long StrTol(const StrBuf *Buf);
367 int StrToi(const StrBuf *Buf);
368 int StrBufIsNumber(const StrBuf *Buf);
369 long StrBuf_Utf8StrLen(StrBuf *Buf);
370 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
371
372 const char *GuessMimeType(const char *data, size_t dlen);
373 const char* GuessMimeByFilename(const char *what, size_t len);
374
375 /* Run once at Programstart */
376 int LoadIconDir(const char *DirName);
377
378 /* Select the icon for a given MIME type */
379 const char *GetIconFilename(char *MimeType, size_t len);
380
381
382 /* URL parsing & connection data */
383 typedef struct ParsedURL ParsedURL;
384 struct ParsedURL {
385         int Priority;
386         StrBuf *URL;
387         StrBuf *UrlWithoutCred;
388         StrBuf *CurlCreds;
389         unsigned Port;
390         const char *Host;
391         const char *User;
392         const char *Pass;
393         const char *LocalPart;
394         const char *PlainUrl;
395         int IsIP;
396         int IPv6;
397         int af;
398         struct hostent *HEnt;
399         struct sockaddr_in6 Addr;
400         ParsedURL *Next;
401         int IsRelay;
402         StrBuf *UsrName;
403         StrBuf *Password;
404 };
405
406 void FreeURL(ParsedURL** Url);
407 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
408 void CurlPrepareURL(ParsedURL *Url);
409
410 /* tools */
411
412
413 int safestrncpy(char *dest, const char *src, size_t n);
414 int num_tokens (const char *source, char tok);
415 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
416 long grab_token(char **dest, const char *source, int parmnum, char separator);
417 int extract_int (const char *source, int parmnum);
418 long extract_long (const char *source, int parmnum);
419 unsigned long extract_unsigned_long(const char *source, int parmnum);
420 void CtdlInitBase64Table(void);
421 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
422 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
423 unsigned int decode_hex(char *Source);
424 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
425 void StripSlashes(char *Dir, int TrailingSlash);
426 size_t striplt(char *);
427 int haschar(const char *st, int ch);
428 void remove_token(char *source, int parmnum, char separator);
429 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
430 int is_msg_in_sequence_set(const char *mset, long msgnum);
431 char *memreadline(char *start, char *buf, int maxlen);
432 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
433 const char *cmemreadline(const char *start, char *buf, int maxlen);
434 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
435 #define IsEmptyStr(a) ((a)[0] == '\0')
436 #define num_parms(source)               num_tokens(source,(char)'|')
437 int stripout(char *str, char leftboundary, char rightboundary);
438 long stripallbut(char *str, char leftboundary, char rightboundary);
439 char *myfgets(char *s, int size, FILE *stream);
440 void urlesc(char *outbuf, size_t oblen, char *strbuf);
441 char *CtdlTempFileName(char *prefix1, int prefix2);
442 FILE *CtdlTempFile(void);
443 void generate_uuid(char *buf);
444 char *bmstrcasestr(char *text, const char *pattern);
445 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
446 const char *cbmstrcasestr(const char *text, const char *pattern);
447 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
448 void CtdlMakeTempFileName(char *name, int len);
449 char *rfc2047encode(const char *line, long length);
450 int is_msg_in_mset(const char *mset, long msgnum);
451 int pattern2(char *search, char *patn);
452 void stripltlen(char *, int *);
453 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
454 void LoadEntityList(char *FileName);
455
456
457
458 /* vCard stuff */
459
460 #define CTDL_VCARD_MAGIC        0xa1f9
461
462 /* This data structure represents a vCard object currently in memory. */
463 struct vCard {
464         int magic;
465         int numprops;
466         struct vCardProp {
467                 char *name;
468                 char *value;
469         } *prop;
470 };
471
472
473 struct vCard *vcard_new(void);
474 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
475 struct vCard *vcard_load(char *vtext);
476 struct vCard *VCardLoad(StrBuf *vbtext);
477
478 void vcard_free(struct vCard *);
479 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
480 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
481                         int instance, int return_propname);
482 char *vcard_serialize(struct vCard *);
483 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
484 void remove_charset_attribute(char *strbuf);
485 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
486
487 /*
488  * Hash list implementation for Citadel
489  */
490 #define HKEY(a) a, (sizeof(a) - 1)
491
492 typedef struct HashList HashList;
493
494 typedef struct HashKey HashKey;
495
496 typedef struct HashPos HashPos;
497
498 typedef void (*DeleteHashDataFunc)(void * Data);
499 typedef const char *(*PrintHashContent)(void * Data);
500 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
501 typedef long (*HashFunc)(const char *Str, long Len);
502 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
503 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
504
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 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
521 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
522 HashPos *GetNewHashPos(const HashList *Hash, int StepWidth);
523 void RewindHashPos(const HashList *Hash, HashPos *it, int StepWidth);
524 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
525 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
526 int GetHashPosCounter(HashList *Hash, HashPos *At);
527 void DeleteHashPos(HashPos **DelMe);
528 int NextHashPos(HashList *Hash, HashPos *At);
529 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
530 int GetNextHashPos(const HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
531 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
532 void SortByHashKey(HashList *Hash, int Order);
533 void SortByHashKeyStr(HashList *Hash);
534 int GetCount(HashList *Hash);
535 const void *GetSearchPayload(const void *HashVoid);
536 void SortByPayload(HashList *Hash, CompareFunc SortBy);
537 void reference_free_handler(void *ptr);
538 int HashLittle(const void *key, size_t length);
539
540 typedef struct MSet MSet;
541 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
542 int IsInMSetList(MSet *MSetList, long MsgNo);
543 void DeleteMSet(MSet **FreeMe);
544
545 void convert_spaces_to_underscores(char *str);
546 int CheckEncode(const char *pch, long len, const char *pche);
547
548 /*
549  * Convert 4 bytes char into an Integer.
550  * usefull for easy inexpensive hashing 
551  * of for char strings.
552  */
553 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
554
555 /* vNote implementation */
556
557 #define CTDL_VNOTE_MAGIC        0xa1fa
558
559 struct vnote {
560         int magic;
561         char *uid;
562         char *summary;
563         char *body;
564         int pos_left;
565         int pos_top;
566         int pos_width;
567         int pos_height;
568         int color_red;
569         int color_green;
570         int color_blue;
571 };
572
573
574
575 struct vnote *vnote_new(void);
576 struct vnote *vnote_new_from_str(char *s);
577 void vnote_free(struct vnote *v);
578 char *vnote_serialize(struct vnote *v);
579 void vnote_serialize_output_field(char *append_to, char *field, char *label);
580
581
582
583
584 /*
585  * Create JSON style structures in C plus serialize them to one string
586  */
587
588 typedef struct JsonValue JsonValue;
589
590
591 void DeleteJSONValue(void *vJsonValue);
592
593 JsonValue *NewJsonObject(const char *Key, long keylen);
594
595 JsonValue *NewJsonArray(const char *Key, long keylen);
596
597 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
598
599 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
600
601 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
602
603 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
604
605 JsonValue *NewJsonNull(const char *Key, long keylen);
606
607 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
608
609 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
610
611 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
612
613 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
614
615
616
617 /*
618  * Citadels Wildfire implementation, see 
619  * http://www.firephp.org/Wiki/Reference/Protocol
620  * and http://wildfirehq.org/ for details
621  */
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
666 #ifdef __cplusplus
667 extern "C" {
668 #endif
669
670 #define CFG_SMTP_FROM_FILTERALL 0
671 #define CFG_SMTP_FROM_NOFILTER 1
672 #define CFG_SMTP_FROM_CORRECT 2
673 #define CFG_SMTP_FROM_REJECT 3
674 /*
675  * MIME types used in Citadel for configuration stuff
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 INTERNETCFG     "application/x-citadel-internet-config"
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 START_CHAT_MODE         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
745 #define US_NEEDVALID    1               /* User needs to be validated       */
746 #define US_EXTEDIT      2               /* Always use external editor       */
747 #define US_PERM         4               /* Permanent user                   */
748 #define US_LASTOLD      16              /* Print last old message with new  */
749 #define US_EXPERT       32              /* Experienced user                 */
750 #define US_UNLISTED     64              /* Unlisted userlog entry           */
751 #define US_NOPROMPT     128             /* Don't prompt after each message  */
752 #define US_PROMPTCTL    256             /* <N>ext & <S>top work at prompt   */
753 #define US_DISAPPEAR    512             /* Use "disappearing msg prompts"   */
754 #define US_REGIS        1024            /* Registered user                  */
755 #define US_PAGINATOR    2048            /* Pause after each screen of text  */
756 #define US_INTERNET     4096            /* Internet mail privileges         */
757 #define US_FLOORS       8192            /* User wants to see floors         */
758 #define US_COLOR        16384           /* User wants ANSI color support    */
759 #define US_USER_SET     (US_LASTOLD | US_EXPERT | US_UNLISTED | \
760                         US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
761                         US_FLOORS | US_COLOR | US_PROMPTCTL | US_EXTEDIT)
762
763 #define UA_KNOWN                2       /* Room appears in a 'known rooms' list */
764 #define UA_GOTOALLOWED          4       /* User may goto this room if specified by exact name */
765 #define UA_HASNEWMSGS           8       /* Unread messages exist in this room */
766 #define UA_ZAPPED               16      /* User has forgotten (zapped) this room */
767 #define UA_POSTALLOWED          32      /* User may post top-level messages here */
768 #define UA_ADMINALLOWED         64      /* Admin or Room Admin rights exist here */
769 #define UA_DELETEALLOWED        128     /* User is allowed to delete messages from this room */
770 #define UA_REPLYALLOWED         256     /* User is allowed to reply to existing messages here */
771 /* runtime flag extracted from goto reply; not db persistant, should be moved if new flags added */
772 #define UA_ISTRASH              512     /* Only available in room view... */
773
774 #ifdef __cplusplus
775 }
776 #endif
777
778 #endif  // LIBCITADEL_H