hal/files/models/system.py
# -*- coding: utf-8 -*-
"""File system utils, renaming and parsing """
import os
import re
from send2trash import send2trash
from hal.strings.models import String
BAD_CHARS = [
".", ":", "\"", "’", "&", "720p", "1080p", "yify", ",", "brrip", "bluray",
"Bokutox", "x264", "[", "]", "sparks", "h264",
"aac", "ozlem", "ac3", "ozlem", "etrg", "dvdrip", "xvid", "nydic",
"sujaidr", "x265", "hevc", "(pimprg)", "aac",
"ozlem", "remastered", "anoxmous",
"yts"] # official formats based on wikipedia
RUSSIAN_CHARS = ["ш", "а", "б", "л", "о", "н", "ы", "р", "е", "а", "л", "и",
"з", "а", "ц", "и", "и", "к",
"о", "р", "п", "о", "р", "а", "т", "и", "в", "н", "ы", "х",
"п", "р", "и", "л", "о", "ж", "е", "н", "и", "й",
"в", "о", "п", "р", "о", "с", "ы", "и", "о", "т", "в", "е",
"т", "ы", "п", "о", "б", "е", "з", "о", "п",
"а", "с", "н", "о", "с", "т", "и", "д", "а", "н", "н", "ы",
"х"]
VIDEO_FORMAT = [".", ".3g2", ".3gp", ".amv", ".asf", ".avi", ".drc", ".f4a",
".f4b", ".f4p", ".f4v", ".flv",
".gifv", ".m2v", ".m4p", ".m4v", ".mkv", ".mng", ".mov",
".mp2", ".mp4", ".mpe", ".mpeg", ".mpg", ".mpv", ".mxf",
".nsv", ".ogg", ".ogv", ".qt", ".rm", ".rmvb", ".roq", ".svi",
".vob", ".webm", ".wmv", ".yuv"]
ARCHIVE_FORMAT = [".7z", ".??_", ".?Q?", ".?Z?", ".a", ".ace", ".afa", ".alz",
".apk", ".ar", ".arc", ".arj",
".b1", ".ba", ".bh", ".bz2", ".cab", ".car", ".cfs", ".cpio",
".cpt", ".dar", ".dd", ".dgc",
".dmg", ".ear", ".ecc", ".F", ".gca", ".gz", ".ha", ".hki",
".ice", ".infl", ".iso", ".jar",
".kgb", ".LBR", ".lbr", ".lha", ".lz", ".lzh", ".lzma",
".lzo", ".lzx", ".mar", ".pak", ".paq6",
".paq7", ".paq8", ".par", ".par2", ".partimg", ".pea",
".pim", ".pit", ".qda", ".rar", ".rk",
".rz", ".s7z", ".sda", ".sea", ".sen", ".sfark", ".sfx",
".shar", ".shk", ".sit", ".sitx",
".sqx", ".sz", ".tar", ".tar.bz2", ".tar.gz", ".tar.lzma",
".tar.Z", ".tbz2", ".tgz", ".tlz",
".uc", ".uc0", ".uc2", ".uca", ".ucn", ".ue2", ".uha",
".ur2", ".war", ".wim", ".xar", ".xp3",
".xz", ".yz1", ".z", ".Z", ".zip", ".zipx", ".zoo", ".zpaq",
".zz"]
SUBTITLE_FORMAT = [".srt", ".sub", ".sbv"]
TEXT_FORMAT = [".cnf", ".conf", ".cfg", ".chm", ".epub", ".log", ".asc",
".txt", ".url"]
IMAGE_FORMAT = [".ani", ".bmp", ".cal", ".fax", ".gif", ".img", ".jbg", ".jpe",
".jpe", ".jpg", ".mac", ".pbm",
".pcd", ".pcx", ".pct", ".pgm", ".png", ".ppm", ".psd", ".ras",
".tga", ".tif", ".wmf"]
AUDIO_FORMAT = [".3gp", ".aa", ".aac", ".aax", ".act", ".aiff", ".amr", ".ape",
".au", ".awb", ".dct", ".dss", ".dvf",
".flac", ".gsm", ".iklax", ".ivs", ".m4a", ".m4b", ".m4p",
".mmf", ".mogg", ".mp3", ".mpc", ".msv",
".oga", ".ogg", ".opus", ".ra", ".raw", ".rm", ".sln", ".tta",
".vox", ".wav", ".webm", ".wma", ".wv"]
PATH_SEPARATOR = "/" if "posix" in os.name else "\\"
def fix_raw_path(path):
"""Prettify name of path
:param path: path to fix
:return: Good name for path
"""
double_path_separator = PATH_SEPARATOR + PATH_SEPARATOR
while path.find(
double_path_separator) >= 0: # there are double separators
path = path.replace(double_path_separator,
PATH_SEPARATOR) # remove double path separator
if is_folder(path) and not path.endswith("/"):
path = path + "/"
return path
def remove_year(name):
"""Removes year from input
:param name: path to edit
:return: inputs with no years
"""
for i in range(len(
name) - 3): # last index is length - 3 - 1 = length - 4
if name[i: i + 4].isdigit():
name = name[:i] + name[i + 4:]
return remove_year(
name) # if there is a removal, start again
return name
def remove_brackets(name):
"""Removes brackets form input
:param name: path to fix
:return: inputs with no brackets
"""
name = re.sub(
r"([(\[]).*?([)\]])",
r"\g<1>\g<2>",
name
) # remove anything in between brackets
brackets = "()[]{}" # list of brackets
for bracket in brackets:
name = name.replace(bracket, "")
return name
def extract_name_max_chars(name, max_chars=64, blank=" "):
"""Extracts max chars in name truncated to nearest word
:param name: path to edit
:param max_chars: max chars of new name
:param blank: char that represents the blank between words
:return: Name edited to contain at most max_chars
"""
new_name = name.strip()
if len(new_name) > max_chars:
new_name = new_name[:max_chars] # get at most 64 chars
if new_name.rfind(blank) > 0:
new_name = new_name[:new_name.rfind(blank)] # nearest word
return new_name
def prettify(name, blank=" "):
"""Prettify name of path
:param name: path Name: to edit
:param blank: default blanks in name
:return: Prettier name from given one: replace bad chars with good ones
"""
if name.startswith("."): # remove starting
name = name[1:]
for bad_char in BAD_CHARS:
name = name.replace(bad_char, blank) # remove token
name = String(name).remove_all(blank)
for i in range(1, len(name) - 2):
try:
are_blanks = name[i - 1] == blank and name[i + 1] == blank
if are_blanks and name[i] in BAD_CHARS:
name = name[:i - 1] + name[i + 2:]
except: # out of bounds
pass
if name.startswith(blank):
name = name[1:]
if name.endswith(blank): # remove ending replacement
name = name[:-1]
return name
def is_file(path):
"""Checks if path is file
:param path: path to check
:return: True iff path is a file
"""
return os.path.isfile(path)
def is_folder(path):
"""Checks if path is folder
:param path: path to check
:return: True iff path is a file
"""
return os.path.isdir(path)
def get_parent_folder_name(file_path):
"""Finds parent folder of file
:param file_path: path
:return: Name of folder container
"""
return os.path.split(os.path.split(os.path.abspath(file_path))[0])[-1]
def get_folder_name(file_path):
"""Finds name of folder
:param file_path: path
:return: Name of folder
"""
return os.path.split(os.path.abspath(file_path))[-1]
def ls_dir(path, include_hidden=False):
"""Finds content of folder
:param path: directory to get list of files and folders
:param include_hidden: True iff include hidden files in list
:return: List of paths in given directory
"""
lst = []
for file in os.listdir(path):
hidden_file = FileSystem(file).is_hidden()
if (hidden_file and include_hidden) or (not hidden_file):
lst.append(os.path.join(path, file))
return list(set(lst))
def ls_recurse(path, include_hidden=False):
"""Finds content of folder recursively
:param path: directory to get list of files and folders
:param include_hidden: True iff include hidden files in list
:return: List of paths in given directory recursively
"""
lst = []
for file in os.listdir(path):
hidden_file = FileSystem(file).is_hidden()
if (hidden_file and include_hidden) or (not hidden_file):
lst.append(os.path.join(path, file))
if is_folder(os.path.join(path, file)):
lst += ls_recurse(
os.path.join(path, file),
include_hidden=include_hidden
) # get list of files in directory
return list(set(lst))
def list_content(path, recurse, include_hidden=False):
"""Finds content of folder (recursively)
:param path: directory to get list of files and folders
:param recurse: True iff recurse into subdirectories or not
:param include_hidden: True iff include hidden files in list
:return: List of paths in given directory recursively
"""
if recurse:
return ls_recurse(path, include_hidden=include_hidden)
return ls_dir(path, include_hidden=include_hidden)
class FileSystem:
"""Models a folder/file in a OS"""
def __init__(self, path):
"""
:param path: Path to file
"""
self.path = fix_raw_path(path)
self.name, self.extension = os.path.splitext(self.path)
def is_hidden(self):
"""Checks if file is hidden
:return: True iff path is hidden
"""
return self.name.startswith(".")
def is_archive_mac(self):
"""Checks if file is a MAC archive
:return: True iff document is an MACOSX archive
"""
return "macosx" in self.path.lower()
def is_russian(self):
"""Checks if file path is russian
:return: True iff document has a russian name
"""
russian_chars = 0
for char in RUSSIAN_CHARS:
if char in self.name:
russian_chars += 1 # found a russian char
return russian_chars > len(RUSSIAN_CHARS) / 2.0
def trash(self):
"""Trashes given file/folder"""
send2trash(self.path)
def rename(self, new_path):
"""Renames to new path
:param new_path: new path to use
"""
rename_path = fix_raw_path(new_path)
if is_folder(self.path):
os.rename(self.path, rename_path)
else:
os.renames(self.path, rename_path)