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 StrBuf* NewStrBuf(void);
216 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
217 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
218 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
219 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
220 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
221 void FreeStrBuf (StrBuf **FreeMe);
222 void HFreeStrBuf (void *VFreeMe);
223 int FlushStrBuf(StrBuf *buf);
225 const char *ChrPtr(const StrBuf *Str);
226 int StrLength(const StrBuf *Str);
227 #define SKEY(a) ChrPtr(a), StrLength(a)
228 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
230 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
231 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
232 int StrBufTCP_read_buffered_line(StrBuf *Line,
236 int selectresolution,
239 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
240 int StrBufSub(StrBuf *dest, const StrBuf *Source, size_t Offset, size_t nChars);
241 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
242 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
243 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
244 inline int StrBufNum_tokens(const StrBuf *source, char tok);
245 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
247 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, size_t Offset);
248 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, size_t Offset);
249 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
250 #ifdef SHOW_ME_VAPPEND_PRINTF
251 /* so owe don't create an include depndency, this is just visible on demand. */
252 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
254 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
255 void StrBufCutLeft(StrBuf *Buf, int nChars);
256 void StrBufCutRight(StrBuf *Buf, int nChars);
257 void StrBufUpCase(StrBuf *Buf);
258 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
259 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
261 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
263 int CompressBuffer(StrBuf *Buf);
264 int StrBufDecodeBase64(StrBuf *Buf);
265 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
266 #define LB (1) /* Internal escape chars */
269 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
270 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
271 void StrMsgEscAppend(StrBuf *Target, StrBuf *Source, const char *PlainIn);
273 long StrTol(const StrBuf *Buf);
274 int StrToi(const StrBuf *Buf);
276 const char *GuessMimeType(const char *data, size_t dlen);
277 const char* GuessMimeByFilename(const char *what, size_t len);
279 /* Run once at Programstart */
280 int LoadIconDir(const char *DirName);
282 /* Select the icon for a given MIME type */
283 const char *GetIconFilename(char *MimeType, size_t len);
285 void ShutDownLibCitadel(void);
290 int Ctdl_IsUtf8SequenceStart(char Char);
291 int Ctdl_GetUtf8SequenceLength(char Char);
292 int Ctdl_Utf8StrLen(char *str);
293 char *Ctdl_Utf8StrCut(char *str, int maxlen);
296 int safestrncpy(char *dest, const char *src, size_t n);
297 int num_tokens (const char *source, char tok);
298 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
299 long grab_token(char **dest, const char *source, int parmnum, char separator);
300 int extract_int (const char *source, int parmnum);
301 long extract_long (const char *source, int parmnum);
302 unsigned long extract_unsigned_long(const char *source, int parmnum);
303 void CtdlInitBase64Table(void);
304 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
305 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
306 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
307 void striplt(char *);
308 int haschar(const char *st, int ch);
309 void remove_token(char *source, int parmnum, char separator);
310 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
311 int is_msg_in_sequence_set(char *mset, long msgnum);
312 char *memreadline(char *start, char *buf, int maxlen);
313 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
314 #define IsEmptyStr(a) ((a)[0] == '\0')
315 #define num_parms(source) num_tokens(source,(char)'|')
316 void stripout(char *str, char leftboundary, char rightboundary);
317 void stripallbut(char *str, char leftboundary, char rightboundary);
318 char *myfgets(char *s, int size, FILE *stream);
319 void urlesc(char *outbuf, size_t oblen, char *strbuf);
320 char *CtdlTempFileName(char *prefix1, int prefix2);
321 FILE *CtdlTempFile(void);
322 void generate_uuid(char *buf);
323 char *bmstrcasestr(char *text, char *pattern);
324 void CtdlMakeTempFileName(char *name, int len);
325 char *rfc2047encode(char *line, long length);
326 int is_msg_in_mset(char *mset, long msgnum);
327 int pattern2(char *search, char *patn);
328 void stripltlen(char *, int *);
329 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
330 void LoadEntityList(char *FileName);
336 #define CTDL_VCARD_MAGIC 0xa1f9
338 /* This data structure represents a vCard object currently in memory. */
349 struct vCard *vcard_new(void);
350 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
351 struct vCard *vcard_load(char *);
352 void vcard_free(struct vCard *);
353 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
354 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
355 int instance, int return_propname);
356 char *vcard_serialize(struct vCard *);
357 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
358 void remove_charset_attribute(char *strbuf);
359 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
362 * Hash list implementation for Citadel
364 #define HKEY(a) a, sizeof(a) - 1
365 typedef struct HashList HashList;
367 typedef struct HashKey HashKey;
369 typedef struct HashPos HashPos;
371 typedef void (*DeleteHashDataFunc)(void * Data);
372 typedef const char *(*PrintHashContent)(void * Data);
373 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
374 typedef int (*HashFunc)(const char *Str, long Len);
375 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
376 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
378 HashList *NewHash(int Uniq, HashFunc F);
379 void DeleteHash(HashList **Hash);
380 void HDeleteHash(void *vHash);
381 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
382 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
383 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
384 int GetHashKeys(HashList *Hash, char ***List);
385 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
386 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
387 HashPos *GetNewHashPos(void);
388 void DeleteHashPos(HashPos **DelMe);
389 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
390 void SortByHashKey(HashList *Hash, int Order);
391 void SortByHashKeyStr(HashList *Hash);
392 int GetCount(HashList *Hash);
393 const void *GetSearchPayload(const void *HashVoid);
394 void SortByPayload(HashList *Hash, CompareFunc SortBy);
395 void generic_free_handler(void *ptr);
398 void convert_spaces_to_underscores(char *str);
401 * Convert 4 bytes char into an Integer.
402 * usefull for easy inexpensive hashing
403 * of for char strings.
405 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
407 /* vNote implementation */
409 #define CTDL_VNOTE_MAGIC 0xa1fa
427 struct vnote *vnote_new(void);
428 struct vnote *vnote_new_from_str(char *s);
429 void vnote_free(struct vnote *v);
430 char *vnote_serialize(struct vnote *v);
431 void vnote_serialize_output_field(char *append_to, char *field, char *label);
434 #endif // LIBCITADEL_H