checkout-index.c

   1 /*
   2  * Check-out files from the "current cache directory"
   3  *
   4  * Copyright (C) 2005 Linus Torvalds
   5  *
   6  * Careful: order of argument flags does matter. For example,
   7  *
   8  *      git-checkout-index -a -f file.c
   9  *
  10  * Will first check out all files listed in the cache (but not
  11  * overwrite any old ones), and then force-checkout "file.c" a
  12  * second time (ie that one _will_ overwrite any old contents
  13  * with the same filename).
  14  *
  15  * Also, just doing "git-checkout-index" does nothing. You probably
  16  * meant "git-checkout-index -a". And if you want to force it, you
  17  * want "git-checkout-index -f -a".
  18  *
  19  * Intuitiveness is not the goal here. Repeatability is. The
  20  * reason for the "no arguments means no work" thing is that
  21  * from scripts you are supposed to be able to do things like
  22  *
  23  *      find . -name '*.h' -print0 | xargs -0 git-checkout-index -f --
  24  *
  25  * or:
  26  *
  27  *      find . -name '*.h' -print0 | git-checkout-index -f -z --stdin
  28  *
  29  * which will force all existing *.h files to be replaced with
  30  * their cached copies. If an empty command line implied "all",
  31  * then this would force-refresh everything in the cache, which
  32  * was not the point.
  33  *
  34  * Oh, and the "--" is just a good idea when you know the rest
  35  * will be filenames. Just so that you wouldn't have a filename
  36  * of "-a" causing problems (not possible in the above example,
  37  * but get used to it in scripting!).
  38  */
  39 #include "cache.h"
  40 #include "strbuf.h"
  41 #include "quote.h"
  42 #include "cache-tree.h"
  43
  44 #define CHECKOUT_ALL 4
  45 static const char *prefix;
  46 static int prefix_length;
  47 static int line_termination = '\n';
  48 static int checkout_stage; /* default to checkout stage0 */
  49 static int to_tempfile;
  50 static char topath[4][MAXPATHLEN+1];
  51
  52 static struct checkout state = {
  53         .base_dir = "",
  54         .base_dir_len = 0,
  55         .force = 0,
  56         .quiet = 0,
  57         .not_new = 0,
  58         .refresh_cache = 0,
  59 };
  60
  61 static void write_tempfile_record (const char *name)
  62 {
  63         int i;
  64
  65         if (CHECKOUT_ALL == checkout_stage) {
  66                 for (i = 1; i < 4; i++) {
  67                         if (i > 1)
  68                                 putchar(' ');
  69                         if (topath[i][0])
  70                                 fputs(topath[i], stdout);
  71                         else
  72                                 putchar('.');
  73                 }
  74         } else
  75                 fputs(topath[checkout_stage], stdout);
  76
  77         putchar('\t');
  78         write_name_quoted("", 0, name + prefix_length,
  79                 line_termination, stdout);
  80         putchar(line_termination);
  81
  82         for (i = 0; i < 4; i++) {
  83                 topath[i][0] = 0;
  84         }
  85 }
  86
  87 static int checkout_file(const char *name)
  88 {
  89         int namelen = strlen(name);
  90         int pos = cache_name_pos(name, namelen);
  91         int has_same_name = 0;
  92         int did_checkout = 0;
  93         int errs = 0;
  94
  95         if (pos < 0)
  96                 pos = -pos - 1;
  97
  98         while (pos < active_nr) {
  99                 struct cache_entry *ce = active_cache[pos];
 100                 if (ce_namelen(ce) != namelen ||
 101                     memcmp(ce->name, name, namelen))
 102                         break;
 103                 has_same_name = 1;
 104                 pos++;
 105                 if (ce_stage(ce) != checkout_stage
 106                     && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
 107                         continue;
 108                 did_checkout = 1;
 109                 if (checkout_entry(ce, &state,
 110                     to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
 111                         errs++;
 112         }
 113
 114         if (did_checkout) {
 115                 if (to_tempfile)
 116                         write_tempfile_record(name);
 117                 return errs > 0 ? -1 : 0;
 118         }
 119
 120         if (!state.quiet) {
 121                 fprintf(stderr, "git-checkout-index: %s ", name);
 122                 if (!has_same_name)
 123                         fprintf(stderr, "is not in the cache");
 124                 else if (checkout_stage)
 125                         fprintf(stderr, "does not exist at stage %d",
 126                                 checkout_stage);
 127                 else
 128                         fprintf(stderr, "is unmerged");
 129                 fputc('\n', stderr);
 130         }
 131         return -1;
 132 }
 133
 134 static int checkout_all(void)
 135 {
 136         int i, errs = 0;
 137         struct cache_entry* last_ce = NULL;
 138
 139         for (i = 0; i < active_nr ; i++) {
 140                 struct cache_entry *ce = active_cache[i];
 141                 if (ce_stage(ce) != checkout_stage
 142                     && (CHECKOUT_ALL != checkout_stage || !ce_stage(ce)))
 143                         continue;
 144                 if (prefix && *prefix &&
 145                     (ce_namelen(ce) <= prefix_length ||
 146                      memcmp(prefix, ce->name, prefix_length)))
 147                         continue;
 148                 if (last_ce && to_tempfile) {
 149                         if (ce_namelen(last_ce) != ce_namelen(ce)
 150                             || memcmp(last_ce->name, ce->name, ce_namelen(ce)))
 151                                 write_tempfile_record(last_ce->name);
 152                 }
 153                 if (checkout_entry(ce, &state,
 154                     to_tempfile ? topath[ce_stage(ce)] : NULL) < 0)
 155                         errs++;
 156                 last_ce = ce;
 157         }
 158         if (last_ce && to_tempfile)
 159                 write_tempfile_record(last_ce->name);
 160         if (errs)
 161                 /* we have already done our error reporting.
 162                  * exit with the same code as die().
 163                  */
 164                 exit(128);
 165         return 0;
 166 }
 167
 168 static const char checkout_cache_usage[] =
 169 "git-checkout-index [-u] [-q] [-a] [-f] [-n] [--stage=[123]|all] [--prefix=<string>] [--temp] [--] <file>...";
 170
 171 static struct lock_file lock_file;
 172
 173 int main(int argc, char **argv)
 174 {
 175         int i;
 176         int newfd = -1;
 177         int all = 0;
 178         int read_from_stdin = 0;
 179
 180         prefix = setup_git_directory();
 181         git_config(git_default_config);
 182         prefix_length = prefix ? strlen(prefix) : 0;
 183
 184         if (read_cache() < 0) {
 185                 die("invalid cache");
 186         }
 187
 188         for (i = 1; i < argc; i++) {
 189                 const char *arg = argv[i];
 190
 191                 if (!strcmp(arg, "--")) {
 192                         i++;
 193                         break;
 194                 }
 195                 if (!strcmp(arg, "-a") || !strcmp(arg, "--all")) {
 196                         all = 1;
 197                         continue;
 198                 }
 199                 if (!strcmp(arg, "-f") || !strcmp(arg, "--force")) {
 200                         state.force = 1;
 201                         continue;
 202                 }
 203                 if (!strcmp(arg, "-q") || !strcmp(arg, "--quiet")) {
 204                         state.quiet = 1;
 205                         continue;
 206                 }
 207                 if (!strcmp(arg, "-n") || !strcmp(arg, "--no-create")) {
 208                         state.not_new = 1;
 209                         continue;
 210                 }
 211                 if (!strcmp(arg, "-u") || !strcmp(arg, "--index")) {
 212                         state.refresh_cache = 1;
 213                         if (newfd < 0)
 214                                 newfd = hold_lock_file_for_update
 215                                         (&lock_file, get_index_file());
 216                         if (newfd < 0)
 217                                 die("cannot open index.lock file.");
 218                         continue;
 219                 }
 220                 if (!strcmp(arg, "-z")) {
 221                         line_termination = 0;
 222                         continue;
 223                 }
 224                 if (!strcmp(arg, "--stdin")) {
 225                         if (i != argc - 1)
 226                                 die("--stdin must be at the end");
 227                         read_from_stdin = 1;
 228                         i++; /* do not consider arg as a file name */
 229                         break;
 230                 }
 231                 if (!strcmp(arg, "--temp")) {
 232                         to_tempfile = 1;
 233                         continue;
 234                 }
 235                 if (!strncmp(arg, "--prefix=", 9)) {
 236                         state.base_dir = arg+9;
 237                         state.base_dir_len = strlen(state.base_dir);
 238                         continue;
 239                 }
 240                 if (!strncmp(arg, "--stage=", 8)) {
 241                         if (!strcmp(arg + 8, "all")) {
 242                                 to_tempfile = 1;
 243                                 checkout_stage = CHECKOUT_ALL;
 244                         } else {
 245                                 int ch = arg[8];
 246                                 if ('1' <= ch && ch <= '3')
 247                                         checkout_stage = arg[8] - '0';
 248                                 else
 249                                         die("stage should be between 1 and 3 or all");
 250                         }
 251                         continue;
 252                 }
 253                 if (arg[0] == '-')
 254                         usage(checkout_cache_usage);
 255                 break;
 256         }
 257
 258         if (state.base_dir_len || to_tempfile) {
 259                 /* when --prefix is specified we do not
 260                  * want to update cache.
 261                  */
 262                 if (state.refresh_cache) {
 263                         close(newfd); newfd = -1;
 264                         rollback_lock_file(&lock_file);
 265                 }
 266                 state.refresh_cache = 0;
 267         }
 268
 269         /* Check out named files first */
 270         for ( ; i < argc; i++) {
 271                 const char *arg = argv[i];
 272                 const char *p;
 273
 274                 if (all)
 275                         die("git-checkout-index: don't mix '--all' and explicit filenames");
 276                 if (read_from_stdin)
 277                         die("git-checkout-index: don't mix '--stdin' and explicit filenames");
 278                 p = prefix_path(prefix, prefix_length, arg);
 279                 checkout_file(p);
 280                 if (p < arg || p > arg + strlen(arg))
 281                         free((char*)p);
 282         }
 283
 284         if (read_from_stdin) {
 285                 struct strbuf buf;
 286                 if (all)
 287                         die("git-checkout-index: don't mix '--all' and '--stdin'");
 288                 strbuf_init(&buf);
 289                 while (1) {
 290                         char *path_name;
 291                         const char *p;
 292
 293                         read_line(&buf, stdin, line_termination);
 294                         if (buf.eof)
 295                                 break;
 296                         if (line_termination && buf.buf[0] == '"')
 297                                 path_name = unquote_c_style(buf.buf, NULL);
 298                         else
 299                                 path_name = buf.buf;
 300                         p = prefix_path(prefix, prefix_length, path_name);
 301                         checkout_file(p);
 302                         if (p < path_name || p > path_name + strlen(path_name))
 303                                 free((char *)p);
 304                         if (path_name != buf.buf)
 305                                 free(path_name);
 306                 }
 307         }
 308
 309         if (all)
 310                 checkout_all();
 311
 312         if (0 <= newfd &&
 313             (write_cache(newfd, active_cache, active_nr) ||
 314              close(newfd) || commit_lock_file(&lock_file)))
 315                 die("Unable to write new index file");
 316         return 0;
 317 }