mirror of
https://github.com/deadc0de6/dotdrop.git
synced 2026-02-05 20:48:00 +00:00
253 lines
9.0 KiB
Python
253 lines
9.0 KiB
Python
"""
|
|
author: deadc0de6 (https://github.com/deadc0de6)
|
|
Copyright (c) 2017, deadc0de6
|
|
|
|
handle the installation of dotfiles
|
|
"""
|
|
|
|
import os
|
|
|
|
# local imports
|
|
from dotdrop.logger import Logger
|
|
from dotdrop.comparator import Comparator
|
|
from dotdrop.templategen import Templategen
|
|
import dotdrop.utils as utils
|
|
|
|
|
|
class Installer:
|
|
|
|
BACKUP_SUFFIX = '.dotdropbak'
|
|
|
|
def __init__(self, base='.', create=True, backup=True,
|
|
dry=False, safe=False, workdir='~/.config/dotdrop',
|
|
debug=False, diff=True, totemp=None):
|
|
self.create = create
|
|
self.backup = backup
|
|
self.dry = dry
|
|
self.safe = safe
|
|
self.workdir = os.path.expanduser(workdir)
|
|
self.base = base
|
|
self.debug = debug
|
|
self.diff = diff
|
|
self.totemp = totemp
|
|
self.comparing = False
|
|
self.log = Logger()
|
|
|
|
def install(self, templater, src, dst):
|
|
"""install the src to dst using a template"""
|
|
src = os.path.join(self.base, os.path.expanduser(src))
|
|
if not os.path.exists(src):
|
|
self.log.err('source dotfile does not exist: {}'.format(src))
|
|
dst = os.path.expanduser(dst)
|
|
if self.totemp:
|
|
dst = self._pivot_path(dst, self.totemp)
|
|
if utils.samefile(src, dst):
|
|
# symlink loop
|
|
self.log.err('dotfile points to itself: {}'.format(dst))
|
|
return []
|
|
if self.debug:
|
|
self.log.dbg('install {} to {}'.format(src, dst))
|
|
if os.path.isdir(src):
|
|
return self._handle_dir(templater, src, dst)
|
|
return self._handle_file(templater, src, dst)
|
|
|
|
def link(self, templater, src, dst):
|
|
"""set src as the link target of dst"""
|
|
src = os.path.join(self.base, os.path.expanduser(src))
|
|
if not os.path.exists(src):
|
|
self.log.err('source dotfile does not exist: {}'.format(src))
|
|
dst = os.path.expanduser(dst)
|
|
if self.totemp:
|
|
return self.install(templater, src, dst)
|
|
|
|
if Templategen.is_template(src):
|
|
if self.debug:
|
|
self.log.dbg('dotfile is a template')
|
|
self.log.dbg('install to {} and symlink'.format(self.workdir))
|
|
tmp = self._pivot_path(dst, self.workdir, striphome=True)
|
|
i = self.install(templater, src, tmp)
|
|
if not i and not os.path.exists(tmp):
|
|
return []
|
|
src = tmp
|
|
return self._link(src, dst)
|
|
|
|
def _link(self, src, dst):
|
|
"""set src as a link target of dst"""
|
|
if os.path.lexists(dst):
|
|
if os.path.realpath(dst) == os.path.realpath(src):
|
|
if self.debug:
|
|
self.log.dbg('ignoring "{}", link exists'.format(dst))
|
|
return []
|
|
if self.dry:
|
|
self.log.dry('would remove {} and link to {}'.format(dst, src))
|
|
return []
|
|
msg = 'Remove "{}" for link creation?'.format(dst)
|
|
if self.safe and not self.log.ask(msg):
|
|
msg = 'ignoring "{}", link was not created'
|
|
self.log.warn(msg.format(dst))
|
|
return []
|
|
try:
|
|
utils.remove(dst)
|
|
except OSError:
|
|
self.log.err('something went wrong with {}'.format(src))
|
|
return []
|
|
if self.dry:
|
|
self.log.dry('would link {} to {}'.format(dst, src))
|
|
return []
|
|
base = os.path.dirname(dst)
|
|
if not self._create_dirs(base):
|
|
self.log.err('creating directory for \"{}\"'.format(dst))
|
|
return []
|
|
os.symlink(src, dst)
|
|
self.log.sub('linked \"{}\" to \"{}\"'.format(dst, src))
|
|
return [(src, dst)]
|
|
|
|
def _handle_file(self, templater, src, dst):
|
|
"""install src to dst when is a file"""
|
|
if self.debug:
|
|
self.log.dbg('generate template for {}'.format(src))
|
|
if utils.samefile(src, dst):
|
|
# symlink loop
|
|
self.log.err('dotfile points to itself: {}'.format(dst))
|
|
return []
|
|
content = templater.generate(src)
|
|
if content is None:
|
|
self.log.err('generate from template \"{}\"'.format(src))
|
|
return []
|
|
if not os.path.exists(src):
|
|
self.log.err('source dotfile does not exist: \"{}\"'.format(src))
|
|
return []
|
|
st = os.stat(src)
|
|
ret = self._write(dst, content, st.st_mode)
|
|
if ret < 0:
|
|
self.log.err('installing \"{}\" to \"{}\"'.format(src, dst))
|
|
return []
|
|
if ret > 0:
|
|
if self.debug:
|
|
self.log.dbg('ignoring \"{}\", same content'.format(dst))
|
|
return []
|
|
if ret == 0:
|
|
if not self.dry and not self.comparing:
|
|
self.log.sub('copied \"{}\" to \"{}\"'.format(src, dst))
|
|
return [(src, dst)]
|
|
return []
|
|
|
|
def _handle_dir(self, templater, src, dst):
|
|
"""install src to dst when is a directory"""
|
|
ret = []
|
|
self._create_dirs(dst)
|
|
# handle all files in dir
|
|
for entry in os.listdir(src):
|
|
f = os.path.join(src, entry)
|
|
if not os.path.isdir(f):
|
|
res = self._handle_file(templater, f, os.path.join(dst, entry))
|
|
ret.extend(res)
|
|
else:
|
|
res = self._handle_dir(templater, f, os.path.join(dst, entry))
|
|
ret.extend(res)
|
|
return ret
|
|
|
|
def _fake_diff(self, dst, content):
|
|
"""fake diff by comparing file content with content"""
|
|
cur = ''
|
|
with open(dst, 'br') as f:
|
|
cur = f.read()
|
|
return cur == content
|
|
|
|
def _write(self, dst, content, rights):
|
|
"""write content to file
|
|
return 0 for success,
|
|
1 when already exists
|
|
-1 when error"""
|
|
if self.dry:
|
|
self.log.dry('would install {}'.format(dst))
|
|
return 0
|
|
if os.path.lexists(dst):
|
|
samerights = os.stat(dst).st_mode == rights
|
|
if self.diff and self._fake_diff(dst, content) and samerights:
|
|
if self.debug:
|
|
self.log.dbg('{} is the same'.format(dst))
|
|
return 1
|
|
if self.safe and not self.log.ask('Overwrite \"{}\"'.format(dst)):
|
|
self.log.warn('ignoring \"{}\", already present'.format(dst))
|
|
return 1
|
|
if self.backup and os.path.lexists(dst):
|
|
self._backup(dst)
|
|
base = os.path.dirname(dst)
|
|
if not self._create_dirs(base):
|
|
self.log.err('creating directory for \"{}\"'.format(dst))
|
|
return -1
|
|
if self.debug:
|
|
self.log.dbg('write content to {}'.format(dst))
|
|
try:
|
|
with open(dst, 'wb') as f:
|
|
f.write(content)
|
|
except NotADirectoryError as e:
|
|
self.log.err('opening dest file: {}'.format(e))
|
|
return -1
|
|
os.chmod(dst, rights)
|
|
return 0
|
|
|
|
def _create_dirs(self, directory):
|
|
"""mkdir -p <directory>"""
|
|
if not self.create and not os.path.exists(directory):
|
|
return False
|
|
if os.path.exists(directory):
|
|
return True
|
|
if self.dry:
|
|
self.log.dry('would mkdir -p {}'.format(directory))
|
|
return True
|
|
if self.debug:
|
|
self.log.dbg('mkdir -p {}'.format(directory))
|
|
os.makedirs(directory)
|
|
return os.path.exists(directory)
|
|
|
|
def _backup(self, path):
|
|
"""backup file pointed by path"""
|
|
if self.dry:
|
|
return
|
|
dst = path.rstrip(os.sep) + self.BACKUP_SUFFIX
|
|
self.log.log('backup {} to {}'.format(path, dst))
|
|
os.rename(path, dst)
|
|
|
|
def _pivot_path(self, path, newdir, striphome=False):
|
|
"""change path to be under newdir"""
|
|
if striphome:
|
|
home = os.path.expanduser('~')
|
|
path = path.lstrip(home)
|
|
sub = path.lstrip(os.sep)
|
|
return os.path.join(newdir, sub)
|
|
|
|
def _install_to_temp(self, templater, src, dst, tmpdir):
|
|
"""install a dotfile to a tempdir"""
|
|
tmpdst = self._pivot_path(dst, tmpdir)
|
|
return self.install(templater, src, tmpdst), tmpdst
|
|
|
|
def install_to_temp(self, templater, tmpdir, src, dst):
|
|
"""install a dotfile to a tempdir"""
|
|
ret = False
|
|
tmpdst = ''
|
|
# save some flags while comparing
|
|
self.comparing = True
|
|
drysaved = self.dry
|
|
self.dry = False
|
|
diffsaved = self.diff
|
|
self.diff = False
|
|
createsaved = self.create
|
|
self.create = True
|
|
# normalize src and dst
|
|
src = os.path.expanduser(src)
|
|
dst = os.path.expanduser(dst)
|
|
if self.debug:
|
|
self.log.dbg('tmp install {} to {}'.format(src, dst))
|
|
# install the dotfile to a temp directory for comparing
|
|
ret, tmpdst = self._install_to_temp(templater, src, dst, tmpdir)
|
|
if self.debug:
|
|
self.log.dbg('tmp installed in {}'.format(tmpdst))
|
|
# reset flags
|
|
self.dry = drysaved
|
|
self.diff = diffsaved
|
|
self.comparing = False
|
|
self.create = createsaved
|
|
return ret, tmpdst
|