Start new chat config sections

This commit is contained in:
Gabe Kangas 2021-06-21 20:19:00 -07:00
parent 3378d0985a
commit caa170e4ef
8 changed files with 221 additions and 10 deletions

View file

@ -16,6 +16,7 @@ import {
QuestionCircleOutlined, QuestionCircleOutlined,
MessageOutlined, MessageOutlined,
ExperimentOutlined, ExperimentOutlined,
UserOutlined,
} from '@ant-design/icons'; } from '@ant-design/icons';
import classNames from 'classnames'; import classNames from 'classnames';
import { upgradeVersionAvailable } from '../utils/apis'; import { upgradeVersionAvailable } from '../utils/apis';
@ -78,6 +79,8 @@ export default function MainLayout(props) {
const upgradeVersionString = `${upgradeVersion}` || ''; const upgradeVersionString = `${upgradeVersion}` || '';
const upgradeMessage = `Upgrade to v${upgradeVersionString}`; const upgradeMessage = `Upgrade to v${upgradeVersionString}`;
const chatMenuItemStyle = 'block'; //upgradeVersion ? 'block' : 'none';
const clearAlertMessage = () => { const clearAlertMessage = () => {
alertMessage.setMessage(null); alertMessage.setMessage(null);
}; };
@ -144,10 +147,22 @@ export default function MainLayout(props) {
<Link href="/viewer-info">Viewers</Link> <Link href="/viewer-info">Viewers</Link>
</Menu.Item> </Menu.Item>
<Menu.Item key="chat" icon={<MessageOutlined />} title="Chat utilities"> <SubMenu
<Link href="/chat">Chat</Link> key="chat-config"
title="Chat"
icon={<MessageOutlined />}
style={{ display: chatMenuItemStyle }}
>
<Menu.Item key="messages" icon={<MessageOutlined />} title="Chat utilities">
<Link href="/chat/messages">Messages</Link>
</Menu.Item> </Menu.Item>
<Menu.Item key="chat-users" icon={<UserOutlined />} title="Chat utilities">
<Link href="/chat/users">Users</Link>
</Menu.Item>
</SubMenu>
<SubMenu key="configuration" title="Configuration" icon={<SettingOutlined />}> <SubMenu key="configuration" title="Configuration" icon={<SettingOutlined />}>
<Menu.Item key="config-public-details"> <Menu.Item key="config-public-details">
<Link href="/config-public-details">General</Link> <Link href="/config-public-details">General</Link>
@ -159,6 +174,9 @@ export default function MainLayout(props) {
<Menu.Item key="config-video"> <Menu.Item key="config-video">
<Link href="/config-video">Video Configuration</Link> <Link href="/config-video">Video Configuration</Link>
</Menu.Item> </Menu.Item>
<Menu.Item key="config-chat">
<Link href="/config-chat">Chat</Link>
</Menu.Item>
<Menu.Item key="config-storage"> <Menu.Item key="config-storage">
<Link href="/config-storage">Storage</Link> <Link href="/config-storage">Storage</Link>
</Menu.Item> </Menu.Item>

View file

@ -9,7 +9,7 @@ import {
} from '@ant-design/icons'; } from '@ant-design/icons';
import { fetchData, UPDATE_CHAT_MESSGAE_VIZ } from '../utils/apis'; import { fetchData, UPDATE_CHAT_MESSGAE_VIZ } from '../utils/apis';
import { MessageType } from '../types/chat'; import { MessageType } from '../types/chat';
import { OUTCOME_TIMEOUT } from '../pages/chat'; import { OUTCOME_TIMEOUT } from '../pages/chat/messages';
import { isEmptyObject } from '../utils/format'; import { isEmptyObject } from '../utils/format';
interface MessageToggleProps { interface MessageToggleProps {

View file

@ -5,10 +5,10 @@ import classNames from 'classnames';
import { ColumnsType } from 'antd/es/table'; import { ColumnsType } from 'antd/es/table';
import format from 'date-fns/format'; import format from 'date-fns/format';
import { CHAT_HISTORY, fetchData, FETCH_INTERVAL, UPDATE_CHAT_MESSGAE_VIZ } from '../utils/apis'; import { CHAT_HISTORY, fetchData, FETCH_INTERVAL, UPDATE_CHAT_MESSGAE_VIZ } from '../../utils/apis';
import { MessageType } from '../types/chat'; import { MessageType } from '../../types/chat';
import { isEmptyObject } from '../utils/format'; import { isEmptyObject } from '../../utils/format';
import MessageVisiblityToggle from '../components/message-visiblity-toggle'; import MessageVisiblityToggle from '../../components/message-visiblity-toggle';
const { Title } = Typography; const { Title } = Typography;

114
web/pages/chat/users.tsx Normal file
View file

@ -0,0 +1,114 @@
import React, { useState, useEffect, useContext } from 'react';
import { Table, Typography } from 'antd';
import { formatDistanceToNow } from 'date-fns';
import { SortOrder } from 'antd/lib/table/interface';
import { ServerStatusContext } from '../../utils/server-status-context';
import { CONNECTED_CLIENTS, VIEWERS_OVER_TIME, fetchData } from '../../utils/apis';
const FETCH_INTERVAL = 60 * 1000; // 1 min
export default function ChatUsers() {
const context = useContext(ServerStatusContext);
const { online } = context || {};
const [viewerInfo, setViewerInfo] = useState([]);
const [clients, setClients] = useState([]);
const getInfo = async () => {
try {
const result = await fetchData(VIEWERS_OVER_TIME);
setViewerInfo(result);
} catch (error) {
console.log('==== error', error);
}
try {
const result = await fetchData(CONNECTED_CLIENTS);
setClients(result);
} catch (error) {
console.log('==== error', error);
}
};
useEffect(() => {
let getStatusIntervalId = null;
getInfo();
if (online) {
getStatusIntervalId = setInterval(getInfo, FETCH_INTERVAL);
// returned function will be called on component unmount
return () => {
clearInterval(getStatusIntervalId);
};
}
return () => [];
}, [online]);
// todo - check to see if broadcast active has changed. if so, start polling.
if (!viewerInfo.length) {
return 'no info';
}
const columns = [
{
title: 'User name',
dataIndex: 'username',
key: 'username',
render: username => username || '-',
sorter: (a, b) => a.username - b.username,
sortDirections: ['descend', 'ascend'] as SortOrder[],
},
{
title: 'Messages sent',
dataIndex: 'messageCount',
key: 'messageCount',
sorter: (a, b) => a.messageCount - b.messageCount,
sortDirections: ['descend', 'ascend'] as SortOrder[],
},
{
title: 'Connected Time',
dataIndex: 'connectedAt',
key: 'connectedAt',
render: time => formatDistanceToNow(new Date(time)),
sorter: (a, b) => new Date(a.connectedAt).getTime() - new Date(b.connectedAt).getTime(),
sortDirections: ['descend', 'ascend'] as SortOrder[],
},
{
title: 'User Agent',
dataIndex: 'userAgent',
key: 'userAgent',
},
{
title: 'Location',
dataIndex: 'geo',
key: 'geo',
render: geo => (geo ? `${geo.regionName}, ${geo.countryCode}` : '-'),
},
];
return (
<>
<div>
<Typography.Title>Connected</Typography.Title>
<Table dataSource={clients} columns={columns} rowKey={row => row.clientID} />
<p>
<Typography.Text type="secondary">
Visit the{' '}
<a
href="https://owncast.online/docs/viewers/?source=admin"
target="_blank"
rel="noopener noreferrer"
>
documentation
</a>{' '}
to configure additional details about your viewers.
</Typography.Text>{' '}
</p>
</div>
</>
);
}

69
web/pages/config-chat.tsx Normal file
View file

@ -0,0 +1,69 @@
import React, { useState, useContext, useEffect } from 'react';
import { Typography } from 'antd';
import {
FIELD_PROPS_DISABLE_CHAT,
TEXTFIELD_PROPS_CHAT_USERNAME_BLOCKLIST,
} from '../utils/config-constants';
import { ServerStatusContext } from '../utils/server-status-context';
import ToggleSwitch from '../components/config/form-toggleswitch';
import { UpdateArgs } from '../types/config-section';
import { TEXTFIELD_TYPE_TEXTAREA } from '../components/config/form-textfield';
import TextFieldWithSubmit from '../components/config/form-textfield-with-submit';
export default function ConfigChat() {
const { Title } = Typography;
const [formDataValues, setFormDataValues] = useState(null);
const serverStatusData = useContext(ServerStatusContext);
const { serverConfig } = serverStatusData || {};
const { chatDisabled } = serverConfig;
const { usernameBlocklist } = serverConfig;
function handleChatDisableChange(disabled: boolean) {
handleFieldChange({ fieldName: 'chatDisabled', value: disabled });
}
function handleChatUsernameBlockListChange(args: UpdateArgs) {
handleFieldChange({ fieldName: 'usernameBlocklist', value: args.value });
}
useEffect(() => {
setFormDataValues({
chatDisabled,
usernameBlocklist,
});
}, [serverConfig]);
if (!formDataValues) {
return null;
}
const handleFieldChange = ({ fieldName, value }: UpdateArgs) => {
setFormDataValues({
...formDataValues,
[fieldName]: value,
});
};
return (
<div className="config-server-details-form">
<Title>Chat Settings</Title>
<div className="form-module config-server-details-container">
<ToggleSwitch
fieldName="chatDisabled"
{...FIELD_PROPS_DISABLE_CHAT}
checked={formDataValues.chatDisabled}
onChange={handleChatDisableChange}
/>
<TextFieldWithSubmit
fieldName="usernameBlocklist"
{...TEXTFIELD_PROPS_CHAT_USERNAME_BLOCKLIST}
type={TEXTFIELD_TYPE_TEXTAREA}
value={formDataValues.usernameBlocklist}
initialValue={usernameBlocklist}
onChange={handleChatUsernameBlockListChange}
/>
</div>
</div>
);
}

View file

@ -101,4 +101,5 @@ export interface ConfigDetails {
yp: ConfigDirectoryFields; yp: ConfigDirectoryFields;
supportedCodecs: string[]; supportedCodecs: string[];
videoCodec: string; videoCodec: string;
usernameBlocklist: string;
} }

View file

@ -30,6 +30,7 @@ export const API_VIDEO_VARIANTS = '/video/streamoutputvariants';
export const API_WEB_PORT = '/webserverport'; export const API_WEB_PORT = '/webserverport';
export const API_YP_SWITCH = '/directoryenabled'; export const API_YP_SWITCH = '/directoryenabled';
export const API_CHAT_DISABLE = '/chat/disable'; export const API_CHAT_DISABLE = '/chat/disable';
export const API_CHAT_USERNAME_BLOCKLIST = '/chat/disallowedusernames';
export const API_EXTERNAL_ACTIONS = '/externalactions'; export const API_EXTERNAL_ACTIONS = '/externalactions';
export const API_VIDEO_CODEC = '/video/codec'; export const API_VIDEO_CODEC = '/video/codec';
@ -175,11 +176,18 @@ export const DEFAULT_VARIANT_STATE: VideoVariant = {
export const FIELD_PROPS_DISABLE_CHAT = { export const FIELD_PROPS_DISABLE_CHAT = {
apiPath: API_CHAT_DISABLE, apiPath: API_CHAT_DISABLE,
configPath: 'chatDisabled', configPath: 'chatDisabled',
label: 'Hide chat', label: 'Disable chat',
tip: 'Hide the web chat interface.', tip: 'Disable chat functionality from your Owncast server.',
useSubmit: true, useSubmit: true,
}; };
export const TEXTFIELD_PROPS_CHAT_USERNAME_BLOCKLIST = {
apiPath: API_CHAT_USERNAME_BLOCKLIST,
placeholder: 'admin, god, owncast, stewiegriffin',
label: 'Disallowed usernames',
tip: 'A comma seperated list of chat usernames you disallow.',
};
export const VIDEO_VARIANT_SETTING_DEFAULTS = { export const VIDEO_VARIANT_SETTING_DEFAULTS = {
// this one is currently unused // this one is currently unused
audioBitrate: { audioBitrate: {

View file

@ -48,6 +48,7 @@ export const initialServerConfigState: ConfigDetails = {
externalActions: [], externalActions: [],
supportedCodecs: [], supportedCodecs: [],
videoCodec: '', videoCodec: '',
usernameBlocklist: '',
}; };
const initialServerStatusState = { const initialServerStatusState = {