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, languages } from "./i18next";
52 } from "./interfaces";
53 import { HttpService, UserService } from "./services";
54 import { RequestState } from "./services/HttpService";
58 Tribute = require("tributejs");
61 export const favIconUrl = "/static/assets/icons/favicon.svg";
62 export const favIconPngUrl = "/static/assets/icons/apple-touch-icon.png";
64 // export const defaultFavIcon = `${window.location.protocol}//${window.location.host}${favIconPngUrl}`;
65 export const repoUrl = "https://github.com/LemmyNet";
66 export const joinLemmyUrl = "https://join-lemmy.org";
67 export const donateLemmyUrl = `${joinLemmyUrl}/donate`;
68 export const docsUrl = `${joinLemmyUrl}/docs/en/index.html`;
69 export const helpGuideUrl = `${joinLemmyUrl}/docs/en/users/01-getting-started.html`; // TODO find a way to redirect to the non-en folder
70 export const markdownHelpUrl = `${joinLemmyUrl}/docs/en/users/02-media.html`;
71 export const sortingHelpUrl = `${joinLemmyUrl}/docs/en/users/03-votes-and-ranking.html`;
72 export const archiveTodayUrl = "https://archive.today";
73 export const ghostArchiveUrl = "https://ghostarchive.org";
74 export const webArchiveUrl = "https://web.archive.org";
75 export const elementUrl = "https://element.io";
77 export const postRefetchSeconds: number = 60 * 1000;
78 export const fetchLimit = 40;
79 export const trendingFetchLimit = 6;
80 export const mentionDropdownFetchLimit = 10;
81 export const commentTreeMaxDepth = 8;
82 export const markdownFieldCharacterLimit = 50000;
83 export const maxUploadImages = 20;
84 export const concurrentImageUpload = 4;
85 export const updateUnreadCountsInterval = 30000;
87 export const relTags = "noopener nofollow";
89 export const emDash = "\u2014";
91 export type ThemeColor =
114 export interface ErrorPageData {
116 adminMatrixIds?: string[];
119 const customEmojis: EmojiMartCategory[] = [];
120 export let customEmojisLookup: Map<string, CustomEmojiView> = new Map<
125 const DEFAULT_ALPHABET =
126 "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
128 function getRandomCharFromAlphabet(alphabet: string): string {
129 return alphabet.charAt(Math.floor(Math.random() * alphabet.length));
132 export function getIdFromString(id?: string): number | undefined {
133 return id && id !== "0" && !Number.isNaN(Number(id)) ? Number(id) : undefined;
136 export function getPageFromString(page?: string): number {
137 return page && !Number.isNaN(Number(page)) ? Number(page) : 1;
140 export function randomStr(
141 idDesiredLength = 20,
142 alphabet = DEFAULT_ALPHABET
145 * Create n-long array and map it to random chars from given alphabet.
146 * Then join individual chars as string
148 return Array.from({ length: idDesiredLength })
150 return getRandomCharFromAlphabet(alphabet);
155 const html5EmbedConfig = {
157 useImageSyntax: true, // Enables video/audio embed with ![]() syntax (default)
159 audio: 'controls preload="metadata"',
160 video: 'width="100%" max-height="100%" controls loop preload="metadata"',
165 const spoilerConfig = {
166 validate: (params: string) => {
167 return params.trim().match(/^spoiler\s+(.*)$/);
170 render: (tokens: any, idx: any) => {
171 var m = tokens[idx].info.trim().match(/^spoiler\s+(.*)$/);
173 if (tokens[idx].nesting === 1) {
175 return `<details><summary> ${md.utils.escapeHtml(m[1])} </summary>\n`;
178 return "</details>\n";
183 export let md: MarkdownIt = new MarkdownIt();
185 export let mdNoImages: MarkdownIt = new MarkdownIt();
187 export function hotRankComment(comment_view: CommentView): number {
188 return hotRank(comment_view.counts.score, comment_view.comment.published);
191 export function hotRankActivePost(post_view: PostView): number {
192 return hotRank(post_view.counts.score, post_view.counts.newest_comment_time);
195 export function hotRankPost(post_view: PostView): number {
196 return hotRank(post_view.counts.score, post_view.post.published);
199 export function hotRank(score: number, timeStr: string): number {
200 // Rank = ScaleFactor * sign(Score) * log(1 + abs(Score)) / (Time + 2)^Gravity
201 const date: Date = new Date(timeStr + "Z"); // Add Z to convert from UTC date
202 const now: Date = new Date();
203 const hoursElapsed: number = (now.getTime() - date.getTime()) / 36e5;
206 (10000 * Math.log10(Math.max(1, 3 + Number(score)))) /
207 Math.pow(hoursElapsed + 2, 1.8);
209 // console.log(`Comment: ${comment.content}\nRank: ${rank}\nScore: ${comment.score}\nHours: ${hoursElapsed}`);
214 export function mdToHtml(text: string) {
215 return { __html: md.render(text) };
218 export function mdToHtmlNoImages(text: string) {
219 return { __html: mdNoImages.render(text) };
222 export function mdToHtmlInline(text: string) {
223 return { __html: md.renderInline(text) };
226 export function getUnixTime(text?: string): number | undefined {
227 return text ? new Date(text).getTime() / 1000 : undefined;
230 export function futureDaysToUnixTime(days?: number): number | undefined {
233 new Date(Date.now() + 1000 * 60 * 60 * 24 * days).getTime() / 1000
238 export function canMod(
240 mods?: CommunityModeratorView[],
241 admins?: PersonView[],
242 myUserInfo = UserService.Instance.myUserInfo,
245 // You can do moderator actions only on the mods added after you.
248 ?.map(a => a.person.id)
249 .concat(mods?.map(m => m.moderator.id) ?? []) ?? [];
252 const myIndex = adminsThenMods.findIndex(
253 id => id == myUserInfo.local_user_view.person.id
258 // onSelf +1 on mod actions not for yourself, IE ban, remove, etc
259 adminsThenMods = adminsThenMods.slice(0, myIndex + (onSelf ? 0 : 1));
260 return !adminsThenMods.includes(creator_id);
267 export function canAdmin(
269 admins?: PersonView[],
270 myUserInfo = UserService.Instance.myUserInfo,
273 return canMod(creatorId, undefined, admins, myUserInfo, onSelf);
276 export function isMod(
278 mods?: CommunityModeratorView[]
280 return mods?.map(m => m.moderator.id).includes(creatorId) ?? false;
283 export function amMod(
284 mods?: CommunityModeratorView[],
285 myUserInfo = UserService.Instance.myUserInfo
287 return myUserInfo ? isMod(myUserInfo.local_user_view.person.id, mods) : false;
290 export function isAdmin(creatorId: number, admins?: PersonView[]): boolean {
291 return admins?.map(a => a.person.id).includes(creatorId) ?? false;
294 export function amAdmin(myUserInfo = UserService.Instance.myUserInfo): boolean {
295 return myUserInfo?.local_user_view.person.admin ?? false;
298 export function amCommunityCreator(
300 mods?: CommunityModeratorView[],
301 myUserInfo = UserService.Instance.myUserInfo
303 const myId = myUserInfo?.local_user_view.person.id;
304 // Don't allow mod actions on yourself
305 return myId == mods?.at(0)?.moderator.id && myId != creator_id;
308 export function amSiteCreator(
310 admins?: PersonView[],
311 myUserInfo = UserService.Instance.myUserInfo
313 const myId = myUserInfo?.local_user_view.person.id;
314 return myId == admins?.at(0)?.person.id && myId != creator_id;
317 export function amTopMod(
318 mods: CommunityModeratorView[],
319 myUserInfo = UserService.Instance.myUserInfo
321 return mods.at(0)?.moderator.id == myUserInfo?.local_user_view.person.id;
324 const imageRegex = /(http)?s?:?(\/\/[^"']*\.(?:jpg|jpeg|gif|png|svg|webp))/;
325 const videoRegex = /(http)?s?:?(\/\/[^"']*\.(?:mp4|webm))/;
327 export function isImage(url: string) {
328 return imageRegex.test(url);
331 export function isVideo(url: string) {
332 return videoRegex.test(url);
335 export function validURL(str: string) {
336 return !!new URL(str);
339 export function communityRSSUrl(actorId: string, sort: string): string {
340 const url = new URL(actorId);
341 return `${url.origin}/feeds${url.pathname}.xml?sort=${sort}`;
344 export function validEmail(email: string) {
346 /^(([^\s"(),.:;<>@[\\\]]+(\.[^\s"(),.:;<>@[\\\]]+)*)|(".+"))@((\[(?:\d{1,3}\.){3}\d{1,3}])|(([\dA-Za-z\-]+\.)+[A-Za-z]{2,}))$/;
347 return re.test(String(email).toLowerCase());
350 export function capitalizeFirstLetter(str: string): string {
351 return str.charAt(0).toUpperCase() + str.slice(1);
354 export async function getSiteMetadata(url: string) {
355 const form: GetSiteMetadata = { url };
356 const client = new LemmyHttp(getHttpBase());
357 return client.getSiteMetadata(form);
360 export function getDataTypeString(dt: DataType) {
361 return dt === DataType.Post ? "Post" : "Comment";
364 export function debounce<T extends any[], R>(
365 func: (...e: T) => R,
369 // 'private' variable for instance
370 // The returned function will be able to reference this due to closure.
371 // Each call to the returned function will share this common timer.
372 let timeout: NodeJS.Timeout | null;
374 // Calling debounce returns a new anonymous function
376 // reference the context and args for the setTimeout function
377 const args = arguments;
379 // Should the function be called now? If immediate is true
380 // and not already in a timeout then the answer is: Yes
381 const callNow = immediate && !timeout;
383 // This is the basic debounce behavior where you can call this
384 // function several times, but it will only execute once
385 // [before or after imposing a delay].
386 // Each time the returned function is called, the timer starts over.
387 clearTimeout(timeout ?? undefined);
389 // Set the new timeout
390 timeout = setTimeout(function () {
391 // Inside the timeout function, clear the timeout variable
392 // which will let the next execution run when in 'immediate' mode
395 // Check if the function already ran with the immediate flag
397 // Call the original function with apply
398 // apply lets you define the 'this' object as well as the arguments
399 // (both captured before setTimeout)
400 func.apply(this, args);
404 // Immediate mode and no wait timer? Execute the function..
405 if (callNow) func.apply(this, args);
409 export function getLanguages(
411 myUserInfo = UserService.Instance.myUserInfo
413 const myLang = myUserInfo?.local_user_view.local_user.interface_language;
414 const lang = override || myLang || "browser";
416 if (lang == "browser" && isBrowser()) {
417 return getBrowserLanguages();
423 function getBrowserLanguages(): string[] {
424 // Intersect lemmy's langs, with the browser langs
425 const langs = languages ? languages.map(l => l.code) : ["en"];
427 // NOTE, mobile browsers seem to be missing this list, so append en
428 const allowedLangs = navigator.languages
430 .filter(v => langs.includes(v));
434 export async function fetchThemeList(): Promise<string[]> {
435 return fetch("/css/themelist").then(res => res.json());
438 export async function setTheme(theme: string, forceReload = false) {
442 if (theme === "browser" && !forceReload) {
445 // This is only run on a force reload
446 if (theme == "browser") {
450 const themeList = await fetchThemeList();
452 // Unload all the other themes
453 for (var i = 0; i < themeList.length; i++) {
454 const styleSheet = document.getElementById(themeList[i]);
456 styleSheet.setAttribute("disabled", "disabled");
461 .getElementById("default-light")
462 ?.setAttribute("disabled", "disabled");
463 document.getElementById("default-dark")?.setAttribute("disabled", "disabled");
465 // Load the theme dynamically
466 const cssLoc = `/css/themes/${theme}.css`;
468 loadCss(theme, cssLoc);
469 document.getElementById(theme)?.removeAttribute("disabled");
472 export function loadCss(id: string, loc: string) {
473 if (!document.getElementById(id)) {
474 var head = document.getElementsByTagName("head")[0];
475 var link = document.createElement("link");
477 link.rel = "stylesheet";
478 link.type = "text/css";
481 head.appendChild(link);
485 export function objectFlip(obj: any) {
487 Object.keys(obj).forEach(key => {
493 export function showAvatars(
494 myUserInfo = UserService.Instance.myUserInfo
496 return myUserInfo?.local_user_view.local_user.show_avatars ?? true;
499 export function showScores(
500 myUserInfo = UserService.Instance.myUserInfo
502 return myUserInfo?.local_user_view.local_user.show_scores ?? true;
505 export function isCakeDay(published: string): boolean {
506 // moment(undefined) or moment.utc(undefined) returns the current date/time
507 // moment(null) or moment.utc(null) returns null
508 const createDate = moment.utc(published).local();
509 const currentDate = moment(new Date());
512 createDate.date() === currentDate.date() &&
513 createDate.month() === currentDate.month() &&
514 createDate.year() !== currentDate.year()
518 export function toast(text: string, background: ThemeColor = "success") {
520 const backgroundColor = `var(--${background})`;
523 backgroundColor: backgroundColor,
531 export function pictrsDeleteToast(filename: string, deleteUrl: string) {
533 const clickToDeleteText = i18n.t("click_to_delete_picture", { filename });
534 const deletePictureText = i18n.t("picture_deleted", {
537 const failedDeletePictureText = i18n.t("failed_to_delete_picture", {
541 const backgroundColor = `var(--light)`;
543 const toast = Toastify({
544 text: clickToDeleteText,
545 backgroundColor: backgroundColor,
551 fetch(deleteUrl).then(res => {
553 if (res.ok === true) {
554 alert(deletePictureText);
556 alert(failedDeletePictureText);
568 export function setupTribute() {
570 noMatchTemplate: function () {
577 menuItemTemplate: (item: any) => {
578 const shortName = `:${item.original.key}:`;
579 return `${item.original.val} ${shortName}`;
581 selectTemplate: (item: any) => {
582 const customEmoji = customEmojisLookup.get(
585 if (customEmoji == undefined) return `${item.original.val}`;
587 return `![${customEmoji.alt_text}](${customEmoji.image_url} "${customEmoji.shortcode}")`;
589 values: Object.entries(emojiShortName)
591 return { key: e[1], val: e[0] };
594 Array.from(customEmojisLookup.entries()).map(k => ({
596 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}" />`,
600 autocompleteMode: true,
602 // menuItemLimit: mentionDropdownFetchLimit,
603 menuShowMinLength: 2,
608 selectTemplate: (item: any) => {
609 const it: PersonTribute = item.original;
610 return `[${it.key}](${it.view.person.actor_id})`;
612 values: debounce(async (text: string, cb: any) => {
613 cb(await personSearch(text));
616 autocompleteMode: true,
618 // menuItemLimit: mentionDropdownFetchLimit,
619 menuShowMinLength: 2,
625 selectTemplate: (item: any) => {
626 const it: CommunityTribute = item.original;
627 return `[${it.key}](${it.view.community.actor_id})`;
629 values: debounce(async (text: string, cb: any) => {
630 cb(await communitySearch(text));
633 autocompleteMode: true,
635 // menuItemLimit: mentionDropdownFetchLimit,
636 menuShowMinLength: 2,
642 function setupEmojiDataModel(custom_emoji_views: CustomEmojiView[]) {
643 const groupedEmojis = groupBy(
645 x => x.custom_emoji.category
647 for (const [category, emojis] of Object.entries(groupedEmojis)) {
651 emojis: emojis.map(emoji => ({
652 id: emoji.custom_emoji.shortcode,
653 name: emoji.custom_emoji.shortcode,
654 keywords: emoji.keywords.map(x => x.keyword),
655 skins: [{ src: emoji.custom_emoji.image_url }],
659 customEmojisLookup = new Map(
660 custom_emoji_views.map(view => [view.custom_emoji.shortcode, view])
664 export function updateEmojiDataModel(custom_emoji_view: CustomEmojiView) {
665 const emoji: EmojiMartCustomEmoji = {
666 id: custom_emoji_view.custom_emoji.shortcode,
667 name: custom_emoji_view.custom_emoji.shortcode,
668 keywords: custom_emoji_view.keywords.map(x => x.keyword),
669 skins: [{ src: custom_emoji_view.custom_emoji.image_url }],
671 const categoryIndex = customEmojis.findIndex(
672 x => x.id == custom_emoji_view.custom_emoji.category
674 if (categoryIndex == -1) {
676 id: custom_emoji_view.custom_emoji.category,
677 name: custom_emoji_view.custom_emoji.category,
681 const emojiIndex = customEmojis[categoryIndex].emojis.findIndex(
682 x => x.id == custom_emoji_view.custom_emoji.shortcode
684 if (emojiIndex == -1) {
685 customEmojis[categoryIndex].emojis.push(emoji);
687 customEmojis[categoryIndex].emojis[emojiIndex] = emoji;
690 customEmojisLookup.set(
691 custom_emoji_view.custom_emoji.shortcode,
696 export function removeFromEmojiDataModel(id: number) {
697 let view: CustomEmojiView | undefined;
698 for (const item of customEmojisLookup.values()) {
699 if (item.custom_emoji.id === id) {
705 const categoryIndex = customEmojis.findIndex(
706 x => x.id == view?.custom_emoji.category
708 const emojiIndex = customEmojis[categoryIndex].emojis.findIndex(
709 x => x.id == view?.custom_emoji.shortcode
711 customEmojis[categoryIndex].emojis = customEmojis[
713 ].emojis.splice(emojiIndex, 1);
715 customEmojisLookup.delete(view?.custom_emoji.shortcode);
718 function setupMarkdown() {
719 const markdownItConfig: MarkdownIt.Options = {
725 const emojiDefs = Array.from(customEmojisLookup.entries()).reduce(
726 (main, [key, value]) => ({ ...main, [key]: value }),
729 md = new MarkdownIt(markdownItConfig)
730 .use(markdown_it_sub)
731 .use(markdown_it_sup)
732 .use(markdown_it_footnote)
733 .use(markdown_it_html5_embed, html5EmbedConfig)
734 .use(markdown_it_container, "spoiler", spoilerConfig)
735 .use(markdown_it_emoji, {
739 mdNoImages = new MarkdownIt(markdownItConfig)
740 .use(markdown_it_sub)
741 .use(markdown_it_sup)
742 .use(markdown_it_footnote)
743 .use(markdown_it_html5_embed, html5EmbedConfig)
744 .use(markdown_it_container, "spoiler", spoilerConfig)
745 .use(markdown_it_emoji, {
749 const defaultRenderer = md.renderer.rules.image;
750 md.renderer.rules.image = function (
753 options: MarkdownIt.Options,
757 //Provide custom renderer for our emojis to allow us to add a css class and force size dimensions on them.
758 const item = tokens[idx] as any;
759 const title = item.attrs.length >= 3 ? item.attrs[2][1] : "";
760 const src: string = item.attrs[0][1];
761 const isCustomEmoji = customEmojisLookup.get(title) != undefined;
762 if (!isCustomEmoji) {
763 return defaultRenderer?.(tokens, idx, options, env, self) ?? "";
765 const alt_text = item.content;
766 return `<img class="icon icon-emoji" src="${src}" title="${title}" alt="${alt_text}"/>`;
768 md.renderer.rules.table_open = function () {
769 return '<table class="table">';
773 export function getEmojiMart(
774 onEmojiSelect: (e: any) => void,
775 customPickerOptions: any = {}
777 const pickerOptions = {
778 ...customPickerOptions,
779 onEmojiSelect: onEmojiSelect,
780 custom: customEmojis,
782 return new Picker(pickerOptions);
785 var tippyInstance: any;
787 tippyInstance = tippy("[data-tippy-content]");
790 export function setupTippy() {
792 tippyInstance.forEach((e: any) => e.destroy());
793 tippyInstance = tippy("[data-tippy-content]", {
795 // Display on "long press"
796 touch: ["hold", 500],
801 interface PersonTribute {
806 async function personSearch(text: string): Promise<PersonTribute[]> {
807 const usersResponse = await fetchUsers(text);
809 return usersResponse.map(pv => ({
810 key: `@${pv.person.name}@${hostname(pv.person.actor_id)}`,
815 interface CommunityTribute {
820 async function communitySearch(text: string): Promise<CommunityTribute[]> {
821 const communitiesResponse = await fetchCommunities(text);
823 return communitiesResponse.map(cv => ({
824 key: `!${cv.community.name}@${hostname(cv.community.actor_id)}`,
829 export function getRecipientIdFromProps(props: any): number {
830 return props.match.params.recipient_id
831 ? Number(props.match.params.recipient_id)
835 export function getIdFromProps(props: any): number | undefined {
836 const id = props.match.params.post_id;
837 return id ? Number(id) : undefined;
840 export function getCommentIdFromProps(props: any): number | undefined {
841 const id = props.match.params.comment_id;
842 return id ? Number(id) : undefined;
845 type ImmutableListKey =
854 | "private_message_report"
855 | "registration_application";
857 function editListImmutable<
858 T extends { [key in F]: { id: number } },
859 F extends ImmutableListKey
860 >(fieldName: F, data: T, list: T[]): T[] {
862 ...list.map(c => (c[fieldName].id === data[fieldName].id ? data : c)),
866 export function editComment(
868 comments: CommentView[]
870 return editListImmutable("comment", data, comments);
873 export function editCommentReply(
874 data: CommentReplyView,
875 replies: CommentReplyView[]
876 ): CommentReplyView[] {
877 return editListImmutable("comment_reply", data, replies);
880 interface WithComment {
882 counts: CommentAggregates;
887 export function editMention(
888 data: PersonMentionView,
889 comments: PersonMentionView[]
890 ): PersonMentionView[] {
891 return editListImmutable("person_mention", data, comments);
894 export function editCommunity(
896 communities: CommunityView[]
898 return editListImmutable("community", data, communities);
901 export function editPrivateMessage(
902 data: PrivateMessageView,
903 messages: PrivateMessageView[]
904 ): PrivateMessageView[] {
905 return editListImmutable("private_message", data, messages);
908 export function editPost(data: PostView, posts: PostView[]): PostView[] {
909 return editListImmutable("post", data, posts);
912 export function editPostReport(
913 data: PostReportView,
914 reports: PostReportView[]
916 return editListImmutable("post_report", data, reports);
919 export function editCommentReport(
920 data: CommentReportView,
921 reports: CommentReportView[]
922 ): CommentReportView[] {
923 return editListImmutable("comment_report", data, reports);
926 export function editPrivateMessageReport(
927 data: PrivateMessageReportView,
928 reports: PrivateMessageReportView[]
929 ): PrivateMessageReportView[] {
930 return editListImmutable("private_message_report", data, reports);
933 export function editRegistrationApplication(
934 data: RegistrationApplicationView,
935 apps: RegistrationApplicationView[]
936 ): RegistrationApplicationView[] {
937 return editListImmutable("registration_application", data, apps);
940 export function editWith<D extends WithComment, L extends WithComment>(
941 { comment, counts, saved, my_vote }: D,
946 c.comment.id === comment.id
947 ? { ...c, comment, counts, saved, my_vote }
953 export function updatePersonBlock(
954 data: BlockPersonResponse,
955 myUserInfo: MyUserInfo | undefined = UserService.Instance.myUserInfo
959 myUserInfo.person_blocks.push({
960 person: myUserInfo.local_user_view.person,
961 target: data.person_view.person,
963 toast(`${i18n.t("blocked")} ${data.person_view.person.name}`);
965 myUserInfo.person_blocks = myUserInfo.person_blocks.filter(
966 i => i.target.id !== data.person_view.person.id
968 toast(`${i18n.t("unblocked")} ${data.person_view.person.name}`);
973 export function updateCommunityBlock(
974 data: BlockCommunityResponse,
975 myUserInfo: MyUserInfo | undefined = UserService.Instance.myUserInfo
979 myUserInfo.community_blocks.push({
980 person: myUserInfo.local_user_view.person,
981 community: data.community_view.community,
983 toast(`${i18n.t("blocked")} ${data.community_view.community.name}`);
985 myUserInfo.community_blocks = myUserInfo.community_blocks.filter(
986 i => i.community.id !== data.community_view.community.id
988 toast(`${i18n.t("unblocked")} ${data.community_view.community.name}`);
993 export function commentsToFlatNodes(comments: CommentView[]): CommentNodeI[] {
994 const nodes: CommentNodeI[] = [];
995 for (const comment of comments) {
996 nodes.push({ comment_view: comment, children: [], depth: 0 });
1001 export function convertCommentSortType(sort: SortType): CommentSortType {
1005 sort == "TopWeek" ||
1006 sort == "TopMonth" ||
1010 } else if (sort == "New") {
1012 } else if (sort == "Hot" || sort == "Active") {
1019 export function buildCommentsTree(
1020 comments: CommentView[],
1021 parentComment: boolean
1023 const map = new Map<number, CommentNodeI>();
1024 const depthOffset = !parentComment
1026 : getDepthFromComment(comments[0].comment) ?? 0;
1028 for (const comment_view of comments) {
1029 const depthI = getDepthFromComment(comment_view.comment) ?? 0;
1030 const depth = depthI ? depthI - depthOffset : 0;
1031 const node: CommentNodeI = {
1036 map.set(comment_view.comment.id, { ...node });
1039 const tree: CommentNodeI[] = [];
1041 // if its a parent comment fetch, then push the first comment to the top node.
1042 if (parentComment) {
1043 const cNode = map.get(comments[0].comment.id);
1049 for (const comment_view of comments) {
1050 const child = map.get(comment_view.comment.id);
1052 const parent_id = getCommentParentId(comment_view.comment);
1054 const parent = map.get(parent_id);
1055 // Necessary because blocked comment might not exist
1057 parent.children.push(child);
1060 if (!parentComment) {
1070 export function getCommentParentId(comment?: CommentI): number | undefined {
1071 const split = comment?.path.split(".");
1075 return split && split.length > 1
1076 ? Number(split.at(split.length - 2))
1080 export function getDepthFromComment(comment?: CommentI): number | undefined {
1081 const len = comment?.path.split(".").length;
1082 return len ? len - 2 : undefined;
1085 // TODO make immutable
1086 export function insertCommentIntoTree(
1087 tree: CommentNodeI[],
1089 parentComment: boolean
1091 // Building a fake node to be used for later
1092 const node: CommentNodeI = {
1098 const parentId = getCommentParentId(cv.comment);
1100 const parent_comment = searchCommentTree(tree, parentId);
1101 if (parent_comment) {
1102 node.depth = parent_comment.depth + 1;
1103 parent_comment.children.unshift(node);
1105 } else if (!parentComment) {
1110 export function searchCommentTree(
1111 tree: CommentNodeI[],
1113 ): CommentNodeI | undefined {
1114 for (const node of tree) {
1115 if (node.comment_view.comment.id === id) {
1119 for (const child of node.children) {
1120 const res = searchCommentTree([child], id);
1130 export const colorList: string[] = [
1140 function hsl(num: number) {
1141 return `hsla(${num}, 35%, 50%, 0.5)`;
1144 export function hostname(url: string): string {
1145 const cUrl = new URL(url);
1146 return cUrl.port ? `${cUrl.hostname}:${cUrl.port}` : `${cUrl.hostname}`;
1149 export function validTitle(title?: string): boolean {
1150 // Initial title is null, minimum length is taken care of by textarea's minLength={3}
1151 if (!title || title.length < 3) return true;
1153 const regex = new RegExp(/.*\S.*/, "g");
1155 return regex.test(title);
1158 export function siteBannerCss(banner: string): string {
1160 background-image: linear-gradient( rgba(0, 0, 0, 0.8), rgba(0, 0, 0, 0.8) ) ,url("${banner}"); \
1161 background-attachment: fixed; \
1162 background-position: top; \
1163 background-repeat: no-repeat; \
1164 background-size: 100% cover; \
1167 max-height: 100vh; \
1171 export function isBrowser() {
1172 return typeof window !== "undefined";
1175 export function setIsoData<T extends RouteData>(context: any): IsoData<T> {
1176 // If its the browser, you need to deserialize the data from the window
1178 return window.isoData;
1179 } else return context.router.staticContext;
1182 moment.updateLocale("en", {
1203 export function saveScrollPosition(context: any) {
1204 const path: string = context.router.route.location.pathname;
1205 const y = window.scrollY;
1206 sessionStorage.setItem(`scrollPosition_${path}`, y.toString());
1209 export function restoreScrollPosition(context: any) {
1210 const path: string = context.router.route.location.pathname;
1211 const y = Number(sessionStorage.getItem(`scrollPosition_${path}`));
1212 window.scrollTo(0, y);
1215 export function showLocal(isoData: IsoData): boolean {
1216 return isoData.site_res.site_view.local_site.federation_enabled;
1219 export interface Choice {
1225 export function getUpdatedSearchId(id?: number | null, urlId?: number | null) {
1228 : ((id ?? urlId) === 0 ? undefined : id ?? urlId)?.toString();
1231 export function communityToChoice(cv: CommunityView): Choice {
1233 value: cv.community.id.toString(),
1234 label: communitySelectName(cv),
1238 export function personToChoice(pvs: PersonView): Choice {
1240 value: pvs.person.id.toString(),
1241 label: personSelectName(pvs),
1245 function fetchSearchResults(q: string, type_: SearchType) {
1246 const form: Search = {
1250 listing_type: "All",
1256 return HttpService.client.search(form);
1259 export async function fetchCommunities(q: string) {
1260 const res = await fetchSearchResults(q, "Communities");
1262 return res.state === "success" ? res.data.communities : [];
1265 export async function fetchUsers(q: string) {
1266 const res = await fetchSearchResults(q, "Users");
1268 return res.state === "success" ? res.data.users : [];
1271 export function communitySelectName(cv: CommunityView): string {
1272 return cv.community.local
1273 ? cv.community.title
1274 : `${hostname(cv.community.actor_id)}/${cv.community.title}`;
1277 export function personSelectName({
1278 person: { display_name, name, local, actor_id },
1279 }: PersonView): string {
1280 const pName = display_name ?? name;
1281 return local ? pName : `${hostname(actor_id)}/${pName}`;
1284 export function initializeSite(site?: GetSiteResponse) {
1285 UserService.Instance.myUserInfo = site?.my_user;
1286 i18n.changeLanguage(getLanguages()[0]);
1288 setupEmojiDataModel(site.custom_emojis ?? []);
1293 const SHORTNUM_SI_FORMAT = new Intl.NumberFormat("en-US", {
1294 maximumSignificantDigits: 3,
1296 notation: "compact",
1297 compactDisplay: "short",
1300 export function numToSI(value: number): string {
1301 return SHORTNUM_SI_FORMAT.format(value);
1304 export function isBanned(ps: Person): boolean {
1305 const expires = ps.ban_expires;
1306 // Add Z to convert from UTC date
1307 // TODO this check probably isn't necessary anymore
1309 if (ps.banned && new Date(expires + "Z") > new Date()) {
1319 export function myAuth(): string | undefined {
1320 return UserService.Instance.auth();
1323 export function myAuthRequired(): string {
1324 return UserService.Instance.auth(true) ?? "";
1327 export function enableDownvotes(siteRes: GetSiteResponse): boolean {
1328 return siteRes.site_view.local_site.enable_downvotes;
1331 export function enableNsfw(siteRes: GetSiteResponse): boolean {
1332 return siteRes.site_view.local_site.enable_nsfw;
1335 export function postToCommentSortType(sort: SortType): CommentSortType {
1350 export function canCreateCommunity(
1351 siteRes: GetSiteResponse,
1352 myUserInfo = UserService.Instance.myUserInfo
1354 const adminOnly = siteRes.site_view.local_site.community_creation_admin_only;
1355 // TODO: Make this check if user is logged on as well
1356 return !adminOnly || amAdmin(myUserInfo);
1359 export function isPostBlocked(
1361 myUserInfo: MyUserInfo | undefined = UserService.Instance.myUserInfo
1364 (myUserInfo?.community_blocks
1365 .map(c => c.community.id)
1366 .includes(pv.community.id) ||
1367 myUserInfo?.person_blocks
1368 .map(p => p.target.id)
1369 .includes(pv.creator.id)) ??
1374 /// Checks to make sure you can view NSFW posts. Returns true if you can.
1375 export function nsfwCheck(
1377 myUserInfo = UserService.Instance.myUserInfo
1379 const nsfw = pv.post.nsfw || pv.community.nsfw;
1380 const myShowNsfw = myUserInfo?.local_user_view.local_user.show_nsfw ?? false;
1381 return !nsfw || (nsfw && myShowNsfw);
1384 export function getRandomFromList<T>(list: T[]): T | undefined {
1385 return list.length == 0
1387 : list.at(Math.floor(Math.random() * list.length));
1391 * This shows what language you can select
1393 * Use showAll for the site form
1394 * Use showSite for the profile and community forms
1395 * Use false for both those to filter on your profile and site ones
1397 export function selectableLanguages(
1398 allLanguages: Language[],
1399 siteLanguages: number[],
1402 myUserInfo = UserService.Instance.myUserInfo
1404 const allLangIds = allLanguages.map(l => l.id);
1405 let myLangs = myUserInfo?.discussion_languages ?? allLangIds;
1406 myLangs = myLangs.length == 0 ? allLangIds : myLangs;
1407 const siteLangs = siteLanguages.length == 0 ? allLangIds : siteLanguages;
1410 return allLanguages;
1413 return allLanguages.filter(x => siteLangs.includes(x.id));
1416 .filter(x => siteLangs.includes(x.id))
1417 .filter(x => myLangs.includes(x.id));
1422 interface EmojiMartCategory {
1425 emojis: EmojiMartCustomEmoji[];
1428 interface EmojiMartCustomEmoji {
1432 skins: EmojiMartSkin[];
1435 interface EmojiMartSkin {
1439 const groupBy = <T>(
1441 predicate: (value: T, index: number, array: T[]) => string
1443 array.reduce((acc, value, index, array) => {
1444 (acc[predicate(value, index, array)] ||= []).push(value);
1446 }, {} as { [key: string]: T[] });
1448 export type QueryParams<T extends Record<string, any>> = {
1449 [key in keyof T]?: string;
1452 export function getQueryParams<T extends Record<string, any>>(processors: {
1453 [K in keyof T]: (param: string) => T[K];
1456 const searchParams = new URLSearchParams(window.location.search);
1458 return Array.from(Object.entries(processors)).reduce(
1459 (acc, [key, process]) => ({
1461 [key]: process(searchParams.get(key)),
1470 export function getQueryString<T extends Record<string, string | undefined>>(
1473 return Object.entries(obj)
1474 .filter(([, val]) => val !== undefined && val !== null)
1476 (acc, [key, val], index) => `${acc}${index > 0 ? "&" : ""}${key}=${val}`,
1481 export function isAuthPath(pathname: string) {
1482 return /create_.*|inbox|settings|admin|reports|registration_applications/g.test(
1487 export function canShare() {
1488 return isBrowser() && !!navigator.canShare;
1491 export function share(shareData: ShareData) {
1493 navigator.share(shareData);
1497 export function newVote(voteType: VoteType, myVote?: number): number {
1498 if (voteType == VoteType.Upvote) {
1499 return myVote == 1 ? 0 : 1;
1501 return myVote == -1 ? 0 : -1;
1505 export type RouteDataResponse<T extends Record<string, any>> = {
1506 [K in keyof T]: RequestState<T[K]>;
1509 function sleep(millis: number): Promise<void> {
1510 return new Promise(resolve => setTimeout(resolve, millis));
1514 * Polls / repeatedly runs a promise, every X milliseconds
1516 export async function poll(promiseFn: any, millis: number) {
1517 if (window.document.visibilityState !== "hidden") {
1520 await sleep(millis);
1521 return poll(promiseFn, millis);