Maxim Devaev 630610bc53 switch
2024-12-17 18:20:04 +02:00

107 lines
3.6 KiB
Python

# ========================================================================== #
# #
# KVMD - The main PiKVM daemon. #
# #
# Copyright (C) 2018-2024 Maxim Devaev <mdevaev@gmail.com> #
# #
# This program is free software: you can redistribute it and/or modify #
# it under the terms of the GNU General Public License as published by #
# the Free Software Foundation, either version 3 of the License, or #
# (at your option) any later version. #
# #
# This program is distributed in the hope that it will be useful, #
# but WITHOUT ANY WARRANTY; without even the implied warranty of #
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
# GNU General Public License for more details. #
# #
# You should have received a copy of the GNU General Public License #
# along with this program. If not, see <https://www.gnu.org/licenses/>. #
# #
# ========================================================================== #
import os
import stat
from typing import Any
from . import raise_error
from . import filter_printable
from .basic import valid_number
from .basic import valid_string_list
from .basic import valid_stripped_string_not_empty
# =====
def valid_abs_path(arg: Any, type: str="", name: str="") -> str: # pylint: disable=redefined-builtin
if type:
if not name:
name = f"absolute path to existent {type}"
type = {
"file": "reg",
"dir": "dir",
"link": "lnk",
"sock": "sock",
"fifo": "fifo",
"char": "chr",
"block": "blk",
}[type]
else:
if not name:
name = "absolute path"
arg = os.path.abspath(valid_stripped_string_not_empty(arg, name))
if type:
try:
st = os.stat(arg)
except Exception as ex:
raise_error(arg, f"{name}: {ex}")
else:
if not getattr(stat, f"S_IS{type.upper()}")(st.st_mode):
raise_error(arg, name)
return arg
def valid_abs_file(arg: Any, name: str="") -> str:
return valid_abs_path(arg, type="file", name=name)
def valid_abs_dir(arg: Any, name: str="") -> str:
return valid_abs_path(arg, type="dir", name=name)
def valid_printable_filename(arg: Any, name: str="") -> str:
if not name:
name = "printable filename"
arg = valid_stripped_string_not_empty(arg, name)
if (
"/" in arg
or "\0" in arg
or arg.startswith(".")
or arg == "lost+found"
):
raise_error(arg, name)
return filter_printable(arg, "_", 255)
# =====
def valid_unix_mode(arg: Any) -> int:
return int(valid_number(arg, min=0, name="UNIX mode"))
def valid_options(arg: Any, name: str="") -> list[str]:
if not name:
name = "options"
return valid_string_list(arg, delim=r"[,\t]+", name=name)
def valid_command(arg: Any) -> list[str]:
cmd = valid_options(arg, name="command")
if len(cmd) == 0:
raise_error(arg, "command")
cmd[0] = valid_abs_file(cmd[0], name="command entry point")
return cmd