Welcome to mirror list, hosted at ThFree Co, Russian Federation.

FileResult.cs « src « Http.Results « Http « src - github.com/dotnet/aspnetcore.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: d3be83f96f44ade5401aba92b09a66539c047bc7 (plain)
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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

using System.Diagnostics.CodeAnalysis;
using Microsoft.Extensions.Logging;
using Microsoft.Net.Http.Headers;

namespace Microsoft.AspNetCore.Http.Result;

internal abstract partial class FileResult
{
    private string? _fileDownloadName;

    /// <summary>
    /// Creates a new <see cref="FileResult"/> instance with
    /// the provided <paramref name="contentType"/>.
    /// </summary>
    /// <param name="contentType">The Content-Type header of the response.</param>
    protected FileResult(string? contentType)
    {
        ContentType = contentType ?? "application/octet-stream";
    }

    /// <summary>
    /// Gets the Content-Type header for the response.
    /// </summary>
    public string ContentType { get; }

    /// <summary>
    /// Gets the file name that will be used in the Content-Disposition header of the response.
    /// </summary>
    [AllowNull]
    public string FileDownloadName
    {
        get { return _fileDownloadName ?? string.Empty; }
        init { _fileDownloadName = value; }
    }

    /// <summary>
    /// Gets or sets the last modified information associated with the <see cref="FileResult"/>.
    /// </summary>
    public DateTimeOffset? LastModified { get; init; }

    /// <summary>
    /// Gets or sets the etag associated with the <see cref="FileResult"/>.
    /// </summary>
    public EntityTagHeaderValue? EntityTag { get; init; }

    /// <summary>
    /// Gets or sets the value that enables range processing for the <see cref="FileResult"/>.
    /// </summary>
    public bool EnableRangeProcessing { get; init; }

    protected static partial class Log
    {
        public static void ExecutingFileResult(ILogger logger, FileResult fileResult)
        {
            if (logger.IsEnabled(LogLevel.Information))
            {
                var fileResultType = fileResult.GetType().Name;
                ExecutingFileResultWithNoFileName(logger, fileResultType, fileResult.FileDownloadName);
            }
        }

        public static void ExecutingFileResult(ILogger logger, FileResult fileResult, string fileName)
        {
            if (logger.IsEnabled(LogLevel.Information))
            {
                var fileResultType = fileResult.GetType().Name;
                ExecutingFileResult(logger, fileResultType, fileName, fileResult.FileDownloadName);
            }
        }

        [LoggerMessage(1, LogLevel.Information,
            "Executing {FileResultType}, sending file with download name '{FileDownloadName}'.",
            EventName = "ExecutingFileResultWithNoFileName",
            SkipEnabledCheck = true)]
        private static partial void ExecutingFileResultWithNoFileName(ILogger logger, string fileResultType, string fileDownloadName);

        [LoggerMessage(2, LogLevel.Information,
            "Executing {FileResultType}, sending file '{FileDownloadPath}' with download name '{FileDownloadName}'.",
            EventName = "ExecutingFileResult",
            SkipEnabledCheck = true)]
        private static partial void ExecutingFileResult(ILogger logger, string fileResultType, string fileDownloadPath, string fileDownloadName);
    }
}