78b3e68ea430bd94d4133f4216087e69355ba7f4
[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       739
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
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 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
249 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
250 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
251 inline int StrBufNum_tokens(const StrBuf *source, char tok);
252 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
253
254 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
255 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
256 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
257 #ifdef SHOW_ME_VAPPEND_PRINTF
258 /* so owe don't create an include depndency, this is just visible on demand. */
259 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
260 #endif
261 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
262 void StrBufCutLeft(StrBuf *Buf, int nChars);
263 void StrBufCutRight(StrBuf *Buf, int nChars);
264 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
265 void StrBufTrim(StrBuf *Buf);
266 void StrBufUpCase(StrBuf *Buf);
267 void StrBufLowerCase(StrBuf *Buf);
268 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
269 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
270
271 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
272
273 int CompressBuffer(StrBuf *Buf);
274 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
275 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
276 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
277 int StrBufDecodeBase64(StrBuf *Buf);
278 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
279 #define LB                      (1)             /* Internal escape chars */
280 #define RB                      (2)
281 #define QU                      (3)
282 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
283 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
284 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
285 void StrMsgEscAppend(StrBuf *Target, StrBuf *Source, const char *PlainIn);
286
287 long StrTol(const StrBuf *Buf);
288 int StrToi(const StrBuf *Buf);
289 int StrBufIsNumber(const StrBuf *Buf);
290 long StrBuf_Utf8StrLen(StrBuf *Buf);
291 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
292
293 const char *GuessMimeType(const char *data, size_t dlen);
294 const char* GuessMimeByFilename(const char *what, size_t len);
295
296 /* Run once at Programstart */
297 int LoadIconDir(const char *DirName);
298
299 /* Select the icon for a given MIME type */
300 const char *GetIconFilename(char *MimeType, size_t len);
301
302 void ShutDownLibCitadel(void);
303
304
305 /* tools */
306
307 int Ctdl_IsUtf8SequenceStart(char Char);
308 int Ctdl_GetUtf8SequenceLength(char Char);
309 int Ctdl_Utf8StrLen(char *str);
310 char *Ctdl_Utf8StrCut(char *str, int maxlen);
311
312
313 int safestrncpy(char *dest, const char *src, size_t n);
314 int num_tokens (const char *source, char tok);
315 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
316 long grab_token(char **dest, const char *source, int parmnum, char separator);
317 int extract_int (const char *source, int parmnum);
318 long extract_long (const char *source, int parmnum);
319 unsigned long extract_unsigned_long(const char *source, int parmnum);
320 void CtdlInitBase64Table(void);
321 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
322 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
323 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
324 void striplt(char *);
325 int haschar(const char *st, int ch);
326 void remove_token(char *source, int parmnum, char separator);
327 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
328 int is_msg_in_sequence_set(const char *mset, long msgnum);
329 char *memreadline(char *start, char *buf, int maxlen);
330 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
331 #define IsEmptyStr(a) ((a)[0] == '\0')
332 #define num_parms(source)               num_tokens(source,(char)'|')
333 void stripout(char *str, char leftboundary, char rightboundary);
334 void stripallbut(char *str, char leftboundary, char rightboundary);
335 char *myfgets(char *s, int size, FILE *stream);
336 void urlesc(char *outbuf, size_t oblen, char *strbuf);
337 char *CtdlTempFileName(char *prefix1, int prefix2);
338 FILE *CtdlTempFile(void);
339 void generate_uuid(char *buf);
340 char *bmstrcasestr(char *text, char *pattern);
341 void CtdlMakeTempFileName(char *name, int len);
342 char *rfc2047encode(char *line, long length);
343 int is_msg_in_mset(const char *mset, long msgnum);
344 int pattern2(char *search, char *patn);
345 void stripltlen(char *, int *);
346 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
347 void LoadEntityList(char *FileName);
348
349
350
351 /* vCard stuff */
352
353 #define CTDL_VCARD_MAGIC        0xa1f9
354
355 /* This data structure represents a vCard object currently in memory. */
356 struct vCard {
357         int magic;
358         int numprops;
359         struct vCardProp {
360                 char *name;
361                 char *value;
362         } *prop;
363 };
364
365
366 struct vCard *vcard_new(void);
367 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
368 struct vCard *vcard_load(char *);
369 void vcard_free(struct vCard *);
370 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
371 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
372                         int instance, int return_propname);
373 char *vcard_serialize(struct vCard *);
374 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
375 void remove_charset_attribute(char *strbuf);
376 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
377
378 /*
379  * Hash list implementation for Citadel
380  */
381 #define HKEY(a) a, (sizeof(a) - 1)
382 typedef struct HashList HashList;
383
384 typedef struct HashKey HashKey;
385
386 typedef struct HashPos HashPos;
387
388 typedef void (*DeleteHashDataFunc)(void * Data);
389 typedef const char *(*PrintHashContent)(void * Data);
390 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
391 typedef int (*HashFunc)(const char *Str, long Len);
392 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
393 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
394
395 int Flathash(const char *str, long len);
396 #define IKEY(a) (const char*)(&((int)a)), sizeof(int)
397
398 HashList *NewHash(int Uniq, HashFunc F);
399 void DeleteHash(HashList **Hash);
400 void HDeleteHash(void *vHash);
401 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
402 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
403 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
404 int GetHashKeys(HashList *Hash, char ***List);
405 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
406 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
407 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
408 int GetHashPosCounter(HashPos *At);
409 void DeleteHashPos(HashPos **DelMe);
410 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
411 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
412 void SortByHashKey(HashList *Hash, int Order);
413 void SortByHashKeyStr(HashList *Hash);
414 int GetCount(HashList *Hash);
415 const void *GetSearchPayload(const void *HashVoid);
416 void SortByPayload(HashList *Hash, CompareFunc SortBy);
417 void generic_free_handler(void *ptr);
418 void reference_free_handler(void *ptr);
419
420
421 void convert_spaces_to_underscores(char *str);
422
423 /*
424  * Convert 4 bytes char into an Integer.
425  * usefull for easy inexpensive hashing 
426  * of for char strings.
427  */
428 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
429
430 /* vNote implementation */
431
432 #define CTDL_VNOTE_MAGIC        0xa1fa
433
434 struct vnote {
435         int magic;
436         char *uid;
437         char *summary;
438         char *body;
439         int pos_left;
440         int pos_top;
441         int pos_width;
442         int pos_height;
443         int color_red;
444         int color_green;
445         int color_blue;
446 };
447
448
449
450 struct vnote *vnote_new(void);
451 struct vnote *vnote_new_from_str(char *s);
452 void vnote_free(struct vnote *v);
453 char *vnote_serialize(struct vnote *v);
454 void vnote_serialize_output_field(char *append_to, char *field, char *label);
455
456
457 #endif  // LIBCITADEL_H