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 */
48 typedef enum AXLevel {
60 * Note that not all views are implemented in all clients.
62 #define VIEW_BBS 0 /* Bulletin board view */
63 #define VIEW_MAILBOX 1 /* Mailbox summary */
64 #define VIEW_ADDRESSBOOK 2 /* Address book view */
65 #define VIEW_CALENDAR 3 /* Calendar view */
66 #define VIEW_TASKS 4 /* Tasks view */
67 #define VIEW_NOTES 5 /* Notes view */
68 #define VIEW_WIKI 6 /* Wiki view */
69 #define VIEW_CALBRIEF 7 /* Brief Calendar view */
70 #define VIEW_JOURNAL 8 /* Journal view */
71 #define VIEW_BLOG 9 /* Blog view (not yet implemented) */
75 #define IsEmptyStr(a) ((a)[0] == '\0')
79 * another word to indicate n/a for a pointer if NULL already has a "meaning"
81 extern const char *StrBufNOTNULL;
87 char *libcitadel_version_string(void);
88 int libcitadel_version_number(void);
89 void StartLibCitadel(size_t basesize);
90 void ShutDownLibCitadel(void);
93 * MIME parser declarations
96 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
98 void mime_parser(char *content_start, char *content_end,
111 void (*PreMultiPartCallBack)
123 void (*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,
160 void (*PreMultiPartCallBack)
172 void (*PostMultiPartCallBack)
187 void the_mime_parser(char *partnum,
188 char *content_start, char *content_end,
201 void (*PreMultiPartCallBack)
213 void (*PostMultiPartCallBack)
229 typedef struct StrBuf StrBuf;
231 typedef struct _ConstStr {
235 #define CKEY(a) (a).Key, (a).len
237 StrBuf* NewStrBuf(void);
238 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
239 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
240 long StrBufShrinkToFit(StrBuf *Buf, int Force);
241 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
243 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
244 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
245 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
246 void FreeStrBuf (StrBuf **FreeMe);
247 char *SmashStrBuf (StrBuf **SmashMe);
248 void HFreeStrBuf (void *VFreeMe);
249 int FlushStrBuf(StrBuf *buf);
250 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
252 const char *ChrPtr(const StrBuf *Str);
253 int StrLength(const StrBuf *Str);
254 #define SKEY(a) ChrPtr(a), StrLength(a)
255 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
257 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
258 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
261 int StrBufReadBLOBBuffered(StrBuf *Buf,
269 int StrBufTCP_read_buffered_line(StrBuf *Line,
273 int selectresolution,
275 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
280 int selectresolution,
283 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
284 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
285 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
287 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
288 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
289 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
290 int StrBufNum_tokens(const StrBuf *source, char tok);
291 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
293 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
294 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
295 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
296 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
297 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
298 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
301 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
302 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
303 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
304 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
305 #ifdef SHOW_ME_VAPPEND_PRINTF
306 /* so owe don't create an include depndency, this is just visible on demand. */
307 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
309 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
310 void StrBufCutLeft(StrBuf *Buf, int nChars);
311 void StrBufCutRight(StrBuf *Buf, int nChars);
312 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
313 void StrBufTrim(StrBuf *Buf);
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_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
327 int StrBufDecodeBase64(StrBuf *Buf);
328 int StrBufDecodeHex(StrBuf *Buf);
329 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
330 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
331 #define LB (1) /* Internal escape chars */
334 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
335 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
336 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
337 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
338 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
339 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
340 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
342 long StrTol(const StrBuf *Buf);
343 int StrToi(const StrBuf *Buf);
344 int StrBufIsNumber(const StrBuf *Buf);
345 long StrBuf_Utf8StrLen(StrBuf *Buf);
346 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
348 const char *GuessMimeType(const char *data, size_t dlen);
349 const char* GuessMimeByFilename(const char *what, size_t len);
351 /* Run once at Programstart */
352 int LoadIconDir(const char *DirName);
354 /* Select the icon for a given MIME type */
355 const char *GetIconFilename(char *MimeType, size_t len);
361 int safestrncpy(char *dest, const char *src, size_t n);
362 int num_tokens (const char *source, char tok);
363 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
364 long grab_token(char **dest, const char *source, int parmnum, char separator);
365 int extract_int (const char *source, int parmnum);
366 long extract_long (const char *source, int parmnum);
367 unsigned long extract_unsigned_long(const char *source, int parmnum);
368 void CtdlInitBase64Table(void);
369 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
370 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
371 unsigned int decode_hex(char *Source);
372 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
373 void StripSlashes(char *Dir, int TrailingSlash);
374 size_t striplt(char *);
375 int haschar(const char *st, int ch);
376 void remove_token(char *source, int parmnum, char separator);
377 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
378 int is_msg_in_sequence_set(const char *mset, long msgnum);
379 const char *memreadline(const char *start, char *buf, int maxlen);
380 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
381 #define IsEmptyStr(a) ((a)[0] == '\0')
382 #define num_parms(source) num_tokens(source,(char)'|')
383 int stripout(char *str, char leftboundary, char rightboundary);
384 void stripallbut(char *str, char leftboundary, char rightboundary);
385 char *myfgets(char *s, int size, FILE *stream);
386 void urlesc(char *outbuf, size_t oblen, char *strbuf);
387 char *CtdlTempFileName(char *prefix1, int prefix2);
388 FILE *CtdlTempFile(void);
389 void generate_uuid(char *buf);
390 const char *bmstrcasestr(const char *text, const char *pattern);
391 const char *bmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
392 void CtdlMakeTempFileName(char *name, int len);
393 char *rfc2047encode(char *line, long length);
394 int is_msg_in_mset(const char *mset, long msgnum);
395 int pattern2(char *search, char *patn);
396 void stripltlen(char *, int *);
397 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
398 void LoadEntityList(char *FileName);
404 #define CTDL_VCARD_MAGIC 0xa1f9
406 /* This data structure represents a vCard object currently in memory. */
417 struct vCard *vcard_new(void);
418 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
419 struct vCard *vcard_load(char *vtext);
420 struct vCard *VCardLoad(StrBuf *vbtext);
422 void vcard_free(struct vCard *);
423 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
424 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
425 int instance, int return_propname);
426 char *vcard_serialize(struct vCard *);
427 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
428 void remove_charset_attribute(char *strbuf);
429 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
432 * Hash list implementation for Citadel
434 #define HKEY(a) a, (sizeof(a) - 1)
436 typedef struct HashList HashList;
438 typedef struct HashKey HashKey;
440 typedef struct HashPos HashPos;
442 typedef void (*DeleteHashDataFunc)(void * Data);
443 typedef const char *(*PrintHashContent)(void * Data);
444 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
445 typedef int (*HashFunc)(const char *Str, long Len);
446 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
447 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
449 int Flathash(const char *str, long len);
450 #define IKEY(a) (const char*) &a, sizeof(a)
452 HashList *NewHash(int Uniq, HashFunc F);
453 void DeleteHash(HashList **Hash);
454 void HDeleteHash(void *vHash);
455 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
456 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
457 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
458 int GetHashKeys(HashList *Hash, char ***List);
459 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
460 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
461 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
462 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
463 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
464 int GetHashPosCounter(HashList *Hash, HashPos *At);
465 void DeleteHashPos(HashPos **DelMe);
466 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
467 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
468 void SortByHashKey(HashList *Hash, int Order);
469 void SortByHashKeyStr(HashList *Hash);
470 int GetCount(HashList *Hash);
471 const void *GetSearchPayload(const void *HashVoid);
472 void SortByPayload(HashList *Hash, CompareFunc SortBy);
473 void generic_free_handler(void *ptr);
474 void reference_free_handler(void *ptr);
475 int HashLittle(const void *key, size_t length);
478 void convert_spaces_to_underscores(char *str);
481 * Convert 4 bytes char into an Integer.
482 * usefull for easy inexpensive hashing
483 * of for char strings.
485 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
487 /* vNote implementation */
489 #define CTDL_VNOTE_MAGIC 0xa1fa
507 struct vnote *vnote_new(void);
508 struct vnote *vnote_new_from_str(char *s);
509 void vnote_free(struct vnote *v);
510 char *vnote_serialize(struct vnote *v);
511 void vnote_serialize_output_field(char *append_to, char *field, char *label);
517 * Create JSON style structures in C plus serialize them to one string
520 typedef struct JsonValue JsonValue;
523 void DeleteJSONValue(void *vJsonValue);
525 JsonValue *NewJsonObject(const char *Key, long keylen);
527 JsonValue *NewJsonArray(const char *Key, long keylen);
529 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
531 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
533 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
535 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
537 JsonValue *NewJsonNull(const char *Key, long keylen);
539 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
541 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
543 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
545 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
550 * Citadels Wildfire implementation, see
551 * http://www.firephp.org/Wiki/Reference/Protocol
552 * and http://wildfirehq.org/ for details
554 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
556 typedef enum _WF_MessageType {
565 JsonValue *WildFireException(const char *Filename, long FileLen,
570 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
572 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
574 const char *Message, long len,
575 WF_MessageType Type);
577 JsonValue *WildFireMessage(const char *Filename, long fnlen,
580 WF_MessageType Type);
582 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
584 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
587 #define WF_STRUCTINDEX "1"
591 #endif // LIBCITADEL_H