1 404c43c4 2018-06-21 stsp /*
  2 4c9641fd 2019-08-21 stsp  * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
  3 404c43c4 2018-06-21 stsp  *
  4 404c43c4 2018-06-21 stsp  * Permission to use, copy, modify, and distribute this software for any
  5 404c43c4 2018-06-21 stsp  * purpose with or without fee is hereby granted, provided that the above
  6 404c43c4 2018-06-21 stsp  * copyright notice and this permission notice appear in all copies.
  7 404c43c4 2018-06-21 stsp  *
  8 404c43c4 2018-06-21 stsp  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  9 404c43c4 2018-06-21 stsp  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 10 404c43c4 2018-06-21 stsp  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 11 404c43c4 2018-06-21 stsp  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 12 404c43c4 2018-06-21 stsp  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 13 404c43c4 2018-06-21 stsp  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 14 404c43c4 2018-06-21 stsp  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 15 404c43c4 2018-06-21 stsp  */
 16 404c43c4 2018-06-21 stsp 
 17 404c43c4 2018-06-21 stsp #include <sys/queue.h>
 18 404c43c4 2018-06-21 stsp #include <sys/stat.h>
 19 404c43c4 2018-06-21 stsp 
 20 404c43c4 2018-06-21 stsp #include <sha1.h>
 21 404c43c4 2018-06-21 stsp #include <string.h>
 22 404c43c4 2018-06-21 stsp #include <stdio.h>
 23 404c43c4 2018-06-21 stsp #include <stdlib.h>
 24 404c43c4 2018-06-21 stsp #include <time.h>
 25 404c43c4 2018-06-21 stsp #include <util.h>
 26 404c43c4 2018-06-21 stsp #include <zlib.h>
 27 404c43c4 2018-06-21 stsp 
 28 404c43c4 2018-06-21 stsp #include "got_error.h"
 29 404c43c4 2018-06-21 stsp #include "got_object.h"
 30 404c43c4 2018-06-21 stsp #include "got_blame.h"
 31 404c43c4 2018-06-21 stsp #include "got_opentemp.h"
 32 404c43c4 2018-06-21 stsp 
 33 63581804 2018-07-09 stsp #include "got_lib_inflate.h"
 34 404c43c4 2018-06-21 stsp #include "got_lib_delta.h"
 35 404c43c4 2018-06-21 stsp #include "got_lib_object.h"
 36 404c43c4 2018-06-21 stsp #include "got_lib_diff.h"
 37 293f6400 2018-09-20 stsp #include "got_commit_graph.h"
 38 404c43c4 2018-06-21 stsp 
 39 404c43c4 2018-06-21 stsp struct got_blame_line {
 40 404c43c4 2018-06-21 stsp 	int annotated;
 41 9b94757a 2018-06-21 stsp 	struct got_object_id id;
 42 404c43c4 2018-06-21 stsp };
 43 404c43c4 2018-06-21 stsp 
 44 404c43c4 2018-06-21 stsp struct got_blame {
 45 404c43c4 2018-06-21 stsp 	FILE *f;
 46 6c4c42e0 2019-06-24 stsp 	size_t filesize;
 47 6fcac457 2018-11-19 stsp 	int nlines;
 48 06ca4d09 2018-11-19 stsp 	int nannotated;
 49 404c43c4 2018-06-21 stsp 	struct got_blame_line *lines; /* one per line */
 50 6c4c42e0 2019-06-24 stsp 	off_t *line_offsets;		/* one per line */
 51 c35a7943 2018-07-12 stsp 	int ncommits;
 52 404c43c4 2018-06-21 stsp };
 53 404c43c4 2018-06-21 stsp 
 54 404c43c4 2018-06-21 stsp static const struct got_error *
 55 84451b3e 2018-07-10 stsp annotate_line(struct got_blame *blame, int lineno, struct got_object_id *id,
 56 84451b3e 2018-07-10 stsp     const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
 57 84451b3e 2018-07-10 stsp     void *arg)
 58 404c43c4 2018-06-21 stsp {
 59 404c43c4 2018-06-21 stsp 	const struct got_error *err = NULL;
 60 404c43c4 2018-06-21 stsp 	struct got_blame_line *line;
 61 404c43c4 2018-06-21 stsp 
 62 404c43c4 2018-06-21 stsp 	if (lineno < 1 || lineno > blame->nlines)
 63 f2e233d8 2018-11-19 stsp 		return NULL;
 64 404c43c4 2018-06-21 stsp 	
 65 404c43c4 2018-06-21 stsp 	line = &blame->lines[lineno - 1];
 66 404c43c4 2018-06-21 stsp 	if (line->annotated)
 67 84451b3e 2018-07-10 stsp 		return NULL;
 68 404c43c4 2018-06-21 stsp 
 69 404c43c4 2018-06-21 stsp 	memcpy(&line->id, id, sizeof(line->id));
 70 404c43c4 2018-06-21 stsp 	line->annotated = 1;
 71 06ca4d09 2018-11-19 stsp 	blame->nannotated++;
 72 84451b3e 2018-07-10 stsp 	if (cb)
 73 84451b3e 2018-07-10 stsp 		err = cb(arg, blame->nlines, lineno, id);
 74 84451b3e 2018-07-10 stsp 	return err;
 75 404c43c4 2018-06-21 stsp }
 76 404c43c4 2018-06-21 stsp 
 77 404c43c4 2018-06-21 stsp static const struct got_error *
 78 c35a7943 2018-07-12 stsp blame_changes(struct got_blame *blame, struct got_diff_changes *changes,
 79 c35a7943 2018-07-12 stsp     struct got_object_id *commit_id,
 80 c35a7943 2018-07-12 stsp     const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
 81 c35a7943 2018-07-12 stsp     void *arg)
 82 c35a7943 2018-07-12 stsp {
 83 c35a7943 2018-07-12 stsp 	const struct got_error *err = NULL;
 84 c35a7943 2018-07-12 stsp 	struct got_diff_change *change;
 85 c35a7943 2018-07-12 stsp 
 86 c35a7943 2018-07-12 stsp 	SIMPLEQ_FOREACH(change, &changes->entries, entry) {
 87 c35a7943 2018-07-12 stsp 		int c = change->cv.c;
 88 c35a7943 2018-07-12 stsp 		int d = change->cv.d;
 89 4c9641fd 2019-08-21 stsp 		int new_lineno = (c < d ? c : d);
 90 c35a7943 2018-07-12 stsp 		int new_length = (c < d ? d - c + 1 : (c == d ? 1 : 0));
 91 c35a7943 2018-07-12 stsp 		int ln;
 92 c35a7943 2018-07-12 stsp 
 93 c35a7943 2018-07-12 stsp 		for (ln = new_lineno; ln < new_lineno + new_length; ln++) {
 94 4c9641fd 2019-08-21 stsp 			err = annotate_line(blame, ln, commit_id, cb, arg);
 95 c35a7943 2018-07-12 stsp 			if (err)
 96 c35a7943 2018-07-12 stsp 				return err;
 97 06ca4d09 2018-11-19 stsp 			if (blame->nlines == blame->nannotated)
 98 4c9641fd 2019-08-21 stsp 				break;
 99 c35a7943 2018-07-12 stsp 		}
100 c35a7943 2018-07-12 stsp 	}
101 c35a7943 2018-07-12 stsp 
102 c35a7943 2018-07-12 stsp 	return NULL;
103 c35a7943 2018-07-12 stsp }
104 c35a7943 2018-07-12 stsp 
105 c35a7943 2018-07-12 stsp static const struct got_error *
106 4c9641fd 2019-08-21 stsp blame_commit(struct got_blame *blame, struct got_object_id *parent_id,
107 4c9641fd 2019-08-21 stsp     struct got_object_id *id, const char *path, struct got_repository *repo,
108 84451b3e 2018-07-10 stsp     const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
109 84451b3e 2018-07-10 stsp     void *arg)
110 404c43c4 2018-06-21 stsp {
111 404c43c4 2018-06-21 stsp 	const struct got_error *err = NULL;
112 d0275cf7 2019-08-21 stsp 	struct got_object *obj = NULL;
113 4c9641fd 2019-08-21 stsp 	struct got_object_id *obj_id = NULL;
114 8d725ae1 2019-08-18 stsp 	struct got_commit_object *commit = NULL;
115 4c9641fd 2019-08-21 stsp 	struct got_blob_object *blob = NULL;
116 404c43c4 2018-06-21 stsp 	struct got_diff_changes *changes = NULL;
117 404c43c4 2018-06-21 stsp 
118 4c9641fd 2019-08-21 stsp 	err = got_object_open_as_commit(&commit, repo, parent_id);
119 8d725ae1 2019-08-18 stsp 	if (err)
120 8d725ae1 2019-08-18 stsp 		return err;
121 8d725ae1 2019-08-18 stsp 
122 4c9641fd 2019-08-21 stsp 	err = got_object_id_by_path(&obj_id, repo, parent_id, path);
123 4c9641fd 2019-08-21 stsp 	if (err) {
124 4c9641fd 2019-08-21 stsp 		if (err->code == GOT_ERR_NO_TREE_ENTRY)
125 4c9641fd 2019-08-21 stsp 			err = NULL;
126 404c43c4 2018-06-21 stsp 		goto done;
127 4c9641fd 2019-08-21 stsp 	}
128 27d434c2 2018-09-15 stsp 
129 27d434c2 2018-09-15 stsp 	err = got_object_open(&obj, repo, obj_id);
130 27d434c2 2018-09-15 stsp 	if (err)
131 27d434c2 2018-09-15 stsp 		goto done;
132 27d434c2 2018-09-15 stsp 
133 15a94983 2018-12-23 stsp 	if (obj->type != GOT_OBJ_TYPE_BLOB) {
134 404c43c4 2018-06-21 stsp 		err = got_error(GOT_ERR_OBJ_TYPE);
135 404c43c4 2018-06-21 stsp 		goto done;
136 404c43c4 2018-06-21 stsp 	}
137 404c43c4 2018-06-21 stsp 
138 404c43c4 2018-06-21 stsp 	err = got_object_blob_open(&blob, repo, obj, 8192);
139 404c43c4 2018-06-21 stsp 	if (err)
140 404c43c4 2018-06-21 stsp 		goto done;
141 404c43c4 2018-06-21 stsp 
142 4c9641fd 2019-08-21 stsp 	if (fseek(blame->f, 0L, SEEK_SET) == -1) {
143 4c9641fd 2019-08-21 stsp 		err = got_ferror(blame->f, GOT_ERR_IO);
144 4c9641fd 2019-08-21 stsp 		goto done;
145 4c9641fd 2019-08-21 stsp 	}
146 4c9641fd 2019-08-21 stsp 
147 4c9641fd 2019-08-21 stsp 	err = got_diff_blob_file_lines_changed(&changes, blob, blame->f,
148 4c9641fd 2019-08-21 stsp 	    blame->filesize);
149 404c43c4 2018-06-21 stsp 	if (err)
150 404c43c4 2018-06-21 stsp 		goto done;
151 404c43c4 2018-06-21 stsp 
152 404c43c4 2018-06-21 stsp 	if (changes) {
153 c35a7943 2018-07-12 stsp 		err = blame_changes(blame, changes, id, cb, arg);
154 ce7f1bfe 2018-07-13 stsp 		got_diff_free_changes(changes);
155 d68a0a7d 2018-07-10 stsp 	} else if (cb)
156 3bf198ba 2018-07-10 stsp 		err = cb(arg, blame->nlines, -1, id);
157 404c43c4 2018-06-21 stsp done:
158 8d725ae1 2019-08-18 stsp 	if (commit)
159 8d725ae1 2019-08-18 stsp 		got_object_commit_close(commit);
160 27d434c2 2018-09-15 stsp 	free(obj_id);
161 404c43c4 2018-06-21 stsp 	if (obj)
162 404c43c4 2018-06-21 stsp 		got_object_close(obj);
163 404c43c4 2018-06-21 stsp 	if (blob)
164 404c43c4 2018-06-21 stsp 		got_object_blob_close(blob);
165 404c43c4 2018-06-21 stsp 	return err;
166 404c43c4 2018-06-21 stsp }
167 404c43c4 2018-06-21 stsp 
168 fb43ecf1 2019-02-11 stsp static const struct got_error *
169 404c43c4 2018-06-21 stsp blame_close(struct got_blame *blame)
170 404c43c4 2018-06-21 stsp {
171 fb43ecf1 2019-02-11 stsp 	const struct got_error *err = NULL;
172 c35a7943 2018-07-12 stsp 
173 fb43ecf1 2019-02-11 stsp 	if (blame->f && fclose(blame->f) != 0)
174 638f9024 2019-05-13 stsp 		err = got_error_from_errno("fclose");
175 404c43c4 2018-06-21 stsp 	free(blame->lines);
176 404c43c4 2018-06-21 stsp 	free(blame);
177 fb43ecf1 2019-02-11 stsp 	return err;
178 404c43c4 2018-06-21 stsp }
179 404c43c4 2018-06-21 stsp 
180 404c43c4 2018-06-21 stsp static const struct got_error *
181 404c43c4 2018-06-21 stsp blame_open(struct got_blame **blamep, const char *path,
182 84451b3e 2018-07-10 stsp     struct got_object_id *start_commit_id, struct got_repository *repo,
183 84451b3e 2018-07-10 stsp     const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
184 84451b3e 2018-07-10 stsp     void *arg)
185 404c43c4 2018-06-21 stsp {
186 404c43c4 2018-06-21 stsp 	const struct got_error *err = NULL;
187 404c43c4 2018-06-21 stsp 	struct got_object *obj = NULL;
188 27d434c2 2018-09-15 stsp 	struct got_object_id *obj_id = NULL;
189 404c43c4 2018-06-21 stsp 	struct got_blob_object *blob = NULL;
190 404c43c4 2018-06-21 stsp 	struct got_blame *blame = NULL;
191 4c9641fd 2019-08-21 stsp 	struct got_object_id *id = NULL, *pid = NULL;
192 404c43c4 2018-06-21 stsp 	int lineno;
193 293f6400 2018-09-20 stsp 	struct got_commit_graph *graph = NULL;
194 404c43c4 2018-06-21 stsp 
195 404c43c4 2018-06-21 stsp 	*blamep = NULL;
196 404c43c4 2018-06-21 stsp 
197 27d434c2 2018-09-15 stsp 	err = got_object_id_by_path(&obj_id, repo, start_commit_id, path);
198 404c43c4 2018-06-21 stsp 	if (err)
199 404c43c4 2018-06-21 stsp 		return err;
200 27d434c2 2018-09-15 stsp 
201 27d434c2 2018-09-15 stsp 	err = got_object_open(&obj, repo, obj_id);
202 27d434c2 2018-09-15 stsp 	if (err)
203 27d434c2 2018-09-15 stsp 		goto done;
204 27d434c2 2018-09-15 stsp 
205 15a94983 2018-12-23 stsp 	if (obj->type != GOT_OBJ_TYPE_BLOB) {
206 404c43c4 2018-06-21 stsp 		err = got_error(GOT_ERR_OBJ_TYPE);
207 404c43c4 2018-06-21 stsp 		goto done;
208 404c43c4 2018-06-21 stsp 	}
209 404c43c4 2018-06-21 stsp 
210 404c43c4 2018-06-21 stsp 	err = got_object_blob_open(&blob, repo, obj, 8192);
211 404c43c4 2018-06-21 stsp 	if (err)
212 404c43c4 2018-06-21 stsp 		goto done;
213 404c43c4 2018-06-21 stsp 
214 404c43c4 2018-06-21 stsp 	blame = calloc(1, sizeof(*blame));
215 404c43c4 2018-06-21 stsp 	if (blame == NULL)
216 638f9024 2019-05-13 stsp 		return got_error_from_errno("calloc");
217 404c43c4 2018-06-21 stsp 
218 404c43c4 2018-06-21 stsp 	blame->f = got_opentemp();
219 404c43c4 2018-06-21 stsp 	if (blame->f == NULL) {
220 638f9024 2019-05-13 stsp 		err = got_error_from_errno("got_opentemp");
221 404c43c4 2018-06-21 stsp 		goto done;
222 404c43c4 2018-06-21 stsp 	}
223 6c4c42e0 2019-06-24 stsp 	err = got_object_blob_dump_to_file(&blame->filesize, &blame->nlines,
224 6c4c42e0 2019-06-24 stsp 	   &blame->line_offsets, blame->f, blob);
225 b02560ec 2019-08-19 stsp 	if (err || blame->nlines == 0)
226 404c43c4 2018-06-21 stsp 		goto done;
227 b02560ec 2019-08-19 stsp 
228 b02560ec 2019-08-19 stsp 	/* Don't include \n at EOF in the blame line count. */
229 b02560ec 2019-08-19 stsp 	if (blame->line_offsets[blame->nlines - 1] == blame->filesize)
230 b02560ec 2019-08-19 stsp 		blame->nlines--;
231 404c43c4 2018-06-21 stsp 
232 404c43c4 2018-06-21 stsp 	blame->lines = calloc(blame->nlines, sizeof(*blame->lines));
233 404c43c4 2018-06-21 stsp 	if (blame->lines == NULL) {
234 638f9024 2019-05-13 stsp 		err = got_error_from_errno("calloc");
235 404c43c4 2018-06-21 stsp 		goto done;
236 404c43c4 2018-06-21 stsp 	}
237 404c43c4 2018-06-21 stsp 
238 8d725ae1 2019-08-18 stsp 	err = got_commit_graph_open(&graph, start_commit_id, path, 1, repo);
239 404c43c4 2018-06-21 stsp 	if (err)
240 293f6400 2018-09-20 stsp 		return err;
241 293f6400 2018-09-20 stsp 	err = got_commit_graph_iter_start(graph, start_commit_id, repo);
242 293f6400 2018-09-20 stsp 	if (err)
243 404c43c4 2018-06-21 stsp 		goto done;
244 4c9641fd 2019-08-21 stsp 	id = start_commit_id;
245 656b1f76 2019-05-11 jcs 	for (;;) {
246 4c9641fd 2019-08-21 stsp 		err = got_commit_graph_iter_next(&pid, graph);
247 404c43c4 2018-06-21 stsp 		if (err) {
248 293f6400 2018-09-20 stsp 			if (err->code == GOT_ERR_ITER_COMPLETED) {
249 4c9641fd 2019-08-21 stsp 				err = NULL;
250 293f6400 2018-09-20 stsp 				break;
251 293f6400 2018-09-20 stsp 			}
252 293f6400 2018-09-20 stsp 			if (err->code != GOT_ERR_ITER_NEED_MORE)
253 293f6400 2018-09-20 stsp 				break;
254 293f6400 2018-09-20 stsp 			err = got_commit_graph_fetch_commits(graph, 1, repo);
255 293f6400 2018-09-20 stsp 			if (err)
256 293f6400 2018-09-20 stsp 				break;
257 78695fb7 2019-08-12 stsp 			continue;
258 293f6400 2018-09-20 stsp 		}
259 4c9641fd 2019-08-21 stsp 		if (pid) {
260 4c9641fd 2019-08-21 stsp 			err = blame_commit(blame, pid, id, path, repo, cb, arg);
261 293f6400 2018-09-20 stsp 			if (err) {
262 293f6400 2018-09-20 stsp 				if (err->code == GOT_ERR_ITER_COMPLETED)
263 293f6400 2018-09-20 stsp 					err = NULL;
264 293f6400 2018-09-20 stsp 				break;
265 293f6400 2018-09-20 stsp 			}
266 06ca4d09 2018-11-19 stsp 			if (blame->nannotated == blame->nlines)
267 06ca4d09 2018-11-19 stsp 				break;
268 404c43c4 2018-06-21 stsp 		}
269 4c9641fd 2019-08-21 stsp 		id = pid;
270 293f6400 2018-09-20 stsp 	}
271 ed77f2ae 2018-06-21 stsp 
272 06ca4d09 2018-11-19 stsp 	if (id && blame->nannotated < blame->nlines) {
273 293f6400 2018-09-20 stsp 		/* Annotate remaining non-annotated lines with last commit. */
274 293f6400 2018-09-20 stsp 		for (lineno = 1; lineno <= blame->nlines; lineno++) {
275 293f6400 2018-09-20 stsp 			err = annotate_line(blame, lineno, id, cb, arg);
276 293f6400 2018-09-20 stsp 			if (err)
277 293f6400 2018-09-20 stsp 				goto done;
278 404c43c4 2018-06-21 stsp 		}
279 404c43c4 2018-06-21 stsp 	}
280 404c43c4 2018-06-21 stsp 
281 404c43c4 2018-06-21 stsp done:
282 293f6400 2018-09-20 stsp 	if (graph)
283 293f6400 2018-09-20 stsp 		got_commit_graph_close(graph);
284 27d434c2 2018-09-15 stsp 	free(obj_id);
285 404c43c4 2018-06-21 stsp 	if (obj)
286 404c43c4 2018-06-21 stsp 		got_object_close(obj);
287 404c43c4 2018-06-21 stsp 	if (blob)
288 404c43c4 2018-06-21 stsp 		got_object_blob_close(blob);
289 1828273a 2018-07-09 stsp 	if (err) {
290 1828273a 2018-07-09 stsp 		if (blame)
291 1828273a 2018-07-09 stsp 			blame_close(blame);
292 1828273a 2018-07-09 stsp 	} else
293 404c43c4 2018-06-21 stsp 		*blamep = blame;
294 404c43c4 2018-06-21 stsp 
295 404c43c4 2018-06-21 stsp 	return err;
296 404c43c4 2018-06-21 stsp }
297 84451b3e 2018-07-10 stsp 
298 84451b3e 2018-07-10 stsp const struct got_error *
299 0d8ff7d5 2019-08-14 stsp got_blame(const char *path, struct got_object_id *commit_id,
300 84451b3e 2018-07-10 stsp     struct got_repository *repo,
301 84451b3e 2018-07-10 stsp     const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
302 84451b3e 2018-07-10 stsp     void *arg)
303 84451b3e 2018-07-10 stsp {
304 fb43ecf1 2019-02-11 stsp 	const struct got_error *err = NULL, *close_err = NULL;
305 84451b3e 2018-07-10 stsp 	struct got_blame *blame;
306 84451b3e 2018-07-10 stsp 	char *abspath;
307 84451b3e 2018-07-10 stsp 
308 84451b3e 2018-07-10 stsp 	if (asprintf(&abspath, "%s%s", path[0] == '/' ? "" : "/", path) == -1)
309 638f9024 2019-05-13 stsp 		return got_error_from_errno2("asprintf", path);
310 84451b3e 2018-07-10 stsp 
311 84451b3e 2018-07-10 stsp 	err = blame_open(&blame, abspath, commit_id, repo, cb, arg);
312 84451b3e 2018-07-10 stsp 	free(abspath);
313 26206841 2018-07-12 stsp 	if (blame)
314 fb43ecf1 2019-02-11 stsp 		close_err = blame_close(blame);
315 fb43ecf1 2019-02-11 stsp 	return err ? err : close_err;
316 84451b3e 2018-07-10 stsp }