2 * Header file for libcitadel
4 * Copyright (c) 1987-2012 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 /* protect against double includes */
22 * since we reference time_t...
27 #include <arpa/inet.h>
28 #include <sys/types.h>
29 #include <netinet/in.h>
31 #define LIBCITADEL_VERSION_NUMBER 815
34 * Here's a bunch of stupid magic to make the MIME parser portable.
41 typedef enum AXLevel {
54 lastsent, /* Server internal use only */
64 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
68 GNET_POP3_DONT_DELETE_REMOTE = 4,
69 GNET_POP3_INTERVAL = 5
72 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
77 typedef enum __GPEXWhichPolicy {
87 * Note that not all views are implemented in all clients.
89 typedef enum _room_views {
90 VIEW_BBS = 0, /* Bulletin board view */
91 VIEW_MAILBOX = 1, /* Mailbox summary */
92 VIEW_ADDRESSBOOK = 2, /* Address book view */
93 VIEW_CALENDAR = 3, /* Calendar view */
94 VIEW_TASKS = 4, /* Tasks view */
95 VIEW_NOTES = 5, /* Notes view */
96 VIEW_WIKI = 6, /* Wiki view */
97 VIEW_CALBRIEF = 7, /* Brief Calendar view */
98 VIEW_JOURNAL = 8, /* Journal view */
99 VIEW_DRAFTS = 9, /* Drafts view */
100 VIEW_BLOG = 10, /* Blog view */
101 VIEW_QUEUE = 11, /* SMTP/... QUEUE rooms */
106 #define BLOG_EUIDBUF_SIZE 40
109 #define IsEmptyStr(a) ((a)[0] == '\0')
114 * another word to indicate n/a for a pointer if NULL already has a "meaning"
116 extern const char *StrBufNOTNULL;
122 char *libcitadel_version_string(void);
123 int libcitadel_version_number(void);
124 void StartLibCitadel(size_t basesize);
125 void ShutDownLibCitadel(void);
128 * MIME parser declarations
131 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
134 typedef void (*MimeParserCallBackType)(char *cbname,
146 void mime_parser(char *content_start, char *content_end,
147 MimeParserCallBackType CallBack,
148 MimeParserCallBackType PreMultiPartCallBack,
149 MimeParserCallBackType PostMultiPartCallBack,
155 char *fixed_partnum(char *);
156 void mime_decode(char *partnum,
157 char *part_start, size_t length,
158 char *content_type, char *charset, char *encoding,
161 char *name, char *filename,
162 MimeParserCallBackType CallBack,
163 MimeParserCallBackType PreMultiPartCallBack,
164 MimeParserCallBackType PostMultiPartCallBack,
167 int mime_decode_now (char *part_start,
171 size_t *bytes_decoded);
172 void the_mime_parser(char *partnum,
173 char *content_start, char *content_end,
174 MimeParserCallBackType CallBack,
175 MimeParserCallBackType PreMultiPartCallBack,
176 MimeParserCallBackType PostMultiPartCallBack,
180 typedef struct StrBuf StrBuf;
183 #define CStrOf(a) #a, sizeof(#a) - 1
184 typedef struct _ConstStr {
188 #define CKEY(a) (a).Key, (a).len
190 StrBuf* NewStrBuf(void);
191 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
192 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
193 long StrBufShrinkToFit(StrBuf *Buf, int Force);
194 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
195 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
197 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
198 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
199 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
200 void FreeStrBuf (StrBuf **FreeMe);
201 char *SmashStrBuf (StrBuf **SmashMe);
202 void HFreeStrBuf (void *VFreeMe);
203 int FlushStrBuf(StrBuf *buf);
204 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
206 const char *ChrPtr(const StrBuf *Str);
207 int StrLength(const StrBuf *Str);
208 #define SKEY(a) ChrPtr(a), StrLength(a)
209 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
210 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
212 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
213 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
216 int StrBufReadBLOBBuffered(StrBuf *Buf,
224 int StrBufTCP_read_buffered_line(StrBuf *Line,
228 int selectresolution,
230 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
235 int selectresolution,
238 typedef enum _eReadState {
245 typedef struct _file_buffer {
247 const char *ReadWritePointer;
250 int nBlobBytesWanted;
254 typedef struct __fd_iobuffer {
260 long TotalSentAlready;
261 long TotalReadAlready;
263 long ChunkSendRemain;
264 StrBuf *ChunkBuffer; /* just used if we don't have sendfile */
268 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize);
269 void FDIOBufferDelete(FDIOBuffer *FDB);
270 int FileSendChunked(FDIOBuffer *FDB, const char **Err);
271 int FileRecvChunked(FDIOBuffer *FDB, const char **Err);
272 int FileMoveChunked(FDIOBuffer *FDB, const char **Err);
273 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error);
275 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
276 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
278 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
279 eReadState StrBufCheckBuffer(IOBuffer *FB);
280 long IOBufferStrLength(IOBuffer *FB);
282 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
283 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
284 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
285 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
286 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
288 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
289 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
290 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
291 int StrBufNum_tokens(const StrBuf *source, char tok);
292 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
294 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
295 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
296 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
297 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
298 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
299 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
302 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
303 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
304 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
305 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
306 #ifdef SHOW_ME_VAPPEND_PRINTF
307 /* so owe don't create an include depndency, this is just visible on demand. */
308 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
310 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
311 void StrBufCutLeft(StrBuf *Buf, int nChars);
312 void StrBufCutRight(StrBuf *Buf, int nChars);
313 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
314 void StrBufTrim(StrBuf *Buf);
315 void StrBufSpaceToBlank(StrBuf *Buf);
316 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
317 void StrBufUpCase(StrBuf *Buf);
318 void StrBufLowerCase(StrBuf *Buf);
319 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
320 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
321 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
323 void StrBufToUnixLF(StrBuf *buf);
324 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
326 int CompressBuffer(StrBuf *Buf);
327 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
328 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
329 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
330 const StrBuf *DecodeMe,
331 const StrBuf* DefaultCharset,
332 StrBuf *FoundCharset,
334 StrBuf *ConvertBuf2);
335 /* deprecated old version: */
336 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
338 int StrBufDecodeBase64(StrBuf *Buf);
339 int StrBufDecodeHex(StrBuf *Buf);
340 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
341 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
343 StrBuf *EmailAddress,
345 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
346 #define LB (1) /* Internal escape chars */
349 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
350 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
351 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
352 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
353 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
354 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
355 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
356 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
357 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
359 long StrTol(const StrBuf *Buf);
360 int StrToi(const StrBuf *Buf);
361 int StrBufIsNumber(const StrBuf *Buf);
362 long StrBuf_Utf8StrLen(StrBuf *Buf);
363 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
365 const char *GuessMimeType(const char *data, size_t dlen);
366 const char* GuessMimeByFilename(const char *what, size_t len);
368 /* Run once at Programstart */
369 int LoadIconDir(const char *DirName);
371 /* Select the icon for a given MIME type */
372 const char *GetIconFilename(char *MimeType, size_t len);
375 /* URL parsing & connection data */
376 typedef struct ParsedURL ParsedURL;
380 StrBuf *UrlWithoutCred;
386 const char *LocalPart;
387 const char *PlainUrl;
391 struct hostent *HEnt;
392 struct sockaddr_in6 Addr;
399 void FreeURL(ParsedURL** Url);
400 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
401 void CurlPrepareURL(ParsedURL *Url);
406 int safestrncpy(char *dest, const char *src, size_t n);
407 int num_tokens (const char *source, char tok);
408 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
409 long grab_token(char **dest, const char *source, int parmnum, char separator);
410 int extract_int (const char *source, int parmnum);
411 long extract_long (const char *source, int parmnum);
412 unsigned long extract_unsigned_long(const char *source, int parmnum);
413 void CtdlInitBase64Table(void);
414 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
415 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
416 unsigned int decode_hex(char *Source);
417 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
418 void StripSlashes(char *Dir, int TrailingSlash);
419 size_t striplt(char *);
420 int haschar(const char *st, int ch);
421 void remove_token(char *source, int parmnum, char separator);
422 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
423 int is_msg_in_sequence_set(const char *mset, long msgnum);
424 char *memreadline(char *start, char *buf, int maxlen);
425 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
426 const char *cmemreadline(const char *start, char *buf, int maxlen);
427 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
428 #define IsEmptyStr(a) ((a)[0] == '\0')
429 #define num_parms(source) num_tokens(source,(char)'|')
430 int stripout(char *str, char leftboundary, char rightboundary);
431 long stripallbut(char *str, char leftboundary, char rightboundary);
432 char *myfgets(char *s, int size, FILE *stream);
433 void urlesc(char *outbuf, size_t oblen, char *strbuf);
434 char *CtdlTempFileName(char *prefix1, int prefix2);
435 FILE *CtdlTempFile(void);
436 void generate_uuid(char *buf);
437 char *bmstrcasestr(char *text, const char *pattern);
438 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
439 const char *cbmstrcasestr(const char *text, const char *pattern);
440 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
441 void CtdlMakeTempFileName(char *name, int len);
442 char *rfc2047encode(char *line, long length);
443 int is_msg_in_mset(const char *mset, long msgnum);
444 int pattern2(char *search, char *patn);
445 void stripltlen(char *, int *);
446 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
447 void LoadEntityList(char *FileName);
453 #define CTDL_VCARD_MAGIC 0xa1f9
455 /* This data structure represents a vCard object currently in memory. */
466 struct vCard *vcard_new(void);
467 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
468 struct vCard *vcard_load(char *vtext);
469 struct vCard *VCardLoad(StrBuf *vbtext);
471 void vcard_free(struct vCard *);
472 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
473 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
474 int instance, int return_propname);
475 char *vcard_serialize(struct vCard *);
476 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
477 void remove_charset_attribute(char *strbuf);
478 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
481 * Hash list implementation for Citadel
483 #define HKEY(a) a, (sizeof(a) - 1)
485 typedef struct HashList HashList;
487 typedef struct HashKey HashKey;
489 typedef struct HashPos HashPos;
491 typedef void (*DeleteHashDataFunc)(void * Data);
492 typedef const char *(*PrintHashContent)(void * Data);
493 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
494 typedef long (*HashFunc)(const char *Str, long Len);
495 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
496 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
498 long Flathash(const char *str, long len);
499 long lFlathash(const char *str, long len);
500 #define IKEY(a) (const char*) &a, sizeof(a)
501 #define LKEY(a) (const char*) &a, sizeof(a)
503 int TestValidateHash(HashList *TestHash);
505 HashList *NewHash(int Uniq, HashFunc F);
506 void DeleteHash(HashList **Hash);
507 void DeleteHashContent(HashList **Hash);
508 void HDeleteHash(void *vHash);
509 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
510 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
511 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
512 int GetHashKeys(HashList *Hash, char ***List);
513 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
514 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
515 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
516 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
517 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
518 int GetHashPosCounter(HashList *Hash, HashPos *At);
519 void DeleteHashPos(HashPos **DelMe);
520 int NextHashPos(HashList *Hash, HashPos *At);
521 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
522 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
523 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
524 void SortByHashKey(HashList *Hash, int Order);
525 void SortByHashKeyStr(HashList *Hash);
526 int GetCount(HashList *Hash);
527 const void *GetSearchPayload(const void *HashVoid);
528 void SortByPayload(HashList *Hash, CompareFunc SortBy);
529 void reference_free_handler(void *ptr);
530 int HashLittle(const void *key, size_t length);
532 typedef struct MSet MSet;
533 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
534 int IsInMSetList(MSet *MSetList, long MsgNo);
535 void DeleteMSet(MSet **FreeMe);
537 void convert_spaces_to_underscores(char *str);
538 int CheckEncode(const char *pch, long len, const char *pche);
541 * Convert 4 bytes char into an Integer.
542 * usefull for easy inexpensive hashing
543 * of for char strings.
545 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
547 /* vNote implementation */
549 #define CTDL_VNOTE_MAGIC 0xa1fa
567 struct vnote *vnote_new(void);
568 struct vnote *vnote_new_from_str(char *s);
569 void vnote_free(struct vnote *v);
570 char *vnote_serialize(struct vnote *v);
571 void vnote_serialize_output_field(char *append_to, char *field, char *label);
577 * Create JSON style structures in C plus serialize them to one string
580 typedef struct JsonValue JsonValue;
583 void DeleteJSONValue(void *vJsonValue);
585 JsonValue *NewJsonObject(const char *Key, long keylen);
587 JsonValue *NewJsonArray(const char *Key, long keylen);
589 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
591 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
593 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
595 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
597 JsonValue *NewJsonNull(const char *Key, long keylen);
599 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
601 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
603 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
605 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
610 * Citadels Wildfire implementation, see
611 * http://www.firephp.org/Wiki/Reference/Protocol
612 * and http://wildfirehq.org/ for details
614 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
616 typedef enum _WF_MessageType {
625 JsonValue *WildFireException(const char *Filename, long FileLen,
630 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
632 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
634 const char *Message, long len,
635 WF_MessageType Type);
637 JsonValue *WildFireMessage(const char *Filename, long fnlen,
640 WF_MessageType Type);
642 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
644 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
647 #define WF_STRUCTINDEX "1"
650 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
652 /* Convenience function to "perform a function and cut a log record if result != 0" */
653 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
655 /* a nice consistent place to define how we turn a message id into a thread id hash */
656 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
659 #endif // LIBCITADEL_H