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 801
22 * Here's a bunch of stupid magic to make the MIME parser portable.
29 typedef enum AXLevel {
42 lastsent, /* Server internal use only */
52 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
56 GNET_POP3_DONT_DELETE_REMOTE = 4,
57 GNET_POP3_INTERVAL = 5
60 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
65 typedef enum __GPEXWhichPolicy {
75 * Note that not all views are implemented in all clients.
77 typedef enum _room_views {
78 VIEW_BBS = 0, /* Bulletin board view */
79 VIEW_MAILBOX = 1, /* Mailbox summary */
80 VIEW_ADDRESSBOOK = 2, /* Address book view */
81 VIEW_CALENDAR = 3, /* Calendar view */
82 VIEW_TASKS = 4, /* Tasks view */
83 VIEW_NOTES = 5, /* Notes view */
84 VIEW_WIKI = 6, /* Wiki view */
85 VIEW_CALBRIEF = 7, /* Brief Calendar view */
86 VIEW_JOURNAL = 8, /* Journal view */
87 VIEW_DRAFTS = 9, /* Drafts view */
88 VIEW_BLOG = 10, /* Blog view */
92 #define BLOG_EUIDBUF_SIZE 40
95 #define IsEmptyStr(a) ((a)[0] == '\0')
100 * another word to indicate n/a for a pointer if NULL already has a "meaning"
102 extern const char *StrBufNOTNULL;
108 char *libcitadel_version_string(void);
109 int libcitadel_version_number(void);
110 void StartLibCitadel(size_t basesize);
111 void ShutDownLibCitadel(void);
114 * MIME parser declarations
117 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
120 typedef void (*MimeParserCallBackType)(char *cbname,
132 void mime_parser(char *content_start, char *content_end,
133 MimeParserCallBackType CallBack,
134 MimeParserCallBackType PreMultiPartCallBack,
135 MimeParserCallBackType PostMultiPartCallBack,
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,
147 char *name, char *filename,
148 MimeParserCallBackType CallBack,
149 MimeParserCallBackType PreMultiPartCallBack,
150 MimeParserCallBackType PostMultiPartCallBack,
153 int mime_decode_now (char *part_start,
157 size_t *bytes_decoded);
158 void the_mime_parser(char *partnum,
159 char *content_start, char *content_end,
160 MimeParserCallBackType CallBack,
161 MimeParserCallBackType PreMultiPartCallBack,
162 MimeParserCallBackType PostMultiPartCallBack,
166 typedef struct StrBuf StrBuf;
169 #define CStrOf(a) #a, sizeof(#a) - 1
170 typedef struct _ConstStr {
174 #define CKEY(a) (a).Key, (a).len
176 StrBuf* NewStrBuf(void);
177 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
178 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
179 long StrBufShrinkToFit(StrBuf *Buf, int Force);
180 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
181 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
183 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
184 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
185 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
186 void FreeStrBuf (StrBuf **FreeMe);
187 char *SmashStrBuf (StrBuf **SmashMe);
188 void HFreeStrBuf (void *VFreeMe);
189 int FlushStrBuf(StrBuf *buf);
190 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
192 const char *ChrPtr(const StrBuf *Str);
193 int StrLength(const StrBuf *Str);
194 #define SKEY(a) ChrPtr(a), StrLength(a)
195 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
196 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
198 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
199 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
202 int StrBufReadBLOBBuffered(StrBuf *Buf,
210 int StrBufTCP_read_buffered_line(StrBuf *Line,
214 int selectresolution,
216 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
221 int selectresolution,
224 typedef enum _eReadState {
231 typedef struct _file_buffer {
233 const char *ReadWritePointer;
236 int nBlobBytesWanted;
240 typedef struct __fd_iobuffer {
245 long TotalSentAlready;
247 long ChunkSendRemain;
248 StrBuf *ChunkBuffer; /* just used if we don't have sendfile */
252 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize);
253 void FDIOBufferDelete(FDIOBuffer *FDB);
254 int FileSendChunked(FDIOBuffer *FDB, const char **Err);
255 int FileRecvChunked(FDIOBuffer *FDB, const char **Err);
256 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error);
258 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
259 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
261 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
262 eReadState StrBufCheckBuffer(IOBuffer *FB);
263 long IOBufferStrLength(IOBuffer *FB);
265 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
266 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
267 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
268 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
270 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
271 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
272 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
273 int StrBufNum_tokens(const StrBuf *source, char tok);
274 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
276 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
277 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
278 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
279 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
280 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
281 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
284 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
285 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
286 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
287 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
288 #ifdef SHOW_ME_VAPPEND_PRINTF
289 /* so owe don't create an include depndency, this is just visible on demand. */
290 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
292 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
293 void StrBufCutLeft(StrBuf *Buf, int nChars);
294 void StrBufCutRight(StrBuf *Buf, int nChars);
295 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
296 void StrBufTrim(StrBuf *Buf);
297 void StrBufSpaceToBlank(StrBuf *Buf);
298 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
299 void StrBufUpCase(StrBuf *Buf);
300 void StrBufLowerCase(StrBuf *Buf);
301 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
302 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
303 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
305 void StrBufToUnixLF(StrBuf *buf);
306 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
308 int CompressBuffer(StrBuf *Buf);
309 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
310 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
311 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
312 const StrBuf *DecodeMe,
313 const StrBuf* DefaultCharset,
314 StrBuf *FoundCharset,
316 StrBuf *ConvertBuf2);
317 /* deprecated old version: */
318 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
320 int StrBufDecodeBase64(StrBuf *Buf);
321 int StrBufDecodeHex(StrBuf *Buf);
322 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
323 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
325 StrBuf *EmailAddress,
327 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
328 #define LB (1) /* Internal escape chars */
331 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
332 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
333 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
334 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
335 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
336 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
337 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
338 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
340 long StrTol(const StrBuf *Buf);
341 int StrToi(const StrBuf *Buf);
342 int StrBufIsNumber(const StrBuf *Buf);
343 long StrBuf_Utf8StrLen(StrBuf *Buf);
344 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
346 const char *GuessMimeType(const char *data, size_t dlen);
347 const char* GuessMimeByFilename(const char *what, size_t len);
349 /* Run once at Programstart */
350 int LoadIconDir(const char *DirName);
352 /* Select the icon for a given MIME type */
353 const char *GetIconFilename(char *MimeType, size_t len);
356 /* URL parsing & connection data */
357 typedef struct ParsedURL ParsedURL;
360 StrBuf *UrlWithoutCred;
366 const char *LocalPart;
367 const char *PlainUrl;
371 struct hostent *HEnt;
372 struct sockaddr_in6 Addr;
376 void FreeURL(ParsedURL** Url);
377 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
378 void CurlPrepareURL(ParsedURL *Url);
383 int safestrncpy(char *dest, const char *src, size_t n);
384 int num_tokens (const char *source, char tok);
385 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
386 long grab_token(char **dest, const char *source, int parmnum, char separator);
387 int extract_int (const char *source, int parmnum);
388 long extract_long (const char *source, int parmnum);
389 unsigned long extract_unsigned_long(const char *source, int parmnum);
390 void CtdlInitBase64Table(void);
391 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
392 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
393 unsigned int decode_hex(char *Source);
394 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
395 void StripSlashes(char *Dir, int TrailingSlash);
396 size_t striplt(char *);
397 int haschar(const char *st, int ch);
398 void remove_token(char *source, int parmnum, char separator);
399 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
400 int is_msg_in_sequence_set(const char *mset, long msgnum);
401 char *memreadline(char *start, char *buf, int maxlen);
402 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
403 const char *cmemreadline(const char *start, char *buf, int maxlen);
404 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
405 #define IsEmptyStr(a) ((a)[0] == '\0')
406 #define num_parms(source) num_tokens(source,(char)'|')
407 int stripout(char *str, char leftboundary, char rightboundary);
408 long stripallbut(char *str, char leftboundary, char rightboundary);
409 char *myfgets(char *s, int size, FILE *stream);
410 void urlesc(char *outbuf, size_t oblen, char *strbuf);
411 char *CtdlTempFileName(char *prefix1, int prefix2);
412 FILE *CtdlTempFile(void);
413 void generate_uuid(char *buf);
414 char *bmstrcasestr(char *text, const char *pattern);
415 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
416 const char *cbmstrcasestr(const char *text, const char *pattern);
417 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
418 void CtdlMakeTempFileName(char *name, int len);
419 char *rfc2047encode(char *line, long length);
420 int is_msg_in_mset(const char *mset, long msgnum);
421 int pattern2(char *search, char *patn);
422 void stripltlen(char *, int *);
423 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
424 void LoadEntityList(char *FileName);
430 #define CTDL_VCARD_MAGIC 0xa1f9
432 /* This data structure represents a vCard object currently in memory. */
443 struct vCard *vcard_new(void);
444 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
445 struct vCard *vcard_load(char *vtext);
446 struct vCard *VCardLoad(StrBuf *vbtext);
448 void vcard_free(struct vCard *);
449 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
450 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
451 int instance, int return_propname);
452 char *vcard_serialize(struct vCard *);
453 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
454 void remove_charset_attribute(char *strbuf);
455 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
458 * Hash list implementation for Citadel
460 #define HKEY(a) a, (sizeof(a) - 1)
462 typedef struct HashList HashList;
464 typedef struct HashKey HashKey;
466 typedef struct HashPos HashPos;
468 typedef void (*DeleteHashDataFunc)(void * Data);
469 typedef const char *(*PrintHashContent)(void * Data);
470 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
471 typedef long (*HashFunc)(const char *Str, long Len);
472 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
473 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
475 long Flathash(const char *str, long len);
476 long lFlathash(const char *str, long len);
477 #define IKEY(a) (const char*) &a, sizeof(a)
478 #define LKEY(a) (const char*) &a, sizeof(a)
480 int TestValidateHash(HashList *TestHash);
482 HashList *NewHash(int Uniq, HashFunc F);
483 void DeleteHash(HashList **Hash);
484 void DeleteHashContent(HashList **Hash);
485 void HDeleteHash(void *vHash);
486 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
487 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
488 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
489 int GetHashKeys(HashList *Hash, char ***List);
490 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
491 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
492 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
493 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
494 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
495 int GetHashPosCounter(HashList *Hash, HashPos *At);
496 void DeleteHashPos(HashPos **DelMe);
497 int NextHashPos(HashList *Hash, HashPos *At);
498 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
499 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
500 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
501 void SortByHashKey(HashList *Hash, int Order);
502 void SortByHashKeyStr(HashList *Hash);
503 int GetCount(HashList *Hash);
504 const void *GetSearchPayload(const void *HashVoid);
505 void SortByPayload(HashList *Hash, CompareFunc SortBy);
506 void reference_free_handler(void *ptr);
507 int HashLittle(const void *key, size_t length);
509 typedef struct MSet MSet;
510 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
511 int IsInMSetList(MSet *MSetList, long MsgNo);
512 void DeleteMSet(MSet **FreeMe);
514 void convert_spaces_to_underscores(char *str);
515 int CheckEncode(const char *pch, long len, const char *pche);
518 * Convert 4 bytes char into an Integer.
519 * usefull for easy inexpensive hashing
520 * of for char strings.
522 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
524 /* vNote implementation */
526 #define CTDL_VNOTE_MAGIC 0xa1fa
544 struct vnote *vnote_new(void);
545 struct vnote *vnote_new_from_str(char *s);
546 void vnote_free(struct vnote *v);
547 char *vnote_serialize(struct vnote *v);
548 void vnote_serialize_output_field(char *append_to, char *field, char *label);
554 * Create JSON style structures in C plus serialize them to one string
557 typedef struct JsonValue JsonValue;
560 void DeleteJSONValue(void *vJsonValue);
562 JsonValue *NewJsonObject(const char *Key, long keylen);
564 JsonValue *NewJsonArray(const char *Key, long keylen);
566 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
568 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
570 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
572 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
574 JsonValue *NewJsonNull(const char *Key, long keylen);
576 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
578 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
580 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
582 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
587 * Citadels Wildfire implementation, see
588 * http://www.firephp.org/Wiki/Reference/Protocol
589 * and http://wildfirehq.org/ for details
591 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
593 typedef enum _WF_MessageType {
602 JsonValue *WildFireException(const char *Filename, long FileLen,
607 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
609 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
611 const char *Message, long len,
612 WF_MessageType Type);
614 JsonValue *WildFireMessage(const char *Filename, long fnlen,
617 WF_MessageType Type);
619 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
621 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
624 #define WF_STRUCTINDEX "1"
627 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
629 /* Convenience function to "perform a function and cut a log record if result != 0" */
630 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
632 /* a nice consistent place to define how we turn a message id into a thread id hash */
633 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
636 #endif // LIBCITADEL_H