File size: 7,443 Bytes
956e414 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
"""
.. codeauthor:: Tsuyoshi Hombashi <[email protected]>
"""
import abc
import os
import sys
from typing import ClassVar, Optional, Sequence, Tuple
from ._common import normalize_platform, unprintable_ascii_chars
from ._const import DEFAULT_MIN_LEN, Platform
from ._types import PathType, PlatformType
from .error import ReservedNameError, ValidationError
from .handler import NullValueHandler, ReservedNameHandler, ValidationErrorHandler
class BaseFile:
_INVALID_PATH_CHARS: ClassVar[str] = "".join(unprintable_ascii_chars)
_INVALID_FILENAME_CHARS: ClassVar[str] = _INVALID_PATH_CHARS + "/"
_INVALID_WIN_PATH_CHARS: ClassVar[str] = _INVALID_PATH_CHARS + ':*?"<>|\t\n\r\x0b\x0c'
_INVALID_WIN_FILENAME_CHARS: ClassVar[str] = (
_INVALID_FILENAME_CHARS + _INVALID_WIN_PATH_CHARS + "\\"
)
@property
def platform(self) -> Platform:
return self.__platform
@property
def reserved_keywords(self) -> Tuple[str, ...]:
return self._additional_reserved_names
@property
def max_len(self) -> int:
return self._max_len
def __init__(
self,
max_len: int,
fs_encoding: Optional[str],
additional_reserved_names: Optional[Sequence[str]] = None,
platform_max_len: Optional[int] = None,
platform: Optional[PlatformType] = None,
) -> None:
if additional_reserved_names is None:
additional_reserved_names = tuple()
self._additional_reserved_names = tuple(n.upper() for n in additional_reserved_names)
self.__platform = normalize_platform(platform)
if platform_max_len is None:
platform_max_len = self._get_default_max_path_len()
if max_len <= 0:
self._max_len = platform_max_len
else:
self._max_len = max_len
self._max_len = min(self._max_len, platform_max_len)
if fs_encoding:
self._fs_encoding = fs_encoding
else:
self._fs_encoding = sys.getfilesystemencoding()
def _is_posix(self) -> bool:
return self.platform == Platform.POSIX
def _is_universal(self) -> bool:
return self.platform == Platform.UNIVERSAL
def _is_linux(self, include_universal: bool = False) -> bool:
if include_universal:
return self.platform in (Platform.UNIVERSAL, Platform.LINUX)
return self.platform == Platform.LINUX
def _is_windows(self, include_universal: bool = False) -> bool:
if include_universal:
return self.platform in (Platform.UNIVERSAL, Platform.WINDOWS)
return self.platform == Platform.WINDOWS
def _is_macos(self, include_universal: bool = False) -> bool:
if include_universal:
return self.platform in (Platform.UNIVERSAL, Platform.MACOS)
return self.platform == Platform.MACOS
def _get_default_max_path_len(self) -> int:
if self._is_linux():
return 4096
if self._is_windows():
return 260
if self._is_posix() or self._is_macos():
return 1024
return 260 # universal
class AbstractValidator(BaseFile, metaclass=abc.ABCMeta):
def __init__(
self,
max_len: int,
fs_encoding: Optional[str],
check_reserved: bool,
additional_reserved_names: Optional[Sequence[str]] = None,
platform_max_len: Optional[int] = None,
platform: Optional[PlatformType] = None,
) -> None:
self._check_reserved = check_reserved
super().__init__(
max_len,
fs_encoding,
additional_reserved_names=additional_reserved_names,
platform_max_len=platform_max_len,
platform=platform,
)
@abc.abstractproperty
def min_len(self) -> int: # pragma: no cover
pass
@abc.abstractmethod
def validate(self, value: PathType) -> None: # pragma: no cover
pass
def is_valid(self, value: PathType) -> bool:
try:
self.validate(value)
except (TypeError, ValidationError):
return False
return True
def _is_reserved_keyword(self, value: str) -> bool:
return value in self.reserved_keywords
class AbstractSanitizer(BaseFile, metaclass=abc.ABCMeta):
def __init__(
self,
validator: AbstractValidator,
max_len: int,
fs_encoding: Optional[str],
validate_after_sanitize: bool,
null_value_handler: Optional[ValidationErrorHandler] = None,
reserved_name_handler: Optional[ValidationErrorHandler] = None,
additional_reserved_names: Optional[Sequence[str]] = None,
platform_max_len: Optional[int] = None,
platform: Optional[PlatformType] = None,
) -> None:
super().__init__(
max_len=max_len,
fs_encoding=fs_encoding,
additional_reserved_names=additional_reserved_names,
platform_max_len=platform_max_len,
platform=platform,
)
if null_value_handler is None:
null_value_handler = NullValueHandler.return_null_string
self._null_value_handler = null_value_handler
if reserved_name_handler is None:
reserved_name_handler = ReservedNameHandler.add_trailing_underscore
self._reserved_name_handler = reserved_name_handler
self._validate_after_sanitize = validate_after_sanitize
self._validator = validator
@abc.abstractmethod
def sanitize(self, value: PathType, replacement_text: str = "") -> PathType: # pragma: no cover
pass
class BaseValidator(AbstractValidator):
@property
def min_len(self) -> int:
return self._min_len
def __init__(
self,
min_len: int,
max_len: int,
fs_encoding: Optional[str],
check_reserved: bool,
additional_reserved_names: Optional[Sequence[str]] = None,
platform_max_len: Optional[int] = None,
platform: Optional[PlatformType] = None,
) -> None:
if min_len <= 0:
min_len = DEFAULT_MIN_LEN
self._min_len = max(min_len, 1)
super().__init__(
max_len=max_len,
fs_encoding=fs_encoding,
check_reserved=check_reserved,
additional_reserved_names=additional_reserved_names,
platform_max_len=platform_max_len,
platform=platform,
)
self._validate_max_len()
def _validate_reserved_keywords(self, name: str) -> None:
if not self._check_reserved:
return
root_name = self.__extract_root_name(name)
base_name = os.path.basename(name).upper()
if self._is_reserved_keyword(root_name.upper()) or self._is_reserved_keyword(
base_name.upper()
):
raise ReservedNameError(
f"'{root_name}' is a reserved name",
reusable_name=False,
reserved_name=root_name,
platform=self.platform,
)
def _validate_max_len(self) -> None:
if self.max_len < 1:
raise ValueError("max_len must be greater or equal to one")
if self.min_len > self.max_len:
raise ValueError("min_len must be lower than max_len")
@staticmethod
def __extract_root_name(path: str) -> str:
return os.path.splitext(os.path.basename(path))[0]
|