feat: Add option to replace values in remote url (#23)

* Add RemoteUrlReplacements feature and update defaultBranch

Author: abeatrix

README.md

@@ -34,6 +34,8 @@ The plugin is configurable _globally_ by creating a `sourcegraph-jetbrains.prope
 
 ```
 url = https://sourcegraph.example.com
+defaultBranch = example-branch
+remoteUrlReplacements = git.example.com, git-web.example.com
 ```
 
 You may also choose to configure it _per repository_ using a `.idea/sourcegraph.xml` file in your repository like so:
@@ -43,6 +45,8 @@ You may also choose to configure it _per repository_ using a `.idea/sourcegraph.
 <project version="4">
     <component name="Config">
         <option name="url" value="https://sourcegraph.example.com" />
+        <option name="defaultBranch" value="example-branch" />
+        <option name="remoteUrlReplacements" value="git.example.com, git-web.example.com" />
     </component>
 </project>
 ```
@@ -78,6 +82,8 @@ Please file an issue: https://github.com/sourcegraph/sourcegraph-jetbrains/issue
 
 #### v1.2.1
 - Added `Open In Sourcegraph` action to VCS History and Git Log to open a revision in the Sourcegraph diff view.
+- Added `defaultBranch` configuration option that allows opening files in a specific branch on Sourcegraph.
+- Added `remoteUrlReplacements` configuration option that allow users to replace specified values in the remote url with new strings.
 
 #### v1.2.0
 

src/main/java/Config.java

@@ -23,6 +23,12 @@ public String getDefaultBranch() {
         return defaultBranch;
     }
 
+    public String remoteUrlReplacements;
+
+    public String getRemoteUrlReplacements() {
+        return remoteUrlReplacements;
+    }
+
     @Nullable
     @Override
     public Config getState() {
@@ -33,6 +39,7 @@ public Config getState() {
     public void loadState(@NotNull Config config) {
         this.url = config.url;
         this.defaultBranch = config.defaultBranch;
+        this.remoteUrlReplacements = config.remoteUrlReplacements;
     }
 
     @Nullable static Config getInstance(Project project) {

src/main/java/FileAction.java

@@ -16,6 +16,8 @@
 import java.io.UnsupportedEncodingException;
 import java.net.URI;
 import java.net.URLEncoder;
+import java.util.Arrays;
+import java.util.List;
 
 public abstract class FileAction extends AnAction {
 
@@ -45,7 +47,7 @@ public void actionPerformed(AnActionEvent e) {
         SelectionModel sel = editor.getSelectionModel();
 
         // Get repo information.
-        RepoInfo repoInfo = Util.repoInfo(currentFile.getPath());
+        RepoInfo repoInfo = Util.repoInfo(currentFile.getPath(), project);
         if (repoInfo.remoteURL == "") {
             return;
         }
@@ -54,19 +56,13 @@ public void actionPerformed(AnActionEvent e) {
         String productName = ApplicationInfo.getInstance().getVersionName();
         String productVersion = ApplicationInfo.getInstance().getFullVersion();
         String uri;
-        String branch = repoInfo.branch;
-
-        // set defaultBranch only if not config is not null
-        if(Util.setDefaultBranch(project)!=null) {
-            branch = Util.setDefaultBranch(project);
-        };
 
         try {
             LogicalPosition start = editor.visualToLogicalPosition(sel.getSelectionStartPosition());
             LogicalPosition end = editor.visualToLogicalPosition(sel.getSelectionEndPosition());
             uri = Util.sourcegraphURL(project)+"-/editor"
                     + "?remote_url=" + URLEncoder.encode(repoInfo.remoteURL, "UTF-8")
-                    + "&branch=" + URLEncoder.encode(branch, "UTF-8")
+                    + "&branch=" + URLEncoder.encode(repoInfo.branch, "UTF-8")
                     + "&file=" + URLEncoder.encode(repoInfo.fileRel, "UTF-8")
                     + "&editor=" + URLEncoder.encode("JetBrains", "UTF-8")
                     + "&version=" + URLEncoder.encode(Util.VERSION, "UTF-8")

src/main/java/OpenRevisionAction.java

@@ -61,7 +61,7 @@ public void actionPerformed(@NotNull AnActionEvent e) {
     try {
       String productName = ApplicationInfo.getInstance().getVersionName();
       String productVersion = ApplicationInfo.getInstance().getFullVersion();
-      RepoInfo repoInfo = Util.repoInfo(context.getProject().getProjectFilePath());
+      RepoInfo repoInfo = Util.repoInfo(context.getProject().getProjectFilePath(), context.getProject());
 
       CommitViewUriBuilder builder = new CommitViewUriBuilder();
       URI uri = builder.build(Util.sourcegraphURL(context.getProject()), context.getRevisionNumber(), repoInfo, productName, productVersion);

src/main/java/SearchActionBase.java

@@ -40,7 +40,7 @@ public void actionPerformedMode(AnActionEvent e, String mode) {
         SelectionModel sel = editor.getSelectionModel();
 
         // Get repo information.
-        RepoInfo repoInfo = Util.repoInfo(currentFile.getPath());
+        RepoInfo repoInfo = Util.repoInfo(currentFile.getPath(), project);
 
         String q = sel.getSelectedText();
         if (q == null || q.equals("")) {
@@ -51,12 +51,6 @@ public void actionPerformedMode(AnActionEvent e, String mode) {
         String uri;
         String productName = ApplicationInfo.getInstance().getVersionName();
         String productVersion = ApplicationInfo.getInstance().getFullVersion();
-        String branch = repoInfo.branch;
-
-        // set defaultBranch only if not config is not null
-        if(Util.setDefaultBranch(project)!=null) {
-            branch = Util.setDefaultBranch(project);
-        };
 
         try {
             uri = Util.sourcegraphURL(project)+"-/editor"
@@ -68,7 +62,7 @@ public void actionPerformedMode(AnActionEvent e, String mode) {
 
             if (mode == "search.repository") {
                 uri += "&search_remote_url=" + URLEncoder.encode(repoInfo.remoteURL, "UTF-8")
-                        + "&search_branch=" + URLEncoder.encode(branch, "UTF-8");
+                        + "&search_branch=" + URLEncoder.encode(repoInfo.branch, "UTF-8");
             }
 
         } catch (UnsupportedEncodingException err) {

src/main/java/Util.java

@@ -68,6 +68,16 @@ public static String setDefaultBranch(Project project) {
         return defaultBranch;
     }
 
+    // get remoteUrlReplacements configuration option
+    public static String setRemoteUrlReplacements(Project project) {
+        String replacements = Config.getInstance(project).getRemoteUrlReplacements();
+        if (replacements == null || replacements.length() == 0) {
+            Properties props = readProps();
+            replacements = props.getProperty("remoteUrlReplacements", null);
+        }
+        return replacements;
+    }
+
     // readProps tries to read the $HOME/sourcegraph-jetbrains.properties file.
     private static Properties readProps() {
         Properties props = new Properties();
@@ -94,7 +104,7 @@ private static Properties readProps() {
     // repoInfo returns the Sourcegraph repository URI, and the file path
     // relative to the repository root. If the repository URI cannot be
     // determined, a RepoInfo with empty strings is returned.
-    public static RepoInfo repoInfo(String fileName) {
+    public static RepoInfo repoInfo(String fileName, Project project) {
         String fileRel = "";
         String remoteURL = "";
         String branch = "";
@@ -106,12 +116,24 @@ public static RepoInfo repoInfo(String fileName) {
             // Determine file path, relative to repository root.
             fileRel = fileName.substring(repoRoot.length()+1);
             remoteURL = configuredGitRemoteURL(repoRoot);
-            branch = gitBranch(repoRoot);
+            branch = Util.setDefaultBranch(project)!=null ? Util.setDefaultBranch(project) : gitBranch(repoRoot);
 
-            // If on a branch that does not exist on the remote, use "master" instead.
+            // If on a branch that does not exist on the remote or if defaultBranch does not exist on the remote,
+            // use "master" instead.
             if (!isRemoteBranch(branch, repoRoot)) {
                 branch = "master";
             }
+
+            // replace remoteURL if config option is not null
+            String r = Util.setRemoteUrlReplacements(project);
+
+            if(r!=null) {
+                String[] replacements = r.trim().split("\\s*,\\s*");
+                // Check if the entered values are pairs
+                for (int i = 0; i < replacements.length && replacements.length % 2 == 0; i += 2) {
+                    remoteURL = remoteURL.replace(replacements[i], replacements[i+1]);
+                }
+            }
         } catch (Exception err) {
             Logger.getInstance(Util.class).info(err);
             err.printStackTrace();
@@ -129,7 +151,7 @@ public static String exec(String cmd, String dir) throws IOException {
         BufferedReader stdout = new BufferedReader(new InputStreamReader(p.getInputStream()));
         BufferedReader stderr = new BufferedReader(new InputStreamReader(p.getErrorStream()));
 
-        // Log any stderr ouput.
+        // Log any stderr output.
         Logger logger = Logger.getInstance(Util.class);
         String s;
         while ((s = stderr.readLine()) != null) {