1 ;;;; file system interface functions -- fairly Unix-specific
3 ;;;; This software is part of the SBCL system. See the README file for
6 ;;;; This software is derived from the CMU CL system, which was
7 ;;;; written at Carnegie Mellon University and released into the
8 ;;;; public domain. The software is in the public domain and is
9 ;;;; provided with absolutely no warranty. See the COPYING and CREDITS
10 ;;;; files for more information.
12 (in-package "SB!IMPL")
14 ;;;; Unix pathname host support
16 ;;; Unix namestrings have the following format:
18 ;;; namestring := [ directory ] [ file [ type [ version ]]]
19 ;;; directory := [ "/" | search-list ] { file "/" }*
20 ;;; search-list := [^:/]*:
22 ;;; type := "." [^/.]*
23 ;;; version := "." ([0-9]+ | "*")
25 ;;; FIXME: Search lists are no longer supported.
27 ;;; Note: this grammar is ambiguous. The string foo.bar.5 can be
28 ;;; parsed as either just the file specified or as specifying the
29 ;;; file, type, and version. Therefore, we use the following rules
30 ;;; when confronted with an ambiguous file.type.version string:
32 ;;; - If the first character is a dot, it's part of the file. It is not
33 ;;; considered a dot in the following rules.
35 ;;; - If there is only one dot, it separates the file and the type.
37 ;;; - If there are multiple dots and the stuff following the last dot
38 ;;; is a valid version, then that is the version and the stuff between
39 ;;; the second to last dot and the last dot is the type.
41 ;;; Wildcard characters:
43 ;;; If the directory, file, type components contain any of the
44 ;;; following characters, it is considered part of a wildcard pattern
45 ;;; and has the following meaning.
47 ;;; ? - matches any character
48 ;;; * - matches any zero or more characters.
49 ;;; [abc] - matches any of a, b, or c.
50 ;;; {str1,str2,...,strn} - matches any of str1, str2, ..., or strn.
52 ;;; Any of these special characters can be preceded by a backslash to
53 ;;; cause it to be treated as a regular character.
54 (defun remove-backslashes (namestr start end)
56 "Remove any occurrences of #\\ from the string because we've already
57 checked for whatever they may have protected."
58 (declare (type simple-base-string namestr)
59 (type index start end))
60 (let* ((result (make-string (- end start)))
63 (do ((src start (1+ src)))
66 (setf (schar result dst) (schar namestr src))
70 (let ((char (schar namestr src)))
71 (cond ((char= char #\\)
74 (setf (schar result dst) char)
77 (error 'namestring-parse-error
78 :complaint "backslash in a bad place"
81 (shrink-vector result dst)))
83 (defvar *ignore-wildcards* nil)
85 (/show0 "filesys.lisp 86")
87 (defun maybe-make-pattern (namestr start end)
88 (declare (type simple-base-string namestr)
89 (type index start end))
90 (if *ignore-wildcards*
91 (subseq namestr start end)
95 (last-regular-char nil)
97 (flet ((flush-pending-regulars ()
98 (when last-regular-char
99 (pattern (if any-quotes
100 (remove-backslashes namestr
103 (subseq namestr last-regular-char index)))
104 (setf any-quotes nil)
105 (setf last-regular-char nil))))
109 (let ((char (schar namestr index)))
116 (unless last-regular-char
117 (setf last-regular-char index))
120 (flush-pending-regulars)
121 (pattern :single-char-wild)
124 (flush-pending-regulars)
125 (pattern :multi-char-wild)
128 (flush-pending-regulars)
130 (position #\] namestr :start index :end end)))
131 (unless close-bracket
132 (error 'namestring-parse-error
133 :complaint "#\\[ with no corresponding #\\]"
136 (pattern (list :character-set
140 (setf index (1+ close-bracket))))
142 (unless last-regular-char
143 (setf last-regular-char index))
145 (flush-pending-regulars)))
146 (cond ((null (pattern))
148 ((null (cdr (pattern)))
149 (let ((piece (first (pattern))))
151 ((member :multi-char-wild) :wild)
152 (simple-string piece)
154 (make-pattern (pattern))))))
156 (make-pattern (pattern)))))))
158 (/show0 "filesys.lisp 160")
160 (defun extract-name-type-and-version (namestr start end)
161 (declare (type simple-base-string namestr)
162 (type index start end))
163 (let* ((last-dot (position #\. namestr :start (1+ start) :end end
165 (second-to-last-dot (and last-dot
166 (position #\. namestr :start (1+ start)
167 :end last-dot :from-end t)))
169 ;; If there is a second-to-last dot, check to see whether there is
170 ;; a valid version after the last dot.
171 (when second-to-last-dot
172 (cond ((and (= (+ last-dot 2) end)
173 (char= (schar namestr (1+ last-dot)) #\*))
174 (setf version :wild))
175 ((and (< (1+ last-dot) end)
176 (do ((index (1+ last-dot) (1+ index)))
178 (unless (char<= #\0 (schar namestr index) #\9)
181 (parse-integer namestr :start (1+ last-dot) :end end)))
183 (setf second-to-last-dot nil))))
184 (cond (second-to-last-dot
185 (values (maybe-make-pattern namestr start second-to-last-dot)
186 (maybe-make-pattern namestr
187 (1+ second-to-last-dot)
191 (values (maybe-make-pattern namestr start last-dot)
192 (maybe-make-pattern namestr (1+ last-dot) end)
195 (values (maybe-make-pattern namestr start end)
199 (/show0 "filesys.lisp 200")
201 ;;; Take a string and return a list of cons cells that mark the char
202 ;;; separated subseq. The first value is true if absolute directories
204 (defun split-at-slashes (namestr start end)
205 (declare (type simple-base-string namestr)
206 (type index start end))
207 (let ((absolute (and (/= start end)
208 (char= (schar namestr start) #\/))))
211 ;; Next, split the remainder into slash-separated chunks.
214 (let ((slash (position #\/ namestr :start start :end end)))
215 (pieces (cons start (or slash end)))
218 (setf start (1+ slash))))
219 (values absolute (pieces)))))
221 (defun maybe-extract-search-list (namestr start end)
222 (declare (type simple-base-string namestr)
223 (type index start end))
225 (do ((index start (1+ index)))
230 (case (schar namestr index)
234 (return (values (remove-backslashes namestr start index)
237 (defun parse-unix-namestring (namestr start end)
238 (declare (type simple-base-string namestr)
239 (type index start end))
240 (multiple-value-bind (absolute pieces) (split-at-slashes namestr start end)
241 (let ((search-list (if absolute
243 (let ((first (car pieces)))
244 (multiple-value-bind (search-list new-start)
245 (maybe-extract-search-list namestr
250 (setf (car first) new-start))
252 (multiple-value-bind (name type version)
253 (let* ((tail (car (last pieces)))
254 (tail-start (car tail))
255 (tail-end (cdr tail)))
256 (unless (= tail-start tail-end)
257 (setf pieces (butlast pieces))
258 (extract-name-type-and-version namestr tail-start tail-end)))
259 ;; PVE: make sure there are no illegal characters in
260 ;; the name, illegal being (code-char 0) and #\/
262 (when (and (stringp name)
263 (find-if #'(lambda (x) (or (char= x (code-char 0))
266 (error 'parse-error))
268 ;; Now we have everything we want. So return it.
269 (values nil ; no host for unix namestrings.
270 nil ; no devices for unix namestrings.
273 (dirs (intern-search-list search-list)))
274 (dolist (piece pieces)
275 (let ((piece-start (car piece))
276 (piece-end (cdr piece)))
277 (unless (= piece-start piece-end)
278 (cond ((string= namestr ".." :start1 piece-start
281 ((string= namestr "**" :start1 piece-start
283 (dirs :wild-inferiors))
285 (dirs (maybe-make-pattern namestr
289 (cons :absolute (dirs)))
291 (cons :relative (dirs)))
298 (/show0 "filesys.lisp 300")
300 (defun unparse-unix-host (pathname)
301 (declare (type pathname pathname)
305 (defun unparse-unix-piece (thing)
309 (let* ((srclen (length thing))
312 (case (schar thing i)
315 (let ((result (make-string dstlen))
317 (dotimes (src srclen)
318 (let ((char (schar thing src)))
321 (setf (schar result dst) #\\)
323 (setf (schar result dst) char)
328 (dolist (piece (pattern-pieces thing))
342 (strings (cdr piece))
345 (error "invalid pattern piece: ~S" piece))))))
350 (defun unparse-unix-directory-list (directory)
351 (declare (type list directory))
354 (ecase (pop directory)
356 (cond ((search-list-p (car directory))
357 (pieces (search-list-name (pop directory)))
364 (dolist (dir directory)
369 (error ":BACK cannot be represented in namestrings."))
370 ((member :wild-inferiors)
372 ((or simple-string pattern)
373 (pieces (unparse-unix-piece dir))
376 (error "invalid directory component: ~S" dir)))))
377 (apply #'concatenate 'simple-string (pieces))))
379 (defun unparse-unix-directory (pathname)
380 (declare (type pathname pathname))
381 (unparse-unix-directory-list (%pathname-directory pathname)))
383 (defun unparse-unix-file (pathname)
384 (declare (type pathname pathname))
386 (let* ((name (%pathname-name pathname))
387 (type (%pathname-type pathname))
388 (type-supplied (not (or (null type) (eq type :unspecific)))))
389 ;; Note: by ANSI 19.3.1.1.5, we ignore the version slot when
390 ;; translating logical pathnames to a filesystem without
391 ;; versions (like Unix).
393 (strings (unparse-unix-piece name)))
396 (error "cannot specify the type without a file: ~S" pathname))
398 (strings (unparse-unix-piece type))))
399 (apply #'concatenate 'simple-string (strings))))
401 (/show0 "filesys.lisp 406")
403 (defun unparse-unix-namestring (pathname)
404 (declare (type pathname pathname))
405 (concatenate 'simple-string
406 (unparse-unix-directory pathname)
407 (unparse-unix-file pathname)))
409 (defun unparse-unix-enough (pathname defaults)
410 (declare (type pathname pathname defaults))
412 (error "~S cannot be represented relative to ~S."
415 (let* ((pathname-directory (%pathname-directory pathname))
416 (defaults-directory (%pathname-directory defaults))
417 (prefix-len (length defaults-directory))
419 (cond ((and (> prefix-len 1)
420 (>= (length pathname-directory) prefix-len)
421 (compare-component (subseq pathname-directory
424 ;; Pathname starts with a prefix of default. So
425 ;; just use a relative directory from then on out.
426 (cons :relative (nthcdr prefix-len pathname-directory)))
427 ((eq (car pathname-directory) :absolute)
428 ;; We are an absolute pathname, so we can just use it.
431 ;; We are a relative directory. So we lose.
433 (strings (unparse-unix-directory-list result-directory)))
434 (let* ((pathname-version (%pathname-version pathname))
435 (version-needed (and pathname-version
436 (not (eq pathname-version :newest))))
437 (pathname-type (%pathname-type pathname))
438 (type-needed (or version-needed
440 (not (eq pathname-type :unspecific)))))
441 (pathname-name (%pathname-name pathname))
442 (name-needed (or type-needed
444 (not (compare-component pathname-name
448 (unless pathname-name (lose))
449 (strings (unparse-unix-piece pathname-name)))
451 (when (or (null pathname-type) (eq pathname-type :unspecific))
454 (strings (unparse-unix-piece pathname-type)))
456 (typecase pathname-version
460 (strings (format nil ".~D" pathname-version)))
463 (apply #'concatenate 'simple-string (strings)))))
465 (/show0 "filesys.lisp 471")
467 (def!struct (unix-host
468 (:make-load-form-fun make-unix-host-load-form)
470 (parse #'parse-unix-namestring)
471 (unparse #'unparse-unix-namestring)
472 (unparse-host #'unparse-unix-host)
473 (unparse-directory #'unparse-unix-directory)
474 (unparse-file #'unparse-unix-file)
475 (unparse-enough #'unparse-unix-enough)
476 (customary-case :lower))))
478 (/show0 "filesys.lisp 486")
480 (defvar *unix-host* (make-unix-host))
482 (/show0 "filesys.lisp 488")
484 (defun make-unix-host-load-form (host)
485 (declare (ignore host))
488 ;;;; wildcard matching stuff
490 ;;; Return a list of all the Lispy filenames (not including e.g. the
491 ;;; Unix magic "." and "..") in the directory named by DIRECTORY-NAME.
492 (defun directory-lispy-filenames (directory-name)
493 (with-alien ((adlf (* c-string)
494 (alien-funcall (extern-alien
495 "alloc_directory_lispy_filenames"
496 (function (* c-string) c-string))
498 (if (null-alien adlf)
499 (error 'simple-file-error
500 :pathname directory-name
501 :format-control "~@<couldn't read directory ~S: ~2I~_~A~:>"
502 :format-arguments (list directory-name (strerror)))
504 (c-strings->string-list adlf)
505 (alien-funcall (extern-alien "free_directory_lispy_filenames"
506 (function void (* c-string)))
509 (/show0 "filesys.lisp 498")
511 ;;; FIXME: could maybe be EVAL-WHEN (COMPILE EVAL)
513 (defmacro enumerate-matches ((var pathname &optional result
514 &key (verify-existence t)
517 (let ((body-name (gensym "ENUMERATE-MATCHES-BODY-FUN-")))
519 (flet ((,body-name (,var)
521 (declare (dynamic-extent ,body-name))
522 (%enumerate-matches (pathname ,pathname)
528 (/show0 "filesys.lisp 500")
530 ;;; Call FUNCTION on matches.
531 (defun %enumerate-matches (pathname verify-existence follow-links function)
532 (/show0 "entering %ENUMERATE-MATCHES")
533 (when (pathname-type pathname)
534 (unless (pathname-name pathname)
535 (error "cannot supply a type without a name:~% ~S" pathname)))
536 (when (and (integerp (pathname-version pathname))
537 (member (pathname-type pathname) '(nil :unspecific)))
538 (error "cannot supply a version without a type:~% ~S" pathname))
539 (let ((directory (pathname-directory pathname)))
540 (/show0 "computed DIRECTORY")
542 (ecase (car directory)
544 (/show0 "absolute directory")
545 (%enumerate-directories "/" (cdr directory) pathname
546 verify-existence follow-links
549 (/show0 "relative directory")
550 (%enumerate-directories "" (cdr directory) pathname
551 verify-existence follow-links
553 (%enumerate-files "" pathname verify-existence function))))
555 ;;; Call FUNCTION on directories.
556 (defun %enumerate-directories (head tail pathname verify-existence
557 follow-links nodes function)
558 (declare (simple-string head))
559 (macrolet ((unix-xstat (name)
561 (sb!unix:unix-stat ,name)
562 (sb!unix:unix-lstat ,name)))
563 (with-directory-node-noted ((head) &body body)
564 `(multiple-value-bind (res dev ino mode)
566 (when (and res (eql (logand mode sb!unix:s-ifmt)
568 (let ((nodes (cons (cons dev ino) nodes)))
571 (let ((piece (car tail)))
574 (let ((head (concatenate 'string head piece)))
575 (with-directory-node-noted (head)
576 (%enumerate-directories (concatenate 'string head "/")
578 verify-existence follow-links
580 ((member :wild-inferiors)
581 (%enumerate-directories head (rest tail) pathname
582 verify-existence follow-links
584 (dolist (name (ignore-errors (directory-lispy-filenames head)))
585 (let ((subdir (concatenate 'string head name)))
586 (multiple-value-bind (res dev ino mode)
588 (declare (type (or fixnum null) mode))
589 (when (and res (eql (logand mode sb!unix:s-ifmt)
591 (unless (dolist (dir nodes nil)
592 (when (and (eql (car dir) dev)
595 (let ((nodes (cons (cons dev ino) nodes))
596 (subdir (concatenate 'string subdir "/")))
597 (%enumerate-directories subdir tail pathname
598 verify-existence follow-links
599 nodes function))))))))
600 ((or pattern (member :wild))
601 (dolist (name (directory-lispy-filenames head))
602 (when (or (eq piece :wild) (pattern-matches piece name))
603 (let ((subdir (concatenate 'string head name)))
604 (multiple-value-bind (res dev ino mode)
606 (declare (type (or fixnum null) mode))
608 (eql (logand mode sb!unix:s-ifmt)
610 (let ((nodes (cons (cons dev ino) nodes))
611 (subdir (concatenate 'string subdir "/")))
612 (%enumerate-directories subdir (rest tail) pathname
613 verify-existence follow-links
614 nodes function))))))))
616 (let ((head (concatenate 'string head "..")))
617 (with-directory-node-noted (head)
618 (%enumerate-directories (concatenate 'string head "/")
620 verify-existence follow-links
622 (%enumerate-files head pathname verify-existence function))))
624 ;;; Call FUNCTION on files.
625 (defun %enumerate-files (directory pathname verify-existence function)
626 (declare (simple-string directory))
627 (/show0 "entering %ENUMERATE-FILES")
628 (let ((name (%pathname-name pathname))
629 (type (%pathname-type pathname))
630 (version (%pathname-version pathname)))
631 (/show0 "computed NAME, TYPE, and VERSION")
632 (cond ((member name '(nil :unspecific))
633 (/show0 "UNSPECIFIC, more or less")
634 (when (or (not verify-existence)
635 (sb!unix:unix-file-kind directory))
636 (funcall function directory)))
637 ((or (pattern-p name)
641 (/show0 "WILD, more or less")
642 ;; I IGNORE-ERRORS here just because the original CMU CL
643 ;; code did. I think the intent is that it's not an error
644 ;; to request matches to a wild pattern when no matches
645 ;; exist, but I haven't tried to figure out whether
646 ;; everything is kosher. (E.g. what if we try to match a
647 ;; wildcard but we don't have permission to read one of the
648 ;; relevant directories?) -- WHN 2001-04-17
649 (dolist (complete-filename (ignore-errors
650 (directory-lispy-filenames directory)))
652 (file-name file-type file-version)
653 (let ((*ignore-wildcards* t))
654 (extract-name-type-and-version
655 complete-filename 0 (length complete-filename)))
656 (when (and (components-match file-name name)
657 (components-match file-type type)
658 (components-match file-version version))
662 complete-filename))))))
664 (/show0 "default case")
665 (let ((file (concatenate 'string directory name)))
666 (/show0 "computed basic FILE=..")
667 (/primitive-print file)
668 (unless (or (null type) (eq type :unspecific))
669 (/show0 "tweaking FILE for more-or-less-:UNSPECIFIC case")
670 (setf file (concatenate 'string file "." type)))
671 (unless (member version '(nil :newest :wild))
672 (/show0 "tweaking FILE for more-or-less-:WILD case")
673 (setf file (concatenate 'string file "."
674 (quick-integer-to-string version))))
675 (/show0 "finished possibly tweaking FILE=..")
676 (/primitive-print file)
677 (when (or (not verify-existence)
678 (sb!unix:unix-file-kind file t))
679 (/show0 "calling FUNCTION on FILE")
680 (funcall function file)))))))
682 (/show0 "filesys.lisp 603")
684 ;;; FIXME: Why do we need this?
685 (defun quick-integer-to-string (n)
686 (declare (type integer n))
687 (cond ((not (fixnump n))
688 (write-to-string n :base 10 :radix nil))
692 (concatenate 'simple-string "-"
693 (the simple-string (quick-integer-to-string (- n)))))
695 (do* ((len (1+ (truncate (integer-length n) 3)))
696 (res (make-string len))
702 (replace res res :start2 i :end2 len)
703 (shrink-vector res (- len i)))
704 (declare (simple-string res)
706 (multiple-value-setq (q r) (truncate q 10))
707 (setf (schar res i) (schar "0123456789" r))))))
711 (defun empty-relative-pathname-spec-p (x)
714 (or (equal (pathname-directory x) '(:relative))
715 ;; KLUDGE: I'm not sure this second check should really
716 ;; have to be here. But on sbcl-0.6.12.7,
717 ;; (PATHNAME-DIRECTORY (PATHNAME "")) is NIL, and
718 ;; (PATHNAME "") seems to act like an empty relative
719 ;; pathname, so in order to work with that, I test
720 ;; for NIL here. -- WHN 2001-05-18
721 (null (pathname-directory x)))
722 (null (pathname-name x))
723 (null (pathname-type x)))
724 ;; (The ANSI definition of "pathname specifier" has
725 ;; other cases, but none of them seem to admit the possibility
726 ;; of being empty and relative.)
729 ;;; Convert PATHNAME into a string that can be used with UNIX system
730 ;;; calls, or return NIL if no match is found. Search-lists and
731 ;;; wild-cards are expanded.
732 (defun unix-namestring (pathname-spec &optional (for-input t))
733 ;; The ordinary rules of converting Lispy paths to Unix paths break
734 ;; down for the current working directory, which Lisp thinks of as
735 ;; "" (more or less, and modulo ANSI's *DEFAULT-PATHNAME-DEFAULTS*,
736 ;; which unfortunately SBCL, as of sbcl-0.6.12.8, basically ignores)
737 ;; and Unix thinks of as ".". Since we're at the interface between
738 ;; Unix system calls and things like ENSURE-DIRECTORIES-EXIST which
739 ;; think the Lisp way, we perform the conversion.
741 ;; (FIXME: The *right* way to deal with this special case is to
742 ;; merge PATHNAME-SPEC with *DEFAULT-PATHNAME-DEFAULTS* here, after
743 ;; which it's not a relative pathname any more so the special case
744 ;; is no longer an issue. But until *DEFAULT-PATHNAME-DEFAULTS*
745 ;; works, we use this hack.)
746 (if (empty-relative-pathname-spec-p pathname-spec)
748 ;; Otherwise, the ordinary rules apply.
749 (let* ((possibly-logical-pathname (pathname pathname-spec))
750 (physical-pathname (if (typep possibly-logical-pathname
752 (namestring (translate-logical-pathname
753 possibly-logical-pathname))
754 possibly-logical-pathname))
755 (matches nil)) ; an accumulator for actual matches
756 (enumerate-matches (match physical-pathname nil
757 :verify-existence for-input)
758 (push match matches))
759 (case (length matches)
762 (t (error 'simple-file-error
763 :format-control "~S is ambiguous:~{~% ~A~}"
764 :format-arguments (list pathname-spec matches)))))))
766 ;;;; TRUENAME and PROBE-FILE
768 ;;; This is only trivially different from PROBE-FILE, which is silly
770 (defun truename (pathname)
772 "Return the pathname for the actual file described by PATHNAME.
773 An error of type FILE-ERROR is signalled if no such file exists,
774 or the pathname is wild."
775 (if (wild-pathname-p pathname)
776 (error 'simple-file-error
777 :format-control "can't use a wild pathname here"
779 (let ((result (probe-file pathname)))
781 (error 'simple-file-error
783 :format-control "The file ~S does not exist."
784 :format-arguments (list (namestring pathname))))
787 ;;; If PATHNAME exists, return its truename, otherwise NIL.
788 (defun probe-file (pathname)
790 "Return a pathname which is the truename of the file if it exists, or NIL
791 otherwise. An error of type FILE-ERROR is signaled if pathname is wild."
792 (when (wild-pathname-p pathname)
793 (error 'simple-file-error
795 :format-control "can't use a wild pathname here"))
796 (let ((namestring (unix-namestring pathname t)))
797 (when (and namestring (sb!unix:unix-file-kind namestring))
798 (let ((truename (sb!unix:unix-resolve-links
799 (sb!unix:unix-maybe-prepend-current-directory
802 (let ((*ignore-wildcards* t))
803 (pathname (sb!unix:unix-simplify-pathname truename))))))))
805 ;;;; miscellaneous other operations
807 (/show0 "filesys.lisp 700")
809 (defun rename-file (file new-name)
811 "Rename FILE to have the specified NEW-NAME. If FILE is a stream open to a
812 file, then the associated file is renamed."
813 (let* ((original (truename file))
814 (original-namestring (unix-namestring original t))
815 (new-name (merge-pathnames new-name original))
816 (new-namestring (unix-namestring new-name nil)))
817 (unless new-namestring
818 (error 'simple-file-error
820 :format-control "~S can't be created."
821 :format-arguments (list new-name)))
822 (multiple-value-bind (res error)
823 (sb!unix:unix-rename original-namestring new-namestring)
825 (error 'simple-file-error
827 :format-control "~@<couldn't rename ~2I~_~A ~I~_to ~2I~_~A: ~
829 :format-arguments (list original new-name (strerror error))))
831 (file-name file new-namestring))
832 (values new-name original (truename new-name)))))
834 (defun delete-file (file)
836 "Delete the specified FILE."
837 (let ((namestring (unix-namestring file t)))
839 (close file :abort t))
841 (error 'simple-file-error
843 :format-control "~S doesn't exist."
844 :format-arguments (list file)))
845 (multiple-value-bind (res err) (sb!unix:unix-unlink namestring)
847 (simple-file-perror "couldn't delete ~A" namestring err))))
850 ;;; (This is an ANSI Common Lisp function.)
852 ;;; This is obtained from the logical name \"home:\", which is set
853 ;;; up for us at initialization time.
854 (defun user-homedir-pathname (&optional host)
855 "Return the home directory of the user as a pathname."
856 (declare (ignore host))
857 ;; Note: CMU CL did #P"home:" here instead of using a call to
858 ;; PATHNAME. Delaying construction of the pathname until we're
859 ;; running in a target Lisp lets us avoid figuring out how to dump
860 ;; cross-compilation host Lisp PATHNAME objects into a target Lisp
861 ;; object file. It also might have a small positive effect on
862 ;; efficiency, in that we don't allocate a PATHNAME we don't need,
863 ;; but it it could also have a larger negative effect. Hopefully
864 ;; it'll be OK. -- WHN 19990714
867 (defun file-write-date (file)
869 "Return file's creation date, or NIL if it doesn't exist.
870 An error of type file-error is signaled if file is a wild pathname"
871 (if (wild-pathname-p file)
872 ;; FIXME: This idiom appears many times in this file. Perhaps it
873 ;; should turn into (CANNOT-BE-WILD-PATHNAME FILE). (C-B-W-P
874 ;; should be a macro, not a function, so that the error message
875 ;; is reported as coming from e.g. FILE-WRITE-DATE instead of
876 ;; from CANNOT-BE-WILD-PATHNAME itself.)
877 (error 'simple-file-error
879 :format-control "bad place for a wild pathname")
880 (let ((name (unix-namestring file t)))
883 (res dev ino mode nlink uid gid rdev size atime mtime)
884 (sb!unix:unix-stat name)
885 (declare (ignore dev ino mode nlink uid gid rdev size atime))
887 (+ unix-to-universal-time mtime)))))))
889 (defun file-author (file)
891 "Returns the file author as a string, or nil if the author cannot be
892 determined. Signals an error of type file-error if file doesn't exist,
893 or file is a wild pathname."
894 (if (wild-pathname-p file)
895 (error 'simple-file-error
897 "bad place for a wild pathname")
898 (let ((name (unix-namestring (pathname file) t)))
900 (error 'simple-file-error
902 :format-control "~S doesn't exist."
903 :format-arguments (list file)))
904 (multiple-value-bind (winp dev ino mode nlink uid)
905 (sb!unix:unix-stat name)
906 (declare (ignore dev ino mode nlink))
907 (if winp (lookup-login-name uid))))))
911 (/show0 "filesys.lisp 800")
913 (defun directory (pathname &key (all t) (check-for-subdirs t)
916 "Returns a list of pathnames, one for each file that matches the given
917 pathname. Supplying :ALL as NIL causes this to ignore Unix dot files. This
918 never includes Unix dot and dot-dot in the result. If :FOLLOW-LINKS is NIL,
919 then symbolic links in the result are not expanded. This is not the
920 default because TRUENAME does follow links, and the result pathnames are
921 defined to be the TRUENAME of the pathname (the truename of a link may well
922 be in another directory.)"
924 (enumerate-search-list
925 (pathname (merge-pathnames pathname
926 (make-pathname :name :wild
929 (enumerate-matches (name pathname)
931 (let ((slash (position #\/ name :from-end t)))
933 (= (1+ slash) (length name))
934 (char/= (schar name (1+ slash)) #\.))))
935 (push name results))))
936 (let ((*ignore-wildcards* t))
937 (mapcar (lambda (name)
938 (let ((name (if (and check-for-subdirs
939 (eq (sb!unix:unix-file-kind name)
941 (concatenate 'string name "/")
943 (if follow-links (truename name) (pathname name))))
944 (sort (delete-duplicates results :test #'string=) #'string<)))))
946 ;;;; translating Unix uid's
948 ;;;; FIXME: should probably move into unix.lisp
950 (defvar *uid-hash-table* (make-hash-table)
952 "hash table for keeping track of uid's and login names")
954 (/show0 "filesys.lisp 844")
956 ;;; LOOKUP-LOGIN-NAME translates a user id into a login name. Previous
957 ;;; lookups are cached in a hash table since groveling the passwd(s)
958 ;;; files is somewhat expensive. The table may hold NIL for id's that
959 ;;; cannot be looked up since this keeps the files from having to be
960 ;;; searched in their entirety each time this id is translated.
961 (defun lookup-login-name (uid)
962 (multiple-value-bind (login-name foundp) (gethash uid *uid-hash-table*)
965 (setf (gethash uid *uid-hash-table*)
966 (get-group-or-user-name :user uid)))))
968 ;;; GET-GROUP-OR-USER-NAME first tries "/etc/passwd" ("/etc/group")
969 ;;; since it is a much smaller file, contains all the local id's, and
970 ;;; most uses probably involve id's on machines one would login into.
971 ;;; Then if necessary, we look in "/etc/passwds" ("/etc/groups") which
972 ;;; is really long and has to be fetched over the net.
974 ;;; FIXME: Now that we no longer have lookup-group-name, we no longer need
975 ;;; the GROUP-OR-USER argument.
976 (defun get-group-or-user-name (group-or-user id)
978 "Returns the simple-string user or group name of the user whose uid or gid
979 is id, or NIL if no such user or group exists. Group-or-user is either
981 (let ((id-string (let ((*print-base* 10)) (prin1-to-string id))))
982 (declare (simple-string id-string))
983 (multiple-value-bind (file1 file2)
985 (:group (values "/etc/group" "/etc/groups"))
986 (:user (values "/etc/passwd" "/etc/passwd")))
987 (or (get-group-or-user-name-aux id-string file1)
988 (get-group-or-user-name-aux id-string file2)))))
990 ;;; FIXME: Isn't there now a POSIX routine to parse the passwd file?
991 ;;; getpwent? getpwuid?
992 (defun get-group-or-user-name-aux (id-string passwd-file)
993 (with-open-file (stream passwd-file)
995 (let ((entry (read-line stream nil)))
996 (unless entry (return nil))
997 (let ((name-end (position #\: (the simple-string entry)
1000 (let ((id-start (position #\: (the simple-string entry)
1001 :start (1+ name-end) :test #'char=)))
1004 (let ((id-end (position #\: (the simple-string entry)
1005 :start id-start :test #'char=)))
1007 (string= id-string entry
1008 :start2 id-start :end2 id-end))
1009 (return (subseq entry 0 name-end))))))))))))
1011 (/show0 "filesys.lisp 899")
1013 ;;; predicate to order pathnames by; goes by name
1014 (defun pathname-order (x y)
1015 (let ((xn (%pathname-name x))
1016 (yn (%pathname-name y)))
1018 (let ((res (string-lessp xn yn)))
1019 (cond ((not res) nil)
1020 ((= res (length (the simple-string xn))) t)
1021 ((= res (length (the simple-string yn))) nil)
1025 ;;;; DEFAULT-DIRECTORY stuff
1027 ;;;; FIXME: *DEFAULT-DIRECTORY-DEFAULTS* seems to be the ANSI way to
1028 ;;;; deal with this, so we should beef up *DEFAULT-DIRECTORY-DEFAULTS*
1029 ;;;; and make all the old DEFAULT-DIRECTORY stuff go away. (At that
1030 ;;;; time the need for UNIX-CHDIR will go away too, I think.)
1032 (defun default-directory ()
1034 "Return the pathname for the default directory. This is the place where
1035 a file will be written if no directory is specified. This may be changed
1037 (multiple-value-bind (gr dir-or-error) (sb!unix:unix-current-directory)
1039 (let ((*ignore-wildcards* t))
1040 (pathname (concatenate 'simple-string dir-or-error "/")))
1041 (error dir-or-error))))
1043 (defun %set-default-directory (new-val)
1044 (let ((namestring (unix-namestring new-val t)))
1046 (error "~S doesn't exist." new-val))
1047 (multiple-value-bind (gr error) (sb!unix:unix-chdir namestring)
1049 (setf (search-list "default:") (default-directory))
1050 (simple-file-perror "couldn't set default directory to ~S"
1055 (/show0 "filesys.lisp 934")
1057 (/show0 "entering what used to be !FILESYS-COLD-INIT")
1058 (defvar *default-pathname-defaults*
1059 (%make-pathname *unix-host* nil nil nil nil :newest))
1060 (setf (search-list "default:") (default-directory))
1061 (/show0 "leaving what used to be !FILESYS-COLD-INIT")
1063 (defun ensure-directories-exist (pathspec &key verbose (mode #o777))
1065 "Test whether the directories containing the specified file
1066 actually exist, and attempt to create them if they do not.
1067 The MODE argument is a CMUCL/SBCL-specific extension to control
1068 the Unix permission bits."
1069 (let* ((pathname (pathname pathspec))
1070 (pathname (if (typep pathname 'logical-pathname)
1071 (translate-logical-pathname pathname)
1074 (when (wild-pathname-p pathname)
1075 (error 'simple-file-error
1076 :format-control "bad place for a wild pathname"
1077 :pathname pathspec))
1078 (enumerate-search-list (pathname pathname)
1079 (let ((dir (pathname-directory pathname)))
1080 (loop for i from 1 upto (length dir)
1081 do (let ((newpath (make-pathname
1082 :host (pathname-host pathname)
1083 :device (pathname-device pathname)
1084 :directory (subseq dir 0 i))))
1085 (unless (probe-file newpath)
1086 (let ((namestring (namestring newpath)))
1088 (format *standard-output*
1089 "~&creating directory: ~A~%"
1091 (sb!unix:unix-mkdir namestring mode)
1092 (unless (probe-file namestring)
1093 (error 'simple-file-error
1095 :format-control "can't create directory ~A"
1096 :format-arguments (list namestring)))
1097 (setf created-p t)))))
1098 ;; Only the first path in a search-list is considered.
1099 (return (values pathname created-p))))))
1101 (/show0 "filesys.lisp 1000")