def __init__(self, host, user, cache_path, remote_path, port=22):
self.logger = logging.getLogger('oxfs')
self.sys = platform.system()
self.host = host
self.port = port
self.user = user
self.cache_path = cache_path
self.remote_path = os.path.normpath(remote_path)
self.client, self.sftp = self.open_sftp()
self.taskpool = TaskExecutorService(4)
self.attributes = MemoryCache(prefix='attributes')
self.directories = MemoryCache(prefix='directories')
if not os.path.exists(self.cache_path):
os.makedirs(self.cache_path)
class Oxfs(LoggingMixIn, Operations):
'''
A dead simple, fast SFTP file system. Home: https://oxfs.io/
You need to be able to login to remote host without entering a password.
'''
def __init__(self,
host,
user,
cache_path,
remote_path,
port=22,
password=None):
self.logger = logging.getLogger('oxfs')
self.sys = platform.system()
self.host = host
self.port = port
self.user = user
self.password = password
self.cache_path = cache_path
self.remote_path = os.path.normpath(remote_path)
self.client, self.sftp = self.open_sftp()
self.attributes = MemoryCache(prefix='attributes')
self.directories = MemoryCache(prefix='directories')
if not os.path.exists(self.cache_path):
os.makedirs(self.cache_path)
def start_thread_pool(self):
self.taskpool = TaskExecutorService(multiprocessing.cpu_count())
def start_apiserver(self, port):
self.apiserver = OxfsApi(self)
self.apiserver.run(port)
def spawnvpe(self):
p = sys.argv
if self.password:
p.append('--password')
p.append(base64.b64encode(self.password.encode()).decode())
p.remove('--daemon')
subprocess.Popen(p, env=os.environ)
def getpass(self):
if self.password:
return self.password
prompt = '''{}@{}'s password: '''.format(self.user, self.host)
self.password = getpass.getpass(prompt)
return self.password
def open_sftp(self):
client = paramiko.SSHClient()
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
client.load_system_host_keys()
if not self.password:
try:
client.connect(self.host, port=self.port, username=self.user)
return client, client.open_sftp()
except paramiko.ssh_exception.AuthenticationException:
self.getpass()
try:
client.connect(self.host,
port=self.port,
username=self.user,
password=self.getpass())
except paramiko.ssh_exception.AuthenticationException as e:
print('Permission denied.')
self.logger.exception(e)
sys.exit(1)
return client, client.open_sftp()
def current_thread_sftp(self, thread_local_data):
sftp = thread_local_data.get('sftp')
if sftp is not None:
return sftp
client, sftp = self.open_sftp()
thread_local_data['sftp'] = sftp
thread_local_data['client'] = client
# thread terminate hook
thread_local_data['exit_hook'] = self.sftp_destroy
return thread_local_data['sftp']
def sftp_destroy(self, thread_local_data):
client = thread_local_data.get('client')
sftp = thread_local_data.get('sftp')
if sftp is not None:
sftp.close()
client.close()
def cachefile(self, path):
return os.path.join(self.cache_path, xxhash.xxh64_hexdigest(path))
def remotepath(self, path):
return os.path.normpath(os.path.join(self.remote_path, path[1:]))
@synchronized
def trylock(self, path):
lockfile = self.cachefile(path) + '.lockfile'
if os.path.exists(lockfile):
return False
open(lockfile, 'wb').close()
return True
@synchronized
def unlock(self, path):
lockfile = self.cachefile(path) + '.lockfile'
os.remove(lockfile)
def getfile(self, thread_local_data, path):
cachefile = self.cachefile(path)
if os.path.exists(cachefile):
self.logger.info('exists, skip it. {}'.format(path))
return False
if not self.trylock(path):
self.logger.info('getfile lock failed {}'.format(path))
return False
self.logger.info('getfile {}'.format(path))
tmpfile = cachefile + '.tmpfile'
self.current_thread_sftp(thread_local_data).get(path, tmpfile)
os.rename(tmpfile, cachefile)
self.unlock(path)
return True
def extract(self, attr):
return dict((key, getattr(attr, key))
for key in ('st_atime', 'st_gid', 'st_mode', 'st_mtime',
'st_size', 'st_uid'))
def _chmod(self, path, mode):
self.logger.info('sftp chmod {}, mode {}'.format(path, mode))
return self.sftp.chmod(path, mode)
def chmod(self, path, mode):
path = self.remotepath(path)
cachefile = self.cachefile(path)
if os.path.exists(cachefile):
os.chmod(self.cachefile(path), mode)
self.attributes.insert(path, self.extract(os.lstat(cachefile)))
return self._chmod(path, mode)
else:
status = self._chmod(path, mode)
self.attributes.remove(path)
return status
def chown(self, path, uid, gid):
path = self.remotepath(path)
return self.sftp.chown(path, uid, gid)
def create(self, path, mode):
path = self.remotepath(path)
self.logger.info('create {}, ignore mode {}'.format(path, mode))
cachefile = self.cachefile(path)
open(cachefile, 'wb').close()
self.sftp.open(path, 'wb').close()
self.attributes.remove(path)
self.directories.remove(os.path.dirname(path))
return 0
def getattr(self, path, fh=None):
path = self.remotepath(path)
attr = self.attributes.fetch(path)
if attr is not None:
if ENOENT == attr:
raise FuseOSError(ENOENT)
return attr
self.logger.info('sftp getattr {}'.format(path))
try:
attr = self.extract(self.sftp.lstat(path))
self.attributes.insert(path, attr)
return attr
except:
self.attributes.insert(path, ENOENT)
raise FuseOSError(ENOENT)
def mkdir(self, path, mode):
path = self.remotepath(path)
self.logger.info('mkdir {}'.format(path))
status = self.sftp.mkdir(path, mode)
self.attributes.remove(path)
self.directories.remove(os.path.dirname(path))
return status
def read(self, path, size, offset, fh):
path = self.remotepath(path)
cachefile = self.cachefile(path)
if os.path.exists(cachefile):
with open(cachefile, 'rb') as infile:
infile.seek(offset, 0)
return infile.read(size)
task = Task(xxhash.xxh64(path).intdigest(), self.getfile, path)
self.taskpool.submit(task)
with self.sftp.open(path, 'rb') as infile:
infile.seek(offset, 0)
return infile.read(size)
def readdir(self, path, fh=None):
path = self.remotepath(path)
entries = self.directories.fetch(path)
if entries is None:
entries = self.sftp.listdir(path)
self.directories.insert(path, entries)
self.logger.info('sftp readdir {} = {}'.format(path, entries))
return entries + ['.', '..']
def readlink(self, path):
path = self.remotepath(path)
return self.sftp.readlink(path)
def rename(self, old, new):
old = self.remotepath(old)
new = self.remotepath(new)
self.logger.info('rename {} {}'.format(old, new))
self.taskpool.wait(xxhash.xxh64(old).intdigest())
try:
self.unlink(new)
except Exception as e:
self.logger.debug(e)
status = self.sftp.rename(old, new)
self.attributes.remove(old)
self.attributes.remove(new)
self.directories.remove(os.path.dirname(old))
self.directories.remove(os.path.dirname(new))
return status
def rmdir(self, path):
path = self.remotepath(path)
self.logger.info('rmdir {}'.format(path))
status = self.sftp.rmdir(path)
self.attributes.remove(path)
self.directories.remove(os.path.dirname(path))
return status
def symlink(self, target, source):
target = self.remotepath(target)
source = self.remotepath(source)
'creates a symlink `target -> source` (e.g. ln -sf source target)'
self.logger.info('sftp symlink {} {}'.format(source, target))
self.sftp.symlink(source, target)
self.attributes.remove(target)
self.directories.remove(os.path.dirname(target))
return 0
def _truncate(self, thread_local_data, path, length):
self.logger.info('sftp truncate {}'.format(path))
sftp = self.current_thread_sftp(thread_local_data)
return sftp.truncate(path, length)
def truncate(self, path, length, fh=None):
realpath = self.remotepath(path)
cachefile = self.cachefile(realpath)
if not os.path.exists(cachefile):
if self.empty_file(realpath):
self.create(path, 'wb')
else:
task = Task(
xxhash.xxh64(realpath).intdigest(), self.getfile, realpath)
self.taskpool.submit(task)
self.taskpool.wait(xxhash.xxh64(realpath).intdigest())
status = os.truncate(cachefile, length)
self.logger.info(self.extract(os.lstat(cachefile)))
self.attributes.insert(realpath, self.extract(os.lstat(cachefile)))
task = Task(
xxhash.xxh64(realpath).intdigest(), self._truncate, realpath,
length)
self.taskpool.submit(task)
return status
def unlink(self, path):
path = self.remotepath(path)
self.logger.info('unlink {}'.format(path))
cachefile = self.cachefile(path)
if os.path.exists(cachefile):
os.unlink(cachefile)
self.sftp.unlink(path)
self.attributes.remove(path)
self.directories.remove(os.path.dirname(path))
return 0
def utimens(self, path, times=None):
path = self.remotepath(path)
self.logger.info('utimens {}'.format(path))
status = self.sftp.utime(path, times)
self.attributes.remove(path)
return status
def _write(self, thread_local_data, path, data, offset):
sftp = self.current_thread_sftp(thread_local_data)
with sftp.open(path, 'rb+') as outfile:
outfile.seek(offset, 0)
outfile.write(data)
return len(data)
def empty_file(self, path):
attr = self.attributes.fetch(path)
return 0 == attr['st_size']
def write(self, path, data, offset, fh):
realpath = self.remotepath(path)
cachefile = self.cachefile(realpath)
if not os.path.exists(cachefile):
if self.empty_file(realpath):
self.create(path, 'wb')
else:
task = Task(
xxhash.xxh64(realpath).intdigest(), self.getfile, realpath)
self.taskpool.submit(task)
self.taskpool.wait(xxhash.xxh64(realpath).intdigest())
with open(cachefile, 'rb+') as outfile:
outfile.seek(offset, 0)
outfile.write(data)
self.attributes.insert(realpath, self.extract(os.lstat(cachefile)))
task = Task(
xxhash.xxh64(realpath).intdigest(), self._write, realpath, data,
offset)
self.taskpool.submit(task)
return len(data)
def destroy(self, path):
self.taskpool.shutdown()
self.sftp.close()
self.client.close()
def fuse_main(self, mount_point):
self.__class__.__name__ = 'oxfs'
if 'Darwin' == self.sys:
fuse = FUSE(self,
mount_point,
foreground=True,
nothreads=True,
allow_other=True,
auto_cache=True,
uid=os.getuid(),
gid=os.getgid(),
defer_permissions=True,
kill_on_unmount=True,
noappledouble=True,
noapplexattr=True,
nosuid=True,
nobrowse=True,
volname=self.host)
elif 'Linux' == self.sys:
fuse = FUSE(self,
mount_point,
foreground=True,
nothreads=True,
allow_other=True,
auto_cache=True,
uid=os.getuid(),
gid=os.getgid(),
auto_unmount=True)
else:
self.logger.error('not supported system, {}'.format(self.sys))
sys.exit()