Run tests in parallel

Provides consistent ordering for numbers in names

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Report a bug
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Attach logs**
+ `%LOCALAPPDATA%\ComicTagger\logs` on windows
+`~/Library/Logs/ComicTagger` on macOS
+`~/.cache/ComicTagger/log` on Linux
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Fedora]
+ - Version [e.g. 1.6.0b2]
+ - Where did you install ComicTagger from? [e.g. releases page]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: feature-request
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build.yaml

@@ -0,0 +1,98 @@
+name: CI
+
+env:
+  LC_COLLATE: en_US.UTF-8
+on:
+  pull_request:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - '**'
+jobs:
+  lint:
+    permissions:
+      checks: write
+      contents: read
+      pull-requests: write
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.9]
+        os: [ubuntu-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install flake8
+
+      - uses: reviewdog/action-setup@v1
+        with:
+          reviewdog_version: nightly
+      - run: flake8 | reviewdog -f=flake8 -reporter=github-pr-review -tee -level=error -fail-on-error
+        env:
+          REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  build-and-test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.9, 3.13]
+        os: [ubuntu-22.04, macos-13, macos-14, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install tox
+        run: |
+          python -m pip install --upgrade --upgrade-strategy eager tox
+
+      - name: Install macos dependencies
+        run: |
+          brew upgrade icu4c pkg-config || brew install icu4c pkg-config
+        if: runner.os == 'macOS'
+
+      - name: Install linux dependencies
+        run: |
+          sudo apt-get update && sudo apt-get upgrade && sudo apt-get install pkg-config libicu-dev libqt6gui6 libfuse2 desktop-file-utils
+        if: runner.os == 'Linux'
+
+      - name: Build and install PyPi packages
+        run: |
+          export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig:/opt/homebrew/opt/icu4c/lib/pkgconfig${PKG_CONFIG_PATH+:$PKG_CONFIG_PATH}";
+          export PATH="/usr/local/opt/icu4c/bin:/usr/local/opt/icu4c/sbin${PATH+:$PATH}"
+          python -m tox r -m build
+        shell: bash
+
+      - name: Archive production artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: "${{ format('ComicTagger-{0}', matrix.os) }}"
+          path: |
+            dist/*.whl
+            dist/binary/*.zip
+            dist/binary/*.tar.gz
+            dist/binary/*.dmg
+            dist/binary/*.AppImage
+        if: matrix.python == 3.12
+
+      - name: PyTest
+        run: |
+          python -m tox p -e py${{ matrix.python-version }}-none,py${{ matrix.python-version }}-gui,py${{ matrix.python-version }}-7z,py${{ matrix.python-version }}-cbr,py${{ matrix.python-version }}-all
+        shell: bash

.github/workflows/contributions.yaml

@@ -0,0 +1,43 @@
+name: Contributions
+on:
+  push:
+    branches:
+      - 'develop'
+    tags-ignore:
+      - '**'
+
+jobs:
+  contrib-readme-job:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    env:
+      CI_COMMIT_AUTHOR: github-actions[bot]
+      CI_COMMIT_EMAIL: <41898282+github-actions[bot]@users.noreply.github.com>
+      CI_COMMIT_MESSAGE: Update AUTHORS
+    name: A job to automate contrib in readme
+    steps:
+      - name: Contribute List
+        uses: akhilmhdh/contributors-readme-action@v2.3.6
+        with:
+          use_username: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Update AUTHORS
+        run: |
+          git config --global log.mailmap true
+          git log --reverse '--format=%aN <%aE>' | cat -n | sort -uk2 | sort -n | cut -f2- >AUTHORS
+
+      - name: Commit and push AUTHORS
+        run: |
+          if ! git diff --exit-code; then
+            git pull
+            git config --global user.name "${{ env.CI_COMMIT_AUTHOR }}"
+            git config --global user.email "${{ env.CI_COMMIT_EMAIL }}"
+            git commit -a -m "${{ env.CI_COMMIT_MESSAGE }}"
+            git push
+          fi

.github/workflows/package.yaml

@@ -0,0 +1,76 @@
+name: Package
+
+env:
+  LC_COLLATE: en_US.UTF-8
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+*"
+jobs:
+  package:
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+      contents: write
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.13]
+        os: [ubuntu-22.04, ubuntu-22.04-arm, macos-13, macos-14, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install tox
+        run: |
+          python -m pip install --upgrade --upgrade-strategy eager tox
+
+      - name: Install macos dependencies
+        run: |
+          brew upgrade icu4c pkg-config || brew install icu4c pkg-config
+        if: runner.os == 'macOS'
+
+      - name: Install linux dependencies
+        run: |
+          sudo apt-get update && sudo apt-get upgrade && sudo apt-get install pkg-config libicu-dev libqt6gui6 libfuse2 desktop-file-utils
+        if: runner.os == 'Linux'
+
+      - name: Build, Install and Test PyPi packages
+        run: |
+          export PKG_CONFIG_PATH="/usr/local/opt/icu4c/lib/pkgconfig:/opt/homebrew/opt/icu4c/lib/pkgconfig${PKG_CONFIG_PATH+:$PKG_CONFIG_PATH}";
+          export PATH="/usr/local/opt/icu4c/bin:/usr/local/opt/icu4c/sbin${PATH+:$PATH}"
+          python -m tox p
+
+      - name: Release PyPi package
+        run: |
+          python -m tox r -e pypi-upload
+        shell: bash
+        if: matrix.os == 'ubuntu-22.04'
+
+      - name: Get release name
+        shell: bash
+        run: |
+          git fetch --depth=1 origin +refs/tags/*:refs/tags/* # github is dumb
+          echo "release_name=$(git tag -l --format "%(refname:strip=2): %(contents:lines=1)" ${{ github.ref_name }})" >> $GITHUB_ENV
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          name: "${{ env.release_name }}"
+          prerelease: "${{ contains(github.ref, '-') }}" # alpha-releases should be 1.3.0-alpha.x full releases should be 1.3.0
+          draft: false
+          # upload the single application zip file for each OS and include the wheel built on linux
+          files: |
+            dist/binary/*.zip
+            dist/binary/*.tar.gz
+            dist/binary/*.dmg
+            dist/binary/*.AppImage
+            dist/*${{ fromJSON('["never", ""]')[matrix.os == 'ubuntu-22.04'] }}.whl

.gitignore

@@ -0,0 +1,160 @@
+# generated by setuptools_scm
+ctversion.py
+
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion
+
+*.iml
+
+## Directory-based project format:
+.idea/
+
+### Other editors
+.*.swp
+nbproject/
+.vscode
+
+comictaggerlib/_version.py
+*.exe
+*.zip
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# for testing
+temp/

.mailmap

@@ -0,0 +1,9 @@
+Andrew W. Buchanan <buchanan@difference.com>
+Davide Romanini <d.romanini@cineca.it> <davide.romanini@gmail.com>
+Davide Romanini <d.romanini@cineca.it> <user159033@92-63-141-211.rdns.melbourne.co.uk>
+Michael Fitzurka <MichaelFitzurka@users.noreply.github.com> <MichaelFitzurka@github.com>
+Timmy Welch <timmy@narnian.us>
+beville <beville@users.noreply.github.com> <(no author)@6c5673fe-1810-88d6-992b-cd32ca31540c>
+beville <beville@users.noreply.github.com> <beville@6c5673fe-1810-88d6-992b-cd32ca31540c>
+beville <beville@users.noreply.github.com> <beville@gmail.com@6c5673fe-1810-88d6-992b-cd32ca31540c>
+beville <beville@users.noreply.github.com> <beville@users.noreply.github.com>

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+exclude: ^(scripts|comictaggerlib/graphics/resources.py)
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: name-tests-test
+    -   id: requirements-txt-fixer
+-   repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v2.8.0
+    hooks:
+    -   id: setup-cfg-fmt
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.19.1
+    hooks:
+    -   id: pyupgrade
+        args: [--py39-plus]
+-   repo: https://github.com/PyCQA/autoflake
+    rev: v2.3.1
+    hooks:
+    -   id: autoflake
+        args: [-i, --remove-all-unused-imports, --ignore-init-module-imports]
+-   repo: https://github.com/PyCQA/isort
+    rev: 6.0.1
+    hooks:
+    -   id: isort
+        args: [--af,--add-import, 'from __future__ import annotations']
+-   repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/PyCQA/flake8
+    rev: 7.2.0
+    hooks:
+    -   id: flake8
+        additional_dependencies: [flake8-encodings, flake8-builtins, flake8-print, flake8-no-nested-comprehensions]
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+    -   id: mypy
+        additional_dependencies: [types-setuptools, types-requests, settngs>=0.10.4, pillow>=9.1.0]
+ci:
+    skip: [mypy]

AUTHORS

@@ -0,0 +1,23 @@
+beville <beville@users.noreply.github.com>
+Davide Romanini <d.romanini@cineca.it>
+fcanc <f.canc@icloud.com>
+Alban Seurat <alkpone@alkpone.com>
+tlc <tlc@users.noreply.github.com>
+Marek Pawlak <francuz14@gmail.com>
+Timmy Welch <timmy@narnian.us>
+J.P. Cranford <philipcranford4@gmail.com>
+thFrgttn <39759781+thFrgttn@users.noreply.github.com>
+Andrew W. Buchanan <buchanan@difference.com>
+Michael Fitzurka <MichaelFitzurka@users.noreply.github.com>
+Richard Haussmann <richard.haussmann@gmail.com>
+Mizaki <jinxybob@hotmail.com>
+Xavier Jouvenot <x.jouvenot@gmail.com>
+github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
+Ben Longman <deck@steamdeck.lan>
+Sven Hesse <drmccoy@drmccoy.de>
+pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
+kcgthb <kcgthb@users.noreply.github.com>
+Kilian Cavalotti <kcgthb@users.noreply.github.com>
+David Bugl <david.bugl@gmx.at>
+HSN <64664577+N-Hertstein@users.noreply.github.com>
+Emmanuel Ferdman <emmanuelferdman@gmail.com>

CONTRIBUTING.md

@@ -0,0 +1,98 @@
+# How to contribute
+
+If your not sure what you can do or you need to ask a question or just want to talk about ComicTagger head over to the [discussions tab](https://github.com/comictagger/comictagger/discussions/categories/general) and start a discussion
+
+## Tests
+
+We have tests written using pytest! Some of them even pass! If you are contributing code any tests you can write are appreciated.
+
+A great place to start is extending the tests that are already made.
+
+For example the file tests/filenames.py has lists of filenames to be parsed in the format:
+```py
+    pytest.param(
+        "Star Wars - War of the Bounty Hunters - IG-88 (2021) (Digital) (Kileko-Empire).cbz",
+        "number ends series, no-issue",
+        {
+            "issue": "",
+            "series": "Star Wars - War of the Bounty Hunters - IG-88",
+            "volume": "",
+            "year": "2021",
+            "remainder": "(Digital) (Kileko-Empire)",
+            "issue_count": "",
+        },
+        marks=pytest.mark.xfail,
+    )
+```
+
+A test consists of 3-4 parts
+1. The filename to be parsed
+2. The reason it might fail
+3. What the result of parsing the filename should be
+4. `marks=pytest.mark.xfail` This marks the test as expected to fail
+
+If you are not comfortable creating a pull request you can [open an issue](https://github.com/comictagger/comictagger/issues/new/choose) or [start a discussion](https://github.com/comictagger/comictagger/discussions/new)
+
+## Submitting changes
+
+Please open a [GitHub Pull Request](https://github.com/comictagger/comictagger/pull/new/develop) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). When you send a pull request, we will love you forever if you include tests. We can always use more test coverage. Please run the code tools below and make sure all of your commits are atomic (one feature per commit).
+
+## Contributing Code
+
+Currently only python 3.9 is supported however 3.10 will probably work if you try it
+
+Those on linux should install `Pillow` from the system package manager if possible and if the GUI `PyQt6` should be installed from the system package manager
+
+Those on macOS will need to ensure that you are using python3 in x86 mode either by installing an x86 only version of python or using the universal installer and using `python3-intel64` instead of `python3`
+
+1. Clone the repository
+```
+git clone https://github.com/comictagger/comictagger.git
+```
+
+2. It is preferred to use a virtual env for running from source:
+
+```
+python3 -m venv venv
+```
+
+3. Activate the virtual env:
+```
+. venv/bin/activate
+```
+or if on windows PowerShell
+```
+. venv/bin/activate.ps1
+```
+
+4. Install tox:
+```bash
+pip install tox
+```
+
+5. If you are on an M1 Mac you will need to export two environment variables for tests to pass.
+```
+export tox_python=python3.9-intel64
+export tox_env=m1env
+```
+
+6. install ComicTagger
+```
+tox run -e venv
+```
+
+7. Make your changes
+8. Build to ensure that your changes work: this will produce a binary build in the dist folder
+```bash
+tox run -m build
+```
+
+The build runs these formatters and linters automatically
+
+setup-cfg-fmt: Formats the setup.cfg file
+autoflake: Removes unused imports
+isort: sorts imports so that you can always find where an import is located<br>
+black: formats all of the code consistently so there are no surprises<br>
+flake8: checks for code quality and style (warns for unused imports and similar issues)<br>
+mypy: checks the types of variables and functions to catch errors
+pytest: runs tests for ComicTagger functionality

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

Makefile

@@ -1,25 +0,0 @@
-TAGGER_BASE := $(HOME)/Dropbox/tagger/comictagger
-VERSION_STR := $(shell grep version $(TAGGER_BASE)/ctversion.py| cut -d= -f2 | sed 's/\"//g')
-
-all: clean
-
-clean:
-	rm -f *~ *.pyc *.pyo
-	rm -f logdict*.log
-	make -C mac clean
-	make -C windows clean
-
-zip:
-	cd release; \
-		rm -rf *zip comictagger-src-$(VERSION_STR) ;  \
-		svn export https://comictagger.googlecode.com/svn/trunk/ comictagger-src-$(VERSION_STR); \
-		zip -r comictagger-src-$(VERSION_STR).zip comictagger-src-$(VERSION_STR); \
-		rm -rf comictagger-src-$(VERSION_STR)
-	
-	@echo When satisfied with release, do this:
-	@echo make svn_tag
-	
-svn_tag:
-	svn copy https://comictagger.googlecode.com/svn/trunk \
-      https://comictagger.googlecode.com/svn/tags/$(VERSION_STR) -m "Release $(VERSION_STR)"
-	

README.md

@@ -0,0 +1,221 @@
+[![CI](https://github.com/comictagger/comictagger/actions/workflows/build.yaml/badge.svg?branch=develop&event=push)](https://github.com/comictagger/comictagger/actions/workflows/build.yaml)
+[![GitHub release (latest by date)](https://img.shields.io/github/downloads/comictagger/comictagger/latest/total)](https://github.com/comictagger/comictagger/releases/latest)
+[![PyPI](https://img.shields.io/pypi/v/comictagger)](https://pypi.org/project/comictagger/)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/comictagger)](https://pypistats.org/packages/comictagger)
+[![Chocolatey package](https://img.shields.io/chocolatey/dt/comictagger?color=blue&label=chocolatey)](https://community.chocolatey.org/packages/comictagger)
+[![WinGet](https://img.shields.io/winget/v/ComicTagger.ComicTagger)](https://github.com/microsoft/winget-pkgs/tree/master/manifests/c/ComicTagger/ComicTagger)
+[![PyPI - License](https://img.shields.io/pypi/l/comictagger)](https://opensource.org/licenses/Apache-2.0)
+
+[![GitHub Discussions](https://img.shields.io/github/discussions/comictagger/comictagger)](https://github.com/comictagger/comictagger/discussions)
+[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/comictagger/community)
+[![Google Group](https://img.shields.io/badge/discuss-on%20groups-%23207de5)](https://groups.google.com/forum/#!forum/comictagger)
+[![Twitter](https://img.shields.io/badge/%40comictagger-twitter-lightgrey)](https://twitter.com/comictagger)
+[![Facebook](https://img.shields.io/badge/comictagger-facebook-lightgrey)](https://www.facebook.com/ComicTagger-139615369550787/)
+
+# ComicTagger
+
+ComicTagger is a **multi-platform** app for **writing metadata to digital comics**, written in Python and PyQt.
+
+![ComicTagger logo](https://raw.githubusercontent.com/comictagger/comictagger/develop/comictaggerlib/graphics/app.png)
+
+## Features
+
+* Runs on macOS, Microsoft Windows, and Linux systems
+* Get comic information from [Comic Vine](https://comicvine.gamespot.com/)
+* **Automatic issue matching** using advanced image processing techniques
+* **Batch processing** in the GUI for tagging hundreds or more comics at a time
+* Support for **ComicRack** and **ComicBookLover** tagging formats
+* Native full support for **CBZ** digital comics
+* Native read only support for **CBR** digital comics: full support enabled installing additional [rar tools](https://www.rarlab.com/download.htm)
+* Command line interface (CLI) enabling **custom scripting** and **batch operations on large collections**
+
+For details, screen-shots, and more, visit [the Wiki](https://github.com/comictagger/comictagger/wiki)
+
+
+## Installation
+
+### Binaries
+
+Windows, Linux and MacOS binaries are provided in the [Releases Page](https://github.com/comictagger/comictagger/releases).
+
+Just unzip the archive in any folder and run, no additional installation steps are required.
+
+### PIP installation
+
+A pip package is provided, you can install it with:
+
+```
+ $ pip3 install comictagger[GUI]
+```
+
+There are optional dependencies. You can install the optional dependencies by specifying one or more of them in braces e.g. `comictagger[CBR,GUI]`
+
+Optional dependencies:
+1. `ICU`: Ensures that comic pages are supported correctly. This should always be installed. *Currently only exists in the latest alpha release *
+1. `CBR`: Provides support for CBR/RAR files.
+1. `GUI`: Installs the GUI.
+1. `7Z`: Provides support for CB7/7Z files.
+1. `all`: Installs all of the above optional dependencies.
+
+### Chocolatey installation (Windows only)
+
+A [Chocolatey package](https://community.chocolatey.org/packages/comictagger), maintained by @Xav83, is provided, you can install it with:
+```powershell
+choco install comictagger
+```
+### WinGet installation (Windows only)
+
+A [WinGet package](https://github.com/microsoft/winget-pkgs/tree/master/manifests/c/ComicTagger/ComicTagger), maintained by @Sn1cket, is provided, you can install it with:
+```powershell
+winget install ComicTagger.ComicTagger
+```
+### From source
+
+ 1. Ensure you have python 3.9 installed
+ 2. Clone this repository `git clone https://github.com/comictagger/comictagger.git`
+ 7. `pip3 install .[ICU]` or `pip3 install .[GUI,ICU]`
+
+
+## Contributors
+
+<!-- readme: beville,davide-romanini,collaborators,contributors -start -->
+<table>
+<tr>
+    <td align="center">
+        <a href="https://github.com/beville">
+            <img src="https://avatars.githubusercontent.com/u/7294848?v=4" width="100;" alt="beville"/>
+            <br />
+            <sub><b>beville</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/davide-romanini">
+            <img src="https://avatars.githubusercontent.com/u/731199?v=4" width="100;" alt="davide-romanini"/>
+            <br />
+            <sub><b>davide-romanini</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/fcanc">
+            <img src="https://avatars.githubusercontent.com/u/4999486?v=4" width="100;" alt="fcanc"/>
+            <br />
+            <sub><b>fcanc</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/lordwelch">
+            <img src="https://avatars.githubusercontent.com/u/7547075?v=4" width="100;" alt="lordwelch"/>
+            <br />
+            <sub><b>lordwelch</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/mizaki">
+            <img src="https://avatars.githubusercontent.com/u/1141189?v=4" width="100;" alt="mizaki"/>
+            <br />
+            <sub><b>mizaki</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/MichaelFitzurka">
+            <img src="https://avatars.githubusercontent.com/u/27830765?v=4" width="100;" alt="MichaelFitzurka"/>
+            <br />
+            <sub><b>MichaelFitzurka</b></sub>
+        </a>
+    </td></tr>
+<tr>
+    <td align="center">
+        <a href="https://github.com/abuchanan920">
+            <img src="https://avatars.githubusercontent.com/u/368793?v=4" width="100;" alt="abuchanan920"/>
+            <br />
+            <sub><b>abuchanan920</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/N-Hertstein">
+            <img src="https://avatars.githubusercontent.com/u/64664577?v=4" width="100;" alt="N-Hertstein"/>
+            <br />
+            <sub><b>N-Hertstein</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/kcgthb">
+            <img src="https://avatars.githubusercontent.com/u/186807?v=4" width="100;" alt="kcgthb"/>
+            <br />
+            <sub><b>kcgthb</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/rhaussmann">
+            <img src="https://avatars.githubusercontent.com/u/7084007?v=4" width="100;" alt="rhaussmann"/>
+            <br />
+            <sub><b>rhaussmann</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/AlbanSeurat">
+            <img src="https://avatars.githubusercontent.com/u/500180?v=4" width="100;" alt="AlbanSeurat"/>
+            <br />
+            <sub><b>AlbanSeurat</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/Sn1cket">
+            <img src="https://avatars.githubusercontent.com/u/32904645?v=4" width="100;" alt="Sn1cket"/>
+            <br />
+            <sub><b>Sn1cket</b></sub>
+        </a>
+    </td></tr>
+<tr>
+    <td align="center">
+        <a href="https://github.com/emmanuel-ferdman">
+            <img src="https://avatars.githubusercontent.com/u/35470921?v=4" width="100;" alt="emmanuel-ferdman"/>
+            <br />
+            <sub><b>emmanuel-ferdman</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/jpcranford">
+            <img src="https://avatars.githubusercontent.com/u/21347202?v=4" width="100;" alt="jpcranford"/>
+            <br />
+            <sub><b>jpcranford</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/PawlakMarek">
+            <img src="https://avatars.githubusercontent.com/u/26022173?v=4" width="100;" alt="PawlakMarek"/>
+            <br />
+            <sub><b>PawlakMarek</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/DrMcCoy">
+            <img src="https://avatars.githubusercontent.com/u/156130?v=4" width="100;" alt="DrMcCoy"/>
+            <br />
+            <sub><b>DrMcCoy</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/Xav83">
+            <img src="https://avatars.githubusercontent.com/u/6787157?v=4" width="100;" alt="Xav83"/>
+            <br />
+            <sub><b>Xav83</b></sub>
+        </a>
+    </td>
+    <td align="center">
+        <a href="https://github.com/thFrgttn">
+            <img src="https://avatars.githubusercontent.com/u/39759781?v=4" width="100;" alt="thFrgttn"/>
+            <br />
+            <sub><b>thFrgttn</b></sub>
+        </a>
+    </td></tr>
+<tr>
+    <td align="center">
+        <a href="https://github.com/tlc">
+            <img src="https://avatars.githubusercontent.com/u/19436?v=4" width="100;" alt="tlc"/>
+            <br />
+            <sub><b>tlc</b></sub>
+        </a>
+    </td></tr>
+</table>
+<!-- readme: beville,davide-romanini,collaborators,contributors -end -->

UnRAR2/UnRARDLL/license.txt

@@ -1,18 +0,0 @@
-      The unrar.dll library is freeware. This means:
-
-   1. All copyrights to RAR and the unrar.dll are exclusively
-      owned by the author - Alexander Roshal.
-
-   2. The unrar.dll library may be used in any software to handle RAR
-      archives without limitations free of charge.
-
-   3. THE RAR ARCHIVER AND THE UNRAR.DLL LIBRARY ARE DISTRIBUTED "AS IS".
-      NO WARRANTY OF ANY KIND IS EXPRESSED OR IMPLIED.  YOU USE AT 
-      YOUR OWN RISK. THE AUTHOR WILL NOT BE LIABLE FOR DATA LOSS, 
-      DAMAGES, LOSS OF PROFITS OR ANY OTHER KIND OF LOSS WHILE USING
-      OR MISUSING THIS SOFTWARE.
-
-      Thank you for your interest in RAR and unrar.dll.
-
-
-                                            Alexander L. Roshal

UnRAR2/UnRARDLL/unrar.h

@@ -1,140 +0,0 @@
-#ifndef _UNRAR_DLL_
-#define _UNRAR_DLL_
-
-#define ERAR_END_ARCHIVE        10
-#define ERAR_NO_MEMORY          11
-#define ERAR_BAD_DATA           12
-#define ERAR_BAD_ARCHIVE        13
-#define ERAR_UNKNOWN_FORMAT     14
-#define ERAR_EOPEN              15
-#define ERAR_ECREATE            16
-#define ERAR_ECLOSE             17
-#define ERAR_EREAD              18
-#define ERAR_EWRITE             19
-#define ERAR_SMALL_BUF          20
-#define ERAR_UNKNOWN            21
-#define ERAR_MISSING_PASSWORD   22
-
-#define RAR_OM_LIST              0
-#define RAR_OM_EXTRACT           1
-#define RAR_OM_LIST_INCSPLIT     2
-
-#define RAR_SKIP              0
-#define RAR_TEST              1
-#define RAR_EXTRACT           2
-
-#define RAR_VOL_ASK           0
-#define RAR_VOL_NOTIFY        1
-
-#define RAR_DLL_VERSION       4
-
-#ifdef _UNIX
-#define CALLBACK
-#define PASCAL
-#define LONG long
-#define HANDLE void *
-#define LPARAM long
-#define UINT unsigned int
-#endif
-
-struct RARHeaderData
-{
-  char         ArcName[260];
-  char         FileName[260];
-  unsigned int Flags;
-  unsigned int PackSize;
-  unsigned int UnpSize;
-  unsigned int HostOS;
-  unsigned int FileCRC;
-  unsigned int FileTime;
-  unsigned int UnpVer;
-  unsigned int Method;
-  unsigned int FileAttr;
-  char         *CmtBuf;
-  unsigned int CmtBufSize;
-  unsigned int CmtSize;
-  unsigned int CmtState;
-};
-
-
-struct RARHeaderDataEx
-{
-  char         ArcName[1024];
-  wchar_t      ArcNameW[1024];
-  char         FileName[1024];
-  wchar_t      FileNameW[1024];
-  unsigned int Flags;
-  unsigned int PackSize;
-  unsigned int PackSizeHigh;
-  unsigned int UnpSize;
-  unsigned int UnpSizeHigh;
-  unsigned int HostOS;
-  unsigned int FileCRC;
-  unsigned int FileTime;
-  unsigned int UnpVer;
-  unsigned int Method;
-  unsigned int FileAttr;
-  char         *CmtBuf;
-  unsigned int CmtBufSize;
-  unsigned int CmtSize;
-  unsigned int CmtState;
-  unsigned int Reserved[1024];
-};
-
-
-struct RAROpenArchiveData
-{
-  char         *ArcName;
-  unsigned int OpenMode;
-  unsigned int OpenResult;
-  char         *CmtBuf;
-  unsigned int CmtBufSize;
-  unsigned int CmtSize;
-  unsigned int CmtState;
-};
-
-struct RAROpenArchiveDataEx
-{
-  char         *ArcName;
-  wchar_t      *ArcNameW;
-  unsigned int OpenMode;
-  unsigned int OpenResult;
-  char         *CmtBuf;
-  unsigned int CmtBufSize;
-  unsigned int CmtSize;
-  unsigned int CmtState;
-  unsigned int Flags;
-  unsigned int Reserved[32];
-};
-
-enum UNRARCALLBACK_MESSAGES {
-  UCM_CHANGEVOLUME,UCM_PROCESSDATA,UCM_NEEDPASSWORD
-};
-
-typedef int (CALLBACK *UNRARCALLBACK)(UINT msg,LPARAM UserData,LPARAM P1,LPARAM P2);
-
-typedef int (PASCAL *CHANGEVOLPROC)(char *ArcName,int Mode);
-typedef int (PASCAL *PROCESSDATAPROC)(unsigned char *Addr,int Size);
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-HANDLE PASCAL RAROpenArchive(struct RAROpenArchiveData *ArchiveData);
-HANDLE PASCAL RAROpenArchiveEx(struct RAROpenArchiveDataEx *ArchiveData);
-int    PASCAL RARCloseArchive(HANDLE hArcData);
-int    PASCAL RARReadHeader(HANDLE hArcData,struct RARHeaderData *HeaderData);
-int    PASCAL RARReadHeaderEx(HANDLE hArcData,struct RARHeaderDataEx *HeaderData);
-int    PASCAL RARProcessFile(HANDLE hArcData,int Operation,char *DestPath,char *DestName);
-int    PASCAL RARProcessFileW(HANDLE hArcData,int Operation,wchar_t *DestPath,wchar_t *DestName);
-void   PASCAL RARSetCallback(HANDLE hArcData,UNRARCALLBACK Callback,LPARAM UserData);
-void   PASCAL RARSetChangeVolProc(HANDLE hArcData,CHANGEVOLPROC ChangeVolProc);
-void   PASCAL RARSetProcessDataProc(HANDLE hArcData,PROCESSDATAPROC ProcessDataProc);
-void   PASCAL RARSetPassword(HANDLE hArcData,char *Password);
-int    PASCAL RARGetDllVersion();
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif

UnRAR2/UnRARDLL/unrardll.txt

@@ -1,606 +0,0 @@
-
-    UnRAR.dll Manual
-    ~~~~~~~~~~~~~~~~
-
-    UnRAR.dll is a 32-bit Windows dynamic-link library which provides
- file extraction from RAR archives.
-
-
-    Exported functions
-
-====================================================================
-HANDLE PASCAL RAROpenArchive(struct RAROpenArchiveData *ArchiveData)
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Open RAR archive and allocate memory structures
-
-Parameters
-~~~~~~~~~~
-ArchiveData       Points to RAROpenArchiveData structure
-
-struct RAROpenArchiveData
-{
-  char *ArcName;
-  UINT OpenMode;
-  UINT OpenResult;
-  char *CmtBuf;
-  UINT CmtBufSize;
-  UINT CmtSize;
-  UINT CmtState;
-};
-
-Structure fields:
-
-ArcName
-  Input parameter which should point to zero terminated string 
-  containing the archive name. 
-
-OpenMode
-  Input parameter.
-
-  Possible values
-
-  RAR_OM_LIST
-    Open archive for reading file headers only.
-
-  RAR_OM_EXTRACT
-    Open archive for testing and extracting files.
-
-  RAR_OM_LIST_INCSPLIT
-    Open archive for reading file headers only. If you open an archive
-    in such mode, RARReadHeader[Ex] will return all file headers,
-    including those with "file continued from previous volume" flag.
-    In case of RAR_OM_LIST such headers are automatically skipped.
-    So if you process RAR volumes in RAR_OM_LIST_INCSPLIT mode, you will
-    get several file header records for same file if file is split between
-    volumes. For such files only the last file header record will contain
-    the correct file CRC and if you wish to get the correct packed size,
-    you need to sum up packed sizes of all parts.
-
-OpenResult
-  Output parameter.
-
-  Possible values
-
-  0                     Success
-  ERAR_NO_MEMORY        Not enough memory to initialize data structures
-  ERAR_BAD_DATA         Archive header broken
-  ERAR_BAD_ARCHIVE      File is not valid RAR archive
-  ERAR_UNKNOWN_FORMAT   Unknown encryption used for archive headers
-  ERAR_EOPEN            File open error
-
-CmtBuf
-  Input parameter which should point to the buffer for archive 
-  comments. Maximum comment size is limited to 64Kb. Comment text is 
-  zero terminated. If the comment text is larger than the buffer 
-  size, the comment text will be truncated. If CmtBuf is set to 
-  NULL, comments will not be read. 
-
-CmtBufSize
-  Input parameter which should contain size of buffer for archive
-  comments.
-
-CmtSize
-  Output parameter containing size of comments actually read into the
-  buffer, cannot exceed CmtBufSize.
-
-CmtState
-  Output parameter.
-
-  Possible values
-
-  0                     comments not present
-  1                     Comments read completely
-  ERAR_NO_MEMORY        Not enough memory to extract comments
-  ERAR_BAD_DATA         Broken comment
-  ERAR_UNKNOWN_FORMAT   Unknown comment format
-  ERAR_SMALL_BUF        Buffer too small, comments not completely read
-
-Return values
-~~~~~~~~~~~~~
-  Archive handle or NULL in case of error
-
-
-========================================================================
-HANDLE PASCAL RAROpenArchiveEx(struct RAROpenArchiveDataEx *ArchiveData)
-========================================================================
-
-Description
-~~~~~~~~~~~
-  Similar to RAROpenArchive, but uses RAROpenArchiveDataEx structure
-  allowing to specify Unicode archive name and returning information
-  about archive flags.
-
-Parameters
-~~~~~~~~~~
-ArchiveData       Points to RAROpenArchiveDataEx structure
-
-struct RAROpenArchiveDataEx
-{
-  char         *ArcName;
-  wchar_t      *ArcNameW;
-  unsigned int OpenMode;
-  unsigned int OpenResult;
-  char         *CmtBuf;
-  unsigned int CmtBufSize;
-  unsigned int CmtSize;
-  unsigned int CmtState;
-  unsigned int Flags;
-  unsigned int Reserved[32];
-};
-
-Structure fields:
-
-ArcNameW
-  Input parameter which should point to zero terminated Unicode string
-  containing the archive name or NULL if Unicode name is not specified.
-
-Flags
-  Output parameter. Combination of bit flags.
-
-  Possible values
-
-    0x0001  - Volume attribute (archive volume)
-    0x0002  - Archive comment present
-    0x0004  - Archive lock attribute
-    0x0008  - Solid attribute (solid archive)
-    0x0010  - New volume naming scheme ('volname.partN.rar')
-    0x0020  - Authenticity information present
-    0x0040  - Recovery record present
-    0x0080  - Block headers are encrypted
-    0x0100  - First volume (set only by RAR 3.0 and later)
-
-Reserved[32]
-  Reserved for future use. Must be zero.
-
-Information on other structure fields and function return values
-is available above, in RAROpenArchive function description.
-
-
-====================================================================
-int PASCAL RARCloseArchive(HANDLE hArcData)
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Close RAR archive and release allocated memory. It must be called when
-  archive processing is finished, even if the archive processing was stopped
-  due to an error.
-
-Parameters
-~~~~~~~~~~
-hArcData
-  This parameter should contain the archive handle obtained from the
-  RAROpenArchive function call.
-
-Return values
-~~~~~~~~~~~~~
-  0                     Success
-  ERAR_ECLOSE           Archive close error
-
-
-====================================================================
-int PASCAL RARReadHeader(HANDLE hArcData,
-                         struct RARHeaderData *HeaderData)
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Read header of file in archive.
-
-Parameters
-~~~~~~~~~~
-hArcData
-  This parameter should contain the archive handle obtained from the
-  RAROpenArchive function call.
-
-HeaderData
-  It should point to RARHeaderData structure:
-
-struct RARHeaderData
-{
-  char ArcName[260];
-  char FileName[260];
-  UINT Flags;
-  UINT PackSize;
-  UINT UnpSize;
-  UINT HostOS;
-  UINT FileCRC;
-  UINT FileTime;
-  UINT UnpVer;
-  UINT Method;
-  UINT FileAttr;
-  char *CmtBuf;
-  UINT CmtBufSize;
-  UINT CmtSize;
-  UINT CmtState;
-};
-
-Structure fields:
-
-ArcName
-  Output parameter which contains a zero terminated string of the
-  current archive name.  May be used to determine the current volume 
-  name. 
-
-FileName
-  Output parameter which contains a zero terminated string of the 
-  file name in OEM (DOS) encoding.
-
-Flags
-  Output parameter which contains file flags:
-
-  0x01 - file continued from previous volume
-  0x02 - file continued on next volume
-  0x04 - file encrypted with password
-  0x08 - file comment present
-  0x10 - compression of previous files is used (solid flag)
-
-  bits 7 6 5
-
-       0 0 0    - dictionary size   64 Kb
-       0 0 1    - dictionary size  128 Kb
-       0 1 0    - dictionary size  256 Kb
-       0 1 1    - dictionary size  512 Kb
-       1 0 0    - dictionary size 1024 Kb
-       1 0 1    - dictionary size 2048 KB
-       1 1 0    - dictionary size 4096 KB
-       1 1 1    - file is directory
-
-  Other bits are reserved.
-
-PackSize
-  Output parameter means packed file size or size of the
-  file part if file was split between volumes.
-
-UnpSize
-  Output parameter - unpacked file size.
-
-HostOS
-  Output parameter - operating system used for archiving:
-
-  0 - MS DOS;
-  1 - OS/2.
-  2 - Win32
-  3 - Unix
-
-FileCRC
-  Output parameter which contains unpacked file CRC. In case of file parts
-  split between volumes only the last part contains the correct CRC
-  and it is accessible only in RAR_OM_LIST_INCSPLIT listing mode.
-
-FileTime
-  Output parameter - contains date and time in standard MS DOS format.
-
-UnpVer
-  Output parameter - RAR version needed to extract file.
-  It is encoded as 10 * Major version + minor version.
-
-Method
-  Output parameter - packing method.
-
-FileAttr
-  Output parameter - file attributes.
-
-CmtBuf
-  File comments support is not implemented in the new DLL version yet.
-  Now CmtState is always 0.
-
-/*
- * Input parameter which should point to the buffer for file
- * comments. Maximum comment size is limited to 64Kb. Comment text is 
- * a zero terminated string in OEM encoding. If the comment text is
- * larger than the buffer size, the comment text will be truncated.
- * If CmtBuf is set to NULL, comments will not be read. 
- */
-
-CmtBufSize
-  Input parameter which should contain size of buffer for archive
-  comments.
-
-CmtSize
-  Output parameter containing size of comments actually read into the
-  buffer, should not exceed CmtBufSize.
-
-CmtState
-  Output parameter.
-
-  Possible values
-
-  0                     Absent comments
-  1                     Comments read completely
-  ERAR_NO_MEMORY        Not enough memory to extract comments
-  ERAR_BAD_DATA         Broken comment
-  ERAR_UNKNOWN_FORMAT   Unknown comment format
-  ERAR_SMALL_BUF        Buffer too small, comments not completely read
-
-Return values
-~~~~~~~~~~~~~
-
-  0                     Success
-  ERAR_END_ARCHIVE      End of archive
-  ERAR_BAD_DATA         File header broken
-
-
-====================================================================
-int PASCAL RARReadHeaderEx(HANDLE hArcData,
-                           struct RARHeaderDataEx *HeaderData)
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Similar to RARReadHeader, but uses RARHeaderDataEx structure,
-containing information about Unicode file names and 64 bit file sizes.
-
-struct RARHeaderDataEx
-{
-  char         ArcName[1024];
-  wchar_t      ArcNameW[1024];
-  char         FileName[1024];
-  wchar_t      FileNameW[1024];
-  unsigned int Flags;
-  unsigned int PackSize;
-  unsigned int PackSizeHigh;
-  unsigned int UnpSize;
-  unsigned int UnpSizeHigh;
-  unsigned int HostOS;
-  unsigned int FileCRC;
-  unsigned int FileTime;
-  unsigned int UnpVer;
-  unsigned int Method;
-  unsigned int FileAttr;
-  char         *CmtBuf;
-  unsigned int CmtBufSize;
-  unsigned int CmtSize;
-  unsigned int CmtState;
-  unsigned int Reserved[1024];
-};
-
-
-====================================================================
-int PASCAL RARProcessFile(HANDLE hArcData,
-                          int Operation,
-                          char *DestPath,
-                          char *DestName)
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Performs action and moves the current position in the archive to 
-  the next file. Extract or test the current file from the archive 
-  opened in RAR_OM_EXTRACT mode. If the mode RAR_OM_LIST is set, 
-  then a call to this function will simply skip the archive position 
-  to the next file. 
-
-Parameters
-~~~~~~~~~~
-hArcData
-  This parameter should contain the archive handle obtained from the
-  RAROpenArchive function call.
-
-Operation
-  File operation.
-
-  Possible values
-
-  RAR_SKIP              Move to the next file in the archive. If the 
-                        archive is solid and RAR_OM_EXTRACT mode was set 
-                        when the archive was opened, the current file will 
-                        be processed - the operation will be performed 
-                        slower than a simple seek. 
-
-  RAR_TEST              Test the current file and move to the next file in 
-                        the archive. If the archive was opened with 
-                        RAR_OM_LIST mode, the operation is equal to 
-                        RAR_SKIP. 
-
-  RAR_EXTRACT           Extract the current file and move to the next file.
-                        If the archive was opened with RAR_OM_LIST mode,
-                        the operation is equal to RAR_SKIP.
-
-
-DestPath
-  This parameter should point to a zero terminated string containing the 
-  destination directory to which to extract files to. If DestPath is equal 
-  to NULL, it means extract to the current directory. This parameter has 
-  meaning only if DestName is NULL. 
-
-DestName
-  This parameter should point to a string containing the full path and name
-  to assign to extracted file or it can be NULL to use the default name.
-  If DestName is defined (not NULL), it overrides both the original file
-  name saved in the archive and path specigied in DestPath setting. 
-
-  Both DestPath and DestName must be in OEM encoding. If necessary,
-  use CharToOem to convert text to OEM before passing to this function.
-
-Return values
-~~~~~~~~~~~~~
-  0                     Success
-  ERAR_BAD_DATA         File CRC error
-  ERAR_BAD_ARCHIVE      Volume is not valid RAR archive
-  ERAR_UNKNOWN_FORMAT   Unknown archive format
-  ERAR_EOPEN            Volume open error
-  ERAR_ECREATE          File create error
-  ERAR_ECLOSE           File close error
-  ERAR_EREAD            Read error
-  ERAR_EWRITE           Write error
-
-
-Note: if you wish to cancel extraction, return -1 when processing
-      UCM_PROCESSDATA callback message.
-
-
-====================================================================
-int PASCAL RARProcessFileW(HANDLE hArcData,
-                           int Operation,
-                           wchar_t *DestPath,
-                           wchar_t *DestName)
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Unicode version of RARProcessFile. It uses Unicode DestPath
-  and DestName parameters, other parameters and return values
-  are the same as in RARProcessFile.
-
-
-====================================================================
-void PASCAL RARSetCallback(HANDLE hArcData,
-            int PASCAL (*CallbackProc)(UINT msg,LPARAM UserData,LPARAM P1,LPARAM P2),
-            LPARAM UserData);
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Set a user-defined callback function to process Unrar events.
-
-Parameters
-~~~~~~~~~~
-hArcData
-  This parameter should contain the archive handle obtained from the
-  RAROpenArchive function call.
-
-CallbackProc
-  It should point to a user-defined callback function.
-
-  The function will be passed four parameters:
-
-
-  msg                    Type of event. Described below.
-
-  UserData               User defined value passed to RARSetCallback.
-
-  P1 and P2              Event dependent parameters. Described below.
-
-
-  Possible events
-
-    UCM_CHANGEVOLUME     Process volume change.
-
-      P1                   Points to the zero terminated name
-                           of the next volume.
-
-      P2                   The function call mode:
-
-        RAR_VOL_ASK          Required volume is absent. The function should
-                             prompt user and return a positive value
-                             to retry or return -1 value to terminate 
-                             operation. The function may also specify a new 
-                             volume name, placing it to the address specified
-                             by P1 parameter. 
-
-        RAR_VOL_NOTIFY       Required volume is successfully opened.
-                             This is a notification call and volume name
-                             modification is not allowed. The function should 
-                             return a positive value to continue or -1
-                             to terminate operation. 
-
-    UCM_PROCESSDATA          Process unpacked data. It may be used to read
-                             a file while it is being extracted or tested
-                             without actual extracting file to disk.
-                             Return a positive value to continue process
-                             or -1 to cancel the archive operation
-
-      P1                   Address pointing to the unpacked data.
-                           Function may refer to the data but must not
-                           change it.
-
-      P2                   Size of the unpacked data. It is guaranteed
-                           only that the size will not exceed the maximum
-                           dictionary size (4 Mb in RAR 3.0).
-
-    UCM_NEEDPASSWORD         DLL needs a password to process archive.
-                             This message must be processed if you wish
-                             to be able to handle archives with encrypted
-                             file names. It can be also used as replacement
-                             of RARSetPassword function even for usual
-                             encrypted files with non-encrypted names.
-
-      P1                   Address pointing to the buffer for a password.
-                           You need to copy a password here.
-
-      P2                   Size of the password buffer.
-
-
-UserData
-  User data passed to callback function.
-
-  Other functions of UnRAR.dll should not be called from the callback
-  function.
-
-Return values
-~~~~~~~~~~~~~
-  None
-
-
-
-====================================================================
-void PASCAL RARSetChangeVolProc(HANDLE hArcData,
-            int PASCAL (*ChangeVolProc)(char *ArcName,int Mode));
-====================================================================
-
-Obsoleted, use RARSetCallback instead.
-
-
-
-====================================================================
-void PASCAL RARSetProcessDataProc(HANDLE hArcData,
-            int PASCAL (*ProcessDataProc)(unsigned char *Addr,int Size))
-====================================================================
-
-Obsoleted, use RARSetCallback instead.
-
-
-====================================================================
-void PASCAL RARSetPassword(HANDLE hArcData,
-                           char *Password);
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Set a password to decrypt files.
-
-Parameters
-~~~~~~~~~~
-hArcData
-  This parameter should contain the archive handle obtained from the
-  RAROpenArchive function call.
-
-Password
-  It should point to a string containing a zero terminated password.
-
-Return values
-~~~~~~~~~~~~~
-  None
-
-
-====================================================================
-void PASCAL RARGetDllVersion();
-====================================================================
-
-Description
-~~~~~~~~~~~
-  Returns API version.
-
-Parameters
-~~~~~~~~~~
-  None.
-
-Return values
-~~~~~~~~~~~~~
-  Returns an integer value denoting UnRAR.dll API version, which is also
-defined in unrar.h as RAR_DLL_VERSION. API version number is incremented
-only in case of noticeable changes in UnRAR.dll API. Do not confuse it
-with version of UnRAR.dll stored in DLL resources, which is incremented
-with every DLL rebuild.
-
-  If RARGetDllVersion() returns a value lower than UnRAR.dll which your
-application was designed for, it may indicate that DLL version is too old
-and it will fail to provide all necessary functions to your application.
-
-  This function is absent in old versions of UnRAR.dll, so it is safer
-to use LoadLibrary and GetProcAddress to access this function.
-

UnRAR2/UnRARDLL/whatsnew.txt

@@ -1,80 +0,0 @@
-List of unrar.dll API changes. We do not include performance and reliability
-improvements into this list, but this library and RAR/UnRAR tools share
-the same source code. So the latest version of unrar.dll usually contains
-same decompression algorithm changes as the latest UnRAR version.
-============================================================================
-
---  18 January 2008
-
-all LONG parameters of CallbackProc function were changed
-to LPARAM type for 64 bit mode compatibility.
-
-
---  12 December 2007
-
-Added new RAR_OM_LIST_INCSPLIT open mode for function RAROpenArchive.
-
-
---  14 August 2007
-
-Added NoCrypt\unrar_nocrypt.dll without decryption code for those
-applications where presence of encryption or decryption code is not
-allowed because of legal restrictions.
-
-
---  14 December 2006
-
-Added ERAR_MISSING_PASSWORD error type. This error is returned
-if empty password is specified for encrypted file.
-
-
---  12 June 2003
-
-Added RARProcessFileW function, Unicode version of RARProcessFile
-
-
---  9 August 2002
-
-Added RAROpenArchiveEx function allowing to specify Unicode archive
-name and get archive flags.
-
-
---  24 January 2002
-
-Added RARReadHeaderEx function allowing to read Unicode file names
-and 64 bit file sizes.
-
-
---  23 January 2002
-
-Added ERAR_UNKNOWN error type (it is used for all errors which
-do not have special ERAR code yet) and UCM_NEEDPASSWORD callback
-message.
-
-Unrar.dll automatically opens all next volumes not only when extracting,
-but also in RAR_OM_LIST mode.
-
-
---  27 November 2001
-
-RARSetChangeVolProc and RARSetProcessDataProc are replaced by
-the single callback function installed with RARSetCallback.
-Unlike old style callbacks, the new function accepts the user defined
-parameter. Unrar.dll still supports RARSetChangeVolProc and
-RARSetProcessDataProc for compatibility purposes, but if you write
-a new application, better use RARSetCallback.
-
-File comments support is not implemented in the new DLL version yet.
-Now CmtState is always 0.
-
-
---  13 August 2001
-
-Added RARGetDllVersion function, so you may distinguish old unrar.dll,
-which used C style callback functions and the new one with PASCAL callbacks.
-
-
---  10 May 2001
-
-Callback functions in RARSetChangeVolProc and RARSetProcessDataProc
-use PASCAL style call convention now.

UnRAR2/UnRARDLL/x64/readme.txt

@@ -1 +0,0 @@
-This is x64 version of unrar.dll.

UnRAR2/__init__.py

@@ -1,177 +0,0 @@
-# Copyright (c) 2003-2005 Jimmy Retzlaff, 2008 Konstantin Yegupov
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
-# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
-# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-"""
-pyUnRAR2 is a ctypes based wrapper around the free UnRAR.dll. 
-
-It is an modified version of Jimmy Retzlaff's pyUnRAR - more simple,
-stable and foolproof.
-Notice that it has INCOMPATIBLE interface.
-
-It enables reading and unpacking of archives created with the
-RAR/WinRAR archivers. There is a low-level interface which is very
-similar to the C interface provided by UnRAR. There is also a
-higher level interface which makes some common operations easier.
-"""
-
-__version__ = '0.99.2'
-
-try:
-    WindowsError
-    in_windows = True
-except NameError:
-    in_windows = False
-
-if in_windows:
-    from windows import RarFileImplementation
-else:
-    from unix import RarFileImplementation
-    
-    
-import fnmatch, time, weakref
-
-class RarInfo(object):
-    """Represents a file header in an archive. Don't instantiate directly.
-    Use only to obtain information about file.
-    YOU CANNOT EXTRACT FILE CONTENTS USING THIS OBJECT.
-    USE METHODS OF RarFile CLASS INSTEAD.
-
-    Properties:
-        index - index of file within the archive
-        filename - name of the file in the archive including path (if any)
-        datetime - file date/time as a struct_time suitable for time.strftime
-        isdir - True if the file is a directory
-        size - size in bytes of the uncompressed file
-        comment - comment associated with the file
-        
-    Note - this is not currently intended to be a Python file-like object.
-    """
-
-    def __init__(self, rarfile, data):
-        self.rarfile = weakref.proxy(rarfile)
-        self.index = data['index']
-        self.filename = data['filename']
-        self.isdir = data['isdir']
-        self.size = data['size']
-        self.datetime = data['datetime']
-        self.comment = data['comment']
-            
-
-
-    def __str__(self):
-        try :
-            arcName = self.rarfile.archiveName
-        except ReferenceError:
-            arcName = "[ARCHIVE_NO_LONGER_LOADED]"
-        return '<RarInfo "%s" in "%s">' % (self.filename, arcName)
-
-class RarFile(RarFileImplementation):
-
-    def __init__(self, archiveName, password=None):
-        """Instantiate the archive.
-
-        archiveName is the name of the RAR file.
-        password is used to decrypt the files in the archive.
-
-        Properties:
-            comment - comment associated with the archive
-
-        >>> print RarFile('test.rar').comment
-        This is a test.
-        """
-        self.archiveName = archiveName
-        RarFileImplementation.init(self, password)
-
-    def __del__(self):
-        self.destruct()
-
-    def infoiter(self):
-        """Iterate over all the files in the archive, generating RarInfos.
-
-        >>> import os
-        >>> for fileInArchive in RarFile('test.rar').infoiter():
-        ...     print os.path.split(fileInArchive.filename)[-1],
-        ...     print fileInArchive.isdir,
-        ...     print fileInArchive.size,
-        ...     print fileInArchive.comment,
-        ...     print tuple(fileInArchive.datetime)[0:5],
-        ...     print time.strftime('%a, %d %b %Y %H:%M', fileInArchive.datetime)
-        test True 0 None (2003, 6, 30, 1, 59) Mon, 30 Jun 2003 01:59
-        test.txt False 20 None (2003, 6, 30, 2, 1) Mon, 30 Jun 2003 02:01
-        this.py False 1030 None (2002, 2, 8, 16, 47) Fri, 08 Feb 2002 16:47
-        """
-        for params in RarFileImplementation.infoiter(self):
-            yield RarInfo(self, params)
-
-    def infolist(self):
-        """Return a list of RarInfos, descripting the contents of the archive."""
-        return list(self.infoiter())
-
-    def read_files(self, condition='*'):
-        """Read specific files from archive into memory.
-        If "condition" is a list of numbers, then return files which have those positions in infolist.
-        If "condition" is a string, then it is treated as a wildcard for names of files to extract.
-        If "condition" is a function, it is treated as a callback function, which accepts a RarInfo object 
-            and returns boolean True (extract) or False (skip).
-        If "condition" is omitted, all files are returned.
-        
-        Returns list of tuples (RarInfo info, str contents)
-        """
-        checker = condition2checker(condition)
-        return RarFileImplementation.read_files(self, checker)
-        
-
-    def extract(self,  condition='*', path='.', withSubpath=True, overwrite=True):
-        """Extract specific files from archive to disk.
-        
-        If "condition" is a list of numbers, then extract files which have those positions in infolist.
-        If "condition" is a string, then it is treated as a wildcard for names of files to extract.
-        If "condition" is a function, it is treated as a callback function, which accepts a RarInfo object
-            and returns either boolean True (extract) or boolean False (skip).
-        DEPRECATED: If "condition" callback returns string (only supported for Windows) - 
-            that string will be used as a new name to save the file under.
-        If "condition" is omitted, all files are extracted.
-        
-        "path" is a directory to extract to
-        "withSubpath" flag denotes whether files are extracted with their full path in the archive.
-        "overwrite" flag denotes whether extracted files will overwrite old ones. Defaults to true.
-        
-        Returns list of RarInfos for extracted files."""
-        checker = condition2checker(condition)
-        return RarFileImplementation.extract(self, checker, path, withSubpath, overwrite)
-
-def condition2checker(condition):
-    """Converts different condition types to callback"""
-    if type(condition) in [str, unicode]:
-        def smatcher(info):
-            return fnmatch.fnmatch(info.filename, condition)
-        return smatcher
-    elif type(condition) in [list, tuple] and type(condition[0]) in [int, long]:
-        def imatcher(info):
-            return info.index in condition
-        return imatcher
-    elif callable(condition):
-        return condition
-    else:
-        raise TypeError
-
-

UnRAR2/rar_exceptions.py

@@ -1,30 +0,0 @@
-# Copyright (c) 2003-2005 Jimmy Retzlaff, 2008 Konstantin Yegupov
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
-# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
-# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-# Low level interface - see UnRARDLL\UNRARDLL.TXT
-
-
-class ArchiveHeaderBroken(Exception): pass
-class InvalidRARArchive(Exception): pass
-class FileOpenError(Exception): pass
-class IncorrectRARPassword(Exception): pass
-class InvalidRARArchiveUsage(Exception): pass

UnRAR2/test_UnRAR2.py

@@ -1,139 +0,0 @@
-import os, sys
-
-import UnRAR2
-from UnRAR2.rar_exceptions import *
-
-
-def cleanup(dir='test'):
-    for path, dirs, files in os.walk(dir):
-        for fn in files:
-            os.remove(os.path.join(path, fn))
-        for dir in dirs:
-            os.removedirs(os.path.join(path, dir))
-
-
-
-
-
-# reuse RarArchive object, en
-cleanup()
-rarc = UnRAR2.RarFile('test.rar')
-rarc.infolist()
-for info in rarc.infoiter():
-    saveinfo = info
-    assert (str(info)=="""<RarInfo "test" in "test.rar">""")
-    break
-rarc.extract()
-assert os.path.exists('test'+os.sep+'test.txt')
-assert os.path.exists('test'+os.sep+'this.py')
-del rarc
-assert (str(saveinfo)=="""<RarInfo "test" in "[ARCHIVE_NO_LONGER_LOADED]">""")
-cleanup()
-
-# extract all the files in test.rar
-cleanup()
-UnRAR2.RarFile('test.rar').extract()
-assert os.path.exists('test'+os.sep+'test.txt')
-assert os.path.exists('test'+os.sep+'this.py')
-cleanup()
-
-# extract all the files in test.rar matching the wildcard *.txt
-cleanup()
-UnRAR2.RarFile('test.rar').extract('*.txt')
-assert os.path.exists('test'+os.sep+'test.txt')
-assert not os.path.exists('test'+os.sep+'this.py')
-cleanup()
-
-
-# check the name and size of each file, extracting small ones
-cleanup()
-archive = UnRAR2.RarFile('test.rar')
-assert archive.comment == 'This is a test.'
-archive.extract(lambda rarinfo: rarinfo.size <= 1024)
-for rarinfo in archive.infoiter():
-    if rarinfo.size <= 1024 and not rarinfo.isdir:
-        assert rarinfo.size == os.stat(rarinfo.filename).st_size
-assert file('test'+os.sep+'test.txt', 'rt').read() == 'This is only a test.'
-assert not os.path.exists('test'+os.sep+'this.py')
-cleanup()
-
-
-# extract this.py, overriding it's destination
-cleanup('test2')
-archive = UnRAR2.RarFile('test.rar')
-archive.extract('*.py', 'test2', False)
-assert os.path.exists('test2'+os.sep+'this.py')
-cleanup('test2')
-
-
-# extract test.txt to memory
-cleanup()
-archive = UnRAR2.RarFile('test.rar')
-entries = UnRAR2.RarFile('test.rar').read_files('*test.txt')
-assert len(entries)==1
-assert entries[0][0].filename.endswith('test.txt')
-assert entries[0][1]=='This is only a test.'
-
-
-# extract all the files in test.rar with overwriting
-cleanup()
-fo = open('test'+os.sep+'test.txt',"wt")
-fo.write("blah")
-fo.close()
-UnRAR2.RarFile('test.rar').extract('*.txt')
-assert open('test'+os.sep+'test.txt',"rt").read()!="blah"
-cleanup()
-
-# extract all the files in test.rar without overwriting
-cleanup()
-fo = open('test'+os.sep+'test.txt',"wt")
-fo.write("blahblah")
-fo.close()
-UnRAR2.RarFile('test.rar').extract('*.txt', overwrite = False)
-assert open('test'+os.sep+'test.txt',"rt").read()=="blahblah"
-cleanup()
-
-# list big file in an archive
-list(UnRAR2.RarFile('test_nulls.rar').infoiter())
-
-# extract files from an archive with protected files
-cleanup()
-UnRAR2.RarFile('test_protected_files.rar', password="protected").extract()
-assert os.path.exists('test'+os.sep+'top_secret_xxx_file.txt')
-cleanup()
-errored = False
-try:
-    UnRAR2.RarFile('test_protected_files.rar', password="proteqted").extract()
-except IncorrectRARPassword:
-    errored = True
-assert not os.path.exists('test'+os.sep+'top_secret_xxx_file.txt')
-assert errored
-cleanup()
-
-# extract files from an archive with protected headers
-cleanup()
-UnRAR2.RarFile('test_protected_headers.rar', password="secret").extract()
-assert os.path.exists('test'+os.sep+'top_secret_xxx_file.txt')
-cleanup()
-errored = False
-try:
-    UnRAR2.RarFile('test_protected_headers.rar', password="seqret").extract()
-except IncorrectRARPassword:
-    errored = True
-assert not os.path.exists('test'+os.sep+'top_secret_xxx_file.txt')
-assert errored
-cleanup()
-
-# make sure docstring examples are working
-import doctest
-doctest.testmod(UnRAR2)
-
-# update documentation
-import pydoc
-pydoc.writedoc(UnRAR2)
-
-# cleanup
-try:
-    os.remove('__init__.pyc')
-except:
-    pass

UnRAR2/unix.py

@@ -1,175 +0,0 @@
-# Copyright (c) 2003-2005 Jimmy Retzlaff, 2008 Konstantin Yegupov
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
-# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
-# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-# Unix version uses unrar command line executable
-
-import subprocess
-import gc
-
-import os, os.path
-import time, re
-
-from rar_exceptions import *
-
-class UnpackerNotInstalled(Exception): pass
-
-rar_executable_cached = None
-
-def call_unrar(params):
-    "Calls rar/unrar command line executable, returns stdout pipe"
-    global rar_executable_cached
-    if rar_executable_cached is None:
-        for command in ('unrar', 'rar'):
-            try:
-                subprocess.Popen([command], stdout=subprocess.PIPE)
-                rar_executable_cached = command
-                break
-            except OSError:
-                pass
-        if rar_executable_cached is None:
-            raise UnpackerNotInstalled("No suitable RAR unpacker installed")
-            
-    assert type(params) == list, "params must be list"
-    args = [rar_executable_cached] + params
-    try:
-        gc.disable() # See http://bugs.python.org/issue1336
-        return subprocess.Popen(args, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-    finally:
-        gc.enable()
-
-class RarFileImplementation(object):
-
-    def init(self, password=None):
-        self.password = password
-        
-        
-
-        stdoutdata, stderrdata = self.call('v', []).communicate()
-        
-        for line in stderrdata.splitlines():
-            if line.strip().startswith("Cannot open"):
-                raise FileOpenError
-            if line.find("CRC failed")>=0:
-                raise IncorrectRARPassword   
-        accum = []
-        source = iter(stdoutdata.splitlines())
-        line = ''
-        while not (line.startswith('Comment:') or line.startswith('Pathname/Comment')):
-            if line.strip().endswith('is not RAR archive'):
-                raise InvalidRARArchive
-            line = source.next()
-        while not line.startswith('Pathname/Comment'):
-            accum.append(line.rstrip('\n'))
-            line = source.next()
-        if len(accum):
-            accum[0] = accum[0][9:]
-            self.comment = '\n'.join(accum[:-1])
-        else:
-            self.comment = None
-                
-    def escaped_password(self):
-        return '-' if self.password == None else self.password
-        
-        
-    def call(self, cmd, options=[], files=[]):
-        options2 = options + ['p'+self.escaped_password()]
-        soptions = ['-'+x for x in options2]
-        return call_unrar([cmd]+soptions+['--',self.archiveName]+files)
-
-    def infoiter(self):
-        
-        stdoutdata, stderrdata = self.call('v', ['c-']).communicate()
-        
-        for line in stderrdata.splitlines():
-            if line.strip().startswith("Cannot open"):
-                raise FileOpenError
-            
-        accum = []
-        source = iter(stdoutdata.splitlines())
-        line = ''
-        while not line.startswith('--------------'):
-            if line.strip().endswith('is not RAR archive'):
-                raise InvalidRARArchive
-            if line.find("CRC failed")>=0:
-                raise IncorrectRARPassword  
-            line = source.next()
-        line = source.next()
-        i = 0
-        re_spaces = re.compile(r"\s+")
-        while not line.startswith('--------------'):
-            accum.append(line)
-            if len(accum)==2:
-                data = {}
-                data['index'] = i
-                data['filename'] = accum[0].strip()
-                info = re_spaces.split(accum[1].strip())
-                data['size'] = int(info[0])
-                attr = info[5]
-                data['isdir'] = 'd' in attr.lower()
-                data['datetime'] = time.strptime(info[3]+" "+info[4], '%d-%m-%y %H:%M')
-                data['comment'] = None
-                yield data
-                accum = []
-                i += 1
-            line = source.next()
-
-    def read_files(self, checker):
-        res = []
-        for info in self.infoiter():
-            checkres = checker(info)
-            if checkres==True and not info.isdir:
-                pipe = self.call('p', ['inul'], [info.filename]).stdout
-                res.append((info, pipe.read()))
-        return res            
-
-          
-    def extract(self, checker, path, withSubpath, overwrite):
-        res = []
-        command = 'x'
-        if not withSubpath:
-            command = 'e'
-        options = []
-        if overwrite:
-            options.append('o+')
-        else:
-			options.append('o-')
-        if not path.endswith(os.sep):
-            path += os.sep
-        names = []
-        for info in self.infoiter():
-            checkres = checker(info)
-            if type(checkres) in [str, unicode]:
-                raise NotImplementedError("Condition callbacks returning strings are deprecated and only supported in Windows")
-            if checkres==True and not info.isdir:
-                names.append(info.filename)
-                res.append(info)
-        names.append(path)
-        proc = self.call(command, options, names)
-        stdoutdata, stderrdata = proc.communicate()
-        if stderrdata.find("CRC failed")>=0:
-            raise IncorrectRARPassword  
-        return res            
-            
-    def destruct(self):
-        pass
-
-    

UnRAR2/windows.py

@@ -1,309 +0,0 @@
-# Copyright (c) 2003-2005 Jimmy Retzlaff, 2008 Konstantin Yegupov
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
-# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
-# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-# Low level interface - see UnRARDLL\UNRARDLL.TXT
-
-from __future__ import generators
-
-import ctypes, ctypes.wintypes
-import os, os.path, sys
-import Queue
-import time
-
-from rar_exceptions import *
-
-ERAR_END_ARCHIVE = 10
-ERAR_NO_MEMORY = 11
-ERAR_BAD_DATA = 12
-ERAR_BAD_ARCHIVE = 13
-ERAR_UNKNOWN_FORMAT = 14
-ERAR_EOPEN = 15
-ERAR_ECREATE = 16
-ERAR_ECLOSE = 17
-ERAR_EREAD = 18
-ERAR_EWRITE = 19
-ERAR_SMALL_BUF = 20
-ERAR_UNKNOWN = 21
-
-RAR_OM_LIST = 0
-RAR_OM_EXTRACT = 1
-
-RAR_SKIP = 0
-RAR_TEST = 1
-RAR_EXTRACT = 2
-
-RAR_VOL_ASK = 0
-RAR_VOL_NOTIFY = 1
-
-RAR_DLL_VERSION = 3
-
-# enum UNRARCALLBACK_MESSAGES
-UCM_CHANGEVOLUME = 0
-UCM_PROCESSDATA = 1
-UCM_NEEDPASSWORD = 2
-
-architecture_bits = ctypes.sizeof(ctypes.c_voidp)*8
-dll_name = "unrar.dll"
-if architecture_bits == 64:
-    dll_name = "x64\\unrar64.dll"
-    
-    
-try:
-    unrar = ctypes.WinDLL(os.path.join(os.path.split(__file__)[0], 'UnRARDLL', dll_name))
-except WindowsError:
-    unrar = ctypes.WinDLL(dll_name)
-
-
-class RAROpenArchiveDataEx(ctypes.Structure):
-    def __init__(self, ArcName=None, ArcNameW=u'', OpenMode=RAR_OM_LIST):
-        self.CmtBuf = ctypes.c_buffer(64*1024)
-        ctypes.Structure.__init__(self, ArcName=ArcName, ArcNameW=ArcNameW, OpenMode=OpenMode, _CmtBuf=ctypes.addressof(self.CmtBuf), CmtBufSize=ctypes.sizeof(self.CmtBuf))
-
-    _fields_ = [
-                ('ArcName', ctypes.c_char_p),
-                ('ArcNameW', ctypes.c_wchar_p),
-                ('OpenMode', ctypes.c_uint),
-                ('OpenResult', ctypes.c_uint),
-                ('_CmtBuf', ctypes.c_voidp),
-                ('CmtBufSize', ctypes.c_uint),
-                ('CmtSize', ctypes.c_uint),
-                ('CmtState', ctypes.c_uint),
-                ('Flags', ctypes.c_uint),
-                ('Reserved', ctypes.c_uint*32),
-               ]
-
-class RARHeaderDataEx(ctypes.Structure):
-    def __init__(self):
-        self.CmtBuf = ctypes.c_buffer(64*1024)
-        ctypes.Structure.__init__(self, _CmtBuf=ctypes.addressof(self.CmtBuf), CmtBufSize=ctypes.sizeof(self.CmtBuf))
-
-    _fields_ = [
-                ('ArcName', ctypes.c_char*1024),
-                ('ArcNameW', ctypes.c_wchar*1024),
-                ('FileName', ctypes.c_char*1024),
-                ('FileNameW', ctypes.c_wchar*1024),
-                ('Flags', ctypes.c_uint),
-                ('PackSize', ctypes.c_uint),
-                ('PackSizeHigh', ctypes.c_uint),
-                ('UnpSize', ctypes.c_uint),
-                ('UnpSizeHigh', ctypes.c_uint),
-                ('HostOS', ctypes.c_uint),
-                ('FileCRC', ctypes.c_uint),
-                ('FileTime', ctypes.c_uint),
-                ('UnpVer', ctypes.c_uint),
-                ('Method', ctypes.c_uint),
-                ('FileAttr', ctypes.c_uint),
-                ('_CmtBuf', ctypes.c_voidp),
-                ('CmtBufSize', ctypes.c_uint),
-                ('CmtSize', ctypes.c_uint),
-                ('CmtState', ctypes.c_uint),
-                ('Reserved', ctypes.c_uint*1024),
-               ]
-
-def DosDateTimeToTimeTuple(dosDateTime):
-    """Convert an MS-DOS format date time to a Python time tuple.
-    """
-    dosDate = dosDateTime >> 16
-    dosTime = dosDateTime & 0xffff
-    day = dosDate & 0x1f
-    month = (dosDate >> 5) & 0xf
-    year = 1980 + (dosDate >> 9)
-    second = 2*(dosTime & 0x1f)
-    minute = (dosTime >> 5) & 0x3f
-    hour = dosTime >> 11
-    return time.localtime(time.mktime((year, month, day, hour, minute, second, 0, 1, -1)))
-
-def _wrap(restype, function, argtypes):
-    result = function
-    result.argtypes = argtypes
-    result.restype = restype
-    return result
-
-RARGetDllVersion = _wrap(ctypes.c_int, unrar.RARGetDllVersion, [])
-
-RAROpenArchiveEx = _wrap(ctypes.wintypes.HANDLE, unrar.RAROpenArchiveEx, [ctypes.POINTER(RAROpenArchiveDataEx)])
-
-RARReadHeaderEx = _wrap(ctypes.c_int, unrar.RARReadHeaderEx, [ctypes.wintypes.HANDLE, ctypes.POINTER(RARHeaderDataEx)])
-
-_RARSetPassword = _wrap(ctypes.c_int, unrar.RARSetPassword, [ctypes.wintypes.HANDLE, ctypes.c_char_p])
-def RARSetPassword(*args, **kwargs):
-    _RARSetPassword(*args, **kwargs)
-
-RARProcessFile = _wrap(ctypes.c_int, unrar.RARProcessFile, [ctypes.wintypes.HANDLE, ctypes.c_int, ctypes.c_char_p, ctypes.c_char_p])
-
-RARCloseArchive = _wrap(ctypes.c_int, unrar.RARCloseArchive, [ctypes.wintypes.HANDLE])
-
-UNRARCALLBACK = ctypes.WINFUNCTYPE(ctypes.c_int, ctypes.c_uint, ctypes.c_long, ctypes.c_long, ctypes.c_long)
-RARSetCallback = _wrap(ctypes.c_int, unrar.RARSetCallback, [ctypes.wintypes.HANDLE, UNRARCALLBACK, ctypes.c_long])
-
-
-
-RARExceptions = {
-                 ERAR_NO_MEMORY : MemoryError,
-                 ERAR_BAD_DATA : ArchiveHeaderBroken,
-                 ERAR_BAD_ARCHIVE : InvalidRARArchive,
-                 ERAR_EOPEN : FileOpenError,
-                }
-
-class PassiveReader:
-    """Used for reading files to memory"""
-    def __init__(self, usercallback = None):
-        self.buf = []
-        self.ucb = usercallback
-    
-    def _callback(self, msg, UserData, P1, P2):
-        if msg == UCM_PROCESSDATA:
-            data = (ctypes.c_char*P2).from_address(P1).raw
-            if self.ucb!=None:
-                self.ucb(data)
-            else:
-                self.buf.append(data)
-        return 1
-    
-    def get_result(self):
-        return ''.join(self.buf)
-
-class RarInfoIterator(object):
-    def __init__(self, arc):
-        self.arc = arc
-        self.index = 0
-        self.headerData = RARHeaderDataEx()
-        self.res = RARReadHeaderEx(self.arc._handle, ctypes.byref(self.headerData))
-        if self.res==ERAR_BAD_DATA:
-            raise IncorrectRARPassword
-        self.arc.lockStatus = "locked"
-        self.arc.needskip = False
-        
-    def __iter__(self):
-        return self
-        
-    def next(self):
-        if self.index>0:
-            if self.arc.needskip:
-                RARProcessFile(self.arc._handle, RAR_SKIP, None, None)
-            self.res = RARReadHeaderEx(self.arc._handle, ctypes.byref(self.headerData))
-
-        if self.res:
-            raise StopIteration 
-        self.arc.needskip = True
-        
-        data = {}
-        data['index'] = self.index
-        data['filename'] = self.headerData.FileName
-        data['datetime'] = DosDateTimeToTimeTuple(self.headerData.FileTime)
-        data['isdir'] = ((self.headerData.Flags & 0xE0) == 0xE0)
-        data['size'] = self.headerData.UnpSize + (self.headerData.UnpSizeHigh << 32)
-        if self.headerData.CmtState == 1:
-            data['comment'] = self.headerData.CmtBuf.value
-        else:
-            data['comment'] = None
-        self.index += 1
-        return data
-
-            
-    def __del__(self):
-        self.arc.lockStatus = "finished"
-
-def generate_password_provider(password):
-    def password_provider_callback(msg, UserData, P1, P2):
-        if msg == UCM_NEEDPASSWORD and password!=None:
-            (ctypes.c_char*P2).from_address(P1).value = password
-        return 1
-    return password_provider_callback
-
-class RarFileImplementation(object):
-
-    def init(self, password=None):
-        self.password = password
-        archiveData = RAROpenArchiveDataEx(ArcNameW=self.archiveName, OpenMode=RAR_OM_EXTRACT)
-        self._handle = RAROpenArchiveEx(ctypes.byref(archiveData))
-        self.c_callback = UNRARCALLBACK(generate_password_provider(self.password))
-        RARSetCallback(self._handle, self.c_callback, 1)
-
-        if archiveData.OpenResult != 0:
-            raise RARExceptions[archiveData.OpenResult]
-
-        if archiveData.CmtState == 1:
-            self.comment = archiveData.CmtBuf.value
-        else:
-            self.comment = None
-
-        if password:
-            RARSetPassword(self._handle, password)
-            
-        self.lockStatus = "ready"
-            
-
-
-    def destruct(self):
-        if self._handle and RARCloseArchive:
-            RARCloseArchive(self._handle)
-
-    def make_sure_ready(self):
-        if self.lockStatus == "locked":
-            raise InvalidRARArchiveUsage("cannot execute infoiter() without finishing previous one")
-        if self.lockStatus == "finished":
-            self.destruct()
-            self.init(self.password)
-
-    def infoiter(self):
-        self.make_sure_ready()
-        return RarInfoIterator(self)
-
-    def read_files(self, checker):
-        res = []
-        for info in self.infoiter():
-            if checker(info) and not info.isdir:
-                reader = PassiveReader()
-                c_callback = UNRARCALLBACK(reader._callback)
-                RARSetCallback(self._handle, c_callback, 1)
-                tmpres = RARProcessFile(self._handle, RAR_TEST, None, None)
-                if tmpres==ERAR_BAD_DATA:
-                    raise IncorrectRARPassword
-                self.needskip = False
-                res.append((info, reader.get_result()))
-        return res
-        
-
-    def extract(self,  checker, path, withSubpath, overwrite):
-        res = []
-        for info in self.infoiter():
-            checkres = checker(info)
-            if checkres!=False and not info.isdir:
-                if checkres==True:
-                    fn = info.filename
-                    if not withSubpath:
-                        fn = os.path.split(fn)[-1]
-                    target = os.path.join(path, fn)
-                else:
-                    raise DeprecationWarning, "Condition callbacks returning strings are deprecated and only supported in Windows"                    
-                    target = checkres
-                if overwrite or (not os.path.exists(target)):
-                    tmpres = RARProcessFile(self._handle, RAR_EXTRACT, None, target)
-                    if tmpres==ERAR_BAD_DATA:
-                        raise IncorrectRARPassword
-
-                self.needskip = False
-                res.append(info)
-        return res
-
-

autotagmatchwindow.py

@@ -1,208 +0,0 @@
-"""
-A PyQT4 dialog to select from automated issue matches
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-import sys
-import os
-from PyQt4 import QtCore, QtGui, uic
-
-from PyQt4.QtCore import QUrl, pyqtSignal, QByteArray
-
-from imagefetcher import  ImageFetcher
-from settings import ComicTaggerSettings
-from options import MetaDataStyle
-
-class AutoTagMatchWindow(QtGui.QDialog):
-	
-	volume_id = 0
-	
-	def __init__(self, parent, match_set_list, style, fetch_func):
-		super(AutoTagMatchWindow, self).__init__(parent)
-		
-		uic.loadUi(os.path.join(ComicTaggerSettings.baseDir(), 'autotagmatchwindow.ui' ), self)
-
-		self.skipButton = QtGui.QPushButton(self.tr("Skip"))
-		self.buttonBox.addButton(self.skipButton, QtGui.QDialogButtonBox.ActionRole)		
-		self.buttonBox.button(QtGui.QDialogButtonBox.Ok).setText("Accept and Next")		
-
-		self.match_set_list = match_set_list
-		self.style = style
-		self.fetch_func = fetch_func
-
-		self.current_match_set_idx = 0
-		
-		self.twList.currentItemChanged.connect(self.currentItemChanged)	
-		self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
-		self.skipButton.clicked.connect(self.skipToNext)
-		
-		self.updateData()		
-
-	def updateData( self):
-
-		self.current_match_set = self.match_set_list[ self.current_match_set_idx ]
-
-
-		if self.current_match_set_idx + 1 == len( self.match_set_list ):
-			self.skipButton.setDisabled(True)
-			
-		self.setCoverImage()
-		self.populateTable()
-		self.twList.resizeColumnsToContents()	
-		self.current_row = 0
-		self.twList.selectRow( 0 )
-		
-		path = self.current_match_set.ca.path
-		self.setWindowTitle( u"Select correct match ({0} of {1}): {2}".format(
-						self.current_match_set_idx+1,
-						len( self.match_set_list ),
-						os.path.split(path)[1] ))
-		
-	def populateTable( self  ):
-
-		while self.twList.rowCount() > 0:
-			self.twList.removeRow(0)
-		
-		self.twList.setSortingEnabled(False)
-
-		row = 0
-		for match in self.current_match_set.matches: 
-			self.twList.insertRow(row)
-			
-			item_text = match['series']  
-			item = QtGui.QTableWidgetItem(item_text)			
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 0, item)
-
-			if match['publisher'] is not None:
-				item_text = u"{0}".format(match['publisher'])
-			else:
-				item_text = u"Unknown"
-			item = QtGui.QTableWidgetItem(item_text)
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 1, item)
-			
-			item_text = ""
-			if match['month'] is not None:
-				item_text = u"{0}/".format(match['month'])
-			if match['year'] is not None:
-				item_text += u"{0}".format(match['year'])
-			else:
-				item_text += u"????"
-			item = QtGui.QTableWidgetItem(item_text)			
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 2, item)
-			
-			row += 1
-			
-
-	def cellDoubleClicked( self, r, c ):
-		self.accept()
-			
-	def currentItemChanged( self, curr, prev ):
-
-		if curr is None:
-			return
-		if prev is not None and prev.row() == curr.row():
-				return
-
-		self.current_row = curr.row()
-		
-		# list selection was changed, update the the issue cover				
-		self.labelThumbnail.setPixmap(QtGui.QPixmap(os.path.join(ComicTaggerSettings.baseDir(), 'graphics/nocover.png' )))
-				
-		self.cover_fetcher = ImageFetcher( )
-		self.cover_fetcher.fetchComplete.connect(self.coverFetchComplete)
-		self.cover_fetcher.fetch( self.current_match_set.matches[self.current_row]['img_url'] )
-				
-	# called when the image is done loading
-	def coverFetchComplete( self, image_data, issue_id ):
-		img = QtGui.QImage()
-		img.loadFromData( image_data )
-		self.labelThumbnail.setPixmap(QtGui.QPixmap(img))
-		
-	def setCoverImage( self ):
-		ca = self.current_match_set.ca
-		cover_idx = ca.readMetadata(self.style).getCoverPageIndexList()[0]
-		image_data = ca.getPage( cover_idx )		
-		self.labelCover.setScaledContents(True)
-		if image_data is not None:
-			img = QtGui.QImage()
-			img.loadFromData( image_data )
-			self.labelCover.setPixmap(QtGui.QPixmap(img))
-		else:
-			self.labelCover.setPixmap(QtGui.QPixmap(os.path.join(ComicTaggerSettings.baseDir(), 'graphics/nocover.png' )))
-
-	def accept(self):
-
-		self.saveMatch()
-		self.current_match_set_idx += 1
-		
-		if self.current_match_set_idx == len( self.match_set_list ):
-			# no more items
-			QtGui.QDialog.accept(self)				
-		else:
-			self.updateData()
-
-	def skipToNext( self ):
-		self.current_match_set_idx += 1
-		
-		if self.current_match_set_idx == len( self.match_set_list ):
-			# no more items
-			QtGui.QDialog.reject(self)				
-		else:
-			self.updateData()
-		
-	def reject(self):
-		reply = QtGui.QMessageBox.question(self, 
-			 self.tr("Cancel Matching"), 
-			 self.tr("Are you sure you wish to cancel the matching process?"),
-			 QtGui.QMessageBox.Yes, QtGui.QMessageBox.No )
-			 
-		if reply == QtGui.QMessageBox.No:
-			return
-
-		QtGui.QDialog.reject(self)				
-			
-	def saveMatch( self ):
-		
-		match = self.current_match_set.matches[self.current_row]
-		ca = self.current_match_set.ca
-
-		md = ca.readMetadata( self.style )
-		if md.isEmpty:
-			md = ca.metadataFromFilename()		
-		
-		# now get the particular issue data
-		cv_md = self.fetch_func( match )
-		if cv_md is None:
-			QtGui.QMessageBox.critical(self, self.tr("Network Issue"), self.tr("Could not connect to ComicVine to get issue details!"))
-			return
-
-		QtGui.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.WaitCursor))			
-		md.overlay( cv_md )
-		success = ca.writeMetadata( md, self.style )
-		ca.loadCache( [ MetaDataStyle.CBI, MetaDataStyle.CIX ] )
-	
-		QtGui.QApplication.restoreOverrideCursor()
-		
-		if not success:		
-			QtGui.QMessageBox.warning(self, self.tr("Write Error"), self.tr("Saving the tags to the archive seemed to fail!"))

autotagmatchwindow.ui

@@ -1,161 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>dialogMatchSelect</class>
- <widget class="QDialog" name="dialogMatchSelect">
-  <property name="geometry">
-   <rect>
-    <x>0</x>
-    <y>0</y>
-    <width>831</width>
-    <height>506</height>
-   </rect>
-  </property>
-  <property name="windowTitle">
-   <string>Select Match</string>
-  </property>
-  <layout class="QGridLayout" name="gridLayout">
-   <item row="0" column="1">
-    <layout class="QVBoxLayout" name="verticalLayout">
-     <item>
-      <layout class="QHBoxLayout" name="horizontalLayout">
-       <item>
-        <widget class="QLabel" name="labelCover">
-         <property name="minimumSize">
-          <size>
-           <width>200</width>
-           <height>0</height>
-          </size>
-         </property>
-         <property name="maximumSize">
-          <size>
-           <width>200</width>
-           <height>300</height>
-          </size>
-         </property>
-         <property name="text">
-          <string>TextLabel</string>
-         </property>
-        </widget>
-       </item>
-       <item>
-        <widget class="QTableWidget" name="twList">
-         <property name="font">
-          <font>
-           <pointsize>9</pointsize>
-          </font>
-         </property>
-         <property name="selectionMode">
-          <enum>QAbstractItemView::SingleSelection</enum>
-         </property>
-         <property name="selectionBehavior">
-          <enum>QAbstractItemView::SelectRows</enum>
-         </property>
-         <property name="rowCount">
-          <number>0</number>
-         </property>
-         <property name="columnCount">
-          <number>3</number>
-         </property>
-         <attribute name="horizontalHeaderStretchLastSection">
-          <bool>true</bool>
-         </attribute>
-         <attribute name="verticalHeaderVisible">
-          <bool>false</bool>
-         </attribute>
-         <column>
-          <property name="text">
-           <string>Series</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>Publisher</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>Date</string>
-          </property>
-         </column>
-        </widget>
-       </item>
-       <item>
-        <widget class="QLabel" name="labelThumbnail">
-         <property name="minimumSize">
-          <size>
-           <width>200</width>
-           <height>0</height>
-          </size>
-         </property>
-         <property name="maximumSize">
-          <size>
-           <width>200</width>
-           <height>300</height>
-          </size>
-         </property>
-         <property name="frameShape">
-          <enum>QFrame::Panel</enum>
-         </property>
-         <property name="frameShadow">
-          <enum>QFrame::Sunken</enum>
-         </property>
-         <property name="text">
-          <string/>
-         </property>
-         <property name="scaledContents">
-          <bool>true</bool>
-         </property>
-        </widget>
-       </item>
-      </layout>
-     </item>
-     <item>
-      <widget class="QDialogButtonBox" name="buttonBox">
-       <property name="orientation">
-        <enum>Qt::Horizontal</enum>
-       </property>
-       <property name="standardButtons">
-        <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
-       </property>
-      </widget>
-     </item>
-    </layout>
-   </item>
-  </layout>
- </widget>
- <resources/>
- <connections>
-  <connection>
-   <sender>buttonBox</sender>
-   <signal>accepted()</signal>
-   <receiver>dialogMatchSelect</receiver>
-   <slot>accept()</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>248</x>
-     <y>254</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>157</x>
-     <y>274</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>buttonBox</sender>
-   <signal>rejected()</signal>
-   <receiver>dialogMatchSelect</receiver>
-   <slot>reject()</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>316</x>
-     <y>260</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>286</x>
-     <y>274</y>
-    </hint>
-   </hints>
-  </connection>
- </connections>
-</ui>

autotagprogresswindow.py

@@ -1,67 +0,0 @@
-"""
-A PyQT4 dialog to show ID log and progress
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-import sys
-from PyQt4 import QtCore, QtGui, uic
-import os
-from settings import ComicTaggerSettings
-
-
-class AutoTagProgressWindow(QtGui.QDialog):
-	
-	
-	def __init__(self, parent):
-		super(AutoTagProgressWindow, self).__init__(parent)
-		
-		uic.loadUi(os.path.join(ComicTaggerSettings.baseDir(), 'autotagprogresswindow.ui' ), self)
-		self.lblTest.setPixmap(QtGui.QPixmap(os.path.join(ComicTaggerSettings.baseDir(), 'graphics/nocover.png' )))
-		self.lblArchive.setPixmap(QtGui.QPixmap(os.path.join(ComicTaggerSettings.baseDir(), 'graphics/nocover.png' )))
-		self.isdone = False
-		
-		# we can't specify relative font sizes in the UI designer, so
-		# make font for scroll window a smidge smaller
-		f = self.textEdit.font()
-		if f.pointSize() > 10:
-			f.setPointSize( f.pointSize() - 2 )
-		self.textEdit.setFont( f )		
-		
-	def setArchiveImage( self, img_data):
-		self.setCoverImage( img_data, self.lblArchive )
-
-	def setTestImage( self, img_data):
-		self.setCoverImage( img_data, self.lblTest )
-
-	def setCoverImage( self, img_data , label):
-		if img_data is not None:
-			img = QtGui.QImage()
-			img.loadFromData( img_data )
-			label.setPixmap(QtGui.QPixmap(img))
-			label.setScaledContents(True)
-		else:
-			label.setPixmap(QtGui.QPixmap(os.path.join(ComicTaggerSettings.baseDir(), 'graphics/nocover.png' )))
-			label.setScaledContents(True)
-		QtCore.QCoreApplication.processEvents()
-		QtCore.QCoreApplication.processEvents()
-			
-	def reject(self):
-		QtGui.QDialog.reject(self)		
-		self.isdone = True
-
-		

autotagstartwindow.py

@@ -1,101 +0,0 @@
-"""
-A PyQT4 dialog to confirm and set options for auto-tag
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-
-from PyQt4 import QtCore, QtGui, uic
-from settings import ComicTaggerSettings
-from settingswindow import SettingsWindow
-from filerenamer import FileRenamer
-import os
-import utils
-
-	
-class AutoTagStartWindow(QtGui.QDialog):
-		
-	def __init__( self, parent,  settings, msg ):
-		super(AutoTagStartWindow, self).__init__(parent)
-		
-		uic.loadUi(os.path.join(ComicTaggerSettings.baseDir(), 'autotagstartwindow.ui' ), self)
-		self.label.setText( msg )
-
-		self.settings = settings
-		
-		self.cbxSaveOnLowConfidence.setCheckState( QtCore.Qt.Unchecked )
-		self.cbxDontUseYear.setCheckState( QtCore.Qt.Unchecked )
-		self.cbxAssumeIssueOne.setCheckState( QtCore.Qt.Unchecked )
-		self.cbxIgnoreLeadingDigitsInFilename.setCheckState( QtCore.Qt.Unchecked )
-		self.cbxRemoveAfterSuccess.setCheckState( QtCore.Qt.Unchecked )
-		self.cbxSpecifySearchString.setCheckState( QtCore.Qt.Unchecked )
-		self.leNameLengthMatchTolerance.setText( str(self.settings.id_length_delta_thresh) )
-		self.leSearchString.setEnabled( False )
-
-		nlmtTip = (
-			""" <html>The <b>Name Length Match Tolerance</b> is for eliminating automatic
-			    search matches that are too long compared to your series name search. The higher
-			    it is, the more likely to have a good match, but each search will take longer and
-				use more bandwidth. Too low, and only the very closest lexical matches will be
-				explored.</html>""" )
-		
-		self.leNameLengthMatchTolerance.setToolTip(nlmtTip)
-			
-		ssTip = (
-			"""<html>
-			The <b>series search string</b> specifies the search string to be used for all selected archives.
-			Use this only when trying to match archives with hard-to-parse filenames.  All archives selected
-			should be from the same series.
-			</html>"""
-		)
-		self.leSearchString.setToolTip(ssTip)
-		self.cbxSpecifySearchString.setToolTip(ssTip)
-		
-				
-		validator = QtGui.QIntValidator(0, 99, self)
-		self.leNameLengthMatchTolerance.setValidator(validator)
-				
-		self.cbxSpecifySearchString.stateChanged.connect(self.searchStringToggle)
-		
-		self.autoSaveOnLow = False
-		self.dontUseYear = False
-		self.assumeIssueOne = False
-		self.ignoreLeadingDigitsInFilename = False
-		self.removeAfterSuccess = False
-		self.searchString = None
-		self.nameLengthMatchTolerance =  self.settings.id_length_delta_thresh
-
-	def searchStringToggle(self):
-		enable = self.cbxSpecifySearchString.isChecked()
-		self.leSearchString.setEnabled( enable )
-
-	
-	def accept( self ):
-		QtGui.QDialog.accept(self)		
-
-		self.autoSaveOnLow = self.cbxSaveOnLowConfidence.isChecked()
-		self.dontUseYear = self.cbxDontUseYear.isChecked()
-		self.assumeIssueOne = self.cbxAssumeIssueOne.isChecked()
-		self.ignoreLeadingDigitsInFilename = self.cbxIgnoreLeadingDigitsInFilename.isChecked()
-		self.removeAfterSuccess = self.cbxRemoveAfterSuccess.isChecked()
-		self.nameLengthMatchTolerance = int(self.leNameLengthMatchTolerance.text())
-		
-		if self.cbxSpecifySearchString.isChecked():
-			self.searchString = unicode(self.leSearchString.text())
-			if len(self.searchString) == 0:
-				self.searchString = None
-			

autotagstartwindow.ui

@@ -1,242 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>dialogExport</class>
- <widget class="QDialog" name="dialogExport">
-  <property name="windowModality">
-   <enum>Qt::NonModal</enum>
-  </property>
-  <property name="geometry">
-   <rect>
-    <x>0</x>
-    <y>0</y>
-    <width>607</width>
-    <height>319</height>
-   </rect>
-  </property>
-  <property name="sizePolicy">
-   <sizepolicy hsizetype="Preferred" vsizetype="MinimumExpanding">
-    <horstretch>0</horstretch>
-    <verstretch>0</verstretch>
-   </sizepolicy>
-  </property>
-  <property name="windowTitle">
-   <string>Auto-Tag</string>
-  </property>
-  <property name="modal">
-   <bool>false</bool>
-  </property>
-  <layout class="QGridLayout" name="gridLayout_3">
-   <item row="0" column="0">
-    <layout class="QVBoxLayout" name="verticalLayout">
-     <item>
-      <widget class="QLabel" name="label">
-       <property name="sizePolicy">
-        <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
-         <horstretch>0</horstretch>
-         <verstretch>0</verstretch>
-        </sizepolicy>
-       </property>
-       <property name="text">
-        <string/>
-       </property>
-       <property name="wordWrap">
-        <bool>true</bool>
-       </property>
-      </widget>
-     </item>
-     <item>
-      <layout class="QFormLayout" name="formLayout">
-       <property name="sizeConstraint">
-        <enum>QLayout::SetFixedSize</enum>
-       </property>
-       <property name="fieldGrowthPolicy">
-        <enum>QFormLayout::AllNonFixedFieldsGrow</enum>
-       </property>
-       <item row="0" column="0" colspan="2">
-        <widget class="QCheckBox" name="cbxSaveOnLowConfidence">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="text">
-          <string>Save on low confidence match</string>
-         </property>
-        </widget>
-       </item>
-       <item row="1" column="0" colspan="2">
-        <widget class="QCheckBox" name="cbxDontUseYear">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="text">
-          <string>Don't use publication year in indentification process</string>
-         </property>
-        </widget>
-       </item>
-       <item row="2" column="0" colspan="2">
-        <widget class="QCheckBox" name="cbxAssumeIssueOne">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="text">
-          <string>If no issue number, assume &quot;1&quot;</string>
-         </property>
-        </widget>
-       </item>
-       <item row="3" column="0" colspan="2">
-        <widget class="QCheckBox" name="cbxIgnoreLeadingDigitsInFilename">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="text">
-          <string>Ignore leading (sequence) numbers in filename</string>
-         </property>
-        </widget>
-       </item>
-       <item row="4" column="0" colspan="2">
-        <widget class="QCheckBox" name="cbxRemoveAfterSuccess">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="text">
-          <string>Remove archives from list after successful tagging</string>
-         </property>
-        </widget>
-       </item>
-       <item row="5" column="0" colspan="2">
-        <widget class="QCheckBox" name="cbxSpecifySearchString">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="text">
-          <string>Specify series search string for all selected archives</string>
-         </property>
-        </widget>
-       </item>
-       <item row="6" column="0">
-        <widget class="QLabel" name="label_2">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="minimumSize">
-          <size>
-           <width>40</width>
-           <height>0</height>
-          </size>
-         </property>
-         <property name="text">
-          <string/>
-         </property>
-        </widget>
-       </item>
-       <item row="6" column="1">
-        <widget class="QLineEdit" name="leSearchString">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Expanding" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-        </widget>
-       </item>
-       <item row="8" column="1">
-        <widget class="QLineEdit" name="leNameLengthMatchTolerance">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Expanding" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="maximumSize">
-          <size>
-           <width>50</width>
-           <height>16777215</height>
-          </size>
-         </property>
-        </widget>
-       </item>
-       <item row="7" column="0" colspan="2">
-        <widget class="QLabel" name="label_3">
-         <property name="sizePolicy">
-          <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
-           <horstretch>0</horstretch>
-           <verstretch>0</verstretch>
-          </sizepolicy>
-         </property>
-         <property name="text">
-          <string>Adjust Name Length Match Tolerance:</string>
-         </property>
-        </widget>
-       </item>
-      </layout>
-     </item>
-     <item>
-      <widget class="QDialogButtonBox" name="buttonBox">
-       <property name="orientation">
-        <enum>Qt::Horizontal</enum>
-       </property>
-       <property name="standardButtons">
-        <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
-       </property>
-      </widget>
-     </item>
-    </layout>
-   </item>
-  </layout>
- </widget>
- <resources/>
- <connections>
-  <connection>
-   <sender>buttonBox</sender>
-   <signal>accepted()</signal>
-   <receiver>dialogExport</receiver>
-   <slot>accept()</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>346</x>
-     <y>187</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>277</x>
-     <y>104</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>buttonBox</sender>
-   <signal>rejected()</signal>
-   <receiver>dialogExport</receiver>
-   <slot>reject()</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>346</x>
-     <y>187</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>277</x>
-     <y>104</y>
-    </hint>
-   </hints>
-  </connection>
- </connections>
-</ui>

build-tools/ComicTagger.desktop

@@ -0,0 +1,11 @@
+[Desktop Entry]
+Encoding=UTF-8
+Name=ComicTagger
+GenericName=Comic Metadata Editor
+Comment=A cross-platform GUI/CLI app for writing metadata to comic archives
+Exec=comictagger %F
+Icon=/usr/local/share/comictagger/app.png
+Terminal=false
+Type=Application
+MimeType=text/plain;
+Categories=Application;

build-tools/comictagger.spec

@@ -0,0 +1,241 @@
+# -*- mode: python ; coding: utf-8 -*-
+
+import platform
+
+from comictaggerlib import ctversion
+
+enable_console = False
+block_cipher = None
+
+
+a = Analysis(
+    ["../comictaggerlib/__main__.py"],
+    pathex=[],
+    binaries=[],
+    datas=[],
+    hiddenimports=[],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=[],
+    win_no_prefer_redirects=False,
+    win_private_assemblies=False,
+    cipher=block_cipher,
+    noarchive=False,
+)
+
+exe_binaries = []
+exe_zipfiles = []
+exe_datas = []
+exe_exclude_binaries = True
+
+coll_binaries = a.binaries
+coll_zipfiles = a.zipfiles
+coll_datas = a.datas
+
+if platform.system() in ["Windows"]:
+    enable_console = True
+    exe_binaries = a.binaries
+    exe_zipfiles = a.zipfiles
+    exe_datas = a.datas
+    exe_exclude_binaries = False
+
+    coll_binaries = []
+    coll_zipfiles = []
+    coll_datas = []
+
+
+pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    exe_binaries,
+    exe_zipfiles,
+    exe_datas,
+    [],
+    exclude_binaries=exe_exclude_binaries,
+    name="comictagger",
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    runtime_tmpdir=None,
+    console=enable_console,
+    disable_windowed_traceback=False,
+    argv_emulation=False,
+    target_arch=None,
+    codesign_identity=None,
+    entitlements_file=None,
+    icon="windows/app.ico",
+)
+if platform.system() not in ["Windows"]:
+    coll = COLLECT(
+        exe,
+        coll_binaries,
+        coll_zipfiles,
+        coll_datas,
+        strip=False,
+        upx=True,
+        upx_exclude=[],
+        name="comictagger",
+    )
+    app = BUNDLE(
+        coll,
+        name="ComicTagger.app",
+        icon="mac/app.icns",
+        info_plist={
+            "NSHighResolutionCapable": "True",
+            "NSPrincipalClass": "NSApplication",
+            "NSRequiresAquaSystemAppearance": "False",
+            "CFBundleDisplayName": "ComicTagger",
+            "CFBundleShortVersionString": ctversion.version,
+            "CFBundleVersion": ctversion.version,
+            "CFBundleDocumentTypes": [
+                {
+                    "CFBundleTypeRole": "Editor",
+                    "LSHandlerRank": "Default",
+                    "LSItemContentTypes": [
+                        "public.folder",
+                    ],
+                    "CFBundleTypeName": "Folder",
+                },
+                {
+                    "CFBundleTypeExtensions": [
+                        "cbz",
+                    ],
+                    "LSTypeIsPackage": False,
+                    "NSPersistentStoreTypeKey": "Binary",
+                    "CFBundleTypeIconSystemGenerated": True,
+                    "CFBundleTypeName": "ZIP Comic Archive",
+                    "LSItemContentTypes": [
+                        "public.zip-comic-archive",
+                        "com.simplecomic.cbz-archive",
+                        "com.macitbetter.cbz-archive",
+                        "public.cbz-archive",
+                        "cx.c3.cbz-archive",
+                        "com.yacreader.yacreader.cbz",
+                        "com.milke.cbz-archive",
+                        "com.bitcartel.comicbooklover.cbz",
+                        "public.archive.cbz",
+                        "public.zip-archive",
+                    ],
+                    "CFBundleTypeRole": "Editor",
+                    "LSHandlerRank": "Default",
+                },
+                {
+                    "CFBundleTypeExtensions": [
+                        "cb7",
+                    ],
+                    "LSTypeIsPackage": False,
+                    "NSPersistentStoreTypeKey": "Binary",
+                    "CFBundleTypeIconSystemGenerated": True,
+                    "CFBundleTypeName": "7-Zip Comic Archive",
+                    "LSItemContentTypes": [
+                        "org.7-zip.7-zip-archive",
+                        "com.simplecomic.cb7-archive",
+                        "public.cb7-archive",
+                        "com.macitbetter.cb7-archive",
+                        "cx.c3.cb7-archive",
+                        "org.7-zip.7-zip-comic-archive",
+                    ],
+                    "CFBundleTypeRole": "Editor",
+                    "LSHandlerRank": "Default",
+                },
+                {
+                    "CFBundleTypeExtensions": [
+                        "cbr",
+                    ],
+                    "LSTypeIsPackage": False,
+                    "NSPersistentStoreTypeKey": "Binary",
+                    "CFBundleTypeIconSystemGenerated": True,
+                    "CFBundleTypeName": "RAR Comic Archive",
+                    "LSItemContentTypes": [
+                        "com.rarlab.rar-archive",
+                        "com.rarlab.rar-comic-archive",
+                        "com.simplecomic.cbr-archive",
+                        "com.macitbetter.cbr-archive",
+                        "public.cbr-archive",
+                        "cx.c3.cbr-archive",
+                        "com.bitcartel.comicbooklover.cbr",
+                        "com.milke.cbr-archive",
+                        "public.archive.cbr",
+                        "com.yacreader.yacreader.cbr",
+                    ],
+                    "CFBundleTypeRole": "Editor",
+                    "LSHandlerRank": "Default",
+                },
+            ],
+            "UTImportedTypeDeclarations": [
+                {
+                    "UTTypeIdentifier": "com.rarlab.rar-archive",
+                    "UTTypeDescription": "RAR Archive",
+                    "UTTypeConformsTo": [
+                        "public.data",
+                        "public.archive",
+                    ],
+                    "UTTypeTagSpecification": {
+                        "public.mime-type": [
+                            "application/x-rar",
+                            "application/x-rar-compressed",
+                        ],
+                        "public.filename-extension": [
+                            "rar",
+                        ],
+                    },
+                },
+                {
+                    "UTTypeConformsTo": [
+                        "public.data",
+                        "public.archive",
+                        "com.rarlab.rar-archive",
+                    ],
+                    "UTTypeIdentifier": "com.rarlab.rar-comic-archive",
+                    "UTTypeDescription": "RAR Comic Archive",
+                    "UTTypeTagSpecification": {
+                        "public.mime-type": [
+                            "application/vnd.comicbook-rar",
+                            "application/x-cbr",
+                        ],
+                        "public.filename-extension": [
+                            "cbr",
+                        ],
+                    },
+                },
+                {
+                    "UTTypeConformsTo": [
+                        "public.data",
+                        "public.archive",
+                        "public.zip-archive",
+                    ],
+                    "UTTypeIdentifier": "public.zip-comic-archive",
+                    "UTTypeDescription": "ZIP Comic Archive",
+                    "UTTypeTagSpecification": {
+                        "public.filename-extension": [
+                            "cbz",
+                        ],
+                    },
+                },
+                {
+                    "UTTypeConformsTo": [
+                        "public.data",
+                        "public.archive",
+                        "org.7-zip.7-zip-archive",
+                    ],
+                    "UTTypeIdentifier": "org.7-zip.7-zip-comic-archive",
+                    "UTTypeDescription": "7-Zip Comic Archive",
+                    "UTTypeTagSpecification": {
+                        "public.mime-type": [
+                            "application/vnd.comicbook+7-zip",
+                            "application/x-cb7-compressed",
+                        ],
+                        "public.filename-extension": [
+                            "cb7",
+                        ],
+                    },
+                },
+            ],
+        },
+        bundle_identifier="com.comictagger",
+    )

build-tools/dmgbuild.conf

@@ -0,0 +1,19 @@
+import pathlib
+
+app = "ComicTagger"
+app_name = f"{app}.app"
+path = f"dist/{app_name}"
+
+
+# dmgbuild settings
+format = 'ULMO'
+files = (str(path),)
+
+symlinks = {'Applications': '/Applications'}
+
+icon = pathlib.Path().cwd() / 'build-tools' / 'mac' / 'volume.icns'
+
+icon_locations = {
+    app_name: (100, 100),
+    'Applications': (300, 100)
+}

build-tools/generate_settngs.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+import os
+import pathlib
+
+import settngs
+
+import comictaggerlib.main
+
+
+def generate() -> str:
+    app = comictaggerlib.main.App()
+    app.load_plugins(app.initial_arg_parser.parse_known_args()[0])
+    app.register_settings(True)
+    imports, types = settngs.generate_dict(app.manager.definitions)
+    imports2, types2 = settngs.generate_ns(app.manager.definitions)
+    i = imports.splitlines()
+    i.extend(set(imports2.splitlines()) - set(i))
+    os.linesep
+    return (os.linesep * 2).join((os.linesep.join(i), types2, types))
+
+
+if __name__ == "__main__":
+    src = generate()
+    pathlib.Path("./comictaggerlib/ctsettings/settngs_namespace.py").write_text(src)
+    print(src, end="")

build-tools/get_appimage.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+import argparse
+import os
+import pathlib
+import platform
+
+try:
+    import niquests as requests
+except ImportError:
+    import requests
+
+arch = platform.machine()
+parser = argparse.ArgumentParser()
+parser.add_argument("APPIMAGETOOL", default=f"build/appimagetool-{arch}.AppImage", type=pathlib.Path, nargs="?")
+
+opts = parser.parse_args()
+opts.APPIMAGETOOL = opts.APPIMAGETOOL.absolute()
+
+
+def urlretrieve(url: str, dest: pathlib.Path) -> None:
+    resp = requests.get(url)
+    if resp.status_code == 200:
+        dest.parent.mkdir(parents=True, exist_ok=True)
+        dest.write_bytes(resp.content)
+
+
+if opts.APPIMAGETOOL.exists():
+    raise SystemExit(0)
+
+urlretrieve(
+    f"https://github.com/AppImage/appimagetool/releases/latest/download/appimagetool-{arch}.AppImage",
+    opts.APPIMAGETOOL,
+)
+os.chmod(opts.APPIMAGETOOL, 0o0700)
+
+if not opts.APPIMAGETOOL.exists():
+    raise SystemExit(1)

build-tools/mac/Makefile

@@ -1,26 +1,27 @@
-PYINSTALLER_CMD := python $(HOME)/pyinstaller-2.0/pyinstaller.py
-TAGGER_BASE := $(HOME)/Dropbox/tagger/comictagger
+PYINSTALLER_CMD := pyinstaller
+TAGGER_BASE ?= ../
+TAGGER_SRC := $(TAGGER_BASE)/comictaggerlib
 
 APP_NAME := ComicTagger
-VERSION_STR := $(shell grep version $(TAGGER_BASE)/ctversion.py| cut -d= -f2 | sed 's/\"//g')
-
-
+VERSION_STR := $(shell cd .. && python setup.py --version)
 
 MAC_BASE := $(TAGGER_BASE)/mac
 DIST_DIR := $(MAC_BASE)/dist
 STAGING := $(MAC_BASE)/$(APP_NAME)
 APP_BUNDLE := $(DIST_DIR)/$(APP_NAME).app
-VOLUME_NAME := $(APP_NAME)-$(VERSION_STR)
+VOLUME_NAME := "$(APP_NAME)-$(VERSION_STR)"
 DMG_FILE := $(VOLUME_NAME).dmg
 
 all: clean dist diskimage
 
 dist:
-	$(PYINSTALLER_CMD) $(TAGGER_BASE)/comictagger.py -o $(MAC_BASE) -w -n $(APP_NAME) -s 
-	cp $(TAGGER_BASE)/*.ui $(APP_BUNDLE)/Contents/MacOS
-	cp -a $(TAGGER_BASE)/graphics $(APP_BUNDLE)/Contents/MacOS
+	$(PYINSTALLER_CMD) $(TAGGER_BASE)/comictagger.py  -w -n $(APP_NAME) -s
+	cp -a $(TAGGER_SRC)/ui $(APP_BUNDLE)/Contents/MacOS
+	cp -a $(TAGGER_SRC)/graphics $(APP_BUNDLE)/Contents/MacOS
 	cp $(MAC_BASE)/app.icns $(APP_BUNDLE)/Contents/Resources/icon-windowed.icns
-	
+	# fix the version string in the Info.plist
+	sed -i -e 's/0\.0\.0/$(VERSION_STR)/' $(MAC_BASE)/dist/ComicTagger.app/Contents/Info.plist
+
 clean:
 	rm -rf $(DIST_DIR) $(MAC_BASE)/build
 	rm -f $(MAC_BASE)/*.spec
@@ -29,7 +30,7 @@ clean:
 	rm -f raw*.dmg
 	echo $(VERSION_STR)
 diskimage:
-	#Set up disk image staging folder
+	# Set up disk image staging folder
 	rm -rf $(STAGING)
 	mkdir $(STAGING)
 	cp $(TAGGER_BASE)/release_notes.txt $(STAGING)
@@ -38,27 +39,27 @@ diskimage:
 	cp $(MAC_BASE)/volume.icns $(STAGING)/.VolumeIcon.icns
 	SetFile -c icnC $(STAGING)/.VolumeIcon.icns
 
-	##generate raw disk image
+	# generate raw disk image
 	rm -f $(DMG_FILE)
-	hdiutil create -srcfolder $(STAGING) -volname $(VOLUME_NAME) -format UDRW -ov raw-$(DMG_FILE)	
+	hdiutil create -srcfolder $(STAGING) -volname $(VOLUME_NAME) -format UDRW -ov raw-$(DMG_FILE)
 
-	#remove working files and folders
+	# remove working files and folders
 	rm -rf $(STAGING)
-	
+
 	# we now have a raw DMG file.
-	
+
 	# remount it so we can set the volume icon properly
 	mkdir -p $(STAGING)
 	hdiutil attach raw-$(DMG_FILE) -mountpoint $(STAGING)
 	SetFile -a C $(STAGING)
 	hdiutil detach $(STAGING)
 	rm -rf $(STAGING)
-	
+
 	# convert the raw image
 	rm -f $(DMG_FILE)
 	hdiutil convert raw-$(DMG_FILE) -format UDZO -o $(DMG_FILE)
 	rm -f raw-$(DMG_FILE)
-	
-	#move finished product to release folder
+
+	# move finished product to release folder
+	mkdir -p $(TAGGER_BASE)/release
 	mv $(DMG_FILE) $(TAGGER_BASE)/release
-	

build-tools/mac/make_thin.sh

@@ -0,0 +1,21 @@
+rm -rf thin
+BINFOLDER=$1
+LIST=`cd $BINFOLDER; ls Qt* *.so *.dylib Python 2>/dev/null`
+for FILE in $LIST
+do
+	ISFAT=`lipo -info $BINFOLDER/$FILE|grep -v Non-fat`
+	if [ "$ISFAT" != "" ]
+	then
+		echo "Fat Binary:  $FILE"
+		mkdir -p thin
+		lipo -thin i386 -output thin/$FILE $BINFOLDER/$FILE
+	fi
+done
+
+if [ -d thin ]
+then
+	mv thin/* $BINFOLDER
+else
+	echo No files to lipo
+fi
+rm -rf thin

build-tools/oidc-exchange.py

@@ -0,0 +1,267 @@
+from __future__ import annotations
+
+import argparse
+import base64
+import json
+import os
+import sys
+from http import HTTPStatus
+from pathlib import Path
+from typing import NoReturn
+from urllib.parse import urlparse
+
+import keyring
+import requests
+from id import IdentityError, detect_credential
+
+_GITHUB_STEP_SUMMARY = Path(os.getenv("GITHUB_STEP_SUMMARY", "fail.txt"))
+
+# The top-level error message that gets rendered.
+# This message wraps one of the other templates/messages defined below.
+_ERROR_SUMMARY_MESSAGE = """
+Trusted publishing exchange failure:
+
+{message}
+
+You're seeing this because the action wasn't given the inputs needed to
+perform password-based or token-based authentication. If you intended to
+perform one of those authentication methods instead of trusted
+publishing, then you should double-check your secret configuration and variable
+names.
+
+Read more about trusted publishers at https://docs.pypi.org/trusted-publishers/
+
+Read more about how this action uses trusted publishers at
+https://github.com/marketplace/actions/pypi-publish#trusted-publishing
+"""
+
+# Rendered if OIDC identity token retrieval fails for any reason.
+_TOKEN_RETRIEVAL_FAILED_MESSAGE = """
+OpenID Connect token retrieval failed: {identity_error}
+
+This generally indicates a workflow configuration error, such as insufficient
+permissions. Make sure that your workflow has `id-token: write` configured
+at the job level, e.g.:
+
+```yaml
+permissions:
+  id-token: write
+```
+
+Learn more at https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#adding-permissions-settings.
+"""  # noqa: S105; not a password
+
+# Specialization of the token retrieval failure case, when we know that
+# the failure cause is use within a third-party PR.
+_TOKEN_RETRIEVAL_FAILED_FORK_PR_MESSAGE = """
+OpenID Connect token retrieval failed: {identity_error}
+
+The workflow context indicates that this action was called from a
+pull request on a fork. GitHub doesn't give these workflows OIDC permissions,
+even if `id-token: write` is explicitly configured.
+
+To fix this, change your publishing workflow to use an event that
+forks of your repository cannot trigger (such as tag or release
+creation, or a manually triggered workflow dispatch).
+"""  # noqa: S105; not a password
+
+# Rendered if the package index refuses the given OIDC token.
+_SERVER_REFUSED_TOKEN_EXCHANGE_MESSAGE = """
+Token request failed: the server refused the request for the following reasons:
+
+{reasons}
+
+This generally indicates a trusted publisher configuration error, but could
+also indicate an internal error on GitHub or PyPI's part.
+
+{rendered_claims}
+"""  # noqa: S105; not a password
+
+_RENDERED_CLAIMS = """
+The claims rendered below are **for debugging purposes only**. You should **not**
+use them to configure a trusted publisher unless they already match your expectations.
+
+If a claim is not present in the claim set, then it is rendered as `MISSING`.
+
+* `sub`: `{sub}`
+* `repository`: `{repository}`
+* `repository_owner`: `{repository_owner}`
+* `repository_owner_id`: `{repository_owner_id}`
+* `job_workflow_ref`: `{job_workflow_ref}`
+* `ref`: `{ref}`
+
+See https://docs.pypi.org/trusted-publishers/troubleshooting/ for more help.
+"""
+
+# Rendered if the package index's token response isn't valid JSON.
+_SERVER_TOKEN_RESPONSE_MALFORMED_JSON = """
+Token request failed: the index produced an unexpected
+{status_code} response.
+
+This strongly suggests a server configuration or downtime issue; wait
+a few minutes and try again.
+
+You can monitor PyPI's status here: https://status.python.org/
+"""  # noqa: S105; not a password
+
+# Rendered if the package index's token response isn't a valid API token payload.
+_SERVER_TOKEN_RESPONSE_MALFORMED_MESSAGE = """
+Token response error: the index gave us an invalid response.
+
+This strongly suggests a server configuration or downtime issue; wait
+a few minutes and try again.
+"""  # noqa: S105; not a password
+
+
+def die(msg: str) -> NoReturn:
+    with _GITHUB_STEP_SUMMARY.open("a", encoding="utf-8") as io:
+        print(_ERROR_SUMMARY_MESSAGE.format(message=msg), file=io)
+
+    # HACK: GitHub Actions' annotations don't work across multiple lines naively;
+    # translating `\n` into `%0A` (i.e., HTML percent-encoding) is known to work.
+    # See: https://github.com/actions/toolkit/issues/193
+    msg = msg.replace("\n", "%0A")
+    print(f"::error::Trusted publishing exchange failure: {msg}", file=sys.stderr)
+    sys.exit(1)
+
+
+def debug(msg: str) -> None:
+    print(f"::debug::{msg.title()}", file=sys.stderr)
+
+
+def assert_successful_audience_call(resp: requests.Response, domain: str) -> None:
+    if resp.ok:
+        return
+
+    if resp.status_code == HTTPStatus.FORBIDDEN:
+        # This index supports OIDC, but forbids the client from using
+        # it (either because it's disabled, ratelimited, etc.)
+        die(
+            f"audience retrieval failed: repository at {domain} has trusted publishing disabled",
+        )
+    elif resp.status_code == HTTPStatus.NOT_FOUND:
+        # This index does not support OIDC.
+        die(
+            f"audience retrieval failed: repository at {domain} does not indicate trusted publishing support",
+        )
+    else:
+        status = HTTPStatus(resp.status_code)
+        # Unknown: the index may or may not support OIDC, but didn't respond with
+        # something we expect. This can happen if the index is broken, in maintenance mode,
+        # misconfigured, etc.
+        die(
+            f"audience retrieval failed: repository at {domain} responded with unexpected {resp.status_code}: {status.phrase}",
+        )
+
+
+def render_claims(token: str) -> str:
+    _, payload, _ = token.split(".", 2)
+
+    # urlsafe_b64decode needs padding; JWT payloads don't contain any.
+    payload += "=" * (4 - (len(payload) % 4))
+    claims = json.loads(base64.urlsafe_b64decode(payload))
+
+    def _get(name: str) -> str:
+        return claims.get(name, "MISSING")
+
+    return _RENDERED_CLAIMS.format(
+        sub=_get("sub"),
+        repository=_get("repository"),
+        repository_owner=_get("repository_owner"),
+        repository_owner_id=_get("repository_owner_id"),
+        job_workflow_ref=_get("job_workflow_ref"),
+        ref=_get("ref"),
+    )
+
+
+def event_is_third_party_pr() -> bool:
+    # Non-`pull_request` events cannot be from third-party PRs.
+    if os.getenv("GITHUB_EVENT_NAME") != "pull_request":
+        return False
+
+    event_path = os.getenv("GITHUB_EVENT_PATH")
+    if not event_path:
+        # No GITHUB_EVENT_PATH indicates a weird GitHub or runner bug.
+        debug("unexpected: no GITHUB_EVENT_PATH to check")
+        return False
+
+    try:
+        event = json.loads(Path(event_path).read_bytes())
+    except json.JSONDecodeError:
+        debug("unexpected: GITHUB_EVENT_PATH does not contain valid JSON")
+        return False
+
+    try:
+        return event["pull_request"]["head"]["repo"]["fork"]
+    except KeyError:
+        return False
+
+
+parser = argparse.ArgumentParser()
+parser.add_argument("repository_url", default="https://upload.pypi.org/legacy/", type=urlparse, nargs="?")
+
+opts = parser.parse_args()
+repository_domain = opts.repository_url.netloc
+token_exchange_url = f"https://{repository_domain}/_/oidc/mint-token"
+
+# Indices are expected to support `https://{domain}/_/oidc/audience`,
+# which tells OIDC exchange clients which audience to use.
+audience_url = f"https://{repository_domain}/_/oidc/audience"
+audience_resp = requests.get(audience_url, timeout=5)
+assert_successful_audience_call(audience_resp, repository_domain)
+
+oidc_audience = audience_resp.json()["audience"]
+
+debug(f"selected trusted publishing exchange endpoint: {token_exchange_url}")
+
+try:
+    oidc_token = detect_credential(audience=oidc_audience)
+except IdentityError as identity_error:
+    cause_msg_tmpl = (
+        _TOKEN_RETRIEVAL_FAILED_FORK_PR_MESSAGE if event_is_third_party_pr() else _TOKEN_RETRIEVAL_FAILED_MESSAGE
+    )
+    for_cause_msg = cause_msg_tmpl.format(identity_error=identity_error)
+    die(for_cause_msg)
+if not oidc_token:
+    die("Unabled to detect credentials. Is this runnnig in CI?")
+
+# Now we can do the actual token exchange.
+mint_token_resp = requests.post(
+    token_exchange_url,
+    json={"token": oidc_token},
+    timeout=5,
+)
+
+try:
+    mint_token_payload = mint_token_resp.json()
+except requests.JSONDecodeError:
+    # Token exchange failure normally produces a JSON error response, but
+    # we might have hit a server error instead.
+    die(
+        _SERVER_TOKEN_RESPONSE_MALFORMED_JSON.format(
+            status_code=mint_token_resp.status_code,
+        ),
+    )
+
+# On failure, the JSON response includes the list of errors that
+# occurred during minting.
+if not mint_token_resp.ok:
+    reasons = "\n".join(f'* `{error["code"]}`: {error["description"]}' for error in mint_token_payload["errors"])
+
+    rendered_claims = render_claims(oidc_token)
+
+    die(
+        _SERVER_REFUSED_TOKEN_EXCHANGE_MESSAGE.format(
+            reasons=reasons,
+            rendered_claims=rendered_claims,
+        ),
+    )
+
+pypi_token = mint_token_payload.get("token")
+if pypi_token is None:
+    die(_SERVER_TOKEN_RESPONSE_MALFORMED_MESSAGE)
+
+# Mask the newly minted PyPI token, so that we don't accidentally leak it in logs.
+print(f"::add-mask::{pypi_token}", file=sys.stderr)
+
+keyring.set_password(opts.repository_url.geturl(), "__token__", pypi_token)

build-tools/zip_artifacts.py

@@ -0,0 +1,85 @@
+from __future__ import annotations
+
+import os
+import pathlib
+import platform
+import sys
+import tarfile
+import zipfile
+
+from comictaggerlib.ctversion import __version__
+
+
+def addToZip(zf: zipfile.ZipFile, path: str, zippath: str) -> None:
+    if os.path.isfile(path):
+        zf.write(path, zippath)
+    elif os.path.isdir(path):
+        if zippath:
+            zf.write(path, zippath)
+        for nm in sorted(os.listdir(path)):
+            addToZip(zf, os.path.join(path, nm), os.path.join(zippath, nm))
+
+
+def Zip(zip_file: pathlib.Path, path: pathlib.Path) -> None:
+    zip_file.unlink(missing_ok=True)
+    with zipfile.ZipFile(f"{zip_file}.zip", "w", compression=zipfile.ZIP_DEFLATED, compresslevel=8) as zf:
+        zippath = os.path.basename(path)
+        if not zippath:
+            zippath = os.path.basename(os.path.dirname(path))
+        if zippath in ("", os.curdir, os.pardir):
+            zippath = ""
+        addToZip(zf, str(path), zippath)
+
+
+def addToTar(tf: tarfile.TarFile, path: str, zippath: str) -> None:
+    if os.path.isfile(path):
+        tf.add(path, zippath)
+    elif os.path.isdir(path):
+        if zippath:
+            tf.add(path, zippath, recursive=False)
+        for nm in sorted(os.listdir(path)):
+            addToTar(tf, os.path.join(path, nm), os.path.join(zippath, nm))
+
+
+def Tar(tar_file: pathlib.Path, path: pathlib.Path) -> None:
+    tar_file.unlink(missing_ok=True)
+    with tarfile.open(f"{tar_file}.tar.gz", "w:gz") as tf:
+        zippath = os.path.basename(path)
+        if not zippath:
+            zippath = os.path.basename(os.path.dirname(path))
+        if zippath in ("", os.curdir, os.pardir):
+            zippath = ""
+        addToTar(tf, str(path), zippath)
+
+
+if __name__ == "__main__":
+    app = "ComicTagger"
+    exe = app.casefold()
+    final_name = f"{app}-{__version__}-{platform.system()}-{platform.machine()}"
+    if platform.system() == "Windows":
+        exe = f"{exe}.exe"
+    elif platform.system() == "Darwin":
+        exe = f"{app}.app"
+        ver = platform.mac_ver()
+        final_name = f"{app}-{__version__}-macOS-{ver[0]}-{ver[2]}"
+
+    path = pathlib.Path(f"dist/{exe}")
+    binary_path = pathlib.Path("dist/binary")
+    binary_path.mkdir(parents=True, exist_ok=True)
+    archive_destination = binary_path / final_name
+
+    if platform.system() == "Darwin":
+        from dmgbuild.__main__ import main as dmg_main
+
+        sys.argv = [
+            "zip_artifacts",
+            "-s",
+            str(pathlib.Path(__file__).parent / "dmgbuild.conf"),
+            f"{app} {__version__}",
+            f"{archive_destination}.dmg",
+        ]
+        dmg_main()
+    elif platform.system() == "Windows":
+        Zip(archive_destination, path)
+    else:
+        Tar(archive_destination, path)

cbltransformer.py

@@ -1,99 +0,0 @@
-"""
-Class to manage modifying metadata specifically for CBL/CBI
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-import os
-import utils
-
-
-class CBLTransformer:
-	def __init__( self, metadata, settings ):
-		self.metadata = metadata
-		self.settings = settings
-
-	
-	def apply( self ):
-		# helper funcs
-		def append_to_tags_if_unique( item ):
-			if item.lower() not in (tag.lower() for tag in self.metadata.tags):
-				self.metadata.tags.append( item )
-				
-		def add_string_list_to_tags( str_list ):
-			if str_list is not None and str_list != "":
-				items = [ s.strip() for s in str_list.split(',') ]
-				for item in items:
-					append_to_tags_if_unique( item )
-
-		if self.settings.assume_lone_credit_is_primary:
-		
-			# helper
-			def setLonePrimary( role_list ):
-				lone_credit = None
-				count = 0
-				for c in self.metadata.credits:
-					if c['role'].lower() in role_list:
-						count += 1
-						lone_credit = c
-					if count > 1:
-						lone_credit = None
-						break
-				if lone_credit is not None:
-					lone_credit['primary'] = True
-				return lone_credit, count
-				
-			#need to loop three times, once for 'writer', 'artist', and then 'penciler' if no artist
-			setLonePrimary( ['writer'] )
-			c, count = setLonePrimary( ['artist'] )
-			if c is None and count == 0:
-				c, count = setLonePrimary( ['penciler', 'penciller'] )
-				if c is not None:
-					c['primary'] = False
-					self.metadata.addCredit( c['person'], 'Artist', True )		
-
-		if self.settings.copy_characters_to_tags:
-			add_string_list_to_tags( self.metadata.characters )
-
-		if self.settings.copy_teams_to_tags:
-			add_string_list_to_tags( self.metadata.teams )
-			
-		if self.settings.copy_locations_to_tags:
-			add_string_list_to_tags( self.metadata.locations )
-			
-		if self.settings.copy_notes_to_comments:
-			if self.metadata.notes is not None:
-				if self.metadata.comments is None:
-					self.metadata.comments = ""
-				else:
-					self.metadata.comments += "\n\n"
-				if self.metadata.notes not in self.metadata.comments:
-					self.metadata.comments += self.metadata.notes
-
-		if self.settings.copy_weblink_to_comments:
-			if self.metadata.webLink is not None:
-				if self.metadata.comments is None:
-					self.metadata.comments = ""
-				else:
-					self.metadata.comments += "\n\n"
-				if self.metadata.webLink not in self.metadata.comments:
-					self.metadata.comments += self.metadata.webLink
-
-		return self.metadata
-
-	
-	

comet.py

@@ -1,260 +0,0 @@
-"""
-A python class to encapsulate CoMet data 
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-from datetime import datetime
-import zipfile
-from pprint import pprint 
-import xml.etree.ElementTree as ET
-from genericmetadata import GenericMetadata
-import utils
-
-class CoMet:
-	
-	writer_synonyms = ['writer', 'plotter', 'scripter']
-	penciller_synonyms = [ 'artist', 'penciller', 'penciler', 'breakdowns' ]
-	inker_synonyms = [ 'inker', 'artist', 'finishes' ]
-	colorist_synonyms = [ 'colorist', 'colourist', 'colorer', 'colourer' ]
-	letterer_synonyms = [ 'letterer']
-	cover_synonyms = [ 'cover', 'covers', 'coverartist', 'cover artist' ]
-	editor_synonyms = [ 'editor']
-		
-	def metadataFromString( self, string ):
-
-		tree = ET.ElementTree(ET.fromstring( string ))
-		return self.convertXMLToMetadata( tree )
-
-	def stringFromMetadata( self, metadata ):
-
-		header = '<?xml version="1.0" encoding="UTF-8"?>\n'
-		
-		tree = self.convertMetadataToXML( self, metadata )
-		return header + ET.tostring(tree.getroot())
-
-	def indent( self, elem, level=0 ):
-		# for making the XML output readable
-		i = "\n" + level*"  "
-		if len(elem):
-			if not elem.text or not elem.text.strip():
-				elem.text = i + "  "
-			if not elem.tail or not elem.tail.strip():
-				elem.tail = i
-			for elem in elem:
-				self.indent( elem, level+1 )
-			if not elem.tail or not elem.tail.strip():
-				elem.tail = i
-		else:
-			if level and (not elem.tail or not elem.tail.strip()):
-				elem.tail = i
-	
-	def convertMetadataToXML( self, filename, metadata ):
-
-		#shorthand for the metadata
-		md = metadata
-
-		# build a tree structure
-		root = ET.Element("comet")
-		root.attrib['xmlns:comet'] = "http://www.denvog.com/comet/"
-		root.attrib['xmlns:xsi'] = "http://www.w3.org/2001/XMLSchema-instance"
-		root.attrib['xsi:schemaLocation'] = "http://www.denvog.com http://www.denvog.com/comet/comet.xsd"
-		
-		#helper func
-		def assign( comet_entry, md_entry):
-			if md_entry is not None:
-				ET.SubElement(root, comet_entry).text = u"{0}".format(md_entry)
-		
-		# title is manditory
-		if md.title is None:
-			md.title = ""
-		assign( 'title', md.title )
-		assign( 'series', md.series )
-		assign( 'issue', md.issue )  #must be int??
-		assign( 'volume', md.volume )
-		assign( 'description', md.comments )
-		assign( 'publisher', md.publisher )
-		assign( 'pages', md.pageCount )
-		assign( 'format', md.format )
-		assign( 'language', md.language )
-		assign( 'rating', md.maturityRating )
-		assign( 'price', md.price )
-		assign( 'isVersionOf', md.isVersionOf )
-		assign( 'rights', md.rights )
-		assign( 'identifier', md.identifier )
-		assign( 'lastMark', md.lastMark )		
-		assign( 'genre', md.genre )   # TODO repeatable
-
-		if md.characters is not None:
-			char_list = [ c.strip() for c in md.characters.split(',') ]
-			for c in char_list:
-				assign( 'character', c ) 
-			
-		if md.manga is not None and md.manga == "YesAndRightToLeft":
-			assign( 'readingDirection', "rtl")
-		
-		date_str = ""
-		if md.year is not None:
-			date_str = str(md.year).zfill(4) 
-			if md.month is not None:
-				date_str += "-" + str(md.month).zfill(2)
-			assign( 'date', date_str )  
-
-		assign( 'coverImage', md.coverImage )
-
-		# need to specially process the credits, since they are structured differently than CIX	
-		credit_writer_list    = list()
-		credit_penciller_list = list()
-		credit_inker_list     = list()
-		credit_colorist_list  = list()
-		credit_letterer_list  = list()
-		credit_cover_list     = list()
-		credit_editor_list    = list()
-		
-		#  loop thru credits, and build a list for each role that CoMet supports
-		for credit in metadata.credits:
-
-			if credit['role'].lower() in set( self.writer_synonyms ):
-				ET.SubElement(root, 'writer').text = u"{0}".format(credit['person'])
-
-			if credit['role'].lower() in set( self.penciller_synonyms ):
-				ET.SubElement(root, 'penciller').text = u"{0}".format(credit['person'])
-				
-			if credit['role'].lower() in set( self.inker_synonyms ):
-				ET.SubElement(root, 'inker').text = u"{0}".format(credit['person'])
-				
-			if credit['role'].lower() in set( self.colorist_synonyms ):
-				ET.SubElement(root, 'colorist').text = u"{0}".format(credit['person'])
-
-			if credit['role'].lower() in set( self.letterer_synonyms ):
-				ET.SubElement(root, 'letterer').text = u"{0}".format(credit['person'])
-
-			if credit['role'].lower() in set( self.cover_synonyms ):
-				ET.SubElement(root, 'coverDesigner').text = u"{0}".format(credit['person'])
-
-			if credit['role'].lower() in set( self.editor_synonyms ):
-				ET.SubElement(root, 'editor').text = u"{0}".format(credit['person'])
-		
-
-		# self pretty-print
-		self.indent(root)
-
-		# wrap it in an ElementTree instance, and save as XML
-		tree = ET.ElementTree(root)
-		return tree
-				 
-
-	def convertXMLToMetadata( self, tree ):
-			
-		root = tree.getroot()
-
-		if root.tag != 'comet':
-			raise 1
-			return None
-
-		metadata = GenericMetadata()
-		md = metadata
-	
-		# Helper function
-		def xlate( tag ):
-			node = root.find( tag )
-			if node is not None:
-				return node.text
-			else:
-				return None
-				
-		md.series =           xlate( 'series' )
-		md.title =            xlate( 'title' )
-		md.issue =            xlate( 'issue' )
-		md.volume =           xlate( 'volume' )
-		md.comments =         xlate( 'description' )
-		md.publisher =        xlate( 'publisher' )
-		md.language =         xlate( 'language' )
-		md.format =           xlate( 'format' )
-		md.pageCount =        xlate( 'pages' )
-		md.maturityRating =   xlate( 'rating' )
-		md.price =            xlate( 'price' )
-		md.isVersionOf =      xlate( 'isVersionOf' )
-		md.rights =           xlate( 'rights' )
-		md.identifier =       xlate( 'identifier' )
-		md.lastMark =         xlate( 'lastMark' )
-		md.genre =            xlate( 'genre' ) # TODO - repeatable field
-
-		date = xlate( 'date' )
-		if date is not None:
-			parts = date.split('-')
-			if len( parts) > 0:
-				md.year = parts[0]
-			if len( parts) > 1:
-				md.month = parts[1]
-				
-		md.coverImage = xlate( 'coverImage' )
-		
-		readingDirection = xlate( 'readingDirection' )
-		if readingDirection is not None and readingDirection == "rtl":
-			md.manga = "YesAndRightToLeft"
-	
-		# loop for character tags		
-		char_list =  []
-		for n in root:
-			if n.tag == 'character':
-				char_list.append(n.text.strip())
-		md.characters = utils.listToString( char_list )
-
-		# Now extract the credit info
-		for n in root:
-			if (  n.tag == 'writer' or 
-				n.tag == 'penciller' or
-				n.tag == 'inker' or
-				n.tag == 'colorist' or
-				n.tag == 'letterer' or
-				n.tag == 'editor' 
-			):
-				metadata.addCredit( n.text.strip(), n.tag.title() )
-
-			if n.tag == 'coverDesigner':
-				metadata.addCredit( n.text.strip(), "Cover" )
-
-
-		metadata.isEmpty = False
-		
-		return metadata
-
-	#verify that the string actually contains CoMet data in XML format
-	def validateString( self, string ):
-		try:
-			tree = ET.ElementTree(ET.fromstring( string ))
-			root = tree.getroot()
-			if root.tag != 'comet':
-				raise Exception
-		except:
-			return False
-		
-		return True
-
-
-	def writeToExternalFile( self, filename, metadata ):
-		
-		tree = self.convertMetadataToXML( self, metadata )
-		#ET.dump(tree)		
-		tree.write(filename, encoding='utf-8')
-	
-	def readFromExternalFile( self, filename ):
-
-		tree = ET.parse( filename )
-		return self.convertXMLToMetadata( tree )
-

comicapi/__init__.py

@@ -0,0 +1,3 @@
+from __future__ import annotations
+
+__author__ = "dromanin"

comicapi/__pyinstaller/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+import os
+
+
+def get_hook_dirs() -> list[str]:
+    return [os.path.dirname(__file__)]

comicapi/__pyinstaller/hook-comicapi.py

@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from PyInstaller.utils.hooks import collect_data_files, collect_entry_point
+
+datas, hiddenimports = collect_entry_point("comicapi.archiver")
+mdatas, mhiddenimports = collect_entry_point("comicapi.tags")
+
+hiddenimports += mhiddenimports
+datas += mdatas
+datas += collect_data_files("comicapi.data")

comicapi/_url.py

@@ -0,0 +1,468 @@
+# mypy: disable-error-code="no-redef"
+from __future__ import annotations
+
+try:
+    from urllib3.exceptions import HTTPError, LocationParseError, LocationValueError
+    from urllib3.util import Url, parse_url
+except ImportError:
+
+    import re
+    import typing
+
+    class HTTPError(Exception):
+        """Base exception used by this module."""
+
+    class LocationValueError(ValueError, HTTPError):
+        """Raised when there is something wrong with a given URL input."""
+
+    class LocationParseError(LocationValueError):
+        """Raised when get_host or similar fails to parse the URL input."""
+
+        def __init__(self, location: str) -> None:
+            message = f"Failed to parse: {location}"
+            super().__init__(message)
+
+            self.location = location
+
+    def to_str(x: str | bytes, encoding: str | None = None, errors: str | None = None) -> str:
+        if isinstance(x, str):
+            return x
+        elif not isinstance(x, bytes):
+            raise TypeError(f"not expecting type {type(x).__name__}")
+        if encoding or errors:
+            return x.decode(encoding or "utf-8", errors=errors or "strict")
+        return x.decode()
+
+    # We only want to normalize urls with an HTTP(S) scheme.
+    # urllib3 infers URLs without a scheme (None) to be http.
+    _NORMALIZABLE_SCHEMES = ("http", "https", None)
+
+    # Almost all of these patterns were derived from the
+    # 'rfc3986' module: https://github.com/python-hyper/rfc3986
+    _PERCENT_RE = re.compile(r"%[a-fA-F0-9]{2}")
+    _SCHEME_RE = re.compile(r"^(?:[a-zA-Z][a-zA-Z0-9+-]*:|/)")
+    _URI_RE = re.compile(
+        r"^(?:([a-zA-Z][a-zA-Z0-9+.-]*):)?" r"(?://([^\\/?#]*))?" r"([^?#]*)" r"(?:\?([^#]*))?" r"(?:#(.*))?$",
+        re.UNICODE | re.DOTALL,
+    )
+
+    _IPV4_PAT = r"(?:[0-9]{1,3}\.){3}[0-9]{1,3}"
+    _HEX_PAT = "[0-9A-Fa-f]{1,4}"
+    _LS32_PAT = "(?:{hex}:{hex}|{ipv4})".format(hex=_HEX_PAT, ipv4=_IPV4_PAT)
+    _subs = {"hex": _HEX_PAT, "ls32": _LS32_PAT}
+    _variations = [
+        #                            6( h16 ":" ) ls32
+        "(?:%(hex)s:){6}%(ls32)s",
+        #                       "::" 5( h16 ":" ) ls32
+        "::(?:%(hex)s:){5}%(ls32)s",
+        # [               h16 ] "::" 4( h16 ":" ) ls32
+        "(?:%(hex)s)?::(?:%(hex)s:){4}%(ls32)s",
+        # [ *1( h16 ":" ) h16 ] "::" 3( h16 ":" ) ls32
+        "(?:(?:%(hex)s:)?%(hex)s)?::(?:%(hex)s:){3}%(ls32)s",
+        # [ *2( h16 ":" ) h16 ] "::" 2( h16 ":" ) ls32
+        "(?:(?:%(hex)s:){0,2}%(hex)s)?::(?:%(hex)s:){2}%(ls32)s",
+        # [ *3( h16 ":" ) h16 ] "::"    h16 ":"   ls32
+        "(?:(?:%(hex)s:){0,3}%(hex)s)?::%(hex)s:%(ls32)s",
+        # [ *4( h16 ":" ) h16 ] "::"              ls32
+        "(?:(?:%(hex)s:){0,4}%(hex)s)?::%(ls32)s",
+        # [ *5( h16 ":" ) h16 ] "::"              h16
+        "(?:(?:%(hex)s:){0,5}%(hex)s)?::%(hex)s",
+        # [ *6( h16 ":" ) h16 ] "::"
+        "(?:(?:%(hex)s:){0,6}%(hex)s)?::",
+    ]
+
+    _UNRESERVED_PAT = r"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._\-~"
+    _IPV6_PAT = "(?:" + "|".join([x % _subs for x in _variations]) + ")"
+    _ZONE_ID_PAT = "(?:%25|%)(?:[" + _UNRESERVED_PAT + "]|%[a-fA-F0-9]{2})+"
+    _IPV6_ADDRZ_PAT = r"\[" + _IPV6_PAT + r"(?:" + _ZONE_ID_PAT + r")?\]"
+    _REG_NAME_PAT = r"(?:[^\[\]%:/?#]|%[a-fA-F0-9]{2})*"
+    _TARGET_RE = re.compile(r"^(/[^?#]*)(?:\?([^#]*))?(?:#.*)?$")
+
+    _IPV4_RE = re.compile("^" + _IPV4_PAT + "$")
+    _IPV6_RE = re.compile("^" + _IPV6_PAT + "$")
+    _IPV6_ADDRZ_RE = re.compile("^" + _IPV6_ADDRZ_PAT + "$")
+    _BRACELESS_IPV6_ADDRZ_RE = re.compile("^" + _IPV6_ADDRZ_PAT[2:-2] + "$")
+    _ZONE_ID_RE = re.compile("(" + _ZONE_ID_PAT + r")\]$")
+
+    _HOST_PORT_PAT = ("^(%s|%s|%s)(?::0*?(|0|[1-9][0-9]{0,4}))?$") % (
+        _REG_NAME_PAT,
+        _IPV4_PAT,
+        _IPV6_ADDRZ_PAT,
+    )
+    _HOST_PORT_RE = re.compile(_HOST_PORT_PAT, re.UNICODE | re.DOTALL)
+
+    _UNRESERVED_CHARS = set("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789._-~")
+    _SUB_DELIM_CHARS = set("!$&'()*+,;=")
+    _USERINFO_CHARS = _UNRESERVED_CHARS | _SUB_DELIM_CHARS | {":"}
+    _PATH_CHARS = _USERINFO_CHARS | {"@", "/"}
+    _QUERY_CHARS = _FRAGMENT_CHARS = _PATH_CHARS | {"?"}
+
+    class Url(
+        typing.NamedTuple(
+            "Url",
+            [
+                ("scheme", typing.Optional[str]),
+                ("auth", typing.Optional[str]),
+                ("host", typing.Optional[str]),
+                ("port", typing.Optional[int]),
+                ("path", typing.Optional[str]),
+                ("query", typing.Optional[str]),
+                ("fragment", typing.Optional[str]),
+            ],
+        )
+    ):
+        """
+        Data structure for representing an HTTP URL. Used as a return value for
+        :func:`parse_url`. Both the scheme and host are normalized as they are
+        both case-insensitive according to RFC 3986.
+        """
+
+        def __new__(  # type: ignore[no-untyped-def]
+            cls,
+            scheme: str | None = None,
+            auth: str | None = None,
+            host: str | None = None,
+            port: int | None = None,
+            path: str | None = None,
+            query: str | None = None,
+            fragment: str | None = None,
+        ):
+            if path and not path.startswith("/"):
+                path = "/" + path
+            if scheme is not None:
+                scheme = scheme.lower()
+            return super().__new__(cls, scheme, auth, host, port, path, query, fragment)
+
+        @property
+        def hostname(self) -> str | None:
+            """For backwards-compatibility with urlparse. We're nice like that."""
+            return self.host
+
+        @property
+        def request_uri(self) -> str:
+            """Absolute path including the query string."""
+            uri = self.path or "/"
+
+            if self.query is not None:
+                uri += "?" + self.query
+
+            return uri
+
+        @property
+        def authority(self) -> str | None:
+            """
+            Authority component as defined in RFC 3986 3.2.
+            This includes userinfo (auth), host and port.
+
+            i.e.
+                userinfo@host:port
+            """
+            userinfo = self.auth
+            netloc = self.netloc
+            if netloc is None or userinfo is None:
+                return netloc
+            else:
+                return f"{userinfo}@{netloc}"
+
+        @property
+        def netloc(self) -> str | None:
+            """
+            Network location including host and port.
+
+            If you need the equivalent of urllib.parse's ``netloc``,
+            use the ``authority`` property instead.
+            """
+            if self.host is None:
+                return None
+            if self.port:
+                return f"{self.host}:{self.port}"
+            return self.host
+
+        @property
+        def url(self) -> str:
+            """
+            Convert self into a url
+
+            This function should more or less round-trip with :func:`.parse_url`. The
+            returned url may not be exactly the same as the url inputted to
+            :func:`.parse_url`, but it should be equivalent by the RFC (e.g., urls
+            with a blank port will have : removed).
+
+            Example:
+
+            .. code-block:: python
+
+                import urllib3
+
+                U = urllib3.util.parse_url("https://google.com/mail/")
+
+                print(U.url)
+                # "https://google.com/mail/"
+
+                print( urllib3.util.Url("https", "username:password",
+                                        "host.com", 80, "/path", "query", "fragment"
+                                        ).url
+                    )
+                # "https://username:password@host.com:80/path?query#fragment"
+            """
+            scheme, auth, host, port, path, query, fragment = self
+            url = ""
+
+            # We use "is not None" we want things to happen with empty strings (or 0 port)
+            if scheme is not None:
+                url += scheme + "://"
+            if auth is not None:
+                url += auth + "@"
+            if host is not None:
+                url += host
+            if port is not None:
+                url += ":" + str(port)
+            if path is not None:
+                url += path
+            if query is not None:
+                url += "?" + query
+            if fragment is not None:
+                url += "#" + fragment
+
+            return url
+
+        def __str__(self) -> str:
+            return self.url
+
+    @typing.overload
+    def _encode_invalid_chars(component: str, allowed_chars: typing.Container[str]) -> str:  # Abstract
+        ...
+
+    @typing.overload
+    def _encode_invalid_chars(component: None, allowed_chars: typing.Container[str]) -> None:  # Abstract
+        ...
+
+    def _encode_invalid_chars(component: str | None, allowed_chars: typing.Container[str]) -> str | None:
+        """Percent-encodes a URI component without reapplying
+        onto an already percent-encoded component.
+        """
+        if component is None:
+            return component
+
+        component = to_str(component)
+
+        # Normalize existing percent-encoded bytes.
+        # Try to see if the component we're encoding is already percent-encoded
+        # so we can skip all '%' characters but still encode all others.
+        component, percent_encodings = _PERCENT_RE.subn(lambda match: match.group(0).upper(), component)
+
+        uri_bytes = component.encode("utf-8", "surrogatepass")
+        is_percent_encoded = percent_encodings == uri_bytes.count(b"%")
+        encoded_component = bytearray()
+
+        for i in range(0, len(uri_bytes)):
+            # Will return a single character bytestring
+            byte = uri_bytes[i : i + 1]
+            byte_ord = ord(byte)
+            if (is_percent_encoded and byte == b"%") or (byte_ord < 128 and byte.decode() in allowed_chars):
+                encoded_component += byte
+                continue
+            encoded_component.extend(b"%" + (hex(byte_ord)[2:].encode().zfill(2).upper()))
+
+        return encoded_component.decode()
+
+    def _remove_path_dot_segments(path: str) -> str:
+        # See http://tools.ietf.org/html/rfc3986#section-5.2.4 for pseudo-code
+        segments = path.split("/")  # Turn the path into a list of segments
+        output = []  # Initialize the variable to use to store output
+
+        for segment in segments:
+            # '.' is the current directory, so ignore it, it is superfluous
+            if segment == ".":
+                continue
+            # Anything other than '..', should be appended to the output
+            if segment != "..":
+                output.append(segment)
+            # In this case segment == '..', if we can, we should pop the last
+            # element
+            elif output:
+                output.pop()
+
+        # If the path starts with '/' and the output is empty or the first string
+        # is non-empty
+        if path.startswith("/") and (not output or output[0]):
+            output.insert(0, "")
+
+        # If the path starts with '/.' or '/..' ensure we add one more empty
+        # string to add a trailing '/'
+        if path.endswith(("/.", "/..")):
+            output.append("")
+
+        return "/".join(output)
+
+    @typing.overload
+    def _normalize_host(host: None, scheme: str | None) -> None: ...
+
+    @typing.overload
+    def _normalize_host(host: str, scheme: str | None) -> str: ...
+
+    def _normalize_host(host: str | None, scheme: str | None) -> str | None:
+        if host:
+            if scheme in _NORMALIZABLE_SCHEMES:
+                is_ipv6 = _IPV6_ADDRZ_RE.match(host)
+                if is_ipv6:
+                    # IPv6 hosts of the form 'a::b%zone' are encoded in a URL as
+                    # such per RFC 6874: 'a::b%25zone'. Unquote the ZoneID
+                    # separator as necessary to return a valid RFC 4007 scoped IP.
+                    match = _ZONE_ID_RE.search(host)
+                    if match:
+                        start, end = match.span(1)
+                        zone_id = host[start:end]
+
+                        if zone_id.startswith("%25") and zone_id != "%25":
+                            zone_id = zone_id[3:]
+                        else:
+                            zone_id = zone_id[1:]
+                        zone_id = _encode_invalid_chars(zone_id, _UNRESERVED_CHARS)
+                        return f"{host[:start].lower()}%{zone_id}{host[end:]}"
+                    else:
+                        return host.lower()
+                elif not _IPV4_RE.match(host):
+                    return to_str(
+                        b".".join([_idna_encode(label) for label in host.split(".")]),
+                        "ascii",
+                    )
+        return host
+
+    def _idna_encode(name: str) -> bytes:
+        if not name.isascii():
+            try:
+                import idna
+            except ImportError:
+                raise LocationParseError("Unable to parse URL without the 'idna' module") from None
+
+            try:
+                return idna.encode(name.lower(), strict=True, std3_rules=True)
+            except idna.IDNAError:
+                raise LocationParseError(f"Name '{name}' is not a valid IDNA label") from None
+
+        return name.lower().encode("ascii")
+
+    def _encode_target(target: str) -> str:
+        """Percent-encodes a request target so that there are no invalid characters
+
+        Pre-condition for this function is that 'target' must start with '/'.
+        If that is the case then _TARGET_RE will always produce a match.
+        """
+        match = _TARGET_RE.match(target)
+        if not match:  # Defensive:
+            raise LocationParseError(f"{target!r} is not a valid request URI")
+
+        path, query = match.groups()
+        encoded_target = _encode_invalid_chars(path, _PATH_CHARS)
+        if query is not None:
+            query = _encode_invalid_chars(query, _QUERY_CHARS)
+            encoded_target += "?" + query
+        return encoded_target
+
+    def parse_url(url: str) -> Url:
+        """
+        Given a url, return a parsed :class:`.Url` namedtuple. Best-effort is
+        performed to parse incomplete urls. Fields not provided will be None.
+        This parser is RFC 3986 and RFC 6874 compliant.
+
+        The parser logic and helper functions are based heavily on
+        work done in the ``rfc3986`` module.
+
+        :param str url: URL to parse into a :class:`.Url` namedtuple.
+
+        Partly backwards-compatible with :mod:`urllib.parse`.
+
+        Example:
+
+        .. code-block:: python
+
+            import urllib3
+
+            print( urllib3.util.parse_url('http://google.com/mail/'))
+            # Url(scheme='http', host='google.com', port=None, path='/mail/', ...)
+
+            print( urllib3.util.parse_url('google.com:80'))
+            # Url(scheme=None, host='google.com', port=80, path=None, ...)
+
+            print( urllib3.util.parse_url('/foo?bar'))
+            # Url(scheme=None, host=None, port=None, path='/foo', query='bar', ...)
+        """
+        if not url:
+            # Empty
+            return Url()
+
+        source_url = url
+        if not _SCHEME_RE.search(url):
+            url = "//" + url
+
+        scheme: str | None
+        authority: str | None
+        auth: str | None
+        host: str | None
+        port: str | None
+        port_int: int | None
+        path: str | None
+        query: str | None
+        fragment: str | None
+
+        try:
+            scheme, authority, path, query, fragment = _URI_RE.match(url).groups()  # type: ignore[union-attr]
+            normalize_uri = scheme is None or scheme.lower() in _NORMALIZABLE_SCHEMES
+
+            if scheme:
+                scheme = scheme.lower()
+
+            if authority:
+                auth, _, host_port = authority.rpartition("@")
+                auth = auth or None
+                host, port = _HOST_PORT_RE.match(host_port).groups()  # type: ignore[union-attr]
+                if auth and normalize_uri:
+                    auth = _encode_invalid_chars(auth, _USERINFO_CHARS)
+                if port == "":
+                    port = None
+            else:
+                auth, host, port = None, None, None
+
+            if port is not None:
+                port_int = int(port)
+                if not (0 <= port_int <= 65535):
+                    raise LocationParseError(url)
+            else:
+                port_int = None
+
+            host = _normalize_host(host, scheme)
+
+            if normalize_uri and path:
+                path = _remove_path_dot_segments(path)
+                path = _encode_invalid_chars(path, _PATH_CHARS)
+            if normalize_uri and query:
+                query = _encode_invalid_chars(query, _QUERY_CHARS)
+            if normalize_uri and fragment:
+                fragment = _encode_invalid_chars(fragment, _FRAGMENT_CHARS)
+
+        except (ValueError, AttributeError) as e:
+            raise LocationParseError(source_url) from e
+
+        # For the sake of backwards compatibility we put empty
+        # string values for path if there are any defined values
+        # beyond the path in the URL.
+        # TODO: Remove this when we break backwards compatibility.
+        if not path:
+            if query is not None or fragment is not None:
+                path = ""
+            else:
+                path = None
+
+        return Url(
+            scheme=scheme,
+            auth=auth,
+            host=host,
+            port=port_int,
+            path=path,
+            query=query,
+            fragment=fragment,
+        )
+
+
+__all__ = ("Url", "parse_url", "HTTPError", "LocationParseError", "LocationValueError")

comicapi/archivers/__init__.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from comicapi.archivers.archiver import Archiver
+from comicapi.archivers.folder import FolderArchiver
+from comicapi.archivers.zip import ZipArchiver
+
+
+class UnknownArchiver(Archiver):
+    def name(self) -> str:
+        return "Unknown"
+
+
+__all__ = ["Archiver", "UnknownArchiver", "FolderArchiver", "ZipArchiver"]

comicapi/archivers/archiver.py

@@ -0,0 +1,146 @@
+from __future__ import annotations
+
+import pathlib
+from collections.abc import Collection
+from typing import Protocol, runtime_checkable
+
+
+@runtime_checkable
+class Archiver(Protocol):
+    """Archiver Protocol"""
+
+    """The path to the archive"""
+    path: pathlib.Path
+
+    """
+    The name of the executable used for this archiver. This should be the base name of the executable.
+    For example if 'rar.exe' is needed this should be "rar".
+    If an executable is not used this should be the empty string.
+    """
+    exe: str = ""
+
+    """
+    Whether or not this archiver is enabled.
+    If external imports are required and are not available this should be false. See rar.py and sevenzip.py.
+    """
+    enabled: bool = True
+
+    """
+    If self.path is a single file that can be hashed.
+    For example directories cannot be hashed.
+    """
+    hashable: bool = True
+
+    supported_extensions: Collection[str] = set()
+
+    def __init__(self) -> None:
+        self.path = pathlib.Path()
+
+    def get_comment(self) -> str:
+        """
+        Returns the comment from the current archive as a string.
+        Should always return a string. If comments are not supported in the archive the empty string should be returned.
+        """
+        return ""
+
+    def set_comment(self, comment: str) -> bool:
+        """
+        Returns True if the comment was successfully set on the current archive.
+        Should always return a boolean. If comments are not supported in the archive False should be returned.
+        """
+        return False
+
+    def supports_comment(self) -> bool:
+        """
+        Returns True if the current archive supports comments.
+        Should always return a boolean. If comments are not supported in the archive False should be returned.
+        """
+        return False
+
+    def read_file(self, archive_file: str) -> bytes:
+        """
+        Reads the named file from the current archive.
+        archive_file should always come from the output of get_filename_list.
+        Should always return a bytes object. Exceptions should be of the type OSError.
+        """
+        raise NotImplementedError
+
+    def remove_file(self, archive_file: str) -> bool:
+        """
+        Removes the named file from the current archive.
+        archive_file should always come from the output of get_filename_list.
+        Should always return a boolean. Failures should return False.
+
+        Rebuilding the archive without the named file is a standard way to remove a file.
+        """
+        return False
+
+    def write_file(self, archive_file: str, data: bytes) -> bool:
+        """
+        Writes the named file to the current archive.
+        Should always return a boolean. Failures should return False.
+        """
+        return False
+
+    def get_filename_list(self) -> list[str]:
+        """
+        Returns a list of filenames in the current archive.
+        Should always return a list of string. Failures should return an empty list.
+        """
+        return []
+
+    def supports_files(self) -> bool:
+        """
+        Returns True if the current archive supports arbitrary non-picture files.
+        Should always return a boolean.
+        If arbitrary non-picture files are not supported in the archive False should be returned.
+        """
+        return False
+
+    def copy_from_archive(self, other_archive: Archiver) -> bool:
+        """
+        Copies the contents of another achive to the current archive.
+        Should always return a boolean. Failures should return False.
+        """
+        return False
+
+    def is_writable(self) -> bool:
+        """
+        Retuns True if the current archive is writeable
+        Should always return a boolean. Failures should return False.
+        """
+        return False
+
+    def extension(self) -> str:
+        """
+        Returns the extension that this archiver should use eg ".cbz".
+        Should always return a string. Failures should return the empty string.
+        """
+        return ""
+
+    def name(self) -> str:
+        """
+        Returns the name of this archiver for display purposes eg "CBZ".
+        Should always return a string. Failures should return the empty string.
+        """
+        return ""
+
+    @classmethod
+    def is_valid(cls, path: pathlib.Path) -> bool:
+        """
+        Returns True if the given path can be opened by this archiver.
+        Should always return a boolean. Failures should return False.
+        """
+        return False
+
+    @classmethod
+    def open(cls, path: pathlib.Path) -> Archiver:
+        """
+        Opens the given archive.
+        Should always return a an Archver.
+        Should never cause an exception no file operations should take place in this method,
+        is_valid will always be called before open.
+        """
+        archiver = cls()
+        archiver.path = path
+        return archiver

comicapi/archivers/folder.py

@@ -0,0 +1,115 @@
+from __future__ import annotations
+
+import logging
+import os
+import pathlib
+
+from comicapi.archivers import Archiver
+
+logger = logging.getLogger(__name__)
+
+
+class FolderArchiver(Archiver):
+    """Folder implementation"""
+
+    hashable = False
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.comment_file_name = "ComicTaggerFolderComment.txt"
+        self._filename_list: list[str] = []
+
+    def get_comment(self) -> str:
+        try:
+            return (self.path / self.comment_file_name).read_text()
+        except OSError:
+            return ""
+
+    def set_comment(self, comment: str) -> bool:
+        self._filename_list = []
+        if comment:
+            return self.write_file(self.comment_file_name, comment.encode("utf-8"))
+        (self.path / self.comment_file_name).unlink(missing_ok=True)
+        return True
+
+    def supports_comment(self) -> bool:
+        return True
+
+    def read_file(self, archive_file: str) -> bytes:
+        try:
+            data = (self.path / archive_file).read_bytes()
+        except OSError as e:
+            logger.error("Error reading folder archive [%s]: %s :: %s", e, self.path, archive_file)
+            raise
+
+        return data
+
+    def remove_file(self, archive_file: str) -> bool:
+        self._filename_list = []
+        try:
+            (self.path / archive_file).unlink(missing_ok=True)
+        except OSError as e:
+            logger.error("Error removing file for folder archive [%s]: %s :: %s", e, self.path, archive_file)
+            return False
+        else:
+            return True
+
+    def write_file(self, archive_file: str, data: bytes) -> bool:
+        self._filename_list = []
+        try:
+            file_path = self.path / archive_file
+            file_path.parent.mkdir(exist_ok=True, parents=True)
+            with open(self.path / archive_file, mode="wb") as f:
+                f.write(data)
+        except OSError as e:
+            logger.error("Error writing folder archive [%s]: %s :: %s", e, self.path, archive_file)
+            return False
+        else:
+            return True
+
+    def get_filename_list(self) -> list[str]:
+        if self._filename_list:
+            return self._filename_list
+        filenames = []
+        try:
+            for root, _dirs, files in os.walk(self.path):
+                for f in files:
+                    filenames.append(os.path.relpath(os.path.join(root, f), self.path).replace(os.path.sep, "/"))
+            self._filename_list = filenames
+            return filenames
+        except OSError as e:
+            logger.error("Error listing files in folder archive [%s]: %s", e, self.path)
+            return []
+
+    def supports_files(self) -> bool:
+        return True
+
+    def copy_from_archive(self, other_archive: Archiver) -> bool:
+        """Replace the current zip with one copied from another archive"""
+        self._filename_list = []
+        try:
+            for filename in other_archive.get_filename_list():
+                data = other_archive.read_file(filename)
+                if data is not None:
+                    self.write_file(filename, data)
+
+            # preserve the old comment
+            comment = other_archive.get_comment()
+            if comment is not None:
+                if not self.set_comment(comment):
+                    return False
+        except Exception:
+            logger.exception("Error while copying archive from %s to %s", other_archive.path, self.path)
+            return False
+        else:
+            return True
+
+    def is_writable(self) -> bool:
+        return True
+
+    def name(self) -> str:
+        return "Folder"
+
+    @classmethod
+    def is_valid(cls, path: pathlib.Path) -> bool:
+        return path.is_dir()

comicapi/archivers/rar.py

@@ -0,0 +1,347 @@
+from __future__ import annotations
+
+import functools
+import logging
+import os
+import pathlib
+import platform
+import shutil
+import subprocess
+import tempfile
+
+from comicapi.archivers import Archiver
+
+try:
+    import rarfile
+
+    rar_support = True
+except ImportError:
+    rar_support = False
+
+
+logger = logging.getLogger(__name__)
+
+if not rar_support:
+    logger.error("rar unavailable")
+# windows only, keeps the cmd.exe from popping up
+STARTUPINFO = None
+if platform.system() == "Windows":
+    STARTUPINFO = subprocess.STARTUPINFO()  # type: ignore
+    STARTUPINFO.dwFlags |= subprocess.STARTF_USESHOWWINDOW  # type: ignore
+
+
+class RarArchiver(Archiver):
+    """RAR implementation"""
+
+    enabled = rar_support
+    exe = "rar"
+    supported_extensions = frozenset({".cbr", ".rar"})
+
+    _rar: rarfile.RarFile | None = None
+    _rar_setup: rarfile.ToolSetup | None = None
+    _writeable: bool | None = None
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._filename_list: list[str] = []
+
+    def get_comment(self) -> str:
+        rarc = self.get_rar_obj()
+        return (rarc.comment if rarc else "") or ""
+
+    def set_comment(self, comment: str) -> bool:
+        self._reset()
+        if rar_support and self.exe:
+            try:
+                # write comment to temp file
+                with tempfile.TemporaryDirectory() as tmp_dir:
+                    tmp_file = pathlib.Path(tmp_dir) / "rar_comment.txt"
+                    tmp_file.write_text(comment, encoding="utf-8")
+
+                    working_dir = os.path.dirname(os.path.abspath(self.path))
+
+                    # use external program to write comment to Rar archive
+                    proc_args = [
+                        self.exe,
+                        "c",
+                        f"-w{working_dir}",
+                        "-c-",
+                        f"-z{tmp_file}",
+                        str(self.path),
+                    ]
+                    result = subprocess.run(
+                        proc_args,
+                        startupinfo=STARTUPINFO,
+                        stdin=subprocess.DEVNULL,
+                        capture_output=True,
+                        encoding="utf-8",
+                        cwd=tmp_dir,
+                    )
+                if result.returncode != 0:
+                    logger.error(
+                        "Error writing comment to rar archive [exitcode: %d]: %s :: %s",
+                        result.returncode,
+                        self.path,
+                        result.stderr,
+                    )
+                    return False
+            except OSError as e:
+                logger.exception("Error writing comment to rar archive [%s]: %s", e, self.path)
+                return False
+            return True
+        return False
+
+    def supports_comment(self) -> bool:
+        return True
+
+    def read_file(self, archive_file: str) -> bytes:
+        rarc = self.get_rar_obj()
+        if rarc is None:
+            return b""
+
+        tries = 0
+        while tries < 7:
+            try:
+                tries = tries + 1
+                data: bytes = rarc.open(archive_file).read()
+                entries = [(rarc.getinfo(archive_file), data)]
+
+                if entries[0][0].file_size != len(entries[0][1]):
+                    logger.info(
+                        "Error reading rar archive [file is not expected size: %d vs %d]  %s :: %s :: tries #%d",
+                        entries[0][0].file_size,
+                        len(entries[0][1]),
+                        self.path,
+                        archive_file,
+                        tries,
+                    )
+                    continue
+
+            except OSError as e:
+                logger.error("Error reading rar archive [%s]: %s :: %s :: tries #%d", e, self.path, archive_file, tries)
+            except Exception as e:
+                logger.error(
+                    "Unexpected exception reading rar archive [%s]: %s :: %s :: tries #%d",
+                    e,
+                    self.path,
+                    archive_file,
+                    tries,
+                )
+                break
+
+            else:
+                # Success. Entries is a list of of tuples:  ( rarinfo, filedata)
+                if len(entries) == 1:
+                    return entries[0][1]
+
+                raise OSError
+
+        raise OSError
+
+    def remove_file(self, archive_file: str) -> bool:
+        self._reset()
+        if self.exe:
+            working_dir = os.path.dirname(os.path.abspath(self.path))
+            # use external program to remove file from Rar archive
+            result = subprocess.run(
+                [self.exe, "d", f"-w{working_dir}", "-c-", self.path, archive_file],
+                startupinfo=STARTUPINFO,
+                stdin=subprocess.DEVNULL,
+                capture_output=True,
+                encoding="utf-8",
+                cwd=self.path.absolute().parent,
+            )
+
+            if result.returncode != 0:
+                logger.error(
+                    "Error removing file from rar archive [exitcode: %d]: %s :: %s",
+                    result.returncode,
+                    self.path,
+                    archive_file,
+                )
+                return False
+            return True
+        return False
+
+    def write_file(self, archive_file: str, data: bytes) -> bool:
+        self._reset()
+        if self.exe:
+            archive_path = pathlib.PurePosixPath(archive_file)
+            archive_name = archive_path.name
+            archive_parent = str(archive_path.parent).lstrip("./")
+            working_dir = os.path.dirname(os.path.abspath(self.path))
+
+            # use external program to write file to Rar archive
+            result = subprocess.run(
+                [
+                    self.exe,
+                    "a",
+                    f"-w{working_dir}",
+                    f"-si{archive_name}",
+                    f"-ap{archive_parent}",
+                    "-c-",
+                    "-ep",
+                    self.path,
+                ],
+                input=data,
+                startupinfo=STARTUPINFO,
+                capture_output=True,
+                cwd=self.path.absolute().parent,
+            )
+
+            if result.returncode != 0:
+                logger.error(
+                    "Error writing rar archive [exitcode: %d]: %s :: %s :: %s",
+                    result.returncode,
+                    self.path,
+                    archive_file,
+                    result.stderr,
+                )
+                return False
+            return True
+        return False
+
+    def get_filename_list(self) -> list[str]:
+        if self._filename_list:
+            return self._filename_list
+        rarc = self.get_rar_obj()
+        tries = 0
+        if rar_support and rarc:
+            while tries < 7:
+                try:
+                    tries = tries + 1
+                    namelist = []
+                    for item in rarc.infolist():
+                        if item.file_size != 0:
+                            namelist.append(item.filename)
+
+                except OSError as e:
+                    logger.error("Error listing files in rar archive [%s]: %s :: attempt #%d", e, self.path, tries)
+
+                else:
+                    self._filename_list = namelist
+                    return namelist
+        return []
+
+    def supports_files(self) -> bool:
+        return True
+
+    def copy_from_archive(self, other_archive: Archiver) -> bool:
+        """Replace the current archive with one copied from another archive"""
+        self._reset()
+        try:
+            with tempfile.TemporaryDirectory() as tmp_dir:
+                tmp_path = pathlib.Path(tmp_dir)
+                rar_cwd = tmp_path / "rar"
+                rar_cwd.mkdir(exist_ok=True)
+                rar_path = (tmp_path / self.path.name).with_suffix(".rar")
+                working_dir = os.path.dirname(os.path.abspath(self.path))
+
+                for filename in other_archive.get_filename_list():
+                    (rar_cwd / filename).parent.mkdir(exist_ok=True, parents=True)
+                    data = other_archive.read_file(filename)
+                    if data is not None:
+                        with open(rar_cwd / filename, mode="w+b") as tmp_file:
+                            tmp_file.write(data)
+                result = subprocess.run(
+                    [self.exe, "a", f"-w{working_dir}", "-r", "-c-", str(rar_path.absolute()), "."],
+                    cwd=rar_cwd.absolute(),
+                    startupinfo=STARTUPINFO,
+                    stdin=subprocess.DEVNULL,
+                    capture_output=True,
+                    encoding="utf-8",
+                )
+                if result.returncode != 0:
+                    logger.error(
+                        "Error while copying to rar archive [exitcode: %d]: %s: %s",
+                        result.returncode,
+                        self.path,
+                        result.stderr,
+                    )
+                    return False
+
+                self.path.unlink(missing_ok=True)
+                shutil.move(rar_path, self.path)
+        except Exception as e:
+            logger.exception("Error while copying to rar archive [%s]: from %s to %s", e, other_archive.path, self.path)
+            return False
+        else:
+            return True
+
+    @classmethod
+    @functools.cache
+    def _log_not_writeable(cls, exe: str) -> None:
+        logger.warning("Unable to find a useable copy of %r, will not be able to write rar files", exe)
+
+    def is_writable(self) -> bool:
+        return bool(self._writeable and bool(self.exe and (os.path.exists(self.exe) or shutil.which(self.exe))))
+
+    def extension(self) -> str:
+        return ".cbr"
+
+    def name(self) -> str:
+        return "RAR"
+
+    @classmethod
+    def _setup_rar(cls) -> None:
+        if cls._rar_setup is None:
+            assert rarfile
+            orig = rarfile.UNRAR_TOOL
+            rarfile.UNRAR_TOOL = cls.exe
+            try:
+                cls._rar_setup = rarfile.tool_setup(sevenzip=False, sevenzip2=False, force=True)
+            except rarfile.RarCannotExec:
+                rarfile.UNRAR_TOOL = orig
+
+            try:
+                cls._rar_setup = rarfile.tool_setup(force=True)
+            except rarfile.RarCannotExec as e:
+                logger.info(e)
+        if cls._writeable is None:
+            try:
+                cls._writeable = (
+                    subprocess.run(
+                        (cls.exe,),
+                        startupinfo=STARTUPINFO,
+                        capture_output=True,
+                        # cwd=cls.path.absolute().parent,
+                    )
+                    .stdout.strip()
+                    .startswith(b"RAR")
+                )
+            except OSError:
+                cls._writeable = False
+
+        if not cls._writeable:
+            cls._log_not_writeable(cls.exe or "rar")
+
+    @classmethod
+    def is_valid(cls, path: pathlib.Path) -> bool:
+        if rar_support:
+            assert rarfile
+            cls._setup_rar()
+
+            # Fallback to standard
+            try:
+                return rarfile.is_rarfile(str(path))
+            except rarfile.RarCannotExec as e:
+                logger.info(e)
+        return False
+
+    def _reset(self) -> None:
+        self._rar = None
+        self._filename_list = []
+
+    def get_rar_obj(self) -> rarfile.RarFile | None:
+        if self._rar is not None:
+            return self._rar
+        if rar_support:
+            try:
+                rarc = rarfile.RarFile(str(self.path))
+                self._rar = rarc
+            except (OSError, rarfile.RarFileError) as e:
+                logger.error("Unable to get rar object [%s]: %s", e, self.path)
+            else:
+                return rarc
+
+        return None

comicapi/archivers/sevenzip.py

@@ -0,0 +1,143 @@
+from __future__ import annotations
+
+import logging
+import os
+import pathlib
+import shutil
+import tempfile
+
+from comicapi.archivers import Archiver
+
+try:
+    import py7zr
+
+    z7_support = True
+except ImportError:
+    z7_support = False
+
+logger = logging.getLogger(__name__)
+
+
+class SevenZipArchiver(Archiver):
+    """7Z implementation"""
+
+    enabled = z7_support
+    supported_extensions = frozenset({".7z", ".cb7"})
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._filename_list: list[str] = []
+
+    # @todo: Implement Comment?
+    def get_comment(self) -> str:
+        return ""
+
+    def set_comment(self, comment: str) -> bool:
+        return False
+
+    def read_file(self, archive_file: str) -> bytes:
+        data = b""
+        try:
+            with py7zr.SevenZipFile(self.path, "r") as zf:
+                data = zf.read([archive_file])[archive_file].read()
+        except (py7zr.Bad7zFile, OSError) as e:
+            logger.error("Error reading 7zip archive [%s]: %s :: %s", e, self.path, archive_file)
+            raise
+
+        return data
+
+    def remove_file(self, archive_file: str) -> bool:
+        self._filename_list = []
+        return self.rebuild([archive_file])
+
+    def write_file(self, archive_file: str, data: bytes) -> bool:
+        # At the moment, no other option but to rebuild the whole
+        # archive w/o the indicated file. Very sucky, but maybe
+        # another solution can be found
+        files = self.get_filename_list()
+        self._filename_list = []
+        if archive_file in files:
+            if not self.rebuild([archive_file]):
+                return False
+
+        try:
+            # now just add the archive file as a new one
+            with py7zr.SevenZipFile(self.path, "a") as zf:
+                zf.writestr(data, archive_file)
+            return True
+        except (py7zr.Bad7zFile, OSError) as e:
+            logger.error("Error writing 7zip archive [%s]: %s :: %s", e, self.path, archive_file)
+            return False
+
+    def get_filename_list(self) -> list[str]:
+        if self._filename_list:
+            return self._filename_list
+        try:
+            with py7zr.SevenZipFile(self.path, "r") as zf:
+                namelist: list[str] = [file.filename for file in zf.list() if not file.is_directory]
+
+            self._filename_list = namelist
+            return namelist
+        except (py7zr.Bad7zFile, OSError) as e:
+            logger.error("Error listing files in 7zip archive [%s]: %s", e, self.path)
+            return []
+
+    def supports_files(self) -> bool:
+        return True
+
+    def rebuild(self, exclude_list: list[str]) -> bool:
+        """Zip helper func
+
+        This recompresses the zip archive, without the files in the exclude_list
+        """
+
+        self._filename_list = []
+        try:
+            # py7zr treats all archives as if they used solid compression
+            # so we need to get the filename list first to read all the files at once
+            with py7zr.SevenZipFile(self.path, mode="r") as zin:
+                targets = [f for f in zin.getnames() if f not in exclude_list]
+            with tempfile.NamedTemporaryFile(dir=os.path.dirname(self.path), delete=False) as tmp_file:
+                with py7zr.SevenZipFile(tmp_file.file, mode="w") as zout:
+                    with py7zr.SevenZipFile(self.path, mode="r") as zin:
+                        for filename, buffer in zin.read(targets).items():
+                            zout.writef(buffer, filename)
+
+                self.path.unlink(missing_ok=True)
+                tmp_file.close()  # Required on windows
+
+                shutil.move(tmp_file.name, self.path)
+        except (py7zr.Bad7zFile, OSError) as e:
+            logger.error("Error rebuilding 7zip file [%s]: %s", e, self.path)
+            return False
+        return True
+
+    def copy_from_archive(self, other_archive: Archiver) -> bool:
+        """Replace the current zip with one copied from another archive"""
+        self._filename_list = []
+        try:
+            with py7zr.SevenZipFile(self.path, "w") as zout:
+                for filename in other_archive.get_filename_list():
+                    data = other_archive.read_file(
+                        filename
+                    )  # This will be very inefficient if other_archive is a 7z file
+                    if data is not None:
+                        zout.writestr(data, filename)
+        except Exception as e:
+            logger.error("Error while copying to 7zip archive [%s]: from %s to %s", e, other_archive.path, self.path)
+            return False
+        else:
+            return True
+
+    def is_writable(self) -> bool:
+        return True
+
+    def extension(self) -> str:
+        return ".cb7"
+
+    def name(self) -> str:
+        return "Seven Zip"
+
+    @classmethod
+    def is_valid(cls, path: pathlib.Path) -> bool:
+        return py7zr.is_7zfile(path)

comicapi/archivers/zip.py

@@ -0,0 +1,160 @@
+from __future__ import annotations
+
+import logging
+import os
+import pathlib
+import shutil
+import tempfile
+import zipfile
+from typing import cast
+
+import chardet
+from zipremove import ZipFile
+
+from comicapi.archivers import Archiver
+
+logger = logging.getLogger(__name__)
+
+
+class ZipArchiver(Archiver):
+    """ZIP implementation"""
+
+    supported_extensions = frozenset((".cbz", ".zip"))
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._filename_list: list[str] = []
+
+    def supports_comment(self) -> bool:
+        return True
+
+    def get_comment(self) -> str:
+        with ZipFile(self.path, "r") as zf:
+            encoding = chardet.detect(zf.comment, True)
+            if encoding["confidence"] > 60:
+                try:
+                    comment = zf.comment.decode(encoding["encoding"])
+                except UnicodeDecodeError:
+                    comment = zf.comment.decode("utf-8", errors="replace")
+            else:
+                comment = zf.comment.decode("utf-8", errors="replace")
+        return comment
+
+    def set_comment(self, comment: str) -> bool:
+        with ZipFile(self.path, mode="a") as zf:
+            zf.comment = bytes(comment, "utf-8")
+        return True
+
+    def read_file(self, archive_file: str) -> bytes:
+        with ZipFile(self.path, mode="r") as zf:
+            try:
+                data = zf.read(archive_file)
+            except (zipfile.BadZipfile, OSError) as e:
+                logger.exception("Error reading zip archive [%s]: %s :: %s", e, self.path, archive_file)
+                raise
+        return data
+
+    def remove_file(self, archive_file: str) -> bool:
+        files = self.get_filename_list()
+        self._filename_list = []
+        try:
+            with ZipFile(self.path, mode="a", allowZip64=True, compression=zipfile.ZIP_DEFLATED) as zf:
+                if archive_file in files:
+                    zf.repack([zf.remove(archive_file)])
+            return True
+        except (zipfile.BadZipfile, OSError) as e:
+            logger.error("Error writing zip archive [%s]: %s :: %s", e, self.path, archive_file)
+            return False
+
+    def write_file(self, archive_file: str, data: bytes) -> bool:
+        files = self.get_filename_list()
+        self._filename_list = []
+
+        try:
+            # now just add the archive file as a new one
+            with ZipFile(self.path, mode="a", allowZip64=True, compression=zipfile.ZIP_DEFLATED) as zf:
+                if archive_file in files:
+                    zf.repack([zf.remove(archive_file)])
+                zf.writestr(archive_file, data)
+            return True
+        except (zipfile.BadZipfile, OSError) as e:
+            logger.error("Error writing zip archive [%s]: %s :: %s", e, self.path, archive_file)
+            return False
+
+    def get_filename_list(self) -> list[str]:
+        if self._filename_list:
+            return self._filename_list
+        try:
+            with ZipFile(self.path, mode="r") as zf:
+                self._filename_list = [file.filename for file in zf.infolist() if not file.is_dir()]
+                return self._filename_list
+        except (zipfile.BadZipfile, OSError) as e:
+            logger.error("Error listing files in zip archive [%s]: %s", e, self.path)
+            return []
+
+    def supports_files(self) -> bool:
+        return True
+
+    def rebuild(self, exclude_list: list[str]) -> bool:
+        """Zip helper func
+
+        This recompresses the zip archive, without the files in the exclude_list
+        """
+        self._filename_list = []
+        try:
+            with ZipFile(
+                tempfile.NamedTemporaryFile(dir=os.path.dirname(self.path), delete=False), "w", allowZip64=True
+            ) as zout:
+                with ZipFile(self.path, mode="r") as zin:
+                    for item in zin.infolist():
+                        buffer = zin.read(item.filename)
+                        if item.filename not in exclude_list:
+                            zout.writestr(item, buffer)
+
+                    # preserve the old comment
+                    zout.comment = zin.comment
+
+                # replace with the new file
+                self.path.unlink(missing_ok=True)
+                zout.close()  # Required on windows
+
+                shutil.move(cast(str, zout.filename), self.path)
+
+        except (zipfile.BadZipfile, OSError) as e:
+            logger.error("Error rebuilding zip file [%s]: %s", e, self.path)
+            return False
+        return True
+
+    def copy_from_archive(self, other_archive: Archiver) -> bool:
+        """Replace the current zip with one copied from another archive"""
+        self._filename_list = []
+        try:
+            with ZipFile(self.path, mode="w", allowZip64=True) as zout:
+                for filename in other_archive.get_filename_list():
+                    data = other_archive.read_file(filename)
+                    if data is not None:
+                        zout.writestr(filename, data)
+
+            # preserve the old comment
+            comment = other_archive.get_comment()
+            if comment is not None:
+                if not self.set_comment(comment):
+                    return False
+        except Exception as e:
+            logger.error("Error while copying to zip archive [%s]: from %s to %s", e, other_archive.path, self.path)
+            return False
+        else:
+            return True
+
+    def is_writable(self) -> bool:
+        return True
+
+    def extension(self) -> str:
+        return ".cbz"
+
+    def name(self) -> str:
+        return "ZIP"
+
+    @classmethod
+    def is_valid(cls, path: pathlib.Path) -> bool:
+        return zipfile.is_zipfile(path)  # only checks central directory ot the end of the archive

comicapi/comicarchive.py

@@ -0,0 +1,473 @@
+"""A class to represent a single comic, be it file or folder of images"""
+
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import hashlib
+import importlib.util
+import inspect
+import io
+import itertools
+import logging
+import os
+import pathlib
+import shutil
+import sys
+from collections.abc import Iterable
+
+from comicapi import utils
+from comicapi.archivers import Archiver, UnknownArchiver, ZipArchiver
+from comicapi.genericmetadata import FileHash, GenericMetadata
+from comicapi.tags import Tag
+from comictaggerlib.ctversion import version
+
+logger = logging.getLogger(__name__)
+
+archivers: list[type[Archiver]] = []
+tags: dict[str, Tag] = {}
+
+
+def load_archive_plugins(local_plugins: Iterable[type[Archiver]] = tuple()) -> None:
+    if archivers:
+        return
+    if sys.version_info < (3, 10):
+        from importlib_metadata import entry_points
+    else:
+        from importlib.metadata import entry_points
+    builtin: list[type[Archiver]] = []
+    archive_plugins: list[type[Archiver]] = []
+    # A list is used first matching plugin wins
+
+    for ep in itertools.chain(entry_points(group="comicapi.archiver")):
+        try:
+            spec = importlib.util.find_spec(ep.module)
+        except ValueError:
+            spec = None
+        try:
+            archiver: type[Archiver] = ep.load()
+
+            if ep.module.startswith("comicapi"):
+                builtin.append(archiver)
+            else:
+                archive_plugins.append(archiver)
+        except Exception:
+            if spec and spec.has_location:
+                logger.exception("Failed to load archive plugin: %s from %s", ep.name, spec.origin)
+            else:
+                logger.exception("Failed to load archive plugin: %s", ep.name)
+    archivers.clear()
+    archivers.extend(local_plugins)
+    archivers.extend(archive_plugins)
+    archivers.extend(builtin)
+
+
+def load_tag_plugins(version: str = f"ComicAPI/{version}", local_plugins: Iterable[type[Tag]] = tuple()) -> None:
+    if tags:
+        return
+    if sys.version_info < (3, 10):
+        from importlib_metadata import entry_points
+    else:
+        from importlib.metadata import entry_points
+    builtin: dict[str, Tag] = {}
+    tag_plugins: dict[str, tuple[Tag, str]] = {}
+    # A dict is used, last plugin wins
+    for ep in entry_points(group="comicapi.tags"):
+        location = "Unknown"
+        try:
+            _spec = importlib.util.find_spec(ep.module)
+            if _spec and _spec.has_location and _spec.origin:
+                location = _spec.origin
+        except ValueError:
+            location = "Unknown"
+
+        try:
+            tag: type[Tag] = ep.load()
+
+            if ep.module.startswith("comicapi"):
+                builtin[tag.id] = tag(version)
+            else:
+                if tag.id in tag_plugins:
+                    logger.warning(
+                        "Plugin %s from %s is overriding the existing plugin for %s tags",
+                        ep.module,
+                        location,
+                        tag.id,
+                    )
+                tag_plugins[tag.id] = (tag(version), location)
+        except Exception:
+            logger.exception("Failed to load tag plugin: %s from %s", ep.name, location)
+    # A dict is used, last plugin wins
+    for tag in local_plugins:
+        tag_plugins[tag.id] = (tag(version), "Local")
+
+    for tag_id in set(builtin.keys()).intersection(tag_plugins):
+        location = tag_plugins[tag_id][1]
+        logger.warning("Builtin plugin for %s tags are being overridden by a plugin from %s", tag_id, location)
+
+    tags.clear()
+    tags.update(builtin)
+    tags.update({s[0]: s[1][0] for s in tag_plugins.items()})
+
+
+class ComicArchive:
+    logo_data = b""
+    pil_available: bool | None = None
+
+    def __init__(
+        self,
+        path: pathlib.Path | str | Archiver,
+        default_image_path: pathlib.Path | str | None = None,
+        hash_archive: str = "",
+    ) -> None:
+        self.md: dict[str, GenericMetadata] = {}
+        self.page_count: int | None = None
+        self.page_list: list[str] = []
+        self.hash_archive = hash_archive
+
+        self.reset_cache()
+        self.default_image_path = default_image_path
+
+        if isinstance(path, Archiver):
+            self.path = path.path
+            self.archiver: Archiver = path
+        else:
+            self.path = pathlib.Path(path).absolute()
+            self.archiver = UnknownArchiver.open(self.path)
+
+            load_archive_plugins()
+            load_tag_plugins()
+            archiver_missing = True
+            for archiver in archivers:
+                if self.path.suffix in archiver.supported_extensions and archiver.is_valid(self.path):
+                    self.archiver = archiver.open(self.path)
+                    archiver_missing = False
+                    break
+
+            if archiver_missing:
+                for archiver in archivers:
+                    if archiver.enabled and archiver.is_valid(self.path):
+                        self.archiver = archiver.open(self.path)
+                        break
+
+        if not ComicArchive.logo_data and self.default_image_path:
+            with open(self.default_image_path, mode="rb") as fd:
+                ComicArchive.logo_data = fd.read()
+
+    def reset_cache(self) -> None:
+        """Clears the cached data"""
+
+        self.page_count = None
+        self.page_list.clear()
+        self.md.clear()
+
+    def load_cache(self, tag_ids: Iterable[str]) -> None:
+        for tag_id in tag_ids:
+            if tag_id not in tags:
+                continue
+            tag = tags[tag_id]
+            if not tag.enabled:
+                continue
+            md = tag.read_tags(self.archiver)
+            if not md.is_empty:
+                self.md[tag_id] = md
+
+    def get_supported_tags(self) -> list[str]:
+        return [tag_id for tag_id, tag in tags.items() if tag.enabled and tag.supports_tags(self.archiver)]
+
+    def rename(self, path: pathlib.Path | str) -> None:
+        new_path = pathlib.Path(path).absolute()
+        if new_path == self.path:
+            return
+        os.makedirs(new_path.parent, 0o777, True)
+        shutil.move(self.path, new_path)
+        self.path = new_path
+        self.archiver.path = pathlib.Path(path)
+
+    def is_writable(self, check_archive_status: bool = True) -> bool:
+        if isinstance(self.archiver, UnknownArchiver):
+            return False
+
+        if check_archive_status and not self.archiver.is_writable():
+            return False
+
+        if not (os.access(self.path, os.W_OK) or os.access(self.path.parent, os.W_OK)):
+            return False
+
+        return True
+
+    def is_zip(self) -> bool:
+        return self.archiver.name() == "ZIP"
+
+    def seems_to_be_a_comic_archive(self) -> bool:
+        if (
+            not (isinstance(self.archiver, UnknownArchiver))
+            and self.get_number_of_pages() > 0
+            and self.archiver.is_valid(self.path)
+        ):
+            return True
+
+        return False
+
+    def extension(self) -> str:
+        return self.archiver.extension()
+
+    def read_tags(self, tag_id: str) -> GenericMetadata:
+        if tag_id in self.md:
+            return self.md[tag_id]
+        md = GenericMetadata()
+        tag = tags[tag_id]
+        if tag.enabled and tag.has_tags(self.archiver):
+            md = tag.read_tags(self.archiver)
+            md.apply_default_page_list(self.get_page_name_list())
+        return md
+
+    def read_raw_tags(self, tag_id: str) -> str:
+        if not tags[tag_id].enabled:
+            return ""
+        return tags[tag_id].read_raw_tags(self.archiver)
+
+    def write_tags(self, metadata: GenericMetadata, tag_id: str) -> bool:
+        if tag_id in self.md:
+            del self.md[tag_id]
+        if not tags[tag_id].enabled:
+            logger.warning("%s tags not enabled", tags[tag_id].name())
+            return False
+
+        self.apply_archive_info_to_metadata(metadata, True, True, hash_archive=self.hash_archive)
+        return tags[tag_id].write_tags(metadata, self.archiver)
+
+    def has_tags(self, tag_id: str) -> bool:
+        if tag_id in self.md:
+            return True
+        if not tags[tag_id].enabled:
+            return False
+        return tags[tag_id].has_tags(self.archiver)
+
+    def remove_tags(self, tag_id: str) -> bool:
+        if tag_id in self.md:
+            del self.md[tag_id]
+        if not tags[tag_id].enabled:
+            return False
+        return tags[tag_id].remove_tags(self.archiver)
+
+    def get_page(self, index: int) -> bytes:
+        image_data = b""
+
+        filename = self.get_page_name(index)
+
+        if filename:
+            try:
+                image_data = self.archiver.read_file(filename) or b""
+            except Exception:
+                logger.exception("Error reading in page %d. Substituting logo page.", index)
+                image_data = ComicArchive.logo_data
+
+        return image_data
+
+    def get_page_name(self, index: int) -> str:
+        if index is None:
+            return ""
+
+        page_list = self.get_page_name_list()
+
+        num_pages = len(page_list)
+        if num_pages == 0 or index >= num_pages:
+            return ""
+
+        return page_list[index]
+
+    def get_scanner_page_index(self) -> int | None:
+        scanner_page_index = None
+
+        # make a guess at the scanner page
+        name_list = self.get_page_name_list()
+        count = self.get_number_of_pages()
+
+        # too few pages to really know
+        if count < 5:
+            return None
+
+        # count the length of every filename, and count occurrences
+        length_buckets: dict[int, int] = {}
+        for name in name_list:
+            fname = os.path.split(name)[1]
+            length = len(fname)
+            if length in length_buckets:
+                length_buckets[length] += 1
+            else:
+                length_buckets[length] = 1
+
+        # sort by most common
+        sorted_buckets = sorted(length_buckets.items(), key=lambda tup: (tup[1], tup[0]), reverse=True)
+
+        # statistical mode occurrence is first
+        mode_length = sorted_buckets[0][0]
+
+        # we are only going to consider the final image file:
+        final_name = os.path.split(name_list[count - 1])[1]
+
+        common_length_list = []
+        for name in name_list:
+            if len(os.path.split(name)[1]) == mode_length:
+                common_length_list.append(os.path.split(name)[1])
+
+        prefix = os.path.commonprefix(common_length_list)
+
+        if mode_length <= 7 and prefix == "":
+            # probably all numbers
+            if len(final_name) > mode_length:
+                scanner_page_index = count - 1
+
+        # see if the last page doesn't start with the same prefix as most others
+        elif not final_name.startswith(prefix):
+            scanner_page_index = count - 1
+
+        return scanner_page_index
+
+    def get_page_name_list(self) -> list[str]:
+        if not self.page_list:
+            self.__import_pil__()  # Import pillow for list of supported extensions
+            self.page_list = utils.get_page_name_list(self.archiver.get_filename_list())
+
+        return self.page_list
+
+    def get_number_of_pages(self) -> int:
+        if self.page_count is None:
+            self.page_count = len(self.get_page_name_list())
+        return self.page_count
+
+    def __import_pil__(self) -> bool:
+        if self.pil_available is not None:
+            return self.pil_available
+
+        try:
+            from PIL import Image
+
+            Image.init()
+            utils.KNOWN_IMAGE_EXTENSIONS.update([ext for ext, typ in Image.EXTENSION.items() if typ in Image.OPEN])
+            self.pil_available = True
+        except Exception:
+            self.pil_available = False
+            logger.exception("Failed to load Pillow")
+            return False
+        return True
+
+    def apply_archive_info_to_metadata(
+        self,
+        md: GenericMetadata,
+        calc_page_sizes: bool = False,
+        detect_double_page: bool = False,
+        *,
+        hash_archive: str = "",
+    ) -> None:
+        hash_archive = hash_archive
+        md.page_count = self.get_number_of_pages()
+        md.apply_default_page_list(self.get_page_name_list())
+        if not self.seems_to_be_a_comic_archive():
+            return
+
+        if hash_archive in hashlib.algorithms_available and not md.original_hash:
+            hasher = getattr(hashlib, hash_archive, hash_archive)
+            try:
+                with self.archiver.path.open("b+r") as archive:
+                    digest = utils.file_digest(archive, hasher)
+                if len(inspect.signature(digest.hexdigest).parameters) > 0:
+                    length = digest.name.rpartition("_")[2]
+                    if not length.isdigit():
+                        length = "128"
+                    md.original_hash = FileHash(digest.name, digest.hexdigest(int(length) // 8))  # type: ignore[call-arg]
+                else:
+                    md.original_hash = FileHash(digest.name, digest.hexdigest())
+            except Exception:
+                logger.exception("Failed to calculate original hash for '%s'", self.archiver.path)
+        if not calc_page_sizes:
+            return
+        for p in md.pages:
+            if p.byte_size is None or p.height is None or p.width is None or p.double_page is None:
+                try:
+                    data = self.get_page(p.archive_index)
+                    p.byte_size = len(data)
+                    if not data or not self.__import_pil__():
+                        continue
+
+                    from PIL import Image
+
+                    im = Image.open(io.BytesIO(data))
+                    w, h = im.size
+
+                    p.height = h
+                    p.width = w
+                    if detect_double_page:
+                        p.double_page = p.is_double_page()
+                except Exception as e:
+                    logger.exception("Error decoding image [%s] %s :: image %s", e, self.path, p.archive_index)
+
+    def metadata_from_filename(
+        self,
+        parser: utils.Parser = utils.Parser.ORIGINAL,
+        remove_c2c: bool = False,
+        remove_fcbd: bool = False,
+        remove_publisher: bool = False,
+        split_words: bool = False,
+        allow_issue_start_with_letter: bool = False,
+        protofolius_issue_number_scheme: bool = False,
+    ) -> GenericMetadata:
+        metadata = GenericMetadata()
+
+        filename_info = utils.parse_filename(
+            self.path.name,
+            parser=parser,
+            remove_c2c=remove_c2c,
+            remove_fcbd=remove_fcbd,
+            remove_publisher=remove_publisher,
+            split_words=split_words,
+            allow_issue_start_with_letter=allow_issue_start_with_letter,
+            protofolius_issue_number_scheme=protofolius_issue_number_scheme,
+        )
+        metadata.alternate_number = utils.xlate(filename_info.get("alternate", None))
+        metadata.issue = utils.xlate(filename_info.get("issue", None))
+        metadata.issue_count = utils.xlate_int(filename_info.get("issue_count", None))
+        metadata.publisher = utils.xlate(filename_info.get("publisher", None))
+        metadata.series = utils.xlate(filename_info.get("series", None))
+        metadata.title = utils.xlate(filename_info.get("title", None))
+        metadata.volume = utils.xlate_int(filename_info.get("volume", None))
+        metadata.volume_count = utils.xlate_int(filename_info.get("volume_count", None))
+        metadata.year = utils.xlate_int(filename_info.get("year", None))
+
+        metadata.scan_info = utils.xlate(filename_info.get("remainder", None))
+
+        if filename_info.get("fcbd", None):
+            metadata.format = "FCBD"
+            metadata.tags.add("FCBD")
+
+        if filename_info.get("c2c", None):
+            metadata.tags.add("c2c")
+
+        if filename_info.get("annual", None):
+            metadata.format = "Annual"
+
+        if filename_info.get("format", None):
+            metadata.format = filename_info["format"]
+
+        metadata.is_empty = False
+        return metadata
+
+    def export_as_zip(self, zip_filename: pathlib.Path) -> bool:
+        if self.archiver.name() == "ZIP":
+            # nothing to do, we're already a zip
+            return True
+
+        zip_archiver = ZipArchiver.open(zip_filename)
+        return zip_archiver.copy_from_archive(self.archiver)

comicapi/data/__init__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+import importlib.resources
+
+data_path = importlib.resources.files(__package__)

comicapi/data/publishers.json

@@ -0,0 +1,143 @@
+{
+    "Marvel":{
+        "marvel comics": "",
+        "aircel comics": "Aircel Comics",
+        "aircel": "Aircel Comics",
+        "atlas comics": "Atlas Comics",
+        "atlas": "Atlas Comics",
+        "crossgen comics": "CrossGen comics",
+        "crossgen": "CrossGen comics",
+        "curtis magazines": "Curtis Magazines",
+        "disney books group": "Disney Books Group",
+        "disney books": "Disney Books Group",
+        "disney kingdoms": "Disney Kingdoms",
+        "epic comics group": "Epic Comics",
+        "epic comics": "Epic Comics",
+        "epic": "Epic Comics",
+        "eternity comics": "Eternity Comics",
+        "humorama": "Humorama",
+        "icon comics": "Icon Comics",
+        "infinite comics": "Infinite Comics",
+        "malibu comics": "Malibu Comics",
+        "malibu": "Malibu Comics",
+        "marvel 2099": "Marvel 2099",
+        "marvel absurd": "Marvel Absurd",
+        "marvel adventures": "Marvel Adventures",
+        "marvel age": "Marvel Age",
+        "marvel books": "Marvel Books",
+        "marvel comics 2": "Marvel Comics 2",
+        "marvel digital comics unlimited": "Marvel Unlimited",
+        "marvel edge": "Marvel Edge",
+        "marvel frontier": "Marvel Frontier",
+        "marvel illustrated": "Marvel Illustrated",
+        "marvel knights": "Marvel Knights",
+        "marvel magazine group": "Marvel Magazine Group",
+        "marvel mangaverse": "Marvel Mangaverse",
+        "marvel monsters group": "Marvel Monsters Group",
+        "marvel music": "Marvel Music",
+        "marvel next": "Marvel Next",
+        "marvel noir": "Marvel Noir",
+        "marvel press": "Marvel Press",
+        "marvel uk": "Marvel UK",
+        "marvel unlimited": "Marvel Unlimited",
+        "max": "MAX",
+        "mc2": "Marvel Comics 2",
+        "new universe": "New Universe",
+        "non-pareil publishing corp.": "Non-Pareil Publishing Corp.",
+        "paramount comics": "Paramount Comics",
+        "power comics": "Power Comics",
+        "razorline": "Razorline",
+        "star comics": "Star Comics",
+        "timely comics": "Timely Comics",
+        "timely": "Timely Comics",
+        "tsunami": "Tsunami",
+        "ultimate comics": "Ultimate Comics",
+        "ultimate marvel": "Ultimate Marvel",
+        "vital publications, inc.": "Vital Publications, Inc."
+    },
+
+    "DC Comics":{
+        "dc_comics": "",
+        "dc": "",
+        "dccomics": "",
+        "!mpact comics": "Impact Comics",
+        "all star dc": "All-Star",
+        "all star": "All-Star",
+        "all-star dc": "All-Star",
+        "all-star": "All-Star",
+        "america's best comics": "America's Best Comics",
+        "black label": "DC Black Label",
+        "cliffhanger": "Cliffhanger",
+        "cmx manga": "CMX Manga",
+        "dc black label": "DC Black Label",
+        "dc focus": "DC Focus",
+        "dc ink": "DC Ink",
+        "dc zoom": "DC Zoom",
+        "earth m": "Earth M",
+        "earth one": "Earth One",
+        "earth-m": "Earth M",
+        "elseworlds": "Elseworlds",
+        "eo": "Earth One",
+        "first wave": "First Wave",
+        "focus": "DC Focus",
+        "helix": "Helix",
+        "homage comics": "Homage Comics",
+        "impact comics": "Impact Comics",
+        "impact! comics": "Impact Comics",
+        "johnny dc": "Johnny DC",
+        "mad": "Mad",
+        "minx": "Minx",
+        "paradox press": "Paradox Press",
+        "piranha press": "Piranha Press",
+        "sandman universe": "Sandman Universe",
+        "tangent comics": "Tangent Comics",
+        "tsr": "TSR",
+        "vertigo": "Vertigo",
+        "wildstorm productions": "WildStorm Productions",
+        "wildstorm signature": "WildStorm Productions",
+        "wildstorm": "WildStorm Productions",
+        "wonder comics": "Wonder Comics",
+        "young animal": "Young Animal",
+        "zuda comics": "Zuda Comics",
+        "zuda": "Zuda Comics"
+    },
+
+    "Dark Horse Comics":{
+        "berger books": "Berger Books",
+        "comics' greatest world": "Dark Horse Heroes",
+        "dark horse digital": "Dark Horse Digital",
+        "dark horse heroes": "Dark Horse Heroes",
+        "dark horse manga": "Dark Horse Manga",
+        "dh deluxe": "DH Deluxe",
+        "dh press": "DH Press",
+        "kitchen sink books": "Kitchen Sink Books",
+        "legend": "Legend",
+        "m press": "M Press",
+        "maverick": "Maverick"
+    },
+
+    "Archie Comics":{
+        "archie action": "Archie Action",
+        "archie adventure Series": "Archie Adventure Series",
+        "archie horror": "Archie Horror",
+        "dark circle Comics": "Dark Circle Comics",
+        "dark circle": "Dark Circle Comics",
+        "mighty comics Group": "Mighty Comics Group",
+        "radio comics": "Mighty Comics Group",
+        "red circle Comics": "Dark Circle Comics",
+        "red circle": "Dark Circle Comics"
+    },
+
+    "Image Comics": {
+        "Image": "",
+        "avalon studios": "Avalon Studios",
+        "desperado publishing": "Desperado Publishing",
+        "extreme studios": "Extreme Studios",
+        "gorilla comics": "Gorilla Comics",
+        "highbrow entertainment": "Highbrow Entertainment",
+        "shadowline": "Shadowline",
+        "skybound entertainment": "Skybound Entertainment",
+        "todd mcfarlane productions": "Todd McFarlane Productions",
+        "top cow productions": "Top Cow Productions"
+    }
+}

comicapi/filenamelexer.py

@@ -0,0 +1,419 @@
+# Extracted and mutilated from https://github.com/lordwelch/wsfmt
+# Which was extracted and mutilated from https://github.com/golang/go/tree/master/src/text/template/parse
+from __future__ import annotations
+
+import calendar
+import os
+import unicodedata
+from enum import Enum, auto
+from itertools import chain
+from typing import Any, Callable, Protocol
+
+
+class ItemType(Enum):
+    Error = auto()  # Error occurred; value is text of error
+    EOF = auto()
+    Text = auto()  # Text
+    LeftParen = auto()
+    Number = auto()  # Simple number
+    IssueNumber = auto()  # Preceded by a # Symbol
+    RightParen = auto()
+    Space = auto()  # Run of spaces separating arguments
+    Dot = auto()
+    LeftBrace = auto()
+    RightBrace = auto()
+    LeftSBrace = auto()
+    RightSBrace = auto()
+    Symbol = auto()
+    Skip = auto()  # __ or -- no title, issue or series information beyond
+    Operator = auto()
+    Calendar = auto()
+    InfoSpecifier = auto()  # Specifies type of info e.g. v1 for 'volume': 1
+    ArchiveType = auto()
+    Honorific = auto()
+    Publisher = auto()
+    Keywords = auto()
+    FCBD = auto()
+    ComicType = auto()
+    C2C = auto()
+
+
+braces = [
+    ItemType.LeftBrace,
+    ItemType.LeftParen,
+    ItemType.LeftSBrace,
+    ItemType.RightBrace,
+    ItemType.RightParen,
+    ItemType.RightSBrace,
+]
+
+eof = chr(0)
+
+key = {
+    "fcbd": ItemType.FCBD,
+    "freecomicbookday": ItemType.FCBD,
+    "cbr": ItemType.ArchiveType,
+    "cbz": ItemType.ArchiveType,
+    "cbt": ItemType.ArchiveType,
+    "cb7": ItemType.ArchiveType,
+    "rar": ItemType.ArchiveType,
+    "zip": ItemType.ArchiveType,
+    "tar": ItemType.ArchiveType,
+    "7z": ItemType.ArchiveType,
+    "annual": ItemType.ComicType,
+    "volume": ItemType.InfoSpecifier,
+    "vol.": ItemType.InfoSpecifier,
+    "vol": ItemType.InfoSpecifier,
+    "v": ItemType.InfoSpecifier,
+    "of": ItemType.InfoSpecifier,
+    "dc": ItemType.Publisher,
+    "marvel": ItemType.Publisher,
+    "covers": ItemType.InfoSpecifier,
+    "c2c": ItemType.C2C,
+    "mr": ItemType.Honorific,
+    "ms": ItemType.Honorific,
+    "mrs": ItemType.Honorific,
+    "dr": ItemType.Honorific,
+}
+
+
+class Item:
+    def __init__(self, typ: ItemType, pos: int, val: str) -> None:
+        self.typ: ItemType = typ
+        self.pos: int = pos
+        self.val: str = val
+        self.no_space = False
+
+    def __repr__(self) -> str:
+        return f"{self.val}: index: {self.pos}: {self.typ}"
+
+
+class LexerFunc(Protocol):
+    def __call__(self, __origin: Lexer) -> LexerFunc | None: ...
+
+
+class Lexer:
+    def __init__(self, string: str, allow_issue_start_with_letter: bool = False) -> None:
+        self.input: str = string  # The string being scanned
+        # The next lexing function to enter
+        self.state: LexerFunc | None = None
+        self.pos: int = -1  # Current position in the input
+        self.start: int = 0  # Start position of this item
+        self.lastPos: int = 0  # Position of most recent item returned by nextItem
+        self.paren_depth: int = 0  # Nesting depth of ( ) exprs
+        self.brace_depth: int = 0  # Nesting depth of { }
+        self.sbrace_depth: int = 0  # Nesting depth of [ ]
+        self.items: list[Item] = []
+        self.allow_issue_start_with_letter = allow_issue_start_with_letter
+
+    # Next returns the next rune in the input.
+    def get(self) -> str:
+        if int(self.pos) >= len(self.input) - 1:
+            self.pos += 1
+            return eof
+
+        self.pos += 1
+        return self.input[self.pos]
+
+    # Peek returns but does not consume the next rune in the input.
+    def peek(self) -> str:
+        if int(self.pos) >= len(self.input) - 1:
+            return eof
+
+        return self.input[self.pos + 1]
+
+    def backup(self) -> None:
+        self.pos -= 1
+
+    # Emit passes an item back to the client.
+    def emit(self, t: ItemType) -> None:
+        self.items.append(Item(t, self.start, self.input[self.start : self.pos + 1]))
+        self.start = self.pos + 1
+
+    # Ignore skips over the pending input before this point.
+    def ignore(self) -> None:
+        self.start = self.pos
+
+    # Accept consumes the next rune if it's from the valid se:
+    def accept(self, valid: str | Callable[[str], bool]) -> bool:
+        if isinstance(valid, str):
+            if self.get() in valid:
+                return True
+        else:
+            if valid(self.get()):
+                return True
+
+        self.backup()
+        return False
+
+    # AcceptRun consumes a run of runes from the valid set.
+    def accept_run(self, valid: str | Callable[[str], bool]) -> bool:
+        initial = self.pos
+        if isinstance(valid, str):
+            while self.get() in valid:
+                continue
+        else:
+            while valid(self.get()):
+                continue
+
+        self.backup()
+        return initial != self.pos
+
+    def scan_number(self) -> bool:
+        digits = "0123456789.,"
+
+        if not self.accept_run(lambda x: x.isnumeric() or x in digits):
+            return False
+        if self.input[self.pos] == ".":
+            self.backup()
+        self.accept_run(str.isalpha)
+
+        return True
+
+    # Runs the state machine for the lexer.
+    def run(self) -> None:
+        self.state = lex_filename
+        while self.state is not None:
+            self.state = self.state(self)
+
+
+# Errorf returns an error token and terminates the scan by passing
+# Back a nil pointer that will be the next state, terminating self.nextItem.
+def errorf(lex: Lexer, message: str) -> Any:
+    lex.items.append(Item(ItemType.Error, lex.start, message))
+    return None
+
+
+# Scans the elements inside action delimiters.
+def lex_filename(lex: Lexer) -> LexerFunc | None:
+    r = lex.get()
+    if r == eof:
+        if lex.paren_depth != 0:
+            errorf(lex, "unclosed left paren")
+            return None
+
+        if lex.brace_depth != 0:
+            errorf(lex, "unclosed left paren")
+            return None
+        lex.emit(ItemType.EOF)
+        return None
+    elif is_space(r):
+        if r == "_" and lex.peek() == "_":
+            lex.get()
+            lex.emit(ItemType.Skip)
+        else:
+            return lex_space
+    elif r == ".":
+        r = lex.peek()
+        if r.isnumeric() and lex.pos > 0 and is_space(lex.input[lex.pos - 1]):
+            return lex_number
+        lex.emit(ItemType.Dot)
+        return lex_filename
+    elif r == "'":
+        r = lex.peek()
+        if r.isdigit():
+            return lex_number
+        if is_symbol(r):
+            lex.accept_run(is_symbol)
+            lex.emit(ItemType.Symbol)
+        else:
+            return lex_text
+    elif r.isnumeric():
+        lex.backup()
+        return lex_number
+    elif r == "#":
+        if lex.allow_issue_start_with_letter and is_alpha_numeric(lex.peek()):
+            return lex_issue_number
+        elif lex.peek().isnumeric() or lex.peek() in "-+.":
+            return lex_issue_number
+        lex.emit(ItemType.Symbol)
+    elif is_operator(r):
+        if r == "-" and lex.peek() == "-":
+            lex.get()
+            lex.emit(ItemType.Skip)
+        else:
+            return lex_operator
+    elif is_alpha_numeric(r):
+        lex.backup()
+        return lex_text
+    elif r == "(":
+        lex.emit(ItemType.LeftParen)
+        lex.paren_depth += 1
+    elif r == ")":
+        lex.emit(ItemType.RightParen)
+        lex.paren_depth -= 1
+        if lex.paren_depth < 0:
+            errorf(lex, "unexpected right paren " + r)
+            return None
+
+    elif r == "{":
+        lex.emit(ItemType.LeftBrace)
+        lex.brace_depth += 1
+    elif r == "}":
+        lex.emit(ItemType.RightBrace)
+        lex.brace_depth -= 1
+        if lex.brace_depth < 0:
+            errorf(lex, "unexpected right brace " + r)
+            return None
+
+    elif r == "[":
+        lex.emit(ItemType.LeftSBrace)
+        lex.sbrace_depth += 1
+    elif r == "]":
+        lex.emit(ItemType.RightSBrace)
+        lex.sbrace_depth -= 1
+        if lex.sbrace_depth < 0:
+            errorf(lex, "unexpected right brace " + r)
+            return None
+    elif is_symbol(r):
+        if unicodedata.category(r) == "Sc":
+            return lex_currency
+        lex.accept_run(is_symbol)
+        lex.emit(ItemType.Symbol)
+    else:
+        errorf(lex, "unrecognized character in action: " + repr(r))
+        return None
+
+    return lex_filename
+
+
+def lex_currency(lex: Lexer) -> LexerFunc:
+    orig = lex.pos
+    lex.accept_run(is_space)
+    if lex.peek().isnumeric():
+        return lex_number
+    else:
+        lex.pos = orig
+    # We don't have a number with this currency symbol. Don't treat it special
+    lex.emit(ItemType.Symbol)
+    return lex_filename
+
+
+def lex_operator(lex: Lexer) -> LexerFunc:
+    lex.accept_run("-|:;")
+    lex.emit(ItemType.Operator)
+    return lex_filename
+
+
+# LexSpace scans a run of space characters.
+# One space has already been seen.
+def lex_space(lex: Lexer) -> LexerFunc:
+    lex.accept_run(is_space)
+
+    lex.emit(ItemType.Space)
+    return lex_filename
+
+
+# Lex_text scans an alphanumeric.
+def lex_text(lex: Lexer) -> LexerFunc:
+    while True:
+        r = lex.get()
+        if is_alpha_numeric(r) or r in "'":
+            if r.isnumeric():  # E.g. v1
+                word = lex.input[lex.start : lex.pos]
+                if key.get(word.casefold(), None) == ItemType.InfoSpecifier:
+                    lex.backup()
+                    lex.emit(key[word.casefold()])
+                    return lex_filename
+        else:
+            lex.backup()
+            word = lex.input[lex.start : lex.pos + 1]
+
+            if word.casefold() in key:
+                if key[word.casefold()] in (ItemType.Honorific, ItemType.InfoSpecifier):
+                    lex.accept(".")
+                lex.emit(key[word.casefold()])
+            elif cal(word):
+                lex.emit(ItemType.Calendar)
+            else:
+                lex.emit(ItemType.Text)
+            break
+
+    return lex_filename
+
+
+def cal(value: str) -> bool:
+    return value.title() in set(chain(calendar.month_abbr, calendar.month_name, calendar.day_abbr, calendar.day_name))
+
+
+def lex_number(lex: Lexer) -> LexerFunc | None:
+    if not lex.scan_number():
+        return errorf(lex, "bad number syntax: " + lex.input[lex.start : lex.pos])
+    # Complex number logic removed. Messes with math operations without space
+
+    if lex.input[lex.start] == "#":
+        lex.emit(ItemType.IssueNumber)
+    elif not lex.input[lex.pos].isnumeric():
+        # Assume that 80th is just text and not a number
+        lex.emit(ItemType.Text)
+    else:
+        # Used to check for a '$'
+        endNumber = lex.pos
+
+        # Consume any spaces
+        lex.accept_run(is_space)
+
+        # This number starts with a '$' emit it as Text instead of a Number
+        if "Sc" == unicodedata.category(lex.input[lex.start]):
+            lex.pos = endNumber
+            lex.emit(ItemType.Text)
+
+        # This number ends in a '$' if there is a number on the other side we assume it belongs to the following number
+        elif "Sc" == unicodedata.category(lex.get()):
+            # Store the end of the number '$'. We still need to check to see if there is a number coming up
+            endCurrency = lex.pos
+            # Consume any spaces
+            lex.accept_run(is_space)
+
+            # This is a number
+            if lex.peek().isnumeric():
+                # We go back to the original number before the '$' and emit a number
+                lex.pos = endNumber
+                lex.emit(ItemType.Number)
+            else:
+                # There was no following number, reset to the '$' and emit a number
+                lex.pos = endCurrency
+                lex.emit(ItemType.Text)
+        else:
+            # We go back to the original number there is no '$'
+            lex.pos = endNumber
+            lex.emit(ItemType.Number)
+
+    return lex_filename
+
+
+def lex_issue_number(lex: Lexer) -> LexerFunc:
+    # Only called when lex.input[lex.start] == "#"
+    original_start = lex.pos
+    lex.accept_run(str.isalpha)
+
+    if lex.peek().isnumeric():
+        return lex_number
+    else:
+        lex.pos = original_start
+        lex.emit(ItemType.Symbol)
+
+    return lex_filename
+
+
+def is_space(character: str) -> bool:
+    return character in "_ \t"
+
+
+# IsAlphaNumeric reports whether r is an alphabetic, digit, or underscore.
+def is_alpha_numeric(character: str) -> bool:
+    return character.isalpha() or character.isnumeric()
+
+
+def is_operator(character: str) -> bool:
+    return character in "-|:;/\\"
+
+
+def is_symbol(character: str) -> bool:
+    return unicodedata.category(character)[0] in "PS" and character != "."
+
+
+def Lex(filename: str, allow_issue_start_with_letter: bool = False) -> Lexer:
+    lex = Lexer(os.path.basename(filename), allow_issue_start_with_letter)
+    lex.run()
+    return lex

comicapi/genericmetadata.py

@@ -0,0 +1,884 @@
+"""A class for internal metadata storage
+
+The goal of this class is to handle ALL the data that might come from various
+tagging schemes and databases, such as ComicVine or GCD.  This makes conversion
+possible, however lossy it might be
+
+"""
+
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import copy
+import dataclasses
+import hashlib
+import logging
+from collections.abc import Sequence
+from typing import TYPE_CHECKING, Any, Union, overload
+
+from typing_extensions import NamedTuple
+
+from comicapi import merge, utils
+from comicapi._url import Url, parse_url
+from comicapi.utils import norm_fold
+
+# needed for runtime type guessing
+if TYPE_CHECKING:
+    Union
+
+logger = logging.getLogger(__name__)
+
+
+REMOVE = object()
+
+
+Credit = merge.Credit
+
+
+class PageType(merge.StrEnum):
+    """
+    These page info classes are exactly the same as the CIX scheme, since
+    it's unique
+    """
+
+    FrontCover = "FrontCover"
+    InnerCover = "InnerCover"
+    Roundup = "Roundup"
+    Story = "Story"
+    Advertisement = "Advertisement"
+    Editorial = "Editorial"
+    Letters = "Letters"
+    Preview = "Preview"
+    BackCover = "BackCover"
+    Other = "Other"
+    Deleted = "Deleted"
+
+
+@dataclasses.dataclass
+class PageMetadata:
+    filename: str
+    type: str
+    bookmark: str
+    display_index: int
+    archive_index: int
+    # These are optional because getting this info requires reading in each page
+    double_page: bool | None = None
+    byte_size: int | None = None
+    height: int | None = None
+    width: int | None = None
+
+    def set_type(self, value: str) -> None:
+        values = {x.casefold(): x for x in PageType}
+        self.type = values.get(value.casefold(), value)
+
+    def is_double_page(self) -> bool:
+        w = self.width or 0
+        h = self.height or 0
+        return self.double_page or (w >= h and w > 0 and h > 0)
+
+    def __lt__(self, other: Any) -> bool:
+        if not isinstance(other, PageMetadata):
+            return False
+        return self.archive_index < other.archive_index
+
+    def __eq__(self, other: Any) -> bool:
+        if not isinstance(other, PageMetadata):
+            return False
+        return self.archive_index == other.archive_index
+
+    def _get_clean_metadata(self, *attributes: str) -> PageMetadata:
+        return PageMetadata(
+            filename=self.filename if "filename" in attributes else "",
+            type=self.type if "type" in attributes else "",
+            bookmark=self.bookmark if "bookmark" in attributes else "",
+            display_index=self.display_index if "display_index" in attributes else 0,
+            archive_index=self.archive_index if "archive_index" in attributes else 0,
+            double_page=self.double_page if "double_page" in attributes else None,
+            byte_size=self.byte_size if "byte_size" in attributes else None,
+            height=self.height if "height" in attributes else None,
+            width=self.width if "width" in attributes else None,
+        )
+
+
+@dataclasses.dataclass
+class ComicSeries:
+    id: str
+    name: str
+    aliases: set[str]
+    count_of_issues: int | None
+    count_of_volumes: int | None
+    description: str
+    image_url: str
+    publisher: str
+    start_year: int | None
+    format: str | None
+
+    def copy(self) -> ComicSeries:
+        return copy.deepcopy(self)
+
+
+class MetadataOrigin(NamedTuple):
+    id: str
+    name: str
+
+    def __str__(self) -> str:
+        return self.name
+
+
+class ImageHash(NamedTuple):
+    """
+    A valid ImageHash requires at a minimum a Hash and Kind or a URL
+    If only a URL is given, it will be used for cover matching otherwise Hash is used
+    The URL is also required for the GUI to display covers
+    Available Kind's are "ahash" and "phash"
+    """
+
+    Hash: int
+    Kind: str
+    URL: str
+
+
+class FileHash(NamedTuple):
+    name: str
+    hash: str
+
+    def __str__(self) -> str:
+        return self.name + ":" + self.hash
+
+    @classmethod
+    def parse(cls, string: str) -> FileHash:
+        name, _, parsed_hash = string.partition(":")
+        if name in hashlib.algorithms_available:
+            return FileHash(name, parsed_hash)
+        return FileHash("", "")
+
+    def __bool__(self) -> bool:
+        return all(self)
+
+
+@dataclasses.dataclass
+class GenericMetadata:
+    writer_synonyms = ("writer", "plotter", "scripter", "script")
+    penciller_synonyms = ("artist", "penciller", "penciler", "breakdowns", "pencils", "painting")
+    inker_synonyms = ("inker", "artist", "finishes", "inks", "painting")
+    colorist_synonyms = ("colorist", "colourist", "colorer", "colourer", "colors", "painting")
+    letterer_synonyms = ("letterer", "letters")
+    cover_synonyms = ("cover", "covers", "coverartist", "cover artist")
+    editor_synonyms = ("editor", "edits", "editing")
+    translator_synonyms = ("translator", "translation")
+
+    is_empty: bool = True
+    data_origin: MetadataOrigin | None = None
+    issue_id: str | None = None
+    series_id: str | None = None
+    original_hash: FileHash | None = None
+
+    series: str | None = None
+    series_aliases: set[str] = dataclasses.field(default_factory=set)
+    issue: str | None = None
+    issue_count: int | None = None
+    title: str | None = None
+    title_aliases: set[str] = dataclasses.field(default_factory=set)
+    volume: int | None = None
+    volume_count: int | None = None
+    genres: set[str] = dataclasses.field(default_factory=set)
+    description: str | None = None  # use same way as Summary in CIX
+    notes: str | None = None
+
+    alternate_series: str | None = None
+    alternate_number: str | None = None
+    alternate_count: int | None = None
+    story_arcs: list[str] = dataclasses.field(default_factory=list)
+    series_groups: list[str] = dataclasses.field(default_factory=list)
+
+    publisher: str | None = None
+    imprint: str | None = None
+    day: int | None = None
+    month: int | None = None
+    year: int | None = None
+    language: str | None = None  # 2 letter iso code
+    country: str | None = None
+    web_links: list[Url] = dataclasses.field(default_factory=list)
+    format: str | None = None
+    manga: str | None = None
+    black_and_white: bool | None = None
+    maturity_rating: str | None = None
+    critical_rating: float | None = None  # rating in CBL; CommunityRating in CIX
+    scan_info: str | None = None
+
+    tags: set[str] = dataclasses.field(default_factory=set)
+    pages: list[PageMetadata] = dataclasses.field(default_factory=list)
+    page_count: int | None = None
+
+    characters: set[str] = dataclasses.field(default_factory=set)
+    teams: set[str] = dataclasses.field(default_factory=set)
+    locations: set[str] = dataclasses.field(default_factory=set)
+    credits: list[Credit] = dataclasses.field(default_factory=list)
+
+    # Some CoMet-only items
+    price: float | None = None
+    is_version_of: str | None = None
+    rights: str | None = None
+    identifier: str | None = None
+    last_mark: str | None = None
+
+    # urls to cover image, not generally part of the metadata
+    _cover_image: ImageHash | None = None
+    _alternate_images: list[ImageHash] = dataclasses.field(default_factory=list)
+
+    def __post_init__(self) -> None:
+        for key, value in self.__dict__.items():
+            if value and key != "is_empty":
+                self.is_empty = False
+                break
+
+    def copy(self) -> GenericMetadata:
+        return copy.deepcopy(self)
+
+    def replace(self, /, **kwargs: Any) -> GenericMetadata:
+        tmp = self.copy()
+        tmp.__dict__.update(kwargs)
+        return tmp
+
+    def _get_clean_metadata(self, *attributes: str) -> GenericMetadata:
+        new_md = GenericMetadata()
+        list_handled = []
+        for attr in sorted(attributes):
+            if "." in attr:
+                lst, _, name = attr.partition(".")
+                if lst in list_handled:
+                    continue
+                old_value = getattr(self, lst)
+                new_value = getattr(new_md, lst)
+                if old_value:
+                    if hasattr(old_value[0], "_get_clean_metadata"):
+                        list_attributes = [x.removeprefix(lst + ".") for x in attributes if x.startswith(lst)]
+                        for x in old_value:
+                            new_value.append(x._get_clean_metadata(*list_attributes))
+                        list_handled.append(lst)
+                        continue
+                    if not new_value:
+                        for x in old_value:
+                            new_value.append(x.__class__())
+                    for i, x in enumerate(old_value):
+                        if isinstance(x, dict):
+                            if name in x:
+                                new_value[i][name] = x[name]
+                        else:
+                            setattr(new_value[i], name, getattr(x, name))
+
+            else:
+                old_value = getattr(self, attr)
+                if isinstance(old_value, list):
+                    continue
+                setattr(new_md, attr, old_value)
+
+        new_md.__post_init__()
+        return new_md
+
+    def overlay(
+        self, new_md: GenericMetadata, mode: merge.Mode = merge.Mode.OVERLAY, merge_lists: bool = False
+    ) -> None:
+        """Overlay a new metadata object on this one"""
+
+        attribute_merge = merge.attribute[mode]
+        list_merge = merge.lists[mode]
+
+        def assign(old: Any, new: Any, attribute_merge: Any = attribute_merge) -> Any:
+            if new is REMOVE:
+                return None
+
+            return attribute_merge(old, new)
+
+        def assign_list(old: list[Any] | set[Any], new: list[Any] | set[Any], list_merge: Any = list_merge) -> Any:
+            if new is REMOVE:
+                old.clear()
+                return old
+            if merge_lists:
+                return list_merge(old, new)
+            else:
+                return assign(old, new)
+
+        if not new_md.is_empty:
+            self.is_empty = False
+
+        self.data_origin = assign(self.data_origin, new_md.data_origin)  # TODO use and purpose now?
+        self.issue_id = assign(self.issue_id, new_md.issue_id)
+        self.series_id = assign(self.series_id, new_md.series_id)
+
+        # This should not usually be set by a talker or other online datasource
+        self.original_hash = assign(self.original_hash, new_md.original_hash)
+
+        self.series = assign(self.series, new_md.series)
+
+        self.series_aliases = assign_list(self.series_aliases, new_md.series_aliases)
+        self.issue = assign(self.issue, new_md.issue)
+        self.issue_count = assign(self.issue_count, new_md.issue_count)
+        self.title = assign(self.title, new_md.title)
+        self.title_aliases = assign_list(self.title_aliases, new_md.title_aliases)
+        self.volume = assign(self.volume, new_md.volume)
+        self.volume_count = assign(self.volume_count, new_md.volume_count)
+        self.genres = assign_list(self.genres, new_md.genres)
+        self.description = assign(self.description, new_md.description)
+        self.notes = assign(self.notes, new_md.notes)
+
+        self.alternate_series = assign(self.alternate_series, new_md.alternate_series)
+        self.alternate_number = assign(self.alternate_number, new_md.alternate_number)
+        self.alternate_count = assign(self.alternate_count, new_md.alternate_count)
+        self.story_arcs = assign_list(self.story_arcs, new_md.story_arcs)
+        self.series_groups = assign_list(self.series_groups, new_md.series_groups)
+
+        self.publisher = assign(self.publisher, new_md.publisher)
+        self.imprint = assign(self.imprint, new_md.imprint)
+        self.day = assign(self.day, new_md.day)
+        self.month = assign(self.month, new_md.month)
+        self.year = assign(self.year, new_md.year)
+        self.language = assign(self.language, new_md.language)
+        self.country = assign(self.country, new_md.country)
+        self.web_links = assign_list(self.web_links, new_md.web_links)
+        self.format = assign(self.format, new_md.format)
+        self.manga = assign(self.manga, new_md.manga)
+        self.black_and_white = assign(self.black_and_white, new_md.black_and_white)
+        self.maturity_rating = assign(self.maturity_rating, new_md.maturity_rating)
+        self.critical_rating = assign(self.critical_rating, new_md.critical_rating)
+        self.scan_info = assign(self.scan_info, new_md.scan_info)
+
+        self.tags = assign_list(self.tags, new_md.tags)
+
+        self.characters = assign_list(self.characters, new_md.characters)
+        self.teams = assign_list(self.teams, new_md.teams)
+        self.locations = assign_list(self.locations, new_md.locations)
+
+        # credits are added through add_credit so that some standard checks are observed
+        # which means that we needs self.credits to be empty
+        tmp_credits = self.credits
+        self.credits = []
+        for c in assign_list(tmp_credits, new_md.credits):
+            self.add_credit(c)
+
+        self.price = assign(self.price, new_md.price)
+        self.is_version_of = assign(self.is_version_of, new_md.is_version_of)
+        self.rights = assign(self.rights, new_md.rights)
+        self.identifier = assign(self.identifier, new_md.identifier)
+        self.last_mark = assign(self.last_mark, new_md.last_mark)
+        self._cover_image = assign(self._cover_image, new_md._cover_image)
+        self._alternate_images = assign_list(self._alternate_images, new_md._alternate_images)
+
+        # pages doesn't get merged, if we did merge we would end up with duplicate pages
+        self.pages = assign(self.pages, new_md.pages)
+        self.page_count = assign(self.page_count, new_md.page_count)
+
+    def apply_default_page_list(self, page_list: Sequence[str]) -> None:
+        """apply a default page list, with the first page marked as the cover"""
+
+        # Create a dictionary in the weird case that the metadata doesn't match the archive
+        pages = {p.archive_index: p for p in self.pages}
+        cover_set = False
+
+        # It might be a good idea to validate that each page in `pages` is found in page_list
+        for i, filename in enumerate(page_list):
+            page = pages.get(i, PageMetadata(archive_index=i, display_index=i, filename="", type="", bookmark=""))
+            page.filename = filename
+            pages[i] = page
+
+            # Check if we know what the cover is
+            cover_set = page.type == PageType.FrontCover or cover_set
+        self.pages = sorted(pages.values())
+
+        self.page_count = len(self.pages)
+        if self.page_count != len(page_list):
+            logger.warning("Wrong count of pages: expected %d got %d", len(self.pages), len(page_list))
+        # Set the cover to the first image acording to hte display index if we don't know what the cover is
+        if not cover_set:
+            first_page = self.get_archive_page_index(0)
+            self.pages[first_page].type = PageType.FrontCover
+
+    def get_archive_page_index(self, pagenum: int) -> int:
+        """convert the displayed page number to the page index of the file in the archive"""
+        if pagenum < len(self.pages):
+            return int(sorted(self.pages, key=lambda p: p.display_index)[pagenum].archive_index)
+
+        return 0
+
+    def get_cover_page_index_list(self) -> list[int]:
+        # return a list of archive page indices of cover pages
+        if not self.pages:
+            return [0]
+        coverlist = []
+        for p in self.pages:
+            if p.type == PageType.FrontCover:
+                coverlist.append(p.archive_index)
+
+        if len(coverlist) == 0:
+            coverlist.append(self.get_archive_page_index(0))
+
+        return coverlist
+
+    @overload
+    def add_credit(self, person: Credit) -> None: ...
+
+    @overload
+    def add_credit(self, person: str, role: str, primary: bool = False, language: str = "") -> None: ...
+
+    def add_credit(
+        self, person: str | Credit, role: str | None = None, primary: bool = False, language: str = ""
+    ) -> None:
+
+        credit: Credit
+        if isinstance(person, Credit):
+            credit = person
+        else:
+            assert role is not None
+            credit = Credit(person=person, role=role, primary=primary, language=language)
+
+        if credit.role is None:
+            raise TypeError("GenericMetadata.add_credit takes either a Credit object or a person name and role")
+        if credit.person == "":
+            return
+
+        person = norm_fold(credit.person)
+        role = norm_fold(credit.role)
+
+        # look to see if it's not already there...
+        found = False
+        for c in self.credits:
+            if norm_fold(c.person) == person and norm_fold(c.role) == role:
+                # no need to add it. just adjust the "primary" flag as needed
+                c.primary = c.primary or primary
+                found = True
+                break
+
+        if not found:
+            self.credits.append(credit)
+
+    def get_primary_credit(self, role: str) -> str:
+        primary = ""
+        for credit in self.credits:
+            if (primary == "" and credit.role.casefold() == role.casefold()) or (
+                credit.role.casefold() == role.casefold() and credit.primary
+            ):
+                primary = credit.person
+        return primary
+
+    def __str__(self) -> str:
+        vals: list[tuple[str, Any]] = []
+        if self.is_empty:
+            return "No metadata"
+
+        def add_string(tag: str, val: Any) -> None:
+            if isinstance(val, (Sequence, set)):
+                if val:
+                    vals.append((tag, val))
+            elif val is not None:
+                vals.append((tag, val))
+
+        add_string("data_origin", self.data_origin)
+        add_string("series", self.series)
+        add_string("original_hash", self.original_hash)
+        add_string("series_aliases", ",".join(self.series_aliases))
+        add_string("issue", self.issue)
+        add_string("issue_count", self.issue_count)
+        add_string("title", self.title)
+        add_string("title_aliases", ",".join(self.title_aliases))
+        add_string("publisher", self.publisher)
+        add_string("year", self.year)
+        add_string("month", self.month)
+        add_string("day", self.day)
+        add_string("volume", self.volume)
+        add_string("volume_count", self.volume_count)
+        add_string("genres", ", ".join(self.genres))
+        add_string("language", self.language)
+        add_string("country", self.country)
+        add_string("critical_rating", self.critical_rating)
+        add_string("alternate_series", self.alternate_series)
+        add_string("alternate_number", self.alternate_number)
+        add_string("alternate_count", self.alternate_count)
+        add_string("imprint", self.imprint)
+        add_string("web_links", [str(x) for x in self.web_links])
+        add_string("format", self.format)
+        add_string("manga", self.manga)
+
+        add_string("price", self.price)
+        add_string("is_version_of", self.is_version_of)
+        add_string("rights", self.rights)
+        add_string("identifier", self.identifier)
+        add_string("last_mark", self.last_mark)
+
+        if self.black_and_white:
+            add_string("black_and_white", self.black_and_white)
+        add_string("maturity_rating", self.maturity_rating)
+        add_string("story_arcs", self.story_arcs)
+        add_string("series_groups", self.series_groups)
+        add_string("scan_info", self.scan_info)
+        add_string("characters", ", ".join(self.characters))
+        add_string("teams", ", ".join(self.teams))
+        add_string("locations", ", ".join(self.locations))
+        add_string("description", self.description)
+        add_string("notes", self.notes)
+
+        add_string("tags", ", ".join(self.tags))
+
+        for c in self.credits:
+            primary = ""
+            if c.primary:
+                primary = " [P]"
+            add_string("credit", f"{c}{primary}")
+
+        # find the longest field name
+        flen = 0
+        for i in vals:
+            flen = max(flen, len(i[0]))
+        flen += 1
+
+        # format the data nicely
+        outstr = ""
+        fmt_str = "{0: <" + str(flen) + "} {1}\n"
+        for i in vals:
+            outstr += fmt_str.format(i[0] + ":", i[1])
+
+        return outstr
+
+    def fix_publisher(self) -> None:
+        if self.publisher is None:
+            return
+        if self.imprint is None:
+            self.imprint = ""
+
+        imprint, publisher = utils.get_publisher(self.publisher)
+
+        self.publisher = publisher
+
+        if self.imprint.casefold() in publisher.casefold():
+            self.imprint = None
+
+        if self.imprint is None or self.imprint == "":
+            self.imprint = imprint
+        elif self.imprint.casefold() in imprint.casefold():
+            self.imprint = imprint
+
+
+md_test: GenericMetadata = GenericMetadata(
+    is_empty=False,
+    data_origin=MetadataOrigin("comicvine", "Comic Vine"),
+    series="Cory Doctorow's Futuristic Tales of the Here and Now",
+    series_id="23437",
+    issue="1",
+    issue_id="140529",
+    title="Anda's Game",
+    publisher="IDW Publishing",
+    month=10,
+    year=2007,
+    day=1,
+    issue_count=6,
+    volume=1,
+    genres={"Sci-Fi"},
+    language="en",
+    description=(
+        "For 12-year-old Anda, getting paid real money to kill the characters of players who were cheating"
+        " in her favorite online computer game was a win-win situation. Until she found out who was paying her,"
+        " and what those characters meant to the livelihood of children around the world."
+    ),
+    volume_count=None,
+    critical_rating=3.0,
+    country=None,
+    alternate_series="Tales",
+    alternate_number="2",
+    alternate_count=7,
+    imprint="craphound.com",
+    notes="Tagged with ComicTagger 1.3.2a5 using info from Comic Vine on 2022-04-16 15:52:26. [Issue ID 140529]",
+    web_links=[
+        parse_url("https://comicvine.gamespot.com/cory-doctorows-futuristic-tales-of-the-here-and-no/4000-140529/")
+    ],
+    format="Series",
+    manga="No",
+    black_and_white=None,
+    page_count=24,
+    maturity_rating="Everyone 10+",
+    story_arcs=["Here and Now"],
+    series_groups=["Futuristic Tales"],
+    scan_info="(CC BY-NC-SA 3.0)",
+    characters={"Anda"},
+    teams={"Fahrenheit"},
+    locations=set(utils.split("lonely  cottage ", ",")),
+    credits=[
+        Credit(primary=False, person="Dara Naraghi", role="Writer"),
+        Credit(primary=False, person="Esteve Polls", role="Penciller"),
+        Credit(primary=False, person="Esteve Polls", role="Inker"),
+        Credit(primary=False, person="Neil Uyetake", role="Letterer"),
+        Credit(primary=False, person="Sam Kieth", role="Cover"),
+        Credit(primary=False, person="Ted Adams", role="Editor"),
+    ],
+    tags=set(),
+    pages=[
+        PageMetadata(
+            archive_index=0,
+            display_index=0,
+            height=1280,
+            byte_size=195977,
+            width=800,
+            type=PageType.FrontCover,
+            filename="!cover.jpg",
+            bookmark="",
+        ),
+        PageMetadata(
+            archive_index=1,
+            display_index=1,
+            height=2039,
+            byte_size=611993,
+            width=1327,
+            filename="01.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=2,
+            display_index=2,
+            height=2039,
+            byte_size=783726,
+            width=1327,
+            filename="02.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=3,
+            display_index=3,
+            height=2039,
+            byte_size=679584,
+            width=1327,
+            filename="03.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=4,
+            display_index=4,
+            height=2039,
+            byte_size=788179,
+            width=1327,
+            filename="04.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=5,
+            display_index=5,
+            height=2039,
+            byte_size=864433,
+            width=1327,
+            filename="05.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=6,
+            display_index=6,
+            height=2039,
+            byte_size=765606,
+            width=1327,
+            filename="06.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=7,
+            display_index=7,
+            height=2039,
+            byte_size=876427,
+            width=1327,
+            filename="07.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=8,
+            display_index=8,
+            height=2039,
+            byte_size=852622,
+            width=1327,
+            filename="08.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=9,
+            display_index=9,
+            height=2039,
+            byte_size=800205,
+            width=1327,
+            filename="09.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=10,
+            display_index=10,
+            height=2039,
+            byte_size=746243,
+            width=1326,
+            filename="10.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=11,
+            display_index=11,
+            height=2039,
+            byte_size=718062,
+            width=1327,
+            filename="11.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=12,
+            display_index=12,
+            height=2039,
+            byte_size=532179,
+            width=1326,
+            filename="12.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=13,
+            display_index=13,
+            height=2039,
+            byte_size=686708,
+            width=1327,
+            filename="13.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=14,
+            display_index=14,
+            height=2039,
+            byte_size=641907,
+            width=1327,
+            filename="14.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=15,
+            display_index=15,
+            height=2039,
+            byte_size=805388,
+            width=1327,
+            filename="15.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=16,
+            display_index=16,
+            height=2039,
+            byte_size=668927,
+            width=1326,
+            filename="16.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=17,
+            display_index=17,
+            height=2039,
+            byte_size=710605,
+            width=1327,
+            filename="17.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=18,
+            display_index=18,
+            height=2039,
+            byte_size=761398,
+            width=1326,
+            filename="18.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=19,
+            display_index=19,
+            height=2039,
+            byte_size=743807,
+            width=1327,
+            filename="19.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=20,
+            display_index=20,
+            height=2039,
+            byte_size=552911,
+            width=1326,
+            filename="20.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=21,
+            display_index=21,
+            height=2039,
+            byte_size=556827,
+            width=1327,
+            filename="21.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            archive_index=22,
+            display_index=22,
+            height=2039,
+            byte_size=675078,
+            width=1326,
+            filename="22.jpg",
+            bookmark="",
+            type="",
+        ),
+        PageMetadata(
+            bookmark="Interview",
+            archive_index=23,
+            display_index=23,
+            height=2032,
+            byte_size=800965,
+            width=1338,
+            type=PageType.Letters,
+            filename="23.jpg",
+        ),
+    ],
+    price=None,
+    is_version_of=None,
+    rights=None,
+    identifier=None,
+    last_mark=None,
+    _cover_image=None,
+)
+
+
+__all__ = (
+    "Url",
+    "parse_url",
+    "PageType",
+    "PageMetadata",
+    "Credit",
+    "ComicSeries",
+    "MetadataOrigin",
+    "GenericMetadata",
+)

comicapi/issuestring.py

@@ -0,0 +1,130 @@
+"""Support for mixed digit/string type Issue field
+
+Class for handling the odd permutations of an 'issue number' that the
+comics industry throws at us.
+  e.g.: "12", "12.1", "0", "-1", "5AU", "100-2"
+"""
+
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+import unicodedata
+
+logger = logging.getLogger(__name__)
+
+
+class IssueString:
+    def __init__(self, text: str | None) -> None:
+        # break up the issue number string into 2 parts: the numeric and suffix string.
+        # (assumes that the numeric portion is always first)
+
+        self.num = None
+        self.suffix = ""
+        self.prefix = ""
+
+        if text is None:
+            return
+
+        text = str(text)
+
+        if len(text) == 0:
+            return
+
+        for idx, r in enumerate(text):
+            if not r.isalpha():
+                break
+        self.prefix = text[:idx]
+        self.num, self.suffix = self.get_number(text[idx:])
+
+    def get_number(self, text: str) -> tuple[float | None, str]:
+        num, suffix = None, ""
+        start = 0
+        # skip the minus sign if it's first
+        if text[0] in ("-", "+"):
+            start = 1
+
+        # if it's still not numeric at start skip it
+        if text[start].isdigit() or text[start] == ".":
+            # walk through the string, look for split point (the first non-numeric)
+            decimal_count = 0
+            for idx in range(start, len(text)):
+                if not (text[idx].isdigit() or text[idx] in "."):
+                    break
+                # special case: also split on second "."
+                if text[idx] == ".":
+                    decimal_count += 1
+                    if decimal_count > 1:
+                        break
+            else:
+                idx = len(text)
+
+            # move trailing numeric decimal to suffix
+            # (only if there is other junk after )
+            if text[idx - 1] == "." and len(text) != idx:
+                idx = idx - 1
+
+            # if there is no numeric after the minus, make the minus part of the suffix
+            if idx == 1 and start == 1:
+                idx = 0
+
+            if text[0:idx]:
+                num = float(text[0:idx])
+            suffix = text[idx : len(text)]
+        else:
+            suffix = text
+        return num, suffix
+
+    def as_string(self, pad: int = 0) -> str:
+        """return the number, left side zero-padded, with suffix attached"""
+
+        # if there is no number return the text
+        if self.num is None:
+            return self.prefix + self.suffix
+
+        # negative is added back in last
+        negative = self.num < 0
+        num_f = abs(self.num)
+
+        # used for padding
+        num_int = int(num_f)
+
+        if num_f.is_integer():
+            num_s = str(num_int)
+        else:
+            num_s = str(num_f)
+
+        # create padding
+        padding = ""
+        # we only pad the whole number part, we don't care about the decimal
+        length = len(str(num_int))
+        if length < pad:
+            padding = "0" * (pad - length)
+
+        # add the padding to the front
+        num_s = padding + num_s
+
+        # finally add the negative back in
+        if negative:
+            num_s = "-" + num_s
+
+        # return the prefix + formatted number + suffix
+        return self.prefix + num_s + self.suffix
+
+    def as_float(self) -> float | None:
+        # return the float, with no suffix
+        if len(self.suffix) == 1 and self.suffix.isnumeric():
+            return (self.num or 0) + unicodedata.numeric(self.suffix)
+        return self.num

comicapi/merge.py

@@ -0,0 +1,72 @@
+from __future__ import annotations
+
+import dataclasses
+from collections.abc import Collection
+from enum import auto
+from typing import Any, Callable
+
+from comicapi.utils import DefaultDict, StrEnum, norm_fold
+
+
+@dataclasses.dataclass
+class Credit:
+    person: str = ""
+    role: str = ""
+    primary: bool = False
+    language: str = ""  # Should be ISO 639 language code
+
+    def __str__(self) -> str:
+        lang = ""
+        if self.language:
+            lang = f" [{self.language}]"
+        return f"{self.role}: {self.person}{lang}"
+
+
+class Mode(StrEnum):
+    OVERLAY = auto()
+    ADD_MISSING = auto()
+
+
+def merge_lists(old: Collection[Any], new: Collection[Any]) -> list[Any] | set[Any]:
+    """Dedupes normalised (NFKD), casefolded values using 'new' values on collisions"""
+    if len(new) == 0:
+        return old if isinstance(old, set) else list(old)
+    if len(old) == 0:
+        return new if isinstance(new, set) else list(new)
+
+    # Create dict to preserve case
+    new_dict = {norm_fold(str(n)): n for n in new}
+    old_dict = {norm_fold(str(c)): c for c in old}
+
+    old_dict.update(new_dict)
+
+    if isinstance(old, set):
+        return set(old_dict.values())
+
+    return list(old_dict.values())
+
+
+def overlay(old: Any, new: Any) -> Any:
+    """overlay - When the `new` object is not empty, replace `old` with `new`."""
+    if new is None or (isinstance(new, Collection) and len(new) == 0):
+        return old
+
+    return new
+
+
+attribute: DefaultDict[Mode, Callable[[Any, Any], Any]] = DefaultDict(
+    {
+        Mode.OVERLAY: overlay,
+        Mode.ADD_MISSING: lambda old, new: overlay(new, old),
+    },
+    default=lambda x: overlay,
+)
+
+
+lists: DefaultDict[Mode, Callable[[Collection[Any], Collection[Any]], list[Any] | set[Any]]] = DefaultDict(
+    {
+        Mode.OVERLAY: merge_lists,
+        Mode.ADD_MISSING: lambda old, new: merge_lists(new, old),
+    },
+    default=lambda x: overlay,
+)

comicapi/tags/__init__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from comicapi.tags.tag import Tag
+
+__all__ = ["Tag"]

comicapi/tags/comicrack.py

@@ -0,0 +1,416 @@
+"""A class to encapsulate ComicRack's ComicInfo.xml data"""
+
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+import xml.etree.ElementTree as ET
+from typing import Any
+
+from comicapi import utils
+from comicapi.archivers import Archiver
+from comicapi.genericmetadata import FileHash, GenericMetadata, PageMetadata
+from comicapi.tags import Tag
+
+logger = logging.getLogger(__name__)
+
+
+class ComicRack(Tag):
+    enabled = True
+
+    id = "cr"
+
+    def __init__(self, version: str) -> None:
+        super().__init__(version)
+
+        self.file = "ComicInfo.xml"
+        self.supported_attributes = {
+            "original_hash",
+            "series",
+            "issue",
+            "issue_count",
+            "title",
+            "volume",
+            "genres",
+            "description",
+            "notes",
+            "alternate_series",
+            "alternate_number",
+            "alternate_count",
+            "story_arcs",
+            "series_groups",
+            "publisher",
+            "imprint",
+            "day",
+            "month",
+            "year",
+            "language",
+            "web_links",
+            "format",
+            "manga",
+            "black_and_white",
+            "maturity_rating",
+            "critical_rating",
+            "scan_info",
+            "pages",
+            "pages.bookmark",
+            "pages.double_page",
+            "pages.height",
+            "pages.image_index",
+            "pages.size",
+            "pages.type",
+            "pages.width",
+            "page_count",
+            "characters",
+            "teams",
+            "locations",
+            "credits",
+            "credits.person",
+            "credits.role",
+        }
+
+    def supports_credit_role(self, role: str) -> bool:
+        return role.casefold() in self._get_parseable_credits()
+
+    def supports_tags(self, archive: Archiver) -> bool:
+        return archive.supports_files()
+
+    def has_tags(self, archive: Archiver) -> bool:
+        try:  # read_file can cause an exception
+            return (
+                self.supports_tags(archive)
+                and self.file in archive.get_filename_list()
+                and self._validate_bytes(archive.read_file(self.file))
+            )
+        except Exception:
+            return False
+
+    def remove_tags(self, archive: Archiver) -> bool:
+        return self.has_tags(archive) and archive.remove_file(self.file)
+
+    def read_tags(self, archive: Archiver) -> GenericMetadata:
+        if self.has_tags(archive):
+            try:  # read_file can cause an exception
+                metadata = archive.read_file(self.file) or b""
+                if self._validate_bytes(metadata):
+                    return self._metadata_from_bytes(metadata)
+            except Exception:
+                ...
+        return GenericMetadata()
+
+    def read_raw_tags(self, archive: Archiver) -> str:
+        try:  # read_file can cause an exception
+            if self.has_tags(archive):
+                b = archive.read_file(self.file)
+                # ET.fromstring is used as xml can declare the encoding
+                return ET.tostring(ET.fromstring(b), encoding="unicode", xml_declaration=True)
+        except Exception:
+            ...
+        return ""
+
+    def write_tags(self, metadata: GenericMetadata, archive: Archiver) -> bool:
+        if self.supports_tags(archive):
+            xml = b""
+            try:  # read_file can cause an exception
+                if self.has_tags(archive):
+                    xml = archive.read_file(self.file)
+                return archive.write_file(self.file, self._bytes_from_metadata(metadata, xml))
+            except Exception:
+                ...
+        else:
+            logger.warning(f"Archive ({archive.name()}) does not support {self.name()} metadata")
+        return False
+
+    def name(self) -> str:
+        return "Comic Rack"
+
+    @classmethod
+    def _get_parseable_credits(cls) -> list[str]:
+        parsable_credits: list[str] = []
+        parsable_credits.extend(GenericMetadata.writer_synonyms)
+        parsable_credits.extend(GenericMetadata.penciller_synonyms)
+        parsable_credits.extend(GenericMetadata.inker_synonyms)
+        parsable_credits.extend(GenericMetadata.colorist_synonyms)
+        parsable_credits.extend(GenericMetadata.letterer_synonyms)
+        parsable_credits.extend(GenericMetadata.cover_synonyms)
+        parsable_credits.extend(GenericMetadata.editor_synonyms)
+        return parsable_credits
+
+    def _metadata_from_bytes(self, string: bytes) -> GenericMetadata:
+        root = ET.fromstring(string)
+        return self._convert_xml_to_metadata(root)
+
+    def _bytes_from_metadata(self, metadata: GenericMetadata, xml: bytes = b"") -> bytes:
+        root = self._convert_metadata_to_xml(metadata, xml)
+        return ET.tostring(root, encoding="utf-8", xml_declaration=True)
+
+    def _convert_metadata_to_xml(self, metadata: GenericMetadata, xml: bytes = b"") -> ET.Element:
+        # shorthand for the metadata
+        md = metadata
+
+        if xml:
+            root = ET.fromstring(xml)
+        else:
+            # build a tree structure
+            root = ET.Element("ComicInfo")
+            root.attrib["xmlns:xsi"] = "http://www.w3.org/2001/XMLSchema-instance"
+            root.attrib["xmlns:xsd"] = "http://www.w3.org/2001/XMLSchema"
+        # helper func
+
+        def assign(cr_entry: str, md_entry: Any) -> None:
+            if md_entry:
+                text = str(md_entry)
+                if isinstance(md_entry, (list, set)):
+                    text = ",".join(md_entry)
+                et_entry = root.find(cr_entry)
+                if et_entry is not None:
+                    et_entry.text = text
+                else:
+                    ET.SubElement(root, cr_entry).text = text
+            else:
+                et_entry = root.find(cr_entry)
+                if et_entry is not None:
+                    root.remove(et_entry)
+
+        # need to specially process the credits, since they are structured
+        # differently than CIX
+        credit_writer_list = []
+        credit_penciller_list = []
+        credit_inker_list = []
+        credit_colorist_list = []
+        credit_letterer_list = []
+        credit_cover_list = []
+        credit_editor_list = []
+
+        # first, loop thru credits, and build a list for each role that CIX
+        # supports
+        for credit in metadata.credits:
+            if credit.role.casefold() in set(GenericMetadata.writer_synonyms):
+                credit_writer_list.append(credit.person.replace(",", ""))
+
+            if credit.role.casefold() in set(GenericMetadata.penciller_synonyms):
+                credit_penciller_list.append(credit.person.replace(",", ""))
+
+            if credit.role.casefold() in set(GenericMetadata.inker_synonyms):
+                credit_inker_list.append(credit.person.replace(",", ""))
+
+            if credit.role.casefold() in set(GenericMetadata.colorist_synonyms):
+                credit_colorist_list.append(credit.person.replace(",", ""))
+
+            if credit.role.casefold() in set(GenericMetadata.letterer_synonyms):
+                credit_letterer_list.append(credit.person.replace(",", ""))
+
+            if credit.role.casefold() in set(GenericMetadata.cover_synonyms):
+                credit_cover_list.append(credit.person.replace(",", ""))
+
+            if credit.role.casefold() in set(GenericMetadata.editor_synonyms):
+                credit_editor_list.append(credit.person.replace(",", ""))
+
+        assign("Series", md.series)
+        assign("Number", md.issue)
+        assign("Count", md.issue_count)
+        assign("Title", md.title)
+        assign("Volume", md.volume)
+        assign("Genre", md.genres)
+        assign("Summary", md.description)
+        assign("Notes", md.notes)
+
+        assign("AlternateSeries", md.alternate_series)
+        assign("AlternateNumber", md.alternate_number)
+        assign("AlternateCount", md.alternate_count)
+        assign("StoryArc", md.story_arcs)
+        assign("SeriesGroup", md.series_groups)
+
+        assign("Publisher", md.publisher)
+        assign("Imprint", md.imprint)
+        assign("Day", md.day)
+        assign("Month", md.month)
+        assign("Year", md.year)
+        assign("LanguageISO", md.language)
+        assign("Web", " ".join(u.url for u in md.web_links))
+        assign("Format", md.format)
+        assign("Manga", md.manga)
+        assign("BlackAndWhite", "Yes" if md.black_and_white else None)
+        assign("AgeRating", md.maturity_rating)
+        assign("CommunityRating", md.critical_rating)
+
+        scan_info = md.scan_info or ""
+        if md.original_hash:
+            scan_info += f" sum:{md.original_hash}"
+        assign("ScanInformation", scan_info)
+
+        assign("PageCount", md.page_count)
+
+        assign("Characters", md.characters)
+        assign("Teams", md.teams)
+        assign("Locations", md.locations)
+        assign("Writer", ", ".join(credit_writer_list))
+        assign("Penciller", ", ".join(credit_penciller_list))
+        assign("Inker", ", ".join(credit_inker_list))
+        assign("Colorist", ", ".join(credit_colorist_list))
+        assign("Letterer", ", ".join(credit_letterer_list))
+        assign("CoverArtist", ", ".join(credit_cover_list))
+        assign("Editor", ", ".join(credit_editor_list))
+
+        #  loop and add the page entries under pages node
+        pages_node = root.find("Pages")
+        if pages_node is not None:
+            pages_node.clear()
+        else:
+            pages_node = ET.SubElement(root, "Pages")
+
+        for page in sorted(md.pages, key=lambda x: x.archive_index):
+            page_node = ET.SubElement(pages_node, "Page")
+            page_node.attrib = {"Image": str(page.display_index)}
+            if page.bookmark:
+                page_node.attrib["Bookmark"] = page.bookmark
+            if page.type:
+                page_node.attrib["Type"] = page.type
+
+            if page.double_page is not None:
+                page_node.attrib["DoublePage"] = str(page.double_page)
+            if page.height is not None:
+                page_node.attrib["ImageHeight"] = str(page.height)
+            if page.byte_size is not None:
+                page_node.attrib["ImageSize"] = str(page.byte_size)
+            if page.width is not None:
+                page_node.attrib["ImageWidth"] = str(page.width)
+            page_node.attrib = dict(sorted(page_node.attrib.items()))
+
+        ET.indent(root)
+
+        return root
+
+    def _convert_xml_to_metadata(self, root: ET.Element) -> GenericMetadata:
+        if root.tag != "ComicInfo":
+            raise Exception("Not a ComicInfo file")
+
+        def get(name: str) -> str | None:
+            tag = root.find(name)
+            if tag is None:
+                return None
+            return tag.text
+
+        md = GenericMetadata()
+
+        md.series = utils.xlate(get("Series"))
+        md.issue = utils.xlate(get("Number"))
+        md.issue_count = utils.xlate_int(get("Count"))
+        md.title = utils.xlate(get("Title"))
+        md.volume = utils.xlate_int(get("Volume"))
+        md.genres = set(utils.split(get("Genre"), ","))
+        md.description = utils.xlate(get("Summary"))
+        md.notes = utils.xlate(get("Notes"))
+
+        md.alternate_series = utils.xlate(get("AlternateSeries"))
+        md.alternate_number = utils.xlate(get("AlternateNumber"))
+        md.alternate_count = utils.xlate_int(get("AlternateCount"))
+        md.story_arcs = utils.split(get("StoryArc"), ",")
+        md.series_groups = utils.split(get("SeriesGroup"), ",")
+
+        md.publisher = utils.xlate(get("Publisher"))
+        md.imprint = utils.xlate(get("Imprint"))
+        md.day = utils.xlate_int(get("Day"))
+        md.month = utils.xlate_int(get("Month"))
+        md.year = utils.xlate_int(get("Year"))
+        md.language = utils.xlate(get("LanguageISO"))
+        md.web_links = utils.split_urls(utils.xlate(get("Web")))
+        md.format = utils.xlate(get("Format"))
+        md.manga = utils.xlate(get("Manga"))
+        md.maturity_rating = utils.xlate(get("AgeRating"))
+        md.critical_rating = utils.xlate_float(get("CommunityRating"))
+        scan_info_list = (utils.xlate(get("ScanInformation")) or "").split()
+        for word in scan_info_list.copy():
+            if not word.startswith("sum:"):
+                continue
+            original_hash = FileHash.parse(word[4:])
+            if original_hash:
+                md.original_hash = original_hash
+                scan_info_list.remove(word)
+                break
+        if scan_info_list:
+            md.scan_info = " ".join(scan_info_list)
+        md.is_empty = False
+
+        md.page_count = utils.xlate_int(get("PageCount"))
+
+        md.characters = set(utils.split(get("Characters"), ","))
+        md.teams = set(utils.split(get("Teams"), ","))
+        md.locations = set(utils.split(get("Locations"), ","))
+
+        tmp = utils.xlate(get("BlackAndWhite"))
+        if tmp is not None:
+            md.black_and_white = tmp.casefold() in ["yes", "true", "1"]
+
+        # Now extract the credit info
+        for n in root:
+            if any(
+                [
+                    n.tag == "Writer",
+                    n.tag == "Penciller",
+                    n.tag == "Inker",
+                    n.tag == "Colorist",
+                    n.tag == "Letterer",
+                    n.tag == "Editor",
+                ]
+            ):
+                if n.text is not None:
+                    for name in utils.split(n.text, ","):
+                        md.add_credit(name.strip(), n.tag)
+
+            if n.tag == "CoverArtist":
+                if n.text is not None:
+                    for name in utils.split(n.text, ","):
+                        md.add_credit(name.strip(), "Cover")
+
+        # parse page data now
+        pages_node = root.find("Pages")
+        if pages_node is not None:
+            for i, page in enumerate(pages_node):
+                p: dict[str, Any] = page.attrib
+                md_page = PageMetadata(
+                    filename="",  # cr doesn't record the filename it just assumes it's always ordered the same
+                    display_index=int(p.get("Image", i)),
+                    archive_index=i,
+                    bookmark=p.get("Bookmark", ""),
+                    type="",
+                )
+                md_page.set_type(p.get("Type", ""))
+
+                if isinstance(p.get("DoublePage", None), str):
+                    md_page.double_page = p["DoublePage"].casefold() in ("yes", "true", "1")
+                if p.get("ImageHeight", "").isnumeric():
+                    md_page.height = int(float(p["ImageHeight"]))
+                if p.get("ImageWidth", "").isnumeric():
+                    md_page.width = int(float(p["ImageWidth"]))
+                if p.get("ImageSize", "").isnumeric():
+                    md_page.byte_size = int(float(p["ImageSize"]))
+
+                md.pages.append(md_page)
+
+        md.is_empty = False
+
+        return md
+
+    def _validate_bytes(self, string: bytes) -> bool:
+        """verify that the string actually contains CIX data in XML format"""
+        try:
+            root = ET.fromstring(string)
+            if root.tag != "ComicInfo":
+                return False
+        except ET.ParseError:
+            return False
+
+        return True

comicapi/tags/tag.py

@@ -0,0 +1,125 @@
+from __future__ import annotations
+
+from comicapi.archivers import Archiver
+from comicapi.genericmetadata import GenericMetadata
+
+
+class Tag:
+    enabled: bool = False
+    id: str = ""
+
+    def __init__(self, version: str) -> None:
+        self.version: str = version
+        self.supported_attributes = {
+            "data_origin",
+            "issue_id",
+            "series_id",
+            "original_hash",
+            "series",
+            "series_aliases",
+            "issue",
+            "issue_count",
+            "title",
+            "title_aliases",
+            "volume",
+            "volume_count",
+            "genres",
+            "description",
+            "notes",
+            "alternate_series",
+            "alternate_number",
+            "alternate_count",
+            "story_arcs",
+            "series_groups",
+            "publisher",
+            "imprint",
+            "day",
+            "month",
+            "year",
+            "language",
+            "country",
+            "web_link",
+            "format",
+            "manga",
+            "black_and_white",
+            "maturity_rating",
+            "critical_rating",
+            "scan_info",
+            "tags",
+            "pages",
+            "pages.type",
+            "pages.bookmark",
+            "pages.double_page",
+            "pages.image_index",
+            "pages.size",
+            "pages.height",
+            "pages.width",
+            "page_count",
+            "characters",
+            "teams",
+            "locations",
+            "credits",
+            "credits.person",
+            "credits.role",
+            "credits.primary",
+            "credits.language",
+            "price",
+            "is_version_of",
+            "rights",
+            "identifier",
+            "last_mark",
+        }
+
+    def supports_credit_role(self, role: str) -> bool:
+        return False
+
+    def supports_tags(self, archive: Archiver) -> bool:
+        """
+        Checks the given archive for the ability to save these tags.
+        Should always return a bool. Failures should return False.
+        Typically consists of a call to either `archive.supports_comment` or `archive.supports_file`
+        """
+        return False
+
+    def has_tags(self, archive: Archiver) -> bool:
+        """
+        Checks the given archive for tags.
+        Should always return a bool. Failures should return False.
+        """
+        return False
+
+    def remove_tags(self, archive: Archiver) -> bool:
+        """
+        Removes the tags from the given archive.
+        Should always return a bool. Failures should return False.
+        """
+        return False
+
+    def read_tags(self, archive: Archiver) -> GenericMetadata:
+        """
+        Returns a GenericMetadata representing the tags saved in the given archive.
+        Should always return a GenericMetadata. Failures should return an empty metadata object.
+        """
+        return GenericMetadata()
+
+    def read_raw_tags(self, archive: Archiver) -> str:
+        """
+        Returns the raw tags as a string.
+        If the tags are a binary format a roughly similar text format should be used.
+        Should always return a string. Failures should return the empty string.
+        """
+        return ""
+
+    def write_tags(self, metadata: GenericMetadata, archive: Archiver) -> bool:
+        """
+        Saves the given metadata to the given archive.
+        Should always return a bool. Failures should return False.
+        """
+        return False
+
+    def name(self) -> str:
+        """
+        Returns the name of these tags for display purposes eg "Comic Rack".
+        Should always return a string. Failures should return the empty string.
+        """
+        return ""

comicapi/utils.py

@@ -0,0 +1,714 @@
+"""Some generic utilities"""
+
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import difflib
+import hashlib
+import json
+import logging
+import os
+import pathlib
+import platform
+import sys
+import unicodedata
+from collections.abc import Iterable, Mapping, Sequence
+from enum import Enum, auto
+from shutil import which  # noqa: F401
+from typing import Any, Callable, TypeVar, cast
+
+from comicfn2dict import comicfn2dict
+
+import comicapi.data
+from comicapi import filenamelexer, filenameparser
+from comicapi._url import LocationParseError as LocationParseError  # noqa: F401
+from comicapi._url import Url as Url
+from comicapi._url import parse_url as parse_url
+
+try:
+    import icu
+
+    del icu
+    icu_available = True
+except ImportError:
+    icu_available = False
+
+
+if sys.version_info < (3, 11):
+
+    def file_digest(fileobj, digest, /, *, _bufsize=2**18):  # type: ignore[no-untyped-def]
+        """Hash the contents of a file-like object. Returns a digest object.
+
+        *fileobj* must be a file-like object opened for reading in binary mode.
+        It accepts file objects from open(), io.BytesIO(), and SocketIO objects.
+        The function may bypass Python's I/O and use the file descriptor *fileno*
+        directly.
+
+        *digest* must either be a hash algorithm name as a *str*, a hash
+        constructor, or a callable that returns a hash object.
+        """
+        # On Linux we could use AF_ALG sockets and sendfile() to archive zero-copy
+        # hashing with hardware acceleration.
+        if isinstance(digest, str):
+            digestobj = hashlib.new(digest)
+        else:
+            digestobj = digest()
+
+        if hasattr(fileobj, "getbuffer"):
+            # io.BytesIO object, use zero-copy buffer
+            digestobj.update(fileobj.getbuffer())
+            return digestobj
+
+        # Only binary files implement readinto().
+        if not (hasattr(fileobj, "readinto") and hasattr(fileobj, "readable") and fileobj.readable()):
+            raise ValueError(f"'{fileobj!r}' is not a file-like object in binary reading mode.")
+
+        # binary file, socket.SocketIO object
+        # Note: socket I/O uses different syscalls than file I/O.
+        buf = bytearray(_bufsize)  # Reusable buffer to reduce allocations.
+        view = memoryview(buf)
+        while True:
+            size = fileobj.readinto(buf)
+            if size == 0:
+                break  # EOF
+            digestobj.update(view[:size])
+
+        return digestobj
+
+    class StrEnum(str, Enum):
+        """
+        Enum where members are also (and must be) strings
+        """
+
+        def __new__(cls, *values: Any) -> Any:
+            "values must already be of type `str`"
+            if len(values) > 3:
+                raise TypeError(f"too many arguments for str(): {values!r}")
+            if len(values) == 1:
+                # it must be a string
+                if not isinstance(values[0], str):
+                    raise TypeError(f"{values[0]!r} is not a string")
+            if len(values) >= 2:
+                # check that encoding argument is a string
+                if not isinstance(values[1], str):
+                    raise TypeError(f"encoding must be a string, not {values[1]!r}")
+            if len(values) == 3:
+                # check that errors argument is a string
+                if not isinstance(values[2], str):
+                    raise TypeError("errors must be a string, not %r" % (values[2]))
+            value = str(*values)
+            member = str.__new__(cls, value)
+            member._value_ = value
+            return member
+
+        @staticmethod
+        def _generate_next_value_(name: str, start: int, count: int, last_values: Any) -> str:
+            """
+            Return the lower-cased version of the member name.
+            """
+            return name.lower()
+
+        @classmethod
+        def _missing_(cls, value: Any) -> str | None:
+            if not isinstance(value, str):
+                return None
+            if not hasattr(cls, "_lower_members"):
+                cls._lower_members = {x.casefold(): x for x in cls}  # type: ignore[attr-defined]
+            return cls._lower_members.get(value.casefold(), None)  # type: ignore[attr-defined]
+
+        def __str__(self) -> str:
+            return self.value
+
+else:
+    from enum import StrEnum as _StrEnum
+    from hashlib import file_digest
+
+    class StrEnum(_StrEnum):
+        @classmethod
+        def _missing_(cls, value: Any) -> str | None:
+            if not isinstance(value, str):
+                return None
+            if not hasattr(cls, "_lower_members"):
+                cls._lower_members = {x.casefold(): x for x in cls}  # type: ignore[attr-defined]
+            return cls._lower_members.get(value.casefold(), None)  # type: ignore[attr-defined]
+
+
+logger = logging.getLogger(__name__)
+
+
+_KT = TypeVar("_KT")
+_VT = TypeVar("_VT")
+
+
+class DefaultDict(dict[_KT, _VT]):
+    def __init__(self, *args, default: Callable[[_KT], _VT | _KT] | None = None, **kwargs) -> None:  # type: ignore[no-untyped-def]
+        super().__init__(*args, **kwargs)
+        self.default = default
+
+    def __missing__(self, key: _KT) -> _VT | _KT:
+        if self.default is None:
+            return key
+        return self.default(key)
+
+
+class Parser(StrEnum):
+    ORIGINAL = auto()
+    COMPLICATED = auto()
+    COMICFN2DICT = auto()
+
+
+def _custom_key(tup: Any) -> Any:
+    import natsort
+
+    lst = []
+    for x in natsort.os_sort_keygen()(tup):
+        ret = x
+        if isinstance(x, Sequence) and len(x) > 1 and isinstance(x[1], int) and isinstance(x[0], str) and x[0] == "":
+            ret = ("a", *x[1:])
+
+        lst.append(ret)
+    return tuple(lst)
+
+
+T = TypeVar("T")
+
+
+def os_sorted(lst: Iterable[T]) -> list[T]:
+    import natsort
+
+    key = _custom_key
+    if icu_available or platform.system() == "Windows":
+        key = natsort.os_sort_keygen()
+    return sorted(sorted(lst), key=key)  # type: ignore[type-var]
+
+
+KNOWN_IMAGE_EXTENSIONS = {".jpg", ".jpeg", ".png", ".gif", ".webp", ".avif"}
+
+
+def parse_filename(
+    filename: str,
+    parser: Parser = Parser.ORIGINAL,
+    remove_c2c: bool = False,
+    remove_fcbd: bool = False,
+    remove_publisher: bool = False,
+    split_words: bool = False,
+    allow_issue_start_with_letter: bool = False,
+    protofolius_issue_number_scheme: bool = False,
+) -> filenameparser.FilenameInfo:
+    fni = filenameparser.FilenameInfo(
+        alternate="",
+        annual=False,
+        archive="",
+        c2c=False,
+        fcbd=False,
+        format="",
+        issue="",
+        issue_count="",
+        publisher="",
+        remainder="",
+        series="",
+        title="",
+        volume="",
+        volume_count="",
+        year="",
+    )
+    if not filename:
+        return fni
+    if split_words:
+        import wordninja
+
+        filename, ext = os.path.splitext(filename)
+        filename = " ".join(wordninja.split(filename)) + ext
+
+    if parser == Parser.COMPLICATED:
+        lex = filenamelexer.Lex(filename, allow_issue_start_with_letter)
+        p = filenameparser.Parse(
+            lex.items,
+            remove_c2c=remove_c2c,
+            remove_fcbd=remove_fcbd,
+            remove_publisher=remove_publisher,
+            protofolius_issue_number_scheme=protofolius_issue_number_scheme,
+        )
+        if p.error:
+            logger.info("Issue parsing filename: '%s': %s ", filename, p.error.val)
+        fni = p.filename_info
+    elif parser == Parser.COMICFN2DICT:
+        fn2d = comicfn2dict(filename)
+        fni = filenameparser.FilenameInfo(
+            alternate="",
+            annual=False,
+            archive=fn2d.get("ext", ""),
+            c2c=False,
+            fcbd=False,
+            issue=fn2d.get("issue", ""),
+            issue_count=fn2d.get("issue_count", ""),
+            publisher=fn2d.get("publisher", ""),
+            remainder=fn2d.get("scan_info", ""),
+            series=fn2d.get("series", ""),
+            title=fn2d.get("title", ""),
+            volume=fn2d.get("volume", ""),
+            volume_count=fn2d.get("volume_count", ""),
+            year=fn2d.get("year", ""),
+            format=fn2d.get("original_format", ""),
+        )
+    else:
+        fnp = filenameparser.FileNameParser()
+        fnp.parse_filename(filename)
+        fni = filenameparser.FilenameInfo(
+            alternate="",
+            annual=False,
+            archive="",
+            c2c=False,
+            fcbd=False,
+            issue=fnp.issue,
+            issue_count=fnp.issue_count,
+            publisher="",
+            remainder=fnp.remainder,
+            series=fnp.series,
+            title="",
+            volume=fnp.volume,
+            volume_count="",
+            year=fnp.year,
+            format="",
+        )
+    return fni
+
+
+def norm_fold(string: str) -> str:
+    """Normalise and casefold string"""
+    return unicodedata.normalize("NFKD", string).casefold()
+
+
+def combine_notes(existing_notes: str | None, new_notes: str | None, split: str) -> str:
+    split_notes, split_str, untouched_notes = (existing_notes or "").rpartition(split)
+    if split_notes or split_str:
+        return (split_notes + (new_notes or "")).strip()
+    else:
+        return (untouched_notes + "\n" + (new_notes or "")).strip()
+
+
+def parse_date_str(date_str: str | None) -> tuple[int | None, int | None, int | None]:
+    day = None
+    month = None
+    year = None
+    if date_str:
+        parts = date_str.split("-")
+        year = xlate_int(parts[0])
+        if len(parts) > 1:
+            month = xlate_int(parts[1])
+            if len(parts) > 2:
+                day = xlate_int(parts[2])
+    return day, month, year
+
+
+def shorten_path(path: pathlib.Path, path2: pathlib.Path | None = None) -> tuple[pathlib.Path, pathlib.Path]:
+    if path2:
+        path2 = path2.absolute()
+
+    path = path.absolute()
+    shortened_path: pathlib.Path = path
+    relative_path = pathlib.Path(path.anchor)
+
+    if path.is_relative_to(path.home()):
+        relative_path = path.home()
+        shortened_path = path.relative_to(path.home())
+    if path.is_relative_to(path.cwd()):
+        relative_path = path.cwd()
+        shortened_path = path.relative_to(path.cwd())
+
+    if path2 and shortened_path.is_relative_to(path2.parent):
+        relative_path = path2
+        shortened_path = shortened_path.relative_to(path2)
+
+    return relative_path, shortened_path
+
+
+def path_to_short_str(original_path: pathlib.Path, renamed_path: pathlib.Path | None = None) -> str:
+    rel, _original_path = shorten_path(original_path)
+    path_str = str(_original_path)
+    if rel.samefile(rel.cwd()):
+        path_str = f"./{_original_path}"
+    elif rel.samefile(rel.home()):
+        path_str = f"~/{_original_path}"
+
+    if renamed_path:
+        rel, path = shorten_path(renamed_path, original_path.parent)
+        rename_str = f" -> {path}"
+        if rel.samefile(rel.cwd()):
+            rename_str = f" -> ./{_original_path}"
+        elif rel.samefile(rel.home()):
+            rename_str = f" -> ~/{_original_path}"
+        path_str += rename_str
+
+    return path_str
+
+
+def get_page_name_list(files: list[str]) -> list[str]:
+    # get the list file names in the archive, and sort
+    files = cast(list[str], os_sorted(files))
+
+    # make a sub-list of image files
+    page_list = []
+    for name in files:
+        if os.path.splitext(name)[1].casefold() in KNOWN_IMAGE_EXTENSIONS and os.path.basename(name)[0] != ".":
+            page_list.append(name)
+    return page_list
+
+
+def get_recursive_filelist(pathlist: list[str]) -> list[str]:
+    """Get a recursive list of of all files under all path items in the list"""
+
+    filelist: list[str] = []
+    for p in pathlist:
+        if os.path.isdir(p):
+            for root, _, files in os.walk(p):
+                for f in files:
+                    filelist.append(os.path.join(root, f))
+        elif os.path.exists(p):
+            filelist.append(p)
+
+    return filelist
+
+
+def add_to_path(dirname: str) -> None:
+    if dirname:
+        dirname = os.path.abspath(dirname)
+        paths = [os.path.normpath(x) for x in split(os.environ["PATH"], os.pathsep)]
+
+        if dirname not in paths:
+            paths.insert(0, dirname)
+            os.environ["PATH"] = os.pathsep.join(paths)
+
+
+def remove_from_path(dirname: str) -> None:
+    if dirname:
+        dirname = os.path.abspath(dirname)
+        paths = [os.path.normpath(x) for x in split(os.environ["PATH"], os.pathsep) if dirname != os.path.normpath(x)]
+
+        os.environ["PATH"] = os.pathsep.join(paths)
+
+
+def xlate_int(data: Any) -> int | None:
+    data = xlate_float(data)
+    if data is None:
+        return None
+    return int(data)
+
+
+def xlate_float(data: Any) -> float | None:
+    if isinstance(data, str):
+        data = data.strip()
+    if data is None or data == "":
+        return None
+    i: str | int | float
+    if isinstance(data, (int, float)):
+        i = data
+    else:
+        i = str(data).translate(
+            DefaultDict(zip((ord(c) for c in "1234567890."), "1234567890."), default=lambda x: None)
+        )
+    if i == "":
+        return None
+    try:
+        return float(i)
+    except ValueError:
+        return None
+
+
+def xlate(data: Any) -> str | None:
+    if data is None or isinstance(data, str) and data.strip() == "":
+        return None
+
+    return str(data).strip()
+
+
+def split(s: str | None, c: str) -> list[str]:
+    s = xlate(s)
+    if s:
+        return [x.strip() for x in s.strip().split(c) if x.strip()]
+    return []
+
+
+def split_urls(s: str | None) -> list[Url]:
+    if s is None:
+        return []
+    # Find occurences of ' http'
+    if s.count("http") > 1 and s.count(" http") >= 1:
+        urls = []
+        # Split urls out
+        url_strings = split(s, " http")
+        # Return the scheme 'http' and parse the url
+        for i, url_string in enumerate(url_strings):
+            if not url_string.startswith("http"):
+                url_string = "http" + url_string
+            urls.append(parse_url(url_string))
+        return urls
+    else:
+        return [parse_url(s)]
+
+
+def remove_articles(text: str) -> str:
+    text = text.casefold()
+    articles = [
+        "&",
+        "a",
+        "am",
+        "an",
+        "and",
+        "as",
+        "at",
+        "be",
+        "but",
+        "by",
+        "for",
+        "if",
+        "is",
+        "issue",
+        "it",
+        "it's",
+        "its",
+        "itself",
+        "of",
+        "or",
+        "so",
+        "the",
+        "the",
+        "with",
+    ]
+    new_text = ""
+    for word in text.split():
+        if word not in articles:
+            new_text += word + " "
+
+    new_text = new_text[:-1]
+
+    return new_text
+
+
+def sanitize_title(text: str, basic: bool = False) -> str:
+    # normalize unicode and convert to ascii. Does not work for everything eg ½ to 1⁄2 not 1/2
+    text = unicodedata.normalize("NFKD", text).casefold()
+    # comicvine keeps apostrophes a part of the word
+    text = text.replace("'", "")
+    text = text.replace('"', "")
+    if not basic:
+        # comicvine ignores punctuation and accents
+        # remove all characters that are not a letter, separator (space) or number
+        # replace any "dash punctuation" with a space
+        # makes sure that batman-superman and self-proclaimed stay separate words
+        text = "".join(
+            c if unicodedata.category(c)[0] not in "P" else " " for c in text if unicodedata.category(c)[0] in "LZNP"
+        )
+        # remove extra space and articles and all lower case
+        text = remove_articles(text).strip()
+
+    return text
+
+
+def titles_match(search_title: str, record_title: str, threshold: int = 90) -> bool:
+    log_msg = "search title: %s ; record title: %s ; ratio: %d ; match threshold: %d"
+    thresh = threshold / 100
+
+    sanitized_search = sanitize_title(search_title)
+    sanitized_record = sanitize_title(record_title)
+    s = difflib.SequenceMatcher(None, sanitized_search, sanitized_record)
+
+    ratio = s.real_quick_ratio()
+    if ratio < thresh:
+        logger.debug(log_msg, search_title, record_title, ratio * 100, threshold)
+        return False
+
+    ratio = s.quick_ratio()
+    if ratio < thresh:
+        logger.debug(log_msg, search_title, record_title, ratio * 100, threshold)
+        return False
+
+    ratio = s.ratio()
+    if ratio < thresh:
+        logger.debug(log_msg, search_title, record_title, ratio * 100, threshold)
+        return False
+
+    logger.debug(log_msg, search_title, record_title, ratio * 100, threshold)
+    return True
+
+
+def unique_file(file_name: pathlib.Path) -> pathlib.Path:
+    name = file_name.stem
+    counter = 1
+    while True:
+        if not file_name.exists():
+            return file_name
+        file_name = file_name.with_stem(name + " (" + str(counter) + ")")
+        counter += 1
+
+
+def parse_version(s: str) -> tuple[int, int, int]:
+    str_parts = s.split(".")[:3]
+    parts = [int(x) if x.isdigit() else 0 for x in str_parts]
+    parts.extend([0] * (3 - len(parts)))  # Ensure exactly three elements in the resulting list
+
+    return (parts[0], parts[1], parts[2])
+
+
+_languages: dict[str | None, str | None] = DefaultDict(default=lambda x: None)
+
+_countries: dict[str | None, str | None] = DefaultDict(default=lambda x: None)
+
+
+def countries() -> dict[str | None, str | None]:
+    if not _countries:
+        import isocodes
+
+        for alpha_2, c in isocodes.countries.by_alpha_2:
+            _countries[alpha_2] = c["name"]
+    return _countries.copy()
+
+
+def languages() -> dict[str | None, str | None]:
+    if not _languages:
+        import isocodes
+
+        for alpha_2, lng in isocodes.extendend_languages._sorted_by_index(index="alpha_2"):
+            _languages[alpha_2] = lng["name"]
+    return _languages.copy()
+
+
+def get_language_from_iso(iso: str | None) -> str | None:
+    if not _languages:
+        return languages()[iso]
+    return _languages[iso]
+
+
+def get_language_iso(string: str | None) -> str | None:
+    if string is None:
+        return None
+    import isocodes
+
+    # Return current string if all else fails
+    lang = string.casefold()
+
+    found = None
+
+    for lng in isocodes.extendend_languages.items:
+        for x in ("alpha_2", "alpha_3", "bibliographic", "common_name", "name"):
+            if x in lng and lng[x].casefold() == lang:
+                found = lng
+                # break
+        if found:
+            break
+
+    if found:
+        return found.get("alpha_2", None)
+    return lang
+
+
+def get_country_from_iso(iso: str | None) -> str | None:
+    if not _countries:
+        return countries()[iso]
+    return _countries[iso]
+
+
+def get_publisher(publisher: str) -> tuple[str, str]:
+    imprint = ""
+
+    for pub in publishers.values():
+        imprint, publisher, ok = pub[publisher]
+        if ok:
+            break
+
+    return imprint, publisher
+
+
+def update_publishers(new_publishers: Mapping[str, Mapping[str, str]]) -> None:
+    for publisher in new_publishers:
+        if publisher in publishers:
+            publishers[publisher].update(new_publishers[publisher])
+        else:
+            publishers[publisher] = ImprintDict(publisher, new_publishers[publisher])
+
+
+class ImprintDict(dict[str, str]):
+    """
+    ImprintDict takes a publisher and a dict or mapping of lowercased
+    imprint names to the proper imprint name. Retrieving a value from an
+    ImprintDict returns a tuple of (imprint, publisher, keyExists).
+    if the key does not exist the key is returned as the publisher unchanged
+    """
+
+    def __init__(self, publisher: str, mapping: Mapping[str, str] = {}, **kwargs) -> None:  # type: ignore[no-untyped-def]
+        super().__init__(mapping, **kwargs)
+        self.publisher = publisher
+
+    def __missing__(self, key: str) -> None:
+        return None
+
+    def __getitem__(self, k: str) -> tuple[str, str, bool]:  # type: ignore[override]
+        item = super().__getitem__(k.casefold())
+        if k.casefold() == self.publisher.casefold():
+            return "", self.publisher, True
+        if item is None:
+            return "", k, False
+        else:
+            return item, self.publisher, True
+
+    def copy(self) -> ImprintDict:
+        return ImprintDict(self.publisher, super().copy())
+
+
+publishers: dict[str, ImprintDict] = {}
+
+
+def load_publishers() -> None:
+    try:
+        update_publishers(json.loads((comicapi.data.data_path / "publishers.json").read_text("utf-8")))
+    except Exception:
+        logger.exception("Failed to load publishers.json; The are no publishers or imprints loaded")
+
+
+__all__ = (
+    "load_publishers",
+    "file_digest",
+    "Parser",
+    "ImprintDict",
+    "os_sorted",
+    "parse_filename",
+    "norm_fold",
+    "combine_notes",
+    "parse_date_str",
+    "shorten_path",
+    "path_to_short_str",
+    "get_page_name_list",
+    "get_recursive_filelist",
+    "add_to_path",
+    "remove_from_path",
+    "xlate_int",
+    "xlate_float",
+    "xlate",
+    "split",
+    "split_urls",
+    "remove_articles",
+    "sanitize_title",
+    "titles_match",
+    "unique_file",
+    "parse_version",
+    "countries",
+    "languages",
+    "get_language_from_iso",
+    "get_language_iso",
+    "get_country_from_iso",
+    "get_publisher",
+    "update_publishers",
+    "load_publishers",
+)

comicarchive.py

@@ -1,978 +0,0 @@
-"""
-A python class to represent a single comic, be it file or folder of images
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-import zipfile
-import os
-import struct
-import sys
-import tempfile
-import subprocess
-import platform
-if platform.system() == "Windows":
-	import _subprocess
-import time
-
-import StringIO
-try: 
-	import Image
-	pil_available = True
-except ImportError:
-	pil_available = False
-	
-sys.path.insert(0, os.path.abspath(".") )
-import UnRAR2
-from UnRAR2.rar_exceptions import *
-
-from options import Options, MetaDataStyle
-from comicinfoxml import ComicInfoXml
-from comicbookinfo import ComicBookInfo
-from comet import CoMet
-from genericmetadata import GenericMetadata, PageType
-from filenameparser import FileNameParser
-from settings import ComicTaggerSettings
-
-class ZipArchiver:
-	
-	def __init__( self, path ):
-		self.path = path
-	
-	def getArchiveComment( self ):
-		zf = zipfile.ZipFile( self.path, 'r' )
-		comment = zf.comment
-		zf.close()
-		return comment
-
-	def setArchiveComment( self, comment ):
-		return self.writeZipComment( self.path, comment )
-
-	def readArchiveFile( self, archive_file ):
-		data = ""
-		zf = zipfile.ZipFile( self.path, 'r' )
-		try:
-			data = zf.read( archive_file )
-		except zipfile.BadZipfile as e:
-			print "bad zipfile [{0}]: {1} :: {2}".format(e, self.path, archive_file)
-			zf.close()	
-			raise IOError
-		except Exception as e:
-			zf.close()	
-			print "bad zipfile [{0}]: {1} :: {2}".format(e, self.path, archive_file)
-			raise IOError
-		finally:
-			zf.close()
-		return data
-
-	def removeArchiveFile( self, archive_file ):
-		try:
-			self.rebuildZipFile(  [ archive_file ] )
-		except:
-			return False
-		else:
-			return True
-			
-	def writeArchiveFile( self, archive_file, data ):
-		#  At the moment, no other option but to rebuild the whole 
-		#  zip archive w/o the indicated file. Very sucky, but maybe 
-		# another solution can be found
-		try:
-			self.rebuildZipFile(  [ archive_file ] )
-			
-			#now just add the archive file as a new one
-			zf = zipfile.ZipFile(self.path, mode='a', compression=zipfile.ZIP_DEFLATED ) 
-			zf.writestr( archive_file, data )
-			zf.close()
-			return True
-		except:
-			return False
-			
-	def getArchiveFilenameList( self ):		
-		zf = zipfile.ZipFile( self.path, 'r' )
-		namelist = zf.namelist()
-		zf.close()
-		return namelist
-	
-	# zip helper func
-	def rebuildZipFile( self, exclude_list ):
-		
-		# this recompresses the zip archive, without the files in the exclude_list
-		#print "Rebuilding zip {0} without {1}".format( self.path, exclude_list )
-		
-		# generate temp file
-		tmp_fd, tmp_name = tempfile.mkstemp( dir=os.path.dirname(self.path) )
-		os.close( tmp_fd )
-		
-		zin = zipfile.ZipFile (self.path, 'r')
-		zout = zipfile.ZipFile (tmp_name, 'w')
-		for item in zin.infolist():
-			buffer = zin.read(item.filename)
-			if ( item.filename not in exclude_list ):
-				zout.writestr(item, buffer)
-		
-		#preserve the old comment
-		zout.comment = zin.comment
-		
-		zout.close()
-		zin.close()
-		
-		# replace with the new file 
-		os.remove( self.path )
-		os.rename( tmp_name, self.path )
-
-
-	def writeZipComment( self, filename, comment ):
-		"""
-		This is a custom function for writing a comment to a zip file,
-		since the built-in one doesn't seem to work on Windows and Mac OS/X
-
-		Fortunately, the zip comment is at the end of the file, and it's
-		easy to manipulate.  See this website for more info:
-		see: http://en.wikipedia.org/wiki/Zip_(file_format)#Structure
-		"""
-
-		#get file size
-		statinfo = os.stat(filename)
-		file_length = statinfo.st_size
-
-		try:
-			fo = open(filename, "r+b")
-
-			#the starting position, relative to EOF
-			pos = -4
-
-			found = False
-			value = bytearray()
-		
-			# walk backwards to find the "End of Central Directory" record
-			while ( not found ) and ( -pos != file_length ):
-				# seek, relative to EOF	
-				fo.seek( pos,  2)
-
-				value = fo.read( 4 )
-
-				#look for the end of central directory signature
-				if bytearray(value) == bytearray([ 0x50, 0x4b, 0x05, 0x06 ]):
-					found = True
-				else:
-					# not found, step back another byte
-					pos = pos - 1
-				#print pos,"{1} int: {0:x}".format(bytearray(value)[0], value)
-			
-			if found:
-				
-				# now skip forward 20 bytes to the comment length word
-				pos += 20
-				fo.seek( pos,  2)
-
-				# Pack the length of the comment string
-				format = "H"                   # one 2-byte integer
-				comment_length = struct.pack(format, len(comment)) # pack integer in a binary string
-				
-				# write out the length
-				fo.write( comment_length )
-				fo.seek( pos+2,  2)
-				
-				# write out the comment itself
-				fo.write( comment )
-				fo.truncate()
-				fo.close()
-			else:
-				raise Exception('Failed to write comment to zip file!')
-		except:
-			return False
-		else:
-			return True
-
-	def copyFromArchive( self, otherArchive ):
-		# Replace the current zip with one copied from another archive
-		try:		
-			zout = zipfile.ZipFile (self.path, 'w')
-			for fname in otherArchive.getArchiveFilenameList():
-				data = otherArchive.readArchiveFile( fname )	
-				if data is not None:
-					zout.writestr( fname, data )
-			zout.close()
-			
-			#preserve the old comment
-			comment = otherArchive.getArchiveComment()
-			if comment is not None:
-				if not self.writeZipComment( self.path, comment ):
-					return False
-		except  Exception as e:
-			print "Error while copying to {0}: {1}".format(self.path, e)
-			return False
-		else:
-			return True
-
-		
-#------------------------------------------
-# RAR implementation
-	
-class RarArchiver:
-	
-	devnull = None
-	def __init__( self, path ):
-		self.path = path
-		self.rar_exe_path = None
-
-		if RarArchiver.devnull is None:
-			RarArchiver.devnull = open(os.devnull, "w")
-
-		# windows only, keeps the cmd.exe from popping up
-		if platform.system() == "Windows":
-			self.startupinfo = subprocess.STARTUPINFO()
-			self.startupinfo.dwFlags |= _subprocess.STARTF_USESHOWWINDOW
-		else:
-			self.startupinfo = None
-
-	def __del__(self):
-		#RarArchiver.devnull.close()
-		pass
-
-	def getArchiveComment( self ):
-		
-		rarc = self.getRARObj()
-		return rarc.comment		
-
-	def setArchiveComment( self, comment ):
-
-		if self.rar_exe_path is not None:
-			try:
-				# write comment to temp file
-				tmp_fd, tmp_name = tempfile.mkstemp()
-				f = os.fdopen(tmp_fd, 'w+b')
-				f.write( comment )		
-				f.close()
-
-				working_dir = os.path.dirname( os.path.abspath( self.path ) )
-
-				# use external program to write comment to Rar archive
-				subprocess.call([self.rar_exe_path, 'c', '-w' + working_dir , '-c-', '-z' + tmp_name, self.path], 
-					startupinfo=self.startupinfo, 
-					stdout=RarArchiver.devnull)
-				
-				if platform.system() == "Darwin":
-					time.sleep(1)
-					
-				os.remove( tmp_name)
-			except:
-				return False
-			else:
-				return True
-		else:
-			return False
-			
-	def readArchiveFile( self, archive_file ):
-
-		# Make sure to escape brackets, since some funky stuff is going on
-		# underneath with "fnmatch"
-		archive_file = archive_file.replace("[", '[[]')
-		entries = []
-
-		rarc = self.getRARObj()
-
-		tries = 0
-		while tries < 7:
-			try:
-				tries = tries+1
-				entries = rarc.read_files( archive_file )
-
-				if entries[0][0].size != len(entries[0][1]):
-					print "readArchiveFile(): [file is not expected size: {0} vs {1}]  {2}:{3} [attempt # {4}]".format(
-								entries[0][0].size,len(entries[0][1]), self.path, archive_file, tries)
-					continue
-				
-			except (OSError, IOError) as e:
-				print "readArchiveFile(): [{0}]  {1}:{2} attempt#{3}".format(str(e), self.path, archive_file, tries)
-				time.sleep(1)
-			except Exception as e:
-				print "Unexpected exception in readArchiveFile(): [{0}] for {1}:{2} attempt#{3}".format(str(e), self.path, archive_file, tries)
-				break
-
-			else:
-				#Success"
-				#entries is a list of of tuples:  ( rarinfo, filedata)
-				if tries > 1:
-					print "Attempted read_files() {0} times".format(tries)
-				if (len(entries) == 1):
-					return entries[0][1]
-				else:
-					raise IOError
-			
-		raise IOError
-		
-
-		
-	def writeArchiveFile( self, archive_file, data ):
-
-		if self.rar_exe_path is not None:
-			try:
-				tmp_folder = tempfile.mkdtemp()
-
-				tmp_file = os.path.join( tmp_folder, archive_file )
-				
-				working_dir = os.path.dirname( os.path.abspath( self.path ) )
-
-				# TODO: will this break if 'archive_file' is in a subfolder. i.e. "foo/bar.txt"
-				# will need to create the subfolder above, I guess...
-				f = open(tmp_file, 'w')
-				f.write( data )		
-				f.close()
-				
-				# use external program to write file to Rar archive
-				subprocess.call([self.rar_exe_path, 'a', '-w' + working_dir ,'-c-', '-ep', self.path, tmp_file], 
-					startupinfo=self.startupinfo,
-					stdout=RarArchiver.devnull)
-
-				if platform.system() == "Darwin":
-					time.sleep(1)
-				os.remove( tmp_file)
-				os.rmdir( tmp_folder)
-			except:
-				return False
-			else:
-				return True
-		else:
-			return False
-			
-	def removeArchiveFile( self, archive_file ):
-		if self.rar_exe_path is not None:
-			try:
-				# use external program to remove file from Rar archive
-				subprocess.call([self.rar_exe_path, 'd','-c-', self.path, archive_file], 
-					startupinfo=self.startupinfo, 				   
-					stdout=RarArchiver.devnull)
-
-				if platform.system() == "Darwin":
-					time.sleep(1)
-			except:
-				return False
-			else:
-				return True
-		else:
-			return False
-			
-	def getArchiveFilenameList( self ):
-
-		rarc = self.getRARObj()
-		#namelist = [ item.filename for item in rarc.infolist() ]
-		#return namelist
-
-		tries = 0
-		while tries < 7:
-			try:
-				tries = tries+1
-				#namelist = [ item.filename for item in rarc.infolist() ]
-				namelist = []
-				for item in rarc.infolist():
-					if item.size != 0:
-						namelist.append( item.filename )
-			
-			except (OSError, IOError) as e:
-				print "getArchiveFilenameList(): [{0}] {1} attempt#{2}".format(str(e), self.path, tries)
-				time.sleep(1)
-
-			else:
-				#Success"
-				return namelist
-			
-		raise e
-			
-		
-	def getRARObj( self ):
-		tries = 0
-		while tries < 7:
-			try:
-				tries = tries+1
-				rarc = UnRAR2.RarFile( self.path )
-			
-			except (OSError, IOError) as e:
-				print "getRARObj(): [{0}] {1} attempt#{2}".format(str(e), self.path, tries)
-				time.sleep(1)
-
-			else:
-				#Success"
-				return rarc
-			
-		raise e
-		
-#------------------------------------------
-# Folder implementation
-class FolderArchiver:
-	
-	def __init__( self, path ):
-		self.path = path
-		self.comment_file_name = "ComicTaggerFolderComment.txt" 
-
-	def getArchiveComment( self ):
-		return self.readArchiveFile( self.comment_file_name )
-	
-	def setArchiveComment( self, comment ):
-		return self.writeArchiveFile( self.comment_file_name, comment )
-		
-	def readArchiveFile( self, archive_file ):
-		
-		data = ""
-		fname = os.path.join( self.path, archive_file )
-		try:
-			with open( fname, 'rb' ) as f: 
-				data = f.read()
-				f.close()			
-		except IOError as e:
-			pass
-		
-		return data
-
-	def writeArchiveFile( self, archive_file, data ):
-
-		fname = os.path.join( self.path, archive_file )
-		try:
-			with open(fname, 'w+') as f: 
-				f.write( data )
-				f.close()
-		except:
-			return False
-		else:
-			return True
-		
-	def removeArchiveFile( self, archive_file ):
-
-		fname = os.path.join( self.path, archive_file )
-		try:
-			os.remove( fname )
-		except:
-			return False
-		else:
-			return True
-		
-	def getArchiveFilenameList( self ):
-		return self.listFiles( self.path )
-		
-	def listFiles( self, folder ):
-		
-		itemlist = list()
-
-		for item in os.listdir( folder ):
-			itemlist.append( item )
-			if os.path.isdir( item ):
-				itemlist.extend( self.listFiles( os.path.join( folder, item ) ))
-
-		return itemlist
-
-#------------------------------------------
-# Unknown implementation
-class UnknownArchiver:
-	
-	def __init__( self, path ):
-		self.path = path
-
-	def getArchiveComment( self ):
-		return ""
-	def setArchiveComment( self, comment ):
-		return False
-	def readArchiveFile( self ):
-		return ""
-	def writeArchiveFile( self, archive_file, data ):
-		return False
-	def removeArchiveFile( self, archive_file ):
-		return False
-	def getArchiveFilenameList( self ):
-		return []
-
-#------------------------------------------------------------------
-class ComicArchive:
-
-	logo_data = None
-
-	class ArchiveType:
-		Zip, Rar, Folder, Unknown = range(4)
-    
-	def __init__( self, path ):
-		self.path = path
-		self.ci_xml_filename = 'ComicInfo.xml'
-		self.comet_default_filename = 'CoMet.xml'
-		self.resetCache()
-		
-		if self.zipTest():
-			self.archive_type =  self.ArchiveType.Zip
-			self.archiver = ZipArchiver( self.path )
-			
-		elif self.rarTest(): 
-			self.archive_type =  self.ArchiveType.Rar
-			self.archiver = RarArchiver( self.path )
-			
-		elif os.path.isdir( self.path ):
-			self.archive_type =  self.ArchiveType.Folder
-			self.archiver = FolderArchiver( self.path )			
-		else:
-			self.archive_type =  self.ArchiveType.Unknown
-			self.archiver = UnknownArchiver( self.path )
-
-		if ComicArchive.logo_data is None:
-			fname = os.path.join(ComicTaggerSettings.baseDir(), 'graphics','nocover.png' )
-			with open(fname, 'rb') as fd:
-				ComicArchive.logo_data = fd.read()				
-
-	# Clears the cached data
-	def resetCache( self ):
-		self.has_cix = None
-		self.has_cbi = None
-		self.has_comet = None
-		self.comet_filename = None
-		self.page_count  = None
-		self.page_list  = None
-		self.cix_md  = None
-		self.cbi_md  = None
-		self.comet_md  = None
-
-	def loadCache( self, style_list ):
-		for style in style_list:
-			self.readMetadata(style)
-			
-	def rename( self, path ):
-		self.path = path
-		self.archiver.path = path
-		
-	def setExternalRarProgram( self, rar_exe_path ):
-		if self.isRar():
-			self.archiver.rar_exe_path = rar_exe_path
-
-	def zipTest( self ):
-		return zipfile.is_zipfile( self.path )
-
-	def rarTest( self ):
-		try:
-			rarc = UnRAR2.RarFile( self.path )
-		except: # InvalidRARArchive:
-			return False
-		else:
-			return True
-
-			
-	def isZip( self ):
-		return self.archive_type ==  self.ArchiveType.Zip
-		
-	def isRar( self ):
-		return self.archive_type ==  self.ArchiveType.Rar
-	
-	def isFolder( self ):
-		return self.archive_type ==  self.ArchiveType.Folder
-
-	def isWritable( self, check_rar_status=True ):	
-		if self.archive_type == self.ArchiveType.Unknown :
-			return False
-		
-		elif check_rar_status and self.isRar() and self.archiver.rar_exe_path is None:
-			return False
-			
-		elif not os.access(self.path, os.W_OK):
-			return False
-		
-		elif ((self.archive_type != self.ArchiveType.Folder) and 
-		        (not os.access( os.path.dirname( os.path.abspath(self.path)), os.W_OK ))):
-			return False
-
-		return True
-
-	def isWritableForStyle( self, data_style ):
-
-		if self.isRar() and data_style == MetaDataStyle.CBI:
-			return False
-
-		return self.isWritable()
-
-	def seemsToBeAComicArchive( self ):
-
-		# Do we even care about extensions??
-		ext = os.path.splitext(self.path)[1].lower()
-
-		if ( 
-		      ( self.isZip() or  self.isRar() or self.isFolder() )
-		      and
-		      ( self.getNumberOfPages() > 2)
-
-			):
-			return True
-		else:	
-			return False
-
-	def readMetadata( self, style ):
-		
-		if style == MetaDataStyle.CIX:
-			return self.readCIX()
-		elif style == MetaDataStyle.CBI:
-			return self.readCBI()
-		elif style == MetaDataStyle.COMET:
-			return self.readCoMet()
-		else:
-			return GenericMetadata()
-
-	def writeMetadata( self, metadata, style ):
-		
-		retcode = None
-		if style == MetaDataStyle.CIX:
-			retcode = self.writeCIX( metadata )
-		elif style == MetaDataStyle.CBI:
-			retcode = self.writeCBI( metadata )
-		elif style == MetaDataStyle.COMET:
-			retcode = self.writeCoMet( metadata )
-		return retcode
-		
-
-	def hasMetadata( self, style ):
-		
-		if style == MetaDataStyle.CIX:
-			return self.hasCIX()
-		elif style == MetaDataStyle.CBI:
-			return self.hasCBI()
-		elif style == MetaDataStyle.COMET:
-			return self.hasCoMet()
-		else:
-			return False
-	
-	def removeMetadata( self, style ):
-		retcode = True
-		if style == MetaDataStyle.CIX:
-			retcode = self.removeCIX()
-		elif style == MetaDataStyle.CBI:
-			retcode = self.removeCBI()
-		elif style == MetaDataStyle.COMET:
-			retcode = self.removeCoMet()
-		return retcode
-
-	def getPage( self, index ):
-		
-		image_data = None
-		
-		filename = self.getPageName( index )
-
-		if filename is not None:
-			try:
-				image_data = self.archiver.readArchiveFile( filename )
-			except IOError:
-				print "Error reading in page.  Substituting logo page."
-				image_data = ComicArchive.logo_data				
-
-		return image_data
-
-	def getPageName( self, index ):
-		
-		page_list = self.getPageNameList()
-		
-		num_pages = len( page_list )
-		if num_pages == 0 or index >= num_pages:
-			return None
-	
-		return  page_list[index]
-
-	def getPageNameList( self , sort_list=True):
-		
-		if self.page_list is None:
-			# get the list file names in the archive, and sort
-			files = self.archiver.getArchiveFilenameList()
-			
-			# seems like some archive creators are on  Windows, and don't know about case-sensitivity!
-			if sort_list:
-				files.sort(key=lambda x: x.lower())
-			
-			# make a sub-list of image files
-			self.page_list = []
-			for name in files:
-				if ( name[-4:].lower() in [ ".jpg", "jpeg", ".png" ] and os.path.basename(name)[0] != "." ):
-					self.page_list.append(name)
-				
-		return self.page_list
-
-	def getNumberOfPages( self ):
-		
-		if self.page_count is None:
-			self.page_count = len( self.getPageNameList( ) )
-		return self.page_count
-
-	def readCBI( self ):
-		if self.cbi_md is None:
-			raw_cbi = self.readRawCBI()
-			if raw_cbi is None:
-				self.cbi_md = GenericMetadata()
-			else:
-				self.cbi_md = ComicBookInfo().metadataFromString( raw_cbi )
-			
-			self.cbi_md.setDefaultPageList( self.getNumberOfPages() )
-				
-		return self.cbi_md
-	
-	def readRawCBI( self ):
-		if ( not self.hasCBI() ):
-			return None
-
-		return self.archiver.getArchiveComment()
-
-	def hasCBI(self):
-		if self.has_cbi is None:
-
-			#if ( not ( self.isZip() or self.isRar()) or not self.seemsToBeAComicArchive() ): 
-			if not self.seemsToBeAComicArchive(): 
-				self.has_cbi = False
-			else:
-				comment = self.archiver.getArchiveComment()
-				self.has_cbi = ComicBookInfo().validateString( comment )
-			
-		return self.has_cbi
-	
-	def writeCBI( self, metadata ):
-		if metadata is not None:
-			self.applyArchiveInfoToMetadata( metadata )
-			cbi_string = ComicBookInfo().stringFromMetadata( metadata )
-			write_success =  self.archiver.setArchiveComment( cbi_string )
-			if write_success:
-				self.has_cbi = True
-				self.cbi_md = metadata
-			self.resetCache()
-			return write_success
-		else:
-			return False
-		
-	def removeCBI( self ):
-		if self.hasCBI():
-			write_success = self.archiver.setArchiveComment( "" )
-			if write_success:
-				self.has_cbi = False
-				self.cbi_md = None
-			self.resetCache()
-			return write_success
-		return True	
-		
-	def readCIX( self ):
-		if self.cix_md is None:
-			raw_cix = self.readRawCIX()
-			if raw_cix is None or raw_cix == "":
-				self.cix_md = GenericMetadata()
-			else:
-				self.cix_md = ComicInfoXml().metadataFromString( raw_cix )
-
-			#validate the existing page list (make sure count is correct)
-			if len ( self.cix_md.pages ) !=  0 :
-				if len ( self.cix_md.pages ) != self.getNumberOfPages():
-					# pages array doesn't match the actual number of images we're seeing
-					# in the archive, so discard the data
-					self.cix_md.pages = []
-				
-			if len( self.cix_md.pages ) == 0:
-				self.cix_md.setDefaultPageList( self.getNumberOfPages() )
-			
-		return self.cix_md
-
-	def readRawCIX( self ):
-		if not self.hasCIX():
-			return None
-		try:
-			raw_cix = self.archiver.readArchiveFile( self.ci_xml_filename )
-		except IOError:
-			print "Error reading in raw CIX!"
-			raw_cix = ""
-		return  raw_cix
-		
-	def writeCIX(self, metadata):
-
-		if metadata is not None:
-			self.applyArchiveInfoToMetadata( metadata, calc_page_sizes=True )
-			cix_string = ComicInfoXml().stringFromMetadata( metadata )
-			write_success = self.archiver.writeArchiveFile( self.ci_xml_filename, cix_string )
-			if write_success:
-				self.has_cix = True
-				self.cix_md = metadata
-			self.resetCache()
-			return write_success
-		else:
-			return False
-			
-	def removeCIX( self ):
-		if self.hasCIX():
-			write_success = self.archiver.removeArchiveFile( self.ci_xml_filename )
-			if write_success:
-				self.has_cix = False
-				self.cix_md = None
-			self.resetCache()
-			return write_success
-		return True
-		
-		
-	def hasCIX(self):
-		if self.has_cix is None:
-
-			if not self.seemsToBeAComicArchive():
-				self.has_cix = False
-			elif self.ci_xml_filename in self.archiver.getArchiveFilenameList():
-				self.has_cix = True
-			else:
-				self.has_cix = False
-		return self.has_cix
-
-
-	def readCoMet( self ):
-		if self.comet_md is None:
-			raw_comet = self.readRawCoMet()
-			if raw_comet is None or raw_comet == "":
-				self.comet_md = GenericMetadata()
-			else:
-				self.comet_md = CoMet().metadataFromString( raw_comet )
-			
-			self.comet_md.setDefaultPageList( self.getNumberOfPages() )
-			#use the coverImage value from the comet_data to mark the cover in this struct
-			# walk through list of images in file, and find the matching one for md.coverImage
-			# need to remove the existing one in the default
-			if self.comet_md.coverImage is not None:
-				cover_idx = 0
-				for idx,f in enumerate(self.getPageNameList()):
-					if self.comet_md.coverImage == f:
-						cover_idx = idx
-						break
-				if cover_idx != 0:
-					del (self.comet_md.pages[0]['Type'] )
-					self.comet_md.pages[ cover_idx ]['Type'] = PageType.FrontCover
-
-		return self.comet_md	
-
-	def readRawCoMet( self ):
-		if not self.hasCoMet():
-			print self.path, "doesn't have CoMet data!"
-			return None
-
-		try:
-			raw_comet = self.archiver.readArchiveFile( self.comet_filename )
-		except IOError:
-			print "Error reading in raw CoMet!"
-			raw_comet = ""
-		return  raw_comet
-		
-	def writeCoMet(self, metadata):
-
-		if metadata is not None:
-			if not self.hasCoMet():
-				self.comet_filename = self.comet_default_filename
-			
-			self.applyArchiveInfoToMetadata( metadata )
-			# Set the coverImage value, if it's not the first page
-			cover_idx = int(metadata.getCoverPageIndexList()[0])
-			if cover_idx != 0:
-				metadata.coverImage = self.getPageName( cover_idx )
-		
-			comet_string = CoMet().stringFromMetadata( metadata )
-			write_success = self.archiver.writeArchiveFile( self.comet_filename, comet_string )
-			if write_success:
-				self.has_comet = True
-				self.comet_md = metadata
-			self.resetCache()
-			return write_success
-		else:
-			return False
-			
-	def removeCoMet( self ):
-		if self.hasCoMet():
-			write_success = self.archiver.removeArchiveFile( self.comet_filename )
-			if write_success:
-				self.has_comet = False
-				self.comet_md = None
-			self.resetCache()
-			return write_success
-		return True
-		
-	def hasCoMet(self):
-		if self.has_comet is None:
-			self.has_comet = False
-			if not self.seemsToBeAComicArchive():
-				return self.has_comet
-			
-			#look at all xml files in root, and search for CoMet data, get first
-			for n in self.archiver.getArchiveFilenameList():
-				if ( os.path.dirname(n) == "" and
-					os.path.splitext(n)[1].lower() == '.xml'):
-					# read in XML file, and validate it
-					try:
-						data = self.archiver.readArchiveFile( n )
-					except:
-						data = ""
-						print "Error reading in Comet XML for validation!"
-					if CoMet().validateString( data ):
-						# since we found it, save it!
-						self.comet_filename = n
-						self.has_comet = True
-						break
-						
-			return self.has_comet
-				
-
-
-	def applyArchiveInfoToMetadata( self, md, calc_page_sizes=False):
-		md.pageCount = self.getNumberOfPages()
-		
-		if calc_page_sizes:
-			for p in md.pages:
-				idx = int( p['Image'] )
-				if pil_available:
-					if 'ImageSize' not in p or 'ImageHeight' not in p or 'ImageWidth' not in p:
-						data = self.getPage( idx )
-						if data is not None:
-							try:
-								im = Image.open(StringIO.StringIO(data))
-								w,h = im.size
-								
-								p['ImageSize'] = str(len(data))
-								p['ImageHeight'] = str(h)
-								p['ImageWidth'] = str(w)
-							except IOError:
-								p['ImageSize'] = str(len(data))
-									
-				else:
-					if 'ImageSize' not in p:
-						data = self.getPage( idx )
-						p['ImageSize'] = str(len(data))
-
-
-			
-	def metadataFromFilename( self ):
-		 
-		metadata = GenericMetadata()
-		
-		fnp = FileNameParser()
-		fnp.parseFilename( self.path )
-
-		if fnp.issue != "":
-			metadata.issue = fnp.issue
-		if fnp.series != "":
-			metadata.series = fnp.series
-		if fnp.volume != "":
-			metadata.volume = fnp.volume
-		if fnp.year != "":
-			metadata.year = fnp.year
-		if fnp.issue_count != "":
-			metadata.issueCount = fnp.issue_count
-
-		metadata.isEmpty = False
-
-		return metadata
-
-	def exportAsZip( self, zipfilename ):
-		if self.archive_type == self.ArchiveType.Zip:
-			# nothing to do, we're already a zip
-			return True
-		
-		zip_archiver = ZipArchiver( zipfilename )
-		return zip_archiver.copyFromArchive( self.archiver )
-		

comicbookinfo.py

@@ -1,152 +0,0 @@
-"""
-A python class to encapsulate the ComicBookInfo data 
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-
-import json
-from datetime import datetime
-import zipfile
-
-from genericmetadata import GenericMetadata
-import utils
-import ctversion
-
-class ComicBookInfo:
-		 
-
-	def metadataFromString( self, string ):
-	
-		cbi_container = json.loads( unicode(string, 'utf-8') )
-
-		metadata = GenericMetadata()
-
-		cbi = cbi_container[ 'ComicBookInfo/1.0' ]
-
-		#helper func 
-		# If item is not in CBI, return None
-		def xlate( cbi_entry):
-			if cbi_entry in cbi:
-				return cbi[cbi_entry] 
-			else:	
-				return None 
-		
-		metadata.series =            xlate( 'series' )
-		metadata.title =             xlate( 'title' )
-		metadata.issue =             xlate( 'issue' )
-		metadata.publisher =         xlate( 'publisher' )
-		metadata.month =             xlate( 'publicationMonth' )
-		metadata.year =              xlate( 'publicationYear' )
-		metadata.issueCount =        xlate( 'numberOfIssues' )
-		metadata.comments =          xlate( 'comments' )
-		metadata.credits =           xlate( 'credits' )
-		metadata.genre =             xlate( 'genre' )
-		metadata.volume =            xlate( 'volume' )
-		metadata.volumeCount =       xlate( 'numberOfVolumes' )
-		metadata.language =          xlate( 'language' )
-		metadata.country =           xlate( 'country' )
-		metadata.criticalRating =    xlate( 'rating' )
-		metadata.tags =              xlate( 'tags' )
-		
-		# make sure credits and tags are at least empty lists and not None
-		if metadata.credits is None:
-			metadata.credits = []
-		if metadata.tags is None:
-			metadata.tags = []
-			
-		#need to massage the language string to be ISO
-		if metadata.language is not None:
-			# reverse look-up
-			pattern = metadata.language
-			metadata.language = None
-			for key in utils.getLanguageDict():
-				if utils.getLanguageDict()[ key ] == pattern.encode('utf-8'):
-					metadata.language = key
-					break
-		
-		metadata.isEmpty = False
-		
-		return metadata
-
-	def stringFromMetadata( self, metadata ):
-
-		cbi_container = self.createJSONDictionary( metadata )
-		return json.dumps( cbi_container )
-	
-	#verify that the string actually contains CBI data in JSON format
-	def validateString( self, string ):
-		
-		try:
-			cbi_container = json.loads( string )
-		except:
-			return False
-			
-		return ( 'ComicBookInfo/1.0' in cbi_container )
-
-
-	def createJSONDictionary( self, metadata ):
-		
-		# Create the dictionary that we will convert to JSON text
-		cbi = dict()
-		cbi_container = {'appID' : 'ComicTagger/' + ctversion.version, 
-		                 'lastModified' : str(datetime.now()), 
-		                 'ComicBookInfo/1.0' : cbi }
-		
-		#helper func
-		def assign( cbi_entry, md_entry):
-			if md_entry is not None:
-				cbi[cbi_entry] = md_entry
-			
-		#helper func
-		def toInt(s):
-			i = None
-			if type(s) in [ str, unicode, int ]:
-				try:
-					i = int(s)
-				except ValueError:
-					pass
-			return i
-				
-		assign( 'series', metadata.series )
-		assign( 'title', metadata.title )
-		assign( 'issue', metadata.issue )
-		assign( 'publisher', metadata.publisher )
-		assign( 'publicationMonth', toInt(metadata.month) )
-		assign( 'publicationYear', toInt(metadata.year) )
-		assign( 'numberOfIssues', toInt(metadata.issueCount) )
-		assign( 'comments', metadata.comments )
-		assign( 'genre', metadata.genre )
-		assign( 'volume', toInt(metadata.volume) )
-		assign( 'numberOfVolumes', toInt(metadata.volumeCount) )
-		assign( 'language', utils.getLanguageFromISO(metadata.language) )
-		assign( 'country', metadata.country )
-		assign( 'rating', metadata.criticalRating )
-		assign( 'credits', metadata.credits )
-		assign( 'tags', metadata.tags )
-		
-		return cbi_container
-	
-
-	def writeToExternalFile( self, filename,  metadata ):
-
-		cbi_container = self.createJSONDictionary(metadata)
-
-		f = open(filename, 'w')
-		f.write(json.dumps(cbi_container, indent=4))
-		f.close
-

comicinfoxml.py

@@ -1,289 +0,0 @@
-"""
-A python class to encapsulate ComicRack's ComicInfo.xml data 
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-from datetime import datetime
-import zipfile
-from pprint import pprint 
-import xml.etree.ElementTree as ET
-from genericmetadata import GenericMetadata
-import utils
-
-class ComicInfoXml:
-	
-	writer_synonyms = ['writer', 'plotter', 'scripter']
-	penciller_synonyms = [ 'artist', 'penciller', 'penciler', 'breakdowns' ]
-	inker_synonyms = [ 'inker', 'artist', 'finishes' ]
-	colorist_synonyms = [ 'colorist', 'colourist', 'colorer', 'colourer' ]
-	letterer_synonyms = [ 'letterer']
-	cover_synonyms = [ 'cover', 'covers', 'coverartist', 'cover artist' ]
-	editor_synonyms = [ 'editor']
-
-
-	def getParseableCredits( self ):
-		parsable_credits =  []
-		parsable_credits.extend( self.writer_synonyms )
-		parsable_credits.extend( self.penciller_synonyms )
-		parsable_credits.extend( self.inker_synonyms )
-		parsable_credits.extend( self.colorist_synonyms )
-		parsable_credits.extend( self.letterer_synonyms )
-		parsable_credits.extend( self.cover_synonyms )
-		parsable_credits.extend( self.editor_synonyms )		
-		return parsable_credits
-		
-	def metadataFromString( self, string ):
-
-		tree = ET.ElementTree(ET.fromstring( string ))
-		return self.convertXMLToMetadata( tree )
-
-	def stringFromMetadata( self, metadata ):
-
-		header = '<?xml version="1.0"?>\n'
-		
-		tree = self.convertMetadataToXML( self, metadata )
-		return header + ET.tostring(tree.getroot())
-
-	def indent( self, elem, level=0 ):
-		# for making the XML output readable
-		i = "\n" + level*"  "
-		if len(elem):
-			if not elem.text or not elem.text.strip():
-				elem.text = i + "  "
-			if not elem.tail or not elem.tail.strip():
-				elem.tail = i
-			for elem in elem:
-				self.indent( elem, level+1 )
-			if not elem.tail or not elem.tail.strip():
-				elem.tail = i
-		else:
-			if level and (not elem.tail or not elem.tail.strip()):
-				elem.tail = i
-	
-	def convertMetadataToXML( self, filename, metadata ):
-
-		#shorthand for the metadata
-		md = metadata
-
-		# build a tree structure
-		root = ET.Element("ComicInfo")
-		root.attrib['xmlns:xsi']="http://www.w3.org/2001/XMLSchema-instance"
-		root.attrib['xmlns:xsd']="http://www.w3.org/2001/XMLSchema"
-		#helper func
-		def assign( cix_entry, md_entry):
-			if md_entry is not None:
-				ET.SubElement(root, cix_entry).text = u"{0}".format(md_entry)
-
-		assign( 'Series', md.series )
-		assign( 'Number', md.issue )
-		assign( 'Title', md.title )
-		assign( 'Count', md.issueCount )
-		assign( 'Volume', md.volume )
-		assign( 'AlternateSeries', md.alternateSeries )
-		assign( 'AlternateNumber', md.alternateNumber )
-		assign( 'AlternateCount', md.alternateCount )
-		assign( 'Summary', md.comments )
-		assign( 'Notes', md.notes )
-		assign( 'Year', md.year )
-		assign( 'Month', md.month )
-		assign( 'Publisher', md.publisher )
-		assign( 'Imprint', md.imprint )
-		assign( 'Genre', md.genre )
-		assign( 'Web', md.webLink )
-		assign( 'PageCount', md.pageCount )
-		assign( 'Format', md.format )
-		assign( 'LanguageISO', md.language )
-		assign( 'Manga', md.manga )
-		assign( 'Characters', md.characters )
-		assign( 'Teams', md.teams )
-		assign( 'Locations', md.locations )
-		assign( 'ScanInformation', md.scanInfo )
-		assign( 'StoryArc', md.storyArc )
-		assign( 'SeriesGroup', md.seriesGroup )
-		assign( 'AgeRating', md.maturityRating )
-
-		if md.blackAndWhite is not None and md.blackAndWhite:
-			ET.SubElement(root, 'BlackAndWhite').text = "Yes"
-
-		# need to specially process the credits, since they are structured differently than CIX	
-		credit_writer_list    = list()
-		credit_penciller_list = list()
-		credit_inker_list     = list()
-		credit_colorist_list  = list()
-		credit_letterer_list  = list()
-		credit_cover_list     = list()
-		credit_editor_list    = list()
-		
-		# first, loop thru credits, and build a list for each role that CIX supports
-		for credit in metadata.credits:
-
-			if credit['role'].lower() in set( self.writer_synonyms ):
-				credit_writer_list.append(credit['person'].replace(",",""))
-
-			if credit['role'].lower() in set( self.penciller_synonyms ):
-				credit_penciller_list.append(credit['person'].replace(",",""))
-				
-			if credit['role'].lower() in set( self.inker_synonyms ):
-				credit_inker_list.append(credit['person'].replace(",",""))
-				
-			if credit['role'].lower() in set( self.colorist_synonyms ):
-				credit_colorist_list.append(credit['person'].replace(",",""))
-
-			if credit['role'].lower() in set( self.letterer_synonyms ):
-				credit_letterer_list.append(credit['person'].replace(",",""))
-
-			if credit['role'].lower() in set( self.cover_synonyms ):
-				credit_cover_list.append(credit['person'].replace(",",""))
-
-			if credit['role'].lower() in set( self.editor_synonyms ):
-				credit_editor_list.append(credit['person'].replace(",",""))
-				
-		# second, convert each list to string, and add to XML struct
-		if len( credit_writer_list ) > 0:
-			node = ET.SubElement(root, 'Writer')
-			node.text = utils.listToString( credit_writer_list )
-
-		if len( credit_penciller_list ) > 0:
-			node = ET.SubElement(root, 'Penciller')
-			node.text = utils.listToString( credit_penciller_list )
-
-		if len( credit_inker_list ) > 0:
-			node = ET.SubElement(root, 'Inker')
-			node.text = utils.listToString( credit_inker_list )
-
-		if len( credit_colorist_list ) > 0:
-			node = ET.SubElement(root, 'Colorist')
-			node.text = utils.listToString( credit_colorist_list )
-
-		if len( credit_letterer_list ) > 0:
-			node = ET.SubElement(root, 'Letterer')
-			node.text = utils.listToString( credit_letterer_list )
-
-		if len( credit_cover_list ) > 0:
-			node = ET.SubElement(root, 'CoverArtist')
-			node.text = utils.listToString( credit_cover_list )
-		
-		if len( credit_editor_list ) > 0:
-			node = ET.SubElement(root, 'Editor')
-			node.text = utils.listToString( credit_editor_list )
-		
-		#  loop and add the page entries under pages node
-		if len( md.pages ) > 0:
-			pages_node = ET.SubElement(root, 'Pages')
-			for page_dict in md.pages:
-				page_node = ET.SubElement(pages_node, 'Page')
-				page_node.attrib = page_dict
-
-		# self pretty-print
-		self.indent(root)
-
-		# wrap it in an ElementTree instance, and save as XML
-		tree = ET.ElementTree(root)
-		return tree
-				 
-
-	def convertXMLToMetadata( self, tree ):
-			
-		root = tree.getroot()
-
-		if root.tag != 'ComicInfo':
-			raise 1
-			return None
-
-		metadata = GenericMetadata()
-		md = metadata
-	
-		
-		# Helper function
-		def xlate( tag ):
-			node = root.find( tag )
-			if node is not None:
-				return node.text
-			else:
-				return None
-				
-		md.series =           xlate( 'Series' )
-		md.title =            xlate( 'Title' )
-		md.issue =            xlate( 'Number' )
-		md.issueCount =       xlate( 'Count' )
-		md.volume =           xlate( 'Volume' )
-		md.alternateSeries =  xlate( 'AlternateSeries' )
-		md.alternateNumber =  xlate( 'AlternateNumber' )
-		md.alternateCount =   xlate( 'AlternateCount' )
-		md.comments =         xlate( 'Summary' )
-		md.notes =            xlate( 'Notes' )
-		md.year =             xlate( 'Year' )
-		md.month =            xlate( 'Month' )
-		md.publisher =        xlate( 'Publisher' )
-		md.imprint =          xlate( 'Imprint' )
-		md.genre =            xlate( 'Genre' )
-		md.webLink =          xlate( 'Web' )
-		md.language =         xlate( 'LanguageISO' )
-		md.format =           xlate( 'Format' )
-		md.manga =            xlate( 'Manga' )
-		md.characters =       xlate( 'Characters' )
-		md.teams =            xlate( 'Teams' )
-		md.locations =        xlate( 'Locations' )
-		md.pageCount =        xlate( 'PageCount' )
-		md.scanInfo =         xlate( 'ScanInformation' )
-		md.storyArc =         xlate( 'StoryArc' )
-		md.seriesGroup =      xlate( 'SeriesGroup' )
-		md.maturityRating =   xlate( 'AgeRating' )
-
-		tmp = xlate( 'BlackAndWhite' )
-		md.blackAndWhite = False
-		if tmp is not None and tmp.lower() in [ "yes", "true", "1" ]:
-			md.blackAndWhite = True
-		# Now extract the credit info
-		for n in root:
-			if (  n.tag == 'Writer' or 
-				n.tag == 'Penciller' or
-				n.tag == 'Inker' or
-				n.tag == 'Colorist' or
-				n.tag == 'Letterer' or
-				n.tag == 'Editor' 
-			):
-				for name in n.text.split(','):
-					metadata.addCredit( name.strip(), n.tag )
-
-			if n.tag == 'CoverArtist':
-				for name in n.text.split(','):
-					metadata.addCredit( name.strip(), "Cover" )
-
-		# parse page data now	
-		pages_node = root.find( "Pages" )
-		if pages_node is not None:			
-			for page in pages_node:
-				metadata.pages.append( page.attrib )
-				#print page.attrib
-
-		metadata.isEmpty = False
-		
-		return metadata
-
-	def writeToExternalFile( self, filename, metadata ):
-		
-		tree = self.convertMetadataToXML( self, metadata )
-		#ET.dump(tree)		
-		tree.write(filename, encoding='utf-8')
-	
-	def readFromExternalFile( self, filename ):
-
-		tree = ET.parse( filename )
-		return self.convertXMLToMetadata( tree )
-

comictagger.py

@@ -1,507 +0,0 @@
-#!/usr/bin/python
-
-"""
-A python script to tag comic archives
-"""
-
-"""
-Copyright 2012  Anthony Beville
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-	http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-"""
-
-import sys
-import signal
-import os
-import traceback
-import time
-from pprint import pprint
-import json
-import platform
-import locale
-
-filename_encoding = sys.getfilesystemencoding()
-	
-try:
-	qt_available = True
-	from PyQt4 import QtCore, QtGui
-	from taggerwindow import TaggerWindow
-except ImportError as e:
-	qt_available = False
-
-
-from settings import ComicTaggerSettings
-from options import Options, MetaDataStyle
-from comicarchive import ComicArchive
-from issueidentifier import IssueIdentifier
-from genericmetadata import GenericMetadata
-from comicvinetalker import ComicVineTalker, ComicVineTalkerException
-from filerenamer import FileRenamer
-from cbltransformer import CBLTransformer
-
-import utils
-import codecs
-
-class MultipleMatch():
-	def __init__( self, filename, match_list):
-		self.filename = filename  
-		self.matches = match_list  
-
-class OnlineMatchResults():
-	def __init__(self):
-		self.goodMatches = []  
-		self.noMatches = []    
-		self.multipleMatches = []  
-		self.writeFailures = []  
-
-#-----------------------------
-
-def actual_issue_data_fetch( match, settings ):
-
-	# now get the particular issue data
-	try:
-		cv_md = ComicVineTalker().fetchIssueData( match['volume_id'],  match['issue_number'], settings )
-	except ComicVineTalkerException:
-		print "Network error while getting issue details.  Save aborted"
-		return None
-
-	if settings.apply_cbl_transform_on_cv_import:
-		cv_md = CBLTransformer( cv_md, settings ).apply()
-		
-	return cv_md
-
-def actual_metadata_save( ca, opts, md ):
-
-	if not opts.dryrun:
-		# write out the new data
-		if not ca.writeMetadata( md, opts.data_style ):
-			print "The tag save seemed to fail!"
-			return False
-		else:
-			print "Save complete."				
-	else:
-		if opts.terse:
-			print "dry-run option was set, so nothing was written"
-		else:
-			print "dry-run option was set, so nothing was written, but here is the final set of tags:"
-			print u"{0}".format(md)
-	return True
-		
-
-def post_process_matches( match_results, opts, settings ):
-	# now go through the match results
-	if opts.show_save_summary:
-		if len( match_results.goodMatches ) > 0:
-			print "\nSuccessful matches:"
-			print "------------------"
-			for f in match_results.goodMatches:
-				print f
-				
-		if len( match_results.noMatches ) > 0:
-			print "\nNo matches:"
-			print "------------------"
-			for f in match_results.noMatches:
-				print f
-	
-		if len( match_results.writeFailures ) > 0:
-			print "\nFile Write Failures:"
-			print "------------------"
-			for f in match_results.writeFailures:
-				print f
-
-	if not opts.show_save_summary and not opts.interactive:
-		#jusr quit if we're not interactive or showing the summary
-		return
-	
-	if len( match_results.multipleMatches ) > 0:
-		print "\nMultiple matches:"
-		print "------------------"
-		for mm in match_results.multipleMatches:
-			print mm.filename
-			for (counter,m) in enumerate(mm.matches):
-				print u"  {0}. {1} #{2} [{3}] ({4}/{5}) - {6}".format(counter,
-											   m['series'],
-											   m['issue_number'],
-											   m['publisher'],
-											   m['month'],
-											   m['year'],
-											   m['issue_title'])
-			if opts.interactive:
-				while True:
-					i = raw_input("Choose a match #, or 's' to skip: ")
-					if (i.isdigit() and int(i) in range(len(mm.matches))) or i == 's':
-						break
-				if i != 's':
-					# save the data!
-					# we know at this point, that the file is all good to go
-					ca = ComicArchive( mm.filename )
-					md = create_local_metadata( opts, ca, ca.hasMetadata(opts.data_style) )
-					cv_md = actual_issue_data_fetch(mm.matches[int(i)], settings)
-					md.overlay( cv_md )
-					actual_metadata_save( ca, opts, md )
-					
-					
-			print
-
-
-def cli_mode( opts, settings ):
-	if len( opts.file_list ) < 1:
-		print "You must specify at least one filename.  Use the -h option for more info"
-		return
-	
-	match_results = OnlineMatchResults()
-	
-	for f in opts.file_list:
-		f = f.decode(filename_encoding, 'replace')
-		process_file_cli( f, opts, settings, match_results )
-		sys.stdout.flush()
-		
-	post_process_matches( match_results, opts, settings )	
-
-
-def create_local_metadata( opts, ca, has_desired_tags ):
-	
-	md = GenericMetadata()
-	md.setDefaultPageList( ca.getNumberOfPages() )
-	
-	if has_desired_tags:
-		md = ca.readMetadata( opts.data_style )
-		
-	# now, overlay the parsed filename info	
-	if opts.parse_filename:
-		md.overlay( ca.metadataFromFilename() )
-	
-	# finally, use explicit stuff	
-	if opts.metadata is not None:
-		md.overlay( opts.metadata )
-
-	return md
-
-def process_file_cli( filename, opts, settings, match_results ):
-
-	batch_mode = len( opts.file_list ) > 1
-		
-	ca = ComicArchive(filename)
-	if settings.rar_exe_path != "":
-		ca.setExternalRarProgram( settings.rar_exe_path )	
-	
-	if not ca.seemsToBeAComicArchive():
-		print "Sorry, but "+ filename + "  is not a comic archive!"
-		return
-	
-	#if not ca.isWritableForStyle( opts.data_style ) and ( opts.delete_tags or opts.save_tags or opts.rename_file ):
-	if not ca.isWritable(  ) and ( opts.delete_tags or opts.copy_tags or opts.save_tags or opts.rename_file ):
-		print "This archive is not writable for that tag type"
-		return
-
-	has = [ False, False, False ]
-	if ca.hasCIX(): has[ MetaDataStyle.CIX ] = True
-	if ca.hasCBI(): has[ MetaDataStyle.CBI ] = True
-	if ca.hasCoMet(): has[ MetaDataStyle.COMET ] = True
-
-	if opts.print_tags:
-
-
-		if opts.data_style is None:
-			page_count = ca.getNumberOfPages()
-
-			brief = ""
-
-			if batch_mode:
-				brief = "{0}: ".format(filename)
-
-			if ca.isZip():      brief += "ZIP archive    "
-			elif ca.isRar():    brief += "RAR archive    "
-			elif ca.isFolder(): brief += "Folder archive "
-				
-			brief += "({0: >3} pages)".format(page_count)			
-			brief += "  tags:[ "
-
-			if not ( has[ MetaDataStyle.CBI ] or has[ MetaDataStyle.CIX ] or has[ MetaDataStyle.COMET ] ):
-				brief += "none "
-			else:
-				if has[ MetaDataStyle.CBI ]: brief += "CBL "
-				if has[ MetaDataStyle.CIX ]: brief += "CR "
-				if has[ MetaDataStyle.COMET ]: brief += "CoMet "
-			brief += "]"
-				
-			print brief
-
-		if opts.terse:
-			return
-
-		print
-		
-		if opts.data_style is None or opts.data_style == MetaDataStyle.CIX:
-			if has[ MetaDataStyle.CIX ]:
-				print "------ComicRack tags--------"
-				if opts.raw:
-					print u"{0}".format(unicode(ca.readRawCIX(), errors='ignore'))
-				else:
-					print u"{0}".format(ca.readCIX())
-				
-		if opts.data_style is None or opts.data_style == MetaDataStyle.CBI:
-			if has[ MetaDataStyle.CBI ]:
-				print "------ComicBookLover tags--------"
-				if opts.raw:
-					pprint(json.loads(ca.readRawCBI()))
-				else:
-					print u"{0}".format(ca.readCBI())
-					
-		if opts.data_style is None or opts.data_style == MetaDataStyle.COMET:
-			if has[ MetaDataStyle.COMET ]:
-				print "------CoMet tags--------"
-				if opts.raw:
-					print u"{0}".format(ca.readRawCoMet())
-				else:
-					print u"{0}".format(ca.readCoMet())
-			
-			
-	elif opts.delete_tags:
-		style_name = MetaDataStyle.name[ opts.data_style ]
-		if has[ opts.data_style ]:
-			if not opts.dryrun:
-				if not ca.removeMetadata( opts.data_style ):
-					print "{0}: Tag removal seemed to fail!".format( filename )
-				else:
-					print "{0}: Removed {1} tags.".format( filename, style_name )
-			else:
-				print "{0}: dry-run.  {1} tags not removed".format( filename, style_name )		
-		else:
-			print "{0}: This archive doesn't have {1} tags to remove.".format( filename, style_name )
-
-	elif opts.copy_tags:
-		dst_style_name = MetaDataStyle.name[ opts.data_style ]
-		if opts.no_overwrite and has[ opts.data_style ]:
-			print "{0}: Already has {1} tags.  Not overwriting.".format(filename, dst_style_name)
-			return
-		if opts.copy_source == opts.data_style:
-			print "{0}: Destination and source are same: {1}.  Nothing to do.".format(filename, dst_style_name)
-			return
-			
-		src_style_name = MetaDataStyle.name[ opts.copy_source ]
-		if has[ opts.copy_source ]:
-			if not opts.dryrun:
-				md = ca.readMetadata( opts.copy_source )
-				
-				if settings.apply_cbl_transform_on_bulk_operation and opts.data_style == MetaDataStyle.CBI:
-					md = CBLTransformer( md, settings ).apply()
-				
-				if not ca.writeMetadata( md, opts.data_style ):
-					print u"{0}: Tag copy seemed to fail!".format( filename )
-				else:
-					print u"{0}: Copied {1} tags to {2} .".format( filename, src_style_name, dst_style_name )
-			else:
-				print u"{0}: dry-run.  {1} tags not copied".format( filename, src_style_name )		
-		else:
-			print u"{0}: This archive doesn't have {1} tags to copy.".format( filename, src_style_name )
-
-		
-	elif opts.save_tags:
-
-		if opts.no_overwrite and has[ opts.data_style ]:
-			print u"{0}: Already has {1} tags.  Not overwriting.".format(filename, MetaDataStyle.name[ opts.data_style ])
-			return
-		
-		if batch_mode:
-			print u"Processing {0}: ".format(filename)
-			
-		md = create_local_metadata( opts, ca, has[ opts.data_style ] )
-
-		# now, search online
-		if opts.search_online:
-			if opts.issue_id is not None:
-				# we were given the actual ID to search with
-				try:
-					cv_md = ComicVineTalker().fetchIssueDataByIssueID( opts.issue_id, settings )
-				except ComicVineTalkerException:
-					print "Network error while getting issue details.  Save aborted"
-					return None
-				
-				if cv_md is None:
-					print "No match for ID {0} was found.".format(opts.issue_id)
-					return None
-				
-				if settings.apply_cbl_transform_on_cv_import:
-					cv_md = CBLTransformer( cv_md, settings ).apply()
-			else:
-				ii = IssueIdentifier( ca, settings )
-	
-				if md is None or md.isEmpty:
-					print "No metadata given to search online with!"
-					return
-	
-				def myoutput( text ):
-					if opts.verbose:
-						IssueIdentifier.defaultWriteOutput( text )
-					
-				# use our overlayed MD struct to search
-				ii.setAdditionalMetadata( md )
-				ii.onlyUseAdditionalMetaData = True
-				ii.setOutputFunction( myoutput )
-				ii.cover_page_index = md.getCoverPageIndexList()[0]
-				matches = ii.search()
-				
-				result = ii.search_result
-				
-				found_match = False
-				choices = False
-				low_confidence = False
-				
-				if result == ii.ResultNoMatches:
-					pass
-				elif result == ii.ResultFoundMatchButBadCoverScore:
-					low_confidence = True
-					found_match = True
-				elif result == ii.ResultFoundMatchButNotFirstPage :
-					found_match = True
-				elif result == ii.ResultMultipleMatchesWithBadImageScores:
-					low_confidence = True
-					choices = True
-				elif result == ii.ResultOneGoodMatch:
-					found_match = True
-				elif result == ii.ResultMultipleGoodMatches:
-					choices = True
-	
-				if choices:
-					print "Online search: Multiple matches.  Save aborted"
-					match_results.multipleMatches.append(MultipleMatch(filename,matches))
-					return
-				if low_confidence and opts.abortOnLowConfidence:
-					print "Online search: Low confidence match.  Save aborted"
-					match_results.noMatches.append(filename)
-					return
-				if not found_match:
-					print "Online search: No match found.  Save aborted"
-					match_results.noMatches.append(filename)
-					return
-	
-	
-				# we got here, so we have a single match
-				
-				# now get the particular issue data
-				cv_md = actual_issue_data_fetch(matches[0], settings)
-				if cv_md is None:
-					return
-			
-			md.overlay( cv_md )
-			
-		# ok, done building our metadata. time to save
-		if not actual_metadata_save( ca, opts, md ):
-				match_results.writeFailures.append(filename)
-		else:
-				match_results.goodMatches.append(filename)
-
-	elif opts.rename_file:
-
-		msg_hdr = ""
-		if batch_mode:
-			msg_hdr = u"{0}: ".format(filename)
-
-		if opts.data_style is not None:
-			use_tags = has[ opts.data_style ]
-		else:
-			use_tags = False
-			
-		md = create_local_metadata( opts, ca, use_tags )
-		
-		if md.series is None:
-			print msg_hdr + "Can't rename without series name"
-			return
-
-		new_ext = None  # default
-		if settings.rename_extension_based_on_archive:
-			if ca.isZip():
-				new_ext = ".cbz"
-			elif ca.isRar():
-				new_ext = ".cbr"
-			
-		renamer = FileRenamer( md )
-		renamer.setTemplate( settings.rename_template )
-		renamer.setIssueZeroPadding( settings.rename_issue_number_padding )
-		renamer.setSmartCleanup( settings.rename_use_smart_string_cleanup )
-		
-		new_name = renamer.determineName( filename, ext=new_ext )
-			
-		if new_name == os.path.basename(filename):
-			print msg_hdr + "Filename is already good!"
-			return
-		
-		folder = os.path.dirname( os.path.abspath( filename ) )
-		new_abs_path = utils.unique_file( os.path.join( folder, new_name ) )
-
-		suffix = ""
-		if not opts.dryrun:
-			# rename the file
-			os.rename( filename, new_abs_path )
-		else:
-			suffix = " (dry-run, no change)"
-
-		print u"renamed '{0}' -> '{1}' {2}".format(os.path.basename(filename), new_name, suffix)
-
-#-----------------------------
-
-def main():
-	
-	# try to make stdout encodings happy for unicode
-	if platform.system() == "Darwin":
-		preferred_encoding = "utf-8"
-	else:
-		preferred_encoding = locale.getpreferredencoding()
-	sys.stdout = codecs.getwriter(preferred_encoding)(sys.stdout)
-
-	opts = Options()
-	opts.parseCmdLineArgs()
-
-	settings = ComicTaggerSettings()
-	# make sure unrar program is in the path for the UnRAR class
-	utils.addtopath(os.path.dirname(settings.unrar_exe_path))
-	
-	signal.signal(signal.SIGINT, signal.SIG_DFL)
-	
-	if not qt_available and not opts.no_gui:
-		opts.no_gui = True
-		print "QT is not available."
-	
-	if opts.no_gui:
-		cli_mode( opts, settings )
-		
-	else:
-
-		app = QtGui.QApplication(sys.argv)
-		
-		if platform.system() != "Linux":
-			img =  QtGui.QPixmap(os.path.join(ComicTaggerSettings.baseDir(), 'graphics/tags.png' ))
-			splash = QtGui.QSplashScreen(img)
-			splash.show()
-			splash.raise_()
-			app.processEvents()
-	
-		try:			
-			tagger_window = TaggerWindow( opts.file_list, settings )
-			tagger_window.show()
-
-			if platform.system() != "Linux":
-				splash.finish( tagger_window )
-
-			sys.exit(app.exec_())
-		except Exception, e:
-			QtGui.QMessageBox.critical(QtGui.QMainWindow(), "Error", "Unhandled exception in app:\n" + traceback.format_exc() )
-			
-			
-if __name__ == "__main__":
-	main()
-    
-    
-    
-    

comictaggerlib/__init__.py

@@ -0,0 +1 @@
+from __future__ import annotations

comictaggerlib/__main__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+from comictaggerlib.main import main
+
+main()

comictaggerlib/__pyinstaller/__init__.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+import os
+
+import comicapi.__pyinstaller
+
+
+def get_hook_dirs() -> list[str]:
+    hooks = [os.path.dirname(__file__)]
+    hooks.extend(comicapi.__pyinstaller.get_hook_dirs())
+    return hooks

comictaggerlib/__pyinstaller/hook-comictaggerlib.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+from PyInstaller.utils.hooks import collect_data_files, collect_entry_point, collect_submodules
+
+datas, hiddenimports = collect_entry_point("comictagger.talker")
+hiddenimports += collect_submodules("comictaggerlib")
+datas += collect_data_files("comictaggerlib.ui")
+datas += collect_data_files("comictaggerlib.graphics")

comictaggerlib/__pyinstaller/hook-wordninja.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+import os
+
+from PyInstaller.utils.hooks import get_module_file_attribute
+
+datas = [(os.path.join(os.path.dirname(get_module_file_attribute("wordninja")), "wordninja"), "wordninja")]

comictaggerlib/applicationlogwindow.py

@@ -0,0 +1,57 @@
+from __future__ import annotations
+
+import logging
+import pathlib
+
+from PyQt6 import QtCore, QtGui, QtWidgets, uic
+
+from comictaggerlib.ui import ui_path
+
+logger = logging.getLogger(__name__)
+
+
+class QTextEditLogger(QtCore.QObject, logging.Handler):
+    qlog = QtCore.pyqtSignal(str)
+
+    def __init__(self, formatter: logging.Formatter, level: int) -> None:
+        super().__init__()
+        self.setFormatter(formatter)
+        self.setLevel(level)
+
+    def emit(self, record: logging.LogRecord) -> None:
+        msg = self.format(record)
+        self.qlog.emit(msg.strip())
+
+
+class ApplicationLogWindow(QtWidgets.QDialog):
+    def __init__(
+        self, log_folder: pathlib.Path, log_handler: QTextEditLogger, parent: QtCore.QObject | None = None
+    ) -> None:
+        super().__init__(parent)
+        with (ui_path / "applicationlogwindow.ui").open(encoding="utf-8") as uifile:
+            uic.loadUi(uifile, self)
+
+        self.log_handler = log_handler
+        self.log_handler.qlog.connect(self.textEdit.append)
+
+        f = QtGui.QFont("menlo")
+        f.setStyleHint(QtGui.QFont.StyleHint.Monospace)
+        self.setFont(f)
+        self._button = QtWidgets.QPushButton(self)
+        self._button.setText("Test Me")
+
+        self.log_folder = log_folder
+        self.lblLogLocation.setText(f'Log Location: <a href="file://{log_folder}">{log_folder}</a>')
+
+        layout = self.layout()
+        layout.addWidget(self._button)
+
+        # Connect signal to slot
+        self._button.clicked.connect(self.test)
+        self.textEdit.setTabStopDistance(self.textEdit.tabStopDistance() * 2)
+
+    def test(self) -> None:
+        logger.debug("damn, a bug")
+        logger.info("something to remember")
+        logger.warning("that's not right")
+        logger.error("foobar")

comictaggerlib/autotagmatchwindow.py

@@ -0,0 +1,278 @@
+"""A PyQT4 dialog to select from automated issue matches"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+import os
+from typing import Callable
+
+from PyQt6 import QtCore, QtGui, QtWidgets, uic
+
+from comicapi.comicarchive import ComicArchive, tags
+from comicapi.genericmetadata import GenericMetadata
+from comictaggerlib.coverimagewidget import CoverImageWidget
+from comictaggerlib.ctsettings import ct_ns
+from comictaggerlib.md import prepare_metadata
+from comictaggerlib.resulttypes import IssueResult, Result
+from comictaggerlib.ui import ui_path
+from comictalker.comictalker import ComicTalker, TalkerError
+
+logger = logging.getLogger(__name__)
+
+
+class AutoTagMatchWindow(QtWidgets.QDialog):
+    def __init__(
+        self,
+        parent: QtWidgets.QWidget,
+        match_set_list: list[Result],
+        read_tags: list[str],
+        fetch_func: Callable[[IssueResult], GenericMetadata],
+        config: ct_ns,
+        talker: ComicTalker,
+    ) -> None:
+        super().__init__(parent)
+
+        with (ui_path / "matchselectionwindow.ui").open(encoding="utf-8") as uifile:
+            uic.loadUi(uifile, self)
+
+        self.config = config
+
+        self.current_match_set: Result = match_set_list[0]
+
+        self.altCoverWidget = CoverImageWidget(
+            self.altCoverContainer, CoverImageWidget.AltCoverMode, config.Runtime_Options__config.user_cache_dir
+        )
+        gridlayout = QtWidgets.QGridLayout(self.altCoverContainer)
+        gridlayout.addWidget(self.altCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
+
+        self.archiveCoverWidget = CoverImageWidget(self.archiveCoverContainer, CoverImageWidget.ArchiveMode, None)
+        gridlayout = QtWidgets.QGridLayout(self.archiveCoverContainer)
+        gridlayout.addWidget(self.archiveCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
+
+        self.setWindowFlags(
+            QtCore.Qt.WindowType(
+                self.windowFlags()
+                | QtCore.Qt.WindowType.WindowSystemMenuHint
+                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
+            )
+        )
+
+        self.skipButton = QtWidgets.QPushButton("Skip to Next")
+        self.buttonBox.addButton(self.skipButton, QtWidgets.QDialogButtonBox.ButtonRole.ActionRole)
+        self.buttonBox.button(QtWidgets.QDialogButtonBox.StandardButton.Ok).setText("Accept and Write Tags")
+
+        self.match_set_list = match_set_list
+        self._tags = read_tags
+        self.fetch_func = fetch_func
+
+        self.current_match_set_idx = 0
+
+        self.twList.currentItemChanged.connect(self.current_item_changed)
+        self.twList.cellDoubleClicked.connect(self.cell_double_clicked)
+        self.skipButton.clicked.connect(self.skip_to_next)
+
+        self.update_data()
+
+    def update_data(self) -> None:
+        self.current_match_set = self.match_set_list[self.current_match_set_idx]
+
+        if self.current_match_set_idx + 1 == len(self.match_set_list):
+            self.buttonBox.button(QtWidgets.QDialogButtonBox.StandardButton.Cancel).setDisabled(True)
+            self.skipButton.setText("Skip")
+
+        self.set_cover_image()
+        self.populate_table()
+        self.twList.resizeColumnsToContents()
+        self.twList.selectRow(0)
+
+        path = self.current_match_set.original_path
+        self.setWindowTitle(
+            "Select correct match or skip ({} of {}): {}".format(
+                self.current_match_set_idx + 1,
+                len(self.match_set_list),
+                os.path.split(path)[1],
+            )
+        )
+
+    def populate_table(self) -> None:
+        if not self.current_match_set:
+            return
+
+        self.twList.setRowCount(0)
+
+        self.twList.setSortingEnabled(False)
+
+        for row, match in enumerate(self.current_match_set.online_results):
+            self.twList.insertRow(row)
+
+            item_text = match.series
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.ItemDataRole.UserRole, (match,))
+            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            self.twList.setItem(row, 0, item)
+
+            if match.publisher is not None:
+                item_text = str(match.publisher)
+            else:
+                item_text = "Unknown"
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            self.twList.setItem(row, 1, item)
+
+            month_str = ""
+            year_str = "????"
+            if match.month is not None:
+                month_str = f"-{int(match.month):02d}"
+            if match.year is not None:
+                year_str = str(match.year)
+
+            item_text = year_str + month_str
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            self.twList.setItem(row, 2, item)
+
+            item_text = match.issue_title
+            if item_text is None:
+                item_text = ""
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            self.twList.setItem(row, 3, item)
+
+        self.twList.resizeColumnsToContents()
+        self.twList.setSortingEnabled(True)
+        self.twList.sortItems(2, QtCore.Qt.SortOrder.AscendingOrder)
+        self.twList.selectRow(0)
+        self.twList.resizeColumnsToContents()
+        self.twList.horizontalHeader().setStretchLastSection(True)
+
+    def cell_double_clicked(self, r: int, c: int) -> None:
+        self.accept()
+
+    def current_item_changed(self, curr: QtCore.QModelIndex, prev: QtCore.QModelIndex) -> None:
+        if curr is None:
+            return None
+        if prev is not None and prev.row() == curr.row():
+            return None
+
+        match = self.current_match()
+        self.altCoverWidget.set_issue_details(match.issue_id, [match.image_url, *match.alt_image_urls])
+        if match.description is None:
+            self.teDescription.setText("")
+        else:
+            self.teDescription.setText(match.description)
+
+    def set_cover_image(self) -> None:
+        ca = ComicArchive(
+            self.current_match_set.original_path, hash_archive=self.config.Runtime_Options__preferred_hash
+        )
+        self.archiveCoverWidget.set_archive(ca)
+
+    def current_match(self) -> IssueResult:
+        row = self.twList.currentRow()
+        match: IssueResult = self.twList.item(row, 0).data(QtCore.Qt.ItemDataRole.UserRole)[0]
+        return match
+
+    def accept(self) -> None:
+        self.save_match()
+        self.current_match_set_idx += 1
+
+        if self.current_match_set_idx == len(self.match_set_list):
+            # no more items
+            QtWidgets.QDialog.accept(self)
+        else:
+            self.update_data()
+
+    def skip_to_next(self) -> None:
+        self.current_match_set_idx += 1
+
+        if self.current_match_set_idx == len(self.match_set_list):
+            # no more items
+            QtWidgets.QDialog.reject(self)
+        else:
+            self.update_data()
+
+    def reject(self) -> None:
+        reply = QtWidgets.QMessageBox.question(
+            self,
+            "Cancel Matching",
+            "Are you sure you wish to cancel the matching process?",
+            QtWidgets.QMessageBox.StandardButton.Yes,
+            QtWidgets.QMessageBox.StandardButton.No,
+        )
+
+        if reply == QtWidgets.QMessageBox.StandardButton.No:
+            return
+
+        QtWidgets.QDialog.reject(self)
+
+    def save_match(self) -> None:
+        match = self.current_match()
+        ca = ComicArchive(
+            self.current_match_set.original_path, hash_archive=self.config.Runtime_Options__preferred_hash
+        )
+        md, error = self.parent().read_selected_tags(self._tags, ca)
+        if error is not None:
+            logger.error("Failed to load tags for %s: %s", ca.path, error)
+            QtWidgets.QApplication.restoreOverrideCursor()
+            QtWidgets.QMessageBox.critical(
+                self,
+                "Read Failed!",
+                f"One or more of the read tags failed to load for {ca.path}, check log for details",
+            )
+            return
+
+        if md.is_empty:
+            md = ca.metadata_from_filename(
+                self.config.Filename_Parsing__filename_parser,
+                self.config.Filename_Parsing__remove_c2c,
+                self.config.Filename_Parsing__remove_fcbd,
+                self.config.Filename_Parsing__remove_publisher,
+            )
+
+        # now get the particular issue data
+
+        try:
+            self.current_match_set.md = ct_md = self.fetch_func(match)
+        except TalkerError as e:
+            QtWidgets.QApplication.restoreOverrideCursor()
+            QtWidgets.QMessageBox.critical(self, f"{e.source} {e.code_name} Error", f"{e}")
+            return
+
+        if ct_md is None or ct_md.is_empty:
+            QtWidgets.QMessageBox.critical(self, "Network Issue", "Could not retrieve issue details!")
+            return
+
+        QtWidgets.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.CursorShape.WaitCursor))
+        md = prepare_metadata(md, ct_md, self.config)
+        for tag_id in self._tags:
+            success = ca.write_tags(md, tag_id)
+            QtWidgets.QApplication.restoreOverrideCursor()
+            if not success:
+                QtWidgets.QMessageBox.warning(
+                    self,
+                    "Write Error",
+                    f"Saving {tags[tag_id].name()} the tags to the archive seemed to fail!",
+                )
+                break
+
+        ca.reset_cache()

comictaggerlib/autotagprogresswindow.py

@@ -0,0 +1,71 @@
+"""A PyQT4 dialog to show ID log and progress"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+
+from PyQt6 import QtCore, QtWidgets, uic
+
+from comictaggerlib.coverimagewidget import CoverImageWidget
+from comictaggerlib.ui import ui_path
+from comictalker.comictalker import ComicTalker
+
+logger = logging.getLogger(__name__)
+
+
+class AutoTagProgressWindow(QtWidgets.QDialog):
+    def __init__(self, parent: QtWidgets.QWidget, talker: ComicTalker) -> None:
+        super().__init__(parent)
+
+        with (ui_path / "autotagprogresswindow.ui").open(encoding="utf-8") as uifile:
+            uic.loadUi(uifile, self)
+
+        self.lblSourceName.setText(talker.attribution)
+
+        self.archiveCoverWidget = CoverImageWidget(self.archiveCoverContainer, CoverImageWidget.DataMode, None, False)
+        gridlayout = QtWidgets.QGridLayout(self.archiveCoverContainer)
+        gridlayout.addWidget(self.archiveCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
+
+        self.testCoverWidget = CoverImageWidget(self.testCoverContainer, CoverImageWidget.DataMode, None, False)
+        gridlayout = QtWidgets.QGridLayout(self.testCoverContainer)
+        gridlayout.addWidget(self.testCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
+
+        self.isdone = False
+
+        self.setWindowFlags(
+            QtCore.Qt.WindowType(
+                self.windowFlags()
+                | QtCore.Qt.WindowType.WindowSystemMenuHint
+                | QtCore.Qt.WindowType.WindowMaximizeButtonHint
+            )
+        )
+
+    def set_archive_image(self, img_data: bytes) -> None:
+        self.set_cover_image(img_data, self.archiveCoverWidget)
+
+    def set_test_image(self, img_data: bytes) -> None:
+        self.set_cover_image(img_data, self.testCoverWidget)
+
+    def set_cover_image(self, img_data: bytes, widget: CoverImageWidget) -> None:
+        widget.set_image_data(img_data)
+        QtCore.QCoreApplication.processEvents()
+
+    def reject(self) -> None:
+        QtWidgets.QDialog.reject(self)
+        self.isdone = True

comictaggerlib/autotagstartwindow.py

@@ -0,0 +1,104 @@
+"""A PyQT4 dialog to confirm and set config for auto-tag"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+
+from PyQt6 import QtCore, QtWidgets, uic
+
+from comictaggerlib.ctsettings import ct_ns
+from comictaggerlib.ui import ui_path
+
+logger = logging.getLogger(__name__)
+
+
+class AutoTagStartWindow(QtWidgets.QDialog):
+    def __init__(self, parent: QtWidgets.QWidget, config: ct_ns, msg: str) -> None:
+        super().__init__(parent)
+
+        with (ui_path / "autotagstartwindow.ui").open(encoding="utf-8") as uifile:
+            uic.loadUi(uifile, self)
+        self.label.setText(msg)
+
+        self.setWindowFlags(
+            QtCore.Qt.WindowType(self.windowFlags() & ~QtCore.Qt.WindowType.WindowContextHelpButtonHint)
+        )
+
+        self.config = config
+
+        self.cbxSpecifySearchString.setChecked(False)
+        self.cbxSplitWords.setChecked(False)
+        self.sbNameMatchSearchThresh.setValue(self.config.Issue_Identifier__series_match_identify_thresh)
+        self.leSearchString.setEnabled(False)
+
+        self.cbxSaveOnLowConfidence.setChecked(self.config.Auto_Tag__save_on_low_confidence)
+        self.cbxDontUseYear.setChecked(not self.config.Auto_Tag__use_year_when_identifying)
+        self.cbxAssumeIssueOne.setChecked(self.config.Auto_Tag__assume_issue_one)
+        self.cbxIgnoreLeadingDigitsInFilename.setChecked(self.config.Auto_Tag__ignore_leading_numbers_in_filename)
+        self.cbxRemoveAfterSuccess.setChecked(self.config.internal__remove_archive_after_successful_match)
+        self.cbxAutoImprint.setChecked(self.config.Auto_Tag__auto_imprint)
+
+        nlmt_tip = """<html>The <b>Name Match Ratio Threshold: Auto-Identify</b> is for eliminating automatic
+                search matches that are too long compared to your series name search. The lower
+                it is, the more likely to have a good match, but each search will take longer and
+                use more bandwidth. Too high, and only the very closest matches will be explored.</html>"""
+
+        self.sbNameMatchSearchThresh.setToolTip(nlmt_tip)
+
+        ss_tip = """<html>
+            The <b>series search string</b> specifies the search string to be used for all selected archives.
+            Use this when trying to match archives with hard-to-parse or incorrect filenames.  All archives selected
+            should be from the same series.
+            </html>"""
+        self.leSearchString.setToolTip(ss_tip)
+        self.cbxSpecifySearchString.setToolTip(ss_tip)
+
+        self.cbxSpecifySearchString.stateChanged.connect(self.search_string_toggle)
+
+        self.auto_save_on_low = False
+        self.dont_use_year = False
+        self.assume_issue_one = False
+        self.ignore_leading_digits_in_filename = False
+        self.remove_after_success = False
+        self.search_string = ""
+        self.name_length_match_tolerance = self.config.Issue_Identifier__series_match_search_thresh
+        self.split_words = self.cbxSplitWords.isChecked()
+
+    def search_string_toggle(self) -> None:
+        enable = self.cbxSpecifySearchString.isChecked()
+        self.leSearchString.setEnabled(enable)
+
+    def accept(self) -> None:
+        QtWidgets.QDialog.accept(self)
+
+        self.auto_save_on_low = self.cbxSaveOnLowConfidence.isChecked()
+        self.dont_use_year = self.cbxDontUseYear.isChecked()
+        self.assume_issue_one = self.cbxAssumeIssueOne.isChecked()
+        self.ignore_leading_digits_in_filename = self.cbxIgnoreLeadingDigitsInFilename.isChecked()
+        self.remove_after_success = self.cbxRemoveAfterSuccess.isChecked()
+        self.name_length_match_tolerance = self.sbNameMatchSearchThresh.value()
+        self.split_words = self.cbxSplitWords.isChecked()
+
+        # persist some settings
+        self.config.Auto_Tag__save_on_low_confidence = self.auto_save_on_low
+        self.config.Auto_Tag__use_year_when_identifying = not self.dont_use_year
+        self.config.Auto_Tag__assume_issue_one = self.assume_issue_one
+        self.config.Auto_Tag__ignore_leading_numbers_in_filename = self.ignore_leading_digits_in_filename
+        self.config.internal__remove_archive_after_successful_match = self.remove_after_success
+
+        if self.cbxSpecifySearchString.isChecked():
+            self.search_string = self.leSearchString.text()

comictaggerlib/cbltransformer.py

@@ -0,0 +1,90 @@
+"""A class to manage modifying metadata specifically for CBL/CBI"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+
+from comicapi.genericmetadata import Credit, GenericMetadata
+from comictaggerlib.ctsettings import ct_ns
+
+logger = logging.getLogger(__name__)
+
+
+class CBLTransformer:
+    def __init__(self, metadata: GenericMetadata, config: ct_ns) -> None:
+        self.metadata = metadata.copy()
+        self.config = config
+
+    def apply(self) -> GenericMetadata:
+        if self.config.Metadata_Options__assume_lone_credit_is_primary:
+            # helper
+            def set_lone_primary(role_list: list[str]) -> tuple[Credit | None, int]:
+                lone_credit: Credit | None = None
+                count = 0
+                for c in self.metadata.credits:
+                    if c.role.casefold() in role_list:
+                        count += 1
+                        lone_credit = c
+                    if count > 1:
+                        lone_credit = None
+                        break
+                if lone_credit is not None:
+                    lone_credit.primary = True
+                return lone_credit, count
+
+            # need to loop three times, once for 'writer', 'artist', and then
+            # 'penciler' if no artist
+            set_lone_primary(["writer"])
+            c, count = set_lone_primary(["artist"])
+            if c is None and count == 0:
+                c, count = set_lone_primary(["penciler", "penciller"])
+                if c is not None:
+                    c.primary = False
+                    self.metadata.add_credit(c.person, "Artist", True)
+
+        if self.config.Metadata_Options__copy_characters_to_tags:
+            self.metadata.tags.update(x for x in self.metadata.characters)
+
+        if self.config.Metadata_Options__copy_teams_to_tags:
+            self.metadata.tags.update(x for x in self.metadata.teams)
+
+        if self.config.Metadata_Options__copy_locations_to_tags:
+            self.metadata.tags.update(x for x in self.metadata.locations)
+
+        if self.config.Metadata_Options__copy_storyarcs_to_tags:
+            self.metadata.tags.update(x for x in self.metadata.story_arcs)
+
+        if self.config.Metadata_Options__copy_notes_to_comments:
+            if self.metadata.notes is not None:
+                if self.metadata.description is None:
+                    self.metadata.description = ""
+                else:
+                    self.metadata.description += "\n\n"
+                if self.metadata.notes not in self.metadata.description:
+                    self.metadata.description += self.metadata.notes
+
+        if self.config.Metadata_Options__copy_weblink_to_comments:
+            for web_link in self.metadata.web_links:
+                temp_desc = self.metadata.description
+                if temp_desc is None:
+                    temp_desc = ""
+                else:
+                    temp_desc += "\n\n"
+                if web_link.url and web_link.url not in temp_desc:
+                    self.metadata.description = temp_desc + web_link.url
+
+        return self.metadata

comictaggerlib/cli.py

@@ -0,0 +1,836 @@
+#!/usr/bin/python
+"""ComicTagger CLI functions"""
+#
+# Copyright 2013 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import dataclasses
+import functools
+import json
+import logging
+import os
+import pathlib
+import re
+import sys
+from collections.abc import Collection
+from typing import Any, TextIO
+
+from comicapi import merge, utils
+from comicapi.comicarchive import ComicArchive, tags
+from comicapi.genericmetadata import GenericMetadata
+from comictaggerlib.cbltransformer import CBLTransformer
+from comictaggerlib.ctsettings import ct_ns
+from comictaggerlib.filerenamer import FileRenamer, get_rename_dir
+from comictaggerlib.graphics import graphics_path
+from comictaggerlib.issueidentifier import IssueIdentifier
+from comictaggerlib.md import prepare_metadata
+from comictaggerlib.quick_tag import QuickTag
+from comictaggerlib.resulttypes import Action, IssueResult, MatchStatus, OnlineMatchResults, Result, Status
+from comictalker.comictalker import ComicTalker, TalkerError
+
+logger = logging.getLogger(__name__)
+
+
+class OutputEncoder(json.JSONEncoder):
+    def default(self, obj: Any) -> Any:
+        if isinstance(obj, pathlib.Path):
+            return str(obj)
+        if not isinstance(obj, str) and isinstance(obj, Collection):
+            return list(obj)
+
+        # Let the base class default method raise the TypeError
+        return json.JSONEncoder.default(self, obj)
+
+
+class CLI:
+    def __init__(self, config: ct_ns, talkers: dict[str, ComicTalker]) -> None:
+        self.config = config
+        self.talkers = talkers
+        self.batch_mode = False
+        self.output_file = sys.stdout
+        if config.Runtime_Options__json:
+            self.output_file = sys.stderr
+
+    def current_talker(self) -> ComicTalker:
+        if self.config.Sources__source in self.talkers:
+            return self.talkers[self.config.Sources__source]
+        logger.error("Could not find the '%s' talker", self.config.Sources__source)
+        raise SystemExit(2)
+
+    def output(
+        self,
+        *args: Any,
+        file: TextIO | None = None,
+        force_output: bool = False,
+        already_logged: bool = False,
+        **kwargs: Any,
+    ) -> None:
+        if file is None:
+            file = self.output_file
+        if not args:
+            log_args: tuple[Any, ...] = ("",)
+        elif isinstance(args[0], str):
+            if args[0] == "":
+                already_logged = True
+            log_args = (args[0].strip("\n"), *args[1:])
+        else:
+            log_args = args
+        if not already_logged:
+            logger.info(*log_args, **kwargs)
+        if self.config.Runtime_Options__verbose > 0:
+            return
+        if not self.config.Runtime_Options__quiet or force_output:
+            print(*args, **kwargs, file=file)
+
+    def run(self) -> int:
+        if len(self.config.Runtime_Options__files) < 1:
+            if self.config.Commands__command == Action.print:
+                res = self.print(None)
+                if res.status != Status.success:
+                    return_code = 3
+                if self.config.Runtime_Options__json:
+                    print(json.dumps(dataclasses.asdict(res), cls=OutputEncoder, indent=2))
+                return 0
+            logger.error("You must specify at least one filename.  Use the -h option for more info")
+            return 1
+        return_code = 0
+
+        results: list[Result] = []
+        match_results = OnlineMatchResults()
+        self.batch_mode = len(self.config.Runtime_Options__files) > 1
+
+        for f in self.config.Runtime_Options__files:
+            res, match_results = self.process_file_cli(self.config.Commands__command, f, match_results)
+            results.append(res)
+            self.output("")
+            if results[-1].status != Status.success:
+                return_code = 3
+            if self.config.Runtime_Options__json:
+                print(json.dumps(dataclasses.asdict(results[-1]), cls=OutputEncoder, indent=2))
+            sys.stdout.flush()
+            sys.stderr.flush()
+
+        self.post_process_matches(match_results)
+
+        if self.config.Auto_Tag__online and results and results[-1].online_results:
+            self.output(
+                f"\nFiles tagged with metadata provided by {self.current_talker().name} {self.current_talker().website}",
+            )
+        return return_code
+
+    def fetch_metadata(self, issue_id: str) -> GenericMetadata:
+        # now get the particular issue data
+        try:
+            ct_md = self.current_talker().fetch_comic_data(issue_id)
+        except TalkerError as e:
+            logger.exception(f"Error retrieving issue details. Save aborted.\n{e}")
+            return GenericMetadata()
+
+        if self.config.Metadata_Options__apply_transform_on_import:
+            ct_md = CBLTransformer(ct_md, self.config).apply()
+
+        return ct_md
+
+    def write_tags(self, ca: ComicArchive, md: GenericMetadata) -> bool:
+        if not self.config.Runtime_Options__dryrun:
+            for tag_id in self.config.Runtime_Options__tags_write:
+                # write out the new data
+                if not ca.write_tags(md, tag_id):
+                    logger.error("The tag save seemed to fail for: %s!", tags[tag_id].name())
+                    return False
+
+            self.output("Save complete.")
+        else:
+            if self.config.Runtime_Options__quiet:
+                self.output("dry-run option was set, so nothing was written")
+            else:
+                self.output("dry-run option was set, so nothing was written, but here is the final set of tags:")
+                self.output(f"{md}")
+        return True
+
+    def display_match_set_for_choice(self, label: str, match_set: Result) -> None:
+        self.output(f"{match_set.original_path} -- {label}:", force_output=True)
+
+        # sort match list by year
+        match_set.online_results.sort(key=lambda k: k.year or 0)
+
+        for counter, m in enumerate(match_set.online_results, 1):
+            self.output(
+                "    {}. {} #{} [{}] ({}/{}) - {}".format(
+                    counter,
+                    m.series,
+                    m.issue_number,
+                    m.publisher,
+                    m.month,
+                    m.year,
+                    m.issue_title,
+                ),
+                force_output=True,
+            )
+        if self.config.Runtime_Options__interactive:
+            while True:
+                i = input("Choose a match #, or 's' to skip: ")
+                if (i.isdigit() and int(i) in range(1, len(match_set.online_results) + 1)) or i == "s":
+                    break
+            if i != "s":
+                # save the data!
+                # we know at this point, that the file is all good to go
+                ca = ComicArchive(match_set.original_path, hash_archive=self.config.Runtime_Options__preferred_hash)
+                md, match_set.tags_read = self.create_local_metadata(ca, self.config.Runtime_Options__tags_read)
+                ct_md = self.fetch_metadata(match_set.online_results[int(i) - 1].issue_id)
+
+                match_set.md = prepare_metadata(md, ct_md, self.config)
+
+                self.write_tags(ca, match_set.md)
+
+    def post_process_matches(self, match_results: OnlineMatchResults) -> None:
+        def print_header(header: str) -> None:
+            self.output("", force_output=True)
+            self.output(header, force_output=True)
+            self.output("------------------", force_output=True)
+
+        # now go through the match results
+        if self.config.Runtime_Options__summary:
+            if len(match_results.good_matches) > 0:
+                print_header("Successful matches:")
+                for f in match_results.good_matches:
+                    self.output(f, force_output=True)
+
+            if len(match_results.no_matches) > 0:
+                print_header("No matches:")
+                for f in match_results.no_matches:
+                    self.output(f, force_output=True)
+
+            if len(match_results.write_failures) > 0:
+                print_header("File Write Failures:")
+                for f in match_results.write_failures:
+                    self.output(f, force_output=True)
+
+            if len(match_results.fetch_data_failures) > 0:
+                print_header("Network Data Fetch Failures:")
+                for f in match_results.fetch_data_failures:
+                    self.output(f, force_output=True)
+
+        if not self.config.Runtime_Options__summary and not self.config.Runtime_Options__interactive:
+            # just quit if we're not interactive or showing the summary
+            return
+
+        if len(match_results.multiple_matches) > 0:
+            self.output("\nArchives with multiple high-confidence matches:\n------------------", force_output=True)
+            for match_set in match_results.multiple_matches:
+                self.display_match_set_for_choice("Multiple high-confidence matches", match_set)
+
+        if len(match_results.low_confidence_matches) > 0:
+            self.output("\nArchives with low-confidence matches:\n------------------", force_output=True)
+            for match_set in match_results.low_confidence_matches:
+                if len(match_set.online_results) == 1:
+                    label = "Single low-confidence match"
+                else:
+                    label = "Multiple low-confidence matches"
+
+                self.display_match_set_for_choice(label, match_set)
+
+    def create_local_metadata(
+        self, ca: ComicArchive, tags_to_read: list[str], /, tags_only: bool = False
+    ) -> tuple[GenericMetadata, list[str]]:
+        md = GenericMetadata()
+        md.apply_default_page_list(ca.get_page_name_list())
+        filename_md = GenericMetadata()
+
+        # now, overlay the parsed filename info
+        if self.config.Auto_Tag__parse_filename and not tags_only:
+            filename_md = ca.metadata_from_filename(
+                self.config.Filename_Parsing__filename_parser,
+                self.config.Filename_Parsing__remove_c2c,
+                self.config.Filename_Parsing__remove_fcbd,
+                self.config.Filename_Parsing__remove_publisher,
+                self.config.Filename_Parsing__split_words,
+                self.config.Filename_Parsing__allow_issue_start_with_letter,
+                self.config.Filename_Parsing__protofolius_issue_number_scheme,
+            )
+
+        file_md = GenericMetadata()
+        tags_used = []
+        for tag_id in tags_to_read:
+            if ca.has_tags(tag_id):
+                try:
+                    t_md = ca.read_tags(tag_id)
+                    if not t_md.is_empty:
+                        file_md.overlay(
+                            t_md,
+                            self.config.Metadata_Options__tag_merge,
+                            self.config.Metadata_Options__tag_merge_lists,
+                        )
+                        tags_used.append(tag_id)
+                except Exception as e:
+                    logger.error("Failed to load metadata for %s: %s", ca.path, e)
+
+        filename_merge = merge.Mode.ADD_MISSING
+        if self.config.Auto_Tag__prefer_filename:
+            filename_merge = merge.Mode.OVERLAY
+
+        md.overlay(file_md, mode=merge.Mode.OVERLAY, merge_lists=False)
+        if not tags_only:
+            md.overlay(filename_md, mode=filename_merge, merge_lists=False)
+            # finally, use explicit stuff (always 'overlay' mode)
+            md.overlay(self.config.Auto_Tag__metadata, mode=merge.Mode.OVERLAY, merge_lists=True)
+
+        return (md, tags_used)
+
+    def print(self, ca: ComicArchive | None) -> Result:
+        md = None
+        if ca is None:
+            if not self.config.Auto_Tag__metadata.is_empty:
+                if not self.config.Auto_Tag__metadata.is_empty:
+                    self.output("--------- CLI tags ---------")
+                    self.output(self.config.Auto_Tag__metadata)
+            return Result(Action.print, Status.success, None, md=md)  # type: ignore
+        if not self.config.Runtime_Options__tags_read:
+            page_count = ca.get_number_of_pages()
+
+            brief = ""
+
+            if self.batch_mode:
+                brief = f"{ca.path}: "
+
+            brief += ca.archiver.name() + " archive "
+
+            brief += f"({page_count: >3} pages)"
+            brief += "  tags:[ "
+
+            tag_names = [tags[tag_id].name() for tag_id in tags if ca.has_tags(tag_id)]
+            brief += " ".join(tag_names)
+            brief += " ]"
+
+            self.output(brief)
+
+        if self.config.Runtime_Options__quiet:
+            return Result(Action.print, Status.success, ca.path)
+
+        self.output()
+
+        for tag_id, tag in tags.items():
+            if not self.config.Runtime_Options__tags_read or tag_id in self.config.Runtime_Options__tags_read:
+                if ca.has_tags(tag_id):
+                    self.output(f"--------- {tag.name()} tags ---------")
+                    try:
+                        if self.config.Runtime_Options__raw:
+                            self.output(ca.read_raw_tags(tag_id))
+                        else:
+                            md = ca.read_tags(tag_id)
+                            self.output(md)
+                    except Exception as e:
+                        logger.error("Failed to read tags from %s: %s", ca.path, e)
+        if not self.config.Auto_Tag__metadata.is_empty and not self.config.Runtime_Options__raw:
+            try:
+                md, tags_read = self.create_local_metadata(
+                    ca, self.config.Runtime_Options__tags_read or list(tags.keys())
+                )
+                tags_read_names = ", ".join(["CLI"] + [tags[t].name() for t in tags_read])
+                self.output(f"--------- Combined {tags_read_names} tags ---------")
+                self.output(md)
+            except Exception as e:
+                logger.error("Failed to read tags from %s: %s", ca.path, e)
+
+        return Result(Action.print, Status.success, ca.path, md=md)
+
+    def delete_tags(self, ca: ComicArchive, tag_id: str) -> Status:
+        tag_name = tags[tag_id].name()
+
+        if ca.has_tags(tag_id):
+            if not self.config.Runtime_Options__dryrun:
+                if ca.remove_tags(tag_id):
+                    self.output(f"{ca.path}: Removed {tag_name} tags.")
+                    return Status.success
+                else:
+                    self.output(f"{ca.path}: Tag removal seemed to fail!")
+                    return Status.write_failure
+            else:
+                self.output(f"{ca.path}: dry-run. {tag_name} tags not removed")
+                return Status.success
+        self.output(f"{ca.path}: This archive doesn't have {tag_name} tags to remove.")
+        return Status.success
+
+    def delete(self, ca: ComicArchive) -> Result:
+        res = Result(Action.delete, Status.success, ca.path)
+        for tag_id in self.config.Runtime_Options__tags_write:
+            status = self.delete_tags(ca, tag_id)
+            if status == Status.success:
+                res.tags_deleted.append(tag_id)
+            else:
+                res.status = status
+        return res
+
+    def _copy_tags(self, ca: ComicArchive, md: GenericMetadata, source_names: str, dst_tag_id: str) -> Status:
+        dst_tag_name = tags[dst_tag_id].name()
+        if self.config.Runtime_Options__skip_existing_tags and ca.has_tags(dst_tag_id):
+            self.output(f"{ca.path}: Already has {dst_tag_name} tags. Not overwriting.")
+            return Status.existing_tags
+
+        if len(self.config.Commands__copy) == 1 and dst_tag_id in self.config.Commands__copy:
+            self.output(f"{ca.path}: Destination and source are same: {dst_tag_name}. Nothing to do.")
+            return Status.existing_tags
+
+        if not self.config.Runtime_Options__dryrun:
+            if self.config.Metadata_Options__apply_transform_on_bulk_operation and dst_tag_id == "cbi":
+                md = CBLTransformer(md, self.config).apply()
+
+            if ca.write_tags(md, dst_tag_id):
+                self.output(f"{ca.path}: Copied {source_names} tags to {dst_tag_name}.")
+            else:
+                self.output(f"{ca.path}: Tag copy seemed to fail!")
+                return Status.write_failure
+        else:
+            self.output(f"{ca.path}: dry-run.  {source_names} tags not copied")
+        return Status.success
+
+    def copy(self, ca: ComicArchive) -> Result:
+        res = Result(Action.copy, Status.success, ca.path)
+        src_tag_names = []
+        for src_tag_id in self.config.Commands__copy:
+            src_tag_names.append(tags[src_tag_id].name())
+            if ca.has_tags(src_tag_id):
+                res.tags_read.append(src_tag_id)
+
+        if not res.tags_read:
+            self.output(f"{ca.path}: This archive doesn't have any {', '.join(src_tag_names)} tags to copy.")
+            res.status = Status.read_failure
+            return res
+        try:
+            res.md, res.tags_read = self.create_local_metadata(ca, res.tags_read, tags_only=True)
+        except Exception as e:
+            logger.error("Failed to read tags from %s: %s", ca.path, e)
+            return res
+
+        for dst_tag_id in self.config.Runtime_Options__tags_write:
+            if dst_tag_id in self.config.Commands__copy:
+                continue
+
+            status = self._copy_tags(ca, res.md, ", ".join(src_tag_names), dst_tag_id)
+            if status == Status.success:
+                res.tags_written.append(dst_tag_id)
+            else:
+                res.status = status
+        return res
+
+    def try_quick_tag(self, ca: ComicArchive, md: GenericMetadata) -> GenericMetadata | None:
+        if not self.config.Runtime_Options__enable_quick_tag:
+            self.output("skipping quick tag")
+            return None
+        self.output("starting quick tag")
+        try:
+            qt = QuickTag(
+                self.config.Quick_Tag__url,
+                str(utils.parse_url(self.current_talker().website).host),
+                self.current_talker(),
+                self.config,
+                self.output,
+            )
+            ct_md = qt.id_comic(
+                ca,
+                md,
+                set(self.config.Quick_Tag__hash),
+                self.config.Quick_Tag__exact_only,
+                self.config.Runtime_Options__interactive,
+                self.config.Quick_Tag__aggressive_filtering,
+                self.config.Quick_Tag__max,
+            )
+            if ct_md is None:
+                ct_md = GenericMetadata()
+            return ct_md
+        except Exception:
+            logger.exception("Quick Tagging failed")
+        return None
+
+    def normal_tag(
+        self, ca: ComicArchive, tags_read: list[str], md: GenericMetadata, match_results: OnlineMatchResults
+    ) -> tuple[GenericMetadata, list[IssueResult], Result | None, OnlineMatchResults]:
+        # ct_md, results, matches, match_results
+        if md is None or md.is_empty:
+            logger.error("No metadata given to search online with!")
+            res = Result(
+                Action.save,
+                status=Status.match_failure,
+                original_path=ca.path,
+                match_status=MatchStatus.no_match,
+                tags_written=self.config.Runtime_Options__tags_write,
+                tags_read=tags_read,
+            )
+            match_results.no_matches.append(res)
+            return GenericMetadata(), [], res, match_results
+
+        ii = IssueIdentifier(ca, self.config, self.current_talker())
+
+        ii.set_output_function(functools.partial(self.output, already_logged=True))
+        if not self.config.Auto_Tag__use_year_when_identifying:
+            md.year = None
+        if self.config.Auto_Tag__ignore_leading_numbers_in_filename and md.series is not None:
+            md.series = re.sub(r"^([\d.]+)(.*)", r"\2", md.series)
+        result, matches = ii.identify(ca, md)
+
+        found_match = False
+        choices = False
+        low_confidence = False
+
+        if result == IssueIdentifier.result_no_matches:
+            pass
+        elif result == IssueIdentifier.result_found_match_but_bad_cover_score:
+            low_confidence = True
+            found_match = True
+        elif result == IssueIdentifier.result_found_match_but_not_first_page:
+            found_match = True
+        elif result == IssueIdentifier.result_multiple_matches_with_bad_image_scores:
+            low_confidence = True
+            choices = True
+        elif result == IssueIdentifier.result_one_good_match:
+            found_match = True
+        elif result == IssueIdentifier.result_multiple_good_matches:
+            choices = True
+
+        if choices:
+            if low_confidence:
+                logger.error("Online search: Multiple low confidence matches. Save aborted")
+                res = Result(
+                    Action.save,
+                    status=Status.match_failure,
+                    original_path=ca.path,
+                    online_results=matches,
+                    match_status=MatchStatus.low_confidence_match,
+                    tags_written=self.config.Runtime_Options__tags_write,
+                    tags_read=tags_read,
+                )
+                match_results.low_confidence_matches.append(res)
+                return GenericMetadata(), matches, res, match_results
+
+            logger.error("Online search: Multiple good matches. Save aborted")
+            res = Result(
+                Action.save,
+                status=Status.match_failure,
+                original_path=ca.path,
+                online_results=matches,
+                match_status=MatchStatus.multiple_match,
+                tags_written=self.config.Runtime_Options__tags_write,
+                tags_read=tags_read,
+            )
+            match_results.multiple_matches.append(res)
+            return GenericMetadata(), matches, res, match_results
+        if low_confidence and self.config.Runtime_Options__abort_on_low_confidence:
+            logger.error("Online search: Low confidence match. Save aborted")
+            res = Result(
+                Action.save,
+                status=Status.match_failure,
+                original_path=ca.path,
+                online_results=matches,
+                match_status=MatchStatus.low_confidence_match,
+                tags_written=self.config.Runtime_Options__tags_write,
+                tags_read=tags_read,
+            )
+            match_results.low_confidence_matches.append(res)
+            return GenericMetadata(), matches, res, match_results
+        if not found_match:
+            logger.error("Online search: No match found. Save aborted")
+            res = Result(
+                Action.save,
+                status=Status.match_failure,
+                original_path=ca.path,
+                online_results=matches,
+                match_status=MatchStatus.no_match,
+                tags_written=self.config.Runtime_Options__tags_write,
+                tags_read=tags_read,
+            )
+            match_results.no_matches.append(res)
+            return GenericMetadata(), matches, res, match_results
+
+        # we got here, so we have a single match
+
+        # now get the particular issue data
+        ct_md = self.fetch_metadata(matches[0].issue_id)
+        if ct_md.is_empty:
+            res = Result(
+                Action.save,
+                status=Status.fetch_data_failure,
+                original_path=ca.path,
+                online_results=matches,
+                match_status=MatchStatus.good_match,
+                tags_written=self.config.Runtime_Options__tags_write,
+                tags_read=tags_read,
+            )
+            match_results.fetch_data_failures.append(res)
+            return GenericMetadata(), matches, res, match_results
+        return ct_md, matches, None, match_results
+
+    def save(self, ca: ComicArchive, match_results: OnlineMatchResults) -> tuple[Result, OnlineMatchResults]:
+        if self.config.Runtime_Options__skip_existing_tags:
+            for tag_id in self.config.Runtime_Options__tags_write:
+                if ca.has_tags(tag_id):
+                    self.output(f"{ca.path}: Already has {tags[tag_id].name()} tags. Not overwriting.")
+                    return (
+                        Result(
+                            Action.save,
+                            original_path=ca.path,
+                            status=Status.existing_tags,
+                            tags_written=self.config.Runtime_Options__tags_write,
+                        ),
+                        match_results,
+                    )
+
+        if self.batch_mode:
+            self.output(f"Processing {utils.path_to_short_str(ca.path)}...")
+
+        md, tags_read = self.create_local_metadata(ca, self.config.Runtime_Options__tags_read)
+
+        matches: list[IssueResult] = []
+        # now, search online
+
+        ct_md = GenericMetadata()
+        if self.config.Auto_Tag__online:
+            if self.config.Auto_Tag__issue_id is not None:
+                # we were given the actual issue ID to search with
+                try:
+                    ct_md = self.current_talker().fetch_comic_data(self.config.Auto_Tag__issue_id)
+                except TalkerError as e:
+                    logger.exception(f"Error retrieving issue details. Save aborted.\n{e}")
+                    res = Result(
+                        Action.save,
+                        original_path=ca.path,
+                        status=Status.fetch_data_failure,
+                        tags_written=self.config.Runtime_Options__tags_write,
+                        tags_read=tags_read,
+                    )
+                    match_results.fetch_data_failures.append(res)
+                    return res, match_results
+
+                if ct_md is None or ct_md.is_empty:
+                    logger.error("No match for ID %s was found.", self.config.Auto_Tag__issue_id)
+                    res = Result(
+                        Action.save,
+                        status=Status.match_failure,
+                        original_path=ca.path,
+                        match_status=MatchStatus.no_match,
+                        tags_written=self.config.Runtime_Options__tags_write,
+                        tags_read=tags_read,
+                    )
+                    match_results.no_matches.append(res)
+                    return res, match_results
+
+            else:
+                query_md = md.copy()
+                qt_md = self.try_quick_tag(ca, query_md)
+                if query_md.issue is None or query_md.issue == "":
+                    if self.config.Auto_Tag__assume_issue_one:
+                        query_md.issue = "1"
+                if qt_md is None or qt_md.is_empty:
+                    if qt_md is not None:
+                        self.output("Failed to find match via quick tag")
+                    ct_md, matches, res, match_results = self.normal_tag(ca, tags_read, query_md, match_results)  # type: ignore[assignment]
+                    if res is not None:
+                        return res, match_results
+                else:
+                    self.output("Successfully matched via quick tag")
+                    ct_md = qt_md
+                    matches = [
+                        IssueResult(
+                            series=ct_md.series or "",
+                            distance=-1,
+                            issue_number=ct_md.issue or "",
+                            issue_count=ct_md.issue_count,
+                            url_image_hash=-1,
+                            issue_title=ct_md.title or "",
+                            issue_id=ct_md.issue_id or "",
+                            series_id=ct_md.series_id or "",
+                            month=ct_md.month,
+                            year=ct_md.year,
+                            publisher=None,
+                            image_url=str(ct_md._cover_image) or "",
+                            alt_image_urls=[],
+                            description=ct_md.description or "",
+                        )
+                    ]
+
+        res = Result(
+            Action.save,
+            status=Status.success,
+            original_path=ca.path,
+            online_results=matches,
+            match_status=MatchStatus.good_match,
+            md=prepare_metadata(md, ct_md, self.config),
+            tags_written=self.config.Runtime_Options__tags_write,
+            tags_read=tags_read,
+        )
+        assert res.md
+        # ok, done building our metadata. time to save
+        if self.write_tags(ca, res.md):
+            match_results.good_matches.append(res)
+        else:
+            res.status = Status.write_failure
+            match_results.write_failures.append(res)
+        return res, match_results
+
+    def rename(self, ca: ComicArchive) -> Result:
+        original_path = ca.path
+        msg_hdr = ""
+        if self.batch_mode:
+            msg_hdr = f"{ca.path}: "
+
+        md, tags_read = self.create_local_metadata(ca, self.config.Runtime_Options__tags_read)
+
+        if md.series is None:
+            logger.error(msg_hdr + "Can't rename without series name")
+            return Result(Action.rename, Status.read_failure, original_path)
+
+        new_ext = ""  # default
+        if self.config.File_Rename__auto_extension:
+            new_ext = ca.extension()
+
+        renamer = FileRenamer(
+            None,
+            platform="universal" if self.config.File_Rename__strict_filenames else "auto",
+            replacements=self.config.File_Rename__replacements,
+        )
+        renamer.set_metadata(md, ca.path.name)
+        renamer.set_template(self.config.File_Rename__template)
+        renamer.set_issue_zero_padding(self.config.File_Rename__issue_number_padding)
+        renamer.set_smart_cleanup(self.config.File_Rename__use_smart_string_cleanup)
+        renamer.move = self.config.File_Rename__move
+        renamer.move_only = self.config.File_Rename__only_move
+
+        try:
+            new_name = renamer.determine_name(ext=new_ext)
+        except ValueError:
+            logger.exception(
+                msg_hdr
+                + "Invalid format string!\n"
+                + "Your rename template is invalid!\n\n"
+                + "%s\n\n"
+                + "Please consult the template help in the settings "
+                + "and the documentation on the format at "
+                + "https://docs.python.org/3/library/string.html#format-string-syntax",
+                self.config.File_Rename__template,
+            )
+            return Result(Action.rename, Status.rename_failure, original_path, md=md)
+        except Exception:
+            logger.exception("Formatter failure: %s metadata: %s", self.config.File_Rename__template, renamer.metadata)
+            return Result(Action.rename, Status.rename_failure, original_path, md=md)
+
+        folder = get_rename_dir(ca, self.config.File_Rename__dir if self.config.File_Rename__move else None)
+
+        full_path = folder / new_name
+
+        if full_path == ca.path:
+            self.output(msg_hdr + "Filename is already good!")
+            return Result(Action.rename, Status.success, original_path, full_path, md=md)
+
+        suffix = ""
+        if not self.config.Runtime_Options__dryrun:
+            # rename the file
+            try:
+                ca.rename(utils.unique_file(full_path))
+            except OSError:
+                logger.exception("Failed to rename comic archive: %s", ca.path)
+                return Result(Action.rename, Status.write_failure, original_path, full_path, md=md)
+        else:
+            suffix = " (dry-run, no change)"
+
+        self.output(f"renamed '{original_path.name}' -> '{new_name}' {suffix}")
+        return Result(Action.rename, Status.success, original_path, tags_read=tags_read, md=md)
+
+    def export(self, ca: ComicArchive) -> Result:
+        msg_hdr = ""
+        if self.batch_mode:
+            msg_hdr = f"{ca.path}: "
+
+        if ca.is_zip():
+            logger.error(msg_hdr + "Archive is already a zip file.")
+            return Result(Action.export, Status.success, ca.path)
+
+        filename_path = ca.path
+        new_file = filename_path.with_suffix(".cbz")
+
+        if self.config.Runtime_Options__abort_on_conflict and new_file.exists():
+            self.output(msg_hdr + f"{new_file.name} already exists in the that folder.")
+            return Result(Action.export, Status.write_failure, ca.path)
+
+        new_file = utils.unique_file(new_file)
+
+        delete_success = False
+        export_success = False
+        if not self.config.Runtime_Options__dryrun:
+            if ca.export_as_zip(new_file):
+                export_success = True
+                if self.config.Runtime_Options__delete_original:
+                    try:
+                        filename_path.unlink(missing_ok=True)
+                        delete_success = True
+                    except OSError:
+                        logger.exception(msg_hdr + "Error deleting original archive after export")
+            else:
+                # last export failed, so remove the zip, if it exists
+                new_file.unlink(missing_ok=True)
+        else:
+            msg = msg_hdr + f"Dry-run:  Would try to create {os.path.split(new_file)[1]}"
+            if self.config.Runtime_Options__delete_original:
+                msg += " and delete original."
+            self.output(msg)
+            return Result(Action.export, Status.success, ca.path, new_file)
+
+        msg = msg_hdr
+        if export_success:
+            msg += f"Archive exported successfully to: {os.path.split(new_file)[1]}"
+            if self.config.Runtime_Options__delete_original and delete_success:
+                msg += " (Original deleted) "
+        else:
+            msg += "Archive failed to export!"
+
+        self.output(msg)
+
+        return Result(Action.export, Status.success, ca.path, new_file)
+
+    def process_file_cli(
+        self, command: Action, filename: str, match_results: OnlineMatchResults
+    ) -> tuple[Result, OnlineMatchResults]:
+        if not os.path.lexists(filename):
+            logger.error("Cannot find %s", filename)
+            return Result(command, Status.read_failure, pathlib.Path(filename)), match_results
+
+        ca = ComicArchive(
+            filename, str(graphics_path / "nocover.png"), hash_archive=self.config.Runtime_Options__preferred_hash
+        )
+
+        if not ca.seems_to_be_a_comic_archive():
+            logger.error("Sorry, but %s is not a comic archive!", filename)
+            return Result(Action.rename, Status.read_failure, ca.path), match_results
+
+        if not ca.is_writable() and (command in (Action.delete, Action.copy, Action.save, Action.rename)):
+            logger.error("This archive is not writable")
+            return Result(command, Status.write_permission_failure, ca.path), match_results
+
+        if command == Action.print:
+            return self.print(ca), match_results
+
+        elif command == Action.delete:
+            return self.delete(ca), match_results
+
+        elif command == Action.copy is not None:
+            return self.copy(ca), match_results
+
+        elif command == Action.save:
+            return self.save(ca, match_results)
+
+        elif command == Action.rename:
+            return self.rename(ca), match_results
+
+        elif command == Action.export:
+            return self.export(ca), match_results
+        return Result(None, Status.read_failure, ca.path), match_results  # type: ignore[arg-type]

comictaggerlib/coverimagewidget.py

@@ -0,0 +1,308 @@
+"""A PyQt6 widget to display cover images
+
+Display cover images from either a local archive, or from comic source metadata.
+TODO: This should be re-factored using subclasses!
+"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+import pathlib
+
+from PyQt6 import QtCore, QtGui, QtWidgets, uic
+
+from comicapi.comicarchive import ComicArchive
+from comictaggerlib.imagefetcher import ImageFetcher
+from comictaggerlib.imagepopup import ImagePopup
+from comictaggerlib.pageloader import PageLoader
+from comictaggerlib.ui import ui_path
+from comictaggerlib.ui.qtutils import get_qimage_from_data
+
+logger = logging.getLogger(__name__)
+
+
+def clickable(widget: QtWidgets.QWidget) -> QtCore.pyqtBoundSignal:
+    """Allow a label to be clickable"""
+
+    class Filter(QtCore.QObject):
+        dblclicked = QtCore.pyqtSignal()
+
+        def eventFilter(self, obj: QtCore.QObject, event: QtCore.QEvent) -> bool:
+            if obj == widget:
+                if event.type() == QtCore.QEvent.Type.MouseButtonDblClick:
+                    self.dblclicked.emit()
+                    return True
+            return False
+
+    flt = Filter(widget)
+    widget.installEventFilter(flt)
+    return flt.dblclicked
+
+
+class CoverImageWidget(QtWidgets.QWidget):
+    ArchiveMode = 0
+    AltCoverMode = 1
+    URLMode = 1
+    DataMode = 3
+
+    image_fetch_complete = QtCore.pyqtSignal(str, QtCore.QByteArray)
+
+    def __init__(
+        self,
+        parent: QtWidgets.QWidget,
+        mode: int,
+        cache_folder: pathlib.Path | None,
+        blur: bool = False,
+        expand_on_click: bool = True,
+    ) -> None:
+        super().__init__(parent)
+
+        if mode not in (self.AltCoverMode, self.URLMode) or cache_folder is None:
+            self.cover_fetcher = None
+            self.talker = None
+        else:
+            self.cover_fetcher = ImageFetcher(cache_folder)
+            self.talker = None
+        with (ui_path / "coverimagewidget.ui").open(encoding="utf-8") as uifile:
+            uic.loadUi(uifile, self)
+
+        self.cache_folder = cache_folder
+        self.mode: int = mode
+        self.page_loader: PageLoader | None = None
+        self.showControls = True
+        self.blur = blur
+        self.scene = QtWidgets.QGraphicsScene(parent=self)
+
+        self.current_pixmap = QtGui.QPixmap()
+
+        self.comic_archive: ComicArchive | None = None
+        self.issue_id: str = ""
+        self.issue_url: str | None = None
+        self.url_list: list[str] = []
+        if self.page_loader is not None:
+            self.page_loader.abandoned = True
+        self.page_loader = None
+        self.imageIndex = -1
+        self.imageCount = 1
+        self.imageData = b""
+
+        self.btnLeft.setIcon(QtGui.QIcon(":/graphics/left.png"))
+        self.btnRight.setIcon(QtGui.QIcon(":/graphics/right.png"))
+
+        self.btnLeft.clicked.connect(self.decrement_image)
+        self.btnRight.clicked.connect(self.increment_image)
+        self.image_fetch_complete.connect(self.cover_remote_fetch_complete)
+        if expand_on_click:
+            clickable(self.graphicsView).connect(self.show_popup)
+        else:
+            self.graphicsView.setToolTip("")
+        self.graphicsView.setScene(self.scene)
+
+        self.update_content()
+
+    def reset_widget(self) -> None:
+        self.comic_archive = None
+        self.issue_id = ""
+        self.issue_url = None
+        self.url_list = []
+        if self.page_loader is not None:
+            self.page_loader.abandoned = True
+        self.page_loader = None
+        self.imageIndex = -1
+        self.imageCount = 1
+        self.imageData = b""
+
+    def clear(self) -> None:
+        self.reset_widget()
+        self.update_content()
+
+    def increment_image(self) -> None:
+        self.imageIndex += 1
+        if self.imageIndex == self.imageCount:
+            self.imageIndex = 0
+        self.update_content()
+
+    def decrement_image(self) -> None:
+        self.imageIndex -= 1
+        if self.imageIndex == -1:
+            self.imageIndex = self.imageCount - 1
+        self.update_content()
+
+    def set_archive(self, ca: ComicArchive, page: int = 0) -> None:
+        if self.mode == CoverImageWidget.ArchiveMode:
+            self.reset_widget()
+            self.comic_archive = ca
+            self.imageIndex = page
+            self.imageCount = ca.get_number_of_pages()
+            self.update_content()
+
+    def set_url(self, url: str) -> None:
+        if self.mode == CoverImageWidget.URLMode:
+            self.reset_widget()
+            self.update_content()
+
+            self.url_list = [url]
+            self.imageIndex = 0
+            self.imageCount = 1
+            self.update_content()
+
+    def set_issue_details(self, issue_id: str, url_list: list[str]) -> None:
+        if self.mode == CoverImageWidget.AltCoverMode:
+            self.reset_widget()
+            self.update_content()
+            self.issue_id = issue_id
+
+            self.set_url_list(url_list)
+
+    def set_image_data(self, image_data: bytes) -> None:
+        if self.mode == CoverImageWidget.DataMode:
+            self.reset_widget()
+
+            if image_data:
+                self.imageIndex = 0
+                self.imageData = image_data
+            else:
+                self.imageIndex = -1
+
+            self.update_content()
+
+    def set_url_list(self, url_list: list[str]) -> None:
+        self.url_list = url_list
+        self.imageIndex = 0
+        self.imageCount = len(self.url_list)
+        self.update_content()
+        self.update_controls()
+
+    def set_page(self, pagenum: int) -> None:
+        if self.mode == CoverImageWidget.ArchiveMode:
+            self.imageIndex = pagenum
+            self.update_content()
+
+    def update_content(self) -> None:
+        self.update_image()
+        self.update_controls()
+
+    def update_image(self) -> None:
+        if self.imageIndex == -1:
+            self.load_default()
+        elif self.mode in [CoverImageWidget.AltCoverMode, CoverImageWidget.URLMode]:
+            self.load_url()
+        elif self.mode == CoverImageWidget.DataMode:
+            self.cover_remote_fetch_complete("", self.imageData)
+        else:
+            self.load_page()
+
+    def update_controls(self) -> None:
+        if not self.showControls or self.mode == CoverImageWidget.DataMode:
+            self.btnLeft.hide()
+            self.btnRight.hide()
+            self.label.hide()
+            return
+
+        if self.imageIndex == -1 or self.imageCount == 1:
+            self.btnLeft.setEnabled(False)
+            self.btnRight.setEnabled(False)
+            self.btnLeft.hide()
+            self.btnRight.hide()
+        else:
+            self.btnLeft.setEnabled(True)
+            self.btnRight.setEnabled(True)
+            self.btnLeft.show()
+            self.btnRight.show()
+
+        if self.imageIndex == -1 or self.imageCount == 1:
+            self.label.setText("")
+        elif self.mode == CoverImageWidget.AltCoverMode:
+            self.label.setText(f"Cover {self.imageIndex + 1} (of {self.imageCount})")
+        else:
+            self.label.setText(f"Page {self.imageIndex + 1} (of {self.imageCount})")
+
+    def load_url(self) -> None:
+        assert isinstance(self.cache_folder, pathlib.Path)
+        self.load_default()
+        self.cover_fetcher = ImageFetcher(self.cache_folder)
+        ImageFetcher.image_fetch_complete = self.image_fetch_complete.emit
+        data = self.cover_fetcher.fetch(self.url_list[self.imageIndex])
+        if data:
+            self.cover_remote_fetch_complete(self.url_list[self.imageIndex], data)
+
+    # called when the image is done loading from internet
+    def cover_remote_fetch_complete(self, url: str, image_data: bytes) -> None:
+        if url and url not in self.url_list:
+            return
+        img = get_qimage_from_data(image_data)
+        self.current_pixmap = QtGui.QPixmap.fromImage(img)
+        self.set_display_pixmap()
+
+    def load_page(self) -> None:
+        if self.comic_archive is not None:
+            if self.page_loader is not None:
+                self.page_loader.abandoned = True
+            self.page_loader = PageLoader(self.comic_archive, self.imageIndex)
+            self.page_loader.loadComplete.connect(self.page_load_complete)
+            self.page_loader.start()
+
+    def page_load_complete(self, image_data: bytes) -> None:
+        img = get_qimage_from_data(image_data)
+        self.current_pixmap = QtGui.QPixmap.fromImage(img)
+        self.set_display_pixmap()
+        self.page_loader = None
+
+    def load_default(self) -> None:
+        self.current_pixmap = QtGui.QPixmap(":/graphics/nocover.png")
+        self.set_display_pixmap()
+
+    def resizeEvent(self, resize_event: QtGui.QResizeEvent) -> None:
+        if self.current_pixmap is not None:
+            self.set_display_pixmap()
+
+    def set_display_pixmap(self) -> None:
+        """The deltas let us know what the new width and height of the label will be"""
+
+        new_w = self.frame.width()
+        new_h = self.frame.height()
+        frame_w = self.frame.width()
+        frame_h = self.frame.height()
+
+        new_h -= 8
+        new_w -= 8
+
+        new_h = max(new_h, 0)
+        new_w = max(new_w, 0)
+
+        # scale the pixmap to fit in the frame
+        scaled_pixmap = self.current_pixmap.scaled(
+            new_w, new_h, QtCore.Qt.AspectRatioMode.KeepAspectRatio, QtCore.Qt.TransformationMode.SmoothTransformation
+        )
+        self.scene.clear()
+        qpix = self.scene.addPixmap(scaled_pixmap)
+        assert qpix
+        if self.blur:
+            blur = QtWidgets.QGraphicsBlurEffect(parent=self)
+            blur.setBlurHints(QtWidgets.QGraphicsBlurEffect.BlurHint.PerformanceHint)
+            blur.setBlurRadius(30)
+            qpix.setGraphicsEffect(blur)
+
+        # move and resize the label to be centered in the fame
+        img_w = scaled_pixmap.width()
+        img_h = scaled_pixmap.height()
+        self.scene.setSceneRect(0, 0, img_w, img_h)
+        self.graphicsView.resize(img_w + 2, img_h + 2)
+        self.graphicsView.move(int((frame_w - img_w) / 2), int((frame_h - img_h) / 2))
+
+    def show_popup(self) -> None:
+        ImagePopup(self, self.current_pixmap)

comictaggerlib/crediteditorwindow.py

@@ -0,0 +1,98 @@
+"""A PyQT4 dialog to edit credits"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+import operator
+
+import natsort
+from PyQt6 import QtCore, QtWidgets, uic
+
+from comicapi import utils
+from comicapi.genericmetadata import Credit
+from comictaggerlib.ui import ui_path
+
+logger = logging.getLogger(__name__)
+
+
+class CreditEditorWindow(QtWidgets.QDialog):
+    ModeEdit = 0
+    ModeNew = 1
+
+    def __init__(self, parent: QtWidgets.QWidget, mode: int, credit: Credit) -> None:
+        super().__init__(parent)
+
+        with (ui_path / "crediteditorwindow.ui").open(encoding="utf-8") as uifile:
+            uic.loadUi(uifile, self)
+
+        self.mode = mode
+
+        if self.mode == self.ModeEdit:
+            self.setWindowTitle("Edit Credit")
+        else:
+            self.setWindowTitle("New Credit")
+
+        # Add the entries to the role combobox
+        self.cbRole.addItem("")
+        self.cbRole.addItem("Artist")
+        self.cbRole.addItem("Colorist")
+        self.cbRole.addItem("Cover Artist")
+        self.cbRole.addItem("Editor")
+        self.cbRole.addItem("Inker")
+        self.cbRole.addItem("Letterer")
+        self.cbRole.addItem("Penciller")
+        self.cbRole.addItem("Plotter")
+        self.cbRole.addItem("Scripter")
+        self.cbRole.addItem("Translator")
+        self.cbRole.addItem("Writer")
+        self.cbRole.addItem("Other")
+
+        self.cbLanguage.addItem("", "")
+        for f in natsort.humansorted(utils.languages().items(), operator.itemgetter(1)):
+            self.cbLanguage.addItem(f[1], f[0])
+
+        self.leName.setText(credit.person)
+
+        if credit.role is not None and credit.role != "":
+            i = self.cbRole.findText(credit.role)
+            if i == -1:
+                self.cbRole.setEditText(credit.role)
+            else:
+                self.cbRole.setCurrentIndex(i)
+
+        if credit.language != "":
+            i = (
+                self.cbLanguage.findData(credit.language, QtCore.Qt.ItemDataRole.UserRole)
+                if self.cbLanguage.findData(credit.language, QtCore.Qt.ItemDataRole.UserRole) > -1
+                else self.cbLanguage.findText(credit.language)
+            )
+            if i == -1:
+                self.cbLanguage.setEditText(credit.language)
+            else:
+                self.cbLanguage.setCurrentIndex(i)
+
+        self.cbPrimary.setChecked(credit.primary)
+
+    def get_credit(self) -> Credit:
+        lang = self.cbLanguage.currentData() or self.cbLanguage.currentText()
+        return Credit(self.leName.text(), self.cbRole.currentText(), self.cbPrimary.isChecked(), lang)
+
+    def accept(self) -> None:
+        if self.leName.text() == "":
+            QtWidgets.QMessageBox.warning(self, "Whoops", "You need to enter a name for a credit.")
+        else:
+            QtWidgets.QDialog.accept(self)

comictaggerlib/ctsettings/__init__.py

@@ -0,0 +1,122 @@
+from __future__ import annotations
+
+import json
+import logging
+import pathlib
+from enum import Enum
+from typing import Any
+
+import settngs
+
+from comictaggerlib.ctsettings.commandline import (
+    initial_commandline_parser,
+    register_commandline_settings,
+    validate_commandline_settings,
+)
+from comictaggerlib.ctsettings.file import register_file_settings, validate_file_settings
+from comictaggerlib.ctsettings.plugin import group_for_plugin, register_plugin_settings, validate_plugin_settings
+from comictaggerlib.ctsettings.settngs_namespace import SettngsNS as ct_ns
+from comictaggerlib.ctsettings.types import ComicTaggerPaths
+from comictalker import ComicTalker
+
+logger = logging.getLogger(__name__)
+
+talkers: dict[str, ComicTalker] = {}
+
+__all__ = [
+    "initial_commandline_parser",
+    "register_commandline_settings",
+    "register_file_settings",
+    "register_plugin_settings",
+    "validate_commandline_settings",
+    "validate_file_settings",
+    "validate_plugin_settings",
+    "ComicTaggerPaths",
+    "ct_ns",
+    "group_for_plugin",
+]
+
+
+class SettingsEncoder(json.JSONEncoder):
+    def default(self, obj: Any) -> Any:
+        if isinstance(obj, pathlib.Path):
+            return str(obj)
+
+        # Let the base class default method raise the TypeError
+        return json.JSONEncoder.default(self, obj)
+
+
+def validate_types(config: settngs.Config[settngs.Values]) -> settngs.Config[settngs.Values]:
+    # Go through each setting
+    for group in config.definitions.values():
+        for setting in group.v.values():
+            # Get the value and if it is the default
+            value, default = settngs.get_option(config.values, setting)
+            if not default and setting.type is not None:
+                # If it is not the default and the type attribute is not None
+                # use it to convert the loaded string into the expected value
+                if (
+                    isinstance(value, str)
+                    or isinstance(default, Enum)
+                    or (isinstance(setting.type, type) and issubclass(setting.type, Enum))
+                ):
+                    if isinstance(setting.type, type) and issubclass(setting.type, Enum) and isinstance(value, list):
+                        config.values[setting.group][setting.dest] = [setting.type(x) for x in value]
+                    else:
+                        config.values[setting.group][setting.dest] = setting.type(value)
+    return config
+
+
+def parse_config(
+    manager: settngs.Manager,
+    config_path: pathlib.Path,
+    args: list[str] | None = None,
+) -> tuple[settngs.Config[settngs.Values], bool]:
+    """
+    Function to parse options from a json file and passes the resulting Config object to parse_cmdline.
+
+    Args:
+        manager: settngs Manager object
+        config_path: A `pathlib.Path` object
+        args: Passed to argparse.ArgumentParser.parse_args
+    """
+    file_options, success = settngs.parse_file(manager.definitions, config_path)
+    file_options = validate_types(file_options)
+    cmdline_options = settngs.parse_cmdline(
+        manager.definitions,
+        manager.description,
+        manager.epilog,
+        args,
+        file_options,
+    )
+
+    final_options = settngs.normalize_config(cmdline_options, file=True, cmdline=True)
+    return final_options, success
+
+
+def save_file(
+    config: settngs.Config[settngs.T],
+    filename: pathlib.Path,
+) -> bool:
+    """
+    Helper function to save options from a json dictionary to a file
+
+    Args:
+        config: The options to save to a json dictionary
+        filename: A pathlib.Path object to save the json dictionary to
+    """
+    file_options = settngs.clean_config(config, file=True)
+    if "Quick Tag" in file_options and "url" in file_options["Quick Tag"]:
+        file_options["Quick Tag"]["url"] = str(file_options["Quick Tag"]["url"])
+
+    try:
+        if not filename.exists():
+            filename.parent.mkdir(exist_ok=True, parents=True)
+            filename.touch()
+
+        json_str = json.dumps(file_options, cls=SettingsEncoder, indent=2)
+        filename.write_text(json_str + "\n", encoding="utf-8")
+    except Exception:
+        logger.exception("Failed to save config file: %s", filename)
+        return False
+    return True

comictaggerlib/ctsettings/commandline.py

@@ -0,0 +1,382 @@
+"""CLI settings for ComicTagger"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import argparse
+import hashlib
+import logging
+import os
+import platform
+import shlex
+import subprocess
+
+import settngs
+
+from comicapi import comicarchive, utils
+from comicapi.comicarchive import tags
+from comictaggerlib import ctversion, quick_tag
+from comictaggerlib.ctsettings.settngs_namespace import SettngsNS as ct_ns
+from comictaggerlib.ctsettings.types import ComicTaggerPaths, tag
+from comictaggerlib.resulttypes import Action
+
+logger = logging.getLogger(__name__)
+
+
+def initial_commandline_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(add_help=False)
+    # Ensure this stays up to date with register_runtime
+    parser.add_argument(
+        "--config",
+        help="Config directory for ComicTagger to use.\ndefault: %(default)s\n\n",
+        type=ComicTaggerPaths,
+        default=ComicTaggerPaths(),
+    )
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        action="count",
+        default=0,
+        help="Be noisy when doing what it does. Use a second time to enable debug logs.\nShort option cannot be combined with other options.",
+    )
+    parser.add_argument(
+        "--enable-quick-tag",
+        action=argparse.BooleanOptionalAction,
+        default=False,
+        help='Enable the expiremental "quick tagger"',
+    )
+    return parser
+
+
+def register_runtime(parser: settngs.Manager) -> None:
+    parser.add_setting(
+        "--config",
+        help="Config directory for ComicTagger to use.\ndefault: %(default)s\n\n",
+        type=ComicTaggerPaths,
+        default=ComicTaggerPaths(),
+        file=False,
+    )
+    parser.add_setting(
+        "-v",
+        "--verbose",
+        action="count",
+        default=0,
+        help="Be noisy when doing what it does. Use a second time to enable debug logs.\nShort option cannot be combined with other options.",
+        file=False,
+    )
+    parser.add_setting(
+        "--enable-quick-tag",
+        action=argparse.BooleanOptionalAction,
+        default=False,
+        help='Enable the expiremental "quick tagger"',
+        file=False,
+    )
+    parser.add_setting(
+        "--enable-embedding-hashes",
+        action=argparse.BooleanOptionalAction,
+        default=False,
+        help="Enable embedding hashes in metadata (currently only CR/CIX has support)",
+        file=False,
+    )
+    parser.add_setting(
+        "--preferred-hash",
+        default="shake_256",
+        choices=hashlib.algorithms_available,
+        help="The type of embedded hash to save when --enable-embedding-hashes is set\n\n",
+        file=False,
+    )
+    parser.add_setting("-q", "--quiet", action="store_true", help="Don't say much (for print mode).", file=False)
+    parser.add_setting(
+        "-j",
+        "--json",
+        action="store_true",
+        help="Output json on stdout. Ignored in interactive mode.\n\n",
+        file=False,
+    )
+    parser.add_setting(
+        "--raw",
+        action="store_true",
+        help="""With -p, will print out the raw tag block(s) from the file.""",
+        file=False,
+    )
+    parser.add_setting(
+        "-i",
+        "--interactive",
+        action="store_true",
+        help="""Interactively query the user when there are\nmultiple matches for an online search. Disabled json output\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--abort",
+        dest="abort_on_low_confidence",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="""Abort save operation when online match is of low confidence.\ndefault: %(default)s""",
+        file=False,
+    )
+    parser.add_setting(
+        "-n",
+        "--dryrun",
+        action="store_true",
+        help="Don't actually modify file (only relevant for -d, -s, or -r).\n\n",
+        file=False,
+    )
+    parser.add_setting(
+        "--summary",
+        default=True,
+        action=argparse.BooleanOptionalAction,
+        help="Show the summary after a save operation.\ndefault: %(default)s",
+        file=False,
+    )
+    parser.add_setting(
+        "-R",
+        "--recursive",
+        action="store_true",
+        help="Recursively include files in sub-folders.",
+        file=False,
+    )
+    parser.add_setting("-g", "--glob", action="store_true", help="Windows only. Enable globbing", file=False)
+    parser.add_setting("--darkmode", action="store_true", help="Windows only. Force a dark pallet", file=False)
+    parser.add_setting("--no-gui", action="store_true", help="Do not open the GUI, force the commandline", file=False)
+
+    parser.add_setting(
+        "--abort-on-conflict",
+        action="store_true",
+        help="""Don't export to zip if intended new filename exists\n(otherwise, creates a new unique filename).\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--delete-original",
+        action="store_true",
+        help="""Delete original archive after successful export to Zip.\n(only relevant for -e)\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "-t",
+        "--tags-read",
+        metavar=f"{{{','.join(tags).upper()}}}",
+        default=[],
+        type=tag,
+        help="""Specify the tags to read.\nUse commas for multiple tags.\nSee --list-plugins for the available tags.\nThe tags used will be 'overlaid' in order:\ne.g. '-t cbl,cr' with no CBL tags, CR will be used if they exist and CR will overwrite any shared CBL tags.\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--tags-write",
+        metavar=f"{{{','.join(tags).upper()}}}",
+        default=[],
+        type=tag,
+        help="""Specify the tags to write.\nUse commas for multiple tags.\nRead tags will be used if unspecified\nSee --list-plugins for the available tags.\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--skip-existing-tags",
+        action=argparse.BooleanOptionalAction,
+        default=False,
+        help="""Skip archives that already have tags specified with -t,\notherwise merges new tags with existing tags (relevant for -s or -c).\ndefault: %(default)s""",
+        file=False,
+    )
+    parser.add_setting("files", nargs="*", default=[], file=False)
+
+
+def register_commands(parser: settngs.Manager) -> None:
+    parser.add_setting("--version", action="store_true", help="Display version.", file=False)
+
+    parser.add_setting(
+        "-p",
+        "--print",
+        dest="command",
+        action="store_const",
+        const=Action.print,
+        default=Action.gui,
+        help="""Print out tag info from file. Specify via -t to only print specific tags.\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "-d",
+        "--delete",
+        dest="command",
+        action="store_const",
+        const=Action.delete,
+        help="Deletes the tags specified via -t.",
+        file=False,
+    )
+    parser.add_setting(
+        "-c",
+        "--copy",
+        type=tag,
+        default=[],
+        metavar=f"{{{','.join(tags).upper()}}}",
+        help="Copy the specified source tags to\ndestination tags specified via --tags-write\n(potentially lossy operation).\n\n",
+        file=False,
+    )
+    parser.add_setting(
+        "-s",
+        "--save",
+        dest="command",
+        action="store_const",
+        const=Action.save,
+        help="Save out tags as specified tags (via --tags-write).\nMust specify also at least -o, -f, or -m.\n\n",
+        file=False,
+    )
+    parser.add_setting(
+        "-r",
+        "--rename",
+        dest="command",
+        action="store_const",
+        const=Action.rename,
+        help="Rename the file based on specified tags.",
+        file=False,
+    )
+    parser.add_setting(
+        "-e",
+        "--export-to-zip",
+        dest="command",
+        action="store_const",
+        const=Action.export,
+        help="Export archive to Zip format.",
+        file=False,
+    )
+    parser.add_setting(
+        "--only-save-config",
+        dest="command",
+        action="store_const",
+        const=Action.save_config,
+        help="Only save the configuration (eg, Comic Vine API key) and quit.",
+        file=False,
+    )
+    parser.add_setting(
+        "--list-plugins",
+        dest="command",
+        action="store_const",
+        const=Action.list_plugins,
+        default=Action.gui,
+        help="List the available plugins.\n\n",
+        file=False,
+    )
+
+
+def register_commandline_settings(parser: settngs.Manager, enable_quick_tag: bool) -> None:
+    parser.add_group("Commands", register_commands, True)
+    parser.add_persistent_group("Runtime Options", register_runtime)
+    if enable_quick_tag:
+        parser.add_group("Quick Tag", quick_tag.settings)
+
+
+def validate_commandline_settings(config: settngs.Config[ct_ns], parser: settngs.Manager) -> settngs.Config[ct_ns]:
+    if config[0].Commands__version:
+        parser.exit(
+            status=1,
+            message=f"ComicTagger {ctversion.version}:  Copyright (c) 2012-2022 ComicTagger Team\n"
+            + "Distributed under Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)\n",
+        )
+
+    enabled_tags = {tag for tag in comicarchive.tags if comicarchive.tags[tag].enabled}
+    if (
+        (not config[0].Metadata_Options__cr)
+        and "cr" in comicarchive.tags
+        and comicarchive.tags["cr"].enabled
+        and len(enabled_tags) > 1
+    ):
+        comicarchive.tags["cr"].enabled = False
+
+    config[0].Runtime_Options__no_gui = any(
+        (config[0].Commands__command != Action.gui, config[0].Runtime_Options__no_gui, config[0].Commands__copy)
+    )
+
+    if platform.system() == "Windows" and config[0].Runtime_Options__glob:
+        # no globbing on windows shell, so do it for them
+        import glob
+
+        globs = config[0].Runtime_Options__files
+        config[0].Runtime_Options__files = []
+        for item in globs:
+            config[0].Runtime_Options__files.extend(glob.glob(item))
+
+    if config[0].Runtime_Options__json and config[0].Runtime_Options__interactive:
+        config[0].Runtime_Options__json = False
+
+    if config[0].Runtime_Options__tags_read and not config[0].Runtime_Options__tags_write:
+        config[0].Runtime_Options__tags_write = config[0].Runtime_Options__tags_read
+
+    disabled_tags = {tag for tag in comicarchive.tags if not comicarchive.tags[tag].enabled}
+    to_be_removed = (
+        set(config[0].Runtime_Options__tags_read)
+        .union(config[0].Runtime_Options__tags_write)
+        .intersection(disabled_tags)
+    )
+    if to_be_removed:
+        logger.debug("Removing disabled tags: %s", to_be_removed)
+        config[0].Runtime_Options__tags_read = [
+            tag for tag in config[0].Runtime_Options__tags_read if tag not in to_be_removed
+        ]
+        config[0].Runtime_Options__tags_write = [
+            tag for tag in config[0].Runtime_Options__tags_write if tag not in to_be_removed
+        ]
+
+    if (
+        config[0].Runtime_Options__no_gui
+        and not [tag.id for tag in tags.values() if tag.enabled]
+        and config[0].Commands__command != Action.list_plugins
+    ):
+        parser.exit(status=1, message="There are no tags enabled see --list-plugins\n")
+
+    if config[0].Runtime_Options__no_gui and not config[0].Runtime_Options__files:
+        if config[0].Commands__command == Action.print and not config[0].Auto_Tag__metadata.is_empty:
+            ...  # allow printing the metadata provided on the commandline
+        elif config[0].Commands__command not in (Action.save_config, Action.list_plugins):
+            parser.exit(message="Command requires at least one filename!\n", status=1)
+
+    if config[0].Commands__command == Action.delete and not config[0].Runtime_Options__tags_write:
+        parser.exit(message="Please specify the tags to delete with --tags-write\n", status=1)
+
+    if config[0].Commands__command == Action.save and not config[0].Runtime_Options__tags_write:
+        parser.exit(message="Please specify the tags to save with --tags-write\n", status=1)
+
+    if config[0].Commands__copy:
+        config[0].Commands__command = Action.copy
+        if not config[0].Runtime_Options__tags_write:
+            parser.exit(message="Please specify the tags to copy to with --tags-write\n", status=1)
+
+    if config[0].Runtime_Options__recursive:
+        config[0].Runtime_Options__files = utils.os_sorted(
+            set(utils.get_recursive_filelist(config[0].Runtime_Options__files))
+        )
+
+    if not config[0].Runtime_Options__enable_embedding_hashes:
+        config[0].Runtime_Options__preferred_hash = ""
+
+    # take a crack at finding rar exe if it's not in the path
+    if not utils.which("rar"):
+        if platform.system() == "Windows":
+            letters = ["C"]
+            letters.extend({f"{d}" for d in "ABDEFGHIJKLMNOPQRSTUVWXYZ" if os.path.exists(f"{d}:\\")})
+            for letter in letters:
+                # look in some likely places for Windows machines
+                utils.add_to_path(rf"{letter}:\Program Files\WinRAR")
+                utils.add_to_path(rf"{letter}:\Program Files (x86)\WinRAR")
+        else:
+            if platform.system() == "Darwin":
+                result = subprocess.run(("/usr/libexec/path_helper", "-s"), capture_output=True)
+                for path in reversed(
+                    shlex.split(result.stdout.decode("utf-8", errors="ignore"))[0]
+                    .partition("=")[2]
+                    .rstrip(";")
+                    .split(os.pathsep)
+                ):
+                    utils.add_to_path(path)
+            utils.add_to_path("/opt/homebrew/bin")
+
+    return config

comictaggerlib/ctsettings/file.py

@@ -0,0 +1,398 @@
+from __future__ import annotations
+
+import argparse
+import uuid
+
+import settngs
+
+from comicapi import merge, utils
+from comicapi.genericmetadata import GenericMetadata
+from comictaggerlib.ctsettings.settngs_namespace import SettngsNS as ct_ns
+from comictaggerlib.ctsettings.types import parse_metadata_from_string
+from comictaggerlib.defaults import DEFAULT_REPLACEMENTS, Replacement, Replacements
+
+
+def general(parser: settngs.Manager) -> None:
+    # General Settings
+    parser.add_setting("check_for_new_version", default=False, cmdline=False)
+    parser.add_setting("blur", default=False, cmdline=False)
+    parser.add_setting(
+        "--prompt-on-save",
+        default=True,
+        action=argparse.BooleanOptionalAction,
+        help="Prompts the user to confirm saving tags when using the GUI.\ndefault: %(default)s",
+    )
+
+
+def internal(parser: settngs.Manager) -> None:
+    # automatic settings
+    parser.add_setting("install_id", default=uuid.uuid4().hex, cmdline=False)
+    parser.add_setting("embedded_hash_type", default="shake_256", cmdline=False)
+    parser.add_setting("write_tags", default=["cr"], cmdline=False)
+    parser.add_setting("read_tags", default=["cr"], cmdline=False)
+    parser.add_setting("last_opened_folder", default="", cmdline=False)
+    parser.add_setting("window_width", default=0, cmdline=False)
+    parser.add_setting("window_height", default=0, cmdline=False)
+    parser.add_setting("window_x", default=0, cmdline=False)
+    parser.add_setting("window_y", default=0, cmdline=False)
+    parser.add_setting("form_width", default=-1, cmdline=False)
+    parser.add_setting("list_width", default=-1, cmdline=False)
+    parser.add_setting("sort_column", default=-1, cmdline=False)
+    parser.add_setting("sort_direction", default=0, cmdline=False)
+    parser.add_setting("remove_archive_after_successful_match", default=False, cmdline=False)
+
+
+def identifier(parser: settngs.Manager) -> None:
+    parser.add_setting(
+        "--series-match-identify-thresh",
+        default=91,
+        type=int,
+        help="The minimum Series name similarity needed to auto-identify an issue default: %(default)s",
+    )
+    parser.add_setting(
+        "--series-match-search-thresh",
+        default=90,
+        type=int,
+        help="The minimum Series name similarity to return from a search result default: %(default)s",
+    )
+    parser.add_setting(
+        "-b",
+        "--border-crop-percent",
+        default=10,
+        type=int,
+        help="ComicTagger will automatically add an additional cover that has any black borders cropped.\nIf the difference in height is less than %(default)s%% the cover will not be cropped.\ndefault: %(default)s\n\n",
+    )
+
+    parser.add_setting(
+        "--sort-series-by-year",
+        default=True,
+        action=argparse.BooleanOptionalAction,
+        help="Sorts series by year default: %(default)s",
+    )
+    parser.add_setting(
+        "--exact-series-matches-first",
+        default=True,
+        action=argparse.BooleanOptionalAction,
+        help="Puts series that are an exact match at the top of the list default: %(default)s",
+    )
+
+
+def dialog(parser: settngs.Manager) -> None:
+    parser.add_setting("show_disclaimer", default=True, cmdline=False)
+    parser.add_setting("dont_notify_about_this_version", default="", cmdline=False)
+    parser.add_setting("notify_plugin_changes", default=True, cmdline=False)
+
+
+def filename(parser: settngs.Manager) -> None:
+    parser.add_setting(
+        "--filename-parser",
+        default=utils.Parser.ORIGINAL,
+        metavar=f"{{{','.join(utils.Parser)}}}",
+        type=utils.Parser,
+        choices=utils.Parser,
+        help="Select the filename parser.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "--remove-c2c",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Removes c2c from filenames.\nRequires --complicated-parser\ndefault: %(default)s\n\n",
+    )
+    parser.add_setting(
+        "--remove-fcbd",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Removes FCBD/free comic book day from filenames.\nRequires --complicated-parser\ndefault: %(default)s\n\n",
+    )
+    parser.add_setting(
+        "--remove-publisher",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Attempts to remove publisher names from filenames, currently limited to Marvel and DC.\nRequires --complicated-parser\ndefault: %(default)s\n\n",
+    )
+    parser.add_setting(
+        "--split-words",
+        action="store_true",
+        help="""Splits words before parsing the filename.\ne.g. 'judgedredd' to 'judge dredd'\ndefault: %(default)s\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--protofolius-issue-number-scheme",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Use an issue number scheme devised by protofolius for encoding format information as a letter in front of an issue number.\nImplies --allow-issue-start-with-letter.  Requires --complicated-parser\ndefault: %(default)s\n\n",
+    )
+    parser.add_setting(
+        "--allow-issue-start-with-letter",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Allows an issue number to start with a single letter (e.g. '#X01').\nRequires --complicated-parser\ndefault: %(default)s\n\n",
+    )
+
+
+def talker(parser: settngs.Manager) -> None:
+    parser.add_setting(
+        "--source",
+        default="comicvine",
+        help="Use a specified source by source ID (use --list-plugins to list all sources).\ndefault: %(default)s",
+    )
+
+
+def md_options(parser: settngs.Manager) -> None:
+    # CBL Transform settings
+    parser.add_setting("--assume-lone-credit-is-primary", default=False, action=argparse.BooleanOptionalAction)
+    parser.add_setting("--copy-characters-to-tags", default=False, action=argparse.BooleanOptionalAction)
+    parser.add_setting("--copy-teams-to-tags", default=False, action=argparse.BooleanOptionalAction)
+    parser.add_setting("--copy-locations-to-tags", default=False, action=argparse.BooleanOptionalAction)
+    parser.add_setting("--copy-storyarcs-to-tags", default=False, action=argparse.BooleanOptionalAction)
+    parser.add_setting("--copy-notes-to-comments", default=False, action=argparse.BooleanOptionalAction)
+    parser.add_setting("--copy-weblink-to-comments", default=False, action=argparse.BooleanOptionalAction)
+    parser.add_setting("--apply-transform-on-import", default=False, action=argparse.BooleanOptionalAction)
+    parser.add_setting("--apply-transform-on-bulk-operation", default=False, action=argparse.BooleanOptionalAction)
+
+    parser.add_setting(
+        "--remove-html-tables",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        display_name="Remove HTML tables",
+        help="Removes html tables instead of converting them to text",
+    )
+    parser.add_setting("use_short_tag_names", default=False, action=argparse.BooleanOptionalAction, cmdline=False)
+    parser.add_setting(
+        "--cr",
+        default=True,
+        action=argparse.BooleanOptionalAction,
+        help="Enable ComicRack tags. Turn off to only use CIX tags.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "--tag-merge",
+        metavar=f"{{{','.join(merge.Mode)}}}",
+        default=merge.Mode.OVERLAY,
+        choices=merge.Mode,
+        type=merge.Mode,
+        help="How to merge fields when reading enabled tags (CR, CBL, etc.) See -t, --tags-read default: %(default)s",
+    )
+    parser.add_setting(
+        "--metadata-merge",
+        metavar=f"{{{','.join(merge.Mode)}}}",
+        default=merge.Mode.OVERLAY,
+        choices=merge.Mode,
+        type=merge.Mode,
+        help="How to merge fields when downloading new metadata (CV, Metron, GCD, etc.) default: %(default)s",
+    )
+    parser.add_setting(
+        "--tag-merge-lists",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="Merge lists when reading enabled tags (genres, characters, etc.) default: %(default)s",
+    )
+    parser.add_setting(
+        "--metadata-merge-lists",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="Merge lists when downloading new metadata (genres, characters, etc.) default: %(default)s",
+    )
+
+
+def rename(parser: settngs.Manager) -> None:
+    parser.add_setting(
+        "--template",
+        default="{series} #{issue} ({year})",
+        help="The teplate to use when renaming.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "--issue-number-padding",
+        default=3,
+        type=int,
+        help="The minimum number of digits to use for the issue number when renaming.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "--use-smart-string-cleanup",
+        default=True,
+        action=argparse.BooleanOptionalAction,
+        help="Attempts to intelligently cleanup whitespace when renaming.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "--auto-extension",
+        default=True,
+        action=argparse.BooleanOptionalAction,
+        help="Automatically sets the extension based on the archive type e.g. cbr for rar, cbz for zip.\ndefault: %(default)s",
+    )
+    parser.add_setting("--dir", default="", help="The directory to move renamed files to.")
+    parser.add_setting(
+        "--move",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Enables moving renamed files to a separate directory.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "--only-move",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Ignores the filename when moving renamed files to a separate directory.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "--strict-filenames",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Ensures that filenames are valid for all OSs.\ndefault: %(default)s",
+    )
+    parser.add_setting("replacements", default=DEFAULT_REPLACEMENTS, cmdline=False)
+
+
+def autotag(parser: settngs.Manager) -> None:
+    parser.add_setting(
+        "-o",
+        "--online",
+        action="store_true",
+        help="""Search online and attempt to identify file\nusing existing tags and images in archive.\nMay be used in conjunction with -f and -m.\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--save-on-low-confidence",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Automatically save tags on low-confidence matches.\ndefault: %(default)s",
+        cmdline=False,
+    )
+    parser.add_setting(
+        "--use-year-when-identifying",
+        default=True,
+        action=argparse.BooleanOptionalAction,
+        help="Use the year metadata attribute when auto-tagging a comic.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "-1",
+        "--assume-issue-one",
+        action=argparse.BooleanOptionalAction,
+        help="Assume issue number is 1 if not found (relevant for -s).\ndefault: %(default)s\n\n",
+        default=False,
+    )
+    parser.add_setting(
+        "--ignore-leading-numbers-in-filename",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="When searching ignore leading numbers in the filename.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "-f",
+        "--parse-filename",
+        action="store_true",
+        help="""Parse the filename to get some info,\nspecifically series name, issue number,\nvolume, and publication year.\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--prefer-filename",
+        action="store_true",
+        help="""Prefer metadata parsed from the filename. CLI only.\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--id",
+        dest="issue_id",
+        type=str,
+        help="""Use the issue ID when searching online.\nOverrides all other metadata.\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "-m",
+        "--metadata",
+        default=GenericMetadata(),
+        type=parse_metadata_from_string,
+        help="""Explicitly define some metadata to be used in YAML syntax.  Use @file.yaml to read from a file.  e.g.:\n"series: Plastic Man, publisher: Quality Comics, year: "\n"series: 'Kickers, Inc.', issue: '1', year: 1986"\nIf you want to erase a tag leave the value blank.\nSome names that can be used: series, issue, issue_count, year,\npublisher, title\n\n""",
+        file=False,
+    )
+    parser.add_setting(
+        "--clear-tags",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Clears all existing tags during import, default is to merge tags.\nMay be used in conjunction with -o, -f and -m.\ndefault: %(default)s\n\n",
+    )
+    parser.add_setting(
+        "--publisher-filter",
+        default=["Panini Comics", "Abril", "Planeta DeAgostini", "Editorial Televisa", "Dino Comics"],
+        action="extend",
+        nargs="+",
+        help="When enabled, filters the listed publishers from all search results.\nEnding a publisher with a '-' removes a publisher from this list\ndefault: %(default)s\n\n",
+    )
+    parser.add_setting(
+        "--use-publisher-filter",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Enables the publisher filter.\ndefault: %(default)s",
+    )
+    parser.add_setting(
+        "-a",
+        "--auto-imprint",
+        default=False,
+        action=argparse.BooleanOptionalAction,
+        help="Enables the auto imprint functionality.\ne.g. if the publisher is set to 'vertigo' it\nwill be updated to 'DC Comics' and the imprint\nproperty will be set to 'Vertigo'.\ndefault: %(default)s\n\n",
+    )
+
+
+def parse_filter(config: settngs.Config[ct_ns]) -> settngs.Config[ct_ns]:
+    new_filter = []
+    remove = []
+    for x in config[0].Auto_Tag__publisher_filter:
+        x = x.strip()
+        if x:  # ignore empty arguments
+            if x[-1] == "-":  # this publisher needs to be removed. We remove after all publishers have been enumerated
+                remove.append(x.strip("-"))
+            else:
+                if x not in new_filter:
+                    new_filter.append(x)
+    for x in remove:  # remove publishers
+        if x in new_filter:
+            new_filter.remove(x)
+    config[0].Auto_Tag__publisher_filter = new_filter
+    return config
+
+
+def migrate_settings(config: settngs.Config[ct_ns]) -> settngs.Config[ct_ns]:
+    original_types = ("cbi", "cr", "comet")
+    write_Tags = config[0].internal__write_tags
+    if not isinstance(write_Tags, list):
+        if isinstance(write_Tags, int) and write_Tags in (0, 1, 2):
+            config[0].internal__write_tags = [original_types[write_Tags]]
+        elif isinstance(write_Tags, str):
+            config[0].internal__write_tags = [write_Tags]
+        else:
+            config[0].internal__write_tags = ["cr"]
+
+    read_tags = config[0].internal__read_tags
+    if not isinstance(read_tags, list):
+        if isinstance(read_tags, int) and read_tags in (0, 1, 2):
+            config[0].internal__read_tags = [original_types[read_tags]]
+        elif isinstance(read_tags, str):
+            config[0].internal__read_tags = [read_tags]
+        else:
+            config[0].internal__read_tags = ["cr"]
+
+    return config
+
+
+def validate_file_settings(config: settngs.Config[ct_ns]) -> settngs.Config[ct_ns]:
+    config = parse_filter(config)
+
+    config = migrate_settings(config)
+
+    if config[0].Filename_Parsing__protofolius_issue_number_scheme:
+        config[0].Filename_Parsing__allow_issue_start_with_letter = True
+
+    config[0].File_Rename__replacements = Replacements(
+        [Replacement(x[0], x[1], x[2]) for x in config[0].File_Rename__replacements[0]],
+        [Replacement(x[0], x[1], x[2]) for x in config[0].File_Rename__replacements[1]],
+    )
+    return config
+
+
+def register_file_settings(parser: settngs.Manager) -> None:
+    parser.add_group("internal", internal, False)
+    parser.add_group("Issue Identifier", identifier, False)
+    parser.add_group("Filename Parsing", filename, False)
+    parser.add_group("Sources", talker, False)
+    parser.add_group("Metadata Options", md_options, False)
+    parser.add_group("File Rename", rename, False)
+    parser.add_group("Auto-Tag", autotag, False)
+    parser.add_group("General", general, False)
+    parser.add_group("Dialog Flags", dialog, False)

comictaggerlib/ctsettings/plugin.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+
+import logging
+import os
+from typing import Any, cast
+
+import settngs
+
+import comicapi.comicarchive
+import comicapi.utils
+import comictaggerlib.ctsettings
+from comicapi.comicarchive import Archiver
+from comictaggerlib.ctsettings.settngs_namespace import SettngsNS as ct_ns
+from comictalker.comictalker import ComicTalker
+
+logger = logging.getLogger("comictagger")
+
+
+def group_for_plugin(plugin: Archiver | ComicTalker | type[Archiver]) -> str:
+    if isinstance(plugin, ComicTalker):
+        return f"Source {plugin.id}"
+    if isinstance(plugin, Archiver) or plugin == Archiver:
+        return "Archive"
+    raise NotImplementedError(f"Invalid plugin received: {plugin=}")
+
+
+def archiver(manager: settngs.Manager) -> None:
+    for archiver in comicapi.comicarchive.archivers:
+        if archiver.exe:
+            # add_setting will overwrite anything with the same name.
+            # So we only end up with one option even if multiple archivers use the same exe.
+            manager.add_setting(
+                f"--{settngs.sanitize_name(archiver.exe)}",
+                default=archiver.exe,
+                help="Path to the %(default)s executable",
+            )
+
+
+def register_talker_settings(manager: settngs.Manager, talkers: dict[str, ComicTalker]) -> None:
+    for talker in talkers.values():
+
+        def api_options(manager: settngs.Manager) -> None:
+            # The default needs to be unset or None.
+            # This allows this setting to be unset with the empty string, allowing the default to change
+            manager.add_setting(
+                f"--{talker.id}-key",
+                display_name="API Key",
+                help=f"API Key for {talker.name} (default: {talker.default_api_key})",
+            )
+            manager.add_setting(
+                f"--{talker.id}-url",
+                display_name="URL",
+                help=f"URL for {talker.name} (default: {talker.default_api_url})",
+            )
+
+        try:
+            manager.add_persistent_group(group_for_plugin(talker), api_options, False)
+            if hasattr(talker, "register_settings"):
+                manager.add_persistent_group(group_for_plugin(talker), talker.register_settings, False)
+        except Exception:
+            logger.exception("Failed to register settings for %s", talker.id)
+
+
+def validate_archive_settings(config: settngs.Config[ct_ns]) -> settngs.Config[ct_ns]:
+    cfg = settngs.normalize_config(config, file=True, cmdline=True, default=False)
+    for archiver in comicapi.comicarchive.archivers:
+        group = group_for_plugin(archiver())
+        exe_name = settngs.sanitize_name(archiver.exe)
+        if not exe_name:
+            continue
+
+        if exe_name in cfg[0][group] and cfg[0][group][exe_name]:
+            path = cfg[0][group][exe_name]
+            name = os.path.basename(path)
+            # If the path is not the basename then this is a relative or absolute path.
+            # Ensure it is absolute
+            if path != name:
+                path = os.path.abspath(path)
+
+            archiver.exe = path
+
+    return config
+
+
+def validate_talker_settings(config: settngs.Config[ct_ns], talkers: dict[str, ComicTalker]) -> settngs.Config[ct_ns]:
+    # Apply talker settings from config file
+    cfg = cast(settngs.Config[dict[str, Any]], settngs.normalize_config(config, True, True))
+    for talker in list(talkers.values()):
+        try:
+            cfg[0][group_for_plugin(talker)] = talker.parse_settings(cfg[0][group_for_plugin(talker)])
+        except Exception as e:
+            # Remove talker as we failed to apply the settings
+            del comictaggerlib.ctsettings.talkers[talker.id]
+            logger.exception("Failed to initialize talker settings: %s", e)
+
+    return cast(settngs.Config[ct_ns], settngs.get_namespace(cfg, file=True, cmdline=True))
+
+
+def validate_plugin_settings(config: settngs.Config[ct_ns], talkers: dict[str, ComicTalker]) -> settngs.Config[ct_ns]:
+    config = validate_archive_settings(config)
+    config = validate_talker_settings(config, talkers)
+    return config
+
+
+def register_plugin_settings(manager: settngs.Manager, talkers: dict[str, ComicTalker]) -> None:
+    manager.add_persistent_group("Archive", archiver, False)
+    register_talker_settings(manager, talkers)

comictaggerlib/ctsettings/plugin_finder.py

@@ -0,0 +1,186 @@
+"""Functions related to finding and loading plugins."""
+
+# Lifted from flake8 https://github.com/PyCQA/flake8/blob/main/src/flake8/plugins/finder.py#L127
+
+from __future__ import annotations
+
+import importlib.util
+import logging
+import pathlib
+import platform
+import re
+import sys
+from collections.abc import Generator, Iterable, Sequence
+from typing import Any, NamedTuple, TypeVar
+
+if sys.version_info < (3, 10):
+    import importlib_metadata
+else:
+    import importlib.metadata as importlib_metadata
+
+logger = logging.getLogger(__name__)
+
+NORMALIZE_PACKAGE_NAME_RE = re.compile(r"[-_.]+")
+PLUGIN_GROUPS = frozenset(("comictagger.talker", "comicapi.archiver", "comicapi.tags"))
+icu_available = importlib.util.find_spec("icu") is not None
+
+
+def _custom_key(tup: Any) -> Any:
+    import natsort
+
+    lst = []
+    for x in natsort.os_sort_keygen()(tup):
+        ret = x
+        if isinstance(x, Sequence) and len(x) > 1 and isinstance(x[1], int) and isinstance(x[0], str) and x[0] == "":
+            ret = ("a", *x[1:])
+
+        lst.append(ret)
+    return tuple(lst)
+
+
+T = TypeVar("T")
+
+
+def os_sorted(lst: Iterable[T]) -> Iterable[T]:
+    import natsort
+
+    key = _custom_key
+    if icu_available or platform.system() == "Windows":
+        key = natsort.os_sort_keygen()
+    return sorted(lst, key=key)
+
+
+class FailedToLoadPlugin(Exception):
+    """Exception raised when a plugin fails to load."""
+
+    FORMAT = 'ComicTagger failed to load local plugin "{name}" due to {exc}.'
+
+    def __init__(self, plugin_name: str, exception: Exception) -> None:
+        """Initialize our FailedToLoadPlugin exception."""
+        self.plugin_name = plugin_name
+        self.original_exception = exception
+        super().__init__(plugin_name, exception)
+
+    def __str__(self) -> str:
+        """Format our exception message."""
+        return self.FORMAT.format(
+            name=self.plugin_name,
+            exc=self.original_exception,
+        )
+
+
+def normalize_pypi_name(s: str) -> str:
+    """Normalize a distribution name according to PEP 503."""
+    return NORMALIZE_PACKAGE_NAME_RE.sub("-", s).lower()
+
+
+class Plugin(NamedTuple):
+    """A plugin before loading."""
+
+    package: str
+    version: str
+    entry_point: importlib_metadata.EntryPoint
+    path: pathlib.Path
+
+    def load(self) -> LoadedPlugin:
+        return LoadedPlugin(self, self.entry_point.load())
+
+
+class LoadedPlugin(NamedTuple):
+    """Represents a plugin after being imported."""
+
+    plugin: Plugin
+    obj: Any
+
+    @property
+    def entry_name(self) -> str:
+        """Return the name given in the packaging metadata."""
+        return self.plugin.entry_point.name
+
+    @property
+    def display_name(self) -> str:
+        """Return the name for use in user-facing / error messages."""
+        return f"{self.plugin.package}[{self.entry_name}]"
+
+
+class Plugins(NamedTuple):
+    """Classified plugins."""
+
+    archivers: list[LoadedPlugin]
+    tags: list[LoadedPlugin]
+    talkers: list[LoadedPlugin]
+
+    def all_plugins(self) -> Generator[LoadedPlugin]:
+        """Return an iterator over all :class:`LoadedPlugin`s."""
+        yield from self.archivers
+        yield from self.tags
+        yield from self.talkers
+
+    def versions_str(self) -> str:
+        """Return a user-displayed list of plugin versions."""
+        return ", ".join(sorted({f"{plugin.plugin.package}: {plugin.plugin.version}" for plugin in self.all_plugins()}))
+
+
+def _find_local_plugins(plugin_path: pathlib.Path) -> Generator[Plugin]:
+    logger.debug("Checking for distributions in %s", plugin_path)
+    for dist in importlib_metadata.distributions(path=[str(plugin_path)]):
+        logger.debug("found distribution %s", dist.name)
+        eps = dist.entry_points
+        for group in PLUGIN_GROUPS:
+            for ep in eps.select(group=group):
+                logger.debug("found EntryPoint group %s %s=%s", group, ep.name, ep.value)
+                yield Plugin(plugin_path.name, dist.version, ep, plugin_path)
+
+
+def find_plugins(plugin_folder: pathlib.Path) -> Plugins:
+    """Discovers all plugins (but does not load them)."""
+    ret: list[LoadedPlugin] = []
+    if not plugin_folder.is_dir():
+        return _classify_plugins(ret)
+
+    zips = [x for x in plugin_folder.iterdir() if x.is_file() and x.suffix in (".zip", ".whl")]
+
+    for plugin_path in os_sorted(zips):
+        logger.debug("looking for plugins in %s", plugin_path)
+        sys_path = sys.path.copy()
+        try:
+            sys.path.append(str(plugin_path))
+            for plugin in _find_local_plugins(plugin_path):
+                logger.debug("Attempting to load %s from %s", plugin.entry_point.name, plugin.path)
+                ret.append(plugin.load())
+        except Exception as err:
+            logger.exception(FailedToLoadPlugin(plugin_path.name, err))
+        finally:
+            sys.path = sys_path
+            for mod in list(sys.modules.values()):
+                if (
+                    mod is not None
+                    and hasattr(mod, "__spec__")
+                    and mod.__spec__
+                    and str(plugin_path) in (mod.__spec__.origin or "")
+                ):
+                    sys.modules.pop(mod.__name__)
+
+    return _classify_plugins(ret)
+
+
+def _classify_plugins(plugins: list[LoadedPlugin]) -> Plugins:
+    archivers = []
+    tags = []
+    talkers = []
+
+    for p in plugins:
+        if p.plugin.entry_point.group == "comictagger.talker":
+            talkers.append(p)
+        elif p.plugin.entry_point.group == "comicapi.tags":
+            tags.append(p)
+        elif p.plugin.entry_point.group == "comicapi.archiver":
+            archivers.append(p)
+        else:
+            logger.warning(NotImplementedError(f"what plugin type? {p}"))
+
+    return Plugins(
+        tags=tags,
+        archivers=archivers,
+        talkers=talkers,
+    )

comictaggerlib/ctsettings/settngs_namespace.py

@@ -0,0 +1,304 @@
+from __future__ import annotations
+
+import typing
+
+import settngs
+import urllib3.util.url
+
+import comicapi.genericmetadata
+import comicapi.merge
+import comicapi.utils
+import comictaggerlib.ctsettings.types
+import comictaggerlib.defaults
+import comictaggerlib.resulttypes
+
+
+class SettngsNS(settngs.TypedNS):
+    Commands__version: bool
+    Commands__command: comictaggerlib.resulttypes.Action
+    Commands__copy: list[str]
+
+    Runtime_Options__config: comictaggerlib.ctsettings.types.ComicTaggerPaths
+    Runtime_Options__verbose: int
+    Runtime_Options__enable_quick_tag: bool
+    Runtime_Options__enable_embedding_hashes: bool
+    Runtime_Options__preferred_hash: str
+    Runtime_Options__quiet: bool
+    Runtime_Options__json: bool
+    Runtime_Options__raw: bool
+    Runtime_Options__interactive: bool
+    Runtime_Options__abort_on_low_confidence: bool
+    Runtime_Options__dryrun: bool
+    Runtime_Options__summary: bool
+    Runtime_Options__recursive: bool
+    Runtime_Options__glob: bool
+    Runtime_Options__darkmode: bool
+    Runtime_Options__no_gui: bool
+    Runtime_Options__abort_on_conflict: bool
+    Runtime_Options__delete_original: bool
+    Runtime_Options__tags_read: list[str]
+    Runtime_Options__tags_write: list[str]
+    Runtime_Options__skip_existing_tags: bool
+    Runtime_Options__files: list[str]
+
+    Quick_Tag__url: urllib3.util.url.Url
+    Quick_Tag__max: int
+    Quick_Tag__aggressive_filtering: bool
+    Quick_Tag__hash: list[comictaggerlib.quick_tag.HashType]
+    Quick_Tag__exact_only: bool
+
+    internal__install_id: str
+    internal__embedded_hash_type: str
+    internal__write_tags: list[str]
+    internal__read_tags: list[str]
+    internal__last_opened_folder: str
+    internal__window_width: int
+    internal__window_height: int
+    internal__window_x: int
+    internal__window_y: int
+    internal__form_width: int
+    internal__list_width: int
+    internal__sort_column: int
+    internal__sort_direction: int
+    internal__remove_archive_after_successful_match: bool
+
+    Issue_Identifier__series_match_identify_thresh: int
+    Issue_Identifier__series_match_search_thresh: int
+    Issue_Identifier__border_crop_percent: int
+    Issue_Identifier__sort_series_by_year: bool
+    Issue_Identifier__exact_series_matches_first: bool
+
+    Filename_Parsing__filename_parser: comicapi.utils.Parser
+    Filename_Parsing__remove_c2c: bool
+    Filename_Parsing__remove_fcbd: bool
+    Filename_Parsing__remove_publisher: bool
+    Filename_Parsing__split_words: bool
+    Filename_Parsing__protofolius_issue_number_scheme: bool
+    Filename_Parsing__allow_issue_start_with_letter: bool
+
+    Sources__source: str
+
+    Metadata_Options__assume_lone_credit_is_primary: bool
+    Metadata_Options__copy_characters_to_tags: bool
+    Metadata_Options__copy_teams_to_tags: bool
+    Metadata_Options__copy_locations_to_tags: bool
+    Metadata_Options__copy_storyarcs_to_tags: bool
+    Metadata_Options__copy_notes_to_comments: bool
+    Metadata_Options__copy_weblink_to_comments: bool
+    Metadata_Options__apply_transform_on_import: bool
+    Metadata_Options__apply_transform_on_bulk_operation: bool
+    Metadata_Options__remove_html_tables: bool
+    Metadata_Options__use_short_tag_names: bool
+    Metadata_Options__cr: bool
+    Metadata_Options__tag_merge: comicapi.merge.Mode
+    Metadata_Options__metadata_merge: comicapi.merge.Mode
+    Metadata_Options__tag_merge_lists: bool
+    Metadata_Options__metadata_merge_lists: bool
+
+    File_Rename__template: str
+    File_Rename__issue_number_padding: int
+    File_Rename__use_smart_string_cleanup: bool
+    File_Rename__auto_extension: bool
+    File_Rename__dir: str
+    File_Rename__move: bool
+    File_Rename__only_move: bool
+    File_Rename__strict_filenames: bool
+    File_Rename__replacements: comictaggerlib.defaults.Replacements
+
+    Auto_Tag__online: bool
+    Auto_Tag__save_on_low_confidence: bool
+    Auto_Tag__use_year_when_identifying: bool
+    Auto_Tag__assume_issue_one: bool
+    Auto_Tag__ignore_leading_numbers_in_filename: bool
+    Auto_Tag__parse_filename: bool
+    Auto_Tag__prefer_filename: bool
+    Auto_Tag__issue_id: str | None
+    Auto_Tag__metadata: comicapi.genericmetadata.GenericMetadata
+    Auto_Tag__clear_tags: bool
+    Auto_Tag__publisher_filter: list[str]
+    Auto_Tag__use_publisher_filter: bool
+    Auto_Tag__auto_imprint: bool
+
+    General__check_for_new_version: bool
+    General__blur: bool
+    General__prompt_on_save: bool
+
+    Dialog_Flags__show_disclaimer: bool
+    Dialog_Flags__dont_notify_about_this_version: str
+    Dialog_Flags__notify_plugin_changes: bool
+
+    Archive__rar: str
+
+    Source_comicvine__comicvine_key: str | None
+    Source_comicvine__comicvine_url: str | None
+    Source_comicvine__cv_use_series_start_as_volume: bool
+    Source_comicvine__comicvine_custom_parameters: str | None
+
+
+class Commands(typing.TypedDict):
+    version: bool
+    command: comictaggerlib.resulttypes.Action
+    copy: list[str]
+
+
+class Runtime_Options(typing.TypedDict):
+    config: comictaggerlib.ctsettings.types.ComicTaggerPaths
+    verbose: int
+    enable_quick_tag: bool
+    enable_embedding_hashes: bool
+    preferred_hash: str
+    quiet: bool
+    json: bool
+    raw: bool
+    interactive: bool
+    abort_on_low_confidence: bool
+    dryrun: bool
+    summary: bool
+    recursive: bool
+    glob: bool
+    darkmode: bool
+    no_gui: bool
+    abort_on_conflict: bool
+    delete_original: bool
+    tags_read: list[str]
+    tags_write: list[str]
+    skip_existing_tags: bool
+    files: list[str]
+
+
+class Quick_Tag(typing.TypedDict):
+    url: urllib3.util.url.Url
+    max: int
+    aggressive_filtering: bool
+    hash: list[comictaggerlib.quick_tag.HashType]
+    exact_only: bool
+
+
+class internal(typing.TypedDict):
+    install_id: str
+    embedded_hash_type: str
+    write_tags: list[str]
+    read_tags: list[str]
+    last_opened_folder: str
+    window_width: int
+    window_height: int
+    window_x: int
+    window_y: int
+    form_width: int
+    list_width: int
+    sort_column: int
+    sort_direction: int
+    remove_archive_after_successful_match: bool
+
+
+class Issue_Identifier(typing.TypedDict):
+    series_match_identify_thresh: int
+    series_match_search_thresh: int
+    border_crop_percent: int
+    sort_series_by_year: bool
+    exact_series_matches_first: bool
+
+
+class Filename_Parsing(typing.TypedDict):
+    filename_parser: comicapi.utils.Parser
+    remove_c2c: bool
+    remove_fcbd: bool
+    remove_publisher: bool
+    split_words: bool
+    protofolius_issue_number_scheme: bool
+    allow_issue_start_with_letter: bool
+
+
+class Sources(typing.TypedDict):
+    source: str
+
+
+class Metadata_Options(typing.TypedDict):
+    assume_lone_credit_is_primary: bool
+    copy_characters_to_tags: bool
+    copy_teams_to_tags: bool
+    copy_locations_to_tags: bool
+    copy_storyarcs_to_tags: bool
+    copy_notes_to_comments: bool
+    copy_weblink_to_comments: bool
+    apply_transform_on_import: bool
+    apply_transform_on_bulk_operation: bool
+    remove_html_tables: bool
+    use_short_tag_names: bool
+    cr: bool
+    tag_merge: comicapi.merge.Mode
+    metadata_merge: comicapi.merge.Mode
+    tag_merge_lists: bool
+    metadata_merge_lists: bool
+
+
+class File_Rename(typing.TypedDict):
+    template: str
+    issue_number_padding: int
+    use_smart_string_cleanup: bool
+    auto_extension: bool
+    dir: str
+    move: bool
+    only_move: bool
+    strict_filenames: bool
+    replacements: comictaggerlib.defaults.Replacements
+
+
+class Auto_Tag(typing.TypedDict):
+    online: bool
+    save_on_low_confidence: bool
+    use_year_when_identifying: bool
+    assume_issue_one: bool
+    ignore_leading_numbers_in_filename: bool
+    parse_filename: bool
+    prefer_filename: bool
+    issue_id: str | None
+    metadata: comicapi.genericmetadata.GenericMetadata
+    clear_tags: bool
+    publisher_filter: list[str]
+    use_publisher_filter: bool
+    auto_imprint: bool
+
+
+class General(typing.TypedDict):
+    check_for_new_version: bool
+    blur: bool
+    prompt_on_save: bool
+
+
+class Dialog_Flags(typing.TypedDict):
+    show_disclaimer: bool
+    dont_notify_about_this_version: str
+    notify_plugin_changes: bool
+
+
+class Archive(typing.TypedDict):
+    rar: str
+
+
+class Source_comicvine(typing.TypedDict):
+    comicvine_key: str | None
+    comicvine_url: str | None
+    cv_use_series_start_as_volume: bool
+    comicvine_custom_parameters: str | None
+
+
+SettngsDict = typing.TypedDict(
+    "SettngsDict",
+    {
+        "Commands": Commands,
+        "Runtime Options": Runtime_Options,
+        "Quick Tag": Quick_Tag,
+        "internal": internal,
+        "Issue Identifier": Issue_Identifier,
+        "Filename Parsing": Filename_Parsing,
+        "Sources": Sources,
+        "Metadata Options": Metadata_Options,
+        "File Rename": File_Rename,
+        "Auto-Tag": Auto_Tag,
+        "General": General,
+        "Dialog Flags": Dialog_Flags,
+        "Archive": Archive,
+        "Source comicvine": Source_comicvine,
+    },
+)

comictaggerlib/ctsettings/types.py

@@ -0,0 +1,248 @@
+from __future__ import annotations
+
+import argparse
+import logging
+import pathlib
+import sys
+import types
+import typing
+from collections.abc import Collection, Mapping
+from typing import Any
+
+import yaml
+from appdirs import AppDirs
+
+from comicapi import utils
+from comicapi.comicarchive import tags
+from comicapi.genericmetadata import REMOVE, GenericMetadata
+
+logger = logging.getLogger(__name__)
+
+if sys.version_info < (3, 10):
+
+    @typing.no_type_check
+    def get_type_hints(obj, globalns=None, localns=None, include_extras=False):
+        if getattr(obj, "__no_type_check__", None):
+            return {}
+        # Classes require a special treatment.
+        if isinstance(obj, type):
+            hints = {}
+            for base in reversed(obj.__mro__):
+                if globalns is None:
+                    base_globals = getattr(sys.modules.get(base.__module__, None), "__dict__", {})
+                else:
+                    base_globals = globalns
+                ann = base.__dict__.get("__annotations__", {})
+                if isinstance(ann, types.GetSetDescriptorType):
+                    ann = {}
+                base_locals = dict(vars(base)) if localns is None else localns
+                if localns is None and globalns is None:
+                    # This is surprising, but required.  Before Python 3.10,
+                    # get_type_hints only evaluated the globalns of
+                    # a class.  To maintain backwards compatibility, we reverse
+                    # the globalns and localns order so that eval() looks into
+                    # *base_globals* first rather than *base_locals*.
+                    # This only affects ForwardRefs.
+                    base_globals, base_locals = base_locals, base_globals
+                for name, value in ann.items():
+                    if value is None:
+                        value = type(None)
+                    if isinstance(value, str):
+                        if "|" in value:
+                            value = "Union[" + value.replace(" |", ",") + "]"
+                        value = typing.ForwardRef(value, is_argument=False, is_class=True)
+                    value = typing._eval_type(value, base_globals, base_locals)
+                    hints[name] = value
+            return hints if include_extras else {k: typing._strip_annotations(t) for k, t in hints.items()}
+
+        if globalns is None:
+            if isinstance(obj, types.ModuleType):
+                globalns = obj.__dict__
+            else:
+                nsobj = obj
+                # Find globalns for the unwrapped object.
+                while hasattr(nsobj, "__wrapped__"):
+                    nsobj = nsobj.__wrapped__
+                globalns = getattr(nsobj, "__globals__", {})
+            if localns is None:
+                localns = globalns
+        elif localns is None:
+            localns = globalns
+        hints = getattr(obj, "__annotations__", None)
+        if hints is None:
+            # Return empty annotations for something that _could_ have them.
+            if isinstance(obj, typing._allowed_types):
+                return {}
+            else:
+                raise TypeError("{!r} is not a module, class, method, " "or function.".format(obj))
+        hints = dict(hints)
+        for name, value in hints.items():
+            if value is None:
+                value = type(None)
+            if isinstance(value, str):
+                if "|" in value:
+                    value = "Union[" + value.replace(" |", ",") + "]"
+                # class-level forward refs were handled above, this must be either
+                # a module-level annotation or a function argument annotation
+                value = typing.ForwardRef(
+                    value,
+                    is_argument=not isinstance(obj, types.ModuleType),
+                    is_class=False,
+                )
+            hints[name] = typing._eval_type(value, globalns, localns)
+        return hints if include_extras else {k: typing._strip_annotations(t) for k, t in hints.items()}
+
+else:
+    from typing import get_type_hints
+
+
+class ComicTaggerPaths(AppDirs):
+    def __init__(self, config_path: pathlib.Path | str | None = None) -> None:
+        super().__init__("ComicTagger", None, None, False, False)
+        self.path: pathlib.Path | None = None
+        if config_path:
+            self.path = pathlib.Path(config_path).absolute()
+
+    @property
+    def user_data_dir(self) -> pathlib.Path:
+        if self.path:
+            return self.path
+        return pathlib.Path(super().user_data_dir)
+
+    @property
+    def user_config_dir(self) -> pathlib.Path:
+        if self.path:
+            return self.path
+        return pathlib.Path(super().user_config_dir)
+
+    @property
+    def user_cache_dir(self) -> pathlib.Path:
+        if self.path:
+            return self.path / "cache"
+        return pathlib.Path(super().user_cache_dir)
+
+    @property
+    def user_state_dir(self) -> pathlib.Path:
+        if self.path:
+            return self.path
+        return pathlib.Path(super().user_state_dir)
+
+    @property
+    def user_log_dir(self) -> pathlib.Path:
+        if self.path:
+            return self.path / "log"
+        return pathlib.Path(super().user_log_dir)
+
+    @property
+    def user_plugin_dir(self) -> pathlib.Path:
+        if self.path:
+            return self.path / "plugins"
+        return pathlib.Path(super().user_config_dir) / "plugins"
+
+    @property
+    def site_data_dir(self) -> pathlib.Path:
+        return pathlib.Path(super().site_data_dir)
+
+    @property
+    def site_config_dir(self) -> pathlib.Path:
+        return pathlib.Path(super().site_config_dir)
+
+    def __str__(self) -> str:
+        return f"logs: {self.user_log_dir}, config: {self.user_config_dir}, cache: {self.user_cache_dir}"
+
+
+def tag(types: str) -> list[str]:
+    enabled_tags = [tag for tag in tags if tags[tag].enabled]
+    result = []
+    types = types.casefold()
+    for typ in utils.split(types, ","):
+        if typ not in enabled_tags:
+            choices = ", ".join(enabled_tags)
+            raise argparse.ArgumentTypeError(f"invalid choice: {typ} (choose from {choices.upper()})")
+        result.append(tags[typ].id)
+    return result
+
+
+def parse_metadata_from_string(mdstr: str) -> GenericMetadata:
+
+    def get_type(key: str, tt: Any = get_type_hints(GenericMetadata)) -> Any:
+        t: Any = tt.get(key, None)
+        if t is None:
+            return None
+        if getattr(t, "__origin__", None) is typing.Union and len(t.__args__) == 2 and t.__args__[1] is type(None):
+            t = t.__args__[0]
+        elif isinstance(t, types.GenericAlias) and issubclass(t.mro()[0], Collection):
+            t = t.mro()[0], t.__args__[0]
+
+        if isinstance(t, tuple) and issubclass(t[1], dict):
+            return (t[0], dict)
+        if isinstance(t, type) and issubclass(t, dict):
+            return dict
+        return t
+
+    def convert_value(t: type, value: Any) -> Any:
+        if isinstance(value, t):
+            return value
+        try:
+            if isinstance(value, (Mapping)):
+                value = t(**value)
+            elif not isinstance(value, str) and isinstance(value, (Collection)):
+                value = t(*value)
+            else:
+                if t is utils.Url and isinstance(value, str):
+                    value = utils.parse_url(value)
+                else:
+                    value = t(value)
+        except (ValueError, TypeError):
+            raise argparse.ArgumentTypeError(f"Invalid syntax for tag {key!r}: {value!r}")
+        return value
+
+    md = GenericMetadata()
+
+    try:
+        if not mdstr:
+            return md
+        if mdstr[0] == "@":
+            p = pathlib.Path(mdstr[1:])
+            if not p.is_file():
+                raise argparse.ArgumentTypeError("Invalid filepath")
+            mdstr = p.read_text()
+        if mdstr[0] != "{":
+            mdstr = "{" + mdstr + "}"
+
+        md_dict = yaml.safe_load(mdstr)
+
+        empty = True
+        # Map the dict to the metadata object
+        for key, value in md_dict.items():
+            if hasattr(md, key):
+                t = get_type(key)
+                if value is None:
+                    value = REMOVE
+                elif isinstance(t, tuple):
+                    if value == "":
+                        value = t[0]()
+                    else:
+                        if isinstance(value, str):
+                            value = [value]
+                        if not isinstance(value, Collection):
+                            raise argparse.ArgumentTypeError(f"Invalid syntax for tag '{key}'")
+                        values = list(value)
+                        for idx, v in enumerate(values):
+                            if not isinstance(v, t[1]):
+                                values[idx] = convert_value(t[1], v)
+                        value = t[0](values)
+                else:
+                    value = convert_value(t, value)
+
+                empty = False
+                setattr(md, key, value)
+            else:
+                raise argparse.ArgumentTypeError(f"'{key}' is not a valid tag name")
+        md.is_empty = empty
+    except argparse.ArgumentTypeError as e:
+        raise e
+    except Exception as e:
+        logger.exception("Unable to read metadata from the commandline '%s'", mdstr)
+        raise Exception("Unable to read metadata from the commandline") from e
+    return md

comictaggerlib/defaults.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from typing import NamedTuple
+
+
+class Replacement(NamedTuple):
+    find: str
+    replce: str
+    strict_only: bool
+
+
+class Replacements(NamedTuple):
+    literal_text: list[Replacement]
+    format_value: list[Replacement]
+
+
+DEFAULT_REPLACEMENTS = Replacements(
+    literal_text=[
+        Replacement(": ", " - ", True),
+        Replacement(":", "-", True),
+    ],
+    format_value=[
+        Replacement(": ", " - ", True),
+        Replacement(":", "-", True),
+        Replacement("/", "-", False),
+        Replacement("//", "--", False),
+        Replacement("\\", "-", True),
+    ],
+)

comictaggerlib/exportwindow.py

@@ -0,0 +1,62 @@
+"""A PyQT4 dialog to confirm and set options for export to zip"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+
+from PyQt6 import QtCore, QtWidgets, uic
+
+from comictaggerlib.ui import ui_path
+
+logger = logging.getLogger(__name__)
+
+
+class ExportConflictOpts:
+    dontCreate = 1
+    overwrite = 2
+    createUnique = 3
+
+
+class ExportWindow(QtWidgets.QDialog):
+    def __init__(self, parent: QtWidgets.QWidget, msg: str) -> None:
+        super().__init__(parent)
+
+        with (ui_path / "exportwindow.ui").open(encoding="utf-8") as uifile:
+            uic.loadUi(uifile, self)
+        self.label.setText(msg)
+
+        self.setWindowFlags(
+            QtCore.Qt.WindowType(self.windowFlags() & ~QtCore.Qt.WindowType.WindowContextHelpButtonHint)
+        )
+
+        self.cbxDeleteOriginal.setChecked(False)
+        self.cbxAddToList.setChecked(True)
+        self.radioDontCreate.setChecked(True)
+
+        self.deleteOriginal = False
+        self.addToList = True
+        self.fileConflictBehavior = ExportConflictOpts.dontCreate
+
+    def accept(self) -> None:
+        QtWidgets.QDialog.accept(self)
+
+        self.deleteOriginal = self.cbxDeleteOriginal.isChecked()
+        self.addToList = self.cbxAddToList.isChecked()
+        if self.radioDontCreate.isChecked():
+            self.fileConflictBehavior = ExportConflictOpts.dontCreate
+        elif self.radioCreateNew.isChecked():
+            self.fileConflictBehavior = ExportConflictOpts.createUnique

comictaggerlib/filerenamer.py

@@ -0,0 +1,325 @@
+"""Functions for renaming files based on metadata"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import calendar
+import datetime
+import logging
+import os
+import pathlib
+import string
+from collections.abc import Collection, Iterable, Mapping, Sequence, Sized
+from typing import Any, cast
+
+from pathvalidate import Platform, normalize_platform, sanitize_filename
+
+from comicapi.comicarchive import ComicArchive
+from comicapi.genericmetadata import GenericMetadata
+from comicapi.issuestring import IssueString
+from comictaggerlib.defaults import DEFAULT_REPLACEMENTS, Replacement, Replacements
+
+logger = logging.getLogger(__name__)
+
+
+def get_rename_dir(ca: ComicArchive, rename_dir: str | pathlib.Path | None) -> pathlib.Path:
+    folder = ca.path.parent.absolute()
+    if rename_dir is not None:
+        if isinstance(rename_dir, str):
+            rename_dir = pathlib.Path(rename_dir.strip())
+        folder = rename_dir.absolute()
+    return folder
+
+
+def _isnamedtupleinstance(x: Any) -> bool:  # pragma: no cover
+    t = type(x)
+    b = t.__bases__
+
+    if len(b) != 1 or b[0] != tuple:
+        return False
+
+    f = getattr(t, "_fields", None)
+    if not isinstance(f, tuple):
+        return False
+
+    return all(isinstance(n, str) for n in f)
+
+
+class MetadataFormatter(string.Formatter):
+    def __init__(
+        self, smart_cleanup: bool = False, platform: str = "auto", replacements: Replacements = DEFAULT_REPLACEMENTS
+    ) -> None:
+        super().__init__()
+        self.smart_cleanup = smart_cleanup
+        self.platform = normalize_platform(platform)
+        self.replacements = replacements
+
+    def format_field(self, value: Any, format_spec: str) -> str:
+        if value is None or value == "":
+            return ""
+        return cast(str, super().format_field(value, format_spec))
+
+    def convert_field(self, value: Any, conversion: str | None) -> str:
+        if value is None:
+            return ""
+        if isinstance(value, Iterable) and not isinstance(value, (str, tuple)):
+            if conversion == "C":
+                if isinstance(value, Sized):
+                    return str(len(value))
+                return ""
+            if conversion and conversion.isdecimal():
+                if not isinstance(value, Collection):
+                    return ""
+                i = int(conversion) - 1
+                if i < 0:
+                    i = 0
+                if i < len(value):
+                    try:
+                        return sorted(value)[i]
+                    except Exception:
+                        ...
+                    return list(value)[i]
+                return ""
+            if conversion == "j":
+                conversion = "s"
+            try:
+                return ", ".join(list(self.convert_field(v, conversion) for v in sorted(value) if v is not None))
+            except Exception:
+                ...
+            return ", ".join(list(self.convert_field(v, conversion) for v in value if v is not None))
+        if not conversion:
+            return cast(str, super().convert_field(value, conversion))
+        if conversion == "u":
+            return str(value).upper()
+        if conversion == "l":
+            return str(value).casefold()
+        if conversion == "c":
+            return str(value).capitalize()
+        if conversion == "S":
+            return str(value).swapcase()
+        if conversion == "t":
+            return str(value).title()
+        if conversion.isdecimal():
+            return ""
+        return cast(str, super().convert_field(value, conversion))
+
+    def handle_replacements(self, string: str, replacements: list[Replacement]) -> str:
+        for find, replace, strict_only in replacements:
+            if self.is_strict() or not strict_only:
+                string = string.replace(find, replace)
+        return string
+
+    def none_replacement(self, value: Any, replacement: str, r: str) -> Any:
+        if r == "-" and value is None or value == "":
+            return replacement
+        if r == "+" and value is not None:
+            return replacement
+        return value
+
+    def split_replacement(self, field_name: str) -> tuple[str, str, str]:
+        if "-" in field_name:
+            return field_name.rpartition("-")
+        if "+" in field_name:
+            return field_name.rpartition("+")
+        return field_name, "", ""
+
+    def is_strict(self) -> bool:
+        return self.platform in [Platform.UNIVERSAL, Platform.WINDOWS]
+
+    def _vformat(
+        self,
+        format_string: str,
+        args: Sequence[Any],
+        kwargs: Mapping[str, Any],
+        used_args: set[Any],
+        recursion_depth: int,
+        auto_arg_index: int = 0,
+    ) -> tuple[str, int]:
+        if recursion_depth < 0:
+            raise ValueError("Max string recursion exceeded")
+        result = []
+        lstrip = False
+        for literal_text, field_name, format_spec, conversion in self.parse(format_string):
+            # output the literal text
+            if literal_text:
+                if lstrip:
+                    literal_text = literal_text.lstrip("-_)}]#")
+                if self.smart_cleanup:
+                    literal_text = self.handle_replacements(literal_text, self.replacements.literal_text)
+                    lspace = literal_text[0].isspace() if literal_text else False
+                    rspace = literal_text[-1].isspace() if literal_text else False
+                    literal_text = " ".join(literal_text.split())
+                    if literal_text == "":
+                        literal_text = " "
+                    else:
+                        if lspace:
+                            literal_text = " " + literal_text
+                        if rspace:
+                            literal_text += " "
+                result.append(literal_text)
+
+            lstrip = False
+            # if there's a field, output it
+            if field_name is not None and field_name != "":
+                field_name, r, replacement = self.split_replacement(field_name)
+                field_name = field_name.casefold()
+                # this is some markup, find the object and do the formatting
+
+                # handle arg indexing when digit field_names are given.
+                if field_name.isdigit():
+                    raise ValueError("cannot use a number as a field name")
+
+                # given the field_name, find the object it references
+                #  and the argument it came from
+                try:
+                    obj, arg_used = self.get_field(field_name, args, kwargs)
+                    used_args.add(arg_used)
+                except Exception:
+                    obj = None
+
+                obj = self.none_replacement(obj, replacement, r)
+                # do any conversion on the resulting object
+                obj = self.convert_field(obj, conversion)
+                if r == "-":
+                    obj = self.none_replacement(obj, replacement, r)
+
+                # expand the format spec, if needed
+                format_spec, _ = self._vformat(
+                    cast(str, format_spec), args, kwargs, used_args, recursion_depth - 1, auto_arg_index=False
+                )
+
+                # format the object and append to the result
+                fmt_obj = self.format_field(obj, format_spec)
+                if fmt_obj == "" and result and self.smart_cleanup and literal_text:
+                    if self.str_contains(result[-1], "({["):
+                        lstrip = True
+                    if result:
+                        if " " in result[-1]:
+                            result[-1], _, _ = result[-1].rstrip().rpartition(" ")
+                        result[-1] = result[-1].rstrip("-_({[#")
+                if self.smart_cleanup:
+                    # colons and slashes get special treatment
+                    fmt_obj = self.handle_replacements(fmt_obj, self.replacements.format_value)
+                    fmt_obj = " ".join(fmt_obj.split())
+                    fmt_obj = str(sanitize_filename(fmt_obj, platform=self.platform))
+                result.append(fmt_obj)
+
+        return "".join(result), False
+
+    def str_contains(self, chars: str, string: str) -> bool:
+        for char in chars:
+            if char in string:
+                return True
+        return False
+
+
+class FileRenamer:
+    def __init__(
+        self,
+        metadata: GenericMetadata | None,
+        platform: str = "auto",
+        replacements: Replacements = DEFAULT_REPLACEMENTS,
+    ) -> None:
+        self.template = "{publisher}/{series}/{series} v{volume} #{issue} (of {issue_count}) ({year})"
+        self.smart_cleanup = True
+        self.issue_zero_padding = 3
+        self.metadata = metadata or GenericMetadata()
+        self.move = False
+        self.platform = platform
+        self.replacements = replacements
+        self.original_name = ""
+        self.move_only = False
+
+    def set_metadata(self, metadata: GenericMetadata, original_name: str) -> None:
+        self.metadata = metadata
+        self.original_name = original_name
+
+    def set_issue_zero_padding(self, count: int) -> None:
+        self.issue_zero_padding = count
+
+    def set_smart_cleanup(self, on: bool) -> None:
+        self.smart_cleanup = on
+
+    def set_template(self, template: str) -> None:
+        self.template = template
+
+    def determine_name(self, ext: str) -> str:
+        class Default(dict[str, Any]):
+            def __missing__(self, key: str) -> str:
+                return "{" + key + "}"
+
+        md = self.metadata
+
+        template = self.template
+
+        new_name = ""
+
+        fmt = MetadataFormatter(self.smart_cleanup, platform=self.platform, replacements=self.replacements)
+        md_dict = vars(md)
+        md_dict.update(
+            dict(
+                month_name=None,
+                month_abbr=None,
+                date=None,
+                genre=None,
+                story_arc=None,
+                series_group=None,
+                web_link=None,
+                character=None,
+                team=None,
+                location=None,
+            )
+        )
+
+        md_dict["issue"] = IssueString(md.issue).as_string(pad=self.issue_zero_padding)
+        for role in ["writer", "penciller", "inker", "colorist", "letterer", "cover artist", "editor", "translator"]:
+            md_dict[role] = md.get_primary_credit(role)
+
+        if (isinstance(md.month, int) or isinstance(md.month, str) and md.month.isdigit()) and 0 < int(md.month) < 13:
+            md_dict["month_name"] = calendar.month_name[int(md.month)]
+            md_dict["month_abbr"] = calendar.month_abbr[int(md.month)]
+
+        if md.year is not None and datetime.MINYEAR <= md.year <= datetime.MAXYEAR:
+            md_dict["date"] = datetime.datetime(year=md.year, month=md.month or 1, day=md.day or 1)
+
+        if md.genres:
+            md_dict["genre"] = sorted(md.genres)[0]
+        if md.story_arcs:
+            md_dict["story_arc"] = md.story_arcs[0]
+        if md.series_groups:
+            md_dict["series_group"] = md.series_groups[0]
+        if md.web_links:
+            md_dict["web_link"] = md.web_links[0]
+        if md.characters:
+            md_dict["character"] = sorted(md.characters)[0]
+        if md.teams:
+            md_dict["team"] = sorted(md.teams)[0]
+        if md.locations:
+            md_dict["location"] = sorted(md.locations)[0]
+
+        new_basename = ""
+        for component in pathlib.PureWindowsPath(template).parts:
+            new_basename = str(
+                sanitize_filename(fmt.vformat(component, args=[], kwargs=Default(md_dict)), platform=self.platform)
+            ).strip()
+            new_name = os.path.join(new_name, new_basename)
+
+        if self.move_only:
+            new_folder = os.path.join(new_name, os.path.splitext(self.original_name)[0])
+            return new_folder + ext
+        if self.move:
+            return new_name.strip() + ext
+        return new_basename.strip() + ext

comictaggerlib/fileselectionlist.py

@@ -0,0 +1,418 @@
+"""A PyQt6 widget for managing list of comic archive files"""
+
+#
+# Copyright 2012-2014 ComicTagger Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import annotations
+
+import logging
+import os
+import pathlib
+import platform
+from typing import Callable, cast
+
+from PyQt6 import QtCore, QtGui, QtWidgets, uic
+
+from comicapi import utils
+from comicapi.comicarchive import ComicArchive
+from comictaggerlib.ctsettings import ct_ns
+from comictaggerlib.graphics import graphics_path
+from comictaggerlib.optionalmsgdialog import OptionalMessageDialog
+from comictaggerlib.settingswindow import linuxRarHelp, macRarHelp, windowsRarHelp
+from comictaggerlib.ui import ui_path
+from comictaggerlib.ui.qtutils import center_window_on_parent
+
+logger = logging.getLogger(__name__)
+
+
+class FileSelectionList(QtWidgets.QWidget):
+    selectionChanged = QtCore.pyqtSignal(QtCore.QVariant)
+    listCleared = QtCore.pyqtSignal()
+
+    fileColNum = 0
+    MDFlagColNum = 1
+    typeColNum = 2
+    readonlyColNum = 3
+    folderColNum = 4
+    dataColNum = fileColNum
+
+    def __init__(
+        self, parent: QtWidgets.QWidget, config: ct_ns, dirty_flag_verification: Callable[[str, str], bool]
+    ) -> None:
+        super().__init__(parent)
+
+        with (ui_path / "fileselectionlist.ui").open(encoding="utf-8") as uifile:
+            uic.loadUi(uifile, self)
+
+        self.config = config
+
+        self.twList.horizontalHeader().setMinimumSectionSize(50)
+        self.twList.currentItemChanged.connect(self.current_item_changed_cb)
+
+        self.currentItem = None
+        self.setContextMenuPolicy(QtCore.Qt.ContextMenuPolicy.ActionsContextMenu)
+        self.dirty_flag = False
+
+        select_all_action = QtGui.QAction("Select All", self)
+        remove_action = QtGui.QAction("Remove Selected Items", self)
+        self.separator = QtGui.QAction("", self)
+        self.separator.setSeparator(True)
+
+        select_all_action.setShortcut("Ctrl+A")
+        remove_action.setShortcut("Backspace" if platform.system() == "Darwin" else "Delete")
+
+        select_all_action.triggered.connect(self.select_all)
+        remove_action.triggered.connect(self.remove_selection)
+
+        self.addAction(select_all_action)
+        self.addAction(remove_action)
+        self.addAction(self.separator)
+
+        self.loaded_paths: set[pathlib.Path] = set()
+
+        self.dirty_flag_verification = dirty_flag_verification
+        self.rar_ro_shown = False
+
+    def get_sorting(self) -> tuple[int, int]:
+        col = self.twList.horizontalHeader().sortIndicatorSection()
+        order = self.twList.horizontalHeader().sortIndicatorOrder().value
+        return int(col), int(order)
+
+    def set_sorting(self, col: int, order: QtCore.Qt.SortOrder) -> None:
+        self.twList.horizontalHeader().setSortIndicator(col, order)
+
+    def add_app_action(self, action: QtGui.QAction) -> None:
+        self.insertAction(QtGui.QAction(), action)
+
+    def set_modified_flag(self, modified: bool) -> None:
+        self.dirty_flag = modified
+
+    def select_all(self) -> None:
+        self.twList.setRangeSelected(
+            QtWidgets.QTableWidgetSelectionRange(0, 0, self.twList.rowCount() - 1, self.twList.columnCount() - 1), True
+        )
+
+    def deselect_all(self) -> None:
+        self.twList.setRangeSelected(
+            QtWidgets.QTableWidgetSelectionRange(0, 0, self.twList.rowCount() - 1, self.twList.columnCount() - 1), False
+        )
+
+    def remove_archive_list(self, ca_list: list[ComicArchive]) -> None:
+        self.twList.setSortingEnabled(False)
+        current_removed = False
+        for ca in ca_list:
+            for row in range(self.twList.rowCount()):
+                row_ca = self.get_archive_by_row(row)
+                if row_ca == ca:
+                    if row == self.twList.currentRow():
+                        current_removed = True
+                    self.twList.removeRow(row)
+                    self.loaded_paths -= {ca.path}
+                    break
+        self.twList.setSortingEnabled(True)
+
+        if self.twList.rowCount() > 0 and current_removed:
+            # since on a removal, we select row 0, make sure callback occurs if
+            # we're already there
+            if self.twList.currentRow() == 0:
+                self.current_item_changed_cb(self.twList.currentItem(), None)
+            self.twList.selectRow(0)
+        elif self.twList.rowCount() <= 0:
+            self.listCleared.emit()
+
+    def get_archive_by_row(self, row: int) -> ComicArchive | None:
+        if row >= 0:
+            ca: ComicArchive = self.twList.item(row, FileSelectionList.dataColNum).data(QtCore.Qt.ItemDataRole.UserRole)
+            return ca
+        return None
+
+    def get_current_archive(self) -> ComicArchive | None:
+        return self.get_archive_by_row(self.twList.currentRow())
+
+    def remove_selection(self) -> None:
+        row_list = []
+        for item in self.twList.selectedItems():
+            if item.column() == 0:
+                row_list.append(item.row())
+
+        if len(row_list) == 0:
+            return
+
+        if self.twList.currentRow() in row_list:
+            if not self.dirty_flag_verification(
+                "Remove Archive", "If you close this archive, data in the form will be lost.  Are you sure?"
+            ):
+                return
+
+        row_list.sort()
+        row_list.reverse()
+
+        self.twList.currentItemChanged.disconnect(self.current_item_changed_cb)
+        self.twList.setSortingEnabled(False)
+
+        for i in row_list:
+            self.loaded_paths -= {self.get_archive_by_row(i).path}  # type: ignore[union-attr]
+            self.twList.removeRow(i)
+
+        self.twList.setSortingEnabled(True)
+        self.twList.currentItemChanged.connect(self.current_item_changed_cb)
+
+        if self.twList.rowCount() > 0:
+            # since on a removal, we select row 0, make sure callback occurs if
+            # we're already there
+            if self.twList.currentRow() == 0:
+                self.current_item_changed_cb(self.twList.currentItem(), None)
+            self.twList.selectRow(0)
+        else:
+            self.listCleared.emit()
+
+    def add_path_list(self, pathlist: list[str]) -> None:
+        if not pathlist:
+            return
+        filelist = utils.get_recursive_filelist(pathlist)
+        # we now have a list of files to add
+
+        progdialog = None
+        if len(filelist) < 3:
+            # Prog dialog on Linux flakes out for small range, so scale up
+            progdialog = QtWidgets.QProgressDialog("", "Cancel", 0, len(filelist), parent=self)
+            progdialog.setWindowTitle("Adding Files")
+            progdialog.setWindowModality(QtCore.Qt.WindowModality.WindowModal)
+            progdialog.setMinimumDuration(300)
+            progdialog.show()
+            center_window_on_parent(progdialog)
+
+        first_added = None
+        rar_added_ro = False
+        self.twList.setSortingEnabled(False)
+        for idx, f in enumerate(filelist):
+            if idx % 10 == 0:
+                QtCore.QCoreApplication.processEvents()
+            if progdialog is not None:
+                if progdialog.wasCanceled():
+                    break
+                progdialog.setValue(idx + 1)
+                progdialog.setLabelText(f)
+
+            row, ca = self.add_path_item(f)
+            if row is not None:
+                rar_added_ro = bool(ca and ca.archiver.name() == "RAR" and not ca.archiver.is_writable())
+                if first_added is None and row != -1:
+                    first_added = row
+
+        if progdialog is not None:
+            progdialog.hide()
+        QtCore.QCoreApplication.processEvents()
+
+        if first_added is not None:
+            self.twList.selectRow(first_added)
+        else:
+            if len(pathlist) == 1 and os.path.isfile(pathlist[0]):
+                QtWidgets.QMessageBox.information(
+                    self, "File Open", "Selected file doesn't seem to be a comic archive."
+                )
+            else:
+                QtWidgets.QMessageBox.information(self, "File/Folder Open", "No readable comic archives were found.")
+
+        if rar_added_ro:
+            self.rar_ro_message()
+
+        self.twList.setSortingEnabled(True)
+
+        # Adjust column size
+        self.twList.resizeColumnsToContents()
+        self.twList.setColumnWidth(FileSelectionList.MDFlagColNum, 35)
+        self.twList.setColumnWidth(FileSelectionList.readonlyColNum, 35)
+        self.twList.setColumnWidth(FileSelectionList.typeColNum, 45)
+        if self.twList.columnWidth(FileSelectionList.fileColNum) > 250:
+            self.twList.setColumnWidth(FileSelectionList.fileColNum, 250)
+        if self.twList.columnWidth(FileSelectionList.folderColNum) > 200:
+            self.twList.setColumnWidth(FileSelectionList.folderColNum, 200)
+
+    def rar_ro_message(self) -> None:
+        if not self.rar_ro_shown:
+            if platform.system() == "Windows":
+                rar_help = windowsRarHelp
+
+            elif platform.system() == "Darwin":
+                rar_help = macRarHelp
+
+            else:
+                rar_help = linuxRarHelp
+
+            OptionalMessageDialog.msg_no_checkbox(
+                self,
+                "RAR Files are Read-Only",
+                "It looks like you have opened a RAR/CBR archive,\n"
+                "however ComicTagger cannot write to them without the rar program and are marked read only!\n\n"
+                f"{rar_help}",
+            )
+            self.rar_ro_shown = True
+
+    def get_current_list_row(self, path: str) -> tuple[int, ComicArchive]:
+        pl = pathlib.Path(path)
+        if pl not in self.loaded_paths:
+            return -1, None  # type: ignore[return-value]
+
+        for r in range(self.twList.rowCount()):
+            ca = cast(ComicArchive, self.get_archive_by_row(r))
+            if ca.path == pl:
+                return r, ca
+
+        return -1, None  # type: ignore[return-value]
+
+    def add_path_item(self, path: str) -> tuple[int, ComicArchive]:
+        path = str(path)
+        path = os.path.abspath(path)
+
+        current_row, ca = self.get_current_list_row(path)
+        if current_row >= 0:
+            return current_row, ca
+
+        ca = ComicArchive(
+            path, str(graphics_path / "nocover.png"), hash_archive=self.config.Runtime_Options__preferred_hash
+        )
+
+        if ca.seems_to_be_a_comic_archive():
+            self.loaded_paths.add(ca.path)
+            row: int = self.twList.rowCount()
+            self.twList.insertRow(row)
+
+            filename_item = QtWidgets.QTableWidgetItem()
+            folder_item = QtWidgets.QTableWidgetItem()
+            md_item = QtWidgets.QTableWidgetItem()
+            readonly_item = QtWidgets.QTableWidgetItem()
+            type_item = QtWidgets.QTableWidgetItem()
+
+            item_text = os.path.split(ca.path)[1]
+
+            filename_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            filename_item.setData(QtCore.Qt.ItemDataRole.UserRole, ca)
+            filename_item.setText(item_text)
+            filename_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+            self.twList.setItem(row, FileSelectionList.fileColNum, filename_item)
+
+            item_text = os.path.split(ca.path)[0]
+
+            folder_item.setText(item_text)
+            folder_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+            folder_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            self.twList.setItem(row, FileSelectionList.folderColNum, folder_item)
+
+            type_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            self.twList.setItem(row, FileSelectionList.typeColNum, type_item)
+
+            md_item.setText(", ".join(x for x in ca.get_supported_tags() if ca.has_tags(x)))
+            md_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            md_item.setTextAlignment(QtCore.Qt.AlignmentFlag.AlignHCenter)
+            self.twList.setItem(row, FileSelectionList.MDFlagColNum, md_item)
+
+            if not ca.is_writable():
+                readonly_item.setCheckState(QtCore.Qt.CheckState.Checked)
+                readonly_item.setData(QtCore.Qt.ItemDataRole.UserRole, True)
+                readonly_item.setText(" ")
+            else:
+                readonly_item.setData(QtCore.Qt.ItemDataRole.UserRole, False)
+                readonly_item.setCheckState(QtCore.Qt.CheckState.Unchecked)
+                # This is a nbsp it sorts after a space ' '
+                readonly_item.setText("\xa0")
+            readonly_item.setFlags(QtCore.Qt.ItemFlag.ItemIsSelectable | QtCore.Qt.ItemFlag.ItemIsEnabled)
+            readonly_item.setTextAlignment(QtCore.Qt.AlignmentFlag.AlignHCenter)
+            self.twList.setItem(row, FileSelectionList.readonlyColNum, readonly_item)
+
+            return row, ca
+        return -1, None  # type: ignore[return-value]
+
+    def update_row(self, row: int) -> None:
+        if row >= 0:
+            ca: ComicArchive = self.twList.item(row, FileSelectionList.dataColNum).data(QtCore.Qt.ItemDataRole.UserRole)
+
+            filename_item = self.twList.item(row, FileSelectionList.fileColNum)
+            folder_item = self.twList.item(row, FileSelectionList.folderColNum)
+            md_item = self.twList.item(row, FileSelectionList.MDFlagColNum)
+            type_item = self.twList.item(row, FileSelectionList.typeColNum)
+            readonly_item = self.twList.item(row, FileSelectionList.readonlyColNum)
+
+            item_text = os.path.split(ca.path)[1]
+            filename_item.setText(item_text)
+            filename_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+
+            item_text = os.path.split(ca.path)[0]
+            folder_item.setText(item_text)
+            folder_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+
+            item_text = ca.archiver.name()
+            type_item.setText(item_text)
+            type_item.setData(QtCore.Qt.ItemDataRole.ToolTipRole, item_text)
+
+            md_item.setText(", ".join(x for x in ca.get_supported_tags() if ca.has_tags(x)))
+
+            if not ca.is_writable():
+                readonly_item.setCheckState(QtCore.Qt.CheckState.Checked)
+                readonly_item.setData(QtCore.Qt.ItemDataRole.UserRole, True)
+                readonly_item.setText(" ")
+            else:
+                readonly_item.setData(QtCore.Qt.ItemDataRole.UserRole, False)
+                readonly_item.setCheckState(QtCore.Qt.CheckState.Unchecked)
+                # This is a nbsp it sorts after a space ' '
+                readonly_item.setText("\xa0")
+
+    def get_selected_archive_list(self) -> list[ComicArchive]:
+        ca_list: list[ComicArchive] = []
+        for r in range(self.twList.rowCount()):
+            item = self.twList.item(r, FileSelectionList.dataColNum)
+            if item.isSelected():
+                ca: ComicArchive = item.data(QtCore.Qt.ItemDataRole.UserRole)
+                ca_list.append(ca)
+
+        return ca_list
+
+    def update_current_row(self) -> None:
+        self.update_row(self.twList.currentRow())
+
+    def update_selected_rows(self) -> None:
+        self.twList.setSortingEnabled(False)
+        for r in range(self.twList.rowCount()):
+            item = self.twList.item(r, FileSelectionList.dataColNum)
+            if item.isSelected():
+                self.update_row(r)
+        self.twList.setSortingEnabled(True)
+
+    def current_item_changed_cb(self, curr: QtCore.QModelIndex | None, prev: QtCore.QModelIndex | None) -> None:
+        if curr is not None:
+            new_idx = curr.row()
+            old_idx = -1
+            if prev is not None:
+                old_idx = prev.row()
+
+            if old_idx == new_idx:
+                return
+
+            # don't allow change if modified
+            if prev is not None and new_idx != old_idx:
+                if not self.dirty_flag_verification(
+                    "Change Archive", "If you change archives now, data in the form will be lost.  Are you sure?"
+                ):
+                    self.twList.currentItemChanged.disconnect(self.current_item_changed_cb)
+                    self.twList.setCurrentItem(prev)
+                    self.twList.currentItemChanged.connect(self.current_item_changed_cb)
+                    # Need to defer this revert selection, for some reason
+                    QtCore.QTimer.singleShot(1, self.revert_selection)
+                    return
+
+            fi = self.twList.item(new_idx, FileSelectionList.dataColNum).data(QtCore.Qt.ItemDataRole.UserRole)
+            self.selectionChanged.emit(QtCore.QVariant(fi))
+
+    def revert_selection(self) -> None:
+        self.twList.selectRow(self.twList.currentRow())

comictaggerlib/graphics/__init__.py

@@ -0,0 +1,5 @@
+from __future__ import annotations
+
+import importlib.resources
+
+graphics_path = importlib.resources.files(__package__)