merge refactors pr #364 from @michilyy

* Save to DB only unique trackhashes

* Add check if track already exists in playlist

* replace all paths with `pathlib.Path`

* `architecture.md`:
* add config folder layout

`config.py`:
* fix bug where `pathlib.Path` cannot be serialized

`files.py`:
* remove unused imports
* update path concatenation to `pathlib.Path`
* add config-folder creation

`imgserver.py`:
* fix serialisation bug

`playlistlib.py`:
* update path concatenation to `pathlib.Path`

* update all `settings.Paths` usages to new singleton `Paths` class.

* update all usages of `settings.Paths`

* `files.py`:
* rework assets copy function.
* remove unused loop and unused `shutil.copy2` function

`settings.py`
* fix recursion exception in `Paths`

* `settings.py`:
* remove Singleton and `@property` todos from `Paths`

* `__init__.py`:
* remove now unused function `create_config_dir()`

`setup.files`:
* remove because merged into `settings.Paths()`
  for more central and clear flow how the base path gets decided

`settings.py`:
* add `copy_assets` function

`start_swingmusic.py`:
* add configurable settings.Paths class

`__main__.py`:
* update click to used correct default path

* remove wrong commited egg files

* remove change in the wrong branch

* add forgotten `property` decorator
update `get_files_and_dirs` to use pathlib where possible

`config.py`:
* update type annotation

`folders.py`:
* convert `pathlib` to posix path where needed for sub-functions

`folderlib.py`:
* rework `get_files_and_dirs` to use `pathlib` where possible

`settings.py`:
* add forgotten `@property`

`start_swingmusic.py`:
* remove second `log_startup_info()`

* `artistlib.py`:
* fix calling property
`tagger.py`:
* fix comparing elements in `pathlib.Path`

* add support for repeating lyrics.

* rework lyrics api and lib

* update most path functions.
add type-hint pathlib where needed

* for serialization paths are converted to posix path

* use `open` instead of `os.open`
update `metaclass` with constant

* fix initial config exception if empty file existed

* update `userConfig` with `InitVar` to be excluded from `asdict`

* remove `is_windows_slash()`
rework path function to use pathlib

* convert `pathlib.Path` to `str` for serialization

* fixing bug with str + pathlib

* `__main__.py`:
* update click to use package version
* remove now unused function `print_version`

`filesystem.py`:
* rework `CWD` to use importlib

`pyproject.toml`:
* disable namespace for `importlib.resources` to work correctly

* update `lyrics.py`:
* remove unused functions
* simplify functions

* fix bug where assets get created on root

* remove unused code

* update lyrics for clearer structure.

* add support for unsynced lyrics

* fix wrong return type in unsynced lyrics

* update `/check` to use `send_lyrics`

* prefer tags to duplicates

* `lyrics.py`:
* add docs to a function group

* `logger.py`:
* add logging config dict.
* combine Logging into one file
* add socket logger
* add debug mode to logger
* add JSONL formater

* `logger.py`:
* update config to directly use the formater.
resolves circular import exception

`__main__.py`:
* add logger setup to main

`start_swingmusic.py`:
* add debug option to cli

* `lyrics.py`:
* add offset support

* add `setuptools-scm` to get version from git

* add support for docker build with scm

* add support for docker build with scm
need someone who can test the changes workflow

* update all usage of `version.txt` to `metadata.version()`

* 2x update all usage of `version.txt` to `metadata.version()`

* update to no local_scheme version

* provide fix for #331.
convert `sql.Row` and `TrackTable` to dict before converting to dataclass.

* fix `__main__.py`:
* wrong import and uncommited changes
* add debug and base_path parameter

* fix logger pathlib

* add client build workflow

* set name

* split client from build

* try fixing builds

* try another fix

* try also another fix

* try again something new

* try again something new

* change runner

* fix failed run because of malformed runner

* add wheel builds

* remove systems from pure python build

* add isolated pyinstaller build

* artifacts with names

* wrong wheel path

* try fetch-depth for tag fetch

* disable fail-fast.
add wheel installation

* add install system packages

* add debug

* fix wheel install
fix pyinstaller spec file

* try fix for pyinstaller

* try another fix

* build on release

* add concrete release types

* only run on released or pre-released

* try release upload

* reformat upload

* fix needs tag

* identifiable pyinstaller builds

* compress client folder before uploading

* update to src build

* remove no more needed aarch64 build script
rename pyinstaller assets to lowercase

* remove unneeded code

* fix: save to DB only unique track hashes

* replace click with argparse

* set concrete types in argparse

* replace manuall path usages with pathlib

* remove unused `configs.py` file

* reformat `start_swingmusic.py`

* fix empty set startup exception

* optimizing static files serve function

* fixing bug in optimisation of static files serve function

* fix folder view bug

* colorlib.py:
* fix wrong type exception
* remove singe use Index_everything class
* update logging of populate.py

* cleanup files

* fix settings.py Paths copy function.
Created folder on file.

* add exist check to folder

* remove unused `INFO` class

* fix multiprocessing bug on windows

* potential icon fix for pyinstaller
fix multiple logging bug

* fix argparse config path bug
add jobs file

* cleanup code fragments
fix logging issue
add notes to function

* note that concurrent creates own sys.modules

* refactor some lyrics plugin condition
remove unused import from hashing

* refactor taglib.py

* update import statements to be static

* playlistlib.py:
* refactoring and more doc strings
populate.py:
* add poc bugfix
settings.py:
* add typehint

* possible bugfix for multitreading globals

* folder.py:
* add check if provided path is absolute
populate.py:
* add bug note
settings.py:
* add possible error from Singleton implementation
start_swingmusic.py:
* correct spelling
* pass resolved path to Paths
tagger.py:
* add logging

* trying out fixes for multithreading

* only upload results not metadata

* fix build action again

* folder.py:
* strictly use pathlib where possible

folderlib.py:
* add missing docstring to function, who really need it.

track.py:
* refactor some code

folder.py:
* refactor some more code

* Merge DBPath class and Paths class.
Update all usages of DBPath

folderslib.py:
* fix bug with logging

taglib.py:
* add missing docstring

settings.py:
* merge classes
* refactor

* network.py:
* add more docstring

config.py:
* update pathlib usage

tools.py:
* refactor
* add docstrings

* colorlib.py:
* add docstring

Refactor App builder into grouped config settings.

* update assets access for migration

* Update FUNDING.yml

* Update FUNDING.yml

* upgrade tinytag in requirements.txt

* update readme

* update license

* update readme

* Update README.md

* Update README.md

* cleanup requirements.txt
remove unused import in audio_segment.py
add entrypoint.sh for appimage support
update pyproject.toml for optional dependencies
add appimage to github workflow

* fix invalid workflow file

* AppImage build needs more research.
Commenting for now

* testing a new build workflow

* add libev installation

* update workflow to new optional dependencies

* trying again another fix

* finally fix all optional deps installation correctly

* remove AppImage poc

* albumslib.py:
* add docstring

folder.py:
* add unix path fix

update logger name to `__name__`

* update build with docker
update Dockerfile with git
fix typo in lyrics.py
add dynamic deps back

* add log for static folder

* add missing import

* add some more todos

* add support for AppImages even when it's not perfect.

* quick bugfix for wrong appimage config path

* fix uploading not finding AppImages builds aka wrong pattern

* optimise docker build by using artifacts.
Add client path option.
change docstring to sphinx format

* add todos

* Now support AppImages for real:
manually build AppImage as we are building a complex project.

* fix missing dep in AppImage build

* add full AppImage metadata

* add missing image file.

* only update swingmusic appimage not tool

* add todo and fix AppImage build again.

* Try fixing some path mixup in AppImage build

* add debug tag to action

* correct path to appimage folder

* do not download tool before checkout

* Another fix for path in appimage build

* extend config files with more information

* default client dir is now inside the config dir.
TODOs updated.

* default client dir is now inside the config dir.
TODOs updated.
Add priority todos.

* Auto download client when client not found.
Respects user provided dir.

* rename `requests` submodule to `request`

* poc for arm AppImage builds

* try out another fix

* fix typo in build.yml

* add missing arch tag

* fix uploading double names

* unique naming

* enable fallback version for project.

* do not download client into readonly dir.

* fix relative client download path. Client was resolved into parent of config.

* remove client backup path as client is now downloadable

* `Paths` checks if config folder exists and creates it if necessary.
logger no more creates the config folder.
`app_builder.py`: static route no more with '/client'

* path are only created in MainProcess.
fix gz file not found.

* move assets into src and update usages accordingly

* remove solved todos

* Only upload artefacts if not draft/master aka only on tag

* wrong type in assets copy

* update log with correct priority

* add debug statements and logging to Paths

* remove debugging statement

* remove double version tag from docker build

* fork save release protection

* fix typo

* add fallback client dir for static builds.

* update argparse to new param

* add missing import pathlib

* add sparse checkout as we do not need everything downloaded

* add assets copy check

* init logger bevor Paths

* remove unused import

* check if logdir exists and create if not

* only add exec info to file

* remove exception log from cli

* move logging into main.
Allows tools support again.

* UserConfig now correctly uses _finished key.
Bug where _finished was never written

* double save serverId.
update root_dir to trow no exception on init.
remove debug param

* clean up TODOs

---------

Co-authored-by: skilletfun <skilletfun.laptew.sergey@yandex.ru>
Co-authored-by: Mungai Njoroge <geoffreymungai45@gmail.com>

src/swingmusic/lib/playlistlib.py

@@ -0,0 +1,171 @@
+"""
+This library contains all the functions related to playlists.
+"""
+import random
+import string
+import logging
+from PIL import Image, ImageSequence
+
+from swingmusic import settings
+from swingmusic.models.track import Track
+from swingmusic.store.albums import AlbumStore
+from swingmusic.store.tracks import TrackStore
+
+logger = logging.getLogger(__name__)
+
+def create_thumbnail(image: Image, img_name: str) -> str:
+    """
+    Creates a 250 px high thumbnail from the Image.
+    It will keep the aspect ratio.
+
+    Images are saved in the playlist-img path
+
+    :param image: Image object.
+    :param img_name: Name of image.
+    :return: Filename of image.
+    """
+
+    aspect_ratio = image.width / image.height
+    new_w = round(250 * aspect_ratio)
+    thumb = image.resize((new_w, 250), Image.Resampling.LANCZOS)
+
+    thumb_filename = "thumb_" + img_name
+    thumb_path = settings.Paths().playlist_img_path / thumb_filename
+
+    thumb.save(thumb_path, "webp")
+
+    return thumb_filename
+
+
+def create_gif_thumbnail(image: Image, img_name: str):
+    """
+    Creates a 250 px high thumbnail from the provided GIF.
+    Keeps the aspect ratio.
+
+    Images are saved in the playlist-img path
+
+    :param image: Image object.
+    :param img_name: Name of image.
+    :return: Filename of image.
+    """
+    thumb_name = "thumb_" + img_name
+    thumb_path = settings.Paths().playlist_img_path / thumb_name
+
+    frames = []
+    for frame in ImageSequence.Iterator(image):
+        aspect_ratio = frame.width / frame.height
+        new_w = round(250 * aspect_ratio)
+        thumb = frame.resize((new_w, 250), Image.Resampling.LANCZOS)
+
+        frames.append(thumb)
+
+    frames[0].save(thumb_path, save_all=True, append_images=frames[1:])
+
+    return thumb_name
+
+
+def save_p_image(img: Image, pid: int, content_type: str = None, filename: str = None) -> str:
+    """
+    Saves a playlist banner image and returns the filepath.
+    """
+    # img = Image.open(file)
+
+    random_str = "".join(random.choices(string.ascii_letters + string.digits, k=5))
+
+    if not filename:
+        filename = str(pid) + str(random_str) + ".webp"
+
+    full_img_path = settings.Paths().playlist_img_path / filename
+
+    if content_type == "image/gif":
+        frames = []
+
+        for frame in ImageSequence.Iterator(img):
+            frames.append(frame.copy())
+
+        frames[0].save(full_img_path, save_all=True, append_images=frames[1:])
+        create_gif_thumbnail(img, img_path=filename)
+
+        return filename
+
+    img.save(full_img_path, "webp")
+    create_thumbnail(img, img_name=filename)
+
+    return filename
+
+
+def duplicate_images(images: list):
+    if len(images) == 1:
+        images *= 4
+    elif len(images) == 2:
+        images += list(reversed(images))
+    elif len(images) == 3:
+        images = images + images[:1]
+
+    return images
+
+# TODO: mutable var in param.
+def get_first_4_images(
+        tracks: list[Track] = [],
+        trackhashes: list[str] = []
+) -> list[dict["str", str]]:
+    """
+    Returns images of the first 4 albums that appear in the track list.
+
+    When tracks are not passed, trackhashes need to be passed.
+    Tracks are then resolved from the store.
+    """
+    if len(trackhashes) > 0:
+        tracks = TrackStore.get_tracks_by_trackhashes(trackhashes)
+
+    albums = []
+
+    for track in tracks:
+        if track.albumhash not in albums:
+            albums.append(track.albumhash)
+
+            if len(albums) == 4:
+                break
+
+    albums = AlbumStore.get_albums_by_hashes(albums)
+    images = [
+        {
+            "image": album.image,
+            "color": album.color,
+        }
+        for album in albums
+    ]
+
+    if len(images) == 4:
+        return images
+
+    return duplicate_images(images)
+
+
+def cleanup_playlist_images() -> None:
+    """
+    Deletes all unlinked files in playlist-img folder.
+    All files not present in the PlaylistTable will get deleted
+    """
+    # Import here to avoid circular import
+    from swingmusic.db.userdata import PlaylistTable
+
+    playlists = PlaylistTable.get_all()
+    linked_images = {p.image for p in playlists if p.image and p.image != "None"}
+
+    playlist_dir = settings.Paths().playlist_img_path
+
+    # Find unlinked images (including thumbnails)
+    for file in playlist_dir.iterdir():
+        if not file.isfile:
+            continue
+
+        name = file.name # not stem. PlaylistTable saves with extension
+        if file not in linked_images:
+            if name.removeprefix("thumb_") not in linked_images:
+                continue
+
+            try:
+                file.unlink(missing_ok=True)
+            except OSError as e:
+                logger.exception("could not delete file", exc_info=e)