From 191212c940084476e213927e099d47cb28da1b90 Mon Sep 17 00:00:00 2001
From: ari melody <ari@arimelody.me>
Date: Fri, 21 Jun 2024 04:55:24 +0100
Subject: [PATCH] migrate to unified "capabilities" API

---
 src/App.svelte                         |   3 +-
 src/api/firefish.js                    |  98 ----------------------
 src/{api/mastodon.js => client/api.js} | 109 +++++++++++++++----------
 src/client/client.js                   |  83 +++++--------------
 src/client/instance.js                 |  68 +++++++++++++++
 src/post/post.js                       |  83 ++++++++++---------
 6 files changed, 198 insertions(+), 246 deletions(-)
 delete mode 100644 src/api/firefish.js
 rename src/{api/mastodon.js => client/api.js} (68%)
 create mode 100644 src/client/instance.js

diff --git a/src/App.svelte b/src/App.svelte
index d9db3ea..604190a 100644
--- a/src/App.svelte
+++ b/src/App.svelte
@@ -1,6 +1,6 @@
 <script>
     import Feed from './Feed.svelte';
-    import { Client, server_types } from './client/client.js';
+    import { Client } from './client/client.js';
 
     let ready = Client.get().app && Client.get().app.token;
 
@@ -25,7 +25,6 @@
         });
     }
 
-
     function log_out() {
         Client.get().logout().then(() => {
             ready = false;
diff --git a/src/api/firefish.js b/src/api/firefish.js
deleted file mode 100644
index 8302ff4..0000000
--- a/src/api/firefish.js
+++ /dev/null
@@ -1,98 +0,0 @@
-import { Client } from '../client/client.js';
-import Post from '../post/post.js';
-import User from '../user/user.js';
-import Emoji from '../emoji.js';
-
-import * as mastodonAPI from './mastodon.js';
-
-export async function createApp(host) {
-    return await mastodonAPI.createApp(host);
-}
-
-export function getOAuthUrl() {
-    return mastodonAPI.getOAuthUrl();
-}
-
-export async function getToken(code) {
-    return await mastodonAPI.getToken(code);
-}
-
-export async function revokeToken() {
-    return await mastodonAPI.revokeToken();
-}
-
-export async function getTimeline(last_post_id) {
-    return await mastodonAPI.getTimeline(last_post_id);
-}
-
-export async function getPost(post_id, num_replies) {
-    return await mastodonAPI.getPost(post_id, num_replies);
-}
-
-export async function parsePost(data, num_replies) {
-    let client = Client.get();
-    let post = new Post()
-    post.id = data.id;
-    post.created_at = new Date(data.created_at);
-    post.user = await Client.get().api.parseUser(data.account);
-    post.text = data.text;
-    post.warning = data.spoiler_text;
-    post.boost_count = data.reblogs_count;
-    post.reply_count = data.replies_count;
-    post.mentions = data.mentions;
-    post.reactions = data.reactions;
-    post.files = data.media_attachments;
-    post.url = data.url;
-    post.reply = data.in_reply_to_id && num_replies > 0 ? await getPost(data.in_reply_to_id, num_replies - 1) : null;
-    post.boost = data.reblog ? await parsePost(data.reblog, 1) : null;
-    post.emojis = [];
-    data.emojis.forEach(emoji_data => {
-        let name = emoji_data.shortcode.split('@')[0];
-        post.emojis.push(Client.get().api.parseEmoji({
-            id: name + '@' + post.user.host,
-            name: name,
-            host: post.user.host,
-            url: emoji_data.url,
-        }));
-    });
-    post.reactions = [];
-    data.reactions.forEach(reaction_data => {
-        if (/^[\w\-.@]+$/g.exec(reaction_data.name)) {
-            let name = reaction_data.name.split('@')[0];
-            let host = reaction_data.name.includes('@') ? reaction_data.name.split('@')[1] : client.instance.host;
-            post.reactions.push({
-                count: reaction_data.count,
-                emoji: Client.get().api.parseEmoji({
-                    id: name + '@' + host,
-                    name: name,
-                    host: host,
-                    url: reaction_data.url,
-                }),
-                me: reaction_data.me,
-            });
-        } else {
-            if (reaction_data.name == '❤') reaction_data.name = '❤️'; // stupid heart unicode
-            post.reactions.push({
-                count: reaction_data.count,
-                emoji: {
-                    html: reaction_data.name,
-                    name: reaction_data.name,
-                },
-                me: reaction_data.me,
-            });
-        }
-    });
-    return post;
-}
-
-export async function parseUser(data) {
-    return mastodonAPI.parseUser(data);
-}
-
-export function parseEmoji(data) {
-    return mastodonAPI.parseEmoji(data);
-}
-
-export async function getUser(user_id) {
-    return mastodonAPI.getUser(user_id);
-}
diff --git a/src/api/mastodon.js b/src/client/api.js
similarity index 68%
rename from src/api/mastodon.js
rename to src/client/api.js
index 38d348e..7adf592 100644
--- a/src/api/mastodon.js
+++ b/src/client/api.js
@@ -1,4 +1,5 @@
 import { Client } from '../client/client.js';
+import { capabilities } from '../client/instance.js';
 import Post from '../post/post.js';
 import User from '../user/user.js';
 import Emoji from '../emoji.js';
@@ -94,13 +95,15 @@ export async function getTimeline(last_post_id) {
     let posts = [];
     for (let i in data) {
         const post_data = data[i];
-        const post = await client.api.parsePost(post_data, 1);
+        const post = await parsePost(post_data, 1);
         if (!post) {
-            if (post_data.id) {
-                console.warn("Failed to parse post #" + post_data.id);
-            } else {
-                console.warn("Failed to parse post:");
-                console.warn(post_data);
+            if (post === null || post === undefined) {
+                if (post_data.id) {
+                    console.warn("Failed to parse post #" + post_data.id);
+                } else {
+                    console.warn("Failed to parse post:");
+                    console.warn(post_data);
+                }
             }
             continue;
         }
@@ -115,10 +118,12 @@ export async function getPost(post_id, num_replies) {
     const data = await fetch(url, {
         method: 'GET',
         headers: { "Authorization": "Bearer " + client.app.token }
-    }).then(res => res.json());
+    }).then(res => { res.ok ? res.json() : false });
 
-    const post = await client.api.parsePost(data, num_replies);
-    if (!post) {
+    if (!data) return null;
+
+    const post = await parsePost(data, num_replies);
+    if (post === null || post === undefined) {
         if (data.id) {
             console.warn("Failed to parse post data #" + data.id);
         } else {
@@ -133,56 +138,72 @@ export async function getPost(post_id, num_replies) {
 export async function parsePost(data, num_replies) {
     let client = Client.get();
     let post = new Post()
+
     post.id = data.id;
     post.created_at = new Date(data.created_at);
-    post.user = await Client.get().api.parseUser(data.account);
-    post.text = data.content;
+    post.user = await parseUser(data.account);
+
+    if (client.instance.capabilities.includes(capabilities.MARKDOWN_CONTENT))
+        post.text = data.text;
+    else
+        post.text = data.content;
+
     post.warning = data.spoiler_text;
     post.boost_count = data.reblogs_count;
     post.reply_count = data.replies_count;
     post.mentions = data.mentions;
-    post.reactions = data.reactions;
     post.files = data.media_attachments;
     post.url = data.url;
-    post.reply = data.in_reply_to_id && num_replies > 0 ? await getPost(data.in_reply_to_id, num_replies - 1) : null;
+
+    post.reply = null;
+    if (data.in_reply_to_id && num_replies > 0) {
+        post.reply = await getPost(data.in_reply_to_id, num_replies - 1);
+        // if the post returns null, we probably don't have permission to read it.
+        // we'll respect the thread's privacy, and leave it alone :)
+        if (post.reply === null) return false;
+    }
     post.boost = data.reblog ? await parsePost(data.reblog, 1) : null;
+
     post.emojis = [];
     data.emojis.forEach(emoji_data => {
         let name = emoji_data.shortcode.split('@')[0];
-        post.emojis.push(Client.get().api.parseEmoji({
+        post.emojis.push(parseEmoji({
             id: name + '@' + post.user.host,
             name: name,
             host: post.user.host,
             url: emoji_data.url,
         }));
     });
-    post.reactions = [];
-    data.reactions.forEach(reaction_data => {
-        if (/^[\w\-.@]+$/g.exec(reaction_data.name)) {
-            let name = reaction_data.name.split('@')[0];
-            let host = reaction_data.name.includes('@') ? reaction_data.name.split('@')[1] : client.instance.host;
-            post.reactions.push({
-                count: reaction_data.count,
-                emoji: Client.get().api.parseEmoji({
-                    id: name + '@' + host,
-                    name: name,
-                    host: host,
-                    url: reaction_data.url,
-                }),
-                me: reaction_data.me,
-            });
-        } else {
-            if (reaction_data.name == '❤') reaction_data.name = '❤️'; // stupid heart unicode
-            post.reactions.push({
-                count: reaction_data.count,
-                emoji: {
-                    html: reaction_data.name,
-                    name: reaction_data.name,
-                },
-                me: reaction_data.me,
-            });
-        }
-    });
+
+    if (client.instance.capabilities.includes(capabilities.REACTIONS)) {
+        post.reactions = [];
+        data.reactions.forEach(reaction_data => {
+            if (/^[\w\-.@]+$/g.exec(reaction_data.name)) {
+                let name = reaction_data.name.split('@')[0];
+                let host = reaction_data.name.includes('@') ? reaction_data.name.split('@')[1] : client.instance.host;
+                post.reactions.push({
+                    count: reaction_data.count,
+                    emoji: parseEmoji({
+                        id: name + '@' + host,
+                        name: name,
+                        host: host,
+                        url: reaction_data.url,
+                    }),
+                    me: reaction_data.me,
+                });
+            } else {
+                if (reaction_data.name == '❤') reaction_data.name = '❤️'; // stupid heart unicode
+                post.reactions.push({
+                    count: reaction_data.count,
+                    emoji: {
+                        html: reaction_data.name,
+                        name: reaction_data.name,
+                    },
+                    me: reaction_data.me,
+                });
+            }
+        });
+    }
     return post;
 }
 
@@ -201,7 +222,7 @@ export async function parseUser(data) {
         emoji_data.id = emoji_data.shortcode + '@' + user.host;
         emoji_data.name = emoji_data.shortcode;
         emoji_data.host = user.host;
-        user.emojis.push(Client.get().api.parseEmoji(emoji_data));
+        user.emojis.push(parseEmoji(emoji_data));
     });
     Client.get().putCacheUser(user);
     return user;
@@ -226,8 +247,8 @@ export async function getUser(user_id) {
         headers: { "Authorization": "Bearer " + client.app.token }
     }).then(res => res.json());
 
-    const user = await Client.get().api.parseUser(data);
-    if (!post) {
+    const user = await parseUser(data);
+    if (user === null || user === undefined) {
         if (data.id) {
             console.warn("Failed to parse user data #" + data.id);
         } else {
diff --git a/src/client/client.js b/src/client/client.js
index 91f19b8..7480cb9 100644
--- a/src/client/client.js
+++ b/src/client/client.js
@@ -1,27 +1,11 @@
-import * as mastodonAPI from '../api/mastodon.js';
-import * as firefishAPI from '../api/firefish.js';
+import { Instance, server_types } from './instance.js';
+import * as api from './api.js';
 
 let client = false;
 
-export const server_types = {
-    INCOMPATIBLE: "incompatible",
-    MASTODON: "mastodon",
-    FIREFISH: "firefish",
-};
-
 const save_name = "spacesocial";
 
-const versions_types = [
-    { version: "mastodon", type: server_types.MASTODON },
-    { version: "glitchsoc", type: server_types.MASTODON },
-    { version: "chuckya", type: server_types.MASTODON },
-    { version: "firefish", type: server_types.FIREFISH },
-    { version: "iceshrimp", type: server_types.FIREFISH },
-    { version: "sharkey", type: server_types.FIREFISH },
-];
-
 export class Client {
-    #api;
     instance;
     app;
     #cache;
@@ -40,44 +24,29 @@ export class Client {
         client = new Client();
         window.peekie = client;
         client.load();
-        if (client.instance && client.instance !== server_types.INCOMPATIBLE)
-            client.#configureAPI();
         return client;
     }
 
     async init(host) {
         if (host.startsWith("https://")) host = host.substring(8);
         const url = `https://${host}/api/v1/instance`;
-        const data = await fetch(url).then(res => res.json()).catch(error => { console.log(error) });
+        const data = await fetch(url).then(res => res.json()).catch(error => { console.error(error) });
         if (!data) {
             console.error(`Failed to connect to ${host}`);
             alert(`Failed to connect to ${host}! Please try again later.`);
             return false;
         }
-        this.instance = {
-            host: host,
-            version: data.version,
-            type: server_types.INCOMPATIBLE,
-        };
-
-        for (let index in versions_types) {
-            const pair = versions_types[index];
-            if (data.version.toLowerCase().includes(pair.version)) {
-                this.instance.type = pair.type;
-                break;
-            }
-        }
-
+        
+        this.instance = new Instance(host, data.version);
         if (this.instance.type == server_types.INCOMPATIBLE) {
             console.error(`Server ${host} is not supported - ${data.version}`);
             alert(`Sorry, this app is not compatible with ${host}!`);
             return false;
         }
 
-        console.log(`Server is "${client.instance.type}" (or compatible).`);
+        console.log(`Server is "${this.instance.type}" (or compatible) with capabilities: [${this.instance.capabilities}].`);
 
-        this.#configureAPI();
-        this.app = await this.api.createApp(host);
+        this.app = await api.createApp(host);
 
         if (!this.app || !this.instance) {
             console.error("Failed to create app. Check the network logs for details.");
@@ -89,29 +58,12 @@ export class Client {
         return true;
     }
 
-    #configureAPI() {
-        switch (this.instance.type) {
-            case server_types.MASTODON:
-                this.api = mastodonAPI;
-                break;
-            case server_types.FIREFISH:
-                this.api = firefishAPI;
-                break;
-            /* not opening that can of worms for a while
-            case server_types.MISSKEY:
-                this.api = misskeyAPI;
-                break; */
-            default:
-                break;
-        }
-    }
-
     getOAuthUrl() {
-        return this.api.getOAuthUrl(this.app.secret);
+        return api.getOAuthUrl(this.app.secret);
     }
 
     async getToken(code) {
-        const token = await this.api.getToken(code);
+        const token = await api.getToken(code);
         if (!token) {
             console.error("Failed to obtain access token");
             return false;
@@ -120,15 +72,15 @@ export class Client {
     }
 
     async revokeToken() {
-        return await this.api.revokeToken();
+        return await api.revokeToken();
     }
 
     async getTimeline(last_post_id) {
-        return await this.api.getTimeline(last_post_id);
+        return await api.getTimeline(last_post_id);
     }
 
     async getPost(post_id, num_replies) {
-        return await this.api.getPost(post_id, num_replies);
+        return await api.getPost(post_id, num_replies);
     }
 
     putCacheUser(user) {
@@ -139,7 +91,7 @@ export class Client {
         let user = this.cache.users[user_id];
         if (user) return user;
 
-        user = await this.api.getUser(user_id);
+        user = await api.getUser(user_id);
         if (user) return user;
 
         return false;
@@ -166,7 +118,10 @@ export class Client {
 
     save() {
         localStorage.setItem(save_name, JSON.stringify({
-            instance: this.instance,
+            instance: {
+                host: this.instance.host,
+                version: this.instance.version,
+            },
             app: this.app,
         }));
     }
@@ -175,13 +130,13 @@ export class Client {
         let json = localStorage.getItem(save_name);
         if (!json) return false;
         let saved = JSON.parse(json);
-        this.instance = saved.instance;
+        this.instance = new Instance(saved.instance.host, saved.instance.version);
         this.app = saved.app;
         return true;
     }
 
     async logout() {
-        if (!this.instance || !this.app || !this.api) return;
+        if (!this.instance || !this.app) return;
         if (!await this.revokeToken()) {
             console.warn("Failed to log out correctly; ditching the old tokens anyways.");
         }
diff --git a/src/client/instance.js b/src/client/instance.js
new file mode 100644
index 0000000..ca737f1
--- /dev/null
+++ b/src/client/instance.js
@@ -0,0 +1,68 @@
+export const server_types = {
+    UNSUPPORTED: "unsupported",
+    MASTODON: "mastodon",
+    GLITCHSOC: "glitchsoc",
+    CHUCKYA: "chuckya",
+    FIREFISH: "firefish",
+    ICESHRIMP: "iceshrimp",
+    SHARKEY: "sharkey",
+};
+
+export const capabilities = {
+    MARKDOWN_CONTENT: "mdcontent",
+    REACTIONS: "reactions",
+};
+
+export class Instance {
+    host;
+    version;
+    capabilities;
+    type = server_types.UNSUPPORTED;
+
+    constructor(host, version) {
+        this.host = host;
+        this.version = version;
+        this.#setType(version);
+        this.capabilities = this.#getCapabilities(this.type);
+    }
+
+    #setType(version) {
+        if (version.constructor !== String) return;
+        let version_lower = version.toLowerCase();
+        for (let i = 1; i < Object.keys(server_types).length; i++) {
+            const check_type = Object.values(server_types)[i];
+            if (version_lower.includes(check_type)) {
+                this.type = check_type;
+                break;
+            }
+        }
+        if (this.type === server_types.UNSUPPORTED) return;
+    }
+
+    #getCapabilities(type) {
+        let c = [];
+        switch (type) {
+            case server_types.MASTODON:
+                break;
+            case server_types.GLITCHSOC:
+                c.push(capabilities.REACTIONS);
+                break;
+            case server_types.CHUCKYA:
+                c.push(capabilities.REACTIONS);
+                break;
+            case server_types.FIREFISH:
+                c.push(capabilities.REACTIONS);
+                break;
+            case server_types.ICESHRIMP:
+                c.push(capabilities.MARKDOWN_CONTENT);
+                c.push(capabilities.REACTIONS);
+                break;
+            case server_types.SHARKEY:
+                c.push(capabilities.REACTIONS);
+                break;
+            default:
+                break;
+        }
+        return c;
+    }
+}
diff --git a/src/post/post.js b/src/post/post.js
index f814460..00f3701 100644
--- a/src/post/post.js
+++ b/src/post/post.js
@@ -1,4 +1,5 @@
-import { Client, server_types } from '../client/client.js';
+import { Client } from '../client/client.js';
+import { capabilities, server_types } from '../client/instance.js';
 import { parseOne as parseEmoji, EMOJI_REGEX } from '../emoji.js';
 
 export default class Post {
@@ -20,33 +21,36 @@ export default class Post {
     async rich_text() {
         let text = this.text;
         if (!text) return text;
+        let client = Client.get();
 
         const markdown_tokens = [
             { tag: "pre", token: "```" },
             { tag: "code", token: "`" },
-            { tag: "strong", token: "**", regex: /\*{2}/g },
+            { tag: "strong", token: "**" },
             { tag: "strong", token: "__" },
-            { tag: "em", token: "*", regex: /\*/g },
+            { tag: "em", token: "*" },
             { tag: "em", token: "_" },
         ];
 
         let response = "";
-        let current;
+        let md_layer;
         let index = 0;
         while (index < text.length) {
             let sample = text.substring(index);
-            let allow_new = !current || !current.nostack;
+            let md_nostack = !(md_layer && md_layer.nostack);
 
             // handle newlines
-            if (allow_new && sample.startsWith('\n')) {
+            if (md_nostack && sample.startsWith('\n')) {
                 response += "<br>";
                 index++;
                 continue;
             }
 
             // handle mentions
-            // TODO: setup a better system for handling different server capabilities
-            if (Client.get().instance.type !== server_types.MASTODON && allow_new && sample.match(/^@[\w\-.]+@[\w\-.]+/g)) {
+            if (client.instance.capabilities.includes(capabilities.MARKDOWN_CONTENT)
+                && md_nostack
+                && sample.match(/^@[\w\-.]+@[\w\-.]+/g)
+            ) {
                 // find end of the mention
                 let length = 1;
                 while (index + length < text.length && /[a-z0-9-_.]/.test(text[index + length])) length++;
@@ -56,12 +60,12 @@ export default class Post {
                 let mention = text.substring(index, index + length);
 
                 // attempt to resolve mention to a user
-                let user = await Client.get().getUserByMention(mention);
+                let user = await client.getUserByMention(mention);
                 if (user) {
                     const out = `<a href="/${user.mention}" class="mention">` +
                         `<img src="${user.avatar_url}" class="mention-avatar" width="20" height="20">` +
                         '@' + user.username + '@' + user.host + "</a>";
-                    if (current) current.text += out;
+                    if (md_layer) md_layer.text += out;
                     else response += out;
                 } else {
                     response += mention;
@@ -71,72 +75,75 @@ export default class Post {
             }
 
             // handle links
-            if (Client.get().instance.type !== server_types.MASTODON && allow_new && sample.match(/^[a-z]{3,6}:\/\/[^\s]+/g)) {
+            if (client.instance.capabilities.includes(capabilities.MARKDOWN_CONTENT)
+                && md_nostack
+                && sample.match(/^[a-z]{3,6}:\/\/[^\s]+/g)
+            ) {
                 // get length of link
                 let length = text.substring(index).search(/\s|$/g);
                 let url = text.substring(index, index + length);
                 let out = `<a href="${url}">${url}</a>`;
-                if (current) current.text += out;
+                if (md_layer) md_layer.text += out;
                 else response += out;
                 index += length;
                 continue;
             }
 
             // handle emojis
-            if (allow_new && sample.match(/^:[\w\-.]{0,32}:/g)) {
+            if (md_nostack && sample.match(/^:[\w\-.]{0,32}:/g)) {
                 // find the emoji name
                 let length = text.substring(index + 1).search(':');
                 if (length <= 0) return text;
                 let emoji_name = text.substring(index + 1, index + length + 1);
-                let emoji = Client.get().getEmoji(emoji_name + '@' + this.user.host);
+                let emoji = client.getEmoji(emoji_name + '@' + this.user.host);
 
                 index += length + 2;
 
                 if (!emoji) {
                     let out = ':' + emoji_name + ':';
-                    if (current) current.text += out;
+                    if (md_layer) md_layer.text += out;
                     else response += out;
                     continue;
                 }
 
                 let out = emoji.html;
-                if (current) current.text += out;
+                if (md_layer) md_layer.text += out;
                 else response += out;
                 continue;
             }
 
             // handle markdown
-            // TODO: handle misskey-flavoured markdown
-            if (current) {
-                // try to pop stack
-                if (sample.startsWith(current.token)) {
-                    index += current.token.length;
-                    let out = `<${current.tag}>${current.text}</${current.tag}>`;
-                    if (current.token === '```')
-                        out = `<code><pre>${current.text}</pre></code>`;
-                    if (current.parent) current.parent.text += out;
+            // TODO: handle misskey-flavoured markdown(?)
+            if (md_layer) {
+                // try to pop layer
+                if (sample.startsWith(md_layer.token)) {
+                    index += md_layer.token.length;
+                    let out = `<${md_layer.tag}>${md_layer.text}</${md_layer.tag}>`;
+                    if (md_layer.token === '```')
+                        out = `<code><pre>${md_layer.text}</pre></code>`;
+                    if (md_layer.parent) md_layer.parent.text += out;
                     else response += out;
-                    current = current.parent;
+                    md_layer = md_layer.parent;
                 } else {
-                    current.text += sample[0];
+                    md_layer.text += sample[0];
                     index++;
                 }
-            } else if (allow_new) {
-                // can we add to stack?
+            } else if (md_nostack) {
+                // should we add a layer?
                 let pushed = false;
                 for (let i = 0; i < markdown_tokens.length; i++) {
                     let item = markdown_tokens[i];
                     if (sample.startsWith(item.token)) {
-                        let new_current = {
+                        let new_md_layer = {
                             token: item.token,
                             tag: item.tag,
                             text: "",
-                            parent: current,
+                            parent: md_layer,
                         };
-                        if (item.token === '```' || item.token === '`') new_current.nostack = true;
-                        current = new_current;
+                        if (item.token === '```' || item.token === '`') new_md_layer.nostack = true;
+                        md_layer = new_md_layer;
                         pushed = true;
-                        index += current.token.length;
+                        index += md_layer.token.length;
                         break;
                     }
                 }
@@ -148,11 +155,11 @@ export default class Post {
         }
 
         // destroy the remaining stack
-        while (current) {
-            let out = current.token + current.text;
-            if (current.parent) current.parent.text += out;
+        while (md_layer) {
+            let out = md_layer.token + md_layer.text;
+            if (md_layer.parent) md_layer.parent.text += out;
             else response += out;
-            current = current.parent;
+            md_layer = md_layer.parent;
         }
 
         return response;