My verison of Wesley W. Terpstra's --fake-super patch.
[rsync/rsync-patches.git] / xattrs.diff
CommitLineData
bbdff76a
WD
1Depends-On-Patch: acls.diff
2
3After applying this patch, run these commands for a successful build:
4
27e96866 5 ./prepare-source
f787c90c 6 ./configure --enable-acl-support --enable-xattr-support
bbdff76a
WD
7 make
8
0f6fb3c8
WD
9TODO:
10
11 - This patch needs to be rewritten to more efficiently handle large xattrs.
12
a74926e4
WD
13 - Extraneous xattr values need to be removed from files that are not being
14 recreated.
15
0f6fb3c8
WD
16 - We need to affect the itemized output to know when xattrs are being updated.
17
18 - We need to affect the --link-dest option to avoid hard-linking two files
19 that differ in their xattrs (when --xattrs was specified).
20
9a7eef96
WD
21--- old/Makefile.in
22+++ new/Makefile.in
1ed0b5c9 23@@ -28,13 +28,13 @@ VERSION=@VERSION@
bbdff76a
WD
24
25 HEADERS=byteorder.h config.h errcode.h proto.h rsync.h smb_acls.h lib/pool_alloc.h
26 LIBOBJ=lib/wildmatch.o lib/compat.o lib/snprintf.o lib/mdfour.o \
27- lib/permstring.o lib/pool_alloc.o lib/sysacls.o @LIBOBJS@
28+ lib/permstring.o lib/pool_alloc.o lib/sysacls.o lib/sysxattr.o @LIBOBJS@
4bf6f8c7
WD
29 ZLIBOBJ=zlib/deflate.o zlib/inffast.o zlib/inflate.o zlib/inftrees.o \
30 zlib/trees.o zlib/zutil.o zlib/adler32.o zlib/compress.o zlib/crc32.o
bbdff76a
WD
31 OBJS1=rsync.o generator.o receiver.o cleanup.o sender.o exclude.o util.o \
32 main.o checksum.o match.o syscall.o log.o backup.o
33 OBJS2=options.o flist.o io.o compat.o hlink.o token.o uidlist.o socket.o \
610969d1
WD
34- fileio.o batch.o clientname.o chmod.o acls.o
35+ fileio.o batch.o clientname.o chmod.o acls.o xattr.o
bbdff76a
WD
36 OBJS3=progress.o pipe.o
37 DAEMON_OBJ = params.o loadparm.o clientserver.o access.o connection.o authenticate.o
38 popt_OBJS=popt/findme.o popt/popt.o popt/poptconfig.o \
0f6fb3c8
WD
39--- old/acls.c
40+++ new/acls.c
41@@ -29,6 +29,7 @@ extern int am_root;
42 extern int dry_run;
43 extern int orig_umask;
44 extern int preserve_acls;
45+extern int preserve_xattrs;
46 extern unsigned int file_struct_len;
47
48 /* === ACL structures === */
4959107f 49@@ -740,6 +741,10 @@ void receive_acl(struct file_struct *fil
0f6fb3c8
WD
50 type = SMB_ACL_TYPE_ACCESS;
51 racl_list = &access_acl_list;
52 ndx_ptr = (char*)file + file_struct_len;
53+#ifdef SUPPORT_XATTRS
54+ if (preserve_xattrs)
55+ ndx_ptr += 4;
56+#endif
57 do {
58 char tag = read_byte(f);
59 int ndx;
4959107f 60@@ -799,6 +804,10 @@ void cache_acl(struct file_struct *file,
0f6fb3c8
WD
61 racl = sxp->acc_acl;
62 racl_list = &access_acl_list;
63 ndx_ptr = (char*)file + file_struct_len;
64+#ifdef SUPPORT_XATTRS
65+ if (preserve_xattrs)
66+ ndx_ptr += 4;
67+#endif
68 do {
69 if (!racl)
70 ndx = -1;
4959107f 71@@ -914,6 +923,10 @@ int set_acl(const char *fname, const str
0f6fb3c8
WD
72
73 type = SMB_ACL_TYPE_ACCESS;
74 ndx_ptr = (char*)file + file_struct_len;
75+#ifdef SUPPORT_XATTRS
76+ if (preserve_xattrs)
77+ ndx_ptr += 4;
78+#endif
79 do {
80 acl_duo *duo_item;
81 BOOL eq;
9a7eef96
WD
82--- old/backup.c
83+++ new/backup.c
dc52bc1a 84@@ -30,6 +30,7 @@ extern char *backup_dir;
93d6ca6d
WD
85
86 extern int am_root;
87 extern int preserve_acls;
88+extern int preserve_xattrs;
89 extern int preserve_devices;
90 extern int preserve_specials;
91 extern int preserve_links;
0f6fb3c8
WD
92@@ -136,6 +137,9 @@ static int make_bak_dir(char *fullpath)
93 #ifdef SUPPORT_ACLS
94 sx.acc_acl = sx.def_acl = NULL;
95 #endif
96+#ifdef SUPPORT_XATTRS
97+ sx.xattr = NULL;
98+#endif
99 if (!(file = make_file(rel, NULL, NULL, 0, NO_FILTERS)))
100 continue;
101 #ifdef SUPPORT_ACLS
102@@ -144,6 +148,12 @@ static int make_bak_dir(char *fullpath)
103 cache_acl(file, &sx);
104 }
09cc6650
WD
105 #endif
106+#ifdef SUPPORT_XATTRS
0f6fb3c8
WD
107+ if (preserve_xattrs) {
108+ get_xattr(rel, &sx);
109+ cache_xattr(file, &sx);
110+ }
09cc6650 111+#endif
0f6fb3c8
WD
112 set_file_attrs(fullpath, file, NULL, 0);
113 free(file);
bbdff76a 114 }
0f6fb3c8
WD
115@@ -195,6 +205,9 @@ static int keep_backup(char *fname)
116 #ifdef SUPPORT_ACLS
117 sx.acc_acl = sx.def_acl = NULL;
09cc6650
WD
118 #endif
119+#ifdef SUPPORT_XATTRS
0f6fb3c8 120+ sx.xattr = NULL;
09cc6650 121+#endif
bbdff76a 122
0f6fb3c8
WD
123 if (!(file = make_file(fname, NULL, NULL, 0, NO_FILTERS)))
124 return 1; /* the file could have disappeared */
125@@ -208,6 +221,12 @@ static int keep_backup(char *fname)
126 cache_acl(file, &sx);
127 }
09cc6650
WD
128 #endif
129+#ifdef SUPPORT_XATTRS
0f6fb3c8
WD
130+ if (preserve_xattrs) {
131+ get_xattr(fname, &sx);
132+ cache_xattr(file, &sx);
133+ }
09cc6650 134+#endif
bbdff76a 135
0f6fb3c8
WD
136 /* Check to see if this is a device file, or link */
137 if ((am_root && preserve_devices && IS_DEVICE(file->mode))
9a7eef96
WD
138--- old/configure.in
139+++ new/configure.in
49de5440 140@@ -856,6 +856,35 @@ samba_cv_HAVE_ACL_GET_PERM_NP=yes,samba_
bbdff76a
WD
141 AC_MSG_RESULT(no)
142 )
143
144+AC_CHECK_HEADERS(attr/xattr.h)
49de5440 145+AC_CHECK_HEADERS(sys/xattr.h)
bbdff76a 146+AC_MSG_CHECKING(whether to support extended attributes)
f787c90c
WD
147+AC_ARG_ENABLE(xattr-support,
148+AC_HELP_STRING([--enable-xattr-support], [Include extended attribute support (default=no)]),
3b05e91f 149+[ case "$enableval" in
bbdff76a
WD
150+ yes)
151+ case "$host_os" in
152+ *linux*)
153+ AC_MSG_RESULT(Using Linux xattrs)
154+ AC_DEFINE(HAVE_LINUX_XATTRS, 1, [True if you have Linux xattrs])
155+ ;;
49de5440
WD
156+ darwin*)
157+ AC_MSG_RESULT(Using OS X xattrs)
158+ AC_DEFINE(HAVE_OSX_XATTRS, 1, [True if you have Mac OS X xattrs])
159+ ;;
bbdff76a 160+ *)
49de5440 161+ AC_MSG_RESULT(Xattrs requested but not Linux or OS X. Good luck...)
bbdff76a
WD
162+ ;;
163+ esac
164+ ;;
165+ *)
166+ AC_MSG_RESULT(no)
167+ AC_DEFINE(HAVE_NA_XATTRS, 1, [True if you don't have extended attributes])
168+ esac ],
169+ AC_MSG_RESULT(no)
170+ AC_DEFINE(HAVE_NO_XATTRL, 1, [True if you don't have extended attributes])
171+)
172+
173 AC_CONFIG_FILES([Makefile lib/dummy zlib/dummy popt/dummy shconfig])
174 AC_OUTPUT
175
9a7eef96
WD
176--- old/flist.c
177+++ new/flist.c
dc52bc1a 178@@ -41,6 +41,7 @@ extern int one_file_system;
93d6ca6d
WD
179 extern int copy_dirlinks;
180 extern int keep_dirlinks;
181 extern int preserve_acls;
182+extern int preserve_xattrs;
183 extern int preserve_links;
184 extern int preserve_hard_links;
185 extern int preserve_devices;
de565f59 186@@ -498,7 +499,7 @@ static struct file_struct *receive_file_
0f6fb3c8
WD
187 char thisname[MAXPATHLEN];
188 unsigned int l1 = 0, l2 = 0;
189 int alloc_len, basename_len, dirname_len, linkname_len, sum_len;
190-#ifdef SUPPORT_ACLS
191+#if defined SUPPORT_ACLS || defined SUPPORT_XATTRS
192 int xtra_len;
193 #endif
194 OFF_T file_length;
de565f59 195@@ -610,10 +611,16 @@ static struct file_struct *receive_file_
0f6fb3c8
WD
196 xtra_len = (S_ISDIR(mode) ? 2 : 1) * 4;
197 else
198 xtra_len = 0;
199+#elif defined SUPPORT_XATTRS
200+ xtra_len = 0;
201+#endif
202+#ifdef SUPPORT_XATTRS
203+ if (preserve_xattrs)
204+ xtra_len += 4;
205 #endif
206
207 alloc_len = file_struct_len + dirname_len + basename_len
208-#ifdef SUPPORT_ACLS
209+#if defined SUPPORT_ACLS || defined SUPPORT_XATTRS
210 + xtra_len
211 #endif
212 + linkname_len + sum_len;
de565f59 213@@ -622,7 +629,7 @@ static struct file_struct *receive_file_
0f6fb3c8
WD
214 file = (struct file_struct *)bp;
215 memset(bp, 0, file_struct_len);
216 bp += file_struct_len;
217-#ifdef SUPPORT_ACLS
218+#if defined SUPPORT_ACLS || defined SUPPORT_XATTRS
219 bp += xtra_len;
220 #endif
221
de565f59 222@@ -723,6 +730,10 @@ static struct file_struct *receive_file_
0f6fb3c8
WD
223 if (preserve_acls)
224 receive_acl(file, f);
225 #endif
226+#ifdef SUPPORT_XATTRS
227+ if (preserve_xattrs)
228+ receive_xattr(file, f );
229+#endif
230
231 return file;
232 }
a071aea2
WD
233@@ -974,7 +985,7 @@ static struct file_struct *send_file_nam
234 unsigned short flags)
235 {
236 struct file_struct *file;
237-#ifdef SUPPORT_ACLS
238+#if defined SUPPORT_ACLS || defined SUPPORT_XATTRS
239 statx sx;
240 #endif
241
de565f59 242@@ -994,6 +1005,13 @@ static struct file_struct *send_file_nam
0f6fb3c8
WD
243 return NULL;
244 }
09cc6650
WD
245 #endif
246+#ifdef SUPPORT_XATTRS
0f6fb3c8
WD
247+ if (preserve_xattrs) {
248+ sx.xattr = NULL;
249+ if (get_xattr(fname, &sx) < 0)
250+ return NULL;
251+ }
09cc6650 252+#endif
bbdff76a 253
a2f9a486
WD
254 maybe_emit_filelist_progress(flist->count + flist_count_offset);
255
de565f59 256@@ -1006,11 +1024,19 @@ static struct file_struct *send_file_nam
93d6ca6d 257 if (preserve_acls)
0f6fb3c8 258 send_acl(&sx, f);
93d6ca6d 259 #endif
09cc6650 260+#ifdef SUPPORT_XATTRS
93d6ca6d 261+ if (preserve_xattrs)
0f6fb3c8 262+ send_xattr(&sx, f);
09cc6650 263+#endif
bbdff76a 264 } else {
93d6ca6d 265 #ifdef SUPPORT_ACLS
93d6ca6d 266 if (preserve_acls)
0f6fb3c8 267 free_acl(&sx);
09cc6650
WD
268 #endif
269+#ifdef SUPPORT_XATTRS
93d6ca6d 270+ if (preserve_xattrs)
0f6fb3c8 271+ free_xattr(&sx);
09cc6650 272+#endif
bbdff76a
WD
273 }
274 return file;
275 }
9a7eef96
WD
276--- old/lib/sysxattr.c
277+++ new/lib/sysxattr.c
a74926e4 278@@ -0,0 +1,71 @@
dc52bc1a
WD
279+/*
280+ * Extended attribute support for rsync.
281+ *
282+ * Copyright (C) 2004 Red Hat, Inc.
283+ * Written by Jay Fenlason.
284+ *
285+ * This program is free software; you can redistribute it and/or modify
286+ * it under the terms of the GNU General Public License as published by
287+ * the Free Software Foundation; either version 2 of the License, or
288+ * (at your option) any later version.
289+ *
290+ * This program is distributed in the hope that it will be useful,
291+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
292+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
293+ * GNU General Public License for more details.
294+ *
295+ * You should have received a copy of the GNU General Public License along
296+ * with this program; if not, write to the Free Software Foundation, Inc.,
297+ * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
298+ */
bbdff76a
WD
299+
300+#include "rsync.h"
0f6fb3c8 301+#include "sysxattr.h"
bbdff76a 302+
09cc6650 303+#if defined HAVE_LINUX_XATTRS
bbdff76a
WD
304+
305+ssize_t sys_lgetxattr(const char *path, const char *name, void *value, size_t size)
306+{
307+ return lgetxattr(path, name, value, size);
308+}
309+
310+int sys_lsetxattr(const char *path, const char *name, const void *value, size_t size, int flags)
311+{
312+ return lsetxattr(path, name, value, size, flags);
313+}
314+
a74926e4
WD
315+int sys_lremovexattr(const char *path, const char *name)
316+{
317+ return lremovexattr(path, name);
318+}
319+
bbdff76a
WD
320+ssize_t sys_llistxattr(const char *path, char *list, size_t size)
321+{
322+ return llistxattr(path, list, size);
323+}
324+
49de5440
WD
325+#elif HAVE_OSX_XATTRS
326+
327+ssize_t sys_lgetxattr(const char *path, const char *name, void *value, size_t size)
328+{
329+ return getxattr(path, name, value, size, 0, XATTR_NOFOLLOW);
330+}
331+
332+int sys_lsetxattr(const char *path, const char *name, const void *value, size_t size, int flags)
333+{
334+ return setxattr(path, name, value, size, 0, XATTR_NOFOLLOW | flags);
335+}
336+
a74926e4
WD
337+int sys_lremovexattr(const char *path, const char *name)
338+{
339+ return removexattr(path, name, XATTR_NOFOLLOW);
340+}
341+
49de5440
WD
342+ssize_t sys_llistxattr(const char *path, char *list, size_t size)
343+{
344+ return listxattr(path, list, size, XATTR_NOFOLLOW);
345+}
346+
bbdff76a
WD
347+#else
348+
349+#endif /* No xattrs */
9a7eef96
WD
350--- old/lib/sysxattr.h
351+++ new/lib/sysxattr.h
a74926e4 352@@ -0,0 +1,25 @@
49de5440
WD
353+#ifdef SUPPORT_XATTRS
354+#if defined HAVE_ATTR_XATTR_H
0f6fb3c8 355+#include <attr/xattr.h>
49de5440
WD
356+#elif defined HAVE_SYS_XATTR_H
357+#include <sys/xattr.h>
358+#endif
0f6fb3c8
WD
359+#endif
360+
49de5440 361+#if defined HAVE_LINUX_XATTRS || defined HAVE_OSX_XATTRS
bbdff76a 362+
a74926e4
WD
363+/* Linux 2.4 does not define this as a distinct errno value: */
364+#ifndef ENOATTR
365+#define ENOATTR ENODATA
366+#endif
367+
bbdff76a
WD
368+ssize_t sys_lgetxattr(const char *path, const char *name, void *value, size_t size);
369+int sys_lsetxattr(const char *path, const char *name, const void *value, size_t size, int flags);
a74926e4 370+int sys_lremovexattr(const char *path, const char *name);
bbdff76a
WD
371+ssize_t sys_llistxattr(const char *path, char *list, size_t size);
372+
373+#else
374+
49de5440
WD
375+/* No xattrs */
376+
377+#endif
9a7eef96
WD
378--- old/options.c
379+++ new/options.c
dc52bc1a 380@@ -48,6 +48,7 @@ int copy_links = 0;
bbdff76a
WD
381 int preserve_links = 0;
382 int preserve_hard_links = 0;
383 int preserve_acls = 0;
384+int preserve_xattrs = 0;
385 int preserve_perms = 0;
4a65fe72 386 int preserve_executability = 0;
bbdff76a 387 int preserve_devices = 0;
4959107f 388@@ -201,6 +202,7 @@ static void print_rsync_version(enum log
bbdff76a
WD
389 char const *have_inplace = "no ";
390 char const *hardlinks = "no ";
391 char const *acls = "no ";
392+ char const *xattrs = "no ";
393 char const *links = "no ";
394 char const *ipv6 = "no ";
395 STRUCT_STAT *dumstat;
4959107f 396@@ -220,7 +222,9 @@ static void print_rsync_version(enum log
bbdff76a
WD
397 #ifdef SUPPORT_ACLS
398 acls = "";
399 #endif
400-
401+#ifdef SUPPORT_XATTRS
402+ xattrs = "";
403+#endif
404 #ifdef SUPPORT_LINKS
405 links = "";
406 #endif
4959107f 407@@ -234,9 +238,9 @@ static void print_rsync_version(enum log
3b05e91f 408 rprintf(f, "Copyright (C) 1996-2006 by Andrew Tridgell, Wayne Davison, and others.\n");
bbdff76a
WD
409 rprintf(f, "<http://rsync.samba.org/>\n");
410 rprintf(f, "Capabilities: %d-bit files, %ssocketpairs, "
bc5988ec
WD
411- "%shard links, %sACLs, %ssymlinks, batchfiles,\n",
412+ "%shard links, %sACLs, %sxattrs, %ssymlinks, batchfiles,\n",
bbdff76a
WD
413 (int) (sizeof (OFF_T) * 8),
414- got_socketpair, hardlinks, acls, links);
415+ got_socketpair, hardlinks, acls, xattrs, links);
416
417 /* Note that this field may not have type ino_t. It depends
418 * on the complicated interaction between largefile feature
4959107f 419@@ -290,7 +294,7 @@ void usage(enum logcode F)
1b57ecb0 420 rprintf(F," -q, --quiet suppress non-error messages\n");
4959107f 421 rprintf(F," --no-motd suppress daemon-mode MOTD (see manpage caveat)\n");
1b57ecb0
WD
422 rprintf(F," -c, --checksum skip based on checksum, not mod-time & size\n");
423- rprintf(F," -a, --archive archive mode; same as -rlptgoD (no -H, -A)\n");
424+ rprintf(F," -a, --archive archive mode; equals -rlptgoD (no -H,-A,-X)\n");
425 rprintf(F," --no-OPTION turn off an implied OPTION (e.g. --no-D)\n");
426 rprintf(F," -r, --recursive recurse into directories\n");
427 rprintf(F," -R, --relative use relative path names\n");
4959107f 428@@ -315,6 +319,9 @@ void usage(enum logcode F)
3610c43c 429 #ifdef SUPPORT_ACLS
bbdff76a 430 rprintf(F," -A, --acls preserve ACLs (implies --perms)\n");
3610c43c
WD
431 #endif
432+#ifdef SUPPORT_XATTRS
bbdff76a 433+ rprintf(F," -X, --xattrs preserve extended attributes (implies --perms)\n");
3610c43c 434+#endif
4a65fe72 435 rprintf(F," -o, --owner preserve owner (super-user only)\n");
bbdff76a 436 rprintf(F," -g, --group preserve group\n");
1ed0b5c9 437 rprintf(F," --devices preserve device files (super-user only)\n");
4959107f 438@@ -437,6 +444,9 @@ static struct poptOption long_options[]
489b0a72
WD
439 {"acls", 'A', POPT_ARG_NONE, 0, 'A', 0, 0 },
440 {"no-acls", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
441 {"no-A", 0, POPT_ARG_VAL, &preserve_acls, 0, 0, 0 },
442+ {"xattrs", 'X', POPT_ARG_NONE, 0, 'X', 0, 0 },
443+ {"no-xattrs", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
444+ {"no-X", 0, POPT_ARG_VAL, &preserve_xattrs, 0, 0, 0 },
445 {"times", 't', POPT_ARG_VAL, &preserve_times, 1, 0, 0 },
446 {"no-times", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
447 {"no-t", 0, POPT_ARG_VAL, &preserve_times, 0, 0, 0 },
4959107f 448@@ -1118,6 +1128,17 @@ int parse_arguments(int *argc, const cha
489b0a72 449 return 0;
3610c43c 450 #endif
bbdff76a
WD
451
452+ case 'X':
453+#ifdef SUPPORT_XATTRS
454+ preserve_xattrs = 1;
455+ preserve_perms = 1;
489b0a72 456+ break;
bbdff76a
WD
457+#else
458+ snprintf(err_buf,sizeof(err_buf),
459+ "extended attributes are not supported on this %s\n",
460+ am_server ? "server" : "client");
461+ return 0;
462+#endif /* SUPPORT_XATTRS */
bbdff76a
WD
463
464 default:
465 /* A large opt value means that set_refuse_options()
4959107f 466@@ -1564,6 +1585,10 @@ void server_options(char **args,int *arg
bbdff76a
WD
467 if (preserve_acls)
468 argstr[x++] = 'A';
3610c43c
WD
469 #endif
470+#ifdef SUPPORT_XATTRS
bbdff76a
WD
471+ if (preserve_xattrs)
472+ argstr[x++] = 'X';
3610c43c 473+#endif
bbdff76a
WD
474 if (preserve_uid)
475 argstr[x++] = 'o';
476 if (preserve_gid)
9a7eef96
WD
477--- old/rsync.c
478+++ new/rsync.c
ff318e90
WD
479@@ -33,6 +33,7 @@
480 extern int verbose;
93d6ca6d 481 extern int dry_run;
93d6ca6d
WD
482 extern int preserve_acls;
483+extern int preserve_xattrs;
484 extern int preserve_perms;
485 extern int preserve_executability;
486 extern int preserve_times;
071c5b19
WD
487@@ -219,6 +220,10 @@ int set_file_attrs(char *fname, struct f
488 if (daemon_chmod_modes && !S_ISLNK(new_mode))
489 new_mode = tweak_mode(new_mode, daemon_chmod_modes);
490
09cc6650 491+#ifdef SUPPORT_XATTRS
0f6fb3c8 492+ if (preserve_xattrs && set_xattr(fname, file, sxp) == 0)
09cc6650
WD
493+ updated = 1;
494+#endif
071c5b19
WD
495 #ifdef SUPPORT_ACLS
496 /* It's OK to call set_acl() now, even for a dir, as the generator
497 * will enable owner-writability using chmod, if necessary.
9a7eef96
WD
498--- old/rsync.h
499+++ new/rsync.h
1ed0b5c9 500@@ -501,6 +501,10 @@ struct idev {
0f6fb3c8 501 #define ACLS_NEED_MASK 1
09cc6650 502 #endif
bbdff76a 503
49de5440 504+#if defined HAVE_LINUX_XATTRS || defined HAVE_OSX_XATTRS
bbdff76a
WD
505+#define SUPPORT_XATTRS 1
506+#endif
507+
0f6fb3c8
WD
508 #define GID_NONE ((gid_t)-1)
509
510 #define HL_CHECK_MASTER 0
de565f59 511@@ -695,6 +699,9 @@ typedef struct {
0f6fb3c8
WD
512 struct rsync_acl *acc_acl; /* access ACL */
513 struct rsync_acl *def_acl; /* default ACL */
514 #endif
515+#ifdef SUPPORT_XATTRS
516+ item_list *xattr;
bbdff76a 517+#endif
0f6fb3c8 518 } statx;
bbdff76a 519
0f6fb3c8 520 #define ACL_READY(sx) ((sx).acc_acl != NULL)
9a7eef96
WD
521--- old/rsync.yo
522+++ new/rsync.yo
4959107f 523@@ -301,7 +301,7 @@ to the detailed description below for a
1b57ecb0 524 -q, --quiet suppress non-error messages
4959107f 525 --no-motd suppress daemon-mode MOTD (see caveat)
1b57ecb0
WD
526 -c, --checksum skip based on checksum, not mod-time & size
527- -a, --archive archive mode; same as -rlptgoD (no -H, -A)
528+ -a, --archive archive mode; equals -rlptgoD (no -H,-A,-X)
529 --no-OPTION turn off an implied OPTION (e.g. --no-D)
530 -r, --recursive recurse into directories
531 -R, --relative use relative path names
4959107f 532@@ -324,6 +324,7 @@ to the detailed description below for a
4a65fe72 533 -E, --executability preserve executability
063cf77b 534 --chmod=CHMOD affect file and/or directory permissions
4a65fe72
WD
535 -A, --acls preserve ACLs (implies -p) [non-standard]
536+ -X, --xattrs preserve extended attrs (implies -p) [n.s.]
4a65fe72 537 -o, --owner preserve owner (super-user only)
bbdff76a 538 -g, --group preserve group
1ed0b5c9 539 --devices preserve device files (super-user only)
4959107f 540@@ -818,6 +819,11 @@ version makes it incompatible with sendi
3fcc541f
WD
541 rsync unless you double the bf(--acls) option (e.g. bf(-AA)). This
542 doubling is not needed when pulling files from an older rsync.
bbdff76a
WD
543
544+dit(bf(-X, --xattrs)) This option causes rsync to update the remote
545+extended attributes to be the same as the local ones. This will work
546+only if the remote machine's rsync supports this option also. This is
547+a non-standard option.
548+
4a65fe72
WD
549 dit(bf(--chmod)) This option tells rsync to apply one or more
550 comma-separated "chmod" strings to the permission of the files in the
551 transfer. The resulting value is treated as though it was the permissions
9a7eef96
WD
552--- old/xattr.c
553+++ new/xattr.c
bb6b64ea 554@@ -0,0 +1,368 @@
dc52bc1a
WD
555+/*
556+ * Extended Attribute support for rsync.
0f6fb3c8 557+ * Written by Jay Fenlason, vaguely based on the ACLs patch.
dc52bc1a
WD
558+ *
559+ * Copyright (C) 2004 Red Hat, Inc.
0f6fb3c8 560+ * Copyright (C) 2006 Wayne Davison
dc52bc1a
WD
561+ *
562+ * This program is free software; you can redistribute it and/or modify
563+ * it under the terms of the GNU General Public License as published by
564+ * the Free Software Foundation; either version 2 of the License, or
565+ * (at your option) any later version.
566+ *
567+ * This program is distributed in the hope that it will be useful,
568+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
569+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
570+ * GNU General Public License for more details.
571+ *
572+ * You should have received a copy of the GNU General Public License along
573+ * with this program; if not, write to the Free Software Foundation, Inc.,
574+ * 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
575+ */
bbdff76a
WD
576+
577+#include "rsync.h"
578+#include "lib/sysxattr.h"
579+
580+#ifdef SUPPORT_XATTRS
581+
bbdff76a 582+extern int dry_run;
0f6fb3c8 583+extern unsigned int file_struct_len;
bbdff76a
WD
584+
585+#define RSYNC_XAL_INITIAL 5
586+#define RSYNC_XAL_LIST_INITIAL 100
587+
588+typedef struct {
bbdff76a 589+ char *name;
bbdff76a 590+ char *datum;
0f6fb3c8
WD
591+ size_t name_len;
592+ size_t datum_len;
bbdff76a
WD
593+} rsync_xa;
594+
bbdff76a
WD
595+static size_t namebuf_len = 0;
596+static char *namebuf = NULL;
597+
0f6fb3c8
WD
598+static item_list empty_xattr = EMPTY_ITEM_LIST;
599+static item_list rsync_xal_l = EMPTY_ITEM_LIST;
bbdff76a 600+
517cc92f
WD
601+#ifdef HAVE_OSX_XATTRS
602+static char unique_prefix[] = "user.0S%."; /* OSX */
603+static int upre_len = sizeof unique_prefix - 1;
604+#endif
605+
bbdff76a
WD
606+/* ------------------------------------------------------------------------- */
607+
0f6fb3c8 608+static void rsync_xal_free(item_list *xalp)
bbdff76a
WD
609+{
610+ size_t i;
0f6fb3c8 611+ rsync_xa *rxas = xalp->items;
bbdff76a 612+
0f6fb3c8
WD
613+ for (i = 0; i < xalp->count; i++) {
614+ free(rxas[i].name);
615+ /* free(rxas[i].value); */
bbdff76a 616+ }
0f6fb3c8 617+ xalp->count = 0;
bbdff76a
WD
618+}
619+
0f6fb3c8 620+void free_xattr(statx *sxp)
bbdff76a 621+{
0f6fb3c8
WD
622+ rsync_xal_free(sxp->xattr);
623+ free(sxp->xattr);
624+ sxp->xattr = NULL;
625+}
bbdff76a 626+
0f6fb3c8
WD
627+static int rsync_xal_compare_names(const void *x1, const void *x2)
628+{
629+ const rsync_xa *xa1 = x1;
630+ const rsync_xa *xa2 = x2;
bbdff76a
WD
631+ return strcmp(xa1->name, xa2->name);
632+}
633+
0f6fb3c8 634+static int rsync_xal_get(const char *fname, item_list *xalp)
bbdff76a
WD
635+{
636+ ssize_t name_size;
637+ ssize_t datum_size;
638+ ssize_t left;
639+ char *name;
640+ size_t len;
641+ char *ptr;
642+
643+ if (!namebuf) {
49de5440 644+ namebuf_len = 1024;
bbdff76a 645+ namebuf = new_array(char, namebuf_len);
49de5440 646+ if (!namebuf)
bbdff76a
WD
647+ out_of_memory("rsync_xal_get");
648+ }
649+
49de5440 650+ /* The length returned includes all the '\0' terminators. */
bbdff76a
WD
651+ name_size = sys_llistxattr(fname, namebuf, namebuf_len);
652+ if (name_size > (ssize_t)namebuf_len) {
653+ name_size = -1;
654+ errno = ERANGE;
655+ }
656+ if (name_size < 0) {
657+ if (errno == ENOTSUP)
0f6fb3c8 658+ return 0;
bbdff76a
WD
659+ if (errno == ERANGE) {
660+ name_size = sys_llistxattr(fname, NULL, 0);
661+ if (name_size < 0) {
0f6fb3c8
WD
662+ rsyserr(FERROR, errno, "%s: rsync_xal_get: llistxattr",
663+ fname);
e5754c5f 664+ return -1;
bbdff76a 665+ }
49de5440 666+ namebuf = realloc_array(namebuf, char, name_size + 1024);
bbdff76a
WD
667+ if (!namebuf)
668+ out_of_memory("rsync_xal_get");
49de5440 669+ namebuf_len = name_size + 1024;
bbdff76a
WD
670+ name_size = sys_llistxattr(fname, namebuf, namebuf_len);
671+ if (name_size < 0) {
0f6fb3c8
WD
672+ rsyserr(FERROR, errno,
673+ "%s: rsync_xal_get: re-llistxattr failed",
674+ fname);
e5754c5f 675+ return -1;
bbdff76a
WD
676+ }
677+ } else {
0f6fb3c8
WD
678+ rsyserr(FERROR, errno,
679+ "%s: rsync_xal_get: llistxattr failed:",
680+ fname);
e5754c5f 681+ return -1;
bbdff76a
WD
682+ }
683+ }
bbdff76a 684+ if (name_size == 0)
e5754c5f 685+ return 0;
bbdff76a 686+ for (left = name_size, name = namebuf; left > 0 ; left -= len, name += len) {
0f6fb3c8 687+ rsync_xa *rxas = EXPAND_ITEM_LIST(xalp, rsync_xa, RSYNC_XAL_INITIAL);
bbdff76a 688+
0f6fb3c8 689+ len = strlen(name) + 1;
49de5440 690+ datum_size = sys_lgetxattr(fname, name, NULL, 0);
bbdff76a
WD
691+ if (datum_size < 0) {
692+ if (errno == ENOTSUP)
e5754c5f 693+ return -1;
49de5440
WD
694+ rsyserr(FERROR, errno,
695+ "%s: rsync_xal_get: lgetxattr %s failed",
696+ fname, name);
697+ return -1;
bbdff76a
WD
698+ }
699+ ptr = new_array(char, len + datum_size);
700+ if (!ptr)
701+ out_of_memory("rsync_xal_get");
0f6fb3c8 702+ memcpy(ptr, name, len);
0f6fb3c8
WD
703+ rxas->name_len = len;
704+ rxas->name = ptr;
705+ rxas->datum_len = datum_size;
706+ rxas->datum = ptr + len;
49de5440
WD
707+ if (datum_size) {
708+ ssize_t size = sys_lgetxattr(fname, name, rxas->datum, datum_size);
709+ if (size != datum_size) {
710+ if (size < 0) {
711+ rsyserr(FERROR, errno,
712+ "rsync_xal_get: lgetxattr(%s,%s)"
713+ " failed", fname, name);
714+ } else {
715+ rprintf(FERROR,
716+ "rsync_xal_get: lgetxattr(%s,%s)"
bb6b64ea
WD
717+ " returned %ld instead of %ld\n",
718+ fname, name,
719+ (long)size, (long)datum_size);
49de5440
WD
720+ }
721+ return -1;
722+ }
723+ }
bbdff76a 724+ }
0f6fb3c8
WD
725+ if (xalp->count > 1)
726+ qsort(xalp->items, xalp->count, sizeof (rsync_xa), rsync_xal_compare_names);
e5754c5f 727+ return 0;
bbdff76a
WD
728+}
729+
0f6fb3c8
WD
730+/* Read the xattr(s) for this filename. */
731+int get_xattr(const char *fname, statx *sxp)
bbdff76a 732+{
0f6fb3c8
WD
733+ sxp->xattr = new(item_list);
734+ *sxp->xattr = empty_xattr;
735+ if (rsync_xal_get(fname, sxp->xattr) < 0) {
736+ free_xattr(sxp);
737+ return -1;
738+ }
739+ return 0;
bbdff76a
WD
740+}
741+
0f6fb3c8 742+static int find_matching_xattr(item_list *xalp)
bbdff76a 743+{
0f6fb3c8
WD
744+ size_t i, j;
745+ item_list *lst = rsync_xal_l.items;
bbdff76a
WD
746+
747+ for (i = 0; i < rsync_xal_l.count; i++) {
0f6fb3c8
WD
748+ rsync_xa *rxas1 = lst[i].items;
749+ rsync_xa *rxas2 = xalp->items;
750+
bbdff76a 751+ /* Wrong number of elements? */
0f6fb3c8 752+ if (lst[i].count != xalp->count)
bbdff76a
WD
753+ continue;
754+ /* any elements different? */
0f6fb3c8
WD
755+ for (j = 0; j < xalp->count; j++) {
756+ if (rxas1[j].name_len != rxas2[j].name_len
757+ || rxas1[j].datum_len != rxas2[j].datum_len
758+ || strcmp(rxas1[j].name, rxas2[j].name)
759+ || memcmp(rxas1[j].datum, rxas2[j].datum, rxas2[j].datum_len))
bbdff76a
WD
760+ break;
761+ }
762+ /* no differences found. This is The One! */
0f6fb3c8
WD
763+ if (j == xalp->count)
764+ return i;
bbdff76a 765+ }
0f6fb3c8
WD
766+
767+ return -1;
bbdff76a
WD
768+}
769+
0f6fb3c8
WD
770+/* Store *xalp on the end of rsync_xal_l */
771+static void rsync_xal_store(item_list *xalp)
bbdff76a 772+{
0f6fb3c8 773+ item_list *new_lst = EXPAND_ITEM_LIST(&rsync_xal_l, item_list, RSYNC_XAL_LIST_INITIAL);
de565f59
WD
774+ /* Since the following call starts a new list, we know it will hold the
775+ * entire initial-count, not just enough space for one new item. */
49de5440
WD
776+ *new_lst = empty_xattr;
777+ (void)EXPAND_ITEM_LIST(new_lst, rsync_xa, xalp->count);
778+ memcpy(new_lst->items, xalp->items, xalp->count * sizeof (rsync_xa));
0f6fb3c8
WD
779+ new_lst->count = xalp->count;
780+ xalp->count = 0;
bbdff76a
WD
781+}
782+
0f6fb3c8
WD
783+/* Send the make_xattr()-generated xattr list for this flist entry. */
784+void send_xattr(statx *sxp, int f)
bbdff76a 785+{
0f6fb3c8
WD
786+ int ndx = find_matching_xattr(sxp->xattr);
787+ if (ndx != -1) {
bbdff76a 788+ write_byte(f, 'x');
0f6fb3c8
WD
789+ write_int(f, ndx);
790+ rsync_xal_free(sxp->xattr);
bbdff76a
WD
791+ } else {
792+ rsync_xa *rxa;
0f6fb3c8 793+ int count = sxp->xattr->count;
bbdff76a
WD
794+ write_byte(f, 'X');
795+ write_int(f, count);
0f6fb3c8 796+ for (rxa = sxp->xattr->items; count--; rxa++) {
517cc92f
WD
797+#ifdef HAVE_OSX_XATTRS
798+ if (strncmp(rxa->name, "user.", 5) != 0
799+ && strncmp(rxa->name, "system.", 7) != 0) {
800+ write_int(f, rxa->name_len + upre_len);
801+ write_int(f, rxa->datum_len);
802+ write_buf(f, unique_prefix, upre_len);
803+ } else
804+#endif
805+ {
806+ write_int(f, rxa->name_len);
807+ write_int(f, rxa->datum_len);
808+ }
bbdff76a
WD
809+ write_buf(f, rxa->name, rxa->name_len);
810+ write_buf(f, rxa->datum, rxa->datum_len);
811+ }
49de5440 812+ rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
bbdff76a 813+ }
0f6fb3c8 814+ free_xattr(sxp);
bbdff76a
WD
815+}
816+
bbdff76a 817+/* ------------------------------------------------------------------------- */
bbdff76a 818+
0f6fb3c8 819+/* receive and build the rsync_xattr_lists */
bbdff76a
WD
820+void receive_xattr(struct file_struct *file, int f)
821+{
0f6fb3c8
WD
822+ static item_list temp_xattr = EMPTY_ITEM_LIST;
823+ int tag = read_byte(f);
824+ char *ndx_ptr = (char*)file + file_struct_len;
825+ int ndx;
bbdff76a 826+
bbdff76a 827+ if (tag == 'X') {
0f6fb3c8 828+ int i, count = read_int(f);
bbdff76a 829+ for (i = 0; i < count; i++) {
bbdff76a 830+ char *ptr;
0f6fb3c8
WD
831+ rsync_xa *rxa;
832+ size_t name_len = read_int(f);
833+ size_t datum_len = read_int(f);
3fcc541f
WD
834+ if (name_len + datum_len < name_len)
835+ out_of_memory("receive_xattr"); /* overflow */
0f6fb3c8 836+ rxa = EXPAND_ITEM_LIST(&temp_xattr, rsync_xa, count);
bbdff76a
WD
837+ ptr = new_array(char, name_len + datum_len);
838+ if (!ptr)
839+ out_of_memory("receive_xattr");
840+ read_buf(f, ptr, name_len);
841+ read_buf(f, ptr + name_len, datum_len);
0f6fb3c8
WD
842+ rxa->name_len = name_len;
843+ rxa->datum_len = datum_len;
844+ rxa->name = ptr;
845+ rxa->datum = ptr + name_len;
517cc92f
WD
846+#ifdef HAVE_OSX_XATTRS
847+ if (strncmp(rxa->name, unique_prefix, upre_len) == 0) {
848+ rxa->name_len -= upre_len;
849+ memmove(rxa->name, rxa->name + upre_len, rxa->name_len);
850+ }
851+#endif
bbdff76a 852+ }
49de5440
WD
853+ ndx = rsync_xal_l.count; /* pre-incremented count */
854+ rsync_xal_store(&temp_xattr); /* adds item to rsync_xal_l */
0f6fb3c8
WD
855+ } else if (tag == 'x') {
856+ ndx = read_int(f);
857+ if (ndx < 0 || (size_t)ndx >= rsync_xal_l.count) {
858+ rprintf(FERROR, "%s: receive_xattr: xa index %d out of range\n",
859+ f_name(file, NULL), ndx);
bbdff76a
WD
860+ exit_cleanup(RERR_STREAMIO);
861+ }
0f6fb3c8
WD
862+ } else {
863+ rprintf(FERROR,
864+ "%s: receive_xattr: unknown extended attribute type tag: %c\n",
865+ f_name(file, NULL), tag);
866+ exit_cleanup(RERR_STREAMIO);
867+ ndx = 0; /* silence a compiler warning... */
bbdff76a 868+ }
bbdff76a 869+
0f6fb3c8 870+ SIVAL(ndx_ptr, 0, ndx);
bbdff76a
WD
871+}
872+
0f6fb3c8
WD
873+/* Turn the xattr data in statx into cached xattr data, setting the index
874+ * values in the file struct. */
875+void cache_xattr(struct file_struct *file, statx *sxp)
bbdff76a 876+{
0f6fb3c8
WD
877+ char *ndx_ptr = (char*)file + file_struct_len;
878+ int ndx;
bbdff76a 879+
0f6fb3c8
WD
880+ if (!sxp->xattr)
881+ return;
bbdff76a 882+
0f6fb3c8
WD
883+ ndx = find_matching_xattr(sxp->xattr);
884+ if (ndx == -1)
49de5440 885+ rsync_xal_store(sxp->xattr); /* adds item to rsync_xal_l */
0f6fb3c8 886+ free_xattr(sxp);
bbdff76a 887+
0f6fb3c8 888+ SIVAL(ndx_ptr, 0, ndx);
bbdff76a
WD
889+}
890+
0f6fb3c8 891+static int rsync_xal_set(const char *fname, item_list *xalp)
bbdff76a 892+{
0f6fb3c8
WD
893+ rsync_xa *rxas = xalp->items;
894+ size_t i;
895+ int ret = 0;
bbdff76a 896+
0f6fb3c8
WD
897+ for (i = 0; i < xalp->count; i++) {
898+ int status = sys_lsetxattr(fname, rxas[i].name, rxas[i].datum, rxas[i].datum_len, 0);
899+ if (status < 0) {
900+ rsyserr(FERROR, errno, "%s: rsync_xal_set: lsetxattr %s failed",
901+ fname, rxas[i].name);
902+ ret = -1;
903+ }
bbdff76a 904+ }
0f6fb3c8 905+ return ret;
bbdff76a
WD
906+}
907+
0f6fb3c8
WD
908+/* Set extended attributes on indicated filename. */
909+int set_xattr(const char *fname, const struct file_struct *file, UNUSED(statx *sxp))
bbdff76a 910+{
0f6fb3c8
WD
911+ int ndx;
912+ char *ndx_ptr = (char*)file + file_struct_len;
913+ item_list *lst = rsync_xal_l.items;
bbdff76a 914+
93d6ca6d
WD
915+ if (dry_run)
916+ return 1; /* FIXME: --dry-run needs to compute this value */
917+
0f6fb3c8
WD
918+ ndx = IVAL(ndx_ptr, 0);
919+ return rsync_xal_set(fname, lst + ndx); /* TODO: This needs to return 1 if no xattrs changed! */
bbdff76a
WD
920+}
921+
922+#endif /* SUPPORT_XATTRS */