* Copyright (C) 2020 Red Hat, Inc.
* SPDX-License-Identifier: LGPL-2.1-or-later
*/
import cockpit from "cockpit";
*
* The "superuser" object indicates whether or not the current page
* can open superuser channels.
*
* - superuser.allowed
*
* This is true when the page can open superuser channels, and false
* otherwise. This field might be "null" while the page or the Cockpit
* session itself is still initializing.
*
* UI elements that trigger actions that need administrative access
* should be hidden when the "allowed" field is false or null. (If
* those elements also show information, such as with checkboxes or
* toggle buttons, disable them instead of hiding.)
*
* UI elements that alert the user that they don't have administrative
* access should be shown when the "allowed" field is exactly false,
* but not when it is null.
*
* - superuser.configured
*
* This is true when the shell has at least one superuser bridge configured,
* false if there are no superuser bridges, or null during initialization.
*
* - superuser.addEventListener("changed", () => ...)
*
* The event handler is called whenever superuser.allowed has changed.
* A page should update its appearance according to superuser.allowed.
*
* - superuser.addEventListener("reconnect", () => ...)
*
* The event handler is called whenever channels should be re-opened
* that use the "superuser" option.
*
* The difference between "reconnect" and "connect" is that the
* "reconnect" signal does not trigger when superuser.allowed goes
* from "null" to its first real value. You don't need to re-open
* channels in this case, and it happens on every page load, so this
* is important to avoid.
*
* - superuser.reload_page_on_change()
*
* Calling this function instructs the "superuser" object to reload
* the page whenever "superuser.allowed" changes. This is a (bad)
* alternative to re-initializing the page and intended to be used
* only to help with the transition.
*
* Even if you are using "superuser.reload_page_on_change" to avoid having
* to re-initialize your page dynamically, you should still use the
* "changed" event to update the page appearance since
* "superuser.allowed" might still change a couple of times right
* after page reload.
*/
function Superuser() {
const proxy = cockpit.dbus(null, { bus: "internal" }).proxy("cockpit.Superuser", "/superuser");
let reload_on_change = false;
const compute_allowed = () => {
if (!proxy.valid || proxy.Current === "init")
return null;
return proxy.Current !== "none";
};
const compute_configured = () => {
if (proxy.Current === "init")
return null;
return (proxy.Bridges?.length ?? 0) > 0;
};
const self = cockpit.event_target({
allowed: compute_allowed(),
configured: null,
reload_page_on_change
});
function changed(allowed) {
if (self.allowed !== allowed) {
if (self.allowed != null && reload_on_change) {
window.location.reload(true);
} else {
const prev = self.allowed;
self.allowed = allowed;
self.configured = compute_configured();
self.dispatchEvent("changed");
if (prev != null)
self.dispatchEvent("reconnect");
}
}
}
proxy.wait(() => {
if (!proxy.valid) {
const permission = cockpit.permission({ admin: true });
const update = () => {
changed(permission.allowed);
};
permission.addEventListener("changed", update);
update();
}
});
proxy.addEventListener("changed", () => {
changed(compute_allowed());
});
function reload_page_on_change() {
reload_on_change = true;
}
return self;
}
export const superuser = Superuser();
