From f784620780e7364d10bb821719eb684eed3b4903 Mon Sep 17 00:00:00 2001
From: Mike Mazur
Date: Thu, 12 Mar 2009 06:03:59 +0000
Subject: Moving TarArchive to OpenSim.Framework.Archive
We now build OpenSim.Framework.Archive.dll which aims to contain code
used for archiving various things in OpenSim. Also remove trailing
whitespace.
---
OpenSim/Framework/Archive/TarArchiveReader.cs | 218 +++++++++++++++++++++
OpenSim/Framework/Archive/TarArchiveWriter.cs | 217 ++++++++++++++++++++
.../Plugins/InventoryArchivePlugin.cs | 2 +-
.../Archiver/InventoryArchiveReadRequest.cs | 1 +
.../Archiver/InventoryArchiveWriteRequest.cs | 1 +
.../Archiver/Tests/InventoryArchiverTests.cs | 3 +-
.../World/Archiver/ArchiveReadRequest.cs | 1 +
.../World/Archiver/ArchiveWriteRequestExecution.cs | 1 +
.../CoreModules/World/Archiver/AssetsArchiver.cs | 1 +
.../CoreModules/World/Archiver/TarArchiveReader.cs | 218 ---------------------
.../CoreModules/World/Archiver/TarArchiveWriter.cs | 217 --------------------
.../World/Archiver/Tests/ArchiverTests.cs | 3 +-
prebuild.xml | 26 ++-
13 files changed, 470 insertions(+), 439 deletions(-)
create mode 100644 OpenSim/Framework/Archive/TarArchiveReader.cs
create mode 100644 OpenSim/Framework/Archive/TarArchiveWriter.cs
delete mode 100644 OpenSim/Region/CoreModules/World/Archiver/TarArchiveReader.cs
delete mode 100644 OpenSim/Region/CoreModules/World/Archiver/TarArchiveWriter.cs
diff --git a/OpenSim/Framework/Archive/TarArchiveReader.cs b/OpenSim/Framework/Archive/TarArchiveReader.cs
new file mode 100644
index 0000000..eee65f5
--- /dev/null
+++ b/OpenSim/Framework/Archive/TarArchiveReader.cs
@@ -0,0 +1,218 @@
+/*
+ * 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.
+ * * Neither the name of the OpenSim Project nor the
+ * 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.
+ */
+
+using System;
+using System.IO;
+using System.Reflection;
+using System.Text;
+using log4net;
+
+namespace OpenSim.Framework.Archive
+{
+ ///
+ /// Temporary code to do the bare minimum required to read a tar archive for our purposes
+ ///
+ public class TarArchiveReader
+ {
+ //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+ public enum TarEntryType
+ {
+ TYPE_UNKNOWN = 0,
+ TYPE_NORMAL_FILE = 1,
+ TYPE_HARD_LINK = 2,
+ TYPE_SYMBOLIC_LINK = 3,
+ TYPE_CHAR_SPECIAL = 4,
+ TYPE_BLOCK_SPECIAL = 5,
+ TYPE_DIRECTORY = 6,
+ TYPE_FIFO = 7,
+ TYPE_CONTIGUOUS_FILE = 8,
+ }
+
+ protected static ASCIIEncoding m_asciiEncoding = new ASCIIEncoding();
+
+ ///
+ /// Binary reader for the underlying stream
+ ///
+ protected BinaryReader m_br;
+
+ ///
+ /// Used to trim off null chars
+ ///
+ protected char[] m_nullCharArray = new char[] { '\0' };
+
+ ///
+ /// Generate a tar reader which reads from the given stream.
+ ///
+ ///
+ public TarArchiveReader(Stream s)
+ {
+ m_br = new BinaryReader(s);
+ }
+
+ ///
+ /// Read the next entry in the tar file.
+ ///
+ ///
+ /// the data for the entry. Returns null if there are no more entries
+ public byte[] ReadEntry(out string filePath, out TarEntryType entryType)
+ {
+ filePath = String.Empty;
+ entryType = TarEntryType.TYPE_UNKNOWN;
+ TarHeader header = ReadHeader();
+
+ if (null == header)
+ return null;
+
+ entryType = header.EntryType;
+ filePath = header.FilePath;
+ return ReadData(header.FileSize);
+ }
+
+ ///
+ /// Read the next 512 byte chunk of data as a tar header.
+ ///
+ /// A tar header struct. null if we have reached the end of the archive.
+ protected TarHeader ReadHeader()
+ {
+ byte[] header = m_br.ReadBytes(512);
+
+ // If we've reached the end of the archive we'll be in null block territory, which means
+ // the next byte will be 0
+ if (header[0] == 0)
+ return null;
+
+ TarHeader tarHeader = new TarHeader();
+
+ // If we're looking at a GNU tar long link then extract the long name and pull up the next header
+ if (header[156] == (byte)'L')
+ {
+ int longNameLength = ConvertOctalBytesToDecimal(header, 124, 11);
+ tarHeader.FilePath = m_asciiEncoding.GetString(ReadData(longNameLength));
+ //m_log.DebugFormat("[TAR ARCHIVE READER]: Got long file name {0}", tarHeader.FilePath);
+ header = m_br.ReadBytes(512);
+ }
+ else
+ {
+ tarHeader.FilePath = m_asciiEncoding.GetString(header, 0, 100);
+ tarHeader.FilePath = tarHeader.FilePath.Trim(m_nullCharArray);
+ //m_log.DebugFormat("[TAR ARCHIVE READER]: Got short file name {0}", tarHeader.FilePath);
+ }
+
+ tarHeader.FileSize = ConvertOctalBytesToDecimal(header, 124, 11);
+
+ switch (header[156])
+ {
+ case 0:
+ tarHeader.EntryType = TarEntryType.TYPE_NORMAL_FILE;
+ break;
+ case (byte)'0':
+ tarHeader.EntryType = TarEntryType.TYPE_NORMAL_FILE;
+ break;
+ case (byte)'1':
+ tarHeader.EntryType = TarEntryType.TYPE_HARD_LINK;
+ break;
+ case (byte)'2':
+ tarHeader.EntryType = TarEntryType.TYPE_SYMBOLIC_LINK;
+ break;
+ case (byte)'3':
+ tarHeader.EntryType = TarEntryType.TYPE_CHAR_SPECIAL;
+ break;
+ case (byte)'4':
+ tarHeader.EntryType = TarEntryType.TYPE_BLOCK_SPECIAL;
+ break;
+ case (byte)'5':
+ tarHeader.EntryType = TarEntryType.TYPE_DIRECTORY;
+ break;
+ case (byte)'6':
+ tarHeader.EntryType = TarEntryType.TYPE_FIFO;
+ break;
+ case (byte)'7':
+ tarHeader.EntryType = TarEntryType.TYPE_CONTIGUOUS_FILE;
+ break;
+ }
+
+ return tarHeader;
+ }
+
+ ///
+ /// Read data following a header
+ ///
+ ///
+ ///
+ protected byte[] ReadData(int fileSize)
+ {
+ byte[] data = m_br.ReadBytes(fileSize);
+
+ //m_log.DebugFormat("[TAR ARCHIVE READER]: fileSize {0}", fileSize);
+
+ // Read the rest of the empty padding in the 512 byte block
+ if (fileSize % 512 != 0)
+ {
+ int paddingLeft = 512 - (fileSize % 512);
+
+ //m_log.DebugFormat("[TAR ARCHIVE READER]: Reading {0} padding bytes", paddingLeft);
+
+ m_br.ReadBytes(paddingLeft);
+ }
+
+ return data;
+ }
+
+ public void Close()
+ {
+ m_br.Close();
+ }
+
+ ///
+ /// Convert octal bytes to a decimal representation
+ ///
+ ///
+ ///
+ public static int ConvertOctalBytesToDecimal(byte[] bytes, int startIndex, int count)
+ {
+ string oString = m_asciiEncoding.GetString(bytes, startIndex, count);
+
+ int d = 0;
+
+ foreach (char c in oString)
+ {
+ d <<= 3;
+ d |= c - '0';
+ }
+
+ return d;
+ }
+ }
+
+ public class TarHeader
+ {
+ public string FilePath;
+ public int FileSize;
+ public TarArchiveReader.TarEntryType EntryType;
+ }
+}
diff --git a/OpenSim/Framework/Archive/TarArchiveWriter.cs b/OpenSim/Framework/Archive/TarArchiveWriter.cs
new file mode 100644
index 0000000..59198b8
--- /dev/null
+++ b/OpenSim/Framework/Archive/TarArchiveWriter.cs
@@ -0,0 +1,217 @@
+/*
+ * 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.
+ * * Neither the name of the OpenSim Project nor the
+ * 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.
+ */
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Text;
+
+namespace OpenSim.Framework.Archive
+{
+ ///
+ /// Temporary code to produce a tar archive in tar v7 format
+ ///
+ public class TarArchiveWriter
+ {
+ //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
+
+ protected static ASCIIEncoding m_asciiEncoding = new ASCIIEncoding();
+
+ ///
+ /// Binary writer for the underlying stream
+ ///
+ protected BinaryWriter m_bw;
+
+ public TarArchiveWriter(Stream s)
+ {
+ m_bw = new BinaryWriter(s);
+ }
+
+ ///
+ /// Write a directory entry to the tar archive. We can only handle one path level right now!
+ ///
+ ///
+ public void WriteDir(string dirName)
+ {
+ // Directories are signalled by a final /
+ if (!dirName.EndsWith("/"))
+ dirName += "/";
+
+ WriteFile(dirName, new byte[0]);
+ }
+
+ ///
+ /// Write a file to the tar archive
+ ///
+ ///
+ ///
+ public void WriteFile(string filePath, string data)
+ {
+ WriteFile(filePath, m_asciiEncoding.GetBytes(data));
+ }
+
+ ///
+ /// Write a file to the tar archive
+ ///
+ ///
+ ///
+ public void WriteFile(string filePath, byte[] data)
+ {
+ if (filePath.Length > 100)
+ WriteEntry("././@LongLink", m_asciiEncoding.GetBytes(filePath), 'L');
+
+ char fileType;
+
+ if (filePath.EndsWith("/"))
+ {
+ fileType = '5';
+ }
+ else
+ {
+ fileType = '0';
+ }
+
+ WriteEntry(filePath, data, fileType);
+ }
+
+ ///
+ /// Finish writing the raw tar archive data to a stream. The stream will be closed on completion.
+ ///
+ /// Stream to which to write the data
+ ///
+ public void Close()
+ {
+ //m_log.Debug("[TAR ARCHIVE WRITER]: Writing final consecutive 0 blocks");
+
+ // Write two consecutive 0 blocks to end the archive
+ byte[] finalZeroPadding = new byte[1024];
+ m_bw.Write(finalZeroPadding);
+
+ m_bw.Flush();
+ m_bw.Close();
+ }
+
+ public static byte[] ConvertDecimalToPaddedOctalBytes(int d, int padding)
+ {
+ string oString = "";
+
+ while (d > 0)
+ {
+ oString = Convert.ToString((byte)'0' + d & 7) + oString;
+ d >>= 3;
+ }
+
+ while (oString.Length < padding)
+ {
+ oString = "0" + oString;
+ }
+
+ byte[] oBytes = m_asciiEncoding.GetBytes(oString);
+
+ return oBytes;
+ }
+
+ ///
+ /// Write a particular entry
+ ///
+ ///
+ ///
+ ///
+ protected void WriteEntry(string filePath, byte[] data, char fileType)
+ {
+ byte[] header = new byte[512];
+
+ // file path field (100)
+ byte[] nameBytes = m_asciiEncoding.GetBytes(filePath);
+ int nameSize = (nameBytes.Length >= 100) ? 100 : nameBytes.Length;
+ Array.Copy(nameBytes, header, nameSize);
+
+ // file mode (8)
+ byte[] modeBytes = m_asciiEncoding.GetBytes("0000777");
+ Array.Copy(modeBytes, 0, header, 100, 7);
+
+ // owner user id (8)
+ byte[] ownerIdBytes = m_asciiEncoding.GetBytes("0000764");
+ Array.Copy(ownerIdBytes, 0, header, 108, 7);
+
+ // group user id (8)
+ byte[] groupIdBytes = m_asciiEncoding.GetBytes("0000764");
+ 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)
+ byte[] lastModTimeBytes = m_asciiEncoding.GetBytes("11017037332");
+ Array.Copy(lastModTimeBytes, 0, header, 136, 11);
+
+ // entry type indicator (1)
+ header[156] = m_asciiEncoding.GetBytes(new char[] { fileType })[0];
+
+ Array.Copy(m_asciiEncoding.GetBytes("0000000"), 0, header, 329, 7);
+ Array.Copy(m_asciiEncoding.GetBytes("0000000"), 0, header, 337, 7);
+
+ // check sum for header block (8) [calculated last]
+ Array.Copy(m_asciiEncoding.GetBytes(" "), 0, header, 148, 8);
+
+ 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;
+
+ // Write out header
+ m_bw.Write(header);
+
+ // Write out data
+ m_bw.Write(data);
+
+ if (data.Length % 512 != 0)
+ {
+ int paddingRequired = 512 - (data.Length % 512);
+
+ //m_log.DebugFormat("[TAR ARCHIVE WRITER]: Padding data with {0} bytes", paddingRequired);
+
+ byte[] padding = new byte[paddingRequired];
+ m_bw.Write(padding);
+ }
+ }
+ }
+}
diff --git a/OpenSim/Grid/AssetInventoryServer/Plugins/InventoryArchivePlugin.cs b/OpenSim/Grid/AssetInventoryServer/Plugins/InventoryArchivePlugin.cs
index 8d60aa6..ceded03 100644
--- a/OpenSim/Grid/AssetInventoryServer/Plugins/InventoryArchivePlugin.cs
+++ b/OpenSim/Grid/AssetInventoryServer/Plugins/InventoryArchivePlugin.cs
@@ -33,8 +33,8 @@ using System.Xml;
using System.Reflection;
using OpenMetaverse;
using OpenSim.Framework;
+using OpenSim.Framework.Archive;
using OpenSim.Framework.Servers;
-using OpenSim.Region.CoreModules.World.Archiver;
using OpenSim.Region.CoreModules.Avatar.Inventory.Archiver;
using log4net;
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
index 4a681bc..5de8adc 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveReadRequest.cs
@@ -35,6 +35,7 @@ using System.Xml;
using log4net;
using OpenMetaverse;
using OpenSim.Framework;
+using OpenSim.Framework.Archive;
using OpenSim.Framework.Communications;
using OpenSim.Framework.Communications.Cache;
using OpenSim.Region.CoreModules.World.Archiver;
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
index b0f2742..71c4740 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/InventoryArchiveWriteRequest.cs
@@ -34,6 +34,7 @@ using System.Xml;
using log4net;
using OpenMetaverse;
using OpenSim.Framework;
+using OpenSim.Framework.Archive;
using OpenSim.Framework.Communications;
using OpenSim.Framework.Communications.Cache;
using OpenSim.Region.CoreModules.World.Archiver;
diff --git a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
index 5cc0340..ef7f93f 100644
--- a/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
+++ b/OpenSim/Region/CoreModules/Avatar/Inventory/Archiver/Tests/InventoryArchiverTests.cs
@@ -34,6 +34,7 @@ using NUnit.Framework.SyntaxHelpers;
using OpenMetaverse;
using OpenSim.Data;
using OpenSim.Framework;
+using OpenSim.Framework.Archive;
using OpenSim.Framework.Communications;
using OpenSim.Framework.Communications.Cache;
using OpenSim.Region.CoreModules.Avatar.Inventory.Archiver;
@@ -182,4 +183,4 @@ namespace OpenSim.Region.CoreModules.Avatar.Inventory.Archiver.Tests
// TODO: Test presence of more files and contents of files.
}
}
-}
\ No newline at end of file
+}
diff --git a/OpenSim/Region/CoreModules/World/Archiver/ArchiveReadRequest.cs b/OpenSim/Region/CoreModules/World/Archiver/ArchiveReadRequest.cs
index 3525e04..69766d4 100644
--- a/OpenSim/Region/CoreModules/World/Archiver/ArchiveReadRequest.cs
+++ b/OpenSim/Region/CoreModules/World/Archiver/ArchiveReadRequest.cs
@@ -35,6 +35,7 @@ using System.Text;
using log4net;
using OpenMetaverse;
using OpenSim.Framework;
+using OpenSim.Framework.Archive;
using OpenSim.Framework.Communications.Cache;
using OpenSim.Region.CoreModules.World.Terrain;
using OpenSim.Region.Framework.Interfaces;
diff --git a/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestExecution.cs b/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestExecution.cs
index cc4eadb..34332f8 100644
--- a/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestExecution.cs
+++ b/OpenSim/Region/CoreModules/World/Archiver/ArchiveWriteRequestExecution.cs
@@ -33,6 +33,7 @@ using System.Xml;
using log4net;
using OpenMetaverse;
using OpenSim.Framework;
+using OpenSim.Framework.Archive;
using OpenSim.Region.CoreModules.World.Terrain;
using OpenSim.Region.Framework.Interfaces;
using OpenSim.Region.Framework.Scenes;
diff --git a/OpenSim/Region/CoreModules/World/Archiver/AssetsArchiver.cs b/OpenSim/Region/CoreModules/World/Archiver/AssetsArchiver.cs
index 8debfcf..fb78af9 100644
--- a/OpenSim/Region/CoreModules/World/Archiver/AssetsArchiver.cs
+++ b/OpenSim/Region/CoreModules/World/Archiver/AssetsArchiver.cs
@@ -32,6 +32,7 @@ using System.Xml;
using log4net;
using OpenMetaverse;
using OpenSim.Framework;
+using OpenSim.Framework.Archive;
namespace OpenSim.Region.CoreModules.World.Archiver
{
diff --git a/OpenSim/Region/CoreModules/World/Archiver/TarArchiveReader.cs b/OpenSim/Region/CoreModules/World/Archiver/TarArchiveReader.cs
deleted file mode 100644
index 070f597..0000000
--- a/OpenSim/Region/CoreModules/World/Archiver/TarArchiveReader.cs
+++ /dev/null
@@ -1,218 +0,0 @@
-/*
- * 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.
- * * Neither the name of the OpenSim Project nor the
- * 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.
- */
-
-using System;
-using System.IO;
-using System.Reflection;
-using System.Text;
-using log4net;
-
-namespace OpenSim.Region.CoreModules.World.Archiver
-{
- ///
- /// Temporary code to do the bare minimum required to read a tar archive for our purposes
- ///
- public class TarArchiveReader
- {
- //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
-
- public enum TarEntryType
- {
- TYPE_UNKNOWN = 0,
- TYPE_NORMAL_FILE = 1,
- TYPE_HARD_LINK = 2,
- TYPE_SYMBOLIC_LINK = 3,
- TYPE_CHAR_SPECIAL = 4,
- TYPE_BLOCK_SPECIAL = 5,
- TYPE_DIRECTORY = 6,
- TYPE_FIFO = 7,
- TYPE_CONTIGUOUS_FILE = 8,
- }
-
- protected static ASCIIEncoding m_asciiEncoding = new ASCIIEncoding();
-
- ///
- /// Binary reader for the underlying stream
- ///
- protected BinaryReader m_br;
-
- ///
- /// Used to trim off null chars
- ///
- protected char[] m_nullCharArray = new char[] { '\0' };
-
- ///
- /// Generate a tar reader which reads from the given stream.
- ///
- ///
- public TarArchiveReader(Stream s)
- {
- m_br = new BinaryReader(s);
- }
-
- ///
- /// Read the next entry in the tar file.
- ///
- ///
- /// the data for the entry. Returns null if there are no more entries
- public byte[] ReadEntry(out string filePath, out TarEntryType entryType)
- {
- filePath = String.Empty;
- entryType = TarEntryType.TYPE_UNKNOWN;
- TarHeader header = ReadHeader();
-
- if (null == header)
- return null;
-
- entryType = header.EntryType;
- filePath = header.FilePath;
- return ReadData(header.FileSize);
- }
-
- ///
- /// Read the next 512 byte chunk of data as a tar header.
- ///
- /// A tar header struct. null if we have reached the end of the archive.
- protected TarHeader ReadHeader()
- {
- byte[] header = m_br.ReadBytes(512);
-
- // If we've reached the end of the archive we'll be in null block territory, which means
- // the next byte will be 0
- if (header[0] == 0)
- return null;
-
- TarHeader tarHeader = new TarHeader();
-
- // If we're looking at a GNU tar long link then extract the long name and pull up the next header
- if (header[156] == (byte)'L')
- {
- int longNameLength = ConvertOctalBytesToDecimal(header, 124, 11);
- tarHeader.FilePath = m_asciiEncoding.GetString(ReadData(longNameLength));
- //m_log.DebugFormat("[TAR ARCHIVE READER]: Got long file name {0}", tarHeader.FilePath);
- header = m_br.ReadBytes(512);
- }
- else
- {
- tarHeader.FilePath = m_asciiEncoding.GetString(header, 0, 100);
- tarHeader.FilePath = tarHeader.FilePath.Trim(m_nullCharArray);
- //m_log.DebugFormat("[TAR ARCHIVE READER]: Got short file name {0}", tarHeader.FilePath);
- }
-
- tarHeader.FileSize = ConvertOctalBytesToDecimal(header, 124, 11);
-
- switch (header[156])
- {
- case 0:
- tarHeader.EntryType = TarEntryType.TYPE_NORMAL_FILE;
- break;
- case (byte)'0':
- tarHeader.EntryType = TarEntryType.TYPE_NORMAL_FILE;
- break;
- case (byte)'1':
- tarHeader.EntryType = TarEntryType.TYPE_HARD_LINK;
- break;
- case (byte)'2':
- tarHeader.EntryType = TarEntryType.TYPE_SYMBOLIC_LINK;
- break;
- case (byte)'3':
- tarHeader.EntryType = TarEntryType.TYPE_CHAR_SPECIAL;
- break;
- case (byte)'4':
- tarHeader.EntryType = TarEntryType.TYPE_BLOCK_SPECIAL;
- break;
- case (byte)'5':
- tarHeader.EntryType = TarEntryType.TYPE_DIRECTORY;
- break;
- case (byte)'6':
- tarHeader.EntryType = TarEntryType.TYPE_FIFO;
- break;
- case (byte)'7':
- tarHeader.EntryType = TarEntryType.TYPE_CONTIGUOUS_FILE;
- break;
- }
-
- return tarHeader;
- }
-
- ///
- /// Read data following a header
- ///
- ///
- ///
- protected byte[] ReadData(int fileSize)
- {
- byte[] data = m_br.ReadBytes(fileSize);
-
- //m_log.DebugFormat("[TAR ARCHIVE READER]: fileSize {0}", fileSize);
-
- // Read the rest of the empty padding in the 512 byte block
- if (fileSize % 512 != 0)
- {
- int paddingLeft = 512 - (fileSize % 512);
-
- //m_log.DebugFormat("[TAR ARCHIVE READER]: Reading {0} padding bytes", paddingLeft);
-
- m_br.ReadBytes(paddingLeft);
- }
-
- return data;
- }
-
- public void Close()
- {
- m_br.Close();
- }
-
- ///
- /// Convert octal bytes to a decimal representation
- ///
- ///
- ///
- public static int ConvertOctalBytesToDecimal(byte[] bytes, int startIndex, int count)
- {
- string oString = m_asciiEncoding.GetString(bytes, startIndex, count);
-
- int d = 0;
-
- foreach (char c in oString)
- {
- d <<= 3;
- d |= c - '0';
- }
-
- return d;
- }
- }
-
- public class TarHeader
- {
- public string FilePath;
- public int FileSize;
- public TarArchiveReader.TarEntryType EntryType;
- }
-}
diff --git a/OpenSim/Region/CoreModules/World/Archiver/TarArchiveWriter.cs b/OpenSim/Region/CoreModules/World/Archiver/TarArchiveWriter.cs
deleted file mode 100644
index 506fcc5..0000000
--- a/OpenSim/Region/CoreModules/World/Archiver/TarArchiveWriter.cs
+++ /dev/null
@@ -1,217 +0,0 @@
-/*
- * 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.
- * * Neither the name of the OpenSim Project nor the
- * 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.
- */
-
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Text;
-
-namespace OpenSim.Region.CoreModules.World.Archiver
-{
- ///
- /// Temporary code to produce a tar archive in tar v7 format
- ///
- public class TarArchiveWriter
- {
- //private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
-
- protected static ASCIIEncoding m_asciiEncoding = new ASCIIEncoding();
-
- ///
- /// Binary writer for the underlying stream
- ///
- protected BinaryWriter m_bw;
-
- public TarArchiveWriter(Stream s)
- {
- m_bw = new BinaryWriter(s);
- }
-
- ///
- /// Write a directory entry to the tar archive. We can only handle one path level right now!
- ///
- ///
- public void WriteDir(string dirName)
- {
- // Directories are signalled by a final /
- if (!dirName.EndsWith("/"))
- dirName += "/";
-
- WriteFile(dirName, new byte[0]);
- }
-
- ///
- /// Write a file to the tar archive
- ///
- ///
- ///
- public void WriteFile(string filePath, string data)
- {
- WriteFile(filePath, m_asciiEncoding.GetBytes(data));
- }
-
- ///
- /// Write a file to the tar archive
- ///
- ///
- ///
- public void WriteFile(string filePath, byte[] data)
- {
- if (filePath.Length > 100)
- WriteEntry("././@LongLink", m_asciiEncoding.GetBytes(filePath), 'L');
-
- char fileType;
-
- if (filePath.EndsWith("/"))
- {
- fileType = '5';
- }
- else
- {
- fileType = '0';
- }
-
- WriteEntry(filePath, data, fileType);
- }
-
- ///
- /// Finish writing the raw tar archive data to a stream. The stream will be closed on completion.
- ///
- /// Stream to which to write the data
- ///
- public void Close()
- {
- //m_log.Debug("[TAR ARCHIVE WRITER]: Writing final consecutive 0 blocks");
-
- // Write two consecutive 0 blocks to end the archive
- byte[] finalZeroPadding = new byte[1024];
- m_bw.Write(finalZeroPadding);
-
- m_bw.Flush();
- m_bw.Close();
- }
-
- public static byte[] ConvertDecimalToPaddedOctalBytes(int d, int padding)
- {
- string oString = "";
-
- while (d > 0)
- {
- oString = Convert.ToString((byte)'0' + d & 7) + oString;
- d >>= 3;
- }
-
- while (oString.Length < padding)
- {
- oString = "0" + oString;
- }
-
- byte[] oBytes = m_asciiEncoding.GetBytes(oString);
-
- return oBytes;
- }
-
- ///
- /// Write a particular entry
- ///
- ///
- ///
- ///
- protected void WriteEntry(string filePath, byte[] data, char fileType)
- {
- byte[] header = new byte[512];
-
- // file path field (100)
- byte[] nameBytes = m_asciiEncoding.GetBytes(filePath);
- int nameSize = (nameBytes.Length >= 100) ? 100 : nameBytes.Length;
- Array.Copy(nameBytes, header, nameSize);
-
- // file mode (8)
- byte[] modeBytes = m_asciiEncoding.GetBytes("0000777");
- Array.Copy(modeBytes, 0, header, 100, 7);
-
- // owner user id (8)
- byte[] ownerIdBytes = m_asciiEncoding.GetBytes("0000764");
- Array.Copy(ownerIdBytes, 0, header, 108, 7);
-
- // group user id (8)
- byte[] groupIdBytes = m_asciiEncoding.GetBytes("0000764");
- 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)
- byte[] lastModTimeBytes = m_asciiEncoding.GetBytes("11017037332");
- Array.Copy(lastModTimeBytes, 0, header, 136, 11);
-
- // entry type indicator (1)
- header[156] = m_asciiEncoding.GetBytes(new char[] { fileType })[0];
-
- Array.Copy(m_asciiEncoding.GetBytes("0000000"), 0, header, 329, 7);
- Array.Copy(m_asciiEncoding.GetBytes("0000000"), 0, header, 337, 7);
-
- // check sum for header block (8) [calculated last]
- Array.Copy(m_asciiEncoding.GetBytes(" "), 0, header, 148, 8);
-
- 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;
-
- // Write out header
- m_bw.Write(header);
-
- // Write out data
- m_bw.Write(data);
-
- if (data.Length % 512 != 0)
- {
- int paddingRequired = 512 - (data.Length % 512);
-
- //m_log.DebugFormat("[TAR ARCHIVE WRITER]: Padding data with {0} bytes", paddingRequired);
-
- byte[] padding = new byte[paddingRequired];
- m_bw.Write(padding);
- }
- }
- }
-}
diff --git a/OpenSim/Region/CoreModules/World/Archiver/Tests/ArchiverTests.cs b/OpenSim/Region/CoreModules/World/Archiver/Tests/ArchiverTests.cs
index ba5fa31..b5a2d13 100644
--- a/OpenSim/Region/CoreModules/World/Archiver/Tests/ArchiverTests.cs
+++ b/OpenSim/Region/CoreModules/World/Archiver/Tests/ArchiverTests.cs
@@ -33,6 +33,7 @@ using NUnit.Framework;
using NUnit.Framework.SyntaxHelpers;
using OpenMetaverse;
using OpenSim.Framework;
+using OpenSim.Framework.Archive;
using OpenSim.Region.CoreModules.World.Serialiser;
using OpenSim.Region.CoreModules.World.Terrain;
using OpenSim.Region.Framework.Scenes;
@@ -303,4 +304,4 @@ namespace OpenSim.Region.CoreModules.World.Archiver.Tests
}
}
}
-}
\ No newline at end of file
+}
diff --git a/prebuild.xml b/prebuild.xml
index 9b1b6c4..f52de6d 100644
--- a/prebuild.xml
+++ b/prebuild.xml
@@ -105,6 +105,27 @@
+
+
+
+ ../../../bin/
+
+
+
+
+ ../../../bin/
+
+
+
+ ../../../bin/
+
+
+
+
+
+
+
+
@@ -1098,6 +1119,7 @@
+
@@ -1138,11 +1160,12 @@
+
-
+
@@ -2951,6 +2974,7 @@
+
--
cgit v1.1