/* eslint-disable jsx-a11y/alt-text */ import { ComponentPropsWithoutRef, lazy, ReactEventHandler, ReactNode, Suspense, useMemo, useState, } from 'react'; import { attributesToProps, domToReact, Element, HTMLReactParserOptions, Text as DOMText, } from 'html-react-parser'; import { MatrixClient } from '$types/matrix-sdk'; import classNames from 'classnames'; import { Box, Chip, config, Header, Icon, IconButton, Icons, Scroll, Text, toRem } from 'folds'; import { IntermediateRepresentation, OptFn, Opts as LinkifyOpts } from 'linkifyjs'; import Linkify from 'linkify-react'; import { ErrorBoundary } from 'react-error-boundary'; import { ChildNode } from 'domhandler'; import * as css from '$styles/CustomHtml.css'; import { getCanonicalAliasRoomId, getMxIdLocalPart, isRoomAlias, mxcUrlToHttp, } from '$utils/matrix'; import { getMemberDisplayName } from '$utils/room'; import { Nicknames } from '$state/nicknames'; import { EMOJI_PATTERN, sanitizeForRegex, URL_NEG_LB } from '$utils/regex'; import { findAndReplace } from '$utils/findAndReplace'; import { onEnterOrSpace } from '$utils/keyboard'; import { copyToClipboard } from '$utils/dom'; import { useTimeoutToggle } from '$hooks/useTimeoutToggle'; import { ClientSideHoverFreeze } from '$components/ClientSideHoverFreeze'; import { parseMatrixToRoom, parseMatrixToRoomEvent, parseMatrixToUser, testMatrixTo, } from './matrix-to'; import { getHexcodeForEmoji, getShortcodeFor } from './emoji'; const ReactPrism = lazy(() => import('./react-prism/ReactPrism')); const EMOJI_REG_G = new RegExp(`${URL_NEG_LB}(${EMOJI_PATTERN})`, 'g'); export const LINKIFY_OPTS: LinkifyOpts = { attributes: { target: '_blank', rel: 'noreferrer noopener', }, validate: { url: (value) => /^(https|http|ftp|mailto|magnet)?:/.test(value), }, ignoreTags: ['span'], }; export const safeDecodeUrl = (url: string) => { try { return decodeURIComponent(url); } catch { return url; } }; export const makeMentionCustomProps = ( handleMentionClick?: ReactEventHandler, content?: string ): ComponentPropsWithoutRef<'a'> => ({ style: { cursor: 'pointer' }, target: '_blank', rel: 'noreferrer noopener', role: 'link', tabIndex: handleMentionClick ? 0 : -1, onKeyDown: handleMentionClick ? onEnterOrSpace(handleMentionClick) : undefined, onClick: handleMentionClick, children: content, }); export const renderMatrixMention = ( mx: MatrixClient, currentRoomId: string | undefined, href: string, customProps: ComponentPropsWithoutRef<'a'>, nicknames?: Nicknames ) => { const userId = parseMatrixToUser(href); if (userId) { const currentRoom = mx.getRoom(currentRoomId); return ( {`@${ (currentRoom && getMemberDisplayName(currentRoom, userId, nicknames)) ?? getMxIdLocalPart(userId) }`} ); } const matrixToRoom = parseMatrixToRoom(href); if (matrixToRoom) { const { roomIdOrAlias, viaServers } = matrixToRoom; const mentionRoom = mx.getRoom( isRoomAlias(roomIdOrAlias) ? getCanonicalAliasRoomId(mx, roomIdOrAlias) : roomIdOrAlias ); const fallbackContent = mentionRoom ? `#${mentionRoom.name}` : roomIdOrAlias; return ( {customProps.children ? customProps.children : fallbackContent} ); } const matrixToRoomEvent = parseMatrixToRoomEvent(href); if (matrixToRoomEvent) { const { roomIdOrAlias, eventId, viaServers } = matrixToRoomEvent; const mentionRoom = mx.getRoom( isRoomAlias(roomIdOrAlias) ? getCanonicalAliasRoomId(mx, roomIdOrAlias) : roomIdOrAlias ); return ( {customProps.children ? customProps.children : `Message: ${mentionRoom ? `#${mentionRoom.name}` : roomIdOrAlias}`} ); } return undefined; }; export const factoryRenderLinkifyWithMention = ( mentionRender: (href: string) => JSX.Element | undefined ): OptFn<(ir: IntermediateRepresentation) => any> => { const renderLink: OptFn<(ir: IntermediateRepresentation) => any> = ({ tagName, attributes, content, }) => { const encodedHref = attributes.href; const decodedHref = encodedHref && safeDecodeUrl(encodedHref); if (tagName === 'a' && decodedHref && testMatrixTo(decodedHref)) { const mention = mentionRender(decodedHref); if (mention) return mention; } return {content}; }; return renderLink; }; export const scaleSystemEmoji = (text: string): (string | JSX.Element)[] => findAndReplace( text, EMOJI_REG_G, (match, pushIndex) => ( {match[0]} ), (txt) => txt ); export const makeHighlightRegex = (highlights: string[]): RegExp | undefined => { const pattern = highlights.map(sanitizeForRegex).join('|'); if (!pattern) return undefined; return new RegExp(pattern, 'gi'); }; export const highlightText = ( regex: RegExp, data: (string | JSX.Element)[] ): (string | JSX.Element)[] => data.flatMap((text) => { if (typeof text !== 'string') return text; return findAndReplace( text, regex, (match, pushIndex) => ( {match[0]} ), (txt) => txt ); }); /** * Recursively extracts and concatenates all text content from an array of ChildNode objects. * * @param {ChildNode[]} nodes - An array of ChildNode objects to extract text from. * @returns {string} The concatenated plain text content of all descendant text nodes. */ const extractTextFromChildren = (nodes: ChildNode[]): string => { let text = ''; nodes.forEach((node) => { if (node.type === 'text') { text += node.data; } else if (node instanceof Element && node.children) { text += extractTextFromChildren(node.children); } }); return text; }; export function CodeBlock({ children, opts, }: { children: ChildNode[]; opts: HTMLReactParserOptions; }) { const code = children[0]; const languageClass = code instanceof Element && code.name === 'code' ? code.attribs.class : undefined; const language = languageClass && languageClass.startsWith('language-') ? languageClass.replace('language-', '') : languageClass; const LINE_LIMIT = 14; const largeCodeBlock = useMemo( () => extractTextFromChildren(children).split('\n').length > LINE_LIMIT, [children] ); const [expanded, setExpand] = useState(false); const [copied, setCopied] = useTimeoutToggle(); const handleCopy = () => { copyToClipboard(extractTextFromChildren(children)); setCopied(); }; const toggleExpand = () => { setExpand(!expanded); }; return (
{language ?? 'Code'} } > {copied ? 'Copied' : 'Copy'} {largeCodeBlock && ( )}
{domToReact(children as any, opts)}
{largeCodeBlock && !expanded && }
); } /** * Thin wrapper around that gracefully swaps in a fallback node when the * image fails to load (e.g. federation down, mxc URL unavailable). Avoids the * silent browser broken-image icon showing up in message bodies. */ function FallbackImg({ fallback, ...props }: ComponentPropsWithoutRef<'img'> & { fallback: ReactNode }) { const [failed, setFailed] = useState(false); if (failed) return <>{fallback}; return setFailed(true)} />; } export const getReactCustomHtmlParser = ( mx: MatrixClient, roomId: string | undefined, params: { linkifyOpts: LinkifyOpts; highlightRegex?: RegExp; handleSpoilerClick?: ReactEventHandler; handleMentionClick?: ReactEventHandler; useAuthentication?: boolean; nicknames?: Nicknames; autoplayEmojis?: boolean; replaceTextNode?: (text: string) => ReactNode | undefined; } ): HTMLReactParserOptions => { const { replaceTextNode } = params; const opts: HTMLReactParserOptions = { replace: (domNode) => { if (replaceTextNode && domNode instanceof DOMText) { return replaceTextNode(domNode.data) ?? undefined; } if (domNode instanceof Element && 'name' in domNode) { const { name, attribs, children, parent } = domNode; const renderChildren = () => domToReact(children as any, opts); const props = attributesToProps(attribs); if (name === 'h1') { return ( {renderChildren()} ); } if (name === 'h2') { return ( {renderChildren()} ); } if (name === 'h3') { return ( {renderChildren()} ); } if (name === 'h4') { return ( {renderChildren()} ); } if (name === 'h5') { return ( {renderChildren()} ); } if (name === 'h6') { return ( {renderChildren()} ); } if (name === 'p') { return ( {renderChildren()} ); } if (name === 'sub') { return ( {renderChildren()} ); } if (name === 'hr') { return
; } if (name === 'pre') { return {children}; } if (name === 'blockquote') { return ( {renderChildren()} ); } if (name === 'ul') { return (
    {renderChildren()}
); } if (name === 'ol') { return (
    {renderChildren()}
); } if (name === 'code') { if (parent && 'name' in parent && parent.name === 'pre') { const codeReact = renderChildren(); if (typeof codeReact === 'string') { let lang = typeof props.className === 'string' ? props.className : undefined; if (lang === 'language-rs') lang = 'language-rust'; else if (lang === 'language-js') lang = 'language-javascript'; else if (lang === 'language-ts') lang = 'language-typescript'; return ( {codeReact}}> {codeReact}}> {(ref) => ( {codeReact} )} ); } } else { return ( {renderChildren()} ); } } if (name === 'a' && typeof props.href === 'string') { const encodedHref = props.href; const decodedHref = encodedHref && safeDecodeUrl(encodedHref); if (!decodedHref || !testMatrixTo(decodedHref)) { return undefined; } const content = children.find((child) => !(child instanceof DOMText)) ? undefined : children.map((c) => (c instanceof DOMText ? c.data : '')).join(); const mention = renderMatrixMention( mx, roomId, safeDecodeUrl(props.href), makeMentionCustomProps(params.handleMentionClick, content), params.nicknames ); if (mention) return mention; } if (name === 'span' && 'data-mx-spoiler' in props) { return ( {renderChildren()} ); } if (name === 'img') { // Guard: img without a src survives sanitisation (fix for crash #1731) // but we can't convert it — skip rendering rather than passing // undefined into mxcUrlToHttp where it would throw. if (!props.src) return null; const htmlSrc = mxcUrlToHttp(mx, props.src, params.useAuthentication) ?? undefined; // Non-mxc images were already converted to links by the sanitiser, // but handle the edge case defensively here too. if (htmlSrc && !props.src.startsWith('mxc://')) { return ( {props.alt || props.title || htmlSrc} ); } if ('data-mx-emoticon' in props) { // When the mxc URL can't be resolved (e.g. federation unavailable), // fall back to rendering the shortcode text so the message stays readable. if (!htmlSrc) { const label = props.alt || props.title || ''; return ( {label ? `:${label}:` : ''} ); } const siblingCount = domNode.parent?.children.length ?? 0; // seperate style for bundled emojis // seperate style for bundled emojis if (siblingCount > 5) { return ( {!params.autoplayEmojis ? ( {props.alt || props.title || '?'} } /> ) : ( {props.alt || props.title || '?'} } /> )} ); } // old style for just a few... what is this even for? React components or something? return ( {!params.autoplayEmojis ? ( {props.alt || props.title || '?'} } /> ) : ( {props.alt || props.title || '?'} } /> )} ); } if (htmlSrc) return ( {props.alt || '[media]'} } /> ); } } if (domNode instanceof DOMText) { const linkify = !(domNode.parent && 'name' in domNode.parent && domNode.parent.name === 'code') && !(domNode.parent && 'name' in domNode.parent && domNode.parent.name === 'a'); let jsx = scaleSystemEmoji(domNode.data); if (params.highlightRegex) { jsx = highlightText(params.highlightRegex, jsx); } if (linkify) { return {jsx}; } return jsx; } return undefined; }, }; return opts; };