From e27523fea11fbdf7cf58bf9479ff0bfbebf303ae Mon Sep 17 00:00:00 2001
From: sunnavy <sunnavy@bestpractical.com>
Date: Fri, 3 Nov 2023 13:27:24 -0400
Subject: [PATCH] Add required attribute for mandatory custom field inputs

The attribute isn't enabled for radio/checkbox inputs. "(no value)"
passes the "required" limitation for radio, which makes it useless. For
checkbox, "required" indicates all "required" checkbox inputs(even with
the same name) must be checked, which is not what want either.
---
 share/html/Admin/CustomFields/Modify.html       |  2 +-
 share/html/Admin/Queues/DefaultValues.html      |  5 +++++
 share/html/Elements/EditCustomField             |  1 +
 share/html/Elements/EditCustomFieldAutocomplete | 10 +++++++++-
 share/html/Elements/EditCustomFieldBinary       |  7 ++++++-
 share/html/Elements/EditCustomFieldCombobox     |  2 ++
 share/html/Elements/EditCustomFieldDate         |  3 ++-
 share/html/Elements/EditCustomFieldDateTime     |  3 ++-
 share/html/Elements/EditCustomFieldFreeform     |  7 +++++++
 share/html/Elements/EditCustomFieldHTML         |  4 ++++
 share/html/Elements/EditCustomFieldImage        |  7 ++++++-
 share/html/Elements/EditCustomFieldSelect       |  4 ++++
 share/html/Elements/EditCustomFieldText         |  4 ++++
 share/html/Elements/EditCustomFieldWikitext     |  4 ++++
 share/html/Elements/EditCustomFields            |  1 +
 share/html/Elements/SelectDate                  |  4 ++++
 share/html/Widgets/ComboBox                     |  3 ++-
 17 files changed, 64 insertions(+), 7 deletions(-)

diff --git a/share/html/Admin/CustomFields/Modify.html b/share/html/Admin/CustomFields/Modify.html
index beee4675a0c..180966fad6a 100644
--- a/share/html/Admin/CustomFields/Modify.html
+++ b/share/html/Admin/CustomFields/Modify.html
@@ -181,7 +181,7 @@
 % if ( $CustomFieldObj->SupportDefaultValues ) {
 <&| /Elements/LabeledValue, Label => loc("Default [numerate,_1,value,values]", $CustomFieldObj->MaxValues),
     Class => $default_value_class &>
-  <& /Elements/EditCustomField, NamePrefix => 'Default-', CustomField => $CustomFieldObj, ShowEmptyOption => 1 &>
+  <& /Elements/EditCustomField, NamePrefix => 'Default-', CustomField => $CustomFieldObj, ShowEmptyOption => 1, Required => 0 &>
 </&>
 % }
 
diff --git a/share/html/Admin/Queues/DefaultValues.html b/share/html/Admin/Queues/DefaultValues.html
index 0cde0c46ddd..dca52fa81ac 100644
--- a/share/html/Admin/Queues/DefaultValues.html
+++ b/share/html/Admin/Queues/DefaultValues.html
@@ -68,6 +68,7 @@
       CustomFields => $queue->TicketCustomFields->LimitToDefaultValuesSupportedTypes,
       Grouping => 'Basics',
       CategoryObj => $queue,
+      Required => 0,
   &>
 
   <&| /Elements/LabeledValue, Label => loc('Article') &>
@@ -91,6 +92,7 @@
       CustomFields => $queue->TicketCustomFields->LimitToDefaultValuesSupportedTypes,
       Grouping => 'Dates',
       CategoryObj => $queue,
+      Required => 0,
   &>
   </&>
 </div>
@@ -103,6 +105,7 @@
       CustomFields => $queue->TicketCustomFields->LimitToDefaultValuesSupportedTypes,
       Grouping => 'People',
       CategoryObj => $queue,
+      Required => 0,
   &>
   </&>
 </div>
@@ -116,6 +119,7 @@
       CustomFields => $queue->TicketCustomFields->LimitToDefaultValuesSupportedTypes,
       Grouping => 'Links',
       CategoryObj => $queue,
+      Required => 0,
   &>
   </&>
 </div>
@@ -126,6 +130,7 @@
     Object => RT::Ticket->new($session{CurrentUser}),
     Groupings => \@groupings,
     CategoryObj => $queue,
+    Required => 0,
 &>
 
 <div class="ticket-info-cfs">
diff --git a/share/html/Elements/EditCustomField b/share/html/Elements/EditCustomField
index c088917ee70..b2e75720642 100644
--- a/share/html/Elements/EditCustomField
+++ b/share/html/Elements/EditCustomField
@@ -162,4 +162,5 @@ $Rows        => 5
 $Cols        => 15
 $Default     => undef
 $DefaultsFromTopArguments => 1,
+$Required    => undef
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldAutocomplete b/share/html/Elements/EditCustomFieldAutocomplete
index 40104555ae7..2acef923d7c 100644
--- a/share/html/Elements/EditCustomFieldAutocomplete
+++ b/share/html/Elements/EditCustomFieldAutocomplete
@@ -53,6 +53,9 @@ cols="<% $Cols %>" \
 % if ( defined $Rows ) {
 rows="<% $Rows %>" \
 % }
+% if ( $Required ) {
+required
+% }
 name="<% $name %>" id="<% $name %>" class="CF-<%$CustomField->id%>-Edit form-control"><% $Default || '' %></textarea>
 
 <script type="text/javascript">
@@ -78,7 +81,11 @@ jQuery('#'+id).autocomplete( {
 }
 );
 % } else {
-<input type="text" id="<% $name %>" name="<% $name %>" class="CF-<%$CustomField->id%>-Edit form-control" value="<% $Default || '' %>"/>
+<input type="text" id="<% $name %>" name="<% $name %>" class="CF-<%$CustomField->id%>-Edit form-control" value="<% $Default || '' %>"
+% if ( $Required ) {
+  required
+% }
+/>
 <script type="text/javascript">
 var id = <% $name |n,j%>;
 id = id.replace(/:/g,'\\:');
@@ -114,4 +121,5 @@ $Values      => undef
 $Multiple    => undef
 $Rows        => undef
 $Cols        => undef
+$Required    => $CustomField->MatchPattern('') ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldBinary b/share/html/Elements/EditCustomFieldBinary
index 87f74913a46..60f3d88facc 100644
--- a/share/html/Elements/EditCustomFieldBinary
+++ b/share/html/Elements/EditCustomFieldBinary
@@ -68,7 +68,11 @@
 % }
 
 <div class="custom-file">
-  <input type="file" id="<% $name %>" name="<% $name %>" class="CF-<%$CustomField->id%>-Edit custom-file-input" />
+  <input type="file" id="<% $name %>" name="<% $name %>" class="CF-<%$CustomField->id%>-Edit custom-file-input"
+% if ( $Required ) {
+    required
+% }
+  />
   <label class="custom-file-label" for="<% $name %>"><&|/l&>Choose file</&></label>
 </div>
 
@@ -86,4 +90,5 @@ $Name   => undef
 $Default => undef
 $Values => undef
 $MaxValues => undef
+$Required => ( ( $Values && $Values->Count ) || $CustomField->MatchPattern('') ) ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldCombobox b/share/html/Elements/EditCustomFieldCombobox
index b0653885a14..5422ebb568c 100644
--- a/share/html/Elements/EditCustomFieldCombobox
+++ b/share/html/Elements/EditCustomFieldCombobox
@@ -58,6 +58,7 @@
     Rows    => $Rows,
     Class   => "CF-".$CustomField->id."-Edit",
     Values  => [map {$_->Name} @{CachedCustomFieldValues($CustomField)->ItemsArrayRef}],
+    Required => $Required,
 &>
 
 <%INIT>
@@ -76,4 +77,5 @@ $Multiple => 0
 $Rows => undef
 $MaxValues => undef
 $Name => undef
+$Required => $CustomField->MatchPattern('') ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldDate b/share/html/Elements/EditCustomFieldDate
index 7b99dba0b06..cceacb1ba23 100644
--- a/share/html/Elements/EditCustomFieldDate
+++ b/share/html/Elements/EditCustomFieldDate
@@ -48,7 +48,7 @@
 % my $name = $Name || $NamePrefix.$CustomField->Id.'-Values';
 <div class="form-row">
   <div class="col-auto">
-    <& /Elements/SelectDate, Name => $name, Default => $Default, current => 0, ShowTime => 0 &>
+    <& /Elements/SelectDate, Name => $name, Default => $Default, current => 0, ShowTime => 0, Required => $Required, &>
   </div>
   <div class="col-auto">
     <span class="current-value form-control">(<%$DateObj->AsString(Time => 0, Timezone => 'utc')%>)</span>
@@ -66,4 +66,5 @@ $Default => undef
 $Values => undef
 $MaxValues => 1
 $Name => undef
+$Required => $CustomField->MatchPattern('') ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldDateTime b/share/html/Elements/EditCustomFieldDateTime
index ac41403e51c..f3f8129ade2 100644
--- a/share/html/Elements/EditCustomFieldDateTime
+++ b/share/html/Elements/EditCustomFieldDateTime
@@ -48,7 +48,7 @@
 % my $name = $Name || $NamePrefix.$CustomField->Id.'-Values';
 <div class="form-row">
     <div class="col-auto">
-        <& /Elements/SelectDate, Name => $name, Default => $Default, current => 0 &>
+        <& /Elements/SelectDate, Name => $name, Default => $Default, current => 0, Required => $Required, &>
     </div>
     <div class="col-auto">
         <span class="current-value form-control">(<%$DateObj->AsString%>)</span>
@@ -68,4 +68,5 @@ $Values => undef
 $MaxValues => 1
 $Name => undef
 $Format => 'unknown'
+$Required => $CustomField->MatchPattern('') ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldFreeform b/share/html/Elements/EditCustomFieldFreeform
index c7c5ed18744..85345f3de7b 100644
--- a/share/html/Elements/EditCustomFieldFreeform
+++ b/share/html/Elements/EditCustomFieldFreeform
@@ -54,12 +54,18 @@ cols="<% $Cols %>" \
 % if ( defined $Rows ) {
 rows="<% $Rows %>" \
 % }
+% if ( $Required ) {
+required
+% }
 name="<%$name%>" id="<%$name%>" wrap="off" class="CF-<%$CustomField->id%>-Edit form-control"><% defined($Default) ? $Default : '' %></textarea>
 % } else {
 <input type="text" name="<%$name%>" id="<%$name%>" \
 % if ( defined $Cols ) {
 size="<% $Cols %>" \
 % }
+% if ( $Required ) {
+required
+% }
 class="CF-<%$CustomField->id%>-Edit form-control" value="<% defined($Default) ? $Default : ''%>" />
 % }
 <%INIT>
@@ -80,4 +86,5 @@ $Values => undef
 $Multiple => undef
 $Cols
 $Rows
+$Required => $CustomField->MatchPattern('') ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldHTML b/share/html/Elements/EditCustomFieldHTML
index 90200b6bdfc..2f74612ca18 100644
--- a/share/html/Elements/EditCustomFieldHTML
+++ b/share/html/Elements/EditCustomFieldHTML
@@ -64,6 +64,9 @@ cols="<% $Cols %>" \
 % if ( defined $Rows ) {
 rows="<% $Rows %>" \
 % }
+% if ( $Required ) {
+required
+% }
 name="<%$name%>" class="CF-<%$CustomField->id%>-Edit form-control richtext"><% $Default %></textarea>
 % }
 <%INIT>
@@ -81,4 +84,5 @@ $Values => undef
 $MaxValues => undef
 $Cols
 $Rows
+$Required => $CustomField->MatchPattern('') ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldImage b/share/html/Elements/EditCustomFieldImage
index 478bade2f6c..5efac3f9c06 100644
--- a/share/html/Elements/EditCustomFieldImage
+++ b/share/html/Elements/EditCustomFieldImage
@@ -60,7 +60,11 @@
 % }
 
 <div class="custom-file">
-  <input type="file" id="<% $name %>" name="<% $name %>" class="CF-<%$CustomField->id%>-Edit custom-file-input" />
+  <input type="file" id="<% $name %>" name="<% $name %>" class="CF-<%$CustomField->id%>-Edit custom-file-input"
+% if ( $Required ) {
+    required
+% }
+  />
   <label class="custom-file-label" for="<% $name %>"><&|/l&>Choose file</&></label>
 </div>
 
@@ -78,4 +82,5 @@ $Name => undef
 $Default => undef
 $Values => undef
 $MaxValues => undef
+$Required => ( ( $Values && $Values->Count ) || $CustomField->MatchPattern('') ) ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldSelect b/share/html/Elements/EditCustomFieldSelect
index 9921e5e965f..2d408b39cf9 100644
--- a/share/html/Elements/EditCustomFieldSelect
+++ b/share/html/Elements/EditCustomFieldSelect
@@ -123,6 +123,9 @@
 % if ( $size > 1 ) {
   size="<% $Rows %>"
 % }
+% if ( $Required ) {
+  required
+% }
 <% $Multiple && qq[multiple="multiple"] |n %> >
 % if ( $show_empty_option ) {
 <option value=""<% !$selected && qq[ selected="selected"] |n %>><&|/l&>(no value)</&></option>
@@ -191,6 +194,7 @@ $Rows => undef
 $HideCategory => 0
 $RenderType => undef
 $MaxValues => 1
+$Required => $CustomField->MatchPattern('') ? 0 : 1,
 </%ARGS>
 
 <%METHOD options>
diff --git a/share/html/Elements/EditCustomFieldText b/share/html/Elements/EditCustomFieldText
index ac365b6ad4a..eea620a927f 100644
--- a/share/html/Elements/EditCustomFieldText
+++ b/share/html/Elements/EditCustomFieldText
@@ -63,6 +63,9 @@ cols="<% $Cols %>" \
 % if ( defined $Rows ) {
 rows="<% $Rows %>" \
 % }
+% if ( $Required ) {
+required
+% }
 name="<%$name%>" class="CF-<%$CustomField->id%>-Edit form-control"><% defined($Default) ? $Default : '' %></textarea>
 % }
 <%INIT>
@@ -80,4 +83,5 @@ $Values => undef
 $MaxValues => undef
 $Cols
 $Rows
+$Required => $CustomField->MatchPattern('') ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFieldWikitext b/share/html/Elements/EditCustomFieldWikitext
index d28add1c2b2..27fe1521947 100644
--- a/share/html/Elements/EditCustomFieldWikitext
+++ b/share/html/Elements/EditCustomFieldWikitext
@@ -63,6 +63,9 @@ cols="<% $Cols %>" \
 % if ( defined $Rows ) {
 rows="<% $Rows %>" \
 % }
+% if ( $Required ) {
+required
+% }
 name="<%$name%>" class="CF-<%$CustomField->id%>-Edit form-control"><% $Default %></textarea>
 % }
 <%INIT>
@@ -80,4 +83,5 @@ $Values => undef
 $MaxValues => undef
 $Cols
 $Rows
+$Required => $CustomField->MatchPattern('') ? 0 : 1
 </%ARGS>
diff --git a/share/html/Elements/EditCustomFields b/share/html/Elements/EditCustomFields
index fdecf23507f..12f76cd6a65 100644
--- a/share/html/Elements/EditCustomFields
+++ b/share/html/Elements/EditCustomFields
@@ -125,4 +125,5 @@ $LabelCols => 3
 $ValueCols => 9
 $ShowHints => 1
 $ForCreation => 0
+$Required => undef
 </%ARGS>
diff --git a/share/html/Elements/SelectDate b/share/html/Elements/SelectDate
index 1425e1bcefb..af7e0476543 100644
--- a/share/html/Elements/SelectDate
+++ b/share/html/Elements/SelectDate
@@ -49,6 +49,9 @@
 <input type="text" class="datepicker<% $ShowTime ? ' withtime' : '' %> form-control"
 % if ( $id ) {
  id="<% $id %>"
+% }
+% if ( $Required ) {
+required
 % }
  name="<% $Name %>" value="<% $Default %>" size="<% $Size %>" autocomplete="off" />
 % $m->callback( %ARGS, Name => $Name, CallbackName => 'AfterDateInput', Object => $Object, ARGSRef => $ARGSRef, );
@@ -78,4 +81,5 @@ $Size        => 16
 $Object      => undef
 $ARGSRef     => undef
 $id          => undef
+$Required    => undef
 </%args>
diff --git a/share/html/Widgets/ComboBox b/share/html/Widgets/ComboBox
index 681e763ce69..9c3c7cfbd55 100644
--- a/share/html/Widgets/ComboBox
+++ b/share/html/Widgets/ComboBox
@@ -51,7 +51,7 @@ my $z_index = 9999;
 </%once>
 
 <div class="combobox-wrapper" data-name="<% $Name %>" data-value="<% $Default // '' %>">
-  <select class="form-control combobox" size="<% $Rows %>">
+  <select class="form-control combobox" size="<% $Rows %>" <% $Required ? 'required' : '' %>>
     <option value=""></option>
 % for my $value (@Values) {
     <option value="<% $value %>" <% ($Default // '') eq $value ? 'selected="selected"' : '' %>><% $value%></option>
@@ -65,4 +65,5 @@ $Rows    => 5
 $Default => ''
 @Values  => ()
 $Class   => ''
+$Required => undef
 </%ARGS>