forked from mirrors/gecko-dev
		
	
		
			
				
	
	
		
			722 lines
		
	
	
	
		
			26 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
			
		
		
	
	
			722 lines
		
	
	
	
		
			26 KiB
		
	
	
	
		
			JavaScript
		
	
	
	
	
	
| /* Any copyright is dedicated to the Public Domain.
 | |
|  * http://creativecommons.org/publicdomain/zero/1.0/ */
 | |
| 
 | |
| // Note to run this test similar to try server, you need to run:
 | |
| // ./mach package
 | |
| // ./mach mochitest --appname dist <path to test>
 | |
| 
 | |
| // Slow on asan builds.
 | |
| requestLongerTimeout(5);
 | |
| 
 | |
| var isDevtools = SimpleTest.harnessParameters.subsuite == "devtools";
 | |
| 
 | |
| var gExceptionPaths = [
 | |
|   "chrome://browser/content/defaultthemes/",
 | |
|   "chrome://browser/locale/searchplugins/",
 | |
|   "resource://app/defaults/blocklists/",
 | |
|   "resource://app/defaults/pinning/",
 | |
|   "resource://app/defaults/preferences/",
 | |
|   "resource://gre/modules/commonjs/",
 | |
|   "resource://gre/defaults/pref/",
 | |
| 
 | |
|   // These resources are referenced using relative paths from html files.
 | |
|   "resource://payments/",
 | |
|   "resource://normandy-content/shield-content-frame.js",
 | |
|   "resource://normandy-content/shield-content-process.js",
 | |
| 
 | |
|   // https://github.com/mozilla/activity-stream/issues/3053
 | |
|   "resource://activity-stream/data/content/tippytop/images/",
 | |
|   // https://github.com/mozilla/activity-stream/issues/3758
 | |
|   "resource://activity-stream/prerendered/",
 | |
| 
 | |
|   // browser/extensions/pdfjs/content/build/pdf.js#1999
 | |
|   "resource://pdf.js/web/images/",
 | |
| 
 | |
|   // Exclude all the metadata paths under the country metadata folder because these
 | |
|   // paths will be concatenated in FormAutofillUtils.jsm based on different country/region.
 | |
|   "resource://formautofill/addressmetadata/",
 | |
| ];
 | |
| 
 | |
| // These are not part of the omni.ja file, so we find them only when running
 | |
| // the test on a non-packaged build.
 | |
| if (AppConstants.platform == "macosx")
 | |
|   gExceptionPaths.push("resource://gre/res/cursors/");
 | |
| 
 | |
| var whitelist = [
 | |
|   // browser/extensions/pdfjs/content/PdfStreamConverter.jsm
 | |
|   {file: "chrome://pdf.js/locale/chrome.properties"},
 | |
|   {file: "chrome://pdf.js/locale/viewer.properties"},
 | |
| 
 | |
|   // security/manager/pki/resources/content/device_manager.js
 | |
|   {file: "chrome://pippki/content/load_device.xul"},
 | |
| 
 | |
|   // The l10n build system can't package string files only for some platforms.
 | |
|   // See bug 1339424 for why this is hard to fix.
 | |
|   {file: "chrome://global/locale/fallbackMenubar.properties",
 | |
|    platforms: ["linux", "win"]},
 | |
|   {file: "chrome://global/locale/printPageSetup.dtd", platforms: ["macosx"]},
 | |
|   {file: "chrome://global/locale/printPreviewProgress.dtd",
 | |
|    platforms: ["macosx"]},
 | |
|   {file: "chrome://global/locale/printProgress.dtd", platforms: ["macosx"]},
 | |
| 
 | |
|   // toolkit/content/aboutRights-unbranded.xhtml doesn't use aboutRights.css
 | |
|   {file: "chrome://global/skin/aboutRights.css", skipUnofficial: true},
 | |
| 
 | |
|   // devtools/client/inspector/bin/dev-server.js
 | |
|   {file: "chrome://devtools/content/inspector/markup/markup.xhtml",
 | |
|    isFromDevTools: true},
 | |
| 
 | |
|   // SpiderMonkey parser API, currently unused in browser/ and toolkit/
 | |
|   {file: "resource://gre/modules/reflect.jsm"},
 | |
| 
 | |
|   // extensions/pref/autoconfig/src/nsReadConfig.cpp
 | |
|   {file: "resource://gre/defaults/autoconfig/prefcalls.js"},
 | |
| 
 | |
|   // modules/libpref/Preferences.cpp
 | |
|   {file: "resource://gre/greprefs.js"},
 | |
| 
 | |
|   // browser/extensions/pdfjs/content/web/viewer.js
 | |
|   {file: "resource://pdf.js/build/pdf.worker.js"},
 | |
| 
 | |
|   // layout/mathml/nsMathMLChar.cpp
 | |
|   {file: "resource://gre/res/fonts/mathfontSTIXGeneral.properties"},
 | |
|   {file: "resource://gre/res/fonts/mathfontUnicode.properties"},
 | |
| 
 | |
|   // toolkit/components/places/ColorAnalyzer_worker.js
 | |
|   {file: "resource://gre/modules/ClusterLib.js"},
 | |
|   {file: "resource://gre/modules/ColorConversion.js"},
 | |
| 
 | |
|   // Needed by HiddenFrame.jsm, but can't be packaged test-only
 | |
|   {file: "chrome://global/content/win.xul"},
 | |
| 
 | |
|   // The l10n build system can't package string files only for some platforms.
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/mac/accessible.properties",
 | |
|    platforms: ["linux", "win"]},
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/mac/intl.properties",
 | |
|    platforms: ["linux", "win"]},
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/mac/platformKeys.properties",
 | |
|    platforms: ["linux", "win"]},
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/unix/accessible.properties",
 | |
|    platforms: ["macosx", "win"]},
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/unix/intl.properties",
 | |
|    platforms: ["macosx", "win"]},
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/unix/platformKeys.properties",
 | |
|    platforms: ["macosx", "win"]},
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/win/accessible.properties",
 | |
|    platforms: ["linux", "macosx"]},
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/win/intl.properties",
 | |
|    platforms: ["linux", "macosx"]},
 | |
|   {file: "resource://gre/chrome/en-US/locale/en-US/global-platform/win/platformKeys.properties",
 | |
|    platforms: ["linux", "macosx"]},
 | |
| 
 | |
|   // browser/extensions/pdfjs/content/web/viewer.js#7450
 | |
|   {file: "resource://pdf.js/web/debugger.js"},
 | |
| 
 | |
|   // Starting from here, files in the whitelist are bugs that need fixing.
 | |
|   // Bug 1339424 (wontfix?)
 | |
|   {file: "chrome://browser/locale/taskbar.properties",
 | |
|    platforms: ["linux", "macosx"]},
 | |
|   // Bug 1356031 (only used by devtools)
 | |
|   {file: "chrome://global/skin/icons/error-16.png"},
 | |
|   // Bug 1348362
 | |
|   {file: "chrome://global/skin/icons/warning-64.png", platforms: ["linux"]},
 | |
|   // Bug 1348526
 | |
|   {file: "chrome://global/skin/tree/sort-asc-classic.png", platforms: ["linux"]},
 | |
|   {file: "chrome://global/skin/tree/sort-asc.png", platforms: ["linux"]},
 | |
|   {file: "chrome://global/skin/tree/sort-dsc-classic.png", platforms: ["linux"]},
 | |
|   {file: "chrome://global/skin/tree/sort-dsc.png", platforms: ["linux"]},
 | |
|   // Bug 1344267
 | |
|   {file: "chrome://marionette/content/test_anonymous_content.xul"},
 | |
|   {file: "chrome://marionette/content/test_dialog.properties"},
 | |
|   {file: "chrome://marionette/content/test_dialog.xul"},
 | |
|   // Bug 1348533
 | |
|   {file: "chrome://mozapps/skin/downloads/buttons.png", platforms: ["macosx"]},
 | |
|   {file: "chrome://mozapps/skin/downloads/downloadButtons.png", platforms: ["linux", "win"]},
 | |
|   // Bug 1348558
 | |
|   {file: "chrome://mozapps/skin/update/downloadButtons.png",
 | |
|    platforms: ["linux"]},
 | |
|   // Bug 1348559
 | |
|   {file: "chrome://pippki/content/resetpassword.xul"},
 | |
|   // Bug 1351078
 | |
|   {file: "resource://gre/modules/Battery.jsm"},
 | |
|   // Bug 1337345
 | |
|   {file: "resource://gre/modules/Manifest.jsm"},
 | |
|   // Bug 1351097
 | |
|   {file: "resource://gre/modules/accessibility/AccessFu.jsm"},
 | |
|   // Bug 1356043
 | |
|   {file: "resource://gre/modules/PerfMeasurement.jsm"},
 | |
|   // Bug 1356045
 | |
|   {file: "chrome://global/content/test-ipc.xul"},
 | |
|   // Bug 1356036
 | |
|   {file: "resource://gre/modules/PerformanceWatcher-content.js"},
 | |
|   {file: "resource://gre/modules/PerformanceWatcher.jsm"},
 | |
|   // Bug 1378173 (warning: still used by devtools)
 | |
|   {file: "resource://gre/modules/Promise.jsm"},
 | |
| ];
 | |
| 
 | |
| whitelist = new Set(whitelist.filter(item =>
 | |
|   ("isFromDevTools" in item) == isDevtools &&
 | |
|   (!item.skipUnofficial || !AppConstants.MOZILLA_OFFICIAL) &&
 | |
|   (!item.platforms || item.platforms.includes(AppConstants.platform))
 | |
| ).map(item => item.file));
 | |
| 
 | |
| const ignorableWhitelist = new Set([
 | |
|   // The communicator.css file is kept for add-on backward compat.
 | |
|   "chrome://communicator/skin/communicator.css",
 | |
| 
 | |
|   // These 2 files are unreferenced only when building without the crash
 | |
|   // reporter (eg. Linux x64 asan builds on treeherder)
 | |
|   "chrome://global/locale/crashes.dtd",
 | |
|   "chrome://global/locale/crashes.properties",
 | |
| 
 | |
|   // The following files are outside of the omni.ja file, so we only catch them
 | |
|   // when testing on a non-packaged build.
 | |
| 
 | |
|   // toolkit/mozapps/extensions/nsBlocklistService.js
 | |
|   "resource://app/blocklist.xml",
 | |
| 
 | |
|   // dom/media/gmp/GMPParent.cpp
 | |
|   "resource://gre/gmp-clearkey/0.1/manifest.json",
 | |
| 
 | |
|   // Bug 1351669 - obsolete test file
 | |
|   "resource://gre/res/test.properties",
 | |
| ]);
 | |
| for (let entry of ignorableWhitelist) {
 | |
|   whitelist.add(entry);
 | |
| }
 | |
| 
 | |
| if (!isDevtools) {
 | |
|   // services/sync/modules/main.js
 | |
|   whitelist.add("resource://services-sync/service.js");
 | |
|   // services/sync/modules/service.js
 | |
|   for (let module of ["addons.js", "bookmarks.js", "forms.js", "history.js",
 | |
|                       "passwords.js", "prefs.js", "tabs.js",
 | |
|                       "extension-storage.js"]) {
 | |
|     whitelist.add("resource://services-sync/engines/" + module);
 | |
|   }
 | |
| 
 | |
| }
 | |
| 
 | |
| const gInterestingCategories = new Set([
 | |
|   "agent-style-sheets", "addon-provider-module", "webextension-modules",
 | |
|   "webextension-scripts", "webextension-schemas", "webextension-scripts-addon",
 | |
|   "webextension-scripts-content", "webextension-scripts-devtools"
 | |
| ]);
 | |
| 
 | |
| var gChromeReg = Cc["@mozilla.org/chrome/chrome-registry;1"]
 | |
|                  .getService(Ci.nsIChromeRegistry);
 | |
| var gChromeMap = new Map();
 | |
| var gOverrideMap = new Map();
 | |
| var gComponentsSet = new Set();
 | |
| 
 | |
| // In this map when the value is a Set of URLs, the file is referenced if any
 | |
| // of the files in the Set is referenced.
 | |
| // When the value is null, the file is referenced unconditionally.
 | |
| // When the value is a string, "whitelist-direct" means that we have not found
 | |
| // any reference in the code, but have a matching whitelist entry for this file.
 | |
| // "whitelist" means that the file is indirectly whitelisted, ie. a whitelisted
 | |
| // file causes this file to be referenced.
 | |
| var gReferencesFromCode = new Map();
 | |
| 
 | |
| var resHandler = Services.io.getProtocolHandler("resource")
 | |
|                          .QueryInterface(Ci.nsIResProtocolHandler);
 | |
| var gResourceMap = [];
 | |
| function trackResourcePrefix(prefix) {
 | |
|   let uri = Services.io.newURI("resource://" + prefix + "/");
 | |
|   gResourceMap.unshift([prefix, resHandler.resolveURI(uri)]);
 | |
| }
 | |
| trackResourcePrefix("gre");
 | |
| trackResourcePrefix("app");
 | |
| 
 | |
| function getBaseUriForChromeUri(chromeUri) {
 | |
|   let chromeFile = chromeUri + "gobbledygooknonexistentfile.reallynothere";
 | |
|   let uri = Services.io.newURI(chromeFile);
 | |
|   let fileUri = gChromeReg.convertChromeURL(uri);
 | |
|   return fileUri.resolve(".");
 | |
| }
 | |
| 
 | |
| function parseManifest(manifestUri) {
 | |
|   return fetchFile(manifestUri.spec).then(data => {
 | |
|     for (let line of data.split("\n")) {
 | |
|       let [type, ...argv] = line.split(/\s+/);
 | |
|       if (type == "content" || type == "skin" || type == "locale") {
 | |
|         let chromeUri = `chrome://${argv[0]}/${type}/`;
 | |
|         gChromeMap.set(getBaseUriForChromeUri(chromeUri), chromeUri);
 | |
|       } else if (type == "override" || type == "overlay") {
 | |
|         // Overlays aren't really overrides, but behave the same in
 | |
|         // that the overlay is only referenced if the original xul
 | |
|         // file is referenced somewhere.
 | |
|         let os = "os=" + Services.appinfo.OS;
 | |
|         if (!argv.some(s => s.startsWith("os=") && s != os)) {
 | |
|           gOverrideMap.set(Services.io.newURI(argv[1]).specIgnoringRef,
 | |
|                            Services.io.newURI(argv[0]).specIgnoringRef);
 | |
|         }
 | |
|       } else if (type == "category" && gInterestingCategories.has(argv[0])) {
 | |
|         gReferencesFromCode.set(argv[2], null);
 | |
|       } else if (type == "resource") {
 | |
|         trackResourcePrefix(argv[0]);
 | |
|       } else if (type == "component") {
 | |
|         gComponentsSet.add(argv[1]);
 | |
|       }
 | |
|     }
 | |
|   });
 | |
| }
 | |
| 
 | |
| function addCodeReference(url, fromURI) {
 | |
|   let from = convertToCodeURI(fromURI.spec);
 | |
| 
 | |
|   // Ignore self references.
 | |
|   if (url == from)
 | |
|     return;
 | |
| 
 | |
|   let ref;
 | |
|   if (gReferencesFromCode.has(url)) {
 | |
|     ref = gReferencesFromCode.get(url);
 | |
|     if (ref === null)
 | |
|       return;
 | |
|   } else {
 | |
|     // Mark any file referenced by a 'features' bootstrap.js file as
 | |
|     // unconditionally referenced. The features folder is only in
 | |
|     // resource://app/ for non-packaged builds.
 | |
|     if (/resource:\/\/app\/features\/[^/]+\/bootstrap\.js/.test(from)) {
 | |
|       gReferencesFromCode.set(url, null);
 | |
|       return;
 | |
|     }
 | |
|     ref = new Set();
 | |
|     gReferencesFromCode.set(url, ref);
 | |
|   }
 | |
|   ref.add(from);
 | |
| }
 | |
| 
 | |
| function listCodeReferences(refs) {
 | |
|   let refList = [];
 | |
|   if (refs) {
 | |
|     for (let ref of refs) {
 | |
|       refList.push(ref);
 | |
|     }
 | |
|   }
 | |
|   return refList.join(",");
 | |
| }
 | |
| 
 | |
| function parseCSSFile(fileUri) {
 | |
|   return fetchFile(fileUri.spec).then(data => {
 | |
|     for (let line of data.split("\n")) {
 | |
|       let urls = line.match(/url\([^()]+\)/g);
 | |
|       if (!urls) {
 | |
|         // @import rules can take a string instead of a url.
 | |
|         let importMatch = line.match(/@import ['"]?([^'"]*)['"]?/);
 | |
|         if (importMatch && importMatch[1]) {
 | |
|           let url = Services.io.newURI(importMatch[1], null, fileUri).spec;
 | |
|           addCodeReference(convertToCodeURI(url), fileUri);
 | |
|         }
 | |
|         continue;
 | |
|       }
 | |
| 
 | |
|       for (let url of urls) {
 | |
|         // Remove the url(" prefix and the ") suffix.
 | |
|         url = url.replace(/url\(([^)]*)\)/, "$1")
 | |
|                  .replace(/^"(.*)"$/, "$1")
 | |
|                  .replace(/^'(.*)'$/, "$1");
 | |
|         if (url.startsWith("data:"))
 | |
|           continue;
 | |
| 
 | |
|         try {
 | |
|           url = Services.io.newURI(url, null, fileUri).specIgnoringRef;
 | |
|           addCodeReference(convertToCodeURI(url), fileUri);
 | |
|         } catch (e) {
 | |
|           ok(false, "unexpected error while resolving this URI: " + url);
 | |
|         }
 | |
|       }
 | |
|     }
 | |
|   });
 | |
| }
 | |
| 
 | |
| function parseCodeFile(fileUri) {
 | |
|   return fetchFile(fileUri.spec).then(data => {
 | |
|     let baseUri;
 | |
|     for (let line of data.split("\n")) {
 | |
|       let urls =
 | |
|         line.match(/["'`]chrome:\/\/[a-zA-Z0-9-]+\/(content|skin|locale)\/[^"'` ]*["'`]/g);
 | |
|       if (!urls) {
 | |
|         urls = line.match(/["']resource:\/\/[^"']+["']/g);
 | |
|         if (urls && isDevtools &&
 | |
|             /baseURI: "resource:\/\/devtools\//.test(line)) {
 | |
|           baseUri = Services.io.newURI(urls[0].slice(1, -1));
 | |
|           continue;
 | |
|         }
 | |
|       }
 | |
|       if (!urls) {
 | |
|         // If there's no absolute chrome URL, look for relative ones in
 | |
|         // src and href attributes.
 | |
|         let match = line.match("(?:src|href)=[\"']([^$&\"']+)");
 | |
|         if (match && match[1]) {
 | |
|           let url = Services.io.newURI(match[1], null, fileUri).spec;
 | |
|           addCodeReference(convertToCodeURI(url), fileUri);
 | |
|         }
 | |
| 
 | |
|         if (isDevtools) {
 | |
|           let rules = [
 | |
|             ["gcli", "resource://devtools/shared/gcli/source/lib/gcli"],
 | |
|             ["devtools/client/locales", "chrome://devtools/locale"],
 | |
|             ["devtools/shared/locales", "chrome://devtools-shared/locale"],
 | |
|             ["devtools/shared/platform", "resource://devtools/shared/platform/chrome"],
 | |
|             ["devtools", "resource://devtools"]
 | |
|           ];
 | |
| 
 | |
|           match = line.match(/["']((?:devtools|gcli)\/[^\\#"']+)["']/);
 | |
|           if (match && match[1]) {
 | |
|             let path = match[1];
 | |
|             for (let rule of rules) {
 | |
|               if (path.startsWith(rule[0] + "/")) {
 | |
|                 path = path.replace(rule[0], rule[1]);
 | |
|                 if (!/\.(properties|js|jsm|json|css)$/.test(path))
 | |
|                   path += ".js";
 | |
|                 addCodeReference(path, fileUri);
 | |
|                 break;
 | |
|               }
 | |
|             }
 | |
|           }
 | |
| 
 | |
|           match = line.match(/require\(['"](\.[^'"]+)['"]\)/);
 | |
|           if (match && match[1]) {
 | |
|             let url = match[1];
 | |
|             url = Services.io.newURI(url, null, baseUri || fileUri).spec;
 | |
|             url = convertToCodeURI(url);
 | |
|             if (!/\.(properties|js|jsm|json|css)$/.test(url))
 | |
|               url += ".js";
 | |
|             if (url.startsWith("resource://")) {
 | |
|               addCodeReference(url, fileUri);
 | |
|             } else {
 | |
|               // if we end up with a chrome:// url here, it's likely because
 | |
|               // a baseURI to a resource:// path has been defined in another
 | |
|               // .js file that is loaded in the same scope, we can't detect it.
 | |
|             }
 | |
|           }
 | |
|         }
 | |
|         continue;
 | |
|       }
 | |
| 
 | |
|       for (let url of urls) {
 | |
|         // Remove quotes.
 | |
|         url = url.slice(1, -1);
 | |
|         // Remove ? or \ trailing characters.
 | |
|         if (url.endsWith("\\")) {
 | |
|           url = url.slice(0, -1);
 | |
|         }
 | |
| 
 | |
|         let pos = url.indexOf("?");
 | |
|         if (pos != -1) {
 | |
|           url = url.slice(0, pos);
 | |
|         }
 | |
| 
 | |
|         // Make urls like chrome://browser/skin/ point to an actual file,
 | |
|         // and remove the ref if any.
 | |
|         url = Services.io.newURI(url).specIgnoringRef;
 | |
| 
 | |
|         if (isDevtools && line.includes("require(") &&
 | |
|             !/\.(properties|js|jsm|json|css)$/.test(url))
 | |
|           url += ".js";
 | |
| 
 | |
|         addCodeReference(url, fileUri);
 | |
|       }
 | |
|     }
 | |
|   });
 | |
| }
 | |
| 
 | |
| function convertToCodeURI(fileUri) {
 | |
|   let baseUri = fileUri;
 | |
|   let path = "";
 | |
|   while (true) {
 | |
|     let slashPos = baseUri.lastIndexOf("/", baseUri.length - 2);
 | |
|     if (slashPos <= 0) {
 | |
|       // File not accessible from chrome protocol, try resource://
 | |
|       for (let res of gResourceMap) {
 | |
|         if (fileUri.startsWith(res[1]))
 | |
|           return fileUri.replace(res[1], "resource://" + res[0] + "/");
 | |
|       }
 | |
|       // Give up and return the original URL.
 | |
|       return fileUri;
 | |
|     }
 | |
|     path = baseUri.slice(slashPos + 1) + path;
 | |
|     baseUri = baseUri.slice(0, slashPos + 1);
 | |
|     if (gChromeMap.has(baseUri))
 | |
|       return gChromeMap.get(baseUri) + path;
 | |
|   }
 | |
| }
 | |
| 
 | |
| function chromeFileExists(aURI) {
 | |
|   let available = 0;
 | |
|   try {
 | |
|     let channel = NetUtil.newChannel({uri: aURI, loadUsingSystemPrincipal: true});
 | |
|     let stream = channel.open();
 | |
|     let sstream = Cc["@mozilla.org/scriptableinputstream;1"]
 | |
|                     .createInstance(Ci.nsIScriptableInputStream);
 | |
|     sstream.init(stream);
 | |
|     available = sstream.available();
 | |
|     sstream.close();
 | |
|   } catch (e) {
 | |
|     if (e.result != Cr.NS_ERROR_FILE_NOT_FOUND &&
 | |
|         e.result != Cr.NS_ERROR_NOT_AVAILABLE) {
 | |
|       todo(false, "Failed to check if " + aURI + "exists: " + e);
 | |
|     }
 | |
|   }
 | |
|   return available > 0;
 | |
| }
 | |
| 
 | |
| function findChromeUrlsFromArray(array, prefix) {
 | |
|   // Find the first character of the prefix...
 | |
|   for (let index = 0;
 | |
|        (index = array.indexOf(prefix.charCodeAt(0), index)) != -1;
 | |
|        ++index) {
 | |
|     // Then ensure we actually have the whole prefix.
 | |
|     let found = true;
 | |
|     for (let i = 1; i < prefix.length; ++i) {
 | |
|       if (array[index + i] != prefix.charCodeAt(i)) {
 | |
|         found = false;
 | |
|         break;
 | |
|       }
 | |
|     }
 | |
|     if (!found)
 | |
|       continue;
 | |
| 
 | |
|     // C strings are null terminated, but " also terminates urls
 | |
|     // (nsIndexedToHTML.cpp contains an HTML fragment with several chrome urls)
 | |
|     // Let's also terminate the string on the # character to skip references.
 | |
|     let end = Math.min(array.indexOf(0, index),
 | |
|                        array.indexOf('"'.charCodeAt(0), index),
 | |
|                        array.indexOf(")".charCodeAt(0), index),
 | |
|                        array.indexOf("#".charCodeAt(0), index));
 | |
|     let string = "";
 | |
|     for ( ; index < end; ++index) {
 | |
|       string += String.fromCharCode(array[index]);
 | |
|     }
 | |
| 
 | |
|     // Only keep strings that look like real chrome or resource urls.
 | |
|     if (/chrome:\/\/[a-zA-Z09-]+\/(content|skin|locale)\//.test(string) ||
 | |
|         /resource:\/\/[a-zA-Z09-]*\/.*\.[a-z]+/.test(string))
 | |
|       gReferencesFromCode.set(string, null);
 | |
|   }
 | |
| }
 | |
| 
 | |
| add_task(async function checkAllTheFiles() {
 | |
|   let libxulPath = OS.Constants.Path.libxul;
 | |
|   if (AppConstants.platform != "macosx")
 | |
|     libxulPath = OS.Constants.Path.libDir + "/" + libxulPath;
 | |
|   let libxul = await OS.File.read(libxulPath);
 | |
|   findChromeUrlsFromArray(libxul, "chrome://");
 | |
|   findChromeUrlsFromArray(libxul, "resource://");
 | |
|   // Handle NS_LITERAL_STRING.
 | |
|   let uint16 = new Uint16Array(libxul.buffer);
 | |
|   findChromeUrlsFromArray(uint16, "chrome://");
 | |
|   findChromeUrlsFromArray(uint16, "resource://");
 | |
| 
 | |
|   const kCodeExtensions = [".xul", ".xml", ".xsl", ".js", ".jsm", ".json", ".html", ".xhtml"];
 | |
| 
 | |
|   let appDir = Services.dirsvc.get("GreD", Ci.nsIFile);
 | |
|   // This asynchronously produces a list of URLs (sadly, mostly sync on our
 | |
|   // test infrastructure because it runs against jarfiles there, and
 | |
|   // our zipreader APIs are all sync)
 | |
|   let uris = await generateURIsFromDirTree(appDir, [".css", ".manifest", ".jpg", ".png", ".gif", ".svg",  ".dtd", ".properties"].concat(kCodeExtensions));
 | |
| 
 | |
|   // Parse and remove all manifests from the list.
 | |
|   // NOTE that this must be done before filtering out devtools paths
 | |
|   // so that all chrome paths can be recorded.
 | |
|   let manifestURIs = [];
 | |
|   uris = uris.filter(uri => {
 | |
|     let path = uri.pathQueryRef;
 | |
|     if (path.endsWith(".manifest")) {
 | |
|       manifestURIs.push(uri);
 | |
|       return false;
 | |
|     }
 | |
| 
 | |
|     return true;
 | |
|   });
 | |
| 
 | |
|   // Wait for all manifest to be parsed
 | |
|   await throttledMapPromises(manifestURIs, parseManifest);
 | |
| 
 | |
|   // We build a list of promises that get resolved when their respective
 | |
|   // files have loaded and produced no errors.
 | |
|   let allPromises = [];
 | |
| 
 | |
|   for (let uri of uris) {
 | |
|     let path = uri.pathQueryRef;
 | |
|     if (path.endsWith(".css"))
 | |
|       allPromises.push([parseCSSFile, uri]);
 | |
|     else if (kCodeExtensions.some(ext => path.endsWith(ext)))
 | |
|       allPromises.push([parseCodeFile, uri]);
 | |
|   }
 | |
| 
 | |
|   // Wait for all the files to have actually loaded:
 | |
|   await throttledMapPromises(allPromises, ([task, uri]) => task(uri));
 | |
| 
 | |
|   // Keep only chrome:// files, and filter out either the devtools paths or
 | |
|   // the non-devtools paths:
 | |
|   let devtoolsPrefixes = ["chrome://webide/",
 | |
|                           "chrome://devtools",
 | |
|                           "resource://devtools/",
 | |
|                           "resource://devtools-client-jsonview/",
 | |
|                           "resource://devtools-client-shared/",
 | |
|                           "resource://app/modules/devtools",
 | |
|                           "resource://gre/modules/devtools"];
 | |
|   let hasDevtoolsPrefix =
 | |
|     uri => devtoolsPrefixes.some(prefix => uri.startsWith(prefix));
 | |
|   let chromeFiles = [];
 | |
|   for (let uri of uris) {
 | |
|     uri = convertToCodeURI(uri.spec);
 | |
|     if ((uri.startsWith("chrome://") || uri.startsWith("resource://")) &&
 | |
|         isDevtools == hasDevtoolsPrefix(uri))
 | |
|       chromeFiles.push(uri);
 | |
|   }
 | |
| 
 | |
|   if (isDevtools) {
 | |
|     // chrome://devtools/skin/devtools-browser.css is included from browser.xul
 | |
|     gReferencesFromCode.set("chrome://browser/content/browser.xul", null);
 | |
|     // devtools' css is currently included from browser.css, see bug 1204810.
 | |
|     gReferencesFromCode.set("chrome://browser/skin/browser.css", null);
 | |
|   }
 | |
| 
 | |
|   let isUnreferenced = file => {
 | |
|     if (gExceptionPaths.some(e => file.startsWith(e)))
 | |
|       return false;
 | |
|     if (gReferencesFromCode.has(file)) {
 | |
|       let refs = gReferencesFromCode.get(file);
 | |
|       if (refs === null)
 | |
|         return false;
 | |
|       for (let ref of refs) {
 | |
|         if (ref.endsWith("!/bootstrap.js"))
 | |
|           return false;
 | |
| 
 | |
|         if (isDevtools) {
 | |
|           if (ref.startsWith("resource://app/components/") ||
 | |
|               (file.startsWith("chrome://") && ref.startsWith("resource://")))
 | |
|             return false;
 | |
|         }
 | |
| 
 | |
|         if (gReferencesFromCode.has(ref)) {
 | |
|           let refType = gReferencesFromCode.get(ref);
 | |
|           if (refType === null || // unconditionally referenced
 | |
|               refType == "whitelist" || refType == "whitelist-direct")
 | |
|             return false;
 | |
|         }
 | |
|       }
 | |
|     }
 | |
|     return !gOverrideMap.has(file) || isUnreferenced(gOverrideMap.get(file));
 | |
|   };
 | |
| 
 | |
|   let unreferencedFiles = chromeFiles;
 | |
| 
 | |
|   let removeReferenced = useWhitelist => {
 | |
|     let foundReference = false;
 | |
|     unreferencedFiles = unreferencedFiles.filter(f => {
 | |
|       let rv = isUnreferenced(f);
 | |
|       if (rv && f.startsWith("resource://app/"))
 | |
|         rv = isUnreferenced(f.replace("resource://app/", "resource:///"));
 | |
|       if (rv && /^resource:\/\/(?:app|gre)\/components\/[^/]+\.js$/.test(f))
 | |
|         rv = !gComponentsSet.has(f.replace(/.*\//, ""));
 | |
|       if (!rv) {
 | |
|         foundReference = true;
 | |
|         if (useWhitelist) {
 | |
|           info("indirectly whitelisted file: " + f + " used from " +
 | |
|                listCodeReferences(gReferencesFromCode.get(f)));
 | |
|         }
 | |
|         gReferencesFromCode.set(f, useWhitelist ? "whitelist" : null);
 | |
|       }
 | |
|       return rv;
 | |
|     });
 | |
|     return foundReference;
 | |
|   };
 | |
|   // First filter out the files that are referenced.
 | |
|   while (removeReferenced(false)) {
 | |
|     // As long as removeReferenced returns true, some files have been marked
 | |
|     // as referenced, so we need to run it again.
 | |
|   }
 | |
|   // Marked as referenced the files that have been explicitly whitelisted.
 | |
|   unreferencedFiles = unreferencedFiles.filter(file => {
 | |
|     if (whitelist.has(file)) {
 | |
|       whitelist.delete(file);
 | |
|       gReferencesFromCode.set(file, "whitelist-direct");
 | |
|       return false;
 | |
|     }
 | |
|     return true;
 | |
|   });
 | |
|   // Run the process again, this time when more files are marked as referenced,
 | |
|   // it's a consequence of the whitelist.
 | |
|   while (removeReferenced(true)) {
 | |
|     // As long as removeReferenced returns true, we need to run it again.
 | |
|   }
 | |
| 
 | |
|   unreferencedFiles.sort();
 | |
| 
 | |
|   if (isDevtools) {
 | |
|     // Bug 1351878 - handle devtools resource files
 | |
|     unreferencedFiles = unreferencedFiles.filter(file => {
 | |
|       if (file.startsWith("resource://")) {
 | |
|         info("unreferenced devtools resource file: " + file);
 | |
|         return false;
 | |
|       }
 | |
|       return true;
 | |
|     });
 | |
|   }
 | |
| 
 | |
|   unreferencedFiles = unreferencedFiles.filter(file => {
 | |
|     // resource://app/features/ will only contain .xpi files when the test runs
 | |
|     // on a packaged build, so the following two exceptions only matter when
 | |
|     // running the test on a local non-packaged build.
 | |
| 
 | |
|     if (/resource:\/\/app\/features\/[^/]+\/bootstrap\.js/.test(file)) {
 | |
|       info("not reporting feature boostrap file: " + file);
 | |
|       return false;
 | |
|     }
 | |
|     // Bug 1351892 - can stop shipping these?
 | |
|     if (/resource:\/\/app\/features\/[^/]+\/chrome\/skin\//.test(file)) {
 | |
|       info("not reporting feature skin file that may be for another platform: " + file);
 | |
|       return false;
 | |
|     }
 | |
|     return true;
 | |
|   });
 | |
| 
 | |
|   is(unreferencedFiles.length, 0, "there should be no unreferenced files");
 | |
|   for (let file of unreferencedFiles) {
 | |
|     let refs = gReferencesFromCode.get(file);
 | |
|     if (refs === undefined) {
 | |
|       ok(false, "unreferenced file: " + file);
 | |
|     } else {
 | |
|       let refList = listCodeReferences(refs);
 | |
|       let msg = "file only referenced from unreferenced files: " + file;
 | |
|       if (refList)
 | |
|         msg += " referenced from " + refList;
 | |
|       ok(false, msg);
 | |
|     }
 | |
|   }
 | |
| 
 | |
|   for (let file of whitelist) {
 | |
|     if (ignorableWhitelist.has(file))
 | |
|       info("ignored unused whitelist entry: " + file);
 | |
|     else
 | |
|       ok(false, "unused whitelist entry: " + file);
 | |
|   }
 | |
| 
 | |
|   for (let [file, refs] of gReferencesFromCode) {
 | |
|     if (isDevtools != devtoolsPrefixes.some(prefix => file.startsWith(prefix)))
 | |
|       continue;
 | |
| 
 | |
|     if ((file.startsWith("chrome://") || file.startsWith("resource://")) &&
 | |
|         !chromeFileExists(file)) {
 | |
|       // Ignore chrome prefixes that have been automatically expanded.
 | |
|       let pathParts =
 | |
|         file.match("chrome://([^/]+)/content/([^/.]+)\.xul") ||
 | |
|         file.match("chrome://([^/]+)/skin/([^/.]+)\.css");
 | |
|       if (pathParts && pathParts[1] == pathParts[2])
 | |
|         continue;
 | |
| 
 | |
|       // TODO: bug 1349010 - add a whitelist and make this reliable enough
 | |
|       // that we could make the test fail when this catches something new.
 | |
|       let refList = listCodeReferences(refs);
 | |
|       let msg = "missing file: " + file;
 | |
|       if (refList)
 | |
|         msg += " referenced from " + refList;
 | |
|       info(msg);
 | |
|     }
 | |
|   }
 | |
| });
 | 
