hide subprocess consoles on Windows (#656)

* Revert "Revert "fix files with ' or " by using arg lists instead of strings (#581)" (#628)"

This reverts commit b528dab711.

* handle FileNotFoundError

* modify unar handling

* remove unneeded utf-8 encoding

* dont uft-8 encode 7z

* remove utf-8 encoding from 7z calls

* don't extract stderr

* add extraction error

* edit error message

* remove debug

* remove kindlegen location from GUI

* remove comment

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+Add a screenshot of your KCC settings.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. macOS, Linux, Windows 11]
+ - Device [e.g. Kindle Paperwhite 3rd gen, Kobo Libra 2]
+
+**Additional context**
+Add any other context about the problem here.

.github/workflows/codeql-analysis.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -56,7 +56,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -69,6 +69,6 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/package-linux.yml

@@ -27,7 +27,7 @@ jobs:
     steps:
     - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: 3.11
         cache: 'pip'
@@ -59,7 +59,7 @@ jobs:
       env:
         UPDATE_INFO: gh-releases-zsync|ciromattia|kcc|latest|*x86_64.AppImage.zsync
     - name: upload artifact
-      uses: actions/upload-artifact@v3
+      uses: actions/upload-artifact@v4
       with:
         name: AppImage
         path: './*.AppImage*'

.github/workflows/package-macos.yml

@@ -27,7 +27,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
           cache: 'pip'
@@ -75,7 +75,7 @@ jobs:
         run: |
           python setup.py build_binary
       - name: upload build
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: mac-os-build
           path: dist/*.dmg

.github/workflows/package-windows-with-docker.yml

@@ -47,7 +47,7 @@ jobs:
           mv dist/windows/kcc-c2e.exe dist/windows/kcc_c2e_${version_built}.exe 
           mv dist/windows/kcc-c2p.exe dist/windows/kcc_c2p_${version_built}.exe
       - name: upload build
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: windows-build
           path: dist/windows/*.exe

.github/workflows/package-windows.yml

@@ -27,7 +27,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.11
           cache: 'pip'
@@ -42,7 +42,7 @@ jobs:
         run: |
           python setup.py build_binary
       - name: upload build
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: windows-build
           path: dist/*.exe

.gitignore

@@ -11,3 +11,4 @@ KindleComicConverter*.egg-info/
 /venv/
 /kindlegen*
 /kcc.bat
+.DS_Store

README.md

@@ -28,6 +28,8 @@ If you find **KCC** valuable you can consider donating to the authors:
 - Paweł Jastrzębski:
   - [![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YTTJ4LK2JDHPS)
   - [![Donate Bitcoin](https://img.shields.io/badge/Donate-Bitcoin-green.svg)](https://jastrzeb.ski/donate/)
+- Alex Xu
+  - [![Donate PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate/?business=QFJVE7A6LCP6U&no_recurring=0&item_name=Kindle+Comic+Converter&currency_code=USD)
 
 
 ## DOWNLOADS
@@ -46,9 +48,9 @@ On Windows 11, you may need to run in compatibility mode for an older Windows ve
 
 On Mac, right click open to get past the security warning.
 
-For flatpak, Docker, amd AppImage versions, refer to the wiki: https://github.com/ciromattia/kcc/wiki/Installation
+For flatpak, Docker, and AppImage versions, refer to the wiki: https://github.com/ciromattia/kcc/wiki/Installation
 
-## INSTALL DEPENDENCIES
+## PREREQUISITES
 
 You'll need to install various tools to access important but optional features.
 
@@ -209,7 +211,12 @@ OTHER:
 ```
 
 ## CREDITS
-**KCC** is made by [Ciro Mattia Gonano](http://github.com/ciromattia), [Paweł Jastrzębski](http://github.com/AcidWeb) and [Darodi](http://github.com/darodi)  .
+**KCC** is made by 
+
+- [Ciro Mattia Gonano](http://github.com/ciromattia)
+- [Paweł Jastrzębski](http://github.com/AcidWeb)
+- [Darodi](http://github.com/darodi)
+- [Alex Xu](http://github.com/axu2)
 
 This script born as a cross-platform alternative to `KindleComicParser` by **Dc5e** (published [here](http://www.mobileread.com/forums/showthread.php?t=192783)).
 

environment.yml

@@ -9,6 +9,7 @@ dependencies:
   - python-slugify>=1.2.1
   - raven>=6.0.0
   - distro
+  - natsort[fast]>=8.4.0
   - pip
   - pip:
     - mozjpeg-lossless-optimization>=1.1.2

kindlecomicconverter/KCC_gui.py

@@ -16,25 +16,25 @@
 # OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 # PERFORMANCE OF THIS SOFTWARE.
-import json
 import os
 import re
 import subprocess
 import sys
 from urllib.parse import unquote
-from urllib.request import urlretrieve, urlopen
 from time import sleep
 from shutil import move, rmtree
 from subprocess import STDOUT, PIPE
+
+import requests
 # noinspection PyUnresolvedReferences
 from PyQt5 import QtGui, QtCore, QtWidgets, QtNetwork
 from xml.sax.saxutils import escape
-from psutil import Popen, Process
+from psutil import Process
 from copy import copy
 from distutils.version import StrictVersion
 from raven import Client
 from tempfile import gettempdir
-from .shared import md5Checksum, HTMLStripper, sanitizeTrace, walkLevel
+from .shared import md5Checksum, HTMLStripper, sanitizeTrace, walkLevel, subprocess_run_silent
 from . import __version__
 from . import comic2ebook
 from . import metadata
@@ -139,10 +139,7 @@ class VersionThread(QtCore.QThread):
 
     def run(self):
         try:
-            last_version_url = urlopen("https://api.github.com/repos/ciromattia/kcc/releases/latest")
-            data = last_version_url.read()
-            encoding = last_version_url.info().get_content_charset('utf-8')
-            json_parser = json.loads(data.decode(encoding))
+            json_parser = requests.get("https://api.github.com/repos/ciromattia/kcc/releases/latest").json()
 
             html_url = json_parser["html_url"]
             latest_version = json_parser["tag_name"]
@@ -839,32 +836,21 @@ class KCCGUI(KCC_ui.Ui_mainWindow):
                 os.chmod('/usr/local/bin/kindlegen', 0o755)
             except Exception:
                 pass
-        kindleGenExitCode = Popen('kindlegen -locale en', stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-        kindleGenExitCode.communicate()
-        if kindleGenExitCode.returncode == 0:
+        try:
+            versionCheck = subprocess_run_silent(['kindlegen', '-locale', 'en'], stdout=PIPE, stderr=STDOUT, encoding='UTF-8')
             self.kindleGen = True
-            versionCheck = Popen('kindlegen -locale en', stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-            for line in versionCheck.stdout:
-                line = line.decode("utf-8")
+            for line in versionCheck.stdout.splitlines():
                 if 'Amazon kindlegen' in line:
                     versionCheck = line.split('V')[1].split(' ')[0]
                     if StrictVersion(versionCheck) < StrictVersion('2.9'):
                         self.addMessage('Your <a href="https://www.amazon.com/b?node=23496309011">KindleGen</a>'
                                         ' is outdated! MOBI conversion might fail.', 'warning')
                     break
-            where_command = 'where kindlegen.exe'
-            if os.name == 'posix':
-                where_command = 'which kindlegen'
-            process = subprocess.run(where_command, stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-            locations = process.stdout.decode('utf-8').split('\n')
-            self.addMessage(f"<b>KindleGen Found:</b> {locations[0]}", 'info')
-        else:
+        except FileNotFoundError:
             self.kindleGen = False
             if startup:
                 self.display_kindlegen_missing()
 
-
-
     def __init__(self, kccapp, kccwindow):
         global APP, MW, GUI
         APP = kccapp
@@ -1039,11 +1025,10 @@ class KCCGUI(KCC_ui.Ui_mainWindow):
             self.addMessage('Since you are a new user of <b>KCC</b> please see few '
                             '<a href="https://github.com/ciromattia/kcc/wiki/Important-tips">important tips</a>.',
                             'info')
-        process = Popen('7z', stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-        process.communicate()
-        if process.returncode == 0 or process.returncode == 7:
+        try:
+            subprocess_run_silent(['7z'], stdout=PIPE, stderr=STDOUT)
             self.sevenzip = True
-        else:
+        except FileNotFoundError:
             self.sevenzip = False
             self.addMessage('<a href="https://github.com/ciromattia/kcc#7-zip">Install 7z (link)</a>'
                             ' to enable CBZ/CBR/ZIP/etc processing.', 'warning')

kindlecomicconverter/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '5.6.4'
+__version__ = '5.6.5'
 __license__ = 'ISC'
 __copyright__ = '2012-2022, Ciro Mattia Gonano <ciromattia@gmail.com>, Pawel Jastrzebski <pawelj@iosphe.re>, darodi'
 __docformat__ = 'restructuredtext en'

kindlecomicconverter/comic2ebook.py

@@ -19,6 +19,9 @@
 #
 
 import os
+import pathlib
+import re
+import subprocess
 import sys
 from argparse import ArgumentParser
 from time import strftime, gmtime
@@ -31,17 +34,17 @@ from tempfile import mkdtemp, gettempdir, TemporaryFile
 from shutil import move, copytree, rmtree, copyfile
 from multiprocessing import Pool
 from uuid import uuid4
-from natsort import natsorted
+from natsort import os_sorted
 from slugify import slugify as slugify_ext
 from PIL import Image
 from subprocess import STDOUT, PIPE
-from psutil import Popen, virtual_memory, disk_usage
+from psutil import virtual_memory, disk_usage
 from html import escape as hescape
 try:
     from PyQt5 import QtCore
 except ImportError:
     QtCore = None
-from .shared import md5Checksum, getImageFileName, walkSort, walkLevel, sanitizeTrace
+from .shared import md5Checksum, getImageFileName, walkSort, walkLevel, sanitizeTrace, subprocess_run_silent
 from . import comic2panel
 from . import image
 from . import comicarchive
@@ -672,11 +675,9 @@ def getOutputFilename(srcpath, wantedname, ext, tomenumber):
         filename = srcpath + tomenumber + ext
     else:
         if 'Ko' in options.profile and options.format == 'EPUB':
-            path = srcpath.split(os.path.sep)
-            path[-1] = ''.join(e for e in path[-1].split('.')[0] if e.isalnum()) + tomenumber + ext
-            if not path[-1].split('.')[0]:
-                path[-1] = 'KCCPlaceholder' + tomenumber + ext
-            filename = os.path.sep.join(path)
+            src = pathlib.Path(srcpath)
+            name = re.sub(r'\W+', '_', src.stem) + tomenumber + ext
+            filename = src.with_name(name)
         else:
             filename = os.path.splitext(srcpath)[0] + tomenumber + ext
     if os.path.isfile(filename):
@@ -762,7 +763,7 @@ def getPanelViewSize(deviceres, size):
 def sanitizeTree(filetree):
     chapterNames = {}
     for root, dirs, files in os.walk(filetree, False):
-        for i, name in enumerate(natsorted(files)):
+        for i, name in enumerate(os_sorted(files)):
             splitname = os.path.splitext(name)
 
             # file needs kcc at front AND back to avoid renaming issues
@@ -1102,15 +1103,15 @@ def checkTools(source):
     source = source.upper()
     if source.endswith('.CB7') or source.endswith('.7Z') or source.endswith('.RAR') or source.endswith('.CBR') or \
             source.endswith('.ZIP') or source.endswith('.CBZ'):
-        process = Popen('7z', stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-        process.communicate()
-        if process.returncode != 0 and process.returncode != 7:
+        try:
+            subprocess_run_silent(['7z'], stdout=PIPE, stderr=STDOUT)
+        except FileNotFoundError:
             print('ERROR: 7z is missing!')
             sys.exit(1)
     if options.format == 'MOBI':
-        kindleGenExitCode = Popen('kindlegen -locale en', stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-        kindleGenExitCode.communicate()
-        if kindleGenExitCode.returncode != 0:
+        try:
+            subprocess_run_silent(['kindlegen', '-locale', 'en'], stdout=PIPE, stderr=STDOUT)
+        except FileNotFoundError:
             print('ERROR: KindleGen is missing!')
             sys.exit(1)
 
@@ -1266,10 +1267,9 @@ def makeMOBIWorker(item):
     kindlegenError = ''
     try:
         if os.path.getsize(item) < 629145600:
-            output = Popen('kindlegen -dont_append_source -locale en "' + item + '"',
-                           stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-            for line in output.stdout:
-                line = line.decode('utf-8')
+            output = subprocess_run_silent(['kindlegen', '-dont_append_source', '-locale', 'en', item],
+                           stdout=PIPE, stderr=STDOUT, encoding='UTF-8')
+            for line in output.stdout.splitlines():
                 # ERROR: Generic error
                 if "Error(" in line:
                     kindlegenErrorCode = 1
@@ -1280,7 +1280,6 @@ def makeMOBIWorker(item):
                 if kindlegenErrorCode > 0:
                     break
                 if ":I1036: Mobi file built successfully" in line:
-                    output.communicate()
                     break
         else:
             # ERROR: EPUB too big

kindlecomicconverter/comicarchive.py

@@ -22,11 +22,13 @@ import os
 import platform
 import subprocess
 import distro
-from psutil import Popen
 from shutil import move
 from subprocess import STDOUT, PIPE
 from xml.dom.minidom import parseString
 from xml.parsers.expat import ExpatError
+from .shared import subprocess_run_silent
+
+EXTRACTION_ERROR = 'Failed to extract archive. Try extracting file outside of KCC.'
 
 
 class ComicArchive:
@@ -35,66 +37,54 @@ class ComicArchive:
         self.type = None
         if not os.path.isfile(self.filepath):
             raise OSError('File not found.')
-        process = Popen('7z l -y -p1 "' + self.filepath + '"', stderr=STDOUT, stdout=PIPE, stdin=PIPE, shell=True)
-        for line in process.stdout:
+        process = subprocess_run_silent(['7z', 'l', '-y', '-p1', self.filepath], stderr=STDOUT, stdout=PIPE)
+        for line in process.stdout.splitlines():
             if b'Type =' in line:
                 self.type = line.rstrip().decode().split(' = ')[1].upper()
                 break
-        process.communicate()
         if process.returncode != 0 and distro.id() == 'fedora':
-            process = Popen('unrar l -y -p1 "' + self.filepath + '"', stderr=STDOUT, stdout=PIPE, stdin=PIPE, shell=True)
-            for line in process.stdout:
+            process = subprocess_run_silent(['unrar', 'l', '-y', '-p1', self.filepath], stderr=STDOUT, stdout=PIPE)
+            for line in process.stdout.splitlines():
                 if b'Details: ' in line:
                     self.type = line.rstrip().decode().split(' ')[1].upper()
                     break
-            process.communicate()
             if process.returncode != 0:
-                raise OSError(process.stdout.strip())
+                raise OSError(EXTRACTION_ERROR)
 
     def extract(self, targetdir):
         if not os.path.isdir(targetdir):
             raise OSError('Target directory doesn\'t exist.')
-        process = Popen('7z x -y -xr!__MACOSX -xr!.DS_Store -xr!thumbs.db -xr!Thumbs.db -o"' + targetdir + '" "' +
-                        self.filepath + '"', stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-        process.communicate()
+        process = subprocess_run_silent(['7z', 'x', '-y', '-xr!__MACOSX', '-xr!.DS_Store', '-xr!thumbs.db', '-xr!Thumbs.db', '-o' + targetdir, self.filepath],
+                                 stdout=PIPE, stderr=STDOUT)
         if process.returncode != 0 and distro.id() == 'fedora':
-            process = Popen('unrar x -y -x__MACOSX -x.DS_Store -xthumbs.db -xThumbs.db "' + self.filepath + '" "' +
-                    targetdir + '"', stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-            process.communicate()
+            process = subprocess_run_silent(['unrar', 'x', '-y', '-x__MACOSX', '-x.DS_Store', '-xthumbs.db', '-xThumbs.db', self.filepath, targetdir] 
+                    , stdout=PIPE, stderr=STDOUT)
             if process.returncode != 0:
-                raise OSError('Failed to extract archive.')
+                raise OSError(EXTRACTION_ERROR)
         elif process.returncode != 0 and platform.system() == 'Darwin':
-            process = subprocess.run(f"unar '{self.filepath}' -f -o '{targetdir}'", 
-                stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-            if process.returncode != 0:
-                raise Exception(process.stdout.decode("utf-8"))
+            process = subprocess_run_silent(['unar', self.filepath, '-f', '-o', targetdir], 
+                stdout=PIPE, stderr=STDOUT)
         elif process.returncode != 0:
-            raise OSError('Failed to extract archive. Check if p7zip-rar is installed.')
+            raise OSError(EXTRACTION_ERROR)
         tdir = os.listdir(targetdir)
         if 'ComicInfo.xml' in tdir:
             tdir.remove('ComicInfo.xml')
-        if len(tdir) == 1 and os.path.isdir(os.path.join(targetdir, tdir[0])):
-            for f in os.listdir(os.path.join(targetdir, tdir[0])):
-                move(os.path.join(targetdir, tdir[0], f), targetdir)
-            os.rmdir(os.path.join(targetdir, tdir[0]))
         return targetdir
 
     def addFile(self, sourcefile):
         if self.type in ['RAR', 'RAR5']:
             raise NotImplementedError
-        process = Popen('7z a -y "' + self.filepath + '" "' + sourcefile + '"',
-                        stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-        process.communicate()
+        process = subprocess_run_silent(['7z', 'a', '-y', self.filepath, sourcefile],
+                        stdout=PIPE, stderr=STDOUT)
         if process.returncode != 0:
             raise OSError('Failed to add the file.')
 
     def extractMetadata(self):
-        process = Popen('7z x -y -so "' + self.filepath + '" ComicInfo.xml',
-                        stdout=PIPE, stderr=STDOUT, stdin=PIPE, shell=True)
-        xml = process.communicate()
+        process = subprocess_run_silent(['7z', 'x', '-y', '-so', self.filepath, 'ComicInfo.xml'],
+                        stdout=PIPE, stderr=STDOUT)
         if process.returncode != 0:
-            raise OSError('Failed to extract archive.')
+            raise OSError(EXTRACTION_ERROR)
         try:
-            return parseString(xml[0])
+            return parseString(process.stdout)
         except ExpatError:
             return None

kindlecomicconverter/kindle.py

@@ -31,8 +31,7 @@ class Kindle:
     def findDevice(self):
         for drive in reversed(psutil.disk_partitions(False)):
             if (drive[2] == 'FAT32' and drive[3] == 'rw,removable') or \
-               (drive[2] == 'vfat' and 'rw' in drive[3]) or \
-               (drive[2] == 'msdos' and 'rw' in drive[3]):
+               (drive[2] in ('vfat', 'msdos', 'FAT') and 'rw' in drive[3]):
                 if os.path.isdir(os.path.join(drive[1], 'system')) and \
                         os.path.isdir(os.path.join(drive[1], 'documents')):
                     return drive[1]

kindlecomicconverter/shared.py

@@ -21,6 +21,7 @@
 import os
 from hashlib import md5
 from html.parser import HTMLParser
+import subprocess
 from distutils.version import StrictVersion
 from re import split
 import sys
@@ -135,3 +136,8 @@ def dependencyCheck(level):
     if len(missing) > 0:
         print('ERROR: ' + ', '.join(missing) + ' is not installed!')
         sys.exit(1)
+
+def subprocess_run_silent(command, **kwargs):
+    if (os.name == 'nt'):
+        kwargs.setdefault('creationflags', subprocess.CREATE_NO_WINDOW)
+    return subprocess.run(command, **kwargs)

requirements.txt

@@ -1,6 +1,7 @@
 PyQt5>=5.6.0
 Pillow>=5.2.0
 psutil>=5.0.0
+requests>=2.31.0
 python-slugify>=1.2.1
 raven>=6.0.0
 # PyQt5-tools

setup.py

@@ -80,7 +80,10 @@ setuptools.setup(
         'psutil>=5.0.0',
         'python-slugify>=1.2.1,<9.0.0',
         'raven>=6.0.0',
+        'requests>=2.31.0',
         'mozjpeg-lossless-optimization>=1.1.2',
+        'natsort[fast]>=8.4.0',
+        'distro',
     ],
     classifiers=[],
     zip_safe=False,