chrome-devtools-frontend
Version:
Chrome DevTools UI
342 lines (312 loc) • 10.4 kB
JavaScript
/*
* Copyright (C) 2013 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:
*
* * 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 Google Inc. 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 THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
* OWNER OR 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.
*/
import * as Common from '../common/common.js'; // eslint-disable-line no-unused-vars
import {ls} from '../platform/platform.js';
import * as TextUtils from '../text_utils/text_utils.js'; // eslint-disable-line no-unused-vars
import * as Workspace from '../workspace/workspace.js';
/**
* @typedef {{
* mimeType: string,
* metadata: ?Workspace.UISourceCode.UISourceCodeMetadata
* }}
*/
let UISourceCodeData; // eslint-disable-line no-unused-vars
/**
* @implements {Workspace.Workspace.Project}
*/
export class ContentProviderBasedProject extends Workspace.Workspace.ProjectStore {
/**
* @param {!Workspace.Workspace.WorkspaceImpl} workspace
* @param {string} id
* @param {!Workspace.Workspace.projectTypes} type
* @param {string} displayName
* @param {boolean} isServiceProject
*/
constructor(workspace, id, type, displayName, isServiceProject) {
super(workspace, id, type, displayName);
/** @type {!Map<string, !TextUtils.ContentProvider.ContentProvider>} */
this._contentProviders = new Map();
this._isServiceProject = isServiceProject;
/** @type {!WeakMap<!Workspace.UISourceCode.UISourceCode, !UISourceCodeData>} */
this._uiSourceCodeToData = new WeakMap();
workspace.addProject(this);
}
/**
* @override
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
* @returns {!Promise<!TextUtils.ContentProvider.DeferredContent>}
*/
async requestFileContent(uiSourceCode) {
const contentProvider =
/** @type {!TextUtils.ContentProvider.ContentProvider} */ (this._contentProviders.get(uiSourceCode.url()));
try {
const [content, isEncoded] =
await Promise.all([contentProvider.requestContent(), contentProvider.contentEncoded()]);
return {content: content.content, isEncoded, error: 'error' in content && content.error || ''};
} catch (err) {
// TODO(rob.paveza): CRBug 1013683 - Consider propagating exceptions full-stack
return {content: null, isEncoded: false, error: err ? String(err) : ls`Unknown error loading file`};
}
}
/**
* @override
* @return {boolean}
*/
isServiceProject() {
return this._isServiceProject;
}
/**
* @override
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
* @return {!Promise<?Workspace.UISourceCode.UISourceCodeMetadata>}
*/
async requestMetadata(uiSourceCode) {
const {metadata} = /** @type {!UISourceCodeData} */ (this._uiSourceCodeToData.get(uiSourceCode));
return metadata;
}
/**
* @override
* @return {boolean}
*/
canSetFileContent() {
return false;
}
/**
* @override
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
* @param {string} newContent
* @param {boolean} isBase64
* @return {!Promise<void>}
*/
async setFileContent(uiSourceCode, newContent, isBase64) {
}
/**
* @override
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
* @return {string}
*/
fullDisplayName(uiSourceCode) {
let parentPath = uiSourceCode.parentURL().replace(/^(?:https?|file)\:\/\//, '');
try {
parentPath = decodeURI(parentPath);
} catch (e) {
}
return parentPath + '/' + uiSourceCode.displayName(true);
}
/**
* @override
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
* @return {string}
*/
mimeType(uiSourceCode) {
const {mimeType} = /** @type {!UISourceCodeData} */ (this._uiSourceCodeToData.get(uiSourceCode));
return mimeType;
}
/**
* @override
* @return {boolean}
*/
canRename() {
return false;
}
/**
* @override
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
* @param {string} newName
* @param {function(boolean, string=, string=, !Common.ResourceType.ResourceType=):void} callback
*/
rename(uiSourceCode, newName, callback) {
const path = uiSourceCode.url();
this.performRename(path, newName, innerCallback.bind(this));
/**
* @param {boolean} success
* @param {string=} newName
* @this {ContentProviderBasedProject}
*/
function innerCallback(success, newName) {
if (success && newName) {
const copyOfPath = path.split('/');
copyOfPath[copyOfPath.length - 1] = newName;
const newPath = copyOfPath.join('/');
const contentProvider =
/** @type {!TextUtils.ContentProvider.ContentProvider} */ (this._contentProviders.get(path));
this._contentProviders.set(newPath, contentProvider);
this._contentProviders.delete(path);
this.renameUISourceCode(uiSourceCode, newName);
}
callback(success, newName);
}
}
/**
* @override
* @param {string} path
*/
excludeFolder(path) {
}
/**
* @override
* @param {string} path
* @return {boolean}
*/
canExcludeFolder(path) {
return false;
}
/**
* @override
* @param {string} path
* @param {?string} name
* @param {string} content
* @param {boolean=} isBase64
* @return {!Promise<?Workspace.UISourceCode.UISourceCode>}
*/
async createFile(path, name, content, isBase64) {
return null;
}
/**
* @override
* @return {boolean}
*/
canCreateFile() {
return false;
}
/**
* @override
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
*/
deleteFile(uiSourceCode) {
}
/**
* @override
*/
remove() {
}
/**
* @param {string} path
* @param {string} newName
* @param {function(boolean, string=):void} callback
*/
performRename(path, newName, callback) {
callback(false);
}
/**
* @override
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
* @param {string} query
* @param {boolean} caseSensitive
* @param {boolean} isRegex
* @return {!Promise<!Array<!TextUtils.ContentProvider.SearchMatch>>}
*/
searchInFileContent(uiSourceCode, query, caseSensitive, isRegex) {
const contentProvider =
/** @type {!TextUtils.ContentProvider.ContentProvider} */ (this._contentProviders.get(uiSourceCode.url()));
return contentProvider.searchInContent(query, caseSensitive, isRegex);
}
/**
* @override
* @param {!Workspace.Workspace.ProjectSearchConfig} searchConfig
* @param {!Array<string>} filesMathingFileQuery
* @param {!Common.Progress.Progress} progress
* @return {!Promise<!Array<string>>}
*/
async findFilesMatchingSearchRequest(searchConfig, filesMathingFileQuery, progress) {
/** @type {!Array<string>} */
const result = [];
progress.setTotalWork(filesMathingFileQuery.length);
await Promise.all(filesMathingFileQuery.map(searchInContent.bind(this)));
progress.done();
return result;
/**
* @param {string} path
* @this {ContentProviderBasedProject}
*/
async function searchInContent(path) {
const contentProvider =
/** @type {!TextUtils.ContentProvider.ContentProvider} */ (this._contentProviders.get(path));
let allMatchesFound = true;
for (const query of searchConfig.queries().slice()) {
const searchMatches =
await contentProvider.searchInContent(query, !searchConfig.ignoreCase(), searchConfig.isRegex());
if (!searchMatches.length) {
allMatchesFound = false;
break;
}
}
if (allMatchesFound) {
result.push(path);
}
progress.worked(1);
}
}
/**
* @override
* @param {!Common.Progress.Progress} progress
*/
indexContent(progress) {
Promise.resolve().then(progress.done.bind(progress));
}
/**
* @param {!Workspace.UISourceCode.UISourceCode} uiSourceCode
* @param {!TextUtils.ContentProvider.ContentProvider} contentProvider
* @param {?Workspace.UISourceCode.UISourceCodeMetadata} metadata
* @param {string} mimeType
*/
addUISourceCodeWithProvider(uiSourceCode, contentProvider, metadata, mimeType) {
this._contentProviders.set(uiSourceCode.url(), contentProvider);
this._uiSourceCodeToData.set(uiSourceCode, {mimeType, metadata});
this.addUISourceCode(uiSourceCode);
}
/**
* @param {string} url
* @param {!TextUtils.ContentProvider.ContentProvider} contentProvider
* @param {string} mimeType
* @return {!Workspace.UISourceCode.UISourceCode}
*/
addContentProvider(url, contentProvider, mimeType) {
const uiSourceCode = this.createUISourceCode(url, contentProvider.contentType());
this.addUISourceCodeWithProvider(uiSourceCode, contentProvider, null, mimeType);
return uiSourceCode;
}
/**
* @param {string} path
*/
removeFile(path) {
this._contentProviders.delete(path);
this.removeUISourceCode(path);
}
reset() {
this._contentProviders.clear();
this.removeProject();
this.workspace().addProject(this);
}
dispose() {
this._contentProviders.clear();
this.removeProject();
}
}