7 /* protect against double includes */
13 * since we reference time_t...
18 #define LIBCITADEL_VERSION_NUMBER 763
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 */
65 #define IsEmptyStr(a) ((a)[0] == '\0')
69 * another word to indicate n/a for a pointer if NULL already has a "meaning"
71 extern const char *StrBufNOTNULL;
77 char *libcitadel_version_string(void);
78 int libcitadel_version_number(void);
79 void StartLibCitadel(size_t basesize);
80 void ShutDownLibCitadel(void);
83 * MIME parser declarations
86 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen);
88 void mime_parser(char *content_start, char *content_end,
101 void (*PreMultiPartCallBack)
113 void (*PostMultiPartCallBack)
131 char *fixed_partnum(char *);
132 void mime_decode(char *partnum,
133 char *part_start, size_t length,
134 char *content_type, char *charset, char *encoding,
137 char *name, char *filename,
150 void (*PreMultiPartCallBack)
162 void (*PostMultiPartCallBack)
177 void the_mime_parser(char *partnum,
178 char *content_start, char *content_end,
191 void (*PreMultiPartCallBack)
203 void (*PostMultiPartCallBack)
219 typedef struct StrBuf StrBuf;
221 typedef struct _ConstStr {
225 #define CKEY(a) (a).Key, (a).len
227 StrBuf* NewStrBuf(void);
228 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
229 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
230 long StrBufShrinkToFit(StrBuf *Buf, int Force);
231 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
233 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
234 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
235 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
236 void FreeStrBuf (StrBuf **FreeMe);
237 void HFreeStrBuf (void *VFreeMe);
238 int FlushStrBuf(StrBuf *buf);
239 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
241 const char *ChrPtr(const StrBuf *Str);
242 int StrLength(const StrBuf *Str);
243 #define SKEY(a) ChrPtr(a), StrLength(a)
244 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
246 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
247 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
250 int StrBufReadBLOBBuffered(StrBuf *Buf,
258 int StrBufTCP_read_buffered_line(StrBuf *Line,
262 int selectresolution,
264 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
269 int selectresolution,
272 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
273 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
274 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
276 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
277 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
278 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
279 int StrBufNum_tokens(const StrBuf *source, char tok);
280 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
282 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
283 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
284 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
285 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
286 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
287 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
290 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
291 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
292 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
293 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
294 #ifdef SHOW_ME_VAPPEND_PRINTF
295 /* so owe don't create an include depndency, this is just visible on demand. */
296 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
298 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
299 void StrBufCutLeft(StrBuf *Buf, int nChars);
300 void StrBufCutRight(StrBuf *Buf, int nChars);
301 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
302 void StrBufTrim(StrBuf *Buf);
303 void StrBufUpCase(StrBuf *Buf);
304 void StrBufLowerCase(StrBuf *Buf);
305 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
306 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
307 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
309 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
311 int CompressBuffer(StrBuf *Buf);
312 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
313 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
314 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
315 int StrBufDecodeBase64(StrBuf *Buf);
316 int StrBufDecodeHex(StrBuf *Buf);
317 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
318 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
319 #define LB (1) /* Internal escape chars */
322 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
323 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
324 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
325 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
326 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
328 long StrTol(const StrBuf *Buf);
329 int StrToi(const StrBuf *Buf);
330 int StrBufIsNumber(const StrBuf *Buf);
331 long StrBuf_Utf8StrLen(StrBuf *Buf);
332 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
334 const char *GuessMimeType(const char *data, size_t dlen);
335 const char* GuessMimeByFilename(const char *what, size_t len);
337 /* Run once at Programstart */
338 int LoadIconDir(const char *DirName);
340 /* Select the icon for a given MIME type */
341 const char *GetIconFilename(char *MimeType, size_t len);
347 int safestrncpy(char *dest, const char *src, size_t n);
348 int num_tokens (const char *source, char tok);
349 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
350 long grab_token(char **dest, const char *source, int parmnum, char separator);
351 int extract_int (const char *source, int parmnum);
352 long extract_long (const char *source, int parmnum);
353 unsigned long extract_unsigned_long(const char *source, int parmnum);
354 void CtdlInitBase64Table(void);
355 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
356 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
357 unsigned int decode_hex(char *Source);
358 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
359 void StripSlashes(char *Dir, int TrailingSlash);
360 size_t striplt(char *);
361 int haschar(const char *st, int ch);
362 void remove_token(char *source, int parmnum, char separator);
363 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
364 int is_msg_in_sequence_set(const char *mset, long msgnum);
365 char *memreadline(char *start, char *buf, int maxlen);
366 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
367 #define IsEmptyStr(a) ((a)[0] == '\0')
368 #define num_parms(source) num_tokens(source,(char)'|')
369 int stripout(char *str, char leftboundary, char rightboundary);
370 void stripallbut(char *str, char leftboundary, char rightboundary);
371 char *myfgets(char *s, int size, FILE *stream);
372 void urlesc(char *outbuf, size_t oblen, char *strbuf);
373 char *CtdlTempFileName(char *prefix1, int prefix2);
374 FILE *CtdlTempFile(void);
375 void generate_uuid(char *buf);
376 char *bmstrcasestr(char *text, char *pattern);
377 char *bmstrcasestr_len(char *text, size_t textlen, char *pattern, size_t patlen);
378 void CtdlMakeTempFileName(char *name, int len);
379 char *rfc2047encode(char *line, long length);
380 int is_msg_in_mset(const char *mset, long msgnum);
381 int pattern2(char *search, char *patn);
382 void stripltlen(char *, int *);
383 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
384 void LoadEntityList(char *FileName);
390 #define CTDL_VCARD_MAGIC 0xa1f9
392 /* This data structure represents a vCard object currently in memory. */
403 struct vCard *vcard_new(void);
404 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
405 struct vCard *vcard_load(char *vtext);
406 struct vCard *VCardLoad(StrBuf *vbtext);
408 void vcard_free(struct vCard *);
409 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
410 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
411 int instance, int return_propname);
412 char *vcard_serialize(struct vCard *);
413 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
414 void remove_charset_attribute(char *strbuf);
415 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
418 * Hash list implementation for Citadel
420 #define HKEY(a) a, (sizeof(a) - 1)
422 typedef struct HashList HashList;
424 typedef struct HashKey HashKey;
426 typedef struct HashPos HashPos;
428 typedef void (*DeleteHashDataFunc)(void * Data);
429 typedef const char *(*PrintHashContent)(void * Data);
430 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
431 typedef int (*HashFunc)(const char *Str, long Len);
432 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
433 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
435 int Flathash(const char *str, long len);
436 #define IKEY(a) (const char*) &a, sizeof(a)
438 HashList *NewHash(int Uniq, HashFunc F);
439 void DeleteHash(HashList **Hash);
440 void HDeleteHash(void *vHash);
441 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
442 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
443 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
444 int GetHashKeys(HashList *Hash, char ***List);
445 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
446 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
447 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
448 int GetHashPosCounter(HashPos *At);
449 void DeleteHashPos(HashPos **DelMe);
450 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
451 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
452 void SortByHashKey(HashList *Hash, int Order);
453 void SortByHashKeyStr(HashList *Hash);
454 int GetCount(HashList *Hash);
455 const void *GetSearchPayload(const void *HashVoid);
456 void SortByPayload(HashList *Hash, CompareFunc SortBy);
457 void generic_free_handler(void *ptr);
458 void reference_free_handler(void *ptr);
459 int HashLittle(const void *key, size_t length);
462 void convert_spaces_to_underscores(char *str);
465 * Convert 4 bytes char into an Integer.
466 * usefull for easy inexpensive hashing
467 * of for char strings.
469 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
471 /* vNote implementation */
473 #define CTDL_VNOTE_MAGIC 0xa1fa
491 struct vnote *vnote_new(void);
492 struct vnote *vnote_new_from_str(char *s);
493 void vnote_free(struct vnote *v);
494 char *vnote_serialize(struct vnote *v);
495 void vnote_serialize_output_field(char *append_to, char *field, char *label);
501 * Create JSON style structures in C plus serialize them to one string
504 typedef struct JsonValue JsonValue;
507 void DeleteJSONValue(void *vJsonValue);
509 JsonValue *NewJsonObject(const char *Key, long keylen);
511 JsonValue *NewJsonArray(const char *Key, long keylen);
513 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
515 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
517 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
519 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
521 JsonValue *NewJsonNull(const char *Key, long keylen);
523 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
525 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
527 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
529 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
534 * Citadels Wildfire implementation, see
535 * http://www.firephp.org/Wiki/Reference/Protocol
536 * and http://wildfirehq.org/ for details
538 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
540 typedef enum _WF_MessageType {
549 JsonValue *WildFireException(const char *Filename, long FileLen,
554 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
556 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
558 const char *Message, long len,
559 WF_MessageType Type);
561 JsonValue *WildFireMessage(const char *Filename, long fnlen,
564 WF_MessageType Type);
566 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
568 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
571 #define WF_STRUCTINDEX "1"
575 #endif // LIBCITADEL_H