Webiant Logo Webiant Logo
  1. No results found.

    Try your search with a different keyword or use * as a wildcard.

AvalaraController.cs

using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Rendering;
using Nop.Core;
using Nop.Core.Domain.Common;
using Nop.Core.Domain.Directory;
using Nop.Plugin.Tax.Avalara.Domain;
using Nop.Plugin.Tax.Avalara.Models.Configuration;
using Nop.Plugin.Tax.Avalara.Services;
using Nop.Services;
using Nop.Services.Common;
using Nop.Services.Configuration;
using Nop.Services.Directory;
using Nop.Services.Localization;
using Nop.Services.Messages;
using Nop.Services.Security;
using Nop.Web.Areas.Admin.Factories;
using Nop.Web.Framework;
using Nop.Web.Framework.Controllers;
using Nop.Web.Framework.Factories;
using Nop.Web.Framework.Mvc.Filters;

namespace Nop.Plugin.Tax.Avalara.Controllers;

[Area(AreaNames.ADMIN)]
[AuthorizeAdmin]
[AutoValidateAntiforgeryToken]
public class AvalaraController : BasePluginController
{
    #region Fields

    protected readonly IAclSupportedModelFactory _aclSupportedModelFactory;
    protected readonly AvalaraTaxManager _avalaraTaxManager;
    protected readonly AvalaraTaxSettings _avalaraTaxSettings;
    protected readonly CurrencySettings _currencySettings;
    protected readonly IBaseAdminModelFactory _baseAdminModelFactory;
    protected readonly ICountryService _countryService;
    protected readonly ICurrencyService _currencyService;
    protected readonly IGenericAttributeService _genericAttributeService;
    protected readonly ILocalizationService _localizationService;
    protected readonly INotificationService _notificationService;
    protected readonly IPermissionService _permissionService;
    protected readonly ISettingService _settingService;
    protected readonly IWorkContext _workContext;

    #endregion

    #region Ctor

    public AvalaraController(IAclSupportedModelFactory aclSupportedModelFactory,
        AvalaraTaxManager avalaraTaxManager,
        AvalaraTaxSettings avalaraTaxSettings,
        CurrencySettings currencySettings,
        IBaseAdminModelFactory baseAdminModelFactory,
        ICountryService countryService,
        ICurrencyService currencyService,
        IGenericAttributeService genericAttributeService,
        ILocalizationService localizationService,
        INotificationService notificationService,
        IPermissionService permissionService,
        ISettingService settingService,
        IWorkContext workContext)
    {
        _aclSupportedModelFactory = aclSupportedModelFactory;
        _avalaraTaxManager = avalaraTaxManager;
        _avalaraTaxSettings = avalaraTaxSettings;
        _currencySettings = currencySettings;
        _baseAdminModelFactory = baseAdminModelFactory;
        _countryService = countryService;
        _currencyService = currencyService;
        _genericAttributeService = genericAttributeService;
        _localizationService = localizationService;
        _notificationService = notificationService;
        _permissionService = permissionService;
        _settingService = settingService;
        _workContext = workContext;
    }

    #endregion

    #region Methods

    public async Task Configure(string testTaxResult = null)
    {
        if (!await _permissionService.AuthorizeAsync(StandardPermissionProvider.ManageTaxSettings))
            return AccessDeniedView();

        var customer = await _workContext.GetCurrentCustomerAsync();

        var model = new ConfigurationModel
        {
            AccountId = _avalaraTaxSettings.AccountId,
            LicenseKey = _avalaraTaxSettings.LicenseKey,
            CompanyCode = _avalaraTaxSettings.CompanyCode,
            UseSandbox = _avalaraTaxSettings.UseSandbox,
            UseItemClassification = _avalaraTaxSettings.UseItemClassification,
            CommitTransactions = _avalaraTaxSettings.CommitTransactions,
            ValidateAddress = _avalaraTaxSettings.ValidateAddress,
            TaxOriginAddressTypeId = (int)_avalaraTaxSettings.TaxOriginAddressType,
            EnableLogging = _avalaraTaxSettings.EnableLogging,
            UseTaxRateTables = _avalaraTaxSettings.UseTaxRateTables,
            GetTaxRateByAddressOnly = _avalaraTaxSettings.GetTaxRateByAddressOnly,
            EnableCertificates = _avalaraTaxSettings.EnableCertificates,
            AutoValidateCertificate = _avalaraTaxSettings.AutoValidateCertificate,
            AllowEditCustomer = _avalaraTaxSettings.AllowEditCustomer,
            DisplayNoValidCertificatesMessage = _avalaraTaxSettings.DisplayNoValidCertificatesMessage,
            SelectedCustomerRoleIds = _avalaraTaxSettings.CustomerRoleIds,
            SelectedCountryIds = _avalaraTaxSettings.SelectedCountryIds,
            TestTaxResult = testTaxResult
        };
        model.IsConfigured = !string.IsNullOrEmpty(_avalaraTaxSettings.AccountId) && !string.IsNullOrEmpty(_avalaraTaxSettings.LicenseKey);
        model.TaxOriginAddressTypes = (await TaxOriginAddressType.DefaultTaxAddress.ToSelectListAsync(false))
            .Select(type => new SelectListItem(type.Text, type.Value)).ToList();
        model.HideGeneralBlock = await _genericAttributeService.GetAttributeAsync(customer, AvalaraTaxDefaults.HideGeneralBlock);
        model.HideItemClassificationBlock = await _genericAttributeService.GetAttributeAsync(customer, AvalaraTaxDefaults.HideItemClassificationBlock);
        model.HideLogBlock = await _genericAttributeService.GetAttributeAsync(customer, AvalaraTaxDefaults.HideLogBlock);

        //prepare model customer roles
        await _aclSupportedModelFactory.PrepareModelCustomerRolesAsync(model);

        //prepare available of item classification countries (for sync)
        await _baseAdminModelFactory.PrepareCountriesAsync(model.AvailableCountries, false);

        //prepare item classification search model
        model.ItemClassificationSearchModel.AvailableCountries = (await _countryService
                .GetCountriesByIdsAsync(_avalaraTaxSettings.SelectedCountryIds?.ToArray()))
            .Select(country => new SelectListItem(country.Name, country.Id.ToString()))
            .ToList();
        model.ItemClassificationSearchModel.AvailableCountries.Insert(0, new SelectListItem { Text = "*", Value = "0" });

        model.ItemClassificationSearchModel.SetGridPageSize();

        //prepare address model
        await _baseAdminModelFactory.PrepareCountriesAsync(model.TestAddress.AvailableCountries);
        await _baseAdminModelFactory.PrepareStatesAndProvincesAsync(model.TestAddress.AvailableStates, model.TestAddress.CountryId);

        //prepare tax transaction log model
        model.TaxTransactionLogSearchModel.SetGridPageSize();

        //get active account companies
        var activeCompanies = model.IsConfigured ? await _avalaraTaxManager.GetAccountCompaniesAsync() : null;
        if (activeCompanies?.Any() ?? false)
        {
            model.Companies = activeCompanies.OrderBy(company => company.isDefault ?? false ? 0 : 1).Select(company => new SelectListItem
            {
                Text = company.isTest ?? false ? $"{company.name} (Test)" : company.name,
                Value = company.companyCode
            }).ToList();
        }

        var defaultCompanyCode = _avalaraTaxSettings.CompanyCode;
        if (!model.Companies.Any())
        {
            //add the special item for 'there are no companies' with empty guid value
            var noCompaniesText = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Fields.Company.NotExist");
            model.Companies.Add(new SelectListItem { Text = noCompaniesText, Value = Guid.Empty.ToString() });
            defaultCompanyCode = Guid.Empty.ToString();
        }
        else if (string.IsNullOrEmpty(_avalaraTaxSettings.CompanyCode) || _avalaraTaxSettings.CompanyCode.Equals(Guid.Empty.ToString()))
            defaultCompanyCode = model.Companies.FirstOrDefault()?.Value;

        //set the default company
        var selectedCompany = activeCompanies?.FirstOrDefault(company => company.companyCode.Equals(defaultCompanyCode));
        model.CompanyCode = defaultCompanyCode;
        _avalaraTaxSettings.CompanyCode = defaultCompanyCode;
        _avalaraTaxSettings.CompanyId = selectedCompany?.id;
        await _settingService.SaveSettingAsync(_avalaraTaxSettings);

        //display warning in case of company currency differ from the primary store currency
        var primaryCurrency = await _currencyService.GetCurrencyByIdAsync(_currencySettings.PrimaryStoreCurrencyId);
        if (!selectedCompany?.baseCurrencyCode?.Equals(primaryCurrency?.CurrencyCode, StringComparison.InvariantCultureIgnoreCase) ?? false)
        {
            var warning = string.Format(await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Fields.Company.Currency.Warning"),
                selectedCompany.name, selectedCompany.baseCurrencyCode, primaryCurrency?.CurrencyCode);
            _notificationService.WarningNotification(warning);
        }

        return View("~/Plugins/Tax.Avalara/Views/Configuration/Configure.cshtml", model);
    }

    [HttpPost, ActionName("Configure")]
    [FormValueRequired("save")]
    public async Task Configure(ConfigurationModel model)
    {
        if (!await _permissionService.AuthorizeAsync(StandardPermissionProvider.ManageTaxSettings))
            return AccessDeniedView();

        if (!ModelState.IsValid)
            return await Configure();

        _avalaraTaxSettings.AccountId = model.AccountId;
        _avalaraTaxSettings.LicenseKey = model.LicenseKey;
        _avalaraTaxSettings.CompanyCode = model.CompanyCode;
        _avalaraTaxSettings.UseSandbox = model.UseSandbox;
        _avalaraTaxSettings.CommitTransactions = model.CommitTransactions;
        _avalaraTaxSettings.ValidateAddress = model.ValidateAddress;
        _avalaraTaxSettings.TaxOriginAddressType = (TaxOriginAddressType)model.TaxOriginAddressTypeId;
        _avalaraTaxSettings.EnableLogging = model.EnableLogging;
        _avalaraTaxSettings.UseTaxRateTables = model.UseTaxRateTables;
        _avalaraTaxSettings.GetTaxRateByAddressOnly = model.GetTaxRateByAddressOnly;
        _avalaraTaxSettings.EnableCertificates = model.EnableCertificates;
        _avalaraTaxSettings.AutoValidateCertificate = model.AutoValidateCertificate;
        _avalaraTaxSettings.AllowEditCustomer = model.AllowEditCustomer;
        _avalaraTaxSettings.DisplayNoValidCertificatesMessage = model.DisplayNoValidCertificatesMessage;
        _avalaraTaxSettings.CustomerRoleIds = model.SelectedCustomerRoleIds.ToList();
        await _settingService.SaveSettingAsync(_avalaraTaxSettings);

        _notificationService.SuccessNotification(await _localizationService.GetResourceAsync("Admin.Plugins.Saved"));

        return await Configure();
    }

    [HttpPost, ActionName("Configure")]
    [FormValueRequired("saveIC")]
    public async Task SaveItemClassification(ConfigurationModel model)
    {
        if (!await _permissionService.AuthorizeAsync(StandardPermissionProvider.ManageTaxSettings))
            return AccessDeniedView();

        if (!ModelState.IsValid)
            return await Configure();

        _avalaraTaxSettings.SelectedCountryIds = model.SelectedCountryIds.ToList();
        _avalaraTaxSettings.UseItemClassification = model.UseItemClassification;
        await _settingService.SaveSettingAsync(_avalaraTaxSettings);

        _notificationService.SuccessNotification(await _localizationService.GetResourceAsync("Admin.Plugins.Saved"));

        return await Configure();
    }

    [HttpPost, ActionName("Configure")]
    [FormValueRequired("check-credentials")]
    public async Task CheckCredentials()
    {
        if (!await _permissionService.AuthorizeAsync(StandardPermissionProvider.ManageTaxSettings))
            return AccessDeniedView();

        //verify credentials
        var credentials = await _avalaraTaxManager.PingAsync();
        if (credentials?.authenticated ?? false)
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Configuration.Credentials.Verified");
            _notificationService.SuccessNotification(locale);
        }
        else
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Configuration.Credentials.Declined");
            _notificationService.ErrorNotification(locale);
        }

        //check certificate setup status
        var status = await _avalaraTaxManager.GetCertificateSetupStatusAsync();
        if (status is null)
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Configuration.Certificates.NotProvisioned");
            _notificationService.ErrorNotification(locale);
        }
        else if (status == false)
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Configuration.Certificates.InProgress");
            _notificationService.WarningNotification(locale);
        }
        else
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Configuration.Certificates.Provisioned");
            _notificationService.SuccessNotification(locale);
        }

        return await Configure();
    }

    [HttpPost, ActionName("Configure")]
    [FormValueRequired("request-certificate-setup")]
    public async Task RequestCertificateSetup()
    {
        if (!await _permissionService.AuthorizeAsync(StandardPermissionProvider.ManageTaxSettings))
            return AccessDeniedView();

        //request the certificate setup and display current status
        var status = await _avalaraTaxManager.GetCertificateSetupStatusAsync(true);
        if (status is null)
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Configuration.Certificates.NotProvisioned");
            _notificationService.ErrorNotification(locale);
        }
        else if (status == false)
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Configuration.Certificates.InProgress");
            _notificationService.WarningNotification(locale);
        }
        else
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Configuration.Certificates.Provisioned");
            _notificationService.SuccessNotification(locale);
        }

        return await Configure();
    }

    [HttpPost, ActionName("Configure")]
    [FormValueRequired("test-tax")]
    public async Task TestTaxRequest(ConfigurationModel model)
    {
        if (!await _permissionService.AuthorizeAsync(StandardPermissionProvider.ManageTaxSettings))
            return AccessDeniedView();

        if (!ModelState.IsValid)
            return await Configure();

        //get result
        var transaction = await _avalaraTaxManager.CreateTestTaxTransactionAsync(new Address
        {
            City = model.TestAddress?.City,
            CountryId = model.TestAddress?.CountryId,
            Address1 = model.TestAddress?.Address1,
            ZipPostalCode = model.TestAddress?.ZipPostalCode,
            StateProvinceId = model.TestAddress?.StateProvinceId
        });

        var testTaxResult = string.Empty;
        if (transaction?.totalTax != null)
        {
            //display tax rates by jurisdictions
            testTaxResult = $"Total tax rate: {transaction.totalTax:0.000}% {Environment.NewLine}";
            if (transaction.summary?.Any() ?? false)
            {
                testTaxResult = transaction.summary.Aggregate(testTaxResult, (resultString, rate) =>
                    $"{resultString}Jurisdiction: {rate?.jurisName}, Tax rate: {(rate?.rate ?? 0) * 100:0.000}% {Environment.NewLine}");
            }
            _notificationService.SuccessNotification(await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.TestTax.Success"));
        }
        else
            _notificationService.ErrorNotification(await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.TestTax.Error"));

        return await Configure(testTaxResult);
    }

    public async Task ChangeOriginAddressType(int typeId)
    {
        var message = (TaxOriginAddressType)typeId switch
        {
            TaxOriginAddressType.ShippingOrigin => string.Format(await _localizationService
                .GetResourceAsync("Plugins.Tax.Avalara.Fields.TaxOriginAddressType.ShippingOrigin.Warning"), Url.Action("Shipping", "Setting")),
            TaxOriginAddressType.DefaultTaxAddress => string.Format(await _localizationService
                .GetResourceAsync("Plugins.Tax.Avalara.Fields.TaxOriginAddressType.DefaultTaxAddress.Warning"), Url.Action("Tax", "Setting")),
            _ => null
        };

        return Json(new { Result = message });
    }

    public async Task ChangeEnableCertificates(bool enabled)
    {
        var message = string.Empty;
        if (enabled)
        {
            var locale = await _localizationService.GetResourceAsync("Plugins.Tax.Avalara.Fields.EnableCertificates.Warning");
            message = string.Format(locale, Url.Action("CustomerUser", "Setting"));
        }

        return Json(new { Result = message });
    }

    #endregion
}