Permalink
Browse files

Sync bugtraq support for spec v0.3

Change-Id: I2c24d1201d4c36963a708b178e780c1828707269
  • Loading branch information...
1 parent 0fe9792 commit 206b4b09c872f3e9f078383c9a5c701b1549ff5c @gitblit committed Dec 16, 2013
View
@@ -1,7 +1,10 @@
[bugtraq "issues"]
url = http://code.google.com/p/gitblit/issues/detail?id=%BUGID%
- logRegex = "[Ii]ssue[-#:\\s]{1}\\d+"
- logRegex1 = "\\d+"
-[bugtraq "[pullrequests"]
+ loglinkregex = "[Ii]ssue[-#:\\s]{1}\\d+"
+ logregex = "\\d+"
+ loglinktext = issue-%BUGID%
+[bugtraq "pullrequests"]
url = "https://github.com/gitblit/gitblit/pull/%BUGID%"
- logRegex = "(?:pull request|pull|pr)\\s*[-#]?([0-9]+)"
+ loglinkregex = "(?:pull request|pull|pr)\\s*[-#]?[0-9]+"
+ logregex = "\\d+"
+ loglinktext = "pull request #%BUGID%"
@@ -29,80 +29,104 @@
*/
package com.syntevo.bugtraq;
-import java.io.File;
-import java.io.IOException;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Set;
-
-import org.eclipse.jgit.errors.ConfigInvalidException;
-import org.eclipse.jgit.lib.Config;
-import org.eclipse.jgit.lib.Constants;
-import org.eclipse.jgit.lib.FileMode;
-import org.eclipse.jgit.lib.ObjectId;
-import org.eclipse.jgit.lib.ObjectLoader;
-import org.eclipse.jgit.lib.Repository;
-import org.eclipse.jgit.revwalk.RevCommit;
-import org.eclipse.jgit.revwalk.RevTree;
-import org.eclipse.jgit.revwalk.RevWalk;
-import org.eclipse.jgit.storage.file.FileBasedConfig;
-import org.eclipse.jgit.treewalk.TreeWalk;
-import org.eclipse.jgit.treewalk.filter.PathFilterGroup;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
+import java.io.*;
+import java.util.*;
+
+import org.eclipse.jgit.errors.*;
+import org.eclipse.jgit.lib.*;
+import org.eclipse.jgit.revwalk.*;
+import org.eclipse.jgit.storage.file.*;
+import org.eclipse.jgit.treewalk.*;
+import org.eclipse.jgit.treewalk.filter.*;
+import org.jetbrains.annotations.*;
public final class BugtraqConfig {
// Constants ==============================================================
private static final String DOT_GIT_BUGTRAQ = ".gitbugtraq";
+ private static final String DOT_TGITCONFIG = ".tgitconfig";
private static final String BUGTRAQ = "bugtraq";
private static final String URL = "url";
private static final String ENABLED = "enabled";
- private static final String LOG_REGEX = "logRegex";
+ private static final String LOG_REGEX = "logregex";
+ private static final String LOG_FILTERREGEX = "logfilterregex";
+ private static final String LOG_LINKREGEX = "loglinkregex";
+ private static final String LOG_LINKTEXT = "loglinktext";
// Static =================================================================
@Nullable
public static BugtraqConfig read(@NotNull Repository repository) throws IOException, ConfigInvalidException {
- final Config baseConfig = getBaseConfig(repository);
+ Config baseConfig = getBaseConfig(repository, DOT_GIT_BUGTRAQ);
+ if (baseConfig == null) {
+ baseConfig = getBaseConfig(repository, DOT_TGITCONFIG);
+ }
+
final Set<String> allNames = new HashSet<String>();
final Config config = repository.getConfig();
- allNames.addAll(config.getSubsections(BUGTRAQ));
- if (baseConfig != null) {
- allNames.addAll(baseConfig.getSubsections(BUGTRAQ));
+ if (getString(null, URL, config, baseConfig) != null) {
+ allNames.add(null);
+ }
+ else {
+ allNames.addAll(config.getSubsections(BUGTRAQ));
+ if (baseConfig != null) {
+ allNames.addAll(baseConfig.getSubsections(BUGTRAQ));
+ }
}
final List<BugtraqEntry> entries = new ArrayList<BugtraqEntry>();
for (String name : allNames) {
final String url = getString(name, URL, config, baseConfig);
+ if (url == null) {
+ continue;
+ }
+
final String enabled = getString(name, ENABLED, config, baseConfig);
if (enabled != null && !"true".equals(enabled)) {
continue;
}
- final String logIdRegex = getString(name, LOG_REGEX, config, baseConfig);
- if (url == null || logIdRegex == null) {
+ String idRegex = getString(name, LOG_REGEX, config, baseConfig);
+ if (idRegex == null) {
return null;
}
- final List<String> logIdRegexs = new ArrayList<String>();
- logIdRegexs.add(logIdRegex);
-
- for (int index = 1; index < Integer.MAX_VALUE; index++) {
- final String logIdRegexN = getString(name, LOG_REGEX + index, config, baseConfig);
- if (logIdRegexN == null) {
- break;
+ String filterRegex = getString(name, LOG_FILTERREGEX, config, baseConfig);
+ final String linkRegex = getString(name, LOG_LINKREGEX, config, baseConfig);
+ if (filterRegex == null && linkRegex == null) {
+ final String[] split = idRegex.split("\n", Integer.MAX_VALUE);
+ if (split.length == 2) {
+ // Compatibility with TortoiseGit
+ filterRegex = split[0];
+ idRegex = split[1];
}
+ else {
+ // Backwards compatibility with specification version < 0.3
+ final List<String> logIdRegexs = new ArrayList<String>();
+ for (int index = 1; index < Integer.MAX_VALUE; index++) {
+ final String logIdRegexN = getString(name, LOG_REGEX + index, config, baseConfig);
+ if (logIdRegexN == null) {
+ break;
+ }
+
+ logIdRegexs.add(logIdRegexN);
+ }
- logIdRegexs.add(logIdRegexN);
+ if (logIdRegexs.size() > 1) {
+ throw new ConfigInvalidException("More than three " + LOG_REGEX + " entries found. This is not supported anymore since bugtraq version 0.3, use " + LOG_FILTERREGEX + " and " + LOG_LINKREGEX + " instead.");
+ }
+ else if (logIdRegexs.size() == 1) {
+ filterRegex = idRegex;
+ idRegex = logIdRegexs.get(0);
+ }
+ }
}
- entries.add(new BugtraqEntry(url, logIdRegexs));
+ final String linkText = getString(name, LOG_LINKTEXT, config, baseConfig);
+ entries.add(new BugtraqEntry(url, idRegex, linkRegex, filterRegex, linkText));
}
if (entries.isEmpty()) {
@@ -133,14 +157,14 @@ public static BugtraqConfig read(@NotNull Repository repository) throws IOExcept
// Utils ==================================================================
@Nullable
- private static Config getBaseConfig(Repository repository) throws IOException, ConfigInvalidException {
+ private static Config getBaseConfig(@NotNull Repository repository, @NotNull String configFileName) throws IOException, ConfigInvalidException {
final Config baseConfig;
if (repository.isBare()) {
// read bugtraq config directly from the repository
String content = null;
RevWalk rw = new RevWalk(repository);
TreeWalk tw = new TreeWalk(repository);
- tw.setFilter(PathFilterGroup.createFromStrings(DOT_GIT_BUGTRAQ));
+ tw.setFilter(PathFilterGroup.createFromStrings(configFileName));
try {
ObjectId headId = repository.getRef(Constants.HEAD).getTarget().getObjectId();
RevCommit commit = rw.parseCommit(headId);
@@ -155,7 +179,8 @@ private static Config getBaseConfig(Repository repository) throws IOException, C
break;
}
}
- } finally {
+ }
+ finally {
rw.dispose();
tw.release();
}
@@ -173,7 +198,7 @@ private static Config getBaseConfig(Repository repository) throws IOException, C
}
else {
// read bugtraq config from work tree
- final File baseFile = new File(repository.getWorkTree(), DOT_GIT_BUGTRAQ);
+ final File baseFile = new File(repository.getWorkTree(), configFileName);
if (baseFile.isFile()) {
FileBasedConfig fileConfig = new FileBasedConfig(baseFile, repository.getFS());
fileConfig.load();
@@ -187,7 +212,7 @@ private static Config getBaseConfig(Repository repository) throws IOException, C
}
@Nullable
- private static String getString(@NotNull String subsection, @NotNull String key, @NotNull Config config, @Nullable Config baseConfig) {
+ private static String getString(@Nullable String subsection, @NotNull String key, @NotNull Config config, @Nullable Config baseConfig) {
final String value = config.getString(BUGTRAQ, subsection, key);
if (value != null) {
return trimMaybeNull(value);
@@ -197,8 +222,8 @@ private static String getString(@NotNull String subsection, @NotNull String key,
return trimMaybeNull(baseConfig.getString(BUGTRAQ, subsection, key));
}
- return value;
- }
+ return value;
+ }
@Nullable
private static String trimMaybeNull(@Nullable String string) {
@@ -29,22 +29,22 @@
*/
package com.syntevo.bugtraq;
-import java.util.*;
-
import org.jetbrains.annotations.*;
final class BugtraqEntry {
// Fields =================================================================
private final String url;
+ private final String logLinkText;
private final BugtraqParser parser;
// Setup ==================================================================
- public BugtraqEntry(@NotNull String url, @NotNull List<String> logIdRegexs) throws BugtraqException {
+ public BugtraqEntry(@NotNull String url, @NotNull String logIdRegex, @Nullable String logLinkRegex, @Nullable String logFilterRegex, @Nullable String logLinkText) throws BugtraqException {
this.url = url;
- this.parser = BugtraqParser.createInstance(logIdRegexs);
+ this.logLinkText = logLinkText;
+ this.parser = BugtraqParser.createInstance(logIdRegex, logLinkRegex, logFilterRegex);
}
// Accessing ==============================================================
@@ -54,6 +54,11 @@ public String getUrl() {
return url;
}
+ @Nullable
+ public String getLogLinkText() {
+ return logLinkText;
+ }
+
@NotNull
public BugtraqParser getParser() {
return parser;
@@ -59,10 +59,6 @@ public int compare(IssueId o1, IssueId o2) {
for (BugtraqEntry entry : config.getEntries()) {
final List<BugtraqParserIssueId> ids = entry.getParser().parse(message);
- if (ids == null) {
- continue;
- }
-
for (BugtraqParserIssueId id : ids) {
allIds.add(new IssueId(entry, id));
}
@@ -76,8 +72,15 @@ public int compare(IssueId o1, IssueId o2) {
}
appendText(message.substring(lastIdEnd + 1, id.getFrom()), outputHandler);
+ final String logLinkText = issueId.entry.getLogLinkText();
+ final String linkText;
+ if (logLinkText != null) {
+ linkText = logLinkText.replace("%BUGID%", id.getId());
+ }
+ else {
+ linkText = message.substring(id.getFrom(), id.getTo() + 1);
+ }
- final String linkText = message.substring(id.getFrom(), id.getTo() + 1);
final String target = issueId.entry.getUrl().replace("%BUGID%", id.getId());
outputHandler.appendLink(linkText, target);
lastIdEnd = id.getTo();
Oops, something went wrong.

0 comments on commit 206b4b0

Please sign in to comment.