mcs/class/System.ServiceModel/System.ServiceModel/Logger.cs

   1 //
   2 // Author:
   3 //      Atsushi Enomoto <atsushi@ximian.com>
   4 //
   5 // Copyright (C) 2011 Novell, Inc.  http://www.novell.com
   6 // Copyright 2011 Xamarin Inc (http://www.xamarin.com).
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining
   9 // a copy of this software and associated documentation files (the
  10 // "Software"), to deal in the Software without restriction, including
  11 // without limitation the rights to use, copy, modify, merge, publish,
  12 // distribute, sublicense, and/or sell copies of the Software, and to
  13 // permit persons to whom the Software is furnished to do so, subject to
  14 // the following conditions:
  15 //
  16 // The above copyright notice and this permission notice shall be
  17 // included in all copies or substantial portions of the Software.
  18 //
  19 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  20 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  21 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  22 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  23 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  24 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  25 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  26 //
  27 using System;
  28 using System.Collections.Generic;
  29 using System.Configuration;
  30 using System.Diagnostics;
  31 using System.IO;
  32 using System.ServiceModel;
  33 using System.ServiceModel.Channels;
  34 using System.ServiceModel.Configuration;
  35 using System.ServiceModel.Diagnostics;
  36 using System.Threading;
  37 using System.Xml;
  38 using System.Xml.XPath;
  39
  40 namespace System.ServiceModel
  41 {
  42         internal enum MessageLogSourceKind
  43         {
  44                 TransportSend,
  45                 TransportReceive,
  46                 ServiceLevelReceiveDatagram,
  47                 ServiceLevelSendDatagram,
  48                 // more, maybe for clients?
  49         }
  50
  51         internal static class Logger
  52         {
  53 #if NET_2_1
  54                 enum TraceEventType // dummy
  55                 {
  56                         Critical,
  57                         Error,
  58                         Warning,
  59                         Information,
  60                         Verbose,
  61                         Start,
  62                         Stop,
  63                         Suspend,
  64                         Resume,
  65                         Transfer
  66                 }
  67 #endif
  68
  69                 const string xmlns = "http://schemas.microsoft.com/2004/06/ServiceModel/Management/MessageTrace";
  70                 static MessageLoggingSettings settings = new MessageLoggingSettings ();
  71                 static int event_id;
  72                 static TextWriter log_writer;
  73                 static XmlWriter xml_writer;
  74 #if !NET_2_1
  75                 static readonly TraceSource source = new TraceSource ("System.ServiceModel");
  76                 static readonly TraceSource message_source = new TraceSource ("System.ServiceModel.MessageLogging");
  77 #endif
  78
  79                 static Logger ()
  80                 {
  81                         var env =
  82                                 Environment.GetEnvironmentVariable ("MOON_WCF_TRACE") ??
  83                                 Environment.GetEnvironmentVariable ("MONO_WCF_TRACE");
  84
  85                         switch (env) {
  86                         case "stdout":
  87                                 log_writer = Console.Out;
  88                                 break;
  89                         case "stderr":
  90                                 log_writer = Console.Error;
  91                                 break;
  92 #if !NET_2_1
  93                         default:
  94                                 try {
  95                                         if (!String.IsNullOrEmpty (env))
  96                                                 log_writer = File.CreateText (env);
  97                                 } catch (Exception ex) {
  98                                         Console.Error.WriteLine ("WARNING: WCF trace environment variable points to non-creatable file name: " + env);
  99                                 }
 100                                 break;
 101 #endif
 102                         }
 103
 104                         if (log_writer != null)
 105                                 xml_writer = XmlWriter.Create (log_writer, new XmlWriterSettings () { OmitXmlDeclaration = true });
 106
 107 #if !NET_2_1
 108                         message_source.Switch.Level = SourceLevels.Information;
 109 #endif
 110                 }
 111
 112                 #region logger methods
 113
 114                 public static void Critical (string message, params object [] args)
 115                 {
 116                         Log (TraceEventType.Critical, message, args);
 117                 }
 118
 119                 public static void Error (string message, params object [] args)
 120                 {
 121                         Log (TraceEventType.Error, message, args);
 122                 }
 123
 124                 public static void Warning (string message, params object [] args)
 125                 {
 126                         Log (TraceEventType.Warning, message, args);
 127                 }
 128
 129                 public static void Info (string message, params object [] args)
 130                 {
 131                         Log (TraceEventType.Information, message, args);
 132                 }
 133
 134                 public static void Verbose (string message, params object [] args)
 135                 {
 136                         Log (TraceEventType.Verbose, message, args);
 137                 }
 138
 139                 // FIXME: do we need more?
 140
 141                 static void Log (TraceEventType eventType, string message, params object [] args)
 142                 {
 143                         if (log_writer != null) {
 144                                 lock (log_writer){
 145                                         event_id++;
 146 #if NET_2_1
 147                                         log_writer.Write ("[{0}] ", event_id);
 148 #endif
 149                                         TraceCore (TraceEventType.Information, event_id,
 150                                                 false, Guid.Empty, // FIXME
 151                                                 message, args);
 152                                         log_writer.WriteLine (message, args);
 153                                         log_writer.Flush ();
 154 #if !NET_2_1
 155                                         source.TraceEvent (eventType, event_id, message, args);
 156 #endif
 157                                 }
 158                         }
 159                 }
 160
 161                 #endregion
 162
 163                 #region message logging
 164
 165                 static readonly XmlWriterSettings xws = new XmlWriterSettings () { OmitXmlDeclaration = true };
 166
 167                 public static void LogMessage (MessageLogSourceKind sourceKind, ref Message msg, long maxMessageSize)
 168                 {
 169                         if (log_writer != null) {
 170                                 if (maxMessageSize > int.MaxValue)
 171                                         throw new ArgumentOutOfRangeException ("maxMessageSize");
 172                                 var mb = msg.CreateBufferedCopy ((int) maxMessageSize);
 173                                 msg = mb.CreateMessage ();
 174                                 LogMessage (new MessageLogTraceRecord (sourceKind, msg.GetType (), mb));
 175                         }
 176                 }
 177
 178                 public static void LogMessage (MessageLogTraceRecord log)
 179                 {
 180                         if (log_writer != null) {
 181                                 var sw = new StringWriter ();
 182 #if NET_2_1
 183                                 var xw = XmlWriter.Create (sw, xws);
 184 #else
 185                                 var doc = new XmlDocument ();
 186                                 var xw = doc.CreateNavigator ().AppendChild ();
 187 #endif
 188                                 xw.WriteStartElement ("MessageLogTraceRecord", xmlns);
 189                                 xw.WriteStartAttribute ("Time");
 190                                 xw.WriteValue (log.Time);
 191                                 xw.WriteEndAttribute ();
 192                                 xw.WriteAttributeString ("Source", log.Source.ToString ());
 193                                 xw.WriteAttributeString ("Type", log.Type.FullName);
 194                                 var msg = log.Message.CreateMessage ();
 195                                 if (!msg.IsEmpty)
 196                                         msg.WriteMessage (xw);
 197                                 xw.WriteEndElement ();
 198                                 xw.Close ();
 199
 200                                 event_id++;
 201                                 lock (log_writer){
 202 #if NET_2_1
 203                                         log_writer.Write ("[{0}] ", event_id);
 204
 205                                         TraceCore (TraceEventType.Information, event_id, /*FIXME*/false, /*FIXME*/Guid.Empty, sw);
 206 #else
 207                                         TraceCore (TraceEventType.Information, event_id, /*FIXME*/false, /*FIXME*/Guid.Empty, doc.CreateNavigator ());
 208
 209                                         message_source.TraceData (TraceEventType.Information, event_id, doc.CreateNavigator ());
 210 #endif
 211                                         log_writer.Flush ();
 212                                 }
 213                         }
 214                 }
 215
 216                 #endregion
 217
 218                 #region XmlWriterTraceListener compatibility
 219                 static void TraceCore (//TraceEventCache eventCache,
 220                         /*string source,*/ TraceEventType eventType, int id,
 221                         bool hasRelatedActivity, Guid relatedActivity,
 222                         /*int level, bool wrapData, */params object [] data)
 223                 {
 224                         string source = "mono(dummy)";
 225                         int level = 2;
 226                         bool wrapData = true;
 227                         var w = xml_writer;
 228
 229                         w.WriteStartElement ("E2ETraceEvent", e2e_ns);
 230
 231                         // <System>
 232                         w.WriteStartElement ("System", sys_ns);
 233                         w.WriteStartElement ("EventID", sys_ns);
 234                         w.WriteString (XmlConvert.ToString (id));
 235                         w.WriteEndElement ();
 236                         w.WriteStartElement ("Type", sys_ns);
 237                         // ...what to write here?
 238                         w.WriteString ("3");
 239                         w.WriteEndElement ();
 240                         w.WriteStartElement ("SubType", sys_ns);
 241                         // FIXME: it does not seem always to match eventType value ...
 242                         w.WriteAttributeString ("Name", eventType.ToString ());
 243                         // ...what to write here?
 244                         w.WriteString ("0");
 245                         w.WriteEndElement ();
 246                         // ...what to write here?
 247                         w.WriteStartElement ("Level", sys_ns);
 248                         w.WriteString (level.ToString ());
 249                         w.WriteEndElement ();
 250                         w.WriteStartElement ("TimeCreated", sys_ns);
 251                         w.WriteAttributeString ("SystemTime", XmlConvert.ToString (DateTime.Now, XmlDateTimeSerializationMode.RoundtripKind));
 252                         w.WriteEndElement ();
 253                         w.WriteStartElement ("Source", sys_ns);
 254                         w.WriteAttributeString ("Name", source);
 255                         w.WriteEndElement ();
 256                         w.WriteStartElement ("Correlation", sys_ns);
 257                         w.WriteAttributeString ("ActivityID", String.Concat ("{", Guid.Empty, "}"));
 258                         w.WriteEndElement ();
 259                         w.WriteStartElement ("Execution", sys_ns);
 260                         w.WriteAttributeString ("ProcessName", "mono (dummy)");
 261                         w.WriteAttributeString ("ProcessID", "0");
 262                         w.WriteAttributeString ("ThreadID", Thread.CurrentThread.ManagedThreadId.ToString ());
 263                         w.WriteEndElement ();
 264                         w.WriteStartElement ("Channel", sys_ns);
 265                         // ...what to write here?
 266                         w.WriteEndElement ();
 267                         w.WriteStartElement ("Computer");
 268                         w.WriteString ("localhost(dummy)");
 269                         w.WriteEndElement ();
 270
 271                         w.WriteEndElement ();
 272
 273                         // <ApplicationData>
 274                         w.WriteStartElement ("ApplicationData", e2e_ns);
 275                         w.WriteStartElement ("TraceData", e2e_ns);
 276                         foreach (object o in data) {
 277                                 if (wrapData)
 278                                         w.WriteStartElement ("DataItem", e2e_ns);
 279                                 if (o is XPathNavigator)
 280                                         // the output ignores xmlns difference between the parent (E2ETraceEvent and the content node).
 281                                         // To clone such behavior, I took this approach.
 282                                         w.WriteRaw (XPathNavigatorToString ((XPathNavigator) o));
 283                                 else if (o != null)
 284                                         w.WriteString (o.ToString ());
 285                                 if (wrapData)
 286                                         w.WriteEndElement ();
 287                         }
 288                         w.WriteEndElement ();
 289                         w.WriteEndElement ();
 290
 291                         w.WriteEndElement ();
 292
 293                         w.Flush (); // for XmlWriter
 294                         log_writer.WriteLine ();
 295                         log_writer.Flush (); // for TextWriter
 296                 }
 297
 298                 static readonly XmlWriterSettings xml_writer_settings = new XmlWriterSettings () { OmitXmlDeclaration = true };
 299
 300                 // I avoided OuterXml which includes indentation.
 301                 static string XPathNavigatorToString (XPathNavigator nav)
 302                 {
 303                         var sw = new StringWriter ();
 304                         using (var xw = XmlWriter.Create (sw, xml_writer_settings))
 305                                 nav.WriteSubtree (xw);
 306                         return sw.ToString ();
 307                 }
 308
 309                 static readonly string e2e_ns = "http://schemas.microsoft.com/2004/06/E2ETraceEvent";
 310                 static readonly string sys_ns = "http://schemas.microsoft.com/2004/06/windows/eventlog/system";
 311                 #endregion
 312         }
 313 }