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