1 // created on 24/04/2003 at 15:35
\r
3 // System.Runtime.Serialization.Formatters.Soap.SoapReader
\r
6 // Jean-Marc Andre (jean-marc.andre@polymtl.ca)
\r
10 // Permission is hereby granted, free of charge, to any person obtaining
11 // a copy of this software and associated documentation files (the
12 // "Software"), to deal in the Software without restriction, including
13 // without limitation the rights to use, copy, modify, merge, publish,
14 // distribute, sublicense, and/or sell copies of the Software, and to
15 // permit persons to whom the Software is furnished to do so, subject to
16 // the following conditions:
18 // The above copyright notice and this permission notice shall be
19 // included in all copies or substantial portions of the Software.
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
22 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
23 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
24 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
25 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
26 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
27 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 using System.Xml.Schema;
\r
34 using System.Reflection;
\r
35 using System.Collections;
\r
36 using System.Runtime.Remoting;
\r
37 using System.Runtime.Serialization;
\r
38 using System.Runtime.Remoting.Messaging;
\r
39 using System.Runtime.Remoting.Metadata;
\r
41 namespace System.Runtime.Serialization.Formatters.Soap {
\r
42 internal sealed class SoapReader {
\r
46 private SerializationBinder _binder;
\r
47 private SoapTypeMapper mapper;
\r
48 private ObjectManager objMgr;
\r
49 private StreamingContext _context;
\r
50 private long _nextAvailableId = long.MaxValue;
\r
51 private ISurrogateSelector _surrogateSelector;
\r
52 private XmlTextReader xmlReader;
\r
53 private Hashtable _fieldIndices;
\r
54 private long _topObjectId = 1;
\r
58 public MemberInfo[] MemberInfos;
\r
59 public Hashtable Indices;
\r
66 private long NextAvailableId
\r
71 return _nextAvailableId;
\r
77 #region Constructors
\r
79 public SoapReader(SerializationBinder binder, ISurrogateSelector selector, StreamingContext context)
\r
82 objMgr = new ObjectManager(selector, context);
\r
84 _surrogateSelector = selector;
\r
85 _fieldIndices = new Hashtable();
\r
90 #region Public Methods
\r
92 public object Deserialize(Stream inStream, ISoapMessage soapMessage)
\r
94 ArrayList headers = null;
\r
95 xmlReader = new XmlTextReader(inStream);
\r
96 xmlReader.WhitespaceHandling = WhitespaceHandling.None;
\r
97 mapper = new SoapTypeMapper(_binder);
\r
101 // SOAP-ENV:Envelope
\r
102 xmlReader.MoveToContent();
\r
103 xmlReader.ReadStartElement ();
104 xmlReader.MoveToContent();
107 while (!(xmlReader.NodeType == XmlNodeType.Element && xmlReader.LocalName == "Body" && xmlReader.NamespaceURI == SoapTypeMapper.SoapEnvelopeNamespace))
109 if (xmlReader.NodeType == XmlNodeType.Element && xmlReader.LocalName == "Header" && xmlReader.NamespaceURI == SoapTypeMapper.SoapEnvelopeNamespace)
\r
111 if (headers == null) headers = new ArrayList ();
\r
112 DeserializeHeaders (headers);
\r
116 xmlReader.MoveToContent();
\r
120 xmlReader.ReadStartElement();
\r
121 xmlReader.MoveToContent();
\r
124 if (soapMessage != null)
\r
126 if (DeserializeMessage (soapMessage)) {
\r
127 _topObjectId = NextAvailableId;
\r
128 RegisterObject (_topObjectId, soapMessage, null, 0, null, null);
\r
130 xmlReader.MoveToContent();
\r
132 if (headers != null)
\r
133 soapMessage.Headers = (Header[]) headers.ToArray (typeof(Header));
\r
136 while (xmlReader.NodeType != XmlNodeType.EndElement)
\r
140 xmlReader.ReadEndElement ();
\r
141 xmlReader.MoveToContent();
\r
143 // SOAP-ENV:Envelope
\r
144 xmlReader.ReadEndElement ();
\r
148 if(xmlReader != null) xmlReader.Close();
\r
156 public SoapTypeMapper Mapper {
157 get { return mapper; }
160 public XmlTextReader XmlReader {
161 get { return xmlReader; }
164 #region Private Methods
\r
166 private object TopObject
\r
171 objMgr.RaiseDeserializationEvent();
\r
172 return objMgr.GetObject(_topObjectId);
\r
176 private bool IsNull()
\r
178 string tmp = xmlReader["null", XmlSchema.InstanceNamespace];
\r
179 return (tmp == null || tmp == string.Empty)?false:true;
\r
182 private long GetId()
\r
186 string strId = xmlReader["id"];
\r
187 if(strId == null || strId == String.Empty) return 0;
\r
188 id = Convert.ToInt64(strId.Substring(4));
\r
192 private long GetHref()
\r
196 string strHref = xmlReader["href"];
\r
197 if(strHref == null || strHref == string.Empty) return 0;
\r
198 href = Convert.ToInt64(strHref.Substring(5));
\r
202 private Type GetComponentType()
\r
204 string strValue = xmlReader["type", XmlSchema.InstanceNamespace];
\r
205 if(strValue == null) {
\r
206 if(GetId() != 0) return typeof(string);
\r
209 return GetTypeFromQName (strValue);
\r
212 private bool DeserializeMessage(ISoapMessage message)
\r
214 string typeNamespace, assemblyName;
\r
216 if(xmlReader.Name == SoapTypeMapper.SoapEnvelopePrefix + ":Fault")
\r
222 SoapServices.DecodeXmlNamespaceForClrTypeNamespace(
\r
223 xmlReader.NamespaceURI,
\r
226 message.MethodName = xmlReader.LocalName;
\r
227 message.XmlNameSpace = xmlReader.NamespaceURI;
\r
229 ArrayList paramNames = new ArrayList();
\r
230 ArrayList paramValues = new ArrayList();
\r
231 long paramValuesId = NextAvailableId;
\r
232 int[] indices = new int[1];
\r
234 if (!xmlReader.IsEmptyElement)
\r
236 int initialDepth = xmlReader.Depth;
\r
239 while(xmlReader.Depth > initialDepth)
\r
241 long paramId, paramHref;
\r
242 object objParam = null;
\r
243 paramNames.Add (xmlReader.Name);
\r
244 Type paramType = null;
\r
246 if (message.ParamTypes != null) {
\r
247 if (i >= message.ParamTypes.Length)
\r
248 throw new SerializationException ("Not enough parameter types in SoapMessages");
\r
249 paramType = message.ParamTypes [i];
\r
253 objParam = DeserializeComponent(
\r
260 indices[0] = paramValues.Add(objParam);
\r
261 if(paramHref != 0)
\r
263 RecordFixup(paramValuesId, paramHref, paramValues.ToArray(), null, null, null, indices);
\r
265 else if(paramId != 0)
\r
267 // RegisterObject(paramId, objParam, null, paramValuesId, null, indices);
\r
274 xmlReader.ReadEndElement();
\r
281 message.ParamNames = (string[]) paramNames.ToArray(typeof(string));
\r
282 message.ParamValues = paramValues.ToArray();
\r
283 RegisterObject(paramValuesId, message.ParamValues, null, 0, null, null);
\r
287 void DeserializeHeaders (ArrayList headers)
\r
289 xmlReader.ReadStartElement ();
\r
290 xmlReader.MoveToContent ();
\r
292 while (xmlReader.NodeType != XmlNodeType.EndElement)
\r
294 if (xmlReader.NodeType != XmlNodeType.Element) { xmlReader.Skip(); continue; }
\r
296 if (xmlReader.GetAttribute ("root", SoapTypeMapper.SoapEncodingNamespace) == "1")
\r
297 headers.Add (DeserializeHeader ());
\r
301 xmlReader.MoveToContent ();
\r
304 xmlReader.ReadEndElement ();
\r
306 \r Header DeserializeHeader ()
308 Header h = new Header (xmlReader.LocalName, null);
309 h.HeaderNamespace = xmlReader.NamespaceURI;
\r
310 h.MustUnderstand = xmlReader.GetAttribute ("mustUnderstand", SoapTypeMapper.SoapEnvelopeNamespace) == "1";
\r
313 long fieldId, fieldHref;
\r
314 long idHeader = NextAvailableId;
\r
315 FieldInfo fieldInfo = typeof(Header).GetField ("Value");
\r
317 value = DeserializeComponent (null, out fieldId, out fieldHref, idHeader, fieldInfo, null);
\r
320 if(fieldHref != 0 && value == null)
\r
322 RecordFixup (idHeader, fieldHref, h, null, null, fieldInfo, null);
\r
324 else if(value != null && value.GetType().IsValueType && fieldId != 0)
\r
326 RecordFixup (idHeader, fieldId, h, null, null, fieldInfo, null);
\r
328 else if(fieldId != 0)
\r
330 RegisterObject (fieldId, value, null, idHeader, fieldInfo, null);
\r
333 RegisterObject (idHeader, h, null, 0, null, null);
\r
338 private object DeserializeArray(long id)
\r
340 // Special case for base64 byte arrays
\r
341 if (GetComponentType () == typeof(byte[])) {
\r
342 byte[] data = Convert.FromBase64String (xmlReader.ReadElementString());
\r
343 RegisterObject(id, data, null, 0, null, null);
\r
347 // Get the array properties
\r
348 string strArrayType = xmlReader["arrayType", SoapTypeMapper.SoapEncodingNamespace];
349 string[] arrayInfo = strArrayType.Split(':');
350 int arraySuffixInfo = arrayInfo[1].LastIndexOf('[');
351 String arrayElementType = arrayInfo[1].Substring(0, arraySuffixInfo);
352 String arraySuffix = arrayInfo[1].Substring(arraySuffixInfo);
353 string[] arrayDims = arraySuffix.Substring(1,arraySuffix.Length-2).Trim().Split(',');
354 int numberOfDims = arrayDims.Length;
355 int[] lengths = new int[numberOfDims];
357 for (int i=0; i < numberOfDims; i++)
\r
359 lengths[i] = Convert.ToInt32(arrayDims[i]);
\r
362 int[] indices = new int[numberOfDims];
\r
364 // Create the array
\r
365 Type arrayType = mapper.GetType (arrayElementType, xmlReader.LookupNamespace(arrayInfo[0]));
\r
366 Array array = Array.CreateInstance(
\r
370 for(int i = 0; i < numberOfDims; i++)
\r
372 indices[i] = array.GetLowerBound(i);
\r
375 // Deserialize the array items
\r
376 int arrayDepth = xmlReader.Depth;
\r
378 while(xmlReader.Depth > arrayDepth)
\r
380 Type itemType = GetComponentType();
\r
381 if(itemType == null)
\r
382 itemType = array.GetType().GetElementType();
\r
383 long itemId, itemHref;
\r
385 object objItem = DeserializeComponent(itemType,
\r
393 object obj = objMgr.GetObject(itemHref);
\r
395 array.SetValue(obj, indices);
\r
397 RecordFixup(id, itemHref, array, null, null, null, indices);
\r
399 else if(objItem != null && objItem.GetType().IsValueType && itemId != 0)
\r
401 RecordFixup(id, itemId, array, null, null, null, indices);
\r
403 else if(itemId != 0)
\r
405 RegisterObject(itemId, objItem, null, id, null, indices);
\r
406 array.SetValue(objItem, indices);
\r
410 array.SetValue(objItem, indices);
\r
413 // Get the next indice
\r
414 for(int dim = array.Rank - 1; dim >= 0; dim--)
\r
417 if(indices[dim] > array.GetUpperBound(dim))
\r
421 indices[dim] = array.GetLowerBound(dim);
\r
430 RegisterObject(id, array, null, 0, null, null);
\r
431 xmlReader.ReadEndElement();
\r
437 private object Deserialize()
\r
439 object objReturn = null;
\r
440 Type type = mapper.GetType (xmlReader.LocalName, xmlReader.NamespaceURI);
\r
444 id = (id == 0)?1:id;
\r
446 if(type == typeof(Array))
\r
448 objReturn = DeserializeArray(id);
\r
452 objReturn = DeserializeObject(type, id, 0, null, null);
\r
460 private object DeserializeObject(
\r
464 MemberInfo parentMemberInfo,
\r
467 SerializationInfo info = null;
\r
468 bool NeedsSerializationInfo = false;
\r
471 if(mapper.IsInternalSoapType (type))
\r
473 object obj = mapper.ReadInternalSoapValue (this, type);
\r
476 RegisterObject(id, obj, info, parentId, parentMemberInfo, indices);
\r
480 object objReturn =
\r
481 FormatterServices.GetUninitializedObject(type);
\r
482 if(objReturn is ISerializable)
\r
483 NeedsSerializationInfo = true;
\r
485 if(_surrogateSelector != null && NeedsSerializationInfo == false)
\r
487 ISurrogateSelector selector;
\r
488 ISerializationSurrogate surrogate = _surrogateSelector.GetSurrogate(
\r
492 NeedsSerializationInfo |= (surrogate != null);
\r
495 if(NeedsSerializationInfo)
\r
498 DeserializeISerializableObject(objReturn, id, out info, out hasFixup);
\r
503 DeserializeSimpleObject(objReturn, id, out hasFixup);
\r
504 if(!hasFixup && objReturn is IObjectReference)
\r
505 objReturn = ((IObjectReference)objReturn).GetRealObject(_context);
\r
508 RegisterObject(id, objReturn, info, parentId, parentMemberInfo, indices);
\r
509 xmlReader.ReadEndElement();
\r
514 private object DeserializeSimpleObject(
\r
521 Type currentType = obj.GetType();
\r
522 TypeMetadata tm = GetTypeMetadata (currentType);
\r
524 object[] data = new object[tm.MemberInfos.Length];
\r
526 xmlReader.MoveToContent ();
\r
527 while (xmlReader.NodeType != XmlNodeType.EndElement)
\r
529 if (xmlReader.NodeType != XmlNodeType.Element) {
\r
534 object fieldObject;
\r
535 long fieldId, fieldHref;
\r
537 object indexob = tm.Indices [xmlReader.LocalName];
\r
538 if (indexob == null)
\r
539 throw new SerializationException ("Field \"" + xmlReader.LocalName + "\" not found in class " + currentType.FullName);
\r
541 int index = (int) indexob;
\r
542 FieldInfo fieldInfo = (tm.MemberInfos[index]) as FieldInfo;
\r
545 DeserializeComponent(fieldInfo.FieldType,
\r
552 data[index] = fieldObject;
\r
554 if(fieldHref != 0 && fieldObject == null)
\r
556 RecordFixup(id, fieldHref, obj, null, null, fieldInfo, null);
\r
560 if(fieldObject != null && fieldObject.GetType().IsValueType && fieldId != 0)
\r
562 RecordFixup(id, fieldId, obj, null, null, fieldInfo, null);
\r
569 RegisterObject(fieldId, fieldObject, null, id, fieldInfo, null);
\r
573 FormatterServices.PopulateObjectMembers (obj, tm.MemberInfos, data);
\r
578 private object DeserializeISerializableObject(
\r
581 out SerializationInfo info,
\r
585 long fieldId, fieldHref;
\r
586 info = new SerializationInfo(obj.GetType(), new FormatterConverter());
\r
589 int initialDepth = xmlReader.Depth;
\r
591 while(xmlReader.Depth > initialDepth)
\r
593 Type fieldType = GetComponentType();
\r
594 string fieldName = XmlConvert.DecodeName (xmlReader.LocalName);
\r
595 object objField = DeserializeComponent(
\r
602 if(fieldHref != 0 && objField == null)
\r
604 RecordFixup(id, fieldHref, obj, info, fieldName, null, null);
\r
608 else if(fieldId != 0 && objField.GetType().IsValueType)
\r
610 RecordFixup(id, fieldId, obj, info, fieldName, null, null);
\r
617 RegisterObject(fieldId, objField, null, id, null, null);
\r
620 info.AddValue(fieldName, objField, (fieldType != null)?fieldType:typeof(object));
\r
627 private object DeserializeComponent(
\r
628 Type componentType,
\r
629 out long componentId,
\r
630 out long componentHref,
\r
632 MemberInfo parentMemberInfo,
\r
645 Type xsiType = GetComponentType();
\r
646 if(xsiType != null) componentType = xsiType;
\r
648 if(xmlReader.HasAttributes)
\r
650 componentId = GetId();
\r
651 componentHref = GetHref();
\r
654 if(componentId != 0)
\r
657 return xmlReader.ReadElementString();
\r
659 if(componentHref != 0)
\r
661 // Move the cursor to the next node
\r
663 return objMgr.GetObject(componentHref);
\r
666 if(componentType == null)
\r
667 return xmlReader.ReadElementString();
\r
669 componentId = NextAvailableId;
\r
670 objReturn = DeserializeObject(
\r
679 public void RecordFixup(
\r
680 long parentObjectId,
\r
681 long childObjectId,
\r
682 object parentObject,
\r
683 SerializationInfo info,
\r
685 MemberInfo memberInfo,
\r
690 objMgr.RecordDelayedFixup(parentObjectId, fieldName, childObjectId);
\r
692 else if (parentObject is Array)
\r
694 if (indices.Length == 1)
\r
695 objMgr.RecordArrayElementFixup (parentObjectId, indices[0], childObjectId);
\r
697 objMgr.RecordArrayElementFixup (parentObjectId, (int[])indices.Clone(), childObjectId);
\r
701 objMgr.RecordFixup (parentObjectId, memberInfo, childObjectId);
\r
705 private void RegisterObject (
\r
707 object objectInstance,
\r
708 SerializationInfo info,
\r
709 long parentObjectId,
\r
710 MemberInfo parentObjectMember,
\r
713 if (parentObjectId == 0) indices = null;
\r
715 if (!objectInstance.GetType().IsValueType || parentObjectId == 0)
\r
716 objMgr.RegisterObject (objectInstance, objectId, info, 0, null, null);
\r
719 if(objMgr.GetObject(objectId) != null)
\r
720 throw new SerializationException("Object already registered");
\r
721 if (indices != null) indices = (int[])indices.Clone();
\r
722 objMgr.RegisterObject (
\r
727 parentObjectMember,
\r
732 TypeMetadata GetTypeMetadata (Type type)
\r
734 TypeMetadata tm = _fieldIndices[type] as TypeMetadata;
\r
735 if (tm != null) return tm;
\r
737 tm = new TypeMetadata ();
\r
738 tm.MemberInfos = FormatterServices.GetSerializableMembers (type, _context);
\r
740 tm.Indices = new Hashtable();
\r
741 for(int i = 0; i < tm.MemberInfos.Length; i++) {
\r
742 SoapFieldAttribute at = (SoapFieldAttribute) InternalRemotingServices.GetCachedSoapAttribute (tm.MemberInfos[i]);
\r
743 tm.Indices [XmlConvert.EncodeLocalName (at.XmlElementName)] = i;
\r
746 _fieldIndices[type] = tm;
\r
750 public Type GetTypeFromQName (string qname)
752 string[] strName = qname.Split(':');
\r
753 string namespaceURI = xmlReader.LookupNamespace (strName[0]);
\r
754 return mapper.GetType (strName[1], namespaceURI);
\r