File: ViewLocalizer.cs
Web Access
Project: src\src\Mvc\Mvc.Localization\src\Microsoft.AspNetCore.Mvc.Localization.csproj (Microsoft.AspNetCore.Mvc.Localization)
// 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;
using System.Text;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Mvc.Rendering;
using Microsoft.AspNetCore.Mvc.ViewFeatures;
using Microsoft.Extensions.Localization;
 
namespace Microsoft.AspNetCore.Mvc.Localization;
 
/// <summary>
/// An <see cref="IViewLocalizer"/> implementation that derives the resource location from the executing view's
/// file path.
/// </summary>
public class ViewLocalizer : IViewLocalizer, IViewContextAware
{
    private readonly IHtmlLocalizerFactory _localizerFactory;
    private readonly string _applicationName;
    private IHtmlLocalizer _localizer = default!;
 
    /// <summary>
    /// Creates a new <see cref="ViewLocalizer"/>.
    /// </summary>
    /// <param name="localizerFactory">The <see cref="IHtmlLocalizerFactory"/>.</param>
    /// <param name="hostingEnvironment">The <see cref="IWebHostEnvironment"/>.</param>
    public ViewLocalizer(IHtmlLocalizerFactory localizerFactory, IWebHostEnvironment hostingEnvironment)
    {
        ArgumentNullException.ThrowIfNull(localizerFactory);
        ArgumentNullException.ThrowIfNull(hostingEnvironment);
 
        if (string.IsNullOrEmpty(hostingEnvironment.ApplicationName))
        {
            throw new InvalidOperationException($"{nameof(hostingEnvironment)}.ApplicationName must have a value.");
        }
 
        _applicationName = hostingEnvironment.ApplicationName;
        _localizerFactory = localizerFactory;
    }
 
    /// <inheritdoc />
    public virtual LocalizedHtmlString this[string key]
    {
        get
        {
            ArgumentNullException.ThrowIfNull(key);
 
            return _localizer[key];
        }
    }
 
    /// <inheritdoc />
    public virtual LocalizedHtmlString this[string key, params object[] arguments]
    {
        get
        {
            ArgumentNullException.ThrowIfNull(key);
 
            return _localizer[key, arguments];
        }
    }
 
    /// <inheritdoc />
    public LocalizedString GetString(string name) => _localizer.GetString(name);
 
    /// <inheritdoc />
    public LocalizedString GetString(string name, params object[] values) => _localizer.GetString(name, values);
 
    /// <inheritdoc />
    public IEnumerable<LocalizedString> GetAllStrings(bool includeParentCultures) =>
        _localizer.GetAllStrings(includeParentCultures);
 
    /// <summary>
    /// Apply the specified <see cref="ViewContext"/>.
    /// </summary>
    /// <param name="viewContext">The <see cref="ViewContext"/>.</param>
    public void Contextualize(ViewContext viewContext)
    {
        ArgumentNullException.ThrowIfNull(viewContext);
 
        // Given a view path "/Views/Home/Index.cshtml" we want a baseName like "MyApplication.Views.Home.Index"
        var path = viewContext.ExecutingFilePath;
 
        if (string.IsNullOrEmpty(path))
        {
            path = viewContext.View.Path;
        }
 
        Debug.Assert(!string.IsNullOrEmpty(path), "Couldn't determine a path for the view");
 
        _localizer = _localizerFactory.Create(BuildBaseName(path), _applicationName);
    }
 
    private string BuildBaseName(string path)
    {
        var extension = Path.GetExtension(path);
        var startIndex = path[0] == '/' || path[0] == '\\' ? 1 : 0;
        var length = path.Length - startIndex - extension.Length;
        var capacity = length + _applicationName.Length + 1;
        var builder = new StringBuilder(path, startIndex, length, capacity);
 
        builder.Replace('/', '.').Replace('\\', '.');
 
        // Prepend the application name
        builder.Insert(0, '.');
        builder.Insert(0, _applicationName);
 
        return builder.ToString();
    }
}