2 * Header file for libcitadel
4 * Copyright (c) 1987-2012 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 /* protect against double includes */
22 * since we reference time_t...
27 #include <arpa/inet.h>
28 #include <sys/types.h>
29 #include <netinet/in.h>
31 #define LIBCITADEL_VERSION_NUMBER 811
34 * Here's a bunch of stupid magic to make the MIME parser portable.
41 typedef enum AXLevel {
54 lastsent, /* Server internal use only */
64 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
68 GNET_POP3_DONT_DELETE_REMOTE = 4,
69 GNET_POP3_INTERVAL = 5
72 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
77 typedef enum __GPEXWhichPolicy {
87 * Note that not all views are implemented in all clients.
89 typedef enum _room_views {
90 VIEW_BBS = 0, /* Bulletin board view */
91 VIEW_MAILBOX = 1, /* Mailbox summary */
92 VIEW_ADDRESSBOOK = 2, /* Address book view */
93 VIEW_CALENDAR = 3, /* Calendar view */
94 VIEW_TASKS = 4, /* Tasks view */
95 VIEW_NOTES = 5, /* Notes view */
96 VIEW_WIKI = 6, /* Wiki view */
97 VIEW_CALBRIEF = 7, /* Brief Calendar view */
98 VIEW_JOURNAL = 8, /* Journal view */
99 VIEW_DRAFTS = 9, /* Drafts view */
100 VIEW_BLOG = 10, /* Blog view */
101 VIEW_QUEUE = 11, /* SMTP/... QUEUE rooms */
106 #define BLOG_EUIDBUF_SIZE 40
109 #define IsEmptyStr(a) ((a)[0] == '\0')
114 * another word to indicate n/a for a pointer if NULL already has a "meaning"
116 extern const char *StrBufNOTNULL;
122 char *libcitadel_version_string(void);
123 int libcitadel_version_number(void);
124 void StartLibCitadel(size_t basesize);
125 void ShutDownLibCitadel(void);
128 * MIME parser declarations
131 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
134 typedef void (*MimeParserCallBackType)(char *cbname,
146 void mime_parser(char *content_start, char *content_end,
147 MimeParserCallBackType CallBack,
148 MimeParserCallBackType PreMultiPartCallBack,
149 MimeParserCallBackType PostMultiPartCallBack,
155 char *fixed_partnum(char *);
156 void mime_decode(char *partnum,
157 char *part_start, size_t length,
158 char *content_type, char *charset, char *encoding,
161 char *name, char *filename,
162 MimeParserCallBackType CallBack,
163 MimeParserCallBackType PreMultiPartCallBack,
164 MimeParserCallBackType PostMultiPartCallBack,
167 int mime_decode_now (char *part_start,
171 size_t *bytes_decoded);
172 void the_mime_parser(char *partnum,
173 char *content_start, char *content_end,
174 MimeParserCallBackType CallBack,
175 MimeParserCallBackType PreMultiPartCallBack,
176 MimeParserCallBackType PostMultiPartCallBack,
180 typedef struct StrBuf StrBuf;
183 #define CStrOf(a) #a, sizeof(#a) - 1
184 typedef struct _ConstStr {
188 #define CKEY(a) (a).Key, (a).len
190 StrBuf* NewStrBuf(void);
191 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
192 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
193 long StrBufShrinkToFit(StrBuf *Buf, int Force);
194 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
195 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
197 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
198 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
199 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
200 void FreeStrBuf (StrBuf **FreeMe);
201 char *SmashStrBuf (StrBuf **SmashMe);
202 void HFreeStrBuf (void *VFreeMe);
203 int FlushStrBuf(StrBuf *buf);
204 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
206 const char *ChrPtr(const StrBuf *Str);
207 int StrLength(const StrBuf *Str);
208 #define SKEY(a) ChrPtr(a), StrLength(a)
209 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
210 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
212 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
213 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
216 int StrBufReadBLOBBuffered(StrBuf *Buf,
224 int StrBufTCP_read_buffered_line(StrBuf *Line,
228 int selectresolution,
230 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
235 int selectresolution,
238 typedef enum _eReadState {
245 typedef struct _file_buffer {
247 const char *ReadWritePointer;
250 int nBlobBytesWanted;
254 typedef struct __fd_iobuffer {
259 long TotalSentAlready;
261 long ChunkSendRemain;
262 StrBuf *ChunkBuffer; /* just used if we don't have sendfile */
266 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize);
267 void FDIOBufferDelete(FDIOBuffer *FDB);
268 int FileSendChunked(FDIOBuffer *FDB, const char **Err);
269 int FileRecvChunked(FDIOBuffer *FDB, const char **Err);
270 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error);
272 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
273 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
275 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
276 eReadState StrBufCheckBuffer(IOBuffer *FB);
277 long IOBufferStrLength(IOBuffer *FB);
279 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
280 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
281 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
282 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
283 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
285 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
286 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
287 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
288 int StrBufNum_tokens(const StrBuf *source, char tok);
289 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
291 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
292 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
293 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
294 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
295 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
296 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
299 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
300 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
301 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
302 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
303 #ifdef SHOW_ME_VAPPEND_PRINTF
304 /* so owe don't create an include depndency, this is just visible on demand. */
305 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
307 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
308 void StrBufCutLeft(StrBuf *Buf, int nChars);
309 void StrBufCutRight(StrBuf *Buf, int nChars);
310 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
311 void StrBufTrim(StrBuf *Buf);
312 void StrBufSpaceToBlank(StrBuf *Buf);
313 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
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);
320 void StrBufToUnixLF(StrBuf *buf);
321 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
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_2_Utf8(StrBuf *Target,
327 const StrBuf *DecodeMe,
328 const StrBuf* DefaultCharset,
329 StrBuf *FoundCharset,
331 StrBuf *ConvertBuf2);
332 /* deprecated old version: */
333 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
335 int StrBufDecodeBase64(StrBuf *Buf);
336 int StrBufDecodeHex(StrBuf *Buf);
337 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
338 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
340 StrBuf *EmailAddress,
342 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
343 #define LB (1) /* Internal escape chars */
346 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
347 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
348 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
349 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
350 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
351 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
352 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
353 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
354 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
356 long StrTol(const StrBuf *Buf);
357 int StrToi(const StrBuf *Buf);
358 int StrBufIsNumber(const StrBuf *Buf);
359 long StrBuf_Utf8StrLen(StrBuf *Buf);
360 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
362 const char *GuessMimeType(const char *data, size_t dlen);
363 const char* GuessMimeByFilename(const char *what, size_t len);
365 /* Run once at Programstart */
366 int LoadIconDir(const char *DirName);
368 /* Select the icon for a given MIME type */
369 const char *GetIconFilename(char *MimeType, size_t len);
372 /* URL parsing & connection data */
373 typedef struct ParsedURL ParsedURL;
377 StrBuf *UrlWithoutCred;
383 const char *LocalPart;
384 const char *PlainUrl;
388 struct hostent *HEnt;
389 struct sockaddr_in6 Addr;
393 void FreeURL(ParsedURL** Url);
394 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
395 void CurlPrepareURL(ParsedURL *Url);
400 int safestrncpy(char *dest, const char *src, size_t n);
401 int num_tokens (const char *source, char tok);
402 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
403 long grab_token(char **dest, const char *source, int parmnum, char separator);
404 int extract_int (const char *source, int parmnum);
405 long extract_long (const char *source, int parmnum);
406 unsigned long extract_unsigned_long(const char *source, int parmnum);
407 void CtdlInitBase64Table(void);
408 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
409 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
410 unsigned int decode_hex(char *Source);
411 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
412 void StripSlashes(char *Dir, int TrailingSlash);
413 size_t striplt(char *);
414 int haschar(const char *st, int ch);
415 void remove_token(char *source, int parmnum, char separator);
416 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
417 int is_msg_in_sequence_set(const char *mset, long msgnum);
418 char *memreadline(char *start, char *buf, int maxlen);
419 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
420 const char *cmemreadline(const char *start, char *buf, int maxlen);
421 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
422 #define IsEmptyStr(a) ((a)[0] == '\0')
423 #define num_parms(source) num_tokens(source,(char)'|')
424 int stripout(char *str, char leftboundary, char rightboundary);
425 long stripallbut(char *str, char leftboundary, char rightboundary);
426 char *myfgets(char *s, int size, FILE *stream);
427 void urlesc(char *outbuf, size_t oblen, char *strbuf);
428 char *CtdlTempFileName(char *prefix1, int prefix2);
429 FILE *CtdlTempFile(void);
430 void generate_uuid(char *buf);
431 char *bmstrcasestr(char *text, const char *pattern);
432 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
433 const char *cbmstrcasestr(const char *text, const char *pattern);
434 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
435 void CtdlMakeTempFileName(char *name, int len);
436 char *rfc2047encode(char *line, long length);
437 int is_msg_in_mset(const char *mset, long msgnum);
438 int pattern2(char *search, char *patn);
439 void stripltlen(char *, int *);
440 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
441 void LoadEntityList(char *FileName);
447 #define CTDL_VCARD_MAGIC 0xa1f9
449 /* This data structure represents a vCard object currently in memory. */
460 struct vCard *vcard_new(void);
461 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
462 struct vCard *vcard_load(char *vtext);
463 struct vCard *VCardLoad(StrBuf *vbtext);
465 void vcard_free(struct vCard *);
466 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
467 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
468 int instance, int return_propname);
469 char *vcard_serialize(struct vCard *);
470 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
471 void remove_charset_attribute(char *strbuf);
472 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
475 * Hash list implementation for Citadel
477 #define HKEY(a) a, (sizeof(a) - 1)
479 typedef struct HashList HashList;
481 typedef struct HashKey HashKey;
483 typedef struct HashPos HashPos;
485 typedef void (*DeleteHashDataFunc)(void * Data);
486 typedef const char *(*PrintHashContent)(void * Data);
487 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
488 typedef long (*HashFunc)(const char *Str, long Len);
489 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
490 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
492 long Flathash(const char *str, long len);
493 long lFlathash(const char *str, long len);
494 #define IKEY(a) (const char*) &a, sizeof(a)
495 #define LKEY(a) (const char*) &a, sizeof(a)
497 int TestValidateHash(HashList *TestHash);
499 HashList *NewHash(int Uniq, HashFunc F);
500 void DeleteHash(HashList **Hash);
501 void DeleteHashContent(HashList **Hash);
502 void HDeleteHash(void *vHash);
503 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
504 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
505 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
506 int GetHashKeys(HashList *Hash, char ***List);
507 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
508 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
509 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
510 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
511 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
512 int GetHashPosCounter(HashList *Hash, HashPos *At);
513 void DeleteHashPos(HashPos **DelMe);
514 int NextHashPos(HashList *Hash, HashPos *At);
515 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
516 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
517 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
518 void SortByHashKey(HashList *Hash, int Order);
519 void SortByHashKeyStr(HashList *Hash);
520 int GetCount(HashList *Hash);
521 const void *GetSearchPayload(const void *HashVoid);
522 void SortByPayload(HashList *Hash, CompareFunc SortBy);
523 void reference_free_handler(void *ptr);
524 int HashLittle(const void *key, size_t length);
526 typedef struct MSet MSet;
527 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
528 int IsInMSetList(MSet *MSetList, long MsgNo);
529 void DeleteMSet(MSet **FreeMe);
531 void convert_spaces_to_underscores(char *str);
532 int CheckEncode(const char *pch, long len, const char *pche);
535 * Convert 4 bytes char into an Integer.
536 * usefull for easy inexpensive hashing
537 * of for char strings.
539 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
541 /* vNote implementation */
543 #define CTDL_VNOTE_MAGIC 0xa1fa
561 struct vnote *vnote_new(void);
562 struct vnote *vnote_new_from_str(char *s);
563 void vnote_free(struct vnote *v);
564 char *vnote_serialize(struct vnote *v);
565 void vnote_serialize_output_field(char *append_to, char *field, char *label);
571 * Create JSON style structures in C plus serialize them to one string
574 typedef struct JsonValue JsonValue;
577 void DeleteJSONValue(void *vJsonValue);
579 JsonValue *NewJsonObject(const char *Key, long keylen);
581 JsonValue *NewJsonArray(const char *Key, long keylen);
583 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
585 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
587 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
589 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
591 JsonValue *NewJsonNull(const char *Key, long keylen);
593 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
595 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
597 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
599 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
604 * Citadels Wildfire implementation, see
605 * http://www.firephp.org/Wiki/Reference/Protocol
606 * and http://wildfirehq.org/ for details
608 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
610 typedef enum _WF_MessageType {
619 JsonValue *WildFireException(const char *Filename, long FileLen,
624 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
626 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
628 const char *Message, long len,
629 WF_MessageType Type);
631 JsonValue *WildFireMessage(const char *Filename, long fnlen,
634 WF_MessageType Type);
636 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
638 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
641 #define WF_STRUCTINDEX "1"
644 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
646 /* Convenience function to "perform a function and cut a log record if result != 0" */
647 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
649 /* a nice consistent place to define how we turn a message id into a thread id hash */
650 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
653 #endif // LIBCITADEL_H