7 /* protect against double includes */
13 * since we reference time_t...
18 #define LIBCITADEL_VERSION_NUMBER 739
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);
77 * MIME parser declarations
80 void extract_key(char *target, char *source, char *key);
82 void mime_parser(char *content_start, char *content_end,
95 void (*PreMultiPartCallBack)
107 void (*PostMultiPartCallBack)
125 char *fixed_partnum(char *);
126 void mime_decode(char *partnum,
127 char *part_start, size_t length,
128 char *content_type, char *charset, char *encoding,
131 char *name, char *filename,
144 void (*PreMultiPartCallBack)
156 void (*PostMultiPartCallBack)
171 void the_mime_parser(char *partnum,
172 char *content_start, char *content_end,
185 void (*PreMultiPartCallBack)
197 void (*PostMultiPartCallBack)
213 typedef struct StrBuf StrBuf;
215 typedef struct _ConstStr {
221 StrBuf* NewStrBuf(void);
222 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
223 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
224 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
225 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
226 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
227 void FreeStrBuf (StrBuf **FreeMe);
228 void HFreeStrBuf (void *VFreeMe);
229 int FlushStrBuf(StrBuf *buf);
231 const char *ChrPtr(const StrBuf *Str);
232 int StrLength(const StrBuf *Str);
233 #define SKEY(a) ChrPtr(a), StrLength(a)
234 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
236 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
237 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
238 int StrBufTCP_read_buffered_line(StrBuf *Line,
242 int selectresolution,
245 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
246 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
247 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
249 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
250 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
251 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
252 inline int StrBufNum_tokens(const StrBuf *source, char tok);
253 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
255 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
256 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
257 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
258 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
259 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
262 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
263 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
264 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
265 #ifdef SHOW_ME_VAPPEND_PRINTF
266 /* so owe don't create an include depndency, this is just visible on demand. */
267 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
269 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
270 void StrBufCutLeft(StrBuf *Buf, int nChars);
271 void StrBufCutRight(StrBuf *Buf, int nChars);
272 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
273 void StrBufTrim(StrBuf *Buf);
274 void StrBufUpCase(StrBuf *Buf);
275 void StrBufLowerCase(StrBuf *Buf);
276 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
277 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
279 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
281 int CompressBuffer(StrBuf *Buf);
282 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
283 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
284 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
285 int StrBufDecodeBase64(StrBuf *Buf);
286 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
287 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
288 #define LB (1) /* Internal escape chars */
291 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
292 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
293 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
294 void StrMsgEscAppend(StrBuf *Target, StrBuf *Source, const char *PlainIn);
296 long StrTol(const StrBuf *Buf);
297 int StrToi(const StrBuf *Buf);
298 int StrBufIsNumber(const StrBuf *Buf);
299 long StrBuf_Utf8StrLen(StrBuf *Buf);
300 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
302 const char *GuessMimeType(const char *data, size_t dlen);
303 const char* GuessMimeByFilename(const char *what, size_t len);
305 /* Run once at Programstart */
306 int LoadIconDir(const char *DirName);
308 /* Select the icon for a given MIME type */
309 const char *GetIconFilename(char *MimeType, size_t len);
311 void ShutDownLibCitadel(void);
316 int Ctdl_IsUtf8SequenceStart(char Char);
317 int Ctdl_GetUtf8SequenceLength(char Char);
318 int Ctdl_Utf8StrLen(char *str);
319 char *Ctdl_Utf8StrCut(char *str, int maxlen);
322 int safestrncpy(char *dest, const char *src, size_t n);
323 int num_tokens (const char *source, char tok);
324 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
325 long grab_token(char **dest, const char *source, int parmnum, char separator);
326 int extract_int (const char *source, int parmnum);
327 long extract_long (const char *source, int parmnum);
328 unsigned long extract_unsigned_long(const char *source, int parmnum);
329 void CtdlInitBase64Table(void);
330 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
331 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
332 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
333 void striplt(char *);
334 int haschar(const char *st, int ch);
335 void remove_token(char *source, int parmnum, char separator);
336 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
337 int is_msg_in_sequence_set(const char *mset, long msgnum);
338 char *memreadline(char *start, char *buf, int maxlen);
339 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
340 #define IsEmptyStr(a) ((a)[0] == '\0')
341 #define num_parms(source) num_tokens(source,(char)'|')
342 int stripout(char *str, char leftboundary, char rightboundary);
343 void stripallbut(char *str, char leftboundary, char rightboundary);
344 char *myfgets(char *s, int size, FILE *stream);
345 void urlesc(char *outbuf, size_t oblen, char *strbuf);
346 char *CtdlTempFileName(char *prefix1, int prefix2);
347 FILE *CtdlTempFile(void);
348 void generate_uuid(char *buf);
349 char *bmstrcasestr(char *text, char *pattern);
350 void CtdlMakeTempFileName(char *name, int len);
351 char *rfc2047encode(char *line, long length);
352 int is_msg_in_mset(const char *mset, long msgnum);
353 int pattern2(char *search, char *patn);
354 void stripltlen(char *, int *);
355 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
356 void LoadEntityList(char *FileName);
362 #define CTDL_VCARD_MAGIC 0xa1f9
364 /* This data structure represents a vCard object currently in memory. */
375 struct vCard *vcard_new(void);
376 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
377 struct vCard *vcard_load(char *);
378 void vcard_free(struct vCard *);
379 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
380 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
381 int instance, int return_propname);
382 char *vcard_serialize(struct vCard *);
383 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
384 void remove_charset_attribute(char *strbuf);
385 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
388 * Hash list implementation for Citadel
390 #define HKEY(a) a, (sizeof(a) - 1)
391 typedef struct HashList HashList;
393 typedef struct HashKey HashKey;
395 typedef struct HashPos HashPos;
397 typedef void (*DeleteHashDataFunc)(void * Data);
398 typedef const char *(*PrintHashContent)(void * Data);
399 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
400 typedef int (*HashFunc)(const char *Str, long Len);
401 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
402 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
404 int Flathash(const char *str, long len);
405 #define IKEY(a) (const char*)(&((int)a)), sizeof(int)
407 HashList *NewHash(int Uniq, HashFunc F);
408 void DeleteHash(HashList **Hash);
409 void HDeleteHash(void *vHash);
410 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
411 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
412 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
413 int GetHashKeys(HashList *Hash, char ***List);
414 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
415 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
416 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
417 int GetHashPosCounter(HashPos *At);
418 void DeleteHashPos(HashPos **DelMe);
419 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
420 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
421 void SortByHashKey(HashList *Hash, int Order);
422 void SortByHashKeyStr(HashList *Hash);
423 int GetCount(HashList *Hash);
424 const void *GetSearchPayload(const void *HashVoid);
425 void SortByPayload(HashList *Hash, CompareFunc SortBy);
426 void generic_free_handler(void *ptr);
427 void reference_free_handler(void *ptr);
430 void convert_spaces_to_underscores(char *str);
433 * Convert 4 bytes char into an Integer.
434 * usefull for easy inexpensive hashing
435 * of for char strings.
437 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
439 /* vNote implementation */
441 #define CTDL_VNOTE_MAGIC 0xa1fa
459 struct vnote *vnote_new(void);
460 struct vnote *vnote_new_from_str(char *s);
461 void vnote_free(struct vnote *v);
462 char *vnote_serialize(struct vnote *v);
463 void vnote_serialize_output_field(char *append_to, char *field, char *label);
469 * Create JSON style structures in C plus serialize them to one string
472 typedef struct JsonValue JsonValue;
475 void DeleteJSONValue(void *vJsonValue);
477 JsonValue *NewJsonObject(const char *Key, long keylen);
479 JsonValue *NewJsonArray(const char *Key, long keylen);
481 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
483 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
485 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
487 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
489 JsonValue *NewJsonNull(const char *Key, long keylen);
491 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
493 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
495 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
497 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
502 * Citadels Wildfire implementation, see
503 * http://www.firephp.org/Wiki/Reference/Protocol
504 * and http://wildfirehq.org/ for details
506 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
508 typedef enum _WF_MessageType {
517 JsonValue *WildFireException(const char *Filename, long FileLen,
522 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
524 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
526 const char *Message, long len,
527 WF_MessageType Type);
529 JsonValue *WildFireMessage(const char *Filename, long fnlen,
532 WF_MessageType Type);
534 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
536 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
539 #define WF_STRUCTINDEX "1"
543 #endif // LIBCITADEL_H