mirror of
https://github.com/TagStudioDev/TagStudio.git
synced 2026-05-05 12:03:42 +00:00
Compare commits
23 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
aa9917de9e | ||
|
|
3d62e592f7 | ||
|
|
70fa866b8d | ||
|
899c534467 | ||
|
74383e3c3c | ||
|
660a87bb94 | ||
|
|
89cf2b22e4 | ||
|
|
133092cd05 | ||
|
|
94ac83768a | ||
|
|
61ca3cb32a | ||
|
|
0e7a2dfd3d | ||
|
|
d00546d5fe | ||
|
|
969b1674f0 | ||
|
|
00001bbf0b | ||
|
|
df064ad104 | ||
|
|
31d205a869 | ||
|
|
a55d9a6a67 | ||
|
|
2c5c98c86c | ||
|
|
8cef5e5749 | ||
|
|
32a2b47c4c | ||
|
|
7a44ef156d | ||
|
|
f2454c4a9a | ||
|
537ecb2a55 |
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.
|
||||
|
||||
@@ -207,6 +211,14 @@ Don't forget to rebuild!
|
||||
|
||||
## Third-Party Dependencies
|
||||
|
||||
<!-- prettier-ignore -->
|
||||
!!! tip
|
||||
You can check to see if any of 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.
|
||||
### 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,272 @@
|
||||
# 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]**
|
||||
- [ ] 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] 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.5.4]**
|
||||
- [ ] 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] 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]**
|
||||
- [ ] 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]**
|
||||
- [ ] 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.4]**
|
||||
- [ ] Versioning System :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.4]**
|
||||
- [ ] Triggers **[v9.5.4]**
|
||||
- [ ] 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.4]**
|
||||
- [ ] 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.6.0]**
|
||||
- [ ] 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.6.0]**
|
||||
- [ ] 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,11 +1,19 @@
|
||||
# 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
|
||||
|
||||
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 | 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 |
|
||||
@@ -16,11 +24,21 @@ Replaced by the new SQLite format introduced in TagStudio [v9.5.0 Pre-Release 1]
|
||||
|
||||
---
|
||||
|
||||
## DB_VERSION 6
|
||||
## 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 and stored inside a `DB_VERSION` attribute inside the SQLite file.
|
||||
|
||||
### 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 | 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 |
|
||||
| [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 |
|
||||
|
||||
The first public version of the SQLite save file format.
|
||||
|
||||
@@ -28,22 +46,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 |
|
||||
| [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 |
|
||||
|
||||
- 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 |
|
||||
| [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 |
|
||||
|
||||
- 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 +69,23 @@ 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) | [v9.5.3](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.3) | 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 | 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 |
|
||||
| [v9.5.4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.4) | _Current_ | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
|
||||
|
||||
- Adds the `filename` column to the `entries` table. Used for sorting entries by filename in search results.
|
||||
- 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, which have erroneously been flipped since the first SQLite DB version.
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
# Usage
|
||||
---
|
||||
icon: material/mouse
|
||||
---
|
||||
|
||||
# :material-mouse: Usage
|
||||
|
||||
## Creating/Opening a Library
|
||||
|
||||
|
||||
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.python313;
|
||||
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,11 +52,23 @@ 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 = [
|
||||
@@ -65,6 +76,7 @@ python3Packages.buildPythonApplication {
|
||||
"pillow"
|
||||
"pillow-heif"
|
||||
"pillow-jxl-plugin"
|
||||
"pyside6"
|
||||
"structlog"
|
||||
"typing-extensions"
|
||||
];
|
||||
@@ -74,6 +86,7 @@ python3Packages.buildPythonApplication {
|
||||
dependencies =
|
||||
with python3Packages;
|
||||
[
|
||||
audioop-lts
|
||||
chardet
|
||||
ffmpeg-python
|
||||
humanfriendly
|
||||
@@ -88,15 +101,16 @@ python3Packages.buildPythonApplication {
|
||||
rawpy
|
||||
send2trash
|
||||
sqlalchemy
|
||||
srctools
|
||||
structlog
|
||||
toml
|
||||
ujson
|
||||
vtf2img
|
||||
wcmatch
|
||||
]
|
||||
++ lib.optional withJXLSupport pillow-jxl-plugin;
|
||||
|
||||
disabledTests = [
|
||||
# INFO: These tests require modifications to a library, which does not work
|
||||
# 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"
|
||||
@@ -121,7 +135,7 @@ python3Packages.buildPythonApplication {
|
||||
"test_update_selection_multiple"
|
||||
"test_update_selection_single"
|
||||
|
||||
# INFO: This test requires modification of a configuration file.
|
||||
# This test requires modification of a configuration file.
|
||||
"test_filepath_setting"
|
||||
];
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -8,8 +8,9 @@ description = "A User-Focused Photo & File Management System."
|
||||
version = "9.5.3"
|
||||
license = "GPL-3.0-only"
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.12,<3.13"
|
||||
requires-python = ">=3.12,<3.14"
|
||||
dependencies = [
|
||||
"audioop-lts; python_version >= '3.13'",
|
||||
"chardet~=5.2",
|
||||
"ffmpeg-python~=0.2",
|
||||
"humanfriendly==10.*",
|
||||
@@ -30,6 +31,7 @@ dependencies = [
|
||||
"toml~=0.10",
|
||||
"typing_extensions~=4.13",
|
||||
"ujson~=5.10",
|
||||
"wcmatch==10.*",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
|
||||
@@ -9,6 +9,7 @@ VERSION_BRANCH: str = "" # Usually "" or "Pre-Release"
|
||||
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 = (
|
||||
|
||||
@@ -79,9 +79,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,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)
|
||||
|
||||
@@ -12,7 +12,7 @@ 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
|
||||
|
||||
@@ -92,6 +92,9 @@ if TYPE_CHECKING:
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
|
||||
DB_VERSION_KEY: str = "DB_VERSION"
|
||||
DB_VERSION: int = 100
|
||||
|
||||
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 (
|
||||
@@ -272,8 +275,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(
|
||||
@@ -364,7 +367,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",
|
||||
@@ -376,13 +379,21 @@ class Library:
|
||||
# dont check db version when creating new library
|
||||
if not is_new:
|
||||
db_result = session.scalar(
|
||||
select(Preferences).where(Preferences.key == LibraryPrefs.DB_VERSION.name)
|
||||
select(Preferences).where(Preferences.key == DB_VERSION_KEY)
|
||||
)
|
||||
if db_result:
|
||||
db_version = db_result.value
|
||||
assert isinstance(db_result.value, int)
|
||||
loaded_db_version = db_result.value
|
||||
|
||||
# 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 +401,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,6 +444,15 @@ class Library:
|
||||
except IntegrityError:
|
||||
session.rollback()
|
||||
|
||||
# TODO: Completely rework this "preferences" system.
|
||||
with catch_warnings(record=True):
|
||||
try:
|
||||
session.add(Preferences(key=DB_VERSION_KEY, value=DB_VERSION))
|
||||
session.commit()
|
||||
except IntegrityError:
|
||||
logger.debug("preference already exists", pref=DB_VERSION_KEY)
|
||||
session.rollback()
|
||||
|
||||
for pref in LibraryPrefs:
|
||||
with catch_warnings(record=True):
|
||||
try:
|
||||
@@ -473,28 +493,30 @@ class Library:
|
||||
# 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:
|
||||
if loaded_db_version < 8:
|
||||
self.apply_db8_schema_changes(session)
|
||||
if db_version < 9:
|
||||
if loaded_db_version < 9:
|
||||
self.apply_db9_schema_changes(session)
|
||||
|
||||
# now the data changes
|
||||
if db_version == 6:
|
||||
if loaded_db_version == 6:
|
||||
self.apply_repairs_for_db6(session)
|
||||
if db_version >= 6 and db_version < 8:
|
||||
if loaded_db_version >= 6 and loaded_db_version < 8:
|
||||
self.apply_db8_default_data(session)
|
||||
if db_version < 9:
|
||||
if loaded_db_version < 9:
|
||||
self.apply_db9_filename_population(session)
|
||||
if loaded_db_version < 100:
|
||||
self.apply_db100_parent_repairs(session)
|
||||
|
||||
# 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_prefs(DB_VERSION_KEY, DB_VERSION)
|
||||
|
||||
# everything is fine, set the library path
|
||||
self.library_dir = library_dir
|
||||
@@ -616,6 +638,20 @@ class Library:
|
||||
session.commit()
|
||||
logger.info("[Library][Migration] Populated filename column in entries table")
|
||||
|
||||
def apply_db100_parent_repairs(self, session: Session):
|
||||
"""Apply database repairs introduced in DB_VERSION 100."""
|
||||
logger.info("[Library][Migration] Applying patches to DB_VERSION 100 library...")
|
||||
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.flush()
|
||||
|
||||
session.commit()
|
||||
|
||||
@property
|
||||
def default_fields(self) -> list[BaseField]:
|
||||
with Session(self.engine) as session:
|
||||
@@ -659,7 +695,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))
|
||||
@@ -885,6 +924,7 @@ class Library:
|
||||
"""
|
||||
assert isinstance(search, BrowsingState)
|
||||
assert self.engine
|
||||
assert self.library_dir
|
||||
|
||||
with Session(self.engine, expire_on_commit=False) as session:
|
||||
statement = select(Entry.id, func.count().over())
|
||||
@@ -897,6 +937,7 @@ class Library:
|
||||
f"SQL Expression Builder finished ({format_timespan(end_time - start_time)})"
|
||||
)
|
||||
|
||||
# TODO: Remove this from the search function and update tests.
|
||||
extensions = self.prefs(LibraryPrefs.EXTENSION_LIST)
|
||||
is_exclude_list = self.prefs(LibraryPrefs.IS_EXCLUDE_LIST)
|
||||
|
||||
@@ -905,6 +946,8 @@ class Library:
|
||||
elif extensions:
|
||||
statement = statement.where(Entry.suffix.in_(extensions))
|
||||
|
||||
statement = statement.distinct(Entry.id)
|
||||
|
||||
sort_on: ColumnExpressionArgument = Entry.id
|
||||
match search.sorting_mode:
|
||||
case SortingModeEnum.DATE_ADDED:
|
||||
@@ -913,6 +956,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:
|
||||
@@ -1621,35 +1666,49 @@ 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 prefs(self, key: str | LibraryPrefs):
|
||||
# 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
|
||||
else:
|
||||
return session.scalar(select(Preferences).where(Preferences.key == key)).value
|
||||
|
||||
def set_prefs(self, key: LibraryPrefs, value) -> None:
|
||||
def set_prefs(self, key: str | LibraryPrefs, value: Any) -> None:
|
||||
# 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))
|
||||
pref: Preferences | None
|
||||
|
||||
stuff = session.scalars(select(Preferences))
|
||||
logger.info([x.key for x in list(stuff)])
|
||||
|
||||
if isinstance(key, LibraryPrefs):
|
||||
pref = session.scalar(select(Preferences).where(Preferences.key == key.name))
|
||||
else:
|
||||
pref = session.scalar(select(Preferences).where(Preferences.key == key))
|
||||
|
||||
logger.info("loading pref", pref=pref, key=key, value=value)
|
||||
assert pref is not None
|
||||
pref.value = value
|
||||
session.add(pref)
|
||||
session.commit()
|
||||
@@ -1710,7 +1769,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
|
||||
|
||||
@@ -99,8 +99,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]
|
||||
|
||||
@@ -31,17 +31,15 @@ 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
|
||||
SELECT :tag_id AS tag_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 tp.child_id AS tag_id
|
||||
FROM tag_parents tp
|
||||
INNER JOIN ChildTags c ON tp.parent_id = c.tag_id
|
||||
)
|
||||
SELECT child_id FROM ChildTags;
|
||||
SELECT tag_id FROM ChildTags;
|
||||
""") # noqa: E501
|
||||
|
||||
|
||||
|
||||
154
src/tagstudio/core/library/ignore.py
Normal file
154
src/tagstudio/core/library/ignore.py
Normal file
@@ -0,0 +1,154 @@
|
||||
# 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.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)
|
||||
additional_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)
|
||||
|
||||
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 = 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 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(
|
||||
"*", PATH_GLOB_FLAGS, exclude=ignore_to_glob(Ignore._patterns)
|
||||
)
|
||||
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
|
||||
@@ -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(
|
||||
|
||||
@@ -26,9 +26,11 @@ class UiColor(IntEnum):
|
||||
THEME_DARK = 1
|
||||
THEME_LIGHT = 2
|
||||
RED = 3
|
||||
GREEN = 4
|
||||
BLUE = 5
|
||||
PURPLE = 6
|
||||
ORANGE = 4
|
||||
AMBER = 5
|
||||
GREEN = 6
|
||||
BLUE = 7
|
||||
PURPLE = 8
|
||||
|
||||
|
||||
TAG_COLORS: dict[TagColorEnum, dict[ColorType, Any]] = {
|
||||
@@ -54,6 +56,18 @@ UI_COLORS: dict[UiColor, dict[ColorType, Any]] = {
|
||||
ColorType.LIGHT_ACCENT: "#f39caa",
|
||||
ColorType.DARK_ACCENT: "#440d12",
|
||||
},
|
||||
UiColor.ORANGE: {
|
||||
ColorType.PRIMARY: "#FF8020",
|
||||
ColorType.BORDER: "#E86919",
|
||||
ColorType.LIGHT_ACCENT: "#FFECB3",
|
||||
ColorType.DARK_ACCENT: "#752809",
|
||||
},
|
||||
UiColor.AMBER: {
|
||||
ColorType.PRIMARY: "#FFC107",
|
||||
ColorType.BORDER: "#FFD54F",
|
||||
ColorType.LIGHT_ACCENT: "#FFECB3",
|
||||
ColorType.DARK_ACCENT: "#772505",
|
||||
},
|
||||
UiColor.GREEN: {
|
||||
ColorType.PRIMARY: "#28bb48",
|
||||
ColorType.BORDER: "#43c568",
|
||||
|
||||
@@ -3,10 +3,11 @@ 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.utils.refresh_dir import GLOBAL_IGNORE_SET
|
||||
from tagstudio.core.library.ignore import PATH_GLOB_FLAGS, Ignore
|
||||
|
||||
logger = structlog.get_logger()
|
||||
|
||||
@@ -25,7 +26,9 @@ class MissingRegistry:
|
||||
|
||||
def refresh_missing_files(self) -> Iterator[int]:
|
||||
"""Track the number of entries that point to an invalid filepath."""
|
||||
assert self.library.library_dir
|
||||
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
|
||||
@@ -38,16 +41,15 @@ class MissingRegistry:
|
||||
|
||||
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
|
||||
assert self.library.library_dir
|
||||
matches: list[Path] = []
|
||||
|
||||
ignore_patterns = Ignore.get_patterns(self.library.library_dir)
|
||||
for path in pathlib.Path(str(self.library.library_dir)).glob(
|
||||
f"***/{match_entry.path.name}",
|
||||
flags=PATH_GLOB_FLAGS,
|
||||
exclude=ignore_patterns,
|
||||
):
|
||||
if path.name == match_entry.path.name:
|
||||
new_path = Path(path).relative_to(self.library.library_dir)
|
||||
matches.append(new_path)
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
import shutil
|
||||
from collections.abc import Iterator
|
||||
from dataclasses import dataclass, field
|
||||
from datetime import datetime as dt
|
||||
@@ -5,27 +6,15 @@ from pathlib import Path
|
||||
from time import time
|
||||
|
||||
import structlog
|
||||
from wcmatch import pathlib
|
||||
|
||||
from tagstudio.core.constants import TS_FOLDER_NAME
|
||||
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.qt.helpers.silent_popen import silent_run
|
||||
|
||||
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:
|
||||
@@ -42,7 +31,7 @@ class RefreshDirTracker:
|
||||
entries = [
|
||||
Entry(
|
||||
path=entry_path,
|
||||
folder=self.library.folder,
|
||||
folder=self.library.folder, # pyright: ignore[reportArgumentType]
|
||||
fields=[],
|
||||
date_added=dt.now(),
|
||||
)
|
||||
@@ -54,18 +43,81 @@ class RefreshDirTracker:
|
||||
|
||||
yield
|
||||
|
||||
def refresh_dir(self, lib_path: Path) -> Iterator[int]:
|
||||
"""Scan a directory for files, and add those relative filenames to internal variables."""
|
||||
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()
|
||||
|
||||
self.files_not_in_library = []
|
||||
dir_file_count = 0
|
||||
self.files_not_in_library = []
|
||||
|
||||
for r in dir_list:
|
||||
f = pathlib.Path(r)
|
||||
|
||||
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:
|
||||
@@ -81,31 +133,62 @@ class RefreshDirTracker:
|
||||
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:
|
||||
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")
|
||||
|
||||
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(lib_path)
|
||||
# TODO - load these in batch somehow
|
||||
relative_path = f.relative_to(library_dir)
|
||||
|
||||
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,
|
||||
"[Refresh]: Directory scan time",
|
||||
path=library_dir,
|
||||
duration=(end_time_total - start_time_total),
|
||||
files_not_in_lib=self.files_not_in_library,
|
||||
files_scanned=dir_file_count,
|
||||
tool_used="wcmatch (internal)",
|
||||
)
|
||||
|
||||
@@ -38,14 +38,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
|
||||
suffix = BrowsingState.from_tag_id(
|
||||
tag.id, self.__driver.browsing_history.current
|
||||
).query
|
||||
assert suffix is not None
|
||||
self.__driver.update_browsing_state(
|
||||
current.with_search_query(
|
||||
@@ -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,9 @@
|
||||
# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
|
||||
|
||||
|
||||
import os
|
||||
from pathlib import Path
|
||||
from platform import system
|
||||
|
||||
import structlog
|
||||
from send2trash import send2trash
|
||||
@@ -23,9 +25,32 @@ def delete_file(path: str | Path) -> bool:
|
||||
send2trash(_path)
|
||||
return True
|
||||
except PermissionError as e:
|
||||
logger.error(f"[delete_file][ERROR] PermissionError: {e}")
|
||||
logger.error(f"[delete_file] PermissionError: {e}")
|
||||
except FileNotFoundError:
|
||||
logger.error(f"[delete_file][ERROR] File Not Found: {_path}")
|
||||
logger.error(f"[delete_file] File Not Found: {_path}")
|
||||
except OSError as e:
|
||||
if system() == "Darwin" and _path.exists():
|
||||
logger.info(
|
||||
f'[delete_file] Encountered "{e}" on macOS and file exists; '
|
||||
"Assuming it's on a network volume and proceeding to delete..."
|
||||
)
|
||||
return _hard_delete_file(_path)
|
||||
else:
|
||||
logger.error("[delete_file] OSError", error=e)
|
||||
except Exception as e:
|
||||
logger.error(e)
|
||||
logger.error("[delete_file] Unknown Error", error_type=type(e).__name__, error=e)
|
||||
return False
|
||||
|
||||
|
||||
def _hard_delete_file(path: Path) -> bool:
|
||||
"""Hard delete a file from the system. Does NOT send to system trash.
|
||||
|
||||
Args:
|
||||
path (str | Path): The path of the file to delete.
|
||||
"""
|
||||
try:
|
||||
os.remove(path)
|
||||
return True
|
||||
except Exception as e:
|
||||
logger.error("[hard_delete_file] Error", error_type=type(e).__name__, error=e)
|
||||
return False
|
||||
|
||||
@@ -86,7 +86,7 @@ def silent_Popen( # noqa: N802
|
||||
)
|
||||
|
||||
|
||||
def silent_run( # noqa: N802
|
||||
def silent_run(
|
||||
args,
|
||||
bufsize=-1,
|
||||
executable=None,
|
||||
|
||||
@@ -316,7 +316,9 @@ class TagSearchPanel(PanelWidget):
|
||||
tag_widget.search_for_tag_action.triggered.connect(
|
||||
lambda checked=False, tag_id=tag.id, driver=self.driver: (
|
||||
driver.main_window.search_field.setText(f"tag_id:{tag_id}"),
|
||||
driver.update_browsing_state(BrowsingState.from_tag_id(tag_id)),
|
||||
driver.update_browsing_state(
|
||||
BrowsingState.from_tag_id(tag_id, driver.browsing_history.current)
|
||||
),
|
||||
)
|
||||
)
|
||||
tag_widget.search_for_tag_action.setEnabled(True)
|
||||
|
||||
@@ -30,6 +30,10 @@
|
||||
"broken_link_icon": {
|
||||
"path": "qt/images/broken_link_icon.png",
|
||||
"mode": "pil"
|
||||
},
|
||||
"ignored": {
|
||||
"path": "qt/images/ignored_128.png",
|
||||
"mode": "pil"
|
||||
},
|
||||
"adobe_illustrator": {
|
||||
"path": "qt/images/file_icons/adobe_illustrator.png",
|
||||
|
||||
@@ -60,6 +60,7 @@ from tagstudio.core.library.alchemy.enums import (
|
||||
from tagstudio.core.library.alchemy.fields import _FieldID
|
||||
from tagstudio.core.library.alchemy.library import Library, LibraryStatus
|
||||
from tagstudio.core.library.alchemy.models import Entry
|
||||
from tagstudio.core.library.ignore import Ignore
|
||||
from tagstudio.core.media_types import MediaCategories
|
||||
from tagstudio.core.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.core.query_lang.util import ParsingError
|
||||
@@ -994,6 +995,7 @@ class QtDriver(DriverMixin, QObject):
|
||||
|
||||
def add_new_files_callback(self):
|
||||
"""Run when user initiates adding new files to the Library."""
|
||||
assert self.lib.library_dir
|
||||
tracker = RefreshDirTracker(self.lib)
|
||||
|
||||
pw = ProgressWidget(
|
||||
@@ -1003,10 +1005,9 @@ class QtDriver(DriverMixin, QObject):
|
||||
)
|
||||
pw.setWindowTitle(Translations["library.refresh.title"])
|
||||
pw.update_label(Translations["library.refresh.scanning_preparing"])
|
||||
|
||||
pw.show()
|
||||
|
||||
iterator = FunctionIterator(lambda: tracker.refresh_dir(self.lib.library_dir))
|
||||
iterator = FunctionIterator(lambda lib=self.lib.library_dir: tracker.refresh_dir(lib))
|
||||
iterator.value.connect(
|
||||
lambda x: (
|
||||
pw.update_progress(x + 1),
|
||||
@@ -1562,6 +1563,7 @@ class QtDriver(DriverMixin, QObject):
|
||||
|
||||
# search the library
|
||||
start_time = time.time()
|
||||
Ignore.get_patterns(self.lib.library_dir, include_global=True)
|
||||
results = self.lib.search_library(self.browsing_history.current, self.settings.page_size)
|
||||
logger.info("items to render", count=len(results))
|
||||
end_time = time.time()
|
||||
@@ -1706,8 +1708,9 @@ class QtDriver(DriverMixin, QObject):
|
||||
)
|
||||
return open_status
|
||||
|
||||
assert self.lib.library_dir
|
||||
self.init_workers()
|
||||
|
||||
Ignore.get_patterns(self.lib.library_dir, include_global=True)
|
||||
self.__reset_navigation()
|
||||
|
||||
# TODO - make this call optional
|
||||
|
||||
@@ -641,7 +641,7 @@ class JsonMigrationModal(QObject):
|
||||
for tag in self.sql_lib.tags:
|
||||
tag_id = tag.id # Tag IDs start at 0
|
||||
sql_parent_tags = set(
|
||||
session.scalars(select(TagParent.child_id).where(TagParent.parent_id == tag.id))
|
||||
session.scalars(select(TagParent.parent_id).where(TagParent.child_id == tag.id))
|
||||
)
|
||||
|
||||
# JSON tags allowed self-parenting; SQL tags no longer allow this.
|
||||
|
||||
@@ -285,11 +285,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,7 +20,9 @@ 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.core.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.qt.helpers.file_opener import FileOpenerHelper, FileOpenerLabel
|
||||
from tagstudio.qt.translations import Translations
|
||||
|
||||
@@ -207,12 +209,30 @@ 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
|
||||
assert self.library.library_dir
|
||||
red = get_ui_color(ColorType.PRIMARY, UiColor.RED)
|
||||
orange = get_ui_color(ColorType.PRIMARY, UiColor.ORANGE)
|
||||
|
||||
if Ignore.compiled_patterns and not Ignore.compiled_patterns.match(
|
||||
filepath.relative_to(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:
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
import contextlib
|
||||
import hashlib
|
||||
import math
|
||||
import os
|
||||
import zipfile
|
||||
from copy import deepcopy
|
||||
from io import BytesIO
|
||||
@@ -55,8 +56,9 @@ from tagstudio.core.constants import (
|
||||
TS_FOLDER_NAME,
|
||||
)
|
||||
from tagstudio.core.exceptions import NoRendererError
|
||||
from tagstudio.core.library.ignore import Ignore
|
||||
from tagstudio.core.media_types import MediaCategories, MediaType
|
||||
from tagstudio.core.palette import ColorType, UiColor, get_ui_color
|
||||
from tagstudio.core.palette import UI_COLORS, ColorType, UiColor, get_ui_color
|
||||
from tagstudio.core.utils.encoding import detect_char_encoding
|
||||
from tagstudio.qt.cache_manager import CacheManager
|
||||
from tagstudio.qt.helpers.blender_thumbnailer import blend_thumb
|
||||
@@ -71,6 +73,7 @@ from tagstudio.qt.helpers.vendored.pydub.audio_segment import (
|
||||
from tagstudio.qt.resource_manager import ResourceManager
|
||||
|
||||
ImageFile.LOAD_TRUNCATED_IMAGES = True
|
||||
os.environ["OPENCV_IO_ENABLE_OPENEXR"] = "1"
|
||||
|
||||
logger = structlog.get_logger(__name__)
|
||||
Image.MAX_IMAGE_PIXELS = None
|
||||
@@ -184,7 +187,14 @@ class ThumbRenderer(QObject):
|
||||
return item
|
||||
|
||||
def _get_icon(
|
||||
self, name: str, color: UiColor, size: tuple[int, int], pixel_ratio: float = 1.0
|
||||
self,
|
||||
name: str,
|
||||
color: UiColor,
|
||||
size: tuple[int, int],
|
||||
pixel_ratio: float = 1.0,
|
||||
bg_image: Image.Image | None = None,
|
||||
draw_edge: bool = True,
|
||||
is_corner: bool = False,
|
||||
) -> Image.Image:
|
||||
"""Return an icon given a size, pixel ratio, and radius scaling option.
|
||||
|
||||
@@ -193,6 +203,9 @@ class ThumbRenderer(QObject):
|
||||
color (str): The color to use for the icon.
|
||||
size (tuple[int,int]): The size of the icon.
|
||||
pixel_ratio (float): The screen pixel ratio.
|
||||
bg_image (Image.Image): Optional background image to go behind the icon.
|
||||
draw_edge (bool): Flag for is the raised edge should be drawn.
|
||||
is_corner (bool): Flag for is the icon should render with the "corner" style
|
||||
"""
|
||||
draw_border: bool = True
|
||||
if name == "thumb_loading":
|
||||
@@ -200,10 +213,17 @@ class ThumbRenderer(QObject):
|
||||
|
||||
item: Image.Image | None = self.icons.get((name, color, *size, pixel_ratio))
|
||||
if not item:
|
||||
item_flat: Image.Image = self._render_icon(name, color, size, pixel_ratio, draw_border)
|
||||
edge: tuple[Image.Image, Image.Image] = self._get_edge(size, pixel_ratio)
|
||||
item = self._apply_edge(item_flat, edge, faded=True)
|
||||
self.icons[(name, color, *size, pixel_ratio)] = item
|
||||
item_flat: Image.Image = (
|
||||
self._render_corner_icon(name, color, size, pixel_ratio, bg_image)
|
||||
if is_corner
|
||||
else self._render_center_icon(name, color, size, pixel_ratio, draw_border, bg_image)
|
||||
)
|
||||
if draw_edge:
|
||||
edge: tuple[Image.Image, Image.Image] = self._get_edge(size, pixel_ratio)
|
||||
item = self._apply_edge(item_flat, edge, faded=True)
|
||||
self.icons[(name, color, *size, pixel_ratio)] = item
|
||||
else:
|
||||
item = item_flat
|
||||
return item
|
||||
|
||||
def _render_mask(
|
||||
@@ -289,13 +309,14 @@ class ThumbRenderer(QObject):
|
||||
|
||||
return (im_hl, im_sh)
|
||||
|
||||
def _render_icon(
|
||||
def _render_center_icon(
|
||||
self,
|
||||
name: str,
|
||||
color: UiColor,
|
||||
size: tuple[int, int],
|
||||
pixel_ratio: float,
|
||||
draw_border: bool = True,
|
||||
bg_image: Image.Image | None = None,
|
||||
) -> Image.Image:
|
||||
"""Render a thumbnail icon.
|
||||
|
||||
@@ -305,6 +326,7 @@ class ThumbRenderer(QObject):
|
||||
size (tuple[int,int]): The size of the icon.
|
||||
pixel_ratio (float): The screen pixel ratio.
|
||||
draw_border (bool): Option to draw a border.
|
||||
bg_image (Image.Image): Optional background image to go behind the icon.
|
||||
"""
|
||||
border_factor: int = 5
|
||||
smooth_factor: int = math.ceil(2 * pixel_ratio)
|
||||
@@ -315,16 +337,23 @@ class ThumbRenderer(QObject):
|
||||
im: Image.Image = Image.new(
|
||||
"RGBA",
|
||||
size=tuple([d * smooth_factor for d in size]), # type: ignore
|
||||
color="#00000000",
|
||||
color="#FF000000",
|
||||
)
|
||||
|
||||
# Create solid background color
|
||||
bg: Image.Image = Image.new(
|
||||
bg: Image.Image
|
||||
bg = Image.new(
|
||||
"RGB",
|
||||
size=tuple([d * smooth_factor for d in size]), # type: ignore
|
||||
color="#000000",
|
||||
color="#000000FF",
|
||||
)
|
||||
|
||||
# Use a background image if provided
|
||||
if bg_image:
|
||||
bg_im = Image.Image.resize(bg_image, size=tuple([d * smooth_factor for d in size])) # type: ignore
|
||||
bg_im = ImageEnhance.Brightness(bg_im).enhance(0.3) # Reduce the brightness
|
||||
bg.paste(bg_im)
|
||||
|
||||
# Paste background color with rounded rectangle mask onto blank image
|
||||
im.paste(
|
||||
bg,
|
||||
@@ -343,7 +372,7 @@ class ThumbRenderer(QObject):
|
||||
radius=math.ceil(
|
||||
(radius_factor * smooth_factor * pixel_ratio) + (pixel_ratio * 1.5)
|
||||
),
|
||||
fill="black",
|
||||
fill=None if bg_image else "black",
|
||||
outline="#FF0000",
|
||||
width=math.floor(
|
||||
(border_factor * smooth_factor * pixel_ratio) - (pixel_ratio * 1.5)
|
||||
@@ -362,7 +391,7 @@ class ThumbRenderer(QObject):
|
||||
)
|
||||
|
||||
# Get icon by name
|
||||
icon: Image.Image = self.rm.get(name)
|
||||
icon: Image.Image | None = self.rm.get(name)
|
||||
if not icon:
|
||||
icon = self.rm.get("file_generic")
|
||||
if not icon:
|
||||
@@ -389,6 +418,105 @@ class ThumbRenderer(QObject):
|
||||
|
||||
return im
|
||||
|
||||
def _render_corner_icon(
|
||||
self,
|
||||
name: str,
|
||||
color: UiColor,
|
||||
size: tuple[int, int],
|
||||
pixel_ratio: float,
|
||||
bg_image: Image.Image | None = None,
|
||||
) -> Image.Image:
|
||||
"""Render a thumbnail icon with the icon in the upper-left corner.
|
||||
|
||||
Args:
|
||||
name (str): The name of the icon resource.
|
||||
color (UiColor): The color to use for the icon.
|
||||
size (tuple[int,int]): The size of the icon.
|
||||
pixel_ratio (float): The screen pixel ratio.
|
||||
draw_border (bool): Option to draw a border.
|
||||
bg_image (Image.Image): Optional background image to go behind the icon.
|
||||
"""
|
||||
smooth_factor: int = math.ceil(2 * pixel_ratio)
|
||||
icon_ratio: float = 5
|
||||
padding_factor = 18
|
||||
|
||||
# Create larger blank image based on smooth_factor
|
||||
im: Image.Image = Image.new(
|
||||
"RGBA",
|
||||
size=tuple([d * smooth_factor for d in size]), # type: ignore
|
||||
color="#00000000",
|
||||
)
|
||||
|
||||
bg: Image.Image
|
||||
# Use a background image if provided
|
||||
if bg_image:
|
||||
bg = Image.Image.resize(bg_image, size=tuple([d * smooth_factor for d in size])) # type: ignore
|
||||
# Create solid background color
|
||||
else:
|
||||
bg = Image.new(
|
||||
"RGB",
|
||||
size=tuple([d * smooth_factor for d in size]), # type: ignore
|
||||
color="#000000",
|
||||
)
|
||||
# Apply color overlay
|
||||
bg = self._apply_overlay_color(
|
||||
im,
|
||||
color,
|
||||
)
|
||||
|
||||
# Paste background color with rounded rectangle mask onto blank image
|
||||
im.paste(
|
||||
bg,
|
||||
(0, 0),
|
||||
mask=self._get_mask(
|
||||
tuple([d * smooth_factor for d in size]), # type: ignore
|
||||
(pixel_ratio * smooth_factor),
|
||||
),
|
||||
)
|
||||
|
||||
colors = UI_COLORS.get(color) or UI_COLORS[UiColor.DEFAULT]
|
||||
primary_color = colors.get(ColorType.PRIMARY)
|
||||
|
||||
# Resize image to final size
|
||||
im = im.resize(
|
||||
size,
|
||||
resample=Image.Resampling.BILINEAR,
|
||||
)
|
||||
fg: Image.Image = Image.new(
|
||||
"RGB",
|
||||
size=size,
|
||||
color=primary_color,
|
||||
)
|
||||
|
||||
# Get icon by name
|
||||
icon: Image.Image | None = self.rm.get(name)
|
||||
if not icon:
|
||||
icon = self.rm.get("file_generic")
|
||||
if not icon:
|
||||
icon = Image.new(mode="RGBA", size=(32, 32), color="magenta")
|
||||
|
||||
# Resize icon to fit icon_ratio
|
||||
icon = icon.resize(
|
||||
(
|
||||
math.ceil(size[0] // icon_ratio),
|
||||
math.ceil(size[1] // icon_ratio),
|
||||
)
|
||||
)
|
||||
|
||||
# Paste icon
|
||||
im.paste(
|
||||
im=fg.resize(
|
||||
(
|
||||
math.ceil(size[0] // icon_ratio),
|
||||
math.ceil(size[1] // icon_ratio),
|
||||
)
|
||||
),
|
||||
box=(size[0] // padding_factor, size[1] // padding_factor),
|
||||
mask=icon.getchannel(3),
|
||||
)
|
||||
|
||||
return im
|
||||
|
||||
def _apply_overlay_color(self, image: Image.Image, color: UiColor) -> Image.Image:
|
||||
"""Apply a color overlay effect to an image based on its color channel data.
|
||||
|
||||
@@ -498,9 +626,10 @@ class ThumbRenderer(QObject):
|
||||
if artwork:
|
||||
image = artwork
|
||||
except (
|
||||
FileNotFoundError,
|
||||
id3.ID3NoHeaderError,
|
||||
mp4.MP4MetadataError,
|
||||
mp4.MP4StreamInfoError,
|
||||
id3.ID3NoHeaderError,
|
||||
MutagenError,
|
||||
) as e:
|
||||
logger.error("Couldn't read album artwork", path=filepath, error=type(e).__name__)
|
||||
@@ -644,7 +773,7 @@ class ThumbRenderer(QObject):
|
||||
vtf = srctools.VTF.read(f)
|
||||
im = vtf.get(frame=0).to_PIL()
|
||||
|
||||
except ValueError as e:
|
||||
except (ValueError, FileNotFoundError) as e:
|
||||
logger.error("Couldn't render thumbnail", filepath=filepath, error=type(e).__name__)
|
||||
return im
|
||||
|
||||
@@ -861,6 +990,36 @@ class ThumbRenderer(QObject):
|
||||
logger.error("Couldn't render thumbnail", filepath=filepath, error=type(e).__name__)
|
||||
return im
|
||||
|
||||
@staticmethod
|
||||
def _image_exr_thumb(filepath: Path) -> Image.Image | None:
|
||||
"""Render a thumbnail for a EXR image type.
|
||||
|
||||
Args:
|
||||
filepath (Path): The path of the file.
|
||||
"""
|
||||
im: Image.Image | None = None
|
||||
try:
|
||||
# Load the EXR data to an array and rotate the color space from BGRA -> RGBA
|
||||
raw_array = cv2.imread(str(filepath), cv2.IMREAD_UNCHANGED)
|
||||
raw_array[..., :3] = raw_array[..., 2::-1]
|
||||
|
||||
# Correct the gamma of the raw array
|
||||
gamma = 2.2
|
||||
array_gamma = np.power(np.clip(raw_array, 0, 1), 1 / gamma)
|
||||
array = (array_gamma * 255).astype(np.uint8)
|
||||
|
||||
im = Image.fromarray(array, mode="RGBA")
|
||||
|
||||
# Paste solid background
|
||||
if im.mode == "RGBA":
|
||||
new_bg = Image.new("RGB", im.size, color="#1e1e1e")
|
||||
new_bg.paste(im, mask=im.getchannel(3))
|
||||
im = new_bg
|
||||
|
||||
except Exception as e:
|
||||
logger.error("Couldn't render thumbnail", filepath=filepath, error=type(e).__name__)
|
||||
return im
|
||||
|
||||
@staticmethod
|
||||
def _image_thumb(filepath: Path) -> Image.Image:
|
||||
"""Render a thumbnail for a standard image type.
|
||||
@@ -879,6 +1038,7 @@ class ThumbRenderer(QObject):
|
||||
im = new_bg
|
||||
im = ImageOps.exif_transpose(im)
|
||||
except (
|
||||
FileNotFoundError,
|
||||
UnidentifiedImageError,
|
||||
DecompressionBombError,
|
||||
NotImplementedError,
|
||||
@@ -1076,6 +1236,7 @@ class ThumbRenderer(QObject):
|
||||
DecompressionBombError,
|
||||
UnicodeDecodeError,
|
||||
OSError,
|
||||
FileNotFoundError,
|
||||
) as e:
|
||||
logger.error("Couldn't render thumbnail", filepath=filepath, error=type(e).__name__)
|
||||
return im
|
||||
@@ -1165,15 +1326,49 @@ class ThumbRenderer(QObject):
|
||||
)
|
||||
return im
|
||||
|
||||
def render_unlinked(size: tuple[int, int], pixel_ratio: float) -> Image.Image:
|
||||
def render_unlinked(
|
||||
size: tuple[int, int], pixel_ratio: float, cached_im: Image.Image | None = None
|
||||
) -> Image.Image:
|
||||
im = self._get_icon(
|
||||
name="broken_link_icon",
|
||||
color=UiColor.RED,
|
||||
size=size,
|
||||
pixel_ratio=pixel_ratio,
|
||||
bg_image=cached_im,
|
||||
draw_edge=not cached_im,
|
||||
is_corner=False,
|
||||
)
|
||||
return im
|
||||
|
||||
def render_ignored(
|
||||
size: tuple[int, int], pixel_ratio: float, im: Image.Image
|
||||
) -> Image.Image:
|
||||
icon_ratio: float = 5
|
||||
padding_factor = 18
|
||||
|
||||
im_ = im
|
||||
icon: Image.Image = self.rm.get("ignored") # pyright: ignore[reportAssignmentType]
|
||||
|
||||
icon = icon.resize(
|
||||
(
|
||||
math.ceil(size[0] // icon_ratio),
|
||||
math.ceil(size[1] // icon_ratio),
|
||||
)
|
||||
)
|
||||
|
||||
im_.paste(
|
||||
im=icon.resize(
|
||||
(
|
||||
math.ceil(size[0] // icon_ratio),
|
||||
math.ceil(size[1] // icon_ratio),
|
||||
)
|
||||
),
|
||||
box=(size[0] // padding_factor, size[1] // padding_factor),
|
||||
mask=icon.getchannel(3),
|
||||
)
|
||||
|
||||
return im_
|
||||
|
||||
def fetch_cached_image(folder: Path):
|
||||
image: Image.Image | None = None
|
||||
cached_path: Path | None = None
|
||||
@@ -1276,6 +1471,19 @@ class ThumbRenderer(QObject):
|
||||
four_corner_gradient(image, (adj_size, adj_size), mask), edge
|
||||
)
|
||||
|
||||
# Check if the file is supposed to be ignored and render an overlay if needed
|
||||
try:
|
||||
if (
|
||||
image
|
||||
and Ignore.compiled_patterns
|
||||
and not Ignore.compiled_patterns.match(
|
||||
filepath.relative_to(self.lib.library_dir)
|
||||
)
|
||||
):
|
||||
image = render_ignored((adj_size, adj_size), pixel_ratio, image)
|
||||
except TypeError:
|
||||
pass
|
||||
|
||||
# A loading thumbnail (cached in memory)
|
||||
elif is_loading:
|
||||
# Initialize "Loading" thumbnail
|
||||
@@ -1354,9 +1562,6 @@ class ThumbRenderer(QObject):
|
||||
|
||||
if _filepath:
|
||||
try:
|
||||
# Missing Files ================================================
|
||||
if not _filepath.exists():
|
||||
raise FileNotFoundError
|
||||
ext: str = _filepath.suffix.lower() if _filepath.suffix else _filepath.stem.lower()
|
||||
# Images =======================================================
|
||||
if MediaCategories.is_ext_in_category(
|
||||
@@ -1372,6 +1577,9 @@ class ThumbRenderer(QObject):
|
||||
ext, MediaCategories.IMAGE_VECTOR_TYPES, mime_fallback=True
|
||||
):
|
||||
image = self._image_vector_thumb(_filepath, adj_size)
|
||||
# EXR Images -----------------------------------------------
|
||||
elif ext in [".exr"]:
|
||||
image = self._image_exr_thumb(_filepath)
|
||||
# Normal Images --------------------------------------------
|
||||
else:
|
||||
image = self._image_thumb(_filepath)
|
||||
@@ -1451,8 +1659,6 @@ class ThumbRenderer(QObject):
|
||||
if save_to_file and savable_media_type and image:
|
||||
ThumbRenderer.cache.save_image(image, save_to_file, mode="RGBA")
|
||||
|
||||
except FileNotFoundError:
|
||||
image = None
|
||||
except (
|
||||
UnidentifiedImageError,
|
||||
DecompressionBombError,
|
||||
|
||||
BIN
src/tagstudio/resources/qt/images/ignored_128.png
Normal file
BIN
src/tagstudio/resources/qt/images/ignored_128.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.1 KiB |
@@ -226,8 +226,10 @@
|
||||
"namespace.create.title": "Create Namespace",
|
||||
"namespace.new.button": "New Namespace",
|
||||
"namespace.new.prompt": "Create a New Namespace to Start Adding Custom Colors!",
|
||||
"preview.ignored": "Ignored",
|
||||
"preview.multiple_selection": "<b>{count}</b> Items Selected",
|
||||
"preview.no_selection": "No Items Selected",
|
||||
"preview.unlinked": "Unlinked",
|
||||
"select.add_tag_to_selected": "Add Tag to Selected",
|
||||
"select.all": "Select All",
|
||||
"select.clear": "Clear Selection",
|
||||
@@ -262,6 +264,7 @@
|
||||
"settings.title": "Settings",
|
||||
"sorting.direction.ascending": "Ascending",
|
||||
"sorting.direction.descending": "Descending",
|
||||
"sorting.mode.random": "Random",
|
||||
"splash.opening_library": "Opening Library \"{library_path}\"...",
|
||||
"status.deleted_file_plural": "Deleted {count} files!",
|
||||
"status.deleted_file_singular": "Deleted 1 file!",
|
||||
|
||||
BIN
tests/fixtures/empty_libraries/DB_VERSION_100/.TagStudio/ts_library.sqlite
vendored
Normal file
BIN
tests/fixtures/empty_libraries/DB_VERSION_100/.TagStudio/ts_library.sqlite
vendored
Normal file
Binary file not shown.
Binary file not shown.
@@ -7,7 +7,7 @@ CWD = Path(__file__).parent
|
||||
|
||||
|
||||
def test_refresh_dupe_files(library):
|
||||
library.library_dir = "/tmp/"
|
||||
library.library_dir = Path("/tmp/")
|
||||
entry = Entry(
|
||||
folder=library.folder,
|
||||
path=Path("bar/foo.txt"),
|
||||
|
||||
@@ -19,8 +19,6 @@ def test_refresh_new_files(library, exclude_mode):
|
||||
library.included_files.clear()
|
||||
(library.library_dir / "FOO.MD").touch()
|
||||
|
||||
# When
|
||||
assert len(list(registry.refresh_dir(library.library_dir))) == 1
|
||||
|
||||
# Then
|
||||
# Test if the single file was added
|
||||
list(registry.refresh_dir(library.library_dir, force_internal_tools=True))
|
||||
assert registry.files_not_in_library == [Path("FOO.MD")]
|
||||
|
||||
@@ -79,7 +79,7 @@ def test_build_tag_panel_set_parent_tags(library, generate_tag):
|
||||
assert parent
|
||||
assert child
|
||||
|
||||
library.add_parent_tag(child.id, parent.id)
|
||||
library.add_parent_tag(parent.id, child.id)
|
||||
|
||||
child = library.get_tag(child.id)
|
||||
|
||||
|
||||
@@ -23,6 +23,7 @@ EMPTY_LIBRARIES = "empty_libraries"
|
||||
str(Path(CWD.parent / FIXTURES / EMPTY_LIBRARIES / "DB_VERSION_7")),
|
||||
str(Path(CWD.parent / FIXTURES / EMPTY_LIBRARIES / "DB_VERSION_8")),
|
||||
str(Path(CWD.parent / FIXTURES / EMPTY_LIBRARIES / "DB_VERSION_9")),
|
||||
str(Path(CWD.parent / FIXTURES / EMPTY_LIBRARIES / "DB_VERSION_100")),
|
||||
],
|
||||
)
|
||||
def test_library_migrations(path: str):
|
||||
|
||||
@@ -1,12 +1,16 @@
|
||||
import pytest
|
||||
import structlog
|
||||
|
||||
from tagstudio.core.library.alchemy.enums import BrowsingState
|
||||
from tagstudio.core.library.alchemy.library import Library
|
||||
from tagstudio.core.query_lang.util import ParsingError
|
||||
|
||||
logger = structlog.get_logger()
|
||||
|
||||
|
||||
def verify_count(lib: Library, query: str, count: int):
|
||||
results = lib.search_library(BrowsingState.from_search_query(query), page_size=500)
|
||||
logger.info("results", entry_ids=results.ids, count=results.total_count)
|
||||
assert results.total_count == count
|
||||
assert len(results.ids) == count
|
||||
|
||||
|
||||
Reference in New Issue
Block a user