Reporting for ASP.NET MVC - Custom Report Parameter Types

C#
using DevExpress.XtraReports.Native;

namespace CustomParameterEditorAspNetMvcExample {
    public class CustomDataSerializer : IDataSerializer {
        public const string Name = "myCustomDataSerializer";

        public bool CanDeserialize(string value, string typeName, object extensionProvider) {
            return typeName == typeof(CustomParameterType).FullName;
        }

        public bool CanSerialize(object data, object extensionProvider) {
            return data is CustomParameterType;
        }

        public object Deserialize(string value, string typeName, object extensionProvider) {
            if (typeName == typeof(CustomParameterType).FullName) {
                return new CustomParameterType { Value = value };
            }
            return null;
        }

        public string Serialize(object data, object extensionProvider) {
            var parameter = data as CustomParameterType;
            return parameter != null ? parameter.Value : null;
        }
    }
}

Visual Basic
Imports DevExpress.XtraReports.Native

Public Class CustomDataSerializer
    Implements IDataSerializer

    Public Const Name As String = "myCustomDataSerializer"

    Public Function CanDeserialize(
                                  ByVal value As String, ByVal typeName As String,
                                  ByVal extensionProvider As Object
                                  ) As Boolean Implements IDataSerializer.CanDeserialize
        Return typeName = GetType(CustomParameterType).FullName
    End Function

    Public Function CanSerialize(
                                ByVal data As Object,
                                ByVal extensionProvider As Object
                                ) As Boolean Implements IDataSerializer.CanSerialize
        Return TypeOf data Is CustomParameterType
    End Function

    Public Function Deserialize(
                               ByVal value As String,
                               ByVal typeName As String,
                               ByVal extensionProvider As Object
                               ) As Object Implements IDataSerializer.Deserialize
        If typeName = GetType(CustomParameterType).FullName Then
            Return New CustomParameterType With {.Value = value}
        End If
        Return Nothing
    End Function

    Public Function Serialize(
                             ByVal data As Object,
                             ByVal extensionProvider As Object
                             ) As String Implements IDataSerializer.Serialize
        Dim parameter = TryCast(data, CustomParameterType)
        Return If(parameter IsNot Nothing, parameter.Value, Nothing)
    End Function
End Class

C#
using System;
using System.ComponentModel;
using System.Globalization;

namespace CustomParameterEditorAspNetMvcExample {
    [TypeConverter(typeof(CustomParameterTypeConverter))]
    public class CustomParameterType {
        public string Value { get; set; }
        public override string ToString() {
            return Value;
        }
    }

    public class CustomParameterTypeConverter : TypeConverter {
        public override object ConvertTo(ITypeDescriptorContext context,
            CultureInfo culture, object value, Type destinationType) {
            if (destinationType == typeof(string)) {
                return ((CustomParameterType)value).Value;
            }
            return base.ConvertTo(context, culture, value, destinationType);
        }
        public override bool CanConvertTo(ITypeDescriptorContext context,
            Type destinationType) {
            return destinationType == typeof(string) ||
                base.CanConvertTo(context, destinationType);
        }

        public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType) {
            return sourceType == typeof(string) || base.CanConvertFrom(context, sourceType);
        }
        public override object ConvertFrom(ITypeDescriptorContext context,
            CultureInfo culture, object value) {
            var valueString = value as string;
            if (valueString != null) {
                return new CustomParameterType { Value = valueString };
            }
            return base.ConvertFrom(context, culture, value);
        }
    }
}

Visual Basic
Imports System
Imports System.ComponentModel
Imports System.Globalization

<TypeConverter(GetType(CustomParameterTypeConverter))>
Public Class CustomParameterType
    Public Property Value() As String
    Public Overrides Function ToString() As String
        Return Value
    End Function
End Class

Public Class CustomParameterTypeConverter
    Inherits TypeConverter

    Public Overrides Function ConvertTo(
                                       ByVal context As ITypeDescriptorContext,
                                       ByVal culture As CultureInfo,
                                       ByVal value As Object,
                                       ByVal destinationType As Type) As Object
        If destinationType Is GetType(String) Then
            Return DirectCast(value, CustomParameterType).Value
        End If
        Return MyBase.ConvertTo(context, culture, value, destinationType)
    End Function
    Public Overrides Function CanConvertTo(
                                          ByVal context As ITypeDescriptorContext,
                                          ByVal destinationType As Type
                                          ) As Boolean
        Return destinationType Is GetType(String) OrElse
            MyBase.CanConvertTo(context, destinationType)
    End Function

    Public Overrides Function CanConvertFrom(
                                            ByVal context As ITypeDescriptorContext,
                                            ByVal sourceType As Type
                                            ) As Boolean
        Return sourceType Is GetType(String) OrElse
            MyBase.CanConvertFrom(context, sourceType)
    End Function
    Public Overrides Function ConvertFrom(
                                         ByVal context As ITypeDescriptorContext,
                                         ByVal culture As CultureInfo,
                                         ByVal value As Object
                                         ) As Object
        Dim valueString = TryCast(value, String)
        If valueString IsNot Nothing Then
            Return New CustomParameterType With {.Value = valueString}
        End If
        Return MyBase.ConvertFrom(context, culture, value)
    End Function
End Class

C#
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using System.ServiceModel;
using DevExpress.XtraReports.Web.Extensions;
using DevExpress.XtraReports.UI;
using CustomParameterEditorAspNetMvcExample.PredefinedReports;

namespace CustomParameterEditorAspNetMvcExample.Services {
    public class CustomReportStorageWebExtension : DevExpress.XtraReports.Web.Extensions.ReportStorageWebExtension {
        readonly string reportDirectory;
        const string FileExtension = ".repx";
        public CustomReportStorageWebExtension(string reportDirectory) {
            if (!Directory.Exists(reportDirectory)) {
                Directory.CreateDirectory(reportDirectory);
            }
            this.reportDirectory = reportDirectory;
        }

        public override bool CanSetData(string url) {
            // Determines whether or not it is possible to store a report by a given URL. 
            // For instance, make the CanSetData method return false for reports that should be read-only in your storage. 
            // This method is called only for valid URLs (i.e., if the IsValidUrl method returned true) before the SetData method is called.

            return true;
        }

        public override bool IsValidUrl(string url) {
            // Determines whether or not the URL passed to the current Report Storage is valid. 
            // For instance, implement your own logic to prohibit URLs that contain white spaces or some other special characters. 
            // This method is called before the CanSetData and GetData methods.

            return Path.GetFileName(url) == url;
        }

        public override byte[] GetData(string url) {
            // Returns report layout data stored in a Report Storage using the specified URL. 
            // This method is called only for valid URLs after the IsValidUrl method is called.
            try {
                if (Directory.EnumerateFiles(reportDirectory).Select(Path.GetFileNameWithoutExtension).Contains(url)) {
                    return File.ReadAllBytes(Path.Combine(reportDirectory, url + FileExtension));
                }
                if (ReportsFactory.Reports.ContainsKey(url)) {
                    using (MemoryStream ms = new MemoryStream()) {
                        ReportsFactory.Reports[url]().SaveLayoutToXml(ms);
                        return ms.ToArray();
                    }
                }
            }
            catch (Exception) {
                throw new FaultException(new FaultReason("Could not get report data."), new FaultCode("Server"), "GetData");
            }
            throw new FaultException(new FaultReason(string.Format("Could not find report '{0}'.", url)), new FaultCode("Server"), "GetData");
        }

        public override Dictionary<string, string> GetUrls() {
            // Returns a dictionary of the existing report URLs and display names. 
            // This method is called when running the Report Designer, 
            // before the Open Report and Save Report dialogs are shown and after a new report is saved to a storage.

            return Directory.GetFiles(reportDirectory, "*" + FileExtension)
                                     .Select(Path.GetFileNameWithoutExtension)
                                     .Union(ReportsFactory.Reports.Select(x => x.Key))
                                     .ToDictionary<string, string>(x => x);
        }

        public override void SetData(XtraReport report, string url) {
            // Stores the specified report to a Report Storage using the specified URL. 
            // This method is called only after the IsValidUrl and CanSetData methods are called.
            var resolvedUrl = Path.GetFullPath(Path.Combine(reportDirectory, url + FileExtension));
            if (!resolvedUrl.StartsWith(reportDirectory + Path.DirectorySeparatorChar)) {
                throw new FaultException("Invalid report name.");
            }

            report.SaveLayoutToXml(resolvedUrl);
        }
        public override string SetNewData(XtraReport report, string defaultUrl) {
            // Stores the specified report using a new URL. 
            // The IsValidUrl and CanSetData methods are never called before this method. 
            // You can validate and correct the specified URL directly in the SetNewData method implementation 
            // and return the resulting URL used to save a report in your storage.
            SetData(report, defaultUrl);
            return defaultUrl;
        }
    }
}

Visual Basic
Imports System.IO
Imports System.ServiceModel
Imports CustomParameterEditorAspNetMvcExample.PredefinedReports
Imports DevExpress.XtraReports.UI

Namespace Services
    Public Class CustomReportStorageWebExtension
        Inherits DevExpress.XtraReports.Web.Extensions.ReportStorageWebExtension

        Private ReadOnly reportDirectory As String
        Private Const FileExtension As String = ".repx"
        Public Sub New(ByVal reportDirectory As String)
            If Not Directory.Exists(reportDirectory) Then
                Directory.CreateDirectory(reportDirectory)
            End If
            Me.reportDirectory = reportDirectory
        End Sub

        Public Overrides Function CanSetData(ByVal url As String) As Boolean
            ' Determines whether or not it is possible to store a report by a given URL. 
            ' For instance, make the CanSetData method return false for reports that should be read-only in your storage. 
            ' This method is called only for valid URLs (i.e., if the IsValidUrl method returned true) before the SetData method is called.

            Return True
        End Function

        Public Overrides Function IsValidUrl(ByVal url As String) As Boolean
            ' Determines whether or not the URL passed to the current Report Storage is valid. 
            ' For instance, implement your own logic to prohibit URLs that contain white spaces or some other special characters. 
            ' This method is called before the CanSetData and GetData methods.

            Return Path.GetFileName(url) = url
        End Function

        Public Overrides Function GetData(ByVal url As String) As Byte()
            ' Returns report layout data stored in a Report Storage using the specified URL. 
            ' This method is called only for valid URLs after the IsValidUrl method is called.
            Try
                If Directory.EnumerateFiles(reportDirectory).Select(AddressOf Path.GetFileNameWithoutExtension).Contains(url) Then
                    Return File.ReadAllBytes(Path.Combine(reportDirectory, url & FileExtension))
                End If
                If ReportsFactory.Reports.ContainsKey(url) Then
                    Using ms As New MemoryStream()
                        ReportsFactory.Reports(url)().SaveLayoutToXml(ms)
                        Return ms.ToArray()
                    End Using
                End If
            Catch e1 As Exception
                Throw New FaultException(New FaultReason("Could not get report data."), New FaultCode("Server"), "GetData")
            End Try
            Throw New FaultException(New FaultReason(String.Format("Could not find report '{0}'.", url)), New FaultCode("Server"), "GetData")
        End Function

        Public Overrides Function GetUrls() As Dictionary(Of String, String)
            ' Returns a dictionary of the existing report URLs and display names. 
            ' This method is called when running the Report Designer, 
            ' before the Open Report and Save Report dialogs are shown and after a new report is saved to a storage.

            Return Directory.GetFiles(reportDirectory, "*" & FileExtension).Select(AddressOf Path.GetFileNameWithoutExtension).Concat(ReportsFactory.Reports.Select(Function(x) x.Key)).ToDictionary(Function(x) x)
        End Function

#Region "SetData"
        Public Overrides Sub SetData(ByVal report As XtraReport, ByVal url As String)
            ' Stores the specified report to a Report Storage using the specified URL. 
            ' This method is called only after the IsValidUrl and CanSetData methods are called.
            Dim resolvedUrl = Path.GetFullPath(Path.Combine(reportDirectory, url + FileExtension))
            If Not resolvedUrl.StartsWith(reportDirectory + Path.DirectorySeparatorChar) Then
                Throw New FaultException("Invalid report name.")
            End If

            report.SaveLayoutToXml(resolvedUrl)
        End Sub
#End Region

        Public Overrides Function SetNewData(ByVal report As XtraReport, ByVal defaultUrl As String) As String
            ' Stores the specified report using a new URL. 
            ' The IsValidUrl and CanSetData methods are never called before this method. 
            ' You can validate and correct the specified URL directly in the SetNewData method implementation 
            ' and return the resulting URL used to save a report in your storage.
            SetData(report, defaultUrl)
            Return defaultUrl
        End Function
    End Class
End Namespace

C#
using DevExpress.XtraReports.Native;
using System.Web.Mvc;

namespace CustomParameterEditorAspNetMvcExample.Controllers {
    public class HomeController : Controller {
        public ActionResult Index() {
            return View();
        }

        public ActionResult Designer() {
            var report = new DevExpress.XtraReports.UI.XtraReport();
            report.Extensions[SerializationService.Guid] = CustomDataSerializer.Name;
            return View(report);
        }

        public ActionResult Viewer() {
            return View();
        }
    }
}

Visual Basic
Imports DevExpress.XtraReports.Native

Public Class HomeController
    Inherits System.Web.Mvc.Controller

    Function Index() As ActionResult
        Return View()
    End Function
    Function Designer() As ActionResult
        Dim report = New DevExpress.XtraReports.UI.XtraReport()
        report.Extensions(SerializationService.Guid) = CustomDataSerializer.Name
        Return View(report)
    End Function
    Function Viewer() As ActionResult
        Return View()
    End Function
End Class