Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: tags #11980

Merged
merged 30 commits into from
Aug 29, 2024
Merged

feat: tags #11980

merged 30 commits into from
Aug 29, 2024

Conversation

jrasm91
Copy link
Contributor

@jrasm91 jrasm91 commented Aug 22, 2024

Warning

NOTE: deleting an entire tag will not sync tags change to impacted asset sidecars at the moment. Re-running metadata extract will most likely recreate the tags again. Untagging the assets and then deleting that tag should be fine though.

Add support for tags

  • Read TagsList and Keywords from exif
  • Any / character in a tag in interpreted to mean nested tags
  • Any parents that don't exist will be created
  • Uniqueness is determined by absolute path (Parent1/Child, Parent2/Child, and Child are all unique tags)
  • When assets are tagged, the tags and written to TagList in the associated XMP sidecar file
  • When assets are untragged the updated tag list is written as per the above statement (with the exception of deleting an entire tag).
  • You can give a tag a color using hex code #123456, although this only is used in the explorer currently. Future work can expand this to the asset detail panel.
Screenshots
Description Image
Sidebar image
Explorer image
Tag assets action image
Create tag image

@bo0tzz
Copy link
Member

bo0tzz commented Aug 22, 2024

Closes #2168, #3518, #3950.

@briandipalma

This comment was marked as outdated.

@C-Otto

This comment was marked as outdated.

@mtojay

This comment was marked as outdated.

@bo0tzz

This comment was marked as outdated.

@briandipalma

This comment was marked as off-topic.

@jrasm91
Copy link
Contributor Author

jrasm91 commented Aug 23, 2024

Please don't bring over to this PR the debate of sidecar vs originals, which has already been answered several times elsewhere. This discussion should be centered around the technical implementation of the feature. The major design decision have already been made:

  • Read tags from xmp
  • Write tags to xmp
  • Dedicated tag table
  • Many to many between assets and tags
  • Tag explorer
  • Viewing parent tag implies seeing assets linked to all children
  • View tags in asset detail panel
  • Add new tags
  • Delete existing tags
  • Add/remove tags in bulk via mult-select option
  • Eventually add multiple tags at once to a set of assets

@jrasm91 jrasm91 marked this pull request as ready for review August 28, 2024 21:30
e2e/src/api/specs/tag.e2e-spec.ts Show resolved Hide resolved
web/src/lib/components/forms/tag-asset-form.svelte Outdated Show resolved Hide resolved
web/src/lib/components/forms/tag-asset-form.svelte Outdated Show resolved Hide resolved
web/src/lib/utils/asset-utils.ts Outdated Show resolved Hide resolved
web/src/lib/utils/asset-utils.ts Outdated Show resolved Hide resolved
@jrasm91 jrasm91 merged commit d08a20b into main Aug 29, 2024
24 checks passed
@jrasm91 jrasm91 deleted the feat/tags branch August 29, 2024 16:14
@waclaw66
Copy link
Contributor

Would it be possible to add option item for Tags and Folders to hide those from Library section same as for People and Sharing? They take up space at the expense of the storage and version info below on small screens.

@alextran1502
Copy link
Contributor

@waclaw66 yep, see #12099

Copy link
Member

@danieldietzler danieldietzler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job!

@ilyaChuk
Copy link
Contributor

Please pay attention #12165

calvinbui added a commit to calvinbui/ansible-monorepo that referenced this pull request Sep 1, 2024
…0 (#2857)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [ghcr.io/immich-app/immich-machine-learning](https://github.com/immich-app/immich) | minor | `v1.112.1-cuda` -> `v1.113.0-cuda` |
| [ghcr.io/immich-app/immich-server](https://github.com/immich-app/immich) | minor | `v1.112.1` -> `v1.113.0` |

---

### Release Notes

<details>
<summary>immich-app/immich (ghcr.io/immich-app/immich-machine-learning)</summary>

### [`v1.113.0`](https://github.com/immich-app/immich/releases/tag/v1.113.0)

[Compare Source](immich-app/immich@v1.112.1...v1.113.0)

##### v1.113.0

> \[!WARNING]
>
> ## Breaking changes
>
> For **OAuth users**, please replace `app.immich:/` with `app.immich:///oauth-callback` for the Redirect URI in your OAuth provider settings

##### Highlights

Welcome to release `v1.113.0` of Immich! This is one of the biggest releases yet, introducing some of the most requested features since the early days of Immich. Let's dive right into what we have in place for this release:

-   Folder view
-   Tags
-   Timeline improvements
-   Library refresh stability
-   Mobile album sync

##### Folder view

You can now browse your photos and videos by folder like in a file explorer. You can use the storage template migration feature for the best experience with uploaded assets in this view.

This feature is especially useful for scanned photos, which are difficult to put in a timeline. It has been a long-requested feature.

You can enable this feature from the `Users Settings > Features > Folders`.

![folder-enabled](https://github.com/user-attachments/assets/aab4a16a-0888-49de-b51a-785ef557261a)

The UI is currently only available for the web; mobile will come in a subsequent release.

![folder](https://github.com/user-attachments/assets/2786da30-83b3-4168-bb98-180dad53a6a4)

![folder-2](https://github.com/user-attachments/assets/163a3ee8-3c3d-4c98-abb6-9c94eb4b362c)

##### Tags

Immich now supports hierarchical tags, with the ability to read existing tags from the `TagList` and `Keywords` exif properties. Any changes to tags made through Immich are also written back to a sidecar file. You can re-run the metadata extraction jobs for all assets to import your existing tags.

You can enable this feature from the `Users Settings > Features > Tags`.

![tag-enabled](https://github.com/user-attachments/assets/20a7a99e-13f6-46f2-8744-20dd95d8456b)

The UI is currently only available for the web; mobile will come in a subsequent release.

https://github.com/user-attachments/assets/d543f531-4b0e-4dcf-8918-e76c7f1b288b

##### Timeline improvements

This release introduces a rewrite of the web timeline component. It can now handle a large number of assets in a single day or month and has been successfully tested with a very large data set (over a million assets). Photographers frequently request this since they can easily take thousands of photos in a given day.

With these performance improvements, you'll see fewer placeholders while loading, which will make for a more fluid scrolling and scrubbing experience.

##### Library refresh stability

In relation to the previous point, the stability of library scanning has improved. Previously, you could run out of memory when starting a refresh with libraries containing millions of assets. Now, we queue the refresh jobs in batches. These enhancements won't make scanning go any faster, but they greatly reduce the likelihood of out-of-memory errors that would cause Immich to crash.

##### Mobile album sync

You can now sync or mirror an album from your phone to the Immich server on your account. For example, if you select `Recents`, `Camera` and `Videos` album for backup, the corresponding album with the same name will be created on the server. Once the assets from those albums are uploaded, they will be put into the target albums automatically.

You can enable this feature from the album selection in the backup screen.

<img src="https://github.com/user-attachments/assets/67b329f5-15ff-4128-af52-4a50df852a07" width="300" alt="sync-album"/>

For existing installations, you can sync the already uploaded assets by going to the backup screen and pressing the `Sync` button.

<img src="https://github.com/user-attachments/assets/ca0847fd-edab-4ebe-b8e1-093ce7e3cc37" width="300" alt="sync-button"/>

Have a wonderful weekend,

Cheers!

***

##### Support Immich

<p align="center">
<img src="https://media.giphy.com/media/v1.Y2lkPTc5MGI3NjExbjY2eWc5Y2F0ZW56MmR4aWE0dDhzZXlidXRmYWZyajl1bWZidXZpcyZlcD12MV9pbnRlcm5hbF9naWZfYnlfaWQmY3Q9Zw/87CKDqErVfMqY/giphy.gif" width="450" title="SUPPORT THE PROJECT!">
</p>

If you find the project helpful, you can support Immich by purchasing a product key at <https://buy.immich.app>.

Cheers! 🍻

<!-- Release notes generated using configuration in .github/release.yml at main -->

##### What's Changed

##### 🚨 Breaking Changes

-   feat(server): granular permissions for api keys by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#11824
-   refactor(server): stacks by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#11453
-   fix(server): album statistics endpoint by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#11924
-   fix: remove `asset.resized` by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#11983
-   fix(mobile): use a valid OAuth callback URL by [@&#8203;qrkourier](https://github.com/qrkourier) in immich-app/immich#10832

##### 🚀 Features

-   feat: folder view by [@&#8203;davidakerr](https://github.com/davidakerr) in immich-app/immich#11880
-   feat(web): Scroll to asset in gridview; increase gridview perf; reduce memory; scrollbar ticks in fixed position by [@&#8203;midzelis](https://github.com/midzelis) in immich-app/immich#10646
-   feat: loading screen, initSDK on bootstrap, fix FOUC for theme by [@&#8203;midzelis](https://github.com/midzelis) in immich-app/immich#10350
-   feat(mobile): preserve mobile album info on upload by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#11965
-   feat: tags by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#11980
-   feat(web): jump to timeline by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#12117

##### 🌟 Enhancements

-   feat(server): do not automatically download android motion videos by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#11774
-   feat(web): pasting coordinates by [@&#8203;michelheusschen](https://github.com/michelheusschen) in immich-app/immich#11866
-   feat(web): drag and drop or paste directories for upload by [@&#8203;simkli](https://github.com/simkli) in immich-app/immich#11879
-   feat(web): Left hand navigation for memories by [@&#8203;carlesalbasboix](https://github.com/carlesalbasboix) in immich-app/immich#11913
-   feat(web): my immich shortcut by [@&#8203;danieldietzler](https://github.com/danieldietzler) in immich-app/immich#12007
-   fix(web): show a clearer confirmation message when deleting an unnamed album by [@&#8203;Snowknight26](https://github.com/Snowknight26) in immich-app/immich#11988
-   feat(format): nrw format by [@&#8203;avsm](https://github.com/avsm) in immich-app/immich#12048
-   feat(web): restore scroll position on navigating back to search page by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#12042
-   feat(server): Storage template support album condition by [@&#8203;feyst](https://github.com/feyst) in immich-app/immich#12000
-   fix(mobile): Changes in the UI for the image editor pages by [@&#8203;Yuvi-raj-P](https://github.com/Yuvi-raj-P) in immich-app/immich#12018
-   feat(web): announce notifications to screen readers by [@&#8203;ben-basten](https://github.com/ben-basten) in immich-app/immich#12071
-   fix(server): don't crash when refreshing large libraries by [@&#8203;etnoy](https://github.com/etnoy) in immich-app/immich#7934
-   feat(server): sort images in duplicate groups by date by [@&#8203;GeoffreyFrogeye](https://github.com/GeoffreyFrogeye) in immich-app/immich#12094
-   feat(ml): support dynamic scaling by [@&#8203;rkojedzinszky](https://github.com/rkojedzinszky) in immich-app/immich#12065
-   feat(web): navigate assets with gestures (next/prev) by [@&#8203;kaziu687](https://github.com/kaziu687) in immich-app/immich#11888
-   fix(mobile): allow create empty non-shared albums, add proper button colors by [@&#8203;src52](https://github.com/src52) in immich-app/immich#12103
-   feat: user's features preferences by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#12099
-   chore(server): log path when generating external thumbnail by [@&#8203;etnoy](https://github.com/etnoy) in immich-app/immich#12107

##### 🐛 Bug fixes

-   fix(web): focus trap inside portal by [@&#8203;michelheusschen](https://github.com/michelheusschen) in immich-app/immich#11797
-   fix(mobile): show correct notification icon for android by [@&#8203;karthikraja001](https://github.com/karthikraja001) in immich-app/immich#11863
-   fix(web): show camera make in search options after searching by [@&#8203;michelheusschen](https://github.com/michelheusschen) in immich-app/immich#11884
-   fix(web): correctly populate the camera model search dropdown by [@&#8203;Snowknight26](https://github.com/Snowknight26) in immich-app/immich#11883
-   fix(server): create shared album from the mobile app does not trigger send email invite by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#11911
-   fix(server): do not match live photos across libraries by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#11952
-   fix(web): rating stars accessibility by [@&#8203;ben-basten](https://github.com/ben-basten) in immich-app/immich#11966
-   fix(mobile): Fix for incorrectly naming edited files and structure change by [@&#8203;Yuvi-raj-P](https://github.com/Yuvi-raj-P) in immich-app/immich#11741
-   fix: align camera model drop down behavior with other drop downs on web and mobile by [@&#8203;x24git](https://github.com/x24git) in immich-app/immich#11951
-   fix(web): announce current theme to screen reader users by [@&#8203;ben-basten](https://github.com/ben-basten) in immich-app/immich#12039
-   fix(web): show supporter badge for account less than 14 days by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#12058
-   fix(web): shared link expiration date accessibility by [@&#8203;ben-basten](https://github.com/ben-basten) in immich-app/immich#12060
-   chore(web): ignore shortcut toggle when entering email and password by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#12082
-   chore(web): ensure goto is awaited for login page by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#12087
-   fix(server): ensure new exclusion patterns work by [@&#8203;etnoy](https://github.com/etnoy) in immich-app/immich#12102
-   fix(server): skip smtp validation if unchanged by [@&#8203;michelheusschen](https://github.com/michelheusschen) in immich-app/immich#12111
-   fix(mobile): long waiting time for login request when server is unreachable by [@&#8203;alextran1502](https://github.com/alextran1502) in immich-app/immich#12100
-   fix: user specific fields in asset search by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#12125
-   fix(web): Device list shows Ubuntu as unknown OS by [@&#8203;spfncer](https://github.com/spfncer) in immich-app/immich#12127
-   fix(web): reset asset grid after changing album order by [@&#8203;michelheusschen](https://github.com/michelheusschen) in immich-app/immich#12139

##### 📚 Documentation

-   fix(docs): read-only affects XMP writing by [@&#8203;C-Otto](https://github.com/C-Otto) in immich-app/immich#11823
-   docs: clarify external domain setting by [@&#8203;pikapower9080](https://github.com/pikapower9080) in immich-app/immich#11958
-   docs: add Immich Kiosk and Immich Power Tools to Community Projects by [@&#8203;Tyree](https://github.com/Tyree) in immich-app/immich#12055
-   docs: mTLS/self signed FAQ entry by [@&#8203;mmomjian](https://github.com/mmomjian) in immich-app/immich#12074
-   docs: external library deletion/edits by [@&#8203;mmomjian](https://github.com/mmomjian) in immich-app/immich#12079
-   docs: sql query for duplicate files by [@&#8203;mmomjian](https://github.com/mmomjian) in immich-app/immich#12086
-   docs: Documentation updates by [@&#8203;aviv926](https://github.com/aviv926) in immich-app/immich#11516
-   docs: update roadmap by [@&#8203;jrasm91](https://github.com/jrasm91) in immich-app/immich#12126
-   fix: README_zh_CN.md link by [@&#8203;ttzytt](https://github.com/ttzytt) in immich-app/immich#12124
-   docs(guide): nginx caching proxy by [@&#8203;pcouy](https://github.com/pcouy) in immich-app/immich#12140

##### New Contributors

-   [@&#8203;aaronjrodrigues](https://github.com/aaronjrodrigues) made their first contribution in immich-app/immich#11851
-   [@&#8203;karthikraja001](https://github.com/karthikraja001) made their first contribution in immich-app/immich#11863
-   [@&#8203;simkli](https://github.com/simkli) made their first contribution in immich-app/immich#11879
-   [@&#8203;carlesalbasboix](https://github.com/carlesalbasboix) made their first contribution in immich-app/immich#11907
-   [@&#8203;pikapower9080](https://github.com/pikapower9080) made their first contribution in immich-app/immich#11958
-   [@&#8203;davidakerr](https://github.com/davidakerr) made their first contribution in immich-app/immich#11880
-   [@&#8203;x24git](https://github.com/x24git) made their first contribution in immich-app/immich#11951
-   [@&#8203;Tonux599](https://github.com/Tonux599) made their first contribution in immich-app/immich#12027
-   [@&#8203;avsm](https://github.com/avsm) made their first contribution in immich-app/immich#12048
-   [@&#8203;Tyree](https://github.com/Tyree) made their first contribution in immich-app/immich#12055
-   [@&#8203;feyst](https://github.com/feyst) made their first contribution in immich-app/immich#12000
-   [@&#8203;Tiefseetauchner](https://github.com/Tiefseetauchner) made their first contribution in immich-app/immich#11874
-   [@&#8203;qrkourier](https://github.com/qrkourier) made their first contribution in immich-app/immich#10832
-   [@&#8203;GeoffreyFrogeye](https://github.com/GeoffreyFrogeye) made their first contribution in immich-app/immich#12094
-   [@&#8203;rkojedzinszky](https://github.com/rkojedzinszky) made their first contribution in immich-app/immich#12065
-   [@&#8203;kaziu687](https://github.com/kaziu687) made their first contribution in immich-app/immich#11888
-   [@&#8203;src52](https://github.com/src52) made their first contribution in immich-app/immich#12103
-   [@&#8203;spfncer](https://github.com/spfncer) made their first contribution in immich-app/immich#12127
-   [@&#8203;ttzytt](https://github.com/ttzytt) made their first contribution in immich-app/immich#12124

**Full Changelog**: https://github.com/immich-app/immich/compare/v1.112.1...

</details>

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOC41OC4wIiwidXBkYXRlZEluVmVyIjoiMzguNTguMCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciIsImxhYmVscyI6W119-->

Co-authored-by: Renovate Bot <[email protected]>
Co-authored-by: Calvin Bui <[email protected]>
Reviewed-on: https://gitea.bui.ng/calvinbui/ansible-monorepo/pulls/2857
Co-authored-by: renovate <[email protected]>
Co-committed-by: renovate <[email protected]>
@bo0tzz bo0tzz mentioned this pull request Sep 4, 2024
@Knuppel1983
Copy link

Does this feature write the tags to the original files? If not can this be added as an option? Or an option to export the tags with the original files?

I want my photo library to be vendor-independant, so i can import / export without having to tag everything all over again...

@danieldietzler
Copy link
Member

Does this feature write the tags to the original files? If not can this be added as an option? Or an option to export the tags with the original files?

I want my photo library to be vendor-independant, so i can import / export without having to tag everything all over again...

It writes the tags to an XMP sidecar file, just like any other metadata you change within immich

@Knuppel1983
Copy link

Does this feature write the tags to the original files? If not can this be added as an option? Or an option to export the tags with the original files?
I want my photo library to be vendor-independant, so i can import / export without having to tag everything all over again...

It writes the tags to an XMP sidecar file, just like any other metadata you change within immich

Ok that will do. Please also add an option to disable smart search, and search by tag only. Some of us don't need machine learning, and it puts a lot of strain on low powered devices.

@jrasm91
Copy link
Contributor Author

jrasm91 commented Oct 7, 2024

@Knuppel1983 you can already do this from the admin settings.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants