X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=42d7650ddb76c8e60b8ba15226ca99e868385623;hb=9452d4fd3321148fb80b64a67bd9983fee6c208e;hp=6532fb4b4d708b77e45d47a4076020d63e109e1f;hpb=98b94643127d881cbc09a12812185aed44173f16;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts index 6532fb4b4..42d7650dd 100644 --- a/server/lib/emailer.ts +++ b/server/lib/emailer.ts @@ -1,67 +1,17 @@ import { readFileSync } from 'fs-extra' -import { merge } from 'lodash' +import { isArray, merge } from 'lodash' import { createTransport, Transporter } from 'nodemailer' import { join } from 'path' -import { VideoChannelModel } from '@server/models/video/video-channel' -import { MVideoBlacklistLightVideo, MVideoBlacklistVideo } from '@server/types/models/video/video-blacklist' -import { MVideoImport, MVideoImportVideo } from '@server/types/models/video/video-import' -import { AbuseState, EmailPayload, UserAbuse } from '@shared/models' -import { SendEmailOptions } from '../../shared/models/server/emailer.model' -import { isTestInstance, root } from '../helpers/core-utils' +import { root } from '@shared/core-utils' +import { EmailPayload } from '@shared/models' +import { SendEmailDefaultOptions } from '../../shared/models/server/emailer.model' +import { isTestOrDevInstance } from '../helpers/core-utils' import { bunyanLogger, logger } from '../helpers/logger' import { CONFIG, isEmailEnabled } from '../initializers/config' import { WEBSERVER } from '../initializers/constants' -import { MAbuseFull, MAbuseMessage, MAccountDefault, MActorFollowActors, MActorFollowFull, MUser } from '../types/models' -import { MCommentOwnerVideo, MVideo, MVideoAccountLight } from '../types/models/video' +import { MUser } from '../types/models' import { JobQueue } from './job-queue' -const sanitizeHtml = require('sanitize-html') -const markdownItEmoji = require('markdown-it-emoji/light') -const MarkdownItClass = require('markdown-it') -const markdownIt = new MarkdownItClass('default', { linkify: true, breaks: true, html: true }) - -markdownIt.enable([ - 'linkify', - 'autolink', - 'emphasis', - 'link', - 'newline', - 'list' -]) - -markdownIt.use(markdownItEmoji) - -const toSafeHtml = text => { - // Restore line feed - const textWithLineFeed = text.replace(//g, '\r\n') - - // Convert possible markdown (emojis, emphasis and lists) to html - const html = markdownIt.render(textWithLineFeed) - - // Convert to safe Html - return sanitizeHtml(html, { - allowedTags: [ 'a', 'p', 'span', 'br', 'strong', 'em', 'ul', 'ol', 'li' ], - allowedSchemes: [ 'http', 'https' ], - allowedAttributes: { - a: [ 'href', 'class', 'target', 'rel' ] - }, - transformTags: { - a: (tagName, attribs) => { - let rel = 'noopener noreferrer' - if (attribs.rel === 'me') rel += ' me' - - return { - tagName, - attribs: Object.assign(attribs, { - target: '_blank', - rel - }) - } - } - } - }) -} - const Email = require('email-templates') class Emailer { @@ -78,467 +28,31 @@ class Emailer { if (this.initialized === true) return this.initialized = true - 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 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 - }) - } else { // sendmail - logger.info('Using sendmail to send emails') - - this.transporter = createTransport({ - sendmail: true, - newline: 'unix', - path: CONFIG.SMTP.SENDMAIL - }) - } - } else { - if (!isTestInstance()) { + if (!isEmailEnabled()) { + if (!isTestOrDevInstance()) { logger.error('Cannot use SMTP server because of lack of configuration. PeerTube will not be able to send mails!') } - } - } - static isEnabled () { - 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 + return } + + if (CONFIG.SMTP.TRANSPORT === 'smtp') this.initSMTPTransport() + else if (CONFIG.SMTP.TRANSPORT === 'sendmail') this.initSendmailTransport() } - async checkConnectionOrDie () { + async checkConnection () { if (!this.transporter || CONFIG.SMTP.TRANSPORT !== 'smtp') return logger.info('Testing SMTP server...') try { const success = await this.transporter.verify() - if (success !== true) this.dieOnConnectionFailure() + if (success !== true) this.warnOnConnectionFailure() logger.info('Successfully connected to SMTP server.') } catch (err) { - this.dieOnConnectionFailure(err) - } - } - - addNewVideoFromSubscriberNotification (to: string[], video: MVideoAccountLight) { - const channelName = video.VideoChannel.getDisplayName() - const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() - - const emailPayload: EmailPayload = { - to, - subject: channelName + ' just published a new video', - text: `Your subscription ${channelName} just published a new video: "${video.name}".`, - locals: { - title: 'New content ', - action: { - text: 'View video', - url: videoUrl - } - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addNewFollowNotification (to: string[], actorFollow: MActorFollowFull, followType: 'account' | 'channel') { - const followingName = (actorFollow.ActorFollowing.VideoChannel || actorFollow.ActorFollowing.Account).getDisplayName() - - const emailPayload: EmailPayload = { - template: 'follower-on-channel', - to, - subject: `New follower on your channel ${followingName}`, - locals: { - followerName: actorFollow.ActorFollower.Account.getDisplayName(), - followerUrl: actorFollow.ActorFollower.url, - followingName, - followingUrl: actorFollow.ActorFollowing.url, - followType - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addNewInstanceFollowerNotification (to: string[], actorFollow: MActorFollowActors) { - const awaitingApproval = actorFollow.state === 'pending' ? ' awaiting manual approval.' : '' - - const emailPayload: EmailPayload = { - to, - subject: 'New instance follower', - text: `Your instance has a new follower: ${actorFollow.ActorFollower.url}${awaitingApproval}.`, - locals: { - title: 'New instance follower', - action: { - text: 'Review followers', - url: WEBSERVER.URL + '/admin/follows/followers-list' - } - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addAutoInstanceFollowingNotification (to: string[], actorFollow: MActorFollowActors) { - const instanceUrl = actorFollow.ActorFollowing.url - const emailPayload: EmailPayload = { - to, - subject: 'Auto instance following', - text: `Your instance automatically followed a new instance: ${instanceUrl}.` - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - myVideoPublishedNotification (to: string[], video: MVideo) { - const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() - - const emailPayload: EmailPayload = { - to, - subject: `Your video ${video.name} has been published`, - text: `Your video "${video.name}" has been published.`, - locals: { - title: 'You video is live', - action: { - text: 'View video', - url: videoUrl - } - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - myVideoImportSuccessNotification (to: string[], videoImport: MVideoImportVideo) { - const videoUrl = WEBSERVER.URL + videoImport.Video.getWatchStaticPath() - - const emailPayload: EmailPayload = { - to, - subject: `Your video import ${videoImport.getTargetIdentifier()} is complete`, - text: `Your video "${videoImport.getTargetIdentifier()}" just finished importing.`, - locals: { - title: 'Import complete', - action: { - text: 'View video', - url: videoUrl - } - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - myVideoImportErrorNotification (to: string[], videoImport: MVideoImport) { - const importUrl = WEBSERVER.URL + '/my-account/video-imports' - - const text = - `Your video import "${videoImport.getTargetIdentifier()}" encountered an error.` + - '\n\n' + - `See your videos import dashboard for more information: ${importUrl}.` - - const emailPayload: EmailPayload = { - to, - subject: `Your video import "${videoImport.getTargetIdentifier()}" encountered an error`, - text, - locals: { - title: 'Import failed', - action: { - text: 'Review imports', - url: importUrl - } - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addNewCommentOnMyVideoNotification (to: string[], comment: MCommentOwnerVideo) { - const video = comment.Video - const videoUrl = WEBSERVER.URL + comment.Video.getWatchStaticPath() - const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() - const commentHtml = toSafeHtml(comment.text) - - const emailPayload: EmailPayload = { - template: 'video-comment-new', - to, - subject: 'New comment on your video ' + video.name, - locals: { - accountName: comment.Account.getDisplayName(), - accountUrl: comment.Account.Actor.url, - comment, - commentHtml, - video, - videoUrl, - action: { - text: 'View comment', - url: commentUrl - } - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addNewCommentMentionNotification (to: string[], comment: MCommentOwnerVideo) { - const accountName = comment.Account.getDisplayName() - const video = comment.Video - const videoUrl = WEBSERVER.URL + comment.Video.getWatchStaticPath() - const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath() - const commentHtml = toSafeHtml(comment.text) - - const emailPayload: EmailPayload = { - template: 'video-comment-mention', - to, - subject: 'Mention on video ' + video.name, - locals: { - comment, - commentHtml, - video, - videoUrl, - accountName, - action: { - text: 'View comment', - url: commentUrl - } - } + this.warnOnConnectionFailure(err) } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addAbuseModeratorsNotification (to: string[], parameters: { - abuse: UserAbuse - abuseInstance: MAbuseFull - reporter: string - }) { - const { abuse, abuseInstance, reporter } = parameters - - const action = { - text: 'View report #' + abuse.id, - url: WEBSERVER.URL + '/admin/moderation/abuses/list?search=%23' + abuse.id - } - - let emailPayload: EmailPayload - - if (abuseInstance.VideoAbuse) { - const video = abuseInstance.VideoAbuse.Video - const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() - - emailPayload = { - template: 'video-abuse-new', - to, - subject: `New video abuse report from ${reporter}`, - locals: { - videoUrl, - isLocal: video.remote === false, - videoCreatedAt: new Date(video.createdAt).toLocaleString(), - videoPublishedAt: new Date(video.publishedAt).toLocaleString(), - videoName: video.name, - reason: abuse.reason, - videoChannel: abuse.video.channel, - reporter, - action - } - } - } else if (abuseInstance.VideoCommentAbuse) { - const comment = abuseInstance.VideoCommentAbuse.VideoComment - const commentUrl = WEBSERVER.URL + comment.Video.getWatchStaticPath() + ';threadId=' + comment.getThreadId() - - emailPayload = { - template: 'video-comment-abuse-new', - to, - subject: `New comment abuse report from ${reporter}`, - locals: { - commentUrl, - videoName: comment.Video.name, - isLocal: comment.isOwned(), - commentCreatedAt: new Date(comment.createdAt).toLocaleString(), - reason: abuse.reason, - flaggedAccount: abuseInstance.FlaggedAccount.getDisplayName(), - reporter, - action - } - } - } else { - const account = abuseInstance.FlaggedAccount - const accountUrl = account.getClientUrl() - - emailPayload = { - template: 'account-abuse-new', - to, - subject: `New account abuse report from ${reporter}`, - locals: { - accountUrl, - accountDisplayName: account.getDisplayName(), - isLocal: account.isOwned(), - reason: abuse.reason, - reporter, - action - } - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addAbuseStateChangeNotification (to: string[], abuse: MAbuseFull) { - const text = abuse.state === AbuseState.ACCEPTED - ? 'Report #' + abuse.id + ' has been accepted' - : 'Report #' + abuse.id + ' has been rejected' - - const abuseUrl = WEBSERVER.URL + '/my-account/abuses?search=%23' + abuse.id - - const action = { - text, - url: abuseUrl - } - - const emailPayload: EmailPayload = { - template: 'abuse-state-change', - to, - subject: text, - locals: { - action, - abuseId: abuse.id, - abuseUrl, - isAccepted: abuse.state === AbuseState.ACCEPTED - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addAbuseNewMessageNotification ( - to: string[], - options: { - target: 'moderator' | 'reporter' - abuse: MAbuseFull - message: MAbuseMessage - accountMessage: MAccountDefault - }) { - const { abuse, target, message, accountMessage } = options - - const text = 'New message on report #' + abuse.id - const abuseUrl = target === 'moderator' - ? WEBSERVER.URL + '/admin/moderation/abuses/list?search=%23' + abuse.id - : WEBSERVER.URL + '/my-account/abuses?search=%23' + abuse.id - - const action = { - text, - url: abuseUrl - } - - const emailPayload: EmailPayload = { - template: 'abuse-new-message', - to, - subject: text, - locals: { - abuseId: abuse.id, - abuseUrl: action.url, - messageAccountName: accountMessage.getDisplayName(), - messageText: message.message, - action - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - async addVideoAutoBlacklistModeratorsNotification (to: string[], videoBlacklist: MVideoBlacklistLightVideo) { - const VIDEO_AUTO_BLACKLIST_URL = WEBSERVER.URL + '/admin/moderation/video-auto-blacklist/list' - const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() - const channel = (await VideoChannelModel.loadByIdAndPopulateAccount(videoBlacklist.Video.channelId)).toFormattedSummaryJSON() - - const emailPayload: EmailPayload = { - template: 'video-auto-blacklist-new', - to, - subject: 'A new video is pending moderation', - locals: { - channel, - videoUrl, - videoName: videoBlacklist.Video.name, - action: { - text: 'Review autoblacklist', - url: VIDEO_AUTO_BLACKLIST_URL - } - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addNewUserRegistrationNotification (to: string[], user: MUser) { - const emailPayload: EmailPayload = { - template: 'user-registered', - to, - subject: `a new user registered on ${WEBSERVER.HOST}: ${user.username}`, - locals: { - user - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addVideoBlacklistNotification (to: string[], videoBlacklist: MVideoBlacklistVideo) { - const videoName = videoBlacklist.Video.name - const videoUrl = WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath() - - const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : '' - const blockedString = `Your video ${videoName} (${videoUrl} on ${WEBSERVER.HOST} has been blacklisted${reasonString}.` - - const emailPayload: EmailPayload = { - to, - subject: `Video ${videoName} blacklisted`, - text: blockedString, - locals: { - title: 'Your video was blacklisted' - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) - } - - addVideoUnblacklistNotification (to: string[], video: MVideo) { - const videoUrl = WEBSERVER.URL + video.getWatchStaticPath() - - const emailPayload: EmailPayload = { - to, - subject: `Video ${video.name} unblacklisted`, - text: `Your video "${video.name}" (${videoUrl}) on ${WEBSERVER.HOST} has been unblacklisted.`, - locals: { - title: 'Your video was unblacklisted' - } - } - - return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } addPasswordResetEmailJob (username: string, to: string, resetPasswordUrl: string) { @@ -573,7 +87,7 @@ class Emailer { const emailPayload: EmailPayload = { template: 'verify-email', to: [ to ], - subject: `Verify your email on ${WEBSERVER.HOST}`, + subject: `Verify your email on ${CONFIG.INSTANCE.NAME}`, locals: { username, verifyEmailUrl @@ -591,7 +105,7 @@ class Emailer { const emailPayload: EmailPayload = { to: [ to ], subject: 'Account ' + blockedWord, - text: `Your account ${user.username} on ${WEBSERVER.HOST} has been ${blockedWord}${reasonString}.` + text: `Your account ${user.username} on ${CONFIG.INSTANCE.NAME} has been ${blockedWord}${reasonString}.` } return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) @@ -606,7 +120,10 @@ class Emailer { locals: { fromName, fromEmail, - body + body, + + // There are not notification preferences for the contact form + hideNotificationPreferences: true } } @@ -620,10 +137,16 @@ class Emailer { const fromDisplayName = options.from ? options.from - : WEBSERVER.HOST + : CONFIG.INSTANCE.NAME const email = new Email({ send: true, + htmlToText: { + selectors: [ + { selector: 'img', format: 'skip' }, + { selector: 'a', options: { hideLinkHrefIfSameAsText: true } } + ] + }, message: { from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>` }, @@ -634,34 +157,80 @@ class Emailer { subjectPrefix: CONFIG.EMAIL.SUBJECT.PREFIX }) - for (const to of options.to) { - await email - .send(merge( - { - template: 'common', - message: { - to, - from: options.from, - subject: options.subject, - replyTo: options.replyTo - }, - locals: { // default variables available in all templates - WEBSERVER, - EMAIL: CONFIG.EMAIL, - text: options.text, - subject: options.subject - } - }, - options // overriden/new variables given for a specific template in the payload - ) as SendEmailOptions) + const toEmails = isArray(options.to) + ? options.to + : [ options.to ] + + for (const to of toEmails) { + const baseOptions: SendEmailDefaultOptions = { + template: 'common', + message: { + to, + from: options.from, + subject: options.subject, + replyTo: options.replyTo + }, + locals: { // default variables available in all templates + WEBSERVER, + EMAIL: CONFIG.EMAIL, + instanceName: CONFIG.INSTANCE.NAME, + text: options.text, + subject: options.subject + } + } + + // overridden/new variables given for a specific template in the payload + const sendOptions = merge(baseOptions, options) + + await email.send(sendOptions) .then(res => logger.debug('Sent email.', { res })) .catch(err => logger.error('Error in email sender.', { err })) } } - private dieOnConnectionFailure (err?: Error) { + private warnOnConnectionFailure (err?: Error) { logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err }) - process.exit(-1) + } + + private initSMTPTransport () { + 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 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 + }) + } + + private initSendmailTransport () { + logger.info('Using sendmail to send emails') + + this.transporter = createTransport({ + sendmail: true, + newline: 'unix', + path: CONFIG.SMTP.SENDMAIL, + logger: bunyanLogger + }) } static get Instance () {