from cmdbox.app import common, feature, options
from cmdbox.app.commons import resdata
from pathlib import Path
from typing import Any, Callable, Dict, Tuple, List, Union
import argparse
import functools
import logging
import pydantic
import re
import unicodedata
[docs]
def apprun_check(func:Callable) -> Callable:
"""
コマンドの引数の妥当性を検証するデコレーター
Args:
func (Callable): コマンドの実行関数
Returns:
Callable: デコレーターでラップされた関数
"""
@functools.wraps(func)
def wrapper(self:Validator, logger:logging.Logger, args:argparse.Namespace, tm:float, pf:List[Dict[str, float]]=[]) -> Tuple[int, Dict[str, Any], Any]:
"""
コマンドの引数の妥当性を検証し、実行結果のスキーマを検証します
Args:
logger (logging.Logger): ロガー
args (argparse.Namespace): 引数
tm (float): 実行開始時間
pf (List[Dict[str, float]]): 呼出元のパフォーマンス情報
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
if not isinstance(self, Validator):
logger.warning(f"apprun_check decorator is applied to a function whose self is not an instance of Validator. Skipping validation. args: {args}")
return func(self, logger, args, tm, pf)
# 引数の妥当性検証
st, msg, obj = self.valid(logger, args, tm, pf)
if st != self.RESP_SUCCESS:
return st, msg, obj
# コマンドの実行
st, msg, obj = func(self, logger, args, tm, pf)
if getattr(args, 'output_no_validate', False):
return st, msg, obj
# 結果のスキーマ検証
cls = self.output_schema()
try:
if cls is not None and issubclass(cls, pydantic.BaseModel):
cls.model_validate(msg)
return st, msg, obj
except Exception as e:
if cls is not None and issubclass(cls, resdata.Base):
info = cls.get_model_info()
msg = dict(warn=f"Invalid result format: {e}", output=msg, output_schema=info)
else:
msg = dict(warn=f"Invalid result format: {e}", output=msg)
common.print_format(msg, args.format, tm, pf=pf)
return self.RESP_WARN, msg, None
return wrapper
[docs]
def async_apprun_check(func:Callable) -> Callable:
"""
コマンドの引数の妥当性を検証するデコレーター
Args:
func (Callable): コマンドの実行関数
Returns:
Callable: デコレーターでラップされた関数
"""
@functools.wraps(func)
async def wrapper(self:Validator, logger:logging.Logger, args:argparse.Namespace, tm:float, pf:List[Dict[str, float]]=[]) -> Tuple[int, Dict[str, Any], Any]:
"""
コマンドの引数の妥当性を検証し、実行結果のスキーマを検証します
Args:
logger (logging.Logger): ロガー
args (argparse.Namespace): 引数
tm (float): 実行開始時間
pf (List[Dict[str, float]]): 呼出元のパフォーマンス情報
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
if not isinstance(self, Validator):
logger.warning(f"async_apprun_check decorator is applied to a function whose self is not an instance of Validator. Skipping validation. args: {args}")
return await func(self, logger, args, tm, pf)
# 引数の妥当性検証
st, msg, obj = self.valid(logger, args, tm, pf)
if st != self.RESP_SUCCESS:
return st, msg, obj
# コマンドの実行
st, msg, obj = await func(self, logger, args, tm, pf)
if getattr(args, 'output_no_validate', False):
return st, msg, obj
# 結果のスキーマ検証
cls = self.output_schema()
try:
if issubclass(cls, pydantic.BaseModel):
cls.model_validate(msg)
return st, msg, obj
except Exception as e:
if issubclass(cls, resdata.Base):
info = cls.get_model_info()
msg = dict(warn=f"Invalid result format: {e}", output=msg, output_schema=info)
else:
msg = dict(warn=f"Invalid result format: {e}", output=msg)
common.print_format(msg, args.format, tm, pf=pf)
return self.RESP_WARN, msg, None
return wrapper
LONG_TEXT_BOUNDARY = 512
[docs]
class Validator(feature.Feature):
[docs]
def output_schema(self) -> type:
"""
コマンドの実行結果スキーマを表すクラスを返します
Returns:
type: 結果のスキーマクラス
"""
return resdata.Result
[docs]
def parse_output(self, output:Any) -> Any:
"""
コマンドの実行結果をパースします
Args:
output (Any): コマンドの実行結果
Returns:
Any: パース後の結果
"""
cls = self.output_schema()
return cls.model_validate(output)
@staticmethod
def _nomalize_path(value: Union[str, Path]) -> str:
if value is None:
return None
if isinstance(value, Path):
return Path(unicodedata.normalize('NFC', str(value)))
if isinstance(value, str):
return unicodedata.normalize('NFC', value)
return value
[docs]
@staticmethod
def validate_safe_path(base_dir: Path, relative_path: str, allow_absolute: bool = False) -> Tuple[bool, str]:
"""
相対パスがベースディレクトリの外に出ていないかバリデーション(パストラバーサル対策)
Args:
base_dir (Path): ベースディレクトリ(絶対パス)
relative_path (str): チェックする相対パス(ユーザー入力)
allow_absolute (bool): 絶対パスを許可するか(デフォルト: False)
Returns:
Tuple[bool, str]: (有効性, エラーメッセージ)
有効な場合: (True, "")
無効な場合: (False, エラーメッセージ)
"""
# Noneチェック
if not relative_path:
return True, ""
# 絶対パスチェック
if Path(relative_path).is_absolute():
if allow_absolute:
return True, ""
return False, f"Absolute paths are not allowed: {relative_path}"
# 相対パスを組み立て
try:
import os
# パスを正規化(..などを解決)
safe_path = (base_dir / relative_path).resolve()
base_dir_resolved = base_dir.resolve()
# relative_to()を使用してパスがベースディレクトリの下にあるか厳密にチェック
# この方法は境界値バグ(/data_hacker が /data を通すなど)を防ぐ
try:
relative_parts = safe_path.relative_to(base_dir_resolved)
# パートに .. が含まれていないか確認(念のため)
for part in relative_parts.parts:
if part == "..":
return False, f"Path traversal detected: {relative_path} contains '..' after resolution"
return True, ""
except ValueError:
# relative_toで失敗する場合は、パスがベース外
return False, f"Path traversal detected: {relative_path} is outside {base_dir}"
except (ValueError, RuntimeError) as e:
return False, f"Invalid path: {relative_path} ({str(e)})"
validator_types = {
options.Options.T_BOOL: [bool],
options.Options.T_DATE: [str],
options.Options.T_DATETIME: [str],
options.Options.T_DICT: [dict],
options.Options.T_DIR: [str, Path],
options.Options.T_FILE: [str, Path],
options.Options.T_FLOAT: [float],
options.Options.T_INT: [int],
options.Options.T_PASSWD: [str],
options.Options.T_STR: [str],
options.Options.T_TEXT: [str],
}
validator_type_castfunc = {
options.Options.T_BOOL: lambda v: v in [True, 'true', 'True'],
options.Options.T_DATE: lambda v: v,
options.Options.T_DATETIME: lambda v: v,
options.Options.T_DICT: lambda v: v,
options.Options.T_DIR: lambda v: Validator._nomalize_path(v),
options.Options.T_FILE: lambda v: Validator._nomalize_path(v),
options.Options.T_FLOAT: lambda v: float(v) if isinstance(v, str) and re.match(r'^-?\d+(\.\d+)?$', v) else v,
options.Options.T_INT: lambda v: int(v) if isinstance(v, str) and re.match(r'^-?\d+$', v) else v,
options.Options.T_PASSWD: lambda v: v,
options.Options.T_STR: lambda v: str(v),
options.Options.T_TEXT: lambda v: str(v),
}
[docs]
def valid(self, logger:logging.Logger, args:argparse.Namespace, tm:float, pf:List[Dict[str, float]]=[]) -> Tuple[int, Dict[str, Any], Any]:
"""
コマンドの引数の妥当性を検証します
Args:
logger (logging.Logger): ロガー
args (argparse.Namespace): 引数
tm (float): 実行開始時間
pf (List[Dict[str, float]]): 呼出元のパフォーマンス
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
def_opt = self.get_option()
choices = def_opt.get('choice',[])
validators = self.custom_validators()
# 共通の引数のデフォルト値を設定
if not hasattr(args, 'format'): setattr(args, 'format', False)
if not hasattr(args, 'output_json'): setattr(args, 'output_json', None)
if not hasattr(args, 'output_json_append'): setattr(args, 'output_json_append', False)
# 引数の検証
for choice in choices:
opt = choice.get('opt', None)
default = choice.get('default', None)
required = choice.get('required', False)
type = choice.get('type', None)
multi = choice.get('multi', False)
fileio = choice.get('fileio', None)
if not opt:
continue
if not hasattr(args, opt):
setattr(args, opt, default)
val = getattr(args, opt)
# 必須オプションの検証
if required and type not in [options.Options.T_BOOL, options.Options.T_INT, options.Options.T_FLOAT]:
if not val:
msg = dict(warn=f"Please specify --{opt}")
common.print_format(msg, args.format, tm, pf=pf)
return self.RESP_WARN, msg, None
elif required and type in [options.Options.T_INT, options.Options.T_FLOAT]:
if val is None:
msg = dict(warn=f"Please specify --{opt}")
common.print_format(msg, args.format, tm, pf=pf)
return self.RESP_WARN, msg, None
# TODO: type==T_DATE, T_DATETIME, T_MLISTの検証
# Choicesの検証 TODO:type==T_DICTのときのchoice検証が必要
if type != options.Options.T_DICT:
opt_choices = choice.get('choice', None)
choice_edit_flag = choice.get('choice_edit', False)
if opt_choices is not None and not choice_edit_flag and val is not None:
valid_values = []
for c in opt_choices:
if isinstance(c, dict):
valid_values.append(c.get('opt'))
else:
valid_values.append(c)
check_vals = val if (multi and isinstance(val, list)) else [val]
if len(valid_values) > 0:
for v in check_vals:
if v not in valid_values:
msg = dict(warn=f"Invalid value for --{opt}: {v} (must be one of {valid_values})")
common.print_format(msg, args.format, tm, pf=pf)
return self.RESP_WARN, msg, None
# オプション固有のバリデーション
for validator in validators:
if multi and isinstance(val, list):
for v in val:
st, msg, obj = validator(logger, opt, type, v, fileio)
if st != self.RESP_SUCCESS:
common.print_format(msg, args.format, tm, pf=pf)
return st, msg, None
else:
st, msg, obj = validator(logger, opt, type, val, fileio)
if st != self.RESP_SUCCESS:
common.print_format(msg, args.format, tm, pf=pf)
return st, msg, None
return self.RESP_SUCCESS, {}, None
[docs]
def custom_validators(self) -> List[Callable[[logging.Logger, str, str, Any, str], Tuple[int, Dict[str, Any], Any]]]:
"""
オプションの値の妥当性を検証するカスタムバリデータのリストを返します
Returns:
List[Callable[[logging.Logger, str, str, Any, str], Tuple[int, Dict[str, Any], Any]]]: バリデータのリスト
"""
return [
self.valid_type,
self.valid_name,
self.valid_str_max_length,
self.valid_str_ctrlchar,
self.valid_data,
self.valid_signin_file,
]
[docs]
def valid_type(self, logger:logging.Logger, opt:str, type:str, val:Any, fileio:str) -> Tuple[int, Dict[str, Any], Any]:
"""
オプションの型の妥当性を検証します
Args:
logger (logging.Logger): ロガー
opt (str): オプション名
type (str): オプションの型
val (Any): オプションの値
fileio (str): ファイル入出力の種別 ('in' or 'out')
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
if type in self.validator_types and val is not None:
val = self.validator_type_castfunc.get(type, lambda v: v)(val)
if not any([isinstance(val, t) for t in self.validator_types[type]]):
msg = dict(warn=f"Invalid value for --{opt}: {val} (must be a {type})")
return self.RESP_WARN, msg, None
if type == options.Options.T_MLIST and val:
if not all(isinstance(v, str) for v in val):
msg = dict(warn=f"Invalid value for --{opt}: {val} (must be a list of strings)")
return self.RESP_WARN, msg, None
return self.RESP_SUCCESS, {}, None
[docs]
def valid_name(self, logger:logging.Logger, opt:str, type:str, val:Any, fileio:str) -> Tuple[int, Dict[str, Any], Any]:
"""
--nameオプションの値の妥当性を検証します
Args:
logger (logging.Logger): ロガー
opt (str): オプション名
type (str): オプションの型
val (Any): オプションの値
fileio (str): ファイル入出力の種別 ('in' or 'out')
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
if 'name' not in opt or not val: return self.RESP_SUCCESS, {}, None
if not re.match(r'^[\w\-]+$', val):
msg = dict(warn=f"{opt} can only contain alphanumeric characters, underscores, and hyphens.")
return self.RESP_WARN, msg, None
return self.RESP_SUCCESS, {}, None
[docs]
def valid_str_max_length(self, logger:logging.Logger, opt:str, type:str, val:Any, fileio:str) -> Tuple[int, Dict[str, Any], Any]:
"""
文字列の最大長の妥当性を検証します
Args:
logger (logging.Logger): ロガー
opt (str): オプション名
type (str): オプションの型
val (Any): オプションの値
fileio (str): ファイル入出力の種別 ('in' or 'out')
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
if type not in [options.Options.T_STR] or val is None:
return self.RESP_SUCCESS, {}, None
if len(val)>=LONG_TEXT_BOUNDARY:
msg = dict(warn=f"Invalid value for --{opt}: {val} (must be less than {LONG_TEXT_BOUNDARY} characters)")
return self.RESP_WARN, msg, None
return self.RESP_SUCCESS, {}, None
regs_ctrlchar = re.compile(r"[\x00-\x08\x0B\x0C\x0E-\x1F\x7F-\x9F]")
[docs]
def valid_str_ctrlchar(self, logger:logging.Logger, opt:str, type:str, val:Any, fileio:str) -> Tuple[int, Dict[str, Any], Any]:
"""
文字列に制御文字が含まれていないかの妥当性を検証します
Args:
logger (logging.Logger): ロガー
opt (str): オプション名
type (str): オプションの型
val (Any): オプションの値
fileio (str): ファイル入出力の種別 ('in' or 'out')
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
str_types = [k for k, v in self.validator_types.items() if str in v]
if type not in str_types or val is None:
return self.RESP_SUCCESS, {}, None
if isinstance(val, list):
for v in val:
if isinstance(v, Path): v = str(v)
if self.regs_ctrlchar.search(v):
msg = dict(warn=f"Invalid value for --{opt}: {v} (contains control characters)")
return self.RESP_WARN, msg, None
return self.RESP_SUCCESS, {}, None
if isinstance(val, Path): val = str(val)
if self.regs_ctrlchar.search(val):
msg = dict(warn=f"Invalid value for --{opt}: {val} (contains control characters)")
return self.RESP_WARN, msg, None
return self.RESP_SUCCESS, {}, None
[docs]
def valid_file_exist(self, logger:logging.Logger, opt:str, type:str, val:Any, fileio:str) -> Tuple[int, Dict[str, Any], Any]:
"""
ファイルの存在の妥当性を検証します
Args:
logger (logging.Logger): ロガー
opt (str): オプション名
type (str): オプションの型
val (Any): オプションの値
fileio (str): ファイル入出力の種別 ('in' or 'out')
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
if type not in [options.Options.T_FILE, options.Options.T_DIR] or val is None or fileio not in ['in']:
return self.RESP_SUCCESS, {}, None
path = Path(val)
if not path.exists():
msg = dict(warn=f"The path specified for '--{opt}' does not exist.")
return self.RESP_WARN, msg, None
if type == options.Options.T_FILE:
if not path.is_file():
msg = dict(warn=f"The path specified for '--{opt}' is not a file.")
return self.RESP_WARN, msg, None
if type == options.Options.T_DIR:
if not path.is_dir():
msg = dict(warn=f"The path specified for '--{opt}' is not a directory.")
return self.RESP_WARN, msg, None
return self.RESP_SUCCESS, {}, None
[docs]
def valid_data(self, logger:logging.Logger, opt:str, type:str, val:Any, fileio:str) -> Tuple[int, Dict[str, Any], Any]:
"""
--dataオプションの値の妥当性を検証します
Args:
logger (logging.Logger): ロガー
opt (str): オプション名
type (str): オプションの型
val (Any): オプションの値
fileio (str): ファイル入出力の種別 ('in' or 'out')
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
if opt!='data' or not val:
return self.RESP_SUCCESS, {}, None
path = Path(val)
if not path.exists():
msg = dict(warn=f"The path specified for '--data' does not exist.")
return self.RESP_WARN, msg, None
if not path.is_dir():
msg = dict(warn=f"The path specified for '--data' is not a directory.")
return self.RESP_WARN, msg, None
return self.RESP_SUCCESS, {}, None
[docs]
def valid_signin_file(self, logger:logging.Logger, opt:str, type:str, val:Any, fileio:str) -> Tuple[int, Dict[str, Any], Any]:
"""
--signin_fileオプションの値の妥当性を検証します
Args:
logger (logging.Logger): ロガー
opt (str): オプション名
type (str): オプションの型
val (Any): オプションの値
fileio (str): ファイル入出力の種別 ('in' or 'out')
Returns:
Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト
"""
if opt!='signin_file' or not val:
return self.RESP_SUCCESS, {}, None
path = Path(val)
if not path.exists():
msg = dict(warn=f"The path specified for '--signin_file' does not exist.")
return self.RESP_WARN, msg, None
if not path.is_file():
msg = dict(warn=f"The path specified for '--signin_file' is not a file.")
return self.RESP_WARN, msg, None
return self.RESP_SUCCESS, {}, None
[docs]
def init_test(self) -> None:
"""
テスト用の初期化処理を行います
"""
pass
[docs]
def cleaning_test(self) -> None:
"""
テスト用のクリーンアップ処理を行います
"""
pass