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 91 92 93 94 95 96
/* Nonzero during writing of auto-save files */
int auto_saving;

/* 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 */
int auto_save_mode_bits;

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

100 101 102 103 104 105 106
/* 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.  */
Lisp_Object Qauto_save_coding;

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

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

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

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

123 124 125
#ifdef HAVE_FSYNC
#endif

126 127
Lisp_Object Qdelete_by_moving_to_trash;

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

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

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

137 138 139
#ifdef WINDOWSNT
#endif

140
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
141
Lisp_Object Qexcl;
142 143
Lisp_Object Qfile_name_history;

144 145
Lisp_Object Qcar_less_than_car;

146 147 148
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 *);
149

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

158
  synchronize_system_messages_locale ();
159 160 161
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
162 163
					    Vlocale_coding_system, 0);

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

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

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

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

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

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

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

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

258
  result = Qnil;
259
  CHECK_STRING (filename);
260

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

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

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

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

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

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

318
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
319

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

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

335 336
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
337 338 339 340 341
	 /* 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))))
342
#endif
Jim Blandy's avatar
Jim Blandy committed
343 344 345 346
	 ) p--;

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

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

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

373
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
374 375
}

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

387
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
388

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

395
  beg = SSDATA (filename);
396
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
397

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

408
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
409
}
410

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

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

  return Ffile_name_directory (filename);
}

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

  strcpy (out, in);

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

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

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

476
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
477
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
478
    return Qnil;
479 480 481

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

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

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

499
static int
500
directory_file_name (char *src, char *dst)
Jim Blandy's avatar
Jim Blandy committed
501 502 503 504
{
  long slen;

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

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

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

534
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
535

Jim Blandy's avatar
Jim Blandy committed
536
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
537
    return Qnil;
538 539 540

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

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

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

563 564
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

565
/* Value is a temporary file name starting with PREFIX, a string.
566

567 568 569 570 571
   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.
572

573 574 575 576 577 578 579 580 581
   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
582
make_temp_name (Lisp_Object prefix, int base64_p)
Jim Blandy's avatar
Jim Blandy committed
583 584
{
  Lisp_Object val;
585
  int len, clen;
586
  int pid;
587
  char *p, *data;
588 589
  char pidbuf[20];
  int pidlen;
590

591
  CHECK_STRING (prefix);
592 593 594 595 596 597 598 599

  /* 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 ();

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

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

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

640 641 642 643 644 645 646 647 648
  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;
649
      unsigned num = make_temp_name_count;
650 651 652 653 654

      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;

655 656 657 658 659
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

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

680 681

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


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

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

748
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
749

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

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

776
  if (!NILP (default_directory))
777
    {
778
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
779
      if (!NILP (handler))
780
	return call3 (handler, Qexpand_file_name, name, default_directory);
781
    }
782

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

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

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

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

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

847
  /* Find and remove drive specifier if present; this makes nm absolute
848 849 850 851
     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]))
    {
852
      drive = (unsigned char) nm[0];
853 854
      nm += 2;
    }
855 856 857 858 859 860 861

#ifdef WINDOWSNT
  /* If we see "c://somedir", we want to strip the first slash after the
     colon when stripping the drive letter.  Otherwise, this expands to
     "//somedir".  */
  if (drive && IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
    nm++;
862

863 864 865 866 867
  /* Discard any previous drive specifier if nm is now in UNC format. */
  if (IS_DIRECTORY_SEP (nm[0]) && IS_DIRECTORY_SEP (nm[1]))
    {
      drive = 0;
    }
868 869
#endif /* WINDOWSNT */
#endif /* DOS_NT */
870

871 872 873
  /* If nm is absolute, look for `/./' or `/../' or `//''sequences; if
     none are found, we can probably return right away.  We will avoid
     allocating a new string if name is already fully expanded.  */
Jim Blandy's avatar
Jim Blandy committed
874
  if (
875
      IS_DIRECTORY_SEP (nm[0])
876
#ifdef MSDOS
877
      && drive && !is_escaped
878 879
#endif
#ifdef WINDOWSNT
880
      && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
881
#endif
Jim Blandy's avatar
Jim Blandy committed
882 883
      )
    {
884 885 886 887 888 889 890
      /* If it turns out that the filename we want to return is just a
	 suffix of FILENAME, we don't need to go through and edit
	 things; we just need to construct a new string using data
	 starting at the middle of FILENAME.  If we set lose to a
	 non-zero value, that means we've discovered that we can't do
	 that cool trick.  */
      int lose = 0;
891
      char *p = nm;
892

Jim Blandy's avatar
Jim Blandy committed
893 894
      while (*p)
	{
895
	  /* Since we know the name is absolute, we can assume that each
896 897 898
	     element starts with a "/".  */

	  /* "." and ".." are hairy.  */
899
	  if (IS_DIRECTORY_SEP (p[0])
900
	      && p[1] == '.'
901
	      && (IS_DIRECTORY_SEP (p[2])
902
		  || p[2] == 0
903
		  || (p[2] == '.' && (IS_DIRECTORY_SEP (p[3])
904
				      || p[3] == 0))))
Jim Blandy's avatar
Jim Blandy committed
905
	    lose = 1;
906 907 908 909 910 911
	  /* We want to replace multiple `/' in a row with a single
	     slash.  */
	  else if (p > nm
		   && IS_DIRECTORY_SEP (p[0])
		   && IS_DIRECTORY_SEP (p[1]))
	    lose = 1;
Jim Blandy's avatar
Jim Blandy committed
912 913 914 915
	  p++;
	}
      if (!lose)
	{
916
#ifdef DOS_NT
917 918 919
	  /* Make sure directories are all separated with /, but
	     avoid allocation of a new string when not required. */
	  dostounix_filename (nm);
920 921 922
#ifdef WINDOWSNT
	  if (IS_DIRECTORY_SEP (nm[1]))
	    {
923
	      if (strcmp (nm, SSDATA (name)) != 0)
924
		name = make_specified_string (nm, -1, strlen (nm), multibyte);
925 926 927 928
	    }
	  else
#endif
	  /* drive must be set, so this is okay */
929
	  if (strcmp (nm - 2, SSDATA (name)) != 0)
930
	    {
931 932
	      char temp[] = " :";

933
	      name = make_specified_string (nm, -1, p - nm, multibyte);
934 935
	      temp[0] = DRIVE_LETTER (drive);
	      name = concat2 (build_string (temp), name);
936 937 938
	    }
	  return name;
#else /* not DOS_NT */
939
	  if (strcmp (nm, SSDATA (name)) == 0)
Jim Blandy's avatar
Jim Blandy committed
940
	    return name;
941
	  return make_specified_string (nm, -1, strlen (nm), multibyte);
942
#endif /* not DOS_NT */
Jim Blandy's avatar
Jim Blandy committed
943 944 945
	}
    }

946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
  /* At this point, nm might or might not be an absolute file name.  We
     need to expand ~ or ~user if present, otherwise prefix nm with
     default_directory if nm is not absolute, and finally collapse /./
     and /foo/../ sequences.

     We set newdir to be the appropriate prefix if one is needed:
       - the relevant user directory if nm starts with ~ or ~user
       - the specified drive's working dir (DOS/NT only) if nm does not
         start with /
       - the value of default_directory.

     Note that these prefixes are not guaranteed to be absolute (except
     for the working dir of a drive).  Therefore, to ensure we always
     return an absolute name, if the final prefix is not absolute we
     append it to the current working directory.  */