8 Commits

Author SHA1 Message Date
Yuvi9587
13c8380cca Update main_window.py 2025-07-10 10:01:29 -07:00
Yuvi9587
fa198c41c1 Commit 2025-07-10 09:59:51 -07:00
Yuvi9587
f214d2452e Update features.md 2025-07-08 13:14:46 +05:30
Yuvi9587
f39b510577 Update features.md 2025-07-08 13:03:24 +05:30
Yuvi9587
2c45c14696 Commit 2025-07-08 13:01:21 +05:30
Yuvi9587
aa2305c10e Commit 2025-07-07 14:10:52 +05:30
Yuvi9587
568c687f98 Update note.md 2025-07-06 17:34:04 +05:30
Yuvi9587
c8b77fb0d7 Commit 2025-07-05 06:02:21 +05:30
8 changed files with 530 additions and 612 deletions

View File

@@ -1,391 +1,190 @@
# Kemono Downloader - Detailed Feature Guide
# Kemono Downloader - Feature Guide
This guide provides a comprehensive overview of all user interface elements, input fields, buttons, popups, and functionalities available in the Kemono Downloader.
---
## Main Interface & Workflow
## 1. Main Interface & Workflow
These are the primary controls you'll interact with to initiate and manage downloads.
### 1. Main Inputs
- **🔗 Kemono Creator/Post URL Input Field:**
- **Purpose:** This is where you paste the URL of the content you want to download.
- **Usage:** Supports full URLs for:
- Kemono.su (and mirrors like kemono.party) creator pages (e.g., `https://kemono.su/patreon/user/12345`).
- Kemono.su (and mirrors) individual posts (e.g., `https://kemono.su/patreon/user/12345/post/98765`).
- Coomer.party (and mirrors like coomer.su) creator pages.
- Coomer.party (and mirrors) individual posts.
- **Note:**
- When **⭐ Favorite Mode** is active, this field is disabled and shows a "Favorite Mode active" message.
- This field can also be populated with a placeholder message (e.g., "{count} items in queue from popup") if posts are added to the download queue directly from the 'Creator Selection' dialog's 'Fetched Posts' view.
- **🎨 Creator Selection Button:**
- **Icon:** 🎨 (Artist Palette)
- **Location:** Next to the URL input field.
- **Purpose:** Opens the "Creator Selection" dialog to easily add multiple creators to the URL field.
- **Dialog Features:**
- Loads creators from your `creators.json` file (expected in the app's directory).
- **Search Bar:** Filter the list of creators by name.
- **Creator List:** Displays creators with their service (e.g., Patreon, Fanbox) and ID.
- **Selection:** Checkboxes to select one or more creators.
- **"Add Selected to URL" Button:** Adds the names of selected creators to the URL input field, comma-separated.
- **"Fetch Posts" Button:** After selecting creators, click this to retrieve their latest posts. This will display a new pane within the dialog showing the fetched posts.
- **"Download Scope" Radio Buttons (`Characters` / `Creators`):** Determines the folder structure for items added via this popup.
- `Characters`: Assumes creator names are character names for folder organization.
- `Creators`: Uses the actual creator names for folder organization.
- **Fetched Posts View (Right Pane - Appears after clicking 'Fetch Posts'):**
- **Posts Area Title Label:** Indicates loading status or number of fetched posts.
- **Posts Search Input:** Allows filtering the list of fetched posts by title.
- **Posts List Widget:** Displays posts fetched from the selected creators, often grouped by creator. Each post is checkable.
- **Select All / Deselect All Buttons (for Posts):** Convenience buttons for selecting/deselecting all displayed fetched posts.
- **"Add Selected Posts to Queue" Button:** Adds all checked posts from this view directly to the application's main download queue. The main URL input field will then show a message like "{count} items in queue from popup".
- **"Close" Button (for Posts View):** Hides the fetched posts view and returns to the creator selection list, allowing you to use the 'Add Selected to URL' button if preferred.
- **Page Range (Start to End) Input Fields:**
- **Purpose:** For creator URLs, specify a range of pages to fetch and process.
- **Usage:** Enter the starting page number in the first field and the ending page number in the second.
- **Behavior:**
- If left blank, all pages for the creator are typically processed (or up to a reasonable limit).
- Disabled for single post URLs or when **📖 Manga/Comic Mode** is active (as manga mode fetches all posts for chronological sorting).
- **📁 Download Location Input Field & Browse Button:**
- **Purpose:** Specify the main directory where all downloaded files and folders will be saved.
- **Usage:**
- Type or paste the path directly into the field.
- Click the **"Browse..."** button to open a system dialog to select a folder.
- **Requirement:** This field must be filled unless you are using the "🔗 Only Links" filter mode.
### 2. Action Buttons
- **⬇️ Start Download / 🔗 Extract Links Button:**
- **Purpose:** The primary action button to begin the downloading or link extraction process based on current settings.
- **Behavior:**
- If "🔗 Only Links" filter is selected, the button text changes to **"🔗 Extract Links"** and it will only gather external links from posts.
- Otherwise, it reads **"⬇️ Start Download"** and initiates the content download.
- **⏸️ Pause / ▶️ Resume Download Button:**
- **Purpose:** Temporarily halt or continue the ongoing download/extraction process.
- **Behavior:**
- When active, the button shows **"⏸️ Pause Download"**. Clicking it pauses the operation.
- When paused, the button shows **"▶️ Resume Download"**. Clicking it resumes from where it left off.
- Some UI settings can be changed while paused (e.g., filter adjustments), which will apply upon resuming.
- **❌ Cancel & Reset UI Button:**
- **Purpose:** Immediately stops the current download/extraction operation and performs a "soft" reset of the UI.
- **Behavior:**
- Halts all active threads and processes.
- Clears progress information and logs.
- Preserves the content of the "🔗 Kemono Creator/Post URL" and "📁 Download Location" input fields. Other settings are reset to their defaults.
- **🔄 Reset Button (located in the log area):**
- **Purpose:** Performs a "hard" reset of the UI when no operation is active.
- **Behavior:**
- Clears all input fields (including URL and Download Location).
- Resets all filter settings and options to their default values.
- Clears the log area.
---
## Filtering & Content Selection
These options allow you to precisely control what content is downloaded or skipped.
- **🎯 Filter by Character(s) Input Field:**
- **Purpose:** Download content related to specific characters.
- **Usage:** Enter character names, comma-separated.
- **Advanced Syntax:**
- `Nami`: Simple character filter. Matches "Nami".
- `(Vivi, Ulti, Uta)`: Grouped characters. Matches "Vivi" OR "Ulti" OR "Uta". If "Separate Folders" is on, creates a shared folder for the session (e.g., "Vivi Ulti Uta"). Adds "Vivi", "Ulti", "Uta" as *separate* entries to `Known.txt` if new.
- `(Boa, Hancock)~`: Aliased characters. Matches "Boa" OR "Hancock" but treats them as the same entity. If "Separate Folders" is on, creates a shared folder (e.g., "Boa Hancock"). Adds "Boa Hancock" as a *single group entry* to `Known.txt` if new, with "Boa" and "Hancock" as its aliases.
- **Filter: [Type] Button (Scope for Character Filter):**
- **Location:** Next to the "Filter by Character(s)" input.
- **Purpose:** Defines how the character filter is applied. Cycles through options on click.
- **Options:**
- `Filter: Files`: Checks individual filenames against the character filter. Only matching files from a post are downloaded.
- `Filter: Title` (Default): Checks post titles against the character filter. If the title matches, all files from that post are downloaded.
- `Filter: Both`: Checks the post title first. If no match, then checks individual filenames within that post.
- `Filter: Comments (Beta)`: Checks filenames first. If no file match, then checks post comments/description. (Note: This may use more API requests).
- **🚫 Skip with Words Input Field:**
- **Purpose:** Exclude posts or files containing specified keywords.
- **Usage:** Enter words or phrases, comma-separated (e.g., `WIP, sketch, preview`).
- **Scope: [Type] Button (Scope for Skip with Words):**
- **Location:** Next to the "Skip with Words" input.
- **Purpose:** Defines how the skip words are applied. Cycles through options on click.
- **Options:**
- `Scope: Files`: Skips individual files if their names contain any of the skip words.
- `Scope: Posts` (Default): Skips entire posts if their titles contain any of the skip words.
- `Scope: Both`: Checks the post title first. If no skip words match, then checks individual filenames.
- **✂️ Remove Words from name Input Field:**
- **Purpose:** Clean up downloaded filenames by removing specified unwanted words or phrases.
- **Usage:** Enter words or phrases, comma-separated (e.g., `patreon, [HD], kemono`).
- **Filter Files (Radio Buttons):**
- **Purpose:** Select the types of files to download.
- **Options:**
- `All`: Download all file types attached to posts.
- `Images/GIFs`: Download only common image formats (JPG, PNG, GIF, WebP, etc.).
- `Videos`: Download only common video formats (MP4, MOV, MKV, WebM, etc.).
- `📦 Only Archives`: Exclusively download `.zip` and `.rar` files. This mode disables the "Skip .zip/.rar" checkboxes and the "Show External Links in Log" feature.
- `🎧 Only Audio`: Download only common audio formats (MP3, WAV, FLAC, OGG, etc.).
- `🔗 Only Links`: Do not download any files. Instead, extract and display external links found in post descriptions in the log area. The main action button changes to "🔗 Extract Links".
- **Skip .zip / Skip .rar Checkboxes:**
- **Purpose:** Individually choose to skip downloading `.zip` files or `.rar` files.
- **Behavior:** Disabled if the "📦 Only Archives" filter is active.
---
## Download Customization
Options to further refine the download process and output.
- **Download Thumbnails Only Checkbox:**
- **Purpose:** Download only the small preview images (thumbnails) provided by the API, instead of full-resolution files.
- **Behavior:** If "**Scan Content for Images**" is also active, this option's behavior changes: *only* images found by the content scan (embedded `<img>` tags) are downloaded as thumbnails (API thumbnails are ignored).
- **Scan Content for Images Checkbox:**
- **Purpose:** Actively scan the HTML content of posts for `<img>` tags and direct image links. This is crucial for downloading images embedded in post descriptions that are not listed as direct attachments in the API response.
- **Behavior:** Resolves relative image paths to absolute URLs for downloading.
- **Compress to WebP Checkbox:**
- **Purpose:** Convert downloaded images to WebP format to potentially save disk space.
- **Requirement:** Requires the `Pillow` library to be installed.
- **Behavior:** Attempts to convert images larger than a certain threshold (e.g., 1.5MB) to WebP if the WebP version is significantly smaller. Original files are not kept if conversion is successful.
- **🗄️ Custom Folder Name (Single Post Only) Input Field:**
- **Purpose:** When downloading a single post URL, allows you to specify a custom name for the folder where its contents will be saved.
- **Visibility:** Only appears if:
1. A single post URL is entered in the main URL field.
2. The "**Separate Folders by Name/Title**" option is enabled.
---
## 📖 Manga/Comic Mode
Specialized mode for downloading creator feeds in a way suitable for sequential reading, like manga or comics. This mode is implicitly active when downloading from a creator URL and certain filename styles are chosen.
- **Activation:** Primarily by downloading a creator's feed (not a single post) and selecting a relevant "Filename Style".
- **Core Behavior:** Processes and downloads posts from the creator's feed in chronological order (oldest to newest). The "Page Range" input is typically disabled as all posts are fetched for correct sorting.
- **Filename Style Toggle Button (located in the log area):**
- **Purpose:** Controls how files are named when downloading in a manga/comic-like fashion. Cycles through options on click.
- **Options:**
- `Name: Post Title` (Default for non-manga): The first file in a post is named after the post title; subsequent files in the *same post* keep their original names.
- `Name: Original File`: All downloaded files attempt to keep their original filenames as provided by the server. An optional "Filename Prefix" input field appears.
- `Name: Title+G.Num`: (Global Numbering) All files across all downloaded posts for the creator get a prefix from their respective post's title, followed by a global sequential number (e.g., `Chapter 1_001.jpg`, `Chapter 1_002.jpg`, `Chapter 2_003.jpg`). This ensures strict order across posts. Disables post-level multithreading for sequential numbering.
- `Name: Date Based`: Files are named sequentially (e.g., `001.jpg`, `002.jpg`) based on the post's publication date. An optional "Filename Prefix" input field appears. Disables post-level multithreading.
- **Optional Filename Prefix Input Field (Manga Mode):**
- **Visibility:** Appears when "Filename Style" is set to `Name: Original File` or `Name: Date Based`.
- **Purpose:** Allows you to add a custom prefix to all filenames generated using these styles (e.g., `MySeries_001.jpg`).
---
## Folder Organization
Controls for how downloaded content is structured into folders.
- **Separate Folders by Name/Title Checkbox:**
- **Purpose:** Creates subfolders within the main "Download Location" based on matching criteria.
- **Behavior:**
- If "**Filter by Character(s)**" is used, folders are named after the matched character(s)/group(s).
- If no character filter matches (or no filter is active), but the post title matches an entry in `Known.txt`, a folder named after the `Known.txt` entry is created.
- If neither of the above, and this option is checked, folders might be created based on post titles directly (behavior can vary).
- **Subfolder per Post Checkbox:**
- **Purpose:** Creates an additional layer of subfolders, where each individual post's content goes into its own subfolder.
- **Behavior:** Only active if "**Separate Folders by Name/Title**" is also checked. The post subfolder will be created *inside* the character/title folder. Folder names are typically derived from sanitized post titles or IDs.
- **`Known.txt` Management UI (Bottom Left of UI):**
- **Purpose:** Manages a local list (`Known.txt` file in the app directory) of series, characters, or general terms used for automatic folder organization and character filter suggestions.
- **Elements:**
- **List Display:** Shows the primary names from your `Known.txt` file.
- **Add New Input Field:** Enter a new name or group to add to `Known.txt`.
- Simple Name: e.g., `My Series`
- Group (creates separate entries in `Known.txt`): e.g., `(Vivi, Ulti, Uta)`
- Group with Aliases (single entry in `Known.txt` with `~`): e.g., `(Boa, Hancock)~`
- ** Add Button:** Adds the entry from the "Add New" field to `Known.txt` and refreshes the list.
- **⤵️ Add to Filter Button:** Opens a dialog displaying all entries from `Known.txt` (with a search bar). Select one or more entries to add them to the "**🎯 Filter by Character(s)**" input field. Grouped names from `Known.txt` are added with the `~` syntax if applicable.
- **🗑️ Delete Selected Button:** Removes the currently selected name(s) from the list display and from the `Known.txt` file.
- **Open Known.txt Button:** Opens your `Known.txt` file in the system's default text editor for manual editing.
- **❓ Help Button:** Opens a guide or tooltip explaining the app feature
---
## ⭐ Favorite Mode (Kemono.su Only)
Download directly from your favorited artists and posts on Kemono.su.
- **Enable Checkbox ("⭐ Favorite Mode"):**
- **Location:** Usually near the "🔗 Only Links" filter option.
- **Purpose:** Switches the downloader to operate on your Kemono.su favorites.
- **UI Changes upon Enabling:**
- The "🔗 Kemono Creator/Post URL" input field is disabled/replaced with a "Favorite Mode active" message.
- The main action buttons change to "**🖼️ Favorite Artists**" and "**📄 Favorite Posts**".
- The "**🍪 Use Cookie**" option is automatically enabled and locked, as cookies are required to access your favorites.
- **🖼️ Favorite Artists Button & Dialog:**
- **Purpose:** Fetches and allows you to download content from artists you have favorited on Kemono.su.
- **Dialog Features:**
- Fetches the list of your favorited artists.
- **Search Bar:** Filter artists by name.
- **Artist List:** Displays favorited artists.
- **Select All / Deselect All:** Convenience buttons for selection.
- **"Download Selected" Button:** Queues all posts from the selected artists for download, respecting current filter settings.
- **📄 Favorite Posts Button & Dialog:**
- **Purpose:** Fetches and allows you to download specific posts you have favorited on Kemono.su.
- **Dialog Features:**
- Fetches the list of your favorited posts, usually grouped by artist and sorted by date.
- **Search Bar:** Filter posts by title, creator name, ID, or service.
- **Post List:** Displays favorited posts. Known names from your `Known.txt` may be highlighted in post titles for easier identification.
- **Select All / Deselect All:** Convenience buttons for selection.
- **"Download Selected" Button:** Queues the selected individual posts for download, respecting current filter settings.
- **Favorite Download Scope Button (Location may vary, often near Favorite Posts button):**
- **Purpose:** Determines the folder structure for downloads initiated via Favorite Mode.
- **Options:**
- `Scope: Selected Location`: All selected favorites (artists or posts) are downloaded directly into the main "📁 Download Location". Global filters apply.
- `Scope: Artist Folders`: A subfolder is created for each artist within the main "📁 Download Location" (e.g., `DownloadLocation/ArtistName/`). Content from that artist (whether a full artist download or specific favorited posts from them) goes into their respective subfolder. Filters apply within each artist's context.
---
## Advanced & Performance
- **🍪 Cookie Management:**
- **Use Cookie Checkbox:** Enables the use of browser cookies for accessing content that might be restricted or require login (e.g., certain posts, Favorite Mode).
- **Cookie Text Field:**
- **Purpose:** Directly paste your cookie string.
- **Format:** Standard HTTP cookie string format (e.g., `name1=value1; name2=value2`).
- **Browse... Button (for Cookies):**
- **Purpose:** Select a `cookies.txt` file from your system.
- **Format:** Must be in Netscape cookie file format.
- **Behavior:**
- The text field takes precedence if filled.
- If "Use Cookie" is checked and both the text field and browsed file path are empty, the application will attempt to automatically load a `cookies.txt` file from its root directory.
- **Use Multithreading Checkbox & Threads Input Field:**
- **Purpose:** Enable and configure the number of simultaneous operations to potentially speed up downloads.
- **Behavior:**
- **Creator Feeds:** The "Threads" input controls how many posts are processed concurrently.
- **Single Post URLs:** The "Threads" input controls how many files from that single post are downloaded concurrently.
- **Note:** Setting too high a number might lead to API rate-limiting or instability.
- **Multi-part Download Toggle Button (located in the log area):**
- **Purpose:** Enables/disables multi-segment downloading for individual large files.
- **Options:**
- `Multi-part: ON`: Large files are split into multiple parts that are downloaded simultaneously and then reassembled. Can significantly speed up downloads for single large files but may increase UI choppiness or log spam with many small files.
- `Multi-part: OFF` (Default): Files are downloaded as a single stream.
- **Behavior:** Disabled if "🔗 Only Links" or "📦 Only Archives" mode is active.
---
## Logging & Monitoring
- **📜 Progress Log / Extracted Links Log Area:**
- **Purpose:** The main text area displaying detailed messages about the ongoing process.
- **Content:** Shows download progress for each file, errors encountered, skipped items, summary information, or extracted links (if in "🔗 Only Links" mode).
- **👁️ / 🙈 Log View Toggle Button:**
- **Purpose:** Switches the content displayed in the main log area.
- **Views:**
- `👁️ Progress Log` (Default): Shows all download activity, errors, and general progress messages.
- `🙈 Missed Character Log`: Shows a list of key terms intelligently extracted from post titles or content that were skipped due to the "**🎯 Filter by Character(s)**" not matching. Useful for identifying characters you might want to add to your filter or `Known.txt`.
- **Show External Links in Log Checkbox & Panel:**
- **Purpose:** If checked, a secondary, smaller log panel appears (usually below the main log) that specifically displays any external links (e.g., to Mega, Google Drive) found in post descriptions.
- **Behavior:** Disabled if "🔗 Only Links" or "📦 Only Archives" mode is active (as "Only Links" uses the main log, and archives typically don't have such external links processed).
- **Export Links Button:**
- **Visibility:** Appears when the "**🔗 Only Links**" filter mode is active.
- **Purpose:** Saves all the links extracted and displayed in the main log area to a `.txt` file.
- **Progress Labels/Bars:**
- **Purpose:** Provide a visual and textual representation of the download progress.
- **Typically Includes:**
- Overall post progress (e.g., "Post 5 of 20").
- Individual file download status (e.g., "Downloading file.zip... 50% at 1.2 MB/s").
- Summary statistics at the end of a session (total downloaded, skipped, failed).
---
## Error Handling & Retries
- **🆘 Error Button (Main UI):**
- **Location:** Typically near the main action buttons (e.g., Start, Pause, Cancel).
- **Purpose:** Becomes active if files failed to download during the last session (and were not successfully retried). Clicking it opens the "Files Skipped Due to Errors" dialog.
- **"Files Skipped Due to Errors" Dialog:**
- **File List:** Displays a list of files that encountered download errors. Each entry shows the filename, the post it was from (title and ID).
- **Checkboxes:** Allows selection of individual files from the list.
- **"Select All" Button:** Checks all files in the list.
- **"Retry Selected" Button:** Attempts to re-download all checked files.
- **"Export URLs to .txt" Button:**
- Opens an "Export Options" dialog.
- **"Link per line (URL only)":** Exports only the direct download URL for each failed file, one URL per line.
- **"Export with details (URL [Post, File info])":** Exports the URL followed by details like Post Title, Post ID, and Original Filename in brackets.
- Prompts the user to save the generated `.txt` file.
- **"OK" Button:** Closes the dialog.
- **Note:** Files successfully retried or skipped due to hash match during a retry attempt are removed from this error list.
---
## ⚙️ Application Settings
These settings allow you to customize the application's appearance and language.
- **⚙️ Settings Button (Icon may vary, e.g., a gear ⚙️):**
- **Location:** Typically located in a persistent area of the UI, possibly near other global controls or in a menu.
- **Purpose:** Opens the "Settings" dialog.
- **Tooltip Example:** "Open application settings (Theme, Language, etc.)"
- **"Settings" Dialog:**
- **Title:** "Settings"
- **Purpose:** Provides options to configure application-wide preferences.
- **Sections:**
- **Appearance Group (`Appearance`):**
- **Theme Toggle Buttons/Options:**
- `Switch to Light Mode`
- `Switch to Dark Mode`
- **Purpose:** Allows users to switch between a light and dark visual theme for the application.
- **Tooltips:** Provide guidance on switching themes.
- **Language Settings Group (`Language Settings`):**
- **Language Selection Dropdown/List:**
- **Label:** "Language:"
- **Options:** Includes, but not limited to:
- English (`English`)
- 日本語 (`日本語 (Japanese)`)
- Français (French)
- Español (Spanish)
- Deutsch (German)
- Русский (Russian)
- 한국어 (Korean)
- 简体中文 (Chinese Simplified)
- **Purpose:** Allows users to change the display language of the application interface.
- **Restart Prompt:** After changing the language, a dialog may appear:
- **Title:** "Language Changed"
- **Message:** "The language has been changed. A restart is required for all changes to take full effect."
- **Informative Text:** "Would you like to restart the application now?"
- **Buttons:** "Restart Now", "OK" (or similar to defer restart).
- **"OK" Button:** Saves the changes made in the Settings dialog and closes it.
---
## Other UI Elements
- **Retry Failed Downloads Prompt:**
- **Trigger:** Appears at the end of a download session if there were files that failed to download due to recoverable errors (e.g., network interruption, IncompleteRead).
- **Action:** Prompts the user if they want to attempt downloading the failed files again.
- **New Name Confirmation Dialog (for Character Filter & `Known.txt`):**
- **Trigger:** When new, unrecognized names or groups are used in the "**🎯 Filter by Character(s)**" field that are not present in `Known.txt`.
- **Action:** Prompts the user to confirm if they want to add these new names/groups to `Known.txt` with the appropriate formatting (simple, grouped, or aliased).
- **Onboarding Tour / Help Guide Button (❓):**
- **Purpose:** Opens a built-in help guide or an onboarding tour that explains the basic functionalities and UI elements of the application. Often linked to this detailed feature guide.
---
This guide should cover all interactive elements of the Kemono Downloader. If you have further questions or discover elements not covered, please refer to the main `readme.md` or consider opening an issue on the project's repository.
### 1.1. Core Inputs
**🔗 Creator/Post URL Input Field**
- **Purpose**: Paste the URL of the content you want to download.
- **Supported Sites**: Kemono.su, Coomer.party, Simpcity.su.
- **Supported URL Types**:
- Creator pages (e.g., `https://kemono.su/patreon/user/12345`).
- Individual posts (e.g., `https://kemono.su/patreon/user/12345/post/98765`).
- **Note**: When ⭐ Favorite Mode is active, this field is disabled. For Simpcity.su URLs, the "Use Cookie" option is mandatory and auto-enabled.
**🎨 Creator Selection Button**
- **Icon**: 🎨 (Artist Palette)
- **Purpose**: Opens the "Creator Selection" dialog to browse and queue downloads from known creators.
- **Dialog Features**:
- Loads creators from `creators.json`.
- **Search Bar**: Filter creators by name.
- **Creator List**: Displays creators with their service (e.g., Patreon, Fanbox).
- **Selection**: Checkboxes to select one or more creators.
- **Download Scope**: Organize downloads by Characters or Creators.
- **Add to Queue**: Adds selected creators or their posts to the download queue.
**Page Range (Start to End) Input Fields**
- **Purpose**: Specify a range of pages to fetch for creator URLs.
- **Usage**: Enter the starting and ending page numbers.
- **Behavior**:
- If blank, all pages are processed.
- Disabled for single post URLs.
**📁 Download Location Input Field & Browse Button**
- **Purpose**: Specify the main directory for downloaded files.
- **Usage**: Type the path or click "Browse..." to select a folder.
- **Requirement**: Mandatory for all download operations.
### 1.2. Action Buttons
**⬇️ Start Download / 🔗 Extract Links Button**
- **Purpose**: Initiates downloading or link extraction.
- **Behavior**:
- Shows "🔗 Extract Links" if "Only Links" is selected.
- Otherwise, shows "⬇️ Start Download".
- Supports single-threaded or multi-threaded downloads based on settings.
**🔄 Restore Download Button**
- **Visibility**: Appears if an incomplete session is detected on startup.
- **Purpose**: Resumes a previously interrupted download session.
**⏸️ Pause / ▶️ Resume Download Button**
- **Purpose**: Pause or resume the ongoing download.
- **Behavior**: Toggles between "Pause" and "Resume". Some UI settings can be changed while paused.
**❌ Cancel & Reset UI Button**
- **Purpose**: Stops the current operation and performs a "soft" reset.
- **Behavior**: Halts background threads, preserves URL and Download Location inputs, resets other settings.
**🔄 Reset Button (in the log area)**
- **Purpose**: Performs a "hard" reset when no operation is active.
- **Behavior**: Clears all inputs, resets options to default, and clears logs.
## 2. Filtering & Content Selection
These options allow precise control over downloaded content.
### 2.1. Content Filtering
**🎯 Filter by Character(s) Input Field**
- **Purpose**: Download content related to specific characters or series.
- **Usage**: Enter comma-separated character names.
- **Advanced Syntax**:
- `Nami`: Simple filter.
- `(Vivi, Ulti)`: Grouped filter. Matches posts with "Vivi" OR "Ulti". Creates a shared folder like `Vivi Ulti` if subfolders are enabled.
- `(Boa, Hancock)~`: Aliased filter. Treats "Boa" and "Hancock" as the same entity.
**Filter: [Type] Button (Character Filter Scope)**
- **Purpose**: Defines where the character filter is applied. Cycles on click.
- **Options**:
- **Filter: Title** (Default): Matches post titles.
- **Filter: Files**: Matches filenames.
- **Filter: Both**: Checks title first, then filenames.
- **Filter: Comments (Beta)**: Checks filenames, then post comments.
**🚫 Skip with Words Input Field**
- **Purpose**: Exclude posts/files with specified keywords (e.g., `WIP`, `sketch`).
**Scope: [Type] Button (Skip Words Scope)**
- **Purpose**: Defines where skip words are applied. Cycles on click.
- **Options**:
- **Scope: Posts** (Default): Skips posts if the title contains a skip word.
- **Scope: Files**: Skips files if the filename contains a skip word.
- **Scope: Both**: Applies both rules.
**✂️ Remove Words from Name Input Field**
- **Purpose**: Remove unwanted text from filenames (e.g., `patreon`, `[HD]`).
### 2.2. File Type Filtering
**Filter Files (Radio Buttons)**
- **Purpose**: Select file types to download.
- **Options**:
- **All**: All file types.
- **Images/GIFs**: Common image formats.
- **Videos**: Common video formats.
- **🎧 Only Audio**: Common audio formats.
- **📦 Only Archives**: Only `.zip` and `.rar` files.
- **🔗 Only Links**: Extracts external links without downloading files.
**Skip .zip / Skip .rar Checkboxes**
- **Purpose**: Skip downloading `.zip` or `.rar` files.
- **Behavior**: Disabled when "📦 Only Archives" is active.
## 3. Download Customization
Options to refine the download process and output.
- **Download Thumbnails Only**: Downloads small preview images instead of full-resolution files.
- **Scan Content for Images**: Scans post HTML for `<img>` tags, crucial for images in descriptions.
- **Compress to WebP**: Converts images to WebP format (requires Pillow library).
- **🗄️ Custom Folder Name (Single Post Only)**: Specify a custom folder name for a single post's content (appears if subfolders are enabled).
## 4. 📖 Manga/Comic Mode
A mode for downloading creator feeds in chronological order, ideal for sequential content.
- **Activation**: Active when downloading a creator's entire feed (not a single post).
- **Core Behavior**: Fetches all posts, processing from oldest to newest.
- **Filename Style Toggle Button (in the log area)**:
- **Purpose**: Controls file naming in Manga Mode. Cycles on click.
- **Options**:
- **Name: Post Title**: First file named after post title; others keep original names.
- **Name: Original File**: Files keep server-provided names, with optional prefix.
- **Name: Title+G.Num**: Global numbering with post title prefix (e.g., `Chapter 1_001.jpg`).
- **Name: Date Based**: Sequential naming by post date (e.g., `001.jpg`), with optional prefix.
- **Name: Post ID**: Files named after post ID to avoid clashes.
- **Name: Date + Title**: Combines post date and title for filenames.
## 5. Folder Organization & Known.txt
Controls for structuring downloaded content.
- **Separate Folders by Name/Title Checkbox**: Enables automatic subfolder creation.
- **Subfolder per Post Checkbox**: Creates subfolders for each post, named after the post title.
- **Known.txt Management UI (Bottom Left)**:
- **Purpose**: Manages a local `Known.txt` file for series, characters, or terms used in folder creation.
- **List Display**: Shows primary names from `Known.txt`.
- ** Add Button**: Adds names or groups (e.g., `(Character A, Alias B)~`).
- **⤵️ Add to Filter Button**: Select names from `Known.txt` for the character filter.
- **🗑️ Delete Selected Button**: Removes selected names from `Known.txt`.
- **Open Known.txt Button**: Opens the file in the default text editor.
- **❓ Help Button**: Opens this feature guide.
- **📜 History Button**: Views recent download history.
## 6. ⭐ Favorite Mode (Kemono.su Only)
Download from favorited artists/posts on Kemono.su.
- **Enable Checkbox ("⭐ Favorite Mode")**:
- Switches to Favorite Mode.
- Disables the main URL input.
- Changes action buttons to "Favorite Artists" and "Favorite Posts".
- Requires cookies.
- **🖼️ Favorite Artists Button**: Select and download from favorited artists.
- **📄 Favorite Posts Button**: Select and download specific favorited posts.
- **Favorite Download Scope Button**:
- **Scope: Selected Location**: Downloads favorites to the main directory.
- **Scope: Artist Folders**: Creates subfolders per artist.
## 7. Advanced Settings & Performance
- **🍪 Cookie Management**:
- **Use Cookie Checkbox**: Enables cookies for restricted content.
- **Cookie Text Field**: Paste cookie string.
- **Browse... Button**: Select a `cookies.txt` file (Netscape format).
- **Use Multithreading Checkbox & Threads Input**:
- **Purpose**: Configures simultaneous operations.
- **Behavior**: Sets concurrent post processing (creator feeds) or file downloads (single posts).
- **Multi-part Download Toggle Button**:
- **Purpose**: Enables/disables multi-segment downloading for large files.
- **Note**: Best for large files; less efficient for small files.
## 8. Logging, Monitoring & Error Handling
- **📜 Progress Log Area**: Displays messages, progress, and errors.
- **👁️ / 🙈 Log View Toggle Button**: Switches between Progress Log and Missed Character Log (skipped posts).
- **Show External Links in Log**: Displays external links (e.g., Mega, Google Drive) in a secondary panel.
- **Export Links Button**: Saves extracted links to a `.txt` file in "Only Links" mode.
- **Download Extracted Links Button**: Downloads files from supported external links in "Only Links" mode.
- **🆘 Error Button & Dialog**:
- **Purpose**: Active if files fail to download.
- **Dialog Features**:
- Lists failed files.
- Retry failed downloads.
- Export failed URLs to a text file.
## 9. Application Settings (⚙️)
- **Appearance**: Switch between Light and Dark themes.
- **Language**: Change UI language (restart required).

29
main.py
View File

@@ -9,24 +9,26 @@ from PyQt5.QtWidgets import QApplication, QDialog
from PyQt5.QtCore import QCoreApplication
# --- Local Application Imports ---
# These imports reflect the new, organized project structure.
from src.ui.main_window import DownloaderApp
from src.ui.dialogs.TourDialog import TourDialog
from src.config.constants import CONFIG_ORGANIZATION_NAME, CONFIG_APP_NAME_MAIN
# --- Define APP_BASE_DIR globally and make available early ---
if getattr(sys, 'frozen', False) and hasattr(sys, '_MEIPASS'):
APP_BASE_DIR = sys._MEIPASS
else:
APP_BASE_DIR = os.path.abspath(os.path.dirname(__file__))
# Optional: Set a global variable or pass it into modules if needed
# Or re-export it via constants.py for cleaner imports
def handle_uncaught_exception(exc_type, exc_value, exc_traceback):
"""
Handles uncaught exceptions by logging them to a file for easier debugging,
especially for bundled applications.
"""
# Determine the base directory for logging
if getattr(sys, 'frozen', False):
base_dir_for_log = os.path.dirname(sys.executable)
else:
base_dir_for_log = os.path.dirname(os.path.abspath(__file__))
log_dir = os.path.join(base_dir_for_log, "logs")
# Use APP_BASE_DIR to determine logging location
log_dir = os.path.join(APP_BASE_DIR, "logs")
log_file_path = os.path.join(log_dir, "uncaught_exceptions.log")
try:
@@ -57,41 +59,35 @@ def main():
qt_app = QApplication(sys.argv)
# Create the main application window from its new module
# Create the main application window
downloader_app_instance = DownloaderApp()
# --- Window Sizing and Positioning ---
# Logic moved from the old main.py to set an appropriate initial size
primary_screen = QApplication.primaryScreen()
if not primary_screen:
# Fallback for systems with no primary screen detected
downloader_app_instance.resize(1024, 768)
else:
available_geo = primary_screen.availableGeometry()
screen_width = available_geo.width()
screen_height = available_geo.height()
# Define minimums and desired ratios
min_app_width, min_app_height = 960, 680
desired_width_ratio, desired_height_ratio = 0.80, 0.85
app_width = max(min_app_width, int(screen_width * desired_width_ratio))
app_height = max(min_app_height, int(screen_height * desired_height_ratio))
# Ensure the window is not larger than the screen
app_width = min(app_width, screen_width)
app_height = min(app_height, screen_height)
downloader_app_instance.resize(app_width, app_height)
# Show the main window and center it
# Show and center the main window
downloader_app_instance.show()
if hasattr(downloader_app_instance, '_center_on_screen'):
downloader_app_instance._center_on_screen()
# --- First-Run Welcome Tour ---
# Check if the tour should be shown and run it.
# This static method call keeps the logic clean and contained.
if TourDialog.should_show_tour():
tour_dialog = TourDialog(parent_app=downloader_app_instance)
tour_dialog.exec_()
@@ -102,7 +98,6 @@ def main():
sys.exit(exit_code)
except SystemExit:
# Allow sys.exit() to work as intended
pass
except Exception as e:
print("--- CRITICAL APPLICATION STARTUP ERROR ---")

View File

@@ -13,10 +13,9 @@ This project used to be one giant messy App Script. It worked, but it was hard t
```
KemonoDownloader/
├── main.py # Where the app starts
├── requirements.txt # List of Python libraries used
├── assets/ # Icons and other static files
│ └── Kemono.ico
├── data/ # Stuff that gets saved (user config, cookies, etc.)
├── data/
│ └── creators.json
├── logs/ # Error logs and other output
│ └── uncaught_exceptions.log

View File

@@ -1,4 +1,4 @@
<h1 align="center">Kemono Downloader v5.5.0</h1>
<h1 align="center">Kemono Downloader v5.6.0</h1>
<table align="center">
<tr>

View File

@@ -9,6 +9,7 @@ STYLE_ORIGINAL_NAME = "original_name"
STYLE_DATE_BASED = "date_based"
STYLE_DATE_POST_TITLE = "date_post_title"
STYLE_POST_TITLE_GLOBAL_NUMBERING = "post_title_global_numbering"
STYLE_POST_ID = "post_id" # Add this line
MANGA_DATE_PREFIX_DEFAULT = ""
# --- Download Scopes ---
@@ -94,6 +95,7 @@ FOLDER_NAME_STOP_WORDS = {
"me", "my", "net", "not", "of", "on", "or", "org", "our",
"s", "she", "so", "the", "their", "they", "this",
"to", "ve", "was", "we", "were", "with", "www", "you", "your",
# add more according to need
}
# Additional words to ignore specifically for creator-level downloads
@@ -107,4 +109,5 @@ CREATOR_DOWNLOAD_DEFAULT_FOLDER_IGNORE_WORDS = {
"oct", "october", "nov", "november", "dec", "december",
"mon", "monday", "tue", "tuesday", "wed", "wednesday", "thu", "thursday",
"fri", "friday", "sat", "saturday", "sun", "sunday"
# add more according to need
}

View File

@@ -77,6 +77,7 @@ class PostProcessorWorker:
scan_content_for_images =False ,
creator_download_folder_ignore_words =None ,
manga_global_file_counter_ref =None ,
use_date_prefix_for_subfolder=False,
session_file_path=None,
session_lock=None,
):
@@ -128,6 +129,7 @@ class PostProcessorWorker:
self .override_output_dir =override_output_dir
self .scan_content_for_images =scan_content_for_images
self .creator_download_folder_ignore_words =creator_download_folder_ignore_words
self.use_date_prefix_for_subfolder = use_date_prefix_for_subfolder
self.session_file_path = session_file_path
self.session_lock = session_lock
if self .compress_images and Image is None :
@@ -167,6 +169,7 @@ class PostProcessorWorker:
if self .dynamic_filter_holder :
return self .dynamic_filter_holder .get_filters ()
return self .filter_character_list_objects_initial
def _download_single_file (self ,file_info ,target_folder_path ,headers ,original_post_id_for_log ,skip_event ,
post_title ="",file_index_in_post =0 ,num_files_in_this_post =1 ,
manga_date_file_counter_ref =None ,
@@ -273,6 +276,15 @@ class PostProcessorWorker:
self .logger (f"⚠️ Manga Title+GlobalNum Mode: Counter ref not provided or malformed for '{api_original_filename }'. Using original. Ref: {manga_global_file_counter_ref }")
filename_to_save_in_main_path =cleaned_original_api_filename
self .logger (f"⚠️ Manga mode (Title+GlobalNum Style Fallback): Using cleaned original filename '{filename_to_save_in_main_path }' for post {original_post_id_for_log }.")
elif self.manga_filename_style == STYLE_POST_ID:
if original_post_id_for_log and original_post_id_for_log != 'unknown_id':
base_name = str(original_post_id_for_log)
# Always append the file index for consistency (e.g., xxxxxx_0, xxxxxx_1)
filename_to_save_in_main_path = f"{base_name}_{file_index_in_post}{original_ext}"
else:
# Fallback if post_id is somehow not available
self.logger(f"⚠️ Manga mode (Post ID Style): Post ID missing. Using cleaned original filename '{cleaned_original_api_filename}'.")
filename_to_save_in_main_path = cleaned_original_api_filename
elif self .manga_filename_style ==STYLE_DATE_POST_TITLE :
published_date_str =self .post .get ('published')
added_date_str =self .post .get ('added')
@@ -717,7 +729,6 @@ class PostProcessorWorker:
if data_to_write_io and hasattr (data_to_write_io ,'close'):
data_to_write_io .close ()
def process (self ):
if self ._check_pause (f"Post processing for ID {self .post .get ('id','N/A')}"):return 0 ,0 ,[],[],[],None
if self .check_cancel ():return 0 ,0 ,[],[],[],None
@@ -994,6 +1005,20 @@ class PostProcessorWorker:
else :
original_cleaned_post_title_for_sub =cleaned_post_title_for_sub
if self.use_date_prefix_for_subfolder:
# Prioritize 'published' date, fall back to 'added' date
published_date_str = self.post.get('published') or self.post.get('added')
if published_date_str:
try:
# Extract just the date part (YYYY-MM-DD)
date_prefix = published_date_str.split('T')[0]
# Prepend the date to the folder name
original_cleaned_post_title_for_sub = f"{date_prefix} {original_cleaned_post_title_for_sub}"
self.logger(f" Applying date prefix to subfolder: '{original_cleaned_post_title_for_sub}'")
except Exception as e:
self.logger(f" ⚠️ Could not parse date '{published_date_str}' for prefix. Using original name. Error: {e}")
else:
self.logger(" ⚠️ 'Date Prefix' is checked, but post has no 'published' or 'added' date. Omitting prefix.")
base_path_for_post_subfolder =determined_post_save_path_for_history
@@ -1434,6 +1459,7 @@ class DownloadThread (QThread ):
use_cookie =False ,
scan_content_for_images =False ,
creator_download_folder_ignore_words =None ,
use_date_prefix_for_subfolder=False,
cookie_text ="",
session_file_path=None,
session_lock=None,
@@ -1486,6 +1512,7 @@ class DownloadThread (QThread ):
self .manga_date_file_counter_ref =manga_date_file_counter_ref
self .scan_content_for_images =scan_content_for_images
self .creator_download_folder_ignore_words =creator_download_folder_ignore_words
self.use_date_prefix_for_subfolder = use_date_prefix_for_subfolder
self .manga_global_file_counter_ref =manga_global_file_counter_ref
self.session_file_path = session_file_path
self.session_lock = session_lock
@@ -1618,6 +1645,7 @@ class DownloadThread (QThread ):
manga_global_file_counter_ref =self .manga_global_file_counter_ref ,
use_cookie =self .use_cookie ,
manga_date_file_counter_ref =self .manga_date_file_counter_ref ,
use_date_prefix_for_subfolder=self.use_date_prefix_for_subfolder,
creator_download_folder_ignore_words =self .creator_download_folder_ignore_words ,
session_file_path=self.session_file_path,
session_lock=self.session_lock,

View File

@@ -22,13 +22,17 @@ def get_app_icon_object():
if _app_icon_cache and not _app_icon_cache.isNull():
return _app_icon_cache
# Declare a single variable to hold the base directory path.
app_base_dir = ""
# Determine the project's base directory, whether running from source or as a bundled app
if getattr(sys, 'frozen', False):
# The application is frozen (e.g., with PyInstaller)
base_dir = os.path.dirname(sys.executable)
# The application is frozen (e.g., with PyInstaller).
# The base directory is the one containing the executable.
app_base_dir = os.path.dirname(sys.executable)
else:
# The application is running from a .py file
# This path navigates up from src/ui/ to the project root
# The application is running from a .py file.
# This path navigates up from src/ui/assets.py to the project root.
app_base_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
icon_path = os.path.join(app_base_dir, 'assets', 'Kemono.ico')
@@ -36,7 +40,14 @@ def get_app_icon_object():
if os.path.exists(icon_path):
_app_icon_cache = QIcon(icon_path)
else:
# If the icon isn't found, especially in a frozen app, check the _MEIPASS directory as a fallback.
if getattr(sys, 'frozen', False) and hasattr(sys, '_MEIPASS'):
fallback_icon_path = os.path.join(sys._MEIPASS, 'assets', 'Kemono.ico')
if os.path.exists(fallback_icon_path):
_app_icon_cache = QIcon(fallback_icon_path)
return _app_icon_cache
print(f"Warning: Application icon not found at {icon_path}")
_app_icon_cache = QIcon() # Return an empty icon as a fallback
return _app_icon_cache
return _app_icon_cache

View File

@@ -92,171 +92,177 @@ class DownloaderApp (QWidget ):
file_progress_signal =pyqtSignal (str ,object )
def __init__ (self ):
super ().__init__ ()
self .settings =QSettings (CONFIG_ORGANIZATION_NAME ,CONFIG_APP_NAME_MAIN )
if getattr (sys ,'frozen',False ):
self .app_base_dir =os .path .dirname (sys .executable )
else :
def __init__(self):
super().__init__()
self.settings = QSettings(CONFIG_ORGANIZATION_NAME, CONFIG_APP_NAME_MAIN)
# --- CORRECT PATH DEFINITION ---
# This block correctly determines the application's base directory whether
# it's running from source or as a frozen executable.
if getattr(sys, 'frozen', False) and hasattr(sys, '_MEIPASS'):
# Path for PyInstaller one-file bundle
self.app_base_dir = os.path.dirname(sys.executable)
else:
# Path for running from source code
self.app_base_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
self .config_file =os .path .join (self .app_base_dir ,"appdata","Known.txt")
self .download_thread =None
self .thread_pool =None
self .cancellation_event =threading .Event ()
self.session_file_path = os.path.join(self.app_base_dir, "appdata","session.json")
# All file paths will now correctly use the single, correct app_base_dir
self.config_file = os.path.join(self.app_base_dir, "appdata", "Known.txt")
self.session_file_path = os.path.join(self.app_base_dir, "appdata", "session.json")
self.persistent_history_file = os.path.join(self.app_base_dir, "appdata", "download_history.json")
self.download_thread = None
self.thread_pool = None
self.cancellation_event = threading.Event()
self.session_lock = threading.Lock()
self.interrupted_session_data = None
self.is_restore_pending = False
self .external_link_download_thread =None
self .pause_event =threading .Event ()
self .active_futures =[]
self .total_posts_to_process =0
self .dynamic_character_filter_holder =DynamicFilterHolder ()
self .processed_posts_count =0
self .creator_name_cache ={}
self .log_signal .emit (f" App base directory: {self .app_base_dir }")
self.external_link_download_thread = None
self.pause_event = threading.Event()
self.active_futures = []
self.total_posts_to_process = 0
self.dynamic_character_filter_holder = DynamicFilterHolder()
self.processed_posts_count = 0
self.creator_name_cache = {}
self.log_signal.emit(f" App base directory: {self.app_base_dir}")
self.log_signal.emit(f" Persistent history file path set to: {self.persistent_history_file}")
self.app_base_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
self.persistent_history_file = os.path.join(self.app_base_dir, "appdata", "download_history.json")
self .last_downloaded_files_details =deque (maxlen =3 )
self .download_history_candidates =deque (maxlen =8 )
self .log_signal .emit (f" Persistent history file path set to: {self .persistent_history_file }")
self .final_download_history_entries =[]
self .favorite_download_queue =deque ()
self .is_processing_favorites_queue =False
self .download_counter =0
self .favorite_download_queue =deque ()
self .permanently_failed_files_for_dialog =[]
self .last_link_input_text_for_queue_sync =""
self .is_fetcher_thread_running =False
self ._restart_pending =False
self .is_processing_favorites_queue =False
self .download_history_log =deque (maxlen =50 )
self .skip_counter =0
self .all_kept_original_filenames =[]
self .cancellation_message_logged_this_session =False
self .favorite_scope_toggle_button =None
self .favorite_download_scope =FAVORITE_SCOPE_SELECTED_LOCATION
# --- The rest of __init__ method continues from here ---
self.last_downloaded_files_details = deque(maxlen=3)
self.download_history_candidates = deque(maxlen=8)
self.final_download_history_entries = []
self.favorite_download_queue = deque()
self.is_processing_favorites_queue = False
self.download_counter = 0
self.permanently_failed_files_for_dialog = []
self.last_link_input_text_for_queue_sync = ""
self.is_fetcher_thread_running = False
self._restart_pending = False
self.download_history_log = deque(maxlen=50)
self.skip_counter = 0
self.all_kept_original_filenames = []
self.cancellation_message_logged_this_session = False
self.favorite_scope_toggle_button = None
self.favorite_download_scope = FAVORITE_SCOPE_SELECTED_LOCATION
self.manga_mode_checkbox = None
self.selected_cookie_filepath = None
self.retryable_failed_files_info = []
self.is_paused = False
self.worker_to_gui_queue = queue.Queue()
self.gui_update_timer = QTimer(self)
self.actual_gui_signals = PostProcessorSignals()
self.worker_signals = PostProcessorSignals()
self.prompt_mutex = QMutex()
self._add_character_response = None
self._original_scan_content_tooltip = ("If checked, the downloader will scan the HTML content of posts for image URLs (from <img> tags or direct links).\n"
"now This includes resolving relative paths from <img> tags to full URLs.\n"
"Relative paths in <img> tags (e.g., /data/image.jpg) will be resolved to full URLs.\n"
"Useful for cases where images are in the post description but not in the API's file/attachment list.")
self.downloaded_files = set()
self.downloaded_files_lock = threading.Lock()
self.downloaded_file_hashes = set()
self.downloaded_file_hashes_lock = threading.Lock()
self.show_external_links = False
self.external_link_queue = deque()
self._is_processing_external_link_queue = False
self._current_link_post_title = None
self.extracted_links_cache = []
self.manga_rename_toggle_button = None
self.favorite_mode_checkbox = None
self.url_or_placeholder_stack = None
self.url_input_widget = None
self.url_placeholder_widget = None
self.favorite_action_buttons_widget = None
self.favorite_mode_artists_button = None
self.favorite_mode_posts_button = None
self.standard_action_buttons_widget = None
self.bottom_action_buttons_stack = None
self.main_log_output = None
self.external_log_output = None
self.log_splitter = None
self.main_splitter = None
self.reset_button = None
self.progress_log_label = None
self.log_verbosity_toggle_button = None
self.missed_character_log_output = None
self.log_view_stack = None
self.current_log_view = 'progress'
self.link_search_input = None
self.link_search_button = None
self.export_links_button = None
self.radio_only_links = None
self.radio_only_archives = None
self.missed_title_key_terms_count = {}
self.missed_title_key_terms_examples = {}
self.logged_summary_for_key_term = set()
self.STOP_WORDS = set(["a", "an", "the", "is", "was", "were", "of", "for", "with", "in", "on", "at", "by", "to", "and", "or", "but", "i", "you", "he", "she", "it", "we", "they", "my", "your", "his", "her", "its", "our", "their", "com", "net", "org", "www"])
self.already_logged_bold_key_terms = set()
self.missed_key_terms_buffer = []
self.char_filter_scope_toggle_button = None
self.skip_words_scope = SKIP_SCOPE_POSTS
self.char_filter_scope = CHAR_SCOPE_TITLE
self.manga_filename_style = self.settings.value(MANGA_FILENAME_STYLE_KEY, STYLE_POST_TITLE, type=str)
self.current_theme = self.settings.value(THEME_KEY, "dark", type=str)
self.only_links_log_display_mode = LOG_DISPLAY_LINKS
self.mega_download_log_preserved_once = False
self.allow_multipart_download_setting = False
self.use_cookie_setting = False
self.scan_content_images_setting = self.settings.value(SCAN_CONTENT_IMAGES_KEY, False, type=bool)
self.cookie_text_setting = ""
self.current_selected_language = self.settings.value(LANGUAGE_KEY, "en", type=str)
self .manga_mode_checkbox =None
print(f" Known.txt will be loaded/saved at: {self.config_file}")
self .selected_cookie_filepath =None
self .retryable_failed_files_info =[]
try:
base_path_for_icon = ""
if getattr(sys, 'frozen', False) and hasattr(sys, '_MEIPASS'):
base_path_for_icon = sys._MEIPASS
else:
base_path_for_icon = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
icon_path_for_window = os.path.join(base_path_for_icon, 'assets', 'Kemono.ico')
if os.path.exists(icon_path_for_window):
self.setWindowIcon(QIcon(icon_path_for_window))
else:
if getattr(sys, 'frozen', False):
executable_dir = os.path.dirname(sys.executable)
fallback_icon_path = os.path.join(executable_dir, 'assets', 'Kemono.ico')
if os.path.exists(fallback_icon_path):
self.setWindowIcon(QIcon(fallback_icon_path))
else:
self.log_signal.emit(f"⚠️ Main window icon 'assets/Kemono.ico' not found at {icon_path_for_window} or {fallback_icon_path}")
else:
self.log_signal.emit(f"⚠️ Main window icon 'assets/Kemono.ico' not found at {icon_path_for_window}")
except Exception as e_icon_app:
self.log_signal.emit(f"❌ Error setting main window icon in DownloaderApp init: {e_icon_app}")
self .is_paused =False
self .worker_to_gui_queue =queue .Queue ()
self .gui_update_timer =QTimer (self )
self .actual_gui_signals =PostProcessorSignals ()
self .worker_signals =PostProcessorSignals ()
self .prompt_mutex =QMutex ()
self ._add_character_response =None
self ._original_scan_content_tooltip =("If checked, the downloader will scan the HTML content of posts for image URLs (from <img> tags or direct links).\n"
"now This includes resolving relative paths from <img> tags to full URLs.\n"
"Relative paths in <img> tags (e.g., /data/image.jpg) will be resolved to full URLs.\n"
"Useful for cases where images are in the post description but not in the API's file/attachment list.")
self .downloaded_files =set ()
self .downloaded_files_lock =threading .Lock ()
self .downloaded_file_hashes =set ()
self .downloaded_file_hashes_lock =threading .Lock ()
self .show_external_links =False
self .external_link_queue =deque ()
self ._is_processing_external_link_queue =False
self ._current_link_post_title =None
self .extracted_links_cache =[]
self .manga_rename_toggle_button =None
self .favorite_mode_checkbox =None
self .url_or_placeholder_stack =None
self .url_input_widget =None
self .url_placeholder_widget =None
self .favorite_action_buttons_widget =None
self .favorite_mode_artists_button =None
self .favorite_mode_posts_button =None
self .standard_action_buttons_widget =None
self .bottom_action_buttons_stack =None
self .main_log_output =None
self .external_log_output =None
self .log_splitter =None
self .main_splitter =None
self .reset_button =None
self .progress_log_label =None
self .log_verbosity_toggle_button =None
self .missed_character_log_output =None
self .log_view_stack =None
self .current_log_view ='progress'
self .link_search_input =None
self .link_search_button =None
self .export_links_button =None
self .radio_only_links =None
self .radio_only_archives =None
self .missed_title_key_terms_count ={}
self .missed_title_key_terms_examples ={}
self .logged_summary_for_key_term =set ()
self .STOP_WORDS =set (["a","an","the","is","was","were","of","for","with","in","on","at","by","to","and","or","but","i","you","he","she","it","we","they","my","your","his","her","its","our","their","com","net","org","www"])
self .already_logged_bold_key_terms =set ()
self .missed_key_terms_buffer =[]
self .char_filter_scope_toggle_button =None
self .skip_words_scope =SKIP_SCOPE_POSTS
self .char_filter_scope =CHAR_SCOPE_TITLE
self .manga_filename_style =self .settings .value (MANGA_FILENAME_STYLE_KEY ,STYLE_POST_TITLE ,type =str )
self .current_theme =self .settings .value (THEME_KEY ,"dark",type =str )
self .only_links_log_display_mode =LOG_DISPLAY_LINKS
self .mega_download_log_preserved_once =False
self .allow_multipart_download_setting =False
self .use_cookie_setting =False
self .scan_content_images_setting =self .settings .value (SCAN_CONTENT_IMAGES_KEY ,False ,type =bool )
self .cookie_text_setting =""
self .current_selected_language =self .settings .value (LANGUAGE_KEY ,"en",type =str )
print (f" Known.txt will be loaded/saved at: {self .config_file }")
try :
if getattr (sys ,'frozen',False )and hasattr (sys ,'_MEIPASS'):
base_dir_for_icon =sys ._MEIPASS
else :
app_base_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..'))
icon_path_for_window =os .path .join (app_base_dir ,'assets','Kemono.ico')
if os .path .exists (icon_path_for_window ):
self .setWindowIcon (QIcon (icon_path_for_window ))
else :
self .log_signal .emit (f"⚠️ Main window icon 'assets/Kemono.ico' not found at {icon_path_for_window } (tried in DownloaderApp init)")
except Exception as e_icon_app :
self .log_signal .emit (f"❌ Error setting main window icon in DownloaderApp init: {e_icon_app }")
self .url_label_widget =None
self .download_location_label_widget =None
self .remove_from_filename_label_widget =None
self .skip_words_label_widget =None
self .setWindowTitle ("Kemono Downloader v5.5.0")
self .init_ui ()
self ._connect_signals ()
self .log_signal .emit (" Local API server functionality has been removed.")
self .log_signal .emit (" 'Skip Current File' button has been removed.")
if hasattr (self ,'character_input'):
self .character_input .setToolTip (self ._tr ("character_input_tooltip","Enter character names (comma-separated)..."))
self .log_signal .emit (f" Manga filename style loaded: '{self .manga_filename_style }'")
self .log_signal .emit (f" Skip words scope loaded: '{self .skip_words_scope }'")
self .log_signal .emit (f" Character filter scope set to default: '{self .char_filter_scope }'")
self .log_signal .emit (f" Multi-part download defaults to: {'Enabled'if self .allow_multipart_download_setting else 'Disabled'}")
self .log_signal .emit (f" Cookie text defaults to: Empty on launch")
self .log_signal .emit (f" 'Use Cookie' setting defaults to: Disabled on launch")
self .log_signal .emit (f" Scan post content for images defaults to: {'Enabled'if self .scan_content_images_setting else 'Disabled'}")
self .log_signal .emit (f" Application language loaded: '{self .current_selected_language .upper ()}' (UI may not reflect this yet).")
self ._retranslate_main_ui ()
self ._load_persistent_history ()
self ._load_saved_download_location ()
self._update_button_states_and_connections() # Initial button state setup
self.url_label_widget = None
self.download_location_label_widget = None
self.remove_from_filename_label_widget = None
self.skip_words_label_widget = None
self.setWindowTitle("Kemono Downloader v5.5.0")
self.init_ui()
self._connect_signals()
self.log_signal.emit(" Local API server functionality has been removed.")
self.log_signal.emit(" 'Skip Current File' button has been removed.")
if hasattr(self, 'character_input'):
self.character_input.setToolTip(self._tr("character_input_tooltip", "Enter character names (comma-separated)..."))
self.log_signal.emit(f" Manga filename style loaded: '{self.manga_filename_style}'")
self.log_signal.emit(f" Skip words scope loaded: '{self.skip_words_scope}'")
self.log_signal.emit(f" Character filter scope set to default: '{self.char_filter_scope}'")
self.log_signal.emit(f" Multi-part download defaults to: {'Enabled' if self.allow_multipart_download_setting else 'Disabled'}")
self.log_signal.emit(f" Cookie text defaults to: Empty on launch")
self.log_signal.emit(f" 'Use Cookie' setting defaults to: Disabled on launch")
self.log_signal.emit(f" Scan post content for images defaults to: {'Enabled' if self.scan_content_images_setting else 'Disabled'}")
self.log_signal.emit(f" Application language loaded: '{self.current_selected_language.upper()}' (UI may not reflect this yet).")
self._retranslate_main_ui()
self._load_persistent_history()
self._load_saved_download_location()
self._update_button_states_and_connections()
self._check_for_interrupted_session()
def get_checkbox_map(self):
"""Returns a mapping of checkbox attribute names to their corresponding settings key."""
return {
@@ -851,20 +857,40 @@ class DownloaderApp (QWidget ):
self .character_list .addItems ([entry ["name"]for entry in KNOWN_NAMES ])
def save_known_names (self ):
global KNOWN_NAMES
try :
with open (self .config_file ,'w',encoding ='utf-8')as f :
for entry in KNOWN_NAMES :
if entry ["is_group"]:
f .write (f"({', '.join (sorted (entry ['aliases'],key =str .lower ))})\n")
else :
f .write (entry ["name"]+'\n')
if hasattr (self ,'log_signal'):self .log_signal .emit (f"💾 Saved {len (KNOWN_NAMES )} known entries to {self .config_file }")
except Exception as e :
log_msg =f"❌ Error saving config '{self .config_file }': {e }"
if hasattr (self ,'log_signal'):self .log_signal .emit (log_msg )
QMessageBox .warning (self ,"Config Save Error",f"Could not save list to {self .config_file }:\n{e }")
def save_known_names(self):
"""
Saves the current list of known names (KNOWN_NAMES) to the config file.
This version includes a fix to ensure the destination directory exists
before attempting to write the file, preventing crashes in new installations.
"""
global KNOWN_NAMES
try:
# --- FIX STARTS HERE ---
# Get the directory path from the full file path.
config_dir = os.path.dirname(self.config_file)
# Create the directory if it doesn't exist. 'exist_ok=True' prevents
# an error if the directory is already there.
os.makedirs(config_dir, exist_ok=True)
# --- FIX ENDS HERE ---
with open(self.config_file, 'w', encoding='utf-8') as f:
for entry in KNOWN_NAMES:
if entry["is_group"]:
# For groups, write the aliases in a sorted, comma-separated format inside parentheses.
f.write(f"({', '.join(sorted(entry['aliases'], key=str.lower))})\n")
else:
# For single entries, write the name on its own line.
f.write(entry["name"] + '\n')
if hasattr(self, 'log_signal'):
self.log_signal.emit(f"💾 Saved {len(KNOWN_NAMES)} known entries to {self.config_file}")
except Exception as e:
# If any error occurs during saving, log it and show a warning popup.
log_msg = f"❌ Error saving config '{self.config_file}': {e}"
if hasattr(self, 'log_signal'):
self.log_signal.emit(log_msg)
QMessageBox.warning(self, "Config Save Error", f"Could not save list to {self.config_file}:\n{e}")
def closeEvent (self ,event ):
self .save_known_names ()
@@ -1197,6 +1223,11 @@ class DownloaderApp (QWidget ):
self .use_subfolder_per_post_checkbox .toggled .connect (self .update_ui_for_subfolders )
advanced_row1_layout .addWidget (self .use_subfolder_per_post_checkbox )
self.date_prefix_checkbox = QCheckBox("Date Prefix")
self.date_prefix_checkbox.setChecked(False)
self.date_prefix_checkbox.setToolTip("When 'Subfolder per Post' is active, prefix the folder name with the post's upload date (e.g., YYYY-MM-DD Post Title).")
advanced_row1_layout.addWidget(self.date_prefix_checkbox)
self .use_cookie_checkbox =QCheckBox ("Use Cookie")
self .use_cookie_checkbox .setChecked (self .use_cookie_setting )
@@ -1526,25 +1557,28 @@ class DownloaderApp (QWidget ):
self .final_download_history_entries =[]
self ._save_persistent_history ()
def _save_persistent_history (self ):
def _save_persistent_history(self):
"""Saves download history to a persistent file."""
self .log_signal .emit (f"📜 Attempting to save history to: {self .persistent_history_file }")
try :
history_dir =os .path .dirname (self .persistent_history_file )
self .log_signal .emit (f" History directory: {history_dir }")
if not os .path .exists (history_dir ):
os .makedirs (history_dir ,exist_ok =True )
self .log_signal .emit (f" Created history directory: {history_dir }")
self.log_signal.emit(f"📜 Attempting to save history to: {self.persistent_history_file}")
try:
history_dir = os.path.dirname(self.persistent_history_file)
self.log_signal.emit(f" History directory: {history_dir}")
if not os.path.exists(history_dir):
os.makedirs(history_dir, exist_ok=True)
self.log_signal.emit(f" Created history directory: {history_dir}")
history_data = {
"last_downloaded_files": list(self.last_downloaded_files_details),
"first_processed_posts": self.final_download_history_entries
}
with open (self .persistent_history_file ,'w',encoding ='utf-8')as f :
json .dump (history_data ,f ,indent =2 )
self .log_signal .emit (f"✅ Saved {len (self .final_download_history_entries )} history entries to: {self .persistent_history_file }")
except Exception as e :
self .log_signal .emit (f"❌ Error saving persistent history to {self .persistent_history_file }: {e }")
with open(self.persistent_history_file, 'w', encoding='utf-8') as f:
json.dump(history_data, f, indent=2)
self.log_signal.emit(f"✅ Saved {len(self.final_download_history_entries)} history entries to: {self.persistent_history_file}")
except Exception as e:
self.log_signal.emit(f"❌ Error saving persistent history to {self.persistent_history_file}: {e}")
def _load_creator_name_cache_from_json (self ):
"""Loads creator id-name-service mappings from creators.json into self.creator_name_cache."""
self .log_signal .emit (" Attempting to load creators.json for creator name cache.")
@@ -2692,6 +2726,13 @@ class DownloaderApp (QWidget ):
if not can_enable_subfolder_per_post_checkbox :
self .use_subfolder_per_post_checkbox .setChecked (False )
if hasattr(self, 'date_prefix_checkbox'):
# The Date Prefix checkbox should only be enabled if "Subfolder per Post" is both enabled and checked
can_enable_date_prefix = self.use_subfolder_per_post_checkbox.isEnabled() and self.use_subfolder_per_post_checkbox.isChecked()
self.date_prefix_checkbox.setEnabled(can_enable_date_prefix)
if not can_enable_date_prefix:
self.date_prefix_checkbox.setChecked(False)
self .update_custom_folder_visibility ()
@@ -2751,7 +2792,9 @@ class DownloaderApp (QWidget ):
elif self .manga_filename_style ==STYLE_DATE_BASED :
self .manga_rename_toggle_button .setText (self ._tr ("manga_style_date_based_text","Name: Date Based"))
elif self .manga_filename_style ==STYLE_POST_ID: # Add this block
self .manga_rename_toggle_button .setText (self ._tr ("manga_style_post_id_text","Name: Post ID"))
elif self .manga_filename_style ==STYLE_DATE_POST_TITLE :
self .manga_rename_toggle_button .setText (self ._tr ("manga_style_date_post_title_text","Name: Date + Title"))
@@ -2763,6 +2806,8 @@ class DownloaderApp (QWidget ):
self .manga_rename_toggle_button .setToolTip ("Click to cycle Manga Filename Style (when Manga Mode is active for a creator feed).")
# In main_window.py
def _toggle_manga_filename_style (self ):
current_style =self .manga_filename_style
new_style =""
@@ -2775,7 +2820,9 @@ class DownloaderApp (QWidget ):
elif current_style ==STYLE_POST_TITLE_GLOBAL_NUMBERING :
new_style =STYLE_DATE_BASED
elif current_style ==STYLE_DATE_BASED :
new_style =STYLE_POST_TITLE
new_style =STYLE_POST_ID # Change this line
elif current_style ==STYLE_POST_ID: # Add this block
new_style =STYLE_POST_TITLE
else :
self .log_signal .emit (f"⚠️ Unknown current manga filename style: {current_style }. Resetting to default ('{STYLE_POST_TITLE }').")
new_style =STYLE_POST_TITLE
@@ -3683,6 +3730,7 @@ class DownloaderApp (QWidget ):
'session_file_path': self.session_file_path,
'session_lock': self.session_lock,
'creator_download_folder_ignore_words':creator_folder_ignore_words_for_run ,
'use_date_prefix_for_subfolder': self.date_prefix_checkbox.isChecked() if hasattr(self, 'date_prefix_checkbox') else False,
}
args_template ['override_output_dir']=override_output_dir
@@ -4035,21 +4083,56 @@ class DownloaderApp (QWidget ):
num_file_dl_threads_for_each_worker =worker_args_template .get ('num_file_threads_for_worker',1 )
ppw_expected_keys =[
'post_data','download_root','known_names','filter_character_list','unwanted_keywords',
'filter_mode','skip_zip','skip_rar','use_subfolders','use_post_subfolders',
'target_post_id_from_initial_url','custom_folder_name','compress_images','emitter','pause_event',
'download_thumbnails','service','user_id','api_url_input',
'cancellation_event','downloaded_files','downloaded_file_hashes',
'downloaded_files_lock','downloaded_file_hashes_lock','remove_from_filename_words_list','dynamic_character_filter_holder',
'skip_words_list','skip_words_scope','char_filter_scope',
'show_external_links','extract_links_only','allow_multipart_download','use_cookie','cookie_text',
'app_base_dir','selected_cookie_file','override_output_dir',
'num_file_threads','skip_current_file_flag','manga_date_file_counter_ref','scan_content_for_images',
'manga_mode_active','manga_filename_style','manga_date_prefix',
'manga_global_file_counter_ref'
,'creator_download_folder_ignore_words'
, 'session_file_path', 'session_lock'
ppw_expected_keys = [
'post_data',
'download_root',
'known_names',
'filter_character_list',
'unwanted_keywords',
'filter_mode',
'skip_zip',
'skip_rar',
'use_subfolders',
'use_post_subfolders',
'target_post_id_from_initial_url',
'custom_folder_name',
'compress_images',
'emitter',
'pause_event',
'download_thumbnails',
'service',
'user_id',
'api_url_input',
'cancellation_event',
'downloaded_files',
'downloaded_file_hashes',
'downloaded_files_lock',
'downloaded_file_hashes_lock',
'remove_from_filename_words_list',
'dynamic_character_filter_holder',
'skip_words_list',
'skip_words_scope',
'char_filter_scope',
'show_external_links',
'extract_links_only',
'allow_multipart_download',
'use_cookie',
'cookie_text',
'app_base_dir',
'selected_cookie_file',
'override_output_dir',
'num_file_threads',
'skip_current_file_flag',
'manga_date_file_counter_ref',
'scan_content_for_images',
'manga_mode_active',
'manga_filename_style',
'manga_date_prefix',
'use_date_prefix_for_subfolder',
'manga_global_file_counter_ref',
'creator_download_folder_ignore_words',
'session_file_path',
'session_lock'
]
ppw_optional_keys_with_defaults ={
@@ -5496,4 +5579,4 @@ class ExternalLinkDownloadThread (QThread ):
self .finished_signal .emit ()
def cancel (self ):
self .is_cancelled =True
self .is_cancelled =True