7 /* protect against double includes */
13 * since we reference time_t...
18 #define LIBCITADEL_VERSION_NUMBER 783
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 */
48 typedef enum AXLevel {
61 lastsent, /* Server internal use only */
71 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
75 GNET_POP3_DONT_DELETE_REMOTE = 4,
76 GNET_POP3_INTERVAL = 5
79 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
84 typedef enum __GPEXWhichPolicy {
94 * Note that not all views are implemented in all clients.
96 #define VIEW_BBS 0 /* Bulletin board view */
97 #define VIEW_MAILBOX 1 /* Mailbox summary */
98 #define VIEW_ADDRESSBOOK 2 /* Address book view */
99 #define VIEW_CALENDAR 3 /* Calendar view */
100 #define VIEW_TASKS 4 /* Tasks view */
101 #define VIEW_NOTES 5 /* Notes view */
102 #define VIEW_WIKI 6 /* Wiki view */
103 #define VIEW_CALBRIEF 7 /* Brief Calendar view */
104 #define VIEW_JOURNAL 8 /* Journal view */
105 #define VIEW_MAX 8 /* increment me... */
107 #define VIEW_BLOG 9 /* Blog view (not yet implemented) */
111 #define IsEmptyStr(a) ((a)[0] == '\0')
116 * another word to indicate n/a for a pointer if NULL already has a "meaning"
118 extern const char *StrBufNOTNULL;
124 char *libcitadel_version_string(void);
125 int libcitadel_version_number(void);
126 void StartLibCitadel(size_t basesize);
127 void ShutDownLibCitadel(void);
130 * MIME parser declarations
133 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
136 typedef void (*MimeParserCallBackType)(char *cbname,
148 void mime_parser(char *content_start, char *content_end,
149 MimeParserCallBackType CallBack,
150 MimeParserCallBackType PreMultiPartCallBack,
151 MimeParserCallBackType PostMultiPartCallBack,
157 char *fixed_partnum(char *);
158 void mime_decode(char *partnum,
159 char *part_start, size_t length,
160 char *content_type, char *charset, char *encoding,
163 char *name, char *filename,
164 MimeParserCallBackType CallBack,
165 MimeParserCallBackType PreMultiPartCallBack,
166 MimeParserCallBackType PostMultiPartCallBack,
169 void the_mime_parser(char *partnum,
170 char *content_start, char *content_end,
171 MimeParserCallBackType CallBack,
172 MimeParserCallBackType PreMultiPartCallBack,
173 MimeParserCallBackType PostMultiPartCallBack,
177 typedef struct StrBuf StrBuf;
180 #define CStrOf(a) #a, sizeof(#a) - 1
181 typedef struct _ConstStr {
185 #define CKEY(a) (a).Key, (a).len
187 StrBuf* NewStrBuf(void);
188 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
189 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
190 long StrBufShrinkToFit(StrBuf *Buf, int Force);
191 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
193 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
194 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
195 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
196 void FreeStrBuf (StrBuf **FreeMe);
197 char *SmashStrBuf (StrBuf **SmashMe);
198 void HFreeStrBuf (void *VFreeMe);
199 int FlushStrBuf(StrBuf *buf);
200 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
202 const char *ChrPtr(const StrBuf *Str);
203 int StrLength(const StrBuf *Str);
204 #define SKEY(a) ChrPtr(a), StrLength(a)
205 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
206 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
208 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
209 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
212 int StrBufReadBLOBBuffered(StrBuf *Buf,
220 int StrBufTCP_read_buffered_line(StrBuf *Line,
224 int selectresolution,
226 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
231 int selectresolution,
234 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
235 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
236 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
237 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
239 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
240 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
241 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
242 int StrBufNum_tokens(const StrBuf *source, char tok);
243 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
245 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
246 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
247 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
248 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
249 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
250 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
253 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
254 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
255 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
256 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
257 #ifdef SHOW_ME_VAPPEND_PRINTF
258 /* so owe don't create an include depndency, this is just visible on demand. */
259 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
261 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
262 void StrBufCutLeft(StrBuf *Buf, int nChars);
263 void StrBufCutRight(StrBuf *Buf, int nChars);
264 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
265 void StrBufTrim(StrBuf *Buf);
266 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
267 void StrBufUpCase(StrBuf *Buf);
268 void StrBufLowerCase(StrBuf *Buf);
269 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
270 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
271 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
273 void StrBufToUnixLF(StrBuf *buf);
274 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
276 int CompressBuffer(StrBuf *Buf);
277 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
278 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
279 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
280 int StrBufDecodeBase64(StrBuf *Buf);
281 int StrBufDecodeHex(StrBuf *Buf);
282 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
283 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
285 StrBuf *EmailAddress,
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 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
293 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
294 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
295 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
296 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
297 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
299 long StrTol(const StrBuf *Buf);
300 int StrToi(const StrBuf *Buf);
301 int StrBufIsNumber(const StrBuf *Buf);
302 long StrBuf_Utf8StrLen(StrBuf *Buf);
303 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
305 const char *GuessMimeType(const char *data, size_t dlen);
306 const char* GuessMimeByFilename(const char *what, size_t len);
308 /* Run once at Programstart */
309 int LoadIconDir(const char *DirName);
311 /* Select the icon for a given MIME type */
312 const char *GetIconFilename(char *MimeType, size_t len);
318 int safestrncpy(char *dest, const char *src, size_t n);
319 int num_tokens (const char *source, char tok);
320 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
321 long grab_token(char **dest, const char *source, int parmnum, char separator);
322 int extract_int (const char *source, int parmnum);
323 long extract_long (const char *source, int parmnum);
324 unsigned long extract_unsigned_long(const char *source, int parmnum);
325 void CtdlInitBase64Table(void);
326 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
327 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
328 unsigned int decode_hex(char *Source);
329 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
330 void StripSlashes(char *Dir, int TrailingSlash);
331 size_t striplt(char *);
332 int haschar(const char *st, int ch);
333 void remove_token(char *source, int parmnum, char separator);
334 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
335 int is_msg_in_sequence_set(const char *mset, long msgnum);
336 char *memreadline(char *start, char *buf, int maxlen);
337 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
338 const char *cmemreadline(const char *start, char *buf, int maxlen);
339 const char *cmemreadlinelen(const 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, const char *pattern);
350 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
351 const char *cbmstrcasestr(const char *text, const char *pattern);
352 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
353 void CtdlMakeTempFileName(char *name, int len);
354 char *rfc2047encode(char *line, long length);
355 int is_msg_in_mset(const char *mset, long msgnum);
356 int pattern2(char *search, char *patn);
357 void stripltlen(char *, int *);
358 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
359 void LoadEntityList(char *FileName);
365 #define CTDL_VCARD_MAGIC 0xa1f9
367 /* This data structure represents a vCard object currently in memory. */
378 struct vCard *vcard_new(void);
379 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
380 struct vCard *vcard_load(char *vtext);
381 struct vCard *VCardLoad(StrBuf *vbtext);
383 void vcard_free(struct vCard *);
384 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
385 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
386 int instance, int return_propname);
387 char *vcard_serialize(struct vCard *);
388 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
389 void remove_charset_attribute(char *strbuf);
390 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
393 * Hash list implementation for Citadel
395 #define HKEY(a) a, (sizeof(a) - 1)
397 typedef struct HashList HashList;
399 typedef struct HashKey HashKey;
401 typedef struct HashPos HashPos;
403 typedef void (*DeleteHashDataFunc)(void * Data);
404 typedef const char *(*PrintHashContent)(void * Data);
405 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
406 typedef int (*HashFunc)(const char *Str, long Len);
407 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
408 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
410 int Flathash(const char *str, long len);
411 #define IKEY(a) (const char*) &a, sizeof(a)
413 HashList *NewHash(int Uniq, HashFunc F);
414 void DeleteHash(HashList **Hash);
415 void HDeleteHash(void *vHash);
416 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
417 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
418 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
419 int GetHashKeys(HashList *Hash, char ***List);
420 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
421 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
422 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
423 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
424 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
425 int GetHashPosCounter(HashList *Hash, HashPos *At);
426 void DeleteHashPos(HashPos **DelMe);
427 int NextHashPos(HashList *Hash, HashPos *At);
428 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
429 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
430 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
431 void SortByHashKey(HashList *Hash, int Order);
432 void SortByHashKeyStr(HashList *Hash);
433 int GetCount(HashList *Hash);
434 const void *GetSearchPayload(const void *HashVoid);
435 void SortByPayload(HashList *Hash, CompareFunc SortBy);
436 void reference_free_handler(void *ptr);
437 int HashLittle(const void *key, size_t length);
440 void convert_spaces_to_underscores(char *str);
441 int CheckEncode(const char *pch, long len, const char *pche);
444 * Convert 4 bytes char into an Integer.
445 * usefull for easy inexpensive hashing
446 * of for char strings.
448 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
450 /* vNote implementation */
452 #define CTDL_VNOTE_MAGIC 0xa1fa
470 struct vnote *vnote_new(void);
471 struct vnote *vnote_new_from_str(char *s);
472 void vnote_free(struct vnote *v);
473 char *vnote_serialize(struct vnote *v);
474 void vnote_serialize_output_field(char *append_to, char *field, char *label);
480 * Create JSON style structures in C plus serialize them to one string
483 typedef struct JsonValue JsonValue;
486 void DeleteJSONValue(void *vJsonValue);
488 JsonValue *NewJsonObject(const char *Key, long keylen);
490 JsonValue *NewJsonArray(const char *Key, long keylen);
492 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
494 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
496 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
498 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
500 JsonValue *NewJsonNull(const char *Key, long keylen);
502 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
504 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
506 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
508 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
513 * Citadels Wildfire implementation, see
514 * http://www.firephp.org/Wiki/Reference/Protocol
515 * and http://wildfirehq.org/ for details
517 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
519 typedef enum _WF_MessageType {
528 JsonValue *WildFireException(const char *Filename, long FileLen,
533 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
535 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
537 const char *Message, long len,
538 WF_MessageType Type);
540 JsonValue *WildFireMessage(const char *Filename, long fnlen,
543 WF_MessageType Type);
545 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
547 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
550 #define WF_STRUCTINDEX "1"
554 #endif // LIBCITADEL_H