Don't allow longexpires in user report (#2370)

Author: mikehelmick

assets/server/realmadmin/_form_sms.html

@@ -187,7 +187,7 @@ <h5 class="mb-3">SMS templates</h5>
       </div>
       <div class="form-floating mb-3">
         <textarea name="sms_text_template_{{$i}}" class="form-control font-monospace {{if $realm.ErrorsFor $v.Label}}is-invalid{{end}} sms-text-template"
-          placeholder="SMS text template" style="height:150px;">{{$v.Value}}</textarea>
+          placeholder="SMS text template" style="height:150px;" label="{{$v.Label}}">{{$v.Value}}</textarea>
         <label for="sms-text-template">SMS text template</label>
       </div>
       {{if $realm.ErrorsFor $v.Label}}
@@ -416,7 +416,7 @@ <h5 class="mb-3">SMS templates</h5>
       if (val.length > {{$realm.SMSTemplateMaxLength}}) {
         errors.push('SMS Templates must be <= {{$realm.SMSTemplateMaxLength}} characters, currently ' + val.length + ' characters.');
       }
-
+    
       // Provide live feedback on errors in the SMS Template construction.
       if (enxEnabled) {
         if (!val.includes("[enslink]")) {
@@ -438,11 +438,19 @@ <h5 class="mb-3">SMS templates</h5>
         hasLC = val.includes("[longcode]");
         if (!(hasSC || hasLC) || (hasSC && hasLC)) {
           errors.push('must contain exactly one of `[code]` or `[longcode]`');
-        }
+        }        
 
         val = val.replace(/\[region\]/g, region);
         val = val.replace(/\[longcode\]/g, longCode);
       }
+
+      isUserReport = $(target).attr('label') === "User Report";
+      if (isUserReport) {
+        if (val.includes(("[longexpires]"))) {
+          errors.push("'User Report' template cannot contain `[longexpires]` since user report always uses the short expiration time `[expires]`, which is always in minutes.");
+        }
+      }
+
       val = val.replace(/\[code\]/g, shortCode);
       val = val.replace(/\[expires\]/g, shortExpires);
       val = val.replace(/\[longexpires\]/g, longExpires);

pkg/database/realm.go

@@ -718,6 +718,13 @@ func (r *Realm) validateSMSTemplate(label, t string) string {
 		}
 	}
 
+	if label == UserReportTemplateLabel {
+		if strings.Contains(t, SMSLongExpires) {
+			r.AddError("smsTextTemplate", fmt.Sprintf("cannot contain %q - for %q the 'short expiration' time is used an is represented in minutes", SMSLongExpires, UserReportTemplateLabel))
+			r.AddError(label, fmt.Sprintf("cannot contain %q", SMSLongExpires))
+		}
+	}
+
 	// Check template length.
 	if l := len(t); l > SMSTemplateMaxLength {
 		r.AddError("smsTextTemplate", fmt.Sprintf("must be %d characters or less, current message is %v characters long", SMSTemplateMaxLength, l))

pkg/database/realm_test.go

@@ -458,6 +458,34 @@ func TestRealm_BeforeSave(t *testing.T) {
 	}
 }
 
+func TestRealm_ValidateSMSTemplateUserReport(t *testing.T) {
+	t.Parallel()
+
+	realm := NewRealmWithDefaults("test")
+	realm.RegionCode = "US-WA"
+	realm.AllowedTestTypes = TestTypeConfirmed | TestTypeUserReport
+	realm.EnableENExpress = true
+	realm.SMSTextTemplate = DefaultENXSMSTextTemplate
+
+	db, _ := testDatabaseInstance.NewDatabase(t, nil)
+	if err := db.SaveRealm(realm, SystemTest); err != nil {
+		t.Fatalf("save error: %v issues: %+v", err, realm.ErrorMessages())
+	}
+
+	_ = realm.validateSMSTemplate(UserReportTemplateLabel, *realm.SMSTextAlternateTemplates[UserReportTemplateLabel])
+	if len(realm.Errors()) > 0 {
+		t.Fatalf("unexpected errors when saving realm in ")
+	}
+
+	badTemplate := "Click here [enslink] expires in [longexpires] time"
+	realm.SMSTextAlternateTemplates[UserReportTemplateLabel] = &badTemplate
+
+	_ = realm.validateSMSTemplate(UserReportTemplateLabel, *realm.SMSTextAlternateTemplates[UserReportTemplateLabel])
+	if _, ok := realm.Errors()["smsTextTemplate"]; !ok {
+		t.Fatalf("missing expected error for `smsTextTemplate`")
+	}
+}
+
 func TestRealm_validateSMSTemplate(t *testing.T) {
 	t.Parallel()