/* * 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: * * * 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. */ WebInspector.AuditsPanel = function() { WebInspector.Panel.call(this, "audits"); this.createSidebar(); this.auditsTreeElement = new WebInspector.SidebarSectionTreeElement("", {}, true); this.sidebarTree.appendChild(this.auditsTreeElement); this.auditsTreeElement.listItemElement.addStyleClass("hidden"); this.auditsTreeElement.expand(); this.auditsItemTreeElement = new WebInspector.AuditsSidebarTreeElement(); this.auditsTreeElement.appendChild(this.auditsItemTreeElement); this.auditResultsTreeElement = new WebInspector.SidebarSectionTreeElement(WebInspector.UIString("RESULTS"), {}, true); this.sidebarTree.appendChild(this.auditResultsTreeElement); this.auditResultsTreeElement.expand(); this.clearResultsButton = new WebInspector.StatusBarButton(WebInspector.UIString("Clear audit results."), "clear-status-bar-item"); this.clearResultsButton.addEventListener("click", this._clearButtonClicked.bind(this), false); this.viewsContainerElement = document.createElement("div"); this.viewsContainerElement.id = "audit-views"; this.element.appendChild(this.viewsContainerElement); this._constructCategories(); this._launcherView = new WebInspector.AuditLauncherView(this.initiateAudit.bind(this)); for (id in this.categoriesById) this._launcherView.addCategory(this.categoriesById[id]); } WebInspector.AuditsPanel.prototype = { get toolbarItemLabel() { return WebInspector.UIString("Audits"); }, get statusBarItems() { return [this.clearResultsButton.element]; }, get mainResourceLoadTime() { return this._mainResourceLoadTime; }, set mainResourceLoadTime(x) { this._mainResourceLoadTime = x; this._didMainResourceLoad(); }, get mainResourceDOMContentTime() { return this._mainResourceDOMContentTime; }, set mainResourceDOMContentTime(x) { this._mainResourceDOMContentTime = x; }, get categoriesById() { return this._auditCategoriesById; }, addCategory: function(category) { this.categoriesById[category.id] = category; this._launcherView.addCategory(category); }, getCategory: function(id) { return this.categoriesById[id]; }, _constructCategories: function() { this._auditCategoriesById = {}; for (var categoryCtorID in WebInspector.AuditCategories) { var auditCategory = new WebInspector.AuditCategories[categoryCtorID](); auditCategory._id = categoryCtorID; this.categoriesById[categoryCtorID] = auditCategory; } }, _executeAudit: function(categories, resultCallback) { var resources = WebInspector.networkResources; var rulesRemaining = 0; for (var i = 0; i < categories.length; ++i) rulesRemaining += categories[i].ruleCount; var results = []; var mainResourceURL = WebInspector.mainResource.url; function ruleResultReadyCallback(categoryResult, ruleResult) { if (ruleResult && ruleResult.children) categoryResult.addRuleResult(ruleResult); --rulesRemaining; if (!rulesRemaining && resultCallback) resultCallback(mainResourceURL, results); } if (!rulesRemaining) { resultCallback(mainResourceURL, results); return; } for (var i = 0; i < categories.length; ++i) { var category = categories[i]; var result = new WebInspector.AuditCategoryResult(category); results.push(result); category.run(resources, ruleResultReadyCallback.bind(null, result)); } }, _auditFinishedCallback: function(launcherCallback, mainResourceURL, results) { var children = this.auditResultsTreeElement.children; var ordinal = 1; for (var i = 0; i < children.length; ++i) { if (children[i].mainResourceURL === mainResourceURL) ordinal++; } var resultTreeElement = new WebInspector.AuditResultSidebarTreeElement(results, mainResourceURL, ordinal); this.auditResultsTreeElement.appendChild(resultTreeElement); resultTreeElement.reveal(); resultTreeElement.select(); if (launcherCallback) launcherCallback(); }, initiateAudit: function(categoryIds, runImmediately, launcherCallback) { if (!categoryIds || !categoryIds.length) return; var categories = []; for (var i = 0; i < categoryIds.length; ++i) categories.push(this.categoriesById[categoryIds[i]]); function initiateAuditCallback(categories, launcherCallback) { this._executeAudit(categories, this._auditFinishedCallback.bind(this, launcherCallback)); } if (runImmediately) initiateAuditCallback.call(this, categories, launcherCallback); else this._reloadResources(initiateAuditCallback.bind(this, categories, launcherCallback)); }, _reloadResources: function(callback) { this._pageReloadCallback = callback; InspectorBackend.reloadPage(false); }, _didMainResourceLoad: function() { if (this._pageReloadCallback) { var callback = this._pageReloadCallback; delete this._pageReloadCallback; callback(); } }, showResults: function(categoryResults) { if (!categoryResults._resultView) categoryResults._resultView = new WebInspector.AuditResultView(categoryResults); this.visibleView = categoryResults._resultView; }, showLauncherView: function() { this.visibleView = this._launcherView; }, get visibleView() { return this._visibleView; }, set visibleView(x) { if (this._visibleView === x) return; if (this._visibleView) this._visibleView.hide(); this._visibleView = x; if (x) x.show(this.viewsContainerElement); }, attach: function() { WebInspector.Panel.prototype.attach.call(this); this.auditsItemTreeElement.select(); }, updateMainViewWidth: function(width) { this.viewsContainerElement.style.left = width + "px"; }, _clearButtonClicked: function() { this.auditsItemTreeElement.reveal(); this.auditsItemTreeElement.select(); this.auditResultsTreeElement.removeChildren(); } } WebInspector.AuditsPanel.prototype.__proto__ = WebInspector.Panel.prototype; WebInspector.AuditCategory = function(displayName) { this._displayName = displayName; this._rules = []; } WebInspector.AuditCategory.prototype = { get id() { // this._id value is injected at construction time. return this._id; }, get displayName() { return this._displayName; }, get ruleCount() { this._ensureInitialized(); return this._rules.length; }, addRule: function(rule, severity) { rule.severity = severity; this._rules.push(rule); }, run: function(resources, callback) { this._ensureInitialized(); for (var i = 0; i < this._rules.length; ++i) this._rules[i].run(resources, callback); }, _ensureInitialized: function() { if (!this._initialized) { if ("initialize" in this) this.initialize(); this._initialized = true; } } } WebInspector.AuditRule = function(id, displayName) { this._id = id; this._displayName = displayName; } WebInspector.AuditRule.Severity = { Info: "info", Warning: "warning", Severe: "severe" } WebInspector.AuditRule.SeverityOrder = { "info": 3, "warning": 2, "severe": 1 } WebInspector.AuditRule.prototype = { get id() { return this._id; }, get displayName() { return this._displayName; }, set severity(severity) { this._severity = severity; }, run: function(resources, callback) { var result = new WebInspector.AuditRuleResult(this.displayName); result.severity = this._severity; this.doRun(resources, result, callback); }, doRun: function(resources, result, callback) { throw new Error("doRun() not implemented"); } } WebInspector.AuditCategoryResult = function(category) { this.title = category.displayName; this.ruleResults = []; } WebInspector.AuditCategoryResult.prototype = { addRuleResult: function(ruleResult) { this.ruleResults.push(ruleResult); } } WebInspector.AuditRuleResult = function(value, expanded, className) { this.value = value; this.className = className; this.expanded = expanded; this.violationCount = 0; } WebInspector.AuditRuleResult.linkifyDisplayName = function(url) { return WebInspector.linkifyURL(url, WebInspector.displayNameForURL(url)); } WebInspector.AuditRuleResult.resourceDomain = function(domain) { return domain || WebInspector.UIString("[empty domain]"); } WebInspector.AuditRuleResult.prototype = { addChild: function(value, expanded, className) { if (!this.children) this.children = []; var entry = new WebInspector.AuditRuleResult(value, expanded, className); this.children.push(entry); return entry; }, addURL: function(url) { return this.addChild(WebInspector.AuditRuleResult.linkifyDisplayName(url)); }, addURLs: function(urls) { for (var i = 0; i < urls.length; ++i) this.addURL(urls[i]); }, addSnippet: function(snippet) { return this.addChild(snippet, false, "source-code"); } } WebInspector.AuditsSidebarTreeElement = function() { this.small = false; WebInspector.SidebarTreeElement.call(this, "audits-sidebar-tree-item", WebInspector.UIString("Audits"), "", null, false); } WebInspector.AuditsSidebarTreeElement.prototype = { onattach: function() { WebInspector.SidebarTreeElement.prototype.onattach.call(this); }, onselect: function() { WebInspector.panels.audits.showLauncherView(); }, get selectable() { return true; }, refresh: function() { this.refreshTitles(); } } WebInspector.AuditsSidebarTreeElement.prototype.__proto__ = WebInspector.SidebarTreeElement.prototype; WebInspector.AuditResultSidebarTreeElement = function(results, mainResourceURL, ordinal) { this.results = results; this.mainResourceURL = mainResourceURL; WebInspector.SidebarTreeElement.call(this, "audit-result-sidebar-tree-item", String.sprintf("%s (%d)", mainResourceURL, ordinal), "", {}, false); } WebInspector.AuditResultSidebarTreeElement.prototype = { onselect: function() { WebInspector.panels.audits.showResults(this.results); }, get selectable() { return true; } } WebInspector.AuditResultSidebarTreeElement.prototype.__proto__ = WebInspector.SidebarTreeElement.prototype; // Contributed audit rules should go into this namespace. WebInspector.AuditRules = {}; // Contributed audit categories should go into this namespace. WebInspector.AuditCategories = {};