comment lib/database/update (#LLM-assisted - Claude)

Resolve "filename sanitization can fail with ascii-only target"

See merge request atom/AtOM!46

atom

@@ -265,7 +265,12 @@ do
 		rest=${line#*::AtOM:SQL:Sep::}
 		removeFileDestName=${rest%%::AtOM:SQL:Sep::*}
 		rest=${rest#*::AtOM:SQL:Sep::}
-		removefile[$removeFileId]="${destinationpath["$removeFileDestName"]}/${rest%%::AtOM:SQL:Sep::*}"
+		if [[ -n "${rest%%::AtOM:SQL:Sep::*}" ]]
+		then
+			removefile[$removeFileId]="${destinationpath["$removeFileDestName"]}/${rest%%::AtOM:SQL:Sep::*}"
+		else
+			removefile[$removeFileId]=''
+		fi
 		read -u4 -r -d $'\0' line
 	done
 done
@@ -475,6 +480,7 @@ echo '
 		tags.genre,
 		tags.performer,
 		tags.rate,
+		tags.rating,
 		tags.releasecountry,
 		tags.replaygain_alb,
 		tags.replaygain_trk,
@@ -555,6 +561,8 @@ do
 	rest=${rest#*::AtOM:SQL:Sep::}
 	rate=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
+	rating=${rest%%::AtOM:SQL:Sep::*}
+	rest=${rest#*::AtOM:SQL:Sep::}
 	releasecountry=${rest%%::AtOM:SQL:Sep::*}
 	rest=${rest#*::AtOM:SQL:Sep::}
 	replaygain_alb=${rest%%::AtOM:SQL:Sep::*}
@@ -625,6 +633,7 @@ do
 		mimetype	\
 		performer	\
 		rate		\
+		rating		\
 		releasecountry	\
 		replaygain_alb	\
 		replaygain_trk	\

lib/database/checkVersion

@@ -14,7 +14,7 @@
 # at the root of the project.
 
 # Current schema version this AtOM binary understands
-currentdbversion=8
+currentdbversion=9
 checkDatabaseVersion() {
 	local dbversion
 	# Try to read the stored version from the 'atom' metadata table

lib/database/upgradedatabase_8_9

@@ -0,0 +1,51 @@
+#!/usr/bin/env bash
+
+# Copyright © 2012-2026 ScriptFanix
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# A copy of the GNU General Public License v3 is includded in the LICENSE file
+# at the root of the project.
+
+upgradedatabase_8_9() {
+	echo "Upgrading database to version 9... (backup is $database.bak_v8)"
+	cp "$database" "$database.bak_v8"
+
+	echo '
+		ALTER TABLE tags ADD COLUMN rating FLOAT;
+		DROP TRIGGER force_destination_update_on_tag_update;
+		CREATE TRIGGER IF NOT EXISTS force_destination_update_on_tag_update
+		AFTER UPDATE OF
+			genre,
+			albumartist,
+			year,
+			album,
+			disc,
+			artist,
+			track,
+			title,
+			composer,
+			performer,
+			rating,
+			releasecountry,
+			replaygain_alb,
+			replaygain_trk,
+			rate,
+			channels,
+			bitrate,
+			depth
+		ON tags
+		BEGIN
+			UPDATE destination_files SET last_change=0
+			WHERE source_file_id=old.source_file;
+		END;
+	' >&3
+
+	Update atom version 9 <<<"1 = 1"
+}

lib/encode/mp3

@@ -28,6 +28,7 @@ encodeFile::mp3() {
 	[ -n "$albumartist" ] && lameopts+=(--tv TPE2="$albumartist")
 	[ -n "$composer" ] && lameopts+=(--tv TCOM="$composer")
 	[ -n "$performer" ] && lameopts+=(--tv TOPE="$performer")
+	[ -n "$rating" ] && lameopts+=(--tv "FMPS_RATING=$rating")
 	[ -n "$releasecountry" ] \
 		&& lameopts+=(--tv TXXX="MusicBrainz Album Release Country=$releasecountry")
 	[ -n "$replaygain_alb" ] \

lib/encode/opus

@@ -29,6 +29,7 @@ encodeFile::opus() {
 	[ -n "$disc"	] && opusencopts+=(--comment "DISCNUMBER=$disc")
 	[ -n "$genre"	] && opusencopts+=(--comment "GENRE=$genre")
 	[ -n "$performer" ] && opusencopts+=(--comment "PERFORMER=$performer")
+	[ -n "$rating" ] && opusencopts+=(--comment "FMPS_RATING=$rating")
 	[ -n "$releasecountry" ] \
 		&& opusencopts+=(--comment "RELEASECOUNTRY=$releasecountry")
 	[ -n "$replaygain_alb" ] 					\

lib/encode/vorbis

@@ -25,6 +25,7 @@ encodeFile::vorbis() {
 	[ -n "$disc"	] && oggencopts+=(-c "DISCNUMBER=$disc")
 	[ -n "$genre"	] && oggencopts+=(-G "$genre")
 	[ -n "$performer" ] && oggencopts+=(-c "PERFORMER=$performer")
+	[ -n "$rating" ] && oggencopts+=(--comment "FMPS_RATING=$rating")
 	[ -n "$releasecountry" ] \
 		&& oggencopts+=(-c "RELEASECOUNTRY=$releasecountry")
 	[ -n "$replaygain_alb" ] \

lib/files/getDestFile

@@ -55,11 +55,13 @@ getDestFile() {
 		destfile="${filename##*/}"
 		destfile="${destfile%.*}"
 	fi
-	destfile=$(sanitizeFile "$destfile")
-	destfile=${destfile//$'\n'/::AtOM:NewLine:SQL:Inline::}
 	if (( ${destinationascii["$destination"]} ))
 	then
+		destfile=${destfile//$'\n'/::AtOM:NewLine:SQL:Inline::}
 		echo "$destfile" >&${toascii[1]}
 		read -r -u${toascii[0]} destfile
+		destfile=${destfile//::AtOM:NewLine:SQL:Inline::/$'\n'}
 	fi
+	destfile=$(sanitizeFile "$destfile")
+	destfile=${destfile//$'\n'/::AtOM:NewLine:SQL:Inline::}
 }

lib/files/sanitizeFile

@@ -40,6 +40,9 @@ sanitizeFile() {
 			string=${string/#+(.)/}
 			string=${string/%+(.)/}
 		fi
+
+		# We can't have newlines either
+		string=${string//$'\n'/ }
 	fi
 	echo "$string"
 }

lib/tags/getInfos::FLAC

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-getInfosFLAC_version='FLAC-5'
+getInfosFLAC_version='FLAC-6'
 tagreaders+=( "$getInfosFLAC_version" )
 getInfos::FLAC() {
 	local			\
@@ -17,6 +17,7 @@ getInfos::FLAC() {
 			--show-tag=COMPOSER			\
 			--show-tag=DATE				\
 			--show-tag=DISCNUMBER			\
+			--show-tag=FMPS_RATING			\
 			--show-tag=GENRE			\
 			--show-tag=PERFORMER			\
 			--show-tag=RELEASECOUNTRY		\
@@ -34,6 +35,7 @@ getInfos::FLAC() {
 	disc=$(gettag discnumber)
 	genre=$(gettag genre)
 	performer=$(gettag performer)
+	rating=$(gettag fmps_rating)
 	releasecountry=$(gettag releasecountry)
 	replaygain_alb=$(gettag replaygain_album_gain)
 	replaygain_trk=$(gettag replaygain_track_gain)

lib/tags/getInfos::Opus

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-getInfosOpus_version='Opus-4'
+getInfosOpus_version='Opus-5'
 tagreaders+=( "$getInfosOpus_version" )
 getInfos::Opus() {
 	tagreader="$getInfosOpus_version"
@@ -15,6 +15,7 @@ getInfos::Opus() {
 	artist=$(gettag artist)
 	composer=$(gettag composer)
 	disc=$(gettag discnumber)
+	rating=$(gettag fmps_rating)
 	genre=$(gettag genre)
 	performer=$(gettag performer)
 	releasecountry=$(gettag releasecountry)

lib/tags/getInfos::ffmpeg

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-getInfosffmpeg_version='ffmpeg-9'
+getInfosffmpeg_version='ffmpeg-10'
 tagreaders+=( "$getInfosffmpeg_version" )
 getInfos::ffmpeg() {
 	tagreader="$getInfosffmpeg_version"
@@ -15,6 +15,7 @@ getInfos::ffmpeg() {
 					artist,				\
 					composer,			\
 					disc,				\
+					fmps_rating,
 					genre,				\
 					TOPE,				\
 					releasecountry,			\
@@ -40,6 +41,7 @@ getInfos::ffmpeg() {
 	disc=$(gettag TAG:disc)
 	genre=$(gettag TAG:genre)
 	performer=$(gettag TAG:TOPE)
+	rating=$(gettag fmps_rating)
 	releasecountry=$(gettag TAG:releasecountry)
 	[[ -z "$releasecountry" ]]					\
 	&& releasecountry=$(gettag "TAG:MusicBrainz Album Release Country")

lib/tags/getInfos::soxi

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-getInfosSoxi_version='soxi-3'
+getInfosSoxi_version='soxi-4'
 tagreaders+=( "$getInfosSoxi_version" )
 getInfos::soxi() {
 	tagreader="$getInfosSoxi_version"
@@ -15,6 +15,7 @@ getInfos::soxi() {
 	artist=$(gettag artist)
 	composer=$(gettag composer)
 	disc=$(gettag discnumber)
+	rating=$(gettag fmps_rating)
 	genre=$(gettag genre)
 	performer=$(gettag performer)
 	releasecountry=$(gettag releasecountry)

lib/tags/update

@@ -1,11 +1,33 @@
 #!/usr/bin/env bash
+
+# Copyright © 2012-2026 ScriptFanix
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# A copy of the GNU General Public License v3 is includded in the LICENSE file
+# at the root of the project.
+
 updateTags() {
 	local	reader			\
 
+	# Build a WHERE clause fragment that excludes files already read by any
+	# known reader version; files not matching any known version need a
+	# re-read
 	for reader in "${tagreaders[@]}"
 	do
 		tagreaderclause+="${tagreaderclause:+ AND }NOT tags.tagreader = \"$reader\""
 	done
+	# Query source files that need tag updates: either the file's
+	# last_change differs from the stored tag row's last_change, or the
+	# tagreader version has changed.
+	# Only files linked to a destination with action=1 (transcode) are
+	# included.
 	echo '
 		SELECT DISTINCT
 			source_files.id,
@@ -20,6 +42,7 @@ updateTags() {
 			tags.disc,
 			tags.genre,
 			tags.performer,
+			tags.rating,
 			tags.releasecountry,
 			tags.replaygain_alb,
 			tags.replaygain_trk,
@@ -47,11 +70,13 @@ updateTags() {
 			)
 		AND	mime_type_actions.action = 1
 		ORDER BY source_files.id' >&3
+	# Optionally cap the number of files processed in one run
 (( maxbatch )) && echo "LIMIT $maxbatch" >&3
 echo '
 ;
 
 		SELECT "AtOM:NoMoreFiles";' >&3
+	# Collect all result rows; sentinel "AtOM:NoMoreFiles" ends the loop
 	read -u4 -r -d $'\0' line
 	while ! [[ $line = AtOM:NoMoreFiles ]]
 	do
@@ -59,9 +84,10 @@ echo '
 		(( filecount++ ))
 		read -u4 -r -d $'\0' line
 	done
-	echo 'BEGIN TRANSACTION;' >&3
+	# Wrap all updates in a transaction	echo 'BEGIN TRANSACTION;' >&3
 	for line in "${tagfiles[@]}"
 	do
+		# Split each row on the ::AtOM:SQL:Sep:: column separator
 		sourcefileid=${line%%::AtOM:SQL:Sep::*}
 		rest=${line#*::AtOM:SQL:Sep::}
 		lastchange=${rest%%::AtOM:SQL:Sep::*}
@@ -86,6 +112,8 @@ echo '
 		rest=${rest#*::AtOM:SQL:Sep::}
 		oldperformer=${rest%%::AtOM:SQL:Sep::*}
 		rest=${rest#*::AtOM:SQL:Sep::}
+		oldrating=${rest%%::AtOM:SQL:Sep::*}
+		rest=${rest#*::AtOM:SQL:Sep::}
 		oldreleasecountry=${rest%%::AtOM:SQL:Sep::*}
 		rest=${rest#*::AtOM:SQL:Sep::}
 		oldreplaygain_alb=${rest%%::AtOM:SQL:Sep::*}
@@ -104,7 +132,9 @@ echo '
 		rest=${rest#*::AtOM:SQL:Sep::}
 		oldbitrate=${rest%%::AtOM:SQL:Sep::*}
 		((++count))
+		# Show percentage progress in interactive mode
 		(( cron )) || echo -en "\rTags: $((count*100/filecount))%"
+		# Commit every 100 files: limit reprocessing on interrupt/crash
 		if (( count % 100 == 0 ))
 		then
 			echo 'COMMIT;BEGIN TRANSACTION;' >&3
@@ -113,6 +143,10 @@ echo '
 		fi
 		if getTags
 		then
+			# Set a dirty flag for each field that changed since
+			# the last read;
+			# only changed fields will be included in the UPDATE
+			# statement below
 			[[ $oldalbum	!= "$album"	]]&& ual=1
 			[[ $oldalbumartist != "$albumartist" ]]&&uaa=1
 			[[ $oldartist	!= "$artist"	]]&& uar=1
@@ -130,6 +164,13 @@ echo '
 			[[ $oldrate	!= "$rate"	]]&& ura=1
 			[[ $oldchannels	!= "$channels"	]]&& uch=1
 			[[ $oldbitrate	!= "$bitrate"	]]&& ubi=1
+			# Emit an Update with only dirty columns plus
+			# last_change/tagreader.
+			# ::AtOM:FT:: prefix forces text quoting even for
+			# numeric-looking values.
+			# Absent values become SQL NULL (no quotes).
+			# Each ${flag:+col val} expands to nothing when the
+			# flag is unset.
 			Update tags					\
 			${ual:+album		"${album:+::AtOM:FT::}${album:-NULL}"}\
 			${uaa:+albumartist	"${albumartist:+::AtOM:FT::}${albumartist:-NULL}"}\
@@ -139,6 +180,8 @@ echo '
 			${udi:+disc		"${disc:-NULL}"}	\
 			${uge:+genre		"${genre:-NULL}"}	\
 			${upe:+performer	"${performer:+::AtOM:FT::}${performer:-NULL}"}\
+			${urr:+rating		"${rating:+::AtOM:FT::}${rating:-NULL}"}\
+			${urc:+releasecountry	"${releasecountry:+::AtOM:FT::}${releasecountry:-NULL}"}\
 			${urc:+releasecountry	"${releasecountry:+::AtOM:FT::}${releasecountry:-NULL}"}\
 			${urpa:+replaygain_alb	"${replaygain_alb:-NULL}"}\
 			${urpt:+replaygain_trk	"${replaygain_trk:-NULL}"}\
@@ -151,6 +194,8 @@ echo '
 			${ubi:+bitrate		"${bitrate:-NULL}"}	\
 			tagreader		"$tagreader"		\
 			>/dev/null <<<"source_file = $sourcefileid"
+			# Clear all tag variables and dirty flags for the next
+			# iteration
 			unset	genre			\
 				albumartist		\
 				year			\
@@ -161,6 +206,7 @@ echo '
 				title			\
 				composer		\
 				performer		\
+				rating			\
 				releasecountry		\
 				replaygain_alb		\
 				replaygain_trk		\
@@ -178,6 +224,7 @@ echo '
 				oldtitle		\
 				oldcomposer		\
 				oldperformer		\
+				oldrating		\
 				oldreleasecountry	\
 				oldreplaygain_alb	\
 				oldreplaygain_trk	\
@@ -193,6 +240,7 @@ echo '
 				udi			\
 				uge			\
 				upe			\
+				urr			\
 				urc			\
 				urpa			\
 				urpt			\
@@ -204,6 +252,7 @@ echo '
 				ubi
 		fi
 	done
+	# Commit the final partial batch
 	echo 'COMMIT;' >&3
 	(( cron )) || echo -n $'\r'
 	(( count )) && echo -n "Read tags from $count files."

share/schema.sql

@@ -57,6 +57,7 @@ CREATE TABLE IF NOT EXISTS tags (
 	title		TEXT,
 	composer	TEXT,
 	performer	TEXT,
+	rating		FLOAT,
 	releasecountry	TEXT,
 	replaygain_alb	TEXT,
 	replaygain_trk	TEXT,
@@ -131,6 +132,7 @@ CREATE TRIGGER IF NOT EXISTS force_destination_update_on_tag_update
 		title,
 		composer,
 		performer,
+		rating,
 		releasecountry,
 		replaygain_alb,
 		replaygain_trk,