1/* 2 * Copyright (c) 2004-2010 Apple, Inc. All rights reserved. 3 * 4 * @APPLE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. Please obtain a copy of the License at 10 * http://www.opensource.apple.com/apsl/ and read it before using this 11 * file. 12 * 13 * The Original Code and all software distributed under the License are 14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 18 * Please see the License for the specific language governing rights and 19 * limitations under the License. 20 * 21 * @APPLE_LICENSE_HEADER_END@ 22 */ 23#ifndef _COPYFILE_H_ /* version 0.1 */ 24#define _COPYFILE_H_ 25 26/* 27 * This API facilitates the copying of files and their associated 28 * metadata. There are several open source projects that need 29 * modifications to support preserving extended attributes and ACLs 30 * and this API collapses several hundred lines of modifications into 31 * one or two calls. 32 */ 33 34/* private */ 35#include <sys/cdefs.h> 36#include <stdint.h> 37 38__BEGIN_DECLS 39struct _copyfile_state; 40typedef struct _copyfile_state * copyfile_state_t; 41typedef uint32_t copyfile_flags_t; 42 43/* public */ 44 45/* receives: 46 * from path to source file system object 47 * to path to destination file system object 48 * state opaque blob for future extensibility 49 * Must be NULL in current implementation 50 * flags (described below) 51 * returns: 52 * int negative for error 53 */ 54 55int copyfile(const char *from, const char *to, copyfile_state_t state, copyfile_flags_t flags); 56int fcopyfile(int from_fd, int to_fd, copyfile_state_t, copyfile_flags_t flags); 57 58int copyfile_state_free(copyfile_state_t); 59copyfile_state_t copyfile_state_alloc(void); 60 61 62int copyfile_state_get(copyfile_state_t s, uint32_t flag, void * dst); 63int copyfile_state_set(copyfile_state_t s, uint32_t flag, const void * src); 64 65typedef int (*copyfile_callback_t)(int, int, copyfile_state_t, const char *, const char *, void *); 66 67#define COPYFILE_STATE_SRC_FD 1 68#define COPYFILE_STATE_SRC_FILENAME 2 69#define COPYFILE_STATE_DST_FD 3 70#define COPYFILE_STATE_DST_FILENAME 4 71#define COPYFILE_STATE_QUARANTINE 5 72#define COPYFILE_STATE_STATUS_CB 6 73#define COPYFILE_STATE_STATUS_CTX 7 74#define COPYFILE_STATE_COPIED 8 75#define COPYFILE_STATE_XATTRNAME 9 76 77 78#define COPYFILE_DISABLE_VAR "COPYFILE_DISABLE" 79 80/* flags for copyfile */ 81 82#define COPYFILE_ACL (1<<0) 83#define COPYFILE_STAT (1<<1) 84#define COPYFILE_XATTR (1<<2) 85#define COPYFILE_DATA (1<<3) 86 87#define COPYFILE_SECURITY (COPYFILE_STAT | COPYFILE_ACL) 88#define COPYFILE_METADATA (COPYFILE_SECURITY | COPYFILE_XATTR) 89#define COPYFILE_ALL (COPYFILE_METADATA | COPYFILE_DATA) 90 91#define COPYFILE_RECURSIVE (1<<15) /* Descend into hierarchies */ 92#define COPYFILE_CHECK (1<<16) /* return flags for xattr or acls if set */ 93#define COPYFILE_EXCL (1<<17) /* fail if destination exists */ 94#define COPYFILE_NOFOLLOW_SRC (1<<18) /* don't follow if source is a symlink */ 95#define COPYFILE_NOFOLLOW_DST (1<<19) /* don't follow if dst is a symlink */ 96#define COPYFILE_MOVE (1<<20) /* unlink src after copy */ 97#define COPYFILE_UNLINK (1<<21) /* unlink dst before copy */ 98#define COPYFILE_NOFOLLOW (COPYFILE_NOFOLLOW_SRC | COPYFILE_NOFOLLOW_DST) 99 100#define COPYFILE_PACK (1<<22) 101#define COPYFILE_UNPACK (1<<23) 102 103#define COPYFILE_VERBOSE (1<<30) 104 105#define COPYFILE_RECURSE_ERROR 0 106#define COPYFILE_RECURSE_FILE 1 107#define COPYFILE_RECURSE_DIR 2 108#define COPYFILE_RECURSE_DIR_CLEANUP 3 109#define COPYFILE_COPY_DATA 4 110#define COPYFILE_COPY_XATTR 5 111 112#define COPYFILE_START 1 113#define COPYFILE_FINISH 2 114#define COPYFILE_ERR 3 115#define COPYFILE_PROGRESS 4 116 117#define COPYFILE_CONTINUE 0 118#define COPYFILE_SKIP 1 119#define COPYFILE_QUIT 2 120 121__END_DECLS 122 123#endif /* _COPYFILE_H_ */ 124