/// <summary>
/// Callback, invoked when the data property is accessed.
/// </summary>
protected override byte[] GetData()
{
if (!isDone)
{
Logger.Error("{0}Downloading is not completed : {1}", kLog, m_WebRequest.url);
throw new InvalidOperationException("Downloading is not completed. " + m_WebRequest.url);
}
else if (m_Buffer == null)
{
// Etag cache hit!
if (m_WebRequest.responseCode == 304)
{
Logger.Debug("<color=green>{0}Etag cache hit : {1}</color>", kLog, m_WebRequest.url);
m_Buffer = LoadCache(m_WebRequest.url);
}
// Download is completed successfully.
else if (m_WebRequest.responseCode == 200)
{
Logger.Debug("<color=green>{0}Download is completed successfully : {1}</color>", kLog, m_WebRequest.url);
m_Buffer = m_Stream.GetBuffer();
SaveCache(m_WebRequest.url, m_WebRequest.GetResponseHeader("Etag"), m_Buffer);
}
}
if (m_Stream != null)
{
m_Stream.Dispose();
m_Stream = null;
}
return(m_Buffer);
}
private void FilterSearch(List <LevelSO> levels)
{
// Make sure we can actually search.
if (this._settings.searchTerms.Count <= 0)
{
Logger.Error("Tried to search for a song with no valid search terms...");
SortSongName(levels);
return;
}
string searchTerm = this._settings.searchTerms[0];
if (String.IsNullOrEmpty(searchTerm))
{
Logger.Error("Empty search term entered.");
SortSongName(levels);
return;
}
Logger.Info("Filtering song list by search term: {0}", searchTerm);
_originalSongs.ForEach(x => Logger.Debug($"{x.songName} {x.songSubName} {x.songAuthorName}".ToLower().Contains(searchTerm.ToLower()).ToString()));
_filteredSongs = levels
.Where(x => $"{x.songName} {x.songSubName} {x.songAuthorName}".ToLower().Contains(searchTerm.ToLower()))
.ToList();
}
public IEnumerator RequestSongByLevelIDCoroutine(string levelId, Action <Song> callback)
{
UnityWebRequest wwwId = UnityWebRequest.Get($"{PluginConfig.BeatsaverURL}/api/songs/search/hash/" + levelId);
wwwId.timeout = 10;
yield return(wwwId.SendWebRequest());
if (wwwId.isNetworkError || wwwId.isHttpError)
{
Logger.Error(wwwId.error);
}
else
{
#if DEBUG
Logger.Info("Received response from BeatSaver...");
#endif
JSONNode node = JSON.Parse(wwwId.downloadHandler.text);
if (node["songs"].Count == 0)
{
Logger.Error($"Song {levelId} doesn't exist on BeatSaver!");
callback?.Invoke(null);
yield break;
}
Song _tempSong = Song.FromSearchNode(node["songs"][0]);
callback?.Invoke(_tempSong);
}
}
private List <BeatmapLevelSO> FilterSearch(List <BeatmapLevelSO> levels)
{
// Make sure we can actually search.
if (this._settings.searchTerms.Count <= 0)
{
Logger.Error("Tried to search for a song with no valid search terms...");
SortSongName(levels);
return(levels);
}
string searchTerm = this._settings.searchTerms[0];
if (String.IsNullOrEmpty(searchTerm))
{
Logger.Error("Empty search term entered.");
SortSongName(levels);
return(levels);
}
Logger.Info("Filtering song list by search term: {0}", searchTerm);
var terms = searchTerm.Split(' ');
foreach (var term in terms)
{
levels = levels.Intersect(
levels
.Where(x => $"{x.songName} {x.songSubName} {x.songAuthorName}".ToLower().Contains(term.ToLower()))
.ToList(
)
).ToList();
}
return(levels);
}
public IEnumerator DownloadScrappedData(Action <List <ScrappedSong> > callback)
{
Logger.Info("Downloading scrapped data...");
UnityWebRequest www;
bool timeout = false;
float time = 0f;
UnityWebRequestAsyncOperation asyncRequest;
try
{
www = UnityWebRequest.Get(scrappedDataURL);
asyncRequest = www.SendWebRequest();
}
catch (Exception e)
{
Logger.Exception("Exception hitting scrappedDataURL", e);
yield break;
}
while (!asyncRequest.isDone)
{
yield return(null);
time += Time.deltaTime;
if (time >= 5f && asyncRequest.progress == 0f)
{
www.Abort();
timeout = true;
Logger.Error("Connection timed out!");
}
}
if (www.isNetworkError || www.isHttpError || timeout)
{
Logger.Error("Unable to download scrapped data! " + (www.isNetworkError ? $"Network error: {www.error}" : (www.isHttpError ? $"HTTP error: {www.error}" : "Unknown error")));
}
else
{
Logger.Info("Received response from github.com...");
Songs = JsonConvert.DeserializeObject <List <ScrappedSong> >(www.downloadHandler.text).OrderByDescending(x => x.Diffs.Count > 0 ? x.Diffs.Max(y => y.Stars) : 0).ToList();
callback?.Invoke(Songs);
Logger.Info("Scrapped data downloaded!");
}
}
private void FilterPlaylist()
{
// bail if no playlist, usually means the settings stored one the user then moved.
if (this.CurrentPlaylist == null)
{
Logger.Error("Trying to load a null playlist...");
_filteredSongs = _originalSongs;
this.Settings.filterMode = SongFilterMode.None;
return;
}
Logger.Debug("Filtering songs for playlist: {0}", this.CurrentPlaylist.Title);
LevelCollectionSO levelCollections = Resources.FindObjectsOfTypeAll <LevelCollectionSO>().FirstOrDefault();
var levels = levelCollections.GetLevelsWithBeatmapCharacteristic(CurrentBeatmapCharacteristicSO);
//Dictionary<String, LevelSO> levelDict = levels.Select((val, index) => new { LevelId = val.levelID, Level = val }).ToDictionary(i => i.LevelId, i => i.Level);
Dictionary <String, LevelSO> levelDict = new Dictionary <string, LevelSO>();
foreach (LevelSO level in levels)
{
if (!levelDict.ContainsKey(level.levelID))
{
levelDict.Add(level.levelID, level);
}
}
List <LevelSO> songList = new List <LevelSO>();
foreach (PlaylistSong ps in this.CurrentPlaylist.Songs)
{
if (!String.IsNullOrEmpty(ps.LevelId))
{
if (levelDict.ContainsKey(ps.LevelId))
{
songList.Add(levelDict[ps.LevelId]);
}
}
else if (!ps.Key.StartsWith("Level_") && _keyToSong.ContainsKey(ps.Key))
{
songList.Add(_keyToSong[ps.Key]);
}
}
_originalSongs = songList;
_filteredSongs = _originalSongs;
Logger.Debug("Playlist filtered song count: {0}", _filteredSongs.Count);
}
private List <BeatmapLevelSO> FilterPlaylist()
{
// bail if no playlist, usually means the settings stored one the user then moved.
if (this.CurrentPlaylist == null)
{
Logger.Error("Trying to load a null playlist...");
this.Settings.filterMode = SongFilterMode.None;
return(null);
}
// Get song keys
PlaylistsCollection.MatchSongsForPlaylist(this.CurrentPlaylist, true);
Logger.Debug("Filtering songs for playlist: {0}", this.CurrentPlaylist.playlistTitle);
Dictionary <String, BeatmapLevelSO> levelDict = new Dictionary <string, BeatmapLevelSO>();
foreach (KeyValuePair <string, List <BeatmapLevelSO> > entry in _levelPackToSongs)
{
foreach (BeatmapLevelSO level in entry.Value)
{
if (!levelDict.ContainsKey(level.levelID))
{
levelDict.Add(level.levelID, level);
}
}
}
List <BeatmapLevelSO> songList = new List <BeatmapLevelSO>();
foreach (PlaylistSong ps in this.CurrentPlaylist.songs)
{
if (ps.level != null)
{
songList.Add(levelDict[ps.level.levelID]);
}
else
{
Logger.Warning("Could not find song in playlist: {0}", ps.songName);
}
}
Logger.Debug("Playlist filtered song count: {0}", songList.Count);
return(songList);
}
/// <summary>
/// Wait for score saber related files to download.
/// </summary>
/// <returns></returns>
private IEnumerator WaitForDownload()
{
if (ScoreSaberDatabaseDownloader.ScoreSaberDataFile != null)
{
Logger.Info("Using cached copy of ScoreSaberData...");
}
else
{
SongBrowserApplication.MainProgressBar.ShowMessage("Downloading BeatStar data...");
Logger.Info("Attempting to download: {0}", ScoreSaberDatabaseDownloader.SCRAPED_SCORE_SABER_JSON_URL);
using (UnityWebRequest www = UnityWebRequest.Get(ScoreSaberDatabaseDownloader.SCRAPED_SCORE_SABER_JSON_URL))
{
// Use 4MB cache, large enough for this file to grow for awhile.
www.SetCacheable(new CacheableDownloadHandlerScoreSaberData(www, _buffer));
yield return(www.SendWebRequest());
Logger.Debug("Returned from web request!...");
try
{
ScoreSaberDatabaseDownloader.ScoreSaberDataFile = (www.downloadHandler as CacheableDownloadHandlerScoreSaberData).ScoreSaberDataFile;
Logger.Info("Success downloading ScoreSaber data!");
SongBrowserApplication.MainProgressBar.ShowMessage("Success downloading BeatStar data...", 10.0f);
onScoreSaberDataDownloaded?.Invoke();
}
catch (System.InvalidOperationException)
{
Logger.Error("Failed to download ScoreSaber data file...");
}
catch (Exception e)
{
Logger.Exception("Exception trying to download ScoreSaber data file...", e);
}
}
}
}
public IEnumerator RequestSongByKeyCoroutine(string key, Action <Song> callback)
{
UnityWebRequest wwwId = UnityWebRequest.Get($"{PluginConfig.BeatsaverURL}/api/songs/detail/" + key);
wwwId.timeout = 10;
yield return(wwwId.SendWebRequest());
if (wwwId.isNetworkError || wwwId.isHttpError)
{
Logger.Error(wwwId.error);
}
else
{
#if DEBUG
Logger.Info("Received response from BeatSaver...");
#endif
JSONNode node = JSON.Parse(wwwId.downloadHandler.text);
Song _tempSong = new Song(node["song"]);
callback?.Invoke(_tempSong);
}
}
public IEnumerator GetInfoForSong(Playlist playlist, PlaylistSong song, Action <Song> songCallback)
{
string url = "";
bool _usingHash = false;
if (!string.IsNullOrEmpty(song.key))
{
url = $"{PluginConfig.beatsaverURL}/api/songs/detail/{song.key}";
if (!string.IsNullOrEmpty(playlist.customDetailUrl))
{
url = playlist.customDetailUrl + song.key;
}
}
else if (!string.IsNullOrEmpty(song.hash))
{
url = $"{PluginConfig.beatsaverURL}/api/songs/search/hash/{song.hash}";
_usingHash = true;
}
else if (!string.IsNullOrEmpty(song.levelId))
{
string hash = CustomHelpers.CheckHex(song.levelId.Substring(0, Math.Min(32, song.levelId.Length)));
url = $"{PluginConfig.beatsaverURL}/api/songs/search/hash/{hash}";
_usingHash = true;
}
else
{
yield break;
}
UnityWebRequest www = UnityWebRequest.Get(url);
www.timeout = 15;
yield return(www.SendWebRequest());
if (www.isNetworkError || www.isHttpError)
{
Logger.Error($"Unable to connect to {PluginConfig.beatsaverURL}! " + (www.isNetworkError ? $"Network error: {www.error}" : (www.isHttpError ? $"HTTP error: {www.error}" : "Unknown error")));
}
else
{
try
{
JSONNode node = JSON.Parse(www.downloadHandler.text);
if (_usingHash)
{
if (node["songs"].Count == 0)
{
Logger.Error($"Song {song.songName} doesn't exist on BeatSaver!");
songCallback?.Invoke(null);
yield break;
}
songCallback?.Invoke(Song.FromSearchNode(node["songs"][0]));
}
else
{
songCallback?.Invoke(new Song(node["song"]));
}
}
catch (Exception e)
{
Logger.Exception("Unable to parse response! Exception: " + e);
}
}
}
/// <summary>
/// Get the song cache from the game.
/// </summary>
public void UpdateSongLists(BeatmapCharacteristicSO gameplayMode)
{
// give up
if (gameplayMode == null)
{
Logger.Debug("Always null first time if user waits for SongLoader event, which they should...");
return;
}
Stopwatch timer = new Stopwatch();
timer.Start();
// Get the level collection from song loader
LevelCollectionSO levelCollections = Resources.FindObjectsOfTypeAll <LevelCollectionSO>().FirstOrDefault();
// Stash everything we need
_originalSongs = levelCollections.GetLevelsWithBeatmapCharacteristic(gameplayMode).ToList();
Logger.Debug("Got {0} songs from level collections...", _originalSongs.Count);
//_originalSongs.ForEach(x => Logger.Debug("{0} by {1} = {2}", x.name, x.levelAuthorName, x.levelID));
_sortedSongs = _originalSongs;
CurrentBeatmapCharacteristicSO = gameplayMode;
// Calculate some information about the custom song dir
String customSongsPath = Path.Combine(Environment.CurrentDirectory, CUSTOM_SONGS_DIR);
String revSlashCustomSongPath = customSongsPath.Replace('\\', '/');
double currentCustomSongDirLastWriteTIme = (File.GetLastWriteTimeUtc(customSongsPath) - EPOCH).TotalMilliseconds;
bool customSongDirChanged = false;
if (_customSongDirLastWriteTime != currentCustomSongDirLastWriteTIme)
{
customSongDirChanged = true;
_customSongDirLastWriteTime = currentCustomSongDirLastWriteTIme;
}
// This operation scales well
if (!Directory.Exists(customSongsPath))
{
Logger.Error("CustomSong directory is missing...");
return;
}
IEnumerable <string> directories = Directory.EnumerateDirectories(customSongsPath, "*.*", SearchOption.AllDirectories);
// Get LastWriteTimes
Stopwatch lastWriteTimer = new Stopwatch();
lastWriteTimer.Start();
foreach (var level in SongLoader.CustomLevels)
{
// If we already know this levelID, don't both updating it.
// SongLoader should filter duplicates but in case of failure we don't want to crash
if (!_cachedLastWriteTimes.ContainsKey(level.levelID) || customSongDirChanged)
{
_cachedLastWriteTimes[level.levelID] = (File.GetLastWriteTimeUtc(level.customSongInfo.path) - EPOCH).TotalMilliseconds;
}
if (!_levelIdToCustomLevel.ContainsKey(level.levelID))
{
_levelIdToCustomLevel.Add(level.levelID, level);
}
if (!_levelIdToSongVersion.ContainsKey(level.levelID))
{
DirectoryInfo info = new DirectoryInfo(level.customSongInfo.path);
string currentDirectoryName = info.Name;
String version = level.customSongInfo.path.Replace(revSlashCustomSongPath, "").Replace(currentDirectoryName, "").Replace("/", "");
if (!String.IsNullOrEmpty(version))
{
//Logger.Debug("MATCH");
_levelIdToSongVersion.Add(level.levelID, version);
_keyToSong.Add(version, level);
}
}
}
lastWriteTimer.Stop();
Logger.Info("Determining song download time and determining mappings took {0}ms", lastWriteTimer.ElapsedMilliseconds);
// Update song Infos, directory tree, and sort
this.UpdateScoreSaberDataMapping();
this.UpdatePlayCounts();
this.UpdateDirectoryTree(customSongsPath);
// Check if we need to upgrade settings file favorites
try
{
this.Settings.ConvertFavoritesToPlaylist(_levelIdToCustomLevel, _levelIdToSongVersion);
}
catch (Exception e)
{
Logger.Exception("FAILED TO CONVERT FAVORITES TO PLAYLIST!", e);
}
// load the current editing playlist or make one
if (!String.IsNullOrEmpty(this.Settings.currentEditingPlaylistFile))
{
CurrentEditingPlaylist = PlaylistsReader.ParsePlaylist(this.Settings.currentEditingPlaylistFile);
}
if (CurrentEditingPlaylist == null)
{
CurrentEditingPlaylist = new Playlist
{
Title = "Song Browser Favorites",
Author = "SongBrowserPlugin",
Path = this.Settings.currentEditingPlaylistFile,
Image = Base64Sprites.PlaylistIconB64,
Songs = new List <PlaylistSong>(),
};
}
CurrentEditingPlaylistLevelIds = new HashSet <string>();
foreach (PlaylistSong ps in CurrentEditingPlaylist.Songs)
{
CurrentEditingPlaylistLevelIds.Add(ps.LevelId);
}
// Actually sort and filter
this.ProcessSongList();
// Signal complete
if (SongLoader.CustomLevels.Count > 0)
{
didFinishProcessingSongs?.Invoke(SongLoader.CustomLevels);
}
timer.Stop();
Logger.Info("Updating songs infos took {0}ms", timer.ElapsedMilliseconds);
Logger.Debug("Song Browser knows about {0} songs from SongLoader...", _originalSongs.Count);
}
public IEnumerator DownloadSongCoroutine(Song songInfo)
{
songInfo.songQueueState = SongQueueState.Downloading;
UnityWebRequest www;
bool timeout = false;
float time = 0f;
UnityWebRequestAsyncOperation asyncRequest;
try
{
www = UnityWebRequest.Get(songInfo.downloadUrl);
asyncRequest = www.SendWebRequest();
}
catch (Exception e)
{
Logger.Exception("DownloadSongCoroutine Exception", e);
songInfo.songQueueState = SongQueueState.Error;
songInfo.downloadingProgress = 1f;
yield break;
}
while ((!asyncRequest.isDone || songInfo.downloadingProgress != 1f) && songInfo.songQueueState != SongQueueState.Error)
{
yield return(null);
time += Time.deltaTime;
if ((time >= 5f && asyncRequest.progress == 0f) || songInfo.songQueueState == SongQueueState.Error)
{
www.Abort();
timeout = true;
Logger.Error("Connection timed out!");
}
songInfo.downloadingProgress = asyncRequest.progress;
}
if (www.isNetworkError || www.isHttpError || timeout || songInfo.songQueueState == SongQueueState.Error)
{
songInfo.songQueueState = SongQueueState.Error;
Logger.Error("Unable to download song! " + (www.isNetworkError ? $"Network error: {www.error}" : (www.isHttpError ? $"HTTP error: {www.error}" : "Unknown error")));
}
else
{
Logger.Info("Received response from BeatSaver.com...");
//string zipPath = "";
string docPath = "";
string customSongsPath = "";
byte[] data = www.downloadHandler.data;
Stream zipStream = null;
try
{
docPath = Application.dataPath;
docPath = docPath.Substring(0, docPath.Length - 5);
docPath = docPath.Substring(0, docPath.LastIndexOf("/"));
customSongsPath = docPath + "/CustomSongs/" + songInfo.id + "/";
if (!Directory.Exists(customSongsPath))
{
Directory.CreateDirectory(customSongsPath);
}
zipStream = new MemoryStream(data);
Logger.Info("Downloaded zip!");
}
catch (Exception e)
{
Logger.Exception("DownloadSongCoroutine exception:", e);
songInfo.songQueueState = SongQueueState.Error;
yield break;
}
while (_extractingZip)
{
yield return(new WaitForSecondsRealtime(0.25f));
}
yield return(new WaitWhile(() => _extractingZip)); //because extracting several songs at once sometimes hangs the game
Task extract = ExtractZipAsync(songInfo, zipStream, customSongsPath);
yield return(new WaitWhile(() => !extract.IsCompleted));
songDownloaded?.Invoke(songInfo);
}
}
/// <summary>
/// Get the song cache from the game.
/// </summary>
public void UpdateLevelRecords()
{
Stopwatch timer = new Stopwatch();
timer.Start();
// Calculate some information about the custom song dir
String customSongsPath = Path.Combine(Environment.CurrentDirectory, CUSTOM_SONGS_DIR);
String revSlashCustomSongPath = customSongsPath.Replace('\\', '/');
double currentCustomSongDirLastWriteTIme = (File.GetLastWriteTimeUtc(customSongsPath) - EPOCH).TotalMilliseconds;
bool customSongDirChanged = false;
if (_customSongDirLastWriteTime != currentCustomSongDirLastWriteTIme)
{
customSongDirChanged = true;
_customSongDirLastWriteTime = currentCustomSongDirLastWriteTIme;
}
if (!Directory.Exists(customSongsPath))
{
Logger.Error("CustomSong directory is missing...");
return;
}
IEnumerable <string> directories = Directory.EnumerateDirectories(customSongsPath, "*.*", SearchOption.AllDirectories);
// Get LastWriteTimes
Stopwatch lastWriteTimer = new Stopwatch();
lastWriteTimer.Start();
foreach (var level in SongLoader.CustomLevels)
{
// If we already know this levelID, don't both updating it.
// SongLoader should filter duplicates but in case of failure we don't want to crash
if (!_cachedLastWriteTimes.ContainsKey(level.levelID) || customSongDirChanged)
{
// Always use the newest date.
var lastWriteTime = File.GetLastWriteTimeUtc(level.customSongInfo.path);
var lastCreateTime = File.GetCreationTimeUtc(level.customSongInfo.path);
var lastTime = lastWriteTime > lastCreateTime ? lastWriteTime : lastCreateTime;
_cachedLastWriteTimes[level.levelID] = (lastTime - EPOCH).TotalMilliseconds;
}
if (!_levelIdToCustomLevel.ContainsKey(level.levelID))
{
_levelIdToCustomLevel.Add(level.levelID, level);
}
if (!_levelIdToSongVersion.ContainsKey(level.levelID))
{
DirectoryInfo info = new DirectoryInfo(level.customSongInfo.path);
string currentDirectoryName = info.Name;
String version = level.customSongInfo.path.Replace(revSlashCustomSongPath, "").Replace(currentDirectoryName, "").Replace("/", "");
if (!String.IsNullOrEmpty(version))
{
_levelIdToSongVersion.Add(level.levelID, version);
if (!_keyToSong.ContainsKey(version))
{
_keyToSong.Add(version, level);
}
}
}
}
lastWriteTimer.Stop();
Logger.Info("Determining song download time and determining mappings took {0}ms", lastWriteTimer.ElapsedMilliseconds);
// Update song Infos, directory tree, and sort
this.UpdateScoreSaberDataMapping();
this.UpdatePlayCounts();
// Check if we need to upgrade settings file favorites
try
{
this.Settings.ConvertFavoritesToPlaylist(_levelIdToCustomLevel, _levelIdToSongVersion);
}
catch (Exception e)
{
Logger.Exception("FAILED TO CONVERT FAVORITES TO PLAYLIST!", e);
}
// load the current editing playlist or make one
if (CurrentEditingPlaylist == null && !String.IsNullOrEmpty(this.Settings.currentEditingPlaylistFile))
{
Logger.Debug("Loading playlist for editing: {0}", this.Settings.currentEditingPlaylistFile);
CurrentEditingPlaylist = Playlist.LoadPlaylist(this.Settings.currentEditingPlaylistFile);
PlaylistsCollection.MatchSongsForPlaylist(CurrentEditingPlaylist);
}
if (CurrentEditingPlaylist == null)
{
Logger.Debug("Current editing playlist does not exit, create...");
CurrentEditingPlaylist = new Playlist
{
playlistTitle = "Song Browser Favorites",
playlistAuthor = "SongBrowserPlugin",
fileLoc = this.Settings.currentEditingPlaylistFile,
image = Base64Sprites.PlaylistIconB64,
songs = new List <PlaylistSong>(),
};
}
CurrentEditingPlaylistLevelIds = new HashSet <string>();
foreach (PlaylistSong ps in CurrentEditingPlaylist.songs)
{
// Sometimes we cannot match a song
if (ps.level == null)
{
continue;
}
CurrentEditingPlaylistLevelIds.Add(ps.level.levelID);
}
// Actually sort and filter
//this.ProcessSongList();
// Signal complete
if (SongLoader.CustomLevels.Count > 0)
{
didFinishProcessingSongs?.Invoke(SongLoader.CustomLevels);
}
timer.Stop();
Logger.Info("Updating songs infos took {0}ms", timer.ElapsedMilliseconds);
}