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