elk/composables/users.ts

407 lines
14 KiB
TypeScript
Raw Permalink Normal View History

2023-01-19 16:20:56 +00:00
import { withoutProtocol } from 'ufo'
import type { mastodon } from 'masto'
import type { EffectScope, Ref } from 'vue'
2023-05-02 00:58:55 +01:00
import type { MaybeRefOrGetter, RemovableRef } from '@vueuse/core'
2023-01-15 08:38:02 +00:00
import type { ElkMasto } from './masto/masto'
import type { UserLogin } from '~/types'
import type { Overwrite } from '~/types/utils'
import {
DEFAULT_POST_CHARS_LIMIT,
STORAGE_KEY_CURRENT_USER_HANDLE,
STORAGE_KEY_NODES,
STORAGE_KEY_NOTIFICATION,
STORAGE_KEY_NOTIFICATION_POLICY,
STORAGE_KEY_SERVERS,
STORAGE_KEY_USERS,
} from '~/constants'
import type { PushNotificationPolicy, PushNotificationRequest } from '~/composables/push-notifications/types'
import { useAsyncIDBKeyval } from '~/composables/idb'
2022-11-22 23:08:36 +00:00
const mock = process.mock
function initializeUsers(): Promise<Ref<UserLogin[]> | RemovableRef<UserLogin[]>> | Ref<UserLogin[]> | RemovableRef<UserLogin[]> {
let defaultUsers = mock ? [mock.user] : []
// Backward compatibility with localStorage
let removeUsersOnLocalStorage = false
if (globalThis?.localStorage) {
const usersOnLocalStorageString = globalThis.localStorage.getItem(STORAGE_KEY_USERS)
if (usersOnLocalStorageString) {
defaultUsers = JSON.parse(usersOnLocalStorageString)
removeUsersOnLocalStorage = true
}
}
2024-02-24 16:46:14 +00:00
const users = import.meta.server
? ref<UserLogin[]>(defaultUsers)
: useAsyncIDBKeyval<UserLogin[]>(STORAGE_KEY_USERS, defaultUsers, { deep: true })
if (removeUsersOnLocalStorage)
globalThis.localStorage.removeItem(STORAGE_KEY_USERS)
return users
}
2024-02-24 16:46:14 +00:00
const users = import.meta.server ? initializeUsers() as Ref<UserLogin[]> | RemovableRef<UserLogin[]> : await initializeUsers()
const nodes = useLocalStorage<Record<string, any>>(STORAGE_KEY_NODES, {}, { deep: true })
const currentUserHandle = useLocalStorage<string>(STORAGE_KEY_CURRENT_USER_HANDLE, mock ? mock.user.account.id : '')
export const instanceStorage = useLocalStorage<Record<string, mastodon.v1.Instance>>(STORAGE_KEY_SERVERS, mock ? mock.server : {}, { deep: true })
2022-11-22 23:08:36 +00:00
2023-01-15 09:44:36 +00:00
export type ElkInstance = Partial<mastodon.v1.Instance> & {
uri: string
/** support GoToSocial */
accountDomain?: string | null
}
export function getInstanceCache(server: string): mastodon.v1.Instance | undefined {
return instanceStorage.value[server]
}
2023-01-15 08:38:02 +00:00
2022-11-22 23:08:36 +00:00
export const currentUser = computed<UserLogin | undefined>(() => {
if (currentUserHandle.value) {
const user = users.value.find(user => user.account?.acct === currentUserHandle.value)
2022-11-22 23:08:36 +00:00
if (user)
return user
}
// Fallback to the first account
2022-11-23 04:25:48 +00:00
return users.value[0]
2022-11-22 23:08:36 +00:00
})
2023-01-15 08:38:02 +00:00
const publicInstance = ref<ElkInstance | null>(null)
export const currentInstance = computed<null | ElkInstance>(() => currentUser.value ? instanceStorage.value[currentUser.value.server] ?? null : publicInstance.value)
2022-12-13 13:49:22 +00:00
2023-01-15 09:44:36 +00:00
export function getInstanceDomain(instance: ElkInstance) {
2023-01-19 16:20:56 +00:00
return instance.accountDomain || withoutProtocol(instance.uri)
2023-01-15 09:44:36 +00:00
}
export const publicServer = ref('')
2022-11-29 20:51:52 +00:00
export const currentServer = computed<string>(() => currentUser.value?.server || publicServer.value)
2022-11-22 23:08:36 +00:00
export const currentNodeInfo = computed<null | Record<string, any>>(() => nodes.value[currentServer.value] || null)
export const isGotoSocial = computed(() => currentNodeInfo.value?.software?.name === 'gotosocial')
export const isGlitchEdition = computed(() => currentInstance.value?.version?.includes('+glitch'))
// when multiple tabs: we need to reload window when sign in, switch account or sign out
2024-02-24 16:46:14 +00:00
if (import.meta.client) {
const windowReload = () => {
document.visibilityState === 'visible' && window.location.reload()
}
watch(currentUserHandle, async (handle, oldHandle) => {
// when sign in or switch account
if (handle) {
if (handle === currentUser.value?.account?.acct) {
// when sign in, the other tab will not have the user, idb is not reactive
const newUser = users.value.find(user => user.account?.acct === handle)
// if the user is there, then we are switching account
if (newUser) {
// check if the change is on current tab: if so, don't reload
if (document.hasFocus() || document.visibilityState === 'visible')
return
}
}
window.addEventListener('visibilitychange', windowReload, { capture: true })
}
// when sign out
else if (oldHandle) {
const oldUser = users.value.find(user => user.account?.acct === oldHandle)
// when sign out, the other tab will not have the user, idb is not reactive
if (oldUser)
window.addEventListener('visibilitychange', windowReload, { capture: true })
}
}, { immediate: true, flush: 'post' })
}
2022-11-23 03:48:01 +00:00
export function useUsers() {
return users
}
2023-05-02 00:58:55 +01:00
export function useSelfAccount(user: MaybeRefOrGetter<mastodon.v1.Account | undefined>) {
return computed(() => currentUser.value && resolveUnref(user)?.id === currentUser.value.account.id)
}
2023-01-15 08:38:02 +00:00
export const characterLimit = computed(() => currentInstance.value?.configuration?.statuses.maxCharacters ?? DEFAULT_POST_CHARS_LIMIT)
2023-01-15 08:38:02 +00:00
export async function loginTo(masto: ElkMasto, user: Overwrite<UserLogin, { account?: mastodon.v1.AccountCredentials }>) {
const { client } = masto
2023-01-15 08:38:02 +00:00
const instance = mastoLogin(masto, user)
// GoToSocial only API
const url = `https://${user.server}`
fetch(`${url}/nodeinfo/2.0`).then(r => r.json()).then((info) => {
nodes.value[user.server] = info
2023-01-15 10:11:19 +00:00
}).catch(() => undefined)
2022-11-29 20:51:52 +00:00
if (!user?.token) {
2023-01-15 08:38:02 +00:00
publicServer.value = user.server
2023-01-12 16:01:18 +00:00
publicInstance.value = instance
2023-01-15 08:38:02 +00:00
return
2022-11-29 20:51:52 +00:00
}
2023-01-15 08:38:02 +00:00
function getUser() {
return users.value.find(u => u.server === user.server && u.token === user.token)
}
2023-01-15 08:38:02 +00:00
const account = getUser()?.account
if (account)
currentUserHandle.value = account.acct
2023-01-15 08:38:02 +00:00
const [me, pushSubscription] = await Promise.all([
fetchAccountInfo(client.value, user.server),
2023-01-15 08:38:02 +00:00
// if PWA is not enabled, don't get push subscription
useAppConfig().pwaEnabled
2023-01-15 08:38:02 +00:00
// we get 404 response instead empty data
? client.value.v1.push.subscription.fetch().catch(() => Promise.resolve(undefined))
2023-01-15 08:38:02 +00:00
: Promise.resolve(undefined),
])
const existingUser = getUser()
if (existingUser) {
existingUser.account = me
existingUser.pushSubscription = pushSubscription
}
2023-01-15 08:38:02 +00:00
else {
users.value.push({
...user,
account: me,
pushSubscription,
})
}
currentUserHandle.value = me.acct
2022-11-22 23:08:36 +00:00
}
2022-11-23 04:20:59 +00:00
const accountPreferencesMap = new Map<string, Partial<mastodon.v1.Preference>>()
/**
2024-01-09 08:56:15 +00:00
* @param account
* @returns `true` when user ticked the preference to always expand posts with content warnings
*/
export function getExpandSpoilersByDefault(account: mastodon.v1.AccountCredentials) {
return accountPreferencesMap.get(account.acct)?.['reading:expand:spoilers'] ?? false
}
/**
2024-01-09 08:56:15 +00:00
* @param account
* @returns `true` when user selected "Always show media" as Media Display preference
*/
export function getExpandMediaByDefault(account: mastodon.v1.AccountCredentials) {
2024-02-24 16:46:14 +00:00
return accountPreferencesMap.get(account.acct)?.['reading:expand:media'] === 'show_all'
}
/**
2024-01-09 08:56:15 +00:00
* @param account
* @returns `true` when user selected "Always hide media" as Media Display preference
*/
export function getHideMediaByDefault(account: mastodon.v1.AccountCredentials) {
2024-02-24 16:46:14 +00:00
return accountPreferencesMap.get(account.acct)?.['reading:expand:media'] === 'hide_all'
}
2024-01-09 08:56:15 +00:00
export async function fetchAccountInfo(client: mastodon.rest.Client, server: string) {
// Try to fetch user preferences if the backend supports it.
const fetchPrefs = async (): Promise<Partial<mastodon.v1.Preference>> => {
try {
return await client.v1.preferences.fetch()
}
catch (e) {
console.warn(`Cannot fetch preferences: ${e}`)
return {}
}
}
const [account, preferences] = await Promise.all([
client.v1.accounts.verifyCredentials(),
fetchPrefs(),
])
if (!account.acct.includes('@')) {
const webDomain = getInstanceDomainFromServer(server)
account.acct = `${account.acct}@${webDomain}`
}
// TODO: lazy load preferences
accountPreferencesMap.set(account.acct, preferences)
2023-01-15 08:38:02 +00:00
cacheAccount(account, server, true)
return account
}
export function getInstanceDomainFromServer(server: string) {
const instance = getInstanceCache(server)
const webDomain = instance ? getInstanceDomain(instance) : server
return webDomain
}
2023-01-15 08:38:02 +00:00
export async function refreshAccountInfo() {
const account = await fetchAccountInfo(useMastoClient(), currentServer.value)
currentUser.value!.account = account
return account
}
export async function removePushNotificationData(user: UserLogin, fromSWPushManager = true) {
// clear push subscription
user.pushSubscription = undefined
const { acct } = user.account
// clear request notification permission
delete useLocalStorage<PushNotificationRequest>(STORAGE_KEY_NOTIFICATION, {}).value[acct]
// clear push notification policy
delete useLocalStorage<PushNotificationPolicy>(STORAGE_KEY_NOTIFICATION_POLICY, {}).value[acct]
const pwaEnabled = useAppConfig().pwaEnabled
const pwa = useNuxtApp().$pwa
const registrationError = pwa?.registrationError === true
const unregister = pwaEnabled && !registrationError && pwa?.registrationError === true && fromSWPushManager
2022-12-23 18:28:10 +00:00
// we remove the sw push manager if required and there are no more accounts with subscriptions
if (unregister && (users.value.length === 0 || users.value.every(u => !u.pushSubscription))) {
// clear sw push subscription
try {
const registration = await navigator.serviceWorker.ready
const subscription = await registration.pushManager.getSubscription()
if (subscription)
await subscription.unsubscribe()
}
catch {
// just ignore
}
}
}
export async function removePushNotifications(user: UserLogin) {
2022-12-23 18:28:10 +00:00
if (!user.pushSubscription)
return
// unsubscribe push notifications
2024-01-09 08:56:15 +00:00
await useMastoClient().v1.push.subscription.remove().catch(() => Promise.resolve())
2023-01-15 08:38:02 +00:00
}
export async function switchUser(user: UserLogin) {
const masto = useMasto()
await loginTo(masto, user)
// This only cleans up the URL; page content should stay the same
const route = useRoute()
const router = useRouter()
if ('server' in route.params && user?.token && !useNuxtApp()._processingMiddleware) {
await router.push({
...route,
force: true,
})
}
}
export async function signOut() {
2022-11-23 04:20:59 +00:00
// TODO: confirm
if (!currentUser.value)
return
const masto = useMasto()
2022-11-26 19:33:36 +00:00
const _currentUserId = currentUser.value.account.id
const index = users.value.findIndex(u => u.account?.id === _currentUserId)
if (index !== -1) {
// Clear stale data
2022-12-13 13:22:27 +00:00
clearUserLocalStorage()
if (!users.value.some((u, i) => u.server === currentUser.value!.server && i !== index))
delete instanceStorage.value[currentUser.value.server]
2022-11-23 04:20:59 +00:00
await removePushNotifications(currentUser.value)
await removePushNotificationData(currentUser.value)
currentUserHandle.value = ''
2022-11-26 19:33:36 +00:00
// Remove the current user from the users
users.value.splice(index, 1)
}
// Set currentUserId to next user if available
currentUserHandle.value = users.value[0]?.account?.acct
2022-11-26 19:33:36 +00:00
if (!currentUserHandle.value)
await useRouter().push('/')
2022-11-23 04:20:59 +00:00
loginTo(masto, currentUser.value || { server: publicServer.value })
2022-11-23 04:20:59 +00:00
}
2022-12-02 02:18:57 +00:00
export function checkLogin() {
if (!currentUser.value) {
openSigninDialog()
return false
}
return true
}
2022-12-13 13:22:27 +00:00
interface UseUserLocalStorageCache {
scope: EffectScope
value: Ref<Record<string, any>>
}
2022-12-13 13:22:27 +00:00
/**
* Create reactive storage for the current user
2024-01-09 08:56:15 +00:00
* @param key
* @param initial
2022-12-13 13:22:27 +00:00
*/
2023-01-14 10:09:17 +00:00
export function useUserLocalStorage<T extends object>(key: string, initial: () => T): Ref<T> {
2024-02-24 16:46:14 +00:00
if (import.meta.server || process.test)
2023-01-14 10:09:17 +00:00
return shallowRef(initial())
// @ts-expect-error bind value to the function
const map: Map<string, UseUserLocalStorageCache> = useUserLocalStorage._ = useUserLocalStorage._ || new Map()
if (!map.has(key)) {
const scope = effectScope(true)
const value = scope.run(() => {
const all = useLocalStorage<Record<string, T>>(key, {}, { deep: true })
return computed(() => {
const id = currentUser.value?.account.id
? currentUser.value.account.acct
: '[anonymous]'
// Backward compatibility, respect webDomain in acct
// In previous versions, acct was username@server instead of username@webDomain
// for example: elk@m.webtoo.ls instead of elk@webtoo.ls
if (!all.value[id]) {
const [username, webDomain] = id.split('@')
const server = currentServer.value
if (webDomain && server && server !== webDomain) {
const oldId = `${username}@${server}`
const outdatedSettings = all.value[oldId]
if (outdatedSettings) {
const newAllValue = { ...all.value, [id]: outdatedSettings }
delete newAllValue[oldId]
all.value = newAllValue
}
}
all.value[id] = Object.assign(initial(), all.value[id] || {})
}
return all.value[id]
})
})
map.set(key, { scope, value: value! })
}
2023-01-14 10:09:17 +00:00
return map.get(key)!.value as Ref<T>
2022-12-13 13:22:27 +00:00
}
/**
* Clear all storages for the given account
2024-01-09 08:56:15 +00:00
* @param account
2022-12-13 13:22:27 +00:00
*/
2023-01-08 06:21:09 +00:00
export function clearUserLocalStorage(account?: mastodon.v1.Account) {
2022-12-13 13:22:27 +00:00
if (!account)
account = currentUser.value?.account
if (!account)
return
2023-01-19 16:20:56 +00:00
const id = `${account.acct}@${currentInstance.value ? getInstanceDomain(currentInstance.value) : currentServer.value}`
2022-12-13 14:03:30 +00:00
// @ts-expect-error bind value to the function
const cacheMap = useUserLocalStorage._ as Map<string, UseUserLocalStorageCache> | undefined
cacheMap?.forEach(({ value }) => {
if (value.value[id])
delete value.value[id]
2022-12-13 13:22:27 +00:00
})
}