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