Re-Implement Song Deletion

Themes/_fallback/metrics.ini

@@ -2215,7 +2215,7 @@ LineGO="lua,GlobalOffsetSeconds()"
 Fallback="ScreenOptionsServiceChild"
 NextScreen="ScreenOptionsService"
 PrevScreen="ScreenOptionsService"
-LineNames="3,4,SI,SM,HN,SSR,14,30,OsuLifts,ReplayMods,PR,PackProgress,MinidumpUpload"
+LineNames="3,4,SI,SM,HN,SSR,14,30,OsuLifts,ReplayMods,PR,PackProgress,MinidumpUpload,AllowSongDeletion"
 #LineScore="lua,UserPrefScoringMode()"
 Line3="lua,JudgeDifficulty()"
 Line4="conf,LifeDifficulty"
@@ -2225,6 +2225,7 @@ LineHN="conf,MinTNSToHideNotes"
 LineSSR="conf,SortBySSRNormPercent"
 Line14="conf,EasterEggs"
 Line30="conf,FastLoad"
+LineAllowSongDeletion="conf,AllowSongDeletion"
 #Line31="conf,FastLoadAdditionalSongs"
 LinePR="conf,EnablePitchRates"
 LineOsuLifts="conf,LiftsOnOsuHolds"

src/Etterna/Screen/Options/ScreenOptionsMasterPrefs.cpp

@@ -827,6 +827,8 @@ InitializeConfOptions()
 	ADD(ConfOption("PackProgressInWheel", MovePref<bool>, "Off", "On"));
 	ADD(ConfOption("EnableMinidumpUpload", MovePref<bool>, "Off", "On"));
 
+	ADD(ConfOption("AllowSongDeletion", MovePref<bool>, "Off", "On"));
+
 	// Machine options
 	ADD(ConfOption("TimingWindowScale",
 				   TimingWindowScale,

src/Etterna/Screen/Others/ScreenSelectMusic.cpp

@@ -37,6 +37,10 @@
 #include "Etterna/Actor/Gameplay/Player.h"
 #include "Etterna/Models/NoteData/NoteDataUtil.h"
 #include "Etterna/Singletons/ReplayManager.h"
+#include "Etterna/Screen/Others/ScreenPrompt.h"
+#include <filesystem>
+
+#include <Core/Platform/Platform.hpp>
 
 #include <algorithm>
 
@@ -56,6 +60,7 @@ AutoScreenMessage(SM_SongChanged);
 AutoScreenMessage(SM_SortOrderChanging);
 AutoScreenMessage(SM_SortOrderChanged);
 AutoScreenMessage(SM_BackFromPlayerOptions);
+AutoScreenMessage(SM_ConfirmDeleteSong);
 AutoScreenMessage(SM_BackFromNamePlaylist);
 AutoScreenMessage(SM_BackFromCalcTestStuff);
 
@@ -387,10 +392,10 @@ void
 ScreenSelectMusic::DifferentialReload()
 {
 	// reload songs
-	SONGMAN->DifferentialReload();
-
+	SONGMAN->DifferentialReload();
+
 	if (IsTransitioning() || m_SelectionState == SelectionState_Finalized) {
-		return;
+		return;
 	}
 
 	const auto selSong = GAMESTATE->m_pCurSong;
@@ -473,6 +478,24 @@ ScreenSelectMusic::Input(const InputEventPlus& input)
 			m_MusicWheel.IsSettled() && input.type == IET_FIRST_PRESS) {
 			if (ReloadCurrentSong())
 				return true;
+		} else if (input.DeviceI.device == DEVICE_KEYBOARD && bHoldingCtrl &&
+				   input.DeviceI.button == KEY_BACK &&
+				   input.type == IET_FIRST_PRESS && m_MusicWheel.IsSettled()) {
+
+			// Keyboard shortcut to delete a song from disk (ctrl + backspace)
+			Song* songToDelete = m_MusicWheel.GetSelectedSong();
+
+			if (songToDelete && PREFSMAN->m_bAllowSongDeletion.Get()) {
+				m_pSongAwaitingDeletionConfirmation = songToDelete;
+
+				ScreenPrompt::Prompt(
+				  SM_ConfirmDeleteSong,
+				  ssprintf(PERMANENTLY_DELETE.GetValue(),
+						   songToDelete->m_sMainTitle.c_str(),
+						   songToDelete->GetSongDir().c_str()),
+				  PROMPT_YES_NO);
+				return true;
+			}
 		} else if (holding_shift && bHoldingCtrl && c == 'P' &&
 				   m_MusicWheel.IsSettled() && input.type == IET_FIRST_PRESS) {
 			if (ReloadCurrentPack())
@@ -978,7 +1001,16 @@ ScreenSelectMusic::HandleScreenMessage(const ScreenMessage& SM)
 		CodeDetector::RefreshCacheItems(CODES);
 	} else if (SM == SM_LoseFocus) {
 		CodeDetector::RefreshCacheItems(); // reset for other screens
-	} else if (SM == SM_BackFromCalcTestStuff) {
+	} else if (SM == SM_ConfirmDeleteSong) {
+		if (ScreenPrompt::s_LastAnswer == ANSWER_YES) {
+			OnConfirmSongDeletion();
+		} else {
+			// need to resume the song preview that was automatically paused
+			m_MusicWheel.ChangeMusic(0);
+		}
+	}
+	else if (SM == SM_BackFromCalcTestStuff)
+	{
 		auto ans = ScreenTextEntry::s_sLastAnswer;
 		std::vector<std::string> words;
 		std::istringstream iss(ans);
@@ -1103,6 +1135,32 @@ ScreenSelectMusic::HandleScreenMessage(const ScreenMessage& SM)
 	ScreenWithMenuElements::HandleScreenMessage(SM);
 }
 
+void
+ScreenSelectMusic::OnConfirmSongDeletion()
+{
+	Song* deletedSong = m_pSongAwaitingDeletionConfirmation;
+	if (!deletedSong) {
+		//Locator::getLogger()->warn("Attempted to delete a null song (ScreenSelectMusic::OnConfirmSongDeletion)");
+		return;
+	}
+
+	/* TODO: Make this platform independent */
+	const ghc::filesystem::path exeLocation = Core::Platform::getExecutableDirectory();
+	const std::string prefix = exeLocation.parent_path();
+	const std::filesystem::path songDir = std::filesystem::u8path(prefix + deletedSong->GetSongDir());
+
+
+	// flush the deleted song from any caches
+	SONGMAN->UnlistSong(deletedSong);
+	// refresh the song list
+	m_MusicWheel.ReloadSongList(false, "");
+	//Locator::getLogger()->trace("Deleting song: ", songDir.c_str());
+	// delete the song directory from disk
+
+	std::filesystem::remove_all(songDir);
+	m_pSongAwaitingDeletionConfirmation = NULL;
+}
+
 bool
 ScreenSelectMusic::MenuStart(const InputEventPlus& input)
 {

src/Etterna/Screen/Others/ScreenSelectMusic.h

@@ -86,6 +86,9 @@ class ScreenSelectMusic : public ScreenWithMenuElements
 	void SwitchToPreferredDifficulty();
 	void AfterMusicChange();
 
+	Song* m_pSongAwaitingDeletionConfirmation;
+	void OnConfirmSongDeletion();
+
 	void CheckBackgroundRequests(bool bForce);
 	bool DetectCodes(const InputEventPlus& input);
 

src/Etterna/Singletons/PrefsManager.cpp

@@ -209,6 +209,7 @@ PrefsManager::PrefsManager()
   , m_logging_level("LoggingLevel", 2)
   , m_bEnableScoreboard("EnableScoreboard", true)
   , m_bEnableCrashUpload("EnableMinidumpUpload", false)
+  , m_bAllowSongDeletion("AllowSongDeletion", false)
   , m_bShowMinidumpUploadDialogue("ShowMinidumpUploadDialogue", true)
 
 {

src/Etterna/Singletons/PrefsManager.h

@@ -241,6 +241,8 @@ class PrefsManager
 	Preference<bool> m_bEnableCrashUpload;
 	Preference<bool> m_bShowMinidumpUploadDialogue;
 
+	Preference<bool> m_bAllowSongDeletion;
+
 	void ReadPrefsFromIni(const IniFile& ini,
 						  const std::string& sSection,
 						  bool bIsStatic);

src/Etterna/Singletons/SongManager.cpp

@@ -974,6 +974,11 @@ SongManager::FreeSongs()
 	m_pSongs.clear();
 	m_SongsByDir.clear();
 
+	// also free the songs that have been deleted from disk
+	for (unsigned i = 0; i < m_pDeletedSongs.size(); ++i)
+		SAFE_DELETE(m_pDeletedSongs[i]);
+	m_pDeletedSongs.clear();
+
 	m_mapSongGroupIndex.clear();
 	m_sSongGroupBannerPaths.clear();
 
@@ -984,6 +989,29 @@ SongManager::FreeSongs()
 	m_pPopularSongs.clear();
 }
 
+void
+SongManager::UnlistSong(Song* song)
+{
+	// cannot immediately free song data, as it is needed temporarily
+	// for smooth audio transitions, etc. Instead, remove it from the
+	// m_pSongs list and store it in a special place where it can safely
+	// be deleted later.
+	m_pDeletedSongs.emplace_back(song);
+
+	// remove all occurences of the song in each of our song vectors
+	vector<Song*>* songVectors[2] = { &m_pSongs,
+									  &m_pPopularSongs};
+	for (int songVecIdx = 0; songVecIdx < 2; ++songVecIdx) {
+		vector<Song*>& v = *songVectors[songVecIdx];
+		for (size_t i = 0; i < v.size(); ++i) {
+			if (v[i] == song) {
+				v.erase(v.begin() + i);
+				--i;
+			}
+		}
+	}
+}
+
 auto
 SongManager::IsGroupNeverCached(const std::string& group) const -> bool
 {

src/Etterna/Singletons/SongManager.h

@@ -36,6 +36,9 @@ class SongManager
 	void FreeSongs();
 	void Cleanup();
 
+	void UnlistSong(Song* song);
+
+
 	void Invalidate(const Song* pStaleSong);
 	static auto GetPlaylists() -> std::map<std::string, Playlist>&;
 	static void SaveEnabledSongsToPref();
@@ -179,6 +182,9 @@ class SongManager
 
 	std::set<std::string> m_GroupsToNeverCache;
 	/** @brief The most popular songs ranked by number of plays. */
+
+	std::vector<Song*> m_pDeletedSongs;
+
 	std::vector<Song*> m_pPopularSongs;
 
 	std::vector<std::string> m_sSongGroupNames;