//
// Name: FileFinder.as
// Author: Duane Maxwell
//
// Copyright (c) 2007, Chumby Industries
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of Chumby Industries nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY CHUMBY INDUSTRIES ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL CHUMBY INDUSTRIES BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Usage:
//
// finder = new FileFinder("/mnt/usb");
// finder.matchFunction = function(file) { return true; };
// finder.target = this;
// finder.completionFunction = function(files) { trace(files); }
// finder.find();

_global.FileFinder = function(rootDirectory) {
    this._protocol = "file://"; // the protocol we're using
    this._directories = [ rootDirectory ];
    this._files = []; // the array that will hold the file paths
    this._dirXML = new XML(); // the XML object that will be used to traverese the directories
    this._dirXML.ignoreWhite = true;
    this._dirXML.__target = this;
    this._dirXML.onLoad = function(success) {
        if (success) {
            this.__target.processDirectory(this.firstChildOfType('directory'));
        }
        this._dirXML = undefined;
    }
}

//
// for each directory read, collect the matching files, and append any subdirectories to the queue, then
// search the next directory in the queue.  If the queue is empty, start processing the files.
//
FileFinder.prototype.processDirectory = function(dir) {
    var base = dir.attributes.path;
    var fileItems = dir.childrenOfTypeAnd('file',this.matchFunction);
    for (var i in fileItems) {
        this._files.push(base+'/'+fileItems[i].attributes.name);
    }
    var dirs = dir.childrenOfTypeAnd('directory',function(d) { return d.attributes.name.charAt(0)!='.'; });
    for (var i in dirs) {
        this._directories.push(base+'/'+dirs[i].attributes.name);
    }
    if (!this.find()) {
        this.completionFunction.call(this.target,this._files);
    }
}

//
// process the next directory in the queue, return false if none available
//
FileFinder.prototype.find = function() {
    if (this._directories.length>0) {
        var dir = this._directories.pop();
        this._dirXML.load(this._protocol+dir);
        return true;
    }
    return false;
}