From 66b15af49b8b9ed90ac3dc55bdfeacbcf64de8ae Mon Sep 17 00:00:00 2001
From: =?utf8?q?Tim=20D=C3=BCsterhus?= <duesterhus@woltlab.com>
Date: Fri, 12 Feb 2021 12:07:11 +0100
Subject: [PATCH] Add option name validators to devtools form for the `option`
 PIP

see #3966
---
 .../OptionPackageInstallationPlugin.class.php | 28 +++++++++++++++++++
 wcfsetup/install/lang/de.xml                  |  2 ++
 wcfsetup/install/lang/en.xml                  |  2 ++
 3 files changed, 32 insertions(+)

diff --git a/wcfsetup/install/files/lib/system/package/plugin/OptionPackageInstallationPlugin.class.php b/wcfsetup/install/files/lib/system/package/plugin/OptionPackageInstallationPlugin.class.php
index 75b1ea4462..b131ea5b17 100644
--- a/wcfsetup/install/files/lib/system/package/plugin/OptionPackageInstallationPlugin.class.php
+++ b/wcfsetup/install/files/lib/system/package/plugin/OptionPackageInstallationPlugin.class.php
@@ -223,6 +223,34 @@ class OptionPackageInstallationPlugin extends AbstractOptionPackageInstallationP
                         }
                     }
                 ));
+                $optionNameField->addValidator(new FormFieldValidator(
+                    'lowercase',
+                    static function (TextFormField $formField) {
+                        $value = $formField->getValue();
+                        if ($value !== \strtolower($value)) {
+                            $formField->addValidationError(
+                                new FormFieldValidationError(
+                                    'notLowercase',
+                                    'wcf.acp.pip.option.optionName.error.notLowercase'
+                                )
+                            );
+                        }
+                    }
+                ));
+                $optionNameField->addValidator(new FormFieldValidator(
+                    'pattern',
+                    static function (TextFormField $formField) {
+                        $value = $formField->getValue();
+                        if (!\preg_match('/^[a-z][a-z0-9_]*[a-z]$/', $value)) {
+                            $formField->addValidationError(
+                                new FormFieldValidationError(
+                                    'pattern',
+                                    'wcf.acp.pip.option.optionName.error.pattern'
+                                )
+                            );
+                        }
+                    }
+                ));
 
                 // add `hidden` pseudo-category
                 /** @var SingleSelectionFormField $categoryName */
diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml
index f3237fbfc7..f8f6839362 100644
--- a/wcfsetup/install/lang/de.xml
+++ b/wcfsetup/install/lang/de.xml
@@ -2616,6 +2616,8 @@ Kein Abschnitt darf leer sein und alle Abschnitten dürfen nur folgende Zeichen
 		<item name="wcf.acp.pip.userProfileMenu.info"><![CDATA[Das <kbd>userProfileMenu</kbd>-Package Installation Plugin installiert neue Menüpunkte für das Benutzerprofilmenü. {if LANGUAGE_USE_INFORMAL_VARIANT}Du kannst{else}Sie können{/if} mehr Informationen in der <a href="https://docs.woltlab.com/package_pip_user-profile-menu.html" class="externalURL">Entwickler-Dokumentation</a> finden.]]></item>
 		<item name="wcf.acp.pip.language.languageItemValue.de.description"><![CDATA[Hilfreiche Code-Fragmente: <kbd>{literal}{if LANGUAGE_USE_INFORMAL_VARIANT}{else}{/if}{/literal}</kbd>, <kbd>„“</kbd>]]></item>
 		<item name="wcf.acp.pip.language.languageItemValue.en.description"><![CDATA[Hilfreiche Code-Fragmente: <kbd>“”</kbd>]]></item>
+		<item name="wcf.acp.pip.option.optionName.error.notLowercase"><![CDATA[Der Optionsname darf keine Großbuchstaben enthalten.]]></item>
+		<item name="wcf.acp.pip.option.optionName.error.pattern"><![CDATA[Der Optionsname darf ausschließlich aus kleinen lateinischen Buchstaben, Ziffern und Unterstrichen bestehen. Erstes und letztes Zeichen muss ein Buchstabe sein.]]></item>
 	</category>
 	<category name="wcf.acp.reactionType">
 		<item name="wcf.acp.reactionType.delete.confirmMessage"><![CDATA[{if LANGUAGE_USE_INFORMAL_VARIANT}Willst du{else}Wollen Sie{/if} den Reaktions-Typen <span class="confirmationObject">{$reactionType->getTitle()}</span> wirklich löschen?]]></item>
diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml
index f0814b1533..0aa9518921 100644
--- a/wcfsetup/install/lang/en.xml
+++ b/wcfsetup/install/lang/en.xml
@@ -2544,6 +2544,8 @@ If you have <strong>already bought the licenses for the listed apps</strong>, th
 		<item name="wcf.acp.pip.userProfileMenu.info"><![CDATA[The <kbd>userProfileMenu</kbd> package installation plugin installs new menu items for the user profile menu. You can find more information in the <a href="https://docs.woltlab.com/package_pip_user-profile-menu.html" class="externalURL">developer documentation</a>.]]></item>
 		<item name="wcf.acp.pip.language.languageItemValue.de.description"><![CDATA[Helpful code fragments: <kbd>{literal}{if LANGUAGE_USE_INFORMAL_VARIANT}{else}{/if}{/literal}</kbd>, <kbd>„“</kbd>]]></item>
 		<item name="wcf.acp.pip.language.languageItemValue.en.description"><![CDATA[Helpful code fragments: <kbd>“”</kbd>]]></item>
+		<item name="wcf.acp.pip.option.optionName.error.notLowercase"><![CDATA[The option name may not include uppercase letters.]]></item>
+		<item name="wcf.acp.pip.option.optionName.error.pattern"><![CDATA[The option name must consist of lowercase latin letters, digits and underscores only. The first and last character must be letters.]]></item>
 	</category>
 	<category name="wcf.acp.reactionType">
 		<item name="wcf.acp.reactionType.delete.confirmMessage"><![CDATA[Do you really want to delete the reaction type <span class="confirmationObject">{$reactionType->getTitle()}</span>?]]></item>
-- 
2.20.1