#30588 Audit sample fixed.

Author: prochan2

Diagnostics/PostSharp.Samples.Logging.Audit/Audit/AuditAttribute.cs

@@ -0,0 +1,27 @@
+using PostSharp.Patterns.Diagnostics;
+using PostSharp.Samples.Logging.Audit.Audit.Backend;
+
+namespace PostSharp.Samples.Logging.Audit.Audit
+{
+  /// <summary>
+  /// Custom attribute that, when applied to a method, causes PostSharp to audit execution of this method. Whenever an audited method is executed, the 
+  /// <see cref="AuditServices.RecordPublished"/> event is raised. You need to register your own logic to the <see cref="AuditServices.RecordPublished"/> event,
+  /// for instance to append the record to a database table.
+  /// </summary>
+  /// <remarks>
+  /// <para>Audit is a special kind of logging. The <see cref="AuditAttribute"/> aspects adds logging with the <c>Audit</c> profile, which is by default served
+  /// by the <see cref="AuditBackend"/> back-end, which exposes a simple API to the <see cref="AuditServices"/> class.
+  /// </para>
+  /// <para>The <see cref="AuditAttribute"/> aspect can be used side-by-side with the <see cref="LogAttribute"/> aspect.</para>
+  /// </remarks>
+  public sealed class AuditAttribute : LogAttributeBase
+  {
+    /// <summary>
+    /// Initializes a new <see cref="AuditAttribute"/>.
+    /// </summary>
+    public AuditAttribute()
+    {
+      this.ProfileName = "Audit";
+    }
+  }
+}

Diagnostics/PostSharp.Samples.Logging.Audit/Audit/AuditRecord.cs

@@ -0,0 +1,87 @@
+using System;
+using PostSharp.Patterns.Diagnostics;
+
+namespace PostSharp.Samples.Logging.Audit.Audit
+{
+  /// <summary>
+  /// Represents an audit record published by the <see cref="AuditServices.RecordPublished"/> event.
+  /// </summary>
+  /// <remarks>
+  /// <para>
+  /// You can customize this class by inheritance. In this case, you also need to customize the <see cref="AuditBackend"/> and
+  /// <see cref="AuditRecordBuilder"/> classes.
+  /// </para>
+  /// </remarks>
+  public class AuditRecord
+  {
+    /// <summary>
+    /// Initializes a new <see cref="AuditRecord"/>.
+    /// </summary>
+    /// <param name="declaringType">Declaring type of the audited method.</param>
+    /// <param name="memberName">Name of the audited method.</param>
+    /// <param name="recordKind">Kind of record (typically <see cref="LogRecordKind.MethodSuccess"/> or <see cref="LogRecordKind.MethodException"/>).</param>
+    public AuditRecord(Type declaringType, string memberName, LogRecordKind recordKind)
+    {
+      this.MemberName = memberName;
+      this.RecordKind = recordKind;
+      this.DeclaringType = declaringType;
+      this.Time = DateTime.Now;
+    }
+
+    /// <summary>
+    /// Gets the time when the execution ended.
+    /// </summary>
+    public DateTime Time
+    {
+      get;
+    }
+
+    /// <summary>
+    /// Gets the declaring type of the method.
+    /// </summary>
+    public Type DeclaringType
+    {
+      get;
+    }
+
+    /// <summary>
+    /// Gets the name of the method.
+    /// </summary>
+    public string MemberName
+    {
+      get;
+    }
+
+    /// <summary>
+    /// Gets the kind of record (typically <see cref="LogRecordKind.MethodSuccess"/> or <see cref="LogRecordKind.MethodException"/>). 
+    /// </summary>
+    public LogRecordKind RecordKind
+    {
+      get;
+    }
+
+    /// <summary>
+    /// Gets a string describing the operation (typically, the method type, name, and parameters).
+    /// </summary>
+    public string Text
+    {
+      get; set;
+    }
+
+    /// <summary>
+    /// Gets the <see cref="Exception"/> if the method failed, or <c>null</c> if the method succeeded.
+    /// </summary>
+    public Exception Exception
+    {
+      get; set;
+    }
+
+    /// <summary>
+    /// Gets the instance on which the method was executed, or <c>null</c> if the method is a static method.
+    /// </summary>
+    public object Target
+    {
+      get; set;
+    }
+  }
+}

Diagnostics/PostSharp.Samples.Logging.Audit/Audit/AuditRecordEventArgs.cs

@@ -0,0 +1,27 @@
+using System;
+
+namespace PostSharp.Samples.Logging.Audit.Audit
+{
+  /// <summary>
+  /// Arguments of the <see cref="AuditServices.RecordPublished"/> event.
+  /// </summary>
+  public class AuditRecordEventArgs : EventArgs
+  {
+    /// <summary>
+    /// Gets the published record.
+    /// </summary>
+    public AuditRecord Record
+    {
+      get;
+    }
+
+    /// <summary>
+    /// Initializes a new <see cref="AuditRecordEventArgs"/>.
+    /// </summary>
+    /// <param name="record">The published <see cref="AuditRecord"/>.</param>
+    public AuditRecordEventArgs(AuditRecord record)
+    {
+      this.Record = record;
+    }
+  }
+}

Diagnostics/PostSharp.Samples.Logging.Audit/Audit/AuditServices.cs

@@ -0,0 +1,20 @@
+using System;
+
+namespace PostSharp.Samples.Logging.Audit.Audit
+{
+  /// <summary>
+  /// Exposes a <see cref="RecordPublished"/> event, which is raised whenever an audited method is executed.
+  /// </summary>
+  public static class AuditServices
+  {
+    internal static void PublishRecord(AuditRecord currentRecord)
+    {
+      RecordPublished?.Invoke(null, new AuditRecordEventArgs(currentRecord));
+    }
+
+    /// <summary>
+    /// Event raised whenever an audited method is executed.
+    /// </summary>
+    public static event EventHandler<AuditRecordEventArgs> RecordPublished;
+  }
+}

Diagnostics/PostSharp.Samples.Logging.Audit/Audit/Backend/AuditBackend.cs

@@ -0,0 +1,51 @@
+using PostSharp.Patterns.Diagnostics;
+using PostSharp.Patterns.Diagnostics.Backends;
+using PostSharp.Patterns.Diagnostics.RecordBuilders;
+using System;
+
+namespace PostSharp.Samples.Logging.Audit.Audit.Backend
+{
+  /// <summary>
+  /// A specialized back-end that publishes audit records to the <see cref="AuditServices.RecordPublished"/> event.
+  /// </summary>
+  public class AuditBackend : TextLoggingBackend
+  {
+    /// <summary>
+    /// Initializes a new <see cref="AuditBackend"/>.
+    /// </summary>
+    public AuditBackend()
+    {
+    }
+
+
+    /// <summary>
+    /// Publishes an <see cref="AuditRecord"/> to the <see cref="AuditServices.RecordPublished"/> event.
+    /// </summary>
+    /// <param name="record"></param>
+    public virtual void PublishRecord(AuditRecord record)
+    {
+      AuditServices.PublishRecord(record);
+    }
+
+
+    /// <inheritdoc />
+    protected override LoggingTypeSource CreateTypeSource(LoggingNamespaceSource parent, Type type)
+    {
+      return new AuditTypeSource(parent, type);
+    }
+
+    /// <inheritdoc />
+    public override LogRecordBuilder CreateRecordBuilder()
+    {
+      return new AuditRecordBuilder(this);
+    }
+
+    /// <summary>
+    /// Gets the back-end options.
+    /// </summary>
+    public new AuditBackendOptions Options { get; } = new AuditBackendOptions();
+
+    /// <inheritdoc />
+    protected override TextLoggingBackendOptions GetTextBackendOptions() => this.Options;
+  }
+}

Diagnostics/PostSharp.Samples.Logging.Audit/Audit/Backend/AuditBackendOptions.cs

@@ -0,0 +1,18 @@
+using PostSharp.Patterns.Diagnostics.Backends;
+
+namespace PostSharp.Samples.Logging.Audit.Audit.Backend
+{
+  /// <summary>
+  /// Options of <see cref="AuditBackend"/>.
+  /// </summary>
+  public class AuditBackendOptions : TextLoggingBackendOptions
+  {
+    /// <summary>
+    /// Initializes a new <see cref="AuditBackendOptions"/>.
+    /// </summary>
+    public AuditBackendOptions()
+    {
+      this.IndentSpaces = 0;
+    }
+  }
+}

Diagnostics/PostSharp.Samples.Logging.Audit/Audit/Backend/AuditRecordBuilder.cs

@@ -0,0 +1,90 @@
+using PostSharp.Patterns.Diagnostics.Contexts;
+using PostSharp.Patterns.Diagnostics.RecordBuilders;
+using PostSharp.Patterns.Formatters;
+using System;
+
+namespace PostSharp.Samples.Logging.Audit.Audit.Backend
+{
+  /// <summary>
+  /// Record builder for the <see cref="AuditBackend"/>.
+  /// </summary>
+  public class AuditRecordBuilder : TextLogRecordBuilder
+  {
+
+    /// <summary>
+    /// Creates an <see cref="AuditRecord"/>.
+    /// </summary>
+    /// <param name="context">The context of the record.</param>
+    /// <param name="recordInfo">Information about the record.</param>
+    /// <param name="memberInfo">Information about the method, property, or field.</param>
+    /// <returns>An <see cref="AuditRecord"/>.</returns>
+    protected virtual AuditRecord CreateRecord(LoggingContext context, ref LogRecordInfo recordInfo, ref LogMemberInfo memberInfo)
+    {
+#pragma warning disable CS0618 // Type or member is obsolete
+      return new AuditRecord(memberInfo.Source.SourceType, memberInfo.MemberName, recordInfo.RecordKind);
+#pragma warning restore CS0618 // Type or member is obsolete
+    }
+
+    /// <inheritdoc />
+    public override void BeginRecord(LoggingContext context, ref LogRecordInfo recordInfo, ref LogMemberInfo memberInfo)
+    {
+      base.BeginRecord(context, ref recordInfo, ref memberInfo);
+
+      this.CurrentRecord = this.CreateRecord(context, ref recordInfo, ref memberInfo);
+
+    }
+
+    /// <summary>
+    /// Gets the current <see cref="AuditBackend"/>.
+    /// </summary>
+    public new AuditBackend Backend
+    {
+      get;
+    }
+
+    /// <summary>
+    /// Initializes a new <see cref="AuditRecordBuilder"/>.
+    /// </summary>
+    /// <param name="backend">The parent <see cref="AuditBackend"/>.</param>
+    public AuditRecordBuilder(AuditBackend backend) : base(backend)
+    {
+      this.Backend = backend;
+    }
+
+    /// <summary>
+    /// Gets the <see cref="AuditRecord"/> being currently built.
+    /// </summary>
+    public AuditRecord CurrentRecord
+    {
+      get; private set;
+    }
+
+    /// <inheritdoc />
+    public override void SetException(Exception exception)
+    {
+      base.SetException(exception);
+
+      this.CurrentRecord.Exception = exception;
+    }
+
+    /// <inheritdoc />
+    public override void SetThis<T>(T value, IFormatter<T> formatter)
+    {
+      // We don't want to include the value in the text.
+      // base.SetThis<T>(value, formatter);
+
+      this.CurrentRecord.Target = value;
+    }
+
+    /// <inheritdoc />
+    protected override void Write(UnsafeString message)
+    {
+      if (this.CurrentRecord != null)
+      {
+        this.CurrentRecord.Text = this.Context.Description.ToString();
+        this.Backend.PublishRecord(this.CurrentRecord);
+        this.CurrentRecord = null;
+      }
+    }
+  }
+}

Diagnostics/PostSharp.Samples.Logging.Audit/Audit/Backend/AuditTypeSource.cs

@@ -0,0 +1,26 @@
+using PostSharp.Patterns.Diagnostics;
+using System;
+
+namespace PostSharp.Samples.Logging.Audit.Audit.Backend
+{
+  /// <summary>
+  /// Represents a type logged using the <see cref="AuditBackend"/>.
+  /// </summary>
+  public class AuditTypeSource : LoggingTypeSource
+  {
+    /// <summary>
+    /// Initializes a new <see cref="AuditTypeSource"/>.
+    /// </summary>
+    /// <param name="parent">The parent <see cref="LoggingNamespaceSource"/>.</param>
+    /// <param name="type">The declaring type of audited methods.</param>
+    public AuditTypeSource(LoggingNamespaceSource parent, Type type) : base(parent, type.FullName, type)
+    {
+    }
+
+    /// <inheritdoc />
+    protected override bool IsBackendEnabled(LogLevel level)
+    {
+      return true;
+    }
+  }
+}