2 * Header file for libcitadel
4 * Copyright (c) 1987-2012 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 /* protect against double includes */
22 * since we reference time_t...
27 #include <arpa/inet.h>
28 #include <sys/types.h>
29 #include <netinet/in.h>
31 #define LIBCITADEL_VERSION_NUMBER 813
34 * Here's a bunch of stupid magic to make the MIME parser portable.
41 typedef enum AXLevel {
54 lastsent, /* 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 */
107 #define BLOG_EUIDBUF_SIZE 40
110 #define IsEmptyStr(a) ((a)[0] == '\0')
115 * another word to indicate n/a for a pointer if NULL already has a "meaning"
117 extern const char *StrBufNOTNULL;
123 char *libcitadel_version_string(void);
124 int libcitadel_version_number(void);
125 void StartLibCitadel(size_t basesize);
126 void ShutDownLibCitadel(void);
129 * MIME parser declarations
132 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
135 typedef void (*MimeParserCallBackType)(char *cbname,
147 void mime_parser(char *content_start, char *content_end,
148 MimeParserCallBackType CallBack,
149 MimeParserCallBackType PreMultiPartCallBack,
150 MimeParserCallBackType PostMultiPartCallBack,
156 char *fixed_partnum(char *);
157 void mime_decode(char *partnum,
158 char *part_start, size_t length,
159 char *content_type, char *charset, char *encoding,
162 char *name, char *filename,
163 MimeParserCallBackType CallBack,
164 MimeParserCallBackType PreMultiPartCallBack,
165 MimeParserCallBackType PostMultiPartCallBack,
168 int mime_decode_now (char *part_start,
172 size_t *bytes_decoded);
173 void the_mime_parser(char *partnum,
174 char *content_start, char *content_end,
175 MimeParserCallBackType CallBack,
176 MimeParserCallBackType PreMultiPartCallBack,
177 MimeParserCallBackType PostMultiPartCallBack,
181 typedef struct StrBuf StrBuf;
184 #define CStrOf(a) #a, sizeof(#a) - 1
185 typedef struct _ConstStr {
189 #define CKEY(a) (a).Key, (a).len
191 StrBuf* NewStrBuf(void);
192 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
193 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
194 long StrBufShrinkToFit(StrBuf *Buf, int Force);
195 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
196 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
198 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
199 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
200 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
201 void FreeStrBuf (StrBuf **FreeMe);
202 char *SmashStrBuf (StrBuf **SmashMe);
203 void HFreeStrBuf (void *VFreeMe);
204 int FlushStrBuf(StrBuf *buf);
205 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
207 const char *ChrPtr(const StrBuf *Str);
208 int StrLength(const StrBuf *Str);
209 #define SKEY(a) ChrPtr(a), StrLength(a)
210 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
211 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
213 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
214 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
217 int StrBufReadBLOBBuffered(StrBuf *Buf,
225 int StrBufTCP_read_buffered_line(StrBuf *Line,
229 int selectresolution,
231 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
236 int selectresolution,
239 typedef enum _eReadState {
246 typedef struct _file_buffer {
248 const char *ReadWritePointer;
251 int nBlobBytesWanted;
255 typedef struct __fd_iobuffer {
261 loff_t TotalSentAlready;
262 loff_t TotalReadAlready;
264 long ChunkSendRemain;
265 StrBuf *ChunkBuffer; /* just used if we don't have sendfile */
269 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize);
270 void FDIOBufferDelete(FDIOBuffer *FDB);
271 int FileSendChunked(FDIOBuffer *FDB, const char **Err);
272 int FileRecvChunked(FDIOBuffer *FDB, const char **Err);
273 int FileMoveChunked(FDIOBuffer *FDB, const char **Err);
274 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error);
276 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
277 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
279 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
280 eReadState StrBufCheckBuffer(IOBuffer *FB);
281 long IOBufferStrLength(IOBuffer *FB);
283 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
284 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
285 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
286 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
287 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
289 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
290 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
291 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
292 int StrBufNum_tokens(const StrBuf *source, char tok);
293 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
295 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
296 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
297 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
298 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
299 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
300 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
303 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
304 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
305 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
306 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
307 #ifdef SHOW_ME_VAPPEND_PRINTF
308 /* so owe don't create an include depndency, this is just visible on demand. */
309 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
311 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
312 void StrBufCutLeft(StrBuf *Buf, int nChars);
313 void StrBufCutRight(StrBuf *Buf, int nChars);
314 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
315 void StrBufTrim(StrBuf *Buf);
316 void StrBufSpaceToBlank(StrBuf *Buf);
317 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
318 void StrBufUpCase(StrBuf *Buf);
319 void StrBufLowerCase(StrBuf *Buf);
320 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
321 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
322 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
324 void StrBufToUnixLF(StrBuf *buf);
325 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
327 int CompressBuffer(StrBuf *Buf);
328 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
329 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
330 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
331 const StrBuf *DecodeMe,
332 const StrBuf* DefaultCharset,
333 StrBuf *FoundCharset,
335 StrBuf *ConvertBuf2);
336 /* deprecated old version: */
337 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
339 int StrBufDecodeBase64(StrBuf *Buf);
340 int StrBufDecodeHex(StrBuf *Buf);
341 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
342 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
344 StrBuf *EmailAddress,
346 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
347 #define LB (1) /* Internal escape chars */
350 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
351 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
352 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
353 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
354 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
355 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
356 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
357 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
358 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
360 long StrTol(const StrBuf *Buf);
361 int StrToi(const StrBuf *Buf);
362 int StrBufIsNumber(const StrBuf *Buf);
363 long StrBuf_Utf8StrLen(StrBuf *Buf);
364 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
366 const char *GuessMimeType(const char *data, size_t dlen);
367 const char* GuessMimeByFilename(const char *what, size_t len);
369 /* Run once at Programstart */
370 int LoadIconDir(const char *DirName);
372 /* Select the icon for a given MIME type */
373 const char *GetIconFilename(char *MimeType, size_t len);
376 /* URL parsing & connection data */
377 typedef struct ParsedURL ParsedURL;
381 StrBuf *UrlWithoutCred;
387 const char *LocalPart;
388 const char *PlainUrl;
392 struct hostent *HEnt;
393 struct sockaddr_in6 Addr;
400 void FreeURL(ParsedURL** Url);
401 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
402 void CurlPrepareURL(ParsedURL *Url);
407 int safestrncpy(char *dest, const char *src, size_t n);
408 int num_tokens (const char *source, char tok);
409 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
410 long grab_token(char **dest, const char *source, int parmnum, char separator);
411 int extract_int (const char *source, int parmnum);
412 long extract_long (const char *source, int parmnum);
413 unsigned long extract_unsigned_long(const char *source, int parmnum);
414 void CtdlInitBase64Table(void);
415 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
416 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
417 unsigned int decode_hex(char *Source);
418 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
419 void StripSlashes(char *Dir, int TrailingSlash);
420 size_t striplt(char *);
421 int haschar(const char *st, int ch);
422 void remove_token(char *source, int parmnum, char separator);
423 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
424 int is_msg_in_sequence_set(const char *mset, long msgnum);
425 char *memreadline(char *start, char *buf, int maxlen);
426 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
427 const char *cmemreadline(const char *start, char *buf, int maxlen);
428 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
429 #define IsEmptyStr(a) ((a)[0] == '\0')
430 #define num_parms(source) num_tokens(source,(char)'|')
431 int stripout(char *str, char leftboundary, char rightboundary);
432 long stripallbut(char *str, char leftboundary, char rightboundary);
433 char *myfgets(char *s, int size, FILE *stream);
434 void urlesc(char *outbuf, size_t oblen, char *strbuf);
435 char *CtdlTempFileName(char *prefix1, int prefix2);
436 FILE *CtdlTempFile(void);
437 void generate_uuid(char *buf);
438 char *bmstrcasestr(char *text, const char *pattern);
439 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
440 const char *cbmstrcasestr(const char *text, const char *pattern);
441 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
442 void CtdlMakeTempFileName(char *name, int len);
443 char *rfc2047encode(char *line, long length);
444 int is_msg_in_mset(const char *mset, long msgnum);
445 int pattern2(char *search, char *patn);
446 void stripltlen(char *, int *);
447 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
448 void LoadEntityList(char *FileName);
454 #define CTDL_VCARD_MAGIC 0xa1f9
456 /* This data structure represents a vCard object currently in memory. */
467 struct vCard *vcard_new(void);
468 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
469 struct vCard *vcard_load(char *vtext);
470 struct vCard *VCardLoad(StrBuf *vbtext);
472 void vcard_free(struct vCard *);
473 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
474 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
475 int instance, int return_propname);
476 char *vcard_serialize(struct vCard *);
477 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
478 void remove_charset_attribute(char *strbuf);
479 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
482 * Hash list implementation for Citadel
484 #define HKEY(a) a, (sizeof(a) - 1)
486 typedef struct HashList HashList;
488 typedef struct HashKey HashKey;
490 typedef struct HashPos HashPos;
492 typedef void (*DeleteHashDataFunc)(void * Data);
493 typedef const char *(*PrintHashContent)(void * Data);
494 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
495 typedef long (*HashFunc)(const char *Str, long Len);
496 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
497 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
499 long Flathash(const char *str, long len);
500 long lFlathash(const char *str, long len);
501 #define IKEY(a) (const char*) &a, sizeof(a)
502 #define LKEY(a) (const char*) &a, sizeof(a)
504 int TestValidateHash(HashList *TestHash);
506 HashList *NewHash(int Uniq, HashFunc F);
507 void DeleteHash(HashList **Hash);
508 void DeleteHashContent(HashList **Hash);
509 void HDeleteHash(void *vHash);
510 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
511 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
512 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
513 int GetHashKeys(HashList *Hash, char ***List);
514 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
515 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
516 HashPos *GetNewHashPos(const HashList *Hash, 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);
594 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
596 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
598 JsonValue *NewJsonNull(const char *Key, long keylen);
600 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
602 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
604 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
606 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
611 * Citadels Wildfire implementation, see
612 * http://www.firephp.org/Wiki/Reference/Protocol
613 * and http://wildfirehq.org/ for details
615 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
617 typedef enum _WF_MessageType {
626 JsonValue *WildFireException(const char *Filename, long FileLen,
631 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
633 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
635 const char *Message, long len,
636 WF_MessageType Type);
638 JsonValue *WildFireMessage(const char *Filename, long fnlen,
641 WF_MessageType Type);
643 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
645 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
648 #define WF_STRUCTINDEX "1"
651 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
653 /* Convenience function to "perform a function and cut a log record if result != 0" */
654 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
656 /* a nice consistent place to define how we turn a message id into a thread id hash */
657 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
663 #define CFG_SMTP_FROM_FILTERALL 0
664 #define CFG_SMTP_FROM_NOFILTER 1
665 #define CFG_SMTP_FROM_CORRECT 2
666 #define CFG_SMTP_FROM_REJECT 3
668 * MIME types used in Citadel for configuration stuff
670 #define SPOOLMIME "application/x-citadel-delivery-list"
671 #define INTERNETCFG "application/x-citadel-internet-config"
672 #define IGNETCFG "application/x-citadel-ignet-config"
673 #define IGNETMAP "application/x-citadel-ignet-map"
674 #define FILTERLIST "application/x-citadel-filter-list"
675 #define SIEVECONFIG "application/x-citadel-sieve-config"
676 #define XMPPMORTUARY "application/x-citadel-xmpp-mortuary"
677 #define INTERNETCFG "application/x-citadel-internet-config"
679 #define FILE_MAILALIAS "__MAIL_ALIAS__"
681 #define LISTING_FOLLOWS 100
683 #define MORE_DATA 300
684 #define SEND_LISTING 400
686 #define BINARY_FOLLOWS 600
687 #define SEND_BINARY 700
688 #define START_CHAT_MODE 800
690 #define INTERNAL_ERROR 10
692 #define ILLEGAL_VALUE 12
693 #define NOT_LOGGED_IN 20
694 #define CMD_NOT_SUPPORTED 30
695 #define SERVER_SHUTTING_DOWN 31
696 #define PASSWORD_REQUIRED 40
697 #define ALREADY_LOGGED_IN 41
698 #define USERNAME_REQUIRED 42
699 #define HIGHER_ACCESS_REQUIRED 50
700 #define MAX_SESSIONS_EXCEEDED 51
701 #define RESOURCE_BUSY 52
702 #define RESOURCE_NOT_OPEN 53
704 #define INVALID_FLOOR_OPERATION 61
705 #define NO_SUCH_USER 70
706 #define FILE_NOT_FOUND 71
707 #define ROOM_NOT_FOUND 72
708 #define NO_SUCH_SYSTEM 73
709 #define ALREADY_EXISTS 74
710 #define MESSAGE_NOT_FOUND 75
712 #define ASYNC_MSG 900
713 #define ASYNC_GEXP 02
715 #define QR_PERMANENT 1 /* Room does not purge */
716 #define QR_INUSE 2 /* Set if in use, clear if avail */
717 #define QR_PRIVATE 4 /* Set for any type of private room */
718 #define QR_PASSWORDED 8 /* Set if there's a password too */
719 #define QR_GUESSNAME 16 /* Set if it's a guessname room */
720 #define QR_DIRECTORY 32 /* Directory room */
721 #define QR_UPLOAD 64 /* Allowed to upload */
722 #define QR_DOWNLOAD 128 /* Allowed to download */
723 #define QR_VISDIR 256 /* Visible directory */
724 #define QR_ANONONLY 512 /* Anonymous-Only room */
725 #define QR_ANONOPT 1024 /* Anonymous-Option room */
726 #define QR_NETWORK 2048 /* Shared network room */
727 #define QR_PREFONLY 4096 /* Preferred status needed to enter */
728 #define QR_READONLY 8192 /* Admin status required to post */
729 #define QR_MAILBOX 16384 /* Set if this is a private mailbox */
731 #define QR2_SYSTEM 1 /* System room; hide by default */
732 #define QR2_SELFLIST 2 /* Self-service mailing list mgmt */
733 #define QR2_COLLABDEL 4 /* Anyone who can post can delete */
734 #define QR2_SUBJECTREQ 8 /* Subject strongly recommended */
735 #define QR2_SMTP_PUBLIC 16 /* Listservice Subscribers may post */
736 #define QR2_MODERATED 32 /* Listservice aide has to permit posts */
738 #define US_NEEDVALID 1 /* User needs to be validated */
739 #define US_EXTEDIT 2 /* Always use external editor */
740 #define US_PERM 4 /* Permanent user */
741 #define US_LASTOLD 16 /* Print last old message with new */
742 #define US_EXPERT 32 /* Experienced user */
743 #define US_UNLISTED 64 /* Unlisted userlog entry */
744 #define US_NOPROMPT 128 /* Don't prompt after each message */
745 #define US_PROMPTCTL 256 /* <N>ext & <S>top work at prompt */
746 #define US_DISAPPEAR 512 /* Use "disappearing msg prompts" */
747 #define US_REGIS 1024 /* Registered user */
748 #define US_PAGINATOR 2048 /* Pause after each screen of text */
749 #define US_INTERNET 4096 /* Internet mail privileges */
750 #define US_FLOORS 8192 /* User wants to see floors */
751 #define US_COLOR 16384 /* User wants ANSI color support */
752 #define US_USER_SET (US_LASTOLD | US_EXPERT | US_UNLISTED | \
753 US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
754 US_FLOORS | US_COLOR | US_PROMPTCTL | US_EXTEDIT)
756 #define UA_KNOWN 2 /* Room appears in a 'known rooms' list */
757 #define UA_GOTOALLOWED 4 /* User may goto this room if specified by exact name */
758 #define UA_HASNEWMSGS 8 /* Unread messages exist in this room */
759 #define UA_ZAPPED 16 /* User has forgotten (zapped) this room */
760 #define UA_POSTALLOWED 32 /* User may post top-level messages here */
761 #define UA_ADMINALLOWED 64 /* Admin or Room Admin rights exist here */
762 #define UA_DELETEALLOWED 128 /* User is allowed to delete messages from this room */
763 #define UA_REPLYALLOWED 256 /* User is allowed to reply to existing messages here */
764 /* runtime flag extracted from goto reply; not db persistant, should be moved if new flags added */
765 #define UA_ISTRASH 512 /* Only available in room view... */
771 #endif // LIBCITADEL_H