X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=9ca0d5d5b139a593472e541bd0407812cd2c3d91;hb=a0eeb45f14bab539f505861cad8f5d42d9ba30cb;hp=a5664408de9b36784f6f2c014118a0d7a97aa509;hpb=4f32032fed8587ea97d45e235b167e8958efd81f;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts index a5664408d..9ca0d5d5b 100644 --- a/server/lib/emailer.ts +++ b/server/lib/emailer.ts @@ -5,16 +5,37 @@ 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 { Abuse, EmailPayload } from '@shared/models' -import { SendEmailOptions } from '../../shared/models/server/emailer.model' +import { SANITIZE_OPTIONS, TEXT_WITH_HTML_RULES } from '@shared/core-utils' +import { AbuseState, EmailPayload, UserAbuse } from '@shared/models' +import { SendEmailDefaultOptions } from '../../shared/models/server/emailer.model' import { isTestInstance, root } from '../helpers/core-utils' import { bunyanLogger, logger } from '../helpers/logger' import { CONFIG, isEmailEnabled } from '../initializers/config' import { WEBSERVER } from '../initializers/constants' -import { MAbuseFull, MActorFollowActors, MActorFollowFull, MUser } from '../types/models' +import { MAbuseFull, MAbuseMessage, MAccountDefault, MActorFollowActors, MActorFollowFull, MPlugin, MUser } from '../types/models' import { MCommentOwnerVideo, MVideo, MVideoAccountLight } from '../types/models/video' 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(TEXT_WITH_HTML_RULES) + +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, SANITIZE_OPTIONS) +} + const Email = require('email-templates') class Emailer { @@ -31,73 +52,30 @@ 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 (!isEmailEnabled()) { if (!isTestInstance()) { 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) + this.warnOnConnectionFailure(err) } } @@ -209,7 +187,7 @@ class Emailer { } myVideoImportErrorNotification (to: string[], videoImport: MVideoImport) { - const importUrl = WEBSERVER.URL + '/my-account/video-imports' + const importUrl = WEBSERVER.URL + '/my-library/video-imports' const text = `Your video import "${videoImport.getTargetIdentifier()}" encountered an error.` + @@ -236,6 +214,7 @@ class Emailer { 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', @@ -245,6 +224,7 @@ class Emailer { accountName: comment.Account.getDisplayName(), accountUrl: comment.Account.Actor.url, comment, + commentHtml, video, videoUrl, action: { @@ -262,6 +242,7 @@ class Emailer { 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', @@ -269,6 +250,7 @@ class Emailer { subject: 'Mention on video ' + video.name, locals: { comment, + commentHtml, video, videoUrl, accountName, @@ -283,7 +265,7 @@ class Emailer { } addAbuseModeratorsNotification (to: string[], parameters: { - abuse: Abuse + abuse: UserAbuse abuseInstance: MAbuseFull reporter: string }) { @@ -311,7 +293,8 @@ class Emailer { videoPublishedAt: new Date(video.publishedAt).toLocaleString(), videoName: video.name, reason: abuse.reason, - videoChannel: video.VideoChannel, + videoChannel: abuse.video.channel, + reporter, action } } @@ -325,10 +308,12 @@ class Emailer { 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 } } @@ -345,6 +330,7 @@ class Emailer { accountDisplayName: account.getDisplayName(), isLocal: account.isOwned(), reason: abuse.reason, + reporter, action } } @@ -353,10 +339,73 @@ class Emailer { 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 videoAutoBlacklistUrl = 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 channel = (await VideoChannelModel.loadAndPopulateAccount(videoBlacklist.Video.channelId)).toFormattedSummaryJSON() const emailPayload: EmailPayload = { template: 'video-auto-blacklist-new', @@ -368,7 +417,7 @@ class Emailer { videoName: videoBlacklist.Video.name, action: { text: 'Review autoblacklist', - url: VIDEO_AUTO_BLACKLIST_URL + url: videoAutoBlacklistUrl } } } @@ -380,7 +429,7 @@ class Emailer { const emailPayload: EmailPayload = { template: 'user-registered', to, - subject: `a new user registered on ${WEBSERVER.HOST}: ${user.username}`, + subject: `a new user registered on ${CONFIG.INSTANCE.NAME}: ${user.username}`, locals: { user } @@ -394,7 +443,7 @@ class Emailer { 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 blockedString = `Your video ${videoName} (${videoUrl} on ${CONFIG.INSTANCE.NAME} has been blacklisted${reasonString}.` const emailPayload: EmailPayload = { to, @@ -414,7 +463,7 @@ class Emailer { const emailPayload: EmailPayload = { to, subject: `Video ${video.name} unblacklisted`, - text: `Your video "${video.name}" (${videoUrl}) on ${WEBSERVER.HOST} has been unblacklisted.`, + text: `Your video "${video.name}" (${videoUrl}) on ${CONFIG.INSTANCE.NAME} has been unblacklisted.`, locals: { title: 'Your video was unblacklisted' } @@ -423,12 +472,43 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addPasswordResetEmailJob (to: string, resetPasswordUrl: string) { + addNewPeerTubeVersionNotification (to: string[], latestVersion: string) { + const emailPayload: EmailPayload = { + to, + template: 'peertube-version-new', + subject: `A new PeerTube version is available: ${latestVersion}`, + locals: { + latestVersion + } + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addNewPlugionVersionNotification (to: string[], plugin: MPlugin) { + const pluginUrl = WEBSERVER.URL + '/admin/plugins/list-installed?pluginType=' + plugin.type + + const emailPayload: EmailPayload = { + to, + template: 'plugin-version-new', + subject: `A new plugin/theme version is available: ${plugin.name}@${plugin.latestVersion}`, + locals: { + pluginName: plugin.name, + latestVersion: plugin.latestVersion, + pluginUrl + } + } + + return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) + } + + addPasswordResetEmailJob (username: string, to: string, resetPasswordUrl: string) { const emailPayload: EmailPayload = { template: 'password-reset', to: [ to ], subject: 'Reset your account password', locals: { + username, resetPasswordUrl } } @@ -450,12 +530,13 @@ class Emailer { return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload }) } - addVerifyEmailJob (to: string, verifyEmailUrl: string) { + addVerifyEmailJob (username: string, to: string, verifyEmailUrl: string) { 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 } } @@ -471,7 +552,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 }) @@ -486,7 +567,10 @@ class Emailer { locals: { fromName, fromEmail, - body + body, + + // There are not notification preferences for the contact form + hideNotificationPreferences: true } } @@ -500,7 +584,7 @@ class Emailer { const fromDisplayName = options.from ? options.from - : WEBSERVER.HOST + : CONFIG.INSTANCE.NAME const email = new Email({ send: true, @@ -515,33 +599,74 @@ class Emailer { }) 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 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 + } + } + + // overriden/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 + }) } static get Instance () {