2 * Header file for libcitadel
4 * Copyright (c) 1987-2021 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.
15 /* protect against double includes */
20 * since we reference time_t...
25 #include <arpa/inet.h>
26 #include <sys/types.h>
27 #include <netinet/in.h>
29 #define LIBCITADEL_VERSION_NUMBER 932
32 * Here's a bunch of stupid magic to make the MIME parser portable.
38 typedef enum AXLevel {
48 typedef enum __RoomNetCfg {
51 lastsent = 2, /* Server internal use only */
62 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
66 GNET_POP3_DONT_DELETE_REMOTE = 4,
67 GNET_POP3_INTERVAL = 5
70 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
75 typedef enum __GPEXWhichPolicy {
85 * Note that not all views are implemented in all clients.
87 typedef enum _room_views {
88 VIEW_BBS = 0, /* Bulletin board view */
89 VIEW_MAILBOX = 1, /* Mailbox summary */
90 VIEW_ADDRESSBOOK = 2, /* Address book view */
91 VIEW_CALENDAR = 3, /* Calendar view */
92 VIEW_TASKS = 4, /* Tasks view */
93 VIEW_NOTES = 5, /* Notes view */
94 VIEW_WIKI = 6, /* Wiki view */
95 VIEW_CALBRIEF = 7, /* Brief Calendar view */
96 VIEW_JOURNAL = 8, /* Journal view */
97 VIEW_DRAFTS = 9, /* Drafts view */
98 VIEW_BLOG = 10, /* Blog view */
99 VIEW_QUEUE = 11, /* SMTP/... QUEUE rooms */
100 VIEW_WIKIMD = 12, /* Markdown Wiki view */
105 #define BLOG_EUIDBUF_SIZE 40
108 #define IsEmptyStr(a) ( ( (a) == NULL ) || ((a)[0] == '\0') )
113 * another word to indicate n/a for a pointer if NULL already has a "meaning"
115 extern const char *StrBufNOTNULL;
121 char *libcitadel_version_string(void);
122 int libcitadel_version_number(void);
123 void ShutDownLibCitadel(void);
126 * MIME parser declarations
129 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
132 typedef void (*MimeParserCallBackType)(char *cbname,
144 void mime_parser(char *content_start, char *content_end,
145 MimeParserCallBackType CallBack,
146 MimeParserCallBackType PreMultiPartCallBack,
147 MimeParserCallBackType PostMultiPartCallBack,
151 char *fixed_partnum(char *);
153 void mime_decode(char *partnum,
154 char *part_start, size_t length,
155 char *content_type, char *charset, char *encoding,
158 char *name, char *filename,
159 MimeParserCallBackType CallBack,
160 MimeParserCallBackType PreMultiPartCallBack,
161 MimeParserCallBackType PostMultiPartCallBack,
165 int mime_decode_now (char *part_start,
169 size_t *bytes_decoded);
171 void the_mime_parser(char *partnum,
172 char *content_start, char *content_end,
173 MimeParserCallBackType CallBack,
174 MimeParserCallBackType PreMultiPartCallBack,
175 MimeParserCallBackType PostMultiPartCallBack,
179 typedef struct StrBuf StrBuf;
182 #define CStrOf(a) #a, sizeof(#a) - 1
183 typedef struct _ConstStr {
187 #define CKEY(a) (a).Key, (a).len
189 StrBuf* NewStrBuf(void);
190 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
191 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
192 void SwapBuffers(StrBuf *A, StrBuf *B);
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);
196 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
197 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
198 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
199 void FreeStrBuf (StrBuf **FreeMe);
200 char *SmashStrBuf (StrBuf **SmashMe);
201 void HFreeStrBuf (void *VFreeMe);
202 int FlushStrBuf(StrBuf *buf);
203 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
204 const char *ChrPtr(const StrBuf *Str);
205 int StrLength(const StrBuf *Str);
206 #define SKEY(a) ChrPtr(a), StrLength(a)
207 void StrBufAsciify(StrBuf *Buf, const char repl);
208 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
209 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
210 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
211 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
214 int StrBufReadBLOBBuffered(StrBuf *Buf,
222 int StrBufTCP_read_buffered_line(StrBuf *Line,
226 int selectresolution,
228 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
233 int selectresolution,
236 typedef enum _eReadState {
243 typedef struct _file_buffer {
245 const char *ReadWritePointer;
248 int nBlobBytesWanted;
251 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
252 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
254 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
255 eReadState StrBufCheckBuffer(IOBuffer *FB);
256 long IOBufferStrLength(IOBuffer *FB);
258 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
259 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
260 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
261 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
262 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
264 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
265 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
266 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
267 int StrBufNum_tokens(const StrBuf *source, char tok);
268 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
270 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
271 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
272 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
273 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
274 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
275 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
278 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
279 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
280 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
281 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
282 #ifdef SHOW_ME_VAPPEND_PRINTF
283 /* so owe don't create an include depndency, this is just visible on demand. */
284 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
286 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
287 void StrBufCutLeft(StrBuf *Buf, int nChars);
288 void StrBufCutRight(StrBuf *Buf, int nChars);
289 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
290 void StrBufTrim(StrBuf *Buf);
291 void StrBufSpaceToBlank(StrBuf *Buf);
292 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
293 void StrBufUpCase(StrBuf *Buf);
294 void StrBufLowerCase(StrBuf *Buf);
295 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
296 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
297 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
299 void StrBufToUnixLF(StrBuf *buf);
300 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
302 int CompressBuffer(StrBuf *Buf);
303 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
304 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
305 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
306 const StrBuf *DecodeMe,
307 const StrBuf* DefaultCharset,
308 StrBuf *FoundCharset,
310 StrBuf *ConvertBuf2);
311 /* deprecated old version: */
312 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
314 typedef enum __eStreamType {
322 typedef struct vStreamT vStreamT;
323 vStreamT *StrBufNewStreamContext(eStreamType type, const char **Err);
324 int StrBufDestroyStreamContext(eStreamType type, vStreamT **Stream, const char **Err);
325 int StrBufStreamTranscode(eStreamType type, IOBuffer *Target, IOBuffer *In, const char* pIn, long pInLen, vStreamT *Stream, int LastChunk, const char **Err);
327 int StrBufDecodeBase64(StrBuf *Buf);
328 void StrBufDecodeQP(StrBuf *Buf);
329 int StrBufDecodeBase64To(const StrBuf *BufIn, StrBuf *BufOut);
330 int StrBufDecodeHex(StrBuf *Buf);
331 StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe);
332 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
333 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
335 StrBuf *EmailAddress,
337 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
338 #define LB (1) /* Internal escape chars */
341 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
342 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
343 void StrBufXMLEscAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int OverrideLowChars);
344 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
345 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
346 void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks);
347 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
348 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
349 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
350 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
351 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
353 long StrTol(const StrBuf *Buf);
354 int StrToi(const StrBuf *Buf);
355 int StrBufIsNumber(const StrBuf *Buf);
356 long StrBuf_Utf8StrLen(StrBuf *Buf);
357 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
359 const char *GuessMimeType(const char *data, size_t dlen);
360 const char* GuessMimeByFilename(const char *what, size_t len);
362 /* Run once at Programstart */
363 int LoadIconDir(const char *DirName);
365 /* Select the icon for a given MIME type */
366 const char *GetIconFilename(char *MimeType, size_t len);
369 /* URL parsing & connection data */
370 typedef struct ParsedURL ParsedURL;
374 StrBuf *UrlWithoutCred;
380 const char *LocalPart;
381 const char *PlainUrl;
385 struct hostent *HEnt;
386 struct sockaddr_in6 Addr;
393 void FreeURL(ParsedURL** Url);
394 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
395 void CurlPrepareURL(ParsedURL *Url);
400 int safestrncpy(char *dest, const char *src, size_t n);
401 int num_tokens (const char *source, char tok);
402 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
403 long grab_token(char **dest, const char *source, int parmnum, char separator);
404 int extract_int (const char *source, int parmnum);
405 long extract_long (const char *source, int parmnum);
406 unsigned long extract_unsigned_long(const char *source, int parmnum);
407 void CtdlInitBase64Table(void);
408 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
409 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
410 unsigned int decode_hex(char *Source);
411 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
412 void StripSlashes(char *Dir, int TrailingSlash);
413 size_t striplt(char *);
414 int haschar(const char *st, int ch);
415 void remove_token(char *source, int parmnum, char separator);
416 int is_msg_in_sequence_set(const char *mset, long msgnum);
417 char *memreadline(char *start, char *buf, int maxlen);
418 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
419 const char *cmemreadline(const char *start, char *buf, int maxlen);
420 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
421 #define num_parms(source) num_tokens(source,(char)'|')
422 int stripout(char *str, char leftboundary, char rightboundary);
423 long stripallbut(char *str, char leftboundary, char rightboundary);
424 char *myfgets(char *s, int size, FILE *stream);
425 void urlesc(char *outbuf, size_t oblen, char *strbuf);
426 char *CtdlTempFileName(char *prefix1, int prefix2);
427 FILE *CtdlTempFile(void);
428 void generate_uuid(char *buf);
429 char *bmstrcasestr(char *text, const char *pattern);
430 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
431 const char *cbmstrcasestr(const char *text, const char *pattern);
432 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
433 void CtdlMakeTempFileName(char *name, int len);
434 char *rfc2047encode(const char *line, long length);
435 int is_msg_in_mset(const char *mset, long msgnum);
436 int pattern2(char *search, char *patn);
437 void stripltlen(char *, int *);
438 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth);
439 void LoadEntityList(char *FileName);
449 Array *array_new(size_t element_size);
450 void array_free(Array *arr);
451 void array_append(Array *arr, void *new_element);
452 void *array_get_element_at(Array *arr, int index);
453 int array_len(Array *arr);
454 void array_sort(Array *arr, int (*compar)(const void *, const void *));
455 void array_delete_element_at(Array *arr, int index);
460 #define CTDL_VCARD_MAGIC 0xa1f9
462 /* This data structure represents a vCard object currently in memory. */
473 struct vCard *vcard_new(void);
474 void vcard_add_prop(struct vCard *v, const char *propname, const char *propvalue);
475 struct vCard *vcard_load(char *vtext);
476 struct vCard *VCardLoad(StrBuf *vbtext);
478 void vcard_free(struct vCard *);
479 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
480 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
481 int instance, int return_propname);
482 char *vcard_serialize(struct vCard *);
483 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
484 void remove_charset_attribute(char *strbuf);
485 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
488 * Hash list implementation for Citadel
490 #define HKEY(a) a, (sizeof(a) - 1)
492 typedef struct HashList HashList;
494 typedef struct HashKey HashKey;
496 typedef struct HashPos HashPos;
498 typedef void (*DeleteHashDataFunc)(void * Data);
499 typedef const char *(*PrintHashContent)(void * Data);
500 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
501 typedef long (*HashFunc)(const char *Str, long Len);
502 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
503 typedef const char* (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
505 long FourHash(const char *key, long length);
506 long Flathash(const char *str, long len);
507 long lFlathash(const char *str, long len);
508 #define IKEY(a) (const char*) &a, sizeof(a)
509 #define LKEY(a) (const char*) &a, sizeof(a)
511 int TestValidateHash(HashList *TestHash);
513 HashList *NewHash(int Uniq, HashFunc F);
514 void DeleteHash(HashList **Hash);
515 void DeleteHashContent(HashList **Hash);
516 void HDeleteHash(void *vHash);
517 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
518 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
519 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
520 int GetHashKeys(HashList *Hash, char ***List);
521 const char *dbg_PrintStrBufPayload(const char *Key, void *Item, int Odd);
522 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
523 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
524 HashPos *GetNewHashPos(const HashList *Hash, int StepWidth);
525 void RewindHashPos(const HashList *Hash, HashPos *it, int StepWidth);
526 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
527 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
528 int GetHashPosCounter(HashList *Hash, HashPos *At);
529 void DeleteHashPos(HashPos **DelMe);
530 int NextHashPos(HashList *Hash, HashPos *At);
531 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
532 int GetNextHashPos(const HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
533 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
534 void SortByHashKey(HashList *Hash, int Order);
535 void SortByHashKeyStr(HashList *Hash);
536 int GetCount(HashList *Hash);
537 const void *GetSearchPayload(const void *HashVoid);
538 void SortByPayload(HashList *Hash, CompareFunc SortBy);
539 void reference_free_handler(void *ptr);
540 int HashLittle(const void *key, size_t length);
542 typedef struct MSet MSet;
543 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
544 int IsInMSetList(MSet *MSetList, long MsgNo);
545 void DeleteMSet(MSet **FreeMe);
547 void convert_spaces_to_underscores(char *str);
548 int CheckEncode(const char *pch, long len, const char *pche);
551 * Convert 4 bytes char into an Integer.
552 * usefull for easy inexpensive hashing
553 * of for char strings.
555 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
557 /* vNote implementation */
559 #define CTDL_VNOTE_MAGIC 0xa1fa
577 struct vnote *vnote_new(void);
578 struct vnote *vnote_new_from_str(char *s);
579 void vnote_free(struct vnote *v);
580 char *vnote_serialize(struct vnote *v);
581 void vnote_serialize_output_field(char *append_to, char *field, char *label);
587 * Create JSON style structures in C plus serialize them to one string
590 typedef struct JsonValue JsonValue;
593 void DeleteJSONValue(void *vJsonValue);
595 JsonValue *NewJsonObject(const char *Key, long keylen);
597 JsonValue *NewJsonArray(const char *Key, long keylen);
599 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
601 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
604 NEWJSONSTRING_COPYBUF, // make a copy of the StrBuf, source is left alone
605 NEWJSONSTRING_SMASHBUF // smash the source StrBuf, the json object now owns that memory
607 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe, int copy_or_smash);
609 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
611 JsonValue *NewJsonNull(const char *Key, long keylen);
613 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
615 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
617 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
619 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
622 /* the following declarations are leftover from the defunct wildfire implementation. can we remove them? */
623 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
625 typedef enum _WF_MessageType {
634 JsonValue *WildFireException(const char *Filename, long FileLen,
639 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
641 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
643 const char *Message, long len,
644 WF_MessageType Type);
646 JsonValue *WildFireMessage(const char *Filename, long fnlen,
649 WF_MessageType Type);
651 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
653 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
656 #define WF_STRUCTINDEX "1"
659 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
661 /* Convenience function to "perform a function and cut a log record if result != 0" */
662 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
664 /* a nice consistent place to define how we turn a message id into a thread id hash */
665 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
666 #define ThreadIdHashOffset(Buf, Offset) abs(HashLittle(ChrPtr(Buf) + Offset, StrLength(Buf)-Offset))
672 #define CFG_SMTP_FROM_FILTERALL 0
673 #define CFG_SMTP_FROM_NOFILTER 1
674 #define CFG_SMTP_FROM_CORRECT 2
675 #define CFG_SMTP_FROM_REJECT 3
678 * object types used in Citadel for configuration stuff (some of these are obsolete)
680 #define SPOOLMIME "application/x-citadel-delivery-list"
681 #define INTERNETCFG "application/x-citadel-internet-config"
682 #define IGNETCFG "application/x-citadel-ignet-config"
683 #define IGNETMAP "application/x-citadel-ignet-map"
684 #define FILTERLIST "application/x-citadel-filter-list"
685 #define SIEVECONFIG "application/x-citadel-sieve-config"
686 #define XMPPMORTUARY "application/x-citadel-xmpp-mortuary"
687 #define GLOBAL_ALIASES "global_alias_table"
689 #define FILE_MAILALIAS "__MAIL_ALIAS__"
691 #define LISTING_FOLLOWS 100
693 #define MORE_DATA 300
694 #define SEND_LISTING 400
696 #define BINARY_FOLLOWS 600
697 #define SEND_BINARY 700
698 #define START_CHAT_MODE 800
700 #define INTERNAL_ERROR 10
702 #define ILLEGAL_VALUE 12
703 #define NOT_LOGGED_IN 20
704 #define CMD_NOT_SUPPORTED 30
705 #define SERVER_SHUTTING_DOWN 31
706 #define PASSWORD_REQUIRED 40
707 #define ALREADY_LOGGED_IN 41
708 #define USERNAME_REQUIRED 42
709 #define HIGHER_ACCESS_REQUIRED 50
710 #define MAX_SESSIONS_EXCEEDED 51
711 #define RESOURCE_BUSY 52
712 #define RESOURCE_NOT_OPEN 53
714 #define INVALID_FLOOR_OPERATION 61
715 #define NO_SUCH_USER 70
716 #define FILE_NOT_FOUND 71
717 #define ROOM_NOT_FOUND 72
718 #define NO_SUCH_SYSTEM 73
719 #define ALREADY_EXISTS 74
720 #define MESSAGE_NOT_FOUND 75
722 #define ASYNC_MSG 900
723 #define ASYNC_GEXP 02
725 #define QR_PERMANENT 1 /* Room does not purge */
726 #define QR_INUSE 2 /* Set if in use, clear if avail */
727 #define QR_PRIVATE 4 /* Set for any type of private room */
728 #define QR_PASSWORDED 8 /* Set if there's a password too */
729 #define QR_GUESSNAME 16 /* Set if it's a guessname room */
730 #define QR_DIRECTORY 32 /* Directory room */
731 #define QR_UPLOAD 64 /* Allowed to upload */
732 #define QR_DOWNLOAD 128 /* Allowed to download */
733 #define QR_VISDIR 256 /* Visible directory */
734 #define QR_ANONONLY 512 /* Anonymous-Only room */
735 #define QR_ANONOPT 1024 /* Anonymous-Option room */
736 #define QR_NETWORK 2048 /* Shared network room */
737 #define QR_PREFONLY 4096 /* Preferred status needed to enter */
738 #define QR_READONLY 8192 /* Admin status required to post */
739 #define QR_MAILBOX 16384 /* Set if this is a private mailbox */
741 #define QR2_SYSTEM 1 /* System room; hide by default */
742 #define QR2_SELFLIST 2 /* Self-service mailing list mgmt */
743 #define QR2_COLLABDEL 4 /* Anyone who can post can delete */
744 #define QR2_SUBJECTREQ 8 /* Subject strongly recommended */
745 #define QR2_SMTP_PUBLIC 16 /* Listservice Subscribers may post */
746 #define QR2_MODERATED 32 /* Listservice aide has to permit posts */
747 #define QR2_NOUPLMSG 64 /* If a file is uploaded, no message will be posted. */
749 #define US_NEEDVALID 1 /* User needs to be validated */
750 #define US_EXTEDIT 2 /* Always use external editor */
751 #define US_PERM 4 /* Permanent user */
752 #define US_LASTOLD 16 /* Print last old message with new */
753 #define US_EXPERT 32 /* Experienced user */
754 #define US_UNLISTED 64 /* Unlisted userlog entry */
755 #define US_NOPROMPT 128 /* Don't prompt after each message */
756 #define US_PROMPTCTL 256 /* <N>ext & <S>top work at prompt */
757 #define US_DISAPPEAR 512 /* Use "disappearing msg prompts" */
758 #define US_REGIS 1024 /* Registered user */
759 #define US_PAGINATOR 2048 /* Pause after each screen of text */
760 #define US_INTERNET 4096 /* Internet mail privileges */
761 #define US_FLOORS 8192 /* User wants to see floors */
762 #define US_COLOR 16384 /* User wants ANSI color support */
763 #define US_USER_SET (US_LASTOLD | US_EXPERT | US_UNLISTED | \
764 US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
765 US_FLOORS | US_COLOR | US_PROMPTCTL | US_EXTEDIT)
767 #define UA_KNOWN 2 /* Room appears in a 'known rooms' list */
768 #define UA_GOTOALLOWED 4 /* User may goto this room if specified by exact name */
769 #define UA_HASNEWMSGS 8 /* Unread messages exist in this room */
770 #define UA_ZAPPED 16 /* User has forgotten (zapped) this room */
771 #define UA_POSTALLOWED 32 /* User may post top-level messages here */
772 #define UA_ADMINALLOWED 64 /* Admin or Room Admin rights exist here */
773 #define UA_DELETEALLOWED 128 /* User is allowed to delete messages from this room */
774 #define UA_REPLYALLOWED 256 /* User is allowed to reply to existing messages here */
775 /* runtime flag extracted from goto reply; not db persistant, should be moved if new flags added */
776 #define UA_ISTRASH 512 /* Only available in room view... */
782 #endif // LIBCITADEL_H