Merge pull request #352 from edgardmessias/added_checkout

feat: Added support to checkout repository (Close #332)

Author: JohnstonCode

package.json

@@ -82,6 +82,11 @@
       ]
     },
     "commands": [
+      {
+        "command": "svn.checkout",
+        "title": "Checkout",
+        "category": "SVN"
+      },
       {
         "command": "svn.add",
         "title": "Add",
@@ -268,6 +273,10 @@
     ],
     "menus": {
       "commandPalette": [
+        {
+          "command": "svn.checkout",
+          "when": "config.svn.enabled"
+        },
         {
           "command": "svn.add",
           "when": "config.svn.enabled && svnOpenRepositoryCount != 0"
@@ -588,6 +597,11 @@
           "default": null,
           "isExecutable": true
         },
+        "svn.defaultCheckoutDirectory": {
+          "type": "string",
+          "default": null,
+          "description": "The default location to checkout a svn repository."
+        },
         "svn.ignoreMissingSvnWarning": {
           "type": "boolean",
           "description": "Ignores the warning when SVN is missing",

src/commands.ts

@@ -1,10 +1,12 @@
 import * as fs from "fs";
+import * as os from "os";
 import * as path from "path";
 import {
   commands,
   Disposable,
   LineChange,
   Position,
+  ProgressLocation,
   Range,
   SourceControlResourceState,
   TextDocumentShowOptions,
@@ -21,20 +23,23 @@ import {
   inputSwitchChangelist
 } from "./changelistItems";
 import {
+  IAuth,
   ICommand,
   ICommandOptions,
+  ICpOptions,
   Status,
   SvnUriAction
 } from "./common/types";
 import { getConflictPickOptions } from "./conflictItems";
-import { selectBranch } from "./helpers/branch";
+import { getBranchName, selectBranch } from "./helpers/branch";
 import { configuration } from "./helpers/configuration";
 import { inputIgnoreList } from "./ignoreitems";
 import { applyLineChanges } from "./lineChanges";
 import { inputCommitMessage } from "./messages";
 import { Model } from "./model";
 import { Repository } from "./repository";
 import { Resource } from "./resource";
+import { Svn, svnErrorCodes } from "./svn";
 import IncommingChangeNode from "./treeView/nodes/incomingChangeNode";
 import IncomingChangeNode from "./treeView/nodes/incomingChangeNode";
 import { fromSvnUri, toSvnUri } from "./uri";
@@ -62,7 +67,7 @@ function command(
 export class SvnCommands implements IDisposable {
   private disposables: Disposable[];
 
-  constructor(private model: Model) {
+  constructor(private model: Model, private svn: Svn) {
     this.disposables = svnCommands.map(({ commandId, method, options }) => {
       const command = this.createCommand(method, options);
       if (options.diff && hasSupportToRegisterDiffCommand()) {
@@ -121,32 +126,170 @@ export class SvnCommands implements IDisposable {
     await commands.executeCommand("vscode.open", resourceUri);
   }
 
-  @command("svn.promptAuth", { repository: true })
-  public async promptAuth(repository: Repository): Promise<boolean> {
+  @command("svn.promptAuth")
+  public async promptAuth(
+    prevUsername?: string,
+    prevPassword?: string
+  ): Promise<IAuth | undefined> {
     const username = await window.showInputBox({
       placeHolder: "Svn repository username",
       prompt: "Please enter your username",
-      value: repository.username
+      value: prevUsername
     });
 
     if (username === undefined) {
-      return false;
+      return;
     }
 
     const password = await window.showInputBox({
       placeHolder: "Svn repository password",
       prompt: "Please enter your password",
+      value: prevPassword,
       password: true
     });
 
-    if (username === undefined) {
-      return false;
+    if (password === undefined) {
+      return;
+    }
+
+    const auth: IAuth = {
+      username,
+      password
+    };
+
+    return auth;
+  }
+
+  @command("svn.checkout")
+  public async checkout(url?: string): Promise<void> {
+    if (!url) {
+      url = await window.showInputBox({
+        prompt: "Repository URL",
+        ignoreFocusOut: true
+      });
+    }
+
+    if (!url) {
+      return;
+    }
+
+    let defaultCheckoutDirectory =
+      configuration.get<string>("defaultCheckoutDirectory") || os.homedir();
+    defaultCheckoutDirectory = defaultCheckoutDirectory.replace(
+      /^~/,
+      os.homedir()
+    );
+
+    const uris = await window.showOpenDialog({
+      canSelectFiles: false,
+      canSelectFolders: true,
+      canSelectMany: false,
+      defaultUri: Uri.file(defaultCheckoutDirectory),
+      openLabel: "Select Repository Location"
+    });
+
+    if (!uris || uris.length === 0) {
+      return;
+    }
+
+    const uri = uris[0];
+    const parentPath = uri.fsPath;
+
+    let folderName: string | undefined;
+
+    // Get folder name from branch
+    const branch = getBranchName(url);
+    if (branch) {
+      const baseUrl = url.replace(/\//g, "/").replace(branch.path, "");
+      folderName = path.basename(baseUrl);
+    }
+
+    folderName = await window.showInputBox({
+      prompt: "Folder name",
+      value: folderName,
+      ignoreFocusOut: true
+    });
+
+    if (!folderName) {
+      return;
     }
 
-    repository.username = username;
-    repository.password = password;
+    const repositoryPath = path.join(parentPath, folderName);
+
+    // Use Notification location if supported
+    let location = ProgressLocation.Window;
+    if ((ProgressLocation as any).Notification) {
+      location = (ProgressLocation as any).Notification;
+    }
+
+    const progressOptions = {
+      location,
+      title: `Checkout svn repository '${url}'...`,
+      cancellable: true
+    };
+
+    let attempt = 0;
 
-    return true;
+    const opt: ICpOptions = {};
+
+    while (true) {
+      attempt++;
+      try {
+        await window.withProgress(progressOptions, async () => {
+          const args = ["checkout", url, repositoryPath];
+          await this.svn.exec(parentPath, args, opt);
+        });
+        break;
+      } catch (err) {
+        if (
+          err.svnErrorCode === svnErrorCodes.AuthorizationFailed &&
+          attempt <= 3
+        ) {
+          const auth = (await commands.executeCommand(
+            "svn.promptAuth",
+            opt.username
+          )) as IAuth;
+          if (auth) {
+            opt.username = auth.username;
+            opt.password = auth.password;
+            continue;
+          }
+        }
+        throw err;
+      }
+    }
+
+    const choices = [];
+    let message = "Would you like to open the checked out repository?";
+    const open = "Open Repository";
+    choices.push(open);
+
+    const addToWorkspace = "Add to Workspace";
+    if (
+      workspace.workspaceFolders &&
+      (workspace as any).updateWorkspaceFolders // For VSCode >= 1.21
+    ) {
+      message =
+        "Would you like to open the checked out repository, or add it to the current workspace?";
+      choices.push(addToWorkspace);
+    }
+
+    const result = await window.showInformationMessage(message, ...choices);
+
+    const openFolder = result === open;
+
+    if (openFolder) {
+      commands.executeCommand("vscode.openFolder", Uri.file(repositoryPath));
+    } else if (result === addToWorkspace) {
+      // For VSCode >= 1.21
+      (workspace as any).updateWorkspaceFolders(
+        workspace.workspaceFolders!.length,
+        0,
+        {
+          uri: Uri.file(repositoryPath)
+        }
+      );
+    }
   }
 
   @command("svn.commitWithMessage", { repository: true })

src/common/types.ts

@@ -250,3 +250,8 @@ export interface IOperations {
   isIdle(): boolean;
   isRunning(operation: Operation): boolean;
 }
+
+export interface IAuth {
+  username: string;
+  password: string;
+}

src/extension.ts

@@ -35,7 +35,7 @@ async function init(
   const svn = new Svn({ svnPath: info.path, version: info.version });
   const model = new Model(svn);
   const contentProvider = new SvnContentProvider(model);
-  const svnCommands = new SvnCommands(model);
+  const svnCommands = new SvnCommands(model, svn);
   disposables.push(model, contentProvider, svnCommands);
 
   const svnProvider = new SvnProvider(model);

src/repository.ts

@@ -16,6 +16,7 @@ import {
   workspace
 } from "vscode";
 import {
+  IAuth,
   IFileStatus,
   IOperations,
   ISvnResourceGroup,
@@ -71,7 +72,7 @@ export class Repository {
   private remoteChangedUpdateInterval?: NodeJS.Timer;
   private deletedUris: Uri[] = [];
 
-  private lastPromptAuth?: Thenable<boolean | undefined>;
+  private lastPromptAuth?: Thenable<IAuth | undefined>;
 
   private _onDidChangeRepository = new EventEmitter<Uri>();
   public readonly onDidChangeRepository: Event<Uri> = this
@@ -864,14 +865,20 @@ export class Repository {
     );
   }
 
-  public async promptAuth(): Promise<boolean | undefined> {
+  public async promptAuth(): Promise<IAuth | undefined> {
     // Prevent multiple prompts for auth
     if (this.lastPromptAuth) {
       return this.lastPromptAuth;
     }
 
     this.lastPromptAuth = commands.executeCommand("svn.promptAuth");
     const result = await this.lastPromptAuth;
+
+    if (result) {
+      this.username = result.username;
+      this.password = result.password;
+    }
+
     this.lastPromptAuth = undefined;
     return result;
   }