Files
libremetaverse/libsecondlife-cs/Packet.cs
John Hurliman f08e7191dc NetworkManager:
* OnSimDisconnected and OnDisconnected events added
* The Disconnect function is working
* Shutdown() was added to kill the network layer
* Added documentation for the Packet class
* Added a TickCount to Packet for tracking ACK timeouts
* Added a LastReceivedTime to Simulator for tracking disconnects
* Optimized the NeedAck hashtable
* Fixed a potential deadlock during Logout and removed a dodgy goto statement
* Removed the try/catch from Logout to catch bugs
* Added a not-logged-in catch in Logout
* Removed the 1-second sleep from Logout
* Connect returns the connected Simulator object or null now

ObjectManager:
* OnAvatarMoved and OnPrimMoved events are fired now

Prims:
* Minor function clarifications

Avatar:
* Uses the new Connect function for teleporting

Packet:
* Added documentation
* HeaderLength is private now
* Removed the Field() function
* Miscellaneous cleanups

git-svn-id: http://libopenmetaverse.googlecode.com/svn/trunk@195 52acb1d6-8a22-11de-b505-999d5b087335
2006-09-17 03:03:31 +00:00

850 lines
26 KiB
C#

/*
* Copyright (c) 2006, Second Life Reverse Engineering Team
* All rights reserved.
*
* - 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.
* - Neither the name of the Second Life Reverse Engineering Team 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR 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.Net;
using System.Collections;
namespace libsecondlife
{
public struct Field
{
public object Data;
public MapField Layout;
public override string ToString()
{
string output = "";
if (Layout.Type == FieldType.Variable || Layout.Type == FieldType.Fixed)
{
bool printable = true;
byte[] byteArray = (byte[])Data;
for (int i = 0; i < byteArray.Length; ++i)
{
// Check if there are any unprintable characters in the array
if ((byteArray[i] < 0x20 || byteArray[i] > 0x7E) && byteArray[i] != 0x09
&& byteArray[i] != 0x0D)
{
printable = false;
}
}
if (printable)
{
output = Helpers.FieldToString(byteArray);
}
else
{
for (int i = 0; i < byteArray.Length; i += 16)
{
output += Layout.Name + ": ";
for (int j = 0; j < 16; j++)
{
if ((i + j) < byteArray.Length)
{
output += String.Format("{0:X2} ", byteArray[i + j]);
}
else
{
output += " ";
}
}
for (int j = 0; j < 16 && (i + j) < byteArray.Length; j++)
{
if (byteArray[i + j] >= 0x20 && byteArray[i + j] < 0x7E)
{
output += (char)byteArray[i + j];
}
else
{
output += ".";
}
}
output += "\n";
}
}
}
else
{
output += Layout.Name + ": " + Data.ToString();
}
return output;
}
}
public struct Block
{
public ArrayList Fields;
public MapBlock Layout;
}
/// <summary>
/// The Packet class is a wrapper around a raw UDP payload of a Second Life
/// message. It is used for both constructing outgoing packets and
/// interpreting incoming packets.
/// </summary>
public class Packet
{
/// <summary>
/// This is the complete, raw UDP payload of an incoming or outgoing
/// packet.
/// </summary>
public byte[] Data;
/// <summary>
/// The packet layout is built from the Second Life message template
/// and describes all the blocks and fields of this packet. It is
/// used to serialize and unserialize the packet data.
/// </summary>
public MapPacket Layout;
/// <summary>
/// Every Second Life message sent has an incremental sequence number
/// that is used for tracking reliable packets and measuring packet
/// loss. For outgoing packets the sequence number will be
/// automatically set by the network layer as the packet is sent out.
/// </summary>
public ushort Sequence
{
get
{
// The sequence number is the third and fourth bytes of the packet, stored
// in network order
return (ushort)(Data[2] * 256 + Data[3]);
}
set
{
Data[2] = (byte)(value / 256);
Data[3] = (byte)(value % 256);
}
}
/// <summary>
/// The TickCount is used for internally tracking packet timeouts,
/// please do not use this member.
/// </summary>
public int TickCount;
private ProtocolManager Protocol;
/// <summary>
/// Constructor used for building a packet where the length of the data
/// is known in advance. This is being phased out in favor of
/// pre-assembling the data or using PacketBuilder.BuildPacket().
/// </summary>
/// <param name="command">The name of the command in the message template</param>
/// <param name="protocol">A reference to the ProtocolManager instance</param>
/// <param name="length">The length of the packet data</param>
public Packet(string command, ProtocolManager protocol, int length)
{
Protocol = protocol;
Data = new byte[length];
Layout = protocol.Command(command);
if (Layout == null)
{
Console.WriteLine("Attempting to build a packet with invalid command \"" + command + "\"");
// Create an empty Layout
Layout = new MapPacket();
Layout.Blocks = new ArrayList();
return;
}
switch (Layout.Frequency)
{
case PacketFrequency.Low:
// Set the low frequency identifier bits
byte[] lowHeader = {0x00, 0x00, 0x00, 0x00, 0xFF, 0xFF};
Array.Copy(lowHeader, 0, Data, 0, 6);
// Store the packet ID in network order
Data[6] = (byte)(Layout.ID / 256);
Data[7] = (byte)(Layout.ID % 256);
break;
case PacketFrequency.Medium:
// Set the medium frequency identifier bits
byte[] mediumHeader = {0x00, 0x00, 0x00, 0x00, 0xFF};
Array.Copy(mediumHeader, 0, Data, 0, 5);
Data[5] = (byte)Layout.ID;
break;
case PacketFrequency.High:
// Set the high frequency identifier bits
byte[] highHeader = {0x00, 0x00, 0x00, 0x00};
Array.Copy(highHeader, 0, Data, 0, 4);
Data[4] = (byte)Layout.ID;
break;
}
}
/// <summary>
/// Constructor used to build a Packet object from incoming data.
/// </summary>
/// <param name="data">Byte array containing the full UDP payload</param>
/// <param name="length">Length of the actual data in the byte array</param>
/// <param name="protocol">A reference to the ProtocolManager instance</param>
public Packet(byte[] data, int length, ProtocolManager protocol)
: this(data, length, protocol, protocol.Command(data), true)
{
}
/// <summary>
/// This is a special constructor created specifically for optimizing
/// SLProxy, do not use it under any circumstances.
/// </summary>
/// <param name="data"></param>
/// <param name="length"></param>
/// <param name="protocol"></param>
/// <param name="layout"></param>
/// <param name="copy"></param>
public Packet(byte[] data, int length, ProtocolManager protocol, MapPacket layout, bool copy)
{
Protocol = protocol;
Layout = layout;
if (Layout == null)
{
// Create an empty MapPacket
Layout = new MapPacket();
Layout.Blocks = new ArrayList();
}
if (copy) {
// Copy the network byte array to this packet's byte array
Data = new byte[length];
Array.Copy(data, 0, Data, 0, length);
}
else
{
// Use the buffer we got for Data
Data = data;
}
}
/// <summary>
/// Unserializes packet data in to higher level representations
/// and native C# data types.
/// </summary>
/// <returns>An ArrayList of all the Block objects in this packet,
/// each of which contain Field objects for each data field.</returns>
public ArrayList Blocks()
{
Field field;
Block block;
byte blockCount;
int fieldSize;
// Get the starting position of the SL payload (different than the UDP payload)
int pos = HeaderLength();
// Initialize the block list we are returning
ArrayList blocks = new ArrayList();
// Get the packet body's length so we can do bounds checking
int length = Data.Length;
if ((Data[0] & Helpers.MSG_APPENDED_ACKS) != 0)
length -= Data[Data.Length - 1] * 4 + 1;
foreach (MapBlock blockMap in Layout.Blocks)
{
if (blockMap.Count == -1)
{
// Variable count block
if (pos < length)
{
blockCount = Data[pos];
pos++;
}
else
{
// FIXME: Figure out a sane way to log from this function
Console.WriteLine("WARNING: Blocks(): end of packet in 1-byte variable block count for " +
Layout.Name + "." + blockMap.Name + " (" + pos + "/" + length + ")");
goto Done;
}
}
else
{
blockCount = (byte)blockMap.Count;
}
for (int i = 0; i < blockCount; ++i)
{
// Create a new block to push back on the list
block = new Block();
block.Layout = blockMap;
block.Fields = new ArrayList();
foreach (MapField fieldMap in blockMap.Fields)
{
if (fieldMap.Type == FieldType.Variable)
{
if (fieldMap.Count == 1)
{
// Field length described with one byte
if (pos < length)
{
fieldSize = (ushort)Data[pos];
pos++;
}
else
{
Console.WriteLine("WARNING: Blocks(): end of packet in 1-byte variable field count for " +
Layout.Name + "." + blockMap.Name + "." + fieldMap.Name + " (" + pos + "/" + length + ")");
goto BlockDone;
}
}
else // (fieldMap.Count == 2)
{
// Field length described with two bytes
if (pos + 1 < length)
{
fieldSize = (ushort)(Data[pos] + Data[pos + 1] * 256);
pos += 2;
}
else
{
Console.WriteLine("WARNING: Blocks(): end of packet in 2-byte variable field count for " +
Layout.Name + "." + blockMap.Name + "." + fieldMap.Name + " (" + pos + "/" + length + ")");
goto BlockDone;
}
}
if (fieldSize != 0)
{
if (pos + fieldSize <= length)
{
// Create a new field to add to the fields for this block
field = new Field();
field.Data = GetField(pos, fieldMap.Type, fieldSize);
field.Layout = fieldMap;
block.Fields.Add(field);
pos += fieldSize;
}
else
{
Console.WriteLine("WARNING: Blocks(): end of packet in " + fieldSize +
"-byte variable field " + Layout.Name + "." + blockMap.Name + "." + fieldMap.Name +
" (" + pos + "/" + length + ")");
goto BlockDone;
}
}
else
{
// Create a zero-length byte-array for this field
field = new Field();
field.Data = new byte[0];
field.Layout = fieldMap;
block.Fields.Add(field);
}
}
else if (fieldMap.Type == FieldType.Fixed)
{
fieldSize = fieldMap.Count;
if (pos + fieldSize <= length)
{
// Create a new field to add to the fields for this block
field = new Field();
field.Data = GetField(pos, fieldMap.Type, fieldSize);
field.Layout = fieldMap;
block.Fields.Add(field);
pos += fieldSize;
}
else
{
Console.WriteLine("WARNING: Blocks(): end of packet in " + fieldSize + "-byte fixed field " +
Layout.Name + "." + blockMap.Name + "." + fieldMap.Name + " (" + pos + "/" + length + ")");
goto BlockDone;
}
}
else
{
for (int j = 0; j < fieldMap.Count; ++j)
{
fieldSize = (int)Protocol.TypeSizes[fieldMap.Type];
if (pos + fieldSize <= length)
{
// Create a new field to add to the fields for this block
field = new Field();
field.Data = GetField(pos, fieldMap.Type, fieldSize);
field.Layout = fieldMap;
block.Fields.Add(field);
pos += fieldSize;
}
else
{
Console.WriteLine("WARNING: Blocks(): end of packet in " + fieldSize + "-byte " +
fieldMap.Type + " field " + Layout.Name + "." + blockMap.Name + "." + fieldMap.Name +
" (" + pos + "/" + length + ")");
goto BlockDone;
}
}
}
}
BlockDone:
blocks.Add(block);
}
}
Done:
return blocks;
}
public override string ToString()
{
string output = "";
ArrayList blocks = Blocks();
output += "---- " + Layout.Name + " ----\n";
foreach (Block block in blocks)
{
output += "-- " + block.Layout.Name + " --\n";
foreach (Field field in block.Fields)
{
output += field.ToString() + "\n";
}
}
return output;
}
private int HeaderLength()
{
switch (Layout.Frequency)
{
case PacketFrequency.High:
return 5;
case PacketFrequency.Medium:
return 6;
case PacketFrequency.Low:
return 8;
}
return 0;
}
private object GetField(int pos, FieldType type, int fieldSize)
{
switch (type)
{
case FieldType.U8:
return Data[pos];
case FieldType.U16:
return (ushort)(Data[pos] + (Data[pos + 1] << 8));
case FieldType.IPPORT:
return (ushort)((Data[pos] << 8) + Data[pos + 1]);
case FieldType.U32:
return (uint)(Data[pos] + (Data[pos + 1] << 8) +
(Data[pos + 2] << 16) + (Data[pos + 3] << 24));
case FieldType.U64:
return new U64(Data, pos);
case FieldType.S8:
return (sbyte)Data[pos];
case FieldType.S16:
return (short)(Data[pos] + (Data[pos + 1] << 8));
case FieldType.S32:
return Data[pos] + (Data[pos + 1] << 8) +
(Data[pos + 2] << 16) + (Data[pos + 3] << 24);
case FieldType.S64:
return (long)(Data[pos] + (Data[pos + 1] << 8) +
(Data[pos + 2] << 16) + (Data[pos + 3] << 24) +
(Data[pos + 4] << 32) + (Data[pos + 5] << 40) +
(Data[pos + 6] << 48) + (Data[pos + 7] << 56));
case FieldType.F32:
return BitConverter.ToSingle(Data, pos);
case FieldType.F64:
return BitConverter.ToDouble(Data, pos);
case FieldType.LLUUID:
return new LLUUID(Data, pos);
case FieldType.BOOL:
return (Data[pos] != 0) ? (bool)true : (bool)false;
case FieldType.LLVector3:
return new LLVector3(Data, pos);
case FieldType.LLVector3d:
return new LLVector3d(Data, pos);
case FieldType.LLVector4:
return new LLVector4(Data, pos);
case FieldType.LLQuaternion:
return new LLQuaternion(Data, pos);
case FieldType.IPADDR:
uint address = (uint)(Data[pos] + (Data[pos + 1] << 8) +
(Data[pos + 2] << 16) + (Data[pos + 3] << 24));
return new IPAddress(address);
case FieldType.Variable:
case FieldType.Fixed:
byte[] bytes = new byte[fieldSize];
Array.Copy(Data, pos, bytes, 0, fieldSize);
return bytes;
}
return null;
}
}
public class PacketBuilder
{
public static Packet BuildPacket(string name, ProtocolManager protocol, Hashtable blocks, byte flags)
{
Hashtable fields;
ArrayList payload = new ArrayList();
byte[] byteArray = new byte[4096];
int length = 0;
int blockCount = 0;
int fieldLength = 0;
IDictionaryEnumerator blocksEnum;
MapPacket packetMap = protocol.Command(name);
// Build the header
#region Header
switch (packetMap.Frequency)
{
case PacketFrequency.High:
byteArray[4] = (byte)packetMap.ID;
length = 5;
break;
case PacketFrequency.Medium:
byteArray[4] = 0xFF;
byteArray[5] = (byte)packetMap.ID;
length = 6;
break;
case PacketFrequency.Low:
byteArray[4] = 0xFF;
byteArray[5] = 0xFF;
byteArray[6] = (byte)(packetMap.ID / 256);
byteArray[7] = (byte)(packetMap.ID % 256);
length = 8;
break;
}
#endregion Header
foreach (MapBlock blockMap in packetMap.Blocks)
{
// If this is a variable count block, count the number of appearances of this block in the
// passed in Hashtable and prepend a counter byte
#region VariableSize
if (blockMap.Count == -1)
{
blockCount = 0;
// Count the number of this type of block in the blocks Hashtable
blocksEnum = blocks.GetEnumerator();
while (blocksEnum.MoveNext())
{
if ((string)blocksEnum.Value == blockMap.Name)
{
blockCount++;
}
}
if (blockCount > 255)
{
throw new Exception("Trying to put more than 255 blocks in a variable block");
}
// Prepend the blocks with a count
byteArray[length] = (byte)blockCount;
length++;
}
#endregion VariableSize
// Reset blockCount
blockCount = 0;
// Check for blocks of this type in the Hashtable
#region BuildBlock
blocksEnum = blocks.GetEnumerator();
while (blocksEnum.MoveNext())
{
if ((string)blocksEnum.Value == blockMap.Name)
{
// Found a match of this block
if ((blockMap.Count == -1 && blockCount < 255) || blockCount < blockMap.Count)
{
blockCount++;
#region TryBlockTypecast
try
{
fields = (Hashtable)blocksEnum.Key;
}
catch (Exception e)
{
throw new Exception("A block Hashtable did not contain a fields Hashtable", e);
}
#endregion TryBlockTypecast
foreach (MapField fieldMap in blockMap.Fields)
{
if (fields.ContainsKey(fieldMap.Name))
{
object field = fields[fieldMap.Name];
#region AddField
switch (fieldMap.Type)
{
case FieldType.U8:
byteArray[length++] = (byte)field;
break;
case FieldType.U16:
ushort fieldUShort = (ushort)field;
byteArray[length++] = (byte)(fieldUShort % 256);
fieldUShort >>= 8;
byteArray[length++] = (byte)(fieldUShort % 256);
break;
case FieldType.U32:
uint fieldUInt = (uint)field;
byteArray[length++] = (byte)(fieldUInt % 256);
fieldUInt >>= 8;
byteArray[length++] = (byte)(fieldUInt % 256);
fieldUInt >>= 8;
byteArray[length++] = (byte)(fieldUInt % 256);
fieldUInt >>= 8;
byteArray[length++] = (byte)(fieldUInt % 256);
break;
case FieldType.U64:
// FIXME: Apply endianness patch
Array.Copy(((U64)field).GetBytes(), 0, byteArray, length, 8);
length += 8;
break;
case FieldType.S8:
byteArray[length++] = (byte)((sbyte)field);
break;
case FieldType.S16:
// FIXME: Apply endianness patch
Array.Copy(BitConverter.GetBytes((short)field), 0, byteArray, length, 2);
length += 2;
break;
case FieldType.S32:
// FIXME: Apply endianness patch
Array.Copy(BitConverter.GetBytes((int)field), 0, byteArray, length, 4);
length += 4;
break;
case FieldType.S64:
// FIXME: Apply endianness patch
Array.Copy(BitConverter.GetBytes((long)field), 0, byteArray, length, 8);
length += 8;
break;
case FieldType.F32:
Array.Copy(BitConverter.GetBytes((float)field), 0, byteArray, length, 4);
length += 4;
break;
case FieldType.F64:
Array.Copy(BitConverter.GetBytes((double)field), 0, byteArray, length, 8);
length += 8;
break;
case FieldType.LLUUID:
Array.Copy(((LLUUID)field).Data, 0, byteArray, length, 16);
length += 16;
break;
case FieldType.BOOL:
byteArray[length] = (byte)((bool)field == true ? 1 : 0);
length++;
break;
case FieldType.LLVector3:
Array.Copy(((LLVector3)field).GetBytes(), 0, byteArray, length, 12);
length += 12;
break;
case FieldType.LLVector3d:
Array.Copy(((LLVector3d)field).GetBytes(), 0, byteArray, length, 24);
length += 24;
break;
case FieldType.LLVector4:
Array.Copy(((LLVector4)field).GetBytes(), 0, byteArray, length, 16);
length += 16;
break;
case FieldType.LLQuaternion:
Array.Copy(((LLQuaternion)field).GetBytes(), 0, byteArray, length, 16);
length += 16;
break;
case FieldType.IPADDR:
Array.Copy(((IPAddress)field).GetAddressBytes(), 0, byteArray, length, 4);
length += 4;
break;
case FieldType.IPPORT:
ushort fieldIPPort = (ushort)field;
byteArray[length + 1] = (byte)(fieldIPPort % 256);
fieldIPPort >>= 8;
byteArray[length] = (byte)(fieldIPPort % 256);
length += 2;
break;
case FieldType.Variable:
if (field.GetType().IsArray)
{
// Assume this is a byte array
fieldLength = ((byte[])field).Length;
}
else
{
// Assume this is a string, add 1 for the null terminator
fieldLength = ((string)field).Length + 1;
}
if (fieldMap.Count == 1)
{
if (fieldLength > 255)
{
throw new Exception("Variable byte field longer than 255 characters");
}
byteArray[length] = (byte)(fieldLength);
length++;
}
else if (fieldMap.Count == 2)
{
if (fieldLength > 1024)
{
throw new Exception("Variable byte field longer than 1024 characters");
}
byteArray[length++] = (byte)(fieldLength % 256);
byteArray[length++] = (byte)(fieldLength / 256);
}
else
{
throw new Exception("Variable field with an unknown count, protocol map error");
}
if (field.GetType().IsArray)
{
// Assume this is a byte array
Array.Copy((byte[])field, 0, byteArray, length, fieldLength);
}
else
{
// Assume this is a string, add 1 for the null terminator
byte[] stringBytes = System.Text.Encoding.UTF8.GetBytes((string)field);
Array.Copy(stringBytes, 0, byteArray, length, stringBytes.Length);
fieldLength = stringBytes.Length + 1;
}
length += fieldLength;
break;
case FieldType.Fixed:
Array.Copy((byte[])field, 0, byteArray, length, fieldMap.Count);
length += fieldMap.Count;
break;
default:
throw new Exception("Unhandled FieldType");
}
#endregion AddField
}
else
{
// This field wasn't passed in, create an empty version
#region EmptyField
if (fieldMap.Type == FieldType.Variable)
{
// Just set the counter to zero and move on
if (fieldMap.Count == 2)
{
length += 2;
}
else
{
if (fieldMap.Count != 1)
{
throw new Exception("Variable length field has an invalid Count");
}
length++;
}
}
else if (fieldMap.Type == FieldType.Fixed)
{
length += fieldMap.Count;
}
else
{
length += (int)protocol.TypeSizes[fieldMap.Type];
}
#endregion EmptyField
}
}
}
else
{
throw new Exception("Too many blocks");
}
}
}
#endregion BuildBlock
// If this is a fixed count block and it doesn't appear in the Hashtable passed in, create
// empty filler blocks
#region EmptyBlock
if (blockCount == 0 && blockMap.Count != -1)
{
for (int i = 0; i < blockMap.Count; ++i)
{
foreach (MapField field in blockMap.Fields)
{
if (field.Type == FieldType.Variable)
{
length++;
}
else
{
length += (int)protocol.TypeSizes[field.Type];
}
}
}
}
#endregion EmptyBlock
}
Packet packet = new Packet(byteArray, length, protocol);
packet.Data[0] = flags;
return packet;
}
}
}