2 * Header file for libcitadel
6 /* protect against double includes */
12 * since we reference time_t...
17 #include <arpa/inet.h>
19 #define LIBCITADEL_VERSION_NUMBER 789
22 * Here's a bunch of stupid magic to make the MIME parser portable.
29 /* Logging levels - correspond to syslog(3) */
31 /* When about to exit the server for an unrecoverable error */
32 CTDL_EMERG, /* system is unusable */
33 /* Manual intervention is required to avoid an abnormal exit */
34 CTDL_ALERT, /* action must be taken immediately */
35 /* The server can continue to run with degraded functionality */
36 CTDL_CRIT, /* critical conditions */
37 /* An error occurs but the server continues to run normally */
38 CTDL_ERR, /* error conditions */
39 /* An abnormal condition was detected; server will continue normally */
40 CTDL_WARNING, /* warning conditions */
41 /* Normal messages (login/out, activity, etc.) */
42 CTDL_NOTICE, /* normal but significant condition */
43 /* Unimportant progress messages, etc. */
44 CTDL_INFO, /* informational */
45 /* Debugging messages */
46 CTDL_DEBUG /* debug-level messages */
49 typedef enum AXLevel {
62 lastsent, /* Server internal use only */
72 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
76 GNET_POP3_DONT_DELETE_REMOTE = 4,
77 GNET_POP3_INTERVAL = 5
80 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
85 typedef enum __GPEXWhichPolicy {
95 * Note that not all views are implemented in all clients.
97 typedef enum _room_views {
98 VIEW_BBS = 0, /* Bulletin board view */
99 VIEW_MAILBOX = 1, /* Mailbox summary */
100 VIEW_ADDRESSBOOK = 2, /* Address book view */
101 VIEW_CALENDAR = 3, /* Calendar view */
102 VIEW_TASKS = 4, /* Tasks view */
103 VIEW_NOTES = 5, /* Notes view */
104 VIEW_WIKI = 6, /* Wiki view */
105 VIEW_CALBRIEF = 7, /* Brief Calendar view */
106 VIEW_JOURNAL = 8, /* Journal view */
107 VIEW_DRAFTS = 9, /* Drafts view */
108 VIEW_BLOG = 10, /* Blog view */
114 #define IsEmptyStr(a) ((a)[0] == '\0')
119 * another word to indicate n/a for a pointer if NULL already has a "meaning"
121 extern const char *StrBufNOTNULL;
127 char *libcitadel_version_string(void);
128 int libcitadel_version_number(void);
129 void StartLibCitadel(size_t basesize);
130 void ShutDownLibCitadel(void);
133 * MIME parser declarations
136 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
139 typedef void (*MimeParserCallBackType)(char *cbname,
151 void mime_parser(char *content_start, char *content_end,
152 MimeParserCallBackType CallBack,
153 MimeParserCallBackType PreMultiPartCallBack,
154 MimeParserCallBackType PostMultiPartCallBack,
160 char *fixed_partnum(char *);
161 void mime_decode(char *partnum,
162 char *part_start, size_t length,
163 char *content_type, char *charset, char *encoding,
166 char *name, char *filename,
167 MimeParserCallBackType CallBack,
168 MimeParserCallBackType PreMultiPartCallBack,
169 MimeParserCallBackType PostMultiPartCallBack,
172 int mime_decode_now (char *part_start,
176 size_t *bytes_decoded);
177 void the_mime_parser(char *partnum,
178 char *content_start, char *content_end,
179 MimeParserCallBackType CallBack,
180 MimeParserCallBackType PreMultiPartCallBack,
181 MimeParserCallBackType PostMultiPartCallBack,
185 typedef struct StrBuf StrBuf;
188 #define CStrOf(a) #a, sizeof(#a) - 1
189 typedef struct _ConstStr {
193 #define CKEY(a) (a).Key, (a).len
195 StrBuf* NewStrBuf(void);
196 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
197 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
198 long StrBufShrinkToFit(StrBuf *Buf, int Force);
199 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
200 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
202 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
203 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
204 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
205 void FreeStrBuf (StrBuf **FreeMe);
206 char *SmashStrBuf (StrBuf **SmashMe);
207 void HFreeStrBuf (void *VFreeMe);
208 int FlushStrBuf(StrBuf *buf);
209 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
211 const char *ChrPtr(const StrBuf *Str);
212 int StrLength(const StrBuf *Str);
213 #define SKEY(a) ChrPtr(a), StrLength(a)
214 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
215 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
217 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
218 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
221 int StrBufReadBLOBBuffered(StrBuf *Buf,
229 int StrBufTCP_read_buffered_line(StrBuf *Line,
233 int selectresolution,
235 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
240 int selectresolution,
244 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
246 typedef enum _eReadState {
253 typedef struct _file_buffer {
255 const char *ReadWritePointer;
258 int nBlobBytesWanted;
261 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
262 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
264 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
265 eReadState StrBufCheckBuffer(IOBuffer *FB);
268 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
269 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
270 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
272 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
273 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
274 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
275 int StrBufNum_tokens(const StrBuf *source, char tok);
276 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
278 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
279 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
280 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
281 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
282 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
283 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
286 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
287 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
288 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
289 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
290 #ifdef SHOW_ME_VAPPEND_PRINTF
291 /* so owe don't create an include depndency, this is just visible on demand. */
292 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
294 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
295 void StrBufCutLeft(StrBuf *Buf, int nChars);
296 void StrBufCutRight(StrBuf *Buf, int nChars);
297 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
298 void StrBufTrim(StrBuf *Buf);
299 void StrBufSpaceToBlank(StrBuf *Buf);
300 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
301 void StrBufUpCase(StrBuf *Buf);
302 void StrBufLowerCase(StrBuf *Buf);
303 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
304 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
305 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
307 void StrBufToUnixLF(StrBuf *buf);
308 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
310 int CompressBuffer(StrBuf *Buf);
311 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
312 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
313 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
314 const StrBuf *DecodeMe,
315 const StrBuf* DefaultCharset,
316 StrBuf *FoundCharset,
318 StrBuf *ConvertBuf2);
319 /* deprecated old version: */
320 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
322 int StrBufDecodeBase64(StrBuf *Buf);
323 int StrBufDecodeHex(StrBuf *Buf);
324 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
325 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
327 StrBuf *EmailAddress,
329 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
330 #define LB (1) /* Internal escape chars */
333 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
334 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
335 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
336 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
337 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
338 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
339 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
341 long StrTol(const StrBuf *Buf);
342 int StrToi(const StrBuf *Buf);
343 int StrBufIsNumber(const StrBuf *Buf);
344 long StrBuf_Utf8StrLen(StrBuf *Buf);
345 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
347 const char *GuessMimeType(const char *data, size_t dlen);
348 const char* GuessMimeByFilename(const char *what, size_t len);
350 /* Run once at Programstart */
351 int LoadIconDir(const char *DirName);
353 /* Select the icon for a given MIME type */
354 const char *GetIconFilename(char *MimeType, size_t len);
357 /* URL parsing & connection data */
358 typedef struct ParsedURL ParsedURL;
361 StrBuf *UrlWithoutCred;
367 const char *LocalPart;
368 const char *PlainUrl;
372 struct hostent *HEnt;
373 struct sockaddr_in6 Addr;
377 void FreeURL(ParsedURL** Url);
378 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
379 void CurlPrepareURL(ParsedURL *Url);
384 int safestrncpy(char *dest, const char *src, size_t n);
385 int num_tokens (const char *source, char tok);
386 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
387 long grab_token(char **dest, const char *source, int parmnum, char separator);
388 int extract_int (const char *source, int parmnum);
389 long extract_long (const char *source, int parmnum);
390 unsigned long extract_unsigned_long(const char *source, int parmnum);
391 void CtdlInitBase64Table(void);
392 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
393 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
394 unsigned int decode_hex(char *Source);
395 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
396 void StripSlashes(char *Dir, int TrailingSlash);
397 size_t striplt(char *);
398 int haschar(const char *st, int ch);
399 void remove_token(char *source, int parmnum, char separator);
400 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
401 int is_msg_in_sequence_set(const char *mset, long msgnum);
402 char *memreadline(char *start, char *buf, int maxlen);
403 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
404 const char *cmemreadline(const char *start, char *buf, int maxlen);
405 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
406 #define IsEmptyStr(a) ((a)[0] == '\0')
407 #define num_parms(source) num_tokens(source,(char)'|')
408 int stripout(char *str, char leftboundary, char rightboundary);
409 long stripallbut(char *str, char leftboundary, char rightboundary);
410 char *myfgets(char *s, int size, FILE *stream);
411 void urlesc(char *outbuf, size_t oblen, char *strbuf);
412 char *CtdlTempFileName(char *prefix1, int prefix2);
413 FILE *CtdlTempFile(void);
414 void generate_uuid(char *buf);
415 char *bmstrcasestr(char *text, const char *pattern);
416 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
417 const char *cbmstrcasestr(const char *text, const char *pattern);
418 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
419 void CtdlMakeTempFileName(char *name, int len);
420 char *rfc2047encode(char *line, long length);
421 int is_msg_in_mset(const char *mset, long msgnum);
422 int pattern2(char *search, char *patn);
423 void stripltlen(char *, int *);
424 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
425 void LoadEntityList(char *FileName);
431 #define CTDL_VCARD_MAGIC 0xa1f9
433 /* This data structure represents a vCard object currently in memory. */
444 struct vCard *vcard_new(void);
445 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
446 struct vCard *vcard_load(char *vtext);
447 struct vCard *VCardLoad(StrBuf *vbtext);
449 void vcard_free(struct vCard *);
450 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
451 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
452 int instance, int return_propname);
453 char *vcard_serialize(struct vCard *);
454 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
455 void remove_charset_attribute(char *strbuf);
456 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
459 * Hash list implementation for Citadel
461 #define HKEY(a) a, (sizeof(a) - 1)
463 typedef struct HashList HashList;
465 typedef struct HashKey HashKey;
467 typedef struct HashPos HashPos;
469 typedef void (*DeleteHashDataFunc)(void * Data);
470 typedef const char *(*PrintHashContent)(void * Data);
471 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
472 typedef long (*HashFunc)(const char *Str, long Len);
473 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
474 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
476 long Flathash(const char *str, long len);
477 long lFlathash(const char *str, long len);
478 #define IKEY(a) (const char*) &a, sizeof(a)
479 #define LKEY(a) (const char*) &a, sizeof(a)
481 HashList *NewHash(int Uniq, HashFunc F);
482 void DeleteHash(HashList **Hash);
483 void DeleteHashContent(HashList **Hash);
484 void HDeleteHash(void *vHash);
485 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
486 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
487 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
488 int GetHashKeys(HashList *Hash, char ***List);
489 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
490 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
491 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
492 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
493 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
494 int GetHashPosCounter(HashList *Hash, HashPos *At);
495 void DeleteHashPos(HashPos **DelMe);
496 int NextHashPos(HashList *Hash, HashPos *At);
497 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
498 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
499 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
500 void SortByHashKey(HashList *Hash, int Order);
501 void SortByHashKeyStr(HashList *Hash);
502 int GetCount(HashList *Hash);
503 const void *GetSearchPayload(const void *HashVoid);
504 void SortByPayload(HashList *Hash, CompareFunc SortBy);
505 void reference_free_handler(void *ptr);
506 int HashLittle(const void *key, size_t length);
508 typedef struct MSet MSet;
509 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
510 int IsInMSetList(MSet *MSetList, long MsgNo);
511 void DeleteMSet(MSet **FreeMe);
513 void convert_spaces_to_underscores(char *str);
514 int CheckEncode(const char *pch, long len, const char *pche);
517 * Convert 4 bytes char into an Integer.
518 * usefull for easy inexpensive hashing
519 * of for char strings.
521 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
523 /* vNote implementation */
525 #define CTDL_VNOTE_MAGIC 0xa1fa
543 struct vnote *vnote_new(void);
544 struct vnote *vnote_new_from_str(char *s);
545 void vnote_free(struct vnote *v);
546 char *vnote_serialize(struct vnote *v);
547 void vnote_serialize_output_field(char *append_to, char *field, char *label);
553 * Create JSON style structures in C plus serialize them to one string
556 typedef struct JsonValue JsonValue;
559 void DeleteJSONValue(void *vJsonValue);
561 JsonValue *NewJsonObject(const char *Key, long keylen);
563 JsonValue *NewJsonArray(const char *Key, long keylen);
565 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
567 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
569 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
571 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
573 JsonValue *NewJsonNull(const char *Key, long keylen);
575 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
577 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
579 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
581 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
586 * Citadels Wildfire implementation, see
587 * http://www.firephp.org/Wiki/Reference/Protocol
588 * and http://wildfirehq.org/ for details
590 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
592 typedef enum _WF_MessageType {
601 JsonValue *WildFireException(const char *Filename, long FileLen,
606 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
608 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
610 const char *Message, long len,
611 WF_MessageType Type);
613 JsonValue *WildFireMessage(const char *Filename, long fnlen,
616 WF_MessageType Type);
618 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
620 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
623 #define WF_STRUCTINDEX "1"
626 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
628 #endif // LIBCITADEL_H