summaryrefslogtreecommitdiffstats
path: root/src/main/java/com/gitblit/utils/BugtraqProcessor.java
blob: 67f220f6b92447c21fe923f7e4c54991a438afb6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
/*
 * Copyright 2013 gitblit.com.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.gitblit.utils;

import java.io.IOException;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.eclipse.jgit.errors.ConfigInvalidException;
import org.eclipse.jgit.lib.Repository;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.gitblit.IStoredSettings;
import com.gitblit.Keys;
import com.gitblit.models.RepositoryModel;
import com.syntevo.bugtraq.BugtraqConfig;
import com.syntevo.bugtraq.BugtraqFormatter;
import com.syntevo.bugtraq.BugtraqFormatter.OutputHandler;

public class BugtraqProcessor {

	private final Logger logger = LoggerFactory.getLogger(getClass());

	private final IStoredSettings settings;

	public BugtraqProcessor(IStoredSettings settings) {
		this.settings = settings;
	}

	/**
	 * Returns an html version of the commit message with any global or
	 * repository-specific regular expression substitution applied.
	 *
	 * This method uses the preferred renderer to transform the commit message.
	 *
	 * @param repository
	 * @param model
	 * @param text
	 * @return html version of the commit message
	 */
	public String processCommitMessage(Repository repository, RepositoryModel model, String text) {
		switch (model.commitMessageRenderer) {
		case MARKDOWN:
			try {
				String prepared = processTextRegex(repository, model.name, text);
				return MarkdownUtils.transformMarkdown(prepared);
			} catch (Exception e) {
				logger.error("Failed to render commit message as markdown", e);
			}
			break;
		default:
			// noop
			break;
		}

		return processPlainCommitMessage(repository, model.name, text);
	}

	/**
	 * Returns an html version of the commit message with any global or
	 * repository-specific regular expression substitution applied.
	 *
	 * This method assumes the commit message is plain text.
	 *
	 * @param repository
	 * @param repositoryName
	 * @param text
	 * @return html version of the commit message
	 */
	public String processPlainCommitMessage(Repository repository, String repositoryName, String text) {
		String html = StringUtils.escapeForHtml(text, false);
		html = processTextRegex(repository, repositoryName, html);
		return StringUtils.breakLinesForHtml(html);

	}

	/**
	 * Returns an processed version of the text with any global or
	 * repository-specific regular expression substitution applied.
	 *
	 * @param repository
	 * @param repositoryName
	 * @param text
	 * @return processed version of the text
	 */
	public String processText(Repository repository, String repositoryName, String text) {
		String html = processTextRegex(repository, repositoryName, text);
		return html;
	}

	/**
	 * Apply globally or per-repository specified regex substitutions to the
	 * text.
	 *
	 * @param repository
	 * @param repositoryName
	 * @param text
	 * @return the processed text
	 */
	protected String processTextRegex(Repository repository, String repositoryName, String text) {
		Map<String, String> map = new HashMap<String, String>();
		// global regex keys
		if (settings.getBoolean(Keys.regex.global, false)) {
			for (String key : settings.getAllKeys(Keys.regex.global)) {
				if (!key.equals(Keys.regex.global)) {
					String subKey = key.substring(key.lastIndexOf('.') + 1);
					map.put(subKey, settings.getString(key, ""));
				}
			}
		}

		// repository-specific regex keys
		List<String> keys = settings.getAllKeys(Keys.regex._ROOT + "."
				+ repositoryName.toLowerCase());
		for (String key : keys) {
			String subKey = key.substring(key.lastIndexOf('.') + 1);
			map.put(subKey, settings.getString(key, ""));
		}

		for (Entry<String, String> entry : map.entrySet()) {
			String definition = entry.getValue().trim();
			String[] chunks = definition.split("!!!");
			if (chunks.length == 2) {
				text = text.replaceAll(chunks[0], chunks[1]);
			} else {
				logger.warn(entry.getKey()
						+ " improperly formatted.  Use !!! to separate match from replacement: "
						+ definition);
			}
		}

		try {
			// parse bugtraq repo config
			BugtraqConfig config = BugtraqConfig.read(repository);
			if (config != null) {
				BugtraqFormatter formatter = new BugtraqFormatter(config);
				StringBuilder sb = new StringBuilder();
				formatter.formatLogMessage(text, new BugtraqOutputHandler(sb));
				text = sb.toString();
			}
		} catch (IOException e) {
			logger.error(MessageFormat.format("Bugtraq config for {0} is invalid!", repositoryName), e);
		} catch (ConfigInvalidException e) {
			logger.error(MessageFormat.format("Bugtraq config for {0} is invalid!", repositoryName), e);
		}

		return text;
	}

	private class BugtraqOutputHandler implements OutputHandler {

		final StringBuilder sb;

		BugtraqOutputHandler(StringBuilder sb) {
			this.sb = sb;
		}

		@Override
		public void appendText(String text) {
			sb.append(text);
		}

		@Override
		public void appendLink(String name, String target) {
			sb.append(MessageFormat.format("<a class=\"bugtraq\" href=\"{1}\" target=\"_blank\">{0}</a>", name, target));
		}
	}
}