Code:
/ 4.0 / 4.0 / DEVDIV_TFS / Dev10 / Releases / RTMRel / ndp / fx / src / CompMod / System / Diagnostics / TextWriterTraceListener.cs / 1305376 / TextWriterTraceListener.cs
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
/*
*/
namespace System.Diagnostics {
using System;
using System.IO;
using System.Text;
using System.Security.Permissions;
using System.Runtime.InteropServices;
using System.IO.Ports;
using Microsoft.Win32;
using System.Runtime.Versioning;
///
/// Directs tracing or debugging output to
/// a
///
[HostProtection(Synchronization=true)]
public class TextWriterTraceListener : TraceListener {
internal TextWriter writer;
String fileName = null;
///
/// Initializes a new instance of the
///
public TextWriterTraceListener() {
}
///
/// Initializes a new instance of the
///
public TextWriterTraceListener(Stream stream)
: this(stream, string.Empty) {
}
///
/// Initializes a new instance of the
///
public TextWriterTraceListener(Stream stream, string name)
: base(name) {
if (stream == null) throw new ArgumentNullException("stream");
this.writer = new StreamWriter(stream);
}
///
/// Initializes a new instance of the
///
public TextWriterTraceListener(TextWriter writer)
: this(writer, string.Empty) {
}
///
/// Initializes a new instance of the
///
public TextWriterTraceListener(TextWriter writer, string name)
: base(name) {
if (writer == null) throw new ArgumentNullException("writer");
this.writer = writer;
}
///
/// [To be supplied.]
///
[ResourceExposure(ResourceScope.Machine)]
public TextWriterTraceListener(string fileName) {
this.fileName = fileName;
}
///
/// [To be supplied.]
///
[ResourceExposure(ResourceScope.Machine)]
public TextWriterTraceListener(string fileName, string name) : base(name) {
this.fileName = fileName;
}
///
/// Indicates the text writer that receives the tracing
/// or debugging output.
///
public TextWriter Writer {
get {
EnsureWriter();
return writer;
}
set {
writer = value;
}
}
///
/// Closes the
///
public override void Close() {
if (writer != null) {
try {
writer.Close();
} catch (ObjectDisposedException) { }
}
writer = null;
}
///
///
protected override void Dispose(bool disposing) {
try {
if (disposing) {
this.Close();
}
else {
// clean up resources
if (writer != null)
try {
writer.Close();
} catch (ObjectDisposedException) { }
writer = null;
}
}
finally {
base.Dispose(disposing);
}
}
///
/// Flushes the output buffer for the
///
public override void Flush() {
if (!EnsureWriter()) return;
try {
writer.Flush();
} catch (ObjectDisposedException) { }
}
///
/// Writes a message
/// to this instance's
///
public override void Write(string message) {
if (!EnsureWriter()) return;
if (NeedIndent) WriteIndent();
try {
writer.Write(message);
} catch (ObjectDisposedException) { }
}
///
/// Writes a message
/// to this instance's
///
public override void WriteLine(string message) {
if (!EnsureWriter()) return;
if (NeedIndent) WriteIndent();
try {
writer.WriteLine(message);
NeedIndent = true;
} catch (ObjectDisposedException) { }
}
private static Encoding GetEncodingWithFallback(Encoding encoding)
{
// Clone it and set the "?" replacement fallback
Encoding fallbackEncoding = (Encoding)encoding.Clone();
fallbackEncoding.EncoderFallback = EncoderFallback.ReplacementFallback;
fallbackEncoding.DecoderFallback = DecoderFallback.ReplacementFallback;
return fallbackEncoding;
}
// This uses a machine resource, scoped by the fileName variable.
[ResourceExposure(ResourceScope.None)]
[ResourceConsumption(ResourceScope.Machine, ResourceScope.Machine)]
internal bool EnsureWriter() {
bool ret = true;
if (writer == null) {
ret = false;
if (fileName == null)
return ret;
// StreamWriter by default uses UTF8Encoding which will throw on invalid encoding errors.
// This can cause the internal StreamWriter's state to be irrecoverable. It is bad for tracing
// APIs to throw on encoding errors. Instead, we should provide a "?" replacement fallback
// encoding to substitute illegal chars. For ex, In case of high surrogate character
// D800-DBFF without a following low surrogate character DC00-DFFF
// NOTE: We also need to use an encoding that does't emit BOM whic is StreamWriter's default
Encoding noBOMwithFallback = GetEncodingWithFallback(new UTF8Encoding(false));
// To support multiple appdomains/instances tracing to the same file,
// we will try to open the given file for append but if we encounter
// IO errors, we will prefix the file name with a unique GUID value
// and try one more time
string fullPath = Path.GetFullPath(fileName);
string dirPath = Path.GetDirectoryName(fullPath);
string fileNameOnly = Path.GetFileName(fullPath);
for (int i=0; i<2; i++) {
try {
writer = new StreamWriter(fullPath, true, noBOMwithFallback, 4096);
ret = true;
break;
}
catch (IOException ) {
// Should we do this only for ERROR_SHARING_VIOLATION?
//if (InternalResources.MakeErrorCodeFromHR(Marshal.GetHRForException(ioexc)) == InternalResources.ERROR_SHARING_VIOLATION) {
fileNameOnly = Guid.NewGuid().ToString() + fileNameOnly;
fullPath = Path.Combine(dirPath, fileNameOnly);
continue;
}
catch (UnauthorizedAccessException ) {
//ERROR_ACCESS_DENIED, mostly ACL issues
break;
}
catch (Exception ) {
break;
}
}
if (!ret) {
// Disable tracing to this listener. Every Write will be nop.
// We need to think of a central way to deal with the listener
// init errors in the future. The default should be that we eat
// up any errors from listener and optionally notify the user
fileName = null;
}
}
return ret;
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
//------------------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//-----------------------------------------------------------------------------
/*
*/
namespace System.Diagnostics {
using System;
using System.IO;
using System.Text;
using System.Security.Permissions;
using System.Runtime.InteropServices;
using System.IO.Ports;
using Microsoft.Win32;
using System.Runtime.Versioning;
///
/// Directs tracing or debugging output to
/// a
///
[HostProtection(Synchronization=true)]
public class TextWriterTraceListener : TraceListener {
internal TextWriter writer;
String fileName = null;
///
/// Initializes a new instance of the
///
public TextWriterTraceListener() {
}
///
/// Initializes a new instance of the
///
public TextWriterTraceListener(Stream stream)
: this(stream, string.Empty) {
}
///
/// Initializes a new instance of the
///
public TextWriterTraceListener(Stream stream, string name)
: base(name) {
if (stream == null) throw new ArgumentNullException("stream");
this.writer = new StreamWriter(stream);
}
///
/// Initializes a new instance of the
///
public TextWriterTraceListener(TextWriter writer)
: this(writer, string.Empty) {
}
///
/// Initializes a new instance of the
///
public TextWriterTraceListener(TextWriter writer, string name)
: base(name) {
if (writer == null) throw new ArgumentNullException("writer");
this.writer = writer;
}
///
/// [To be supplied.]
///
[ResourceExposure(ResourceScope.Machine)]
public TextWriterTraceListener(string fileName) {
this.fileName = fileName;
}
///
/// [To be supplied.]
///
[ResourceExposure(ResourceScope.Machine)]
public TextWriterTraceListener(string fileName, string name) : base(name) {
this.fileName = fileName;
}
///
/// Indicates the text writer that receives the tracing
/// or debugging output.
///
public TextWriter Writer {
get {
EnsureWriter();
return writer;
}
set {
writer = value;
}
}
///
/// Closes the
///
public override void Close() {
if (writer != null) {
try {
writer.Close();
} catch (ObjectDisposedException) { }
}
writer = null;
}
///
///
protected override void Dispose(bool disposing) {
try {
if (disposing) {
this.Close();
}
else {
// clean up resources
if (writer != null)
try {
writer.Close();
} catch (ObjectDisposedException) { }
writer = null;
}
}
finally {
base.Dispose(disposing);
}
}
///
/// Flushes the output buffer for the
///
public override void Flush() {
if (!EnsureWriter()) return;
try {
writer.Flush();
} catch (ObjectDisposedException) { }
}
///
/// Writes a message
/// to this instance's
///
public override void Write(string message) {
if (!EnsureWriter()) return;
if (NeedIndent) WriteIndent();
try {
writer.Write(message);
} catch (ObjectDisposedException) { }
}
///
/// Writes a message
/// to this instance's
///
public override void WriteLine(string message) {
if (!EnsureWriter()) return;
if (NeedIndent) WriteIndent();
try {
writer.WriteLine(message);
NeedIndent = true;
} catch (ObjectDisposedException) { }
}
private static Encoding GetEncodingWithFallback(Encoding encoding)
{
// Clone it and set the "?" replacement fallback
Encoding fallbackEncoding = (Encoding)encoding.Clone();
fallbackEncoding.EncoderFallback = EncoderFallback.ReplacementFallback;
fallbackEncoding.DecoderFallback = DecoderFallback.ReplacementFallback;
return fallbackEncoding;
}
// This uses a machine resource, scoped by the fileName variable.
[ResourceExposure(ResourceScope.None)]
[ResourceConsumption(ResourceScope.Machine, ResourceScope.Machine)]
internal bool EnsureWriter() {
bool ret = true;
if (writer == null) {
ret = false;
if (fileName == null)
return ret;
// StreamWriter by default uses UTF8Encoding which will throw on invalid encoding errors.
// This can cause the internal StreamWriter's state to be irrecoverable. It is bad for tracing
// APIs to throw on encoding errors. Instead, we should provide a "?" replacement fallback
// encoding to substitute illegal chars. For ex, In case of high surrogate character
// D800-DBFF without a following low surrogate character DC00-DFFF
// NOTE: We also need to use an encoding that does't emit BOM whic is StreamWriter's default
Encoding noBOMwithFallback = GetEncodingWithFallback(new UTF8Encoding(false));
// To support multiple appdomains/instances tracing to the same file,
// we will try to open the given file for append but if we encounter
// IO errors, we will prefix the file name with a unique GUID value
// and try one more time
string fullPath = Path.GetFullPath(fileName);
string dirPath = Path.GetDirectoryName(fullPath);
string fileNameOnly = Path.GetFileName(fullPath);
for (int i=0; i<2; i++) {
try {
writer = new StreamWriter(fullPath, true, noBOMwithFallback, 4096);
ret = true;
break;
}
catch (IOException ) {
// Should we do this only for ERROR_SHARING_VIOLATION?
//if (InternalResources.MakeErrorCodeFromHR(Marshal.GetHRForException(ioexc)) == InternalResources.ERROR_SHARING_VIOLATION) {
fileNameOnly = Guid.NewGuid().ToString() + fileNameOnly;
fullPath = Path.Combine(dirPath, fileNameOnly);
continue;
}
catch (UnauthorizedAccessException ) {
//ERROR_ACCESS_DENIED, mostly ACL issues
break;
}
catch (Exception ) {
break;
}
}
if (!ret) {
// Disable tracing to this listener. Every Write will be nop.
// We need to think of a central way to deal with the listener
// init errors in the future. The default should be that we eat
// up any errors from listener and optionally notify the user
fileName = null;
}
}
return ret;
}
}
}
// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
Link Menu
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- ObjectDataSourceFilteringEventArgs.cs
- LambdaSerializationException.cs
- StateMachineSubscriptionManager.cs
- XmlDataSourceView.cs
- GlobalizationAssembly.cs
- WsdlHelpGeneratorElement.cs
- PieceNameHelper.cs
- DrawingVisual.cs
- ForEach.cs
- OrderPreservingPipeliningMergeHelper.cs
- DefaultShape.cs
- NamespaceListProperty.cs
- ObjectComplexPropertyMapping.cs
- AppSettingsSection.cs
- PropertyChangedEventManager.cs
- ExpressionBuilderContext.cs
- InputQueueChannel.cs
- WebHttpSecurityModeHelper.cs
- SpinWait.cs
- EnumConverter.cs
- DummyDataSource.cs
- XmlSchemaImport.cs
- OdbcDataReader.cs
- DataTable.cs
- RedirectionProxy.cs
- WebPartHelpVerb.cs
- ExtenderProvidedPropertyAttribute.cs
- Hex.cs
- SimpleBitVector32.cs
- DataPointer.cs
- MobileControlPersister.cs
- HandleCollector.cs
- PrtCap_Builder.cs
- SHA512.cs
- GroupItem.cs
- StringStorage.cs
- SingleResultAttribute.cs
- HttpCachePolicyWrapper.cs
- AuthenticationSchemesHelper.cs
- _NetworkingPerfCounters.cs
- ProfileProvider.cs
- CompositeControlDesigner.cs
- ReservationNotFoundException.cs
- DependencyPropertyChangedEventArgs.cs
- AutoResetEvent.cs
- HttpCapabilitiesBase.cs
- IDReferencePropertyAttribute.cs
- DialogResultConverter.cs
- WpfSharedBamlSchemaContext.cs
- ConfigurationManagerHelper.cs
- OAVariantLib.cs
- LicenseException.cs
- PictureBox.cs
- SafeSerializationManager.cs
- WebBrowserBase.cs
- securitymgrsite.cs
- VolatileEnlistmentState.cs
- NonBatchDirectoryCompiler.cs
- ILGenerator.cs
- StorageEntityContainerMapping.cs
- DataSetSchema.cs
- DateTimeUtil.cs
- SoapUnknownHeader.cs
- FrameworkName.cs
- ListViewVirtualItemsSelectionRangeChangedEvent.cs
- EndEvent.cs
- ResXResourceReader.cs
- UnicastIPAddressInformationCollection.cs
- SmiRequestExecutor.cs
- ThicknessAnimationUsingKeyFrames.cs
- StringTraceRecord.cs
- GridViewSortEventArgs.cs
- FixedDocument.cs
- XmlSchemaAnyAttribute.cs
- WindowsBrush.cs
- OutputCacheProfile.cs
- RuntimeConfig.cs
- HttpCacheVaryByContentEncodings.cs
- UIHelper.cs
- BindingCollection.cs
- LinqExpressionNormalizer.cs
- CreateUserWizard.cs
- ObjectToken.cs
- DataListItem.cs
- XmlElement.cs
- TryCatchDesigner.xaml.cs
- CompressedStack.cs
- TypeValidationEventArgs.cs
- ActiveXSite.cs
- Monitor.cs
- ExpressionEditorAttribute.cs
- path.cs
- RepeaterItemEventArgs.cs
- ComboBoxAutomationPeer.cs
- CodeCatchClauseCollection.cs
- SectionVisual.cs
- QueuePropertyVariants.cs
- FixedElement.cs
- ControlTemplate.cs
- PageThemeParser.cs