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 800
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;
239 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
240 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
242 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
243 eReadState StrBufCheckBuffer(IOBuffer *FB);
244 long IOBufferStrLength(IOBuffer *FB);
246 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
247 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
248 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
249 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
251 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
252 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
253 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
254 int StrBufNum_tokens(const StrBuf *source, char tok);
255 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
257 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
258 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
259 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
260 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
261 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
262 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
265 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
266 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
267 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
268 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
269 #ifdef SHOW_ME_VAPPEND_PRINTF
270 /* so owe don't create an include depndency, this is just visible on demand. */
271 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
273 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
274 void StrBufCutLeft(StrBuf *Buf, int nChars);
275 void StrBufCutRight(StrBuf *Buf, int nChars);
276 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
277 void StrBufTrim(StrBuf *Buf);
278 void StrBufSpaceToBlank(StrBuf *Buf);
279 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
280 void StrBufUpCase(StrBuf *Buf);
281 void StrBufLowerCase(StrBuf *Buf);
282 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
283 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
284 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
286 void StrBufToUnixLF(StrBuf *buf);
287 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
289 int CompressBuffer(StrBuf *Buf);
290 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
291 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
292 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
293 const StrBuf *DecodeMe,
294 const StrBuf* DefaultCharset,
295 StrBuf *FoundCharset,
297 StrBuf *ConvertBuf2);
298 /* deprecated old version: */
299 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
301 int StrBufDecodeBase64(StrBuf *Buf);
302 int StrBufDecodeHex(StrBuf *Buf);
303 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
304 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
306 StrBuf *EmailAddress,
308 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
309 #define LB (1) /* Internal escape chars */
312 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
313 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
314 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
315 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
316 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
317 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
318 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
319 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
321 long StrTol(const StrBuf *Buf);
322 int StrToi(const StrBuf *Buf);
323 int StrBufIsNumber(const StrBuf *Buf);
324 long StrBuf_Utf8StrLen(StrBuf *Buf);
325 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
327 const char *GuessMimeType(const char *data, size_t dlen);
328 const char* GuessMimeByFilename(const char *what, size_t len);
330 /* Run once at Programstart */
331 int LoadIconDir(const char *DirName);
333 /* Select the icon for a given MIME type */
334 const char *GetIconFilename(char *MimeType, size_t len);
337 /* URL parsing & connection data */
338 typedef struct ParsedURL ParsedURL;
341 StrBuf *UrlWithoutCred;
347 const char *LocalPart;
348 const char *PlainUrl;
352 struct hostent *HEnt;
353 struct sockaddr_in6 Addr;
357 void FreeURL(ParsedURL** Url);
358 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
359 void CurlPrepareURL(ParsedURL *Url);
364 int safestrncpy(char *dest, const char *src, size_t n);
365 int num_tokens (const char *source, char tok);
366 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
367 long grab_token(char **dest, const char *source, int parmnum, char separator);
368 int extract_int (const char *source, int parmnum);
369 long extract_long (const char *source, int parmnum);
370 unsigned long extract_unsigned_long(const char *source, int parmnum);
371 void CtdlInitBase64Table(void);
372 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
373 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
374 unsigned int decode_hex(char *Source);
375 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
376 void StripSlashes(char *Dir, int TrailingSlash);
377 size_t striplt(char *);
378 int haschar(const char *st, int ch);
379 void remove_token(char *source, int parmnum, char separator);
380 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
381 int is_msg_in_sequence_set(const char *mset, long msgnum);
382 char *memreadline(char *start, char *buf, int maxlen);
383 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
384 const char *cmemreadline(const char *start, char *buf, int maxlen);
385 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
386 #define IsEmptyStr(a) ((a)[0] == '\0')
387 #define num_parms(source) num_tokens(source,(char)'|')
388 int stripout(char *str, char leftboundary, char rightboundary);
389 long stripallbut(char *str, char leftboundary, char rightboundary);
390 char *myfgets(char *s, int size, FILE *stream);
391 void urlesc(char *outbuf, size_t oblen, char *strbuf);
392 char *CtdlTempFileName(char *prefix1, int prefix2);
393 FILE *CtdlTempFile(void);
394 void generate_uuid(char *buf);
395 char *bmstrcasestr(char *text, const char *pattern);
396 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
397 const char *cbmstrcasestr(const char *text, const char *pattern);
398 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
399 void CtdlMakeTempFileName(char *name, int len);
400 char *rfc2047encode(char *line, long length);
401 int is_msg_in_mset(const char *mset, long msgnum);
402 int pattern2(char *search, char *patn);
403 void stripltlen(char *, int *);
404 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
405 void LoadEntityList(char *FileName);
411 #define CTDL_VCARD_MAGIC 0xa1f9
413 /* This data structure represents a vCard object currently in memory. */
424 struct vCard *vcard_new(void);
425 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
426 struct vCard *vcard_load(char *vtext);
427 struct vCard *VCardLoad(StrBuf *vbtext);
429 void vcard_free(struct vCard *);
430 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
431 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
432 int instance, int return_propname);
433 char *vcard_serialize(struct vCard *);
434 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
435 void remove_charset_attribute(char *strbuf);
436 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
439 * Hash list implementation for Citadel
441 #define HKEY(a) a, (sizeof(a) - 1)
443 typedef struct HashList HashList;
445 typedef struct HashKey HashKey;
447 typedef struct HashPos HashPos;
449 typedef void (*DeleteHashDataFunc)(void * Data);
450 typedef const char *(*PrintHashContent)(void * Data);
451 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
452 typedef long (*HashFunc)(const char *Str, long Len);
453 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
454 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
456 long Flathash(const char *str, long len);
457 long lFlathash(const char *str, long len);
458 #define IKEY(a) (const char*) &a, sizeof(a)
459 #define LKEY(a) (const char*) &a, sizeof(a)
461 int TestValidateHash(HashList *TestHash);
463 HashList *NewHash(int Uniq, HashFunc F);
464 void DeleteHash(HashList **Hash);
465 void DeleteHashContent(HashList **Hash);
466 void HDeleteHash(void *vHash);
467 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
468 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
469 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
470 int GetHashKeys(HashList *Hash, char ***List);
471 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
472 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
473 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
474 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
475 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
476 int GetHashPosCounter(HashList *Hash, HashPos *At);
477 void DeleteHashPos(HashPos **DelMe);
478 int NextHashPos(HashList *Hash, HashPos *At);
479 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
480 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
481 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
482 void SortByHashKey(HashList *Hash, int Order);
483 void SortByHashKeyStr(HashList *Hash);
484 int GetCount(HashList *Hash);
485 const void *GetSearchPayload(const void *HashVoid);
486 void SortByPayload(HashList *Hash, CompareFunc SortBy);
487 void reference_free_handler(void *ptr);
488 int HashLittle(const void *key, size_t length);
490 typedef struct MSet MSet;
491 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
492 int IsInMSetList(MSet *MSetList, long MsgNo);
493 void DeleteMSet(MSet **FreeMe);
495 void convert_spaces_to_underscores(char *str);
496 int CheckEncode(const char *pch, long len, const char *pche);
499 * Convert 4 bytes char into an Integer.
500 * usefull for easy inexpensive hashing
501 * of for char strings.
503 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
505 /* vNote implementation */
507 #define CTDL_VNOTE_MAGIC 0xa1fa
525 struct vnote *vnote_new(void);
526 struct vnote *vnote_new_from_str(char *s);
527 void vnote_free(struct vnote *v);
528 char *vnote_serialize(struct vnote *v);
529 void vnote_serialize_output_field(char *append_to, char *field, char *label);
535 * Create JSON style structures in C plus serialize them to one string
538 typedef struct JsonValue JsonValue;
541 void DeleteJSONValue(void *vJsonValue);
543 JsonValue *NewJsonObject(const char *Key, long keylen);
545 JsonValue *NewJsonArray(const char *Key, long keylen);
547 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
549 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
551 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
553 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
555 JsonValue *NewJsonNull(const char *Key, long keylen);
557 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
559 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
561 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
563 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
568 * Citadels Wildfire implementation, see
569 * http://www.firephp.org/Wiki/Reference/Protocol
570 * and http://wildfirehq.org/ for details
572 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
574 typedef enum _WF_MessageType {
583 JsonValue *WildFireException(const char *Filename, long FileLen,
588 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
590 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
592 const char *Message, long len,
593 WF_MessageType Type);
595 JsonValue *WildFireMessage(const char *Filename, long fnlen,
598 WF_MessageType Type);
600 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
602 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
605 #define WF_STRUCTINDEX "1"
608 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
610 /* Convenience function to "perform a function and cut a log record if result != 0" */
611 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
613 #endif // LIBCITADEL_H