1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Streams for Tar files
4 // Author: Mike Wetherell
6 // Copyright: (c) 2004 Mike Wetherell
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 // For compilers that support precompilation, includes "wx.h".
11 #include "wx/wxprec.h"
19 #include "wx/tarstrm.h"
27 #include "wx/buffer.h"
28 #include "wx/datetime.h"
29 #include "wx/ptr_scpd.h"
30 #include "wx/filename.h"
39 /////////////////////////////////////////////////////////////////////////////
76 TYPE_OLDTAR
, // fields after TAR_LINKNAME are invalid
77 TYPE_GNUTAR
, // all fields except TAR_PREFIX are valid
78 TYPE_USTAR
// all fields are valid
82 static const char *USTAR_MAGIC
= "ustar";
83 static const char *USTAR_VERSION
= "00";
84 static const char *GNU_MAGIC
= "ustar ";
85 static const char *GNU_VERION
= " ";
87 IMPLEMENT_DYNAMIC_CLASS(wxTarEntry
, wxArchiveEntry
)
88 IMPLEMENT_DYNAMIC_CLASS(wxTarClassFactory
, wxArchiveClassFactory
)
91 /////////////////////////////////////////////////////////////////////////////
94 static wxTarClassFactory g_wxTarClassFactory
;
96 wxTarClassFactory::wxTarClassFactory()
98 if (this == &g_wxTarClassFactory
)
102 const wxChar
* const *
103 wxTarClassFactory::GetProtocols(wxStreamProtocolType type
) const
105 static const wxChar
*protocols
[] = { _T("tar"), NULL
};
106 static const wxChar
*mimetypes
[] = { _T("application/x-tar"), NULL
};
107 static const wxChar
*fileexts
[] = { _T(".tar"), NULL
};
108 static const wxChar
*empty
[] = { NULL
};
111 case wxSTREAM_PROTOCOL
: return protocols
;
112 case wxSTREAM_MIMETYPE
: return mimetypes
;
113 case wxSTREAM_FILEEXTENSION
: return fileexts
;
114 default: return empty
;
119 /////////////////////////////////////////////////////////////////////////////
122 typedef wxFileOffset wxTarNumber
;
124 struct wxTarField
{ const wxChar
*name
; int pos
; };
126 class wxTarHeaderBlock
130 { memset(data
, 0, sizeof(data
)); }
131 wxTarHeaderBlock(const wxTarHeaderBlock
& hb
)
132 { memcpy(data
, hb
.data
, sizeof(data
)); }
134 bool Read(wxInputStream
& in
);
135 bool Write(wxOutputStream
& out
);
136 inline bool WriteField(wxOutputStream
& out
, int id
);
138 bool IsAllZeros() const;
139 wxUint32
Sum(bool SignedSum
= false);
140 wxUint32
SumField(int id
);
142 char *Get(int id
) { return data
+ fields
[id
].pos
+ id
; }
143 static size_t Len(int id
) { return fields
[id
+ 1].pos
- fields
[id
].pos
; }
144 static const wxChar
*Name(int id
) { return fields
[id
].name
; }
145 static size_t Offset(int id
) { return fields
[id
].pos
; }
147 bool SetOctal(int id
, wxTarNumber n
);
148 wxTarNumber
GetOctal(int id
);
149 bool SetPath(const wxString
& name
, wxMBConv
& conv
);
152 char data
[TAR_BLOCKSIZE
+ TAR_NUMFIELDS
];
153 static const wxTarField fields
[];
157 wxDEFINE_SCOPED_PTR_TYPE(wxTarHeaderBlock
);
159 // A table giving the field names and offsets in a tar header block
160 const wxTarField
wxTarHeaderBlock::fields
[] =
162 { _T("name"), 0 }, // 100
163 { _T("mode"), 100 }, // 8
164 { _T("uid"), 108 }, // 8
165 { _T("gid"), 116 }, // 8
166 { _T("size"), 124 }, // 12
167 { _T("mtime"), 136 }, // 12
168 { _T("chksum"), 148 }, // 8
169 { _T("typeflag"), 156 }, // 1
170 { _T("linkname"), 157 }, // 100
171 { _T("magic"), 257 }, // 6
172 { _T("version"), 263 }, // 2
173 { _T("uname"), 265 }, // 32
174 { _T("gname"), 297 }, // 32
175 { _T("devmajor"), 329 }, // 8
176 { _T("devminor"), 337 }, // 8
177 { _T("prefix"), 345 }, // 155
178 { _T("unused"), 500 }, // 12
179 { NULL
, TAR_BLOCKSIZE
}
182 void wxTarHeaderBlock::check()
184 wxCOMPILE_TIME_ASSERT(
185 WXSIZEOF(fields
) == TAR_NUMFIELDS
+ 1,
186 Wrong_number_of_elements_in_fields_table
190 bool wxTarHeaderBlock::IsAllZeros() const
192 const char *p
= data
;
193 for (size_t i
= 0; i
< sizeof(data
); i
++)
199 wxUint32
wxTarHeaderBlock::Sum(bool SignedSum
/*=false*/)
201 // the chksum field itself should be blanks during the calculation
202 memset(Get(TAR_CHKSUM
), ' ', Len(TAR_CHKSUM
));
203 const char *p
= data
;
207 for (size_t i
= 0; i
< sizeof(data
); i
++)
208 n
+= (signed char)p
[i
];
210 for (size_t i
= 0; i
< sizeof(data
); i
++)
211 n
+= (unsigned char)p
[i
];
216 wxUint32
wxTarHeaderBlock::SumField(int id
)
218 unsigned char *p
= (unsigned char*)Get(id
);
219 unsigned char *q
= p
+ Len(id
);
228 bool wxTarHeaderBlock::Read(wxInputStream
& in
)
232 for (int id
= 0; id
< TAR_NUMFIELDS
&& ok
; id
++)
233 ok
= in
.Read(Get(id
), Len(id
)).LastRead() == Len(id
);
238 bool wxTarHeaderBlock::Write(wxOutputStream
& out
)
242 for (int id
= 0; id
< TAR_NUMFIELDS
&& ok
; id
++)
243 ok
= WriteField(out
, id
);
248 bool wxTarHeaderBlock::WriteField(wxOutputStream
& out
, int id
)
250 return out
.Write(Get(id
), Len(id
)).LastWrite() == Len(id
);
253 wxTarNumber
wxTarHeaderBlock::GetOctal(int id
)
256 const char *p
= Get(id
);
259 while (*p
>= '0' && *p
< '8')
260 n
= (n
<< 3) | (*p
++ - '0');
264 bool wxTarHeaderBlock::SetOctal(int id
, wxTarNumber n
)
266 // set an octal field, return true if the number fits
267 char *field
= Get(id
);
268 char *p
= field
+ Len(id
);
271 *--p
= '0' + (n
& 7);
277 bool wxTarHeaderBlock::SetPath(const wxString
& name
, wxMBConv
& conv
)
279 bool badconv
= false;
282 wxCharBuffer nameBuf
= name
.mb_str(conv
);
284 // if the conversion fails make an approximation
287 size_t len
= name
.length();
288 wxCharBuffer
approx(len
);
289 for (size_t i
= 0; i
< len
; i
++)
290 approx
.data()[i
] = name
[i
] & ~0x7F ? '_' : name
[i
];
294 const char *mbName
= nameBuf
;
296 const char *mbName
= name
.c_str();
301 bool notGoingToFit
= false;
302 size_t len
= strlen(mbName
);
303 size_t maxname
= Len(TAR_NAME
);
304 size_t maxprefix
= Len(TAR_PREFIX
);
309 fits
= i
< maxprefix
&& len
- i
<= maxname
;
312 const char *p
= strchr(mbName
+ i
, '/');
314 nexti
= p
- mbName
+ 1;
315 if (!p
|| nexti
- 1 > maxprefix
)
316 notGoingToFit
= true;
319 if (fits
|| notGoingToFit
) {
320 strncpy(Get(TAR_NAME
), mbName
+ i
, maxname
);
322 strncpy(Get(TAR_PREFIX
), mbName
, i
- 1);
329 return fits
&& !badconv
;
333 /////////////////////////////////////////////////////////////////////////////
336 static wxFileOffset
RoundUpSize(wxFileOffset size
, int factor
= 1)
338 wxFileOffset chunk
= TAR_BLOCKSIZE
* factor
;
339 return ((size
+ chunk
- 1) / chunk
) * chunk
;
342 static wxString
GroupName()
346 if ((gr
= getgrgid(getgid())) != NULL
)
347 return wxString(gr
->gr_name
, wxConvLibc
);
352 static inline int UserId()
361 static inline int GroupId()
370 // ignore the size field for entry types 3, 4, 5 and 6
372 static inline wxFileOffset
GetDataSize(const wxTarEntry
& entry
)
374 switch (entry
.GetTypeFlag()) {
381 return entry
.GetSize();
386 /////////////////////////////////////////////////////////////////////////////
388 // Holds all the meta-data for a file in the tar
390 wxTarEntry::wxTarEntry(const wxString
& name
/*=wxEmptyString*/,
391 const wxDateTime
& dt
/*=wxDateTime::Now()*/,
392 wxFileOffset size
/*=0*/)
396 m_GroupId(GroupId()),
398 m_Offset(wxInvalidOffset
),
400 m_TypeFlag(wxTAR_REGTYPE
),
401 m_UserName(wxGetUserId()),
402 m_GroupName(GroupName()),
410 wxTarEntry::~wxTarEntry()
414 wxTarEntry::wxTarEntry(const wxTarEntry
& e
)
417 m_IsModeSet(e
.m_IsModeSet
),
418 m_UserId(e
.m_UserId
),
419 m_GroupId(e
.m_GroupId
),
421 m_Offset(e
.m_Offset
),
422 m_ModifyTime(e
.m_ModifyTime
),
423 m_AccessTime(e
.m_AccessTime
),
424 m_CreateTime(e
.m_CreateTime
),
425 m_TypeFlag(e
.m_TypeFlag
),
426 m_LinkName(e
.m_LinkName
),
427 m_UserName(e
.m_UserName
),
428 m_GroupName(e
.m_GroupName
),
429 m_DevMajor(e
.m_DevMajor
),
430 m_DevMinor(e
.m_DevMinor
)
434 wxTarEntry
& wxTarEntry::operator=(const wxTarEntry
& e
)
439 m_IsModeSet
= e
.m_IsModeSet
;
440 m_UserId
= e
.m_UserId
;
441 m_GroupId
= e
.m_GroupId
;
443 m_Offset
= e
.m_Offset
;
444 m_ModifyTime
= e
.m_ModifyTime
;
445 m_AccessTime
= e
.m_AccessTime
;
446 m_CreateTime
= e
.m_CreateTime
;
447 m_TypeFlag
= e
.m_TypeFlag
;
448 m_LinkName
= e
.m_LinkName
;
449 m_UserName
= e
.m_UserName
;
450 m_GroupName
= e
.m_GroupName
;
451 m_DevMajor
= e
.m_DevMajor
;
452 m_DevMinor
= e
.m_DevMinor
;
457 wxString
wxTarEntry::GetName(wxPathFormat format
/*=wxPATH_NATIVE*/) const
459 bool isDir
= IsDir() && !m_Name
.empty();
461 // optimisations for common (and easy) cases
462 switch (wxFileName::GetFormat(format
)) {
465 wxString
name(isDir
? m_Name
+ _T("\\") : m_Name
);
466 for (size_t i
= 0; i
< name
.length(); i
++)
467 if (name
[i
] == _T('/'))
473 return isDir
? m_Name
+ _T("/") : m_Name
;
482 fn
.AssignDir(m_Name
, wxPATH_UNIX
);
484 fn
.Assign(m_Name
, wxPATH_UNIX
);
486 return fn
.GetFullPath(format
);
489 void wxTarEntry::SetName(const wxString
& name
, wxPathFormat format
)
492 m_Name
= GetInternalName(name
, format
, &isDir
);
496 // Static - Internally tars and zips use forward slashes for the path
497 // separator, absolute paths aren't allowed, and directory names have a
498 // trailing slash. This function converts a path into this internal format,
499 // but without a trailing slash for a directory.
501 wxString
wxTarEntry::GetInternalName(const wxString
& name
,
502 wxPathFormat format
/*=wxPATH_NATIVE*/,
503 bool *pIsDir
/*=NULL*/)
507 if (wxFileName::GetFormat(format
) != wxPATH_UNIX
)
508 internal
= wxFileName(name
, format
).GetFullPath(wxPATH_UNIX
);
512 bool isDir
= !internal
.empty() && internal
.Last() == '/';
516 internal
.erase(internal
.length() - 1);
518 while (!internal
.empty() && *internal
.begin() == '/')
519 internal
.erase(0, 1);
520 while (!internal
.empty() && internal
.compare(0, 2, _T("./")) == 0)
521 internal
.erase(0, 2);
522 if (internal
== _T(".") || internal
== _T(".."))
523 internal
= wxEmptyString
;
528 bool wxTarEntry::IsDir() const
530 return m_TypeFlag
- wxTAR_DIRTYPE
== 0;
533 void wxTarEntry::SetIsDir(bool isDir
)
536 m_TypeFlag
= wxTAR_DIRTYPE
;
537 else if (m_TypeFlag
- wxTAR_DIRTYPE
== 0)
538 m_TypeFlag
= wxTAR_REGTYPE
;
541 void wxTarEntry::SetIsReadOnly(bool isReadOnly
)
549 int wxTarEntry::GetMode() const
551 if (m_IsModeSet
|| !IsDir())
554 return m_Mode
| 0111;
558 void wxTarEntry::SetMode(int mode
)
560 m_Mode
= mode
& 07777;
565 /////////////////////////////////////////////////////////////////////////////
568 wxDECLARE_SCOPED_PTR(wxTarEntry
, wxTarEntryPtr_
)
569 wxDEFINE_SCOPED_PTR (wxTarEntry
, wxTarEntryPtr_
)
571 wxTarInputStream::wxTarInputStream(wxInputStream
& stream
,
572 wxMBConv
& conv
/*=wxConvLocal*/)
573 : wxArchiveInputStream(stream
, conv
)
578 wxTarInputStream::wxTarInputStream(wxInputStream
*stream
,
579 wxMBConv
& conv
/*=wxConvLocal*/)
580 : wxArchiveInputStream(stream
, conv
)
585 void wxTarInputStream::Init()
587 m_pos
= wxInvalidOffset
;
589 m_size
= wxInvalidOffset
;
590 m_sumType
= SUM_UNKNOWN
;
591 m_tarType
= TYPE_USTAR
;
592 m_hdr
= new wxTarHeaderBlock
;
594 m_GlobalHeaderRecs
= NULL
;
595 m_lasterror
= m_parent_i_stream
->GetLastError();
598 wxTarInputStream::~wxTarInputStream()
602 delete m_GlobalHeaderRecs
;
605 wxTarEntry
*wxTarInputStream::GetNextEntry()
607 m_lasterror
= ReadHeaders();
612 wxTarEntryPtr_
entry(new wxTarEntry
);
614 entry
->SetMode(GetHeaderNumber(TAR_MODE
));
615 entry
->SetUserId(GetHeaderNumber(TAR_UID
));
616 entry
->SetGroupId(GetHeaderNumber(TAR_UID
));
617 entry
->SetSize(GetHeaderNumber(TAR_SIZE
));
619 entry
->SetOffset(m_offset
);
621 entry
->SetDateTime(GetHeaderDate(_T("mtime")));
622 entry
->SetAccessTime(GetHeaderDate(_T("atime")));
623 entry
->SetCreateTime(GetHeaderDate(_T("ctime")));
625 entry
->SetTypeFlag(*m_hdr
->Get(TAR_TYPEFLAG
));
626 bool isDir
= entry
->IsDir();
628 entry
->SetLinkName(GetHeaderString(TAR_LINKNAME
));
630 if (m_tarType
!= TYPE_OLDTAR
) {
631 entry
->SetUserName(GetHeaderString(TAR_UNAME
));
632 entry
->SetGroupName(GetHeaderString(TAR_GNAME
));
634 entry
->SetDevMajor(GetHeaderNumber(TAR_DEVMAJOR
));
635 entry
->SetDevMinor(GetHeaderNumber(TAR_DEVMINOR
));
638 entry
->SetName(GetHeaderPath(), wxPATH_UNIX
);
643 m_HeaderRecs
->clear();
645 m_size
= GetDataSize(*entry
);
648 return entry
.release();
651 bool wxTarInputStream::OpenEntry(wxTarEntry
& entry
)
653 wxFileOffset offset
= entry
.GetOffset();
655 if (GetLastError() != wxSTREAM_READ_ERROR
656 && m_parent_i_stream
->IsSeekable()
657 && m_parent_i_stream
->SeekI(offset
) == offset
)
660 m_size
= GetDataSize(entry
);
662 m_lasterror
= wxSTREAM_NO_ERROR
;
665 m_lasterror
= wxSTREAM_READ_ERROR
;
670 bool wxTarInputStream::OpenEntry(wxArchiveEntry
& entry
)
672 wxTarEntry
*tarEntry
= wxStaticCast(&entry
, wxTarEntry
);
673 return tarEntry
? OpenEntry(*tarEntry
) : false;
676 bool wxTarInputStream::CloseEntry()
678 if (m_lasterror
== wxSTREAM_READ_ERROR
)
683 wxFileOffset size
= RoundUpSize(m_size
);
684 wxFileOffset remainder
= size
- m_pos
;
686 if (remainder
&& m_parent_i_stream
->IsSeekable()) {
688 if (m_parent_i_stream
->SeekI(remainder
, wxFromCurrent
)
694 const int BUFSIZE
= 8192;
695 wxCharBuffer
buf(BUFSIZE
);
697 while (remainder
> 0 && m_parent_i_stream
->IsOk())
698 remainder
-= m_parent_i_stream
->Read(
699 buf
.data(), wxMin(BUFSIZE
, remainder
)).LastRead();
702 m_pos
= wxInvalidOffset
;
704 m_lasterror
= m_parent_i_stream
->GetLastError();
709 wxStreamError
wxTarInputStream::ReadHeaders()
712 return wxSTREAM_READ_ERROR
;
717 m_hdr
->Read(*m_parent_i_stream
);
718 if (m_parent_i_stream
->Eof())
719 wxLogError(_("incomplete header block in tar"));
720 if (!*m_parent_i_stream
)
721 return wxSTREAM_READ_ERROR
;
722 m_offset
+= TAR_BLOCKSIZE
;
724 // an all-zero header marks the end of the tar
725 if (m_hdr
->IsAllZeros())
728 // the checksum is supposed to be the unsigned sum of the header bytes,
729 // but there have been versions of tar that used the signed sum, so
730 // accept that too, but only if used throughout.
731 wxUint32 chksum
= m_hdr
->GetOctal(TAR_CHKSUM
);
734 if (m_sumType
!= SUM_SIGNED
) {
735 ok
= chksum
== m_hdr
->Sum();
736 if (m_sumType
== SUM_UNKNOWN
)
737 m_sumType
= ok
? SUM_UNSIGNED
: SUM_SIGNED
;
739 if (m_sumType
== SUM_SIGNED
)
740 ok
= chksum
== m_hdr
->Sum(true);
742 wxLogError(_("checksum failure reading tar header block"));
743 return wxSTREAM_READ_ERROR
;
746 if (strcmp(m_hdr
->Get(TAR_MAGIC
), USTAR_MAGIC
) == 0)
747 m_tarType
= TYPE_USTAR
;
748 else if (strcmp(m_hdr
->Get(TAR_MAGIC
), GNU_MAGIC
) == 0 &&
749 strcmp(m_hdr
->Get(TAR_VERSION
), GNU_VERION
) == 0)
750 m_tarType
= TYPE_GNUTAR
;
752 m_tarType
= TYPE_OLDTAR
;
754 if (m_tarType
!= TYPE_USTAR
)
757 switch (*m_hdr
->Get(TAR_TYPEFLAG
)) {
758 case 'g': ReadExtendedHeader(m_GlobalHeaderRecs
); break;
759 case 'x': ReadExtendedHeader(m_HeaderRecs
); break;
760 default: done
= true;
764 return wxSTREAM_NO_ERROR
;
767 wxString
wxTarInputStream::GetExtendedHeader(const wxString
& key
) const
769 wxTarHeaderRecords::iterator it
;
771 // look at normal extended header records first
773 it
= m_HeaderRecs
->find(key
);
774 if (it
!= m_HeaderRecs
->end())
775 return wxString(it
->second
.wc_str(wxConvUTF8
), GetConv());
778 // if not found, look at the global header records
779 if (m_GlobalHeaderRecs
) {
780 it
= m_GlobalHeaderRecs
->find(key
);
781 if (it
!= m_GlobalHeaderRecs
->end())
782 return wxString(it
->second
.wc_str(wxConvUTF8
), GetConv());
785 return wxEmptyString
;
788 wxString
wxTarInputStream::GetHeaderPath() const
792 if ((path
= GetExtendedHeader(_T("path"))) != wxEmptyString
)
795 path
= wxString(m_hdr
->Get(TAR_NAME
), GetConv());
796 if (m_tarType
!= TYPE_USTAR
)
799 const char *prefix
= m_hdr
->Get(TAR_PREFIX
);
800 return *prefix
? wxString(prefix
, GetConv()) + _T("/") + path
: path
;
803 wxDateTime
wxTarInputStream::GetHeaderDate(const wxString
& key
) const
807 // try extended header, stored as decimal seconds since the epoch
808 if ((value
= GetExtendedHeader(key
)) != wxEmptyString
) {
810 ll
.Assign(wxAtof(value
) * 1000.0);
814 if (key
== _T("mtime"))
815 return wxLongLong(m_hdr
->GetOctal(TAR_MTIME
)) * 1000L;
820 wxTarNumber
wxTarInputStream::GetHeaderNumber(int id
) const
824 if ((value
= GetExtendedHeader(m_hdr
->Name(id
))) != wxEmptyString
) {
826 const wxChar
*p
= value
;
830 n
= n
* 10 + (*p
++ - '0');
833 return m_hdr
->GetOctal(id
);
837 wxString
wxTarInputStream::GetHeaderString(int id
) const
841 if ((value
= GetExtendedHeader(m_hdr
->Name(id
))) != wxEmptyString
)
844 return wxString(m_hdr
->Get(id
), GetConv());
847 // An extended header consists of one or more records, each constructed:
848 // "%d %s=%s\n", <length>, <keyword>, <value>
849 // <length> is the byte length, <keyword> and <value> are UTF-8
851 bool wxTarInputStream::ReadExtendedHeader(wxTarHeaderRecords
*& recs
)
854 recs
= new wxTarHeaderRecords
;
856 // round length up to a whole number of blocks
857 size_t len
= m_hdr
->GetOctal(TAR_SIZE
);
858 size_t size
= RoundUpSize(len
);
860 // read in the whole header since it should be small
861 wxCharBuffer
buf(size
);
862 size_t lastread
= m_parent_i_stream
->Read(buf
.data(), size
).LastRead();
866 m_offset
+= lastread
;
868 size_t recPos
, recSize
;
871 for (recPos
= 0; recPos
< len
; recPos
+= recSize
) {
872 char *pRec
= buf
.data() + recPos
;
875 // read the record size (byte count in ascii decimal)
878 recSize
= recSize
* 10 + *p
++ - '0';
881 if (recPos
+ recSize
> len
)
883 if (recSize
< p
- pRec
+ (size_t)3 || *p
!= ' '
884 || pRec
[recSize
- 1] != '\012') {
889 // replace the final '\n' with a nul, to terminate value
890 pRec
[recSize
- 1] = 0;
891 // the key is here, following the space
894 // look forward for the '=', the value follows
895 while (*p
&& *p
!= '=')
901 // replace the '=' with a nul, to terminate the key
904 wxString
key(wxConvUTF8
.cMB2WC(pKey
), GetConv());
905 wxString
value(wxConvUTF8
.cMB2WC(p
), GetConv());
907 // an empty value unsets a previously given value
911 (*recs
)[key
] = value
;
914 if (!ok
|| recPos
< len
|| size
!= lastread
) {
915 wxLogWarning(_("invalid data in extended tar header"));
922 wxFileOffset
wxTarInputStream::OnSysSeek(wxFileOffset pos
, wxSeekMode mode
)
925 wxLogError(_("tar entry not open"));
926 m_lasterror
= wxSTREAM_READ_ERROR
;
929 return wxInvalidOffset
;
932 case wxFromStart
: break;
933 case wxFromCurrent
: pos
+= m_pos
; break;
934 case wxFromEnd
: pos
+= m_size
; break;
937 if (pos
< 0 || m_parent_i_stream
->SeekI(m_offset
+ pos
) == wxInvalidOffset
)
938 return wxInvalidOffset
;
944 size_t wxTarInputStream::OnSysRead(void *buffer
, size_t size
)
947 wxLogError(_("tar entry not open"));
948 m_lasterror
= wxSTREAM_READ_ERROR
;
950 if (!IsOk() || !size
)
955 else if (m_pos
+ size
> m_size
+ (size_t)0)
956 size
= m_size
- m_pos
;
958 size_t lastread
= m_parent_i_stream
->Read(buffer
, size
).LastRead();
961 if (m_pos
>= m_size
) {
962 m_lasterror
= wxSTREAM_EOF
;
963 } else if (!m_parent_i_stream
->IsOk()) {
964 // any other error will have been reported by the underlying stream
965 if (m_parent_i_stream
->Eof())
966 wxLogError(_("unexpected end of file"));
967 m_lasterror
= wxSTREAM_READ_ERROR
;
974 /////////////////////////////////////////////////////////////////////////////
977 wxTarOutputStream::wxTarOutputStream(wxOutputStream
& stream
,
978 wxTarFormat format
/*=wxTAR_PAX*/,
979 wxMBConv
& conv
/*=wxConvLocal*/)
980 : wxArchiveOutputStream(stream
, conv
)
985 wxTarOutputStream::wxTarOutputStream(wxOutputStream
*stream
,
986 wxTarFormat format
/*=wxTAR_PAX*/,
987 wxMBConv
& conv
/*=wxConvLocal*/)
988 : wxArchiveOutputStream(stream
, conv
)
993 void wxTarOutputStream::Init(wxTarFormat format
)
995 m_pos
= wxInvalidOffset
;
996 m_maxpos
= wxInvalidOffset
;
997 m_size
= wxInvalidOffset
;
998 m_headpos
= wxInvalidOffset
;
999 m_datapos
= wxInvalidOffset
;
1000 m_tarstart
= wxInvalidOffset
;
1002 m_pax
= format
== wxTAR_PAX
;
1003 m_BlockingFactor
= m_pax
? 10 : 20;
1006 m_hdr
= new wxTarHeaderBlock
;
1008 m_extendedHdr
= NULL
;
1010 m_lasterror
= m_parent_o_stream
->GetLastError();
1013 wxTarOutputStream::~wxTarOutputStream()
1019 delete [] m_extendedHdr
;
1022 bool wxTarOutputStream::PutNextEntry(wxTarEntry
*entry
)
1024 wxTarEntryPtr_
e(entry
);
1031 m_tarstart
= m_parent_o_stream
->TellO();
1034 if (m_tarstart
!= wxInvalidOffset
)
1035 m_headpos
= m_tarstart
+ m_tarsize
;
1037 if (WriteHeaders(*e
)) {
1040 m_size
= GetDataSize(*e
);
1041 if (m_tarstart
!= wxInvalidOffset
)
1042 m_datapos
= m_tarstart
+ m_tarsize
;
1044 // types that are not allowd any data
1045 const char nodata
[] = {
1046 wxTAR_LNKTYPE
, wxTAR_SYMTYPE
, wxTAR_CHRTYPE
, wxTAR_BLKTYPE
,
1047 wxTAR_DIRTYPE
, wxTAR_FIFOTYPE
, 0
1049 char typeflag
= e
->GetTypeFlag();
1051 // pax does now allow data for wxTAR_LNKTYPE
1052 if (!m_pax
|| typeflag
- wxTAR_LNKTYPE
!= 0)
1053 if (strchr(nodata
, typeflag
) != NULL
)
1060 bool wxTarOutputStream::PutNextEntry(const wxString
& name
,
1061 const wxDateTime
& dt
,
1064 return PutNextEntry(new wxTarEntry(name
, dt
, size
));
1067 bool wxTarOutputStream::PutNextDirEntry(const wxString
& name
,
1068 const wxDateTime
& dt
)
1070 wxTarEntry
*entry
= new wxTarEntry(name
, dt
);
1072 return PutNextEntry(entry
);
1075 bool wxTarOutputStream::PutNextEntry(wxArchiveEntry
*entry
)
1077 wxTarEntry
*tarEntry
= wxStaticCast(entry
, wxTarEntry
);
1080 return PutNextEntry(tarEntry
);
1083 bool wxTarOutputStream::CopyEntry(wxTarEntry
*entry
,
1084 wxTarInputStream
& inputStream
)
1086 if (PutNextEntry(entry
))
1088 return IsOk() && inputStream
.Eof();
1091 bool wxTarOutputStream::CopyEntry(wxArchiveEntry
*entry
,
1092 wxArchiveInputStream
& inputStream
)
1094 if (PutNextEntry(entry
))
1096 return IsOk() && inputStream
.Eof();
1099 bool wxTarOutputStream::CloseEntry()
1104 if (m_pos
< m_maxpos
) {
1105 wxASSERT(m_parent_o_stream
->IsSeekable());
1106 m_parent_o_stream
->SeekO(m_datapos
+ m_maxpos
);
1107 m_lasterror
= m_parent_o_stream
->GetLastError();
1112 wxFileOffset size
= RoundUpSize(m_pos
);
1114 memset(m_hdr
, 0, size
- m_pos
);
1115 m_parent_o_stream
->Write(m_hdr
, size
- m_pos
);
1116 m_lasterror
= m_parent_o_stream
->GetLastError();
1121 if (IsOk() && m_pos
!= m_size
)
1124 m_pos
= wxInvalidOffset
;
1125 m_maxpos
= wxInvalidOffset
;
1126 m_size
= wxInvalidOffset
;
1127 m_headpos
= wxInvalidOffset
;
1128 m_datapos
= wxInvalidOffset
;
1133 bool wxTarOutputStream::Close()
1138 memset(m_hdr
, 0, sizeof(*m_hdr
));
1139 int count
= (RoundUpSize(m_tarsize
+ 2 * TAR_BLOCKSIZE
, m_BlockingFactor
)
1140 - m_tarsize
) / TAR_BLOCKSIZE
;
1142 m_parent_o_stream
->Write(m_hdr
, TAR_BLOCKSIZE
);
1145 m_tarstart
= wxInvalidOffset
;
1146 m_lasterror
= m_parent_o_stream
->GetLastError();
1150 bool wxTarOutputStream::WriteHeaders(wxTarEntry
& entry
)
1152 memset(m_hdr
, 0, sizeof(*m_hdr
));
1154 SetHeaderPath(entry
.GetName(wxPATH_UNIX
));
1156 SetHeaderNumber(TAR_MODE
, entry
.GetMode());
1157 SetHeaderNumber(TAR_UID
, entry
.GetUserId());
1158 SetHeaderNumber(TAR_GID
, entry
.GetGroupId());
1160 if (entry
.GetSize() == wxInvalidOffset
)
1162 m_large
= SetHeaderNumber(TAR_SIZE
, entry
.GetSize());
1164 SetHeaderDate(_T("mtime"), entry
.GetDateTime());
1165 if (entry
.GetAccessTime().IsValid())
1166 SetHeaderDate(_T("atime"), entry
.GetAccessTime());
1167 if (entry
.GetCreateTime().IsValid())
1168 SetHeaderDate(_T("ctime"), entry
.GetCreateTime());
1170 *m_hdr
->Get(TAR_TYPEFLAG
) = entry
.GetTypeFlag();
1172 strcpy(m_hdr
->Get(TAR_MAGIC
), USTAR_MAGIC
);
1173 strcpy(m_hdr
->Get(TAR_VERSION
), USTAR_VERSION
);
1175 SetHeaderString(TAR_LINKNAME
, entry
.GetLinkName());
1176 SetHeaderString(TAR_UNAME
, entry
.GetUserName());
1177 SetHeaderString(TAR_GNAME
, entry
.GetGroupName());
1179 if (~entry
.GetDevMajor())
1180 SetHeaderNumber(TAR_DEVMAJOR
, entry
.GetDevMajor());
1181 if (~entry
.GetDevMinor())
1182 SetHeaderNumber(TAR_DEVMINOR
, entry
.GetDevMinor());
1184 m_chksum
= m_hdr
->Sum();
1185 m_hdr
->SetOctal(TAR_CHKSUM
, m_chksum
);
1187 m_chksum
-= m_hdr
->SumField(TAR_SIZE
);
1189 // The main header is now fully prepared so we know what extended headers
1190 // (if any) will be needed. Output any extended headers before writing
1192 if (m_extendedHdr
&& *m_extendedHdr
) {
1194 // the extended headers are written to the tar as a file entry,
1195 // so prepare a regular header block for the pseudo-file.
1197 m_hdr2
= new wxTarHeaderBlock
;
1198 memset(m_hdr2
, 0, sizeof(*m_hdr2
));
1200 // an old tar that doesn't understand extended headers will
1201 // extract it as a file, so give these fields reasonable values
1202 // so that the user will have access to read and remove it.
1203 m_hdr2
->SetPath(PaxHeaderPath(_T("%d/PaxHeaders.%p/%f"),
1204 entry
.GetName(wxPATH_UNIX
)), GetConv());
1205 m_hdr2
->SetOctal(TAR_MODE
, 0600);
1206 strcpy(m_hdr2
->Get(TAR_UID
), m_hdr
->Get(TAR_UID
));
1207 strcpy(m_hdr2
->Get(TAR_GID
), m_hdr
->Get(TAR_GID
));
1208 size_t length
= strlen(m_extendedHdr
);
1209 m_hdr2
->SetOctal(TAR_SIZE
, length
);
1210 strcpy(m_hdr2
->Get(TAR_MTIME
), m_hdr
->Get(TAR_MTIME
));
1211 *m_hdr2
->Get(TAR_TYPEFLAG
) = 'x';
1212 strcpy(m_hdr2
->Get(TAR_MAGIC
), USTAR_MAGIC
);
1213 strcpy(m_hdr2
->Get(TAR_VERSION
), USTAR_VERSION
);
1214 strcpy(m_hdr2
->Get(TAR_UNAME
), m_hdr
->Get(TAR_UNAME
));
1215 strcpy(m_hdr2
->Get(TAR_GNAME
), m_hdr
->Get(TAR_GNAME
));
1217 m_hdr2
->SetOctal(TAR_CHKSUM
, m_hdr2
->Sum());
1219 m_hdr2
->Write(*m_parent_o_stream
);
1220 m_tarsize
+= TAR_BLOCKSIZE
;
1222 size_t rounded
= RoundUpSize(length
);
1223 memset(m_extendedHdr
+ length
, 0, rounded
- length
);
1224 m_parent_o_stream
->Write(m_extendedHdr
, rounded
);
1225 m_tarsize
+= rounded
;
1230 // if don't have extended headers just report error
1231 if (!m_badfit
.empty()) {
1233 wxLogWarning(_("%s did not fit the tar header for entry '%s'"),
1234 m_badfit
.c_str(), entry
.GetName().c_str());
1238 m_hdr
->Write(*m_parent_o_stream
);
1239 m_tarsize
+= TAR_BLOCKSIZE
;
1240 m_lasterror
= m_parent_o_stream
->GetLastError();
1245 wxString
wxTarOutputStream::PaxHeaderPath(const wxString
& format
,
1246 const wxString
& path
)
1248 wxString d
= path
.BeforeLast(_T('/'));
1249 wxString f
= path
.AfterLast(_T('/'));
1255 ret
.reserve(format
.length() + path
.length() + 16);
1261 end
= format
.find('%', begin
);
1262 if (end
== wxString::npos
|| end
+ 1 >= format
.length())
1264 ret
<< format
.substr(begin
, end
- begin
);
1265 switch (format
[end
+ 1]) {
1266 case 'd': ret
<< d
; break;
1267 case 'f': ret
<< f
; break;
1268 case 'p': ret
<< wxGetProcessId(); break;
1269 case '%': ret
<< _T("%"); break;
1274 ret
<< format
.substr(begin
);
1279 bool wxTarOutputStream::ModifyHeader()
1281 wxFileOffset originalPos
= wxInvalidOffset
;
1282 wxFileOffset sizePos
= wxInvalidOffset
;
1284 if (!m_large
&& m_headpos
!= wxInvalidOffset
1285 && m_parent_o_stream
->IsSeekable())
1288 originalPos
= m_parent_o_stream
->TellO();
1289 if (originalPos
!= wxInvalidOffset
)
1291 m_parent_o_stream
->SeekO(m_headpos
+ m_hdr
->Offset(TAR_SIZE
));
1294 if (sizePos
== wxInvalidOffset
|| !m_hdr
->SetOctal(TAR_SIZE
, m_pos
)) {
1295 wxLogError(_("incorrect size given for tar entry"));
1296 m_lasterror
= wxSTREAM_WRITE_ERROR
;
1300 m_chksum
+= m_hdr
->SumField(TAR_SIZE
);
1301 m_hdr
->SetOctal(TAR_CHKSUM
, m_chksum
);
1302 wxFileOffset sumPos
= m_headpos
+ m_hdr
->Offset(TAR_CHKSUM
);
1305 m_hdr
->WriteField(*m_parent_o_stream
, TAR_SIZE
) &&
1306 m_parent_o_stream
->SeekO(sumPos
) == sumPos
&&
1307 m_hdr
->WriteField(*m_parent_o_stream
, TAR_CHKSUM
) &&
1308 m_parent_o_stream
->SeekO(originalPos
) == originalPos
;
1311 void wxTarOutputStream::SetHeaderPath(const wxString
& name
)
1313 if (!m_hdr
->SetPath(name
, GetConv()) || (m_pax
&& !name
.IsAscii()))
1314 SetExtendedHeader(_T("path"), name
);
1317 bool wxTarOutputStream::SetHeaderNumber(int id
, wxTarNumber n
)
1319 if (m_hdr
->SetOctal(id
, n
)) {
1322 SetExtendedHeader(m_hdr
->Name(id
), wxLongLong(n
).ToString());
1327 void wxTarOutputStream::SetHeaderString(int id
, const wxString
& str
)
1329 strncpy(m_hdr
->Get(id
), str
.mb_str(GetConv()), m_hdr
->Len(id
));
1330 if (str
.length() > m_hdr
->Len(id
))
1331 SetExtendedHeader(m_hdr
->Name(id
), str
);
1334 void wxTarOutputStream::SetHeaderDate(const wxString
& key
,
1335 const wxDateTime
& datetime
)
1337 wxLongLong ll
= datetime
.IsValid() ? datetime
.GetValue() : wxLongLong(0);
1338 wxLongLong secs
= ll
/ 1000L;
1340 if (key
!= _T("mtime") || !m_hdr
->SetOctal(TAR_MTIME
, secs
.GetValue())
1341 || secs
<= 0 || secs
>= 0x7fffffff)
1344 if (ll
>= LONG_MIN
&& ll
<= LONG_MAX
) {
1345 str
.Printf(_T("%g"), ll
.ToLong() / 1000.0);
1347 str
= ll
.ToString();
1348 str
.insert(str
.end() - 3, '.');
1350 SetExtendedHeader(key
, str
);
1354 void wxTarOutputStream::SetExtendedHeader(const wxString
& key
,
1355 const wxString
& value
)
1358 const wxWX2WCbuf wide_key
= key
.wc_str(GetConv());
1359 const wxCharBuffer utf_key
= wxConvUTF8
.cWC2MB(wide_key
);
1361 const wxWX2WCbuf wide_value
= value
.wc_str(GetConv());
1362 const wxCharBuffer utf_value
= wxConvUTF8
.cWC2MB(wide_value
);
1364 // a small buffer to format the length field in
1366 // length of "99<space><key>=<value>\n"
1367 unsigned long length
= strlen(utf_value
) + strlen(utf_key
) + 5;
1368 sprintf(buf
, "%lu", length
);
1369 // the length includes itself
1370 size_t lenlen
= strlen(buf
);
1372 length
+= lenlen
- 2;
1373 sprintf(buf
, "%lu", length
);
1374 if (strlen(buf
) > lenlen
)
1375 sprintf(buf
, "%lu", ++length
);
1378 // reallocate m_extendedHdr if it's not big enough
1379 if (m_extendedSize
< length
) {
1380 size_t rounded
= RoundUpSize(length
);
1381 m_extendedSize
<<= 1;
1382 if (rounded
> m_extendedSize
)
1383 m_extendedSize
= rounded
;
1384 char *oldHdr
= m_extendedHdr
;
1385 m_extendedHdr
= new char[m_extendedSize
];
1387 strcpy(m_extendedHdr
, oldHdr
);
1394 // append the new record
1395 char *append
= strchr(m_extendedHdr
, 0);
1396 sprintf(append
, "%s %s=%s\012", buf
,
1397 (const char*)utf_key
, (const char*)utf_value
);
1400 // if not pax then make a list of fields to report as errors
1401 if (!m_badfit
.empty())
1402 m_badfit
+= _T(", ");
1407 void wxTarOutputStream::Sync()
1409 m_parent_o_stream
->Sync();
1412 wxFileOffset
wxTarOutputStream::OnSysSeek(wxFileOffset pos
, wxSeekMode mode
)
1415 wxLogError(_("tar entry not open"));
1416 m_lasterror
= wxSTREAM_WRITE_ERROR
;
1418 if (!IsOk() || m_datapos
== wxInvalidOffset
)
1419 return wxInvalidOffset
;
1422 case wxFromStart
: break;
1423 case wxFromCurrent
: pos
+= m_pos
; break;
1424 case wxFromEnd
: pos
+= m_maxpos
; break;
1427 if (pos
< 0 || m_parent_o_stream
->SeekO(m_datapos
+ pos
) == wxInvalidOffset
)
1428 return wxInvalidOffset
;
1434 size_t wxTarOutputStream::OnSysWrite(const void *buffer
, size_t size
)
1437 wxLogError(_("tar entry not open"));
1438 m_lasterror
= wxSTREAM_WRITE_ERROR
;
1440 if (!IsOk() || !size
)
1443 size_t lastwrite
= m_parent_o_stream
->Write(buffer
, size
).LastWrite();
1445 if (m_pos
> m_maxpos
)
1448 if (lastwrite
!= size
)
1449 m_lasterror
= wxSTREAM_WRITE_ERROR
;
1454 #endif // wxUSE_TARSTREAM