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