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 921
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;
258 typedef struct __fd_iobuffer {
264 loff_t TotalSentAlready;
265 loff_t TotalReadAlready;
267 long ChunkSendRemain;
268 StrBuf *ChunkBuffer; /* just used if we don't have sendfile */
272 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize);
273 void FDIOBufferDelete(FDIOBuffer *FDB);
274 int FileSendChunked(FDIOBuffer *FDB, const char **Err);
275 int FileRecvChunked(FDIOBuffer *FDB, const char **Err);
276 int FileMoveChunked(FDIOBuffer *FDB, const char **Err);
277 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error);
279 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
280 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
282 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
283 eReadState StrBufCheckBuffer(IOBuffer *FB);
284 long IOBufferStrLength(IOBuffer *FB);
286 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
287 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
288 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
289 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
290 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
292 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
293 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
294 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
295 int StrBufNum_tokens(const StrBuf *source, char tok);
296 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
298 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
299 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
300 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
301 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
302 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
303 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
306 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
307 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
308 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
309 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
310 #ifdef SHOW_ME_VAPPEND_PRINTF
311 /* so owe don't create an include depndency, this is just visible on demand. */
312 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
314 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
315 void StrBufCutLeft(StrBuf *Buf, int nChars);
316 void StrBufCutRight(StrBuf *Buf, int nChars);
317 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
318 void StrBufTrim(StrBuf *Buf);
319 void StrBufSpaceToBlank(StrBuf *Buf);
320 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
321 void StrBufUpCase(StrBuf *Buf);
322 void StrBufLowerCase(StrBuf *Buf);
323 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
324 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
325 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
327 void StrBufToUnixLF(StrBuf *buf);
328 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
330 int CompressBuffer(StrBuf *Buf);
331 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
332 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
333 void StrBuf_RFC822_2_Utf8(StrBuf *Target,
334 const StrBuf *DecodeMe,
335 const StrBuf* DefaultCharset,
336 StrBuf *FoundCharset,
338 StrBuf *ConvertBuf2);
339 /* deprecated old version: */
340 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
342 typedef enum __eStreamType {
350 typedef struct vStreamT vStreamT;
351 vStreamT *StrBufNewStreamContext(eStreamType type, const char **Err);
352 int StrBufDestroyStreamContext(eStreamType type, vStreamT **Stream, const char **Err);
353 int StrBufStreamTranscode(eStreamType type, IOBuffer *Target, IOBuffer *In, const char* pIn, long pInLen, vStreamT *Stream, int LastChunk, const char **Err);
355 int StrBufDecodeBase64(StrBuf *Buf);
356 void StrBufDecodeQP(StrBuf *Buf);
357 int StrBufDecodeBase64To(const StrBuf *BufIn, StrBuf *BufOut);
358 int StrBufDecodeHex(StrBuf *Buf);
359 StrBuf *StrBufRFC2047encodeMessage(const StrBuf *EncodeMe);
360 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
361 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
363 StrBuf *EmailAddress,
365 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
366 #define LB (1) /* Internal escape chars */
369 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
370 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
371 void StrBufXMLEscAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int OverrideLowChars);
372 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
373 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
374 void StrBufBase64Append(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn, long PlainInLen, int linebreaks);
375 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
376 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
377 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
378 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
379 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
381 long StrTol(const StrBuf *Buf);
382 int StrToi(const StrBuf *Buf);
383 int StrBufIsNumber(const StrBuf *Buf);
384 long StrBuf_Utf8StrLen(StrBuf *Buf);
385 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
387 const char *GuessMimeType(const char *data, size_t dlen);
388 const char* GuessMimeByFilename(const char *what, size_t len);
390 /* Run once at Programstart */
391 int LoadIconDir(const char *DirName);
393 /* Select the icon for a given MIME type */
394 const char *GetIconFilename(char *MimeType, size_t len);
397 /* URL parsing & connection data */
398 typedef struct ParsedURL ParsedURL;
402 StrBuf *UrlWithoutCred;
408 const char *LocalPart;
409 const char *PlainUrl;
413 struct hostent *HEnt;
414 struct sockaddr_in6 Addr;
421 void FreeURL(ParsedURL** Url);
422 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
423 void CurlPrepareURL(ParsedURL *Url);
428 int safestrncpy(char *dest, const char *src, size_t n);
429 int num_tokens (const char *source, char tok);
430 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
431 long grab_token(char **dest, const char *source, int parmnum, char separator);
432 int extract_int (const char *source, int parmnum);
433 long extract_long (const char *source, int parmnum);
434 unsigned long extract_unsigned_long(const char *source, int parmnum);
435 void CtdlInitBase64Table(void);
436 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
437 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
438 unsigned int decode_hex(char *Source);
439 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
440 void StripSlashes(char *Dir, int TrailingSlash);
441 size_t striplt(char *);
442 int haschar(const char *st, int ch);
443 void remove_token(char *source, int parmnum, char separator);
444 int is_msg_in_sequence_set(const char *mset, long msgnum);
445 char *memreadline(char *start, char *buf, int maxlen);
446 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
447 const char *cmemreadline(const char *start, char *buf, int maxlen);
448 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
449 #define num_parms(source) num_tokens(source,(char)'|')
450 int stripout(char *str, char leftboundary, char rightboundary);
451 long stripallbut(char *str, char leftboundary, char rightboundary);
452 char *myfgets(char *s, int size, FILE *stream);
453 void urlesc(char *outbuf, size_t oblen, char *strbuf);
454 char *CtdlTempFileName(char *prefix1, int prefix2);
455 FILE *CtdlTempFile(void);
456 void generate_uuid(char *buf);
457 char *bmstrcasestr(char *text, const char *pattern);
458 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
459 const char *cbmstrcasestr(const char *text, const char *pattern);
460 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
461 void CtdlMakeTempFileName(char *name, int len);
462 char *rfc2047encode(const char *line, long length);
463 int is_msg_in_mset(const char *mset, long msgnum);
464 int pattern2(char *search, char *patn);
465 void stripltlen(char *, int *);
466 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth);
467 void LoadEntityList(char *FileName);
473 #define CTDL_VCARD_MAGIC 0xa1f9
475 /* This data structure represents a vCard object currently in memory. */
486 struct vCard *vcard_new(void);
487 void vcard_add_prop(struct vCard *v, const char *propname, const char *propvalue);
488 struct vCard *vcard_load(char *vtext);
489 struct vCard *VCardLoad(StrBuf *vbtext);
491 void vcard_free(struct vCard *);
492 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
493 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
494 int instance, int return_propname);
495 char *vcard_serialize(struct vCard *);
496 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
497 void remove_charset_attribute(char *strbuf);
498 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
501 * Hash list implementation for Citadel
503 #define HKEY(a) a, (sizeof(a) - 1)
505 typedef struct HashList HashList;
507 typedef struct HashKey HashKey;
509 typedef struct HashPos HashPos;
511 typedef void (*DeleteHashDataFunc)(void * Data);
512 typedef const char *(*PrintHashContent)(void * Data);
513 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
514 typedef long (*HashFunc)(const char *Str, long Len);
515 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
516 typedef const char* (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
518 long FourHash(const char *key, long length);
519 long Flathash(const char *str, long len);
520 long lFlathash(const char *str, long len);
521 #define IKEY(a) (const char*) &a, sizeof(a)
522 #define LKEY(a) (const char*) &a, sizeof(a)
524 int TestValidateHash(HashList *TestHash);
526 HashList *NewHash(int Uniq, HashFunc F);
527 void DeleteHash(HashList **Hash);
528 void DeleteHashContent(HashList **Hash);
529 void HDeleteHash(void *vHash);
530 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
531 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
532 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
533 int GetHashKeys(HashList *Hash, char ***List);
534 const char *dbg_PrintStrBufPayload(const char *Key, void *Item, int Odd);
535 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
536 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
537 HashPos *GetNewHashPos(const HashList *Hash, int StepWidth);
538 void RewindHashPos(const HashList *Hash, HashPos *it, int StepWidth);
539 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
540 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
541 int GetHashPosCounter(HashList *Hash, HashPos *At);
542 void DeleteHashPos(HashPos **DelMe);
543 int NextHashPos(HashList *Hash, HashPos *At);
544 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
545 int GetNextHashPos(const HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
546 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
547 void SortByHashKey(HashList *Hash, int Order);
548 void SortByHashKeyStr(HashList *Hash);
549 int GetCount(HashList *Hash);
550 const void *GetSearchPayload(const void *HashVoid);
551 void SortByPayload(HashList *Hash, CompareFunc SortBy);
552 void reference_free_handler(void *ptr);
553 int HashLittle(const void *key, size_t length);
555 typedef struct MSet MSet;
556 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
557 int IsInMSetList(MSet *MSetList, long MsgNo);
558 void DeleteMSet(MSet **FreeMe);
560 void convert_spaces_to_underscores(char *str);
561 int CheckEncode(const char *pch, long len, const char *pche);
564 * Convert 4 bytes char into an Integer.
565 * usefull for easy inexpensive hashing
566 * of for char strings.
568 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
570 /* vNote implementation */
572 #define CTDL_VNOTE_MAGIC 0xa1fa
590 struct vnote *vnote_new(void);
591 struct vnote *vnote_new_from_str(char *s);
592 void vnote_free(struct vnote *v);
593 char *vnote_serialize(struct vnote *v);
594 void vnote_serialize_output_field(char *append_to, char *field, char *label);
600 * Create JSON style structures in C plus serialize them to one string
603 typedef struct JsonValue JsonValue;
606 void DeleteJSONValue(void *vJsonValue);
608 JsonValue *NewJsonObject(const char *Key, long keylen);
610 JsonValue *NewJsonArray(const char *Key, long keylen);
612 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
614 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
617 NEWJSONSTRING_COPYBUF, // make a copy of the StrBuf, source is left alone
618 NEWJSONSTRING_SMASHBUF // smash the source StrBuf, the json object now owns that memory
620 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe, int copy_or_smash);
622 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
624 JsonValue *NewJsonNull(const char *Key, long keylen);
626 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
628 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
630 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
632 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
637 * Citadels Wildfire implementation, see
638 * http://www.firephp.org/Wiki/Reference/Protocol
639 * and http://wildfirehq.org/ for details
641 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
643 typedef enum _WF_MessageType {
652 JsonValue *WildFireException(const char *Filename, long FileLen,
657 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
659 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
661 const char *Message, long len,
662 WF_MessageType Type);
664 JsonValue *WildFireMessage(const char *Filename, long fnlen,
667 WF_MessageType Type);
669 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
671 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
674 #define WF_STRUCTINDEX "1"
677 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
679 /* Convenience function to "perform a function and cut a log record if result != 0" */
680 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
682 /* a nice consistent place to define how we turn a message id into a thread id hash */
683 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
684 #define ThreadIdHashOffset(Buf, Offset) abs(HashLittle(ChrPtr(Buf) + Offset, StrLength(Buf)-Offset))
690 #define CFG_SMTP_FROM_FILTERALL 0
691 #define CFG_SMTP_FROM_NOFILTER 1
692 #define CFG_SMTP_FROM_CORRECT 2
693 #define CFG_SMTP_FROM_REJECT 3
695 * MIME types used in Citadel for configuration stuff
697 #define SPOOLMIME "application/x-citadel-delivery-list"
698 #define INTERNETCFG "application/x-citadel-internet-config"
699 #define IGNETCFG "application/x-citadel-ignet-config"
700 #define IGNETMAP "application/x-citadel-ignet-map"
701 #define FILTERLIST "application/x-citadel-filter-list"
702 #define SIEVECONFIG "application/x-citadel-sieve-config"
703 #define XMPPMORTUARY "application/x-citadel-xmpp-mortuary"
705 #define FILE_MAILALIAS "__MAIL_ALIAS__"
707 #define LISTING_FOLLOWS 100
709 #define MORE_DATA 300
710 #define SEND_LISTING 400
712 #define BINARY_FOLLOWS 600
713 #define SEND_BINARY 700
714 #define START_CHAT_MODE 800
716 #define INTERNAL_ERROR 10
718 #define ILLEGAL_VALUE 12
719 #define NOT_LOGGED_IN 20
720 #define CMD_NOT_SUPPORTED 30
721 #define SERVER_SHUTTING_DOWN 31
722 #define PASSWORD_REQUIRED 40
723 #define ALREADY_LOGGED_IN 41
724 #define USERNAME_REQUIRED 42
725 #define HIGHER_ACCESS_REQUIRED 50
726 #define MAX_SESSIONS_EXCEEDED 51
727 #define RESOURCE_BUSY 52
728 #define RESOURCE_NOT_OPEN 53
730 #define INVALID_FLOOR_OPERATION 61
731 #define NO_SUCH_USER 70
732 #define FILE_NOT_FOUND 71
733 #define ROOM_NOT_FOUND 72
734 #define NO_SUCH_SYSTEM 73
735 #define ALREADY_EXISTS 74
736 #define MESSAGE_NOT_FOUND 75
738 #define ASYNC_MSG 900
739 #define ASYNC_GEXP 02
741 #define QR_PERMANENT 1 /* Room does not purge */
742 #define QR_INUSE 2 /* Set if in use, clear if avail */
743 #define QR_PRIVATE 4 /* Set for any type of private room */
744 #define QR_PASSWORDED 8 /* Set if there's a password too */
745 #define QR_GUESSNAME 16 /* Set if it's a guessname room */
746 #define QR_DIRECTORY 32 /* Directory room */
747 #define QR_UPLOAD 64 /* Allowed to upload */
748 #define QR_DOWNLOAD 128 /* Allowed to download */
749 #define QR_VISDIR 256 /* Visible directory */
750 #define QR_ANONONLY 512 /* Anonymous-Only room */
751 #define QR_ANONOPT 1024 /* Anonymous-Option room */
752 #define QR_NETWORK 2048 /* Shared network room */
753 #define QR_PREFONLY 4096 /* Preferred status needed to enter */
754 #define QR_READONLY 8192 /* Admin status required to post */
755 #define QR_MAILBOX 16384 /* Set if this is a private mailbox */
757 #define QR2_SYSTEM 1 /* System room; hide by default */
758 #define QR2_SELFLIST 2 /* Self-service mailing list mgmt */
759 #define QR2_COLLABDEL 4 /* Anyone who can post can delete */
760 #define QR2_SUBJECTREQ 8 /* Subject strongly recommended */
761 #define QR2_SMTP_PUBLIC 16 /* Listservice Subscribers may post */
762 #define QR2_MODERATED 32 /* Listservice aide has to permit posts */
763 #define QR2_NOUPLMSG 64 /* If a file is uploaded, no message will be posted. */
765 #define US_NEEDVALID 1 /* User needs to be validated */
766 #define US_EXTEDIT 2 /* Always use external editor */
767 #define US_PERM 4 /* Permanent user */
768 #define US_LASTOLD 16 /* Print last old message with new */
769 #define US_EXPERT 32 /* Experienced user */
770 #define US_UNLISTED 64 /* Unlisted userlog entry */
771 #define US_NOPROMPT 128 /* Don't prompt after each message */
772 #define US_PROMPTCTL 256 /* <N>ext & <S>top work at prompt */
773 #define US_DISAPPEAR 512 /* Use "disappearing msg prompts" */
774 #define US_REGIS 1024 /* Registered user */
775 #define US_PAGINATOR 2048 /* Pause after each screen of text */
776 #define US_INTERNET 4096 /* Internet mail privileges */
777 #define US_FLOORS 8192 /* User wants to see floors */
778 #define US_COLOR 16384 /* User wants ANSI color support */
779 #define US_USER_SET (US_LASTOLD | US_EXPERT | US_UNLISTED | \
780 US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | \
781 US_FLOORS | US_COLOR | US_PROMPTCTL | US_EXTEDIT)
783 #define UA_KNOWN 2 /* Room appears in a 'known rooms' list */
784 #define UA_GOTOALLOWED 4 /* User may goto this room if specified by exact name */
785 #define UA_HASNEWMSGS 8 /* Unread messages exist in this room */
786 #define UA_ZAPPED 16 /* User has forgotten (zapped) this room */
787 #define UA_POSTALLOWED 32 /* User may post top-level messages here */
788 #define UA_ADMINALLOWED 64 /* Admin or Room Admin rights exist here */
789 #define UA_DELETEALLOWED 128 /* User is allowed to delete messages from this room */
790 #define UA_REPLYALLOWED 256 /* User is allowed to reply to existing messages here */
791 /* runtime flag extracted from goto reply; not db persistant, should be moved if new flags added */
792 #define UA_ISTRASH 512 /* Only available in room view... */
798 #endif // LIBCITADEL_H