1 import { Picker } from "emoji-mart";
2 import emojiShortName from "emoji-short-name";
4 BlockCommunityResponse,
12 CommunityModeratorView,
25 PrivateMessageReportView,
27 RegistrationApplicationView,
31 } from "lemmy-js-client";
32 import { default as MarkdownIt } from "markdown-it";
33 import markdown_it_container from "markdown-it-container";
34 import markdown_it_emoji from "markdown-it-emoji/bare";
35 import markdown_it_footnote from "markdown-it-footnote";
36 import markdown_it_html5_embed from "markdown-it-html5-embed";
37 import markdown_it_sub from "markdown-it-sub";
38 import markdown_it_sup from "markdown-it-sup";
39 import Renderer from "markdown-it/lib/renderer";
40 import Token from "markdown-it/lib/token";
41 import moment from "moment";
42 import tippy from "tippy.js";
43 import Toastify from "toastify-js";
44 import { getHttpBase } from "./env";
45 import { i18n } from "./i18next";
46 import { CommentNodeI, DataType, IsoData, VoteType } from "./interfaces";
47 import { HttpService, UserService } from "./services";
51 Tribute = require("tributejs");
54 export const favIconUrl = "/static/assets/icons/favicon.svg";
55 export const favIconPngUrl = "/static/assets/icons/apple-touch-icon.png";
57 // export const defaultFavIcon = `${window.location.protocol}//${window.location.host}${favIconPngUrl}`;
58 export const repoUrl = "https://github.com/LemmyNet";
59 export const joinLemmyUrl = "https://join-lemmy.org";
60 export const donateLemmyUrl = `${joinLemmyUrl}/donate`;
61 export const docsUrl = `${joinLemmyUrl}/docs/en/index.html`;
62 export const helpGuideUrl = `${joinLemmyUrl}/docs/en/users/01-getting-started.html`; // TODO find a way to redirect to the non-en folder
63 export const markdownHelpUrl = `${joinLemmyUrl}/docs/en/users/02-media.html`;
64 export const sortingHelpUrl = `${joinLemmyUrl}/docs/en/users/03-votes-and-ranking.html`;
65 export const archiveTodayUrl = "https://archive.today";
66 export const ghostArchiveUrl = "https://ghostarchive.org";
67 export const webArchiveUrl = "https://web.archive.org";
68 export const elementUrl = "https://element.io";
70 export const postRefetchSeconds: number = 60 * 1000;
71 export const fetchLimit = 40;
72 export const trendingFetchLimit = 6;
73 export const mentionDropdownFetchLimit = 10;
74 export const commentTreeMaxDepth = 8;
75 export const markdownFieldCharacterLimit = 50000;
76 export const maxUploadImages = 20;
77 export const concurrentImageUpload = 4;
78 export const updateUnreadCountsInterval = 30000;
80 export const relTags = "noopener nofollow";
82 export const emDash = "\u2014";
84 export type ThemeColor =
107 export interface ErrorPageData {
109 adminMatrixIds?: string[];
112 const customEmojis: EmojiMartCategory[] = [];
113 export let customEmojisLookup: Map<string, CustomEmojiView> = new Map<
118 const DEFAULT_ALPHABET =
119 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
121 function getRandomCharFromAlphabet(alphabet: string): string {
122 return alphabet.charAt(Math.floor(Math.random() * alphabet.length));
125 export function getIdFromString(id?: string): number | undefined {
126 return id && id !== "0" && !Number.isNaN(Number(id)) ? Number(id) : undefined;
129 export function getPageFromString(page?: string): number {
130 return page && !Number.isNaN(Number(page)) ? Number(page) : 1;
133 export function randomStr(
134 idDesiredLength = 20,
135 alphabet = DEFAULT_ALPHABET
138 * Create n-long array and map it to random chars from given alphabet.
139 * Then join individual chars as string
141 return Array.from({ length: idDesiredLength })
143 return getRandomCharFromAlphabet(alphabet);
148 const html5EmbedConfig = {
150 useImageSyntax: true, // Enables video/audio embed with ![]() syntax (default)
152 audio: 'controls preload="metadata"',
153 video: 'width="100%" max-height="100%" controls loop preload="metadata"',
158 const spoilerConfig = {
159 validate: (params: string) => {
160 return params.trim().match(/^spoiler\s+(.*)$/);
163 render: (tokens: any, idx: any) => {
164 var m = tokens[idx].info.trim().match(/^spoiler\s+(.*)$/);
166 if (tokens[idx].nesting === 1) {
168 return `<details><summary> ${md.utils.escapeHtml(m[1])} </summary>\n`;
171 return "</details>\n";
176 export let md: MarkdownIt = new MarkdownIt();
178 export let mdNoImages: MarkdownIt = new MarkdownIt();
180 export function hotRankComment(comment_view: CommentView): number {
181 return hotRank(comment_view.counts.score, comment_view.comment.published);
184 export function hotRankActivePost(post_view: PostView): number {
185 return hotRank(post_view.counts.score, post_view.counts.newest_comment_time);
188 export function hotRankPost(post_view: PostView): number {
189 return hotRank(post_view.counts.score, post_view.post.published);
192 export function hotRank(score: number, timeStr: string): number {
193 // Rank = ScaleFactor * sign(Score) * log(1 + abs(Score)) / (Time + 2)^Gravity
194 const date: Date = new Date(timeStr + "Z"); // Add Z to convert from UTC date
195 const now: Date = new Date();
196 const hoursElapsed: number = (now.getTime() - date.getTime()) / 36e5;
199 (10000 * Math.log10(Math.max(1, 3 + Number(score)))) /
200 Math.pow(hoursElapsed + 2, 1.8);
202 // console.log(`Comment: ${comment.content}\nRank: ${rank}\nScore: ${comment.score}\nHours: ${hoursElapsed}`);
207 export function mdToHtml(text: string) {
208 return { __html: md.render(text) };
211 export function mdToHtmlNoImages(text: string) {
212 return { __html: mdNoImages.render(text) };
215 export function mdToHtmlInline(text: string) {
216 return { __html: md.renderInline(text) };
219 export function getUnixTime(text?: string): number | undefined {
220 return text ? new Date(text).getTime() / 1000 : undefined;
223 export function futureDaysToUnixTime(days?: number): number | undefined {
226 new Date(Date.now() + 1000 * 60 * 60 * 24 * days).getTime() / 1000
231 export function canMod(
233 mods?: CommunityModeratorView[],
234 admins?: PersonView[],
235 myUserInfo = UserService.Instance.myUserInfo,
238 // You can do moderator actions only on the mods added after you.
241 ?.map(a => a.person.id)
242 .concat(mods?.map(m => m.moderator.id) ?? []) ?? [];
245 const myIndex = adminsThenMods.findIndex(
246 id => id == myUserInfo.local_user_view.person.id
251 // onSelf +1 on mod actions not for yourself, IE ban, remove, etc
252 adminsThenMods = adminsThenMods.slice(0, myIndex + (onSelf ? 0 : 1));
253 return !adminsThenMods.includes(creator_id);
260 export function canAdmin(
262 admins?: PersonView[],
263 myUserInfo = UserService.Instance.myUserInfo,
266 return canMod(creatorId, undefined, admins, myUserInfo, onSelf);
269 export function isMod(
271 mods?: CommunityModeratorView[]
273 return mods?.map(m => m.moderator.id).includes(creatorId) ?? false;
276 export function amMod(
277 mods?: CommunityModeratorView[],
278 myUserInfo = UserService.Instance.myUserInfo
280 return myUserInfo ? isMod(myUserInfo.local_user_view.person.id, mods) : false;
283 export function isAdmin(creatorId: number, admins?: PersonView[]): boolean {
284 return admins?.map(a => a.person.id).includes(creatorId) ?? false;
287 export function amAdmin(myUserInfo = UserService.Instance.myUserInfo): boolean {
288 return myUserInfo?.local_user_view.person.admin ?? false;
291 export function amCommunityCreator(
293 mods?: CommunityModeratorView[],
294 myUserInfo = UserService.Instance.myUserInfo
296 const myId = myUserInfo?.local_user_view.person.id;
297 // Don't allow mod actions on yourself
298 return myId == mods?.at(0)?.moderator.id && myId != creator_id;
301 export function amSiteCreator(
303 admins?: PersonView[],
304 myUserInfo = UserService.Instance.myUserInfo
306 const myId = myUserInfo?.local_user_view.person.id;
307 return myId == admins?.at(0)?.person.id && myId != creator_id;
310 export function amTopMod(
311 mods: CommunityModeratorView[],
312 myUserInfo = UserService.Instance.myUserInfo
314 return mods.at(0)?.moderator.id == myUserInfo?.local_user_view.person.id;
317 const imageRegex = /(http)?s?:?(\/\/[^"']*\.(?:jpg|jpeg|gif|png|svg|webp))/;
318 const videoRegex = /(http)?s?:?(\/\/[^"']*\.(?:mp4|webm))/;
319 const tldRegex = /([a-z0-9]+\.)*[a-z0-9]+\.[a-z]+/;
321 export function isImage(url: string) {
322 return imageRegex.test(url);
325 export function isVideo(url: string) {
326 return videoRegex.test(url);
329 export function validURL(str: string) {
330 return !!new URL(str);
333 export function validInstanceTLD(str: string) {
334 return tldRegex.test(str);
337 export function communityRSSUrl(actorId: string, sort: string): string {
338 const url = new URL(actorId);
339 return `${url.origin}/feeds${url.pathname}.xml?sort=${sort}`;
342 export function validEmail(email: string) {
344 /^(([^\s"(),.:;<>@[\\\]]+(\.[^\s"(),.:;<>@[\\\]]+)*)|(".+"))@((\[(?:\d{1,3}\.){3}\d{1,3}])|(([\dA-Za-z\-]+\.)+[A-Za-z]{2,}))$/;
345 return re.test(String(email).toLowerCase());
348 export function capitalizeFirstLetter(str: string): string {
349 return str.charAt(0).toUpperCase() + str.slice(1);
352 export async function getSiteMetadata(url: string) {
353 const form: GetSiteMetadata = { url };
354 const client = new LemmyHttp(getHttpBase());
355 return client.getSiteMetadata(form);
358 export function getDataTypeString(dt: DataType) {
359 return dt === DataType.Post ? "Post" : "Comment";
362 export function debounce<T extends any[], R>(
363 func: (...e: T) => R,
367 // 'private' variable for instance
368 // The returned function will be able to reference this due to closure.
369 // Each call to the returned function will share this common timer.
370 let timeout: NodeJS.Timeout | null;
372 // Calling debounce returns a new anonymous function
374 // reference the context and args for the setTimeout function
375 const args = arguments;
377 // Should the function be called now? If immediate is true
378 // and not already in a timeout then the answer is: Yes
379 const callNow = immediate && !timeout;
381 // This is the basic debounce behavior where you can call this
382 // function several times, but it will only execute once
383 // [before or after imposing a delay].
384 // Each time the returned function is called, the timer starts over.
385 clearTimeout(timeout ?? undefined);
387 // Set the new timeout
388 timeout = setTimeout(function () {
389 // Inside the timeout function, clear the timeout variable
390 // which will let the next execution run when in 'immediate' mode
393 // Check if the function already ran with the immediate flag
395 // Call the original function with apply
396 // apply lets you define the 'this' object as well as the arguments
397 // (both captured before setTimeout)
398 func.apply(this, args);
402 // Immediate mode and no wait timer? Execute the function..
403 if (callNow) func.apply(this, args);
407 export async function fetchThemeList(): Promise<string[]> {
408 return fetch("/css/themelist").then(res => res.json());
411 export async function setTheme(theme: string, forceReload = false) {
415 if (theme === "browser" && !forceReload) {
418 // This is only run on a force reload
419 if (theme == "browser") {
423 const themeList = await fetchThemeList();
425 // Unload all the other themes
426 for (var i = 0; i < themeList.length; i++) {
427 const styleSheet = document.getElementById(themeList[i]);
429 styleSheet.setAttribute("disabled", "disabled");
434 .getElementById("default-light")
435 ?.setAttribute("disabled", "disabled");
436 document.getElementById("default-dark")?.setAttribute("disabled", "disabled");
438 // Load the theme dynamically
439 const cssLoc = `/css/themes/${theme}.css`;
441 loadCss(theme, cssLoc);
442 document.getElementById(theme)?.removeAttribute("disabled");
445 export function loadCss(id: string, loc: string) {
446 if (!document.getElementById(id)) {
447 var head = document.getElementsByTagName("head")[0];
448 var link = document.createElement("link");
450 link.rel = "stylesheet";
451 link.type = "text/css";
454 head.appendChild(link);
458 export function objectFlip(obj: any) {
460 Object.keys(obj).forEach(key => {
466 export function showAvatars(
467 myUserInfo = UserService.Instance.myUserInfo
469 return myUserInfo?.local_user_view.local_user.show_avatars ?? true;
472 export function showScores(
473 myUserInfo = UserService.Instance.myUserInfo
475 return myUserInfo?.local_user_view.local_user.show_scores ?? true;
478 export function isCakeDay(published: string): boolean {
479 // moment(undefined) or moment.utc(undefined) returns the current date/time
480 // moment(null) or moment.utc(null) returns null
481 const createDate = moment.utc(published).local();
482 const currentDate = moment(new Date());
485 createDate.date() === currentDate.date() &&
486 createDate.month() === currentDate.month() &&
487 createDate.year() !== currentDate.year()
491 export function toast(text: string, background: ThemeColor = "success") {
493 const backgroundColor = `var(--${background})`;
496 backgroundColor: backgroundColor,
504 export function pictrsDeleteToast(filename: string, deleteUrl: string) {
506 const clickToDeleteText = i18n.t("click_to_delete_picture", { filename });
507 const deletePictureText = i18n.t("picture_deleted", {
510 const failedDeletePictureText = i18n.t("failed_to_delete_picture", {
514 const backgroundColor = `var(--light)`;
516 const toast = Toastify({
517 text: clickToDeleteText,
518 backgroundColor: backgroundColor,
524 fetch(deleteUrl).then(res => {
526 if (res.ok === true) {
527 alert(deletePictureText);
529 alert(failedDeletePictureText);
541 export function setupTribute() {
543 noMatchTemplate: function () {
550 menuItemTemplate: (item: any) => {
551 const shortName = `:${item.original.key}:`;
552 return `${item.original.val} ${shortName}`;
554 selectTemplate: (item: any) => {
555 const customEmoji = customEmojisLookup.get(
558 if (customEmoji == undefined) return `${item.original.val}`;
560 return `![${customEmoji.alt_text}](${customEmoji.image_url} "${customEmoji.shortcode}")`;
562 values: Object.entries(emojiShortName)
564 return { key: e[1], val: e[0] };
567 Array.from(customEmojisLookup.entries()).map(k => ({
569 val: `<img class="icon icon-emoji" src="${k[1].custom_emoji.image_url}" title="${k[1].custom_emoji.shortcode}" alt="${k[1].custom_emoji.alt_text}" />`,
573 autocompleteMode: true,
575 // menuItemLimit: mentionDropdownFetchLimit,
576 menuShowMinLength: 2,
581 selectTemplate: (item: any) => {
582 const it: PersonTribute = item.original;
583 return `[${it.key}](${it.view.person.actor_id})`;
585 values: debounce(async (text: string, cb: any) => {
586 cb(await personSearch(text));
589 autocompleteMode: true,
591 // menuItemLimit: mentionDropdownFetchLimit,
592 menuShowMinLength: 2,
598 selectTemplate: (item: any) => {
599 const it: CommunityTribute = item.original;
600 return `[${it.key}](${it.view.community.actor_id})`;
602 values: debounce(async (text: string, cb: any) => {
603 cb(await communitySearch(text));
606 autocompleteMode: true,
608 // menuItemLimit: mentionDropdownFetchLimit,
609 menuShowMinLength: 2,
615 function setupEmojiDataModel(custom_emoji_views: CustomEmojiView[]) {
616 const groupedEmojis = groupBy(
618 x => x.custom_emoji.category
620 for (const [category, emojis] of Object.entries(groupedEmojis)) {
624 emojis: emojis.map(emoji => ({
625 id: emoji.custom_emoji.shortcode,
626 name: emoji.custom_emoji.shortcode,
627 keywords: emoji.keywords.map(x => x.keyword),
628 skins: [{ src: emoji.custom_emoji.image_url }],
632 customEmojisLookup = new Map(
633 custom_emoji_views.map(view => [view.custom_emoji.shortcode, view])
637 export function updateEmojiDataModel(custom_emoji_view: CustomEmojiView) {
638 const emoji: EmojiMartCustomEmoji = {
639 id: custom_emoji_view.custom_emoji.shortcode,
640 name: custom_emoji_view.custom_emoji.shortcode,
641 keywords: custom_emoji_view.keywords.map(x => x.keyword),
642 skins: [{ src: custom_emoji_view.custom_emoji.image_url }],
644 const categoryIndex = customEmojis.findIndex(
645 x => x.id == custom_emoji_view.custom_emoji.category
647 if (categoryIndex == -1) {
649 id: custom_emoji_view.custom_emoji.category,
650 name: custom_emoji_view.custom_emoji.category,
654 const emojiIndex = customEmojis[categoryIndex].emojis.findIndex(
655 x => x.id == custom_emoji_view.custom_emoji.shortcode
657 if (emojiIndex == -1) {
658 customEmojis[categoryIndex].emojis.push(emoji);
660 customEmojis[categoryIndex].emojis[emojiIndex] = emoji;
663 customEmojisLookup.set(
664 custom_emoji_view.custom_emoji.shortcode,
669 export function removeFromEmojiDataModel(id: number) {
670 let view: CustomEmojiView | undefined;
671 for (const item of customEmojisLookup.values()) {
672 if (item.custom_emoji.id === id) {
678 const categoryIndex = customEmojis.findIndex(
679 x => x.id == view?.custom_emoji.category
681 const emojiIndex = customEmojis[categoryIndex].emojis.findIndex(
682 x => x.id == view?.custom_emoji.shortcode
684 customEmojis[categoryIndex].emojis = customEmojis[
686 ].emojis.splice(emojiIndex, 1);
688 customEmojisLookup.delete(view?.custom_emoji.shortcode);
691 function setupMarkdown() {
692 const markdownItConfig: MarkdownIt.Options = {
698 const emojiDefs = Array.from(customEmojisLookup.entries()).reduce(
699 (main, [key, value]) => ({ ...main, [key]: value }),
702 md = new MarkdownIt(markdownItConfig)
703 .use(markdown_it_sub)
704 .use(markdown_it_sup)
705 .use(markdown_it_footnote)
706 .use(markdown_it_html5_embed, html5EmbedConfig)
707 .use(markdown_it_container, "spoiler", spoilerConfig)
708 .use(markdown_it_emoji, {
712 mdNoImages = new MarkdownIt(markdownItConfig)
713 .use(markdown_it_sub)
714 .use(markdown_it_sup)
715 .use(markdown_it_footnote)
716 .use(markdown_it_html5_embed, html5EmbedConfig)
717 .use(markdown_it_container, "spoiler", spoilerConfig)
718 .use(markdown_it_emoji, {
722 const defaultRenderer = md.renderer.rules.image;
723 md.renderer.rules.image = function (
726 options: MarkdownIt.Options,
730 //Provide custom renderer for our emojis to allow us to add a css class and force size dimensions on them.
731 const item = tokens[idx] as any;
732 const title = item.attrs.length >= 3 ? item.attrs[2][1] : "";
733 const src: string = item.attrs[0][1];
734 const isCustomEmoji = customEmojisLookup.get(title) != undefined;
735 if (!isCustomEmoji) {
736 return defaultRenderer?.(tokens, idx, options, env, self) ?? "";
738 const alt_text = item.content;
739 return `<img class="icon icon-emoji" src="${src}" title="${title}" alt="${alt_text}"/>`;
741 md.renderer.rules.table_open = function () {
742 return '<table class="table">';
746 export function getEmojiMart(
747 onEmojiSelect: (e: any) => void,
748 customPickerOptions: any = {}
750 const pickerOptions = {
751 ...customPickerOptions,
752 onEmojiSelect: onEmojiSelect,
753 custom: customEmojis,
755 return new Picker(pickerOptions);
758 var tippyInstance: any;
760 tippyInstance = tippy("[data-tippy-content]");
763 export function setupTippy() {
765 tippyInstance.forEach((e: any) => e.destroy());
766 tippyInstance = tippy("[data-tippy-content]", {
768 // Display on "long press"
769 touch: ["hold", 500],
774 interface PersonTribute {
779 async function personSearch(text: string): Promise<PersonTribute[]> {
780 const usersResponse = await fetchUsers(text);
782 return usersResponse.map(pv => ({
783 key: `@${pv.person.name}@${hostname(pv.person.actor_id)}`,
788 interface CommunityTribute {
793 async function communitySearch(text: string): Promise<CommunityTribute[]> {
794 const communitiesResponse = await fetchCommunities(text);
796 return communitiesResponse.map(cv => ({
797 key: `!${cv.community.name}@${hostname(cv.community.actor_id)}`,
802 export function getRecipientIdFromProps(props: any): number {
803 return props.match.params.recipient_id
804 ? Number(props.match.params.recipient_id)
808 export function getIdFromProps(props: any): number | undefined {
809 const id = props.match.params.post_id;
810 return id ? Number(id) : undefined;
813 export function getCommentIdFromProps(props: any): number | undefined {
814 const id = props.match.params.comment_id;
815 return id ? Number(id) : undefined;
818 type ImmutableListKey =
827 | "private_message_report"
828 | "registration_application";
830 function editListImmutable<
831 T extends { [key in F]: { id: number } },
832 F extends ImmutableListKey
833 >(fieldName: F, data: T, list: T[]): T[] {
835 ...list.map(c => (c[fieldName].id === data[fieldName].id ? data : c)),
839 export function editComment(
841 comments: CommentView[]
843 return editListImmutable("comment", data, comments);
846 export function editCommentReply(
847 data: CommentReplyView,
848 replies: CommentReplyView[]
849 ): CommentReplyView[] {
850 return editListImmutable("comment_reply", data, replies);
853 interface WithComment {
855 counts: CommentAggregates;
860 export function editMention(
861 data: PersonMentionView,
862 comments: PersonMentionView[]
863 ): PersonMentionView[] {
864 return editListImmutable("person_mention", data, comments);
867 export function editCommunity(
869 communities: CommunityView[]
871 return editListImmutable("community", data, communities);
874 export function editPrivateMessage(
875 data: PrivateMessageView,
876 messages: PrivateMessageView[]
877 ): PrivateMessageView[] {
878 return editListImmutable("private_message", data, messages);
881 export function editPost(data: PostView, posts: PostView[]): PostView[] {
882 return editListImmutable("post", data, posts);
885 export function editPostReport(
886 data: PostReportView,
887 reports: PostReportView[]
889 return editListImmutable("post_report", data, reports);
892 export function editCommentReport(
893 data: CommentReportView,
894 reports: CommentReportView[]
895 ): CommentReportView[] {
896 return editListImmutable("comment_report", data, reports);
899 export function editPrivateMessageReport(
900 data: PrivateMessageReportView,
901 reports: PrivateMessageReportView[]
902 ): PrivateMessageReportView[] {
903 return editListImmutable("private_message_report", data, reports);
906 export function editRegistrationApplication(
907 data: RegistrationApplicationView,
908 apps: RegistrationApplicationView[]
909 ): RegistrationApplicationView[] {
910 return editListImmutable("registration_application", data, apps);
913 export function editWith<D extends WithComment, L extends WithComment>(
914 { comment, counts, saved, my_vote }: D,
919 c.comment.id === comment.id
920 ? { ...c, comment, counts, saved, my_vote }
926 export function updatePersonBlock(
927 data: BlockPersonResponse,
928 myUserInfo: MyUserInfo | undefined = UserService.Instance.myUserInfo
932 myUserInfo.person_blocks.push({
933 person: myUserInfo.local_user_view.person,
934 target: data.person_view.person,
936 toast(`${i18n.t("blocked")} ${data.person_view.person.name}`);
938 myUserInfo.person_blocks = myUserInfo.person_blocks.filter(
939 i => i.target.id !== data.person_view.person.id
941 toast(`${i18n.t("unblocked")} ${data.person_view.person.name}`);
946 export function updateCommunityBlock(
947 data: BlockCommunityResponse,
948 myUserInfo: MyUserInfo | undefined = UserService.Instance.myUserInfo
952 myUserInfo.community_blocks.push({
953 person: myUserInfo.local_user_view.person,
954 community: data.community_view.community,
956 toast(`${i18n.t("blocked")} ${data.community_view.community.name}`);
958 myUserInfo.community_blocks = myUserInfo.community_blocks.filter(
959 i => i.community.id !== data.community_view.community.id
961 toast(`${i18n.t("unblocked")} ${data.community_view.community.name}`);
966 export function commentsToFlatNodes(comments: CommentView[]): CommentNodeI[] {
967 const nodes: CommentNodeI[] = [];
968 for (const comment of comments) {
969 nodes.push({ comment_view: comment, children: [], depth: 0 });
974 export function convertCommentSortType(sort: SortType): CommentSortType {
979 sort == "TopMonth" ||
983 } else if (sort == "New") {
985 } else if (sort == "Hot" || sort == "Active") {
992 export function buildCommentsTree(
993 comments: CommentView[],
994 parentComment: boolean
996 const map = new Map<number, CommentNodeI>();
997 const depthOffset = !parentComment
999 : getDepthFromComment(comments[0].comment) ?? 0;
1001 for (const comment_view of comments) {
1002 const depthI = getDepthFromComment(comment_view.comment) ?? 0;
1003 const depth = depthI ? depthI - depthOffset : 0;
1004 const node: CommentNodeI = {
1009 map.set(comment_view.comment.id, { ...node });
1012 const tree: CommentNodeI[] = [];
1014 // if its a parent comment fetch, then push the first comment to the top node.
1015 if (parentComment) {
1016 const cNode = map.get(comments[0].comment.id);
1022 for (const comment_view of comments) {
1023 const child = map.get(comment_view.comment.id);
1025 const parent_id = getCommentParentId(comment_view.comment);
1027 const parent = map.get(parent_id);
1028 // Necessary because blocked comment might not exist
1030 parent.children.push(child);
1033 if (!parentComment) {
1043 export function getCommentParentId(comment?: CommentI): number | undefined {
1044 const split = comment?.path.split(".");
1048 return split && split.length > 1
1049 ? Number(split.at(split.length - 2))
1053 export function getDepthFromComment(comment?: CommentI): number | undefined {
1054 const len = comment?.path.split(".").length;
1055 return len ? len - 2 : undefined;
1058 // TODO make immutable
1059 export function insertCommentIntoTree(
1060 tree: CommentNodeI[],
1062 parentComment: boolean
1064 // Building a fake node to be used for later
1065 const node: CommentNodeI = {
1071 const parentId = getCommentParentId(cv.comment);
1073 const parent_comment = searchCommentTree(tree, parentId);
1074 if (parent_comment) {
1075 node.depth = parent_comment.depth + 1;
1076 parent_comment.children.unshift(node);
1078 } else if (!parentComment) {
1083 export function searchCommentTree(
1084 tree: CommentNodeI[],
1086 ): CommentNodeI | undefined {
1087 for (const node of tree) {
1088 if (node.comment_view.comment.id === id) {
1092 for (const child of node.children) {
1093 const res = searchCommentTree([child], id);
1103 export const colorList: string[] = [
1113 function hsl(num: number) {
1114 return `hsla(${num}, 35%, 50%, 0.5)`;
1117 export function hostname(url: string): string {
1118 const cUrl = new URL(url);
1119 return cUrl.port ? `${cUrl.hostname}:${cUrl.port}` : `${cUrl.hostname}`;
1122 export function validTitle(title?: string): boolean {
1123 // Initial title is null, minimum length is taken care of by textarea's minLength={3}
1124 if (!title || title.length < 3) return true;
1126 const regex = new RegExp(/.*\S.*/, "g");
1128 return regex.test(title);
1131 export function siteBannerCss(banner: string): string {
1133 background-image: linear-gradient( rgba(0, 0, 0, 0.8), rgba(0, 0, 0, 0.8) ) ,url("${banner}"); \
1134 background-attachment: fixed; \
1135 background-position: top; \
1136 background-repeat: no-repeat; \
1137 background-size: 100% cover; \
1140 max-height: 100vh; \
1144 export function isBrowser() {
1145 return typeof window !== "undefined";
1148 export function setIsoData(context: any): IsoData {
1149 // If its the browser, you need to deserialize the data from the window
1151 return window.isoData;
1152 } else return context.router.staticContext;
1155 moment.updateLocale("en", {
1176 export function saveScrollPosition(context: any) {
1177 const path: string = context.router.route.location.pathname;
1178 const y = window.scrollY;
1179 sessionStorage.setItem(`scrollPosition_${path}`, y.toString());
1182 export function restoreScrollPosition(context: any) {
1183 const path: string = context.router.route.location.pathname;
1184 const y = Number(sessionStorage.getItem(`scrollPosition_${path}`));
1185 window.scrollTo(0, y);
1188 export function showLocal(isoData: IsoData): boolean {
1189 return isoData.site_res.site_view.local_site.federation_enabled;
1192 export interface Choice {
1198 export function getUpdatedSearchId(id?: number | null, urlId?: number | null) {
1201 : ((id ?? urlId) === 0 ? undefined : id ?? urlId)?.toString();
1204 export function communityToChoice(cv: CommunityView): Choice {
1206 value: cv.community.id.toString(),
1207 label: communitySelectName(cv),
1211 export function personToChoice(pvs: PersonView): Choice {
1213 value: pvs.person.id.toString(),
1214 label: personSelectName(pvs),
1218 function fetchSearchResults(q: string, type_: SearchType) {
1219 const form: Search = {
1223 listing_type: "All",
1229 return HttpService.client.search(form);
1232 export async function fetchCommunities(q: string) {
1233 const res = await fetchSearchResults(q, "Communities");
1235 return res.state === "success" ? res.data.communities : [];
1238 export async function fetchUsers(q: string) {
1239 const res = await fetchSearchResults(q, "Users");
1241 return res.state === "success" ? res.data.users : [];
1244 export function communitySelectName(cv: CommunityView): string {
1245 return cv.community.local
1246 ? cv.community.title
1247 : `${hostname(cv.community.actor_id)}/${cv.community.title}`;
1250 export function personSelectName({
1251 person: { display_name, name, local, actor_id },
1252 }: PersonView): string {
1253 const pName = display_name ?? name;
1254 return local ? pName : `${hostname(actor_id)}/${pName}`;
1257 export function initializeSite(site?: GetSiteResponse) {
1258 UserService.Instance.myUserInfo = site?.my_user;
1259 i18n.changeLanguage();
1261 setupEmojiDataModel(site.custom_emojis ?? []);
1266 const SHORTNUM_SI_FORMAT = new Intl.NumberFormat("en-US", {
1267 maximumSignificantDigits: 3,
1269 notation: "compact",
1270 compactDisplay: "short",
1273 export function numToSI(value: number): string {
1274 return SHORTNUM_SI_FORMAT.format(value);
1277 export function isBanned(ps: Person): boolean {
1278 const expires = ps.ban_expires;
1279 // Add Z to convert from UTC date
1280 // TODO this check probably isn't necessary anymore
1282 if (ps.banned && new Date(expires + "Z") > new Date()) {
1292 export function myAuth(): string | undefined {
1293 return UserService.Instance.auth();
1296 export function myAuthRequired(): string {
1297 return UserService.Instance.auth(true) ?? "";
1300 export function enableDownvotes(siteRes: GetSiteResponse): boolean {
1301 return siteRes.site_view.local_site.enable_downvotes;
1304 export function enableNsfw(siteRes: GetSiteResponse): boolean {
1305 return siteRes.site_view.local_site.enable_nsfw;
1308 export function postToCommentSortType(sort: SortType): CommentSortType {
1323 export function canCreateCommunity(
1324 siteRes: GetSiteResponse,
1325 myUserInfo = UserService.Instance.myUserInfo
1327 const adminOnly = siteRes.site_view.local_site.community_creation_admin_only;
1328 // TODO: Make this check if user is logged on as well
1329 return !adminOnly || amAdmin(myUserInfo);
1332 export function isPostBlocked(
1334 myUserInfo: MyUserInfo | undefined = UserService.Instance.myUserInfo
1337 (myUserInfo?.community_blocks
1338 .map(c => c.community.id)
1339 .includes(pv.community.id) ||
1340 myUserInfo?.person_blocks
1341 .map(p => p.target.id)
1342 .includes(pv.creator.id)) ??
1347 /// Checks to make sure you can view NSFW posts. Returns true if you can.
1348 export function nsfwCheck(
1350 myUserInfo = UserService.Instance.myUserInfo
1352 const nsfw = pv.post.nsfw || pv.community.nsfw;
1353 const myShowNsfw = myUserInfo?.local_user_view.local_user.show_nsfw ?? false;
1354 return !nsfw || (nsfw && myShowNsfw);
1357 export function getRandomFromList<T>(list: T[]): T | undefined {
1358 return list.length == 0
1360 : list.at(Math.floor(Math.random() * list.length));
1364 * This shows what language you can select
1366 * Use showAll for the site form
1367 * Use showSite for the profile and community forms
1368 * Use false for both those to filter on your profile and site ones
1370 export function selectableLanguages(
1371 allLanguages: Language[],
1372 siteLanguages: number[],
1375 myUserInfo = UserService.Instance.myUserInfo
1377 const allLangIds = allLanguages.map(l => l.id);
1378 let myLangs = myUserInfo?.discussion_languages ?? allLangIds;
1379 myLangs = myLangs.length == 0 ? allLangIds : myLangs;
1380 const siteLangs = siteLanguages.length == 0 ? allLangIds : siteLanguages;
1383 return allLanguages;
1386 return allLanguages.filter(x => siteLangs.includes(x.id));
1389 .filter(x => siteLangs.includes(x.id))
1390 .filter(x => myLangs.includes(x.id));
1395 interface EmojiMartCategory {
1398 emojis: EmojiMartCustomEmoji[];
1401 interface EmojiMartCustomEmoji {
1405 skins: EmojiMartSkin[];
1408 interface EmojiMartSkin {
1412 const groupBy = <T>(
1414 predicate: (value: T, index: number, array: T[]) => string
1416 array.reduce((acc, value, index, array) => {
1417 (acc[predicate(value, index, array)] ||= []).push(value);
1419 }, {} as { [key: string]: T[] });
1421 export type QueryParams<T extends Record<string, any>> = {
1422 [key in keyof T]?: string;
1425 export function getQueryParams<T extends Record<string, any>>(processors: {
1426 [K in keyof T]: (param: string) => T[K];
1429 const searchParams = new URLSearchParams(window.location.search);
1431 return Array.from(Object.entries(processors)).reduce(
1432 (acc, [key, process]) => ({
1434 [key]: process(searchParams.get(key)),
1443 export function getQueryString<T extends Record<string, string | undefined>>(
1446 return Object.entries(obj)
1447 .filter(([, val]) => val !== undefined && val !== null)
1449 (acc, [key, val], index) => `${acc}${index > 0 ? "&" : ""}${key}=${val}`,
1454 export function isAuthPath(pathname: string) {
1455 return /create_.*|inbox|settings|admin|reports|registration_applications/g.test(
1460 export function canShare() {
1461 return isBrowser() && !!navigator.canShare;
1464 export function share(shareData: ShareData) {
1466 navigator.share(shareData);
1470 export function newVote(voteType: VoteType, myVote?: number): number {
1471 if (voteType == VoteType.Upvote) {
1472 return myVote == 1 ? 0 : 1;
1474 return myVote == -1 ? 0 : -1;
1478 function sleep(millis: number): Promise<void> {
1479 return new Promise(resolve => setTimeout(resolve, millis));
1483 * Polls / repeatedly runs a promise, every X milliseconds
1485 export async function poll(promiseFn: any, millis: number) {
1486 if (window.document.visibilityState !== "hidden") {
1489 await sleep(millis);
1490 return poll(promiseFn, millis);