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