Switch emails to pug templates and provide richer html/text-only versions

1 files changed, 205 insertions, 187 deletions

diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts
index 45d57fd28..935c9e882 100644
--- a/server/lib/emailer.ts
+++ b/server/lib/emailer.ts
@@ -1,5 +1,5 @@
 import { createTransport, Transporter } from 'nodemailer'
-import { isTestInstance } from '../helpers/core-utils'
+import { isTestInstance, root } from '../helpers/core-utils'
 import { bunyanLogger, logger } from '../helpers/logger'
 import { CONFIG, isEmailEnabled } from '../initializers/config'
 import { JobQueue } from './job-queue'
@@ -16,6 +16,12 @@ import {
 import { MActorFollowActors, MActorFollowFull, MUser } from '../typings/models'
 import { MVideoImport, MVideoImportVideo } from '@server/typings/models/video/video-import'
 import { EmailPayload } from '@shared/models'
+import { join } from 'path'
+import { VideoAbuse } from '../../shared/models/videos'
+import { SendEmailOptions } from '../../shared/models/server/emailer.model'
+import { merge } from 'lodash'
+import { VideoChannelModel } from '@server/models/video/video-channel'
+const Email = require('email-templates')
 
 class Emailer {
 
@@ -105,37 +111,36 @@ class Emailer {
     const channelName = video.VideoChannel.getDisplayName()
     const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
 
-    const text = 'Hi dear user,\n\n' +
-      `Your subscription ${channelName} just published a new video: ${video.name}` +
-      '\n\n' +
-      `You can view it on ${videoUrl} ` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + channelName + ' just published a new video',
-      text
+      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 followerName = actorFollow.ActorFollower.Account.getDisplayName()
     const followingName = (actorFollow.ActorFollowing.VideoChannel || actorFollow.ActorFollowing.Account).getDisplayName()
 
-    const text = 'Hi dear user,\n\n' +
-      `Your ${followType} ${followingName} has a new subscriber: ${followerName}` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
+      template: 'follower-on-channel',
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New follower on your channel ' + followingName,
-      text
+      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 })
@@ -144,32 +149,28 @@ class Emailer {
   addNewInstanceFollowerNotification (to: string[], actorFollow: MActorFollowActors) {
     const awaitingApproval = actorFollow.state === 'pending' ? ' awaiting manual approval.' : ''
 
-    const text = 'Hi dear admin,\n\n' +
-      `Your instance has a new follower: ${actorFollow.ActorFollower.url}${awaitingApproval}` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New instance follower',
-      text
+      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 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 instanceUrl = actorFollow.ActorFollowing.url
     const emailPayload: EmailPayload = {
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Auto instance following',
-      text
+      subject: 'Auto instance following',
+      text: `Your instance automatically followed a new instance: <a href="${instanceUrl}">${instanceUrl}</a>.`
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
@@ -178,18 +179,17 @@ class Emailer {
   myVideoPublishedNotification (to: string[], video: MVideo) {
     const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
 
-    const text = 'Hi dear user,\n\n' +
-      `Your video ${video.name} has been published.` +
-      '\n\n' +
-      `You can view it on ${videoUrl} ` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video ${video.name} is published`,
-      text
+      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 })
@@ -198,18 +198,17 @@ class Emailer {
   myVideoImportSuccessNotification (to: string[], videoImport: MVideoImportVideo) {
     const videoUrl = WEBSERVER.URL + videoImport.Video.getWatchStaticPath()
 
-    const text = 'Hi dear user,\n\n' +
-      `Your video import ${videoImport.getTargetIdentifier()} is finished.` +
-      '\n\n' +
-      `You can view the imported video on ${videoUrl} ` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} is finished`,
-      text
+      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 })
@@ -218,40 +217,47 @@ class Emailer {
   myVideoImportErrorNotification (to: string[], videoImport: MVideoImport) {
     const importUrl = WEBSERVER.URL + '/my-account/video-imports'
 
-    const text = 'Hi dear user,\n\n' +
-      `Your video import ${videoImport.getTargetIdentifier()} encountered an error.` +
-      '\n\n' +
-      `See your videos import dashboard for more information: ${importUrl}` +
+    const text =
+      `Your video import "${videoImport.getTargetIdentifier()}" encountered an error.` +
       '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
+      `See your videos import dashboard for more information: <a href="${importUrl}">${importUrl}</a>.`
 
     const emailPayload: EmailPayload = {
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Your video import ${videoImport.getTargetIdentifier()} encountered an error`,
-      text
+      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 accountName = comment.Account.getDisplayName()
     const video = comment.Video
+    const videoUrl = WEBSERVER.URL + comment.Video.getWatchStaticPath()
     const commentUrl = WEBSERVER.URL + comment.getCommentStaticPath()
 
-    const text = 'Hi dear user,\n\n' +
-      `A new comment has been posted by ${accountName} on your video ${video.name}` +
-      '\n\n' +
-      `You can view it on ${commentUrl} ` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
+      template: 'video-comment-new',
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New comment on your video ' + video.name,
-      text
+      subject: 'New comment on your video ' + video.name,
+      locals: {
+        accountName: comment.Account.getDisplayName(),
+        accountUrl: comment.Account.Actor.url,
+        comment,
+        video,
+        videoUrl,
+        action: {
+          text: 'View comment',
+          url: commentUrl
+        }
+      }
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
@@ -260,75 +266,88 @@ class Emailer {
   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 text = 'Hi dear user,\n\n' +
-      `${accountName} mentioned you on video ${video.name}` +
-      '\n\n' +
-      `You can view the comment on ${commentUrl} ` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
+      template: 'video-comment-mention',
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Mention on video ' + video.name,
-      text
+      subject: 'Mention on video ' + video.name,
+      locals: {
+        comment,
+        video,
+        videoUrl,
+        accountName,
+        action: {
+          text: 'View comment',
+          url: commentUrl
+        }
+      }
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
   }
 
-  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' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
+  addVideoAbuseModeratorsNotification (to: string[], parameters: {
+    videoAbuse: VideoAbuse
+    videoAbuseInstance: MVideoAbuseVideo
+    reporter: string
+  }) {
+    const videoAbuseUrl = WEBSERVER.URL + '/admin/moderation/video-abuses/list?search=%23' + parameters.videoAbuse.id
+    const videoUrl = WEBSERVER.URL + parameters.videoAbuseInstance.Video.getWatchStaticPath()
 
     const emailPayload: EmailPayload = {
+      template: 'video-abuse-new',
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Received a video abuse',
-      text
+      subject: `New video abuse report from ${parameters.reporter}`,
+      locals: {
+        videoUrl,
+        videoAbuseUrl,
+        videoCreatedAt: new Date(parameters.videoAbuseInstance.Video.createdAt).toLocaleString(),
+        videoPublishedAt: new Date(parameters.videoAbuseInstance.Video.publishedAt).toLocaleString(),
+        videoAbuse: parameters.videoAbuse,
+        reporter: parameters.reporter,
+        action: {
+          text: 'View report #' + parameters.videoAbuse.id,
+          url: videoAbuseUrl
+        }
+      }
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
   }
 
-  addVideoAutoBlacklistModeratorsNotification (to: string[], videoBlacklist: MVideoBlacklistLightVideo) {
+  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 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' +
-      `A full list of auto-blacklisted videos can be reviewed here: ${VIDEO_AUTO_BLACKLIST_URL}` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
+    const channel = (await VideoChannelModel.loadByIdAndPopulateAccount(videoBlacklist.Video.channelId)).toFormattedSummaryJSON()
 
     const emailPayload: EmailPayload = {
+      template: 'video-auto-blacklist-new',
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'An auto-blacklisted video is awaiting review',
-      text
+      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 text = 'Hi,\n\n' +
-      `User ${user.username} just registered on ${WEBSERVER.HOST} PeerTube instance.\n\n` +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
+      template: 'user-registered',
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New user registration on ' + WEBSERVER.HOST,
-      text
+      subject: `a new user registered on ${WEBSERVER.HOST}: ${user.username}`,
+      locals: {
+        user
+      }
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
@@ -341,16 +360,13 @@ class Emailer {
     const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : ''
     const blockedString = `Your video ${videoName} (${videoUrl} on ${WEBSERVER.HOST} has been blacklisted${reasonString}.`
 
-    const text = 'Hi,\n\n' +
-      blockedString +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Video ${videoName} blacklisted`,
-      text
+      subject: `Video ${videoName} blacklisted`,
+      text: blockedString,
+      locals: {
+        title: 'Your video was blacklisted'
+      }
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
@@ -359,66 +375,53 @@ class Emailer {
   addVideoUnblacklistNotification (to: string[], video: MVideo) {
     const videoUrl = WEBSERVER.URL + video.getWatchStaticPath()
 
-    const text = 'Hi,\n\n' +
-      `Your video ${video.name} (${videoUrl}) on ${WEBSERVER.HOST} has been unblacklisted.` +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
       to,
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + `Video ${video.name} unblacklisted`,
-      text
+      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 (to: string, resetPasswordUrl: string) {
-    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}  (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 = {
+      template: 'password-reset',
       to: [ to ],
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Reset your password',
-      text
+      subject: 'Reset your account password',
+      locals: {
+        resetPasswordUrl
+      }
     }
 
     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}`
-
+  addPasswordCreateEmailJob (username: string, to: string, createPasswordUrl: string) {
     const emailPayload: EmailPayload = {
+      template: 'password-create',
       to: [ to ],
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'New PeerTube account password',
-      text
+      subject: 'Create your account password',
+      locals: {
+        username,
+        createPasswordUrl
+      }
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
   }
 
   addVerifyEmailJob (to: string, verifyEmailUrl: string) {
-    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' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
-
     const emailPayload: EmailPayload = {
+      template: 'verify-email',
       to: [ to ],
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Verify your email',
-      text
+      subject: `Verify your email on ${WEBSERVER.HOST}`,
+      locals: {
+        verifyEmailUrl
+      }
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
@@ -427,39 +430,28 @@ class Emailer {
   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}.`
-
-    const text = 'Hi,\n\n' +
-      blockedString +
-      '\n\n' +
-      'Cheers,\n' +
-      `${CONFIG.EMAIL.BODY.SIGNATURE}`
 
     const to = user.email
     const emailPayload: EmailPayload = {
       to: [ to ],
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + 'Account ' + blockedWord,
-      text
+      subject: 'Account ' + blockedWord,
+      text: `Your account ${user.username} on ${WEBSERVER.HOST} has been ${blockedWord}${reasonString}.`
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
   }
 
   addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) {
-    const text = 'Hello dear admin,\n\n' +
-      fromName + ' sent you a message' +
-      '\n\n---------------------------------------\n\n' +
-      body +
-      '\n\n---------------------------------------\n\n' +
-      'Cheers,\n' +
-      'PeerTube.'
-
     const emailPayload: EmailPayload = {
-      fromDisplayName: fromEmail,
-      replyTo: fromEmail,
+      template: 'contact-form',
       to: [ CONFIG.ADMIN.EMAIL ],
-      subject: CONFIG.EMAIL.SUBJECT.PREFIX + subject,
-      text
+      replyTo: `"${fromName}" <${fromEmail}>`,
+      subject: `(contact form) ${subject}`,
+      locals: {
+        fromName,
+        fromEmail,
+        body
+      }
     }
 
     return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
@@ -470,18 +462,44 @@ class Emailer {
       throw new Error('Cannot send mail because SMTP is not configured.')
     }
 
-    const fromDisplayName = options.fromDisplayName
-      ? options.fromDisplayName
+    const fromDisplayName = options.from
+      ? options.from
       : WEBSERVER.HOST
 
+    const email = new Email({
+      send: true,
+      message: {
+        from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`
+      },
+      transport: this.transporter,
+      views: {
+        root: join(root(), 'server', 'lib', 'emails')
+      },
+      subjectPrefix: CONFIG.EMAIL.SUBJECT.PREFIX
+    })
+
     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
-      })
+      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)
+        .then(logger.info)
+        .catch(logger.error)
     }
   }