1 module.exports = globSync
2 globSync.GlobSync = GlobSync
5 var rp = require('fs.realpath')
6 var minimatch = require('minimatch')
7 var Minimatch = minimatch.Minimatch
8 var Glob = require('./glob.js').Glob
9 var util = require('util')
10 var path = require('path')
11 var assert = require('assert')
12 var isAbsolute = require('path-is-absolute')
13 var common = require('./common.js')
14 var alphasort = common.alphasort
15 var alphasorti = common.alphasorti
16 var setopts = common.setopts
17 var ownProp = common.ownProp
18 var childrenIgnored = common.childrenIgnored
19 var isIgnored = common.isIgnored
21 function globSync (pattern, options) {
22 if (typeof options === 'function' || arguments.length === 3)
23 throw new TypeError('callback provided to sync glob\n'+
24 'See: https://github.com/isaacs/node-glob/issues/167')
26 return new GlobSync(pattern, options).found
29 function GlobSync (pattern, options) {
31 throw new Error('must provide pattern')
33 if (typeof options === 'function' || arguments.length === 3)
34 throw new TypeError('callback provided to sync glob\n'+
35 'See: https://github.com/isaacs/node-glob/issues/167')
37 if (!(this instanceof GlobSync))
38 return new GlobSync(pattern, options)
40 setopts(this, pattern, options)
45 var n = this.minimatch.set.length
46 this.matches = new Array(n)
47 for (var i = 0; i < n; i ++) {
48 this._process(this.minimatch.set[i], i, false)
53 GlobSync.prototype._finish = function () {
54 assert(this instanceof GlobSync)
57 this.matches.forEach(function (matchset, index) {
58 var set = self.matches[index] = Object.create(null)
59 for (var p in matchset) {
62 var real = rp.realpathSync(p, self.realpathCache)
65 if (er.syscall === 'stat')
66 set[self._makeAbs(p)] = true
77 GlobSync.prototype._process = function (pattern, index, inGlobStar) {
78 assert(this instanceof GlobSync)
80 // Get the first [n] parts of pattern that are all strings.
82 while (typeof pattern[n] === 'string') {
85 // now n is the index of the first one that is *not* a string.
87 // See if there's anything else
90 // if not, then this is rather simple
92 this._processSimple(pattern.join('/'), index)
96 // pattern *starts* with some non-trivial item.
97 // going to readdir(cwd), but not include the prefix in matches.
102 // pattern has some string bits in the front.
103 // whatever it starts with, whether that's 'absolute' like /foo/bar,
104 // or 'relative' like '../baz'
105 prefix = pattern.slice(0, n).join('/')
109 var remain = pattern.slice(n)
111 // get the list of entries.
115 else if (isAbsolute(prefix) || isAbsolute(pattern.join('/'))) {
116 if (!prefix || !isAbsolute(prefix))
117 prefix = '/' + prefix
122 var abs = this._makeAbs(read)
124 //if ignored, skip processing
125 if (childrenIgnored(this, read))
128 var isGlobStar = remain[0] === minimatch.GLOBSTAR
130 this._processGlobStar(prefix, read, abs, remain, index, inGlobStar)
132 this._processReaddir(prefix, read, abs, remain, index, inGlobStar)
136 GlobSync.prototype._processReaddir = function (prefix, read, abs, remain, index, inGlobStar) {
137 var entries = this._readdir(abs, inGlobStar)
139 // if the abs isn't a dir, then nothing can match!
143 // It will only match dot entries if it starts with a dot, or if
144 // dot is set. Stuff like @(.foo|.bar) isn't allowed.
146 var negate = !!this.minimatch.negate
147 var rawGlob = pn._glob
148 var dotOk = this.dot || rawGlob.charAt(0) === '.'
150 var matchedEntries = []
151 for (var i = 0; i < entries.length; i++) {
153 if (e.charAt(0) !== '.' || dotOk) {
155 if (negate && !prefix) {
161 matchedEntries.push(e)
165 var len = matchedEntries.length
166 // If there are no matched entries, then nothing matches.
170 // if this is the last remaining pattern bit, then no need for
171 // an additional stat *unless* the user has specified mark or
172 // stat explicitly. We know they exist, since readdir returned
175 if (remain.length === 1 && !this.mark && !this.stat) {
176 if (!this.matches[index])
177 this.matches[index] = Object.create(null)
179 for (var i = 0; i < len; i ++) {
180 var e = matchedEntries[i]
182 if (prefix.slice(-1) !== '/')
188 if (e.charAt(0) === '/' && !this.nomount) {
189 e = path.join(this.root, e)
191 this._emitMatch(index, e)
193 // This was the last one, and no stats were needed
197 // now test all matched entries as stand-ins for that part
200 for (var i = 0; i < len; i ++) {
201 var e = matchedEntries[i]
204 newPattern = [prefix, e]
207 this._process(newPattern.concat(remain), index, inGlobStar)
212 GlobSync.prototype._emitMatch = function (index, e) {
213 if (isIgnored(this, e))
216 var abs = this._makeAbs(e)
225 if (this.matches[index][e])
229 var c = this.cache[abs]
230 if (c === 'DIR' || Array.isArray(c))
234 this.matches[index][e] = true
241 GlobSync.prototype._readdirInGlobStar = function (abs) {
242 // follow all symlinked directories forever
243 // just proceed as if this is a non-globstar situation
245 return this._readdir(abs, false)
251 lstat = fs.lstatSync(abs)
253 if (er.code === 'ENOENT') {
254 // lstat failed, doesn't exist
259 var isSym = lstat && lstat.isSymbolicLink()
260 this.symlinks[abs] = isSym
262 // If it's not a symlink or a dir, then it's definitely a regular file.
263 // don't bother doing a readdir in that case.
264 if (!isSym && lstat && !lstat.isDirectory())
265 this.cache[abs] = 'FILE'
267 entries = this._readdir(abs, false)
272 GlobSync.prototype._readdir = function (abs, inGlobStar) {
275 if (inGlobStar && !ownProp(this.symlinks, abs))
276 return this._readdirInGlobStar(abs)
278 if (ownProp(this.cache, abs)) {
279 var c = this.cache[abs]
280 if (!c || c === 'FILE')
283 if (Array.isArray(c))
288 return this._readdirEntries(abs, fs.readdirSync(abs))
290 this._readdirError(abs, er)
295 GlobSync.prototype._readdirEntries = function (abs, entries) {
296 // if we haven't asked to stat everything, then just
297 // assume that everything in there exists, so we can avoid
298 // having to stat it a second time.
299 if (!this.mark && !this.stat) {
300 for (var i = 0; i < entries.length; i ++) {
310 this.cache[abs] = entries
312 // mark and cache dir-ness
316 GlobSync.prototype._readdirError = function (f, er) {
317 // handle errors, and cache the information
319 case 'ENOTSUP': // https://github.com/isaacs/node-glob/issues/205
320 case 'ENOTDIR': // totally normal. means it *does* exist.
321 var abs = this._makeAbs(f)
322 this.cache[abs] = 'FILE'
323 if (abs === this.cwdAbs) {
324 var error = new Error(er.code + ' invalid cwd ' + this.cwd)
325 error.path = this.cwd
331 case 'ENOENT': // not terribly unusual
335 this.cache[this._makeAbs(f)] = false
338 default: // some unusual error. Treat as failure.
339 this.cache[this._makeAbs(f)] = false
343 console.error('glob error', er)
348 GlobSync.prototype._processGlobStar = function (prefix, read, abs, remain, index, inGlobStar) {
350 var entries = this._readdir(abs, inGlobStar)
352 // no entries means not a dir, so it can never have matches
353 // foo.txt/** doesn't match foo.txt
357 // test without the globstar, and with every child both below
358 // and replacing the globstar.
359 var remainWithoutGlobStar = remain.slice(1)
360 var gspref = prefix ? [ prefix ] : []
361 var noGlobStar = gspref.concat(remainWithoutGlobStar)
363 // the noGlobStar pattern exits the inGlobStar state
364 this._process(noGlobStar, index, false)
366 var len = entries.length
367 var isSym = this.symlinks[abs]
369 // If it's a symlink, and we're in a globstar, then stop
370 if (isSym && inGlobStar)
373 for (var i = 0; i < len; i++) {
375 if (e.charAt(0) === '.' && !this.dot)
378 // these two cases enter the inGlobStar state
379 var instead = gspref.concat(entries[i], remainWithoutGlobStar)
380 this._process(instead, index, true)
382 var below = gspref.concat(entries[i], remain)
383 this._process(below, index, true)
387 GlobSync.prototype._processSimple = function (prefix, index) {
388 // XXX review this. Shouldn't it be doing the mounting etc
389 // before doing stat? kinda weird?
390 var exists = this._stat(prefix)
392 if (!this.matches[index])
393 this.matches[index] = Object.create(null)
395 // If it doesn't exist, then just mark the lack of results
399 if (prefix && isAbsolute(prefix) && !this.nomount) {
400 var trail = /[\/\\]$/.test(prefix)
401 if (prefix.charAt(0) === '/') {
402 prefix = path.join(this.root, prefix)
404 prefix = path.resolve(this.root, prefix)
410 if (process.platform === 'win32')
411 prefix = prefix.replace(/\\/g, '/')
413 // Mark this as a match
414 this._emitMatch(index, prefix)
417 // Returns either 'DIR', 'FILE', or false
418 GlobSync.prototype._stat = function (f) {
419 var abs = this._makeAbs(f)
420 var needDir = f.slice(-1) === '/'
422 if (f.length > this.maxLength)
425 if (!this.stat && ownProp(this.cache, abs)) {
426 var c = this.cache[abs]
428 if (Array.isArray(c))
431 // It exists, but maybe not how we need it
432 if (!needDir || c === 'DIR')
435 if (needDir && c === 'FILE')
438 // otherwise we have to stat, because maybe c=true
439 // if we know it exists, but not what it is.
443 var stat = this.statCache[abs]
447 lstat = fs.lstatSync(abs)
449 if (er && (er.code === 'ENOENT' || er.code === 'ENOTDIR')) {
450 this.statCache[abs] = false
455 if (lstat && lstat.isSymbolicLink()) {
457 stat = fs.statSync(abs)
466 this.statCache[abs] = stat
470 c = stat.isDirectory() ? 'DIR' : 'FILE'
472 this.cache[abs] = this.cache[abs] || c
474 if (needDir && c === 'FILE')
480 GlobSync.prototype._mark = function (p) {
481 return common.mark(this, p)
484 GlobSync.prototype._makeAbs = function (f) {
485 return common.makeAbs(this, f)