mirror of
https://github.com/TagStudioDev/TagStudio.git
synced 2026-01-29 22:30:57 +00:00
Compare commits
77 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2d107ab00d | ||
|
|
2d652c83d4 | ||
|
|
bbfc27285e | ||
|
|
2df92f2115 | ||
|
|
2eb9aad12d | ||
|
|
d9c7d58e89 | ||
|
|
71d04254cf | ||
|
|
b216490311 | ||
|
|
1c5e0016cc | ||
|
|
f258578f7b | ||
|
|
19cdb80b57 | ||
|
|
47baa6f09e | ||
|
|
cee64a8c31 | ||
|
|
f49cb4fade | ||
|
|
fff967617b | ||
|
|
7a8d34e190 | ||
|
|
3374f6b07f | ||
|
|
eecb4d3e38 | ||
|
|
583d107cb8 | ||
|
|
2db8bed304 | ||
|
|
01680cab34 | ||
|
|
ccd7ce136e | ||
|
|
25f85bf443 | ||
|
|
ce095385a8 | ||
|
|
54f9c93285 | ||
|
|
1132026aff | ||
|
|
c16445f47e | ||
|
|
781aca27ae | ||
|
|
4f9d805cac | ||
|
|
bb10baf892 | ||
|
|
1ae92a3661 | ||
|
|
2f4b72fd4d | ||
|
|
7a7e1cc4bd | ||
|
|
a9a1470a08 | ||
|
|
dcf564e8c3 | ||
|
|
9891caca35 | ||
|
|
131c5df86b | ||
|
|
d8b058ac5a | ||
|
|
a9bdd93c64 | ||
|
|
2926b91980 | ||
|
|
8e1ae81ec9 | ||
|
|
44c7d223ff | ||
|
|
3f9aa87ab6 | ||
|
|
2583a76f56 | ||
|
|
d8919ab283 | ||
|
|
08d0ba4eee | ||
|
|
e551359845 | ||
|
|
12e074b71d | ||
|
|
4704b92804 | ||
|
|
3a0da4699a | ||
|
|
3125a995a7 | ||
|
|
5dfcc36d70 | ||
|
|
eb2887e871 | ||
|
|
02a56892e6 | ||
|
|
3489e159a5 | ||
|
|
6c257f9671 | ||
|
|
acba9c3c33 | ||
|
|
899c534467 | ||
|
|
74383e3c3c | ||
|
|
660a87bb94 | ||
|
|
89cf2b22e4 | ||
|
|
133092cd05 | ||
|
|
94ac83768a | ||
|
|
61ca3cb32a | ||
|
|
0e7a2dfd3d | ||
|
|
d00546d5fe | ||
|
|
969b1674f0 | ||
|
|
00001bbf0b | ||
|
|
df064ad104 | ||
|
|
31d205a869 | ||
|
|
a55d9a6a67 | ||
|
|
2c5c98c86c | ||
|
|
8cef5e5749 | ||
|
|
32a2b47c4c | ||
|
|
7a44ef156d | ||
|
|
f2454c4a9a | ||
|
|
537ecb2a55 |
6
STYLE.md
6
STYLE.md
@@ -21,11 +21,11 @@ As of writing this section, the QT part of the code base is quite unstructured a
|
||||
The general structure of the QT code base should look like this:
|
||||
```
|
||||
qt
|
||||
├── controller
|
||||
├── controllers
|
||||
│ ├── widgets
|
||||
│ │ └── preview_panel_controller.py
|
||||
│ └── main_window_controller.py
|
||||
├── view
|
||||
├── views
|
||||
│ ├── widgets
|
||||
│ │ └── preview_panel_view.py
|
||||
│ └── main_window_view.py
|
||||
@@ -33,7 +33,7 @@ qt
|
||||
└── mixed.py
|
||||
```
|
||||
|
||||
In this structure there are the `view` and `controller` sub-directories. They have the exact same structure and for every `<component>_view.py` there is a `<component>_controller.py` at the same location in the other subdirectory and vice versa.
|
||||
In this structure there are the `views` and `controllers` sub-directories. They have the exact same structure and for every `<component>_view.py` there is a `<component>_controller.py` at the same location in the other subdirectory and vice versa.
|
||||
|
||||
Typically the classes should look like this:
|
||||
```py
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.2 MiB After Width: | Height: | Size: 1.1 MiB |
BIN
docs/assets/tag_bubbles.png
Normal file
BIN
docs/assets/tag_bubbles.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 132 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 56 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB |
BIN
docs/assets/ts-9-3_logo_text.png
Normal file
BIN
docs/assets/ts-9-3_logo_text.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 234 KiB |
@@ -1,4 +1,8 @@
|
||||
# Developing
|
||||
---
|
||||
icon: material/code-braces
|
||||
---
|
||||
|
||||
# :material-code-braces: Developing
|
||||
|
||||
If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarity with existing Python toolchains.
|
||||
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
# FFmpeg
|
||||
---
|
||||
icon: material/movie-open-cog
|
||||
---
|
||||
|
||||
# :material-movie-open-cog: FFmpeg
|
||||
|
||||
FFmpeg is required for thumbnail previews and playback features on audio and video files. FFmpeg is a free Open Source project dedicated to the handling of multimedia (video, audio, etc) files. For more information, see their official website at [ffmpeg.org](https://www.ffmpeg.org/).
|
||||
|
||||
|
||||
126
docs/index.md
126
docs/index.md
@@ -1,52 +1,110 @@
|
||||
---
|
||||
title: Home
|
||||
hide:
|
||||
- toc
|
||||
---
|
||||
|
||||
# Welcome to the TagStudio Documentation!
|
||||
#
|
||||
|
||||

|
||||
|
||||
TagStudio is a photo & file organization application with an underlying tag-based system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure.
|
||||
|
||||
<figure width="60%" markdown="span">
|
||||
|
||||

|
||||
|
||||
<figcaption>TagStudio Alpha v9.5.0 running on macOS Sequoia.</figcaption>
|
||||
<link rel="stylesheet" href="stylesheets/home.css">
|
||||
|
||||
<figure markdown="span">
|
||||
{ width=80% }<h2>A User-Focused Photo & File Management System</h2>
|
||||
</figure>
|
||||
|
||||
## Feature Roadmap
|
||||
<br>
|
||||
|
||||
The [Feature Roadmap](./updates/roadmap.md) lists all of the planned core features for TagStudio to be considered "feature complete" along with estimated release milestones. The development and testing of these features takes priority over all other requested or submitted features unless they are later added to this roadmap. This helps ensure that TagStudio eventually sees a full release and becomes more usable by more people more quickly.
|
||||
<figure markdown="span">
|
||||
{ width=80% }
|
||||
<figcaption>TagStudio Alpha v9.5.0 running on macOS Sequoia.</figcaption>
|
||||
</figure>
|
||||
|
||||
## Current Features
|
||||
<div class="grid" markdown>
|
||||
|
||||
### Libraries
|
||||

|
||||
|
||||
- Create [libraries](./library/index.md) centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
|
||||
- Address moved, deleted, or otherwise "unlinked" files by using the "Fix Unlinked Entries" option in the Tools menu.
|
||||
**TagStudio** is a photo & file organization application with an underlying tag-based system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure.
|
||||
|
||||
### Tagging + Metadata Fields
|
||||
</div>
|
||||
|
||||
- Add custom powerful [tags](./library/tag.md) to your library entries
|
||||
- Add [metadata fields](./library/field.md) to your library entries, including:
|
||||
- Name, Author, Artist (Single-Line Text Fields)
|
||||
- Description, Notes (Multi-Line Text Fields)
|
||||
- Create rich tags composed of a name, color, a list of aliases, and a list of "parent tags" - these being tags in which these tags inherit values from.
|
||||
- Copy and paste tags and fields across file entries
|
||||
- Automatically organize tags into groups based on parent tags marked as "categories"
|
||||
- Generate tags from your existing folder structure with the "Folders to Tags" macro (NOTE: these tags do NOT sync with folders after they are created)
|
||||
<figure markdown="span">
|
||||
[:material-download: Download Latest Release](https://github.com/TagStudioDev/TagStudio/releases){ .md-button .md-button--primary }
|
||||
</figure>
|
||||
|
||||
### Search
|
||||
## :material-star: Core Features
|
||||
|
||||
- [Search](./library/library_search.md) for file entries based on tags, file path (`path:`), file types (`filetype:`), and even media types! (`mediatype:`)
|
||||
- Use and combine Boolean operators (`AND`, `OR`, `NOT`) along with parentheses groups, quotation escaping, and underscore substitution to create detailed search queries
|
||||
- Use special search conditions (`special:untagged`) to find file entries without tags or fields, respectively
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
### File Entries
|
||||
- :material-file-multiple:{ .lg .middle } **[All Files](./library/entry.md) Welcome**
|
||||
|
||||
- Nearly all [file](./library/entry.md) types are supported in TagStudio libraries - just not all have dedicated thumbnail support.
|
||||
- Preview most image file types, animated GIFs, videos, plain text documents, audio files, Blender projects, and more!
|
||||
- Open files or file locations by right-clicking on thumbnails and previews and selecting the respective context menu options. You can also click on the preview panel image to open the file, and click the file path label to open its location.
|
||||
- Delete files from both your library and drive by right-clicking the thumbnail(s) and selecting the "Move to Trash"/"Move to Recycle Bin" option.
|
||||
***
|
||||
|
||||
TagStudio works with photos, videos, music, documents, and more! **All file types** are recognized by TagStudio, with most common ones having built-in preview support.
|
||||
|
||||
[:material-arrow-right: See Full Preview Support](./library/index.md#preview-support)
|
||||
|
||||
- :material-tag-text:{ .lg .middle } **Create [Tags](./library/tag.md) Your Way**
|
||||
|
||||
***
|
||||
|
||||
- :material-format-font: No character restrictions
|
||||
- :material-form-textbox: Add aliases/alternate names
|
||||
- :material-palette: Customize colors and styles
|
||||
- :material-tag-multiple: Tags can be tagged with other tags!
|
||||
- :material-star-four-points: And more!
|
||||
|
||||
- :material-magnify:{ .lg .middle } **Powerful [Search](./library/library_search.md)**
|
||||
|
||||
***
|
||||
|
||||
- Full [Boolean operator](./library/library_search.md) support
|
||||
- Filenames, paths, and extensions with [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) syntax
|
||||
- General media types (e.g. "Photo", "Video", "Document")
|
||||
- Special searches (e.g. "Untagged")
|
||||
- "[Smartcase](./library/library_search.md#case-sensitivity)" case sensitivity
|
||||
|
||||
- :material-text-box:{ .lg .middle } **Text and Date [Fields](./library/field.md)**
|
||||
|
||||
***
|
||||
|
||||
Along with tags, add custom metadata fields such as text and dates to your files!
|
||||
|
||||
This is useful for adding notes and descriptions, titling files, and keeping track of extra dates and times.
|
||||
|
||||
</div>
|
||||
|
||||
## :material-toolbox: Built Different
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-scale-balance:{ .lg .middle } **Open Source**
|
||||
|
||||
***
|
||||
|
||||
TagStudio is licensed under the GPL-3.0 license with the source code and executable releases available on [GitHub](https://github.com/TagStudioDev/TagStudio).
|
||||
|
||||
[:material-arrow-right: View License](https://github.com/TagStudioDev/TagStudio/blob/main/LICENSE)
|
||||
|
||||
[:material-arrow-right: Roadmap to MIT Core Library License](./updates/roadmap.md#core-library-api)
|
||||
|
||||
- :material-database:{ .lg .middle } **Central Save File**
|
||||
|
||||
***
|
||||
|
||||
Apposed to filling your drives with [sidecar files](https://en.wikipedia.org/wiki/Sidecar_file), TagStudio uses a project-like [library](./library/index.md) system that stores your tags and metadata inside a single save file per-library.
|
||||
|
||||
[:material-arrow-right: Learn About the Format](./library/index.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## :material-layers-triple: More Than an Application
|
||||
|
||||
TagStudio aims to create an **open** and **robust** format for file tagging that isn't burdened by the limitations of traditional tagging and file metadata systems. **TagStudio** is the first proof-of-concept implementation of this system.
|
||||
|
||||
<div class="grid cards" markdown>
|
||||
|
||||
- :material-map-check:{ .lg .middle } See the [**Roadmap**](./updates/roadmap.md) for future features and updates
|
||||
|
||||
</div>
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
# Installation
|
||||
---
|
||||
icon: material/download
|
||||
---
|
||||
|
||||
# :material-download: Installation
|
||||
|
||||
TagStudio provides [releases](https://github.com/TagStudioDev/TagStudio/releases) as well as full access to its [source code](https://github.com/TagStudioDev/TagStudio) under the [GPLv3](https://github.com/TagStudioDev/TagStudio/blob/main/LICENSE) license.
|
||||
|
||||
@@ -6,14 +10,14 @@ TagStudio provides [releases](https://github.com/TagStudioDev/TagStudio/releases
|
||||
|
||||
To download executable builds of TagStudio, visit the [Releases](https://github.com/TagStudioDev/TagStudio/releases) page of the GitHub repository and download the latest release for your system under the "Assets" section at the bottom of the release.
|
||||
|
||||
TagStudio has builds for **Windows**, **macOS** _(Apple Silicon & Intel)_, and **Linux**. We also offer portable releases for Windows and Linux which are self-contained and easier to move around.
|
||||
TagStudio has builds for :fontawesome-brands-windows: **Windows**, :fontawesome-brands-apple: **macOS** _(Apple Silicon & Intel)_, and :material-penguin: **Linux**. We also offer portable releases for Windows and Linux which are self-contained and easier to move around.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! info "Third-Party Dependencies"
|
||||
You may need to install [third-party dependencies](#third-party-dependencies) such as [FFmpeg](https://ffmpeg.org/download.html) to use the full feature set of TagStudio.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! warning "For macOS Users"
|
||||
!!! warning ":fontawesome-brands-apple: macOS "Privacy & Security" Popup"
|
||||
On macOS, you may be met with a message saying "**"TagStudio" can't be opened because Apple cannot check it for malicious software.**" If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says "**"TagStudio" was blocked from use because it is not from an identified developer.**" Click the "Open Anyway" button to allow TagStudio to run. You should only have to do this once after downloading the application.
|
||||
|
||||
---
|
||||
@@ -26,7 +30,7 @@ TagStudio has builds for **Windows**, **macOS** _(Apple Silicon & Intel)_, and *
|
||||
|
||||
Installation support will not be given to users installing from unofficial sources. Use these versions at your own risk!
|
||||
|
||||
### Installing with PIP
|
||||
### :fontawesome-brands-python: Installing with PIP
|
||||
|
||||
TagStudio is installable via [PIP](https://pip.pypa.io/). Note that since we don't currently distribute on PyPI, the repository needs to be cloned and installed locally. Make sure you have Python 3.12 and PIP installed if you choose to install using this method.
|
||||
|
||||
@@ -54,7 +58,7 @@ TagStudio can now be launched via the `tagstudio` command in your terminal.
|
||||
|
||||
---
|
||||
|
||||
### Linux
|
||||
### :material-penguin: Linux
|
||||
|
||||
Some external dependencies are required for TagStudio to execute. Below is a table of known packages that will be necessary.
|
||||
|
||||
@@ -75,7 +79,7 @@ Some external dependencies are required for TagStudio to execute. Below is a tab
|
||||
| [qt-multimedia](https://repology.org/project/qt) | required |
|
||||
| [qt-wayland](https://repology.org/project/qt) | Wayland support |
|
||||
|
||||
### Nix(OS)
|
||||
### :material-nix: Nix(OS)
|
||||
|
||||
For [Nix(OS)](https://nixos.org/), the TagStudio repository includes a [flake](https://wiki.nixos.org/wiki/Flakes) that provides some outputs such as a development shell and package.
|
||||
|
||||
@@ -207,6 +211,32 @@ Don't forget to rebuild!
|
||||
|
||||
## Third-Party Dependencies
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip
|
||||
You can check to see if these dependencies are correctly located by launching TagStudio and going to "About TagStudio" in the menu bar.
|
||||
|
||||
### FFmpeg/FFprobe
|
||||
|
||||
For audio/video thumbnails and playback you'll need [FFmpeg](https://ffmpeg.org/download.html) installed on your system. If you encounter any issues with this, please reference our [FFmpeg Help](./help/ffmpeg.md) guide.
|
||||
|
||||
You can check to see if FFmpeg and FFprobe are correctly located by launching TagStudio and going to "About TagStudio" in the menu bar.
|
||||
### RAR Extractor
|
||||
|
||||
To generate thumbnails for RAR-based files (like `.cbr`) you'll need an extractor capable of handling them.
|
||||
|
||||
- :material-penguin: On Linux you'll need to install either `unrar` (likely in you distro's non-free repository) or `unrar-free` from your package manager.
|
||||
|
||||
- :fontawesome-brands-apple: On macOS `unrar` can be installed through Homebrew's [`rar`](https://formulae.brew.sh/cask/rar) formula.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! warning ":fontawesome-brands-apple: macOS "Privacy & Security" Popup"
|
||||
On macOS, you may be met with a message similar to "**"unrar" Not Opened. Apple could not verify "unrar" is free of malware that may harm your Mac or compromise your privacy**" If you encounter this, then you'll need to go to the "Settings" app, navigate to "Privacy & Security", and scroll down to a section that says "**"unrar" was blocked from use because it is not from an identified developer.**" Click the "Open Anyway" button to allow unrar to be used.
|
||||
|
||||
- :fontawesome-brands-windows: On Windows you'll need to install either [`WinRAR`](https://www.rarlab.com/download.htm) or [`7-zip`](https://www.7-zip.org/) and add their folder to you `PATH`.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip "WinRAR License"
|
||||
Both `unrar` and `WinRAR` require a license, but since the evaluation copy has no time limit you can simply dismiss the prompt.
|
||||
|
||||
### ripgrep
|
||||
|
||||
A recommended tool to improve the performance of directory scanning is [`ripgrep`](https://github.com/BurntSushi/ripgrep), a Rust-based directory walker that natively integrates with our [`.ts_ignore`](./utilities/ignore.md) (`.gitignore`-style) pattern matching system for excluding files and directories. Ripgrep is already pre-installed on some Linux distributions and also available from several package managers.
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
# File Entries
|
||||
---
|
||||
icon: material/file
|
||||
---
|
||||
|
||||
File entries are the individual representations of your files inside a TagStudio [library](./index.md). Each one corresponds one-to-one to a file on disk, and tracks all of the additional [tags](tag.md) and metadata that you attach to it inside TagStudio.
|
||||
# :material-file: Entries
|
||||
|
||||
Entries are the individual representations of your files inside a TagStudio [library](./index.md). Each one corresponds one-to-one to a file on disk, and tracks all of the additional [tags](tag.md) and metadata that you attach to it inside TagStudio.
|
||||
|
||||
## Storage
|
||||
|
||||
@@ -10,7 +14,7 @@ File entry data is stored within the `ts_library.sqlite` file inside each librar
|
||||
|
||||
File entries appear as thumbnails inside the grid display. The preview panel shows a more detailed preview of the file, along with extra file stats and all attached TagStudio tags and fields.
|
||||
|
||||
## Unlinked File Entries
|
||||
## Unlinked Entries
|
||||
|
||||
If the file that an entry is referencing has been moved, renamed, or deleted on disk, then TagStudio will display its unlinked status with a red chain-link icon instead of its thumbnail image. Certain uncached stats such as the file size and image dimensions will also be unavailable to see in the preview panel.
|
||||
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
---
|
||||
tags:
|
||||
- Upcoming Feature
|
||||
---
|
||||
|
||||
# Entry Groups
|
||||
|
||||
Entries can be grouped via tags marked as "groups" which when applied to different entries will signal TagStudio to treat those entries as a single group inside of searches and browsing.
|
||||
@@ -1,4 +1,8 @@
|
||||
# Fields
|
||||
---
|
||||
icon: material/text-box
|
||||
---
|
||||
|
||||
# :material-text-box: Fields
|
||||
|
||||
Fields are additional types of metadata that you can attach to [file entries](./entry.md). Like [tags](./tag.md), fields are not stored inside files themselves nor in sidecar files, but rather inside the respective TagStudio [library](./index.md) save file.
|
||||
|
||||
|
||||
@@ -1,5 +1,155 @@
|
||||
# Library
|
||||
# :material-database: Library
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! info
|
||||
This page is a work in progress and needs to be updated with additional information.
|
||||
|
||||
The library is how TagStudio represents your chosen directory, with every file inside being represented by a [file entry](./entry.md). You can have as many or few libraries as you wish, since each libraries' data is stored within a `.TagStudio` folder at its root. From there the library save file itself is stored as `ts_library.sqlite`, with TagStudio versions 9.4 and below using a the legacy `ts_library.json` format.
|
||||
|
||||
Note that this means [tags](./tag.md) you create only exist _per-library_.
|
||||
Note that this means [tags](./tag.md) you create only exist _per-library_. Global tags along with other library structure updates are planned for future releases on the [roadmap](../updates/roadmap.md#library).
|
||||
|
||||
---
|
||||
|
||||
## Preview Support
|
||||
|
||||
TagStudio offers built-in preview and thumbnail support for a wide variety of file types. Files that don't have explicit support can still be added to your library like normal, they will just show a default icon for thumbnails and previews. TagStudio also references the file's [MIME](https://en.wikipedia.org/wiki/Media_type) type in an attempt to render previews for file types that haven't gained explicit support yet.
|
||||
|
||||
### :material-image-outline: Images
|
||||
|
||||
Images will generate thumbnails the first time they are viewed or since the last time they were modified. Thumbnails are used in the grid view, but not in the Preview Panel. Animated images will play in the Preview Panel.
|
||||
|
||||
| Filetype | Extensions | Animation |
|
||||
| -------------------- | -------------------------------------------------- | :---------------------------------: |
|
||||
| Animated PNG | `.apng` | :material-check-circle:{.lg .green} |
|
||||
| Apple Icon Image | `.icns` | :material-minus-circle:{.lg .gray} |
|
||||
| AVIF | `.avif` | :material-minus-circle:{.lg .gray} |
|
||||
| Bitmap | `.bmp` | :material-minus-circle:{.lg .gray} |
|
||||
| GIF | `.gif` | :material-check-circle:{.lg .green} |
|
||||
| HEIF | `.heif`, `.heic` | :material-minus-circle:{.lg .gray} |
|
||||
| JPEG | `.jpeg`, `.jpg`, `.jfif`, `.jif`, `.jpg_large`[^1] | :material-minus-circle:{.lg .gray} |
|
||||
| JPEG-XL | `.jxl` | :material-close-circle:{.lg .red} |
|
||||
| OpenEXR | `.exr` | :material-minus-circle:{.lg .gray} |
|
||||
| OpenRaster | `.ora` | :material-minus-circle:{.lg .gray} |
|
||||
| PNG | `.png` | :material-minus-circle:{.lg .gray} |
|
||||
| SVG | `.svg` | :material-minus-circle:{.lg .gray} |
|
||||
| TIFF | `.tiff`, `.tif` | :material-minus-circle:{.lg .gray} |
|
||||
| Valve Texture Format | `.vtf` | :material-close-circle:{.lg .red} |
|
||||
| WebP | `.webp` | :material-check-circle:{.lg .green} |
|
||||
| Windows Icon | `.ico` | :material-minus-circle:{.lg .gray} |
|
||||
|
||||
#### :material-image-outline: RAW Images
|
||||
|
||||
| Filetype | Extensions |
|
||||
| -------------------------------- | ---------------------- |
|
||||
| Camera Image File Format (Canon) | `.crw`, `.cr2`, `.cr3` |
|
||||
| Digital Negative | `.dng` |
|
||||
| Fuji RAW | `.raf` |
|
||||
| Nikon RAW | `.nef`, `.nrw` |
|
||||
| Olympus RAW | `.orf` |
|
||||
| Panasonic RAW | `.raw`, `.rw2` |
|
||||
| Sony RAW | `.arw` |
|
||||
|
||||
### :material-movie-open: Videos
|
||||
|
||||
Video thumbnails will default to the closest viable frame from the middle of the video. Both thumbnail generation and video playback in the Preview Panel requires [FFmpeg](../install.md#third-party-dependencies) installed on your system.
|
||||
|
||||
| Filetype | Extensions | Dependencies |
|
||||
| --------------------- | ----------------------- | :----------: |
|
||||
| 3GP | `.3gp` | FFmpeg |
|
||||
| AVI | `.avi` | FFmpeg |
|
||||
| AVIF | `.avif` | FFmpeg |
|
||||
| FLV | `.flv` | FFmpeg |
|
||||
| HEVC | `.hevc` | FFmpeg |
|
||||
| Matroska | `.mkv` | FFmpeg |
|
||||
| MP4 | `.mp4` , `.m4p` | FFmpeg |
|
||||
| MPEG Transport Stream | `.ts` | FFmpeg |
|
||||
| QuickTime | `.mov`, `.movie`, `.qt` | FFmpeg |
|
||||
| WebM | `.webm` | FFmpeg |
|
||||
| WMV | `.wmv` | FFmpeg |
|
||||
|
||||
### :material-sine-wave: Audio
|
||||
|
||||
Audio thumbnails will default to embedded cover art (if any) andfallback to generated waveform thumbnails. Audio file playback is supported in the Preview Panel if you have [FFmpeg](../install.md#third-party-dependencies) installed on your system. Audio waveforms are currently not cached.
|
||||
|
||||
| Filetype | Extensions | Dependencies |
|
||||
| ------------------- | ------------------------ | :----------: |
|
||||
| AAC | `.aac`, `.m4a` | FFmpeg |
|
||||
| AIFF | `.aiff`, `.aif`, `.aifc` | FFmpeg |
|
||||
| Apple Lossless[^2] | `.alac`, `.aac` | FFmpeg |
|
||||
| FLAC | `.flac` | FFmpeg |
|
||||
| MP3 | `.mp3`, | FFmpeg |
|
||||
| Ogg | `.ogg` | FFmpeg |
|
||||
| WAVE | `.wav`, `.wave` | FFmpeg |
|
||||
| Windows Media Audio | `.wma` | FFmpeg |
|
||||
|
||||
### :material-file-chart: Documents
|
||||
|
||||
Preview support for office documents or well-known project file formats varies by the format and whether or not embedded thumbnails are available to be read from. OpenDocument-based files are typically supported.
|
||||
|
||||
| Filetype | Extensions | Preview Type |
|
||||
| ----------------------------- | --------------------- | -------------------------------------------------------------------------- |
|
||||
| Blender | `.blend`, `.blend<#>` | Embedded thumbnail :material-alert-circle:{ title="If available in file" } |
|
||||
| Keynote (Apple iWork) | `.key` | Embedded thumbnail |
|
||||
| Krita[^3] | `.kra`, `.krz` | Embedded thumbnail :material-alert-circle:{ title="If available in file" } |
|
||||
| MuseScore | `.mscz` | Embedded thumbnail :material-alert-circle:{ title="If available in file" } |
|
||||
| Numbers (Apple iWork) | `.numbers` | Embedded thumbnail |
|
||||
| OpenDocument Presentation | `.odp`, `.fodp` | Embedded thumbnail |
|
||||
| OpenDocument Spreadsheet | `.ods`, `.fods` | Embedded thumbnail |
|
||||
| OpenDocument Text | `.odt`, `.fodt` | Embedded thumbnail |
|
||||
| Pages (Apple iWork) | `.pages` | Embedded thumbnail |
|
||||
| PDF | `.pdf` | First page render |
|
||||
| Photoshop | `.psd` | Flattened image render |
|
||||
| PowerPoint (Microsoft Office) | `.pptx`, `.ppt` | Embedded thumbnail :material-alert-circle:{ title="If available in file" } |
|
||||
|
||||
### 3D Models
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! failure "3D Model Support"
|
||||
TagStudio does not currently support previews for 3D model files *(outside of Blender project embedded thumbnails)*. This is on our [roadmap](../updates/roadmap.md#uiux) for future features.
|
||||
|
||||
### :material-format-font: Fonts
|
||||
|
||||
Font thumbnails will use a "Aa" example preview of the font, with a full alphanumeric of the font available in the Preview Panel.
|
||||
|
||||
| Filetype | Extensions |
|
||||
| -------------------- | ----------------- |
|
||||
| OpenType Font | `.otf`, `.otc` |
|
||||
| TrueType Font | `.ttf`, `.ttc` |
|
||||
| Web Open Font Format | `.woff`, `.woff2` |
|
||||
|
||||
### :material-text-box: Text
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! info "Plain Text Support"
|
||||
TagStudio supports the *vast* majority of files considered to be "[plain text](https://en.wikipedia.org/wiki/Plain_text)". If an extension or format is not listed here, odds are it's still supported anyway.
|
||||
|
||||
Text files render the first 256 bytes of text information to an image preview for thumbnails and the Preview Panel. Improved thumbnails, full scrollable text, and syntax highlighting are on our [roadmap](../updates/roadmap.md#uiux) for future features.
|
||||
|
||||
| Filetype | Extensions | Syntax Highlighting |
|
||||
| ---------- | --------------------------------------------- | :--------------------------------: |
|
||||
| CSV | `.csv` | :material-close-circle:{.lg .red} |
|
||||
| HTML | `.html`, `.htm`, `.xhtml`, `.shtml`, `.dhtml` | :material-close-circle:{.lg .red} |
|
||||
| JSON | `.json`, `.jsonc`, `.json5` | :material-close-circle:{.lg .red} |
|
||||
| Markdown | `.md`, `.markdown`, `.mkd`, `.rmd` | :material-close-circle:{.lg .red} |
|
||||
| Plain Text | `.txt`, `.text` | :material-minus-circle:{.lg .gray} |
|
||||
| TOML | `.toml` | :material-close-circle:{.lg .red} |
|
||||
| XML | `.xml`, `.xul` | :material-close-circle:{.lg .red} |
|
||||
| YAML | `.yaml`, `.yml` | :material-close-circle:{.lg .red} |
|
||||
|
||||
### :material-file: Other
|
||||
|
||||
| Filetype | Extensions | Preview Type |
|
||||
| -------- | ---------- | -------------------- |
|
||||
| EPUB | `.epub` | Embedded ebook cover |
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
[^1]:
|
||||
The `.jpg_large` extension is unofficial and instead the byproduct of how [Google Chrome used to download images from Twitter](https://fileinfo.com/extension/jpg_large). Since this mangled extension is still in circulation, TagStudio supports it.
|
||||
|
||||
[^2]:
|
||||
Apple Lossless traditionally uses `.m4a` and `.caf` containers, but may unofficially use the `.alac` extension. The `.m4a` container is also used for separate compressed audio codecs.
|
||||
|
||||
[^3]:
|
||||
Krita also supports saving projects as OpenRaster `.ora` files. Support for these is listed in the "[Images](#images)" section.
|
||||
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
# Library Search
|
||||
---
|
||||
icon: material/magnify
|
||||
---
|
||||
|
||||
# :material-magnify: Search
|
||||
|
||||
TagStudio provides various methods to search your library, ranging from TagStudio data such as tags to inherent file data such as paths or media types.
|
||||
|
||||
@@ -74,7 +78,7 @@ TagStudio uses a "[smartcase](https://neovim.io/doc/user/options.html#'smartcase
|
||||
|
||||
#### Glob Syntax
|
||||
|
||||
Optionally, you may use [glob](https://en.wikipedia.org/wiki/Glob_(programming)) syntax to search filepaths.
|
||||
Optionally, you may use [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>) syntax to search filepaths.
|
||||
|
||||
#### Examples
|
||||
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
# Tags
|
||||
---
|
||||
icon: material/tag-text
|
||||
---
|
||||
|
||||
# :material-tag-text: Tags
|
||||
|
||||
Tags are discrete objects that represent some attribute. This could be a person, place, object, concept, and more. Unlike most tagging systems, TagStudio tags are not solely represented by a line of text or a hashtag. Tags in TagStudio consist of several properties and relationships that give extra customization, searching power, and ease of tagging that cannot be achieved by string-based tags alone. TagStudio tags are designed to be as simple or as complex as you'd like, giving options to users of all skill levels and use cases.
|
||||
|
||||
@@ -60,9 +64,9 @@ Lastly, when searching your files with broader categories such as `Character` or
|
||||
|
||||
### Component Tags
|
||||
|
||||
**_[Coming in version 9.6](../updates/roadmap.md#v96)_**
|
||||
**_Coming in version 9.6_**
|
||||
|
||||
Component tags will be built from a composition-based, or "HAS" type relationship between tags. This takes care of instances where an attribute may "have" another attribute, but doesn't inherit from it. Shrek may be an `Ogre`, he may be a `Character`, but he is NOT a `Leather Vest` - even if he's commonly seen _with_ it. Component tags, along with the upcoming [Tag Override](./tag_overrides.md) feature, are built to handle these cases in a way that still simplifies the tagging process without adding too much undue complexity for the user.
|
||||
Component tags will be built from a composition-based, or "HAS" type relationship between tags. This takes care of instances where an attribute may "have" another attribute, but doesn't inherit from it. Shrek may be an `Ogre`, he may be a `Character`, but he is NOT a `Leather Vest` - even if he's commonly seen _with_ it. Component tags, along with the upcoming "Tag Override" feature, are built to handle these cases in a way that still simplifies the tagging process without adding too much undue complexity for the user.
|
||||
|
||||
## Tag Appearance
|
||||
|
||||
@@ -80,7 +84,7 @@ Custom palettes and colors can be created via the [Tag Color Manager](./tag_colo
|
||||
|
||||
### Icon
|
||||
|
||||
**_[Coming in version 9.6](../updates/roadmap.md#v96)_**
|
||||
**_Coming in version 9.6_**
|
||||
|
||||
## Tag Properties
|
||||
|
||||
@@ -94,7 +98,7 @@ When the "Is Category" property is checked, this tag now acts as a category sepa
|
||||
|
||||
#### Is Hidden
|
||||
|
||||
**_[Coming in version 9.6](../updates/roadmap.md#v96)_**
|
||||
**_Coming in version 9.6_**
|
||||
|
||||
When the "Is Hidden" property is checked, any file entries tagged with this tag will not show up in searches by default. This property comes by default with the built-in "Archived" tag.
|
||||
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
---
|
||||
tags:
|
||||
icon: material/shape-plus
|
||||
---
|
||||
|
||||
# Tag Categories
|
||||
# :material-shape-plus: Tag Categories
|
||||
|
||||
The "Is Category" property of tags determines if a tag should be treated as a category itself when being organized inside the preview panel. Tags marked as categories will show themselves and all tags inheriting from it (including recursively) underneath a field-like section with the tag's name. This means that duplicates of tags can appear on entries if the tag inherits from multiple parent categories, however this is by design and reflects the nature of multiple inheritance. Any tags not inheriting from a category tag will simply show under a default "Tag" section.
|
||||
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
# Tag Colors
|
||||
---
|
||||
icon: material/palette
|
||||
---
|
||||
|
||||
# :material-palette: Tag Colors
|
||||
|
||||
TagStudio features a variety of built-in tag colors, alongside the ability for users to create their own custom tag color palettes.
|
||||
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
---
|
||||
tags:
|
||||
- Upcoming Feature
|
||||
---
|
||||
|
||||
# Tag Overrides
|
||||
|
||||
Tag overrides are the ability to add or remove [parent tags](./tag.md#parent-tags) from a [tag](./tag.md) on a per-[entry](./entry.md) basis.
|
||||
|
||||
## Examples
|
||||
|
||||
<figure markdown="span">
|
||||
{ height="300" }
|
||||
<figcaption>Ex. 1 - Comparing standard tag composition vs additive and subtractive inheritance overrides.</figcaption>
|
||||
</figure>
|
||||
|
||||
<figure markdown="span">
|
||||
{ height="300" }
|
||||
<figcaption>Ex. 2 - Parent tag swap using tag overrides.</figcaption>
|
||||
</figure>
|
||||
@@ -26,6 +26,18 @@
|
||||
);
|
||||
}
|
||||
|
||||
/* Mobile Nav Header */
|
||||
.md-nav__source {
|
||||
background: linear-gradient(
|
||||
60deg,
|
||||
rgb(205, 78, 255) 0%,
|
||||
rgb(116, 123, 255) 100%
|
||||
);
|
||||
border-style: solid;
|
||||
border-width: 0 0 2px 0;
|
||||
border-color: #ffffff33;
|
||||
}
|
||||
|
||||
th,
|
||||
td {
|
||||
padding: 0.5em 1em 0.5em 1em !important;
|
||||
@@ -68,6 +80,10 @@ h2,
|
||||
margin-right: -0.8rem;
|
||||
}
|
||||
|
||||
figcaption {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
.md-search__form {
|
||||
height: 1.5rem;
|
||||
background-color: #00004444;
|
||||
@@ -81,8 +97,12 @@ h2,
|
||||
margin-top: -0.2rem;
|
||||
}
|
||||
|
||||
.twemoji {
|
||||
margin-top: 0.05rem;
|
||||
h1 > .twemoji {
|
||||
margin-top: 0.14rem;
|
||||
}
|
||||
|
||||
h2 > .twemoji {
|
||||
margin-top: 0.08rem;
|
||||
}
|
||||
|
||||
/* Matches the palette used by mkdocs-material */
|
||||
@@ -97,3 +117,39 @@ h2,
|
||||
.priority-low {
|
||||
color: #28afff;
|
||||
}
|
||||
|
||||
.red {
|
||||
color: rgb(245, 0, 87);
|
||||
}
|
||||
|
||||
.amber {
|
||||
color: rgb(255, 145, 0);
|
||||
}
|
||||
|
||||
.green {
|
||||
color: rgb(0, 191, 165);
|
||||
}
|
||||
|
||||
.gray {
|
||||
color: rgb(158, 158, 158);
|
||||
}
|
||||
|
||||
@media screen and (max-width: 76.234375em) {
|
||||
/* Always show image logo on mobile */
|
||||
.md-header__button.md-logo {
|
||||
display: block;
|
||||
}
|
||||
|
||||
label[for="__drawer"].md-header__button.md-icon {
|
||||
order: -1;
|
||||
}
|
||||
|
||||
.md-header {
|
||||
background: linear-gradient(
|
||||
60deg,
|
||||
rgb(205, 78, 255) 10%,
|
||||
rgb(116, 123, 255) 70%,
|
||||
rgb(72, 179, 255) 100%
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
14
docs/stylesheets/home.css
Normal file
14
docs/stylesheets/home.css
Normal file
@@ -0,0 +1,14 @@
|
||||
h2 {
|
||||
margin: 1rem 0 0 0 !important;
|
||||
}
|
||||
|
||||
.md-content .md-typeset h1 {
|
||||
/* display: none; */
|
||||
font-size: 0;
|
||||
}
|
||||
|
||||
.grid > p {
|
||||
align-content: center;
|
||||
font-size: 1rem !important;
|
||||
line-height: 1.25rem;
|
||||
}
|
||||
@@ -1,4 +1,6 @@
|
||||
---
|
||||
title: Changelog
|
||||
icon: material/list-status
|
||||
---
|
||||
--8<-- "CHANGELOG.md"
|
||||
|
||||
--8<-- "CHANGELOG.md"
|
||||
|
||||
@@ -1,217 +1,283 @@
|
||||
# Feature Roadmap
|
||||
---
|
||||
icon: material/map-check
|
||||
---
|
||||
|
||||
This checklist details the current and remaining features required at a minimum for TagStudio to be considered "Feature Complete". This list is _not_ a definitive list for additional feature requests and PRs as they come in, but rather an outline of my personal core feature set intended for TagStudio.
|
||||
# :material-map-check: Roadmap
|
||||
|
||||
## Priorities
|
||||
This page outlines the current and planned features required for TagStudio to be considered "feature complete" (v10.0.0). Features and changes are broken up by group in order to better assess the overall state of those features. [Priority levels](#priority-levels) and [version estimates](#version-estimates) are provided in order to give a rough idea of what's planned and when it may release.
|
||||
|
||||
Features are broken up into the following priority levels, with nested priorities referencing their relative priority for the overall feature (i.e. A [LOW] priority feature can have a [HIGH] priority element but it otherwise still a [LOW] priority item overall):
|
||||
This roadmap will update as new features are planned or completed. If there's a feature you'd like to see but is not listed on this page, please check the GitHub [Issues](https://github.com/TagStudioDev/TagStudio/issues) page and submit a feature request if one does not already exist!
|
||||
|
||||
- [HIGH] - Core feature
|
||||
- [MEDIUM] - Important but not necessary
|
||||
- [LOW] - Just nice to have
|
||||
## Priority Levels
|
||||
|
||||
## Version Milestones
|
||||
Planned features and changes are assigned **priority levels** to signify how important they are to the feature-complete version of TagStudio and to serve as a general guide for what should be worked on first, along with [version estimates](#version-estimates). When features are completed, their priority level icons are removed.
|
||||
|
||||
These version milestones are rough estimations for when the previous core features will be added. For a more definitive idea for when features are coming, please reference the current GitHub [milestones](https://github.com/TagStudioDev/TagStudio/milestones).
|
||||
<!-- prettier-ignore -->
|
||||
!!! info "Priority Level Icons"
|
||||
- :material-chevron-triple-up:{ .priority-high title="High Priority" } **High Priority** - Core features
|
||||
- :material-chevron-double-up:{ .priority-med title="Medium Priority" } **Medium Priority** - Important, but not necessary
|
||||
- :material-chevron-up:{ .priority-low title="Low Priority" } **Low Priority** - Just nice to have
|
||||
|
||||
## Version Estimates
|
||||
|
||||
Features are given rough estimations for which version they will be completed in, and are listed next to their names (e.g. Feature **[v9.0.0]**). They are eventually replaced with links to the version changelog in which they were completed in, if applicable.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip
|
||||
For a more definitive and up-to-date list of features planned for near-future updates, please reference the current GitHub [Milestones](https://github.com/TagStudioDev/TagStudio/milestones)!
|
||||
|
||||
---
|
||||
|
||||
## Core
|
||||
|
||||
### :material-database: SQL Library Database
|
||||
|
||||
An improved SQLite-based library save file format in which legacy JSON libraries are be migrated to.
|
||||
Must be finalized or deemed "feature complete" before other core features are developed or finalized.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! note
|
||||
This list was created after the release of version 9.4
|
||||
See the "[Library](#library)" section for features related to the library database rather than the underlying schema.
|
||||
|
||||
### v9.5
|
||||
- [x] A SQLite-based library save file format **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [ ] Cached File Properties Table :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [x] Date Entry Added to Library :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Date File Created :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Date File Modified :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Date Photo Taken :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Media Duration :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Media Dimensions :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Word Count :material-chevron-up:{ .priority-low title="Low Priority" }
|
||||
|
||||
#### Core
|
||||
### :material-database-cog: Core Library + API
|
||||
|
||||
- [x] SQL backend [HIGH]
|
||||
A separated, UI agnostic core library that would be used to interface with the TagStudio library format. Would host an API for communication from outside the program. This would be licensed under the more permissive [MIT](https://en.wikipedia.org/wiki/MIT_License) license to foster wider adoption compared to the TagStudio application source code.
|
||||
|
||||
#### Tags
|
||||
- [ ] Core Library :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
|
||||
- [ ] Core Library API :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
|
||||
- [ ] MIT License :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
|
||||
|
||||
- [x] Deleting Tags [HIGH]
|
||||
- [ ] User-defined tag colors [HIGH]
|
||||
- [x] ID based, not string or hex [HIGH]
|
||||
- [x] Color name [HIGH]
|
||||
- [x] Color value (hex) [HIGH]
|
||||
- [x] Existing colors are now a set of base colors [HIGH]
|
||||
- [x] [Tag Categories](../library/tag_categories.md) [HIGH]
|
||||
- [x] Property available for tags that allow the tag and any inheriting from it to be displayed separately in the preview panel under a title [HIGH]
|
||||
### :material-clipboard-text: Format Specification
|
||||
|
||||
#### Search
|
||||
A detailed written specification for the TagStudio tag and/or library format. Intended for used by third-parties to build alternative cores or protocols that can remain interoperable.
|
||||
|
||||
- [x] Boolean operators [HIGH]
|
||||
- [x] Filename search [HIGH]
|
||||
- [x] File type search [HIGH]
|
||||
- [x] Search by extension (e.g. ".jpg", ".png") [HIGH]
|
||||
- [x] Optional consolidation of extension synonyms (i.e. ".jpg" can equal ".jpeg") [LOW]
|
||||
- [x] Search by media type (e.g. "image", "video", "document") [MEDIUM]
|
||||
- [x] Sort by date added [HIGH]
|
||||
- [ ] Format Specification Established :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
|
||||
|
||||
#### UI
|
||||
---
|
||||
|
||||
- [x] Translations _(Any applicable)_ [MEDIUM]
|
||||
- [x] Unified Media Player [HIGH]
|
||||
- [x] Auto-hiding player controls
|
||||
- [x] Play/Pause [HIGH]
|
||||
- [x] Loop [HIGH]
|
||||
- [x] Toggle Autoplay [MEDIUM]
|
||||
- [x] Volume Control [HIGH]
|
||||
- [x] Toggle Mute [HIGH]
|
||||
- [x] Timeline scrubber [HIGH]
|
||||
- [ ] Fullscreen [MEDIUM]
|
||||
- [x] Configurable page size [HIGH]
|
||||
## Application
|
||||
|
||||
#### Performance
|
||||
### :material-button-cursor: UI/UX
|
||||
|
||||
- [x] Thumbnail caching [HIGH]
|
||||
- [x] Library Grid View
|
||||
- [ ] Explore Filesystem in Grid View :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Infinite Scrolling (No Pagination) :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Library List View :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Explore Filesystem in List View :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Lightbox View :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- Similar to List View in concept, but displays one large preview that can cycle back/forth between entries.
|
||||
- [ ] Smaller thumbnails of immediate adjacent entries below :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [x] Library Statistics Screen :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.4]**
|
||||
- [ ] Unified Library Health/Cleanup Screen :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.4]**
|
||||
- [x] Fix Unlinked Entries
|
||||
- [x] Fix Duplicate Files
|
||||
- [x] ~~Fix Duplicate Entries~~
|
||||
- [ ] Remove Ignored Entries :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.4]**
|
||||
- [ ] Delete Old Backups :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.5]**
|
||||
- [ ] Delete Legacy JSON File :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.5]**
|
||||
- [x] Translations
|
||||
- [ ] Search Bar Rework :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.0]**
|
||||
- [ ] Improved Tag Autocomplete :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Tags appear as widgets in search bar :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [x] Unified Media Player
|
||||
- [x] Auto-Hiding Player Controls
|
||||
- [x] Play/Pause
|
||||
- [x] Loop
|
||||
- [x] Toggle Autoplay
|
||||
- [x] Volume Control
|
||||
- [x] Toggle Mute
|
||||
- [x] Timeline scrubber
|
||||
- [ ] Fullscreen :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Fine-Tuned UI/UX :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6]**
|
||||
- [ ] 3D Model Thumbnails/Previews :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] STL File Support
|
||||
- [ ] OBJ File Support
|
||||
- [ ] Plaintext Thumbnails/Previews :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [x] Basic Support
|
||||
- [ ] Full File Preview :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Syntax Highlighting :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Toggleable Persistent Tagging Panel :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Top Tags
|
||||
- [ ] Recent Tags
|
||||
- [ ] Tag Search
|
||||
- [ ] Pinned Tags
|
||||
- [ ] New Tabbed Tag Building UI to Support New Tag Features :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Custom Thumbnail Overrides :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Media Duration Labels :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Word/Line Count Labels :material-chevron-up:{ .priority-low title="Low Priority" }
|
||||
- [ ] Custom Tag Badges :material-chevron-up:{ .priority-low title="Low Priority" }
|
||||
- Would serve as an addition/alternative to the Favorite and Archived badges.
|
||||
|
||||
### v9.6
|
||||
### :material-cog: Settings
|
||||
|
||||
#### Core
|
||||
- [x] Application Settings
|
||||
- [x] Stored in System User Folder/Designated Folder
|
||||
- [x] Language
|
||||
- [x] Date and Time Format
|
||||
- [x] Theme
|
||||
- [x] Thumbnail Generation :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.4]**
|
||||
- [x] Configurable Page Size
|
||||
- [ ] Library Settings :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Stored in `.TagStudio` folder :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Toggle File Extension Label :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Toggle Duration Label :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
|
||||
- [ ] Cached file property table (media duration, word count, dimensions, etc.) [MEDIUM]
|
||||
### :material-puzzle: Plugin Support
|
||||
|
||||
#### Library
|
||||
Some form of official plugin support for TagStudio, likely with its own API that may connect to or encapsulate part of the the [core library API](#core-library-api).
|
||||
|
||||
- [ ] Multiple Root Directories per Library [HIGH]
|
||||
- [ ] `.ts_ignore` (`.gitignore`-style glob ignoring) [HIGH]
|
||||
- [ ] Sharable Color Packs [MEDIUM]
|
||||
- [ ] Human-readable (TOML) files containing tag data [HIGH]
|
||||
- [ ] Importable [HIGH]
|
||||
- [ ] Exportable [HIGH]
|
||||
- [ ] Plugin Support :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
|
||||
|
||||
#### Tags
|
||||
---
|
||||
|
||||
- [ ] Merging Tags [HIGH]
|
||||
- [ ] [Component/HAS](../library/tag.md#component-tags) subtags [HIGH]
|
||||
- [ ] Tag Icons [HIGH]
|
||||
- [ ] Small Icons [HIGH]
|
||||
- [ ] Large Icons for Profiles [MEDIUM]
|
||||
- [ ] Built-in Icon Packs (i.e. Boxicons) [HIGH]
|
||||
- [ ] User Defined Icons [HIGH]
|
||||
- [ ] Multiple Languages for Tag Strings [MEDIUM]
|
||||
- [ ] Title is tag name [HIGH]
|
||||
- [ ] Title has tag color [MEDIUM]
|
||||
- [ ] Tag marked as category does not display as a tag itself [HIGH]
|
||||
- [ ] [Tag Overrides](../library/tag_overrides.md) [MEDIUM]
|
||||
- [ ] Per-file overrides of subtags [HIGH]
|
||||
## [Library](../library/index.md)
|
||||
|
||||
#### Fields
|
||||
### :material-wrench: Library Mechanics
|
||||
|
||||
- [ ] Datetime fields [HIGH]
|
||||
- [ ] Custom field names [HIGH]
|
||||
- [x] Per-Library Tags
|
||||
- [ ] Global Tags :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Multiple Root Directories :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Ability to store TagStudio library folder separate from library files :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Automatic Entry Relinking :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.0]**
|
||||
- [ ] Detect Renames :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Detect Moves :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Detect Deletions :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Performant :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Background File Scanning :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.0]**
|
||||
- [x] Thumbnail Caching **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [ ] Audio Waveform Caching :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.7.0]**
|
||||
|
||||
#### Search
|
||||
### :material-grid: [Entries](../library/entry.md)
|
||||
|
||||
- [ ] Field content search [HIGH]
|
||||
- [ ] Sort by date created [HIGH]
|
||||
- [ ] Sort by date modified [HIGH]
|
||||
- [x] Sort by filename [HIGH]
|
||||
- [ ] HAS operator for composition tags [HIGH]
|
||||
- [ ] Search bar rework
|
||||
- [ ] Improved tag autocomplete [HIGH]
|
||||
- [ ] Tags appear as widgets in search bar [HIGH]
|
||||
Library representations of files or file-like objects.
|
||||
|
||||
#### UI
|
||||
- [x] File Entries **[v1.0.0]**
|
||||
- [ ] Folder Entries :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] URL Entries / Bookmarks :material-chevron-up:{ .priority-low title="Low Priority" }
|
||||
- [x] Fields
|
||||
- [x] Text Lines
|
||||
- [x] Text Boxes
|
||||
- [x] Datetimes **[v9.5.4]**
|
||||
- [ ] User-Titled Fields :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Removal of Deprecated Fields :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Entry Groups :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.0]**
|
||||
- [ ] Non-exclusive; Entries can be in multiple groups :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Ability to number entries within group :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Ability to set sorting method for group :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Ability to set custom thumbnail for group :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Group is treated as entry with tags and metadata :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Nested groups :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
|
||||
- [ ] File duration on video thumbnails [HIGH]
|
||||
- [ ] 3D Model Previews [MEDIUM]
|
||||
- [ ] STL Previews [HIGH]
|
||||
- [ ] Word count/line count on text thumbnails [LOW]
|
||||
- [x] Settings Menu [HIGH]
|
||||
- [x] Application Settings [HIGH]
|
||||
- [x] Stored in system user folder/designated folder [HIGH]
|
||||
- [ ] Library Settings [HIGH]
|
||||
- [ ] Stored in `.TagStudio` folder [HIGH]
|
||||
- [ ] Tagging Panel [HIGH]
|
||||
### :material-tag-text: [Tags](../library/tag.md)
|
||||
|
||||
Toggleable persistent main window panel or pop-out. Replaces the current tag manager.
|
||||
Discrete library objects representing [attributes](<https://en.wikipedia.org/wiki/Property_(philosophy)>). Can be applied to library [entries](../library/entry.md), or applied to other tags to build traversable relationships.
|
||||
|
||||
- [ ] Top Tags [HIGH]
|
||||
- [ ] Recent Tags [HIGH]
|
||||
- [ ] Tag Search [HIGH]
|
||||
- [ ] Pinned Tags [HIGH]
|
||||
- [x] Tag Name **[v8.0.0]**
|
||||
- [x] Tag Shorthand Name **[v8.0.0]**
|
||||
- [x] Tag Aliases List **[v8.0.0]**
|
||||
- [x] Tag Color **[v8.0.0]**
|
||||
- [ ] Tag Description :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.6.0]**
|
||||
- [x] Tag Colors
|
||||
- [x] Built-in Color Palette **[v8.0.0]**
|
||||
- [x] User-Defined Colors **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [x] Primary and Secondary Colors **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [ ] Tag Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Small Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Large Icons for Profiles :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.6.0]**
|
||||
- [ ] Built-in Icon Packs (i.e. Boxicons) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] User-Defined Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [x] [Category Property](../library/tag_categories.md) **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [x] Property available for tags that allow the tag and any inheriting from it to be displayed separately in the preview panel under a title
|
||||
- [ ] Fine-tuned exclusion from categories :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Hidden Property :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Built-in "Archived" tag has this property by default :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Checkbox near search bar to show hidden tags in search :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Tag Relationships
|
||||
- [x] [Parent Tags](../library/tag.md#parent-tags) ([Inheritance](<https://en.wikipedia.org/wiki/Inheritance_(object-oriented_programming)>) Relationship) **[v9.0.0]**
|
||||
- [ ] [Component Tags](../library/tag.md#component-tags) ([Composition](https://en.wikipedia.org/wiki/Object_composition) Relationship) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Multiple Language Support :material-chevron-up:{ .priority-low title="Low Priority" } **[v9.9.0]**
|
||||
- [ ] Tag Overrides :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Tag Merging :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
|
||||
- [ ] New tabbed tag building UI to support the new tag features [HIGH]
|
||||
### :material-magnify: [Search](../library/library_search.md)
|
||||
|
||||
### v9.7
|
||||
- [x] Tag Search **[v8.0.0]**
|
||||
- [x] Filename Search **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [x] Glob Search **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [x] Filetype Search **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [x] Search by Extension (e.g. ".jpg", ".png") **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [x] Optional consolidation of extension synonyms (i.e. ".jpg" can equal ".jpeg") **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [x] Search by media type (e.g. "image", "video", "document") **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [ ] Field Content Search :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [x] [Boolean Operators](../library/library_search.md) **[[v9.5.0](./changelog.md#950-2025-03-03)]**
|
||||
- [x] `AND` Operator
|
||||
- [x] `OR` Operator
|
||||
- [x] `NOT` Operator
|
||||
- [x] Parenthesis Grouping
|
||||
- [x] Character Escaping
|
||||
- [ ] `HAS` Operator (for [Component Tags](../library/tag.md#component-tags)) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Conditional Search :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.7.0]**
|
||||
- [ ] Compare Dates :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Compare Durations :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Compare File Sizes :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Compare Dimensions :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [x] Smartcase Search [[v9.5.0](./changelog.md#950-2025-03-03)]
|
||||
- [ ] Search Result Sorting
|
||||
- [x] Sort by Filename **[[v9.5.2](./changelog.md#952-2025-03-31)]**
|
||||
- [x] Sort by Date Entry Added to Library **[[v9.5.2](./changelog.md#952-2025-03-31)]**
|
||||
- [ ] Sort by File Creation Date :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Sort by File Modification Date :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [ ] Sort by File Modification Date :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Sort by Date Taken (Photos) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]**
|
||||
- [x] Random/Shuffle Sort
|
||||
- [ ] OCR Search :material-chevron-up:{ .priority-low title="Low Priority" }
|
||||
- [ ] Fuzzy Search :material-chevron-up:{ .priority-low title="Low Priority" }
|
||||
|
||||
#### Library
|
||||
### :material-file-cog: [Macros](../utilities/macro.md)
|
||||
|
||||
- [ ] [Entry groups](../library/entry_groups.md) [HIGH]
|
||||
- [ ] Groups for files/entries where the same entry can be in multiple groups [HIGH]
|
||||
- [ ] Ability to number entries within group [HIGH]
|
||||
- [ ] Ability to set sorting method for group [HIGH]
|
||||
- [ ] Ability to set custom thumbnail for group [HIGH]
|
||||
- [ ] Group is treated as entry with tags and metadata [HIGH]
|
||||
- [ ] Nested groups [MEDIUM]
|
||||
|
||||
#### Search
|
||||
|
||||
- [ ] Sort by relevance [HIGH]
|
||||
- [ ] Sort by date taken (photos) [MEDIUM]
|
||||
- [ ] Sort by file size [HIGH]
|
||||
- [ ] Sort by file dimension (images/video) [LOW]
|
||||
|
||||
#### [Macros](../utilities/macro.md)
|
||||
|
||||
- [ ] Sharable Macros [MEDIUM]
|
||||
- [ ] Standard notation format (TOML) contacting macro instructions [HIGH]
|
||||
- [ ] Exportable [HIGH]
|
||||
- [ ] Importable [HIGH]
|
||||
- [ ] Triggers [HIGH]
|
||||
- [ ] On new file [HIGH]
|
||||
- [ ] On library refresh [HIGH]
|
||||
- [ ] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.5]**
|
||||
- [ ] Versioning System :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.5]**
|
||||
- [ ] Triggers **[v9.5.5]**
|
||||
- [ ] On File Added :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] On Library Refresh :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] [...]
|
||||
- [ ] Actions [HIGH]
|
||||
- [ ] Add tag(s) [HIGH]
|
||||
- [ ] Add field(s) [HIGH]
|
||||
- [ ] Set field content [HIGH]
|
||||
- [ ] Actions **[v9.5.5]**
|
||||
- [ ] Add Tag(s) :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Add Field(s) :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Set Field Content :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] [...]
|
||||
|
||||
#### UI
|
||||
### :material-table-arrow-right: Sharable Data
|
||||
|
||||
- [ ] Custom thumbnail overrides [MEDIUM]
|
||||
- [ ] Toggle File Extension Label [MEDIUM]
|
||||
- [ ] Toggle Duration Label [MEDIUM]
|
||||
- [ ] Custom Tag Badges [LOW]
|
||||
- [ ] Library list view [HIGH]
|
||||
Sharable TagStudio library data in the form of data packs (tags, colors, etc.) or other formats.
|
||||
Packs are intended as an easy way to import and export specific data between libraries and users, while export-only formats are intended to be imported by other programs.
|
||||
|
||||
### v9.8
|
||||
|
||||
#### Library
|
||||
|
||||
- [ ] Automatic Entry Relinking [HIGH]
|
||||
- [ ] Detect Renames [HIGH]
|
||||
- [ ] Detect Moves [HIGH]
|
||||
- [ ] Detect Deletions [HIGH]
|
||||
|
||||
#### Search
|
||||
|
||||
- [ ] OCR search [LOW]
|
||||
- [ ] Fuzzy Search [LOW]
|
||||
|
||||
### v9.9
|
||||
|
||||
#### Library
|
||||
|
||||
- [ ] Exportable Library Data [HIGH]
|
||||
- [ ] Standard notation format (i.e. JSON) contacting all library data [HIGH]
|
||||
|
||||
#### Tags
|
||||
|
||||
- [ ] Tag Packs [MEDIUM]
|
||||
- [ ] Human-readable (TOML) files containing tag data [HIGH]
|
||||
- [ ] Multiple Languages for Tag Strings [MEDIUM]
|
||||
- [ ] Importable [HIGH]
|
||||
- [ ] Exportable [HIGH]
|
||||
- [ ] Conflict resolution [HIGH]
|
||||
|
||||
### v10.0
|
||||
|
||||
- [ ] All remaining [HIGH] and optional [MEDIUM] features
|
||||
|
||||
### Post v10.0
|
||||
|
||||
#### Core
|
||||
|
||||
- [ ] Core Library/API
|
||||
- [ ] Plugin Support
|
||||
- [ ] Color Packs :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.5]**
|
||||
- [ ] Importable
|
||||
- [ ] Exportable
|
||||
- [x] UUIDs + Namespaces :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [x] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Versioning System :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Tag Packs :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.9.0]**
|
||||
- [ ] Importable :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Exportable :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] UUIDs + Namespaces :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Versioning System :material-chevron-double-up:{ .priority-med title="Medium Priority" }
|
||||
- [ ] Macro Sharing :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.5]**
|
||||
- [ ] Importable :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Exportable :material-chevron-triple-up:{ .priority-high title="High Priority" }
|
||||
- [ ] Sharable Entry Data :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.9.0]**
|
||||
- _Specifics of this are yet to be determined_
|
||||
- [ ] Export Library to Human Readable Format :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]**
|
||||
- Intended to give users more flexible options with their data if they wish to migrate away from TagStudio
|
||||
|
||||
@@ -1,14 +1,22 @@
|
||||
# Save Format Changes
|
||||
---
|
||||
icon: material/database-edit
|
||||
---
|
||||
|
||||
This page outlines the various changes made to the TagStudio save file format over time, sometimes referred to as the "database" or "database file".
|
||||
# :material-database-edit: Save Format Changes
|
||||
|
||||
This page outlines the various changes made to the TagStudio library save file format over time, sometimes referred to as the "database" or "database file".
|
||||
|
||||
---
|
||||
|
||||
## JSON
|
||||
|
||||
| Used From | Used Until | Format | Location |
|
||||
| --------- | ----------------------------------------------------------------------- | ------ | --------------------------------------------- |
|
||||
| v1.0.0 | [v9.4.2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.4.2) | JSON | `<Library Folder>`/.TagStudio/ts_library.json |
|
||||
Legacy (JSON) library save format versions were tied to the release version of the program itself. This number was stored in a `version` key inside the JSON file.
|
||||
|
||||
### Versions 1.0.0 - 9.4.2
|
||||
|
||||
| Used From | Format | Location |
|
||||
| --------- | ------ | --------------------------------------------- |
|
||||
| v1.0.0 | JSON | `<Library Folder>`/.TagStudio/ts_library.json |
|
||||
|
||||
The legacy database format for public TagStudio releases [v9.1](https://github.com/TagStudioDev/TagStudio/tree/Alpha-v9.1) through [v9.4.2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.4.2). Variations of this format had been used privately since v1.0.0.
|
||||
|
||||
@@ -16,11 +24,33 @@ Replaced by the new SQLite format introduced in TagStudio [v9.5.0 Pre-Release 1]
|
||||
|
||||
---
|
||||
|
||||
## DB_VERSION 6
|
||||
## SQLite
|
||||
|
||||
| Used From | Used Until | Format | Location |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.0-PR1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | [v9.5.0-PR1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
Starting with TagStudio [v9.5.0-pr1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1), the library save format has been moved to a [SQLite](https://sqlite.org) format. Legacy JSON libraries are migrated (with the user's consent) to the new format when opening in current versions of the program. The save format versioning is now separate from the program's versioning number.
|
||||
|
||||
Versions **1-100** stored the database version in a table called `preferences` in a row with the `key` column of `"DB_VERSION"` inside the corresponding `value` column.
|
||||
|
||||
Versions **>101** store the database version in a table called `versions` in a row with the `key` column of `'CURRENT'` inside the corresponding `value` column. The `versions` table also stores the initial database version in which the file was created with under the `'INITIAL'` key. Databases created before this key was introduced will always have `'INITIAL'` value of `100`.
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
versions {
|
||||
TEXT key PK "Values: ['INITIAL', 'CURRENT']"
|
||||
INTEGER value
|
||||
}
|
||||
```
|
||||
|
||||
### Versions 1 - 5
|
||||
|
||||
These versions were used while developing the new SQLite file format, outside any official or recommended release. These versions **were never supported** in any official capacity and were actively warned against using for real libraries.
|
||||
|
||||
---
|
||||
|
||||
### Version 6
|
||||
|
||||
| Used From | Format | Location |
|
||||
| ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.0-pr1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
|
||||
The first public version of the SQLite save file format.
|
||||
|
||||
@@ -28,22 +58,22 @@ Migration from the legacy JSON format is provided via a walkthrough when opening
|
||||
|
||||
---
|
||||
|
||||
## DB_VERSION 7
|
||||
### Version 7
|
||||
|
||||
| Used From | Used Until | Format | Location |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.0-PR2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr2) | [v9.5.0-PR3](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr3) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
| Used From | Format | Location |
|
||||
| ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.0-pr2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr2) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
|
||||
- Repairs "Description" fields to use a TEXT_LINE key instead of a TEXT_BOX key.
|
||||
- Repairs tags that may have a disambiguation_id pointing towards a deleted tag.
|
||||
|
||||
---
|
||||
|
||||
## DB_VERSION 8
|
||||
### Version 8
|
||||
|
||||
| Used From | Used Until | Format | Location |
|
||||
| ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.0-PR4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr4) | [v9.5.1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
| Used From | Format | Location |
|
||||
| ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.0-pr4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr4) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
|
||||
- Adds the `color_border` column to the `tag_colors` table. Used for instructing the [secondary color](../library/tag_color.md#secondary-color) to apply to a tag's border as a new optional behavior.
|
||||
- Adds three new default colors: "Burgundy (TagStudio Shades)", "Dark Teal (TagStudio Shades)", and "Dark Lavender (TagStudio Shades)".
|
||||
@@ -51,10 +81,45 @@ Migration from the legacy JSON format is provided via a walkthrough when opening
|
||||
|
||||
---
|
||||
|
||||
## DB_VERSION 9
|
||||
### Version 9
|
||||
|
||||
| Used From | Used Until | Format | Location |
|
||||
| ----------------------------------------------------------------------- | ---------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.2) | _Current_ | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
| Used From | Format | Location |
|
||||
| ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.2](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.2) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
|
||||
- Adds the `filename` column to the `entries` table. Used for sorting entries by filename in search results.
|
||||
|
||||
---
|
||||
|
||||
### Version 100
|
||||
|
||||
| Used From | Format | Location |
|
||||
| ---------------------------------------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [74383e3](https://github.com/TagStudioDev/TagStudio/commit/74383e3c3c12f72be1481ab0b86c7360b95c2d85) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
|
||||
- Introduces built-in minor versioning
|
||||
- The version number divided by 100 (and floored) constitutes the **major** version. Major version indicate breaking changes that prevent libraries from being opened in TagStudio versions older than the ones they were created in.
|
||||
- Values more precise than this ("ones" through "tens" columns) constitute the **minor** version. These indicate minor changes that don't prevent a newer library from being opened in an older version of TagStudio, as long as the major version is not also increased.
|
||||
- Swaps `parent_id` and `child_id` values in the `tag_parents` table
|
||||
|
||||
#### Version 101
|
||||
|
||||
| Used From | Format | Location |
|
||||
| ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.4) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
|
||||
- Deprecates the `preferences` table, set to be removed in a future TagStudio version.
|
||||
- Introduces the `versions` table
|
||||
- Has a string `key` column and an int `value` column
|
||||
- The `key` column stores one of two values: `'INITIAL'` and `'CURRENT'`
|
||||
- `'INITIAL'` stores the database version number in which in was created
|
||||
- Pre-existing databases set this number to `100`
|
||||
- `'CURRENT'` stores the current database version number
|
||||
|
||||
#### Version 102
|
||||
|
||||
| Used From | Format | Location |
|
||||
| ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
|
||||
| [v9.5.4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.4) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
|
||||
- Applies repairs to the `tag_parents` table created in [version 100](#version-100), removing rows that reference tags that have been deleted.
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
# Usage
|
||||
---
|
||||
icon: material/mouse
|
||||
---
|
||||
|
||||
# :material-mouse: Usage
|
||||
|
||||
## Creating/Opening a Library
|
||||
|
||||
@@ -67,7 +71,9 @@ As of version 9.5, libraries are saved automatically as you go. To save a backup
|
||||
|
||||
There are a handful of launch arguments you can pass to TagStudio via the command line or a desktop shortcut.
|
||||
|
||||
| Argument | Short | Description |
|
||||
| ---------------------- | ----- | ---------------------------------------------------- |
|
||||
| `--open <path>` | `-o` | Path to a TagStudio Library folder to open on start. |
|
||||
| `--config-file <path>` | `-c` | Path to the TagStudio config file to load. |
|
||||
| Argument | Short | Description |
|
||||
| ------------------------ | ----- | ------------------------------------------------------ |
|
||||
| `--cache-file <path>` | `-c` | Path to a TagStudio .ini or .plist cache file to use. |
|
||||
| `--open <path>` | `-o` | Path to a TagStudio Library folder to open on start. |
|
||||
| `--settings-file <path>` | `-s` | Path to a TagStudio .toml global settings file to use. |
|
||||
| `--version` | `-v` | Displays TagStudio version information. |
|
||||
|
||||
322
docs/utilities/ignore.md
Normal file
322
docs/utilities/ignore.md
Normal file
@@ -0,0 +1,322 @@
|
||||
---
|
||||
title: Ignore Files
|
||||
icon: material/file-document-remove
|
||||
---
|
||||
|
||||
# :material-file-document-remove: Ignore Files & Directories
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! warning "Legacy File Extension Ignoring"
|
||||
TagStudio versions prior to v9.5.4 use a different, more limited method to exclude or include file extensions from your library and subsequent searches. Opening a pre-exiting library in v9.5.4 or later will non-destructively convert this to the newer, more extensive `.ts_ignore` format.
|
||||
|
||||
If you're still running an older version of TagStudio in the meantime, you can access the legacy system by going to "Edit -> Manage File Extensions" in the menubar.
|
||||
|
||||
TagStudio offers the ability to ignore specific files and directories via a `.ts_ignore` file located inside your [library's](../library/index.md) `.TagStudio` folder. This file is designed to use very similar [glob](<https://en.wikipedia.org/wiki/Glob_(programming)>)-style pattern matching as the [`.gitignore`](https://git-scm.com/docs/gitignore) file used by Git™[^1]. It can be edited within TagStudio or opened to edit with an external program by going to the "Edit -> Ignore Files" option in the menubar.
|
||||
|
||||
This file is only referenced when scanning directories for new files to add to your library, and does not apply to files that have already been added to your library.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip
|
||||
If you just want some specific examples of how to achieve common tasks with the ignore patterns (e.g. ignoring a single file type, ignoring a specific folder) then jump to the "[Use Cases](#use-cases)" section!
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
=== "Example .ts_ignore file"
|
||||
```toml title="My Library/.TagStudio/.ts_ignore"
|
||||
# TagStudio .ts_ignore file.
|
||||
|
||||
# Code
|
||||
__pycache__
|
||||
.pytest_cache
|
||||
.venv
|
||||
.vs
|
||||
|
||||
# Projects
|
||||
Minecraft/**/Metadata
|
||||
Minecraft/Website
|
||||
!Minecraft/Website/*.png
|
||||
!Minecraft/Website/*.css
|
||||
|
||||
# Documents
|
||||
*.doc
|
||||
*.docx
|
||||
*.ppt
|
||||
*.pptx
|
||||
*.xls
|
||||
*.xlsx
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
## Pattern Format
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! note ""
|
||||
_This section sourced and adapted from Git's[^1] `.gitignore` [documentation](https://git-scm.com/docs/gitignore)._
|
||||
|
||||
### Internal Processes
|
||||
|
||||
When scanning your library directories, the `.ts_ignore` file is read by either the [`wcmatch`](https://facelessuser.github.io/wcmatch/glob/) library or [`ripgrep`](https://github.com/BurntSushi/ripgrep) in glob mode depending if you have the later installed on your system and it's detected by TagStudio. Ripgrep is the preferred method for scanning directories due to its improved performance and identical pattern matching to `.gitignore`. This mixture of tools may lead to slight inconsistencies if not using `ripgrep`.
|
||||
|
||||
---
|
||||
|
||||
### Comments ( `#` )
|
||||
|
||||
A `#` symbol at the start of a line indicates that this line is a comment, and match no items. Blank lines are used to enhance readability and also match no items.
|
||||
|
||||
- Can be escaped by putting a backslash ("`\`") in front of the `#` symbol.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
=== "Example comment"
|
||||
```toml
|
||||
# This is a comment! I can say whatever I want on this line.
|
||||
file_that_is_being_matched.txt
|
||||
|
||||
# file_that_is_NOT_being_matched.png
|
||||
file_that_is_being_matched.png
|
||||
```
|
||||
=== "Organizing with comments"
|
||||
```toml
|
||||
# TagStudio .ts_ignore file.
|
||||
|
||||
# Minecraft Stuff
|
||||
Minecraft/**/Metadata
|
||||
Minecraft/Website
|
||||
!Minecraft/Website/*.png
|
||||
!Minecraft/Website/*.css
|
||||
|
||||
# Microsoft Office
|
||||
*.doc
|
||||
*.docx
|
||||
*.ppt
|
||||
*.pptx
|
||||
*.xls
|
||||
*.xlsx
|
||||
```
|
||||
=== "Escape a # symbol"
|
||||
```toml
|
||||
# To ensure a file named '#hashtag.jpg' is ignored:
|
||||
\#hashtag.jpg
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
---
|
||||
|
||||
### Directories ( `/` )
|
||||
|
||||
The forward slash "`/`" is used as the directory separator. Separators may occur at the beginning, middle or end of the `.ts_ignore` search pattern.
|
||||
|
||||
- If there is a separator at the beginning or middle (or both) of the pattern, then the pattern is relative to the directory level of the particular `.TagStudio` library folder itself. Otherwise the pattern may also match at any level below the `.TagStudio` folder level.
|
||||
|
||||
- If there is a separator at the end of the pattern then the pattern will only match directories, otherwise the pattern can match both files and directories.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
=== "Example folder pattern"
|
||||
```toml
|
||||
# Matches "frotz" and "a/frotz" if they are directories.
|
||||
frotz/
|
||||
```
|
||||
=== "Example nested folder pattern"
|
||||
```toml
|
||||
# Matches "doc/frotz" but not "a/doc/frotz".
|
||||
doc/frotz/
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
---
|
||||
|
||||
### Negation ( `!` )
|
||||
|
||||
A `!` prefix before a pattern negates the pattern, allowing any files matched matched by previous patterns to be un-matched.
|
||||
|
||||
- Any matching file excluded by a previous pattern will become included again.
|
||||
- **It is not possible to re-include a file if a parent directory of that file is excluded.**
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
=== "Example negation"
|
||||
```toml
|
||||
# All .jpg files will be ignored, except any located in the 'Photos' folder.
|
||||
*.jpg
|
||||
Photos/!*.jpg
|
||||
```
|
||||
=== "Escape a ! Symbol"
|
||||
```toml
|
||||
# To ensure a file named '!wowee.jpg' is ignored:
|
||||
\!wowee.jpg
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
---
|
||||
|
||||
### Wildcards
|
||||
|
||||
#### Single Asterisks ( `*` )
|
||||
|
||||
An asterisk "`*`" matches anything except a slash.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
=== "File examples"
|
||||
```toml
|
||||
# Matches all .png files in the "Images" folder.
|
||||
Images/*.png
|
||||
|
||||
# Matches all .png files in all folders
|
||||
*.png
|
||||
```
|
||||
=== "Folder examples"
|
||||
```toml
|
||||
# Matches any files or folders directly in "Images/" but not deeper levels.
|
||||
# Matches file "Images/mario.jpg"
|
||||
# Matches folder "Images/Mario"
|
||||
# Does not match file "Images/Mario/cat.jpg"
|
||||
Images/*
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
#### Question Marks ( `?` )
|
||||
|
||||
The character "`?`" matches any one character except "`/`".
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
=== "File examples"
|
||||
```toml
|
||||
# Matches any .png file starting with "IMG_" and ending in any four characters.
|
||||
# Matches "IMG_0001.png"
|
||||
# Matches "Photos/IMG_1234.png"
|
||||
# Does not match "IMG_1.png"
|
||||
IMG_????.png
|
||||
|
||||
# Same as above, except matches any file extension instead of only .png
|
||||
IMG_????.*
|
||||
```
|
||||
=== "Folder examples"
|
||||
```toml
|
||||
# Matches all files in any direct subfolder of "Photos" beginning in "20".
|
||||
# Matches "Photos/2000"
|
||||
# Matches "Photos/2024"
|
||||
# Matches "Photos/2099"
|
||||
# Does not match "Photos/1995"
|
||||
Photos/20??/
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
#### Double Asterisks ( `**` )
|
||||
|
||||
Two consecutive asterisks ("`**`") in patterns matched against full pathname may have special meaning:
|
||||
|
||||
- A leading "`**`" followed by a slash means matches in all directories.
|
||||
- A trailing "`/**`" matches everything inside.
|
||||
- A slash followed by two consecutive asterisks then a slash ("`/**/`") matches zero or more directories.
|
||||
- Other consecutive asterisks are considered regular asterisks and will match according to the previous rules.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
=== "Leading **"
|
||||
```toml
|
||||
# Both match file or directory "foo" anywhere
|
||||
**/foo
|
||||
foo
|
||||
|
||||
# Matches file or directory "bar" anywhere that is directly under directory "foo"
|
||||
**/foo/bar
|
||||
```
|
||||
=== "Trailing /**"
|
||||
```toml
|
||||
# Matches all files inside directory "abc" with infinite depth.
|
||||
abc/**
|
||||
```
|
||||
=== "Middle /**/"
|
||||
```toml
|
||||
# Matches "a/b", "a/x/b", "a/x/y/b" and so on.
|
||||
a/**/b
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
#### Square Brackets ( `[a-Z]` )
|
||||
|
||||
Character sets and ranges are specific and powerful forms of wildcards that use characters inside of brackets (`[]`) to leverage very specific matching. The range notation, e.g. `[a-zA-Z]`, can be used to match one of the characters in a range.
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip
|
||||
For more in-depth examples and explanations on how to use ranges, please reference the [`glob`](https://man7.org/linux/man-pages/man7/glob.7.html) man page.
|
||||
|
||||
<!-- prettier-ignore-start -->
|
||||
=== "Range examples"
|
||||
```toml
|
||||
# Matches all files that start with "IMG_" and end in a single numeric character.
|
||||
# Matches "IMG_0.jpg", "IMG_7.png"
|
||||
# Does not match "IMG_10.jpg", "IMG_A.jpg"
|
||||
IMG_[0-9]
|
||||
|
||||
# Matches all files that start with "IMG_" and end in a single alphabetic character
|
||||
IMG_[a-z]
|
||||
```
|
||||
=== "Set examples"
|
||||
```toml
|
||||
# Matches all files that start with "IMG_" and in any character in the set.
|
||||
# Matches "draft_a.docx", "draft_b.docx", "draft_c.docx"
|
||||
# Does not match "draft_d.docx"
|
||||
draft_[abc]
|
||||
|
||||
# Matches all files that start with "IMG_" and end in a single alphabetic character
|
||||
IMG_[a-z]
|
||||
```
|
||||
<!-- prettier-ignore-end -->
|
||||
|
||||
---
|
||||
|
||||
## Use Cases
|
||||
|
||||
### Ignoring Files by Extension
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
=== "Ignore all .jpg files"
|
||||
```toml
|
||||
*.jpg
|
||||
```
|
||||
=== "Ignore all files EXCEPT .jpg files"
|
||||
```toml
|
||||
*
|
||||
!*.jpg
|
||||
```
|
||||
=== "Ignore all .jpg files in specific folders"
|
||||
```toml
|
||||
./Photos/Worst Vacation/*.jpg
|
||||
Music/Artwork Art/*.jpg
|
||||
```
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip "Ensuring Complete Extension Matches"
|
||||
For some filetypes, it may be nessisary to specify different casing and alternative spellings in order to match with all possible variations of an extension in your library.
|
||||
|
||||
```toml title="Ignore (Most) Possible JPEG File Extensions"
|
||||
# The JPEG Cinematic Universe
|
||||
*.jpg
|
||||
*.jpeg
|
||||
*.jfif
|
||||
*.jpeg_large
|
||||
*.JPG
|
||||
*.JPEG
|
||||
*.JFIF
|
||||
*.JPEG_LARGE
|
||||
```
|
||||
|
||||
### Ignoring a Folder
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
=== "Ignore all "Cache" folders"
|
||||
```toml
|
||||
# Matches any folder called "Cache" no matter where it is in your library.
|
||||
cache/
|
||||
```
|
||||
=== "Ignore a "Downloads" folder"
|
||||
```toml
|
||||
# "Downloads" must be a folder on the same level as your ".TagStudio" folder.
|
||||
# Does not match with folders name "Downloads" elsewhere in your library
|
||||
# Does not match with a file called "Downloads"
|
||||
/Downloads/
|
||||
```
|
||||
=== "Ignore .jpg files in specific folders"
|
||||
```toml
|
||||
Photos/Worst Vacation/*.jpg
|
||||
/Music/Artwork Art/*.jpg
|
||||
```
|
||||
|
||||
[^1]: The term "Git" is a licensed trademark of "The Git Project", a member of the Software Freedom Conservancy. Git is released under the [GNU General Public License version 2.0](https://opensource.org/license/GPL-2.0), an open source license. TagStudio is not associated with the Git Project, only including systems based on some therein.
|
||||
@@ -1,4 +1,8 @@
|
||||
# Tools & Macros
|
||||
---
|
||||
icon: material/script-text
|
||||
---
|
||||
|
||||
# :material-script-text: Tools & Macros
|
||||
|
||||
Tools and macros are features that serve to create a more fluid [library](../library/index.md)-managing process, or provide some extra functionality. Please note that some are still in active development and will be fleshed out in future updates.
|
||||
|
||||
|
||||
12
flake.lock
generated
12
flake.lock
generated
@@ -7,11 +7,11 @@
|
||||
]
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1743550720,
|
||||
"narHash": "sha256-hIshGgKZCgWh6AYJpJmRgFdR3WUbkY04o82X05xqQiY=",
|
||||
"lastModified": 1754487366,
|
||||
"narHash": "sha256-pHYj8gUBapuUzKV/kN/tR3Zvqc7o6gdFB9XKXIp1SQ8=",
|
||||
"owner": "hercules-ci",
|
||||
"repo": "flake-parts",
|
||||
"rev": "c621e8422220273271f52058f618c94e405bb0f5",
|
||||
"rev": "af66ad14b28a127c5c0f3bbb298218fc63528a18",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -22,11 +22,11 @@
|
||||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1744932701,
|
||||
"narHash": "sha256-fusHbZCyv126cyArUwwKrLdCkgVAIaa/fQJYFlCEqiU=",
|
||||
"lastModified": 1755615617,
|
||||
"narHash": "sha256-HMwfAJBdrr8wXAkbGhtcby1zGFvs+StOp19xNsbqdOg=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "b024ced1aac25639f8ca8fdfc2f8c4fbd66c48ef",
|
||||
"rev": "20075955deac2583bb12f07151c2df830ef346b4",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
|
||||
34
flake.nix
34
flake.nix
@@ -27,48 +27,30 @@
|
||||
|
||||
perSystem =
|
||||
{ pkgs, ... }:
|
||||
let
|
||||
python3 = pkgs.python312;
|
||||
in
|
||||
{
|
||||
packages =
|
||||
let
|
||||
python3Packages = pkgs.python312Packages;
|
||||
python3Packages = python3.pkgs;
|
||||
|
||||
pillow-jxl-plugin = python3Packages.callPackage ./nix/package/pillow-jxl-plugin.nix {
|
||||
inherit (pkgs) cmake;
|
||||
inherit pyexiv2;
|
||||
};
|
||||
pyexiv2 = python3Packages.callPackage ./nix/package/pyexiv2.nix { inherit (pkgs) exiv2; };
|
||||
vtf2img = python3Packages.callPackage ./nix/package/vtf2img.nix { };
|
||||
in
|
||||
rec {
|
||||
default = tagstudio;
|
||||
tagstudio = pkgs.callPackage ./nix/package {
|
||||
# HACK: Remove when PySide6 is bumped to 6.9.x.
|
||||
# Sourced from https://github.com/NixOS/nixpkgs/commit/2f9c1ad5e19a6154d541f878774a9aacc27381b7.
|
||||
pyside6 =
|
||||
if lib.versionAtLeast python3Packages.pyside6.version "6.9.0" then
|
||||
(python3Packages.pyside6.override {
|
||||
shiboken6 = python3Packages.shiboken6.overrideAttrs {
|
||||
version = "6.8.0.2";
|
||||
inherit python3Packages;
|
||||
|
||||
src = pkgs.fetchurl {
|
||||
url = "mirror://qt/official_releases/QtForPython/shiboken6/PySide6-6.8.0.2-src/pyside-setup-everywhere-src-6.8.0.tar.xz";
|
||||
hash = "sha256-Ghohmo8yfjQNJYJ1+tOp8mG48EvFcEF0fnPdatJStOE=";
|
||||
};
|
||||
|
||||
sourceRoot = "pyside-setup-everywhere-src-6.8.0/sources/shiboken6";
|
||||
|
||||
patches = [ ./nix/package/shiboken6-fix-include-qt-headers.patch ];
|
||||
};
|
||||
}).overrideAttrs
|
||||
{ sourceRoot = "pyside-setup-everywhere-src-6.8.0/sources/pyside6"; }
|
||||
else
|
||||
python3Packages.pyside6;
|
||||
|
||||
inherit pillow-jxl-plugin vtf2img;
|
||||
inherit pillow-jxl-plugin;
|
||||
};
|
||||
tagstudio-jxl = tagstudio.override { withJXLSupport = true; };
|
||||
|
||||
inherit pillow-jxl-plugin pyexiv2 vtf2img;
|
||||
inherit pillow-jxl-plugin pyexiv2;
|
||||
};
|
||||
|
||||
devShells = rec {
|
||||
@@ -79,6 +61,8 @@
|
||||
lib
|
||||
pkgs
|
||||
self
|
||||
|
||||
python3
|
||||
;
|
||||
};
|
||||
};
|
||||
|
||||
21
mkdocs.yml
21
mkdocs.yml
@@ -36,15 +36,14 @@ nav:
|
||||
- help/ffmpeg.md
|
||||
- Library:
|
||||
- library/index.md
|
||||
- library/entry.md
|
||||
- library/entry_groups.md
|
||||
- library/field.md
|
||||
- library/library_search.md
|
||||
- library/entry.md
|
||||
- library/field.md
|
||||
- library/tag.md
|
||||
- library/tag_categories.md
|
||||
- library/tag_color.md
|
||||
- library/tag_overrides.md
|
||||
- Utilities:
|
||||
- utilities/ignore.md
|
||||
- utilities/macro.md
|
||||
- Updates:
|
||||
- updates/changelog.md
|
||||
@@ -63,16 +62,16 @@ theme:
|
||||
# Palette toggle for light mode
|
||||
- media: "(prefers-color-scheme: light)"
|
||||
scheme: default
|
||||
primary: deep purple
|
||||
accent: deep purple
|
||||
primary: purple
|
||||
accent: purple
|
||||
toggle:
|
||||
icon: material/lightbulb
|
||||
name: Switch to Dark Mode
|
||||
# Palette toggle for dark mode
|
||||
- media: "(prefers-color-scheme: dark)"
|
||||
scheme: slate
|
||||
primary: deep purple
|
||||
accent: deep purple
|
||||
primary: purple
|
||||
accent: purple
|
||||
toggle:
|
||||
icon: material/lightbulb-night-outline
|
||||
name: Switch to System Preference
|
||||
@@ -91,6 +90,7 @@ theme:
|
||||
- content.code.annotate
|
||||
- content.code.copy
|
||||
- content.action.edit
|
||||
- content.tooltips
|
||||
icon:
|
||||
repo: fontawesome/brands/github
|
||||
tag:
|
||||
@@ -105,6 +105,7 @@ markdown_extensions:
|
||||
- def_list
|
||||
- footnotes
|
||||
- md_in_html
|
||||
- tables
|
||||
- toc:
|
||||
permalink: true
|
||||
|
||||
@@ -115,11 +116,15 @@ markdown_extensions:
|
||||
smart_enable: all
|
||||
- pymdownx.caret
|
||||
- pymdownx.details
|
||||
- pymdownx.emoji:
|
||||
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
||||
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
||||
- pymdownx.highlight
|
||||
- pymdownx.inlinehilite
|
||||
- pymdownx.keys
|
||||
- pymdownx.mark
|
||||
- pymdownx.smartsymbols
|
||||
- pymdownx.snippets
|
||||
- pymdownx.superfences:
|
||||
custom_fences:
|
||||
- name: mermaid
|
||||
|
||||
@@ -4,12 +4,11 @@
|
||||
pipewire,
|
||||
python3Packages,
|
||||
qt6,
|
||||
ripgrep,
|
||||
stdenv,
|
||||
wrapGAppsHook,
|
||||
|
||||
pillow-jxl-plugin,
|
||||
pyside6,
|
||||
vtf2img,
|
||||
|
||||
withJXLSupport ? false,
|
||||
}:
|
||||
@@ -28,7 +27,7 @@ python3Packages.buildPythonApplication {
|
||||
python3Packages.pythonRelaxDepsHook
|
||||
qt6.wrapQtAppsHook
|
||||
|
||||
# INFO: Should be unnecessary once PR is pulled.
|
||||
# Should be unnecessary once PR is pulled.
|
||||
# PR: https://github.com/NixOS/nixpkgs/pull/271037
|
||||
# Issue: https://github.com/NixOS/nixpkgs/issues/149812
|
||||
wrapGAppsHook
|
||||
@@ -53,18 +52,32 @@ python3Packages.buildPythonApplication {
|
||||
cp $src/src/tagstudio/resources/icon.png $out/share/icons/hicolor/512x512/apps/tagstudio.png
|
||||
'';
|
||||
|
||||
makeWrapperArgs =
|
||||
[ "--prefix PATH : ${lib.makeBinPath [ ffmpeg-headless ]}" ]
|
||||
++ lib.optional stdenv.hostPlatform.isLinux "--prefix LD_LIBRARY_PATH : ${
|
||||
lib.makeLibraryPath [ pipewire ]
|
||||
}";
|
||||
dontWrapGApps = true;
|
||||
dontWrapQtApps = true;
|
||||
makeWrapperArgs = [
|
||||
"--prefix PATH : ${
|
||||
lib.makeBinPath [
|
||||
ffmpeg-headless
|
||||
ripgrep
|
||||
]
|
||||
}"
|
||||
]
|
||||
++ lib.optional stdenv.hostPlatform.isLinux "--prefix LD_LIBRARY_PATH : ${
|
||||
lib.makeLibraryPath [ pipewire ]
|
||||
}"
|
||||
++ [
|
||||
"\${gappsWrapperArgs[@]}"
|
||||
"\${qtWrapperArgs[@]}"
|
||||
];
|
||||
|
||||
pythonRemoveDeps = lib.optional (!withJXLSupport) [ "pillow_jxl" ];
|
||||
pythonRelaxDeps = [
|
||||
"numpy"
|
||||
"pillow"
|
||||
"pillow-avif-plugin"
|
||||
"pillow-heif"
|
||||
"pillow-jxl-plugin"
|
||||
"pyside6"
|
||||
"structlog"
|
||||
"typing-extensions"
|
||||
];
|
||||
@@ -81,6 +94,7 @@ python3Packages.buildPythonApplication {
|
||||
numpy
|
||||
opencv-python
|
||||
pillow
|
||||
pillow-avif-plugin
|
||||
pillow-heif
|
||||
pydantic
|
||||
pydub
|
||||
@@ -88,41 +102,33 @@ python3Packages.buildPythonApplication {
|
||||
rawpy
|
||||
send2trash
|
||||
sqlalchemy
|
||||
srctools
|
||||
structlog
|
||||
toml
|
||||
ujson
|
||||
vtf2img
|
||||
wcmatch
|
||||
]
|
||||
++ lib.optional withJXLSupport pillow-jxl-plugin;
|
||||
|
||||
# These tests require modifications to a library, which does not work
|
||||
# in a read-only environment.
|
||||
disabledTests = [
|
||||
# INFO: These tests require modifications to a library, which does not work
|
||||
# in a read-only environment.
|
||||
"test_build_tag_panel_add_alias_callback"
|
||||
"test_build_tag_panel_add_aliases"
|
||||
"test_build_tag_panel_add_sub_tag_callback"
|
||||
"test_build_tag_panel_build_tag"
|
||||
"test_build_tag_panel_remove_alias_callback"
|
||||
"test_build_tag_panel_remove_subtag_callback"
|
||||
"test_build_tag_panel_set_aliases"
|
||||
"test_build_tag_panel_set_parent_tags"
|
||||
"test_build_tag_panel_set_tag"
|
||||
"test_badge_visual_state"
|
||||
"test_browsing_state_update"
|
||||
"test_flow_layout_happy_path"
|
||||
"test_get" # TODO: Look further into, might be possible to run.
|
||||
"test_json_migration"
|
||||
"test_library_migrations"
|
||||
|
||||
"test_add_same_tag_to_selection_single"
|
||||
"test_add_tag_to_selection_multiple"
|
||||
"test_add_tag_to_selection_single"
|
||||
"test_custom_tag_category"
|
||||
"test_file_path_display"
|
||||
"test_meta_tag_category"
|
||||
"test_update_selection_empty"
|
||||
"test_update_selection_empty"
|
||||
"test_update_selection_multiple"
|
||||
"test_update_selection_single"
|
||||
|
||||
# INFO: This test requires modification of a configuration file.
|
||||
"test_filepath_setting"
|
||||
"test_update_tags"
|
||||
];
|
||||
disabledTestPaths = [
|
||||
"tests/qt/test_build_tag_panel.py"
|
||||
"tests/qt/test_field_containers.py"
|
||||
"tests/qt/test_file_path_options.py"
|
||||
"tests/qt/test_preview_panel.py"
|
||||
"tests/qt/test_tag_panel.py"
|
||||
"tests/qt/test_tag_search_panel.py"
|
||||
"tests/test_library.py"
|
||||
];
|
||||
|
||||
meta = {
|
||||
|
||||
@@ -13,18 +13,18 @@
|
||||
|
||||
buildPythonPackage rec {
|
||||
pname = "pillow-jxl-plugin";
|
||||
version = "1.3.2";
|
||||
version = "1.3.4";
|
||||
pyproject = true;
|
||||
|
||||
src = fetchPypi {
|
||||
pname = builtins.replaceStrings [ "-" ] [ "_" ] pname;
|
||||
pname = "pillow_jxl_plugin";
|
||||
inherit version;
|
||||
hash = "sha256-efBoek8yUFR+ArhS55lm9F2XhkZ7/I3GsScQEe8U/2I=";
|
||||
hash = "sha256-jqWJ/FWep8XfzLQq9NgUj121CPX01FGDKLq1ox/LJo4=";
|
||||
};
|
||||
|
||||
cargoDeps = rustPlatform.fetchCargoVendor {
|
||||
inherit src;
|
||||
hash = "sha256-vZHrwGfgo3fIIOY7p0vy4XIKiHoddPDdJggkBen+w/A=";
|
||||
hash = "sha256-7j+sCn+P6q6tsm2MJ/cM7hF2KEjILJNA6SDb35tecPg=";
|
||||
};
|
||||
|
||||
nativeBuildInputs = [
|
||||
@@ -39,9 +39,9 @@ buildPythonPackage rec {
|
||||
pytestCheckHook
|
||||
];
|
||||
|
||||
# INFO: Working directory takes precedence in the Python path. Remove
|
||||
# Working directory takes precedence in the Python path. Remove
|
||||
# `pillow_jxl` to prevent it from being loaded during pytest, rather than the
|
||||
# built module, as it includes a `pillow_jxl.pillow_jxl` .so that is imported.
|
||||
# built module, as it includes a `pillow_jxl.pillow_jxl.so` that is imported.
|
||||
# See: https://github.com/NixOS/nixpkgs/issues/255262
|
||||
# See: https://github.com/NixOS/nixpkgs/pull/255471
|
||||
preCheck = ''
|
||||
@@ -58,8 +58,9 @@ buildPythonPackage rec {
|
||||
];
|
||||
|
||||
meta = {
|
||||
description = "Pillow plugin for JPEG-XL, using Rust for bindings.";
|
||||
description = "Pillow plugin for JPEG-XL, using Rust for bindings";
|
||||
homepage = "https://github.com/Isotr0py/pillow-jpegxl-plugin";
|
||||
changelog = "https://github.com/Isotr0py/pillow-jpegxl-plugin/releases/tag/v${version}";
|
||||
license = lib.licenses.gpl3;
|
||||
maintainers = with lib.maintainers; [ xarvex ];
|
||||
platforms = lib.platforms.unix;
|
||||
|
||||
@@ -4,16 +4,18 @@
|
||||
exiv2,
|
||||
fetchFromGitHub,
|
||||
lib,
|
||||
setuptools,
|
||||
}:
|
||||
|
||||
buildPythonPackage rec {
|
||||
pname = "pyexiv2";
|
||||
version = "2.15.3";
|
||||
pyproject = true;
|
||||
|
||||
src = fetchFromGitHub {
|
||||
owner = "LeoHsiao1";
|
||||
repo = pname;
|
||||
rev = "v${version}";
|
||||
repo = "pyexiv2";
|
||||
tag = "v${version}";
|
||||
hash = "sha256-83bFMaoXncvhRJNcCgkkC7B29wR5pjuLO/EdkQdqxxo=";
|
||||
};
|
||||
|
||||
@@ -22,9 +24,12 @@ buildPythonPackage rec {
|
||||
|
||||
pythonImportsCheck = [ "pyexiv2" ];
|
||||
|
||||
build-system = [ setuptools ];
|
||||
|
||||
meta = {
|
||||
description = "Read and write image metadata, including EXIF, IPTC, XMP, ICC Profile.";
|
||||
description = "Read and write image metadata, including EXIF, IPTC, XMP, ICC Profile";
|
||||
homepage = "https://github.com/LeoHsiao1/pyexiv2";
|
||||
changelog = "https://github.com/LeoHsiao1/pyexiv2/releases/tag/v${version}";
|
||||
license = lib.licenses.gpl3;
|
||||
maintainers = with lib.maintainers; [ xarvex ];
|
||||
platforms = with lib.platforms; darwin ++ linux ++ windows;
|
||||
|
||||
@@ -1,81 +0,0 @@
|
||||
Sourced from https://github.com/NixOS/nixpkgs/blob/5ba0f1ea90b0afa2abc23a43edb63af51d932e6d/pkgs/development/python-modules/shiboken6/fix-include-qt-headers.patch.
|
||||
--- a/ApiExtractor/clangparser/compilersupport.cpp
|
||||
+++ b/ApiExtractor/clangparser/compilersupport.cpp
|
||||
@@ -16,6 +16,7 @@
|
||||
#include <QtCore/QStandardPaths>
|
||||
#include <QtCore/QStringList>
|
||||
#include <QtCore/QVersionNumber>
|
||||
+#include <QtCore/QRegularExpression>
|
||||
|
||||
#include <clang-c/Index.h>
|
||||
|
||||
@@ -341,6 +342,13 @@ QByteArrayList emulatedCompilerOptions()
|
||||
{
|
||||
QByteArrayList result;
|
||||
HeaderPaths headerPaths;
|
||||
+
|
||||
+ bool isNixDebug = qgetenv("NIX_DEBUG").toInt() > 0;
|
||||
+ // examples:
|
||||
+ // /nix/store/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-qtsensors-6.4.2-dev/include
|
||||
+ // /nix/store/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx-qtbase-6.4.2-dev/include
|
||||
+ QRegularExpression qtHeaderRegex(uR"(/[0-9a-z]{32}-qt[a-z0-9]+-)"_s);
|
||||
+
|
||||
switch (compiler()) {
|
||||
case Compiler::Msvc:
|
||||
result.append(QByteArrayLiteral("-fms-compatibility-version=19.26.28806"));
|
||||
@@ -352,9 +360,30 @@ QByteArrayList emulatedCompilerOptions()
|
||||
appendClangBuiltinIncludes(&headerPaths);
|
||||
break;
|
||||
case Compiler::Clang:
|
||||
- headerPaths.append(gppInternalIncludePaths(compilerFromCMake(u"clang++"_s)));
|
||||
+ // fix: error: cannot jump from switch statement to this case label: case Compiler::Gpp
|
||||
+ // note: jump bypasses variable initialization: const HeaderPaths clangPaths =
|
||||
+ {
|
||||
+ //headerPaths.append(gppInternalIncludePaths(compilerFromCMake(u"clang++"_s)));
|
||||
+ // fix: qt.shiboken: x is specified in typesystem, but not defined. This could potentially lead to compilation errors.
|
||||
+ // PySide requires that Qt headers are not -isystem
|
||||
+ // https://bugreports.qt.io/browse/PYSIDE-787
|
||||
+ const HeaderPaths clangPaths = gppInternalIncludePaths(compilerFromCMake(u"clang++"_qs));
|
||||
+ for (const HeaderPath &h : clangPaths) {
|
||||
+ auto match = qtHeaderRegex.match(QString::fromUtf8(h.path));
|
||||
+ if (!match.hasMatch()) {
|
||||
+ if (isNixDebug)
|
||||
+ qDebug() << "shiboken compilersupport.cpp: found non-qt header: " << h.path;
|
||||
+ // add using -isystem
|
||||
+ headerPaths.append(h);
|
||||
+ } else {
|
||||
+ if (isNixDebug)
|
||||
+ qDebug() << "shiboken compilersupport.cpp: found qt header: " << h.path;
|
||||
+ headerPaths.append({h.path, HeaderType::Standard});
|
||||
+ }
|
||||
+ }
|
||||
result.append(noStandardIncludeOption());
|
||||
break;
|
||||
+ }
|
||||
case Compiler::Gpp:
|
||||
if (needsClangBuiltinIncludes())
|
||||
appendClangBuiltinIncludes(&headerPaths);
|
||||
@@ -363,8 +392,20 @@ QByteArrayList emulatedCompilerOptions()
|
||||
// <type_traits> etc (g++ 11.3).
|
||||
const HeaderPaths gppPaths = gppInternalIncludePaths(compilerFromCMake(u"g++"_qs));
|
||||
for (const HeaderPath &h : gppPaths) {
|
||||
- if (h.path.contains("c++") || h.path.contains("sysroot"))
|
||||
+ // fix: qt.shiboken: x is specified in typesystem, but not defined. This could potentially lead to compilation errors.
|
||||
+ // PySide requires that Qt headers are not -isystem
|
||||
+ // https://bugreports.qt.io/browse/PYSIDE-787
|
||||
+ auto match = qtHeaderRegex.match(QString::fromUtf8(h.path));
|
||||
+ if (!match.hasMatch()) {
|
||||
+ if (isNixDebug)
|
||||
+ qDebug() << "shiboken compilersupport.cpp: found non-qt header: " << h.path;
|
||||
+ // add using -isystem
|
||||
headerPaths.append(h);
|
||||
+ } else {
|
||||
+ if (isNixDebug)
|
||||
+ qDebug() << "shiboken compilersupport.cpp: found qt header: " << h.path;
|
||||
+ headerPaths.append({h.path, HeaderType::Standard});
|
||||
+ }
|
||||
}
|
||||
break;
|
||||
}
|
||||
--
|
||||
2.39.0
|
||||
@@ -1,29 +0,0 @@
|
||||
{
|
||||
buildPythonPackage,
|
||||
fetchPypi,
|
||||
lib,
|
||||
pillow,
|
||||
}:
|
||||
|
||||
buildPythonPackage rec {
|
||||
pname = "vtf2img";
|
||||
version = "0.1.0";
|
||||
|
||||
src = fetchPypi {
|
||||
inherit pname version;
|
||||
hash = "sha256-YmWs8673d72wH4nTOXP4AFGs2grIETln4s1MD5PfE0A=";
|
||||
};
|
||||
|
||||
pythonImportsCheck = [ "vtf2img" ];
|
||||
|
||||
dependencies = [ pillow ];
|
||||
|
||||
meta = {
|
||||
description = "A Python library to convert Valve Texture Format (VTF) files to images.";
|
||||
homepage = "https://github.com/julienc91/vtf2img";
|
||||
license = lib.licenses.mit;
|
||||
maintainers = with lib.maintainers; [ xarvex ];
|
||||
mainProgram = "vtf2img";
|
||||
platforms = lib.platforms.unix;
|
||||
};
|
||||
}
|
||||
@@ -1,59 +1,72 @@
|
||||
{ lib, pkgs, ... }:
|
||||
{
|
||||
lib,
|
||||
pkgs,
|
||||
|
||||
python3,
|
||||
...
|
||||
}:
|
||||
|
||||
let
|
||||
# INFO: PySide6 from PIP is compiled for 6.8.0 of Qt, must pin to match version.
|
||||
# Long term this can be solved with an alternative like uv2nix for the devshell.
|
||||
qt6Pkgs = import (builtins.fetchTarball {
|
||||
name = "nixos-unstable-qt6-pinned";
|
||||
url = "https://github.com/NixOS/nixpkgs/archive/93ff48c9be84a76319dac293733df09bbbe3f25c.tar.gz";
|
||||
sha256 = "038m7932v4z0zn2lk7k7mbqbank30q84r1viyhchw9pcm3aq3q23";
|
||||
}) { inherit (pkgs) system; };
|
||||
|
||||
pythonLibraryPath = lib.makeLibraryPath (
|
||||
(with pkgs; [
|
||||
fontconfig.lib
|
||||
freetype
|
||||
glib
|
||||
stdenv.cc.cc.lib
|
||||
zstd
|
||||
])
|
||||
++ (with qt6Pkgs.qt6; [ qtbase ])
|
||||
++ lib.optionals (!pkgs.stdenv.isDarwin) (
|
||||
(with pkgs; [
|
||||
dbus.lib
|
||||
pythonLibraryPath =
|
||||
with pkgs;
|
||||
lib.makeLibraryPath (
|
||||
[
|
||||
fontconfig
|
||||
freetype
|
||||
glib
|
||||
qt6.qtbase
|
||||
stdenv.cc.cc
|
||||
zstd
|
||||
]
|
||||
++ lib.optionals (!stdenv.isDarwin) [
|
||||
dbus
|
||||
libGL
|
||||
libdrm
|
||||
libpulseaudio
|
||||
libva
|
||||
libxkbcommon
|
||||
pipewire
|
||||
qt6.qtwayland
|
||||
xorg.libX11
|
||||
xorg.libXrandr
|
||||
])
|
||||
++ (with qt6Pkgs.qt6; [ qtwayland ])
|
||||
)
|
||||
);
|
||||
]
|
||||
);
|
||||
|
||||
libraryPath = "${lib.optionalString pkgs.stdenv.isDarwin "DY"}LD_LIBRARY_PATH";
|
||||
|
||||
python = pkgs.python312;
|
||||
pythonWrapped = pkgs.symlinkJoin {
|
||||
inherit (python)
|
||||
python3Wrapped = pkgs.symlinkJoin {
|
||||
inherit (python3)
|
||||
name
|
||||
pname
|
||||
version
|
||||
meta
|
||||
;
|
||||
|
||||
paths = [ python ];
|
||||
paths = [ python3 ];
|
||||
|
||||
nativeBuildInputs = (with pkgs; [ makeWrapper ]) ++ (with qt6Pkgs.qt6; [ wrapQtAppsHook ]);
|
||||
buildInputs = with qt6Pkgs.qt6; [ qtbase ];
|
||||
nativeBuildInputs = with pkgs; [
|
||||
makeWrapper
|
||||
qt6.wrapQtAppsHook
|
||||
|
||||
# Should be unnecessary once PR is pulled.
|
||||
# PR: https://github.com/NixOS/nixpkgs/pull/271037
|
||||
# Issue: https://github.com/NixOS/nixpkgs/issues/149812
|
||||
wrapGAppsHook
|
||||
];
|
||||
buildInputs = with pkgs.qt6; [
|
||||
qtbase
|
||||
qtmultimedia
|
||||
];
|
||||
|
||||
postBuild = ''
|
||||
wrapProgram $out/bin/python3.12 \
|
||||
wrapProgram $out/bin/${python3.meta.mainProgram} \
|
||||
--prefix ${libraryPath} : ${pythonLibraryPath} \
|
||||
"''${gappsWrapperArgs[@]}" \
|
||||
"''${qtWrapperArgs[@]}"
|
||||
'';
|
||||
|
||||
dontWrapGApps = true;
|
||||
dontWrapQtApps = true;
|
||||
};
|
||||
in
|
||||
pkgs.mkShellNoCC {
|
||||
@@ -63,7 +76,13 @@ pkgs.mkShellNoCC {
|
||||
|
||||
ruff
|
||||
];
|
||||
buildInputs = [ pythonWrapped ] ++ (with pkgs; [ ffmpeg-headless ]);
|
||||
buildInputs = [
|
||||
python3Wrapped
|
||||
]
|
||||
++ (with pkgs; [
|
||||
ffmpeg-headless
|
||||
ripgrep
|
||||
]);
|
||||
|
||||
env = {
|
||||
QT_QPA_PLATFORM = "wayland;xcb";
|
||||
@@ -74,11 +93,16 @@ pkgs.mkShellNoCC {
|
||||
|
||||
shellHook =
|
||||
let
|
||||
python = lib.getExe pythonWrapped;
|
||||
python = lib.getExe python3Wrapped;
|
||||
|
||||
# PySide/Qt are very particular about matching versions. Override with nixpkgs package.
|
||||
pythonPath = lib.makeSearchPathOutput "lib" python3.sitePackages (
|
||||
with python3.pkgs; [ pyside6 ] ++ pyside6.propagatedBuildInputs or [ ]
|
||||
);
|
||||
in
|
||||
# bash
|
||||
''
|
||||
venv="''${UV_PROJECT_ENVIRONMENT:-.venv}"
|
||||
venv=''${UV_PROJECT_ENVIRONMENT:-.venv}
|
||||
|
||||
if [ ! -f "''${venv}"/bin/activate ] || [ "$(readlink -f "''${venv}"/bin/python)" != "$(readlink -f ${python})" ]; then
|
||||
printf '%s\n' 'Regenerating virtual environment, Python interpreter changed...' >&2
|
||||
@@ -87,6 +111,7 @@ pkgs.mkShellNoCC {
|
||||
fi
|
||||
|
||||
source "''${venv}"/bin/activate
|
||||
PYTHONPATH=${pythonPath}''${PYTHONPATH:+:}''${PYTHONPATH:-}
|
||||
|
||||
if [ ! -f "''${venv}"/pyproject.toml ] || ! diff --brief pyproject.toml "''${venv}"/pyproject.toml >/dev/null; then
|
||||
printf '%s\n' 'Installing dependencies, pyproject.toml changed...' >&2
|
||||
|
||||
@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
|
||||
[project]
|
||||
name = "TagStudio"
|
||||
description = "A User-Focused Photo & File Management System."
|
||||
version = "9.5.3"
|
||||
version = "9.5.5"
|
||||
license = "GPL-3.0-only"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.12,<3.13"
|
||||
@@ -16,12 +16,14 @@ dependencies = [
|
||||
"mutagen~=1.47",
|
||||
"numpy~=2.2",
|
||||
"opencv_python~=4.11",
|
||||
"Pillow>=10.2,<=12.0",
|
||||
"Pillow>=10.2,<=11",
|
||||
"pillow-avif-plugin~=1.5",
|
||||
"pillow-heif~=0.22",
|
||||
"pillow-jxl-plugin~=1.3",
|
||||
"pydantic~=2.10",
|
||||
"pydub~=0.25",
|
||||
"PySide6==6.8.0.*",
|
||||
"rarfile==4.2",
|
||||
"rawpy~=0.24",
|
||||
"Send2Trash~=1.8",
|
||||
"SQLAlchemy~=2.0",
|
||||
@@ -30,6 +32,7 @@ dependencies = [
|
||||
"toml~=0.10",
|
||||
"typing_extensions~=4.13",
|
||||
"ujson~=5.10",
|
||||
"wcmatch==10.*",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
@@ -83,13 +86,17 @@ ignore_errors = true
|
||||
qt_api = "pyside6"
|
||||
|
||||
[tool.pyright]
|
||||
ignore = [".venv/**"]
|
||||
ignore = [
|
||||
".venv/**",
|
||||
"src/tagstudio/core/library/json/",
|
||||
"src/tagstudio/qt/previews/vendored/pydub/",
|
||||
]
|
||||
include = ["src/tagstudio", "tests"]
|
||||
extraPaths = ["src/tagstudio", "tests"]
|
||||
reportAny = false
|
||||
reportIgnoreCommentWithoutRule = false
|
||||
reportImplicitStringConcatenation = false
|
||||
reportMissingTypeArgument = false
|
||||
reportMissingTypeStubs = false
|
||||
# reportOptionalMemberAccess = false
|
||||
reportUnannotatedClassAttribute = false
|
||||
reportUnknownArgumentType = false
|
||||
@@ -107,7 +114,7 @@ ignore = ["D100", "D101", "D102", "D103", "D104", "D105", "D106", "D107"]
|
||||
|
||||
[tool.ruff.lint.per-file-ignores]
|
||||
"tests/**" = ["D", "E402"]
|
||||
"src/tagstudio/qt/helpers/vendored/**" = ["B", "E", "N", "UP", "SIM115"]
|
||||
"src/tagstudio/qt/previews/vendored/**" = ["B", "E", "N", "UP", "SIM115"]
|
||||
|
||||
[tool.ruff.lint.pydocstyle]
|
||||
convention = "google"
|
||||
|
||||
@@ -2,13 +2,14 @@
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
VERSION: str = "9.5.3" # Major.Minor.Patch
|
||||
VERSION: str = "9.5.5" # Major.Minor.Patch
|
||||
VERSION_BRANCH: str = "" # Usually "" or "Pre-Release"
|
||||
|
||||
# The folder & file names where TagStudio keeps its data relative to a library.
|
||||
TS_FOLDER_NAME: str = ".TagStudio"
|
||||
BACKUP_FOLDER_NAME: str = "backups"
|
||||
COLLAGE_FOLDER_NAME: str = "collages"
|
||||
IGNORE_NAME: str = ".ts_ignore"
|
||||
THUMB_CACHE_NAME: str = "thumbs"
|
||||
|
||||
FONT_SAMPLE_TEXT: str = (
|
||||
|
||||
@@ -5,14 +5,16 @@ from PySide6.QtCore import QSettings
|
||||
|
||||
from tagstudio.core.constants import TS_FOLDER_NAME
|
||||
from tagstudio.core.enums import SettingItems
|
||||
from tagstudio.core.global_settings import GlobalSettings
|
||||
from tagstudio.core.library.alchemy.library import LibraryStatus
|
||||
from tagstudio.qt.global_settings import GlobalSettings
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
class DriverMixin:
|
||||
cached_values: QSettings
|
||||
# TODO: GlobalSettings has become closely tied to Qt.
|
||||
# Should there be a base Settings class?
|
||||
settings: GlobalSettings
|
||||
|
||||
def evaluate_path(self, open_path: str | None) -> LibraryStatus:
|
||||
|
||||
@@ -12,7 +12,6 @@ class SettingItems(str, enum.Enum):
|
||||
|
||||
LAST_LIBRARY = "last_library"
|
||||
LIBS_LIST = "libs_list"
|
||||
THUMB_CACHE_SIZE_LIMIT = "thumb_cache_size_limit"
|
||||
|
||||
|
||||
class ShowFilepathOption(int, enum.Enum):
|
||||
@@ -79,9 +78,9 @@ class DefaultEnum(enum.Enum):
|
||||
raise AttributeError("access the value via .default property instead")
|
||||
|
||||
|
||||
# TODO: Remove DefaultEnum and LibraryPrefs classes once remaining values are removed.
|
||||
class LibraryPrefs(DefaultEnum):
|
||||
"""Library preferences with default value accessible via .default property."""
|
||||
|
||||
IS_EXCLUDE_LIST = True
|
||||
EXTENSION_LIST = [".json", ".xmp", ".aae"]
|
||||
DB_VERSION = 9
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
# Copyright (C) 2024 Travis Abendshien (CyanVoxel).
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
class FieldTemplate:
|
||||
"""A TagStudio Library Field Template object."""
|
||||
|
||||
def __init__(self, id: int, name: str, type: str) -> None:
|
||||
self.id = id
|
||||
self.name = name
|
||||
self.type = type
|
||||
|
||||
def __str__(self) -> str:
|
||||
return f"\nID: {self.id}\nName: {self.name}\nType: {self.type}\n"
|
||||
|
||||
def __repr__(self) -> str:
|
||||
return self.__str__()
|
||||
|
||||
def to_compressed_obj(self) -> dict:
|
||||
"""An alternative to __dict__ that only includes fields containing non-default data."""
|
||||
obj: dict = {}
|
||||
# All Field fields (haha) are mandatory, so no value checks are done.
|
||||
obj["id"] = self.id
|
||||
obj["name"] = self.name
|
||||
obj["type"] = self.type
|
||||
|
||||
return obj
|
||||
36
src/tagstudio/core/library/alchemy/constants.py
Normal file
36
src/tagstudio/core/library/alchemy/constants.py
Normal file
@@ -0,0 +1,36 @@
|
||||
# Copyright (C) 2025
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from sqlalchemy import text
|
||||
|
||||
SQL_FILENAME: str = "ts_library.sqlite"
|
||||
JSON_FILENAME: str = "ts_library.json"
|
||||
|
||||
DB_VERSION_LEGACY_KEY: str = "DB_VERSION"
|
||||
DB_VERSION_CURRENT_KEY: str = "CURRENT"
|
||||
DB_VERSION_INITIAL_KEY: str = "INITIAL"
|
||||
DB_VERSION: int = 102
|
||||
|
||||
TAG_CHILDREN_QUERY = text("""
|
||||
WITH RECURSIVE ChildTags AS (
|
||||
SELECT :tag_id AS tag_id
|
||||
UNION
|
||||
SELECT tp.child_id AS tag_id
|
||||
FROM tag_parents tp
|
||||
INNER JOIN ChildTags c ON tp.parent_id = c.tag_id
|
||||
)
|
||||
SELECT * FROM ChildTags;
|
||||
""")
|
||||
|
||||
TAG_CHILDREN_ID_QUERY = text("""
|
||||
WITH RECURSIVE ChildTags AS (
|
||||
SELECT :tag_id AS tag_id
|
||||
UNION
|
||||
SELECT tp.child_id AS tag_id
|
||||
FROM tag_parents tp
|
||||
INNER JOIN ChildTags c ON tp.parent_id = c.tag_id
|
||||
)
|
||||
SELECT tag_id FROM ChildTags;
|
||||
""")
|
||||
@@ -4,6 +4,7 @@
|
||||
|
||||
|
||||
from pathlib import Path
|
||||
from typing import override
|
||||
|
||||
import structlog
|
||||
from sqlalchemy import Dialect, Engine, String, TypeDecorator, create_engine, text
|
||||
@@ -19,12 +20,14 @@ class PathType(TypeDecorator):
|
||||
impl = String
|
||||
cache_ok = True
|
||||
|
||||
def process_bind_param(self, value: Path, dialect: Dialect):
|
||||
@override
|
||||
def process_bind_param(self, value: Path | None, dialect: Dialect):
|
||||
if value is not None:
|
||||
return Path(value).as_posix()
|
||||
return None
|
||||
|
||||
def process_result_value(self, value: str, dialect: Dialect):
|
||||
@override
|
||||
def process_result_value(self, value: str | None, dialect: Dialect):
|
||||
if value is not None:
|
||||
return Path(value)
|
||||
return None
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
import enum
|
||||
import random
|
||||
from dataclasses import dataclass, replace
|
||||
from pathlib import Path
|
||||
|
||||
@@ -69,6 +70,7 @@ class SortingModeEnum(enum.Enum):
|
||||
DATE_ADDED = "file.date_added"
|
||||
FILE_NAME = "generic.filename"
|
||||
PATH = "file.path"
|
||||
RANDOM = "sorting.mode.random"
|
||||
|
||||
|
||||
@dataclass
|
||||
@@ -78,6 +80,7 @@ class BrowsingState:
|
||||
page_index: int = 0
|
||||
sorting_mode: SortingModeEnum = SortingModeEnum.DATE_ADDED
|
||||
ascending: bool = True
|
||||
random_seed: float = 0
|
||||
|
||||
query: str | None = None
|
||||
|
||||
@@ -97,7 +100,20 @@ class BrowsingState:
|
||||
return cls(query=search_query)
|
||||
|
||||
@classmethod
|
||||
def from_tag_id(cls, tag_id: int | str) -> "BrowsingState":
|
||||
def from_tag_id(
|
||||
cls, tag_id: int | str, state: "BrowsingState | None" = None
|
||||
) -> "BrowsingState":
|
||||
"""Create and return a BrowsingState object given a tag ID.
|
||||
|
||||
Args:
|
||||
tag_id(int): The tag ID to search for.
|
||||
state(BrowsingState|None): An optional BrowsingState object to use
|
||||
existing options from, such as sorting options.
|
||||
|
||||
"""
|
||||
logger.warning(state)
|
||||
if state:
|
||||
return state.with_search_query(f"tag_id:{str(tag_id)}")
|
||||
return cls(query=f"tag_id:{str(tag_id)}")
|
||||
|
||||
@classmethod
|
||||
@@ -120,7 +136,10 @@ class BrowsingState:
|
||||
return replace(self, page_index=index)
|
||||
|
||||
def with_sorting_mode(self, mode: SortingModeEnum) -> "BrowsingState":
|
||||
return replace(self, sorting_mode=mode)
|
||||
seed = self.random_seed
|
||||
if mode == SortingModeEnum.RANDOM:
|
||||
seed = random.random()
|
||||
return replace(self, sorting_mode=mode, random_seed=seed)
|
||||
|
||||
def with_sorting_direction(self, ascending: bool) -> "BrowsingState":
|
||||
return replace(self, ascending=ascending)
|
||||
|
||||
@@ -7,7 +7,7 @@ from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass, field
|
||||
from enum import Enum
|
||||
from typing import TYPE_CHECKING, Any
|
||||
from typing import TYPE_CHECKING, Any, override
|
||||
|
||||
from sqlalchemy import ForeignKey
|
||||
from sqlalchemy.orm import Mapped, declared_attr, mapped_column, relationship
|
||||
@@ -32,7 +32,7 @@ class BaseField(Base):
|
||||
|
||||
@declared_attr
|
||||
def type(self) -> Mapped[ValueType]:
|
||||
return relationship(foreign_keys=[self.type_key], lazy=False) # type: ignore
|
||||
return relationship(foreign_keys=[self.type_key], lazy=False) # type: ignore # pyright: ignore[reportArgumentType]
|
||||
|
||||
@declared_attr
|
||||
def entry_id(self) -> Mapped[int]:
|
||||
@@ -40,19 +40,20 @@ class BaseField(Base):
|
||||
|
||||
@declared_attr
|
||||
def entry(self) -> Mapped[Entry]:
|
||||
return relationship(foreign_keys=[self.entry_id]) # type: ignore
|
||||
return relationship(foreign_keys=[self.entry_id]) # type: ignore # pyright: ignore[reportArgumentType]
|
||||
|
||||
@declared_attr
|
||||
def position(self) -> Mapped[int]:
|
||||
return mapped_column(default=0)
|
||||
|
||||
@override
|
||||
def __hash__(self):
|
||||
return hash(self.__key())
|
||||
|
||||
def __key(self):
|
||||
def __key(self): # pyright: ignore[reportUnknownParameterType]
|
||||
raise NotImplementedError
|
||||
|
||||
value: Any
|
||||
value: Any # pyright: ignore
|
||||
|
||||
|
||||
class BooleanField(BaseField):
|
||||
@@ -63,7 +64,8 @@ class BooleanField(BaseField):
|
||||
def __key(self):
|
||||
return (self.type, self.value)
|
||||
|
||||
def __eq__(self, value) -> bool:
|
||||
@override
|
||||
def __eq__(self, value: object) -> bool:
|
||||
if isinstance(value, BooleanField):
|
||||
return self.__key() == value.__key()
|
||||
raise NotImplementedError
|
||||
@@ -74,10 +76,11 @@ class TextField(BaseField):
|
||||
|
||||
value: Mapped[str | None]
|
||||
|
||||
def __key(self) -> tuple:
|
||||
def __key(self) -> tuple[ValueType, str | None]:
|
||||
return self.type, self.value
|
||||
|
||||
def __eq__(self, value) -> bool:
|
||||
@override
|
||||
def __eq__(self, value: object) -> bool:
|
||||
if isinstance(value, TextField):
|
||||
return self.__key() == value.__key()
|
||||
elif isinstance(value, DatetimeField):
|
||||
@@ -93,7 +96,8 @@ class DatetimeField(BaseField):
|
||||
def __key(self):
|
||||
return (self.type, self.value)
|
||||
|
||||
def __eq__(self, value) -> bool:
|
||||
@override
|
||||
def __eq__(self, value: object) -> bool:
|
||||
if isinstance(value, DatetimeField):
|
||||
return self.__key() == value.__key()
|
||||
raise NotImplementedError
|
||||
@@ -107,7 +111,7 @@ class DefaultField:
|
||||
is_default: bool = field(default=False)
|
||||
|
||||
|
||||
class _FieldID(Enum):
|
||||
class FieldID(Enum):
|
||||
"""Only for bootstrapping content of DB table."""
|
||||
|
||||
TITLE = DefaultField(id=0, name="Title", type=FieldTypeEnum.TEXT_LINE, is_default=True)
|
||||
|
||||
@@ -2,6 +2,10 @@
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
# NOTE: This file contains necessary use of deprecated first-party code until that
|
||||
# code is removed in a future version (prefs).
|
||||
# pyright: reportDeprecated=false
|
||||
|
||||
|
||||
import re
|
||||
import shutil
|
||||
@@ -12,12 +16,13 @@ from dataclasses import dataclass
|
||||
from datetime import UTC, datetime
|
||||
from os import makedirs
|
||||
from pathlib import Path
|
||||
from typing import TYPE_CHECKING
|
||||
from typing import TYPE_CHECKING, Any
|
||||
from uuid import uuid4
|
||||
from warnings import catch_warnings
|
||||
|
||||
import sqlalchemy
|
||||
import structlog
|
||||
from humanfriendly import format_timespan
|
||||
from humanfriendly import format_timespan # pyright: ignore[reportUnknownVariableType]
|
||||
from sqlalchemy import (
|
||||
URL,
|
||||
ColumnExpressionArgument,
|
||||
@@ -31,6 +36,7 @@ from sqlalchemy import (
|
||||
desc,
|
||||
exists,
|
||||
func,
|
||||
inspect,
|
||||
or_,
|
||||
select,
|
||||
text,
|
||||
@@ -38,15 +44,19 @@ from sqlalchemy import (
|
||||
)
|
||||
from sqlalchemy.exc import IntegrityError
|
||||
from sqlalchemy.orm import (
|
||||
InstanceState,
|
||||
Session,
|
||||
contains_eager,
|
||||
joinedload,
|
||||
make_transient,
|
||||
noload,
|
||||
selectinload,
|
||||
)
|
||||
from typing_extensions import deprecated
|
||||
|
||||
from tagstudio.core.constants import (
|
||||
BACKUP_FOLDER_NAME,
|
||||
IGNORE_NAME,
|
||||
LEGACY_TAG_FIELD_IDS,
|
||||
RESERVED_NAMESPACE_PREFIX,
|
||||
RESERVED_TAG_END,
|
||||
@@ -58,6 +68,15 @@ from tagstudio.core.constants import (
|
||||
)
|
||||
from tagstudio.core.enums import LibraryPrefs
|
||||
from tagstudio.core.library.alchemy import default_color_groups
|
||||
from tagstudio.core.library.alchemy.constants import (
|
||||
DB_VERSION,
|
||||
DB_VERSION_CURRENT_KEY,
|
||||
DB_VERSION_INITIAL_KEY,
|
||||
DB_VERSION_LEGACY_KEY,
|
||||
JSON_FILENAME,
|
||||
SQL_FILENAME,
|
||||
TAG_CHILDREN_QUERY,
|
||||
)
|
||||
from tagstudio.core.library.alchemy.db import make_tables
|
||||
from tagstudio.core.library.alchemy.enums import (
|
||||
MAX_SQL_VARIABLES,
|
||||
@@ -68,8 +87,8 @@ from tagstudio.core.library.alchemy.enums import (
|
||||
from tagstudio.core.library.alchemy.fields import (
|
||||
BaseField,
|
||||
DatetimeField,
|
||||
FieldID,
|
||||
TextField,
|
||||
_FieldID,
|
||||
)
|
||||
from tagstudio.core.library.alchemy.joins import TagEntry, TagParent
|
||||
from tagstudio.core.library.alchemy.models import (
|
||||
@@ -81,9 +100,11 @@ from tagstudio.core.library.alchemy.models import (
|
||||
TagAlias,
|
||||
TagColorGroup,
|
||||
ValueType,
|
||||
Version,
|
||||
)
|
||||
from tagstudio.core.library.alchemy.visitors import SQLBoolExpressionBuilder
|
||||
from tagstudio.core.library.json.library import Library as JsonLibrary
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
from tagstudio.qt.translations import Translations
|
||||
|
||||
if TYPE_CHECKING:
|
||||
@@ -92,18 +113,6 @@ if TYPE_CHECKING:
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
TAG_CHILDREN_QUERY = text("""
|
||||
-- Note for this entire query that tag_parents.child_id is the parent id and tag_parents.parent_id is the child id due to bad naming
|
||||
WITH RECURSIVE ChildTags AS (
|
||||
SELECT :tag_id AS child_id
|
||||
UNION
|
||||
SELECT tp.parent_id AS child_id
|
||||
FROM tag_parents tp
|
||||
INNER JOIN ChildTags c ON tp.child_id = c.child_id
|
||||
)
|
||||
SELECT * FROM ChildTags;
|
||||
""") # noqa: E501
|
||||
|
||||
|
||||
class ReservedNamespaceError(Exception):
|
||||
"""Raise during an unauthorized attempt to create or modify a reserved namespace value.
|
||||
@@ -207,22 +216,30 @@ class Library:
|
||||
"""Class for the Library object, and all CRUD operations made upon it."""
|
||||
|
||||
library_dir: Path | None = None
|
||||
storage_path: Path | None
|
||||
storage_path: Path | str | None = None
|
||||
engine: Engine | None = None
|
||||
folder: Folder | None
|
||||
folder: Folder | None = None
|
||||
included_files: set[Path] = set()
|
||||
|
||||
SQL_FILENAME: str = "ts_library.sqlite"
|
||||
JSON_FILENAME: str = "ts_library.json"
|
||||
def __init__(self) -> None:
|
||||
self.dupe_entries_count: int = -1 # NOTE: For internal management.
|
||||
self.dupe_files_count: int = -1
|
||||
self.ignored_entries_count: int = -1
|
||||
self.unlinked_entries_count: int = -1
|
||||
|
||||
def close(self):
|
||||
if self.engine:
|
||||
self.engine.dispose()
|
||||
self.library_dir: Path | None = None
|
||||
self.library_dir = None
|
||||
self.storage_path = None
|
||||
self.folder = None
|
||||
self.included_files = set()
|
||||
|
||||
self.dupe_entries_count = -1
|
||||
self.dupe_files_count = -1
|
||||
self.ignored_entries_count = -1
|
||||
self.unlinked_entries_count = -1
|
||||
|
||||
def migrate_json_to_sqlite(self, json_lib: JsonLibrary):
|
||||
"""Migrate JSON library data to the SQLite database."""
|
||||
logger.info("Starting Library Conversion...")
|
||||
@@ -272,8 +289,8 @@ class Library:
|
||||
|
||||
# Parent Tags (Previously known as "Subtags" in JSON)
|
||||
for tag in json_lib.tags:
|
||||
for child_id in tag.subtag_ids:
|
||||
self.add_parent_tag(parent_id=tag.id, child_id=child_id)
|
||||
for parent_id in tag.subtag_ids:
|
||||
self.add_parent_tag(parent_id=parent_id, child_id=tag.id)
|
||||
|
||||
# Entries
|
||||
self.add_entries(
|
||||
@@ -289,8 +306,8 @@ class Library:
|
||||
]
|
||||
)
|
||||
for entry in json_lib.entries:
|
||||
for field in entry.fields:
|
||||
for k, v in field.items():
|
||||
for field in entry.fields: # pyright: ignore[reportUnknownVariableType]
|
||||
for k, v in field.items(): # pyright: ignore[reportUnknownVariableType]
|
||||
# Old tag fields get added as tags
|
||||
if k in LEGACY_TAG_FIELD_IDS:
|
||||
self.add_tags_to_entries(entry_ids=entry.id + 1, tag_ids=v)
|
||||
@@ -308,19 +325,18 @@ class Library:
|
||||
end_time = time.time()
|
||||
logger.info(f"Library Converted! ({format_timespan(end_time - start_time)})")
|
||||
|
||||
def get_field_name_from_id(self, field_id: int) -> _FieldID:
|
||||
for f in _FieldID:
|
||||
def get_field_name_from_id(self, field_id: int) -> FieldID | None:
|
||||
for f in FieldID:
|
||||
if field_id == f.value.id:
|
||||
return f
|
||||
return None
|
||||
|
||||
def tag_display_name(self, tag_id: int) -> str:
|
||||
with Session(self.engine) as session:
|
||||
tag = session.scalar(select(Tag).where(Tag.id == tag_id))
|
||||
if not tag:
|
||||
return "<NO TAG>"
|
||||
def tag_display_name(self, tag: Tag | None) -> str:
|
||||
if not tag:
|
||||
return "<NO TAG>"
|
||||
|
||||
if tag.disambiguation_id:
|
||||
if tag.disambiguation_id:
|
||||
with Session(self.engine) as session:
|
||||
disam_tag = session.scalar(select(Tag).where(Tag.id == tag.disambiguation_id))
|
||||
if not disam_tag:
|
||||
return "<NO DISAM TAG>"
|
||||
@@ -328,19 +344,22 @@ class Library:
|
||||
if not disam_name:
|
||||
disam_name = disam_tag.name
|
||||
return f"{tag.name} ({disam_name})"
|
||||
else:
|
||||
return tag.name
|
||||
else:
|
||||
return tag.name
|
||||
|
||||
def open_library(self, library_dir: Path, storage_path: Path | None = None) -> LibraryStatus:
|
||||
def open_library(
|
||||
self, library_dir: Path, storage_path: Path | str | None = None
|
||||
) -> LibraryStatus:
|
||||
is_new: bool = True
|
||||
if storage_path == ":memory:":
|
||||
self.storage_path = storage_path
|
||||
is_new = True
|
||||
return self.open_sqlite_library(library_dir, is_new)
|
||||
else:
|
||||
self.storage_path = library_dir / TS_FOLDER_NAME / self.SQL_FILENAME
|
||||
self.storage_path = library_dir / TS_FOLDER_NAME / SQL_FILENAME
|
||||
assert isinstance(self.storage_path, Path)
|
||||
if self.verify_ts_folder(library_dir) and (is_new := not self.storage_path.exists()):
|
||||
json_path = library_dir / TS_FOLDER_NAME / self.JSON_FILENAME
|
||||
json_path = library_dir / TS_FOLDER_NAME / JSON_FILENAME
|
||||
if json_path.exists():
|
||||
return LibraryStatus(
|
||||
success=False,
|
||||
@@ -364,7 +383,7 @@ class Library:
|
||||
# https://docs.sqlalchemy.org/en/20/changelog/migration_07.html
|
||||
# Under -> sqlite-the-sqlite-dialect-now-uses-nullpool-for-file-based-databases
|
||||
poolclass = None if self.storage_path == ":memory:" else NullPool
|
||||
db_version: int = 0
|
||||
loaded_db_version: int = 0
|
||||
|
||||
logger.info(
|
||||
"[Library] Opening SQLite Library",
|
||||
@@ -373,16 +392,19 @@ class Library:
|
||||
)
|
||||
self.engine = create_engine(connection_string, poolclass=poolclass)
|
||||
with Session(self.engine) as session:
|
||||
# dont check db version when creating new library
|
||||
# Don't check DB version when creating new library
|
||||
if not is_new:
|
||||
db_result = session.scalar(
|
||||
select(Preferences).where(Preferences.key == LibraryPrefs.DB_VERSION.name)
|
||||
)
|
||||
if db_result:
|
||||
db_version = db_result.value
|
||||
loaded_db_version = self.get_version(DB_VERSION_CURRENT_KEY)
|
||||
|
||||
# NOTE: DB_VERSION 6 is the first supported SQL DB version.
|
||||
if db_version < 6 or db_version > LibraryPrefs.DB_VERSION.default:
|
||||
# ======================== Library Database Version Checking =======================
|
||||
# DB_VERSION 6 is the first supported SQLite DB version.
|
||||
# If the DB_VERSION is >= 100, that means it's a compound major + minor version.
|
||||
# - Dividing by 100 and flooring gives the major (breaking changes) version.
|
||||
# - If a DB has major version higher than the current program, don't load it.
|
||||
# - If only the minor version is higher, it's still allowed to load.
|
||||
if loaded_db_version < 6 or (
|
||||
loaded_db_version >= 100 and loaded_db_version // 100 > DB_VERSION // 100
|
||||
):
|
||||
mismatch_text = Translations["status.library_version_mismatch"]
|
||||
found_text = Translations["status.library_version_found"]
|
||||
expected_text = Translations["status.library_version_expected"]
|
||||
@@ -390,12 +412,12 @@ class Library:
|
||||
success=False,
|
||||
message=(
|
||||
f"{mismatch_text}\n"
|
||||
f"{found_text} v{db_version}, "
|
||||
f"{expected_text} v{LibraryPrefs.DB_VERSION.default}"
|
||||
f"{found_text} v{loaded_db_version}, "
|
||||
f"{expected_text} v{DB_VERSION}"
|
||||
),
|
||||
)
|
||||
|
||||
logger.info(f"[Library] DB_VERSION: {db_version}")
|
||||
logger.info(f"[Library] DB_VERSION: {loaded_db_version}")
|
||||
make_tables(self.engine)
|
||||
|
||||
# Add default tag color namespaces.
|
||||
@@ -433,16 +455,40 @@ class Library:
|
||||
except IntegrityError:
|
||||
session.rollback()
|
||||
|
||||
# Ensure version rows are present
|
||||
with catch_warnings(record=True):
|
||||
# NOTE: The "Preferences" table is depreciated and will be removed in the future.
|
||||
# The DB_VERSION is still being set to it in order to remain backwards-compatible
|
||||
# with existing TagStudio versions until it is removed.
|
||||
try:
|
||||
session.add(Preferences(key=DB_VERSION_LEGACY_KEY, value=DB_VERSION))
|
||||
session.commit()
|
||||
except IntegrityError:
|
||||
session.rollback()
|
||||
|
||||
try:
|
||||
initial = DB_VERSION if is_new else 100
|
||||
session.add(Version(key=DB_VERSION_INITIAL_KEY, value=initial))
|
||||
session.commit()
|
||||
except IntegrityError:
|
||||
session.rollback()
|
||||
|
||||
try:
|
||||
session.add(Version(key=DB_VERSION_CURRENT_KEY, value=DB_VERSION))
|
||||
session.commit()
|
||||
except IntegrityError:
|
||||
session.rollback()
|
||||
|
||||
# TODO: Remove this "Preferences" system.
|
||||
for pref in LibraryPrefs:
|
||||
with catch_warnings(record=True):
|
||||
try:
|
||||
session.add(Preferences(key=pref.name, value=pref.default))
|
||||
session.commit()
|
||||
except IntegrityError:
|
||||
logger.debug("preference already exists", pref=pref)
|
||||
session.rollback()
|
||||
|
||||
for field in _FieldID:
|
||||
for field in FieldID:
|
||||
try:
|
||||
session.add(
|
||||
ValueType(
|
||||
@@ -470,47 +516,64 @@ class Library:
|
||||
session.commit()
|
||||
self.folder = folder
|
||||
|
||||
# Generate default .ts_ignore file
|
||||
if is_new:
|
||||
try:
|
||||
ts_ignore_template = (
|
||||
Path(__file__).parents[3] / "resources/templates/ts_ignore_template.txt"
|
||||
)
|
||||
shutil.copy2(ts_ignore_template, library_dir / TS_FOLDER_NAME / IGNORE_NAME)
|
||||
except Exception as e:
|
||||
logger.error("[ERROR][Library] Could not generate '.ts_ignore' file!", error=e)
|
||||
|
||||
# Apply any post-SQL migration patches.
|
||||
if not is_new:
|
||||
# save backup if patches will be applied
|
||||
if LibraryPrefs.DB_VERSION.default != db_version:
|
||||
if loaded_db_version < DB_VERSION:
|
||||
self.library_dir = library_dir
|
||||
self.save_library_backup_to_disk()
|
||||
self.library_dir = None
|
||||
|
||||
# schema changes first
|
||||
if db_version < 8:
|
||||
self.apply_db8_schema_changes(session)
|
||||
if db_version < 9:
|
||||
self.apply_db9_schema_changes(session)
|
||||
# NOTE: Depending on the data, some data and schema changes need to be applied in
|
||||
# different orders. This chain of methods can likely be cleaned up and/or moved.
|
||||
if loaded_db_version < 8:
|
||||
self.__apply_db8_schema_changes(session)
|
||||
if loaded_db_version < 9:
|
||||
self.__apply_db9_schema_changes(session)
|
||||
if loaded_db_version == 6:
|
||||
self.__apply_repairs_for_db6(session)
|
||||
|
||||
# now the data changes
|
||||
if db_version == 6:
|
||||
self.apply_repairs_for_db6(session)
|
||||
if db_version >= 6 and db_version < 8:
|
||||
self.apply_db8_default_data(session)
|
||||
if db_version < 9:
|
||||
self.apply_db9_filename_population(session)
|
||||
if loaded_db_version >= 6 and loaded_db_version < 8:
|
||||
self.__apply_db8_default_data(session)
|
||||
if loaded_db_version < 9:
|
||||
self.__apply_db9_filename_population(session)
|
||||
if loaded_db_version < 100:
|
||||
self.__apply_db100_parent_repairs(session)
|
||||
if loaded_db_version < 102:
|
||||
self.__apply_db102_repairs(session)
|
||||
|
||||
# Convert file extension list to ts_ignore file, if a .ts_ignore file does not exist
|
||||
self.migrate_sql_to_ts_ignore(library_dir)
|
||||
|
||||
# Update DB_VERSION
|
||||
if LibraryPrefs.DB_VERSION.default > db_version:
|
||||
self.set_prefs(LibraryPrefs.DB_VERSION, LibraryPrefs.DB_VERSION.default)
|
||||
if loaded_db_version < DB_VERSION:
|
||||
self.set_version(DB_VERSION_CURRENT_KEY, DB_VERSION)
|
||||
|
||||
# everything is fine, set the library path
|
||||
self.library_dir = library_dir
|
||||
return LibraryStatus(success=True, library_path=library_dir)
|
||||
|
||||
def apply_repairs_for_db6(self, session: Session):
|
||||
def __apply_repairs_for_db6(self, session: Session):
|
||||
"""Apply database repairs introduced in DB_VERSION 7."""
|
||||
logger.info("[Library][Migration] Applying patches to DB_VERSION: 6 library...")
|
||||
with session:
|
||||
# Repair "Description" fields with a TEXT_LINE key instead of a TEXT_BOX key.
|
||||
desc_stmd = (
|
||||
desc_stmt = (
|
||||
update(ValueType)
|
||||
.where(ValueType.key == _FieldID.DESCRIPTION.name)
|
||||
.where(ValueType.key == FieldID.DESCRIPTION.name)
|
||||
.values(type=FieldTypeEnum.TEXT_BOX.name)
|
||||
)
|
||||
session.execute(desc_stmd)
|
||||
session.execute(desc_stmt)
|
||||
session.flush()
|
||||
|
||||
# Repair tags that may have a disambiguation_id pointing towards a deleted tag.
|
||||
@@ -521,11 +584,9 @@ class Library:
|
||||
.values(disambiguation_id=None)
|
||||
)
|
||||
session.execute(disam_stmt)
|
||||
session.flush()
|
||||
|
||||
session.commit()
|
||||
|
||||
def apply_db8_schema_changes(self, session: Session):
|
||||
def __apply_db8_schema_changes(self, session: Session):
|
||||
"""Apply database schema changes introduced in DB_VERSION 8."""
|
||||
# TODO: Use Alembic for this part instead
|
||||
# Add the missing color_border column to the TagColorGroups table.
|
||||
@@ -543,7 +604,7 @@ class Library:
|
||||
)
|
||||
session.rollback()
|
||||
|
||||
def apply_db8_default_data(self, session: Session):
|
||||
def __apply_db8_default_data(self, session: Session):
|
||||
"""Apply default data changes introduced in DB_VERSION 8."""
|
||||
tag_colors: list[TagColorGroup] = default_color_groups.standard()
|
||||
tag_colors += default_color_groups.pastels()
|
||||
@@ -593,7 +654,7 @@ class Library:
|
||||
)
|
||||
session.rollback()
|
||||
|
||||
def apply_db9_schema_changes(self, session: Session):
|
||||
def __apply_db9_schema_changes(self, session: Session):
|
||||
"""Apply database schema changes introduced in DB_VERSION 9."""
|
||||
add_filename_column = text(
|
||||
"ALTER TABLE entries ADD COLUMN filename TEXT NOT NULL DEFAULT ''"
|
||||
@@ -609,13 +670,62 @@ class Library:
|
||||
)
|
||||
session.rollback()
|
||||
|
||||
def apply_db9_filename_population(self, session: Session):
|
||||
def __apply_db9_filename_population(self, session: Session):
|
||||
"""Populate the filename column introduced in DB_VERSION 9."""
|
||||
for entry in self.all_entries():
|
||||
session.merge(entry).filename = entry.path.name
|
||||
session.commit()
|
||||
logger.info("[Library][Migration] Populated filename column in entries table")
|
||||
|
||||
def __apply_db100_parent_repairs(self, session: Session):
|
||||
"""Swap the child_id and parent_id values in the TagParent table."""
|
||||
with session:
|
||||
# Repair parent-child tag relationships that are the wrong way around.
|
||||
stmt = update(TagParent).values(
|
||||
parent_id=TagParent.child_id,
|
||||
child_id=TagParent.parent_id,
|
||||
)
|
||||
session.execute(stmt)
|
||||
session.commit()
|
||||
logger.info("[Library][Migration] Refactored TagParent table")
|
||||
|
||||
def __apply_db102_repairs(self, session: Session):
|
||||
"""Repair tag_parents rows with references to deleted tags."""
|
||||
with session:
|
||||
all_tag_ids: list[int] = [t.id for t in self.tags]
|
||||
stmt = delete(TagParent).where(TagParent.parent_id.not_in(all_tag_ids))
|
||||
session.execute(stmt)
|
||||
session.commit()
|
||||
logger.info("[Library][Migration] Verified TagParent table data")
|
||||
|
||||
def migrate_sql_to_ts_ignore(self, library_dir: Path):
|
||||
# Do not continue if existing '.ts_ignore' file is found
|
||||
if Path(library_dir / TS_FOLDER_NAME / IGNORE_NAME).exists():
|
||||
return
|
||||
|
||||
# Create blank '.ts_ignore' file
|
||||
ts_ignore_template = (
|
||||
Path(__file__).parents[3] / "resources/templates/ts_ignore_template_blank.txt"
|
||||
)
|
||||
ts_ignore = library_dir / TS_FOLDER_NAME / IGNORE_NAME
|
||||
try:
|
||||
shutil.copy2(ts_ignore_template, ts_ignore)
|
||||
except Exception as e:
|
||||
logger.error("[ERROR][Library] Could not generate '.ts_ignore' file!", error=e)
|
||||
|
||||
# Load legacy extension data
|
||||
extensions: list[str] = self.prefs(LibraryPrefs.EXTENSION_LIST) # pyright: ignore
|
||||
is_exclude_list: bool = self.prefs(LibraryPrefs.IS_EXCLUDE_LIST) # pyright: ignore
|
||||
|
||||
# Copy extensions to '.ts_ignore' file
|
||||
if ts_ignore.exists():
|
||||
with open(ts_ignore, "a") as f:
|
||||
prefix = ""
|
||||
if not is_exclude_list:
|
||||
prefix = "!"
|
||||
f.write("*\n")
|
||||
f.writelines([f"{prefix}*.{x.lstrip('.')}\n" for x in extensions])
|
||||
|
||||
@property
|
||||
def default_fields(self) -> list[BaseField]:
|
||||
with Session(self.engine) as session:
|
||||
@@ -627,12 +737,6 @@ class Library:
|
||||
)
|
||||
return [x.as_field for x in types]
|
||||
|
||||
def delete_item(self, item):
|
||||
logger.info("deleting item", item=item)
|
||||
with Session(self.engine) as session:
|
||||
session.delete(item)
|
||||
session.commit()
|
||||
|
||||
def get_entry(self, entry_id: int) -> Entry | None:
|
||||
"""Load entry without joins."""
|
||||
with Session(self.engine) as session:
|
||||
@@ -659,7 +763,10 @@ class Library:
|
||||
entry_stmt = (
|
||||
entry_stmt.outerjoin(Entry.text_fields)
|
||||
.outerjoin(Entry.datetime_fields)
|
||||
.options(selectinload(Entry.text_fields), selectinload(Entry.datetime_fields))
|
||||
.options(
|
||||
selectinload(Entry.text_fields),
|
||||
selectinload(Entry.datetime_fields),
|
||||
)
|
||||
)
|
||||
# if with_tags:
|
||||
# entry_stmt = entry_stmt.outerjoin(Entry.tags).options(selectinload(Entry.tags))
|
||||
@@ -768,7 +875,7 @@ class Library:
|
||||
@property
|
||||
def entries_count(self) -> int:
|
||||
with Session(self.engine) as session:
|
||||
return session.scalar(select(func.count(Entry.id)))
|
||||
return unwrap(session.scalar(select(func.count(Entry.id))))
|
||||
|
||||
def all_entries(self, with_joins: bool = False) -> Iterator[Entry]:
|
||||
"""Load entries without joins."""
|
||||
@@ -810,7 +917,7 @@ class Library:
|
||||
|
||||
return list(tags_list)
|
||||
|
||||
def verify_ts_folder(self, library_dir: Path) -> bool:
|
||||
def verify_ts_folder(self, library_dir: Path | None) -> bool:
|
||||
"""Verify/create folders required by TagStudio.
|
||||
|
||||
Returns:
|
||||
@@ -864,7 +971,7 @@ class Library:
|
||||
with Session(self.engine) as session:
|
||||
return session.query(exists().where(Entry.path == path)).scalar()
|
||||
|
||||
def get_paths(self, glob: str | None = None, limit: int = -1) -> list[str]:
|
||||
def get_paths(self, limit: int = -1) -> list[str]:
|
||||
path_strings: list[str] = []
|
||||
with Session(self.engine) as session:
|
||||
if limit > 0:
|
||||
@@ -884,9 +991,9 @@ class Library:
|
||||
:return: number of entries matching the query and one page of results.
|
||||
"""
|
||||
assert isinstance(search, BrowsingState)
|
||||
assert self.engine
|
||||
assert self.library_dir
|
||||
|
||||
with Session(self.engine, expire_on_commit=False) as session:
|
||||
with Session(unwrap(self.engine), expire_on_commit=False) as session:
|
||||
statement = select(Entry.id, func.count().over())
|
||||
|
||||
if search.ast:
|
||||
@@ -896,14 +1003,7 @@ class Library:
|
||||
logger.info(
|
||||
f"SQL Expression Builder finished ({format_timespan(end_time - start_time)})"
|
||||
)
|
||||
|
||||
extensions = self.prefs(LibraryPrefs.EXTENSION_LIST)
|
||||
is_exclude_list = self.prefs(LibraryPrefs.IS_EXCLUDE_LIST)
|
||||
|
||||
if extensions and is_exclude_list:
|
||||
statement = statement.where(Entry.suffix.notin_(extensions))
|
||||
elif extensions:
|
||||
statement = statement.where(Entry.suffix.in_(extensions))
|
||||
statement = statement.distinct(Entry.id)
|
||||
|
||||
sort_on: ColumnExpressionArgument = Entry.id
|
||||
match search.sorting_mode:
|
||||
@@ -913,6 +1013,8 @@ class Library:
|
||||
sort_on = func.lower(Entry.filename)
|
||||
case SortingModeEnum.PATH:
|
||||
sort_on = func.lower(Entry.path)
|
||||
case SortingModeEnum.RANDOM:
|
||||
sort_on = func.sin(Entry.id * search.random_seed)
|
||||
|
||||
statement = statement.order_by(asc(sort_on) if search.ascending else desc(sort_on))
|
||||
if page_size is not None:
|
||||
@@ -929,7 +1031,7 @@ class Library:
|
||||
ids = []
|
||||
count = 0
|
||||
for row in rows:
|
||||
id, count = row._tuple()
|
||||
id, count = row._tuple() # pyright: ignore[reportPrivateUsage]
|
||||
ids.append(id)
|
||||
end_time = time.time()
|
||||
logger.info(f"SQL Execution finished ({format_timespan(end_time - start_time)})")
|
||||
@@ -1018,45 +1120,36 @@ class Library:
|
||||
session.commit()
|
||||
return True
|
||||
|
||||
def remove_tag(self, tag: Tag):
|
||||
def remove_tag(self, tag_id: int):
|
||||
with Session(self.engine, expire_on_commit=False) as session:
|
||||
try:
|
||||
child_tags = session.scalars(
|
||||
select(TagParent).where(TagParent.child_id == tag.id)
|
||||
).all()
|
||||
tags_query = select(Tag).options(
|
||||
selectinload(Tag.parent_tags), selectinload(Tag.aliases)
|
||||
)
|
||||
tag = session.scalar(tags_query.where(Tag.id == tag.id))
|
||||
aliases = session.scalars(select(TagAlias).where(TagAlias.tag_id == tag.id))
|
||||
|
||||
for alias in aliases or []:
|
||||
aliases = session.scalars(select(TagAlias).where(TagAlias.tag_id == tag_id))
|
||||
for alias in aliases:
|
||||
session.delete(alias)
|
||||
session.flush()
|
||||
|
||||
for child_tag in child_tags or []:
|
||||
session.delete(child_tag)
|
||||
session.expunge(child_tag)
|
||||
tag_parents = session.scalars(
|
||||
select(TagParent).where(TagParent.parent_id == tag_id)
|
||||
).all()
|
||||
for tag_parent in tag_parents:
|
||||
session.delete(tag_parent)
|
||||
session.flush()
|
||||
|
||||
disam_stmt = (
|
||||
update(Tag)
|
||||
.where(Tag.disambiguation_id == tag.id)
|
||||
.where(Tag.disambiguation_id == tag_id)
|
||||
.values(disambiguation_id=None)
|
||||
)
|
||||
session.execute(disam_stmt)
|
||||
session.flush()
|
||||
|
||||
session.delete(tag)
|
||||
session.query(Tag).filter_by(id=tag_id).delete()
|
||||
session.commit()
|
||||
session.expunge(tag)
|
||||
|
||||
return tag
|
||||
|
||||
except IntegrityError as e:
|
||||
logger.error(e)
|
||||
session.rollback()
|
||||
|
||||
return None
|
||||
|
||||
def update_field_position(
|
||||
self,
|
||||
field_class: type[BaseField],
|
||||
@@ -1156,7 +1249,7 @@ class Library:
|
||||
|
||||
def get_value_type(self, field_key: str) -> ValueType:
|
||||
with Session(self.engine) as session:
|
||||
field = session.scalar(select(ValueType).where(ValueType.key == field_key))
|
||||
field = unwrap(session.scalar(select(ValueType).where(ValueType.key == field_key)))
|
||||
session.expunge(field)
|
||||
return field
|
||||
|
||||
@@ -1165,11 +1258,11 @@ class Library:
|
||||
entry_id: int,
|
||||
*,
|
||||
field: ValueType | None = None,
|
||||
field_id: _FieldID | str | None = None,
|
||||
field_id: FieldID | str | None = None,
|
||||
value: str | datetime | None = None,
|
||||
) -> bool:
|
||||
logger.info(
|
||||
"add_field_to_entry",
|
||||
"[Library][add_field_to_entry]",
|
||||
entry_id=entry_id,
|
||||
field_type=field,
|
||||
field_id=field_id,
|
||||
@@ -1179,9 +1272,9 @@ class Library:
|
||||
assert bool(field) != (field_id is not None)
|
||||
|
||||
if not field:
|
||||
if isinstance(field_id, _FieldID):
|
||||
if isinstance(field_id, FieldID):
|
||||
field_id = field_id.name
|
||||
field = self.get_value_type(field_id)
|
||||
field = self.get_value_type(unwrap(field_id))
|
||||
|
||||
field_model: TextField | DatetimeField
|
||||
if field.type in (FieldTypeEnum.TEXT_LINE, FieldTypeEnum.TEXT_BOX):
|
||||
@@ -1341,9 +1434,20 @@ class Library:
|
||||
return None
|
||||
|
||||
def add_tags_to_entries(
|
||||
self, entry_ids: int | list[int], tag_ids: int | list[int] | set[int]
|
||||
) -> bool:
|
||||
"""Add one or more tags to one or more entries."""
|
||||
self, entry_ids: int | list[int] | set[int], tag_ids: int | list[int] | set[int]
|
||||
) -> int:
|
||||
"""Add one or more tags to one or more entries.
|
||||
|
||||
Returns:
|
||||
The total number of tags added across all entries.
|
||||
"""
|
||||
total_added: int = 0
|
||||
logger.info(
|
||||
"[Library][add_tags_to_entries]",
|
||||
entry_ids=entry_ids,
|
||||
tag_ids=tag_ids,
|
||||
)
|
||||
|
||||
entry_ids_ = [entry_ids] if isinstance(entry_ids, int) else entry_ids
|
||||
tag_ids_ = [tag_ids] if isinstance(tag_ids, int) else tag_ids
|
||||
with Session(self.engine, expire_on_commit=False) as session:
|
||||
@@ -1351,19 +1455,15 @@ class Library:
|
||||
for entry_id in entry_ids_:
|
||||
try:
|
||||
session.add(TagEntry(tag_id=tag_id, entry_id=entry_id))
|
||||
session.flush()
|
||||
total_added += 1
|
||||
session.commit()
|
||||
except IntegrityError:
|
||||
session.rollback()
|
||||
try:
|
||||
session.commit()
|
||||
except IntegrityError as e:
|
||||
logger.warning("[Library][add_tags_to_entries]", warning=e)
|
||||
session.rollback()
|
||||
return False
|
||||
return True
|
||||
|
||||
return total_added
|
||||
|
||||
def remove_tags_from_entries(
|
||||
self, entry_ids: int | list[int], tag_ids: int | list[int] | set[int]
|
||||
self, entry_ids: int | list[int] | set[int], tag_ids: int | list[int] | set[int]
|
||||
) -> bool:
|
||||
"""Remove one or more tags from one or more entries."""
|
||||
entry_ids_ = [entry_ids] if isinstance(entry_ids, int) else entry_ids
|
||||
@@ -1426,7 +1526,7 @@ class Library:
|
||||
target_path = self.library_dir / TS_FOLDER_NAME / BACKUP_FOLDER_NAME / filename
|
||||
|
||||
shutil.copy2(
|
||||
self.library_dir / TS_FOLDER_NAME / self.SQL_FILENAME,
|
||||
self.library_dir / TS_FOLDER_NAME / SQL_FILENAME,
|
||||
target_path,
|
||||
)
|
||||
|
||||
@@ -1490,6 +1590,51 @@ class Library:
|
||||
|
||||
return session.scalar(statement)
|
||||
|
||||
def get_tag_hierarchy(self, tag_ids: Iterable[int]) -> dict[int, Tag]:
|
||||
"""Get a dictionary containing tags in `tag_ids` and all of their ancestor tags."""
|
||||
current_tag_ids: set[int] = set(tag_ids)
|
||||
all_tag_ids: set[int] = set()
|
||||
all_tags: dict[int, Tag] = {}
|
||||
all_tag_parents: dict[int, list[int]] = {}
|
||||
|
||||
with Session(self.engine) as session:
|
||||
while len(current_tag_ids) > 0:
|
||||
all_tag_ids.update(current_tag_ids)
|
||||
statement = select(TagParent).where(TagParent.child_id.in_(current_tag_ids))
|
||||
tag_parents = session.scalars(statement).fetchall()
|
||||
current_tag_ids.clear()
|
||||
for tag_parent in tag_parents:
|
||||
all_tag_parents.setdefault(tag_parent.child_id, []).append(tag_parent.parent_id)
|
||||
current_tag_ids.add(tag_parent.parent_id)
|
||||
current_tag_ids = current_tag_ids.difference(all_tag_ids)
|
||||
|
||||
statement = select(Tag).where(Tag.id.in_(all_tag_ids))
|
||||
statement = statement.options(
|
||||
noload(Tag.parent_tags), selectinload(Tag.aliases), joinedload(Tag.color)
|
||||
)
|
||||
tags = session.scalars(statement).fetchall()
|
||||
for tag in tags:
|
||||
all_tags[tag.id] = tag
|
||||
for tag in all_tags.values():
|
||||
try:
|
||||
# Sqlalchemy tracks this as a change to the parent_tags field
|
||||
tag.parent_tags = {all_tags[p] for p in all_tag_parents.get(tag.id, [])}
|
||||
# When calling session.add with this tag instance sqlalchemy will
|
||||
# attempt to create TagParents that already exist.
|
||||
|
||||
state: InstanceState[Tag] = inspect(tag)
|
||||
# Prevent sqlalchemy from thinking fields are different from what's committed
|
||||
# committed_state contains original values for fields that have changed.
|
||||
# empty when no fields have changed
|
||||
state.committed_state.clear()
|
||||
except KeyError as e:
|
||||
logger.error(
|
||||
"[LIBRARY][get_tag_hierarchy] Tag referenced by TagParent does not exist!",
|
||||
error=e,
|
||||
)
|
||||
|
||||
return all_tags
|
||||
|
||||
def add_parent_tag(self, parent_id: int, child_id: int) -> bool:
|
||||
if parent_id == child_id:
|
||||
return False
|
||||
@@ -1598,7 +1743,13 @@ class Library:
|
||||
else:
|
||||
self.add_color(new_color_group)
|
||||
|
||||
def update_aliases(self, tag, alias_ids, alias_names, session):
|
||||
def update_aliases(
|
||||
self,
|
||||
tag: Tag,
|
||||
alias_ids: list[int] | set[int],
|
||||
alias_names: list[str] | set[str],
|
||||
session: Session,
|
||||
):
|
||||
prev_aliases = session.scalars(select(TagAlias).where(TagAlias.tag_id == tag.id)).all()
|
||||
|
||||
for alias in prev_aliases:
|
||||
@@ -1612,7 +1763,7 @@ class Library:
|
||||
alias = TagAlias(alias_name, tag.id)
|
||||
session.add(alias)
|
||||
|
||||
def update_parent_tags(self, tag: Tag, parent_ids: list[int] | set[int], session):
|
||||
def update_parent_tags(self, tag: Tag, parent_ids: list[int] | set[int], session: Session):
|
||||
if tag.id in parent_ids:
|
||||
parent_ids.remove(tag.id)
|
||||
|
||||
@@ -1621,35 +1772,110 @@ class Library:
|
||||
|
||||
# load all tag's parent tags to know which to remove
|
||||
prev_parent_tags = session.scalars(
|
||||
select(TagParent).where(TagParent.parent_id == tag.id)
|
||||
select(TagParent).where(TagParent.child_id == tag.id)
|
||||
).all()
|
||||
|
||||
for parent_tag in prev_parent_tags:
|
||||
if parent_tag.child_id not in parent_ids:
|
||||
if parent_tag.parent_id not in parent_ids:
|
||||
session.delete(parent_tag)
|
||||
else:
|
||||
# no change, remove from list
|
||||
parent_ids.remove(parent_tag.child_id)
|
||||
parent_ids.remove(parent_tag.parent_id)
|
||||
|
||||
# create remaining items
|
||||
for parent_id in parent_ids:
|
||||
# add new parent tag
|
||||
parent_tag = TagParent(
|
||||
parent_id=tag.id,
|
||||
child_id=parent_id,
|
||||
parent_id=parent_id,
|
||||
child_id=tag.id,
|
||||
)
|
||||
session.add(parent_tag)
|
||||
|
||||
def prefs(self, key: LibraryPrefs):
|
||||
def get_version(self, key: str) -> int:
|
||||
"""Get a version value from the DB.
|
||||
|
||||
Args:
|
||||
key(str): The key for the name of the version type to set.
|
||||
"""
|
||||
with Session(self.engine) as session:
|
||||
engine = sqlalchemy.inspect(self.engine)
|
||||
try:
|
||||
# "Version" table added in DB_VERSION 101
|
||||
if engine and engine.has_table("Version"):
|
||||
version = session.scalar(select(Version).where(Version.key == key))
|
||||
assert version
|
||||
return version.value
|
||||
# NOTE: The "Preferences" table has been depreciated as of TagStudio 9.5.4
|
||||
# and is set to be removed in a future release.
|
||||
else:
|
||||
pref_version = session.scalar(
|
||||
select(Preferences).where(Preferences.key == DB_VERSION_LEGACY_KEY)
|
||||
)
|
||||
assert pref_version
|
||||
assert isinstance(pref_version.value, int)
|
||||
return pref_version.value
|
||||
except Exception:
|
||||
return 0
|
||||
|
||||
def set_version(self, key: str, value: int) -> None:
|
||||
"""Set a version value to the DB.
|
||||
|
||||
Args:
|
||||
key(str): The key for the name of the version type to set.
|
||||
value(int): The version value to set.
|
||||
"""
|
||||
with Session(self.engine) as session:
|
||||
try:
|
||||
version = session.scalar(select(Version).where(Version.key == key))
|
||||
assert version
|
||||
version.value = value
|
||||
session.add(version)
|
||||
session.commit()
|
||||
|
||||
# If a depreciated "Preferences" table is found, update the version value to be read
|
||||
# by older TagStudio versions.
|
||||
engine = sqlalchemy.inspect(self.engine)
|
||||
if engine and engine.has_table("Preferences"):
|
||||
pref = unwrap(
|
||||
session.scalar(
|
||||
select(Preferences).where(Preferences.key == DB_VERSION_LEGACY_KEY)
|
||||
)
|
||||
)
|
||||
pref.value = value # pyright: ignore
|
||||
session.add(pref)
|
||||
session.commit()
|
||||
except (IntegrityError, AssertionError) as e:
|
||||
logger.error("[Library][ERROR] Couldn't add default tag color namespaces", error=e)
|
||||
session.rollback()
|
||||
|
||||
# TODO: Remove this once the 'preferences' table is removed.
|
||||
@deprecated("Use `get_version() for version and `ts_ignore` system for extension exclusion.")
|
||||
def prefs(self, key: str | LibraryPrefs): # pyright: ignore[reportUnknownParameterType]
|
||||
# load given item from Preferences table
|
||||
with Session(self.engine) as session:
|
||||
return session.scalar(select(Preferences).where(Preferences.key == key.name)).value
|
||||
if isinstance(key, LibraryPrefs):
|
||||
return session.scalar(select(Preferences).where(Preferences.key == key.name)).value # pyright: ignore
|
||||
else:
|
||||
return session.scalar(select(Preferences).where(Preferences.key == key)).value # pyright: ignore
|
||||
|
||||
def set_prefs(self, key: LibraryPrefs, value) -> None:
|
||||
# TODO: Remove this once the 'preferences' table is removed.
|
||||
@deprecated("Use `get_version() for version and `ts_ignore` system for extension exclusion.")
|
||||
def set_prefs(self, key: str | LibraryPrefs, value: Any) -> None: # pyright: ignore[reportExplicitAny]
|
||||
# set given item in Preferences table
|
||||
with Session(self.engine) as session:
|
||||
# load existing preference and update value
|
||||
pref = session.scalar(select(Preferences).where(Preferences.key == key.name))
|
||||
stuff = session.scalars(select(Preferences))
|
||||
logger.info([x.key for x in list(stuff)])
|
||||
|
||||
pref: Preferences = unwrap(
|
||||
session.scalar(
|
||||
select(Preferences).where(
|
||||
Preferences.key == (key.name if isinstance(key, LibraryPrefs) else key)
|
||||
)
|
||||
)
|
||||
)
|
||||
|
||||
logger.info("loading pref", pref=pref, key=key, value=value)
|
||||
pref.value = value
|
||||
session.add(pref)
|
||||
session.commit()
|
||||
@@ -1666,7 +1892,7 @@ class Library:
|
||||
|
||||
# assign the field to all entries
|
||||
for entry in entries:
|
||||
for field_key, field in fields.items():
|
||||
for field_key, field in fields.items(): # pyright: ignore[reportUnknownVariableType]
|
||||
if field_key not in existing_fields:
|
||||
self.add_field_to_entry(
|
||||
entry_id=entry.id,
|
||||
@@ -1674,18 +1900,23 @@ class Library:
|
||||
value=field.value,
|
||||
)
|
||||
|
||||
def merge_entries(self, from_entry: Entry, into_entry: Entry) -> None:
|
||||
def merge_entries(self, from_entry: Entry, into_entry: Entry) -> bool:
|
||||
"""Add fields and tags from the first entry to the second, and then delete the first."""
|
||||
success = True
|
||||
for field in from_entry.fields:
|
||||
self.add_field_to_entry(
|
||||
result = self.add_field_to_entry(
|
||||
entry_id=into_entry.id,
|
||||
field_id=field.type_key,
|
||||
value=field.value,
|
||||
)
|
||||
if not result:
|
||||
success = False
|
||||
tag_ids = [tag.id for tag in from_entry.tags]
|
||||
self.add_tags_to_entries(into_entry.id, tag_ids)
|
||||
self.remove_entries([from_entry.id])
|
||||
|
||||
return success
|
||||
|
||||
@property
|
||||
def tag_color_groups(self) -> dict[str, list[TagColorGroup]]:
|
||||
"""Return every TagColorGroup in the library."""
|
||||
@@ -1710,7 +1941,10 @@ class Library:
|
||||
session.expunge(en)
|
||||
|
||||
return dict(
|
||||
sorted(color_groups.items(), key=lambda kv: self.get_namespace_name(kv[0]).lower())
|
||||
sorted(
|
||||
color_groups.items(),
|
||||
key=lambda kv: self.get_namespace_name(kv[0]).lower(),
|
||||
)
|
||||
)
|
||||
|
||||
@property
|
||||
|
||||
@@ -4,9 +4,11 @@
|
||||
|
||||
from datetime import datetime as dt
|
||||
from pathlib import Path
|
||||
from typing import override
|
||||
|
||||
from sqlalchemy import JSON, ForeignKey, ForeignKeyConstraint, Integer, event
|
||||
from sqlalchemy.orm import Mapped, mapped_column, relationship
|
||||
from typing_extensions import deprecated
|
||||
|
||||
from tagstudio.core.constants import TAG_ARCHIVED, TAG_FAVORITE
|
||||
from tagstudio.core.library.alchemy.db import Base, PathType
|
||||
@@ -99,8 +101,8 @@ class Tag(Base):
|
||||
aliases: Mapped[set[TagAlias]] = relationship(back_populates="tag")
|
||||
parent_tags: Mapped[set["Tag"]] = relationship(
|
||||
secondary=TagParent.__tablename__,
|
||||
primaryjoin="Tag.id == TagParent.parent_id",
|
||||
secondaryjoin="Tag.id == TagParent.child_id",
|
||||
primaryjoin="Tag.id == TagParent.child_id",
|
||||
secondaryjoin="Tag.id == TagParent.parent_id",
|
||||
back_populates="parent_tags",
|
||||
)
|
||||
disambiguation_id: Mapped[int | None]
|
||||
@@ -126,8 +128,8 @@ class Tag(Base):
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
name: str,
|
||||
id: int | None = None,
|
||||
name: str | None = None,
|
||||
shorthand: str | None = None,
|
||||
aliases: set[TagAlias] | None = None,
|
||||
parent_tags: set["Tag"] | None = None,
|
||||
@@ -146,26 +148,31 @@ class Tag(Base):
|
||||
self.shorthand = shorthand
|
||||
self.disambiguation_id = disambiguation_id
|
||||
self.is_category = is_category
|
||||
assert not self.id
|
||||
self.id = id
|
||||
self.id = id # pyright: ignore[reportAttributeAccessIssue]
|
||||
super().__init__()
|
||||
|
||||
@override
|
||||
def __str__(self) -> str:
|
||||
return f"<Tag ID: {self.id} Name: {self.name}>"
|
||||
|
||||
@override
|
||||
def __repr__(self) -> str:
|
||||
return self.__str__()
|
||||
|
||||
def __lt__(self, other) -> bool:
|
||||
@override
|
||||
def __hash__(self) -> int:
|
||||
return hash(self.id)
|
||||
|
||||
def __lt__(self, other: "Tag") -> bool:
|
||||
return self.name < other.name
|
||||
|
||||
def __le__(self, other) -> bool:
|
||||
def __le__(self, other: "Tag") -> bool:
|
||||
return self.name <= other.name
|
||||
|
||||
def __gt__(self, other) -> bool:
|
||||
def __gt__(self, other: "Tag") -> bool:
|
||||
return self.name > other.name
|
||||
|
||||
def __ge__(self, other) -> bool:
|
||||
def __ge__(self, other: "Tag") -> bool:
|
||||
return self.name >= other.name
|
||||
|
||||
|
||||
@@ -230,9 +237,10 @@ class Entry(Base):
|
||||
date_modified: dt | None = None,
|
||||
date_added: dt | None = None,
|
||||
) -> None:
|
||||
super().__init__()
|
||||
self.path = path
|
||||
self.folder = folder
|
||||
self.id = id
|
||||
self.id = id # pyright: ignore[reportAttributeAccessIssue]
|
||||
self.filename = path.name
|
||||
self.suffix = path.suffix.lstrip(".").lower()
|
||||
|
||||
@@ -277,8 +285,8 @@ class ValueType(Base):
|
||||
key: Mapped[str] = mapped_column(primary_key=True)
|
||||
name: Mapped[str] = mapped_column(nullable=False)
|
||||
type: Mapped[FieldTypeEnum] = mapped_column(default=FieldTypeEnum.TEXT_LINE)
|
||||
is_default: Mapped[bool]
|
||||
position: Mapped[int]
|
||||
is_default: Mapped[bool] # pyright: ignore[reportUninitializedInstanceVariable]
|
||||
position: Mapped[int] # pyright: ignore[reportUninitializedInstanceVariable]
|
||||
|
||||
# add relations to other tables
|
||||
text_fields: Mapped[list[TextField]] = relationship("TextField", back_populates="type")
|
||||
@@ -303,7 +311,7 @@ class ValueType(Base):
|
||||
|
||||
|
||||
@event.listens_for(ValueType, "before_insert")
|
||||
def slugify_field_key(mapper, connection, target):
|
||||
def slugify_field_key(mapper, connection, target): # pyright: ignore
|
||||
"""Slugify the field key before inserting into the database."""
|
||||
if not target.key:
|
||||
from tagstudio.core.library.alchemy.library import slugify
|
||||
@@ -311,8 +319,18 @@ def slugify_field_key(mapper, connection, target):
|
||||
target.key = slugify(target.tag)
|
||||
|
||||
|
||||
# NOTE: The "Preferences" table has been depreciated as of TagStudio 9.5.4
|
||||
# and is set to be removed in a future release.
|
||||
@deprecated("Use `Version` for storing version, and `ts_ignore` system for file exclusion.")
|
||||
class Preferences(Base):
|
||||
__tablename__ = "preferences"
|
||||
|
||||
key: Mapped[str] = mapped_column(primary_key=True)
|
||||
value: Mapped[dict] = mapped_column(JSON, nullable=False)
|
||||
|
||||
|
||||
class Version(Base):
|
||||
__tablename__ = "versions"
|
||||
|
||||
key: Mapped[str] = mapped_column(primary_key=True)
|
||||
value: Mapped[int] = mapped_column(nullable=False, default=0)
|
||||
|
||||
@@ -12,7 +12,7 @@ logger = structlog.get_logger()
|
||||
|
||||
|
||||
@dataclass
|
||||
class DupeRegistry:
|
||||
class DupeFilesRegistry:
|
||||
"""State handler for DupeGuru results."""
|
||||
|
||||
library: Library
|
||||
@@ -0,0 +1,51 @@
|
||||
# Copyright (C) 2025
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from collections.abc import Iterator
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
|
||||
import structlog
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Entry
|
||||
from tagstudio.core.library.ignore import Ignore
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
@dataclass
|
||||
class IgnoredRegistry:
|
||||
"""State tracker for ignored entries."""
|
||||
|
||||
lib: Library
|
||||
ignored_entries: list[Entry] = field(default_factory=list)
|
||||
|
||||
@property
|
||||
def ignored_count(self) -> int:
|
||||
return len(self.ignored_entries)
|
||||
|
||||
def reset(self):
|
||||
self.ignored_entries.clear()
|
||||
|
||||
def refresh_ignored_entries(self) -> Iterator[int]:
|
||||
"""Track the number of entries that would otherwise be ignored by the current rules."""
|
||||
logger.info("[IgnoredRegistry] Refreshing ignored entries...")
|
||||
|
||||
self.ignored_entries = []
|
||||
library_dir: Path = unwrap(self.lib.library_dir)
|
||||
|
||||
for i, entry in enumerate(self.lib.all_entries()):
|
||||
if not Ignore.compiled_patterns:
|
||||
# If the compiled_patterns has malfunctioned, don't consider that a false positive
|
||||
yield i
|
||||
elif Ignore.compiled_patterns.match(library_dir / entry.path):
|
||||
self.ignored_entries.append(entry)
|
||||
yield i
|
||||
|
||||
def remove_ignored_entries(self) -> None:
|
||||
self.lib.remove_entries(list(map(lambda ignored: ignored.id, self.ignored_entries)))
|
||||
self.ignored_entries = []
|
||||
@@ -0,0 +1,93 @@
|
||||
from collections.abc import Iterator
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
|
||||
import structlog
|
||||
from wcmatch import pathlib
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Entry
|
||||
from tagstudio.core.library.ignore import PATH_GLOB_FLAGS, Ignore
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
|
||||
logger = structlog.get_logger()
|
||||
|
||||
|
||||
@dataclass
|
||||
class UnlinkedRegistry:
|
||||
"""State tracker for unlinked entries."""
|
||||
|
||||
lib: Library
|
||||
files_fixed_count: int = 0
|
||||
unlinked_entries: list[Entry] = field(default_factory=list)
|
||||
|
||||
@property
|
||||
def unlinked_entries_count(self) -> int:
|
||||
return len(self.unlinked_entries)
|
||||
|
||||
def reset(self):
|
||||
self.unlinked_entries.clear()
|
||||
|
||||
def refresh_unlinked_files(self) -> Iterator[int]:
|
||||
"""Track the number of entries that point to an invalid filepath."""
|
||||
logger.info("[UnlinkedRegistry] Refreshing unlinked files...")
|
||||
|
||||
self.unlinked_entries = []
|
||||
for i, entry in enumerate(self.lib.all_entries()):
|
||||
full_path = unwrap(self.lib.library_dir) / entry.path
|
||||
if not full_path.exists() or not full_path.is_file():
|
||||
self.unlinked_entries.append(entry)
|
||||
yield i
|
||||
|
||||
def match_unlinked_file_entry(self, match_entry: Entry) -> list[Path]:
|
||||
"""Try and match unlinked file entries with matching results in the library directory.
|
||||
|
||||
Works if files were just moved to different subfolders and don't have duplicate names.
|
||||
"""
|
||||
library_dir = unwrap(self.lib.library_dir)
|
||||
matches: list[Path] = []
|
||||
|
||||
ignore_patterns = Ignore.get_patterns(library_dir)
|
||||
for path in pathlib.Path(str(library_dir)).glob(
|
||||
f"***/{match_entry.path.name}",
|
||||
flags=PATH_GLOB_FLAGS,
|
||||
exclude=ignore_patterns,
|
||||
):
|
||||
if path.is_dir():
|
||||
continue
|
||||
if path.name == match_entry.path.name:
|
||||
new_path = Path(path).relative_to(library_dir)
|
||||
matches.append(new_path)
|
||||
|
||||
logger.info("[UnlinkedRegistry] Matches", matches=matches)
|
||||
return matches
|
||||
|
||||
def fix_unlinked_entries(self) -> Iterator[int]:
|
||||
"""Attempt to fix unlinked file entries by finding a match in the library directory."""
|
||||
self.files_fixed_count = 0
|
||||
matched_entries: list[Entry] = []
|
||||
for i, entry in enumerate(self.unlinked_entries):
|
||||
item_matches = self.match_unlinked_file_entry(entry)
|
||||
if len(item_matches) == 1:
|
||||
logger.info(
|
||||
"[UnlinkedRegistry]",
|
||||
entry=entry.path.as_posix(),
|
||||
item_matches=item_matches[0].as_posix(),
|
||||
)
|
||||
if not self.lib.update_entry_path(entry.id, item_matches[0]):
|
||||
try:
|
||||
match = unwrap(self.lib.get_entry_full_by_path(item_matches[0]))
|
||||
entry_full = unwrap(self.lib.get_entry_full(entry.id))
|
||||
self.lib.merge_entries(entry_full, match)
|
||||
except AttributeError:
|
||||
continue
|
||||
self.files_fixed_count += 1
|
||||
matched_entries.append(entry)
|
||||
yield i
|
||||
|
||||
for entry in matched_entries:
|
||||
self.unlinked_entries.remove(entry)
|
||||
|
||||
def remove_unlinked_entries(self) -> None:
|
||||
self.lib.remove_entries(list(map(lambda unlinked: unlinked.id, self.unlinked_entries)))
|
||||
self.unlinked_entries = []
|
||||
@@ -3,17 +3,19 @@
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
import re
|
||||
from typing import TYPE_CHECKING
|
||||
from typing import TYPE_CHECKING, override
|
||||
|
||||
import structlog
|
||||
from sqlalchemy import ColumnElement, and_, distinct, func, or_, select, text
|
||||
from sqlalchemy import ColumnElement, and_, distinct, func, or_, select
|
||||
from sqlalchemy.orm import Session
|
||||
from sqlalchemy.sql.operators import ilike_op
|
||||
|
||||
from tagstudio.core.library.alchemy.constants import TAG_CHILDREN_ID_QUERY
|
||||
from tagstudio.core.library.alchemy.joins import TagEntry
|
||||
from tagstudio.core.library.alchemy.models import Entry, Tag, TagAlias
|
||||
from tagstudio.core.media_types import FILETYPE_EQUIVALENTS, MediaCategories
|
||||
from tagstudio.core.query_lang.ast import (
|
||||
AST,
|
||||
ANDList,
|
||||
BaseVisitor,
|
||||
Constraint,
|
||||
@@ -31,19 +33,6 @@ else:
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
# TODO: Reevaluate after subtags -> parent tags name change
|
||||
TAG_CHILDREN_ID_QUERY = text("""
|
||||
-- Note for this entire query that tag_parents.child_id is the parent id and tag_parents.parent_id is the child id due to bad naming
|
||||
WITH RECURSIVE ChildTags AS (
|
||||
SELECT :tag_id AS child_id
|
||||
UNION
|
||||
SELECT tp.parent_id AS child_id
|
||||
FROM tag_parents tp
|
||||
INNER JOIN ChildTags c ON tp.child_id = c.child_id
|
||||
)
|
||||
SELECT child_id FROM ChildTags;
|
||||
""") # noqa: E501
|
||||
|
||||
|
||||
def get_filetype_equivalency_list(item: str) -> list[str] | set[str]:
|
||||
for s in FILETYPE_EQUIVALENTS:
|
||||
@@ -57,54 +46,30 @@ class SQLBoolExpressionBuilder(BaseVisitor[ColumnElement[bool]]):
|
||||
super().__init__()
|
||||
self.lib = lib
|
||||
|
||||
def visit_or_list(self, node: ORList) -> ColumnElement[bool]:
|
||||
return or_(*[self.visit(element) for element in node.elements])
|
||||
@override
|
||||
def visit_or_list(self, node: ORList) -> ColumnElement[bool]: # type: ignore
|
||||
tag_ids, bool_expressions = self.__separate_tags(node.elements, only_single=False)
|
||||
if len(tag_ids) > 0:
|
||||
bool_expressions.append(self.__entry_has_any_tags(tag_ids))
|
||||
return or_(*bool_expressions)
|
||||
|
||||
def visit_and_list(self, node: ANDList) -> ColumnElement[bool]:
|
||||
tag_ids: list[int] = []
|
||||
bool_expressions: list[ColumnElement[bool]] = []
|
||||
|
||||
# Search for TagID / unambiguous Tag Constraints and store the respective tag ids separately
|
||||
for term in node.terms:
|
||||
if isinstance(term, Constraint) and len(term.properties) == 0:
|
||||
match term.type:
|
||||
case ConstraintType.TagID:
|
||||
try:
|
||||
tag_ids.append(int(term.value))
|
||||
except ValueError:
|
||||
logger.error(
|
||||
"[SQLBoolExpressionBuilder] Could not cast value to an int Tag ID",
|
||||
value=term.value,
|
||||
)
|
||||
continue
|
||||
case ConstraintType.Tag:
|
||||
if len(ids := self.__get_tag_ids(term.value)) == 1:
|
||||
tag_ids.append(ids[0])
|
||||
continue
|
||||
|
||||
bool_expressions.append(self.visit(term))
|
||||
|
||||
# If there are at least two tag ids use a relational division query
|
||||
# to efficiently check all of them
|
||||
if len(tag_ids) > 1:
|
||||
@override
|
||||
def visit_and_list(self, node: ANDList) -> ColumnElement[bool]: # type: ignore
|
||||
tag_ids, bool_expressions = self.__separate_tags(node.terms, only_single=True)
|
||||
if len(tag_ids) > 0:
|
||||
bool_expressions.append(self.__entry_has_all_tags(tag_ids))
|
||||
# If there is just one tag id, check the normal way
|
||||
elif len(tag_ids) == 1:
|
||||
bool_expressions.append(
|
||||
self.__entry_satisfies_expression(TagEntry.tag_id == tag_ids[0])
|
||||
)
|
||||
|
||||
return and_(*bool_expressions)
|
||||
|
||||
def visit_constraint(self, node: Constraint) -> ColumnElement[bool]:
|
||||
@override
|
||||
def visit_constraint(self, node: Constraint) -> ColumnElement[bool]: # type: ignore
|
||||
"""Returns a Boolean Expression that is true, if the Entry satisfies the constraint."""
|
||||
if len(node.properties) != 0:
|
||||
raise NotImplementedError("Properties are not implemented yet") # TODO TSQLANG
|
||||
|
||||
if node.type == ConstraintType.Tag:
|
||||
return self.__entry_matches_tag_ids(self.__get_tag_ids(node.value))
|
||||
return self.__entry_has_any_tags(self.__get_tag_ids(node.value))
|
||||
elif node.type == ConstraintType.TagID:
|
||||
return self.__entry_matches_tag_ids([int(node.value)])
|
||||
return self.__entry_has_any_tags([int(node.value)])
|
||||
elif node.type == ConstraintType.Path:
|
||||
ilike = False
|
||||
glob = False
|
||||
@@ -147,21 +112,14 @@ class SQLBoolExpressionBuilder(BaseVisitor[ColumnElement[bool]]):
|
||||
# raise exception if Constraint stays unhandled
|
||||
raise NotImplementedError("This type of constraint is not implemented yet")
|
||||
|
||||
def visit_property(self, node: Property) -> ColumnElement[bool]:
|
||||
@override
|
||||
def visit_property(self, node: Property) -> ColumnElement[bool]: # type: ignore
|
||||
raise NotImplementedError("This should never be reached!")
|
||||
|
||||
def visit_not(self, node: Not) -> ColumnElement[bool]:
|
||||
@override
|
||||
def visit_not(self, node: Not) -> ColumnElement[bool]: # type: ignore
|
||||
return ~self.visit(node.child)
|
||||
|
||||
def __entry_matches_tag_ids(self, tag_ids: list[int]) -> ColumnElement[bool]:
|
||||
"""Returns a boolean expression that is true if the entry has at least one of the supplied tags.""" # noqa: E501
|
||||
return (
|
||||
select(1)
|
||||
.correlate(Entry)
|
||||
.where(and_(TagEntry.entry_id == Entry.id, TagEntry.tag_id.in_(tag_ids)))
|
||||
.exists()
|
||||
)
|
||||
|
||||
def __get_tag_ids(self, tag_name: str, include_children: bool = True) -> list[int]:
|
||||
"""Given a tag name find the ids of all tags that this name could refer to."""
|
||||
with Session(self.lib.engine) as session:
|
||||
@@ -180,11 +138,49 @@ class SQLBoolExpressionBuilder(BaseVisitor[ColumnElement[bool]]):
|
||||
)
|
||||
if not include_children:
|
||||
return tag_ids
|
||||
outp = []
|
||||
outp: list[int] = []
|
||||
for tag_id in tag_ids:
|
||||
outp.extend(list(session.scalars(TAG_CHILDREN_ID_QUERY, {"tag_id": tag_id})))
|
||||
return outp
|
||||
|
||||
def __separate_tags(
|
||||
self, terms: list[AST], only_single: bool = True
|
||||
) -> tuple[list[int], list[ColumnElement[bool]]]:
|
||||
tag_ids: list[int] = []
|
||||
bool_expressions: list[ColumnElement[bool]] = []
|
||||
|
||||
for term in terms:
|
||||
if isinstance(term, Constraint) and len(term.properties) == 0:
|
||||
match term.type:
|
||||
case ConstraintType.TagID:
|
||||
try:
|
||||
tag_ids.append(int(term.value))
|
||||
except ValueError:
|
||||
logger.error(
|
||||
"[SQLBoolExpressionBuilder] Could not cast value to an int Tag ID",
|
||||
value=term.value,
|
||||
)
|
||||
continue
|
||||
case ConstraintType.Tag:
|
||||
ids = self.__get_tag_ids(term.value)
|
||||
if not only_single:
|
||||
tag_ids.extend(ids)
|
||||
continue
|
||||
elif len(ids) == 1:
|
||||
tag_ids.append(ids[0])
|
||||
continue
|
||||
case ConstraintType.FileType:
|
||||
pass
|
||||
case ConstraintType.Path:
|
||||
pass
|
||||
case ConstraintType.Special:
|
||||
pass
|
||||
case _:
|
||||
raise NotImplementedError(f"Unhandled constraint: '{term.type}'")
|
||||
|
||||
bool_expressions.append(self.visit(term))
|
||||
return tag_ids, bool_expressions
|
||||
|
||||
def __entry_has_all_tags(self, tag_ids: list[int]) -> ColumnElement[bool]:
|
||||
"""Returns Binary Expression that is true if the Entry has all provided tag ids."""
|
||||
# Relational Division Query
|
||||
@@ -195,9 +191,8 @@ class SQLBoolExpressionBuilder(BaseVisitor[ColumnElement[bool]]):
|
||||
.having(func.count(distinct(TagEntry.tag_id)) == len(tag_ids))
|
||||
)
|
||||
|
||||
def __entry_satisfies_expression(self, expr: ColumnElement[bool]) -> ColumnElement[bool]:
|
||||
"""Returns Binary Expression that is true if the Entry satisfies the column expression.
|
||||
|
||||
Executed on: Entry ⟕ TagEntry (Entry LEFT OUTER JOIN TagEntry).
|
||||
"""
|
||||
return Entry.id.in_(select(Entry.id).outerjoin(TagEntry).where(expr))
|
||||
def __entry_has_any_tags(self, tag_ids: list[int]) -> ColumnElement[bool]:
|
||||
"""Returns Binary Expression that is true if the Entry has any of the provided tag ids."""
|
||||
return Entry.id.in_(
|
||||
select(TagEntry.entry_id).where(TagEntry.tag_id.in_(tag_ids)).distinct()
|
||||
)
|
||||
|
||||
200
src/tagstudio/core/library/ignore.py
Normal file
200
src/tagstudio/core/library/ignore.py
Normal file
@@ -0,0 +1,200 @@
|
||||
# Copyright (C) 2025 Travis Abendshien (CyanVoxel).
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
from copy import deepcopy
|
||||
from pathlib import Path
|
||||
|
||||
import structlog
|
||||
import wcmatch.fnmatch as fnmatch
|
||||
from wcmatch import glob, pathlib
|
||||
|
||||
from tagstudio.core.constants import IGNORE_NAME, TS_FOLDER_NAME
|
||||
from tagstudio.core.utils.singleton import Singleton
|
||||
|
||||
logger = structlog.get_logger()
|
||||
|
||||
PATH_GLOB_FLAGS = glob.GLOBSTARLONG | glob.DOTGLOB | glob.NEGATE | pathlib.MATCHBASE
|
||||
|
||||
|
||||
GLOBAL_IGNORE = [
|
||||
# TagStudio -------------------
|
||||
f"{TS_FOLDER_NAME}",
|
||||
# Trash -----------------------
|
||||
".Trash-*",
|
||||
".Trash",
|
||||
".Trashes",
|
||||
"$RECYCLE.BIN",
|
||||
# System ----------------------
|
||||
"._*",
|
||||
".DS_Store",
|
||||
".fseventsd",
|
||||
".Spotlight-V100",
|
||||
".TemporaryItems",
|
||||
"desktop.ini",
|
||||
"System Volume Information",
|
||||
".localized",
|
||||
]
|
||||
|
||||
|
||||
def ignore_to_glob(ignore_patterns: list[str]) -> list[str]:
|
||||
"""Convert .gitignore-like patterns to explicit glob syntax.
|
||||
|
||||
Args:
|
||||
ignore_patterns (list[str]): The .gitignore-like patterns to convert.
|
||||
"""
|
||||
glob_patterns: list[str] = deepcopy(ignore_patterns)
|
||||
glob_patterns_remove: list[str] = []
|
||||
additional_patterns: list[str] = []
|
||||
root_patterns: list[str] = []
|
||||
|
||||
# Mimic implicit .gitignore syntax behavior for the SQLite GLOB function.
|
||||
for pattern in glob_patterns:
|
||||
# Temporarily remove any exclusion character before processing
|
||||
exclusion_char = ""
|
||||
gp = pattern
|
||||
if pattern.startswith("!"):
|
||||
gp = pattern[1:]
|
||||
exclusion_char = "!"
|
||||
|
||||
if not gp.startswith("**/") and not gp.startswith("*/") and not gp.startswith("/"):
|
||||
# Create a version of a prefix-less pattern that starts with "**/"
|
||||
gp = "**/" + gp
|
||||
additional_patterns.append(exclusion_char + gp)
|
||||
|
||||
gp = gp.removesuffix("/**").removesuffix("/*").removesuffix("/")
|
||||
additional_patterns.append(exclusion_char + gp)
|
||||
|
||||
gp = gp.removeprefix("**/").removeprefix("*/")
|
||||
additional_patterns.append(exclusion_char + gp)
|
||||
|
||||
elif gp.startswith("/"):
|
||||
# Matches "/file" case for .gitignore behavior where it should only match
|
||||
# a file or folder int the root directory, and nowhere else.
|
||||
glob_patterns_remove.append(gp)
|
||||
gp = gp.lstrip("/")
|
||||
root_patterns.append(exclusion_char + gp)
|
||||
|
||||
for gp in glob_patterns_remove:
|
||||
glob_patterns.remove(gp)
|
||||
|
||||
glob_patterns = glob_patterns + additional_patterns
|
||||
|
||||
# Add "/**" suffix to suffix-less patterns to match implicit .gitignore behavior.
|
||||
for pattern in glob_patterns:
|
||||
if pattern.endswith("/**"):
|
||||
continue
|
||||
|
||||
glob_patterns.append(pattern.removesuffix("/*").removesuffix("/") + "/**")
|
||||
|
||||
glob_patterns = glob_patterns + root_patterns
|
||||
glob_patterns = list(set(glob_patterns))
|
||||
|
||||
logger.info("[Ignore]", glob_patterns=glob_patterns)
|
||||
return glob_patterns
|
||||
|
||||
|
||||
class Ignore(metaclass=Singleton):
|
||||
"""Class for processing and managing glob-like file ignore file patterns."""
|
||||
|
||||
_last_loaded: tuple[Path, float] | None = None
|
||||
_patterns: list[str] = []
|
||||
compiled_patterns: fnmatch.WcMatcher | None = None
|
||||
|
||||
@staticmethod
|
||||
def read_ignore_file(library_dir: Path) -> list[str]:
|
||||
"""Get the entire raw '.ts_ignore' file contents as a list of strings."""
|
||||
ts_ignore_path = Path(library_dir / TS_FOLDER_NAME / IGNORE_NAME)
|
||||
|
||||
if not ts_ignore_path.exists():
|
||||
logger.info(
|
||||
"[Ignore] No .ts_ignore file found",
|
||||
path=ts_ignore_path,
|
||||
)
|
||||
|
||||
return []
|
||||
|
||||
with open(ts_ignore_path, encoding="utf8") as f:
|
||||
return f.readlines()
|
||||
|
||||
@staticmethod
|
||||
def write_ignore_file(library_dir: Path, lines: list[str]) -> None:
|
||||
"""Write to the '.ts_ignore' file."""
|
||||
ts_ignore_path = Path(library_dir / TS_FOLDER_NAME / IGNORE_NAME)
|
||||
|
||||
if not ts_ignore_path.exists():
|
||||
logger.info(
|
||||
"[Ignore] No .ts_ignore file found",
|
||||
path=ts_ignore_path,
|
||||
)
|
||||
|
||||
return
|
||||
|
||||
with open(ts_ignore_path, "w", encoding="utf8") as f:
|
||||
f.writelines(lines)
|
||||
|
||||
@staticmethod
|
||||
def get_patterns(library_dir: Path, include_global: bool = True) -> list[str]:
|
||||
"""Get the ignore patterns for the given library directory.
|
||||
|
||||
Args:
|
||||
library_dir (Path): The path of the library to load patterns from.
|
||||
include_global (bool): Flag for including the global ignore set.
|
||||
In most scenarios, this should be True.
|
||||
"""
|
||||
patterns = GLOBAL_IGNORE if include_global else []
|
||||
ts_ignore_path = Path(library_dir / TS_FOLDER_NAME / IGNORE_NAME)
|
||||
|
||||
if not ts_ignore_path.exists():
|
||||
logger.info(
|
||||
"[Ignore] No .ts_ignore file found",
|
||||
path=ts_ignore_path,
|
||||
)
|
||||
Ignore._last_loaded = None
|
||||
Ignore._patterns = patterns
|
||||
|
||||
return Ignore._patterns
|
||||
|
||||
# Process the .ts_ignore file if the previous result is non-existent or outdated.
|
||||
loaded = (ts_ignore_path, ts_ignore_path.stat().st_mtime)
|
||||
if not Ignore._last_loaded or (Ignore._last_loaded and Ignore._last_loaded != loaded):
|
||||
logger.info(
|
||||
"[Ignore] Processing the .ts_ignore file...",
|
||||
library=library_dir,
|
||||
last_mtime=Ignore._last_loaded[1] if Ignore._last_loaded else None,
|
||||
new_mtime=loaded[1],
|
||||
)
|
||||
Ignore._patterns = patterns + Ignore._load_ignore_file(ts_ignore_path)
|
||||
Ignore.compiled_patterns = fnmatch.compile(
|
||||
ignore_to_glob(Ignore._patterns),
|
||||
PATH_GLOB_FLAGS,
|
||||
)
|
||||
else:
|
||||
logger.info(
|
||||
"[Ignore] No updates to the .ts_ignore detected",
|
||||
library=library_dir,
|
||||
last_mtime=Ignore._last_loaded[1],
|
||||
new_mtime=loaded[1],
|
||||
)
|
||||
Ignore._last_loaded = loaded
|
||||
|
||||
return Ignore._patterns
|
||||
|
||||
@staticmethod
|
||||
def _load_ignore_file(path: Path) -> list[str]:
|
||||
"""Load and process the .ts_ignore file into a list of glob patterns.
|
||||
|
||||
Args:
|
||||
path (Path): The path of the .ts_ignore file.
|
||||
"""
|
||||
patterns: list[str] = []
|
||||
if path.exists():
|
||||
with open(path, encoding="utf8") as f:
|
||||
for line_raw in f.readlines():
|
||||
line = line_raw.strip()
|
||||
# Ignore blank lines and comments
|
||||
if not line or line.startswith("#"):
|
||||
continue
|
||||
patterns.append(line)
|
||||
|
||||
return patterns
|
||||
@@ -27,8 +27,7 @@ from tagstudio.core.constants import (
|
||||
)
|
||||
from tagstudio.core.enums import OpenStatus
|
||||
from tagstudio.core.library.json.fields import DEFAULT_FIELDS, TEXT_FIELDS
|
||||
from tagstudio.core.utils.str import strip_punctuation
|
||||
from tagstudio.core.utils.web import strip_web_protocol
|
||||
from tagstudio.core.utils.str_formatting import strip_punctuation, strip_web_protocol
|
||||
|
||||
TYPE = ["file", "meta", "alt", "mask"]
|
||||
|
||||
|
||||
202
src/tagstudio/core/library/refresh.py
Normal file
202
src/tagstudio/core/library/refresh.py
Normal file
@@ -0,0 +1,202 @@
|
||||
# Copyright (C) 2025
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
import shutil
|
||||
from collections.abc import Iterator
|
||||
from dataclasses import dataclass, field
|
||||
from datetime import datetime as dt
|
||||
from pathlib import Path
|
||||
from time import time
|
||||
|
||||
import structlog
|
||||
from wcmatch import pathlib
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Entry
|
||||
from tagstudio.core.library.ignore import PATH_GLOB_FLAGS, Ignore, ignore_to_glob
|
||||
from tagstudio.core.utils.silent_subprocess import silent_run # pyright: ignore
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
@dataclass
|
||||
class RefreshTracker:
|
||||
library: Library
|
||||
files_not_in_library: list[Path] = field(default_factory=list)
|
||||
|
||||
@property
|
||||
def files_count(self) -> int:
|
||||
return len(self.files_not_in_library)
|
||||
|
||||
def save_new_files(self):
|
||||
"""Save the list of files that are not in the library."""
|
||||
if self.files_not_in_library:
|
||||
entries = [
|
||||
Entry(
|
||||
path=entry_path,
|
||||
folder=self.library.folder, # pyright: ignore[reportArgumentType]
|
||||
fields=[],
|
||||
date_added=dt.now(),
|
||||
)
|
||||
for entry_path in self.files_not_in_library
|
||||
]
|
||||
self.library.add_entries(entries)
|
||||
|
||||
self.files_not_in_library = []
|
||||
|
||||
yield
|
||||
|
||||
def refresh_dir(self, library_dir: Path, force_internal_tools: bool = False) -> Iterator[int]:
|
||||
"""Scan a directory for files, and add those relative filenames to internal variables.
|
||||
|
||||
Args:
|
||||
library_dir (Path): The library directory.
|
||||
force_internal_tools (bool): Option to force the use of internal tools for scanning
|
||||
(i.e. wcmatch) instead of using tools found on the system (i.e. ripgrep).
|
||||
"""
|
||||
if self.library.library_dir is None:
|
||||
raise ValueError("No library directory set.")
|
||||
|
||||
ignore_patterns = Ignore.get_patterns(library_dir)
|
||||
|
||||
if force_internal_tools:
|
||||
return self.__wc_add(library_dir, ignore_to_glob(ignore_patterns))
|
||||
|
||||
dir_list: list[str] | None = self.__get_dir_list(library_dir, ignore_patterns)
|
||||
|
||||
# Use ripgrep if it was found and working, else fallback to wcmatch.
|
||||
if dir_list is not None:
|
||||
return self.__rg_add(library_dir, dir_list)
|
||||
else:
|
||||
return self.__wc_add(library_dir, ignore_to_glob(ignore_patterns))
|
||||
|
||||
def __get_dir_list(self, library_dir: Path, ignore_patterns: list[str]) -> list[str] | None:
|
||||
"""Use ripgrep to return a list of matched directories and files.
|
||||
|
||||
Return `None` if ripgrep not found on system.
|
||||
"""
|
||||
rg_path = shutil.which("rg")
|
||||
# Use ripgrep if found on system
|
||||
if rg_path is not None:
|
||||
logger.info("[Refresh: Using ripgrep for scanning]")
|
||||
|
||||
compiled_ignore_path = library_dir / ".TagStudio" / ".compiled_ignore"
|
||||
|
||||
# Write compiled ignore patterns (built-in + user) to a temp file to pass to ripgrep
|
||||
with open(compiled_ignore_path, "w") as pattern_file:
|
||||
pattern_file.write("\n".join(ignore_patterns))
|
||||
|
||||
result = silent_run(
|
||||
" ".join(
|
||||
[
|
||||
"rg",
|
||||
"--files",
|
||||
"--follow",
|
||||
"--hidden",
|
||||
"--ignore-file",
|
||||
f'"{str(compiled_ignore_path)}"',
|
||||
]
|
||||
),
|
||||
cwd=library_dir,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
shell=True,
|
||||
)
|
||||
compiled_ignore_path.unlink()
|
||||
|
||||
if result.stderr:
|
||||
logger.error(result.stderr)
|
||||
|
||||
return result.stdout.splitlines() # pyright: ignore [reportReturnType]
|
||||
|
||||
logger.warning("[Refresh: ripgrep not found on system]")
|
||||
return None
|
||||
|
||||
def __rg_add(self, library_dir: Path, dir_list: list[str]) -> Iterator[int]:
|
||||
start_time_total = time()
|
||||
start_time_loop = time()
|
||||
dir_file_count = 0
|
||||
self.files_not_in_library = []
|
||||
|
||||
for r in dir_list:
|
||||
f = pathlib.Path(r)
|
||||
|
||||
end_time_loop = time()
|
||||
# Yield output every 1/30 of a second
|
||||
if (end_time_loop - start_time_loop) > 0.034:
|
||||
yield dir_file_count
|
||||
start_time_loop = time()
|
||||
|
||||
# Skip if the file/path is already mapped in the Library
|
||||
if f in self.library.included_files:
|
||||
dir_file_count += 1
|
||||
continue
|
||||
|
||||
# Ignore if the file is a directory
|
||||
if f.is_dir():
|
||||
continue
|
||||
|
||||
dir_file_count += 1
|
||||
self.library.included_files.add(f)
|
||||
|
||||
if not self.library.has_path_entry(f):
|
||||
self.files_not_in_library.append(f)
|
||||
|
||||
end_time_total = time()
|
||||
yield dir_file_count
|
||||
logger.info(
|
||||
"[Refresh]: Directory scan time",
|
||||
path=library_dir,
|
||||
duration=(end_time_total - start_time_total),
|
||||
files_scanned=dir_file_count,
|
||||
tool_used="ripgrep (system)",
|
||||
)
|
||||
|
||||
def __wc_add(self, library_dir: Path, ignore_patterns: list[str]) -> Iterator[int]:
|
||||
start_time_total = time()
|
||||
start_time_loop = time()
|
||||
dir_file_count = 0
|
||||
self.files_not_in_library = []
|
||||
|
||||
logger.info("[Refresh]: Falling back to wcmatch for scanning")
|
||||
|
||||
try:
|
||||
for f in pathlib.Path(str(library_dir)).glob(
|
||||
"***/*", flags=PATH_GLOB_FLAGS, exclude=ignore_patterns
|
||||
):
|
||||
end_time_loop = time()
|
||||
# Yield output every 1/30 of a second
|
||||
if (end_time_loop - start_time_loop) > 0.034:
|
||||
yield dir_file_count
|
||||
start_time_loop = time()
|
||||
|
||||
# Skip if the file/path is already mapped in the Library
|
||||
if f in self.library.included_files:
|
||||
dir_file_count += 1
|
||||
continue
|
||||
|
||||
# Ignore if the file is a directory
|
||||
if f.is_dir():
|
||||
continue
|
||||
|
||||
dir_file_count += 1
|
||||
self.library.included_files.add(f)
|
||||
|
||||
relative_path = f.relative_to(library_dir)
|
||||
|
||||
if not self.library.has_path_entry(relative_path):
|
||||
self.files_not_in_library.append(relative_path)
|
||||
except ValueError:
|
||||
logger.info("[Refresh]: ValueError when refreshing directory with wcmatch!")
|
||||
|
||||
end_time_total = time()
|
||||
yield dir_file_count
|
||||
logger.info(
|
||||
"[Refresh]: Directory scan time",
|
||||
path=library_dir,
|
||||
duration=(end_time_total - start_time_total),
|
||||
files_scanned=dir_file_count,
|
||||
tool_used="wcmatch (internal)",
|
||||
)
|
||||
@@ -129,6 +129,7 @@ class MediaCategories:
|
||||
".aifc",
|
||||
".aiff",
|
||||
".alac",
|
||||
".caf",
|
||||
".flac",
|
||||
".m4a",
|
||||
".m4p",
|
||||
@@ -242,7 +243,7 @@ class MediaCategories:
|
||||
".sqlite",
|
||||
".sqlite3",
|
||||
}
|
||||
_DISK_IMAGE_SET: set[str] = {".bios", ".dmg", ".iso"}
|
||||
_DISK_IMAGE_SET: set[str] = {".bios", ".dmg", ".fhdx", ".iso"}
|
||||
_DOCUMENT_SET: set[str] = {
|
||||
".doc",
|
||||
".docm",
|
||||
@@ -297,10 +298,13 @@ class MediaCategories:
|
||||
".crw",
|
||||
".dng",
|
||||
".nef",
|
||||
".nrw",
|
||||
".orf",
|
||||
".raf",
|
||||
".raw",
|
||||
".rw2",
|
||||
".srf",
|
||||
".srf2",
|
||||
}
|
||||
_IMAGE_VECTOR_SET: set[str] = {".eps", ".epsf", ".epsi", ".svg", ".svgz"}
|
||||
_IMAGE_RASTER_SET: set[str] = {
|
||||
@@ -365,6 +369,7 @@ class MediaCategories:
|
||||
".md",
|
||||
".mkd",
|
||||
".rmd",
|
||||
".text",
|
||||
".txt",
|
||||
"contributing",
|
||||
"license",
|
||||
@@ -408,6 +413,7 @@ class MediaCategories:
|
||||
".mp4",
|
||||
".webm",
|
||||
".wmv",
|
||||
".ts",
|
||||
}
|
||||
|
||||
ADOBE_PHOTOSHOP_TYPES = MediaCategory(
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
# Copyright (C) 2025
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from abc import ABC, abstractmethod
|
||||
from enum import Enum
|
||||
from typing import Generic, TypeVar, Union
|
||||
from typing import Generic, TypeVar, override
|
||||
|
||||
|
||||
class ConstraintType(Enum):
|
||||
@@ -12,7 +17,7 @@ class ConstraintType(Enum):
|
||||
Special = 5
|
||||
|
||||
@staticmethod
|
||||
def from_string(text: str) -> Union["ConstraintType", None]:
|
||||
def from_string(text: str) -> "ConstraintType | None":
|
||||
return {
|
||||
"tag": ConstraintType.Tag,
|
||||
"tag_id": ConstraintType.TagID,
|
||||
@@ -24,14 +29,16 @@ class ConstraintType(Enum):
|
||||
|
||||
|
||||
class AST:
|
||||
parent: Union["AST", None] = None
|
||||
parent: "AST | None" = None
|
||||
|
||||
@override
|
||||
def __str__(self):
|
||||
class_name = self.__class__.__name__
|
||||
fields = vars(self) # Get all instance variables as a dictionary
|
||||
field_str = ", ".join(f"{key}={value}" for key, value in fields.items())
|
||||
return f"{class_name}({field_str})"
|
||||
|
||||
@override
|
||||
def __repr__(self) -> str:
|
||||
return self.__str__()
|
||||
|
||||
|
||||
@@ -1,3 +1,8 @@
|
||||
# Copyright (C) 2025
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from tagstudio.core.query_lang.ast import (
|
||||
AST,
|
||||
ANDList,
|
||||
@@ -27,7 +32,7 @@ class Parser:
|
||||
if self.next_token.type == TokenType.EOF:
|
||||
return ORList([])
|
||||
out = self.__or_list()
|
||||
if self.next_token.type != TokenType.EOF:
|
||||
if self.next_token.type != TokenType.EOF: # pyright: ignore[reportUnnecessaryComparison]
|
||||
raise ParsingError(self.next_token.start, self.next_token.end, "Syntax Error")
|
||||
return out
|
||||
|
||||
@@ -41,7 +46,7 @@ class Parser:
|
||||
return ORList(terms) if len(terms) > 1 else terms[0]
|
||||
|
||||
def __is_next_or(self) -> bool:
|
||||
return self.next_token.type == TokenType.ULITERAL and self.next_token.value.upper() == "OR"
|
||||
return self.next_token.type == TokenType.ULITERAL and self.next_token.value.upper() == "OR" # pyright: ignore
|
||||
|
||||
def __and_list(self) -> AST:
|
||||
elements = [self.__term()]
|
||||
@@ -67,7 +72,7 @@ class Parser:
|
||||
raise self.__syntax_error("Unexpected AND")
|
||||
|
||||
def __is_next_and(self) -> bool:
|
||||
return self.next_token.type == TokenType.ULITERAL and self.next_token.value.upper() == "AND"
|
||||
return self.next_token.type == TokenType.ULITERAL and self.next_token.value.upper() == "AND" # pyright: ignore
|
||||
|
||||
def __term(self) -> AST:
|
||||
if self.__is_next_not():
|
||||
@@ -85,11 +90,14 @@ class Parser:
|
||||
return self.__constraint()
|
||||
|
||||
def __is_next_not(self) -> bool:
|
||||
return self.next_token.type == TokenType.ULITERAL and self.next_token.value.upper() == "NOT"
|
||||
return self.next_token.type == TokenType.ULITERAL and self.next_token.value.upper() == "NOT" # pyright: ignore
|
||||
|
||||
def __constraint(self) -> Constraint:
|
||||
if self.next_token.type == TokenType.CONSTRAINTTYPE:
|
||||
self.last_constraint_type = self.__eat(TokenType.CONSTRAINTTYPE).value
|
||||
constraint = self.__eat(TokenType.CONSTRAINTTYPE).value
|
||||
if not isinstance(constraint, ConstraintType):
|
||||
raise self.__syntax_error()
|
||||
self.last_constraint_type = constraint
|
||||
|
||||
value = self.__literal()
|
||||
|
||||
@@ -98,7 +106,7 @@ class Parser:
|
||||
self.__eat(TokenType.SBRACKETO)
|
||||
properties.append(self.__property())
|
||||
|
||||
while self.next_token.type == TokenType.COMMA:
|
||||
while self.next_token.type == TokenType.COMMA: # pyright: ignore[reportUnnecessaryComparison]
|
||||
self.__eat(TokenType.COMMA)
|
||||
properties.append(self.__property())
|
||||
|
||||
@@ -110,11 +118,16 @@ class Parser:
|
||||
key = self.__eat(TokenType.ULITERAL).value
|
||||
self.__eat(TokenType.EQUALS)
|
||||
value = self.__literal()
|
||||
if not isinstance(key, str):
|
||||
raise self.__syntax_error()
|
||||
return Property(key, value)
|
||||
|
||||
def __literal(self) -> str:
|
||||
if self.next_token.type in [TokenType.QLITERAL, TokenType.ULITERAL]:
|
||||
return self.__eat(self.next_token.type).value
|
||||
literal = self.__eat(self.next_token.type).value
|
||||
if not isinstance(literal, str):
|
||||
raise self.__syntax_error()
|
||||
return literal
|
||||
raise self.__syntax_error()
|
||||
|
||||
def __eat(self, type: TokenType) -> Token:
|
||||
|
||||
@@ -1,5 +1,10 @@
|
||||
# Copyright (C) 2025
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from enum import Enum
|
||||
from typing import Any
|
||||
from typing import override
|
||||
|
||||
from tagstudio.core.query_lang.ast import ConstraintType
|
||||
from tagstudio.core.query_lang.util import ParsingError
|
||||
@@ -21,12 +26,14 @@ class TokenType(Enum):
|
||||
|
||||
class Token:
|
||||
type: TokenType
|
||||
value: Any
|
||||
value: str | ConstraintType | None
|
||||
|
||||
start: int
|
||||
end: int
|
||||
|
||||
def __init__(self, type: TokenType, value: Any, start: int, end: int) -> None:
|
||||
def __init__(
|
||||
self, type: TokenType, value: str | ConstraintType | None, start: int, end: int
|
||||
) -> None:
|
||||
self.type = type
|
||||
self.value = value
|
||||
self.start = start
|
||||
@@ -40,9 +47,11 @@ class Token:
|
||||
def EOF(pos: int) -> "Token": # noqa: N802
|
||||
return Token.from_type(TokenType.EOF, pos)
|
||||
|
||||
@override
|
||||
def __str__(self) -> str:
|
||||
return f"Token({self.type}, {self.value}, {self.start}, {self.end})" # pragma: nocover
|
||||
|
||||
@override
|
||||
def __repr__(self) -> str:
|
||||
return self.__str__() # pragma: nocover
|
||||
|
||||
|
||||
@@ -1,15 +1,26 @@
|
||||
# Copyright (C) 2025
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from typing import override
|
||||
|
||||
|
||||
class ParsingError(BaseException):
|
||||
start: int
|
||||
end: int
|
||||
msg: str
|
||||
|
||||
def __init__(self, start: int, end: int, msg: str = "Syntax Error") -> None:
|
||||
super().__init__()
|
||||
self.start = start
|
||||
self.end = end
|
||||
self.msg = msg
|
||||
|
||||
@override
|
||||
def __str__(self) -> str:
|
||||
return f"Syntax Error {self.start}->{self.end}: {self.msg}" # pragma: nocover
|
||||
|
||||
@override
|
||||
def __repr__(self) -> str:
|
||||
return self.__str__() # pragma: nocover
|
||||
|
||||
@@ -7,11 +7,14 @@
|
||||
import json
|
||||
from pathlib import Path
|
||||
|
||||
import structlog
|
||||
|
||||
from tagstudio.core.constants import TS_FOLDER_NAME
|
||||
from tagstudio.core.library.alchemy.fields import _FieldID
|
||||
from tagstudio.core.library.alchemy.fields import FieldID
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Entry
|
||||
from tagstudio.core.utils.missing_files import logger
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
class TagStudioCore:
|
||||
@@ -43,27 +46,27 @@ class TagStudioCore:
|
||||
return {}
|
||||
|
||||
if source == "twitter":
|
||||
info[_FieldID.DESCRIPTION] = json_dump["content"].strip()
|
||||
info[_FieldID.DATE_PUBLISHED] = json_dump["date"]
|
||||
info[FieldID.DESCRIPTION] = json_dump["content"].strip()
|
||||
info[FieldID.DATE_PUBLISHED] = json_dump["date"]
|
||||
elif source == "instagram":
|
||||
info[_FieldID.DESCRIPTION] = json_dump["description"].strip()
|
||||
info[_FieldID.DATE_PUBLISHED] = json_dump["date"]
|
||||
info[FieldID.DESCRIPTION] = json_dump["description"].strip()
|
||||
info[FieldID.DATE_PUBLISHED] = json_dump["date"]
|
||||
elif source == "artstation":
|
||||
info[_FieldID.TITLE] = json_dump["title"].strip()
|
||||
info[_FieldID.ARTIST] = json_dump["user"]["full_name"].strip()
|
||||
info[_FieldID.DESCRIPTION] = json_dump["description"].strip()
|
||||
info[_FieldID.TAGS] = json_dump["tags"]
|
||||
info[FieldID.TITLE] = json_dump["title"].strip()
|
||||
info[FieldID.ARTIST] = json_dump["user"]["full_name"].strip()
|
||||
info[FieldID.DESCRIPTION] = json_dump["description"].strip()
|
||||
info[FieldID.TAGS] = json_dump["tags"]
|
||||
# info["tags"] = [x for x in json_dump["mediums"]["name"]]
|
||||
info[_FieldID.DATE_PUBLISHED] = json_dump["date"]
|
||||
info[FieldID.DATE_PUBLISHED] = json_dump["date"]
|
||||
elif source == "newgrounds":
|
||||
# info["title"] = json_dump["title"]
|
||||
# info["artist"] = json_dump["artist"]
|
||||
# info["description"] = json_dump["description"]
|
||||
info[_FieldID.TAGS] = json_dump["tags"]
|
||||
info[_FieldID.DATE_PUBLISHED] = json_dump["date"]
|
||||
info[_FieldID.ARTIST] = json_dump["user"].strip()
|
||||
info[_FieldID.DESCRIPTION] = json_dump["description"].strip()
|
||||
info[_FieldID.SOURCE] = json_dump["post_url"].strip()
|
||||
info[FieldID.TAGS] = json_dump["tags"]
|
||||
info[FieldID.DATE_PUBLISHED] = json_dump["date"]
|
||||
info[FieldID.ARTIST] = json_dump["user"].strip()
|
||||
info[FieldID.DESCRIPTION] = json_dump["description"].strip()
|
||||
info[FieldID.SOURCE] = json_dump["post_url"].strip()
|
||||
|
||||
except Exception:
|
||||
logger.exception("Error handling sidecar file.", path=_filepath)
|
||||
|
||||
@@ -1,89 +0,0 @@
|
||||
from collections.abc import Iterator
|
||||
from dataclasses import dataclass, field
|
||||
from pathlib import Path
|
||||
|
||||
import structlog
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Entry
|
||||
from tagstudio.core.utils.refresh_dir import GLOBAL_IGNORE_SET
|
||||
|
||||
logger = structlog.get_logger()
|
||||
|
||||
|
||||
@dataclass
|
||||
class MissingRegistry:
|
||||
"""State tracker for unlinked and moved files."""
|
||||
|
||||
library: Library
|
||||
files_fixed_count: int = 0
|
||||
missing_file_entries: list[Entry] = field(default_factory=list)
|
||||
|
||||
@property
|
||||
def missing_file_entries_count(self) -> int:
|
||||
return len(self.missing_file_entries)
|
||||
|
||||
def refresh_missing_files(self) -> Iterator[int]:
|
||||
"""Track the number of entries that point to an invalid filepath."""
|
||||
logger.info("[refresh_missing_files] Refreshing missing files...")
|
||||
self.missing_file_entries = []
|
||||
for i, entry in enumerate(self.library.all_entries()):
|
||||
full_path = self.library.library_dir / entry.path
|
||||
if not full_path.exists() or not full_path.is_file():
|
||||
self.missing_file_entries.append(entry)
|
||||
yield i
|
||||
|
||||
def match_missing_file_entry(self, match_entry: Entry) -> list[Path]:
|
||||
"""Try and match unlinked file entries with matching results in the library directory.
|
||||
|
||||
Works if files were just moved to different subfolders and don't have duplicate names.
|
||||
"""
|
||||
matches = []
|
||||
for path in self.library.library_dir.glob(f"**/{match_entry.path.name}"):
|
||||
# Ensure matched file isn't in a globally ignored folder
|
||||
skip: bool = False
|
||||
for part in path.parts:
|
||||
if part in GLOBAL_IGNORE_SET:
|
||||
skip = True
|
||||
break
|
||||
if skip:
|
||||
continue
|
||||
if path.name == match_entry.path.name:
|
||||
new_path = Path(path).relative_to(self.library.library_dir)
|
||||
matches.append(new_path)
|
||||
|
||||
logger.info("[MissingRegistry] Matches", matches=matches)
|
||||
return matches
|
||||
|
||||
def fix_unlinked_entries(self) -> Iterator[int]:
|
||||
"""Attempt to fix unlinked file entries by finding a match in the library directory."""
|
||||
self.files_fixed_count = 0
|
||||
matched_entries: list[Entry] = []
|
||||
for i, entry in enumerate(self.missing_file_entries):
|
||||
item_matches = self.match_missing_file_entry(entry)
|
||||
if len(item_matches) == 1:
|
||||
logger.info(
|
||||
"[fix_unlinked_entries]",
|
||||
entry=entry.path.as_posix(),
|
||||
item_matches=item_matches[0].as_posix(),
|
||||
)
|
||||
if not self.library.update_entry_path(entry.id, item_matches[0]):
|
||||
try:
|
||||
match = self.library.get_entry_full_by_path(item_matches[0])
|
||||
entry_full = self.library.get_entry_full(entry.id)
|
||||
self.library.merge_entries(entry_full, match)
|
||||
except AttributeError:
|
||||
continue
|
||||
self.files_fixed_count += 1
|
||||
matched_entries.append(entry)
|
||||
yield i
|
||||
|
||||
for entry in matched_entries:
|
||||
self.missing_file_entries.remove(entry)
|
||||
|
||||
def execute_deletion(self) -> None:
|
||||
self.library.remove_entries(
|
||||
list(map(lambda missing: missing.id, self.missing_file_entries))
|
||||
)
|
||||
|
||||
self.missing_file_entries = []
|
||||
@@ -1,111 +0,0 @@
|
||||
from collections.abc import Iterator
|
||||
from dataclasses import dataclass, field
|
||||
from datetime import datetime as dt
|
||||
from pathlib import Path
|
||||
from time import time
|
||||
|
||||
import structlog
|
||||
|
||||
from tagstudio.core.constants import TS_FOLDER_NAME
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Entry
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
GLOBAL_IGNORE_SET: set[str] = set(
|
||||
[
|
||||
TS_FOLDER_NAME,
|
||||
"$RECYCLE.BIN",
|
||||
".Trashes",
|
||||
".Trash",
|
||||
"tagstudio_thumbs",
|
||||
".fseventsd",
|
||||
".Spotlight-V100",
|
||||
"System Volume Information",
|
||||
".DS_Store",
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
@dataclass
|
||||
class RefreshDirTracker:
|
||||
library: Library
|
||||
files_not_in_library: list[Path] = field(default_factory=list)
|
||||
|
||||
@property
|
||||
def files_count(self) -> int:
|
||||
return len(self.files_not_in_library)
|
||||
|
||||
def save_new_files(self):
|
||||
"""Save the list of files that are not in the library."""
|
||||
if self.files_not_in_library:
|
||||
entries = [
|
||||
Entry(
|
||||
path=entry_path,
|
||||
folder=self.library.folder,
|
||||
fields=[],
|
||||
date_added=dt.now(),
|
||||
)
|
||||
for entry_path in self.files_not_in_library
|
||||
]
|
||||
self.library.add_entries(entries)
|
||||
|
||||
self.files_not_in_library = []
|
||||
|
||||
yield
|
||||
|
||||
def refresh_dir(self, lib_path: Path) -> Iterator[int]:
|
||||
"""Scan a directory for files, and add those relative filenames to internal variables."""
|
||||
if self.library.library_dir is None:
|
||||
raise ValueError("No library directory set.")
|
||||
|
||||
start_time_total = time()
|
||||
start_time_loop = time()
|
||||
|
||||
self.files_not_in_library = []
|
||||
dir_file_count = 0
|
||||
|
||||
for f in lib_path.glob("**/*"):
|
||||
end_time_loop = time()
|
||||
# Yield output every 1/30 of a second
|
||||
if (end_time_loop - start_time_loop) > 0.034:
|
||||
yield dir_file_count
|
||||
start_time_loop = time()
|
||||
|
||||
# Skip if the file/path is already mapped in the Library
|
||||
if f in self.library.included_files:
|
||||
dir_file_count += 1
|
||||
continue
|
||||
|
||||
# Ignore if the file is a directory
|
||||
if f.is_dir():
|
||||
continue
|
||||
|
||||
# Ensure new file isn't in a globally ignored folder
|
||||
skip: bool = False
|
||||
for part in f.parts:
|
||||
# NOTE: Files starting with "._" are sometimes generated by macOS Finder.
|
||||
# More info: https://lists.apple.com/archives/applescript-users/2006/Jun/msg00180.html
|
||||
if part.startswith("._") or part in GLOBAL_IGNORE_SET:
|
||||
skip = True
|
||||
break
|
||||
if skip:
|
||||
continue
|
||||
|
||||
dir_file_count += 1
|
||||
self.library.included_files.add(f)
|
||||
|
||||
relative_path = f.relative_to(lib_path)
|
||||
# TODO - load these in batch somehow
|
||||
if not self.library.has_path_entry(relative_path):
|
||||
self.files_not_in_library.append(relative_path)
|
||||
|
||||
end_time_total = time()
|
||||
yield dir_file_count
|
||||
logger.info(
|
||||
"Directory scan time",
|
||||
path=lib_path,
|
||||
duration=(end_time_total - start_time_total),
|
||||
files_not_in_lib=self.files_not_in_library,
|
||||
files_scanned=dir_file_count,
|
||||
)
|
||||
@@ -1,46 +1,51 @@
|
||||
# Copyright (C) 2024 Travis Abendshien (CyanVoxel).
|
||||
# Copyright (C) 2025
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
# pyright: reportExplicitAny=false
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
from collections.abc import Callable, Collection, Iterable
|
||||
from typing import Any
|
||||
|
||||
"""Implementation of subprocess.Popen that does not spawn console windows or log output
|
||||
and sanitizes pyinstall environment variables."""
|
||||
and sanitizes pyinstaller environment variables."""
|
||||
|
||||
|
||||
def silent_Popen( # noqa: N802
|
||||
def silent_popen(
|
||||
args,
|
||||
bufsize=-1,
|
||||
bufsize: int = -1,
|
||||
executable=None,
|
||||
stdin=None,
|
||||
stdout=None,
|
||||
stderr=None,
|
||||
preexec_fn=None,
|
||||
close_fds=True,
|
||||
shell=False,
|
||||
preexec_fn: Callable[[], Any] | None = None,
|
||||
close_fds: bool = True,
|
||||
shell: bool = False,
|
||||
cwd=None,
|
||||
env=None,
|
||||
universal_newlines=None,
|
||||
startupinfo=None,
|
||||
creationflags=0,
|
||||
restore_signals=True,
|
||||
start_new_session=False,
|
||||
pass_fds=(),
|
||||
universal_newlines: bool | None = None,
|
||||
startupinfo: Any | None = None,
|
||||
creationflags: int = 0,
|
||||
restore_signals: bool = True,
|
||||
start_new_session: bool = False,
|
||||
pass_fds: Collection[int] = (),
|
||||
*,
|
||||
group=None,
|
||||
extra_groups=None,
|
||||
user=None,
|
||||
umask=-1,
|
||||
encoding=None,
|
||||
errors=None,
|
||||
text=None,
|
||||
pipesize=-1,
|
||||
process_group=None,
|
||||
text: bool | None = None,
|
||||
encoding: str | None = None,
|
||||
errors: str | None = None,
|
||||
user: str | int | None = None,
|
||||
group: str | int | None = None,
|
||||
extra_groups: Iterable[str | int] | None = None,
|
||||
umask: int = -1,
|
||||
pipesize: int = -1,
|
||||
process_group: int | None = None,
|
||||
):
|
||||
"""Call subprocess.Popen without creating a console window."""
|
||||
current_env = env
|
||||
|
||||
if sys.platform == "win32":
|
||||
creationflags |= subprocess.CREATE_NO_WINDOW
|
||||
import ctypes
|
||||
@@ -52,9 +57,9 @@ def silent_Popen( # noqa: N802
|
||||
or sys.platform.startswith("openbsd")
|
||||
):
|
||||
# pass clean environment to the subprocess
|
||||
env = os.environ
|
||||
original_env = env.get("LD_LIBRARY_PATH_ORIG")
|
||||
env["LD_LIBRARY_PATH"] = original_env if original_env else ""
|
||||
current_env = os.environ
|
||||
original_env = current_env.get("LD_LIBRARY_PATH_ORIG")
|
||||
current_env["LD_LIBRARY_PATH"] = original_env if original_env else ""
|
||||
|
||||
return subprocess.Popen(
|
||||
args=args,
|
||||
@@ -67,26 +72,26 @@ def silent_Popen( # noqa: N802
|
||||
close_fds=close_fds,
|
||||
shell=shell,
|
||||
cwd=cwd,
|
||||
env=env,
|
||||
env=current_env,
|
||||
universal_newlines=universal_newlines,
|
||||
startupinfo=startupinfo,
|
||||
creationflags=creationflags,
|
||||
restore_signals=restore_signals,
|
||||
start_new_session=start_new_session,
|
||||
pass_fds=pass_fds,
|
||||
group=group,
|
||||
extra_groups=extra_groups,
|
||||
user=user,
|
||||
umask=umask,
|
||||
text=text,
|
||||
encoding=encoding,
|
||||
errors=errors,
|
||||
text=text,
|
||||
user=user,
|
||||
group=group,
|
||||
extra_groups=extra_groups,
|
||||
umask=umask,
|
||||
pipesize=pipesize,
|
||||
process_group=process_group,
|
||||
)
|
||||
|
||||
|
||||
def silent_run( # noqa: N802
|
||||
def silent_run(
|
||||
args,
|
||||
bufsize=-1,
|
||||
executable=None,
|
||||
@@ -1,4 +1,4 @@
|
||||
# Copyright (C) 2024 Travis Abendshien (CyanVoxel).
|
||||
# Copyright (C) 2025 Travis Abendshien (CyanVoxel).
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
@@ -24,3 +24,11 @@ def strip_punctuation(string: str) -> str:
|
||||
.replace(" ", "")
|
||||
.replace(" ", "")
|
||||
)
|
||||
|
||||
|
||||
def strip_web_protocol(string: str) -> str:
|
||||
r"""Strips a leading web protocol (ex. \"https://\") as well as \"www.\" from a string."""
|
||||
prefixes = ["https://", "http://", "www.", "www2."]
|
||||
for prefix in prefixes:
|
||||
string = string.removeprefix(prefix)
|
||||
return string
|
||||
14
src/tagstudio/core/utils/types.py
Normal file
14
src/tagstudio/core/utils/types.py
Normal file
@@ -0,0 +1,14 @@
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
from typing import TypeVar
|
||||
|
||||
T = TypeVar("T")
|
||||
|
||||
|
||||
def unwrap(optional: T | None, default: T | None = None) -> T:
|
||||
if optional is not None:
|
||||
return optional
|
||||
if default is not None:
|
||||
return default
|
||||
raise ValueError("Expected a value, but got None and no default was provided.")
|
||||
@@ -1,11 +0,0 @@
|
||||
# Copyright (C) 2024 Travis Abendshien (CyanVoxel).
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
def strip_web_protocol(string: str) -> str:
|
||||
r"""Strips a leading web protocol (ex. \"https://\") as well as \"www.\" from a string."""
|
||||
prefixes = ["https://", "http://", "www.", "www2."]
|
||||
for prefix in prefixes:
|
||||
string = string.removeprefix(prefix)
|
||||
return string
|
||||
@@ -11,6 +11,7 @@ import traceback
|
||||
|
||||
import structlog
|
||||
|
||||
from tagstudio.core.constants import VERSION, VERSION_BRANCH
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
@@ -54,6 +55,13 @@ def main():
|
||||
action="store_true",
|
||||
help="Reveals additional internal data useful for debugging.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-v",
|
||||
"--version",
|
||||
action="version",
|
||||
help="Displays TagStudio version information.",
|
||||
version=f"TagStudio v{VERSION} {VERSION_BRANCH}",
|
||||
)
|
||||
args = parser.parse_args()
|
||||
|
||||
driver = QtDriver(args)
|
||||
|
||||
@@ -2,189 +2,193 @@
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
import contextlib
|
||||
import math
|
||||
import typing
|
||||
from collections.abc import Iterable
|
||||
from datetime import datetime as dt
|
||||
from pathlib import Path
|
||||
from threading import RLock
|
||||
|
||||
import structlog
|
||||
from PIL import Image
|
||||
|
||||
from tagstudio.core.constants import THUMB_CACHE_NAME, TS_FOLDER_NAME
|
||||
from tagstudio.core.singleton import Singleton
|
||||
|
||||
# Only import for type checking/autocompletion, will not be imported at runtime.
|
||||
if typing.TYPE_CHECKING:
|
||||
from tagstudio.core.library import Library
|
||||
from tagstudio.qt.global_settings import DEFAULT_CACHED_IMAGE_QUALITY, DEFAULT_THUMB_CACHE_SIZE
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
class CacheManager(metaclass=Singleton):
|
||||
FOLDER_SIZE = 10000000 # Each cache folder assumed to be 10 MiB
|
||||
size_limit = 500000000 # 500 MiB default
|
||||
class CacheFolder:
|
||||
def __init__(self, path: Path, size: int):
|
||||
self.path: Path = path
|
||||
self.size: int = size
|
||||
|
||||
folder_dict: dict[Path, int] = {}
|
||||
|
||||
def __init__(self):
|
||||
self.lib: Library | None = None
|
||||
self.last_lib_path: Path | None = None
|
||||
class CacheManager:
|
||||
MAX_FOLDER_SIZE = 10 # Absolute maximum size of a folder, number in MiB
|
||||
STAT_MULTIPLIER = 1_000_000 # Multiplier to apply to file stats (bytes) to get user units (MiB)
|
||||
|
||||
@staticmethod
|
||||
def clear_cache(library_dir: Path | None) -> bool:
|
||||
"""Clear all files and folders within the cached folder.
|
||||
def __init__(
|
||||
self,
|
||||
library_dir: Path,
|
||||
max_size: int | float = DEFAULT_THUMB_CACHE_SIZE,
|
||||
img_quality: int = DEFAULT_CACHED_IMAGE_QUALITY,
|
||||
):
|
||||
"""A class for managing frontend caches, such as for file thumbnails.
|
||||
|
||||
Returns:
|
||||
bool: True if successfully deleted, else False.
|
||||
Args:
|
||||
library_dir(Path): The path of the folder containing the .TagStudio library folder.
|
||||
max_size: (int | float) The maximum size of the cache, in MiB.
|
||||
img_quality: (int) The image quality value to save PIL images (0-100, default=80)
|
||||
"""
|
||||
cleared = True
|
||||
self._lock = RLock()
|
||||
self.cache_path = library_dir / TS_FOLDER_NAME / THUMB_CACHE_NAME
|
||||
self.max_size: int = max(
|
||||
math.floor(max_size * CacheManager.STAT_MULTIPLIER),
|
||||
math.floor(CacheManager.MAX_FOLDER_SIZE * CacheManager.STAT_MULTIPLIER),
|
||||
)
|
||||
self.img_quality = (
|
||||
img_quality if img_quality >= 0 and img_quality <= 100 else DEFAULT_CACHED_IMAGE_QUALITY
|
||||
)
|
||||
|
||||
if library_dir:
|
||||
tree: Path = library_dir / TS_FOLDER_NAME / THUMB_CACHE_NAME
|
||||
self.folders: list[CacheFolder] = []
|
||||
self.current_size = 0
|
||||
if self.cache_path.exists():
|
||||
for folder in self.cache_path.iterdir():
|
||||
if not folder.is_dir():
|
||||
continue
|
||||
folder_size = 0
|
||||
for file in folder.iterdir():
|
||||
folder_size += file.stat().st_size
|
||||
self.folders.append(CacheFolder(folder, folder_size))
|
||||
self.current_size += folder_size
|
||||
|
||||
for folder in tree.glob("*"):
|
||||
for file in folder.glob("*"):
|
||||
# NOTE: On macOS with non-native file systems, this will commonly raise
|
||||
# FileNotFound errors due to trying to delete "._" files that have
|
||||
# already been deleted: https://bugs.python.org/issue29699
|
||||
with contextlib.suppress(FileNotFoundError):
|
||||
file.unlink()
|
||||
def _set_most_recent_folder(self, index: int):
|
||||
"""Move CacheFolder at index so it's considered the most recently used folder."""
|
||||
with self._lock as _lock:
|
||||
if index == (len(self.folders) - 1):
|
||||
return
|
||||
cache_folder = self.folders.pop(index)
|
||||
self.folders.append(cache_folder)
|
||||
|
||||
def _get_most_recent_folder(self) -> Iterable[int]:
|
||||
"""Get each folders index sorted most recently used first."""
|
||||
with self._lock as _lock:
|
||||
return reversed(range(len(self.folders)))
|
||||
|
||||
def _least_recent_folder(self) -> Iterable[int]:
|
||||
"""Get each folder's index sorted least recently used first."""
|
||||
with self._lock as _lock:
|
||||
return range(len(self.folders))
|
||||
|
||||
def clear_cache(self):
|
||||
"""Clear all files and folders within the cached folder."""
|
||||
with self._lock as _lock:
|
||||
folders = []
|
||||
for folder in self.folders:
|
||||
if not self._remove_folder(folder):
|
||||
folders.append(folders)
|
||||
logger.warn("[CacheManager] Failed to remove folder", folder=folder)
|
||||
self.folders = folders
|
||||
logger.info("[CacheManager] Cleared cache!")
|
||||
|
||||
def _remove_folder(self, cache_folder: CacheFolder) -> bool:
|
||||
with self._lock as _lock:
|
||||
self.current_size -= cache_folder.size
|
||||
if not cache_folder.path.is_dir():
|
||||
return True
|
||||
|
||||
is_empty = True
|
||||
for file in cache_folder.path.iterdir():
|
||||
assert file.is_file() and file.suffix == ".webp"
|
||||
try:
|
||||
folder.rmdir()
|
||||
with contextlib.suppress(KeyError):
|
||||
CacheManager.folder_dict.pop(folder)
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
"[CacheManager] Couldn't unlink empty cache folder!",
|
||||
error=e,
|
||||
folder=folder,
|
||||
tree=tree,
|
||||
)
|
||||
file.unlink(missing_ok=True)
|
||||
except BaseException as e:
|
||||
is_empty = False
|
||||
logger.warn("[CacheManager] Failed to remove file", file=file, error=e)
|
||||
|
||||
for _ in tree.glob("*"):
|
||||
cleared = False
|
||||
|
||||
if cleared:
|
||||
logger.info("[CacheManager] Cleared cache!")
|
||||
if is_empty:
|
||||
cache_folder.path.rmdir()
|
||||
return True
|
||||
else:
|
||||
logger.error("[CacheManager] Couldn't delete cache!", tree=tree)
|
||||
size = 0
|
||||
for file in cache_folder.path.iterdir():
|
||||
size += file.stat().st_size
|
||||
cache_folder.size = size
|
||||
self.current_size += size
|
||||
return False
|
||||
|
||||
return cleared
|
||||
def get_file_path(self, file_name: Path) -> Path | None:
|
||||
with self._lock as _lock:
|
||||
for i in self._get_most_recent_folder():
|
||||
cache_folder = self.folders[i]
|
||||
file_path = cache_folder.path / file_name
|
||||
if file_path.exists():
|
||||
self._set_most_recent_folder(i)
|
||||
return file_path
|
||||
return None
|
||||
|
||||
def set_library(self, library):
|
||||
"""Set the TagStudio library for the cache manager."""
|
||||
self.lib = library
|
||||
self.last_lib_path = self.lib.library_dir
|
||||
if library.library_dir:
|
||||
self.check_folder_status()
|
||||
|
||||
def cache_dir(self) -> Path | None:
|
||||
"""Return the current cache directory, not including folder slugs."""
|
||||
if not self.lib.library_dir:
|
||||
return None
|
||||
return Path(self.lib.library_dir / TS_FOLDER_NAME / THUMB_CACHE_NAME)
|
||||
|
||||
def save_image(self, image: Image.Image, path: Path, mode: str = "RGBA"):
|
||||
def save_image(self, image: Image.Image, file_name: Path, mode: str = "RGBA"):
|
||||
"""Save an image to the cache."""
|
||||
folder = self.get_current_folder()
|
||||
if folder:
|
||||
image_path: Path = folder / path
|
||||
image.save(image_path, mode=mode)
|
||||
with contextlib.suppress(KeyError):
|
||||
CacheManager.folder_dict[folder] += image_path.stat().st_size
|
||||
|
||||
def check_folder_status(self):
|
||||
"""Check the status of the cache folders.
|
||||
|
||||
This includes registering existing ones and creating new ones if needed.
|
||||
"""
|
||||
if (
|
||||
(self.last_lib_path != self.lib.library_dir)
|
||||
or not self.cache_dir()
|
||||
or not self.cache_dir().exists()
|
||||
):
|
||||
self.register_existing_folders()
|
||||
|
||||
def create_folder() -> Path | None:
|
||||
"""Create a new cache folder."""
|
||||
if not self.lib.library_dir:
|
||||
return None
|
||||
folder_path = Path(self.cache_dir() / str(math.floor(dt.timestamp(dt.now()))))
|
||||
logger.info("[CacheManager] Creating new folder", folder=folder_path)
|
||||
with self._lock as _lock:
|
||||
cache_folder: CacheFolder = self._get_current_folder()
|
||||
file_path = cache_folder.path / file_name
|
||||
try:
|
||||
folder_path.mkdir(exist_ok=True)
|
||||
except NotADirectoryError:
|
||||
logger.error("[CacheManager] Not a directory", path=folder_path)
|
||||
return folder_path
|
||||
image.save(file_path, mode=mode, quality=self.img_quality)
|
||||
|
||||
# Get size of most recent folder, if any exist.
|
||||
if CacheManager.folder_dict:
|
||||
last_folder = sorted(CacheManager.folder_dict.keys())[-1]
|
||||
size = file_path.stat().st_size
|
||||
cache_folder.size += size
|
||||
self.current_size += size
|
||||
self._cull_folders()
|
||||
except FileNotFoundError:
|
||||
logger.warn(
|
||||
"[CacheManager] Failed to save cached image, was the folder deleted on disk?",
|
||||
folder=file_path,
|
||||
)
|
||||
if not cache_folder.path.exists():
|
||||
self.folders.remove(cache_folder)
|
||||
|
||||
if CacheManager.folder_dict[last_folder] > CacheManager.FOLDER_SIZE:
|
||||
new_folder = create_folder()
|
||||
CacheManager.folder_dict[new_folder] = 0
|
||||
else:
|
||||
new_folder = create_folder()
|
||||
CacheManager.folder_dict[new_folder] = 0
|
||||
def _create_folder(self) -> CacheFolder:
|
||||
with self._lock as _lock:
|
||||
folder = self.cache_path / Path(str(math.floor(dt.timestamp(dt.now()))))
|
||||
try:
|
||||
folder.mkdir(parents=True)
|
||||
except FileExistsError:
|
||||
for cache_folder in self.folders:
|
||||
if cache_folder.path == folder:
|
||||
return cache_folder
|
||||
cache_folder = CacheFolder(folder, 0)
|
||||
self.folders.append(cache_folder)
|
||||
return cache_folder
|
||||
|
||||
def get_current_folder(self) -> Path:
|
||||
"""Get the current cache folder path that should be used."""
|
||||
self.check_folder_status()
|
||||
self.cull_folders()
|
||||
def _get_current_folder(self) -> CacheFolder:
|
||||
with self._lock as _lock:
|
||||
if len(self.folders) == 0:
|
||||
return self._create_folder()
|
||||
|
||||
return sorted(CacheManager.folder_dict.keys())[-1]
|
||||
for i in self._get_most_recent_folder():
|
||||
cache_folder: CacheFolder = self.folders[i]
|
||||
if cache_folder.size < CacheManager.MAX_FOLDER_SIZE * CacheManager.STAT_MULTIPLIER:
|
||||
self._set_most_recent_folder(i)
|
||||
return cache_folder
|
||||
|
||||
def register_existing_folders(self):
|
||||
"""Scan and register any pre-existing cache folders with the most recent size."""
|
||||
self.last_lib_path = self.lib.library_dir
|
||||
CacheManager.folder_dict.clear()
|
||||
return self._create_folder()
|
||||
|
||||
if self.last_lib_path:
|
||||
# Ensure thumbnail cache path exists.
|
||||
self.cache_dir().mkdir(exist_ok=True)
|
||||
# Registers any existing folders and counts the capacity of the most recent one.
|
||||
for f in sorted(self.cache_dir().glob("*")):
|
||||
if f.is_dir():
|
||||
# A folder is found. Add it to the class dict.BlockingIOError
|
||||
CacheManager.folder_dict[f] = 0
|
||||
CacheManager.folder_dict = dict(
|
||||
sorted(CacheManager.folder_dict.items(), key=lambda kv: kv[0])
|
||||
)
|
||||
|
||||
if CacheManager.folder_dict:
|
||||
last_folder = sorted(CacheManager.folder_dict.keys())[-1]
|
||||
for f in last_folder.glob("*"):
|
||||
if not f.is_dir():
|
||||
with contextlib.suppress(KeyError):
|
||||
CacheManager.folder_dict[last_folder] += f.stat().st_size
|
||||
|
||||
def cull_folders(self):
|
||||
def _cull_folders(self):
|
||||
"""Remove folders and their cached context based on size or age limits."""
|
||||
# Ensure that the user's configured size limit isn't less than the internal folder size.
|
||||
size_limit = max(CacheManager.size_limit, CacheManager.FOLDER_SIZE)
|
||||
with self._lock as _lock:
|
||||
if self.current_size < self.max_size:
|
||||
return
|
||||
|
||||
if len(CacheManager.folder_dict) > (size_limit / CacheManager.FOLDER_SIZE):
|
||||
f = sorted(CacheManager.folder_dict.keys())[0]
|
||||
folder = self.cache_dir() / f
|
||||
logger.info("[CacheManager] Removing folder due to size limit", folder=folder)
|
||||
removed: list[int] = []
|
||||
for i in self._least_recent_folder():
|
||||
cache_folder: CacheFolder = self.folders[i]
|
||||
logger.info(
|
||||
"[CacheManager] Removing folder due to size limit", folder=cache_folder.path
|
||||
)
|
||||
if self._remove_folder(cache_folder):
|
||||
removed.append(i)
|
||||
if self.current_size < self.max_size:
|
||||
break
|
||||
|
||||
for file in folder.glob("*"):
|
||||
try:
|
||||
file.unlink()
|
||||
except Exception as e:
|
||||
logger.error(
|
||||
"[CacheManager] Couldn't cull file inside of folder!",
|
||||
error=e,
|
||||
file=file,
|
||||
folder=folder,
|
||||
)
|
||||
try:
|
||||
folder.rmdir()
|
||||
with contextlib.suppress(KeyError):
|
||||
CacheManager.folder_dict.pop(f)
|
||||
self.cull_folders()
|
||||
except Exception as e:
|
||||
logger.error("[CacheManager] Couldn't cull folder!", error=e, folder=folder)
|
||||
pass
|
||||
for index in sorted(removed, reverse=True):
|
||||
self.folders.pop(index)
|
||||
|
||||
@@ -5,14 +5,14 @@ from PySide6.QtCore import Qt, QUrl
|
||||
from PySide6.QtGui import QDesktopServices
|
||||
from PySide6.QtWidgets import QMessageBox
|
||||
|
||||
from tagstudio.core.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.qt.helpers.vendored.ffmpeg import FFMPEG_CMD, FFPROBE_CMD
|
||||
from tagstudio.qt.models.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.qt.previews.vendored.ffmpeg import FFMPEG_CMD, FFPROBE_CMD
|
||||
from tagstudio.qt.translations import Translations
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
class FfmpegChecker(QMessageBox):
|
||||
class FfmpegMissingMessageBox(QMessageBox):
|
||||
"""A warning dialog for if FFmpeg is missing."""
|
||||
|
||||
HELP_URL = "https://docs.tagstud.io/help/ffmpeg/"
|
||||
94
src/tagstudio/qt/controllers/fix_ignored_modal_controller.py
Normal file
94
src/tagstudio/qt/controllers/fix_ignored_modal_controller.py
Normal file
@@ -0,0 +1,94 @@
|
||||
# Copyright (C) 2025 Travis Abendshien (CyanVoxel).
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from typing import TYPE_CHECKING, override
|
||||
|
||||
import structlog
|
||||
from PySide6 import QtGui
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.registries.ignored_registry import IgnoredRegistry
|
||||
from tagstudio.qt.mixed.progress_bar import ProgressWidget
|
||||
from tagstudio.qt.mixed.remove_ignored_modal import RemoveIgnoredModal
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.views.fix_ignored_modal_view import FixIgnoredEntriesModalView
|
||||
|
||||
# Only import for type checking/autocompletion, will not be imported at runtime.
|
||||
if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
class FixIgnoredEntriesModal(FixIgnoredEntriesModalView):
|
||||
def __init__(self, library: "Library", driver: "QtDriver"):
|
||||
super().__init__(library, driver)
|
||||
self.tracker = IgnoredRegistry(self.lib)
|
||||
|
||||
self.remove_modal = RemoveIgnoredModal(self.driver, self.tracker)
|
||||
self.remove_modal.done.connect(
|
||||
lambda: (
|
||||
self.update_ignored_count(),
|
||||
self.driver.update_browsing_state(),
|
||||
self.driver.library_info_window.update_cleanup(),
|
||||
self.refresh_ignored(),
|
||||
)
|
||||
)
|
||||
|
||||
self.refresh_ignored_button.clicked.connect(self.refresh_ignored)
|
||||
self.remove_button.clicked.connect(self.remove_modal.show)
|
||||
self.done_button.clicked.connect(self.hide)
|
||||
|
||||
self.update_ignored_count()
|
||||
|
||||
def refresh_ignored(self):
|
||||
pw = ProgressWidget(
|
||||
cancel_button_text=None,
|
||||
minimum=0,
|
||||
maximum=self.lib.entries_count,
|
||||
)
|
||||
pw.setWindowTitle(Translations["library.scan_library.title"])
|
||||
pw.update_label(Translations["entries.ignored.scanning"])
|
||||
|
||||
def update_driver_widgets():
|
||||
if (
|
||||
hasattr(self.driver, "library_info_window")
|
||||
and self.driver.library_info_window.isVisible()
|
||||
):
|
||||
self.driver.library_info_window.update_cleanup()
|
||||
|
||||
pw.from_iterable_function(
|
||||
self.tracker.refresh_ignored_entries,
|
||||
None,
|
||||
self.set_ignored_count,
|
||||
self.update_ignored_count,
|
||||
self.remove_modal.refresh_list,
|
||||
update_driver_widgets,
|
||||
)
|
||||
|
||||
def set_ignored_count(self):
|
||||
"""Sets the ignored_entries_count in the Library to the tracker's value."""
|
||||
self.lib.ignored_entries_count = self.tracker.ignored_count
|
||||
|
||||
def update_ignored_count(self):
|
||||
"""Updates the UI to reflect the Library's current ignored_entries_count."""
|
||||
# Indicates that the library is new compared to the last update.
|
||||
# NOTE: Make sure set_ignored_count() is called before this!
|
||||
if self.tracker.ignored_count > 0 and self.lib.ignored_entries_count < 0:
|
||||
self.tracker.reset()
|
||||
|
||||
count: int = self.lib.ignored_entries_count
|
||||
|
||||
self.remove_button.setDisabled(count < 1)
|
||||
|
||||
count_text: str = Translations.format(
|
||||
"entries.ignored.ignored_count", count=count if count >= 0 else "—"
|
||||
)
|
||||
self.ignored_count_label.setText(f"<h3>{count_text}</h3>")
|
||||
|
||||
@override
|
||||
def showEvent(self, event: QtGui.QShowEvent) -> None: # type: ignore
|
||||
self.update_ignored_count()
|
||||
return super().showEvent(event)
|
||||
52
src/tagstudio/qt/controllers/ignore_modal_controller.py
Normal file
52
src/tagstudio/qt/controllers/ignore_modal_controller.py
Normal file
@@ -0,0 +1,52 @@
|
||||
# Copyright (C) 2025 Travis Abendshien (CyanVoxel).
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from pathlib import Path
|
||||
from typing import override
|
||||
|
||||
import structlog
|
||||
from PySide6.QtCore import Signal
|
||||
from PySide6.QtGui import QShowEvent
|
||||
|
||||
from tagstudio.core.constants import IGNORE_NAME, TS_FOLDER_NAME
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Tag
|
||||
from tagstudio.core.library.ignore import Ignore
|
||||
from tagstudio.qt.utils.file_opener import open_file
|
||||
from tagstudio.qt.views.ignore_modal_view import IgnoreModalView
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
class IgnoreModal(IgnoreModalView):
|
||||
on_edit = Signal(Tag)
|
||||
|
||||
def __init__(self, library: Library) -> None:
|
||||
super().__init__(library)
|
||||
self.open_button.clicked.connect(self.__open_file)
|
||||
|
||||
def __load_file(self):
|
||||
if not self.lib.library_dir:
|
||||
return
|
||||
ts_ignore: list[str] = Ignore.read_ignore_file(self.lib.library_dir)
|
||||
self.text_edit.setPlainText("".join(ts_ignore))
|
||||
|
||||
def __open_file(self):
|
||||
if not self.lib.library_dir:
|
||||
return
|
||||
ts_ignore_path = Path(self.lib.library_dir / TS_FOLDER_NAME / IGNORE_NAME)
|
||||
open_file(ts_ignore_path, file_manager=True)
|
||||
|
||||
def save(self):
|
||||
if not self.lib.library_dir:
|
||||
return
|
||||
lines = self.text_edit.toPlainText().split("\n")
|
||||
lines = [f"{line}\n" for line in lines]
|
||||
Ignore.write_ignore_file(self.lib.library_dir, lines)
|
||||
|
||||
@override
|
||||
def showEvent(self, event: QShowEvent) -> None: # type: ignore
|
||||
self.__load_file()
|
||||
return super().showEvent(event)
|
||||
166
src/tagstudio/qt/controllers/library_info_window_controller.py
Normal file
166
src/tagstudio/qt/controllers/library_info_window_controller.py
Normal file
@@ -0,0 +1,166 @@
|
||||
# Copyright (C) 2025 Travis Abendshien (CyanVoxel).
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
import os
|
||||
from pathlib import Path
|
||||
from typing import TYPE_CHECKING, override
|
||||
from warnings import catch_warnings
|
||||
|
||||
import structlog
|
||||
from humanfriendly import format_size # pyright: ignore[reportUnknownVariableType]
|
||||
from PySide6 import QtGui
|
||||
|
||||
from tagstudio.core.constants import BACKUP_FOLDER_NAME, TS_FOLDER_NAME
|
||||
from tagstudio.core.library.alchemy.constants import (
|
||||
DB_VERSION,
|
||||
DB_VERSION_CURRENT_KEY,
|
||||
JSON_FILENAME,
|
||||
)
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.utils import file_opener
|
||||
from tagstudio.qt.views.library_info_window_view import LibraryInfoWindowView
|
||||
|
||||
# Only import for type checking/autocompletion, will not be imported at runtime.
|
||||
if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
class LibraryInfoWindow(LibraryInfoWindowView):
|
||||
def __init__(self, library: "Library", driver: "QtDriver"):
|
||||
super().__init__(library, driver)
|
||||
|
||||
# Statistics Buttons
|
||||
self.manage_tags_button.clicked.connect(
|
||||
self.driver.main_window.menu_bar.tag_manager_action.trigger
|
||||
)
|
||||
self.manage_colors_button.clicked.connect(
|
||||
self.driver.main_window.menu_bar.color_manager_action.trigger
|
||||
)
|
||||
|
||||
# Cleanup Buttons
|
||||
self.fix_unlinked_entries.clicked.connect(
|
||||
self.driver.main_window.menu_bar.fix_unlinked_entries_action.trigger
|
||||
)
|
||||
self.fix_ignored_entries.clicked.connect(
|
||||
self.driver.main_window.menu_bar.fix_ignored_entries_action.trigger
|
||||
)
|
||||
self.fix_dupe_files.clicked.connect(
|
||||
self.driver.main_window.menu_bar.fix_dupe_files_action.trigger
|
||||
)
|
||||
|
||||
# General Buttons
|
||||
self.close_button.clicked.connect(lambda: self.close())
|
||||
|
||||
def update_title(self):
|
||||
assert self.lib.library_dir
|
||||
title: str = Translations.format(
|
||||
"library_info.title", library_dir=self.lib.library_dir.stem
|
||||
)
|
||||
self.title_label.setText(f"<h2>{title}</h2>")
|
||||
|
||||
def update_stats(self):
|
||||
self.entry_count_label.setText(f"<b>{self.lib.entries_count}</b>")
|
||||
self.tag_count_label.setText(f"<b>{len(self.lib.tags)}</b>")
|
||||
self.field_count_label.setText(f"<b>{len(self.lib.field_types)}</b>")
|
||||
self.namespaces_count_label.setText(f"<b>{len(self.lib.namespaces)}</b>")
|
||||
colors_total = 0
|
||||
for c in self.lib.tag_color_groups.values():
|
||||
colors_total += len(c)
|
||||
self.color_count_label.setText(f"<b>{colors_total}</b>")
|
||||
|
||||
self.macros_count_label.setText("<b>1</b>") # TODO: Implement macros system
|
||||
|
||||
def update_cleanup(self):
|
||||
# Unlinked Entries
|
||||
unlinked_count: str = (
|
||||
str(self.lib.unlinked_entries_count) if self.lib.unlinked_entries_count >= 0 else "—"
|
||||
)
|
||||
self.unlinked_count_label.setText(f"<b>{unlinked_count}</b>")
|
||||
|
||||
# Ignored Entries
|
||||
ignored_count: str = (
|
||||
str(self.lib.ignored_entries_count) if self.lib.ignored_entries_count >= 0 else "—"
|
||||
)
|
||||
self.ignored_count_label.setText(f"<b>{ignored_count}</b>")
|
||||
|
||||
# Duplicate Files
|
||||
dupe_files_count: str = (
|
||||
str(self.lib.dupe_files_count) if self.lib.dupe_files_count >= 0 else "—"
|
||||
)
|
||||
self.dupe_files_count_label.setText(f"<b>{dupe_files_count}</b>")
|
||||
|
||||
# Legacy JSON Library Present
|
||||
json_library_text: str = (
|
||||
Translations["generic.yes"]
|
||||
if self.__is_json_library_present
|
||||
else Translations["generic.no"]
|
||||
)
|
||||
self.legacy_json_status_label.setText(f"<b>{json_library_text}</b>")
|
||||
|
||||
# Backups
|
||||
self.backups_count_label.setText(
|
||||
f"<b>{self.__backups_count}</b> ({format_size(self.__backups_size)})"
|
||||
)
|
||||
|
||||
# Buttons
|
||||
with catch_warnings(record=True):
|
||||
self.view_legacy_json_file.clicked.disconnect()
|
||||
self.open_backups_folder.clicked.disconnect()
|
||||
|
||||
if self.__is_json_library_present:
|
||||
self.view_legacy_json_file.setEnabled(True)
|
||||
self.view_legacy_json_file.clicked.connect(
|
||||
lambda: file_opener.open_file(
|
||||
unwrap(self.lib.library_dir) / TS_FOLDER_NAME / JSON_FILENAME, file_manager=True
|
||||
)
|
||||
)
|
||||
else:
|
||||
self.view_legacy_json_file.setEnabled(False)
|
||||
|
||||
self.open_backups_folder.clicked.connect(
|
||||
lambda: file_opener.open_file(
|
||||
unwrap(self.lib.library_dir) / TS_FOLDER_NAME / BACKUP_FOLDER_NAME
|
||||
)
|
||||
)
|
||||
|
||||
def update_version(self):
|
||||
version_text: str = f"<b>{self.lib.get_version(DB_VERSION_CURRENT_KEY)}</b> / {DB_VERSION}"
|
||||
self.version_label.setText(
|
||||
Translations.format("library_info.version", version=version_text)
|
||||
)
|
||||
|
||||
def refresh(self):
|
||||
self.update_title()
|
||||
self.update_stats()
|
||||
self.update_cleanup()
|
||||
self.update_version()
|
||||
|
||||
@property
|
||||
def __is_json_library_present(self):
|
||||
json_path = unwrap(self.lib.library_dir) / TS_FOLDER_NAME / JSON_FILENAME
|
||||
return json_path.exists()
|
||||
|
||||
@property
|
||||
def __backups_count(self):
|
||||
backups_path = unwrap(self.lib.library_dir) / TS_FOLDER_NAME / BACKUP_FOLDER_NAME
|
||||
return len(os.listdir(backups_path))
|
||||
|
||||
@property
|
||||
def __backups_size(self):
|
||||
backups_path = unwrap(self.lib.library_dir) / TS_FOLDER_NAME / BACKUP_FOLDER_NAME
|
||||
size: int = 0
|
||||
|
||||
for f in backups_path.glob("*"):
|
||||
if not f.is_dir() and f.exists():
|
||||
size += Path(f).stat().st_size
|
||||
|
||||
return size
|
||||
|
||||
@override
|
||||
def showEvent(self, event: QtGui.QShowEvent): # type: ignore
|
||||
self.refresh()
|
||||
return super().showEvent(event)
|
||||
@@ -10,7 +10,7 @@ from PySide6 import QtCore, QtGui
|
||||
from PySide6.QtCore import Qt
|
||||
from PySide6.QtWidgets import QHBoxLayout, QLabel, QVBoxLayout, QWidget
|
||||
|
||||
from tagstudio.qt.widgets.paged_panel.paged_panel_state import PagedPanelState
|
||||
from tagstudio.qt.controllers.paged_panel_state import PagedPanelState
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
|
||||
from PySide6.QtWidgets import QPushButton
|
||||
|
||||
from tagstudio.qt.widgets.paged_panel.paged_body_wrapper import PagedBodyWrapper
|
||||
from tagstudio.qt.views.paged_body_wrapper import PagedBodyWrapper
|
||||
|
||||
|
||||
class PagedPanelState:
|
||||
@@ -7,9 +7,9 @@ from warnings import catch_warnings
|
||||
from PySide6.QtWidgets import QListWidgetItem
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.qt.modals.add_field import AddFieldModal
|
||||
from tagstudio.qt.modals.tag_search import TagSearchModal
|
||||
from tagstudio.qt.view.widgets.preview_panel_view import PreviewPanelView
|
||||
from tagstudio.qt.mixed.add_field import AddFieldModal
|
||||
from tagstudio.qt.mixed.tag_search import TagSearchModal
|
||||
from tagstudio.qt.views.preview_panel_view import PreviewPanelView
|
||||
|
||||
if typing.TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -14,10 +14,10 @@ from PySide6.QtCore import QSize
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.media_types import MediaCategories
|
||||
from tagstudio.qt.helpers.file_opener import open_file
|
||||
from tagstudio.qt.helpers.file_tester import is_readable_video
|
||||
from tagstudio.qt.view.widgets.preview.preview_thumb_view import PreviewThumbView
|
||||
from tagstudio.qt.widgets.preview.file_attributes import FileAttributeData
|
||||
from tagstudio.qt.mixed.file_attributes import FileAttributeData
|
||||
from tagstudio.qt.utils.file_opener import open_file
|
||||
from tagstudio.qt.views.preview_thumb_view import PreviewThumbView
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -39,7 +39,9 @@ class PreviewThumb(PreviewThumbView):
|
||||
stats = FileAttributeData()
|
||||
ext = filepath.suffix.lower()
|
||||
|
||||
if MediaCategories.IMAGE_RAW_TYPES.contains(ext, mime_fallback=True):
|
||||
if filepath.is_dir():
|
||||
pass
|
||||
elif MediaCategories.IMAGE_RAW_TYPES.contains(ext, mime_fallback=True):
|
||||
try:
|
||||
with rawpy.imread(str(filepath)) as raw:
|
||||
rgb = raw.postprocess()
|
||||
@@ -142,7 +144,9 @@ class PreviewThumb(PreviewThumbView):
|
||||
return self.__get_image_stats(filepath)
|
||||
|
||||
def _open_file_action_callback(self):
|
||||
open_file(self.__current_file)
|
||||
open_file(
|
||||
self.__current_file, windows_start_command=self.__driver.settings.windows_start_command
|
||||
)
|
||||
|
||||
def _open_explorer_action_callback(self):
|
||||
open_file(self.__current_file, file_manager=True)
|
||||
@@ -152,4 +156,6 @@ class PreviewThumb(PreviewThumbView):
|
||||
self.__driver.delete_files_callback(self.__current_file)
|
||||
|
||||
def _button_wrapper_callback(self):
|
||||
open_file(self.__current_file)
|
||||
open_file(
|
||||
self.__current_file, windows_start_command=self.__driver.settings.windows_start_command
|
||||
)
|
||||
@@ -10,9 +10,10 @@ from PySide6.QtCore import Signal
|
||||
from tagstudio.core.enums import TagClickActionOption
|
||||
from tagstudio.core.library.alchemy.enums import BrowsingState
|
||||
from tagstudio.core.library.alchemy.models import Tag
|
||||
from tagstudio.qt.modals.build_tag import BuildTagPanel
|
||||
from tagstudio.qt.view.components.tag_box_view import TagBoxWidgetView
|
||||
from tagstudio.qt.widgets.panel import PanelModal
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
from tagstudio.qt.mixed.build_tag import BuildTagPanel
|
||||
from tagstudio.qt.views.panel_modal import PanelModal
|
||||
from tagstudio.qt.views.tag_box_view import TagBoxWidgetView
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -38,15 +39,18 @@ class TagBoxWidget(TagBoxWidgetView):
|
||||
case TagClickActionOption.OPEN_EDIT:
|
||||
self._on_edit(tag)
|
||||
case TagClickActionOption.SET_SEARCH:
|
||||
self.__driver.update_browsing_state(BrowsingState.from_tag_id(tag.id))
|
||||
self.__driver.update_browsing_state(
|
||||
BrowsingState.from_tag_id(tag.id, self.__driver.browsing_history.current)
|
||||
)
|
||||
case TagClickActionOption.ADD_TO_SEARCH:
|
||||
# NOTE: modifying the ast and then setting that would be nicer
|
||||
# than this string manipulation, but also much more complex,
|
||||
# due to needing to implement a visitor that turns an AST to a string
|
||||
# So if that exists when you read this, change the following accordingly.
|
||||
current = self.__driver.browsing_history.current
|
||||
suffix = BrowsingState.from_tag_id(tag.id).query
|
||||
assert suffix is not None
|
||||
suffix = unwrap(
|
||||
BrowsingState.from_tag_id(tag.id, self.__driver.browsing_history.current).query
|
||||
)
|
||||
self.__driver.update_browsing_state(
|
||||
current.with_search_query(
|
||||
f"{current.query} {suffix}" if current.query else suffix
|
||||
@@ -71,7 +75,7 @@ class TagBoxWidget(TagBoxWidgetView):
|
||||
|
||||
edit_modal = PanelModal(
|
||||
build_tag_panel,
|
||||
self.__driver.lib.tag_display_name(tag.id),
|
||||
self.__driver.lib.tag_display_name(tag),
|
||||
"Edit Tag",
|
||||
done_callback=self.on_update.emit,
|
||||
has_save=True,
|
||||
@@ -90,4 +94,6 @@ class TagBoxWidget(TagBoxWidgetView):
|
||||
@override
|
||||
def _on_search(self, tag: Tag) -> None: # type: ignore[misc]
|
||||
self.__driver.main_window.search_field.setText(f"tag_id:{tag.id}")
|
||||
self.__driver.update_browsing_state(BrowsingState.from_tag_id(tag.id))
|
||||
self.__driver.update_browsing_state(
|
||||
BrowsingState.from_tag_id(tag.id, self.__driver.browsing_history.current)
|
||||
)
|
||||
@@ -3,7 +3,7 @@
|
||||
|
||||
import platform
|
||||
from datetime import datetime
|
||||
from enum import Enum
|
||||
from enum import Enum, IntEnum, StrEnum
|
||||
from pathlib import Path
|
||||
from typing import override
|
||||
|
||||
@@ -13,44 +13,64 @@ from pydantic import BaseModel, Field
|
||||
|
||||
from tagstudio.core.enums import ShowFilepathOption, TagClickActionOption
|
||||
|
||||
if platform.system() == "Windows":
|
||||
DEFAULT_GLOBAL_SETTINGS_PATH = (
|
||||
Path.home() / "Appdata" / "Roaming" / "TagStudio" / "settings.toml"
|
||||
)
|
||||
else:
|
||||
DEFAULT_GLOBAL_SETTINGS_PATH = Path.home() / ".config" / "TagStudio" / "settings.toml"
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
DEFAULT_GLOBAL_SETTINGS_PATH = (
|
||||
Path.home() / "Appdata" / "Roaming" / "TagStudio" / "settings.toml"
|
||||
if platform.system() == "Windows"
|
||||
else Path.home() / ".config" / "TagStudio" / "settings.toml"
|
||||
)
|
||||
|
||||
class TomlEnumEncoder(toml.TomlEncoder):
|
||||
@override
|
||||
def dump_value(self, v):
|
||||
if isinstance(v, Enum):
|
||||
return super().dump_value(v.value)
|
||||
return super().dump_value(v)
|
||||
DEFAULT_THUMB_CACHE_SIZE = 500 # Number in MiB
|
||||
MIN_THUMB_CACHE_SIZE = 10 # Number in MiB
|
||||
|
||||
# See: https://pillow.readthedocs.io/en/stable/handbook/image-file-formats.html#webp-saving
|
||||
DEFAULT_CACHED_IMAGE_QUALITY = 80
|
||||
DEFAULT_CACHED_IMAGE_RES = 256
|
||||
|
||||
|
||||
class Theme(Enum):
|
||||
class Theme(IntEnum):
|
||||
DARK = 0
|
||||
LIGHT = 1
|
||||
SYSTEM = 2
|
||||
DEFAULT = SYSTEM
|
||||
|
||||
|
||||
class Splash(StrEnum):
|
||||
DEFAULT = "default"
|
||||
RANDOM = "random"
|
||||
CLASSIC = "classic"
|
||||
GOO_GEARS = "goo_gears"
|
||||
NINETY_FIVE = "95"
|
||||
|
||||
|
||||
class TomlEnumEncoder(toml.TomlEncoder):
|
||||
@override
|
||||
def dump_value(self, v): # pyright: ignore[reportMissingParameterType]
|
||||
if isinstance(v, Enum):
|
||||
return super().dump_value(v.value)
|
||||
return super().dump_value(v)
|
||||
|
||||
|
||||
# NOTE: pydantic also has a BaseSettings class (from pydantic-settings) that allows any settings
|
||||
# properties to be overwritten with environment variables. as tagstudio is not currently using
|
||||
# environment variables, i did not base it on that, but that may be useful in the future.
|
||||
# properties to be overwritten with environment variables. As TagStudio is not currently using
|
||||
# environment variables, this was not based on that, but that may be useful in the future.
|
||||
class GlobalSettings(BaseModel):
|
||||
language: str = Field(default="en")
|
||||
open_last_loaded_on_startup: bool = Field(default=True)
|
||||
generate_thumbs: bool = Field(default=True)
|
||||
thumb_cache_size: float = Field(default=DEFAULT_THUMB_CACHE_SIZE)
|
||||
cached_thumb_quality: int = Field(default=DEFAULT_CACHED_IMAGE_QUALITY)
|
||||
cached_thumb_resolution: int = Field(default=DEFAULT_CACHED_IMAGE_RES)
|
||||
autoplay: bool = Field(default=True)
|
||||
loop: bool = Field(default=True)
|
||||
show_filenames_in_grid: bool = Field(default=True)
|
||||
page_size: int = Field(default=100)
|
||||
show_filepath: ShowFilepathOption = Field(default=ShowFilepathOption.DEFAULT)
|
||||
theme: Theme = Field(default=Theme.SYSTEM)
|
||||
tag_click_action: TagClickActionOption = Field(default=TagClickActionOption.DEFAULT)
|
||||
theme: Theme = Field(default=Theme.SYSTEM)
|
||||
splash: Splash = Field(default=Splash.DEFAULT)
|
||||
windows_start_command: bool = Field(default=False)
|
||||
|
||||
date_format: str = Field(default="%x")
|
||||
hour_format: bool = Field(default=True)
|
||||
@@ -7,7 +7,7 @@ from PIL import Image
|
||||
from PySide6.QtCore import Qt
|
||||
from PySide6.QtGui import QGuiApplication
|
||||
|
||||
from tagstudio.qt.helpers.gradient import linear_gradient
|
||||
from tagstudio.qt.helpers.gradients import linear_gradient
|
||||
|
||||
# TODO: Consolidate the built-in QT theme values with the values
|
||||
# here, in enums.py, and in palette.py.
|
||||
|
||||
@@ -1,31 +0,0 @@
|
||||
# Copyright (C) 2025 Travis Abendshien (CyanVoxel).
|
||||
# Licensed under the GPL-3.0 License.
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
from pathlib import Path
|
||||
|
||||
import structlog
|
||||
from send2trash import send2trash
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
|
||||
def delete_file(path: str | Path) -> bool:
|
||||
"""Send a file to the system trash.
|
||||
|
||||
Args:
|
||||
path (str | Path): The path of the file to delete.
|
||||
"""
|
||||
_path = Path(path)
|
||||
try:
|
||||
logger.info(f"[delete_file] Sending to Trash: {_path}")
|
||||
send2trash(_path)
|
||||
return True
|
||||
except PermissionError as e:
|
||||
logger.error(f"[delete_file][ERROR] PermissionError: {e}")
|
||||
except FileNotFoundError:
|
||||
logger.error(f"[delete_file][ERROR] File Not Found: {_path}")
|
||||
except Exception as e:
|
||||
logger.error(e)
|
||||
return False
|
||||
@@ -7,7 +7,9 @@ from pathlib import Path
|
||||
|
||||
import ffmpeg
|
||||
|
||||
from tagstudio.qt.helpers.vendored.ffmpeg import probe
|
||||
from tagstudio.qt.previews.vendored.ffmpeg import (
|
||||
probe, # pyright: ignore[reportUnknownVariableType]
|
||||
)
|
||||
|
||||
|
||||
def is_readable_video(filepath: Path | str):
|
||||
|
||||
@@ -20,8 +20,8 @@ from PySide6.QtWidgets import (
|
||||
|
||||
from tagstudio.core.constants import VERSION, VERSION_BRANCH
|
||||
from tagstudio.core.enums import Theme
|
||||
from tagstudio.core.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.qt.helpers.vendored import ffmpeg
|
||||
from tagstudio.qt.models.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.qt.previews.vendored import ffmpeg
|
||||
from tagstudio.qt.resource_manager import ResourceManager
|
||||
from tagstudio.qt.translations import Translations
|
||||
|
||||
@@ -20,19 +20,18 @@ from PySide6.QtWidgets import (
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from tagstudio.core import palette
|
||||
from tagstudio.core.library.alchemy.enums import TagColorEnum
|
||||
from tagstudio.core.library.alchemy.library import Library, slugify
|
||||
from tagstudio.core.library.alchemy.models import TagColorGroup
|
||||
from tagstudio.core.palette import ColorType, UiColor, get_tag_color, get_ui_color
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.panel import PanelWidget
|
||||
from tagstudio.qt.widgets.tag import (
|
||||
from tagstudio.qt.mixed.tag_color_preview import TagColorPreview
|
||||
from tagstudio.qt.mixed.tag_widget import (
|
||||
get_border_color,
|
||||
get_highlight_color,
|
||||
get_text_color,
|
||||
)
|
||||
from tagstudio.qt.widgets.tag_color_preview import TagColorPreview
|
||||
from tagstudio.qt.models.palette import ColorType, UiColor, get_tag_color, get_ui_color
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.views.panel_modal import PanelWidget
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
@@ -265,7 +264,7 @@ class BuildColorPanel(PanelWidget):
|
||||
def update_secondary(self, color: QColor | None = None, color_border: bool = False):
|
||||
logger.info("[BuildColorPanel] Updating Secondary", color=color)
|
||||
|
||||
color_ = color or QColor(palette.get_tag_color(ColorType.PRIMARY, TagColorEnum.DEFAULT))
|
||||
color_ = color or QColor(get_tag_color(ColorType.PRIMARY, TagColorEnum.DEFAULT))
|
||||
|
||||
highlight_color = get_highlight_color(color_)
|
||||
text_color = get_text_color(color_, highlight_color)
|
||||
@@ -13,9 +13,9 @@ from PySide6.QtWidgets import QLabel, QLineEdit, QVBoxLayout, QWidget
|
||||
from tagstudio.core.constants import RESERVED_NAMESPACE_PREFIX
|
||||
from tagstudio.core.library.alchemy.library import Library, ReservedNamespaceError, slugify
|
||||
from tagstudio.core.library.alchemy.models import Namespace
|
||||
from tagstudio.core.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.qt.models.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.panel import PanelWidget
|
||||
from tagstudio.qt.views.panel_modal import PanelWidget
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
@@ -28,19 +28,19 @@ from PySide6.QtWidgets import (
|
||||
from tagstudio.core.library.alchemy.enums import TagColorEnum
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Tag, TagColorGroup
|
||||
from tagstudio.core.palette import ColorType, UiColor, get_tag_color, get_ui_color
|
||||
from tagstudio.qt.modals.tag_color_selection import TagColorSelection
|
||||
from tagstudio.qt.modals.tag_search import TagSearchModal
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.panel import PanelModal, PanelWidget
|
||||
from tagstudio.qt.widgets.tag import (
|
||||
from tagstudio.qt.mixed.tag_color_preview import TagColorPreview
|
||||
from tagstudio.qt.mixed.tag_color_selection import TagColorSelection
|
||||
from tagstudio.qt.mixed.tag_search import TagSearchModal, TagSearchPanel
|
||||
from tagstudio.qt.mixed.tag_widget import (
|
||||
TagWidget,
|
||||
get_border_color,
|
||||
get_highlight_color,
|
||||
get_primary_color,
|
||||
get_text_color,
|
||||
)
|
||||
from tagstudio.qt.widgets.tag_color_preview import TagColorPreview
|
||||
from tagstudio.qt.models.palette import ColorType, UiColor, get_tag_color, get_ui_color
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.views.panel_modal import PanelModal, PanelWidget
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
@@ -385,10 +385,11 @@ class BuildTagPanel(PanelWidget):
|
||||
tag_widget = TagWidget(
|
||||
tag,
|
||||
library=self.lib,
|
||||
has_edit=False,
|
||||
has_edit=True,
|
||||
has_remove=True,
|
||||
)
|
||||
tag_widget.on_remove.connect(lambda t=parent_id: self.remove_parent_tag_callback(t))
|
||||
tag_widget.on_edit.connect(lambda t=tag: TagSearchPanel(library=self.lib).edit_tag(t))
|
||||
row.addWidget(tag_widget)
|
||||
|
||||
# Add Disambiguation Tag Button
|
||||
@@ -14,6 +14,7 @@ from PySide6.QtCore import QObject, Signal
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.media_types import MediaCategories
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
from tagstudio.qt.helpers.file_tester import is_readable_video
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
@@ -35,10 +36,8 @@ class CollageIconRenderer(QObject):
|
||||
data_only_mode: bool,
|
||||
keep_aspect: bool,
|
||||
):
|
||||
entry = self.lib.get_entry(entry_id)
|
||||
lib_dir = self.lib.library_dir
|
||||
assert lib_dir is not None and entry is not None
|
||||
filepath = lib_dir / entry.path
|
||||
entry = unwrap(self.lib.get_entry(entry_id))
|
||||
filepath = unwrap(self.lib.library_dir) / entry.path
|
||||
color: str = ""
|
||||
|
||||
try:
|
||||
@@ -13,16 +13,16 @@ from PySide6.QtWidgets import QMessageBox, QPushButton
|
||||
from tagstudio.core.constants import RESERVED_NAMESPACE_PREFIX
|
||||
from tagstudio.core.library.alchemy.enums import TagColorEnum
|
||||
from tagstudio.core.library.alchemy.models import TagColorGroup
|
||||
from tagstudio.core.palette import ColorType, get_tag_color
|
||||
from tagstudio.qt.flowlayout import FlowLayout
|
||||
from tagstudio.qt.modals.build_color import BuildColorPanel
|
||||
from tagstudio.qt.mixed.build_color import BuildColorPanel
|
||||
from tagstudio.qt.mixed.field_widget import FieldWidget
|
||||
from tagstudio.qt.mixed.tag_color_label import TagColorLabel
|
||||
from tagstudio.qt.models.palette import ColorType, get_tag_color
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.fields import FieldWidget
|
||||
from tagstudio.qt.widgets.panel import PanelModal
|
||||
from tagstudio.qt.widgets.tag_color_label import TagColorLabel
|
||||
from tagstudio.qt.views.layouts.flow_layout import FlowLayout
|
||||
from tagstudio.qt.views.panel_modal import PanelModal
|
||||
|
||||
if typing.TYPE_CHECKING:
|
||||
from tagstudio.core.library import Library
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
@@ -6,7 +6,7 @@ from typing import cast
|
||||
from PySide6.QtCore import QDateTime
|
||||
from PySide6.QtWidgets import QDateTimeEdit, QVBoxLayout
|
||||
|
||||
from tagstudio.qt.widgets.panel import PanelWidget
|
||||
from tagstudio.qt.views.panel_modal import PanelWidget
|
||||
|
||||
if typing.TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -21,8 +21,8 @@ from PySide6.QtWidgets import (
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from tagstudio.qt.mixed.progress_bar import ProgressWidget
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.progress import ProgressWidget
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -24,22 +24,23 @@ from PySide6.QtWidgets import (
|
||||
|
||||
from tagstudio.core.constants import TAG_ARCHIVED, TAG_FAVORITE
|
||||
from tagstudio.core.enums import Theme
|
||||
from tagstudio.core.library.alchemy.enums import FieldTypeEnum
|
||||
from tagstudio.core.library.alchemy.fields import (
|
||||
BaseField,
|
||||
DatetimeField,
|
||||
FieldTypeEnum,
|
||||
TextField,
|
||||
)
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Entry, Tag
|
||||
from tagstudio.qt.controller.components.tag_box_controller import TagBoxWidget
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
from tagstudio.qt.controllers.tag_box_controller import TagBoxWidget
|
||||
from tagstudio.qt.mixed.datetime_picker import DatetimePicker
|
||||
from tagstudio.qt.mixed.field_widget import FieldContainer
|
||||
from tagstudio.qt.mixed.text_field import TextWidget
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.datetime_picker import DatetimePicker
|
||||
from tagstudio.qt.widgets.fields import FieldContainer
|
||||
from tagstudio.qt.widgets.panel import PanelModal
|
||||
from tagstudio.qt.widgets.text import TextWidget
|
||||
from tagstudio.qt.widgets.text_box_edit import EditTextBox
|
||||
from tagstudio.qt.widgets.text_line_edit import EditTextLine
|
||||
from tagstudio.qt.views.edit_text_box_modal import EditTextBox
|
||||
from tagstudio.qt.views.edit_text_line_modal import EditTextLine
|
||||
from tagstudio.qt.views.panel_modal import PanelModal
|
||||
|
||||
if typing.TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -110,8 +111,7 @@ class FieldContainers(QWidget):
|
||||
"""Update tags and fields from a single Entry source."""
|
||||
logger.warning("[FieldContainers] Updating Selection", entry_id=entry_id)
|
||||
|
||||
entry = self.lib.get_entry_full(entry_id)
|
||||
assert entry is not None
|
||||
entry = unwrap(self.lib.get_entry_full(entry_id))
|
||||
self.cached_entries = [entry]
|
||||
self.update_granular(entry.tags, entry.fields, update_badges)
|
||||
|
||||
@@ -160,98 +160,49 @@ class FieldContainers(QWidget):
|
||||
c.setHidden(True)
|
||||
|
||||
def get_tag_categories(self, tags: set[Tag]) -> dict[Tag | None, set[Tag]]:
|
||||
"""Get a dictionary of category tags mapped to their respective tags."""
|
||||
cats: dict[Tag | None, set[Tag]] = {}
|
||||
cats[None] = set()
|
||||
"""Get a dictionary of category tags mapped to their respective tags.
|
||||
|
||||
base_tag_ids: set[int] = {x.id for x in tags}
|
||||
exhausted: set[int] = set()
|
||||
cluster_map: dict[int, set[int]] = {}
|
||||
Example:
|
||||
Tag: ["Johnny Bravo", Parent Tags: "Cartoon Network (TV)", "Character"] maps to:
|
||||
"Cartoon Network" -> Johnny Bravo,
|
||||
"Character" -> "Johnny Bravo",
|
||||
"TV" -> Johnny Bravo"
|
||||
"""
|
||||
loop_cutoff = 1024 # Used for stopping the while loop
|
||||
|
||||
def add_to_cluster(tag_id: int, p_ids: list[int] | None = None):
|
||||
"""Maps a Tag's child tags' IDs back to it's parent tag's ID.
|
||||
hierarchy_tags = self.lib.get_tag_hierarchy(t.id for t in tags)
|
||||
categories: dict[Tag | None, set[Tag]] = {None: set()}
|
||||
|
||||
Example:
|
||||
Tag: ["Johnny Bravo", Parent Tags: "Cartoon Network (TV)", "Character"] maps to:
|
||||
"Cartoon Network" -> Johnny Bravo,
|
||||
"Character" -> "Johnny Bravo",
|
||||
"TV" -> Johnny Bravo"
|
||||
"""
|
||||
tag_obj = self.lib.get_tag(tag_id) # Get full object
|
||||
if p_ids is None:
|
||||
assert tag_obj is not None
|
||||
p_ids = tag_obj.parent_ids
|
||||
|
||||
for p_id in p_ids:
|
||||
if cluster_map.get(p_id) is None:
|
||||
cluster_map[p_id] = set()
|
||||
# If the p_tag has p_tags of its own, recursively link those to the original Tag.
|
||||
if tag_id not in cluster_map[p_id]:
|
||||
cluster_map[p_id].add(tag_id)
|
||||
p_tag = self.lib.get_tag(p_id) # Get full object
|
||||
assert p_tag is not None
|
||||
if p_tag.parent_ids:
|
||||
add_to_cluster(
|
||||
tag_id,
|
||||
[sub_id for sub_id in p_tag.parent_ids if sub_id != tag_id],
|
||||
)
|
||||
exhausted.add(p_id)
|
||||
exhausted.add(tag_id)
|
||||
|
||||
for tag in tags:
|
||||
add_to_cluster(tag.id)
|
||||
|
||||
logger.info("[FieldContainers] Entry Cluster", entry_cluster=exhausted)
|
||||
logger.info("[FieldContainers] Cluster Map", cluster_map=cluster_map)
|
||||
|
||||
# Initialize all categories from parents.
|
||||
tags_ = {t for tid in exhausted if (t := self.lib.get_tag(tid)) is not None}
|
||||
for tag in tags_:
|
||||
for tag in hierarchy_tags.values():
|
||||
if tag.is_category:
|
||||
cats[tag] = set()
|
||||
logger.info("[FieldContainers] Blank Tag Categories", cats=cats)
|
||||
categories[tag] = set()
|
||||
for tag in tags:
|
||||
tag = hierarchy_tags[tag.id]
|
||||
has_category_parent = False
|
||||
parent_tags = tag.parent_tags
|
||||
|
||||
# Add tags to any applicable categories.
|
||||
added_ids: set[int] = set()
|
||||
for key in cats:
|
||||
logger.info("[FieldContainers] Checking category tag key", key=key)
|
||||
loop_counter = 0
|
||||
while len(parent_tags) > 0:
|
||||
# NOTE: This is for preventing infinite loops in the event a tag is parented
|
||||
# to itself cyclically.
|
||||
loop_counter += 1
|
||||
if loop_counter >= loop_cutoff:
|
||||
break
|
||||
|
||||
if key:
|
||||
logger.info(
|
||||
"[FieldContainers] Key cluster:", key=key, cluster=cluster_map.get(key.id)
|
||||
)
|
||||
grandparent_tags: set[Tag] = set()
|
||||
for parent_tag in parent_tags:
|
||||
if parent_tag in categories:
|
||||
categories[parent_tag].add(tag)
|
||||
has_category_parent = True
|
||||
grandparent_tags.update(parent_tag.parent_tags)
|
||||
parent_tags = grandparent_tags
|
||||
|
||||
if final_tags := cluster_map.get(key.id, set()).union([key.id]):
|
||||
cats[key] = {
|
||||
t
|
||||
for tid in final_tags
|
||||
if tid in base_tag_ids and (t := self.lib.get_tag(tid)) is not None
|
||||
}
|
||||
added_ids = added_ids.union({tid for tid in final_tags if tid in base_tag_ids})
|
||||
if tag.is_category:
|
||||
categories[tag].add(tag)
|
||||
elif not has_category_parent:
|
||||
categories[None].add(tag)
|
||||
|
||||
# Add remaining tags to None key (general case).
|
||||
cats[None] = {
|
||||
t
|
||||
for tid in base_tag_ids
|
||||
if tid not in added_ids and (t := self.lib.get_tag(tid)) is not None
|
||||
}
|
||||
logger.info(
|
||||
"[FieldContainers] Key cluster: None, general case!",
|
||||
general_tags=cats[None],
|
||||
added=added_ids,
|
||||
base_tag_ids=base_tag_ids,
|
||||
)
|
||||
|
||||
# Remove unused categories
|
||||
empty: list[Tag | None] = []
|
||||
for k, v in list(cats.items()):
|
||||
if not v:
|
||||
empty.append(k)
|
||||
for key in empty:
|
||||
cats.pop(key, None)
|
||||
|
||||
logger.info("[FieldContainers] Tag Categories", categories=cats)
|
||||
return cats
|
||||
return dict((c, d) for c, d in categories.items() if len(d) > 0)
|
||||
|
||||
def remove_field_prompt(self, name: str) -> str:
|
||||
return Translations.format("library.field.confirm_remove", name=name)
|
||||
@@ -285,11 +236,10 @@ class FieldContainers(QWidget):
|
||||
selected=self.driver.selected,
|
||||
tags=tags,
|
||||
)
|
||||
for entry_id in self.driver.selected:
|
||||
self.lib.add_tags_to_entries(
|
||||
entry_id,
|
||||
tag_ids=tags,
|
||||
)
|
||||
self.lib.add_tags_to_entries(
|
||||
self.driver.selected,
|
||||
tag_ids=tags,
|
||||
)
|
||||
self.emit_badge_signals(tags, emit_on_absent=False)
|
||||
|
||||
def write_container(self, index: int, field: BaseField, is_mixed: bool = False):
|
||||
@@ -20,9 +20,12 @@ from PySide6.QtWidgets import QLabel, QVBoxLayout, QWidget
|
||||
|
||||
from tagstudio.core.enums import ShowFilepathOption, Theme
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.ignore import Ignore
|
||||
from tagstudio.core.media_types import MediaCategories
|
||||
from tagstudio.qt.helpers.file_opener import FileOpenerHelper, FileOpenerLabel
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
from tagstudio.qt.models.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.utils.file_opener import FileOpenerHelper, FileOpenerLabel
|
||||
|
||||
if typing.TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -154,13 +157,11 @@ class FileAttributes(QWidget):
|
||||
self.dimensions_label.setHidden(True)
|
||||
else:
|
||||
ext = filepath.suffix.lower()
|
||||
self.library_path = self.library.library_dir
|
||||
display_path = filepath
|
||||
if self.driver.settings.show_filepath == ShowFilepathOption.SHOW_FULL_PATHS:
|
||||
display_path = filepath
|
||||
elif self.driver.settings.show_filepath == ShowFilepathOption.SHOW_RELATIVE_PATHS:
|
||||
assert self.library_path is not None
|
||||
display_path = Path(filepath).relative_to(self.library_path)
|
||||
display_path = Path(filepath).relative_to(unwrap(self.library.library_dir))
|
||||
elif self.driver.settings.show_filepath == ShowFilepathOption.SHOW_FILENAMES_ONLY:
|
||||
display_path = Path(filepath.name)
|
||||
|
||||
@@ -191,7 +192,7 @@ class FileAttributes(QWidget):
|
||||
|
||||
# Attempt to populate the stat variables
|
||||
ext_display = ext.upper()[1:] or filepath.stem.upper()
|
||||
if filepath:
|
||||
if filepath and filepath.is_file():
|
||||
try:
|
||||
file_size = format_size(filepath.stat().st_size)
|
||||
|
||||
@@ -207,12 +208,29 @@ class FileAttributes(QWidget):
|
||||
|
||||
# Format and display any stat variables
|
||||
def add_newline(stats_label_text: str) -> str:
|
||||
if stats_label_text and stats_label_text[-2:] != "\n":
|
||||
return stats_label_text + "\n"
|
||||
if stats_label_text and stats_label_text[-4:] != "<br>":
|
||||
return stats_label_text + "<br>"
|
||||
return stats_label_text
|
||||
|
||||
if ext_display:
|
||||
stats_label_text += ext_display
|
||||
red = get_ui_color(ColorType.PRIMARY, UiColor.RED)
|
||||
orange = get_ui_color(ColorType.PRIMARY, UiColor.ORANGE)
|
||||
|
||||
if Ignore.compiled_patterns and Ignore.compiled_patterns.match(
|
||||
filepath.relative_to(unwrap(self.library.library_dir))
|
||||
):
|
||||
stats_label_text = (
|
||||
f"{stats_label_text}"
|
||||
f" • <span style='color:{orange}'>"
|
||||
f"{Translations['preview.ignored'].upper()}</span>"
|
||||
)
|
||||
if not filepath.exists():
|
||||
stats_label_text = (
|
||||
f"{stats_label_text}"
|
||||
f" • <span style='color:{red}'>"
|
||||
f"{Translations['preview.unlinked'].upper()}</span>"
|
||||
)
|
||||
if file_size:
|
||||
stats_label_text += f" • {file_size}"
|
||||
elif file_size:
|
||||
@@ -17,8 +17,8 @@ from PySide6.QtWidgets import (
|
||||
)
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.utils.dupe_files import DupeRegistry
|
||||
from tagstudio.qt.modals.mirror_entities import MirrorEntriesModal
|
||||
from tagstudio.core.library.alchemy.registries.dupe_files_registry import DupeFilesRegistry
|
||||
from tagstudio.qt.mixed.mirror_entries_modal import MirrorEntriesModal
|
||||
from tagstudio.qt.translations import Translations
|
||||
|
||||
# Only import for type checking/autocompletion, will not be imported at runtime.
|
||||
@@ -26,6 +26,7 @@ if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
|
||||
|
||||
# TODO: Break up into MVC classes, similar to fix_ignored_modal
|
||||
class FixDupeFilesModal(QWidget):
|
||||
def __init__(self, library: "Library", driver: "QtDriver"):
|
||||
super().__init__()
|
||||
@@ -39,7 +40,7 @@ class FixDupeFilesModal(QWidget):
|
||||
self.root_layout = QVBoxLayout(self)
|
||||
self.root_layout.setContentsMargins(6, 6, 6, 6)
|
||||
|
||||
self.tracker = DupeRegistry(library=self.lib)
|
||||
self.tracker = DupeFilesRegistry(library=self.lib)
|
||||
|
||||
self.desc_widget = QLabel(Translations["file.duplicates.description"])
|
||||
self.desc_widget.setObjectName("descriptionLabel")
|
||||
@@ -10,27 +10,28 @@ from PySide6.QtCore import Qt
|
||||
from PySide6.QtWidgets import QHBoxLayout, QLabel, QPushButton, QVBoxLayout, QWidget
|
||||
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.utils.missing_files import MissingRegistry
|
||||
from tagstudio.qt.modals.delete_unlinked import DeleteUnlinkedEntriesModal
|
||||
from tagstudio.qt.modals.merge_dupe_entries import MergeDuplicateEntries
|
||||
from tagstudio.qt.modals.relink_unlinked import RelinkUnlinkedEntries
|
||||
from tagstudio.core.library.alchemy.registries.unlinked_registry import UnlinkedRegistry
|
||||
from tagstudio.qt.mixed.merge_dupe_entries import MergeDuplicateEntries
|
||||
from tagstudio.qt.mixed.progress_bar import ProgressWidget
|
||||
from tagstudio.qt.mixed.relink_entries_modal import RelinkUnlinkedEntries
|
||||
from tagstudio.qt.mixed.remove_unlinked_modal import RemoveUnlinkedEntriesModal
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.progress import ProgressWidget
|
||||
|
||||
# Only import for type checking/autocompletion, will not be imported at runtime.
|
||||
if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
|
||||
|
||||
# TODO: Break up into MVC classes, similar to fix_ignored_modal
|
||||
class FixUnlinkedEntriesModal(QWidget):
|
||||
def __init__(self, library: "Library", driver: "QtDriver"):
|
||||
super().__init__()
|
||||
self.lib = library
|
||||
self.driver = driver
|
||||
|
||||
self.tracker = MissingRegistry(library=self.lib)
|
||||
self.tracker = UnlinkedRegistry(lib=self.lib)
|
||||
|
||||
self.missing_count = -1
|
||||
self.unlinked_count = -1
|
||||
self.dupe_count = -1
|
||||
self.setWindowTitle(Translations["entries.unlinked.title"])
|
||||
self.setWindowModality(Qt.WindowModality.ApplicationModal)
|
||||
@@ -43,18 +44,16 @@ class FixUnlinkedEntriesModal(QWidget):
|
||||
self.unlinked_desc_widget.setWordWrap(True)
|
||||
self.unlinked_desc_widget.setStyleSheet("text-align:left;")
|
||||
|
||||
self.missing_count_label = QLabel()
|
||||
self.missing_count_label.setObjectName("missingCountLabel")
|
||||
self.missing_count_label.setStyleSheet("font-weight:bold;font-size:14px;")
|
||||
self.missing_count_label.setAlignment(Qt.AlignmentFlag.AlignCenter)
|
||||
self.unlinked_count_label = QLabel()
|
||||
self.unlinked_count_label.setObjectName("unlinkedCountLabel")
|
||||
self.unlinked_count_label.setAlignment(Qt.AlignmentFlag.AlignCenter)
|
||||
|
||||
self.dupe_count_label = QLabel()
|
||||
self.dupe_count_label.setObjectName("dupeCountLabel")
|
||||
self.dupe_count_label.setStyleSheet("font-weight:bold;font-size:14px;")
|
||||
self.dupe_count_label.setAlignment(Qt.AlignmentFlag.AlignCenter)
|
||||
|
||||
self.refresh_unlinked_button = QPushButton(Translations["entries.unlinked.refresh_all"])
|
||||
self.refresh_unlinked_button.clicked.connect(self.refresh_missing_files)
|
||||
self.refresh_unlinked_button = QPushButton(Translations["entries.generic.refresh_alt"])
|
||||
self.refresh_unlinked_button.clicked.connect(self.refresh_unlinked)
|
||||
|
||||
self.merge_class = MergeDuplicateEntries(self.lib, self.driver)
|
||||
self.relink_class = RelinkUnlinkedEntries(self.tracker)
|
||||
@@ -64,7 +63,7 @@ class FixUnlinkedEntriesModal(QWidget):
|
||||
# refresh the grid
|
||||
lambda: (
|
||||
self.driver.update_browsing_state(),
|
||||
self.refresh_missing_files(),
|
||||
self.refresh_unlinked(),
|
||||
)
|
||||
)
|
||||
self.search_button.clicked.connect(self.relink_class.repair_entries)
|
||||
@@ -72,16 +71,17 @@ class FixUnlinkedEntriesModal(QWidget):
|
||||
self.manual_button = QPushButton(Translations["entries.unlinked.relink.manual"])
|
||||
self.manual_button.setHidden(True)
|
||||
|
||||
self.delete_button = QPushButton(Translations["entries.unlinked.delete_alt"])
|
||||
self.delete_modal = DeleteUnlinkedEntriesModal(self.driver, self.tracker)
|
||||
self.delete_modal.done.connect(
|
||||
self.remove_button = QPushButton(Translations["entries.unlinked.remove_alt"])
|
||||
self.remove_modal = RemoveUnlinkedEntriesModal(self.driver, self.tracker)
|
||||
self.remove_modal.done.connect(
|
||||
lambda: (
|
||||
self.set_missing_count(),
|
||||
self.set_unlinked_count(),
|
||||
# refresh the grid
|
||||
self.driver.update_browsing_state(),
|
||||
self.refresh_unlinked(),
|
||||
)
|
||||
)
|
||||
self.delete_button.clicked.connect(self.delete_modal.show)
|
||||
self.remove_button.clicked.connect(self.remove_modal.show)
|
||||
|
||||
self.button_container = QWidget()
|
||||
self.button_layout = QHBoxLayout(self.button_container)
|
||||
@@ -93,19 +93,19 @@ class FixUnlinkedEntriesModal(QWidget):
|
||||
self.done_button.clicked.connect(self.hide)
|
||||
self.button_layout.addWidget(self.done_button)
|
||||
|
||||
self.root_layout.addWidget(self.missing_count_label)
|
||||
self.root_layout.addWidget(self.unlinked_count_label)
|
||||
self.root_layout.addWidget(self.unlinked_desc_widget)
|
||||
self.root_layout.addWidget(self.refresh_unlinked_button)
|
||||
self.root_layout.addWidget(self.search_button)
|
||||
self.root_layout.addWidget(self.manual_button)
|
||||
self.root_layout.addWidget(self.delete_button)
|
||||
self.root_layout.addWidget(self.remove_button)
|
||||
self.root_layout.addStretch(1)
|
||||
self.root_layout.addStretch(2)
|
||||
self.root_layout.addWidget(self.button_container)
|
||||
|
||||
self.set_missing_count(self.missing_count)
|
||||
self.update_unlinked_count()
|
||||
|
||||
def refresh_missing_files(self):
|
||||
def refresh_unlinked(self):
|
||||
pw = ProgressWidget(
|
||||
cancel_button_text=None,
|
||||
minimum=0,
|
||||
@@ -114,30 +114,47 @@ class FixUnlinkedEntriesModal(QWidget):
|
||||
pw.setWindowTitle(Translations["library.scan_library.title"])
|
||||
pw.update_label(Translations["entries.unlinked.scanning"])
|
||||
|
||||
def update_driver_widgets():
|
||||
if (
|
||||
hasattr(self.driver, "library_info_window")
|
||||
and self.driver.library_info_window.isVisible()
|
||||
):
|
||||
self.driver.library_info_window.update_cleanup()
|
||||
|
||||
pw.from_iterable_function(
|
||||
self.tracker.refresh_missing_files,
|
||||
self.tracker.refresh_unlinked_files,
|
||||
None,
|
||||
self.set_missing_count,
|
||||
self.delete_modal.refresh_list,
|
||||
self.set_unlinked_count,
|
||||
self.update_unlinked_count,
|
||||
self.remove_modal.refresh_list,
|
||||
update_driver_widgets,
|
||||
)
|
||||
|
||||
def set_missing_count(self, count: int | None = None):
|
||||
if count is not None:
|
||||
self.missing_count = count
|
||||
else:
|
||||
self.missing_count = self.tracker.missing_file_entries_count
|
||||
def set_unlinked_count(self):
|
||||
"""Sets the unlinked_entries_count in the Library to the tracker's value."""
|
||||
self.lib.unlinked_entries_count = self.tracker.unlinked_entries_count
|
||||
|
||||
if self.missing_count < 0:
|
||||
self.search_button.setDisabled(True)
|
||||
self.delete_button.setDisabled(True)
|
||||
self.missing_count_label.setText(Translations["entries.unlinked.missing_count.none"])
|
||||
else:
|
||||
# disable buttons if there are no files to fix
|
||||
self.search_button.setDisabled(self.missing_count == 0)
|
||||
self.delete_button.setDisabled(self.missing_count == 0)
|
||||
self.missing_count_label.setText(
|
||||
Translations.format("entries.unlinked.missing_count.some", count=self.missing_count)
|
||||
)
|
||||
def update_unlinked_count(self):
|
||||
"""Updates the UI to reflect the Library's current unlinked_entries_count."""
|
||||
# Indicates that the library is new compared to the last update.
|
||||
# NOTE: Make sure set_unlinked_count() is called before this!
|
||||
if self.tracker.unlinked_entries_count > 0 and self.lib.unlinked_entries_count < 0:
|
||||
self.tracker.reset()
|
||||
|
||||
count: int = self.lib.unlinked_entries_count
|
||||
|
||||
self.search_button.setDisabled(count < 1)
|
||||
self.remove_button.setDisabled(count < 1)
|
||||
|
||||
count_text: str = Translations.format(
|
||||
"entries.unlinked.unlinked_count", count=count if count >= 0 else "—"
|
||||
)
|
||||
self.unlinked_count_label.setText(f"<h3>{count_text}</h3>")
|
||||
|
||||
@override
|
||||
def showEvent(self, event: QtGui.QShowEvent) -> None:
|
||||
self.update_unlinked_count()
|
||||
return super().showEvent(event)
|
||||
|
||||
@override
|
||||
def keyPressEvent(self, event: QtGui.QKeyEvent) -> None: # noqa N802
|
||||
@@ -20,14 +20,16 @@ from PySide6.QtWidgets import (
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
from typing_extensions import deprecated
|
||||
|
||||
from tagstudio.core.constants import TAG_ARCHIVED, TAG_FAVORITE
|
||||
from tagstudio.core.library.alchemy.enums import TagColorEnum
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.library.alchemy.models import Tag
|
||||
from tagstudio.core.palette import ColorType, get_tag_color
|
||||
from tagstudio.qt.flowlayout import FlowLayout
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
from tagstudio.qt.models.palette import ColorType, get_tag_color
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.views.layouts.flow_layout import FlowLayout
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -55,6 +57,7 @@ def add_folders_to_tree(library: Library, tree: BranchData, items: tuple[str, ..
|
||||
return branch
|
||||
|
||||
|
||||
@deprecated("Will be replaced with upcoming 'Macros' feature before v9.6")
|
||||
def folders_to_tags(library: Library):
|
||||
logger.info("Converting folders to Tags")
|
||||
tree = BranchData()
|
||||
@@ -93,8 +96,7 @@ def reverse_tag(library: Library, tag: Tag, items: list[Tag] | None) -> list[Tag
|
||||
parent_tag = None # to avoid subtag unbound error
|
||||
for parent_tag_id in tag.parent_ids:
|
||||
parent_tag = library.get_tag(parent_tag_id)
|
||||
assert parent_tag is not None
|
||||
return reverse_tag(library, parent_tag, items)
|
||||
return reverse_tag(library, unwrap(parent_tag), items)
|
||||
|
||||
|
||||
# =========== UI ===========
|
||||
@@ -274,8 +276,7 @@ class TreeItem(QWidget):
|
||||
|
||||
self.label = QLabel()
|
||||
self.tag_layout.addWidget(self.label)
|
||||
assert data.tag is not None and parent_tag is not None
|
||||
self.tag_widget = ModifiedTagWidget(data.tag, parent_tag)
|
||||
self.tag_widget = ModifiedTagWidget(unwrap(data.tag), unwrap(parent_tag))
|
||||
self.tag_widget.bg_button.clicked.connect(lambda: self.hide_show())
|
||||
self.tag_layout.addWidget(self.tag_widget)
|
||||
|
||||
@@ -13,25 +13,19 @@ import structlog
|
||||
from PIL import Image, ImageQt
|
||||
from PySide6.QtCore import QEvent, QMimeData, QSize, Qt, QUrl
|
||||
from PySide6.QtGui import QAction, QDrag, QEnterEvent, QGuiApplication, QMouseEvent, QPixmap
|
||||
from PySide6.QtWidgets import (
|
||||
QBoxLayout,
|
||||
QCheckBox,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
from PySide6.QtWidgets import QBoxLayout, QCheckBox, QHBoxLayout, QLabel, QVBoxLayout, QWidget
|
||||
|
||||
from tagstudio.core.constants import TAG_ARCHIVED, TAG_FAVORITE
|
||||
from tagstudio.core.library.alchemy.enums import ItemType
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.media_types import MediaCategories, MediaType
|
||||
from tagstudio.qt.flowlayout import FlowWidget
|
||||
from tagstudio.qt.helpers.file_opener import FileOpenerHelper
|
||||
from tagstudio.core.utils.types import unwrap
|
||||
from tagstudio.qt.platform_strings import open_file_str, trash_term
|
||||
from tagstudio.qt.previews.renderer import ThumbRenderer
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.thumb_button import ThumbButton
|
||||
from tagstudio.qt.widgets.thumb_renderer import ThumbRenderer
|
||||
from tagstudio.qt.utils.file_opener import FileOpenerHelper
|
||||
from tagstudio.qt.views.layouts.flow_layout import FlowWidget
|
||||
from tagstudio.qt.views.thumb_button import ThumbButton
|
||||
|
||||
if TYPE_CHECKING:
|
||||
from tagstudio.qt.ts_qt import QtDriver
|
||||
@@ -201,7 +195,7 @@ class ItemThumb(FlowWidget):
|
||||
self.thumb_layout.addWidget(self.bottom_container)
|
||||
|
||||
self.thumb_button = ThumbButton(self.thumb_container, thumb_size)
|
||||
self.renderer = ThumbRenderer(self.lib)
|
||||
self.renderer = ThumbRenderer(driver, self.lib)
|
||||
self.renderer.updated.connect(
|
||||
lambda timestamp, image, size, filename: (
|
||||
self.update_thumb(image, timestamp),
|
||||
@@ -538,8 +532,7 @@ class ItemThumb(FlowWidget):
|
||||
if not entry:
|
||||
continue
|
||||
|
||||
assert self.lib.library_dir is not None
|
||||
url = QUrl.fromLocalFile(Path(self.lib.library_dir) / entry.path)
|
||||
url = QUrl.fromLocalFile(Path(unwrap(self.lib.library_dir)) / entry.path)
|
||||
paths.append(url)
|
||||
|
||||
mimedata.setUrls(paths)
|
||||
@@ -15,7 +15,7 @@ from PySide6.QtWidgets import QLabel, QPushButton, QVBoxLayout, QWidget
|
||||
|
||||
from tagstudio.qt.helpers.color_overlay import gradient_overlay, theme_fg_overlay
|
||||
from tagstudio.qt.translations import Translations
|
||||
from tagstudio.qt.widgets.clickable_label import ClickableLabel
|
||||
from tagstudio.qt.views.clickable_label import ClickableLabel
|
||||
|
||||
# Only import for type checking/autocompletion, will not be imported at runtime.
|
||||
if typing.TYPE_CHECKING:
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user