7 /* protect against double includes */
13 * since we reference time_t...
18 #define LIBCITADEL_VERSION_NUMBER 738
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,
94 void (*PreMultiPartCallBack)
105 void (*PostMultiPartCallBack)
122 char *fixed_partnum(char *);
123 void mime_decode(char *partnum,
124 char *part_start, size_t length,
125 char *content_type, char *charset, char *encoding,
127 char *name, char *filename,
139 void (*PreMultiPartCallBack)
150 void (*PostMultiPartCallBack)
164 void the_mime_parser(char *partnum,
165 char *content_start, char *content_end,
177 void (*PreMultiPartCallBack)
188 void (*PostMultiPartCallBack)
203 typedef struct StrBuf StrBuf;
205 StrBuf* NewStrBuf(void);
206 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
207 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
208 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
209 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
210 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
211 void FreeStrBuf (StrBuf **FreeMe);
212 void HFreeStrBuf (void *VFreeMe);
213 int FlushStrBuf(StrBuf *buf);
215 inline const char *ChrPtr(const StrBuf *Str);
216 inline int StrLength(const StrBuf *Str);
217 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
219 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
220 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
222 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
223 int StrBufSub(StrBuf *dest, const StrBuf *Source, size_t Offset, size_t nChars);
224 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
225 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
226 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
227 inline int StrBufNum_tokens(const StrBuf *source, char tok);
229 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, size_t Offset);
230 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, size_t Offset);
231 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
232 #ifdef SHOW_ME_VAPPEND_PRINTF
233 /* so owe don't create an include depndency, this is just visible on demand. */
234 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
236 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
237 void StrBufCutLeft(StrBuf *Buf, int nChars);
238 void StrBufCutRight(StrBuf *Buf, int nChars);
239 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
240 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
242 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
244 int CompressBuffer(StrBuf *Buf);
245 int StrBufDecodeBase64(StrBuf *Buf);
246 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
247 #define LB (1) /* Internal escape chars */
250 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
251 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
252 void StrMsgEscAppend(StrBuf *Target, StrBuf *Source, const char *PlainIn);
254 long StrTol(const StrBuf *Buf);
255 int StrToi(const StrBuf *Buf);
257 const char *GuessMimeType(const char *data, size_t dlen);
258 const char* GuessMimeByFilename(const char *what, size_t len);
260 /* Run once at Programstart */
261 int LoadIconDir(const char *DirName);
263 /* Select the icon for a given MIME type */
264 const char *GetIconFilename(char *MimeType, size_t len);
266 void ShutDownLibCitadel(void);
271 int Ctdl_IsUtf8SequenceStart(char Char);
272 int Ctdl_GetUtf8SequenceLength(char Char);
273 int Ctdl_Utf8StrLen(char *str);
274 char *Ctdl_Utf8StrCut(char *str, int maxlen);
277 int safestrncpy(char *dest, const char *src, size_t n);
278 int num_tokens (const char *source, char tok);
279 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
280 long grab_token(char **dest, const char *source, int parmnum, char separator);
281 int extract_int (const char *source, int parmnum);
282 long extract_long (const char *source, int parmnum);
283 unsigned long extract_unsigned_long(const char *source, int parmnum);
284 void CtdlInitBase64Table(void);
285 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
286 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
287 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
288 void striplt(char *);
289 int haschar(const char *st, int ch);
290 void remove_token(char *source, int parmnum, char separator);
291 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
292 int is_msg_in_sequence_set(char *mset, long msgnum);
293 char *memreadline(char *start, char *buf, int maxlen);
294 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
295 #define IsEmptyStr(a) ((a)[0] == '\0')
296 #define num_parms(source) num_tokens(source,(char)'|')
297 void stripout(char *str, char leftboundary, char rightboundary);
298 void stripallbut(char *str, char leftboundary, char rightboundary);
299 char *myfgets(char *s, int size, FILE *stream);
300 void urlesc(char *outbuf, size_t oblen, char *strbuf);
301 char *CtdlTempFileName(char *prefix1, int prefix2);
302 FILE *CtdlTempFile(void);
303 void generate_uuid(char *buf);
304 char *bmstrcasestr(char *text, char *pattern);
305 void CtdlMakeTempFileName(char *name, int len);
306 char *rfc2047encode(char *line, long length);
307 int is_msg_in_mset(char *mset, long msgnum);
308 int pattern2(char *search, char *patn);
309 void stripltlen(char *, int *);
310 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
311 void LoadEntityList(char *FileName);
317 #define CTDL_VCARD_MAGIC 0xa1f9
319 /* This data structure represents a vCard object currently in memory. */
330 struct vCard *vcard_new(void);
331 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
332 struct vCard *vcard_load(char *);
333 void vcard_free(struct vCard *);
334 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
335 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
336 int instance, int return_propname);
337 char *vcard_serialize(struct vCard *);
338 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
339 void remove_charset_attribute(char *strbuf);
340 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
343 * Hash list implementation for Citadel
345 #define HKEY(a) a, sizeof(a) - 1
346 typedef struct HashList HashList;
348 typedef struct HashKey HashKey;
350 typedef struct HashPos HashPos;
352 typedef void (*DeleteHashDataFunc)(void * Data);
353 typedef const char *(*PrintHashContent)(void * Data);
354 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
355 typedef int (*HashFunc)(const char *Str, long Len);
356 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
357 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
359 HashList *NewHash(int Uniq, HashFunc F);
360 void DeleteHash(HashList **Hash);
361 void HDeleteHash(void *vHash);
362 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
363 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
364 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
365 int GetHashKeys(HashList *Hash, char ***List);
366 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
367 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
368 HashPos *GetNewHashPos(void);
369 void DeleteHashPos(HashPos **DelMe);
370 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
371 void SortByHashKey(HashList *Hash, int Order);
372 void SortByHashKeyStr(HashList *Hash);
373 int GetCount(HashList *Hash);
374 const void *GetSearchPayload(const void *HashVoid);
375 void SortByPayload(HashList *Hash, CompareFunc SortBy);
376 void generic_free_handler(void *ptr);
379 void convert_spaces_to_underscores(char *str);
382 * Convert 4 bytes char into an Integer.
383 * usefull for easy inexpensive hashing
384 * of for char strings.
386 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
388 /* vNote implementation */
390 #define CTDL_VNOTE_MAGIC 0xa1fa
408 struct vnote *vnote_new(void);
409 struct vnote *vnote_new_from_str(char *s);
410 void vnote_free(struct vnote *v);
411 char *vnote_serialize(struct vnote *v);
412 void vnote_serialize_output_field(char *append_to, char *field, char *label);
415 #endif // LIBCITADEL_H