]> Pileus Git - ~andy/fetchmail/blobdiff - fetchmail.h
Rename lock_release to fm_lock_release, to avoid namespace collision on
[~andy/fetchmail] / fetchmail.h
index 943765d93d5b410ac06ee27ff2b33098e377872d..74121bd5ea898d2f68596859f993702474ff1bd5 100644 (file)
@@ -5,6 +5,33 @@
 /* We need this for HAVE_STDARG_H, etc */
 #include "config.h"
 
+/* We need this for size_t */
+#include <sys/types.h>
+
+/* We need this for time_t */
+#if TIME_WITH_SYS_TIME
+# include <sys/time.h>
+# include <time.h>
+#else
+# if HAVE_SYS_TIME_H
+#  include <sys/time.h>
+# else
+#  include <time.h>
+# endif
+#endif
+
+#include <stdio.h>
+
+/* Import Trio if needed */
+#if !defined(HAVE_SNPRINTF) || !defined(HAVE_VSNPRINTF)
+#  include "trio/trio.h"
+#endif
+
+/* We need this for strstr */
+#if !defined(HAVE_STRSTR) && !defined(strstr)
+char *strstr(const char *, const char *);
+#endif
+
 /* constants designating the various supported protocols */
 #define                P_AUTO          1
 #define                P_POP2          2
@@ -15,7 +42,7 @@
 #define                P_ETRN          7
 #define                P_ODMR          8
 
-#if INET6_ENABLE
+#ifdef INET6_ENABLE
 #define                SMTP_PORT       "smtp"
 #define                KPOP_PORT       "kpop"
 #else /* INET6_ENABLE */
 #define                PS_REFUSED      25      /* mail refused (internal use) */
 #define                PS_RETAINED     26      /* message retained (internal use) */
 #define                PS_TRUNCATED    27      /* headers incomplete (internal use) */
+#define                PS_REPOLL       28      /* repoll immediately with changed parameters (internal use) */
+#define                PS_IDLETIMEOUT  29      /* timeout on imap IDLE (internal use) */
 
 /* output noise level */
 #define         O_SILENT       0       /* mute, max squelch, etc. */
@@ -142,7 +171,7 @@ struct idlist
     {
        struct
        {
-           short       num;
+           int         num;
            flag        mark;           /* UID-index information */
 #define UID_UNSEEN     0               /* hasn't been seen */
 #define UID_SEEN       1               /* seen, but not deleted */
@@ -160,7 +189,7 @@ struct query;
 struct method          /* describe methods for protocol state machine */
 {
     const char *name;          /* protocol name */
-#if INET6_ENABLE
+#ifdef INET6_ENABLE
     const char *service;
     const char *sslservice;
 #else /* INET6_ENABLE */
@@ -177,6 +206,8 @@ struct method               /* describe methods for protocol state machine */
                                /* get message range to fetch */
     int (*getsizes)(int, int, int *);
                                /* get sizes of messages */
+    int (*getpartialsizes)(int, int, int, int *);
+                               /* get sizes of subset of messages */
     int (*is_old)(int, struct query *, int);
                                /* check for old message */
     int (*fetch_headers)(int, struct query *, int, int *);
@@ -187,6 +218,8 @@ struct method               /* describe methods for protocol state machine */
                                /* eat trailer of a message */
     int (*delete)(int, struct query *, int);
                                /* delete method */
+    int (*mark_seen)(int, struct query *, int);
+                               /* mark as seen method */
     int (*logout_cmd)(int, struct query *);
                                /* logout command */
     flag retry;                        /* can getrange poll for new messages? */
@@ -200,7 +233,7 @@ struct hostdata             /* shared among all user connections to given server */
     struct idlist *akalist;            /* server name first, then akas */
     struct idlist *localdomains;       /* list of pass-through domains */
     int protocol;                      /* protocol type */
-#if INET6_ENABLE
+#ifdef INET6_ENABLE
     char *service;                     /* IPv6 service name */
     void *netsec;                      /* IPv6 security request */
 #else /* INET6_ENABLE */
@@ -218,9 +251,10 @@ struct hostdata            /* shared among all user connections to given server */
 #ifdef SDPS_ENABLE
     flag sdps;                         /* use Demon Internet SDPS *ENV */
 #endif /* SDPS_ENABLE */
-    flag checkalias;                   /* resolve aliases by comparing IPs? */
+    flag checkalias;                   /* resolve aliases by comparing IPs? */
+    flag tracepolls;                   /* if TRUE, add poll trace info to Received */
     char *principal;                   /* Kerberos principal for mail service */
-
+    char *esmtp_name, *esmtp_password; /* ESMTP AUTH information */
 
 #if defined(linux) || defined(__FreeBSD__)
     char *interface;
@@ -282,6 +316,9 @@ struct query
     int        limit;                  /* limit size of retrieved messages */
     int warnings;              /* size warning interval */
     int        fetchlimit;             /* max # msgs to get in single poll */
+    int fetchsizelimit;                /* max # msg sizes to get in a request */
+    int fastuidl;              /* do binary search for new UIDLs? */
+    int fastuidlcount;         /* internal count for frequency of binary search */
     int        batchlimit;             /* max # msgs to pass in single SMTP session */
     int        expunge;                /* max # msgs to pass between expunges */
     flag use_ssl;              /* use SSL encrypted session */
@@ -292,7 +329,6 @@ struct query
     flag sslcertck;            /* Strictly check the server cert. */
     char *sslfingerprint;      /* Fingerprint to check against */
     char *properties;          /* passthrough properties for extensions */
-    flag tracepolls;           /* if TRUE, add poll trace info to Received */
 
     /* internal use -- per-poll state */
     flag active;               /* should we actually poll this server? */
@@ -307,12 +343,12 @@ struct query
     unsigned int uid;          /* UID of user to deliver to */
     struct idlist *skipped;    /* messages skipped on the mail server */
     struct idlist *oldsaved, *newsaved;
-    char *lastid;              /* last Message-ID seen on this connection */
-    char *thisid;              /* Message-ID of current message */
+    struct idlist **oldsavedend;
+    char lastdigest[DIGESTLEN];        /* last MD5 hash seen on this connection */
 
     /* internal use -- per-message state */
     int mimemsg;               /* bitmask indicating MIME body-type */
-    char digest [DIGESTLEN];   /* md5 digest buffer */
+    char digest[DIGESTLEN];    /* md5 digest buffer */
 
     /* internal use -- housekeeping */
     struct query *next;                /* next query control block in chain */
@@ -383,21 +419,39 @@ extern int pass;          /* number of re-polling pass */
 extern flag configdump;                /* dump control blocks as Python dictionary */
 extern char *fetchmailhost;    /* either "localhost" or an FQDN */
 extern int suppress_tags;      /* suppress tags in tagged protocols? */
-extern char shroud[PASSWORDLEN];       /* string to shroud in debug output */
+extern char shroud[PASSWORDLEN*2+3];   /* string to shroud in debug output */
 #ifdef SDPS_ENABLE
 extern char *sdps_envfrom;
 extern char *sdps_envto;
 #endif /* SDPS_ENABLE */
 
+extern const char *iana_charset;       /* IANA assigned charset name */
+
+/* from ucs/norm_charmap.c */
+const char *norm_charmap(const char *name);
+
 /* prototypes for globally callable functions */
 
+/* from /usr/include/sys/cdefs.h */
+#if !defined __GNUC__ || __GNUC__ < 2
+# define __attribute__(xyz)    /* Ignore. */
+#endif
+
 /* error.c: Error reporting */
 #if defined(HAVE_STDARG_H)
 void report_init(int foreground);
-void report (FILE *fp, const char *format, ...);
-void report_build (FILE *fp, const char *format, ...);
-void report_complete (FILE *fp, const char *format, ...);
-void report_at_line (FILE *fp, int, const char *, unsigned int, const char *, ...);
+void report (FILE *fp, const char *format, ...)
+    __attribute__ ((format (printf, 2, 3)))
+    ;
+void report_build (FILE *fp, const char *format, ...)
+    __attribute__ ((format (printf, 2, 3)))
+    ;
+void report_complete (FILE *fp, const char *format, ...)
+    __attribute__ ((format (printf, 2, 3)))
+    ;
+void report_at_line (FILE *fp, int, const char *, unsigned int, const char *, ...)
+    __attribute__ ((format (printf, 5, 6)))
+    ;
 #else
 void report ();
 void report_build ();
@@ -407,6 +461,8 @@ void report_at_line ();
 
 /* driver.c -- main driver loop */
 void set_timeout(int);
+int isidletimeout(void);
+void resetidletimeout(void);
 int do_protocol(struct query *, const struct method *);
 
 /* transact.c: transaction support */
@@ -415,12 +471,17 @@ int readheaders(int sock,
                       long fetchlen,
                       long reallen,
                       struct query *ctl,
-               int num);
+                      int num,
+                      flag *suppress_readbody);
 int readbody(int sock, struct query *ctl, flag forward, int len);
 #if defined(HAVE_STDARG_H)
-void gen_send(int sock, const char *, ... );
+void gen_send(int sock, const char *, ... )
+    __attribute__ ((format (printf, 2, 3)))
+    ;
 int gen_recv(int sock, char *buf, int size);
-int gen_transact(int sock, const char *, ... );
+int gen_transact(int sock, const char *, ... )
+    __attribute__ ((format (printf, 2, 3)))
+    ;
 #else
 void gen_send();
 int gen_recv();
@@ -429,8 +490,10 @@ int gen_transact();
 extern struct msgblk msgblk;
 
 /* lock.c: concurrency locking */
-void lock_setup(void), lock_assert(void);
-void lock_or_die(void), lock_release(void);
+void lock_setup(void);
+void lock_assert(void);
+void lock_or_die(void);
+void fm_lock_release(void);
 int lock_state(void);
 void lock_dispose(void);
 
@@ -460,45 +523,54 @@ extern int mytimeout;
 
 /* idle.c */
 int interruptible_idle(int interval);
+extern volatile int lastsig;
 
 /* sink.c: forwarding */
 void smtp_close(struct query *, int);
 int smtp_open(struct query *);
+char *rcpt_address(struct query *, const char *, int);
 int stuffline(struct query *, char *);
 int open_sink(struct query*, struct msgblk *, int*, int*);
 void release_sink(struct query *);
 int close_sink(struct query *, struct msgblk *, flag);
 int open_warning_by_mail(struct query *, struct msgblk *);
 #if defined(HAVE_STDARG_H)
-void stuff_warning(struct query *, const char *, ... );
+void stuff_warning(const char *, struct query *, const char *, ... )
+    __attribute__ ((format (printf, 3, 4)))
+    ;
 #else
 void stuff_warning();
 #endif
 void close_warning_by_mail(struct query *, struct msgblk *);
 
 /* rfc822.c: RFC822 header parsing */
-unsigned char *reply_hack(unsigned char *, const unsigned char *);
+unsigned char *reply_hack(unsigned char *, const unsigned char *, size_t *);
 unsigned char *nxtaddr(const unsigned char *);
 
 /* uid.c: UID support */
+extern int dofastuidl;
+
 void initialize_saved_lists(struct query *, const char *);
 struct idlist *save_str(struct idlist **, const char *, flag);
 void free_str_list(struct idlist **);
 struct idlist *copy_str_list(struct idlist *idl);
 void save_str_pair(struct idlist **, const char *, const char *);
 void free_str_pair_list(struct idlist **);
-int delete_str(struct idlist **, int);
-int str_in_list(struct idlist **, const char *, const flag);
+int delete_str(struct idlist **, long);
+struct idlist *str_in_list(struct idlist **, const char *, const flag);
 int str_nr_in_list(struct idlist **, const char *);
 int str_nr_last_in_list(struct idlist **, const char *);
 void str_set_mark( struct idlist **, const char *, const flag);
 int count_list( struct idlist **idl );
-char *str_from_nr_list( struct idlist **idl, int number );
-char *str_find(struct idlist **, int);
+char *str_from_nr_list( struct idlist **idl, long number );
+char *str_find(struct idlist **, long);
+struct idlist *id_find(struct idlist **idl, long);
 char *idpair_find(struct idlist **, const char *);
 void append_str_list(struct idlist **, struct idlist **);
 void expunge_uids(struct query *);
 void uid_swap_lists(struct query *);
+void uid_discard_new_list(struct query *ctl);
+void uid_reset_num(struct query *ctl);
 void write_saved_lists(struct query *, const char *);
 
 /* rcfile_y.y */
@@ -530,14 +602,14 @@ int interface_approve(struct hostdata *, flag domonitor);
 #else
 #define XMALLOCTYPE char
 #endif
-XMALLOCTYPE *xmalloc(int);
-XMALLOCTYPE *xrealloc(XMALLOCTYPE *, int);
+XMALLOCTYPE *xmalloc(size_t);
+XMALLOCTYPE *xrealloc(/*@null@*/ XMALLOCTYPE *, size_t);
 char *xstrdup(const char *);
 #if defined(HAVE_ALLOCA_H)
 #include <alloca.h>
 #else
 #ifdef _AIX
- #pragma alloca
+#pragma alloca
 #endif
 #endif
 #define        xalloca(ptr, t, n)      if (!(ptr = (t) alloca(n)))\
@@ -560,15 +632,24 @@ int doODMR (struct query *);
 /* authentication functions */
 int do_cram_md5(int sock, char *command, struct query *ctl, char *strip);
 int do_rfc1731(int sock, char *command, char *truename);
-int do_gssauth(int sock, char *command, char *hostname, char *username);
+int do_gssauth(int sock, char *command, char *service, char *hostname, char *username);
 int do_otp(int sock, char *command, struct query *ctl);
 
 /* miscellanea */
+
+/* these should be of size PATH_MAX */
+extern char currentwd[1024], rcfiledir[1024];
+
 struct query *hostalloc(struct query *); 
 int parsecmdline (int, char **, struct runctl *, struct query *);
+char *prependdir (const char *, const char *);
 char *MD5Digest (unsigned char *);
+void hmac_md5 (unsigned char *, size_t, unsigned char *, size_t, unsigned char *, size_t);
 int POP3_auth_rpa(unsigned char *, unsigned char *, int socket);
+typedef RETSIGTYPE (*SIGHANDLERTYPE) (int);
 void deal_with_sigchld(void);
+RETSIGTYPE null_signal_handler(int sig);
+SIGHANDLERTYPE set_signal_handler(int sig, SIGHANDLERTYPE handler);
 int daemonize(const char *, void (*)(int));
 char *fm_getpassword(char *);
 void escapes(const char *, char *);
@@ -579,6 +660,7 @@ int is_host_alias(const char *, struct query *);
 char *host_fqdn(void);
 char *rfc822timestamp(void);
 flag isafile(int);
+char *rfc2047e(const char*, const char *);
 
 void yyerror(const char *);
 int yylex(void);
@@ -598,7 +680,7 @@ void itimerthread(void*);
 
 # if HAVE_STRERROR
 #  ifndef strerror             /* On some systems, strerror is a macro */
-char *strerror ();
+char *strerror (int);
 #  endif
 # endif /* HAVE_STRERROR */
 
@@ -611,6 +693,10 @@ char *strerror ();
 #endif
 #endif
 
+#ifndef HAVE_STPCPY
+char *stpcpy(char *, const char*);
+#endif
+
 #ifdef FETCHMAIL_DEBUG
 #define exit(e) do { \
        FILE *out; \
@@ -623,4 +709,27 @@ char *strerror ();
        } while(0)
 #endif /* FETCHMAIL_DEBUG */
 
+#ifdef __CYGWIN__
+#define ROOT_UID 18
+#else /* !__CYGWIN__ */
+#define ROOT_UID 0
+#endif /* __CYGWIN__ */
+
+extern int mailserver_socket_temp;
+extern char *program_name;
+
+/* POSIX space characters,
+ * <tab>;<newline>;<vertical-tab>;<form-feed>;<carriage-return>;<space> */
+#define POSIX_space "\t\n\v\f\r "
+
+/* strlcpy/strlcat prototypes */
+#ifndef HAVE_STRLCAT
+size_t
+strlcat(char *dst, const char *src, size_t siz);
+#endif
+#ifndef HAVE_STRLCPY
+size_t
+strlcpy(char *dst, const char *src, size_t siz);
+#endif
+
 /* fetchmail.h ends here */