tar.cpp@ 35708

Last change on this file since 35708 was 35351, checked in by vboxsync, 14 years ago
scm cleanups.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 54.0 KB

Line
1	/* $Id: tar.cpp 35351 2010-12-27 17:04:17Z vboxsync $ */
2	/** @file
3	* IPRT - Tar archive I/O.
4	*/
5
6	/*
7	* Copyright (C) 2009-2010 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27
28	/******************************************************************************
29	* Header Files *
30	******************************************************************************/
31	#include "internal/iprt.h"
32	#include <iprt/tar.h>
33
34	#include <iprt/asm.h>
35	#include <iprt/assert.h>
36	#include <iprt/err.h>
37	#include <iprt/file.h>
38	#include <iprt/mem.h>
39	#include <iprt/path.h>
40	#include <iprt/string.h>
41
42	#include "internal/magics.h"
43
44
45	/******************************************************************************
46	* Structures and Typedefs *
47	******************************************************************************/
48
49	/** @name RTTARRECORD::h::linkflag
50	* @{ */
51	#define LF_OLDNORMAL '\0' /*< Normal disk file, Unix compatible /
52	#define LF_NORMAL '0' /*< Normal disk file /
53	#define LF_LINK '1' /*< Link to previously dumped file /
54	#define LF_SYMLINK '2' /*< Symbolic link /
55	#define LF_CHR '3' /*< Character special file /
56	#define LF_BLK '4' /*< Block special file /
57	#define LF_DIR '5' /*< Directory /
58	#define LF_FIFO '6' /*< FIFO special file /
59	#define LF_CONTIG '7' /*< Contiguous file /
60	/** @} */
61
62	/**
63	* A tar file header.
64	*/
65	typedef union RTTARRECORD
66	{
67	char d[512];
68	struct h
69	{
70	char name[100];
71	char mode[8];
72	char uid[8];
73	char gid[8];
74	char size[12];
75	char mtime[12];
76	char chksum[8];
77	char linkflag;
78	char linkname[100];
79	char magic[8];
80	char uname[32];
81	char gname[32];
82	char devmajor[8];
83	char devminor[8];
84	} h;
85	} RTTARRECORD;
86	AssertCompileSize(RTTARRECORD, 512);
87	AssertCompileMemberOffset(RTTARRECORD, h.size, 100+8*3);
88	/** Pointer to a tar file header. */
89	typedef RTTARRECORD *PRTTARRECORD;
90
91
92	#if 0 /* not currently used */
93	typedef struct RTTARFILELIST
94	{
95	char *pszFilename;
96	RTTARFILELIST *pNext;
97	} RTTARFILELIST;
98	typedef RTTARFILELIST *PRTTARFILELIST;
99	#endif
100
101	/** Pointer to a tar file handle. */
102	typedef struct RTTARFILEINTERNAL *PRTTARFILEINTERNAL;
103
104	/**
105	* The internal data of a tar handle.
106	*/
107	typedef struct RTTARINTERNAL
108	{
109	/** The magic (RTTAR_MAGIC). */
110	uint32_t u32Magic;
111	/** The handle to the tar file. */
112	RTFILE hTarFile;
113	/** The open mode for hTarFile. */
114	uint32_t fOpenMode;
115	/** Whether a file within the archive is currently open for writing.
116	* Only one can be open. */
117	bool fFileOpenForWrite;
118	/** Whether operating in stream mode. */
119	bool fStreamMode;
120	/** The file cache of one file. */
121	PRTTARFILEINTERNAL pFileCache;
122	} RTTARINTERNAL;
123	/** Pointer to a the internal data of a tar handle. */
124	typedef RTTARINTERNAL* PRTTARINTERNAL;
125
126	/**
127	* The internal data of a file within a tar file.
128	*/
129	typedef struct RTTARFILEINTERNAL
130	{
131	/** The magic (RTTARFILE_MAGIC). */
132	uint32_t u32Magic;
133	/** Pointer to back to the tar file. */
134	PRTTARINTERNAL pTar;
135	/** The name of the file. */
136	char *pszFilename;
137	/** The offset into the archive where the file header starts. */
138	uint64_t offStart;
139	/** The size of the file. */
140	uint64_t cbSize;
141	/** The size set by RTTarFileSetSize(). */
142	uint64_t cbSetSize;
143	/** The current offset within this file. */
144	uint64_t offCurrent;
145	/** The open mode. */
146	uint32_t fOpenMode;
147	} RTTARFILEINTERNAL;
148	/** Pointer to the internal data of a tar file. */
149	typedef RTTARFILEINTERNAL *PRTTARFILEINTERNAL;
150
151
152	/******************************************************************************
153	* Defined Constants And Macros *
154	******************************************************************************/
155
156	/** Validates a handle and returns VERR_INVALID_HANDLE if not valid. */
157	/* RTTAR */
158	#define RTTAR_VALID_RETURN_RC(hHandle, rc) \
159	do { \
160	AssertPtrReturn((hHandle), (rc)); \
161	AssertReturn((hHandle)->u32Magic == RTTAR_MAGIC, (rc)); \
162	} while (0)
163	/* RTTARFILE */
164	#define RTTARFILE_VALID_RETURN_RC(hHandle, rc) \
165	do { \
166	AssertPtrReturn((hHandle), (rc)); \
167	AssertReturn((hHandle)->u32Magic == RTTARFILE_MAGIC, (rc)); \
168	} while (0)
169
170	/** Validates a handle and returns VERR_INVALID_HANDLE if not valid. */
171	/* RTTAR */
172	#define RTTAR_VALID_RETURN(hHandle) RTTAR_VALID_RETURN_RC((hHandle), VERR_INVALID_HANDLE)
173	/* RTTARFILE */
174	#define RTTARFILE_VALID_RETURN(hHandle) RTTARFILE_VALID_RETURN_RC((hHandle), VERR_INVALID_HANDLE)
175
176	/** Validates a handle and returns (void) if not valid. */
177	/* RTTAR */
178	#define RTTAR_VALID_RETURN_VOID(hHandle) \
179	do { \
180	AssertPtrReturnVoid(hHandle); \
181	AssertReturnVoid((hHandle)->u32Magic == RTTAR_MAGIC); \
182	} while (0)
183	/* RTTARFILE */
184	#define RTTARFILE_VALID_RETURN_VOID(hHandle) \
185	do { \
186	AssertPtrReturnVoid(hHandle); \
187	AssertReturnVoid((hHandle)->u32Magic == RTTARFILE_MAGIC); \
188	} while (0)
189
190
191	/******************************************************************************
192	* Internal Functions *
193	******************************************************************************/
194
195	DECLINLINE(void) rtTarSizeToRec(PRTTARRECORD pRecord, uint64_t cbSize)
196	{
197	/*
198	* Small enough for the standard octal string encoding?
199	*
200	* Note! We could actually use the terminator character as well if we liked,
201	* but let not do that as it's easier to test this way.
202	*/
203	if (cbSize < _4G * 2U)
204	RTStrPrintf(pRecord->h.size, sizeof(pRecord->h.size), "%0.11llo", cbSize);
205	else
206	{
207	/*
208	* Base 256 extension. Set the highest bit of the left most character.
209	* We don't deal with negatives here, cause the size have to be greater
210	* than zero.
211	*
212	* Note! The base-256 extension are never used by gtar or libarchive
213	* with the "ustar \0" format version, only the later
214	* "ustar\000" version. However, this shouldn't cause much
215	* trouble as they are not picky about what they read.
216	*/
217	size_t cchField = sizeof(pRecord->h.size) - 1;
218	unsigned char puchField = (unsigned char)pRecord->h.size;
219	puchField[0] = 0x80;
220	do
221	{
222	puchField[cchField--] = cbSize & 0xff;
223	cbSize >>= 8;
224	} while (cchField);
225	}
226	}
227
228	DECLINLINE(uint64_t) rtTarRecToSize(PRTTARRECORD pRecord)
229	{
230	int64_t cbSize = 0;
231	if (pRecord->h.size[0] & 0x80)
232	{
233	size_t cchField = sizeof(pRecord->h.size);
234	unsigned char const puchField = (unsigned char const )pRecord->h.size;
235
236	/*
237	* The first byte has the bit 7 set to indicate base-256, while bit 6
238	* is the signed bit. Bits 5:0 are the most significant value bits.
239	*/
240	cbSize = !(0x40 & *puchField) ? 0 : -1;
241	cbSize = (cbSize << 6) \| (*puchField & 0x3f);
242	cchField--;
243	puchField++;
244
245	/*
246	* The remaining bytes are used in full.
247	*/
248	while (cchField-- > 0)
249	{
250	if (RT_UNLIKELY( cbSize > INT64_MAX / 256
251	\|\| cbSize < INT64_MIN / 256))
252	{
253	cbSize = cbSize < 0 ? INT64_MIN : INT64_MAX;
254	break;
255	}
256	cbSize = (cbSize << 8) \| *puchField++;
257	}
258	}
259	else
260	RTStrToInt64Full(pRecord->h.size, 8, &cbSize);
261
262	if (cbSize < 0)
263	cbSize = 0;
264
265	return (uint64_t)cbSize;
266	}
267
268	DECLINLINE(int) rtTarCalcChkSum(PRTTARRECORD pRecord, uint32_t *pChkSum)
269	{
270	uint32_t check = 0;
271	uint32_t zero = 0;
272	for (size_t i = 0; i < sizeof(RTTARRECORD); ++i)
273	{
274	/* Calculate the sum of every byte from the header. The checksum field
275	* itself is counted as all blanks. */
276	if ( i < RT_UOFFSETOF(RTTARRECORD, h.chksum)
277	\|\| i >= RT_UOFFSETOF(RTTARRECORD, h.linkflag))
278	check += pRecord->d[i];
279	else
280	check += ' ';
281	/* Additional check if all fields are zero, which indicate EOF. */
282	zero += pRecord->d[i];
283	}
284
285	/* EOF? */
286	if (!zero)
287	return VERR_TAR_END_OF_FILE;
288
289	*pChkSum = check;
290	return VINF_SUCCESS;
291	}
292
293	DECLINLINE(int) rtTarReadHeaderRecord(RTFILE hFile, PRTTARRECORD pRecord)
294	{
295	int rc = RTFileRead(hFile, pRecord, sizeof(RTTARRECORD), NULL);
296	/* Check for EOF. EOF is valid in this case, cause it indicates no more
297	* data in the tar archive. */
298	if (rc == VERR_EOF)
299	return VERR_TAR_END_OF_FILE;
300	/* Report any other errors */
301	else if (RT_FAILURE(rc))
302	return rc;
303
304	/* Check for data integrity & an EOF record */
305	uint32_t check = 0;
306	rc = rtTarCalcChkSum(pRecord, &check);
307	/* EOF? */
308	if (RT_FAILURE(rc))
309	return rc;
310
311	/* Verify the checksum */
312	uint32_t sum;
313	rc = RTStrToUInt32Full(pRecord->h.chksum, 8, &sum);
314	if (RT_SUCCESS(rc) && sum == check)
315	{
316	/* Make sure the strings are zero terminated. */
317	pRecord->h.name[sizeof(pRecord->h.name) - 1] = 0;
318	pRecord->h.linkname[sizeof(pRecord->h.linkname) - 1] = 0;
319	pRecord->h.magic[sizeof(pRecord->h.magic) - 1] = 0;
320	pRecord->h.uname[sizeof(pRecord->h.uname) - 1] = 0;
321	pRecord->h.gname[sizeof(pRecord->h.gname) - 1] = 0;
322	}
323	else
324	rc = VERR_TAR_CHKSUM_MISMATCH;
325
326	return rc;
327	}
328
329	DECLINLINE(int) rtTarCreateHeaderRecord(PRTTARRECORD pRecord, const char *pszSrcName, uint64_t cbSize,
330	RTUID uid, RTGID gid, RTFMODE fmode, int64_t mtime)
331	{
332	/** @todo check for field overflows. */
333	/* Fill the header record */
334	// RT_ZERO(pRecord); - done by the caller.
335	RTStrPrintf(pRecord->h.name, sizeof(pRecord->h.name), "%s", pszSrcName);
336	RTStrPrintf(pRecord->h.mode, sizeof(pRecord->h.mode), "%0.7o", fmode);
337	RTStrPrintf(pRecord->h.uid, sizeof(pRecord->h.uid), "%0.7o", uid);
338	RTStrPrintf(pRecord->h.gid, sizeof(pRecord->h.gid), "%0.7o", gid);
339	rtTarSizeToRec(pRecord, cbSize);
340	RTStrPrintf(pRecord->h.mtime, sizeof(pRecord->h.mtime), "%0.11o", mtime);
341	RTStrPrintf(pRecord->h.magic, sizeof(pRecord->h.magic), "ustar ");
342	RTStrPrintf(pRecord->h.uname, sizeof(pRecord->h.uname), "someone");
343	RTStrPrintf(pRecord->h.gname, sizeof(pRecord->h.gname), "someone");
344	pRecord->h.linkflag = LF_NORMAL;
345
346	/* Create the checksum out of the new header */
347	uint32_t uChkSum = 0;
348	int rc = rtTarCalcChkSum(pRecord, &uChkSum);
349	if (RT_FAILURE(rc))
350	return rc;
351	/* Format the checksum */
352	RTStrPrintf(pRecord->h.chksum, sizeof(pRecord->h.chksum), "%0.7o", uChkSum);
353
354	return VINF_SUCCESS;
355	}
356
357	DECLINLINE(void ) rtTarMemTmpAlloc(size_t pcbSize)
358	{
359	*pcbSize = 0;
360	/* Allocate a reasonably large buffer, fall back on a tiny one.
361	* Note: has to be 512 byte aligned and >= 512 byte. */
362	size_t cbTmp = _1M;
363	void *pvTmp = RTMemTmpAlloc(cbTmp);
364	if (!pvTmp)
365	{
366	cbTmp = sizeof(RTTARRECORD);
367	pvTmp = RTMemTmpAlloc(cbTmp);
368	}
369	*pcbSize = cbTmp;
370	return pvTmp;
371	}
372
373	DECLINLINE(int) rtTarAppendZeros(RTTARFILE hFile, uint64_t cbSize)
374	{
375	/* Allocate a temporary buffer for copying the tar content in blocks. */
376	size_t cbTmp = 0;
377	void *pvTmp = rtTarMemTmpAlloc(&cbTmp);
378	if (!pvTmp)
379	return VERR_NO_MEMORY;
380	RT_BZERO(pvTmp, cbTmp);
381
382	int rc = VINF_SUCCESS;
383	uint64_t cbAllWritten = 0;
384	size_t cbWritten = 0;
385	for (;;)
386	{
387	if (cbAllWritten >= cbSize)
388	break;
389	size_t cbToWrite = RT_MIN(cbSize - cbAllWritten, cbTmp);
390	rc = RTTarFileWrite(hFile, pvTmp, cbToWrite, &cbWritten);
391	if (RT_FAILURE(rc))
392	break;
393	cbAllWritten += cbWritten;
394	}
395
396	RTMemTmpFree(pvTmp);
397
398	return rc;
399	}
400
401	DECLINLINE(PRTTARFILEINTERNAL) rtCreateTarFileInternal(PRTTARINTERNAL pInt, const char *pszFilename, uint32_t fOpen)
402	{
403	PRTTARFILEINTERNAL pFileInt = (PRTTARFILEINTERNAL)RTMemAllocZ(sizeof(RTTARFILEINTERNAL));
404	if (!pFileInt)
405	return NULL;
406
407	pFileInt->u32Magic = RTTARFILE_MAGIC;
408	pFileInt->pTar = pInt;
409	pFileInt->fOpenMode = fOpen;
410	pFileInt->pszFilename = RTStrDup(pszFilename);
411	if (!pFileInt->pszFilename)
412	{
413	RTMemFree(pFileInt);
414	return NULL;
415	}
416
417	return pFileInt;
418	}
419
420	DECLINLINE(PRTTARFILEINTERNAL) rtCopyTarFileInternal(PRTTARFILEINTERNAL pInt)
421	{
422	PRTTARFILEINTERNAL pNewInt = (PRTTARFILEINTERNAL)RTMemAllocZ(sizeof(RTTARFILEINTERNAL));
423	if (!pNewInt)
424	return NULL;
425
426	memcpy(pNewInt, pInt, sizeof(RTTARFILEINTERNAL));
427	pNewInt->pszFilename = RTStrDup(pInt->pszFilename);
428	if (!pNewInt->pszFilename)
429	{
430	RTMemFree(pNewInt);
431	return NULL;
432	}
433
434	return pNewInt;
435	}
436
437	DECLINLINE(void) rtDeleteTarFileInternal(PRTTARFILEINTERNAL pInt)
438	{
439	if (pInt)
440	{
441	if (pInt->pszFilename)
442	RTStrFree(pInt->pszFilename);
443	pInt->u32Magic = RTTARFILE_MAGIC_DEAD;
444	RTMemFree(pInt);
445	}
446	}
447
448	static int rtTarExtractFileToFile(RTTARFILE hFile, const char pszTargetName, const uint64_t cbOverallSize, uint64_t &cbOverallWritten, PFNRTPROGRESS pfnProgressCallback, void pvUser)
449	{
450	/* Open the target file */
451	RTFILE hNewFile;
452	int rc = RTFileOpen(&hNewFile, pszTargetName, RTFILE_O_CREATE \| RTFILE_O_WRITE \| RTFILE_O_DENY_WRITE);
453	if (RT_FAILURE(rc))
454	return rc;
455
456	void *pvTmp = NULL;
457	do
458	{
459	/* Allocate a temporary buffer for reading the tar content in blocks. */
460	size_t cbTmp = 0;
461	pvTmp = rtTarMemTmpAlloc(&cbTmp);
462	if (!pvTmp)
463	{
464	rc = VERR_NO_MEMORY;
465	break;
466	}
467
468	/* Get the size of the source file */
469	uint64_t cbToCopy = 0;
470	rc = RTTarFileGetSize(hFile, &cbToCopy);
471	if (RT_FAILURE(rc))
472	break;
473
474	/* Copy the content from hFile over to pszTargetName. */
475	uint64_t cbAllWritten = 0; /* Already copied */
476	uint64_t cbRead = 0; /* Actually read in the last step */
477	for (;;)
478	{
479	if (pfnProgressCallback)
480	pfnProgressCallback((unsigned)(100.0 / cbOverallSize * cbOverallWritten), pvUser);
481
482	/* Finished already? */
483	if (cbAllWritten == cbToCopy)
484	break;
485
486	/* Read one block. */
487	cbRead = RT_MIN(cbToCopy - cbAllWritten, cbTmp);
488	rc = RTTarFileRead(hFile, pvTmp, cbRead, NULL);
489	if (RT_FAILURE(rc))
490	break;
491
492	/* Write the block */
493	rc = RTFileWrite(hNewFile, pvTmp, cbRead, NULL);
494	if (RT_FAILURE(rc))
495	break;
496
497	/* Count how many bytes are written already */
498	cbAllWritten += cbRead;
499	cbOverallWritten += cbRead;
500	}
501
502	} while(0);
503
504	/* Cleanup */
505	if (pvTmp)
506	RTMemTmpFree(pvTmp);
507
508	/* Now set all file attributes */
509	if (RT_SUCCESS(rc))
510	{
511	uint32_t mode;
512	rc = RTTarFileGetMode(hFile, &mode);
513	if (RT_SUCCESS(rc))
514	{
515	mode \|= RTFS_TYPE_FILE; /* For now we support regular files only */
516	/* Set the mode */
517	rc = RTFileSetMode(hNewFile, mode);
518	}
519	}
520
521	RTFileClose(hNewFile);
522
523	/* Delete the freshly created file in the case of an error */
524	if (RT_FAILURE(rc))
525	RTFileDelete(pszTargetName);
526
527	return rc;
528	}
529
530	static int rtTarAppendFileFromFile(RTTAR hTar, const char pszSrcName, const uint64_t cbOverallSize, uint64_t &cbOverallWritten, PFNRTPROGRESS pfnProgressCallback, void pvUser)
531	{
532	/* Open the source file */
533	RTFILE hOldFile;
534	int rc = RTFileOpen(&hOldFile, pszSrcName, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_WRITE);
535	if (RT_FAILURE(rc))
536	return rc;
537
538	RTTARFILE hFile = NIL_RTTARFILE;
539	void *pvTmp = NULL;
540	do
541	{
542	/* Get the size of the source file */
543	uint64_t cbToCopy;
544	rc = RTFileGetSize(hOldFile, &cbToCopy);
545	if (RT_FAILURE(rc))
546	break;
547
548	rc = RTTarFileOpen(hTar, &hFile, RTPathFilename(pszSrcName), RTFILE_O_OPEN \| RTFILE_O_WRITE);
549	if (RT_FAILURE(rc))
550	break;
551
552	/* Get some info from the source file */
553	RTFSOBJINFO info;
554	RTUID uid = 0;
555	RTGID gid = 0;
556	RTFMODE fmode = 0600; /* Make some save default */
557	int64_t mtime = 0;
558
559	/* This isn't critical. Use the defaults if it fails. */
560	rc = RTFileQueryInfo(hOldFile, &info, RTFSOBJATTRADD_UNIX);
561	if (RT_SUCCESS(rc))
562	{
563	fmode = info.Attr.fMode & RTFS_UNIX_MASK;
564	uid = info.Attr.u.Unix.uid;
565	gid = info.Attr.u.Unix.gid;
566	mtime = RTTimeSpecGetSeconds(&info.ModificationTime);
567	}
568
569	/* Set the mode from the other file */
570	rc = RTTarFileSetMode(hFile, fmode);
571	if (RT_FAILURE(rc))
572	break;
573
574	/* Set the modification time from the other file */
575	RTTIMESPEC time;
576	RTTimeSpecSetSeconds(&time, mtime);
577	rc = RTTarFileSetTime(hFile, &time);
578	if (RT_FAILURE(rc))
579	break;
580
581	/* Set the owner from the other file */
582	rc = RTTarFileSetOwner(hFile, uid, gid);
583	if (RT_FAILURE(rc))
584	break;
585
586	/* Allocate a temporary buffer for copying the tar content in blocks. */
587	size_t cbTmp = 0;
588	pvTmp = rtTarMemTmpAlloc(&cbTmp);
589	if (!pvTmp)
590	{
591	rc = VERR_NO_MEMORY;
592	break;
593	}
594
595	/* Copy the content from pszSrcName over to hFile. This is done block
596	* wise in 512 byte steps. After this copying is finished hFile will be
597	* on a 512 byte boundary, regardless if the file copied is 512 byte
598	* size aligned. */
599	uint64_t cbAllWritten = 0; /* Already copied */
600	uint64_t cbRead = 0; /* Actually read in the last step */
601	uint64_t cbWrite = 0; /* Actually write in the last step */
602	for (;;)
603	{
604	if (pfnProgressCallback)
605	pfnProgressCallback((unsigned)(100.0 / cbOverallSize * cbOverallWritten), pvUser);
606	if (cbAllWritten >= cbToCopy)
607	break;
608
609	/* Read one block. Either its the buffer size or the rest of the
610	* file. */
611	cbRead = RT_MIN(cbToCopy - cbAllWritten, cbTmp);
612	rc = RTFileRead(hOldFile, pvTmp, cbRead, NULL);
613	if (RT_FAILURE(rc))
614	break;
615
616	/* Write one block. */
617	rc = RTTarFileWriteAt(hFile, cbAllWritten, pvTmp, cbRead, NULL);
618	if (RT_FAILURE(rc))
619	break;
620
621	/* Count how many bytes (of the original file) are written already */
622	cbAllWritten += cbRead;
623	cbOverallWritten += cbRead;
624	}
625	} while (0);
626
627	/* Cleanup */
628	if (pvTmp)
629	RTMemTmpFree(pvTmp);
630
631	if (hFile)
632	RTTarFileClose(hFile);
633
634	RTFileClose(hOldFile);
635
636	return rc;
637	}
638
639	static int rtTarSkipData(RTFILE hFile, PRTTARRECORD pRecord)
640	{
641	int rc = VINF_SUCCESS;
642	/* Seek over the data parts (512 bytes aligned) */
643	int64_t offSeek = RT_ALIGN(rtTarRecToSize(pRecord), sizeof(RTTARRECORD));
644	if (offSeek > 0)
645	rc = RTFileSeek(hFile, offSeek, RTFILE_SEEK_CURRENT, NULL);
646	return rc;
647	}
648
649	static int rtTarFindFile(RTFILE hFile, const char pszFile, uint64_t poff, uint64_t *pcbSize)
650	{
651	/* Assume we are on the file head. */
652	int rc = VINF_SUCCESS;
653	bool fFound = false;
654	RTTARRECORD record;
655	for (;;)
656	{
657	/* Read & verify a header record */
658	rc = rtTarReadHeaderRecord(hFile, &record);
659	/* Check for error or EOF. */
660	if (RT_FAILURE(rc))
661	break;
662
663	/* We support normal files only */
664	if ( record.h.linkflag == LF_OLDNORMAL
665	\|\| record.h.linkflag == LF_NORMAL)
666	{
667	if (!RTStrCmp(record.h.name, pszFile))
668	{
669	/* Get the file size */
670	*pcbSize = rtTarRecToSize(&record);
671	/* Seek back, to position the file pointer at the start of the header. */
672	rc = RTFileSeek(hFile, -(int64_t)sizeof(RTTARRECORD), RTFILE_SEEK_CURRENT, poff);
673	fFound = true;
674	break;
675	}
676	}
677	rc = rtTarSkipData(hFile, &record);
678	if (RT_FAILURE(rc))
679	break;
680	}
681
682	if (rc == VERR_TAR_END_OF_FILE)
683	rc = VINF_SUCCESS;
684
685	/* Something found? */
686	if ( RT_SUCCESS(rc)
687	&& !fFound)
688	rc = VERR_FILE_NOT_FOUND;
689
690	return rc;
691	}
692
693	static int rtTarGetFilesOverallSize(RTFILE hFile, const char * const papszFiles, size_t cFiles, uint64_t pcbOverallSize)
694	{
695	int rc = VINF_SUCCESS;
696	size_t cFound = 0;
697	RTTARRECORD record;
698	for (;;)
699	{
700	/* Read & verify a header record */
701	rc = rtTarReadHeaderRecord(hFile, &record);
702	/* Check for error or EOF. */
703	if (RT_FAILURE(rc))
704	break;
705
706	/* We support normal files only */
707	if ( record.h.linkflag == LF_OLDNORMAL
708	\|\| record.h.linkflag == LF_NORMAL)
709	{
710	for (size_t i = 0; i < cFiles; ++i)
711	{
712	if (!RTStrCmp(record.h.name, papszFiles[i]))
713	{
714	/* Sum up the overall size */
715	*pcbOverallSize += rtTarRecToSize(&record);
716	++cFound;
717	break;
718	}
719	}
720	if ( cFound == cFiles
721	\|\| RT_FAILURE(rc))
722	break;
723	}
724	rc = rtTarSkipData(hFile, &record);
725	if (RT_FAILURE(rc))
726	break;
727	}
728	if (rc == VERR_TAR_END_OF_FILE)
729	rc = VINF_SUCCESS;
730
731	/* Make sure the file pointer is at the begin of the file again. */
732	if (RT_SUCCESS(rc))
733	rc = RTFileSeek(hFile, 0, RTFILE_SEEK_BEGIN, 0);
734	return rc;
735	}
736
737	/******************************************************************************
738	* Public Functions *
739	******************************************************************************/
740
741	RTR3DECL(int) RTTarOpen(PRTTAR phTar, const char *pszTarname, uint32_t fMode, bool fStream)
742	{
743	/*
744	* Create a tar instance.
745	*/
746	PRTTARINTERNAL pThis = (PRTTARINTERNAL)RTMemAllocZ(sizeof(RTTARINTERNAL));
747	if (!pThis)
748	return VERR_NO_MEMORY;
749
750	pThis->u32Magic = RTTAR_MAGIC;
751	pThis->fOpenMode = fMode;
752	pThis->fStreamMode = fStream && (fMode & RTFILE_O_READ);
753
754	/*
755	* Open the tar file.
756	*/
757	int rc = RTFileOpen(&pThis->hTarFile, pszTarname, fMode);
758	if (RT_SUCCESS(rc))
759	{
760	*phTar = pThis;
761	return VINF_SUCCESS;
762	}
763
764	RTMemFree(pThis);
765	return rc;
766	}
767
768	RTR3DECL(int) RTTarClose(RTTAR hTar)
769	{
770	if (hTar == NIL_RTTAR)
771	return VINF_SUCCESS;
772
773	PRTTARINTERNAL pInt = hTar;
774	RTTAR_VALID_RETURN(pInt);
775
776	int rc = VINF_SUCCESS;
777
778	/* gtar gives a warning, but the documentation says EOF is indicated by a
779	* zero block. Disabled for now. */
780	#if 0
781	{
782	/* Append the EOF record which is filled all by zeros */
783	RTTARRECORD record;
784	RT_ZERO(record);
785	rc = RTFileWrite(pInt->hTarFile, &record, sizeof(record), NULL);
786	}
787	#endif
788
789	if (pInt->hTarFile != NIL_RTFILE)
790	rc = RTFileClose(pInt->hTarFile);
791
792	/* Delete any remaining cached file headers. */
793	if (pInt->pFileCache)
794	{
795	rtDeleteTarFileInternal(pInt->pFileCache);
796	pInt->pFileCache = NULL;
797	}
798
799	pInt->u32Magic = RTTAR_MAGIC_DEAD;
800
801	RTMemFree(pInt);
802
803	return rc;
804	}
805
806	RTR3DECL(int) RTTarFileOpen(RTTAR hTar, PRTTARFILE phFile, const char *pszFilename, uint32_t fOpen)
807	{
808	AssertReturn((fOpen & RTFILE_O_READ) \|\| (fOpen & RTFILE_O_WRITE), VERR_INVALID_PARAMETER);
809
810	PRTTARINTERNAL pInt = hTar;
811	RTTAR_VALID_RETURN(pInt);
812
813	if (!pInt->hTarFile)
814	return VERR_INVALID_HANDLE;
815
816	if (pInt->fStreamMode)
817	return VERR_INVALID_STATE;
818
819	if (fOpen & RTFILE_O_WRITE)
820	{
821	if (!(pInt->fOpenMode & RTFILE_O_WRITE))
822	return VERR_WRITE_PROTECT;
823	if (pInt->fFileOpenForWrite)
824	return VERR_TOO_MANY_OPEN_FILES;
825	}
826
827	PRTTARFILEINTERNAL pFileInt = rtCreateTarFileInternal(pInt, pszFilename, fOpen);
828	if (!pFileInt)
829	return VERR_NO_MEMORY;
830
831	int rc = VINF_SUCCESS;
832	do /* break loop */
833	{
834	if (pFileInt->fOpenMode & RTFILE_O_WRITE)
835	{
836	pInt->fFileOpenForWrite = true;
837
838	/* If we are in write mode, we also in append mode. Add an dummy
839	* header at the end of the current file. It will be filled by the
840	* close operation. */
841	rc = RTFileSeek(pFileInt->pTar->hTarFile, 0, RTFILE_SEEK_END, &pFileInt->offStart);
842	if (RT_FAILURE(rc))
843	break;
844	RTTARRECORD record;
845	RT_ZERO(record);
846	rc = RTFileWrite(pFileInt->pTar->hTarFile, &record, sizeof(RTTARRECORD), NULL);
847	if (RT_FAILURE(rc))
848	break;
849	}
850	else if (pFileInt->fOpenMode & RTFILE_O_READ)
851	{
852	/* We need to be on the start of the file */
853	rc = RTFileSeek(pFileInt->pTar->hTarFile, 0, RTFILE_SEEK_BEGIN, NULL);
854	if (RT_FAILURE(rc))
855	break;
856
857	/* Search for the file. */
858	rc = rtTarFindFile(pFileInt->pTar->hTarFile, pszFilename, &pFileInt->offStart, &pFileInt->cbSize);
859	if (RT_FAILURE(rc))
860	break;
861	}
862	else
863	{
864	/** @todo is something missing here? */
865	}
866
867	} while (0);
868
869	/* Cleanup on failure */
870	if (RT_FAILURE(rc))
871	{
872	if (pFileInt->pszFilename)
873	RTStrFree(pFileInt->pszFilename);
874	RTMemFree(pFileInt);
875	}
876	else
877	*phFile = (RTTARFILE)pFileInt;
878
879	return rc;
880	}
881
882	RTR3DECL(int) RTTarFileClose(RTTARFILE hFile)
883	{
884	/* Already closed? */
885	if (hFile == NIL_RTTARFILE)
886	return VINF_SUCCESS;
887
888	PRTTARFILEINTERNAL pFileInt = hFile;
889	RTTARFILE_VALID_RETURN(pFileInt);
890
891	int rc = VINF_SUCCESS;
892
893	/* In write mode: */
894	if (pFileInt->fOpenMode & RTFILE_O_READ)
895	{
896	/* In read mode, we want to make sure to stay at the aligned end of this
897	* file, so the next file could be read immediately. */
898	uint64_t offCur = RTFileTell(pFileInt->pTar->hTarFile);
899
900	/* Check that the file pointer is somewhere within the last open file.
901	* If we are at the beginning (nothing read yet) nothing will be done.
902	* A user could open/close a file more than once, without reading
903	* something. */
904	if ( pFileInt->offStart + sizeof(RTTARRECORD) < offCur
905	&& offCur < RT_ALIGN(pFileInt->offStart + sizeof(RTTARRECORD) + pFileInt->cbSize, sizeof(RTTARRECORD)))
906	{
907	/* Seek to the next file header. */
908	uint64_t offNext = RT_ALIGN(pFileInt->offStart + sizeof(RTTARRECORD) + pFileInt->cbSize, sizeof(RTTARRECORD));
909	rc = RTFileSeek(pFileInt->pTar->hTarFile, offNext - offCur, RTFILE_SEEK_CURRENT, NULL);
910	}
911	}
912	else if (pFileInt->fOpenMode & RTFILE_O_WRITE)
913	{
914	pFileInt->pTar->fFileOpenForWrite = false;
915	do
916	{
917	/* If the user has called RTTarFileSetSize in the meantime, we have
918	to make sure the file has the right size. */
919	if (pFileInt->cbSetSize > pFileInt->cbSize)
920	{
921	rc = rtTarAppendZeros(hFile, pFileInt->cbSetSize - pFileInt->cbSize);
922	if (RT_FAILURE(rc))
923	break;
924	}
925
926	/* If the written size isn't 512 byte aligned, we need to fix this. */
927	RTTARRECORD record;
928	RT_ZERO(record);
929	uint64_t cbSizeAligned = RT_ALIGN(pFileInt->cbSize, sizeof(RTTARRECORD));
930	if (cbSizeAligned != pFileInt->cbSize)
931	{
932	/* Note the RTFile method. We didn't increase the cbSize or cbCurrentPos here. */
933	rc = RTFileWriteAt(pFileInt->pTar->hTarFile,
934	pFileInt->offStart + sizeof(RTTARRECORD) + pFileInt->cbSize,
935	&record,
936	cbSizeAligned - pFileInt->cbSize,
937	NULL);
938	if (RT_FAILURE(rc))
939	break;
940	}
941
942	/* Create a header record for the file */
943	/* Todo: mode, gid, uid, mtime should be setable (or detected myself) */
944	RTTIMESPEC time;
945	RTTimeNow(&time);
946	rc = rtTarCreateHeaderRecord(&record, pFileInt->pszFilename, pFileInt->cbSize,
947	0, 0, 0600, RTTimeSpecGetSeconds(&time));
948	if (RT_FAILURE(rc))
949	break;
950
951	/* Write this at the start of the file data */
952	rc = RTFileWriteAt(pFileInt->pTar->hTarFile, pFileInt->offStart, &record, sizeof(RTTARRECORD), NULL);
953	if (RT_FAILURE(rc))
954	break;
955	}
956	while(0);
957	}
958
959	/* Now cleanup and delete the handle */
960	rtDeleteTarFileInternal(pFileInt);
961
962	return rc;
963	}
964
965	RTR3DECL(int) RTTarFileSeek(RTTARFILE hFile, uint64_t offSeek, unsigned uMethod, uint64_t *poffActual)
966	{
967	PRTTARFILEINTERNAL pFileInt = hFile;
968	RTTARFILE_VALID_RETURN(pFileInt);
969
970	if (pFileInt->pTar->fStreamMode)
971	return VERR_INVALID_STATE;
972
973	switch (uMethod)
974	{
975	case RTFILE_SEEK_BEGIN:
976	{
977	if (offSeek > pFileInt->cbSize)
978	return VERR_SEEK_ON_DEVICE;
979	pFileInt->offCurrent = offSeek;
980	break;
981	}
982	case RTFILE_SEEK_CURRENT:
983	{
984	if (pFileInt->offCurrent + offSeek > pFileInt->cbSize)
985	return VERR_SEEK_ON_DEVICE;
986	pFileInt->offCurrent += offSeek;
987	break;
988	}
989	case RTFILE_SEEK_END:
990	{
991	if ((int64_t)pFileInt->cbSize - (int64_t)offSeek < 0)
992	return VERR_NEGATIVE_SEEK;
993	pFileInt->offCurrent = pFileInt->cbSize - offSeek;
994	break;
995	}
996	default: AssertFailedReturn(VERR_INVALID_PARAMETER); break;
997	}
998
999	return VINF_SUCCESS;
1000	}
1001
1002	RTR3DECL(uint64_t) RTTarFileTell(RTTARFILE hFile)
1003	{
1004	PRTTARFILEINTERNAL pFileInt = hFile;
1005	RTTARFILE_VALID_RETURN_RC(pFileInt, UINT64_MAX);
1006
1007	return pFileInt->offCurrent;
1008	}
1009
1010	RTR3DECL(int) RTTarFileRead(RTTARFILE hFile, void pvBuf, size_t cbToRead, size_t pcbRead)
1011	{
1012	PRTTARFILEINTERNAL pFileInt = hFile;
1013	RTTARFILE_VALID_RETURN(pFileInt);
1014
1015	/* Todo: optimize this, by checking the current pos */
1016	return RTTarFileReadAt(hFile, pFileInt->offCurrent, pvBuf, cbToRead, pcbRead);
1017	}
1018
1019	RTR3DECL(int) RTTarFileReadAt(RTTARFILE hFile, uint64_t off, void pvBuf, size_t cbToRead, size_t pcbRead)
1020	{
1021	PRTTARFILEINTERNAL pFileInt = hFile;
1022	RTTARFILE_VALID_RETURN(pFileInt);
1023
1024	/* Check that we not read behind the end of file. If so return immediately. */
1025	if (off > pFileInt->cbSize)
1026	{
1027	if (pcbRead)
1028	*pcbRead = 0;
1029	return VINF_SUCCESS; /* ??? VERR_EOF */
1030	}
1031
1032	size_t cbToCopy = RT_MIN(pFileInt->cbSize - off, cbToRead);
1033	size_t cbTmpRead = 0;
1034	int rc = RTFileReadAt(pFileInt->pTar->hTarFile, pFileInt->offStart + 512 + off, pvBuf, cbToCopy, &cbTmpRead);
1035	pFileInt->offCurrent = off + cbTmpRead;
1036	if (pcbRead)
1037	*pcbRead = cbTmpRead;
1038
1039	return rc;
1040	}
1041
1042	RTR3DECL(int) RTTarFileWrite(RTTARFILE hFile, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
1043	{
1044	PRTTARFILEINTERNAL pFileInt = hFile;
1045	RTTARFILE_VALID_RETURN(pFileInt);
1046
1047	/** @todo Optimize this, by checking the current pos */
1048	return RTTarFileWriteAt(hFile, pFileInt->offCurrent, pvBuf, cbToWrite, pcbWritten);
1049	}
1050
1051	RTR3DECL(int) RTTarFileWriteAt(RTTARFILE hFile, uint64_t off, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
1052	{
1053	PRTTARFILEINTERNAL pFileInt = hFile;
1054	RTTARFILE_VALID_RETURN(pFileInt);
1055
1056	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1057	return VERR_WRITE_ERROR;
1058
1059	size_t cbTmpWritten = 0;
1060	int rc = RTFileWriteAt(pFileInt->pTar->hTarFile, pFileInt->offStart + 512 + off, pvBuf, cbToWrite, &cbTmpWritten);
1061	pFileInt->cbSize += cbTmpWritten;
1062	pFileInt->offCurrent = off + cbTmpWritten;
1063	if (pcbWritten)
1064	*pcbWritten = cbTmpWritten;
1065
1066	return rc;
1067	}
1068
1069	RTR3DECL(int) RTTarFileGetSize(RTTARFILE hFile, uint64_t *pcbSize)
1070	{
1071	/* Validate input */
1072	AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
1073
1074	PRTTARFILEINTERNAL pFileInt = hFile;
1075	RTTARFILE_VALID_RETURN(pFileInt);
1076
1077	*pcbSize = RT_MAX(pFileInt->cbSetSize, pFileInt->cbSize);
1078
1079	return VINF_SUCCESS;
1080	}
1081
1082	RTR3DECL(int) RTTarFileSetSize(RTTARFILE hFile, uint64_t cbSize)
1083	{
1084	PRTTARFILEINTERNAL pFileInt = hFile;
1085	RTTARFILE_VALID_RETURN(pFileInt);
1086
1087	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1088	return VERR_WRITE_ERROR;
1089
1090	/** @todo If cbSize is smaller than pFileInt->cbSize we have to
1091	* truncate the current file. */
1092	pFileInt->cbSetSize = cbSize;
1093
1094	return VINF_SUCCESS;
1095	}
1096
1097	RTR3DECL(int) RTTarFileGetMode(RTTARFILE hFile, uint32_t *pfMode)
1098	{
1099	/* Validate input */
1100	AssertPtrReturn(pfMode, VERR_INVALID_POINTER);
1101
1102	PRTTARFILEINTERNAL pFileInt = hFile;
1103	RTTARFILE_VALID_RETURN(pFileInt);
1104
1105	/* Read the mode out of the header entry */
1106	char szMode[RT_SIZEOFMEMB(RTTARRECORD, h.mode)+1];
1107	int rc = RTFileReadAt(pFileInt->pTar->hTarFile,
1108	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.mode),
1109	szMode,
1110	RT_SIZEOFMEMB(RTTARRECORD, h.mode),
1111	NULL);
1112	if (RT_FAILURE(rc))
1113	return rc;
1114	szMode[sizeof(szMode) - 1] = '\0';
1115
1116	/* Convert it to an integer */
1117	return RTStrToUInt32Full(szMode, 8, pfMode);
1118	}
1119
1120	RTR3DECL(int) RTTarFileSetMode(RTTARFILE hFile, uint32_t fMode)
1121	{
1122	PRTTARFILEINTERNAL pFileInt = hFile;
1123	RTTARFILE_VALID_RETURN(pFileInt);
1124
1125	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1126	return VERR_WRITE_ERROR;
1127
1128	/* Convert the mode to an string. */
1129	char szMode[RT_SIZEOFMEMB(RTTARRECORD, h.mode)];
1130	RTStrPrintf(szMode, sizeof(szMode), "%0.7o", fMode);
1131
1132	/* Write it directly into the header */
1133	return RTFileWriteAt(pFileInt->pTar->hTarFile,
1134	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.mode),
1135	szMode,
1136	RT_SIZEOFMEMB(RTTARRECORD, h.mode),
1137	NULL);
1138	}
1139
1140	RTR3DECL(int) RTTarFileGetTime(RTTARFILE hFile, PRTTIMESPEC pTime)
1141	{
1142	PRTTARFILEINTERNAL pFileInt = hFile;
1143	RTTARFILE_VALID_RETURN(pFileInt);
1144
1145	/* Read the time out of the header entry */
1146	char szModTime[RT_SIZEOFMEMB(RTTARRECORD, h.mtime) + 1];
1147	int rc = RTFileReadAt(pFileInt->pTar->hTarFile,
1148	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.mtime),
1149	szModTime,
1150	RT_SIZEOFMEMB(RTTARRECORD, h.mtime),
1151	NULL);
1152	if (RT_FAILURE(rc))
1153	return rc;
1154	szModTime[sizeof(szModTime) - 1] = '\0';
1155
1156	/* Convert it to an integer */
1157	int64_t cSeconds;
1158	rc = RTStrToInt64Full(szModTime, 12, &cSeconds);
1159
1160	/* And back to our time structure */
1161	if (RT_SUCCESS(rc))
1162	RTTimeSpecSetSeconds(pTime, cSeconds);
1163
1164	return rc;
1165	}
1166
1167	RTR3DECL(int) RTTarFileSetTime(RTTARFILE hFile, PRTTIMESPEC pTime)
1168	{
1169	PRTTARFILEINTERNAL pFileInt = hFile;
1170	RTTARFILE_VALID_RETURN(pFileInt);
1171
1172	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1173	return VERR_WRITE_ERROR;
1174
1175	/* Convert the time to an string. */
1176	char szModTime[RT_SIZEOFMEMB(RTTARRECORD, h.mtime)];
1177	RTStrPrintf(szModTime, sizeof(szModTime), "%0.11o", RTTimeSpecGetSeconds(pTime));
1178
1179	/* Write it directly into the header */
1180	return RTFileWriteAt(pFileInt->pTar->hTarFile,
1181	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.mtime),
1182	szModTime,
1183	RT_SIZEOFMEMB(RTTARRECORD, h.mtime),
1184	NULL);
1185	}
1186
1187	RTR3DECL(int) RTTarFileGetOwner(RTTARFILE hFile, uint32_t pUid, uint32_t pGid)
1188	{
1189	PRTTARFILEINTERNAL pFileInt = hFile;
1190	RTTARFILE_VALID_RETURN(pFileInt);
1191
1192	/* Read the uid and gid out of the header entry */
1193	AssertCompileAdjacentMembers(RTTARRECORD, h.uid, h.gid);
1194	char szUidGid[RT_SIZEOFMEMB(RTTARRECORD, h.uid) + RT_SIZEOFMEMB(RTTARRECORD, h.gid) + 1];
1195	int rc = RTFileReadAt(pFileInt->pTar->hTarFile,
1196	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.uid),
1197	szUidGid,
1198	sizeof(szUidGid) - 1,
1199	NULL);
1200	if (RT_FAILURE(rc))
1201	return rc;
1202	szUidGid[sizeof(szUidGid) - 1] = '\0';
1203
1204	/* Convert it to integer */
1205	rc = RTStrToUInt32Full(&szUidGid[RT_SIZEOFMEMB(RTTARRECORD, h.uid)], 8, pGid);
1206	if (RT_SUCCESS(rc))
1207	{
1208	szUidGid[RT_SIZEOFMEMB(RTTARRECORD, h.uid)] = '\0';
1209	rc = RTStrToUInt32Full(szUidGid, 8, pUid);
1210	}
1211	return rc;
1212	}
1213
1214	RTR3DECL(int) RTTarFileSetOwner(RTTARFILE hFile, uint32_t uid, uint32_t gid)
1215	{
1216	PRTTARFILEINTERNAL pFileInt = hFile;
1217	RTTARFILE_VALID_RETURN(pFileInt);
1218
1219	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1220	return VERR_WRITE_ERROR;
1221	AssertReturn(uid == (uint32_t)-1 \|\| uid <= 07777777, VERR_OUT_OF_RANGE);
1222	AssertReturn(gid == (uint32_t)-1 \|\| gid <= 07777777, VERR_OUT_OF_RANGE);
1223
1224	int rc = VINF_SUCCESS;
1225
1226	if (uid != (uint32_t)-1)
1227	{
1228	/* Convert the uid to an string. */
1229	char szUid[RT_SIZEOFMEMB(RTTARRECORD, h.uid)];
1230	RTStrPrintf(szUid, sizeof(szUid), "%0.7o", uid);
1231
1232	/* Write it directly into the header */
1233	rc = RTFileWriteAt(pFileInt->pTar->hTarFile,
1234	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.uid),
1235	szUid,
1236	RT_SIZEOFMEMB(RTTARRECORD, h.uid),
1237	NULL);
1238	if (RT_FAILURE(rc))
1239	return rc;
1240	}
1241
1242	if (gid != (uint32_t)-1)
1243	{
1244	/* Convert the gid to an string. */
1245	char szGid[RT_SIZEOFMEMB(RTTARRECORD, h.gid)];
1246	RTStrPrintf(szGid, sizeof(szGid), "%0.7o", gid);
1247
1248	/* Write it directly into the header */
1249	rc = RTFileWriteAt(pFileInt->pTar->hTarFile,
1250	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.gid),
1251	szGid,
1252	RT_SIZEOFMEMB(RTTARRECORD, h.gid),
1253	NULL);
1254	if (RT_FAILURE(rc))
1255	return rc;
1256	}
1257
1258	return rc;
1259	}
1260
1261	/******************************************************************************
1262	* Convenience Functions *
1263	******************************************************************************/
1264
1265	RTR3DECL(int) RTTarFileExists(const char pszTarFile, const char pszFile)
1266	{
1267	/* Validate input */
1268	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1269	AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1270
1271	/* Open the tar file */
1272	RTTAR hTar;
1273	int rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE, false /fStream/);
1274	if (RT_FAILURE(rc))
1275	return rc;
1276
1277	/* Just try to open that file readonly. If this succeed the file exists. */
1278	RTTARFILE hFile;
1279	rc = RTTarFileOpen(hTar, &hFile, pszFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE);
1280	if (RT_SUCCESS(rc))
1281	RTTarFileClose(hFile);
1282
1283	RTTarClose(hTar);
1284
1285	return rc;
1286	}
1287
1288	RTR3DECL(int) RTTarList(const char pszTarFile, char *ppapszFiles, size_t pcFiles)
1289	{
1290	/* Validate input */
1291	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1292	AssertPtrReturn(ppapszFiles, VERR_INVALID_POINTER);
1293	AssertPtrReturn(pcFiles, VERR_INVALID_POINTER);
1294
1295	/* Open the tar file */
1296	RTTAR hTar;
1297	int rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE, false /fStream/);
1298	if (RT_FAILURE(rc))
1299	return rc;
1300
1301	/* This is done by internal methods, cause we didn't have a RTTARDIR
1302	* interface, yet. This should be fixed someday. */
1303
1304	PRTTARINTERNAL pInt = hTar;
1305	char **papszFiles = NULL;
1306	size_t cFiles = 0;
1307	do /* break loop */
1308	{
1309	/* Initialize the file name array with one slot */
1310	size_t cFilesAlloc = 1;
1311	papszFiles = (char *)RTMemAlloc(sizeof(char ));
1312	if (!papszFiles)
1313	{
1314	rc = VERR_NO_MEMORY;
1315	break;
1316	}
1317
1318	/* Iterate through the tar file record by record. Skip data records as we
1319	* didn't need them. */
1320	RTTARRECORD record;
1321	for (;;)
1322	{
1323	/* Read & verify a header record */
1324	rc = rtTarReadHeaderRecord(pInt->hTarFile, &record);
1325	/* Check for error or EOF. */
1326	if (RT_FAILURE(rc))
1327	break;
1328	/* We support normal files only */
1329	if ( record.h.linkflag == LF_OLDNORMAL
1330	\|\| record.h.linkflag == LF_NORMAL)
1331	{
1332	if (cFiles >= cFilesAlloc)
1333	{
1334	/* Double the array size, make sure the size doesn't wrap. */
1335	void *pvNew = NULL;
1336	size_t cbNew = cFilesAlloc * sizeof(char ) 2;
1337	if (cbNew / sizeof(char *) / 2 == cFilesAlloc)
1338	pvNew = RTMemRealloc(papszFiles, cbNew);
1339	if (!pvNew)
1340	{
1341	rc = VERR_NO_MEMORY;
1342	break;
1343	}
1344	papszFiles = (char **)pvNew;
1345	cFilesAlloc *= 2;
1346	}
1347
1348	/* Duplicate the name */
1349	papszFiles[cFiles] = RTStrDup(record.h.name);
1350	if (!papszFiles[cFiles])
1351	{
1352	rc = VERR_NO_MEMORY;
1353	break;
1354	}
1355	cFiles++;
1356	}
1357	rc = rtTarSkipData(pInt->hTarFile, &record);
1358	if (RT_FAILURE(rc))
1359	break;
1360	}
1361	} while(0);
1362
1363	if (rc == VERR_TAR_END_OF_FILE)
1364	rc = VINF_SUCCESS;
1365
1366	/* Return the file array on success, dispose of it on failure. */
1367	if (RT_SUCCESS(rc))
1368	{
1369	*pcFiles = cFiles;
1370	*ppapszFiles = papszFiles;
1371	}
1372	else
1373	{
1374	while (cFiles-- > 0)
1375	RTStrFree(papszFiles[cFiles]);
1376	RTMemFree(papszFiles);
1377	}
1378
1379	RTTarClose(hTar);
1380
1381	return rc;
1382	}
1383
1384	RTR3DECL(int) RTTarExtractFileToBuf(const char pszTarFile, void ppvBuf, size_t pcbSize, const char *pszFile,
1385	PFNRTPROGRESS pfnProgressCallback, void *pvUser)
1386	{
1387	/*
1388	* Validate input
1389	*/
1390	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1391	AssertPtrReturn(ppvBuf, VERR_INVALID_POINTER);
1392	AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
1393	AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1394	AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
1395	AssertPtrNullReturn(pvUser, VERR_INVALID_POINTER);
1396
1397	/** @todo progress bar - is this TODO still valid? */
1398
1399	int rc = VINF_SUCCESS;
1400	RTTAR hTar = NIL_RTTAR;
1401	RTTARFILE hFile = NIL_RTTARFILE;
1402	char *pvTmp = NULL;
1403	uint64_t cbToCopy= 0;
1404	do /* break loop */
1405	{
1406	rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE, false /fStream/);
1407	if (RT_FAILURE(rc))
1408	break;
1409	rc = RTTarFileOpen(hTar, &hFile, pszFile, RTFILE_O_OPEN \| RTFILE_O_READ);
1410	if (RT_FAILURE(rc))
1411	break;
1412	rc = RTTarFileGetSize(hFile, &cbToCopy);
1413	if (RT_FAILURE(rc))
1414	break;
1415
1416	/* Allocate the memory for the file content. */
1417	pvTmp = (char *)RTMemAlloc(cbToCopy);
1418	if (!pvTmp)
1419	{
1420	rc = VERR_NO_MEMORY;
1421	break;
1422	}
1423	size_t cbRead = 0;
1424	size_t cbAllRead = 0;
1425	for (;;)
1426	{
1427	if (pfnProgressCallback)
1428	pfnProgressCallback((unsigned)(100.0 / cbToCopy * cbAllRead), pvUser);
1429	if (cbAllRead == cbToCopy)
1430	break;
1431	rc = RTTarFileReadAt(hFile, 0, &pvTmp[cbAllRead], cbToCopy - cbAllRead, &cbRead);
1432	if (RT_FAILURE(rc))
1433	break;
1434	cbAllRead += cbRead;
1435	}
1436	} while (0);
1437
1438	/* Set output values on success */
1439	if (RT_SUCCESS(rc))
1440	{
1441	*pcbSize = cbToCopy;
1442	*ppvBuf = pvTmp;
1443	}
1444
1445	/* Cleanup */
1446	if ( RT_FAILURE(rc)
1447	&& pvTmp)
1448	RTMemFree(pvTmp);
1449	if (hFile)
1450	RTTarFileClose(hFile);
1451	if (hTar)
1452	RTTarClose(hTar);
1453
1454	return rc;
1455	}
1456
1457	RTR3DECL(int) RTTarExtractFiles(const char pszTarFile, const char pszOutputDir, const char * const *papszFiles,
1458	size_t cFiles, PFNRTPROGRESS pfnProgressCallback, void *pvUser)
1459	{
1460	/* Validate input */
1461	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1462	AssertPtrReturn(pszOutputDir, VERR_INVALID_POINTER);
1463	AssertPtrReturn(papszFiles, VERR_INVALID_POINTER);
1464	AssertReturn(cFiles, VERR_INVALID_PARAMETER);
1465	AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
1466	AssertPtrNullReturn(pvUser, VERR_INVALID_POINTER);
1467
1468	/* Open the tar file */
1469	RTTAR hTar;
1470	int rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE, false /fStream/);
1471	if (RT_FAILURE(rc))
1472	return rc;
1473
1474	do /* break loop */
1475	{
1476	/* Get the overall size of all files to extract out of the tar archive
1477	headers. Only necessary if there is a progress callback. */
1478	uint64_t cbOverallSize = 0;
1479	if (pfnProgressCallback)
1480	{
1481	// rc = rtTarGetFilesOverallSize(hFile, papszFiles, cFiles, &cbOverallSize);
1482	// if (RT_FAILURE(rc))
1483	// break;
1484	}
1485
1486	uint64_t cbOverallWritten = 0;
1487	for (size_t i = 0; i < cFiles; ++i)
1488	{
1489	RTTARFILE hFile;
1490	rc = RTTarFileOpen(hTar, &hFile, papszFiles[i], RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE);
1491	if (RT_FAILURE(rc))
1492	break;
1493	char *pszTargetFile = RTPathJoinA(pszOutputDir, papszFiles[i]);
1494	if (pszTargetFile)
1495	rc = rtTarExtractFileToFile(hFile, pszTargetFile, cbOverallSize, cbOverallWritten, pfnProgressCallback, pvUser);
1496	else
1497	rc = VERR_NO_STR_MEMORY;
1498	RTStrFree(pszTargetFile);
1499	RTTarFileClose(hFile);
1500	if (RT_FAILURE(rc))
1501	break;
1502	}
1503	} while (0);
1504
1505	RTTarClose(hTar);
1506
1507	return rc;
1508	}
1509
1510	RTR3DECL(int) RTTarExtractAll(const char pszTarFile, const char pszOutputDir, PFNRTPROGRESS pfnProgressCallback, void *pvUser)
1511	{
1512	/* Validate input */
1513	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1514	AssertPtrReturn(pszOutputDir, VERR_INVALID_POINTER);
1515	AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
1516	AssertPtrNullReturn(pvUser, VERR_INVALID_POINTER);
1517
1518	char **papszFiles;
1519	size_t cFiles;
1520
1521	/* First fetch the files names contained in the tar file */
1522	int rc = RTTarList(pszTarFile, &papszFiles, &cFiles);
1523	if (RT_FAILURE(rc))
1524	return rc;
1525
1526	/* Extract all files */
1527	return RTTarExtractFiles(pszTarFile, pszOutputDir, papszFiles, cFiles, pfnProgressCallback, pvUser);
1528	}
1529
1530	RTR3DECL(int) RTTarCreate(const char pszTarFile, const char const papszFiles, size_t cFiles, PFNRTPROGRESS pfnProgressCallback, void pvUser)
1531	{
1532	/* Validate input */
1533	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1534	AssertPtrReturn(papszFiles, VERR_INVALID_POINTER);
1535	AssertReturn(cFiles, VERR_INVALID_PARAMETER);
1536	AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
1537	AssertPtrNullReturn(pvUser, VERR_INVALID_POINTER);
1538
1539	RTTAR hTar;
1540	int rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_CREATE \| RTFILE_O_READWRITE \| RTFILE_O_DENY_NONE, false /fStream/);
1541	if (RT_FAILURE(rc))
1542	return rc;
1543
1544	/* Get the overall size of all files to pack into the tar archive. Only
1545	necessary if there is a progress callback. */
1546	uint64_t cbOverallSize = 0;
1547	if (pfnProgressCallback)
1548	for (size_t i = 0; i < cFiles; ++i)
1549	{
1550	uint64_t cbSize;
1551	rc = RTFileQuerySize(papszFiles[i], &cbSize);
1552	if (RT_FAILURE(rc))
1553	break;
1554	cbOverallSize += cbSize;
1555	}
1556	uint64_t cbOverallWritten = 0;
1557	for (size_t i = 0; i < cFiles; ++i)
1558	{
1559	rc = rtTarAppendFileFromFile(hTar, papszFiles[i], cbOverallSize, cbOverallWritten, pfnProgressCallback, pvUser);
1560	if (RT_FAILURE(rc))
1561	break;
1562	}
1563
1564	/* Cleanup */
1565	RTTarClose(hTar);
1566
1567	return rc;
1568	}
1569
1570	/******************************************************************************
1571	* Streaming Functions *
1572	******************************************************************************/
1573
1574	RTR3DECL(int) RTTarCurrentFile(RTTAR hTar, char **ppszFilename)
1575	{
1576	/* Validate input. */
1577	AssertPtrNullReturn(ppszFilename, VERR_INVALID_POINTER);
1578
1579	PRTTARINTERNAL pInt = hTar;
1580	RTTAR_VALID_RETURN(pInt);
1581
1582	/* Open and close the file on the current position. This makes sure the
1583	* cache is filled in case we never read something before. On success it
1584	* will return the current filename. */
1585	RTTARFILE hFile;
1586	int rc = RTTarFileOpenCurrentFile(hTar, &hFile, ppszFilename, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE);
1587	if (RT_SUCCESS(rc))
1588	RTTarFileClose(hFile);
1589
1590	return rc;
1591	}
1592
1593	RTR3DECL(int) RTTarSeekNextFile(RTTAR hTar)
1594	{
1595	PRTTARINTERNAL pInt = hTar;
1596	RTTAR_VALID_RETURN(pInt);
1597
1598	int rc = VINF_SUCCESS;
1599
1600	if (!pInt->fStreamMode)
1601	return VERR_INVALID_STATE;
1602
1603	/* If there is nothing in the cache, it means we never read something. Just
1604	* ask for the current filename to fill the cache. */
1605	if (!pInt->pFileCache)
1606	{
1607	rc = RTTarCurrentFile(hTar, NULL);
1608	if (RT_FAILURE(rc))
1609	return rc;
1610	}
1611
1612	/* Check that the file pointer is somewhere within the last open file.
1613	* If not we are somehow busted. */
1614	uint64_t offCur = RTFileTell(pInt->hTarFile);
1615	if (!( pInt->pFileCache->offStart <= offCur
1616	&& offCur < pInt->pFileCache->offStart + sizeof(RTTARRECORD) + pInt->pFileCache->cbSize))
1617	return VERR_INVALID_STATE;
1618
1619	/* Seek to the next file header. */
1620	uint64_t offNext = RT_ALIGN(pInt->pFileCache->offStart + sizeof(RTTARRECORD) + pInt->pFileCache->cbSize, sizeof(RTTARRECORD));
1621	rc = RTFileSeek(pInt->hTarFile, offNext - offCur, RTFILE_SEEK_CURRENT, NULL);
1622	if (RT_FAILURE(rc))
1623	return rc;
1624
1625	/* Again check the current filename to fill the cache with the new value. */
1626	return RTTarCurrentFile(hTar, NULL);
1627	}
1628
1629	RTR3DECL(int) RTTarFileOpenCurrentFile(RTTAR hTar, PRTTARFILE phFile, char **ppszFilename, uint32_t fOpen)
1630	{
1631	/* Validate input. */
1632	AssertPtrReturn(phFile, VERR_INVALID_POINTER);
1633	AssertPtrNullReturn(ppszFilename, VERR_INVALID_POINTER);
1634	AssertReturn((fOpen & RTFILE_O_READ), VERR_INVALID_PARAMETER); /* Only valid in read mode. */
1635
1636	PRTTARINTERNAL pInt = hTar;
1637	RTTAR_VALID_RETURN(pInt);
1638
1639	if (!pInt->fStreamMode)
1640	return VERR_INVALID_STATE;
1641
1642	int rc = VINF_SUCCESS;
1643
1644	/* Is there some cached entry? */
1645	if (pInt->pFileCache)
1646	{
1647	/* Are we still direct behind that header? */
1648	if (pInt->pFileCache->offStart + sizeof(RTTARRECORD) == RTFileTell(pInt->hTarFile))
1649	{
1650	/* Yes, so the streaming can start. Just return the cached file
1651	* structure to the caller. */
1652	*phFile = rtCopyTarFileInternal(pInt->pFileCache);
1653	if (ppszFilename)
1654	*ppszFilename = RTStrDup(pInt->pFileCache->pszFilename);
1655	return VINF_SUCCESS;
1656	}
1657
1658	/* Else delete the last open file cache. Might be recreated below. */
1659	rtDeleteTarFileInternal(pInt->pFileCache);
1660	pInt->pFileCache = NULL;
1661	}
1662
1663	PRTTARFILEINTERNAL pFileInt = NULL;
1664	do /* break loop */
1665	{
1666	/* Try to read a header entry from the current position. If we aren't
1667	* on a header record, the header checksum will show and an error will
1668	* be returned. */
1669	RTTARRECORD record;
1670	/* Read & verify a header record */
1671	rc = rtTarReadHeaderRecord(pInt->hTarFile, &record);
1672	/* Check for error or EOF. */
1673	if (RT_FAILURE(rc))
1674	break;
1675
1676	/* We support normal files only */
1677	if ( record.h.linkflag == LF_OLDNORMAL
1678	\|\| record.h.linkflag == LF_NORMAL)
1679	{
1680	pFileInt = rtCreateTarFileInternal(pInt, record.h.name, fOpen);
1681	if (!pFileInt)
1682	{
1683	rc = VERR_NO_MEMORY;
1684	break;
1685	}
1686
1687	/* Get the file size */
1688	pFileInt->cbSize = rtTarRecToSize(&record);
1689	/* The start is -512 from here. */
1690	pFileInt->offStart = RTFileTell(pInt->hTarFile) - sizeof(RTTARRECORD);
1691
1692	/* Copy the new file structure to our cache. */
1693	pInt->pFileCache = rtCopyTarFileInternal(pFileInt);
1694	if (ppszFilename)
1695	*ppszFilename = RTStrDup(pFileInt->pszFilename);
1696	}
1697	} while (0);
1698
1699	if (RT_FAILURE(rc))
1700	{
1701	if (pFileInt)
1702	rtDeleteTarFileInternal(pFileInt);
1703	}
1704	else
1705	*phFile = pFileInt;
1706
1707	return rc;
1708	}
1709

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Runtime/common/zip/tar.cpp@ 35708

Download in other formats: