def __init__(self, logger=None, ignored_extensions=None):
"""
constructor
"""
self.__log = None
if logger is None:
self.__log = logging.getLogger("TagStoreLogger")
else:
self.__log = logger
self.file_system = FileSystem()
self.__IGNORED_FILE_PREFIXES = ["~$", "."]
self.__IGNORED_DIR_PREFIXES = ["."]
if ignored_extensions is None:
self.__IGNORED_EXTENSIONS = TsRestrictions.IGNORED_EXTENSIONS
else:
self.__IGNORED_EXTENSIONS = ignored_extensions
def __init__(self, logger=None, ignored_extensions=None):
"""
constructor
"""
self.__log = None
if logger is None:
self.__log = logging.getLogger("TagStoreLogger")
else:
self.__log = logger
self.file_system = FileSystem()
self.__IGNORED_FILE_PREFIXES = ["~$", "."]
self.__IGNORED_DIR_PREFIXES = ["."]
if ignored_extensions is None:
self.__IGNORED_EXTENSIONS = TsRestrictions.IGNORED_EXTENSIONS
else:
self.__IGNORED_EXTENSIONS = ignored_extensions
class FileSystemWrapper():
def __init__(self, logger=None, ignored_extensions=None):
"""
constructor
"""
self.__log = None
if logger is None:
self.__log = logging.getLogger("TagStoreLogger")
else:
self.__log = logger
self.file_system = FileSystem()
self.__IGNORED_FILE_PREFIXES = ["~$", "."]
self.__IGNORED_DIR_PREFIXES = ["."]
if ignored_extensions is None:
self.__IGNORED_EXTENSIONS = TsRestrictions.IGNORED_EXTENSIONS
else:
self.__IGNORED_EXTENSIONS = ignored_extensions
def add_ignored_extensions(self, extension_list):
self.__IGNORED_EXTENSIONS = self.__IGNORED_EXTENSIONS + extension_list
def get_os(self):
"""
returns the systems os as enumerable EOS
"""
return self.file_system.get_type()
def get_user_profile_path(self):
"""
returns the user profile path of the current user
"""
return unicode((os.environ['USERPROFILE']).replace("\\", "/").rstrip("/"))
def path_exists(self, path):
"""
returns True if given path exists, else False
"""
path = unicode(path)
return os.path.exists(path)
def find_files(self, in_path, search_path):
"""
returns a list of files including the search_path from the directory in_path
caution: this method does not provide a hierarchical search- use os.walk() for this purpose
"""
in_path = unicode(in_path)
search_path = unicode(search_path)
files = []
if not os.path.exists(in_path):
return files
for file in os.listdir(in_path):
path = in_path + "/" + file + "/" + search_path
if os.path.exists(path):
files.append(path)
return files
def get_files(self, directory):
"""
returns a list of files found in the given directory filtered by ignore- settings
"""
directory = unicode(directory)
files = []
ignored = []
for item in os.listdir(directory):
if os.path.isfile(directory + "/" + item):
files.append(item)
## handle ignore-list
for ext in self.__IGNORED_EXTENSIONS:
if item.endswith(ext):
ignored.append(item)
for prefix in self.__IGNORED_FILE_PREFIXES:
if item.startswith(prefix):
ignored.append(item)
return list(set(files) - set(ignored))
def get_directories(self, directory):
"""
returns a list of dirs found in the given directory filtered by ignore- settings
"""
directory = unicode(directory)
files = []
ignored = []
for item in os.listdir(directory):
if os.path.isdir(directory + "/" + item):
files.append(item)
## handle ignore list
for prefix in self.__IGNORED_DIR_PREFIXES:
if item.startswith(prefix):
ignored.append(item)
return list(set(files) - set(ignored))
def is_directory(self, path):
"""
returns True if the given path points to a directory
"""
path = unicode(path)
return os.path.isdir(path)
def create_dir(self, path_name):
"""
creates a directory with the given pathname at the filesystem
"""
path_name = unicode(path_name)
if not self.path_exists(path_name):
self.__log.debug("creating dir with the path: %s" % path_name)
os.mkdir(path_name)
def delete_dir_content(self, path_name):
"""
deletes the directories content without deleting the root folder
"""
path_name = unicode(path_name)
if self.path_exists(path_name):
self.__log.debug("deleting dir content: %s" % path_name)
for item in os.listdir(unicode(path_name)):
item_path = unicode(path_name) + unicode("/") + item
if os.path.isdir(item_path):
self.delete_dir(item_path)
elif os.path.islink(item_path):
os.unlink(item_path)
else:
os.remove(item_path)
def delete_dir(self, path_name):
"""
deletes a given directory and its content
"""
path_name = unicode(path_name)
if self.path_exists(path_name):
self.__log.debug("deleting dir: %s" % path_name)
for item in os.listdir(path_name):
item_path = path_name + unicode("/") + item
if os.path.isdir(item_path):
self.delete_dir(item_path)
elif os.path.islink(item_path):
os.unlink(item_path)
else:
os.remove(item_path)
#self.__log.debug("deleting dir: %s" % path_name)
os.rmdir(path_name)
def create_link(self, source, link_path):
"""
creates a symbolic link on Linux and Mac, a .lnk link at Windows file systems
pointing to source, named link_name."
source -> the original file/dir
link_path -> the path to the link
"""
source = unicode(source)
link_path = unicode(link_path)
## at first check if the link already exists
##TODO @wolfgang ... tried it with a whitespace containing (dir)item - and it did not check that the path already exists
if os.path.exists(link_path):
self.__log.debug("link (%s) already exists ... do nothing" % link_path)
return
self.__log.debug("creating link --- %s --- with the path: %s" % (link_path, source))
if source.find(":/") == -1:
source = source.replace(":", ":/")
if link_path.find(":/") == -1:
link_path = link_path.replace(":", ":/")
self.file_system.create_link(source, link_path)
# def move_file(self, file_path, target_directory):
# """
# moves an existing file to another directory
# """
# pass
def rename_file(self, src, dst):
"""
creates a file at the file system
"""
src = unicode(src)
dst = unicode(dst)
os.rename(src, dst)
def create_file(self, file_path):
"""
creates a file at the file system
"""
file_path = unicode(file_path)
file = open(file_path, "w")
file.close()
def move(self, old_path, new_path):
"""
move the whole old path with its contents to the new path
"""
if self.path_exists(old_path):
shutil.move(old_path, new_path)
#os.rename(old_path, new_path)
def remove_file(self, file_path):
"""
removes a file from filesystem
"""
file_path = unicode(file_path)
if self.path_exists(file_path):
os.remove(file_path)
def remove_link(self, file_path):
"""
removes a given link from file system and also the folder if it's empty
"""
file_path = unicode(file_path)
self.file_system.remove_link(file_path)
def inode_shortage(self, file_path):
"""
returns True, if the free number of inodes (non-root) < TsRestrictions.INODE_THRESHOLD (10%) of all available
Caution: Windows does not support this functionality, that's why it returns False in any case
"""
file_path = unicode(file_path)
return self.file_system.inode_shortage(file_path, TsRestrictions.INODE_THRESHOLD)
class FileSystemWrapper():
def __init__(self, logger=None, ignored_extensions=None):
"""
constructor
"""
self.__log = None
if logger is None:
self.__log = logging.getLogger("TagStoreLogger")
else:
self.__log = logger
self.file_system = FileSystem()
self.__IGNORED_FILE_PREFIXES = ["~$", "."]
self.__IGNORED_DIR_PREFIXES = ["."]
if ignored_extensions is None:
self.__IGNORED_EXTENSIONS = TsRestrictions.IGNORED_EXTENSIONS
else:
self.__IGNORED_EXTENSIONS = ignored_extensions
def add_ignored_extensions(self, extension_list):
self.__IGNORED_EXTENSIONS = self.__IGNORED_EXTENSIONS + extension_list
def get_os(self):
"""
returns the systems os as enumerable EOS
"""
return self.file_system.get_type()
def get_user_profile_path(self):
"""
returns the user profile path of the current user
"""
return unicode((os.environ['USERPROFILE']).replace("\\",
"/").rstrip("/"))
def path_exists(self, path):
"""
returns True if given path exists, else False
"""
path = unicode(path)
return os.path.exists(path)
def find_files(self, in_path, search_path):
"""
returns a list of files including the search_path from the directory in_path
caution: this method does not provide a hierarchical search- use os.walk() for this purpose
"""
in_path = unicode(in_path)
search_path = unicode(search_path)
files = []
if not os.path.exists(in_path):
return files
for file in os.listdir(in_path):
path = in_path + "/" + file + "/" + search_path
if os.path.exists(path):
files.append(path)
return files
def get_files(self, directory):
"""
returns a list of files found in the given directory filtered by ignore- settings
"""
directory = unicode(directory)
files = []
ignored = []
for item in os.listdir(directory):
if os.path.isfile(directory + "/" + item):
files.append(item)
## handle ignore-list
for ext in self.__IGNORED_EXTENSIONS:
if item.endswith(ext):
ignored.append(item)
for prefix in self.__IGNORED_FILE_PREFIXES:
if item.startswith(prefix):
ignored.append(item)
return list(set(files) - set(ignored))
def get_directories(self, directory):
"""
returns a list of dirs found in the given directory filtered by ignore- settings
"""
directory = unicode(directory)
files = []
ignored = []
for item in os.listdir(directory):
if os.path.isdir(directory + "/" + item):
files.append(item)
## handle ignore list
for prefix in self.__IGNORED_DIR_PREFIXES:
if item.startswith(prefix):
ignored.append(item)
return list(set(files) - set(ignored))
def is_directory(self, path):
"""
returns True if the given path points to a directory
"""
path = unicode(path)
return os.path.isdir(path)
def create_dir(self, path_name):
"""
creates a directory with the given pathname at the filesystem
"""
path_name = unicode(path_name)
if not self.path_exists(path_name):
self.__log.debug("creating dir with the path: %s" % path_name)
os.mkdir(path_name)
def delete_dir_content(self, path_name):
"""
deletes the directories content without deleting the root folder
"""
path_name = unicode(path_name)
if self.path_exists(path_name):
self.__log.debug("deleting dir content: %s" % path_name)
for item in os.listdir(unicode(path_name)):
item_path = unicode(path_name) + unicode("/") + item
if os.path.isdir(item_path):
self.delete_dir(item_path)
elif os.path.islink(item_path):
os.unlink(item_path)
else:
os.remove(item_path)
def delete_dir(self, path_name):
"""
deletes a given directory and its content
"""
path_name = unicode(path_name)
if self.path_exists(path_name):
self.__log.debug("deleting dir: %s" % path_name)
for item in os.listdir(path_name):
item_path = path_name + unicode("/") + item
if os.path.isdir(item_path):
self.delete_dir(item_path)
elif os.path.islink(item_path):
os.unlink(item_path)
else:
os.remove(item_path)
#self.__log.debug("deleting dir: %s" % path_name)
os.rmdir(path_name)
def create_link(self, source, link_path):
"""
creates a symbolic link on Linux and Mac, a .lnk link at Windows file systems
pointing to source, named link_name."
source -> the original file/dir
link_path -> the path to the link
"""
source = unicode(source)
link_path = unicode(link_path)
## at first check if the link already exists
##TODO @wolfgang ... tried it with a whitespace containing (dir)item - and it did not check that the path already exists
if os.path.exists(link_path):
self.__log.debug("link (%s) already exists ... do nothing" %
link_path)
return
self.__log.debug("creating link --- %s --- with the path: %s" %
(link_path, source))
if source.find(":/") == -1:
source = source.replace(":", ":/")
if link_path.find(":/") == -1:
link_path = link_path.replace(":", ":/")
self.file_system.create_link(source, link_path)
# def move_file(self, file_path, target_directory):
# """
# moves an existing file to another directory
# """
# pass
def rename_file(self, src, dst):
"""
creates a file at the file system
"""
src = unicode(src)
dst = unicode(dst)
os.rename(src, dst)
def create_file(self, file_path):
"""
creates a file at the file system
"""
file_path = unicode(file_path)
file = open(file_path, "w")
file.close()
def move(self, old_path, new_path):
"""
move the whole old path with its contents to the new path
"""
if self.path_exists(old_path):
shutil.move(old_path, new_path)
#os.rename(old_path, new_path)
def remove_file(self, file_path):
"""
removes a file from filesystem
"""
file_path = unicode(file_path)
if self.path_exists(file_path):
os.remove(file_path)
def remove_link(self, file_path):
"""
removes a given link from file system and also the folder if it's empty
"""
file_path = unicode(file_path)
self.file_system.remove_link(file_path)
def inode_shortage(self, file_path):
"""
returns True, if the free number of inodes (non-root) < TsRestrictions.INODE_THRESHOLD (10%) of all available
Caution: Windows does not support this functionality, that's why it returns False in any case
"""
file_path = unicode(file_path)
return self.file_system.inode_shortage(file_path,
TsRestrictions.INODE_THRESHOLD)