Merge pull request #212 from Ducatel/add-urlencode-filename-token

Add urlencode filename token
GitTools · Jun 6, 2019 · 9628f44 · 9628f44
2 parents 3ef11e0 + f17b9be
commit 9628f44
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 11 deletions.
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -11,6 +11,7 @@
 # Please keep the list sorted.
 
 Andrew Arnott <[email protected]>
+David Ducatel <[email protected]>
 Geert van Horrik <[email protected]>
 Wesley Eledui <[email protected]>
 Marek Fišera <[email protected]>

diff --git a/README.md b/README.md
@@ -70,6 +70,10 @@ When working with a repository using uncommon URL you can use placeholders to sp
 
     GitLink.exe <pdbfile> -u "https://host/projects/catel/repos/catel/browse/{filename}?at={revision}&raw"
 
+Or if you require URL encoded filename you can use `urlencoded_filename` token
+
+    GitLink.exe <pdbfile> -u "http://host/api/v4/projects/42/repository/files/{urlencoded_filename}/raw?ref={revision}"
+
 The custom url will be used to fill the placeholders with the relative file path and the revision hash.
 
 ### Git repository location

diff --git a/src/GitLink.Tests/Providers/CustomUrlProviderFacts.cs b/src/GitLink.Tests/Providers/CustomUrlProviderFacts.cs
@@ -25,6 +25,7 @@ public class TheInitialization
             [TestCase("https://example.com/repo", false)]
             [TestCase("https://bitbucket.intra.company.com/projects/aaa/repos/a/browse/{filename}?raw", true)]
             [TestCase("gopher://example.com/repo", false)]
+            [TestCase("http://gitlab.com/api/v4/projects/42/repository/files/{urlencoded_filename}/raw?ref={revision}&private_token=superToken", true)]
             public void CorrectlyValidatesForUrls(string url, bool expectedValue)
             {
                 var provider = new CustomUrlProvider();
@@ -73,14 +74,16 @@ public void ReturnsNullProjectUrl()
                 Assert.IsNull(provider.ProjectUrl);
             }
 
-            [TestCase]
-            public void ReturnsValidRawGitUrl()
+            [TestCase(CorrectUrl)]
+            [TestCase("http://gitlab.com/api/v4/projects/42/repository/files/{urlencoded_filename}/raw?ref={revision}&private_token=superToken")]
+            public void ReturnsValidRawGitUrl(string url)
             {
                 var provider = new CustomUrlProvider();
-                provider.Initialize(CorrectUrl);
+                provider.Initialize(url);
 
-                string correctReturnedUrl = CorrectUrl.Replace("{filename}", "%var2%");
-                correctReturnedUrl = correctReturnedUrl.Replace("{revision}", "{0}");
+                string correctReturnedUrl = url.Replace("{filename}", "%var2%")
+                    .Replace("{revision}", "{0}")
+                    .Replace("{urlencoded_filename}", "%var2%");
 
                 Assert.AreEqual(correctReturnedUrl, provider.RawGitUrl);
             }

diff --git a/src/GitLink/GitLink.csproj b/src/GitLink/GitLink.csproj
@@ -26,4 +26,7 @@
   <ItemGroup>
     <Content Include="Logo.ico" />
   </ItemGroup>
+  <ItemGroup>
+    <Reference Include="System.Web" />
+  </ItemGroup>
 </Project>
diff --git a/src/GitLink/Linker.cs b/src/GitLink/Linker.cs
@@ -12,6 +12,7 @@ namespace GitLink
     using System.IO;
     using System.Linq;
     using System.Reflection;
+    using System.Web;
     using Catel;
     using Catel.Logging;
     using GitTools;
@@ -28,6 +29,7 @@ public static class Linker
         private static readonly ILog Log = LogManager.GetCurrentClassLogger();
 
         private static readonly string FilenamePlaceholder = Uri.EscapeUriString("{filename}");
+        private static readonly string UrlEncodedFileNamePlaceHolder = Uri.EscapeUriString("{urlencoded_filename}");
         private static readonly string RevisionPlaceholder = Uri.EscapeUriString("{revision}");
         private static readonly string PdbStrExePath = Path.Combine(Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location), "pdbstr.exe");
         private static readonly string[] ExtensionsToIgnore = new string[] { ".g.cs" };
@@ -170,17 +172,18 @@ public static class Linker
                 }
 
                 string rawUrl = provider.RawGitUrl;
-                if (rawUrl.Contains(RevisionPlaceholder) || rawUrl.Contains(FilenamePlaceholder))
+                if (rawUrl.Contains(RevisionPlaceholder) || rawUrl.Contains(FilenamePlaceholder) || rawUrl.Contains(UrlEncodedFileNamePlaceHolder))
                 {
-                    if (!rawUrl.Contains(RevisionPlaceholder) || !rawUrl.Contains(FilenamePlaceholder))
+                    if (!rawUrl.Contains(RevisionPlaceholder) || !(rawUrl.Contains(FilenamePlaceholder) || rawUrl.Contains(UrlEncodedFileNamePlaceHolder)))
                     {
                         Log.Error("Supplied custom URL pattern must contain both a revision and a filename placeholder.");
                         return false;
                     }
 
                     rawUrl = rawUrl
                         .Replace(RevisionPlaceholder, "{0}")
-                        .Replace(FilenamePlaceholder, "%var2%");
+                        .Replace(FilenamePlaceholder, "%var2%")
+                        .Replace(UrlEncodedFileNamePlaceHolder, "%var2%");
                 }
                 else
                 {
@@ -217,6 +220,11 @@ public static class Linker
                     if (sourceFile.Value != null)
                     {
                         var relativePathForUrl = ReplaceSlashes(provider, sourceFile.Value);
+                        if (provider.RawGitUrl.Contains(UrlEncodedFileNamePlaceHolder))
+                        {
+                            relativePathForUrl = HttpUtility.UrlEncode(relativePathForUrl);
+                        }
+
                         srcSrvContext.Paths.Add(Tuple.Create(sourceFile.Key, relativePathForUrl));
                     }
                 }

diff --git a/src/GitLink/Providers/CustomUrlProvider.cs b/src/GitLink/Providers/CustomUrlProvider.cs
@@ -12,6 +12,7 @@ namespace GitLink.Providers
     public sealed class CustomUrlProvider : ProviderBase
     {
         private const string FileNamePlaceHolder = "{filename}";
+        private const string UrlEncodedFileNamePlaceHolder = "{urlencoded_filename}";
         private const string RevisionPlaceHolder = "{revision}";
         private static readonly Regex HostingUrlPattern = new Regex(@"https?://.+");
 
@@ -27,14 +28,16 @@ public CustomUrlProvider()
         public override bool Initialize(string url)
         {
             if (string.IsNullOrEmpty(url) || !HostingUrlPattern.IsMatch(url) ||
-               (!url.Contains(FileNamePlaceHolder) && !url.Contains(RevisionPlaceHolder)))
+               (!(url.Contains(FileNamePlaceHolder) || url.Contains(UrlEncodedFileNamePlaceHolder)) &&
+               !url.Contains(RevisionPlaceHolder)))
             {
                 return false;
             }
 
-            if (url.Contains(FileNamePlaceHolder))
+            if (url.Contains(FileNamePlaceHolder) || url.Contains(UrlEncodedFileNamePlaceHolder))
             {
-                _rawUrl = url.Replace(FileNamePlaceHolder, "%var2%");
+                _rawUrl = url.Replace(FileNamePlaceHolder, "%var2%")
+                            .Replace(UrlEncodedFileNamePlaceHolder, "%var2%");
             }
 
             if (url.Contains(RevisionPlaceHolder))