* add defines for IGNET parts
[citadel.git] / libcitadel / lib / libcitadel.h
1 /*
2  * $Id$
3  *
4  */
5
6
7 /* protect against double includes */
8 #ifndef LIBCITADEL_H
9 #define LIBCITADEL_H
10
11
12 /*
13  * since we reference time_t...
14  */
15 #include <time.h>
16 #include <stdlib.h>
17 #include <stdarg.h>
18 #define LIBCITADEL_VERSION_NUMBER       783
19
20 /*
21  * Here's a bunch of stupid magic to make the MIME parser portable.
22  */
23 #ifndef SIZ
24 #define SIZ     4096
25 #endif
26
27
28 /* Logging levels - correspond to syslog(3) */
29 enum LogLevel {
30         /* When about to exit the server for an unrecoverable error */
31          CTDL_EMERG,    /* system is unusable */
32         /* Manual intervention is required to avoid an abnormal exit */
33          CTDL_ALERT,    /* action must be taken immediately */
34         /* The server can continue to run with degraded functionality */
35          CTDL_CRIT,     /* critical conditions */
36         /* An error occurs but the server continues to run normally */
37          CTDL_ERR,      /* error conditions */
38         /* An abnormal condition was detected; server will continue normally */
39          CTDL_WARNING,  /* warning conditions */
40         /* Normal messages (login/out, activity, etc.) */
41          CTDL_NOTICE,   /* normal but significant condition */
42         /* Unimportant progress messages, etc. */
43          CTDL_INFO,     /* informational */
44         /* Debugging messages */
45          CTDL_DEBUG     /* debug-level messages */
46 };
47
48 typedef enum AXLevel {
49         AxDeleted = 0,
50         AxNewU = 1,
51         AxProbU = 2,
52         AxLocU = 3,
53         AxNetU = 4,
54         AxPrefU = 5,
55         AxAideU = 6
56 }eUsrAxlvl;
57
58 enum RoomNetCfg {
59         subpending,
60         unsubpending,
61         lastsent, /* Server internal use only */
62         ignet_push_share,
63         listrecp,
64         digestrecp,
65         pop3client,
66         rssclient,
67         participate,
68         maxRoomNetCfg
69 };
70
71 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
72         GNET_POP3_HOST = 1,
73         GNET_POP3_USER = 2,
74         GNET_POP3_PASS = 4,
75         GNET_POP3_DONT_DELETE_REMOTE = 4,
76         GNET_POP3_INTERVAL = 5
77 };
78
79 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
80         GNET_IGNET_NODE = 1,
81         GNET_IGNET_ROOM = 2
82 };
83
84 typedef enum __GPEXWhichPolicy {
85         roompolicy,
86         floorpolicy,
87         sitepolicy,
88         mailboxespolicy,
89         maxpolicy
90 }GPEXWhichPolicy;
91
92 /*
93  * View definitions.
94  * Note that not all views are implemented in all clients.
95  */
96 #define VIEW_BBS                0       /* Bulletin board view */
97 #define VIEW_MAILBOX            1       /* Mailbox summary */
98 #define VIEW_ADDRESSBOOK        2       /* Address book view */
99 #define VIEW_CALENDAR           3       /* Calendar view */
100 #define VIEW_TASKS              4       /* Tasks view */
101 #define VIEW_NOTES              5       /* Notes view */
102 #define VIEW_WIKI               6       /* Wiki view */
103 #define VIEW_CALBRIEF           7       /* Brief Calendar view */
104 #define VIEW_JOURNAL            8       /* Journal view */
105 #define VIEW_BLOG               9       /* Blog view (not yet implemented) */
106
107
108 #ifndef IsEmptyStr
109 #define IsEmptyStr(a) ((a)[0] == '\0')
110 #endif
111
112
113 /*
114  * another word to indicate n/a for a pointer if NULL already has a "meaning"
115  */
116 extern const char *StrBufNOTNULL;
117
118 /*
119  * Misc declarations
120  */
121
122 char *libcitadel_version_string(void);
123 int libcitadel_version_number(void);
124 void StartLibCitadel(size_t basesize);
125 void ShutDownLibCitadel(void);
126
127 /*
128  * MIME parser declarations
129  */
130
131 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
132
133
134 typedef void (*MimeParserCallBackType)(char *cbname,
135                                        char *cbfilename,
136                                        char *cbpartnum,
137                                        char *cbdisp,
138                                        void *cbcontent,
139                                        char *cbtype,
140                                        char *cbcharset,
141                                        size_t cblength,
142                                        char *cbencoding,
143                                        char *cbid,
144                                        void *cbuserdata);
145
146 void mime_parser(char *content_start, char *content_end,
147                  MimeParserCallBackType CallBack,
148                  MimeParserCallBackType PreMultiPartCallBack,
149                  MimeParserCallBackType PostMultiPartCallBack,
150                  void *userdata,
151                  int dont_decode);
152
153
154
155 char *fixed_partnum(char *);
156 void mime_decode(char *partnum,
157                  char *part_start, size_t length,
158                  char *content_type, char *charset, char *encoding,
159                  char *disposition,
160                  char *id,
161                  char *name, char *filename,
162                  MimeParserCallBackType CallBack,
163                  MimeParserCallBackType PreMultiPartCallBack,
164                  MimeParserCallBackType PostMultiPartCallBack,
165                  void *userdata,
166                  int dont_decode);
167 void the_mime_parser(char *partnum,
168                      char *content_start, char *content_end,
169                      MimeParserCallBackType CallBack,
170                      MimeParserCallBackType PreMultiPartCallBack,
171                      MimeParserCallBackType PostMultiPartCallBack,
172                      void *userdata,
173                      int dont_decode);
174
175 typedef struct StrBuf StrBuf;
176
177 #define strof(a) #a
178 #define CStrOf(a) #a, sizeof(#a) - 1
179 typedef struct _ConstStr {
180         const char *Key;
181         long len;
182 }ConstStr;
183 #define CKEY(a) (a).Key, (a).len
184
185 StrBuf* NewStrBuf(void);
186 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
187 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
188 long StrBufShrinkToFit(StrBuf *Buf, int Force);
189 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
190
191 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
192 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
193 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
194 void FreeStrBuf (StrBuf **FreeMe);
195 char *SmashStrBuf (StrBuf **SmashMe);
196 void HFreeStrBuf (void *VFreeMe);
197 int FlushStrBuf(StrBuf *buf);
198 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
199
200 const char *ChrPtr(const StrBuf *Str);
201 int StrLength(const StrBuf *Str);
202 #define SKEY(a) ChrPtr(a), StrLength(a)
203 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
204 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
205
206 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
207 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
208 #define NNN_TERM 1
209 #define O_TERM 0
210 int StrBufReadBLOBBuffered(StrBuf *Buf, 
211                            StrBuf *IOBuf, 
212                            const char **BufPos,
213                            int *fd, 
214                            int append, 
215                            long nBytes, 
216                            int check, 
217                            const char **Error);
218 int StrBufTCP_read_buffered_line(StrBuf *Line, 
219                                  StrBuf *buf, 
220                                  int *fd, 
221                                  int timeout, 
222                                  int selectresolution, 
223                                  const char **Error);
224 int StrBufTCP_read_buffered_line_fast(StrBuf *Line, 
225                                       StrBuf *buf, 
226                                       const char **Pos,
227                                       int *fd, 
228                                       int timeout, 
229                                       int selectresolution, 
230                                       const char **Error);
231
232 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
233 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
234 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
235 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
236
237 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
238 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
239 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
240 int StrBufNum_tokens(const StrBuf *source, char tok);
241 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
242
243 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
244 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
245 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
246 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
247 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
248 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
249
250
251 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
252 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
253 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
254 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
255 #ifdef SHOW_ME_VAPPEND_PRINTF
256 /* so owe don't create an include depndency, this is just visible on demand. */
257 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
258 #endif
259 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
260 void StrBufCutLeft(StrBuf *Buf, int nChars);
261 void StrBufCutRight(StrBuf *Buf, int nChars);
262 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
263 void StrBufTrim(StrBuf *Buf);
264 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
265 void StrBufUpCase(StrBuf *Buf);
266 void StrBufLowerCase(StrBuf *Buf);
267 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
268 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
269 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
270
271 void StrBufToUnixLF(StrBuf *buf);
272 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
273
274 int CompressBuffer(StrBuf *Buf);
275 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
276 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
277 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
278 int StrBufDecodeBase64(StrBuf *Buf);
279 int StrBufDecodeHex(StrBuf *Buf);
280 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
281 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp, 
282                                            StrBuf *UserName, 
283                                            StrBuf *EmailAddress,
284                                            StrBuf *EncBuf);
285 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
286 #define LB                      (1)             /* Internal escape chars */
287 #define RB                      (2)
288 #define QU                      (3)
289 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
290 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
291 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
292 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
293 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
294 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
295 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
296
297 long StrTol(const StrBuf *Buf);
298 int StrToi(const StrBuf *Buf);
299 int StrBufIsNumber(const StrBuf *Buf);
300 long StrBuf_Utf8StrLen(StrBuf *Buf);
301 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
302
303 const char *GuessMimeType(const char *data, size_t dlen);
304 const char* GuessMimeByFilename(const char *what, size_t len);
305
306 /* Run once at Programstart */
307 int LoadIconDir(const char *DirName);
308
309 /* Select the icon for a given MIME type */
310 const char *GetIconFilename(char *MimeType, size_t len);
311
312
313 /* tools */
314
315
316 int safestrncpy(char *dest, const char *src, size_t n);
317 int num_tokens (const char *source, char tok);
318 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
319 long grab_token(char **dest, const char *source, int parmnum, char separator);
320 int extract_int (const char *source, int parmnum);
321 long extract_long (const char *source, int parmnum);
322 unsigned long extract_unsigned_long(const char *source, int parmnum);
323 void CtdlInitBase64Table(void);
324 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
325 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
326 unsigned int decode_hex(char *Source);
327 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
328 void StripSlashes(char *Dir, int TrailingSlash);
329 size_t striplt(char *);
330 int haschar(const char *st, int ch);
331 void remove_token(char *source, int parmnum, char separator);
332 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
333 int is_msg_in_sequence_set(const char *mset, long msgnum);
334 char *memreadline(char *start, char *buf, int maxlen);
335 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
336 const char *cmemreadline(const char *start, char *buf, int maxlen);
337 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
338 #define IsEmptyStr(a) ((a)[0] == '\0')
339 #define num_parms(source)               num_tokens(source,(char)'|')
340 int stripout(char *str, char leftboundary, char rightboundary);
341 void stripallbut(char *str, char leftboundary, char rightboundary);
342 char *myfgets(char *s, int size, FILE *stream);
343 void urlesc(char *outbuf, size_t oblen, char *strbuf);
344 char *CtdlTempFileName(char *prefix1, int prefix2);
345 FILE *CtdlTempFile(void);
346 void generate_uuid(char *buf);
347 char *bmstrcasestr(char *text, const char *pattern);
348 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
349 const char *cbmstrcasestr(const char *text, const char *pattern);
350 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
351 void CtdlMakeTempFileName(char *name, int len);
352 char *rfc2047encode(char *line, long length);
353 int is_msg_in_mset(const char *mset, long msgnum);
354 int pattern2(char *search, char *patn);
355 void stripltlen(char *, int *);
356 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
357 void LoadEntityList(char *FileName);
358
359
360
361 /* vCard stuff */
362
363 #define CTDL_VCARD_MAGIC        0xa1f9
364
365 /* This data structure represents a vCard object currently in memory. */
366 struct vCard {
367         int magic;
368         int numprops;
369         struct vCardProp {
370                 char *name;
371                 char *value;
372         } *prop;
373 };
374
375
376 struct vCard *vcard_new(void);
377 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
378 struct vCard *vcard_load(char *vtext);
379 struct vCard *VCardLoad(StrBuf *vbtext);
380
381 void vcard_free(struct vCard *);
382 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
383 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
384                         int instance, int return_propname);
385 char *vcard_serialize(struct vCard *);
386 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
387 void remove_charset_attribute(char *strbuf);
388 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
389
390 /*
391  * Hash list implementation for Citadel
392  */
393 #define HKEY(a) a, (sizeof(a) - 1)
394
395 typedef struct HashList HashList;
396
397 typedef struct HashKey HashKey;
398
399 typedef struct HashPos HashPos;
400
401 typedef void (*DeleteHashDataFunc)(void * Data);
402 typedef const char *(*PrintHashContent)(void * Data);
403 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
404 typedef int (*HashFunc)(const char *Str, long Len);
405 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
406 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
407
408 int Flathash(const char *str, long len);
409 #define IKEY(a) (const char*) &a, sizeof(a)
410
411 HashList *NewHash(int Uniq, HashFunc F);
412 void DeleteHash(HashList **Hash);
413 void HDeleteHash(void *vHash);
414 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
415 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
416 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
417 int GetHashKeys(HashList *Hash, char ***List);
418 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
419 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
420 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
421 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
422 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
423 int GetHashPosCounter(HashList *Hash, HashPos *At);
424 void DeleteHashPos(HashPos **DelMe);
425 int NextHashPos(HashList *Hash, HashPos *At);
426 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
427 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
428 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
429 void SortByHashKey(HashList *Hash, int Order);
430 void SortByHashKeyStr(HashList *Hash);
431 int GetCount(HashList *Hash);
432 const void *GetSearchPayload(const void *HashVoid);
433 void SortByPayload(HashList *Hash, CompareFunc SortBy);
434 void reference_free_handler(void *ptr);
435 int HashLittle(const void *key, size_t length);
436
437
438 void convert_spaces_to_underscores(char *str);
439 int CheckEncode(const char *pch, long len, const char *pche);
440
441 /*
442  * Convert 4 bytes char into an Integer.
443  * usefull for easy inexpensive hashing 
444  * of for char strings.
445  */
446 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
447
448 /* vNote implementation */
449
450 #define CTDL_VNOTE_MAGIC        0xa1fa
451
452 struct vnote {
453         int magic;
454         char *uid;
455         char *summary;
456         char *body;
457         int pos_left;
458         int pos_top;
459         int pos_width;
460         int pos_height;
461         int color_red;
462         int color_green;
463         int color_blue;
464 };
465
466
467
468 struct vnote *vnote_new(void);
469 struct vnote *vnote_new_from_str(char *s);
470 void vnote_free(struct vnote *v);
471 char *vnote_serialize(struct vnote *v);
472 void vnote_serialize_output_field(char *append_to, char *field, char *label);
473
474
475
476
477 /*
478  * Create JSON style structures in C plus serialize them to one string
479  */
480
481 typedef struct JsonValue JsonValue;
482
483
484 void DeleteJSONValue(void *vJsonValue);
485
486 JsonValue *NewJsonObject(const char *Key, long keylen);
487
488 JsonValue *NewJsonArray(const char *Key, long keylen);
489
490 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
491
492 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
493
494 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
495
496 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
497
498 JsonValue *NewJsonNull(const char *Key, long keylen);
499
500 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
501
502 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
503
504 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
505
506 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
507
508
509
510 /*
511  * Citadels Wildfire implementation, see 
512  * http://www.firephp.org/Wiki/Reference/Protocol
513  * and http://wildfirehq.org/ for details
514  */
515 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
516
517 typedef enum _WF_MessageType {
518         eLOG, 
519         eINFO,
520         eWARN,
521         eERROR,
522         eTRACE,
523         eEXCEPTION
524 } WF_MessageType;
525
526 JsonValue *WildFireException(const char *Filename, long FileLen,
527                              long LineNo,
528                              StrBuf *Message,
529                              int StackOffset);
530
531 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
532
533 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
534                                    long LineNo,
535                                    const char *Message, long len, 
536                                    WF_MessageType Type);
537
538 JsonValue *WildFireMessage(const char *Filename, long fnlen,
539                            long lineno,
540                            StrBuf *Msg, 
541                            WF_MessageType Type);
542
543 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
544
545 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
546
547 #define WF_MAJOR "1"
548 #define WF_STRUCTINDEX "1"
549 #define WF_SUB "1"
550
551
552 #endif  // LIBCITADEL_H