Source code
Revision control
Copy as Markdown
Other Tools
/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*- */
/* vim: set ts=2 et sw=2 tw=80 filetype=javascript: */
/* 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
/**
* Handles the download progress indicator in the taskbar.
*/
// Globals
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
BrowserWindowTracker: "resource:///modules/BrowserWindowTracker.sys.mjs",
Downloads: "resource://gre/modules/Downloads.sys.mjs",
});
ChromeUtils.defineLazyGetter(lazy, "gWinTaskbar", function () {
if (!("@mozilla.org/windows-taskbar;1" in Cc)) {
return null;
}
let winTaskbar = Cc["@mozilla.org/windows-taskbar;1"].getService(
Ci.nsIWinTaskbar
);
return winTaskbar.available && winTaskbar;
});
ChromeUtils.defineLazyGetter(lazy, "gMacTaskbarProgress", function () {
return (
"@mozilla.org/widget/macdocksupport;1" in Cc &&
Cc["@mozilla.org/widget/macdocksupport;1"].getService(Ci.nsITaskbarProgress)
);
});
ChromeUtils.defineLazyGetter(lazy, "gGtkTaskbarProgress", function () {
return (
"@mozilla.org/widget/taskbarprogress/gtk;1" in Cc &&
Cc["@mozilla.org/widget/taskbarprogress/gtk;1"].getService(
Ci.nsIGtkTaskbarProgress
)
);
});
// DownloadsTaskbar
/**
* Handles the download progress indicator in the taskbar.
*/
export var DownloadsTaskbar = {
/**
* Underlying DownloadSummary providing the aggregate download information, or
* null if the indicator has never been initialized.
*/
_summary: null,
/**
* nsITaskbarProgress object to which download information is dispatched.
* This can be null if the indicator has never been initialized or if the
* indicator is currently hidden on Windows.
*/
_taskbarProgress: null,
/**
* This method is called after a new browser window is opened, and ensures
* that the download progress indicator is displayed in the taskbar.
*
* On Windows, the indicator is attached to the first browser window that
* calls this method. When the window is closed, the indicator is moved to
* another browser window, if available, in no particular order. When there
* are no browser windows visible, the indicator is hidden.
*
* On Mac OS X, the indicator is initialized globally when this method is
* called for the first time. Subsequent calls have no effect.
*
* @param aBrowserWindow
* nsIDOMWindow object of the newly opened browser window to which the
* indicator may be attached.
*/
registerIndicator(aBrowserWindow) {
if (!this._taskbarProgress) {
if (lazy.gMacTaskbarProgress) {
// On Mac OS X, we have to register the global indicator only once.
this._taskbarProgress = lazy.gMacTaskbarProgress;
// Free the XPCOM reference on shutdown, to prevent detecting a leak.
Services.obs.addObserver(() => {
this._taskbarProgress = null;
lazy.gMacTaskbarProgress = null;
}, "quit-application-granted");
} else if (lazy.gWinTaskbar) {
// On Windows, the indicator is currently hidden because we have no
// previous browser window, thus we should attach the indicator now.
this._attachIndicator(aBrowserWindow);
} else if (lazy.gGtkTaskbarProgress) {
this._taskbarProgress = lazy.gGtkTaskbarProgress;
this._attachGtkTaskbarProgress(aBrowserWindow);
} else {
// The taskbar indicator is not available on this platform.
return;
}
}
// Ensure that the DownloadSummary object will be created asynchronously.
if (!this._summary) {
lazy.Downloads.getSummary(lazy.Downloads.ALL)
.then(summary => {
// In case the method is re-entered, we simply ignore redundant
// invocations of the callback, instead of keeping separate state.
if (this._summary) {
return undefined;
}
this._summary = summary;
return this._summary.addView(this);
})
.catch(console.error);
}
},
/**
* On Windows, attaches the taskbar indicator to the specified browser window.
*/
_attachIndicator(aWindow) {
// Activate the indicator on the specified window.
let { docShell } = aWindow.browsingContext.topChromeWindow;
this._taskbarProgress = lazy.gWinTaskbar.getTaskbarProgress(docShell);
// If the DownloadSummary object has already been created, we should update
// the state of the new indicator, otherwise it will be updated as soon as
// the DownloadSummary view is registered.
if (this._summary) {
this.onSummaryChanged();
}
aWindow.addEventListener("unload", () => {
// Locate another browser window, excluding the one being closed.
let browserWindow = lazy.BrowserWindowTracker.getTopWindow();
if (browserWindow) {
// Move the progress indicator to the other browser window.
this._attachIndicator(browserWindow);
} else {
// The last browser window has been closed. We remove the reference to
// the taskbar progress object so that the indicator will be registered
// again on the next browser window that is opened.
this._taskbarProgress = null;
}
});
},
/**
* In gtk3, the window itself implements the progress interface.
*/
_attachGtkTaskbarProgress(aWindow) {
// Set the current window.
this._taskbarProgress.setPrimaryWindow(aWindow);
// If the DownloadSummary object has already been created, we should update
// the state of the new indicator, otherwise it will be updated as soon as
// the DownloadSummary view is registered.
if (this._summary) {
this.onSummaryChanged();
}
aWindow.addEventListener("unload", () => {
// Locate another browser window, excluding the one being closed.
let browserWindow = lazy.BrowserWindowTracker.getTopWindow();
if (browserWindow) {
// Move the progress indicator to the other browser window.
this._attachGtkTaskbarProgress(browserWindow);
} else {
// The last browser window has been closed. We remove the reference to
// the taskbar progress object so that the indicator will be registered
// again on the next browser window that is opened.
this._taskbarProgress = null;
}
});
},
// DownloadSummary view
onSummaryChanged() {
// If the last browser window has been closed, we have no indicator any more.
if (!this._taskbarProgress) {
return;
}
if (this._summary.allHaveStopped || this._summary.progressTotalBytes == 0) {
this._taskbarProgress.setProgressState(
Ci.nsITaskbarProgress.STATE_NO_PROGRESS,
0,
0
);
} else if (this._summary.allUnknownSize) {
this._taskbarProgress.setProgressState(
Ci.nsITaskbarProgress.STATE_INDETERMINATE,
0,
0
);
} else {
// For a brief moment before completion, some download components may
// report more transferred bytes than the total number of bytes. Thus,
// ensure that we never break the expectations of the progress indicator.
let progressCurrentBytes = Math.min(
this._summary.progressTotalBytes,
this._summary.progressCurrentBytes
);
this._taskbarProgress.setProgressState(
Ci.nsITaskbarProgress.STATE_NORMAL,
progressCurrentBytes,
this._summary.progressTotalBytes
);
}
},
};