[5.x] Improve handle and slug validation

resources/lang/en/validation.php

@@ -154,6 +154,8 @@
  |
  */
 
+ 'handle' => 'Must contain only lowercase letters and numbers with underscores as separators.',
+ 'slug' => 'Must contain only letters and numbers with dashes or underscores as separators.',
  'code_fieldtype_rulers' => 'This is invalid.',
  'date_fieldtype_date_required' => 'Date is required.',
  'date_fieldtype_end_date_invalid' => 'Not a valid end date.',

src/Actions/DuplicateForm.php

@@ -4,6 +4,7 @@
 
 use Statamic\Contracts\Forms\Form;
 use Statamic\Facades\Form as Forms;
+use Statamic\Rules\Handle;
 use Statamic\Statamic;
 
 class DuplicateForm extends Action
@@ -30,7 +31,7 @@ protected function fieldItems()
  'type' => 'slug',
  'instructions' => __('statamic::messages.form_configure_handle_instructions'),
  'separator' => '_',
- 'validate' => 'required|alpha_dash|unique_form_handle',
+ 'validate' => ['required', new Handle, 'unique_form_handle'],
  ],
  ];
  }

src/Fields/Field.php

@@ -9,6 +9,7 @@
 use Rebing\GraphQL\Support\Field as GqlField;
 use Statamic\Contracts\Forms\Form;
 use Statamic\Facades\GraphQL;
+use Statamic\Rules\Handle;
 use Statamic\Support\Arr;
 use Statamic\Support\Str;
 
@@ -480,7 +481,7 @@ public static function commonFieldOptions(): Fields
  'separator' => '_',
  'validate' => [
  'required',
- 'regex:/^[a-zA-Z]([a-zA-Z0-9_]|->)*$/',
+ new Handle,
  'not_in:'.implode(',', $reserved),
  ],
  'show_regenerate' => true,

src/Http/Controllers/CP/Assets/AssetContainersController.php

@@ -8,6 +8,7 @@
 use Statamic\Facades\Blueprint;
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
+use Statamic\Rules\Handle;
 
 class AssetContainersController extends CpController
 {
@@ -192,7 +193,7 @@ protected function formBlueprint($container = null)
  $fields['name']['fields']['handle'] = [
  'type' => 'slug',
  'display' => __('Handle'),
- 'validate' => 'required|alpha_dash',
+ 'validate' => ['required', new Handle],
  'separator' => '_',
  'instructions' => __('statamic::messages.asset_container_handle_instructions'),
  ];

src/Http/Controllers/CP/Collections/CollectionsController.php

@@ -13,6 +13,7 @@
 use Statamic\Facades\Site;
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
+use Statamic\Rules\Handle;
 use Statamic\Statamic;
 use Statamic\Structures\CollectionStructure;
 use Statamic\Support\Str;
@@ -190,7 +191,7 @@ public function store(Request $request)
 
  $request->validate([
  'title' => 'required',
- 'handle' => 'nullable|alpha_dash',
+ 'handle' => ['nullable', new Handle],
  ]);
 
  $handle = $request->handle ?? Str::snake($request->title);

src/Http/Controllers/CP/Fields/FieldsetController.php

@@ -8,6 +8,7 @@
 use Statamic\Fields\Fieldset;
 use Statamic\Fields\FieldTransformer;
 use Statamic\Http\Controllers\CP\CpController;
+use Statamic\Rules\Handle;
 use Statamic\Support\Arr;
 use Statamic\Support\Str;
 
@@ -115,7 +116,7 @@ public function store(Request $request)
  {
  $request->validate([
  'title' => 'required',
- 'handle' => 'required|alpha_dash',
+ 'handle' => ['required', new Handle],
  ]);
 
  if (Facades\Fieldset::find($request->handle)) {

src/Http/Controllers/CP/Forms/FormsController.php

@@ -10,6 +10,7 @@
 use Statamic\Facades\Form;
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
+use Statamic\Rules\Handle;
 use Statamic\Support\Str;
 
 class FormsController extends CpController
@@ -121,7 +122,7 @@ public function store(Request $request)
 
  $request->validate([
  'title' => 'required',
- 'handle' => 'nullable|alpha_dash',
+ 'handle' => ['nullable', new Handle],
  ]);
 
  $handle = $request->handle ?? Str::snake($request->title);

src/Http/Controllers/CP/Globals/GlobalsController.php

@@ -9,6 +9,7 @@
 use Statamic\Facades\Site;
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
+use Statamic\Rules\Handle;
 use Statamic\Support\Arr;
 use Statamic\Support\Str;
 
@@ -144,7 +145,7 @@ public function store(Request $request)
 
  $data = $request->validate([
  'title' => 'required',
- 'handle' => 'nullable|alpha_dash',
+ 'handle' => ['nullable', new Handle],
  ]);
 
  $handle = $data['handle'] ?? Str::snake($data['title']);

src/Http/Controllers/CP/Navigation/NavigationController.php

@@ -9,6 +9,7 @@
 use Statamic\Facades\Site;
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
+use Statamic\Rules\Handle;
 use Statamic\Support\Arr;
 
 class NavigationController extends CpController
@@ -153,7 +154,7 @@ public function store(Request $request)
 
  $values = $request->validate([
  'title' => 'required',
- 'handle' => 'required|alpha_dash',
+ 'handle' => ['required', new Handle],
  ]);
 
  if (Nav::find($values['handle'])) {

src/Http/Controllers/CP/Taxonomies/TaxonomiesController.php

@@ -14,6 +14,7 @@
 use Statamic\Facades\Taxonomy;
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
+use Statamic\Rules\Handle;
 use Statamic\Stache\Repositories\TermRepository as StacheTermRepository;
 
 class TaxonomiesController extends CpController
@@ -99,7 +100,7 @@ public function store(Request $request)
 
  $request->validate([
  'title' => 'required',
- 'handle' => 'nullable|alpha_dash',
+ 'handle' => ['nullable', new Handle],
  ]);
 
  $handle = $request->handle ?? snake_case($request->title);

src/Http/Controllers/CP/Taxonomies/TermsController.php

@@ -14,6 +14,7 @@
 use Statamic\Http\Resources\CP\Taxonomies\Term as TermResource;
 use Statamic\Http\Resources\CP\Taxonomies\Terms;
 use Statamic\Query\Scopes\Filters\Concerns\QueriesFilters;
+use Statamic\Rules\Slug;
 
 class TermsController extends CpController
 {
@@ -166,7 +167,11 @@ public function update(Request $request, $taxonomy, $term, $site)
 
  $fields->validate([
  'title' => 'required',
- 'slug' => 'required|alpha_dash|unique_term_value:'.$taxonomy->handle().','.$term->id().','.$site->handle(),
+ 'slug' => [
+ 'required',
+ new Slug,
+ 'unique_term_value:'.$taxonomy->handle().','.$term->id().','.$site->handle(),
+ ],
  ]);
 
  $values = $fields->process()->values();

src/Http/Controllers/CP/Users/RolesController.php

@@ -9,6 +9,7 @@
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
 use Statamic\Http\Middleware\RequireStatamicPro;
+use Statamic\Rules\Handle;
 
 class RolesController extends CpController
 {
@@ -61,7 +62,7 @@ public function store(Request $request)
 
  $request->validate([
  'title' => 'required',
- 'handle' => 'alpha_dash',
+ 'handle' => [new Handle],
  'super' => 'boolean',
  'permissions' => 'array',
  ]);
@@ -120,7 +121,7 @@ public function update(Request $request, $role)
 
  $request->validate([
  'title' => 'required',
- 'handle' => 'alpha_dash',
+ 'handle' => [new Handle],
  'super' => 'boolean',
  'permissions' => 'array',
  ]);

src/Rules/Handle.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Statamic\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class Handle implements ValidationRule
+{
+ public function validate(string $attribute, mixed $value, Closure $fail): void
+ {
+ if (! preg_match('/^[a-z][a-z0-9]*(?:_{0,1}[a-z0-9])*$/', $value)) {
+ $fail('statamic::validation.handle')->translate();
+ }
+ }
+}

src/Rules/Slug.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Statamic\Rules;
+
+use Closure;
+use Illuminate\Contracts\Validation\ValidationRule;
+
+class Slug implements ValidationRule
+{
+ public function validate(string $attribute, mixed $value, Closure $fail): void
+ {
+ if (! preg_match('/^[a-zA-Z0-9]+(?:-{0,1}[a-zA-Z0-9])*$/', $value)) {
+ $fail('statamic::validation.slug')->translate();
+ }
+ }
+}

src/Stache/Repositories/EntryRepository.php

@@ -9,6 +9,7 @@
 use Statamic\Exceptions\CollectionNotFoundException;
 use Statamic\Exceptions\EntryNotFoundException;
 use Statamic\Facades\Collection;
+use Statamic\Rules\Slug;
 use Statamic\Stache\Query\EntryQueryBuilder;
 use Statamic\Stache\Stache;
 use Statamic\Support\Arr;
@@ -128,15 +129,15 @@ public function createRules($collection, $site)
  {
  return [
  'title' => $collection->autoGeneratesTitles() ? '' : 'required',
- 'slug' => 'alpha_dash',
+ 'slug' => [new Slug],
  ];
  }
 
  public function updateRules($collection, $entry)
  {
  return [
  'title' => $collection->autoGeneratesTitles() ? '' : 'required',
- 'slug' => 'alpha_dash',
+ 'slug' => [new Slug],
  ];
  }
 

tests/Rules/HandleTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Tests\Rules;
+
+use Statamic\Rules\Handle;
+use Tests\TestCase;
+
+class HandleTest extends TestCase
+{
+ use ValidatesCustomRule;
+
+ protected static $customRule = Handle::class;
+
+ /** @test */
+ public function it_validates_handles()
+ {
+ $this->assertPasses('foo');
+ $this->assertPasses('foo_bar');
+ $this->assertPasses('foo_bar_baz');
+ $this->assertPasses('foo_bar_baz_qux');
+ $this->assertPasses('foo1');
+ $this->assertPasses('foo123');
+ $this->assertPasses('foo123_20bar');
+
+ $this->assertFails('foo-bar');
+ $this->assertFails('_foo');
+ $this->assertFails('foo_');
+ $this->assertFails('_foo_bar');
+ $this->assertFails('foo_bar_');
+ $this->assertFails('foo__bar');
+ $this->assertFails('foo___bar');
+ $this->assertFails('1foo');
+ $this->assertFails('*foo');
+ $this->assertFails('foo#');
+ $this->assertFails('foo_!bar');
+ $this->assertFails('foo_-_bar');
+ }
+
+ /** @test */
+ public function it_outputs_helpful_validation_error()
+ {
+ $this->assertValidationErrorOutput(trans('statamic::validation.handle'), '_bad_input');
+ }
+}

tests/Rules/SlugTest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace Tests\Rules;
+
+use Statamic\Rules\Slug;
+use Tests\TestCase;
+
+class SlugTest extends TestCase
+{
+ use ValidatesCustomRule;
+
+ protected static $customRule = Slug::class;
+
+ /** @test */
+ public function it_validates_handles()
+ {
+ $this->assertPasses('foo');
+ $this->assertPasses('foo-bar');
+ $this->assertPasses('foo-bar-baz');
+ $this->assertPasses('foo-bar-baz-qux');
+ $this->assertPasses('1-foo-bar234-baz-qux-5');
+
+ $this->assertFails('foo_bar');
+ $this->assertFails('-foo');
+ $this->assertFails('foo-');
+ $this->assertFails('-foo-bar');
+ $this->assertFails('foo-bar-');
+ $this->assertFails('foo--bar');
+ $this->assertFails('foo---bar');
+ $this->assertFails('*foo');
+ $this->assertFails('foo#');
+ $this->assertFails('foo-!bar');
+ $this->assertFails('foo-_-bar');
+ }
+
+ /** @test */
+ public function it_outputs_helpful_validation_error()
+ {
+ $this->assertValidationErrorOutput(trans('statamic::validation.slug'), '-bad-input');
+ }
+}

tests/Rules/ValidatesCustomRule.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace Tests\Rules;
+
+use Illuminate\Support\Facades\Validator;
+
+trait ValidatesCustomRule
+{
+ public function validator($string)
+ {
+ return Validator::make(
+ ['input' => $string],
+ ['input' => [new static::$customRule]]
+ );
+ }
+
+ public function assertPasses($string)
+ {
+ return $this->assertTrue($this->validator($string)->passes());
+ }
+
+ public function assertFails($string)
+ {
+ return $this->assertFalse($this->validator($string)->passes());
+ }
+
+ public function assertValidationErrorOutput($expectedErrorMessage, $badInput)
+ {
+ $this->assertEquals($expectedErrorMessage, $this->validator($badInput)->errors()->first());
+ }
+}