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                 strbuf_addf(reason, _("Removing worktrees/%s: gitdir file points to non-existent location"), id);
 124                 return 1;
 125         }
 126         free(path);
 127         return st.st_mtime <= expire;
 128 }
 129
 130 static void prune_worktrees(void)
 131 {
 132         struct strbuf reason = STRBUF_INIT;
 133         struct strbuf path = STRBUF_INIT;
 134         DIR *dir = opendir(git_path("worktrees"));
 135         struct dirent *d;
 136         int ret;
 137         if (!dir)
 138                 return;
 139         while ((d = readdir(dir)) != NULL) {
 140                 if (!strcmp(d->d_name, ".") || !strcmp(d->d_name, ".."))
 141                         continue;
 142                 strbuf_reset(&reason);
 143                 if (!prune_worktree(d->d_name, &reason))
 144                         continue;
 145                 if (show_only || verbose)
 146                         printf("%s\n", reason.buf);
 147                 if (show_only)
 148                         continue;
 149                 strbuf_reset(&path);
 150                 strbuf_addstr(&path, git_path("worktrees/%s", d->d_name));
 151                 ret = remove_dir_recursively(&path, 0);
 152                 if (ret < 0 && errno == ENOTDIR)
 153                         ret = unlink(path.buf);
 154                 if (ret)
 155                         error(_("failed to remove: %s"), strerror(errno));
 156         }
 157         closedir(dir);
 158         if (!show_only)
 159                 rmdir(git_path("worktrees"));
 160         strbuf_release(&reason);
 161         strbuf_release(&path);
 162 }
 163
 164 /*
 165  * Write errors (particularly out of space) can result in
 166  * failed temporary packs (and more rarely indexes and other
 167  * files beginning with "tmp_") accumulating in the object
 168  * and the pack directories.
 169  */
 170 static void remove_temporary_files(const char *path)
 171 {
 172         DIR *dir;
 173         struct dirent *de;
 174
 175         dir = opendir(path);
 176         if (!dir) {
 177                 fprintf(stderr, "Unable to open directory %s\n", path);
 178                 return;
 179         }
 180         while ((de = readdir(dir)) != NULL)
 181                 if (starts_with(de->d_name, "tmp_"))
 182                         prune_tmp_file(mkpath("%s/%s", path, de->d_name));
 183         closedir(dir);
 184 }
 185
 186 int cmd_prune(int argc, const char **argv, const char *prefix)
 187 {
 188         struct rev_info revs;
 189         struct progress *progress = NULL;
 190         int do_prune_worktrees = 0;
 191         const struct option options[] = {
 192                 OPT__DRY_RUN(&show_only, N_("do not remove, show only")),
 193                 OPT__VERBOSE(&verbose, N_("report pruned objects")),
 194                 OPT_BOOL(0, "progress", &show_progress, N_("show progress")),
 195                 OPT_BOOL(0, "worktrees", &do_prune_worktrees, N_("prune .git/worktrees")),
 196                 OPT_EXPIRY_DATE(0, "expire", &expire,
 197                                 N_("expire objects older than <time>")),
 198                 OPT_END()
 199         };
 200         char *s;
 201
 202         expire = ULONG_MAX;
 203         save_commit_buffer = 0;
 204         check_replace_refs = 0;
 205         init_revisions(&revs, prefix);
 206
 207         argc = parse_options(argc, argv, prefix, options, prune_usage, 0);
 208
 209         if (do_prune_worktrees) {
 210                 if (argc)
 211                         die(_("--worktrees does not take extra arguments"));
 212                 prune_worktrees();
 213                 return 0;
 214         }
 215
 216         while (argc--) {
 217                 unsigned char sha1[20];
 218                 const char *name = *argv++;
 219
 220                 if (!get_sha1(name, sha1)) {
 221                         struct object *object = parse_object_or_die(sha1, name);
 222                         add_pending_object(&revs, object, "");
 223                 }
 224                 else
 225                         die("unrecognized argument: %s", name);
 226         }
 227
 228         if (show_progress == -1)
 229                 show_progress = isatty(2);
 230         if (show_progress)
 231                 progress = start_progress_delay(_("Checking connectivity"), 0, 0, 2);
 232
 233         mark_reachable_objects(&revs, 1, expire, progress);
 234         stop_progress(&progress);
 235         for_each_loose_file_in_objdir(get_object_directory(), prune_object,
 236                                       prune_cruft, prune_subdir, NULL);
 237
 238         prune_packed_objects(show_only ? PRUNE_PACKED_DRY_RUN : 0);
 239         remove_temporary_files(get_object_directory());
 240         s = mkpathdup("%s/pack", get_object_directory());
 241         remove_temporary_files(s);
 242         free(s);
 243
 244         if (is_repository_shallow())
 245                 prune_shallow(show_only);
 246
 247         return 0;
 248 }