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
INFUN (Fmake_symbolic_link, 3);
147 148 149
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 *);
150

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

159
  synchronize_system_messages_locale ();
160 161 162
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (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
Lisp_Object Qexpand_file_name;
209
Lisp_Object Qsubstitute_in_file_name;
210 211 212
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
213
Lisp_Object Qunhandled_file_name_directory;
214
Lisp_Object Qfile_name_as_directory;
215
Lisp_Object Qcopy_file;
216
Lisp_Object Qmake_directory_internal;
217
Lisp_Object Qmake_directory;
218
Lisp_Object Qdelete_directory_internal;
219 220 221 222 223 224 225 226
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;
227 228
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
229
Lisp_Object Qfile_directory_p;
230
Lisp_Object Qfile_regular_p;
231 232 233
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
234
Lisp_Object Qset_file_times;
Karel Klíc's avatar
Karel Klíc committed
235 236
Lisp_Object Qfile_selinux_context;
Lisp_Object Qset_file_selinux_context;
237 238 239 240
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
241
Lisp_Object Qset_visited_file_modtime;
242

243 244
DEFUE ("find-file-name-handler", Ffind_file_name_handler,
       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
  int 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
	  EMACS_INT 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
}

304
DEFUE ("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
    return call2 (handler, Qfile_name_directory, filename);
327

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return Ffile_name_directory (filename);
}

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

  strcpy (out, in);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

565 566
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

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

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

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

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

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

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

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

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

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

      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;

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

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

682 683

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


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

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

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

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

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

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

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

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

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

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

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

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

#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++;
864

865 866 867 868 869
  /* 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;
    }
870 871
#endif /* WINDOWSNT */
#endif /* DOS_NT */
872

873 874 875
  /* 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
876
  if (
877
      IS_DIRECTORY_SEP (nm[0])
878
#ifdef MSDOS
879
      && drive && !is_escaped
880 881
#endif
#ifdef WINDOWSNT
882
      && (drive || IS_DIRECTORY_SEP (nm[1])) && !is_escaped
883
#endif
Jim Blandy's avatar
Jim Blandy committed
884 885
      )
    {
886 887 888 889 890 891 892
      /* 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;
893
      char *p = nm;
894

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

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

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