/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ "use strict"; const TELEMETRY_DDSTAT_SHOWN = 0; const TELEMETRY_DDSTAT_SHOWN_FIRST = 1; const TELEMETRY_DDSTAT_CLICKED = 2; const TELEMETRY_DDSTAT_CLICKED_FIRST = 3; const TELEMETRY_DDSTAT_SOLVED = 4; let gDecoderDoctorHandler = { getLabelForNotificationBox(type) { if (type == "platform-decoder-not-found") { if (AppConstants.platform == "win") { return gNavigatorBundle.getString("decoder.noHWAcceleration.message"); } if (AppConstants.platform == "linux") { return gNavigatorBundle.getString("decoder.noCodecsLinux.message"); } } if (type == "cannot-initialize-pulseaudio") { return gNavigatorBundle.getString("decoder.noPulseAudio.message"); } if (type == "unsupported-libavcodec" && AppConstants.platform == "linux") { return gNavigatorBundle.getString( "decoder.unsupportedLibavcodec.message" ); } if (type == "decode-error") { return gNavigatorBundle.getString("decoder.decodeError.message"); } if (type == "decode-warning") { return gNavigatorBundle.getString("decoder.decodeWarning.message"); } return ""; }, getSumoForLearnHowButton(type) { if ( type == "platform-decoder-not-found" && AppConstants.platform == "win" ) { return "fix-video-audio-problems-firefox-windows"; } if (type == "cannot-initialize-pulseaudio") { return "fix-common-audio-and-video-issues"; } return ""; }, getEndpointForReportIssueButton(type) { if (type == "decode-error" || type == "decode-warning") { return Services.prefs.getStringPref( "media.decoder-doctor.new-issue-endpoint", "" ); } return ""; }, receiveMessage({ target: browser, data: data }) { let box = gBrowser.getNotificationBox(browser); let notificationId = "decoder-doctor-notification"; if (box.getNotificationWithValue(notificationId)) { return; } let parsedData; try { parsedData = JSON.parse(data); } catch (ex) { Cu.reportError("Malformed Decoder Doctor message with data: " + data); return; } // parsedData (the result of parsing the incoming 'data' json string) // contains analysis information from Decoder Doctor: // - 'type' is the type of issue, it determines which text to show in the // infobar. // - 'isSolved' is true when the notification actually indicates the // resolution of that issue, to be reported as telemetry. // - 'decoderDoctorReportId' is the Decoder Doctor issue identifier, to be // used here as key for the telemetry (counting infobar displays, // "Learn how" buttons clicks, and resolutions) and for the prefs used // to store at-issue formats. // - 'formats' contains a comma-separated list of formats (or key systems) // that suffer the issue. These are kept in a pref, which the backend // uses to later find when an issue is resolved. // - 'decodeIssue' is a description of the decode error/warning. // - 'resourceURL' is the resource with the issue. let { type, isSolved, decoderDoctorReportId, formats, decodeIssue, docURL, resourceURL, } = parsedData; type = type.toLowerCase(); // Error out early on invalid ReportId if (!/^\w+$/im.test(decoderDoctorReportId)) { return; } let title = gDecoderDoctorHandler.getLabelForNotificationBox(type); if (!title) { return; } // We keep the list of formats in prefs for the sake of the decoder itself, // which reads it to determine when issues get solved for these formats. // (Writing prefs from e10s content is not allowed.) let formatsPref = formats && "media.decoder-doctor." + decoderDoctorReportId + ".formats"; let buttonClickedPref = "media.decoder-doctor." + decoderDoctorReportId + ".button-clicked"; let formatsInPref = formats && Services.prefs.getCharPref(formatsPref, ""); if (!isSolved) { if (formats) { if (!formatsInPref) { Services.prefs.setCharPref(formatsPref, formats); } else { // Split existing formats into an array of strings. let existing = formatsInPref.split(",").map(x => x.trim()); // Keep given formats that were not already recorded. let newbies = formats .split(",") .map(x => x.trim()) .filter(x => !existing.includes(x)); // And rewrite pref with the added new formats (if any). if (newbies.length) { Services.prefs.setCharPref( formatsPref, existing.concat(newbies).join(", ") ); } } } else if (!decodeIssue) { Cu.reportError( "Malformed Decoder Doctor unsolved message with no formats nor decode issue" ); return; } let buttons = []; let sumo = gDecoderDoctorHandler.getSumoForLearnHowButton(type); if (sumo) { buttons.push({ label: gNavigatorBundle.getString("decoder.noCodecs.button"), accessKey: gNavigatorBundle.getString("decoder.noCodecs.accesskey"), callback() { let clickedInPref = Services.prefs.getBoolPref( buttonClickedPref, false ); if (!clickedInPref) { Services.prefs.setBoolPref(buttonClickedPref, true); } let baseURL = Services.urlFormatter.formatURLPref( "app.support.baseURL" ); openTrustedLinkIn(baseURL + sumo, "tab"); }, }); } let endpoint = gDecoderDoctorHandler.getEndpointForReportIssueButton( type ); if (endpoint) { buttons.push({ label: gNavigatorBundle.getString("decoder.decodeError.button"), accessKey: gNavigatorBundle.getString( "decoder.decodeError.accesskey" ), callback() { let clickedInPref = Services.prefs.getBoolPref( buttonClickedPref, false ); if (!clickedInPref) { Services.prefs.setBoolPref(buttonClickedPref, true); } let params = new URLSearchParams(); params.append("url", docURL); params.append("label", "type-media"); params.append("problem_type", "video_bug"); params.append("src", "media-decode-error"); let details = { "Technical Information:": decodeIssue }; if (resourceURL) { details["Resource:"] = resourceURL; } params.append("details", JSON.stringify(details)); openTrustedLinkIn(endpoint + "?" + params.toString(), "tab"); }, }); } box.appendNotification( title, notificationId, "", // This uses the info icon as specified below. box.PRIORITY_INFO_LOW, buttons ); } else if (formatsInPref) { // Issue is solved, and prefs haven't been cleared yet, meaning it's the // first time we get this resolution -> Clear prefs and report telemetry. Services.prefs.clearUserPref(formatsPref); Services.prefs.clearUserPref(buttonClickedPref); } }, }; window .getGroupMessageManager("browsers") .addMessageListener("DecoderDoctor:Notification", gDecoderDoctorHandler); window.addEventListener("unload", function() { window .getGroupMessageManager("browsers") .removeMessageListener("DecoderDoctor:Notification", gDecoderDoctorHandler); });