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