2 * Header file for libcitadel
4 * Copyright (c) 1987-2018 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 922
34 * Here's a bunch of stupid magic to make the MIME parser portable.
41 typedef enum AXLevel {
51 typedef enum __RoomNetCfg {
54 lastsent = 2, /* Server internal use only */
65 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
69 GNET_POP3_DONT_DELETE_REMOTE = 4,
70 GNET_POP3_INTERVAL = 5
73 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
78 typedef enum __GPEXWhichPolicy {
88 * Note that not all views are implemented in all clients.
90 typedef enum _room_views {
91 VIEW_BBS = 0, /* Bulletin board view */
92 VIEW_MAILBOX = 1, /* Mailbox summary */
93 VIEW_ADDRESSBOOK = 2, /* Address book view */
94 VIEW_CALENDAR = 3, /* Calendar view */
95 VIEW_TASKS = 4, /* Tasks view */
96 VIEW_NOTES = 5, /* Notes view */
97 VIEW_WIKI = 6, /* Wiki view */
98 VIEW_CALBRIEF = 7, /* Brief Calendar view */
99 VIEW_JOURNAL = 8, /* Journal view */
100 VIEW_DRAFTS = 9, /* Drafts view */
101 VIEW_BLOG = 10, /* Blog view */
102 VIEW_QUEUE = 11, /* SMTP/... QUEUE rooms */
103 VIEW_WIKIMD = 12, /* Markdown Wiki view */
108 #define BLOG_EUIDBUF_SIZE 40
111 #define IsEmptyStr(a) ( ( (a) == NULL ) || ((a)[0] == '\0') )
116 * another word to indicate n/a for a pointer if NULL already has a "meaning"
118 extern const char *StrBufNOTNULL;
124 char *libcitadel_version_string(void);
125 int libcitadel_version_number(void);
126 void StartLibCitadel(size_t basesize);
127 void ShutDownLibCitadel(void);
130 * MIME parser declarations
133 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
136 typedef void (*MimeParserCallBackType)(char *cbname,
148 void mime_parser(char *content_start, char *content_end,
149 MimeParserCallBackType CallBack,
150 MimeParserCallBackType PreMultiPartCallBack,
151 MimeParserCallBackType PostMultiPartCallBack,
157 char *fixed_partnum(char *);
158 void mime_decode(char *partnum,
159 char *part_start, size_t length,
160 char *content_type, char *charset, char *encoding,
163 char *name, char *filename,
164 MimeParserCallBackType CallBack,
165 MimeParserCallBackType PreMultiPartCallBack,
166 MimeParserCallBackType PostMultiPartCallBack,
169 int mime_decode_now (char *part_start,
173 size_t *bytes_decoded);
174 void the_mime_parser(char *partnum,
175 char *content_start, char *content_end,
176 MimeParserCallBackType CallBack,
177 MimeParserCallBackType PreMultiPartCallBack,
178 MimeParserCallBackType PostMultiPartCallBack,
182 typedef struct StrBuf StrBuf;
185 #define CStrOf(a) #a, sizeof(#a) - 1
186 typedef struct _ConstStr {
190 #define CKEY(a) (a).Key, (a).len
192 StrBuf* NewStrBuf(void);
193 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
194 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
195 void SwapBuffers(StrBuf *A, StrBuf *B);
196 long StrBufShrinkToFit(StrBuf *Buf, int Force);
197 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
198 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
200 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
201 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
202 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
203 void FreeStrBuf (StrBuf **FreeMe);
204 char *SmashStrBuf (StrBuf **SmashMe);
205 void HFreeStrBuf (void *VFreeMe);
206 int FlushStrBuf(StrBuf *buf);
207 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
209 const char *ChrPtr(const StrBuf *Str);
210 int StrLength(const StrBuf *Str);
211 #define SKEY(a) ChrPtr(a), StrLength(a)
212 void StrBufAsciify(StrBuf *Buf, const char repl);
213 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
214 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
216 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
217 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
220 int StrBufReadBLOBBuffered(StrBuf *Buf,
228 int StrBufTCP_read_buffered_line(StrBuf *Line,
232 int selectresolution,
234 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
239 int selectresolution,
242 typedef enum _eReadState {
249 typedef struct _file_buffer {
251 const char *ReadWritePointer;
254 int nBlobBytesWanted;
257 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
258 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
260 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
261 eReadState StrBufCheckBuffer(IOBuffer *FB);
262 long IOBufferStrLength(IOBuffer *FB);
264 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
265 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
266 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
267 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
268 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
270 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
271 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
272 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
273 int StrBufNum_tokens(const StrBuf *source, char tok);
274 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
276 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
277 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
278 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
279 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
280 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
281 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
284 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
285 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
286 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
287 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
288 #ifdef SHOW_ME_VAPPEND_PRINTF
289 /* so owe don't create an include depndency, this is just visible on demand. */
290 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
292 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
293 void StrBufCutLeft(StrBuf *Buf, int nChars);
294 void StrBufCutRight(StrBuf *Buf, int nChars);
295 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
296 void StrBufTrim(StrBuf *Buf);
297 void StrBufSpaceToBlank(StrBuf *Buf);
298 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
299 void StrBufUpCase(StrBuf *Buf);
300 void StrBufLowerCase(StrBuf *Buf);
301 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
302 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
303 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
305 void StrBufToUnixLF(StrBuf *buf);
306 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
308 int CompressBuffer(StrBuf *Buf);
309 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
310 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
311 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
312 const StrBuf *DecodeMe,
313 const StrBuf* DefaultCharset,
314 StrBuf *FoundCharset,
316 StrBuf *ConvertBuf2);
317 /* deprecated old version: */
318 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
320 typedef enum __eStreamType {
328 typedef struct vStreamT vStreamT;
329 vStreamT *StrBufNewStreamContext(eStreamType type, const char **Err);
330 int StrBufDestroyStreamContext(eStreamType type, vStreamT **Stream, const char **Err);
331 int StrBufStreamTranscode(eStreamType type, IOBuffer *Target, IOBuffer *In, const char* pIn, long pInLen, vStreamT *Stream, int LastChunk, const char **Err);
333 int StrBufDecodeBase64(StrBuf *Buf);
334 void StrBufDecodeQP(StrBuf *Buf);
335 int StrBufDecodeBase64To(const StrBuf *BufIn, StrBuf *BufOut);
336 int StrBufDecodeHex(StrBuf *Buf);
337 StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe);
338 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
339 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
341 StrBuf *EmailAddress,
343 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
344 #define LB (1) /* Internal escape chars */
347 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
348 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
349 void StrBufXMLEscAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int OverrideLowChars);
350 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
351 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
352 void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks);
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 int is_msg_in_sequence_set(const char *mset, long msgnum);
423 char *memreadline(char *start, char *buf, int maxlen);
424 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
425 const char *cmemreadline(const char *start, char *buf, int maxlen);
426 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
427 #define num_parms(source) num_tokens(source,(char)'|')
428 int stripout(char *str, char leftboundary, char rightboundary);
429 long stripallbut(char *str, char leftboundary, char rightboundary);
430 char *myfgets(char *s, int size, FILE *stream);
431 void urlesc(char *outbuf, size_t oblen, char *strbuf);
432 char *CtdlTempFileName(char *prefix1, int prefix2);
433 FILE *CtdlTempFile(void);
434 void generate_uuid(char *buf);
435 char *bmstrcasestr(char *text, const char *pattern);
436 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
437 const char *cbmstrcasestr(const char *text, const char *pattern);
438 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
439 void CtdlMakeTempFileName(char *name, int len);
440 char *rfc2047encode(const char *line, long length);
441 int is_msg_in_mset(const char *mset, long msgnum);
442 int pattern2(char *search, char *patn);
443 void stripltlen(char *, int *);
444 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth);
445 void LoadEntityList(char *FileName);
451 #define CTDL_VCARD_MAGIC 0xa1f9
453 /* This data structure represents a vCard object currently in memory. */
464 struct vCard *vcard_new(void);
465 void vcard_add_prop(struct vCard *v, const char *propname, const char *propvalue);
466 struct vCard *vcard_load(char *vtext);
467 struct vCard *VCardLoad(StrBuf *vbtext);
469 void vcard_free(struct vCard *);
470 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
471 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
472 int instance, int return_propname);
473 char *vcard_serialize(struct vCard *);
474 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
475 void remove_charset_attribute(char *strbuf);
476 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
479 * Hash list implementation for Citadel
481 #define HKEY(a) a, (sizeof(a) - 1)
483 typedef struct HashList HashList;
485 typedef struct HashKey HashKey;
487 typedef struct HashPos HashPos;
489 typedef void (*DeleteHashDataFunc)(void * Data);
490 typedef const char *(*PrintHashContent)(void * Data);
491 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
492 typedef long (*HashFunc)(const char *Str, long Len);
493 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
494 typedef const char* (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
496 long FourHash(const char *key, long length);
497 long Flathash(const char *str, long len);
498 long lFlathash(const char *str, long len);
499 #define IKEY(a) (const char*) &a, sizeof(a)
500 #define LKEY(a) (const char*) &a, sizeof(a)
502 int TestValidateHash(HashList *TestHash);
504 HashList *NewHash(int Uniq, HashFunc F);
505 void DeleteHash(HashList **Hash);
506 void DeleteHashContent(HashList **Hash);
507 void HDeleteHash(void *vHash);
508 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
509 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
510 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
511 int GetHashKeys(HashList *Hash, char ***List);
512 const char *dbg_PrintStrBufPayload(const char *Key, void *Item, int Odd);
513 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
514 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
515 HashPos *GetNewHashPos(const HashList *Hash, int StepWidth);
516 void RewindHashPos(const HashList *Hash, HashPos *it, int StepWidth);
517 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
518 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
519 int GetHashPosCounter(HashList *Hash, HashPos *At);
520 void DeleteHashPos(HashPos **DelMe);
521 int NextHashPos(HashList *Hash, HashPos *At);
522 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
523 int GetNextHashPos(const HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
524 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
525 void SortByHashKey(HashList *Hash, int Order);
526 void SortByHashKeyStr(HashList *Hash);
527 int GetCount(HashList *Hash);
528 const void *GetSearchPayload(const void *HashVoid);
529 void SortByPayload(HashList *Hash, CompareFunc SortBy);
530 void reference_free_handler(void *ptr);
531 int HashLittle(const void *key, size_t length);
533 typedef struct MSet MSet;
534 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
535 int IsInMSetList(MSet *MSetList, long MsgNo);
536 void DeleteMSet(MSet **FreeMe);
538 void convert_spaces_to_underscores(char *str);
539 int CheckEncode(const char *pch, long len, const char *pche);
542 * Convert 4 bytes char into an Integer.
543 * usefull for easy inexpensive hashing
544 * of for char strings.
546 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
548 /* vNote implementation */
550 #define CTDL_VNOTE_MAGIC 0xa1fa
568 struct vnote *vnote_new(void);
569 struct vnote *vnote_new_from_str(char *s);
570 void vnote_free(struct vnote *v);
571 char *vnote_serialize(struct vnote *v);
572 void vnote_serialize_output_field(char *append_to, char *field, char *label);
578 * Create JSON style structures in C plus serialize them to one string
581 typedef struct JsonValue JsonValue;
584 void DeleteJSONValue(void *vJsonValue);
586 JsonValue *NewJsonObject(const char *Key, long keylen);
588 JsonValue *NewJsonArray(const char *Key, long keylen);
590 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
592 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
595 NEWJSONSTRING_COPYBUF, // make a copy of the StrBuf, source is left alone
596 NEWJSONSTRING_SMASHBUF // smash the source StrBuf, the json object now owns that memory
598 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe, int copy_or_smash);
600 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
602 JsonValue *NewJsonNull(const char *Key, long keylen);
604 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
606 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
608 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
610 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
615 * Citadels Wildfire implementation, see
616 * http://www.firephp.org/Wiki/Reference/Protocol
617 * and http://wildfirehq.org/ for details
619 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
621 typedef enum _WF_MessageType {
630 JsonValue *WildFireException(const char *Filename, long FileLen,
635 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
637 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
639 const char *Message, long len,
640 WF_MessageType Type);
642 JsonValue *WildFireMessage(const char *Filename, long fnlen,
645 WF_MessageType Type);
647 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
649 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
652 #define WF_STRUCTINDEX "1"
655 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
657 /* Convenience function to "perform a function and cut a log record if result != 0" */
658 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
660 /* a nice consistent place to define how we turn a message id into a thread id hash */
661 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
662 #define ThreadIdHashOffset(Buf, Offset) abs(HashLittle(ChrPtr(Buf) + Offset, StrLength(Buf)-Offset))
668 #define CFG_SMTP_FROM_FILTERALL 0
669 #define CFG_SMTP_FROM_NOFILTER 1
670 #define CFG_SMTP_FROM_CORRECT 2
671 #define CFG_SMTP_FROM_REJECT 3
673 * MIME types used in Citadel for configuration stuff
675 #define SPOOLMIME "application/x-citadel-delivery-list"
676 #define INTERNETCFG "application/x-citadel-internet-config"
677 #define IGNETCFG "application/x-citadel-ignet-config"
678 #define IGNETMAP "application/x-citadel-ignet-map"
679 #define FILTERLIST "application/x-citadel-filter-list"
680 #define SIEVECONFIG "application/x-citadel-sieve-config"
681 #define XMPPMORTUARY "application/x-citadel-xmpp-mortuary"
683 #define FILE_MAILALIAS "__MAIL_ALIAS__"
685 #define LISTING_FOLLOWS 100
687 #define MORE_DATA 300
688 #define SEND_LISTING 400
690 #define BINARY_FOLLOWS 600
691 #define SEND_BINARY 700
692 #define START_CHAT_MODE 800
694 #define INTERNAL_ERROR 10
696 #define ILLEGAL_VALUE 12
697 #define NOT_LOGGED_IN 20
698 #define CMD_NOT_SUPPORTED 30
699 #define SERVER_SHUTTING_DOWN 31
700 #define PASSWORD_REQUIRED 40
701 #define ALREADY_LOGGED_IN 41
702 #define USERNAME_REQUIRED 42
703 #define HIGHER_ACCESS_REQUIRED 50
704 #define MAX_SESSIONS_EXCEEDED 51
705 #define RESOURCE_BUSY 52
706 #define RESOURCE_NOT_OPEN 53
708 #define INVALID_FLOOR_OPERATION 61
709 #define NO_SUCH_USER 70
710 #define FILE_NOT_FOUND 71
711 #define ROOM_NOT_FOUND 72
712 #define NO_SUCH_SYSTEM 73
713 #define ALREADY_EXISTS 74
714 #define MESSAGE_NOT_FOUND 75
716 #define ASYNC_MSG 900
717 #define ASYNC_GEXP 02
719 #define QR_PERMANENT 1 /* Room does not purge */
720 #define QR_INUSE 2 /* Set if in use, clear if avail */
721 #define QR_PRIVATE 4 /* Set for any type of private room */
722 #define QR_PASSWORDED 8 /* Set if there's a password too */
723 #define QR_GUESSNAME 16 /* Set if it's a guessname room */
724 #define QR_DIRECTORY 32 /* Directory room */
725 #define QR_UPLOAD 64 /* Allowed to upload */
726 #define QR_DOWNLOAD 128 /* Allowed to download */
727 #define QR_VISDIR 256 /* Visible directory */
728 #define QR_ANONONLY 512 /* Anonymous-Only room */
729 #define QR_ANONOPT 1024 /* Anonymous-Option room */
730 #define QR_NETWORK 2048 /* Shared network room */
731 #define QR_PREFONLY 4096 /* Preferred status needed to enter */
732 #define QR_READONLY 8192 /* Admin status required to post */
733 #define QR_MAILBOX 16384 /* Set if this is a private mailbox */
735 #define QR2_SYSTEM 1 /* System room; hide by default */
736 #define QR2_SELFLIST 2 /* Self-service mailing list mgmt */
737 #define QR2_COLLABDEL 4 /* Anyone who can post can delete */
738 #define QR2_SUBJECTREQ 8 /* Subject strongly recommended */
739 #define QR2_SMTP_PUBLIC 16 /* Listservice Subscribers may post */
740 #define QR2_MODERATED 32 /* Listservice aide has to permit posts */
741 #define QR2_NOUPLMSG 64 /* If a file is uploaded, no message will be posted. */
743 #define US_NEEDVALID 1 /* User needs to be validated */
744 #define US_EXTEDIT 2 /* Always use external editor */
745 #define US_PERM 4 /* Permanent user */
746 #define US_LASTOLD 16 /* Print last old message with new */
747 #define US_EXPERT 32 /* Experienced user */
748 #define US_UNLISTED 64 /* Unlisted userlog entry */
749 #define US_NOPROMPT 128 /* Don't prompt after each message */
750 #define US_PROMPTCTL 256 /* <N>ext & <S>top work at prompt */
751 #define US_DISAPPEAR 512 /* Use "disappearing msg prompts" */
752 #define US_REGIS 1024 /* Registered user */
753 #define US_PAGINATOR 2048 /* Pause after each screen of text */
754 #define US_INTERNET 4096 /* Internet mail privileges */
755 #define US_FLOORS 8192 /* User wants to see floors */
756 #define US_COLOR 16384 /* User wants ANSI color support */
757 #define US_USER_SET (US_LASTOLD | US_EXPERT | US_UNLISTED | \
758 US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
759 US_FLOORS | US_COLOR | US_PROMPTCTL | US_EXTEDIT)
761 #define UA_KNOWN 2 /* Room appears in a 'known rooms' list */
762 #define UA_GOTOALLOWED 4 /* User may goto this room if specified by exact name */
763 #define UA_HASNEWMSGS 8 /* Unread messages exist in this room */
764 #define UA_ZAPPED 16 /* User has forgotten (zapped) this room */
765 #define UA_POSTALLOWED 32 /* User may post top-level messages here */
766 #define UA_ADMINALLOWED 64 /* Admin or Room Admin rights exist here */
767 #define UA_DELETEALLOWED 128 /* User is allowed to delete messages from this room */
768 #define UA_REPLYALLOWED 256 /* User is allowed to reply to existing messages here */
769 /* runtime flag extracted from goto reply; not db persistant, should be moved if new flags added */
770 #define UA_ISTRASH 512 /* Only available in room view... */
776 #endif // LIBCITADEL_H