install.py

#!/usr/bin/env python3
#
# Copyright (C) 2026 Junaid Qadir Shekhanzai
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, see <https://www.gnu.org/licenses/>.
#
"""Install "True Center Align" into Inkscape on macOS, Linux or Windows.

Four pieces go into the Inkscape user profile:

  extensions/true_center_align/   the extension itself
  icons/                          the toolbar icon, as a hicolor theme
  ui/align-and-distribute.ui      a patched dialog carrying the new button
  keys/default.xml                the keyboard shortcut

Only the first is what Inkscape's Extension Manager can distribute; the rest is
why this script exists. Run it again after upgrading Inkscape to rebuild the
patched dialog against the new version, then restart Inkscape.
"""

import argparse
import shutil
import sys
from pathlib import Path

HERE = Path(__file__).resolve().parent
sys.path.insert(0, str(HERE / "tools"))

import inkscape_paths  # noqa: E402
import merge_shortcut  # noqa: E402
import patch_align_ui  # noqa: E402

EXTENSION_FILES = ("true_center_align.py", "true_center_align.inx")
EXTENSION_DIRS = ("icons",)
PACKAGE_NAME = "true_center_align"



class Installer:
    def __init__(self, profile: Path, share: Path, dry_run: bool):
        self.profile = profile
        self.share = share
        self.dry_run = dry_run
        self.steps = []

    def note(self, message):
        prefix = "would " if self.dry_run else ""
        print(f"  {prefix}{message}")

    def copy_tree(self, src: Path, dst: Path):
        self.note(f"copy {src.name}/ -> {dst}")
        if not self.dry_run:
            shutil.copytree(src, dst, dirs_exist_ok=True)

    def copy_file(self, src: Path, dst: Path):
        self.note(f"copy {src.name} -> {dst}")
        if not self.dry_run:
            dst.parent.mkdir(parents=True, exist_ok=True)
            shutil.copy2(src, dst)

    def install_extension(self):
        print("==> extension")
        target = self.profile / "extensions" / PACKAGE_NAME
        if target.resolve() == HERE:
            print(f"  already installed in place at {target}")
            return
        for name in EXTENSION_FILES:
            self.copy_file(HERE / name, target / name)
        for name in EXTENSION_DIRS:
            source = HERE / name
            if source.is_dir():
                self.copy_tree(source, target / name)

    def install_icons(self):
        print("==> icons")
        self.copy_tree(HERE / "profile" / "icons", self.profile / "icons")

    def install_dialog(self):
        print("==> Align & Distribute button")
        out = self.profile / "ui" / "align-and-distribute.ui"
        if out.is_file():
            backup = out.with_suffix(".ui.bak")
            self.note(f"back up existing dialog -> {backup}")
            if not self.dry_run:
                shutil.move(str(out), str(backup))
        self.note(f"generate {out} from {self.share}")
        if not self.dry_run:
            patch_align_ui.write_patched(self.share, out)

    def install_shortcut(self, keys: str):
        print("==> keyboard shortcut")
        clashes = merge_shortcut.conflicts(self.share, keys)
        for action in clashes:
            print(f"  warning: {keys} is already bound to {action}", file=sys.stderr)
        keys_file = self.profile / "keys" / "default.xml"
        if self.dry_run:
            self.note(f"bind {keys} in {keys_file}")
        else:
            print(f"  {merge_shortcut.merge(keys_file, keys)}")


def main() -> int:
    ap = argparse.ArgumentParser(
        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter
    )
    ap.add_argument("--profile", type=Path, help="Inkscape user profile directory")
    ap.add_argument("--share", type=Path, help="Inkscape share/inkscape directory")
    ap.add_argument("--inkscape", type=Path, help="Inkscape executable to interrogate")
    ap.add_argument("--shortcut", default=merge_shortcut.DEFAULT_KEYS,
                    help="accelerator to bind (default: %(default)s)")
    ap.add_argument("--no-shortcut", action="store_true", help="skip the shortcut")
    ap.add_argument("--no-dialog", action="store_true",
                    help="skip the Align & Distribute button")
    ap.add_argument("--dry-run", action="store_true",
                    help="report what would happen, change nothing")
    args = ap.parse_args()

    binary = args.inkscape or inkscape_paths.find_binary()
    profile = args.profile or inkscape_paths.profile_dir(binary)
    share = args.share or inkscape_paths.share_dir(binary)

    print(f"platform: {sys.platform}")
    print(f"inkscape: {binary or '(not found)'}")
    print(f"profile:  {profile or '(unknown)'}")
    print(f"share:    {share or '(unknown)'}")
    print()

    if profile is None:
        print("error: could not locate Inkscape's user profile directory.\n"
              "       pass --profile /path/to/inkscape (the folder holding "
              "preferences.xml).", file=sys.stderr)
        return 1

    installer = Installer(profile, share, args.dry_run)
    installer.install_extension()
    installer.install_icons()

    if share is None:
        print("\nwarning: Inkscape's share directory was not found, so the Align "
              "& Distribute\n         button and the shortcut conflict check were "
              "skipped. Pass --share\n         /path/to/share/inkscape to enable "
              "them.", file=sys.stderr)
    else:
        if not args.no_dialog:
            installer.install_dialog()
        if not args.no_shortcut:
            installer.install_shortcut(args.shortcut)

    print("\nDone. Restart Inkscape." if not args.dry_run else "\nDry run: nothing changed.")
    return 0


if __name__ == "__main__":
    sys.exit(main())