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