server/database/entities/Status.ts

446 lines
9.5 KiB
TypeScript
Raw Normal View History

2023-09-12 22:48:10 +02:00
import { getConfig } from "@config";
import {
BaseEntity,
Column,
CreateDateColumn,
Entity,
2023-09-22 03:09:14 +02:00
JoinTable,
2023-09-12 22:48:10 +02:00
ManyToMany,
ManyToOne,
PrimaryGeneratedColumn,
2023-09-27 00:19:10 +02:00
RemoveOptions,
2023-10-28 22:21:04 +02:00
Tree,
TreeChildren,
TreeParent,
2023-09-12 22:48:10 +02:00
UpdateDateColumn,
} from "typeorm";
import { APIStatus } from "~types/entities/status";
import { User, userRelations } from "./User";
2023-09-12 22:48:10 +02:00
import { Application } from "./Application";
import { Emoji } from "./Emoji";
import { Instance } from "./Instance";
2023-10-28 22:21:04 +02:00
import { Like } from "./Like";
import { AppDataSource } from "~database/datasource";
2023-09-12 22:48:10 +02:00
const config = getConfig();
2023-10-23 03:47:04 +02:00
export const statusRelations = [
"account",
"reblog",
"in_reply_to_post",
"instance",
"in_reply_to_post.account",
"application",
"emojis",
"mentions",
];
export const statusAndUserRelations = [
...statusRelations,
...["account.relationships", "account.pinned_notes", "account.instance"],
];
2023-09-12 22:48:10 +02:00
/**
2023-09-28 20:19:21 +02:00
* Represents a status (i.e. a post)
2023-09-12 22:48:10 +02:00
*/
@Entity({
name: "statuses",
})
2023-10-28 22:21:04 +02:00
@Tree("closure-table")
2023-09-12 22:48:10 +02:00
export class Status extends BaseEntity {
2023-09-28 20:19:21 +02:00
/**
* The unique identifier for this status.
*/
2023-09-12 22:48:10 +02:00
@PrimaryGeneratedColumn("uuid")
id!: string;
2023-09-28 20:19:21 +02:00
/**
* The user account that created this status.
*/
2023-09-13 02:29:13 +02:00
@ManyToOne(() => User, user => user.id)
2023-09-12 22:48:10 +02:00
account!: User;
2023-09-28 20:19:21 +02:00
/**
* The date and time when this status was created.
*/
2023-09-12 22:48:10 +02:00
@CreateDateColumn()
created_at!: Date;
2023-09-28 20:19:21 +02:00
/**
* The date and time when this status was last updated.
*/
2023-09-12 22:48:10 +02:00
@UpdateDateColumn()
updated_at!: Date;
2023-09-28 20:19:21 +02:00
/**
* The status that this status is a reblog of, if any.
*/
2023-09-13 02:29:13 +02:00
@ManyToOne(() => Status, status => status.id, {
2023-09-12 22:48:10 +02:00
nullable: true,
2023-10-23 03:47:04 +02:00
onDelete: "SET NULL",
2023-09-12 22:48:10 +02:00
})
2023-10-23 03:47:04 +02:00
reblog?: Status | null;
2023-09-12 22:48:10 +02:00
2023-09-28 20:19:21 +02:00
/**
* Whether this status is a reblog.
*/
2023-09-12 22:48:10 +02:00
@Column("boolean")
isReblog!: boolean;
2023-09-28 20:19:21 +02:00
/**
* The content of this status.
*/
2023-09-12 22:48:10 +02:00
@Column("varchar", {
default: "",
})
content!: string;
2023-09-28 20:19:21 +02:00
/**
* The visibility of this status.
*/
2023-09-12 22:48:10 +02:00
@Column("varchar")
visibility!: APIStatus["visibility"];
2023-09-28 20:19:21 +02:00
/**
* The raw object that this status is a reply to, if any.
*/
2023-10-28 22:21:04 +02:00
@TreeParent({
2023-10-23 03:47:04 +02:00
onDelete: "SET NULL",
})
in_reply_to_post!: Status | null;
2023-10-28 22:21:04 +02:00
@TreeChildren()
replies!: Status[];
/**
* The status' instance
*/
@ManyToOne(() => Instance, {
2023-09-27 00:19:10 +02:00
nullable: true,
})
instance!: Instance | null;
2023-09-27 00:19:10 +02:00
2023-09-28 20:19:21 +02:00
/**
* Whether this status is sensitive.
*/
2023-09-12 22:48:10 +02:00
@Column("boolean")
sensitive!: boolean;
2023-09-28 20:19:21 +02:00
/**
* The spoiler text for this status.
*/
2023-09-12 22:48:10 +02:00
@Column("varchar", {
default: "",
})
spoiler_text!: string;
2023-09-28 20:19:21 +02:00
/**
* The application associated with this status, if any.
*/
2023-09-13 02:29:13 +02:00
@ManyToOne(() => Application, app => app.id, {
nullable: true,
2023-09-12 22:48:10 +02:00
})
application!: Application | null;
2023-09-28 20:19:21 +02:00
/**
* The emojis associated with this status.
*/
2023-09-13 02:29:13 +02:00
@ManyToMany(() => Emoji, emoji => emoji.id)
2023-09-22 03:09:14 +02:00
@JoinTable()
2023-09-12 22:48:10 +02:00
emojis!: Emoji[];
/**
* The users mentioned (excluding followers and such)
*/
@ManyToMany(() => User, user => user.id)
@JoinTable()
mentions!: User[];
2023-09-28 20:19:21 +02:00
/**
* Removes this status from the database.
* @param options The options for removing this status.
* @returns A promise that resolves when the status has been removed.
*/
2023-09-27 00:19:10 +02:00
async remove(options?: RemoveOptions | undefined) {
// Delete object
2023-10-28 22:21:04 +02:00
// Get all associated Likes and remove them as well
await Like.delete({
liked: {
id: this.id,
},
});
2023-09-27 01:08:05 +02:00
return await super.remove(options);
2023-09-27 00:19:10 +02:00
}
async parseEmojis(string: string) {
const emojis = [...string.matchAll(/:([a-zA-Z0-9_]+):/g)].map(
match => match[1]
);
const emojiObjects = await Promise.all(
emojis.map(async emoji => {
const emojiObject = await Emoji.findOne({
where: {
shortcode: emoji,
},
});
return emojiObject;
})
);
return emojiObjects.filter(emoji => emoji !== null) as Emoji[];
}
/**
* Returns whether this status is viewable by a user.
* @param user The user to check.
* @returns Whether this status is viewable by the user.
*/
isViewableByUser(user: User | null) {
const relationship = user?.relationships.find(
rel => rel.id === this.account.id
);
if (this.visibility === "public") return true;
else if (this.visibility === "unlisted") return true;
else if (this.visibility === "private") {
return !!relationship?.following;
} else {
return user && this.mentions.includes(user);
}
}
/**
* Return all the ancestors of this post,
*/
async getAncestors(fetcher: User | null) {
const max = fetcher ? 4096 : 40;
const ancestors = [];
let id = this.in_reply_to_post?.id;
while (ancestors.length < max && id) {
const currentStatus = await Status.findOne({
where: {
id: id,
},
2023-10-25 00:23:22 +02:00
relations: statusAndUserRelations,
});
if (currentStatus) {
if (currentStatus.isViewableByUser(fetcher)) {
ancestors.push(currentStatus);
}
id = currentStatus.in_reply_to_post?.id;
} else {
break;
}
}
return ancestors;
}
/**
* Return all the descendants of this post,
*/
async getDescendants(fetcher: User | null) {
const max = fetcher ? 4096 : 60;
2023-10-28 22:21:04 +02:00
const descendants = await AppDataSource.getTreeRepository(
Status
).findDescendantsTree(this, {
depth: fetcher ? 20 : undefined,
2023-10-25 00:23:22 +02:00
relations: statusAndUserRelations,
});
2023-10-28 22:21:04 +02:00
// Go through .replies of each descendant recursively and add them to the list
const flatten = (descendants: Status): Status[] => {
const flattened = [];
for (const descendant of descendants.replies) {
if (descendant.isViewableByUser(fetcher)) {
flattened.push(descendant);
}
flattened.push(...flatten(descendant));
}
2023-10-28 22:21:04 +02:00
return flattened;
};
const flattened = flatten(descendants);
return flattened.slice(0, max);
}
2023-09-28 20:19:21 +02:00
/**
* Creates a new status and saves it to the database.
* @param data The data for the new status.
* @returns A promise that resolves with the new status.
*/
2023-09-22 03:09:14 +02:00
static async createNew(data: {
account: User;
application: Application | null;
content: string;
visibility: APIStatus["visibility"];
sensitive: boolean;
spoiler_text: string;
emojis: Emoji[];
2023-09-27 00:19:10 +02:00
reply?: {
status: Status;
user: User;
2023-09-27 00:19:10 +02:00
};
2023-09-22 03:09:14 +02:00
}) {
const newStatus = new Status();
newStatus.account = data.account;
newStatus.application = data.application ?? null;
newStatus.content = data.content;
newStatus.visibility = data.visibility;
newStatus.sensitive = data.sensitive;
newStatus.spoiler_text = data.spoiler_text;
newStatus.emojis = data.emojis;
newStatus.isReblog = false;
newStatus.mentions = [];
newStatus.instance = data.account.instance;
2023-09-22 03:09:14 +02:00
2023-09-27 00:19:10 +02:00
if (data.reply) {
newStatus.in_reply_to_post = data.reply.status;
2023-09-27 00:19:10 +02:00
}
// Get people mentioned in the content
const mentionedPeople = [
...data.content.matchAll(/@([a-zA-Z0-9_]+)/g),
].map(match => {
2023-10-16 08:04:03 +02:00
return `${config.http.base_url}/users/${match[1]}`;
2023-09-27 00:19:10 +02:00
});
// Get list of mentioned users
await Promise.all(
mentionedPeople.map(async person => {
// Check if post is in format @username or @username@instance.com
// If is @username, the user is a local user
const instanceUrl =
person.split("@").length === 3
? person.split("@")[2]
: null;
if (instanceUrl) {
const user = await User.findOne({
where: {
username: person.split("@")[1],
// If contains instanceUrl
instance: {
base_url: instanceUrl,
},
},
relations: userRelations,
});
newStatus.mentions.push(user as User);
} else {
const user = await User.findOne({
where: {
username: person.split("@")[1],
},
relations: userRelations,
});
newStatus.mentions.push(user as User);
}
})
);
2023-09-22 03:09:14 +02:00
await newStatus.save();
return newStatus;
}
2023-10-28 22:21:04 +02:00
async isFavouritedBy(user: User) {
const like = await Like.findOne({
where: {
liker: {
id: user.id,
},
liked: {
id: this.id,
},
},
relations: ["liker"],
});
return !!like;
}
2023-09-28 20:19:21 +02:00
/**
* Converts this status to an API status.
* @returns A promise that resolves with the API status.
*/
2023-10-28 22:21:04 +02:00
async toAPI(user?: User): Promise<APIStatus> {
const reblogCount = await Status.count({
where: {
reblog: {
id: this.id,
},
},
relations: ["reblog"],
});
const repliesCount = await Status.count({
where: {
in_reply_to_post: {
id: this.id,
},
},
relations: ["in_reply_to_post"],
});
2023-10-28 22:21:04 +02:00
const favourited = user ? await this.isFavouritedBy(user) : false;
const favourites_count = await Like.count({
where: {
liked: {
id: this.id,
},
},
relations: ["liked"],
});
return {
id: this.id,
2023-10-23 03:47:04 +02:00
in_reply_to_id: this.in_reply_to_post?.id || null,
in_reply_to_account_id: this.in_reply_to_post?.account.id || null,
account: await this.account.toAPI(),
created_at: new Date(this.created_at).toISOString(),
application: (await this.application?.toAPI()) || null,
card: null,
content: this.content,
emojis: await Promise.all(this.emojis.map(emoji => emoji.toAPI())),
2023-10-28 22:21:04 +02:00
favourited,
favourites_count: favourites_count,
media_attachments: [],
mentions: await Promise.all(
this.mentions.map(async m => await m.toAPI())
),
language: null,
muted: false,
pinned: this.account.pinned_notes.some(note => note.id === this.id),
poll: null,
reblog: this.reblog ? await this.reblog.toAPI() : null,
reblogged: !!this.reblog,
reblogs_count: reblogCount,
replies_count: repliesCount,
2023-10-28 22:21:04 +02:00
sensitive: this.sensitive,
spoiler_text: this.spoiler_text,
tags: [],
uri: `${config.http.base_url}/users/${this.account.username}/statuses/${this.id}`,
visibility: "public",
url: `${config.http.base_url}/users/${this.account.username}/statuses/${this.id}`,
bookmarked: false,
quote: null,
quote_id: undefined,
};
2023-09-12 22:48:10 +02:00
}
}