7 /* protect against double includes */
13 * since we reference time_t...
18 #define LIBCITADEL_VERSION_NUMBER 770
21 * Here's a bunch of stupid magic to make the MIME parser portable.
28 /* Logging levels - correspond to syslog(3) */
30 /* When about to exit the server for an unrecoverable error */
31 CTDL_EMERG, /* system is unusable */
32 /* Manual intervention is required to avoid an abnormal exit */
33 CTDL_ALERT, /* action must be taken immediately */
34 /* The server can continue to run with degraded functionality */
35 CTDL_CRIT, /* critical conditions */
36 /* An error occurs but the server continues to run normally */
37 CTDL_ERR, /* error conditions */
38 /* An abnormal condition was detected; server will continue normally */
39 CTDL_WARNING, /* warning conditions */
40 /* Normal messages (login/out, activity, etc.) */
41 CTDL_NOTICE, /* normal but significant condition */
42 /* Unimportant progress messages, etc. */
43 CTDL_INFO, /* informational */
44 /* Debugging messages */
45 CTDL_DEBUG /* debug-level messages */
51 * Note that not all views are implemented in all clients.
53 #define VIEW_BBS 0 /* Bulletin board view */
54 #define VIEW_MAILBOX 1 /* Mailbox summary */
55 #define VIEW_ADDRESSBOOK 2 /* Address book view */
56 #define VIEW_CALENDAR 3 /* Calendar view */
57 #define VIEW_TASKS 4 /* Tasks view */
58 #define VIEW_NOTES 5 /* Notes view */
59 #define VIEW_WIKI 6 /* Wiki view */
60 #define VIEW_CALBRIEF 7 /* Brief Calendar view */
61 #define VIEW_JOURNAL 8 /* Journal view */
62 #define VIEW_BLOG 9 /* Blog view (not yet implemented) */
66 #define IsEmptyStr(a) ((a)[0] == '\0')
70 * another word to indicate n/a for a pointer if NULL already has a "meaning"
72 extern const char *StrBufNOTNULL;
78 char *libcitadel_version_string(void);
79 int libcitadel_version_number(void);
80 void StartLibCitadel(size_t basesize);
81 void ShutDownLibCitadel(void);
84 * MIME parser declarations
87 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
89 void mime_parser(char *content_start, char *content_end,
102 void (*PreMultiPartCallBack)
114 void (*PostMultiPartCallBack)
132 char *fixed_partnum(char *);
133 void mime_decode(char *partnum,
134 char *part_start, size_t length,
135 char *content_type, char *charset, char *encoding,
138 char *name, char *filename,
151 void (*PreMultiPartCallBack)
163 void (*PostMultiPartCallBack)
178 void the_mime_parser(char *partnum,
179 char *content_start, char *content_end,
192 void (*PreMultiPartCallBack)
204 void (*PostMultiPartCallBack)
220 typedef struct StrBuf StrBuf;
222 typedef struct _ConstStr {
226 #define CKEY(a) (a).Key, (a).len
228 StrBuf* NewStrBuf(void);
229 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
230 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
231 long StrBufShrinkToFit(StrBuf *Buf, int Force);
232 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
234 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
235 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
236 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
237 void FreeStrBuf (StrBuf **FreeMe);
238 char *SmashStrBuf (StrBuf **SmashMe);
239 void HFreeStrBuf (void *VFreeMe);
240 int FlushStrBuf(StrBuf *buf);
241 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
243 const char *ChrPtr(const StrBuf *Str);
244 int StrLength(const StrBuf *Str);
245 #define SKEY(a) ChrPtr(a), StrLength(a)
246 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
248 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
249 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
252 int StrBufReadBLOBBuffered(StrBuf *Buf,
260 int StrBufTCP_read_buffered_line(StrBuf *Line,
264 int selectresolution,
266 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
271 int selectresolution,
274 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
275 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
276 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
278 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
279 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
280 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
281 int StrBufNum_tokens(const StrBuf *source, char tok);
282 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
284 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
285 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
286 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
287 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
288 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
289 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
292 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
293 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
294 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
295 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
296 #ifdef SHOW_ME_VAPPEND_PRINTF
297 /* so owe don't create an include depndency, this is just visible on demand. */
298 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
300 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
301 void StrBufCutLeft(StrBuf *Buf, int nChars);
302 void StrBufCutRight(StrBuf *Buf, int nChars);
303 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
304 void StrBufTrim(StrBuf *Buf);
305 void StrBufUpCase(StrBuf *Buf);
306 void StrBufLowerCase(StrBuf *Buf);
307 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
308 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
309 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
311 void StrBufToUnixLF(StrBuf *buf);
312 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
314 int CompressBuffer(StrBuf *Buf);
315 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
316 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
317 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
318 int StrBufDecodeBase64(StrBuf *Buf);
319 int StrBufDecodeHex(StrBuf *Buf);
320 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
321 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
322 #define LB (1) /* Internal escape chars */
325 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
326 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
327 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
328 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
329 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
330 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
331 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
333 long StrTol(const StrBuf *Buf);
334 int StrToi(const StrBuf *Buf);
335 int StrBufIsNumber(const StrBuf *Buf);
336 long StrBuf_Utf8StrLen(StrBuf *Buf);
337 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
339 const char *GuessMimeType(const char *data, size_t dlen);
340 const char* GuessMimeByFilename(const char *what, size_t len);
342 /* Run once at Programstart */
343 int LoadIconDir(const char *DirName);
345 /* Select the icon for a given MIME type */
346 const char *GetIconFilename(char *MimeType, size_t len);
352 int safestrncpy(char *dest, const char *src, size_t n);
353 int num_tokens (const char *source, char tok);
354 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
355 long grab_token(char **dest, const char *source, int parmnum, char separator);
356 int extract_int (const char *source, int parmnum);
357 long extract_long (const char *source, int parmnum);
358 unsigned long extract_unsigned_long(const char *source, int parmnum);
359 void CtdlInitBase64Table(void);
360 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
361 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
362 unsigned int decode_hex(char *Source);
363 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
364 void StripSlashes(char *Dir, int TrailingSlash);
365 size_t striplt(char *);
366 int haschar(const char *st, int ch);
367 void remove_token(char *source, int parmnum, char separator);
368 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
369 int is_msg_in_sequence_set(const char *mset, long msgnum);
370 char *memreadline(char *start, char *buf, int maxlen);
371 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
372 #define IsEmptyStr(a) ((a)[0] == '\0')
373 #define num_parms(source) num_tokens(source,(char)'|')
374 int stripout(char *str, char leftboundary, char rightboundary);
375 void stripallbut(char *str, char leftboundary, char rightboundary);
376 char *myfgets(char *s, int size, FILE *stream);
377 void urlesc(char *outbuf, size_t oblen, char *strbuf);
378 char *CtdlTempFileName(char *prefix1, int prefix2);
379 FILE *CtdlTempFile(void);
380 void generate_uuid(char *buf);
381 char *bmstrcasestr(char *text, char *pattern);
382 char *bmstrcasestr_len(char *text, size_t textlen, char *pattern, size_t patlen);
383 void CtdlMakeTempFileName(char *name, int len);
384 char *rfc2047encode(char *line, long length);
385 int is_msg_in_mset(const char *mset, long msgnum);
386 int pattern2(char *search, char *patn);
387 void stripltlen(char *, int *);
388 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
389 void LoadEntityList(char *FileName);
395 #define CTDL_VCARD_MAGIC 0xa1f9
397 /* This data structure represents a vCard object currently in memory. */
408 struct vCard *vcard_new(void);
409 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
410 struct vCard *vcard_load(char *vtext);
411 struct vCard *VCardLoad(StrBuf *vbtext);
413 void vcard_free(struct vCard *);
414 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
415 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
416 int instance, int return_propname);
417 char *vcard_serialize(struct vCard *);
418 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
419 void remove_charset_attribute(char *strbuf);
420 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
423 * Hash list implementation for Citadel
425 #define HKEY(a) a, (sizeof(a) - 1)
427 typedef struct HashList HashList;
429 typedef struct HashKey HashKey;
431 typedef struct HashPos HashPos;
433 typedef void (*DeleteHashDataFunc)(void * Data);
434 typedef const char *(*PrintHashContent)(void * Data);
435 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
436 typedef int (*HashFunc)(const char *Str, long Len);
437 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
438 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
440 int Flathash(const char *str, long len);
441 #define IKEY(a) (const char*) &a, sizeof(a)
443 HashList *NewHash(int Uniq, HashFunc F);
444 void DeleteHash(HashList **Hash);
445 void HDeleteHash(void *vHash);
446 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
447 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
448 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
449 int GetHashKeys(HashList *Hash, char ***List);
450 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
451 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
452 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
453 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
454 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
455 int GetHashPosCounter(HashList *Hash, HashPos *At);
456 void DeleteHashPos(HashPos **DelMe);
457 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
458 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
459 void SortByHashKey(HashList *Hash, int Order);
460 void SortByHashKeyStr(HashList *Hash);
461 int GetCount(HashList *Hash);
462 const void *GetSearchPayload(const void *HashVoid);
463 void SortByPayload(HashList *Hash, CompareFunc SortBy);
464 void generic_free_handler(void *ptr);
465 void reference_free_handler(void *ptr);
466 int HashLittle(const void *key, size_t length);
469 void convert_spaces_to_underscores(char *str);
472 * Convert 4 bytes char into an Integer.
473 * usefull for easy inexpensive hashing
474 * of for char strings.
476 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
478 /* vNote implementation */
480 #define CTDL_VNOTE_MAGIC 0xa1fa
498 struct vnote *vnote_new(void);
499 struct vnote *vnote_new_from_str(char *s);
500 void vnote_free(struct vnote *v);
501 char *vnote_serialize(struct vnote *v);
502 void vnote_serialize_output_field(char *append_to, char *field, char *label);
508 * Create JSON style structures in C plus serialize them to one string
511 typedef struct JsonValue JsonValue;
514 void DeleteJSONValue(void *vJsonValue);
516 JsonValue *NewJsonObject(const char *Key, long keylen);
518 JsonValue *NewJsonArray(const char *Key, long keylen);
520 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
522 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
524 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
526 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
528 JsonValue *NewJsonNull(const char *Key, long keylen);
530 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
532 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
534 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
536 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
541 * Citadels Wildfire implementation, see
542 * http://www.firephp.org/Wiki/Reference/Protocol
543 * and http://wildfirehq.org/ for details
545 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
547 typedef enum _WF_MessageType {
556 JsonValue *WildFireException(const char *Filename, long FileLen,
561 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
563 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
565 const char *Message, long len,
566 WF_MessageType Type);
568 JsonValue *WildFireMessage(const char *Filename, long fnlen,
571 WF_MessageType Type);
573 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
575 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
578 #define WF_STRUCTINDEX "1"
582 #endif // LIBCITADEL_H