third_party/WebKit/Source/devtools/front_end/sources/SourcesSearchScope.js

/*
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY GOOGLE INC. AND ITS CONTRIBUTORS
 * "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 GOOGLE INC.
 * OR ITS CONTRIBUTORS 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.
 */

/**
 * @constructor
 * @implements {WebInspector.SearchScope}
 */
WebInspector.SourcesSearchScope = function()
{
    // FIXME: Add title once it is used by search controller.
    this._searchId = 0;
}

/**
 * @param {!WebInspector.UISourceCode} uiSourceCode1
 * @param {!WebInspector.UISourceCode} uiSourceCode2
 * @return {number}
 */
WebInspector.SourcesSearchScope._filesComparator = function(uiSourceCode1, uiSourceCode2)
{
    if (uiSourceCode1.isDirty() && !uiSourceCode2.isDirty())
        return -1;
    if (!uiSourceCode1.isDirty() && uiSourceCode2.isDirty())
        return 1;
    var networkURL1 = WebInspector.networkMapping.networkURL(uiSourceCode1);
    var networkURL2 = WebInspector.networkMapping.networkURL(uiSourceCode2);
    if (networkURL1 && !networkURL2)
        return -1;
    if (!networkURL1 && networkURL2)
        return 1;
    return String.naturalOrderComparator(uiSourceCode1.fullDisplayName(), uiSourceCode2.fullDisplayName());
}


WebInspector.SourcesSearchScope.prototype = {
    /**
     * @override
     * @param {!WebInspector.Progress} progress
     */
    performIndexing: function(progress)
    {
        this.stopSearch();

        var projects = this._projects();
        var compositeProgress = new WebInspector.CompositeProgress(progress);
        for (var i = 0; i < projects.length; ++i) {
            var project = projects[i];
            var projectProgress = compositeProgress.createSubProgress(project.uiSourceCodes().length);
            project.indexContent(projectProgress);
        }
    },

    /**
     * @return {!Array.<!WebInspector.Project>}
     */
    _projects: function()
    {
        /**
         * @param {!WebInspector.Project} project
         * @return {boolean}
         */
        function filterOutServiceProjects(project)
        {
            return !project.isServiceProject() || project.type() === WebInspector.projectTypes.Formatter;
        }

        /**
         * @param {!WebInspector.Project} project
         * @return {boolean}
         */
        function filterOutContentScriptsIfNeeded(project)
        {
            return WebInspector.moduleSetting("searchInContentScripts").get() || project.type() !== WebInspector.projectTypes.ContentScripts;
        }

        return WebInspector.workspace.projects().filter(filterOutServiceProjects).filter(filterOutContentScriptsIfNeeded);
    },

    /**
     * @override
     * @param {!WebInspector.ProjectSearchConfig} searchConfig
     * @param {!WebInspector.Progress} progress
     * @param {function(!WebInspector.FileBasedSearchResult)} searchResultCallback
     * @param {function(boolean)} searchFinishedCallback
     */
    performSearch: function(searchConfig, progress, searchResultCallback, searchFinishedCallback)
    {
        this.stopSearch();
        this._searchResultCandidates = [];
        this._searchResultCallback = searchResultCallback;
        this._searchFinishedCallback = searchFinishedCallback;
        this._searchConfig = searchConfig;

        var projects = this._projects();
        var barrier = new CallbackBarrier();
        var compositeProgress = new WebInspector.CompositeProgress(progress);
        var searchContentProgress = compositeProgress.createSubProgress();
        var findMatchingFilesProgress = new WebInspector.CompositeProgress(compositeProgress.createSubProgress());
        for (var i = 0; i < projects.length; ++i) {
            var project = projects[i];
            var weight = project.uiSourceCodes().length;
            var findMatchingFilesInProjectProgress = findMatchingFilesProgress.createSubProgress(weight);
            var barrierCallback = barrier.createCallback();
            var filesMathingFileQuery = this._projectFilesMatchingFileQuery(project, searchConfig);
            var callback = this._processMatchingFilesForProject.bind(this, this._searchId, project, filesMathingFileQuery, barrierCallback);
            project.findFilesMatchingSearchRequest(searchConfig, filesMathingFileQuery, findMatchingFilesInProjectProgress, callback);
        }
        barrier.callWhenDone(this._processMatchingFiles.bind(this, this._searchId, searchContentProgress, this._searchFinishedCallback.bind(this, true)));
    },

    /**
     * @param {!WebInspector.Project} project
     * @param {!WebInspector.ProjectSearchConfig} searchConfig
     * @param {boolean=} dirtyOnly
     * @return {!Array.<string>}
     */
    _projectFilesMatchingFileQuery: function(project, searchConfig, dirtyOnly)
    {
        var result = [];
        var uiSourceCodes = project.uiSourceCodes();
        for (var i = 0; i < uiSourceCodes.length; ++i) {
            var uiSourceCode = uiSourceCodes[i];
            if (dirtyOnly && !uiSourceCode.isDirty())
                continue;
            if (this._searchConfig.filePathMatchesFileQuery(uiSourceCode.fullDisplayName()))
                result.push(uiSourceCode.path());
        }
        result.sort(String.naturalOrderComparator);
        return result;
    },

    /**
     * @param {number} searchId
     * @param {!WebInspector.Project} project
     * @param {!Array.<string>} filesMathingFileQuery
     * @param {function()} callback
     * @param {!Array.<string>} files
     */
    _processMatchingFilesForProject: function(searchId, project, filesMathingFileQuery, callback, files)
    {
        if (searchId !== this._searchId) {
            this._searchFinishedCallback(false);
            return;
        }

        files.sort(String.naturalOrderComparator);
        files = files.intersectOrdered(filesMathingFileQuery, String.naturalOrderComparator);
        var dirtyFiles = this._projectFilesMatchingFileQuery(project, this._searchConfig, true);
        files = files.mergeOrdered(dirtyFiles, String.naturalOrderComparator);

        var uiSourceCodes = [];
        for (var i = 0; i < files.length; ++i) {
            var uiSourceCode = project.uiSourceCode(files[i]);
            if (uiSourceCode)
                uiSourceCodes.push(uiSourceCode);
        }
        uiSourceCodes.sort(WebInspector.SourcesSearchScope._filesComparator);
        this._searchResultCandidates = this._searchResultCandidates.mergeOrdered(uiSourceCodes, WebInspector.SourcesSearchScope._filesComparator);
        callback();
    },

    /**
     * @param {number} searchId
     * @param {!WebInspector.Progress} progress
     * @param {function()} callback
     */
    _processMatchingFiles: function(searchId, progress, callback)
    {
        if (searchId !== this._searchId) {
            this._searchFinishedCallback(false);
            return;
        }

        var files = this._searchResultCandidates;
        if (!files.length) {
            progress.done();
            callback();
            return;
        }

        progress.setTotalWork(files.length);

        var fileIndex = 0;
        var maxFileContentRequests = 20;
        var callbacksLeft = 0;

        for (var i = 0; i < maxFileContentRequests && i < files.length; ++i)
            scheduleSearchInNextFileOrFinish.call(this);

        /**
         * @param {!WebInspector.UISourceCode} uiSourceCode
         * @this {WebInspector.SourcesSearchScope}
         */
        function searchInNextFile(uiSourceCode)
        {
            if (uiSourceCode.isDirty())
                contentLoaded.call(this, uiSourceCode, uiSourceCode.workingCopy());
            else
                uiSourceCode.checkContentUpdated(true, contentUpdated.bind(this, uiSourceCode));
        }

        /**
         * @param {!WebInspector.UISourceCode} uiSourceCode
         * @this {WebInspector.SourcesSearchScope}
         */
        function contentUpdated(uiSourceCode)
        {
            uiSourceCode.requestContent(contentLoaded.bind(this, uiSourceCode));
        }

        /**
         * @this {WebInspector.SourcesSearchScope}
         */
        function scheduleSearchInNextFileOrFinish()
        {
            if (fileIndex >= files.length) {
                if (!callbacksLeft) {
                    progress.done();
                    callback();
                    return;
                }
                return;
            }

            ++callbacksLeft;
            var uiSourceCode = files[fileIndex++];
            setTimeout(searchInNextFile.bind(this, uiSourceCode), 0);
        }

        /**
         * @param {!WebInspector.UISourceCode} uiSourceCode
         * @param {?string} content
         * @this {WebInspector.SourcesSearchScope}
         */
        function contentLoaded(uiSourceCode, content)
        {
            /**
             * @param {!WebInspector.ContentProvider.SearchMatch} a
             * @param {!WebInspector.ContentProvider.SearchMatch} b
             */
            function matchesComparator(a, b)
            {
                return a.lineNumber - b.lineNumber;
            }

            progress.worked(1);
            var matches = [];
            var queries = this._searchConfig.queries();
            if (content !== null) {
                for (var i = 0; i < queries.length; ++i) {
                    var nextMatches = WebInspector.ContentProvider.performSearchInContent(content, queries[i], !this._searchConfig.ignoreCase(), this._searchConfig.isRegex());
                    matches = matches.mergeOrdered(nextMatches, matchesComparator);
                }
            }
            if (matches) {
                var searchResult = new WebInspector.FileBasedSearchResult(uiSourceCode, matches);
                this._searchResultCallback(searchResult);
            }

            --callbacksLeft;
            scheduleSearchInNextFileOrFinish.call(this);
        }
    },

    /**
     * @override
     */
    stopSearch: function()
    {
        ++this._searchId;
    },

    /**
     * @override
     * @param {!WebInspector.ProjectSearchConfig} searchConfig
     * @return {!WebInspector.FileBasedSearchResultsPane}
     */
    createSearchResultsPane: function(searchConfig)
    {
        return new WebInspector.FileBasedSearchResultsPane(searchConfig);
    }
}