2025-08-19 12:14:48 +02:00
< ? php
namespace App\Support ;
/**
* Shared validation patterns for consistent use across the application
*/
class ValidationPatterns
{
/**
2026-01-05 13:14:27 +01:00
* Pattern for names excluding all dangerous characters
2026-03-18 13:53:01 +01:00
*/
2026-03-24 08:03:08 +01:00
public const NAME_PATTERN = '/^[\p{L}\p{M}\p{N}\s\-_.@\/&()#,:+]+$/u' ;
2025-08-19 12:14:48 +02:00
/**
2026-01-05 13:14:27 +01:00
* Pattern for descriptions excluding all dangerous characters with some additional allowed characters
2025-08-19 12:14:48 +02:00
*/
2026-01-19 18:50:56 +01:00
public const DESCRIPTION_PATTERN = '/^[\p{L}\p{M}\p{N}\s\-_.,!?()\'\"+=*@\/&]+$/u' ;
2025-08-19 12:14:48 +02:00
2026-03-12 13:09:13 +01:00
/**
* Pattern for file paths (dockerfile location, docker compose location, etc.)
* Allows alphanumeric, dots, hyphens, underscores, slashes, @, ~, and +
*/
public const FILE_PATH_PATTERN = '/^\/[a-zA-Z0-9._\-\/~@+]+$/' ;
2026-03-18 13:53:01 +01:00
/**
* Pattern for directory paths (base_directory, publish_directory, etc.)
* Like FILE_PATH_PATTERN but also allows bare "/" (root directory)
*/
public const DIRECTORY_PATH_PATTERN = '/^\/([a-zA-Z0-9._\-\/~@+]*)?$/' ;
/**
* Pattern for Docker build target names (multi-stage build stage names)
* Allows alphanumeric, dots, hyphens, and underscores
*/
public const DOCKER_TARGET_PATTERN = '/^[a-zA-Z0-9][a-zA-Z0-9._-]*$/' ;
/**
* Pattern for shell-safe command strings (docker compose commands, docker run options)
2026-03-25 20:27:21 +01:00
* Blocks dangerous shell metacharacters: ; | ` $ ( ) > < newlines and carriage returns
* Allows & for command chaining (&&) which is common in multi-step build commands
* Allows double quotes for build args with spaces (e.g. --build-arg KEY="value")
* Blocks backslashes and single quotes to prevent escape-sequence attacks
2026-03-18 13:53:01 +01:00
* Uses [ \t] instead of \s to explicitly exclude \n and \r (which act as command separators)
*/
2026-03-25 20:27:21 +01:00
public const SHELL_SAFE_COMMAND_PATTERN = '/^[a-zA-Z0-9 \t._\-\/=:@,+\[\]{}#%^~&"]+$/' ;
2026-03-18 13:53:01 +01:00
2026-03-26 11:06:30 +01:00
/**
* Pattern for Docker volume names
* Must start with alphanumeric, followed by alphanumeric, dots, hyphens, or underscores
* Matches Docker's volume naming rules
*/
public const VOLUME_NAME_PATTERN = '/^[a-zA-Z0-9][a-zA-Z0-9._-]*$/' ;
2026-03-18 13:53:01 +01:00
/**
* Pattern for Docker container names
* Must start with alphanumeric, followed by alphanumeric, dots, hyphens, or underscores
*/
public const CONTAINER_NAME_PATTERN = '/^[a-zA-Z0-9][a-zA-Z0-9._-]*$/' ;
2025-08-19 12:14:48 +02:00
/**
* Get validation rules for name fields
*/
public static function nameRules ( bool $required = true , int $minLength = 3 , int $maxLength = 255 ) : array
{
$rules = [];
if ( $required ) {
$rules [] = 'required' ;
} else {
$rules [] = 'nullable' ;
}
$rules [] = 'string' ;
$rules [] = " min: $minLength " ;
$rules [] = " max: $maxLength " ;
$rules [] = 'regex:' . self :: NAME_PATTERN ;
return $rules ;
}
/**
* Get validation rules for description fields
*/
public static function descriptionRules ( bool $required = false , int $maxLength = 255 ) : array
{
$rules = [];
if ( $required ) {
$rules [] = 'required' ;
} else {
$rules [] = 'nullable' ;
}
$rules [] = 'string' ;
$rules [] = " max: $maxLength " ;
$rules [] = 'regex:' . self :: DESCRIPTION_PATTERN ;
return $rules ;
}
/**
* Get validation messages for name fields
*/
public static function nameMessages () : array
{
return [
2026-03-24 08:03:08 +01:00
'name.regex' => 'The name may only contain letters (including Unicode), numbers, spaces, and these characters: - _ . / @ & ( ) # , : +' ,
2025-08-19 12:14:48 +02:00
'name.min' => 'The name must be at least :min characters.' ,
'name.max' => 'The name may not be greater than :max characters.' ,
];
}
/**
* Get validation messages for description fields
*/
public static function descriptionMessages () : array
{
return [
2026-01-19 18:50:56 +01:00
'description.regex' => " The description may only contain letters (including Unicode), numbers, spaces, and common punctuation: - _ . , ! ? ( ) ' \" + = * / @ & " ,
2025-08-19 12:14:48 +02:00
'description.max' => 'The description may not be greater than :max characters.' ,
];
}
2026-03-12 13:09:13 +01:00
/**
* Get validation rules for file path fields (dockerfile location, docker compose location)
*/
public static function filePathRules ( int $maxLength = 255 ) : array
{
return [ 'nullable' , 'string' , 'max:' . $maxLength , 'regex:' . self :: FILE_PATH_PATTERN ];
}
/**
* Get validation messages for file path fields
*/
public static function filePathMessages ( string $field = 'dockerfileLocation' , string $label = 'Dockerfile' ) : array
{
return [
" { $field } .regex " => " The { $label } location must be a valid path starting with / and containing only alphanumeric characters, dots, hyphens, underscores, slashes, @, ~, and +. " ,
];
}
2026-03-18 13:53:01 +01:00
/**
* Get validation rules for directory path fields (base_directory, publish_directory)
*/
public static function directoryPathRules ( int $maxLength = 255 ) : array
{
return [ 'nullable' , 'string' , 'max:' . $maxLength , 'regex:' . self :: DIRECTORY_PATH_PATTERN ];
}
/**
* Get validation rules for Docker build target fields
*/
public static function dockerTargetRules ( int $maxLength = 128 ) : array
{
return [ 'nullable' , 'string' , 'max:' . $maxLength , 'regex:' . self :: DOCKER_TARGET_PATTERN ];
}
/**
* Get validation rules for shell-safe command fields
*/
public static function shellSafeCommandRules ( int $maxLength = 1000 ) : array
{
return [ 'nullable' , 'string' , 'max:' . $maxLength , 'regex:' . self :: SHELL_SAFE_COMMAND_PATTERN ];
}
2026-03-26 11:06:30 +01:00
/**
* Get validation rules for Docker volume name fields
*/
public static function volumeNameRules ( bool $required = true , int $maxLength = 255 ) : array
{
$rules = [];
if ( $required ) {
$rules [] = 'required' ;
} else {
$rules [] = 'nullable' ;
}
$rules [] = 'string' ;
$rules [] = " max: $maxLength " ;
$rules [] = 'regex:' . self :: VOLUME_NAME_PATTERN ;
return $rules ;
}
/**
* Get validation messages for volume name fields
*/
public static function volumeNameMessages ( string $field = 'name' ) : array
{
return [
" { $field } .regex " => 'The volume name must start with an alphanumeric character and contain only alphanumeric characters, dots, hyphens, and underscores.' ,
];
}
2026-03-18 13:53:01 +01:00
/**
* Get validation rules for container name fields
*/
public static function containerNameRules ( int $maxLength = 255 ) : array
{
return [ 'string' , 'max:' . $maxLength , 'regex:' . self :: CONTAINER_NAME_PATTERN ];
}
2026-03-25 20:21:39 +01:00
/**
* Check if a string is a valid Docker container name.
*/
public static function isValidContainerName ( string $name ) : bool
{
return preg_match ( self :: CONTAINER_NAME_PATTERN , $name ) === 1 ;
}
2026-03-12 13:09:13 +01:00
/**
2025-08-19 12:14:48 +02:00
* Get combined validation messages for both name and description fields
*/
public static function combinedMessages () : array
{
return array_merge ( self :: nameMessages (), self :: descriptionMessages ());
}
}