Update token rules to correctly reflect the specs

Author: thomasrawiel

Classes/ViewHelpers/String/AutocompleteViewHelper.php

@@ -1,6 +1,7 @@
 <?php
 
 declare(strict_types=1);
+
 namespace In2code\Powermail\ViewHelpers\String;
 
 use In2code\Powermail\Domain\Model\Field;
@@ -26,7 +27,7 @@ public function render(): string
     {
         $field = $this->arguments['field'];
 
-        list($autocompleteTokens, $token, $section, $type, $purpose)
+        [$autocompleteTokens, $token, $section, $type, $purpose]
             = [
             '',
             $field->getAutocompleteToken(),
@@ -35,22 +36,26 @@ public function render(): string
             $field->getAutocompletePurpose(),
         ];
 
-        //if token is empty or 'on'/'off' other tokens are not allowed
+        // If token is empty or 'on'/'off', other tokens are not allowed.
         if (empty($token) || in_array($token, ['on', 'off'])) {
             return $token;
         }
 
-        //optional section token must begin with the string 'section-'
+        // Optional section token must begin with the string 'section-'
         if (!empty($section)) {
-            $autocompleteTokens = 'section-' . $section . ' ';
+            if ($this->tokenIsAllowedForSection($token)) {
+                $autocompleteTokens .= 'section-' . $section . ' ';
+            }
         }
 
-        //optional type token must be either shipping or billing
-        if (!empty($type) && in_array($type, ['shipping', 'billing'])) {
-            $autocompleteTokens .= $type . ' ';
+        // Optional type token must be either 'shipping' or 'billing'
+        if (!empty($type)) {
+            if ($this->tokenIsAllowedForType($token, $type)) {
+                $autocompleteTokens .= $type . ' ';
+            }
         }
 
-        //optional purpose token is only allowed for certain autofill-field tokens
+        // Optional purpose token is only allowed for certain autofill-field tokens
         if (!empty($purpose)) {
             if ($this->tokenIsAllowedForPurpose($token, $purpose)) {
                 $autocompleteTokens .= $purpose . ' ';
@@ -60,20 +65,45 @@ public function render(): string
         return $autocompleteTokens . $token;
     }
 
+
     /**
-     * hardcoded check:
-     * purpose is only allowed for email, imp, tel and tel-*
-     *
-     * @see https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill-detail-tokens
+     * @param string $token
+     * @param string $type
      *
+     * @return bool
+     */
+    protected function tokenIsAllowedForType(string $token, string $type): bool
+    {
+        $allowedTypes = ['shipping', 'billing'];
+        $tokensNotSupportingType = ['nickname', 'sex', 'impp', 'url', 'organization-title', 'tel-country-code', 'tel-area-code', 'tel-national', 'tel-local', 'tel-local-prefix', 'tel-local-suffix', 'tel-extension', 'username', 'new-password', 'current-password', 'one-time-code', 'bday', 'bday-day', 'bday-month', 'bday-year', 'language', 'photo'];
+        return in_array($type, $allowedTypes)
+            && !in_array($token, $tokensNotSupportingType);
+    }
+
+
+    /**
      * @param string $token
      * @param string $purpose
      *
      * @return bool
      */
     protected function tokenIsAllowedForPurpose(string $token, string $purpose): bool
     {
-        return in_array($purpose, ['home', 'work', 'mobile', 'fax', 'pager'])
-            && in_array($token, ['tel', 'tel-country-code', 'tel-national', 'tel-area-code', 'tel-local', 'tel-local-prefix', 'tel-local-suffix', 'tel-extension', 'email', 'impp']);
+        $allowedPurposes = ['home', 'work', 'mobile', 'fax', 'pager'];
+        $tokensSupportingPurpose = ['tel', 'email', 'impp'];
+
+        return in_array($token, $allowedPurposes, true)
+            && !in_array($token, $tokensSupportingPurpose, true);
+    }
+
+    /**
+     * @param string $token
+     *
+     * @return bool
+     */
+    protected function tokenIsAllowedForSection(string $token): bool
+    {
+        $tokensNotSupportingSection = ['nickname', 'sex', 'impp', 'url', 'organization-title', 'username', 'new-password', 'current-password', 'one-time-code', 'bday', 'bday-day', 'bday-month', 'bday-year', 'language', 'photo'];
+        return !in_array($token, $tokensNotSupportingSection, true);
     }
 }

Configuration/TCA/tx_powermail_domain_model_field.php

@@ -1048,7 +1048,7 @@
             'displayCond' => [
                 'AND' => [
                     'FIELD:type:IN:input,textarea',
-                    'FIELD:autocomplete_token:!IN:on,off',
+                    'FIELD:autocomplete_token:!IN:on,off,nickname,sex,impp,url,organization-title,username,new-password,current-password,one-time-code,bday,bday-day,bday-month,bday-year,language,photo',
                     'FIELD:autocomplete_token:REQ:true',
                 ],
             ],
@@ -1067,7 +1067,7 @@
             'displayCond' => [
                 'AND' => [
                     'FIELD:type:IN:input,textarea',
-                    'FIELD:autocomplete_token:!IN:on,off',
+                    'FIELD:autocomplete_token:!IN:on,off,nickname,sex,impp,url,organization-title,tel-country-code,tel-area-code,tel-national,tel-local,tel-local-prefix,tel-local-suffix,tel-extension,username,new-password,current-password,one-time-code,bday,bday-day,bday-month,bday-year,language,photo',
                     'FIELD:autocomplete_token:REQ:true',
                 ],
             ],
@@ -1090,7 +1090,7 @@
             'displayCond' => [
                 'AND' => [
                     'FIELD:type:IN:input,textarea',
-                    'FIELD:autocomplete_token:IN:email,impp,tel,tel-country-code,tel-national,tel-area-code,tel-local,tel-local-prefix,tel-local-suffix,tel-extension',
+                    'FIELD:autocomplete_token:IN:email,impp,tel',
                 ],
             ],
         ],