1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
|
#!/usr/bin/env python3
import argparse
import logging
import os
import glob
import shutil
import sys
import stat
import tempfile
import fnmatch
from textext.requirements_check import \
set_logging_levels, \
TexTextRequirementsChecker, \
defaults, \
LoggingColors, \
SUCCESS
from textext.utility import Settings
# Hotfix for Inkscape 1.0.1 on Windows: HarfBuzz-0.0.typelib is missing
# in the Inkscape installation Python subsystem, hence we ship
# it manually and set the search path accordingly here
# ToDo: Remove this hotfix when Inkscape 1.0.2 is released and mark
# Inkscape 1.0.1 as incompatible with TexText
if os.name == "nt":
os.environ['GI_TYPELIB_PATH'] = os.path.abspath(os.path.join(os.path.dirname(__file__), "textext"))
# taken from https://stackoverflow.com/a/3041990/1741477
def query_yes_no(question, default="yes"):
"""Ask a yes/no question via raw_input() and return their answer.
"question" is a string that is presented to the user.
"default" is the presumed answer if the user just hits <Enter>.
It must be "yes" (the default), "no" or None (meaning
an answer is required of the user).
The "answer" return value is True for "yes" or False for "no".
"""
valid = {"yes": True, "y": True, "ye": True,
"no": False, "n": False}
if default is None:
prompt = " [y/n] "
elif default == "yes":
prompt = " [Y/n] "
elif default == "no":
prompt = " [y/N] "
else:
raise ValueError("invalid default answer: '%s'" % default)
if sys.version_info[0] > 2:
read_input = input
else:
read_input = raw_input
while True:
sys.stdout.write(question + prompt)
choice = read_input().lower()
if default is not None and choice == '':
return valid[default]
elif choice in valid:
return valid[choice]
else:
sys.stdout.write("Please respond with 'yes' or 'no' "
"(or 'y' or 'n').\n")
class TemporaryDirectory(object):
""" Mimic tempfile.TemporaryDirectory from python3 """
def __init__(self):
self.dir_name = None
def __enter__(self):
self.dir_name = tempfile.mkdtemp("textext_")
return self.dir_name
def __exit__(self, exc_type, exc_val, exc_tb):
def retry_with_chmod(func, path, exec_info):
os.chmod(path, stat.S_IWRITE)
func(path)
if self.dir_name:
shutil.rmtree(self.dir_name,
class StashFiles(object):
def __init__(self, stash_from, rel_filenames, tmp_dir, unstash_to=None):
self.stash_from = stash_from
self.unstash_to = stash_from if unstash_to is None else unstash_to
self.rel_filenames = rel_filenames
self.tmp_dir = tmp_dir
def __enter__(self):
for old_name, new_name in self.rel_filenames.items():
src = os.path.join(self.stash_from, old_name)
dst = os.path.join(self.tmp_dir, old_name)
if os.path.isfile(src):
if not os.path.isdir(os.path.dirname(dst)):
logger.info("Creating directory `%s`" % os.path.dirname(dst) )
os.makedirs(os.path.dirname(dst))
logger.info("Stashing `%s`" % dst)
shutil.copy2(src, dst)
def __exit__(self, exc_type, exc_val, exc_tb):
for old_name, new_name in self.rel_filenames.items():
src = os.path.join(self.tmp_dir, old_name)
dst = os.path.join(self.unstash_to, new_name)
if os.path.isfile(src):
if not os.path.isdir(os.path.dirname(dst)):
logger.info("Creating directory `%s`" % os.path.dirname(dst) )
os.makedirs(os.path.dirname(dst))
logger.info("Restoring old `%s` -> `%s`" % (old_name, dst))
shutil.copy2(src, dst)
class CopyFileOverDirectoryError(RuntimeError):
pass
class CopyFileAlreadyExistsError(RuntimeError):
pass
_ignore_patterns = [
'__pycache__',
'*.pyc',
'*.log',
]
def is_ignored(filename):
for pattern in _ignore_patterns:
if fnmatch.fnmatch(filename, pattern):
return True
return False
def copy_extension_files(src, dst, if_already_exists="raise"):
"""
src: glob expresion to copy from
dst: destination directory
if_already_exists: action on existing files. One of "raise" (default), "skip", "overwrite"
"""
if os.path.exists(dst):
if not os.path.isdir(dst):
logger.critical("Can't copy files to `%s`: it's not a directory")
raise CopyFileOverDirectoryError("Can't copy files to `%s`: it's not a directory")
else:
logger.info("Creating directory `%s`" % dst)
os.makedirs(dst)
for file in glob.glob(src):
basename = os.path.basename(file)
destination = os.path.join(dst, basename)
if is_ignored(basename):
continue
if os.path.exists(destination):
if if_already_exists == "raise":
logger.critical("Can't copy `%s`: `%s` already exists" % (file, destination))
raise CopyFileAlreadyExistsError("Can't copy `%s`: `%s` already exists" % (file, destination))
elif if_already_exists == "skip":
logger.info("Skipping `%s`" % file)
continue
elif if_already_exists == "overwrite":
logger.info("Overwriting `%s`" % destination)
pass
if os.path.isfile(file):
logger.info("Copying `%s` to `%s`" % (file, destination))
shutil.copy(file, destination)
else:
logger.info("Creating directory `%s`" % destination)
if os.path.exists(destination):
if not os.path.isdir(destination):
os.remove(destination)
os.mkdir(destination)
else:
os.mkdir(destination)
copy_extension_files(os.path.join(file, "*"),
destination,
if_already_exists=if_already_exists)
def remove_previous_installation(extension_dir):
previous_installation_files_and_folders = [
"asktext.py",
"default_packages.tex",
"latexlogparser.py",
"textext",
"textext.inx",
"textext.py",
"typesetter.py",
"win_app_paths.py",
]
for file_or_dir in previous_installation_files_and_folders:
file_or_dir = os.path.abspath(os.path.join(extension_dir, file_or_dir))
if os.path.isfile(file_or_dir):
logger.info("Removing `%s`" % file_or_dir)
os.remove(file_or_dir)
elif os.path.isdir(file_or_dir):
logger.info("Removing `%s`" % file_or_dir)
shutil.rmtree(file_or_dir)
else:
logger.debug("`%s` is not found" % file_or_dir)
if __name__ == "__main__":
EXIT_SUCCESS = 0
EXIT_REQUIREMENT_CHECK_UNKNOWN = 64
EXIT_REQUIREMENT_CHECK_FAILED = 65
EXIT_BAD_COMMAND_LINE_ARGUMENT_VALUE = 2
parser = argparse.ArgumentParser(description='Install TexText')
parser.add_argument(
"--inkscape-extensions-path",
default=defaults.inkscape_extensions_path,
type=str,
help="Path to inkscape extensions directory"
)
parser.add_argument(
"--inkscape-executable",
default=None,
type=str,
help="Full path to inkscape executable"
)
parser.add_argument(
"--pdflatex-executable",
default=None,
type=str,
help="Full path to pdflatex executable"
)
parser.add_argument(
"--lualatex-executable",
default=None,
type=str,
help="Full path to lualatex executable"
)
parser.add_argument(
"--xelatex-executable",
default=None,
type=str,
help="Full path to xelatex executable"
)
parser.add_argument(
"--skip-requirements-check",
default=False,
action='store_true',
help="Bypass minimal requirements check"
)
parser.add_argument(
"--skip-extension-install",
default=False,
action='store_true',
help="Don't install extension"
)
parser.add_argument(
"--keep-previous-installation-files",
default=None,
action='store_true',
help="Keep/discard files from previous installation, suppress prompt"
)
parser.add_argument(
"--color",
default=defaults.console_colors,
choices=("always", "never"),
help="Enables/disable console colors"
)
files_to_keep = { # old_name : new_name
"default_packages.tex": "textext/default_packages.tex", # old layout
"textext/default_packages.tex": "textext/default_packages.tex", # new layout
"textext/config.json": "textext/config.json" # new layout
}
args = parser.parse_args()
args.inkscape_extensions_path = os.path.expanduser(args.inkscape_extensions_path)
if args.color == "always":
LoggingColors.enable_colors = True
elif args.color == "never":
LoggingColors.enable_colors = False
set_logging_levels()
logger = logging.getLogger('TexText')
logger.setLevel(logging.DEBUG)
ch = logging.StreamHandler()
ch.setLevel(logging.INFO)
formatter = logging.Formatter('[%(name)s][%(levelname)6s]: %(message)s')
ch.setFormatter(formatter)
logger.addHandler(ch)
# Explicit path spec since on Windows working directory must be the python.exe directory
# which is usually read-only for standard users
fh = logging.FileHandler(os.path.join(os.path.dirname(__file__), "textextsetup.log"))
fh.setLevel(ch.level)
fh.setFormatter(formatter)
logger.addHandler(fh)
settings = Settings(inkscape_extensions_path=args.inkscape_extensions_path)
checker = TexTextRequirementsChecker(logger, settings)
for executable_name in [
"inkscape",
"lualatex",
"pdflatex",
"xelatex",
]:
executable_path = getattr(args, "%s_executable" % executable_name)
if executable_path is not None:
if not checker.check_executable(executable_path):
logger.error("Bad `%s` executable provided: `%s`. Abort installation." % (executable_name, executable_path))
exit(EXIT_BAD_COMMAND_LINE_ARGUMENT_VALUE)
settings["%s-executable" % executable_name] = executable_path
if not args.skip_requirements_check:
check_result = checker.check()
if check_result == None:
logger.error("Automatic requirements check is incomplete")
logger.error("Please check requirements list manually and run:")
logger.error(" ".join(sys.argv + ["--skip-requirements-check"]))
exit(EXIT_REQUIREMENT_CHECK_UNKNOWN)
if check_result == False:
logger.error("Automatic requirements check found issue")
logger.error("Follow instruction above and run install script again")
logger.error("To bypass requirement check pass `--skip-requirements-check` to setup.py")
exit(EXIT_REQUIREMENT_CHECK_FAILED)
if not args.skip_extension_install:
if args.keep_previous_installation_files is None:
found_files_to_keep = {}
for old_filename, new_filename in files_to_keep.items():
if not os.path.isfile(os.path.join(args.inkscape_extensions_path, old_filename)):
logger.debug("%s not found" % old_filename)
else:
logger.debug("%s found" % old_filename)
if not os.path.isfile(os.path.join("extension", new_filename)):
logger.info("`%s` is not found in distribution, keep old file" % new_filename)
found_files_to_keep[old_filename] = new_filename
continue
with open(os.path.join(args.inkscape_extensions_path, old_filename)) as f_old, \
open(new_filename) as f_new:
if f_old.read() != f_new.read():
logger.debug("Content of `%s` are not identical version in distribution" % old_filename)
found_files_to_keep[old_filename] = new_filename
else:
logger.debug("Content of `%s` is identical to distribution" % old_filename)
files_to_keep = {}
if len(found_files_to_keep) > 0:
file_s = "file" if len(found_files_to_keep) == 1 else "files"
for old_filename, new_filename in found_files_to_keep.items():
if os.path.isfile(os.path.join("extension", new_filename)):
logger.warn("Existing `%s` differs from newer version in distribution" % old_filename)
if query_yes_no("Keep `%s` from previous installation?" % old_filename):
files_to_keep[old_filename] = new_filename
args.keep_previous_installation_files = True
else:
args.keep_previous_installation_files = False
if not args.keep_previous_installation_files:
files_to_keep = {}
with TemporaryDirectory() as tmp_dir, \
StashFiles(stash_from=args.inkscape_extensions_path,
rel_filenames=files_to_keep,
tmp_dir=tmp_dir
):
remove_previous_installation(args.inkscape_extensions_path)
copy_extension_files(
src=os.path.join(os.path.dirname(os.path.abspath(__file__)), "textext"),
dst=args.inkscape_extensions_path,
if_already_exists="overwrite"
)
settings.save()
logger.log(SUCCESS, "--> TexText has been SUCCESSFULLY installed on your system <--")
exit(EXIT_SUCCESS)
|