Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Template content validation #16944

Merged
merged 7 commits into from
Nov 5, 2024
Merged

Template content validation #16944

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ea9e0a7
DRY template validation.
sarahelsaig Nov 1, 2024
6d3191f
If both name and content are wrong then both should show error indepe…
sarahelsaig Nov 1, 2024
06810df
Add missing asp-validation-for.
sarahelsaig Nov 1, 2024
7b02fe7
Add note about Placements.
sarahelsaig Nov 1, 2024
27a2719
Update src/OrchardCore.Modules/OrchardCore.Templates/Controllers/Temp…
sarahelsaig Nov 2, 2024
a5f8ccf
Add OrchardCore.Placements.csproj reference to avoid hard coding acti…
sarahelsaig Nov 2, 2024
d830f84
Merge branch 'main' into template-content-validation
hishamco Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 30 additions & 32 deletions src/OrchardCore.Modules/OrchardCore.Templates/Controllers/TemplateController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,26 +164,7 @@ public async Task<IActionResult> CreatePost(TemplateViewModel model, string subm

if (ModelState.IsValid)
{
if (string.IsNullOrWhiteSpace(model.Name))
{
ModelState.AddModelError(nameof(TemplateViewModel.Name), S["The name is mandatory."]);
}
else if (string.IsNullOrWhiteSpace(model.Content))
{
ModelState.AddModelError(nameof(TemplateViewModel.Content), S["The content is mandatory."]);
}
else
{
var templatesDocument = model.AdminTemplates
? await _adminTemplatesManager.GetTemplatesDocumentAsync()
: await _templatesManager.GetTemplatesDocumentAsync()
;

if (templatesDocument.Templates.ContainsKey(model.Name))
{
ModelState.AddModelError(nameof(TemplateViewModel.Name), S["A template with the same name already exists."]);
}
}
await ValidateModelAsync(model);
}

if (ModelState.IsValid)
Expand Down Expand Up @@ -265,18 +246,7 @@ public async Task<IActionResult> Edit(string sourceName, TemplateViewModel model

if (ModelState.IsValid)
{
if (string.IsNullOrWhiteSpace(model.Name))
{
ModelState.AddModelError(nameof(TemplateViewModel.Name), S["The name is mandatory."]);
}
else if (!model.Name.Equals(sourceName, StringComparison.OrdinalIgnoreCase) && templatesDocument.Templates.ContainsKey(model.Name))
{
ModelState.AddModelError(nameof(TemplateViewModel.Name), S["A template with the same name already exists."]);
}
else if (string.IsNullOrWhiteSpace(model.Content))
{
ModelState.AddModelError(nameof(TemplateViewModel.Content), S["The content is mandatory."]);
}
await ValidateModelAsync(model, templatesDocument, sourceName);
}

if (!templatesDocument.Templates.ContainsKey(sourceName))
Expand Down Expand Up @@ -395,4 +365,32 @@ private IActionResult RedirectToReturnUrlOrIndex(string returnUrl)
return RedirectToAction(nameof(Index));
}
}

private async Task ValidateModelAsync(TemplateViewModel model, TemplatesDocument templatesDocument = null, string sourceName = null)
{
if (string.IsNullOrWhiteSpace(model.Name))
{
ModelState.AddModelError(nameof(TemplateViewModel.Name), S["The name is mandatory."]);
}
else
{
templatesDocument ??= model.AdminTemplates
? await _adminTemplatesManager.GetTemplatesDocumentAsync()
: await _templatesManager.GetTemplatesDocumentAsync();

if (!model.Name.Equals(sourceName, StringComparison.OrdinalIgnoreCase) &&
templatesDocument.Templates.ContainsKey(model.Name))
{
ModelState.AddModelError(nameof(TemplateViewModel.Name), S["A template with the same name already exists."]);
}
}

if (string.IsNullOrWhiteSpace(model.Content))
{
var placementsLink = Url.ActionLink("Index", "Admin", new { area = "OrchardCore.Placements" });
sarahelsaig marked this conversation as resolved.
Show resolved Hide resolved
var docsLink = "https://docs.orchardcore.net/en/main/reference/modules/Placements/";
sarahelsaig marked this conversation as resolved.
Show resolved Hide resolved
await _notifier.WarningAsync(H["If you left the content empty because you want to hide the shape, use <a href=\"{0}\">Placements</a> instead. See <a href=\"{1}\">the docs</a> for more info about this feature.", placementsLink, docsLink]);
ModelState.AddModelError(nameof(TemplateViewModel.Content), S["The content is mandatory."]);
}
}
}
1 change: 1 addition & 0 deletions src/OrchardCore.Modules/OrchardCore.Templates/Views/Template/Create.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
<label asp-for="Content" class="form-label">@T["Content"]</label>
<div id="@Html.IdFor(x => x.Content)_editor" asp-for="Text" style="min-height: 600px;" class="form-control" dir="@culture.GetLanguageDirection()"></div>
<textarea asp-for="Content" class="content-preview-text" hidden>@Html.Raw(Model.Content)</textarea>
<span asp-validation-for="Content"></span>
<span class="hint">@T["The Liquid template."]</span>
</div>
</form>
Expand Down