oqtane.framework/Oqtane.Client/Modules/Admin/ModuleCreator/Index.razor

@namespace Oqtane.Modules.Admin.ModuleCreator
@inherits ModuleBase
@inject NavigationManager NavigationManager
@inject IModuleDefinitionService ModuleDefinitionService
@inject IModuleService ModuleService
@inject ISystemService SystemService
@inject ISettingService SettingService
@inject IStringLocalizer<Index> Localizer
@using System.Text.RegularExpressions
@using System.IO;

@if (string.IsNullOrEmpty(_moduledefinitionname) && _systeminfo != null && _templates != null)
{
    <table class="table table-borderless">
        <tr>
            <td>
                <Label For="owner" HelpText="Enter the name of the organization who is developing this module. It should not contain spaces or punctuation." ResourceKey="OwnerName">Owner Name: </Label>
            </td>
            <td>
                <input id="owner" class="form-control" @bind="@_owner" />
            </td>
        </tr>
        <tr>
            <td>
                <Label For="module" HelpText="Enter a name for this module. It should not contain spaces or punctuation." ResourceKey="ModuleName">Module Name: </Label>
            </td>
            <td>
                <input id="module" class="form-control" @bind="@_module" />
            </td>
        </tr>
        <tr>
            <td>
                <Label For="description" HelpText="Enter a short description for the module" ResourceKey="Description">Description: </Label>
            </td>
            <td>
                <textarea id="description" class="form-control" @bind="@_description" rows="3"></textarea>
            </td>
        </tr>
        <tr>
            <td>
                <Label For="template" HelpText="Select a module template. Templates are located in the wwwroot/Modules/Templates folder on the server." ResourceKey="Template">Template: </Label>
            </td>
            <td>
                <select id="template" class="form-control" @onchange="(e => TemplateChanged(e))">
                    <option value="-">&lt;@Localizer["Select Template"]&gt;</option>
                    @foreach (string template in _templates)
                    {
                        <option value="@template">@template</option>
                    }
                </select>
            </td>
        </tr>
        <tr>
            <td>
                <Label For="reference" HelpText="Select a framework reference version" ResourceKey="FrameworkReference">Framework Reference: </Label>
            </td>
            <td>
                <select id="reference" class="form-control" @bind="@_reference">
                    @foreach (string version in Constants.ReleaseVersions.Split(','))
                    {
                        if (Version.Parse(version).CompareTo(Version.Parse("2.0.0")) >= 0)
                        {
                            <option value="@(version)">@(version)</option>
                        }
                    }
                    <option value="local">@Localizer["Local Version"]</option>
                </select>
            </td>
        </tr>
        @if (!string.IsNullOrEmpty(_location))
        {
            <tr>
                <td>
                    <Label For="location" HelpText="Location where the module will be created" ResourceKey="Location">Location: </Label>
                </td>
                <td>
                    <input id="module" class="form-control" @bind="@_location" readonly />
                </td>
            </tr>
        }
    </table>
    <button type="button" class="btn btn-success" @onclick="CreateModule">@Localizer["Create Module"]</button>
}
else
{
    <button type="button" class="btn btn-success" @onclick="ActivateModule">@Localizer["Activate Module"]</button>
}

@code {
    private string _moduledefinitionname = string.Empty;
    private string _owner = string.Empty;
    private string _module = string.Empty;
    private string _description = string.Empty;
    private string _template = "-";
    private string _reference = Constants.Version;
    private string _location = string.Empty;

    private Dictionary<string, string> _systeminfo;
    private List<string> _templates;

    public override SecurityAccessLevel SecurityAccessLevel => SecurityAccessLevel.Host;

    protected override async Task OnParametersSetAsync()
    {
        try
        {
            _moduledefinitionname = SettingService.GetSetting(ModuleState.Settings, "ModuleDefinitionName", "");
            _systeminfo = await SystemService.GetSystemInfoAsync();
            _templates = await ModuleDefinitionService.GetModuleDefinitionTemplatesAsync();

            if (string.IsNullOrEmpty(_moduledefinitionname))
            {
                AddModuleMessage(Localizer["Please Note That The Module Creator Is Only Intended To Be Used In A Development Environment"], MessageType.Info);
            }
            else
            {
                AddModuleMessage(Localizer["Once You Have Compiled The Module And Restarted The Application You Can Activate The Module Below"], MessageType.Info);
            }
        }
        catch (Exception ex)
        {
            await logger.LogError(ex, "Error Loading Module Creator");
        }
    }

    private async Task CreateModule()
    {
        try
        {
            if (IsValid(_owner) && IsValid(_module) && _owner != _module && _template != "-")
            {
                var moduleDefinition = new ModuleDefinition { Owner = _owner, Name = _module, Description = _description, Template = _template, Version = _reference };
                moduleDefinition = await ModuleDefinitionService.CreateModuleDefinitionAsync(moduleDefinition);

                var settings = ModuleState.Settings;
                SettingService.SetSetting(settings, "ModuleDefinitionName", moduleDefinition.ModuleDefinitionName);
                await SettingService.UpdateModuleSettingsAsync(settings, ModuleState.ModuleId);

                GetLocation();

                AddModuleMessage(Localizer["The Source Code For Your Module Has Been Created At The Location Specified Below And Must Be Compiled In Order To Make It Functional. Once It Has Been Compiled You Must <a href=\"{0}\">Restart</a> Your Application To Apply These Changes.", NavigateUrl("admin/system")], MessageType.Success);
            }
            else
            {
                AddModuleMessage(Localizer["You Must Provide A Valid Owner Name And Module Name ( ie. No Punctuation Or Spaces And The Values Cannot Be The Same ) And Choose A Template"], MessageType.Warning);
            }
        }
        catch (Exception ex)
        {
            await logger.LogError(ex, "Error Creating Module");
        }
    }

    private async Task ActivateModule()
    {
        try
        {
            if (!string.IsNullOrEmpty(_moduledefinitionname))
            {
                Module module = await ModuleService.GetModuleAsync(ModuleState.ModuleId);
                module.ModuleDefinitionName = _moduledefinitionname;
                await ModuleService.UpdateModuleAsync(module);
                NavigationManager.NavigateTo(NavigateUrl(), true);
            }
        }
        catch (Exception ex)
        {
            await logger.LogError(ex, "Error Activating Module");
        }
    }

    private bool IsValid(string name)
    {
        // must contain letters, underscores and digits and first character must be letter or underscore
        return !string.IsNullOrEmpty(name) && Regex.IsMatch(name, "^[A-Za-z_][A-Za-z0-9_]*$");
    }

    private void TemplateChanged(ChangeEventArgs e)
    {
        _template = (string)e.Value;
        GetLocation();
    }

    private void GetLocation()
    {
        _location = string.Empty;
        if (_template != "-" && _systeminfo != null && _systeminfo.ContainsKey("serverpath"))
        {
            string[] path = _systeminfo["serverpath"].Split(Path.DirectorySeparatorChar);
            _location = string.Join(Path.DirectorySeparatorChar, path, 0, path.Length - 2) +
                Path.DirectorySeparatorChar + _owner + "." + _module;
        }
        StateHasChanged();
    }
}