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