ui-blame.c (view raw)
1/* ui-blame.c: functions for blame output
2 *
3 * Copyright (C) 2006-2017 cgit Development Team <cgit@lists.zx2c4.com>
4 *
5 * Licensed under GNU General Public License v2
6 * (see COPYING for full license text)
7 */
8
9#include "cgit.h"
10#include "ui-blame.h"
11#include "html.h"
12#include "ui-shared.h"
13#include "argv-array.h"
14#include "blame.h"
15
16
17static char *emit_suspect_detail(struct blame_origin *suspect)
18{
19 struct commitinfo *info;
20 struct strbuf detail = STRBUF_INIT;
21
22 info = cgit_parse_commit(suspect->commit);
23
24 strbuf_addf(&detail, "author %s", info->author);
25 if (!ctx.cfg.noplainemail)
26 strbuf_addf(&detail, " %s", info->author_email);
27 strbuf_addf(&detail, " %s\n",
28 show_date(info->author_date, info->author_tz,
29 cgit_date_mode(DATE_ISO8601)));
30
31 strbuf_addf(&detail, "committer %s", info->committer);
32 if (!ctx.cfg.noplainemail)
33 strbuf_addf(&detail, " %s", info->committer_email);
34 strbuf_addf(&detail, " %s\n\n",
35 show_date(info->committer_date, info->committer_tz,
36 cgit_date_mode(DATE_ISO8601)));
37
38 strbuf_addstr(&detail, info->subject);
39
40 cgit_free_commitinfo(info);
41 return strbuf_detach(&detail, NULL);
42}
43
44static void emit_blame_entry_hash(struct blame_entry *ent)
45{
46 struct blame_origin *suspect = ent->suspect;
47 struct object_id *oid = &suspect->commit->object.oid;
48 unsigned long line = 0;
49
50 char *detail = emit_suspect_detail(suspect);
51 html("<span class='sha1'>");
52 cgit_commit_link(find_unique_abbrev(oid, DEFAULT_ABBREV), detail,
53 NULL, ctx.qry.head, oid_to_hex(oid), suspect->path);
54 html("</span>");
55 free(detail);
56
57 while (line++ < ent->num_lines)
58 html("\n");
59}
60
61static void emit_blame_entry_linenumber(struct blame_entry *ent)
62{
63 const char *numberfmt = "<a id='n%1$d' href='#n%1$d'>%1$d</a>\n";
64
65 unsigned long lineno = ent->lno;
66 while (lineno < ent->lno + ent->num_lines)
67 htmlf(numberfmt, ++lineno);
68}
69
70static void emit_blame_entry_line_background(struct blame_scoreboard *sb,
71 struct blame_entry *ent)
72{
73 unsigned long line;
74 size_t len, maxlen = 2;
75 const char* pos, *endpos;
76
77 for (line = ent->lno; line < ent->lno + ent->num_lines; line++) {
78 html("\n");
79 pos = blame_nth_line(sb, line);
80 endpos = blame_nth_line(sb, line + 1);
81 len = 0;
82 while (pos < endpos) {
83 len++;
84 if (*pos++ == '\t')
85 len = (len + 7) & ~7;
86 }
87 if (len > maxlen)
88 maxlen = len;
89 }
90
91 for (len = 0; len < maxlen - 1; len++)
92 html(" ");
93}
94
95struct walk_tree_context {
96 char *curr_rev;
97 int match_baselen;
98 int state;
99};
100
101static void print_object(const struct object_id *oid, const char *path,
102 const char *basename, const char *rev)
103{
104 enum object_type type;
105 char *buf;
106 unsigned long size;
107 struct argv_array rev_argv = ARGV_ARRAY_INIT;
108 struct rev_info revs;
109 struct blame_scoreboard sb;
110 struct blame_origin *o;
111 struct blame_entry *ent = NULL;
112
113 type = oid_object_info(the_repository, oid, &size);
114 if (type == OBJ_BAD) {
115 cgit_print_error_page(404, "Not found", "Bad object name: %s",
116 oid_to_hex(oid));
117 return;
118 }
119
120 buf = read_object_file(oid, &type, &size);
121 if (!buf) {
122 cgit_print_error_page(500, "Internal server error",
123 "Error reading object %s", oid_to_hex(oid));
124 return;
125 }
126
127 argv_array_push(&rev_argv, "blame");
128 argv_array_push(&rev_argv, rev);
129 init_revisions(&revs, NULL);
130 revs.diffopt.flags.allow_textconv = 1;
131 setup_revisions(rev_argv.argc, rev_argv.argv, &revs, NULL);
132 init_scoreboard(&sb);
133 sb.revs = &revs;
134 setup_scoreboard(&sb, path, &o);
135 o->suspects = blame_entry_prepend(NULL, 0, sb.num_lines, o);
136 prio_queue_put(&sb.commits, o->commit);
137 blame_origin_decref(o);
138 sb.ent = NULL;
139 sb.path = path;
140 assign_blame(&sb, 0);
141 blame_sort_final(&sb);
142 blame_coalesce(&sb);
143
144 cgit_set_title_from_path(path);
145
146 cgit_print_layout_start();
147 htmlf("blob: %s (", oid_to_hex(oid));
148 cgit_plain_link("plain", NULL, NULL, ctx.qry.head, rev, path);
149 html(") (");
150 cgit_tree_link("tree", NULL, NULL, ctx.qry.head, rev, path);
151 html(")\n");
152
153 if (ctx.cfg.max_blob_size && size / 1024 > ctx.cfg.max_blob_size) {
154 htmlf("<div class='error'>blob size (%ldKB)"
155 " exceeds display size limit (%dKB).</div>",
156 size / 1024, ctx.cfg.max_blob_size);
157 goto cleanup;
158 }
159
160 html("<table class='blame blob'>\n<tr>\n");
161
162 /* Commit hashes */
163 html("<td class='hashes'>");
164 for (ent = sb.ent; ent; ent = ent->next) {
165 html("<div class='alt'><pre>");
166 emit_blame_entry_hash(ent);
167 html("</pre></div>");
168 }
169 html("</td>\n");
170
171 /* Line numbers */
172 if (ctx.cfg.enable_tree_linenumbers) {
173 html("<td class='linenumbers'>");
174 for (ent = sb.ent; ent; ent = ent->next) {
175 html("<div class='alt'><pre>");
176 emit_blame_entry_linenumber(ent);
177 html("</pre></div>");
178 }
179 html("</td>\n");
180 }
181
182 html("<td class='lines'><div>");
183
184 /* Colored bars behind lines */
185 html("<div>");
186 for (ent = sb.ent; ent; ) {
187 struct blame_entry *e = ent->next;
188 html("<div class='alt'><pre>");
189 emit_blame_entry_line_background(&sb, ent);
190 html("</pre></div>");
191 free(ent);
192 ent = e;
193 }
194 html("</div>");
195
196 free((void *)sb.final_buf);
197
198 /* Lines */
199 html("<pre><code>");
200 if (ctx.repo->source_filter) {
201 char *filter_arg = xstrdup(basename);
202 cgit_open_filter(ctx.repo->source_filter, filter_arg);
203 html_raw(buf, size);
204 cgit_close_filter(ctx.repo->source_filter);
205 free(filter_arg);
206 } else {
207 html_txt(buf);
208 }
209 html("</code></pre>");
210
211 html("</div></td>\n");
212
213 html("</tr>\n</table>\n");
214
215 cgit_print_layout_end();
216
217cleanup:
218 free(buf);
219}
220
221static int walk_tree(const struct object_id *oid, struct strbuf *base,
222 const char *pathname, unsigned mode, int stage,
223 void *cbdata)
224{
225 struct walk_tree_context *walk_tree_ctx = cbdata;
226
227 if (base->len == walk_tree_ctx->match_baselen) {
228 if (S_ISREG(mode)) {
229 struct strbuf buffer = STRBUF_INIT;
230 strbuf_addbuf(&buffer, base);
231 strbuf_addstr(&buffer, pathname);
232 print_object(oid, buffer.buf, pathname,
233 walk_tree_ctx->curr_rev);
234 strbuf_release(&buffer);
235 walk_tree_ctx->state = 1;
236 } else if (S_ISDIR(mode)) {
237 walk_tree_ctx->state = 2;
238 }
239 } else if (base->len < INT_MAX
240 && (int)base->len > walk_tree_ctx->match_baselen) {
241 walk_tree_ctx->state = 2;
242 } else if (S_ISDIR(mode)) {
243 return READ_TREE_RECURSIVE;
244 }
245 return 0;
246}
247
248static int basedir_len(const char *path)
249{
250 char *p = strrchr(path, '/');
251 if (p)
252 return p - path + 1;
253 return 0;
254}
255
256void cgit_print_blame(void)
257{
258 const char *rev = ctx.qry.sha1;
259 struct object_id oid;
260 struct commit *commit;
261 struct pathspec_item path_items = {
262 .match = ctx.qry.path,
263 .len = ctx.qry.path ? strlen(ctx.qry.path) : 0
264 };
265 struct pathspec paths = {
266 .nr = 1,
267 .items = &path_items
268 };
269 struct walk_tree_context walk_tree_ctx = {
270 .state = 0
271 };
272
273 if (!rev)
274 rev = ctx.qry.head;
275
276 if (get_oid(rev, &oid)) {
277 cgit_print_error_page(404, "Not found",
278 "Invalid revision name: %s", rev);
279 return;
280 }
281 commit = lookup_commit_reference(&oid);
282 if (!commit || parse_commit(commit)) {
283 cgit_print_error_page(404, "Not found",
284 "Invalid commit reference: %s", rev);
285 return;
286 }
287
288 walk_tree_ctx.curr_rev = xstrdup(rev);
289 walk_tree_ctx.match_baselen = (path_items.match) ?
290 basedir_len(path_items.match) : -1;
291
292 read_tree_recursive(commit->maybe_tree, "", 0, 0, &paths, walk_tree,
293 &walk_tree_ctx);
294 if (!walk_tree_ctx.state)
295 cgit_print_error_page(404, "Not found", "Not found");
296 else if (walk_tree_ctx.state == 2)
297 cgit_print_error_page(404, "No blame for folders",
298 "Blame is not available for folders.");
299
300 free(walk_tree_ctx.curr_rev);
301}