fileio.c 178 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* File IO for GNU Emacs.
Glenn Morris's avatar
Glenn Morris committed
2

Glenn Morris's avatar
Glenn Morris committed
3
Copyright (C) 1985-1988, 1993-2012 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20
#include <config.h>
21
#include <limits.h>
22
#include <fcntl.h>
23
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
24 25
#include <sys/types.h>
#include <sys/stat.h>
26 27
#include <unistd.h>

28
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
29
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
30 31
#endif

Jim Blandy's avatar
Jim Blandy committed
32 33
#include <errno.h>

Karel Klíc's avatar
Karel Klíc committed
34 35 36 37 38
#ifdef HAVE_LIBSELINUX
#include <selinux/selinux.h>
#include <selinux/context.h>
#endif

39 40
#include <c-ctype.h>

Jim Blandy's avatar
Jim Blandy committed
41
#include "lisp.h"
42
#include "intervals.h"
43
#include "character.h"
44
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
45
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
46
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
47
#include "blockinput.h"
Karoly Lorentey's avatar
Karoly Lorentey committed
48 49
#include "frame.h"
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
50

51 52 53 54 55 56
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Eli Zaretskii's avatar
Eli Zaretskii committed
57 58 59 60 61 62
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#include <fcntl.h>
#endif

63 64
#ifdef DOS_NT
/* On Windows, drive letters must be alphabetic - on DOS, the Netware
65
   redirector allows the six letters between 'Z' and 'a' as well.  */
66 67 68 69
#ifdef MSDOS
#define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
#endif
#ifdef WINDOWSNT
70
#define IS_DRIVE(x) c_isalpha (x)
71
#endif
72
/* Need to lower-case the drive letter, or else expanded
Paul Eggert's avatar
Paul Eggert committed
73
   filenames will sometimes compare unequal, because
74
   `expand-file-name' doesn't always down-case the drive letter.  */
75
#define DRIVE_LETTER(x) c_tolower (x)
76 77
#endif

Jim Blandy's avatar
Jim Blandy committed
78
#include "systime.h"
79
#include <stat-time.h>
Jim Blandy's avatar
Jim Blandy committed
80 81 82

#ifdef HPUX
#include <netio.h>
83
#endif
Jim Blandy's avatar
Jim Blandy committed
84

85 86
#include "commands.h"

87 88
/* True during writing of auto-save files.  */
static bool auto_saving;
Jim Blandy's avatar
Jim Blandy committed
89

90
/* Nonzero umask during creation of auto-save directories.  */
91
static mode_t auto_saving_dir_umask;
92

Jim Blandy's avatar
Jim Blandy committed
93
/* Set by auto_save_1 to mode of original file so Fwrite_region will create
94
   a new file with the same mode as the original.  */
95
static mode_t auto_save_mode_bits;
Jim Blandy's avatar
Jim Blandy committed
96

97
/* Set by auto_save_1 if an error occurred during the last auto-save.  */
98
static bool auto_save_error_occurred;
99

100 101 102 103 104
/* The symbol bound to coding-system-for-read when
   insert-file-contents is called for recovering a file.  This is not
   an actual coding system name, but just an indicator to tell
   insert-file-contents to use `emacs-mule' with a special flag for
   auto saving and recovering a file.  */
105
static Lisp_Object Qauto_save_coding;
106

107 108
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
109
static Lisp_Object Qoperations;
110

111
/* Lisp functions for translating file formats.  */
112
static Lisp_Object Qformat_decode, Qformat_annotate_function;
113

114
/* Lisp function for setting buffer-file-coding-system and the
115
   multibyteness of the current buffer after inserting a file.  */
116
static Lisp_Object Qafter_insert_file_set_coding;
117

118
static Lisp_Object Qwrite_region_annotate_functions;
119 120
/* Each time an annotation function changes the buffer, the new buffer
   is added here.  */
121
static Lisp_Object Vwrite_region_annotation_buffers;
122

123 124 125
#ifdef HAVE_FSYNC
#endif

126
static Lisp_Object Qdelete_by_moving_to_trash;
127

128
/* Lisp function for moving files to trash.  */
129
static Lisp_Object Qmove_file_to_trash;
130

131
/* Lisp function for recursively copying directories.  */
132
static Lisp_Object Qcopy_directory;
133 134

/* Lisp function for recursively deleting directories.  */
135
static Lisp_Object Qdelete_directory;
136

137 138 139
#ifdef WINDOWSNT
#endif

140 141 142
Lisp_Object Qfile_error;
static Lisp_Object Qfile_already_exists, Qfile_date_error;
static Lisp_Object Qexcl;
143 144
Lisp_Object Qfile_name_history;

145
static Lisp_Object Qcar_less_than_car;
146

147 148 149 150
static bool a_write (int, Lisp_Object, ptrdiff_t, ptrdiff_t,
		     Lisp_Object *, struct coding_system *);
static bool e_write (int, Lisp_Object, ptrdiff_t, ptrdiff_t,
		     struct coding_system *);
151

152

153
void
154
report_file_error (const char *string, Lisp_Object data)
Jim Blandy's avatar
Jim Blandy committed
155 156
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
157
  int errorno = errno;
158
  char *str;
Jim Blandy's avatar
Jim Blandy committed
159

160
  synchronize_system_messages_locale ();
161
  str = strerror (errorno);
162
  errstring = code_convert_string_norecord (build_unibyte_string (str),
163 164
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
165
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167 168
    switch (errorno)
      {
      case EEXIST:
169
	xsignal (Qfile_already_exists, Fcons (errstring, data));
Richard M. Stallman's avatar
Richard M. Stallman committed
170 171 172
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
173 174
	   unless it is followed by a slash.  (The slash case caters to
	   error messages that begin with "I/O" or, in German, "E/A".)  */
175 176
	if (STRING_MULTIBYTE (errstring)
	    && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
177 178 179
	  {
	    int c;

180
	    str = SSDATA (errstring);
181
	    c = STRING_CHAR ((unsigned char *) str);
182
	    Faset (errstring, make_number (0), make_number (downcase (c)));
183
	  }
Richard M. Stallman's avatar
Richard M. Stallman committed
184

185
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
186 187
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
188
}
189

190
Lisp_Object
191
close_file_unwind (Lisp_Object fd)
192
{
193
  emacs_close (XFASTINT (fd));
194
  return Qnil;
195
}
196 197 198

/* Restore point, having saved it as a marker.  */

Andreas Schwab's avatar
Andreas Schwab committed
199
Lisp_Object
200
restore_point_unwind (Lisp_Object location)
201
{
202
  Fgoto_char (location);
203
  Fset_marker (location, Qnil, Qnil);
204
  return Qnil;
205
}
206

Jim Blandy's avatar
Jim Blandy committed
207

208 209 210 211 212 213 214 215 216 217 218
static Lisp_Object Qexpand_file_name;
static Lisp_Object Qsubstitute_in_file_name;
static Lisp_Object Qdirectory_file_name;
static Lisp_Object Qfile_name_directory;
static Lisp_Object Qfile_name_nondirectory;
static Lisp_Object Qunhandled_file_name_directory;
static Lisp_Object Qfile_name_as_directory;
static Lisp_Object Qcopy_file;
static Lisp_Object Qmake_directory_internal;
static Lisp_Object Qmake_directory;
static Lisp_Object Qdelete_directory_internal;
219
Lisp_Object Qdelete_file;
220 221 222
static Lisp_Object Qrename_file;
static Lisp_Object Qadd_name_to_file;
static Lisp_Object Qmake_symbolic_link;
223
Lisp_Object Qfile_exists_p;
224 225 226 227 228
static Lisp_Object Qfile_executable_p;
static Lisp_Object Qfile_readable_p;
static Lisp_Object Qfile_writable_p;
static Lisp_Object Qfile_symlink_p;
static Lisp_Object Qaccess_file;
229
Lisp_Object Qfile_directory_p;
230 231 232 233 234 235 236 237
static Lisp_Object Qfile_regular_p;
static Lisp_Object Qfile_accessible_directory_p;
static Lisp_Object Qfile_modes;
static Lisp_Object Qset_file_modes;
static Lisp_Object Qset_file_times;
static Lisp_Object Qfile_selinux_context;
static Lisp_Object Qset_file_selinux_context;
static Lisp_Object Qfile_newer_than_file_p;
238 239
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
240 241
static Lisp_Object Qverify_visited_file_modtime;
static Lisp_Object Qset_visited_file_modtime;
242

Paul Eggert's avatar
Paul Eggert committed
243
DEFUN ("find-file-name-handler", Ffind_file_name_handler,
244
       Sfind_file_name_handler, 2, 2, 0,
245 246 247 248 249 250 251 252 253
       doc: /* Return FILENAME's handler function for OPERATION, if it has one.
Otherwise, return nil.
A file name is handled if one of the regular expressions in
`file-name-handler-alist' matches it.

If OPERATION equals `inhibit-file-name-operation', then we ignore
any handlers that are members of `inhibit-file-name-handlers',
but we still do run any other handlers.  This lets handlers
use the standard functions without calling themselves recursively.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
254
  (Lisp_Object filename, Lisp_Object operation)
255
{
256
  /* This function must not munge the match data.  */
257
  Lisp_Object chain, inhibited_handlers, result;
258
  ptrdiff_t pos = -1;
259

260
  result = Qnil;
261
  CHECK_STRING (filename);
262

263 264 265 266
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
267

268
  for (chain = Vfile_name_handler_alist; CONSP (chain);
269
       chain = XCDR (chain))
270 271
    {
      Lisp_Object elt;
272
      elt = XCAR (chain);
273
      if (CONSP (elt))
274
	{
275
	  Lisp_Object string = XCAR (elt);
276
	  ptrdiff_t match_pos;
277
	  Lisp_Object handler = XCDR (elt);
278 279 280 281
	  Lisp_Object operations = Qnil;

	  if (SYMBOLP (handler))
	    operations = Fget (handler, Qoperations);
282

283
	  if (STRINGP (string)
284 285
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
286
	    {
287
	      Lisp_Object tem;
288

289
	      handler = XCDR (elt);
290 291
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
292 293 294 295
		{
		  result = handler;
		  pos = match_pos;
		}
296
	    }
297
	}
298 299

      QUIT;
300
    }
301
  return result;
302 303
}

Paul Eggert's avatar
Paul Eggert committed
304
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
305 306 307
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
308
Otherwise return a directory name.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
309
Given a Unix syntax file name, returns a string ending in slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
310
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
311
{
312
#ifndef DOS_NT
313
  register const char *beg;
314
#else
315
  register char *beg;
316
#endif
317
  register const char *p;
318
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
319

320
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
321

322 323
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
324
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
325
  if (!NILP (handler))
326 327 328 329 330
    {
      Lisp_Object handled_name = call2 (handler, Qfile_name_directory,
					filename);
      return STRINGP (handled_name) ? handled_name : Qnil;
    }
331

332
#ifdef DOS_NT
333
  beg = alloca (SBYTES (filename) + 1);
334
  memcpy (beg, SSDATA (filename), SBYTES (filename) + 1);
335
#else
336
  beg = SSDATA (filename);
337
#endif
338
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
339

340 341
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
Paul Eggert's avatar
Paul Eggert committed
342
	 /* only recognize drive specifier at the beginning */
343 344 345 346
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" and "/:foo" cases correctly  */
	      && ((p == beg + 2 && !IS_DIRECTORY_SEP (*beg))
		  || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
347
#endif
Jim Blandy's avatar
Jim Blandy committed
348 349 350 351
	 ) p--;

  if (p == beg)
    return Qnil;
352
#ifdef DOS_NT
353
  /* Expansion of "c:" to drive and default directory.  */
354
  if (p[-1] == ':')
355 356
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
357 358
      char *res = alloca (MAXPATHLEN + 1);
      char *r = res;
359 360 361

      if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
	{
362
	  memcpy (res, beg, 2);
363 364 365 366
	  beg += 2;
	  r += 2;
	}

367
      if (getdefdir (c_toupper (*beg) - 'A' + 1, r))
368
	{
369
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
370 371 372 373 374
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
375
  dostounix_filename (beg);
376
#endif /* DOS_NT */
377

378
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
379 380
}

Paul Eggert's avatar
Paul Eggert committed
381
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
382
       Sfile_name_nondirectory, 1, 1, 0,
383 384 385 386
       doc: /* Return file name FILENAME sans its directory.
For example, in a Unix-syntax file name,
this is everything after the last slash,
or the entire name if it contains no slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
387
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
388
{
389
  register const char *beg, *p, *end;
390
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
391

392
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
393

394 395
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
396
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
397
  if (!NILP (handler))
398 399 400 401 402 403 404
    {
      Lisp_Object handled_name = call2 (handler, Qfile_name_nondirectory,
					filename);
      if (STRINGP (handled_name))
	return handled_name;
      error ("Invalid handler in `file-name-handler-alist'");
    }
405

406
  beg = SSDATA (filename);
407
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
408

409 410
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
Paul Eggert's avatar
Paul Eggert committed
411
	 /* only recognize drive specifier at beginning */
412 413 414
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
415
#endif
416 417
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
418

419
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
420
}
421

Paul Eggert's avatar
Paul Eggert committed
422
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
423
       Sunhandled_file_name_directory, 1, 1, 0,
424 425 426 427 428
       doc: /* Return a directly usable directory name somehow associated with FILENAME.
A `directly usable' directory name is one that may be used without the
intervention of any file handler.
If FILENAME is a directly usable file itself, return
\(file-name-directory FILENAME).
Stefan Monnier's avatar
Stefan Monnier committed
429 430
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
431 432
The `call-process' and `start-process' functions use this function to
get a current directory to run processes in.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
433
  (Lisp_Object filename)
434 435 436 437 438
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
439
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
440
  if (!NILP (handler))
441 442 443 444 445
    {
      Lisp_Object handled_name = call2 (handler, Qunhandled_file_name_directory,
					filename);
      return STRINGP (handled_name) ? handled_name : Qnil;
    }
446 447 448 449

  return Ffile_name_directory (filename);
}

450 451 452
/* Convert from file name SRC of length SRCLEN to directory name
   in DST.  On UNIX, just make sure there is a terminating /.
   Return the length of DST.  */
Jim Blandy's avatar
Jim Blandy committed
453

454 455 456 457
static ptrdiff_t
file_name_as_directory (char *dst, const char *src, ptrdiff_t srclen)
{
  if (srclen == 0)
458
    {
459 460 461 462
      dst[0] = '.';
      dst[1] = '/';
      dst[2] = '\0';
      return 2;
463 464
    }

465
  strcpy (dst, src);
466

467
  if (!IS_DIRECTORY_SEP (dst[srclen - 1]))
468
    {
469 470 471
      dst[srclen] = DIRECTORY_SEP;
      dst[srclen + 1] = '\0';
      srclen++;
472
    }
473
#ifdef DOS_NT
474
  dostounix_filename (dst);
475
#endif
476
  return srclen;
Jim Blandy's avatar
Jim Blandy committed
477 478
}

Paul Eggert's avatar
Paul Eggert committed
479
DEFUN ("file-name-as-directory", Ffile_name_as_directory,
Jim Blandy's avatar
Jim Blandy committed
480
       Sfile_name_as_directory, 1, 1, 0,
481
       doc: /* Return a string representing the file name FILE interpreted as a directory.
482 483 484 485
This operation exists because a directory is also a file, but its name as
a directory is different from its name as a file.
The result can be used as the value of `default-directory'
or passed as second argument to `expand-file-name'.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
486
For a Unix-syntax file name, just appends a slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
487
  (Lisp_Object file)
Jim Blandy's avatar
Jim Blandy committed
488 489
{
  char *buf;
490
  ptrdiff_t length;
491
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
492

493
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
494
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
495
    return Qnil;
496 497 498

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
499
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
500
  if (!NILP (handler))
501 502 503 504 505 506 507
    {
      Lisp_Object handled_name = call2 (handler, Qfile_name_as_directory,
					file);
      if (STRINGP (handled_name))
	return handled_name;
      error ("Invalid handler in `file-name-handler-alist'");
    }
508

509
  buf = alloca (SBYTES (file) + 10);
510 511
  length = file_name_as_directory (buf, SSDATA (file), SBYTES (file));
  return make_specified_string (buf, -1, length, STRING_MULTIBYTE (file));
Jim Blandy's avatar
Jim Blandy committed
512 513
}

514 515 516
/* Convert from directory name SRC of length SRCLEN to
   file name in DST.  On UNIX, just make sure there isn't
   a terminating /.  Return the length of DST.  */
Jim Blandy's avatar
Jim Blandy committed
517

518 519
static ptrdiff_t
directory_file_name (char *dst, char *src, ptrdiff_t srclen)
Jim Blandy's avatar
Jim Blandy committed
520 521 522 523
{
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
524 525
  if (srclen > 1
      && IS_DIRECTORY_SEP (dst[srclen - 1])
526
#ifdef DOS_NT
527
      && !IS_ANY_SEP (dst[srclen - 2])
528 529
#endif
      )
530 531 532 533
    {
      dst[srclen - 1] = 0;
      srclen--;
    }
534
#ifdef DOS_NT
535
  dostounix_filename (dst);
536
#endif
537
  return srclen;
Jim Blandy's avatar
Jim Blandy committed
538 539
}

Paul Eggert's avatar
Paul Eggert committed
540
DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
541 542 543 544 545
       1, 1, 0,
       doc: /* Returns the file name of the directory named DIRECTORY.
This is the name of the file that holds the data for the directory DIRECTORY.
This operation exists because a directory is also a file, but its name as
a directory is different from its name as a file.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
546
In Unix-syntax, this function just removes the final slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
547
  (Lisp_Object directory)
Jim Blandy's avatar
Jim Blandy committed
548 549
{
  char *buf;
550
  ptrdiff_t length;
551
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
552

553
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
554

Jim Blandy's avatar
Jim Blandy committed
555
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
556
    return Qnil;
557 558 559

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
560
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
561
  if (!NILP (handler))
562 563 564 565 566 567 568
    {
      Lisp_Object handled_name = call2 (handler, Qdirectory_file_name,
					directory);
      if (STRINGP (handled_name))
	return handled_name;
      error ("Invalid handler in `file-name-handler-alist'");
    }
569

570
  buf = alloca (SBYTES (directory) + 20);
571 572
  length = directory_file_name (buf, SSDATA (directory), SBYTES (directory));
  return make_specified_string (buf, -1, length, STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
573 574
}

575
static const char make_temp_name_tbl[64] =
576 577 578 579 580 581 582 583 584 585
{
  'A','B','C','D','E','F','G','H',
  'I','J','K','L','M','N','O','P',
  'Q','R','S','T','U','V','W','X',
  'Y','Z','a','b','c','d','e','f',
  'g','h','i','j','k','l','m','n',
  'o','p','q','r','s','t','u','v',
  'w','x','y','z','0','1','2','3',
  '4','5','6','7','8','9','-','_'
};
586

587 588
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

589
/* Value is a temporary file name starting with PREFIX, a string.
590

591 592 593 594 595
   The Emacs process number forms part of the result, so there is
   no danger of generating a name being used by another process.
   In addition, this function makes an attempt to choose a name
   which has no existing file.  To make this work, PREFIX should be
   an absolute file name.
596

597
   BASE64_P means add the pid as 3 characters in base64
598 599 600 601 602 603 604 605
   encoding.  In this case, 6 characters will be added to PREFIX to
   form the file name.  Otherwise, if Emacs is running on a system
   with long file names, add the pid as a decimal number.

   This function signals an error if no unique file name could be
   generated.  */

Lisp_Object
606
make_temp_name (Lisp_Object prefix, bool base64_p)
Jim Blandy's avatar
Jim Blandy committed
607 608
{
  Lisp_Object val;
609
  int len, clen;
610
  printmax_t pid;
611
  char *p, *data;
612
  char pidbuf[INT_BUFSIZE_BOUND (printmax_t)];
613
  int pidlen;
614

615
  CHECK_STRING (prefix);
616 617 618 619 620 621

  /* VAL is created by adding 6 characters to PREFIX.  The first
     three are the PID of this process, in base 64, and the second
     three are incremented if the file already exists.  This ensures
     262144 unique file names per PID per PREFIX.  */

622
  pid = getpid ();
623

624 625 626 627 628 629 630 631 632
  if (base64_p)
    {
      pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidlen = 3;
    }
  else
    {
633
#ifdef HAVE_LONG_FILE_NAMES
634
      pidlen = sprintf (pidbuf, "%"pMd, pid);
635
#else
636 637 638 639
      pidbuf[0] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[1] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidbuf[2] = make_temp_name_tbl[pid & 63], pid >>= 6;
      pidlen = 3;
640
#endif
641
    }
642

643 644 645 646
  len = SBYTES (prefix); clen = SCHARS (prefix);
  val = make_uninit_multibyte_string (clen + 3 + pidlen, len + 3 + pidlen);
  if (!STRING_MULTIBYTE (prefix))
    STRING_SET_UNIBYTE (val);
647 648
  data = SSDATA (val);
  memcpy (data, SSDATA (prefix), len);
649 650
  p = data + len;

651
  memcpy (p, pidbuf, pidlen);
652 653 654 655 656
  p += pidlen;

  /* Here we try to minimize useless stat'ing when this function is
     invoked many times successively with the same PREFIX.  We achieve
     this by initializing count to a random value, and incrementing it
Richard M. Stallman's avatar
Richard M. Stallman committed
657 658 659 660 661 662
     afterwards.

     We don't want make-temp-name to be called while dumping,
     because then make_temp_name_count_initialized_p would get set
     and then make_temp_name_count would not be set when Emacs starts.  */

663 664
  if (!make_temp_name_count_initialized_p)
    {
665
      make_temp_name_count = time (NULL);
666 667 668 669 670 671
      make_temp_name_count_initialized_p = 1;
    }

  while (1)
    {
      struct stat ignored;
672
      unsigned num = make_temp_name_count;
673 674 675 676 677

      p[0] = make_temp_name_tbl[num & 63], num >>= 6;
      p[1] = make_temp_name_tbl[num & 63], num >>= 6;
      p[2] = make_temp_name_tbl[num & 63], num >>= 6;

678 679 680 681 682
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

683 684 685 686 687 688 689 690 691 692
      if (stat (data, &ignored) < 0)
	{
	  /* We want to return only if errno is ENOENT.  */
	  if (errno == ENOENT)
	    return val;
	  else
	    /* The error here is dubious, but there is little else we
	       can do.  The alternatives are to return nil, which is
	       as bad as (and in many cases worse than) throwing the
	       error, or to ignore the error, which will likely result
693
	       in looping through 225307 stat's, which is not only
694 695
	       dog-slow, but also useless since eventually nil would
	       have to be returned anyway.  */
696
	    report_file_error ("Cannot create temporary name for prefix",
697 698 699 700
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }
Jim Blandy's avatar
Jim Blandy committed
701
}
702

703 704

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
705 706 707 708 709 710 711 712 713 714
       doc: /* Generate temporary file name (string) starting with PREFIX (a string).
The Emacs process number forms part of the result,
so there is no danger of generating a name being used by another process.

In addition, this function makes an attempt to choose a name
which has no existing file.  To make this work,
PREFIX should be an absolute file name.

There is a race condition between calling `make-temp-name' and creating the
file which opens all kinds of security holes.  For that reason, you should
715 716 717 718 719
probably use `make-temp-file' instead, except in three circumstances:

* If you are creating the file in the user's home directory.
* If you are creating a directory rather than an ordinary file.
* If you are taking special precautions as `make-temp-file' does.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
720
  (Lisp_Object prefix)
721 722 723 724 725
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
726

Paul Eggert's avatar
Paul Eggert committed
727
DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
728 729
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
730
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
731
the current buffer's value of `default-directory' is used.
732 733
NAME should be a string that is a valid file name for the underlying
filesystem.
734 735 736 737
File name components that are `.' are removed, and
so are file name components followed by `..', along with the `..' itself;
note that these simplifications are done without checking the resulting
file names in the file system.
738 739 740
Multiple consecutive slashes are collapsed into a single slash,
except at the beginning of the file name when they are significant (e.g.,
UNC file names on MS-Windows.)
741 742
An initial `~/' expands to your home directory.
An initial `~USER/' expands to USER's home directory.
Chong Yidong's avatar
Chong Yidong committed
743 744 745 746 747
See also the function `substitute-in-file-name'.

For technical reasons, this function can return correct but
non-intuitive results for the root directory; for instance,
\(expand-file-name ".." "/") returns "/..".  For this reason, use
748
\(directory-file-name (file-name-directory dirname)) to traverse a
Chong Yidong's avatar
Chong Yidong committed
749
filesystem tree, not (expand-file-name ".."  dirname).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
750
  (Lisp_Object name, Lisp_Object default_directory)
Jim Blandy's avatar
Jim Blandy committed
751
{
752 753
  /* These point to SDATA and need to be careful with string-relocation
     during GC (via DECODE_FILE).  */
754 755
  char *nm;
  const char *newdir;
756
  /* This should only point to alloca'd data.  */
757
  char *target;
758

759
  ptrdiff_t tlen;
Jim Blandy's avatar
Jim Blandy committed
760
  struct passwd *pw;
761
#ifdef DOS_NT
762
  int drive = 0;
763 764
  bool collapse_newdir = 1;
  bool is_escaped = 0;
765
#endif /* DOS_NT */
766
  ptrdiff_t length;
767
  Lisp_Object handler, result, handled_name;
768
  bool multibyte;
769
  Lisp_Object hdir;
770

771
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
772

773 774
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
775
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
776
  if (!NILP (handler))
777 778 779 780 781 782 783 784
    {
      handled_name = call3 (handler, Qexpand_file_name,
			    name, default_directory);
      if (STRINGP (handled_name))
	return handled_name;
      error ("Invalid handler in `file-name-handler-alist'");
    }

785

786 787
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
Tom Tromey's avatar
Tom Tromey committed
788
    default_directory = BVAR (current_buffer, directory);
789
  if (! STRINGP (default_directory))
790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
    {
#ifdef DOS_NT
      /* "/" is not considered a root directory on DOS_NT, so using "/"
	 here causes an infinite recursion in, e.g., the following:

            (let (default-directory)
	      (expand-file-name "a"))

	 To avoid this, we set default_directory to the root of the
	 current drive.  */
      default_directory = build_string (emacs_root_dir ());
#else
      default_directory = build_string ("/");
#endif
    }
805

806
  if (!NILP (default_directory))
807
    {
808
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
809
      if (!NILP (handler))
810 811 812 813 814 815 816
	{
	  handled_name = call3 (handler, Qexpand_file_name,
				name, default_directory);
	  if (STRINGP (handled_name))
	    return handled_name;
	  error ("Invalid handler in `file-name-handler-alist'");
	}
817
    }
818

819
  {
820
    char *o = SSDATA (default_directory);
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835

    /* Make sure DEFAULT_DIRECTORY is properly expanded.
       It would be better to do this down below where we actually use
       default_directory.  Unfortunately, calling Fexpand_file_name recursively
       could invoke GC, and the strings might be relocated.  This would
       be annoying because we have pointers into strings lying around
       that would need adjusting, and people would add new pointers to
       the code and forget to adjust them, resulting in intermittent bugs.
       Putting this call here avoids all that crud.

       The EQ test avoids infinite recursion.  */
    if (! NILP (default_directory) && !EQ (default_directory, name)
	/* Save time in some common cases - as long as default_directory
	   is not relative, it can be canonicalized with name below (if it
	   is needed at all) without requiring it to be expanded now.  */
836
#ifdef DOS_NT
837 838 839
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
840
#ifdef WINDOWSNT
841 842
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))