mirror of
https://github.com/platomav/BIOSUtilities.git
synced 2024-09-19 15:28:54 -04:00
120 lines
3.9 KiB
Python
120 lines
3.9 KiB
Python
#!/usr/bin/env python3
|
|
#coding=utf-8
|
|
|
|
import os
|
|
import re
|
|
import sys
|
|
import inspect
|
|
from pathlib import Path
|
|
|
|
from common.text_ops import to_string
|
|
|
|
# Fix illegal/reserved Windows characters
|
|
def get_safe_name(in_name):
|
|
raw_name = repr(in_name).strip("'")
|
|
|
|
fix_name = re.sub(r'[\\/*?:"<>|]', '_', raw_name)
|
|
|
|
return fix_name
|
|
|
|
# Check and attempt to fix illegal/unsafe OS path traversals
|
|
def get_safe_path(base_path, user_paths, follow_symlinks=False):
|
|
# Convert user path(s) to string w/ OS separators
|
|
user_path = to_string(user_paths, os.sep)
|
|
|
|
# Create target path from base + requested user path
|
|
target_path = get_norm_path(base_path, user_path)
|
|
|
|
# Check if target path is OS illegal/unsafe
|
|
if is_safe_path(base_path, target_path, follow_symlinks):
|
|
return target_path
|
|
|
|
# Re-create target path from base + leveled/safe illegal "path" (now file)
|
|
nuked_path = get_norm_path(base_path, get_safe_name(user_path))
|
|
|
|
# Check if illegal path leveling worked
|
|
if is_safe_path(base_path, nuked_path, follow_symlinks):
|
|
return nuked_path
|
|
|
|
# Still illegal, create fallback base path + placeholder file
|
|
failed_path = get_norm_path(base_path, 'illegal_path_traversal')
|
|
|
|
return failed_path
|
|
|
|
# Check for illegal/unsafe OS path traversal
|
|
def is_safe_path(base_path, target_path, follow_symlinks=True):
|
|
if follow_symlinks:
|
|
actual_path = os.path.realpath(target_path)
|
|
else:
|
|
actual_path = os.path.abspath(target_path)
|
|
|
|
common_path = os.path.commonpath((base_path, actual_path))
|
|
|
|
return base_path == common_path
|
|
|
|
# Create normalized base path + OS separator + user path
|
|
def get_norm_path(base_path, user_path):
|
|
return os.path.normpath(base_path + os.sep + user_path)
|
|
|
|
# Walk path to get all files
|
|
def get_path_files(in_path):
|
|
path_files = []
|
|
|
|
for root, _, files in os.walk(in_path):
|
|
for name in files:
|
|
path_files.append(os.path.join(root, name))
|
|
|
|
return path_files
|
|
|
|
# Get parent of path
|
|
def get_path_parent(in_path):
|
|
return Path(in_path).parent.absolute()
|
|
|
|
# Get absolute file path (argparse object)
|
|
def get_absolute_path(argparse_path):
|
|
script_dir = get_path_parent(get_script_dir())
|
|
|
|
if not argparse_path:
|
|
absolute_path = script_dir # Use input file directory if no user path is specified
|
|
else:
|
|
# Check if user specified path is absolute, otherwise convert it to input file relative
|
|
if Path(argparse_path).is_absolute(): absolute_path = argparse_path
|
|
else: absolute_path = os.path.join(script_dir, argparse_path)
|
|
|
|
return absolute_path
|
|
|
|
# Process input files (argparse object)
|
|
def process_input_files(argparse_args, sys_argv=None):
|
|
if sys_argv is None: sys_argv = []
|
|
|
|
if len(sys_argv) >= 2:
|
|
# Drag & Drop or CLI
|
|
if argparse_args.input_dir:
|
|
input_path_user = argparse_args.input_dir
|
|
input_path_full = get_absolute_path(input_path_user) if input_path_user else ''
|
|
input_files = get_path_files(input_path_full)
|
|
else:
|
|
input_files = [file.name for file in argparse_args.files]
|
|
|
|
output_path = get_absolute_path(argparse_args.output_dir or argparse_args.input_dir)
|
|
else:
|
|
# Script w/o parameters
|
|
input_path_user = input('\nEnter input directory path: ')
|
|
input_path_full = get_absolute_path(input_path_user) if input_path_user else ''
|
|
input_files = get_path_files(input_path_full)
|
|
|
|
output_path = get_absolute_path(input('\nEnter output directory path: '))
|
|
|
|
return input_files, output_path
|
|
|
|
# https://stackoverflow.com/a/22881871 by jfs
|
|
def get_script_dir(follow_symlinks=True):
|
|
if getattr(sys, 'frozen', False):
|
|
path = os.path.abspath(sys.executable)
|
|
else:
|
|
path = inspect.getabsfile(get_script_dir)
|
|
|
|
if follow_symlinks:
|
|
path = os.path.realpath(path)
|
|
|
|
return os.path.dirname(path)
|