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