LogalDeveloper/owncast
LogalDeveloper/owncast
0
Fork 0
Code

fix(js): consolidate url and account validators

Browse Source
This commit is contained in:
Gabe Kangas 2023-04-16 14:17:13 -07:00
parent e84ccbb90b
commit b3ac4e1a15
No known key found for this signature in database
GPG Key ID: 4345B2060657F330
11 changed files with 101 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
web/components/admin/config/general/EditSocialLinks.tsx
View File

@ -18,7 +18,7 @@ import {
isValidAccount,
isValidUrl,
DEFAULT_TEXTFIELD_URL_PATTERN,
} from '../../../../utils/urls';
} from '../../../../utils/validators';
import { TextField } from '../../TextField';
import { createInputStatus, STATUS_ERROR, STATUS_SUCCESS } from '../../../../utils/input-statuses';
import { FormStatusIndicator } from '../../FormStatusIndicator';

2
web/components/admin/config/server/EditStorage.tsx
View File

@ -20,7 +20,7 @@ import {
} from '../../../../utils/input-statuses';
import { TextField } from '../../TextField';
import { FormStatusIndicator } from '../../FormStatusIndicator';
import { isValidUrl } from '../../../../utils/urls';
import { isValidUrl } from '../../../../utils/validators';
import { ToggleSwitch } from '../../ToggleSwitch';
const { Panel } = Collapse;

4
web/components/modals/FediAuthModal/FediAuthModal.tsx
View File

@ -2,7 +2,7 @@ import { Alert, Button, Input, Space, Spin, Collapse } from 'antd';
import React, { FC, useState } from 'react';
import dynamic from 'next/dynamic';
import styles from './FediAuthModal.module.scss';
import { validateAccount } from '../../../utils/validators';
import { isValidFediverseAccount } from '../../../utils/validators';
const { Panel } = Collapse;
@ -50,7 +50,7 @@ export const FediAuthModal: FC<FediAuthModalProps> = ({
}
const validate = (acct: string) => {
setValid(validateAccount(acct));
setValid(isValidFediverseAccount(acct));
};
const onInput = (e: React.ChangeEvent<HTMLInputElement>) => {

10
web/components/modals/FollowModal/FollowModal.tsx
View File

@ -2,6 +2,7 @@
import { Input, Button, Alert, Spin, Space } from 'antd';
import { FC, useState } from 'react';
import styles from './FollowModal.module.scss';
import { isValidFediverseAccount } from '../../../utils/validators';
const ENDPOINT = '/api/remotefollow';
@ -11,13 +12,6 @@ export type FollowModalProps = {
name: string;
};
function validateAccount(a) {
const sanitized = a.replace(/^@+/, '');
const regex =
/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
return regex.test(String(sanitized).toLowerCase());
}
export const FollowModal: FC<FollowModalProps> = ({ handleClose, account, name }) => {
const [remoteAccount, setRemoteAccount] = useState(null);
const [valid, setValid] = useState(false);
@ -26,7 +20,7 @@ export const FollowModal: FC<FollowModalProps> = ({ handleClose, account, name }
const handleAccountChange = a => {
setRemoteAccount(a);
if (validateAccount(a)) {
if (isValidFediverseAccount(a)) {
setValid(true);
} else {
setValid(false);

2
web/components/modals/IndieAuthModal/IndieAuthModal.tsx
View File

@ -1,7 +1,7 @@
import { Alert, Input, Space, Spin, Collapse, Typography, Button } from 'antd';
import dynamic from 'next/dynamic';
import React, { FC, useState } from 'react';
import { isValidUrl } from '../../../utils/urls';
import { isValidUrl } from '../../../utils/validators';
const { Panel } = Collapse;
const { Link } = Typography;

2
web/pages/admin/actions.tsx
View File

@ -13,7 +13,7 @@ import {
} from '../../utils/config-constants';
import { createInputStatus, STATUS_ERROR, STATUS_SUCCESS } from '../../utils/input-statuses';
import { ServerStatusContext } from '../../utils/server-status-context';
import { isValidUrl, DEFAULT_TEXTFIELD_URL_PATTERN } from '../../utils/urls';
import { isValidUrl, DEFAULT_TEXTFIELD_URL_PATTERN } from '../../utils/validators';
import { AdminLayout } from '../../components/layouts/AdminLayout';

2
web/pages/admin/config-notify.tsx
View File

@ -12,7 +12,7 @@ import {
import { TEXTFIELD_PROPS_FEDERATION_INSTANCE_URL } from '../../utils/config-constants';
import { ServerStatusContext } from '../../utils/server-status-context';
import { UpdateArgs } from '../../types/config-section';
import { isValidUrl } from '../../utils/urls';
import { isValidUrl } from '../../utils/validators';
import { AdminLayout } from '../../components/layouts/AdminLayout';

2
web/pages/admin/webhooks.tsx
View File

@ -15,7 +15,7 @@ import {
import dynamic from 'next/dynamic';
import React, { ReactElement, useEffect, useState } from 'react';
import { CREATE_WEBHOOK, DELETE_WEBHOOK, fetchData, WEBHOOKS } from '../../utils/apis';
import { isValidUrl, DEFAULT_TEXTFIELD_URL_PATTERN } from '../../utils/urls';
import { isValidUrl, DEFAULT_TEXTFIELD_URL_PATTERN } from '../../utils/validators';
import { AdminLayout } from '../../components/layouts/AdminLayout';

2
web/utils/config-constants.tsx
View File

@ -1,7 +1,7 @@
// DEFAULT VALUES
import { fetchData, SERVER_CONFIG_UPDATE_URL } from './apis';
import { ApiPostArgs, VideoVariant, SocialHandle } from '../types/config-section';
import { DEFAULT_TEXTFIELD_URL_PATTERN } from './urls';
import { DEFAULT_TEXTFIELD_URL_PATTERN } from './validators';
export const TEXT_MAXLENGTH = 255;

83
web/utils/urls.ts
View File

@ -1,83 +0,0 @@
// to use with <input type="url"> fields, as the default pattern only checks for `:`,
export const DEFAULT_TEXTFIELD_URL_PATTERN = 'https?://.*';
/**
* Determines if a URL is valid
* @param {string} url - A URL to validate.
* @param {string[]} validProtocols - An array of valid protocols. Defaults to web.
* @returns {boolean} - True if the URI is valid, false otherwise.
*/
export function isValidUrl(url: string, validProtocols: string[] = ['http:', 'https:']): boolean {
try {
const validationObject = new URL(url);
if (
validationObject.protocol === '' ||
validationObject.hostname === '' ||
!validProtocols.includes(validationObject.protocol)
) {
return false;
}
} catch (e) {
return false;
}
return true;
}
/**
* Determines if an account is valid by simply checking for a protocol, username
* and server, delimited by a colon. For example: @username:example.com
* @param {string} account - An account to validate.
* @param {string} protocol - The protocol we expect the account to be using.
* @returns {boolean} - True if the account is valid, false otherwise.
*/
export function isValidAccount(account: string, protocol: string): boolean {
if (account.startsWith('@')) {
// eslint-disable-next-line no-param-reassign
account = account.slice(1);
}
const components = account.split(/:|@/);
const [service, user, host] = components;
console.log({ account, protocol, service, user, host });
if (service !== protocol) {
return false;
}
if (components.length !== 3 || !service || !user || !host) {
return false;
}
return true;
}
/**
* Determines if an account is valid by simply checking for a protocol, username
* and server, delimited by a colon. For example: @username:example.com
* @param {string} account - An account to validate.
* @returns {boolean} - True if the account is valid, false otherwise.
*/
export function isValidMatrixAccount(account: string): boolean {
if (account.startsWith('matrix:')) {
// eslint-disable-next-line no-param-reassign
account = account.slice(7);
} else {
return false;
}
if (account.startsWith('@')) {
// eslint-disable-next-line no-param-reassign
account = account.slice(1);
}
const components = account.split(':');
const [user, host] = components;
if (components.length !== 2 || !user || !host) {
return false;
}
return true;
}

94
web/utils/validators.ts
View File

@ -1,7 +1,93 @@
// eslint-disable-next-line import/prefer-default-export
export function validateAccount(account) {
const a = account.replace(/^@+/, '');
// to use with <input type="url"> fields, as the default pattern only checks for `:`,
export const DEFAULT_TEXTFIELD_URL_PATTERN = 'https?://.*';
/**
* Determines if a URL is valid
* @param {string} url - A URL to validate.
* @param {string[]} validProtocols - An array of valid protocols. Defaults to web.
* @returns {boolean} - True if the URI is valid, false otherwise.
*/
export function isValidUrl(url: string, validProtocols: string[] = ['http:', 'https:']): boolean {
try {
const validationObject = new URL(url);
if (
validationObject.protocol === '' ||
validationObject.hostname === '' ||
!validProtocols.includes(validationObject.protocol)
) {
return false;
}
} catch (e) {
return false;
}
return true;
}
/**
* Determines if an account is valid by checking for a protocol, username
* and server, delimited by a colon. For example: @username:example.com
* @param {string} account - An account to validate.
* @param {string} protocol - The protocol we expect the account to be using.
* @returns {boolean} - True if the account is valid, false otherwise.
*/
export function isValidAccount(account: string, protocol: string): boolean {
if (account.startsWith('@')) {
// eslint-disable-next-line no-param-reassign
account = account.slice(1);
}
const components = account.split(/:|@/);
const [service, user, host] = components;
if (service !== protocol) {
return false;
}
if (components.length !== 3 || !service || !user || !host) {
return false;
}
return true;
}
/**
* Determines if an account is valid by simply checking for a protocol, username
* and server, delimited by a colon. For example: @username:example.com
* @param {string} account - An account to validate. Example: @me:matrix.org
* @returns {boolean} - True if the account is valid, false otherwise.
*/
export function isValidMatrixAccount(account: string): boolean {
if (account.startsWith('matrix:')) {
// eslint-disable-next-line no-param-reassign
account = account.slice(7);
}
if (account.startsWith('@')) {
// eslint-disable-next-line no-param-reassign
account = account.slice(1);
}
const components = account.split(':');
const [user, host] = components;
if (components.length !== 2 || !user || !host) {
return false;
}
return true;
}
/**
* Determines if a fediverse account is valid.
* For example: @username@example.com
* @param {string} account - An account to validate.
* @returns {boolean} - True if the account is valid, false otherwise.
*/
export function isValidFediverseAccount(account: string): boolean {
const sanitized = account.replace(/^@+/, '');
const regex =
/^(([^<>()[\]\\.,;:\s@"]+(\.[^<>()[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/;
return regex.test(String(a).toLowerCase());
return regex.test(String(sanitized).toLowerCase());
}