├── src └── tts_tools │ ├── __init__.py │ ├── libgui │ ├── __init__.py │ ├── entry.py │ └── frame.py │ ├── backup │ ├── cli.py │ ├── __init__.py │ └── gui.py │ ├── prefetch │ ├── cli.py │ ├── gui.py │ └── __init__.py │ ├── util.py │ └── libtts.py ├── pyproject.toml ├── pytest.ini ├── setup.cfg ├── nix └── tts-backup.nix ├── .pre-commit-config.yaml ├── .github └── workflows │ └── pre-commit.yml ├── flake.nix ├── flake.lock ├── setup.py ├── .gitignore ├── test └── tts_tools │ └── test_libtts.py ├── README.rst └── LICENSE /src/tts_tools/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | line-length = 79 3 | -------------------------------------------------------------------------------- /pytest.ini: -------------------------------------------------------------------------------- 1 | [pytest] 2 | addopts = --black --flake8 --isort 3 | -------------------------------------------------------------------------------- /src/tts_tools/libgui/__init__.py: -------------------------------------------------------------------------------- 1 | # Shared GUI functions & classes. 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [isort] 2 | force_alphabetical_sort = True 3 | force_single_line = True 4 | lines_after_imports = 2 5 | line_length = 79 6 | use_parentheses = True 7 | multi_line_output = 3 8 | -------------------------------------------------------------------------------- /nix/tts-backup.nix: -------------------------------------------------------------------------------- 1 | { python3Packages }: 2 | python3Packages.buildPythonApplication { 3 | pname = "tts-backup"; 4 | version = "0.1.0.3"; 5 | propagatedBuildInputs = (with python3Packages; [ setuptools tkinter ]); 6 | src = ../.; 7 | } 8 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | --- 2 | repos: 3 | - repo: https://github.com/szebenyib/pre-commit-pytest 4 | rev: 051fea3 5 | hooks: 6 | - id: pytest 7 | stages: 8 | - commit 9 | entry: sh -c "pip install .[dev] && pytest" 10 | -------------------------------------------------------------------------------- /.github/workflows/pre-commit.yml: -------------------------------------------------------------------------------- 1 | --- 2 | name: pre-commit 3 | 4 | on: 5 | pull_request: 6 | push: 7 | 8 | jobs: 9 | pre-commit: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v2 13 | - uses: actions/setup-python@v2 14 | with: 15 | python-version: '3.9' 16 | - uses: pre-commit/action@v2.0.0 17 | -------------------------------------------------------------------------------- /flake.nix: -------------------------------------------------------------------------------- 1 | { 2 | description = "tts-backup"; 3 | inputs = { 4 | nixpkgs.url = "nixpkgs/nixos-21.05"; 5 | utils.url = "github:numtide/flake-utils"; 6 | }; 7 | outputs = { self, nixpkgs, utils }: 8 | (utils.lib.eachDefaultSystem (system: 9 | let 10 | pkgs = import nixpkgs { 11 | inherit system; 12 | overlays = [ 13 | (final: prev: { 14 | tts-backup = final.callPackage ./nix/tts-backup.nix { }; 15 | }) 16 | ]; 17 | }; 18 | in rec { 19 | packages = rec { 20 | default = tts-backup; 21 | tts-backup = pkgs.tts-backup; 22 | }; 23 | apps = rec { 24 | tts-backup = { 25 | type = "app"; 26 | program = "${packages.tts-backup}/bin/tts-backup"; 27 | }; 28 | tts-prefetch = { 29 | type = "app"; 30 | program = "${packages.tts-backup}/bin/tts-prefetch"; 31 | }; 32 | default = tts-backup; 33 | }; 34 | })); 35 | } 36 | -------------------------------------------------------------------------------- /flake.lock: -------------------------------------------------------------------------------- 1 | { 2 | "nodes": { 3 | "nixpkgs": { 4 | "locked": { 5 | "lastModified": 1631545603, 6 | "narHash": "sha256-aT2UoEOnlEBpMRZKBLu/OBsDNTZQS48scjcL936VSLI=", 7 | "owner": "NixOS", 8 | "repo": "nixpkgs", 9 | "rev": "b3083bc6933eb7fa4ee7bd4802e9f72b56f3e654", 10 | "type": "github" 11 | }, 12 | "original": { 13 | "id": "nixpkgs", 14 | "ref": "nixos-21.05", 15 | "type": "indirect" 16 | } 17 | }, 18 | "root": { 19 | "inputs": { 20 | "nixpkgs": "nixpkgs", 21 | "utils": "utils" 22 | } 23 | }, 24 | "utils": { 25 | "locked": { 26 | "lastModified": 1631561581, 27 | "narHash": "sha256-3VQMV5zvxaVLvqqUrNz3iJelLw30mIVSfZmAaauM3dA=", 28 | "owner": "numtide", 29 | "repo": "flake-utils", 30 | "rev": "7e5bf3925f6fbdfaf50a2a7ca0be2879c4261d19", 31 | "type": "github" 32 | }, 33 | "original": { 34 | "owner": "numtide", 35 | "repo": "flake-utils", 36 | "type": "github" 37 | } 38 | } 39 | }, 40 | "root": "root", 41 | "version": 7 42 | } 43 | -------------------------------------------------------------------------------- /src/tts_tools/backup/cli.py: -------------------------------------------------------------------------------- 1 | from tts_tools.backup import backup_json 2 | from tts_tools.libtts import GAMEDATA_DEFAULT 3 | 4 | import argparse 5 | 6 | 7 | parser = argparse.ArgumentParser( 8 | description="Back-up locally cached content from a TTS .json file." 9 | ) 10 | 11 | parser.add_argument( 12 | "infile_name", 13 | metavar="FILENAME", 14 | help="The save file or mod in JSON format.", 15 | ) 16 | 17 | parser.add_argument( 18 | "--gamedata", 19 | dest="gamedata_dir", 20 | metavar="PATH", 21 | default=GAMEDATA_DEFAULT, 22 | help="The path to the TTS game data dircetory.", 23 | ) 24 | 25 | parser.add_argument( 26 | "--outname", 27 | "-o", 28 | dest="outfile_name", 29 | metavar="FILENAME", 30 | default=None, 31 | help="The name for the output archive.", 32 | ) 33 | 34 | parser.add_argument( 35 | "--dry-run", 36 | "-n", 37 | dest="dry_run", 38 | default=False, 39 | action="store_true", 40 | help="Only print which files would be backed up.", 41 | ) 42 | 43 | parser.add_argument( 44 | "--ignore-missing", 45 | "-i", 46 | dest="ignore_missing", 47 | default=False, 48 | action="store_true", 49 | help="Do not abort the backup when files are missing.", 50 | ) 51 | 52 | parser.add_argument( 53 | "--comment", 54 | "-c", 55 | dest="comment", 56 | default="", 57 | help="A comment to be stored in the resulting Zip.", 58 | ) 59 | 60 | 61 | def console_entry(): 62 | 63 | args = parser.parse_args() 64 | backup_json(args) 65 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | from setuptools import setup 4 | 5 | import shlex 6 | import subprocess 7 | 8 | 9 | version = "0.1.0.3" 10 | 11 | try: 12 | hash = ( 13 | subprocess.check_output(shlex.split("git rev-parse --short HEAD")) 14 | .rstrip() 15 | .decode("ASCII") 16 | ) 17 | commit = ( 18 | subprocess.check_output(shlex.split("git rev-list --count HEAD")) 19 | .rstrip() 20 | .decode("ASCII") 21 | ) 22 | except Exception: 23 | pass 24 | else: 25 | version = "{}.dev{}+{}".format(version, commit, hash) 26 | 27 | 28 | setup( 29 | name="tts-backup", 30 | version=version, 31 | description=( 32 | "Backup Tabletop Simulator saves and assets into comprehensive " 33 | "Zip files." 34 | ), 35 | author="Sebastian Reuße", 36 | author_email="seb@wirrsal.net", 37 | url="https://github.com/eigengrau/tts-backup", 38 | packages=[ 39 | "tts_tools", 40 | "tts_tools.backup", 41 | "tts_tools.prefetch", 42 | "tts_tools.libgui", 43 | ], 44 | extras_require={ 45 | "dev": [ 46 | "pytest==6.2.2", 47 | "pytest-black==0.3.12", 48 | "pytest-flake8==1.0.7", 49 | "pytest-isort==1.3.0", 50 | "isort==5.7.0", 51 | ] 52 | }, 53 | package_dir={"": "src"}, 54 | license="GPL3", 55 | entry_points={ 56 | "console_scripts": [ 57 | "tts-backup = tts_tools.backup.cli:console_entry", 58 | "tts-prefetch = tts_tools.prefetch.cli:console_entry", 59 | ], 60 | "gui_scripts": [ 61 | "tts-backup-gui = tts_tools.backup.gui:gui_entry", 62 | "tts-prefetch-gui = tts_tools.prefetch.gui:gui_entry", 63 | ], 64 | }, 65 | ) 66 | -------------------------------------------------------------------------------- /src/tts_tools/prefetch/cli.py: -------------------------------------------------------------------------------- 1 | from tts_tools.libtts import GAMEDATA_DEFAULT 2 | from tts_tools.prefetch import prefetch_files 3 | 4 | import argparse 5 | import signal 6 | import sys 7 | 8 | 9 | parser = argparse.ArgumentParser( 10 | description="Download assets referenced in TTS .json files." 11 | ) 12 | 13 | parser.add_argument( 14 | "infile_names", 15 | metavar="FILENAME", 16 | nargs="+", 17 | help="The save file or mod in JSON format.", 18 | ) 19 | 20 | parser.add_argument( 21 | "--gamedata", 22 | dest="gamedata_dir", 23 | metavar="PATH", 24 | default=GAMEDATA_DEFAULT, 25 | help="The path to the TTS game data directory.", 26 | ) 27 | 28 | parser.add_argument( 29 | "--dry-run", 30 | "-n", 31 | dest="dry_run", 32 | default=False, 33 | action="store_true", 34 | help="Only print which files would be downloaded.", 35 | ) 36 | 37 | parser.add_argument( 38 | "--refetch", 39 | "-r", 40 | dest="refetch", 41 | default=False, 42 | action="store_true", 43 | help="Rewrite objects that already exist in the cache.", 44 | ) 45 | 46 | parser.add_argument( 47 | "--relax", 48 | "-x", 49 | dest="ignore_content_type", 50 | default=False, 51 | action="store_true", 52 | help="Do not abort when encountering an unexpected MIME type.", 53 | ) 54 | 55 | parser.add_argument( 56 | "--timeout", 57 | "-t", 58 | dest="timeout", 59 | default=5, 60 | type=int, 61 | help="Connection timeout in s.", 62 | ) 63 | parser.add_argument( 64 | "--user-agent", 65 | "-a", 66 | dest="user_agent", 67 | default="tts-backup", 68 | help="HTTP user-agent string.", 69 | ) 70 | 71 | 72 | def sigint_handler(signum, frame): 73 | sys.exit(1) 74 | 75 | 76 | def console_entry(): 77 | 78 | signal.signal(signal.SIGINT, sigint_handler) 79 | signal.signal(signal.SIGTERM, sigint_handler) 80 | args = parser.parse_args() 81 | prefetch_files(args) 82 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### https://raw.github.com/github/gitignore/21e9f06539cdbc1ccbbb2ce59cd667be3e172fc8/Python.gitignore 2 | 3 | # Byte-compiled / optimized / DLL files 4 | __pycache__/ 5 | *.py[cod] 6 | *$py.class 7 | 8 | # C extensions 9 | *.so 10 | 11 | # Distribution / packaging 12 | .Python 13 | build/ 14 | develop-eggs/ 15 | dist/ 16 | downloads/ 17 | eggs/ 18 | .eggs/ 19 | lib/ 20 | lib64/ 21 | parts/ 22 | sdist/ 23 | var/ 24 | wheels/ 25 | pip-wheel-metadata/ 26 | share/python-wheels/ 27 | *.egg-info/ 28 | .installed.cfg 29 | *.egg 30 | MANIFEST 31 | 32 | # PyInstaller 33 | # Usually these files are written by a python script from a template 34 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 35 | *.manifest 36 | *.spec 37 | 38 | # Installer logs 39 | pip-log.txt 40 | pip-delete-this-directory.txt 41 | 42 | # Unit test / coverage reports 43 | htmlcov/ 44 | .tox/ 45 | .nox/ 46 | .coverage 47 | .coverage.* 48 | .cache 49 | nosetests.xml 50 | coverage.xml 51 | *.cover 52 | *.py,cover 53 | .hypothesis/ 54 | .pytest_cache/ 55 | 56 | # Translations 57 | *.mo 58 | *.pot 59 | 60 | # Django stuff: 61 | *.log 62 | local_settings.py 63 | db.sqlite3 64 | db.sqlite3-journal 65 | 66 | # Flask stuff: 67 | instance/ 68 | .webassets-cache 69 | 70 | # Scrapy stuff: 71 | .scrapy 72 | 73 | # Sphinx documentation 74 | docs/_build/ 75 | 76 | # PyBuilder 77 | target/ 78 | 79 | # Jupyter Notebook 80 | .ipynb_checkpoints 81 | 82 | # IPython 83 | profile_default/ 84 | ipython_config.py 85 | 86 | # pyenv 87 | .python-version 88 | 89 | # pipenv 90 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 91 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 92 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 93 | # install all needed dependencies. 94 | #Pipfile.lock 95 | 96 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 97 | __pypackages__/ 98 | 99 | # Celery stuff 100 | celerybeat-schedule 101 | celerybeat.pid 102 | 103 | # SageMath parsed files 104 | *.sage.py 105 | 106 | # Environments 107 | .env 108 | .venv 109 | env/ 110 | venv/ 111 | ENV/ 112 | env.bak/ 113 | venv.bak/ 114 | 115 | # Spyder project settings 116 | .spyderproject 117 | .spyproject 118 | 119 | # Rope project settings 120 | .ropeproject 121 | 122 | # mkdocs documentation 123 | /site 124 | 125 | # mypy 126 | .mypy_cache/ 127 | .dmypy.json 128 | dmypy.json 129 | 130 | # Pyre type checker 131 | .pyre/ 132 | 133 | # Nix 134 | /result 135 | -------------------------------------------------------------------------------- /test/tts_tools/test_libtts.py: -------------------------------------------------------------------------------- 1 | import pytest 2 | 3 | 4 | # seekURL ignores page URLs from a fixture. 5 | @pytest.mark.skip 6 | def test_seekURL_ignore_page_url(): 7 | pass 8 | 9 | 10 | # seekURL ignores tablet URLs from a fixture. 11 | @pytest.mark.skip 12 | def test_seekURL_ignore_tablet_url(): 13 | pass 14 | 15 | 16 | # seekURL returns audio library items from a fixture. 17 | @pytest.mark.skip 18 | def test_seekURL_extract_audio_library_item(): 19 | pass 20 | 21 | 22 | # seekURL ignores URL keys with no value from the fixture. 23 | @pytest.mark.skip 24 | def test_seekURL_ignore_empty_URL(): 25 | pass 26 | 27 | 28 | # seekURL strips in-band metadata (curly braces) from URLs. 29 | @pytest.mark.skip 30 | def test_seekURL_strip_url_inband_metadata(): 31 | pass 32 | 33 | 34 | # seekURL returns expected URLs for the fixture. 35 | @pytest.mark.skip 36 | def test_seekURL_return_common_url(): 37 | pass 38 | 39 | 40 | # is_obj selects expected mesh URLs from the fixture. 41 | @pytest.mark.skip 42 | def test_is_obj_mesh(): 43 | pass 44 | 45 | 46 | # is_obj selects expected collider URLs from the fixture. 47 | @pytest.mark.skip 48 | def test_is_obj_collider(): 49 | pass 50 | 51 | 52 | # is_obj filters anything else from the fixture. 53 | @pytest.mark.skip 54 | def test_is_obj_other(): 55 | pass 56 | 57 | 58 | # is_image selects expected image keys from the fixture. 59 | @pytest.mark.skip 60 | def test_is_image_known_image_keys(): 61 | pass 62 | 63 | 64 | # is_image filters anything else from the fixture. 65 | @pytest.mark.skip 66 | def test_is_image_non_image_keys(): 67 | pass 68 | 69 | 70 | # is_assetbundle selects asset-bundle keys from the fixture. 71 | @pytest.mark.skip 72 | def test_is_assetbundle_known_asset_bundle_keys(): 73 | pass 74 | 75 | 76 | # is_assetbundle filters anything else from the fixture. 77 | @pytest.mark.skip 78 | def test_is_assetbundle_non_assetbundle_keys(): 79 | pass 80 | 81 | 82 | # is_audiolibrary selects audio-library keys from the fixture. 83 | @pytest.mark.skip 84 | def test_is_audiolibrary_known_audiolibrary_keys(): 85 | pass 86 | 87 | 88 | # is_audiolibrary filters anything else from the fixture. 89 | @pytest.mark.skip 90 | def test_is_audiolibrary_non_audiolibrary_keys(): 91 | pass 92 | 93 | 94 | # is_pdf selects PDF keys from the fixture. 95 | @pytest.mark.skip 96 | def test_is_pdf_known_pdf_keys(): 97 | pass 98 | 99 | 100 | # is_pdf filters anything else from the fixture. 101 | @pytest.mark.skip 102 | def test_is_pdf_non_pdf_keys(): 103 | pass 104 | 105 | 106 | # recodeURL rewrites URLs as expected 107 | @pytest.mark.skip 108 | def test_recodeURL(): 109 | pass 110 | 111 | 112 | # get_fs_path returns cache paths as expected 113 | @pytest.mark.skip 114 | def test_get_fs_path(): 115 | pass 116 | 117 | 118 | # urls_from_save returns expected URLs from a save file fixture 119 | @pytest.mark.skip 120 | def test_urls_from_save(): 121 | pass 122 | 123 | 124 | # get_save_name extracts the save file name from a save file fixture 125 | @pytest.mark.skip 126 | def test_get_save_name(): 127 | pass 128 | -------------------------------------------------------------------------------- /src/tts_tools/backup/__init__.py: -------------------------------------------------------------------------------- 1 | from tts_tools.libtts import get_fs_path 2 | from tts_tools.libtts import IllegalSavegameException 3 | from tts_tools.libtts import urls_from_save 4 | from tts_tools.util import print_err 5 | from tts_tools.util import ZipFile 6 | 7 | import os 8 | import re 9 | import sys 10 | 11 | 12 | def backup_json(args): 13 | 14 | try: 15 | urls = urls_from_save(args.infile_name) 16 | except (FileNotFoundError, IllegalSavegameException) as error: 17 | errmsg = "Could not read URLs from '{file}': {error}".format( 18 | file=args.infile_name, error=error 19 | ) 20 | print_err(errmsg) 21 | sys.exit(1) 22 | 23 | # Change working dir, since get_fs_path gives us a relative path. 24 | orig_path = os.getcwd() 25 | try: 26 | os.chdir(args.gamedata_dir) 27 | except FileNotFoundError as error: 28 | errmsg = "Could not open gamedata directory '{dir}': {error}".format( 29 | dir=args.gamedata_dir, error=error 30 | ) 31 | print_err(errmsg) 32 | sys.exit(1) 33 | 34 | # We also need to correct the the destination path now. 35 | if args.outfile_name: 36 | args.outfile_name = os.path.join(orig_path, args.outfile_name) 37 | else: 38 | outfile_basename = re.sub( 39 | r"\.json$", "", os.path.basename(args.infile_name) 40 | ) 41 | args.outfile_name = os.path.join(orig_path, outfile_basename) + ".zip" 42 | 43 | try: 44 | zipfile = ZipFile( 45 | args.outfile_name, 46 | "w", 47 | dry_run=args.dry_run, 48 | ignore_missing=args.ignore_missing, 49 | ) 50 | except FileNotFoundError as error: 51 | errmsg = "Could not write to Zip archive '{outfile}': {error}".format( 52 | outfile=args.outfile_name, error=error 53 | ) 54 | print_err(errmsg) 55 | sys.exit(1) 56 | 57 | with zipfile as outfile: 58 | 59 | for path, url in urls: 60 | 61 | filename = get_fs_path(path, url) 62 | try: 63 | outfile.write(filename) 64 | 65 | except FileNotFoundError as error: 66 | errmsg = "Could not write {filename} to Zip ({error}).".format( 67 | filename=filename, error=error 68 | ) 69 | print_err(errmsg, "Aborting.", sep="\n", end=" ") 70 | if not args.dry_run: 71 | print_err("Zip file is incomplete.") 72 | else: 73 | print_err() 74 | sys.exit(1) 75 | 76 | # Finally, include the save file itself. 77 | orig_json = os.path.join(orig_path, args.infile_name) 78 | outfile.write(orig_json, os.path.basename(args.infile_name)) 79 | 80 | # Store some metadata. 81 | outfile.put_metadata(comment=args.comment) 82 | 83 | if args.dry_run: 84 | print("Dry run for {file} completed.".format(file=args.infile_name)) 85 | else: 86 | print( 87 | "Backed-up contents for {file} found in {outfile}.".format( 88 | file=args.infile_name, outfile=args.outfile_name 89 | ) 90 | ) 91 | -------------------------------------------------------------------------------- /src/tts_tools/libgui/entry.py: -------------------------------------------------------------------------------- 1 | from tkinter import BooleanVar 2 | from tkinter import Button 3 | from tkinter import Checkbutton 4 | from tkinter import Entry 5 | from tkinter import filedialog 6 | from tkinter import font 7 | from tkinter import Frame 8 | from tkinter import Label 9 | from tkinter import LEFT 10 | from tkinter import RIGHT 11 | from tkinter import StringVar 12 | from tkinter import W 13 | from tkinter import X 14 | 15 | 16 | class TextEntry(Frame): 17 | def __init__(self, master, *args, label, default="", **kwargs): 18 | 19 | super().__init__(master, *args, **kwargs) 20 | 21 | _, self.row = master.grid_size() 22 | 23 | label = label + ":" 24 | self.label = Label(self, text=label) 25 | self.label.pack(anchor=W) 26 | 27 | self.var = StringVar() 28 | self.var.set(default) 29 | self.entry = Entry(self, textvariable=self.var) 30 | self.entry.pack(side=LEFT, fill=X) 31 | 32 | 33 | class ToggleEntry(Frame): 34 | def __init__(self, master, *args, label, **kwargs): 35 | 36 | super().__init__(master, *args, **kwargs) 37 | 38 | _, self.row = master.grid_size() 39 | 40 | self.var = BooleanVar() 41 | self.checkbutton = Checkbutton(self, variable=self.var) 42 | self.checkbutton.pack(side=LEFT) 43 | 44 | self.label = Label(self, text=label) 45 | self.label.pack(anchor=W) 46 | self.label.bind("", self.toggle) 47 | 48 | def toggle(self, *args): 49 | 50 | oldval = self.var.get() 51 | self.var.set(not oldval) 52 | 53 | 54 | class FSEntry(TextEntry): 55 | def __init__(self, *args, initialdir=None, mustexist=False, **kwargs): 56 | 57 | super().__init__(*args, **kwargs) 58 | 59 | self.button = Button( 60 | self, text="...", command=self.ask, font=font.Font(size=6) 61 | ) 62 | self.button.pack(side=RIGHT) 63 | 64 | self.initialdir = initialdir 65 | self.mustexist = mustexist 66 | 67 | def ask(self): 68 | 69 | raise NotImplementedError 70 | 71 | 72 | class FileEntry(FSEntry): 73 | def __init__( 74 | self, *args, filetypes=[], defaultextension="", action, **kwargs 75 | ): 76 | 77 | super().__init__(*args, **kwargs) 78 | self.defaultextension = defaultextension 79 | self.filetypes = filetypes 80 | 81 | if action == "save": 82 | self.ask_func = filedialog.asksaveasfilename 83 | elif action == "open": 84 | self.ask_func = filedialog.askopenfilename 85 | else: 86 | raise TypeError("Unknown action type: {}".format(action)) 87 | 88 | def ask(self): 89 | 90 | filename = self.ask_func( 91 | initialdir=self.initialdir, 92 | filetypes=self.filetypes, 93 | defaultextension=self.defaultextension, 94 | ) 95 | self.var.set(filename) 96 | 97 | 98 | class DirEntry(FSEntry): 99 | def __init__(self, *args, **kwargs): 100 | 101 | super().__init__(*args, **kwargs) 102 | 103 | def ask(self): 104 | 105 | dirname = filedialog.askdirectory( 106 | initialdir=self.initialdir, mustexist=self.mustexist 107 | ) 108 | self.var.set(dirname) 109 | -------------------------------------------------------------------------------- /src/tts_tools/util.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | import pkg_resources 4 | import time 5 | import zipfile 6 | 7 | 8 | REVISION = pkg_resources.require("tts-backup")[0].version 9 | 10 | 11 | class ShadowProxy: 12 | """Proxy objects for arbitrary objects, with the ability to divert 13 | attribute access from one attribute to another. 14 | 15 | """ 16 | 17 | def __init__(self, proxy_for): 18 | self.__target = proxy_for 19 | self.__diverted = {} 20 | 21 | def divert_access(self, source, target): 22 | self.__diverted[source] = target 23 | 24 | def __getattr__(self, name): 25 | if name in self.__diverted: 26 | name = self.__diverted[name] 27 | return getattr(self.__target, name) 28 | 29 | 30 | class ZipFile(zipfile.ZipFile): 31 | """A ZipFile that supports dry-runs. 32 | 33 | It also keeps track of files already written, and only writes them 34 | once. ZipFile.filelist would have been useful for this, but on 35 | Windows, this doesn’t seem to reflect writes before syncing the 36 | file to disk. 37 | """ 38 | 39 | def __init__(self, *args, dry_run=False, ignore_missing=False, **kwargs): 40 | 41 | self.dry_run = dry_run 42 | self.stored_files = set() 43 | self.ignore_missing = ignore_missing 44 | 45 | if not self.dry_run: 46 | super().__init__(*args, **kwargs) 47 | 48 | def __exit__(self, *args, **kwargs): 49 | 50 | if not self.dry_run: 51 | super().__exit__(*args, **kwargs) 52 | 53 | def write(self, filename, *args, **kwargs): 54 | 55 | if filename in self.stored_files: 56 | return 57 | 58 | # Logging. 59 | curdir = os.getcwd() 60 | absname = os.path.join(curdir, filename) 61 | 62 | def log_skipped(): 63 | print("{} (not found)".format(absname)) 64 | 65 | def log_written(): 66 | print(absname) 67 | 68 | if not (os.path.isfile(filename) or self.ignore_missing): 69 | raise FileNotFoundError("No such file: {}".format(filename)) 70 | 71 | if self.dry_run and os.path.isfile(filename): 72 | log_written() 73 | 74 | elif self.dry_run: 75 | log_skipped() 76 | 77 | else: 78 | try: 79 | super().write(filename, *args, **kwargs) 80 | except FileNotFoundError: 81 | assert self.ignore_missing 82 | log_skipped() 83 | else: 84 | log_written() 85 | 86 | self.stored_files.add(filename) 87 | 88 | def put_metadata(self, comment=None): 89 | """Create a MANIFEST file and store it within the archive.""" 90 | 91 | manifest = dict( 92 | script_revision=REVISION, export_date=round(time.time()) 93 | ) 94 | 95 | if comment: 96 | manifest["comment"] = comment 97 | 98 | manifest = json.dumps(manifest) 99 | self.comment = manifest.encode("utf-8") 100 | 101 | 102 | def print_err(*args, **kwargs): 103 | # stderr could be reset at run-time, so we need to import it when 104 | # the function runs, not when this module is imported. 105 | from sys import stderr 106 | 107 | if "file" in kwargs: 108 | del kwargs["file"] 109 | print(*args, file=stderr, **kwargs) 110 | 111 | 112 | def strip_mime_parms(mime_type): 113 | "Remove any MIME parameters from a content-type header value." 114 | idx = mime_type.find(";") 115 | has_parms = idx >= 0 116 | if has_parms: 117 | return mime_type[:idx] 118 | else: 119 | return mime_type 120 | -------------------------------------------------------------------------------- /src/tts_tools/libgui/frame.py: -------------------------------------------------------------------------------- 1 | from tkinter import BOTH 2 | from tkinter import Button 3 | from tkinter import END 4 | from tkinter import Frame 5 | from tkinter import LabelFrame 6 | from tkinter import LEFT 7 | from tkinter import RIGHT 8 | from tkinter import Scrollbar 9 | from tkinter import Text 10 | from tkinter import X 11 | from tkinter import Y 12 | from tts_tools import util 13 | 14 | import sys 15 | 16 | 17 | class EntryFrame(LabelFrame): 18 | def __init__(self, master, *args, **kwargs): 19 | 20 | super().__init__(master, **kwargs) 21 | 22 | self.entries = [] 23 | for (key, entry_class, entry_kwargs) in args: 24 | 25 | entry = entry_class(self, **entry_kwargs) 26 | entry.pack(fill=X) 27 | self.__dict__[key] = entry.var 28 | self.entries.append(entry) 29 | 30 | 31 | class ButtonFrame(Frame): 32 | def __init__(self, master, *args): 33 | 34 | super().__init__(master) 35 | 36 | self.buttons = {} 37 | for label in args: 38 | 39 | button = Button(self, text=label) 40 | button.pack(side=LEFT) 41 | self.buttons[label] = button 42 | 43 | def on(self, label, command): 44 | 45 | self.buttons[label].config(command=command) 46 | 47 | 48 | class OutputFrame(LabelFrame): 49 | def __init__(self, master, *args, **kwargs): 50 | 51 | super().__init__(master, *args, **kwargs) 52 | self.output = StreamOutput(self) 53 | self.output.pack(expand=True, fill=BOTH, side=LEFT) 54 | 55 | self.scrollbar = Scrollbar(self, command=self.output.yview) 56 | self.scrollbar.pack(fill=Y, side=RIGHT) 57 | self.output.config(yscrollcommand=self.scrollbar.set) 58 | 59 | def __enter__(self): 60 | 61 | return self.output.__enter__() 62 | 63 | def __exit__(self, *args): 64 | 65 | return self.output.__exit__(*args) 66 | 67 | def clear(self): 68 | 69 | return self.output.clear() 70 | 71 | def install(self): 72 | 73 | return self.output.install() 74 | 75 | def uninstall(self): 76 | 77 | return self.output.uninstall() 78 | 79 | 80 | class StreamOutput(Text): 81 | def __init__(self, master): 82 | 83 | super().__init__(master) 84 | 85 | self.buffer = [] 86 | 87 | self.tag_configure("err", foreground="red") 88 | 89 | def install(self): 90 | 91 | self.__enter__() 92 | return 93 | 94 | def unistall(self): 95 | 96 | self.__exit__() 97 | return 98 | 99 | def __enter__(self): 100 | 101 | # Make a proxy which replaces self.write with self.write.err, 102 | # so we can colorize both streams differently. 103 | stderr_proxy = util.ShadowProxy(proxy_for=self) 104 | stderr_proxy.divert_access("write", "write_err") 105 | 106 | self.stdout, sys.stdout = sys.stdout, self 107 | self.stderr, sys.stderr = sys.stderr, stderr_proxy 108 | return self 109 | 110 | def __exit__(self, *args): 111 | 112 | self.flush() 113 | sys.stdout = self.stdout 114 | sys.stderr = self.stderr 115 | 116 | def clear(self): 117 | 118 | self.delete(1.0, END) 119 | 120 | def write(self, s): 121 | 122 | self.buffer.append(s) 123 | if s.endswith("\n"): 124 | self.flush() 125 | 126 | def write_err(self, s): 127 | 128 | self.insert("end", s, "err") 129 | self.see("end") 130 | 131 | def flush(self): 132 | 133 | for elem in self.buffer: 134 | self.insert("end", elem) 135 | self.buffer = [] 136 | 137 | self.see("end") 138 | 139 | return 140 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | TTS-Backup 2 | ========== 3 | 4 | TTS-Backup backs up Tabletop simulator save games and mods to a Zip 5 | file, bundling locally cached images and models within a single 6 | archive. 7 | 8 | This only handles saves and mods in JSON format. 9 | 10 | 11 | Requirements & Installation 12 | --------------------------- 13 | 14 | A Python 3.3 (or newer) interpreter is required. For Windows users, the 15 | `ActivePython `__ 16 | distribution is recommended. 17 | 18 | Alternatively, a binary release for the Windows platform is available 19 | `here 20 | `__. 21 | 22 | Optionally, to use the source distribution, download the current 23 | `release `__, and 24 | either use ``pip`` or ``easy_install`` on the archive file, or extract 25 | the contents and run ``python setup.py install``. 26 | 27 | 28 | Usage 29 | ----- 30 | 31 | All content referenced within the mod or save must have been locally 32 | cached from within TTS before a backup can be made. Note that when 33 | game items are contained within bags, TTS will only locally cache the 34 | respective assets once they are removed from the bag. 35 | 36 | By default, TTS-Backup will assume that cached data is located in 37 | ``~/Documents/My Games/Tabletop Simulator``. 38 | 39 | TTS-Backup is a console application. For stern opponents of the CLI, a 40 | minimal GUI is provided. 41 | 42 | Usage flags and arguments are as follows: 43 | 44 | :: 45 | 46 | usage: tts-backup [-h] [--gamedata PATH] [--outname FILENAME] [--dry-run] 47 | [--ignore-missing] [--comment COMMENT] 48 | FILENAME 49 | 50 | Back-up locally cached content from a TTS .json file. 51 | 52 | positional arguments: 53 | FILENAME The save file or mod in JSON format. 54 | 55 | optional arguments: 56 | -h, --help show this help message and exit 57 | --gamedata PATH The path to the TTS game data directory. 58 | --outname FILENAME, -o FILENAME 59 | The name for the output archive. 60 | --dry-run, -n Only print which files would be backed up. 61 | --ignore-missing, -i Don’t abort the backup when files are missing. 62 | --comment COMMENT, -c COMMENT 63 | A comment to be stored in the resulting Zip. 64 | 65 | 66 | TTS-Prefetch 67 | ============ 68 | 69 | TTS-Prefetch downloads assets specified within a TTS JSON save file 70 | and stores them within the TTS cache. This is handy if you want to 71 | ensure that all mod assets are present, e. g., when several mods have 72 | been updated, or when a mod uses bags, which normally require that all 73 | pieces are unpacked manually before they are fetched and stored inside 74 | the TTS cache. 75 | 76 | 77 | Requirements & Installation 78 | --------------------------- 79 | 80 | Cf. above. 81 | 82 | 83 | Usage 84 | ----- 85 | 86 | By default, TTS-Prefetch will assume that cached data is located in 87 | ``~/Documents/My Games/Tabletop Simulator``. 88 | 89 | TTS-Prefetch is a console application. For stern opponents of the CLI, 90 | a minimal GUI is provided. 91 | 92 | Usage flags and arguments are as follows: 93 | 94 | :: 95 | 96 | usage: tts-prefetch [-h] [--gamedata PATH] [--dry-run] [--refetch] [--relax] 97 | [--timeout TIMEOUT] [--user-agent USER_AGENT] 98 | FILENAME [FILENAME ...] 99 | 100 | Download assets referenced in TTS .json files. 101 | 102 | positional arguments: 103 | FILENAME The save file or mod in JSON format. 104 | 105 | optional arguments: 106 | -h, --help show this help message and exit 107 | --gamedata PATH The path to the TTS game data directory. 108 | --dry-run, -n Only print which files would be downloaded. 109 | --refetch, -r Rewrite objects that already exist in the cache. 110 | --relax, -x Do not abort when encountering an unexpected MIME 111 | type. 112 | --timeout TIMEOUT, -t TIMEOUT 113 | Connection timeout in s. 114 | --user-agent USER_AGENT, -a USER_AGENT 115 | HTTP user-agent string. 116 | -------------------------------------------------------------------------------- /src/tts_tools/libtts.py: -------------------------------------------------------------------------------- 1 | import json 2 | import os 3 | import platform 4 | import re 5 | 6 | 7 | IMGPATH = os.path.join("Mods", "Images") 8 | OBJPATH = os.path.join("Mods", "Models") 9 | BUNDLEPATH = os.path.join("Mods", "Assetbundles") 10 | AUDIOPATH = os.path.join("Mods", "Audio") 11 | PDFPATH = os.path.join("Mods", "PDF") 12 | 13 | gamedata_map = { 14 | "Windows": "~/Documents/My Games/Tabletop Simulator", 15 | "Darwin": "~/Library/Tabletop Simulator", # MacOS 16 | "Linux": "~/.local/share/Tabletop Simulator", 17 | } 18 | try: 19 | active_platform = platform.system() 20 | GAMEDATA_DEFAULT = os.path.expanduser(gamedata_map[active_platform]) 21 | except KeyError: 22 | GAMEDATA_DEFAULT = os.path.expanduser(gamedata_map["Windows"]) 23 | 24 | 25 | class IllegalSavegameException(ValueError): 26 | def __init__(self): 27 | super().__init__("not a Tabletop Simulator savegame") 28 | 29 | 30 | def seekURL(dic, trail=[]): 31 | """Recursively search through the save game structure and return URLs 32 | and the paths to them. 33 | 34 | """ 35 | 36 | for k, v in dic.items(): 37 | 38 | newtrail = trail + [k] 39 | 40 | if k == "AudioLibrary": 41 | for elem in v: 42 | try: 43 | # It appears that AudioLibrary items are mappings of form 44 | # “Item1” → URL, “Item2” → audio title. 45 | yield (newtrail, elem["Item1"]) 46 | except KeyError: 47 | raise NotImplementedError( 48 | "AudioLibrary has unexpected structure: {}".format(v) 49 | ) 50 | 51 | elif isinstance(v, dict): 52 | yield from seekURL(v, newtrail) 53 | 54 | elif isinstance(v, list): 55 | for elem in v: 56 | if not isinstance(elem, dict): 57 | continue 58 | yield from seekURL(elem, newtrail) 59 | 60 | elif k.lower().endswith("url"): 61 | # We don’t want tablet URLs. 62 | if k == "PageURL": 63 | continue 64 | 65 | # Some URL keys may be left empty. 66 | if not v: 67 | continue 68 | 69 | # Deck art URLs can contain metadata in curly braces 70 | # (yikes). 71 | v = re.sub(r"{.*}", "", v) 72 | 73 | yield (newtrail, v) 74 | 75 | 76 | # We need checks for whether a URL points to a mesh or an image, so we 77 | # can do the right thing for each. 78 | 79 | 80 | def is_obj(path, url): 81 | # TODO: None of my mods have NormalURL set (normal maps?). I’m 82 | # assuming these are image files. 83 | obj_keys = ("MeshURL", "ColliderURL") 84 | return path[-1] in obj_keys 85 | 86 | 87 | def is_image(path, url): 88 | # This assumes that we only have mesh, assetbundle, audio, PDF and image 89 | # URLs. 90 | return not ( 91 | is_obj(path, url) 92 | or is_assetbundle(path, url) 93 | or is_audiolibrary(path, url) 94 | or is_pdf(path, url) 95 | ) 96 | 97 | 98 | def is_assetbundle(path, url): 99 | bundle_keys = ("AssetbundleURL", "AssetbundleSecondaryURL") 100 | return path[-1] in bundle_keys 101 | 102 | 103 | def is_audiolibrary(path, url): 104 | audio_keys = ("CurrentAudioURL", "AudioLibrary") 105 | return path[-1] in audio_keys 106 | 107 | 108 | def is_pdf(path, url): 109 | return path[-1] == "PDFUrl" 110 | 111 | 112 | def recodeURL(url): 113 | """Recode the given URL in the way TTS does, which yields the 114 | file-system path to the cached file.""" 115 | 116 | return re.sub(r"[\W_]", "", url) 117 | 118 | 119 | def get_fs_path(path, url): 120 | """Return a file-system path to the object in the cache.""" 121 | 122 | recoded_name = recodeURL(url) 123 | 124 | if is_obj(path, url): 125 | filename = recoded_name + ".obj" 126 | return os.path.join(OBJPATH, filename) 127 | 128 | elif is_assetbundle(path, url): 129 | filename = recoded_name + ".unity3d" 130 | return os.path.join(BUNDLEPATH, filename) 131 | 132 | elif is_audiolibrary(path, url): 133 | # Is the suffix always MP3, regardless of content? 134 | filename = recoded_name + ".MP3" 135 | return os.path.join(AUDIOPATH, filename) 136 | 137 | elif is_pdf(path, url): 138 | filename = recoded_name + ".PDF" 139 | return os.path.join(PDFPATH, filename) 140 | 141 | elif is_image(path, url): 142 | # TTS appears to perform some weird heuristics when determining 143 | # the file suffix. ._. 144 | if url.find(".png") > 0: 145 | file_suffix = ".png" 146 | else: 147 | file_suffix = ".jpg" 148 | filename = recoded_name + file_suffix 149 | return os.path.join(IMGPATH, filename) 150 | 151 | else: 152 | errstr = ( 153 | "Do not know how to generate path for " 154 | "URL {url} at {path}.".format(url=url, path=path) 155 | ) 156 | raise ValueError(errstr) 157 | 158 | 159 | def urls_from_save(filename): 160 | 161 | with open(filename, "r", encoding="utf-8") as infile: 162 | try: 163 | save = json.load(infile) 164 | except UnicodeDecodeError: 165 | raise IllegalSavegameException 166 | 167 | if not isinstance(save, dict): 168 | raise IllegalSavegameException 169 | 170 | return seekURL(save) 171 | 172 | 173 | def get_save_name(filename): 174 | 175 | with open(filename, "r", encoding="utf-8") as infile: 176 | save = json.load(infile) 177 | return save["SaveName"] 178 | -------------------------------------------------------------------------------- /src/tts_tools/prefetch/gui.py: -------------------------------------------------------------------------------- 1 | from contextlib import ExitStack 2 | from contextlib import suppress 3 | from tkinter import BOTH 4 | from tkinter import Frame 5 | from tkinter import Label 6 | from tkinter import LabelFrame 7 | from tkinter import LEFT 8 | from tkinter import N 9 | from tkinter import Tk 10 | from tkinter import X 11 | from tkinter.font import Font 12 | from tts_tools import libtts 13 | from tts_tools.libgui.entry import DirEntry 14 | from tts_tools.libgui.entry import FileEntry 15 | from tts_tools.libgui.entry import TextEntry 16 | from tts_tools.libgui.entry import ToggleEntry 17 | from tts_tools.libgui.frame import ButtonFrame 18 | from tts_tools.libgui.frame import EntryFrame 19 | from tts_tools.libgui.frame import OutputFrame 20 | from tts_tools.prefetch import cli 21 | from tts_tools.prefetch import prefetch_files 22 | 23 | import argparse 24 | import os 25 | import os.path 26 | import threading 27 | 28 | 29 | class GUI(Frame): 30 | 31 | argparser = argparse.ArgumentParser( 32 | description="Back-up locally cached content " "from a TTS .json file." 33 | ) 34 | 35 | argparser.add_argument( 36 | "infile", 37 | metavar="FILENAME", 38 | default="", 39 | nargs="?", 40 | help="The save file or mod in JSON format.", 41 | ) 42 | 43 | def __init__(self, master): 44 | 45 | super().__init__(master) 46 | 47 | self.running = None 48 | self.semaphore = None 49 | 50 | self.args = self.argparser.parse_args() 51 | 52 | self.make_widgets() 53 | 54 | def quit(self): 55 | 56 | if self.running and self.running.is_alive(): 57 | self.stop() 58 | self.after(300, self.quit) 59 | else: 60 | super().quit() 61 | 62 | def make_widgets(self): 63 | 64 | self.label = Label( 65 | self, text="TTS-Prefetch", font=Font(size=14, weight="bold") 66 | ) 67 | self.label.pack() 68 | 69 | leftpane = Frame(self) 70 | leftpane.configure(bg="black") 71 | 72 | homedir = os.path.expanduser("~") 73 | self.settings = EntryFrame( 74 | leftpane, 75 | ( 76 | "infile", 77 | FileEntry, 78 | dict( 79 | label="Input file", 80 | initialdir=libtts.GAMEDATA_DEFAULT, 81 | filetypes=[("JSON-file", "*.json")], 82 | action="open", 83 | default=self.args.infile, 84 | ), 85 | ), 86 | ( 87 | "gamedata", 88 | DirEntry, 89 | dict( 90 | label="Gamedata path", 91 | default=libtts.GAMEDATA_DEFAULT, 92 | initialdir=homedir, 93 | mustexist=True, 94 | ), 95 | ), 96 | ("dry_run", ToggleEntry, dict(label="Dry run")), 97 | ("refetch", ToggleEntry, dict(label="Refetch")), 98 | ("relax", ToggleEntry, dict(label="Relax")), 99 | ("user_agent", TextEntry, dict(label="User-agent")), 100 | text="Settings", 101 | width=60, 102 | ) 103 | self.settings.pack(fill=X) 104 | 105 | control = LabelFrame(leftpane, text="Control") 106 | self.buttons = ButtonFrame(control, "Run", "Stop", "Quit") 107 | self.buttons.pack() 108 | self.buttons.on("Run", self.run) 109 | self.buttons.on("Stop", self.stop) 110 | self.buttons.on("Quit", self.quit) 111 | control.pack(fill=X) 112 | 113 | leftpane.pack(side=LEFT, anchor=N) 114 | 115 | self.output = OutputFrame(self, text="Output") 116 | self.output.pack(expand=True, fill=BOTH) 117 | 118 | def run(self): 119 | 120 | if self.running and self.running.is_alive(): 121 | return 122 | 123 | args = self.parse_args() 124 | if not args: 125 | return 126 | 127 | self.output.clear() 128 | 129 | self.semaphore = threading.Semaphore(0) 130 | 131 | def callback(): 132 | 133 | with ExitStack() as stack: 134 | stack.enter_context(self.output) 135 | stack.enter_context(suppress(SystemExit)) 136 | prefetch_files(args, self.semaphore) 137 | 138 | thread = threading.Thread(target=callback) 139 | thread.start() 140 | self.running = thread 141 | 142 | def stop(self): 143 | def callback(): 144 | 145 | if self.running and self.running.is_alive(): 146 | self.semaphore.release() 147 | self.running.join() 148 | 149 | thread = threading.Thread(target=callback) 150 | thread.start() 151 | 152 | def parse_args(self): 153 | 154 | commands = [] 155 | 156 | infile = self.settings.infile.get() 157 | if infile: 158 | commands.append(infile) 159 | else: 160 | return 161 | 162 | gamedata = self.settings.gamedata.get() 163 | if gamedata: 164 | commands.extend(["--gamedata", gamedata]) 165 | 166 | if self.settings.dry_run.get(): 167 | commands.append("--dry-run") 168 | 169 | if self.settings.relax.get(): 170 | commands.append("--relax") 171 | 172 | if self.settings.refetch.get(): 173 | commands.append("--refetch") 174 | 175 | user_agent = self.settings.user_agent.get() 176 | if user_agent: 177 | commands.extend(["--user-agent", user_agent]) 178 | 179 | return cli.parser.parse_args(args=commands) 180 | 181 | 182 | def gui_entry(): 183 | 184 | root = Tk() 185 | gui = GUI(root) 186 | gui.pack(fill=BOTH, expand=True) 187 | root.mainloop() 188 | -------------------------------------------------------------------------------- /src/tts_tools/backup/gui.py: -------------------------------------------------------------------------------- 1 | from contextlib import ExitStack 2 | from contextlib import suppress 3 | from tkinter import BOTH 4 | from tkinter import Frame 5 | from tkinter import Label 6 | from tkinter import LabelFrame 7 | from tkinter import LEFT 8 | from tkinter import N 9 | from tkinter import Tk 10 | from tkinter import X 11 | from tkinter.font import Font 12 | from tts_tools import libtts 13 | from tts_tools.backup import backup_json 14 | from tts_tools.backup import cli 15 | from tts_tools.libgui.entry import DirEntry 16 | from tts_tools.libgui.entry import FileEntry 17 | from tts_tools.libgui.entry import TextEntry 18 | from tts_tools.libgui.entry import ToggleEntry 19 | from tts_tools.libgui.frame import ButtonFrame 20 | from tts_tools.libgui.frame import EntryFrame 21 | from tts_tools.libgui.frame import OutputFrame 22 | 23 | import argparse 24 | import os 25 | import os.path 26 | import re 27 | import threading 28 | 29 | 30 | class GUI(Frame): 31 | 32 | argparser = argparse.ArgumentParser( 33 | description="Back-up locally cached content " "from a TTS .json file." 34 | ) 35 | 36 | argparser.add_argument( 37 | "infile", 38 | metavar="FILENAME", 39 | default="", 40 | nargs="?", 41 | help="The save file or mod in JSON format.", 42 | ) 43 | 44 | def __init__(self, master): 45 | 46 | super().__init__(master) 47 | 48 | self.running = None 49 | self.args = self.argparser.parse_args() 50 | 51 | self.make_widgets() 52 | 53 | def make_widgets(self): 54 | 55 | self.label = Label( 56 | self, text="TTS-Backup", font=Font(size=14, weight="bold") 57 | ) 58 | self.label.pack() 59 | 60 | leftpane = Frame(self) 61 | 62 | homedir = os.path.expanduser("~") 63 | self.settings = EntryFrame( 64 | leftpane, 65 | ( 66 | "infile", 67 | FileEntry, 68 | dict( 69 | label="Input file", 70 | initialdir=libtts.GAMEDATA_DEFAULT, 71 | filetypes=[("JSON-file", "*.json")], 72 | action="open", 73 | ), 74 | ), 75 | ( 76 | "gamedata", 77 | DirEntry, 78 | dict( 79 | label="Gamedata path", 80 | default=libtts.GAMEDATA_DEFAULT, 81 | initialdir=homedir, 82 | mustexist=True, 83 | ), 84 | ), 85 | ( 86 | "outfile", 87 | FileEntry, 88 | dict( 89 | label="Output archive", 90 | initialdir=homedir, 91 | defaultextension=".zip", 92 | action="save", 93 | ), 94 | ), 95 | ("comment", TextEntry, dict(label="Archive comment")), 96 | ("dry_run", ToggleEntry, dict(label="Dry run")), 97 | ("ignore_missing", ToggleEntry, dict(label="Ignore missing")), 98 | text="Settings", 99 | width=60, 100 | ) 101 | self.settings.infile.trace("w", self.on_infile_change) 102 | self.settings.infile.set(self.args.infile) 103 | self.settings.pack(fill=X) 104 | 105 | control = LabelFrame(leftpane, text="Control") 106 | self.buttons = ButtonFrame(control, "Run", "Quit") 107 | self.buttons.pack() 108 | self.buttons.on("Quit", self.quit) 109 | self.buttons.on("Run", self.run) 110 | control.pack(fill=X) 111 | 112 | leftpane.pack(side=LEFT, anchor=N) 113 | 114 | self.output = OutputFrame(self, text="Output") 115 | self.output.pack(expand=True, fill=BOTH) 116 | 117 | def run(self): 118 | 119 | if self.running and self.running.is_alive(): 120 | return 121 | 122 | args = self.parse_args() 123 | if not args: 124 | return 125 | 126 | self.output.clear() 127 | 128 | def callback(): 129 | 130 | with ExitStack() as stack: 131 | stack.enter_context(self.output) 132 | stack.enter_context(suppress(SystemExit)) 133 | backup_json(args) 134 | 135 | thread = threading.Thread(target=callback) 136 | thread.start() 137 | self.running = thread 138 | 139 | def parse_args(self): 140 | 141 | commands = [] 142 | 143 | infile = self.settings.infile.get() 144 | if infile: 145 | commands.append(infile) 146 | else: 147 | return 148 | 149 | gamedata = self.settings.gamedata.get() 150 | if gamedata: 151 | commands.extend(["--gamedata", gamedata]) 152 | 153 | outfile = self.settings.outfile.get() 154 | if outfile: 155 | commands.extend(["--outname", outfile]) 156 | 157 | if self.settings.dry_run.get(): 158 | commands.append("--dry-run") 159 | 160 | if self.settings.ignore_missing.get(): 161 | commands.append("--ignore-missing") 162 | 163 | comment = self.settings.comment.get() 164 | if comment: 165 | commands.extend(["--comment", comment]) 166 | 167 | return cli.parser.parse_args(args=commands) 168 | 169 | def on_infile_change(self, *args): 170 | 171 | filename = self.settings.infile.get() 172 | filename = os.path.basename(filename) 173 | filename = re.sub(r"\.json$", "", filename) 174 | 175 | if filename: 176 | filename += ".zip" 177 | filename = os.path.join(os.path.expanduser("~"), filename) 178 | self.settings.outfile.set(filename) 179 | 180 | 181 | def gui_entry(): 182 | 183 | root = Tk() 184 | gui = GUI(root) 185 | gui.pack(fill=BOTH, expand=True) 186 | root.mainloop() 187 | -------------------------------------------------------------------------------- /src/tts_tools/prefetch/__init__.py: -------------------------------------------------------------------------------- 1 | from contextlib import suppress 2 | from tts_tools.libtts import GAMEDATA_DEFAULT 3 | from tts_tools.libtts import get_fs_path 4 | from tts_tools.libtts import get_save_name 5 | from tts_tools.libtts import IllegalSavegameException 6 | from tts_tools.libtts import is_assetbundle 7 | from tts_tools.libtts import is_audiolibrary 8 | from tts_tools.libtts import is_image 9 | from tts_tools.libtts import is_obj 10 | from tts_tools.libtts import is_pdf 11 | from tts_tools.libtts import urls_from_save 12 | from tts_tools.util import print_err 13 | 14 | import http.client 15 | import os 16 | import socket 17 | import sys 18 | import urllib.error 19 | import urllib.parse 20 | import urllib.request 21 | 22 | 23 | def prefetch_file( 24 | filename, 25 | refetch=False, 26 | ignore_content_type=False, 27 | dry_run=False, 28 | gamedata_dir=GAMEDATA_DEFAULT, 29 | timeout=5, 30 | semaphore=None, 31 | user_agent="TTS prefetch", 32 | ): 33 | 34 | try: 35 | save_name = get_save_name(filename) 36 | except Exception: 37 | save_name = "???" 38 | 39 | print( 40 | "Prefetching assets for {file} ({save_name}).".format( 41 | file=filename, save_name=save_name 42 | ) 43 | ) 44 | 45 | try: 46 | urls = urls_from_save(filename) 47 | except (FileNotFoundError, IllegalSavegameException) as error: 48 | print_err( 49 | "Error retrieving URLs from {filename}: {error}".format( 50 | error=error, filename=filename 51 | ) 52 | ) 53 | raise 54 | 55 | done = set() 56 | for path, url in urls: 57 | 58 | if semaphore and semaphore.acquire(blocking=False): 59 | print("Aborted.") 60 | return 61 | 62 | # Some mods contain malformed URLs missing a prefix. I’m not 63 | # sure how TTS deals with these. Let’s assume http for now. 64 | if not urllib.parse.urlparse(url).scheme: 65 | print_err( 66 | "Warning: URL {url} does not specify a URL scheme. " 67 | "Assuming http.".format(url=url) 68 | ) 69 | fetch_url = "http://" + url 70 | else: 71 | fetch_url = url 72 | 73 | # A mod might refer to the same URL multiple times. 74 | if url in done: 75 | continue 76 | 77 | # To prevent downloading unexpected content, we check the MIME 78 | # type in the response. 79 | if is_obj(path, url): 80 | 81 | def content_expected(mime): 82 | return any( 83 | map( 84 | mime.startswith, 85 | ( 86 | "text/plain", 87 | "application/binary", 88 | "application/octet-stream", 89 | "application/json", 90 | "application/x-tgif", 91 | ), 92 | ) 93 | ) 94 | 95 | elif is_assetbundle(path, url): 96 | 97 | def content_expected(mime): 98 | return any( 99 | map( 100 | mime.startswith, 101 | ("application/binary", "application/octet-stream"), 102 | ) 103 | ) 104 | 105 | elif is_image(path, url): 106 | 107 | def content_expected(mime): 108 | return mime in ( 109 | "image/jpeg", 110 | "image/jpg", 111 | "image/png", 112 | "application/octet-stream", 113 | "application/binary", 114 | "video/mp4", 115 | ) 116 | 117 | elif is_audiolibrary(path, url): 118 | 119 | def content_expected(mime): 120 | return mime in ( 121 | "application/octet-stream", 122 | "application/binary", 123 | ) or mime.startswith("audio/") 124 | 125 | elif is_pdf(path, url): 126 | 127 | def content_expected(mime): 128 | return mime in ( 129 | "application/pdf", 130 | "application/binary", 131 | "application/octet-stream", 132 | ) 133 | 134 | else: 135 | errstr = "Do not know how to retrieve URL {url} at {path}.".format( 136 | url=url, path=path 137 | ) 138 | raise ValueError(errstr) 139 | 140 | outfile_name = os.path.join(gamedata_dir, get_fs_path(path, url)) 141 | 142 | # Check if the object is already cached. 143 | if os.path.isfile(outfile_name) and not refetch: 144 | done.add(url) 145 | continue 146 | 147 | print("{} ".format(url), end="", flush=True) 148 | 149 | if dry_run: 150 | print("dry run") 151 | done.add(url) 152 | continue 153 | 154 | headers = {"User-Agent": user_agent} 155 | request = urllib.request.Request(url=fetch_url, headers=headers) 156 | 157 | try: 158 | response = urllib.request.urlopen(request, timeout=timeout) 159 | 160 | except urllib.error.HTTPError as error: 161 | print_err( 162 | "Error {code} ({reason})".format( 163 | code=error.code, reason=error.reason 164 | ) 165 | ) 166 | continue 167 | 168 | except urllib.error.URLError as error: 169 | print_err("Error ({reason})".format(reason=error.reason)) 170 | continue 171 | 172 | except socket.timeout as error: 173 | print_err("Error ({reason})".format(reason=error)) 174 | continue 175 | 176 | except http.client.HTTPException as error: 177 | print_err("HTTP error ({reason})".format(reason=error)) 178 | continue 179 | 180 | # Only for informative purposes. 181 | length = response.getheader("Content-Length", 0) 182 | length_kb = "???" 183 | if length: 184 | with suppress(ValueError): 185 | length_kb = int(length) / 1000 186 | size_msg = "({length} kb): ".format(length=length_kb) 187 | print(size_msg, end="", flush=True) 188 | 189 | content_type = response.getheader("Content-Type", "").strip() 190 | is_expected = not content_type or content_expected(content_type) 191 | if not (is_expected or ignore_content_type): 192 | print_err( 193 | "Error: Content type {type} does not match expected type. " 194 | "Aborting. Use --relax to ignore.".format(type=content_type) 195 | ) 196 | sys.exit(1) 197 | 198 | try: 199 | with open(outfile_name, "wb") as outfile: 200 | outfile.write(response.read()) 201 | 202 | except FileNotFoundError as error: 203 | print_err("Error writing object to disk: {}".format(error)) 204 | raise 205 | 206 | # Don’t leave files with partial content lying around. 207 | except Exception: 208 | with suppress(FileNotFoundError): 209 | os.remove(outfile_name) 210 | raise 211 | 212 | else: 213 | print("ok") 214 | 215 | if not is_expected: 216 | errmsg = ( 217 | "Warning: Content type {} did not match " 218 | "expected type.".format(content_type) 219 | ) 220 | print_err(errmsg) 221 | 222 | done.add(url) 223 | 224 | if dry_run: 225 | completion_msg = "Dry-run for {} completed." 226 | else: 227 | completion_msg = "Prefetching {} completed." 228 | print(completion_msg.format(filename)) 229 | 230 | 231 | def prefetch_files(args, semaphore=None): 232 | 233 | for infile_name in args.infile_names: 234 | 235 | try: 236 | prefetch_file( 237 | infile_name, 238 | dry_run=args.dry_run, 239 | refetch=args.refetch, 240 | ignore_content_type=args.ignore_content_type, 241 | gamedata_dir=args.gamedata_dir, 242 | timeout=args.timeout, 243 | semaphore=semaphore, 244 | user_agent=args.user_agent, 245 | ) 246 | 247 | except (FileNotFoundError, IllegalSavegameException, SystemExit): 248 | print_err("Aborting.") 249 | sys.exit(1) 250 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------