2 /* protect against double includes */
8 * since we reference time_t...
13 #define LIBCITADEL_VERSION_NUMBER 785
16 * Here's a bunch of stupid magic to make the MIME parser portable.
23 /* Logging levels - correspond to syslog(3) */
25 /* When about to exit the server for an unrecoverable error */
26 CTDL_EMERG, /* system is unusable */
27 /* Manual intervention is required to avoid an abnormal exit */
28 CTDL_ALERT, /* action must be taken immediately */
29 /* The server can continue to run with degraded functionality */
30 CTDL_CRIT, /* critical conditions */
31 /* An error occurs but the server continues to run normally */
32 CTDL_ERR, /* error conditions */
33 /* An abnormal condition was detected; server will continue normally */
34 CTDL_WARNING, /* warning conditions */
35 /* Normal messages (login/out, activity, etc.) */
36 CTDL_NOTICE, /* normal but significant condition */
37 /* Unimportant progress messages, etc. */
38 CTDL_INFO, /* informational */
39 /* Debugging messages */
40 CTDL_DEBUG /* debug-level messages */
43 typedef enum AXLevel {
56 lastsent, /* Server internal use only */
67 typedef enum __GPEXWhichPolicy {
77 * Note that not all views are implemented in all clients.
79 #define VIEW_BBS 0 /* Bulletin board view */
80 #define VIEW_MAILBOX 1 /* Mailbox summary */
81 #define VIEW_ADDRESSBOOK 2 /* Address book view */
82 #define VIEW_CALENDAR 3 /* Calendar view */
83 #define VIEW_TASKS 4 /* Tasks view */
84 #define VIEW_NOTES 5 /* Notes view */
85 #define VIEW_WIKI 6 /* Wiki view */
86 #define VIEW_CALBRIEF 7 /* Brief Calendar view */
87 #define VIEW_JOURNAL 8 /* Journal view */
88 #define VIEW_BLOG 9 /* Blog view (not yet implemented) */
92 #define IsEmptyStr(a) ((a)[0] == '\0')
97 * another word to indicate n/a for a pointer if NULL already has a "meaning"
99 extern const char *StrBufNOTNULL;
105 char *libcitadel_version_string(void);
106 int libcitadel_version_number(void);
107 void StartLibCitadel(size_t basesize);
108 void ShutDownLibCitadel(void);
111 * MIME parser declarations
114 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
117 typedef void (*MimeParserCallBackType)(char *cbname,
129 void mime_parser(char *content_start, char *content_end,
130 MimeParserCallBackType CallBack,
131 MimeParserCallBackType PreMultiPartCallBack,
132 MimeParserCallBackType PostMultiPartCallBack,
138 char *fixed_partnum(char *);
139 void mime_decode(char *partnum,
140 char *part_start, size_t length,
141 char *content_type, char *charset, char *encoding,
144 char *name, char *filename,
145 MimeParserCallBackType CallBack,
146 MimeParserCallBackType PreMultiPartCallBack,
147 MimeParserCallBackType PostMultiPartCallBack,
150 void the_mime_parser(char *partnum,
151 char *content_start, char *content_end,
152 MimeParserCallBackType CallBack,
153 MimeParserCallBackType PreMultiPartCallBack,
154 MimeParserCallBackType PostMultiPartCallBack,
158 typedef struct StrBuf StrBuf;
161 #define CStrOf(a) #a, sizeof(#a) - 1
162 typedef struct _ConstStr {
166 #define CKEY(a) (a).Key, (a).len
168 StrBuf* NewStrBuf(void);
169 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
170 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
171 long StrBufShrinkToFit(StrBuf *Buf, int Force);
172 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
174 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
175 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
176 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
177 void FreeStrBuf (StrBuf **FreeMe);
178 char *SmashStrBuf (StrBuf **SmashMe);
179 void HFreeStrBuf (void *VFreeMe);
180 int FlushStrBuf(StrBuf *buf);
181 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
183 const char *ChrPtr(const StrBuf *Str);
184 int StrLength(const StrBuf *Str);
185 #define SKEY(a) ChrPtr(a), StrLength(a)
186 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
187 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
189 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
190 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
193 int StrBufReadBLOBBuffered(StrBuf *Buf,
201 int StrBufTCP_read_buffered_line(StrBuf *Line,
205 int selectresolution,
207 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
212 int selectresolution,
215 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
216 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
217 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
218 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long 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 int StrBufNum_tokens(const StrBuf *source, char tok);
224 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
226 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
227 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
228 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
229 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
230 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
231 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
234 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
235 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
236 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
237 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
238 #ifdef SHOW_ME_VAPPEND_PRINTF
239 /* so owe don't create an include depndency, this is just visible on demand. */
240 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
242 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
243 void StrBufCutLeft(StrBuf *Buf, int nChars);
244 void StrBufCutRight(StrBuf *Buf, int nChars);
245 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
246 void StrBufTrim(StrBuf *Buf);
247 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
248 void StrBufUpCase(StrBuf *Buf);
249 void StrBufLowerCase(StrBuf *Buf);
250 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
251 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
252 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
254 void StrBufToUnixLF(StrBuf *buf);
255 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
257 int CompressBuffer(StrBuf *Buf);
258 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
259 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
260 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
261 int StrBufDecodeBase64(StrBuf *Buf);
262 int StrBufDecodeHex(StrBuf *Buf);
263 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
264 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
266 StrBuf *EmailAddress,
268 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
269 #define LB (1) /* Internal escape chars */
272 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
273 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
274 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
275 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
276 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
277 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
278 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
280 long StrTol(const StrBuf *Buf);
281 int StrToi(const StrBuf *Buf);
282 int StrBufIsNumber(const StrBuf *Buf);
283 long StrBuf_Utf8StrLen(StrBuf *Buf);
284 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
286 const char *GuessMimeType(const char *data, size_t dlen);
287 const char* GuessMimeByFilename(const char *what, size_t len);
289 /* Run once at Programstart */
290 int LoadIconDir(const char *DirName);
292 /* Select the icon for a given MIME type */
293 const char *GetIconFilename(char *MimeType, size_t len);
299 int safestrncpy(char *dest, const char *src, size_t n);
300 int num_tokens (const char *source, char tok);
301 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
302 long grab_token(char **dest, const char *source, int parmnum, char separator);
303 int extract_int (const char *source, int parmnum);
304 long extract_long (const char *source, int parmnum);
305 unsigned long extract_unsigned_long(const char *source, int parmnum);
306 void CtdlInitBase64Table(void);
307 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
308 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
309 unsigned int decode_hex(char *Source);
310 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
311 void StripSlashes(char *Dir, int TrailingSlash);
312 size_t striplt(char *);
313 int haschar(const char *st, int ch);
314 void remove_token(char *source, int parmnum, char separator);
315 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
316 int is_msg_in_sequence_set(const char *mset, long msgnum);
317 char *memreadline(char *start, char *buf, int maxlen);
318 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
319 const char *cmemreadline(const char *start, char *buf, int maxlen);
320 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
321 #define IsEmptyStr(a) ((a)[0] == '\0')
322 #define num_parms(source) num_tokens(source,(char)'|')
323 int stripout(char *str, char leftboundary, char rightboundary);
324 void stripallbut(char *str, char leftboundary, char rightboundary);
325 char *myfgets(char *s, int size, FILE *stream);
326 void urlesc(char *outbuf, size_t oblen, char *strbuf);
327 char *CtdlTempFileName(char *prefix1, int prefix2);
328 FILE *CtdlTempFile(void);
329 void generate_uuid(char *buf);
330 char *bmstrcasestr(char *text, const char *pattern);
331 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
332 const char *cbmstrcasestr(const char *text, const char *pattern);
333 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
334 void CtdlMakeTempFileName(char *name, int len);
335 char *rfc2047encode(char *line, long length);
336 int is_msg_in_mset(const char *mset, long msgnum);
337 int pattern2(char *search, char *patn);
338 void stripltlen(char *, int *);
339 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
340 void LoadEntityList(char *FileName);
346 #define CTDL_VCARD_MAGIC 0xa1f9
348 /* This data structure represents a vCard object currently in memory. */
359 struct vCard *vcard_new(void);
360 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
361 struct vCard *vcard_load(char *vtext);
362 struct vCard *VCardLoad(StrBuf *vbtext);
364 void vcard_free(struct vCard *);
365 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
366 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
367 int instance, int return_propname);
368 char *vcard_serialize(struct vCard *);
369 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
370 void remove_charset_attribute(char *strbuf);
371 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
374 * Hash list implementation for Citadel
376 #define HKEY(a) a, (sizeof(a) - 1)
378 typedef struct HashList HashList;
380 typedef struct HashKey HashKey;
382 typedef struct HashPos HashPos;
384 typedef void (*DeleteHashDataFunc)(void * Data);
385 typedef const char *(*PrintHashContent)(void * Data);
386 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
387 typedef int (*HashFunc)(const char *Str, long Len);
388 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
389 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
391 int Flathash(const char *str, long len);
392 #define IKEY(a) (const char*) &a, sizeof(a)
394 HashList *NewHash(int Uniq, HashFunc F);
395 void DeleteHash(HashList **Hash);
396 void HDeleteHash(void *vHash);
397 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
398 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
399 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
400 int GetHashKeys(HashList *Hash, char ***List);
401 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
402 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
403 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
404 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
405 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
406 int GetHashPosCounter(HashList *Hash, HashPos *At);
407 void DeleteHashPos(HashPos **DelMe);
408 int NextHashPos(HashList *Hash, HashPos *At);
409 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
410 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
411 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
412 void SortByHashKey(HashList *Hash, int Order);
413 void SortByHashKeyStr(HashList *Hash);
414 int GetCount(HashList *Hash);
415 const void *GetSearchPayload(const void *HashVoid);
416 void SortByPayload(HashList *Hash, CompareFunc SortBy);
417 void reference_free_handler(void *ptr);
418 int HashLittle(const void *key, size_t length);
421 void convert_spaces_to_underscores(char *str);
422 int CheckEncode(const char *pch, long len, const char *pche);
425 * Convert 4 bytes char into an Integer.
426 * usefull for easy inexpensive hashing
427 * of for char strings.
429 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
431 /* vNote implementation */
433 #define CTDL_VNOTE_MAGIC 0xa1fa
451 struct vnote *vnote_new(void);
452 struct vnote *vnote_new_from_str(char *s);
453 void vnote_free(struct vnote *v);
454 char *vnote_serialize(struct vnote *v);
455 void vnote_serialize_output_field(char *append_to, char *field, char *label);
461 * Create JSON style structures in C plus serialize them to one string
464 typedef struct JsonValue JsonValue;
467 void DeleteJSONValue(void *vJsonValue);
469 JsonValue *NewJsonObject(const char *Key, long keylen);
471 JsonValue *NewJsonArray(const char *Key, long keylen);
473 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
475 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
477 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
479 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
481 JsonValue *NewJsonNull(const char *Key, long keylen);
483 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
485 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
487 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
489 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
494 * Citadels Wildfire implementation, see
495 * http://www.firephp.org/Wiki/Reference/Protocol
496 * and http://wildfirehq.org/ for details
498 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
500 typedef enum _WF_MessageType {
509 JsonValue *WildFireException(const char *Filename, long FileLen,
514 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
516 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
518 const char *Message, long len,
519 WF_MessageType Type);
521 JsonValue *WildFireMessage(const char *Filename, long fnlen,
524 WF_MessageType Type);
526 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
528 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
531 #define WF_STRUCTINDEX "1"
535 #endif // LIBCITADEL_H