2008-05-27 22:49:34 +00:00
|
|
|
/*
|
|
|
|
* Copyright (c) Contributors, http://opensimulator.org/
|
|
|
|
* See CONTRIBUTORS.TXT for a full list of copyright holders.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions are met:
|
|
|
|
* * Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
2009-06-01 06:37:14 +00:00
|
|
|
* * Neither the name of the OpenSimulator Project nor the
|
2008-05-27 22:49:34 +00:00
|
|
|
* names of its contributors may be used to endorse or promote products
|
|
|
|
* derived from this software without specific prior written permission.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
|
|
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
|
|
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
|
* DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
|
|
|
|
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
|
|
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
|
|
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
|
|
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
|
|
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
2009-02-12 18:59:45 +00:00
|
|
|
using System;
|
|
|
|
using System.Collections.Generic;
|
|
|
|
using System.IO;
|
2010-05-21 18:36:39 +00:00
|
|
|
using System.Reflection;
|
2009-02-12 18:59:45 +00:00
|
|
|
using System.Text;
|
2010-05-21 18:36:39 +00:00
|
|
|
using log4net;
|
2009-02-12 18:59:45 +00:00
|
|
|
|
2009-03-16 00:12:25 +00:00
|
|
|
namespace OpenSim.Framework.Serialization
|
2008-05-28 03:44:49 +00:00
|
|
|
{
|
2008-05-27 22:49:34 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Temporary code to produce a tar archive in tar v7 format
|
2008-05-28 03:44:49 +00:00
|
|
|
/// </summary>
|
2008-05-28 17:49:34 +00:00
|
|
|
public class TarArchiveWriter
|
2008-05-27 22:49:34 +00:00
|
|
|
{
|
2010-05-21 18:36:39 +00:00
|
|
|
// private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
|
2008-05-28 03:44:49 +00:00
|
|
|
|
2008-05-28 16:37:43 +00:00
|
|
|
/// <summary>
|
2009-03-06 20:12:08 +00:00
|
|
|
/// Binary writer for the underlying stream
|
|
|
|
/// </summary>
|
|
|
|
protected BinaryWriter m_bw;
|
2009-03-12 06:03:59 +00:00
|
|
|
|
2009-03-06 20:12:08 +00:00
|
|
|
public TarArchiveWriter(Stream s)
|
|
|
|
{
|
|
|
|
m_bw = new BinaryWriter(s);
|
|
|
|
}
|
2009-03-12 06:03:59 +00:00
|
|
|
|
2009-03-06 20:12:08 +00:00
|
|
|
/// <summary>
|
|
|
|
/// Write a directory entry to the tar archive. We can only handle one path level right now!
|
2008-05-28 16:37:43 +00:00
|
|
|
/// </summary>
|
|
|
|
/// <param name="dirName"></param>
|
2009-03-06 20:12:08 +00:00
|
|
|
public void WriteDir(string dirName)
|
2008-05-28 16:37:43 +00:00
|
|
|
{
|
|
|
|
// Directories are signalled by a final /
|
|
|
|
if (!dirName.EndsWith("/"))
|
|
|
|
dirName += "/";
|
2008-08-18 00:39:10 +00:00
|
|
|
|
2009-03-06 20:12:08 +00:00
|
|
|
WriteFile(dirName, new byte[0]);
|
2008-05-28 16:37:43 +00:00
|
|
|
}
|
2009-03-12 06:03:59 +00:00
|
|
|
|
2008-05-27 23:29:59 +00:00
|
|
|
/// <summary>
|
2009-03-06 20:12:08 +00:00
|
|
|
/// Write a file to the tar archive
|
2008-05-27 23:29:59 +00:00
|
|
|
/// </summary>
|
|
|
|
/// <param name="filePath"></param>
|
|
|
|
/// <param name="data"></param>
|
2009-03-06 20:12:08 +00:00
|
|
|
public void WriteFile(string filePath, string data)
|
2008-05-27 23:29:59 +00:00
|
|
|
{
|
2012-07-13 00:03:28 +00:00
|
|
|
WriteFile(filePath, Util.UTF8NoBomEncoding.GetBytes(data));
|
2008-05-27 23:29:59 +00:00
|
|
|
}
|
2008-05-28 03:44:49 +00:00
|
|
|
|
2008-05-27 22:49:34 +00:00
|
|
|
/// <summary>
|
2009-03-06 20:12:08 +00:00
|
|
|
/// Write a file to the tar archive
|
2008-05-27 22:49:34 +00:00
|
|
|
/// </summary>
|
|
|
|
/// <param name="filePath"></param>
|
|
|
|
/// <param name="data"></param>
|
2009-03-06 20:12:08 +00:00
|
|
|
public void WriteFile(string filePath, byte[] data)
|
2008-05-27 22:49:34 +00:00
|
|
|
{
|
2009-03-06 20:12:08 +00:00
|
|
|
if (filePath.Length > 100)
|
2012-07-11 21:54:22 +00:00
|
|
|
WriteEntry("././@LongLink", Encoding.ASCII.GetBytes(filePath), 'L');
|
2009-03-12 06:03:59 +00:00
|
|
|
|
2009-03-06 20:12:08 +00:00
|
|
|
char fileType;
|
2009-03-12 06:03:59 +00:00
|
|
|
|
2009-03-06 20:12:08 +00:00
|
|
|
if (filePath.EndsWith("/"))
|
|
|
|
{
|
|
|
|
fileType = '5';
|
|
|
|
}
|
|
|
|
else
|
|
|
|
{
|
|
|
|
fileType = '0';
|
2009-03-12 06:03:59 +00:00
|
|
|
}
|
|
|
|
|
2009-03-06 20:12:08 +00:00
|
|
|
WriteEntry(filePath, data, fileType);
|
2008-05-27 22:49:34 +00:00
|
|
|
}
|
2009-03-12 06:03:59 +00:00
|
|
|
|
2008-05-27 22:49:34 +00:00
|
|
|
/// <summary>
|
2009-03-06 20:12:08 +00:00
|
|
|
/// Finish writing the raw tar archive data to a stream. The stream will be closed on completion.
|
2008-05-27 22:49:34 +00:00
|
|
|
/// </summary>
|
2008-07-12 18:54:21 +00:00
|
|
|
/// <param name="s">Stream to which to write the data</param>
|
2008-05-27 22:49:34 +00:00
|
|
|
/// <returns></returns>
|
2009-03-06 20:12:08 +00:00
|
|
|
public void Close()
|
2008-05-27 22:49:34 +00:00
|
|
|
{
|
2009-01-30 20:54:38 +00:00
|
|
|
//m_log.Debug("[TAR ARCHIVE WRITER]: Writing final consecutive 0 blocks");
|
2009-03-12 06:03:59 +00:00
|
|
|
|
2008-05-27 22:49:34 +00:00
|
|
|
// Write two consecutive 0 blocks to end the archive
|
|
|
|
byte[] finalZeroPadding = new byte[1024];
|
2008-05-28 03:44:49 +00:00
|
|
|
|
2009-05-14 20:37:54 +00:00
|
|
|
lock (m_bw)
|
|
|
|
{
|
|
|
|
m_bw.Write(finalZeroPadding);
|
2017-01-05 19:07:37 +00:00
|
|
|
|
2009-05-14 20:37:54 +00:00
|
|
|
m_bw.Flush();
|
|
|
|
m_bw.Close();
|
|
|
|
}
|
2008-05-27 22:49:34 +00:00
|
|
|
}
|
2008-05-28 03:44:49 +00:00
|
|
|
|
2008-05-27 22:49:34 +00:00
|
|
|
public static byte[] ConvertDecimalToPaddedOctalBytes(int d, int padding)
|
|
|
|
{
|
2008-05-28 03:44:49 +00:00
|
|
|
string oString = "";
|
|
|
|
|
2008-05-27 22:49:34 +00:00
|
|
|
while (d > 0)
|
|
|
|
{
|
|
|
|
oString = Convert.ToString((byte)'0' + d & 7) + oString;
|
|
|
|
d >>= 3;
|
|
|
|
}
|
2008-05-28 03:44:49 +00:00
|
|
|
|
2008-05-27 22:49:34 +00:00
|
|
|
while (oString.Length < padding)
|
|
|
|
{
|
|
|
|
oString = "0" + oString;
|
2008-05-28 03:44:49 +00:00
|
|
|
}
|
|
|
|
|
2012-07-11 21:54:22 +00:00
|
|
|
byte[] oBytes = Encoding.ASCII.GetBytes(oString);
|
2008-05-28 03:44:49 +00:00
|
|
|
|
2008-05-27 22:49:34 +00:00
|
|
|
return oBytes;
|
2009-03-12 06:03:59 +00:00
|
|
|
}
|
2009-03-04 18:33:05 +00:00
|
|
|
|
|
|
|
/// <summary>
|
2009-03-06 20:12:08 +00:00
|
|
|
/// Write a particular entry
|
2009-03-04 18:33:05 +00:00
|
|
|
/// </summary>
|
|
|
|
/// <param name="filePath"></param>
|
|
|
|
/// <param name="data"></param>
|
|
|
|
/// <param name="fileType"></param>
|
2009-03-06 20:12:08 +00:00
|
|
|
protected void WriteEntry(string filePath, byte[] data, char fileType)
|
2009-03-04 18:33:05 +00:00
|
|
|
{
|
2010-05-21 18:36:39 +00:00
|
|
|
// m_log.DebugFormat(
|
|
|
|
// "[TAR ARCHIVE WRITER]: Data for {0} is {1} bytes", filePath, (null == data ? "null" : data.Length.ToString()));
|
2017-01-05 19:07:37 +00:00
|
|
|
|
2009-03-04 18:33:05 +00:00
|
|
|
byte[] header = new byte[512];
|
|
|
|
|
|
|
|
// file path field (100)
|
2012-07-11 21:54:22 +00:00
|
|
|
byte[] nameBytes = Encoding.ASCII.GetBytes(filePath);
|
2009-03-04 18:33:05 +00:00
|
|
|
int nameSize = (nameBytes.Length >= 100) ? 100 : nameBytes.Length;
|
|
|
|
Array.Copy(nameBytes, header, nameSize);
|
|
|
|
|
|
|
|
// file mode (8)
|
2012-07-11 21:54:22 +00:00
|
|
|
byte[] modeBytes = Encoding.ASCII.GetBytes("0000777");
|
2009-03-04 18:33:05 +00:00
|
|
|
Array.Copy(modeBytes, 0, header, 100, 7);
|
|
|
|
|
|
|
|
// owner user id (8)
|
2012-07-11 21:54:22 +00:00
|
|
|
byte[] ownerIdBytes = Encoding.ASCII.GetBytes("0000764");
|
2009-03-04 18:33:05 +00:00
|
|
|
Array.Copy(ownerIdBytes, 0, header, 108, 7);
|
|
|
|
|
|
|
|
// group user id (8)
|
2012-07-11 21:54:22 +00:00
|
|
|
byte[] groupIdBytes = Encoding.ASCII.GetBytes("0000764");
|
2009-03-04 18:33:05 +00:00
|
|
|
Array.Copy(groupIdBytes, 0, header, 116, 7);
|
|
|
|
|
|
|
|
// file size in bytes (12)
|
|
|
|
int fileSize = data.Length;
|
|
|
|
//m_log.DebugFormat("[TAR ARCHIVE WRITER]: File size of {0} is {1}", filePath, fileSize);
|
|
|
|
|
|
|
|
byte[] fileSizeBytes = ConvertDecimalToPaddedOctalBytes(fileSize, 11);
|
|
|
|
|
|
|
|
Array.Copy(fileSizeBytes, 0, header, 124, 11);
|
|
|
|
|
|
|
|
// last modification time (12)
|
2012-07-11 21:54:22 +00:00
|
|
|
byte[] lastModTimeBytes = Encoding.ASCII.GetBytes("11017037332");
|
2009-03-04 18:33:05 +00:00
|
|
|
Array.Copy(lastModTimeBytes, 0, header, 136, 11);
|
|
|
|
|
|
|
|
// entry type indicator (1)
|
2012-07-11 21:54:22 +00:00
|
|
|
header[156] = Encoding.ASCII.GetBytes(new char[] { fileType })[0];
|
2009-03-04 18:33:05 +00:00
|
|
|
|
2012-07-11 21:54:22 +00:00
|
|
|
Array.Copy(Encoding.ASCII.GetBytes("0000000"), 0, header, 329, 7);
|
|
|
|
Array.Copy(Encoding.ASCII.GetBytes("0000000"), 0, header, 337, 7);
|
2009-03-04 18:33:05 +00:00
|
|
|
|
|
|
|
// check sum for header block (8) [calculated last]
|
2012-07-11 21:54:22 +00:00
|
|
|
Array.Copy(Encoding.ASCII.GetBytes(" "), 0, header, 148, 8);
|
2009-03-04 18:33:05 +00:00
|
|
|
|
|
|
|
int checksum = 0;
|
|
|
|
foreach (byte b in header)
|
|
|
|
{
|
|
|
|
checksum += b;
|
|
|
|
}
|
|
|
|
|
|
|
|
//m_log.DebugFormat("[TAR ARCHIVE WRITER]: Decimal header checksum is {0}", checksum);
|
|
|
|
|
|
|
|
byte[] checkSumBytes = ConvertDecimalToPaddedOctalBytes(checksum, 6);
|
|
|
|
|
|
|
|
Array.Copy(checkSumBytes, 0, header, 148, 6);
|
|
|
|
|
|
|
|
header[154] = 0;
|
|
|
|
|
2009-05-14 20:37:54 +00:00
|
|
|
lock (m_bw)
|
2009-03-04 18:33:05 +00:00
|
|
|
{
|
2009-05-14 20:37:54 +00:00
|
|
|
// Write out header
|
|
|
|
m_bw.Write(header);
|
2017-01-05 19:07:37 +00:00
|
|
|
|
2009-05-14 20:37:54 +00:00
|
|
|
// Write out data
|
2010-03-31 18:51:17 +00:00
|
|
|
// An IOException occurs if we try to write out an empty array in Mono 2.6
|
|
|
|
if (data.Length > 0)
|
|
|
|
m_bw.Write(data);
|
2017-01-05 19:07:37 +00:00
|
|
|
|
2009-05-14 20:37:54 +00:00
|
|
|
if (data.Length % 512 != 0)
|
|
|
|
{
|
|
|
|
int paddingRequired = 512 - (data.Length % 512);
|
2017-01-05 19:07:37 +00:00
|
|
|
|
2009-05-14 20:37:54 +00:00
|
|
|
//m_log.DebugFormat("[TAR ARCHIVE WRITER]: Padding data with {0} bytes", paddingRequired);
|
2017-01-05 19:07:37 +00:00
|
|
|
|
2009-05-14 20:37:54 +00:00
|
|
|
byte[] padding = new byte[paddingRequired];
|
|
|
|
m_bw.Write(padding);
|
|
|
|
}
|
2009-03-12 06:03:59 +00:00
|
|
|
}
|
|
|
|
}
|
2008-05-27 22:49:34 +00:00
|
|
|
}
|
2008-05-28 16:37:43 +00:00
|
|
|
}
|