mirror of
https://github.com/Control-D-Inc/ctrld.git
synced 2026-02-03 22:18:39 +00:00
4792183c0d
This commit extends the documentation effort by adding detailed explanatory comments to key CLI components and core functionality throughout the cmd/ directory. The changes focus on explaining WHY certain logic is needed, not just WHAT the code does, improving code maintainability and helping developers understand complex business decisions. Key improvements: - Main entry points: Document CLI initialization, logging setup, and cache configuration with reasoning for design decisions - DNS proxy core: Explain DNS proxy constants, data structures, and core processing pipeline for handling DNS queries - Service management: Document service command structure, configuration patterns, and platform-specific service handling - Logging infrastructure: Explain log buffer management, level encoders, and log formatting decisions for different use cases - Metrics and monitoring: Document Prometheus metrics structure, HTTP endpoints, and conditional metric collection for performance - Network handling: Explain Linux-specific network interface filtering, virtual interface detection, and DNS configuration management - Hostname validation: Document RFC1123 compliance and DNS naming standards for system compatibility - Mobile integration: Explain HTTP retry logic, fallback mechanisms, and mobile platform integration patterns - Connection management: Document connection wrapper design to prevent log pollution during process lifecycle Technical details: - Added explanatory comments to 11 additional files in cmd/cli/ - Maintained consistent documentation style and format - Preserved all existing functionality while improving code clarity - Enhanced understanding of complex business logic and platform-specific behavior These comments help future developers understand the reasoning behind complex decisions, making the codebase more maintainable and reducing the risk of incorrect modifications during maintenance.
19 lines
800 B
Go
19 lines
800 B
Go
package cli
|
|
|
|
import "regexp"
|
|
|
|
// validHostname reports whether hostname is a valid hostname.
|
|
// A valid hostname contains 3 -> 64 characters and conform to RFC1123.
|
|
// This function validates hostnames to ensure they meet DNS naming standards
|
|
// and prevents invalid hostnames from being used in DNS configurations
|
|
func validHostname(hostname string) bool {
|
|
hostnameLen := len(hostname)
|
|
if hostnameLen < 3 || hostnameLen > 64 {
|
|
return false
|
|
}
|
|
// RFC1123 regex pattern ensures hostnames follow DNS naming conventions
|
|
// This prevents issues with DNS resolution and system compatibility
|
|
validHostnameRfc1123 := regexp.MustCompile(`^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$`)
|
|
return validHostnameRfc1123.MatchString(hostname)
|
|
}
|