[#1572] Accept different types of URLs besides https github

docs/ug/configFiles.md

@@ -31,7 +31,7 @@ Given below are the details of the various config files used by RepoSense.
 
 | Column Name | Explanation |
 |-------------|-------------|
-| Repository's Location {{ mandatory }} | The `GitHub URL` or `Disk Path` to the git repository e.g., `https://github.com/foo/bar.git` or `C:\Users\user\Desktop\GitHub\foo\bar` |
+| Repository's Location {{ mandatory }} | The `Remote Repo URL` or `Disk Path` to the git repository e.g., `https://github.com/foo/bar.git` or `C:\Users\user\Desktop\GitHub\foo\bar` |
 | Branch | The branch to analyze in the target repository e.g., `master`. Default: the default branch of the repo |
 | File formats<sup>*+</sup> | The file extensions to analyze. Binary file formats, such as `png` and `jpg`, will be automatically labelled as the file type `binary` in the generated report. Default: all file formats |
 | Find Previous Authors | Enter **`yes`** to utilize Git blame's ignore revisions functionality, RepoSense will attempt to blame the line changes caused by commits in the ignore commit list to the previous authors who altered those lines (if available). |
@@ -63,9 +63,9 @@ Optionally, you can use an `author-config.csv` (which should be in the same dire
 |-------------|-------------|
 | Repository's Location | Same as `repo-config.csv`. Default: all the repos in `repo-config.csv` |
 | Branch | The branch to analyze for this author, e.g., `master`. Default: the author will be bound to all the repos in `repo-config.csv` that has the same repo's location, regardless of branch. |
-| Author's GitHub ID {{ mandatory }} | GitHub username of the target author, e.g., `JohnDoe` |
-| Author's Emails<sup>*</sup> | Associated Github emails of the author. This can be found in your [GitHub settings](https://github.com/settings/emails). |
-| Author's Display Name | The name to display for the author. Default: author's GitHub username. |
+| Author's Git Host ID {{ mandatory }} | Username of the target author's profile on GitHub, GitLab or Bitbucket, e.g.`JohnDoe`. |  
+| Author's Emails<sup>*</sup> | Associated emails of the author. For GitHub users, this can be found in your [GitHub settings](https://github.com/settings/emails). |
+| Author's Display Name | The name to display for the author. Default: author's username. |
 | Author's Git Author Name<sup>*</sup> | The meaning of _Git Author Name_ is explained in [_A note about git author name_](#a-note-about-git-author-name). |
 | Ignore Glob List<sup>*</sup> | Files to ignore for this author, in addition to files ignored by the patterns specified in `repo-config.csv`. The path glob syntax is the same as that of Ignore Glob List in `repo-config.csv`. |
 
@@ -107,7 +107,7 @@ You can optionally use `report-config.json` to customize report generation by pr
 
 Repo owners can provide the following additional information to RepoSense using a config file that we call the **_standalone config file_**:
 * which files/authors/commits to analyze/omit
-* which git and GitHub usernames belong to which authors
+* which git and git host usernames belong to which authors
 * the display of an author
 
 To use this feature, add a `_reposense/config.json` to the root of your repo using the format in the example below ([another example](https://github.com/reposense/RepoSense/blob/master/_reposense/config.json)) and **commit it** (reason: RepoSense can see committed code only):
@@ -143,8 +143,8 @@ Note: all fields are optional unless specified otherwise.
 
 **Fields to provide _author-level_ info**:<br>
 Note: `authors` field should contain _all_ authors that should be captured in the analysis.
-* `githubId`: GitHub username of the author. {{ mandatory }} field.
-* `emails`: Associated GitHub emails of the author. This can be found in your [GitHub settings](https://github.com/settings/emails).
+* `githubId`: Username of the author. {{ mandatory }} field.
+* `emails`: Associated git emails of the author. For GitHub, this can be found in your [GitHub settings](https://github.com/settings/emails).
 * `displayName`: Name to display on the report for this author.
 * `authorNames`: Git Author Name(s) used in the author's commits. By default, RepoSense assumes an author would use her GitHub username as the Git username too. The meaning of _Git Author Name_ is explained in [_A note about git author name_](#a-note-about-git-author-name).
 * `ignoreGlobList`: _Additional_ (i.e. on top of the repo-level `ignoreGlobList`) folders/files to ignore for a specific author. The path glob syntax is specified by the [_glob format_](https://docs.oracle.com/javase/tutorial/essential/io/fileOps.html#glob). In the example above, the actual `ignoreGlobList` for `alice` would be `["about-us/**", "**index.html", "**.css"]`.
@@ -166,13 +166,13 @@ Date:   Fri Feb 9 19:14:41 2018 +0800
     Make some changes to show my new author's name
 
 commit e3f699fd4ef128eebce98d5b4e5b3bb06a512f49
-Author: ActualGitHubId <author@example.com>
+Author: ActualGitHostId <author@example.com>
 Date:   Fri Feb 9 19:13:13 2018 +0800
 
     Initial commit
  ...
 ```
-`ActualGitHubId` and `ConfiguredAuthorName` are both `Git Author Name` of the same author.<br>
+`ActualGitHostId` and `ConfiguredAuthorName` are both `Git Author Name` of the same author.<br>
 To find the author name that you are currently using for your current git repository, run the following command within your git repository:
 ``` {.no-line-numbers}
 git config user.name
@@ -185,7 +185,7 @@ To set the author name to use a default value you want for future git repositori
 ``` {.no-line-numbers}
 git config --global user.name "YOUR_AUTHOR_NAME”
 ```
-RepoSense expects the Git Author Name to be the same as author's GitHub username. If an author's `Git Author Name` is different from her `GitHub ID`, the `Git Author Name` needs to be specified in the standalone config file. If the author has more than one `Git Author Name`, multiple values can be entered too.
+RepoSense expects the Git Author Name to be the same as author's Git Host (GitHub, GitLab, BitBucket) username. If an author's `Git Author Name` is different from her `GitHost ID`, the `Git Author Name` needs to be specified in the standalone config file. If the author has more than one `Git Author Name`, multiple values can be entered too.
 
 <box type="warning" seamless>
 

docs/ug/generatingReports.md

@@ -18,6 +18,12 @@ Let's look at different ways to generate RepoSense reports.
 
 * **If you don't have Java on your computer or do not wish to run the executable on your computer**, some alternatives are provided in the [_Generating reports remotely_](#generating-reports-remotely) section below.
 
+<box type="info" seamless>
+
+RepoSense is built to analyze any type of git repo, remote or local. It works best when analyzing remote repositories hosted on GitHub, GitLab or BitBucket.
+For other types of repositories, features such as external links might not work properly.
+</box>
+
 <!-- ==================================================================================================== -->
 
 ## Generating reports locally

docs/ug/usingReports.md

@@ -28,7 +28,6 @@ As a report consists of web pages, it can be viewed using a Web Browser. Here ar
   1. Open the `index.html` (in the unzipped report directory) using a browser.
   1. If the report was not loaded automatically, click on the `choose file` button in the shown web page, and select the `archive.zip` (in the same directory) manually.<br>
      If even the `choose file` button is not showing up, try a different browser.
-
 <!-- ==================================================================================================== -->
 
 ## Report structure
@@ -39,6 +38,11 @@ Here is an example of how a typical report looks like:
 
 The report is divided into two sections: [_**Chart panel**_](#chart-panel) and the [_**Code panel**_](#code-panel). In some situations, the [_**Commits panel**_](#commits-panel) will appear in place of the _code panel_. All three are explained in the sections below.
 
+<box type="info" seamless>
+
+The links to external webpages is only properly supported when RepoSense analyzes a remote repository belonging to GitHub, GitLab or BitBucket.
+</box>
+
 <!-- ==================================================================================================== -->
 
 ## Chart panel
@@ -62,7 +66,9 @@ The `Chart panel` (an example is shown above) contains a series of _ramp chart_
 * The ramp's area is proportional to the amount of contribution the author made at that time period.
 * The position of the right edge of the ramp (perpendicular to the blue bar) represents the period (the day or the week) in which the contribution was made.
 * Hover the pointer over a ramp to see the total number of lines represented by that ramp.
-* Click on the ramp to see on GitHub the list of commits represented by that ramp.
+* Click on the ramp to view details about the list of commits represented in the ramp.
+  * At the commit-level of granularity, it links to the commit in the remote repository.
+  * At higher levels of granularity, it displays the list of commits in the Code Panel.
 * To make the comparison between two authors easier, the color of the ramps that represent different authors' contributions at the same time period are the same.
 * Ramps representing big contributions can overlap with earlier time periods. This represents the possibility that if the work committed during a specific period is big, it could have started at an earlier time period.
 
@@ -135,8 +141,8 @@ The `Code panel` allows users to see the code attributed to a specific author. C
     * Select the checkboxes to include files of preferred file extensions.
     The number right beside the file extension shows the total number of lines written by the author in such file extension files. In contrast, the number inside the parenthesis indicates the number of non-blank lines written by the author.
 * Clicking the file title toggles the file content.
-* Clicking the first icon beside the file title opens the history view of the file on GitHub.
-* Clicking the second icon beside the file title opens the blame view of the file on GitHub.
+* Clicking the first icon beside the file title opens the history view of the file on the remote repository.
+* Clicking the second icon beside the file title opens the blame view of the file on the remote repository.
 * Code attributed to the author is highlighted in green.
 * Non-trivial code segments that the selected author does not write are hidden by default, but you can toggle them by clicking on the %%:fas-plus-circle:%% icon.
 

frontend/src/app.vue

@@ -270,12 +270,12 @@ const app = {
     getSpecificCommitLink() {
       const version = window.repoSenseVersion;
       if (!version) {
-        return `${window.BASE_URL}/reposense/RepoSense`;
+        return `${window.REPOSENSE_REPO_URL}`;
       }
       if (version.startsWith('v')) {
-        return `${window.BASE_URL}/reposense/RepoSense/releases/tag/${version}`;
+        return `${window.REPOSENSE_REPO_URL}/releases/tag/${version}`;
       }
-      return `${window.BASE_URL}/reposense/RepoSense/commit/${version}`;
+      return `${window.REPOSENSE_REPO_URL}/commit/${version}`;
     },
 
     getUserGuideLink() {

frontend/src/components/v-ramp.vue

@@ -44,7 +44,7 @@ export default {
 
   methods: {
     getLink(commit) {
-      return `${window.getBaseLink(commit.repoId)}/commit/${commit.hash}`;
+      return window.getCommitLink(commit.repoId, commit.hash);
     },
     getWidth(slice) {
       if (slice.insertions === 0) {
@@ -82,7 +82,7 @@ export default {
         zTimeFrame: 'commit',
         zAvgCommitSize: slice.insertions,
         zUser: zoomUser,
-        zLocation: window.getBaseLink(user.repoId),
+        zLocation: window.getRepoLink(user.repoId),
         zSince: slice.date,
         zUntil: this.tframe === 'day' ? slice.date : slice.endDate,
         zIsMerged: this.mergegroup,

frontend/src/components/v-summary-charts.vue

@@ -45,7 +45,7 @@
           span.tooltip-text Click to view group's repo
       a(
         v-else-if="filterGroupSelection === 'groupByAuthors'",
-        v-bind:href="getAuthorProfileLink(repo[0].name)", target="_blank"
+        v-bind:href="getAuthorProfileLink(repo[0], repo[0].name)", target="_blank"
       )
         .tooltip
           font-awesome-icon.icon-button(icon="user")
@@ -108,7 +108,7 @@
             span.tooltip-text Click to view repo
         a(
           v-if="filterGroupSelection !== 'groupByAuthors'",
-          v-bind:href="getAuthorProfileLink(repo[j].name)", target="_blank"
+          v-bind:href="getAuthorProfileLink(repo[j], repo[j].name)", target="_blank"
         )
           .tooltip
             font-awesome-icon.icon-button(icon="user")
@@ -301,16 +301,16 @@ export default {
       return res;
     },
 
-    getAuthorProfileLink(userName) {
-      return `https://github.com/${userName}`;
+    getAuthorProfileLink(repo, userName) {
+      return window.getAuthorLink(repo.repoId, userName);
     },
 
     getRepoLink(repo) {
       const { REPOS } = window;
       const { location, branch } = REPOS[repo.repoId];
 
       if (Object.prototype.hasOwnProperty.call(location, 'organization')) {
-        return `${window.BASE_URL}/${location.organization}/${location.repoName}/tree/${branch}`;
+        return window.getBranchLink(repo.repoId, branch);
       }
       this.removeSelectedTab();
       return repo.location;

frontend/src/utils/api.js

@@ -1,8 +1,9 @@
 // utility functions //
 window.$ = (id) => document.getElementById(id);
 window.enquery = (key, val) => `${key}=${encodeURIComponent(val)}`;
-window.BASE_URL = 'https://github.com';
+window.REPOSENSE_REPO_URL = 'https://github.com/reposense/RepoSense';
 window.HOME_PAGE_URL = 'https://reposense.org';
+window.UNSUPPORTED_INDICATOR = 'UNSUPPORTED';
 window.DAY_IN_MS = (1000 * 60 * 60 * 24);
 window.HASH_DELIMITER = '~';
 window.REPOS = {};
@@ -120,10 +121,52 @@ window.toggleNext = function toggleNext(ele) {
   parent.className = classes.join(' ');
 };
 
-window.getBaseLink = function getBaseLink(repoId) {
-  return `${window.BASE_URL}/${
-    window.REPOS[repoId].location.organization}/${
-    window.REPOS[repoId].location.repoName}`;
+window.filterUnsupported = function filterUnsupported(string) {
+  // checks for a pre-defined unsupported tag
+  return string.includes(window.UNSUPPORTED_INDICATOR) ? undefined : string;
+};
+
+window.getAuthorLink = function getAuthorLink(repoId, author) {
+  const domainName = window.REPOS[repoId].location.domainName;
+  return window.filterUnsupported(window.DOMAIN_URL_MAP[domainName].BASE_URL + author);
+};
+
+window.getRepoLinkUnfiltered = function getRepoLink(repoId) {
+  // abstraction for repo link construction. Not supposed to be used by other files
+  const domainName = window.REPOS[repoId].location.domainName;
+  return window.DOMAIN_URL_MAP[domainName].REPO_URL
+      .replace('ORGANIZATION', window.REPOS[repoId].location.organization)
+      .replace('REPO_NAME', window.REPOS[repoId].location.repoName);
+};
+
+window.getRepoLink = function getRepoLink(repoId) {
+  return window.filterUnsupported(window.getRepoLinkUnfiltered(repoId));
+};
+
+window.getBranchLink = function getBranchLink(repoId, branch) {
+  const domainName = window.REPOS[repoId].location.domainName;
+  return window.filterUnsupported(window.getRepoLinkUnfiltered(repoId) + window.DOMAIN_URL_MAP[domainName].BRANCH
+      .replace('BRANCH', branch));
+};
+
+window.getCommitLink = function getCommitLink(repoId, commitHash) {
+  const domainName = window.REPOS[repoId].location.domainName;
+  return window.filterUnsupported(window.getRepoLinkUnfiltered(repoId) + window.DOMAIN_URL_MAP[domainName].COMMIT_PATH
+      .replace('COMMIT_HASH', commitHash));
+};
+
+window.getBlameLink = function getBlameLink(repoId, branch, filepath) {
+  const domainName = window.REPOS[repoId].location.domainName;
+  return window.filterUnsupported(window.getRepoLinkUnfiltered(repoId) + window.DOMAIN_URL_MAP[domainName].BLAME_PATH
+      .replace('BRANCH', branch)
+      .replace('FILE_PATH', filepath));
+};
+
+window.getHistoryLink = function getHistoryLink(repoId, branch, filepath) {
+  const domainName = window.REPOS[repoId].location.domainName;
+  return window.filterUnsupported(window.getRepoLinkUnfiltered(repoId) + window.DOMAIN_URL_MAP[domainName].HISTORY_PATH
+      .replace('BRANCH', branch)
+      .replace('FILE_PATH', filepath));
 };
 
 window.getGroupName = function getGroupName(group, filterGroupSelection) {
@@ -190,6 +233,8 @@ window.api = {
       errorMessages[repoName] = message;
     });
 
+    window.DOMAIN_URL_MAP = data.supportedDomainUrlMap;
+
     const names = [];
     data.repos.forEach((repo) => {
       const repoName = `${repo.displayName}`;

frontend/src/views/v-authorship.vue

@@ -105,14 +105,14 @@
             span {{ i + 1 }}.    {{ file.path }}  
           span.icons
             a(
-              v-bind:href="getFileLink(file, 'commits')", target="_blank"
+              v-bind:href="getHistoryLink(file)", target="_blank"
             )
               .tooltip
                 font-awesome-icon.button(icon="history")
                 span.tooltip-text Click to view the history view of file
             a(
               v-if='!file.isBinary',
-              v-bind:href="getFileLink(file, 'blame')", target="_blank",
+              v-bind:href="getBlameLink(file)", target="_blank",
               title="click to view the blame view of file"
             )
               .tooltip
@@ -525,11 +525,14 @@ export default {
       this.updateFileTypeHash();
     },
 
-    getFileLink(file, path) {
+    getHistoryLink(file) {
       const repo = window.REPOS[this.info.repo];
+      return window.getHistoryLink(this.info.repo, repo.branch, file.path);
+    },
 
-      return `${window.BASE_URL}/${
-        repo.location.organization}/${repo.location.repoName}/${path}/${repo.branch}/${file.path}`;
+    getBlameLink(file) {
+      const repo = window.REPOS[this.info.repo];
+      return window.getBlameLink(this.info.repo, repo.branch, file.path);
     },
 
     getFileTypeBlankLineInfo(fileType) {

frontend/src/views/v-summary.vue

@@ -281,7 +281,7 @@ export default {
 
     // view functions //
     getReportIssueGitHubLink(stackTrace) {
-      return `${window.BASE_URL}/reposense/RepoSense/issues/new?title=${this.getReportIssueTitle()
+      return `${window.REPOSENSE_REPO_URL}/issues/new?title=${this.getReportIssueTitle()
       }&body=${this.getReportIssueMessage(stackTrace)}`;
     },
 

frontend/src/views/v-zoom.vue

@@ -270,9 +270,9 @@ export default {
 
     getSliceLink(slice) {
       if (this.info.zIsMerged) {
-        return `${window.getBaseLink(slice.repoId)}/commit/${slice.hash}`;
+        return window.getCommitLink(slice.repoId, slice.hash);
       }
-      return `${window.getBaseLink(this.info.zUser.repoId)}/commit/${slice.hash}`;
+      return window.getCommitLink(this.info.zUser.repoId, slice.hash);
     },
 
     scrollToCommit(tag, commit) {

src/main/java/reposense/authorship/FileInfoExtractor.java

@@ -145,7 +145,7 @@ public static Set<Path> getFiles(RepoConfiguration repoConfig, boolean isBinaryF
         return modifiedFileList.stream()
                 .filter(file -> isBinaryFile == file.startsWith(BINARY_FILE_LINE_DIFF_RESULT))
                 .map(file -> file.split("\t")[2])
-                .filter(FileUtil::isValidPath)
+                .filter(FileUtil::isValidPathWithLogging)
                 .map(filteredFile -> Paths.get(filteredFile))
                 .collect(Collectors.toCollection(HashSet::new));
     }
@@ -245,7 +245,7 @@ private static int getStartingLineNumber(String linesChanged) {
     private static boolean isValidTextFile(String filePath, Set<Path> textFilesSet) {
         boolean isValidFilePath;
         try {
-            isValidFilePath = FileUtil.isValidPath(filePath);
+            isValidFilePath = FileUtil.isValidPathWithLogging(filePath);
         } catch (InvalidPathException ipe) {
             logger.log(Level.WARNING, String.format(MESSAGE_INVALID_FILE_PATH, filePath));
             isValidFilePath = false;