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.
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 */
74 * Note that not all views are implemented in all clients.
76 #define VIEW_BBS 0 /* Bulletin board view */
77 #define VIEW_MAILBOX 1 /* Mailbox summary */
78 #define VIEW_ADDRESSBOOK 2 /* Address book view */
79 #define VIEW_CALENDAR 3 /* Calendar view */
80 #define VIEW_TASKS 4 /* Tasks view */
81 #define VIEW_NOTES 5 /* Notes view */
82 #define VIEW_WIKI 6 /* Wiki view */
83 #define VIEW_CALBRIEF 7 /* Brief Calendar view */
84 #define VIEW_JOURNAL 8 /* Journal view */
85 #define VIEW_BLOG 9 /* Blog view (not yet implemented) */
89 #define IsEmptyStr(a) ((a)[0] == '\0')
93 * another word to indicate n/a for a pointer if NULL already has a "meaning"
95 extern const char *StrBufNOTNULL;
101 char *libcitadel_version_string(void);
102 int libcitadel_version_number(void);
103 void StartLibCitadel(size_t basesize);
104 void ShutDownLibCitadel(void);
107 * MIME parser declarations
110 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
112 void mime_parser(char *content_start, char *content_end,
125 void (*PreMultiPartCallBack)
137 void (*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,
174 void (*PreMultiPartCallBack)
186 void (*PostMultiPartCallBack)
201 void the_mime_parser(char *partnum,
202 char *content_start, char *content_end,
215 void (*PreMultiPartCallBack)
227 void (*PostMultiPartCallBack)
243 typedef struct StrBuf StrBuf;
245 typedef struct _ConstStr {
249 #define CKEY(a) (a).Key, (a).len
251 StrBuf* NewStrBuf(void);
252 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
253 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
254 long StrBufShrinkToFit(StrBuf *Buf, int Force);
255 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
257 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
258 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
259 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
260 void FreeStrBuf (StrBuf **FreeMe);
261 char *SmashStrBuf (StrBuf **SmashMe);
262 void HFreeStrBuf (void *VFreeMe);
263 int FlushStrBuf(StrBuf *buf);
264 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
266 const char *ChrPtr(const StrBuf *Str);
267 int StrLength(const StrBuf *Str);
268 #define SKEY(a) ChrPtr(a), StrLength(a)
269 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
271 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
272 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
275 int StrBufReadBLOBBuffered(StrBuf *Buf,
283 int StrBufTCP_read_buffered_line(StrBuf *Line,
287 int selectresolution,
289 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
294 int selectresolution,
297 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
298 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
299 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
301 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
302 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
303 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
304 int StrBufNum_tokens(const StrBuf *source, char tok);
305 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
307 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
308 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
309 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
310 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
311 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
312 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
315 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
316 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
317 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
318 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
319 #ifdef SHOW_ME_VAPPEND_PRINTF
320 /* so owe don't create an include depndency, this is just visible on demand. */
321 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
323 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
324 void StrBufCutLeft(StrBuf *Buf, int nChars);
325 void StrBufCutRight(StrBuf *Buf, int nChars);
326 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
327 void StrBufTrim(StrBuf *Buf);
328 void StrBufUpCase(StrBuf *Buf);
329 void StrBufLowerCase(StrBuf *Buf);
330 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
331 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
332 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
334 void StrBufToUnixLF(StrBuf *buf);
335 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
337 int CompressBuffer(StrBuf *Buf);
338 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
339 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
340 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
341 int StrBufDecodeBase64(StrBuf *Buf);
342 int StrBufDecodeHex(StrBuf *Buf);
343 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
344 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
345 #define LB (1) /* Internal escape chars */
348 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
349 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
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);
375 int safestrncpy(char *dest, const char *src, size_t n);
376 int num_tokens (const char *source, char tok);
377 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
378 long grab_token(char **dest, const char *source, int parmnum, char separator);
379 int extract_int (const char *source, int parmnum);
380 long extract_long (const char *source, int parmnum);
381 unsigned long extract_unsigned_long(const char *source, int parmnum);
382 void CtdlInitBase64Table(void);
383 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
384 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
385 unsigned int decode_hex(char *Source);
386 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
387 void StripSlashes(char *Dir, int TrailingSlash);
388 size_t striplt(char *);
389 int haschar(const char *st, int ch);
390 void remove_token(char *source, int parmnum, char separator);
391 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
392 int is_msg_in_sequence_set(const char *mset, long msgnum);
393 const char *memreadline(const char *start, char *buf, int maxlen);
394 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
395 #define IsEmptyStr(a) ((a)[0] == '\0')
396 #define num_parms(source) num_tokens(source,(char)'|')
397 int stripout(char *str, char leftboundary, char rightboundary);
398 void stripallbut(char *str, char leftboundary, char rightboundary);
399 char *myfgets(char *s, int size, FILE *stream);
400 void urlesc(char *outbuf, size_t oblen, char *strbuf);
401 char *CtdlTempFileName(char *prefix1, int prefix2);
402 FILE *CtdlTempFile(void);
403 void generate_uuid(char *buf);
404 const char *bmstrcasestr(const char *text, const char *pattern);
405 const char *bmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
406 void CtdlMakeTempFileName(char *name, int len);
407 char *rfc2047encode(char *line, long length);
408 int is_msg_in_mset(const char *mset, long msgnum);
409 int pattern2(char *search, char *patn);
410 void stripltlen(char *, int *);
411 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
412 void LoadEntityList(char *FileName);
418 #define CTDL_VCARD_MAGIC 0xa1f9
420 /* This data structure represents a vCard object currently in memory. */
431 struct vCard *vcard_new(void);
432 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
433 struct vCard *vcard_load(char *vtext);
434 struct vCard *VCardLoad(StrBuf *vbtext);
436 void vcard_free(struct vCard *);
437 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
438 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
439 int instance, int return_propname);
440 char *vcard_serialize(struct vCard *);
441 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
442 void remove_charset_attribute(char *strbuf);
443 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
446 * Hash list implementation for Citadel
448 #define HKEY(a) a, (sizeof(a) - 1)
450 typedef struct HashList HashList;
452 typedef struct HashKey HashKey;
454 typedef struct HashPos HashPos;
456 typedef void (*DeleteHashDataFunc)(void * Data);
457 typedef const char *(*PrintHashContent)(void * Data);
458 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
459 typedef int (*HashFunc)(const char *Str, long Len);
460 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
461 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
463 int Flathash(const char *str, long len);
464 #define IKEY(a) (const char*) &a, sizeof(a)
466 HashList *NewHash(int Uniq, HashFunc F);
467 void DeleteHash(HashList **Hash);
468 void HDeleteHash(void *vHash);
469 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
470 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
471 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
472 int GetHashKeys(HashList *Hash, char ***List);
473 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
474 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
475 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
476 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
477 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
478 int GetHashPosCounter(HashList *Hash, HashPos *At);
479 void DeleteHashPos(HashPos **DelMe);
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 generic_free_handler(void *ptr);
488 void reference_free_handler(void *ptr);
489 int HashLittle(const void *key, size_t length);
492 void convert_spaces_to_underscores(char *str);
495 * Convert 4 bytes char into an Integer.
496 * usefull for easy inexpensive hashing
497 * of for char strings.
499 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
501 /* vNote implementation */
503 #define CTDL_VNOTE_MAGIC 0xa1fa
521 struct vnote *vnote_new(void);
522 struct vnote *vnote_new_from_str(char *s);
523 void vnote_free(struct vnote *v);
524 char *vnote_serialize(struct vnote *v);
525 void vnote_serialize_output_field(char *append_to, char *field, char *label);
531 * Create JSON style structures in C plus serialize them to one string
534 typedef struct JsonValue JsonValue;
537 void DeleteJSONValue(void *vJsonValue);
539 JsonValue *NewJsonObject(const char *Key, long keylen);
541 JsonValue *NewJsonArray(const char *Key, long keylen);
543 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
545 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
547 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
549 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
551 JsonValue *NewJsonNull(const char *Key, long keylen);
553 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
555 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
557 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
559 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
564 * Citadels Wildfire implementation, see
565 * http://www.firephp.org/Wiki/Reference/Protocol
566 * and http://wildfirehq.org/ for details
568 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
570 typedef enum _WF_MessageType {
579 JsonValue *WildFireException(const char *Filename, long FileLen,
584 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
586 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
588 const char *Message, long len,
589 WF_MessageType Type);
591 JsonValue *WildFireMessage(const char *Filename, long fnlen,
594 WF_MessageType Type);
596 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
598 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
601 #define WF_STRUCTINDEX "1"
605 #endif // LIBCITADEL_H