Merge branch 'ls/hint-rev-list-count'
[git] / builtin / prune.c
1 #include "cache.h"
2 #include "commit.h"
3 #include "diff.h"
4 #include "revision.h"
5 #include "builtin.h"
6 #include "reachable.h"
7 #include "parse-options.h"
8 #include "progress.h"
9 #include "dir.h"
10
11 static const char * const prune_usage[] = {
12         N_("git prune [-n] [-v] [--expire <time>] [--] [<head>...]"),
13         NULL
14 };
15 static int show_only;
16 static int verbose;
17 static unsigned long expire;
18 static int show_progress = -1;
19
20 static int prune_tmp_file(const char *fullpath)
21 {
22         struct stat st;
23         if (lstat(fullpath, &st))
24                 return error("Could not stat '%s'", fullpath);
25         if (st.st_mtime > expire)
26                 return 0;
27         if (show_only || verbose)
28                 printf("Removing stale temporary file %s\n", fullpath);
29         if (!show_only)
30                 unlink_or_warn(fullpath);
31         return 0;
32 }
33
34 static int prune_object(const unsigned char *sha1, const char *fullpath,
35                         void *data)
36 {
37         struct stat st;
38
39         /*
40          * Do we know about this object?
41          * It must have been reachable
42          */
43         if (lookup_object(sha1))
44                 return 0;
45
46         if (lstat(fullpath, &st)) {
47                 /* report errors, but do not stop pruning */
48                 error("Could not stat '%s'", fullpath);
49                 return 0;
50         }
51         if (st.st_mtime > expire)
52                 return 0;
53         if (show_only || verbose) {
54                 enum object_type type = sha1_object_info(sha1, NULL);
55                 printf("%s %s\n", sha1_to_hex(sha1),
56                        (type > 0) ? typename(type) : "unknown");
57         }
58         if (!show_only)
59                 unlink_or_warn(fullpath);
60         return 0;
61 }
62
63 static int prune_cruft(const char *basename, const char *path, void *data)
64 {
65         if (starts_with(basename, "tmp_obj_"))
66                 prune_tmp_file(path);
67         else
68                 fprintf(stderr, "bad sha1 file: %s\n", path);
69         return 0;
70 }
71
72 static int prune_subdir(int nr, const char *path, void *data)
73 {
74         if (!show_only)
75                 rmdir(path);
76         return 0;
77 }
78
79 static int prune_worktree(const char *id, struct strbuf *reason)
80 {
81         struct stat st;
82         char *path;
83         int fd, len;
84
85         if (!is_directory(git_path("worktrees/%s", id))) {
86                 strbuf_addf(reason, _("Removing worktrees/%s: not a valid directory"), id);
87                 return 1;
88         }
89         if (file_exists(git_path("worktrees/%s/locked", id)))
90                 return 0;
91         if (stat(git_path("worktrees/%s/gitdir", id), &st)) {
92                 strbuf_addf(reason, _("Removing worktrees/%s: gitdir file does not exist"), id);
93                 return 1;
94         }
95         fd = open(git_path("worktrees/%s/gitdir", id), O_RDONLY);
96         if (fd < 0) {
97                 strbuf_addf(reason, _("Removing worktrees/%s: unable to read gitdir file (%s)"),
98                             id, strerror(errno));
99                 return 1;
100         }
101         len = st.st_size;
102         path = xmalloc(len + 1);
103         read_in_full(fd, path, len);
104         close(fd);
105         while (len && (path[len - 1] == '\n' || path[len - 1] == '\r'))
106                 len--;
107         if (!len) {
108                 strbuf_addf(reason, _("Removing worktrees/%s: invalid gitdir file"), id);
109                 free(path);
110                 return 1;
111         }
112         path[len] = '\0';
113         if (!file_exists(path)) {
114                 struct stat st_link;
115                 free(path);
116                 /*
117                  * the repo is moved manually and has not been
118                  * accessed since?
119                  */
120                 if (!stat(git_path("worktrees/%s/link", id), &st_link) &&
121                     st_link.st_nlink > 1)
122                         return 0;
123                 if (st.st_mtime <= expire) {
124                         strbuf_addf(reason, _("Removing worktrees/%s: gitdir file points to non-existent location"), id);
125                         return 1;
126                 } else {
127                         return 0;
128                 }
129         }
130         free(path);
131         return 0;
132 }
133
134 static void prune_worktrees(void)
135 {
136         struct strbuf reason = STRBUF_INIT;
137         struct strbuf path = STRBUF_INIT;
138         DIR *dir = opendir(git_path("worktrees"));
139         struct dirent *d;
140         int ret;
141         if (!dir)
142                 return;
143         while ((d = readdir(dir)) != NULL) {
144                 if (!strcmp(d->d_name, ".") || !strcmp(d->d_name, ".."))
145                         continue;
146                 strbuf_reset(&reason);
147                 if (!prune_worktree(d->d_name, &reason))
148                         continue;
149                 if (show_only || verbose)
150                         printf("%s\n", reason.buf);
151                 if (show_only)
152                         continue;
153                 strbuf_reset(&path);
154                 strbuf_addstr(&path, git_path("worktrees/%s", d->d_name));
155                 ret = remove_dir_recursively(&path, 0);
156                 if (ret < 0 && errno == ENOTDIR)
157                         ret = unlink(path.buf);
158                 if (ret)
159                         error(_("failed to remove: %s"), strerror(errno));
160         }
161         closedir(dir);
162         if (!show_only)
163                 rmdir(git_path("worktrees"));
164         strbuf_release(&reason);
165         strbuf_release(&path);
166 }
167
168 /*
169  * Write errors (particularly out of space) can result in
170  * failed temporary packs (and more rarely indexes and other
171  * files beginning with "tmp_") accumulating in the object
172  * and the pack directories.
173  */
174 static void remove_temporary_files(const char *path)
175 {
176         DIR *dir;
177         struct dirent *de;
178
179         dir = opendir(path);
180         if (!dir) {
181                 fprintf(stderr, "Unable to open directory %s\n", path);
182                 return;
183         }
184         while ((de = readdir(dir)) != NULL)
185                 if (starts_with(de->d_name, "tmp_"))
186                         prune_tmp_file(mkpath("%s/%s", path, de->d_name));
187         closedir(dir);
188 }
189
190 int cmd_prune(int argc, const char **argv, const char *prefix)
191 {
192         struct rev_info revs;
193         struct progress *progress = NULL;
194         int do_prune_worktrees = 0;
195         const struct option options[] = {
196                 OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
197                 OPT__VERBOSE(&verbose, N_("report pruned objects")),
198                 OPT_BOOL(0, "progress", &show_progress, N_("show progress")),
199                 OPT_BOOL(0, "worktrees", &do_prune_worktrees, N_("prune .git/worktrees")),
200                 OPT_EXPIRY_DATE(0, "expire", &expire,
201                                 N_("expire objects older than <time>")),
202                 OPT_END()
203         };
204         char *s;
205
206         expire = ULONG_MAX;
207         save_commit_buffer = 0;
208         check_replace_refs = 0;
209         ref_paranoia = 1;
210         init_revisions(&revs, prefix);
211
212         argc = parse_options(argc, argv, prefix, options, prune_usage, 0);
213
214         if (do_prune_worktrees) {
215                 if (argc)
216                         die(_("--worktrees does not take extra arguments"));
217                 prune_worktrees();
218                 return 0;
219         }
220
221         while (argc--) {
222                 unsigned char sha1[20];
223                 const char *name = *argv++;
224
225                 if (!get_sha1(name, sha1)) {
226                         struct object *object = parse_object_or_die(sha1, name);
227                         add_pending_object(&revs, object, "");
228                 }
229                 else
230                         die("unrecognized argument: %s", name);
231         }
232
233         if (show_progress == -1)
234                 show_progress = isatty(2);
235         if (show_progress)
236                 progress = start_progress_delay(_("Checking connectivity"), 0, 0, 2);
237
238         mark_reachable_objects(&revs, 1, expire, progress);
239         stop_progress(&progress);
240         for_each_loose_file_in_objdir(get_object_directory(), prune_object,
241                                       prune_cruft, prune_subdir, NULL);
242
243         prune_packed_objects(show_only ? PRUNE_PACKED_DRY_RUN : 0);
244         remove_temporary_files(get_object_directory());
245         s = mkpathdup("%s/pack", get_object_directory());
246         remove_temporary_files(s);
247         free(s);
248
249         if (is_repository_shallow())
250                 prune_shallow(show_only);
251
252         return 0;
253 }