7 /* protect against double includes */
13 * since we reference time_t...
18 #define LIBCITADEL_VERSION_NUMBER 760
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')
72 char *libcitadel_version_string(void);
73 int libcitadel_version_number(void);
74 void StartLibCitadel(size_t basesize);
75 void ShutDownLibCitadel(void);
78 * MIME parser declarations
81 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen);
83 void mime_parser(char *content_start, char *content_end,
96 void (*PreMultiPartCallBack)
108 void (*PostMultiPartCallBack)
126 char *fixed_partnum(char *);
127 void mime_decode(char *partnum,
128 char *part_start, size_t length,
129 char *content_type, char *charset, char *encoding,
132 char *name, char *filename,
145 void (*PreMultiPartCallBack)
157 void (*PostMultiPartCallBack)
172 void the_mime_parser(char *partnum,
173 char *content_start, char *content_end,
186 void (*PreMultiPartCallBack)
198 void (*PostMultiPartCallBack)
214 typedef struct StrBuf StrBuf;
216 typedef struct _ConstStr {
222 StrBuf* NewStrBuf(void);
223 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
224 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
225 long StrBufShrinkToFit(StrBuf *Buf, int Force);
226 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
228 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
229 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
230 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
231 void FreeStrBuf (StrBuf **FreeMe);
232 void HFreeStrBuf (void *VFreeMe);
233 int FlushStrBuf(StrBuf *buf);
234 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
236 const char *ChrPtr(const StrBuf *Str);
237 int StrLength(const StrBuf *Str);
238 #define SKEY(a) ChrPtr(a), StrLength(a)
239 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
241 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
242 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
245 int StrBufReadBLOBBuffered(StrBuf *Buf,
253 int StrBufTCP_read_buffered_line(StrBuf *Line,
257 int selectresolution,
259 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
264 int selectresolution,
267 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
268 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
269 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
271 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
272 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
273 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
274 int StrBufNum_tokens(const StrBuf *source, char tok);
275 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
277 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
278 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
279 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
280 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
281 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
284 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
285 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
286 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
287 #ifdef SHOW_ME_VAPPEND_PRINTF
288 /* so owe don't create an include depndency, this is just visible on demand. */
289 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
291 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
292 void StrBufCutLeft(StrBuf *Buf, int nChars);
293 void StrBufCutRight(StrBuf *Buf, int nChars);
294 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
295 void StrBufTrim(StrBuf *Buf);
296 void StrBufUpCase(StrBuf *Buf);
297 void StrBufLowerCase(StrBuf *Buf);
298 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
299 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
301 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
303 int CompressBuffer(StrBuf *Buf);
304 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
305 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
306 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
307 int StrBufDecodeBase64(StrBuf *Buf);
308 int StrBufDecodeHex(StrBuf *Buf);
309 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
310 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
311 #define LB (1) /* Internal escape chars */
314 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
315 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
316 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
317 void StrMsgEscAppend(StrBuf *Target, StrBuf *Source, const char *PlainIn);
319 long StrTol(const StrBuf *Buf);
320 int StrToi(const StrBuf *Buf);
321 int StrBufIsNumber(const StrBuf *Buf);
322 long StrBuf_Utf8StrLen(StrBuf *Buf);
323 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
325 const char *GuessMimeType(const char *data, size_t dlen);
326 const char* GuessMimeByFilename(const char *what, size_t len);
328 /* Run once at Programstart */
329 int LoadIconDir(const char *DirName);
331 /* Select the icon for a given MIME type */
332 const char *GetIconFilename(char *MimeType, size_t len);
338 int safestrncpy(char *dest, const char *src, size_t n);
339 int num_tokens (const char *source, char tok);
340 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
341 long grab_token(char **dest, const char *source, int parmnum, char separator);
342 int extract_int (const char *source, int parmnum);
343 long extract_long (const char *source, int parmnum);
344 unsigned long extract_unsigned_long(const char *source, int parmnum);
345 void CtdlInitBase64Table(void);
346 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
347 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
348 unsigned int decode_hex(char *Source);
349 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
350 void StripSlashes(char *Dir, int TrailingSlash);
351 size_t striplt(char *);
352 int haschar(const char *st, int ch);
353 void remove_token(char *source, int parmnum, char separator);
354 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
355 int is_msg_in_sequence_set(const char *mset, long msgnum);
356 char *memreadline(char *start, char *buf, int maxlen);
357 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
358 #define IsEmptyStr(a) ((a)[0] == '\0')
359 #define num_parms(source) num_tokens(source,(char)'|')
360 int stripout(char *str, char leftboundary, char rightboundary);
361 void stripallbut(char *str, char leftboundary, char rightboundary);
362 char *myfgets(char *s, int size, FILE *stream);
363 void urlesc(char *outbuf, size_t oblen, char *strbuf);
364 char *CtdlTempFileName(char *prefix1, int prefix2);
365 FILE *CtdlTempFile(void);
366 void generate_uuid(char *buf);
367 char *bmstrcasestr(char *text, char *pattern);
368 char *bmstrcasestr_len(char *text, size_t textlen, char *pattern, size_t patlen);
369 void CtdlMakeTempFileName(char *name, int len);
370 char *rfc2047encode(char *line, long length);
371 int is_msg_in_mset(const char *mset, long msgnum);
372 int pattern2(char *search, char *patn);
373 void stripltlen(char *, int *);
374 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
375 void LoadEntityList(char *FileName);
381 #define CTDL_VCARD_MAGIC 0xa1f9
383 /* This data structure represents a vCard object currently in memory. */
394 struct vCard *vcard_new(void);
395 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
396 struct vCard *vcard_load(char *vtext);
397 struct vCard *VCardLoad(StrBuf *vbtext);
399 void vcard_free(struct vCard *);
400 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
401 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
402 int instance, int return_propname);
403 char *vcard_serialize(struct vCard *);
404 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
405 void remove_charset_attribute(char *strbuf);
406 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
409 * Hash list implementation for Citadel
411 #define HKEY(a) a, (sizeof(a) - 1)
413 typedef struct HashList HashList;
415 typedef struct HashKey HashKey;
417 typedef struct HashPos HashPos;
419 typedef void (*DeleteHashDataFunc)(void * Data);
420 typedef const char *(*PrintHashContent)(void * Data);
421 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
422 typedef int (*HashFunc)(const char *Str, long Len);
423 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
424 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
426 int Flathash(const char *str, long len);
427 #define IKEY(a) (const char*)(&((int)a)), sizeof(int)
429 HashList *NewHash(int Uniq, HashFunc F);
430 void DeleteHash(HashList **Hash);
431 void HDeleteHash(void *vHash);
432 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
433 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
434 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
435 int GetHashKeys(HashList *Hash, char ***List);
436 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
437 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
438 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
439 int GetHashPosCounter(HashPos *At);
440 void DeleteHashPos(HashPos **DelMe);
441 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
442 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
443 void SortByHashKey(HashList *Hash, int Order);
444 void SortByHashKeyStr(HashList *Hash);
445 int GetCount(HashList *Hash);
446 const void *GetSearchPayload(const void *HashVoid);
447 void SortByPayload(HashList *Hash, CompareFunc SortBy);
448 void generic_free_handler(void *ptr);
449 void reference_free_handler(void *ptr);
450 int HashLittle(const void *key, size_t length);
453 void convert_spaces_to_underscores(char *str);
456 * Convert 4 bytes char into an Integer.
457 * usefull for easy inexpensive hashing
458 * of for char strings.
460 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
462 /* vNote implementation */
464 #define CTDL_VNOTE_MAGIC 0xa1fa
482 struct vnote *vnote_new(void);
483 struct vnote *vnote_new_from_str(char *s);
484 void vnote_free(struct vnote *v);
485 char *vnote_serialize(struct vnote *v);
486 void vnote_serialize_output_field(char *append_to, char *field, char *label);
492 * Create JSON style structures in C plus serialize them to one string
495 typedef struct JsonValue JsonValue;
498 void DeleteJSONValue(void *vJsonValue);
500 JsonValue *NewJsonObject(const char *Key, long keylen);
502 JsonValue *NewJsonArray(const char *Key, long keylen);
504 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
506 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
508 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
510 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
512 JsonValue *NewJsonNull(const char *Key, long keylen);
514 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
516 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
518 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
520 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
525 * Citadels Wildfire implementation, see
526 * http://www.firephp.org/Wiki/Reference/Protocol
527 * and http://wildfirehq.org/ for details
529 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
531 typedef enum _WF_MessageType {
540 JsonValue *WildFireException(const char *Filename, long FileLen,
545 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
547 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
549 const char *Message, long len,
550 WF_MessageType Type);
552 JsonValue *WildFireMessage(const char *Filename, long fnlen,
555 WF_MessageType Type);
557 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
559 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
562 #define WF_STRUCTINDEX "1"
566 #endif // LIBCITADEL_H