Some improvements to the file-name cleaning code:
[rsync/rsync.git] / rsync.h
diff --git a/rsync.h b/rsync.h
index 16be3be..7f7e353 100644 (file)
--- a/rsync.h
+++ b/rsync.h
@@ -2,7 +2,7 @@
  * Copyright (C) 1996, 2000 Andrew Tridgell
  * Copyright (C) 1996 Paul Mackerras
  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
- * Copyright (C) 2003-2007 Wayne Davison
+ * Copyright (C) 2003-2008 Wayne Davison
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -32,6 +32,9 @@
 #define DEFAULT_LOCK_FILE "/var/run/rsyncd.lock"
 #define URL_PREFIX "rsync://"
 
+#define SYMLINK_PREFIX "/rsyncd-munged/"
+#define SYMLINK_PREFIX_LEN ((int)sizeof SYMLINK_PREFIX - 1)
+
 #define BACKUP_SUFFIX "~"
 
 /* a non-zero CHAR_OFFSET makes the rolling sum stronger, but is
@@ -50,7 +53,7 @@
 #define XMIT_LONG_NAME (1<<6)
 #define XMIT_SAME_TIME (1<<7)
 #define XMIT_SAME_RDEV_MAJOR (1<<8)    /* protocols 28 - now (devices only) */
-#define XMIT_NON_XFER_DIR (1<<8)       /* protocols 30 - now (dirs only) */
+#define XMIT_NO_CONTENT_DIR (1<<8)     /* protocols 30 - now (dirs only) */
 #define XMIT_HLINKED (1<<9)            /* protocols 28 - now */
 #define XMIT_SAME_DEV_pre30 (1<<10)    /* protocols 28 - 29  */
 #define XMIT_USER_NAME_FOLLOWS (1<<10) /* protocols 30 - now */
 #define FLAG_TOP_DIR (1<<0)    /* sender/receiver/generator */
 #define FLAG_FILE_SENT (1<<1)  /* sender/receiver/generator */
 #define FLAG_DIR_CREATED (1<<1)        /* generator */
-#define FLAG_XFER_DIR (1<<2)   /* sender/receiver/generator */
-#define FLAG_MOUNT_DIR (1<<3)  /* sender/generator */
+#define FLAG_CONTENT_DIR (1<<2)        /* sender/receiver/generator */
+#define FLAG_MOUNT_DIR (1<<3)  /* sender/generator (dirs only) */
+#define FLAG_SKIP_HLINK (1<<3) /* receiver/generator (w/FLAG_HLINKED) */
 #define FLAG_DUPLICATE (1<<4)  /* sender */
 #define FLAG_MISSING_DIR (1<<4)        /* generator */
-#define FLAG_HLINKED (1<<5)    /* receiver/generator */
-#define FLAG_HLINK_FIRST (1<<6)        /* receiver/generator */
+#define FLAG_HLINKED (1<<5)    /* receiver/generator (checked on all types) */
+#define FLAG_HLINK_FIRST (1<<6)        /* receiver/generator (w/FLAG_HLINKED) */
+#define FLAG_IMPLIED_DIR (1<<6)        /* sender/receiver/generator (dirs only) */
 #define FLAG_HLINK_LAST (1<<7) /* receiver/generator */
-#define FLAG_HLINK_DONE (1<<8) /* receiver/generator */
+#define FLAG_HLINK_DONE (1<<8) /* receiver/generator (checked on all types) */
 #define FLAG_LENGTH64 (1<<9)   /* sender/receiver/generator */
 #define FLAG_SKIP_GROUP (1<<10)        /* receiver/generator */
+#define FLAG_TIME_FAILED (1<<11)/* generator */
 
 /* These flags are passed to functions but not stored. */
 
@@ -89,7 +95,7 @@
 /* This is used when working on a new protocol version in CVS, and should
  * be a new non-zero value for each CVS change that affects the protocol.
  * It must ALWAYS be 0 when the protocol goes final! */
-#define SUBPROTOCOL_VERSION 8
+#define SUBPROTOCOL_VERSION 0
 
 /* We refuse to interoperate with versions that are not in this range.
  * Note that we assume we'll work with later versions: the onus is on
 #define CHUNK_SIZE (32*1024)
 #define MAX_MAP_SIZE (256*1024)
 #define IO_BUFFER_SIZE (4092)
-#define MAX_BLOCK_SIZE ((int32)1 << 29)
+#define MAX_BLOCK_SIZE ((int32)1 << 17)
 
 #define IOERR_GENERAL  (1<<0) /* For backward compatibility, this must == 1 */
 #define IOERR_VANISHED (1<<1)
 
 /* For use by the itemize_changes code */
 #define ITEM_REPORT_ATIME (1<<0)
-#define ITEM_REPORT_CHECKSUM (1<<1)
-#define ITEM_REPORT_SIZE (1<<2)
+#define ITEM_REPORT_CHANGE (1<<1)
+#define ITEM_REPORT_SIZE (1<<2)     /* regular files only */
+#define ITEM_REPORT_TIMEFAIL (1<<2) /* symlinks only */
 #define ITEM_REPORT_TIME (1<<3)
 #define ITEM_REPORT_PERMS (1<<4)
 #define ITEM_REPORT_OWNER (1<<5)
 #define SIGNIFICANT_ITEM_FLAGS (~(\
        ITEM_BASIS_TYPE_FOLLOWS | ITEM_XNAME_FOLLOWS | ITEM_LOCAL_CHANGE))
 
-
-/* Log-message categories.  Only FERROR and FINFO get sent over the socket,
- * but FLOG and FSOCKERR can be sent over the receiver -> generator pipe.
- * FLOG only goes to the log file, not the client; FCLIENT is the opposite. */
-enum logcode { FNONE=0, FERROR=1, FINFO=2, FLOG=3, FCLIENT=4, FSOCKERR=5 };
+#define CFN_KEEP_DOT_DIRS (1<<0)
+#define CFN_KEEP_TRAILING_SLASH (1<<1)
+#define CFN_DROP_TRAILING_DOT_DIR (1<<2)
+#define CFN_COLLAPSE_DOT_DOT_DIRS (1<<3)
+
+#define SP_DEFAULT 0
+#define SP_KEEP_DOT_DIRS (1<<0)
+
+/* Log-message categories.  FLOG only goes to the log file, not the client;
+ * FCLIENT is the opposite. */
+enum logcode {
+    FNONE=0, /* never sent */
+    FERROR_XFER=1, FINFO=2, /* sent over socket for any protocol */
+    FERROR=3, FWARNING=4, /* sent over socket for protocols >= 30 */
+    FERROR_SOCKET=5, FLOG=6, /* only sent via receiver -> generator pipe */
+    FCLIENT=7 /* never transmitted (e.g. server converts to FINFO) */
+};
 
 /* Messages types that are sent over the message channel.  The logcode
  * values must all be present here with identical numbers. */
 enum msgcode {
        MSG_DATA=0,     /* raw data on the multiplexed stream */
-       MSG_ERROR=FERROR, MSG_INFO=FINFO, /* remote logging */
-       MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, MSG_SOCKERR=FSOCKERR, /* sibling logging */
+       MSG_ERROR_XFER=FERROR_XFER, MSG_INFO=FINFO, /* remote logging */
+       MSG_ERROR=FERROR, MSG_WARNING=FWARNING, /* protocol-30 remote logging */
+       MSG_ERROR_SOCKET=FERROR_SOCKET, /* sibling logging */
+       MSG_LOG=FLOG, MSG_CLIENT=FCLIENT, /* sibling logging */
        MSG_REDO=9,     /* reprocess indicated flist index */
        MSG_FLIST=20,   /* extra file list over sibling socket */
        MSG_FLIST_EOF=21,/* we've transmitted all the file lists */
@@ -242,6 +263,9 @@ enum msgcode {
 #ifdef HAVE_INTTYPES_H
 # include <inttypes.h>
 #endif
+#ifdef HAVE_STDINT_H
+# include <stdint.h>
+#endif
 #ifdef HAVE_UNISTD_H
 # include <unistd.h>
 #endif
@@ -323,7 +347,9 @@ enum msgcode {
 #include <stdarg.h>
 #include <netinet/in.h>
 #include <arpa/inet.h>
+#ifdef HAVE_NETDB_H
 #include <netdb.h>
+#endif
 #include <syslog.h>
 #include <sys/file.h>
 
@@ -374,6 +400,9 @@ enum msgcode {
 #ifdef ICONV_CONST
 #undef ICONV_CONST
 #endif
+#ifdef ICONV_OPTION
+#undef ICONV_OPTION
+#endif
 #ifdef iconv_t
 #undef iconv_t
 #endif
@@ -384,6 +413,22 @@ enum msgcode {
 
 #include "lib/pool_alloc.h"
 
+#ifndef HAVE_ID_T
+typedef unsigned int id_t;
+#endif
+#ifndef HAVE_PID_T
+typedef int pid_t;
+#endif
+#ifndef HAVE_MODE_T
+typedef unsigned int mode_t;
+#endif
+#ifndef HAVE_OFF_T
+typedef long off_t;
+#endif
+#ifndef HAVE_SIZE_T
+typedef unsigned int size_t;
+#endif
+
 #define BOOL int
 
 #ifndef uchar
@@ -501,6 +546,7 @@ struct hashtable {
        void *nodes;
        int32 size, entries;
        uint32 node_size;
+       int key64;
 };
 
 struct ht_int32_node {
@@ -584,7 +630,7 @@ extern int xattrs_ndx;
 
 #define FILE_STRUCT_LEN (offsetof(struct file_struct, basename))
 #define EXTRA_LEN (sizeof (union file_extras))
-#define PTR_EXTRA_LEN ((sizeof (char *) + EXTRA_LEN - 1) / EXTRA_LEN)
+#define PTR_EXTRA_CNT ((sizeof (char *) + EXTRA_LEN - 1) / EXTRA_LEN)
 #define DEV_EXTRA_CNT 2
 #define DIRNODE_EXTRA_CNT 3
 #define SUM_EXTRA_CNT ((MAX_DIGEST_LEN + EXTRA_LEN - 1) / EXTRA_LEN)
@@ -608,7 +654,7 @@ extern int xattrs_ndx;
 #define F_SYMLINK(f) ((f)->basename + strlen((f)->basename) + 1)
 
 /* The sending side always has this available: */
-#define F_PATHNAME(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_LEN))
+#define F_PATHNAME(f) (*(const char**)REQ_EXTRA(f, PTR_EXTRA_CNT))
 
 /* The receiving side always has this available: */
 #define F_DEPTH(f) REQ_EXTRA(f, 1)->num
@@ -618,20 +664,22 @@ extern int xattrs_ndx;
 #define F_GROUP(f) REQ_EXTRA(f, gid_ndx)->unum
 #define F_ACL(f) REQ_EXTRA(f, acls_ndx)->num
 #define F_XATTR(f) REQ_EXTRA(f, xattrs_ndx)->num
-#define F_NDX(f) REQ_EXTRA(f, ic_ndx)->num
+#define F_NDX(f) REQ_EXTRA(f, unsort_ndx)->num
 
 /* These items are per-entry optional: */
 #define F_HL_GNUM(f) OPT_EXTRA(f, LEN64_BUMP(f))->num /* non-dirs */
 #define F_HL_PREV(f) OPT_EXTRA(f, LEN64_BUMP(f)+inc_recurse)->num /* non-dirs */
 #define F_DIR_NODE_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) \
                                + DIRNODE_EXTRA_CNT - 1)->num) /* sender dirs */
+#define F_DIR_RELNAMES_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + DIRNODE_EXTRA_CNT \
+                               + PTR_EXTRA_CNT - 1)->num) /* sender dirs */
 #define F_DIR_DEFACL(f) OPT_EXTRA(f, LEN64_BUMP(f))->unum /* receiver dirs */
 #define F_DIR_DEV_P(f) (&OPT_EXTRA(f, LEN64_BUMP(f) + ACL_BUMP(f) \
                                + DEV_EXTRA_CNT - 1)->unum) /* receiver dirs */
 
 /* This optional item might follow an F_HL_*() item.
  * (Note: a device doesn't need to check LEN64_BUMP(f).) */
-#define F_RDEV_P(f) (&OPT_EXTRA(f, HLINK_BUMP(f) + 2 - 1)->unum)
+#define F_RDEV_P(f) (&OPT_EXTRA(f, HLINK_BUMP(f) + DEV_EXTRA_CNT - 1)->unum)
 
 /* The sum is only present on regular files. */
 #define F_SUM(f) ((char*)OPT_EXTRA(f, LEN64_BUMP(f) + HLINK_BUMP(f) \
@@ -644,9 +692,11 @@ extern int xattrs_ndx;
 #define F_HLINK_NOT_FIRST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_FIRST)
 #define F_HLINK_NOT_LAST(f) BITS_SETnUNSET((f)->flags, FLAG_HLINKED, FLAG_HLINK_LAST)
 
+/* These access the F_DIR_DEV_P() and F_RDEV_P() values: */
 #define DEV_MAJOR(a) (a)[0]
 #define DEV_MINOR(a) (a)[1]
 
+/* These access the F_DIRS_NODE_P() values: */
 #define DIR_PARENT(a) (a)[0]
 #define DIR_FIRST_CHILD(a) (a)[1]
 #define DIR_NEXT_SIBLING(a) (a)[2]
@@ -680,7 +730,7 @@ struct file_list {
        int used, malloced;
        int low, high;  /* 0-relative index values excluding empties */
        int ndx_start;  /* the start offset for inc_recurse mode */
-       int ndx_end;    /* the end offset for inc_recurse mode */
+       int flist_num;  /* 1-relative file_list number or 0 */
        int parent_ndx; /* dir_flist index of parent directory */
        int in_progress, to_redo;
 };
@@ -771,7 +821,6 @@ struct stats {
        int64 flist_size;
        int num_files;
        int num_transferred_files;
-       int current_file_index;
 };
 
 struct chmod_mode_struct;
@@ -809,6 +858,11 @@ typedef struct {
 #define RL_DUMP_COMMENTS (1<<1)
 #define RL_CONVERT (1<<2)
 
+typedef struct {
+       char name_type;
+       char fname[1]; /* has variable size */
+} relnamecache;
+
 #include "byteorder.h"
 #include "lib/mdigest.h"
 #include "lib/wildmatch.h"
@@ -837,7 +891,7 @@ typedef struct {
 #ifdef SUPPORT_XATTRS
     item_list *xattr;
 #endif
-} statx;
+} stat_x;
 
 #define ACL_READY(sx) ((sx).acc_acl != NULL)
 #define XATTR_READY(sx) ((sx).xattr != NULL)
@@ -1056,6 +1110,11 @@ size_t strlcat(char *d, const char *s, size_t bufsize);
 #define MY_GID() getgid()
 #endif
 
+#ifdef FORCE_FD_ZERO_MEMSET
+#undef FD_ZERO
+#define FD_ZERO(fdsetp) memset(fdsetp, 0, sizeof (fd_set))
+#endif
+
 extern int verbose;
 
 #ifndef HAVE_INET_NTOP