Support hierarchical (with owner) or flat repository directory layout

src/GitHub.App/Services/RepositoryCloneService.cs

@@ -11,6 +11,7 @@
 using GitHub.Logging;
 using GitHub.Models;
 using GitHub.Primitives;
+using GitHub.Settings;
 using Microsoft.VisualStudio.Shell;
 using Microsoft.VisualStudio.Threading;
 using Octokit.GraphQL;
@@ -39,6 +40,7 @@ public class RepositoryCloneService : IRepositoryCloneService
         readonly IGraphQLClientFactory graphqlFactory;
         readonly IGitHubContextService gitHubContextService;
         readonly IUsageTracker usageTracker;
+        readonly Lazy<IPackageSettings> packageSettings;
         readonly Lazy<EnvDTE.DTE> dte;
         ICompiledQuery<ViewerRepositoriesModel> readViewerRepositories;
 
@@ -51,6 +53,7 @@ public RepositoryCloneService(
             IGitHubContextService gitHubContextService,
             IUsageTracker usageTracker,
             IGitHubServiceProvider sp,
+            Lazy<IPackageSettings> packageSettings,
             [Import(AllowDefault = true)] JoinableTaskContext joinableTaskContext)
         {
             this.operatingSystem = operatingSystem;
@@ -59,10 +62,9 @@ public RepositoryCloneService(
             this.graphqlFactory = graphqlFactory;
             this.gitHubContextService = gitHubContextService;
             this.usageTracker = usageTracker;
+            this.packageSettings = packageSettings;
             dte = new Lazy<EnvDTE.DTE>(() => sp.GetService<EnvDTE.DTE>());
             JoinableTaskContext = joinableTaskContext ?? ThreadHelper.JoinableTaskContext;
-
-            defaultClonePath = GetLocalClonePathFromGitProvider(operatingSystem.Environment.GetUserRepositoriesPath());
         }
 
         /// <inheritdoc/>
@@ -225,6 +227,8 @@ public async Task CloneRepository(
                     // Count the number of times users clone into the Default Repository Location
                     await usageTracker.IncrementCounter(x => x.NumberOfClonesToDefaultClonePath);
                 }
+
+                SetDefaultClonePath(repositoryPath, cloneUrl);
             }
             catch (Exception ex)
             {
@@ -251,13 +255,38 @@ string GetLocalClonePathFromGitProvider(string fallbackPath)
                 : fallbackPath;
         }
 
-        public string DefaultClonePath { get { return defaultClonePath; } }
+        public void SetDefaultClonePath(string repositoryPath, UriString cloneUrl)
+        {
+            var (defaultPath, repositoryLayout) = RepositoryLayoutUtilities.GetDefaultPathAndLayout(repositoryPath, cloneUrl);
 
-        JoinableTaskContext JoinableTaskContext { get; }
+            log.Information("Setting DefaultRepositoryLocation to {Location}", defaultPath);
+            packageSettings.Value.DefaultRepositoryLocation = defaultPath;
+
+            log.Information("Setting DefaultRepositoryLayout to {Layout}", repositoryLayout);
+            packageSettings.Value.DefaultRepositoryLayout = repositoryLayout.ToString();
 
-        class OrganizationAdapter
+            packageSettings.Value.Save();
+        }
+
+        public RepositoryLayout DefaultRepositoryLayout
         {
-            public IReadOnlyList<RepositoryListItemModel> Repositories { get; set; }
+            get => RepositoryLayoutUtilities.GetRepositoryLayout(packageSettings.Value.DefaultRepositoryLayout);
         }
+
+        public string DefaultClonePath
+        {
+            get
+            {
+                var defaultPath = packageSettings.Value.DefaultRepositoryLocation;
+                if (!string.IsNullOrEmpty(defaultPath))
+                {
+                    return defaultPath;
+                }
+
+                return GetLocalClonePathFromGitProvider(operatingSystem.Environment.GetUserRepositoriesPath());
+            }
+        }
+
+        JoinableTaskContext JoinableTaskContext { get; }
     }
 }

src/GitHub.App/Services/RepositoryLayoutUtilities.cs

@@ -0,0 +1,49 @@
+using System;
+using System.IO;
+using GitHub.Primitives;
+
+namespace GitHub.Services
+{
+    public static class RepositoryLayoutUtilities
+    {
+        // Exclude directories with a case sensitive name of "GitHub" from being a possible owner.
+        // GitHub Desktop uses "GitHub" as its default directory and this isn't a user or organization name.
+        const string GitHubDirectoryName = "GitHub";
+
+        public static string GetDefaultRepositoryPath(UriString cloneUrl, string defaultPath, RepositoryLayout repositoryLayout)
+        {
+            switch (repositoryLayout)
+            {
+                case RepositoryLayout.Name:
+                    return Path.Combine(defaultPath, cloneUrl.RepositoryName);
+                case RepositoryLayout.Default:
+                case RepositoryLayout.OwnerName:
+                    return Path.Combine(defaultPath, cloneUrl.Owner, cloneUrl.RepositoryName);
+                default:
+                    throw new ArgumentException($"Unknown repository layout: {repositoryLayout}");
+
+            }
+        }
+
+        public static RepositoryLayout GetRepositoryLayout(string repositoryLayoutSetting)
+        {
+            return Enum.TryParse(repositoryLayoutSetting, out RepositoryLayout repositoryLayout) ?
+                repositoryLayout : RepositoryLayout.Default;
+        }
+
+        public static (string, RepositoryLayout) GetDefaultPathAndLayout(string repositoryPath, UriString cloneUrl)
+        {
+            var possibleOwnerPath = Path.GetDirectoryName(repositoryPath);
+            var possibleOwner = Path.GetFileName(possibleOwnerPath);
+            if (string.Equals(possibleOwner, cloneUrl.Owner, StringComparison.OrdinalIgnoreCase) &&
+                !string.Equals(possibleOwner, GitHubDirectoryName, StringComparison.Ordinal))
+            {
+                return (Path.GetDirectoryName(possibleOwnerPath), RepositoryLayout.OwnerName);
+            }
+            else
+            {
+                return (possibleOwnerPath, RepositoryLayout.Name);
+            }
+        }
+    }
+}

src/GitHub.App/ViewModels/Dialog/Clone/RepositoryCloneViewModel.cs

@@ -210,55 +210,27 @@ void UpdatePath(RepositoryModel repository)
         {
             if (repository != null)
             {
-                var basePath = GetUpdatedBasePath(Path);
-                previousRepository = repository;
-                Path = System.IO.Path.Combine(basePath, repository.Owner, repository.Name);
-            }
-        }
-
-        string GetUpdatedBasePath(string path)
-        {
-            if (string.IsNullOrEmpty(path))
-            {
-                return service.DefaultClonePath;
-            }
-
-            if (previousRepository == null)
-            {
-                return path;
-            }
-
-            if (FindDirWithout(path, previousRepository?.Owner, 2) is string dirWithoutOwner)
-            {
-                return dirWithoutOwner;
-            }
-
-            if (FindDirWithout(path, previousRepository?.Name, 1) is string dirWithoutRepo)
-            {
-                return dirWithoutRepo;
-            }
-
-            return path;
-
-            string FindDirWithout(string dir, string match, int levels)
-            {
-                string dirWithout = null;
-                for (var i = 0; i < 2; i++)
+                try
                 {
-                    if (string.IsNullOrEmpty(dir))
+                    if (previousRepository != null && !string.IsNullOrEmpty(Path))
                     {
-                        break;
+                        var (path, layout) = RepositoryLayoutUtilities.GetDefaultPathAndLayout(Path, previousRepository.CloneUrl);
+                        Path = RepositoryLayoutUtilities.GetDefaultRepositoryPath(repository.CloneUrl, path, layout);
                     }
-
-                    var name = System.IO.Path.GetFileName(dir);
-                    dir = System.IO.Path.GetDirectoryName(dir);
-                    if (name == match)
+                    else
                     {
-                        dirWithout = dir;
+                        Path = RepositoryLayoutUtilities.GetDefaultRepositoryPath(repository.CloneUrl,
+                            service.DefaultClonePath, service.DefaultRepositoryLayout);
                     }
                 }
+                catch (Exception)
+                {
+                    // Reset illegal paths
+                    Path = RepositoryLayoutUtilities.GetDefaultRepositoryPath(repository.CloneUrl,
+                        service.DefaultClonePath, service.DefaultRepositoryLayout);
+                }
 
-                return dirWithout;
+                previousRepository = repository;
             }
         }
 

src/GitHub.Exports.Reactive/Services/IRepositoryCloneService.cs

@@ -11,11 +11,20 @@ namespace GitHub.Services
     public interface IRepositoryCloneService
     {
         /// <summary>
-        /// Default path to clone things to, used as fallback if we can't find the correct path
-        /// from VS.
+        /// Default path to clone things to
         /// </summary>
         string DefaultClonePath { get; }
 
+        /// <summary>
+        /// Default layout of repository directories.
+        /// </summary>
+        RepositoryLayout DefaultRepositoryLayout { get; }
+
+        /// <summary>
+        /// Infer the default clone path and layout from an example repository path and clone URL.
+        /// </summary>
+        void SetDefaultClonePath(string repositoryPath, UriString cloneUrl);
+
         /// <summary>
         /// Clones the specificed repository into the specified directory.
         /// </summary>

src/GitHub.Exports.Reactive/Services/RepositoryLayout.cs

@@ -0,0 +1,9 @@
+namespace GitHub.Services
+{
+    public enum RepositoryLayout
+    {
+        Default,  // Layout hasn't been specified
+        Name,     // Layout repositories by name
+        OwnerName // Layout repositories by owner and name
+    }
+}

src/GitHub.Exports/Settings/generated/IPackageSettings.cs

@@ -38,5 +38,7 @@ public interface IPackageSettings : INotifyPropertyChanged
         UIState UIState { get; set; }
         bool HideTeamExplorerWelcomeMessage { get; set; }
         bool EnableTraceLogging { get; set; }
+        string DefaultRepositoryLocation { get; set; }
+        string DefaultRepositoryLayout { get; set; }
     }
 }

src/GitHub.VisualStudio/Settings/generated/PackageSettingsGen.cs

@@ -5,7 +5,7 @@
     {
       "name": "CollectMetrics",
       "type": "bool",
-      "default": 'true'
+      "default": "true"
     },
     {
       "name": "UIState",
@@ -22,6 +22,16 @@
       "name": "EnableTraceLogging",
       "type": "bool",
       "default": "false"
+    },
+    {
+      "name": "DefaultRepositoryLocation",
+      "type": "string",
+      "default": "null"
+    },
+    {
+      "name": "DefaultRepositoryLayout",
+      "type": "string",
+      "default": "null"
     }
   ]
 }
@@ -71,13 +81,29 @@ public bool EnableTraceLogging
             set { enableTraceLogging  = value; this.RaisePropertyChange(); }
         }
 
+        string defaultRepositoryLocation;
+        public string DefaultRepositoryLocation
+        {
+            get { return defaultRepositoryLocation; }
+            set { defaultRepositoryLocation  = value; this.RaisePropertyChange(); }
+        }
+
+        string defaultRepositoryLayout;
+        public string DefaultRepositoryLayout
+        {
+            get { return defaultRepositoryLayout; }
+            set { defaultRepositoryLayout  = value; this.RaisePropertyChange(); }
+        }
+
 
         void LoadSettings()
         {
             CollectMetrics = (bool)settingsStore.Read("CollectMetrics", true);
             UIState = SimpleJson.DeserializeObject<UIState>((string)settingsStore.Read("UIState", "{}"));
             HideTeamExplorerWelcomeMessage = (bool)settingsStore.Read("HideTeamExplorerWelcomeMessage", false);
             EnableTraceLogging = (bool)settingsStore.Read("EnableTraceLogging", false);
+            DefaultRepositoryLocation = (string)settingsStore.Read("DefaultRepositoryLocation", null);
+            DefaultRepositoryLayout = (string)settingsStore.Read("DefaultRepositoryLayout", null);
         }
 
         void SaveSettings()
@@ -86,6 +112,8 @@ void SaveSettings()
             settingsStore.Write("UIState", SimpleJson.SerializeObject(UIState));
             settingsStore.Write("HideTeamExplorerWelcomeMessage", HideTeamExplorerWelcomeMessage);
             settingsStore.Write("EnableTraceLogging", EnableTraceLogging);
+            settingsStore.Write("DefaultRepositoryLocation", DefaultRepositoryLocation);
+            settingsStore.Write("DefaultRepositoryLayout", DefaultRepositoryLayout);
         }
 
     }

src/GitHub.VisualStudio/Settings/generated/PackageSettingsGen.tt

@@ -3,7 +3,7 @@
 <#@ import namespace="System.Linq" #>
 <#@ import namespace="System.Collections.Generic" #>
 <#@ import namespace="System.IO" #>
-<#@ assembly name="$(PackageDir)\Newtonsoft.Json.6.0.8\lib\net45\Newtonsoft.Json.dll" #>
+<#@ assembly name="$(USERPROFILE)\.nuget\packages\Newtonsoft.Json\6.0.8\lib\net45\Newtonsoft.Json.dll" #>
 <#@ import namespace="Newtonsoft.Json.Linq" #>
 <#@ output extension=".cs" #>
 <#

src/common/settings.json

@@ -3,7 +3,7 @@
     {
       "name": "CollectMetrics",
       "type": "bool",
-      "default": 'true'
+      "default": "true"
     },
     {
       "name": "UIState",
@@ -20,6 +20,16 @@
       "name": "EnableTraceLogging",
       "type": "bool",
       "default": "false"
+    },
+    {
+      "name": "DefaultRepositoryLocation",
+      "type": "string",
+      "default": "null"
+    },
+    {
+      "name": "DefaultRepositoryLayout",
+      "type": "string",
+      "default": "null"
     }
   ]
 }