Back to index

libcitadel  8.12
libcitadel.h
Go to the documentation of this file.
00001 /*
00002  * Header file for libcitadel
00003  *
00004  * Copyright (c) 1987-2012 by the citadel.org team
00005  *
00006  * This program is open source software; you can redistribute it and/or modify
00007  * it under the terms of the GNU General Public License version 3.
00008  *
00009  * This program is distributed in the hope that it will be useful,
00010  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00011  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00012  * GNU General Public License for more details.
00013  */
00014 
00015 
00016 /* protect against double includes */
00017 #ifndef LIBCITADEL_H
00018 #define LIBCITADEL_H
00019 
00020 
00021 /*
00022  * since we reference time_t...
00023  */
00024 #include <time.h>
00025 #include <stdlib.h>
00026 #include <stdarg.h>
00027 #include <arpa/inet.h>
00028 #include <sys/types.h>
00029 #include <netinet/in.h>
00030 
00031 #define LIBCITADEL_VERSION_NUMBER  812
00032 
00033 /*
00034  * Here's a bunch of stupid magic to make the MIME parser portable.
00035  */
00036 #ifndef SIZ
00037 #define SIZ   4096
00038 #endif
00039 
00040 
00041 typedef enum AXLevel {
00042        AxDeleted = 0,
00043        AxNewU = 1,
00044        AxProbU = 2,
00045        AxLocU = 3,
00046        AxNetU = 4,
00047        AxPrefU = 5,
00048        AxAideU = 6
00049 }eUsrAxlvl;
00050 
00051 enum RoomNetCfg {
00052        subpending,
00053        unsubpending,
00054        lastsent, /* Server internal use only */
00055        ignet_push_share,
00056        listrecp,
00057        digestrecp,
00058        pop3client,
00059        rssclient,
00060        participate,
00061        maxRoomNetCfg
00062 };
00063 
00064 enum GNET_POP3_PARTS { /* pop3client splits into these columns: */
00065        GNET_POP3_HOST = 1,
00066        GNET_POP3_USER = 2,
00067        GNET_POP3_PASS = 4,
00068        GNET_POP3_DONT_DELETE_REMOTE = 4,
00069        GNET_POP3_INTERVAL = 5
00070 };
00071 
00072 enum GNET_PUSH_SHARE { /* ignet_push_share splits into these columns: */
00073        GNET_IGNET_NODE = 1,
00074        GNET_IGNET_ROOM = 2
00075 };
00076 
00077 typedef enum __GPEXWhichPolicy {
00078        roompolicy,
00079        floorpolicy,
00080        sitepolicy,
00081        mailboxespolicy,
00082        maxpolicy
00083 }GPEXWhichPolicy;
00084 
00085 /*
00086  * View definitions.
00087  * Note that not all views are implemented in all clients.
00088  */
00089 typedef enum _room_views {
00090        VIEW_BBS             = 0,   /* Bulletin board view */
00091        VIEW_MAILBOX         = 1,   /* Mailbox summary */
00092        VIEW_ADDRESSBOOK     = 2,   /* Address book view */
00093        VIEW_CALENDAR        = 3,   /* Calendar view */
00094        VIEW_TASKS           = 4,   /* Tasks view */
00095        VIEW_NOTES           = 5,   /* Notes view */
00096        VIEW_WIKI            = 6,   /* Wiki view */
00097        VIEW_CALBRIEF        = 7,   /* Brief Calendar view */
00098        VIEW_JOURNAL         = 8,   /* Journal view */
00099        VIEW_DRAFTS          = 9,   /* Drafts view */
00100        VIEW_BLOG            = 10,  /* Blog view */
00101        VIEW_QUEUE           = 11,   /* SMTP/... QUEUE rooms */
00102        VIEW_MAX,
00103        VIEW_JSON_LIST,
00104 } ROOM_VIEWS;
00105 
00106 #define BLOG_EUIDBUF_SIZE   40
00107 
00108 #ifndef IsEmptyStr
00109 #define IsEmptyStr(a) ((a)[0] == '\0')
00110 #endif
00111 
00112 
00113 /*
00114  * another word to indicate n/a for a pointer if NULL already has a "meaning"
00115  */
00116 extern const char *StrBufNOTNULL;
00117 
00118 /*
00119  * Misc declarations
00120  */
00121 
00122 char *libcitadel_version_string(void);
00123 int libcitadel_version_number(void);
00124 void StartLibCitadel(size_t basesize);
00125 void ShutDownLibCitadel(void);
00126 
00127 /*
00128  * MIME parser declarations
00129  */
00130 
00131 long extract_key(char *target, char *source, long sourcelen, char *key, long keylen, char KeyEnd);
00132 
00133 
00134 typedef void (*MimeParserCallBackType)(char *cbname,
00135                                    char *cbfilename,
00136                                    char *cbpartnum,
00137                                    char *cbdisp,
00138                                    void *cbcontent,
00139                                    char *cbtype,
00140                                    char *cbcharset,
00141                                    size_t cblength,
00142                                    char *cbencoding,
00143                                    char *cbid,
00144                                    void *cbuserdata);
00145 
00146 void mime_parser(char *content_start, char *content_end,
00147                MimeParserCallBackType CallBack,
00148                MimeParserCallBackType PreMultiPartCallBack,
00149                MimeParserCallBackType PostMultiPartCallBack,
00150                void *userdata,
00151                int dont_decode);
00152 
00153 
00154 
00155 char *fixed_partnum(char *);
00156 void mime_decode(char *partnum,
00157                char *part_start, size_t length,
00158                char *content_type, char *charset, char *encoding,
00159                char *disposition,
00160                char *id,
00161                char *name, char *filename,
00162                MimeParserCallBackType CallBack,
00163                MimeParserCallBackType PreMultiPartCallBack,
00164                MimeParserCallBackType PostMultiPartCallBack,
00165                void *userdata,
00166                int dont_decode);
00167 int mime_decode_now (char *part_start, 
00168                    size_t length,
00169                    char *encoding,
00170                    char **decoded,
00171                    size_t *bytes_decoded);
00172 void the_mime_parser(char *partnum,
00173                    char *content_start, char *content_end,
00174                    MimeParserCallBackType CallBack,
00175                    MimeParserCallBackType PreMultiPartCallBack,
00176                    MimeParserCallBackType PostMultiPartCallBack,
00177                    void *userdata,
00178                    int dont_decode);
00179 
00180 typedef struct StrBuf StrBuf;
00181 
00182 #define strof(a) #a
00183 #define CStrOf(a) #a, sizeof(#a) - 1
00184 typedef struct _ConstStr {
00185        const char *Key;
00186        long len;
00187 }ConstStr;
00188 #define CKEY(a) (a).Key, (a).len
00189 
00190 StrBuf* NewStrBuf(void);
00191 StrBuf* NewStrBufDup(const StrBuf *CopyMe);
00192 StrBuf* NewStrBufPlain(const char* ptr, int nChars);
00193 long StrBufShrinkToFit(StrBuf *Buf, int Force);
00194 void ReAdjustEmptyBuf(StrBuf *Buf, long ThreshHold, long NewSize);
00195 void NewStrBufDupAppendFlush(StrBuf **CreateRelpaceMe, StrBuf *CopyFlushMe, const char *NoMe, int KeepOriginal);
00196 
00197 int StrBufPlain(StrBuf *Buf, const char* ptr, int nChars);
00198 StrBuf* _NewConstStrBuf(const char* StringConstant, size_t SizeOfStrConstant);
00199 #define NewConstStrBuf(a) _NewConstStrBuf(a, sizeof(a))
00200 void FreeStrBuf (StrBuf **FreeMe);
00201 char *SmashStrBuf (StrBuf **SmashMe);
00202 void HFreeStrBuf (void *VFreeMe);
00203 int FlushStrBuf(StrBuf *buf);
00204 int FLUSHStrBuf(StrBuf *buf); /* expensive but doesn't leave content behind for others to find in case of errors */
00205 
00206 const char *ChrPtr(const StrBuf *Str);
00207 int StrLength(const StrBuf *Str);
00208 #define SKEY(a) ChrPtr(a), StrLength(a)
00209 long StrBufPeek(StrBuf *Buf, const char* ptr, long nThChar, char PeekValue);
00210 long StrBufPook(StrBuf *Buf, const char* ptr, long nThChar, long nChars, char PookValue);
00211 
00212 int StrBufTCP_read_line(StrBuf *buf, int *fd, int append, const char **Error);
00213 int StrBufReadBLOB(StrBuf *Buf, int *fd, int append, long nBytes, const char **Error);
00214 #define NNN_TERM 1
00215 #define O_TERM 0
00216 int StrBufReadBLOBBuffered(StrBuf *Buf, 
00217                         StrBuf *IOBuf, 
00218                         const char **BufPos,
00219                         int *fd, 
00220                         int append, 
00221                         long nBytes, 
00222                         int check, 
00223                         const char **Error);
00224 int StrBufTCP_read_buffered_line(StrBuf *Line, 
00225                              StrBuf *buf, 
00226                              int *fd, 
00227                              int timeout, 
00228                              int selectresolution, 
00229                              const char **Error);
00230 int StrBufTCP_read_buffered_line_fast(StrBuf *Line, 
00231                                   StrBuf *buf, 
00232                                   const char **Pos,
00233                                   int *fd, 
00234                                   int timeout, 
00235                                   int selectresolution, 
00236                                   const char **Error);
00237 
00238 typedef enum _eReadState {
00239        eReadFail,
00240        eReadSuccess,
00241        eMustReadMore, 
00242        eBufferNotEmpty
00243 } eReadState;
00244 
00245 typedef struct _file_buffer {
00246        StrBuf *Buf;
00247        const char *ReadWritePointer;
00248        int fd;
00249        int LineCompleted;
00250        int nBlobBytesWanted;
00251 } IOBuffer;
00252 
00253 
00254 typedef struct __fd_iobuffer {
00255        IOBuffer *IOB;
00256        int OtherFD;
00257        int SplicePipe[2];
00258        int PipeSize;
00259        long TotalSendSize;
00260        long TotalSentAlready;
00261        long TotalReadAlready;
00262        long ChunkSize;
00263        long ChunkSendRemain;
00264        StrBuf *ChunkBuffer; /* just used if we don't have sendfile */
00265 } FDIOBuffer;
00266 
00267 
00268 void FDIOBufferInit(FDIOBuffer *FDB, IOBuffer *IO, int FD, long TotalSendSize);
00269 void FDIOBufferDelete(FDIOBuffer *FDB);
00270 int FileSendChunked(FDIOBuffer *FDB, const char **Err);
00271 int FileRecvChunked(FDIOBuffer *FDB, const char **Err);
00272 int FileMoveChunked(FDIOBuffer *FDB, const char **Err);
00273 eReadState WriteIOBAlreadyRead(FDIOBuffer *FDB, const char **Error);
00274 
00275 long StrBuf_read_one_chunk_callback (int fd, short event, IOBuffer *FB);
00276 int StrBuf_write_one_chunk_callback(int fd, short event, IOBuffer *FB);
00277 
00278 eReadState StrBufChunkSipLine(StrBuf *LineBuf, IOBuffer *FB);
00279 eReadState StrBufCheckBuffer(IOBuffer *FB);
00280 long IOBufferStrLength(IOBuffer *FB);
00281 
00282 int StrBufSipLine(StrBuf *LineBuf, const StrBuf *Buf, const char **Ptr);
00283 int StrBufReplaceToken(StrBuf *Buf, long where, long HowLong, const char *Repl, long ReplLen);
00284 int StrBufExtract_tokenFromStr(StrBuf *dest, const char *Source, long SourceLen, int parmnum, char separator);
00285 int StrBufExtract_token(StrBuf *dest, const StrBuf *Source, int parmnum, char separator);
00286 int StrBufSub(StrBuf *dest, const StrBuf *Source, unsigned long Offset, size_t nChars);
00287 
00288 unsigned long StrBufExtract_unsigned_long(const StrBuf* Source, int parmnum, char separator);
00289 long StrBufExtract_long(const StrBuf* Source, int parmnum, char separator);
00290 int StrBufExtract_int(const StrBuf* Source, int parmnum, char separator);
00291 int StrBufNum_tokens(const StrBuf *source, char tok);
00292 int StrBufRemove_token(StrBuf *Source, int parmnum, char separator);
00293 
00294 int StrBufHaveNextToken(const StrBuf *Source, const char **pStart);
00295 int StrBufExtract_NextToken(StrBuf *dest, const StrBuf *Source, const char **pStart, char separator);
00296 int StrBufSkip_NTokenS(const StrBuf *Source, const char **pStart, char separator, int nTokens);
00297 unsigned long StrBufExtractNext_unsigned_long(const StrBuf* Source, const char **pStart, char separator);
00298 long StrBufExtractNext_long(const StrBuf* Source, const char **pStart, char separator);
00299 int StrBufExtractNext_int(const StrBuf* Source, const char **pStart, char separator);
00300 
00301 
00302 void StrBufAppendBufPlain(StrBuf *Buf, const char *AppendBuf, long AppendSize, unsigned long Offset);
00303 void StrBufAppendBuf(StrBuf *Buf, const StrBuf *AppendBuf, unsigned long Offset);
00304 size_t CurlFillStrBuf_callback(void *ptr, size_t size, size_t nmemb, void *stream);
00305 void StrBufAppendPrintf(StrBuf *Buf, const char *format, ...);
00306 #ifdef SHOW_ME_VAPPEND_PRINTF
00307 /* so owe don't create an include depndency, this is just visible on demand. */
00308 void StrBufVAppendPrintf(StrBuf *Buf, const char *format, va_list ap);
00309 #endif
00310 void StrBufPrintf(StrBuf *Buf, const char *format, ...) __attribute__((__format__(__printf__,2,3)));
00311 void StrBufCutLeft(StrBuf *Buf, int nChars);
00312 void StrBufCutRight(StrBuf *Buf, int nChars);
00313 void StrBufCutAt(StrBuf *Buf, int AfternChars, const char *At);
00314 void StrBufTrim(StrBuf *Buf);
00315 void StrBufSpaceToBlank(StrBuf *Buf);
00316 void StrBufStripAllBut(StrBuf *Buf, char leftboundary, char rightboundary);
00317 void StrBufUpCase(StrBuf *Buf);
00318 void StrBufLowerCase(StrBuf *Buf);
00319 void StrBufStripSlashes(StrBuf *Dir, int RemoveTrailingSlash);
00320 void StrBufEUid_unescapize(StrBuf *target, const StrBuf *source);
00321 void StrBufEUid_escapize(StrBuf *target, const StrBuf *source);
00322 
00323 void StrBufToUnixLF(StrBuf *buf);
00324 void StrBufReplaceChars(StrBuf *buf, char search, char replace);
00325 
00326 int CompressBuffer(StrBuf *Buf);
00327 void StrBufConvert(StrBuf *ConvertBuf, StrBuf *TmpBuf, void *pic);
00328 void ctdl_iconv_open(const char *tocode, const char *fromcode, void *pic);
00329 void StrBuf_RFC822_2_Utf8(StrBuf *Target, 
00330                        const StrBuf *DecodeMe, 
00331                        const StrBuf* DefaultCharset, 
00332                        StrBuf *FoundCharset, 
00333                        StrBuf *ConvertBuf, 
00334                        StrBuf *ConvertBuf2);
00335 /* deprecated old version: */
00336 void StrBuf_RFC822_to_Utf8(StrBuf *Target, const StrBuf *DecodeMe, const StrBuf* DefaultCharset, StrBuf *FoundCharset);
00337 
00338 int StrBufDecodeBase64(StrBuf *Buf);
00339 int StrBufDecodeHex(StrBuf *Buf);
00340 int StrBufRFC2047encode(StrBuf **target, const StrBuf *source);
00341 StrBuf *StrBufSanitizeEmailRecipientVector(const StrBuf *Recp, 
00342                                       StrBuf *UserName, 
00343                                       StrBuf *EmailAddress,
00344                                       StrBuf *EncBuf);
00345 int StrBufSanitizeAscii(StrBuf *Buf, const char Mute);
00346 #define LB                  (1)           /* Internal escape chars */
00347 #define RB                  (2)
00348 #define QU                  (3)
00349 void StrBufUrlescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
00350 void StrBufUrlescUPAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
00351 void StrBufHexescAppend(StrBuf *OutBuf, const StrBuf *In, const char *PlainIn);
00352 void StrBufHexEscAppend(StrBuf *OutBuf, const StrBuf *In, const unsigned char *PlainIn, long PlainInLen);
00353 long StrEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
00354 long StrECMAEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
00355 long StrHtmlEcmaEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn, int nbsp, int nolinebreaks);
00356 void StrMsgEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
00357 void StrIcalEscAppend(StrBuf *Target, const StrBuf *Source, const char *PlainIn);
00358 
00359 long StrTol(const StrBuf *Buf);
00360 int StrToi(const StrBuf *Buf);
00361 int StrBufIsNumber(const StrBuf *Buf);
00362 long StrBuf_Utf8StrLen(StrBuf *Buf);
00363 long StrBuf_Utf8StrCut(StrBuf *Buf, int maxlen);
00364 
00365 const char *GuessMimeType(const char *data, size_t dlen);
00366 const char* GuessMimeByFilename(const char *what, size_t len);
00367 
00368 /* Run once at Programstart */
00369 int LoadIconDir(const char *DirName);
00370 
00371 /* Select the icon for a given MIME type */
00372 const char *GetIconFilename(char *MimeType, size_t len);
00373 
00374 
00375 /* URL parsing & connection data */
00376 typedef struct ParsedURL ParsedURL;
00377 struct ParsedURL {
00378        int Priority;
00379        StrBuf *URL;
00380        StrBuf *UrlWithoutCred;
00381        StrBuf *CurlCreds;
00382        unsigned Port;
00383        const char *Host;
00384        const char *User;
00385        const char *Pass;
00386        const char *LocalPart;
00387        const char *PlainUrl;
00388        int IsIP;
00389        int IPv6;
00390        int af;
00391        struct hostent *HEnt;
00392        struct sockaddr_in6 Addr;
00393        ParsedURL *Next;
00394 };
00395 
00396 void FreeURL(ParsedURL** Url);
00397 int ParseURL(ParsedURL **Url, StrBuf *UrlStr, unsigned short DefaultPort);
00398 void CurlPrepareURL(ParsedURL *Url);
00399 
00400 /* tools */
00401 
00402 
00403 int safestrncpy(char *dest, const char *src, size_t n);
00404 int num_tokens (const char *source, char tok);
00405 long extract_token(char *dest, const char *source, int parmnum, char separator, int maxlen);
00406 long grab_token(char **dest, const char *source, int parmnum, char separator);
00407 int extract_int (const char *source, int parmnum);
00408 long extract_long (const char *source, int parmnum);
00409 unsigned long extract_unsigned_long(const char *source, int parmnum);
00410 void CtdlInitBase64Table(void);
00411 size_t CtdlEncodeBase64(char *dest, const char *source, size_t sourcelen, int linebreaks);
00412 int CtdlDecodeBase64(char *dest, const char *source, size_t length);
00413 unsigned int decode_hex(char *Source);
00414 int CtdlDecodeQuotedPrintable(char *decoded, char *encoded, int sourcelen);
00415 void StripSlashes(char *Dir, int TrailingSlash);
00416 size_t striplt(char *);
00417 int haschar(const char *st, int ch);
00418 void remove_token(char *source, int parmnum, char separator);
00419 void fmt_date(char *buf, size_t n, time_t thetime, int seconds);
00420 int is_msg_in_sequence_set(const char *mset, long msgnum);
00421 char *memreadline(char *start, char *buf, int maxlen);
00422 char *memreadlinelen(char *start, char *buf, int maxlen, int *retlen);
00423 const char *cmemreadline(const char *start, char *buf, int maxlen);
00424 const char *cmemreadlinelen(const char *start, char *buf, int maxlen, int *retlen);
00425 #define IsEmptyStr(a) ((a)[0] == '\0')
00426 #define num_parms(source)          num_tokens(source,(char)'|')
00427 int stripout(char *str, char leftboundary, char rightboundary);
00428 long stripallbut(char *str, char leftboundary, char rightboundary);
00429 char *myfgets(char *s, int size, FILE *stream);
00430 void urlesc(char *outbuf, size_t oblen, char *strbuf);
00431 char *CtdlTempFileName(char *prefix1, int prefix2);
00432 FILE *CtdlTempFile(void);
00433 void generate_uuid(char *buf);
00434 char *bmstrcasestr(char *text, const char *pattern);
00435 char *bmstrcasestr_len(char *text, size_t textlen, const char *pattern, size_t patlen);
00436 const char *cbmstrcasestr(const char *text, const char *pattern);
00437 const char *cbmstrcasestr_len(const char *text, size_t textlen, const char *pattern, size_t patlen);
00438 void CtdlMakeTempFileName(char *name, int len);
00439 char *rfc2047encode(char *line, long length);
00440 int is_msg_in_mset(const char *mset, long msgnum);
00441 int pattern2(char *search, char *patn);
00442 void stripltlen(char *, int *);
00443 char *html_to_ascii(const char *inputmsg, int msglen, int screenwidth, int do_citaformat);
00444 void LoadEntityList(char *FileName);
00445 
00446 
00447 
00448 /* vCard stuff */
00449 
00450 #define CTDL_VCARD_MAGIC    0xa1f9
00451 
00452 /* This data structure represents a vCard object currently in memory. */
00453 struct vCard {
00454        int magic;
00455        int numprops;
00456        struct vCardProp {
00457               char *name;
00458               char *value;
00459        } *prop;
00460 };
00461 
00462 
00463 struct vCard *vcard_new(void);
00464 void vcard_add_prop(struct vCard *v, char *propname, char *propvalue);
00465 struct vCard *vcard_load(char *vtext);
00466 struct vCard *VCardLoad(StrBuf *vbtext);
00467 
00468 void vcard_free(struct vCard *);
00469 void vcard_set_prop(struct vCard *v, char *name, char *value, int append);
00470 char *vcard_get_prop(struct vCard *v, char *propname, int is_partial,
00471                      int instance, int return_propname);
00472 char *vcard_serialize(struct vCard *);
00473 void vcard_fn_to_n(char *vname, char *n, size_t vname_size);
00474 void remove_charset_attribute(char *strbuf);
00475 long StrBufUnescape(StrBuf *Buf, int StripBlanks);
00476 
00477 /*
00478  * Hash list implementation for Citadel
00479  */
00480 #define HKEY(a) a, (sizeof(a) - 1)
00481 
00482 typedef struct HashList HashList;
00483 
00484 typedef struct HashKey HashKey;
00485 
00486 typedef struct HashPos HashPos;
00487 
00488 typedef void (*DeleteHashDataFunc)(void * Data);
00489 typedef const char *(*PrintHashContent)(void * Data);
00490 typedef int (*CompareFunc)(const void* Item1, const void*Item2);
00491 typedef long (*HashFunc)(const char *Str, long Len);
00492 typedef void (*TransitionFunc) (void *Item1, void *Item2, int Odd);
00493 typedef void (*PrintHashDataFunc) (const char *Key, void *Item, int Odd);
00494 
00495 long Flathash(const char *str, long len);
00496 long lFlathash(const char *str, long len);
00497 #define IKEY(a) (const char*) &a, sizeof(a)
00498 #define LKEY(a) (const char*) &a, sizeof(a)
00499 
00500 int TestValidateHash(HashList *TestHash);
00501 
00502 HashList *NewHash(int Uniq, HashFunc F);
00503 void DeleteHash(HashList **Hash);
00504 void DeleteHashContent(HashList **Hash);
00505 void HDeleteHash(void *vHash);
00506 int GetHash(HashList *Hash, const char *HKey, long HKLen, void **Data);
00507 void Put(HashList *Hash, const char *HKey, long HKLen, void *Data, DeleteHashDataFunc DeleteIt);
00508 int GetKey(HashList *Hash, char *HKey, long HKLen, void **Data);
00509 int GetHashKeys(HashList *Hash, char ***List);
00510 int dbg_PrintHash(HashList *Hash, PrintHashContent first, PrintHashContent Second);
00511 int PrintHash(HashList *Hash, TransitionFunc Trans, PrintHashDataFunc PrintEntry);
00512 HashPos *GetNewHashPos(HashList *Hash, int StepWidth);
00513 int GetHashPosFromKey(HashList *Hash, const char *HKey, long HKLen, HashPos *At);
00514 int DeleteEntryFromHash(HashList *Hash, HashPos *At);
00515 int GetHashPosCounter(HashList *Hash, HashPos *At);
00516 void DeleteHashPos(HashPos **DelMe);
00517 int NextHashPos(HashList *Hash, HashPos *At);
00518 int GetHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
00519 int GetNextHashPos(HashList *Hash, HashPos *At, long *HKLen, const char **HashKey, void **Data);
00520 int GetHashAt(HashList *Hash,long At, long *HKLen, const char **HashKey, void **Data);
00521 void SortByHashKey(HashList *Hash, int Order);
00522 void SortByHashKeyStr(HashList *Hash);
00523 int GetCount(HashList *Hash);
00524 const void *GetSearchPayload(const void *HashVoid);
00525 void SortByPayload(HashList *Hash, CompareFunc SortBy);
00526 void reference_free_handler(void *ptr);
00527 int HashLittle(const void *key, size_t length);
00528 
00529 typedef struct MSet MSet;
00530 int ParseMSet(MSet **MsetList, StrBuf *MSetStr);
00531 int IsInMSetList(MSet *MSetList, long MsgNo);
00532 void DeleteMSet(MSet **FreeMe);
00533 
00534 void convert_spaces_to_underscores(char *str);
00535 int CheckEncode(const char *pch, long len, const char *pche);
00536 
00537 /*
00538  * Convert 4 bytes char into an Integer.
00539  * usefull for easy inexpensive hashing 
00540  * of for char strings.
00541  */
00542 #define CHAR4TO_INT(a) ((int) (a[0] | (a[1]<<8) | (a[2]<<16) | (a[3]<<24)))
00543 
00544 /* vNote implementation */
00545 
00546 #define CTDL_VNOTE_MAGIC    0xa1fa
00547 
00548 struct vnote {
00549        int magic;
00550        char *uid;
00551        char *summary;
00552        char *body;
00553        int pos_left;
00554        int pos_top;
00555        int pos_width;
00556        int pos_height;
00557        int color_red;
00558        int color_green;
00559        int color_blue;
00560 };
00561 
00562 
00563 
00564 struct vnote *vnote_new(void);
00565 struct vnote *vnote_new_from_str(char *s);
00566 void vnote_free(struct vnote *v);
00567 char *vnote_serialize(struct vnote *v);
00568 void vnote_serialize_output_field(char *append_to, char *field, char *label);
00569 
00570 
00571 
00572 
00573 /*
00574  * Create JSON style structures in C plus serialize them to one string
00575  */
00576 
00577 typedef struct JsonValue JsonValue;
00578 
00579 
00580 void DeleteJSONValue(void *vJsonValue);
00581 
00582 JsonValue *NewJsonObject(const char *Key, long keylen);
00583 
00584 JsonValue *NewJsonArray(const char *Key, long keylen);
00585 
00586 JsonValue *NewJsonNumber(const char *Key, long keylen, long Number);
00587 
00588 JsonValue *NewJsonBigNumber(const char *Key, long keylen, double Number);
00589 
00590 JsonValue *NewJsonString(const char *Key, long keylen, StrBuf *CopyMe);
00591 
00592 JsonValue *NewJsonPlainString(const char *Key, long keylen, const char *CopyMe, long len);
00593 
00594 JsonValue *NewJsonNull(const char *Key, long keylen);
00595 
00596 JsonValue *NewJsonBool(const char *Key, long keylen, int value);
00597 
00598 void JsonArrayAppend(JsonValue *Array, JsonValue *Val);
00599 
00600 void JsonObjectAppend(JsonValue *Array, JsonValue *Val);
00601 
00602 void SerializeJson(StrBuf *Target, JsonValue *Val, int FreeVal);
00603 
00604 
00605 
00606 /*
00607  * Citadels Wildfire implementation, see 
00608  * http://www.firephp.org/Wiki/Reference/Protocol
00609  * and http://wildfirehq.org/ for details
00610  */
00611 typedef void (*AddHeaderFunc)(const char *HdrName, const char *HdrValue);
00612 
00613 typedef enum _WF_MessageType {
00614        eLOG, 
00615        eINFO,
00616        eWARN,
00617        eERROR,
00618        eTRACE,
00619        eEXCEPTION
00620 } WF_MessageType;
00621 
00622 JsonValue *WildFireException(const char *Filename, long FileLen,
00623                           long LineNo,
00624                           StrBuf *Message,
00625                           int StackOffset);
00626 
00627 void WildFireAddArray(JsonValue *ReportBase, JsonValue *Array, WF_MessageType Type);
00628 
00629 JsonValue *WildFireMessagePlain(const char *Filename, long fnlen,
00630                                long LineNo,
00631                                const char *Message, long len, 
00632                                WF_MessageType Type);
00633 
00634 JsonValue *WildFireMessage(const char *Filename, long fnlen,
00635                         long lineno,
00636                         StrBuf *Msg, 
00637                         WF_MessageType Type);
00638 
00639 void WildFireInitBacktrace(const char *argvNull, int AddBaseFrameSkip);
00640 
00641 void WildFireSerializePayload(StrBuf *JsonBuffer, StrBuf *OutBuf, int *MsgCount, AddHeaderFunc AddHdr);
00642 
00643 #define WF_MAJOR "1"
00644 #define WF_STRUCTINDEX "1"
00645 #define WF_SUB "1"
00646 
00647 extern ConstStr RoomNetCfgStrs[maxRoomNetCfg];
00648 
00649 /* Convenience function to "perform a function and cut a log record if result != 0" */
00650 #define CtdlLogResult(x) if (x) syslog(LOG_CRIT, "%s:%d %s", __FILE__, __LINE__, strerror(errno))
00651 
00652 /* a nice consistent place to define how we turn a message id into a thread id hash */
00653 #define ThreadIdHash(Buf) abs(HashLittle(ChrPtr(Buf), StrLength(Buf)))
00654 
00655 
00656 #endif // LIBCITADEL_H