-
Notifications
You must be signed in to change notification settings - Fork 79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
consoles: Allow configuring VNC #1973
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,10 +20,16 @@ import React from 'react'; | |
import PropTypes from 'prop-types'; | ||
import cockpit from 'cockpit'; | ||
import { AccessConsoles } from "@patternfly/react-console"; | ||
import { Button } from "@patternfly/react-core/dist/esm/components/Button"; | ||
import { Split, SplitItem } from "@patternfly/react-core/dist/esm/layouts/Split/index.js"; | ||
|
||
import { useDialogs } from 'dialogs.jsx'; | ||
import SerialConsole from './serialConsole.jsx'; | ||
import Vnc from './vnc.jsx'; | ||
import DesktopConsole from './desktopConsole.jsx'; | ||
import { AddVNC } from './vncAdd.jsx'; | ||
import { EditVNCModal } from './vncEdit.jsx'; | ||
|
||
import { | ||
domainCanConsole, | ||
domainDesktopConsole, | ||
|
@@ -34,10 +40,59 @@ import './consoles.css'; | |
|
||
const _ = cockpit.gettext; | ||
|
||
const VmNotRunning = () => { | ||
const VmNotRunning = ({ vm, vnc }) => { | ||
const Dialogs = useDialogs(); | ||
|
||
function add_vnc() { | ||
Dialogs.show(<AddVNC | ||
idPrefix="add-vnc" | ||
vm={vm} />); | ||
} | ||
|
||
function edit_vnc() { | ||
Dialogs.show(<EditVNCModal | ||
idPrefix="edit-vnc" | ||
consoleDetail={vnc} | ||
vmName={vm.name} | ||
vmId={vm.id} | ||
connectionName={vm.connectionName} />); | ||
Comment on lines
+52
to
+58
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 7 added lines are not executed by any test. |
||
} | ||
|
||
let vnc_info; | ||
let vnc_action; | ||
|
||
if (!vnc) { | ||
vnc_info = _("not supported"); | ||
vnc_action = ( | ||
<Button variant="link" isInline onClick={add_vnc}> | ||
{_("Add support")} | ||
</Button> | ||
); | ||
} else { | ||
if (vnc.port == -1) | ||
vnc_info = _("supported"); | ||
else | ||
vnc_info = cockpit.format(_("supported, port $0"), vnc.port); | ||
|
||
vnc_action = ( | ||
<Button variant="link" isInline onClick={edit_vnc}> | ||
{_("Edit")} | ||
</Button> | ||
); | ||
} | ||
|
||
return ( | ||
<div id="vm-not-running-message"> | ||
{_("Please start the virtual machine to access its console.")} | ||
<p>{_("Please start the virtual machine to access its console.")}</p> | ||
<br /> | ||
<Split hasGutter> | ||
<SplitItem isFilled> | ||
<span><b>{_("Graphical console:")}</b> {vnc_info}</span> | ||
</SplitItem> | ||
<SplitItem> | ||
{vnc_action} | ||
</SplitItem> | ||
</Split> | ||
</div> | ||
); | ||
}; | ||
|
@@ -98,7 +153,7 @@ class Consoles extends React.Component { | |
const vnc = vm.displays && vm.displays.find(display => display.type == 'vnc'); | ||
|
||
if (!domainCanConsole || !domainCanConsole(vm.state)) { | ||
return (<VmNotRunning />); | ||
return (<VmNotRunning vm={vm} vnc={vnc} />); | ||
} | ||
|
||
const onDesktopConsole = () => { // prefer spice over vnc | ||
|
@@ -109,21 +164,20 @@ class Consoles extends React.Component { | |
<AccessConsoles preselectedType={this.getDefaultConsole()} | ||
textSelectConsoleType={_("Select console type")} | ||
textSerialConsole={_("Serial console")} | ||
textVncConsole={_("VNC console")} | ||
textVncConsole={_("Graphical console (VNC)")} | ||
textDesktopViewerConsole={_("Desktop viewer")}> | ||
{serial.map((pty, idx) => (<SerialConsole type={serial.length == 1 ? "SerialConsole" : cockpit.format(_("Serial console ($0)"), pty.alias || idx)} | ||
key={"pty-" + idx} | ||
connectionName={vm.connectionName} | ||
vmName={vm.name} | ||
spawnArgs={domainSerialConsoleCommand({ vm, alias: pty.alias })} />))} | ||
{vnc && | ||
<Vnc type="VncConsole" | ||
vmName={vm.name} | ||
vmId={vm.id} | ||
connectionName={vm.connectionName} | ||
consoleDetail={vnc} | ||
onAddErrorNotification={onAddErrorNotification} | ||
isExpanded={isExpanded} />} | ||
isExpanded={isExpanded} /> | ||
{(vnc || spice) && | ||
<DesktopConsole type="DesktopViewer" | ||
onDesktopConsole={onDesktopConsole} | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,6 +23,7 @@ import { VncConsole } from '@patternfly/react-console'; | |
import { Dropdown, DropdownItem, DropdownList } from "@patternfly/react-core/dist/esm/components/Dropdown"; | ||
import { MenuToggle } from "@patternfly/react-core/dist/esm/components/MenuToggle"; | ||
import { Divider } from "@patternfly/react-core/dist/esm/components/Divider"; | ||
import { EmptyState, EmptyStateBody } from "@patternfly/react-core/dist/esm/components/EmptyState"; | ||
|
||
import { logDebug } from '../../../helpers.js'; | ||
import { domainSendKey } from '../../../libvirtApi/domain.js'; | ||
|
@@ -68,7 +69,7 @@ class Vnc extends React.Component { | |
} | ||
|
||
const { consoleDetail } = props; | ||
if (!consoleDetail || consoleDetail.port == -1) { | ||
if (!consoleDetail || consoleDetail.port == -1 || !consoleDetail.address) { | ||
logDebug('Vnc component: console detail not yet provided'); | ||
return; | ||
} | ||
|
@@ -117,7 +118,18 @@ class Vnc extends React.Component { | |
render() { | ||
const { consoleDetail, connectionName, vmName, vmId, onAddErrorNotification, isExpanded } = this.props; | ||
const { path, isActionOpen } = this.state; | ||
if (!consoleDetail || !path) { | ||
if (!consoleDetail) { | ||
return ( | ||
<div className="pf-v5-c-console__vnc"> | ||
<EmptyState> | ||
<EmptyStateBody> | ||
{_("Graphical console not supported. Shut down the virtual machine to add support.")} | ||
</EmptyStateBody> | ||
</EmptyState> | ||
</div> | ||
Comment on lines
+121
to
+129
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 9 added lines are not executed by any test. |
||
); | ||
} | ||
if (!path) { | ||
// postpone rendering until consoleDetail is known and channel ready | ||
return null; | ||
} | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,131 @@ | ||
/* | ||
* This file is part of Cockpit. | ||
* | ||
* Copyright 2024 Fsas Technologies Inc. | ||
* | ||
* Cockpit is free software; you can redistribute it and/or modify it | ||
* under the terms of the GNU Lesser General Public License as published by | ||
* the Free Software Foundation; either version 2.1 of the License, or | ||
* (at your option) any later version. | ||
* | ||
* Cockpit is distributed in the hope that it will be useful, but | ||
* WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
* Lesser General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Lesser General Public License | ||
* along with Cockpit; If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
import React from 'react'; | ||
import cockpit from 'cockpit'; | ||
import PropTypes from 'prop-types'; | ||
import { Button, Form, Modal, ModalVariant } from "@patternfly/react-core"; | ||
import { DialogsContext } from 'dialogs.jsx'; | ||
|
||
import { ModalError } from 'cockpit-components-inline-notification.jsx'; | ||
import { VncRow, validateDialogValues } from './vncBody.jsx'; | ||
import { domainAttachVnc, domainGet } from '../../../libvirtApi/domain.js'; | ||
|
||
const _ = cockpit.gettext; | ||
|
||
export class AddVNC extends React.Component { | ||
static contextType = DialogsContext; | ||
|
||
constructor(props) { | ||
super(props); | ||
Comment on lines
+34
to
+35
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 2 added lines are not executed by any test. |
||
|
||
this.state = { | ||
dialogError: undefined, | ||
vncAddress: "", | ||
vncPort: "", | ||
vncPassword: "", | ||
addVncInProgress: false, | ||
validationErrors: { }, | ||
Comment on lines
+37
to
+43
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 7 added lines are not executed by any test. |
||
}; | ||
this.add = this.add.bind(this); | ||
this.onValueChanged = this.onValueChanged.bind(this); | ||
this.dialogErrorSet = this.dialogErrorSet.bind(this); | ||
Comment on lines
+45
to
+47
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 3 added lines are not executed by any test. |
||
} | ||
|
||
onValueChanged(key, value) { | ||
const stateDelta = { [key]: value }; | ||
Comment on lines
+50
to
+51
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 2 added lines are not executed by any test. |
||
|
||
this.setState(stateDelta); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This added line is not executed by any test. |
||
} | ||
|
||
dialogErrorSet(text, detail) { | ||
this.setState({ dialogError: text, dialogErrorDetail: detail }); | ||
Comment on lines
+56
to
+57
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 2 added lines are not executed by any test. |
||
} | ||
|
||
add() { | ||
const Dialogs = this.context; | ||
const { vm } = this.props; | ||
Comment on lines
+60
to
+62
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 3 added lines are not executed by any test. |
||
|
||
const errors = validateDialogValues(this.state); | ||
if (errors) { | ||
this.setState({ validationErrors: errors }); | ||
return; | ||
Comment on lines
+64
to
+67
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 4 added lines are not executed by any test. |
||
} | ||
|
||
this.setState({ addVncInProgress: true }); | ||
const vncParams = { | ||
connectionName: vm.connectionName, | ||
vmName: vm.name, | ||
vncAddress: this.state.vncAddress || "", | ||
vncPort: this.state.vncPort || "", | ||
vncPassword: this.state.vncPassword || "", | ||
Comment on lines
+70
to
+76
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 7 added lines are not executed by any test. |
||
}; | ||
|
||
domainAttachVnc(vncParams) | ||
.then(() => { | ||
domainGet({ connectionName: vm.connectionName, id: vm.id }); | ||
Dialogs.close(); | ||
Comment on lines
+79
to
+82
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 4 added lines are not executed by any test. |
||
}) | ||
.catch(exc => this.dialogErrorSet(_("VNC device settings could not be saved"), exc.message)) | ||
.finally(() => this.setState({ addVncInProgress: false })); | ||
Comment on lines
+84
to
+85
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 2 added lines are not executed by any test. |
||
} | ||
|
||
render() { | ||
const Dialogs = this.context; | ||
const { idPrefix } = this.props; | ||
Comment on lines
+88
to
+90
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 3 added lines are not executed by any test. |
||
|
||
const defaultBody = ( | ||
<Form onSubmit={e => e.preventDefault()} isHorizontal> | ||
<VncRow | ||
idPrefix={idPrefix} | ||
dialogValues={this.state} | ||
validationErrors={this.state.validationErrors} | ||
onValueChanged={this.onValueChanged} /> | ||
</Form> | ||
Comment on lines
+92
to
+99
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 8 added lines are not executed by any test. |
||
); | ||
|
||
return ( | ||
<Modal position="top" variant={ModalVariant.medium} id={`${idPrefix}-dialog`} isOpen onClose={Dialogs.close} className='vnc-add' | ||
title={_("Add VNC server")} | ||
footer={ | ||
Comment on lines
+102
to
+105
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 4 added lines are not executed by any test. |
||
<> | ||
<Button isLoading={this.state.addVncInProgress} | ||
isDisabled={false} | ||
id={`${idPrefix}-add`} | ||
variant='primary' | ||
onClick={this.add}> | ||
{_("Add")} | ||
</Button> | ||
<Button id={`${idPrefix}-cancel`} variant='link' onClick={Dialogs.close}> | ||
{_("Cancel")} | ||
</Button> | ||
Comment on lines
+107
to
+116
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 10 added lines are not executed by any test. |
||
</> | ||
}> | ||
{this.state.dialogError && <ModalError dialogError={this.state.dialogError} dialogErrorDetail={this.state.dialogErrorDetail} />} | ||
{defaultBody} | ||
</Modal> | ||
Comment on lines
+119
to
+121
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 3 added lines are not executed by any test. |
||
); | ||
} | ||
} | ||
|
||
AddVNC.propTypes = { | ||
idPrefix: PropTypes.string.isRequired, | ||
vm: PropTypes.object.isRequired, | ||
}; | ||
|
||
export default AddVNC; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,100 @@ | ||
/* | ||
* This file is part of Cockpit. | ||
* | ||
* Copyright 2024 Fsas Technologies Inc. | ||
* | ||
* Cockpit is free software; you can redistribute it and/or modify it | ||
* under the terms of the GNU Lesser General Public License as published by | ||
* the Free Software Foundation; either version 2.1 of the License, or | ||
* (at your option) any later version. | ||
* | ||
* Cockpit is distributed in the hope that it will be useful, but | ||
* WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
* Lesser General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Lesser General Public License | ||
* along with Cockpit; If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
|
||
import React, { useState } from 'react'; | ||
import PropTypes from 'prop-types'; | ||
import { | ||
FormGroup, FormHelperText, HelperText, HelperTextItem, | ||
Grid, GridItem, | ||
InputGroup, TextInput, Button | ||
} from "@patternfly/react-core"; | ||
import { EyeIcon, EyeSlashIcon } from "@patternfly/react-icons"; | ||
|
||
import cockpit from 'cockpit'; | ||
|
||
const _ = cockpit.gettext; | ||
|
||
export const VncRow = ({ idPrefix, onValueChanged, dialogValues, validationErrors }) => { | ||
const [showPassword, setShowPassword] = useState(false); | ||
Comment on lines
+33
to
+34
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 2 added lines are not executed by any test. |
||
|
||
return ( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This added line is not executed by any test. |
||
<> | ||
<Grid hasGutter md={6}> | ||
<GridItem span={6}> | ||
<FormGroup fieldId={`${idPrefix}-address`} label={_("Listening address")}> | ||
<TextInput id={`${idPrefix}-address`} | ||
value={dialogValues.vncAddress} | ||
type="text" | ||
placeholder={_("default")} | ||
onChange={(event) => onValueChanged('vncAddress', event.target.value)} /> | ||
</FormGroup> | ||
</GridItem> | ||
<GridItem span={6}> | ||
<FormGroup fieldId={`${idPrefix}-port`} label={_("Listening port")}> | ||
<TextInput id={`${idPrefix}-port`} | ||
value={dialogValues.vncPort} | ||
type="text" | ||
placeholder={_("automatic")} | ||
validated={validationErrors.vncPort ? "error" : null} | ||
onChange={(event) => onValueChanged('vncPort', event.target.value)} /> | ||
{ validationErrors.vncPort && | ||
<FormHelperText> | ||
<HelperText> | ||
<HelperTextItem variant='error'>{validationErrors.vncPort}</HelperTextItem> | ||
</HelperText> | ||
</FormHelperText> | ||
Comment on lines
+38
to
+61
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 24 added lines are not executed by any test. |
||
} | ||
</FormGroup> | ||
</GridItem> | ||
</Grid> | ||
<FormGroup fieldId={`${idPrefix}-password`} label={_("Password")}> | ||
<InputGroup> | ||
<TextInput | ||
id={`${idPrefix}-password`} | ||
type={showPassword ? "text" : "password"} | ||
value={dialogValues.vncPassword} | ||
onChange={(event) => onValueChanged('vncPassword', event.target.value)} /> | ||
<Button | ||
variant="control" | ||
onClick={() => setShowPassword(!showPassword)}> | ||
{ showPassword ? <EyeSlashIcon /> : <EyeIcon /> } | ||
</Button> | ||
</InputGroup> | ||
</FormGroup> | ||
Comment on lines
+63
to
+79
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 17 added lines are not executed by any test. |
||
</> | ||
); | ||
}; | ||
|
||
export function validateDialogValues(values) { | ||
const res = { }; | ||
Comment on lines
+84
to
+85
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 2 added lines are not executed by any test. |
||
|
||
if (values.vncPort == "") | ||
; // fine | ||
else if (!values.vncPort.match("^[0-9]+$") || Number(values.vncPort) < 5900) | ||
res.vncPort = _("Port must be 5900 or larger."); | ||
Comment on lines
+87
to
+90
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. These 4 added lines are not executed by any test. |
||
|
||
return Object.keys(res).length > 0 ? res : null; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This added line is not executed by any test. |
||
} | ||
|
||
VncRow.propTypes = { | ||
idPrefix: PropTypes.string.isRequired, | ||
onValueChanged: PropTypes.func.isRequired, | ||
dialogValues: PropTypes.object.isRequired, | ||
validationErrors: PropTypes.object.isRequired, | ||
}; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These 4 added lines are not executed by any test.