wrolpi/app/src/components/Common.js
Roland bf5b787fb3
Some checks failed
CodeQL / Analyze (push) Has been cancelled
Controller Tests / controller-tests (push) Has been cancelled
Jest Tests / jest-tests (push) Has been cancelled
Unifying Files tab appearance for model pages.
2026-03-28 14:19:09 -06:00

2291 lines
74 KiB
JavaScript

import React, {useContext, useEffect, useState} from "react";
import {
AccordionContent,
AccordionTitle,
BreadcrumbSection,
Button as SButton,
ButtonGroup,
Card,
Container,
Dimmer,
DimmerDimmable,
GridColumn,
GridRow,
Icon as SIcon,
IconGroup,
Input,
Label,
Pagination,
Search,
Transition
} from 'semantic-ui-react';
import {Link, NavLink, useNavigate} from "react-router";
import Message from "semantic-ui-react/dist/commonjs/collections/Message";
import {useBluetooth, useHotspot, useSearchDirectories, useSearchOrder, useThrottle, useWROLMode} from "../hooks/customHooks";
import {Media, SettingsContext, StatusContext, ThemeContext} from "../contexts/contexts";
import {
Accordion,
Breadcrumb,
Button,
Card as ThemedCard,
Confirm,
darkTheme,
Form,
Header,
Icon,
lightTheme,
Loader,
Menu,
Modal,
Popup,
Segment,
Statistic
} from "./Theme";
import {FilePreviewContext} from "./FilePreview";
import _ from "lodash";
import {killDownloads, startDownloads, unlockCookies} from "../api";
import {allFrequencyOptions, HELP_VIEWER_URI, NAME, semanticUIColorMap, validUrlRegex} from "./Vars";
import Grid from "semantic-ui-react/dist/commonjs/collections/Grid";
export function Paginator({activePage, onPageChange, totalPages, showFirstAndLast, size = 'mini'}) {
const handlePageChange = (e, {activePage}) => {
onPageChange(activePage);
}
return <>
<Media at='mobile'>
<Pagination
activePage={activePage}
boundaryRange={1}
onPageChange={handlePageChange}
size={size}
siblingRange={2}
totalPages={totalPages || 1}
firstItem={showFirstAndLast ? undefined : null}
lastItem={showFirstAndLast ? undefined : null}
/>
</Media>
<Media greaterThanOrEqual='tablet'>
<Pagination
activePage={activePage}
boundaryRange={1}
onPageChange={handlePageChange}
size={size}
siblingRange={5}
totalPages={totalPages || 1}
firstItem={showFirstAndLast ? undefined : null}
lastItem={showFirstAndLast ? undefined : null}
/>
</Media>
</>
}
export function divmod(x, y) {
return [Math.floor(x / y), x % y];
}
export function secondsToHumanElapsed(seconds, short = true) {
// Convert the provided seconds into a human-readable string of the time elapsed between the provided timestamp
// and now.
if (!seconds || seconds < 0) {
return null;
}
// Get seconds elapsed between now and `seconds` which is a UTC epoch.
const localNow = (new Date()).getTime() / 1000;
let years;
let days;
let hours;
let minutes;
seconds = Math.abs(localNow - seconds);
[years, seconds] = divmod(seconds, secondsToYears);
[days, seconds] = divmod(seconds, secondsToDays);
[hours, seconds] = divmod(seconds, secondsToHours);
[minutes, seconds] = divmod(seconds, secondsToMinutes);
seconds = Math.floor(seconds);
if (short) {
if (years > 0 && days > 30) {
return `${years}y${days}d`;
} else if (years > 0) {
return `${years}y`;
} else if (days > 0) {
return `${days}d`;
} else if (hours > 0) {
return `${hours}h`;
} else if (minutes > 0) {
return `${minutes}m`;
}
return `${seconds}s`
} else {
if (years > 0 && days > 30) {
return `${years} years ${days} days`;
} else if (years > 0) {
return `${years} years`;
} else if (days > 0) {
return `${days} days`;
} else if (hours > 0) {
return `${hours} hours`;
} else if (minutes > 0) {
return `${minutes} minutes`;
}
return `${seconds} seconds`
}
}
export function secondsToElapsedPopup(seconds) {
// Return a Popup which allows the user see a more detailed timestamp when hovering.
const elapsed = secondsToHumanElapsed(seconds);
if (!elapsed) {
return <></>;
}
return <Popup
content={secondsToTimestamp(seconds)}
on='hover'
trigger={<span>{elapsed}</span>}
/>
}
export function isoDatetimeToElapsedPopup(dt) {
let d = new Date(dt);
return secondsToElapsedPopup(d.getTime() / 1000);
}
export function isoDatetimeToAgoPopup(dt, short = true) {
const seconds = (new Date(dt)).getTime() / 1000;
// Return a Popup which allows the user see a more detailed timestamp when hovering.
const elapsed = secondsToHumanElapsed(seconds, short);
if (seconds === 0 || !elapsed) {
return <></>;
}
const trigger = <span>{isoDatetimeToString(dt)}</span>;
return <Popup
content={<span>{elapsed} ago</span>}
on='hover'
trigger={trigger}
/>
}
export function secondsToHMS(totalSeconds) {
let hours = Math.floor(totalSeconds / 3600);
totalSeconds -= hours * 3600;
let minutes = Math.floor(totalSeconds / 60);
let seconds = totalSeconds - (minutes * 60);
hours = String('00' + hours).slice(-2);
minutes = String('00' + minutes).slice(-2);
seconds = String('00' + seconds).slice(-2);
return {hours, minutes, seconds};
}
export function Duration({totalSeconds}) {
const {hours, minutes, seconds} = secondsToHMS(totalSeconds);
if (hours > 0) {
return <div className='duration-overlay'>{hours}:{minutes}:{seconds}</div>
} else if (totalSeconds) {
return <div className='duration-overlay'>{minutes}:{seconds}</div>
} else {
return <></>
}
}
export function isoDatetimeToString(dt, time = false) {
// Convert a datetime to a human-readable date format.
let d = <React.Fragment/>;
if (dt && time) {
d = new Date(dt);
const hours = String(d.getHours()).padStart(2, '0');
const minutes = String(d.getMinutes()).padStart(2, '0');
const seconds = String(d.getSeconds()).padStart(2, '0');
d = `${d.toDateString()} ${hours}:${minutes}:${seconds}`;
} else if (dt) {
d = new Date(dt);
d = d.toDateString();
}
return d;
}
export function CardLink({to, newTab = false, ...props}) {
const {t} = useContext(ThemeContext);
props = {...props, ...t};
props = newTab === true ? {...props, target: '_blank', rel: 'noopener noreferrer'} : props;
return <Link to={to} className="no-link-underscore card-link" {...props}>
{props.children}
</Link>
}
export function ExternalCardLink({to, children, ...props}) {
const {t} = useContext(ThemeContext);
return <a
href={to}
target='_blank'
rel='noopener noreferrer'
className='no-link-underscore card-link'
{...t}
{...props}
>
{children}
</a>
}
export function PreviewLink({file, children, className, ...props}) {
const {t} = useContext(ThemeContext);
const {setPreviewFile} = React.useContext(FilePreviewContext);
className = className ? `clickable ${className}` : `clickable `;
return <span className={className} onClick={() => setPreviewFile(file)} {...props} {...t}>
{children}
</span>
}
export function PreviewPath({path, mimetype, taggable = true, ...props}) {
return <PreviewLink file={{path, mimetype, taggable}} {...props}/>
}
export function DirectoryLink({path}) {
if (!path) return <span>Unknown</span>;
const href = `/media/${encodeMediaPath(path)}/`;
return <a href={href} target='_blank' rel='noopener noreferrer'
style={{color: 'inherit', textDecoration: 'none'}}>
{path}
</a>
}
export function RequiredAsterisk() {
return <span style={{color: '#db2828'}}> *</span>
}
/**
* Format a frequency value (in seconds) to a human-readable string using allFrequencyOptions.
* @param {number|null} frequency - Frequency in seconds
* @returns {string} Human-readable frequency text or '-' if null/undefined
*/
export function formatFrequency(frequency) {
if (frequency === null || frequency === undefined) {
return '-';
}
const option = allFrequencyOptions[frequency];
return option ? option.text : `${frequency}s`;
}
const secondsToYears = 31536000;
const secondsToDays = 86400;
const secondsToHours = 3600;
const secondsToMinutes = 60;
export function secondsToFullDuration(seconds) {
let duration = '';
let years, days, hours, minutes;
[years, seconds] = divmod(seconds, secondsToYears);
[days, seconds] = divmod(seconds, secondsToDays);
[hours, seconds] = divmod(seconds, secondsToHours);
[minutes] = divmod(seconds, secondsToMinutes);
if (years > 0) {
duration = `${years}Y`;
}
if (days > 0) {
duration = `${duration} ${days}D`;
}
if (hours > 0 || minutes > 0) {
hours = String(hours).padStart(2, '0');
minutes = String(minutes).padStart(2, '0');
duration = `${duration} ${hours}:${minutes}`;
}
if (years === 0 && days === 0 && hours === 0 && minutes === 0) {
// Less than a minute.
seconds = String(seconds).padStart(2, '0');
duration = `00:00:${seconds}`;
}
return duration.trim();
}
export function secondsToTimestamp(seconds) {
let d = new Date(seconds * 1000);
const month = String(d.getMonth() + 1).padStart(2, '0');
const day = String(d.getDate()).padStart(2, '0');
const hours = String(d.getHours()).padStart(2, '0');
const minutes = String(d.getMinutes()).padStart(2, '0');
const sec = String(d.getSeconds()).padStart(2, '0');
return `${d.getFullYear()}-${month}-${day} ${hours}:${minutes}:${sec}`;
}
export function humanFileSize(bytes, dp = 1) {
// Handle null/undefined
if (bytes == null) {
return '-';
}
// Convert string to number if needed
if (typeof bytes === 'string') {
bytes = parseFloat(bytes);
}
// Handle invalid numbers
if (isNaN(bytes) || !isFinite(bytes)) {
return '-';
}
const thresh = 1024;
if (Math.abs(bytes) < thresh) {
return bytes + ' B';
}
const units = ['kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
let u = -1;
const r = 10 ** dp;
do {
bytes /= thresh;
++u;
} while (Math.round(Math.abs(bytes) * r) / r >= thresh && u < units.length - 1);
return bytes.toFixed(dp) + ' ' + units[u];
}
export function humanBandwidth(bytes) {
// Convert bytes to MBps and return a string.
const thresh = 1024;
if (Math.abs(bytes) < thresh) {
return bytes + ' Bps';
}
const units = ['KBps', 'MBps', 'GBps', 'TBps', 'PBps', 'EBps', 'ZBps', 'YBps'];
let u = -1;
const r = 10;
do {
bytes /= thresh;
++u;
} while (Math.round(Math.abs(bytes) * r) / r >= thresh && u < units.length - 1);
return bytes.toFixed(0) + ' ' + units[u];
}
export function humanNumber(num, dp = 1) {
// Convert large numbers to a more human-readable format.
// >> humanNumber(1000)
// 1.0k
// >> humanNumber(1500000)
// 1.5m
const divisor = 1000;
if (Math.abs(num) < divisor) {
return num;
}
const units = ['k', 'm', 'b'];
let i = -1;
const r = 10 ** dp;
do {
num /= divisor;
++i;
} while (Math.round(Math.abs(num) * r) / r >= divisor && i < units.length - 1);
return num.toFixed(dp) + units[i];
}
export function replaceNullValues(obj, newValue) {
newValue = newValue === undefined ? '' : newValue;
let keys = Object.keys(obj);
for (let i = 0; i < keys.length; i++) {
let key = keys[i];
obj[key] = obj[key] === null ? newValue : obj[key];
}
}
export function enumerate(array) {
let newArray = [];
for (let i = 0; i < array.length; i++) {
newArray = newArray.concat([[i, array[i]]]);
}
return newArray;
}
export function arraysEqual(a, b) {
if (a === b) return true;
if (a == null || b == null) return false;
if (a.length !== b.length) return false;
for (var i = 0; i < a.length; ++i) {
if (a[i] !== b[i]) return false;
}
return true;
}
export function scrollToTop() {
window.scrollTo({
top: 0, behavior: "auto"
});
}
export function scrollToTopOfElement(element, smooth = true) {
element.scroll({
top: 0,
behavior: smooth ? 'smooth' : 'auto',
});
}
const useClearableInput = (searchStr, onChange, onClear, onSubmit, size = 'small', placeholder = 'Search...', icon = 'search', clearDisabled = null, inputRef = null) => {
const [value, setValue] = useState(searchStr || '');
const [submitted, setSubmitted] = useState(false);
React.useEffect(() => {
// Search was changed above.
if (searchStr !== value) {
setValue(searchStr);
}
if (!searchStr) {
setValue('');
}
}, [searchStr, value]);
const handleChange = (e) => {
if (e) {
e.preventDefault();
}
setValue(e.target.value);
setSubmitted(false);
if (onChange) {
// Try to call the remote function, don't let its failure break this.
try {
onChange(e.target.value);
} catch (e) {
console.error(`Call to ${onChange} failed`);
}
}
}
const handleClearSearch = (e) => {
e.preventDefault();
// Clear the input when the "clear" button is clicked, search again.
setValue('');
setSubmitted(false);
if (onSubmit) {
onSubmit('');
}
if (onClear) {
onClear();
}
}
const localOnSubmit = (e) => {
// Send the value up when submitting.
e.preventDefault();
setSubmitted(true);
if (onSubmit) {
onSubmit(value);
} else {
console.debug('No onSubmit defined');
}
}
const clearButton = <Button
icon='close'
size={size}
onClick={handleClearSearch}
type='button'
// If `clearDisabled` is provided, use it to disable the clear button. Fallback to disabling if there is no
// search value.
disabled={clearDisabled !== null ? clearDisabled : !!!value}
className='search-clear'
/>;
// Can only clear after submitting.
let action = submitted ? clearButton : <Button type='button' icon={icon} size='big'/>;
const input = <Input fluid
placeholder={placeholder}
type='text'
onChange={handleChange}
value={value}
size={size}
className='search-input'
action={action}
ref={inputRef}
/>;
return {value, submitted, clearButton, input, localOnSubmit, handleChange}
}
export function SearchInput({
searchStr,
onSubmit,
onChange,
onClear,
size = 'small',
placeholder = 'Search...',
icon = 'search',
inputRef = null,
...props
}) {
// A Semantic <Input> with a Clear button as the action.
let {input, localOnSubmit} = useClearableInput(searchStr, onChange, onClear, onSubmit, size, placeholder, icon, null, inputRef);
return <Form onSubmit={localOnSubmit} {...props} className='search-container'>
{input}
</Form>
}
export function SearchResultsInput({
searchStr,
onSubmit,
onClear = null,
onChange = null,
size = 'small',
placeholder = 'Search...',
icon = 'search',
action,
actionIcon,
clearable = false,
clearDisabled = null,
results = undefined,
handleResultSelect = null,
resultRenderer = undefined,
loading = false,
inputRef = null,
...props
}) {
// A Semantic <Search> input with a Clear button.
let {
value,
clearButton,
localOnSubmit,
handleChange,
} = useClearableInput(searchStr, onChange, onClear, onSubmit, size, placeholder, icon, clearDisabled);
// Show a "Loading" message rather than "No results" while results are pending.
const loadingResults = {'loading': {name: 'Loading', results: [{title: 'Results are pending...'}]}};
const localHandleResultSelect = (e, data) => {
if (e) {
e.preventDefault();
}
if (handleResultSelect) {
console.debug(`Selected result`, data);
handleResultSelect(data);
} else {
console.error('No handleResultSelect defined!');
}
}
return <Form onSubmit={localOnSubmit} {...props} className='search-container'>
<Search category
input={{fluid: true, icon: icon, ref: inputRef}}
placeholder={placeholder}
type='text'
onSearchChange={handleChange}
onResultSelect={localHandleResultSelect}
value={value}
size={size}
results={_.isEmpty(results) ? loadingResults : results}
resultRenderer={resultRenderer}
className='search-input'
loading={loading}
/>
{clearable === true && <div style={{marginLeft: '1em'}}>{clearButton}</div>}
</Form>
}
export function WROLModeMessage({content}) {
const wrolModeEnabled = useWROLMode();
if (wrolModeEnabled) {
return <Message icon='lock' header='WROL Mode Enabled' content={content}/>
}
return null;
}
export function DownloadWindowMessage() {
const {status} = React.useContext(StatusContext);
const downloads = status ? status.downloads : null;
if (downloads && downloads.outside_download_window) {
return <Message icon='clock outline' header='Outside Download Window'
content='Downloads are paused because the current time is outside the configured download window.'/>
}
return null;
}
export function CookiesUnlockModal({open, onClose, onSuccess}) {
const [password, setPassword] = useState('');
const [submitting, setSubmitting] = useState(false);
const passwordRef = React.useRef(null);
useEffect(() => {
if (open) {
const timer = setTimeout(() => {
if (passwordRef.current) {
passwordRef.current.focus();
}
}, 100);
return () => clearTimeout(timer);
}
}, [open]);
const handleUnlock = async () => {
setSubmitting(true);
const result = await unlockCookies(password);
setSubmitting(false);
if (result.success) {
setPassword('');
if (onSuccess) onSuccess();
onClose();
}
};
return <Modal open={open} onClose={onClose} size='tiny'>
<Modal.Header>Unlock Cookies</Modal.Header>
<Modal.Content>
<Form>
<Form.Input
input={{ref: passwordRef}}
label='Password'
type='password'
placeholder='Enter your encryption password'
value={password}
onChange={(e) => setPassword(e.target.value)}
onKeyPress={(e) => e.key === 'Enter' && handleUnlock()}
/>
</Form>
</Modal.Content>
<Modal.Actions>
<Button onClick={onClose}>Cancel</Button>
<Button
color='green'
onClick={handleUnlock}
loading={submitting}
disabled={!password || submitting}
>
<SIcon name='unlock'/> Unlock
</Button>
</Modal.Actions>
</Modal>;
}
export function CookiesLockedMessage() {
const {settings} = React.useContext(SettingsContext);
const {status} = React.useContext(StatusContext);
const flags = status?.flags || {};
const [modalOpen, setModalOpen] = useState(false);
if (!flags.cookies_exist || flags.cookies_unlocked || settings?.wrol_mode) {
return null;
}
return <>
<Message warning icon>
<SIcon name='lock'/>
<Message.Content>
<Message.Header>Cookies Locked</Message.Header>
You have encrypted cookies stored, but they are currently locked.
<a style={{marginLeft: '0.5em', cursor: 'pointer'}}
onClick={() => setModalOpen(true)}>
<SIcon name='unlock'/> Unlock Cookies
</a>
</Message.Content>
</Message>
<CookiesUnlockModal open={modalOpen} onClose={() => setModalOpen(false)}/>
</>;
}
// Thanks https://www.npmjs.com/package/text-ellipsis
export function textEllipsis(str, maxLength = 100, {side = "end", ellipsis = "..."} = {}) {
if (str && str.length > maxLength) {
switch (side) {
case "start":
return ellipsis + str.slice(-(maxLength - ellipsis.length));
case "end":
default:
return str.slice(0, maxLength - ellipsis.length) + ellipsis;
}
}
return str;
}
export function TabLinks({links}) {
return <Menu tabular>
{links.map((link) => <NavLink
to={link.to}
style={{padding: '1em'}}
key={link.to}
end={link.end === true ? true : null}
className={({isActive}) => {
const active = link.isActive ? link.isActive() : isActive;
return active ? 'item active' : 'item';
}}
>
{link.text}
</NavLink>)}
</Menu>
}
export function PageContainer(props) {
return <>
<Media at='mobile'>
<Container style={{marginTop: '1em', padding: 0}}>
{props.children}
</Container>
</Media>
<Media greaterThanOrEqual='tablet'>
<Container fluid style={{marginTop: '1em', padding: '1em'}}>
{props.children}
</Container>
</Media>
</>;
}
export function CardGroupCentered(props) {
return <div style={{marginTop: '1em'}}>
<Media at='mobile'>
<Card.Group centered>
{props.children}
</Card.Group>
</Media>
<Media greaterThanOrEqual='tablet'>
<Card.Group>
{props.children}
</Card.Group>
</Media>
</div>
}
/**
* Resolve a filename-only path to a full relative path using the file's directory.
* Paths in FileGroup.data are stored as filenames only for performance (fast moves/renames).
* This function resolves them to full relative paths suitable for /media/ URLs.
*
* @param {string} path - The path to resolve (may be filename-only or already a full path)
* @param {string} directory - The directory to prepend if path is filename-only
* @returns {string|null} - The resolved path, or null if path is falsy
*/
export function resolveDataPath(path, directory) {
if (!path) return null;
if (path.includes('/')) return path; // Already a full relative path
return directory ? `${directory}/${path}` : path;
}
export function findPosterPath(file) {
if (!file) {
return;
}
const {files, poster_path, cover_path, screenshot_path, video, directory} = file;
if (poster_path) {
return poster_path;
}
if (cover_path) {
return cover_path;
}
if (screenshot_path) {
return screenshot_path;
}
// video.poster_path is already a full relative path (from Video.__json__)
if (video && video['poster_path']) {
return video['poster_path'];
}
// data paths are filename-only, need to resolve with directory
if (file['data'] && file['data']['cover_path']) {
// Ebook.
return resolveDataPath(file['data']['cover_path'], directory);
}
if (file['data'] && file['data']['poster_path']) {
// PDF or Video (cached).
return resolveDataPath(file['data']['poster_path'], directory);
}
if (file['data'] && file['data']['screenshot_path']) {
// Archive.
return resolveDataPath(file['data']['screenshot_path'], directory);
}
// files[].path is already resolved by my_files() on the backend
if (!_.isEmpty(files)) {
for (let i = 0; i < files.length; i++) {
const file = files[i];
if (file['mimetype'] && file['mimetype'].startsWith('image/')) {
// Found an image file, use that as the poster.
return file['path'];
}
}
}
}
export function CardPoster({to, file}) {
const {s} = useContext(ThemeContext);
// Used to center posters in CardIcon.
const style = {display: 'flex', justifyContent: 'center', ...s['style']};
const navigate = useNavigate();
const cardTagIcon = <div className="ui green left corner label">
<i aria-hidden="true" className="tag icon"></i>
</div>;
let imageLabel = !_.isEmpty(file.tags) ? cardTagIcon : null;
let posterPath = findPosterPath(file);
if (posterPath) {
// FileGroup has a poster (screenshot/thumbnail) file.
posterPath = `/media/${encodeMediaPath(posterPath)}`;
const image = <>
{/* Replicate <Image label/> but with maxHeight applied to image */}
{imageLabel}
<img alt='poster' src={posterPath} style={{maxHeight: '163px', maxWidth: '290px', width: 'auto'}}/>
</>;
if (to) {
// Link within this App.
return <Link to={to} style={style}>
{image}
</Link>
} else {
// Preview the file.
return <div style={style}>
<PreviewLink file={file}>
{image}
</PreviewLink>
</div>
}
} else {
// FileGroup has no poster.
if (!to || (to.startsWith('/media/') || to.startsWith('/download/'))) {
// "to" is a downloadable file outside the app, preview the file.
return <PreviewLink file={file}>
<ThemedCard.Icon>
{imageLabel}
<FileIcon file={file}/>
</ThemedCard.Icon>
</PreviewLink>
} else if (!posterPath && to) {
// Link to the full page in this App.
return <Link to={to}>
<ThemedCard.Icon onClick={() => navigate(to)}>
{imageLabel}
<FileIcon file={file}/>
</ThemedCard.Icon>
</Link>
}
}
}
export function InfoPopup({
icon = 'info circle',
size = null,
content,
position = 'left center',
iconSize = null,
header = '',
iconStyle = { margin: '0.5em'},
...props
}) {
const trigger = <Icon link name={icon} size={iconSize} style={iconStyle}/>;
return <Popup
content={content}
size={size}
position={position}
header={header || null}
trigger={trigger}
hoverable={true}
{...props}
/>
}
export function InfoHeader({
icon,
headerSize = 'h2',
iconSize,
headerContent,
popupContent,
popupPosition = null,
popupProps = {},
for_ = null,
required = false,
...props
}) {
return <div className='inline-header' {...props}>
<label htmlFor={for_}>
<Header as={headerSize}>{headerContent} {required && <RequiredAsterisk/>}</Header>
</label>
<span>
<InfoPopup content={popupContent} iconSize={iconSize} icon={icon} position={popupPosition} {...popupProps}/>
</span>
</div>
}
export function HelpModal({
icon = 'help circle',
iconSize = null,
iconStyle = {margin: '0.5em'},
helpPath,
title = null,
modalSize = 'fullscreen',
}) {
const [open, setOpen] = useState(false);
const src = `${HELP_VIEWER_URI}${helpPath}`;
const style = {position: 'relative', height: '75vh', width: '100%', border: 'none'};
return <>
<Icon link name={icon} size={iconSize} style={iconStyle} onClick={() => setOpen(true)}/>
<Modal open={open} onClose={() => setOpen(false)} size={modalSize} closeIcon>
{title && <Modal.Header>{title}</Modal.Header>}
<Modal.Content>
<IframeViewer title={title} src={src} style={style}/>
</Modal.Content>
</Modal>
</>
}
export function HelpHeader({
icon,
headerSize = 'h2',
iconSize,
headerContent,
helpPath,
helpTitle,
helpModalProps = {},
for_ = null,
required = false,
...props
}) {
return <div className='inline-header' {...props}>
<label htmlFor={for_}>
<Header as={headerSize}>{headerContent} {required && <RequiredAsterisk/>}</Header>
</label>
<span>
<HelpModal helpPath={helpPath} iconSize={iconSize} icon={icon} title={helpTitle} {...helpModalProps}/>
</span>
</div>
}
export function HotspotToggle() {
let {on, setHotspot} = useHotspot();
const disabled = on === null;
return <div style={{margin: '0.5em'}}>
<Toggle
label='WiFi Hotspot'
disabled={disabled}
checked={on === true}
onChange={checked => setHotspot(checked)}
/>
{disabled && <InfoPopup content='Hotspot is not supported on this server'/>}
</div>;
}
export function ThrottleToggle() {
let {on, setThrottle} = useThrottle();
const disabled = on === null;
return <div style={{margin: '0.5em'}}>
<Toggle
label='CPU Power-save'
disabled={disabled}
checked={on === true}
onChange={checked => setThrottle(checked)}
/>
{disabled && <InfoPopup content='CPU Power-save is not supported on this server'/>}
</div>;
}
export function BluetoothToggle() {
let {on, setBluetooth} = useBluetooth();
const disabled = on === null;
return <div style={{margin: '0.5em'}}>
<Toggle
label='Bluetooth'
disabled={disabled}
checked={on === true}
onChange={checked => setBluetooth(checked)}
/>
{disabled && <InfoPopup content='Bluetooth is not supported on this server'/>}
</div>;
}
export function Toggle({label, checked, disabled, onChange, icon, popupContent = null, info = null}) {
// Custom toggle because Semantic UI does not handle inverted labels correctly.
const {t, inverted} = useContext(ThemeContext);
let style = {marginLeft: '1em'};
if (t && t.style) {
style = {...t.style, ...style};
}
disabled = disabled === true ? 'disabled' : '';
let inputClassName = `${disabled} ${inverted}`;
let sliderClassName = `${disabled} ${inverted} slider`;
if (inverted) {
style['color'] = '#dddddd';
}
if (disabled && inverted) {
style['color'] = '#888888';
}
let onMouseUp = () => {
};
if (onChange) {
onMouseUp = (e) => {
if (disabled) {
return;
}
e.preventDefault();
if (onChange) {
onChange(!checked);
}
}
}
if (icon) {
icon = <Icon name={icon}/>
}
const body = <span>
<div className='toggle' onMouseUp={onMouseUp}>
<input type="checkbox" className={inputClassName} checked={checked} onChange={onMouseUp}
data-testid='toggle'/>
<span className={sliderClassName}></span>
</div>
<span style={style} data-testid='toggle-label'>
{icon}
{label}
{info && <InfoPopup content={info}/>}
</span>
</span>
if (popupContent) {
return <Popup on='hover' trigger={body} content={popupContent}/>
}
return body
}
export function DisableDownloadsToggle() {
const [pending, setPending] = React.useState(false);
const {status, fetchStatus} = React.useContext(StatusContext);
const {downloads} = status ? status : {downloads: null};
const wrolModeEnabled = useWROLMode();
const setDownloads = async (enable) => {
setPending(true);
if (enable) {
await startDownloads();
} else {
await killDownloads();
}
await fetchStatus();
setPending(false);
}
const on = downloads && downloads['disabled'] === false && downloads['stopped'] === false;
return <Form>
<Toggle
label={on === true ? 'Downloading Enabled' : 'Downloading Disabled'}
disabled={wrolModeEnabled || pending || downloads === null}
checked={on === true}
onChange={setDownloads}
/>
</Form>;
}
export function emptyToNull(obj) {
const keys = Object.keys(obj);
for (let i = 0; i < keys.length; i++) {
const key = keys[i];
if (obj[key] === '') {
obj[key] = null;
}
}
return obj;
}
export function mimetypeColor(mimetype, path = '') {
if (!mimetype) {
return 'grey';
}
try {
const lowerPath = path.toLowerCase();
if (mimetype === 'application/pdf') {
return 'red'
} else if (mimetype.startsWith('video/')) {
return 'blue'
} else if (mimetype.startsWith('image/')) {
return 'pink'
} else if (mimetype.startsWith('text/html')) {
return 'green'
} else if (mimetype.startsWith('application/epub')) {
return 'yellow'
} else if (mimetype.includes('cbz') || mimetype.includes('cbr')
|| mimetype.includes('comicbook')
|| lowerPath.endsWith('.cbz') || lowerPath.endsWith('.cbr')
|| lowerPath.endsWith('.cbt') || lowerPath.endsWith('.cb7')) {
return 'yellow'
} else if (mimetype.startsWith('audio/')) {
return 'violet'
} else if (isZipMimetype(mimetype)) {
return 'purple'
}
} catch (e) {
console.error(e);
console.error('Unable to choose mimetype color');
}
return 'grey'
}
export function isZipMimetype(mimetype) {
return mimetype.startsWith('application/zip') || mimetype.startsWith('application/zlib') || mimetype.startsWith('application/x-7z-compressed') || mimetype.startsWith('application/x-bzip2') || mimetype.startsWith('application/x-xz') || mimetype.startsWith('application/gzip') || mimetype.startsWith('application/x-rar');
}
export function isSupportedArchive(mimetype, lowerPath) {
// Zip is always supported.
if (mimetype.startsWith('application/zip') || mimetype.startsWith('application/zlib')) return true;
if (mimetype.startsWith('application/x-tar')) return true;
// Suffix-based detection for tar variants whose mimetype may be the compression type.
if (lowerPath.endsWith('.tar') || lowerPath.endsWith('.tar.gz') || lowerPath.endsWith('.tgz') || lowerPath.endsWith('.tar.bz2') || lowerPath.endsWith('.tar.xz')) return true;
return false;
}
export function mimetypeIconName(mimetype, lowerPath = '') {
if (mimetype) {
if (mimetype.startsWith('text/html') || mimetype.startsWith('application/json') || mimetype.startsWith('text/yaml') || mimetype.startsWith('text/xml')) {
return 'file code';
} else if (mimetype.startsWith('application/pdf')) {
return 'file pdf';
} else if (mimetype.startsWith('text/plain')) {
return 'file text';
} else if (mimetype.startsWith('image/')) {
return 'image';
} else if (mimetype.startsWith('video/')) {
return 'film';
} else if (mimetype.startsWith('message/rfc822')) {
return 'mail';
} else if (isZipMimetype(mimetype)) {
return 'file archive';
} else if (mimetype.startsWith('application/x-iso9660-image') || mimetype.startsWith('application/x-raw-disk-image') || mimetype.startsWith('application/x-cd-image')) {
return 'dot circle';
} else if (mimetype.startsWith('application/epub') || mimetype.startsWith('application/x-mobipocket-ebook') || mimetype.startsWith('application/vnd.amazon.mobi8-ebook')
|| mimetype.startsWith('application/vnd.comicbook') || mimetype.startsWith('application/x-cbz') || mimetype.startsWith('application/x-cbr')) {
return 'book';
} else if (mimetype.startsWith('text/vtt') || mimetype.startsWith('text/srt')) {
return 'closed captioning';
} else if (mimetype.startsWith('application/x-openscad') || mimetype.startsWith('model/stl')) {
return 'cube';
} else if (mimetype.startsWith('application/x-dosexec') || mimetype.startsWith('application/x-msi') || mimetype.startsWith('application/vnd.microsoft.portable-executable')) {
return 'windows';
} else if (mimetype.startsWith('audio/')) {
return 'file audio';
} else if (mimetype.startsWith('application/vnd.openxmlformats-officedocument.wordprocessingml.document')) {
return 'file word';
} else if (mimetype.startsWith('application/x-x509-ca-cert')) {
return 'certificate';
} else if (mimetype.startsWith('application/x-pie-executable')) {
return 'linux';
} else if (mimetype.startsWith('application/octet-stream')) {
if (lowerPath.endsWith('.mp3')) {
return 'file audio';
} else if (lowerPath.endsWith('.stl')) {
return 'cube';
} else if (lowerPath.endsWith('.blend')) {
return 'cube';
} else if (lowerPath.endsWith('.dmg')) {
return 'apple';
} else if (lowerPath.endsWith('.azw3')) {
return 'book';
} else if (lowerPath.endsWith('.exe')) {
return 'windows';
}
} else if (mimetype.startsWith('application/vnd.openxmlformats-officedocument.spreadsheetml.') || mimetype.startsWith('application/vnd.ms-excel') || mimetype.startsWith('application/vnd.oasis.opendocument.spreadsheet')) {
return 'file excel'
} else if (mimetype.startsWith('application/vnd.openxmlformats-officedocument.wordprocessingml.') || mimetype.startsWith('application/msword') || mimetype.startsWith('application/vnd.oasis.opendocument.text')) {
return 'file word'
} else if (mimetype.startsWith('application/vnd.openxmlformats-officedocument.presentationml.') || mimetype.startsWith('application/vnd.ms-powerpoint') || mimetype.startsWith('application/vnd.oasis.opendocument.presentation')) {
return 'file powerpoint'
} else if (mimetype.startsWith('font/') || mimetype.startsWith('application/font-sfnt') || mimetype.startsWith('application/vnd.ms-fontobject')) {
return 'font'
}
}
if (lowerPath.endsWith('.pem')) {
return 'certificate';
}
return 'file';
}
const SUFFIX_ICON_MAP = {
// Code
html: 'file code', htm: 'file code', json: 'file code', xml: 'file code',
yaml: 'file code', yml: 'file code', js: 'file code', css: 'file code',
py: 'file code', sh: 'file code', c: 'file code', cpp: 'file code',
h: 'file code', java: 'file code', rs: 'file code', go: 'file code',
ts: 'file code', tsx: 'file code', jsx: 'file code',
// Documents
pdf: 'file pdf',
txt: 'file text', md: 'file text', csv: 'file text', log: 'file text', rst: 'file text',
doc: 'file word', docx: 'file word', odt: 'file word',
xls: 'file excel', xlsx: 'file excel', ods: 'file excel',
ppt: 'file powerpoint', pptx: 'file powerpoint', odp: 'file powerpoint',
// Media
jpg: 'image', jpeg: 'image', png: 'image', gif: 'image', svg: 'image',
bmp: 'image', webp: 'image', ico: 'image', tiff: 'image',
mp4: 'film', mkv: 'film', avi: 'film', mov: 'film', wmv: 'film', webm: 'film', flv: 'film',
mp3: 'file audio', wav: 'file audio', flac: 'file audio', ogg: 'file audio',
aac: 'file audio', wma: 'file audio', m4a: 'file audio',
vtt: 'closed captioning', srt: 'closed captioning',
// Archives
zip: 'file archive', tar: 'file archive', gz: 'file archive', bz2: 'file archive',
xz: 'file archive', '7z': 'file archive', rar: 'file archive', tgz: 'file archive',
// Books
epub: 'book', mobi: 'book', azw3: 'book',
// 3D
stl: 'cube', blend: 'cube', scad: 'cube',
// Platform
exe: 'windows', msi: 'windows',
dmg: 'apple',
iso: 'dot circle', img: 'dot circle',
// Certs
pem: 'certificate', crt: 'certificate', cer: 'certificate',
// Email
eml: 'mail',
};
export function fileSuffixIconName(filename) {
const dot = filename.lastIndexOf('.');
if (dot >= 0) {
const ext = filename.substring(dot + 1).toLowerCase();
return SUFFIX_ICON_MAP[ext] || 'file';
}
return 'file';
}
export function FileIcon({file, disabled = true, size = 'huge', ...props}) {
// Default to a grey file icon.
const {mimetype, path, primary_path} = file;
// `file` may be a file_group or a file.
const lowerPath = primary_path ? primary_path.toLocaleString() : path.toLowerCase();
props['name'] = mimetypeIconName(mimetype, lowerPath);
props['color'] = mimetypeColor(mimetype);
return <Icon disabled={disabled} size={size} {...props}/>
}
export function LoadStatistic({label, value, cores, ...props}) {
const quarter = cores / 4;
if (cores && value >= (quarter * 3)) {
props['color'] = 'red';
} else if (cores && value >= (quarter * 2)) {
props['color'] = 'orange';
}
return <Statistic
label={label}
value={value ? parseFloat(value).toFixed(1) : '?'}
{...props}/>;
}
export function DarkModeToggle() {
const {savedTheme, cycleSavedTheme} = useContext(ThemeContext);
let iconName = 'lightbulb outline';
if (savedTheme === darkTheme) {
iconName = 'moon';
} else if (savedTheme === lightTheme) {
iconName = 'sun';
}
return <Icon
name={iconName}
onClick={cycleSavedTheme}
style={{cursor: 'pointer', marginRight: '0.8em'}}
/>
}
export function UnsupportedModal(header, message, icon) {
const [open, setOpen] = useState(false);
const onOpen = () => setOpen(true);
const onClose = () => setOpen(false);
const modal = <Modal basic closeIcon
onOpen={onOpen}
onClose={onClose}
open={open}
>
<Header>
<Icon name={icon || 'exclamation triangle'}/>
{header || 'Unsupported'}
</Header>
<Modal.Content>
<Modal.Description>
{message}
</Modal.Description>
</Modal.Content>
<Modal.Actions>
<Button basic inverted onClick={onClose}>Ok</Button>
</Modal.Actions>
</Modal>;
return {modal, doClose: onClose, doOpen: onOpen};
}
export function HotspotStatusIcon() {
const {on, inUse, setHotspot, dockerized, hotspotSsid} = useHotspot();
const {modal: unsupportedModal, doOpen: openUnsupportedModal} =
UnsupportedModal('Unsupported', 'You cannot toggle the hotspot on this machine.');
const [disableHotspotOpen, setDisableHotspotOpen] = React.useState(false);
const [inUseOpen, setInUseOpen] = React.useState(false);
const handleConfirmDisable = (e) => {
if (e) {
e.preventDefault()
}
setDisableHotspotOpen(false);
setHotspot(false);
}
const handleConfirmInUse = (e) => {
if (e) {
e.preventDefault()
}
setInUseOpen(false);
setHotspot(true);
}
if (inUse === true) {
const content = hotspotSsid ? `Wifi device is in use for ${hotspotSsid}. Disconnect and enable hotspot?`
: 'Wifi device is in use. Disconnect and enable hotspot?'
return <>
<Confirm open={inUseOpen}
onCancel={() => setInUseOpen(false)}
onClose={() => setInUseOpen(false)}
onConfirm={handleConfirmInUse}
header='Wifi is in-use'
content={content}
confirmButton='Enable Hotspot'
/>
<a href='#' onClick={() => setInUseOpen(true)}>
<IconGroup size='large'>
<Icon name='wifi' disabled/>
<Icon corner name='exclamation'/>
</IconGroup>
</a>
</>
} else if (dockerized === false && on === true) {
return <>
<Confirm
open={disableHotspotOpen}
onCancel={() => setDisableHotspotOpen(false)}
onClose={() => setDisableHotspotOpen(false)}
onConfirm={handleConfirmDisable}
header='Disable the hotspot'
content='You will be disconnected when using the hotspot. Are you sure?'
confirmButton='Disable'
/>
<a href='#' onClick={() => setDisableHotspotOpen(true)}>
<IconGroup size='large'>
<Icon name='wifi' disabled={on !== true}/>
{on === false && <Icon corner name='x'/>}
{on === null && <Icon corner name='question'/>}
</IconGroup>
</a>
</>
} else if (dockerized === false && on === false) {
return <a href='#' onClick={() => setHotspot(true)}>
<IconGroup size='large'>
<Icon name='wifi' disabled/>
<Icon corner name='x'/>
</IconGroup>
</a>
}
// Hotspot is not available, or, status has not yet been fetched.
return <>
<a href='#' onClick={openUnsupportedModal}>
<IconGroup size='large'>
<Icon name='wifi' disabled/>
<Icon corner name='question'/>
</IconGroup>
</a>
{unsupportedModal}
</>
}
export function useMediaSession(title, artist, artworkUrl) {
useEffect(() => {
if ('mediaSession' in navigator && title) {
const artwork = [];
if (artworkUrl) {
artwork.push({src: artworkUrl, type: 'image/jpeg'});
}
navigator.mediaSession.metadata = new MediaMetadata({
title: title,
artist: artist || '',
artwork: artwork,
});
}
}, [title, artist, artworkUrl]);
}
export function useTitle(title) {
const documentDefined = typeof document !== 'undefined';
const originalTitle = React.useRef(documentDefined ? document.title : null);
const name = NAME ? `${NAME} WROLPi` : `WROLPi`;
useEffect(() => {
if (!documentDefined) {
return;
}
const newTitle = `${title} - ${name}`
if (title && document.title !== newTitle) {
document.title = newTitle;
}
return () => {
document.title = originalTitle.current;
}
}, [title]);
}
export function DirectorySearch({onSelect, value, disabled, required, ...props}) {
const {
directoryName,
setDirectoryName,
directories,
channelDirectories,
domainDirectories,
isDir,
loading,
} = useSearchDirectories(value);
const [results, setResults] = useState({});
useEffect(() => {
if (directories && directories.length >= 0) {
const newDirectory = isDir ? {} : {
newDirectory: {
name: 'New Directory',
results: [{title: directoryName}],
}
};
const newResults = {
...newDirectory,
directories: {
name: 'Directories',
results: directories.map(i => {
return {title: i['path']}
}),
},
channel_directories: {
name: 'Channels',
results: channelDirectories.map(i => {
return {title: i['path'], description: i['name']};
}),
},
domain_directories: {
name: 'Domains',
results: domainDirectories.map(i => {
return {title: i['path'], description: i['domain']};
}),
},
};
setResults(newResults);
}
}, [
JSON.stringify(directories),
JSON.stringify(channelDirectories),
JSON.stringify(domainDirectories),
loading,
]);
const handleSearchChange = (e, data) => {
if (e) {
e.preventDefault();
}
setDirectoryName(data.value);
}
const handleResultSelect = (e, data) => {
if (e) {
e.preventDefault();
}
setDirectoryName(data.result.title);
// title is the relative path.
if (onSelect) {
onSelect(data.result.title);
}
}
const handleBlur = (e) => {
// When user leaves the field, commit the typed value to the form
if (onSelect && directoryName !== value) {
onSelect(directoryName);
}
}
return <Search category
placeholder='Search directory names...'
onSearchChange={handleSearchChange}
onResultSelect={handleResultSelect}
onBlur={handleBlur}
loading={loading}
value={directoryName}
results={results}
disabled={disabled}
{...props}
/>
}
export const BackButton = ({...props}) => {
const navigate = useNavigate();
return <Button icon='arrow left' content='Back' onClick={() => navigate(-1)} {...props}/>;
}
export const filterToMimetypes = (filter) => {
const zipMimetypes = ['application/zip', 'application/zlib', 'application/x-bzip2', 'application/x-xz', 'application/x-bzip', 'application/x-bzip2', 'application/gzip', 'application/vnd.rar', 'application/x-tar', 'application/x-7z-compressed'];
const softwareMimetypes = [...zipMimetypes, 'application/x-iso9660-image', 'application/x-executable', 'application/x-dosexec'];
if (filter === 'video') {
return ['video'];
} else if (filter === 'archive') {
return ['text/html'];
} else if (filter === 'pdf') {
return ['application/pdf'];
} else if (filter === 'audio') {
return ['audio'];
} else if (filter === 'ebook') {
return ['application/epub+zip', 'application/x-mobipocket-ebook'];
} else if (filter === 'doc') {
return ['application/epub+zip', 'application/x-mobipocket-ebook', 'application/pdf',
'application/msword', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
'application/vnd.oasis.opendocument.text', 'application/x-cbz', 'application/x-cbr'];
} else if (filter === 'image') {
return ['image'];
} else if (filter === 'zip') {
return zipMimetypes;
} else if (filter === 'model') {
return ['application/x-openscad', 'model/stl', 'application/sla', 'model/obj'];
} else if (filter === 'software') {
return softwareMimetypes;
}
}
export const toLocaleString = (num, locale = 'en-US') => {
return num.toLocaleString(locale);
}
function luma(color) {
let rgb = (typeof color === 'string') ? hexToRGBArray(color) : color;
return (0.2126 * rgb[0]) + (0.7152 * rgb[1]) + (0.0722 * rgb[2]); // SMPTE C, Rec. 709 weightings
}
function hexToRGBArray(color) {
if (color.length === 7) {
color = color.slice(1);
}
if (color.length !== 6) {
console.error('Invalid hex color: ' + color);
return;
}
let rgb = [];
for (let i = 0; i <= 2; i++) rgb[i] = parseInt(color.substr(i * 2, 2), 16);
return rgb;
}
export function contrastingColor(color) {
return (luma(color) >= 120) ? '#000000' : '#dddddd';
}
export const encodeMediaPath = (path) => {
// Replace % first to avoid replacing the other replacements.
path = path.replaceAll('%', '%25');
path = path.replaceAll('&', '%26');
path = path.replaceAll('=', '%3d');
path = path.replaceAll('#', '%23');
path = path.replaceAll(' ', '%20');
return path
}
export function SortButton({sorts = []}) {
const {sort, setSort} = useSearchOrder();
if (!sorts || (sorts && sorts.length === 0)) {
console.error('No sorts have been defined!');
}
const [localSort, setLocalSort] = useState(sort ? sort.replaceAll(/^-/g, '') : null);
const [desc, setDesc] = useState(sort ? sort.startsWith('-') : true);
const [open, setOpen] = useState(false);
// Remove the - from the front of the query sort, it will be added when toggling direction.
const sortKey = localSort ? localSort.replaceAll(/^-/g, '') : sorts[0]['value'];
const selectedSort = sorts.find(i => i['value'] === sortKey);
useEffect(() => {
if (localSort) {
const newSort = desc ? `-${localSort}` : localSort;
console.debug(`Setting new sort: ${newSort}`)
setSort(newSort);
}
}, [localSort, desc]);
const handleSortButton = (o) => {
setLocalSort(o);
setOpen(false);
}
const toggleDesc = () => {
setDesc(!desc);
if (!localSort) {
// No sort in URL, use the first.
setLocalSort(sorts[0]['value']);
}
setOpen(false);
}
let sortFields;
if (sorts && sorts.length) {
sortFields = sorts.map((i) => {
return <Button key={i['value']} onClick={() => handleSortButton(i['value'])}>{i['text']}</Button>
})
}
return <>
<Modal closeIcon
open={open}
onClose={() => setOpen(false)}
>
<Modal.Header>Sort By</Modal.Header>
<Modal.Content>
{sortFields}
</Modal.Content>
</Modal>
<ButtonGroup icon>
<Button icon={desc ? 'sort down' : 'sort up'} onClick={() => toggleDesc()}/>
<Button content={selectedSort['short'] || selectedSort['text']} onClick={() => setOpen(true)}/>
</ButtonGroup>
</>
}
export function TagIcon() {
return <Label circular color='green' style={{padding: '0.5em', marginRight: '0.5em'}}>
<Icon name='tag' style={{margin: 0}}/>
</Label>
}
export function normalizeEstimate(estimate) {
if (Number.isInteger(estimate)) {
return estimate > 999 ? '>999' : estimate.toString();
}
return '?';
}
export function useAPIButton(
color = 'violet',
size = 'medium',
floated,
onClick,
disabled,
confirmContent,
confirmButton,
confirmHeader,
themed = true,
obeyWROLMode = false,
icon = null,
type = 'button',
id = null,
props
) {
props = props || {};
const ref = React.useRef();
const [confirmOpen, setConfirmOpen] = React.useState(false);
const [loading, setLoading] = React.useState(false);
const [animation, setAnimation] = React.useState('jiggle');
const [animationVisible, setAnimationVisible] = React.useState(true);
const [showSuccess, setShowSuccess] = React.useState(false);
const [showFailure, setShowFailure] = React.useState(false);
const wrolModeEnabled = useWROLMode();
// Disable when API call is pending, or button is disabled.
disabled = loading || disabled;
// Disable when WROL Mode is enabled, otherwise normal disabled.
disabled = obeyWROLMode ? wrolModeEnabled || disabled : disabled;
const reset = () => {
setShowSuccess(false);
setShowFailure(false);
};
const setSuccess = () => {
setShowSuccess(true);
setAnimation('pulse');
setAnimationVisible(!animationVisible);
setTimeout(reset, 2000);
}
const setFailure = () => {
setShowFailure(true);
setAnimation('shake');
setAnimationVisible(!animationVisible);
setTimeout(reset, 2000);
}
const handleAPICall = async () => {
// Handle when user clicks button, or clicks confirm.
setLoading(true);
try {
await onClick();
setSuccess();
} catch (e) {
console.error(e);
setFailure();
} finally {
setLoading(false);
}
}
const localOnClick = async (e) => {
if (e) {
e.preventDefault();
}
if (confirmContent) {
// Clicking button opens confirm.
setConfirmOpen(true);
} else if (onClick) {
// No <Confirm/> send the API request.
await handleAPICall();
} else {
throw Error('No onClick defined!');
}
}
const localOnConfirm = async () => {
// User clicked the "OK" button in the <Confirm/>.
setConfirmOpen(false);
if (onClick) {
await handleAPICall();
}
}
// Create button with or without theme. Pass all props to the <Button/> (except props.children).
const buttonArgs = {
color, onClick: localOnClick, disabled, loading, size, floated, type,
...props
};
if (id) {
buttonArgs['id'] = id;
}
let buttonContent = props.children || null;
if (icon) {
// Send Icon as Button properties.
buttonContent = null;
buttonArgs['icon'] = showSuccess ? 'check' : showFailure ? 'close' : icon;
} else if (showSuccess || showFailure) {
// Show ✔ or ✖ overtop the contents after API call has completed.
buttonContent = <>
<Icon style={{position: 'absolute'}} name={showSuccess ? 'check' : 'close'}/>
{/* Keep contents to avoid resizing button */}
<div style={{opacity: 0}}>{buttonContent}</div>
</>
}
let button = themed ?
<Button ref={ref} {...buttonArgs}>{buttonContent}</Button>
: <SButton ref={ref} {...buttonArgs}>{buttonContent}</SButton>;
// Wrap button in <Transition/> to show success or failure animations.
button = <Transition animation={animation} duration={500} visible={animationVisible}>
{button}
</Transition>;
if (confirmContent) {
// Wrap button with <Confirm/>
button = <>
{button}
<Confirm open={confirmOpen}
content={confirmContent}
onClose={() => setConfirmOpen(false)}
onCancel={() => setConfirmOpen(false)}
onConfirm={localOnConfirm}
confirmButton={confirmButton}
header={confirmHeader}
/>
</>
}
return {button, ref}
}
export function APIButton({
color,
size,
floated,
onClick,
disabled,
confirmContent,
confirmButton,
confirmHeader,
themed,
obeyWROLMode,
icon,
type = 'button',
id = null,
...props
}) {
const {button} = useAPIButton(
color,
size,
floated,
onClick,
disabled,
confirmContent,
confirmButton,
confirmHeader,
themed,
obeyWROLMode,
icon,
type,
id,
props
);
return button;
}
export const useMessageDismissal = (messageName) => {
const [dismissed, setDismissed] = useLocalStorage('dismissed_hints', {});
return {
dismissed: dismissed[messageName] || false, // true or false
setDismissed: (value) => setDismissed({...dismissed, [messageName]: !!value}), // force true/false
clearAll: () => setDismissed({}),
}
}
export function InfoMessage({children, size = null, storageName = null, icon = 'info circle'}) {
const {dismissed, setDismissed} = useMessageDismissal(storageName);
if (dismissed) {
return <React.Fragment/>
}
return <Message info icon size={size} onDismiss={storageName ? () => setDismissed(true) : undefined}>
<SIcon name={icon}/>
<Message.Content>
{children}
</Message.Content>
</Message>
}
export function HandPointMessage({children, size = null, storageName = null}) {
const {dismissed, setDismissed} = useMessageDismissal(storageName);
if (dismissed) {
return <React.Fragment/>
}
return <Message info icon size={size} onDismiss={storageName ? () => setDismissed(true) : undefined}>
<SIcon name='hand point right'/>
<Message.Content>
{children}
</Message.Content>
</Message>
}
export function WarningMessage({children, size = null, icon = 'exclamation', storageName = null}) {
const {dismissed, setDismissed} = useMessageDismissal(storageName);
if (dismissed) {
return <React.Fragment/>
}
// Use color='yellow' because "warning" does not work.
return <Message color='yellow' icon size={size} onDismiss={storageName ? () => setDismissed(true) : undefined}>
<SIcon name={icon}/>
<Message.Content>
{children}
</Message.Content>
</Message>
}
export function ErrorMessage({children, size = null, icon = 'exclamation', storageName = null}) {
const {dismissed, setDismissed} = useMessageDismissal(storageName);
if (dismissed) {
return <React.Fragment/>
}
return <Message negative icon size={size} onDismiss={storageName ? () => setDismissed(true) : undefined}>
<SIcon name={icon}/>
<Message.Content>
{children}
</Message.Content>
</Message>
}
function levenshteinDistance(a, b) {
const matrix = [];
// Initialize the matrix
for (let i = 0; i <= b.length; i++) {
matrix[i] = [i];
}
for (let j = 0; j <= a.length; j++) {
matrix[0][j] = j;
}
// Populate the matrix
for (let i = 1; i <= b.length; i++) {
for (let j = 1; j <= a.length; j++) {
if (b.charAt(i - 1) === a.charAt(j - 1)) {
matrix[i][j] = matrix[i - 1][j - 1];
} else {
matrix[i][j] = Math.min(matrix[i - 1][j - 1], matrix[i][j - 1], matrix[i - 1][j]) + 1;
}
}
}
return matrix[b.length][a.length];
}
export function fuzzyMatch(a, b, threshold = 3) {
return levenshteinDistance(a, b) <= threshold;
}
export function useIsIgnoredDirectory(directory) {
const {settings} = React.useContext(SettingsContext);
if (!settings || _.isEmpty(settings)) {
// Settings have not yet been fetched.
return false;
}
let ignoredDirectories = settings['ignored_directories'];
if (directory.endsWith('/')) {
ignoredDirectories = ignoredDirectories.map(i => `${i}/`);
}
return ignoredDirectories.indexOf(directory) >= 0;
}
export function getParentDirectory(filePath) {
// Remove trailing slashes for consistency
const normalizedPath = filePath.endsWith('/') ? filePath.slice(0, -1) : filePath;
// Find the last occurrence of "/" and extract the substring up to it
const parentDirectory = normalizedPath.substring(0, normalizedPath.lastIndexOf('/'));
return parentDirectory;
}
export function MultilineText({text, ...props}) {
return <div {...props}>
{text.split('\n').map((line, index, array) =>
index === array.length - 1 ? line : <p key={index}>{line}</p>
)}
</div>
}
export const monthNames = [
'January',
'February',
'March',
'April',
'May',
'June',
'July',
'August',
'September',
'October',
'November',
'December',
];
export function IframeViewer({title, src, fallback, style, timeout = 5000}) {
// This function checks that an iframe can be fetched before displaying it. Otherwise, it will display the fallback
// element which should help the maintainer to fix the issue.
const [contentAvailable, setContentAvailable] = useState(false);
const [loading, setLoading] = useState(true);
const {s} = React.useContext(ThemeContext);
fallback = fallback || <pre {...s}>Frame could not load.</pre>;
useEffect(() => {
const controller = new AbortController(); // To manage fetch timeout
const timeoutId = setTimeout(() => {
controller.abort(); // Abort the fetch after 5 seconds
}, timeout);
fetch(src, {signal: controller.signal})
.then(response => {
// Only display content if it can be fetched.
setContentAvailable(response.ok);
})
.catch(() => {
setContentAvailable(false); // Handle fetch errors (including aborts)
})
.finally(() => {
setLoading(false); // Update loading state regardless of result
clearTimeout(timeoutId); // Clear the timeout
});
return () => clearTimeout(timeoutId); // Cleanup timeout on unmount
}, [src]);
// Mobile needs less height, otherwise it hides the content below the screen.
let mobileStyle = {
position: 'fixed',
height: '80%',
width: '100%',
border: 'none',
padding: 0,
backgroundColor: '#FFFFFF',
};
// Allow provided `style` to overwrite.
mobileStyle = style ? {...mobileStyle, ...style} : mobileStyle;
let tabletStyle = {...mobileStyle, height: '93%'};
tabletStyle = style ? {...tabletStyle, ...style} : tabletStyle;
const iframeMedia = <>
<Media at='mobile'>
<iframe title={title} src={src} style={mobileStyle}/>
</Media>
<Media greaterThan='mobile'>
<iframe title={title} src={src} style={tabletStyle}/>
</Media>
</>;
const dimmer = <DimmerDimmable as={Segment} dimmed={true}><Dimmer active><Loader/></Dimmer></DimmerDimmable>;
return <>
{loading ? dimmer
: contentAvailable ? iframeMedia
: fallback
}
</>
}
export function roundDigits(value, decimals = 2) {
return Number(Math.round(value + 'e' + decimals) + 'e-' + decimals);
}
export function Breadcrumbs({crumbs, size = undefined}) {
function getSection(crumb) {
const {text, link, icon} = crumb;
let contents = text;
if (link) {
contents = <Link to={link}>
{icon && <Icon name={icon}/>}
{text}
</Link>;
}
return <BreadcrumbSection>{contents}</BreadcrumbSection>
}
return <Breadcrumb size={size}>
{crumbs.map((crumb, index) => (
<React.Fragment key={index}>
{getSection(crumb)}
{index < crumbs.length - 1 && <Breadcrumb.Divider icon='right chevron'/>}
</React.Fragment>
))}
</Breadcrumb>
}
export function validURL(url) {
return !(url && !validUrlRegex.test(url));
}
export function validURLs(urls) {
if (!!!urls) {
// Invalid while empty.
return false;
}
urls = urls.split(/\r?\n/);
for (let i = 0; i < urls.length; i++) {
if (!validURL(urls[i])) {
return false;
}
}
return true;
}
export function useLocalStorage(key, initialValue, decode = JSON.parse, encode = JSON.stringify) {
// Use localstorage to store some JSON encode-able.
// Initialize state with the value from localStorage or initial value
const [value, setValue] = useState(() => {
let item;
try {
const item = window.localStorage.getItem(key);
// Parse the stored item (integer, bool, etc.). Use the initial value if empty.
return item ? decode(item) : initialValue;
} catch (error) {
console.error('useLocalStorage', key, item, initialValue);
console.error('Error reading localStorage:', error);
return initialValue;
}
});
// Save to localStorage when the value changes
useEffect(() => {
if (key === null || key === undefined) {
// key was not defined, do not add this to storage.
return
}
try {
decode(value);
window.localStorage.setItem(key, value);
} catch (error) {
window.localStorage.setItem(key, encode(value));
}
}, [key, value, encode]);
// Return the stored value and a function to update it
return [value, setValue];
}
export function useLocalStorageInt(key, initialValue) {
// Use localStorage to store an integer.
const [storedValue, setStoredValue] = useLocalStorage(key, initialValue, parseInt, (num) => num.toString());
return [storedValue, setStoredValue];
}
export function SimpleAccordion({title = 'Advanced', ...props}) {
const [active, setActive] = React.useState(false);
return <Accordion>
<AccordionTitle
active={active}
onClick={() => setActive(!active)}
>
<Icon name='dropdown'/>
{title}
</AccordionTitle>
<AccordionContent active={active}>
{props.children}
</AccordionContent>
</Accordion>
}
export function mergeDeep(target, source) {
if (_.isEmpty(source)) {
return target;
}
// Initialize the result as target
let result = Object.assign({}, target);
for (let key of Object.keys(source)) {
if (Array.isArray(source[key])) {
// source overwrites target if it is a list with values.
result[key] = source[key] || target[key];
} else if (typeof source[key] === 'object' && typeof target[key] === 'object' && source[key] !== null) {
result[key] = mergeDeep(target[key] || {}, source[key]);
} else {
result[key] = source[key] !== undefined ? source[key] : target[key];
}
}
return result;
}
export function getDistinctColor(hexColors) {
function hexToHSL(hex) {
if (!hex) {
return {h: 0, s: 0, l: 0};
}
let r = parseInt(hex.slice(1, 3), 16) / 255;
let g = parseInt(hex.slice(3, 5), 16) / 255;
let b = parseInt(hex.slice(5, 7), 16) / 255;
let cmax = Math.max(r, g, b), cmin = Math.min(r, g, b);
let delta = cmax - cmin;
let h, s, l = (cmax + cmin) / 2;
if (delta === 0) h = 0;
else if (cmax === r) h = ((g - b) / delta) % 6;
else if (cmax === g) h = (b - r) / delta + 2;
else h = (r - g) / delta + 4;
h = Math.round(h * 60);
if (h < 0) h += 360;
s = delta === 0 ? 0 : delta / (1 - Math.abs(2 * l - 1));
return {h: h, s: s, l: l};
}
function hslToHex(h, s, l) {
l /= 100;
const a = s * Math.min(l, 1 - l) / 100;
const f = n => {
const k = (n + h / 30) % 12;
const color = l - a * Math.max(Math.min(k - 3, 9 - k, 1), -1);
return Math.round(255 * color).toString(16).padStart(2, '0');
};
return `#${f(0)}${f(8)}${f(4)}`;
}
function generateRandomHSL() {
return {
h: Math.random() * 360,
s: Math.random() * 100,
l: Math.random() * 100
};
}
function isDistinct(newColor, existingColors, threshold) {
const hslNew = newColor;
for (const color of existingColors) {
const hslColor = hexToHSL(color);
const h = Math.abs(hslNew.h - hslColor.h);
const s = Math.abs(hslNew.s * 100 - hslColor.s * 100);
const l = Math.abs(hslNew.l - hslColor.l * 100);
if (h < threshold && s < threshold && l < threshold) {
console.debug(`trying distinct color h=${h} s=${s} l=${l} with threshold=${threshold}`);
return false;
}
}
return true;
}
let newColor, attempt = 0;
const maxAttempts = 1000; // Max attempts before returning any color
const baseThreshold = 30; // Starting threshold
do {
newColor = generateRandomHSL();
// Decreasing threshold as attempts increase, but never below 10 for distinctiveness
let threshold = Math.max(baseThreshold - (attempt / 10), 10);
if (isDistinct(newColor, hexColors, threshold)) {
return hslToHex(newColor.h, newColor.s, newColor.l);
}
attempt++;
} while (attempt < maxAttempts);
// If we've tried maxAttempts times, return the last generated color regardless
return hslToHex(newColor.h, newColor.s, newColor.l);
}
export const RefreshHeader = ({header, headerSize = 'h2', onRefresh, popupContents}) => {
const refreshButton = <APIButton icon='refresh' onClick={onRefresh}/>;
let popup;
if (popupContents) {
popup = <Popup
content={popupContents}
on='hover'
trigger={refreshButton}
/>;
}
return <Grid columns={2}>
<GridRow>
<GridColumn>
<Header as={headerSize}>{header}</Header>
</GridColumn>
<GridColumn textAlign='right'>{popup || refreshButton}</GridColumn>
</GridRow>
</Grid>
}