Blob


1 /*
2 * Copyright (c) 2018 Stefan Sperling <stsp@openbsd.org>
3 *
4 * Permission to use, copy, modify, and distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 */
17 #include <sys/queue.h>
18 #include <sys/stat.h>
20 #include <sha1.h>
21 #include <string.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <time.h>
25 #include <util.h>
26 #include <zlib.h>
28 #include "got_error.h"
29 #include "got_object.h"
30 #include "got_blame.h"
31 #include "got_opentemp.h"
33 #include "got_lib_inflate.h"
34 #include "got_lib_delta.h"
35 #include "got_lib_object.h"
36 #include "got_lib_diff.h"
37 #include "got_lib_diffoffset.h"
39 struct got_blame_line {
40 int annotated;
41 struct got_object_id id;
42 };
44 struct got_blame_diff_offsets {
45 struct got_diffoffset_chunks *chunks;
46 struct got_object_id *commit_id;
47 SLIST_ENTRY(got_blame_diff_offsets) entry;
48 };
50 SLIST_HEAD(got_blame_diff_offsets_list, got_blame_diff_offsets);
52 struct got_blame {
53 FILE *f;
54 size_t nlines;
55 struct got_blame_line *lines; /* one per line */
56 int ncommits;
57 struct got_blame_diff_offsets_list diff_offsets_list;
58 };
60 static void
61 free_diff_offsets(struct got_blame_diff_offsets *diff_offsets)
62 {
63 if (diff_offsets->chunks)
64 got_diffoffset_free(diff_offsets->chunks);
65 free(diff_offsets->commit_id);
66 free(diff_offsets);
67 }
69 static const struct got_error *
70 alloc_diff_offsets(struct got_blame_diff_offsets **diff_offsets,
71 struct got_object_id *commit_id)
72 {
73 const struct got_error *err = NULL;
75 *diff_offsets = calloc(1, sizeof(**diff_offsets));
76 if (*diff_offsets == NULL)
77 return got_error_from_errno();
79 (*diff_offsets)->commit_id = got_object_id_dup(commit_id);
80 if ((*diff_offsets)->commit_id == NULL) {
81 err = got_error_from_errno();
82 free_diff_offsets(*diff_offsets);
83 *diff_offsets = NULL;
84 return err;
85 }
87 err = got_diffoffset_alloc(&(*diff_offsets)->chunks);
88 if (err) {
89 free_diff_offsets(*diff_offsets);
90 return err;
91 }
93 return NULL;
94 }
96 static const struct got_error *
97 annotate_line(struct got_blame *blame, int lineno, struct got_object_id *id,
98 const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
99 void *arg)
101 const struct got_error *err = NULL;
102 struct got_blame_line *line;
104 if (lineno < 1 || lineno > blame->nlines)
105 return got_error(GOT_ERR_RANGE);
107 line = &blame->lines[lineno - 1];
108 if (line->annotated)
109 return NULL;
111 memcpy(&line->id, id, sizeof(line->id));
112 line->annotated = 1;
113 if (cb)
114 err = cb(arg, blame->nlines, lineno, id);
115 return err;
118 static int
119 get_blamed_line(struct got_blame_diff_offsets_list *diff_offsets_list,
120 int lineno)
122 struct got_blame_diff_offsets *diff_offsets;
124 SLIST_FOREACH(diff_offsets, diff_offsets_list, entry)
125 lineno = got_diffoffset_get(diff_offsets->chunks, lineno);
127 return lineno;
130 static const struct got_error *
131 blame_changes(struct got_blame *blame, struct got_diff_changes *changes,
132 struct got_object_id *commit_id,
133 const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
134 void *arg)
136 const struct got_error *err = NULL;
137 struct got_diff_change *change;
138 struct got_blame_diff_offsets *diff_offsets;
140 SIMPLEQ_FOREACH(change, &changes->entries, entry) {
141 int c = change->cv.c;
142 int d = change->cv.d;
143 int new_lineno = c;
144 int new_length = (c < d ? d - c + 1 : (c == d ? 1 : 0));
145 int ln;
147 for (ln = new_lineno; ln < new_lineno + new_length; ln++) {
148 err = annotate_line(blame,
149 get_blamed_line(&blame->diff_offsets_list, ln),
150 commit_id, cb, arg);
151 if (err)
152 return err;
156 err = alloc_diff_offsets(&diff_offsets, commit_id);
157 if (err)
158 return err;
159 SIMPLEQ_FOREACH(change, &changes->entries, entry) {
160 int a = change->cv.a;
161 int b = change->cv.b;
162 int c = change->cv.c;
163 int d = change->cv.d;
164 int old_lineno = a;
165 int old_length = (a < b ? b - a + 1 : (a == b ? 1 : 0));
166 int new_lineno = c;
167 int new_length = (c < d ? d - c + 1 : (c == d ? 1 : 0));
169 err = got_diffoffset_add(diff_offsets->chunks,
170 old_lineno, old_length, new_lineno, new_length);
171 if (err) {
172 free_diff_offsets(diff_offsets);
173 return err;
176 SLIST_INSERT_HEAD(&blame->diff_offsets_list, diff_offsets, entry);
178 return NULL;
181 static const struct got_error *
182 blame_commit(struct got_blame *blame, struct got_object_id *id,
183 struct got_object_id *pid, const char *path, struct got_repository *repo,
184 const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
185 void *arg)
187 const struct got_error *err = NULL;
188 struct got_object *obj = NULL, *pobj = NULL;
189 struct got_object_id *obj_id = NULL, *pobj_id = NULL;
190 struct got_blob_object *blob = NULL, *pblob = NULL;
191 struct got_diff_changes *changes = NULL;
193 err = got_object_id_by_path(&obj_id, repo, id, path);
194 if (err)
195 goto done;
197 err = got_object_open(&obj, repo, obj_id);
198 if (err)
199 goto done;
201 if (got_object_get_type(obj) != GOT_OBJ_TYPE_BLOB) {
202 err = got_error(GOT_ERR_OBJ_TYPE);
203 goto done;
206 err = got_object_id_by_path(&pobj_id, repo, pid, path);
207 if (err) {
208 if (err->code == GOT_ERR_NO_OBJ) {
209 /* Blob's history began in previous commit. */
210 err = got_error(GOT_ERR_ITER_COMPLETED);
212 goto done;
215 /* If IDs match then don't bother with diffing. */
216 if (got_object_id_cmp(obj_id, pobj_id) == 0) {
217 if (cb)
218 err = cb(arg, blame->nlines, -1, id);
219 goto done;
222 err = got_object_open(&pobj, repo, pobj_id);
223 if (err)
224 goto done;
226 if (got_object_get_type(pobj) != GOT_OBJ_TYPE_BLOB) {
227 /*
228 * Encountered a non-blob at the path (probably a tree).
229 * Blob's history began in previous commit.
230 */
231 err = got_error(GOT_ERR_ITER_COMPLETED);
232 goto done;
235 err = got_object_blob_open(&blob, repo, obj, 8192);
236 if (err)
237 goto done;
239 err = got_object_blob_open(&pblob, repo, pobj, 8192);
240 if (err)
241 goto done;
243 err = got_diff_blob_lines_changed(&changes, pblob, blob);
244 if (err)
245 goto done;
247 if (changes) {
248 err = blame_changes(blame, changes, id, cb, arg);
249 got_diff_free_changes(changes);
250 } else if (cb)
251 err = cb(arg, blame->nlines, -1, id);
252 done:
253 free(obj_id);
254 free(pobj_id);
255 if (obj)
256 got_object_close(obj);
257 if (pobj)
258 got_object_close(pobj);
259 if (blob)
260 got_object_blob_close(blob);
261 if (pblob)
262 got_object_blob_close(pblob);
263 return err;
266 static void
267 blame_close(struct got_blame *blame)
269 struct got_blame_diff_offsets *diff_offsets;
271 if (blame->f)
272 fclose(blame->f);
273 free(blame->lines);
274 while (!SLIST_EMPTY(&blame->diff_offsets_list)) {
275 diff_offsets = SLIST_FIRST(&blame->diff_offsets_list);
276 SLIST_REMOVE_HEAD(&blame->diff_offsets_list, entry);
277 free_diff_offsets(diff_offsets);
279 free(blame);
282 static const struct got_error *
283 blame_open(struct got_blame **blamep, const char *path,
284 struct got_object_id *start_commit_id, struct got_repository *repo,
285 const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
286 void *arg)
288 const struct got_error *err = NULL;
289 struct got_object *obj = NULL;
290 struct got_object_id *obj_id = NULL;
291 struct got_blob_object *blob = NULL;
292 struct got_blame *blame = NULL;
293 struct got_commit_object *commit = NULL;
294 struct got_object_id *id = NULL;
295 int lineno;
297 *blamep = NULL;
299 err = got_object_id_by_path(&obj_id, repo, start_commit_id, path);
300 if (err)
301 return err;
303 err = got_object_open(&obj, repo, obj_id);
304 if (err)
305 goto done;
307 if (got_object_get_type(obj) != GOT_OBJ_TYPE_BLOB) {
308 err = got_error(GOT_ERR_OBJ_TYPE);
309 goto done;
312 err = got_object_blob_open(&blob, repo, obj, 8192);
313 if (err)
314 goto done;
316 blame = calloc(1, sizeof(*blame));
317 if (blame == NULL)
318 return got_error_from_errno();
320 blame->f = got_opentemp();
321 if (blame->f == NULL) {
322 err = got_error_from_errno();
323 goto done;
325 err = got_object_blob_dump_to_file(NULL, &blame->nlines, blame->f,
326 blob);
327 if (err)
328 goto done;
330 blame->lines = calloc(blame->nlines, sizeof(*blame->lines));
331 if (blame->lines == NULL) {
332 err = got_error_from_errno();
333 goto done;
336 /* Loop over first-parent history and try to blame commits. */
337 err = got_object_open_as_commit(&commit, repo, start_commit_id);
338 if (err)
339 goto done;
340 id = got_object_id_dup(start_commit_id);
341 if (id == NULL) {
342 err = got_error_from_errno();
343 goto done;
345 while (1) {
346 struct got_object_qid *pid;
348 pid = SIMPLEQ_FIRST(&commit->parent_ids);
349 if (pid == NULL)
350 break;
352 err = blame_commit(blame, id, pid->id, path, repo, cb, arg);
353 if (err) {
354 if (err->code == GOT_ERR_ITER_COMPLETED)
355 err = NULL;
356 break;
359 free(id);
360 id = got_object_id_dup(pid->id);
361 if (id == NULL) {
362 err = got_error_from_errno();
363 goto done;
365 got_object_commit_close(commit);
366 err = got_object_open_as_commit(&commit, repo, id);
367 if (err)
368 goto done;
371 /* Annotate remaining non-annotated lines with last commit. */
372 for (lineno = 1; lineno <= blame->nlines; lineno++) {
373 err = annotate_line(blame, lineno, id, cb, arg);
374 if (err)
375 goto done;
378 done:
379 free(obj_id);
380 if (obj)
381 got_object_close(obj);
382 if (blob)
383 got_object_blob_close(blob);
384 if (commit)
385 got_object_commit_close(commit);
386 if (err) {
387 if (blame)
388 blame_close(blame);
389 } else
390 *blamep = blame;
392 return err;
395 static const struct got_error *
396 blame_line(struct got_object_id **id, struct got_blame *blame, int lineno)
398 if (lineno < 1 || lineno > blame->nlines)
399 return got_error(GOT_ERR_RANGE);
400 *id = &blame->lines[lineno - 1].id;
401 return NULL;
404 static char *
405 parse_next_line(FILE *f, size_t *len)
407 char *line;
408 size_t linelen;
409 size_t lineno;
410 const char delim[3] = { '\0', '\0', '\0'};
412 line = fparseln(f, &linelen, &lineno, delim, 0);
413 if (len)
414 *len = linelen;
415 return line;
418 const struct got_error *
419 got_blame(const char *path, struct got_object_id *start_commit_id,
420 struct got_repository *repo, FILE *outfile)
422 const struct got_error *err = NULL;
423 struct got_blame *blame;
424 int lineno;
425 char *abspath;
427 if (asprintf(&abspath, "%s%s", path[0] == '/' ? "" : "/", path) == -1)
428 return got_error_from_errno();
430 err = blame_open(&blame, abspath, start_commit_id, repo, NULL, NULL);
431 if (err) {
432 free(abspath);
433 return err;
436 for (lineno = 1; lineno <= blame->nlines; lineno++) {
437 struct got_object_id *id;
438 char *line, *id_str;
440 line = parse_next_line(blame->f, NULL);
441 if (line == NULL)
442 break;
444 err = blame_line(&id, blame, lineno);
445 if (err) {
446 free(line);
447 break;
450 err = got_object_id_str(&id_str, id);
451 /* Do not free id; It points into blame->lines. */
452 if (err) {
453 free(line);
454 break;
457 fprintf(outfile, "%.8s %s\n", id_str, line);
458 free(line);
459 free(id_str);
462 blame_close(blame);
463 free(abspath);
464 return err;
467 const struct got_error *
468 got_blame_incremental(const char *path, struct got_object_id *commit_id,
469 struct got_repository *repo,
470 const struct got_error *(*cb)(void *, int, int, struct got_object_id *),
471 void *arg)
473 const struct got_error *err = NULL;
474 struct got_blame *blame;
475 char *abspath;
477 if (asprintf(&abspath, "%s%s", path[0] == '/' ? "" : "/", path) == -1)
478 return got_error_from_errno();
480 err = blame_open(&blame, abspath, commit_id, repo, cb, arg);
481 free(abspath);
482 if (blame)
483 blame_close(blame);
484 return err;