2 * Copyright (c) 2003-2010 Tim Kientzle
3 * Copyright (c) 2012 Michihiro NAKAJIMA
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer
11 * in this position and unchanged.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include "archive_platform.h"
29 __FBSDID("$FreeBSD$");
31 #if !defined(_WIN32) || defined(__CYGWIN__)
33 #ifdef HAVE_SYS_TYPES_H
34 #include <sys/types.h>
39 #ifdef HAVE_SYS_EXTATTR_H
40 #include <sys/extattr.h>
43 #include <sys/xattr.h>
44 #elif HAVE_ATTR_XATTR_H
45 #include <attr/xattr.h>
50 #ifdef HAVE_SYS_IOCTL_H
51 #include <sys/ioctl.h>
53 #ifdef HAVE_SYS_STAT_H
56 #ifdef HAVE_SYS_TIME_H
59 #ifdef HAVE_SYS_UTIME_H
60 #include <sys/utime.h>
62 #ifdef HAVE_COPYFILE_H
74 #ifdef HAVE_LANGINFO_H
77 #ifdef HAVE_LINUX_FS_H
78 #include <linux/fs.h> /* for Linux file flags */
81 * Some Linux distributions have both linux/ext2_fs.h and ext2fs/ext2_fs.h.
82 * As the include guards don't agree, the order of include is important.
84 #ifdef HAVE_LINUX_EXT2_FS_H
85 #include <linux/ext2_fs.h> /* for Linux file flags */
87 #if defined(HAVE_EXT2FS_EXT2_FS_H) && !defined(__CYGWIN__)
88 #include <ext2fs/ext2_fs.h> /* Linux file flags, broken on Cygwin */
109 #ifdef F_GETTIMES /* Tru64 specific */
110 #include <sys/fcntl1.h>
114 * Macro to cast st_mtime and time_t to an int64 so that 2 numbers can reliably be compared.
116 * It assumes that the input is an integer type of no more than 64 bits.
117 * If the number is less than zero, t must be a signed type, so it fits in
118 * int64_t. Otherwise, it's a nonnegative value so we can cast it to uint64_t
119 * without loss. But it could be a large unsigned value, so we have to clip it
122 #define to_int64_time(t) \
123 ((t) < 0 ? (int64_t)(t) : (uint64_t)(t) > (uint64_t)INT64_MAX ? INT64_MAX : (int64_t)(t))
126 #include <TargetConditionals.h>
127 #if TARGET_OS_MAC && !TARGET_OS_EMBEDDED && HAVE_QUARANTINE_H
128 #include <quarantine.h>
129 #define HAVE_QUARANTINE 1
137 /* TODO: Support Mac OS 'quarantine' feature. This is really just a
138 * standard tag to mark files that have been downloaded as "tainted".
139 * On Mac OS, we should mark the extracted files as tainted if the
140 * archive being read was tainted. Windows has a similar feature; we
141 * should investigate ways to support this generically. */
144 #include "archive_acl_private.h"
145 #include "archive_string.h"
146 #include "archive_endian.h"
147 #include "archive_entry.h"
148 #include "archive_private.h"
149 #include "archive_write_disk_private.h"
158 /* Ignore non-int O_NOFOLLOW constant. */
159 /* gnulib's fcntl.h does this on AIX, but it seems practical everywhere */
160 #if defined O_NOFOLLOW && !(INT_MIN <= O_NOFOLLOW && O_NOFOLLOW <= INT_MAX)
169 #define AT_FDCWD -100
173 struct fixup_entry *next;
174 struct archive_acl acl;
180 unsigned long atime_nanos;
181 unsigned long birthtime_nanos;
182 unsigned long mtime_nanos;
183 unsigned long ctime_nanos;
184 unsigned long fflags_set;
185 size_t mac_metadata_size;
187 int fixup; /* bitmask of what needs fixing */
192 * We use a bitmask to track which operations remain to be done for
193 * this file. In particular, this helps us avoid unnecessary
194 * operations when it's possible to take care of one step as a
195 * side-effect of another. For example, mkdir() can specify the mode
196 * for the newly-created object but symlink() cannot. This means we
197 * can skip chmod() if mkdir() succeeded, but we must explicitly
198 * chmod() if we're trying to create a directory that already exists
199 * (mkdir() failed) or if we're restoring a symlink. Similarly, we
200 * need to verify UID/GID before trying to restore SUID/SGID bits;
201 * that verification can occur explicitly through a stat() call or
202 * implicitly because of a successful chown() call.
204 #define TODO_MODE_FORCE 0x40000000
205 #define TODO_MODE_BASE 0x20000000
206 #define TODO_SUID 0x10000000
207 #define TODO_SUID_CHECK 0x08000000
208 #define TODO_SGID 0x04000000
209 #define TODO_SGID_CHECK 0x02000000
210 #define TODO_APPLEDOUBLE 0x01000000
211 #define TODO_MODE (TODO_MODE_BASE|TODO_SUID|TODO_SGID)
212 #define TODO_TIMES ARCHIVE_EXTRACT_TIME
213 #define TODO_OWNER ARCHIVE_EXTRACT_OWNER
214 #define TODO_FFLAGS ARCHIVE_EXTRACT_FFLAGS
215 #define TODO_ACLS ARCHIVE_EXTRACT_ACL
216 #define TODO_XATTR ARCHIVE_EXTRACT_XATTR
217 #define TODO_MAC_METADATA ARCHIVE_EXTRACT_MAC_METADATA
218 #define TODO_HFS_COMPRESSION ARCHIVE_EXTRACT_HFS_COMPRESSION_FORCED
220 struct archive_write_disk {
221 struct archive archive;
224 struct fixup_entry *fixup_list;
225 struct fixup_entry *current_fixup;
228 int64_t skip_file_dev;
229 int64_t skip_file_ino;
232 int64_t (*lookup_gid)(void *private, const char *gname, int64_t gid);
233 void (*cleanup_gid)(void *private);
234 void *lookup_gid_data;
235 int64_t (*lookup_uid)(void *private, const char *uname, int64_t uid);
236 void (*cleanup_uid)(void *private);
237 void *lookup_uid_data;
240 * Full path of last file to satisfy symlink checks.
242 struct archive_string path_safe;
245 * Cached stat data from disk for the current entry.
246 * If this is valid, pst points to st. Otherwise,
252 /* Information about the object being restored right now. */
253 struct archive_entry *entry; /* Entry being extracted. */
254 char *name; /* Name of entry, possibly edited. */
255 struct archive_string _name_data; /* backing store for 'name' */
256 char *tmpname; /* Temporary name * */
257 struct archive_string _tmpname_data; /* backing store for 'tmpname' */
258 /* Tasks remaining for this object. */
260 /* Tasks deferred until end-of-archive. */
262 /* Options requested by the client. */
264 /* Handle for the file we're restoring. */
266 /* Current offset for writing data to the file. */
268 /* Last offset actually written to disk. */
270 /* Total bytes actually written to files. */
271 int64_t total_bytes_written;
272 /* Maximum size of file, -1 if unknown. */
274 /* Dir we were in before this restore; only for deep paths. */
276 /* Mode we should use for this entry; affected by _PERM and umask. */
278 /* UID/GID to use in restoring this entry. */
284 /* Xattr "com.apple.decmpfs". */
285 uint32_t decmpfs_attr_size;
286 unsigned char *decmpfs_header_p;
287 /* ResourceFork set options used for fsetxattr. */
288 int rsrc_xattr_options;
289 /* Xattr "com.apple.ResourceFork". */
290 unsigned char *resource_fork;
291 size_t resource_fork_allocated_size;
292 unsigned int decmpfs_block_count;
293 uint32_t *decmpfs_block_info;
294 /* Buffer for compressed data. */
295 unsigned char *compressed_buffer;
296 size_t compressed_buffer_size;
297 size_t compressed_buffer_remaining;
298 /* The offset of the ResourceFork where compressed data will
300 uint32_t compressed_rsrc_position;
301 uint32_t compressed_rsrc_position_v;
302 /* Buffer for uncompressed data. */
303 char *uncompressed_buffer;
304 size_t block_remaining_bytes;
305 size_t file_remaining_bytes;
309 int decmpfs_compression_level;
314 * Default mode for dirs created automatically (will be modified by umask).
315 * Note that POSIX specifies 0777 for implicitly-created dirs, "modified
316 * by the process' file creation mask."
318 #define DEFAULT_DIR_MODE 0777
320 * Dir modes are restored in two steps: During the extraction, the permissions
321 * in the archive are modified to match the following limits. During
322 * the post-extract fixup pass, the permissions from the archive are
325 #define MINIMUM_DIR_MODE 0700
326 #define MAXIMUM_DIR_MODE 0775
329 * Maximum uncompressed size of a decmpfs block.
331 #define MAX_DECMPFS_BLOCK_SIZE (64 * 1024)
333 * HFS+ compression type.
335 #define CMP_XATTR 3/* Compressed data in xattr. */
336 #define CMP_RESOURCE_FORK 4/* Compressed data in resource fork. */
338 * HFS+ compression resource fork.
340 #define RSRC_H_SIZE 260 /* Base size of Resource fork header. */
341 #define RSRC_F_SIZE 50 /* Size of Resource fork footer. */
342 /* Size to write compressed data to resource fork. */
343 #define COMPRESSED_W_SIZE (64 * 1024)
344 /* decmpfs definitions. */
345 #define MAX_DECMPFS_XATTR_SIZE 3802
346 #ifndef DECMPFS_XATTR_NAME
347 #define DECMPFS_XATTR_NAME "com.apple.decmpfs"
349 #define DECMPFS_MAGIC 0x636d7066
350 #define DECMPFS_COMPRESSION_MAGIC 0
351 #define DECMPFS_COMPRESSION_TYPE 4
352 #define DECMPFS_UNCOMPRESSED_SIZE 8
353 #define DECMPFS_HEADER_SIZE 16
355 #define HFS_BLOCKS(s) ((s) >> 12)
358 static int la_opendirat(int, const char *);
359 static int la_mktemp(struct archive_write_disk *);
360 static void fsobj_error(int *, struct archive_string *, int, const char *,
362 static int check_symlinks_fsobj(char *, int *, struct archive_string *,
364 static int check_symlinks(struct archive_write_disk *);
365 static int create_filesystem_object(struct archive_write_disk *);
366 static struct fixup_entry *current_fixup(struct archive_write_disk *,
367 const char *pathname);
368 #if defined(HAVE_FCHDIR) && defined(PATH_MAX)
369 static void edit_deep_directories(struct archive_write_disk *ad);
371 static int cleanup_pathname_fsobj(char *, int *, struct archive_string *,
373 static int cleanup_pathname(struct archive_write_disk *);
374 static int create_dir(struct archive_write_disk *, char *);
375 static int create_parent_dir(struct archive_write_disk *, char *);
376 static ssize_t hfs_write_data_block(struct archive_write_disk *,
377 const char *, size_t);
378 static int fixup_appledouble(struct archive_write_disk *, const char *);
379 static int older(struct stat *, struct archive_entry *);
380 static int restore_entry(struct archive_write_disk *);
381 static int set_mac_metadata(struct archive_write_disk *, const char *,
382 const void *, size_t);
383 static int set_xattrs(struct archive_write_disk *);
384 static int clear_nochange_fflags(struct archive_write_disk *);
385 static int set_fflags(struct archive_write_disk *);
386 static int set_fflags_platform(struct archive_write_disk *, int fd,
387 const char *name, mode_t mode,
388 unsigned long fflags_set, unsigned long fflags_clear);
389 static int set_ownership(struct archive_write_disk *);
390 static int set_mode(struct archive_write_disk *, int mode);
391 static int set_time(int, int, const char *, time_t, long, time_t, long);
392 static int set_times(struct archive_write_disk *, int, int, const char *,
393 time_t, long, time_t, long, time_t, long, time_t, long);
394 static int set_times_from_entry(struct archive_write_disk *);
395 static struct fixup_entry *sort_dir_list(struct fixup_entry *p);
396 static ssize_t write_data_block(struct archive_write_disk *,
397 const char *, size_t);
399 static struct archive_vtable *archive_write_disk_vtable(void);
401 static int _archive_write_disk_close(struct archive *);
402 static int _archive_write_disk_free(struct archive *);
403 static int _archive_write_disk_header(struct archive *,
404 struct archive_entry *);
405 static int64_t _archive_write_disk_filter_bytes(struct archive *, int);
406 static int _archive_write_disk_finish_entry(struct archive *);
407 static ssize_t _archive_write_disk_data(struct archive *, const void *,
409 static ssize_t _archive_write_disk_data_block(struct archive *, const void *,
413 la_mktemp(struct archive_write_disk *a)
418 archive_string_empty(&a->_tmpname_data);
419 archive_string_sprintf(&a->_tmpname_data, "%s.XXXXXX", a->name);
420 a->tmpname = a->_tmpname_data.s;
422 fd = __archive_mkstemp(a->tmpname);
426 mode = a->mode & 0777 & ~a->user_umask;
427 if (fchmod(fd, mode) == -1) {
437 la_opendirat(int fd, const char *path) {
438 const int flags = O_CLOEXEC
439 #if defined(O_BINARY)
442 #if defined(O_DIRECTORY)
447 #elif defined(O_SEARCH)
449 #elif defined(__FreeBSD__) && defined(O_EXEC)
456 #if !defined(HAVE_OPENAT)
457 if (fd != AT_FDCWD) {
461 return (open(path, flags));
463 return (openat(fd, path, flags));
468 lazy_stat(struct archive_write_disk *a)
470 if (a->pst != NULL) {
471 /* Already have stat() data available. */
475 if (a->fd >= 0 && fstat(a->fd, &a->st) == 0) {
481 * XXX At this point, symlinks should not be hit, otherwise
482 * XXX a race occurred. Do we want to check explicitly for that?
484 if (lstat(a->name, &a->st) == 0) {
488 archive_set_error(&a->archive, errno, "Couldn't stat file");
489 return (ARCHIVE_WARN);
492 static struct archive_vtable *
493 archive_write_disk_vtable(void)
495 static struct archive_vtable av;
496 static int inited = 0;
499 av.archive_close = _archive_write_disk_close;
500 av.archive_filter_bytes = _archive_write_disk_filter_bytes;
501 av.archive_free = _archive_write_disk_free;
502 av.archive_write_header = _archive_write_disk_header;
503 av.archive_write_finish_entry
504 = _archive_write_disk_finish_entry;
505 av.archive_write_data = _archive_write_disk_data;
506 av.archive_write_data_block = _archive_write_disk_data_block;
513 _archive_write_disk_filter_bytes(struct archive *_a, int n)
515 struct archive_write_disk *a = (struct archive_write_disk *)_a;
516 (void)n; /* UNUSED */
517 if (n == -1 || n == 0)
518 return (a->total_bytes_written);
524 archive_write_disk_set_options(struct archive *_a, int flags)
526 struct archive_write_disk *a = (struct archive_write_disk *)_a;
534 * Extract this entry to disk.
536 * TODO: Validate hardlinks. According to the standards, we're
537 * supposed to check each extracted hardlink and squawk if it refers
538 * to a file that we didn't restore. I'm not entirely convinced this
539 * is a good idea, but more importantly: Is there any way to validate
540 * hardlinks without keeping a complete list of filenames from the
541 * entire archive?? Ugh.
545 _archive_write_disk_header(struct archive *_a, struct archive_entry *entry)
547 struct archive_write_disk *a = (struct archive_write_disk *)_a;
548 struct fixup_entry *fe;
549 const char *linkname;
552 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
553 ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
554 "archive_write_disk_header");
555 archive_clear_error(&a->archive);
556 if (a->archive.state & ARCHIVE_STATE_DATA) {
557 r = _archive_write_disk_finish_entry(&a->archive);
558 if (r == ARCHIVE_FATAL)
562 /* Set up for this particular entry. */
564 a->current_fixup = NULL;
567 archive_entry_free(a->entry);
570 a->entry = archive_entry_clone(entry);
575 a->uid = a->user_uid;
576 a->mode = archive_entry_mode(a->entry);
577 if (archive_entry_size_is_set(a->entry))
578 a->filesize = archive_entry_size(a->entry);
581 archive_strcpy(&(a->_name_data), archive_entry_pathname(a->entry));
582 a->name = a->_name_data.s;
583 archive_clear_error(&a->archive);
586 * Clean up the requested path. This is necessary for correct
587 * dir restores; the dir restore logic otherwise gets messed
588 * up by nonsense like "dir/.".
590 ret = cleanup_pathname(a);
591 if (ret != ARCHIVE_OK)
595 * Check if we have a hardlink that points to itself.
597 linkname = archive_entry_hardlink(a->entry);
598 if (linkname != NULL && strcmp(a->name, linkname) == 0) {
599 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
600 "Skipping hardlink pointing to itself: %s",
602 return (ARCHIVE_WARN);
606 * Query the umask so we get predictable mode settings.
607 * This gets done on every call to _write_header in case the
608 * user edits their umask during the extraction for some
611 umask(a->user_umask = umask(0));
613 /* Figure out what we need to do for this entry. */
614 a->todo = TODO_MODE_BASE;
615 if (a->flags & ARCHIVE_EXTRACT_PERM) {
616 a->todo |= TODO_MODE_FORCE; /* Be pushy about permissions. */
618 * SGID requires an extra "check" step because we
619 * cannot easily predict the GID that the system will
620 * assign. (Different systems assign GIDs to files
621 * based on a variety of criteria, including process
622 * credentials and the gid of the enclosing
623 * directory.) We can only restore the SGID bit if
624 * the file has the right GID, and we only know the
625 * GID if we either set it (see set_ownership) or if
626 * we've actually called stat() on the file after it
627 * was restored. Since there are several places at
628 * which we might verify the GID, we need a TODO bit
631 if (a->mode & S_ISGID)
632 a->todo |= TODO_SGID | TODO_SGID_CHECK;
634 * Verifying the SUID is simpler, but can still be
635 * done in multiple ways, hence the separate "check" bit.
637 if (a->mode & S_ISUID)
638 a->todo |= TODO_SUID | TODO_SUID_CHECK;
641 * User didn't request full permissions, so don't
642 * restore SUID, SGID bits and obey umask.
647 a->mode &= ~a->user_umask;
649 if (a->flags & ARCHIVE_EXTRACT_OWNER)
650 a->todo |= TODO_OWNER;
651 if (a->flags & ARCHIVE_EXTRACT_TIME)
652 a->todo |= TODO_TIMES;
653 if (a->flags & ARCHIVE_EXTRACT_ACL) {
654 #if ARCHIVE_ACL_DARWIN
656 * On MacOS, platform ACLs get stored in mac_metadata, too.
657 * If we intend to extract mac_metadata and it is present
658 * we skip extracting libarchive NFSv4 ACLs.
660 size_t metadata_size;
662 if ((a->flags & ARCHIVE_EXTRACT_MAC_METADATA) == 0 ||
663 archive_entry_mac_metadata(a->entry,
664 &metadata_size) == NULL || metadata_size == 0)
666 #if ARCHIVE_ACL_LIBRICHACL
668 * RichACLs are stored in an extended attribute.
669 * If we intend to extract extended attributes and have this
670 * attribute we skip extracting libarchive NFSv4 ACLs.
672 short extract_acls = 1;
673 if (a->flags & ARCHIVE_EXTRACT_XATTR && (
674 archive_entry_acl_types(a->entry) &
675 ARCHIVE_ENTRY_ACL_TYPE_NFS4)) {
676 const char *attr_name;
677 const void *attr_value;
679 int i = archive_entry_xattr_reset(a->entry);
681 archive_entry_xattr_next(a->entry, &attr_name,
682 &attr_value, &attr_size);
683 if (attr_name != NULL && attr_value != NULL &&
684 attr_size > 0 && strcmp(attr_name,
685 "trusted.richacl") == 0) {
693 #if ARCHIVE_ACL_DARWIN || ARCHIVE_ACL_LIBRICHACL
696 if (archive_entry_filetype(a->entry) == AE_IFDIR)
697 a->deferred |= TODO_ACLS;
699 a->todo |= TODO_ACLS;
700 #if ARCHIVE_ACL_DARWIN || ARCHIVE_ACL_LIBRICHACL
704 if (a->flags & ARCHIVE_EXTRACT_MAC_METADATA) {
705 if (archive_entry_filetype(a->entry) == AE_IFDIR)
706 a->deferred |= TODO_MAC_METADATA;
708 a->todo |= TODO_MAC_METADATA;
710 #if defined(__APPLE__) && defined(UF_COMPRESSED) && defined(HAVE_ZLIB_H)
711 if ((a->flags & ARCHIVE_EXTRACT_NO_HFS_COMPRESSION) == 0) {
712 unsigned long set, clear;
713 archive_entry_fflags(a->entry, &set, &clear);
714 if ((set & ~clear) & UF_COMPRESSED) {
715 a->todo |= TODO_HFS_COMPRESSION;
716 a->decmpfs_block_count = (unsigned)-1;
719 if ((a->flags & ARCHIVE_EXTRACT_HFS_COMPRESSION_FORCED) != 0 &&
720 (a->mode & AE_IFMT) == AE_IFREG && a->filesize > 0) {
721 a->todo |= TODO_HFS_COMPRESSION;
722 a->decmpfs_block_count = (unsigned)-1;
727 /* Check if the current file name is a type of the
728 * resource fork file. */
729 p = strrchr(a->name, '/');
734 if (p[0] == '.' && p[1] == '_') {
735 /* Do not compress "._XXX" files. */
736 a->todo &= ~TODO_HFS_COMPRESSION;
738 a->todo |= TODO_APPLEDOUBLE;
743 if (a->flags & ARCHIVE_EXTRACT_XATTR) {
744 #if ARCHIVE_XATTR_DARWIN
746 * On MacOS, extended attributes get stored in mac_metadata,
747 * too. If we intend to extract mac_metadata and it is present
748 * we skip extracting extended attributes.
750 size_t metadata_size;
752 if ((a->flags & ARCHIVE_EXTRACT_MAC_METADATA) == 0 ||
753 archive_entry_mac_metadata(a->entry,
754 &metadata_size) == NULL || metadata_size == 0)
756 a->todo |= TODO_XATTR;
758 if (a->flags & ARCHIVE_EXTRACT_FFLAGS)
759 a->todo |= TODO_FFLAGS;
760 if (a->flags & ARCHIVE_EXTRACT_SECURE_SYMLINKS) {
761 ret = check_symlinks(a);
762 if (ret != ARCHIVE_OK)
765 #if defined(HAVE_FCHDIR) && defined(PATH_MAX)
766 /* If path exceeds PATH_MAX, shorten the path. */
767 edit_deep_directories(a);
770 ret = restore_entry(a);
772 #if defined(__APPLE__) && defined(UF_COMPRESSED) && defined(HAVE_ZLIB_H)
774 * Check if the filesystem the file is restoring on supports
775 * HFS+ Compression. If not, cancel HFS+ Compression.
777 if (a->todo | TODO_HFS_COMPRESSION) {
779 * NOTE: UF_COMPRESSED is ignored even if the filesystem
780 * supports HFS+ Compression because the file should
781 * have at least an extended attribute "com.apple.decmpfs"
782 * before the flag is set to indicate that the file have
783 * been compressed. If the filesystem does not support
784 * HFS+ Compression the system call will fail.
786 if (a->fd < 0 || fchflags(a->fd, UF_COMPRESSED) != 0)
787 a->todo &= ~TODO_HFS_COMPRESSION;
792 * TODO: There are rumours that some extended attributes must
793 * be restored before file data is written. If this is true,
794 * then we either need to write all extended attributes both
795 * before and after restoring the data, or find some rule for
796 * determining which must go first and which last. Due to the
797 * many ways people are using xattrs, this may prove to be an
798 * intractable problem.
802 /* If we changed directory above, restore it here. */
803 if (a->restore_pwd >= 0) {
804 r = fchdir(a->restore_pwd);
806 archive_set_error(&a->archive, errno,
810 close(a->restore_pwd);
816 * Fixup uses the unedited pathname from archive_entry_pathname(),
817 * because it is relative to the base dir and the edited path
818 * might be relative to some intermediate dir as a result of the
819 * deep restore logic.
821 if (a->deferred & TODO_MODE) {
822 fe = current_fixup(a, archive_entry_pathname(entry));
824 return (ARCHIVE_FATAL);
825 fe->fixup |= TODO_MODE_BASE;
829 if ((a->deferred & TODO_TIMES)
830 && (archive_entry_mtime_is_set(entry)
831 || archive_entry_atime_is_set(entry))) {
832 fe = current_fixup(a, archive_entry_pathname(entry));
834 return (ARCHIVE_FATAL);
836 fe->fixup |= TODO_TIMES;
837 if (archive_entry_atime_is_set(entry)) {
838 fe->atime = archive_entry_atime(entry);
839 fe->atime_nanos = archive_entry_atime_nsec(entry);
841 /* If atime is unset, use start time. */
842 fe->atime = a->start_time;
845 if (archive_entry_mtime_is_set(entry)) {
846 fe->mtime = archive_entry_mtime(entry);
847 fe->mtime_nanos = archive_entry_mtime_nsec(entry);
849 /* If mtime is unset, use start time. */
850 fe->mtime = a->start_time;
853 if (archive_entry_birthtime_is_set(entry)) {
854 fe->birthtime = archive_entry_birthtime(entry);
855 fe->birthtime_nanos = archive_entry_birthtime_nsec(
858 /* If birthtime is unset, use mtime. */
859 fe->birthtime = fe->mtime;
860 fe->birthtime_nanos = fe->mtime_nanos;
864 if (a->deferred & TODO_ACLS) {
865 fe = current_fixup(a, archive_entry_pathname(entry));
867 return (ARCHIVE_FATAL);
868 fe->fixup |= TODO_ACLS;
869 archive_acl_copy(&fe->acl, archive_entry_acl(entry));
872 if (a->deferred & TODO_MAC_METADATA) {
873 const void *metadata;
874 size_t metadata_size;
875 metadata = archive_entry_mac_metadata(a->entry, &metadata_size);
876 if (metadata != NULL && metadata_size > 0) {
877 fe = current_fixup(a, archive_entry_pathname(entry));
879 return (ARCHIVE_FATAL);
880 fe->mac_metadata = malloc(metadata_size);
881 if (fe->mac_metadata != NULL) {
882 memcpy(fe->mac_metadata, metadata,
884 fe->mac_metadata_size = metadata_size;
885 fe->fixup |= TODO_MAC_METADATA;
890 if (a->deferred & TODO_FFLAGS) {
891 fe = current_fixup(a, archive_entry_pathname(entry));
893 return (ARCHIVE_FATAL);
894 fe->fixup |= TODO_FFLAGS;
895 /* TODO: Complete this.. defer fflags from below. */
898 /* We've created the object and are ready to pour data into it. */
899 if (ret >= ARCHIVE_WARN)
900 a->archive.state = ARCHIVE_STATE_DATA;
902 * If it's not open, tell our client not to try writing.
903 * In particular, dirs, links, etc, don't get written to.
906 archive_entry_set_size(entry, 0);
914 archive_write_disk_set_skip_file(struct archive *_a, la_int64_t d, la_int64_t i)
916 struct archive_write_disk *a = (struct archive_write_disk *)_a;
917 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
918 ARCHIVE_STATE_ANY, "archive_write_disk_set_skip_file");
919 a->skip_file_set = 1;
920 a->skip_file_dev = d;
921 a->skip_file_ino = i;
926 write_data_block(struct archive_write_disk *a, const char *buff, size_t size)
928 uint64_t start_size = size;
929 ssize_t bytes_written = 0;
930 ssize_t block_size = 0, bytes_to_write;
935 if (a->filesize == 0 || a->fd < 0) {
936 archive_set_error(&a->archive, 0,
937 "Attempt to write to an empty file");
938 return (ARCHIVE_WARN);
941 if (a->flags & ARCHIVE_EXTRACT_SPARSE) {
942 #if HAVE_STRUCT_STAT_ST_BLKSIZE
944 if ((r = lazy_stat(a)) != ARCHIVE_OK)
946 block_size = a->pst->st_blksize;
948 /* XXX TODO XXX Is there a more appropriate choice here ? */
949 /* This needn't match the filesystem allocation size. */
950 block_size = 16*1024;
954 /* If this write would run beyond the file size, truncate it. */
955 if (a->filesize >= 0 && (int64_t)(a->offset + size) > a->filesize)
956 start_size = size = (size_t)(a->filesize - a->offset);
958 /* Write the data. */
960 if (block_size == 0) {
961 bytes_to_write = size;
963 /* We're sparsifying the file. */
967 /* Skip leading zero bytes. */
968 for (p = buff, end = buff + size; p < end; ++p) {
972 a->offset += p - buff;
978 /* Calculate next block boundary after offset. */
980 = (a->offset / block_size + 1) * block_size;
982 /* If the adjusted write would cross block boundary,
983 * truncate it to the block boundary. */
984 bytes_to_write = size;
985 if (a->offset + bytes_to_write > block_end)
986 bytes_to_write = block_end - a->offset;
988 /* Seek if necessary to the specified offset. */
989 if (a->offset != a->fd_offset) {
990 if (lseek(a->fd, a->offset, SEEK_SET) < 0) {
991 archive_set_error(&a->archive, errno,
993 return (ARCHIVE_FATAL);
995 a->fd_offset = a->offset;
997 bytes_written = write(a->fd, buff, bytes_to_write);
998 if (bytes_written < 0) {
999 archive_set_error(&a->archive, errno, "Write failed");
1000 return (ARCHIVE_WARN);
1002 buff += bytes_written;
1003 size -= bytes_written;
1004 a->total_bytes_written += bytes_written;
1005 a->offset += bytes_written;
1006 a->fd_offset = a->offset;
1008 return (start_size - size);
1011 #if defined(__APPLE__) && defined(UF_COMPRESSED) && defined(HAVE_SYS_XATTR_H)\
1012 && defined(HAVE_ZLIB_H)
1015 * Set UF_COMPRESSED file flag.
1016 * This have to be called after hfs_write_decmpfs() because if the
1017 * file does not have "com.apple.decmpfs" xattr the flag is ignored.
1020 hfs_set_compressed_fflag(struct archive_write_disk *a)
1024 if ((r = lazy_stat(a)) != ARCHIVE_OK)
1027 a->st.st_flags |= UF_COMPRESSED;
1028 if (fchflags(a->fd, a->st.st_flags) != 0) {
1029 archive_set_error(&a->archive, errno,
1030 "Failed to set UF_COMPRESSED file flag");
1031 return (ARCHIVE_WARN);
1033 return (ARCHIVE_OK);
1037 * HFS+ Compression decmpfs
1039 * +------------------------------+ +0
1040 * | Magic(LE 4 bytes) |
1041 * +------------------------------+
1042 * | Type(LE 4 bytes) |
1043 * +------------------------------+
1044 * | Uncompressed size(LE 8 bytes)|
1045 * +------------------------------+ +16
1047 * | Compressed data |
1048 * | (Placed only if Type == 3) |
1050 * +------------------------------+ +3802 = MAX_DECMPFS_XATTR_SIZE
1052 * Type is 3: decmpfs has compressed data.
1053 * Type is 4: Resource Fork has compressed data.
1056 * Write "com.apple.decmpfs"
1059 hfs_write_decmpfs(struct archive_write_disk *a)
1062 uint32_t compression_type;
1064 r = fsetxattr(a->fd, DECMPFS_XATTR_NAME, a->decmpfs_header_p,
1065 a->decmpfs_attr_size, 0, 0);
1067 archive_set_error(&a->archive, errno,
1068 "Cannot restore xattr:%s", DECMPFS_XATTR_NAME);
1069 compression_type = archive_le32dec(
1070 &a->decmpfs_header_p[DECMPFS_COMPRESSION_TYPE]);
1071 if (compression_type == CMP_RESOURCE_FORK)
1072 fremovexattr(a->fd, XATTR_RESOURCEFORK_NAME,
1073 XATTR_SHOWCOMPRESSION);
1074 return (ARCHIVE_WARN);
1076 return (ARCHIVE_OK);
1080 * HFS+ Compression Resource Fork
1082 * +-----------------------------+
1083 * | Header(260 bytes) |
1084 * +-----------------------------+
1085 * | Block count(LE 4 bytes) |
1086 * +-----------------------------+ --+
1087 * +-- | Offset (LE 4 bytes) | |
1088 * | | [distance from Block count] | | Block 0
1089 * | +-----------------------------+ |
1090 * | | Compressed size(LE 4 bytes) | |
1091 * | +-----------------------------+ --+
1093 * | | .................. |
1095 * | +-----------------------------+ --+
1096 * | | Offset (LE 4 bytes) | |
1097 * | +-----------------------------+ | Block (Block count -1)
1098 * | | Compressed size(LE 4 bytes) | |
1099 * +-> +-----------------------------+ --+
1100 * | Compressed data(n bytes) | Block 0
1101 * +-----------------------------+
1103 * | .................. |
1105 * +-----------------------------+
1106 * | Compressed data(n bytes) | Block (Block count -1)
1107 * +-----------------------------+
1108 * | Footer(50 bytes) |
1109 * +-----------------------------+
1113 * Write the header of "com.apple.ResourceFork"
1116 hfs_write_resource_fork(struct archive_write_disk *a, unsigned char *buff,
1117 size_t bytes, uint32_t position)
1121 ret = fsetxattr(a->fd, XATTR_RESOURCEFORK_NAME, buff, bytes,
1122 position, a->rsrc_xattr_options);
1124 archive_set_error(&a->archive, errno,
1125 "Cannot restore xattr: %s at %u pos %u bytes",
1126 XATTR_RESOURCEFORK_NAME,
1129 return (ARCHIVE_WARN);
1131 a->rsrc_xattr_options &= ~XATTR_CREATE;
1132 return (ARCHIVE_OK);
1136 hfs_write_compressed_data(struct archive_write_disk *a, size_t bytes_compressed)
1140 ret = hfs_write_resource_fork(a, a->compressed_buffer,
1141 bytes_compressed, a->compressed_rsrc_position);
1142 if (ret == ARCHIVE_OK)
1143 a->compressed_rsrc_position += bytes_compressed;
1148 hfs_write_resource_fork_header(struct archive_write_disk *a)
1150 unsigned char *buff;
1151 uint32_t rsrc_bytes;
1152 uint32_t rsrc_header_bytes;
1155 * Write resource fork header + block info.
1157 buff = a->resource_fork;
1158 rsrc_bytes = a->compressed_rsrc_position - RSRC_F_SIZE;
1160 RSRC_H_SIZE + /* Header base size. */
1161 4 + /* Block count. */
1162 (a->decmpfs_block_count * 8);/* Block info */
1163 archive_be32enc(buff, 0x100);
1164 archive_be32enc(buff + 4, rsrc_bytes);
1165 archive_be32enc(buff + 8, rsrc_bytes - 256);
1166 archive_be32enc(buff + 12, 0x32);
1167 memset(buff + 16, 0, 240);
1168 archive_be32enc(buff + 256, rsrc_bytes - 260);
1169 return hfs_write_resource_fork(a, buff, rsrc_header_bytes, 0);
1173 hfs_set_resource_fork_footer(unsigned char *buff, size_t buff_size)
1175 static const char rsrc_footer[RSRC_F_SIZE] = {
1176 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
1177 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
1178 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
1179 0x00, 0x1c, 0x00, 0x32, 0x00, 0x00, 'c', 'm',
1180 'p', 'f', 0x00, 0x00, 0x00, 0x0a, 0x00, 0x01,
1181 0xff, 0xff, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
1184 if (buff_size < sizeof(rsrc_footer))
1186 memcpy(buff, rsrc_footer, sizeof(rsrc_footer));
1187 return (sizeof(rsrc_footer));
1191 hfs_reset_compressor(struct archive_write_disk *a)
1195 if (a->stream_valid)
1196 ret = deflateReset(&a->stream);
1198 ret = deflateInit(&a->stream, a->decmpfs_compression_level);
1201 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1202 "Failed to initialize compressor");
1203 return (ARCHIVE_FATAL);
1205 a->stream_valid = 1;
1207 return (ARCHIVE_OK);
1211 hfs_decompress(struct archive_write_disk *a)
1213 uint32_t *block_info;
1214 unsigned int block_count;
1215 uint32_t data_pos, data_size;
1217 ssize_t bytes_written, bytes_to_write;
1220 block_info = (uint32_t *)(a->resource_fork + RSRC_H_SIZE);
1221 block_count = archive_le32dec(block_info++);
1222 while (block_count--) {
1223 data_pos = RSRC_H_SIZE + archive_le32dec(block_info++);
1224 data_size = archive_le32dec(block_info++);
1225 r = fgetxattr(a->fd, XATTR_RESOURCEFORK_NAME,
1226 a->compressed_buffer, data_size, data_pos, 0);
1227 if (r != data_size) {
1228 archive_set_error(&a->archive,
1229 (r < 0)?errno:ARCHIVE_ERRNO_MISC,
1230 "Failed to read resource fork");
1231 return (ARCHIVE_WARN);
1233 if (a->compressed_buffer[0] == 0xff) {
1234 bytes_to_write = data_size -1;
1235 b = a->compressed_buffer + 1;
1237 uLong dest_len = MAX_DECMPFS_BLOCK_SIZE;
1240 zr = uncompress((Bytef *)a->uncompressed_buffer,
1241 &dest_len, a->compressed_buffer, data_size);
1243 archive_set_error(&a->archive,
1245 "Failed to decompress resource fork");
1246 return (ARCHIVE_WARN);
1248 bytes_to_write = dest_len;
1249 b = (unsigned char *)a->uncompressed_buffer;
1252 bytes_written = write(a->fd, b, bytes_to_write);
1253 if (bytes_written < 0) {
1254 archive_set_error(&a->archive, errno,
1256 return (ARCHIVE_WARN);
1258 bytes_to_write -= bytes_written;
1260 } while (bytes_to_write > 0);
1262 r = fremovexattr(a->fd, XATTR_RESOURCEFORK_NAME, 0);
1264 archive_set_error(&a->archive, errno,
1265 "Failed to remove resource fork");
1266 return (ARCHIVE_WARN);
1268 return (ARCHIVE_OK);
1272 hfs_drive_compressor(struct archive_write_disk *a, const char *buff,
1275 unsigned char *buffer_compressed;
1276 size_t bytes_compressed;
1280 ret = hfs_reset_compressor(a);
1281 if (ret != ARCHIVE_OK)
1284 if (a->compressed_buffer == NULL) {
1287 block_size = COMPRESSED_W_SIZE + RSRC_F_SIZE +
1288 + compressBound(MAX_DECMPFS_BLOCK_SIZE);
1289 a->compressed_buffer = malloc(block_size);
1290 if (a->compressed_buffer == NULL) {
1291 archive_set_error(&a->archive, ENOMEM,
1292 "Can't allocate memory for Resource Fork");
1293 return (ARCHIVE_FATAL);
1295 a->compressed_buffer_size = block_size;
1296 a->compressed_buffer_remaining = block_size;
1299 buffer_compressed = a->compressed_buffer +
1300 a->compressed_buffer_size - a->compressed_buffer_remaining;
1301 a->stream.next_in = (Bytef *)(uintptr_t)(const void *)buff;
1302 a->stream.avail_in = size;
1303 a->stream.next_out = buffer_compressed;
1304 a->stream.avail_out = a->compressed_buffer_remaining;
1306 ret = deflate(&a->stream, Z_FINISH);
1312 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1313 "Failed to compress data");
1314 return (ARCHIVE_FAILED);
1316 } while (ret == Z_OK);
1317 bytes_compressed = a->compressed_buffer_remaining - a->stream.avail_out;
1320 * If the compressed size is larger than the original size,
1321 * throw away compressed data, use uncompressed data instead.
1323 if (bytes_compressed > size) {
1324 buffer_compressed[0] = 0xFF;/* uncompressed marker. */
1325 memcpy(buffer_compressed + 1, buff, size);
1326 bytes_compressed = size + 1;
1328 a->compressed_buffer_remaining -= bytes_compressed;
1331 * If the compressed size is smaller than MAX_DECMPFS_XATTR_SIZE
1332 * and the block count in the file is only one, store compressed
1333 * data to decmpfs xattr instead of the resource fork.
1335 if (a->decmpfs_block_count == 1 &&
1336 (a->decmpfs_attr_size + bytes_compressed)
1337 <= MAX_DECMPFS_XATTR_SIZE) {
1338 archive_le32enc(&a->decmpfs_header_p[DECMPFS_COMPRESSION_TYPE],
1340 memcpy(a->decmpfs_header_p + DECMPFS_HEADER_SIZE,
1341 buffer_compressed, bytes_compressed);
1342 a->decmpfs_attr_size += bytes_compressed;
1343 a->compressed_buffer_remaining = a->compressed_buffer_size;
1345 * Finish HFS+ Compression.
1346 * - Write the decmpfs xattr.
1347 * - Set the UF_COMPRESSED file flag.
1349 ret = hfs_write_decmpfs(a);
1350 if (ret == ARCHIVE_OK)
1351 ret = hfs_set_compressed_fflag(a);
1355 /* Update block info. */
1356 archive_le32enc(a->decmpfs_block_info++,
1357 a->compressed_rsrc_position_v - RSRC_H_SIZE);
1358 archive_le32enc(a->decmpfs_block_info++, bytes_compressed);
1359 a->compressed_rsrc_position_v += bytes_compressed;
1362 * Write the compressed data to the resource fork.
1364 bytes_used = a->compressed_buffer_size - a->compressed_buffer_remaining;
1365 while (bytes_used >= COMPRESSED_W_SIZE) {
1366 ret = hfs_write_compressed_data(a, COMPRESSED_W_SIZE);
1367 if (ret != ARCHIVE_OK)
1369 bytes_used -= COMPRESSED_W_SIZE;
1370 if (bytes_used > COMPRESSED_W_SIZE)
1371 memmove(a->compressed_buffer,
1372 a->compressed_buffer + COMPRESSED_W_SIZE,
1375 memcpy(a->compressed_buffer,
1376 a->compressed_buffer + COMPRESSED_W_SIZE,
1379 a->compressed_buffer_remaining = a->compressed_buffer_size - bytes_used;
1382 * If the current block is the last block, write the remaining
1383 * compressed data and the resource fork footer.
1385 if (a->file_remaining_bytes == 0) {
1389 /* Append the resource footer. */
1390 rsrc_size = hfs_set_resource_fork_footer(
1391 a->compressed_buffer + bytes_used,
1392 a->compressed_buffer_remaining);
1393 ret = hfs_write_compressed_data(a, bytes_used + rsrc_size);
1394 a->compressed_buffer_remaining = a->compressed_buffer_size;
1396 /* If the compressed size is not enough smaller than
1397 * the uncompressed size. cancel HFS+ compression.
1398 * TODO: study a behavior of ditto utility and improve
1399 * the condition to fall back into no HFS+ compression. */
1400 bk = HFS_BLOCKS(a->compressed_rsrc_position);
1402 if (bk > HFS_BLOCKS(a->filesize))
1403 return hfs_decompress(a);
1405 * Write the resourcefork header.
1407 if (ret == ARCHIVE_OK)
1408 ret = hfs_write_resource_fork_header(a);
1410 * Finish HFS+ Compression.
1411 * - Write the decmpfs xattr.
1412 * - Set the UF_COMPRESSED file flag.
1414 if (ret == ARCHIVE_OK)
1415 ret = hfs_write_decmpfs(a);
1416 if (ret == ARCHIVE_OK)
1417 ret = hfs_set_compressed_fflag(a);
1423 hfs_write_decmpfs_block(struct archive_write_disk *a, const char *buff,
1426 const char *buffer_to_write;
1427 size_t bytes_to_write;
1430 if (a->decmpfs_block_count == (unsigned)-1) {
1433 unsigned int block_count;
1435 if (a->decmpfs_header_p == NULL) {
1436 new_block = malloc(MAX_DECMPFS_XATTR_SIZE
1437 + sizeof(uint32_t));
1438 if (new_block == NULL) {
1439 archive_set_error(&a->archive, ENOMEM,
1440 "Can't allocate memory for decmpfs");
1441 return (ARCHIVE_FATAL);
1443 a->decmpfs_header_p = new_block;
1445 a->decmpfs_attr_size = DECMPFS_HEADER_SIZE;
1446 archive_le32enc(&a->decmpfs_header_p[DECMPFS_COMPRESSION_MAGIC],
1448 archive_le32enc(&a->decmpfs_header_p[DECMPFS_COMPRESSION_TYPE],
1450 archive_le64enc(&a->decmpfs_header_p[DECMPFS_UNCOMPRESSED_SIZE],
1453 /* Calculate a block count of the file. */
1455 (a->filesize + MAX_DECMPFS_BLOCK_SIZE -1) /
1456 MAX_DECMPFS_BLOCK_SIZE;
1458 * Allocate buffer for resource fork.
1459 * Set up related pointers;
1462 RSRC_H_SIZE + /* header */
1463 4 + /* Block count */
1464 (block_count * sizeof(uint32_t) * 2) +
1465 RSRC_F_SIZE; /* footer */
1466 if (new_size > a->resource_fork_allocated_size) {
1467 new_block = realloc(a->resource_fork, new_size);
1468 if (new_block == NULL) {
1469 archive_set_error(&a->archive, ENOMEM,
1470 "Can't allocate memory for ResourceFork");
1471 return (ARCHIVE_FATAL);
1473 a->resource_fork_allocated_size = new_size;
1474 a->resource_fork = new_block;
1477 /* Allocate uncompressed buffer */
1478 if (a->uncompressed_buffer == NULL) {
1479 new_block = malloc(MAX_DECMPFS_BLOCK_SIZE);
1480 if (new_block == NULL) {
1481 archive_set_error(&a->archive, ENOMEM,
1482 "Can't allocate memory for decmpfs");
1483 return (ARCHIVE_FATAL);
1485 a->uncompressed_buffer = new_block;
1487 a->block_remaining_bytes = MAX_DECMPFS_BLOCK_SIZE;
1488 a->file_remaining_bytes = a->filesize;
1489 a->compressed_buffer_remaining = a->compressed_buffer_size;
1492 * Set up a resource fork.
1494 a->rsrc_xattr_options = XATTR_CREATE;
1495 /* Get the position where we are going to set a bunch
1497 a->decmpfs_block_info =
1498 (uint32_t *)(a->resource_fork + RSRC_H_SIZE);
1499 /* Set the block count to the resource fork. */
1500 archive_le32enc(a->decmpfs_block_info++, block_count);
1501 /* Get the position where we are going to set compressed
1503 a->compressed_rsrc_position =
1504 RSRC_H_SIZE + 4 + (block_count * 8);
1505 a->compressed_rsrc_position_v = a->compressed_rsrc_position;
1506 a->decmpfs_block_count = block_count;
1509 /* Ignore redundant bytes. */
1510 if (a->file_remaining_bytes == 0)
1511 return ((ssize_t)size);
1513 /* Do not overrun a block size. */
1514 if (size > a->block_remaining_bytes)
1515 bytes_to_write = a->block_remaining_bytes;
1517 bytes_to_write = size;
1518 /* Do not overrun the file size. */
1519 if (bytes_to_write > a->file_remaining_bytes)
1520 bytes_to_write = a->file_remaining_bytes;
1522 /* For efficiency, if a copy length is full of the uncompressed
1523 * buffer size, do not copy writing data to it. */
1524 if (bytes_to_write == MAX_DECMPFS_BLOCK_SIZE)
1525 buffer_to_write = buff;
1527 memcpy(a->uncompressed_buffer +
1528 MAX_DECMPFS_BLOCK_SIZE - a->block_remaining_bytes,
1529 buff, bytes_to_write);
1530 buffer_to_write = a->uncompressed_buffer;
1532 a->block_remaining_bytes -= bytes_to_write;
1533 a->file_remaining_bytes -= bytes_to_write;
1535 if (a->block_remaining_bytes == 0 || a->file_remaining_bytes == 0) {
1536 ret = hfs_drive_compressor(a, buffer_to_write,
1537 MAX_DECMPFS_BLOCK_SIZE - a->block_remaining_bytes);
1540 a->block_remaining_bytes = MAX_DECMPFS_BLOCK_SIZE;
1542 /* Ignore redundant bytes. */
1543 if (a->file_remaining_bytes == 0)
1544 return ((ssize_t)size);
1545 return (bytes_to_write);
1549 hfs_write_data_block(struct archive_write_disk *a, const char *buff,
1552 uint64_t start_size = size;
1553 ssize_t bytes_written = 0;
1554 ssize_t bytes_to_write;
1557 return (ARCHIVE_OK);
1559 if (a->filesize == 0 || a->fd < 0) {
1560 archive_set_error(&a->archive, 0,
1561 "Attempt to write to an empty file");
1562 return (ARCHIVE_WARN);
1565 /* If this write would run beyond the file size, truncate it. */
1566 if (a->filesize >= 0 && (int64_t)(a->offset + size) > a->filesize)
1567 start_size = size = (size_t)(a->filesize - a->offset);
1569 /* Write the data. */
1571 bytes_to_write = size;
1572 /* Seek if necessary to the specified offset. */
1573 if (a->offset < a->fd_offset) {
1574 /* Can't support backward move. */
1575 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
1577 return (ARCHIVE_FATAL);
1578 } else if (a->offset > a->fd_offset) {
1579 int64_t skip = a->offset - a->fd_offset;
1580 char nullblock[1024];
1582 memset(nullblock, 0, sizeof(nullblock));
1584 if (skip > (int64_t)sizeof(nullblock))
1585 bytes_written = hfs_write_decmpfs_block(
1586 a, nullblock, sizeof(nullblock));
1588 bytes_written = hfs_write_decmpfs_block(
1589 a, nullblock, skip);
1590 if (bytes_written < 0) {
1591 archive_set_error(&a->archive, errno,
1593 return (ARCHIVE_WARN);
1595 skip -= bytes_written;
1598 a->fd_offset = a->offset;
1601 hfs_write_decmpfs_block(a, buff, bytes_to_write);
1602 if (bytes_written < 0)
1603 return (bytes_written);
1604 buff += bytes_written;
1605 size -= bytes_written;
1606 a->total_bytes_written += bytes_written;
1607 a->offset += bytes_written;
1608 a->fd_offset = a->offset;
1610 return (start_size - size);
1614 hfs_write_data_block(struct archive_write_disk *a, const char *buff,
1617 return (write_data_block(a, buff, size));
1622 _archive_write_disk_data_block(struct archive *_a,
1623 const void *buff, size_t size, int64_t offset)
1625 struct archive_write_disk *a = (struct archive_write_disk *)_a;
1628 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
1629 ARCHIVE_STATE_DATA, "archive_write_data_block");
1632 if (a->todo & TODO_HFS_COMPRESSION)
1633 r = hfs_write_data_block(a, buff, size);
1635 r = write_data_block(a, buff, size);
1638 if ((size_t)r < size) {
1639 archive_set_error(&a->archive, 0,
1640 "Too much data: Truncating file at %ju bytes",
1641 (uintmax_t)a->filesize);
1642 return (ARCHIVE_WARN);
1644 #if ARCHIVE_VERSION_NUMBER < 3999000
1645 return (ARCHIVE_OK);
1652 _archive_write_disk_data(struct archive *_a, const void *buff, size_t size)
1654 struct archive_write_disk *a = (struct archive_write_disk *)_a;
1656 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
1657 ARCHIVE_STATE_DATA, "archive_write_data");
1659 if (a->todo & TODO_HFS_COMPRESSION)
1660 return (hfs_write_data_block(a, buff, size));
1661 return (write_data_block(a, buff, size));
1665 _archive_write_disk_finish_entry(struct archive *_a)
1667 struct archive_write_disk *a = (struct archive_write_disk *)_a;
1668 int ret = ARCHIVE_OK;
1670 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
1671 ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
1672 "archive_write_finish_entry");
1673 if (a->archive.state & ARCHIVE_STATE_HEADER)
1674 return (ARCHIVE_OK);
1675 archive_clear_error(&a->archive);
1677 /* Pad or truncate file to the right size. */
1679 /* There's no file. */
1680 } else if (a->filesize < 0) {
1681 /* File size is unknown, so we can't set the size. */
1682 } else if (a->fd_offset == a->filesize) {
1683 /* Last write ended at exactly the filesize; we're done. */
1684 /* Hopefully, this is the common case. */
1685 #if defined(__APPLE__) && defined(UF_COMPRESSED) && defined(HAVE_ZLIB_H)
1686 } else if (a->todo & TODO_HFS_COMPRESSION) {
1690 if (a->file_remaining_bytes)
1691 memset(null_d, 0, sizeof(null_d));
1692 while (a->file_remaining_bytes) {
1693 if (a->file_remaining_bytes > sizeof(null_d))
1694 r = hfs_write_data_block(
1695 a, null_d, sizeof(null_d));
1697 r = hfs_write_data_block(
1698 a, null_d, a->file_remaining_bytes);
1705 if (ftruncate(a->fd, a->filesize) == -1 &&
1707 archive_set_error(&a->archive, errno,
1708 "File size could not be restored");
1709 return (ARCHIVE_FAILED);
1713 * Not all platforms implement the XSI option to
1714 * extend files via ftruncate. Stat() the file again
1715 * to see what happened.
1718 if ((ret = lazy_stat(a)) != ARCHIVE_OK)
1720 /* We can use lseek()/write() to extend the file if
1721 * ftruncate didn't work or isn't available. */
1722 if (a->st.st_size < a->filesize) {
1723 const char nul = '\0';
1724 if (lseek(a->fd, a->filesize - 1, SEEK_SET) < 0) {
1725 archive_set_error(&a->archive, errno,
1727 return (ARCHIVE_FATAL);
1729 if (write(a->fd, &nul, 1) < 0) {
1730 archive_set_error(&a->archive, errno,
1731 "Write to restore size failed");
1732 return (ARCHIVE_FATAL);
1738 /* Restore metadata. */
1741 * This is specific to Mac OS X.
1742 * If the current file is an AppleDouble file, it should be
1743 * linked with the data fork file and remove it.
1745 if (a->todo & TODO_APPLEDOUBLE) {
1746 int r2 = fixup_appledouble(a, a->name);
1747 if (r2 == ARCHIVE_EOF) {
1748 /* The current file has been successfully linked
1749 * with the data fork file and removed. So there
1750 * is nothing to do on the current file. */
1751 goto finish_metadata;
1753 if (r2 < ret) ret = r2;
1757 * Look up the "real" UID only if we're going to need it.
1758 * TODO: the TODO_SGID condition can be dropped here, can't it?
1760 if (a->todo & (TODO_OWNER | TODO_SUID | TODO_SGID)) {
1761 a->uid = archive_write_disk_uid(&a->archive,
1762 archive_entry_uname(a->entry),
1763 archive_entry_uid(a->entry));
1765 /* Look up the "real" GID only if we're going to need it. */
1766 /* TODO: the TODO_SUID condition can be dropped here, can't it? */
1767 if (a->todo & (TODO_OWNER | TODO_SGID | TODO_SUID)) {
1768 a->gid = archive_write_disk_gid(&a->archive,
1769 archive_entry_gname(a->entry),
1770 archive_entry_gid(a->entry));
1774 * Restore ownership before set_mode tries to restore suid/sgid
1775 * bits. If we set the owner, we know what it is and can skip
1776 * a stat() call to examine the ownership of the file on disk.
1778 if (a->todo & TODO_OWNER) {
1779 int r2 = set_ownership(a);
1780 if (r2 < ret) ret = r2;
1785 * If we're not root, we won't be setting any security
1786 * attributes that may be wiped by the set_mode() routine
1787 * below. We also can't set xattr on non-owner-writable files,
1788 * which may be the state after set_mode(). Perform
1789 * set_xattrs() first based on these constraints.
1791 if (a->user_uid != 0 &&
1792 (a->todo & TODO_XATTR)) {
1793 int r2 = set_xattrs(a);
1794 if (r2 < ret) ret = r2;
1798 * set_mode must precede ACLs on systems such as Solaris and
1799 * FreeBSD where setting the mode implicitly clears extended ACLs
1801 if (a->todo & TODO_MODE) {
1802 int r2 = set_mode(a, a->mode);
1803 if (r2 < ret) ret = r2;
1807 * Security-related extended attributes (such as
1808 * security.capability on Linux) have to be restored last,
1809 * since they're implicitly removed by other file changes.
1810 * We do this last only when root.
1812 if (a->user_uid == 0 &&
1813 (a->todo & TODO_XATTR)) {
1814 int r2 = set_xattrs(a);
1815 if (r2 < ret) ret = r2;
1819 * Some flags prevent file modification; they must be restored after
1820 * file contents are written.
1822 if (a->todo & TODO_FFLAGS) {
1823 int r2 = set_fflags(a);
1824 if (r2 < ret) ret = r2;
1828 * Time must follow most other metadata;
1829 * otherwise atime will get changed.
1831 if (a->todo & TODO_TIMES) {
1832 int r2 = set_times_from_entry(a);
1833 if (r2 < ret) ret = r2;
1837 * Mac extended metadata includes ACLs.
1839 if (a->todo & TODO_MAC_METADATA) {
1840 const void *metadata;
1841 size_t metadata_size;
1842 metadata = archive_entry_mac_metadata(a->entry, &metadata_size);
1843 if (metadata != NULL && metadata_size > 0) {
1844 int r2 = set_mac_metadata(a, archive_entry_pathname(
1845 a->entry), metadata, metadata_size);
1846 if (r2 < ret) ret = r2;
1851 * ACLs must be restored after timestamps because there are
1852 * ACLs that prevent attribute changes (including time).
1854 if (a->todo & TODO_ACLS) {
1856 r2 = archive_write_disk_set_acls(&a->archive, a->fd,
1857 archive_entry_pathname(a->entry),
1858 archive_entry_acl(a->entry),
1859 archive_entry_mode(a->entry));
1860 if (r2 < ret) ret = r2;
1864 /* If there's an fd, we can close it now. */
1869 if (rename(a->tmpname, a->name) == -1) {
1870 archive_set_error(&a->archive, errno,
1871 "Failed to rename temporary file");
1872 ret = ARCHIVE_FAILED;
1878 /* If there's an entry, we can release it now. */
1879 archive_entry_free(a->entry);
1881 a->archive.state = ARCHIVE_STATE_HEADER;
1886 archive_write_disk_set_group_lookup(struct archive *_a,
1888 la_int64_t (*lookup_gid)(void *private, const char *gname, la_int64_t gid),
1889 void (*cleanup_gid)(void *private))
1891 struct archive_write_disk *a = (struct archive_write_disk *)_a;
1892 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
1893 ARCHIVE_STATE_ANY, "archive_write_disk_set_group_lookup");
1895 if (a->cleanup_gid != NULL && a->lookup_gid_data != NULL)
1896 (a->cleanup_gid)(a->lookup_gid_data);
1898 a->lookup_gid = lookup_gid;
1899 a->cleanup_gid = cleanup_gid;
1900 a->lookup_gid_data = private_data;
1901 return (ARCHIVE_OK);
1905 archive_write_disk_set_user_lookup(struct archive *_a,
1907 int64_t (*lookup_uid)(void *private, const char *uname, int64_t uid),
1908 void (*cleanup_uid)(void *private))
1910 struct archive_write_disk *a = (struct archive_write_disk *)_a;
1911 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
1912 ARCHIVE_STATE_ANY, "archive_write_disk_set_user_lookup");
1914 if (a->cleanup_uid != NULL && a->lookup_uid_data != NULL)
1915 (a->cleanup_uid)(a->lookup_uid_data);
1917 a->lookup_uid = lookup_uid;
1918 a->cleanup_uid = cleanup_uid;
1919 a->lookup_uid_data = private_data;
1920 return (ARCHIVE_OK);
1924 archive_write_disk_gid(struct archive *_a, const char *name, la_int64_t id)
1926 struct archive_write_disk *a = (struct archive_write_disk *)_a;
1927 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
1928 ARCHIVE_STATE_ANY, "archive_write_disk_gid");
1930 return (a->lookup_gid)(a->lookup_gid_data, name, id);
1935 archive_write_disk_uid(struct archive *_a, const char *name, la_int64_t id)
1937 struct archive_write_disk *a = (struct archive_write_disk *)_a;
1938 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
1939 ARCHIVE_STATE_ANY, "archive_write_disk_uid");
1941 return (a->lookup_uid)(a->lookup_uid_data, name, id);
1946 * Create a new archive_write_disk object and initialize it with global state.
1949 archive_write_disk_new(void)
1951 struct archive_write_disk *a;
1953 a = (struct archive_write_disk *)calloc(1, sizeof(*a));
1956 a->archive.magic = ARCHIVE_WRITE_DISK_MAGIC;
1957 /* We're ready to write a header immediately. */
1958 a->archive.state = ARCHIVE_STATE_HEADER;
1959 a->archive.vtable = archive_write_disk_vtable();
1960 a->start_time = time(NULL);
1961 /* Query and restore the umask. */
1962 umask(a->user_umask = umask(0));
1964 a->user_uid = geteuid();
1965 #endif /* HAVE_GETEUID */
1966 if (archive_string_ensure(&a->path_safe, 512) == NULL) {
1971 a->decmpfs_compression_level = 5;
1973 return (&a->archive);
1978 * If pathname is longer than PATH_MAX, chdir to a suitable
1979 * intermediate dir and edit the path down to a shorter suffix. Note
1980 * that this routine never returns an error; if the chdir() attempt
1981 * fails for any reason, we just go ahead with the long pathname. The
1982 * object creation is likely to fail, but any error will get handled
1985 #if defined(HAVE_FCHDIR) && defined(PATH_MAX)
1987 edit_deep_directories(struct archive_write_disk *a)
1990 char *tail = a->name;
1992 /* If path is short, avoid the open() below. */
1993 if (strlen(tail) < PATH_MAX)
1996 /* Try to record our starting dir. */
1997 a->restore_pwd = la_opendirat(AT_FDCWD, ".");
1998 __archive_ensure_cloexec_flag(a->restore_pwd);
1999 if (a->restore_pwd < 0)
2002 /* As long as the path is too long... */
2003 while (strlen(tail) >= PATH_MAX) {
2004 /* Locate a dir prefix shorter than PATH_MAX. */
2005 tail += PATH_MAX - 8;
2006 while (tail > a->name && *tail != '/')
2008 /* Exit if we find a too-long path component. */
2009 if (tail <= a->name)
2011 /* Create the intermediate dir and chdir to it. */
2012 *tail = '\0'; /* Terminate dir portion */
2013 ret = create_dir(a, a->name);
2014 if (ret == ARCHIVE_OK && chdir(a->name) != 0)
2015 ret = ARCHIVE_FAILED;
2016 *tail = '/'; /* Restore the / we removed. */
2017 if (ret != ARCHIVE_OK)
2020 /* The chdir() succeeded; we've now shortened the path. */
2028 * The main restore function.
2031 restore_entry(struct archive_write_disk *a)
2033 int ret = ARCHIVE_OK, en;
2035 if (a->flags & ARCHIVE_EXTRACT_UNLINK && !S_ISDIR(a->mode)) {
2037 * TODO: Fix this. Apparently, there are platforms
2038 * that still allow root to hose the entire filesystem
2039 * by unlinking a dir. The S_ISDIR() test above
2040 * prevents us from using unlink() here if the new
2041 * object is a dir, but that doesn't mean the old
2042 * object isn't a dir.
2044 if (a->flags & ARCHIVE_EXTRACT_CLEAR_NOCHANGE_FFLAGS)
2045 (void)clear_nochange_fflags(a);
2046 if (unlink(a->name) == 0) {
2047 /* We removed it, reset cached stat. */
2049 } else if (errno == ENOENT) {
2050 /* File didn't exist, that's just as good. */
2051 } else if (rmdir(a->name) == 0) {
2052 /* It was a dir, but now it's gone. */
2055 /* We tried, but couldn't get rid of it. */
2056 archive_set_error(&a->archive, errno,
2057 "Could not unlink");
2058 return(ARCHIVE_FAILED);
2062 /* Try creating it first; if this fails, we'll try to recover. */
2063 en = create_filesystem_object(a);
2065 if ((en == ENOTDIR || en == ENOENT)
2066 && !(a->flags & ARCHIVE_EXTRACT_NO_AUTODIR)) {
2067 /* If the parent dir doesn't exist, try creating it. */
2068 create_parent_dir(a, a->name);
2069 /* Now try to create the object again. */
2070 en = create_filesystem_object(a);
2073 if ((en == ENOENT) && (archive_entry_hardlink(a->entry) != NULL)) {
2074 archive_set_error(&a->archive, en,
2075 "Hard-link target '%s' does not exist.",
2076 archive_entry_hardlink(a->entry));
2077 return (ARCHIVE_FAILED);
2080 if ((en == EISDIR || en == EEXIST)
2081 && (a->flags & ARCHIVE_EXTRACT_NO_OVERWRITE)) {
2082 /* If we're not overwriting, we're done. */
2083 if (S_ISDIR(a->mode)) {
2084 /* Don't overwrite any settings on existing directories. */
2087 archive_entry_unset_size(a->entry);
2088 return (ARCHIVE_OK);
2092 * Some platforms return EISDIR if you call
2093 * open(O_WRONLY | O_EXCL | O_CREAT) on a directory, some
2094 * return EEXIST. POSIX is ambiguous, requiring EISDIR
2095 * for open(O_WRONLY) on a dir and EEXIST for open(O_EXCL | O_CREAT)
2096 * on an existing item.
2099 /* A dir is in the way of a non-dir, rmdir it. */
2100 if (rmdir(a->name) != 0) {
2101 archive_set_error(&a->archive, errno,
2102 "Can't remove already-existing dir");
2103 return (ARCHIVE_FAILED);
2107 en = create_filesystem_object(a);
2108 } else if (en == EEXIST) {
2110 * We know something is in the way, but we don't know what;
2111 * we need to find out before we go any further.
2115 * The SECURE_SYMLINKS logic has already removed a
2116 * symlink to a dir if the client wants that. So
2117 * follow the symlink if we're creating a dir.
2119 if (S_ISDIR(a->mode))
2120 r = la_stat(a->name, &a->st);
2122 * If it's not a dir (or it's a broken symlink),
2123 * then don't follow it.
2125 if (r != 0 || !S_ISDIR(a->mode))
2126 r = lstat(a->name, &a->st);
2128 archive_set_error(&a->archive, errno,
2129 "Can't stat existing object");
2130 return (ARCHIVE_FAILED);
2134 * NO_OVERWRITE_NEWER doesn't apply to directories.
2136 if ((a->flags & ARCHIVE_EXTRACT_NO_OVERWRITE_NEWER)
2137 && !S_ISDIR(a->st.st_mode)) {
2138 if (!older(&(a->st), a->entry)) {
2139 archive_entry_unset_size(a->entry);
2140 return (ARCHIVE_OK);
2144 /* If it's our archive, we're done. */
2145 if (a->skip_file_set &&
2146 a->st.st_dev == (dev_t)a->skip_file_dev &&
2147 a->st.st_ino == (ino_t)a->skip_file_ino) {
2148 archive_set_error(&a->archive, 0,
2149 "Refusing to overwrite archive");
2150 return (ARCHIVE_FAILED);
2153 if (!S_ISDIR(a->st.st_mode)) {
2154 if (a->flags & ARCHIVE_EXTRACT_CLEAR_NOCHANGE_FFLAGS)
2155 (void)clear_nochange_fflags(a);
2157 if ((a->flags & ARCHIVE_EXTRACT_SAFE_WRITES) &&
2158 S_ISREG(a->st.st_mode)) {
2159 /* Use a temporary file to extract */
2160 if ((a->fd = la_mktemp(a)) == -1) {
2161 archive_set_error(&a->archive, errno,
2162 "Can't create temporary file");
2163 return ARCHIVE_FAILED;
2168 /* A non-dir is in the way, unlink it. */
2169 if (unlink(a->name) != 0) {
2170 archive_set_error(&a->archive, errno,
2171 "Can't unlink already-existing "
2173 return (ARCHIVE_FAILED);
2177 en = create_filesystem_object(a);
2179 } else if (!S_ISDIR(a->mode)) {
2180 /* A dir is in the way of a non-dir, rmdir it. */
2181 if (a->flags & ARCHIVE_EXTRACT_CLEAR_NOCHANGE_FFLAGS)
2182 (void)clear_nochange_fflags(a);
2183 if (rmdir(a->name) != 0) {
2184 archive_set_error(&a->archive, errno,
2185 "Can't replace existing directory with non-directory");
2186 return (ARCHIVE_FAILED);
2189 en = create_filesystem_object(a);
2192 * There's a dir in the way of a dir. Don't
2193 * waste time with rmdir()/mkdir(), just fix
2194 * up the permissions on the existing dir.
2195 * Note that we don't change perms on existing
2196 * dirs unless _EXTRACT_PERM is specified.
2198 if ((a->mode != a->st.st_mode)
2199 && (a->todo & TODO_MODE_FORCE))
2200 a->deferred |= (a->todo & TODO_MODE);
2201 /* Ownership doesn't need deferred fixup. */
2202 en = 0; /* Forget the EEXIST. */
2207 /* Everything failed; give up here. */
2208 if ((&a->archive)->error == NULL)
2209 archive_set_error(&a->archive, en, "Can't create '%s'",
2211 return (ARCHIVE_FAILED);
2214 a->pst = NULL; /* Cached stat data no longer valid. */
2219 * Returns 0 if creation succeeds, or else returns errno value from
2220 * the failed system call. Note: This function should only ever perform
2221 * a single system call.
2224 create_filesystem_object(struct archive_write_disk *a)
2226 /* Create the entry. */
2227 const char *linkname;
2228 mode_t final_mode, mode;
2230 /* these for check_symlinks_fsobj */
2231 char *linkname_copy; /* non-const copy of linkname */
2233 struct archive_string error_string;
2236 /* We identify hard/symlinks according to the link names. */
2237 /* Since link(2) and symlink(2) don't handle modes, we're done here. */
2238 linkname = archive_entry_hardlink(a->entry);
2239 if (linkname != NULL) {
2243 archive_string_init(&error_string);
2244 linkname_copy = strdup(linkname);
2245 if (linkname_copy == NULL) {
2249 * TODO: consider using the cleaned-up path as the link
2252 r = cleanup_pathname_fsobj(linkname_copy, &error_number,
2253 &error_string, a->flags);
2254 if (r != ARCHIVE_OK) {
2255 archive_set_error(&a->archive, error_number, "%s",
2257 free(linkname_copy);
2258 archive_string_free(&error_string);
2260 * EPERM is more appropriate than error_number for our
2265 r = check_symlinks_fsobj(linkname_copy, &error_number,
2266 &error_string, a->flags);
2267 if (r != ARCHIVE_OK) {
2268 archive_set_error(&a->archive, error_number, "%s",
2270 free(linkname_copy);
2271 archive_string_free(&error_string);
2273 * EPERM is more appropriate than error_number for our
2278 free(linkname_copy);
2279 archive_string_free(&error_string);
2281 * Unlinking and linking here is really not atomic,
2282 * but doing it right, would require us to construct
2283 * an mktemplink() function, and then use rename(2).
2285 if (a->flags & ARCHIVE_EXTRACT_SAFE_WRITES)
2287 r = link(linkname, a->name) ? errno : 0;
2289 * New cpio and pax formats allow hardlink entries
2290 * to carry data, so we may have to open the file
2291 * for hardlink entries.
2293 * If the hardlink was successfully created and
2294 * the archive doesn't have carry data for it,
2295 * consider it to be non-authoritative for meta data.
2296 * This is consistent with GNU tar and BSD pax.
2297 * If the hardlink does carry data, let the last
2298 * archive entry decide ownership.
2300 if (r == 0 && a->filesize <= 0) {
2303 } else if (r == 0 && a->filesize > 0) {
2305 r = lstat(a->name, &st);
2307 r = la_stat(a->name, &st);
2311 else if ((st.st_mode & AE_IFMT) == AE_IFREG) {
2312 a->fd = open(a->name, O_WRONLY | O_TRUNC |
2313 O_BINARY | O_CLOEXEC | O_NOFOLLOW);
2314 __archive_ensure_cloexec_flag(a->fd);
2322 linkname = archive_entry_symlink(a->entry);
2323 if (linkname != NULL) {
2326 * Unlinking and linking here is really not atomic,
2327 * but doing it right, would require us to construct
2328 * an mktempsymlink() function, and then use rename(2).
2330 if (a->flags & ARCHIVE_EXTRACT_SAFE_WRITES)
2332 return symlink(linkname, a->name) ? errno : 0;
2339 * The remaining system calls all set permissions, so let's
2340 * try to take advantage of that to avoid an extra chmod()
2341 * call. (Recall that umask is set to zero right now!)
2344 /* Mode we want for the final restored object (w/o file type bits). */
2345 final_mode = a->mode & 07777;
2347 * The mode that will actually be restored in this step. Note
2348 * that SUID, SGID, etc, require additional work to ensure
2349 * security, so we never restore them at this point.
2351 mode = final_mode & 0777 & ~a->user_umask;
2354 * Always create writable such that [f]setxattr() works if we're not
2357 if (a->user_uid != 0 &&
2358 a->todo & (TODO_HFS_COMPRESSION | TODO_XATTR)) {
2362 switch (a->mode & AE_IFMT) {
2364 /* POSIX requires that we fall through here. */
2368 a->fd = open(a->name,
2369 O_WRONLY | O_CREAT | O_EXCL | O_BINARY | O_CLOEXEC, mode);
2370 __archive_ensure_cloexec_flag(a->fd);
2375 /* Note: we use AE_IFCHR for the case label, and
2376 * S_IFCHR for the mknod() call. This is correct. */
2377 r = mknod(a->name, mode | S_IFCHR,
2378 archive_entry_rdev(a->entry));
2381 /* TODO: Find a better way to warn about our inability
2382 * to restore a char device node. */
2384 #endif /* HAVE_MKNOD */
2387 r = mknod(a->name, mode | S_IFBLK,
2388 archive_entry_rdev(a->entry));
2391 /* TODO: Find a better way to warn about our inability
2392 * to restore a block device node. */
2394 #endif /* HAVE_MKNOD */
2396 mode = (mode | MINIMUM_DIR_MODE) & MAXIMUM_DIR_MODE;
2397 r = mkdir(a->name, mode);
2399 /* Defer setting dir times. */
2400 a->deferred |= (a->todo & TODO_TIMES);
2401 a->todo &= ~TODO_TIMES;
2402 /* Never use an immediate chmod(). */
2403 /* We can't avoid the chmod() entirely if EXTRACT_PERM
2404 * because of SysV SGID inheritance. */
2405 if ((mode != final_mode)
2406 || (a->flags & ARCHIVE_EXTRACT_PERM))
2407 a->deferred |= (a->todo & TODO_MODE);
2408 a->todo &= ~TODO_MODE;
2413 r = mkfifo(a->name, mode);
2416 /* TODO: Find a better way to warn about our inability
2417 * to restore a fifo. */
2419 #endif /* HAVE_MKFIFO */
2422 /* All the system calls above set errno on failure. */
2426 /* If we managed to set the final mode, we've avoided a chmod(). */
2427 if (mode == final_mode)
2428 a->todo &= ~TODO_MODE;
2433 * Cleanup function for archive_extract. Mostly, this involves processing
2434 * the fixup list, which is used to address a number of problems:
2435 * * Dir permissions might prevent us from restoring a file in that
2436 * dir, so we restore the dir with minimum 0700 permissions first,
2437 * then correct the mode at the end.
2438 * * Similarly, the act of restoring a file touches the directory
2439 * and changes the timestamp on the dir, so we have to touch-up dir
2440 * timestamps at the end as well.
2441 * * Some file flags can interfere with the restore by, for example,
2442 * preventing the creation of hardlinks to those files.
2443 * * Mac OS extended metadata includes ACLs, so must be deferred on dirs.
2445 * Note that tar/cpio do not require that archives be in a particular
2446 * order; there is no way to know when the last file has been restored
2447 * within a directory, so there's no way to optimize the memory usage
2448 * here by fixing up the directory any earlier than the
2451 * XXX TODO: Directory ACLs should be restored here, for the same
2452 * reason we set directory perms here. XXX
2455 _archive_write_disk_close(struct archive *_a)
2457 struct archive_write_disk *a = (struct archive_write_disk *)_a;
2458 struct fixup_entry *next, *p;
2461 archive_check_magic(&a->archive, ARCHIVE_WRITE_DISK_MAGIC,
2462 ARCHIVE_STATE_HEADER | ARCHIVE_STATE_DATA,
2463 "archive_write_disk_close");
2464 ret = _archive_write_disk_finish_entry(&a->archive);
2466 /* Sort dir list so directories are fixed up in depth-first order. */
2467 p = sort_dir_list(a->fixup_list);
2471 a->pst = NULL; /* Mark stat cache as out-of-date. */
2473 (TODO_TIMES | TODO_MODE_BASE | TODO_ACLS | TODO_FFLAGS)) {
2475 O_WRONLY | O_BINARY | O_NOFOLLOW | O_CLOEXEC);
2477 if (p->fixup & TODO_TIMES) {
2478 set_times(a, fd, p->mode, p->name,
2479 p->atime, p->atime_nanos,
2480 p->birthtime, p->birthtime_nanos,
2481 p->mtime, p->mtime_nanos,
2482 p->ctime, p->ctime_nanos);
2484 if (p->fixup & TODO_MODE_BASE) {
2487 fchmod(fd, p->mode);
2490 chmod(p->name, p->mode);
2492 if (p->fixup & TODO_ACLS)
2493 archive_write_disk_set_acls(&a->archive, fd,
2494 p->name, &p->acl, p->mode);
2495 if (p->fixup & TODO_FFLAGS)
2496 set_fflags_platform(a, fd, p->name,
2497 p->mode, p->fflags_set, 0);
2498 if (p->fixup & TODO_MAC_METADATA)
2499 set_mac_metadata(a, p->name, p->mac_metadata,
2500 p->mac_metadata_size);
2502 archive_acl_clear(&p->acl);
2503 free(p->mac_metadata);
2510 a->fixup_list = NULL;
2515 _archive_write_disk_free(struct archive *_a)
2517 struct archive_write_disk *a;
2520 return (ARCHIVE_OK);
2521 archive_check_magic(_a, ARCHIVE_WRITE_DISK_MAGIC,
2522 ARCHIVE_STATE_ANY | ARCHIVE_STATE_FATAL, "archive_write_disk_free");
2523 a = (struct archive_write_disk *)_a;
2524 ret = _archive_write_disk_close(&a->archive);
2525 archive_write_disk_set_group_lookup(&a->archive, NULL, NULL, NULL);
2526 archive_write_disk_set_user_lookup(&a->archive, NULL, NULL, NULL);
2527 archive_entry_free(a->entry);
2528 archive_string_free(&a->_name_data);
2529 archive_string_free(&a->_tmpname_data);
2530 archive_string_free(&a->archive.error_string);
2531 archive_string_free(&a->path_safe);
2532 a->archive.magic = 0;
2533 __archive_clean(&a->archive);
2534 free(a->decmpfs_header_p);
2535 free(a->resource_fork);
2536 free(a->compressed_buffer);
2537 free(a->uncompressed_buffer);
2538 #if defined(__APPLE__) && defined(UF_COMPRESSED) && defined(HAVE_SYS_XATTR_H)\
2539 && defined(HAVE_ZLIB_H)
2540 if (a->stream_valid) {
2541 switch (deflateEnd(&a->stream)) {
2545 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
2546 "Failed to clean up compressor");
2547 ret = ARCHIVE_FATAL;
2557 * Simple O(n log n) merge sort to order the fixup list. In
2558 * particular, we want to restore dir timestamps depth-first.
2560 static struct fixup_entry *
2561 sort_dir_list(struct fixup_entry *p)
2563 struct fixup_entry *a, *b, *t;
2567 /* A one-item list is already sorted. */
2568 if (p->next == NULL)
2571 /* Step 1: split the list. */
2575 /* Step a twice, t once. */
2581 /* Now, t is at the mid-point, so break the list here. */
2586 /* Step 2: Recursively sort the two sub-lists. */
2587 a = sort_dir_list(a);
2588 b = sort_dir_list(b);
2590 /* Step 3: Merge the returned lists. */
2591 /* Pick the first element for the merged list. */
2592 if (strcmp(a->name, b->name) > 0) {
2600 /* Always put the later element on the list first. */
2601 while (a != NULL && b != NULL) {
2602 if (strcmp(a->name, b->name) > 0) {
2612 /* Only one list is non-empty, so just splice it on. */
2622 * Returns a new, initialized fixup entry.
2624 * TODO: Reduce the memory requirements for this list by using a tree
2625 * structure rather than a simple list of names.
2627 static struct fixup_entry *
2628 new_fixup(struct archive_write_disk *a, const char *pathname)
2630 struct fixup_entry *fe;
2632 fe = (struct fixup_entry *)calloc(1, sizeof(struct fixup_entry));
2634 archive_set_error(&a->archive, ENOMEM,
2635 "Can't allocate memory for a fixup");
2638 fe->next = a->fixup_list;
2641 fe->name = strdup(pathname);
2646 * Returns a fixup structure for the current entry.
2648 static struct fixup_entry *
2649 current_fixup(struct archive_write_disk *a, const char *pathname)
2651 if (a->current_fixup == NULL)
2652 a->current_fixup = new_fixup(a, pathname);
2653 return (a->current_fixup);
2656 /* Error helper for new *_fsobj functions */
2658 fsobj_error(int *a_eno, struct archive_string *a_estr,
2659 int err, const char *errstr, const char *path)
2664 archive_string_sprintf(a_estr, "%s%s", errstr, path);
2668 * TODO: Someday, integrate this with the deep dir support; they both
2669 * scan the path and both can be optimized by comparing against other
2673 * Checks the given path to see if any elements along it are symlinks. Returns
2674 * ARCHIVE_OK if there are none, otherwise puts an error in errmsg.
2677 check_symlinks_fsobj(char *path, int *a_eno, struct archive_string *a_estr,
2680 #if !defined(HAVE_LSTAT) && \
2681 !(defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT))
2682 /* Platform doesn't have lstat, so we can't look for symlinks. */
2683 (void)path; /* UNUSED */
2684 (void)error_number; /* UNUSED */
2685 (void)error_string; /* UNUSED */
2686 (void)flags; /* UNUSED */
2687 return (ARCHIVE_OK);
2689 int res = ARCHIVE_OK;
2697 #if defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT)
2701 /* Nothing to do here if name is empty */
2703 return (ARCHIVE_OK);
2706 * Guard against symlink tricks. Reject any archive entry whose
2707 * destination would be altered by a symlink.
2709 * Walk the filename in chunks separated by '/'. For each segment:
2710 * - if it doesn't exist, continue
2711 * - if it's symlink, abort or remove it
2712 * - if it's a directory and it's not the last chunk, cd into it
2714 * head points to the current (relative) path
2715 * tail points to the temporary \0 terminating the segment we're
2716 * currently examining
2717 * c holds what used to be in *tail
2718 * last is 1 if this is the last tail
2720 chdir_fd = la_opendirat(AT_FDCWD, ".");
2721 __archive_ensure_cloexec_flag(chdir_fd);
2723 fsobj_error(a_eno, a_estr, errno,
2724 "Could not open ", path);
2725 return (ARCHIVE_FATAL);
2730 /* TODO: reintroduce a safe cache here? */
2731 /* Skip the root directory if the path is absolute. */
2732 if(tail == path && tail[0] == '/')
2734 /* Keep going until we've checked the entire name.
2735 * head, tail, path all alias the same string, which is
2736 * temporarily zeroed at tail, so be careful restoring the
2737 * stashed (c=tail[0]) for error messages.
2738 * Exiting the loop with break is okay; continue is not.
2742 * Skip the separator we just consumed, plus any adjacent ones
2744 while (*tail == '/')
2746 /* Skip the next path element. */
2747 while (*tail != '\0' && *tail != '/')
2749 /* is this the last path component? */
2750 last = (tail[0] == '\0') || (tail[0] == '/' && tail[1] == '\0');
2751 /* temporarily truncate the string here */
2754 /* Check that we haven't hit a symlink. */
2755 #if defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT)
2756 r = fstatat(chdir_fd, head, &st, AT_SYMLINK_NOFOLLOW);
2758 r = lstat(head, &st);
2762 /* We've hit a dir that doesn't exist; stop now. */
2763 if (errno == ENOENT) {
2767 * Treat any other error as fatal - best to be
2769 * Note: This effectively disables deep
2770 * directory support when security checks are
2771 * enabled. Otherwise, very long pathnames that
2772 * trigger an error here could evade the
2774 * TODO: We could do better, but it would
2775 * probably require merging the symlink checks
2776 * with the deep-directory editing.
2778 fsobj_error(a_eno, a_estr, errno,
2779 "Could not stat ", path);
2780 res = ARCHIVE_FAILED;
2783 } else if (S_ISDIR(st.st_mode)) {
2785 #if defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT)
2786 fd = la_opendirat(chdir_fd, head);
2799 fsobj_error(a_eno, a_estr, errno,
2800 "Could not chdir ", path);
2801 res = (ARCHIVE_FATAL);
2804 /* Our view is now from inside this dir: */
2807 } else if (S_ISLNK(st.st_mode)) {
2810 * Last element is symlink; remove it
2811 * so we can overwrite it with the
2812 * item being extracted.
2814 #if defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT)
2815 r = unlinkat(chdir_fd, head, 0);
2821 fsobj_error(a_eno, a_estr, errno,
2822 "Could not remove symlink ",
2824 res = ARCHIVE_FAILED;
2828 * Even if we did remove it, a warning
2829 * is in order. The warning is silly,
2830 * though, if we're just replacing one
2831 * symlink with another symlink.
2835 * FIXME: not sure how important this is to
2839 if (!S_ISLNK(path)) {
2840 fsobj_error(a_eno, a_estr, 0,
2841 "Removing symlink ", path);
2844 /* Symlink gone. No more problem! */
2847 } else if (flags & ARCHIVE_EXTRACT_UNLINK) {
2848 /* User asked us to remove problems. */
2849 #if defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT)
2850 r = unlinkat(chdir_fd, head, 0);
2856 fsobj_error(a_eno, a_estr, 0,
2857 "Cannot remove intervening "
2859 res = ARCHIVE_FAILED;
2864 ARCHIVE_EXTRACT_SECURE_SYMLINKS) == 0) {
2866 * We are not the last element and we want to
2867 * follow symlinks if they are a directory.
2869 * This is needed to extract hardlinks over
2872 #if defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT)
2873 r = fstatat(chdir_fd, head, &st, 0);
2875 r = la_stat(head, &st);
2879 if (errno == ENOENT) {
2882 fsobj_error(a_eno, a_estr,
2884 "Could not stat ", path);
2885 res = (ARCHIVE_FAILED);
2888 } else if (S_ISDIR(st.st_mode)) {
2889 #if defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT)
2890 fd = la_opendirat(chdir_fd, head);
2903 fsobj_error(a_eno, a_estr,
2905 "Could not chdir ", path);
2906 res = (ARCHIVE_FATAL);
2910 * Our view is now from inside
2916 fsobj_error(a_eno, a_estr, 0,
2917 "Cannot extract through "
2919 res = ARCHIVE_FAILED;
2924 fsobj_error(a_eno, a_estr, 0,
2925 "Cannot extract through symlink ", path);
2926 res = ARCHIVE_FAILED;
2930 /* be sure to always maintain this */
2932 if (tail[0] != '\0')
2933 tail++; /* Advance to the next segment. */
2935 /* Catches loop exits via break */
2937 #if defined(HAVE_OPENAT) && defined(HAVE_FSTATAT) && defined(HAVE_UNLINKAT)
2938 /* If we operate with openat(), fstatat() and unlinkat() there was
2939 * no chdir(), so just close the fd */
2943 /* If we changed directory above, restore it here. */
2944 if (chdir_fd >= 0) {
2945 r = fchdir(chdir_fd);
2947 fsobj_error(a_eno, a_estr, errno,
2948 "chdir() failure", "");
2953 res = (ARCHIVE_FATAL);
2957 /* TODO: reintroduce a safe cache here? */
2963 * Check a->name for symlinks, returning ARCHIVE_OK if its clean, otherwise
2964 * calls archive_set_error and returns ARCHIVE_{FATAL,FAILED}
2967 check_symlinks(struct archive_write_disk *a)
2969 struct archive_string error_string;
2972 archive_string_init(&error_string);
2973 rc = check_symlinks_fsobj(a->name, &error_number, &error_string,
2975 if (rc != ARCHIVE_OK) {
2976 archive_set_error(&a->archive, error_number, "%s",
2979 archive_string_free(&error_string);
2980 a->pst = NULL; /* to be safe */
2985 #if defined(__CYGWIN__)
2987 * 1. Convert a path separator from '\' to '/' .
2988 * We shouldn't check multibyte character directly because some
2989 * character-set have been using the '\' character for a part of
2990 * its multibyte character code.
2991 * 2. Replace unusable characters in Windows with underscore('_').
2992 * See also : http://msdn.microsoft.com/en-us/library/aa365247.aspx
2995 cleanup_pathname_win(char *path)
3000 int mb, complete, utf8;
3005 utf8 = (strcmp(nl_langinfo(CODESET), "UTF-8") == 0)? 1: 0;
3006 for (p = path; *p != '\0'; p++) {
3009 /* If previous byte is smaller than 128,
3010 * this is not second byte of multibyte characters,
3011 * so we can replace '\' with '/'. */
3015 complete = 0;/* uncompleted. */
3016 } else if (*(unsigned char *)p > 127)
3020 /* Rewrite the path name if its next character is unusable. */
3021 if (*p == ':' || *p == '*' || *p == '?' || *p == '"' ||
3022 *p == '<' || *p == '>' || *p == '|')
3029 * Convert path separator in wide-character.
3032 while (*p != '\0' && alen) {
3033 l = mbtowc(&wc, p, alen);
3034 if (l == (size_t)-1) {
3035 while (*p != '\0') {
3042 if (l == 1 && wc == L'\\')
3051 * Canonicalize the pathname. In particular, this strips duplicate
3052 * '/' characters, '.' elements, and trailing '/'. It also raises an
3053 * error for an empty path, a trailing '..', (if _SECURE_NODOTDOT is
3054 * set) any '..' in the path or (if ARCHIVE_EXTRACT_SECURE_NOABSOLUTEPATHS
3055 * is set) if the path is absolute.
3058 cleanup_pathname_fsobj(char *path, int *a_eno, struct archive_string *a_estr,
3062 char separator = '\0';
3066 fsobj_error(a_eno, a_estr, ARCHIVE_ERRNO_MISC,
3067 "Invalid empty ", "pathname");
3068 return (ARCHIVE_FAILED);
3071 #if defined(__CYGWIN__)
3072 cleanup_pathname_win(path);
3074 /* Skip leading '/'. */
3076 if (flags & ARCHIVE_EXTRACT_SECURE_NOABSOLUTEPATHS) {
3077 fsobj_error(a_eno, a_estr, ARCHIVE_ERRNO_MISC,
3078 "Path is ", "absolute");
3079 return (ARCHIVE_FAILED);
3085 /* Scan the pathname one element at a time. */
3087 /* src points to first char after '/' */
3088 if (src[0] == '\0') {
3090 } else if (src[0] == '/') {
3091 /* Found '//', ignore second one. */
3094 } else if (src[0] == '.') {
3095 if (src[1] == '\0') {
3096 /* Ignore trailing '.' */
3098 } else if (src[1] == '/') {
3102 } else if (src[1] == '.') {
3103 if (src[2] == '/' || src[2] == '\0') {
3104 /* Conditionally warn about '..' */
3106 & ARCHIVE_EXTRACT_SECURE_NODOTDOT) {
3107 fsobj_error(a_eno, a_estr,
3109 "Path contains ", "'..'");
3110 return (ARCHIVE_FAILED);
3114 * Note: Under no circumstances do we
3115 * remove '..' elements. In
3116 * particular, restoring
3117 * '/foo/../bar/' should create the
3118 * 'foo' dir as a side-effect.
3123 /* Copy current element, including leading '/'. */
3126 while (*src != '\0' && *src != '/') {
3133 /* Skip '/' separator. */
3137 * We've just copied zero or more path elements, not including the
3142 * Nothing got copied. The path must have been something
3143 * like '.' or '/' or './' or '/././././/./'.
3150 /* Terminate the result. */
3152 return (ARCHIVE_OK);
3156 cleanup_pathname(struct archive_write_disk *a)
3158 struct archive_string error_string;
3161 archive_string_init(&error_string);
3162 rc = cleanup_pathname_fsobj(a->name, &error_number, &error_string,
3164 if (rc != ARCHIVE_OK) {
3165 archive_set_error(&a->archive, error_number, "%s",
3168 archive_string_free(&error_string);
3173 * Create the parent directory of the specified path, assuming path
3174 * is already in mutable storage.
3177 create_parent_dir(struct archive_write_disk *a, char *path)
3182 /* Remove tail element to obtain parent name. */
3183 slash = strrchr(path, '/');
3185 return (ARCHIVE_OK);
3187 r = create_dir(a, path);
3193 * Create the specified dir, recursing to create parents as necessary.
3195 * Returns ARCHIVE_OK if the path exists when we're done here.
3196 * Otherwise, returns ARCHIVE_FAILED.
3197 * Assumes path is in mutable storage; path is unchanged on exit.
3200 create_dir(struct archive_write_disk *a, char *path)
3203 struct fixup_entry *le;
3205 mode_t mode_final, mode;
3208 /* Check for special names and just skip them. */
3209 slash = strrchr(path, '/');
3215 if (base[0] == '\0' ||
3216 (base[0] == '.' && base[1] == '\0') ||
3217 (base[0] == '.' && base[1] == '.' && base[2] == '\0')) {
3218 /* Don't bother trying to create null path, '.', or '..'. */
3219 if (slash != NULL) {
3221 r = create_dir(a, path);
3225 return (ARCHIVE_OK);
3229 * Yes, this should be stat() and not lstat(). Using lstat()
3230 * here loses the ability to extract through symlinks. Also note
3231 * that this should not use the a->st cache.
3233 if (la_stat(path, &st) == 0) {
3234 if (S_ISDIR(st.st_mode))
3235 return (ARCHIVE_OK);
3236 if ((a->flags & ARCHIVE_EXTRACT_NO_OVERWRITE)) {
3237 archive_set_error(&a->archive, EEXIST,
3238 "Can't create directory '%s'", path);
3239 return (ARCHIVE_FAILED);
3241 if (unlink(path) != 0) {
3242 archive_set_error(&a->archive, errno,
3243 "Can't create directory '%s': "
3244 "Conflicting file cannot be removed",
3246 return (ARCHIVE_FAILED);
3248 } else if (errno != ENOENT && errno != ENOTDIR) {
3250 archive_set_error(&a->archive, errno,
3251 "Can't test directory '%s'", path);
3252 return (ARCHIVE_FAILED);
3253 } else if (slash != NULL) {
3255 r = create_dir(a, path);
3257 if (r != ARCHIVE_OK)
3262 * Mode we want for the final restored directory. Per POSIX,
3263 * implicitly-created dirs must be created obeying the umask.
3264 * There's no mention whether this is different for privileged
3265 * restores (which the rest of this code handles by pretending
3266 * umask=0). I've chosen here to always obey the user's umask for
3267 * implicit dirs, even if _EXTRACT_PERM was specified.
3269 mode_final = DEFAULT_DIR_MODE & ~a->user_umask;
3270 /* Mode we want on disk during the restore process. */
3272 mode |= MINIMUM_DIR_MODE;
3273 mode &= MAXIMUM_DIR_MODE;
3274 if (mkdir(path, mode) == 0) {
3275 if (mode != mode_final) {
3276 le = new_fixup(a, path);
3278 return (ARCHIVE_FATAL);
3279 le->fixup |=TODO_MODE_BASE;
3280 le->mode = mode_final;
3282 return (ARCHIVE_OK);
3286 * Without the following check, a/b/../b/c/d fails at the
3287 * second visit to 'b', so 'd' can't be created. Note that we
3288 * don't add it to the fixup list here, as it's already been
3291 if (la_stat(path, &st) == 0 && S_ISDIR(st.st_mode))
3292 return (ARCHIVE_OK);
3294 archive_set_error(&a->archive, errno, "Failed to create dir '%s'",
3296 return (ARCHIVE_FAILED);
3300 * Note: Although we can skip setting the user id if the desired user
3301 * id matches the current user, we cannot skip setting the group, as
3302 * many systems set the gid based on the containing directory. So
3303 * we have to perform a chown syscall if we want to set the SGID
3304 * bit. (The alternative is to stat() and then possibly chown(); it's
3305 * more efficient to skip the stat() and just always chown().) Note
3306 * that a successful chown() here clears the TODO_SGID_CHECK bit, which
3307 * allows set_mode to skip the stat() check for the GID.
3310 set_ownership(struct archive_write_disk *a)
3312 #if !defined(__CYGWIN__) && !defined(__linux__)
3314 * On Linux, a process may have the CAP_CHOWN capability.
3315 * On Windows there is no 'root' user with uid 0.
3316 * Elsewhere we can skip calling chown if we are not root and the desired
3317 * user id does not match the current user.
3319 if (a->user_uid != 0 && a->user_uid != a->uid) {
3320 archive_set_error(&a->archive, errno,
3321 "Can't set UID=%jd", (intmax_t)a->uid);
3322 return (ARCHIVE_WARN);
3327 /* If we have an fd, we can avoid a race. */
3328 if (a->fd >= 0 && fchown(a->fd, a->uid, a->gid) == 0) {
3329 /* We've set owner and know uid/gid are correct. */
3330 a->todo &= ~(TODO_OWNER | TODO_SGID_CHECK | TODO_SUID_CHECK);
3331 return (ARCHIVE_OK);
3335 /* We prefer lchown() but will use chown() if that's all we have. */
3336 /* Of course, if we have neither, this will always fail. */
3338 if (lchown(a->name, a->uid, a->gid) == 0) {
3339 /* We've set owner and know uid/gid are correct. */
3340 a->todo &= ~(TODO_OWNER | TODO_SGID_CHECK | TODO_SUID_CHECK);
3341 return (ARCHIVE_OK);
3344 if (!S_ISLNK(a->mode) && chown(a->name, a->uid, a->gid) == 0) {
3345 /* We've set owner and know uid/gid are correct. */
3346 a->todo &= ~(TODO_OWNER | TODO_SGID_CHECK | TODO_SUID_CHECK);
3347 return (ARCHIVE_OK);
3351 archive_set_error(&a->archive, errno,
3352 "Can't set user=%jd/group=%jd for %s",
3353 (intmax_t)a->uid, (intmax_t)a->gid, a->name);
3354 return (ARCHIVE_WARN);
3358 * Note: Returns 0 on success, non-zero on failure.
3361 set_time(int fd, int mode, const char *name,
3362 time_t atime, long atime_nsec,
3363 time_t mtime, long mtime_nsec)
3365 /* Select the best implementation for this platform. */
3366 #if defined(HAVE_UTIMENSAT) && defined(HAVE_FUTIMENS)
3368 * utimensat() and futimens() are defined in
3369 * POSIX.1-2008. They support ns resolution and setting times
3370 * on fds and symlinks.
3372 struct timespec ts[2];
3373 (void)mode; /* UNUSED */
3374 ts[0].tv_sec = atime;
3375 ts[0].tv_nsec = atime_nsec;
3376 ts[1].tv_sec = mtime;
3377 ts[1].tv_nsec = mtime_nsec;
3379 return futimens(fd, ts);
3380 return utimensat(AT_FDCWD, name, ts, AT_SYMLINK_NOFOLLOW);
3384 * The utimes()-family functions support µs-resolution and
3385 * setting times fds and symlinks. utimes() is documented as
3386 * LEGACY by POSIX, futimes() and lutimes() are not described
3389 struct timeval times[2];
3391 times[0].tv_sec = atime;
3392 times[0].tv_usec = atime_nsec / 1000;
3393 times[1].tv_sec = mtime;
3394 times[1].tv_usec = mtime_nsec / 1000;
3398 return (futimes(fd, times));
3400 (void)fd; /* UNUSED */
3403 (void)mode; /* UNUSED */
3404 return (lutimes(name, times));
3408 return (utimes(name, times));
3411 #elif defined(HAVE_UTIME)
3413 * utime() is POSIX-standard but only supports 1s resolution and
3414 * does not support fds or symlinks.
3416 struct utimbuf times;
3417 (void)fd; /* UNUSED */
3418 (void)name; /* UNUSED */
3419 (void)atime_nsec; /* UNUSED */
3420 (void)mtime_nsec; /* UNUSED */
3421 times.actime = atime;
3422 times.modtime = mtime;
3424 return (ARCHIVE_OK);
3425 return (utime(name, ×));
3429 * We don't know how to set the time on this platform.
3431 (void)fd; /* UNUSED */
3432 (void)mode; /* UNUSED */
3433 (void)name; /* UNUSED */
3434 (void)atime_nsec; /* UNUSED */
3435 (void)mtime_nsec; /* UNUSED */
3436 return (ARCHIVE_WARN);
3442 set_time_tru64(int fd, int mode, const char *name,
3443 time_t atime, long atime_nsec,
3444 time_t mtime, long mtime_nsec,
3445 time_t ctime, long ctime_nsec)
3447 struct attr_timbuf tstamp;
3448 tstamp.atime.tv_sec = atime;
3449 tstamp.mtime.tv_sec = mtime;
3450 tstamp.ctime.tv_sec = ctime;
3451 #if defined (__hpux) && defined (__ia64)
3452 tstamp.atime.tv_nsec = atime_nsec;
3453 tstamp.mtime.tv_nsec = mtime_nsec;
3454 tstamp.ctime.tv_nsec = ctime_nsec;
3456 tstamp.atime.tv_usec = atime_nsec / 1000;
3457 tstamp.mtime.tv_usec = mtime_nsec / 1000;
3458 tstamp.ctime.tv_usec = ctime_nsec / 1000;
3460 return (fcntl(fd,F_SETTIMES,&tstamp));
3462 #endif /* F_SETTIMES */
3465 set_times(struct archive_write_disk *a,
3466 int fd, int mode, const char *name,
3467 time_t atime, long atime_nanos,
3468 time_t birthtime, long birthtime_nanos,
3469 time_t mtime, long mtime_nanos,
3470 time_t cctime, long ctime_nanos)
3472 /* Note: set_time doesn't use libarchive return conventions!
3473 * It uses syscall conventions. So 0 here instead of ARCHIVE_OK. */
3478 * on Tru64 try own fcntl first which can restore even the
3479 * ctime, fall back to default code path below if it fails
3480 * or if we are not running as root
3482 if (a->user_uid == 0 &&
3483 set_time_tru64(fd, mode, name,
3484 atime, atime_nanos, mtime,
3485 mtime_nanos, cctime, ctime_nanos) == 0) {
3486 return (ARCHIVE_OK);
3489 (void)cctime; /* UNUSED */
3490 (void)ctime_nanos; /* UNUSED */
3493 #ifdef HAVE_STRUCT_STAT_ST_BIRTHTIME
3495 * If you have struct stat.st_birthtime, we assume BSD
3496 * birthtime semantics, in which {f,l,}utimes() updates
3497 * birthtime to earliest mtime. So we set the time twice,
3498 * first using the birthtime, then using the mtime. If
3499 * birthtime == mtime, this isn't necessary, so we skip it.
3500 * If birthtime > mtime, then this won't work, so we skip it.
3502 if (birthtime < mtime
3503 || (birthtime == mtime && birthtime_nanos < mtime_nanos))
3504 r1 = set_time(fd, mode, name,
3506 birthtime, birthtime_nanos);
3508 (void)birthtime; /* UNUSED */
3509 (void)birthtime_nanos; /* UNUSED */
3511 r2 = set_time(fd, mode, name,
3513 mtime, mtime_nanos);
3514 if (r1 != 0 || r2 != 0) {
3515 archive_set_error(&a->archive, errno,
3516 "Can't restore time");
3517 return (ARCHIVE_WARN);
3519 return (ARCHIVE_OK);
3523 set_times_from_entry(struct archive_write_disk *a)
3525 time_t atime, birthtime, mtime, cctime;
3526 long atime_nsec, birthtime_nsec, mtime_nsec, ctime_nsec;
3528 /* Suitable defaults. */
3529 atime = birthtime = mtime = cctime = a->start_time;
3530 atime_nsec = birthtime_nsec = mtime_nsec = ctime_nsec = 0;
3532 /* If no time was provided, we're done. */
3533 if (!archive_entry_atime_is_set(a->entry)
3534 #if HAVE_STRUCT_STAT_ST_BIRTHTIME
3535 && !archive_entry_birthtime_is_set(a->entry)
3537 && !archive_entry_mtime_is_set(a->entry))
3538 return (ARCHIVE_OK);
3540 if (archive_entry_atime_is_set(a->entry)) {
3541 atime = archive_entry_atime(a->entry);
3542 atime_nsec = archive_entry_atime_nsec(a->entry);
3544 if (archive_entry_birthtime_is_set(a->entry)) {
3545 birthtime = archive_entry_birthtime(a->entry);
3546 birthtime_nsec = archive_entry_birthtime_nsec(a->entry);
3548 if (archive_entry_mtime_is_set(a->entry)) {
3549 mtime = archive_entry_mtime(a->entry);
3550 mtime_nsec = archive_entry_mtime_nsec(a->entry);
3552 if (archive_entry_ctime_is_set(a->entry)) {
3553 cctime = archive_entry_ctime(a->entry);
3554 ctime_nsec = archive_entry_ctime_nsec(a->entry);
3557 return set_times(a, a->fd, a->mode, a->name,
3559 birthtime, birthtime_nsec,
3561 cctime, ctime_nsec);
3565 set_mode(struct archive_write_disk *a, int mode)
3569 mode &= 07777; /* Strip off file type bits. */
3571 if (a->todo & TODO_SGID_CHECK) {
3573 * If we don't know the GID is right, we must stat()
3574 * to verify it. We can't just check the GID of this
3575 * process, since systems sometimes set GID from
3576 * the enclosing dir or based on ACLs.
3578 if ((r = lazy_stat(a)) != ARCHIVE_OK)
3580 if (a->pst->st_gid != a->gid) {
3582 if (a->flags & ARCHIVE_EXTRACT_OWNER) {
3584 * This is only an error if you
3585 * requested owner restore. If you
3586 * didn't, we'll try to restore
3587 * sgid/suid, but won't consider it a
3588 * problem if we can't.
3590 archive_set_error(&a->archive, -1,
3591 "Can't restore SGID bit");
3595 /* While we're here, double-check the UID. */
3596 if (a->pst->st_uid != a->uid
3597 && (a->todo & TODO_SUID)) {
3599 if (a->flags & ARCHIVE_EXTRACT_OWNER) {
3600 archive_set_error(&a->archive, -1,
3601 "Can't restore SUID bit");
3605 a->todo &= ~TODO_SGID_CHECK;
3606 a->todo &= ~TODO_SUID_CHECK;
3607 } else if (a->todo & TODO_SUID_CHECK) {
3609 * If we don't know the UID is right, we can just check
3610 * the user, since all systems set the file UID from
3613 if (a->user_uid != a->uid) {
3615 if (a->flags & ARCHIVE_EXTRACT_OWNER) {
3616 archive_set_error(&a->archive, -1,
3617 "Can't make file SUID");
3621 a->todo &= ~TODO_SUID_CHECK;
3624 if (S_ISLNK(a->mode)) {
3627 * If this is a symlink, use lchmod(). If the
3628 * platform doesn't support lchmod(), just skip it. A
3629 * platform that doesn't provide a way to set
3630 * permissions on symlinks probably ignores
3631 * permissions on symlinks, so a failure here has no
3634 if (lchmod(a->name, mode) != 0) {
3638 #if ENOTSUP != EOPNOTSUPP
3642 * if lchmod is defined but the platform
3643 * doesn't support it, silently ignore
3648 archive_set_error(&a->archive, errno,
3649 "Can't set permissions to 0%o", (int)mode);
3654 } else if (!S_ISDIR(a->mode)) {
3656 * If it's not a symlink and not a dir, then use
3657 * fchmod() or chmod(), depending on whether we have
3658 * an fd. Dirs get their perms set during the
3659 * post-extract fixup, which is handled elsewhere.
3663 r2 = fchmod(a->fd, mode);
3666 /* If this platform lacks fchmod(), then
3667 * we'll just use chmod(). */
3668 r2 = chmod(a->name, mode);
3671 archive_set_error(&a->archive, errno,
3672 "Can't set permissions to 0%o", (int)mode);
3680 set_fflags(struct archive_write_disk *a)
3682 struct fixup_entry *le;
3683 unsigned long set, clear;
3685 mode_t mode = archive_entry_mode(a->entry);
3687 * Make 'critical_flags' hold all file flags that can't be
3688 * immediately restored. For example, on BSD systems,
3689 * SF_IMMUTABLE prevents hardlinks from being created, so
3690 * should not be set until after any hardlinks are created. To
3691 * preserve some semblance of portability, this uses #ifdef
3692 * extensively. Ugly, but it works.
3694 * Yes, Virginia, this does create a security race. It's mitigated
3695 * somewhat by the practice of creating dirs 0700 until the extract
3696 * is done, but it would be nice if we could do more than that.
3697 * People restoring critical file systems should be wary of
3698 * other programs that might try to muck with files as they're
3701 const int critical_flags = 0
3714 #if defined(FS_APPEND_FL)
3716 #elif defined(EXT2_APPEND_FL)
3719 #if defined(FS_IMMUTABLE_FL)
3721 #elif defined(EXT2_IMMUTABLE_FL)
3724 #ifdef FS_JOURNAL_DATA_FL
3725 | FS_JOURNAL_DATA_FL
3729 if (a->todo & TODO_FFLAGS) {
3730 archive_entry_fflags(a->entry, &set, &clear);
3733 * The first test encourages the compiler to eliminate
3734 * all of this if it's not necessary.
3736 if ((critical_flags != 0) && (set & critical_flags)) {
3737 le = current_fixup(a, a->name);
3739 return (ARCHIVE_FATAL);
3740 le->fixup |= TODO_FFLAGS;
3741 le->fflags_set = set;
3742 /* Store the mode if it's not already there. */
3743 if ((le->fixup & TODO_MODE) == 0)
3746 r = set_fflags_platform(a, a->fd,
3747 a->name, mode, set, clear);
3748 if (r != ARCHIVE_OK)
3752 return (ARCHIVE_OK);
3756 clear_nochange_fflags(struct archive_write_disk *a)
3758 mode_t mode = archive_entry_mode(a->entry);
3759 const int nochange_flags = 0
3772 #ifdef EXT2_APPEND_FL
3775 #ifdef EXT2_IMMUTABLE_FL
3780 return (set_fflags_platform(a, a->fd, a->name, mode, 0,
3785 #if ( defined(HAVE_LCHFLAGS) || defined(HAVE_CHFLAGS) || defined(HAVE_FCHFLAGS) ) && defined(HAVE_STRUCT_STAT_ST_FLAGS)
3787 * BSD reads flags using stat() and sets them with one of {f,l,}chflags()
3790 set_fflags_platform(struct archive_write_disk *a, int fd, const char *name,
3791 mode_t mode, unsigned long set, unsigned long clear)
3794 const int sf_mask = 0
3808 (void)mode; /* UNUSED */
3810 if (set == 0 && clear == 0)
3811 return (ARCHIVE_OK);
3814 * XXX Is the stat here really necessary? Or can I just use
3815 * the 'set' flags directly? In particular, I'm not sure
3816 * about the correct approach if we're overwriting an existing
3817 * file that already has flags on it. XXX
3819 if ((r = lazy_stat(a)) != ARCHIVE_OK)
3822 a->st.st_flags &= ~clear;
3823 a->st.st_flags |= set;
3825 /* Only super-user may change SF_* flags */
3827 if (a->user_uid != 0)
3828 a->st.st_flags &= ~sf_mask;
3830 #ifdef HAVE_FCHFLAGS
3831 /* If platform has fchflags() and we were given an fd, use it. */
3832 if (fd >= 0 && fchflags(fd, a->st.st_flags) == 0)
3833 return (ARCHIVE_OK);
3836 * If we can't use the fd to set the flags, we'll use the
3837 * pathname to set flags. We prefer lchflags() but will use
3838 * chflags() if we must.
3840 #ifdef HAVE_LCHFLAGS
3841 if (lchflags(name, a->st.st_flags) == 0)
3842 return (ARCHIVE_OK);
3843 #elif defined(HAVE_CHFLAGS)
3844 if (S_ISLNK(a->st.st_mode)) {
3845 archive_set_error(&a->archive, errno,
3846 "Can't set file flags on symlink.");
3847 return (ARCHIVE_WARN);
3849 if (chflags(name, a->st.st_flags) == 0)
3850 return (ARCHIVE_OK);
3852 archive_set_error(&a->archive, errno,
3853 "Failed to set file flags");
3854 return (ARCHIVE_WARN);
3857 #elif (defined(FS_IOC_GETFLAGS) && defined(FS_IOC_SETFLAGS) && \
3858 defined(HAVE_WORKING_FS_IOC_GETFLAGS)) || \
3859 (defined(EXT2_IOC_GETFLAGS) && defined(EXT2_IOC_SETFLAGS) && \
3860 defined(HAVE_WORKING_EXT2_IOC_GETFLAGS))
3862 * Linux uses ioctl() to read and write file flags.
3865 set_fflags_platform(struct archive_write_disk *a, int fd, const char *name,
3866 mode_t mode, unsigned long set, unsigned long clear)
3870 int newflags, oldflags;
3872 * Linux has no define for the flags that are only settable by
3873 * the root user. This code may seem a little complex, but
3874 * there seem to be some Linux systems that lack these
3875 * defines. (?) The code below degrades reasonably gracefully
3876 * if sf_mask is incomplete.
3878 const int sf_mask = 0
3879 #if defined(FS_IMMUTABLE_FL)
3881 #elif defined(EXT2_IMMUTABLE_FL)
3884 #if defined(FS_APPEND_FL)
3886 #elif defined(EXT2_APPEND_FL)
3889 #if defined(FS_JOURNAL_DATA_FL)
3890 | FS_JOURNAL_DATA_FL
3894 if (set == 0 && clear == 0)
3895 return (ARCHIVE_OK);
3896 /* Only regular files and dirs can have flags. */
3897 if (!S_ISREG(mode) && !S_ISDIR(mode))
3898 return (ARCHIVE_OK);
3900 /* If we weren't given an fd, open it ourselves. */
3902 myfd = open(name, O_RDONLY | O_NONBLOCK | O_BINARY | O_CLOEXEC);
3903 __archive_ensure_cloexec_flag(myfd);
3906 return (ARCHIVE_OK);
3909 * XXX As above, this would be way simpler if we didn't have
3910 * to read the current flags from disk. XXX
3914 /* Read the current file flags. */
3916 #ifdef FS_IOC_GETFLAGS
3924 /* Try setting the flags as given. */
3925 newflags = (oldflags & ~clear) | set;
3927 #ifdef FS_IOC_SETFLAGS
3937 /* If we couldn't set all the flags, try again with a subset. */
3938 newflags &= ~sf_mask;
3939 oldflags &= sf_mask;
3940 newflags |= oldflags;
3942 #ifdef FS_IOC_SETFLAGS
3950 /* We couldn't set the flags, so report the failure. */
3952 archive_set_error(&a->archive, errno,
3953 "Failed to set file flags");
3964 * Of course, some systems have neither BSD chflags() nor Linux' flags
3965 * support through ioctl().
3968 set_fflags_platform(struct archive_write_disk *a, int fd, const char *name,
3969 mode_t mode, unsigned long set, unsigned long clear)
3971 (void)a; /* UNUSED */
3972 (void)fd; /* UNUSED */
3973 (void)name; /* UNUSED */
3974 (void)mode; /* UNUSED */
3975 (void)set; /* UNUSED */
3976 (void)clear; /* UNUSED */
3977 return (ARCHIVE_OK);
3980 #endif /* __linux */
3982 #ifndef HAVE_COPYFILE_H
3983 /* Default is to simply drop Mac extended metadata. */
3985 set_mac_metadata(struct archive_write_disk *a, const char *pathname,
3986 const void *metadata, size_t metadata_size)
3988 (void)a; /* UNUSED */
3989 (void)pathname; /* UNUSED */
3990 (void)metadata; /* UNUSED */
3991 (void)metadata_size; /* UNUSED */
3992 return (ARCHIVE_OK);
3996 fixup_appledouble(struct archive_write_disk *a, const char *pathname)
3998 (void)a; /* UNUSED */
3999 (void)pathname; /* UNUSED */
4000 return (ARCHIVE_OK);
4005 * On Mac OS, we use copyfile() to unpack the metadata and
4006 * apply it to the target file.
4009 #if defined(HAVE_SYS_XATTR_H)
4011 copy_xattrs(struct archive_write_disk *a, int tmpfd, int dffd)
4014 char *xattr_names = NULL, *xattr_val = NULL;
4015 int ret = ARCHIVE_OK, xattr_i;
4017 xattr_size = flistxattr(tmpfd, NULL, 0, 0);
4018 if (xattr_size == -1) {
4019 archive_set_error(&a->archive, errno,
4020 "Failed to read metadata(xattr)");
4024 xattr_names = malloc(xattr_size);
4025 if (xattr_names == NULL) {
4026 archive_set_error(&a->archive, ENOMEM,
4027 "Can't allocate memory for metadata(xattr)");
4028 ret = ARCHIVE_FATAL;
4031 xattr_size = flistxattr(tmpfd, xattr_names, xattr_size, 0);
4032 if (xattr_size == -1) {
4033 archive_set_error(&a->archive, errno,
4034 "Failed to read metadata(xattr)");
4038 for (xattr_i = 0; xattr_i < xattr_size;
4039 xattr_i += strlen(xattr_names + xattr_i) + 1) {
4040 char *xattr_val_saved;
4044 s = fgetxattr(tmpfd, xattr_names + xattr_i, NULL, 0, 0, 0);
4046 archive_set_error(&a->archive, errno,
4047 "Failed to get metadata(xattr)");
4051 xattr_val_saved = xattr_val;
4052 xattr_val = realloc(xattr_val, s);
4053 if (xattr_val == NULL) {
4054 archive_set_error(&a->archive, ENOMEM,
4055 "Failed to get metadata(xattr)");
4057 free(xattr_val_saved);
4060 s = fgetxattr(tmpfd, xattr_names + xattr_i, xattr_val, s, 0, 0);
4062 archive_set_error(&a->archive, errno,
4063 "Failed to get metadata(xattr)");
4067 f = fsetxattr(dffd, xattr_names + xattr_i, xattr_val, s, 0, 0);
4069 archive_set_error(&a->archive, errno,
4070 "Failed to get metadata(xattr)");
4083 copy_acls(struct archive_write_disk *a, int tmpfd, int dffd)
4085 #ifndef HAVE_SYS_ACL_H
4088 acl_t acl, dfacl = NULL;
4089 int acl_r, ret = ARCHIVE_OK;
4091 acl = acl_get_fd(tmpfd);
4093 if (errno == ENOENT)
4094 /* There are not any ACLs. */
4096 archive_set_error(&a->archive, errno,
4097 "Failed to get metadata(acl)");
4101 dfacl = acl_dup(acl);
4102 acl_r = acl_set_fd(dffd, dfacl);
4104 archive_set_error(&a->archive, errno,
4105 "Failed to get metadata(acl)");
4119 create_tempdatafork(struct archive_write_disk *a, const char *pathname)
4121 struct archive_string tmpdatafork;
4124 archive_string_init(&tmpdatafork);
4125 archive_strcpy(&tmpdatafork, "tar.md.XXXXXX");
4126 tmpfd = mkstemp(tmpdatafork.s);
4128 archive_set_error(&a->archive, errno,
4129 "Failed to mkstemp");
4130 archive_string_free(&tmpdatafork);
4133 if (copyfile(pathname, tmpdatafork.s, 0,
4134 COPYFILE_UNPACK | COPYFILE_NOFOLLOW
4135 | COPYFILE_ACL | COPYFILE_XATTR) < 0) {
4136 archive_set_error(&a->archive, errno,
4137 "Failed to restore metadata");
4141 unlink(tmpdatafork.s);
4142 archive_string_free(&tmpdatafork);
4147 copy_metadata(struct archive_write_disk *a, const char *metadata,
4148 const char *datafork, int datafork_compressed)
4150 int ret = ARCHIVE_OK;
4152 if (datafork_compressed) {
4155 tmpfd = create_tempdatafork(a, metadata);
4157 return (ARCHIVE_WARN);
4160 * Do not open the data fork compressed by HFS+ compression
4161 * with at least a writing mode(O_RDWR or O_WRONLY). it
4162 * makes the data fork uncompressed.
4164 dffd = open(datafork, 0);
4166 archive_set_error(&a->archive, errno,
4167 "Failed to open the data fork for metadata");
4169 return (ARCHIVE_WARN);
4172 #if defined(HAVE_SYS_XATTR_H)
4173 ret = copy_xattrs(a, tmpfd, dffd);
4174 if (ret == ARCHIVE_OK)
4176 ret = copy_acls(a, tmpfd, dffd);
4180 if (copyfile(metadata, datafork, 0,
4181 COPYFILE_UNPACK | COPYFILE_NOFOLLOW
4182 | COPYFILE_ACL | COPYFILE_XATTR) < 0) {
4183 archive_set_error(&a->archive, errno,
4184 "Failed to restore metadata");
4192 set_mac_metadata(struct archive_write_disk *a, const char *pathname,
4193 const void *metadata, size_t metadata_size)
4195 struct archive_string tmp;
4198 int ret = ARCHIVE_OK;
4200 /* This would be simpler if copyfile() could just accept the
4201 * metadata as a block of memory; then we could sidestep this
4202 * silly dance of writing the data to disk just so that
4203 * copyfile() can read it back in again. */
4204 archive_string_init(&tmp);
4205 archive_strcpy(&tmp, pathname);
4206 archive_strcat(&tmp, ".XXXXXX");
4207 fd = mkstemp(tmp.s);
4210 archive_set_error(&a->archive, errno,
4211 "Failed to restore metadata");
4212 archive_string_free(&tmp);
4213 return (ARCHIVE_WARN);
4215 written = write(fd, metadata, metadata_size);
4217 if ((size_t)written != metadata_size) {
4218 archive_set_error(&a->archive, errno,
4219 "Failed to restore metadata");
4224 #if defined(UF_COMPRESSED)
4225 if ((a->todo & TODO_HFS_COMPRESSION) != 0 &&
4226 (ret = lazy_stat(a)) == ARCHIVE_OK)
4227 compressed = a->st.st_flags & UF_COMPRESSED;
4231 ret = copy_metadata(a, tmp.s, pathname, compressed);
4234 archive_string_free(&tmp);
4239 fixup_appledouble(struct archive_write_disk *a, const char *pathname)
4244 struct archive_string datafork;
4245 int fd = -1, ret = ARCHIVE_OK;
4247 archive_string_init(&datafork);
4248 /* Check if the current file name is a type of the resource
4250 p = strrchr(pathname, '/');
4255 if (p[0] != '.' || p[1] != '_')
4256 goto skip_appledouble;
4259 * Check if the data fork file exists.
4261 * TODO: Check if this write disk object has handled it.
4263 archive_strncpy(&datafork, pathname, p - pathname);
4264 archive_strcat(&datafork, p + 2);
4265 if (lstat(datafork.s, &st) == -1 ||
4266 (st.st_mode & AE_IFMT) != AE_IFREG)
4267 goto skip_appledouble;
4270 * Check if the file is in the AppleDouble form.
4272 fd = open(pathname, O_RDONLY | O_BINARY | O_CLOEXEC);
4273 __archive_ensure_cloexec_flag(fd);
4275 archive_set_error(&a->archive, errno,
4276 "Failed to open a restoring file");
4278 goto skip_appledouble;
4280 if (read(fd, buff, 8) == -1) {
4281 archive_set_error(&a->archive, errno,
4282 "Failed to read a restoring file");
4285 goto skip_appledouble;
4288 /* Check AppleDouble Magic Code. */
4289 if (archive_be32dec(buff) != 0x00051607)
4290 goto skip_appledouble;
4291 /* Check AppleDouble Version. */
4292 if (archive_be32dec(buff+4) != 0x00020000)
4293 goto skip_appledouble;
4295 ret = copy_metadata(a, pathname, datafork.s,
4296 #if defined(UF_COMPRESSED)
4297 st.st_flags & UF_COMPRESSED);
4301 if (ret == ARCHIVE_OK) {
4306 archive_string_free(&datafork);
4311 #if ARCHIVE_XATTR_LINUX || ARCHIVE_XATTR_DARWIN || ARCHIVE_XATTR_AIX
4313 * Restore extended attributes - Linux, Darwin and AIX implementations:
4314 * AIX' ea interface is syntaxwise identical to the Linux xattr interface.
4317 set_xattrs(struct archive_write_disk *a)
4319 struct archive_entry *entry = a->entry;
4320 struct archive_string errlist;
4321 int ret = ARCHIVE_OK;
4322 int i = archive_entry_xattr_reset(entry);
4325 archive_string_init(&errlist);
4333 archive_entry_xattr_next(entry, &name, &value, &size);
4337 #if ARCHIVE_XATTR_LINUX
4338 /* Linux: quietly skip POSIX.1e ACL extended attributes */
4339 if (strncmp(name, "system.", 7) == 0 &&
4340 (strcmp(name + 7, "posix_acl_access") == 0 ||
4341 strcmp(name + 7, "posix_acl_default") == 0))
4343 if (strncmp(name, "trusted.SGI_", 12) == 0 &&
4344 (strcmp(name + 12, "ACL_DEFAULT") == 0 ||
4345 strcmp(name + 12, "ACL_FILE") == 0))
4348 /* Linux: xfsroot namespace is obsolete and unsupported */
4349 if (strncmp(name, "xfsroot.", 8) == 0) {
4351 archive_strcat(&errlist, name);
4352 archive_strappend_char(&errlist, ' ');
4358 #if ARCHIVE_XATTR_LINUX
4359 e = fsetxattr(a->fd, name, value, size, 0);
4360 #elif ARCHIVE_XATTR_DARWIN
4361 e = fsetxattr(a->fd, name, value, size, 0, 0);
4362 #elif ARCHIVE_XATTR_AIX
4363 e = fsetea(a->fd, name, value, size, 0);
4366 #if ARCHIVE_XATTR_LINUX
4367 e = lsetxattr(archive_entry_pathname(entry),
4368 name, value, size, 0);
4369 #elif ARCHIVE_XATTR_DARWIN
4370 e = setxattr(archive_entry_pathname(entry),
4371 name, value, size, 0, XATTR_NOFOLLOW);
4372 #elif ARCHIVE_XATTR_AIX
4373 e = lsetea(archive_entry_pathname(entry),
4374 name, value, size, 0);
4379 archive_strcat(&errlist, name);
4380 archive_strappend_char(&errlist, ' ');
4381 if (errno != ENOTSUP && errno != ENOSYS)
4386 if (ret == ARCHIVE_WARN) {
4387 if (fail && errlist.length > 0) {
4389 errlist.s[errlist.length] = '\0';
4390 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
4391 "Cannot restore extended attributes: %s",
4394 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
4395 "Cannot restore extended "
4396 "attributes on this file system.");
4399 archive_string_free(&errlist);
4402 #elif ARCHIVE_XATTR_FREEBSD
4404 * Restore extended attributes - FreeBSD implementation
4407 set_xattrs(struct archive_write_disk *a)
4409 struct archive_entry *entry = a->entry;
4410 struct archive_string errlist;
4411 int ret = ARCHIVE_OK;
4412 int i = archive_entry_xattr_reset(entry);
4415 archive_string_init(&errlist);
4421 archive_entry_xattr_next(entry, &name, &value, &size);
4426 namespace = EXTATTR_NAMESPACE_USER;
4428 if (strncmp(name, "user.", 5) == 0) {
4429 /* "user." attributes go to user namespace */
4431 namespace = EXTATTR_NAMESPACE_USER;
4432 } else if (strncmp(name, "system.", 7) == 0) {
4434 namespace = EXTATTR_NAMESPACE_SYSTEM;
4435 if (!strcmp(name, "nfs4.acl") ||
4436 !strcmp(name, "posix1e.acl_access") ||
4437 !strcmp(name, "posix1e.acl_default"))
4440 /* Other namespaces are unsupported */
4441 archive_strcat(&errlist, name);
4442 archive_strappend_char(&errlist, ' ');
4450 * On FreeBSD, extattr_set_fd does not
4451 * return the same as
4452 * extattr_set_file. It returns zero
4453 * on success, non-zero on failure.
4455 * We can detect the failure by
4456 * manually setting errno prior to the
4457 * call and checking after.
4459 * If errno remains zero, fake the
4460 * return value by setting e to size.
4462 * This is a hack for now until I
4463 * (Shawn Webb) get FreeBSD to fix the
4464 * issue, if that's even possible.
4467 e = extattr_set_fd(a->fd, namespace, name,
4469 if (e == 0 && errno == 0) {
4473 e = extattr_set_link(
4474 archive_entry_pathname(entry), namespace,
4477 if (e != (ssize_t)size) {
4478 archive_strcat(&errlist, name);
4479 archive_strappend_char(&errlist, ' ');
4481 if (errno != ENOTSUP && errno != ENOSYS)
4487 if (ret == ARCHIVE_WARN) {
4488 if (fail && errlist.length > 0) {
4490 errlist.s[errlist.length] = '\0';
4492 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
4493 "Cannot restore extended attributes: %s",
4496 archive_set_error(&a->archive, ARCHIVE_ERRNO_MISC,
4497 "Cannot restore extended "
4498 "attributes on this file system.");
4501 archive_string_free(&errlist);
4506 * Restore extended attributes - stub implementation for unsupported systems
4509 set_xattrs(struct archive_write_disk *a)
4511 static int warning_done = 0;
4513 /* If there aren't any extended attributes, then it's okay not
4514 * to extract them, otherwise, issue a single warning. */
4515 if (archive_entry_xattr_count(a->entry) != 0 && !warning_done) {
4517 archive_set_error(&a->archive, ARCHIVE_ERRNO_FILE_FORMAT,
4518 "Cannot restore extended attributes on this system");
4519 return (ARCHIVE_WARN);
4521 /* Warning was already emitted; suppress further warnings. */
4522 return (ARCHIVE_OK);
4527 * Test if file on disk is older than entry.
4530 older(struct stat *st, struct archive_entry *entry)
4532 /* First, test the seconds and return if we have a definite answer. */
4533 /* Definitely older. */
4534 if (to_int64_time(st->st_mtime) < to_int64_time(archive_entry_mtime(entry)))
4536 /* Definitely younger. */
4537 if (to_int64_time(st->st_mtime) > to_int64_time(archive_entry_mtime(entry)))
4539 /* If this platform supports fractional seconds, try those. */
4540 #if HAVE_STRUCT_STAT_ST_MTIMESPEC_TV_NSEC
4541 /* Definitely older. */
4542 if (st->st_mtimespec.tv_nsec < archive_entry_mtime_nsec(entry))
4544 #elif HAVE_STRUCT_STAT_ST_MTIM_TV_NSEC
4545 /* Definitely older. */
4546 if (st->st_mtim.tv_nsec < archive_entry_mtime_nsec(entry))
4548 #elif HAVE_STRUCT_STAT_ST_MTIME_N
4550 if (st->st_mtime_n < archive_entry_mtime_nsec(entry))
4552 #elif HAVE_STRUCT_STAT_ST_UMTIME
4554 if (st->st_umtime * 1000 < archive_entry_mtime_nsec(entry))
4556 #elif HAVE_STRUCT_STAT_ST_MTIME_USEC
4558 if (st->st_mtime_usec * 1000 < archive_entry_mtime_nsec(entry))
4561 /* This system doesn't have high-res timestamps. */
4563 /* Same age or newer, so not older. */
4567 #ifndef ARCHIVE_ACL_SUPPORT
4569 archive_write_disk_set_acls(struct archive *a, int fd, const char *name,
4570 struct archive_acl *abstract_acl, __LA_MODE_T mode)
4572 (void)a; /* UNUSED */
4573 (void)fd; /* UNUSED */
4574 (void)name; /* UNUSED */
4575 (void)abstract_acl; /* UNUSED */
4576 (void)mode; /* UNUSED */
4577 return (ARCHIVE_OK);
4581 #endif /* !_WIN32 || __CYGWIN__ */