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

3
Copyright (C) 1985-1988, 1993-2011  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
#include <setjmp.h>
27 28
#include <unistd.h>

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

Jim Blandy's avatar
Jim Blandy committed
33 34 35
#include <ctype.h>
#include <errno.h>

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

Jim Blandy's avatar
Jim Blandy committed
41
#include "lisp.h"
42
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
43
#include "buffer.h"
44
#include "character.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 65 66 67 68 69
#ifdef DOS_NT
/* On Windows, drive letters must be alphabetic - on DOS, the Netware
   redirector allows the six letters between 'Z' and 'a' as well. */
#ifdef MSDOS
#define IS_DRIVE(x) ((x) >= 'A' && (x) <= 'z')
#endif
#ifdef WINDOWSNT
70
#define IS_DRIVE(x) isalpha ((unsigned char) (x))
71
#endif
72 73 74
/* Need to lower-case the drive letter, or else expanded
   filenames will sometimes compare inequal, because
   `expand-file-name' doesn't always down-case the drive letter.  */
75
#define DRIVE_LETTER(x) (tolower ((unsigned char) (x)))
76 77
#endif

Jim Blandy's avatar
Jim Blandy committed
78
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
79 80 81

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

84 85
#include "commands.h"

86 87 88 89
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
90
/* Nonzero during writing of auto-save files */
91
static int auto_saving;
Jim Blandy's avatar
Jim Blandy committed
92 93 94

/* Set by auto_save_1 to mode of original file so Fwrite_region will create
   a new file with the same mode as the original */
95
static int 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 int 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
INFUN (Fmake_symbolic_link, 3);
148 149 150
static int a_write (int, Lisp_Object, int, int,
                    Lisp_Object *, struct coding_system *);
static int e_write (int, Lisp_Object, int, int, 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 162 163
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
164 165
					    Vlocale_coding_system, 0);

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
208

209 210 211 212 213 214 215 216 217 218 219
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;
220
Lisp_Object Qdelete_file;
221 222 223
static Lisp_Object Qrename_file;
static Lisp_Object Qadd_name_to_file;
static Lisp_Object Qmake_symbolic_link;
224
Lisp_Object Qfile_exists_p;
225 226 227 228 229
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;
230
Lisp_Object Qfile_directory_p;
231 232 233 234 235 236 237 238
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;
239 240
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
241 242
static Lisp_Object Qverify_visited_file_modtime;
static Lisp_Object Qset_visited_file_modtime;
243

244 245
DEFUE ("find-file-name-handler", Ffind_file_name_handler,
       Sfind_file_name_handler, 2, 2, 0,
246 247 248 249 250 251 252 253 254
       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
255
  (Lisp_Object filename, Lisp_Object operation)
256
{
257
  /* This function must not munge the match data.  */
258
  Lisp_Object chain, inhibited_handlers, result;
259
  int pos = -1;
260

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

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

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

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

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

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

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

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

323 324
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
325
  handler = Ffind_file_name_handler (filename, Qfile_name_directory);
326
  if (!NILP (handler))
327
    return call2 (handler, Qfile_name_directory, filename);
328

329
  filename = FILE_SYSTEM_CASE (filename);
330
#ifdef DOS_NT
331 332
  beg = (char *) alloca (SBYTES (filename) + 1);
  memcpy (beg, SSDATA (filename), SBYTES (filename) + 1);
333
#else
334
  beg = SSDATA (filename);
335
#endif
336
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
337

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

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

      if (p == beg + 4 && IS_DIRECTORY_SEP (*beg) && beg[1] == ':')
	{
	  strncpy (res, beg, 2);
	  beg += 2;
	  r += 2;
	}

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

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

379
DEFUE ("file-name-nondirectory", Ffile_name_nondirectory,
380
       Sfile_name_nondirectory, 1, 1, 0,
381 382 383 384
       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
385
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
386
{
387
  register const char *beg, *p, *end;
388
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
389

390
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
391

392 393
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
394
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
395
  if (!NILP (handler))
396
    return call2 (handler, Qfile_name_nondirectory, filename);
397

398
  beg = SSDATA (filename);
399
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
400

401 402 403
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
404 405 406
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
407
#endif
408 409
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
410

411
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
412
}
413

414
DEFUE ("unhandled-file-name-directory", Funhandled_file_name_directory,
415
       Sunhandled_file_name_directory, 1, 1, 0,
416 417 418 419 420
       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
421 422
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
423 424
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
425
  (Lisp_Object filename)
426 427 428 429 430
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
431
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
432 433 434 435 436 437
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
438

439
static char *
440
file_name_as_directory (char *out, const char *in)
Jim Blandy's avatar
Jim Blandy committed
441 442 443 444 445
{
  int size = strlen (in) - 1;

  strcpy (out, in);

446 447
  if (size < 0)
    {
448 449 450
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
451 452 453
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
454
  /* For Unix syntax, Append a slash if necessary */
455
  if (!IS_DIRECTORY_SEP (out[size]))
456
    {
457
      out[size + 1] = DIRECTORY_SEP;
458 459
      out[size + 2] = '\0';
    }
460
#ifdef DOS_NT
461
  dostounix_filename (out);
462
#endif
Jim Blandy's avatar
Jim Blandy committed
463 464 465
  return out;
}

466
DEFUE ("file-name-as-directory", Ffile_name_as_directory,
Jim Blandy's avatar
Jim Blandy committed
467
       Sfile_name_as_directory, 1, 1, 0,
468
       doc: /* Return a string representing the file name FILE interpreted as a directory.
469 470 471 472
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
473
For a Unix-syntax file name, just appends a slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
474
  (Lisp_Object file)
Jim Blandy's avatar
Jim Blandy committed
475 476
{
  char *buf;
477
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
478

479
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
480
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
481
    return Qnil;
482 483 484

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
485
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
486 487 488
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

489
  buf = (char *) alloca (SBYTES (file) + 10);
490
  file_name_as_directory (buf, SSDATA (file));
491 492
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (file));
Jim Blandy's avatar
Jim Blandy committed
493 494 495 496
}

/*
 * Convert from directory name to filename.
497
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501

 * Value is nonzero if the string output is different from the input.
 */

502
static int
503
directory_file_name (char *src, char *dst)
Jim Blandy's avatar
Jim Blandy committed
504 505 506 507
{
  long slen;

  slen = strlen (src);
Dan Nicolaescu's avatar
Dan Nicolaescu committed
508

Jim Blandy's avatar
Jim Blandy committed
509 510 511
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
512
  if (slen > 1
513
      && IS_DIRECTORY_SEP (dst[slen - 1])
514 515 516 517
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
518
    dst[slen - 1] = 0;
519
#ifdef DOS_NT
520
  dostounix_filename (dst);
521
#endif
Jim Blandy's avatar
Jim Blandy committed
522 523 524
  return 1;
}

525
DEFUE ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
526 527 528 529 530
       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
531
In Unix-syntax, this function just removes the final slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
532
  (Lisp_Object directory)
Jim Blandy's avatar
Jim Blandy committed
533 534
{
  char *buf;
535
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
536

537
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
538

Jim Blandy's avatar
Jim Blandy committed
539
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
540
    return Qnil;
541 542 543

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
544
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
545 546 547
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

548
  buf = (char *) alloca (SBYTES (directory) + 20);
549
  directory_file_name (SSDATA (directory), buf);
550 551
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
552 553
}

554
static const char make_temp_name_tbl[64] =
555 556 557 558 559 560 561 562 563 564
{
  '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','-','_'
};
565

566 567
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

568
/* Value is a temporary file name starting with PREFIX, a string.
569

570 571 572 573 574
   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.
575

576 577 578 579 580 581 582 583 584
   BASE64_P non-zero means add the pid as 3 characters in base64
   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
585
make_temp_name (Lisp_Object prefix, int base64_p)
Jim Blandy's avatar
Jim Blandy committed
586 587
{
  Lisp_Object val;
588
  int len, clen;
589
  int pid;
590
  char *p, *data;
591 592
  char pidbuf[20];
  int pidlen;
593

594
  CHECK_STRING (prefix);
595 596 597 598 599 600 601 602

  /* 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.  */

  pid = (int) getpid ();

603 604 605 606 607 608 609 610 611
  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
    {
612
#ifdef HAVE_LONG_FILE_NAMES
613 614
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
615
#else
616 617 618 619
      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;
620
#endif
621
    }
622

623 624 625 626
  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);
627 628
  data = SSDATA (val);
  memcpy (data, SSDATA (prefix), len);
629 630
  p = data + len;

631
  memcpy (p, pidbuf, pidlen);
632 633 634 635 636
  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
637 638 639 640 641 642
     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.  */

643 644 645 646 647 648 649 650 651
  if (!make_temp_name_count_initialized_p)
    {
      make_temp_name_count = (unsigned) time (NULL);
      make_temp_name_count_initialized_p = 1;
    }

  while (1)
    {
      struct stat ignored;
652
      unsigned num = make_temp_name_count;
653 654 655 656 657

      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;

658 659 660 661 662
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

663 664 665 666 667 668 669 670 671 672
      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
673
	       in looping through 225307 stat's, which is not only
674 675
	       dog-slow, but also useless since eventually nil would
	       have to be returned anyway.  */
676
	    report_file_error ("Cannot create temporary name for prefix",
677 678 679 680
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }
Jim Blandy's avatar
Jim Blandy committed
681
}
682

683 684

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
685 686 687 688 689 690 691 692 693 694
       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
695 696 697 698 699
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
700
  (Lisp_Object prefix)
701 702 703 704 705
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
706

707
DEFUE ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
708 709
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
710
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
711
the current buffer's value of `default-directory' is used.
712 713
NAME should be a string that is a valid file name for the underlying
filesystem.
714 715 716 717
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.
718 719 720
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.)
721 722
An initial `~/' expands to your home directory.
An initial `~USER/' expands to USER's home directory.
Chong Yidong's avatar
Chong Yidong committed
723 724 725 726 727
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
728
\(directory-file-name (file-name-directory dirname)) to traverse a
Chong Yidong's avatar
Chong Yidong committed
729
filesystem tree, not (expand-file-name ".."  dirname).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
730
  (Lisp_Object name, Lisp_Object default_directory)
Jim Blandy's avatar
Jim Blandy committed
731
{
732 733
  /* These point to SDATA and need to be careful with string-relocation
     during GC (via DECODE_FILE).  */
734 735
  char *nm;
  const char *newdir;
736
  /* This should only point to alloca'd data.  */
737
  char *target;
738

Jim Blandy's avatar
Jim Blandy committed
739 740
  int tlen;
  struct passwd *pw;
741
#ifdef DOS_NT
742
  int drive = 0;
743
  int collapse_newdir = 1;
744
  int is_escaped = 0;
745
#endif /* DOS_NT */
746
  int length;
747
  Lisp_Object handler, result;
748
  int multibyte;
749
  Lisp_Object hdir;
750

751
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
752

753 754
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
755
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
756
  if (!NILP (handler))
757
    return call3 (handler, Qexpand_file_name, name, default_directory);
758

759 760
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
Tom Tromey's avatar
Tom Tromey committed
761
    default_directory = BVAR (current_buffer, directory);
762
  if (! STRINGP (default_directory))
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
    {
#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
    }
778

779
  if (!NILP (default_directory))
780
    {
781
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
782
      if (!NILP (handler))
783
	return call3 (handler, Qexpand_file_name, name, default_directory);
784
    }
785

786
  {
787
    char *o = SSDATA (default_directory);
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802

    /* 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.  */
803
#ifdef DOS_NT
804 805 806
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
807
#ifdef WINDOWSNT
808 809
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
810
#endif
811 812 813
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
814
	&& ! (IS_DIRECTORY_SEP (o[0]))
815
#endif /* not DOS_NT */
816 817 818
	)
      {
	struct gcpro gcpro1;
819

820 821 822 823 824
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
825
  name = FILE_SYSTEM_CASE (name);
826
  multibyte = STRING_MULTIBYTE (name);
827 828 829 830 831 832 833 834 835 836 837
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

838
  /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
839 840
  nm = (char *) alloca (SBYTES (name) + 1);
  memcpy (nm, SSDATA (name), SBYTES (name) + 1);
841

842
#ifdef DOS_NT
843 844 845 846 847 848 849
  /* Note if special escape prefix is present, but remove for now.  */
  if (nm[0] == '/' && nm[1] == ':')
    {
      is_escaped = 1;
      nm += 2;
    }

850
  /* Find and remove drive specifier if present; this makes nm absolute
851 852 853 854
     even if the rest of the name appears to be relative.  Only look for
     drive specifier at the beginning.  */
  if (IS_DRIVE (nm[0]) && IS_DEVICE_SEP (nm[1]))
    {
855
      drive = (unsigned char) nm[0];
856 857
      nm += 2;
    }
858 859 860 861 862 863