Add seriesYear attribute

Moves to Python format strings for renaming, handles directory
structures, moving of files to a destination directory, sanitizes
file paths with pathvalidate and takes a different approach to
smart filename cleanup using the Python string.Formatter class

Moving to Python format strings means we can point to python
documentation for syntax and all we have to do is document the
properties and types that are attached to the GenericMetadata class.

Switching to pathvalidate allows comictagger to more simply handle both
directories and symbols in filenames.

The only changes to the string.Formatter class is:
1. format_field returns
an empty string if the value is none or an empty string regardless of
the format specifier.
2. _vformat drops the previous literal text if the field value
is an empty string and lstrips the following literal text of closing
special characters.

.github/workflows/build.yaml

@@ -0,0 +1,63 @@
+name: Build
+
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+*"
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version: [3.9]
+        os: [ubuntu-latest, macos-10.15, windows-latest]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python3 -m pip install -r requirements_dev.txt
+          python3 -m pip install -r requirements.txt
+          for requirement in requirements-*.txt; do
+            python3 -m pip install -r "$requirement"
+          done
+        shell: bash
+      - name: Install Windows dependencies
+        run: |
+          choco install -y zip
+        if: runner.os == 'Windows'
+      - name: build
+        run: |
+          make pydist
+          make dist
+      - name: Archive production artifacts
+        uses: actions/upload-artifact@v2
+        if: runner.os != 'Linux' # linux binary currently has a segfault when running on latest fedora
+        with:
+          name: "${{ format('ComicTagger-{0}', runner.os) }}"
+          path: dist/*.zip
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          prerelease: "${{ contains(github.ref, '-') }}" # alpha-releases should be 1.3.0-alpha.x full releases should be 1.3.0
+          draft: true
+          files: dist/*.zip
+      - name: "Publish distribution 📦 to PyPI"
+        if: startsWith(github.ref, 'refs/tags/') && runner.os == 'Linux'
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          packages_dir: piprelease

.gitignore

@@ -0,0 +1,157 @@
+# 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/

.travis.yml

@@ -0,0 +1,59 @@
+language: python
+# Only build tags
+if: type = pull_request OR tag IS present
+branches:
+  only:
+    - develop
+    - /^\d+\.\d+\.\d+.*$/
+env:
+  global:
+    - PYTHON=python3
+    - PIP=pip3
+    - SETUPTOOLS_SCM_PRETEND_VERSION=$TRAVIS_TAG
+    - MAKE=make
+matrix:
+  include:
+    - os: linux
+      python: 3.8
+    - name: "Python: 3.7"
+      os: osx
+      language: shell
+      python: 3.7
+      env: PYTHON=python3 PIP="python3 -m pip"
+      cache:
+        - directories:
+          - $HOME/Library/Caches/pip
+    - os: windows
+      language: bash
+      env: PATH=/C/Python37:/C/Python37/Scripts:$PATH MAKE=mingw32-make PIP=pip PYTHON=python
+before_install:
+  - if [ "$TRAVIS_OS_NAME" = "windows" ]; then choco install -y python --version 3.7.9; choco install -y mingw zip; fi
+install:
+  - $PIP install -r requirements_dev.txt
+  - $PIP install -r requirements-GUI.txt
+  - $PIP install -r requirements-CBR.txt
+script:
+  - if [ "$TRAVIS_OS_NAME" != "linux" ]; then $MAKE dist ; fi
+
+deploy:
+  - name: "$TRAVIS_TAG"
+    body: Released ComicTagger $TRAVIS_TAG
+    provider: releases
+    skip_cleanup: true
+    api_key:
+      secure: RgohcOJOfLhXXT12bMWaLwOqhe+ClSCYXjYuUJuWK4/E1fdd1xu1ebdQU+MI/R8cZ0Efz3sr2n3NkO/Aa8gN68xEfuF7RVRMm64P9oPrfZgGdsD6H43rU/6kN8bgaDRmCYpLTfXaJ+/gq0x1QDkhWJuceF2BYEGGvL0BvS/TUsLyjVxs8ujTplLyguXHNEv4/7Yz7SBNZZmUHjBuq/y+l8ds3ra9rSgAVAN1tMXoFKJPv+SNNkpTo5WUNMPzBnN041F1rzqHwYDLog2V7Krp9JkXzheRFdAr51/tJBYzEd8AtYVdYvaIvoO6A4PiTZ7MpsmcZZPAWqLQU00UTm/PhT/LVR+7+f8lOBG07RgNNHB+edjDRz3TAuqyuZl9wURWTZKTPuO49TkZMz7Wm0DRNZHvBm1IXLeSG7Tll2YL1+WpZNZg+Dhro2J1QD3vxDXafhMdTCB4z0q5aKpG93IT0p6oXOO0oEGOPZYbA2c5R3SXWSyqd1E1gdhbVjIZr59h++TEf1zz07tvWHqPuAF/Ly/j+dIcY2wj0EzRWaSASWgUpTnMljAkHtWhqDw4GXGDRkRUWRJl1d0/JyVqCeIdRzDQNl8/q7BcO3F1zqr1PgnYdz0lfwWxL1/ekw2vHOJE/GOdkyvX0aJrnaOV338mjJbfGHYv4ESc9ow1kdtIbiU=
+    file_glob: true
+    file: dist/*.zip
+    draft: true
+    on:
+      tags: true
+      condition: $TRAVIS_OS_NAME != "linux"
+  - provider: pypi
+    user: __token__
+    password:
+      secure: h+y5WkE8igf864dnsbGPFvOBkyPkuBYtnDRt+EgxHd71EZnV2YP7ns2Cx12su/SVVDdZCBlmHVtkhl6Jmqy+0rTkSYx+3mlBOqyl8Cj5+BlP/dP7Bdmhs2uLZk2YYL1avbC0A6eoNJFtCkjurnB/jCGE433rvMECWJ5x2HsQTKchCmDAEdAZbRBJrzLFsrIC+6NXW1IJZjd+OojbhLSyVar2Jr32foh6huTcBu/x278V1+zIC/Rwy3W67+3c4aZxYrI47FoYFza0jjFfr3EoSkKYUSByMTIvhWaqB2gIsF0T160jgDd8Lcgej+86ACEuG0v01VE7xoougqlOaJ94eAmapeM7oQXzekSwSAxcK3JQSfgWk/AvPhp07T4pQ8vCZmky6yqvVp1EzfKarTeub1rOnv+qo1znKLrBtOoq6t8pOAeczDdIDs51XT/hxaijpMRCM8vHxN4Kqnc4DY+3KcF7UFyH1ifQJHQe71tLBsM/GnAcJM5/3ykFVGvRJ716p4aa6IoGsdNk6bqlysNh7nURDl+bfm+CDXRkO2jkFwUFNqPHW7JwY6ZFx+b5SM3TzC3obJhfMS7OC37fo2geISOTR0xVie6NvpN6TjNAxFTfDxWJI7yH3Al2w43B3uYDd97WeiN+B+HVWtdaER87IVSRbRqFrRub+V+xrozT0y0=
+    skip_existing: true
+    skip_cleanup: true
+    on:
+      tags: true
+      condition: $TRAVIS_OS_NAME = "linux"

MANIFEST.in

@@ -1,4 +1,7 @@
-include README.txt
+include README.md
 include release_notes.txt
 include requirements.txt
-recursive-include scripts *.py *.txt
+recursive-include scripts *.py *.txt
+recursive-include desktop-integration *
+include windows/app.ico
+include mac/app.icns

Makefile

@@ -1,9 +1,23 @@
-TAGGER_BASE ?:= $(HOME)/Dropbox/tagger/comictagger
-TAGGER_SRC := $(TAGGER_BASE)/comictaggerlib
-VERSION_STR := $(shell grep version $(TAGGER_SRC)/ctversion.py| cut -d= -f2 | sed 's/\"//g')
-PASSWORD    := $(shell cat $(TAGGER_BASE)/project_password.txt)  
-UPLOAD_TOOL := $(TAGGER_BASE)/google/googlecode_upload.py
-all: clean
+PIP ?= pip3
+PYTHON ?= python3
+VERSION_STR := $(shell $(PYTHON) setup.py --version)
+
+ifeq ($(OS),Windows_NT)
+	OS_VERSION=win-$(PROCESSOR_ARCHITECTURE)
+	APP_NAME=comictagger.exe
+	FINAL_NAME=ComicTagger-$(VERSION_STR)-$(OS_VERSION).exe
+else ifeq ($(shell uname -s),Darwin)
+	OS_VERSION=osx-$(shell defaults read loginwindow SystemVersionStampAsString)-$(shell uname -m)
+	APP_NAME=ComicTagger.app
+	FINAL_NAME=ComicTagger-$(VERSION_STR)-$(OS_VERSION).app
+else
+	APP_NAME=comictagger
+	FINAL_NAME=ComicTagger-$(VERSION_STR)
+endif
+
+.PHONY: all clean pydist upload dist
+	
+all: clean dist
 
 clean:
 	rm -rf *~ *.pyc *.pyo
@@ -12,49 +26,24 @@ clean:
 	rm -rf dist MANIFEST
 	rm -rf *.deb
 	rm -rf logdict*.log
-	make -C mac clean
-	make -C windows clean
+	$(MAKE) -C mac clean   
 	rm -rf build
+	rm -rf comictaggerlib/ui/__pycache__
+	rm comictaggerlib/ctversion.py
 
 pydist:
-	mkdir -p release
-	rm -f release/*.zip
-	python setup.py sdist --formats=zip  #,gztar
-	mv dist/comictagger-$(VERSION_STR).zip release
-	@echo When satisfied with release, do this:
-	@echo make svn_tag
-
-remove_test_install:
-	sudo rm -rf /usr/local/bin/comictagger.py
-	sudo rm -rf /usr/local/lib/python2.7/dist-packages/comictagger*
-	
-#deb:
-#	fpm -s python -t deb \
-#		-n 'comictagger' \
-#		--category 'utilities' \
-#		--maintainer 'comictagger@gmail.com' \
-#		--after-install debian_scripts/after_install.sh \
-#		--before-remove debian_scripts/before_remove.sh \
-#		-d 'python >= 2.6' \
-#		-d 'python < 2.8' \
-#		-d 'python-imaging' \
-#		-d 'python-bs4' \
-#		--deb-suggests 'rar' \
-#		--deb-suggests 'unrar-free' \
-#		--python-install-bin /usr/share/comictagger \
-#		--python-install-lib /usr/share/comictagger \
-#		setup.py 
-#
-#		# For now, don't require PyQt, since command-line is available without it
-#		#-d 'python-qt4 >= 4.8' 
+	make clean
+	mkdir -p piprelease
+	rm -f comictagger-$(VERSION_STR).zip
+	$(PYTHON) setup.py sdist --formats=gztar
+	mv dist/comictagger-$(VERSION_STR).tar.gz piprelease
+	rm -rf comictagger.egg-info dist
 		
 upload:
-	$(UPLOAD_TOOL) -p comictagger -s "ComicTagger $(VERSION_STR) Source" -l Featured,Type-Source -u beville -w $(PASSWORD) "release/comictagger-$(VERSION_STR).zip"
-	$(UPLOAD_TOOL) -p comictagger -s "ComicTagger $(VERSION_STR)  Mac OS X" -l Featured,Type-Archive -u beville -w $(PASSWORD) "release/ComicTagger-$(VERSION_STR).dmg"
-	$(UPLOAD_TOOL) -p comictagger -s "ComicTagger $(VERSION_STR)  Windows" -l Featured,Type-Installer -u beville -w $(PASSWORD) "release/ComicTagger v$(VERSION_STR).exe"
-	python setup.py register
- 
-svn_tag:
-	svn copy https://comictagger.googlecode.com/svn/trunk \
-		https://comictagger.googlecode.com/svn/tags/$(VERSION_STR) -m "Release $(VERSION_STR)"
+	$(PYTHON) setup.py register
+	$(PYTHON) setup.py sdist --formats=gztar upload
 
+dist:
+	$(PIP) install .
+	pyinstaller -y comictagger.spec
+	cd dist && zip -r $(FINAL_NAME).zip $(APP_NAME)

README.md

@@ -0,0 +1,50 @@
+[![Build Status](https://travis-ci.org/comictagger/comictagger.svg?branch=develop)](https://travis-ci.org/comictagger/comictagger)
+[![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, release notes, and more, visit [the Wiki](https://github.com/comictagger/comictagger/wiki)
+
+
+## Installation
+
+### Binaries
+
+Windows 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]
+```
+
+### From source
+
+ 1. Ensure you have a recent version of python3 installed
+ 2. Clone this repository `git clone https://github.com/comictagger/comictagger.git`
+ 3. `pip3 install -r requirements_dev.txt`
+ 4. Optionally install the GUI `pip3 install -r requirements-GUI.txt`
+ 5. Optionally install CBR support `pip3 install -r requirements-CBR.txt`
+ 6. `python3 comictagger.py`

README.txt

@@ -1,31 +0,0 @@
-ComicTagger is a multi-platform app for writing metadata to comic archives, written in Python and PyQt.
-
-Features:
-
-* Runs on Mac OSX, Microsoft Windows, and Linux systems
-* Communicates with an online database (Comic Vine) for acquiring metadata
-* Uses image processing to automatically match a given archive with the correct issue data
-* Batch processing in the GUI for tagging hundreds or more comics at a time
-* Reads and writes multiple tagging schemes ( ComicBookLover and ComicRack, with more planned).
-* Reads and writes RAR and Zip archives (external tools needed for writing RAR)
-* Command line interface (CLI) on all platforms (including Windows), which supports batch operations, and which can be used in native scripts for complex operations. For example, to recusrively scrape and tag all archives in a folder
-	comictagger.py -R -s -o -f -t cr -v -i --nooverwrite /path/to/comics/
-
-For details, screenshots, release notes, and more, visit http://code.google.com/p/comictagger/
-
-Requires:
-
-* python 2.6 or 2.7
-* configparser
-* python imaging (PIL) >= 1.1.6
-* beautifulsoup > 4.1
-    
-Optional requirement (for GUI):
-
-* pyqt4
-
-Install and run:
-
-* ComicTagger can be run directly from this directory, using the launcher script "comictagger.py"
-
-* To install on your system use:  "python setup.py install".  Take note in the output where comictagger.py goes!

comicapi/__init__.py

@@ -0,0 +1 @@
+__author__ = 'dromanin'

comicapi/comet.py

@@ -0,0 +1,276 @@
+"""A class to encapsulate CoMet data"""
+
+# Copyright 2012-2014 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 xml.etree.ElementTree as ET
+#from datetime import datetime
+#from pprint import pprint
+#import zipfile
+
+from .genericmetadata import GenericMetadata
+from . 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 = "{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 = "{0}".format(
+                    credit['person'])
+
+            if credit['role'].lower() in set(self.penciller_synonyms):
+                ET.SubElement(
+                    root,
+                    'penciller').text = "{0}".format(
+                    credit['person'])
+
+            if credit['role'].lower() in set(self.inker_synonyms):
+                ET.SubElement(
+                    root,
+                    'inker').text = "{0}".format(
+                    credit['person'])
+
+            if credit['role'].lower() in set(self.colorist_synonyms):
+                ET.SubElement(
+                    root,
+                    'colorist').text = "{0}".format(
+                    credit['person'])
+
+            if credit['role'].lower() in set(self.letterer_synonyms):
+                ET.SubElement(
+                    root,
+                    'letterer').text = "{0}".format(
+                    credit['person'])
+
+            if credit['role'].lower() in set(self.cover_synonyms):
+                ET.SubElement(
+                    root,
+                    'coverDesigner').text = "{0}".format(
+                    credit['person'])
+
+            if credit['role'].lower() in set(self.editor_synonyms):
+                ET.SubElement(
+                    root,
+                    'editor').text = "{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/comicbookinfo.py

@@ -0,0 +1,130 @@
+"""A class to encapsulate the ComicBookInfo data"""
+
+# Copyright 2012-2014 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
+from . import utils
+#import ctversion
+
+
+class ComicBookInfo:
+    def metadataFromString(self, string):
+        class Default(dict):
+            def __missing__(self, key):
+                return None
+        cbi_container = json.loads(str(string, 'utf-8'))
+
+        metadata = GenericMetadata()
+
+        cbi = Default(cbi_container['ComicBookInfo/1.0'])
+
+        metadata.series = utils.xlate(cbi['series'])
+        metadata.title = utils.xlate(cbi['title'])
+        metadata.issue = utils.xlate(cbi['issue'])
+        metadata.publisher = utils.xlate(cbi['publisher'])
+        metadata.month = utils.xlate(cbi['publicationMonth'], True)
+        metadata.year = utils.xlate(cbi['publicationYear'], True)
+        metadata.seriesYear = utils.xlate('seriesPublicationYear', True)
+        metadata.issueCount = utils.xlate(cbi['numberOfIssues'], True)
+        metadata.comments = utils.xlate(cbi['comments'])
+        metadata.genre = utils.xlate(cbi['genre'])
+        metadata.volume = utils.xlate(cbi['volume'], True)
+        metadata.volumeCount = utils.xlate(cbi['numberOfVolumes'], True)
+        metadata.language = utils.xlate(cbi['language'])
+        metadata.country = utils.xlate(cbi['country'])
+        metadata.criticalRating = utils.xlate(cbi['rating'])
+
+        metadata.credits = cbi['credits']
+        metadata.tags = cbi['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)
+
+    def validateString(self, string):
+        """Verify that the string actually contains CBI data in JSON format"""
+
+        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/' + '1.0.0',  # ctversion.version,
+                         'lastModified': str(datetime.now()),
+                         'ComicBookInfo/1.0': cbi}
+
+        # helper func
+        def assign(cbi_entry, md_entry):
+            if md_entry is not None or isinstance(md_entry, str) and md_entry != "":
+                cbi[cbi_entry] = md_entry
+
+        assign('series', utils.xlate(metadata.series))
+        assign('title', utils.xlate(metadata.title))
+        assign('issue', utils.xlate(metadata.issue))
+        assign('publisher', utils.xlate(metadata.publisher))
+        assign('publicationMonth', utils.xlate(metadata.month, True))
+        assign('publicationYear', utils.xlate(metadata.year, True))
+        assign('seriesPublicationYear', utils.xlate(metadata.seriesYear, True))
+        assign('numberOfIssues', utils.xlate(metadata.issueCount, True))
+        assign('comments', utils.xlate(metadata.comments))
+        assign('genre', utils.xlate(metadata.genre))
+        assign('volume', utils.xlate(metadata.volume, True))
+        assign('numberOfVolumes', utils.xlate(metadata.volumeCount, True))
+        assign('language', utils.xlate(utils.getLanguageFromISO(metadata.language)))
+        assign('country', utils.xlate(metadata.country))
+        assign('rating', utils.xlate(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

comicapi/comicinfoxml.py

@@ -0,0 +1,290 @@
+"""A class to encapsulate ComicRack's ComicInfo.xml data"""
+
+# Copyright 2012-2014 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 xml.etree.ElementTree as ET
+#from datetime import datetime
+#from pprint import pprint
+#import zipfile
+
+from .genericmetadata import GenericMetadata
+from .issuestring import IssueString
+from . 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)
+        tree_str = ET.tostring(tree.getroot()).decode()
+        return header + tree_str
+
+    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 = "{0}".format(md_entry)
+
+        assign('Title', md.title)
+        assign('Series', md.series)
+        assign('Number', md.issue)
+        assign('Count', md.issueCount)
+        assign('Volume', md.volume)
+        assign('AlternateSeries', md.alternateSeries)
+        assign('AlternateNumber', md.alternateNumber)
+        assign('StoryArc', md.storyArc)
+        assign('SeriesGroup', md.seriesGroup)
+        assign('AlternateCount', md.alternateCount)
+        assign('Summary', md.comments)
+        assign('Notes', md.notes)
+        assign('Year', md.year)
+        assign('Month', md.month)
+        assign('Day', md.day)
+        assign('SeriesYear', md.seriesYear)
+
+        # 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)
+
+        assign('Publisher', md.publisher)
+        assign('Imprint', md.imprint)
+        assign('Genre', md.genre)
+        assign('Web', md.webLink)
+        assign('PageCount', md.pageCount)
+        assign('LanguageISO', md.language)
+        assign('Format', md.format)
+        assign('AgeRating', md.maturityRating)
+        if md.blackAndWhite is not None and md.blackAndWhite:
+            ET.SubElement(root, 'BlackAndWhite').text = "Yes"
+        assign('Manga', md.manga)
+        assign('Characters', md.characters)
+        assign('Teams', md.teams)
+        assign('Locations', md.locations)
+        assign('ScanInformation', md.scanInfo)
+
+        #  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
+
+        def get(name):
+            tag = root.find(name)
+            if tag is None:
+                return None
+            return tag.text
+
+        md = GenericMetadata()
+
+        md.series = utils.xlate(get('Series'))
+        md.title = utils.xlate(get('Title'))
+        md.issue = IssueString(utils.xlate(get('Number'))).asString()
+        md.issueCount = utils.xlate(get('Count'), True)
+        md.volume = utils.xlate(get('Volume'), True)
+        md.alternateSeries = utils.xlate(get('AlternateSeries'))
+        md.alternateNumber = IssueString(utils.xlate(get('AlternateNumber'))).asString()
+        md.alternateCount = utils.xlate(get('AlternateCount'), True)
+        md.comments = utils.xlate(get('Summary'))
+        md.notes = utils.xlate(get('Notes'))
+        md.year = utils.xlate(get('Year'), True)
+        md.month = utils.xlate(get('Month'), True)
+        md.day = utils.xlate(get('Day'), True)
+        md.seriesYear = utils.xlate(get('SeriesYear'), True)
+        md.publisher = utils.xlate(get('Publisher'))
+        md.imprint = utils.xlate(get('Imprint'))
+        md.genre = utils.xlate(get('Genre'))
+        md.webLink = utils.xlate(get('Web'))
+        md.language = utils.xlate(get('LanguageISO'))
+        md.format = utils.xlate(get('Format'))
+        md.manga = utils.xlate(get('Manga'))
+        md.characters = utils.xlate(get('Characters'))
+        md.teams = utils.xlate(get('Teams'))
+        md.locations = utils.xlate(get('Locations'))
+        md.pageCount = utils.xlate(get('PageCount'), True)
+        md.scanInfo = utils.xlate(get('ScanInformation'))
+        md.storyArc = utils.xlate(get('StoryArc'))
+        md.seriesGroup = utils.xlate(get('SeriesGroup'))
+        md.maturityRating = utils.xlate(get('AgeRating'))
+
+        tmp = utils.xlate(get('BlackAndWhite'))
+        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'
+                ):
+                if n.text is not None:
+                    for name in n.text.split(','):
+                        md.addCredit(name.strip(), n.tag)
+
+            if n.tag == 'CoverArtist':
+                if n.text is not None:
+                    for name in n.text.split(','):
+                        md.addCredit(name.strip(), "Cover")
+
+        # parse page data now
+        pages_node = root.find("Pages")
+        if pages_node is not None:
+            for page in pages_node:
+                md.pages.append(page.attrib)
+                # print page.attrib
+
+        md.isEmpty = False
+
+        return md
+
+    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/filenameparser.py

@@ -0,0 +1,292 @@
+"""Functions for parsing comic info from filename
+
+This should probably be re-written, but, well, it mostly works!
+"""
+
+# Copyright 2012-2014 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.
+
+# Some portions of this code were modified from pyComicMetaThis project
+# http://code.google.com/p/pycomicmetathis/
+
+import re
+import os
+from urllib.parse import unquote
+
+
+class FileNameParser:
+
+    def repl(self, m):
+        return ' ' * len(m.group())
+
+    def fixSpaces(self, string, remove_dashes=True):
+        if remove_dashes:
+            placeholders = ['[-_]', '  +']
+        else:
+            placeholders = ['[_]', '  +']
+        for ph in placeholders:
+            string = re.sub(ph, self.repl, string)
+        return string  # .strip()
+
+    def getIssueCount(self, filename, issue_end):
+
+        count = ""
+        filename = filename[issue_end:]
+
+        # replace any name separators with spaces
+        tmpstr = self.fixSpaces(filename)
+        found = False
+
+        match = re.search('(?<=\sof\s)\d+(?=\s)', tmpstr, re.IGNORECASE)
+        if match:
+            count = match.group()
+            found = True
+
+        if not found:
+            match = re.search('(?<=\(of\s)\d+(?=\))', tmpstr, re.IGNORECASE)
+            if match:
+                count = match.group()
+                found = True
+
+        count = count.lstrip("0")
+
+        return count
+
+    def getIssueNumber(self, filename):
+        """Returns a tuple of issue number string, and start and end indexes in the filename
+        (The indexes will be used to split the string up for further parsing)
+        """
+
+        found = False
+        issue = ''
+        start = 0
+        end = 0
+
+        # first, look for multiple "--", this means it's formatted differently
+        # from most:
+        if "--" in filename:
+            # the pattern seems to be that anything to left of the first "--"
+            # is the series name followed by issue
+            filename = re.sub("--.*", self.repl, filename)
+
+        elif "__" in filename:
+            # the pattern seems to be that anything to left of the first "__"
+            # is the series name followed by issue
+            filename = re.sub("__.*", self.repl, filename)
+
+        filename = filename.replace("+", " ")
+
+        # replace parenthetical phrases with spaces
+        filename = re.sub("\(.*?\)", self.repl, filename)
+        filename = re.sub("\[.*?\]", self.repl, filename)
+
+        # replace any name separators with spaces
+        filename = self.fixSpaces(filename)
+
+        # remove any "of NN" phrase with spaces (problem: this could break on
+        # some titles)
+        filename = re.sub("of [\d]+", self.repl, filename)
+
+        # print u"[{0}]".format(filename)
+
+        # we should now have a cleaned up filename version with all the words in
+        # the same positions as original filename
+
+        # make a list of each word and its position
+        word_list = list()
+        for m in re.finditer("\S+", filename):
+            word_list.append((m.group(0), m.start(), m.end()))
+
+        # remove the first word, since it can't be the issue number
+        if len(word_list) > 1:
+            word_list = word_list[1:]
+        else:
+            # only one word??  just bail.
+            return issue, start, end
+
+        # Now try to search for the likely issue number word in the list
+
+        # first look for a word with "#" followed by digits with optional suffix
+        # this is almost certainly the issue number
+        for w in reversed(word_list):
+            if re.match("#[-]?(([0-9]*\.[0-9]+|[0-9]+)(\w*))", w[0]):
+                found = True
+                break
+
+        # same as above but w/o a '#', and only look at the last word in the
+        # list
+        if not found:
+            w = word_list[-1]
+            if re.match("[-]?(([0-9]*\.[0-9]+|[0-9]+)(\w*))", w[0]):
+                found = True
+
+        # now try to look for a # followed by any characters
+        if not found:
+            for w in reversed(word_list):
+                if re.match("#\S+", w[0]):
+                    found = True
+                    break
+
+        if found:
+            issue = w[0]
+            start = w[1]
+            end = w[2]
+            if issue[0] == '#':
+                issue = issue[1:]
+
+        return issue, start, end
+
+    def getSeriesName(self, filename, issue_start):
+        """Use the issue number string index to split the filename string"""
+
+        if issue_start != 0:
+            filename = filename[:issue_start]
+
+        # in case there is no issue number, remove some obvious stuff
+        if "--" in filename:
+            # the pattern seems to be that anything to left of the first "--"
+            # is the series name followed by issue
+            filename = re.sub("--.*", self.repl, filename)
+
+        elif "__" in filename:
+            # the pattern seems to be that anything to left of the first "__"
+            # is the series name followed by issue
+            filename = re.sub("__.*", self.repl, filename)
+
+        filename = filename.replace("+", " ")
+        tmpstr = self.fixSpaces(filename, remove_dashes=False)
+
+        series = tmpstr
+        volume = ""
+
+        # save the last word
+        try:
+            last_word = series.split()[-1]
+        except:
+            last_word = ""
+
+        # remove any parenthetical phrases
+        series = re.sub("\(.*?\)", "", series)
+
+        # search for volume number
+        match = re.search('(.+)([vV]|[Vv][oO][Ll]\.?\s?)(\d+)\s*$', series)
+        if match:
+            series = match.group(1)
+            volume = match.group(3)
+
+        # if a volume wasn't found, see if the last word is a year in parentheses
+        # since that's a common way to designate the volume
+        if volume == "":
+            # match either (YEAR), (YEAR-), or (YEAR-YEAR2)
+            match = re.search("(\()(\d{4})(-(\d{4}|)|)(\))", last_word)
+            if match:
+                volume = match.group(2)
+
+        series = series.strip()
+
+        # if we don't have an issue number (issue_start==0), look
+        # for hints i.e. "TPB", "one-shot", "OS", "OGN", etc that might
+        # be removed to help search online
+        if issue_start == 0:
+            one_shot_words = ["tpb", "os", "one-shot", "ogn", "gn"]
+            try:
+                last_word = series.split()[-1]
+                if last_word.lower() in one_shot_words:
+                    series = series.rsplit(' ', 1)[0]
+            except:
+                pass
+
+        return series, volume.strip()
+
+    def getYear(self, filename, issue_end):
+
+        filename = filename[issue_end:]
+
+        year = ""
+        # look for four digit number with "(" ")" or "--" around it
+        match = re.search('(\(\d\d\d\d\))|(--\d\d\d\d--)', filename)
+        if match:
+            year = match.group()
+            # remove non-digits
+            year = re.sub("[^0-9]", "", year)
+        return year
+
+    def getRemainder(self, filename, year, count, volume, issue_end):
+        """Make a guess at where the the non-interesting stuff begins"""
+
+        remainder = ""
+
+        if "--" in filename:
+            remainder = filename.split("--", 1)[1]
+        elif "__" in filename:
+            remainder = filename.split("__", 1)[1]
+        elif issue_end != 0:
+            remainder = filename[issue_end:]
+
+        remainder = self.fixSpaces(remainder, remove_dashes=False)
+        if volume != "":
+            remainder = remainder.replace("Vol." + volume, "", 1)
+        if year != "":
+            remainder = remainder.replace(year, "", 1)
+        if count != "":
+            remainder = remainder.replace("of " + count, "", 1)
+
+        remainder = remainder.replace("()", "")
+        remainder = remainder.replace(
+            "  ",
+            " ")    # cleans some whitespace mess
+
+        return remainder.strip()
+
+    def parseFilename(self, filename):
+
+        # remove the path
+        filename = os.path.basename(filename)
+
+        # remove the extension
+        filename = os.path.splitext(filename)[0]
+
+        # url decode, just in case
+        filename = unquote(filename)
+
+        # sometimes archives get messed up names from too many decodes
+        # often url encodings will break and leave "_28" and "_29" in place
+        # of "(" and ")"  see if there are a number of these, and replace them
+        if filename.count("_28") > 1 and filename.count("_29") > 1:
+            filename = filename.replace("_28", "(")
+            filename = filename.replace("_29", ")")
+
+        self.issue, issue_start, issue_end = self.getIssueNumber(filename)
+        self.series, self.volume = self.getSeriesName(filename, issue_start)
+
+        # provides proper value when the filename doesn't have a issue number
+        if issue_end == 0:
+            issue_end = len(self.series)
+
+        self.year = self.getYear(filename, issue_end)
+        self.issue_count = self.getIssueCount(filename, issue_end)
+        self.remainder = self.getRemainder(
+            filename,
+            self.year,
+            self.issue_count,
+            self.volume,
+            issue_end)
+
+        if self.issue != "":
+            # strip off leading zeros
+            self.issue = self.issue.lstrip("0")
+            if self.issue == "":
+                self.issue = "0"
+            if self.issue[0] == ".":
+                self.issue = "0" + self.issue

comicapi/genericmetadata.py

@@ -0,0 +1,324 @@
+"""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 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 . import utils
+
+
+class PageType:
+
+    """
+    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"
+
+"""
+class PageInfo:
+	Image = 0
+	Type = PageType.Story
+	DoublePage = False
+	ImageSize = 0
+	Key = ""
+	ImageWidth = 0
+	ImageHeight = 0
+"""
+
+
+class GenericMetadata:
+
+    def __init__(self):
+
+        self.isEmpty = True
+        self.tagOrigin = None
+
+        self.series = None
+        self.issue = None
+        self.title = None
+        self.publisher = None
+        self.seriesYear = None
+        self.month = None
+        self.year = None
+        self.day = None
+        self.issueCount = None
+        self.volume = None
+        self.genre = None
+        self.language = None  # 2 letter iso code
+        self.comments = None  # use same way as Summary in CIX
+
+        self.volumeCount = None
+        self.criticalRating = None
+        self.country = None
+
+        self.alternateSeries = None
+        self.alternateNumber = None
+        self.alternateCount = None
+        self.imprint = None
+        self.notes = None
+        self.webLink = None
+        self.format = None
+        self.manga = None
+        self.blackAndWhite = None
+        self.pageCount = None
+        self.maturityRating = None
+
+        self.storyArc = None
+        self.seriesGroup = None
+        self.scanInfo = None
+
+        self.characters = None
+        self.teams = None
+        self.locations = None
+
+        self.credits = list()
+        self.tags = list()
+        self.pages = list()
+
+        # Some CoMet-only items
+        self.price = None
+        self.isVersionOf = None
+        self.rights = None
+        self.identifier = None
+        self.lastMark = None
+        self.coverImage = None
+
+    def overlay(self, new_md):
+        """Overlay a metadata object on this one
+
+        That is, when the new object has non-None values, over-write them
+        to this one.
+        """
+
+        def assign(cur, new):
+            if new is not None:
+                if isinstance(new, str) and len(new) == 0:
+                    setattr(self, cur, None)
+                else:
+                    setattr(self, cur, new)
+
+        if not new_md.isEmpty:
+            self.isEmpty = False
+
+        assign('series', new_md.series)
+        assign("issue", new_md.issue)
+        assign("issueCount", new_md.issueCount)
+        assign("title", new_md.title)
+        assign("publisher", new_md.publisher)
+        assign("seriesYear", new_md.seriesYear)
+        assign("day", new_md.day)
+        assign("month", new_md.month)
+        assign("year", new_md.year)
+        assign("volume", new_md.volume)
+        assign("volumeCount", new_md.volumeCount)
+        assign("genre", new_md.genre)
+        assign("language", new_md.language)
+        assign("country", new_md.country)
+        assign("criticalRating", new_md.criticalRating)
+        assign("alternateSeries", new_md.alternateSeries)
+        assign("alternateNumber", new_md.alternateNumber)
+        assign("alternateCount", new_md.alternateCount)
+        assign("imprint", new_md.imprint)
+        assign("webLink", new_md.webLink)
+        assign("format", new_md.format)
+        assign("manga", new_md.manga)
+        assign("blackAndWhite", new_md.blackAndWhite)
+        assign("maturityRating", new_md.maturityRating)
+        assign("storyArc", new_md.storyArc)
+        assign("seriesGroup", new_md.seriesGroup)
+        assign("scanInfo", new_md.scanInfo)
+        assign("characters", new_md.characters)
+        assign("teams", new_md.teams)
+        assign("locations", new_md.locations)
+        assign("comments", new_md.comments)
+        assign("notes", new_md.notes)
+
+        assign("price", new_md.price)
+        assign("isVersionOf", new_md.isVersionOf)
+        assign("rights", new_md.rights)
+        assign("identifier", new_md.identifier)
+        assign("lastMark", new_md.lastMark)
+
+        self.overlayCredits(new_md.credits)
+        # TODO
+
+        # not sure if the tags and pages should broken down, or treated
+        # as whole lists....
+
+        # For now, go the easy route, where any overlay
+        # value wipes out the whole list
+        if len(new_md.tags) > 0:
+            assign("tags", new_md.tags)
+
+        if len(new_md.pages) > 0:
+            assign("pages", new_md.pages)
+
+    def overlayCredits(self, new_credits):
+        for c in new_credits:
+            if 'primary' in c and c['primary']:
+                primary = True
+            else:
+                primary = False
+
+            # Remove credit role if person is blank
+            if c['person'] == "":
+                for r in reversed(self.credits):
+                    if r['role'].lower() == c['role'].lower():
+                        self.credits.remove(r)
+            # otherwise, add it!
+            else:
+                self.addCredit(c['person'], c['role'], primary)
+
+    def setDefaultPageList(self, count):
+        # generate a default page list, with the first page marked as the cover
+        for i in range(count):
+            page_dict = dict()
+            page_dict['Image'] = str(i)
+            if i == 0:
+                page_dict['Type'] = PageType.FrontCover
+            self.pages.append(page_dict)
+
+    def getArchivePageIndex(self, pagenum):
+        # convert the displayed page number to the page index of the file in
+        # the archive
+        if pagenum < len(self.pages):
+            return int(self.pages[pagenum]['Image'])
+        else:
+            return 0
+
+    def getCoverPageIndexList(self):
+        # return a list of archive page indices of cover pages
+        coverlist = []
+        for p in self.pages:
+            if 'Type' in p and p['Type'] == PageType.FrontCover:
+                coverlist.append(int(p['Image']))
+
+        if len(coverlist) == 0:
+            coverlist.append(0)
+
+        return coverlist
+
+    def addCredit(self, person, role, primary=False):
+
+        credit = dict()
+        credit['person'] = person
+        credit['role'] = role
+        if primary:
+            credit['primary'] = primary
+
+        # look to see if it's not already there...
+        found = False
+        for c in self.credits:
+            if (c['person'].lower() == person.lower() and
+                    c['role'].lower() == role.lower()):
+                # no need to add it. just adjust the "primary" flag as needed
+                c['primary'] = primary
+                found = True
+                break
+
+        if not found:
+            self.credits.append(credit)
+
+    def __str__(self):
+        vals = []
+        if self.isEmpty:
+            return "No metadata"
+
+        def add_string(tag, val):
+            if val is not None and "{0}".format(val) != "":
+                vals.append((tag, val))
+
+        def add_attr_string(tag):
+            val = getattr(self, tag)
+            add_string(tag, getattr(self, tag))
+
+        add_attr_string("series")
+        add_attr_string("issue")
+        add_attr_string("issueCount")
+        add_attr_string("title")
+        add_attr_string("publisher")
+        add_attr_string("seriesYear")
+        add_attr_string("year")
+        add_attr_string("month")
+        add_attr_string("day")
+        add_attr_string("volume")
+        add_attr_string("volumeCount")
+        add_attr_string("genre")
+        add_attr_string("language")
+        add_attr_string("country")
+        add_attr_string("criticalRating")
+        add_attr_string("alternateSeries")
+        add_attr_string("alternateNumber")
+        add_attr_string("alternateCount")
+        add_attr_string("imprint")
+        add_attr_string("webLink")
+        add_attr_string("format")
+        add_attr_string("manga")
+
+        add_attr_string("price")
+        add_attr_string("isVersionOf")
+        add_attr_string("rights")
+        add_attr_string("identifier")
+        add_attr_string("lastMark")
+
+        if self.blackAndWhite:
+            add_attr_string("blackAndWhite")
+        add_attr_string("maturityRating")
+        add_attr_string("storyArc")
+        add_attr_string("seriesGroup")
+        add_attr_string("scanInfo")
+        add_attr_string("characters")
+        add_attr_string("teams")
+        add_attr_string("locations")
+        add_attr_string("comments")
+        add_attr_string("notes")
+
+        add_string("tags", utils.listToString(self.tags))
+
+        for c in self.credits:
+            primary = ""
+            if 'primary' in c and c['primary']:
+                primary = " [P]"
+            add_string("credit", c['role'] + ": " + c['person'] + 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

comicapi/issuestring.py

@@ -0,0 +1,133 @@
+# coding=utf-8
+"""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 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 utils
+#import math
+#import re
+
+
+class IssueString:
+
+    def __init__(self, text):
+
+        # 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 = ""
+
+        if text is None:
+            return
+
+        if isinstance(text, int):
+            text = str(text)
+
+        if len(text) == 0:
+            return
+
+        text = str(text)
+
+        # skip the minus sign if it's first
+        if text[0] == '-':
+            start = 1
+        else:
+            start = 0
+
+        # 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 text[idx] not in "0123456789.":
+                    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
+
+            part1 = text[0:idx]
+            part2 = text[idx:len(text)]
+
+            if part1 != "":
+                self.num = float(part1)
+            self.suffix = part2
+        else:
+            self.suffix = text
+
+        # print "num: {0} suf: {1}".format(self.num, self.suffix)
+
+    def asString(self, pad=0):
+        # return the float, left side zero-padded, with suffix attached
+        if self.num is None:
+            return self.suffix
+
+        negative = self.num < 0
+
+        num_f = abs(self.num)
+
+        num_int = int(num_f)
+        num_s = str(num_int)
+        if float(num_int) != num_f:
+            num_s = str(num_f)
+
+        num_s += self.suffix
+
+        # create padding
+        padding = ""
+        l = len(str(num_int))
+        if l < pad:
+            padding = "0" * (pad - l)
+
+        num_s = padding + num_s
+        if negative:
+            num_s = "-" + num_s
+
+        return num_s
+
+    def asFloat(self):
+        # return the float, with no suffix
+        if self.suffix == "½":
+            if self.num is not None:
+                return self.num + .5
+            else:
+                return .5
+        return self.num
+
+    def asInt(self):
+        # return the int version of the float
+        if self.num is None:
+            return None
+        return int(self.num)

comicapi/utils.py

@@ -0,0 +1,617 @@
+# coding=utf-8
+"""Some generic utilities"""
+
+# Copyright 2012-2014 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
+import re
+import platform
+import locale
+import codecs
+import unicodedata
+
+
+class UtilsVars:
+    already_fixed_encoding = False
+
+
+def get_actual_preferred_encoding():
+    preferred_encoding = locale.getpreferredencoding()
+    if platform.system() == "Darwin":
+        preferred_encoding = "utf-8"
+    return preferred_encoding
+
+
+def fix_output_encoding():
+    if not UtilsVars.already_fixed_encoding:
+        # this reads the environment and inits the right locale
+        locale.setlocale(locale.LC_ALL, "")
+
+        # try to make stdout/stderr encodings happy for unicode printing
+        preferred_encoding = get_actual_preferred_encoding()
+        sys.stdout = codecs.getwriter(preferred_encoding)(sys.stdout)
+        sys.stderr = codecs.getwriter(preferred_encoding)(sys.stderr)
+        UtilsVars.already_fixed_encoding = True
+
+
+def get_recursive_filelist(pathlist):
+    """Get a recursive list of of all files under all path items in the list"""
+
+    filename_encoding = sys.getfilesystemencoding()
+    filelist = []
+    for p in pathlist:
+        # if path is a folder, walk it recursively, and all files underneath
+        if isinstance(p, str):
+            # make sure string is unicode
+            #p = p.decode(filename_encoding)  # , 'replace')
+            pass
+        elif not isinstance(p, str):
+            # it's probably a QString
+            p = str(p)
+
+        if os.path.isdir(p):
+            for root, dirs, files in os.walk(p):
+                for f in files:
+                    if isinstance(f, str):
+                        # make sure string is unicode
+                        #f = f.decode(filename_encoding, 'replace')
+                        pass
+                    elif not isinstance(f, str):
+                        # it's probably a QString
+                        f = str(f)
+                    filelist.append(os.path.join(root, f))
+        else:
+            filelist.append(p)
+
+    return filelist
+
+
+def listToString(l):
+    string = ""
+    if l is not None:
+        for item in l:
+            if len(string) > 0:
+                string += ", "
+            string += item
+    return string
+
+
+def addtopath(dirname):
+    if dirname is not None and dirname != "":
+
+        # verify that path doesn't already contain the given dirname
+        tmpdirname = re.escape(dirname)
+        pattern = r"{sep}{dir}$|^{dir}{sep}|{sep}{dir}{sep}|^{dir}$".format(
+            dir=tmpdirname,
+            sep=os.pathsep)
+
+        match = re.search(pattern, os.environ['PATH'])
+        if not match:
+            os.environ['PATH'] = dirname + os.pathsep + os.environ['PATH']
+
+
+def which(program):
+    """Returns path of the executable, if it exists"""
+
+    def is_exe(fpath):
+        return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
+
+    fpath, fname = os.path.split(program)
+    if fpath:
+        if is_exe(program):
+            return program
+    else:
+        for path in os.environ["PATH"].split(os.pathsep):
+            exe_file = os.path.join(path, program)
+            if is_exe(exe_file):
+                return exe_file
+
+    return None
+
+
+def xlate(data, isInt=False):
+    class Default(dict):
+        def __missing__(self, key):
+            return None
+    if data is None or data == "":
+        return None
+    if isInt:
+        i = str(data).translate(Default(zip((ord(c) for c in "1234567890"),"1234567890")))
+        if i == "0":
+            return "0"
+        if i is "":
+            return None
+        return int(i)
+    else:
+        return str(data)
+
+
+def removearticles(text):
+    text = text.lower()
+    articles = ['and', 'a', '&', 'issue', 'the']
+    newText = ''
+    for word in text.split(' '):
+        if word not in articles:
+            newText += word + ' '
+
+    newText = newText[:-1]
+
+    return newText
+
+
+def sanitize_title(text):
+    # normalize unicode and convert to ascii. Does not work for everything eg ½ to 1⁄2 not 1/2
+    # this will probably cause issues with titles in other character sets e.g. chinese, japanese
+    text = unicodedata.normalize('NFKD', text).encode('ascii', 'ignore').decode('ascii')
+    # comicvine keeps apostrophes a part of the word
+    text = text.replace("'", "")
+    text = text.replace("\"", "")
+    # comicvine ignores punctuation and accents
+    text = re.sub(r'[^A-Za-z0-9]+',' ', text)
+    # remove extra space and articles and all lower case
+    text = removearticles(text).lower().strip()
+
+    return text
+
+
+def unique_file(file_name):
+    counter = 1
+    # returns ('/path/file', '.ext')
+    file_name_parts = os.path.splitext(file_name)
+    while True:
+        if not os.path.lexists(file_name):
+            return file_name
+        file_name = file_name_parts[
+            0] + ' (' + str(counter) + ')' + file_name_parts[1]
+        counter += 1
+
+
+# -o- coding: utf-8 -o-
+# ISO639 python dict
+# official list in http://www.loc.gov/standards/iso639-2/php/code_list.php
+
+lang_dict = {
+    'ab': 'Abkhaz',
+    'aa': 'Afar',
+    'af': 'Afrikaans',
+    'ak': 'Akan',
+    'sq': 'Albanian',
+    'am': 'Amharic',
+    'ar': 'Arabic',
+    'an': 'Aragonese',
+    'hy': 'Armenian',
+    'as': 'Assamese',
+    'av': 'Avaric',
+    'ae': 'Avestan',
+    'ay': 'Aymara',
+    'az': 'Azerbaijani',
+    'bm': 'Bambara',
+    'ba': 'Bashkir',
+    'eu': 'Basque',
+    'be': 'Belarusian',
+    'bn': 'Bengali',
+    'bh': 'Bihari',
+    'bi': 'Bislama',
+    'bs': 'Bosnian',
+    'br': 'Breton',
+    'bg': 'Bulgarian',
+    'my': 'Burmese',
+    'ca': 'Catalan; Valencian',
+    'ch': 'Chamorro',
+    'ce': 'Chechen',
+    'ny': 'Chichewa; Chewa; Nyanja',
+    'zh': 'Chinese',
+    'cv': 'Chuvash',
+    'kw': 'Cornish',
+    'co': 'Corsican',
+    'cr': 'Cree',
+    'hr': 'Croatian',
+    'cs': 'Czech',
+    'da': 'Danish',
+    'dv': 'Divehi; Maldivian;',
+    'nl': 'Dutch',
+    'dz': 'Dzongkha',
+    'en': 'English',
+    'eo': 'Esperanto',
+    'et': 'Estonian',
+    'ee': 'Ewe',
+    'fo': 'Faroese',
+    'fj': 'Fijian',
+    'fi': 'Finnish',
+    'fr': 'French',
+    'ff': 'Fula',
+    'gl': 'Galician',
+    'ka': 'Georgian',
+    'de': 'German',
+    'el': 'Greek, Modern',
+    'gn': 'Guaraní',
+    'gu': 'Gujarati',
+    'ht': 'Haitian',
+    'ha': 'Hausa',
+    'he': 'Hebrew (modern)',
+    'hz': 'Herero',
+    'hi': 'Hindi',
+    'ho': 'Hiri Motu',
+    'hu': 'Hungarian',
+    'ia': 'Interlingua',
+    'id': 'Indonesian',
+    'ie': 'Interlingue',
+    'ga': 'Irish',
+    'ig': 'Igbo',
+    'ik': 'Inupiaq',
+    'io': 'Ido',
+    'is': 'Icelandic',
+    'it': 'Italian',
+    'iu': 'Inuktitut',
+    'ja': 'Japanese',
+    'jv': 'Javanese',
+    'kl': 'Kalaallisut',
+    'kn': 'Kannada',
+    'kr': 'Kanuri',
+    'ks': 'Kashmiri',
+    'kk': 'Kazakh',
+    'km': 'Khmer',
+    'ki': 'Kikuyu, Gikuyu',
+    'rw': 'Kinyarwanda',
+    'ky': 'Kirghiz, Kyrgyz',
+    'kv': 'Komi',
+    'kg': 'Kongo',
+    'ko': 'Korean',
+    'ku': 'Kurdish',
+    'kj': 'Kwanyama, Kuanyama',
+    'la': 'Latin',
+    'lb': 'Luxembourgish',
+    'lg': 'Luganda',
+    'li': 'Limburgish',
+    'ln': 'Lingala',
+    'lo': 'Lao',
+    'lt': 'Lithuanian',
+    'lu': 'Luba-Katanga',
+    'lv': 'Latvian',
+    'gv': 'Manx',
+    'mk': 'Macedonian',
+    'mg': 'Malagasy',
+    'ms': 'Malay',
+    'ml': 'Malayalam',
+    'mt': 'Maltese',
+    'mi': 'Māori',
+    'mr': 'Marathi (Marāṭhī)',
+    'mh': 'Marshallese',
+    'mn': 'Mongolian',
+    'na': 'Nauru',
+    'nv': 'Navajo, Navaho',
+    'nb': 'Norwegian Bokmål',
+    'nd': 'North Ndebele',
+    'ne': 'Nepali',
+    'ng': 'Ndonga',
+    'nn': 'Norwegian Nynorsk',
+    'no': 'Norwegian',
+    'ii': 'Nuosu',
+    'nr': 'South Ndebele',
+    'oc': 'Occitan',
+    'oj': 'Ojibwe, Ojibwa',
+    'cu': 'Old Church Slavonic',
+    'om': 'Oromo',
+    'or': 'Oriya',
+    'os': 'Ossetian, Ossetic',
+    'pa': 'Panjabi, Punjabi',
+    'pi': 'Pāli',
+    'fa': 'Persian',
+    'pl': 'Polish',
+    'ps': 'Pashto, Pushto',
+    'pt': 'Portuguese',
+    'qu': 'Quechua',
+    'rm': 'Romansh',
+    'rn': 'Kirundi',
+    'ro': 'Romanian, Moldavan',
+    'ru': 'Russian',
+    'sa': 'Sanskrit (Saṁskṛta)',
+    'sc': 'Sardinian',
+    'sd': 'Sindhi',
+    'se': 'Northern Sami',
+    'sm': 'Samoan',
+    'sg': 'Sango',
+    'sr': 'Serbian',
+    'gd': 'Scottish Gaelic',
+    'sn': 'Shona',
+    'si': 'Sinhala, Sinhalese',
+    'sk': 'Slovak',
+    'sl': 'Slovene',
+    'so': 'Somali',
+    'st': 'Southern Sotho',
+    'es': 'Spanish; Castilian',
+    'su': 'Sundanese',
+    'sw': 'Swahili',
+    'ss': 'Swati',
+    'sv': 'Swedish',
+    'ta': 'Tamil',
+    'te': 'Telugu',
+    'tg': 'Tajik',
+    'th': 'Thai',
+    'ti': 'Tigrinya',
+    'bo': 'Tibetan',
+    'tk': 'Turkmen',
+    'tl': 'Tagalog',
+    'tn': 'Tswana',
+    'to': 'Tonga',
+    'tr': 'Turkish',
+    'ts': 'Tsonga',
+    'tt': 'Tatar',
+    'tw': 'Twi',
+    'ty': 'Tahitian',
+    'ug': 'Uighur, Uyghur',
+    'uk': 'Ukrainian',
+    'ur': 'Urdu',
+    'uz': 'Uzbek',
+    've': 'Venda',
+    'vi': 'Vietnamese',
+    'vo': 'Volapük',
+    'wa': 'Walloon',
+    'cy': 'Welsh',
+    'wo': 'Wolof',
+    'fy': 'Western Frisian',
+    'xh': 'Xhosa',
+    'yi': 'Yiddish',
+    'yo': 'Yoruba',
+    'za': 'Zhuang, Chuang',
+    'zu': 'Zulu',
+}
+
+
+countries = [
+    ('AF', 'Afghanistan'),
+    ('AL', 'Albania'),
+    ('DZ', 'Algeria'),
+    ('AS', 'American Samoa'),
+    ('AD', 'Andorra'),
+    ('AO', 'Angola'),
+    ('AI', 'Anguilla'),
+    ('AQ', 'Antarctica'),
+    ('AG', 'Antigua And Barbuda'),
+    ('AR', 'Argentina'),
+    ('AM', 'Armenia'),
+    ('AW', 'Aruba'),
+    ('AU', 'Australia'),
+    ('AT', 'Austria'),
+    ('AZ', 'Azerbaijan'),
+    ('BS', 'Bahamas'),
+    ('BH', 'Bahrain'),
+    ('BD', 'Bangladesh'),
+    ('BB', 'Barbados'),
+    ('BY', 'Belarus'),
+    ('BE', 'Belgium'),
+    ('BZ', 'Belize'),
+    ('BJ', 'Benin'),
+    ('BM', 'Bermuda'),
+    ('BT', 'Bhutan'),
+    ('BO', 'Bolivia'),
+    ('BA', 'Bosnia And Herzegowina'),
+    ('BW', 'Botswana'),
+    ('BV', 'Bouvet Island'),
+    ('BR', 'Brazil'),
+    ('BN', 'Brunei Darussalam'),
+    ('BG', 'Bulgaria'),
+    ('BF', 'Burkina Faso'),
+    ('BI', 'Burundi'),
+    ('KH', 'Cambodia'),
+    ('CM', 'Cameroon'),
+    ('CA', 'Canada'),
+    ('CV', 'Cape Verde'),
+    ('KY', 'Cayman Islands'),
+    ('CF', 'Central African Rep'),
+    ('TD', 'Chad'),
+    ('CL', 'Chile'),
+    ('CN', 'China'),
+    ('CX', 'Christmas Island'),
+    ('CC', 'Cocos Islands'),
+    ('CO', 'Colombia'),
+    ('KM', 'Comoros'),
+    ('CG', 'Congo'),
+    ('CK', 'Cook Islands'),
+    ('CR', 'Costa Rica'),
+    ('CI', 'Cote D`ivoire'),
+    ('HR', 'Croatia'),
+    ('CU', 'Cuba'),
+    ('CY', 'Cyprus'),
+    ('CZ', 'Czech Republic'),
+    ('DK', 'Denmark'),
+    ('DJ', 'Djibouti'),
+    ('DM', 'Dominica'),
+    ('DO', 'Dominican Republic'),
+    ('TP', 'East Timor'),
+    ('EC', 'Ecuador'),
+    ('EG', 'Egypt'),
+    ('SV', 'El Salvador'),
+    ('GQ', 'Equatorial Guinea'),
+    ('ER', 'Eritrea'),
+    ('EE', 'Estonia'),
+    ('ET', 'Ethiopia'),
+    ('FK', 'Falkland Islands (Malvinas)'),
+    ('FO', 'Faroe Islands'),
+    ('FJ', 'Fiji'),
+    ('FI', 'Finland'),
+    ('FR', 'France'),
+    ('GF', 'French Guiana'),
+    ('PF', 'French Polynesia'),
+    ('TF', 'French S. Territories'),
+    ('GA', 'Gabon'),
+    ('GM', 'Gambia'),
+    ('GE', 'Georgia'),
+    ('DE', 'Germany'),
+    ('GH', 'Ghana'),
+    ('GI', 'Gibraltar'),
+    ('GR', 'Greece'),
+    ('GL', 'Greenland'),
+    ('GD', 'Grenada'),
+    ('GP', 'Guadeloupe'),
+    ('GU', 'Guam'),
+    ('GT', 'Guatemala'),
+    ('GN', 'Guinea'),
+    ('GW', 'Guinea-bissau'),
+    ('GY', 'Guyana'),
+    ('HT', 'Haiti'),
+    ('HN', 'Honduras'),
+    ('HK', 'Hong Kong'),
+    ('HU', 'Hungary'),
+    ('IS', 'Iceland'),
+    ('IN', 'India'),
+    ('ID', 'Indonesia'),
+    ('IR', 'Iran'),
+    ('IQ', 'Iraq'),
+    ('IE', 'Ireland'),
+    ('IL', 'Israel'),
+    ('IT', 'Italy'),
+    ('JM', 'Jamaica'),
+    ('JP', 'Japan'),
+    ('JO', 'Jordan'),
+    ('KZ', 'Kazakhstan'),
+    ('KE', 'Kenya'),
+    ('KI', 'Kiribati'),
+    ('KP', 'Korea (North)'),
+    ('KR', 'Korea (South)'),
+    ('KW', 'Kuwait'),
+    ('KG', 'Kyrgyzstan'),
+    ('LA', 'Laos'),
+    ('LV', 'Latvia'),
+    ('LB', 'Lebanon'),
+    ('LS', 'Lesotho'),
+    ('LR', 'Liberia'),
+    ('LY', 'Libya'),
+    ('LI', 'Liechtenstein'),
+    ('LT', 'Lithuania'),
+    ('LU', 'Luxembourg'),
+    ('MO', 'Macau'),
+    ('MK', 'Macedonia'),
+    ('MG', 'Madagascar'),
+    ('MW', 'Malawi'),
+    ('MY', 'Malaysia'),
+    ('MV', 'Maldives'),
+    ('ML', 'Mali'),
+    ('MT', 'Malta'),
+    ('MH', 'Marshall Islands'),
+    ('MQ', 'Martinique'),
+    ('MR', 'Mauritania'),
+    ('MU', 'Mauritius'),
+    ('YT', 'Mayotte'),
+    ('MX', 'Mexico'),
+    ('FM', 'Micronesia'),
+    ('MD', 'Moldova'),
+    ('MC', 'Monaco'),
+    ('MN', 'Mongolia'),
+    ('MS', 'Montserrat'),
+    ('MA', 'Morocco'),
+    ('MZ', 'Mozambique'),
+    ('MM', 'Myanmar'),
+    ('NA', 'Namibia'),
+    ('NR', 'Nauru'),
+    ('NP', 'Nepal'),
+    ('NL', 'Netherlands'),
+    ('AN', 'Netherlands Antilles'),
+    ('NC', 'New Caledonia'),
+    ('NZ', 'New Zealand'),
+    ('NI', 'Nicaragua'),
+    ('NE', 'Niger'),
+    ('NG', 'Nigeria'),
+    ('NU', 'Niue'),
+    ('NF', 'Norfolk Island'),
+    ('MP', 'Northern Mariana Islands'),
+    ('NO', 'Norway'),
+    ('OM', 'Oman'),
+    ('PK', 'Pakistan'),
+    ('PW', 'Palau'),
+    ('PA', 'Panama'),
+    ('PG', 'Papua New Guinea'),
+    ('PY', 'Paraguay'),
+    ('PE', 'Peru'),
+    ('PH', 'Philippines'),
+    ('PN', 'Pitcairn'),
+    ('PL', 'Poland'),
+    ('PT', 'Portugal'),
+    ('PR', 'Puerto Rico'),
+    ('QA', 'Qatar'),
+    ('RE', 'Reunion'),
+    ('RO', 'Romania'),
+    ('RU', 'Russian Federation'),
+    ('RW', 'Rwanda'),
+    ('KN', 'Saint Kitts And Nevis'),
+    ('LC', 'Saint Lucia'),
+    ('VC', 'St Vincent/Grenadines'),
+    ('WS', 'Samoa'),
+    ('SM', 'San Marino'),
+    ('ST', 'Sao Tome'),
+    ('SA', 'Saudi Arabia'),
+    ('SN', 'Senegal'),
+    ('SC', 'Seychelles'),
+    ('SL', 'Sierra Leone'),
+    ('SG', 'Singapore'),
+    ('SK', 'Slovakia'),
+    ('SI', 'Slovenia'),
+    ('SB', 'Solomon Islands'),
+    ('SO', 'Somalia'),
+    ('ZA', 'South Africa'),
+    ('ES', 'Spain'),
+    ('LK', 'Sri Lanka'),
+    ('SH', 'St. Helena'),
+    ('PM', 'St.Pierre'),
+    ('SD', 'Sudan'),
+    ('SR', 'Suriname'),
+    ('SZ', 'Swaziland'),
+    ('SE', 'Sweden'),
+    ('CH', 'Switzerland'),
+    ('SY', 'Syrian Arab Republic'),
+    ('TW', 'Taiwan'),
+    ('TJ', 'Tajikistan'),
+    ('TZ', 'Tanzania'),
+    ('TH', 'Thailand'),
+    ('TG', 'Togo'),
+    ('TK', 'Tokelau'),
+    ('TO', 'Tonga'),
+    ('TT', 'Trinidad And Tobago'),
+    ('TN', 'Tunisia'),
+    ('TR', 'Turkey'),
+    ('TM', 'Turkmenistan'),
+    ('TV', 'Tuvalu'),
+    ('UG', 'Uganda'),
+    ('UA', 'Ukraine'),
+    ('AE', 'United Arab Emirates'),
+    ('UK', 'United Kingdom'),
+    ('US', 'United States'),
+    ('UY', 'Uruguay'),
+    ('UZ', 'Uzbekistan'),
+    ('VU', 'Vanuatu'),
+    ('VA', 'Vatican City State'),
+    ('VE', 'Venezuela'),
+    ('VN', 'Viet Nam'),
+    ('VG', 'Virgin Islands (British)'),
+    ('VI', 'Virgin Islands (U.S.)'),
+    ('EH', 'Western Sahara'),
+    ('YE', 'Yemen'),
+    ('YU', 'Yugoslavia'),
+    ('ZR', 'Zaire'),
+    ('ZM', 'Zambia'),
+    ('ZW', 'Zimbabwe')
+]
+
+
+def getLanguageDict():
+    return lang_dict
+
+
+def getLanguageFromISO(iso):
+    if iso is None:
+        return None
+    else:
+        return lang_dict[iso]

comictagger.py

@@ -1,5 +1,5 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 from comictaggerlib.main import ctmain
 
 if __name__ == '__main__':
-	ctmain()
+    ctmain()

comictagger.spec

@@ -0,0 +1,50 @@
+# -*- mode: python -*-
+
+import platform
+from os.path import join
+from comictaggerlib import ctversion
+
+enable_console = False
+binaries = []
+block_cipher = None
+
+if platform.system() == "Windows":
+    enable_console = True
+
+a = Analysis(['comictagger.py'],
+             binaries=binaries,
+             datas=[('comictaggerlib/ui/*.ui', 'ui'), ('comictaggerlib/graphics', 'graphics')],
+             hiddenimports=['PIL'],
+             hookspath=[],
+             runtime_hooks=[],
+             excludes=[],
+             win_no_prefer_redirects=False,
+             win_private_assemblies=False,
+             cipher=block_cipher)
+pyz = PYZ(a.pure, a.zipped_data,
+             cipher=block_cipher)
+exe = EXE(pyz,
+          a.scripts,
+          a.binaries,
+          a.zipfiles,
+          a.datas,
+          # single file setup
+          exclude_binaries=False,
+          name='comictagger',
+          debug=False,
+          strip=False,
+          upx=True,
+          console=enable_console,
+          icon="windows/app.ico" )
+
+app = BUNDLE(exe,
+            name='ComicTagger.app',
+            icon='mac/app.icns',
+            info_plist={
+                'NSHighResolutionCapable': 'True',
+                'NSRequiresAquaSystemAppearance': 'False',
+                'CFBundleDisplayName': 'ComicTagger',
+                'CFBundleShortVersionString': ctversion.version,
+                'CFBundleVersion': ctversion.version
+            },
+            bundle_identifier=None)

comictaggerlib/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

comictaggerlib/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

comictaggerlib/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.
-

comictaggerlib/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.

comictaggerlib/UnRAR2/UnRARDLL/x64/readme.txt

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

comictaggerlib/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
-
-

comictaggerlib/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

comictaggerlib/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

comictaggerlib/UnRAR2/unix.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.
-
-# 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
-                #!!!ATB - changed this because it was choking when a folder or file started with a space.
-                #!!!      now, just strip off the first char in the string
-                data['filename'] = accum[0].rstrip()[1:]
-                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
-
-    

comictaggerlib/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
-
-

comictaggerlib/autotagmatchwindow.py

@@ -1,233 +1,245 @@
-"""
-A PyQT4 dialog to select from automated issue matches
-"""
+"""A PyQT4 dialog to select from automated issue matches"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
+#import sys
 
-from PyQt4.QtCore import QUrl, pyqtSignal, QByteArray
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+#from PyQt5.QtCore import QUrl, pyqtSignal, QByteArray
 
-from imagefetcher import  ImageFetcher
-from settings import ComicTaggerSettings
-from comicarchive import MetaDataStyle
-from coverimagewidget import CoverImageWidget
-from comicvinetalker import ComicVineTalker
-import utils
+from .settings import ComicTaggerSettings
+from .comicarchive import MetaDataStyle
+from .coverimagewidget import CoverImageWidget
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
+#from imagefetcher import ImageFetcher
+#from comicvinetalker import ComicVineTalker
+#import utils
 
-class AutoTagMatchWindow(QtGui.QDialog):
-	
-	volume_id = 0
-	
-	def __init__(self, parent, match_set_list, style, fetch_func):
-		super(AutoTagMatchWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('matchselectionwindow.ui' ), self)
 
-		self.altCoverWidget = CoverImageWidget( self.altCoverContainer, CoverImageWidget.AltCoverMode )
-		gridlayout = QtGui.QGridLayout( self.altCoverContainer )
-		gridlayout.addWidget( self.altCoverWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
+class AutoTagMatchWindow(QtWidgets.QDialog):
 
-		self.archiveCoverWidget = CoverImageWidget( self.archiveCoverContainer, CoverImageWidget.ArchiveMode )
-		gridlayout = QtGui.QGridLayout( self.archiveCoverContainer )
-		gridlayout.addWidget( self.archiveCoverWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
+    volume_id = 0
 
-		utils.reduceWidgetFontSize( self.twList )		
-		utils.reduceWidgetFontSize( self.teDescription, 1 )
+    def __init__(self, parent, match_set_list, style, fetch_func):
+        super(AutoTagMatchWindow, self).__init__(parent)
 
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)		
-				
-		self.skipButton = QtGui.QPushButton(self.tr("Skip to Next"))
-		self.buttonBox.addButton(self.skipButton, QtGui.QDialogButtonBox.ActionRole)		
-		self.buttonBox.button(QtGui.QDialogButtonBox.Ok).setText("Accept and Write Tags")		
+        uic.loadUi(
+            ComicTaggerSettings.getUIFile('matchselectionwindow.ui'), self)
 
-		self.match_set_list = match_set_list
-		self.style = style
-		self.fetch_func = fetch_func
+        self.altCoverWidget = CoverImageWidget(
+            self.altCoverContainer, CoverImageWidget.AltCoverMode)
+        gridlayout = QtWidgets.QGridLayout(self.altCoverContainer)
+        gridlayout.addWidget(self.altCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
 
-		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()		
+        self.archiveCoverWidget = CoverImageWidget(
+            self.archiveCoverContainer, CoverImageWidget.ArchiveMode)
+        gridlayout = QtWidgets.QGridLayout(self.archiveCoverContainer)
+        gridlayout.addWidget(self.archiveCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
 
-	def updateData( self):
+        reduceWidgetFontSize(self.twList)
+        reduceWidgetFontSize(self.teDescription, 1)
 
-		self.current_match_set = self.match_set_list[ self.current_match_set_idx ]
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
 
-		if self.current_match_set_idx + 1 == len( self.match_set_list ):
-			self.buttonBox.button(QtGui.QDialogButtonBox.Cancel).setDisabled(True)	
-			#self.buttonBox.button(QtGui.QDialogButtonBox.Ok).setText("Accept")		
-			self.skipButton.setText(self.tr("Skip"))
-			
-		self.setCoverImage()
-		self.populateTable()
-		self.twList.resizeColumnsToContents()	
-		self.twList.selectRow( 0 )
-		
-		path = self.current_match_set.ca.path
-		self.setWindowTitle( u"Select correct match or skip ({0} of {1}): {2}".format(
-						self.current_match_set_idx+1,
-						len( self.match_set_list ),
-						os.path.split(path)[1] ))
-		
-	def populateTable( self  ):
+        self.skipButton = QtWidgets.QPushButton(self.tr("Skip to Next"))
+        self.buttonBox.addButton(
+            self.skipButton, QtWidgets.QDialogButtonBox.ActionRole)
+        self.buttonBox.button(QtWidgets.QDialogButtonBox.Ok).setText(
+            "Accept and Write Tags")
 
-		while self.twList.rowCount() > 0:
-			self.twList.removeRow(0)
-		
-		self.twList.setSortingEnabled(False)
+        self.match_set_list = match_set_list
+        self.style = style
+        self.fetch_func = fetch_func
 
-		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.setData( QtCore.Qt.UserRole, (match,))
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 0, item)
+        self.current_match_set_idx = 0
 
-			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)
-			
-			month_str = u""
-			year_str = u"????"
-			if match['month'] is not None:
-				month_str = u"-{0:02d}".format(int(match['month']))
-			if match['year'] is not None:
-				year_str = u"{0}".format(match['year'])
+        self.twList.currentItemChanged.connect(self.currentItemChanged)
+        self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
+        self.skipButton.clicked.connect(self.skipToNext)
 
-			item_text = year_str + month_str			
-			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)
+        self.updateData()
 
-			item_text = match['issue_title']
-			if item_text is None:
-				item_text = ""
-			item = QtGui.QTableWidgetItem(item_text)			
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 3, item)
-			
-			row += 1
+    def updateData(self):
 
-		self.twList.resizeColumnsToContents()
-		self.twList.setSortingEnabled(True)
-		self.twList.sortItems( 2 , QtCore.Qt.AscendingOrder )
-		self.twList.selectRow(0)
-		self.twList.resizeColumnsToContents()
-		self.twList.horizontalHeader().setStretchLastSection(True) 
-			
+        self.current_match_set = self.match_set_list[
+            self.current_match_set_idx]
 
-	def cellDoubleClicked( self, r, c ):
-		self.accept()
-			
-	def currentItemChanged( self, curr, prev ):
+        if self.current_match_set_idx + 1 == len(self.match_set_list):
+            self.buttonBox.button(
+                QtWidgets.QDialogButtonBox.Cancel).setDisabled(True)
+            # self.buttonBox.button(QtWidgets.QDialogButtonBox.Ok).setText("Accept")
+            self.skipButton.setText(self.tr("Skip"))
 
-		if curr is None:
-			return
-		if prev is not None and prev.row() == curr.row():
-				return
-		
-		self.altCoverWidget.setIssueID( self.currentMatch()['issue_id'] )
-		if self.currentMatch()['description'] is None:
-			self.teDescription.setText ( "" )
-		else:	
-			self.teDescription.setText ( self.currentMatch()['description'] )
-		
-	def setCoverImage( self ):
-		ca = self.current_match_set.ca
-		self.archiveCoverWidget.setArchive(ca)
+        self.setCoverImage()
+        self.populateTable()
+        self.twList.resizeColumnsToContents()
+        self.twList.selectRow(0)
 
-	def currentMatch( self ):
-		row = self.twList.currentRow()
-		match = self.twList.item(row, 0).data( QtCore.Qt.UserRole ).toPyObject()[0]
-		return match
-	
-	def accept(self):
+        path = self.current_match_set.ca.path
+        self.setWindowTitle(
+            "Select correct match or skip ({0} of {1}): {2}".format(
+                self.current_match_set_idx + 1,
+                len(self.match_set_list),
+                os.path.split(path)[1])
+        )
 
-		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 populateTable(self):
 
-	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
+        while self.twList.rowCount() > 0:
+            self.twList.removeRow(0)
 
-		QtGui.QDialog.reject(self)				
-			
-	def saveMatch( self ):
-		
-		match = self.currentMatch()
-		ca = self.current_match_set.ca
+        self.twList.setSortingEnabled(False)
 
-		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
+        row = 0
+        for match in self.current_match_set.matches:
+            self.twList.insertRow(row)
 
-		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!"))
+            item_text = match['series']
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.UserRole, (match,))
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 0, item)
+
+            if match['publisher'] is not None:
+                item_text = "{0}".format(match['publisher'])
+            else:
+                item_text = "Unknown"
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 1, item)
+
+            month_str = ""
+            year_str = "????"
+            if match['month'] is not None:
+                month_str = "-{0:02d}".format(int(match['month']))
+            if match['year'] is not None:
+                year_str = "{0}".format(match['year'])
+
+            item_text = year_str + month_str
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.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.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 3, item)
+
+            row += 1
+
+        self.twList.resizeColumnsToContents()
+        self.twList.setSortingEnabled(True)
+        self.twList.sortItems(2, QtCore.Qt.AscendingOrder)
+        self.twList.selectRow(0)
+        self.twList.resizeColumnsToContents()
+        self.twList.horizontalHeader().setStretchLastSection(True)
+
+    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.altCoverWidget.setIssueID(self.currentMatch()['issue_id'])
+        if self.currentMatch()['description'] is None:
+            self.teDescription.setText("")
+        else:
+            self.teDescription.setText(self.currentMatch()['description'])
+
+    def setCoverImage(self):
+        ca = self.current_match_set.ca
+        self.archiveCoverWidget.setArchive(ca)
+
+    def currentMatch(self):
+        row = self.twList.currentRow()
+        match = self.twList.item(row, 0).data(
+            QtCore.Qt.UserRole)[0]
+        return match
+
+    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
+            QtWidgets.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
+            QtWidgets.QDialog.reject(self)
+        else:
+            self.updateData()
+
+    def reject(self):
+        reply = QtWidgets.QMessageBox.question(
+            self,
+            self.tr("Cancel Matching"),
+            self.tr("Are you sure you wish to cancel the matching process?"),
+            QtWidgets.QMessageBox.Yes,
+            QtWidgets.QMessageBox.No)
+
+        if reply == QtWidgets.QMessageBox.No:
+            return
+
+        QtWidgets.QDialog.reject(self)
+
+    def saveMatch(self):
+
+        match = self.currentMatch()
+        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:
+            QtWidgets.QMessageBox.critical(self, self.tr("Network Issue"), self.tr(
+                "Could not connect to Comic Vine to get issue details!"))
+            return
+
+        QtWidgets.QApplication.setOverrideCursor(
+            QtGui.QCursor(QtCore.Qt.WaitCursor))
+        md.overlay(cv_md)
+        success = ca.writeMetadata(md, self.style)
+        ca.loadCache([MetaDataStyle.CBI, MetaDataStyle.CIX])
+
+        QtWidgets.QApplication.restoreOverrideCursor()
+
+        if not success:
+            QtWidgets.QMessageBox.warning(self, self.tr("Write Error"), self.tr(
+                "Saving the tags to the archive seemed to fail!"))

comictaggerlib/autotagprogresswindow.py

@@ -1,69 +1,69 @@
-"""
-A PyQT4 dialog to show ID log and progress
-"""
+"""A PyQT4 dialog to show ID log and progress"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
-from coverimagewidget import CoverImageWidget
-import utils
+#import sys
+#import os
 
-class AutoTagProgressWindow(QtGui.QDialog):
-	
-	
-	def __init__(self, parent):
-		super(AutoTagProgressWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('autotagprogresswindow.ui' ), self)
-		
-		self.archiveCoverWidget = CoverImageWidget( self.archiveCoverContainer, CoverImageWidget.DataMode, False )
-		gridlayout = QtGui.QGridLayout( self.archiveCoverContainer )
-		gridlayout.addWidget( self.archiveCoverWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-		self.testCoverWidget = CoverImageWidget( self.testCoverContainer, CoverImageWidget.DataMode, False )
-		gridlayout = QtGui.QGridLayout( self.testCoverContainer )
-		gridlayout.addWidget( self.testCoverWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
-				
-		self.isdone = False
+from .settings import ComicTaggerSettings
+from .coverimagewidget import CoverImageWidget
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
+#import utils
 
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)
 
-		utils.reduceWidgetFontSize( self.textEdit )	
-		
-	def setArchiveImage( self, img_data):
-		self.setCoverImage( img_data, self.archiveCoverWidget)
+class AutoTagProgressWindow(QtWidgets.QDialog):
 
-	def setTestImage( self, img_data):
-		self.setCoverImage( img_data, self.testCoverWidget)
+    def __init__(self, parent):
+        super(AutoTagProgressWindow, self).__init__(parent)
 
-	def setCoverImage( self, img_data , widget):
-		widget.setImageData( img_data )
-		QtCore.QCoreApplication.processEvents()
-		QtCore.QCoreApplication.processEvents()
-	
-	def reject(self):
-		QtGui.QDialog.reject(self)		
-		self.isdone = True
+        uic.loadUi(
+            ComicTaggerSettings.getUIFile('autotagprogresswindow.ui'), self)
 
-		
+        self.archiveCoverWidget = CoverImageWidget(
+            self.archiveCoverContainer, CoverImageWidget.DataMode, False)
+        gridlayout = QtWidgets.QGridLayout(self.archiveCoverContainer)
+        gridlayout.addWidget(self.archiveCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
+
+        self.testCoverWidget = CoverImageWidget(
+            self.testCoverContainer, CoverImageWidget.DataMode, False)
+        gridlayout = QtWidgets.QGridLayout(self.testCoverContainer)
+        gridlayout.addWidget(self.testCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
+
+        self.isdone = False
+
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
+
+        reduceWidgetFontSize(self.textEdit)
+
+    def setArchiveImage(self, img_data):
+        self.setCoverImage(img_data, self.archiveCoverWidget)
+
+    def setTestImage(self, img_data):
+        self.setCoverImage(img_data, self.testCoverWidget)
+
+    def setCoverImage(self, img_data, widget):
+        widget.setImageData(img_data)
+        QtCore.QCoreApplication.processEvents()
+        QtCore.QCoreApplication.processEvents()
+
+    def reject(self):
+        QtWidgets.QDialog.reject(self)
+        self.isdone = True

comictaggerlib/autotagstartwindow.py

@@ -1,104 +1,127 @@
-"""
-A PyQT4 dialog to confirm and set options for auto-tag
-"""
+"""A PyQT4 dialog to confirm and set options for auto-tag"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
+
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+
+from .settings import ComicTaggerSettings
+#from settingswindow import SettingsWindow
+#from filerenamer import FileRenamer
+#import utils
 
 
-from PyQt4 import QtCore, QtGui, uic
-from settings import ComicTaggerSettings
-from settingswindow import SettingsWindow
-from filerenamer import FileRenamer
-import os
-import utils
+class AutoTagStartWindow(QtWidgets.QDialog):
 
-	
-class AutoTagStartWindow(QtGui.QDialog):
-		
-	def __init__( self, parent,  settings, msg ):
-		super(AutoTagStartWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('autotagstartwindow.ui' ), self)
-		self.label.setText( msg )
+    def __init__(self, parent, settings, msg):
+        super(AutoTagStartWindow, self).__init__(parent)
 
-		self.setWindowFlags(self.windowFlags() &
-									  ~QtCore.Qt.WindowContextHelpButtonHint )
+        uic.loadUi(
+            ComicTaggerSettings.getUIFile('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 )
+        self.setWindowFlags(self.windowFlags() &
+                            ~QtCore.Qt.WindowContextHelpButtonHint)
 
-		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 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(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
+        self.settings = settings
 
-	def searchStringToggle(self):
-		enable = self.cbxSpecifySearchString.isChecked()
-		self.leSearchString.setEnabled( enable )
+        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)
 
-	
-	def accept( self ):
-		QtGui.QDialog.accept(self)		
+        if self.settings.save_on_low_confidence:
+            self.cbxSaveOnLowConfidence.setCheckState(QtCore.Qt.Checked)
+        if self.settings.dont_use_year_when_identifying:
+            self.cbxDontUseYear.setCheckState(QtCore.Qt.Checked)
+        if self.settings.assume_1_if_no_issue_num:
+            self.cbxAssumeIssueOne.setCheckState(QtCore.Qt.Checked)
+        if self.settings.ignore_leading_numbers_in_filename:
+            self.cbxIgnoreLeadingDigitsInFilename.setCheckState(
+                QtCore.Qt.Checked)
+        if self.settings.remove_archive_after_successful_match:
+            self.cbxRemoveAfterSuccess.setCheckState(QtCore.Qt.Checked)
+        if self.settings.wait_and_retry_on_rate_limit:
+            self.cbxWaitForRateLimit.setCheckState(QtCore.Qt.Checked)
 
-		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
-			
+        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 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(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.waitAndRetryOnRateLimit = 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):
+        QtWidgets.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())
+        self.waitAndRetryOnRateLimit = self.cbxWaitForRateLimit.isChecked()
+
+        # persist some settings
+        self.settings.save_on_low_confidence = self.autoSaveOnLow
+        self.settings.dont_use_year_when_identifying = self.dontUseYear
+        self.settings.assume_1_if_no_issue_num = self.assumeIssueOne
+        self.settings.ignore_leading_numbers_in_filename = self.ignoreLeadingDigitsInFilename
+        self.settings.remove_archive_after_successful_match = self.removeAfterSuccess
+        self.settings.wait_and_retry_on_rate_limit = self.waitAndRetryOnRateLimit
+
+        if self.cbxSpecifySearchString.isChecked():
+            self.searchString = str(self.leSearchString.text())
+            if len(self.searchString) == 0:
+                self.searchString = None

comictaggerlib/cbltransformer.py

@@ -1,99 +1,97 @@
-"""
-Class to manage modifying metadata specifically for CBL/CBI
-"""
+"""A class to manage modifying metadata specifically for CBL/CBI"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
+#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 )
+    def __init__(self, metadata, settings):
+        self.metadata = metadata
+        self.settings = settings
 
-		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 )		
+    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)
 
-		if self.settings.copy_characters_to_tags:
-			add_string_list_to_tags( self.metadata.characters )
+        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.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.assume_lone_credit_is_primary:
 
-		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
+            # 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
 
-		return self.metadata
+            # 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_storyarcs_to_tags:
+            add_string_list_to_tags(self.metadata.storyArc)
+
+        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

comictaggerlib/comet.py

@@ -1,260 +1 @@
-"""
-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 )
-
+from comicapi.comet import *

comictaggerlib/comicbookinfo.py

@@ -1,152 +1 @@
-"""
-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
-
+from comicapi.comicbookinfo import *

comictaggerlib/comicinfoxml.py

@@ -1,293 +1 @@
-"""
-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( 'Title', md.title )
-		assign( 'Series', md.series )
-		assign( 'Number', md.issue )
-		assign( 'Count', md.issueCount )
-		assign( 'Volume', md.volume )
-		assign( 'AlternateSeries', md.alternateSeries )
-		assign( 'AlternateNumber', md.alternateNumber )
-		assign( 'StoryArc', md.storyArc )
-		assign( 'SeriesGroup', md.seriesGroup )
-		assign( 'AlternateCount', md.alternateCount )
-		assign( 'Summary', md.comments )
-		assign( 'Notes', md.notes )
-		assign( 'Year', md.year )
-		assign( 'Month', md.month )
-		assign( 'Day', md.day )
-
-		# 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 )
-
-		assign( 'Publisher', md.publisher )
-		assign( 'Imprint', md.imprint )
-		assign( 'Genre', md.genre )
-		assign( 'Web', md.webLink )
-		assign( 'PageCount', md.pageCount )
-		assign( 'LanguageISO', md.language )
-		assign( 'Format', md.format )
-		assign( 'AgeRating', md.maturityRating )
-		if md.blackAndWhite is not None and md.blackAndWhite:
-			ET.SubElement(root, 'BlackAndWhite').text = "Yes"
-		assign( 'Manga', md.manga )
-		assign( 'Characters', md.characters )
-		assign( 'Teams', md.teams )
-		assign( 'Locations', md.locations )
-		assign( 'ScanInformation', md.scanInfo )
-
-		#  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.day =              xlate( 'Day' )
-		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' 
-			):
-				if n.text is not None:
-					for name in n.text.split(','):
-						metadata.addCredit( name.strip(), n.tag )
-
-			if n.tag == 'CoverArtist':
-				if n.text is not None:
-					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 )
-
+from comicapi.comicinfoxml import *

comictaggerlib/comicvinecacher.py

@@ -1,459 +1,469 @@
-"""
-A python class to manage caching of data from Comic Vine
-"""
+"""A python class to manage caching of data from Comic Vine"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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 pprint import pprint 
+# 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 sqlite3 as lite
-import sys
 import os
 import datetime
+#import sys
+#from pprint import pprint
+
+from . import ctversion
+from .settings import ComicTaggerSettings
+from . import utils
 
-import ctversion
-from settings import ComicTaggerSettings
-import utils
 
 class ComicVineCacher:
 
-	def __init__(self ):
-		self.settings_folder = ComicTaggerSettings.getSettingsFolder()
-		self.db_file = os.path.join( self.settings_folder, "cv_cache.db")
-		self.version_file = os.path.join( self.settings_folder, "cache_version.txt")
-		
-		#verify that cache is from same version as this one
-		data = ""
-		try:
-			with open( self.version_file, 'rb' ) as f: 
-				data = f.read()
-				f.close()
-		except:
-			pass
-		if data != ctversion.version:
-			self.clearCache()
-		
-		if not os.path.exists( self.db_file ):
-			self.create_cache_db()
+    def __init__(self):
+        self.settings_folder = ComicTaggerSettings.getSettingsFolder()
+        self.db_file = os.path.join(self.settings_folder, "cv_cache.db")
+        self.version_file = os.path.join(
+            self.settings_folder, "cache_version.txt")
 
-	def clearCache( self ):
-		try:
-			os.unlink( self.db_file )
-		except:
-			pass
-		try:
-			os.unlink( self.version_file )
-		except:
-			pass
+        # verify that cache is from same version as this one
+        data = ""
+        try:
+            with open(self.version_file, 'rb') as f:
+                data = f.read().decode("utf-8") 
+                f.close()
+        except:
+            pass
+        if data != ctversion.version:
+            self.clearCache()
 
-	def create_cache_db( self ):
-		
-		#create the version file
-		with open( self.version_file, 'w' ) as f:
-			f.write( ctversion.version )
-		
-		# this will wipe out any existing version
-		open( self.db_file, 'w').close()
+        if not os.path.exists(self.db_file):
+            self.create_cache_db()
 
-		con = lite.connect( self.db_file )
-		
-		# create tables 
-		with con:
-			
-			cur = con.cursor()    
-			#name,id,start_year,publisher,image,description,count_of_issues
-			cur.execute("CREATE TABLE VolumeSearchCache(" +
-							"search_term TEXT," +
-							"id INT," +
-							"name TEXT," +
-							"start_year INT," +
-							"publisher TEXT," +
-							"count_of_issues INT," +
-							"image_url TEXT," +
-							"description TEXT," +
-							"timestamp DATE DEFAULT (datetime('now','localtime')) ) " 
-						)
-						
-			cur.execute("CREATE TABLE Volumes(" +
-							"id INT," +
-							"name TEXT," +
-							"publisher TEXT," +
-							"count_of_issues INT," +
-							"start_year INT," +
-							"timestamp DATE DEFAULT (datetime('now','localtime')), " + 
-							"PRIMARY KEY (id) )" 
-						)
+    def clearCache(self):
+        try:
+            os.unlink(self.db_file)
+        except:
+            pass
+        try:
+            os.unlink(self.version_file)
+        except:
+            pass
 
-			cur.execute("CREATE TABLE AltCovers(" +
-							"issue_id INT," +
-							"url_list TEXT," +
-							"timestamp DATE DEFAULT (datetime('now','localtime')), " + 
-							"PRIMARY KEY (issue_id) )" 
-						)
+    def create_cache_db(self):
 
-			cur.execute("CREATE TABLE Issues(" +
-							"id INT," +
-							"volume_id INT," +
-							"name TEXT," +
-							"issue_number TEXT," +
-							"super_url TEXT," +
-							"thumb_url TEXT," +
-							"cover_date TEXT," +
-							"site_detail_url TEXT," +
-							"description TEXT," +
-							"timestamp DATE DEFAULT (datetime('now','localtime')), " + 
-							"PRIMARY KEY (id ) )" 
-						)
+        # create the version file
+        with open(self.version_file, 'w') as f:
+            f.write(ctversion.version)
 
-	def add_search_results( self, search_term, cv_search_results ):
-		
-		con = lite.connect( self.db_file )
+        # this will wipe out any existing version
+        open(self.db_file, 'w').close()
 
-		with con:
-			con.text_factory = unicode					
-			cur = con.cursor()    
-			
-			# remove all previous entries with this search term
-			cur.execute("DELETE FROM VolumeSearchCache WHERE search_term = ?", [ search_term.lower() ])
-			
-			# now add in new results
-			for record in cv_search_results:
-				timestamp = datetime.datetime.now()
+        con = lite.connect(self.db_file)
 
-				if record['publisher'] is None:
-					pub_name = ""
-				else:
-					pub_name = record['publisher']['name']
-					
-				if record['image'] is None:
-					url = ""
-				else:
-					url = record['image']['super_url']
-					
-				cur.execute("INSERT INTO VolumeSearchCache " +
-				            "(search_term, id, name, start_year, publisher, count_of_issues, image_url, description ) " +
-				            "VALUES( ?, ?, ?, ?, ?, ?, ?, ? )" ,
-								( search_term.lower(),
-								record['id'],
-								record['name'],
-								record['start_year'],
-								pub_name,
-								record['count_of_issues'],
-								url,
-								record['description']) 
-							)
-			
-	def get_search_results( self, search_term ):
-		
-		results = list()
-		con = lite.connect( self.db_file )
-		with con:
-			con.text_factory = unicode					
-			cur = con.cursor() 
-			
-			
-			# purge stale search results 
-			a_day_ago = datetime.datetime.today()-datetime.timedelta(days=1)
-			cur.execute( "DELETE FROM VolumeSearchCache WHERE timestamp  < ?", [ str(a_day_ago) ] )
-			
-			# fetch
-			cur.execute("SELECT * FROM VolumeSearchCache WHERE search_term=?", [ search_term.lower() ] )
-			rows = cur.fetchall()
-			# now process the results
-			for record in rows:
-				
-				result = dict()
-				result['id'] = record[1]
-				result['name'] = record[2]
-				result['start_year'] = record[3]
-				result['publisher'] = dict()
-				result['publisher']['name'] = record[4]
-				result['count_of_issues'] = record[5]
-				result['image'] = dict()
-				result['image']['super_url'] = record[6]
-				result['description'] = record[7]
-				
-				results.append(result)
-				
-		return results
+        # create tables
+        with con:
 
-	def add_alt_covers( self, issue_id, url_list ):
-		
-		con = lite.connect( self.db_file )
+            cur = con.cursor()
+            # name,id,start_year,publisher,image,description,count_of_issues
+            cur.execute(
+                "CREATE TABLE VolumeSearchCache(" +
+                "search_term TEXT," +
+                "id INT," +
+                "name TEXT," +
+                "start_year INT," +
+                "publisher TEXT," +
+                "count_of_issues INT," +
+                "image_url TEXT," +
+                "description TEXT," +
+                "timestamp DATE DEFAULT (datetime('now','localtime'))) ")
 
-		with con:
-			con.text_factory = unicode					
-			cur = con.cursor()    
-			
-			# remove all previous entries with this search term
-			cur.execute("DELETE FROM AltCovers WHERE issue_id = ?", [ issue_id ])
-			
-			url_list_str = utils.listToString(url_list)
-			# now add in new record				
-			cur.execute("INSERT INTO AltCovers " +
-						"(issue_id, url_list ) " +
-						"VALUES( ?, ? )" ,
-							( issue_id,
-							url_list_str) 
-						)
+            cur.execute(
+                "CREATE TABLE Volumes(" +
+                "id INT," +
+                "name TEXT," +
+                "publisher TEXT," +
+                "count_of_issues INT," +
+                "start_year INT," +
+                "timestamp DATE DEFAULT (datetime('now','localtime')), " +
+                "PRIMARY KEY (id))")
 
+            cur.execute(
+                "CREATE TABLE AltCovers(" +
+                "issue_id INT," +
+                "url_list TEXT," +
+                "timestamp DATE DEFAULT (datetime('now','localtime')), " +
+                "PRIMARY KEY (issue_id))")
 
-	def get_alt_covers( self, issue_id ):
-		
-		con = lite.connect( self.db_file )
-		with con:
-			cur = con.cursor() 
-			con.text_factory = unicode					
-			
-			# purge stale issue info - probably issue data won't change much....
-			a_month_ago = datetime.datetime.today()-datetime.timedelta(days=30)
-			cur.execute( "DELETE FROM AltCovers WHERE timestamp  < ?", [ str(a_month_ago) ] )
-			
-			cur.execute("SELECT url_list FROM AltCovers WHERE issue_id=?", [ issue_id ])
-			row = cur.fetchone()
-			if row is None :
-				return None
-			else:
-				url_list_str = row[0]
-				if len(url_list_str) == 0:
-					return []
-				raw_list = url_list_str.split(",")
-				url_list = []
-				for item in raw_list:
-					url_list.append( str(item).strip())
-				return url_list
-			
-	def add_volume_info( self, cv_volume_record ):
-		
-		con = lite.connect( self.db_file )
+            cur.execute(
+                "CREATE TABLE Issues(" +
+                "id INT," +
+                "volume_id INT," +
+                "name TEXT," +
+                "issue_number TEXT," +
+                "super_url TEXT," +
+                "thumb_url TEXT," +
+                "cover_date TEXT," +
+                "site_detail_url TEXT," +
+                "description TEXT," +
+                "timestamp DATE DEFAULT (datetime('now','localtime')), " +
+                "PRIMARY KEY (id))")
 
-		with con:
-			
-			cur = con.cursor()    
-			
-			timestamp = datetime.datetime.now()
-			
-			if cv_volume_record['publisher'] is None:
-				pub_name = ""
-			else:
-				pub_name = cv_volume_record['publisher']['name']
+    def add_search_results(self, search_term, cv_search_results):
 
-			data = { 
-						"name":            cv_volume_record['name'], 
-						"publisher":       pub_name, 
-						"count_of_issues": cv_volume_record['count_of_issues'],
-						"start_year":      cv_volume_record['start_year'], 
-						"timestamp":       timestamp 
-					}
-			self.upsert( cur, "volumes", "id", cv_volume_record['id'], data)
+        con = lite.connect(self.db_file)
 
+        with con:
+            con.text_factory = str
+            cur = con.cursor()
 
-	def add_volume_issues_info( self, volume_id, cv_volume_issues ):
-		
-		con = lite.connect( self.db_file )
+            # remove all previous entries with this search term
+            cur.execute(
+                "DELETE FROM VolumeSearchCache WHERE search_term = ?", [
+                    search_term.lower()])
 
-		with con:
-			
-			cur = con.cursor()    
-			
-			timestamp = datetime.datetime.now()
+            # now add in new results
+            for record in cv_search_results:
+                timestamp = datetime.datetime.now()
 
-			# add in issues
+                if record['publisher'] is None:
+                    pub_name = ""
+                else:
+                    pub_name = record['publisher']['name']
 
-			for issue in cv_volume_issues:
-				
-				data = { 
-						"volume_id":       volume_id,
-						"name":            issue['name'], 
-						"issue_number":    issue['issue_number'],
-						"site_detail_url": issue['site_detail_url'],
-						"cover_date":      issue['cover_date'],
-						"super_url":       issue['image']['super_url'],
-						"thumb_url":       issue['image']['thumb_url'],
-						"description":     issue['description'],
-						"timestamp":    timestamp 
-				       }
-				self.upsert( cur, "issues" , "id", issue['id'], data)
-							
+                if record['image'] is None:
+                    url = ""
+                else:
+                    url = record['image']['super_url']
 
-	def get_volume_info( self, volume_id ):
-		
-		result = None
+                cur.execute(
+                    "INSERT INTO VolumeSearchCache " +
+                    "(search_term, id, name, start_year, publisher, count_of_issues, image_url, description) " +
+                    "VALUES(?, ?, ?, ?, ?, ?, ?, ?)",
+                    (search_term.lower(),
+                     record['id'],
+                        record['name'],
+                        record['start_year'],
+                        pub_name,
+                        record['count_of_issues'],
+                        url,
+                        record['description']))
 
-		con = lite.connect( self.db_file )
-		with con:
-			cur = con.cursor() 
-			con.text_factory = unicode					
-			
-			# purge stale volume info
-			a_week_ago = datetime.datetime.today()-datetime.timedelta(days=7)
-			cur.execute( "DELETE FROM Volumes WHERE timestamp  < ?", [ str(a_week_ago) ] )	
-			
-			# fetch
-			cur.execute("SELECT id,name,publisher,count_of_issues,start_year FROM Volumes WHERE id = ?", [ volume_id ] )
-			
-			row = cur.fetchone()
-			
-			if row is None :
-				return result
-			
-			result = dict()
-			
-			#since ID is primary key, there is only one row
-			result['id'] =                row[0]
-			result['name'] =              row[1]
-			result['publisher'] = dict()
-			result['publisher']['name'] = row[2]
-			result['count_of_issues'] =   row[3]
-			result['start_year'] =   row[4]
-			result['issues'] = list()
-		
-		return result
+    def get_search_results(self, search_term):
 
-	def get_volume_issues_info( self, volume_id ):
-	
-		result = None
+        results = list()
+        con = lite.connect(self.db_file)
+        with con:
+            con.text_factory = str
+            cur = con.cursor()
 
-		con = lite.connect( self.db_file )
-		with con:
-			cur = con.cursor() 
-			con.text_factory = unicode					
-			
-			# purge stale issue info - probably issue data won't change much....
-			a_week_ago = datetime.datetime.today()-datetime.timedelta(days=7)
-			cur.execute( "DELETE FROM Issues WHERE timestamp  < ?", [ str(a_week_ago) ] )	
-			
-			# fetch			
-			results = list()
-			
-			cur.execute("SELECT id,name,issue_number,site_detail_url,cover_date,super_url,thumb_url,description FROM Issues WHERE volume_id = ?", [ volume_id ] )
-			rows = cur.fetchall()
-			
-			# now process the results
-			for row in rows:
-				record = dict()
-				
-				record['id'] =                  row[0]
-				record['name'] =                row[1]
-				record['issue_number'] =        row[2]
-				record['site_detail_url'] =	    row[3]
-				record['cover_date'] =          row[4]
-				record['image'] = dict()
-				record['image']['super_url'] =  row[5]
-				record['image']['thumb_url'] =  row[6]
-				record['description'] =         row[7]
-				
-				results.append(record)
-		
-		if len(results) == 0:
-			return None
-			
-		return results
-	
+            # purge stale search results
+            a_day_ago = datetime.datetime.today() - datetime.timedelta(days=1)
+            cur.execute(
+                "DELETE FROM VolumeSearchCache WHERE timestamp  < ?", [
+                    str(a_day_ago)])
 
-	def add_issue_select_details( self, issue_id, image_url, thumb_image_url, cover_date, site_detail_url ):
-		
-		con = lite.connect( self.db_file )
+            # fetch
+            cur.execute(
+                "SELECT * FROM VolumeSearchCache WHERE search_term=?", [search_term.lower()])
+            rows = cur.fetchall()
+            # now process the results
+            for record in rows:
 
-		with con:
-			cur = con.cursor()    
-			con.text_factory = unicode					
-			timestamp = datetime.datetime.now()
-			
-			data = { 
-			          "super_url": image_url, 
-			          "thumb_url": thumb_image_url, 
-			          "cover_date": cover_date, 
-			          "site_detail_url": site_detail_url, 
-			          "timestamp": timestamp 
-			       }
-			self.upsert( cur, "issues" , "id", issue_id, data)
-			
-				
+                result = dict()
+                result['id'] = record[1]
+                result['name'] = record[2]
+                result['start_year'] = record[3]
+                result['publisher'] = dict()
+                result['publisher']['name'] = record[4]
+                result['count_of_issues'] = record[5]
+                result['image'] = dict()
+                result['image']['super_url'] = record[6]
+                result['description'] = record[7]
 
-	def get_issue_select_details( self, issue_id ):
-		
-		con = lite.connect( self.db_file )
-		with con:
-			cur = con.cursor() 
-			con.text_factory = unicode					
-			
-			cur.execute("SELECT super_url,thumb_url,cover_date,site_detail_url FROM Issues WHERE id=?", [ issue_id ])
-			row = cur.fetchone()
+                results.append(result)
 
-			details = dict()
-			if row is None or row[0] is None :
-				details['image_url'] = None
-				details['thumb_image_url'] = None
-				details['cover_date'] = None
-				details['site_detail_url'] = None
+        return results
 
-			else:
-				details['image_url'] = row[0]
-				details['thumb_image_url'] = row[1]
-				details['cover_date'] = row[2]
-				details['site_detail_url'] = row[3]
-				
-			return details
-			
-			
-	def upsert( self, cur, tablename, pkname, pkval, data):
-		"""
-		This does an insert if the given PK doesn't exist, and an update it if does
-		"""
-		
-		# TODO - look into checking if UPDATE is needed
-		# TODO - should the cursor be created here, and not up the stack?
-		
-		ins_count = len(data) + 1
+    def add_alt_covers(self, issue_id, url_list):
 
-		keys = ""
-		vals = list()
-		ins_slots = ""
-		set_slots = ""
-		
-		for key in data:
-			
-			if keys !=  "":
-				keys += ", "
-			if ins_slots !=  "":
-				ins_slots += ", "
-			if set_slots !=  "":
-				set_slots += ", "
-				
-			keys += key
-			vals.append( data[key] )
-			ins_slots += "?"
-			set_slots += key + " = ?"
+        con = lite.connect(self.db_file)
 
-		keys += ", " + pkname
-		vals.append( pkval )
-		ins_slots += ", ?"
-		condition = pkname + " = ?"
+        with con:
+            con.text_factory = str
+            cur = con.cursor()
 
-		sql_ins = ( "INSERT OR IGNORE INTO " + tablename  + 
-			" ( " + keys  + " ) " + 
-			" VALUES ( " +  ins_slots + " )"  )
-		cur.execute( sql_ins , vals )
-		
-		sql_upd =  ( "UPDATE " + tablename  + 
-			" SET " + set_slots + " WHERE " + condition )
-		cur.execute( sql_upd , vals )
+            # remove all previous entries with this search term
+            cur.execute("DELETE FROM AltCovers WHERE issue_id = ?", [issue_id])
 
+            url_list_str = utils.listToString(url_list)
+            # now add in new record
+            cur.execute("INSERT INTO AltCovers " +
+                        "(issue_id, url_list) " +
+                        "VALUES(?, ?)",
+                        (issue_id,
+                         url_list_str)
+                        )
 
+    def get_alt_covers(self, issue_id):
 
+        con = lite.connect(self.db_file)
+        with con:
+            cur = con.cursor()
+            con.text_factory = str
 
+            # purge stale issue info - probably issue data won't change
+            # much....
+            a_month_ago = datetime.datetime.today() - \
+                datetime.timedelta(days=30)
+            cur.execute(
+                "DELETE FROM AltCovers WHERE timestamp  < ?", [
+                    str(a_month_ago)])
+
+            cur.execute(
+                "SELECT url_list FROM AltCovers WHERE issue_id=?", [issue_id])
+            row = cur.fetchone()
+            if row is None:
+                return None
+            else:
+                url_list_str = row[0]
+                if len(url_list_str) == 0:
+                    return []
+                raw_list = url_list_str.split(",")
+                url_list = []
+                for item in raw_list:
+                    url_list.append(str(item).strip())
+                return url_list
+
+    def add_volume_info(self, cv_volume_record):
+
+        con = lite.connect(self.db_file)
+
+        with con:
+
+            cur = con.cursor()
+
+            timestamp = datetime.datetime.now()
+
+            if cv_volume_record['publisher'] is None:
+                pub_name = ""
+            else:
+                pub_name = cv_volume_record['publisher']['name']
+
+            data = {
+                "name": cv_volume_record['name'],
+                "publisher": pub_name,
+                "count_of_issues": cv_volume_record['count_of_issues'],
+                "start_year": cv_volume_record['start_year'],
+                "timestamp": timestamp
+            }
+            self.upsert(cur, "volumes", "id", cv_volume_record['id'], data)
+
+    def add_volume_issues_info(self, volume_id, cv_volume_issues):
+
+        con = lite.connect(self.db_file)
+
+        with con:
+
+            cur = con.cursor()
+
+            timestamp = datetime.datetime.now()
+
+            # add in issues
+
+            for issue in cv_volume_issues:
+
+                data = {
+                    "volume_id": volume_id,
+                    "name": issue['name'],
+                    "issue_number": issue['issue_number'],
+                    "site_detail_url": issue['site_detail_url'],
+                    "cover_date": issue['cover_date'],
+                    "super_url": issue['image']['super_url'],
+                    "thumb_url": issue['image']['thumb_url'],
+                    "description": issue['description'],
+                    "timestamp": timestamp
+                }
+                self.upsert(cur, "issues", "id", issue['id'], data)
+
+    def get_volume_info(self, volume_id):
+
+        result = None
+
+        con = lite.connect(self.db_file)
+        with con:
+            cur = con.cursor()
+            con.text_factory = str
+
+            # purge stale volume info
+            a_week_ago = datetime.datetime.today() - datetime.timedelta(days=7)
+            cur.execute(
+                "DELETE FROM Volumes WHERE timestamp  < ?", [str(a_week_ago)])
+
+            # fetch
+            cur.execute(
+                "SELECT id,name,publisher,count_of_issues,start_year FROM Volumes WHERE id = ?",
+                [volume_id])
+
+            row = cur.fetchone()
+
+            if row is None:
+                return result
+
+            result = dict()
+
+            # since ID is primary key, there is only one row
+            result['id'] = row[0]
+            result['name'] = row[1]
+            result['publisher'] = dict()
+            result['publisher']['name'] = row[2]
+            result['count_of_issues'] = row[3]
+            result['start_year'] = row[4]
+            result['issues'] = list()
+
+        return result
+
+    def get_volume_issues_info(self, volume_id):
+
+        result = None
+
+        con = lite.connect(self.db_file)
+        with con:
+            cur = con.cursor()
+            con.text_factory = str
+
+            # purge stale issue info - probably issue data won't change
+            # much....
+            a_week_ago = datetime.datetime.today() - datetime.timedelta(days=7)
+            cur.execute(
+                "DELETE FROM Issues WHERE timestamp  < ?", [str(a_week_ago)])
+
+            # fetch
+            results = list()
+
+            cur.execute(
+                "SELECT id,name,issue_number,site_detail_url,cover_date,super_url,thumb_url,description FROM Issues WHERE volume_id = ?",
+                [volume_id])
+            rows = cur.fetchall()
+
+            # now process the results
+            for row in rows:
+                record = dict()
+
+                record['id'] = row[0]
+                record['name'] = row[1]
+                record['issue_number'] = row[2]
+                record['site_detail_url'] = row[3]
+                record['cover_date'] = row[4]
+                record['image'] = dict()
+                record['image']['super_url'] = row[5]
+                record['image']['thumb_url'] = row[6]
+                record['description'] = row[7]
+
+                results.append(record)
+
+        if len(results) == 0:
+            return None
+
+        return results
+
+    def add_issue_select_details(
+            self,
+            issue_id,
+            image_url,
+            thumb_image_url,
+            cover_date,
+            site_detail_url):
+
+        con = lite.connect(self.db_file)
+
+        with con:
+            cur = con.cursor()
+            con.text_factory = str
+            timestamp = datetime.datetime.now()
+
+            data = {
+                "super_url": image_url,
+                "thumb_url": thumb_image_url,
+                "cover_date": cover_date,
+                "site_detail_url": site_detail_url,
+                "timestamp": timestamp
+            }
+            self.upsert(cur, "issues", "id", issue_id, data)
+
+    def get_issue_select_details(self, issue_id):
+
+        con = lite.connect(self.db_file)
+        with con:
+            cur = con.cursor()
+            con.text_factory = str
+
+            cur.execute(
+                "SELECT super_url,thumb_url,cover_date,site_detail_url FROM Issues WHERE id=?",
+                [issue_id])
+            row = cur.fetchone()
+
+            details = dict()
+            if row is None or row[0] is None:
+                details['image_url'] = None
+                details['thumb_image_url'] = None
+                details['cover_date'] = None
+                details['site_detail_url'] = None
+
+            else:
+                details['image_url'] = row[0]
+                details['thumb_image_url'] = row[1]
+                details['cover_date'] = row[2]
+                details['site_detail_url'] = row[3]
+
+            return details
+
+    def upsert(self, cur, tablename, pkname, pkval, data):
+        """This does an insert if the given PK doesn't exist, and an
+        update it if does
+
+        TODO: look into checking if UPDATE is needed
+        TODO: should the cursor be created here, and not up the stack?
+        """
+
+        ins_count = len(data) + 1
+
+        keys = ""
+        vals = list()
+        ins_slots = ""
+        set_slots = ""
+
+        for key in data:
+
+            if keys != "":
+                keys += ", "
+            if ins_slots != "":
+                ins_slots += ", "
+            if set_slots != "":
+                set_slots += ", "
+
+            keys += key
+            vals.append(data[key])
+            ins_slots += "?"
+            set_slots += key + " = ?"
+
+        keys += ", " + pkname
+        vals.append(pkval)
+        ins_slots += ", ?"
+        condition = pkname + " = ?"
+
+        sql_ins = ("INSERT OR IGNORE INTO " + tablename +
+                   " (" + keys + ") " +
+                   " VALUES (" + ins_slots + ")")
+        cur.execute(sql_ins, vals)
+
+        sql_upd = ("UPDATE " + tablename +
+                   " SET " + set_slots + " WHERE " + condition)
+        cur.execute(sql_upd, vals)

comictaggerlib/coverimagewidget.py

@@ -1,312 +1,326 @@
-"""
-A PyQt4 widget display cover images from either local archive, or from ComicVine
+"""A PyQt5 widget to display cover images
 
-(TODO: This should be re-factored using subclasses!)
+Display cover images from either a local archive, or from Comic Vine.
+TODO: This should be re-factored using subclasses!
 """
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 os
 
-from PyQt4.QtCore import *
-from PyQt4.QtGui import *
-from PyQt4 import uic
+from PyQt5.QtCore import *
+from PyQt5.QtWidgets import *
+from PyQt5.QtGui import *
+from PyQt5 import uic
+
+from .settings import ComicTaggerSettings
+from .comicvinetalker import ComicVineTalker, ComicVineTalkerException
+from .imagefetcher import ImageFetcher
+from .pageloader import PageLoader
+from .imagepopup import ImagePopup
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize, getQImageFromData
+#from genericmetadata import GenericMetadata, PageType
+#from comicarchive import MetaDataStyle
+#import utils
 
-from settings import ComicTaggerSettings
-from genericmetadata import GenericMetadata, PageType
-from comicarchive import MetaDataStyle
-from comicvinetalker import ComicVineTalker, ComicVineTalkerException
-from imagefetcher import  ImageFetcher
-from pageloader import PageLoader
-from imagepopup import ImagePopup
-import utils
 
-# helper func to allow a label to be clickable
 def clickable(widget):
+    """# Allow a label to be clickable"""
 
-	class Filter(QObject):
-	
-		dblclicked = pyqtSignal()
-		
-		def eventFilter(self, obj, event):
-		
-			if obj == widget:
-				if event.type() == QEvent.MouseButtonDblClick:
-					self.dblclicked.emit()
-					return True
-			
-			return False
-	
-	filter = Filter(widget)
-	widget.installEventFilter(filter)
-	return filter.dblclicked
+    class Filter(QObject):
+
+        dblclicked = pyqtSignal()
+
+        def eventFilter(self, obj, event):
+
+            if obj == widget:
+                if event.type() == QEvent.MouseButtonDblClick:
+                    self.dblclicked.emit()
+                    return True
+
+            return False
+
+    filter = Filter(widget)
+    widget.installEventFilter(filter)
+    return filter.dblclicked
 
 
 class CoverImageWidget(QWidget):
-	
-	ArchiveMode = 0
-	AltCoverMode = 1
-	URLMode = 1
-	DataMode = 3
-	
-	def __init__(self, parent, mode, expand_on_click = True ):
-		super(CoverImageWidget, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('coverimagewidget.ui' ), self)
 
-		utils.reduceWidgetFontSize( self.label )
+    ArchiveMode = 0
+    AltCoverMode = 1
+    URLMode = 1
+    DataMode = 3
 
-		self.mode = mode
-		self.comicVine = ComicVineTalker()
-		self.page_loader = None
-		self.showControls = True
+    def __init__(self, parent, mode, expand_on_click=True):
+        super(CoverImageWidget, self).__init__(parent)
 
-		self.btnLeft.setIcon(QIcon(ComicTaggerSettings.getGraphic('left.png')))
-		self.btnRight.setIcon(QIcon(ComicTaggerSettings.getGraphic('right.png')))
-		
-		self.btnLeft.clicked.connect( self.decrementImage )
-		self.btnRight.clicked.connect( self.incrementImage )
-		self.resetWidget()
-		if expand_on_click:
-			clickable(self.lblImage).connect(self.showPopup)
-		else:
-			self.lblImage.setToolTip( "" )
+        uic.loadUi(ComicTaggerSettings.getUIFile('coverimagewidget.ui'), self)
 
-		self.updateContent()
+        reduceWidgetFontSize(self.label)
 
-	def resetWidget(self):
-		self.comic_archive = None
-		self.issue_id = None
-		self.comicVine = None
-		self.cover_fetcher = 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 = None
-		
-	def clear( self ):
-		self.resetWidget()
-		self.updateContent()
-		
-	def incrementImage( self ):
-		self.imageIndex += 1
-		if self.imageIndex == self.imageCount:
-			self.imageIndex = 0
-		self.updateContent()
+        self.mode = mode
+        self.comicVine = ComicVineTalker()
+        self.page_loader = None
+        self.showControls = True
 
-	def decrementImage( self ):
-		self.imageIndex -= 1
-		if self.imageIndex == -1:
-			self.imageIndex = self.imageCount -1
-		self.updateContent()
-			
-	def setArchive( self, ca, page=0 ):
-		if self.mode == CoverImageWidget.ArchiveMode:
-			self.resetWidget()
-			self.comic_archive = ca
-			self.imageIndex = page
-			self.imageCount = ca.getNumberOfPages()
-			self.updateContent()
+        self.btnLeft.setIcon(QIcon(ComicTaggerSettings.getGraphic('left.png')))
+        self.btnRight.setIcon(
+            QIcon(ComicTaggerSettings.getGraphic('right.png')))
 
-	def setURL( self, url ):
-		if self.mode == CoverImageWidget.URLMode:
-			self.resetWidget()
-			self.updateContent()
-			
-			self.url_list = [ url ] 
-			self.imageIndex = 0
-			self.imageCount = 1
-			self.updateContent()
+        self.btnLeft.clicked.connect(self.decrementImage)
+        self.btnRight.clicked.connect(self.incrementImage)
+        self.resetWidget()
+        if expand_on_click:
+            clickable(self.lblImage).connect(self.showPopup)
+        else:
+            self.lblImage.setToolTip("")
 
-	def setIssueID( self, issue_id ):
-		if self.mode == CoverImageWidget.AltCoverMode:
-			self.resetWidget()
-			self.updateContent()
-			
-			self.issue_id = issue_id
+        self.updateContent()
 
-			self.comicVine = ComicVineTalker()
-			self.comicVine.urlFetchComplete.connect( self.primaryUrlFetchComplete )	
-			self.comicVine.asyncFetchIssueCoverURLs( int(self.issue_id) )
+    def resetWidget(self):
+        self.comic_archive = None
+        self.issue_id = None
+        self.comicVine = None
+        self.cover_fetcher = 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 = None
 
-	def setImageData( self, image_data ):
-		if self.mode == CoverImageWidget.DataMode:
-			self.resetWidget()
-			
-			if image_data is None:
-				self.imageIndex = -1
-			else:
-				self.imageIndex = 0
-				self.imageData = image_data
-				
-			self.updateContent()
-			
-	def primaryUrlFetchComplete( self, primary_url, thumb_url, issue_id ):
-		self.url_list.append(str(primary_url))
-		self.imageIndex = 0
-		self.imageCount = len(self.url_list)
-		self.updateContent()
+    def clear(self):
+        self.resetWidget()
+        self.updateContent()
 
-		#defer the alt cover search 		
-		QTimer.singleShot(1, self.startAltCoverSearch)
+    def incrementImage(self):
+        self.imageIndex += 1
+        if self.imageIndex == self.imageCount:
+            self.imageIndex = 0
+        self.updateContent()
 
-	def startAltCoverSearch( self ):
+    def decrementImage(self):
+        self.imageIndex -= 1
+        if self.imageIndex == -1:
+            self.imageIndex = self.imageCount - 1
+        self.updateContent()
 
-		# now we need to get the list of alt cover URLs
-		self.label.setText("Searching for alt. covers...")
-		
-		# page URL should already be cached, so no need to defer
-		self.comicVine = ComicVineTalker()
-		issue_page_url = self.comicVine.fetchIssuePageURL( self.issue_id )
-		self.comicVine.altUrlListFetchComplete.connect( self.altCoverUrlListFetchComplete )	
-		self.comicVine.asyncFetchAlternateCoverURLs( int(self.issue_id),  issue_page_url)
-		
-	def altCoverUrlListFetchComplete( self, url_list, issue_id ):
-		if len(url_list) > 0:
-			self.url_list.extend(url_list)
-			self.imageCount = len(self.url_list)
-		self.updateControls()
+    def setArchive(self, ca, page=0):
+        if self.mode == CoverImageWidget.ArchiveMode:
+            self.resetWidget()
+            self.comic_archive = ca
+            self.imageIndex = page
+            self.imageCount = ca.getNumberOfPages()
+            self.updateContent()
 
-	def setPage( self, pagenum ):
-		if self.mode == CoverImageWidget.ArchiveMode:
-			self.imageIndex = pagenum
-			self.updateContent()
-	
-	def updateContent( self ):
-		self.updateImage()
-		self.updateControls()
-		
-	def updateImage( self ):
-		if self.imageIndex == -1:
-			self.loadDefault()
-		elif self.mode in [ CoverImageWidget.AltCoverMode,  CoverImageWidget.URLMode ]:
-			self.loadURL()
-		elif self.mode == CoverImageWidget.DataMode:
-			self.coverRemoteFetchComplete( self.imageData, 0 )
-		else:
-			self.loadPage()
-	
-	def updateControls( self ):
-		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("Cover {0} ( of {1} )".format(self.imageIndex+1, self.imageCount))
-		else:
-			self.label.setText("Page {0} ( of {1} )".format(self.imageIndex+1, self.imageCount))
-	
-	def loadURL( self ):
-		self.loadDefault()
-		self.cover_fetcher = ImageFetcher( )
-		self.cover_fetcher.fetchComplete.connect(self.coverRemoteFetchComplete)
-		self.cover_fetcher.fetch( self.url_list[self.imageIndex] )
-		#print "ATB cover fetch started...."
-				
-	# called when the image is done loading from internet
-	def coverRemoteFetchComplete( self, image_data, issue_id ):
-		img = QImage()
-		img.loadFromData( image_data )
-		self.current_pixmap = QPixmap(img)
-		self.setDisplayPixmap( 0, 0)
-		#print "ATB cover fetch complete!"
+    def setURL(self, url):
+        if self.mode == CoverImageWidget.URLMode:
+            self.resetWidget()
+            self.updateContent()
 
-	def loadPage( self ):
-		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.pageLoadComplete )	
-			self.page_loader.start()
+            self.url_list = [url]
+            self.imageIndex = 0
+            self.imageCount = 1
+            self.updateContent()
 
-	def pageLoadComplete( self, img ):
-		self.current_pixmap = QPixmap(img)
-		self.setDisplayPixmap( 0, 0)
-		self.page_loader = None
-					
-	def loadDefault( self ):
-		self.current_pixmap = QPixmap(ComicTaggerSettings.getGraphic('nocover.png'))
-		#print "loadDefault called"
-		self.setDisplayPixmap( 0, 0)
+    def setIssueID(self, issue_id):
+        if self.mode == CoverImageWidget.AltCoverMode:
+            self.resetWidget()
+            self.updateContent()
 
-	def resizeEvent( self, resize_event ):
-		if self.current_pixmap is not None:
-			delta_w = resize_event.size().width() - resize_event.oldSize().width()
-			delta_h = resize_event.size().height() - resize_event.oldSize().height()
-			#print "ATB resizeEvent deltas", resize_event.size().width(), resize_event.size().height()
-			self.setDisplayPixmap( delta_w , delta_h )
-							
-	def setDisplayPixmap( self, delta_w , delta_h ):
-			# the deltas let us know what the new width and height of the label will be
-			"""
-			new_h = self.frame.height() + delta_h
-			new_w = self.frame.width() + delta_w
-			print "ATB setDisplayPixmap deltas", delta_w , delta_h
-			print "ATB self.frame", self.frame.width(), self.frame.height()
-			print "ATB self.", self.width(), self.height()
-			
-			frame_w = new_w
-			frame_h = new_h
-			"""
-			new_h = self.frame.height() 
-			new_w = self.frame.width() 
-			frame_w = self.frame.width() 
-			frame_h = self.frame.height() 
+            self.issue_id = issue_id
 
-			new_h -= 4
-			new_w -= 4
-			
-			if new_h < 0:
-				new_h = 0;
-			if new_w < 0:
-				new_w = 0;
+            self.comicVine = ComicVineTalker()
+            self.comicVine.urlFetchComplete.connect(
+                self.primaryUrlFetchComplete)
+            self.comicVine.asyncFetchIssueCoverURLs(int(self.issue_id))
 
-			#print "ATB setDisplayPixmap deltas", delta_w , delta_h
-			#print "ATB self.frame", frame_w, frame_h
-			#print "ATB new size", new_w, new_h
-			
-			# scale the pixmap to fit in the frame
-			scaled_pixmap = self.current_pixmap.scaled(new_w, new_h, Qt.KeepAspectRatio)			
-			self.lblImage.setPixmap( scaled_pixmap )
-			
-			# move and resize the label to be centered in the fame
-			img_w = scaled_pixmap.width()
-			img_h = scaled_pixmap.height()
-			self.lblImage.resize( img_w, img_h )
-			self.lblImage.move( (frame_w - img_w)/2, (frame_h - img_h)/2 )
-			
-	def showPopup( self ):
-		self.popup = ImagePopup(self, self.current_pixmap)
+    def setImageData(self, image_data):
+        if self.mode == CoverImageWidget.DataMode:
+            self.resetWidget()
 
+            if image_data is None:
+                self.imageIndex = -1
+            else:
+                self.imageIndex = 0
+                self.imageData = image_data
+
+            self.updateContent()
+
+    def primaryUrlFetchComplete(self, primary_url, thumb_url, issue_id):
+        self.url_list.append(str(primary_url))
+        self.imageIndex = 0
+        self.imageCount = len(self.url_list)
+        self.updateContent()
+
+        # defer the alt cover search
+        QTimer.singleShot(1, self.startAltCoverSearch)
+
+    def startAltCoverSearch(self):
+
+        # now we need to get the list of alt cover URLs
+        self.label.setText("Searching for alt. covers...")
+
+        # page URL should already be cached, so no need to defer
+        self.comicVine = ComicVineTalker()
+        issue_page_url = self.comicVine.fetchIssuePageURL(self.issue_id)
+        self.comicVine.altUrlListFetchComplete.connect(
+            self.altCoverUrlListFetchComplete)
+        self.comicVine.asyncFetchAlternateCoverURLs(
+            int(self.issue_id), issue_page_url)
+
+    def altCoverUrlListFetchComplete(self, url_list, issue_id):
+        if len(url_list) > 0:
+            self.url_list.extend(url_list)
+            self.imageCount = len(self.url_list)
+        self.updateControls()
+
+    def setPage(self, pagenum):
+        if self.mode == CoverImageWidget.ArchiveMode:
+            self.imageIndex = pagenum
+            self.updateContent()
+
+    def updateContent(self):
+        self.updateImage()
+        self.updateControls()
+
+    def updateImage(self):
+        if self.imageIndex == -1:
+            self.loadDefault()
+        elif self.mode in [CoverImageWidget.AltCoverMode, CoverImageWidget.URLMode]:
+            self.loadURL()
+        elif self.mode == CoverImageWidget.DataMode:
+            self.coverRemoteFetchComplete(self.imageData, 0)
+        else:
+            self.loadPage()
+
+    def updateControls(self):
+        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(
+                "Cover {0} (of {1})".format(
+                    self.imageIndex + 1,
+                    self.imageCount))
+        else:
+            self.label.setText(
+                "Page {0} (of {1})".format(
+                    self.imageIndex + 1,
+                    self.imageCount))
+
+    def loadURL(self):
+        self.loadDefault()
+        self.cover_fetcher = ImageFetcher()
+        self.cover_fetcher.fetchComplete.connect(self.coverRemoteFetchComplete)
+        self.cover_fetcher.fetch(self.url_list[self.imageIndex])
+        #print("ATB cover fetch started...")
+
+    # called when the image is done loading from internet
+    def coverRemoteFetchComplete(self, image_data, issue_id):
+        img = getQImageFromData(image_data)
+        self.current_pixmap = QPixmap(img)
+        self.setDisplayPixmap(0, 0)
+        #print("ATB cover fetch complete!")
+
+    def loadPage(self):
+        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.pageLoadComplete)
+            self.page_loader.start()
+
+    def pageLoadComplete(self, img):
+        self.current_pixmap = QPixmap(img)
+        self.setDisplayPixmap(0, 0)
+        self.page_loader = None
+
+    def loadDefault(self):
+        self.current_pixmap = QPixmap(
+            ComicTaggerSettings.getGraphic('nocover.png'))
+        #print("loadDefault called")
+        self.setDisplayPixmap(0, 0)
+
+    def resizeEvent(self, resize_event):
+        if self.current_pixmap is not None:
+            delta_w = resize_event.size().width() - \
+                resize_event.oldSize().width()
+            delta_h = resize_event.size().height() - \
+                resize_event.oldSize().height()
+            # print "ATB resizeEvent deltas", resize_event.size().width(),
+            # resize_event.size().height()
+            self.setDisplayPixmap(delta_w, delta_h)
+
+    def setDisplayPixmap(self, delta_w, delta_h):
+        """The deltas let us know what the new width and height of the label will be"""
+
+        #new_h = self.frame.height() + delta_h
+        #new_w = self.frame.width() + delta_w
+        # print "ATB setDisplayPixmap deltas", delta_w , delta_h
+        # print "ATB self.frame", self.frame.width(), self.frame.height()
+        # print "ATB self.", self.width(), self.height()
+
+        #frame_w = new_w
+        #frame_h = new_h
+
+        new_h = self.frame.height()
+        new_w = self.frame.width()
+        frame_w = self.frame.width()
+        frame_h = self.frame.height()
+
+        new_h -= 4
+        new_w -= 4
+
+        if new_h < 0:
+            new_h = 0
+        if new_w < 0:
+            new_w = 0
+
+        # print "ATB setDisplayPixmap deltas", delta_w , delta_h
+        # print "ATB self.frame", frame_w, frame_h
+        # print "ATB new size", new_w, new_h
+
+        # scale the pixmap to fit in the frame
+        scaled_pixmap = self.current_pixmap.scaled(
+            new_w, new_h, Qt.KeepAspectRatio)
+        self.lblImage.setPixmap(scaled_pixmap)
+
+        # move and resize the label to be centered in the fame
+        img_w = scaled_pixmap.width()
+        img_h = scaled_pixmap.height()
+        self.lblImage.resize(img_w, img_h)
+        self.lblImage.move((frame_w - img_w) / 2, (frame_h - img_h) / 2)
+
+    def showPopup(self):
+        self.popup = ImagePopup(self, self.current_pixmap)

comictaggerlib/crediteditorwindow.py

@@ -1,99 +1,96 @@
-"""
-A PyQT4 dialog to edit credits
-"""
+"""A PyQT4 dialog to edit credits"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
+
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+
+from .settings import ComicTaggerSettings
 
 
-from PyQt4 import QtCore, QtGui, uic
-from settings import ComicTaggerSettings
-import os
+class CreditEditorWindow(QtWidgets.QDialog):
 
-class CreditEditorWindow(QtGui.QDialog):
-	
-	
-	ModeEdit = 0
-	ModeNew = 1
-	
-	
-	def __init__(self, parent, mode, role, name, primary ):
-		super(CreditEditorWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('crediteditorwindow.ui' ), self)
-		
-		self.mode = mode
-		
-		if self.mode == self.ModeEdit:
-			self.setWindowTitle("Edit Credit")
-		else: 
-			self.setWindowTitle("New Credit")
+    ModeEdit = 0
+    ModeNew = 1
 
-		# Add the entries to the role combobox
-		self.cbRole.addItem( "" )
-		self.cbRole.addItem( "Writer" )
-		self.cbRole.addItem( "Artist" )
-		self.cbRole.addItem( "Penciller" )
-		self.cbRole.addItem( "Inker" )
-		self.cbRole.addItem( "Colorist" )
-		self.cbRole.addItem( "Letterer" )
-		self.cbRole.addItem( "Cover Artist" )
-		self.cbRole.addItem( "Editor" )
-		self.cbRole.addItem( "Other" )
-		self.cbRole.addItem( "Plotter" )
-		self.cbRole.addItem( "Scripter" )
-		
-		self.leName.setText( name )
-		
-		if role is not None and role != "":
-			i = self.cbRole.findText( role )
-			if i == -1:
-				self.cbRole.setEditText( role  )
-			else:	
-				self.cbRole.setCurrentIndex( i )
+    def __init__(self, parent, mode, role, name, primary):
+        super(CreditEditorWindow, self).__init__(parent)
 
-		if primary:
-			self.cbPrimary.setCheckState( QtCore.Qt.Checked )
-			
-		self.cbRole.currentIndexChanged.connect(self.roleChanged)
-		self.cbRole.editTextChanged.connect(self.roleChanged)
-	
-		self.updatePrimaryButton()
+        uic.loadUi(
+            ComicTaggerSettings.getUIFile('crediteditorwindow.ui'), self)
 
-	def updatePrimaryButton( self ):
-		enabled =self.currentRoleCanBePrimary()
-		self.cbPrimary.setEnabled( enabled )
+        self.mode = mode
 
-	def currentRoleCanBePrimary( self ):
-		role =  self.cbRole.currentText()
-		if str(role).lower() == "writer" or str(role).lower() == "artist":
-			return True
-		else:
-			return False
-		
-	def roleChanged( self, s ):
-		self.updatePrimaryButton()
-				
-	def getCredits( self ):
-		primary = self.currentRoleCanBePrimary() and self.cbPrimary.isChecked() 
-		return self.cbRole.currentText(), self.leName.text(), primary
+        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("Writer")
+        self.cbRole.addItem("Artist")
+        self.cbRole.addItem("Penciller")
+        self.cbRole.addItem("Inker")
+        self.cbRole.addItem("Colorist")
+        self.cbRole.addItem("Letterer")
+        self.cbRole.addItem("Cover Artist")
+        self.cbRole.addItem("Editor")
+        self.cbRole.addItem("Other")
+        self.cbRole.addItem("Plotter")
+        self.cbRole.addItem("Scripter")
 
-	def accept( self ):
-		if self.cbRole.currentText() == "" or self.leName.text() == "":
-			QtGui.QMessageBox.warning(self, self.tr("Whoops"), self.tr("You need to enter both role and name for a credit."))
-		else:
-			QtGui.QDialog.accept(self)
+        self.leName.setText(name)
+
+        if role is not None and role != "":
+            i = self.cbRole.findText(role)
+            if i == -1:
+                self.cbRole.setEditText(role)
+            else:
+                self.cbRole.setCurrentIndex(i)
+
+        if primary:
+            self.cbPrimary.setCheckState(QtCore.Qt.Checked)
+
+        self.cbRole.currentIndexChanged.connect(self.roleChanged)
+        self.cbRole.editTextChanged.connect(self.roleChanged)
+
+        self.updatePrimaryButton()
+
+    def updatePrimaryButton(self):
+        enabled = self.currentRoleCanBePrimary()
+        self.cbPrimary.setEnabled(enabled)
+
+    def currentRoleCanBePrimary(self):
+        role = self.cbRole.currentText()
+        if str(role).lower() == "writer" or str(role).lower() == "artist":
+            return True
+        else:
+            return False
+
+    def roleChanged(self, s):
+        self.updatePrimaryButton()
+
+    def getCredits(self):
+        primary = self.currentRoleCanBePrimary() and self.cbPrimary.isChecked()
+        return self.cbRole.currentText(), self.leName.text(), primary
+
+    def accept(self):
+        if self.cbRole.currentText() == "" or self.leName.text() == "":
+            QtWidgets.QMessageBox.warning(self, self.tr("Whoops"), self.tr(
+                "You need to enter both role and name for a credit."))
+        else:
+            QtWidgets.QDialog.accept(self)

comictaggerlib/ctversion.py

@@ -1,3 +0,0 @@
-# This file should contan only these comments, and the line below.  
-# Used by packaging makefiles and app
-version="1.1.10-beta"

comictaggerlib/exportwindow.py

@@ -1,65 +1,64 @@
-"""
-A PyQT4 dialog to confirm and set options for export to zip 
-"""
+"""A PyQT4 dialog to confirm and set options for export to zip"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
+
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+
+from .settings import ComicTaggerSettings
+#from settingswindow import SettingsWindow
+#from filerenamer import FileRenamer
+#import utils
 
-from PyQt4 import QtCore, QtGui, uic
-from settings import ComicTaggerSettings
-from settingswindow import SettingsWindow
-from filerenamer import FileRenamer
-import os
-import utils
 
 class ExportConflictOpts:
-	dontCreate = 1
-	overwrite = 2
-	createUnique = 3
-	
-class ExportWindow(QtGui.QDialog):
-		
-	def __init__( self, parent,  settings, msg ):
-		super(ExportWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('exportwindow.ui' ), self)
-		self.label.setText( msg )
+    dontCreate = 1
+    overwrite = 2
+    createUnique = 3
 
-		self.setWindowFlags(self.windowFlags() &
-									  ~QtCore.Qt.WindowContextHelpButtonHint )
 
-		self.settings = settings
-		
-		self.cbxDeleteOriginal.setCheckState( QtCore.Qt.Unchecked )
-		self.cbxAddToList.setCheckState( QtCore.Qt.Checked )
-		self.radioDontCreate.setChecked( True )
-		
-		self.deleteOriginal = False
-		self.addToList = True
-		self.fileConflictBehavior = ExportConflictOpts.dontCreate
+class ExportWindow(QtWidgets.QDialog):
 
-	def accept( self ):
-		QtGui.QDialog.accept(self)		
+    def __init__(self, parent, settings, msg):
+        super(ExportWindow, self).__init__(parent)
 
-		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
-		#else:
-		#	self.fileConflictBehavior = ExportConflictOpts.overwrite	
+        uic.loadUi(ComicTaggerSettings.getUIFile('exportwindow.ui'), self)
+        self.label.setText(msg)
+
+        self.setWindowFlags(self.windowFlags() &
+                            ~QtCore.Qt.WindowContextHelpButtonHint)
+
+        self.settings = settings
+
+        self.cbxDeleteOriginal.setCheckState(QtCore.Qt.Unchecked)
+        self.cbxAddToList.setCheckState(QtCore.Qt.Checked)
+        self.radioDontCreate.setChecked(True)
+
+        self.deleteOriginal = False
+        self.addToList = True
+        self.fileConflictBehavior = ExportConflictOpts.dontCreate
+
+    def accept(self):
+        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
+        # else:
+        #    self.fileConflictBehavior = ExportConflictOpts.overwrite

comictaggerlib/filenameparser.py

@@ -1,272 +1 @@
-"""
-Functions for parsing comic info from filename 
-
-This should probably be re-written, but, well, it mostly works!
-
-"""
-
-"""
-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.
-"""
-
-
-# Some portions of this code were modified from pyComicMetaThis project
-# http://code.google.com/p/pycomicmetathis/
-
-import re
-import os
-from urllib import unquote
-
-class FileNameParser:
-
-	def repl(self, m):
-	   return ' ' * len(m.group())
-	
-	def fixSpaces( self, string, remove_dashes=True ):
-		if remove_dashes:
-			placeholders = ['[-_]','  +']
-		else:
-			placeholders = ['[_]','  +']			
-		for ph in placeholders:
-			string = re.sub(ph, self.repl, string )
-		return string #.strip()
-
-
-	def getIssueCount( self,filename, issue_end ):
-
-		count = ""
-		filename = filename[issue_end:]
-		
-		# replace any name seperators with spaces
-		tmpstr = self.fixSpaces(filename)
-		found = False
-		
-		match = re.search('(?<=\sof\s)\d+(?=\s)', tmpstr, re.IGNORECASE)
-		if match:
-			count = match.group()
-			found = True
-
-		if not found:
-			match = re.search('(?<=\(of\s)\d+(?=\))', tmpstr,  re.IGNORECASE)
-			if match:
-				count = match.group()
-				found = True
-			
-
-		count = count.lstrip("0")
-
-		return count
-	
-	def getIssueNumber( self, filename ):
-
-		# Returns a tuple of issue number string, and start and end indexs in the filename
-		# (The indexes will be used to split the string up for further parsing)
-		
-		found = False
-		issue = ''
-		start = 0
-		end = 0
-		
-		# first, look for multiple "--", this means it's formatted differently from most:
-		if "--" in filename:
-			# the pattern seems to be that anything to left of the first "--" is the series name followed by issue
-			filename = re.sub("--.*", self.repl, filename)	
-			
-		elif "__" in filename:
-			# the pattern seems to be that anything to left of the first "__" is the series name followed by issue
-			filename = re.sub("__.*", self.repl, filename)	
-
-		filename = filename.replace("+", " ")
-			
-		# replace parenthetical phrases with spaces
-		filename = re.sub( "\(.*?\)", self.repl, filename)
-		filename = re.sub( "\[.*?\]", self.repl, filename)
-
-		# replace any name seperators with spaces
-		filename = self.fixSpaces(filename)
-
-		# remove any "of NN" phrase with spaces (problem: this could break on some titles)
-		filename = re.sub( "of [\d]+", self.repl, filename)
-
-		#print u"[{0}]".format(filename)
-		
-		# we should now have a cleaned up filename version with all the words in
-		# the same positions as original filename
-			
-		# make a list of each word and its position
-		word_list = list()
-		for m in re.finditer("\S+", filename):
-			word_list.append( (m.group(0), m.start(), m.end()) )
-			
-		# remove the first word, since it can't be the issue number
-		if len(word_list) > 1:
-			word_list = word_list[1:]
-		else:
-			#only one word??  just bail.
-			return issue, start, end
-					
-		# Now try to search for the likely issue number word in the list
-		
-		# first look for a word with "#" followed by digits with optional sufix 
-		# this is almost certainly the issue number
-		for w in reversed(word_list):
-			if re.match("#[-]?(([0-9]*\.[0-9]+|[0-9]+)(\w*))", w[0]):
-				found = True
-				break
-
-		# same as above but w/o a '#', and only look at the last word in the list	
-		if not found:
-			w  = word_list[-1]
-			if re.match("[-]?(([0-9]*\.[0-9]+|[0-9]+)(\w*))", w[0]):
-				found = True
-				
-		# now try to look for a # followed by any characters		
-		if not found:
-			for w in reversed(word_list):
-				if re.match("#\S+", w[0]):
-					found = True
-					break
-				
-		if found:
-			issue = w[0]
-			start = w[1]
-			end = w[2]
-			if issue[0] == '#':
-				issue = issue[1:]
-				
-		return issue, start, end
-		
-	def getSeriesName(self, filename, issue_start ):
-		
-		# use the issue number string index to split the filename string
-		
-		if issue_start != 0:
-			filename = filename[:issue_start]
-
-		# in case there is no issue number, remove some obvious stuff
-		if "--" in filename:
-			# the pattern seems to be that anything to left of the first "--" is the series name followed by issue
-			filename = re.sub("--.*", self.repl, filename)	
-			
-		elif "__" in filename:
-			# the pattern seems to be that anything to left of the first "__" is the series name followed by issue
-			filename = re.sub("__.*", self.repl, filename)
-			
-		filename = filename.replace("+", " ")
-		tmpstr = self.fixSpaces(filename, remove_dashes=False)
-		
-		series = tmpstr	
-		volume = ""
-
-		#save the last word		
-		last_word = series.split()[-1]
-		
-		# remove any parenthetical phrases
-		series = re.sub( "\(.*?\)", "", series)
-			
-		# search for volume number
-		match = re.search('(.+)([vV]|[Vv][oO][Ll]\.?\s?)(\d+)\s*$', series)
-		if match:
-			series = match.group(1)
-			volume = match.group(3)
-			
-		# if a volume wasn't found, see if the last word is a year in parentheses
-		# since that's a common way to designate the volume
-		if volume == "":
-			#match either (YEAR), (YEAR-), or (YEAR-YEAR2)
-			match = re.search("(\()(\d{4})(-(\d{4}|)|)(\))", last_word)
-			if match:
-				volume = match.group(2)
-
-		series = series.strip()
-
-		# if we don't have an issue number (issue_start==0), look
-		# for hints i.e. "TPB", "one-shot", "OS", "OGN", etc that might
-		# be removed to help search online		
-		if issue_start == 0:
-			one_shot_words = [ "tpb", "os", "one-shot", "ogn", "gn" ]
-			last_word = series.split()[-1]
-			if last_word.lower() in one_shot_words:
-				series = series.rsplit(' ', 1)[0]
-				
-		return series, volume.strip()
-
-	def getYear( self,filename, issue_end):
-		
-		filename = filename[issue_end:]
-
-		year = ""
-		# look for four digit number with "(" ")" or "--" around it
-		match = re.search('(\(\d\d\d\d\))|(--\d\d\d\d--)', filename)
-		if match:
-			year = match.group()
-			# remove non-numerics
-			year = re.sub("[^0-9]", "", year)
-		return year
-
-	def getRemainder( self, filename, year, count, issue_end ):
-		
-		#make a guess at where the the non-interesting stuff begins
-		remainder = ""
-		
-		if "--" in filename:
-			remainder = filename.split("--",1)[1]
-		elif "__" in filename:
-			remainder = filename.split("__",1)[1]
-		elif issue_end != 0:
-			remainder = filename[issue_end:]
-
-		remainder = self.fixSpaces(remainder, remove_dashes=False)
-		if year != "":
-			remainder = remainder.replace(year,"",1)
-		if count != "":
-			remainder = remainder.replace("of "+count,"",1)
-			
-		remainder = remainder.replace("()","")
-		
-		return remainder.strip()
-		
-	def parseFilename( self, filename ):
-
-		# remove the path
-		filename = os.path.basename(filename)
-
-		# remove the extension
-		filename = os.path.splitext(filename)[0]
-
-		#url decode, just in case
-		filename = unquote(filename)
-
-		# sometimes archives get messed up names from too many decodings
-		# often url encodings will break and leave "_28" and "_29" in place
-		# of "(" and ")"  see if there are a number of these, and replace them
-		if filename.count("_28") > 1 and filename.count("_29") > 1:
-			filename = filename.replace("_28", "(")
-			filename = filename.replace("_29", ")")
-					
-		self.issue, issue_start, issue_end = self.getIssueNumber(filename)
-		self.series, self.volume = self.getSeriesName(filename, issue_start)
-		self.year = self.getYear(filename, issue_end)
-		self.issue_count = self.getIssueCount(filename, issue_end)
-		self.remainder = self.getRemainder( filename, self.year, self.issue_count, issue_end )
-	
-		if self.issue != "":
-			# strip off leading zeros
-			self.issue = self.issue.lstrip("0")
-			if self.issue == "":
-				self.issue = "0"
-			if self.issue[0] == ".":
-				self.issue = "0" + self.issue
-
+from comicapi.filenameparser import *

comictaggerlib/filerenamer.py

@@ -1,150 +1,156 @@
-"""
-Functions for renaming files based on metadata
-"""
+"""Functions for renaming files based on metadata"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 re
 import datetime
-import utils
-from issuestring import IssueString
+import sys
+import string
+
+from pathvalidate import sanitize_filepath
+
+from . import utils
+from .issuestring import IssueString
+
+
+class MetadataFormatter(string.Formatter):
+    def __init__(self, smart_cleanup=False):
+       super().__init__()
+       self.smart_cleanup = smart_cleanup
+
+    def format_field(self, value, format_spec):
+        if value is None or value == "":
+            return ""
+        return super().format_field(value, format_spec)
+
+    def _vformat(self, format_string, args, kwargs, used_args, recursion_depth,
+                 auto_arg_index=0):
+        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:
+                    result.append(literal_text.lstrip("-_)}]#"))
+                else:
+                    result.append(literal_text)
+            lstrip = False
+            # if there's a field, output it
+            if field_name is not None:
+                # this is some markup, find the object and do
+                #  the formatting
+
+                # handle arg indexing when empty field_names are given.
+                if field_name == '':
+                    if auto_arg_index is False:
+                        raise ValueError('cannot switch from manual field '
+                                         'specification to automatic field '
+                                         'numbering')
+                    field_name = str(auto_arg_index)
+                    auto_arg_index += 1
+                elif field_name.isdigit():
+                    if auto_arg_index:
+                        raise ValueError('cannot switch from manual field '
+                                         'specification to automatic field '
+                                         'numbering')
+                    # disable auto arg incrementing, if it gets
+                    # used later on, then an exception will be raised
+                    auto_arg_index = False
+
+                # given the field_name, find the object it references
+                #  and the argument it came from
+                obj, arg_used = self.get_field(field_name, args, kwargs)
+                used_args.add(arg_used)
+
+                # do any conversion on the resulting object
+                obj = self.convert_field(obj, conversion)
+
+                # expand the format spec, if needed
+                format_spec, auto_arg_index = self._vformat(
+                    format_spec, args, kwargs,
+                    used_args, recursion_depth-1,
+                    auto_arg_index=auto_arg_index)
+
+                # format the object and append to the result
+                fmtObj = self.format_field(obj, format_spec)
+                if fmtObj == "" and len(result) > 0 and self.smart_cleanup:
+                    lstrip = True
+                    result.pop()
+                result.append(fmtObj)
+
+        return ''.join(result), auto_arg_index
+
 
 class FileRenamer:
-	def __init__( self, metadata ):
-		self.setMetadata( metadata )
-		self.setTemplate( "%series% v%volume% #%issue% (of %issuecount%) (%year%)" )
-		self.smart_cleanup = True
-		self.issue_zero_padding = 3
 
-	def setMetadata( self, metadata ):
-		self.metdata = metadata
+    def __init__(self, metadata):
+        self.setMetadata(metadata)
+        self.setTemplate(
+            "{publisher}/{series}/{series} v{volume} #{issue} (of {issueCount}) ({year})")
+        self.smart_cleanup = True
+        self.issue_zero_padding = 3
+        self.move = False
 
-	def setIssueZeroPadding( self, count ):
-		self.issue_zero_padding = count
+    def setMetadata(self, metadata):
+        self.metdata = metadata
 
-	def setSmartCleanup( self, on ):
-		self.smart_cleanup = on
+    def setIssueZeroPadding(self, count):
+        self.issue_zero_padding = count
 
-	def setTemplate( self, template ):
-		self.template = template
-		
-	def replaceToken( self, text, value, token ):
-		#helper func
-		def isToken( word ):
-			return (word[0] == "%" and word[-1:] == "%")
+    def setSmartCleanup(self, on):
+        self.smart_cleanup = on
 
-		if value is not None:
-			return text.replace( token, unicode(value) )
-		else:
-			if self.smart_cleanup:
-				# smart cleanup means we want to remove anything appended to token if it's empty
-				# (e.g "#%issue%"  or "v%volume%" )
-				# (TODO: This could fail if there is more than one token appended together, I guess)
-				text_list = text.split()
-				
-				#special case for issuecount, remove preceding non-token word, as in "...(of %issuecount%)..."
-				if token == '%issuecount%':
-					for idx,word in enumerate( text_list ):
-						if token in word and not isToken(text_list[idx -1]) :
-							text_list[idx -1] = ""
-							
-				text_list = [ x  for x in text_list if token not in x ]
-				return " ".join( text_list )
-			else:
-				return text.replace( token, "" )
-		
-	def determineName( self, filename, ext=None ):
+    def setTemplate(self, template):
+        self.template = template
 
-		md = self.metdata
-		new_name = self.template
-		preferred_encoding = utils.get_actual_preferred_encoding()
+    def determineName(self, filename, ext=None):
+        class Default(dict):
+             def __missing__(self, key):
+                 return "{" + key + "}"
+        md = self.metdata
 
-		#print u"{0}".format(md)
-		
-		new_name = self.replaceToken( new_name, md.series, '%series%')
-		new_name = self.replaceToken( new_name, md.volume, '%volume%')
-		
-		if md.issue is not None:
-			issue_str = u"{0}".format( IssueString(md.issue).asString(pad=self.issue_zero_padding) ) 
-		else:
-			issue_str = None		
-		new_name = self.replaceToken( new_name, issue_str, '%issue%')
-		
-		new_name = self.replaceToken( new_name, md.issueCount, '%issuecount%')
-		new_name = self.replaceToken( new_name, md.year, '%year%')
-		new_name = self.replaceToken( new_name, md.publisher, '%publisher%')
-		new_name = self.replaceToken( new_name, md.title, '%title%')
-		new_name = self.replaceToken( new_name, md.month, '%month%')
-		month_name = None
-		if md.month is not None:
-			if (type(md.month) == str and md.month.isdigit()) or type(md.month) == int:
-				if int(md.month) in range(1,13):
-					dt = datetime.datetime( 1970, int(md.month), 1, 0, 0)
-					month_name = dt.strftime(u"%B".encode(preferred_encoding)).decode(preferred_encoding)
-		new_name = self.replaceToken( new_name, month_name, '%month_name%')
 
-		new_name = self.replaceToken( new_name, md.genre, '%genre%')
-		new_name = self.replaceToken( new_name, md.language, '%language_code%')
-		new_name = self.replaceToken( new_name, md.criticalRating , '%criticalrating%')
-		new_name = self.replaceToken( new_name, md.alternateSeries, '%alternateseries%')
-		new_name = self.replaceToken( new_name, md.alternateNumber, '%alternatenumber%')
-		new_name = self.replaceToken( new_name, md.alternateCount, '%alternatecount%')
-		new_name = self.replaceToken( new_name, md.imprint, '%imprint%')
-		new_name = self.replaceToken( new_name, md.format, '%format%')
-		new_name = self.replaceToken( new_name, md.maturityRating, '%maturityrating%')
-		new_name = self.replaceToken( new_name, md.storyArc, '%storyarc%')
-		new_name = self.replaceToken( new_name, md.seriesGroup, '%seriesgroup%')
-		new_name = self.replaceToken( new_name, md.scanInfo, '%scaninfo%')
-			
-		if self.smart_cleanup:
-			
-			# remove empty braces,brackets, parentheses
-			new_name = re.sub("\(\s*[-:]*\s*\)", "", new_name )
-			new_name = re.sub("\[\s*[-:]*\s*\]", "", new_name )
-			new_name = re.sub("\{\s*[-:]*\s*\}", "", new_name )
+        # padding for issue
+        md.issue = IssueString(md.issue).asString(pad=self.issue_zero_padding)
 
-			# remove duplicate spaces
-			new_name = u" ".join(new_name.split())
+        template = self.template
 
-			# remove remove duplicate -, _,
-			new_name = re.sub("[-_]{2,}\s+", "-- ", new_name )
-			new_name = re.sub("(\s--)+", " --", new_name )
-			new_name = re.sub("(\s-)+", " -", new_name )
-			
-			# remove dash or double dash at end of line
-			new_name = re.sub("[-]{1,2}\s*$", "", new_name )
-			
-			# remove duplicate spaces (again!)
-			new_name = u" ".join(new_name.split())
+        pathComponents = template.split(os.sep)
+        new_name = ""
 
-		
-		if ext is None:
-			ext = os.path.splitext( filename )[1]
+        fmt = MetadataFormatter(self.smart_cleanup)
+        for Component in pathComponents:
+            new_name = os.path.join(new_name, fmt.vformat(Component, args=[], kwargs=Default(vars(md))).replace("/", "-"))
 
-		new_name += ext
-		
-		# some tweaks to keep various filesystems happy		
-		new_name = new_name.replace("/", "-")
-		new_name = new_name.replace(" :", " -")
-		new_name = new_name.replace(": ",  " - ")
-		new_name = new_name.replace(":",  "-")
-		new_name = new_name.replace("?", "")
-		
-		return new_name
-	
-	
+        if ext is None or ext == "":
+            ext = os.path.splitext(filename)[1]
+
+        new_name += ext
+
+        # some tweaks to keep various filesystems happy
+        new_name = new_name.replace(": ", " - ")
+        new_name = new_name.replace(":", "-")
+
+        # remove padding
+        md.issue = IssueString(md.issue).asString()
+        if self.move:
+            return sanitize_filepath(new_name.strip())
+        else:
+            return os.path.basename(sanitize_filepath(new_name.strip()))

comictaggerlib/fileselectionlist.py

@@ -1,406 +1,447 @@
 # coding=utf-8
-"""
-A PyQt4 widget for managing list of comic archive files
-"""
+"""A PyQt5 widget for managing list of comic archive files"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 platform
 import os
+#import os
 import sys
 
-from PyQt4.QtCore import *
-from PyQt4.QtGui import *
-from PyQt4 import uic
-from PyQt4.QtCore import pyqtSignal
+from PyQt5.QtCore import *
+from PyQt5.QtGui import *
+from PyQt5.QtWidgets import *
+from PyQt5 import uic
+from PyQt5.QtCore import pyqtSignal
 
-from settings import ComicTaggerSettings
-from comicarchive import ComicArchive
-from comicarchive import MetaDataStyle
-from genericmetadata import GenericMetadata, PageType
-import utils
-
-class FileTableWidget( QTableWidget ):
-
-	def __init__(self, parent ):
-		super(FileTableWidget, self).__init__(parent)
-		
-		
-		self.setColumnCount(5)
-		self.setHorizontalHeaderLabels (["File", "Folder", "CR", "CBL", ""])
-		self.horizontalHeader().setStretchLastSection( True )
+from .settings import ComicTaggerSettings
+from .comicarchive import ComicArchive
+from .optionalmsgdialog import OptionalMessageDialog
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize, centerWindowOnParent
+from . import utils
+#from comicarchive import MetaDataStyle
+#from genericmetadata import GenericMetadata, PageType
 
 
 class FileTableWidgetItem(QTableWidgetItem):
-   def __lt__(self, other):
-        return (self.data(Qt.UserRole).toBool() <
-                other.data(Qt.UserRole).toBool())
+
+    def __lt__(self, other):
+        #return (self.data(Qt.UserRole).toBool() <
+        #        other.data(Qt.UserRole).toBool())
+        return (self.data(Qt.UserRole) <
+                other.data(Qt.UserRole))
 
 
-class FileInfo(  ):
-	def __init__(self, ca ):
-		self.ca = ca
+class FileInfo():
+
+    def __init__(self, ca):
+        self.ca = ca
+
 
 class FileSelectionList(QWidget):
 
-	selectionChanged = pyqtSignal(QVariant)
-	listCleared = pyqtSignal()
-	
-	fileColNum = 0
-	CRFlagColNum = 1
-	CBLFlagColNum = 2
-	typeColNum = 3
-	readonlyColNum = 4
-	folderColNum = 5
-	dataColNum = fileColNum
-	
+    selectionChanged = pyqtSignal(QVariant)
+    listCleared = pyqtSignal()
 
-	def __init__(self, parent , settings ):
-		super(FileSelectionList, self).__init__(parent)
+    fileColNum = 0
+    CRFlagColNum = 1
+    CBLFlagColNum = 2
+    typeColNum = 3
+    readonlyColNum = 4
+    folderColNum = 5
+    dataColNum = fileColNum
 
-		uic.loadUi(ComicTaggerSettings.getUIFile('fileselectionlist.ui' ), self)
-		
-		self.settings = settings
+    def __init__(self, parent, settings):
+        super(FileSelectionList, self).__init__(parent)
 
-		utils.reduceWidgetFontSize( self.twList )
-		
-		self.twList.currentItemChanged.connect( self.currentItemChangedCB )
-		
-		self.currentItem = None
-		self.setContextMenuPolicy(Qt.ActionsContextMenu)
-		self.modifiedFlag = False
-		
-		selectAllAction = QAction("Select All", self)
-		removeAction = QAction("Remove Selected Items", self)
-		self.separator = QAction("",self)
-		self.separator.setSeparator(True)
-		
-		selectAllAction.setShortcut( 'Ctrl+A' )
-		removeAction.setShortcut( 'Ctrl+X' )
-		
-		selectAllAction.triggered.connect(self.selectAll)
-		removeAction.triggered.connect(self.removeSelection)
+        uic.loadUi(ComicTaggerSettings.getUIFile('fileselectionlist.ui'), self)
 
-		self.addAction(selectAllAction)			
-		self.addAction(removeAction)
-		self.addAction(self.separator)
+        self.settings = settings
 
-	def getSorting(self):
-		col = self.twList.horizontalHeader().sortIndicatorSection()
-		order = self.twList.horizontalHeader().sortIndicatorOrder()
-		return col, order
+        reduceWidgetFontSize(self.twList)
 
-	def setSorting(self, col, order):
-		col = self.twList.horizontalHeader().setSortIndicator( col, order)
+        self.twList.setColumnCount(6)
+        #self.twlist.setHorizontalHeaderLabels (["File", "Folder", "CR", "CBL", ""])
+        # self.twList.horizontalHeader().setStretchLastSection(True)
+        self.twList.currentItemChanged.connect(self.currentItemChangedCB)
 
-	def addAppAction( self, action ):
-		self.insertAction( None , action )
-	
-	def setModifiedFlag( self, modified ):
-		self.modifiedFlag = modified
-		
-	def selectAll( self ):
-		self.twList.setRangeSelected( QTableWidgetSelectionRange ( 0, 0, self.twList.rowCount()-1, 5 ), True )
+        self.currentItem = None
+        self.setContextMenuPolicy(Qt.ActionsContextMenu)
+        self.modifiedFlag = False
 
-	def deselectAll( self ):
-		self.twList.setRangeSelected( QTableWidgetSelectionRange ( 0, 0, self.twList.rowCount()-1, 5 ), False )
+        selectAllAction = QAction("Select All", self)
+        removeAction = QAction("Remove Selected Items", self)
+        self.separator = QAction("", self)
+        self.separator.setSeparator(True)
 
-	def removeArchiveList( self, ca_list ):
-		self.twList.setSortingEnabled(False)
-		for ca in ca_list:
-			for row in range(self.twList.rowCount()):
-				row_ca = self.getArchiveByRow( row )
-				if row_ca == ca:
-					self.twList.removeRow(row)
-					break
-		self.twList.setSortingEnabled(True)
-				
-	def getArchiveByRow( self, row):
-		fi = self.twList.item(row, FileSelectionList.dataColNum).data( Qt.UserRole ).toPyObject()
-		return fi.ca
-	
-	def getCurrentArchive( self ):
-		return self.getArchiveByRow( self.twList.currentRow() )
-	
-	def removeSelection( self ):
-		row_list = []
-		for item in self.twList.selectedItems():
-			if item.column() == 0:
-			    row_list.append(item.row())
+        selectAllAction.setShortcut('Ctrl+A')
+        removeAction.setShortcut('Ctrl+X')
 
-		if len(row_list) == 0:
-			return
-		
-		if self.twList.currentRow() in row_list:
-			if not self.modifiedFlagVerification( "Remove Archive",
-					"If you close this archive, data in the form will be lost.  Are you sure?"):
-				return
-		
-		row_list.sort()
-		row_list.reverse()
+        selectAllAction.triggered.connect(self.selectAll)
+        removeAction.triggered.connect(self.removeSelection)
 
-		self.twList.currentItemChanged.disconnect( self.currentItemChangedCB )
-		self.twList.setSortingEnabled(False)
+        self.addAction(selectAllAction)
+        self.addAction(removeAction)
+        self.addAction(self.separator)
 
-		for i in row_list:
-			self.twList.removeRow(i)
-			
-		self.twList.setSortingEnabled(True)
-		self.twList.currentItemChanged.connect( self.currentItemChangedCB )
-		
-		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.currentItemChangedCB( self.twList.currentItem(), None)	
-			self.twList.selectRow(0)
-		else:
-			self.listCleared.emit()
-	
-	def addPathList( self, pathlist ):
-		
-		filelist = utils.get_recursive_filelist( pathlist )
-			
-		# we now have a list of files to add
+    def getSorting(self):
+        col = self.twList.horizontalHeader().sortIndicatorSection()
+        order = self.twList.horizontalHeader().sortIndicatorOrder()
+        return col, order
 
-		progdialog = QProgressDialog("", "Cancel", 0, len(filelist), self)
-		progdialog.setWindowTitle( "Adding Files" )
-		#progdialog.setWindowModality(Qt.WindowModal)
-		progdialog.setWindowModality(Qt.ApplicationModal)		
-		progdialog.show()
-		
-		firstAdded = None
-		self.twList.setSortingEnabled(False)
-		for idx,f in enumerate(filelist):
-			QCoreApplication.processEvents()
-			if progdialog.wasCanceled():
-				break
-			progdialog.setValue(idx)
-			progdialog.setLabelText(f)
-			utils.centerWindowOnParent( progdialog )
-			QCoreApplication.processEvents()
-			row = self.addPathItem( f )
-			if firstAdded is None and row is not None:
-				firstAdded = row
-			
-		progdialog.close()
-		if firstAdded is not None:
-			self.twList.selectRow(firstAdded)
-		else:
-			if len(pathlist) == 1 and os.path.isfile(pathlist[0]):
-				QMessageBox.information(self, self.tr("File Open"), self.tr("Selected file doesn't seem to be a comic archive."))
-			else:
-				QMessageBox.information(self, self.tr("File/Folder Open"), self.tr("No comic archives were found."))
-			
-		
-		self.twList.setSortingEnabled(True)
-		
-		# Adjust column size
-		self.twList.resizeColumnsToContents()
-		self.twList.setColumnWidth(FileSelectionList.CRFlagColNum, 35) 
-		self.twList.setColumnWidth(FileSelectionList.CBLFlagColNum, 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 setSorting(self, col, order):
+        col = self.twList.horizontalHeader().setSortIndicator(col, order)
 
-	def isListDupe( self, path ):
-		r = 0
-		while r < self.twList.rowCount():
-			ca = self.getArchiveByRow( r )
-			if ca.path == path:
-				return True
-			r = r + 1
-			
-		return False		
-		
-	def addPathItem( self, path):
-		path = unicode( path )
-		path = os.path.abspath( path ) 
-		#print "processing", path
-		
-		if self.isListDupe(path):
-			return None
-		
-		ca = ComicArchive( path, self.settings )
-			
-		if ca.seemsToBeAComicArchive() :
-			row = self.twList.rowCount()
-			self.twList.insertRow( row )
-			
-			fi = FileInfo( ca )
-			
-			filename_item = QTableWidgetItem()
-			folder_item =   QTableWidgetItem()
-			cix_item =      FileTableWidgetItem()
-			cbi_item =      FileTableWidgetItem()
-			readonly_item = FileTableWidgetItem()
-			type_item =     QTableWidgetItem()
-	
-			filename_item.setFlags(Qt.ItemIsSelectable| Qt.ItemIsEnabled)
-			filename_item.setData( Qt.UserRole , fi )
-			self.twList.setItem(row, FileSelectionList.fileColNum, filename_item)
-					
-			folder_item.setFlags(Qt.ItemIsSelectable| Qt.ItemIsEnabled)
-			self.twList.setItem(row, FileSelectionList.folderColNum, folder_item)
+    def addAppAction(self, action):
+        self.insertAction(None, action)
 
-			type_item.setFlags(Qt.ItemIsSelectable| Qt.ItemIsEnabled)
-			self.twList.setItem(row, FileSelectionList.typeColNum, type_item)
+    def setModifiedFlag(self, modified):
+        self.modifiedFlag = modified
 
-			cix_item.setFlags(Qt.ItemIsSelectable| Qt.ItemIsEnabled)
-			cix_item.setTextAlignment(Qt.AlignHCenter)
-			self.twList.setItem(row, FileSelectionList.CRFlagColNum, cix_item)
+    def selectAll(self):
+        self.twList.setRangeSelected(
+            QTableWidgetSelectionRange(
+                0,
+                0,
+                self.twList.rowCount() -
+                1,
+                5),
+            True)
 
-			cbi_item.setFlags(Qt.ItemIsSelectable| Qt.ItemIsEnabled)
-			cbi_item.setTextAlignment(Qt.AlignHCenter)
-			self.twList.setItem(row, FileSelectionList.CBLFlagColNum, cbi_item)
+    def deselectAll(self):
+        self.twList.setRangeSelected(
+            QTableWidgetSelectionRange(
+                0,
+                0,
+                self.twList.rowCount() -
+                1,
+                5),
+            False)
 
-			readonly_item.setFlags(Qt.ItemIsSelectable| Qt.ItemIsEnabled)
-			readonly_item.setTextAlignment(Qt.AlignHCenter)
-			self.twList.setItem(row, FileSelectionList.readonlyColNum, readonly_item)
-			
-			self.updateRow( row )
-			
-			return row
+    def removeArchiveList(self, ca_list):
+        self.twList.setSortingEnabled(False)
+        for ca in ca_list:
+            for row in range(self.twList.rowCount()):
+                row_ca = self.getArchiveByRow(row)
+                if row_ca == ca:
+                    self.twList.removeRow(row)
+                    break
+        self.twList.setSortingEnabled(True)
 
-	def updateRow( self, row ):
-		fi = self.twList.item( row, FileSelectionList.dataColNum ).data( Qt.UserRole ).toPyObject()
+    def getArchiveByRow(self, row):
+        fi = self.twList.item(row, FileSelectionList.dataColNum).data(
+            Qt.UserRole)
+        return fi.ca
 
-		filename_item =  self.twList.item( row, FileSelectionList.fileColNum )
-		folder_item =    self.twList.item( row, FileSelectionList.folderColNum )
-		cix_item =       self.twList.item( row, FileSelectionList.CRFlagColNum )
-		cbi_item =       self.twList.item( row, FileSelectionList.CBLFlagColNum )
-		type_item =      self.twList.item( row, FileSelectionList.typeColNum )
-		readonly_item =  self.twList.item( row, FileSelectionList.readonlyColNum )
+    def getCurrentArchive(self):
+        return self.getArchiveByRow(self.twList.currentRow())
 
-		item_text = os.path.split(fi.ca.path)[0]
-		folder_item.setText( item_text )
-		folder_item.setData( Qt.ToolTipRole, item_text )
+    def removeSelection(self):
+        row_list = []
+        for item in self.twList.selectedItems():
+            if item.column() == 0:
+                row_list.append(item.row())
 
-		item_text = os.path.split(fi.ca.path)[1]
-		filename_item.setText( item_text )
-		filename_item.setData( Qt.ToolTipRole, item_text )
+        if len(row_list) == 0:
+            return
 
-		if fi.ca.isZip():
-			item_text = "ZIP"     
-		elif fi.ca.isRar():
-			item_text = "RAR"     
-		else:
-			item_text = ""     
-		type_item.setText( item_text )
-		type_item.setData( Qt.ToolTipRole, item_text )
+        if self.twList.currentRow() in row_list:
+            if not self.modifiedFlagVerification(
+                    "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.currentItemChangedCB)
+        self.twList.setSortingEnabled(False)
+
+        for i in row_list:
+            self.twList.removeRow(i)
+
+        self.twList.setSortingEnabled(True)
+        self.twList.currentItemChanged.connect(self.currentItemChangedCB)
+
+        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.currentItemChangedCB(self.twList.currentItem(), None)
+            self.twList.selectRow(0)
+        else:
+            self.listCleared.emit()
+
+    def addPathList(self, pathlist):
+
+        filelist = utils.get_recursive_filelist(pathlist)
+        # we now have a list of files to add
+
+        # Prog dialog on Linux flakes out for small range, so scale up
+        progdialog = QProgressDialog("", "Cancel", 0, len(filelist), parent=self)
+        progdialog.setWindowTitle("Adding Files")
+        progdialog.setWindowModality(Qt.ApplicationModal)
+        progdialog.setMinimumDuration(300)
+        centerWindowOnParent(progdialog)
+        #QCoreApplication.processEvents()
+        #progdialog.show()
+        
+        QCoreApplication.processEvents()
+        firstAdded = None
+        self.twList.setSortingEnabled(False)
+        for idx, f in enumerate(filelist):
+            QCoreApplication.processEvents()
+            if progdialog.wasCanceled():
+                break
+            progdialog.setValue(idx+1)
+            progdialog.setLabelText(f)
+            centerWindowOnParent(progdialog)
+            QCoreApplication.processEvents()
+            row = self.addPathItem(f)
+            if firstAdded is None and row is not None:
+                firstAdded = row
+ 
+        progdialog.hide()
+        QCoreApplication.processEvents()
+
+        if firstAdded is not None:
+            self.twList.selectRow(firstAdded)
+        else:
+            if len(pathlist) == 1 and os.path.isfile(pathlist[0]):
+                QMessageBox.information(self, self.tr("File Open"), self.tr(
+                    "Selected file doesn't seem to be a comic archive."))
+            else:
+                QMessageBox.information(
+                    self,
+                    self.tr("File/Folder Open"),
+                    self.tr("No readable comic archives were found."))
+
+        self.twList.setSortingEnabled(True)
+
+        # Adjust column size
+        self.twList.resizeColumnsToContents()
+        self.twList.setColumnWidth(FileSelectionList.CRFlagColNum, 35)
+        self.twList.setColumnWidth(FileSelectionList.CBLFlagColNum, 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 isListDupe(self, path):
+        r = 0
+        while r < self.twList.rowCount():
+            ca = self.getArchiveByRow(r)
+            if ca.path == path:
+                return True
+            r = r + 1
+
+        return False
+
+    def getCurrentListRow(self, path):
+        r = 0
+        while r < self.twList.rowCount():
+            ca = self.getArchiveByRow(r)
+            if ca.path == path:
+                return r
+            r = r + 1
+
+        return -1
+
+    def addPathItem(self, path):
+        path = str(path)
+        path = os.path.abspath(path)
+        # print "processing", path
+
+        if self.isListDupe(path):
+            return self.getCurrentListRow(path)
+
+        ca = ComicArchive(
+            path,
+            self.settings.rar_exe_path,
+            ComicTaggerSettings.getGraphic('nocover.png'))
+
+        if ca.seemsToBeAComicArchive():
+            row = self.twList.rowCount()
+            self.twList.insertRow(row)
+
+            fi = FileInfo(ca)
+
+            filename_item = QTableWidgetItem()
+            folder_item = QTableWidgetItem()
+            cix_item = FileTableWidgetItem()
+            cbi_item = FileTableWidgetItem()
+            readonly_item = FileTableWidgetItem()
+            type_item = QTableWidgetItem()
+
+            filename_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            filename_item.setData(Qt.UserRole, fi)
+            self.twList.setItem(
+                row, FileSelectionList.fileColNum, filename_item)
+
+            folder_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            self.twList.setItem(
+                row, FileSelectionList.folderColNum, folder_item)
+
+            type_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            self.twList.setItem(row, FileSelectionList.typeColNum, type_item)
+
+            cix_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            cix_item.setTextAlignment(Qt.AlignHCenter)
+            self.twList.setItem(row, FileSelectionList.CRFlagColNum, cix_item)
+
+            cbi_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            cbi_item.setTextAlignment(Qt.AlignHCenter)
+            self.twList.setItem(row, FileSelectionList.CBLFlagColNum, cbi_item)
+
+            readonly_item.setFlags(Qt.ItemIsSelectable | Qt.ItemIsEnabled)
+            readonly_item.setTextAlignment(Qt.AlignHCenter)
+            self.twList.setItem(
+                row, FileSelectionList.readonlyColNum, readonly_item)
+
+            self.updateRow(row)
+
+            return row
+
+    def updateRow(self, row):
+        fi = self.twList.item(row, FileSelectionList.dataColNum).data(
+            Qt.UserRole) #.toPyObject()
+
+        filename_item = self.twList.item(row, FileSelectionList.fileColNum)
+        folder_item = self.twList.item(row, FileSelectionList.folderColNum)
+        cix_item = self.twList.item(row, FileSelectionList.CRFlagColNum)
+        cbi_item = self.twList.item(row, FileSelectionList.CBLFlagColNum)
+        type_item = self.twList.item(row, FileSelectionList.typeColNum)
+        readonly_item = self.twList.item(row, FileSelectionList.readonlyColNum)
+
+        item_text = os.path.split(fi.ca.path)[0]
+        folder_item.setText(item_text)
+        folder_item.setData(Qt.ToolTipRole, item_text)
+
+        item_text = os.path.split(fi.ca.path)[1]
+        filename_item.setText(item_text)
+        filename_item.setData(Qt.ToolTipRole, item_text)
+
+        if fi.ca.isZip():
+            item_text = "ZIP"
+        elif fi.ca.isRar():
+            item_text = "RAR"
+        else:
+            item_text = ""
+        type_item.setText(item_text)
+        type_item.setData(Qt.ToolTipRole, item_text)
+
+        if fi.ca.hasCIX():
+            cix_item.setCheckState(Qt.Checked)
+            cix_item.setData(Qt.UserRole, True)
+        else:
+            cix_item.setData(Qt.UserRole, False)
+            cix_item.setCheckState(Qt.Unchecked)
+
+        if fi.ca.hasCBI():
+            cbi_item.setCheckState(Qt.Checked)
+            cbi_item.setData(Qt.UserRole, True)
+        else:
+            cbi_item.setData(Qt.UserRole, False)
+            cbi_item.setCheckState(Qt.Unchecked)
+
+        if not fi.ca.isWritable():
+            readonly_item.setCheckState(Qt.Checked)
+            readonly_item.setData(Qt.UserRole, True)
+        else:
+            readonly_item.setData(Qt.UserRole, False)
+            readonly_item.setCheckState(Qt.Unchecked)
+
+        # Reading these will force them into the ComicArchive's cache
+        fi.ca.readCIX()
+        fi.ca.hasCBI()
+
+    def getSelectedArchiveList(self):
+        ca_list = []
+        for r in range(self.twList.rowCount()):
+            item = self.twList.item(r, FileSelectionList.dataColNum)
+            if item.isSelected():
+                fi = item.data(Qt.UserRole)
+                ca_list.append(fi.ca)
+
+        return ca_list
+
+    def updateCurrentRow(self):
+        self.updateRow(self.twList.currentRow())
+
+    def updateSelectedRows(self):
+        self.twList.setSortingEnabled(False)
+        for r in range(self.twList.rowCount()):
+            item = self.twList.item(r, FileSelectionList.dataColNum)
+            if item.isSelected():
+                self.updateRow(r)
+        self.twList.setSortingEnabled(True)
+
+    def currentItemChangedCB(self, curr, prev):
+
+        new_idx = curr.row()
+        old_idx = -1
+        if prev is not None:
+            old_idx = prev.row()
+        #print("old {0} new {1}".format(old_idx, new_idx))
+
+        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.modifiedFlagVerification(
+                    "Change Archive",
+                    "If you change archives now, data in the form will be lost.  Are you sure?"):
+                self.twList.currentItemChanged.disconnect(
+                    self.currentItemChangedCB)
+                self.twList.setCurrentItem(prev)
+                self.twList.currentItemChanged.connect(
+                    self.currentItemChangedCB)
+                # Need to defer this revert selection, for some reason
+                QTimer.singleShot(1, self.revertSelection)
+                return
+
+        fi = self.twList.item(new_idx, FileSelectionList.dataColNum).data(
+            Qt.UserRole) #.toPyObject()
+        self.selectionChanged.emit(QVariant(fi))
+
+    def revertSelection(self):
+        self.twList.selectRow(self.twList.currentRow())
+
+    def modifiedFlagVerification(self, title, desc):
+        if self.modifiedFlag:
+            reply = QMessageBox.question(self,
+                                         self.tr(title),
+                                         self.tr(desc),
+                                         QMessageBox.Yes, QMessageBox.No)
+
+            if reply != QMessageBox.Yes:
+                return False
+        return True
 
 
-		if fi.ca.hasCIX():
-			cix_item.setCheckState(Qt.Checked)       
-			cix_item.setData(Qt.UserRole, True)
-		else:
-			cix_item.setData(Qt.UserRole, False)
-			cix_item.setCheckState(Qt.Unchecked)       
-
-		if fi.ca.hasCBI():
-			cbi_item.setCheckState(Qt.Checked)       
-			cbi_item.setData(Qt.UserRole, True)
-		else:
-			cbi_item.setData(Qt.UserRole, False)
-			cbi_item.setCheckState(Qt.Unchecked)
-
-		if not fi.ca.isWritable():
-			readonly_item.setCheckState(Qt.Checked)       
-			readonly_item.setData(Qt.UserRole, True)
-		else:
-			readonly_item.setData(Qt.UserRole, False)
-			readonly_item.setCheckState(Qt.Unchecked)
-
-			
-		# Reading these will force them into the ComicArchive's cache
-		fi.ca.readCIX()
-		fi.ca.hasCBI()
-
-	def getSelectedArchiveList( self ):
-		ca_list = []
-		for r in range( self.twList.rowCount() ):
-			item = self.twList.item(r, FileSelectionList.dataColNum)
-			if self.twList.isItemSelected(item):
-				fi = item.data( Qt.UserRole ).toPyObject()
-				ca_list.append(fi.ca)
-
-		return ca_list
-	
-	def updateCurrentRow( self ):
-		self.updateRow( self.twList.currentRow() )
-
-	def updateSelectedRows( self ):
-		self.twList.setSortingEnabled(False)
-		for r in range( self.twList.rowCount() ):
-			item = self.twList.item(r, FileSelectionList.dataColNum)
-			if self.twList.isItemSelected(item):
-				self.updateRow( r )
-		self.twList.setSortingEnabled(True)
-			
-	def currentItemChangedCB( self, curr, prev ):
-
-		new_idx = curr.row()
-		old_idx = -1
-		if prev is not None:
-			old_idx = prev.row()
-		#print "old {0} new {1}".format(old_idx, new_idx)
-		
-		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.modifiedFlagVerification( "Change Archive",
-						"If you change archives now, data in the form will be lost.  Are you sure?"):
-				self.twList.currentItemChanged.disconnect( self.currentItemChangedCB )
-				self.twList.setCurrentItem( prev )
-				self.twList.currentItemChanged.connect( self.currentItemChangedCB )
-				# Need to defer this revert selection, for some reason
-				QTimer.singleShot(1, self.revertSelection)
-				return
-
-		fi = self.twList.item( new_idx, FileSelectionList.dataColNum ).data( Qt.UserRole ).toPyObject()		
-		self.selectionChanged.emit( QVariant(fi))
-		
-	def revertSelection( self ):
-		self.twList.selectRow( self.twList.currentRow() )
-		
-	
-	def modifiedFlagVerification( self, title, desc):
-		if self.modifiedFlag:
-			reply = QMessageBox.question(self, 
-			     self.tr(title), 
-			     self.tr(desc),
-			     QMessageBox.Yes, QMessageBox.No )
-			     
-			if reply != QMessageBox.Yes:
-				return False
-		return True
-		
-		
 # Attempt to use a special checkbox widget in the cell.
 # Couldn't figure out how to disable it with "enabled" colors
 #w = QWidget()
 #cb = QCheckBox(w)
-#cb.setCheckState(Qt.Checked)
+# cb.setCheckState(Qt.Checked)
 #layout = QHBoxLayout()
-#layout.addWidget( cb )
-#layout.setAlignment(Qt.AlignHCenter)
-#layout.setMargin(2)
-#w.setLayout(layout)
-#self.twList.setCellWidget( row, 2, w )
+# layout.addWidget(cb)
+# layout.setAlignment(Qt.AlignHCenter)
+# layout.setMargin(2)
+# w.setLayout(layout)
+#self.twList.setCellWidget(row, 2, w)

comictaggerlib/genericmetadata.py

@@ -1,316 +1 @@
-"""
- A python 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  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 utils
-
-# These page info classes are exactly the same as the CIX scheme, since it's unique
-class PageType:
-	FrontCover   = "FrontCover"
-	InnerCover   = "InnerCover"
-	Roundup      = "Roundup"
-	Story        = "Story"
-	Advertisment = "Advertisment"
-	Editorial    = "Editorial"
-	Letters      = "Letters"
-	Preview      = "Preview"
-	BackCover    = "BackCover"
-	Other        = "Other"
-	Deleted      = "Deleted"
-
-"""
-class PageInfo:
-	Image = 0
-	Type = PageType.Story
-	DoublePage = False
-	ImageSize = 0
-	Key = ""
-	ImageWidth = 0
-	ImageHeight = 0
-"""	
-
-class GenericMetadata:
-
-	def __init__(self):
-		
-		self.isEmpty = True
-		self.tagOrigin = None
-		
-		self.series             = None
-		self.issue              = None
-		self.title              = None
-		self.publisher          = None
-		self.month              = None
-		self.year               = None
-		self.day                = None
-		self.issueCount         = None
-		self.volume             = None
-		self.genre              = None
-		self.language           = None  # 2 letter iso code
-		self.comments           = None  # use same way as Summary in CIX
-
-		self.volumeCount        = None
-		self.criticalRating     = None
-		self.country            = None
-		
-		self.alternateSeries    = None
-		self.alternateNumber    = None
-		self.alternateCount     = None
-		self.imprint            = None
-		self.notes              = None
-		self.webLink            = None
-		self.format             = None
-		self.manga              = None
-		self.blackAndWhite      = None
-		self.pageCount          = None
-		self.maturityRating     = None
-		
-		self.storyArc            = None
-		self.seriesGroup         = None
-		self.scanInfo            = None
-		
-		self.characters          = None
-		self.teams               = None
-		self.locations           = None
-
-		self.credits            = list()		
-		self.tags               = list()
-		self.pages              = list()
-
-		# Some CoMet-only items
-		self.price               = None
-		self.isVersionOf         = None
-		self.rights              = None
-		self.identifier          = None
-		self.lastMark            = None
-		self.coverImage	         = None
-
-	def overlay( self, new_md ):
-		# Overlay a metadata object on this one
-		# that is, when the new object has non-None
-		# values, over-write them to this one
-		
-		def assign( cur, new ):
-			if new is not None:
-				if type(new) == str and len(new) == 0:
-					setattr(self, cur, None)
-				else:
-					setattr(self, cur, new)
-				
-		if not new_md.isEmpty:
-			self.isEmpty = False
-				
-		assign( 'series',            new_md.series )
-		assign( "issue",             new_md.issue )
-		assign( "issueCount",        new_md.issueCount )
-		assign( "title",             new_md.title )
-		assign( "publisher",         new_md.publisher )
-		assign( "day",               new_md.day )
-		assign( "month",             new_md.month )
-		assign( "year",              new_md.year )
-		assign( "volume",            new_md.volume )
-		assign( "volumeCount",       new_md.volumeCount )
-		assign( "genre",             new_md.genre )
-		assign( "language",          new_md.language )
-		assign( "country",           new_md.country )
-		assign( "criticalRating",    new_md.criticalRating )
-		assign( "alternateSeries",   new_md.alternateSeries )
-		assign( "alternateNumber",   new_md.alternateNumber )
-		assign( "alternateCount",    new_md.alternateCount )
-		assign( "imprint",           new_md.imprint )
-		assign( "webLink",           new_md.webLink )
-		assign( "format",            new_md.format )
-		assign( "manga",             new_md.manga )
-		assign( "blackAndWhite",     new_md.blackAndWhite )
-		assign( "maturityRating",    new_md.maturityRating )
-		assign( "storyArc",          new_md.storyArc )
-		assign( "seriesGroup",       new_md.seriesGroup )
-		assign( "scanInfo",          new_md.scanInfo )
-		assign( "characters",        new_md.characters )
-		assign( "teams",             new_md.teams )
-		assign( "locations",         new_md.locations )
-		assign( "comments",          new_md.comments )
-		assign( "notes",             new_md.notes )
-
-		assign( "price",             new_md.price )
-		assign( "isVersionOf",       new_md.isVersionOf )
-		assign( "rights",            new_md.rights )
-		assign( "identifier",        new_md.identifier )
-		assign( "lastMark",          new_md.lastMark )
-		
-		self.overlayCredits( new_md.credits )
-		# TODO
-		
-		# not sure if the tags and pages should broken down, or treated
-		# as whole lists.... 
-
-		# For now, go the easy route, where any overlay
-		# value wipes out the whole list
-		if len(new_md.tags) > 0:
-			assign( "tags",  new_md.tags )
-			
-		if len(new_md.pages) > 0:	
-			assign( "pages",           new_md.pages )
-
-	
-	def overlayCredits( self, new_credits ):
-		for c in new_credits:	
-			if c.has_key('primary') and c['primary']:
-				primary = True
-			else:
-				primary = False
-
-			# Remove credit role if person is blank
-			if c['person'] == "":			
-				for r in reversed(self.credits):
-					if r['role'].lower() == c['role'].lower():
-						self.credits.remove(r)
-			# otherwise, add it!
-			else:
-				self.addCredit( c['person'], c['role'], primary )
-	
-	def setDefaultPageList( self, count ):
-		# generate a default page list, with the first page marked as the cover
-		for i in range(count):
-			page_dict = dict()
-			page_dict['Image'] = str(i)
-			if i == 0:
-				page_dict['Type'] = PageType.FrontCover
-			self.pages.append( page_dict )
-
-	def getArchivePageIndex( self, pagenum ):
-		# convert the displayed page number to the page index of the file in the archive
-		if pagenum < len( self.pages ):
-			return int( self.pages[pagenum]['Image'] )
-		else:
-			return 0
-	
-	def getCoverPageIndexList( self ):
-		# return a list of archive page indices of cover pages
-		coverlist = []
-		for p in self.pages:
-			if 'Type' in p and p['Type'] == PageType.FrontCover:
-				coverlist.append( int(p['Image']))
-				
-		if len(coverlist) == 0:
-			coverlist.append( 0 )
-			
-		return coverlist
-	
-	def addCredit( self, person, role, primary = False ):
-		
-		credit = dict()
-		credit['person'] = person
-		credit['role'] = role
-		if primary:
-			credit['primary'] = primary
-
-		# look to see if it's not already there...
-		found = False
-		for c in self.credits:
-			if (   c['person'].lower() == person.lower() and
-				   c['role'].lower() == role.lower() ):
-				# no need to add it. just adjust the "primary" flag as needed
-				c['primary'] = primary
-				found = True
-				break
-		
-		if not found:
-			self.credits.append(credit)
-
-      		
-	def __str__( self ):
-		vals = []
-		if self.isEmpty:
-			return "No metadata"
-
-		def add_string( tag, val ):
-			if val is not None and u"{0}".format(val) != "":
-				vals.append( (tag, val) )
-
-		def add_attr_string( tag ):
-			val = getattr(self,tag)
-			add_string( tag, getattr(self,tag) )
-
-		add_attr_string( "series" )
-		add_attr_string( "issue" )
-		add_attr_string( "issueCount" )
-		add_attr_string( "title" )
-		add_attr_string( "publisher" )
-		add_attr_string( "year" )
-		add_attr_string( "month" )
-		add_attr_string( "day" )
-		add_attr_string( "volume" )
-		add_attr_string( "volumeCount" )
-		add_attr_string( "genre" )
-		add_attr_string( "language" )
-		add_attr_string( "country" )
-		add_attr_string( "criticalRating" )
-		add_attr_string( "alternateSeries" )
-		add_attr_string( "alternateNumber" )
-		add_attr_string( "alternateCount" )
-		add_attr_string( "imprint" )
-		add_attr_string( "webLink" )
-		add_attr_string( "format" )
-		add_attr_string( "manga" )
-
-		add_attr_string( "price" )
-		add_attr_string( "isVersionOf" )
-		add_attr_string( "rights" )
-		add_attr_string( "identifier" )
-		add_attr_string( "lastMark" )
-		
-		if self.blackAndWhite:
-			add_attr_string( "blackAndWhite" )
-		add_attr_string( "maturityRating" )
-		add_attr_string( "storyArc" )
-		add_attr_string( "seriesGroup" )
-		add_attr_string( "scanInfo" )
-		add_attr_string( "characters" )
-		add_attr_string( "teams" )
-		add_attr_string( "locations" )
-		add_attr_string( "comments" )
-		add_attr_string( "notes" )
-		
-		add_string( "tags",  utils.listToString( self.tags ) )
-		 
-		for c in self.credits:
-			primary = ""
-			if c.has_key('primary') and c['primary']: 
-				primary = " [P]"
-			add_string( "credit",  c['role']+": "+c['person'] + 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 = u"{0: <" + str(flen) + "} {1}\n"
-		for i in vals:
-			outstr += fmt_str.format( i[0]+":", i[1] )
-	
-		return outstr
+from comicapi.genericmetadata import *

comictaggerlib/imagefetcher.py

@@ -1,198 +1,191 @@
-"""
-A python class to manage fetching and caching of images by URL
-"""
+"""A class to manage fetching and caching of images by URL"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 sqlite3 as lite
 import os
 import datetime
 import shutil
 import tempfile
-import urllib2, urllib
+import requests
 
-try: 
-	from PyQt4.QtNetwork import QNetworkAccessManager, QNetworkRequest
-	from PyQt4.QtCore import QUrl, pyqtSignal, QObject, QByteArray
-	from PyQt4 import  QtGui
+try:
+    from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest
+    from PyQt5.QtCore import QUrl, pyqtSignal, QObject, QByteArray
+    from PyQt5 import QtGui
 except ImportError:
-	# No Qt, so define a few dummy QObjects to help us compile
-	class QObject():
-		def __init__(self,*args):
-			pass
-	class QByteArray():
-		pass
-	class pyqtSignal():
-		def __init__(self,*args):
-			pass
-		def emit(a,b,c):
-			pass
+    # No Qt, so define a few dummy QObjects to help us compile
+    class QObject():
+
+        def __init__(self, *args):
+            pass
+
+    class QByteArray():
+        pass
+
+    class pyqtSignal():
+
+        def __init__(self, *args):
+            pass
+
+        def emit(a, b, c):
+            pass
+
+from .settings import ComicTaggerSettings
+from . import ctversion
 
-from settings import ComicTaggerSettings 
 
 class ImageFetcherException(Exception):
-	pass
+    pass
+
 
 class ImageFetcher(QObject):
-	
-	fetchComplete = pyqtSignal( QByteArray , int)
 
+    fetchComplete = pyqtSignal(QByteArray, int)
 
-	def __init__(self ):
-		QObject.__init__(self)
+    def __init__(self):
+        QObject.__init__(self)
 
-		self.settings_folder = ComicTaggerSettings.getSettingsFolder()
-		self.db_file = os.path.join( self.settings_folder, "image_url_cache.db" )
-		self.cache_folder = os.path.join( self.settings_folder, "image_cache" )
-		
-		if not os.path.exists( self.db_file ):
-			self.create_image_db()
+        self.settings_folder = ComicTaggerSettings.getSettingsFolder()
+        self.db_file = os.path.join(self.settings_folder, "image_url_cache.db")
+        self.cache_folder = os.path.join(self.settings_folder, "image_cache")
 
-	def clearCache( self ):
-		os.unlink( self.db_file )
-		if os.path.isdir( self.cache_folder ):
-			shutil.rmtree( self.cache_folder )
+        if not os.path.exists(self.db_file):
+            self.create_image_db()
 
+    def clearCache(self):
+        os.unlink(self.db_file)
+        if os.path.isdir(self.cache_folder):
+            shutil.rmtree(self.cache_folder)
 
-	def fetch( self, url, user_data=None, blocking=False  ):
-		"""
-		If called with blocking=True, this will block until the image is 
-		fetched.
-		
-		If called with blocking=False, this will run the fetch in the 
-		background, and emit a signal when done
-		"""
+    def fetch(self, url, user_data=None, blocking=False):
+        """
+        If called with blocking=True, this will block until the image is
+        fetched.
+        If called with blocking=False, this will run the fetch in the
+        background, and emit a signal when done
+        """
 
-		self.user_data = user_data
-		self.fetched_url = url
-		
-		# first look in the DB
-		image_data = self.get_image_from_cache( url )
-		
-		if blocking:
-			if image_data is None:
-				try:
-					image_data = urllib.urlopen(url).read()
-				except Exception as e:
-					print e
-					raise ImageFetcherException("Network Error!")
+        self.user_data = user_data
+        self.fetched_url = url
 
-			# save the image to the cache
-			self.add_image_to_cache( self.fetched_url, image_data )	
-			return image_data
-		
-		else:
-			
-			# if we found it, just emit the signal asap
-			if image_data is not None:
-				self.fetchComplete.emit( QByteArray(image_data), self.user_data )
-				return
-			
-			# didn't find it.  look online
-			self.nam = QNetworkAccessManager()
-			self.nam.finished.connect(self.finishRequest)
-			self.nam.get(QNetworkRequest(QUrl(url)))
-			
-			#we'll get called back when done...
-		
-		
+        # first look in the DB
+        image_data = self.get_image_from_cache(url)
+        if blocking:
+            if image_data is None:
+                try:
+                    print(url)
+                    image_data = requests.get(url, headers={'user-agent': 'comictagger/' + ctversion.version}).content
+                except Exception as e:
+                    print(e)
+                    raise ImageFetcherException("Network Error!")
 
-	def finishRequest(self, reply):
-		
-		# read in the image data
-		image_data = reply.readAll()
-		
-		# save the image to the cache
-		self.add_image_to_cache( self.fetched_url, image_data )	
+            # save the image to the cache
+            self.add_image_to_cache(self.fetched_url, image_data)
+            return image_data
 
-		self.fetchComplete.emit( QByteArray(image_data), self.user_data )
+        else:
 
-		
-		
-	def create_image_db( self ):
-		
-		# this will wipe out any existing version
-		open( self.db_file, 'w').close()
+            # if we found it, just emit the signal asap
+            if image_data is not None:
+                self.fetchComplete.emit(QByteArray(image_data), self.user_data)
+                return
 
-		# wipe any existing image cache folder too
-		if os.path.isdir( self.cache_folder ):
-			shutil.rmtree( self.cache_folder )
-		os.makedirs( self.cache_folder )
+            # didn't find it.  look online
+            self.nam = QNetworkAccessManager()
+            self.nam.finished.connect(self.finishRequest)
+            self.nam.get(QNetworkRequest(QUrl(url)))
 
-		con = lite.connect( self.db_file )
-		
-		# create tables 
-		with con:
-			
-			cur = con.cursor()    
+            # we'll get called back when done...
 
-			cur.execute("CREATE TABLE Images(" +
-							"url TEXT," +
-							"filename TEXT," +
-							"timestamp TEXT," +
-							"PRIMARY KEY (url) )" 
-						)
+    def finishRequest(self, reply):
 
+        # read in the image data
+        image_data = reply.readAll()
 
-	def add_image_to_cache( self, url, image_data ):
+        # save the image to the cache
+        self.add_image_to_cache(self.fetched_url, image_data)
 
-		con = lite.connect( self.db_file )
+        self.fetchComplete.emit(QByteArray(image_data), self.user_data)
 
-		with con:
-			
-			cur = con.cursor()    
-			
-			timestamp = datetime.datetime.now()
-			
-			tmp_fd, filename = tempfile.mkstemp(dir=self.cache_folder, prefix="img")
-			f = os.fdopen(tmp_fd, 'w+b')
-			f.write( image_data )		
-			f.close()
-			
-			cur.execute("INSERT or REPLACE INTO Images VALUES( ?, ?, ? )" ,
-							(url,
-							filename,
-							timestamp ) 
-			            )
+    def create_image_db(self):
 
-	def get_image_from_cache( self, url ):
-		
-		con = lite.connect( self.db_file )
-		with con:
-			cur = con.cursor() 
-			
-			cur.execute("SELECT filename FROM Images WHERE url=?", [ url ])
-			row = cur.fetchone()
+        # this will wipe out any existing version
+        open(self.db_file, 'w').close()
 
-			if row is None :
-				return None
-			else:
-				filename = row[0]
-				image_data = None
+        # wipe any existing image cache folder too
+        if os.path.isdir(self.cache_folder):
+            shutil.rmtree(self.cache_folder)
+        os.makedirs(self.cache_folder)
 
-				try:
-					with open( filename, 'rb' ) as f: 
-						image_data = f.read()
-						f.close()			
-				except IOError as e:
-					pass
-				
-				return image_data
+        con = lite.connect(self.db_file)
 
+        # create tables
+        with con:
 
+            cur = con.cursor()
 
+            cur.execute("CREATE TABLE Images(" +
+                        "url TEXT," +
+                        "filename TEXT," +
+                        "timestamp TEXT," +
+                        "PRIMARY KEY (url))"
+                        )
 
+    def add_image_to_cache(self, url, image_data):
+
+        con = lite.connect(self.db_file)
+
+        with con:
+
+            cur = con.cursor()
+
+            timestamp = datetime.datetime.now()
+
+            tmp_fd, filename = tempfile.mkstemp(
+                dir=self.cache_folder, prefix="img")
+            f = os.fdopen(tmp_fd, 'w+b')
+            f.write(image_data)
+            f.close()
+
+            cur.execute("INSERT or REPLACE INTO Images VALUES(?, ?, ?)",
+                        (url,
+                         filename,
+                         timestamp)
+                        )
+
+    def get_image_from_cache(self, url):
+
+        con = lite.connect(self.db_file)
+        with con:
+            cur = con.cursor()
+
+            cur.execute("SELECT filename FROM Images WHERE url=?", [url])
+            row = cur.fetchone()
+
+            if row is None:
+                return None
+            else:
+                filename = row[0]
+                image_data = None
+
+                try:
+                    with open(filename, 'rb') as f:
+                        image_data = f.read()
+                        f.close()
+                except IOError as e:
+                    pass
+
+                return image_data

comictaggerlib/imagehasher.py

@@ -1,198 +1,192 @@
-"""
-A pthyon class to manage creating image content hashes, and calculate hamming distances
-"""
+"""A class to manage creating image content hashes, and calculate hamming distances"""
 
-"""
-Copyright 2013  Anthony Beville
+# Copyright 2013 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
+# 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
+#     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 StringIO
+# 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 io
 import sys
+from functools import reduce
 
-try: 
-	import Image
-	pil_available = True
+try:
+    from PIL import Image
+    from PIL import WebPImagePlugin
+    pil_available = True
 except ImportError:
-	pil_available = False
-
+    pil_available = False
 
 
 class ImageHasher(object):
-	def __init__(self, path=None, data=None, width=8, height=8):
-		#self.hash_size = size
-		self.width = width
-		self.height = height
 
-		if path is None and data is None:
-			raise IOError
-		else:
-			try:
-				if path is not None:
-					self.image = Image.open(path)
-				else:
-					self.image = Image.open(StringIO.StringIO(data))
-			except:
-				print "Image data seems corrupted!"
-				# just generate a bogus image
-				self.image = Image.new( "L", (1,1))
+    def __init__(self, path=None, data=None, width=8, height=8):
+        #self.hash_size = size
+        self.width = width
+        self.height = height
 
-	def average_hash(self):
-		try:
-			image = self.image.resize((self.width, self.height), Image.ANTIALIAS).convert("L")
-		except Exception as e:
-			sys.exc_clear()
-			print "average_hash error:", e
-			return long(0)
-		
-		pixels = list(image.getdata())
-		avg = sum(pixels) / len(pixels)
-		
-		def compare_value_to_avg(i):
-			return ( 1 if i > avg else 0 )
-				
-		bitlist = map(compare_value_to_avg, pixels)
-		
-		# build up an int value from the bit list, one bit at a time
-		def set_bit( x, (idx, val) ):
-			return (x | (val << idx))
-			
-		result = reduce(set_bit, enumerate(bitlist), 0)
-		
-		#print "{0:016x}".format(result)
-		return result
+        if path is None and data is None:
+            raise IOError
+        else:
+            try:
+                if path is not None:
+                    self.image = Image.open(path)
+                else:
+                    self.image = Image.open(io.BytesIO(data))
+            except Exception as e:
+                print("Image data seems corrupted! [{}]".format(e))
+                # just generate a bogus image
+                self.image = Image.new("L", (1, 1))
 
-	def average_hash2( self ):
-		pass
-		"""
-		# Got this one from somewhere on the net.  Not a clue how the 'convolve2d'
-		# works! 
+    def average_hash(self):
+        try:
+            image = self.image.resize(
+                (self.width, self.height), Image.ANTIALIAS).convert("L")
+        except Exception as e:
+            print("average_hash error:", e)
+            return int(0)
 
-		from numpy import array 
-		from scipy.signal import convolve2d
-				
-		im = self.image.resize((self.width, self.height), Image.ANTIALIAS).convert('L')
+        pixels = list(image.getdata())
+        avg = sum(pixels) / len(pixels)
 
-		in_data = array((im.getdata())).reshape(self.width, self.height)
-		filt = array([[0,1,0],[1,-4,1],[0,1,0]])
-		filt_data = convolve2d(in_data,filt,mode='same',boundary='symm').flatten()
-		
-		result = reduce(lambda x, (y, z): x | (z << y),
-		                 enumerate(map(lambda i: 0 if i < 0 else 1, filt_data)),
-		                 0)
-		#print "{0:016x}".format(result)
-		return result
-		"""
-		
-	def dct_average_hash(self):
-		pass
-		"""
-		# Algorithm source: http://syntaxcandy.blogspot.com/2012/08/perceptual-hash.html
-		
-		1. Reduce size. Like Average Hash, pHash starts with a small image. 
-		However, the image is larger than 8x8; 32x32 is a 	good size. This 
-		is really done to simplify the DCT computation and not because it 
-		is needed to reduce the high frequencies.
+        def compare_value_to_avg(i):
+            return (1 if i > avg else 0)
 
-		2. Reduce color. The image is reduced to a grayscale just to further 
-		simplify the number of computations.
-		
-		3. Compute the DCT. The DCT separates the image into a collection of
-		frequencies and scalars. While JPEG uses 	an 8x8 DCT, this algorithm 
-		uses a 32x32 DCT.
-		
-		4. Reduce the DCT. This is the magic step. While the DCT is 32x32, 
-		just keep the top-left 8x8. Those represent the lowest frequencies in 
-		the picture.
-		
-		5. Compute the average value. Like the Average Hash, compute the mean DCT 
-		value (using only the 8x8 DCT low-frequency values and excluding the first 
-		term since the DC coefficient can be significantly different 	from the other 
-		values and will throw off the average). Thanks to David Starkweather for the 
-		added information about pHash. He wrote: "the dct hash is based on the low 2D
-		DCT coefficients starting at the second from lowest, leaving out the first DC
-		term. This excludes completely flat image information (i.e. solid colors) from
-		being included in the hash description."
-		
-		6. Further reduce the DCT. This is the magic step. Set the 64 hash bits to 0 or
-		1 depending on whether 	each of the 64 DCT values is above or below the average 
-		value. The result doesn't tell us the actual low frequencies; it just tells us
-		the very-rough relative scale of the frequencies to the mean. The result will not
-		vary as long as the overall structure of the image remains the same; this can 
-		survive gamma and color histogram adjustments without a problem.
-		
-		7. Construct the hash. Set the 64 bits into a 64-bit integer. The order does not 
-		matter, just as long as you are consistent. 
-		"""
-		"""
-		import numpy
-		import scipy.fftpack
-		numpy.set_printoptions(threshold=10000, linewidth=200, precision=2, suppress=True)
+        bitlist = list(map(compare_value_to_avg, pixels))
 
-		# Step 1,2
-		im = self.image.resize((32, 32), Image.ANTIALIAS).convert("L")
-		in_data = numpy.asarray(im)
-		
-		# Step 3
-		dct = scipy.fftpack.dct( in_data.astype(float) )
-	
-		# Step 4
-		# Just skip the top and left rows when slicing, as suggested somewhere else...
-		lofreq_dct = dct[1:9, 1:9].flatten()
-		
-		# Step 5
-		avg = ( lofreq_dct.sum() ) / ( lofreq_dct.size  )
-		median = numpy.median( lofreq_dct )
+        # build up an int value from the bit list, one bit at a time
+        def set_bit(x, idx_val):
+            (idx, val) = idx_val
+            return (x | (val << idx))
 
-		thresh = avg
+        result = reduce(set_bit, enumerate(bitlist), 0)
 
-		# Step 6
-		def compare_value_to_thresh(i):
-			return ( 1 if i > thresh else 0 )
-				
-		bitlist = map(compare_value_to_thresh, lofreq_dct)
-		
-		#Step 7
-		def set_bit( x, (idx, val) ):
-			return (x | (val << idx))
-			
-		result = reduce(set_bit, enumerate(bitlist), long(0))
-
-
-		#print "{0:016x}".format(result)
-		return result
-		"""
-
-	#accepts 2 hashes (longs or hex strings) and returns the hamming distance
-	
-	@staticmethod
-	def hamming_distance(h1, h2):
-		if type(h1) == long or type(h1) == int:
-			n1 = h1
-			n2 = h2
-		else:
-			# convert hex strings to ints
-			n1 = long( h1, 16)
-			n2 = long( h2, 16)
-			
-		# xor the two numbers
-		n = n1 ^ n2
-
-		#count up the 1's in the binary string 
-		return sum( b == '1' for b in bin(n)[2:] )
+        # print("{0:016x}".format(result))
+        return result
+
+    def average_hash2(self):
+        pass
+        """
+        # Got this one from somewhere on the net.  Not a clue how the 'convolve2d'
+        # works!
+
+        from numpy import array
+        from scipy.signal import convolve2d
+
+        im = self.image.resize((self.width, self.height), Image.ANTIALIAS).convert('L')
+
+        in_data = array((im.getdata())).reshape(self.width, self.height)
+        filt = array([[0,1,0],[1,-4,1],[0,1,0]])
+        filt_data = convolve2d(in_data,filt,mode='same',boundary='symm').flatten()
+
+        result = reduce(lambda x, (y, z): x | (z << y),
+                         enumerate(map(lambda i: 0 if i < 0 else 1, filt_data)),
+                         0)
+        #print("{0:016x}".format(result))
+        return result
+        """
+
+    def dct_average_hash(self):
+        pass
+        """
+        # Algorithm source: http://syntaxcandy.blogspot.com/2012/08/perceptual-hash.html
+
+        1. Reduce size. Like Average Hash, pHash starts with a small image.
+        However, the image is larger than 8x8; 32x32 is a     good size. This
+        is really done to simplify the DCT computation and not because it
+        is needed to reduce the high frequencies.
+
+        2. Reduce color. The image is reduced to a grayscale just to further
+        simplify the number of computations.
+
+        3. Compute the DCT. The DCT separates the image into a collection of
+        frequencies and scalars. While JPEG uses     an 8x8 DCT, this algorithm
+        uses a 32x32 DCT.
+
+        4. Reduce the DCT. This is the magic step. While the DCT is 32x32,
+        just keep the top-left 8x8. Those represent the lowest frequencies in
+        the picture.
+
+        5. Compute the average value. Like the Average Hash, compute the mean DCT
+        value (using only the 8x8 DCT low-frequency values and excluding the first
+        term since the DC coefficient can be significantly different     from the other
+        values and will throw off the average). Thanks to David Starkweather for the
+        added information about pHash. He wrote: "the dct hash is based on the low 2D
+        DCT coefficients starting at the second from lowest, leaving out the first DC
+        term. This excludes completely flat image information (i.e. solid colors) from
+        being included in the hash description."
+
+        6. Further reduce the DCT. This is the magic step. Set the 64 hash bits to 0 or
+        1 depending on whether     each of the 64 DCT values is above or below the average
+        value. The result doesn't tell us the actual low frequencies; it just tells us
+        the very-rough relative scale of the frequencies to the mean. The result will not
+        vary as long as the overall structure of the image remains the same; this can
+        survive gamma and color histogram adjustments without a problem.
+
+        7. Construct the hash. Set the 64 bits into a 64-bit integer. The order does not
+        matter, just as long as you are consistent.
+        """
+        """
+        import numpy
+        import scipy.fftpack
+        numpy.set_printoptions(threshold=10000, linewidth=200, precision=2, suppress=True)
+
+        # Step 1,2
+        im = self.image.resize((32, 32), Image.ANTIALIAS).convert("L")
+        in_data = numpy.asarray(im)
+
+        # Step 3
+        dct = scipy.fftpack.dct(in_data.astype(float))
+
+        # Step 4
+        # Just skip the top and left rows when slicing, as suggested somewhere else...
+        lofreq_dct = dct[1:9, 1:9].flatten()
+
+        # Step 5
+        avg = (lofreq_dct.sum()) / (lofreq_dct.size)
+        median = numpy.median(lofreq_dct)
+
+        thresh = avg
+
+        # Step 6
+        def compare_value_to_thresh(i):
+            return (1 if i > thresh else 0)
+
+        bitlist = map(compare_value_to_thresh, lofreq_dct)
+
+        #Step 7
+        def set_bit(x, (idx, val)):
+            return (x | (val << idx))
+
+        result = reduce(set_bit, enumerate(bitlist), long(0))
 
 
+        #print("{0:016x}".format(result))
+        return result
+        """
 
+    # accepts 2 hashes (longs or hex strings) and returns the hamming distance
 
+    @staticmethod
+    def hamming_distance(h1, h2):
+        if isinstance(h1, int) or isinstance(h1, int):
+            n1 = h1
+            n2 = h2
+        else:
+            # convert hex strings to ints
+            n1 = int(h1, 16)
+            n2 = int(h2, 16)
 
+        # xor the two numbers
+        n = n1 ^ n2
 
+        # count up the 1's in the binary string
+        return sum(b == '1' for b in bin(n)[2:])

comictaggerlib/imagepopup.py

@@ -1,86 +1,93 @@
-"""
-A PyQT4 widget to display a popup image
-"""
+"""A PyQT4 widget to display a popup image"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
+#import sys
+#import os
+
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+
+from .settings import ComicTaggerSettings
 
 
-class ImagePopup(QtGui.QDialog):
-	
-	def __init__(self, parent, image_pixmap):
-		super(ImagePopup, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('imagepopup.ui' ), self)
+class ImagePopup(QtWidgets.QDialog):
 
-		QtGui.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.WaitCursor))
+    def __init__(self, parent, image_pixmap):
+        super(ImagePopup, self).__init__(parent)
 
-		#self.setWindowModality(QtCore.Qt.WindowModal)
-		self.setWindowFlags(QtCore.Qt.Popup)
-		self.setWindowState(QtCore.Qt.WindowFullScreen)
-	
-		self.imagePixmap = image_pixmap
-		
-		screen_size = QtGui.QDesktopWidget().screenGeometry()
-		self.resize(screen_size.width(), screen_size.height())
-		self.move( 0, 0)
-		
-		# This is a total hack.  Uses a snapshot of the desktop, and overlays a
-		# translucent screen over it.  Probably can do it better by setting opacity of a
-		# widget
-		self.desktopBg = QtGui.QPixmap.grabWindow(QtGui.QApplication.desktop ().winId(), 
-			0,0, screen_size.width(), screen_size.height())
-		bg = QtGui.QPixmap(ComicTaggerSettings.getGraphic('popup_bg.png')) 
-		self.clientBgPixmap = bg.scaled(screen_size.width(), screen_size.height())		
-		self.setMask(self.clientBgPixmap.mask())
+        uic.loadUi(ComicTaggerSettings.getUIFile('imagepopup.ui'), self)
 
-		self.applyImagePixmap()
-		self.showFullScreen()
-		self.raise_(  )
-		QtGui.QApplication.restoreOverrideCursor()		
+        QtWidgets.QApplication.setOverrideCursor(
+            QtGui.QCursor(QtCore.Qt.WaitCursor))
 
-	def paintEvent (self, event):
-		self.painter = QtGui.QPainter(self)
-		self.painter.setRenderHint(QtGui.QPainter.Antialiasing)
-		self.painter.drawPixmap(0, 0, self.desktopBg)
-		self.painter.drawPixmap(0, 0, self.clientBgPixmap)
-		self.painter.end()		
+        # self.setWindowModality(QtCore.Qt.WindowModal)
+        self.setWindowFlags(QtCore.Qt.Popup)
+        self.setWindowState(QtCore.Qt.WindowFullScreen)
 
-	def applyImagePixmap( self ):
-		win_h = self.height()
-		win_w = self.width() 
-	
-		if self.imagePixmap.width() >  win_w or self.imagePixmap.height() > win_h:
-			# scale the pixmap to fit in the frame
-			display_pixmap = self.imagePixmap.scaled(win_w, win_h, QtCore.Qt.KeepAspectRatio)			
-			self.lblImage.setPixmap( display_pixmap )
-		else:
-			display_pixmap = self.imagePixmap
-		self.lblImage.setPixmap( display_pixmap )
-			
-		# move and resize the label to be centered in the fame
-		img_w = display_pixmap.width()
-		img_h = display_pixmap.height()
-		self.lblImage.resize( img_w, img_h )
-		self.lblImage.move( (win_w - img_w)/2, (win_h - img_h)/2 )
+        self.imagePixmap = image_pixmap
 
-	def	mousePressEvent( self , event):
-		self.close()
+        screen_size = QtWidgets.QDesktopWidget().screenGeometry()
+        self.resize(screen_size.width(), screen_size.height())
+        self.move(0, 0)
+
+        # This is a total hack.  Uses a snapshot of the desktop, and overlays a
+        # translucent screen over it.  Probably can do it better by setting opacity of a
+        # widget
+        screen = QtWidgets.QApplication.primaryScreen()
+        self.desktopBg = screen.grabWindow(
+            QtWidgets.QApplication.desktop().winId(),
+            0,
+            0,
+            screen_size.width(),
+            screen_size.height())
+        bg = QtGui.QPixmap(ComicTaggerSettings.getGraphic('popup_bg.png'))
+        self.clientBgPixmap = bg.scaled(
+            screen_size.width(), screen_size.height())
+        self.setMask(self.clientBgPixmap.mask())
+
+        self.applyImagePixmap()
+        self.showFullScreen()
+        self.raise_()
+        QtWidgets.QApplication.restoreOverrideCursor()
+
+    def paintEvent(self, event):
+        self.painter = QtGui.QPainter(self)
+        self.painter.setRenderHint(QtGui.QPainter.Antialiasing)
+        self.painter.drawPixmap(0, 0, self.desktopBg)
+        self.painter.drawPixmap(0, 0, self.clientBgPixmap)
+        self.painter.end()
+
+    def applyImagePixmap(self):
+        win_h = self.height()
+        win_w = self.width()
+
+        if self.imagePixmap.width(
+        ) > win_w or self.imagePixmap.height() > win_h:
+            # scale the pixmap to fit in the frame
+            display_pixmap = self.imagePixmap.scaled(
+                win_w, win_h, QtCore.Qt.KeepAspectRatio)
+            self.lblImage.setPixmap(display_pixmap)
+        else:
+            display_pixmap = self.imagePixmap
+        self.lblImage.setPixmap(display_pixmap)
+
+        # move and resize the label to be centered in the fame
+        img_w = display_pixmap.width()
+        img_h = display_pixmap.height()
+        self.lblImage.resize(img_w, img_h)
+        self.lblImage.move((win_w - img_w) / 2, (win_h - img_h) / 2)
+
+    def mousePressEvent(self, event):
+        self.close()

comictaggerlib/issueselectionwindow.py

@@ -1,174 +1,188 @@
-"""
-A PyQT4 dialog to select specific issue from list
-"""
+"""A PyQT4 dialog to select specific issue from list"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
-import re
-from PyQt4 import QtCore, QtGui, uic
+#import sys
+#import os
+#import re
 
-from PyQt4.QtCore import QUrl, pyqtSignal, QByteArray
-from PyQt4.QtNetwork import QNetworkAccessManager, QNetworkRequest
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+#from PyQt5.QtCore import QUrl, pyqtSignal, QByteArray
+#from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest
 
-from comicvinetalker import ComicVineTalker, ComicVineTalkerException
-from  imagefetcher import  ImageFetcher
-from settings import ComicTaggerSettings
-from issuestring import IssueString
-from coverimagewidget import CoverImageWidget
-import utils
+from .comicvinetalker import ComicVineTalker, ComicVineTalkerException
+from .settings import ComicTaggerSettings
+from .issuestring import IssueString
+from .coverimagewidget import CoverImageWidget
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
+#from imagefetcher import ImageFetcher
+#import utils
 
-class IssueNumberTableWidgetItem(QtGui.QTableWidgetItem):
-	def __lt__(self, other):
-		selfStr = self.data(QtCore.Qt.DisplayRole).toString()
-		otherStr = other.data(QtCore.Qt.DisplayRole).toString()
-		return (IssueString(selfStr).asFloat() <
-		        IssueString(otherStr).asFloat())
 
-class IssueSelectionWindow(QtGui.QDialog):
-	
-	volume_id = 0
-	
-	def __init__(self, parent, settings, series_id, issue_number):
-		super(IssueSelectionWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('issueselectionwindow.ui' ), self)
+class IssueNumberTableWidgetItem(QtWidgets.QTableWidgetItem):
 
-		self.coverWidget = CoverImageWidget( self.coverImageContainer, CoverImageWidget.AltCoverMode )
-		gridlayout = QtGui.QGridLayout( self.coverImageContainer )
-		gridlayout.addWidget( self.coverWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
+    def __lt__(self, other):
+        selfStr = self.data(QtCore.Qt.DisplayRole)
+        otherStr = other.data(QtCore.Qt.DisplayRole)
+        return (IssueString(selfStr).asFloat() <
+                IssueString(otherStr).asFloat())
 
-		utils.reduceWidgetFontSize( self.twList )		
-		utils.reduceWidgetFontSize( self.teDescription, 1 )
 
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)		
+class IssueSelectionWindow(QtWidgets.QDialog):
 
-		self.series_id  = series_id
-		self.settings = settings
-		self.url_fetch_thread = None
-		
-		if issue_number is None or issue_number == "":
-			self.issue_number = 1
-		else:
-			self.issue_number = issue_number
+    volume_id = 0
 
-		self.initial_id = None
-		self.performQuery()
-		
-		self.twList.resizeColumnsToContents()	
-		self.twList.currentItemChanged.connect(self.currentItemChanged)	
-		self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
-		
-		#now that the list has been sorted, find the initial record, and select it
-		if self.initial_id is None:
-			self.twList.selectRow( 0 )
-		else:
-			for r in range(0, self.twList.rowCount()):
-				issue_id, b = self.twList.item( r, 0 ).data( QtCore.Qt.UserRole ).toInt()
-				if (issue_id == self.initial_id):
-					self.twList.selectRow( r )
-					break
-					
-	def performQuery( self ):
+    def __init__(self, parent, settings, series_id, issue_number):
+        super(IssueSelectionWindow, self).__init__(parent)
 
-		QtGui.QApplication.setOverrideCursor(QtGui.QCursor(QtCore.Qt.WaitCursor))
+        uic.loadUi(
+            ComicTaggerSettings.getUIFile('issueselectionwindow.ui'), self)
 
-		try:
-			comicVine = ComicVineTalker( )
-			volume_data = comicVine.fetchVolumeData( self.series_id )
-			self.issue_list = comicVine.fetchIssuesByVolume( self.series_id )
-		except ComicVineTalkerException:
-			QtGui.QApplication.restoreOverrideCursor()		
-			QtGui.QMessageBox.critical(self, self.tr("Network Issue"), self.tr("Could not connect to ComicVine to list issues!"))
-			return
+        self.coverWidget = CoverImageWidget(
+            self.coverImageContainer, CoverImageWidget.AltCoverMode)
+        gridlayout = QtWidgets.QGridLayout(self.coverImageContainer)
+        gridlayout.addWidget(self.coverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
 
-		while self.twList.rowCount() > 0:
-			self.twList.removeRow(0)
+        reduceWidgetFontSize(self.twList)
+        reduceWidgetFontSize(self.teDescription, 1)
 
-		self.twList.setSortingEnabled(False)
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
 
-		row = 0
-		for record in self.issue_list: 
-			self.twList.insertRow(row)
-			
-			item_text = record['issue_number']  
-			item = IssueNumberTableWidgetItem(item_text)			
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setData( QtCore.Qt.UserRole ,record['id'])
-			item.setData(QtCore.Qt.DisplayRole, item_text)
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 0, item)
-			
-			item_text = record['cover_date']
-			if item_text is None:
-				item_text = ""
-			#remove the day of "YYYY-MM-DD"
-			parts = item_text.split("-")
-			if len(parts) > 1:
-				item_text = parts[0] + "-" + parts[1]
-				
-			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)
+        self.series_id = series_id
+        self.settings = settings
+        self.url_fetch_thread = None
 
-			item_text = record['name']
-			if item_text is None:
-				item_text = ""				
-			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)
-			
-			if IssueString(record['issue_number']).asString().lower() == IssueString(self.issue_number).asString().lower():
-				self.initial_id = record['id']
-			
-			row += 1
-			
-		self.twList.setSortingEnabled(True)
-		self.twList.sortItems( 0 , QtCore.Qt.AscendingOrder )
+        if issue_number is None or issue_number == "":
+            self.issue_number = 1
+        else:
+            self.issue_number = issue_number
 
-		QtGui.QApplication.restoreOverrideCursor()		
+        self.initial_id = None
+        self.performQuery()
 
-	def cellDoubleClicked( self, r, c ):
-		self.accept()
-			
-	def currentItemChanged( self, curr, prev ):
+        self.twList.resizeColumnsToContents()
+        self.twList.currentItemChanged.connect(self.currentItemChanged)
+        self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
 
-		if curr is None:
-			return
-		if prev is not None and prev.row() == curr.row():
-				return
-		
-		self.issue_id, b = self.twList.item( curr.row(), 0 ).data( QtCore.Qt.UserRole ).toInt()
+        # now that the list has been sorted, find the initial record, and
+        # select it
+        if self.initial_id is None:
+            self.twList.selectRow(0)
+        else:
+            for r in range(0, self.twList.rowCount()):
+                issue_id = self.twList.item(r, 0).data(QtCore.Qt.UserRole)
+                if (issue_id == self.initial_id):
+                    self.twList.selectRow(r)
+                    break
 
-		# list selection was changed, update the the issue cover
-		for record in self.issue_list: 
-			if record['id'] == self.issue_id:				
-				self.issue_number = record['issue_number']
-				self.coverWidget.setIssueID( int(self.issue_id) )
-				if record['description'] is None:
-					self.teDescription.setText ( "" )
-				else:	
-					self.teDescription.setText ( record['description'] )
-				
-				break
-		
+    def performQuery(self):
+
+        QtWidgets.QApplication.setOverrideCursor(
+            QtGui.QCursor(QtCore.Qt.WaitCursor))
+
+        try:
+            comicVine = ComicVineTalker()
+            volume_data = comicVine.fetchVolumeData(self.series_id)
+            self.issue_list = comicVine.fetchIssuesByVolume(self.series_id)
+        except ComicVineTalkerException as e:
+            QtWidgets.QApplication.restoreOverrideCursor()
+            if e.code == ComicVineTalkerException.RateLimit:
+                QtWidgets.QMessageBox.critical(
+                    self,
+                    self.tr("Comic Vine Error"),
+                    ComicVineTalker.getRateLimitMessage())
+            else:
+                QtWidgets.QMessageBox.critical(
+                    self,
+                    self.tr("Network Issue"),
+                    self.tr("Could not connect to Comic Vine to list issues!"))
+            return
+
+        while self.twList.rowCount() > 0:
+            self.twList.removeRow(0)
+
+        self.twList.setSortingEnabled(False)
+
+        row = 0
+        for record in self.issue_list:
+            self.twList.insertRow(row)
+
+            item_text = record['issue_number']
+            item = IssueNumberTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.UserRole, record['id'])
+            item.setData(QtCore.Qt.DisplayRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 0, item)
+
+            item_text = record['cover_date']
+            if item_text is None:
+                item_text = ""
+            # remove the day of "YYYY-MM-DD"
+            parts = item_text.split("-")
+            if len(parts) > 1:
+                item_text = parts[0] + "-" + parts[1]
+
+            item = QtWidgets.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 = record['name']
+            if item_text is None:
+                item_text = ""
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 2, item)
+
+            if IssueString(
+                    record['issue_number']).asString().lower() == IssueString(
+                    self.issue_number).asString().lower():
+                self.initial_id = record['id']
+
+            row += 1
+
+        self.twList.setSortingEnabled(True)
+        self.twList.sortItems(0, QtCore.Qt.AscendingOrder)
+
+        QtWidgets.QApplication.restoreOverrideCursor()
+
+    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.issue_id = self.twList.item(curr.row(), 0).data(QtCore.Qt.UserRole)
+
+        # list selection was changed, update the the issue cover
+        for record in self.issue_list:
+            if record['id'] == self.issue_id:
+                self.issue_number = record['issue_number']
+                self.coverWidget.setIssueID(int(self.issue_id))
+                if record['description'] is None:
+                    self.teDescription.setText("")
+                else:
+                    self.teDescription.setText(record['description'])
+
+                break

comictaggerlib/issuestring.py

@@ -1,124 +1 @@
-"""
-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  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 utils
-import math
-import re
-
-class IssueString:
-	def __init__(self, text):
-	
-		#  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 = ""
-
-		if text is None:
-			return
-		
-		text = unicode(text)
-		
-		#skip the minus sign if it's first
-		if text[0] == '-':
-			start = 1
-		else:
-			start  = 0
-
-		# walk through the string, look for split point (the first non-numeric)
-		decimal_count = 0
-		for idx in range( start, len(text) ):
-			if text[idx] not in "0123456789.":
-				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
-		
-		part1 = text[0:idx]
-		part2 = text[idx:len(text)]
-		
-		if part1 != "":
-			self.num = float( part1 )
-		self.suffix = part2
-		
-		#print "num: {0} suf: {1}".format(self.num, self.suffix)
-
-	def asString( self, pad = 0 ):
-		#return the float, left side zero-padded, with suffix attached
-		if self.num is None:
-			return self.suffix
-		
-		negative = self.num < 0
-
-		num_f = abs(self.num)
-			
-		num_int = int( num_f )
-		num_s = str( num_int ) 
-		if float( num_int ) != num_f:
-			num_s = str( num_f )
-			
-		num_s += self.suffix
-		
-		# create padding
-		padding = ""
-		l = len( str(num_int))
-		if l < pad :
-			padding = "0" * (pad - l)
-		
-		num_s = padding + num_s
-		if negative:
-			num_s = "-" + num_s
-
-		return num_s
-	
-	def asFloat( self ):
-		#return the float, with no suffix
-		return self.num
-	
-	def asInt( self ):
-		#return the int version of the float
-		if self.num is None:
-			return None
-		return  int( self.num )
-	
-	
+from comicapi.issuestring import *

comictaggerlib/logwindow.py

@@ -1,40 +1,41 @@
-"""
-A PyQT4 dialog to a text file or log
-"""
+"""A PyQT4 dialog to a text file or log"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
+#import sys
+#import os
+
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+
+from .settings import ComicTaggerSettings
 
 
-class LogWindow(QtGui.QDialog):
-	
-	
-	def __init__(self, parent):
-		super(LogWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('logwindow.ui' ), self)
-		
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)
+class LogWindow(QtWidgets.QDialog):
 
-	def setText( self, text ):
-		self.textEdit.setPlainText( text ) 
+    def __init__(self, parent):
+        super(LogWindow, self).__init__(parent)
+
+        uic.loadUi(ComicTaggerSettings.getUIFile('logwindow.ui'), self)
+
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
+
+    def setText(self, text):
+        try:
+            text = text.decode()
+        except:
+            pass
+        self.textEdit.setPlainText(text)

comictaggerlib/main.py

@@ -1,79 +1,106 @@
-"""
-A python app to (automatically) tag comic archives
-"""
+"""A python app to (automatically) tag comic archives"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 sys
 import signal
-import os
 import traceback
 import platform
 
-import utils
-import cli
-from settings import ComicTaggerSettings
-from options import Options
+from .settings import ComicTaggerSettings
+# Need to load setting before anything else
+SETTINGS = ComicTaggerSettings()
 
 try:
-	qt_available = True
-	from PyQt4 import QtCore, QtGui
-	from taggerwindow import TaggerWindow
+    qt_available = True
+    from PyQt5 import QtCore, QtGui, QtWidgets
+    from .taggerwindow import TaggerWindow
 except ImportError as e:
-	qt_available = False
-#---------------------------------------
+    qt_available = False
+
+
+from . import utils
+from . import cli
+from .options import Options
+from .comicvinetalker import ComicVineTalker
 
 def ctmain():
-	utils.fix_output_encoding()
-	settings = ComicTaggerSettings()
+    opts = Options()
+    opts.parseCmdLineArgs()
 
-	opts = Options()
-	opts.parseCmdLineArgs()
+    # manage the CV API key
+    if opts.cv_api_key:
+        if opts.cv_api_key != SETTINGS.cv_api_key:
+            SETTINGS.cv_api_key = opts.cv_api_key
+            SETTINGS.save()
+    if opts.only_set_key:
+        print("Key set")
+        return
 
-	signal.signal(signal.SIGINT, signal.SIG_DFL)
-	
-	if not qt_available and not opts.no_gui:
-		opts.no_gui = True
-		print >> sys.stderr, "PyQt4 is not available.  ComicTagger is limited to command-line mode."
-	
-	if opts.no_gui:
-		cli.cli_mode( opts, settings )
-	else:
-		app = QtGui.QApplication(sys.argv)
-		
-		if platform.system() != "Linux":
-			img =  QtGui.QPixmap(ComicTaggerSettings.getGraphic('tags.png'))
-			
-			splash = QtGui.QSplashScreen(img)
-			splash.show()
-			splash.raise_()
-			app.processEvents()
-	
-		try:			
-			tagger_window = TaggerWindow( opts.file_list, settings )
-			tagger_window.show()
+    ComicVineTalker.api_key = SETTINGS.cv_api_key
 
-			if platform.system() != "Linux":
-				splash.finish( tagger_window )
+    signal.signal(signal.SIGINT, signal.SIG_DFL)
 
-			sys.exit(app.exec_())
-		except Exception, e:
-			QtGui.QMessageBox.critical(QtGui.QMainWindow(), "Error", "Unhandled exception in app:\n" + traceback.format_exc() )
+    if not qt_available and not opts.no_gui:
+        opts.no_gui = True
+        print("PyQt5 is not available.  ComicTagger is limited to command-line mode.", file=sys.stderr)
 
-    
-    
-    
+    if opts.no_gui:
+        cli.cli_mode(opts, SETTINGS)
+    else:
+        os.environ['QT_AUTO_SCREEN_SCALE_FACTOR'] = '1'            
+        app = QtWidgets.QApplication(sys.argv)
+        if platform.system() == "Darwin":
+            # Set the MacOS dock icon
+            app.setWindowIcon(
+            QtGui.QIcon(ComicTaggerSettings.getGraphic('app.png')))
+
+        if platform.system() == "Windows":
+            # For pure python, tell windows that we're not python,
+            # so we can have our own taskbar icon
+            import ctypes
+            myappid = u'comictagger' # arbitrary string
+            ctypes.windll.shell32.SetCurrentProcessExplicitAppUserModelID(myappid)
+            # force close of console window
+            SWP_HIDEWINDOW = 0x0080
+            consoleWnd = ctypes.windll.kernel32.GetConsoleWindow()
+            if consoleWnd != 0:          
+                ctypes.windll.user32.SetWindowPos(consoleWnd, None, 0, 0, 0, 0, SWP_HIDEWINDOW)
+
+        if platform.system() != "Linux":
+            img = QtGui.QPixmap(ComicTaggerSettings.getGraphic('tags.png'))
+
+            splash = QtWidgets.QSplashScreen(img)
+            splash.show()
+            splash.raise_()
+            app.processEvents()
+
+        try:
+            tagger_window = TaggerWindow(opts.file_list, SETTINGS, opts=opts)
+            tagger_window.setWindowIcon(
+                QtGui.QIcon(ComicTaggerSettings.getGraphic('app.png')))
+            tagger_window.show()
+
+            if platform.system() != "Linux":
+                splash.finish(tagger_window)
+
+            sys.exit(app.exec_())
+        except Exception as e:
+            QtWidgets.QMessageBox.critical(
+                QtWidgets.QMainWindow(),
+                "Error",
+                "Unhandled exception in app:\n" +
+                traceback.format_exc())

comictaggerlib/matchselectionwindow.py

@@ -1,160 +1,160 @@
-"""
-A PyQT4 dialog to select from automated issue matches
-"""
+"""A PyQT4 dialog to select from automated issue matches"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
+#import sys
 
-from PyQt4.QtCore import QUrl, pyqtSignal, QByteArray
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+#from PyQt5.QtCore import QUrl, pyqtSignal, QByteArray
 
-from imagefetcher import  ImageFetcher
-from settings import ComicTaggerSettings
-from comicarchive import MetaDataStyle
-from coverimagewidget import CoverImageWidget
-from comicvinetalker import ComicVineTalker
-import utils
+from .settings import ComicTaggerSettings
+from .coverimagewidget import CoverImageWidget
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
+#from imagefetcher import ImageFetcher
+#from comicarchive import MetaDataStyle
+#from comicvinetalker import ComicVineTalker
+#import utils
 
-class MatchSelectionWindow(QtGui.QDialog):
-	
-	volume_id = 0
-	
-	def __init__(self, parent, matches, comic_archive):
-		super(MatchSelectionWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('matchselectionwindow.ui' ), self)
 
-		self.altCoverWidget = CoverImageWidget( self.altCoverContainer, CoverImageWidget.AltCoverMode )
-		gridlayout = QtGui.QGridLayout( self.altCoverContainer )
-		gridlayout.addWidget( self.altCoverWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
+class MatchSelectionWindow(QtWidgets.QDialog):
 
-		self.archiveCoverWidget = CoverImageWidget( self.archiveCoverContainer, CoverImageWidget.ArchiveMode )
-		gridlayout = QtGui.QGridLayout( self.archiveCoverContainer )
-		gridlayout.addWidget( self.archiveCoverWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
+    volume_id = 0
 
-		utils.reduceWidgetFontSize( self.twList )		
-		utils.reduceWidgetFontSize( self.teDescription, 1 )
+    def __init__(self, parent, matches, comic_archive):
+        super(MatchSelectionWindow, self).__init__(parent)
 
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)		
+        uic.loadUi(
+            ComicTaggerSettings.getUIFile('matchselectionwindow.ui'), self)
 
-		self.matches = matches
-		self.comic_archive = comic_archive
-		
-		self.twList.currentItemChanged.connect(self.currentItemChanged)	
-		self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
+        self.altCoverWidget = CoverImageWidget(
+            self.altCoverContainer, CoverImageWidget.AltCoverMode)
+        gridlayout = QtWidgets.QGridLayout(self.altCoverContainer)
+        gridlayout.addWidget(self.altCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
 
-		self.updateData()		
+        self.archiveCoverWidget = CoverImageWidget(
+            self.archiveCoverContainer, CoverImageWidget.ArchiveMode)
+        gridlayout = QtWidgets.QGridLayout(self.archiveCoverContainer)
+        gridlayout.addWidget(self.archiveCoverWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
 
-	def updateData( self):
-			
-		self.setCoverImage()
-		self.populateTable()
-		self.twList.resizeColumnsToContents()	
-		self.twList.selectRow( 0 )
-		
-		path = self.comic_archive.path
-		self.setWindowTitle( u"Select correct match: {0}".format(
-						os.path.split(path)[1] ))
-		
-	def populateTable( self  ):
+        reduceWidgetFontSize(self.twList)
+        reduceWidgetFontSize(self.teDescription, 1)
 
-		while self.twList.rowCount() > 0:
-			self.twList.removeRow(0)
-		
-		self.twList.setSortingEnabled(False)
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
 
-		row = 0
-		for match in self.matches: 
-			self.twList.insertRow(row)
-			
-			item_text = match['series']  
-			item = QtGui.QTableWidgetItem(item_text)			
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setData( QtCore.Qt.UserRole, (match,))
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 0, item)
+        self.matches = matches
+        self.comic_archive = comic_archive
 
-			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)
-			
-			month_str = u""
-			year_str = u"????"
-			if match['month'] is not None:
-				month_str = u"-{0:02d}".format(int(match['month']))
-			if match['year'] is not None:
-				year_str = u"{0}".format(match['year'])
+        self.twList.currentItemChanged.connect(self.currentItemChanged)
+        self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
 
-			item_text = year_str + month_str			
-			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)
+        self.updateData()
 
-			item_text = match['issue_title']  
-			if item_text is None:
-				item_text = ""
-			item = QtGui.QTableWidgetItem(item_text)			
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 3, item)
-			
-			row += 1
+    def updateData(self):
 
-		self.twList.resizeColumnsToContents()
-		self.twList.setSortingEnabled(True)
-		self.twList.sortItems( 2 , QtCore.Qt.AscendingOrder )
-		self.twList.selectRow(0)
-		self.twList.resizeColumnsToContents()
-		self.twList.horizontalHeader().setStretchLastSection(True) 
-			
+        self.setCoverImage()
+        self.populateTable()
+        self.twList.resizeColumnsToContents()
+        self.twList.selectRow(0)
 
-	def cellDoubleClicked( self, r, c ):
-		self.accept()
-			
-	def currentItemChanged( self, curr, prev ):
+        path = self.comic_archive.path
+        self.setWindowTitle("Select correct match: {0}".format(
+            os.path.split(path)[1]))
 
-		if curr is None:
-			return
-		if prev is not None and prev.row() == curr.row():
-				return
-		
-		self.altCoverWidget.setIssueID( self.currentMatch()['issue_id'] )
-		if self.currentMatch()['description'] is None:
-			self.teDescription.setText ( "" )
-		else:	
-			self.teDescription.setText ( self.currentMatch()['description'] )
-			
-	def setCoverImage( self ):
-		self.archiveCoverWidget.setArchive( self.comic_archive)
+    def populateTable(self):
 
-	def currentMatch( self ):
-		row = self.twList.currentRow()
-		match = self.twList.item(row, 0).data( QtCore.Qt.UserRole ).toPyObject()[0]
-		return match
+        while self.twList.rowCount() > 0:
+            self.twList.removeRow(0)
 
+        self.twList.setSortingEnabled(False)
+
+        row = 0
+        for match in self.matches:
+            self.twList.insertRow(row)
+
+            item_text = match['series']
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.UserRole, (match,))
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 0, item)
+
+            if match['publisher'] is not None:
+                item_text = "{0}".format(match['publisher'])
+            else:
+                item_text = "Unknown"
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 1, item)
+
+            month_str = ""
+            year_str = "????"
+            if match['month'] is not None:
+                month_str = "-{0:02d}".format(int(match['month']))
+            if match['year'] is not None:
+                year_str = "{0}".format(match['year'])
+
+            item_text = year_str + month_str
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.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.ToolTipRole, item_text)
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 3, item)
+
+            row += 1
+
+        self.twList.resizeColumnsToContents()
+        self.twList.setSortingEnabled(True)
+        self.twList.sortItems(2, QtCore.Qt.AscendingOrder)
+        self.twList.selectRow(0)
+        self.twList.resizeColumnsToContents()
+        self.twList.horizontalHeader().setStretchLastSection(True)
+
+    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.altCoverWidget.setIssueID(self.currentMatch()['issue_id'])
+        if self.currentMatch()['description'] is None:
+            self.teDescription.setText("")
+        else:
+            self.teDescription.setText(self.currentMatch()['description'])
+
+    def setCoverImage(self):
+        self.archiveCoverWidget.setArchive(self.comic_archive)
+
+    def currentMatch(self):
+        row = self.twList.currentRow()
+        match = self.twList.item(row, 0).data(
+            QtCore.Qt.UserRole)[0]
+        return match

comictaggerlib/optionalmsgdialog.py

@@ -1,106 +1,118 @@
-"""
-A PyQt4 dialog to show a message and let the user check a box
+"""A PyQt5 dialog to show a message and let the user check a box
+
+Example usage:
+
+checked = OptionalMessageDialog.msg(self, "Disclaimer",
+                            "This is beta software, and you are using it at your own risk!",
+                         )
+
+said_yes, checked = OptionalMessageDialog.question(self, "Question",
+                            "Are you sure you wish to do this?",
+                         )
 """
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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.
 
-"""
-example usage:
-
-checked = OptionalMessageDialog.msg(  self, "Disclaimer", 
-							"This is beta software, and you are using it at your own risk!",
-							)
-
-said_yes, checked =  OptionalMessageDialog.question( self,  "Question", 
-							"Are you sure you wish to do this?",
-							)
-"""
+from PyQt5.QtCore import *
+from PyQt5.QtGui import *
+from PyQt5.QtWidgets import *
 
 
-from PyQt4.QtCore import *
-from PyQt4.QtGui import *
- 
 StyleMessage = 0
 StyleQuestion = 1
 
+
 class OptionalMessageDialog(QDialog):
-	
-	def __init__(self, parent, style, title, msg, check_state=Qt.Unchecked, check_text=None ):	
-		QDialog.__init__(self, parent)
 
-		self.setWindowTitle( title )
-		self.was_accepted = False
-		
-		l = QVBoxLayout( self )
-		
-		self.theLabel = QLabel( msg )
-		self.theLabel.setWordWrap(True)
-		self.theLabel.setTextFormat( Qt.RichText )
-		self.theLabel.setOpenExternalLinks(True)
-		self.theLabel.setTextInteractionFlags( Qt.TextSelectableByMouse | Qt.LinksAccessibleByMouse | Qt.LinksAccessibleByKeyboard )
-		
-		l.addWidget( self.theLabel ) 
-		l.insertSpacing ( -1, 10 )
-		
-		if check_text is None:
-			if style == StyleQuestion:
-				check_text = "Remember this answer"
-			else:
-				check_text = "Don't show this dialog again"
-				
-		self.theCheckBox = QCheckBox(check_text)
-		
-		self.theCheckBox.setCheckState( check_state )
-			
-		l.addWidget( self.theCheckBox )
+    def __init__(self, parent, style, title, msg,
+                 check_state=Qt.Unchecked, check_text=None):
+        QDialog.__init__(self, parent)
 
-		btnbox_style = QDialogButtonBox.Ok
-		if style == StyleQuestion:
-			btnbox_style = QDialogButtonBox.Yes|QDialogButtonBox.No
-			
-		self.theButtonBox = QDialogButtonBox(
-						btnbox_style,
-						parent=self,
-						accepted=self.accept,
-						rejected=self.reject) 
-						
-		l.addWidget( self.theButtonBox )
-		
- 	def accept( self ):
-		self.was_accepted = True
-		QDialog.accept(self)
+        self.setWindowTitle(title)
+        self.was_accepted = False
 
-	def reject( self ):
-		self.was_accepted = False
-		QDialog.reject(self)
+        l = QVBoxLayout(self)
 
-	@staticmethod
-	def msg( parent, title, msg, check_state=Qt.Unchecked, check_text=None):
-		
-		d = OptionalMessageDialog( parent, StyleMessage, title, msg, check_state=check_state, check_text=check_text )
+        self.theLabel = QLabel(msg)
+        self.theLabel.setWordWrap(True)
+        self.theLabel.setTextFormat(Qt.RichText)
+        self.theLabel.setOpenExternalLinks(True)
+        self.theLabel.setTextInteractionFlags(
+            Qt.TextSelectableByMouse | Qt.LinksAccessibleByMouse | Qt.LinksAccessibleByKeyboard)
 
-		d.exec_()
-		return  d.theCheckBox.isChecked()
+        l.addWidget(self.theLabel)
+        l.insertSpacing(-1, 10)
 
-	@staticmethod
-	def question( parent, title, msg, check_state=Qt.Unchecked, check_text=None ):
-		
-		d = OptionalMessageDialog( parent, StyleQuestion, title, msg, check_state=check_state, check_text=check_text )
-		
-		d.exec_() 
-		
-		return d.was_accepted, d.theCheckBox.isChecked()
+        if check_text is None:
+            if style == StyleQuestion:
+                check_text = "Remember this answer"
+            else:
+                check_text = "Don't show this message again"
+
+        self.theCheckBox = QCheckBox(check_text)
+
+        self.theCheckBox.setCheckState(check_state)
+
+        l.addWidget(self.theCheckBox)
+
+        btnbox_style = QDialogButtonBox.Ok
+        if style == StyleQuestion:
+            btnbox_style = QDialogButtonBox.Yes | QDialogButtonBox.No
+
+        self.theButtonBox = QDialogButtonBox(
+            btnbox_style,
+            parent=self,
+            accepted=self.accept,
+            rejected=self.reject)
+
+        l.addWidget(self.theButtonBox)
+
+    def accept(self):
+        self.was_accepted = True
+        QDialog.accept(self)
+
+    def reject(self):
+        self.was_accepted = False
+        QDialog.reject(self)
+
+    @staticmethod
+    def msg(parent, title, msg, check_state=Qt.Unchecked, check_text=None):
+
+        d = OptionalMessageDialog(
+            parent,
+            StyleMessage,
+            title,
+            msg,
+            check_state=check_state,
+            check_text=check_text)
+
+        d.exec_()
+        return d.theCheckBox.isChecked()
+
+    @staticmethod
+    def question(
+            parent, title, msg, check_state=Qt.Unchecked, check_text=None):
+
+        d = OptionalMessageDialog(
+            parent,
+            StyleQuestion,
+            title,
+            msg,
+            check_state=check_state,
+            check_text=check_text)
+
+        d.exec_()
+
+        return d.was_accepted, d.theCheckBox.isChecked()

comictaggerlib/options.py

@@ -1,372 +1,425 @@
-"""
-CLI options class for comictagger app
-"""
+"""CLI options class for ComicTagger app"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 getopt
 import platform
 import os
 import traceback
-import ctversion
-import utils
-try:
-	import argparse
-except:
-	pass
 
-from genericmetadata import GenericMetadata
-from comicarchive import MetaDataStyle
-from versionchecker import VersionChecker
+try:
+    import argparse
+except ImportError:
+    pass
+
+from datetime import datetime
+from .genericmetadata import GenericMetadata
+from .comicarchive import MetaDataStyle
+from .versionchecker import VersionChecker
+from . import ctversion
+from . import utils
+
 
 class Options:
-	help_text = """	
-Usage: {0} [OPTION]... [FILE LIST]
+    help_text = """Usage: {0} [option] ... [file [files ...]]
 
 A utility for reading and writing metadata to comic archives.
 
-If no options are given, {0} will run in windowed mode
+If no options are given, {0} will run in windowed mode.
 
-  -p, --print                Print out tag info from file.  Specify type
-                             (via -t) to get only info of that tag type
-      --raw                  With -p, will print out the raw tag block(s)
-                             from the file
-  -d, --delete               Deletes the tag block of specified type (via -t)
-  -c, --copy=SOURCE          Copy the specified source tag block to destination style
-                             specified via via -t (potentially lossy operation)
-  -s, --save                 Save out tags as specified type (via -t)
-                             Must specify also at least -o, -p, or -m
-      --nooverwrite          Don't modify tag block if it already exists ( relevent for -s or -c )  
-  -1, --assume-issue-one     Assume issue number is 1 if not found ( relevent for -s )  
-  -n, --dryrun               Don't actually modify file (only relevent for -d, -s, or -r)
-  -t, --type=TYPE            Specify TYPE as either "CR", "CBL", or "COMET" (as either 
-                             ComicRack, ComicBookLover, or CoMet style tags, respectivly)
-  -f, --parsefilename        Parse the filename to get some info, specifically
-                             series name, issue number, volume, and publication 
-                             year
-  -i, --interactive          Interactively query the user when there are multiple matches for
-                             an online search
-      --nosummary            Suppress the default summary after a save operation
-  -o, --online               Search online and attempt to identify file using 
-                             existing metadata and images in archive. May be used
-                             in conjuntion with -f and -m
-      --id=ID                Use the issue ID when searching online.  Overrides all other metadata
-  -m, --metadata=LIST        Explicity define, as a list, some tags to be used                           
-                                e.g. "series=Plastic Man , publisher=Quality Comics"
-                                     "series=Kickers^, Inc., issue=1, year=1986"
-                             Name-Value pairs are comma separated.  Use a "^" to 
-                             escape an "=" or a ",", as shown in the example above
-                             Some names that can be used:
-                                 series, issue, issueCount, year, publisher, title
-  -r, --rename               Rename the file based on specified tag style.
-      --noabort              Don't abort save operation when online match is of low confidence
-  -e, --export-to-zip        Export RAR archive to Zip format
-      --delete-rar           Delete original RAR archive after successful export to Zip
-      --abort-on-conflict    Don't export to zip if intended new filename exists (Otherwise, creates
-                             a new unique filename)
-  -S, --script=FILE          Run an "add-on" python script that uses the comictagger library for custom
-                             processing.  Script arguments can follow the script name  
-  -R, --recursive            Recursively include files in sub-folders                            
-  -v, --verbose              Be noisy when doing what it does                            
-      --terse                Don't say much (for print mode)                            
-      --version              Display version                            
-  -h, --help                 Display this message
-  
-For more help visit the wiki at: http://code.google.com/p/comictagger/
-	"""
+-p, --print                 Print out tag info from file. Specify type
+                            (via -t) to get only info of that tag type.
+    --raw                   With -p, will print out the raw tag block(s)
+                            from the file.
+-d, --delete                Deletes the tag block of specified type (via
+                            -t).
+-c, --copy=SOURCE           Copy the specified source tag block to
+                            destination style specified via -t
+                            (potentially lossy operation).
+-s, --save                  Save out tags as specified type (via -t).
+                            Must specify also at least -o, -p, or -m.
+    --nooverwrite           Don't modify tag block if it already exists
+                            (relevant for -s or -c).
+-1, --assume-issue-one      Assume issue number is 1 if not found
+                            (relevant for -s).
+-n, --dryrun                Don't actually modify file (only relevant for
+                            -d, -s, or -r).
+-t, --type=TYPE             Specify TYPE as either "CR", "CBL", or
+                            "COMET" (as either ComicRack, ComicBookLover,
+                            or CoMet style tags, respectively).
+-f, --parsefilename         Parse the filename to get some info,
+                            specifically series name, issue number,
+                            volume, and publication year.
+-i, --interactive           Interactively query the user when there are
+                            multiple matches for an online search.
+    --nosummary             Suppress the default summary after a save
+                            operation.
+-o, --online                Search online and attempt to identify file
+                            using existing metadata and images in archive.
+                            May be used in conjunction with -f and -m.
+    --id=ID                 Use the issue ID when searching online.
+                            Overrides all other metadata.
+-m, --metadata=LIST         Explicitly define, as a list, some tags to be
+                            used.  e.g.:
+                            "series=Plastic Man, publisher=Quality Comics"
+                            "series=Kickers^, Inc., issue=1, year=1986"
+                            Name-Value pairs are comma separated. Use a
+                            "^" to escape an "=" or a ",", as shown in
+                            the example above.  Some names that can be
+                            used: series, issue, issueCount, year,
+                            publisher, title
+-r, --rename                Rename the file based on specified tag style.
+    --noabort               Don't abort save operation when online match
+                            is of low confidence.
+-e, --export-to-zip         Export RAR archive to Zip format.
+    --delete-rar            Delete original RAR archive after successful
+                            export to Zip.
+    --abort-on-conflict     Don't export to zip if intended new filename
+                            exists (otherwise, creates a new unique
+                            filename).
+-S, --script=FILE           Run an "add-on" python script that uses the
+                            ComicTagger library for custom processing.
+                            Script arguments can follow the script name.
+-R, --recursive             Recursively include files in sub-folders.
+    --cv-api-key=KEY        Use the given Comic Vine API Key (persisted
+                            in settings).
+    --only-set-cv-key       Only set the Comic Vine API key and quit.
+-w, --wait-on-cv-rate-limit When encountering a Comic Vine rate limit
+                            error, wait and retry query.
+-v, --verbose               Be noisy when doing what it does.
+    --terse                 Don't say much (for print mode).
+    --version               Display version.
+-h, --help                  Display this message.
 
+For more help visit the wiki at: https://github.com/comictagger/comictagger/wiki
+    """
 
-	def __init__(self):
-		self.data_style = None
-		self.no_gui = False
-		self.filename = None  
-		self.verbose = False
-		self.terse = False
-		self.metadata = None
-		self.print_tags = False
-		self.copy_tags = False
-		self.delete_tags = False
-		self.export_to_zip = False
-		self.abort_export_on_conflict = False
-		self.delete_rar_after_export = False
-		self.search_online = False
-		self.dryrun = False
-		self.abortOnLowConfidence = True
-		self.save_tags = False
-		self.parse_filename = False
-		self.show_save_summary = True
-		self.raw = False
-		self.rename_file = False
-		self.no_overwrite = False
-		self.interactive = False
-		self.issue_id = None
-		self.recursive = False
-		self.run_script = False
-		self.script = None
-		self.assume_issue_is_one_if_not_set = False
-		self.file_list = []
-		
-	def display_msg_and_quit( self, msg, code, show_help=False ):
-		appname = os.path.basename(sys.argv[0])
-		if msg is not None:
-			print( msg )
-		if show_help:
-			print self.help_text.format(appname)
-		else:
-			print "For more help, run with '--help'"
-		sys.exit(code)
-	
-	def parseMetadataFromString( self, mdstr ):
-		# The metadata string is a comma separated list of name-value pairs
-		# The names match the attributes of the internal metadata struct (for now)
-		# The caret is the special "escape character", since it's not common in 
-		# natural language text
+    def __init__(self):
+        self.data_style = None
+        self.no_gui = False
+        self.filename = None
+        self.verbose = False
+        self.terse = False
+        self.metadata = None
+        self.print_tags = False
+        self.copy_tags = False
+        self.delete_tags = False
+        self.export_to_zip = False
+        self.abort_export_on_conflict = False
+        self.delete_rar_after_export = False
+        self.search_online = False
+        self.dryrun = False
+        self.abortOnLowConfidence = True
+        self.save_tags = False
+        self.parse_filename = False
+        self.show_save_summary = True
+        self.raw = False
+        self.cv_api_key = None
+        self.only_set_key = False
+        self.rename_file = False
+        self.no_overwrite = False
+        self.interactive = False
+        self.issue_id = None
+        self.recursive = False
+        self.run_script = False
+        self.script = None
+        self.wait_and_retry_on_rate_limit = False
+        self.assume_issue_is_one_if_not_set = False
+        self.file_list = []
 
-		# example = "series=Kickers^, Inc. ,issue=1, year=1986"
-		
-		escaped_comma = "^,"
-		escaped_equals = "^="		
-		replacement_token = "<_~_>"
-		
-		md = GenericMetadata()
+    def display_msg_and_quit(self, msg, code, show_help=False):
+        appname = os.path.basename(sys.argv[0])
+        if msg is not None:
+            print(msg)
+        if show_help:
+            print((self.help_text.format(appname)))
+        else:
+            print("For more help, run with '--help'")
+        sys.exit(code)
 
-		# First, replace escaped commas with with a unique token (to be changed back later)
-		mdstr = mdstr.replace( escaped_comma, replacement_token)
-		tmp_list = mdstr.split(",")
-		md_list = []
-		for item in tmp_list:
-			item = item.replace( replacement_token, "," )
-			md_list.append(item)
-			
-		# Now build a nice dict from the list
-		md_dict = dict()
-		for item in md_list:
-			# Make sure to fix any escaped equal signs
-			i = item.replace( escaped_equals, replacement_token)
-			key,value = i.split("=")
-			value = value.replace( replacement_token, "=" ).strip()
-			key = key.strip()
-			if key.lower() == "credit":
-				cred_attribs = value.split(":")
-				role = cred_attribs[0]
-				person = ( cred_attribs[1] if len( cred_attribs ) > 1 else  "" )
-				primary = (cred_attribs[2] if len( cred_attribs ) > 2 else None )
-				md.addCredit( person.strip(), role.strip(), True if primary is not None else False )
-			else:			
-				md_dict[key] = value
-		
-		# Map the dict to the metadata object
-		for key in md_dict:
-			if not hasattr(md, key):
-				print "Warning: '{0}' is not a valid tag name".format(key)
-			else:
-				md.isEmpty = False
-				setattr( md, key, md_dict[key] )
-		#print md
-		return md
-		
-	def launch_script(self, scriptfile):
-		# we were given a script.  special case for the args:
-		#  1. ignore everthing before the -S,
-		#  2. pass all the ones that follow (including script name) to the script 
-		script_args = list()
-		for idx, arg in enumerate(sys.argv):
-			if arg in [ '-S', '--script']:
-				#found script!
-				script_args = sys.argv[idx+1:]
-				break
-		sys.argv = script_args
-		if not os.path.exists(scriptfile):
-			print "Can't find {0}".format( scriptfile )
-		else:
-			# I *think* this makes sense:
-			#  assume the base name of the file is the module name
-			#  add the folder of the given file to the python path
-			#  import module
-			dirname = os.path.dirname(scriptfile)
-			module_name = os.path.splitext(os.path.basename(scriptfile))[0]
-			sys.path = [dirname] + sys.path
-			try:
-				script =  __import__(module_name)
-			
-				# Determine if the entry point exists before trying to run it
-				if "main" in dir(script):
-					script.main()
-				else:
-					print "Can't find entry point \"main()\" in module \"{0}\"".format( module_name )
-			except Exception as e:
-				print "Script raised an unhandled exception: ", e	
-				print traceback.format_exc()
-	
-		sys.exit(0)		
+    def parseMetadataFromString(self, mdstr):
+        """The metadata string is a comma separated list of name-value pairs
+        The names match the attributes of the internal metadata struct (for now)
+        The caret is the special "escape character", since it's not common in
+        natural language text
 
-	def parseCmdLineArgs(self):
-		
-		if platform.system() == "Darwin" and hasattr(sys, "frozen") and sys.frozen == 1:
-			# remove the PSN ("process serial number") argument from OS/X
-			input_args = [a for a in sys.argv[1:] if "-psn_0_" not in  a ]
-		else:
-			input_args = sys.argv[1:]
-			
-		# first check if we're launching a script:	
-		for n in range(len(input_args)):
-			if (  input_args[n] in [ "-S", "--script" ] and
-                  n+1 < len(input_args)):
-				# insert a "--" which will cause getopt to ignore the remaining args
-				# so they will be passed to the script
-				input_args.insert(n+2, "--")
-				break
-	
-		# parse command line options
-		try:
-			opts, args = getopt.getopt( input_args, 
-			           "hpdt:fm:vonsrc:ieRS:1", 
-			           [ "help", "print", "delete", "type=", "copy=", "parsefilename", "metadata=", "verbose",
-			            "online", "dryrun", "save", "rename" , "raw", "noabort", "terse", "nooverwrite",
-			            "interactive", "nosummary", "version", "id=" , "recursive", "script=",
-			            "export-to-zip", "delete-rar", "abort-on-conflict", "assume-issue-one" ] )
+        example = "series=Kickers^, Inc. ,issue=1, year=1986"
+        """
 
-		except getopt.GetoptError as err:
-			self.display_msg_and_quit( str(err), 2 )
-		
-		# process options
-		for o, a in opts:
-			if o in ("-h", "--help"):
-				self.display_msg_and_quit( None, 0, show_help=True )
-			if o in ("-v", "--verbose"):
-				self.verbose = True
-			if o in ("-S", "--script"):
-				self.run_script = True
-				self.script = a
-			if o in ("-R", "--recursive"):
-				self.recursive = True
-			if o in ("-p", "--print"):
-				self.print_tags = True
-			if o in ("-d", "--delete"):
-				self.delete_tags = True
-			if o in ("-i", "--interactive"):
-				self.interactive = True
-			if o in ("-c", "--copy"):
-				self.copy_tags = True
-				if a.lower() == "cr":
-					self.copy_source = MetaDataStyle.CIX
-				elif a.lower() == "cbl":
-					self.copy_source = MetaDataStyle.CBI
-				elif a.lower() == "comet":
-					self.copy_source = MetaDataStyle.COMET
-				else:
-					self.display_msg_and_quit( "Invalid copy tag source type", 1 )
-			if o in ("-o", "--online"):
-				self.search_online = True
-			if o in ("-n", "--dryrun"):
-				self.dryrun = True
-			if o in ("-m", "--metadata"):
-				self.metadata = self.parseMetadataFromString(a)
-			if o in ("-s", "--save"):
-				self.save_tags = True
-			if o in ("-r", "--rename"):
-				self.rename_file = True
-			if o in ("-e", "--export_to_zip"):
-				self.export_to_zip = True
-			if o  == "--delete-rar":
-				self.delete_rar_after_export = True
-			if o  == "--abort-on-conflict":
-				self.abort_export_on_conflict = True				
-			if o in ("-f", "--parsefilename"):
-				self.parse_filename = True
-			if o == "--id":
-				self.issue_id = a
-			if o == "--raw":
-				self.raw = True
-			if o  == "--noabort":
-				self.abortOnLowConfidence = False
-			if o == "--terse":
-				self.terse = True
-			if o == "--nosummary":
-				self.show_save_summary = False
-			if o in ("-1", "--assume-issue-one"):
-				self.assume_issue_is_one_if_not_set = True
-			if o  == "--nooverwrite":
-				self.no_overwrite = True
-			if o  == "--version":
-				print "ComicTagger {0}:  Copyright (c) 2012-2013 Anthony Beville".format(ctversion.version)
-				print "Distributed under Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)"
-				new_version = VersionChecker().getLatestVersion("", False)
-				if new_version is not None and new_version != ctversion.version:
-					print "----------------------------------------"
-					print "New version available online: {0}".format(new_version)
-					print "----------------------------------------"
-				sys.exit(0)
-			if o in ("-t", "--type"):
-				if a.lower() == "cr":
-					self.data_style = MetaDataStyle.CIX
-				elif a.lower() == "cbl":
-					self.data_style = MetaDataStyle.CBI
-				elif a.lower() == "comet":
-					self.data_style = MetaDataStyle.COMET
-				else:
-					self.display_msg_and_quit( "Invalid tag type", 1 )
-						
-		if self.print_tags or self.delete_tags or self.save_tags or self.copy_tags or self.rename_file or self.export_to_zip:
-			self.no_gui = True
+        escaped_comma = "^,"
+        escaped_equals = "^="
+        replacement_token = "<_~_>"
 
-		count = 0
-		if self.run_script: count += 1
-		if self.print_tags: count += 1
-		if self.delete_tags: count += 1
-		if self.save_tags: count += 1
-		if self.copy_tags: count += 1
-		if self.rename_file: count += 1
-		if self.export_to_zip: count +=1
-		
-		if count > 1:
-			self.display_msg_and_quit( "Must choose only one action of print, delete, save, copy, rename, export, or run script", 1 )
+        md = GenericMetadata()
 
-		if self.script is not None:
-			self.launch_script( self.script )
+        # First, replace escaped commas with with a unique token (to be changed
+        # back later)
+        mdstr = mdstr.replace(escaped_comma, replacement_token)
+        tmp_list = mdstr.split(",")
+        md_list = []
+        for item in tmp_list:
+            item = item.replace(replacement_token, ",")
+            md_list.append(item)
 
-		if len(args) > 0:
-			if platform.system() == "Windows":
-				# no globbing on windows shell, so do it for them
-				import glob
-				self.file_list = []
-				for item in args:
-					self.file_list.extend(glob.glob(item))
-				if len(self.file_list) > 0:
-					self.filename = self.file_list[0]
-			else:
-				self.filename = args[0]
-				self.file_list = args
+        # Now build a nice dict from the list
+        md_dict = dict()
+        for item in md_list:
+            # Make sure to fix any escaped equal signs
+            i = item.replace(escaped_equals, replacement_token)
+            key, value = i.split("=")
+            value = value.replace(replacement_token, "=").strip()
+            key = key.strip()
+            if key.lower() == "credit":
+                cred_attribs = value.split(":")
+                role = cred_attribs[0]
+                person = (cred_attribs[1] if len(cred_attribs) > 1 else "")
+                primary = (cred_attribs[2] if len(cred_attribs) > 2 else None)
+                md.addCredit(
+                    person.strip(),
+                    role.strip(),
+                    True if primary is not None else False)
+            else:
+                md_dict[key] = value
 
-		if self.no_gui and self.filename is None:
-			self.display_msg_and_quit( "Command requires at least one filename!", 1 )
-			
-		if self.delete_tags and self.data_style is None:
-			self.display_msg_and_quit( "Please specify the type to delete with -t", 1 )
-			
-		if self.save_tags and self.data_style is None:
-			self.display_msg_and_quit( "Please specify the type to save with -t", 1 )
+        # Map the dict to the metadata object
+        for key in md_dict:
+            if not hasattr(md, key):
+                print(("Warning: '{0}' is not a valid tag name".format(key)))
+            else:
+                md.isEmpty = False
+                setattr(md, key, md_dict[key])
+        # print(md)
+        return md
 
-		if self.copy_tags and self.data_style is None:
-			self.display_msg_and_quit( "Please specify the type to copy to with -t", 1 )
-			
-		#if self.rename_file and self.data_style is None:
-		#	self.display_msg_and_quit( "Please specify the type to use for renaming with -t", 1 )
-		
-		if self.recursive:
-			self.file_list = utils.get_recursive_filelist( self.file_list )
+    def launch_script(self, scriptfile):
+        # we were given a script.  special case for the args:
+        # 1. ignore everything before the -S,
+        # 2. pass all the ones that follow (including script name) to the
+        # script
+        script_args = list()
+        for idx, arg in enumerate(sys.argv):
+            if arg in ['-S', '--script']:
+                # found script!
+                script_args = sys.argv[idx + 1:]
+                break
+        sys.argv = script_args
+        if not os.path.exists(scriptfile):
+            print(("Can't find {0}".format(scriptfile)))
+        else:
+            # I *think* this makes sense:
+            #  assume the base name of the file is the module name
+            #  add the folder of the given file to the python path
+            #  import module
+            dirname = os.path.dirname(scriptfile)
+            module_name = os.path.splitext(os.path.basename(scriptfile))[0]
+            sys.path = [dirname] + sys.path
+            try:
+                script = __import__(module_name)
+
+                # Determine if the entry point exists before trying to run it
+                if "main" in dir(script):
+                    script.main()
+                else:
+                    print((
+                        "Can't find entry point \"main()\" in module \"{0}\"".format(module_name)))
+            except Exception as e:
+                print("Script raised an unhandled exception: ", e)
+                print((traceback.format_exc()))
+
+        sys.exit(0)
+
+    def parseCmdLineArgs(self):
+
+        if platform.system() == "Darwin" and hasattr(
+                sys, "frozen") and sys.frozen == 1:
+            # remove the PSN ("process serial number") argument from OS/X
+            input_args = [a for a in sys.argv[1:] if "-psn_0_" not in a]
+        else:
+            input_args = sys.argv[1:]
+
+        # first check if we're launching a script:
+        for n in range(len(input_args)):
+            if (input_args[n] in ["-S", "--script"] and
+                    n + 1 < len(input_args)):
+                # insert a "--" which will cause getopt to ignore the remaining args
+                # so they will be passed to the script
+                input_args.insert(n + 2, "--")
+                break
+
+        # parse command line options
+        try:
+            opts, args = getopt.getopt(input_args,
+                                       "hpdt:fm:vownsrc:ieRS:1",
+                                       ["help", "print", "delete", "type=", "copy=", "parsefilename",
+                                        "metadata=", "verbose", "online", "dryrun", "save", "rename",
+                                        "raw", "noabort", "terse", "nooverwrite", "interactive",
+                                        "nosummary", "version", "id=", "recursive", "script=",
+                                        "export-to-zip", "delete-rar", "abort-on-conflict",
+                                        "assume-issue-one", "cv-api-key=", "only-set-cv-key",
+                                        "wait-on-cv-rate-limit"])
+
+        except getopt.GetoptError as err:
+            self.display_msg_and_quit(str(err), 2)
+
+        # process options
+        for o, a in opts:
+            if o in ("-h", "--help"):
+                self.display_msg_and_quit(None, 0, show_help=True)
+            if o in ("-v", "--verbose"):
+                self.verbose = True
+            if o in ("-S", "--script"):
+                self.run_script = True
+                self.script = a
+            if o in ("-R", "--recursive"):
+                self.recursive = True
+            if o in ("-p", "--print"):
+                self.print_tags = True
+            if o in ("-d", "--delete"):
+                self.delete_tags = True
+            if o in ("-i", "--interactive"):
+                self.interactive = True
+            if o in ("-c", "--copy"):
+                self.copy_tags = True
+                if a.lower() == "cr":
+                    self.copy_source = MetaDataStyle.CIX
+                elif a.lower() == "cbl":
+                    self.copy_source = MetaDataStyle.CBI
+                elif a.lower() == "comet":
+                    self.copy_source = MetaDataStyle.COMET
+                else:
+                    self.display_msg_and_quit(
+                        "Invalid copy tag source type", 1)
+            if o in ("-o", "--online"):
+                self.search_online = True
+            if o in ("-n", "--dryrun"):
+                self.dryrun = True
+            if o in ("-m", "--metadata"):
+                self.metadata = self.parseMetadataFromString(a)
+            if o in ("-s", "--save"):
+                self.save_tags = True
+            if o in ("-r", "--rename"):
+                self.rename_file = True
+            if o in ("-e", "--export_to_zip"):
+                self.export_to_zip = True
+            if o == "--delete-rar":
+                self.delete_rar_after_export = True
+            if o == "--abort-on-conflict":
+                self.abort_export_on_conflict = True
+            if o in ("-f", "--parsefilename"):
+                self.parse_filename = True
+            if o in ("-w", "--wait-on-cv-rate-limit"):
+                self.wait_and_retry_on_rate_limit = True
+            if o == "--id":
+                self.issue_id = a
+            if o == "--raw":
+                self.raw = True
+            if o == "--noabort":
+                self.abortOnLowConfidence = False
+            if o == "--terse":
+                self.terse = True
+            if o == "--nosummary":
+                self.show_save_summary = False
+            if o in ("-1", "--assume-issue-one"):
+                self.assume_issue_is_one_if_not_set = True
+            if o == "--nooverwrite":
+                self.no_overwrite = True
+            if o == "--cv-api-key":
+                self.cv_api_key = a
+            if o == "--only-set-cv-key":
+                self.only_set_key = True
+            if o == "--version":
+                print((
+                    "ComicTagger {}:  Copyright (c) 2012-{:%Y} ComicTagger Team".format(ctversion.version, datetime.today())))
+                print(
+                    "Distributed under Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0)")
+                sys.exit(0)
+            if o in ("-t", "--type"):
+                if a.lower() == "cr":
+                    self.data_style = MetaDataStyle.CIX
+                elif a.lower() == "cbl":
+                    self.data_style = MetaDataStyle.CBI
+                elif a.lower() == "comet":
+                    self.data_style = MetaDataStyle.COMET
+                else:
+                    self.display_msg_and_quit("Invalid tag type", 1)
+
+        if self.print_tags or self.delete_tags or self.save_tags or self.copy_tags or self.rename_file or self.export_to_zip or self.only_set_key:
+            self.no_gui = True
+
+        count = 0
+        if self.run_script:
+            count += 1
+        if self.print_tags:
+            count += 1
+        if self.delete_tags:
+            count += 1
+        if self.save_tags:
+            count += 1
+        if self.copy_tags:
+            count += 1
+        if self.rename_file:
+            count += 1
+        if self.export_to_zip:
+            count += 1
+        if self.only_set_key:
+            count += 1
+
+        if count > 1:
+            self.display_msg_and_quit(
+                "Must choose only one action of print, delete, save, copy, rename, export, set key, or run script",
+                1)
+
+        if self.script is not None:
+            self.launch_script(self.script)
+
+        if len(args) > 0:
+            if platform.system() == "Windows":
+                # no globbing on windows shell, so do it for them
+                import glob
+                self.file_list = []
+                for item in args:
+                    self.file_list.extend(glob.glob(item))
+                if len(self.file_list) > 0:
+                    self.filename = self.file_list[0]
+            else:
+                self.filename = args[0]
+                self.file_list = args
+
+        if self.only_set_key and self.cv_api_key is None:
+            self.display_msg_and_quit("Key not given!", 1)
+
+        if (self.only_set_key == False) and self.no_gui and (
+                self.filename is None):
+            self.display_msg_and_quit(
+                "Command requires at least one filename!", 1)
+
+        if self.delete_tags and self.data_style is None:
+            self.display_msg_and_quit(
+                "Please specify the type to delete with -t", 1)
+
+        if self.save_tags and self.data_style is None:
+            self.display_msg_and_quit(
+                "Please specify the type to save with -t", 1)
+
+        if self.copy_tags and self.data_style is None:
+            self.display_msg_and_quit(
+                "Please specify the type to copy to with -t", 1)
+
+        # if self.rename_file and self.data_style is None:
+        #    self.display_msg_and_quit("Please specify the type to use for renaming with -t", 1)
+
+        if self.recursive:
+            self.file_list = utils.get_recursive_filelist(self.file_list)

comictaggerlib/pagebrowser.py

@@ -1,110 +1,114 @@
-"""
-A PyQT4 dialog to show pages of a comic archive
-"""
+"""A PyQT4 dialog to show pages of a comic archive"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 platform
-import sys
-from PyQt4 import QtCore, QtGui, uic
-import os
-from settings import ComicTaggerSettings
-from coverimagewidget import CoverImageWidget
+#import sys
+#import os
 
-class PageBrowserWindow(QtGui.QDialog):
-	
-	def __init__(self, parent, metadata):
-		super(PageBrowserWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('pagebrowser.ui' ), self)
-		
-		self.pageWidget = CoverImageWidget( self.pageContainer, CoverImageWidget.ArchiveMode )
-		gridlayout = QtGui.QGridLayout( self.pageContainer )
-		gridlayout.addWidget( self.pageWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
-		self.pageWidget.showControls = False
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)
-		
-		self.comic_archive = None
-		self.page_count = 0
-		self.current_page_num = 0
-		self.metadata = metadata
-		
-		self.buttonBox.button(QtGui.QDialogButtonBox.Close).setDefault(True)	
-		if platform.system() == "Darwin":
-			self.btnPrev.setText("<<")
-			self.btnNext.setText(">>")
-		else:
-			self.btnPrev.setIcon(QtGui.QIcon( ComicTaggerSettings.getGraphic('left.png' )))
-			self.btnNext.setIcon(QtGui.QIcon( ComicTaggerSettings.getGraphic('right.png')))
-		
-		self.btnNext.clicked.connect( self.nextPage )
-		self.btnPrev.clicked.connect( self.prevPage )
-		self.show()
-		
-		self.btnNext.setEnabled( False )
-		self.btnPrev.setEnabled( False )
-		
-	def reset( self ):
-		self.comic_archive = None
-		self.page_count = 0
-		self.current_page_num = 0
-		self.metadata = None
-		
-		self.btnNext.setEnabled( False )
-		self.btnPrev.setEnabled( False )
-		self.pageWidget.clear()
+from .settings import ComicTaggerSettings
+from .coverimagewidget import CoverImageWidget
 
-	def setComicArchive(self, ca):
 
-		self.comic_archive = ca
-		self.page_count = ca.getNumberOfPages()
-		self.current_page_num = 0
-		self.pageWidget.setArchive( self.comic_archive )
-		self.setPage()
-	
-		if 	self.page_count > 1:
-			self.btnNext.setEnabled( True )
-			self.btnPrev.setEnabled( True )
+class PageBrowserWindow(QtWidgets.QDialog):
 
-	def nextPage(self):
-		
-		if self.current_page_num + 1 < self.page_count:
-			self.current_page_num += 1
-		else:
-			self.current_page_num = 0
-		self.setPage()
+    def __init__(self, parent, metadata):
+        super(PageBrowserWindow, self).__init__(parent)
 
-	def prevPage(self):
-		
-		if self.current_page_num - 1 >= 0:
-			self.current_page_num -= 1
-		else:
-			self.current_page_num = self.page_count - 1
-		self.setPage()
-			
-	def setPage( self ):
-		if self.metadata is not None:
-			archive_page_index = self.metadata.getArchivePageIndex( self.current_page_num )
-		else:
-			archive_page_index =  self.current_page_num
-			
-		self.pageWidget.setPage( archive_page_index )
-		self.setWindowTitle("Page Browser - Page {0} (of {1}) ".format(self.current_page_num+1, self.page_count ) )
+        uic.loadUi(ComicTaggerSettings.getUIFile('pagebrowser.ui'), self)
+
+        self.pageWidget = CoverImageWidget(
+            self.pageContainer, CoverImageWidget.ArchiveMode)
+        gridlayout = QtWidgets.QGridLayout(self.pageContainer)
+        gridlayout.addWidget(self.pageWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
+        self.pageWidget.showControls = False
+
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
+
+        self.comic_archive = None
+        self.page_count = 0
+        self.current_page_num = 0
+        self.metadata = metadata
+
+        self.buttonBox.button(QtWidgets.QDialogButtonBox.Close).setDefault(True)
+        if platform.system() == "Darwin":
+            self.btnPrev.setText("<<")
+            self.btnNext.setText(">>")
+        else:
+            self.btnPrev.setIcon(
+                QtGui.QIcon(ComicTaggerSettings.getGraphic('left.png')))
+            self.btnNext.setIcon(
+                QtGui.QIcon(ComicTaggerSettings.getGraphic('right.png')))
+
+        self.btnNext.clicked.connect(self.nextPage)
+        self.btnPrev.clicked.connect(self.prevPage)
+        self.show()
+
+        self.btnNext.setEnabled(False)
+        self.btnPrev.setEnabled(False)
+
+    def reset(self):
+        self.comic_archive = None
+        self.page_count = 0
+        self.current_page_num = 0
+        self.metadata = None
+
+        self.btnNext.setEnabled(False)
+        self.btnPrev.setEnabled(False)
+        self.pageWidget.clear()
+
+    def setComicArchive(self, ca):
+
+        self.comic_archive = ca
+        self.page_count = ca.getNumberOfPages()
+        self.current_page_num = 0
+        self.pageWidget.setArchive(self.comic_archive)
+        self.setPage()
+
+        if self.page_count > 1:
+            self.btnNext.setEnabled(True)
+            self.btnPrev.setEnabled(True)
+
+    def nextPage(self):
+
+        if self.current_page_num + 1 < self.page_count:
+            self.current_page_num += 1
+        else:
+            self.current_page_num = 0
+        self.setPage()
+
+    def prevPage(self):
+
+        if self.current_page_num - 1 >= 0:
+            self.current_page_num -= 1
+        else:
+            self.current_page_num = self.page_count - 1
+        self.setPage()
+
+    def setPage(self):
+        if self.metadata is not None:
+            archive_page_index = self.metadata.getArchivePageIndex(
+                self.current_page_num)
+        else:
+            archive_page_index = self.current_page_num
+
+        self.pageWidget.setPage(archive_page_index)
+        self.setWindowTitle(
+            "Page Browser - Page {0} (of {1}) ".format(self.current_page_num + 1, self.page_count))

comictaggerlib/pagelisteditor.py

@@ -1,273 +1,282 @@
-"""
-A PyQt4 widget for editing the page list info
-"""
+"""A PyQt5 widget for editing the page list info"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 os
 
-from PyQt4.QtCore import *
-from PyQt4.QtGui import *
-from PyQt4 import uic
+from PyQt5.QtCore import *
+from PyQt5.QtGui import *
+from PyQt5.QtWidgets import *
+from PyQt5 import uic
 
-from settings import ComicTaggerSettings
-from genericmetadata import GenericMetadata, PageType
-from comicarchive import MetaDataStyle
-from pageloader import PageLoader
-from coverimagewidget import CoverImageWidget
+from .settings import ComicTaggerSettings
+from .genericmetadata import GenericMetadata, PageType
+from .comicarchive import MetaDataStyle
+from .coverimagewidget import CoverImageWidget
+#from pageloader import PageLoader
 
 
-def itemMoveEvents( widget ):
+def itemMoveEvents(widget):
 
-	class Filter(QObject):
-	
-		mysignal = pyqtSignal( str )
-		
-		def eventFilter(self, obj, event):
-		
-			if obj == widget:
-				#print event.type()
-				if event.type() == QEvent.ChildRemoved:
-					#print "ChildRemoved"
-					self.mysignal.emit("finish")
-				if event.type() == QEvent.ChildAdded:
-					#print "ChildAdded"
-					self.mysignal.emit("start")
-					return True
-			
-			return False
+    class Filter(QObject):
+
+        mysignal = pyqtSignal(str)
+
+        def eventFilter(self, obj, event):
+
+            if obj == widget:
+                # print(event.type())
+                if event.type() == QEvent.ChildRemoved:
+                    # print("ChildRemoved")
+                    self.mysignal.emit("finish")
+                if event.type() == QEvent.ChildAdded:
+                    # print("ChildAdded")
+                    self.mysignal.emit("start")
+                    return True
+
+            return False
+
+    filter = Filter(widget)
+    widget.installEventFilter(filter)
+    return filter.mysignal
 
-	filter = Filter( widget )
-	widget.installEventFilter( filter )
-	return filter.mysignal
 
 class PageListEditor(QWidget):
 
-	firstFrontCoverChanged = pyqtSignal( int )
-	listOrderChanged = pyqtSignal( )
-	modified = pyqtSignal( )
-	
-	pageTypeNames = {
-		PageType.FrontCover: "Front Cover",
-		PageType.InnerCover: "Inner Cover",
-		PageType.Advertisment: "Advertisment",
-		PageType.Roundup: "Roundup",
-		PageType.Story: "Story",
-		PageType.Editorial: "Editorial",
-		PageType.Letters: "Letters",
-		PageType.Preview: "Preview",
-		PageType.BackCover: "Back Cover",
-		PageType.Other: "Other",
-		PageType.Deleted: "Deleted",
-	}
+    firstFrontCoverChanged = pyqtSignal(int)
+    listOrderChanged = pyqtSignal()
+    modified = pyqtSignal()
 
-	def __init__(self, parent ):
-		super(PageListEditor, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('pagelisteditor.ui' ), self)
+    pageTypeNames = {
+        PageType.FrontCover: "Front Cover",
+        PageType.InnerCover: "Inner Cover",
+        PageType.Advertisement: "Advertisement",
+        PageType.Roundup: "Roundup",
+        PageType.Story: "Story",
+        PageType.Editorial: "Editorial",
+        PageType.Letters: "Letters",
+        PageType.Preview: "Preview",
+        PageType.BackCover: "Back Cover",
+        PageType.Other: "Other",
+        PageType.Deleted: "Deleted",
+    }
 
-		self.pageWidget = CoverImageWidget( self.pageContainer, CoverImageWidget.ArchiveMode )
-		gridlayout = QGridLayout( self.pageContainer )
-		gridlayout.addWidget( self.pageWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
-		self.pageWidget.showControls = False
+    def __init__(self, parent):
+        super(PageListEditor, self).__init__(parent)
 
-		self.resetPage()
-	
-		# Add the entries to the manga combobox
-		self.comboBox.addItem( "", "" )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.FrontCover], PageType.FrontCover )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.InnerCover], PageType.InnerCover )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.Advertisment], PageType.Advertisment )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.Roundup], PageType.Roundup )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.Story], PageType.Story )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.Editorial], PageType.Editorial )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.Letters], PageType.Letters )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.Preview], PageType.Preview )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.BackCover], PageType.BackCover )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.Other], PageType.Other )
-		self.comboBox.addItem( self.pageTypeNames[ PageType.Deleted], PageType.Deleted )
+        uic.loadUi(ComicTaggerSettings.getUIFile('pagelisteditor.ui'), self)
 
-		self.listWidget.itemSelectionChanged.connect( self.changePage )
-		itemMoveEvents(self.listWidget).connect(self.itemMoveEvent)
-		self.comboBox.activated.connect( self.changePageType )
-		self.btnUp.clicked.connect( self.moveCurrentUp )
-		self.btnDown.clicked.connect( self.moveCurrentDown )
-		self.pre_move_row = -1
-		self.first_front_page = None
+        self.pageWidget = CoverImageWidget(
+            self.pageContainer, CoverImageWidget.ArchiveMode)
+        gridlayout = QGridLayout(self.pageContainer)
+        gridlayout.addWidget(self.pageWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
+        self.pageWidget.showControls = False
 
-	def resetPage( self ):
-		self.pageWidget.clear()
-		self.comboBox.setDisabled(True)
-		self.comic_archive = None
-		self.pages_list = None
-		
-	def moveCurrentUp( self ):
-		row = self.listWidget.currentRow()
-		if row > 0:
-			item = self.listWidget.takeItem ( row )
-			self.listWidget.insertItem( row-1, item )
-			self.listWidget.setCurrentRow( row-1 )
-			self.listOrderChanged.emit()
-			self.emitFrontCoverChange()
-			self.modified.emit()
+        self.resetPage()
 
-	def moveCurrentDown( self ):
-		row = self.listWidget.currentRow()
-		if row < self.listWidget.count()-1:
-			item = self.listWidget.takeItem ( row )
-			self.listWidget.insertItem( row+1, item )
-			self.listWidget.setCurrentRow( row+1 )
-			self.listOrderChanged.emit()
-			self.emitFrontCoverChange()
-			self.modified.emit()
-		
-	def itemMoveEvent(self, s):
-		#print "move event: ", s, self.listWidget.currentRow()
-		if s == "start":
-			self.pre_move_row = self.listWidget.currentRow()
-		if s == "finish":
-			if self.pre_move_row != self.listWidget.currentRow():
-				self.listOrderChanged.emit()
-				self.emitFrontCoverChange()
-				self.modified.emit()
+        # Add the entries to the manga combobox
+        self.comboBox.addItem("", "")
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.FrontCover], PageType.FrontCover)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.InnerCover], PageType.InnerCover)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.Advertisement], PageType.Advertisement)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.Roundup], PageType.Roundup)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.Story], PageType.Story)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.Editorial], PageType.Editorial)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.Letters], PageType.Letters)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.Preview], PageType.Preview)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.BackCover], PageType.BackCover)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.Other], PageType.Other)
+        self.comboBox.addItem(
+            self.pageTypeNames[PageType.Deleted], PageType.Deleted)
 
-	def changePageType( self , i):
-		new_type = self.comboBox.itemData(i).toString()
-		if self.getCurrentPageType() != new_type:
-			self.setCurrentPageType( new_type )
-			self.emitFrontCoverChange()
-			self.modified.emit()
+        self.listWidget.itemSelectionChanged.connect(self.changePage)
+        itemMoveEvents(self.listWidget).connect(self.itemMoveEvent)
+        self.comboBox.activated.connect(self.changePageType)
+        self.btnUp.clicked.connect(self.moveCurrentUp)
+        self.btnDown.clicked.connect(self.moveCurrentDown)
+        self.pre_move_row = -1
+        self.first_front_page = None
 
-	def changePage( self ):
-		row = self.listWidget.currentRow()
-		pagetype = self.getCurrentPageType()
-		
-		i = self.comboBox.findData( pagetype )
-		self.comboBox.setCurrentIndex( i )
-	
-		#idx = int(str (self.listWidget.item( row ).text()))
-		idx = int(self.listWidget.item( row ).data(Qt.UserRole).toPyObject()[0]['Image'])
+    def resetPage(self):
+        self.pageWidget.clear()
+        self.comboBox.setDisabled(True)
+        self.comic_archive = None
+        self.pages_list = None
 
-		if self.comic_archive is not None:
-			self.pageWidget.setArchive( self.comic_archive, idx )
+    def moveCurrentUp(self):
+        row = self.listWidget.currentRow()
+        if row > 0:
+            item = self.listWidget.takeItem(row)
+            self.listWidget.insertItem(row - 1, item)
+            self.listWidget.setCurrentRow(row - 1)
+            self.listOrderChanged.emit()
+            self.emitFrontCoverChange()
+            self.modified.emit()
 
-	def getFirstFrontCover( self ):
-		frontCover = 0
-		for i in range( self.listWidget.count() ):
-			item = self.listWidget.item( i )
-			page_dict = item.data(Qt.UserRole).toPyObject()[0]
-			if 'Type' in page_dict and page_dict['Type'] == PageType.FrontCover:
-				frontCover = int(page_dict['Image'])
-				break
-		return frontCover
-		
+    def moveCurrentDown(self):
+        row = self.listWidget.currentRow()
+        if row < self.listWidget.count() - 1:
+            item = self.listWidget.takeItem(row)
+            self.listWidget.insertItem(row + 1, item)
+            self.listWidget.setCurrentRow(row + 1)
+            self.listOrderChanged.emit()
+            self.emitFrontCoverChange()
+            self.modified.emit()
 
-	def getCurrentPageType( self ):
-		row = self.listWidget.currentRow()
-		page_dict = self.listWidget.item( row ).data(Qt.UserRole).toPyObject()[0]
-		if 'Type' in page_dict:
-			return page_dict['Type']
-		else:
-			return ""
-			
-	def setCurrentPageType( self, t ):
-		row = self.listWidget.currentRow()
-		page_dict = self.listWidget.item( row ).data(Qt.UserRole).toPyObject()[0]
+    def itemMoveEvent(self, s):
+        # print "move event: ", s, self.listWidget.currentRow()
+        if s == "start":
+            self.pre_move_row = self.listWidget.currentRow()
+        if s == "finish":
+            if self.pre_move_row != self.listWidget.currentRow():
+                self.listOrderChanged.emit()
+                self.emitFrontCoverChange()
+                self.modified.emit()
 
-		if t == "":
-			if 'Type' in page_dict:
-				del(page_dict['Type'])
-		else:
-			page_dict['Type'] = str(t)
+    def changePageType(self, i):
+        new_type = self.comboBox.itemData(i)
+        if self.getCurrentPageType() != new_type:
+            self.setCurrentPageType(new_type)
+            self.emitFrontCoverChange()
+            self.modified.emit()
 
-		item = self.listWidget.item( row )
-		# wrap the dict in a tuple to keep from being converted to QStrings
-		item.setData(Qt.UserRole, (page_dict,) )
-		item.setText( self.listEntryText( page_dict ) )
-			
+    def changePage(self):
+        row = self.listWidget.currentRow()
+        pagetype = self.getCurrentPageType()
 
-	def setData( self, comic_archive, pages_list ):
-		self.comic_archive = comic_archive
-		self.pages_list = pages_list
-		if pages_list is not None and len(pages_list) > 0:
-			self.comboBox.setDisabled(False)
+        i = self.comboBox.findData(pagetype)
+        self.comboBox.setCurrentIndex(i)
 
-		self.listWidget.itemSelectionChanged.disconnect( self.changePage )
+        #idx = int(str (self.listWidget.item(row).text()))
+        idx = int(self.listWidget.item(row).data(
+            Qt.UserRole)[0]['Image'])
 
-		self.listWidget.clear()
-		for p in pages_list:
-			item = QListWidgetItem(  self.listEntryText( p ) )
-			# wrap the dict in a tuple to keep from being converted to QStrings
-			item.setData(Qt.UserRole, (p, ))
-						
-			self.listWidget.addItem(  item )
-		self.first_front_page = self.getFirstFrontCover()
-		self.listWidget.itemSelectionChanged.connect( self.changePage )
-		self.listWidget.setCurrentRow ( 0 )
+        if self.comic_archive is not None:
+            self.pageWidget.setArchive(self.comic_archive, idx)
 
-	def listEntryText(self, page_dict):
-		text =  str(int(page_dict['Image']) + 1)
-		if 'Type' in page_dict:
-			text += " (" + self.pageTypeNames[page_dict['Type']] + ")"
-		return text
-		
-	def getPageList( self ):
-		page_list = []		
-		for i in range( self.listWidget.count() ):
-			item = self.listWidget.item( i )
-			page_list.append(  item.data(Qt.UserRole).toPyObject()[0] )
-		return page_list
-		
-	def emitFrontCoverChange( self ):
-		if self.first_front_page != self.getFirstFrontCover():
-			self.first_front_page = self.getFirstFrontCover()
-			self.firstFrontCoverChanged.emit( self.first_front_page )
+    def getFirstFrontCover(self):
+        frontCover = 0
+        for i in range(self.listWidget.count()):
+            item = self.listWidget.item(i)
+            page_dict = item.data(Qt.UserRole)[0] #.toPyObject()[0]
+            if 'Type' in page_dict and page_dict[
+                    'Type'] == PageType.FrontCover:
+                frontCover = int(page_dict['Image'])
+                break
+        return frontCover
 
-	def setMetadataStyle( self, data_style ):
+    def getCurrentPageType(self):
+        row = self.listWidget.currentRow()
+        page_dict = self.listWidget.item(row).data(Qt.UserRole)[0] #.toPyObject()[0]
+        if 'Type' in page_dict:
+            return page_dict['Type']
+        else:
+            return ""
 
-		# depending on the current data style, certain fields are disabled
-		
-		inactive_color = QColor(255, 170, 150)
-		active_palette = self.comboBox.palette()
-		
-		inactive_palette3 = self.comboBox.palette()
-		inactive_palette3.setColor(QPalette.Base, inactive_color)
+    def setCurrentPageType(self, t):
+        row = self.listWidget.currentRow()
+        page_dict = self.listWidget.item(row).data(Qt.UserRole)[0] #.toPyObject()[0]
 
+        if t == "":
+            if 'Type' in page_dict:
+                del(page_dict['Type'])
+        else:
+            page_dict['Type'] = str(t)
 
-		if data_style == MetaDataStyle.CIX:
-			self.btnUp.setEnabled( True )
-			self.btnDown.setEnabled( True )
-			self.comboBox.setEnabled( True )
-			self.listWidget.setEnabled( True )
-			
-			self.listWidget.setPalette(active_palette)
-		
-		elif data_style == MetaDataStyle.CBI:
-			self.btnUp.setEnabled( False )
-			self.btnDown.setEnabled( False )
-			self.comboBox.setEnabled( False )
-			self.listWidget.setEnabled( False )
+        item = self.listWidget.item(row)
+        # wrap the dict in a tuple to keep from being converted to QStrings
+        item.setData(Qt.UserRole, (page_dict,))
+        item.setText(self.listEntryText(page_dict))
 
-			self.listWidget.setPalette(inactive_palette3)
-			
-		elif data_style == MetaDataStyle.CoMet:
-			pass
-		
-		# make sure combo is disabled when no list
-		if self.comic_archive is None:
-			self.comboBox.setEnabled( False )
+    def setData(self, comic_archive, pages_list):
+        self.comic_archive = comic_archive
+        self.pages_list = pages_list
+        if pages_list is not None and len(pages_list) > 0:
+            self.comboBox.setDisabled(False)
+
+        self.listWidget.itemSelectionChanged.disconnect(self.changePage)
+
+        self.listWidget.clear()
+        for p in pages_list:
+            item = QListWidgetItem(self.listEntryText(p))
+            # wrap the dict in a tuple to keep from being converted to QStrings
+            item.setData(Qt.UserRole, (p,))
+
+            self.listWidget.addItem(item)
+        self.first_front_page = self.getFirstFrontCover()
+        self.listWidget.itemSelectionChanged.connect(self.changePage)
+        self.listWidget.setCurrentRow(0)
+
+    def listEntryText(self, page_dict):
+        text = str(int(page_dict['Image']) + 1)
+        if 'Type' in page_dict:
+            text += " (" + self.pageTypeNames[page_dict['Type']] + ")"
+        return text
+
+    def getPageList(self):
+        page_list = []
+        for i in range(self.listWidget.count()):
+            item = self.listWidget.item(i)
+            page_list.append(item.data(Qt.UserRole)[0]) #.toPyObject()[0]
+        return page_list
+
+    def emitFrontCoverChange(self):
+        if self.first_front_page != self.getFirstFrontCover():
+            self.first_front_page = self.getFirstFrontCover()
+            self.firstFrontCoverChanged.emit(self.first_front_page)
+
+    def setMetadataStyle(self, data_style):
+
+        # depending on the current data style, certain fields are disabled
+
+        inactive_color = QColor(255, 170, 150)
+        active_palette = self.comboBox.palette()
+
+        inactive_palette3 = self.comboBox.palette()
+        inactive_palette3.setColor(QPalette.Base, inactive_color)
+
+        if data_style == MetaDataStyle.CIX:
+            self.btnUp.setEnabled(True)
+            self.btnDown.setEnabled(True)
+            self.comboBox.setEnabled(True)
+            self.listWidget.setEnabled(True)
+
+            self.listWidget.setPalette(active_palette)
+
+        elif data_style == MetaDataStyle.CBI:
+            self.btnUp.setEnabled(False)
+            self.btnDown.setEnabled(False)
+            self.comboBox.setEnabled(False)
+            self.listWidget.setEnabled(False)
+
+            self.listWidget.setPalette(inactive_palette3)
+
+        elif data_style == MetaDataStyle.CoMet:
+            pass
+
+        # make sure combo is disabled when no list
+        if self.comic_archive is None:
+            self.comboBox.setEnabled(False)

comictaggerlib/pageloader.py

@@ -1,77 +1,70 @@
-"""
-A PyQT4 class to load a page image from a ComicArchive in a background thread
-"""
+"""A PyQT4 class to load a page image from a ComicArchive in a background thread"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 PyQt4.QtCore import pyqtSignal
+from PyQt5 import QtCore, QtGui, uic
+from PyQt5.QtCore import pyqtSignal
 
-from comicarchive import ComicArchive
+from comictaggerlib.ui.qtutils import getQImageFromData
+#from comicarchive import ComicArchive
+#import utils
 
-"""
-This class holds onto a reference of each instance in a list
-since problems occur if the ref count goes to zero and the GC
-tries to reap the object while the thread is going.
 
-If the client class wants to stop the thread, they should mark
-it as "abandoned", and no signals will be issued
-"""
-	
-class PageLoader( QtCore.QThread ):
+class PageLoader(QtCore.QThread):
 
-	loadComplete = pyqtSignal( QtGui.QImage )
-	
-	instanceList = []
-	mutex = QtCore.QMutex()
+    """
+    This class holds onto a reference of each instance in a list since
+    problems occur if the ref count goes to zero and the GC tries to reap
+    the object while the thread is going.
+    If the client class wants to stop the thread, they should mark it as
+    "abandoned", and no signals will be issued.
+    """
 
-	"""
-	Remove all finished threads from the list
-	"""
-	@staticmethod
-	def reapInstances():
-		for obj in reversed(PageLoader.instanceList ):
-			if obj.isFinished():
-				PageLoader.instanceList.remove(obj)
+    loadComplete = pyqtSignal(QtGui.QImage)
 
-	def __init__(self, ca, page_num ):
-		QtCore.QThread.__init__(self)
-		self.ca = ca
-		self.page_num = page_num
-		self.abandoned = False		
+    instanceList = []
+    mutex = QtCore.QMutex()
 
-		# remove any old instances, and then add ourself
-		PageLoader.mutex.lock()
-		PageLoader.reapInstances()
-		PageLoader.instanceList.append( self )
-		PageLoader.mutex.unlock()
-		
-	def run(self):
-		image_data = self.ca.getPage( self.page_num )
-		if self.abandoned:
-			return
+    # Remove all finished threads from the list
+    @staticmethod
+    def reapInstances():
+        for obj in reversed(PageLoader.instanceList):
+            if obj.isFinished():
+                PageLoader.instanceList.remove(obj)
 
-		if image_data is not None:
-			img = QtGui.QImage()
-			img.loadFromData( image_data )
+    def __init__(self, ca, page_num):
+        QtCore.QThread.__init__(self)
+        self.ca = ca
+        self.page_num = page_num
+        self.abandoned = False
 
-			if self.abandoned:
-				return
-			
-			self.loadComplete.emit( img )
+        # remove any old instances, and then add ourself
+        PageLoader.mutex.lock()
+        PageLoader.reapInstances()
+        PageLoader.instanceList.append(self)
+        PageLoader.mutex.unlock()
 
-	
+    def run(self):
+        image_data = self.ca.getPage(self.page_num)
+        if self.abandoned:
+            return
+
+        if image_data is not None:
+            img = getQImageFromData(image_data)
+
+            if self.abandoned:
+                return
+
+            self.loadComplete.emit(img)

comictaggerlib/progresswindow.py

@@ -1,42 +1,38 @@
-"""
-A PyQT4 dialog to show ID log and progress
-"""
+"""A PyQT5 dialog to show ID log and progress"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
-import utils
+#import sys
+#import os
 
-class IDProgressWindow(QtGui.QDialog):
-	
-	
-	def __init__(self, parent):
-		super(IDProgressWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('progresswindow.ui' ), self)
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)
-
-		utils.reduceWidgetFontSize( self.textEdit )
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize
+from .settings import ComicTaggerSettings
+#import utils
 
 
-		
+class IDProgressWindow(QtWidgets.QDialog):
+
+    def __init__(self, parent):
+        super(IDProgressWindow, self).__init__(parent)
+
+        uic.loadUi(ComicTaggerSettings.getUIFile('progresswindow.ui'), self)
+
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
+
+        reduceWidgetFontSize(self.textEdit)

comictaggerlib/renamewindow.py

@@ -1,157 +1,186 @@
-"""
-A PyQT4 dialog to confirm rename 
-"""
+"""A PyQT4 dialog to confirm rename"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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
-from comicarchive import MetaDataStyle
+# 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 RenameWindow(QtGui.QDialog):
-		
-	def __init__( self, parent, comic_archive_list, data_style, settings ):
-		super(RenameWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('renamewindow.ui' ), self)
-		self.label.setText("Preview (based on {0} tags):".format(MetaDataStyle.name[data_style]))
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
 
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)
+from .settings import ComicTaggerSettings
+from .settingswindow import SettingsWindow
+from .filerenamer import FileRenamer
+from .comicarchive import MetaDataStyle
+from comictaggerlib.ui.qtutils import  centerWindowOnParent
+from . import utils
 
-		self.settings = settings
-		self.comic_archive_list = comic_archive_list
-		self.data_style = data_style
-		
-		self.btnSettings.clicked.connect( self.modifySettings )
-		self.configRenamer()
-		self.doPreview()
 
-	def configRenamer( self ):
-		self.renamer = FileRenamer( None )
-		self.renamer.setTemplate( self.settings.rename_template )
-		self.renamer.setIssueZeroPadding( self.settings.rename_issue_number_padding )
-		self.renamer.setSmartCleanup( self.settings.rename_use_smart_string_cleanup )		
-		
-	def doPreview( self ):
-		self.rename_list = []
-		while self.twList.rowCount() > 0:
-			self.twList.removeRow(0)
+class RenameWindow(QtWidgets.QDialog):
 
-		self.twList.setSortingEnabled(False)
-			
-		for ca in self.comic_archive_list:
+    def __init__(self, parent, comic_archive_list, data_style, settings):
+        super(RenameWindow, self).__init__(parent)
 
-			new_ext = None  # default
-			if self.settings.rename_extension_based_on_archive:
-				if ca.isZip():
-					new_ext = ".cbz"
-				elif ca.isRar():
-					new_ext = ".cbr"			
+        uic.loadUi(ComicTaggerSettings.getUIFile('renamewindow.ui'), self)
+        self.label.setText(
+            "Preview (based on {0} tags):".format(
+                MetaDataStyle.name[data_style]))
 
-			md = ca.readMetadata(self.data_style)
-			if md.isEmpty:
-				md = ca.metadataFromFilename()
-			self.renamer.setMetadata( md )
-			new_name = self.renamer.determineName( ca.path, ext=new_ext )		
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
 
-			row = self.twList.rowCount()
-			self.twList.insertRow( row )
-			folder_item =   QtGui.QTableWidgetItem()
-			old_name_item = QtGui.QTableWidgetItem()
-			new_name_item = QtGui.QTableWidgetItem()
-			
-			item_text = os.path.split(ca.path)[0]
-			folder_item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 0, folder_item)
-			folder_item.setText( item_text )
-			folder_item.setData( QtCore.Qt.ToolTipRole, item_text )
-					
-			item_text = os.path.split(ca.path)[1]
-			old_name_item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 1, old_name_item)
-			old_name_item.setText( item_text )
-			old_name_item.setData( QtCore.Qt.ToolTipRole, item_text )
+        self.settings = settings
+        self.comic_archive_list = comic_archive_list
+        self.data_style = data_style
 
-			new_name_item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 2, new_name_item)
-			new_name_item.setText( new_name )
-			new_name_item.setData( QtCore.Qt.ToolTipRole, new_name )
-			
-			dict_item = dict()
-			dict_item['archive'] = ca
-			dict_item['new_name'] = new_name
-			self.rename_list.append( dict_item)
+        self.btnSettings.clicked.connect(self.modifySettings)
+        self.configRenamer()
+        self.doPreview()
 
-		# Adjust column sizes
-		self.twList.setVisible( False )
-		self.twList.resizeColumnsToContents()
-		self.twList.setVisible( True )
-		if self.twList.columnWidth(0) > 200:
-			self.twList.setColumnWidth(0, 200)
-			
-		self.twList.setSortingEnabled(True)
-		
-	def modifySettings( self ):
-		settingswin = SettingsWindow( self, self.settings )
-		settingswin.setModal(True)
-		settingswin.showRenameTab()
-		settingswin.exec_()
-		if settingswin.result():
-			self.configRenamer()
-			self.doPreview()
-				
-	def accept( self ):
+    def configRenamer(self):
+        self.renamer = FileRenamer(None)
+        self.renamer.setTemplate(self.settings.rename_template)
+        self.renamer.setIssueZeroPadding(
+            self.settings.rename_issue_number_padding)
+        self.renamer.setSmartCleanup(
+            self.settings.rename_use_smart_string_cleanup)
 
-		progdialog = QtGui.QProgressDialog("", "Cancel", 0, len(self.rename_list), self)
-		progdialog.setWindowTitle( "Renaming Archives" )
-		progdialog.setWindowModality(QtCore.Qt.WindowModal)
-		progdialog.show()
+    def doPreview(self):
+        self.rename_list = []
+        while self.twList.rowCount() > 0:
+            self.twList.removeRow(0)
 
-		for idx,item in enumerate(self.rename_list):
+        self.twList.setSortingEnabled(False)
 
-			QtCore.QCoreApplication.processEvents()
-			if progdialog.wasCanceled():
-				break
-			progdialog.setValue(idx)
-			idx += 1
-			progdialog.setLabelText( item['new_name'] )
-			
-			if item['new_name'] == os.path.basename( item['archive'].path ):
-				print item['new_name'] , "Filename is already good!"
-				continue
-			
-			if not item['archive'].isWritable(check_rar_status=False):
-				continue
-			
-			folder = os.path.dirname( os.path.abspath( item['archive'].path ) )
-			new_abs_path = utils.unique_file( os.path.join( folder, item['new_name'] ) )
-	
-			os.rename( item['archive'].path, new_abs_path)
-	
-			item['archive'].rename( new_abs_path )
-			
-		progdialog.close()		
+        for ca in self.comic_archive_list:
 
-		QtGui.QDialog.accept(self)		
+            new_ext = None  # default
+            if self.settings.rename_extension_based_on_archive:
+                if ca.isZip():
+                    new_ext = ".cbz"
+                elif ca.isRar():
+                    new_ext = ".cbr"
+
+            md = ca.readMetadata(self.data_style)
+            if md.isEmpty:
+                md = ca.metadataFromFilename(self.settings.parse_scan_info)
+            self.renamer.setMetadata(md)
+            self.renamer.move = self.settings.rename_move_dir
+
+            try:
+                new_name = self.renamer.determineName(ca.path, ext=new_ext)
+            except Exception as e:
+                QtWidgets.QMessageBox.critical(self, 'Invalid format string!',
+                    'Your rename template is invalid!'
+                    '<br/><br/>{}<br/><br/>'
+                    'Please consult the template help in the '
+                    'settings and the documentation on the format at '
+                    '<a href=\'https://docs.python.org/3/library/string.html#format-string-syntax\'>'
+                    'https://docs.python.org/3/library/string.html#format-string-syntax</a>'.format(e))
+                return
+
+
+            row = self.twList.rowCount()
+            self.twList.insertRow(row)
+            folder_item = QtWidgets.QTableWidgetItem()
+            old_name_item = QtWidgets.QTableWidgetItem()
+            new_name_item = QtWidgets.QTableWidgetItem()
+
+            item_text = os.path.split(ca.path)[0]
+            folder_item.setFlags(
+                QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 0, folder_item)
+            folder_item.setText(item_text)
+            folder_item.setData(QtCore.Qt.ToolTipRole, item_text)
+
+            item_text = os.path.split(ca.path)[1]
+            old_name_item.setFlags(
+                QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 1, old_name_item)
+            old_name_item.setText(item_text)
+            old_name_item.setData(QtCore.Qt.ToolTipRole, item_text)
+
+            new_name_item.setFlags(
+                QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 2, new_name_item)
+            new_name_item.setText(new_name)
+            new_name_item.setData(QtCore.Qt.ToolTipRole, new_name)
+
+            dict_item = dict()
+            dict_item['archive'] = ca
+            dict_item['new_name'] = new_name
+            self.rename_list.append(dict_item)
+
+        # Adjust column sizes
+        self.twList.setVisible(False)
+        self.twList.resizeColumnsToContents()
+        self.twList.setVisible(True)
+        if self.twList.columnWidth(0) > 200:
+            self.twList.setColumnWidth(0, 200)
+
+        self.twList.setSortingEnabled(True)
+
+    def modifySettings(self):
+        settingswin = SettingsWindow(self, self.settings)
+        settingswin.setModal(True)
+        settingswin.showRenameTab()
+        settingswin.exec_()
+        if settingswin.result():
+            self.configRenamer()
+            self.doPreview()
+
+    def accept(self):
+
+        progdialog = QtWidgets.QProgressDialog(
+            "", "Cancel", 0, len(self.rename_list), self)
+        progdialog.setWindowTitle("Renaming Archives")
+        progdialog.setWindowModality(QtCore.Qt.WindowModal)
+        progdialog.setMinimumDuration(100)
+        centerWindowOnParent(progdialog)
+        #progdialog.show()
+        QtCore.QCoreApplication.processEvents()
+
+        for idx, item in enumerate(self.rename_list):
+
+            QtCore.QCoreApplication.processEvents()
+            if progdialog.wasCanceled():
+                break
+            idx += 1
+            progdialog.setValue(idx)
+            progdialog.setLabelText(item['new_name'])
+            centerWindowOnParent(progdialog)
+            QtCore.QCoreApplication.processEvents()
+
+            folder = os.path.dirname(os.path.abspath(item['archive'].path))
+            if self.settings.rename_move_dir and len(self.settings.rename_dir.strip()) > 3:
+                folder = self.settings.rename_dir.strip()
+
+            new_abs_path = utils.unique_file(os.path.join(folder, item['new_name']))
+
+            if os.path.join(folder, item['new_name']) == item['archive'].path:
+                print(item['new_name'], "Filename is already good!")
+                continue
+
+            if not item['archive'].isWritable(check_rar_status=False):
+                continue
+
+            os.makedirs(os.path.dirname(new_abs_path), 0o777, True)
+            os.rename(item['archive'].path, new_abs_path)
+
+            item['archive'].rename(new_abs_path)
+
+        progdialog.hide()
+        QtCore.QCoreApplication.processEvents()
+
+        QtWidgets.QDialog.accept(self)

comictaggerlib/settings.py

@@ -1,24 +1,19 @@
-"""
-Settings class for comictagger app
-"""
+"""Settings class for ComicTagger app"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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
 import sys
 import configparser
@@ -26,310 +21,480 @@ import platform
 import codecs
 import uuid
 
-import utils
+from . import utils
+
 
 class ComicTaggerSettings:
 
-	@staticmethod
-	def getSettingsFolder():
-		if platform.system() == "Windows":
-			return os.path.join( os.environ['APPDATA'], 'ComicTagger' )
-		else:
-			return os.path.join( os.path.expanduser('~') , '.ComicTagger')
+    @staticmethod
+    def getSettingsFolder():
+        filename_encoding = sys.getfilesystemencoding()
+        if platform.system() == "Windows":
+            folder = os.path.join(os.environ['APPDATA'], 'ComicTagger')
+        else:
+            folder = os.path.join(os.path.expanduser('~'), '.ComicTagger')
+        if folder is not None:
+            folder = folder
+        return folder
+    
+    @staticmethod
+    def baseDir():
+        if getattr(sys, 'frozen', None):
+            return sys._MEIPASS
+        else:
+            return os.path.dirname(os.path.abspath(__file__))
 
-	frozen_win_exe_path = None
-	
-	@staticmethod
-	def baseDir():
-		if getattr(sys, 'frozen', None):
-			if platform.system() == "Darwin":
-				return sys._MEIPASS
-			else: # Windows
-				#Preserve this value, in case sys.argv gets changed importing a plugin script
-				if ComicTaggerSettings.frozen_win_exe_path is None:
-					ComicTaggerSettings.frozen_win_exe_path = os.path.dirname( os.path.abspath( sys.argv[0] ) )
-				return ComicTaggerSettings.frozen_win_exe_path
-		else:
-			return os.path.dirname( os.path.abspath( __file__) )
+    @staticmethod
+    def getGraphic(filename):
+        graphic_folder = os.path.join(
+            ComicTaggerSettings.baseDir(), 'graphics')
+        return os.path.join(graphic_folder, filename)
 
-	@staticmethod
-	def getGraphic( filename ):
-		graphic_folder = os.path.join(ComicTaggerSettings.baseDir(), 'graphics')
-		return os.path.join( graphic_folder, filename )
-		
-	@staticmethod
-	def getUIFile( filename ):
-		ui_folder = os.path.join(ComicTaggerSettings.baseDir(), 'ui')
-		return os.path.join( ui_folder, filename )
+    @staticmethod
+    def getUIFile(filename):
+        ui_folder = os.path.join(ComicTaggerSettings.baseDir(), 'ui')
+        return os.path.join(ui_folder, filename)
 
-	def setDefaultValues( self ):
+    def setDefaultValues(self):
+        # General Settings
+        self.rar_exe_path = ""
+        self.allow_cbi_in_rar = True
+        self.check_for_new_version = False
+        self.send_usage_stats = False
 
-		# General Settings
-		self.rar_exe_path = ""
-		self.unrar_exe_path = ""
-		self.allow_cbi_in_rar = True
-		self.check_for_new_version = True
-		self.send_usage_stats = False
-		
-		# automatic settings
-		self.install_id = uuid.uuid4().hex
-		self.last_selected_save_data_style = 0
-		self.last_selected_load_data_style = 0
-		self.last_opened_folder = ""
-		self.last_main_window_width = 0
-		self.last_main_window_height = 0
-		self.last_main_window_x = 0
-		self.last_main_window_y = 0
-		self.last_form_side_width = -1
-		self.last_list_side_width = -1
-		self.last_filelist_sorted_column = -1
-		self.last_filelist_sorted_order = 0
-		
-		# identifier settings
-		self.id_length_delta_thresh = 5
-		self.id_publisher_blacklist = "Panini Comics, Abril, Planeta DeAgostini, Editorial Televisa"
-		
-		# Show/ask dialog flags
-		self.ask_about_cbi_in_rar = True
-		self.show_disclaimer = True
-		self.dont_notify_about_this_version = ""
-		self.ask_about_usage_stats = True
-		
-		#filename parsing settings
-		self.parse_scan_info = True
-		
-		# Comic Vine settings
-		self.use_series_start_as_volume = False
-		
-		# CBL Tranform settings
-		
-		self.assume_lone_credit_is_primary = False
-		self.copy_characters_to_tags = False
-		self.copy_teams_to_tags = False
-		self.copy_locations_to_tags = False
-		self.copy_notes_to_comments = False
-		self.copy_weblink_to_comments = False
-		self.apply_cbl_transform_on_cv_import = False
-		self.apply_cbl_transform_on_bulk_operation = False
+        # automatic settings
+        self.install_id = uuid.uuid4().hex
+        self.last_selected_save_data_style = 0
+        self.last_selected_load_data_style = 0
+        self.last_opened_folder = ""
+        self.last_main_window_width = 0
+        self.last_main_window_height = 0
+        self.last_main_window_x = 0
+        self.last_main_window_y = 0
+        self.last_form_side_width = -1
+        self.last_list_side_width = -1
+        self.last_filelist_sorted_column = -1
+        self.last_filelist_sorted_order = 0
 
-		# Rename settings
-		self.rename_template = "%series% #%issue% (%year%)"
-		self.rename_issue_number_padding = 3
-		self.rename_use_smart_string_cleanup = True
-		self.rename_extension_based_on_archive = True
+        # identifier settings
+        self.id_length_delta_thresh = 5
+        self.id_publisher_blacklist = "Panini Comics, Abril, Planeta DeAgostini, Editorial Televisa, Dino Comics"
 
-	def __init__(self):
-		
-		self.settings_file = ""
-		self.folder = ""
-		self.setDefaultValues()
+        # Show/ask dialog flags
+        self.ask_about_cbi_in_rar = True
+        self.show_disclaimer = True
+        self.dont_notify_about_this_version = ""
+        self.ask_about_usage_stats = True
 
-		self.config = configparser.RawConfigParser()
-		self.folder = ComicTaggerSettings.getSettingsFolder()
-		
-		if not os.path.exists( self.folder ):
-			os.makedirs( self.folder )
-		
-		self.settings_file = os.path.join( self.folder, "settings")
-		
-		# if config file doesn't exist, write one out
-		if not os.path.exists( self.settings_file ):
-			self.save()
-		else:
-			self.load()
-		
-		# take a crack at finding rar exes, if not set already
-		if self.rar_exe_path == "":
-			if platform.system() == "Windows":
-				# look in some likely places for windows machine
-				if os.path.exists( "C:\Program Files\WinRAR\Rar.exe" ):
-					self.rar_exe_path = "C:\Program Files\WinRAR\Rar.exe"
-				elif os.path.exists( "C:\Program Files (x86)\WinRAR\Rar.exe" ):
-					self.rar_exe_path = "C:\Program Files (x86)\WinRAR\Rar.exe"
-			else:
-				# see if it's in the path of unix user
-				if utils.which("rar") is not None:
-					self.rar_exe_path = utils.which("rar")
-			if self.rar_exe_path != "":
-				self.save()
-					
-		if self.unrar_exe_path == "":
-			if platform.system() != "Windows":
-				# see if it's in the path of unix user
-				if utils.which("unrar") is not None:
-					self.unrar_exe_path = utils.which("unrar")
-			if self.unrar_exe_path != "":
-				self.save()
-				
-		# make sure unrar/rar program is now in the path for the UnRAR class to use
-		utils.addtopath(os.path.dirname(self.unrar_exe_path))
-		utils.addtopath(os.path.dirname(self.rar_exe_path))
+        # filename parsing settings
+        self.parse_scan_info = True
 
-	def reset( self ):
-		os.unlink( self.settings_file )
-		self.__init__()
-		
-	def load(self):
+        # Comic Vine settings
+        self.use_series_start_as_volume = False
+        self.clear_form_before_populating_from_cv = False
+        self.remove_html_tables = False
+        self.cv_api_key = ""
 
-		def readline_generator(f):
-			line = f.readline()
-			while line:
-				yield line
-				line = f.readline()			
+        # CBL Tranform settings
 
-		#self.config.readfp(codecs.open(self.settings_file, "r", "utf8"))
-		self.config.read_file(readline_generator(codecs.open(self.settings_file, "r", "utf8")))
-		
-		self.rar_exe_path =    self.config.get( 'settings', 'rar_exe_path' )
-		self.unrar_exe_path =  self.config.get( 'settings', 'unrar_exe_path' )
-		if self.config.has_option('settings', 'check_for_new_version'):
-			self.check_for_new_version =        self.config.getboolean( 'settings', 'check_for_new_version' )		
-		if self.config.has_option('settings', 'send_usage_stats'):
-			self.send_usage_stats =        self.config.getboolean( 'settings', 'send_usage_stats' )		
-	
-		if self.config.has_option('auto', 'install_id'):
-			self.install_id =  self.config.get( 'auto', 'install_id' )
-		if self.config.has_option('auto', 'last_selected_load_data_style'):
-			self.last_selected_load_data_style =  self.config.getint( 'auto', 'last_selected_load_data_style' )
-		if self.config.has_option('auto', 'last_selected_save_data_style'):
-			self.last_selected_save_data_style =  self.config.getint( 'auto', 'last_selected_save_data_style' )
-		if self.config.has_option('auto', 'last_opened_folder'):
-			self.last_opened_folder =        self.config.get( 'auto', 'last_opened_folder' )
-		if self.config.has_option('auto', 'last_main_window_width'):
-			self.last_main_window_width =    self.config.getint( 'auto', 'last_main_window_width' )
-		if self.config.has_option('auto', 'last_main_window_height'):
-			self.last_main_window_height =   self.config.getint( 'auto', 'last_main_window_height' )
-		if self.config.has_option('auto', 'last_main_window_x'):
-			self.last_main_window_x =   self.config.getint( 'auto', 'last_main_window_x' )
-		if self.config.has_option('auto', 'last_main_window_y'):
-			self.last_main_window_y =   self.config.getint( 'auto', 'last_main_window_y' )
-		if self.config.has_option('auto', 'last_form_side_width'):
-			self.last_form_side_width =   self.config.getint( 'auto', 'last_form_side_width' )
-		if self.config.has_option('auto', 'last_list_side_width'):
-			self.last_list_side_width =   self.config.getint( 'auto', 'last_list_side_width' )
-		if self.config.has_option('auto', 'last_filelist_sorted_column'):
-			self.last_filelist_sorted_column =   self.config.getint( 'auto', 'last_filelist_sorted_column' )
-		if self.config.has_option('auto', 'last_filelist_sorted_order'):
-			self.last_filelist_sorted_order =   self.config.getint( 'auto', 'last_filelist_sorted_order' )
+        self.assume_lone_credit_is_primary = False
+        self.copy_characters_to_tags = False
+        self.copy_teams_to_tags = False
+        self.copy_locations_to_tags = False
+        self.copy_storyarcs_to_tags = False
+        self.copy_notes_to_comments = False
+        self.copy_weblink_to_comments = False
+        self.apply_cbl_transform_on_cv_import = False
+        self.apply_cbl_transform_on_bulk_operation = False
 
-		if self.config.has_option('identifier', 'id_length_delta_thresh'):
-			self.id_length_delta_thresh =   self.config.getint( 'identifier', 'id_length_delta_thresh' )
-		if self.config.has_option('identifier', 'id_publisher_blacklist'):
-			self.id_publisher_blacklist =   self.config.get( 'identifier', 'id_publisher_blacklist' )
+        # Rename settings
+        self.rename_template = "{publisher}/{series}/{series} #{issue} - {title} ({year})"
+        self.rename_issue_number_padding = 3
+        self.rename_use_smart_string_cleanup = True
+        self.rename_extension_based_on_archive = True
+        self.rename_dir = ""
+        self.rename_move_dir = False
 
-		if self.config.has_option('filenameparser', 'parse_scan_info'):
-			self.parse_scan_info =   self.config.getboolean( 'filenameparser', 'parse_scan_info' )
+        # Auto-tag stickies
+        self.save_on_low_confidence = False
+        self.dont_use_year_when_identifying = False
+        self.assume_1_if_no_issue_num = False
+        self.ignore_leading_numbers_in_filename = False
+        self.remove_archive_after_successful_match = False
+        self.wait_and_retry_on_rate_limit = False
 
-		if self.config.has_option('dialogflags', 'ask_about_cbi_in_rar'):
-			self.ask_about_cbi_in_rar =        self.config.getboolean( 'dialogflags', 'ask_about_cbi_in_rar' )		
-		if self.config.has_option('dialogflags', 'show_disclaimer'):
-			self.show_disclaimer =        self.config.getboolean( 'dialogflags', 'show_disclaimer' )
-		if self.config.has_option('dialogflags', 'dont_notify_about_this_version'):
-			self.dont_notify_about_this_version = self.config.get( 'dialogflags', 'dont_notify_about_this_version' )
-		if self.config.has_option('dialogflags', 'ask_about_usage_stats'):
-			self.ask_about_usage_stats =        self.config.getboolean( 'dialogflags', 'ask_about_usage_stats' )		
-						
-		if self.config.has_option('comicvine', 'use_series_start_as_volume'):
-			self.use_series_start_as_volume =        self.config.getboolean( 'comicvine', 'use_series_start_as_volume' )		
+    def __init__(self):
 
-		if self.config.has_option('cbl_transform', 'assume_lone_credit_is_primary'):
-			self.assume_lone_credit_is_primary =         self.config.getboolean( 'cbl_transform', 'assume_lone_credit_is_primary' )		
-		if self.config.has_option('cbl_transform', 'copy_characters_to_tags'):
-			self.copy_characters_to_tags =               self.config.getboolean( 'cbl_transform', 'copy_characters_to_tags' )		
-		if self.config.has_option('cbl_transform', 'copy_teams_to_tags'):
-			self.copy_teams_to_tags =                    self.config.getboolean( 'cbl_transform', 'copy_teams_to_tags' )		
-		if self.config.has_option('cbl_transform', 'copy_locations_to_tags'):
-			self.copy_locations_to_tags =                self.config.getboolean( 'cbl_transform', 'copy_locations_to_tags' )		
-		if self.config.has_option('cbl_transform', 'copy_notes_to_comments'):
-			self.copy_notes_to_comments =                self.config.getboolean( 'cbl_transform', 'copy_notes_to_comments' )		
-		if self.config.has_option('cbl_transform', 'copy_weblink_to_comments'):
-			self.copy_weblink_to_comments =              self.config.getboolean( 'cbl_transform', 'copy_weblink_to_comments' )		
-		if self.config.has_option('cbl_transform', 'apply_cbl_transform_on_cv_import'):
-			self.apply_cbl_transform_on_cv_import =      self.config.getboolean( 'cbl_transform', 'apply_cbl_transform_on_cv_import' )		
-		if self.config.has_option('cbl_transform', 'apply_cbl_transform_on_bulk_operation'):
-			self.apply_cbl_transform_on_bulk_operation = self.config.getboolean( 'cbl_transform', 'apply_cbl_transform_on_bulk_operation' )		
-			
-		if self.config.has_option('rename', 'rename_template'):
-			self.rename_template =                  self.config.get( 'rename', 'rename_template' )		
-		if self.config.has_option('rename', 'rename_issue_number_padding'):
-			self.rename_issue_number_padding =      self.config.getint( 'rename', 'rename_issue_number_padding' )		
-		if self.config.has_option('rename', 'rename_use_smart_string_cleanup'):
-			self.rename_use_smart_string_cleanup =  self.config.getboolean( 'rename', 'rename_use_smart_string_cleanup' )		
-		if self.config.has_option('rename', 'rename_extension_based_on_archive'):
-			self.rename_extension_based_on_archive =  self.config.getboolean( 'rename', 'rename_extension_based_on_archive' )		
-			
-	def save( self ):
+        self.settings_file = ""
+        self.folder = ""
+        self.setDefaultValues()
 
-		if not self.config.has_section( 'settings' ):
-			self.config.add_section( 'settings' )
+        self.config = configparser.RawConfigParser()
+        self.folder = ComicTaggerSettings.getSettingsFolder()
 
-		self.config.set( 'settings', 'check_for_new_version',   self.check_for_new_version )
-		self.config.set( 'settings', 'rar_exe_path',   self.rar_exe_path )
-		self.config.set( 'settings', 'unrar_exe_path', self.unrar_exe_path )
-		self.config.set( 'settings', 'send_usage_stats', self.send_usage_stats )	
+        if not os.path.exists(self.folder):
+            os.makedirs(self.folder)
 
-		if not self.config.has_section( 'auto' ):
-			self.config.add_section( 'auto' )
+        self.settings_file = os.path.join(self.folder, "settings")
 
-		self.config.set( 'auto', 'install_id', self.install_id )
-		self.config.set( 'auto', 'last_selected_load_data_style', self.last_selected_load_data_style )
-		self.config.set( 'auto', 'last_selected_save_data_style', self.last_selected_save_data_style )
-		self.config.set( 'auto', 'last_opened_folder', self.last_opened_folder )
-		self.config.set( 'auto', 'last_main_window_width', self.last_main_window_width )
-		self.config.set( 'auto', 'last_main_window_height', self.last_main_window_height )
-		self.config.set( 'auto', 'last_main_window_x', self.last_main_window_x )
-		self.config.set( 'auto', 'last_main_window_y', self.last_main_window_y )
-		self.config.set( 'auto', 'last_form_side_width', self.last_form_side_width )
-		self.config.set( 'auto', 'last_list_side_width', self.last_list_side_width )
-		self.config.set( 'auto', 'last_filelist_sorted_column', self.last_filelist_sorted_column )
-		self.config.set( 'auto', 'last_filelist_sorted_order', self.last_filelist_sorted_order )
+        # if config file doesn't exist, write one out
+        if not os.path.exists(self.settings_file):
+            self.save()
+        else:
+            self.load()
 
-		if not self.config.has_section( 'identifier' ):
-			self.config.add_section( 'identifier' )
+        # take a crack at finding rar exe, if not set already
+        if self.rar_exe_path == "":
+            if platform.system() == "Windows":
+                # look in some likely places for Windows machines
+                if os.path.exists("C:\Program Files\WinRAR\Rar.exe"):
+                    self.rar_exe_path = "C:\Program Files\WinRAR\Rar.exe"
+                elif os.path.exists("C:\Program Files (x86)\WinRAR\Rar.exe"):
+                    self.rar_exe_path = "C:\Program Files (x86)\WinRAR\Rar.exe"
+            else:
+                # see if it's in the path of unix user
+                if utils.which("rar") is not None:
+                    self.rar_exe_path = utils.which("rar")
+            if self.rar_exe_path != "":
+                self.save()
+        if self.rar_exe_path != "":
+             # make sure rar program is now in the path for the rar class    
+            utils.addtopath(os.path.dirname(self.rar_exe_path))          
 
-		self.config.set( 'identifier', 'id_length_delta_thresh', self.id_length_delta_thresh )
-		self.config.set( 'identifier', 'id_publisher_blacklist', self.id_publisher_blacklist )
+    def reset(self):
+        os.unlink(self.settings_file)
+        self.__init__()
 
-		if not self.config.has_section( 'dialogflags' ):
-			self.config.add_section( 'dialogflags' )
+    def load(self):
 
-		self.config.set( 'dialogflags', 'ask_about_cbi_in_rar', self.ask_about_cbi_in_rar )
-		self.config.set( 'dialogflags', 'show_disclaimer', self.show_disclaimer )
-		self.config.set( 'dialogflags', 'dont_notify_about_this_version', self.dont_notify_about_this_version )
-		self.config.set( 'dialogflags', 'ask_about_usage_stats', self.ask_about_usage_stats )
+        def readline_generator(f):
+            line = f.readline()
+            while line:
+                yield line
+                line = f.readline()
 
-		if not self.config.has_section( 'filenameparser' ):
-			self.config.add_section( 'filenameparser' )
-			
-		self.config.set( 'filenameparser', 'parse_scan_info', self.parse_scan_info )
-	
-		if not self.config.has_section( 'comicvine' ):
-			self.config.add_section( 'comicvine' )
-			
-		self.config.set( 'comicvine', 'use_series_start_as_volume', self.use_series_start_as_volume )
+        #self.config.readfp(codecs.open(self.settings_file, "r", "utf8"))
+        self.config.read_file(
+            readline_generator(codecs.open(self.settings_file, "r", "utf8")))
 
-		if not self.config.has_section( 'cbl_transform' ):
-			self.config.add_section( 'cbl_transform' )
+        self.rar_exe_path = self.config.get('settings', 'rar_exe_path')
+        if self.config.has_option('settings', 'check_for_new_version'):
+            self.check_for_new_version = self.config.getboolean(
+                'settings', 'check_for_new_version')
+        if self.config.has_option('settings', 'send_usage_stats'):
+            self.send_usage_stats = self.config.getboolean(
+                'settings', 'send_usage_stats')
 
-		self.config.set( 'cbl_transform', 'assume_lone_credit_is_primary', self.assume_lone_credit_is_primary )
-		self.config.set( 'cbl_transform', 'copy_characters_to_tags', self.copy_characters_to_tags )
-		self.config.set( 'cbl_transform', 'copy_teams_to_tags', self.copy_teams_to_tags )
-		self.config.set( 'cbl_transform', 'copy_locations_to_tags', self.copy_locations_to_tags )
-		self.config.set( 'cbl_transform', 'copy_notes_to_comments', self.copy_notes_to_comments )
-		self.config.set( 'cbl_transform', 'copy_weblink_to_comments', self.copy_weblink_to_comments )
-		self.config.set( 'cbl_transform', 'apply_cbl_transform_on_cv_import', self.apply_cbl_transform_on_cv_import )
-		self.config.set( 'cbl_transform', 'apply_cbl_transform_on_bulk_operation', self.apply_cbl_transform_on_bulk_operation )
+        if self.config.has_option('auto', 'install_id'):
+            self.install_id = self.config.get('auto', 'install_id')
+        if self.config.has_option('auto', 'last_selected_load_data_style'):
+            self.last_selected_load_data_style = self.config.getint(
+                'auto', 'last_selected_load_data_style')
+        if self.config.has_option('auto', 'last_selected_save_data_style'):
+            self.last_selected_save_data_style = self.config.getint(
+                'auto', 'last_selected_save_data_style')
+        if self.config.has_option('auto', 'last_opened_folder'):
+            self.last_opened_folder = self.config.get(
+                'auto', 'last_opened_folder')
+        if self.config.has_option('auto', 'last_main_window_width'):
+            self.last_main_window_width = self.config.getint(
+                'auto', 'last_main_window_width')
+        if self.config.has_option('auto', 'last_main_window_height'):
+            self.last_main_window_height = self.config.getint(
+                'auto', 'last_main_window_height')
+        if self.config.has_option('auto', 'last_main_window_x'):
+            self.last_main_window_x = self.config.getint(
+                'auto', 'last_main_window_x')
+        if self.config.has_option('auto', 'last_main_window_y'):
+            self.last_main_window_y = self.config.getint(
+                'auto', 'last_main_window_y')
+        if self.config.has_option('auto', 'last_form_side_width'):
+            self.last_form_side_width = self.config.getint(
+                'auto', 'last_form_side_width')
+        if self.config.has_option('auto', 'last_list_side_width'):
+            self.last_list_side_width = self.config.getint(
+                'auto', 'last_list_side_width')
+        if self.config.has_option('auto', 'last_filelist_sorted_column'):
+            self.last_filelist_sorted_column = self.config.getint(
+                'auto', 'last_filelist_sorted_column')
+        if self.config.has_option('auto', 'last_filelist_sorted_order'):
+            self.last_filelist_sorted_order = self.config.getint(
+                'auto', 'last_filelist_sorted_order')
 
-		if not self.config.has_section( 'rename' ):
-			self.config.add_section( 'rename' )
+        if self.config.has_option('identifier', 'id_length_delta_thresh'):
+            self.id_length_delta_thresh = self.config.getint(
+                'identifier', 'id_length_delta_thresh')
+        if self.config.has_option('identifier', 'id_publisher_blacklist'):
+            self.id_publisher_blacklist = self.config.get(
+                'identifier', 'id_publisher_blacklist')
 
-		self.config.set( 'rename', 'rename_template', self.rename_template )
-		self.config.set( 'rename', 'rename_issue_number_padding', self.rename_issue_number_padding )
-		self.config.set( 'rename', 'rename_use_smart_string_cleanup', self.rename_use_smart_string_cleanup )
-		self.config.set( 'rename', 'rename_extension_based_on_archive', self.rename_extension_based_on_archive )
-		
-		with codecs.open( self.settings_file, 'wb', 'utf8') as configfile:
-			self.config.write(configfile)    
+        if self.config.has_option('filenameparser', 'parse_scan_info'):
+            self.parse_scan_info = self.config.getboolean(
+                'filenameparser', 'parse_scan_info')
 
-#make sure the basedir is cached, in case we're  on windows running a script from frozen binary
+        if self.config.has_option('dialogflags', 'ask_about_cbi_in_rar'):
+            self.ask_about_cbi_in_rar = self.config.getboolean(
+                'dialogflags', 'ask_about_cbi_in_rar')
+        if self.config.has_option('dialogflags', 'show_disclaimer'):
+            self.show_disclaimer = self.config.getboolean(
+                'dialogflags', 'show_disclaimer')
+        if self.config.has_option(
+                'dialogflags', 'dont_notify_about_this_version'):
+            self.dont_notify_about_this_version = self.config.get(
+                'dialogflags', 'dont_notify_about_this_version')
+        if self.config.has_option('dialogflags', 'ask_about_usage_stats'):
+            self.ask_about_usage_stats = self.config.getboolean(
+                'dialogflags', 'ask_about_usage_stats')
+
+        if self.config.has_option('comicvine', 'use_series_start_as_volume'):
+            self.use_series_start_as_volume = self.config.getboolean(
+                'comicvine', 'use_series_start_as_volume')
+        if self.config.has_option(
+                'comicvine', 'clear_form_before_populating_from_cv'):
+            self.clear_form_before_populating_from_cv = self.config.getboolean(
+                'comicvine', 'clear_form_before_populating_from_cv')
+        if self.config.has_option('comicvine', 'remove_html_tables'):
+            self.remove_html_tables = self.config.getboolean(
+                'comicvine', 'remove_html_tables')
+        if self.config.has_option('comicvine', 'cv_api_key'):
+            self.cv_api_key = self.config.get('comicvine', 'cv_api_key')
+
+        if self.config.has_option(
+                'cbl_transform', 'assume_lone_credit_is_primary'):
+            self.assume_lone_credit_is_primary = self.config.getboolean(
+                'cbl_transform', 'assume_lone_credit_is_primary')
+        if self.config.has_option('cbl_transform', 'copy_characters_to_tags'):
+            self.copy_characters_to_tags = self.config.getboolean(
+                'cbl_transform', 'copy_characters_to_tags')
+        if self.config.has_option('cbl_transform', 'copy_teams_to_tags'):
+            self.copy_teams_to_tags = self.config.getboolean(
+                'cbl_transform', 'copy_teams_to_tags')
+        if self.config.has_option('cbl_transform', 'copy_locations_to_tags'):
+            self.copy_locations_to_tags = self.config.getboolean(
+                'cbl_transform', 'copy_locations_to_tags')
+        if self.config.has_option('cbl_transform', 'copy_notes_to_comments'):
+            self.copy_notes_to_comments = self.config.getboolean(
+                'cbl_transform', 'copy_notes_to_comments')
+        if self.config.has_option('cbl_transform', 'copy_storyarcs_to_tags'):
+            self.copy_storyarcs_to_tags = self.config.getboolean(
+                'cbl_transform', 'copy_storyarcs_to_tags')
+        if self.config.has_option('cbl_transform', 'copy_weblink_to_comments'):
+            self.copy_weblink_to_comments = self.config.getboolean(
+                'cbl_transform', 'copy_weblink_to_comments')
+        if self.config.has_option(
+                'cbl_transform', 'apply_cbl_transform_on_cv_import'):
+            self.apply_cbl_transform_on_cv_import = self.config.getboolean(
+                'cbl_transform', 'apply_cbl_transform_on_cv_import')
+        if self.config.has_option(
+                'cbl_transform', 'apply_cbl_transform_on_bulk_operation'):
+            self.apply_cbl_transform_on_bulk_operation = self.config.getboolean(
+                'cbl_transform',
+                'apply_cbl_transform_on_bulk_operation')
+
+        if self.config.has_option('rename', 'rename_template'):
+            self.rename_template = self.config.get('rename', 'rename_template')
+        if self.config.has_option('rename', 'rename_issue_number_padding'):
+            self.rename_issue_number_padding = self.config.getint(
+                'rename', 'rename_issue_number_padding')
+        if self.config.has_option('rename', 'rename_use_smart_string_cleanup'):
+            self.rename_use_smart_string_cleanup = self.config.getboolean(
+                'rename', 'rename_use_smart_string_cleanup')
+        if self.config.has_option(
+                'rename', 'rename_extension_based_on_archive'):
+            self.rename_extension_based_on_archive = self.config.getboolean(
+                'rename', 'rename_extension_based_on_archive')
+        if self.config.has_option('rename', 'rename_dir'):
+            self.rename_dir = self.config.get('rename', 'rename_dir')
+        if self.config.has_option('rename', 'rename_move_dir'):
+            self.rename_move_dir = self.config.getboolean('rename', 'rename_move_dir')
+
+        if self.config.has_option('autotag', 'save_on_low_confidence'):
+            self.save_on_low_confidence = self.config.getboolean(
+                'autotag', 'save_on_low_confidence')
+        if self.config.has_option('autotag', 'dont_use_year_when_identifying'):
+            self.dont_use_year_when_identifying = self.config.getboolean(
+                'autotag', 'dont_use_year_when_identifying')
+        if self.config.has_option('autotag', 'assume_1_if_no_issue_num'):
+            self.assume_1_if_no_issue_num = self.config.getboolean(
+                'autotag', 'assume_1_if_no_issue_num')
+        if self.config.has_option(
+                'autotag', 'ignore_leading_numbers_in_filename'):
+            self.ignore_leading_numbers_in_filename = self.config.getboolean(
+                'autotag', 'ignore_leading_numbers_in_filename')
+        if self.config.has_option(
+                'autotag', 'remove_archive_after_successful_match'):
+            self.remove_archive_after_successful_match = self.config.getboolean(
+                'autotag',
+                'remove_archive_after_successful_match')
+        if self.config.has_option('autotag', 'wait_and_retry_on_rate_limit'):
+            self.wait_and_retry_on_rate_limit = self.config.getboolean(
+                'autotag', 'wait_and_retry_on_rate_limit')
+
+    def save(self):
+
+        if not self.config.has_section('settings'):
+            self.config.add_section('settings')
+
+        self.config.set(
+            'settings', 'check_for_new_version', self.check_for_new_version)
+        self.config.set('settings', 'rar_exe_path', self.rar_exe_path)
+        self.config.set('settings', 'send_usage_stats', self.send_usage_stats)
+
+        if not self.config.has_section('auto'):
+            self.config.add_section('auto')
+
+        self.config.set('auto', 'install_id', self.install_id)
+        self.config.set(
+            'auto',
+            'last_selected_load_data_style',
+            self.last_selected_load_data_style)
+        self.config.set(
+            'auto',
+            'last_selected_save_data_style',
+            self.last_selected_save_data_style)
+        self.config.set('auto', 'last_opened_folder', self.last_opened_folder)
+        self.config.set(
+            'auto', 'last_main_window_width', self.last_main_window_width)
+        self.config.set(
+            'auto', 'last_main_window_height', self.last_main_window_height)
+        self.config.set('auto', 'last_main_window_x', self.last_main_window_x)
+        self.config.set('auto', 'last_main_window_y', self.last_main_window_y)
+        self.config.set(
+            'auto', 'last_form_side_width', self.last_form_side_width)
+        self.config.set(
+            'auto', 'last_list_side_width', self.last_list_side_width)
+        self.config.set(
+            'auto',
+            'last_filelist_sorted_column',
+            self.last_filelist_sorted_column)
+        self.config.set(
+            'auto',
+            'last_filelist_sorted_order',
+            self.last_filelist_sorted_order)
+
+        if not self.config.has_section('identifier'):
+            self.config.add_section('identifier')
+
+        self.config.set(
+            'identifier',
+            'id_length_delta_thresh',
+            self.id_length_delta_thresh)
+        self.config.set(
+            'identifier',
+            'id_publisher_blacklist',
+            self.id_publisher_blacklist)
+
+        if not self.config.has_section('dialogflags'):
+            self.config.add_section('dialogflags')
+
+        self.config.set(
+            'dialogflags', 'ask_about_cbi_in_rar', self.ask_about_cbi_in_rar)
+        self.config.set('dialogflags', 'show_disclaimer', self.show_disclaimer)
+        self.config.set(
+            'dialogflags',
+            'dont_notify_about_this_version',
+            self.dont_notify_about_this_version)
+        self.config.set(
+            'dialogflags', 'ask_about_usage_stats', self.ask_about_usage_stats)
+
+        if not self.config.has_section('filenameparser'):
+            self.config.add_section('filenameparser')
+
+        self.config.set(
+            'filenameparser', 'parse_scan_info', self.parse_scan_info)
+
+        if not self.config.has_section('comicvine'):
+            self.config.add_section('comicvine')
+
+        self.config.set(
+            'comicvine',
+            'use_series_start_as_volume',
+            self.use_series_start_as_volume)
+        self.config.set('comicvine', 'clear_form_before_populating_from_cv',
+                        self.clear_form_before_populating_from_cv)
+        self.config.set(
+            'comicvine', 'remove_html_tables', self.remove_html_tables)
+        self.config.set('comicvine', 'cv_api_key', self.cv_api_key)
+
+        if not self.config.has_section('cbl_transform'):
+            self.config.add_section('cbl_transform')
+
+        self.config.set(
+            'cbl_transform',
+            'assume_lone_credit_is_primary',
+            self.assume_lone_credit_is_primary)
+        self.config.set(
+            'cbl_transform',
+            'copy_characters_to_tags',
+            self.copy_characters_to_tags)
+        self.config.set(
+            'cbl_transform', 'copy_teams_to_tags', self.copy_teams_to_tags)
+        self.config.set(
+            'cbl_transform',
+            'copy_locations_to_tags',
+            self.copy_locations_to_tags)
+        self.config.set(
+            'cbl_transform',
+            'copy_storyarcs_to_tags',
+            self.copy_storyarcs_to_tags)
+        self.config.set(
+            'cbl_transform',
+            'copy_notes_to_comments',
+            self.copy_notes_to_comments)
+        self.config.set(
+            'cbl_transform',
+            'copy_weblink_to_comments',
+            self.copy_weblink_to_comments)
+        self.config.set(
+            'cbl_transform',
+            'apply_cbl_transform_on_cv_import',
+            self.apply_cbl_transform_on_cv_import)
+        self.config.set(
+            'cbl_transform',
+            'apply_cbl_transform_on_bulk_operation',
+            self.apply_cbl_transform_on_bulk_operation)
+
+        if not self.config.has_section('rename'):
+            self.config.add_section('rename')
+
+        self.config.set('rename', 'rename_template', self.rename_template)
+        self.config.set(
+            'rename',
+            'rename_issue_number_padding',
+            self.rename_issue_number_padding)
+        self.config.set(
+            'rename',
+            'rename_use_smart_string_cleanup',
+            self.rename_use_smart_string_cleanup)
+        self.config.set('rename', 'rename_extension_based_on_archive',
+                        self.rename_extension_based_on_archive)
+        self.config.set('rename', 'rename_dir', self.rename_dir)
+        self.config.set('rename', 'rename_move_dir', self.rename_move_dir)
+
+        if not self.config.has_section('autotag'):
+            self.config.add_section('autotag')
+        self.config.set(
+            'autotag', 'save_on_low_confidence', self.save_on_low_confidence)
+        self.config.set(
+            'autotag',
+            'dont_use_year_when_identifying',
+            self.dont_use_year_when_identifying)
+        self.config.set(
+            'autotag',
+            'assume_1_if_no_issue_num',
+            self.assume_1_if_no_issue_num)
+        self.config.set('autotag', 'ignore_leading_numbers_in_filename',
+                        self.ignore_leading_numbers_in_filename)
+        self.config.set('autotag', 'remove_archive_after_successful_match',
+                        self.remove_archive_after_successful_match)
+        self.config.set(
+            'autotag',
+            'wait_and_retry_on_rate_limit',
+            self.wait_and_retry_on_rate_limit)
+
+        with codecs.open(self.settings_file, 'wb', 'utf8') as configfile:
+            self.config.write(configfile)
+
+# make sure the basedir is cached, in case we're on Windows running a
+# script from frozen binary
 ComicTaggerSettings.baseDir()

comictaggerlib/settingswindow.py

@@ -1,239 +1,366 @@
-"""
-A PyQT4 dialog to enter app settings
-"""
+"""A PyQT4 dialog to enter app settings"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 platform
 import os
-from PyQt4 import QtCore, QtGui, uic
+import sys
+
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+
+from .settings import ComicTaggerSettings
+from .comicvinecacher import ComicVineCacher
+from .comicvinetalker import ComicVineTalker
+from .imagefetcher import ImageFetcher
+from .filerenamer import FileRenamer
+from .genericmetadata import GenericMetadata
+from . import utils
 
-from settings import ComicTaggerSettings
-from comicvinecacher import ComicVineCacher
-from imagefetcher import ImageFetcher
-import utils
 
 windowsRarHelp = """
-                 <html><head/><body><p>In order to write to CBR/RAR archives, 
-                 you will need to have the tools from 
-                 <a href="http://www.win-rar.com/download.html">
-                 <span style=" text-decoration: underline; color:#0000ff;">WinRAR</span>
-                 </a> installed. </p></body></html>
+                 <html><head/><body><p>To write to CBR/RAR archives,
+                 you will need to have the tools from
+                 <span style=" text-decoration: underline; color:#0000ff;">
+                 <a href="http://www.win-rar.com/download.html">WINRar</a></span>
+                 installed. (ComicTagger only uses the command-line rar tool,
+                 which is free to use.)</p></body></html>
                 """
-                
+
 linuxRarHelp = """
-               <html><head/><body><p>In order to read/write to CBR/RAR archives, you will
-               need to have the shareware tools from WinRar installed.  Your package manager
-               should have unrar, and probably rar.  If not, download them <a href="http://www.win-rar.com/download.html">
-               <span style=" text-decoration: underline; color:#0000ff;">here</span></a>, and install in your path.</p>
-               </body></html>                
+               <html><head/><body><p>To write to CBR/RAR archives,
+               you will need to have the shareware rar tool from RARLab installed.
+               Your package manager should have rar (e.g. "apt-get install rar"). If not, download it
+               <span style=" text-decoration: underline; color:#0000ff;">
+               <a href="https://www.rarlab.com/download.htm">here</a></span>,
+               and install in your path. </p></body></html>
                """
+               
 macRarHelp = """
-                 <html><head/><body><p>In order to read/write to CBR/RAR archives, 
-                 you will need the shareware tools from <a href="http://www.win-rar.com/download.html">
-                 <span style=" text-decoration: underline; color:#0000ff;">WinRAR</span></a>.  
-                 </p></body></html>
+                 <html><head/><body><p>To write to CBR/RAR archives,
+                 you will need the rar tool.  The easiest way to get this is
+                 to install <span style=" text-decoration: underline; color:#0000ff;">
+                 <a href="https://brew.sh/">homebrew</a></span>.
+                 </p>Once homebrew is installed, run: <b>brew install caskroom/cask/rar</b></body></html>  
                 """
 
-class SettingsWindow(QtGui.QDialog):
-		
-	def __init__(self, parent, settings ):
-		super(SettingsWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('settingswindow.ui' ), self)
+class SettingsWindow(QtWidgets.QDialog):
 
-		self.setWindowFlags(self.windowFlags() &
-									  ~QtCore.Qt.WindowContextHelpButtonHint )
+    def __init__(self, parent, settings):
+        super(SettingsWindow, self).__init__(parent)
 
-		self.settings = settings		
-		self.name = "Settings"
-				
-		if platform.system() == "Windows":
-			self.lblUnrar.hide()
-			self.leUnrarExePath.hide()
-			self.btnBrowseUnrar.hide()			
-			self.lblRarHelp.setText( windowsRarHelp )
-			
-		elif platform.system() == "Linux":
-			self.lblRarHelp.setText( linuxRarHelp )
-			
-		elif platform.system() == "Darwin":
-			self.lblRarHelp.setText( macRarHelp )
-			self.name = "Preferences"
-			
-		self.setWindowTitle("ComicTagger " + self.name)
-		self.lblDefaultSettings.setText( "Revert to default " + self.name.lower())
-		self.btnResetSettings.setText( "Default " + self.name)
-			
-			
-		nldtTip = (
-			""" <html>The <b>Default 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.leNameLengthDeltaThresh.setToolTip(nldtTip)
-			
-		pblTip = (
-			"""<html>
-			The <b>Publisher Blacklist</b> is for eliminating automatic matches to certain publishers
-			that you know are incorrect. Useful for avoiding international re-prints with same
-			covers or series names. Enter publisher names separated by commas.
-			</html>"""
-		)
-		self.tePublisherBlacklist.setToolTip(pblTip)
+        uic.loadUi(ComicTaggerSettings.getUIFile('settingswindow.ui'), self)
 
-		validator = QtGui.QIntValidator(1, 4, self)
-		self.leIssueNumPadding.setValidator(validator)
+        self.setWindowFlags(self.windowFlags() &
+                            ~QtCore.Qt.WindowContextHelpButtonHint)
 
-		validator = QtGui.QIntValidator(0, 99, self)
-		self.leNameLengthDeltaThresh.setValidator(validator)
+        self.settings = settings
+        self.name = "Settings"        
+            
+        if platform.system() == "Windows":
+            self.lblRarHelp.setText(windowsRarHelp)
 
-		self.settingsToForm()
-		
-		self.btnBrowseRar.clicked.connect(self.selectRar)
-		self.btnBrowseUnrar.clicked.connect(self.selectUnrar)		
-		self.btnClearCache.clicked.connect(self.clearCache)
-		self.btnResetSettings.clicked.connect(self.resetSettings)
+        elif platform.system() == "Linux":
+            self.lblRarHelp.setText(linuxRarHelp)
 
-	def settingsToForm( self ):
-			
-		# Copy values from settings to form
-		self.leRarExePath.setText( self.settings.rar_exe_path )
-		self.leUnrarExePath.setText( self.settings.unrar_exe_path )
-		self.leNameLengthDeltaThresh.setText( str(self.settings.id_length_delta_thresh) )
-		self.tePublisherBlacklist.setPlainText( self.settings.id_publisher_blacklist )
+        elif platform.system() == "Darwin":
+            self.leRarExePath.setReadOnly(False)
+                     
+            self.lblRarHelp.setText(macRarHelp)
+            self.name = "Preferences"
 
-		if self.settings.check_for_new_version:
-			self.cbxCheckForNewVersion.setCheckState( QtCore.Qt.Checked)
-		
-		if self.settings.parse_scan_info:
-			self.cbxParseScanInfo.setCheckState( QtCore.Qt.Checked)
-			
-		if self.settings.use_series_start_as_volume:
-			self.cbxUseSeriesStartAsVolume.setCheckState( QtCore.Qt.Checked)
-	
-		if self.settings.assume_lone_credit_is_primary:
-			self.cbxAssumeLoneCreditIsPrimary.setCheckState( QtCore.Qt.Checked)
-		if self.settings.copy_characters_to_tags:
-			self.cbxCopyCharactersToTags.setCheckState( QtCore.Qt.Checked)
-		if self.settings.copy_teams_to_tags:
-			self.cbxCopyTeamsToTags.setCheckState( QtCore.Qt.Checked)
-		if self.settings.copy_locations_to_tags:
-			self.cbxCopyLocationsToTags.setCheckState( QtCore.Qt.Checked)
-		if self.settings.copy_notes_to_comments:
-			self.cbxCopyNotesToComments.setCheckState( QtCore.Qt.Checked)
-		if self.settings.copy_weblink_to_comments:
-			self.cbxCopyWebLinkToComments.setCheckState( QtCore.Qt.Checked)
-		if self.settings.apply_cbl_transform_on_cv_import:
-			self.cbxApplyCBLTransformOnCVIMport.setCheckState( QtCore.Qt.Checked)
-		if self.settings.apply_cbl_transform_on_bulk_operation:
-			self.cbxApplyCBLTransformOnBatchOperation.setCheckState( QtCore.Qt.Checked)
+        self.setWindowTitle("ComicTagger " + self.name)
+        self.lblDefaultSettings.setText(
+            "Revert to default " + self.name.lower())
+        self.btnResetSettings.setText("Default " + self.name)
 
-		self.leRenameTemplate.setText( self.settings.rename_template )
-		self.leIssueNumPadding.setText( str(self.settings.rename_issue_number_padding) )
-		if self.settings.rename_use_smart_string_cleanup:
-			self.cbxSmartCleanup.setCheckState( QtCore.Qt.Checked )
-		if self.settings.rename_extension_based_on_archive:
-			self.cbxChangeExtension.setCheckState( QtCore.Qt.Checked )
+        nldtTip = (
+            """<html>The <b>Default 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.leNameLengthDeltaThresh.setToolTip(nldtTip)
+
+        pblTip = (
+            """<html>
+            The <b>Publisher Blacklist</b> is for eliminating automatic matches to certain publishers
+            that you know are incorrect. Useful for avoiding international re-prints with same
+            covers or series names. Enter publisher names separated by commas.
+            </html>"""
+        )
+        self.tePublisherBlacklist.setToolTip(pblTip)
+
+        validator = QtGui.QIntValidator(1, 4, self)
+        self.leIssueNumPadding.setValidator(validator)
+
+        validator = QtGui.QIntValidator(0, 99, self)
+        self.leNameLengthDeltaThresh.setValidator(validator)
+
+        self.settingsToForm()
+
+        self.btnBrowseRar.clicked.connect(self.selectRar)
+        self.btnClearCache.clicked.connect(self.clearCache)
+        self.btnResetSettings.clicked.connect(self.resetSettings)
+        self.btnTestKey.clicked.connect(self.testAPIKey)
+        self.btnTemplateHelp.clicked.connect(self.showTemplateHelp)
+
+    def configRenamer(self):
+        md = GenericMetadata()
+        md.isEmpty = False
+        md.tagOrigin = "testing"
+
+        md.series = "series name"
+        md.issue = "1"
+        md.title = "issue title"
+        md.publisher = "publisher"
+        md.year = 1998
+        md.month = 4
+        md.day = 4
+        md.issueCount = 1
+        md.volume = 256
+        md.genre = "test"
+        md.language = "en"  # 2 letter iso code
+        md.comments = "This is definitly a comic."  # use same way as Summary in CIX
+
+        md.volumeCount = 4096
+        md.criticalRating = "Worst Comic Ever"
+        md.country = "US"
+
+        md.alternateSeries = "None"
+        md.alternateNumber = 4.4
+        md.alternateCount = 4444
+        md.imprint = 'imprint'
+        md.notes = "This doesn't actually exist"
+        md.webLink = "https://example.com/series name/1"
+        md.format = "Box Set"
+        md.manga = "Yes"
+        md.blackAndWhite = False
+        md.pageCount = 4
+        md.maturityRating = "Everyone"
+
+        md.storyArc = "story"
+        md.seriesGroup = "seriesGroup"
+        md.scanInfo = "(lordwelch)"
+
+        md.characters = "character 1, character 2"
+        md.teams = "None"
+        md.locations = "Earth, 444 B.C."
+
+        md.credits = [dict({'role': 'Everything', 'person': 'author', 'primary': True})]
+        md.tags = ["testing", "not real"]
+        md.pages = [dict({'Image': '0', 'Type': 'Front Cover'}), dict({'Image': '1', 'Type': 'Story'})]
+
+        # Some CoMet-only items
+        md.price = 0.00
+        md.isVersionOf = "SERIES #1"
+        md.rights = "None"
+        md.identifier = "LW4444-Comic"
+        md.lastMark = "0"
+        md.coverImage = "https://example.com/series name/1/cover"
+
+        self.renamer = FileRenamer(md)
+        self.renamer.setTemplate(str(self.leRenameTemplate.text()))
+        self.renamer.setIssueZeroPadding(self.settings.rename_issue_number_padding)
+        self.renamer.setSmartCleanup(self.settings.rename_use_smart_string_cleanup)
+
+    def settingsToForm(self):
+
+        # Copy values from settings to form
+        self.leRarExePath.setText(self.settings.rar_exe_path)
+        self.leNameLengthDeltaThresh.setText(
+            str(self.settings.id_length_delta_thresh))
+        self.tePublisherBlacklist.setPlainText(
+            self.settings.id_publisher_blacklist)
+
+        if self.settings.check_for_new_version:
+            self.cbxCheckForNewVersion.setCheckState(QtCore.Qt.Checked)
+
+        if self.settings.parse_scan_info:
+            self.cbxParseScanInfo.setCheckState(QtCore.Qt.Checked)
+
+        if self.settings.use_series_start_as_volume:
+            self.cbxUseSeriesStartAsVolume.setCheckState(QtCore.Qt.Checked)
+        if self.settings.clear_form_before_populating_from_cv:
+            self.cbxClearFormBeforePopulating.setCheckState(QtCore.Qt.Checked)
+        if self.settings.remove_html_tables:
+            self.cbxRemoveHtmlTables.setCheckState(QtCore.Qt.Checked)
+        self.leKey.setText(str(self.settings.cv_api_key))
+
+        if self.settings.assume_lone_credit_is_primary:
+            self.cbxAssumeLoneCreditIsPrimary.setCheckState(QtCore.Qt.Checked)
+        if self.settings.copy_characters_to_tags:
+            self.cbxCopyCharactersToTags.setCheckState(QtCore.Qt.Checked)
+        if self.settings.copy_teams_to_tags:
+            self.cbxCopyTeamsToTags.setCheckState(QtCore.Qt.Checked)
+        if self.settings.copy_locations_to_tags:
+            self.cbxCopyLocationsToTags.setCheckState(QtCore.Qt.Checked)
+        if self.settings.copy_storyarcs_to_tags:
+            self.cbxCopyStoryArcsToTags.setCheckState(QtCore.Qt.Checked)
+        if self.settings.copy_notes_to_comments:
+            self.cbxCopyNotesToComments.setCheckState(QtCore.Qt.Checked)
+        if self.settings.copy_weblink_to_comments:
+            self.cbxCopyWebLinkToComments.setCheckState(QtCore.Qt.Checked)
+        if self.settings.apply_cbl_transform_on_cv_import:
+            self.cbxApplyCBLTransformOnCVIMport.setCheckState(
+                QtCore.Qt.Checked)
+        if self.settings.apply_cbl_transform_on_bulk_operation:
+            self.cbxApplyCBLTransformOnBatchOperation.setCheckState(
+                QtCore.Qt.Checked)
+
+        self.leRenameTemplate.setText(self.settings.rename_template)
+        self.leIssueNumPadding.setText(
+            str(self.settings.rename_issue_number_padding))
+        if self.settings.rename_use_smart_string_cleanup:
+            self.cbxSmartCleanup.setCheckState(QtCore.Qt.Checked)
+        if self.settings.rename_extension_based_on_archive:
+            self.cbxChangeExtension.setCheckState(QtCore.Qt.Checked)
+        if self.settings.rename_move_dir:
+            self.cbxMoveFiles.setCheckState(QtCore.Qt.Checked)
+        self.leDirectory.setText(self.settings.rename_dir)
+
+    def accept(self):
+
+        self.configRenamer()
 
 
-	def accept( self ):
-		
-		# Copy values from form to settings and save
-		self.settings.rar_exe_path = str(self.leRarExePath.text())
-		self.settings.unrar_exe_path = str(self.leUnrarExePath.text())
-		
-		# make sure unrar/rar program is now in the path for the UnRAR class
-		utils.addtopath(os.path.dirname(self.settings.unrar_exe_path))
-		utils.addtopath(os.path.dirname(self.settings.rar_exe_path))
-		
-		if not str(self.leNameLengthDeltaThresh.text()).isdigit():
-			self.leNameLengthDeltaThresh.setText("0")
+        try:
+            new_name = self.renamer.determineName('test.cbz')
+        except Exception as e:
+            QtWidgets.QMessageBox.critical(self, 'Invalid format string!',
+                'Your rename template is invalid!'
+                '<br/><br/>{}<br/><br/>'
+                'Please consult the template help in the '
+                'settings and the documentation on the format at '
+                '<a href=\'https://docs.python.org/3/library/string.html#format-string-syntax\'>'
+                'https://docs.python.org/3/library/string.html#format-string-syntax</a>'.format(e))
+            return
 
-		if not str(self.leIssueNumPadding.text()).isdigit():
-			self.leIssueNumPadding.setText("0")
+        # Copy values from form to settings and save
+        self.settings.rar_exe_path = str(self.leRarExePath.text())
+        
+        # make sure rar program is now in the path for the rar class
+        if self.settings.rar_exe_path:
+            utils.addtopath(os.path.dirname(self.settings.rar_exe_path))
+            
+        if not str(self.leNameLengthDeltaThresh.text()).isdigit():
+            self.leNameLengthDeltaThresh.setText("0")
 
-		self.settings.check_for_new_version = self.cbxCheckForNewVersion.isChecked()
-		
-		self.settings.id_length_delta_thresh = int(self.leNameLengthDeltaThresh.text())
-		self.settings.id_publisher_blacklist = str(self.tePublisherBlacklist.toPlainText())
-			
-		self.settings.parse_scan_info = self.cbxParseScanInfo.isChecked()
+        if not str(self.leIssueNumPadding.text()).isdigit():
+            self.leIssueNumPadding.setText("0")
 
-		self.settings.use_series_start_as_volume = self.cbxUseSeriesStartAsVolume.isChecked()
-				
-		self.settings.assume_lone_credit_is_primary = self.cbxAssumeLoneCreditIsPrimary.isChecked()
-		self.settings.copy_characters_to_tags = self.cbxCopyCharactersToTags.isChecked()
-		self.settings.copy_teams_to_tags = self.cbxCopyTeamsToTags.isChecked()
-		self.settings.copy_locations_to_tags = self.cbxCopyLocationsToTags.isChecked()
-		self.settings.copy_notes_to_comments = self.cbxCopyNotesToComments.isChecked()
-		self.settings.copy_weblink_to_comments = self.cbxCopyWebLinkToComments.isChecked()
-		self.settings.apply_cbl_transform_on_cv_import = self.cbxApplyCBLTransformOnCVIMport.isChecked()
-		self.settings.apply_cbl_transform_on_bulk_operation = self.cbxApplyCBLTransformOnBatchOperation.isChecked()
-	
-		self.settings.rename_template = str(self.leRenameTemplate.text())
-		self.settings.rename_issue_number_padding = int(self.leIssueNumPadding.text())
-		self.settings.rename_use_smart_string_cleanup = self.cbxSmartCleanup.isChecked()
-		self.settings.rename_extension_based_on_archive = self.cbxChangeExtension.isChecked()
-		
-		self.settings.save()
-		QtGui.QDialog.accept(self)
-	
-	def selectRar( self ):
-		self.selectFile(  self.leRarExePath, "RAR" )
-	
-	def selectUnrar( self ):
-		self.selectFile( self.leUnrarExePath, "UnRAR" )
+        self.settings.check_for_new_version = self.cbxCheckForNewVersion.isChecked()
 
-	def clearCache( self ):
-		ImageFetcher().clearCache()
-		ComicVineCacher( ).clearCache()	
-		QtGui.QMessageBox.information(self, self.name, "Cache has been cleared.")
+        self.settings.id_length_delta_thresh = int(
+            self.leNameLengthDeltaThresh.text())
+        self.settings.id_publisher_blacklist = str(
+            self.tePublisherBlacklist.toPlainText())
+
+        self.settings.parse_scan_info = self.cbxParseScanInfo.isChecked()
+
+        self.settings.use_series_start_as_volume = self.cbxUseSeriesStartAsVolume.isChecked()
+        self.settings.clear_form_before_populating_from_cv = self.cbxClearFormBeforePopulating.isChecked()
+        self.settings.remove_html_tables = self.cbxRemoveHtmlTables.isChecked()
+        self.settings.cv_api_key = str(self.leKey.text())
+        ComicVineTalker.api_key = self.settings.cv_api_key.strip()
+        self.settings.assume_lone_credit_is_primary = self.cbxAssumeLoneCreditIsPrimary.isChecked()
+        self.settings.copy_characters_to_tags = self.cbxCopyCharactersToTags.isChecked()
+        self.settings.copy_teams_to_tags = self.cbxCopyTeamsToTags.isChecked()
+        self.settings.copy_locations_to_tags = self.cbxCopyLocationsToTags.isChecked()
+        self.settings.copy_storyarcs_to_tags = self.cbxCopyStoryArcsToTags.isChecked()
+        self.settings.copy_notes_to_comments = self.cbxCopyNotesToComments.isChecked()
+        self.settings.copy_weblink_to_comments = self.cbxCopyWebLinkToComments.isChecked()
+        self.settings.apply_cbl_transform_on_cv_import = self.cbxApplyCBLTransformOnCVIMport.isChecked()
+        self.settings.apply_cbl_transform_on_bulk_operation = self.cbxApplyCBLTransformOnBatchOperation.isChecked()
+
+        self.settings.rename_template = str(self.leRenameTemplate.text())
+        self.settings.rename_issue_number_padding = int(
+            self.leIssueNumPadding.text())
+        self.settings.rename_use_smart_string_cleanup = self.cbxSmartCleanup.isChecked()
+        self.settings.rename_extension_based_on_archive = self.cbxChangeExtension.isChecked()
+        self.settings.rename_move_dir = self.cbxMoveFiles.isChecked()
+        self.settings.rename_dir = self.leDirectory.text()
+
+        self.settings.save()
+        QtWidgets.QDialog.accept(self)
+            
+    def selectRar(self):
+        self.selectFile(self.leRarExePath, "RAR")
+
+    def clearCache(self):
+        ImageFetcher().clearCache()
+        ComicVineCacher().clearCache()
+        QtWidgets.QMessageBox.information(
+            self, self.name, "Cache has been cleared.")
+
+    def testAPIKey(self):
+        if ComicVineTalker().testKey(str(self.leKey.text()).strip()):
+            QtWidgets.QMessageBox.information(
+                self, "API Key Test", "Key is valid!")
+        else:
+            QtWidgets.QMessageBox.warning(
+                self, "API Key Test", "Key is NOT valid.")
+
+    def resetSettings(self):
+        self.settings.reset()
+        self.settingsToForm()
+        QtWidgets.QMessageBox.information(
+            self,
+            self.name,
+            self.name +
+            " have been returned to default values.")
+
+    def selectFile(self, control, name):
+
+        dialog = QtWidgets.QFileDialog(self)
+        dialog.setFileMode(QtWidgets.QFileDialog.ExistingFile)
+
+        if platform.system() == "Windows":
+            if name == "RAR":
+                filter = self.tr("Rar Program (Rar.exe)")
+            else:
+                filter = self.tr("Libraries (*.dll)")
+            dialog.setNameFilter(filter)
+        else:
+            # QtCore.QDir.Executable | QtCore.QDir.Files)
+            dialog.setFilter(QtCore.QDir.Files)
+            pass
+
+        dialog.setDirectory(os.path.dirname(str(control.text())))
+        if name == "RAR":
+            dialog.setWindowTitle("Find " + name + " program")
+        else:
+             dialog.setWindowTitle("Find " + name + " library")
+             
+        if (dialog.exec_()):
+            fileList = dialog.selectedFiles()
+            control.setText(str(fileList[0]))
+
+    def showRenameTab(self):
+        self.tabWidget.setCurrentIndex(5)
+
+    def showTemplateHelp(self):
+        TemplateHelpWin = TemplateHelpWindow(self)
+        TemplateHelpWin.setModal(False)
+        TemplateHelpWin.show()
+
+class TemplateHelpWindow(QtWidgets.QDialog):
+
+    def __init__(self, parent):
+        super(TemplateHelpWindow, self).__init__(parent)
+
+        uic.loadUi(ComicTaggerSettings.getUIFile('TemplateHelp.ui'), self)
 
-	
-	def resetSettings( self ):
-		self.settings.reset()
-		self.settingsToForm()
-		QtGui.QMessageBox.information(self, self.name, self.name + " have been returned to default values.")
-	
-	def selectFile( self, control, name ):
-		
-		dialog = QtGui.QFileDialog(self)
-		dialog.setFileMode(QtGui.QFileDialog.ExistingFile)
-		
-		if platform.system() == "Windows":
-			if name == "RAR":
-				filter  = self.tr("Rar Program (Rar.exe)")						
-			else:
-				filter  = self.tr("Programs (*.exe)")	
-			dialog.setNameFilter(filter)		
-		else:
-			dialog.setFilter(QtCore.QDir.Files) #QtCore.QDir.Executable | QtCore.QDir.Files)
-			pass
-			
-		dialog.setDirectory(os.path.dirname(str(control.text())))
-		dialog.setWindowTitle("Find " + name + " program")
-		
-		if (dialog.exec_()):
-			fileList = dialog.selectedFiles()
-			control.setText( str(fileList[0]) )
 
-	def showRenameTab( self ):
-		self.tabWidget.setCurrentIndex(5)	
-		

comictaggerlib/ui/TemplateHelp.ui

@@ -0,0 +1,107 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>Dialog</class>
+ <widget class="QDialog" name="Dialog">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>702</width>
+    <height>452</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Template Help</string>
+  </property>
+  <property name="sizeGripEnabled">
+   <bool>true</bool>
+  </property>
+  <layout class="QVBoxLayout" name="verticalLayout">
+   <property name="spacing">
+    <number>0</number>
+   </property>
+   <property name="leftMargin">
+    <number>2</number>
+   </property>
+   <property name="topMargin">
+    <number>2</number>
+   </property>
+   <item>
+    <widget class="QTextBrowser" name="textBrowser">
+     <property name="html">
+      <string>&lt;html&gt;
+	&lt;head/&gt;
+	&lt;body&gt;
+		&lt;h1 style=&quot;text-align: center&quot;&gt;Template help&lt;/h1&gt;
+		&lt;p&gt;The template uses Python format strings, in the simplest use it replaces the field (e.g. {issue}) with the value for that particular comic (e.g. 1) for advanced formatting please reference the
+
+			&lt;a href=&quot;https://docs.python.org/3/library/string.html#format-string-syntax&quot;&gt;Python 3 documentation&lt;/a&gt;&lt;/p&gt;
+		&lt;pre&gt;Accepts the following variables:
+{isEmpty}&#009;&#009;(boolean)
+{tagOrigin}&#009;&#009;(string)
+{series}&#009;&#009;(string)
+{issue}&#009;&#009;(string)
+{title}&#009;&#009;(string)
+{publisher}&#009;&#009;(string)
+{month}&#009;&#009;(integer)
+{year}&#009;&#009;(integer)
+{day}&#009;&#009;(integer)
+{issueCount}&#009;(integer)
+{volume}&#009;&#009;(integer)
+{genre}&#009;&#009;(string)
+{language}&#009;&#009;(string)
+{comments}&#009;&#009;(string)
+{volumeCount}&#009;(integer)
+{criticalRating}&#009;(string)
+{country}&#009;&#009;(string)
+{alternateSeries}&#009;(string)
+{alternateNumber}&#009;(string)
+{alternateCount}&#009;(integer)
+{imprint}&#009;&#009;(string)
+{notes}&#009;&#009;(string)
+{webLink}&#009;&#009;(string)
+{format}&#009;&#009;(string)
+{manga}&#009;&#009;(string)
+{blackAndWhite}&#009;(boolean)
+{pageCount}&#009;&#009;(integer)
+{maturityRating}&#009;(string)
+{storyArc}&#009;&#009;(string)
+{seriesGroup}&#009;(string)
+{scanInfo}&#009;&#009;(string)
+{characters}&#009;(string)
+{teams}&#009;&#009;(string)
+{locations}&#009;&#009;(string)
+{credits}&#009;&#009;(list of dict({&apos;role&apos;: &apos;str&apos;, &apos;person&apos;: &apos;str&apos;, &apos;primary&apos;: boolean}))
+{tags}&#009;&#009;(list of str)
+{pages}&#009;&#009;(list of dict({&apos;Image&apos;: &apos;str(int)&apos;, &apos;Type&apos;: &apos;str&apos;}))
+
+CoMet-only items:
+{price}&#009;&#009;(float)
+{isVersionOf}&#009;(string)
+{rights}&#009;&#009;(string)
+{identifier}&#009;(string)
+{lastMark}&#009;(string)
+{coverImage}&#009;(string)
+
+Examples:
+
+{series} {issue} ({year})
+Spider-Geddon 1 (2018)
+
+{series} #{issue} - {title}
+Spider-Geddon #1 - New Players; Check In
+
+&lt;/pre&gt;
+	&lt;/body&gt;
+&lt;/html&gt;</string>
+     </property>
+     <property name="openExternalLinks">
+      <bool>true</bool>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

comictaggerlib/ui/autotagstartwindow.ui

@@ -9,8 +9,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>607</width>
-    <height>319</height>
+    <width>519</width>
+    <height>378</height>
    </rect>
   </property>
   <property name="sizePolicy">
@@ -25,183 +25,180 @@
   <property name="modal">
    <bool>false</bool>
   </property>
-  <layout class="QGridLayout" name="gridLayout_3">
+  <layout class="QGridLayout" name="gridLayout_2">
    <item row="0" column="0">
-    <layout class="QVBoxLayout" name="verticalLayout">
-     <item>
-      <widget class="QLabel" name="label">
+    <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 row="1" column="0">
+    <layout class="QGridLayout" name="gridLayout">
+     <item row="6" column="0">
+      <widget class="QCheckBox" name="cbxSpecifySearchString">
        <property name="sizePolicy">
-        <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+        <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
          <horstretch>0</horstretch>
          <verstretch>0</verstretch>
         </sizepolicy>
        </property>
        <property name="text">
-        <string/>
-       </property>
-       <property name="wordWrap">
-        <bool>true</bool>
+        <string>Specify series search string for all selected archives:</string>
        </property>
       </widget>
      </item>
-     <item>
-      <layout class="QFormLayout" name="formLayout">
-       <property name="sizeConstraint">
-        <enum>QLayout::SetFixedSize</enum>
+     <item row="0" column="0">
+      <widget class="QCheckBox" name="cbxSaveOnLowConfidence">
+       <property name="sizePolicy">
+        <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
+         <horstretch>0</horstretch>
+         <verstretch>0</verstretch>
+        </sizepolicy>
        </property>
-       <property name="fieldGrowthPolicy">
-        <enum>QFormLayout::AllNonFixedFieldsGrow</enum>
+       <property name="text">
+        <string>Save on low confidence match</string>
        </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>
+      </widget>
      </item>
-     <item>
-      <widget class="QDialogButtonBox" name="buttonBox">
-       <property name="orientation">
-        <enum>Qt::Horizontal</enum>
+     <item row="4" column="0">
+      <widget class="QCheckBox" name="cbxIgnoreLeadingDigitsInFilename">
+       <property name="sizePolicy">
+        <sizepolicy hsizetype="Minimum" vsizetype="Fixed">
+         <horstretch>0</horstretch>
+         <verstretch>0</verstretch>
+        </sizepolicy>
        </property>
-       <property name="standardButtons">
-        <set>QDialogButtonBox::Cancel|QDialogButtonBox::Ok</set>
+       <property name="text">
+        <string>Ignore leading (sequence) numbers in filename</string>
+       </property>
+      </widget>
+     </item>
+     <item row="5" column="0">
+      <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="3" column="0">
+      <widget class="QCheckBox" name="cbxWaitForRateLimit">
+       <property name="text">
+        <string>Wait and retry when Comic Vine rate limit is exceeded (experimental)</string>
+       </property>
+      </widget>
+     </item>
+     <item row="1" column="0">
+      <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">
+      <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="10" column="0">
+      <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">
+      <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="0">
+      <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 row="2" 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="4" column="0">
+    <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>
  </widget>
  <resources/>

comictaggerlib/ui/qtutils.py

@@ -0,0 +1,90 @@
+"""Some utilities for the GUI"""
+
+#import StringIO
+
+#from PIL import Image
+
+from comictaggerlib.settings import ComicTaggerSettings
+
+
+try:
+    from PyQt5 import QtGui
+    qt_available = True
+except ImportError:
+    qt_available = False
+
+if qt_available:
+
+    def reduceWidgetFontSize(widget, delta=2):
+        f = widget.font()
+        if f.pointSize() > 10:
+            f.setPointSize(f.pointSize() - delta)
+        widget.setFont(f)
+
+    def centerWindowOnScreen(window):
+        """Center the window on screen.
+
+        This implementation will handle the window
+        being resized or the screen resolution changing.
+        """
+        # Get the current screens' dimensions...
+        screen = QtGui.QDesktopWidget().screenGeometry()
+        # ... and get this windows' dimensions
+        mysize = window.geometry()
+        # The horizontal position is calculated as screen width - window width
+        # / 2
+        hpos = (screen.width() - window.width()) / 2
+        # And vertical position the same, but with the height dimensions
+        vpos = (screen.height() - window.height()) / 2
+        # And the move call repositions the window
+        window.move(hpos, vpos)
+
+    def centerWindowOnParent(window):
+
+        top_level = window
+        while top_level.parent() is not None:
+            top_level = top_level.parent()
+
+        # Get the current screens' dimensions...
+        main_window_size = top_level.geometry()
+        # ... and get this windows' dimensions
+        mysize = window.geometry()
+        # The horizontal position is calculated as screen width - window width
+        # /2
+        hpos = (main_window_size.width() - window.width()) / 2
+        # And vertical position the same, but with the height dimensions
+        vpos = (main_window_size.height() - window.height()) / 2
+        # And the move call repositions the window
+        window.move(
+            hpos +
+            main_window_size.left(),
+            vpos +
+            main_window_size.top())
+
+    try:
+        from PIL import Image
+        from PIL import WebPImagePlugin
+        import io
+        pil_available = True
+    except ImportError:
+        pil_available = False
+
+    def getQImageFromData(image_data):
+        img = QtGui.QImage()
+        success = img.loadFromData(image_data)
+        if not success:
+            try:
+                if pil_available:
+                    #  Qt doesn't understand the format, but maybe PIL does
+                    # so try to convert the image data to uncompressed tiff
+                    # format
+                    im = Image.open(io.StringIO(image_data))
+                    output = io.StringIO()
+                    im.save(output, format="PNG")
+                    success = img.loadFromData(output.getvalue())
+            except Exception as e:
+                pass
+        # if still nothing, go with default image
+        if not success:
+            img.load(ComicTaggerSettings.getGraphic('nocover.png'))
+        return img

comictaggerlib/ui/settingswindow.ui

@@ -6,8 +6,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>674</width>
-    <height>428</height>
+    <width>702</width>
+    <height>432</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -21,6 +21,12 @@
     <layout class="QVBoxLayout" name="verticalLayout">
      <item>
       <widget class="QTabWidget" name="tabWidget">
+       <property name="sizePolicy">
+        <sizepolicy hsizetype="Expanding" vsizetype="Preferred">
+         <horstretch>0</horstretch>
+         <verstretch>0</verstretch>
+        </sizepolicy>
+       </property>
        <property name="currentIndex">
         <number>0</number>
        </property>
@@ -110,118 +116,6 @@
            </property>
           </widget>
          </item>
-         <item>
-          <widget class="QGroupBox" name="grpBoxRar">
-           <layout class="QGridLayout" name="gridLayout">
-            <item row="0" column="0" colspan="3">
-             <widget class="QLabel" name="lblRarHelp">
-              <property name="sizePolicy">
-               <sizepolicy hsizetype="Preferred" vsizetype="Expanding">
-                <horstretch>0</horstretch>
-                <verstretch>0</verstretch>
-               </sizepolicy>
-              </property>
-              <property name="text">
-               <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;In order to read/write to CBR/RAR archives, you will need to have the shareware tools from &lt;a href=&quot;www.win-rar.com/download.html&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;WinRAR&lt;/span&gt;&lt;/a&gt; installed.  &lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
-              </property>
-              <property name="textFormat">
-               <enum>Qt::RichText</enum>
-              </property>
-              <property name="alignment">
-               <set>Qt::AlignBottom|Qt::AlignLeading|Qt::AlignLeft</set>
-              </property>
-              <property name="wordWrap">
-               <bool>true</bool>
-              </property>
-              <property name="openExternalLinks">
-               <bool>true</bool>
-              </property>
-              <property name="textInteractionFlags">
-               <set>Qt::LinksAccessibleByKeyboard|Qt::LinksAccessibleByMouse</set>
-              </property>
-             </widget>
-            </item>
-            <item row="1" column="0">
-             <widget class="QLabel" name="label_7">
-              <property name="sizePolicy">
-               <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
-                <horstretch>0</horstretch>
-                <verstretch>0</verstretch>
-               </sizepolicy>
-              </property>
-              <property name="minimumSize">
-               <size>
-                <width>120</width>
-                <height>0</height>
-               </size>
-              </property>
-              <property name="maximumSize">
-               <size>
-                <width>200</width>
-                <height>16777215</height>
-               </size>
-              </property>
-              <property name="text">
-               <string>RAR program</string>
-              </property>
-             </widget>
-            </item>
-            <item row="1" column="1">
-             <widget class="QLineEdit" name="leRarExePath">
-              <property name="sizePolicy">
-               <sizepolicy hsizetype="Expanding" vsizetype="Maximum">
-                <horstretch>0</horstretch>
-                <verstretch>0</verstretch>
-               </sizepolicy>
-              </property>
-              <property name="readOnly">
-               <bool>true</bool>
-              </property>
-             </widget>
-            </item>
-            <item row="1" column="2">
-             <widget class="QPushButton" name="btnBrowseRar">
-              <property name="sizePolicy">
-               <sizepolicy hsizetype="Minimum" vsizetype="Maximum">
-                <horstretch>0</horstretch>
-                <verstretch>0</verstretch>
-               </sizepolicy>
-              </property>
-              <property name="text">
-               <string>...</string>
-              </property>
-             </widget>
-            </item>
-            <item row="2" column="0">
-             <widget class="QLabel" name="lblUnrar">
-              <property name="minimumSize">
-               <size>
-                <width>120</width>
-                <height>0</height>
-               </size>
-              </property>
-              <property name="text">
-               <string>UnRAR program</string>
-              </property>
-             </widget>
-            </item>
-            <item row="2" column="1">
-             <widget class="QLineEdit" name="leUnrarExePath">
-              <property name="readOnly">
-               <bool>true</bool>
-              </property>
-             </widget>
-            </item>
-            <item row="2" column="2">
-             <widget class="QPushButton" name="btnBrowseUnrar">
-              <property name="text">
-               <string>...</string>
-              </property>
-             </widget>
-            </item>
-           </layout>
-          </widget>
-         </item>
          <item>
           <spacer name="verticalSpacer">
            <property name="orientation">
@@ -336,19 +230,156 @@
         <attribute name="title">
          <string>Comic Vine</string>
         </attribute>
-        <widget class="QCheckBox" name="cbxUseSeriesStartAsVolume">
-         <property name="geometry">
-          <rect>
-           <x>30</x>
-           <y>30</y>
-           <width>240</width>
-           <height>25</height>
-          </rect>
-         </property>
-         <property name="text">
-          <string>Use Series Start Date as Volume</string>
-         </property>
-        </widget>
+        <layout class="QVBoxLayout" name="verticalLayout_4">
+         <item>
+          <widget class="QGroupBox" name="grpBoxCVTop">
+           <property name="sizePolicy">
+            <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+             <horstretch>0</horstretch>
+             <verstretch>0</verstretch>
+            </sizepolicy>
+           </property>
+           <layout class="QVBoxLayout" name="verticalLayout_5">
+            <item>
+             <layout class="QVBoxLayout" name="verticalLayout_3">
+              <item>
+               <widget class="QCheckBox" name="cbxUseSeriesStartAsVolume">
+                <property name="text">
+                 <string>Use Series Start Date as Volume</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="QCheckBox" name="cbxClearFormBeforePopulating">
+                <property name="text">
+                 <string>Clear Form Before Importing Comic Vine data</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="QCheckBox" name="cbxRemoveHtmlTables">
+                <property name="text">
+                 <string>Remove HTML tables from CV summary field</string>
+                </property>
+               </widget>
+              </item>
+             </layout>
+            </item>
+           </layout>
+          </widget>
+         </item>
+         <item>
+          <widget class="Line" name="line_4">
+           <property name="sizePolicy">
+            <sizepolicy hsizetype="Expanding" vsizetype="Fixed">
+             <horstretch>0</horstretch>
+             <verstretch>0</verstretch>
+            </sizepolicy>
+           </property>
+           <property name="orientation">
+            <enum>Qt::Horizontal</enum>
+           </property>
+          </widget>
+         </item>
+         <item>
+          <widget class="QGroupBox" name="grpBoxKey">
+           <property name="sizePolicy">
+            <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+             <horstretch>0</horstretch>
+             <verstretch>0</verstretch>
+            </sizepolicy>
+           </property>
+           <layout class="QGridLayout" name="gridLayout_8">
+            <item row="1" column="1">
+             <widget class="QLineEdit" name="leKey">
+              <property name="sizePolicy">
+               <sizepolicy hsizetype="MinimumExpanding" vsizetype="Maximum">
+                <horstretch>0</horstretch>
+                <verstretch>0</verstretch>
+               </sizepolicy>
+              </property>
+              <property name="readOnly">
+               <bool>false</bool>
+              </property>
+             </widget>
+            </item>
+            <item row="1" column="0">
+             <widget class="QLabel" name="label_8">
+              <property name="sizePolicy">
+               <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+                <horstretch>0</horstretch>
+                <verstretch>0</verstretch>
+               </sizepolicy>
+              </property>
+              <property name="minimumSize">
+               <size>
+                <width>120</width>
+                <height>0</height>
+               </size>
+              </property>
+              <property name="maximumSize">
+               <size>
+                <width>200</width>
+                <height>16777215</height>
+               </size>
+              </property>
+              <property name="text">
+               <string>Comic Vine API Key</string>
+              </property>
+             </widget>
+            </item>
+            <item row="0" column="0" colspan="3">
+             <widget class="QLabel" name="lblKeyHelp">
+              <property name="sizePolicy">
+               <sizepolicy hsizetype="Expanding" vsizetype="MinimumExpanding">
+                <horstretch>0</horstretch>
+                <verstretch>0</verstretch>
+               </sizepolicy>
+              </property>
+              <property name="text">
+               <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;A personal API key from &lt;a href=&quot;http://www.comicvine.com/api/&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;Comic Vine&lt;/span&gt;&lt;/a&gt; is recommended in order to search for tag data. Login (or create a new account) there to get your key, and enter it below.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+              </property>
+              <property name="textFormat">
+               <enum>Qt::RichText</enum>
+              </property>
+              <property name="alignment">
+               <set>Qt::AlignBottom|Qt::AlignLeading|Qt::AlignLeft</set>
+              </property>
+              <property name="wordWrap">
+               <bool>true</bool>
+              </property>
+              <property name="openExternalLinks">
+               <bool>true</bool>
+              </property>
+              <property name="textInteractionFlags">
+               <set>Qt::LinksAccessibleByKeyboard|Qt::LinksAccessibleByMouse</set>
+              </property>
+             </widget>
+            </item>
+            <item row="1" column="2">
+             <widget class="QPushButton" name="btnTestKey">
+              <property name="text">
+               <string>Test Key</string>
+              </property>
+             </widget>
+            </item>
+           </layout>
+          </widget>
+         </item>
+         <item>
+          <spacer name="verticalSpacer_3">
+           <property name="orientation">
+            <enum>Qt::Vertical</enum>
+           </property>
+           <property name="sizeHint" stdset="0">
+            <size>
+             <width>20</width>
+             <height>40</height>
+            </size>
+           </property>
+          </spacer>
+         </item>
+        </layout>
        </widget>
        <widget class="QWidget" name="tab_4">
         <attribute name="title">
@@ -385,11 +416,18 @@
              <rect>
               <x>11</x>
               <y>21</y>
-              <width>246</width>
-              <height>182</height>
+              <width>251</width>
+              <height>199</height>
              </rect>
             </property>
             <layout class="QGridLayout" name="gridLayout_7">
+             <item row="3" column="0">
+              <widget class="QCheckBox" name="cbxCopyLocationsToTags">
+               <property name="text">
+                <string>Copy Locations to Generic Tags</string>
+               </property>
+              </widget>
+             </item>
              <item row="0" column="0">
               <widget class="QCheckBox" name="cbxAssumeLoneCreditIsPrimary">
                <property name="text">
@@ -411,27 +449,27 @@
                </property>
               </widget>
              </item>
-             <item row="3" column="0">
-              <widget class="QCheckBox" name="cbxCopyLocationsToTags">
-               <property name="text">
-                <string>Copy Locations to Generic Tags</string>
-               </property>
-              </widget>
-             </item>
-             <item row="4" column="0">
+             <item row="5" column="0">
               <widget class="QCheckBox" name="cbxCopyNotesToComments">
                <property name="text">
                 <string>Copy Notes to Comments</string>
                </property>
               </widget>
              </item>
-             <item row="5" column="0">
+             <item row="6" column="0">
               <widget class="QCheckBox" name="cbxCopyWebLinkToComments">
                <property name="text">
                 <string>Copy Web Link to Comments</string>
                </property>
               </widget>
              </item>
+             <item row="4" column="0">
+              <widget class="QCheckBox" name="cbxCopyStoryArcsToTags">
+               <property name="text">
+                <string>Copy Story Arcs to Generic Tags</string>
+               </property>
+              </widget>
+             </item>
             </layout>
            </widget>
           </widget>
@@ -465,7 +503,7 @@
             <enum>QFormLayout::AllNonFixedFieldsGrow</enum>
            </property>
            <item row="1" column="0">
-            <widget class="QLabel" name="label">
+            <widget class="QLabel" name="lblTemplate">
              <property name="text">
               <string>Template:</string>
              </property>
@@ -474,31 +512,80 @@
            <item row="1" column="1">
             <widget class="QLineEdit" name="leRenameTemplate">
              <property name="toolTip">
-              <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;The template for the new filename. Accepts the following variables:&lt;/p&gt;&lt;p&gt;%series%&lt;br/&gt;%issue%&lt;br/&gt;%volume%&lt;br/&gt;%issuecount%&lt;br/&gt;%year%&lt;br/&gt;%month%&lt;br/&gt;%month_name%&lt;br/&gt;%publisher%&lt;br/&gt;%title%&lt;br/&gt;
-%genre%&lt;br/&gt;
-%language_code%&lt;br/&gt;
-%criticalrating%&lt;br/&gt;
-%alternateseries%&lt;br/&gt;
-%alternatenumber%&lt;br/&gt;
-%alternatecount%&lt;br/&gt;
-%imprint%&lt;br/&gt;
-%format%&lt;br/&gt;
-%maturityrating%&lt;br/&gt;
-%storyarc%&lt;br/&gt;
-%seriesgroup%&lt;br/&gt;
-%scaninfo%
-&lt;/p&gt;&lt;p&gt;Examples:&lt;/p&gt;&lt;p&gt;&lt;span style=&quot; font-style:italic;&quot;&gt;%series% %issue% (%year%)&lt;/span&gt;&lt;br/&gt;&lt;span style=&quot; font-style:italic;&quot;&gt;%series% #%issue% - %title%&lt;/span&gt;&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+              <string>&lt;pre&gt;The template for the new filename. Uses python format strings https://docs.python.org/3/library/string.html#format-string-syntax
+Accepts the following variables:
+{isEmpty}		(boolean)
+{tagOrigin}		(string)
+{series}		(string)
+{issue}		(string)
+{title}		(string)
+{publisher}		(string)
+{month}		(integer)
+{year}		(integer)
+{day}		(integer)
+{issueCount}	(integer)
+{volume}		(integer)
+{genre}		(string)
+{language}		(string)
+{comments}		(string)
+{volumeCount}	(integer)
+{criticalRating}	(string)
+{country}		(string)
+{alternateSeries}	(string)
+{alternateNumber}	(string)
+{alternateCount}	(integer)
+{imprint}		(string)
+{notes}		(string)
+{webLink}		(string)
+{format}		(string)
+{manga}		(string)
+{blackAndWhite}	(boolean)
+{pageCount}		(integer)
+{maturityRating}	(string)
+{storyArc}		(string)
+{seriesGroup}	(string)
+{scanInfo}		(string)
+{characters}	(string)
+{teams}		(string)
+{locations}		(string)
+{credits}		(list of dict({&amp;apos;role&amp;apos;: &amp;apos;str&amp;apos;, &amp;apos;person&amp;apos;: &amp;apos;str&amp;apos;, &amp;apos;primary&amp;apos;: boolean}))
+{tags}		(list of str)
+{pages}		(list of dict({&amp;apos;Image&amp;apos;: &amp;apos;str(int)&amp;apos;, &amp;apos;Type&amp;apos;: &amp;apos;str&amp;apos;}))
+
+CoMet-only items:
+{price}		(float)
+{isVersionOf}	(string)
+{rights}		(string)
+{identifier}	(string)
+{lastMark}	(string)
+{coverImage}	(string)
+
+Examples:
+
+{series} {issue} ({year})
+Spider-Geddon 1 (2018)
+
+{series} #{issue} - {title}
+Spider-Geddon #1 - New Players; Check In
+&lt;/pre&gt;</string>
              </property>
             </widget>
            </item>
            <item row="2" column="0">
-            <widget class="QLabel" name="label_6">
+            <widget class="QPushButton" name="btnTemplateHelp">
+             <property name="text">
+              <string>Template Help</string>
+             </property>
+            </widget>
+           </item>
+           <item row="3" column="0">
+            <widget class="QLabel" name="lblPadding">
              <property name="text">
               <string>Issue # Zero Padding</string>
              </property>
             </widget>
            </item>
-           <item row="2" column="1">
+           <item row="3" column="1">
             <widget class="QLineEdit" name="leIssueNumPadding">
              <property name="sizePolicy">
               <sizepolicy hsizetype="Maximum" vsizetype="Fixed">
@@ -517,7 +604,7 @@
              </property>
             </widget>
            </item>
-           <item row="3" column="0" colspan="2">
+           <item row="4" column="0" colspan="2">
             <widget class="QCheckBox" name="cbxSmartCleanup">
              <property name="toolTip">
               <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;&lt;span style=&quot; font-weight:600;&quot;&gt;&amp;quot;Smart Text Cleanup&amp;quot; &lt;/span&gt;will attempt to clean up the new filename if there are missing fields from the template.  For example, removing empty braces, repeated spaces and dashes, and more.  Experimental feature.&lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
@@ -527,17 +614,142 @@
              </property>
             </widget>
            </item>
-           <item row="4" column="0" colspan="2">
+           <item row="5" column="0" colspan="2">
             <widget class="QCheckBox" name="cbxChangeExtension">
              <property name="text">
               <string>Change Extension Based On Archive Type</string>
              </property>
             </widget>
            </item>
+           <item row="6" column="0">
+            <widget class="QCheckBox" name="cbxMoveFiles">
+             <property name="toolTip">
+              <string>If checked moves files to specified folder</string>
+             </property>
+             <property name="text">
+              <string>Move files when renaming</string>
+             </property>
+            </widget>
+           </item>
+           <item row="7" column="0">
+            <widget class="QLabel" name="lblDirectory">
+             <property name="text">
+              <string>Destination Directory:</string>
+             </property>
+            </widget>
+           </item>
+           <item row="7" column="1">
+            <widget class="QLineEdit" name="leDirectory"/>
+           </item>
           </layout>
          </item>
         </layout>
        </widget>
+       <widget class="QWidget" name="tab_7">
+        <attribute name="title">
+         <string>RAR Tools</string>
+        </attribute>
+        <layout class="QVBoxLayout" name="verticalLayout_2">
+         <item>
+          <widget class="QGroupBox" name="grpBoxRar">
+           <layout class="QGridLayout" name="gridLayout">
+            <item row="1" column="0">
+             <widget class="QLabel" name="label_7">
+              <property name="sizePolicy">
+               <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+                <horstretch>0</horstretch>
+                <verstretch>0</verstretch>
+               </sizepolicy>
+              </property>
+              <property name="minimumSize">
+               <size>
+                <width>120</width>
+                <height>0</height>
+               </size>
+              </property>
+              <property name="maximumSize">
+               <size>
+                <width>200</width>
+                <height>16777215</height>
+               </size>
+              </property>
+              <property name="text">
+               <string>RAR program</string>
+              </property>
+             </widget>
+            </item>
+            <item row="1" column="1">
+             <widget class="QLineEdit" name="leRarExePath">
+              <property name="sizePolicy">
+               <sizepolicy hsizetype="Expanding" vsizetype="Maximum">
+                <horstretch>0</horstretch>
+                <verstretch>0</verstretch>
+               </sizepolicy>
+              </property>
+              <property name="readOnly">
+               <bool>true</bool>
+              </property>
+             </widget>
+            </item>
+            <item row="1" column="2">
+             <widget class="QPushButton" name="btnBrowseRar">
+              <property name="sizePolicy">
+               <sizepolicy hsizetype="Minimum" vsizetype="Maximum">
+                <horstretch>0</horstretch>
+                <verstretch>0</verstretch>
+               </sizepolicy>
+              </property>
+              <property name="text">
+               <string>...</string>
+              </property>
+             </widget>
+            </item>
+            <item row="0" column="0" colspan="3">
+             <widget class="QLabel" name="lblRarHelp">
+              <property name="sizePolicy">
+               <sizepolicy hsizetype="Preferred" vsizetype="Minimum">
+                <horstretch>0</horstretch>
+                <verstretch>0</verstretch>
+               </sizepolicy>
+              </property>
+              <property name="text">
+               <string>&lt;html&gt;&lt;head/&gt;&lt;body&gt;&lt;p&gt;In order to write to CBR/RAR archives, you will need to have the shareware tools from &lt;a href=&quot;www.win-rar.com/download.html&quot;&gt;&lt;span style=&quot; text-decoration: underline; color:#0000ff;&quot;&gt;WinRAR&lt;/span&gt;&lt;/a&gt; installed. &lt;/p&gt;&lt;/body&gt;&lt;/html&gt;</string>
+              </property>
+              <property name="textFormat">
+               <enum>Qt::RichText</enum>
+              </property>
+              <property name="alignment">
+               <set>Qt::AlignBottom|Qt::AlignLeading|Qt::AlignLeft</set>
+              </property>
+              <property name="wordWrap">
+               <bool>true</bool>
+              </property>
+              <property name="openExternalLinks">
+               <bool>true</bool>
+              </property>
+              <property name="textInteractionFlags">
+               <set>Qt::LinksAccessibleByKeyboard|Qt::LinksAccessibleByMouse</set>
+              </property>
+             </widget>
+            </item>
+           </layout>
+          </widget>
+         </item>
+         <item>
+          <spacer name="verticalSpacer">
+           <property name="orientation">
+            <enum>Qt::Vertical</enum>
+           </property>
+           <property name="sizeHint" stdset="0">
+            <size>
+             <width>20</width>
+             <height>40</height>
+            </size>
+           </property>
+          </spacer>
+         </item>
+        </layout>
+       </widget>
       </widget>
      </item>
      <item>

comictaggerlib/ui/taggerwindow.ui

@@ -402,14 +402,26 @@
                        </widget>
                       </item>
                       <item row="3" column="0">
-                       <widget class="QLabel" name="label_5">
+                       <widget class="QLabel" name="lblDay">
                         <property name="text">
-                         <string># Issues</string>
+                         <string>Day</string>
                         </property>
                        </widget>
                       </item>
                       <item row="3" column="1">
-                       <widget class="QLineEdit" name="leIssueCount">
+                       <widget class="QLineEdit" name="lePubDay">
+                        <property name="sizePolicy">
+                         <sizepolicy hsizetype="Expanding" vsizetype="Fixed">
+                          <horstretch>0</horstretch>
+                          <verstretch>0</verstretch>
+                         </sizepolicy>
+                        </property>
+                        <property name="maximumSize">
+                         <size>
+                          <width>16777215</width>
+                          <height>16777215</height>
+                         </size>
+                        </property>
                         <property name="acceptDrops">
                          <bool>false</bool>
                         </property>
@@ -419,27 +431,44 @@
                        </widget>
                       </item>
                       <item row="4" column="0">
+                       <widget class="QLabel" name="label_5">
+                        <property name="text">
+                         <string># Issues</string>
+                        </property>
+                       </widget>
+                      </item>
+                      <item row="4" column="1">
+                       <widget class="QLineEdit" name="leIssueCount">
+                        <property name="acceptDrops">
+                         <bool>false</bool>
+                        </property>
+                        <property name="inputMethodHints">
+                         <set>Qt::ImhDigitsOnly</set>
+                        </property>
+                       </widget>
+                      </item>
+                      <item row="5" column="0">
                        <widget class="QLabel" name="label_9">
                         <property name="text">
                          <string>Volume</string>
                         </property>
                        </widget>
                       </item>
-                      <item row="4" column="1">
+                      <item row="5" column="1">
                        <widget class="QLineEdit" name="leVolumeNum">
                         <property name="acceptDrops">
                          <bool>false</bool>
                         </property>
                        </widget>
                       </item>
-                      <item row="5" column="0">
+                      <item row="6" column="0">
                        <widget class="QLabel" name="label_12">
                         <property name="text">
                          <string># Volumes</string>
                         </property>
                        </widget>
                       </item>
-                      <item row="5" column="1">
+                      <item row="6" column="1">
                        <widget class="QLineEdit" name="leVolumeCount">
                         <property name="acceptDrops">
                          <bool>false</bool>
@@ -449,14 +478,14 @@
                         </property>
                        </widget>
                       </item>
-                      <item row="6" column="0">
+                      <item row="7" column="0">
                        <widget class="QLabel" name="label_22">
                         <property name="text">
                          <string>Alt.Issue</string>
                         </property>
                        </widget>
                       </item>
-                      <item row="6" column="1">
+                      <item row="7" column="1">
                        <widget class="QLineEdit" name="leAltIssueNum">
                         <property name="sizePolicy">
                          <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
@@ -469,20 +498,30 @@
                         </property>
                        </widget>
                       </item>
-                      <item row="7" column="0">
+                      <item row="8" column="0">
                        <widget class="QLabel" name="label_23">
                         <property name="text">
                          <string>Alt. # Issues</string>
                         </property>
                        </widget>
                       </item>
-                      <item row="7" column="1">
+                      <item row="8" column="1">
                        <widget class="QLineEdit" name="leAltIssueCount">
                         <property name="acceptDrops">
                          <bool>false</bool>
                         </property>
                        </widget>
                       </item>
+                       <item row="10" column="1">
+                       <widget class="QLineEdit" name="leSeriesPubYear"/>
+                      </item>
+                      <item row="9" column="1">
+                       <widget class="QLabel" name="label_7">
+                        <property name="text">
+                         <string>Series Year</string>
+                        </property>
+                       </widget>
+                      </item>
                      </layout>
                     </item>
                     <item>

comictaggerlib/utils.py

@@ -1,632 +1 @@
-# coding=utf-8
-
-"""
-Some generic utilities
-"""
-
-"""
-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
-import re
-import platform
-import locale
-import codecs
-	
-class UtilsVars:
-	already_fixed_encoding = False
-
-def get_actual_preferred_encoding():
-	preferred_encoding = locale.getpreferredencoding()
-	if getattr(sys, 'frozen', None) and platform.system() == "Darwin":	
-		preferred_encoding = "utf-8"
-	return preferred_encoding
-	
-def fix_output_encoding( ):
-	if not UtilsVars.already_fixed_encoding:
-		# this reads the environment and inits the right locale
-		locale.setlocale(locale.LC_ALL, "")
-
-		# try to make stdout/stderr encodings happy for unicode printing
-		preferred_encoding = get_actual_preferred_encoding()
-		sys.stdout = codecs.getwriter(preferred_encoding)(sys.stdout)
-		sys.stderr = codecs.getwriter(preferred_encoding)(sys.stderr)
-		UtilsVars.already_fixed_encoding = True
-
-def get_recursive_filelist( pathlist ):
-	"""
-	Get a recursive list of of all files under all path items in the list
-	"""
-	filename_encoding = sys.getfilesystemencoding()	
-	filelist = []
-	for p in pathlist:
-		# if path is a folder, walk it recursivly, and all files underneath
-		if type(p) == str:
-			#make sure string is unicode
-			p = p.decode(filename_encoding) #, 'replace')
-		elif type(p) != unicode:
-			#it's probably a QString
-			p = unicode(p)
-		
-		if os.path.isdir( p ):
-			for root,dirs,files in os.walk( p ):
-				for f in files:
-					if type(f) == str:
-						#make sure string is unicode
-						f = f.decode(filename_encoding, 'replace')
-					elif type(f) != unicode:
-						#it's probably a QString
-						f = unicode(f)
-					filelist.append(os.path.join(root,f))
-		else:
-			filelist.append(p)
-	
-	return filelist
-	
-def listToString( l ):
-	string = ""
-	if l is not None:
-		for item in l:
-			if len(string) > 0:
-				string += ", "
-			string += item 
-	return string
-		
-def addtopath( dirname ):
-	if dirname is not None and dirname != "":
-		
-		# verify that path doesn't already contain the given dirname
-		tmpdirname = re.escape(dirname)
-		pattern = r"{sep}{dir}$|^{dir}{sep}|{sep}{dir}{sep}|^{dir}$".format( dir=tmpdirname, sep=os.pathsep)
-		
-		match = re.search(pattern, os.environ['PATH'])
-		if not match:	
-			os.environ['PATH'] = dirname + os.pathsep + os.environ['PATH']
-
-# returns executable path, if it exists
-def which(program):
- 
-	def is_exe(fpath):
-		return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
-
-	fpath, fname = os.path.split(program)
-	if fpath:
-		if is_exe(program):
-			return program
-	else:
-		for path in os.environ["PATH"].split(os.pathsep):
-			exe_file = os.path.join(path, program)
-			if is_exe(exe_file):
-				return exe_file
-
-	return None
-
-def removearticles( text ):
-	text = text.lower()
-	articles = ['and', 'the', 'a', '&', 'issue' ]
-	newText = ''
-	for word in text.split(' '):
-		if word not in articles:
-			newText += word+' '
-	
-	newText = newText[:-1]
-	
-	# now get rid of some other junk
-	newText = newText.replace(":", "")
-	newText = newText.replace(",", "")
-	newText = newText.replace("-", " ")
-
-	# since the CV api changed, searches for series names with periods
-	# now explicity require the period to be in the search key,
-	# so the line below is removed (for now)
-	#newText = newText.replace(".", "")
-	
-	return newText
-
-
-def unique_file(file_name):
-	counter = 1
-	file_name_parts = os.path.splitext(file_name) # returns ('/path/file', '.ext')
-	while 1:
-		if not os.path.lexists( file_name):
-			return file_name
-		file_name = file_name_parts[0] + ' (' + str(counter) + ')' + file_name_parts[1]
-		counter += 1
-
-
-# -o- coding: utf-8 -o-
-# ISO639 python dict 
-# oficial list in http://www.loc.gov/standards/iso639-2/php/code_list.php
-
-lang_dict = {
-	'ab': 'Abkhaz',
-	'aa': 'Afar',
-	'af': 'Afrikaans',
-	'ak': 'Akan',
-	'sq': 'Albanian',
-	'am': 'Amharic',
-	'ar': 'Arabic',
-	'an': 'Aragonese',
-	'hy': 'Armenian',
-	'as': 'Assamese',
-	'av': 'Avaric',
-	'ae': 'Avestan',
-	'ay': 'Aymara',
-	'az': 'Azerbaijani',
-	'bm': 'Bambara',
-	'ba': 'Bashkir',
-	'eu': 'Basque',
-	'be': 'Belarusian',
-	'bn': 'Bengali',
-	'bh': 'Bihari',
-	'bi': 'Bislama',
-	'bs': 'Bosnian',
-	'br': 'Breton',
-	'bg': 'Bulgarian',
-	'my': 'Burmese',
-	'ca': 'Catalan; Valencian',
-	'ch': 'Chamorro',
-	'ce': 'Chechen',
-	'ny': 'Chichewa; Chewa; Nyanja',
-	'zh': 'Chinese',
-	'cv': 'Chuvash',
-	'kw': 'Cornish',
-	'co': 'Corsican',
-	'cr': 'Cree',
-	'hr': 'Croatian',
-	'cs': 'Czech',
-	'da': 'Danish',
-	'dv': 'Divehi; Maldivian;',
-	'nl': 'Dutch',
-	'dz': 'Dzongkha',
-	'en': 'English',
-	'eo': 'Esperanto',
-	'et': 'Estonian',
-	'ee': 'Ewe',
-	'fo': 'Faroese',
-	'fj': 'Fijian',
-	'fi': 'Finnish',
-	'fr': 'French',
-	'ff': 'Fula',
-	'gl': 'Galician',
-	'ka': 'Georgian',
-	'de': 'German',
-	'el': 'Greek, Modern',
-	'gn': 'Guaraní',
-	'gu': 'Gujarati',
-	'ht': 'Haitian',
-	'ha': 'Hausa',
-	'he': 'Hebrew (modern)',
-	'hz': 'Herero',
-	'hi': 'Hindi',
-	'ho': 'Hiri Motu',
-	'hu': 'Hungarian',
-	'ia': 'Interlingua',
-	'id': 'Indonesian',
-	'ie': 'Interlingue',
-	'ga': 'Irish',
-	'ig': 'Igbo',
-	'ik': 'Inupiaq',
-	'io': 'Ido',
-	'is': 'Icelandic',
-	'it': 'Italian',
-	'iu': 'Inuktitut',
-	'ja': 'Japanese',
-	'jv': 'Javanese',
-	'kl': 'Kalaallisut',
-	'kn': 'Kannada',
-	'kr': 'Kanuri',
-	'ks': 'Kashmiri',
-	'kk': 'Kazakh',
-	'km': 'Khmer',
-	'ki': 'Kikuyu, Gikuyu',
-	'rw': 'Kinyarwanda',
-	'ky': 'Kirghiz, Kyrgyz',
-	'kv': 'Komi',
-	'kg': 'Kongo',
-	'ko': 'Korean',
-	'ku': 'Kurdish',
-	'kj': 'Kwanyama, Kuanyama',
-	'la': 'Latin',
-	'lb': 'Luxembourgish',
-	'lg': 'Luganda',
-	'li': 'Limburgish',
-	'ln': 'Lingala',
-	'lo': 'Lao',
-	'lt': 'Lithuanian',
-	'lu': 'Luba-Katanga',
-	'lv': 'Latvian',
-	'gv': 'Manx',
-	'mk': 'Macedonian',
-	'mg': 'Malagasy',
-	'ms': 'Malay',
-	'ml': 'Malayalam',
-	'mt': 'Maltese',
-	'mi': 'Māori',
-	'mr': 'Marathi (Marāṭhī)',
-	'mh': 'Marshallese',
-	'mn': 'Mongolian',
-	'na': 'Nauru',
-	'nv': 'Navajo, Navaho',
-	'nb': 'Norwegian Bokmål',
-	'nd': 'North Ndebele',
-	'ne': 'Nepali',
-	'ng': 'Ndonga',
-	'nn': 'Norwegian Nynorsk',
-	'no': 'Norwegian',
-	'ii': 'Nuosu',
-	'nr': 'South Ndebele',
-	'oc': 'Occitan',
-	'oj': 'Ojibwe, Ojibwa',
-	'cu': 'Old Church Slavonic',
-	'om': 'Oromo',
-	'or': 'Oriya',
-	'os': 'Ossetian, Ossetic',
-	'pa': 'Panjabi, Punjabi',
-	'pi': 'Pāli',
-	'fa': 'Persian',
-	'pl': 'Polish',
-	'ps': 'Pashto, Pushto',
-	'pt': 'Portuguese',
-	'qu': 'Quechua',
-	'rm': 'Romansh',
-	'rn': 'Kirundi',
-	'ro': 'Romanian, Moldavan',
-	'ru': 'Russian',
-	'sa': 'Sanskrit (Saṁskṛta)',
-	'sc': 'Sardinian',
-	'sd': 'Sindhi',
-	'se': 'Northern Sami',
-	'sm': 'Samoan',
-	'sg': 'Sango',
-	'sr': 'Serbian',
-	'gd': 'Scottish Gaelic',
-	'sn': 'Shona',
-	'si': 'Sinhala, Sinhalese',
-	'sk': 'Slovak',
-	'sl': 'Slovene',
-	'so': 'Somali',
-	'st': 'Southern Sotho',
-	'es': 'Spanish; Castilian',
-	'su': 'Sundanese',
-	'sw': 'Swahili',
-	'ss': 'Swati',
-	'sv': 'Swedish',
-	'ta': 'Tamil',
-	'te': 'Telugu',
-	'tg': 'Tajik',
-	'th': 'Thai',
-	'ti': 'Tigrinya',
-	'bo': 'Tibetan',
-	'tk': 'Turkmen',
-	'tl': 'Tagalog',
-	'tn': 'Tswana',
-	'to': 'Tonga',
-	'tr': 'Turkish',
-	'ts': 'Tsonga',
-	'tt': 'Tatar',
-	'tw': 'Twi',
-	'ty': 'Tahitian',
-	'ug': 'Uighur, Uyghur',
-	'uk': 'Ukrainian',
-	'ur': 'Urdu',
-	'uz': 'Uzbek',
-	've': 'Venda',
-	'vi': 'Vietnamese',
-	'vo': 'Volapük',
-	'wa': 'Walloon',
-	'cy': 'Welsh',
-	'wo': 'Wolof',
-	'fy': 'Western Frisian',
-	'xh': 'Xhosa',
-	'yi': 'Yiddish',
-	'yo': 'Yoruba',
-	'za': 'Zhuang, Chuang',
-	'zu': 'Zulu',
-}
-
-
-countries = [
-	('AF', 'Afghanistan'),
-	('AL', 'Albania'),
-	('DZ', 'Algeria'),
-	('AS', 'American Samoa'),
-	('AD', 'Andorra'),
-	('AO', 'Angola'),
-	('AI', 'Anguilla'),
-	('AQ', 'Antarctica'),
-	('AG', 'Antigua And Barbuda'),
-	('AR', 'Argentina'),
-	('AM', 'Armenia'),
-	('AW', 'Aruba'),
-	('AU', 'Australia'),
-	('AT', 'Austria'),
-	('AZ', 'Azerbaijan'),
-	('BS', 'Bahamas'),
-	('BH', 'Bahrain'),
-	('BD', 'Bangladesh'),
-	('BB', 'Barbados'),
-	('BY', 'Belarus'),
-	('BE', 'Belgium'),
-	('BZ', 'Belize'),
-	('BJ', 'Benin'),
-	('BM', 'Bermuda'),
-	('BT', 'Bhutan'),
-	('BO', 'Bolivia'),
-	('BA', 'Bosnia And Herzegowina'),
-	('BW', 'Botswana'),
-	('BV', 'Bouvet Island'),
-	('BR', 'Brazil'),
-	('BN', 'Brunei Darussalam'),
-	('BG', 'Bulgaria'),
-	('BF', 'Burkina Faso'),
-	('BI', 'Burundi'),
-	('KH', 'Cambodia'),
-	('CM', 'Cameroon'),
-	('CA', 'Canada'),
-	('CV', 'Cape Verde'),
-	('KY', 'Cayman Islands'),
-	('CF', 'Central African Rep'),
-	('TD', 'Chad'),
-	('CL', 'Chile'),
-	('CN', 'China'),
-	('CX', 'Christmas Island'),
-	('CC', 'Cocos Islands'),
-	('CO', 'Colombia'),
-	('KM', 'Comoros'),
-	('CG', 'Congo'),
-	('CK', 'Cook Islands'),
-	('CR', 'Costa Rica'),
-	('CI', 'Cote D`ivoire'),
-	('HR', 'Croatia'),
-	('CU', 'Cuba'),
-	('CY', 'Cyprus'),
-	('CZ', 'Czech Republic'),
-	('DK', 'Denmark'),
-	('DJ', 'Djibouti'),
-	('DM', 'Dominica'),
-	('DO', 'Dominican Republic'),
-	('TP', 'East Timor'),
-	('EC', 'Ecuador'),
-	('EG', 'Egypt'),
-	('SV', 'El Salvador'),
-	('GQ', 'Equatorial Guinea'),
-	('ER', 'Eritrea'),
-	('EE', 'Estonia'),
-	('ET', 'Ethiopia'),
-	('FK', 'Falkland Islands (Malvinas)'),
-	('FO', 'Faroe Islands'),
-	('FJ', 'Fiji'),
-	('FI', 'Finland'),
-	('FR', 'France'),
-	('GF', 'French Guiana'),
-	('PF', 'French Polynesia'),
-	('TF', 'French S. Territories'),
-	('GA', 'Gabon'),
-	('GM', 'Gambia'),
-	('GE', 'Georgia'),
-	('DE', 'Germany'),
-	('GH', 'Ghana'),
-	('GI', 'Gibraltar'),
-	('GR', 'Greece'),
-	('GL', 'Greenland'),
-	('GD', 'Grenada'),
-	('GP', 'Guadeloupe'),
-	('GU', 'Guam'),
-	('GT', 'Guatemala'),
-	('GN', 'Guinea'),
-	('GW', 'Guinea-bissau'),
-	('GY', 'Guyana'),
-	('HT', 'Haiti'),
-	('HN', 'Honduras'),
-	('HK', 'Hong Kong'),
-	('HU', 'Hungary'),
-	('IS', 'Iceland'),
-	('IN', 'India'),
-	('ID', 'Indonesia'),
-	('IR', 'Iran'),
-	('IQ', 'Iraq'),
-	('IE', 'Ireland'),
-	('IL', 'Israel'),
-	('IT', 'Italy'),
-	('JM', 'Jamaica'),
-	('JP', 'Japan'),
-	('JO', 'Jordan'),
-	('KZ', 'Kazakhstan'),
-	('KE', 'Kenya'),
-	('KI', 'Kiribati'),
-	('KP', 'Korea (North)'),
-	('KR', 'Korea (South)'),
-	('KW', 'Kuwait'),
-	('KG', 'Kyrgyzstan'),
-	('LA', 'Laos'),
-	('LV', 'Latvia'),
-	('LB', 'Lebanon'),
-	('LS', 'Lesotho'),
-	('LR', 'Liberia'),
-	('LY', 'Libya'),
-	('LI', 'Liechtenstein'),
-	('LT', 'Lithuania'),
-	('LU', 'Luxembourg'),
-	('MO', 'Macau'),
-	('MK', 'Macedonia'),
-	('MG', 'Madagascar'),
-	('MW', 'Malawi'),
-	('MY', 'Malaysia'),
-	('MV', 'Maldives'),
-	('ML', 'Mali'),
-	('MT', 'Malta'),
-	('MH', 'Marshall Islands'),
-	('MQ', 'Martinique'),
-	('MR', 'Mauritania'),
-	('MU', 'Mauritius'),
-	('YT', 'Mayotte'),
-	('MX', 'Mexico'),
-	('FM', 'Micronesia'),
-	('MD', 'Moldova'),
-	('MC', 'Monaco'),
-	('MN', 'Mongolia'),
-	('MS', 'Montserrat'),
-	('MA', 'Morocco'),
-	('MZ', 'Mozambique'),
-	('MM', 'Myanmar'),
-	('NA', 'Namibia'),
-	('NR', 'Nauru'),
-	('NP', 'Nepal'),
-	('NL', 'Netherlands'),
-	('AN', 'Netherlands Antilles'),
-	('NC', 'New Caledonia'),
-	('NZ', 'New Zealand'),
-	('NI', 'Nicaragua'),
-	('NE', 'Niger'),
-	('NG', 'Nigeria'),
-	('NU', 'Niue'),
-	('NF', 'Norfolk Island'),
-	('MP', 'Northern Mariana Islands'),
-	('NO', 'Norway'),
-	('OM', 'Oman'),
-	('PK', 'Pakistan'),
-	('PW', 'Palau'),
-	('PA', 'Panama'),
-	('PG', 'Papua New Guinea'),
-	('PY', 'Paraguay'),
-	('PE', 'Peru'),
-	('PH', 'Philippines'),
-	('PN', 'Pitcairn'),
-	('PL', 'Poland'),
-	('PT', 'Portugal'),
-	('PR', 'Puerto Rico'),
-	('QA', 'Qatar'),
-	('RE', 'Reunion'),
-	('RO', 'Romania'),
-	('RU', 'Russian Federation'),
-	('RW', 'Rwanda'),
-	('KN', 'Saint Kitts And Nevis'),
-	('LC', 'Saint Lucia'),
-	('VC', 'St Vincent/Grenadines'),
-	('WS', 'Samoa'),
-	('SM', 'San Marino'),
-	('ST', 'Sao Tome'),
-	('SA', 'Saudi Arabia'),
-	('SN', 'Senegal'),
-	('SC', 'Seychelles'),
-	('SL', 'Sierra Leone'),
-	('SG', 'Singapore'),
-	('SK', 'Slovakia'),
-	('SI', 'Slovenia'),
-	('SB', 'Solomon Islands'),
-	('SO', 'Somalia'),
-	('ZA', 'South Africa'),
-	('ES', 'Spain'),
-	('LK', 'Sri Lanka'),
-	('SH', 'St. Helena'),
-	('PM', 'St.Pierre'),
-	('SD', 'Sudan'),
-	('SR', 'Suriname'),
-	('SZ', 'Swaziland'),
-	('SE', 'Sweden'),
-	('CH', 'Switzerland'),
-	('SY', 'Syrian Arab Republic'),
-	('TW', 'Taiwan'),
-	('TJ', 'Tajikistan'),
-	('TZ', 'Tanzania'),
-	('TH', 'Thailand'),
-	('TG', 'Togo'),
-	('TK', 'Tokelau'),
-	('TO', 'Tonga'),
-	('TT', 'Trinidad And Tobago'),
-	('TN', 'Tunisia'),
-	('TR', 'Turkey'),
-	('TM', 'Turkmenistan'),
-	('TV', 'Tuvalu'),
-	('UG', 'Uganda'),
-	('UA', 'Ukraine'),
-	('AE', 'United Arab Emirates'),
-	('UK', 'United Kingdom'),
-	('US', 'United States'),
-	('UY', 'Uruguay'),
-	('UZ', 'Uzbekistan'),
-	('VU', 'Vanuatu'),
-	('VA', 'Vatican City State'),
-	('VE', 'Venezuela'),
-	('VN', 'Viet Nam'),
-	('VG', 'Virgin Islands (British)'),
-	('VI', 'Virgin Islands (U.S.)'),
-	('EH', 'Western Sahara'),
-	('YE', 'Yemen'),
-	('YU', 'Yugoslavia'),
-	('ZR', 'Zaire'),
-	('ZM', 'Zambia'),
-	('ZW', 'Zimbabwe')
-]
-
-
-
-def getLanguageDict():
-	return lang_dict
-
-def getLanguageFromISO( iso ):
-	if iso == None:
-		return None
-	else:
-		return lang_dict[ iso ]
-
-
-try: 
-	from PyQt4 import QtGui
-	qt_available = True
-except ImportError:
-	qt_available = False
-	
-if qt_available:
-	def reduceWidgetFontSize( widget , delta = 2):
-		f = widget.font()
-		if f.pointSize() > 10:
-			f.setPointSize( f.pointSize() - delta )
-		widget.setFont( f )
-		
-	def centerWindowOnScreen( window ):
-		"""
-		Center the window on screen. This implemention will handle the window
-		being resized or the screen resolution changing.
-		"""
-		# Get the current screens' dimensions...
-		screen = QtGui.QDesktopWidget().screenGeometry()
-		# ... and get this windows' dimensions
-		mysize = window.geometry()
-		# The horizontal position is calulated as screenwidth - windowwidth /2
-		hpos = ( screen.width() - window.width() ) / 2
-		# And vertical position the same, but with the height dimensions
-		vpos = ( screen.height() - window.height() ) / 2
-		# And the move call repositions the window
-		window.move(hpos, vpos)		
-
-	def centerWindowOnParent( window ):
-
-		top_level = window
-		while top_level.parent() is not None:
-			top_level = top_level.parent()
-			
-		# Get the current screens' dimensions...
-		main_window_size = top_level.geometry()
-		# ... and get this windows' dimensions
-		mysize = window.geometry()
-		# The horizontal position is calulated as screenwidth - windowwidth /2
-		hpos = ( main_window_size.width() - window.width() ) / 2
-		# And vertical position the same, but with the height dimensions
-		vpos = ( main_window_size.height() - window.height() ) / 2
-		# And the move call repositions the window
-		window.move(hpos + main_window_size.left(), vpos + main_window_size.top())	
+from comicapi.utils import *

comictaggerlib/versionchecker.py

@@ -1,91 +1,100 @@
-"""
-Version checker
-"""
+"""Version checker"""
 
-"""
-Copyright 2013  Anthony Beville
+# Copyright 2013 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
+# 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
+#     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.
 
-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
 import platform
-import urllib,urllib2
-import ctversion
+import requests
+import urllib.parse
+#import os
 
 try:
-	from PyQt4.QtNetwork import QNetworkAccessManager, QNetworkRequest
-	from PyQt4.QtCore import QUrl, pyqtSignal, QObject, QByteArray
+    from PyQt5.QtNetwork import QNetworkAccessManager, QNetworkRequest, QNetworkReply
+    from PyQt5.QtCore import QUrl, pyqtSignal, QObject, QByteArray
 except ImportError:
-	# No Qt, so define a few dummy QObjects to help us compile
-	class QObject():
-		def __init__(self,*args):
-			pass
-	class pyqtSignal():
-		def __init__(self,*args):
-			pass
-		def emit(a,b,c):
-			pass
-			
+    # No Qt, so define a few dummy QObjects to help us compile
+    class QObject():
+
+        def __init__(self, *args):
+            pass
+
+    class pyqtSignal():
+
+        def __init__(self, *args):
+            pass
+
+        def emit(a, b, c):
+            pass
+
+from . import ctversion
+
+
 class VersionChecker(QObject):
 
-	def getRequestUrl( self, uuid, use_stats ):
-	
-		base_url = "http://comictagger1.appspot.com/latest"
-		args = ""
-		
-		if use_stats:
-			if platform.system() == "Windows":
-				plat = "win"
-			elif platform.system() == "Linux":
-				plat = "lin"
-			elif platform.system() == "Darwin":
-				plat = "mac"
-			else:
-				plat = "other"
-			args = "?uuid={0}&platform={1}&version={2}".format(uuid, plat, ctversion.version)
-			if not getattr(sys, 'frozen', None):
-				args += "&src=T"
+    def getRequestUrl(self, uuid, use_stats):
 
-		return base_url+args
-		
-	def getLatestVersion( self, uuid, use_stats=True):
-		
-		try:
-			resp = urllib2.urlopen( self.getRequestUrl(uuid, use_stats ))
-			new_version = resp.read()
-		except Exception as e:
-			return None
-			
-		if new_version is None or new_version == "":
-			return None
-		return new_version.strip()
+        base_url = "http://comictagger1.appspot.com/latest"
+        args = ""
+        params = dict()
+        if use_stats:
+            params = {
+                'uuid': uuid,
+                'version': ctversion.version
+            }
+            if platform.system() == "Windows":
+                params['platform'] = "win"
+            elif platform.system() == "Linux":
+                params['platform'] = "lin"
+            elif platform.system() == "Darwin":
+                params['platform'] = "mac"
+            else:
+                params['platform'] = "other"
 
-	versionRequestComplete = pyqtSignal( str )
-	
-	def asyncGetLatestVersion( self, uuid, use_stats ):
+            if not getattr(sys, 'frozen', None):
+                params['src'] = 'T'
 
-		url = self.getRequestUrl( uuid, use_stats )
-			
-		self.nam = QNetworkAccessManager()
-		self.nam.finished.connect( self.asyncGetLatestVersionComplete )
-		self.nam.get(QNetworkRequest(QUrl(str(url))))
-		
-	def asyncGetLatestVersionComplete( self, reply ):
-		# read in the response
-		new_version = str(reply.readAll())
+        return (base_url, params)
 
-		if new_version is None or new_version == "":
-			return
+    def getLatestVersion(self, uuid, use_stats=True):
+        try:
+            url, params = self.getRequestUrl(uuid, use_stats)
+            new_version = requests.get(url, params=params).text
+        except Exception as e:
+            return None
 
-		self.versionRequestComplete.emit( new_version.strip() )	
+        if new_version is None or new_version == "":
+            return None
+        return new_version.strip()
+
+    versionRequestComplete = pyqtSignal(str)
+
+    def asyncGetLatestVersion(self, uuid, use_stats):
+        url, params = self.getRequestUrl(uuid, use_stats)
+
+        self.nam = QNetworkAccessManager()
+        self.nam.finished.connect(self.asyncGetLatestVersionComplete)
+        self.nam.get(QNetworkRequest(QUrl(str(url + '?' + urllib.parse.urlencode(params)))))
+
+    def asyncGetLatestVersionComplete(self, reply):
+        if (reply.error() != QNetworkReply.NoError):
+            return
+
+        # read in the response
+        new_version = str(reply.readAll())
+
+        if new_version is None or new_version == "":
+            return
+
+        self.versionRequestComplete.emit(new_version.strip())

comictaggerlib/volumeselectionwindow.py

@@ -1,379 +1,418 @@
-"""
-A PyQT4 dialog to select specific series/volume from list
-"""
+"""A PyQT4 dialog to select specific series/volume from list"""
 
-"""
-Copyright 2012  Anthony Beville
+# Copyright 2012-2014 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
+# 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
+#     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.
-"""
+# 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 time
-import os
-from PyQt4 import QtCore, QtGui, uic
-from PyQt4.QtCore import QObject
-from PyQt4.QtCore import QUrl,pyqtSignal
-from PyQt4.QtNetwork import QNetworkAccessManager, QNetworkRequest
+#import sys
+#import time
+#import os
 
-from comicvinetalker import ComicVineTalker, ComicVineTalkerException
-from issueselectionwindow import IssueSelectionWindow
-from issueidentifier import IssueIdentifier
-from genericmetadata import GenericMetadata
-from imagefetcher import  ImageFetcher
-from progresswindow import IDProgressWindow
-from settings import ComicTaggerSettings
-from matchselectionwindow import MatchSelectionWindow
-from coverimagewidget import CoverImageWidget
-import utils
+from PyQt5 import QtCore, QtGui, QtWidgets, uic
+from PyQt5.QtCore import QUrl, pyqtSignal
+#from PyQt4.QtCore import QObject
+#from PyQt4.QtNetwork import QNetworkAccessManager, QNetworkRequest
 
-class SearchThread( QtCore.QThread):
-
-	searchComplete = pyqtSignal()
-	progressUpdate = pyqtSignal(int, int)
-
-	def __init__(self, series_name, refresh):
-		QtCore.QThread.__init__(self)
-		self.series_name = series_name
-		self.refresh = refresh
-		
-	def run(self):
-		comicVine = ComicVineTalker( )
-		try:
-			self.cv_error = False
-			self.cv_search_results = comicVine.searchForSeries( self.series_name, callback=self.prog_callback, refresh_cache=self.refresh )
-		except ComicVineTalkerException:
-			self.cv_search_results = []
-			self.cv_error = True
-		finally:
-			self.searchComplete.emit()
-		
-	def prog_callback(self, current, total):
-		self.progressUpdate.emit(current, total)
+from .comicvinetalker import ComicVineTalker, ComicVineTalkerException
+from .issueselectionwindow import IssueSelectionWindow
+from .issueidentifier import IssueIdentifier
+from .genericmetadata import GenericMetadata
+from .progresswindow import IDProgressWindow
+from .settings import ComicTaggerSettings
+from .matchselectionwindow import MatchSelectionWindow
+from .coverimagewidget import CoverImageWidget
+from comictaggerlib.ui.qtutils import reduceWidgetFontSize, centerWindowOnParent
+#from imagefetcher import ImageFetcher
+#import utils
 
 
-class IdentifyThread( QtCore.QThread):
+class SearchThread(QtCore.QThread):
 
-	identifyComplete = pyqtSignal( )
-	identifyLogMsg = pyqtSignal( str )
-	identifyProgress = pyqtSignal( int, int )
+    searchComplete = pyqtSignal()
+    progressUpdate = pyqtSignal(int, int)
 
-	def __init__(self, identifier):
-		QtCore.QThread.__init__(self)
-		self.identifier = identifier
-		self.identifier.setOutputFunction( self.logOutput )
-		self.identifier.setProgressCallback( self.progressCallback )
+    def __init__(self, series_name, refresh):
+        QtCore.QThread.__init__(self)
+        self.series_name = series_name
+        self.refresh = refresh
+        self.error_code = None
 
-	def logOutput(self, text):
-		self.identifyLogMsg.emit( text )
+    def run(self):
+        comicVine = ComicVineTalker()
+        try:
+            self.cv_error = False
+            self.cv_search_results = comicVine.searchForSeries(
+                self.series_name,
+                callback=self.prog_callback,
+                refresh_cache=self.refresh)
+        except ComicVineTalkerException as e:
+            self.cv_search_results = []
+            self.cv_error = True
+            self.error_code = e.code
 
-	def progressCallback(self, cur, total):
-		self.identifyProgress.emit( cur, total )
-				
-	def run(self):
-		matches =self.identifier.search()
-		self.identifyComplete.emit( )
+        finally:
+            self.searchComplete.emit()
+
+    def prog_callback(self, current, total):
+        self.progressUpdate.emit(current, total)
 
 
-class VolumeSelectionWindow(QtGui.QDialog):
+class IdentifyThread(QtCore.QThread):
 
-	def __init__(self, parent, series_name, issue_number, year, issue_count, cover_index_list, comic_archive, settings, autoselect=False):
-		super(VolumeSelectionWindow, self).__init__(parent)
-		
-		uic.loadUi(ComicTaggerSettings.getUIFile('volumeselectionwindow.ui' ), self)
-		
-		self.imageWidget = CoverImageWidget( self.imageContainer, CoverImageWidget.URLMode )
-		gridlayout = QtGui.QGridLayout( self.imageContainer )
-		gridlayout.addWidget( self.imageWidget )
-		gridlayout.setContentsMargins(0,0,0,0)
+    identifyComplete = pyqtSignal()
+    identifyLogMsg = pyqtSignal(str)
+    identifyProgress = pyqtSignal(int, int)
 
-		utils.reduceWidgetFontSize( self.teDetails, 1 )
-		utils.reduceWidgetFontSize( self.twList )		
-		
-		self.setWindowFlags(self.windowFlags() |
-									  QtCore.Qt.WindowSystemMenuHint |
-									  QtCore.Qt.WindowMaximizeButtonHint)
+    def __init__(self, identifier):
+        QtCore.QThread.__init__(self)
+        self.identifier = identifier
+        self.identifier.setOutputFunction(self.logOutput)
+        self.identifier.setProgressCallback(self.progressCallback)
 
-		self.settings = settings
-		self.series_name = series_name
-		self.issue_number = issue_number
-		self.year = year
-		self.issue_count = issue_count
-		self.volume_id = 0
-		self.comic_archive = comic_archive
-		self.immediate_autoselect = autoselect
-		self.cover_index_list = cover_index_list
-		self.cv_search_results = None
-		
-		self.twList.resizeColumnsToContents()	
-		self.twList.currentItemChanged.connect(self.currentItemChanged)
-		self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
-		self.btnRequery.clicked.connect(self.requery)			
-		self.btnIssues.clicked.connect(self.showIssues)	
-		self.btnAutoSelect.clicked.connect(self.autoSelect)	
-		
-		self.updateButtons()
-		self.performQuery()
-		self.twList.selectRow(0)
+    def logOutput(self, text):
+        self.identifyLogMsg.emit(text)
 
-	def updateButtons( self ):
-		if self.cv_search_results is not None and len(self.cv_search_results) > 0:
-			enabled = True
-		else:
-			enabled = False
-			
-		self.btnRequery.setEnabled( enabled )			
-		self.btnIssues.setEnabled( enabled )	
-		self.btnAutoSelect.setEnabled( enabled )
-		self.buttonBox.button(QtGui.QDialogButtonBox.Ok).setEnabled( enabled )
-		
-	def requery( self,  ):
-		self.performQuery( refresh=True )
-		self.twList.selectRow(0)
+    def progressCallback(self, cur, total):
+        self.identifyProgress.emit(cur, total)
 
-	def autoSelect( self ):
-
-		if self.comic_archive is None:
-			QtGui.QMessageBox.information(self,"Auto-Select", "You need to load a comic first!")
-			return
-			
-		if self.issue_number is None or self.issue_number == "":
-			QtGui.QMessageBox.information(self,"Auto-Select", "Can't auto-select without an issue number (yet!)")
-			return
-			
-		self.iddialog = IDProgressWindow( self)
-		self.iddialog.setModal(True)
-		self.iddialog.rejected.connect( self.identifyCancel )
-		self.iddialog.show()
-		
-		self.ii = IssueIdentifier( self.comic_archive, self.settings )
-		
-		md = GenericMetadata()
-		md.series = self.series_name
-		md.issue = self.issue_number
-		md.year = self.year
-		md.issueCount = self.issue_count
-
-		self.ii.setAdditionalMetadata( md )
-		self.ii.onlyUseAdditionalMetaData = True
-
-		self.ii.cover_page_index = int(self.cover_index_list[0])
-		
-		self.id_thread = IdentifyThread( self.ii )
-		self.id_thread.identifyComplete.connect( self.identifyComplete )	
-		self.id_thread.identifyLogMsg.connect( self.logIDOutput )	
-		self.id_thread.identifyProgress.connect( self.identifyProgress )	
-		
-		self.id_thread.start()
-		
-		self.iddialog.exec_()
-
-	def logIDOutput( self, text ):
-		print unicode(text),
-		self.iddialog.textEdit.ensureCursorVisible()
-		self.iddialog.textEdit.insertPlainText(text)
-
-	def identifyProgress( self, cur, total ):
-		self.iddialog.progressBar.setMaximum( total )
-		self.iddialog.progressBar.setValue( cur )
-
-	def identifyCancel( self ):
-		self.ii.cancel = True
-		
-	def identifyComplete( self ):
-
-		matches = self.ii.match_list
-		result = self.ii.search_result
-		match_index = 0
-		
-		found_match = None
-		choices = False
-		if result == self.ii.ResultNoMatches:
-			QtGui.QMessageBox.information(self,"Auto-Select Result", " No matches found :-(")
-		elif result == self.ii.ResultFoundMatchButBadCoverScore:
-			QtGui.QMessageBox.information(self,"Auto-Select Result", " Found a match, but cover doesn't seem the same.  Verify before commiting!")
-			found_match = matches[0]
-		elif result == self.ii.ResultFoundMatchButNotFirstPage :
-			QtGui.QMessageBox.information(self,"Auto-Select Result", " Found a match, but not with the first page of the archive.")
-			found_match = matches[0]
-		elif result == self.ii.ResultMultipleMatchesWithBadImageScores:
-			QtGui.QMessageBox.information(self,"Auto-Select Result", " Found some possibilities, but no confidence. Proceed manually.")
-			choices = True
-		elif result == self.ii.ResultOneGoodMatch:
-			found_match = matches[0]
-		elif result == self.ii.ResultMultipleGoodMatches:
-			QtGui.QMessageBox.information(self,"Auto-Select Result", " Found multiple likely matches.  Please select.")
-			choices = True
-
-		if choices:
-			selector = MatchSelectionWindow( self, matches, self.comic_archive )
-			selector.setModal(True)
-			selector.exec_()
-			if selector.result():
-				#we should now have a list index
-				found_match = selector.currentMatch()			
-		
-		if found_match is not None:
-			self.iddialog.accept()
-
-			self.volume_id = found_match['volume_id']
-			self.issue_number = found_match['issue_number']
-			self.selectByID()
-			self.showIssues()
-
-	def showIssues( self ):
-		selector = IssueSelectionWindow( self, self.settings, self.volume_id, self.issue_number )
-		title = ""
-		for record in self.cv_search_results:
-			if record['id'] ==  self.volume_id:
-				title = record['name']
-				title += " (" + unicode(record['start_year']) + ")"
-				title += " - "
-				break
-				
-		selector.setWindowTitle( title + "Select Issue")
-		selector.setModal( True )
-		selector.exec_()
-		if selector.result():
-			#we should now have a volume ID
-			self.issue_number = selector.issue_number
-			self.accept()
-		return
-
-	def selectByID( self ):
-		for r in range(0, self.twList.rowCount()):
-			volume_id, b = self.twList.item( r, 0 ).data( QtCore.Qt.UserRole ).toInt()
-			if (volume_id == self.volume_id):
-				self.twList.selectRow( r )
-				break
-		
-	def performQuery( self, refresh=False ):
-		
-		self.progdialog = QtGui.QProgressDialog("Searching Online", "Cancel", 0, 100, self)
-		self.progdialog.setWindowTitle( "Online Search" )
-		self.progdialog.canceled.connect( self.searchCanceled )
-		self.progdialog.setModal(True)
-
-		self.search_thread = SearchThread( self.series_name, refresh )
-		self.search_thread.searchComplete.connect( self.searchComplete )	
-		self.search_thread.progressUpdate.connect( self.searchProgressUpdate )	
-		self.search_thread.start()
-
-		#QtCore.QCoreApplication.processEvents()
-		self.progdialog.exec_()
+    def run(self):
+        matches = self.identifier.search()
+        self.identifyComplete.emit()
 
 
-	def searchCanceled( self ):
-		print "query cancelled"
-		self.search_thread.searchComplete.disconnect( self.searchComplete )	
-		self.search_thread.progressUpdate.disconnect( self.searchProgressUpdate )	
-		self.progdialog.canceled.disconnect( self.searchCanceled )
-		self.progdialog.reject()
-		QtCore.QTimer.singleShot(200, self.closeMe)
+class VolumeSelectionWindow(QtWidgets.QDialog):
 
-	def closeMe( self ):
-		print "closeme"
-		self.reject()
+    def __init__(self, parent, series_name, issue_number, year, issue_count,
+                 cover_index_list, comic_archive, settings, autoselect=False):
+        super(VolumeSelectionWindow, self).__init__(parent)
 
+        uic.loadUi(
+            ComicTaggerSettings.getUIFile('volumeselectionwindow.ui'), self)
 
-	def searchProgressUpdate( self , current, total ):
-		self.progdialog.setMaximum(total)
-		self.progdialog.setValue(current)
+        self.imageWidget = CoverImageWidget(
+            self.imageContainer, CoverImageWidget.URLMode)
+        gridlayout = QtWidgets.QGridLayout(self.imageContainer)
+        gridlayout.addWidget(self.imageWidget)
+        gridlayout.setContentsMargins(0, 0, 0, 0)
 
-	def searchComplete( self ):
-		self.progdialog.accept()
-		if self.search_thread.cv_error:
-			QtGui.QMessageBox.critical(self, self.tr("Network Issue"), self.tr("Could not connect to ComicVine to search for series!"))
-			return
-		
-		self.cv_search_results = self.search_thread.cv_search_results		
-		self.updateButtons()
+        reduceWidgetFontSize(self.teDetails, 1)
+        reduceWidgetFontSize(self.twList)
 
-		self.twList.setSortingEnabled(False)
+        self.setWindowFlags(self.windowFlags() |
+                            QtCore.Qt.WindowSystemMenuHint |
+                            QtCore.Qt.WindowMaximizeButtonHint)
 
-		while self.twList.rowCount() > 0:
-			self.twList.removeRow(0)
-	
-		row = 0
-		for record in self.cv_search_results: 
-			self.twList.insertRow(row)
+        self.settings = settings
+        self.parent = parent
+        self.series_name = series_name
+        self.issue_number = issue_number
+        self.year = year
+        self.issue_count = issue_count
+        self.volume_id = 0
+        self.comic_archive = comic_archive
+        self.immediate_autoselect = autoselect
+        self.cover_index_list = cover_index_list
+        self.cv_search_results = None
 
-			item_text = record['name']
-			item = QtGui.QTableWidgetItem( item_text )			
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setData( QtCore.Qt.UserRole ,record['id'])
-			item.setFlags(QtCore.Qt.ItemIsSelectable| QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 0, item)
-			
-			item_text = str(record['start_year'])  
-			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)
+        self.twList.resizeColumnsToContents()
+        self.twList.currentItemChanged.connect(self.currentItemChanged)
+        self.twList.cellDoubleClicked.connect(self.cellDoubleClicked)
+        self.btnRequery.clicked.connect(self.requery)
+        self.btnIssues.clicked.connect(self.showIssues)
+        self.btnAutoSelect.clicked.connect(self.autoSelect)
 
-			item_text = record['count_of_issues']  
-			item = QtGui.QTableWidgetItem(item_text)			
-			item.setData( QtCore.Qt.ToolTipRole, item_text )
-			item.setData(QtCore.Qt.DisplayRole, record['count_of_issues'])
-			item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
-			self.twList.setItem(row, 2, item)
-			
-			if record['publisher'] is not None:
-				item_text = record['publisher']['name']
-				item.setData( QtCore.Qt.ToolTipRole, item_text )
-				item = QtGui.QTableWidgetItem(item_text)			
-				item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
-				self.twList.setItem(row, 3, item)
-				
-			row += 1
+        self.updateButtons()
+        self.performQuery()
+        self.twList.selectRow(0)
 
-		self.twList.resizeColumnsToContents()
-		self.twList.setSortingEnabled(True)
-		self.twList.sortItems( 2 , QtCore.Qt.DescendingOrder )
-		self.twList.selectRow(0)
-		self.twList.resizeColumnsToContents()
-		
-		if len( self.cv_search_results ) == 0:
-			QtCore.QCoreApplication.processEvents()
-			QtGui.QMessageBox.information(self,"Search Result", "No matches found!")
+    def updateButtons(self):
+        if self.cv_search_results is not None and len(
+                self.cv_search_results) > 0:
+            enabled = True
+        else:
+            enabled = False
 
-		if self.immediate_autoselect and len( self.cv_search_results ) > 0:
-			# defer the immediate autoselect so this dialog has time to pop up
-			QtCore.QCoreApplication.processEvents()
-			QtCore.QTimer.singleShot(10, self.doImmediateAutoselect)
-			
-	def doImmediateAutoselect( self ):
-			self.immediate_autoselect = False
-			self.autoSelect()
-	
-	def cellDoubleClicked( self, r, c ):
-		self.showIssues()
-		
-	def currentItemChanged( self, curr, prev ):
+        self.btnRequery.setEnabled(enabled)
+        self.btnIssues.setEnabled(enabled)
+        self.btnAutoSelect.setEnabled(enabled)
+        self.buttonBox.button(QtWidgets.QDialogButtonBox.Ok).setEnabled(enabled)
 
-		if curr is None:
-			return
-		if prev is not None and prev.row() == curr.row():
-				return
+    def requery(self,):
+        self.performQuery(refresh=True)
+        self.twList.selectRow(0)
 
-		self.volume_id, b = self.twList.item( curr.row(), 0 ).data( QtCore.Qt.UserRole ).toInt()
+    def autoSelect(self):
 
-		# list selection was changed, update the info on the volume
-		for record in self.cv_search_results: 
-			if record['id'] == self.volume_id:
-				if record['description'] is None:
-					self.teDetails.setText ( "" )
-				else:	
-					self.teDetails.setText ( record['description'] )
-				self.imageWidget.setURL( record['image']['super_url'] )
-				break
+        if self.comic_archive is None:
+            QtWidgets.QMessageBox.information(
+                self, "Auto-Select", "You need to load a comic first!")
+            return
+
+        if self.issue_number is None or self.issue_number == "":
+            QtWidgets.QMessageBox.information(
+                self,
+                "Auto-Select",
+                "Can't auto-select without an issue number (yet!)")
+            return
+
+        self.iddialog = IDProgressWindow(self)
+        self.iddialog.setModal(True)
+        self.iddialog.rejected.connect(self.identifyCancel)
+        self.iddialog.show()
+
+        self.ii = IssueIdentifier(self.comic_archive, self.settings)
+
+        md = GenericMetadata()
+        md.series = self.series_name
+        md.issue = self.issue_number
+        md.year = self.year
+        md.issueCount = self.issue_count
+
+        self.ii.setAdditionalMetadata(md)
+        self.ii.onlyUseAdditionalMetaData = True
+
+        self.ii.cover_page_index = int(self.cover_index_list[0])
+
+        self.id_thread = IdentifyThread(self.ii)
+        self.id_thread.identifyComplete.connect(self.identifyComplete)
+        self.id_thread.identifyLogMsg.connect(self.logIDOutput)
+        self.id_thread.identifyProgress.connect(self.identifyProgress)
+
+        self.id_thread.start()
+
+        self.iddialog.exec_()
+
+    def logIDOutput(self, text):
+        print(str(text), end=' ')
+        self.iddialog.textEdit.ensureCursorVisible()
+        self.iddialog.textEdit.insertPlainText(text)
+
+    def identifyProgress(self, cur, total):
+        self.iddialog.progressBar.setMaximum(total)
+        self.iddialog.progressBar.setValue(cur)
+
+    def identifyCancel(self):
+        self.ii.cancel = True
+
+    def identifyComplete(self):
+
+        matches = self.ii.match_list
+        result = self.ii.search_result
+        match_index = 0
+
+        found_match = None
+        choices = False
+        if result == self.ii.ResultNoMatches:
+            QtWidgets.QMessageBox.information(
+                self, "Auto-Select Result", " No matches found :-(")
+        elif result == self.ii.ResultFoundMatchButBadCoverScore:
+            QtWidgets.QMessageBox.information(
+                self,
+                "Auto-Select Result",
+                " Found a match, but cover doesn't seem the same.  Verify before commiting!")
+            found_match = matches[0]
+        elif result == self.ii.ResultFoundMatchButNotFirstPage:
+            QtWidgets.QMessageBox.information(
+                self,
+                "Auto-Select Result",
+                " Found a match, but not with the first page of the archive.")
+            found_match = matches[0]
+        elif result == self.ii.ResultMultipleMatchesWithBadImageScores:
+            QtWidgets.QMessageBox.information(
+                self,
+                "Auto-Select Result",
+                " Found some possibilities, but no confidence. Proceed manually.")
+            choices = True
+        elif result == self.ii.ResultOneGoodMatch:
+            found_match = matches[0]
+        elif result == self.ii.ResultMultipleGoodMatches:
+            QtWidgets.QMessageBox.information(
+                self,
+                "Auto-Select Result",
+                " Found multiple likely matches.  Please select.")
+            choices = True
+
+        if choices:
+            selector = MatchSelectionWindow(self, matches, self.comic_archive)
+            selector.setModal(True)
+            selector.exec_()
+            if selector.result():
+                # we should now have a list index
+                found_match = selector.currentMatch()
+
+        if found_match is not None:
+            self.iddialog.accept()
+
+            self.volume_id = found_match['volume_id']
+            self.issue_number = found_match['issue_number']
+            self.selectByID()
+            self.showIssues()
+
+    def showIssues(self):
+        selector = IssueSelectionWindow(
+            self, self.settings, self.volume_id, self.issue_number)
+        title = ""
+        for record in self.cv_search_results:
+            if record['id'] == self.volume_id:
+                title = record['name']
+                title += " (" + str(record['start_year']) + ")"
+                title += " - "
+                break
+
+        selector.setWindowTitle(title + "Select Issue")
+        selector.setModal(True)
+        selector.exec_()
+        if selector.result():
+            # we should now have a volume ID
+            self.issue_number = selector.issue_number
+            self.accept()
+        return
+
+    def selectByID(self):
+        for r in range(0, self.twList.rowCount()):
+            volume_id = self.twList.item(r, 0).data(QtCore.Qt.UserRole)
+            if (volume_id == self.volume_id):
+                self.twList.selectRow(r)
+                break
+
+    def performQuery(self, refresh=False):
+
+        self.progdialog = QtWidgets.QProgressDialog(
+            "Searching Online", "Cancel", 0, 100, self)
+        self.progdialog.setWindowTitle("Online Search")
+        self.progdialog.canceled.connect(self.searchCanceled)
+        self.progdialog.setModal(True)
+        self.progdialog.setMinimumDuration(300)
+        QtCore.QCoreApplication.processEvents()        
+        self.search_thread = SearchThread(self.series_name, refresh)
+        self.search_thread.searchComplete.connect(self.searchComplete)
+        self.search_thread.progressUpdate.connect(self.searchProgressUpdate)
+        self.search_thread.start()
+        self.progdialog.exec_()
+
+    def searchCanceled(self):
+        print("query cancelled")
+        self.search_thread.searchComplete.disconnect(self.searchComplete)
+        self.search_thread.progressUpdate.disconnect(self.searchProgressUpdate)
+        self.progdialog.canceled.disconnect(self.searchCanceled)
+        self.progdialog.reject()
+        QtCore.QTimer.singleShot(200, self.closeMe)
+
+    def closeMe(self):
+        print("closeme")
+        self.reject()
+
+    def searchProgressUpdate(self, current, total):
+        self.progdialog.setMaximum(total)
+        self.progdialog.setValue(current+1)
+
+    def searchComplete(self):
+        self.progdialog.accept()
+        del self.progdialog
+        QtCore.QCoreApplication.processEvents()
+        if self.search_thread.cv_error:
+            if self.search_thread.error_code == ComicVineTalkerException.RateLimit:
+                QtWidgets.QMessageBox.critical(
+                    self,
+                    self.tr("Comic Vine Error"),
+                    ComicVineTalker.getRateLimitMessage())
+            else:
+                QtWidgets.QMessageBox.critical(
+                    self,
+                    self.tr("Network Issue"),
+                    self.tr("Could not connect to Comic Vine to search for series!"))
+            return
+
+        self.cv_search_results = self.search_thread.cv_search_results
+        self.updateButtons()
+
+        self.twList.setSortingEnabled(False)
+
+        while self.twList.rowCount() > 0:
+            self.twList.removeRow(0)
+
+        row = 0
+        for record in self.cv_search_results:
+            self.twList.insertRow(row)
+
+            item_text = record['name']
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.UserRole, record['id'])
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 0, item)
+
+            item_text = str(record['start_year'])
+            item = QtWidgets.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 = record['count_of_issues']
+            item = QtWidgets.QTableWidgetItem(item_text)
+            item.setData(QtCore.Qt.ToolTipRole, item_text)
+            item.setData(QtCore.Qt.DisplayRole, record['count_of_issues'])
+            item.setFlags(QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+            self.twList.setItem(row, 2, item)
+
+            if record['publisher'] is not None:
+                item_text = record['publisher']['name']
+                item.setData(QtCore.Qt.ToolTipRole, item_text)
+                item = QtWidgets.QTableWidgetItem(item_text)
+                item.setFlags(
+                    QtCore.Qt.ItemIsSelectable | QtCore.Qt.ItemIsEnabled)
+                self.twList.setItem(row, 3, item)
+
+            row += 1
+
+        self.twList.resizeColumnsToContents()
+        self.twList.setSortingEnabled(True)
+        self.twList.sortItems(2, QtCore.Qt.DescendingOrder)
+        self.twList.selectRow(0)
+        self.twList.resizeColumnsToContents()
+
+        if len(self.cv_search_results) == 0:
+            QtCore.QCoreApplication.processEvents()
+            QtWidgets.QMessageBox.information(
+                self, "Search Result", "No matches found!")
+
+        if self.immediate_autoselect and len(self.cv_search_results) > 0:
+            # defer the immediate autoselect so this dialog has time to pop up
+            QtCore.QCoreApplication.processEvents()
+            QtCore.QTimer.singleShot(10, self.doImmediateAutoselect)
+
+    def doImmediateAutoselect(self):
+        self.immediate_autoselect = False
+        self.autoSelect()
+
+    def cellDoubleClicked(self, r, c):
+        self.showIssues()
+
+    def currentItemChanged(self, curr, prev):
+
+        if curr is None:
+            return
+        if prev is not None and prev.row() == curr.row():
+            return
+
+        self.volume_id = self.twList.item(curr.row(), 0).data(QtCore.Qt.UserRole)
+             
+        # list selection was changed, update the info on the volume
+        for record in self.cv_search_results:
+            if record['id'] == self.volume_id:
+                if record['description'] is None:
+                    self.teDetails.setText("")
+                else:
+                    self.teDetails.setText(record['description'])
+                self.imageWidget.setURL(record['image']['super_url'])
+                break

current_version.txt

@@ -1 +0,0 @@
-1.1.7-beta

desktop-integration/linux/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=%%CTSCRIPT%% %F
+Icon=/usr/local/share/comictagger/app.png
+Terminal=false
+Type=Application
+MimeType=text/plain;
+Categories=Application;

desktop-integration/mac/ComicTagger

@@ -0,0 +1,4 @@
+This file is a placeholder that will automaticlly be replaced with a symlink to
+the local machine's Python framework python binary.
+
+When pip does an uninstall, it will remove the link.

desktop-integration/mac/Info.plist

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>CFBundleDevelopmentRegion</key>
+    <string>English</string>
+    <key>CFBundleExecutable</key>
+    <string>main.sh</string>
+    <key>CFBundleIconFile</key>
+    <string>app.icns</string>
+    <key>CFBundleIdentifier</key>
+    <string>org.comictagger.comictagger</string>
+    <key>CFBundleInfoDictionaryVersion</key>
+    <string>6.0</string>
+    <key>CFBundleName</key>
+    <string>ComicTagger</string>
+    <key>CFBundlePackageType</key>
+    <string>APPL</string>
+    <key>CFBundleShortVersionString</key>
+    <string>%%CTVERSION%%</string>
+    <key>CFBundleSignature</key>
+    <string>????</string>
+    <key>CFBundleVersion</key>
+    <string>%%CTVERSION%%</string>
+    <key>NSAppleScriptEnabled</key>
+    <string>YES</string>
+    <key>NSMainNibFile</key>
+    <string>MainMenu</string>
+    <key>NSPrincipalClass</key>
+    <string>NSApplication</string>
+</dict>
+</plist>

desktop-integration/mac/main.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+# This is a lot of hoop-jumping to get the absolute path
+# of this script, so that we can use the Symlinked python
+# binary to call the CT script.  This is all so that the
+# Mac menu doesn't say "Python".
+
+realpath() 
+{
+    [[ $1 = /* ]] && echo "$1" || echo "$PWD/${1#./}"
+}
+
+CTSCRIPT=%%CTSCRIPT%%
+
+THIS=$(realpath $0)
+THIS_FOLDER=$(dirname $THIS)
+"$THIS_FOLDER/ComicTagger" "$CTSCRIPT"

desktop-integration/windows/ComicTagger-pip.lnk

@@ -0,0 +1,4 @@
+This file is a placeholder that will automatically be replaced with a Windows
+shortcut on the user's desktop.
+
+When pip does an uninstall, it will remove the shortcut file.

google/googlecode_upload.py

@@ -57,200 +57,204 @@ import sys
 
 
 def upload(file, project_name, user_name, password, summary, labels=None):
-  """Upload a file to a Google Code project's file server.
+    """Upload a file to a Google Code project's file server.
 
-  Args:
-    file: The local path to the file.
-    project_name: The name of your project on Google Code.
-    user_name: Your Google account name.
-    password: The googlecode.com password for your account.
-              Note that this is NOT your global Google Account password!
-    summary: A small description for the file.
-    labels: an optional list of label strings with which to tag the file.
+    Args:
+      file: The local path to the file.
+      project_name: The name of your project on Google Code.
+      user_name: Your Google account name.
+      password: The googlecode.com password for your account.
+                Note that this is NOT your global Google Account password!
+      summary: A small description for the file.
+      labels: an optional list of label strings with which to tag the file.
 
-  Returns: a tuple:
-    http_status: 201 if the upload succeeded, something else if an
-                 error occured.
-    http_reason: The human-readable string associated with http_status
-    file_url: If the upload succeeded, the URL of the file on Google
-              Code, None otherwise.
-  """
-  # The login is the user part of user@gmail.com. If the login provided
-  # is in the full user@domain form, strip it down.
-  if user_name.endswith('@gmail.com'):
-    user_name = user_name[:user_name.index('@gmail.com')]
+    Returns: a tuple:
+      http_status: 201 if the upload succeeded, something else if an
+                   error occured.
+      http_reason: The human-readable string associated with http_status
+      file_url: If the upload succeeded, the URL of the file on Google
+                Code, None otherwise.
+    """
+    # The login is the user part of user@gmail.com. If the login provided
+    # is in the full user@domain form, strip it down.
+    if user_name.endswith('@gmail.com'):
+        user_name = user_name[:user_name.index('@gmail.com')]
 
-  form_fields = [('summary', summary)]
-  if labels is not None:
-    form_fields.extend([('label', l.strip()) for l in labels])
+    form_fields = [('summary', summary)]
+    if labels is not None:
+        form_fields.extend([('label', l.strip()) for l in labels])
 
-  content_type, body = encode_upload_request(form_fields, file)
+    content_type, body = encode_upload_request(form_fields, file)
 
-  upload_host = '%s.googlecode.com' % project_name
-  upload_uri = '/files'
-  auth_token = base64.b64encode('%s:%s'% (user_name, password))
-  headers = {
-    'Authorization': 'Basic %s' % auth_token,
-    'User-Agent': 'Googlecode.com uploader v0.9.4',
-    'Content-Type': content_type,
+    upload_host = '%s.googlecode.com' % project_name
+    upload_uri = '/files'
+    auth_token = base64.b64encode('%s:%s' % (user_name, password))
+    headers = {
+        'Authorization': 'Basic %s' % auth_token,
+        'User-Agent': 'Googlecode.com uploader v0.9.4',
+        'Content-Type': content_type,
     }
 
-  server = httplib.HTTPSConnection(upload_host)
-  server.request('POST', upload_uri, body, headers)
-  resp = server.getresponse()
-  server.close()
+    server = httplib.HTTPSConnection(upload_host)
+    server.request('POST', upload_uri, body, headers)
+    resp = server.getresponse()
+    server.close()
 
-  if resp.status == 201:
-    location = resp.getheader('Location', None)
-  else:
-    location = None
-  return resp.status, resp.reason, location
+    if resp.status == 201:
+        location = resp.getheader('Location', None)
+    else:
+        location = None
+    return resp.status, resp.reason, location
 
 
 def encode_upload_request(fields, file_path):
-  """Encode the given fields and file into a multipart form body.
+    """Encode the given fields and file into a multipart form body.
 
-  fields is a sequence of (name, value) pairs. file is the path of
-  the file to upload. The file will be uploaded to Google Code with
-  the same file name.
+    fields is a sequence of (name, value) pairs. file is the path of
+    the file to upload. The file will be uploaded to Google Code with
+    the same file name.
 
-  Returns: (content_type, body) ready for httplib.HTTP instance
-  """
-  BOUNDARY = '----------Googlecode_boundary_reindeer_flotilla'
-  CRLF = '\r\n'
+    Returns: (content_type, body) ready for httplib.HTTP instance
+    """
+    BOUNDARY = '----------Googlecode_boundary_reindeer_flotilla'
+    CRLF = '\r\n'
 
-  body = []
+    body = []
+
+    # Add the metadata about the upload first
+    for key, value in fields:
+        body.extend(
+            ['--' + BOUNDARY,
+             'Content-Disposition: form-data; name="%s"' % key,
+             '',
+             value,
+             ])
+
+    # Now add the file itself
+    file_name = os.path.basename(file_path)
+    f = open(file_path, 'rb')
+    file_content = f.read()
+    f.close()
 
-  # Add the metadata about the upload first
-  for key, value in fields:
     body.extend(
-      ['--' + BOUNDARY,
-       'Content-Disposition: form-data; name="%s"' % key,
-       '',
-       value,
-       ])
+        ['--' + BOUNDARY,
+         'Content-Disposition: form-data; name="filename"; filename="%s"'
+         % file_name,
+         # The upload server determines the mime-type, no need to set it.
+         'Content-Type: application/octet-stream',
+         '',
+         file_content,
+         ])
 
-  # Now add the file itself
-  file_name = os.path.basename(file_path)
-  f = open(file_path, 'rb')
-  file_content = f.read()
-  f.close()
+    # Finalize the form body
+    body.extend(['--' + BOUNDARY + '--', ''])
 
-  body.extend(
-    ['--' + BOUNDARY,
-     'Content-Disposition: form-data; name="filename"; filename="%s"'
-     % file_name,
-     # The upload server determines the mime-type, no need to set it.
-     'Content-Type: application/octet-stream',
-     '',
-     file_content,
-     ])
-
-  # Finalize the form body
-  body.extend(['--' + BOUNDARY + '--', ''])
-
-  return 'multipart/form-data; boundary=%s' % BOUNDARY, CRLF.join(body)
+    return 'multipart/form-data; boundary=%s' % BOUNDARY, CRLF.join(body)
 
 
 def upload_find_auth(file_path, project_name, summary, labels=None,
                      user_name=None, password=None, tries=3):
-  """Find credentials and upload a file to a Google Code project's file server.
+    """Find credentials and upload a file to a Google Code project's file server.
 
-  file_path, project_name, summary, and labels are passed as-is to upload.
+    file_path, project_name, summary, and labels are passed as-is to upload.
 
-  Args:
-    file_path: The local path to the file.
-    project_name: The name of your project on Google Code.
-    summary: A small description for the file.
-    labels: an optional list of label strings with which to tag the file.
-    config_dir: Path to Subversion configuration directory, 'none', or None.
-    user_name: Your Google account name.
-    tries: How many attempts to make.
-  """
-  if user_name is None or password is None:
-    from netrc import netrc
-    authenticators = netrc().authenticators("code.google.com")
-    if authenticators:
-      if user_name is None:
-        user_name = authenticators[0]
-      if password is None:
-        password = authenticators[2]
+    Args:
+      file_path: The local path to the file.
+      project_name: The name of your project on Google Code.
+      summary: A small description for the file.
+      labels: an optional list of label strings with which to tag the file.
+      config_dir: Path to Subversion configuration directory, 'none', or None.
+      user_name: Your Google account name.
+      tries: How many attempts to make.
+    """
+    if user_name is None or password is None:
+        from netrc import netrc
+        authenticators = netrc().authenticators("code.google.com")
+        if authenticators:
+            if user_name is None:
+                user_name = authenticators[0]
+            if password is None:
+                password = authenticators[2]
 
-  while tries > 0:
-    if user_name is None:
-      # Read username if not specified or loaded from svn config, or on
-      # subsequent tries.
-      sys.stdout.write('Please enter your googlecode.com username: ')
-      sys.stdout.flush()
-      user_name = sys.stdin.readline().rstrip()
-    if password is None:
-      # Read password if not loaded from svn config, or on subsequent tries.
-      print 'Please enter your googlecode.com password.'
-      print '** Note that this is NOT your Gmail account password! **'
-      print 'It is the password you use to access Subversion repositories,'
-      print 'and can be found here: http://code.google.com/hosting/settings'
-      password = getpass.getpass()
+    while tries > 0:
+        if user_name is None:
+            # Read username if not specified or loaded from svn config, or on
+            # subsequent tries.
+            sys.stdout.write('Please enter your googlecode.com username: ')
+            sys.stdout.flush()
+            user_name = sys.stdin.readline().rstrip()
+        if password is None:
+            # Read password if not loaded from svn config, or on subsequent
+            # tries.
+            print 'Please enter your googlecode.com password.'
+            print '** Note that this is NOT your Gmail account password! **'
+            print 'It is the password you use to access Subversion repositories,'
+            print 'and can be found here: http://code.google.com/hosting/settings'
+            password = getpass.getpass()
 
-    status, reason, url = upload(file_path, project_name, user_name, password,
-                                 summary, labels)
-    # Returns 403 Forbidden instead of 401 Unauthorized for bad
-    # credentials as of 2007-07-17.
-    if status in [httplib.FORBIDDEN, httplib.UNAUTHORIZED]:
-      # Rest for another try.
-      user_name = password = None
-      tries = tries - 1
-    else:
-      # We're done.
-      break
+        status, reason, url = upload(
+            file_path, project_name, user_name, password, summary, labels)
+        # Returns 403 Forbidden instead of 401 Unauthorized for bad
+        # credentials as of 2007-07-17.
+        if status in [httplib.FORBIDDEN, httplib.UNAUTHORIZED]:
+            # Rest for another try.
+            user_name = password = None
+            tries = tries - 1
+        else:
+            # We're done.
+            break
 
-  return status, reason, url
+    return status, reason, url
 
 
 def main():
-  parser = optparse.OptionParser(usage='googlecode-upload.py -s SUMMARY '
-                                 '-p PROJECT [options] FILE')
-  parser.add_option('-s', '--summary', dest='summary',
-                    help='Short description of the file')
-  parser.add_option('-p', '--project', dest='project',
-                    help='Google Code project name')
-  parser.add_option('-u', '--user', dest='user',
-                    help='Your Google Code username')
-  parser.add_option('-w', '--password', dest='password',
-                    help='Your Google Code password')
-  parser.add_option('-l', '--labels', dest='labels',
-                    help='An optional list of comma-separated labels to attach '
-                    'to the file')
+    parser = optparse.OptionParser(usage='googlecode-upload.py -s SUMMARY '
+                                   '-p PROJECT [options] FILE')
+    parser.add_option('-s', '--summary', dest='summary',
+                      help='Short description of the file')
+    parser.add_option('-p', '--project', dest='project',
+                      help='Google Code project name')
+    parser.add_option('-u', '--user', dest='user',
+                      help='Your Google Code username')
+    parser.add_option('-w', '--password', dest='password',
+                      help='Your Google Code password')
+    parser.add_option(
+        '-l',
+        '--labels',
+        dest='labels',
+        help='An optional list of comma-separated labels to attach '
+        'to the file')
 
-  options, args = parser.parse_args()
+    options, args = parser.parse_args()
 
-  if not options.summary:
-    parser.error('File summary is missing.')
-  elif not options.project:
-    parser.error('Project name is missing.')
-  elif len(args) < 1:
-    parser.error('File to upload not provided.')
-  elif len(args) > 1:
-    parser.error('Only one file may be specified.')
+    if not options.summary:
+        parser.error('File summary is missing.')
+    elif not options.project:
+        parser.error('Project name is missing.')
+    elif len(args) < 1:
+        parser.error('File to upload not provided.')
+    elif len(args) > 1:
+        parser.error('Only one file may be specified.')
 
-  file_path = args[0]
+    file_path = args[0]
 
-  if options.labels:
-    labels = options.labels.split(',')
-  else:
-    labels = None
+    if options.labels:
+        labels = options.labels.split(',')
+    else:
+        labels = None
 
-  status, reason, url = upload_find_auth(file_path, options.project,
-                                         options.summary, labels,
-                                         options.user, options.password)
-  if url:
-    print 'The file was uploaded successfully.'
-    print 'URL: %s' % url
-    return 0
-  else:
-    print 'An error occurred. Your file was not uploaded.'
-    print 'Google Code upload server said: %s (%s)' % (reason, status)
-    return 1
+    status, reason, url = upload_find_auth(file_path, options.project,
+                                           options.summary, labels,
+                                           options.user, options.password)
+    if url:
+        print 'The file was uploaded successfully.'
+        print 'URL: %s' % url
+        return 0
+    else:
+        print 'An error occurred. Your file was not uploaded.'
+        print 'Google Code upload server said: %s (%s)' % (reason, status)
+        return 1
 
 
 if __name__ == '__main__':
-  sys.exit(main())
+    sys.exit(main())

mac/Makefile

@@ -1,22 +1,24 @@
 #PYINSTALLER_CMD := VERSIONER_PYTHON_PREFER_32_BIT=yes arch -i386 python $(HOME)/pyinstaller-2.0/pyinstaller.py
-PYINSTALLER_CMD := python $(HOME)/pyinstaller-2.0/pyinstaller.py
-TAGGER_BASE ?= $(HOME)/Dropbox/tagger/comictagger
+#PYINSTALLER_CMD := python $(HOME)/pyinstaller-2.0/pyinstaller.py
+PYINSTALLER_CMD := pyinstaller
+TAGGER_BASE ?= ../
 TAGGER_SRC := $(TAGGER_BASE)/comictaggerlib
 
 APP_NAME := ComicTagger
-VERSION_STR := $(shell grep version $(TAGGER_SRC)/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 
+	#$(PYINSTALLER_CMD) $(TAGGER_BASE)/comictagger.py -o $(MAC_BASE) -w -n $(APP_NAME) -s 
+	$(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

pyproject.toml

@@ -0,0 +1,13 @@
+[tool.black]
+line-length = 150
+
+[tool.isort]
+line_length = 150
+
+[build-system]
+requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "comictaggerlib/ctversion.py"
+local_scheme = "no-local-version"

release_notes.txt

@@ -1,180 +1,221 @@
----------------------------------  
-1.1.10-beta - 30-Jan-2014
----------------------------------
- * Updated series query to match changes on Comic Vine side
- * Added a message when not able to open a file or folder
- * Fixed an issue where series names with periods would fail on search 
- * Other misc bug fixes
-
----------------------------------  
-1.1.9-beta - 8-May-2013
----------------------------------
- * Filename parser and identification enhancements
- * Misc bug fixes
-
----------------------------------  
-1.1.8-beta - 21-Apr-2013
----------------------------------
- * Handle occasional error 500 from Comic Vine by retrying a few times
- * Nicer handling of colon (":") in file rename
- * Fixed command-line option parsing issue for add-on scripts
- * Misc bug fixes
-
----------------------------------  
-1.1.7-beta - 12-Apr-2013
----------------------------------
- * Added description and cover date to issue selection dialogs
- * Added notification of new version
- * Added setting to attempt to parse scan info from file name
- * Last sorted column in the file list is now remembered
- * Added CLI option ('-1') to assume issue #1 if not found/parsed
- * Misc bug fixes
-
----------------------------------  
-1.1.6-beta - 3-Apr-2013
----------------------------------
- * More ComicVine API-related fixes
- * More efficient automated search using new CV API issue filters
+---------------------------------  
+1.1.16-beta-rc - 07-Apr-2017
+---------------------------------
+ * Fix ComicVine SSL problems (issue #87)
+ 
+---------------------------------  
+1.1.15-beta - 13-Jun-2014
+---------------------------------
+ * WebP support
+ * Added user-configurable API key for Comic Vine access 
+ * Experimental option to wait and retry after exceeding Comic Vine rate limit
+
+---------------------------------  
+1.1.14-beta - 13-Apr-2014
+---------------------------------
+ * Make sure app gets raised when enforcing single instance
+ * Added warning dialog for when opening rar files, and no (un)rar tool 
+ * remove pil from python package requirements
+
+---------------------------------  
+1.1.13-beta - 9-Apr-2014
+---------------------------------
+ * Handle non-ascii user names properly
+ * better parsing of html table in summary text, and optional removal
+ * Python package should auto-install requirements
+ * Specify default GUI tag style on command-line
+ * enforce single GUI instance
+ * new CBL transform to copy story arcs to generic tags
+ * Persist some auto-tag settings
+
+---------------------------------  
+1.1.12-beta - 23-Mar-2014
+---------------------------------
+ * Fixed noisy version update error
+
+---------------------------------  
+1.1.11-beta - 23-Mar-2014
+---------------------------------
+ * Updated unrar library to hand Rar tools 5.0 and greater
+ * Other misc bug fixes
+
+---------------------------------  
+1.1.10-beta - 30-Jan-2014
+---------------------------------
+ * Updated series query to match changes on Comic Vine side
+ * Added a message when not able to open a file or folder
+ * Fixed an issue where series names with periods would fail on search 
+ * Other misc bug fixes
+
+---------------------------------  
+1.1.9-beta - 8-May-2013
+---------------------------------
+ * Filename parser and identification enhancements
+ * Misc bug fixes
+
+---------------------------------  
+1.1.8-beta - 21-Apr-2013
+---------------------------------
+ * Handle occasional error 500 from Comic Vine by retrying a few times
+ * Nicer handling of colon (":") in file rename
+ * Fixed command-line option parsing issue for add-on scripts
+ * Misc bug fixes
+
+---------------------------------  
+1.1.7-beta - 12-Apr-2013
+---------------------------------
+ * Added description and cover date to issue selection dialogs
+ * Added notification of new version
+ * Added setting to attempt to parse scan info from file name
+ * Last sorted column in the file list is now remembered
+ * Added CLI option ('-1') to assume issue #1 if not found/parsed
+ * Misc bug fixes
+
+---------------------------------  
+1.1.6-beta - 3-Apr-2013
+---------------------------------
+ * More ComicVine API-related fixes
+ * More efficient automated search using new CV API issue filters
  * Minor bug fixes
- 
----------------------------------  
-1.1.5-beta - 30-Mar-2013
----------------------------------
- * More updates for handling changes to ComicVine API and result sets
- * Even better handling of non-numeric issue "numbers" ("½", "X")
-
----------------------------------  
-1.1.4-beta - 27-Mar-2013
----------------------------------
- * Updated to match the changes to the ComicVine API and result sets
- * Better handling of weird issue numbers ("0.1", "6au")
-
----------------------------------  
-1.1.3-beta - 25-Feb-2013
----------------------------------
-Bug Fixes:
-	* Fixed a bug when renaming on non-English systems
-	* Fixed issue when saving settings on non-English systems
-	* Fixed a bug when comic contains non-RGB images
-	* Fixed a rare crash when comic image is not-RGB format
-	* Fixed sequence order of ComicInfo.xml items
-
-Note:
-  New requirement for users of the python package:  "configparser"
-
----------------------------------  
-1.1.2-beta - 14-Feb-2013
----------------------------------
-Changes:
-	* Source is now packaged using Python distutils
-	* Recursive mode for CLI
-	* Run custom add-on scripts from CLI
-	* Minor UI tweaks
-	* Misc bug fixes
-
----------------------------------  
-1.1.0-beta - 06-Feb-2013
----------------------------------
-Changes:
-	* Enhanced identification process to use alternative covers from ComicVine
-	* Post auto-tag manual matching now includes single low-confidence matches (CLI & GUI)
-	* Page and cover view mini-browser available throughout app.  Most images can be
-         double-clicked for embiggened view
-	* Export-to-zip in CLI (very handy in scripts!)
-	* More rename template variables
-	* Misc GUI & CLI Tweaks
-
----------------------------------  
-1.0.3-beta - 31-Jan-2013
----------------------------------
-Changes:
-	Misc bug fixes and enhancements
-	
----------------------------------  
-1.0.2-beta - 25-Jan-2013
----------------------------------
-Changes:
-	More verbose logging during auto-tag
-	Added %month% and %month_name% for renaming
-	Better parsing of volume numbers in file name
-Bugs:
-	Better exception handling with corrupted image data
-	Fixed issues with RAR reading on OS X
-	Other minor bug fixes
-	
----------------------------------  
-1.0.1-beta - 24-Jan-2013
----------------------------------
-Bug Fix:
-	Fixed an issue where unicode strings can't be printed to OS X Console
-
----------------------------------  
-1.0.0-beta - 23-Jan-2013
----------------------------------
-Version 1!  New multi-file processing in GUI!
-
-GUI Changes:
-  Open multiple files and/or folders via drag/drop or file dialog
-  File management list for easy viewing and selection
-  Batch tag remove
-  Batch export as zip
-  Batch rename
-  Batch tag copy
-  Batch auto-tag (automatic identification and save!)
-  
----------------------------------  
-0.9.5-beta - 16-Jan-2013
----------------------------------
-Changes:
-  Added CLI option to search by comicvine issue ID
-  Some image loading optimizations
-  Bug Fix:  Some CBL fields that should have been ints were written as strings
-
----------------------------------  
-0.9.4-beta - 7-Jan-2013
----------------------------------
-Changes:
-  Better handling of non-ascii characters in filenames and data
-  Add CBL Transform to copy Web Link and Notes to comments
-  Minor bug fixes
-
----------------------------------  
-0.9.3-beta - 19-Dec-2012
----------------------------------
-Changes:
-  File rename in GUI
-  Setting for file rename
-  Option to use series start year as volume
-  Added "CBL Transform" to handle primary credits copying data into the generic tags field
-  Bug Fix:  unicode characters in credits caused crash 
-  Bug Fix:  bad or non-image data in file caused crash 
-
-Note:
-  The user should clear the cache and delete the existing settings when first running this version.
-  
----------------------------------  
-0.9.2-beta - 13-Dec-2012
----------------------------------
-  Page List/Type editing in GUI
-  File globbing for windows CLI (i.e. use of wildcards like '*.cbz')
-  Fixed RAR writing bug on windows
-  Minor bug and crash fixes
-
----------------------------------  
-0.9.1-beta - 07-Dec-2012
----------------------------------
-  Export as ZIP Archive
-  Added help menu option for websites
-  Added Primary Credit Flag editing
-  Menu enhancements
-  CLI Enhancements:
-	Interactive selection of matches
-	Tag copy
-	Better output
-	CoMet support
-  Minor bug and crash fixes
-
----------------------------------  
-0.9.0-beta - 30-Nov-2012
----------------------------------
-Initial beta release
+ 
+---------------------------------  
+1.1.5-beta - 30-Mar-2013
+---------------------------------
+ * More updates for handling changes to ComicVine API and result sets
+ * Even better handling of non-numeric issue "numbers" ("½", "X")
+
+---------------------------------  
+1.1.4-beta - 27-Mar-2013
+---------------------------------
+ * Updated to match the changes to the ComicVine API and result sets
+ * Better handling of weird issue numbers ("0.1", "6au")
+
+---------------------------------  
+1.1.3-beta - 25-Feb-2013
+---------------------------------
+Bug Fixes:
+	* Fixed a bug when renaming on non-English systems
+	* Fixed issue when saving settings on non-English systems
+	* Fixed a bug when comic contains non-RGB images
+	* Fixed a rare crash when comic image is not-RGB format
+	* Fixed sequence order of ComicInfo.xml items
+
+Note:
+  New requirement for users of the python package: "configparser"
+
+---------------------------------  
+1.1.2-beta - 14-Feb-2013
+---------------------------------
+Changes:
+	* Source is now packaged using Python distutils
+	* Recursive mode for CLI
+	* Run custom add-on scripts from CLI
+	* Minor UI tweaks
+	* Misc bug fixes
+
+---------------------------------  
+1.1.0-beta - 06-Feb-2013
+---------------------------------
+Changes:
+	* Enhanced identification process to use alternative covers from ComicVine
+	* Post auto-tag manual matching now includes single low-confidence matches (CLI & GUI)
+	* Page and cover view mini-browser available throughout app.  Most images can be
+         double-clicked for enlarged view
+	* Export-to-zip in CLI (very handy in scripts!)
+	* More rename template variables
+	* Misc GUI & CLI Tweaks
+
+---------------------------------  
+1.0.3-beta - 31-Jan-2013
+---------------------------------
+Changes:
+	Misc bug fixes and enhancements
+	
+---------------------------------  
+1.0.2-beta - 25-Jan-2013
+---------------------------------
+Changes:
+	More verbose logging during auto-tag
+	Added %month% and %month_name% for renaming
+	Better parsing of volume numbers in file name
+Bugs:
+	Better exception handling with corrupted image data
+	Fixed issues with RAR reading on OS X
+	Other minor bug fixes
+	
+---------------------------------  
+1.0.1-beta - 24-Jan-2013
+---------------------------------
+Bug Fix:
+	Fixed an issue where unicode strings can't be printed to OS X Console
+
+---------------------------------  
+1.0.0-beta - 23-Jan-2013
+---------------------------------
+Version 1!  New multi-file processing in GUI!
+
+GUI Changes:
+  Open multiple files and/or folders via drag/drop or file dialog
+  File management list for easy viewing and selection
+  Batch tag remove
+  Batch export as zip
+  Batch rename
+  Batch tag copy
+  Batch auto-tag (automatic identification and save!)
+  
+---------------------------------  
+0.9.5-beta - 16-Jan-2013
+---------------------------------
+Changes:
+  Added CLI option to search by Comic Vine issue ID
+  Some image loading optimizations
+  Bug Fix: Some CBL fields that should have been ints were written as strings
+
+---------------------------------  
+0.9.4-beta - 7-Jan-2013
+---------------------------------
+Changes:
+  Better handling of non-ascii characters in file names and data
+  Add CBL Transform to copy Web Link and Notes to comments
+  Minor bug fixes
+
+---------------------------------  
+0.9.3-beta - 19-Dec-2012
+---------------------------------
+Changes:
+  File rename in GUI
+  Setting for file rename
+  Option to use series start year as volume
+  Added "CBL Transform" to handle primary credits copying data into the generic tags field
+  Bug Fix: unicode characters in credits caused crash
+  Bug Fix: bad or non-image data in file caused crash
+
+Note:
+  The user should clear the cache and delete the existing settings when first running this version.
+  
+---------------------------------  
+0.9.2-beta - 13-Dec-2012
+---------------------------------
+  Page List/Type editing in GUI
+  File globbing for windows CLI (i.e. use of wildcards like '*.cbz')
+  Fixed RAR writing bug on windows
+  Minor bug and crash fixes
+
+---------------------------------  
+0.9.1-beta - 07-Dec-2012
+---------------------------------
+  Export as ZIP Archive
+  Added help menu option for websites
+  Added Primary Credit Flag editing
+  Menu enhancements
+  CLI Enhancements:
+	Interactive selection of matches
+	Tag copy
+	Better output
+	CoMet support
+  Minor bug and crash fixes
+
+---------------------------------  
+0.9.0-beta - 30-Nov-2012
+---------------------------------
+Initial beta release

requirements-CBR.txt

@@ -0,0 +1 @@
+unrar-cffi>=0.2.2

requirements-GUI.txt

@@ -0,0 +1 @@
+PyQt5<=5.15.3

requirements.txt

@@ -1,3 +1,7 @@
-configparser
 beautifulsoup4 >= 4.1
-PIL >= 1.1.6
+PyPDF2==1.24
+configparser
+natsort
+pillow>=4.3.0
+requests
+pathvalidate

requirements_dev.txt

@@ -0,0 +1,4 @@
+pyinstaller==4.3
+setuptools>=42
+setuptools_scm[toml]>=3.4
+wheel

scripts/README.txt

@@ -7,7 +7,7 @@ the setup.py file.
 
 To run via the ComicTagger app, invoke:
 
-# comictagger.py -S script.py [script args]
+$ comictagger.py -S script.py [script args]
 
 (This will work also for binary distributions on Mac and Windows.  No need for
 an extra python install.)
@@ -19,12 +19,10 @@ via the app.
 
 This feature is UNSUPPORTED, and is for the convenience of development-minded
 users of ComicTagger.  The comictaggerlib module will remain largely
-undocumented, and it will up to the crafty script developer to look through
+undocumented, and it will be up to the crafty script developer to look through
 the code to discern APIs and such.
 
 That said, if there are questions, please post in the forums, and hopefully we
 can get your add-on scripts working!
 
 http://comictagger.forumotion.com/
-
-

scripts/find_dupes.py

@@ -1,84 +1,84 @@
 #!/usr/bin/python
-"""
-find all duplicate comics
-"""
+"""Find all duplicate comics"""
 
-import sys
+#import sys
 
 from comictaggerlib.comicarchive import *
 from comictaggerlib.settings import *
-from comictaggerlib.issuestring import *
-import comictaggerlib.utils
+#from comictaggerlib.issuestring import *
+#import comictaggerlib.utils
 
 
 def main():
-	utils.fix_output_encoding()
-	settings = ComicTaggerSettings()
+    utils.fix_output_encoding()
+    settings = ComicTaggerSettings()
 
-	style = MetaDataStyle.CIX
+    style = MetaDataStyle.CIX
 
-	if len(sys.argv) < 2:
-		print >> sys.stderr, "usage:  {0} comic_folder ".format(sys.argv[0])
-		return
-		
-	filelist = utils.get_recursive_filelist( sys.argv[1:] )
-	
-	#first find all comics with metadata
-	print >> sys.stderr, "reading in all comics..."
-	comic_list = []
-	max_name_len = 2
-	for filename in filelist:
-		ca = ComicArchive(filename, settings )
-		if ca.seemsToBeAComicArchive() and ca.hasMetadata( style ):
-			max_name_len = max ( max_name_len, len(filename))
-			fmt_str = u"{{0:{0}}}".format(max_name_len)
-			print >> sys.stderr, fmt_str.format( filename ) + "\r",
-			sys.stderr.flush()
-			comic_list.append((filename, ca.readMetadata( style )))
+    if len(sys.argv) < 2:
+        print >> sys.stderr, "Usage:  {0} [comic_folder]".format(sys.argv[0])
+        return
 
-	print >> sys.stderr, fmt_str.format( "" ) + "\r",
-	print "-----------------------------------------------"
-	print "Found {0} comics with {1} tags".format( len(comic_list), MetaDataStyle.name[style])
-	print "-----------------------------------------------"
+    filelist = utils.get_recursive_filelist(sys.argv[1:])
 
-	#sort the list by series+issue+year, to put all the dupes together
-	def makeKey(x):
-		return "<" + unicode(x[1].series) + u" #" + unicode( x[1].issue ) +  u" - " + unicode( x[1].year ) + ">" 
-	comic_list.sort(key=makeKey, reverse=False)
+    # first find all comics with metadata
+    print >> sys.stderr, "Reading in all comics..."
+    comic_list = []
+    fmt_str = ""
+    max_name_len = 2
+    for filename in filelist:
+        ca = ComicArchive(filename, settings.rar_exe_path)
+        if ca.seemsToBeAComicArchive() and ca.hasMetadata(style):
+            max_name_len = max(max_name_len, len(filename))
+            fmt_str = u"{{0:{0}}}".format(max_name_len)
+            print >> sys.stderr, fmt_str.format(filename) + "\r",
+            sys.stderr.flush()
+            comic_list.append((filename, ca.readMetadata(style)))
 
-	# look for duplicate blocks
-	dupe_set_list = list()
-	dupe_set = list()
-	prev_key = ""
-	for filename, md in comic_list:
-		print >> sys.stderr, fmt_str.format( filename ) + "\r",
-		sys.stderr.flush()
-		
-		new_key = makeKey((filename, md))
+    print >> sys.stderr, fmt_str.format("") + "\r",
+    print "--------------------------------------------------------------------------"
+    print "Found {0} comics with {1} tags".format(len(comic_list), MetaDataStyle.name[style])
+    print "--------------------------------------------------------------------------"
 
-		#if the new key same as the last, add to to dupe set
-		if new_key == prev_key:
-			dupe_set.append(filename)
-			
-		#else we're on a new potential block
-		else:
-			# only add if the dupe list has 2 or more
-			if len (dupe_set) > 1:
-				dupe_set_list.append( dupe_set )
-			dupe_set = list()
-			dupe_set.append(filename)
-			
-		prev_key = new_key
-		
-	print >> sys.stderr, fmt_str.format( "" ) + "\r",
-	print "Found {0} duplicate sets".format( len(dupe_set_list))
+    # sort the list by series+issue+year, to put all the dupes together
+    def makeKey(x):
+        return "<" + unicode(x[1].series) + u" #" + \
+            unicode(x[1].issue) + u" - " + unicode(x[1].year) + ">"
+    comic_list.sort(key=makeKey, reverse=False)
 
-	for dupe_set in dupe_set_list:
-		ca = ComicArchive(dupe_set[0], settings )
-		md = ca.readMetadata( style )
-		print "{0} #{1} ({2})".format( md.series, md.issue, md.year )
-		for filename in dupe_set:
-			print "------------->{0}".format( filename )
+    # look for duplicate blocks
+    dupe_set_list = list()
+    dupe_set = list()
+    prev_key = ""
+    for filename, md in comic_list:
+        print >> sys.stderr, fmt_str.format(filename) + "\r",
+        sys.stderr.flush()
+
+        new_key = makeKey((filename, md))
+
+        # if the new key same as the last, add to to dupe set
+        if new_key == prev_key:
+            dupe_set.append(filename)
+
+        # else we're on a new potential block
+        else:
+            # only add if the dupe list has 2 or more
+            if len(dupe_set) > 1:
+                dupe_set_list.append(dupe_set)
+            dupe_set = list()
+            dupe_set.append(filename)
+
+        prev_key = new_key
+
+    print >> sys.stderr, fmt_str.format("") + "\r",
+    print "Found {0} duplicate sets".format(len(dupe_set_list))
+
+    for dupe_set in dupe_set_list:
+        ca = ComicArchive(dupe_set[0], settings.rar_exe_path)
+        md = ca.readMetadata(style)
+        print "{0} #{1} ({2})".format(md.series, md.issue, md.year)
+        for filename in dupe_set:
+            print "------>{0}".format(filename)
 
 if __name__ == '__main__':
-	main() 
+    main()

scripts/inventory.py

@@ -1,84 +1,83 @@
 #!/usr/bin/python
-"""
-Print out a line-by-line list of basic tag info from all comics
-"""
+"""Print out a line-by-line list of basic tag info from all comics"""
 
-"""
-Copyright 2012  Anthony Beville
+# 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
+# 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
+#     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.
-"""
+# 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
+#import sys
+#import os
 
 from comictaggerlib.comicarchive import *
 from comictaggerlib.settings import *
 from comictaggerlib.issuestring import *
-import comictaggerlib.utils
+#import comictaggerlib.utils
+
 
 def main():
-	utils.fix_output_encoding()
-	settings = ComicTaggerSettings()
+    utils.fix_output_encoding()
+    settings = ComicTaggerSettings()
 
-	style = MetaDataStyle.CIX
+    style = MetaDataStyle.CIX
 
-	if len(sys.argv) < 2:
-		print >> sys.stderr, "usage:  {0} comic_folder ".format(sys.argv[0])
-		return
-	
-	filelist = utils.get_recursive_filelist( sys.argv[1:] )
-			
-	#first read in metadata from all files
-	metadata_list = []	
-	max_name_len = 2
-	for filename in filelist:
-		ca = ComicArchive(filename, settings )
-		if ca.hasMetadata( style ):
-			#make a list of paired filenames and metadata objects
-			metadata_list.append((filename, ca.readMetadata( style )))
-	
-			max_name_len = max ( max_name_len, len(filename))
-			fmt_str = u"{{0:{0}}}".format(max_name_len)
-			print >> sys.stderr, fmt_str.format( filename ) + "\r",
-			sys.stderr.flush()
+    if len(sys.argv) < 2:
+        print >> sys.stderr, "Usage: {0} [comic_folder]".format(sys.argv[0])
+        return
 
-	print >> sys.stderr, fmt_str.format( "" ) + "\r",
-	print "-----------------------------------------------"
-	print "Found {0} comics with {1} tags".format( len(metadata_list), MetaDataStyle.name[style])
-	print "-----------------------------------------------"
+    filelist = utils.get_recursive_filelist(sys.argv[1:])
 
-	# now, figure out column widths	
-	w0 = 4
-	w1 = 4
-	for filename,md in metadata_list: 
-		if not md.isEmpty:
-			w0 = max( len((os.path.split(filename)[1])), w0)
-			if md.series is not None:
-				w1 = max( len(md.series), w1)
-	w0 += 2
-	
-	# build a format string
-	fmt_str = u"{0:" + str(w0) + "} {1:" + str(w1) + "} #{2:6} ({3})"
+    # first read in metadata from all files
+    metadata_list = []
+    max_name_len = 2
+    for filename in filelist:
+        ca = ComicArchive(filename, settings.rar_exe_path)
+        if ca.hasMetadata(style):
+            # make a list of paired file names and metadata objects
+            metadata_list.append((filename, ca.readMetadata(style)))
 
-	# now sort the list by issue, and then series
-	metadata_list.sort(key=lambda x: IssueString(x[1].issue).asString(3), reverse=False)
-	metadata_list.sort(key=lambda x: unicode(x[1].series).lower()+str(x[1].year), reverse=False)
-	
-	# now print
-	for filename, md in metadata_list:
-		if not md.isEmpty:
-			print fmt_str.format(os.path.split(filename)[1]+":", md.series, md.issue, md.year), md.title
+            max_name_len = max(max_name_len, len(filename))
+            fmt_str = u"{{0:{0}}}".format(max_name_len)
+            print >> sys.stderr, fmt_str.format(filename) + "\r",
+            sys.stderr.flush()
+
+    print >> sys.stderr, fmt_str.format("") + "\r",
+    print "--------------------------------------------------------------------------"
+    print "Found {0} comics with {1} tags".format(len(metadata_list), MetaDataStyle.name[style])
+    print "--------------------------------------------------------------------------"
+
+    # now, figure out column widths
+    w0 = 4
+    w1 = 4
+    for filename, md in metadata_list:
+        if not md.isEmpty:
+            w0 = max(len((os.path.split(filename)[1])), w0)
+            if md.series is not None:
+                w1 = max(len(md.series), w1)
+    w0 += 2
+
+    # build a format string
+    fmt_str = u"{0:" + str(w0) + "} {1:" + str(w1) + "} #{2:6} ({3})"
+
+    # now sort the list by issue, and then series
+    metadata_list.sort(
+        key=lambda x: IssueString(x[1].issue).asString(3), reverse=False)
+    metadata_list.sort(
+        key=lambda x: unicode(x[1].series).lower() + str(x[1].year), reverse=False)
+
+    # now print
+    for filename, md in metadata_list:
+        if not md.isEmpty:
+            print fmt_str.format(os.path.split(filename)[1] + ":", md.series, md.issue, md.year), md.title
 
 if __name__ == '__main__':
-	main() 
+    main()

scripts/make_links.py

@@ -1,107 +1,112 @@
 #!/usr/bin/python
 """
-make some tree structures and symbolic links to comic files based on metadata
-oragnizing by date and series, in different trees
+Make some tree structures and symbolic links to comic files based on metadata
+organizing by date and series, in different trees
 """
 
-"""
-Copyright 2012  Anthony Beville
+# 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
+# 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
+#     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.
-"""
+# 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
-import platform
+#import sys
+#import os
+#import platform
 
 from comictaggerlib.comicarchive import *
 from comictaggerlib.settings import *
-from comictaggerlib.issuestring import *
-import comictaggerlib.utils
+#from comictaggerlib.issuestring import *
+#import comictaggerlib.utils
+
+
+def make_folder(folder):
+    if not os.path.exists(folder):
+        try:
+            os.makedirs(folder)
+        except Exception as e:
+            print "{0} Can't make {1} -- quitting".format(e, folder)
+            quit()
+
+
+def make_link(source, link):
+    if not os.path.exists(link):
+        os.symlink(os.path.abspath(source), link)
 
-def make_folder( folder ):
-	if not os.path.exists( folder ):
-		try:
-			os.makedirs(folder)
-		except Exception as e:
-			print "{0} Can't make {1} -- quitting".format(e, folder)
-			quit()
-			
-def make_link( source, link ):
-	if not os.path.exists( link ):
-		os.symlink( os.path.abspath(source) , link )
 
 def main():
-	utils.fix_output_encoding()
-	settings = ComicTaggerSettings()
+    utils.fix_output_encoding()
+    settings = ComicTaggerSettings()
 
-	style = MetaDataStyle.CIX
+    style = MetaDataStyle.CIX
 
-	if platform.system() == "Windows":
-		print >> sys.stderr, "Sorry, this script works only on UNIX systems"
-		
-	if len(sys.argv) < 3:
-		print >> sys.stderr, "usage:  {0} comic_root link_root".format(sys.argv[0])
-		return
-	
-	comic_root = sys.argv[1]
-	link_root = sys.argv[2]
-	
-	print "root is : ", comic_root
-	filelist = utils.get_recursive_filelist( [ comic_root ] )
-	make_folder( link_root )
-		
-	#first find all comics with metadata
-	print "reading in all comics..."
-	comic_list = []
-	max_name_len = 2
-	for filename in filelist:
-		ca = ComicArchive(filename, settings )
-		if ca.seemsToBeAComicArchive() and ca.hasMetadata( style ):
+    if platform.system() == "Windows":
+        print >> sys.stderr, "Sorry, this script works only on UNIX systems"
 
-			comic_list.append((filename, ca.readMetadata( style )))
-			
-			max_name_len = max ( max_name_len, len(filename))
-			fmt_str = u"{{0:{0}}}".format(max_name_len)
-			print >> sys.stderr, fmt_str.format( filename ) + "\r",
-			sys.stderr.flush()
+    if len(sys.argv) < 3:
+        print >> sys.stderr, "Usage: {0} [comic_root][link_root]".format(
+            sys.argv[0])
+        return
 
-	print >> sys.stderr, fmt_str.format( "" )
-	print "Found {0} tagged comics.".format( len(comic_list))
+    comic_root = sys.argv[1]
+    link_root = sys.argv[2]
+
+    print "Root is:", comic_root
+    filelist = utils.get_recursive_filelist([comic_root])
+    make_folder(link_root)
+
+    # first find all comics with metadata
+    print "Reading in all comics..."
+    comic_list = []
+    max_name_len = 2
+    for filename in filelist:
+        ca = ComicArchive(filename, settings.rar_exe_path)
+        if ca.seemsToBeAComicArchive() and ca.hasMetadata(style):
+
+            comic_list.append((filename, ca.readMetadata(style)))
+
+            max_name_len = max(max_name_len, len(filename))
+            fmt_str = u"{{0:{0}}}".format(max_name_len)
+            print >> sys.stderr, fmt_str.format(filename) + "\r",
+            sys.stderr.flush()
+
+    print >> sys.stderr, fmt_str.format("")
+    print "Found {0} tagged comics.".format(len(comic_list))
+
+    # walk through the comic list and add subdirs and links for each one
+    for filename, md in comic_list:
+        print >> sys.stderr, fmt_str.format(filename) + "\r",
+        sys.stderr.flush()
+
+        # do date organizing:
+        if md.month is not None:
+            month_str = "{0:02d}".format(int(md.month))
+        else:
+            month_str = "00"
+        date_folder = os.path.join(link_root, "date", str(md.year), month_str)
+        make_folder(date_folder)
+        make_link(
+            filename, os.path.join(date_folder, os.path.basename(filename)))
+
+        # do publisher/series organizing:
+        fixed_series_name = md.series
+        if fixed_series_name is not None:
+            # some tweaks to keep various filesystems happy
+            fixed_series_name = fixed_series_name.replace("/", "-")
+            fixed_series_name = fixed_series_name.replace("?", "")
+        series_folder = os.path.join(
+            link_root, "series", str(md.publisher), unicode(fixed_series_name))
+        make_folder(series_folder)
+        make_link(filename, os.path.join(
+            series_folder, os.path.basename(filename)))
 
-	# walk through the comic list and add subdirs and links for each one	
-	for filename, md in comic_list:
-		print >> sys.stderr, fmt_str.format( filename ) + "\r",
-		sys.stderr.flush()
-		
-		#do date organizing:
-		if md.month is not None:
-			month_str = "{0:02d}".format(int(md.month))
-		else:
-			month_str = "00"
-		date_folder = os.path.join(link_root, "date", str(md.year), month_str)
-		make_folder( date_folder )
-		make_link( filename, os.path.join(date_folder, os.path.basename(filename)) )
-		
-		#do publisher/series organizing:
-		fixed_series_name = md.series
-		if fixed_series_name is not None:
-			# some tweaks to keep various filesystems happy		
-			fixed_series_name = fixed_series_name.replace("/", "-")
-			fixed_series_name = fixed_series_name.replace("?", "")
-		series_folder = os.path.join(link_root, "series", str(md.publisher), unicode(fixed_series_name))
-		make_folder( series_folder )
-		make_link( filename, os.path.join(series_folder, os.path.basename(filename)) )
-		
 if __name__ == '__main__':
-	main() 
+    main()

scripts/move2folder.py

@@ -0,0 +1,118 @@
+#!/usr/bin/python
+"""Moves comic files based on metadata organizing in a tree by Publisher/Series (Volume)"""
+
+# This script is based on make_links.py by Anthony Beville
+
+# Copyright 2015 Fabio Cancedda, 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 shutil
+#import sys
+#import os
+#import platform
+
+from comictaggerlib.settings import *
+from comicapi.comicarchive import *
+#from comicapi.issuestring import *
+#import comicapi.utils
+
+
+def make_folder(folder):
+    if not os.path.exists(folder):
+        try:
+            os.makedirs(folder)
+        except Exception as e:
+            print "{0} Can't make {1} -- quitting".format(e, folder)
+            quit()
+
+
+def move_file(source, filename):
+    if not os.path.exists(filename):
+        shutil.move(os.path.abspath(source), filename)
+
+
+def main():
+    utils.fix_output_encoding()
+    settings = ComicTaggerSettings()
+
+    style = MetaDataStyle.CIX
+
+    if platform.system() == "Windows":
+        print >> sys.stderr, "Sorry, this script works only on UNIX systems"
+
+    if len(sys.argv) < 3:
+        print >> sys.stderr, "Usage: {0} [comic_root][tree_root]".format(
+            sys.argv[0])
+        return
+
+    comic_root = sys.argv[1]
+    tree_root = sys.argv[2]
+
+    print "Root is:", comic_root
+    if not os.path.exists(comic_root):
+        print >> sys.stderr, "The comic root doesn't seem a directory or it doesn't exists. -- quitting"
+        return
+
+    filelist = utils.get_recursive_filelist([comic_root])
+
+    if len(filelist) == 0:
+        print >> sys.stderr, "The comic root seems empty. -- quitting"
+        return
+
+    make_folder(tree_root)
+
+    # first find all comics with metadata
+    print "Reading in all comics..."
+    comic_list = []
+    max_name_len = 2
+    fmt_str = ""
+    for filename in filelist:
+        ca = ComicArchive(filename, settings.rar_exe_path, ComicTaggerSettings.getGraphic('nocover.png'))
+        if ca.seemsToBeAComicArchive() and ca.hasMetadata(style):
+
+            comic_list.append((filename, ca.readMetadata(style)))
+
+            max_name_len = max(max_name_len, len(filename))
+            fmt_str = u"{{0:{0}}}".format(max_name_len)
+            print >> sys.stderr, fmt_str.format(filename) + "\r",
+            sys.stderr.flush()
+
+    print >> sys.stderr, fmt_str.format("")
+
+    print "Found {0} tagged comics.".format(len(comic_list))
+
+    # walk through the comic list and moves each one
+    for filename, md in comic_list:
+        print >> sys.stderr, fmt_str.format(filename) + "\r",
+        sys.stderr.flush()
+
+        # do publisher/series organizing:
+        series_name = md.series
+        publisher_name = md.publisher
+        start_year = md.volume
+        if series_name is not None:
+            # some tweaks to keep various filesystems happy
+            series_name = series_name.replace(":", " -")
+            series_name = series_name.replace("/", "-")
+            series_name = series_name.replace("?", "")
+        series_folder = os.path.join(
+            tree_root,
+            unicode(publisher_name),
+            unicode(series_name) + " (" + unicode(start_year) + ")")
+        make_folder(series_folder)
+        move_file(filename, os.path.join(
+            series_folder, os.path.basename(filename)))
+
+if __name__ == '__main__':
+    main()