├── tests.lisp ├── package.lisp ├── file-finder.asd ├── predicates.lisp ├── readme.org ├── file.lisp └── LICENSE /tests.lisp: -------------------------------------------------------------------------------- 1 | 2 | (in-package :file-finder) 3 | 4 | (uiop:add-package-local-nickname :finder :file-finder) 5 | 6 | ;; We find at least 1 file. 7 | ;; (#F"~/quicklisp/local-projects/fof/file.lisp") 8 | (let ((res (finder (path~ "fil") (extension= "lisp")))) 9 | (print res) 10 | (assert (length res))) 11 | 12 | 13 | (let ((file (first (finder "readme.org")))) 14 | (assert (not (equal 1970 15 | ;; creation-date returns 1970 16 | ;; (local-time:timestamp-year (creation-date file)))))) 17 | (local-time:timestamp-year (modification-date file)))))) 18 | -------------------------------------------------------------------------------- /package.lisp: -------------------------------------------------------------------------------- 1 | (defpackage file-finder 2 | (:documentation "File object finder, one package for the two project files (file class, finder predicates).") 3 | (:use #:common-lisp) 4 | (:import-from #:serapeum 5 | #:export-always 6 | #:->) 7 | (:local-nicknames (#:alex #:alexandria) 8 | (#:sera #:serapeum) 9 | (#:file-attributes #:org.shirakumo.file-attributes)) 10 | (:export 11 | ;; File class and readers: 12 | ;; (use M-x slime-export-class) 13 | #:file 14 | #:path 15 | #:inode 16 | #:link-count 17 | #:kind 18 | #:size 19 | #:disk-usage 20 | #:creation-date)) 21 | 22 | ;; predicates.lisp symbols are exported with serapeum:export-always in the file. 23 | -------------------------------------------------------------------------------- /file-finder.asd: -------------------------------------------------------------------------------- 1 | #-asdf3.1 (warning "`fof' used to require ASDF 3.1, after our update of <2024-04-23> that may not be the case anymore.") 2 | ;; <2024-04-23> After simplification and removal of inferred system, does this hold? 3 | 4 | (defsystem "file-finder" 5 | :version "0.2.0" 6 | :author "Pierre Neidhardt " 7 | :maintainer "vindarel <@ vindarel mailz.org>" 8 | :homepage "https://github.com/lisp-maintainers/file-finder" 9 | :licence "GPL3+" 10 | :description "File finder. Enable rapid file search, inspection and manipulation." 11 | :depends-on (:named-readtables 12 | :alexandria 13 | :serapeum 14 | :local-time 15 | :file-attributes 16 | :str) 17 | :components ((:file "package") 18 | (:file "file") 19 | (:file "predicates"))) 20 | -------------------------------------------------------------------------------- /predicates.lisp: -------------------------------------------------------------------------------- 1 | 2 | (in-package file-finder) 3 | 4 | (export-always 'date<) 5 | (defun date< (timestamp) 6 | "Return a file predicate that matches on modification time less recent than TIMESTAMP." 7 | (lambda (file) 8 | (local-time:timestamp< (modification-date file) timestamp))) 9 | 10 | (export-always 'date>) 11 | (defun date> (timestamp) 12 | "Return a file predicate that matches on modification time more recent than TIMESTAMP." 13 | (lambda (file) 14 | (local-time:timestamp> (modification-date file) timestamp))) 15 | 16 | (export-always 'extension=) 17 | (defun extension= (extension &rest more-extensions) 18 | "Return a predicate for files that match one of the provided extensions." 19 | (lambda (file) 20 | (some (sera:equals (extension file)) 21 | (cons extension more-extensions)))) 22 | 23 | ;; (export-always 'kind=) 24 | ;; (-> kind= (file-kind &rest file-kind) function) 25 | ;; (defun kind= (kind &rest more-kinds) 26 | ;; "Return a predicate for files that match one of the provided `file-kind's." 27 | ;; (lambda (file) 28 | ;; (some (sera:eqs (kind file)) 29 | ;; (cons kind more-kinds)))) 30 | 31 | ;; (deftype user-specifier () 32 | ;; "A `string' identifies the user name, a `fixnum' the user ID." 33 | ;; `(or string fixnum)) 34 | 35 | ;; (export-always 'user=) 36 | ;; (-> user= (user-specifier &rest user-specifier) function) 37 | ;; (defun user= (user &rest more-users) 38 | ;; "Return a predicate for files that match one of the provided `user-specifier's." 39 | ;; (lambda (file) 40 | ;; (let ((user-name (user file))) 41 | ;; (some (lambda (user) 42 | ;; (typecase user 43 | ;; (string (string= user-name user)) 44 | ;; (number (= user (user-id file))))) 45 | ;; (cons user more-users))))) 46 | 47 | ;; (deftype group-specifier () 48 | ;; "A `string' identifies the group name, a `fixnum' the group ID." 49 | ;; `(or string fixnum)) 50 | 51 | ;; (export-always 'group=) 52 | ;; (-> group= (group-specifier &rest group-specifier) function) 53 | ;; (defun group= (group &rest more-groups) 54 | ;; "Return a predicate for files that match one of the provided `group-specifier's." 55 | ;; (lambda (file) 56 | ;; (let ((group-name (group file))) 57 | ;; (some (lambda (group) 58 | ;; (typecase group 59 | ;; (string (string= group-name group)) 60 | ;; (number (= group (group-id file))))) 61 | ;; (cons group more-groups))))) 62 | 63 | 64 | (export-always 'path~) 65 | (defun path~ (path-element &rest more-path-elements) 66 | "Return a predicate that matches when one of the path elements is contained in 67 | the file path. 68 | 69 | Example: 70 | 71 | (file-finder:finder* :predicates (list (path~ \"file\" \"lisp\"))) 72 | ;; => (#F\"mediafile.lisp\" #F\"file.lisp\" #F\"predicates.lisp\")" 73 | (apply #'match-path path-element more-path-elements)) 74 | 75 | (export-always 'every-path~) 76 | (defun every-path~ (path-element &rest more-path-elements) 77 | "Return a predicate that matches when all the path elements are contained in 78 | the file path. 79 | 80 | Example: 81 | 82 | (file-finder:finder* :predicates (list (every-path~ \"file\" \"lisp\"))) 83 | ;; => (F\"file.lisp\")" 84 | (apply #'every-match-path path-element more-path-elements)) 85 | 86 | (export-always 'path$) 87 | (defun path$ (path-suffix &rest more-path-suffixes) 88 | "Return a predicate that matches when one of the path suffixes matches 89 | the file path." 90 | (apply #'match-path-end path-suffix more-path-suffixes)) 91 | 92 | (export-always 'name=) 93 | (defun name= (name &rest more-names) 94 | "Return a predicate that matches when one of the names matches, case sensitive, the file basename." 95 | (lambda (file) 96 | (some (lambda (name) 97 | (string= name (basename file))) 98 | (cons name more-names)))) 99 | 100 | (export-always 'iname=) 101 | (defun iname= (name &rest more-names) 102 | "Return a predicate that matches when one of the names matches, case insensitive, the file basename." 103 | (lambda (file) 104 | (some (lambda (name) 105 | (equalp name (basename file))) 106 | (cons name more-names)))) 107 | 108 | (export-always 'name~) 109 | (defun name~ (name &rest more-names) 110 | "Return a predicate that matches when one of the names is contained in the 111 | file basename (case sensitive). " 112 | (lambda (file) 113 | (some (lambda (name) 114 | (str:contains? name (basename file))) 115 | (cons name more-names)))) 116 | 117 | (export-always 'iname~) 118 | (defun iname~ (name &rest more-names) 119 | "Return a predicate that matches when one of the names is contained in the 120 | file basename (case insensitive). " 121 | (lambda (file) 122 | (some (lambda (name) 123 | (str:contains? name (basename file)) :ignore-case t) 124 | (cons name more-names)))) 125 | 126 | (export-always 'every-name~) 127 | (defun every-name~ (name &rest more-names) 128 | "Return a predicate that matches when all the names are contained in the 129 | file basename." 130 | (lambda (file) 131 | (every (lambda (name) 132 | (str:contains? name (basename file))) 133 | (cons name more-names)))) 134 | 135 | (defun depth< (level &optional (root (file *default-pathname-defaults*))) 136 | "Return a predicate that matches when the argument file is in a subdirectory 137 | of ROOT less deep than LEVEL." 138 | (apply #'match-depth< level root)) 139 | 140 | ;; (export-always 'executable?) 141 | ;; (defun executable? (file) 142 | ;; "Return T when this file has executable permissions. 143 | 144 | ;; Example: 145 | 146 | ;; (file-finder:finder* :predicates (list #'executable?))" 147 | ;; (intersection 148 | ;; (permissions file) 149 | ;; '(:user-exec :group-exec :other-exec))) 150 | 151 | (export-always 'hidden?) 152 | (defun hidden? (file) 153 | "Return T if this is a 'hidden' file. 154 | 155 | Unix only (hidden files start with \".\" (dot)." 156 | (str:starts-with? "." (basename file))) 157 | 158 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 159 | 160 | ;; TODO: needs to find a portable way for windows. 161 | ;; it could be moved into an extension package. 162 | ;; (export-always 'elf-binary?) 163 | ;; (defun elf-binary? (file) 164 | ;; (and (slot-boundp file 'mime-type) 165 | ;; (string= "application/x-executable" (mime-type file)))) 166 | 167 | ;; (export-always 'elf-library?) 168 | ;; (defun elf-library? (file) 169 | ;; (and (slot-boundp file 'mime-type) 170 | ;; (ppcre:scan "application/x-sharedlib" (first (mime-type file))))) 171 | -------------------------------------------------------------------------------- /readme.org: -------------------------------------------------------------------------------- 1 | #+TITLE: FILE-FINDER 2 | #+SUBTITLE: Quickly search and manipulate augmented file objects. 3 | 4 | *Warning:* This library is currently experimental. While perfectly usable as 5 | is, the application programming interface is prone to change in the future. 6 | 7 | <2024-08-30>: =file-finder= is on Ultralisp and is included in [[https://github.com/ciel-lang/CIEL/][CIEL]]. 8 | 9 | <2024-10-16>: =file-finder= is on Quicklisp, since the 2024-10 release. 10 | 11 | Please report any issue or suggestion, including: 12 | 13 | - Better function, variable, slot, class or package naming. 14 | - Better function arguments. 15 | - Filesystem issues. 16 | 17 | * Features 18 | 19 | Enable rapid file search, inspection and manipulation. 20 | 21 | - A =file= class which embeds the path and metadata such as size, 22 | ctime/mtime/atime. 23 | 24 | - Various path manipulation functions which supersede Common Lisp =pathname= 25 | related functions. 26 | 27 | Using =file= instead of =pathname= saves us from many pitfalls, for instance 28 | path with wildcards (such as `[`, `*`) are no longer special. 29 | 30 | - =finder= and =finder*= which return a list of files matching predicates. 31 | 32 | =finder= is a convenience wrapper around =finder*=. The latter has more 33 | options. 34 | 35 | - A =file-finder:syntax= readtable to enable the =#f"/path/to/file"= syntax, which 36 | mimicks =#p= for pathnames. 37 | 38 | In practice, it mostly supersedes: 39 | 40 | - Common Lisp pathnames (at least for existing files). 41 | - =find= for recursive and programmable file search. 42 | Unlike =find=, =finder='s predicates are extensible. 43 | - =du= 44 | - =touch= 45 | 46 | Note that FILE-FINDER is not meant to manipulate arbitrary paths of non-existing files. 47 | Consider using [[https://github.com/fourier/ppath][ppath]] instead. 48 | 49 | * Portability 50 | 51 | For now this is only tested on Unix-based systems. 52 | Help welcome if you need support for another system. 53 | 54 | * File search and recursive listing 55 | 56 | List all files in the current directory, recursively: 57 | 58 | #+begin_src lisp 59 | (finder) 60 | ; => (#F"~/co…/file-finder/LICENSE" 61 | ; #F"~/co…/file-finder/ffprobe.lisp" 62 | ; #F"~/co…/file-finder/file.lisp" 63 | ; #F"~/co…/file-finder/file-finder.asd" 64 | ; #F"~/co…/file-finder/mediafile.lisp" 65 | ; ...) 66 | 67 | ;; Same, with a given root, without descending into hidden directories and 68 | ;; without descending more than one level: 69 | (finder* :root (file ".") :recur-predicates (list (complement #'hidden?) 70 | (depth< 2))) 71 | #+end_src 72 | 73 | List files matching all the given predicates: 74 | 75 | #+begin_src lisp 76 | (finder "fil" (extension= "lisp")) 77 | ; => (#F"~/co…/file-finder/file.lisp") 78 | ;; Passing a string as a predicate specifier is equivalent to `path~': 79 | (finder (path~ "fil") (extension= "lisp")) 80 | 81 | ;; Passing a pathname is equivalent to `path$' (match end of path). 82 | #+end_src 83 | 84 | We include useful predicate or predicate 85 | generators you can complete against, see the list below. 86 | 87 | Passing a list of predicate specifiers connects them with a logical =or=. 88 | In other words, it returns the files matching at least one of the predicate 89 | specifiers: 90 | 91 | #+begin_src lisp 92 | (finder (list "fil" (extension= "asd"))) 93 | ;; this returns many results: 94 | ; => (#F"~/co…/file-finder/file.lisp" #F"~/co…/file-finder/file-finder.asd" #F"~/co…/file-finder/mediafile.lisp") 95 | 96 | ;; While this finds 1 file: 97 | (finder "fil" (extension= "asd")) 98 | #+end_src 99 | 100 | To get the file names, use =path=: 101 | 102 | #+begin_src lisp 103 | (mapcar #'path *) 104 | ; => "~/co…/file-finder/mediafile.lisp" (sans the #F reader macro) 105 | #+end_src 106 | 107 | For more complex predicate list nesting, you can leverage 108 | =alexandria:disjoin= and =alexandria:conjoin=. 109 | 110 | ** Hidden files and directories 111 | 112 | =file-finder= doesn't return hidden files by default (on Linux, files 113 | starting with ".") and doesn't visit hidden directories. 114 | 115 | You can search in them by setting 2 parameters: 116 | 117 | #+begin_src lisp 118 | ;; List hidden files, descend hidden directories. 119 | (let ((*include-hidden-files* t) 120 | (*descend-hidden-directories* t)) 121 | (finder)) 122 | #+end_src 123 | 124 | ** Exclude directories 125 | 126 | The =node_modules= directory is excluded by default. 127 | 128 | You can enlarge the list into =*exclude-directories*= (use pathnames 129 | with =#p"directory/"= instead of strings). 130 | 131 | ** List of predicates 132 | 133 | Most predicates are functions that accept one or many strings as 134 | arguments. In that case, they return a lambda function, that 135 | receives the file object as argument. For example: 136 | 137 | #+begin_src lisp 138 | (finder (lambda (file-object) 139 | (str:containsp "lisp" (path file-object)))) ;; get the path name from the file object. 140 | #+end_src 141 | 142 | # Some predicates do not take arguments, such as =executable?=. 143 | 144 | It is possible to use predicates that don't take arguments. 145 | 146 | In =predicates.lisp=, see: 147 | 148 | - =path~=: matches when one of the path elements is contained in the file path. 149 | - =every-path~=: same checks on the file path, but uses a logical =and=. 150 | - =path$=: matches when one of the path suffixes matches the file path. 151 | - =name==: matches when one of the names matches the file name (case sensitive). 152 | - =iname==: matches when one of the names matches the file name (case insensitive). 153 | - =name~=: matches when one of the names is contained in the file 154 | basename (and not the whole path), case sensitive. 155 | - =every-name~=: same checks on the file basename, but uses a logical =and=. 156 | - =iname~=: matches when one of the names is contained in the file, case insensitive. 157 | - =depth<=: matches when the argument file is in a subdirectory of ROOT less deep than LEVEL. 158 | - =elf-binary?= and =elf-library?=. 159 | 160 | * Make inspectable file objects 161 | 162 | #+begin_src lisp 163 | (file "file-finder.asd") 164 | ; => #F"~/co…/file-finder/file-finder.asd" 165 | 166 | (inspect *) 167 | ; => 168 | The object is a STANDARD-OBJECT of type FILE-FINDER/FILE::FILE. 169 | 0. PATH: "/home/lisp-maintainers/projects/file-finder/file-finder.asd" 170 | 1. INODE: 3223494 171 | 2. LINK-COUNT: 1 172 | 4. SIZE: 1565 173 | 5. DISK-USAGE: 12288 174 | 8. CREATION-DATE: @2023-11-16T19:08:16.000000+01:00 175 | 9. MODIFICATION-DATE: @2023-11-16T19:08:16.000000+01:00 176 | 10. ACCESS-DATE: @2024-04-22T17:50:58.000000+02:00 177 | 178 | ;; Enable reader macro: 179 | (named-readtables:in-readtable file-finder:syntax) 180 | ; => # 181 | 182 | ;; Now you can use the #f syntax: 183 | #f"file-finder.asd" 184 | ; => #F"~/co…/file-finder/file-finder.asd" 185 | 186 | ;; Recursive disk-usage, in bytes. 187 | (disk-usage #f".") 188 | ; => 1298432 189 | 190 | ;; Custom printer with abbreviations disabled: 191 | (setf *print-abbreviation-threshold* 0 192 | *print-abbreviate-home?* nil 193 | *print-size?* t 194 | *print-date?* t) 195 | ; => #F"/home/ambrevar/common-lisp/file-finder/file-finder.asd 348 Feb 28 16:56" 196 | #+end_src 197 | 198 | # ;; Set permissions 199 | # (setf (permissions #f"file-finder.asd") '(:user-read :user-write :group-read)) 200 | # ; => (:USER-READ :USER-WRITE :GROUP-READ) 201 | 202 | 203 | 204 | * Familiar path manipulation functions 205 | 206 | #+begin_src lisp 207 | (separator) 208 | ; => "/" 209 | 210 | (current-directory) 211 | ; => #F"~/co…/file-finder/" 212 | 213 | (extension #f"file-finder.asd") 214 | ; => "asd" 215 | (basename #f"../file-finder/file-finder.asd") 216 | ; => "file-finder.asd" 217 | (parent #f"file-finder.asd") 218 | ; => #F"~/co…/file-finder/" 219 | (relative-path #f"file-finder.asd" #f"..") 220 | ; => "file-finder/file-finder.asd 221 | 222 | (file? #f"file-finder.asd") 223 | ; => T 224 | (directory? #f"file-finder.asd") 225 | ; => NIL 226 | (let ((f #f"file-finder.asd")) 227 | (delete-file f) 228 | (exists? f)) 229 | ; => NIL 230 | #+end_src 231 | 232 | 233 | * Changelog and acknowledgements 234 | 235 | This library was cloned from [[https://gitlab.com/ambrevar/fof/][fof]] (file-object finder) by 236 | @ambrevar. FOF is richer in that its file object also gives: user and 237 | group IDs, stats, file kind (regular, executable) and permissions in 238 | user-readable format (:user-read, :user-write etc). 239 | 240 | We are most interested in the search features, hence the clone and the 241 | cleanup. We could re-include some of the removed features by relying 242 | on the newer [[https://github.com/Shinmera/file-attributes][file-attributes]] library. PR welcome. 243 | 244 | We did the following changes in this fork. 245 | 246 | 247 | ** 2024-04 248 | 249 | *** Removed Osicat dependency and related features 250 | 251 | - removed dependency on osicat, and added dependency on [[https://github.com/shinmera/file-attributes/][file-attributes]] 252 | - removed: getting the user, group, stats, permissions, of a file and 253 | the related finder predicates (user, group, kind, executable). 254 | 255 | In fof, an object has these slots: 256 | 257 | #+BEGIN_SRC text 258 | 0. PATH: "/home/lisp-maintainers/projects/file-finder/file-finder.asd" 259 | 1. INODE: 3223494 260 | 2. LINK-COUNT: 1 261 | 3. KIND: :REGULAR-FILE 262 | 4. SIZE: 1565 263 | 5. DISK-USAGE: 12288 264 | 6. USER-ID: 1000 265 | 7. GROUP-ID: 1000 266 | 8. CREATION-DATE: @2023-11-16T19:08:16.000000+01:00 267 | 9. MODIFICATION-DATE: @2023-11-16T19:08:16.000000+01:00 268 | 10. ACCESS-DATE: @2024-04-22T17:50:58.000000+02:00 269 | 11. PERMISSIONS: (:USER-READ :USER-WRITE :GROUP-READ :GROUP-WRITE :OTHER-READ) 270 | #+end_src 271 | 272 | In file-finder, these ones: 273 | 274 | #+BEGIN_SRC text 275 | 0. PATH: "/home/vince/quicklisp/local-projects/fof/readme.org" 276 | 1. INODE: 0 277 | 2. LINK-COUNT: 0 278 | 3. KIND: :REGULAR-FILE 279 | 4. SIZE: 0 280 | 5. DISK-USAGE: 0 281 | 6. CREATION-DATE: @1970-01-01T01:00:00.000000+01:00 <--- 1970 here 282 | 7. MODIFICATION-DATE: @2024-04-24T13:45:38.000000+02:00 283 | 8. ACCESS-DATE: @2024-04-24T13:45:38.000000+02:00 284 | #+end_src 285 | 286 | - removed dependency on =hu.dwim.defclass-star=. 287 | - removed dependency on =trivia=. 288 | - changed from package-inferred systems to traditional system (list 289 | dependencies in the .asd) 290 | - changed from one package per file to one package for the project: 291 | simplify symbols mangling, no need to import&reexport and a bit 292 | easier to type for the user. 293 | 294 | - added: don't return hidden files by default and don't recur into 295 | hidden directories (typically, .git/) (merged unmerged MR #2 of FOF). 296 | - added: exclude node_modules/ directory by default. 297 | 298 | *** Removed libmagic/magicffi dependency and dropped support for mime-type and file encoding 299 | 300 | - [[https://github.com/guicho271828/magicffi][magicffi]] is a FFI wrapper around [[https://en.wikipedia.org/wiki/File_(command)][libmagic]], a unix command to 301 | recognize the type of data contained in a file. It makes 302 | installation and distribution less straightforward, and is unix 303 | only. FOF used it to get the file mime type and file encoding, and 304 | to provide related filters. 305 | - see also [[https://github.com/Shinmera/trivial-mimes][trivial-mimes]]. It first does a simple association file 306 | type -> mime type, without looking at the file content. If that 307 | fails, it consults the =file= unix command. 308 | -------------------------------------------------------------------------------- /file.lisp: -------------------------------------------------------------------------------- 1 | 2 | (in-package file-finder) 3 | 4 | (defvar *touch-command* "touch") ; TODO: `utime' syscall binding is missing from Osicat. 5 | 6 | ;; TODO: Add option to follow symlinks or not. 7 | 8 | ;; TODO: Run multiple disk writes within a transation? 9 | ;; Need proper POSIX bindings. Can Osicat do all of them? 10 | ;; Could we edit files virtually? Does that even make sense? 11 | 12 | (export-always 'file-kind) 13 | (deftype file-kind () 14 | `(member :directory 15 | :character-device 16 | :block-device 17 | :regular-file 18 | :symbolic-link 19 | :socket 20 | :pipe)) 21 | 22 | (defclass file () 23 | ((path :initform (error "Path required") 24 | :initarg :path 25 | :type string 26 | :reader path) 27 | (inode :initform 0 28 | :reader inode) 29 | (link-count :initform 0 30 | :reader link-count) 31 | (kind :initform :regular-file ; "kind" because `type' is reserved by CL. 32 | :type file-kind 33 | :reader kind) 34 | (size :initform 0 35 | :reader size) 36 | (disk-usage :initform 0 37 | :reader disk-usage) 38 | ;; (user-id 0) 39 | ;; (group-id 0) 40 | ;; TODO: Include blocks? 41 | (creation-date :initform (local-time:unix-to-timestamp 0) 42 | :reader creation-date) 43 | (modification-date :initform (local-time:unix-to-timestamp 0) 44 | :reader modification-date) 45 | (access-date :initform (local-time:unix-to-timestamp 0) 46 | :reader access-date) 47 | ;; (permissions '() 48 | ;; :type (or null 49 | ;; (cons #.(cons 'member (mapcar #'first osicat::+permissions+))))) 50 | ) 51 | ;; (:accessor-name-transformer (hu.dwim.defclass-star:make-name-transformer name)) 52 | ;; Easily export symbols at once: M-x slime-export-class => exports 8 symbols at once. 53 | ;; (:export-slot-names-p t) 54 | ;; (:export-class-name-p t) 55 | ) 56 | 57 | ;; (defmethod (setf user-id) (id (file file)) 58 | ;; (osicat-posix::chown (path file) id (group-id file)) 59 | ;; (setf (slot-value file 'user-id) id)) 60 | 61 | ;; (defmethod (setf group-id) (id (file file)) 62 | ;; (osicat-posix::chown (path file) (user-id file) id) 63 | ;; (setf (slot-value file 'group-id) id)) 64 | 65 | ;; TODO: For now, date setters rely on GNU touch. Find a portable version. 66 | (defmethod (setf modification-date) (timestamp (file file)) 67 | "Set both the `modification-date' and the `access-date' of FILE." 68 | (uiop:run-program (list *touch-command* 69 | (format nil "--date=~a" (local-time:format-rfc3339-timestring nil timestamp)) 70 | (path file))) 71 | (setf (slot-value file 'modification-date) timestamp) 72 | (setf (slot-value file 'access-date) timestamp)) 73 | 74 | (defmethod (setf access-date) (timestamp (file file)) 75 | (uiop:run-program (list *touch-command* 76 | "-a" 77 | (format nil "--date=~a" (local-time:format-rfc3339-timestring nil timestamp)) 78 | (path file))) 79 | (setf (slot-value file 'modification-date) timestamp)) 80 | 81 | ;; (defmethod (setf permissions) (permissions (file file)) 82 | ;; (setf (osicat:file-permissions (path file)) permissions) 83 | ;; (setf (slot-value file 'permissions) permissions)) 84 | 85 | (defmethod uiop-path ((file file)) 86 | (uiop:parse-native-namestring (path file))) 87 | 88 | (defmethod uiop-path ((s string)) 89 | (uiop:parse-native-namestring s)) 90 | 91 | (defmethod uiop-path ((p pathname)) 92 | p) 93 | 94 | (defmethod path ((s string)) 95 | "Useful so that `path' can be called both on a `file' or a `string'. 96 | A trailing separator is automatically append for directories, if missing. 97 | This is to be consistent with the `path' method for `file'. " 98 | (or (ignore-errors (path (file s))) 99 | s)) 100 | 101 | (defmethod path ((p pathname)) 102 | "Useful so that `path' can be called both on a `file' or a `pathname'. 103 | A trailing separator is automatically append for directories, if missing. 104 | This is to be consistent with the `path' method for `file'." 105 | (or (ignore-errors (path (file p))) 106 | (namestring p))) 107 | 108 | (defmethod (setf path) (new-path (file file)) 109 | "Set FILE to a NEW-PATH. 110 | This renames the file." 111 | (unless (handler-case (or (ignore-errors (rename-file (path file) new-path)) 112 | ;; Fallback since `rename-file' does not work cross-device. 113 | (uiop:run-program (list "mv" (path file) new-path))) 114 | 115 | (error (c) 116 | (warn "Renaming ~s to ~s failed: ~a" (path file) new-path c) 117 | :error)) 118 | (setf (path file) new-path))) 119 | 120 | ;; (export-always 'user) 121 | ;; (defmethod user ((file file)) 122 | ;; "Return the name of the user owning the file." 123 | ;; (nth-value 0 (alex:assoc-value (osicat:user-info (user-id file)) :name))) 124 | 125 | (defun read-/etc/group () 126 | (let ((content (alex:read-file-into-string "/etc/group"))) 127 | (mapcar (alex:curry #'str:split ":") (str:split (string #\newline) content)))) 128 | 129 | ;; (defun group-id->name (id) 130 | ;; (let ((result (find (write-to-string id) (read-/etc/group) 131 | ;; :key #'caddr :test #'string=))) 132 | ;; (when result 133 | ;; (first result)))) 134 | 135 | ;; (export-always 'group) 136 | ;; (defmethod group ((file file)) 137 | ;; "Return the name of the group owning the file." 138 | ;; (group-id->name (group-id file))) 139 | 140 | (export-always 'extension) 141 | (defmethod extension ((file file)) 142 | "Return the file extension. 143 | If none, return the empty string unlike `pathname-type'." 144 | (or (pathname-type (path file)) 145 | "")) 146 | 147 | (defmethod (setf extension) (new-extension (file file)) 148 | "Set the FILE extension to NEW-EXTENSION. 149 | This renames the file." 150 | (setf (path file) 151 | (str:concat (namestring (uiop:pathname-directory-pathname (path file))) 152 | (pathname-name (path file)) 153 | "." 154 | new-extension))) 155 | 156 | (export-always 'directory?) 157 | (defmethod directory? ((file file)) 158 | (eq (kind file) :directory)) 159 | 160 | (export-always 'file?) 161 | (defgeneric file? (file) 162 | (:documentation "Return T if this object is a file-finder:file object.")) 163 | 164 | (defmethod file? ((file file)) 165 | (eq (kind file) :regular-file)) 166 | 167 | (defmethod file? (file) 168 | nil) 169 | 170 | (export-always 'file=?) 171 | (defun file=? (file1 file2) 172 | "Return true if FILE1 and FILE2 point to the same file. 173 | They might not be the same objects." 174 | (and (typep file1 'file) (typep file2 'file) 175 | (string= (path file1) 176 | (path file2)))) 177 | 178 | (export-always 'separator) 179 | (defun separator (&optional char?) 180 | (if char? 181 | (uiop:directory-separator-for-host) 182 | (string (uiop:directory-separator-for-host)))) 183 | 184 | (export-always 'basename) 185 | (defmethod basename ((file file)) 186 | "Return the file basename (including the extension). 187 | This returns the directory name for directories." 188 | (let* ((path (path file)) 189 | (path (if (str:ends-with? (separator) path) 190 | (subseq path 0 (1- (length path))) 191 | path)) 192 | (last-separator (or (position (separator :char) 193 | path :from-end t) 194 | 0))) 195 | (subseq path 196 | (1+ last-separator)))) 197 | 198 | (export-always 'exists?) 199 | (defmethod exists? ((file file)) 200 | (and 201 | (if (directory? file) 202 | (uiop:directory-exists-p (uiop-path file)) 203 | (uiop:file-exists-p (uiop-path file))) 204 | file)) 205 | 206 | (export-always 'parent) 207 | (defmethod parent ((file file)) 208 | "Return the parent directory of FILE." 209 | (file 210 | (if (directory? file) 211 | (uiop:pathname-parent-directory-pathname (uiop-path file)) 212 | (uiop:pathname-directory-pathname (uiop-path file))))) 213 | 214 | (export-always 'current-directory) 215 | (defun current-directory () 216 | (file *default-pathname-defaults*)) 217 | 218 | (export-always 'with-current-directory) 219 | (defmacro with-current-directory ((&optional file) &body body) 220 | "Call BODY while the POSIX current working directory is set to FILE. 221 | This is just like `uiop:with-current-directory' except that it takes a `file' 222 | object." 223 | `(uiop:call-with-current-directory ,(path file) #'(lambda () ,@body))) 224 | 225 | (defmethod disk-usage* ((file file)) 226 | "Compute recursive `disk-usage' of FILE if a directory. 227 | Return the new disk-usage." 228 | (if (directory? file) 229 | (if (list-directory file) 230 | (reduce #'+ (mapcar #'disk-usage* (list-directory file))) 231 | (size file)) 232 | (slot-value file 'disk-usage))) 233 | 234 | (defmethod disk-usage ((file file)) 235 | "Return FILE `disk-usage'. 236 | If FILE is a directory and it's disk-usage is 0 (never computed before), set it 237 | with `disk-usage*' and return the new value." 238 | (if (or (file? file) 239 | (/= 0 (slot-value file 'disk-usage))) 240 | (slot-value file 'disk-usage) 241 | (disk-usage* file))) 242 | 243 | (defun depth (file parent) 244 | "Return NIL if FILE is not a child of PARENT." 245 | (if (file=? file parent) 246 | 0 247 | (unless (file=? (parent file) file) 248 | (or (when (file=? (parent file) parent) 249 | 1) 250 | (alex:when-let ((level (depth (parent file) parent))) 251 | (1+ level)))))) 252 | 253 | (defun parent? (file parent) 254 | "Return true if PARENT is a parent of FILE." 255 | (sera:true (depth file parent))) 256 | 257 | (export-always 'relative-path) 258 | (defmethod relative-path ((path pathname) &optional (parent-directory (current-directory))) 259 | "Return PATH relative to PARENT-DIRECTORY. 260 | If PARENT-DIRECTORY is not a parent of PATH, return PATH." 261 | (let ((file-finder-path (uiop:unix-namestring path))) 262 | (if (str:starts-with? (path parent-directory) 263 | file-finder-path) 264 | (subseq file-finder-path (length (path parent-directory))) 265 | file-finder-path))) 266 | 267 | (defmethod relative-path ((file file) &optional (parent-directory (current-directory))) 268 | "Return path of FILE relative to PARENT-DIRECTORY. 269 | If PARENT-DIRECTORY is not a parent of FILE, return FILE's path." 270 | (if (str:starts-with? (path parent-directory) 271 | (path file)) 272 | (subseq (path file) (length (path parent-directory))) 273 | (path file))) 274 | 275 | (defun shorten-home (path) 276 | (let ((home (uiop:getenv "HOME"))) 277 | (if (str:starts-with? home path) 278 | (str:replace-first home "~" path) 279 | path))) 280 | 281 | (declaim (ftype (function (string &key 282 | (:abbreviation-length integer) 283 | (:abbreviation-threshold integer) 284 | (:abbreviate-home? boolean) 285 | (:ellipsis string)) 286 | string) 287 | shorten-path)) 288 | (defun shorten-path (path &key (abbreviation-length 1) ; TODO: Is there a library for this? 289 | (abbreviation-threshold 80) 290 | (abbreviate-home? t) 291 | (ellipsis "…")) 292 | "When ABBREVIATE-HOME?, abbreviate user home directory regardless of 293 | ABBREVIATION-THRESHOLD." 294 | (let* ((path (if abbreviate-home? 295 | (shorten-home path) 296 | path)) 297 | (length (length path))) 298 | (if (or (<= abbreviation-threshold 0) 299 | (<= length abbreviation-threshold)) 300 | path 301 | (let ((elements (str:split (separator) path :omit-nulls t))) 302 | (if elements 303 | (labels ((shorten (dir) 304 | (if (<= (length dir) (+ abbreviation-length (length ellipsis))) 305 | dir 306 | (str:concat 307 | (subseq dir 0 abbreviation-length) 308 | ellipsis))) 309 | (maybe-shorten (dir-list total-length) 310 | (if (or (null dir-list) 311 | (<= total-length abbreviation-threshold)) 312 | dir-list 313 | (let ((short (shorten (first dir-list)))) 314 | (cons short 315 | (maybe-shorten (rest dir-list) 316 | (- total-length 317 | (- (length (first dir-list)) 318 | (length short))))))))) 319 | (the (values string &optional) 320 | (str:concat (when (str:starts-with? (separator) path) 321 | (separator)) 322 | (str:join 323 | (separator) 324 | (append 325 | (maybe-shorten (butlast elements) length) 326 | (list (first (last elements))))) 327 | (when (str:ends-with? (separator) path) 328 | (separator))))) 329 | path))))) 330 | 331 | 332 | (defparameter +ls-time-format+ 333 | '(:short-month #\space (:day 2 #\ ) #\space (:hour 2) #\: (:min 2))) 334 | 335 | 336 | (export-always '*print-reader-macro*) 337 | (declaim (type string *print-reader-macro*)) 338 | (defvar *print-reader-macro* "#F") 339 | 340 | (export-always '*print-relative-path?*) 341 | (declaim (type boolean *print-relative-path?*)) 342 | (defvar *print-relative-path?* nil) 343 | 344 | (export-always '*print-abbreviate-home?*) 345 | (declaim (type boolean *print-abbreviate-home?*)) 346 | (defvar *print-abbreviate-home?* t 347 | "Whether to abbreviate the user home directory to '~'.") 348 | 349 | (export-always '*print-abbreviation-threshold*) 350 | (declaim (type integer *print-abbreviation-threshold*)) 351 | (defvar *print-abbreviation-threshold* 80 352 | "Abbreviate printout if strictly longer than this value. 353 | Set to 0 to stop abbreviating.") 354 | 355 | (export-always '*print-abbreviation-length*) 356 | (declaim (type integer *print-abbreviation-length*)) 357 | (defvar *print-abbreviation-length* 3 358 | "Maximum abbreviation length, for each directory.") 359 | 360 | (export-always '*print-size?*) 361 | (declaim (type boolean *print-size?*)) 362 | (defvar *print-size?* nil) 363 | 364 | (export-always '*print-date?*) 365 | (declaim (type boolean *print-date?*)) 366 | (defvar *print-date?* nil) 367 | 368 | (defun print-file (file stream 369 | &key 370 | (reader-macro *print-reader-macro*) 371 | (relative-path? *print-relative-path?*) 372 | (abbreviation-length *print-abbreviation-length*) 373 | (abbreviation-threshold *print-abbreviation-threshold*) 374 | (abbreviate-home? *print-abbreviate-home?*) 375 | (size? *print-size?*) 376 | (date? *print-date?*)) 377 | (let ((path (if relative-path? 378 | (relative-path file) 379 | (path file)))) 380 | (format stream "~a\"~a~a~a\"" 381 | reader-macro 382 | (shorten-path path :abbreviation-length abbreviation-length 383 | :abbreviation-threshold abbreviation-threshold 384 | :abbreviate-home? abbreviate-home?) 385 | (if (and (directory? file) 386 | (not (str:ends-with? "/" (path file)))) 387 | "/" "") 388 | (str:concat 389 | (when size? 390 | (str:concat " " (sera:format-human-size nil (size file) :space nil))) 391 | (when date? 392 | (str:concat " " (local-time:format-timestring nil (modification-date file) 393 | :format +ls-time-format+))))))) 394 | 395 | ;; TODO: Support `*print-pretty*'? 396 | ;; TODO: `*print-readably*'? 397 | ;; TODO: Auto-update file when mtime changes? Wouldn't it be too slow? 398 | (defmethod print-object ((file file) stream) 399 | (print-file file stream)) 400 | 401 | (export-always 'file) 402 | (defmethod initialize-instance :after ((file file) &key) 403 | (let* ((path (path file)) 404 | (native-path (ignore-errors 405 | (uiop:ensure-pathname path 406 | :truename t 407 | :want-existing t))) 408 | (native-namestring (uiop:native-namestring native-path))) 409 | 410 | (unless (or (uiop:file-exists-p native-path) 411 | (uiop:directory-exists-p native-path)) 412 | (error "~s is not a file path and does not exist" (or native-path path))) 413 | ;; TODO: What do we do with non-existent files (e.g. unsaved emacs buffers)? Just return nil? 414 | (setf (slot-value file 'path) native-namestring) 415 | 416 | (setf (slot-value file 'creation-date) 417 | ;; we get 1970 418 | (ignore-errors 419 | ;; unsaved emacs buffers starting with .# are annoying. 420 | (local-time:universal-to-timestamp 421 | (file-attributes:creation-time native-namestring)))) 422 | 423 | (setf (slot-value file 'modification-date) 424 | (ignore-errors 425 | (local-time:universal-to-timestamp 426 | (file-attributes:modification-time native-namestring)))) 427 | 428 | (setf (slot-value file 'access-date) 429 | (ignore-errors 430 | (local-time:universal-to-timestamp 431 | (file-attributes:access-time native-namestring)))) 432 | 433 | 434 | ;; Use `lstat' to _not_ follow symlinks, unlike `stat'. 435 | ;; (let ((stat (ignore-errors (osicat-posix:lstat native-path)))) 436 | ;; (if stat 437 | ;; ;; From Osicat's `file-permissions': 438 | ;; (flet ((stat-permissions (stat) 439 | ;; (let ((mode (osicat-posix:stat-mode stat))) 440 | ;; (loop for (name . value) in osicat::+permissions+ 441 | ;; when (plusp (logand mode value)) 442 | ;; collect name)))) 443 | ;; (setf 444 | ;; (slot-value file 'inode) (osicat-posix:stat-ino stat) 445 | ;; (slot-value file 'link-count) (osicat-posix:stat-nlink stat) 446 | ;; (slot-value file 'kind) (osicat:file-kind native-path) ; TODO: Don't recall `stat'. 447 | ;; (slot-value file 'size) (osicat-posix:stat-size stat) 448 | ;; (slot-value file 'disk-usage) (* 512 (osicat-posix:stat-blocks stat)) ; 512 as per (2)stat. 449 | ;; (slot-value file 'user-id) (osicat-posix:stat-uid stat) 450 | ;; (slot-value file 'group-id) (osicat-posix:stat-gid stat) 451 | ;; ;; (slot-value file 'permissions) 452 | ;; ;; (stat-permissions stat) 453 | ;; )) 454 | ;; ;; Errors may happen in particular for broken symlinks, see 455 | ;; ;; https://github.com/osicat/osicat/issues/40 456 | ;; (warn "Failed to retrieve ~s metadata" (slot-value file 'path)))) 457 | )) 458 | 459 | (defun file (path) 460 | (make-instance 'file :path (if (typep path 'file) 461 | (path path) 462 | path))) 463 | 464 | (defun file-reader (stream char1 char2) 465 | (declare (ignore char1 char2)) 466 | (let ((path-string (read stream))) 467 | (check-type path-string string) 468 | (file path-string))) 469 | 470 | (export-always 'syntax) 471 | (named-readtables:defreadtable file-finder::syntax 472 | (:merge :standard) 473 | (:dispatch-macro-char #\# #\f 'file-reader)) 474 | 475 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 476 | (export-always 'list-directory) 477 | (defun list-directory (&optional (path (current-directory)) sort) 478 | "Return entries in PATH. 479 | By default, directories come first. 480 | If SORT is non nil, sort them alphabetically. 481 | Second value is the list of directories, third value is the non-directories." 482 | ;; TODO: Use locale to sort? 483 | (let* ((subdirs (mapcar #'file (uiop:subdirectories (uiop-path path)))) 484 | (subfiles (mapcar #'file (uiop:directory-files (uiop-path path)))) 485 | (result (append subdirs subfiles))) 486 | (values 487 | (if sort 488 | (sort result #'string< :key #'path) 489 | result) 490 | subdirs 491 | subfiles))) 492 | 493 | (export-always '*include-directories*) 494 | (defvar *include-directories* nil 495 | "When non-nil `finder' includes directories in its search results.") 496 | (export-always '*include-hidden-files*) 497 | (defvar *include-hidden-files* nil 498 | "When non-nil `finder' includes hidden files in the result.") 499 | (export-always '*descend-hidden-directories*) 500 | (defvar *descend-hidden-directories* nil 501 | "When non-nil `finder' descends into hidden directories as well.") 502 | 503 | (export-always '*exclude-directories*) 504 | (defparameter *exclude-directories* (list #p"node_modules/") 505 | "Exclude these directories. Typically: node_modules. 506 | 507 | Use pathnames with #p instead of simple strings.") 508 | 509 | (export-always '*file-constructor*) 510 | (defvar *file-constructor* #'file 511 | "Function that takes a path and returns a `file'-like object.") 512 | 513 | (defun ensure-match-path-predicates (predicates) 514 | "If a string is given inside PREDICATES, return a `match-path' predicate. 515 | 516 | This allows an easier use of finder*." 517 | (reverse 518 | (loop for pred in (uiop:ensure-list predicates) 519 | if (stringp pred) 520 | collect (match-path pred) 521 | else 522 | collect pred))) 523 | 524 | (export-always 'finder*) 525 | (defun finder* (&key 526 | (root (current-directory)) 527 | predicates 528 | recur-predicates) 529 | "List FILES (including directories) that satisfy all PREDICATES. 530 | Without PREDICATES, list all files. 531 | 532 | Recur in all subdirectories by default. 533 | With RECUR-PREDICATES, recur only in subdirectories that satisfy the list of predicates. 534 | " 535 | (let ((result '()) 536 | (predicates (ensure-match-path-predicates predicates))) 537 | (uiop:collect-sub*directories 538 | (uiop:ensure-directory-pathname (path root)) 539 | (constantly t) 540 | (lambda (dir) 541 | (every (alex:rcurry #'funcall (file dir)) recur-predicates)) 542 | (lambda (subdirectory) 543 | (setf result (nconc result 544 | (let ((subfiles (mapcar *file-constructor* 545 | (append (uiop:subdirectories subdirectory) 546 | (uiop:directory-files subdirectory))))) 547 | (if predicates 548 | (delete-if (lambda (file) 549 | (notevery (alex:rcurry #'funcall file) predicates)) 550 | subfiles) 551 | subfiles)))))) 552 | result)) 553 | 554 | (defun match-path (path-element &rest more-path-elements) 555 | "Return a predicate that matches when one of the path elements is contained in 556 | the file path. 557 | 558 | This is the one used when we give a string for predicate. 559 | 560 | Useful for `finder'." 561 | (lambda (file) 562 | (some (lambda (elem) 563 | (str:contains? elem (path file))) 564 | (cons path-element more-path-elements)))) 565 | 566 | (defun every-match-path (path-element &rest more-path-elements) 567 | "Return a predicate that matches when all path elements are contained in the file path. 568 | 569 | Useful for `finder' or `finder*', but giving strings one after the other should be sufficient." 570 | (lambda (file) 571 | (every (lambda (elem) 572 | (str:containsp elem (path file))) 573 | (cons path-element more-path-elements)))) 574 | 575 | #+(or) 576 | (finder "pack" "lisp") 577 | ;; is equal to: 578 | 579 | #+(or) 580 | (equal (finder* :predicates (list "pack" "lisp")) 581 | (finder* :predicates (every-match-path "pack" "lisp"))) 582 | 583 | 584 | (defun match-path-end (path-suffix &rest more-path-suffixes) 585 | "Return a predicate that matches when one of the path suffixes matches 586 | the file path. 587 | Useful for `finder'." 588 | (lambda (file) 589 | (some (lambda (suffix) 590 | (str:ends-with? (namestring suffix) (path file))) 591 | (cons path-suffix more-path-suffixes)))) 592 | 593 | (defun match-depth< (level &optional (root (current-directory))) 594 | "Return a predicate that matches when the argument file is in a subdirectory 595 | of ROOT less deep than LEVEL." 596 | (lambda (file) 597 | (< (depth file root) level))) 598 | 599 | (deftype function-specifier () 600 | `(or function 601 | (and symbol (satisfies fboundp)))) 602 | 603 | (defun %specifier->predicate (specifier) 604 | (cond 605 | ((and specifier 606 | (stringp specifier)) 607 | (match-path specifier)) 608 | ((and specifier 609 | (pathnamep specifier)) 610 | (match-path-end specifier)) 611 | ((consp specifier) 612 | (apply #'alex:disjoin 613 | (mapcar #'%specifier->predicate specifier))) 614 | ((and specifier 615 | (typep specifier 'function-specifier)) 616 | specifier) 617 | (t 618 | (error "Unknown predicate specifier: ~a" specifier)))) 619 | 620 | (export-always 'finder) 621 | (defun finder (&rest predicate-specifiers) ; TODO: Add convenient regexp support? Case-folding? Maybe str:*ignore-case* is enough. 622 | "List files in current directory that satisfy all PREDICATE-SPECIFIERS. 623 | Directories are ignored. 624 | Without PREDICATE-SPECIFIERS, list all files. 625 | 626 | A predicate specifier can be: 627 | 628 | - a string, in which case it is turned into (match-path STRING); 629 | - a pathname, in which case it is turned into (match-path-end PATHNAME); 630 | - a list of predicates, in which case it is turned into (apply #'alexandria:disjoin PREDICATES); 631 | - a function (a predicate). 632 | 633 | Passing a list of predicates connects them with a logical OR. 634 | 635 | Ignore all directories specified in *exclude-directories* (node_modules). 636 | 637 | Examples: 638 | 639 | (finder \"pred\" \"lisp\") ; => list all files that have these two strings in their path name. 640 | ;; => \"lisp\" matches \"quicklisp/local-projects/\". 641 | 642 | (finder \"file\" (extension= \"lisp\")) ; => list all files whose path contain \"file\" with a \".lisp\" extension. 643 | ;; => 644 | (#F\"~/quicklisp/local-projects/file-finder/predicates.lisp\") 645 | 646 | (finder (list \"file\" (extension= \"lisp\"))) ; => list all files matching one or the other predicate 647 | ; => many more results. 648 | 649 | 650 | For a more tunable finder, see `finder*'." 651 | (labels () 652 | (finder* :root (current-directory) 653 | :recur-predicates (append (unless *descend-hidden-directories* 654 | (list (complement #'hidden?))) 655 | 656 | ;; exclude node_modules. 657 | (when *exclude-directories* 658 | (mapcar #'complement 659 | (mapcar #'%specifier->predicate 660 | *exclude-directories*)))) 661 | 662 | :predicates (append (unless *include-directories* 663 | (list (complement #'directory?))) 664 | (unless *include-hidden-files* 665 | (list (complement #'hidden?))) 666 | (mapcar #'%specifier->predicate 667 | predicate-specifiers) 668 | 669 | ;; exclude node_modules. 670 | (when *exclude-directories* 671 | (mapcar #'complement 672 | (mapcar #'%specifier->predicate 673 | *exclude-directories*))))))) 674 | 675 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 676 | ;; `ls -l' proof-of-concept replacement. 677 | 678 | ;; (defun permissions->unix (permissions) 679 | ;; (format nil "~a~a~a~a~a~a~a~a~a" 680 | ;; (if (find :user-read permissions) "r" "-") 681 | ;; (if (find :user-write permissions) "w" "-") 682 | ;; (if (find :user-exec permissions) "x" "-") 683 | ;; (if (find :group-read permissions) "r" "-") 684 | ;; (if (find :group-write permissions) "w" "-") 685 | ;; (if (find :group-exec permissions) "x" "-") 686 | ;; (if (find :other-read permissions) "r" "-") 687 | ;; (if (find :other-write permissions) "w" "-") 688 | ;; (if (find :other-exec permissions) "x" "-"))) 689 | 690 | ;; (defun max-width (files reader &key (key #'write-to-string)) 691 | ;; (apply #'max (mapcar #'length 692 | ;; (mapcar (lambda (file) 693 | ;; (funcall key (funcall reader file))) 694 | ;; files)))) 695 | 696 | ;; (defun ls-l (&key human-readable?) 697 | ;; "Mimicks Unix' `ls -l'." 698 | ;; ;; TODO: Add support for file arguments? 699 | ;; (let* ((current-dir-entries (finder* :recur-predicates (list (constantly nil)))) 700 | ;; (size-column-width (max-width current-dir-entries #'size))) 701 | ;; (dolist (file current-dir-entries) 702 | ;; (format t (str:concat "~a~a ~a ~a ~a ~" (write-to-string size-column-width) "@a ~a ~a~%") 703 | ;; (if (directory? file) "d" "-") 704 | ;; (permissions->unix (permissions file)) 705 | ;; (link-count file) 706 | ;; (user file) 707 | ;; (group file) 708 | ;; (if human-readable? 709 | ;; (serapeum:format-file-size-human-readable nil (size file)) 710 | ;; (size file)) 711 | ;; (local-time:format-timestring nil (modification-date file) 712 | ;; :format +ls-time-format+) 713 | ;; (relative-path file))))) 714 | 715 | ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; 716 | 717 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------