Newer
Older
;;; -*- Log: code.log; Package: Lisp -*-
;;; **********************************************************************
;;; This code was written as part of the CMU Common Lisp project at
;;; Carnegie Mellon University, and has been placed in the public domain.
;;; If you want to use this code or any part of CMU Common Lisp, please contact
;;; Scott Fahlman or slisp-group@cs.cmu.edu.
;;;
(ext:file-comment
"$Header: /Volumes/share2/src/cmucl/cvs2git/cvsroot/src/code/filesys.lisp,v 1.63 2001/03/12 12:44:31 pw Exp $")
;;; **********************************************************************
;;;
;;; File system interface functions. This file is pretty UNIX specific.
;;; Written by William Lott
;;;
;;; **********************************************************************
(in-package "LISP")
(export '(truename probe-file user-homedir-pathname directory
rename-file delete-file file-write-date file-author))
(use-package "EXTENSIONS")
(in-package "EXTENSIONS")
(export '(print-directory complete-file ambiguous-files default-directory
file-writable unix-namestring))
(in-package "LISP")
;;;; Unix pathname host support.
;;; Unix namestrings have the following format:
;;; namestring := [ directory ] [ file [ type [ version ]]]
;;; directory := [ "/" | search-list ] { file "/" }*
;;; search-list := [^:/]*:
;;; file := [^/]*
;;; type := "." [^/.]*
;;; version := ".*" | ".~" ([0-9]+ | "*") "~"
;;; Note: this grammer is ambiguous. The string foo.bar.~5~ can be parsed
;;; as either just the file specified or as specifying the file, type, and
;;; version. Therefore, we use the following rules when confronted with
;;; an ambiguous file.type.version string:
;;; - If the first character is a dot, it's part of the file. It is not
;;; considered a dot in the following rules.
;;; - If there is only one dot, it seperates the file and the type.
;;;
;;; - If there are multiple dots and the stuff following the last dot
;;; is a valid version, then that is the version and the stuff between
;;; the second to last dot and the last dot is the type.
;;;
;;; Wildcard characters:
;;;
;;; If the directory, file, type components contain any of the following
;;; characters, it is considered part of a wildcard pattern and has the
;;; following meaning.
;;;
;;; ? - matches any character
;;; * - matches any zero or more characters.
;;; [abc] - matches any of a, b, or c.
;;; {str1,str2,...,strn} - matches any of str1, str2, ..., or strn.
;;;
;;; Any of these special characters can be preceeded by a backslash to
;;; cause it to be treated as a regular character.
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
(defun remove-backslashes (namestr start end)
"Remove and occurences of \\ from the string because we've already
checked for whatever they may have been backslashed."
(declare (type simple-base-string namestr)
(type index start end))
(let* ((result (make-string (- end start)))
(dst 0)
(quoted nil))
(do ((src start (1+ src)))
((= src end))
(cond (quoted
(setf (schar result dst) (schar namestr src))
(setf quoted nil)
(incf dst))
(t
(let ((char (schar namestr src)))
(cond ((char= char #\\)
(setq quoted t))
(t
(setf (schar result dst) char)
(incf dst)))))))
(when quoted
(error 'namestring-parse-error
:complaint "Backslash in bad place."
:namestring namestr
:offset (1- end)))
(shrink-vector result dst)))
(defvar *ignore-wildcards* nil)
(defun maybe-make-pattern (namestr start end)
(declare (type simple-base-string namestr)
(type index start end))
(if *ignore-wildcards*
(subseq namestr start end)
(collect ((pattern))
(let ((quoted nil)
(any-quotes nil)
(last-regular-char nil)
(index start))
(flet ((flush-pending-regulars ()
(when last-regular-char
(pattern (if any-quotes
(remove-backslashes namestr
last-regular-char
index)
(subseq namestr last-regular-char index)))
(setf any-quotes nil)
(setf last-regular-char nil))))
(loop
(when (>= index end)
(return))
(let ((char (schar namestr index)))
(cond (quoted
(incf index)
(setf quoted nil))
((char= char #\\)
(setf quoted t)
(setf any-quotes t)
(unless last-regular-char
(setf last-regular-char index))
(incf index))
((char= char #\?)
(flush-pending-regulars)
(pattern :single-char-wild)
(incf index))
((char= char #\*)
(flush-pending-regulars)
(pattern :multi-char-wild)
(incf index))
((char= char #\[)
(flush-pending-regulars)
(let ((close-bracket
(position #\] namestr :start index :end end)))
(unless close-bracket
(error 'namestring-parse-error
:complaint "``['' with no corresponding ``]''"
:namestring namestr
:offset index))
(pattern (list :character-set
(subseq namestr
(1+ index)
close-bracket)))
(setf index (1+ close-bracket))))
(t
(unless last-regular-char
(setf last-regular-char index))
(incf index)))))
(flush-pending-regulars)))
(cond ((null (pattern))
"")
((null (cdr (pattern)))
(let ((piece (first (pattern))))
(typecase piece
((member :multi-char-wild) :wild)
(simple-string piece)
(t
(make-pattern (pattern))))))
(t
(make-pattern (pattern)))))))
;;; extract-name-type-and-version -- Internal.
;;;
(defun extract-name-type-and-version (namestr start end)
(declare (type simple-base-string namestr)
(type index start end))
(labels
((explicit-version (namestr start end)
(cond ((or (< (- end start) 5)
(char/= (schar namestr (1- end)) #\~))
(values :newest end))
((and (char= (schar namestr (- end 2)) #\*)
(char= (schar namestr (- end 3)) #\~)
(char= (schar namestr (- end 4)) #\.))
(values :wild (- end 4)))
(t
(do ((i (- end 2) (1- i)))
((< i (+ start 2)) (values :newest end))
(let ((char (schar namestr i)))
(when (eql char #\~)
(return (if (char= (schar namestr (1- i)) #\.)
(values (parse-integer namestr :start (1+ i)
:end (1- end))
(1- i))
(values :newest end))))
(unless (char<= #\0 char #\9)
(return (values :newest end))))))))
(any-version (namestr start end)
;; process end of string looking for a version candidate.
(multiple-value-bind (version where)
(explicit-version namestr start end)
(cond ((not (eq version :newest))
(values version where))
((and (char= (schar namestr (- end 1)) #\*)
(char= (schar namestr (- end 2)) #\.)
(find #\. namestr
:start (min (1+ start) (- end 2))
:end (- end 2)))
(values :wild (- end 2)))
(t (values version where)))))
(any-type (namestr start end)
;; Process end of string looking for a type. A leading "."
;; is part of the name.
(let ((where (position #\. namestr
:start (min (1+ start) end)
:end end :from-end t)))
(when where
(values where end))))
(any-name (namestr start end)
(declare (ignore namestr))
(values start end)))
(multiple-value-bind
(version vstart)(any-version namestr start end)
(multiple-value-bind
(tstart tend)(any-type namestr start vstart)
(multiple-value-bind
(nstart nend)(any-name namestr start (or tstart vstart))
(values
(maybe-make-pattern namestr nstart nend)
(and tstart (maybe-make-pattern namestr (1+ tstart) tend))
version))))))
;;; Take a string and return a list of cons cells that mark the char
;;; separated subseq. The first value t if absolute directories location.
;;;
(defun split-at-slashes (namestr start end)
(declare (type simple-base-string namestr)
(type index start end))
(let ((absolute (and (/= start end)
(char= (schar namestr start) #\/))))
(when absolute
(incf start))
;; Next, split the remainder into slash seperated chunks.
(collect ((pieces))
(loop
(let ((slash (position #\/ namestr :start start :end end)))
(pieces (cons start (or slash end)))
(unless slash
(setf start (1+ slash))))
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
(values absolute (pieces)))))
(defun maybe-extract-search-list (namestr start end)
(declare (type simple-base-string namestr)
(type index start end))
(let ((quoted nil))
(do ((index start (1+ index)))
((= index end)
(values nil start))
(if quoted
(setf quoted nil)
(case (schar namestr index)
(#\\
(setf quoted t))
(#\:
(return (values (remove-backslashes namestr start index)
(1+ index)))))))))
(defun parse-unix-namestring (namestr start end)
(declare (type simple-base-string namestr)
(type index start end))
(multiple-value-bind
(absolute pieces)
(split-at-slashes namestr start end)
(let ((search-list
(if absolute
nil
(let ((first (car pieces)))
(multiple-value-bind
(search-list new-start)
(maybe-extract-search-list namestr
(car first) (cdr first))
(when search-list
(setf absolute t)
(setf (car first) new-start))
search-list)))))
(multiple-value-bind
(name type version)
(let* ((tail (car (last pieces)))
(tail-start (car tail))
(tail-end (cdr tail)))
(unless (= tail-start tail-end)
(setf pieces (butlast pieces))
(extract-name-type-and-version namestr tail-start tail-end)))
;; PVE: Make sure there are no illegal characters in the name
;; such as #\Null and #\/.
(when (and (stringp name)
(find-if #'(lambda (x)
(or (char= x #\Null) (char= x #\/)))
name))
(error 'parse-error))
;; Now we have everything we want. So return it.
(values nil ; no host for unix namestrings.
nil ; no devices for unix namestrings.
(collect ((dirs))
(when search-list
(dirs (intern-search-list search-list)))
(dolist (piece pieces)
(let ((piece-start (car piece))
(piece-end (cdr piece)))
(unless (= piece-start piece-end)
(cond ((string= namestr ".." :start1 piece-start
:end1 piece-end)
(dirs :up))
((string= namestr "**" :start1 piece-start
:end1 piece-end)
(dirs :wild-inferiors))
(t
(dirs (maybe-make-pattern namestr
piece-start
piece-end)))))))
(cond (absolute
(cons :absolute (dirs)))
((dirs)
(cons :relative (dirs)))
(t
nil)))
name
type
version)))))
(defun unparse-unix-host (pathname)
(declare (type pathname pathname)
(ignore pathname))
"Unix")
(defun unparse-unix-piece (thing)
(etypecase thing
((member :wild) "*")
(simple-string
(let* ((srclen (length thing))
(dstlen srclen))
(dotimes (i srclen)
(case (schar thing i)
((#\* #\? #\[)
(incf dstlen))))
(let ((result (make-string dstlen))
(dst 0))
(dotimes (src srclen)
(let ((char (schar thing src)))
(case char
((#\* #\? #\[)
(setf (schar result dst) #\\)
(incf dst)))
(setf (schar result dst) char)
(incf dst)))
result)))
(pattern
(collect ((strings))
(dolist (piece (pattern-pieces thing))
(etypecase piece
(simple-string
(strings piece))
(symbol
(ecase piece
(:multi-char-wild
(strings "*"))
(:single-char-wild
(strings "?"))))
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
(cons
(case (car piece)
(:character-set
(strings "[")
(strings (cdr piece))
(strings "]"))
(t
(error "Invalid pattern piece: ~S" piece))))))
(apply #'concatenate
'simple-string
(strings))))))
(defun unparse-unix-directory-list (directory)
(declare (type list directory))
(collect ((pieces))
(when directory
(ecase (pop directory)
(:absolute
(cond ((search-list-p (car directory))
(pieces (search-list-name (pop directory)))
(pieces ":"))
(t
(pieces "/"))))
(:relative
;; Nothing special.
))
(dolist (dir directory)
(typecase dir
((member :up)
(pieces "../"))
((member :back)
(error ":BACK cannot be represented in namestrings."))
((member :wild-inferiors)
(pieces "**/"))
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
((or simple-string pattern)
(pieces (unparse-unix-piece dir))
(pieces "/"))
(t
(error "Invalid directory component: ~S" dir)))))
(apply #'concatenate 'simple-string (pieces))))
(defun unparse-unix-directory (pathname)
(declare (type pathname pathname))
(unparse-unix-directory-list (%pathname-directory pathname)))
(defun unparse-unix-file (pathname)
(declare (type pathname pathname))
(collect ((strings))
(let* ((name (%pathname-name pathname))
(type (%pathname-type pathname))
(type-supplied (not (or (null type) (eq type :unspecific))))
(version (%pathname-version pathname))
(version-supplied (not (or (null version) (eq version :newest)))))
(when name
(strings (unparse-unix-piece name)))
(when type-supplied
(unless name
(error "Cannot specify the type without a file: ~S" pathname))
(strings ".")
(strings (unparse-unix-piece type)))
(when version-supplied
(strings (if (eq version :wild)
(format nil ".~~~D~~" version)))))
(and (strings) (apply #'concatenate 'simple-string (strings)))))
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
(defun unparse-unix-namestring (pathname)
(declare (type pathname pathname))
(concatenate 'simple-string
(unparse-unix-directory pathname)
(unparse-unix-file pathname)))
(defun unparse-unix-enough (pathname defaults)
(declare (type pathname pathname defaults))
(flet ((lose ()
(error "~S cannot be represented relative to ~S"
pathname defaults)))
(collect ((strings))
(let* ((pathname-directory (%pathname-directory pathname))
(defaults-directory (%pathname-directory defaults))
(prefix-len (length defaults-directory))
(result-dir
(cond ((and (> prefix-len 1)
(>= (length pathname-directory) prefix-len)
(compare-component (subseq pathname-directory
0 prefix-len)
defaults-directory))
;; Pathname starts with a prefix of default. So just
;; use a relative directory from then on out.
(cons :relative (nthcdr prefix-len pathname-directory)))
((eq (car pathname-directory) :absolute)
;; We are an absolute pathname, so we can just use it.
pathname-directory)
(t
;; We are a relative directory. So we lose.
(lose)))))
(strings (unparse-unix-directory-list result-dir)))
(let* ((pathname-version (%pathname-version pathname))
(version-needed (and pathname-version
(not (eq pathname-version :newest))))
(pathname-type (%pathname-type pathname))
(type-needed (or version-needed
(and pathname-type
(not (eq pathname-type :unspecific)))))
(pathname-name (%pathname-name pathname))
(name-needed (or type-needed
(and pathname-name
(not (compare-component pathname-name
(%pathname-name
defaults)))))))
(when name-needed
(unless pathname-name (lose))
(strings (unparse-unix-piece pathname-name)))
(when type-needed
(when (or (null pathname-type) (eq pathname-type :unspecific))
(lose))
(strings ".")
(strings (unparse-unix-piece pathname-type)))
(when version-needed
(typecase pathname-version
((member :wild)
(strings ".~*~"))
(strings (format nil ".~~~D~~" pathname-version)))
(t
(lose)))))
(apply #'concatenate 'simple-string (strings)))))
(defstruct (unix-host
(:include host
(:parse #'parse-unix-namestring)
(:unparse #'unparse-unix-namestring)
(:unparse-host #'unparse-unix-host)
(:unparse-directory #'unparse-unix-directory)
(:unparse-file #'unparse-unix-file)
(:unparse-enough #'unparse-unix-enough)
(:customary-case :lower))
(:make-load-form-fun make-unix-host-load-form))
)
(defvar *unix-host* (make-unix-host))
(defun make-unix-host-load-form (host)
(declare (ignore host))
'*unix-host*)
;;;; Wildcard matching stuff.
(defmacro enumerate-matches ((var pathname &optional result
&key (verify-existance t) (follow-links t))
&body body)
(let ((body-name (gensym)))
`(block nil
(flet ((,body-name (,var)
,@body))
(%enumerate-matches (pathname ,pathname)
,verify-existance ,follow-links
#',body-name)
,result))))
(defun %enumerate-matches (pathname verify-existance follow-links function)
(when (pathname-type pathname)
(unless (pathname-name pathname)
(error "Cannot supply a type without a name:~% ~S" pathname)))
(let ((directory (pathname-directory pathname)))
(if directory
(ecase (car directory)
(:absolute
(%enumerate-directories "/" (cdr directory) pathname
verify-existance follow-links
nil function))
(:relative
(%enumerate-directories "" (cdr directory) pathname
verify-existance follow-links
nil function)))
(%enumerate-files "" pathname verify-existance function))))
;;; %enumerate-directories -- Internal
;;;
;;; The directory node and device numbers are maintained for the current path
;;; during the search for the detection of paths loops upon :wild-inferiors.
;;;
(defun %enumerate-directories (head tail pathname verify-existance
follow-links nodes function)
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
(macrolet ((unix-xstat (name)
`(if follow-links
(unix:unix-stat ,name)
(unix:unix-lstat ,name)))
(with-directory-node-noted ((head) &body body)
`(multiple-value-bind (res dev ino mode)
(unix-xstat ,head)
(when (and res (eql (logand mode unix:s-ifmt) unix:s-ifdir))
(let ((nodes (cons (cons dev ino) nodes)))
,@body))))
(do-directory-entries ((name directory) &body body)
`(let ((dir (unix:open-dir ,directory)))
(when dir
(unwind-protect
(loop
(let ((,name (unix:read-dir dir)))
(cond ((null ,name)
(return))
((string= ,name "."))
((string= ,name ".."))
(t
,@body))))
(unix:close-dir dir))))))
(if tail
(let ((piece (car tail)))
(etypecase piece
(simple-string
(let ((head (concatenate 'string head piece)))
(with-directory-node-noted (head)
(%enumerate-directories (concatenate 'string head "/")
(cdr tail) pathname
verify-existance follow-links
nodes function))))
((member :wild-inferiors)
(%enumerate-directories head (rest tail) pathname
verify-existance follow-links
nodes function)
(do-directory-entries (name head)
(let ((subdir (concatenate 'string head name)))
(multiple-value-bind (res dev ino mode)
(unix-xstat subdir)
(declare (type (or fixnum null) mode))
(when (and res (eql (logand mode unix:s-ifmt) unix:s-ifdir))
(unless (dolist (dir nodes nil)
(when (and (eql (car dir) dev)
(eql (cdr dir) ino))
(return t)))
(let ((nodes (cons (cons dev ino) nodes))
(subdir (concatenate 'string subdir "/")))
(%enumerate-directories subdir tail pathname
verify-existance follow-links
nodes function))))))))
((or pattern (member :wild))
(do-directory-entries (name head)
(when (or (eq piece :wild) (pattern-matches piece name))
(let ((subdir (concatenate 'string head name)))
(multiple-value-bind (res dev ino mode)
(unix-xstat subdir)
(declare (type (or fixnum null) mode))
(when (and res
(eql (logand mode unix:s-ifmt) unix:s-ifdir))
(let ((nodes (cons (cons dev ino) nodes))
(subdir (concatenate 'string subdir "/")))
(%enumerate-directories subdir (rest tail) pathname
verify-existance follow-links
nodes function))))))))
((member :up)
(let ((head (concatenate 'string head "..")))
(with-directory-node-noted (head)
(%enumerate-directories (concatenate 'string head "/")
(rest tail) pathname
verify-existance follow-links
nodes function))))))
(%enumerate-files head pathname verify-existance function))))
(defun %enumerate-files (directory pathname verify-existance function)
(declare (simple-string directory))
(let ((name (%pathname-name pathname))
(type (%pathname-type pathname))
(version (%pathname-version pathname)))
(cond ((member name '(nil :unspecific))
(when (or (not verify-existance)
(funcall function directory)))
((or (pattern-p name)
(pattern-p type)
(eq name :wild)
(eq type :wild))
(when dir
(unwind-protect
(loop
(unless (or (string= file ".")
(string= file ".."))
(multiple-value-bind
(file-name file-type file-version)
(let ((*ignore-wildcards* t))
(extract-name-type-and-version
file 0 (length file)))
(when (and (components-match file-name name)
(components-match file-type type)
(components-match file-version
version))
(funcall function
(concatenate 'string
directory
file)))))
(return))))
(t
(let ((file (concatenate 'string directory name)))
(unless (or (null type) (eq type :unspecific))
(setf file (concatenate 'string file "." type)))
(unless (member version '(nil :newest :wild))
(setf file (concatenate 'string file "."
(when (or (not verify-existance)
(unix:unix-file-kind file t))
(funcall function file)))))))
(declare (type integer n))
(cond ((not (fixnump n))
(write-to-string n :base 10 :radix nil))
((zerop n) "0")
((eql n 1) "1")
((minusp n)
(concatenate 'simple-string "-"
(the simple-string (quick-integer-to-string (- n)))))
(t
(do* ((len (1+ (truncate (integer-length n) 3)))
(res (make-string len))
(i (1- len) (1- i))
(q n)
(r 0))
((zerop q)
(incf i)
(replace res res :start2 i :end2 len)
(shrink-vector res (- len i)))
(fixnum len i r q))
(multiple-value-setq (q r) (truncate q 10))
(setf (schar res i) (schar "0123456789" r))))))
;;;; UNIX-NAMESTRING -- public
(defun unix-namestring (pathname &optional (for-input t) executable-only)
"Convert PATHNAME into a string that can be used with UNIX system calls.
Search-lists and wild-cards are expanded. If optional argument
FOR-INPUT is true and PATHNAME doesn't exist, NIL is returned.
If optional argument EXECUTABLE-ONLY is true, NIL is returned
unless an executable version of PATHNAME exists."
;; toy@rtp.ericsson.se: Let unix-namestring also handle logical
;; pathnames too.
(let ((path (let ((lpn (pathname pathname)))
(if (logical-pathname-p lpn)
(namestring (translate-logical-pathname lpn))
pathname))))
(enumerate-search-list
(collect ((names))
(enumerate-matches (name pathname nil :verify-existance for-input
:follow-links t)
(when (or (not executable-only)
(and (eq (unix:unix-file-kind name) :file)
(unix:unix-access name unix:x_ok)))
(names name)))
(let ((names (names)))
(when names
(when (cdr names)
(error 'simple-file-error
:format-control "~S is ambiguous:~{~% ~A~}"
:format-arguments (list pathname names)))
;;;; TRUENAME and PROBE-FILE.
;;; Another silly file function trivially different from another function.
;;;
(defun truename (pathname)
"Return the pathname for the actual file described by the pathname
An error of type file-error is signalled if no such file exists,
or the pathname is wild."
(if (wild-pathname-p pathname)
(error 'simple-file-error
:format-control "Bad place for a wild pathname."
:pathname pathname)
(let ((result (probe-file pathname)))
(unless result
(error 'simple-file-error
:pathname pathname
:format-control "The file ~S does not exist."
:format-arguments (list (namestring pathname))))
result)))
;;; If PATHNAME exists, return it's truename, otherwise NIL.
;;;
(defun probe-file (pathname)
"Return a pathname which is the truename of the file if it exists, NIL
otherwise. An error of type file-error is signaled if pathname is wild."
(if (wild-pathname-p pathname)
(error 'simple-file-error
:pathname pathname
:format-control "Bad place for a wild pathname.")
(let ((namestring (unix-namestring pathname t)))
(when (and namestring (unix:unix-file-kind namestring))
(let ((truename (unix:unix-resolve-links
(unix:unix-maybe-prepend-current-directory
namestring))))
(when truename
(let ((*ignore-wildcards* t))
(pathname (unix:unix-simplify-pathname truename)))))))))
;;;; Other random operations.
;;; Rename-File -- Public
;;;
(defun rename-file (file new-name)
"Rename File to have the specified New-Name. If file is a stream open to a
file, then the associated file is renamed."
(let* ((original (truename file))
(original-namestring (unix-namestring original t))
(new-name (merge-pathnames new-name original))
(new-namestring (unix-namestring new-name nil)))
(unless new-namestring
(error 'simple-file-error
:pathname new-name
:format-control "~S can't be created."
:format-arguments (list new-name)))
(multiple-value-bind (res error)
new-namestring)
(unless res
(error 'simple-file-error
:pathname new-name
:format-control "Failed to rename ~A to ~A: ~A"
:format-arguments (list original new-name
(unix:get-unix-error-msg error))))
(when (streamp file)
(file-name file new-namestring))
(values new-name original (truename new-name)))))
;;; Delete-File -- Public
;;;
;;; Delete the file, Man.
;;;
(defun delete-file (file)
"Delete the specified file."
(let ((namestring (unix-namestring file t)))
(unless namestring
(error 'simple-file-error
:pathname file
:format-control "~S doesn't exist."
:format-arguments (list file)))
(multiple-value-bind (res err) (unix:unix-unlink namestring)
(error 'simple-file-error
:pathname namestring
:format-control "Could not delete ~A: ~A."
:format-arguments (list namestring
(unix:get-unix-error-msg err))))))
;;; Return Home:, which is set up for us at initialization time.
;;;
(defun user-homedir-pathname (&optional host)
"Returns the home directory of the logged in user as a pathname.
This is obtained from the logical name \"home:\"."
;;; File-Write-Date -- Public
;;;
(defun file-write-date (file)
"Return file's creation date, or NIL if it doesn't exist.
An error of type file-error is signaled if file is a wild pathname"
(if (wild-pathname-p file)
(error 'simple-file-error
:pathname file
:format-control "Bad place for a wild pathname.")
(let ((name (unix-namestring file t)))
(when name
(multiple-value-bind
(res dev ino mode nlink uid gid rdev size atime mtime)
(unix:unix-stat name)
(declare (ignore dev ino mode nlink uid gid rdev size atime))
(when res
(+ unix-to-universal-time mtime)))))))
;;; File-Author -- Public
;;;
(defun file-author (file)
"Returns the file author as a string, or nil if the author cannot be
determined. Signals an error of type file-error if file doesn't exist,
or file is a wild pathname."
(if (wild-pathname-p file)
(error 'simple-file-error
:pathname file
"Bad place for a wild pathname.")
(let ((name (unix-namestring (pathname file) t)))
(unless name
(error 'simple-file-error
:pathname file
:format-control "~S doesn't exist."
:format-arguments (list file)))
(multiple-value-bind (winp dev ino mode nlink uid)
(unix:unix-stat name)
(declare (ignore dev ino mode nlink))
(if winp (lookup-login-name uid))))))
;;; DIRECTORY -- public.
;;;
(defun directory (pathname &key (all t) (check-for-subdirs t)
(truenamep t) (follow-links t))
"Returns a list of pathnames, one for each file that matches the given
pathname. Supplying :ALL as nil causes this to ignore Unix dot files. This
never includes Unix dot and dot-dot in the result. If :TRUENAMEP is NIL,
then symblolic links in the result are not expanded which is not the
default because TRUENAME does follow links, and the result pathnames are
defined to be the TRUENAME of the pathname (the truename of a link may well
be in another directory.) If FOLLOW-LINKS is NIL then symbolic links are
not followed."
(let ((results nil))
(enumerate-search-list
(pathname (merge-pathnames pathname
(make-pathname :name :wild
:type :wild
:version :wild)))
(enumerate-matches (name pathname nil :follow-links follow-links)
(when (or all
(let ((slash (position #\/ name :from-end t)))
(or (null slash)
(= (1+ slash) (length name))
(char/= (schar name (1+ slash)) #\.))))
(push name results))))
(let ((*ignore-wildcards* t))
(mapcar #'(lambda (name)
(let ((name (if (and check-for-subdirs
:directory))
(concatenate 'string name "/")
name)))
(if truenamep (truename name) (pathname name))))
(sort (delete-duplicates results :test #'string=) #'string<)))))
;;;; Printing directories.
;;; PRINT-DIRECTORY is exported from the EXTENSIONS package.
;;;
(defun print-directory (pathname &optional stream &key all verbose return-list)
"Like Directory, but prints a terse, multi-coloumn directory listing
instead of returning a list of pathnames. When :all is supplied and
non-nil, then Unix dot files are included too (as ls -a). When :vervose
is supplied and non-nil, then a long listing of miscellaneous
information is output one file per line."
(let ((*standard-output* (out-synonym-of stream))
(pathname pathname))
(if verbose
(print-directory-verbose pathname all return-list)
(print-directory-formatted pathname all return-list))))
(defun print-directory-verbose (pathname all return-list)
(let ((contents (directory pathname :all all :check-for-subdirs nil
:truenamep nil))
(result nil))
(format t "Directory of ~A :~%" (namestring pathname))
(dolist (file contents)
(let* ((namestring (unix-namestring file))
(tail (subseq namestring
(1+ (or (position #\/ namestring
:from-end t
:test #'char=)
-1)))))
(multiple-value-bind
(reslt dev-or-err ino mode nlink uid gid rdev size atime mtime)
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
(declare (ignore ino gid rdev atime)
(fixnum uid mode))
(cond (reslt
;;
;; Print characters for file modes.
(macrolet ((frob (bit name &optional sbit sname negate)
`(if ,(if negate
`(not (logbitp ,bit mode))
`(logbitp ,bit mode))
,(if sbit
`(if (logbitp ,sbit mode)
(write-char ,sname)
(write-char ,name))
`(write-char ,name))
(write-char #\-))))
(frob 15 #\d nil nil t)
(frob 8 #\r)
(frob 7 #\w)
(frob 6 #\x 11 #\s)
(frob 5 #\r)
(frob 4 #\w)
(frob 3 #\x 10 #\s)
(frob 2 #\r)
(frob 1 #\w)
(frob 0 #\x))
;;
;; Print the rest.
(multiple-value-bind (sec min hour date month year)
(get-decoded-time)
(declare (ignore sec min hour date month))
(format t "~2D ~8A ~8D ~12A ~A~@[/~]~%"
nlink
(or (lookup-login-name uid) uid)
size
(decode-universal-time-for-files mtime year)
tail
(= (logand mode unix:s-ifmt) unix:s-ifdir))))
(t (format t "Couldn't stat ~A -- ~A.~%"
tail
(push (if (= (logand mode unix:s-ifmt) unix:s-ifdir)
(pathname (concatenate 'string namestring "/"))
file)
result)))))
(nreverse result)))
(defun decode-universal-time-for-files (time current-year)
(multiple-value-bind (sec min hour day month year)
(decode-universal-time (+ time unix-to-universal-time))
(declare (ignore sec))
(format nil "~A ~2,' D ~:[ ~D~;~*~2,'0D:~2,'0D~]"
(svref '#("Jan" "Feb" "Mar" "Apr" "May" "Jun" "Jul" "Aug"
"Sep" "Oct" "Nov" "Dec")
(1- month))
day (= current-year year) year hour min)))
(defun print-directory-formatted (pathname all return-list)
(let ((width (or (line-length *standard-output*) 80))
(names ())
(cnt 0)
(max-len 0)
(result (directory pathname :all all :truenamep nil)))
(declare (list names) (fixnum max-len cnt))
;;
;; Get the data.
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
(dolist (file result)
(let* ((name (unix-namestring file))
(length (length name))
(end (if (and (plusp length)
(char= (schar name (1- length)) #\/))
(1- length)
length))
(slash-name (subseq name
(1+ (or (position #\/ name
:from-end t
:end end
:test #'char=)
-1))))
(len (length slash-name)))
(declare (simple-string slash-name)
(fixnum len))
(if (> len max-len) (setq max-len len))
(incf cnt)
(push slash-name names)))
(setq names (nreverse names))
;;
;; Do the output.
(let* ((col-width (1+ max-len))
(cols (max (truncate width col-width) 1))
(lines (ceiling cnt cols)))
(declare (fixnum cols lines))
(format t "Directory of ~A :~%" (namestring pathname))
(dotimes (i lines)
(declare (fixnum i))
(dotimes (j cols)
(declare (fixnum j))
(let ((name (nth (+ i (the fixnum (* j lines))) names)))
(when name
(write-string name)
(unless (eql j (1- cols))
(dotimes (i (- col-width (length (the simple-string name))))
(write-char #\space))))))
(terpri)))
(when return-list
result)))
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
;;;; Translating uid's and gid's.
(defvar *uid-hash-table* (make-hash-table)
"Hash table for keeping track of uid's and login names.")
;;; LOOKUP-LOGIN-NAME translates a user id into a login name. Previous
;;; lookups are cached in a hash table since groveling the passwd(s) files
;;; is somewhat expensive. The table may hold nil for id's that cannot
;;; be looked up since this means the files are searched in their entirety
;;; each time this id is translated.
;;;
(defun lookup-login-name (uid)
(multiple-value-bind (login-name foundp) (gethash uid *uid-hash-table*)
(if foundp
login-name
(setf (gethash uid *uid-hash-table*)
(get-group-or-user-name :user uid)))))
(defvar *gid-hash-table* (make-hash-table)
"Hash table for keeping track of gid's and group names.")
;;; LOOKUP-GROUP-NAME translates a group id into a group name. Previous
;;; lookups are cached in a hash table since groveling the group(s) files
;;; is somewhat expensive. The table may hold nil for id's that cannot
;;; be looked up since this means the files are searched in their entirety
;;; each time this id is translated.
;;;
(defun lookup-group-name (gid)
(multiple-value-bind (group-name foundp) (gethash gid *gid-hash-table*)
(if foundp
group-name
(setf (gethash gid *gid-hash-table*)
(get-group-or-user-name :group gid)))))
;;; GET-GROUP-OR-USER-NAME first tries "/etc/passwd" ("/etc/group") since it is
;;; a much smaller file, contains all the local id's, and most uses probably
;;; involve id's on machines one would login into. Then if necessary, we look
;;; in "/etc/passwds" ("/etc/groups") which is really long and has to be
;;; fetched over the net.
;;;
(defun get-group-or-user-name (group-or-user id)
"Returns the simple-string user or group name of the user whose uid or gid
is id, or NIL if no such user or group exists. Group-or-user is either
:group or :user."
(let ((id-string (let ((*print-base* 10)) (prin1-to-string id))))
(declare (simple-string id-string))
(multiple-value-bind (file1 file2)
(ecase group-or-user
(:group (values "/etc/group" "/etc/groups"))
(:user (values "/etc/passwd" "/etc/passwd")))
(or (get-group-or-user-name-aux id-string file1)
(get-group-or-user-name-aux id-string file2)))))
(defun get-group-or-user-name-aux (id-string passwd-file)
(with-open-file (stream passwd-file)
(loop
(let ((entry (read-line stream nil)))
(unless entry (return nil))
(let ((name-end (position #\: (the simple-string entry)
:test #'char=)))
(when name-end
(let ((id-start (position #\: (the simple-string entry)
:start (1+ name-end) :test #'char=)))
(when id-start
(incf id-start)
(let ((id-end (position #\: (the simple-string entry)
:start id-start :test #'char=)))
(when (and id-end
(string= id-string entry
:start2 id-start :end2 id-end))
(return (subseq entry 0 name-end))))))))))))
;;;; File completion.
(defun complete-file (pathname &key (defaults *default-pathname-defaults*)
ignore-types)
(let ((files (directory (complete-file-directory-arg pathname defaults)
:check-for-subdirs nil
:truenamep nil)))
(cond ((null files)
(values nil nil))
((null (cdr files))
(values (merge-pathnames (file-namestring (car files))
pathname)
t))
(t
(let ((good-files
(delete-if #'(lambda (pathname)
(and (simple-string-p
(pathname-type pathname))
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
(member (pathname-type pathname)
ignore-types
:test #'string=)))
files)))
(cond ((null good-files))
((null (cdr good-files))
(return-from complete-file
(values (merge-pathnames (file-namestring
(car good-files))
pathname)
t)))
(t
(setf files good-files)))
(let ((common (file-namestring (car files))))
(dolist (file (cdr files))
(let ((name (file-namestring file)))
(dotimes (i (min (length common) (length name))
(when (< (length name) (length common))
(setf common name)))
(unless (char= (schar common i) (schar name i))
(setf common (subseq common 0 i))
(return)))))
(values (merge-pathnames common pathname)
nil)))))))
;;; COMPLETE-FILE-DIRECTORY-ARG -- Internal.
;;;
(defun complete-file-directory-arg (pathname defaults)
(let* ((pathname (merge-pathnames pathname (directory-namestring defaults)))
(type (pathname-type pathname)))
(flet ((append-multi-char-wild (thing)
(etypecase thing
(null :wild)
(pattern
(make-pattern (append (pattern-pieces thing)
(list :multi-char-wild))))
(simple-string
(make-pattern (list thing :multi-char-wild))))))
(if (or (null type) (eq type :unspecific))
;; There is no type.
(make-pathname :defaults pathname
:name (append-multi-char-wild (pathname-name pathname))
:type :wild)
;; There already is a type, so just extend it.
(make-pathname :defaults pathname
:name (pathname-name pathname)
:type (append-multi-char-wild (pathname-type pathname)))))))
;;; Ambiguous-Files -- Public
(defun ambiguous-files (pathname
&optional (defaults *default-pathname-defaults*))
"Return a list of all files which are possible completions of Pathname.
We look in the directory specified by Defaults as well as looking down
the search list."
(directory (complete-file-directory-arg pathname defaults)
:truenamep nil
:check-for-subdirs nil))
;;; File-writable -- exported from extensions.
;;;
;;; Determines whether the single argument (which should be a pathname)
(defun file-writable (name)
"File-writable accepts a pathname and returns T if the current
process can write it, and NIL otherwise."
(let ((name (unix-namestring name nil)))
(cond ((null name)
nil)
((unix:unix-file-kind name)
(values (unix:unix-access name unix:w_ok)))
(t
(values
0
(or (position #\/ name :from-end t)
0))
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
;;; Pathname-Order -- Internal
;;;
;;; Predicate to order pathnames by. Goes by name.
;;;
(defun pathname-order (x y)
(let ((xn (%pathname-name x))
(yn (%pathname-name y)))
(if (and xn yn)
(let ((res (string-lessp xn yn)))
(cond ((not res) nil)
((= res (length (the simple-string xn))) t)
((= res (length (the simple-string yn))) nil)
(t t)))
xn)))
;;; Default-Directory -- Public
;;;
(defun default-directory ()
"Returns the pathname for the default directory. This is the place where
a file will be written if no directory is specified. This may be changed
with setf."
(multiple-value-bind (gr dir-or-error)
(let ((*ignore-wildcards* t))
(pathname (concatenate 'simple-string dir-or-error "/")))
;;; %Set-Default-Directory -- Internal
;;;
(defun %set-default-directory (new-val)
(let ((namestring (unix-namestring new-val t)))
(unless namestring
(error "~S doesn't exist." new-val))
(multiple-value-bind (gr error)
(if gr
(setf (search-list "default:") (default-directory))
;;;
(defsetf default-directory %set-default-directory)
(defun filesys-init ()
(setf *default-pathname-defaults*
(%make-pathname *unix-host* nil nil nil nil :newest))
(setf (search-list "default:") (default-directory))
nil)
;;; Ensure-Directories-Exist -- Public
;;;
(defun ensure-directories-exist (pathspec &key verbose (mode #o777))
"Tests whether the directories containing the specified file
actually exist, and attempts to create them if they do not.
Portable programs should avoid using the :MODE keyword argument."
(let* ((pathname (pathname pathspec))
(pathname (if (logical-pathname-p pathname)
(translate-logical-pathname pathname)
pathname))
(created-p nil))
(when (wild-pathname-p pathname)
(error 'simple-file-error
:format-control "Bad place for a wild pathname."
:pathname pathspec))
(enumerate-search-list (pathname pathname)
(let ((dir (pathname-directory pathname)))
(loop for i from 1 upto (length dir)
do (let ((newpath (make-pathname
:host (pathname-host pathname)
:device (pathname-device pathname)
:directory (subseq dir 0 i))))
(unless (probe-file newpath)
(let ((namestring (namestring newpath)))
(when verbose
(format *standard-output* "~&Creating directory: ~A~%"
namestring))
(unix:unix-mkdir namestring mode)
(unless (probe-file namestring)
(error 'simple-file-error
:pathname pathspec
:format-control "Can't create directory ~A."
:format-arguments (list namestring)))
(setf created-p t)))))
;; Only the first path in a search-list is considered.
(return (values pathname created-p))))))