aherman
/
SoulSync
mirror of https://github.com/Nezreka/SoulSync.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add $quality template var (filename only)

Browse Source 
Introduce a new $quality template variable that is only substituted into filenames to avoid splitting album folders when tracks of mixed qualities are present. Updates include:

- web_server.py: populate template contexts with 'quality' (from context['_audio_quality']), strip $quality from folder components, substitute it only in the filename, and clean up empty brackets/parentheses/dashes when the variable is empty.
- config/config.example.json and config/config.json: document the new variable in the file_organization template variables string.
- webui/index.html and webui/static/script.js: update UI help text and client-side template validation to include $quality.

This prevents folder fragmentation for albums with mixed-quality files while still allowing quality information in filenames.
pull/153/head
Broque Thomas 3 months ago
parent d4d2568f32
commit d858a7c85f
5 changed files with 52 additions and 14 deletions
Show Stats Download Patch File Download Diff File

2
config/config.example.json
Unescape View File

@ -48,7 +48,7 @@
},
"file_organization": {
"enabled": true,
"_template_variables": "Available: $artist, $albumartist, $album, $title, $track, $year, $playlist",
"_template_variables": "Available: $artist, $albumartist, $album, $title, $track, $year, $playlist, $quality (filename only)",
"templates": {
"album_path": "$albumartist/$albumartist - $album/$track - $title",
"single_path": "$artist/$artist - $title/$title",

2
config/config.json
Unescape View File

@ -48,7 +48,7 @@
},
"file_organization": {
"enabled": true,
"_template_variables": "Available: $artist, $albumartist, $album, $title, $track, $year, $playlist",
"_template_variables": "Available: $artist, $albumartist, $album, $title, $track, $year, $playlist, $quality (filename only)",
"templates": {
"album_path": "$albumartist/$albumartist - $album/$track - $title",
"single_path": "$artist/$artist - $title/$title",

50
web_server.py
Unescape View File

@ -8094,7 +8094,8 @@ def _build_final_path_for_track(context, spotify_artist, album_info, file_ext):
'title': track_name,
'playlist_name': playlist_name,
'track_number': 1,
'year': year
'year': year,
'quality': context.get('_audio_quality', '')
}
folder_path, filename_base = _get_file_path_from_template(template_context, 'playlist_path')
@ -8132,7 +8133,8 @@ def _build_final_path_for_track(context, spotify_artist, album_info, file_ext):
'album': album_info['album_name'],
'title': clean_track_name,
'track_number': track_number,
'year': year
'year': year,
'quality': context.get('_audio_quality', '')
}
# Multi-disc album subfolder support
@ -8179,7 +8181,8 @@ def _build_final_path_for_track(context, spotify_artist, album_info, file_ext):
'album': album_info.get('album_name', clean_track_name) if album_info else clean_track_name,
'title': clean_track_name,
'track_number': 1,
'year': year
'year': year,
'quality': context.get('_audio_quality', '')
}
folder_path, filename_base = _get_file_path_from_template(template_context, 'single_path')
@ -8316,20 +8319,55 @@ def _get_file_path_from_template(context: dict, template_type: str = 'album_path
# Split into folder and filename
path_parts = full_path.split('/')
# Handle $quality: only substituted in the filename (last component).
# In folder components it becomes empty string to prevent album splits
# when tracks arrive in mixed qualities (e.g., FLAC 16bit vs 24bit).
import re
quality_value = context.get('quality', '')
if len(path_parts) > 1:
folder_parts = path_parts[:-1]
filename_base = path_parts[-1]
# Strip $quality from folder parts and clean up artifacts
cleaned_folders = []
for part in folder_parts:
part = part.replace('$quality', '')
part = re.sub(r'\s*\[\s*\]', '', part) # empty []
part = re.sub(r'\s*\(\s*\)', '', part) # empty ()
part = re.sub(r'\s*\{\s*\}', '', part) # empty {}
part = re.sub(r'\s*-\s*$', '', part) # trailing dash
part = re.sub(r'^\s*-\s*', '', part) # leading dash
part = re.sub(r'\s+', ' ', part).strip()
if part:
cleaned_folders.append(part)
# Substitute $quality in filename only
filename_base = filename_base.replace('$quality', quality_value)
# Clean up empty brackets/parens from any variable that resolved to empty
filename_base = re.sub(r'\s*\[\s*\]', '', filename_base)
filename_base = re.sub(r'\s*\(\s*\)', '', filename_base)
filename_base = re.sub(r'\s*\{\s*\}', '', filename_base)
filename_base = re.sub(r'\s*-\s*$', '', filename_base)
filename_base = re.sub(r'\s+', ' ', filename_base).strip()
# Sanitize each folder component
sanitized_folders = [_sanitize_filename(part) for part in folder_parts]
folder_path = os.path.join(*sanitized_folders)
sanitized_folders = [_sanitize_filename(part) for part in cleaned_folders]
folder_path = os.path.join(*sanitized_folders) if sanitized_folders else ''
# Sanitize filename
filename = _sanitize_filename(filename_base)
return folder_path, filename
else:
# Single component, treat as filename
# Single component, treat as filename — substitute $quality
full_path = full_path.replace('$quality', quality_value)
full_path = re.sub(r'\s*\[\s*\]', '', full_path)
full_path = re.sub(r'\s*\(\s*\)', '', full_path)
full_path = re.sub(r'\s*\{\s*\}', '', full_path)
full_path = re.sub(r'\s*-\s*$', '', full_path)
full_path = re.sub(r'\s+', ' ', full_path).strip()
return '', _sanitize_filename(full_path)
# METADATA & COVER ART HELPERS (Ported from downloads.py)

6
webui/index.html
Unescape View File

@ -3206,21 +3206,21 @@
<input type="text" id="template-album-path"
placeholder="$albumartist/$albumartist - $album/$track - $title">
<small style="color: #888;">Variables: $albumartist, $artist, $album, $title,
$track, $year</small>
$track, $year, $quality (filename only)</small>
</div>
<div class="form-group">
<label>Single Path Template:</label>
<input type="text" id="template-single-path"
placeholder="$artist/$artist - $title/$title">
<small style="color: #888;">Variables: $artist, $title, $album, $year</small>
<small style="color: #888;">Variables: $artist, $title, $album, $year, $quality (filename only)</small>
</div>
<div class="form-group">
<label>Playlist Path Template:</label>
<input type="text" id="template-playlist-path"
placeholder="$playlist/$artist - $title">
<small style="color: #888;">Variables: $playlist, $artist, $title, $year</small>
<small style="color: #888;">Variables: $playlist, $artist, $title, $year, $quality (filename only)</small>
</div>
<div class="form-group">

6
webui/static/script.js
Unescape View File

@ -1625,9 +1625,9 @@ function validateFileOrganizationTemplates() {
// Valid variables for each template type
const validVars = {
album: ['$artist', '$albumartist', '$album', '$title', '$track', '$year'],
single: ['$artist', '$albumartist', '$album', '$title', '$year'],
playlist: ['$artist', '$playlist', '$title', '$year']
album: ['$artist', '$albumartist', '$album', '$title', '$track', '$year', '$quality'],
single: ['$artist', '$albumartist', '$album', '$title', '$year', '$quality'],
playlist: ['$artist', '$playlist', '$title', '$year', '$quality']
};
// Get template values

Write Preview
Loading…
Cancel
Save