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

Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1996, 1997,
  1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
  2009, 2010, 2011  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6 7 8

This file is part of GNU Emacs.

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

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
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
21

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

30 31 32 33
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

34 35 36 37
#if !defined (S_ISLNK) && defined (S_IFLNK)
#  define S_ISLNK(m) (((m) & S_IFMT) == S_IFLNK)
#endif

38 39 40 41
#if !defined (S_ISFIFO) && defined (S_IFIFO)
#  define S_ISFIFO(m) (((m) & S_IFMT) == S_IFIFO)
#endif

42 43 44 45
#if !defined (S_ISREG) && defined (S_IFREG)
#  define S_ISREG(m) (((m) & S_IFMT) == S_IFREG)
#endif

46
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
47
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
48 49
#endif

Jim Blandy's avatar
Jim Blandy committed
50 51 52
#include <ctype.h>
#include <errno.h>

Karel Klíc's avatar
Karel Klíc committed
53 54 55 56 57
#ifdef HAVE_LIBSELINUX
#include <selinux/selinux.h>
#include <selinux/context.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
58
#include "lisp.h"
59
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
60
#include "buffer.h"
61
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
62
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
63
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
64
#include "blockinput.h"
Karoly Lorentey's avatar
Karoly Lorentey committed
65 66
#include "frame.h"
#include "dispextern.h"
Jim Blandy's avatar
Jim Blandy committed
67

68 69 70 71 72 73
#ifdef WINDOWSNT
#define NOMINMAX 1
#include <windows.h>
#include <fcntl.h>
#endif /* not WINDOWSNT */

Eli Zaretskii's avatar
Eli Zaretskii committed
74 75 76 77 78 79
#ifdef MSDOS
#include "msdos.h"
#include <sys/param.h>
#include <fcntl.h>
#endif

80 81 82 83 84 85 86 87 88
#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
#define IS_DRIVE(x) isalpha (x)
#endif
89 90 91 92
/* 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.  */
#define DRIVE_LETTER(x) (tolower (x))
93 94
#endif

Jim Blandy's avatar
Jim Blandy committed
95
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
96 97 98

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

101 102
#include "commands.h"

103 104 105 106
#ifndef S_ISLNK
#  define lstat stat
#endif

107 108 109 110
#ifndef FILE_SYSTEM_CASE
#define FILE_SYSTEM_CASE(filename)  (filename)
#endif

Jim Blandy's avatar
Jim Blandy committed
111 112 113 114 115 116 117
/* 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;

118 119 120
/* Set by auto_save_1 if an error occurred during the last auto-save. */
int auto_save_error_occurred;

121 122 123 124 125 126 127
/* 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;

128 129 130
/* Coding system for file names, or nil if none.  */
Lisp_Object Vfile_name_coding_system;

131 132 133 134
/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
Lisp_Object Vdefault_file_name_coding_system;

135
/* Alist of elements (REGEXP . HANDLER) for file names
136 137 138
   whose I/O is done with a special handler.  */
Lisp_Object Vfile_name_handler_alist;

139 140 141 142
/* Property name of a file name handler,
   which gives a list of operations it handles..  */
Lisp_Object Qoperations;

143 144 145
/* Lisp functions for translating file formats */
Lisp_Object Qformat_decode, Qformat_annotate_function;

146
/* Function to be called to decide a coding system of a reading file.  */
147
Lisp_Object Vset_auto_coding_function;
148

149 150 151
/* Functions to be called to process text properties in inserted file.  */
Lisp_Object Vafter_insert_file_functions;

152
/* Lisp function for setting buffer-file-coding-system and the
153
   multibyteness of the current buffer after inserting a file.  */
154
Lisp_Object Qafter_insert_file_set_coding;
155

156 157
/* Functions to be called to create text property annotations for file.  */
Lisp_Object Vwrite_region_annotate_functions;
158
Lisp_Object Qwrite_region_annotate_functions;
159
Lisp_Object Vwrite_region_post_annotation_function;
160

161 162 163 164
/* During build_annotations, each time an annotation function is called,
   this holds the annotations made by the previous functions.  */
Lisp_Object Vwrite_region_annotations_so_far;

165 166 167 168
/* Each time an annotation function changes the buffer, the new buffer
   is added here.  */
Lisp_Object Vwrite_region_annotation_buffers;

169 170 171
/* File name in which we write a list of all our auto save files.  */
Lisp_Object Vauto_save_list_file_name;

172 173 174
/* Whether or not files are auto-saved into themselves.  */
Lisp_Object Vauto_save_visited_file_name;

175 176 177
/* Whether or not to continue auto-saving after a large deletion.  */
Lisp_Object Vauto_save_include_big_deletions;

178 179 180 181 182
#ifdef HAVE_FSYNC
/* Nonzero means skip the call to fsync in Fwrite-region.  */
int write_region_inhibit_fsync;
#endif

183
/* Non-zero means call move-file-to-trash in Fdelete_file or
184
   Fdelete_directory_internal.  */
185 186
int delete_by_moving_to_trash;

187 188
Lisp_Object Qdelete_by_moving_to_trash;

189 190 191
/* Lisp function for moving files to trash.  */
Lisp_Object Qmove_file_to_trash;

192 193 194 195 196 197
/* Lisp function for recursively copying directories.  */
Lisp_Object Qcopy_directory;

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

198 199 200 201
#ifdef WINDOWSNT
extern Lisp_Object Vw32_get_true_file_attributes;
#endif

202 203 204 205 206 207 208
/* These variables describe handlers that have "already" had a chance
   to handle the current operation.

   Vinhibit_file_name_handlers is a list of file name handlers.
   Vinhibit_file_name_operation is the operation being handled.
   If we try to handle that operation, we ignore those handlers.  */

209
static Lisp_Object Vinhibit_file_name_handlers;
210
static Lisp_Object Vinhibit_file_name_operation;
211

212
Lisp_Object Qfile_error, Qfile_already_exists, Qfile_date_error;
Richard M. Stallman's avatar
Richard M. Stallman committed
213
Lisp_Object Qexcl;
214 215
Lisp_Object Qfile_name_history;

216 217
Lisp_Object Qcar_less_than_car;

218 219 220
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 *);
221

222

223
void
224
report_file_error (const char *string, Lisp_Object data)
Jim Blandy's avatar
Jim Blandy committed
225 226
{
  Lisp_Object errstring;
Richard M. Stallman's avatar
Richard M. Stallman committed
227
  int errorno = errno;
228
  char *str;
Jim Blandy's avatar
Jim Blandy committed
229

230
  synchronize_system_messages_locale ();
231 232 233
  str = strerror (errorno);
  errstring = code_convert_string_norecord (make_unibyte_string (str,
								 strlen (str)),
234 235
					    Vlocale_coding_system, 0);

Jim Blandy's avatar
Jim Blandy committed
236
  while (1)
Richard M. Stallman's avatar
Richard M. Stallman committed
237 238 239
    switch (errorno)
      {
      case EEXIST:
240
	xsignal (Qfile_already_exists, Fcons (errstring, data));
Richard M. Stallman's avatar
Richard M. Stallman committed
241 242 243
	break;
      default:
	/* System error messages are capitalized.  Downcase the initial
244 245
	   unless it is followed by a slash.  (The slash case caters to
	   error messages that begin with "I/O" or, in German, "E/A".)  */
246 247
	if (STRING_MULTIBYTE (errstring)
	    && ! EQ (Faref (errstring, make_number (1)), make_number ('/')))
248 249 250 251
	  {
	    int c;

	    str = (char *) SDATA (errstring);
252
	    c = STRING_CHAR (str);
Stefan Monnier's avatar
Stefan Monnier committed
253
	    Faset (errstring, make_number (0), make_number (DOWNCASE (c)));
254
	  }
Richard M. Stallman's avatar
Richard M. Stallman committed
255

256
	xsignal (Qfile_error,
Richard M. Stallman's avatar
Richard M. Stallman committed
257 258
		 Fcons (build_string (string), Fcons (errstring, data)));
      }
Jim Blandy's avatar
Jim Blandy committed
259
}
260

261
Lisp_Object
262
close_file_unwind (Lisp_Object fd)
263
{
264
  emacs_close (XFASTINT (fd));
265
  return Qnil;
266
}
267 268 269

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

Andreas Schwab's avatar
Andreas Schwab committed
270
Lisp_Object
271
restore_point_unwind (Lisp_Object location)
272
{
273
  Fgoto_char (location);
274
  Fset_marker (location, Qnil, Qnil);
275
  return Qnil;
276
}
277

Jim Blandy's avatar
Jim Blandy committed
278

279
Lisp_Object Qexpand_file_name;
280
Lisp_Object Qsubstitute_in_file_name;
281 282 283
Lisp_Object Qdirectory_file_name;
Lisp_Object Qfile_name_directory;
Lisp_Object Qfile_name_nondirectory;
284
Lisp_Object Qunhandled_file_name_directory;
285
Lisp_Object Qfile_name_as_directory;
286
Lisp_Object Qcopy_file;
287
Lisp_Object Qmake_directory_internal;
288
Lisp_Object Qmake_directory;
289
Lisp_Object Qdelete_directory_internal;
290 291 292 293 294 295 296 297
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;
298 299
Lisp_Object Qfile_symlink_p;
Lisp_Object Qaccess_file;
300
Lisp_Object Qfile_directory_p;
301
Lisp_Object Qfile_regular_p;
302 303 304
Lisp_Object Qfile_accessible_directory_p;
Lisp_Object Qfile_modes;
Lisp_Object Qset_file_modes;
305
Lisp_Object Qset_file_times;
Karel Klíc's avatar
Karel Klíc committed
306 307
Lisp_Object Qfile_selinux_context;
Lisp_Object Qset_file_selinux_context;
308 309 310 311
Lisp_Object Qfile_newer_than_file_p;
Lisp_Object Qinsert_file_contents;
Lisp_Object Qwrite_region;
Lisp_Object Qverify_visited_file_modtime;
312
Lisp_Object Qset_visited_file_modtime;
313

314
DEFUN ("find-file-name-handler", Ffind_file_name_handler, Sfind_file_name_handler, 2, 2, 0,
315 316 317 318 319 320 321 322 323
       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
324
  (Lisp_Object filename, Lisp_Object operation)
325
{
326
  /* This function must not munge the match data.  */
327
  Lisp_Object chain, inhibited_handlers, result;
328
  int pos = -1;
329

330
  result = Qnil;
331
  CHECK_STRING (filename);
332

333 334 335 336
  if (EQ (operation, Vinhibit_file_name_operation))
    inhibited_handlers = Vinhibit_file_name_handlers;
  else
    inhibited_handlers = Qnil;
337

338
  for (chain = Vfile_name_handler_alist; CONSP (chain);
339
       chain = XCDR (chain))
340 341
    {
      Lisp_Object elt;
342
      elt = XCAR (chain);
343
      if (CONSP (elt))
344
	{
345
	  Lisp_Object string = XCAR (elt);
346
	  int match_pos;
347
	  Lisp_Object handler = XCDR (elt);
348 349 350 351
	  Lisp_Object operations = Qnil;

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

353
	  if (STRINGP (string)
354 355
	      && (match_pos = fast_string_match (string, filename)) > pos
	      && (NILP (operations) || ! NILP (Fmemq (operation, operations))))
356
	    {
357
	      Lisp_Object tem;
358

359
	      handler = XCDR (elt);
360 361
	      tem = Fmemq (handler, inhibited_handlers);
	      if (NILP (tem))
362 363 364 365
		{
		  result = handler;
		  pos = match_pos;
		}
366
	    }
367
	}
368 369

      QUIT;
370
    }
371
  return result;
372 373
}

Jim Blandy's avatar
Jim Blandy committed
374
DEFUN ("file-name-directory", Ffile_name_directory, Sfile_name_directory,
375 376 377
       1, 1, 0,
       doc: /* Return the directory component in file name FILENAME.
Return nil if FILENAME does not include a directory.
378
Otherwise return a directory name.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
379
Given a Unix syntax file name, returns a string ending in slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
380
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
381
{
382
#ifndef DOS_NT
383
  register const unsigned char *beg;
384 385 386
#else
  register unsigned char *beg;
#endif
387
  register const unsigned char *p;
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_directory);
395
  if (!NILP (handler))
396
    return call2 (handler, Qfile_name_directory, filename);
397

398
  filename = FILE_SYSTEM_CASE (filename);
399
#ifdef DOS_NT
400
  beg = (unsigned char *) alloca (SBYTES (filename) + 1);
401
  memcpy (beg, SDATA (filename), SBYTES (filename) + 1);
402 403
#else
  beg = SDATA (filename);
404
#endif
405
  p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
406

407 408
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
409 410 411 412 413
	 /* 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))))
414
#endif
Jim Blandy's avatar
Jim Blandy committed
415 416 417 418
	 ) p--;

  if (p == beg)
    return Qnil;
419
#ifdef DOS_NT
420
  /* Expansion of "c:" to drive and default directory.  */
421
  if (p[-1] == ':')
422 423
    {
      /* MAXPATHLEN+1 is guaranteed to be enough space for getdefdir.  */
424
      unsigned char *res = alloca (MAXPATHLEN + 1);
425 426 427 428 429 430 431 432 433 434
      unsigned char *r = res;

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

      if (getdefdir (toupper (*beg) - 'A' + 1, r))
435
	{
436
	  if (!IS_DIRECTORY_SEP (res[strlen (res) - 1]))
437 438 439 440 441
	    strcat (res, "/");
	  beg = res;
	  p = beg + strlen (beg);
	}
    }
442
  dostounix_filename (beg);
443
#endif /* DOS_NT */
444

445
  return make_specified_string (beg, -1, p - beg, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
446 447
}

448 449
DEFUN ("file-name-nondirectory", Ffile_name_nondirectory,
       Sfile_name_nondirectory, 1, 1, 0,
450 451 452 453
       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
454
  (Lisp_Object filename)
Jim Blandy's avatar
Jim Blandy committed
455
{
456
  register const unsigned char *beg, *p, *end;
457
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
458

459
  CHECK_STRING (filename);
Jim Blandy's avatar
Jim Blandy committed
460

461 462
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
463
  handler = Ffind_file_name_handler (filename, Qfile_name_nondirectory);
464
  if (!NILP (handler))
465
    return call2 (handler, Qfile_name_nondirectory, filename);
466

467 468
  beg = SDATA (filename);
  end = p = beg + SBYTES (filename);
Jim Blandy's avatar
Jim Blandy committed
469

470 471 472
  while (p != beg && !IS_DIRECTORY_SEP (p[-1])
#ifdef DOS_NT
	 /* only recognise drive specifier at beginning */
473 474 475
	 && !(p[-1] == ':'
	      /* handle the "/:d:foo" case correctly  */
	      && (p == beg + 2 || (p == beg + 4 && IS_DIRECTORY_SEP (*beg))))
476
#endif
477 478
	 )
    p--;
Jim Blandy's avatar
Jim Blandy committed
479

480
  return make_specified_string (p, -1, end - p, STRING_MULTIBYTE (filename));
Jim Blandy's avatar
Jim Blandy committed
481
}
482

483 484
DEFUN ("unhandled-file-name-directory", Funhandled_file_name_directory,
       Sunhandled_file_name_directory, 1, 1, 0,
485 486 487 488 489
       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
490 491
If FILENAME refers to a file which is not accessible from a local process,
then this should return nil.
492 493
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
494
  (Lisp_Object filename)
495 496 497 498 499
{
  Lisp_Object handler;

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
500
  handler = Ffind_file_name_handler (filename, Qunhandled_file_name_directory);
501 502 503 504 505 506
  if (!NILP (handler))
    return call2 (handler, Qunhandled_file_name_directory, filename);

  return Ffile_name_directory (filename);
}

Jim Blandy's avatar
Jim Blandy committed
507 508

char *
509
file_name_as_directory (char *out, char *in)
Jim Blandy's avatar
Jim Blandy committed
510 511 512 513 514
{
  int size = strlen (in) - 1;

  strcpy (out, in);

515 516
  if (size < 0)
    {
517 518 519
      out[0] = '.';
      out[1] = '/';
      out[2] = 0;
520 521 522
      return out;
    }

Jim Blandy's avatar
Jim Blandy committed
523
  /* For Unix syntax, Append a slash if necessary */
524
  if (!IS_DIRECTORY_SEP (out[size]))
525
    {
526
      out[size + 1] = DIRECTORY_SEP;
527 528
      out[size + 2] = '\0';
    }
529
#ifdef DOS_NT
530
  dostounix_filename (out);
531
#endif
Jim Blandy's avatar
Jim Blandy committed
532 533 534 535 536
  return out;
}

DEFUN ("file-name-as-directory", Ffile_name_as_directory,
       Sfile_name_as_directory, 1, 1, 0,
537
       doc: /* Return a string representing the file name FILE interpreted as a directory.
538 539 540 541
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
542
For a Unix-syntax file name, just appends a slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
543
  (Lisp_Object file)
Jim Blandy's avatar
Jim Blandy committed
544 545
{
  char *buf;
546
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
547

548
  CHECK_STRING (file);
Jim Blandy's avatar
Jim Blandy committed
549
  if (NILP (file))
Jim Blandy's avatar
Jim Blandy committed
550
    return Qnil;
551 552 553

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
554
  handler = Ffind_file_name_handler (file, Qfile_name_as_directory);
555 556 557
  if (!NILP (handler))
    return call2 (handler, Qfile_name_as_directory, file);

558
  buf = (char *) alloca (SBYTES (file) + 10);
559 560 561
  file_name_as_directory (buf, SDATA (file));
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (file));
Jim Blandy's avatar
Jim Blandy committed
562 563 564 565
}

/*
 * Convert from directory name to filename.
566
 * On UNIX, it's simple: just make sure there isn't a terminating /
Jim Blandy's avatar
Jim Blandy committed
567 568 569 570

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

Andreas Schwab's avatar
Andreas Schwab committed
571
int
572
directory_file_name (char *src, char *dst)
Jim Blandy's avatar
Jim Blandy committed
573 574 575 576
{
  long slen;

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

Jim Blandy's avatar
Jim Blandy committed
578 579 580
  /* Process as Unix format: just remove any final slash.
     But leave "/" unchanged; do not change it to "".  */
  strcpy (dst, src);
581
  if (slen > 1
582
      && IS_DIRECTORY_SEP (dst[slen - 1])
583 584 585 586
#ifdef DOS_NT
      && !IS_ANY_SEP (dst[slen - 2])
#endif
      )
Jim Blandy's avatar
Jim Blandy committed
587
    dst[slen - 1] = 0;
588
#ifdef DOS_NT
589
  dostounix_filename (dst);
590
#endif
Jim Blandy's avatar
Jim Blandy committed
591 592 593 594
  return 1;
}

DEFUN ("directory-file-name", Fdirectory_file_name, Sdirectory_file_name,
595 596 597 598 599
       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
600
In Unix-syntax, this function just removes the final slash.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
601
  (Lisp_Object directory)
Jim Blandy's avatar
Jim Blandy committed
602 603
{
  char *buf;
604
  Lisp_Object handler;
Jim Blandy's avatar
Jim Blandy committed
605

606
  CHECK_STRING (directory);
Jim Blandy's avatar
Jim Blandy committed
607

Jim Blandy's avatar
Jim Blandy committed
608
  if (NILP (directory))
Jim Blandy's avatar
Jim Blandy committed
609
    return Qnil;
610 611 612

  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
613
  handler = Ffind_file_name_handler (directory, Qdirectory_file_name);
614 615 616
  if (!NILP (handler))
    return call2 (handler, Qdirectory_file_name, directory);

617 618
  buf = (char *) alloca (SBYTES (directory) + 20);
  directory_file_name (SDATA (directory), buf);
619 620
  return make_specified_string (buf, -1, strlen (buf),
				STRING_MULTIBYTE (directory));
Jim Blandy's avatar
Jim Blandy committed
621 622
}

623
static const char make_temp_name_tbl[64] =
624 625 626 627 628 629 630 631 632 633
{
  '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','-','_'
};
634

635 636
static unsigned make_temp_name_count, make_temp_name_count_initialized_p;

637
/* Value is a temporary file name starting with PREFIX, a string.
638

639 640 641 642 643
   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.
644

645 646 647 648 649 650 651 652 653
   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
654
make_temp_name (Lisp_Object prefix, int base64_p)
Jim Blandy's avatar
Jim Blandy committed
655 656
{
  Lisp_Object val;
657
  int len, clen;
658 659 660 661
  int pid;
  unsigned char *p, *data;
  char pidbuf[20];
  int pidlen;
662

663
  CHECK_STRING (prefix);
664 665 666 667 668 669 670 671

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

672 673 674 675 676 677 678 679 680
  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
    {
681
#ifdef HAVE_LONG_FILE_NAMES
682 683
      sprintf (pidbuf, "%d", pid);
      pidlen = strlen (pidbuf);
684
#else
685 686 687 688
      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;
689
#endif
690
    }
691

692 693 694 695
  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);
696
  data = SDATA (val);
697
  memcpy (data, SDATA (prefix), len);
698 699
  p = data + len;

700
  memcpy (p, pidbuf, pidlen);
701 702 703 704 705
  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
706 707 708 709 710 711
     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.  */

712 713 714 715 716 717 718 719 720
  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;
721
      unsigned num = make_temp_name_count;
722 723 724 725 726

      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;

727 728 729 730 731
      /* Poor man's congruential RN generator.  Replace with
         ++make_temp_name_count for debugging.  */
      make_temp_name_count += 25229;
      make_temp_name_count %= 225307;

732 733 734 735 736 737 738 739 740 741
      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
742 743 744
	       in looping through 225307 stat's, which is not only
	       dog-slow, but also useless since it will fallback to
	       the errow below, anyway.  */
745
	    report_file_error ("Cannot create temporary name for prefix",
746 747 748 749 750 751
			       Fcons (prefix, Qnil));
	  /* not reached */
	}
    }

  error ("Cannot create temporary name for prefix `%s'",
752
	 SDATA (prefix));
753
  return Qnil;
Jim Blandy's avatar
Jim Blandy committed
754
}
755

756 757

DEFUN ("make-temp-name", Fmake_temp_name, Smake_temp_name, 1, 1, 0,
758 759 760 761 762 763 764 765 766 767
       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
768 769 770 771 772
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
773
  (Lisp_Object prefix)
774 775 776 777 778
{
  return make_temp_name (prefix, 0);
}


Jim Blandy's avatar
Jim Blandy committed
779 780

DEFUN ("expand-file-name", Fexpand_file_name, Sexpand_file_name, 1, 2, 0,
781 782
       doc: /* Convert filename NAME to absolute, and canonicalize it.
Second arg DEFAULT-DIRECTORY is directory to start with if NAME is relative
783
\(does not start with slash or tilde); if DEFAULT-DIRECTORY is nil or missing,
784
the current buffer's value of `default-directory' is used.
785 786
NAME should be a string that is a valid file name for the underlying
filesystem.
787 788 789 790
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.
791 792 793
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.)
794 795
An initial `~/' expands to your home directory.
An initial `~USER/' expands to USER's home directory.
Chong Yidong's avatar
Chong Yidong committed
796 797 798 799 800
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
801
\(directory-file-name (file-name-directory dirname)) to traverse a
Chong Yidong's avatar
Chong Yidong committed
802
filesystem tree, not (expand-file-name ".."  dirname).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
803
  (Lisp_Object name, Lisp_Object default_directory)
Jim Blandy's avatar
Jim Blandy committed
804
{
805 806 807 808 809
  /* These point to SDATA and need to be careful with string-relocation
     during GC (via DECODE_FILE).  */
  unsigned char *nm, *newdir;
  /* This should only point to alloca'd data.  */
  unsigned char *target;
810

Jim Blandy's avatar
Jim Blandy committed
811 812
  int tlen;
  struct passwd *pw;
813
#ifdef DOS_NT
814
  int drive = 0;
815
  int collapse_newdir = 1;
816
  int is_escaped = 0;
817
#endif /* DOS_NT */
818
  int length;
819
  Lisp_Object handler, result;
820
  int multibyte;
821
  Lisp_Object hdir;
822

823
  CHECK_STRING (name);
Jim Blandy's avatar
Jim Blandy committed
824

825 826
  /* If the file name has special constructs in it,
     call the corresponding file handler.  */
827
  handler = Ffind_file_name_handler (name, Qexpand_file_name);
828
  if (!NILP (handler))
829
    return call3 (handler, Qexpand_file_name, name, default_directory);
830

831 832 833
  /* Use the buffer's default-directory if DEFAULT_DIRECTORY is omitted.  */
  if (NILP (default_directory))
    default_directory = current_buffer->directory;
834
  if (! STRINGP (default_directory))
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849
    {
#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
    }
850

851
  if (!NILP (default_directory))
852
    {
853
      handler = Ffind_file_name_handler (default_directory, Qexpand_file_name);
854
      if (!NILP (handler))
855
	return call3 (handler, Qexpand_file_name, name, default_directory);
856
    }
857

858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874
  {
    unsigned char *o = SDATA (default_directory);

    /* 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.  */
875
#ifdef DOS_NT
876 877 878
	/* Detect MSDOS file names with drive specifiers.  */
	&& ! (IS_DRIVE (o[0]) && IS_DEVICE_SEP (o[1])
	      && IS_DIRECTORY_SEP (o[2]))
879
#ifdef WINDOWSNT
880 881
	/* Detect Windows file names in UNC format.  */
	&& ! (IS_DIRECTORY_SEP (o[0]) && IS_DIRECTORY_SEP (o[1]))
882
#endif
883 884 885
#else /* not DOS_NT */
      /* Detect Unix absolute file names (/... alone is not absolute on
	 DOS or Windows).  */
886
	&& ! (IS_DIRECTORY_SEP (o[0]))
887
#endif /* not DOS_NT */
888 889 890
	)
      {
	struct gcpro gcpro1;
891

892 893 894 895 896
	GCPRO1 (name);
	default_directory = Fexpand_file_name (default_directory, Qnil);
	UNGCPRO;
      }
  }
897
  name = FILE_SYSTEM_CASE (name);
898
  multibyte = STRING_MULTIBYTE (name);
899 900 901 902 903 904 905 906 907 908 909
  if (multibyte != STRING_MULTIBYTE (default_directory))
    {
      if (multibyte)
	default_directory = string_to_multibyte (default_directory);
      else
	{
	  name = string_to_multibyte (name);
	  multibyte = 1;
	}
    }

910
  /* Make a local copy of nm[] to protect it from GC in DECODE_FILE below. */
911
  nm = (unsigned char *) alloca (SBYTES (name) + 1);
912
  memcpy (nm, SDATA (name), SBYTES (name) + 1);
913

914
#ifdef DOS_NT
915 916 917 918 919 920 921
  /* Note if special escape prefix is present, but remove for now.  */
  if (nm[0] == '/' && nm[1] == ':')
    {
      is_escaped = 1;
      nm += 2;
    }

922
  /* Find and remove drive specifier if present; this makes nm absolute