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 split into these columns: */
75 GNET_POP3_DONT_DELETE_REMOTE = 4,
76 GNET_POP3_INTERVAL = 5
80 typedef enum __GPEXWhichPolicy {
90 * Note that not all views are implemented in all clients.
92 #define VIEW_BBS 0 /* Bulletin board view */
93 #define VIEW_MAILBOX 1 /* Mailbox summary */
94 #define VIEW_ADDRESSBOOK 2 /* Address book view */
95 #define VIEW_CALENDAR 3 /* Calendar view */
96 #define VIEW_TASKS 4 /* Tasks view */
97 #define VIEW_NOTES 5 /* Notes view */
98 #define VIEW_WIKI 6 /* Wiki view */
99 #define VIEW_CALBRIEF 7 /* Brief Calendar view */
100 #define VIEW_JOURNAL 8 /* Journal view */
101 #define VIEW_BLOG 9 /* Blog view (not yet implemented) */
105 #define IsEmptyStr(a) ((a)[0] == '\0')
110 * another word to indicate n/a for a pointer if NULL already has a "meaning"
112 extern const char *StrBufNOTNULL;
118 char *libcitadel_version_string(void);
119 int libcitadel_version_number(void);
120 void StartLibCitadel(size_t basesize);
121 void ShutDownLibCitadel(void);
124 * MIME parser declarations
127 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
130 typedef void (*MimeParserCallBackType)(char *cbname,
142 void mime_parser(char *content_start, char *content_end,
143 MimeParserCallBackType CallBack,
144 MimeParserCallBackType PreMultiPartCallBack,
145 MimeParserCallBackType PostMultiPartCallBack,
151 char *fixed_partnum(char *);
152 void mime_decode(char *partnum,
153 char *part_start, size_t length,
154 char *content_type, char *charset, char *encoding,
157 char *name, char *filename,
158 MimeParserCallBackType CallBack,
159 MimeParserCallBackType PreMultiPartCallBack,
160 MimeParserCallBackType PostMultiPartCallBack,
163 void the_mime_parser(char *partnum,
164 char *content_start, char *content_end,
165 MimeParserCallBackType CallBack,
166 MimeParserCallBackType PreMultiPartCallBack,
167 MimeParserCallBackType PostMultiPartCallBack,
171 typedef struct StrBuf StrBuf;
174 #define CStrOf(a) #a, sizeof(#a) - 1
175 typedef struct _ConstStr {
179 #define CKEY(a) (a).Key, (a).len
181 StrBuf* NewStrBuf(void);
182 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
183 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
184 long StrBufShrinkToFit(StrBuf *Buf, int Force);
185 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
187 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
188 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
189 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
190 void FreeStrBuf (StrBuf **FreeMe);
191 char *SmashStrBuf (StrBuf **SmashMe);
192 void HFreeStrBuf (void *VFreeMe);
193 int FlushStrBuf(StrBuf *buf);
194 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
196 const char *ChrPtr(const StrBuf *Str);
197 int StrLength(const StrBuf *Str);
198 #define SKEY(a) ChrPtr(a), StrLength(a)
199 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
200 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
202 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
203 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
206 int StrBufReadBLOBBuffered(StrBuf *Buf,
214 int StrBufTCP_read_buffered_line(StrBuf *Line,
218 int selectresolution,
220 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
225 int selectresolution,
228 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
229 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
230 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
231 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
233 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
234 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
235 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
236 int StrBufNum_tokens(const StrBuf *source, char tok);
237 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
239 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
240 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
241 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
242 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
243 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
244 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
247 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
248 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
249 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
250 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
251 #ifdef SHOW_ME_VAPPEND_PRINTF
252 /* so owe don't create an include depndency, this is just visible on demand. */
253 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
255 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
256 void StrBufCutLeft(StrBuf *Buf, int nChars);
257 void StrBufCutRight(StrBuf *Buf, int nChars);
258 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
259 void StrBufTrim(StrBuf *Buf);
260 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
261 void StrBufUpCase(StrBuf *Buf);
262 void StrBufLowerCase(StrBuf *Buf);
263 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
264 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
265 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
267 void StrBufToUnixLF(StrBuf *buf);
268 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
270 int CompressBuffer(StrBuf *Buf);
271 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
272 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
273 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
274 int StrBufDecodeBase64(StrBuf *Buf);
275 int StrBufDecodeHex(StrBuf *Buf);
276 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
277 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
279 StrBuf *EmailAddress,
281 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
282 #define LB (1) /* Internal escape chars */
285 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
286 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
287 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
288 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
289 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
290 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
291 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
293 long StrTol(const StrBuf *Buf);
294 int StrToi(const StrBuf *Buf);
295 int StrBufIsNumber(const StrBuf *Buf);
296 long StrBuf_Utf8StrLen(StrBuf *Buf);
297 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
299 const char *GuessMimeType(const char *data, size_t dlen);
300 const char* GuessMimeByFilename(const char *what, size_t len);
302 /* Run once at Programstart */
303 int LoadIconDir(const char *DirName);
305 /* Select the icon for a given MIME type */
306 const char *GetIconFilename(char *MimeType, size_t len);
312 int safestrncpy(char *dest, const char *src, size_t n);
313 int num_tokens (const char *source, char tok);
314 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
315 long grab_token(char **dest, const char *source, int parmnum, char separator);
316 int extract_int (const char *source, int parmnum);
317 long extract_long (const char *source, int parmnum);
318 unsigned long extract_unsigned_long(const char *source, int parmnum);
319 void CtdlInitBase64Table(void);
320 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
321 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
322 unsigned int decode_hex(char *Source);
323 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
324 void StripSlashes(char *Dir, int TrailingSlash);
325 size_t striplt(char *);
326 int haschar(const char *st, int ch);
327 void remove_token(char *source, int parmnum, char separator);
328 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
329 int is_msg_in_sequence_set(const char *mset, long msgnum);
330 char *memreadline(char *start, char *buf, int maxlen);
331 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
332 const char *cmemreadline(const char *start, char *buf, int maxlen);
333 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
334 #define IsEmptyStr(a) ((a)[0] == '\0')
335 #define num_parms(source) num_tokens(source,(char)'|')
336 int stripout(char *str, char leftboundary, char rightboundary);
337 void stripallbut(char *str, char leftboundary, char rightboundary);
338 char *myfgets(char *s, int size, FILE *stream);
339 void urlesc(char *outbuf, size_t oblen, char *strbuf);
340 char *CtdlTempFileName(char *prefix1, int prefix2);
341 FILE *CtdlTempFile(void);
342 void generate_uuid(char *buf);
343 char *bmstrcasestr(char *text, const char *pattern);
344 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
345 const char *cbmstrcasestr(const char *text, const char *pattern);
346 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
347 void CtdlMakeTempFileName(char *name, int len);
348 char *rfc2047encode(char *line, long length);
349 int is_msg_in_mset(const char *mset, long msgnum);
350 int pattern2(char *search, char *patn);
351 void stripltlen(char *, int *);
352 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
353 void LoadEntityList(char *FileName);
359 #define CTDL_VCARD_MAGIC 0xa1f9
361 /* This data structure represents a vCard object currently in memory. */
372 struct vCard *vcard_new(void);
373 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
374 struct vCard *vcard_load(char *vtext);
375 struct vCard *VCardLoad(StrBuf *vbtext);
377 void vcard_free(struct vCard *);
378 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
379 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
380 int instance, int return_propname);
381 char *vcard_serialize(struct vCard *);
382 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
383 void remove_charset_attribute(char *strbuf);
384 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
387 * Hash list implementation for Citadel
389 #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*) &a, sizeof(a)
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 GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
418 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
419 int GetHashPosCounter(HashList *Hash, HashPos *At);
420 void DeleteHashPos(HashPos **DelMe);
421 int NextHashPos(HashList *Hash, HashPos *At);
422 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
423 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
424 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
425 void SortByHashKey(HashList *Hash, int Order);
426 void SortByHashKeyStr(HashList *Hash);
427 int GetCount(HashList *Hash);
428 const void *GetSearchPayload(const void *HashVoid);
429 void SortByPayload(HashList *Hash, CompareFunc SortBy);
430 void reference_free_handler(void *ptr);
431 int HashLittle(const void *key, size_t length);
434 void convert_spaces_to_underscores(char *str);
435 int CheckEncode(const char *pch, long len, const char *pche);
438 * Convert 4 bytes char into an Integer.
439 * usefull for easy inexpensive hashing
440 * of for char strings.
442 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
444 /* vNote implementation */
446 #define CTDL_VNOTE_MAGIC 0xa1fa
464 struct vnote *vnote_new(void);
465 struct vnote *vnote_new_from_str(char *s);
466 void vnote_free(struct vnote *v);
467 char *vnote_serialize(struct vnote *v);
468 void vnote_serialize_output_field(char *append_to, char *field, char *label);
474 * Create JSON style structures in C plus serialize them to one string
477 typedef struct JsonValue JsonValue;
480 void DeleteJSONValue(void *vJsonValue);
482 JsonValue *NewJsonObject(const char *Key, long keylen);
484 JsonValue *NewJsonArray(const char *Key, long keylen);
486 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
488 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
490 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
492 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
494 JsonValue *NewJsonNull(const char *Key, long keylen);
496 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
498 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
500 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
502 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
507 * Citadels Wildfire implementation, see
508 * http://www.firephp.org/Wiki/Reference/Protocol
509 * and http://wildfirehq.org/ for details
511 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
513 typedef enum _WF_MessageType {
522 JsonValue *WildFireException(const char *Filename, long FileLen,
527 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
529 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
531 const char *Message, long len,
532 WF_MessageType Type);
534 JsonValue *WildFireMessage(const char *Filename, long fnlen,
537 WF_MessageType Type);
539 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
541 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
544 #define WF_STRUCTINDEX "1"
548 #endif // LIBCITADEL_H