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
40 namespace System.Runtime.Serialization.Formatters.Soap {
\r
41 internal sealed class SoapReader {
\r
45 private SerializationBinder _binder;
\r
46 private SoapTypeMapper mapper;
\r
47 private ObjectManager objMgr;
\r
48 private StreamingContext _context;
\r
49 private long _nextAvailableId = long.MaxValue;
\r
50 private ISurrogateSelector _surrogateSelector;
\r
51 private XmlTextReader xmlReader;
\r
52 private Hashtable _fieldIndices;
\r
53 private long _topObjectId = 1;
\r
57 public MemberInfo[] MemberInfos;
\r
58 public Hashtable Indices;
\r
65 private long NextAvailableId
\r
70 return _nextAvailableId;
\r
76 #region Constructors
\r
78 public SoapReader(SerializationBinder binder, ISurrogateSelector selector, StreamingContext context)
\r
81 objMgr = new ObjectManager(selector, context);
\r
83 _surrogateSelector = selector;
\r
84 _fieldIndices = new Hashtable();
\r
89 #region Public Methods
\r
91 public object Deserialize(Stream inStream, ISoapMessage soapMessage)
\r
93 ArrayList headers = null;
\r
94 xmlReader = new XmlTextReader(inStream);
\r
95 xmlReader.WhitespaceHandling = WhitespaceHandling.None;
\r
96 mapper = new SoapTypeMapper(_binder);
\r
100 // SOAP-ENV:Envelope
\r
101 xmlReader.MoveToContent();
\r
102 xmlReader.ReadStartElement ();
103 xmlReader.MoveToContent();
106 while (!(xmlReader.NodeType == XmlNodeType.Element && xmlReader.LocalName == "Body" && xmlReader.NamespaceURI == SoapTypeMapper.SoapEnvelopeNamespace))
108 if (xmlReader.NodeType == XmlNodeType.Element && xmlReader.LocalName == "Header" && xmlReader.NamespaceURI == SoapTypeMapper.SoapEnvelopeNamespace)
\r
110 if (headers == null) headers = new ArrayList ();
\r
111 DeserializeHeaders (headers);
\r
115 xmlReader.MoveToContent();
\r
119 xmlReader.ReadStartElement();
\r
120 xmlReader.MoveToContent();
\r
123 if (soapMessage != null)
\r
125 if (DeserializeMessage (soapMessage)) {
\r
126 _topObjectId = NextAvailableId;
\r
127 RegisterObject (_topObjectId, soapMessage, null, 0, null, null);
\r
129 xmlReader.MoveToContent();
\r
131 if (headers != null)
\r
132 soapMessage.Headers = (Header[]) headers.ToArray (typeof(Header));
\r
135 while (xmlReader.NodeType != XmlNodeType.EndElement)
\r
139 xmlReader.ReadEndElement ();
\r
140 xmlReader.MoveToContent();
\r
142 // SOAP-ENV:Envelope
\r
143 xmlReader.ReadEndElement ();
\r
147 if(xmlReader != null) xmlReader.Close();
\r
155 #region Private Methods
\r
157 private object TopObject
\r
162 objMgr.RaiseDeserializationEvent();
\r
163 return objMgr.GetObject(_topObjectId);
\r
167 private bool IsNull()
\r
169 string tmp = xmlReader["null", XmlSchema.InstanceNamespace];
\r
170 return (tmp == null || tmp == string.Empty)?false:true;
\r
173 private long GetId()
\r
177 string strId = xmlReader["id"];
\r
178 if(strId == null || strId == String.Empty) return 0;
\r
179 id = Convert.ToInt64(strId.Substring(4));
\r
183 private long GetHref()
\r
187 string strHref = xmlReader["href"];
\r
188 if(strHref == null || strHref == string.Empty) return 0;
\r
189 href = Convert.ToInt64(strHref.Substring(5));
\r
193 private Type GetComponentType()
\r
197 string strValue = xmlReader["type", XmlSchema.InstanceNamespace];
\r
198 if(strValue == null) {
\r
199 if(GetId() != 0) return typeof(string);
\r
202 string[] strName = strValue.Split(':');
\r
203 string namespaceURI = xmlReader.LookupNamespace(strName[0]);
\r
204 type = mapper[new Element(string.Empty, strName[1], namespaceURI)];
\r
209 private bool DeserializeMessage(ISoapMessage message)
\r
211 string typeNamespace, assemblyName;
\r
213 if(xmlReader.Name == SoapTypeMapper.SoapEnvelopePrefix + ":Fault")
\r
219 SoapServices.DecodeXmlNamespaceForClrTypeNamespace(
\r
220 xmlReader.NamespaceURI,
\r
223 message.MethodName = xmlReader.LocalName;
\r
224 message.XmlNameSpace = xmlReader.NamespaceURI;
\r
226 ArrayList paramNames = new ArrayList();
\r
227 ArrayList paramValues = new ArrayList();
\r
228 long paramValuesId = NextAvailableId;
\r
229 int[] indices = new int[1];
\r
231 if (!xmlReader.IsEmptyElement)
\r
233 int initialDepth = xmlReader.Depth;
\r
236 while(xmlReader.Depth > initialDepth)
\r
238 long paramId, paramHref;
\r
239 object objParam = null;
\r
240 paramNames.Add (xmlReader.Name);
\r
241 Type paramType = null;
\r
243 if (message.ParamTypes != null) {
\r
244 if (i >= message.ParamTypes.Length)
\r
245 throw new SerializationException ("Not enough parameter types in SoapMessages");
\r
246 paramType = message.ParamTypes [i];
\r
250 objParam = DeserializeComponent(
\r
257 indices[0] = paramValues.Add(objParam);
\r
258 if(paramHref != 0)
\r
260 RecordFixup(paramValuesId, paramHref, paramValues.ToArray(), null, null, null, indices);
\r
262 else if(paramId != 0)
\r
264 // RegisterObject(paramId, objParam, null, paramValuesId, null, indices);
\r
271 xmlReader.ReadEndElement();
\r
278 message.ParamNames = (string[]) paramNames.ToArray(typeof(string));
\r
279 message.ParamValues = paramValues.ToArray();
\r
280 RegisterObject(paramValuesId, message.ParamValues, null, 0, null, null);
\r
284 void DeserializeHeaders (ArrayList headers)
\r
286 xmlReader.ReadStartElement ();
\r
287 xmlReader.MoveToContent ();
\r
289 while (xmlReader.NodeType != XmlNodeType.EndElement)
\r
291 if (xmlReader.NodeType != XmlNodeType.Element) { xmlReader.Skip(); continue; }
\r
293 if (xmlReader.GetAttribute ("root", SoapTypeMapper.SoapEncodingNamespace) == "1")
\r
294 headers.Add (DeserializeHeader ());
\r
298 xmlReader.MoveToContent ();
\r
301 xmlReader.ReadEndElement ();
\r
303 \r Header DeserializeHeader ()
305 Header h = new Header (xmlReader.LocalName, null);
306 h.HeaderNamespace = xmlReader.NamespaceURI;
\r
307 h.MustUnderstand = xmlReader.GetAttribute ("mustUnderstand", SoapTypeMapper.SoapEnvelopeNamespace) == "1";
\r
310 long fieldId, fieldHref;
\r
311 long idHeader = NextAvailableId;
\r
312 FieldInfo fieldInfo = typeof(Header).GetField ("Value");
\r
314 value = DeserializeComponent (null, out fieldId, out fieldHref, idHeader, fieldInfo, null);
\r
317 if(fieldHref != 0 && value == null)
\r
319 RecordFixup (idHeader, fieldHref, h, null, null, fieldInfo, null);
\r
321 else if(value != null && value.GetType().IsValueType && fieldId != 0)
\r
323 RecordFixup (idHeader, fieldId, h, null, null, fieldInfo, null);
\r
325 else if(fieldId != 0)
\r
327 RegisterObject (fieldId, value, null, idHeader, fieldInfo, null);
\r
330 RegisterObject (idHeader, h, null, 0, null, null);
\r
335 private object DeserializeArray(long id)
\r
337 // Special case for base64 byte arrays
\r
338 if (GetComponentType () == typeof(byte[])) {
\r
339 byte[] data = Convert.FromBase64String (xmlReader.ReadElementString());
\r
340 RegisterObject(id, data, null, 0, null, null);
\r
344 // Get the array properties
\r
345 string strArrayType = xmlReader["arrayType", SoapTypeMapper.SoapEncodingNamespace];
\r
346 string[] arrayInfo = strArrayType.Split(':','[',',',']');
\r
347 int numberOfDims = arrayInfo.Length - 3;
\r
348 int[] lengths = new int[numberOfDims];
\r
349 string[] arrayDims = new String[numberOfDims];
\r
350 Array.Copy(arrayInfo, 2, arrayDims, 0, numberOfDims);
\r
351 for (int i=0; i < numberOfDims; i++)
\r
353 lengths[i] = Convert.ToInt32(arrayDims[i]);
\r
356 int[] indices = new int[numberOfDims];
\r
358 // Create the array
\r
359 Type arrayType = mapper[new Element(arrayInfo[0], arrayInfo[1], xmlReader.LookupNamespace(arrayInfo[0]))];
\r
360 Array array = Array.CreateInstance(
\r
364 for(int i = 0; i < numberOfDims; i++)
\r
366 indices[i] = array.GetLowerBound(i);
\r
369 // Deserialize the array items
\r
370 int arrayDepth = xmlReader.Depth;
\r
372 while(xmlReader.Depth > arrayDepth)
\r
374 Type itemType = GetComponentType();
\r
375 if(itemType == null)
\r
376 itemType = array.GetType().GetElementType();
\r
377 long itemId, itemHref;
\r
379 object objItem = DeserializeComponent(itemType,
\r
387 object obj = objMgr.GetObject(itemHref);
\r
389 array.SetValue(obj, indices);
\r
391 RecordFixup(id, itemHref, array, null, null, null, indices);
\r
393 else if(objItem != null && objItem.GetType().IsValueType && itemId != 0)
\r
395 RecordFixup(id, itemId, array, null, null, null, indices);
\r
397 else if(itemId != 0)
\r
399 RegisterObject(itemId, objItem, null, id, null, indices);
\r
400 array.SetValue(objItem, indices);
\r
404 array.SetValue(objItem, indices);
\r
407 // Get the next indice
\r
408 for(int dim = array.Rank - 1; dim >= 0; dim--)
\r
411 if(indices[dim] > array.GetUpperBound(dim))
\r
415 indices[dim] = array.GetLowerBound(dim);
\r
424 RegisterObject(id, array, null, 0, null, null);
\r
425 xmlReader.ReadEndElement();
\r
431 private object Deserialize()
\r
433 object objReturn = null;
\r
434 Element element = new Element(
\r
436 xmlReader.LocalName,
\r
437 xmlReader.NamespaceURI);
\r
440 Type type = mapper[element];
\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(SoapTypeMapper.CanBeValue(type))
\r
473 string elementString = xmlReader.ReadElementString();
\r
474 object obj = SoapTypeMapper.ParseXsdValue (elementString, type);
\r
477 RegisterObject(id, obj, info, parentId, parentMemberInfo, indices);
\r
481 object objReturn =
\r
482 FormatterServices.GetUninitializedObject(type);
\r
483 if(objReturn is ISerializable)
\r
484 NeedsSerializationInfo = true;
\r
486 if(_surrogateSelector != null && NeedsSerializationInfo == false)
\r
488 ISurrogateSelector selector;
\r
489 ISerializationSurrogate surrogate = _surrogateSelector.GetSurrogate(
\r
493 NeedsSerializationInfo |= (surrogate != null);
\r
496 if(NeedsSerializationInfo)
\r
499 DeserializeISerializableObject(objReturn, id, out info, out hasFixup);
\r
504 DeserializeSimpleObject(objReturn, id, out hasFixup);
\r
505 if(!hasFixup && objReturn is IObjectReference)
\r
506 objReturn = ((IObjectReference)objReturn).GetRealObject(_context);
\r
509 RegisterObject(id, objReturn, info, parentId, parentMemberInfo, indices);
\r
510 xmlReader.ReadEndElement();
\r
515 private object DeserializeSimpleObject(
\r
522 Type currentType = obj.GetType();
\r
523 TypeMetadata tm = GetTypeMetadata (currentType);
\r
525 int objDepth = xmlReader.Depth;
\r
526 object[] data = new object[tm.MemberInfos.Length];
\r
528 for(int i = 0; i < tm.MemberInfos.Length; i++)
\r
530 object fieldObject;
\r
531 long fieldId, fieldHref;
\r
532 int index = (int) tm.Indices[xmlReader.LocalName];
\r
533 FieldInfo fieldInfo = (tm.MemberInfos[index]) as FieldInfo;
\r
534 if(fieldInfo == null) continue;
\r
537 DeserializeComponent(fieldInfo.FieldType,
\r
544 data[index] = fieldObject;
\r
546 if(fieldHref != 0 && fieldObject == null)
\r
548 RecordFixup(id, fieldHref, obj, null, null, fieldInfo, null);
\r
552 if(fieldObject != null && fieldObject.GetType().IsValueType && fieldId != 0)
\r
554 RecordFixup(id, fieldId, obj, null, null, fieldInfo, null);
\r
561 RegisterObject(fieldId, fieldObject, null, id, fieldInfo, null);
\r
565 FormatterServices.PopulateObjectMembers (obj, tm.MemberInfos, data);
\r
570 private object DeserializeISerializableObject(
\r
573 out SerializationInfo info,
\r
577 long fieldId, fieldHref;
\r
578 info = new SerializationInfo(obj.GetType(), new FormatterConverter());
\r
581 int initialDepth = xmlReader.Depth;
\r
583 while(xmlReader.Depth > initialDepth)
\r
585 Type fieldType = GetComponentType();
\r
586 string fieldName = xmlReader.LocalName;
\r
587 object objField = DeserializeComponent(
\r
594 if(fieldHref != 0 && objField == null)
\r
596 RecordFixup(id, fieldHref, obj, info, fieldName, null, null);
\r
600 else if(fieldId != 0 && objField.GetType().IsValueType)
\r
602 RecordFixup(id, fieldId, obj, info, fieldName, null, null);
\r
609 RegisterObject(fieldId, objField, null, id, null, null);
\r
612 info.AddValue(fieldName, objField, (fieldType != null)?fieldType:typeof(object));
\r
619 private object DeserializeComponent(
\r
620 Type componentType,
\r
621 out long componentId,
\r
622 out long componentHref,
\r
624 MemberInfo parentMemberInfo,
\r
637 Type xsiType = GetComponentType();
\r
638 if(xsiType != null) componentType = xsiType;
\r
640 if(xmlReader.HasAttributes)
\r
642 componentId = GetId();
\r
643 componentHref = GetHref();
\r
646 if(componentId != 0)
\r
649 return xmlReader.ReadElementString();
\r
651 if(componentHref != 0)
\r
653 // Move the cursor to the next node
\r
655 return objMgr.GetObject(componentHref);
\r
658 if(componentType == null)
\r
659 return xmlReader.ReadElementString();
\r
661 componentId = NextAvailableId;
\r
662 objReturn = DeserializeObject(
\r
671 public void RecordFixup(
\r
672 long parentObjectId,
\r
673 long childObjectId,
\r
674 object parentObject,
\r
675 SerializationInfo info,
\r
677 MemberInfo memberInfo,
\r
682 objMgr.RecordDelayedFixup(parentObjectId, fieldName, childObjectId);
\r
684 else if (parentObject is Array)
\r
686 if (indices.Length == 1)
\r
687 objMgr.RecordArrayElementFixup (parentObjectId, indices[0], childObjectId);
\r
689 objMgr.RecordArrayElementFixup (parentObjectId, (int[])indices.Clone(), childObjectId);
\r
693 objMgr.RecordFixup (parentObjectId, memberInfo, childObjectId);
\r
697 private void RegisterObject (
\r
699 object objectInstance,
\r
700 SerializationInfo info,
\r
701 long parentObjectId,
\r
702 MemberInfo parentObjectMember,
\r
705 if (parentObjectId == 0) indices = null;
\r
707 if (!objectInstance.GetType().IsValueType || parentObjectId == 0)
\r
708 objMgr.RegisterObject (objectInstance, objectId, info, 0, null, null);
\r
711 if(objMgr.GetObject(objectId) != null)
\r
712 throw new SerializationException("Object already registered");
\r
713 if (indices != null) indices = (int[])indices.Clone();
\r
714 objMgr.RegisterObject (
\r
719 parentObjectMember,
\r
724 TypeMetadata GetTypeMetadata (Type type)
\r
726 TypeMetadata tm = _fieldIndices[type] as TypeMetadata;
\r
727 if (tm != null) return tm;
\r
729 tm = new TypeMetadata ();
\r
730 tm.MemberInfos = FormatterServices.GetSerializableMembers (type, _context);
\r
732 tm.Indices = new Hashtable();
\r
733 for(int i = 0; i < tm.MemberInfos.Length; i++)
\r
734 tm.Indices.Add (tm.MemberInfos[i].Name, i);
\r
736 _fieldIndices[type] = tm;
\r