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