X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=5a99edc7f68bd196ed8e32de6254c0800b7db30a;hb=7fed637506043e4432cbebe041ada0625171cceb;hp=10e7d0479ca578167f11618888a306da691dd301;hpb=7c58378a57a1540534b9fc47bf06c9f64a1ebc6b;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts index 10e7d0479..5a99edc7f 100644 --- a/server/lib/emailer.ts +++ b/server/lib/emailer.ts @@ -1,18 +1,21 @@ import { createTransport, Transporter } from 'nodemailer' import { isTestInstance } from '../helpers/core-utils' import { bunyanLogger, logger } from '../helpers/logger' -import { CONFIG } from '../initializers/config' -import { UserModel } from '../models/account/user' -import { VideoModel } from '../models/video/video' +import { CONFIG, isEmailEnabled } from '../initializers/config' import { JobQueue } from './job-queue' import { EmailPayload } from './job-queue/handlers/email' import { readFileSync } from 'fs-extra' -import { VideoCommentModel } from '../models/video/video-comment' -import { VideoAbuseModel } from '../models/video/video-abuse' -import { VideoBlacklistModel } from '../models/video/video-blacklist' -import { VideoImportModel } from '../models/video/video-import' -import { ActorFollowModel } from '../models/activitypub/actor-follow' import { WEBSERVER } from '../initializers/constants' +import { + MCommentOwnerVideo, + MVideo, + MVideoAbuseVideo, + MVideoAccountLight, + MVideoBlacklistLightVideo, + MVideoBlacklistVideo +} from '../typings/models/video' +import { MActorFollowActors, MActorFollowFull, MUser } from '../typings/models' +import { MVideoImport, MVideoImportVideo } from '@server/typings/models/video/video-import' type SendEmailOptions = { to: string[] @@ -29,41 +32,52 @@ class Emailer { private initialized = false private transporter: Transporter - private constructor () {} + private constructor () { + } init () { // Already initialized if (this.initialized === true) return this.initialized = true - if (Emailer.isEnabled()) { - logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT) + if (isEmailEnabled()) { + if (CONFIG.SMTP.TRANSPORT === 'smtp') { + logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT) - let tls - if (CONFIG.SMTP.CA_FILE) { - tls = { - ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ] + let tls + if (CONFIG.SMTP.CA_FILE) { + tls = { + ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ] + } } - } - let auth - if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) { - auth = { - user: CONFIG.SMTP.USERNAME, - pass: CONFIG.SMTP.PASSWORD + let auth + if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) { + auth = { + user: CONFIG.SMTP.USERNAME, + pass: CONFIG.SMTP.PASSWORD + } } - } - this.transporter = createTransport({ - host: CONFIG.SMTP.HOSTNAME, - port: CONFIG.SMTP.PORT, - secure: CONFIG.SMTP.TLS, - debug: CONFIG.LOG.LEVEL === 'debug', - logger: bunyanLogger as any, - ignoreTLS: CONFIG.SMTP.DISABLE_STARTTLS, - tls, - auth - }) + this.transporter = createTransport({ + host: CONFIG.SMTP.HOSTNAME, + port: CONFIG.SMTP.PORT, + secure: CONFIG.SMTP.TLS, + debug: CONFIG.LOG.LEVEL === 'debug', + logger: bunyanLogger as any, + ignoreTLS: CONFIG.SMTP.DISABLE_STARTTLS, + tls, + auth + }) + } else { // sendmail + logger.info('Using sendmail to send emails') + + this.transporter = createTransport({ + sendmail: true, + newline: 'unix', + path: CONFIG.SMTP.SENDMAIL + }) + } } else { if (!isTestInstance()) { logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!') @@ -72,11 +86,17 @@ class Emailer { } static isEnabled () { - return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT + if (CONFIG.SMTP.TRANSPORT === 'sendmail') { + return !!CONFIG.SMTP.SENDMAIL + } else if (CONFIG.SMTP.TRANSPORT === 'smtp') { + return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT + } else { + return false + } } async checkConnectionOrDie () { - if (!this.transporter) return + if (!this.transporter || CONFIG.SMTP.TRANSPORT !== 'smtp') return logger.info('Testing SMTP server...') @@ -90,16 +110,16 @@ class Emailer { } } - addNewVideoFromSubscriberNotification (to: string[], video: VideoModel) { + addNewVideoFromSubscriberNotification (to: string[], video: MVideoAccountLight) { const channelName = video.VideoChannel.getDisplayName() const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your subscription ${channelName} just published a new video: ${video.name}` + - `\n\n` + + '\n\n' + `You can view it on ${videoUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -111,14 +131,14 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewFollowNotification (to: string[], actorFollow: ActorFollowModel, followType: 'account' | 'channel') { + addNewFollowNotification (to: string[], actorFollow: MActorFollowFull, followType: 'account' | 'channel') { const followerName = actorFollow.ActorFollower.Account.getDisplayName() const followingName = (actorFollow.ActorFollowing.VideoChannel || actorFollow.ActorFollowing.Account).getDisplayName() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your ${followType} ${followingName} has a new subscriber: ${followerName}` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -130,13 +150,13 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewInstanceFollowerNotification (to: string[], actorFollow: ActorFollowModel) { + addNewInstanceFollowerNotification (to: string[], actorFollow: MActorFollowActors) { const awaitingApproval = actorFollow.state === 'pending' ? ' awaiting manual approval.' : '' - const text = `Hi dear admin,\n\n` + + const text = 'Hi dear admin,\n\n' + `Your instance has a new follower: ${actorFollow.ActorFollower.url}${awaitingApproval}` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -148,15 +168,31 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - myVideoPublishedNotification (to: string[], video: VideoModel) { + addAutoInstanceFollowingNotification (to: string[], actorFollow: MActorFollowActors) { + const text = 'Hi dear admin,\n\n' + + `Your instance automatically followed a new instance: ${actorFollow.ActorFollowing.url}` + + '\n\n' + + 'Cheers,\n' + + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to, + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Auto instance following', + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + myVideoPublishedNotification (to: string[], video: MVideo) { const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your video ${video.name} has been published.` + - `\n\n` + + '\n\n' + `You can view it on ${videoUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -168,15 +204,15 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - myVideoImportSuccessNotification (to: string[], videoImport: VideoImportModel) { + myVideoImportSuccessNotification (to: string[], videoImport: MVideoImportVideo) { const videoUrl = WEBSERVER.URL + videoImport.Video.getWatchStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your video import ${videoImport.getTargetIdentifier()} is finished.` + - `\n\n` + + '\n\n' + `You can view the imported video on ${videoUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -188,15 +224,15 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - myVideoImportErrorNotification (to: string[], videoImport: VideoImportModel) { + myVideoImportErrorNotification (to: string[], videoImport: MVideoImport) { const importUrl = WEBSERVER.URL + '/my-account/video-imports' - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `Your video import ${videoImport.getTargetIdentifier()} encountered an error.` + - `\n\n` + + '\n\n' + `See your videos import dashboard for more information: ${importUrl}` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -208,17 +244,17 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewCommentOnMyVideoNotification (to: string[], comment: VideoCommentModel) { + addNewCommentOnMyVideoNotification (to: string[], comment: MCommentOwnerVideo) { const accountName = comment.Account.getDisplayName() const video = comment.Video const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `A new comment has been posted by ${accountName} on your video ${video.name}` + - `\n\n` + + '\n\n' + `You can view it on ${commentUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -230,17 +266,17 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewCommentMentionNotification (to: string[], comment: VideoCommentModel) { + addNewCommentMentionNotification (to: string[], comment: MCommentOwnerVideo) { const accountName = comment.Account.getDisplayName() const video = comment.Video const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `${accountName} mentioned you on video ${video.name}` + - `\n\n` + + '\n\n' + `You can view the comment on ${commentUrl} ` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -252,12 +288,12 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVideoAbuseModeratorsNotification (to: string[], videoAbuse: VideoAbuseModel) { + addVideoAbuseModeratorsNotification (to: string[], videoAbuse: MVideoAbuseVideo) { const videoUrl = WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath() - const text = `Hi,\n\n` + - `${WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` + - `Cheers,\n` + + const text = 'Hi,\n\n' + + `${WEBSERVER.HOST} received an abuse for the following video: ${videoUrl}\n\n` + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -269,18 +305,18 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVideoAutoBlacklistModeratorsNotification (to: string[], video: VideoModel) { + addVideoAutoBlacklistModeratorsNotification (to: string[], videoBlacklist: MVideoBlacklistLightVideo) { const VIDEO_AUTO_BLACKLIST_URL = WEBSERVER.URL + '/admin/moderation/video-auto-blacklist/list' - const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() + const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() - const text = `Hi,\n\n` + - `A recently added video was auto-blacklisted and requires moderator review before publishing.` + - `\n\n` + + const text = 'Hi,\n\n' + + 'A recently added video was auto-blacklisted and requires moderator review before publishing.' + + '\n\n' + `You can view it and take appropriate action on ${videoUrl}` + - `\n\n` + + '\n\n' + `A full list of auto-blacklisted videos can be reviewed here: ${VIDEO_AUTO_BLACKLIST_URL}` + - `\n\n` + - `Cheers,\n` + + '\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -292,10 +328,10 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addNewUserRegistrationNotification (to: string[], user: UserModel) { - const text = `Hi,\n\n` + + addNewUserRegistrationNotification (to: string[], user: MUser) { + const text = 'Hi,\n\n' + `User ${user.username} just registered on ${WEBSERVER.HOST} PeerTube instance.\n\n` + - `Cheers,\n` + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -307,7 +343,7 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVideoBlacklistNotification (to: string[], videoBlacklist: VideoBlacklistModel) { + addVideoBlacklistNotification (to: string[], videoBlacklist: MVideoBlacklistVideo) { const videoName = videoBlacklist.Video.name const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() @@ -329,7 +365,7 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVideoUnblacklistNotification (to: string[], video: VideoModel) { + addVideoUnblacklistNotification (to: string[], video: MVideo) { const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() const text = 'Hi,\n\n' + @@ -348,11 +384,11 @@ class Emailer { } addPasswordResetEmailJob (to: string, resetPasswordUrl: string) { - const text = `Hi dear user,\n\n` + + const text = 'Hi dear user,\n\n' + `A reset password procedure for your account ${to} has been requested on ${WEBSERVER.HOST} ` + - `Please follow this link to reset it: ${resetPasswordUrl}\n\n` + - `If you are not the person who initiated this request, please ignore this email.\n\n` + - `Cheers,\n` + + `Please follow this link to reset it: ${resetPasswordUrl} (the link will expire within 1 hour)\n\n` + + 'If you are not the person who initiated this request, please ignore this email.\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -364,12 +400,28 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } + addPasswordCreateEmailJob (username: string, to: string, resetPasswordUrl: string) { + const text = 'Hi,\n\n' + + `Welcome to your ${WEBSERVER.HOST} PeerTube instance. Your username is: ${username}.\n\n` + + `Please set your password by following this link: ${resetPasswordUrl} (this link will expire within seven days).\n\n` + + 'Cheers,\n' + + `${CONFIG.EMAIL.BODY.SIGNATURE}` + + const emailPayload: EmailPayload = { + to: [ to ], + subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New PeerTube account password', + text + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + addVerifyEmailJob (to: string, verifyEmailUrl: string) { - const text = `Welcome to PeerTube,\n\n` + + const text = 'Welcome to PeerTube,\n\n' + `To start using PeerTube on ${WEBSERVER.HOST} you must verify your email! ` + `Please follow this link to verify this email belongs to you: ${verifyEmailUrl}\n\n` + - `If you are not the person who initiated this request, please ignore this email.\n\n` + - `Cheers,\n` + + 'If you are not the person who initiated this request, please ignore this email.\n\n' + + 'Cheers,\n' + `${CONFIG.EMAIL.BODY.SIGNATURE}` const emailPayload: EmailPayload = { @@ -381,7 +433,7 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addUserBlockJob (user: UserModel, blocked: boolean, reason?: string) { + addUserBlockJob (user: MUser, blocked: boolean, reason?: string) { const reasonString = reason ? ` for the following reason: ${reason}` : '' const blockedWord = blocked ? 'blocked' : 'unblocked' const blockedString = `Your account ${user.username} on ${WEBSERVER.HOST} has been ${blockedWord}${reasonString}.` @@ -422,8 +474,8 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - sendMail (options: EmailPayload) { - if (!Emailer.isEnabled()) { + async sendMail (options: EmailPayload) { + if (!isEmailEnabled()) { throw new Error('Cannot send mail because SMTP is not configured.') } @@ -431,13 +483,15 @@ class Emailer { ? options.fromDisplayName : WEBSERVER.HOST - return this.transporter.sendMail({ - from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`, - replyTo: options.replyTo, - to: options.to.join(','), - subject: options.subject, - text: options.text - }) + for (const to of options.to) { + await this.transporter.sendMail({ + from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`, + replyTo: options.replyTo, + to, + subject: options.subject, + text: options.text + }) + } } private dieOnConnectionFailure (err?: Error) {