src/ln.c

   1 /* `ln' program to create links between files.
   2    Copyright (C) 86, 89, 90, 91, 1995-2003 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software Foundation,
  16    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17 \f
  18 /* Written by Mike Parker and David MacKenzie. */
  19
  20 #include <config.h>
  21 #include <stdio.h>
  22 #include <sys/types.h>
  23 #include <getopt.h>
  24
  25 #include "system.h"
  26 #include "same.h"
  27 #include "backupfile.h"
  28 #include "dirname.h"
  29 #include "error.h"
  30 #include "quote.h"
  31
  32 /* The official name of this program (e.g., no `g' prefix).  */
  33 #define PROGRAM_NAME "ln"
  34
  35 #define AUTHORS "Mike Parker", "David MacKenzie"
  36
  37 #ifndef ENABLE_HARD_LINK_TO_SYMLINK_WARNING
  38 # define ENABLE_HARD_LINK_TO_SYMLINK_WARNING 0
  39 #endif
  40
  41 /* For long options that have no equivalent short option, use a
  42    non-character as a pseudo short option, starting with CHAR_MAX + 1.  */
  43 enum
  44 {
  45   TARGET_DIRECTORY_OPTION = CHAR_MAX + 1
  46 };
  47
  48 int link ();                    /* Some systems don't declare this anywhere. */
  49
  50 #ifdef S_ISLNK
  51 int symlink ();
  52 #endif
  53
  54 /* In being careful not even to try to make hard links to directories,
  55    we have to know whether link(2) follows symlinks.  If it does, then
  56    we have to *stat* the `source' to see if the resulting link would be
  57    to a directory.  Otherwise, we have to use *lstat* so that we allow
  58    users to make hard links to symlinks-that-point-to-directories.  */
  59
  60 #if LINK_FOLLOWS_SYMLINKS
  61 # define STAT_LIKE_LINK(File, Stat_buf) \
  62   stat (File, Stat_buf)
  63 #else
  64 # define STAT_LIKE_LINK(File, Stat_buf) \
  65   lstat (File, Stat_buf)
  66 #endif
  67
  68 /* Construct a string NEW_DEST by concatenating DEST, a slash, and
  69    basename(SOURCE) in alloca'd memory.  Don't modify DEST or SOURCE.  */
  70
  71 #define PATH_BASENAME_CONCAT(new_dest, dest, source)                    \
  72     do                                                                  \
  73       {                                                                 \
  74         const char *source_base;                                        \
  75         char *tmp_source;                                               \
  76                                                                         \
  77         tmp_source = (char *) alloca (strlen ((source)) + 1);           \
  78         strcpy (tmp_source, (source));                                  \
  79         strip_trailing_slashes (tmp_source);                            \
  80         source_base = base_name (tmp_source);                           \
  81                                                                         \
  82         (new_dest) = (char *) alloca (strlen ((dest)) + 1               \
  83                                       + strlen (source_base) + 1);      \
  84         stpcpy (stpcpy (stpcpy ((new_dest), (dest)), "/"), source_base);\
  85       }                                                                 \
  86     while (0)
  87
  88 int isdir ();
  89 int yesno ();
  90
  91 /* The name by which the program was run, for error messages.  */
  92 char *program_name;
  93
  94 /* FIXME: document */
  95 enum backup_type backup_type;
  96
  97 /* A pointer to the function used to make links.  This will point to either
  98    `link' or `symlink'. */
  99 static int (*linkfunc) ();
 100
 101 /* If nonzero, make symbolic links; otherwise, make hard links.  */
 102 static int symbolic_link;
 103
 104 /* If nonzero, ask the user before removing existing files.  */
 105 static int interactive;
 106
 107 /* If nonzero, remove existing files unconditionally.  */
 108 static int remove_existing_files;
 109
 110 /* If nonzero, list each file as it is moved. */
 111 static int verbose;
 112
 113 /* If nonzero, allow the superuser to make hard links to directories. */
 114 static int hard_dir_link;
 115
 116 /* If nonzero, and the specified destination is a symbolic link to a
 117    directory, treat it just as if it were a directory.  Otherwise, the
 118    command `ln --force --no-dereference file symlink-to-dir' deletes
 119    symlink-to-dir before creating the new link.  */
 120 static int dereference_dest_dir_symlinks = 1;
 121
 122 static struct option const long_options[] =
 123 {
 124   {"backup", optional_argument, NULL, 'b'},
 125   {"directory", no_argument, NULL, 'F'},
 126   {"no-dereference", no_argument, NULL, 'n'},
 127   {"force", no_argument, NULL, 'f'},
 128   {"interactive", no_argument, NULL, 'i'},
 129   {"suffix", required_argument, NULL, 'S'},
 130   {"target-directory", required_argument, NULL, TARGET_DIRECTORY_OPTION},
 131   {"symbolic", no_argument, NULL, 's'},
 132   {"verbose", no_argument, NULL, 'v'},
 133   {"version-control", required_argument, NULL, 'V'}, /* Deprecated. FIXME. */
 134   {GETOPT_HELP_OPTION_DECL},
 135   {GETOPT_VERSION_OPTION_DECL},
 136   {NULL, 0, NULL, 0}
 137 };
 138
 139 /* Make a link DEST to the (usually) existing file SOURCE.
 140    Symbolic links to nonexistent files are allowed.
 141    If DEST is a directory, put the link to SOURCE in that directory.
 142    Return 1 if there is an error, otherwise 0.  */
 143
 144 static int
 145 do_link (const char *source, const char *dest)
 146 {
 147   struct stat source_stats;
 148   struct stat dest_stats;
 149   char *dest_backup = NULL;
 150   int lstat_status;
 151   int backup_succeeded = 0;
 152
 153   /* Use stat here instead of lstat.
 154      On SVR4, link does not follow symlinks, so this check disallows
 155      making hard links to symlinks that point to directories.  Big deal.
 156      On other systems, link follows symlinks, so this check is right.  */
 157   if (!symbolic_link)
 158     {
 159       if (STAT_LIKE_LINK (source, &source_stats) != 0)
 160         {
 161           error (0, errno, _("accessing %s"), quote (source));
 162           return 1;
 163         }
 164
 165       if (ENABLE_HARD_LINK_TO_SYMLINK_WARNING
 166           && S_ISLNK (source_stats.st_mode))
 167         {
 168           error (0, 0, _("%s: warning: making a hard link to a symbolic link\
 169  is not portable"),
 170                  quote (source));
 171         }
 172
 173       if (!hard_dir_link && S_ISDIR (source_stats.st_mode))
 174         {
 175           error (0, 0, _("%s: hard link not allowed for directory"),
 176                  quote (source));
 177           return 1;
 178         }
 179     }
 180
 181   lstat_status = lstat (dest, &dest_stats);
 182   if (lstat_status != 0 && errno != ENOENT)
 183     {
 184       error (0, errno, _("accessing %s"), quote (dest));
 185       return 1;
 186     }
 187
 188   /* If the destination is a directory or (it is a symlink to a directory
 189      and the user has not specified --no-dereference), then form the
 190      actual destination name by appending base_name (source) to the
 191      specified destination directory.  */
 192   if ((lstat_status == 0
 193        && S_ISDIR (dest_stats.st_mode))
 194 #ifdef S_ISLNK
 195       || (dereference_dest_dir_symlinks
 196           && (lstat_status == 0
 197               && S_ISLNK (dest_stats.st_mode)
 198               && isdir (dest)))
 199 #endif
 200      )
 201     {
 202       /* Target is a directory; build the full filename. */
 203       char *new_dest;
 204       PATH_BASENAME_CONCAT (new_dest, dest, source);
 205       dest = new_dest;
 206
 207       /* Get stats for new DEST.  */
 208       lstat_status = lstat (dest, &dest_stats);
 209       if (lstat_status != 0 && errno != ENOENT)
 210         {
 211           error (0, errno, _("accessing %s"), quote (dest));
 212           return 1;
 213         }
 214     }
 215
 216   /* If --force (-f) has been specified without --backup, then before
 217      making a link ln must remove the destination file if it exists.
 218      (with --backup, it just renames any existing destination file)
 219      But if the source and destination are the same, don't remove
 220      anything and fail right here.  */
 221   if (remove_existing_files
 222       && lstat_status == 0
 223       /* Allow `ln -sf --backup k k' to succeed in creating the
 224          self-referential symlink, but don't allow the hard-linking
 225          equivalent: `ln -f k k' (with or without --backup) to get
 226          beyond this point, because the error message you'd get is
 227          misleading.  */
 228       && (backup_type == none || !symbolic_link)
 229       && (!symbolic_link || stat (source, &source_stats) == 0)
 230       && SAME_INODE (source_stats, dest_stats)
 231       /* The following detects whether removing DEST will also remove
 232          SOURCE.  If the file has only one link then both are surely
 233          the same link.  Otherwise check whether they point to the same
 234          name in the same directory.  */
 235       && (source_stats.st_nlink == 1 || same_name (source, dest)))
 236     {
 237       error (0, 0, _("%s and %s are the same file"),
 238              quote_n (0, source), quote_n (1, dest));
 239       return 1;
 240     }
 241
 242   if (lstat_status == 0 || lstat (dest, &dest_stats) == 0)
 243     {
 244       if (S_ISDIR (dest_stats.st_mode))
 245         {
 246           error (0, 0, _("%s: cannot overwrite directory"), quote (dest));
 247           return 1;
 248         }
 249       if (interactive)
 250         {
 251           fprintf (stderr, _("%s: replace %s? "), program_name, quote (dest));
 252           if (!yesno ())
 253             return 0;
 254         }
 255       else if (!remove_existing_files && backup_type == none)
 256         {
 257           error (0, 0, _("%s: File exists"), quote (dest));
 258           return 1;
 259         }
 260
 261       if (backup_type != none)
 262         {
 263           char *tmp_backup = find_backup_file_name (dest, backup_type);
 264           if (tmp_backup == NULL)
 265             xalloc_die ();
 266           dest_backup = (char *) alloca (strlen (tmp_backup) + 1);
 267           strcpy (dest_backup, tmp_backup);
 268           free (tmp_backup);
 269           if (rename (dest, dest_backup))
 270             {
 271               if (errno != ENOENT)
 272                 {
 273                   error (0, errno, _("cannot backup %s"), quote (dest));
 274                   return 1;
 275                 }
 276               else
 277                 dest_backup = NULL;
 278             }
 279           else
 280             {
 281               backup_succeeded = 1;
 282             }
 283         }
 284
 285       /* Try to unlink DEST even if we may have renamed it.  In some unusual
 286          cases (when DEST and DEST_BACKUP are hard-links that refer to the
 287          same file), rename succeeds and DEST remains.  If we didn't remove
 288          DEST in that case, the subsequent LINKFUNC call would fail.  */
 289       if (unlink (dest) && errno != ENOENT)
 290         {
 291           error (0, errno, _("cannot remove %s"), quote (dest));
 292           return 1;
 293         }
 294     }
 295   else if (errno != ENOENT)
 296     {
 297       error (0, errno, _("accessing %s"), quote (dest));
 298       return 1;
 299     }
 300
 301   if (verbose)
 302     {
 303       printf ((symbolic_link
 304                ? _("create symbolic link %s to %s")
 305                : _("create hard link %s to %s")),
 306               quote_n (0, dest), quote_n (1, source));
 307       if (backup_succeeded)
 308         printf (_(" (backup: %s)"), quote (dest_backup));
 309       putchar ('\n');
 310     }
 311
 312   if ((*linkfunc) (source, dest) == 0)
 313     {
 314       return 0;
 315     }
 316
 317   error (0, errno,
 318          (symbolic_link
 319           ? _("creating symbolic link %s to %s")
 320           : _("creating hard link %s to %s")),
 321          quote_n (0, dest), quote_n (1, source));
 322
 323   if (dest_backup)
 324     {
 325       if (rename (dest_backup, dest))
 326         error (0, errno, _("cannot un-backup %s"), quote (dest));
 327     }
 328   return 1;
 329 }
 330
 331 void
 332 usage (int status)
 333 {
 334   if (status != 0)
 335     fprintf (stderr, _("Try `%s --help' for more information.\n"),
 336              program_name);
 337   else
 338     {
 339       printf (_("\
 340 Usage: %s [OPTION]... TARGET [LINK_NAME]\n\
 341   or:  %s [OPTION]... TARGET... DIRECTORY\n\
 342   or:  %s [OPTION]... --target-directory=DIRECTORY TARGET...\n\
 343 "),
 344               program_name, program_name, program_name);
 345       fputs (_("\
 346 Create a link to the specified TARGET with optional LINK_NAME.\n\
 347 If LINK_NAME is omitted, a link with the same basename as the TARGET is\n\
 348 created in the current directory.  When using the second form with more\n\
 349 than one TARGET, the last argument must be a directory;  create links\n\
 350 in DIRECTORY to each TARGET.  Create hard links by default, symbolic\n\
 351 links with --symbolic.  When creating hard links, each TARGET must exist.\n\
 352 \n\
 353 "), stdout);
 354       fputs (_("\
 355 Mandatory arguments to long options are mandatory for short options too.\n\
 356 "), stdout);
 357       fputs (_("\
 358       --backup[=CONTROL]      make a backup of each existing destination file\n\
 359   -b                          like --backup but does not accept an argument\n\
 360   -d, -F, --directory         hard link directories (super-user only)\n\
 361   -f, --force                 remove existing destination files\n\
 362 "), stdout);
 363       fputs (_("\
 364   -n, --no-dereference        treat destination that is a symlink to a\n\
 365                                 directory as if it were a normal file\n\
 366   -i, --interactive           prompt whether to remove destinations\n\
 367   -s, --symbolic              make symbolic links instead of hard links\n\
 368 "), stdout);
 369       fputs (_("\
 370   -S, --suffix=SUFFIX         override the usual backup suffix\n\
 371       --target-directory=DIRECTORY  specify the DIRECTORY in which to create\n\
 372                                 the links\n\
 373   -v, --verbose               print name of each file before linking\n\
 374 "), stdout);
 375       fputs (HELP_OPTION_DESCRIPTION, stdout);
 376       fputs (VERSION_OPTION_DESCRIPTION, stdout);
 377       fputs (_("\
 378 \n\
 379 The backup suffix is `~', unless set with --suffix or SIMPLE_BACKUP_SUFFIX.\n\
 380 The version control method may be selected via the --backup option or through\n\
 381 the VERSION_CONTROL environment variable.  Here are the values:\n\
 382 \n\
 383 "), stdout);
 384       fputs (_("\
 385   none, off       never make backups (even if --backup is given)\n\
 386   numbered, t     make numbered backups\n\
 387   existing, nil   numbered if numbered backups exist, simple otherwise\n\
 388   simple, never   always make simple backups\n\
 389 "), stdout);
 390       printf (_("\nReport bugs to <%s>.\n"), PACKAGE_BUGREPORT);
 391     }
 392   exit (status);
 393 }
 394
 395 int
 396 main (int argc, char **argv)
 397 {
 398   int c;
 399   int errors;
 400   int make_backups = 0;
 401   char *backup_suffix_string;
 402   char *version_control_string = NULL;
 403   char *target_directory = NULL;
 404   int target_directory_specified;
 405   unsigned int n_files;
 406   char **file;
 407   int dest_is_dir;
 408
 409   initialize_main (&argc, &argv);
 410   program_name = argv[0];
 411   setlocale (LC_ALL, "");
 412   bindtextdomain (PACKAGE, LOCALEDIR);
 413   textdomain (PACKAGE);
 414
 415   atexit (close_stdout);
 416
 417   /* FIXME: consider not calling getenv for SIMPLE_BACKUP_SUFFIX unless
 418      we'll actually use backup_suffix_string.  */
 419   backup_suffix_string = getenv ("SIMPLE_BACKUP_SUFFIX");
 420
 421   symbolic_link = remove_existing_files = interactive = verbose
 422     = hard_dir_link = 0;
 423   errors = 0;
 424
 425   while ((c = getopt_long (argc, argv, "bdfinsvFS:V:", long_options, NULL))
 426          != -1)
 427     {
 428       switch (c)
 429         {
 430         case 0:                 /* Long-named option. */
 431           break;
 432
 433         case 'V':  /* FIXME: this is deprecated.  Remove it in 2001.  */
 434           error (0, 0,
 435                  _("warning: --version-control (-V) is obsolete;  support for\
 436  it\nwill be removed in some future release.  Use --backup=%s instead."
 437                    ), optarg);
 438           /* Fall through.  */
 439
 440         case 'b':
 441           make_backups = 1;
 442           if (optarg)
 443             version_control_string = optarg;
 444           break;
 445         case 'd':
 446         case 'F':
 447           hard_dir_link = 1;
 448           break;
 449         case 'f':
 450           remove_existing_files = 1;
 451           interactive = 0;
 452           break;
 453         case 'i':
 454           remove_existing_files = 0;
 455           interactive = 1;
 456           break;
 457         case 'n':
 458           dereference_dest_dir_symlinks = 0;
 459           break;
 460         case 's':
 461 #ifdef S_ISLNK
 462           symbolic_link = 1;
 463 #else
 464           error (EXIT_FAILURE, 0,
 465                  _("symbolic links are not supported on this system"));
 466 #endif
 467           break;
 468         case TARGET_DIRECTORY_OPTION:
 469           target_directory = optarg;
 470           break;
 471         case 'v':
 472           verbose = 1;
 473           break;
 474         case 'S':
 475           make_backups = 1;
 476           backup_suffix_string = optarg;
 477           break;
 478         case_GETOPT_HELP_CHAR;
 479         case_GETOPT_VERSION_CHAR (PROGRAM_NAME, AUTHORS);
 480         default:
 481           usage (EXIT_FAILURE);
 482           break;
 483         }
 484     }
 485
 486   if (argc <= optind)
 487     {
 488       error (0, 0, _("missing file argument"));
 489       usage (EXIT_FAILURE);
 490     }
 491
 492   n_files = argc - optind;
 493   file = argv + optind;
 494
 495   target_directory_specified = (target_directory != NULL);
 496   if (!target_directory)
 497     target_directory = file[n_files - 1];
 498
 499   /* If target directory is not specified, and there's only one
 500      file argument, then pretend `.' was given as the second argument.  */
 501   if (!target_directory_specified && n_files == 1)
 502     {
 503       static char *dummy[2];
 504       dummy[0] = file[0];
 505       dummy[1] = ".";
 506       file = dummy;
 507       n_files = 2;
 508       dest_is_dir = 1;
 509     }
 510   else
 511     {
 512       dest_is_dir = isdir (target_directory);
 513     }
 514
 515   if (symbolic_link)
 516     linkfunc = symlink;
 517   else
 518     linkfunc = link;
 519
 520   if (target_directory_specified && !dest_is_dir)
 521     {
 522       error (0, 0, _("%s: specified target directory is not a directory"),
 523              quote (target_directory));
 524       usage (EXIT_FAILURE);
 525     }
 526
 527   if (backup_suffix_string)
 528     simple_backup_suffix = xstrdup (backup_suffix_string);
 529
 530   backup_type = (make_backups
 531                  ? xget_version (_("backup type"), version_control_string)
 532                  : none);
 533
 534   if (target_directory_specified || n_files > 2)
 535     {
 536       unsigned int i;
 537       unsigned int last_file_idx = (target_directory_specified
 538                                     ? n_files - 1
 539                                     : n_files - 2);
 540
 541       if (!target_directory_specified && !dest_is_dir)
 542         error (EXIT_FAILURE, 0,
 543            _("when making multiple links, last argument must be a directory"));
 544       for (i = 0; i <= last_file_idx; ++i)
 545         errors += do_link (file[i], target_directory);
 546     }
 547   else
 548     {
 549       struct stat source_stats;
 550       const char *source;
 551       char *dest;
 552       char *new_dest;
 553
 554       source = file[0];
 555       dest = file[1];
 556
 557       /* When the destination is specified with a trailing slash and the
 558          source exists but is not a directory, convert the user's command
 559          `ln source dest/' to `ln source dest/basename(source)'.  */
 560
 561       if (dest[strlen (dest) - 1] == '/'
 562           && lstat (source, &source_stats) == 0
 563           && !S_ISDIR (source_stats.st_mode))
 564         {
 565           PATH_BASENAME_CONCAT (new_dest, dest, source);
 566         }
 567       else
 568         {
 569           new_dest = dest;
 570         }
 571
 572       errors = do_link (source, new_dest);
 573     }
 574
 575   exit (errors != 0);
 576 }