Newer
Older
percord / src / connections / Reddit / index.ts
/*
	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
	Copyright (C) 2023 Spacebar and Spacebar Contributors

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published
	by the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

import { ConnectedAccount, Connection, ConnectionLoader, DiscordApiErrors } from "@spacebar/util";
import wretch from "wretch";
import { GenericOAuthSettings as RedditSettings } from "../GenericOAuthSettings";
import { ConnectedAccountCommonOAuthTokenResponse, ConnectionCallbackSchema } from "@spacebar/schemas";

export interface UserResponse {
    verified: boolean;
    coins: number;
    id: string;
    is_mod: boolean;
    has_verified_email: boolean;
    total_karma: number;
    name: string;
    created: number;
    gold_creddits: number;
    created_utc: number;
}

export interface ErrorResponse {
    message: string;
    error: number;
}

export default class RedditConnection extends Connection {
    public readonly id = "reddit";
    public friendlyName = "Reddit";
    public setupUrl = "https://www.reddit.com/prefs/apps";
    public requiredScopes = []; // Does not seem to offer platform-side scope controls

    public readonly authorizeUrl = "https://www.reddit.com/api/v1/authorize";
    public readonly tokenUrl = "https://www.reddit.com/api/v1/access_token";
    public readonly userInfoUrl = "https://oauth.reddit.com/api/v1/me";
    public readonly scopes = ["identity"];
    settings: RedditSettings = new RedditSettings();

    init(): void {
        this.settings = ConnectionLoader.getConnectionConfig<RedditSettings>(this.id, this.settings);

        if (this.settings.enabled && (!this.settings.clientId || !this.settings.clientSecret)) throw new Error(`Invalid settings for connection ${this.id}`);
    }

    public get isConfigured(): boolean {
        return !!this.settings.clientId && !!this.settings.clientSecret;
    }

    getAuthorizationUrl(userId: string): string {
        const state = this.createState(userId);
        const url = new URL(this.authorizeUrl);

        url.searchParams.append("client_id", this.settings.clientId as string);
        url.searchParams.append("redirect_uri", this.getRedirectUri());
        url.searchParams.append("response_type", "code");
        url.searchParams.append("scope", this.scopes.join(" "));
        url.searchParams.append("state", state);
        return url.toString();
    }

    getTokenUrl(): string {
        return this.tokenUrl;
    }

    async exchangeCode(state: string, code: string): Promise<ConnectedAccountCommonOAuthTokenResponse> {
        this.validateState(state);

        const url = this.getTokenUrl();

        return wretch(url.toString())
            .headers({
                Accept: "application/json",
                Authorization: `Basic ${Buffer.from(`${this.settings.clientId}:${this.settings.clientSecret}`).toString("base64")}`,
                "Content-Type": "application/x-www-form-urlencoded",
            })
            .body(
                new URLSearchParams({
                    grant_type: "authorization_code",
                    code: code,
                    redirect_uri: this.getRedirectUri(),
                }),
            )
            .post()
            .json<ConnectedAccountCommonOAuthTokenResponse>()
            .catch((e) => {
                console.error(e);
                throw DiscordApiErrors.GENERAL_ERROR;
            });
    }

    async getUser(token: string): Promise<UserResponse> {
        const url = new URL(this.userInfoUrl);
        return wretch(url.toString())
            .headers({
                Authorization: `Bearer ${token}`,
            })
            .get()
            .json<UserResponse>()
            .catch((e) => {
                console.error(e);
                throw DiscordApiErrors.GENERAL_ERROR;
            });
    }

    async handleCallback(params: ConnectionCallbackSchema): Promise<ConnectedAccount | null> {
        const { state, code } = params;
        if (!code) throw new Error("No code provided");

        const userId = this.getUserId(state);
        const tokenData = await this.exchangeCode(state, code);
        const userInfo = await this.getUser(tokenData.access_token);

        const exists = await this.hasConnection(userId, userInfo.id.toString());

        if (exists) return null;

        // TODO: connection metadata

        return await this.createConnection({
            user_id: userId,
            external_id: userInfo.id.toString(),
            friend_sync: params.friend_sync,
            name: userInfo.name,
            verified: userInfo.has_verified_email,
            type: this.id,
        });
    }
}