X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=9e546de7f85d39adf55545afe8510005d7d64ee0;hb=bd911b54b555b11df7e9849cf92d358bccfecf6e;hp=7681164b3fc93eb4ddc9f8be4fb2fcdf8c3ddf9a;hpb=328c78bc4a570a9aceaaa1a2124bacd4a0e8d295;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts
index 7681164b3..9e546de7f 100644
--- a/server/lib/emailer.ts
+++ b/server/lib/emailer.ts
@@ -1,17 +1,18 @@
+import { readFileSync } from 'fs-extra'
+import { isArray, merge } from 'lodash'
 import { createTransport, Transporter } from 'nodemailer'
-import { isTestInstance } from '../helpers/core-utils'
+import { join } from 'path'
+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 } from '../initializers'
-import { UserModel } from '../models/account/user'
-import { VideoModel } from '../models/video/video'
+import { CONFIG, isEmailEnabled } from '../initializers/config'
+import { WEBSERVER } from '../initializers/constants'
+import { MUser } from '../types/models'
 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'
+
+const Email = require('email-templates')
 
 class Emailer {
 
@@ -19,391 +20,220 @@ 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)
-
-      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 {
-      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!')
       }
+
+      return
     }
-  }
 
-  static isEnabled () {
-    return !!CONFIG.SMTP.HOSTNAME && !!CONFIG.SMTP.PORT
+    if (CONFIG.SMTP.TRANSPORT === 'smtp') this.initSMTPTransport()
+    else if (CONFIG.SMTP.TRANSPORT === 'sendmail') this.initSendmailTransport()
   }
 
-  async checkConnectionOrDie () {
-    if (!this.transporter) return
+  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)
     }
   }
 
-  addNewVideoFromSubscriberNotification (to: string[], video: VideoModel) {
-    const channelName = video.VideoChannel.getDisplayName()
-    const videoUrl = CONFIG.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` +
-      `PeerTube.`
-
-    const emailPayload: EmailPayload = {
-      to,
-      subject: channelName + ' just published a new video',
-      text
-    }
-
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
-  }
-
-  addForceResetPasswordEmailJob (to: string, resetPasswordUrl: string) {
-    const text = `Hi dear user,\n\n` +
-      `Your password has been reset on ${CONFIG.WEBSERVER.HOST}! ` +
-      `Please follow this link to reset it: ${resetPasswordUrl}\n\n` +
-      `Cheers,\n` +
-      `PeerTube.`
-
+  addPasswordResetEmailJob (username: string, to: string, resetPasswordUrl: string) {
     const emailPayload: EmailPayload = {
+      template: 'password-reset',
       to: [ to ],
-      subject: 'Reset of your PeerTube password',
-      text
-    }
-
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
-  }
-
-  addNewFollowNotification (to: string[], actorFollow: ActorFollowModel, 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` +
-      `PeerTube.`
-
-    const emailPayload: EmailPayload = {
-      to,
-      subject: 'New follower on your channel ' + followingName,
-      text
-    }
-
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
-  }
-
-  myVideoPublishedNotification (to: string[], video: VideoModel) {
-    const videoUrl = CONFIG.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` +
-      `PeerTube.`
-
-    const emailPayload: EmailPayload = {
-      to,
-      subject: `Your video ${video.name} is published`,
-      text
-    }
-
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
-  }
-
-  myVideoImportSuccessNotification (to: string[], videoImport: VideoImportModel) {
-    const videoUrl = CONFIG.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` +
-      `PeerTube.`
-
-    const emailPayload: EmailPayload = {
-      to,
-      subject: `Your video import ${videoImport.getTargetIdentifier()} is finished`,
-      text
-    }
-
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
-  }
-
-  myVideoImportErrorNotification (to: string[], videoImport: VideoImportModel) {
-    const importUrl = CONFIG.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}` +
-      `\n\n` +
-      `Cheers,\n` +
-      `PeerTube.`
-
-    const emailPayload: EmailPayload = {
-      to,
-      subject: `Your video import ${videoImport.getTargetIdentifier()} encountered an error`,
-      text
+      subject: 'Reset your account password',
+      locals: {
+        username,
+        resetPasswordUrl
+      }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
-  addNewCommentOnMyVideoNotification (to: string[], comment: VideoCommentModel) {
-    const accountName = comment.Account.getDisplayName()
-    const video = comment.Video
-    const commentUrl = CONFIG.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` +
-      `PeerTube.`
-
+  addPasswordCreateEmailJob (username: string, to: string, createPasswordUrl: string) {
     const emailPayload: EmailPayload = {
-      to,
-      subject: 'New comment on your video ' + video.name,
-      text
+      template: 'password-create',
+      to: [ to ],
+      subject: 'Create your account password',
+      locals: {
+        username,
+        createPasswordUrl
+      }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
-  addNewCommentMentionNotification (to: string[], comment: VideoCommentModel) {
-    const accountName = comment.Account.getDisplayName()
-    const video = comment.Video
-    const commentUrl = CONFIG.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` +
-      `PeerTube.`
-
+  addVerifyEmailJob (username: string, to: string, verifyEmailUrl: string) {
     const emailPayload: EmailPayload = {
-      to,
-      subject: 'Mention on video ' + video.name,
-      text
+      template: 'verify-email',
+      to: [ to ],
+      subject: `Verify your email on ${CONFIG.INSTANCE.NAME}`,
+      locals: {
+        username,
+        verifyEmailUrl
+      }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
-  addVideoAbuseModeratorsNotification (to: string[], videoAbuse: VideoAbuseModel) {
-    const videoUrl = CONFIG.WEBSERVER.URL + videoAbuse.Video.getWatchStaticPath()
-
-    const text = `Hi,\n\n` +
-      `${CONFIG.WEBSERVER.HOST} received an abuse for the following video ${videoUrl}\n\n` +
-      `Cheers,\n` +
-      `PeerTube.`
+  addUserBlockJob (user: MUser, blocked: boolean, reason?: string) {
+    const reasonString = reason ? ` for the following reason: ${reason}` : ''
+    const blockedWord = blocked ? 'blocked' : 'unblocked'
 
+    const to = user.email
     const emailPayload: EmailPayload = {
-      to,
-      subject: '[PeerTube] Received a video abuse',
-      text
+      to: [ to ],
+      subject: 'Account ' + blockedWord,
+      text: `Your account ${user.username} on ${CONFIG.INSTANCE.NAME} has been ${blockedWord}${reasonString}.`
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
-  addNewUserRegistrationNotification (to: string[], user: UserModel) {
-    const text = `Hi,\n\n` +
-      `User ${user.username} just registered on ${CONFIG.WEBSERVER.HOST} PeerTube instance.\n\n` +
-      `Cheers,\n` +
-      `PeerTube.`
-
+  addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) {
     const emailPayload: EmailPayload = {
-      to,
-      subject: '[PeerTube] New user registration on ' + CONFIG.WEBSERVER.HOST,
-      text
+      template: 'contact-form',
+      to: [ CONFIG.ADMIN.EMAIL ],
+      replyTo: `"${fromName}" <${fromEmail}>`,
+      subject: `(contact form) ${subject}`,
+      locals: {
+        fromName,
+        fromEmail,
+        body,
+
+        // There are not notification preferences for the contact form
+        hideNotificationPreferences: true
+      }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
-  addVideoBlacklistNotification (to: string[], videoBlacklist: VideoBlacklistModel) {
-    const videoName = videoBlacklist.Video.name
-    const videoUrl = CONFIG.WEBSERVER.URL + videoBlacklist.Video.getWatchStaticPath()
-
-    const reasonString = videoBlacklist.reason ? ` for the following reason: ${videoBlacklist.reason}` : ''
-    const blockedString = `Your video ${videoName} (${videoUrl} on ${CONFIG.WEBSERVER.HOST} has been blacklisted${reasonString}.`
-
-    const text = 'Hi,\n\n' +
-      blockedString +
-      '\n\n' +
-      'Cheers,\n' +
-      `PeerTube.`
-
-    const emailPayload: EmailPayload = {
-      to,
-      subject: `[PeerTube] Video ${videoName} blacklisted`,
-      text
+  async sendMail (options: EmailPayload) {
+    if (!isEmailEnabled()) {
+      logger.info('Cannot send mail because SMTP is not configured.')
+      return
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
-  }
+    const fromDisplayName = options.from
+      ? options.from
+      : CONFIG.INSTANCE.NAME
 
-  addVideoUnblacklistNotification (to: string[], video: VideoModel) {
-    const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath()
-
-    const text = 'Hi,\n\n' +
-      `Your video ${video.name} (${videoUrl}) on ${CONFIG.WEBSERVER.HOST} has been unblacklisted.` +
-      '\n\n' +
-      'Cheers,\n' +
-      `PeerTube.`
-
-    const emailPayload: EmailPayload = {
-      to,
-      subject: `[PeerTube] Video ${video.name} unblacklisted`,
-      text
-    }
+    const email = new Email({
+      send: true,
+      htmlToText: {
+        selectors: [
+          { selector: 'img', format: 'skip' },
+          { selector: 'a', options: { hideLinkHrefIfSameAsText: true } }
+        ]
+      },
+      message: {
+        from: `"${fromDisplayName}" <${CONFIG.SMTP.FROM_ADDRESS}>`
+      },
+      transport: this.transporter,
+      views: {
+        root: join(root(), 'dist', 'server', 'lib', 'emails')
+      },
+      subjectPrefix: CONFIG.EMAIL.SUBJECT.PREFIX
+    })
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
-  }
+    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
+        }
+      }
 
-  addForgetPasswordEmailJob (to: string, resetPasswordUrl: string) {
-    const text = `Hi dear user,\n\n` +
-      `It seems you forgot your password on ${CONFIG.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` +
-      `PeerTube.`
+      // overridden/new variables given for a specific template in the payload
+      const sendOptions = merge(baseOptions, options)
 
-    const emailPayload: EmailPayload = {
-      to: [ to ],
-      subject: 'Reset your PeerTube password',
-      text
+      await email.send(sendOptions)
+        .then(res => logger.debug('Sent email.', { res }))
+        .catch(err => logger.error('Error in email sender.', { err }))
     }
-
-    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 ${CONFIG.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` +
-      `PeerTube.`
-
-    const emailPayload: EmailPayload = {
-      to: [ to ],
-      subject: 'Verify your PeerTube email',
-      text
-    }
-
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+  private warnOnConnectionFailure (err?: Error) {
+    logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err })
   }
 
-  addUserBlockJob (user: UserModel, blocked: boolean, reason?: string) {
-    const reasonString = reason ? ` for the following reason: ${reason}` : ''
-    const blockedWord = blocked ? 'blocked' : 'unblocked'
-    const blockedString = `Your account ${user.username} on ${CONFIG.WEBSERVER.HOST} has been ${blockedWord}${reasonString}.`
-
-    const text = 'Hi,\n\n' +
-      blockedString +
-      '\n\n' +
-      'Cheers,\n' +
-      `PeerTube.`
+  private initSMTPTransport () {
+    logger.info('Using %s:%s as SMTP server.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT)
 
-    const to = user.email
-    const emailPayload: EmailPayload = {
-      to: [ to ],
-      subject: '[PeerTube] Account ' + blockedWord,
-      text
+    let tls
+    if (CONFIG.SMTP.CA_FILE) {
+      tls = {
+        ca: [ readFileSync(CONFIG.SMTP.CA_FILE) ]
+      }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
-  }
-
-  addContactFormJob (fromEmail: string, fromName: 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 = {
-      from: fromEmail,
-      to: [ CONFIG.ADMIN.EMAIL ],
-      subject: '[PeerTube] Contact form submitted',
-      text
+    let auth
+    if (CONFIG.SMTP.USERNAME && CONFIG.SMTP.PASSWORD) {
+      auth = {
+        user: CONFIG.SMTP.USERNAME,
+        pass: CONFIG.SMTP.PASSWORD
+      }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    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
+    })
   }
 
-  sendMail (to: string[], subject: string, text: string, from?: string) {
-    if (!Emailer.isEnabled()) {
-      throw new Error('Cannot send mail because SMTP is not configured.')
-    }
+  private initSendmailTransport () {
+    logger.info('Using sendmail to send emails')
 
-    return this.transporter.sendMail({
-      from: from || CONFIG.SMTP.FROM_ADDRESS,
-      to: to.join(','),
-      subject,
-      text
+    this.transporter = createTransport({
+      sendmail: true,
+      newline: 'unix',
+      path: CONFIG.SMTP.SENDMAIL,
+      logger: bunyanLogger
     })
   }
 
-  private dieOnConnectionFailure (err?: Error) {
-    logger.error('Failed to connect to SMTP %s:%d.', CONFIG.SMTP.HOSTNAME, CONFIG.SMTP.PORT, { err })
-    process.exit(-1)
-  }
-
   static get Instance () {
     return this.instance || (this.instance = new this())
   }