tar.cpp@ 39032

Last change on this file since 39032 was 39032, checked in by vboxsync, 13 years ago
IPRT: Fixed unused variable warnings.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 53.9 KB

Line
1	/* $Id: tar.cpp 39032 2011-10-19 11:08:50Z 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	for (;;)
602	{
603	if (pfnProgressCallback)
604	pfnProgressCallback((unsigned)(100.0 / cbOverallSize * cbOverallWritten), pvUser);
605	if (cbAllWritten >= cbToCopy)
606	break;
607
608	/* Read one block. Either its the buffer size or the rest of the
609	* file. */
610	cbRead = RT_MIN(cbToCopy - cbAllWritten, cbTmp);
611	rc = RTFileRead(hOldFile, pvTmp, cbRead, NULL);
612	if (RT_FAILURE(rc))
613	break;
614
615	/* Write one block. */
616	rc = RTTarFileWriteAt(hFile, cbAllWritten, pvTmp, cbRead, NULL);
617	if (RT_FAILURE(rc))
618	break;
619
620	/* Count how many bytes (of the original file) are written already */
621	cbAllWritten += cbRead;
622	cbOverallWritten += cbRead;
623	}
624	} while (0);
625
626	/* Cleanup */
627	if (pvTmp)
628	RTMemTmpFree(pvTmp);
629
630	if (hFile)
631	RTTarFileClose(hFile);
632
633	RTFileClose(hOldFile);
634
635	return rc;
636	}
637
638	static int rtTarSkipData(RTFILE hFile, PRTTARRECORD pRecord)
639	{
640	int rc = VINF_SUCCESS;
641	/* Seek over the data parts (512 bytes aligned) */
642	int64_t offSeek = RT_ALIGN(rtTarRecToSize(pRecord), sizeof(RTTARRECORD));
643	if (offSeek > 0)
644	rc = RTFileSeek(hFile, offSeek, RTFILE_SEEK_CURRENT, NULL);
645	return rc;
646	}
647
648	static int rtTarFindFile(RTFILE hFile, const char pszFile, uint64_t poff, uint64_t *pcbSize)
649	{
650	/* Assume we are on the file head. */
651	int rc = VINF_SUCCESS;
652	bool fFound = false;
653	RTTARRECORD record;
654	for (;;)
655	{
656	/* Read & verify a header record */
657	rc = rtTarReadHeaderRecord(hFile, &record);
658	/* Check for error or EOF. */
659	if (RT_FAILURE(rc))
660	break;
661
662	/* We support normal files only */
663	if ( record.h.linkflag == LF_OLDNORMAL
664	\|\| record.h.linkflag == LF_NORMAL)
665	{
666	if (!RTStrCmp(record.h.name, pszFile))
667	{
668	/* Get the file size */
669	*pcbSize = rtTarRecToSize(&record);
670	/* Seek back, to position the file pointer at the start of the header. */
671	rc = RTFileSeek(hFile, -(int64_t)sizeof(RTTARRECORD), RTFILE_SEEK_CURRENT, poff);
672	fFound = true;
673	break;
674	}
675	}
676	rc = rtTarSkipData(hFile, &record);
677	if (RT_FAILURE(rc))
678	break;
679	}
680
681	if (rc == VERR_TAR_END_OF_FILE)
682	rc = VINF_SUCCESS;
683
684	/* Something found? */
685	if ( RT_SUCCESS(rc)
686	&& !fFound)
687	rc = VERR_FILE_NOT_FOUND;
688
689	return rc;
690	}
691
692	static int rtTarGetFilesOverallSize(RTFILE hFile, const char * const papszFiles, size_t cFiles, uint64_t pcbOverallSize)
693	{
694	int rc = VINF_SUCCESS;
695	size_t cFound = 0;
696	RTTARRECORD record;
697	for (;;)
698	{
699	/* Read & verify a header record */
700	rc = rtTarReadHeaderRecord(hFile, &record);
701	/* Check for error or EOF. */
702	if (RT_FAILURE(rc))
703	break;
704
705	/* We support normal files only */
706	if ( record.h.linkflag == LF_OLDNORMAL
707	\|\| record.h.linkflag == LF_NORMAL)
708	{
709	for (size_t i = 0; i < cFiles; ++i)
710	{
711	if (!RTStrCmp(record.h.name, papszFiles[i]))
712	{
713	/* Sum up the overall size */
714	*pcbOverallSize += rtTarRecToSize(&record);
715	++cFound;
716	break;
717	}
718	}
719	if ( cFound == cFiles
720	\|\| RT_FAILURE(rc))
721	break;
722	}
723	rc = rtTarSkipData(hFile, &record);
724	if (RT_FAILURE(rc))
725	break;
726	}
727	if (rc == VERR_TAR_END_OF_FILE)
728	rc = VINF_SUCCESS;
729
730	/* Make sure the file pointer is at the begin of the file again. */
731	if (RT_SUCCESS(rc))
732	rc = RTFileSeek(hFile, 0, RTFILE_SEEK_BEGIN, 0);
733	return rc;
734	}
735
736	/******************************************************************************
737	* Public Functions *
738	******************************************************************************/
739
740	RTR3DECL(int) RTTarOpen(PRTTAR phTar, const char *pszTarname, uint32_t fMode, bool fStream)
741	{
742	/*
743	* Create a tar instance.
744	*/
745	PRTTARINTERNAL pThis = (PRTTARINTERNAL)RTMemAllocZ(sizeof(RTTARINTERNAL));
746	if (!pThis)
747	return VERR_NO_MEMORY;
748
749	pThis->u32Magic = RTTAR_MAGIC;
750	pThis->fOpenMode = fMode;
751	pThis->fStreamMode = fStream && (fMode & RTFILE_O_READ);
752
753	/*
754	* Open the tar file.
755	*/
756	int rc = RTFileOpen(&pThis->hTarFile, pszTarname, fMode);
757	if (RT_SUCCESS(rc))
758	{
759	*phTar = pThis;
760	return VINF_SUCCESS;
761	}
762
763	RTMemFree(pThis);
764	return rc;
765	}
766
767	RTR3DECL(int) RTTarClose(RTTAR hTar)
768	{
769	if (hTar == NIL_RTTAR)
770	return VINF_SUCCESS;
771
772	PRTTARINTERNAL pInt = hTar;
773	RTTAR_VALID_RETURN(pInt);
774
775	int rc = VINF_SUCCESS;
776
777	/* gtar gives a warning, but the documentation says EOF is indicated by a
778	* zero block. Disabled for now. */
779	#if 0
780	{
781	/* Append the EOF record which is filled all by zeros */
782	RTTARRECORD record;
783	RT_ZERO(record);
784	rc = RTFileWrite(pInt->hTarFile, &record, sizeof(record), NULL);
785	}
786	#endif
787
788	if (pInt->hTarFile != NIL_RTFILE)
789	rc = RTFileClose(pInt->hTarFile);
790
791	/* Delete any remaining cached file headers. */
792	if (pInt->pFileCache)
793	{
794	rtDeleteTarFileInternal(pInt->pFileCache);
795	pInt->pFileCache = NULL;
796	}
797
798	pInt->u32Magic = RTTAR_MAGIC_DEAD;
799
800	RTMemFree(pInt);
801
802	return rc;
803	}
804
805	RTR3DECL(int) RTTarFileOpen(RTTAR hTar, PRTTARFILE phFile, const char *pszFilename, uint32_t fOpen)
806	{
807	AssertReturn((fOpen & RTFILE_O_READ) \|\| (fOpen & RTFILE_O_WRITE), VERR_INVALID_PARAMETER);
808
809	PRTTARINTERNAL pInt = hTar;
810	RTTAR_VALID_RETURN(pInt);
811
812	if (!pInt->hTarFile)
813	return VERR_INVALID_HANDLE;
814
815	if (pInt->fStreamMode)
816	return VERR_INVALID_STATE;
817
818	if (fOpen & RTFILE_O_WRITE)
819	{
820	if (!(pInt->fOpenMode & RTFILE_O_WRITE))
821	return VERR_WRITE_PROTECT;
822	if (pInt->fFileOpenForWrite)
823	return VERR_TOO_MANY_OPEN_FILES;
824	}
825
826	PRTTARFILEINTERNAL pFileInt = rtCreateTarFileInternal(pInt, pszFilename, fOpen);
827	if (!pFileInt)
828	return VERR_NO_MEMORY;
829
830	int rc = VINF_SUCCESS;
831	do /* break loop */
832	{
833	if (pFileInt->fOpenMode & RTFILE_O_WRITE)
834	{
835	pInt->fFileOpenForWrite = true;
836
837	/* If we are in write mode, we also in append mode. Add an dummy
838	* header at the end of the current file. It will be filled by the
839	* close operation. */
840	rc = RTFileSeek(pFileInt->pTar->hTarFile, 0, RTFILE_SEEK_END, &pFileInt->offStart);
841	if (RT_FAILURE(rc))
842	break;
843	RTTARRECORD record;
844	RT_ZERO(record);
845	rc = RTFileWrite(pFileInt->pTar->hTarFile, &record, sizeof(RTTARRECORD), NULL);
846	if (RT_FAILURE(rc))
847	break;
848	}
849	else if (pFileInt->fOpenMode & RTFILE_O_READ)
850	{
851	/* We need to be on the start of the file */
852	rc = RTFileSeek(pFileInt->pTar->hTarFile, 0, RTFILE_SEEK_BEGIN, NULL);
853	if (RT_FAILURE(rc))
854	break;
855
856	/* Search for the file. */
857	rc = rtTarFindFile(pFileInt->pTar->hTarFile, pszFilename, &pFileInt->offStart, &pFileInt->cbSize);
858	if (RT_FAILURE(rc))
859	break;
860	}
861	else
862	{
863	/** @todo is something missing here? */
864	}
865
866	} while (0);
867
868	/* Cleanup on failure */
869	if (RT_FAILURE(rc))
870	{
871	if (pFileInt->pszFilename)
872	RTStrFree(pFileInt->pszFilename);
873	RTMemFree(pFileInt);
874	}
875	else
876	*phFile = (RTTARFILE)pFileInt;
877
878	return rc;
879	}
880
881	RTR3DECL(int) RTTarFileClose(RTTARFILE hFile)
882	{
883	/* Already closed? */
884	if (hFile == NIL_RTTARFILE)
885	return VINF_SUCCESS;
886
887	PRTTARFILEINTERNAL pFileInt = hFile;
888	RTTARFILE_VALID_RETURN(pFileInt);
889
890	int rc = VINF_SUCCESS;
891
892	/* In write mode: */
893	if (pFileInt->fOpenMode & RTFILE_O_READ)
894	{
895	/* In read mode, we want to make sure to stay at the aligned end of this
896	* file, so the next file could be read immediately. */
897	uint64_t offCur = RTFileTell(pFileInt->pTar->hTarFile);
898
899	/* Check that the file pointer is somewhere within the last open file.
900	* If we are at the beginning (nothing read yet) nothing will be done.
901	* A user could open/close a file more than once, without reading
902	* something. */
903	if ( pFileInt->offStart + sizeof(RTTARRECORD) < offCur
904	&& offCur < RT_ALIGN(pFileInt->offStart + sizeof(RTTARRECORD) + pFileInt->cbSize, sizeof(RTTARRECORD)))
905	{
906	/* Seek to the next file header. */
907	uint64_t offNext = RT_ALIGN(pFileInt->offStart + sizeof(RTTARRECORD) + pFileInt->cbSize, sizeof(RTTARRECORD));
908	rc = RTFileSeek(pFileInt->pTar->hTarFile, offNext - offCur, RTFILE_SEEK_CURRENT, NULL);
909	}
910	}
911	else if (pFileInt->fOpenMode & RTFILE_O_WRITE)
912	{
913	pFileInt->pTar->fFileOpenForWrite = false;
914	do
915	{
916	/* If the user has called RTTarFileSetSize in the meantime, we have
917	to make sure the file has the right size. */
918	if (pFileInt->cbSetSize > pFileInt->cbSize)
919	{
920	rc = rtTarAppendZeros(hFile, pFileInt->cbSetSize - pFileInt->cbSize);
921	if (RT_FAILURE(rc))
922	break;
923	}
924
925	/* If the written size isn't 512 byte aligned, we need to fix this. */
926	RTTARRECORD record;
927	RT_ZERO(record);
928	uint64_t cbSizeAligned = RT_ALIGN(pFileInt->cbSize, sizeof(RTTARRECORD));
929	if (cbSizeAligned != pFileInt->cbSize)
930	{
931	/* Note the RTFile method. We didn't increase the cbSize or cbCurrentPos here. */
932	rc = RTFileWriteAt(pFileInt->pTar->hTarFile,
933	pFileInt->offStart + sizeof(RTTARRECORD) + pFileInt->cbSize,
934	&record,
935	cbSizeAligned - pFileInt->cbSize,
936	NULL);
937	if (RT_FAILURE(rc))
938	break;
939	}
940
941	/* Create a header record for the file */
942	/* Todo: mode, gid, uid, mtime should be setable (or detected myself) */
943	RTTIMESPEC time;
944	RTTimeNow(&time);
945	rc = rtTarCreateHeaderRecord(&record, pFileInt->pszFilename, pFileInt->cbSize,
946	0, 0, 0600, RTTimeSpecGetSeconds(&time));
947	if (RT_FAILURE(rc))
948	break;
949
950	/* Write this at the start of the file data */
951	rc = RTFileWriteAt(pFileInt->pTar->hTarFile, pFileInt->offStart, &record, sizeof(RTTARRECORD), NULL);
952	if (RT_FAILURE(rc))
953	break;
954	}
955	while(0);
956	}
957
958	/* Now cleanup and delete the handle */
959	rtDeleteTarFileInternal(pFileInt);
960
961	return rc;
962	}
963
964	RTR3DECL(int) RTTarFileSeek(RTTARFILE hFile, uint64_t offSeek, unsigned uMethod, uint64_t *poffActual)
965	{
966	PRTTARFILEINTERNAL pFileInt = hFile;
967	RTTARFILE_VALID_RETURN(pFileInt);
968
969	if (pFileInt->pTar->fStreamMode)
970	return VERR_INVALID_STATE;
971
972	switch (uMethod)
973	{
974	case RTFILE_SEEK_BEGIN:
975	{
976	if (offSeek > pFileInt->cbSize)
977	return VERR_SEEK_ON_DEVICE;
978	pFileInt->offCurrent = offSeek;
979	break;
980	}
981	case RTFILE_SEEK_CURRENT:
982	{
983	if (pFileInt->offCurrent + offSeek > pFileInt->cbSize)
984	return VERR_SEEK_ON_DEVICE;
985	pFileInt->offCurrent += offSeek;
986	break;
987	}
988	case RTFILE_SEEK_END:
989	{
990	if ((int64_t)pFileInt->cbSize - (int64_t)offSeek < 0)
991	return VERR_NEGATIVE_SEEK;
992	pFileInt->offCurrent = pFileInt->cbSize - offSeek;
993	break;
994	}
995	default: AssertFailedReturn(VERR_INVALID_PARAMETER); break;
996	}
997
998	return VINF_SUCCESS;
999	}
1000
1001	RTR3DECL(uint64_t) RTTarFileTell(RTTARFILE hFile)
1002	{
1003	PRTTARFILEINTERNAL pFileInt = hFile;
1004	RTTARFILE_VALID_RETURN_RC(pFileInt, UINT64_MAX);
1005
1006	return pFileInt->offCurrent;
1007	}
1008
1009	RTR3DECL(int) RTTarFileRead(RTTARFILE hFile, void pvBuf, size_t cbToRead, size_t pcbRead)
1010	{
1011	PRTTARFILEINTERNAL pFileInt = hFile;
1012	RTTARFILE_VALID_RETURN(pFileInt);
1013
1014	/* Todo: optimize this, by checking the current pos */
1015	return RTTarFileReadAt(hFile, pFileInt->offCurrent, pvBuf, cbToRead, pcbRead);
1016	}
1017
1018	RTR3DECL(int) RTTarFileReadAt(RTTARFILE hFile, uint64_t off, void pvBuf, size_t cbToRead, size_t pcbRead)
1019	{
1020	PRTTARFILEINTERNAL pFileInt = hFile;
1021	RTTARFILE_VALID_RETURN(pFileInt);
1022
1023	/* Check that we not read behind the end of file. If so return immediately. */
1024	if (off > pFileInt->cbSize)
1025	{
1026	if (pcbRead)
1027	*pcbRead = 0;
1028	return VINF_SUCCESS; /* ??? VERR_EOF */
1029	}
1030
1031	size_t cbToCopy = RT_MIN(pFileInt->cbSize - off, cbToRead);
1032	size_t cbTmpRead = 0;
1033	int rc = RTFileReadAt(pFileInt->pTar->hTarFile, pFileInt->offStart + 512 + off, pvBuf, cbToCopy, &cbTmpRead);
1034	pFileInt->offCurrent = off + cbTmpRead;
1035	if (pcbRead)
1036	*pcbRead = cbTmpRead;
1037
1038	return rc;
1039	}
1040
1041	RTR3DECL(int) RTTarFileWrite(RTTARFILE hFile, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
1042	{
1043	PRTTARFILEINTERNAL pFileInt = hFile;
1044	RTTARFILE_VALID_RETURN(pFileInt);
1045
1046	/** @todo Optimize this, by checking the current pos */
1047	return RTTarFileWriteAt(hFile, pFileInt->offCurrent, pvBuf, cbToWrite, pcbWritten);
1048	}
1049
1050	RTR3DECL(int) RTTarFileWriteAt(RTTARFILE hFile, uint64_t off, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
1051	{
1052	PRTTARFILEINTERNAL pFileInt = hFile;
1053	RTTARFILE_VALID_RETURN(pFileInt);
1054
1055	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1056	return VERR_WRITE_ERROR;
1057
1058	size_t cbTmpWritten = 0;
1059	int rc = RTFileWriteAt(pFileInt->pTar->hTarFile, pFileInt->offStart + 512 + off, pvBuf, cbToWrite, &cbTmpWritten);
1060	pFileInt->cbSize += cbTmpWritten;
1061	pFileInt->offCurrent = off + cbTmpWritten;
1062	if (pcbWritten)
1063	*pcbWritten = cbTmpWritten;
1064
1065	return rc;
1066	}
1067
1068	RTR3DECL(int) RTTarFileGetSize(RTTARFILE hFile, uint64_t *pcbSize)
1069	{
1070	/* Validate input */
1071	AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
1072
1073	PRTTARFILEINTERNAL pFileInt = hFile;
1074	RTTARFILE_VALID_RETURN(pFileInt);
1075
1076	*pcbSize = RT_MAX(pFileInt->cbSetSize, pFileInt->cbSize);
1077
1078	return VINF_SUCCESS;
1079	}
1080
1081	RTR3DECL(int) RTTarFileSetSize(RTTARFILE hFile, uint64_t cbSize)
1082	{
1083	PRTTARFILEINTERNAL pFileInt = hFile;
1084	RTTARFILE_VALID_RETURN(pFileInt);
1085
1086	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1087	return VERR_WRITE_ERROR;
1088
1089	/** @todo If cbSize is smaller than pFileInt->cbSize we have to
1090	* truncate the current file. */
1091	pFileInt->cbSetSize = cbSize;
1092
1093	return VINF_SUCCESS;
1094	}
1095
1096	RTR3DECL(int) RTTarFileGetMode(RTTARFILE hFile, uint32_t *pfMode)
1097	{
1098	/* Validate input */
1099	AssertPtrReturn(pfMode, VERR_INVALID_POINTER);
1100
1101	PRTTARFILEINTERNAL pFileInt = hFile;
1102	RTTARFILE_VALID_RETURN(pFileInt);
1103
1104	/* Read the mode out of the header entry */
1105	char szMode[RT_SIZEOFMEMB(RTTARRECORD, h.mode)+1];
1106	int rc = RTFileReadAt(pFileInt->pTar->hTarFile,
1107	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.mode),
1108	szMode,
1109	RT_SIZEOFMEMB(RTTARRECORD, h.mode),
1110	NULL);
1111	if (RT_FAILURE(rc))
1112	return rc;
1113	szMode[sizeof(szMode) - 1] = '\0';
1114
1115	/* Convert it to an integer */
1116	return RTStrToUInt32Full(szMode, 8, pfMode);
1117	}
1118
1119	RTR3DECL(int) RTTarFileSetMode(RTTARFILE hFile, uint32_t fMode)
1120	{
1121	PRTTARFILEINTERNAL pFileInt = hFile;
1122	RTTARFILE_VALID_RETURN(pFileInt);
1123
1124	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1125	return VERR_WRITE_ERROR;
1126
1127	/* Convert the mode to an string. */
1128	char szMode[RT_SIZEOFMEMB(RTTARRECORD, h.mode)];
1129	RTStrPrintf(szMode, sizeof(szMode), "%0.7o", fMode);
1130
1131	/* Write it directly into the header */
1132	return RTFileWriteAt(pFileInt->pTar->hTarFile,
1133	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.mode),
1134	szMode,
1135	RT_SIZEOFMEMB(RTTARRECORD, h.mode),
1136	NULL);
1137	}
1138
1139	RTR3DECL(int) RTTarFileGetTime(RTTARFILE hFile, PRTTIMESPEC pTime)
1140	{
1141	PRTTARFILEINTERNAL pFileInt = hFile;
1142	RTTARFILE_VALID_RETURN(pFileInt);
1143
1144	/* Read the time out of the header entry */
1145	char szModTime[RT_SIZEOFMEMB(RTTARRECORD, h.mtime) + 1];
1146	int rc = RTFileReadAt(pFileInt->pTar->hTarFile,
1147	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.mtime),
1148	szModTime,
1149	RT_SIZEOFMEMB(RTTARRECORD, h.mtime),
1150	NULL);
1151	if (RT_FAILURE(rc))
1152	return rc;
1153	szModTime[sizeof(szModTime) - 1] = '\0';
1154
1155	/* Convert it to an integer */
1156	int64_t cSeconds;
1157	rc = RTStrToInt64Full(szModTime, 12, &cSeconds);
1158
1159	/* And back to our time structure */
1160	if (RT_SUCCESS(rc))
1161	RTTimeSpecSetSeconds(pTime, cSeconds);
1162
1163	return rc;
1164	}
1165
1166	RTR3DECL(int) RTTarFileSetTime(RTTARFILE hFile, PRTTIMESPEC pTime)
1167	{
1168	PRTTARFILEINTERNAL pFileInt = hFile;
1169	RTTARFILE_VALID_RETURN(pFileInt);
1170
1171	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1172	return VERR_WRITE_ERROR;
1173
1174	/* Convert the time to an string. */
1175	char szModTime[RT_SIZEOFMEMB(RTTARRECORD, h.mtime)];
1176	RTStrPrintf(szModTime, sizeof(szModTime), "%0.11o", RTTimeSpecGetSeconds(pTime));
1177
1178	/* Write it directly into the header */
1179	return RTFileWriteAt(pFileInt->pTar->hTarFile,
1180	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.mtime),
1181	szModTime,
1182	RT_SIZEOFMEMB(RTTARRECORD, h.mtime),
1183	NULL);
1184	}
1185
1186	RTR3DECL(int) RTTarFileGetOwner(RTTARFILE hFile, uint32_t pUid, uint32_t pGid)
1187	{
1188	PRTTARFILEINTERNAL pFileInt = hFile;
1189	RTTARFILE_VALID_RETURN(pFileInt);
1190
1191	/* Read the uid and gid out of the header entry */
1192	AssertCompileAdjacentMembers(RTTARRECORD, h.uid, h.gid);
1193	char szUidGid[RT_SIZEOFMEMB(RTTARRECORD, h.uid) + RT_SIZEOFMEMB(RTTARRECORD, h.gid) + 1];
1194	int rc = RTFileReadAt(pFileInt->pTar->hTarFile,
1195	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.uid),
1196	szUidGid,
1197	sizeof(szUidGid) - 1,
1198	NULL);
1199	if (RT_FAILURE(rc))
1200	return rc;
1201	szUidGid[sizeof(szUidGid) - 1] = '\0';
1202
1203	/* Convert it to integer */
1204	rc = RTStrToUInt32Full(&szUidGid[RT_SIZEOFMEMB(RTTARRECORD, h.uid)], 8, pGid);
1205	if (RT_SUCCESS(rc))
1206	{
1207	szUidGid[RT_SIZEOFMEMB(RTTARRECORD, h.uid)] = '\0';
1208	rc = RTStrToUInt32Full(szUidGid, 8, pUid);
1209	}
1210	return rc;
1211	}
1212
1213	RTR3DECL(int) RTTarFileSetOwner(RTTARFILE hFile, uint32_t uid, uint32_t gid)
1214	{
1215	PRTTARFILEINTERNAL pFileInt = hFile;
1216	RTTARFILE_VALID_RETURN(pFileInt);
1217
1218	if ((pFileInt->fOpenMode & RTFILE_O_WRITE) != RTFILE_O_WRITE)
1219	return VERR_WRITE_ERROR;
1220	AssertReturn(uid == (uint32_t)-1 \|\| uid <= 07777777, VERR_OUT_OF_RANGE);
1221	AssertReturn(gid == (uint32_t)-1 \|\| gid <= 07777777, VERR_OUT_OF_RANGE);
1222
1223	int rc = VINF_SUCCESS;
1224
1225	if (uid != (uint32_t)-1)
1226	{
1227	/* Convert the uid to an string. */
1228	char szUid[RT_SIZEOFMEMB(RTTARRECORD, h.uid)];
1229	RTStrPrintf(szUid, sizeof(szUid), "%0.7o", uid);
1230
1231	/* Write it directly into the header */
1232	rc = RTFileWriteAt(pFileInt->pTar->hTarFile,
1233	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.uid),
1234	szUid,
1235	RT_SIZEOFMEMB(RTTARRECORD, h.uid),
1236	NULL);
1237	if (RT_FAILURE(rc))
1238	return rc;
1239	}
1240
1241	if (gid != (uint32_t)-1)
1242	{
1243	/* Convert the gid to an string. */
1244	char szGid[RT_SIZEOFMEMB(RTTARRECORD, h.gid)];
1245	RTStrPrintf(szGid, sizeof(szGid), "%0.7o", gid);
1246
1247	/* Write it directly into the header */
1248	rc = RTFileWriteAt(pFileInt->pTar->hTarFile,
1249	pFileInt->offStart + RT_OFFSETOF(RTTARRECORD, h.gid),
1250	szGid,
1251	RT_SIZEOFMEMB(RTTARRECORD, h.gid),
1252	NULL);
1253	if (RT_FAILURE(rc))
1254	return rc;
1255	}
1256
1257	return rc;
1258	}
1259
1260	/******************************************************************************
1261	* Convenience Functions *
1262	******************************************************************************/
1263
1264	RTR3DECL(int) RTTarFileExists(const char pszTarFile, const char pszFile)
1265	{
1266	/* Validate input */
1267	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1268	AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1269
1270	/* Open the tar file */
1271	RTTAR hTar;
1272	int rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE, false /fStream/);
1273	if (RT_FAILURE(rc))
1274	return rc;
1275
1276	/* Just try to open that file readonly. If this succeed the file exists. */
1277	RTTARFILE hFile;
1278	rc = RTTarFileOpen(hTar, &hFile, pszFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE);
1279	if (RT_SUCCESS(rc))
1280	RTTarFileClose(hFile);
1281
1282	RTTarClose(hTar);
1283
1284	return rc;
1285	}
1286
1287	RTR3DECL(int) RTTarList(const char pszTarFile, char *ppapszFiles, size_t pcFiles)
1288	{
1289	/* Validate input */
1290	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1291	AssertPtrReturn(ppapszFiles, VERR_INVALID_POINTER);
1292	AssertPtrReturn(pcFiles, VERR_INVALID_POINTER);
1293
1294	/* Open the tar file */
1295	RTTAR hTar;
1296	int rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE, false /fStream/);
1297	if (RT_FAILURE(rc))
1298	return rc;
1299
1300	/* This is done by internal methods, cause we didn't have a RTTARDIR
1301	* interface, yet. This should be fixed someday. */
1302
1303	PRTTARINTERNAL pInt = hTar;
1304	char **papszFiles = NULL;
1305	size_t cFiles = 0;
1306	do /* break loop */
1307	{
1308	/* Initialize the file name array with one slot */
1309	size_t cFilesAlloc = 1;
1310	papszFiles = (char *)RTMemAlloc(sizeof(char ));
1311	if (!papszFiles)
1312	{
1313	rc = VERR_NO_MEMORY;
1314	break;
1315	}
1316
1317	/* Iterate through the tar file record by record. Skip data records as we
1318	* didn't need them. */
1319	RTTARRECORD record;
1320	for (;;)
1321	{
1322	/* Read & verify a header record */
1323	rc = rtTarReadHeaderRecord(pInt->hTarFile, &record);
1324	/* Check for error or EOF. */
1325	if (RT_FAILURE(rc))
1326	break;
1327	/* We support normal files only */
1328	if ( record.h.linkflag == LF_OLDNORMAL
1329	\|\| record.h.linkflag == LF_NORMAL)
1330	{
1331	if (cFiles >= cFilesAlloc)
1332	{
1333	/* Double the array size, make sure the size doesn't wrap. */
1334	void *pvNew = NULL;
1335	size_t cbNew = cFilesAlloc * sizeof(char ) 2;
1336	if (cbNew / sizeof(char *) / 2 == cFilesAlloc)
1337	pvNew = RTMemRealloc(papszFiles, cbNew);
1338	if (!pvNew)
1339	{
1340	rc = VERR_NO_MEMORY;
1341	break;
1342	}
1343	papszFiles = (char **)pvNew;
1344	cFilesAlloc *= 2;
1345	}
1346
1347	/* Duplicate the name */
1348	papszFiles[cFiles] = RTStrDup(record.h.name);
1349	if (!papszFiles[cFiles])
1350	{
1351	rc = VERR_NO_MEMORY;
1352	break;
1353	}
1354	cFiles++;
1355	}
1356	rc = rtTarSkipData(pInt->hTarFile, &record);
1357	if (RT_FAILURE(rc))
1358	break;
1359	}
1360	} while(0);
1361
1362	if (rc == VERR_TAR_END_OF_FILE)
1363	rc = VINF_SUCCESS;
1364
1365	/* Return the file array on success, dispose of it on failure. */
1366	if (RT_SUCCESS(rc))
1367	{
1368	*pcFiles = cFiles;
1369	*ppapszFiles = papszFiles;
1370	}
1371	else
1372	{
1373	while (cFiles-- > 0)
1374	RTStrFree(papszFiles[cFiles]);
1375	RTMemFree(papszFiles);
1376	}
1377
1378	RTTarClose(hTar);
1379
1380	return rc;
1381	}
1382
1383	RTR3DECL(int) RTTarExtractFileToBuf(const char pszTarFile, void ppvBuf, size_t pcbSize, const char *pszFile,
1384	PFNRTPROGRESS pfnProgressCallback, void *pvUser)
1385	{
1386	/*
1387	* Validate input
1388	*/
1389	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1390	AssertPtrReturn(ppvBuf, VERR_INVALID_POINTER);
1391	AssertPtrReturn(pcbSize, VERR_INVALID_POINTER);
1392	AssertPtrReturn(pszFile, VERR_INVALID_POINTER);
1393	AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
1394	AssertPtrNullReturn(pvUser, VERR_INVALID_POINTER);
1395
1396	/** @todo progress bar - is this TODO still valid? */
1397
1398	int rc = VINF_SUCCESS;
1399	RTTAR hTar = NIL_RTTAR;
1400	RTTARFILE hFile = NIL_RTTARFILE;
1401	char *pvTmp = NULL;
1402	uint64_t cbToCopy= 0;
1403	do /* break loop */
1404	{
1405	rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE, false /fStream/);
1406	if (RT_FAILURE(rc))
1407	break;
1408	rc = RTTarFileOpen(hTar, &hFile, pszFile, RTFILE_O_OPEN \| RTFILE_O_READ);
1409	if (RT_FAILURE(rc))
1410	break;
1411	rc = RTTarFileGetSize(hFile, &cbToCopy);
1412	if (RT_FAILURE(rc))
1413	break;
1414
1415	/* Allocate the memory for the file content. */
1416	pvTmp = (char *)RTMemAlloc(cbToCopy);
1417	if (!pvTmp)
1418	{
1419	rc = VERR_NO_MEMORY;
1420	break;
1421	}
1422	size_t cbRead = 0;
1423	size_t cbAllRead = 0;
1424	for (;;)
1425	{
1426	if (pfnProgressCallback)
1427	pfnProgressCallback((unsigned)(100.0 / cbToCopy * cbAllRead), pvUser);
1428	if (cbAllRead == cbToCopy)
1429	break;
1430	rc = RTTarFileReadAt(hFile, 0, &pvTmp[cbAllRead], cbToCopy - cbAllRead, &cbRead);
1431	if (RT_FAILURE(rc))
1432	break;
1433	cbAllRead += cbRead;
1434	}
1435	} while (0);
1436
1437	/* Set output values on success */
1438	if (RT_SUCCESS(rc))
1439	{
1440	*pcbSize = cbToCopy;
1441	*ppvBuf = pvTmp;
1442	}
1443
1444	/* Cleanup */
1445	if ( RT_FAILURE(rc)
1446	&& pvTmp)
1447	RTMemFree(pvTmp);
1448	if (hFile)
1449	RTTarFileClose(hFile);
1450	if (hTar)
1451	RTTarClose(hTar);
1452
1453	return rc;
1454	}
1455
1456	RTR3DECL(int) RTTarExtractFiles(const char pszTarFile, const char pszOutputDir, const char * const *papszFiles,
1457	size_t cFiles, PFNRTPROGRESS pfnProgressCallback, void *pvUser)
1458	{
1459	/* Validate input */
1460	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1461	AssertPtrReturn(pszOutputDir, VERR_INVALID_POINTER);
1462	AssertPtrReturn(papszFiles, VERR_INVALID_POINTER);
1463	AssertReturn(cFiles, VERR_INVALID_PARAMETER);
1464	AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
1465	AssertPtrNullReturn(pvUser, VERR_INVALID_POINTER);
1466
1467	/* Open the tar file */
1468	RTTAR hTar;
1469	int rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE, false /fStream/);
1470	if (RT_FAILURE(rc))
1471	return rc;
1472
1473	do /* break loop */
1474	{
1475	/* Get the overall size of all files to extract out of the tar archive
1476	headers. Only necessary if there is a progress callback. */
1477	uint64_t cbOverallSize = 0;
1478	if (pfnProgressCallback)
1479	{
1480	// rc = rtTarGetFilesOverallSize(hFile, papszFiles, cFiles, &cbOverallSize);
1481	// if (RT_FAILURE(rc))
1482	// break;
1483	}
1484
1485	uint64_t cbOverallWritten = 0;
1486	for (size_t i = 0; i < cFiles; ++i)
1487	{
1488	RTTARFILE hFile;
1489	rc = RTTarFileOpen(hTar, &hFile, papszFiles[i], RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE);
1490	if (RT_FAILURE(rc))
1491	break;
1492	char *pszTargetFile = RTPathJoinA(pszOutputDir, papszFiles[i]);
1493	if (pszTargetFile)
1494	rc = rtTarExtractFileToFile(hFile, pszTargetFile, cbOverallSize, cbOverallWritten, pfnProgressCallback, pvUser);
1495	else
1496	rc = VERR_NO_STR_MEMORY;
1497	RTStrFree(pszTargetFile);
1498	RTTarFileClose(hFile);
1499	if (RT_FAILURE(rc))
1500	break;
1501	}
1502	} while (0);
1503
1504	RTTarClose(hTar);
1505
1506	return rc;
1507	}
1508
1509	RTR3DECL(int) RTTarExtractAll(const char pszTarFile, const char pszOutputDir, PFNRTPROGRESS pfnProgressCallback, void *pvUser)
1510	{
1511	/* Validate input */
1512	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1513	AssertPtrReturn(pszOutputDir, VERR_INVALID_POINTER);
1514	AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
1515	AssertPtrNullReturn(pvUser, VERR_INVALID_POINTER);
1516
1517	char **papszFiles;
1518	size_t cFiles;
1519
1520	/* First fetch the files names contained in the tar file */
1521	int rc = RTTarList(pszTarFile, &papszFiles, &cFiles);
1522	if (RT_FAILURE(rc))
1523	return rc;
1524
1525	/* Extract all files */
1526	return RTTarExtractFiles(pszTarFile, pszOutputDir, papszFiles, cFiles, pfnProgressCallback, pvUser);
1527	}
1528
1529	RTR3DECL(int) RTTarCreate(const char pszTarFile, const char const papszFiles, size_t cFiles, PFNRTPROGRESS pfnProgressCallback, void pvUser)
1530	{
1531	/* Validate input */
1532	AssertPtrReturn(pszTarFile, VERR_INVALID_POINTER);
1533	AssertPtrReturn(papszFiles, VERR_INVALID_POINTER);
1534	AssertReturn(cFiles, VERR_INVALID_PARAMETER);
1535	AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
1536	AssertPtrNullReturn(pvUser, VERR_INVALID_POINTER);
1537
1538	RTTAR hTar;
1539	int rc = RTTarOpen(&hTar, pszTarFile, RTFILE_O_CREATE \| RTFILE_O_READWRITE \| RTFILE_O_DENY_NONE, false /fStream/);
1540	if (RT_FAILURE(rc))
1541	return rc;
1542
1543	/* Get the overall size of all files to pack into the tar archive. Only
1544	necessary if there is a progress callback. */
1545	uint64_t cbOverallSize = 0;
1546	if (pfnProgressCallback)
1547	for (size_t i = 0; i < cFiles; ++i)
1548	{
1549	uint64_t cbSize;
1550	rc = RTFileQuerySize(papszFiles[i], &cbSize);
1551	if (RT_FAILURE(rc))
1552	break;
1553	cbOverallSize += cbSize;
1554	}
1555	uint64_t cbOverallWritten = 0;
1556	for (size_t i = 0; i < cFiles; ++i)
1557	{
1558	rc = rtTarAppendFileFromFile(hTar, papszFiles[i], cbOverallSize, cbOverallWritten, pfnProgressCallback, pvUser);
1559	if (RT_FAILURE(rc))
1560	break;
1561	}
1562
1563	/* Cleanup */
1564	RTTarClose(hTar);
1565
1566	return rc;
1567	}
1568
1569	/******************************************************************************
1570	* Streaming Functions *
1571	******************************************************************************/
1572
1573	RTR3DECL(int) RTTarCurrentFile(RTTAR hTar, char **ppszFilename)
1574	{
1575	/* Validate input. */
1576	AssertPtrNullReturn(ppszFilename, VERR_INVALID_POINTER);
1577
1578	PRTTARINTERNAL pInt = hTar;
1579	RTTAR_VALID_RETURN(pInt);
1580
1581	/* Open and close the file on the current position. This makes sure the
1582	* cache is filled in case we never read something before. On success it
1583	* will return the current filename. */
1584	RTTARFILE hFile;
1585	int rc = RTTarFileOpenCurrentFile(hTar, &hFile, ppszFilename, RTFILE_O_OPEN \| RTFILE_O_READ \| RTFILE_O_DENY_NONE);
1586	if (RT_SUCCESS(rc))
1587	RTTarFileClose(hFile);
1588
1589	return rc;
1590	}
1591
1592	RTR3DECL(int) RTTarSeekNextFile(RTTAR hTar)
1593	{
1594	PRTTARINTERNAL pInt = hTar;
1595	RTTAR_VALID_RETURN(pInt);
1596
1597	int rc = VINF_SUCCESS;
1598
1599	if (!pInt->fStreamMode)
1600	return VERR_INVALID_STATE;
1601
1602	/* If there is nothing in the cache, it means we never read something. Just
1603	* ask for the current filename to fill the cache. */
1604	if (!pInt->pFileCache)
1605	{
1606	rc = RTTarCurrentFile(hTar, NULL);
1607	if (RT_FAILURE(rc))
1608	return rc;
1609	}
1610
1611	/* Check that the file pointer is somewhere within the last open file.
1612	* If not we are somehow busted. */
1613	uint64_t offCur = RTFileTell(pInt->hTarFile);
1614	if (!( pInt->pFileCache->offStart <= offCur
1615	&& offCur < pInt->pFileCache->offStart + sizeof(RTTARRECORD) + pInt->pFileCache->cbSize))
1616	return VERR_INVALID_STATE;
1617
1618	/* Seek to the next file header. */
1619	uint64_t offNext = RT_ALIGN(pInt->pFileCache->offStart + sizeof(RTTARRECORD) + pInt->pFileCache->cbSize, sizeof(RTTARRECORD));
1620	rc = RTFileSeek(pInt->hTarFile, offNext - offCur, RTFILE_SEEK_CURRENT, NULL);
1621	if (RT_FAILURE(rc))
1622	return rc;
1623
1624	/* Again check the current filename to fill the cache with the new value. */
1625	return RTTarCurrentFile(hTar, NULL);
1626	}
1627
1628	RTR3DECL(int) RTTarFileOpenCurrentFile(RTTAR hTar, PRTTARFILE phFile, char **ppszFilename, uint32_t fOpen)
1629	{
1630	/* Validate input. */
1631	AssertPtrReturn(phFile, VERR_INVALID_POINTER);
1632	AssertPtrNullReturn(ppszFilename, VERR_INVALID_POINTER);
1633	AssertReturn((fOpen & RTFILE_O_READ), VERR_INVALID_PARAMETER); /* Only valid in read mode. */
1634
1635	PRTTARINTERNAL pInt = hTar;
1636	RTTAR_VALID_RETURN(pInt);
1637
1638	if (!pInt->fStreamMode)
1639	return VERR_INVALID_STATE;
1640
1641	int rc = VINF_SUCCESS;
1642
1643	/* Is there some cached entry? */
1644	if (pInt->pFileCache)
1645	{
1646	/* Are we still direct behind that header? */
1647	if (pInt->pFileCache->offStart + sizeof(RTTARRECORD) == RTFileTell(pInt->hTarFile))
1648	{
1649	/* Yes, so the streaming can start. Just return the cached file
1650	* structure to the caller. */
1651	*phFile = rtCopyTarFileInternal(pInt->pFileCache);
1652	if (ppszFilename)
1653	*ppszFilename = RTStrDup(pInt->pFileCache->pszFilename);
1654	return VINF_SUCCESS;
1655	}
1656
1657	/* Else delete the last open file cache. Might be recreated below. */
1658	rtDeleteTarFileInternal(pInt->pFileCache);
1659	pInt->pFileCache = NULL;
1660	}
1661
1662	PRTTARFILEINTERNAL pFileInt = NULL;
1663	do /* break loop */
1664	{
1665	/* Try to read a header entry from the current position. If we aren't
1666	* on a header record, the header checksum will show and an error will
1667	* be returned. */
1668	RTTARRECORD record;
1669	/* Read & verify a header record */
1670	rc = rtTarReadHeaderRecord(pInt->hTarFile, &record);
1671	/* Check for error or EOF. */
1672	if (RT_FAILURE(rc))
1673	break;
1674
1675	/* We support normal files only */
1676	if ( record.h.linkflag == LF_OLDNORMAL
1677	\|\| record.h.linkflag == LF_NORMAL)
1678	{
1679	pFileInt = rtCreateTarFileInternal(pInt, record.h.name, fOpen);
1680	if (!pFileInt)
1681	{
1682	rc = VERR_NO_MEMORY;
1683	break;
1684	}
1685
1686	/* Get the file size */
1687	pFileInt->cbSize = rtTarRecToSize(&record);
1688	/* The start is -512 from here. */
1689	pFileInt->offStart = RTFileTell(pInt->hTarFile) - sizeof(RTTARRECORD);
1690
1691	/* Copy the new file structure to our cache. */
1692	pInt->pFileCache = rtCopyTarFileInternal(pFileInt);
1693	if (ppszFilename)
1694	*ppszFilename = RTStrDup(pFileInt->pszFilename);
1695	}
1696	} while (0);
1697
1698	if (RT_FAILURE(rc))
1699	{
1700	if (pFileInt)
1701	rtDeleteTarFileInternal(pFileInt);
1702	}
1703	else
1704	*phFile = pFileInt;
1705
1706	return rc;
1707	}
1708

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

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

Download in other formats: