1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
|
//
// WebMessageFormatter.cs
//
// Author:
// Atsushi Enomoto <atsushi@ximian.com>
//
// Copyright (C) 2008,2009 Novell, Inc (http://www.novell.com)
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Reflection;
using System.Runtime.Serialization;
using System.Runtime.Serialization.Json;
using System.ServiceModel;
using System.ServiceModel.Channels;
using System.ServiceModel.Dispatcher;
using System.ServiceModel.Web;
using System.Text;
using System.Xml;
namespace System.ServiceModel.Description
{
internal abstract class WebMessageFormatter
{
OperationDescription operation;
ServiceEndpoint endpoint;
QueryStringConverter converter;
WebHttpBehavior behavior;
UriTemplate template;
WebAttributeInfo info = null;
public WebMessageFormatter (OperationDescription operation, ServiceEndpoint endpoint, QueryStringConverter converter, WebHttpBehavior behavior)
{
this.operation = operation;
this.endpoint = endpoint;
this.converter = converter;
this.behavior = behavior;
ApplyWebAttribute ();
// This is a hack for WebScriptEnablingBehavior
var jqc = converter as JsonQueryStringConverter;
if (jqc != null)
BodyName = jqc.CustomWrapperName;
}
void ApplyWebAttribute ()
{
MethodInfo mi = operation.SyncMethod ?? operation.BeginMethod;
object [] atts = mi.GetCustomAttributes (typeof (WebGetAttribute), false);
if (atts.Length > 0)
info = ((WebGetAttribute) atts [0]).Info;
atts = mi.GetCustomAttributes (typeof (WebInvokeAttribute), false);
if (atts.Length > 0)
info = ((WebInvokeAttribute) atts [0]).Info;
if (info == null)
info = new WebAttributeInfo ();
template = info.BuildUriTemplate (Operation, GetMessageDescription (MessageDirection.Input));
}
public string BodyName { get; set; }
public WebHttpBehavior Behavior {
get { return behavior; }
}
public WebAttributeInfo Info {
get { return info; }
}
public WebMessageBodyStyle BodyStyle {
get { return info.IsBodyStyleSetExplicitly ? info.BodyStyle : behavior.DefaultBodyStyle; }
}
public bool IsResponseBodyWrapped {
get {
switch (BodyStyle) {
case WebMessageBodyStyle.Wrapped:
case WebMessageBodyStyle.WrappedResponse:
return true;
}
return BodyName != null;
}
}
public OperationDescription Operation {
get { return operation; }
}
public QueryStringConverter Converter {
get { return converter; }
}
public ServiceEndpoint Endpoint {
get { return endpoint; }
}
public UriTemplate UriTemplate {
get { return template; }
}
protected WebContentFormat ToContentFormat (WebMessageFormat src)
{
switch (src) {
case WebMessageFormat.Xml:
return WebContentFormat.Xml;
case WebMessageFormat.Json:
return WebContentFormat.Json;
}
throw new SystemException ("INTERNAL ERROR: should not happen");
}
protected void CheckMessageVersion (MessageVersion messageVersion)
{
if (messageVersion == null)
throw new ArgumentNullException ("messageVersion");
if (!MessageVersion.None.Equals (messageVersion))
throw new ArgumentException ("Only MessageVersion.None is supported");
}
protected MessageDescription GetMessageDescription (MessageDirection dir)
{
foreach (MessageDescription md in operation.Messages)
if (md.Direction == dir)
return md;
throw new SystemException ("INTERNAL ERROR: no corresponding message description for the specified direction: " + dir);
}
protected XmlObjectSerializer GetSerializer (WebContentFormat msgfmt)
{
switch (msgfmt) {
case WebContentFormat.Xml:
if (IsResponseBodyWrapped)
return GetSerializer (ref xml_serializer, p => new DataContractSerializer (p.Type, p.Name, p.Namespace));
else
return GetSerializer (ref xml_serializer, p => new DataContractSerializer (p.Type));
break;
case WebContentFormat.Json:
// FIXME: after name argument they are hack
#if !NET_2_1 || MONOTOUCH
if (IsResponseBodyWrapped)
return GetSerializer (ref json_serializer, p => new DataContractJsonSerializer (p.Type, BodyName ?? p.Name, null, 0x100000, false, null, true));
else
#endif
return GetSerializer (ref json_serializer, p => new DataContractJsonSerializer (p.Type));
break;
default:
throw new NotImplementedException ();
}
}
XmlObjectSerializer xml_serializer, json_serializer;
XmlObjectSerializer GetSerializer (ref XmlObjectSerializer serializer, Func<MessagePartDescription,XmlObjectSerializer> f)
{
if (serializer == null) {
MessageDescription md = GetMessageDescription (MessageDirection.Output);
serializer = f (md.Body.ReturnValue);
}
return serializer;
}
internal class RequestClientFormatter : WebClientMessageFormatter
{
public RequestClientFormatter (OperationDescription operation, ServiceEndpoint endpoint, QueryStringConverter converter, WebHttpBehavior behavior)
: base (operation, endpoint, converter, behavior)
{
}
public override object DeserializeReply (Message message, object [] parameters)
{
throw new NotSupportedException ();
}
}
internal class ReplyClientFormatter : WebClientMessageFormatter
{
public ReplyClientFormatter (OperationDescription operation, ServiceEndpoint endpoint, QueryStringConverter converter, WebHttpBehavior behavior)
: base (operation, endpoint, converter, behavior)
{
}
public override Message SerializeRequest (MessageVersion messageVersion, object [] parameters)
{
throw new NotSupportedException ();
}
}
#if !NET_2_1
internal class RequestDispatchFormatter : WebDispatchMessageFormatter
{
public RequestDispatchFormatter (OperationDescription operation, ServiceEndpoint endpoint, QueryStringConverter converter, WebHttpBehavior behavior)
: base (operation, endpoint, converter, behavior)
{
}
public override Message SerializeReply (MessageVersion messageVersion, object [] parameters, object result)
{
throw new NotSupportedException ();
}
}
internal class ReplyDispatchFormatter : WebDispatchMessageFormatter
{
public ReplyDispatchFormatter (OperationDescription operation, ServiceEndpoint endpoint, QueryStringConverter converter, WebHttpBehavior behavior)
: base (operation, endpoint, converter, behavior)
{
}
public override void DeserializeRequest (Message message, object [] parameters)
{
throw new NotSupportedException ();
}
}
#endif
internal abstract class WebClientMessageFormatter : WebMessageFormatter, IClientMessageFormatter
{
protected WebClientMessageFormatter (OperationDescription operation, ServiceEndpoint endpoint, QueryStringConverter converter, WebHttpBehavior behavior)
: base (operation, endpoint, converter, behavior)
{
}
public virtual Message SerializeRequest (MessageVersion messageVersion, object [] parameters)
{
if (parameters == null)
throw new ArgumentNullException ("parameters");
CheckMessageVersion (messageVersion);
var c = new Dictionary<string,string> ();
MessageDescription md = GetMessageDescription (MessageDirection.Input);
if (parameters.Length != md.Body.Parts.Count)
throw new ArgumentException ("Parameter array length does not match the number of message body parts");
for (int i = 0; i < parameters.Length; i++) {
var p = md.Body.Parts [i];
string name = p.Name.ToUpper (CultureInfo.InvariantCulture);
if (UriTemplate.PathSegmentVariableNames.Contains (name) ||
UriTemplate.QueryValueVariableNames.Contains (name))
c.Add (name, parameters [i] != null ? Converter.ConvertValueToString (parameters [i], parameters [i].GetType ()) : null);
else
// FIXME: bind as a message part
throw new NotImplementedException (String.Format ("parameter {0} is not contained in the URI template {1} {2} {3}", p.Name, UriTemplate, UriTemplate.PathSegmentVariableNames.Count, UriTemplate.QueryValueVariableNames.Count));
}
Uri to = UriTemplate.BindByName (Endpoint.Address.Uri, c);
Message ret = Message.CreateMessage (messageVersion, (string) null);
ret.Headers.To = to;
var hp = new HttpRequestMessageProperty ();
hp.Method = Info.Method;
#if !NET_2_1
if (WebOperationContext.Current != null)
WebOperationContext.Current.OutgoingRequest.Apply (hp);
#endif
// FIXME: set hp.SuppressEntityBody for some cases.
ret.Properties.Add (HttpRequestMessageProperty.Name, hp);
var wp = new WebBodyFormatMessageProperty (ToContentFormat (Info.IsRequestFormatSetExplicitly ? Info.RequestFormat : Behavior.DefaultOutgoingRequestFormat));
ret.Properties.Add (WebBodyFormatMessageProperty.Name, wp);
return ret;
}
public virtual object DeserializeReply (Message message, object [] parameters)
{
if (parameters == null)
throw new ArgumentNullException ("parameters");
CheckMessageVersion (message.Version);
string pname = WebBodyFormatMessageProperty.Name;
if (!message.Properties.ContainsKey (pname))
throw new SystemException ("INTERNAL ERROR: it expects WebBodyFormatMessageProperty existence");
var wp = (WebBodyFormatMessageProperty) message.Properties [pname];
var serializer = GetSerializer (wp.Format);
// FIXME: handle ref/out parameters
var md = GetMessageDescription (MessageDirection.Output);
var reader = message.GetReaderAtBodyContents ();
if (IsResponseBodyWrapped) {
if (wp.Format == WebContentFormat.Json)
reader.ReadStartElement ("root", String.Empty); // note that the wrapper name is passed to the serializer.
else
reader.ReadStartElement (md.Body.WrapperName, md.Body.WrapperNamespace);
}
var ret = serializer.ReadObject (reader, true);
if (IsResponseBodyWrapped)
reader.ReadEndElement ();
return ret;
}
}
internal class WrappedBodyWriter : BodyWriter
{
public WrappedBodyWriter (object value, XmlObjectSerializer serializer, string name, string ns, bool json)
: base (true)
{
this.name = name;
this.ns = ns;
this.value = value;
this.serializer = serializer;
this.is_json = json;
}
bool is_json;
string name, ns;
object value;
XmlObjectSerializer serializer;
#if !NET_2_1
protected override BodyWriter OnCreateBufferedCopy (int maxBufferSize)
{
return new WrappedBodyWriter (value, serializer, name, ns, is_json);
}
#endif
protected override void OnWriteBodyContents (XmlDictionaryWriter writer)
{
if (is_json)
WriteJsonBodyContents (writer);
else
WriteXmlBodyContents (writer);
}
void WriteJsonBodyContents (XmlDictionaryWriter writer)
{
if (name != null) {
writer.WriteStartElement ("root");
writer.WriteAttributeString ("type", "object");
}
serializer.WriteObject (writer, value);
if (name != null)
writer.WriteEndElement ();
}
void WriteXmlBodyContents (XmlDictionaryWriter writer)
{
if (name != null)
writer.WriteStartElement (name, ns);
serializer.WriteObject (writer, value);
if (name != null)
writer.WriteEndElement ();
}
}
#if !NET_2_1
internal abstract class WebDispatchMessageFormatter : WebMessageFormatter, IDispatchMessageFormatter
{
protected WebDispatchMessageFormatter (OperationDescription operation, ServiceEndpoint endpoint, QueryStringConverter converter, WebHttpBehavior behavior)
: base (operation, endpoint, converter, behavior)
{
}
public virtual Message SerializeReply (MessageVersion messageVersion, object [] parameters, object result)
{
try {
return SerializeReplyCore (messageVersion, parameters, result);
} finally {
if (WebOperationContext.Current != null)
OperationContext.Current.Extensions.Remove (WebOperationContext.Current);
}
}
Message SerializeReplyCore (MessageVersion messageVersion, object [] parameters, object result)
{
if (parameters == null)
throw new ArgumentNullException ("parameters");
CheckMessageVersion (messageVersion);
MessageDescription md = GetMessageDescription (MessageDirection.Output);
// FIXME: use them.
// var dcob = Operation.Behaviors.Find<DataContractSerializerOperationBehavior> ();
// XmlObjectSerializer xos = dcob.CreateSerializer (result.GetType (), md.Body.WrapperName, md.Body.WrapperNamespace, null);
// var xsob = Operation.Behaviors.Find<XmlSerializerOperationBehavior> ();
// XmlSerializer [] serializers = XmlSerializer.FromMappings (xsob.GetXmlMappings ().ToArray ());
WebMessageFormat msgfmt = Info.IsResponseFormatSetExplicitly ? Info.ResponseFormat : Behavior.DefaultOutgoingResponseFormat;
string mediaType = null;
XmlObjectSerializer serializer = null;
// FIXME: serialize ref/out parameters as well.
string name = null, ns = null;
switch (msgfmt) {
case WebMessageFormat.Xml:
serializer = GetSerializer (WebContentFormat.Xml);
mediaType = "application/xml";
name = IsResponseBodyWrapped ? md.Body.WrapperName : null;
ns = IsResponseBodyWrapped ? md.Body.WrapperNamespace : null;
break;
case WebMessageFormat.Json:
serializer = GetSerializer (WebContentFormat.Json);
mediaType = "application/json";
name = IsResponseBodyWrapped ? (BodyName ?? md.Body.ReturnValue.Name) : null;
ns = String.Empty;
break;
}
bool json = msgfmt == WebMessageFormat.Json;
Message ret = Message.CreateMessage (MessageVersion.None, null, new WrappedBodyWriter (result, serializer, name, ns, json));
// Message properties
var hp = new HttpResponseMessageProperty ();
// FIXME: get encoding from somewhere
hp.Headers ["Content-Type"] = mediaType + "; charset=utf-8";
// apply user-customized HTTP results via WebOperationContext.
WebOperationContext.Current.OutgoingResponse.Apply (hp);
// FIXME: fill some properties if required.
ret.Properties.Add (HttpResponseMessageProperty.Name, hp);
var wp = new WebBodyFormatMessageProperty (ToContentFormat (msgfmt));
ret.Properties.Add (WebBodyFormatMessageProperty.Name, wp);
return ret;
}
public virtual void DeserializeRequest (Message message, object [] parameters)
{
if (parameters == null)
throw new ArgumentNullException ("parameters");
CheckMessageVersion (message.Version);
OperationContext.Current.Extensions.Add (new WebOperationContext (OperationContext.Current));
IncomingWebRequestContext iwc = WebOperationContext.Current.IncomingRequest;
Uri to = message.Headers.To;
UriTemplateMatch match = UriTemplate.Match (Endpoint.Address.Uri, to);
if (match == null)
// not sure if it could happen
throw new SystemException (String.Format ("INTERNAL ERROR: UriTemplate does not match with the request: {0} / {1}", UriTemplate, to));
iwc.UriTemplateMatch = match;
MessageDescription md = GetMessageDescription (MessageDirection.Input);
for (int i = 0; i < parameters.Length; i++) {
var p = md.Body.Parts [i];
string name = p.Name.ToUpperInvariant ();
var str = match.BoundVariables [name];
parameters [i] = Converter.ConvertStringToValue (str, p.Type);
}
}
}
#endif
}
}
|