Merge pull request #6433 from frenzibyte/online-store-proxy

Allow rewriting URL lookups in `OnlineStore`
ppy · Dec 6, 2024 · 83ea26d · 83ea26d
2 parents 2e19f17 + f13a1ce
commit 83ea26d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/osu.Framework/Game.cs b/osu.Framework/Game.cs
@@ -154,16 +154,16 @@ private void load(FrameworkConfigManager config)
             Textures = new TextureStore(Host.Renderer, Host.CreateTextureLoaderStore(new NamespacedResourceStore<byte[]>(Resources, @"Textures")),
                 filteringMode: DefaultTextureFilteringMode);
 
-            Textures.AddTextureSource(Host.CreateTextureLoaderStore(new OnlineStore()));
+            Textures.AddTextureSource(Host.CreateTextureLoaderStore(CreateOnlineStore()));
             dependencies.Cache(Textures);
 
             var tracks = new ResourceStore<byte[]>();
             tracks.AddStore(new NamespacedResourceStore<byte[]>(Resources, @"Tracks"));
-            tracks.AddStore(new OnlineStore());
+            tracks.AddStore(CreateOnlineStore());
 
             var samples = new ResourceStore<byte[]>();
             samples.AddStore(new NamespacedResourceStore<byte[]>(Resources, @"Samples"));
-            samples.AddStore(new OnlineStore());
+            samples.AddStore(CreateOnlineStore());
 
             Audio = new AudioManager(Host.AudioThread, tracks, samples) { EventScheduler = Scheduler };
             dependencies.Cache(Audio);
@@ -234,6 +234,11 @@ private void load(FrameworkConfigManager config)
             }, true);
         }
 
+        /// <summary>
+        /// Creates an <see cref="OnlineStore"/> to be used for online textures/tracks/samples lookups.
+        /// </summary>
+        protected virtual OnlineStore CreateOnlineStore() => new OnlineStore();
+
         /// <summary>
         /// Add a font to be globally accessible to the game.
         /// </summary>

diff --git a/osu.Framework/IO/Stores/OnlineStore.cs b/osu.Framework/IO/Stores/OnlineStore.cs
@@ -24,7 +24,7 @@ public async Task<byte[]> GetAsync(string url, CancellationToken cancellationTok
 
             try
             {
-                using (WebRequest req = new WebRequest($@"{url}"))
+                using (WebRequest req = new WebRequest(GetLookupUrl(url)))
                 {
                     await req.PerformAsync(cancellationToken).ConfigureAwait(false);
                     return req.GetResponseData();
@@ -45,7 +45,7 @@ public virtual byte[] Get(string url)
 
             try
             {
-                using (WebRequest req = new WebRequest($@"{url}"))
+                using (WebRequest req = new WebRequest(GetLookupUrl(url)))
                 {
                     req.Perform();
                     return req.GetResponseData();
@@ -68,6 +68,12 @@ public Stream GetStream(string url)
 
         public IEnumerable<string> GetAvailableResources() => Enumerable.Empty<string>();
 
+        /// <summary>
+        /// Returns the URL used to look up the requested resource.
+        /// </summary>
+        /// <param name="url">The original URL for lookup.</param>
+        protected virtual string GetLookupUrl(string url) => url;
+
         private bool validateScheme(string url)
         {
             if (!Uri.TryCreate(url, UriKind.Absolute, out Uri uri))