[apple/copyfile.git] / copyfile.h

/*
 * Copyright (c) 2004-2010 Apple, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this
 * file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
#ifndef _COPYFILE_H_ /* version 0.1 */
#define _COPYFILE_H_

/*
 * This API facilitates the copying of files and their associated
 * metadata.  There are several open source projects that need
 * modifications to support preserving extended attributes and ACLs
 * and this API collapses several hundred lines of modifications into
 * one or two calls.
 */

/* private */
#include <sys/cdefs.h>
#include <stdint.h>

__BEGIN_DECLS
struct _copyfile_state;
typedef struct _copyfile_state * copyfile_state_t;
typedef uint32_t copyfile_flags_t;

/* public */

/* receives:
 *   from	path to source file system object
 *   to		path to destination file system object
 *   state	opaque blob for future extensibility
 *		Must be NULL in current implementation
 *   flags	(described below)
 * returns:
 *   int	negative for error
 */

int copyfile(const char *from, const char *to, copyfile_state_t state, copyfile_flags_t flags);
int fcopyfile(int from_fd, int to_fd, copyfile_state_t, copyfile_flags_t flags);

int copyfile_state_free(copyfile_state_t);
copyfile_state_t copyfile_state_alloc(void);


int copyfile_state_get(copyfile_state_t s, uint32_t flag, void * dst);
int copyfile_state_set(copyfile_state_t s, uint32_t flag, const void * src);

typedef int (*copyfile_callback_t)(int, int, copyfile_state_t, const char *, const char *, void *);

#define COPYFILE_STATE_SRC_FD		1
#define COPYFILE_STATE_SRC_FILENAME	2
#define COPYFILE_STATE_DST_FD		3
#define COPYFILE_STATE_DST_FILENAME	4
#define COPYFILE_STATE_QUARANTINE	5
#define	COPYFILE_STATE_STATUS_CB	6
#define	COPYFILE_STATE_STATUS_CTX	7
#define	COPYFILE_STATE_COPIED		8
#define	COPYFILE_STATE_XATTRNAME	9
#define	COPYFILE_STATE_WAS_CLONED	10


#define	COPYFILE_DISABLE_VAR	"COPYFILE_DISABLE"

/* flags for copyfile */

#define COPYFILE_ACL	    (1<<0)
#define COPYFILE_STAT	    (1<<1)
#define COPYFILE_XATTR	    (1<<2)
#define COPYFILE_DATA	    (1<<3)

#define COPYFILE_SECURITY   (COPYFILE_STAT | COPYFILE_ACL)
#define COPYFILE_METADATA   (COPYFILE_SECURITY | COPYFILE_XATTR)
#define COPYFILE_ALL	    (COPYFILE_METADATA | COPYFILE_DATA)

#define	COPYFILE_RECURSIVE	(1<<15)	/* Descend into hierarchies */
#define COPYFILE_CHECK		(1<<16) /* return flags for xattr or acls if set */
#define COPYFILE_EXCL		(1<<17) /* fail if destination exists */
#define COPYFILE_NOFOLLOW_SRC	(1<<18) /* don't follow if source is a symlink */
#define COPYFILE_NOFOLLOW_DST	(1<<19) /* don't follow if dst is a symlink */
#define COPYFILE_MOVE		(1<<20) /* unlink src after copy */
#define COPYFILE_UNLINK		(1<<21) /* unlink dst before copy */
#define COPYFILE_NOFOLLOW	(COPYFILE_NOFOLLOW_SRC | COPYFILE_NOFOLLOW_DST)

#define COPYFILE_PACK		(1<<22)
#define COPYFILE_UNPACK		(1<<23)

#define COPYFILE_CLONE		(1<<24)
#define COPYFILE_CLONE_FORCE	(1<<25)

#define COPYFILE_RUN_IN_PLACE	(1<<26)

#define COPYFILE_DATA_SPARSE	(1<<27)

#define COPYFILE_VERBOSE	(1<<30)

#define	COPYFILE_RECURSE_ERROR	0
#define	COPYFILE_RECURSE_FILE	1
#define	COPYFILE_RECURSE_DIR	2
#define	COPYFILE_RECURSE_DIR_CLEANUP	3
#define	COPYFILE_COPY_DATA	4
#define	COPYFILE_COPY_XATTR	5

#define	COPYFILE_START		1
#define	COPYFILE_FINISH		2
#define	COPYFILE_ERR		3
#define	COPYFILE_PROGRESS	4

#define	COPYFILE_CONTINUE	0
#define	COPYFILE_SKIP	1
#define	COPYFILE_QUIT	2

__END_DECLS

#endif /* _COPYFILE_H_ */
Commit	Line	Data
b3aa0442	1	/*
3f81d1c4	2	* Copyright (c) 2004-2010 Apple, Inc. All rights reserved.
b3aa0442 A	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	/*
618b37c8 A	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.
b3aa0442 A	32	*/
	33
	34	/* private */
	35	#include <sys/cdefs.h>
	36	#include <stdint.h>
	37
	38	__BEGIN_DECLS
	39	struct _copyfile_state;
	40	typedef struct _copyfile_state * copyfile_state_t;
	41	typedef 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
	55	int copyfile(const char from, const char to, copyfile_state_t state, copyfile_flags_t flags);
	56	int fcopyfile(int from_fd, int to_fd, copyfile_state_t, copyfile_flags_t flags);
	57
	58	int copyfile_state_free(copyfile_state_t);
	59	copyfile_state_t copyfile_state_alloc(void);
	60
	61
	62	int copyfile_state_get(copyfile_state_t s, uint32_t flag, void * dst);
	63	int copyfile_state_set(copyfile_state_t s, uint32_t flag, const void * src);
	64
659640e4 A	65	typedef int (copyfile_callback_t)(int, int, copyfile_state_t, const char , const char , void );
659640e4 A	66
b3aa0442 A	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
659640e4 A	72	#define COPYFILE_STATE_STATUS_CB 6
	73	#define COPYFILE_STATE_STATUS_CTX 7
	74	#define COPYFILE_STATE_COPIED 8
3f81d1c4	75	#define COPYFILE_STATE_XATTRNAME 9
1f4df596	76	#define COPYFILE_STATE_WAS_CLONED 10
b3aa0442	77
11f767b3	78
b3aa0442 A	79	#define COPYFILE_DISABLE_VAR "COPYFILE_DISABLE"
	80
	81	/* flags for copyfile */
	82
	83	#define COPYFILE_ACL (1<<0)
	84	#define COPYFILE_STAT (1<<1)
	85	#define COPYFILE_XATTR (1<<2)
	86	#define COPYFILE_DATA (1<<3)
	87
	88	#define COPYFILE_SECURITY (COPYFILE_STAT \| COPYFILE_ACL)
	89	#define COPYFILE_METADATA (COPYFILE_SECURITY \| COPYFILE_XATTR)
	90	#define COPYFILE_ALL (COPYFILE_METADATA \| COPYFILE_DATA)
	91
659640e4	92	#define COPYFILE_RECURSIVE (1<<15) /* Descend into hierarchies */
b3aa0442 A	93	#define COPYFILE_CHECK (1<<16) /* return flags for xattr or acls if set */
	94	#define COPYFILE_EXCL (1<<17) /* fail if destination exists */
	95	#define COPYFILE_NOFOLLOW_SRC (1<<18) /* don't follow if source is a symlink */
	96	#define COPYFILE_NOFOLLOW_DST (1<<19) /* don't follow if dst is a symlink */
	97	#define COPYFILE_MOVE (1<<20) /* unlink src after copy */
	98	#define COPYFILE_UNLINK (1<<21) /* unlink dst before copy */
	99	#define COPYFILE_NOFOLLOW (COPYFILE_NOFOLLOW_SRC \| COPYFILE_NOFOLLOW_DST)
	100
	101	#define COPYFILE_PACK (1<<22)
	102	#define COPYFILE_UNPACK (1<<23)
	103
1f4df596 A	104	#define COPYFILE_CLONE (1<<24)
	105	#define COPYFILE_CLONE_FORCE (1<<25)
	106
	107	#define COPYFILE_RUN_IN_PLACE (1<<26)
	108
937356ff A	109	#define COPYFILE_DATA_SPARSE (1<<27)
937356ff A	110
b3aa0442 A	111	#define COPYFILE_VERBOSE (1<<30)
b3aa0442 A	112
659640e4 A	113	#define COPYFILE_RECURSE_ERROR 0
	114	#define COPYFILE_RECURSE_FILE 1
	115	#define COPYFILE_RECURSE_DIR 2
	116	#define COPYFILE_RECURSE_DIR_CLEANUP 3
	117	#define COPYFILE_COPY_DATA 4
3f81d1c4	118	#define COPYFILE_COPY_XATTR 5
659640e4 A	119
	120	#define COPYFILE_START 1
	121	#define COPYFILE_FINISH 2
	122	#define COPYFILE_ERR 3
	123	#define COPYFILE_PROGRESS 4
	124
	125	#define COPYFILE_CONTINUE 0
	126	#define COPYFILE_SKIP 1
	127	#define COPYFILE_QUIT 2
	128
b3aa0442 A	129	__END_DECLS
	130
	131	#endif /* _COPYFILE_H_ */