mirrors/PeerTube
1
0
Fork 0
mirror of https://github.com/Chocobozzz/PeerTube.git synced 2024-05-17 04:12:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add notification plugin hook

Browse source
This commit is contained in:
Chocobozzz 2022-08-03 11:33:43 +02:00
parent 0260dc8aca
commit 785f1897a4
No known key found for this signature in database
GPG key ID: 583A612D890159BE
23 changed files with 61 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
server/lib/notifier/notifier.ts
View file

@ -7,12 +7,12 @@ import { MAbuseFull, MAbuseMessage, MActorFollowFull, MApplication, MPlugin } fr
import { MCommentOwnerVideo, MVideoAccountLight, MVideoFullLight } from '../../types/models/video'
import { JobQueue } from '../job-queue'
import { PeerTubeSocket } from '../peertube-socket'
import { Hooks } from '../plugins/hooks'
import {
AbstractNotification,
AbuseStateChangeForReporter,
AutoFollowForInstance,
CommentMention,
StudioEditionFinishedForOwner,
FollowForInstance,
FollowForUser,
ImportFinishedForOwner,
@ -31,6 +31,7 @@ import {
OwnedPublicationAfterScheduleUpdate,
OwnedPublicationAfterTranscoding,
RegistrationForModerators,
StudioEditionFinishedForOwner,
UnblacklistForOwner
} from './shared'
@ -222,15 +223,21 @@ class Notifier {
for (const user of users) {
const setting = object.getSetting(user)
if (this.isWebNotificationEnabled(setting)) {
const notification = await object.createNotification(user)
const webNotificationEnabled = this.isWebNotificationEnabled(setting)
const emailNotificationEnabled = this.isEmailEnabled(user, setting)
const notification = object.createNotification(user)
if (webNotificationEnabled) {
await notification.save()
PeerTubeSocket.Instance.sendNotification(user.id, notification)
}
if (this.isEmailEnabled(user, setting)) {
if (emailNotificationEnabled) {
toEmails.push(user.email)
}
Hooks.runAction('action:notifier.notification.created', { webNotificationEnabled, emailNotificationEnabled, user, notification })
}
for (const to of toEmails) {

4
server/lib/notifier/shared/abuse/abstract-new-abuse-message.ts
View file

@ -21,8 +21,8 @@ export abstract class AbstractNewAbuseMessage extends AbstractNotification <NewA
return user.NotificationSetting.abuseNewMessage
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.ABUSE_NEW_MESSAGE,
userId: user.id,
abuseId: this.abuse.id

4
server/lib/notifier/shared/abuse/abuse-state-change-for-reporter.ts
View file

@ -32,8 +32,8 @@ export class AbuseStateChangeForReporter extends AbstractNotification <MAbuseFul
return [ this.user ]
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.ABUSE_STATE_CHANGE,
userId: user.id,
abuseId: this.abuse.id

4
server/lib/notifier/shared/abuse/new-abuse-for-moderators.ts
View file

@ -28,8 +28,8 @@ export class NewAbuseForModerators extends AbstractNotification <NewAbusePayload
return this.moderators
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.NEW_ABUSE_FOR_MODERATORS,
userId: user.id,
abuseId: this.payload.abuseInstance.id

4
server/lib/notifier/shared/blacklist/new-auto-blacklist-for-moderators.ts
View file

@ -26,8 +26,8 @@ export class NewAutoBlacklistForModerators extends AbstractNotification <MVideoB
return this.moderators
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.VIDEO_AUTO_BLACKLIST_FOR_MODERATORS,
userId: user.id,
videoBlacklistId: this.payload.id

4
server/lib/notifier/shared/blacklist/new-blacklist-for-owner.ts
View file

@ -28,8 +28,8 @@ export class NewBlacklistForOwner extends AbstractNotification <MVideoBlacklistV
return [ this.user ]
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.BLACKLIST_ON_MY_VIDEO,
userId: user.id,
videoBlacklistId: this.payload.id

4
server/lib/notifier/shared/blacklist/unblacklist-for-owner.ts
View file

@ -28,8 +28,8 @@ export class UnblacklistForOwner extends AbstractNotification <MVideoFullLight>
return [ this.user ]
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.UNBLACKLIST_ON_MY_VIDEO,
userId: user.id,
videoId: this.payload.id

4
server/lib/notifier/shared/comment/comment-mention.ts
View file

@ -71,8 +71,8 @@ export class CommentMention extends AbstractNotification <MCommentOwnerVideo, MU
return this.users
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.COMMENT_MENTION,
userId: user.id,
commentId: this.payload.id

4
server/lib/notifier/shared/comment/new-comment-for-video-owner.ts
View file

@ -38,8 +38,8 @@ export class NewCommentForVideoOwner extends AbstractNotification <MCommentOwner
return [ this.user ]
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.NEW_COMMENT_ON_MY_VIDEO,
userId: user.id,
commentId: this.payload.id

2
server/lib/notifier/shared/common/abstract-notification.ts
View file

@ -13,7 +13,7 @@ export abstract class AbstractNotification <T, U = MUserWithNotificationSetting>
abstract getSetting (user: U): UserNotificationSettingValue
abstract getTargetUsers (): U[]
abstract createNotification (user: U): Promise<UserNotificationModelForApi>
abstract createNotification (user: U): UserNotificationModelForApi
abstract createEmail (to: string): EmailPayload | Promise<EmailPayload>
isDisabled (): boolean | Promise<boolean> {

4
server/lib/notifier/shared/follow/auto-follow-for-instance.ts
View file

@ -24,8 +24,8 @@ export class AutoFollowForInstance extends AbstractNotification <MActorFollowFul
return this.admins
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.AUTO_INSTANCE_FOLLOWING,
userId: user.id,
actorFollowId: this.actorFollow.id

4
server/lib/notifier/shared/follow/follow-for-instance.ts
View file

@ -32,8 +32,8 @@ export class FollowForInstance extends AbstractNotification <MActorFollowFull> {
return this.admins
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.NEW_INSTANCE_FOLLOWER,
userId: user.id,
actorFollowId: this.actorFollow.id

4
server/lib/notifier/shared/follow/follow-for-user.ts
View file

@ -45,8 +45,8 @@ export class FollowForUser extends AbstractNotification <MActorFollowFull> {
return [ this.user ]
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.NEW_FOLLOW,
userId: user.id,
actorFollowId: this.actorFollow.id

4
server/lib/notifier/shared/instance/new-peertube-version-for-admins.ts
View file

@ -30,8 +30,8 @@ export class NewPeerTubeVersionForAdmins extends AbstractNotification <NewPeerTu
return this.admins
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.NEW_PEERTUBE_VERSION,
userId: user.id,
applicationId: this.payload.application.id

4
server/lib/notifier/shared/instance/new-plugin-version-for-admins.ts
View file

@ -26,8 +26,8 @@ export class NewPluginVersionForAdmins extends AbstractNotification <MPlugin> {
return this.admins
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.NEW_PLUGIN_VERSION,
userId: user.id,
pluginId: this.plugin.id

4
server/lib/notifier/shared/instance/registration-for-moderators.ts
View file

@ -25,8 +25,8 @@ export class RegistrationForModerators extends AbstractNotification <MUserDefaul
return this.moderators
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.NEW_USER_REGISTRATION,
userId: user.id,
accountId: this.payload.Account.id

4
server/lib/notifier/shared/video-publication/abstract-owned-video-publication.ts
View file

@ -27,8 +27,8 @@ export abstract class AbstractOwnedVideoPublication extends AbstractNotification
return [ this.user ]
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.MY_VIDEO_PUBLISHED,
userId: user.id,
videoId: this.payload.id

4
server/lib/notifier/shared/video-publication/import-finished-for-owner.ts
View file

@ -32,8 +32,8 @@ export class ImportFinishedForOwner extends AbstractNotification <ImportFinished
return [ this.user ]
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: this.payload.success
? UserNotificationType.MY_VIDEO_IMPORT_SUCCESS
: UserNotificationType.MY_VIDEO_IMPORT_ERROR,

4
server/lib/notifier/shared/video-publication/new-video-for-subscribers.ts
View file

@ -30,8 +30,8 @@ export class NewVideoForSubscribers extends AbstractNotification <MVideoAccountL
return this.users
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.NEW_VIDEO_FROM_SUBSCRIPTION,
userId: user.id,
videoId: this.payload.id

4
server/lib/notifier/shared/video-publication/studio-edition-finished-for-owner.ts
View file

@ -27,8 +27,8 @@ export class StudioEditionFinishedForOwner extends AbstractNotification <MVideoF
return [ this.user ]
}
async createNotification (user: MUserWithNotificationSetting) {
const notification = await UserNotificationModel.create<UserNotificationModelForApi>({
createNotification (user: MUserWithNotificationSetting) {
const notification = UserNotificationModel.build<UserNotificationModelForApi>({
type: UserNotificationType.MY_VIDEO_STUDIO_EDITION_FINISHED,
userId: user.id,
videoId: this.payload.id

1
server/tests/fixtures/peertube-plugin-test/main.js vendored
View file

@ -1,6 +1,7 @@
async function register ({ registerHook, registerSetting, settingsManager, storageManager, peertubeHelpers }) {
const actionHooks = [
'action:application.listening',
'action:notifier.notification.created',
'action:api.video.updated',
'action:api.video.deleted',

11
server/tests/plugins/action-hooks.ts
View file

@ -17,8 +17,8 @@ describe('Test plugin action hooks', function () {
let videoUUID: string
let threadId: number
function checkHook (hook: ServerHookName) {
return servers[0].servers.waitUntilLog('Run hook ' + hook)
function checkHook (hook: ServerHookName, strictCount = true) {
return servers[0].servers.waitUntilLog('Run hook ' + hook, 1, strictCount)
}
before(async function () {
@ -225,6 +225,13 @@ describe('Test plugin action hooks', function () {
})
})
describe('Notification hook', function () {
it('Should run action:notifier.notification.created', async function () {
await checkHook('action:notifier.notification.created', false)
})
})
after(async function () {
await cleanupTests(servers)
})

3
shared/models/plugins/server/server-hook.model.ts
View file

@ -112,6 +112,9 @@ export const serverActionHookObject = {
// Fired when the application has been loaded and is listening HTTP requests
'action:application.listening': true,
// Fired when a new notification is created
'action:notifier.notification.created': true,
// API actions hooks give access to the original express `req` and `res` parameters
// Fired when a local video is updated