libcitadel/lib/libcitadel.h

   1 /*
   2  * $Id$
   3  *
   4  */
   5
   6
   7 /* protect against double includes */
   8 #ifndef LIBCITADEL_H
   9 #define LIBCITADEL_H
  10
  11
  12 /*
  13  * since we reference time_t...
  14  */
  15 #include <time.h>
  16 #include <stdlib.h>
  17 #include <stdarg.h>
  18 #define LIBCITADEL_VERSION_NUMBER       780
  19
  20 /*
  21  * Here's a bunch of stupid magic to make the MIME parser portable.
  22  */
  23 #ifndef SIZ
  24 #define SIZ     4096
  25 #endif
  26
  27
  28 /* Logging levels - correspond to syslog(3) */
  29 enum LogLevel {
  30         /* When about to exit the server for an unrecoverable error */
  31          CTDL_EMERG,    /* system is unusable */
  32         /* Manual intervention is required to avoid an abnormal exit */
  33          CTDL_ALERT,    /* action must be taken immediately */
  34         /* The server can continue to run with degraded functionality */
  35          CTDL_CRIT,     /* critical conditions */
  36         /* An error occurs but the server continues to run normally */
  37          CTDL_ERR,      /* error conditions */
  38         /* An abnormal condition was detected; server will continue normally */
  39          CTDL_WARNING,  /* warning conditions */
  40         /* Normal messages (login/out, activity, etc.) */
  41          CTDL_NOTICE,   /* normal but significant condition */
  42         /* Unimportant progress messages, etc. */
  43          CTDL_INFO,     /* informational */
  44         /* Debugging messages */
  45          CTDL_DEBUG     /* debug-level messages */
  46 };
  47
  48 typedef enum AXLevel {
  49         AxDeleted = 0,
  50         AxNewU = 1,
  51         AxProbU = 2,
  52         AxLocU = 3,
  53         AxNetU = 4,
  54         AxPrefU = 5,
  55         AxAideU = 6
  56 }eUsrAxlvl;
  57
  58 enum RoomNetCfg {
  59         subpending,
  60         unsubpending,
  61         lastsent, /* Server internal use only */
  62         ignet_push_share,
  63         listrecp,
  64         digestrecp,
  65         pop3client,
  66         rssclient,
  67         participate,
  68         maxRoomNetCfg
  69 };
  70
  71
  72 typedef enum __GPEXWhichPolicy {
  73         roompolicy,
  74         floorpolicy,
  75         sitepolicy,
  76         mailboxespolicy,
  77         maxpolicy
  78 }GPEXWhichPolicy;
  79
  80 /*
  81  * View definitions.
  82  * Note that not all views are implemented in all clients.
  83  */
  84 #define VIEW_BBS                0       /* Bulletin board view */
  85 #define VIEW_MAILBOX            1       /* Mailbox summary */
  86 #define VIEW_ADDRESSBOOK        2       /* Address book view */
  87 #define VIEW_CALENDAR           3       /* Calendar view */
  88 #define VIEW_TASKS              4       /* Tasks view */
  89 #define VIEW_NOTES              5       /* Notes view */
  90 #define VIEW_WIKI               6       /* Wiki view */
  91 #define VIEW_CALBRIEF           7       /* Brief Calendar view */
  92 #define VIEW_JOURNAL            8       /* Journal view */
  93 #define VIEW_BLOG               9       /* Blog view (not yet implemented) */
  94
  95
  96 #ifndef IsEmptyStr
  97 #define IsEmptyStr(a) ((a)[0] == '\0')
  98 #endif
  99
 100
 101 /*
 102  * another word to indicate n/a for a pointer if NULL already has a "meaning"
 103  */
 104 extern const char *StrBufNOTNULL;
 105
 106 /*
 107  * Misc declarations
 108  */
 109
 110 char *libcitadel_version_string(void);
 111 int libcitadel_version_number(void);
 112 void StartLibCitadel(size_t basesize);
 113 void ShutDownLibCitadel(void);
 114
 115 /*
 116  * MIME parser declarations
 117  */
 118
 119 void extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
 120
 121
 122 typedef void (*MimeParserCallBackType)(char *cbname,
 123                                        char *cbfilename,
 124                                        char *cbpartnum,
 125                                        char *cbdisp,
 126                                        void *cbcontent,
 127                                        char *cbtype,
 128                                        char *cbcharset,
 129                                        size_t cblength,
 130                                        char *cbencoding,
 131                                        char *cbid,
 132                                        void *cbuserdata);
 133
 134 void mime_parser(char *content_start, char *content_end,
 135                  MimeParserCallBackType CallBack,
 136                  MimeParserCallBackType PreMultiPartCallBack,
 137                  MimeParserCallBackType PostMultiPartCallBack,
 138                  void *userdata,
 139                  int dont_decode);
 140
 141
 142
 143 char *fixed_partnum(char *);
 144 void mime_decode(char *partnum,
 145                  char *part_start, size_t length,
 146                  char *content_type, char *charset, char *encoding,
 147                  char *disposition,
 148                  char *id,
 149                  char *name, char *filename,
 150                  MimeParserCallBackType CallBack,
 151                  MimeParserCallBackType PreMultiPartCallBack,
 152                  MimeParserCallBackType PostMultiPartCallBack,
 153                  void *userdata,
 154                  int dont_decode);
 155 void the_mime_parser(char *partnum,
 156                      char *content_start, char *content_end,
 157                      MimeParserCallBackType CallBack,
 158                      MimeParserCallBackType PreMultiPartCallBack,
 159                      MimeParserCallBackType PostMultiPartCallBack,
 160                      void *userdata,
 161                      int dont_decode);
 162
 163 typedef struct StrBuf StrBuf;
 164
 165 #define strof(a) #a
 166 #define CStrOf(a) #a, sizeof(#a) - 1
 167 typedef struct _ConstStr {
 168         const char *Key;
 169         long len;
 170 }ConstStr;
 171 #define CKEY(a) (a).Key, (a).len
 172
 173 StrBuf* NewStrBuf(void);
 174 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
 175 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
 176 long StrBufShrinkToFit(StrBuf *Buf, int Force);
 177 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
 178
 179 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
 180 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
 181 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
 182 void FreeStrBuf (StrBuf **FreeMe);
 183 char *SmashStrBuf (StrBuf **SmashMe);
 184 void HFreeStrBuf (void *VFreeMe);
 185 int FlushStrBuf(StrBuf *buf);
 186 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
 187
 188 const char *ChrPtr(const StrBuf *Str);
 189 int StrLength(const StrBuf *Str);
 190 #define SKEY(a) ChrPtr(a), StrLength(a)
 191 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
 192 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
 193
 194 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
 195 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
 196 #define NNN_TERM 1
 197 #define O_TERM 0
 198 int StrBufReadBLOBBuffered(StrBuf *Buf,
 199                            StrBuf *IOBuf,
 200                            const char **BufPos,
 201                            int *fd,
 202                            int append,
 203                            long nBytes,
 204                            int check,
 205                            const char **Error);
 206 int StrBufTCP_read_buffered_line(StrBuf *Line,
 207                                  StrBuf *buf,
 208                                  int *fd,
 209                                  int timeout,
 210                                  int selectresolution,
 211                                  const char **Error);
 212 int StrBufTCP_read_buffered_line_fast(StrBuf *Line,
 213                                       StrBuf *buf,
 214                                       const char **Pos,
 215                                       int *fd,
 216                                       int timeout,
 217                                       int selectresolution,
 218                                       const char **Error);
 219
 220 int StrBufSipLine(StrBuf *LineBuf, StrBuf *Buf, const char **Ptr);
 221 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
 222 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
 223 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
 224
 225 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
 226 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
 227 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
 228 int StrBufNum_tokens(const StrBuf *source, char tok);
 229 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
 230
 231 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
 232 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
 233 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
 234 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
 235 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
 236 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
 237
 238
 239 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
 240 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
 241 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
 242 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
 243 #ifdef SHOW_ME_VAPPEND_PRINTF
 244 /* so owe don't create an include depndency, this is just visible on demand. */
 245 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
 246 #endif
 247 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
 248 void StrBufCutLeft(StrBuf *Buf, int nChars);
 249 void StrBufCutRight(StrBuf *Buf, int nChars);
 250 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
 251 void StrBufTrim(StrBuf *Buf);
 252 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
 253 void StrBufUpCase(StrBuf *Buf);
 254 void StrBufLowerCase(StrBuf *Buf);
 255 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
 256 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
 257 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
 258
 259 void StrBufToUnixLF(StrBuf *buf);
 260 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
 261
 262 int CompressBuffer(StrBuf *Buf);
 263 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
 264 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
 265 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
 266 int StrBufDecodeBase64(StrBuf *Buf);
 267 int StrBufDecodeHex(StrBuf *Buf);
 268 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
 269 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp,
 270                                            StrBuf *UserName,
 271                                            StrBuf *EmailAddress,
 272                                            StrBuf *EncBuf);
 273 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
 274 #define LB                      (1)             /* Internal escape chars */
 275 #define RB                      (2)
 276 #define QU                      (3)
 277 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
 278 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
 279 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
 280 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 281 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
 282 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 283 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
 284
 285 long StrTol(const StrBuf *Buf);
 286 int StrToi(const StrBuf *Buf);
 287 int StrBufIsNumber(const StrBuf *Buf);
 288 long StrBuf_Utf8StrLen(StrBuf *Buf);
 289 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
 290
 291 const char *GuessMimeType(const char *data, size_t dlen);
 292 const char* GuessMimeByFilename(const char *what, size_t len);
 293
 294 /* Run once at Programstart */
 295 int LoadIconDir(const char *DirName);
 296
 297 /* Select the icon for a given MIME type */
 298 const char *GetIconFilename(char *MimeType, size_t len);
 299
 300
 301 /* tools */
 302
 303
 304 int safestrncpy(char *dest, const char *src, size_t n);
 305 int num_tokens (const char *source, char tok);
 306 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
 307 long grab_token(char **dest, const char *source, int parmnum, char separator);
 308 int extract_int (const char *source, int parmnum);
 309 long extract_long (const char *source, int parmnum);
 310 unsigned long extract_unsigned_long(const char *source, int parmnum);
 311 void CtdlInitBase64Table(void);
 312 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
 313 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
 314 unsigned int decode_hex(char *Source);
 315 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
 316 void StripSlashes(char *Dir, int TrailingSlash);
 317 size_t striplt(char *);
 318 int haschar(const char *st, int ch);
 319 void remove_token(char *source, int parmnum, char separator);
 320 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
 321 int is_msg_in_sequence_set(const char *mset, long msgnum);
 322 const char *memreadline(const char *start, char *buf, int maxlen);
 323 const char *memreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
 324 #define IsEmptyStr(a) ((a)[0] == '\0')
 325 #define num_parms(source)               num_tokens(source,(char)'|')
 326 int stripout(char *str, char leftboundary, char rightboundary);
 327 void stripallbut(char *str, char leftboundary, char rightboundary);
 328 char *myfgets(char *s, int size, FILE *stream);
 329 void urlesc(char *outbuf, size_t oblen, char *strbuf);
 330 char *CtdlTempFileName(char *prefix1, int prefix2);
 331 FILE *CtdlTempFile(void);
 332 void generate_uuid(char *buf);
 333 const char *bmstrcasestr(const char *text, const char *pattern);
 334 const char *bmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
 335 void CtdlMakeTempFileName(char *name, int len);
 336 char *rfc2047encode(char *line, long length);
 337 int is_msg_in_mset(const char *mset, long msgnum);
 338 int pattern2(char *search, char *patn);
 339 void stripltlen(char *, int *);
 340 char *html_to_ascii(char *inputmsg, int msglen, int screenwidth, int do_citaformat);
 341 void LoadEntityList(char *FileName);
 342
 343
 344
 345 /* vCard stuff */
 346
 347 #define CTDL_VCARD_MAGIC        0xa1f9
 348
 349 /* This data structure represents a vCard object currently in memory. */
 350 struct vCard {
 351         int magic;
 352         int numprops;
 353         struct vCardProp {
 354                 char *name;
 355                 char *value;
 356         } *prop;
 357 };
 358
 359
 360 struct vCard *vcard_new(void);
 361 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
 362 struct vCard *vcard_load(char *vtext);
 363 struct vCard *VCardLoad(StrBuf *vbtext);
 364
 365 void vcard_free(struct vCard *);
 366 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
 367 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
 368                         int instance, int return_propname);
 369 char *vcard_serialize(struct vCard *);
 370 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
 371 void remove_charset_attribute(char *strbuf);
 372 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
 373
 374 /*
 375  * Hash list implementation for Citadel
 376  */
 377 #define HKEY(a) a, (sizeof(a) - 1)
 378
 379 typedef struct HashList HashList;
 380
 381 typedef struct HashKey HashKey;
 382
 383 typedef struct HashPos HashPos;
 384
 385 typedef void (*DeleteHashDataFunc)(void * Data);
 386 typedef const char *(*PrintHashContent)(void * Data);
 387 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
 388 typedef int (*HashFunc)(const char *Str, long Len);
 389 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
 390 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
 391
 392 int Flathash(const char *str, long len);
 393 #define IKEY(a) (const char*) &a, sizeof(a)
 394
 395 HashList *NewHash(int Uniq, HashFunc F);
 396 void DeleteHash(HashList **Hash);
 397 void HDeleteHash(void *vHash);
 398 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
 399 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
 400 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
 401 int GetHashKeys(HashList *Hash, char ***List);
 402 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
 403 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
 404 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
 405 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
 406 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
 407 int GetHashPosCounter(HashList *Hash, HashPos *At);
 408 void DeleteHashPos(HashPos **DelMe);
 409 int NextHashPos(HashList *Hash, HashPos *At);
 410 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
 411 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
 412 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
 413 void SortByHashKey(HashList *Hash, int Order);
 414 void SortByHashKeyStr(HashList *Hash);
 415 int GetCount(HashList *Hash);
 416 const void *GetSearchPayload(const void *HashVoid);
 417 void SortByPayload(HashList *Hash, CompareFunc SortBy);
 418 void reference_free_handler(void *ptr);
 419 int HashLittle(const void *key, size_t length);
 420
 421
 422 void convert_spaces_to_underscores(char *str);
 423 int CheckEncode(const char *pch, long len, const char *pche);
 424
 425 /*
 426  * Convert 4 bytes char into an Integer.
 427  * usefull for easy inexpensive hashing
 428  * of for char strings.
 429  */
 430 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
 431
 432 /* vNote implementation */
 433
 434 #define CTDL_VNOTE_MAGIC        0xa1fa
 435
 436 struct vnote {
 437         int magic;
 438         char *uid;
 439         char *summary;
 440         char *body;
 441         int pos_left;
 442         int pos_top;
 443         int pos_width;
 444         int pos_height;
 445         int color_red;
 446         int color_green;
 447         int color_blue;
 448 };
 449
 450
 451
 452 struct vnote *vnote_new(void);
 453 struct vnote *vnote_new_from_str(char *s);
 454 void vnote_free(struct vnote *v);
 455 char *vnote_serialize(struct vnote *v);
 456 void vnote_serialize_output_field(char *append_to, char *field, char *label);
 457
 458
 459
 460
 461 /*
 462  * Create JSON style structures in C plus serialize them to one string
 463  */
 464
 465 typedef struct JsonValue JsonValue;
 466
 467
 468 void DeleteJSONValue(void *vJsonValue);
 469
 470 JsonValue *NewJsonObject(const char *Key, long keylen);
 471
 472 JsonValue *NewJsonArray(const char *Key, long keylen);
 473
 474 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
 475
 476 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
 477
 478 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
 479
 480 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
 481
 482 JsonValue *NewJsonNull(const char *Key, long keylen);
 483
 484 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
 485
 486 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
 487
 488 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
 489
 490 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
 491
 492
 493
 494 /*
 495  * Citadels Wildfire implementation, see
 496  * http://www.firephp.org/Wiki/Reference/Protocol
 497  * and http://wildfirehq.org/ for details
 498  */
 499 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
 500
 501 typedef enum _WF_MessageType {
 502         eLOG,
 503         eINFO,
 504         eWARN,
 505         eERROR,
 506         eTRACE,
 507         eEXCEPTION
 508 } WF_MessageType;
 509
 510 JsonValue *WildFireException(const char *Filename, long FileLen,
 511                              long LineNo,
 512                              StrBuf *Message,
 513                              int StackOffset);
 514
 515 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
 516
 517 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
 518                                    long LineNo,
 519                                    const char *Message, long len,
 520                                    WF_MessageType Type);
 521
 522 JsonValue *WildFireMessage(const char *Filename, long fnlen,
 523                            long lineno,
 524                            StrBuf *Msg,
 525                            WF_MessageType Type);
 526
 527 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
 528
 529 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
 530
 531 #define WF_MAJOR "1"
 532 #define WF_STRUCTINDEX "1"
 533 #define WF_SUB "1"
 534
 535
 536 #endif  // LIBCITADEL_H