X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=libcitadel%2Flib%2Flibcitadel.h;h=b035a474454276b9e379772c5b4ebb73b4ac1089;hb=48537c783a8d9769e005719f1268f83b1598e09e;hp=a0a70305a574fc8d45674910de43054463f6d12c;hpb=8bfe7498818fed3f6e0e0c8d228662706bcf8ae5;p=citadel.git diff --git a/libcitadel/lib/libcitadel.h b/libcitadel/lib/libcitadel.h index a0a70305a..b035a4744 100644 --- a/libcitadel/lib/libcitadel.h +++ b/libcitadel/lib/libcitadel.h @@ -1,7 +1,7 @@ /* * Header file for libcitadel * - * Copyright (c) 1987-2012 by the citadel.org team + * Copyright (c) 1987-2018 by the citadel.org team * * This program is open source software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 3. @@ -12,12 +12,10 @@ * GNU General Public License for more details. */ - /* protect against double includes */ #ifndef LIBCITADEL_H #define LIBCITADEL_H - /* * since we reference time_t... */ @@ -28,7 +26,7 @@ #include #include -#define LIBCITADEL_VERSION_NUMBER 810 +#define LIBCITADEL_VERSION_NUMBER 924 /* * Here's a bunch of stupid magic to make the MIME parser portable. @@ -37,7 +35,6 @@ #define SIZ 4096 #endif - typedef enum AXLevel { AxDeleted = 0, AxNewU = 1, @@ -48,18 +45,19 @@ typedef enum AXLevel { AxAideU = 6 }eUsrAxlvl; -enum RoomNetCfg { - subpending, - unsubpending, - lastsent, /* Server internal use only */ - ignet_push_share, - listrecp, - digestrecp, - pop3client, - rssclient, - participate, +typedef enum __RoomNetCfg { + subpending = 0, + unsubpending = 1, + lastsent = 2, /* Server internal use only */ + ignet_push_share = 3, + listrecp = 4, + digestrecp = 5, + pop3client = 6, + rssclient = 7, + participate = 8, + roommailalias = 9, maxRoomNetCfg -}; +} RoomNetCfg; enum GNET_POP3_PARTS { /* pop3client splits into these columns: */ GNET_POP3_HOST = 1, @@ -99,13 +97,15 @@ typedef enum _room_views { VIEW_DRAFTS = 9, /* Drafts view */ VIEW_BLOG = 10, /* Blog view */ VIEW_QUEUE = 11, /* SMTP/... QUEUE rooms */ - VIEW_MAX + VIEW_WIKIMD = 12, /* Markdown Wiki view */ + VIEW_MAX, + VIEW_JSON_LIST, } ROOM_VIEWS; #define BLOG_EUIDBUF_SIZE 40 #ifndef IsEmptyStr -#define IsEmptyStr(a) ((a)[0] == '\0') +#define IsEmptyStr(a) ( ( (a) == NULL ) || ((a)[0] == '\0') ) #endif @@ -149,9 +149,8 @@ void mime_parser(char *content_start, char *content_end, void *userdata, int dont_decode); - - char *fixed_partnum(char *); + void mime_decode(char *partnum, char *part_start, size_t length, char *content_type, char *charset, char *encoding, @@ -163,11 +162,13 @@ void mime_decode(char *partnum, MimeParserCallBackType PostMultiPartCallBack, void *userdata, int dont_decode); + int mime_decode_now (char *part_start, size_t length, char *encoding, char **decoded, size_t *bytes_decoded); + void the_mime_parser(char *partnum, char *content_start, char *content_end, MimeParserCallBackType CallBack, @@ -189,10 +190,10 @@ typedef struct _ConstStr { StrBuf* NewStrBuf(void); StrBuf* NewStrBufDup(const StrBuf *CopyMe); StrBuf* NewStrBufPlain(const char* ptr, int nChars); +void SwapBuffers(StrBuf *A, StrBuf *B); long StrBufShrinkToFit(StrBuf *Buf, int Force); void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize); void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal); - int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars); StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant); #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a)) @@ -201,13 +202,12 @@ char *SmashStrBuf (StrBuf **SmashMe); void HFreeStrBuf (void *VFreeMe); int FlushStrBuf(StrBuf *buf); int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */ - const char *ChrPtr(const StrBuf *Str); int StrLength(const StrBuf *Str); #define SKEY(a) ChrPtr(a), StrLength(a) +void StrBufAsciify(StrBuf *Buf, const char repl); long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue); long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue); - int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error); int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error); #define NNN_TERM 1 @@ -249,25 +249,6 @@ typedef struct _file_buffer { int nBlobBytesWanted; } IOBuffer; - -typedef struct __fd_iobuffer { - IOBuffer *IOB; - int OtherFD; - int SplicePipe[2]; - long TotalSendSize; - long TotalSentAlready; - long ChunkSize; - long ChunkSendRemain; - StrBuf *ChunkBuffer; /* just used if we don't have sendfile */ -} FDIOBuffer; - - -void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize); -void FDIOBufferDelete(FDIOBuffer *FDB); -int FileSendChunked(FDIOBuffer *FDB, const char **Err); -int FileRecvChunked(FDIOBuffer *FDB, const char **Err); -eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error); - long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB); int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB); @@ -277,6 +258,7 @@ long IOBufferStrLength(IOBuffer *FB); int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr); int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen); +int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator); int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator); int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars); @@ -330,8 +312,24 @@ void StrBuf_RFC822_2_Utf8(StrBuf *Target, /* deprecated old version: */ void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset); +typedef enum __eStreamType { + eBase64Encode, + eBase64Decode, + eZLibEncode, + eZLibDecode, + eEmtyCodec +} eStreamType; + +typedef struct vStreamT vStreamT; +vStreamT *StrBufNewStreamContext(eStreamType type, const char **Err); +int StrBufDestroyStreamContext(eStreamType type, vStreamT **Stream, const char **Err); +int StrBufStreamTranscode(eStreamType type, IOBuffer *Target, IOBuffer *In, const char* pIn, long pInLen, vStreamT *Stream, int LastChunk, const char **Err); + int StrBufDecodeBase64(StrBuf *Buf); +void StrBufDecodeQP(StrBuf *Buf); +int StrBufDecodeBase64To(const StrBuf *BufIn, StrBuf *BufOut); int StrBufDecodeHex(StrBuf *Buf); +StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe); int StrBufRFC2047encode(StrBuf **target, const StrBuf *source); StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp, StrBuf *UserName, @@ -342,8 +340,11 @@ int StrBufSanitizeAscii(StrBuf *Buf, const char Mute); #define RB (2) #define QU (3) void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn); +void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn); +void StrBufXMLEscAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int OverrideLowChars); void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn); void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen); +void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks); long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks); long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn); long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks); @@ -385,6 +386,9 @@ struct ParsedURL { struct hostent *HEnt; struct sockaddr_in6 Addr; ParsedURL *Next; + int IsRelay; + StrBuf *UsrName; + StrBuf *Password; }; void FreeURL(ParsedURL** Url); @@ -410,13 +414,11 @@ void StripSlashes(char *Dir, int TrailingSlash); size_t striplt(char *); int haschar(const char *st, int ch); void remove_token(char *source, int parmnum, char separator); -void fmt_date(char *buf, size_t n, time_t thetime, int seconds); int is_msg_in_sequence_set(const char *mset, long msgnum); char *memreadline(char *start, char *buf, int maxlen); char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen); const char *cmemreadline(const char *start, char *buf, int maxlen); const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen); -#define IsEmptyStr(a) ((a)[0] == '\0') #define num_parms(source) num_tokens(source,(char)'|') int stripout(char *str, char leftboundary, char rightboundary); long stripallbut(char *str, char leftboundary, char rightboundary); @@ -430,11 +432,11 @@ char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t p const char *cbmstrcasestr(const char *text, const char *pattern); const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen); void CtdlMakeTempFileName(char *name, int len); -char *rfc2047encode(char *line, long length); +char *rfc2047encode(const char *line, long length); int is_msg_in_mset(const char *mset, long msgnum); int pattern2(char *search, char *patn); void stripltlen(char *, int *); -char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat); +char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth); void LoadEntityList(char *FileName); @@ -455,7 +457,7 @@ struct vCard { struct vCard *vcard_new(void); -void vcard_add_prop(struct vCard *v, char *propname, char *propvalue); +void vcard_add_prop(struct vCard *v, const char *propname, const char *propvalue); struct vCard *vcard_load(char *vtext); struct vCard *VCardLoad(StrBuf *vbtext); @@ -484,8 +486,9 @@ typedef const char *(*PrintHashContent)(void * Data); typedef int (*CompareFunc)(const void* Item1, const void*Item2); typedef long (*HashFunc)(const char *Str, long Len); typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd); -typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd); +typedef const char* (*PrintHashDataFunc) (const char *Key, void *Item, int Odd); +long FourHash(const char *key, long length); long Flathash(const char *str, long len); long lFlathash(const char *str, long len); #define IKEY(a) (const char*) &a, sizeof(a) @@ -501,16 +504,18 @@ int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data); void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt); int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data); int GetHashKeys(HashList *Hash, char ***List); +const char *dbg_PrintStrBufPayload(const char *Key, void *Item, int Odd); int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second); int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry); -HashPos *GetNewHashPos(HashList *Hash, int StepWidth); +HashPos *GetNewHashPos(const HashList *Hash, int StepWidth); +void RewindHashPos(const HashList *Hash, HashPos *it, int StepWidth); int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At); int DeleteEntryFromHash(HashList *Hash, HashPos *At); int GetHashPosCounter(HashList *Hash, HashPos *At); void DeleteHashPos(HashPos **DelMe); int NextHashPos(HashList *Hash, HashPos *At); int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data); -int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data); +int GetNextHashPos(const HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data); int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data); void SortByHashKey(HashList *Hash, int Order); void SortByHashKeyStr(HashList *Hash); @@ -581,7 +586,11 @@ JsonValue *NewJsonNumber(const char *Key, long keylen, long Number); JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number); -JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe); +enum { + NEWJSONSTRING_COPYBUF, // make a copy of the StrBuf, source is left alone + NEWJSONSTRING_SMASHBUF // smash the source StrBuf, the json object now owns that memory +}; +JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe, int copy_or_smash); JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len); @@ -596,12 +605,7 @@ void JsonObjectAppend(JsonValue *Array, JsonValue *Val); void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal); - -/* - * Citadels Wildfire implementation, see - * http://www.firephp.org/Wiki/Reference/Protocol - * and http://wildfirehq.org/ for details - */ +/* the following declarations are leftover from the defunct wildfire implementation. can we remove them? */ typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue); typedef enum _WF_MessageType { @@ -645,6 +649,118 @@ extern ConstStr RoomNetCfgStrs[maxRoomNetCfg]; /* a nice consistent place to define how we turn a message id into a thread id hash */ #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf))) +#define ThreadIdHashOffset(Buf, Offset) abs(HashLittle(ChrPtr(Buf) + Offset, StrLength(Buf)-Offset)) + +#ifdef __cplusplus +extern "C" { +#endif +#define CFG_SMTP_FROM_FILTERALL 0 +#define CFG_SMTP_FROM_NOFILTER 1 +#define CFG_SMTP_FROM_CORRECT 2 +#define CFG_SMTP_FROM_REJECT 3 +/* + * MIME types used in Citadel for configuration stuff + */ +#define SPOOLMIME "application/x-citadel-delivery-list" +#define INTERNETCFG "application/x-citadel-internet-config" +#define IGNETCFG "application/x-citadel-ignet-config" +#define IGNETMAP "application/x-citadel-ignet-map" +#define FILTERLIST "application/x-citadel-filter-list" +#define SIEVECONFIG "application/x-citadel-sieve-config" +#define XMPPMORTUARY "application/x-citadel-xmpp-mortuary" + +#define FILE_MAILALIAS "__MAIL_ALIAS__" + +#define LISTING_FOLLOWS 100 +#define CIT_OK 200 +#define MORE_DATA 300 +#define SEND_LISTING 400 +#define ERROR 500 +#define BINARY_FOLLOWS 600 +#define SEND_BINARY 700 +#define START_CHAT_MODE 800 + +#define INTERNAL_ERROR 10 +#define TOO_BIG 11 +#define ILLEGAL_VALUE 12 +#define NOT_LOGGED_IN 20 +#define CMD_NOT_SUPPORTED 30 +#define SERVER_SHUTTING_DOWN 31 +#define PASSWORD_REQUIRED 40 +#define ALREADY_LOGGED_IN 41 +#define USERNAME_REQUIRED 42 +#define HIGHER_ACCESS_REQUIRED 50 +#define MAX_SESSIONS_EXCEEDED 51 +#define RESOURCE_BUSY 52 +#define RESOURCE_NOT_OPEN 53 +#define NOT_HERE 60 +#define INVALID_FLOOR_OPERATION 61 +#define NO_SUCH_USER 70 +#define FILE_NOT_FOUND 71 +#define ROOM_NOT_FOUND 72 +#define NO_SUCH_SYSTEM 73 +#define ALREADY_EXISTS 74 +#define MESSAGE_NOT_FOUND 75 + +#define ASYNC_MSG 900 +#define ASYNC_GEXP 02 + +#define QR_PERMANENT 1 /* Room does not purge */ +#define QR_INUSE 2 /* Set if in use, clear if avail */ +#define QR_PRIVATE 4 /* Set for any type of private room */ +#define QR_PASSWORDED 8 /* Set if there's a password too */ +#define QR_GUESSNAME 16 /* Set if it's a guessname room */ +#define QR_DIRECTORY 32 /* Directory room */ +#define QR_UPLOAD 64 /* Allowed to upload */ +#define QR_DOWNLOAD 128 /* Allowed to download */ +#define QR_VISDIR 256 /* Visible directory */ +#define QR_ANONONLY 512 /* Anonymous-Only room */ +#define QR_ANONOPT 1024 /* Anonymous-Option room */ +#define QR_NETWORK 2048 /* Shared network room */ +#define QR_PREFONLY 4096 /* Preferred status needed to enter */ +#define QR_READONLY 8192 /* Admin status required to post */ +#define QR_MAILBOX 16384 /* Set if this is a private mailbox */ + +#define QR2_SYSTEM 1 /* System room; hide by default */ +#define QR2_SELFLIST 2 /* Self-service mailing list mgmt */ +#define QR2_COLLABDEL 4 /* Anyone who can post can delete */ +#define QR2_SUBJECTREQ 8 /* Subject strongly recommended */ +#define QR2_SMTP_PUBLIC 16 /* Listservice Subscribers may post */ +#define QR2_MODERATED 32 /* Listservice aide has to permit posts */ +#define QR2_NOUPLMSG 64 /* If a file is uploaded, no message will be posted. */ + +#define US_NEEDVALID 1 /* User needs to be validated */ +#define US_EXTEDIT 2 /* Always use external editor */ +#define US_PERM 4 /* Permanent user */ +#define US_LASTOLD 16 /* Print last old message with new */ +#define US_EXPERT 32 /* Experienced user */ +#define US_UNLISTED 64 /* Unlisted userlog entry */ +#define US_NOPROMPT 128 /* Don't prompt after each message */ +#define US_PROMPTCTL 256 /* ext & top work at prompt */ +#define US_DISAPPEAR 512 /* Use "disappearing msg prompts" */ +#define US_REGIS 1024 /* Registered user */ +#define US_PAGINATOR 2048 /* Pause after each screen of text */ +#define US_INTERNET 4096 /* Internet mail privileges */ +#define US_FLOORS 8192 /* User wants to see floors */ +#define US_COLOR 16384 /* User wants ANSI color support */ +#define US_USER_SET (US_LASTOLD | US_EXPERT | US_UNLISTED | \ + US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \ + US_FLOORS | US_COLOR | US_PROMPTCTL | US_EXTEDIT) + +#define UA_KNOWN 2 /* Room appears in a 'known rooms' list */ +#define UA_GOTOALLOWED 4 /* User may goto this room if specified by exact name */ +#define UA_HASNEWMSGS 8 /* Unread messages exist in this room */ +#define UA_ZAPPED 16 /* User has forgotten (zapped) this room */ +#define UA_POSTALLOWED 32 /* User may post top-level messages here */ +#define UA_ADMINALLOWED 64 /* Admin or Room Admin rights exist here */ +#define UA_DELETEALLOWED 128 /* User is allowed to delete messages from this room */ +#define UA_REPLYALLOWED 256 /* User is allowed to reply to existing messages here */ +/* runtime flag extracted from goto reply; not db persistant, should be moved if new flags added */ +#define UA_ISTRASH 512 /* Only available in room view... */ + +#ifdef __cplusplus +} +#endif #endif // LIBCITADEL_H