7 /* protect against double includes */
13 * since we reference time_t...
18 #define LIBCITADEL_VERSION_NUMBER 780
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 */
72 typedef enum __GPEXWhichPolicy {
82 * Note that not all views are implemented in all clients.
84 #define VIEW_BBS 0 /* Bulletin board view */
85 #define VIEW_MAILBOX 1 /* Mailbox summary */
86 #define VIEW_ADDRESSBOOK 2 /* Address book view */
87 #define VIEW_CALENDAR 3 /* Calendar view */
88 #define VIEW_TASKS 4 /* Tasks view */
89 #define VIEW_NOTES 5 /* Notes view */
90 #define VIEW_WIKI 6 /* Wiki view */
91 #define VIEW_CALBRIEF 7 /* Brief Calendar view */
92 #define VIEW_JOURNAL 8 /* Journal view */
93 #define VIEW_BLOG 9 /* Blog view (not yet implemented) */
97 #define IsEmptyStr(a) ((a)[0] == '\0')
102 * another word to indicate n/a for a pointer if NULL already has a "meaning"
104 extern const char *StrBufNOTNULL;
110 char *libcitadel_version_string(void);
111 int libcitadel_version_number(void);
112 void StartLibCitadel(size_t basesize);
113 void ShutDownLibCitadel(void);
116 * MIME parser declarations
119 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
122 typedef void (*MimeParserCallBackType)(char *cbname,
134 void mime_parser(char *content_start, char *content_end,
135 MimeParserCallBackType CallBack,
136 MimeParserCallBackType PreMultiPartCallBack,
137 MimeParserCallBackType PostMultiPartCallBack,
143 char *fixed_partnum(char *);
144 void mime_decode(char *partnum,
145 char *part_start, size_t length,
146 char *content_type, char *charset, char *encoding,
149 char *name, char *filename,
150 MimeParserCallBackType CallBack,
151 MimeParserCallBackType PreMultiPartCallBack,
152 MimeParserCallBackType PostMultiPartCallBack,
155 void the_mime_parser(char *partnum,
156 char *content_start, char *content_end,
157 MimeParserCallBackType CallBack,
158 MimeParserCallBackType PreMultiPartCallBack,
159 MimeParserCallBackType PostMultiPartCallBack,
163 typedef struct StrBuf StrBuf;
166 #define CStrOf(a) #a, sizeof(#a) - 1
167 typedef struct _ConstStr {
171 #define CKEY(a) (a).Key, (a).len
173 StrBuf* NewStrBuf(void);
174 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
175 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
176 long StrBufShrinkToFit(StrBuf *Buf, int Force);
177 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
179 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
180 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
181 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
182 void FreeStrBuf (StrBuf **FreeMe);
183 char *SmashStrBuf (StrBuf **SmashMe);
184 void HFreeStrBuf (void *VFreeMe);
185 int FlushStrBuf(StrBuf *buf);
186 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
188 const char *ChrPtr(const StrBuf *Str);
189 int StrLength(const StrBuf *Str);
190 #define SKEY(a) ChrPtr(a), StrLength(a)
191 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
192 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
194 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
195 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
198 int StrBufReadBLOBBuffered(StrBuf *Buf,
206 int StrBufTCP_read_buffered_line(StrBuf *Line,
210 int selectresolution,
212 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
217 int selectresolution,
220 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
221 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
222 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
223 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
225 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
226 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
227 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
228 int StrBufNum_tokens(const StrBuf *source, char tok);
229 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
231 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
232 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
233 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
234 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
235 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
236 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
239 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
240 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
241 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
242 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
243 #ifdef SHOW_ME_VAPPEND_PRINTF
244 /* so owe don't create an include depndency, this is just visible on demand. */
245 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
247 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
248 void StrBufCutLeft(StrBuf *Buf, int nChars);
249 void StrBufCutRight(StrBuf *Buf, int nChars);
250 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
251 void StrBufTrim(StrBuf *Buf);
252 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
253 void StrBufUpCase(StrBuf *Buf);
254 void StrBufLowerCase(StrBuf *Buf);
255 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
256 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
257 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
259 void StrBufToUnixLF(StrBuf *buf);
260 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
262 int CompressBuffer(StrBuf *Buf);
263 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
264 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
265 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
266 int StrBufDecodeBase64(StrBuf *Buf);
267 int StrBufDecodeHex(StrBuf *Buf);
268 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
269 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
270 #define LB (1) /* Internal escape chars */
273 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
274 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
275 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
276 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
277 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
278 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
279 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
281 long StrTol(const StrBuf *Buf);
282 int StrToi(const StrBuf *Buf);
283 int StrBufIsNumber(const StrBuf *Buf);
284 long StrBuf_Utf8StrLen(StrBuf *Buf);
285 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
287 const char *GuessMimeType(const char *data, size_t dlen);
288 const char* GuessMimeByFilename(const char *what, size_t len);
290 /* Run once at Programstart */
291 int LoadIconDir(const char *DirName);
293 /* Select the icon for a given MIME type */
294 const char *GetIconFilename(char *MimeType, size_t len);
300 int safestrncpy(char *dest, const char *src, size_t n);
301 int num_tokens (const char *source, char tok);
302 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
303 long grab_token(char **dest, const char *source, int parmnum, char separator);
304 int extract_int (const char *source, int parmnum);
305 long extract_long (const char *source, int parmnum);
306 unsigned long extract_unsigned_long(const char *source, int parmnum);
307 void CtdlInitBase64Table(void);
308 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
309 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
310 unsigned int decode_hex(char *Source);
311 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
312 void StripSlashes(char *Dir, int TrailingSlash);
313 size_t striplt(char *);
314 int haschar(const char *st, int ch);
315 void remove_token(char *source, int parmnum, char separator);
316 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
317 int is_msg_in_sequence_set(const char *mset, long msgnum);
318 const char *memreadline(const char *start, char *buf, int maxlen);
319 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
320 #define IsEmptyStr(a) ((a)[0] == '\0')
321 #define num_parms(source) num_tokens(source,(char)'|')
322 int stripout(char *str, char leftboundary, char rightboundary);
323 void stripallbut(char *str, char leftboundary, char rightboundary);
324 char *myfgets(char *s, int size, FILE *stream);
325 void urlesc(char *outbuf, size_t oblen, char *strbuf);
326 char *CtdlTempFileName(char *prefix1, int prefix2);
327 FILE *CtdlTempFile(void);
328 void generate_uuid(char *buf);
329 const char *bmstrcasestr(const char *text, const char *pattern);
330 const char *bmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
331 void CtdlMakeTempFileName(char *name, int len);
332 char *rfc2047encode(char *line, long length);
333 int is_msg_in_mset(const char *mset, long msgnum);
334 int pattern2(char *search, char *patn);
335 void stripltlen(char *, int *);
336 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
337 void LoadEntityList(char *FileName);
343 #define CTDL_VCARD_MAGIC 0xa1f9
345 /* This data structure represents a vCard object currently in memory. */
356 struct vCard *vcard_new(void);
357 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
358 struct vCard *vcard_load(char *vtext);
359 struct vCard *VCardLoad(StrBuf *vbtext);
361 void vcard_free(struct vCard *);
362 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
363 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
364 int instance, int return_propname);
365 char *vcard_serialize(struct vCard *);
366 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
367 void remove_charset_attribute(char *strbuf);
368 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
371 * Hash list implementation for Citadel
373 #define HKEY(a) a, (sizeof(a) - 1)
375 typedef struct HashList HashList;
377 typedef struct HashKey HashKey;
379 typedef struct HashPos HashPos;
381 typedef void (*DeleteHashDataFunc)(void * Data);
382 typedef const char *(*PrintHashContent)(void * Data);
383 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
384 typedef int (*HashFunc)(const char *Str, long Len);
385 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
386 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
388 int Flathash(const char *str, long len);
389 #define IKEY(a) (const char*) &a, sizeof(a)
391 HashList *NewHash(int Uniq, HashFunc F);
392 void DeleteHash(HashList **Hash);
393 void HDeleteHash(void *vHash);
394 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
395 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
396 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
397 int GetHashKeys(HashList *Hash, char ***List);
398 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
399 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
400 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
401 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
402 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
403 int GetHashPosCounter(HashList *Hash, HashPos *At);
404 void DeleteHashPos(HashPos **DelMe);
405 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
406 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
407 void SortByHashKey(HashList *Hash, int Order);
408 void SortByHashKeyStr(HashList *Hash);
409 int GetCount(HashList *Hash);
410 const void *GetSearchPayload(const void *HashVoid);
411 void SortByPayload(HashList *Hash, CompareFunc SortBy);
412 void generic_free_handler(void *ptr);
413 void reference_free_handler(void *ptr);
414 int HashLittle(const void *key, size_t length);
417 void convert_spaces_to_underscores(char *str);
420 * Convert 4 bytes char into an Integer.
421 * usefull for easy inexpensive hashing
422 * of for char strings.
424 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
426 /* vNote implementation */
428 #define CTDL_VNOTE_MAGIC 0xa1fa
446 struct vnote *vnote_new(void);
447 struct vnote *vnote_new_from_str(char *s);
448 void vnote_free(struct vnote *v);
449 char *vnote_serialize(struct vnote *v);
450 void vnote_serialize_output_field(char *append_to, char *field, char *label);
456 * Create JSON style structures in C plus serialize them to one string
459 typedef struct JsonValue JsonValue;
462 void DeleteJSONValue(void *vJsonValue);
464 JsonValue *NewJsonObject(const char *Key, long keylen);
466 JsonValue *NewJsonArray(const char *Key, long keylen);
468 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
470 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
472 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
474 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
476 JsonValue *NewJsonNull(const char *Key, long keylen);
478 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
480 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
482 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
484 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
489 * Citadels Wildfire implementation, see
490 * http://www.firephp.org/Wiki/Reference/Protocol
491 * and http://wildfirehq.org/ for details
493 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
495 typedef enum _WF_MessageType {
504 JsonValue *WildFireException(const char *Filename, long FileLen,
509 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
511 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
513 const char *Message, long len,
514 WF_MessageType Type);
516 JsonValue *WildFireMessage(const char *Filename, long fnlen,
519 WF_MessageType Type);
521 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
523 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
526 #define WF_STRUCTINDEX "1"
530 #endif // LIBCITADEL_H