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* NewStrBufPlain(const char* ptr, int nChars);
207 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
208 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
209 void FreeStrBuf (StrBuf **FreeMe);
210 void HFreeStrBuf (void *VFreeMe);
211 int FlushStrBuf(StrBuf *buf);
213 inline const char *ChrPtr(StrBuf *Str);
214 inline int StrLength(StrBuf *Str);
216 int StrBufTCP_read_line(StrBuf *buf, int fd, int append, const char **Error);
218 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
219 int StrBufSub(StrBuf *dest, const StrBuf *Source, size_t Offset, size_t nChars);
220 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
221 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
222 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
223 inline int StrBufNum_tokens(const StrBuf *source, char tok);
225 void StrBufAppendBuf(StrBuf *Buf, StrBuf *AppendBuf, size_t Offset);
226 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
227 void StrBufCutLeft(StrBuf *Buf, int nChars);
228 void StrBufCutRight(StrBuf *Buf, int nChars);
229 void StrBufEUid_unescapize(StrBuf *target, StrBuf *source);
230 void StrBufEUid_escapize(StrBuf *target, StrBuf *source);
232 long StrTol(StrBuf *Buf);
234 const char *GuessMimeType(char *data, size_t dlen);
235 const char* GuessMimeByFilename(const char *what, size_t len);
237 /* Run once at Programstart */
238 int LoadIconDir(const char *DirName);
240 /* Select the icon for a given MIME type */
241 const char *GetIconFilename(char *MimeType, size_t len);
243 void ShutDownLibCitadel(void);
248 int Ctdl_IsUtf8SequenceStart(char Char);
249 int Ctdl_GetUtf8SequenceLength(char Char);
250 int Ctdl_Utf8StrLen(char *str);
251 char *Ctdl_Utf8StrCut(char *str, int maxlen);
254 int safestrncpy(char *dest, const char *src, size_t n);
255 int num_tokens (const char *source, char tok);
256 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
257 long grab_token(char **dest, const char *source, int parmnum, char separator);
258 int extract_int (const char *source, int parmnum);
259 long extract_long (const char *source, int parmnum);
260 unsigned long extract_unsigned_long(const char *source, int parmnum);
261 void CtdlInitBase64Table(void);
262 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
263 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
264 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
265 void striplt(char *);
266 int haschar(const char *st, int ch);
267 void remove_token(char *source, int parmnum, char separator);
268 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
269 int is_msg_in_sequence_set(char *mset, long msgnum);
270 char *memreadline(char *start, char *buf, int maxlen);
271 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
272 #define IsEmptyStr(a) ((a)[0] == '\0')
273 #define num_parms(source) num_tokens(source,(char)'|')
274 void stripout(char *str, char leftboundary, char rightboundary);
275 void stripallbut(char *str, char leftboundary, char rightboundary);
276 char *myfgets(char *s, int size, FILE *stream);
277 void urlesc(char *outbuf, size_t oblen, char *strbuf);
278 char *CtdlTempFileName(char *prefix1, int prefix2);
279 FILE *CtdlTempFile(void);
280 void generate_uuid(char *buf);
281 char *bmstrcasestr(char *text, char *pattern);
282 void CtdlMakeTempFileName(char *name, int len);
283 char *rfc2047encode(char *line, long length);
284 int is_msg_in_mset(char *mset, long msgnum);
285 int pattern2(char *search, char *patn);
286 void stripltlen(char *, int *);
287 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
288 void LoadEntityList(char *FileName);
294 #define CTDL_VCARD_MAGIC 0xa1f9
296 /* This data structure represents a vCard object currently in memory. */
307 struct vCard *vcard_new(void);
308 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
309 struct vCard *vcard_load(char *);
310 void vcard_free(struct vCard *);
311 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
312 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
313 int instance, int return_propname);
314 char *vcard_serialize(struct vCard *);
315 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
316 void remove_charset_attribute(char *strbuf);
319 * Hash list implementation for Citadel
321 #define HKEY(a) a, sizeof(a) - 1
322 typedef struct HashList HashList;
324 typedef struct HashKey HashKey;
326 typedef struct HashPos HashPos;
328 typedef void (*DeleteHashDataFunc)(void * Data);
329 typedef const char *(*PrintHashContent)(void * Data);
330 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
331 typedef int (*HashFunc)(const char *Str, long Len);
332 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
333 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
335 HashList *NewHash(int Uniq, HashFunc F);
336 void DeleteHash(HashList **Hash);
337 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
338 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
339 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
340 int GetHashKeys(HashList *Hash, char ***List);
341 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
342 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
343 HashPos *GetNewHashPos(void);
344 void DeleteHashPos(HashPos **DelMe);
345 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, char **HashKey, void **Data);
346 void SortByHashKey(HashList *Hash, int Order);
347 void SortByHashKeyStr(HashList *Hash);
348 int GetCount(HashList *Hash);
349 const void *GetSearchPayload(const void *HashVoid);
350 void SortByPayload(HashList *Hash, CompareFunc SortBy);
351 void generic_free_handler(void *ptr);
354 void convert_spaces_to_underscores(char *str);
357 * Convert 4 bytes char into an Integer.
358 * usefull for easy inexpensive hashing
359 * of for char strings.
361 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
363 /* vNote implementation */
365 #define CTDL_VNOTE_MAGIC 0xa1fa
383 struct vnote *vnote_new(void);
384 struct vnote *vnote_new_from_str(char *s);
385 void vnote_free(struct vnote *v);
386 char *vnote_serialize(struct vnote *v);
387 void vnote_serialize_output_field(char *append_to, char *field, char *label);
390 #endif // LIBCITADEL_H