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 956
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 */
104 #define BLOG_EUIDBUF_SIZE 40
107 #define IsEmptyStr(a) ( ( (a) == NULL ) || ((a)[0] == '\0') )
112 * another word to indicate n/a for a pointer if NULL already has a "meaning"
114 extern const char *StrBufNOTNULL;
120 char *libcitadel_version_string(void);
121 int libcitadel_version_number(void);
122 void ShutDownLibCitadel(void);
125 * MIME parser declarations
128 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
131 typedef void (*MimeParserCallBackType)(char *cbname,
143 void mime_parser(char *content_start, char *content_end,
144 MimeParserCallBackType CallBack,
145 MimeParserCallBackType PreMultiPartCallBack,
146 MimeParserCallBackType PostMultiPartCallBack,
150 char *fixed_partnum(char *);
152 void mime_decode(char *partnum,
153 char *part_start, size_t length,
154 char *content_type, char *charset, char *encoding,
157 char *name, char *filename,
158 MimeParserCallBackType CallBack,
159 MimeParserCallBackType PreMultiPartCallBack,
160 MimeParserCallBackType PostMultiPartCallBack,
164 int mime_decode_now (char *part_start,
168 size_t *bytes_decoded);
170 void the_mime_parser(char *partnum,
171 char *content_start, char *content_end,
172 MimeParserCallBackType CallBack,
173 MimeParserCallBackType PreMultiPartCallBack,
174 MimeParserCallBackType PostMultiPartCallBack,
178 typedef struct StrBuf StrBuf;
181 #define CStrOf(a) #a, sizeof(#a) - 1
182 typedef struct _ConstStr {
186 #define CKEY(a) (a).Key, (a).len
188 StrBuf* NewStrBuf(void);
189 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
190 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
191 void SwapBuffers(StrBuf *A, StrBuf *B);
192 long StrBufShrinkToFit(StrBuf *Buf, int Force);
193 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
194 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
195 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
196 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
197 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
198 void FreeStrBuf (StrBuf **FreeMe);
199 char *SmashStrBuf (StrBuf **SmashMe);
200 void HFreeStrBuf (void *VFreeMe);
201 int FlushStrBuf(StrBuf *buf);
202 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
203 const char *ChrPtr(const StrBuf *Str);
204 int StrLength(const StrBuf *Str);
205 #define SKEY(a) ChrPtr(a), StrLength(a)
206 void StrBufAsciify(StrBuf *Buf, const char repl);
207 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
208 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
209 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
210 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
213 int StrBufReadBLOBBuffered(StrBuf *Buf,
221 int StrBufTCP_read_buffered_line(StrBuf *Line,
225 int selectresolution,
227 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
232 int selectresolution,
235 typedef enum _eReadState {
242 typedef struct _file_buffer {
244 const char *ReadWritePointer;
247 int nBlobBytesWanted;
250 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
251 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
253 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
254 eReadState StrBufCheckBuffer(IOBuffer *FB);
255 long IOBufferStrLength(IOBuffer *FB);
257 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
258 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
259 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
260 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
261 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
263 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
264 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
265 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
266 int StrBufNum_tokens(const StrBuf *source, char tok);
267 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
269 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
270 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
271 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
272 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
273 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
274 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
277 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
278 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
279 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
280 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
281 #ifdef SHOW_ME_VAPPEND_PRINTF
282 /* so owe don't create an include depndency, this is just visible on demand. */
283 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
285 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
286 void StrBufCutLeft(StrBuf *Buf, int nChars);
287 void StrBufCutRight(StrBuf *Buf, int nChars);
288 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
289 void StrBufTrim(StrBuf *Buf);
290 void StrBufSpaceToBlank(StrBuf *Buf);
291 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
292 void StrBufUpCase(StrBuf *Buf);
293 void StrBufLowerCase(StrBuf *Buf);
294 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
295 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
296 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
298 void StrBufToUnixLF(StrBuf *buf);
299 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
301 int CompressBuffer(StrBuf *Buf);
302 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
303 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
304 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
305 const StrBuf *DecodeMe,
306 const StrBuf* DefaultCharset,
307 StrBuf *FoundCharset,
309 StrBuf *ConvertBuf2);
310 /* deprecated old version: */
311 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
313 typedef enum __eStreamType {
321 typedef struct vStreamT vStreamT;
322 vStreamT *StrBufNewStreamContext(eStreamType type, const char **Err);
323 int StrBufDestroyStreamContext(eStreamType type, vStreamT **Stream, const char **Err);
324 int StrBufStreamTranscode(eStreamType type, IOBuffer *Target, IOBuffer *In, const char* pIn, long pInLen, vStreamT *Stream, int LastChunk, const char **Err);
326 int StrBufDecodeBase64(StrBuf *Buf);
327 void StrBufDecodeQP(StrBuf *Buf);
328 int StrBufDecodeBase64To(const StrBuf *BufIn, StrBuf *BufOut);
329 int StrBufDecodeHex(StrBuf *Buf);
330 StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe);
331 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
332 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
334 StrBuf *EmailAddress,
336 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
337 #define LB (1) /* Internal escape chars */
340 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
341 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
342 void StrBufXMLEscAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int OverrideLowChars);
343 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
344 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
345 void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks);
346 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
347 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
348 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
349 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
350 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
352 long StrTol(const StrBuf *Buf);
353 int StrToi(const StrBuf *Buf);
354 int StrBufIsNumber(const StrBuf *Buf);
355 long StrBuf_Utf8StrLen(StrBuf *Buf);
356 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
358 const char *GuessMimeType(const char *data, size_t dlen);
359 const char* GuessMimeByFilename(const char *what, size_t len);
361 /* Run once at Programstart */
362 int LoadIconDir(const char *DirName);
364 /* Select the icon for a given MIME type */
365 const char *GetIconFilename(char *MimeType, size_t len);
368 /* URL parsing & connection data */
369 typedef struct ParsedURL ParsedURL;
373 StrBuf *UrlWithoutCred;
379 const char *LocalPart;
380 const char *PlainUrl;
384 struct hostent *HEnt;
385 struct sockaddr_in6 Addr;
392 void FreeURL(ParsedURL** Url);
393 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
394 void CurlPrepareURL(ParsedURL *Url);
399 int safestrncpy(char *dest, const char *src, size_t n);
400 int num_tokens (const char *source, char tok);
401 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
402 long grab_token(char **dest, const char *source, int parmnum, char separator);
403 int extract_int (const char *source, int parmnum);
404 long extract_long (const char *source, int parmnum);
405 unsigned long extract_unsigned_long(const char *source, int parmnum);
406 void CtdlInitBase64Table(void);
407 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
409 BASE64_NO_LINEBREAKS = 0,
410 BASE64_YES_LINEBREAKS = 1
412 size_t CtdlDecodeBase64(char *dest, const char *source, size_t length);
413 unsigned int decode_hex(char *Source);
414 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
415 void StripSlashes(char *Dir, int TrailingSlash);
416 size_t striplt(char *);
417 int haschar(const char *st, int ch);
418 void remove_token(char *source, int parmnum, char separator);
419 int is_msg_in_sequence_set(const char *mset, long msgnum);
420 char *memreadline(char *start, char *buf, int maxlen);
421 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
422 const char *cmemreadline(const char *start, char *buf, int maxlen);
423 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
424 #define num_parms(source) num_tokens(source,(char)'|')
425 int stripout(char *str, char leftboundary, char rightboundary);
426 long stripallbut(char *str, char leftboundary, char rightboundary);
427 char *myfgets(char *s, int size, FILE *stream);
428 void urlesc(char *outbuf, size_t oblen, char *strbuf);
429 char *CtdlTempFileName(char *prefix1, int prefix2);
430 FILE *CtdlTempFile(void);
431 void generate_uuid(char *buf);
432 char *bmstrcasestr(char *text, const char *pattern);
433 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
434 const char *cbmstrcasestr(const char *text, const char *pattern);
435 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
436 void CtdlMakeTempFileName(char *name, int len);
437 char *rfc2047encode(const char *line, long length);
438 int is_msg_in_mset(const char *mset, long msgnum);
439 int pattern2(char *search, char *patn);
440 void stripltlen(char *, int *);
441 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth);
442 void LoadEntityList(char *FileName);
452 Array *array_new(size_t element_size);
453 void array_free(Array *arr);
454 void array_append(Array *arr, void *new_element);
455 void *array_get_element_at(Array *arr, int index);
456 int array_len(Array *arr);
457 void array_sort(Array *arr, int (*compar)(const void *, const void *));
458 void array_delete_element_at(Array *arr, int index);
463 #define CTDL_VCARD_MAGIC 0xa1f9
465 /* This data structure represents a vCard object currently in memory. */
476 struct vCard *vcard_new(void);
477 void vcard_add_prop(struct vCard *v, const char *propname, const char *propvalue);
478 struct vCard *vcard_load(char *vtext);
479 struct vCard *VCardLoad(StrBuf *vbtext);
481 void vcard_free(struct vCard *);
482 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
483 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
484 int instance, int return_propname);
485 char *vcard_serialize(struct vCard *);
486 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
487 void remove_charset_attribute(char *strbuf);
488 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
491 * Hash list implementation for Citadel
493 #define HKEY(a) a, (sizeof(a) - 1)
495 typedef struct HashList HashList;
497 typedef struct HashKey HashKey;
499 typedef struct HashPos HashPos;
501 typedef void (*DeleteHashDataFunc)(void * Data);
502 typedef const char *(*PrintHashContent)(void * Data);
503 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
504 typedef long (*HashFunc)(const char *Str, long Len);
505 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
506 typedef const char* (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
508 long FourHash(const char *key, long length);
509 long Flathash(const char *str, long len);
510 long lFlathash(const char *str, long len);
511 #define IKEY(a) (const char*) &a, sizeof(a)
512 #define LKEY(a) (const char*) &a, sizeof(a)
514 int TestValidateHash(HashList *TestHash);
516 HashList *NewHash(int Uniq, HashFunc F);
517 void DeleteHash(HashList **Hash);
518 void DeleteHashContent(HashList **Hash);
519 void HDeleteHash(void *vHash);
520 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
521 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
522 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
523 int GetHashKeys(HashList *Hash, char ***List);
524 const char *dbg_PrintStrBufPayload(const char *Key, void *Item, int Odd);
525 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
526 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
527 HashPos *GetNewHashPos(const HashList *Hash, int StepWidth);
528 void RewindHashPos(const HashList *Hash, HashPos *it, int StepWidth);
529 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
530 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
531 int GetHashPosCounter(HashList *Hash, HashPos *At);
532 void DeleteHashPos(HashPos **DelMe);
533 int NextHashPos(HashList *Hash, HashPos *At);
534 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
535 int GetNextHashPos(const HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
536 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
537 void SortByHashKey(HashList *Hash, int Order);
538 void SortByHashKeyStr(HashList *Hash);
539 int GetCount(HashList *Hash);
540 const void *GetSearchPayload(const void *HashVoid);
541 void SortByPayload(HashList *Hash, CompareFunc SortBy);
542 void reference_free_handler(void *ptr);
543 int HashLittle(const void *key, size_t length);
545 typedef struct MSet MSet;
546 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
547 int IsInMSetList(MSet *MSetList, long MsgNo);
548 void DeleteMSet(MSet **FreeMe);
550 void convert_spaces_to_underscores(char *str);
551 int CheckEncode(const char *pch, long len, const char *pche);
554 * Convert 4 bytes char into an Integer.
555 * usefull for easy inexpensive hashing
556 * of for char strings.
558 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
560 /* vNote implementation */
562 #define CTDL_VNOTE_MAGIC 0xa1fa
580 struct vnote *vnote_new(void);
581 struct vnote *vnote_new_from_str(char *s);
582 void vnote_free(struct vnote *v);
583 char *vnote_serialize(struct vnote *v);
584 void vnote_serialize_output_field(char *append_to, char *field, char *label);
590 * Create JSON style structures in C plus serialize them to one string
593 typedef struct JsonValue JsonValue;
596 void DeleteJSONValue(void *vJsonValue);
598 JsonValue *NewJsonObject(const char *Key, long keylen);
600 JsonValue *NewJsonArray(const char *Key, long keylen);
602 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
604 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
607 NEWJSONSTRING_COPYBUF, // make a copy of the StrBuf, source is left alone
608 NEWJSONSTRING_SMASHBUF // smash the source StrBuf, the json object now owns that memory
610 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe, int copy_or_smash);
612 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
614 JsonValue *NewJsonNull(const char *Key, long keylen);
616 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
618 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
620 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
622 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
625 /* the following declarations are leftover from the defunct wildfire implementation. can we remove them? */
626 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
628 typedef enum _WF_MessageType {
637 JsonValue *WildFireException(const char *Filename, long FileLen,
642 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
644 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
646 const char *Message, long len,
647 WF_MessageType Type);
649 JsonValue *WildFireMessage(const char *Filename, long fnlen,
652 WF_MessageType Type);
654 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
656 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
659 #define WF_STRUCTINDEX "1"
662 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
664 /* Convenience function to "perform a function and cut a log record if result != 0" */
665 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
667 /* a nice consistent place to define how we turn a message id into a thread id hash */
668 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
669 #define ThreadIdHashOffset(Buf, Offset) abs(HashLittle(ChrPtr(Buf) + Offset, StrLength(Buf)-Offset))
675 #define CFG_SMTP_FROM_FILTERALL 0
676 #define CFG_SMTP_FROM_NOFILTER 1
677 #define CFG_SMTP_FROM_CORRECT 2
678 #define CFG_SMTP_FROM_REJECT 3
681 * object types used in Citadel for configuration stuff (some of these are obsolete)
683 #define SPOOLMIME "application/x-citadel-delivery-list"
684 #define INTERNETCFG "application/x-citadel-internet-config"
685 #define IGNETCFG "application/x-citadel-ignet-config"
686 #define IGNETMAP "application/x-citadel-ignet-map"
687 #define FILTERLIST "application/x-citadel-filter-list"
688 #define SIEVECONFIG "application/x-citadel-sieve-config"
689 #define XMPPMORTUARY "application/x-citadel-xmpp-mortuary"
690 #define GLOBAL_ALIASES "global_alias_table"
692 #define FILE_MAILALIAS "__MAIL_ALIAS__"
694 #define LISTING_FOLLOWS 100
696 #define MORE_DATA 300
697 #define SEND_LISTING 400
699 #define BINARY_FOLLOWS 600
700 #define SEND_BINARY 700
701 #define START_CHAT_MODE 800
703 #define INTERNAL_ERROR 10
705 #define ILLEGAL_VALUE 12
706 #define NOT_LOGGED_IN 20
707 #define CMD_NOT_SUPPORTED 30
708 #define SERVER_SHUTTING_DOWN 31
709 #define PASSWORD_REQUIRED 40
710 #define ALREADY_LOGGED_IN 41
711 #define USERNAME_REQUIRED 42
712 #define HIGHER_ACCESS_REQUIRED 50
713 #define MAX_SESSIONS_EXCEEDED 51
714 #define RESOURCE_BUSY 52
715 #define RESOURCE_NOT_OPEN 53
717 #define INVALID_FLOOR_OPERATION 61
718 #define NO_SUCH_USER 70
719 #define FILE_NOT_FOUND 71
720 #define ROOM_NOT_FOUND 72
721 #define NO_SUCH_SYSTEM 73
722 #define ALREADY_EXISTS 74
723 #define MESSAGE_NOT_FOUND 75
725 #define ASYNC_MSG 900
726 #define ASYNC_GEXP 02
728 #define QR_PERMANENT 1 /* Room does not purge */
729 #define QR_INUSE 2 /* Set if in use, clear if avail */
730 #define QR_PRIVATE 4 /* Set for any type of private room */
731 #define QR_PASSWORDED 8 /* Set if there's a password too */
732 #define QR_GUESSNAME 16 /* Set if it's a guessname room */
733 #define QR_DIRECTORY 32 /* Directory room */
734 #define QR_UPLOAD 64 /* Allowed to upload */
735 #define QR_DOWNLOAD 128 /* Allowed to download */
736 #define QR_VISDIR 256 /* Visible directory */
737 #define QR_ANONONLY 512 /* Anonymous-Only room */
738 #define QR_ANONOPT 1024 /* Anonymous-Option room */
739 #define QR_NETWORK 2048 /* Shared network room */
740 #define QR_PREFONLY 4096 /* Preferred status needed to enter */
741 #define QR_READONLY 8192 /* Admin status required to post */
742 #define QR_MAILBOX 16384 /* Set if this is a private mailbox */
744 #define QR2_SYSTEM 1 /* System room; hide by default */
745 #define QR2_SELFLIST 2 /* Self-service mailing list mgmt */
746 #define QR2_COLLABDEL 4 /* Anyone who can post can delete */
747 #define QR2_SUBJECTREQ 8 /* Subject strongly recommended */
748 #define QR2_SMTP_PUBLIC 16 /* Listservice Subscribers may post */
749 #define QR2_MODERATED 32 /* Listservice aide has to permit posts */
750 #define QR2_NOUPLMSG 64 /* If a file is uploaded, no message will be posted. */
752 #define US_NEEDVALID 1 /* User needs to be validated */
753 #define US_EXTEDIT 2 /* Always use external editor */
754 #define US_PERM 4 /* Permanent user */
755 #define US_LASTOLD 16 /* Print last old message with new */
756 #define US_EXPERT 32 /* Experienced user */
757 #define US_UNLISTED 64 /* Unlisted userlog entry */
758 #define US_NOPROMPT 128 /* Don't prompt after each message */
759 #define US_PROMPTCTL 256 /* <N>ext & <S>top work at prompt */
760 #define US_DISAPPEAR 512 /* Use "disappearing msg prompts" */
761 #define US_REGIS 1024 /* Registered user */
762 #define US_PAGINATOR 2048 /* Pause after each screen of text */
763 #define US_INTERNET 4096 /* Internet mail privileges */
764 #define US_FLOORS 8192 /* User wants to see floors */
765 #define US_COLOR 16384 /* User wants ANSI color support */
766 #define US_USER_SET (US_LASTOLD | US_EXPERT | US_UNLISTED | \
767 US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
768 US_FLOORS | US_COLOR | US_PROMPTCTL | US_EXTEDIT)
770 #define UA_KNOWN 2 /* Room appears in a 'known rooms' list */
771 #define UA_GOTOALLOWED 4 /* User may goto this room if specified by exact name */
772 #define UA_HASNEWMSGS 8 /* Unread messages exist in this room */
773 #define UA_ZAPPED 16 /* User has forgotten (zapped) this room */
774 #define UA_POSTALLOWED 32 /* User may post top-level messages here */
775 #define UA_ADMINALLOWED 64 /* Admin or Room Admin rights exist here */
776 #define UA_DELETEALLOWED 128 /* User is allowed to delete messages from this room */
777 #define UA_REPLYALLOWED 256 /* User is allowed to reply to existing messages here */
778 /* runtime flag extracted from goto reply; not db persistant, should be moved if new flags added */
779 #define UA_ISTRASH 512 /* Only available in room view... */
785 #endif // LIBCITADEL_H