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 {
61 lastsent, /* Server internal use only */
72 typedef enum __GPEXWhichPolicy {
82 * Note that not all views are implemented in all clients.
84 #define VIEW_BBS 0 /* Bulletin board view */
85 #define VIEW_MAILBOX 1 /* Mailbox summary */
86 #define VIEW_ADDRESSBOOK 2 /* Address book view */
87 #define VIEW_CALENDAR 3 /* Calendar view */
88 #define VIEW_TASKS 4 /* Tasks view */
89 #define VIEW_NOTES 5 /* Notes view */
90 #define VIEW_WIKI 6 /* Wiki view */
91 #define VIEW_CALBRIEF 7 /* Brief Calendar view */
92 #define VIEW_JOURNAL 8 /* Journal view */
93 #define VIEW_BLOG 9 /* Blog view (not yet implemented) */
97 #define IsEmptyStr(a) ((a)[0] == '\0')
102 * another word to indicate n/a for a pointer if NULL already has a "meaning"
104 extern const char *StrBufNOTNULL;
110 char *libcitadel_version_string(void);
111 int libcitadel_version_number(void);
112 void StartLibCitadel(size_t basesize);
113 void ShutDownLibCitadel(void);
116 * MIME parser declarations
119 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
121 void mime_parser(char *content_start, char *content_end,
134 void (*PreMultiPartCallBack)
146 void (*PostMultiPartCallBack)
164 char *fixed_partnum(char *);
165 void mime_decode(char *partnum,
166 char *part_start, size_t length,
167 char *content_type, char *charset, char *encoding,
170 char *name, char *filename,
183 void (*PreMultiPartCallBack)
195 void (*PostMultiPartCallBack)
210 void the_mime_parser(char *partnum,
211 char *content_start, char *content_end,
224 void (*PreMultiPartCallBack)
236 void (*PostMultiPartCallBack)
252 typedef struct StrBuf StrBuf;
255 #define CStrOf(a) #a, sizeof(#a) - 1
256 typedef struct _ConstStr {
260 #define CKEY(a) (a).Key, (a).len
262 StrBuf* NewStrBuf(void);
263 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
264 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
265 long StrBufShrinkToFit(StrBuf *Buf, int Force);
266 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
268 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
269 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
270 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
271 void FreeStrBuf (StrBuf **FreeMe);
272 char *SmashStrBuf (StrBuf **SmashMe);
273 void HFreeStrBuf (void *VFreeMe);
274 int FlushStrBuf(StrBuf *buf);
275 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
277 const char *ChrPtr(const StrBuf *Str);
278 int StrLength(const StrBuf *Str);
279 #define SKEY(a) ChrPtr(a), StrLength(a)
280 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
281 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
283 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
284 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
287 int StrBufReadBLOBBuffered(StrBuf *Buf,
295 int StrBufTCP_read_buffered_line(StrBuf *Line,
299 int selectresolution,
301 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
306 int selectresolution,
309 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
310 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
311 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
312 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
314 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
315 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
316 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
317 int StrBufNum_tokens(const StrBuf *source, char tok);
318 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
320 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
321 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
322 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
323 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
324 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
325 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
328 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
329 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
330 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
331 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
332 #ifdef SHOW_ME_VAPPEND_PRINTF
333 /* so owe don't create an include depndency, this is just visible on demand. */
334 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
336 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
337 void StrBufCutLeft(StrBuf *Buf, int nChars);
338 void StrBufCutRight(StrBuf *Buf, int nChars);
339 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
340 void StrBufTrim(StrBuf *Buf);
341 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
342 void StrBufUpCase(StrBuf *Buf);
343 void StrBufLowerCase(StrBuf *Buf);
344 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
345 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
346 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
348 void StrBufToUnixLF(StrBuf *buf);
349 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
351 int CompressBuffer(StrBuf *Buf);
352 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
353 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
354 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
355 int StrBufDecodeBase64(StrBuf *Buf);
356 int StrBufDecodeHex(StrBuf *Buf);
357 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
358 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
359 #define LB (1) /* Internal escape chars */
362 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
363 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
364 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
365 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
366 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
367 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
368 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
370 long StrTol(const StrBuf *Buf);
371 int StrToi(const StrBuf *Buf);
372 int StrBufIsNumber(const StrBuf *Buf);
373 long StrBuf_Utf8StrLen(StrBuf *Buf);
374 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
376 const char *GuessMimeType(const char *data, size_t dlen);
377 const char* GuessMimeByFilename(const char *what, size_t len);
379 /* Run once at Programstart */
380 int LoadIconDir(const char *DirName);
382 /* Select the icon for a given MIME type */
383 const char *GetIconFilename(char *MimeType, size_t len);
389 int safestrncpy(char *dest, const char *src, size_t n);
390 int num_tokens (const char *source, char tok);
391 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
392 long grab_token(char **dest, const char *source, int parmnum, char separator);
393 int extract_int (const char *source, int parmnum);
394 long extract_long (const char *source, int parmnum);
395 unsigned long extract_unsigned_long(const char *source, int parmnum);
396 void CtdlInitBase64Table(void);
397 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
398 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
399 unsigned int decode_hex(char *Source);
400 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
401 void StripSlashes(char *Dir, int TrailingSlash);
402 size_t striplt(char *);
403 int haschar(const char *st, int ch);
404 void remove_token(char *source, int parmnum, char separator);
405 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
406 int is_msg_in_sequence_set(const char *mset, long msgnum);
407 const char *memreadline(const char *start, char *buf, int maxlen);
408 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
409 #define IsEmptyStr(a) ((a)[0] == '\0')
410 #define num_parms(source) num_tokens(source,(char)'|')
411 int stripout(char *str, char leftboundary, char rightboundary);
412 void stripallbut(char *str, char leftboundary, char rightboundary);
413 char *myfgets(char *s, int size, FILE *stream);
414 void urlesc(char *outbuf, size_t oblen, char *strbuf);
415 char *CtdlTempFileName(char *prefix1, int prefix2);
416 FILE *CtdlTempFile(void);
417 void generate_uuid(char *buf);
418 const char *bmstrcasestr(const char *text, const char *pattern);
419 const char *bmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
420 void CtdlMakeTempFileName(char *name, int len);
421 char *rfc2047encode(char *line, long length);
422 int is_msg_in_mset(const char *mset, long msgnum);
423 int pattern2(char *search, char *patn);
424 void stripltlen(char *, int *);
425 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
426 void LoadEntityList(char *FileName);
432 #define CTDL_VCARD_MAGIC 0xa1f9
434 /* This data structure represents a vCard object currently in memory. */
445 struct vCard *vcard_new(void);
446 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
447 struct vCard *vcard_load(char *vtext);
448 struct vCard *VCardLoad(StrBuf *vbtext);
450 void vcard_free(struct vCard *);
451 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
452 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
453 int instance, int return_propname);
454 char *vcard_serialize(struct vCard *);
455 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
456 void remove_charset_attribute(char *strbuf);
457 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
460 * Hash list implementation for Citadel
462 #define HKEY(a) a, (sizeof(a) - 1)
464 typedef struct HashList HashList;
466 typedef struct HashKey HashKey;
468 typedef struct HashPos HashPos;
470 typedef void (*DeleteHashDataFunc)(void * Data);
471 typedef const char *(*PrintHashContent)(void * Data);
472 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
473 typedef int (*HashFunc)(const char *Str, long Len);
474 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
475 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
477 int Flathash(const char *str, long len);
478 #define IKEY(a) (const char*) &a, sizeof(a)
480 HashList *NewHash(int Uniq, HashFunc F);
481 void DeleteHash(HashList **Hash);
482 void HDeleteHash(void *vHash);
483 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
484 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
485 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
486 int GetHashKeys(HashList *Hash, char ***List);
487 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
488 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
489 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
490 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
491 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
492 int GetHashPosCounter(HashList *Hash, HashPos *At);
493 void DeleteHashPos(HashPos **DelMe);
494 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
495 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
496 void SortByHashKey(HashList *Hash, int Order);
497 void SortByHashKeyStr(HashList *Hash);
498 int GetCount(HashList *Hash);
499 const void *GetSearchPayload(const void *HashVoid);
500 void SortByPayload(HashList *Hash, CompareFunc SortBy);
501 void generic_free_handler(void *ptr);
502 void reference_free_handler(void *ptr);
503 int HashLittle(const void *key, size_t length);
506 void convert_spaces_to_underscores(char *str);
509 * Convert 4 bytes char into an Integer.
510 * usefull for easy inexpensive hashing
511 * of for char strings.
513 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
515 /* vNote implementation */
517 #define CTDL_VNOTE_MAGIC 0xa1fa
535 struct vnote *vnote_new(void);
536 struct vnote *vnote_new_from_str(char *s);
537 void vnote_free(struct vnote *v);
538 char *vnote_serialize(struct vnote *v);
539 void vnote_serialize_output_field(char *append_to, char *field, char *label);
545 * Create JSON style structures in C plus serialize them to one string
548 typedef struct JsonValue JsonValue;
551 void DeleteJSONValue(void *vJsonValue);
553 JsonValue *NewJsonObject(const char *Key, long keylen);
555 JsonValue *NewJsonArray(const char *Key, long keylen);
557 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
559 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
561 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
563 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
565 JsonValue *NewJsonNull(const char *Key, long keylen);
567 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
569 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
571 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
573 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
578 * Citadels Wildfire implementation, see
579 * http://www.firephp.org/Wiki/Reference/Protocol
580 * and http://wildfirehq.org/ for details
582 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
584 typedef enum _WF_MessageType {
593 JsonValue *WildFireException(const char *Filename, long FileLen,
598 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
600 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
602 const char *Message, long len,
603 WF_MessageType Type);
605 JsonValue *WildFireMessage(const char *Filename, long fnlen,
608 WF_MessageType Type);
610 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
612 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
615 #define WF_STRUCTINDEX "1"
619 #endif // LIBCITADEL_H