X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Femailer.ts;h=f5c3e474596abf7ec7b8d30eec98a2560378b89a;hb=6cc8a0dfad49addf620a42e78d6f38003a67b310;hp=d54eab96664814db2ebde39f4dad407dc4213de9;hpb=cfde28bac33c3644e1b6218eb471b675a37def60;p=github%2FChocobozzz%2FPeerTube.git

diff --git a/server/lib/emailer.ts b/server/lib/emailer.ts
index d54eab966..f5c3e4745 100644
--- a/server/lib/emailer.ts
+++ b/server/lib/emailer.ts
@@ -2,17 +2,14 @@ import { readFileSync } from 'fs-extra'
 import { 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 { Abuse, EmailPayload } from '@shared/models'
-import { SendEmailOptions } from '../../shared/models/server/emailer.model'
-import { isTestInstance, root } from '../helpers/core-utils'
+import { arrayify, root } from '@shared/core-utils'
+import { EmailPayload, UserRegistrationState } 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, MActorFollowActors, MActorFollowFull, MUser } from '../types/models'
-import { MCommentOwnerVideo, MVideo, MVideoAccountLight } from '../types/models/video'
+import { MRegistration, MUser } from '../types/models'
 import { JobQueue } from './job-queue'
 
 const Email = require('email-templates')
@@ -31,413 +28,47 @@ 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: <a href="${instanceUrl}">${instanceUrl}</a>.`
-    }
-
-    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: <a href="${importUrl}">${importUrl}</a>.`
-
-    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 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,
-        video,
-        videoUrl,
-        action: {
-          text: 'View comment',
-          url: commentUrl
-        }
-      }
+      this.warnOnConnectionFailure(err)
     }
-
-    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 emailPayload: EmailPayload = {
-      template: 'video-comment-mention',
-      to,
-      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 })
-  }
-
-  addAbuseModeratorsNotification (to: string[], parameters: {
-    abuse: Abuse
-    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 })
-  }
-
-  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 (to: string, resetPasswordUrl: string) {
+  addPasswordResetEmailJob (username: string, to: string, resetPasswordUrl: string) {
     const emailPayload: EmailPayload = {
       template: 'password-reset',
       to: [ to ],
       subject: 'Reset your account password',
       locals: {
-        resetPasswordUrl
+        username,
+        resetPasswordUrl,
+
+        hideNotificationPreferencesLink: true
       }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
   addPasswordCreateEmailJob (username: string, to: string, createPasswordUrl: string) {
@@ -447,24 +78,37 @@ class Emailer {
       subject: 'Create your account password',
       locals: {
         username,
-        createPasswordUrl
+        createPasswordUrl,
+
+        hideNotificationPreferencesLink: true
       }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
-  addVerifyEmailJob (to: string, verifyEmailUrl: string) {
+  addVerifyEmailJob (options: {
+    username: string
+    isRegistrationRequest: boolean
+    to: string
+    verifyEmailUrl: string
+  }) {
+    const { username, isRegistrationRequest, to, verifyEmailUrl } = options
+
     const emailPayload: EmailPayload = {
       template: 'verify-email',
       to: [ to ],
-      subject: `Verify your email on ${WEBSERVER.HOST}`,
+      subject: `Verify your email on ${CONFIG.INSTANCE.NAME}`,
       locals: {
-        verifyEmailUrl
+        username,
+        verifyEmailUrl,
+        isRegistrationRequest,
+
+        hideNotificationPreferencesLink: true
       }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
   addUserBlockJob (user: MUser, blocked: boolean, reason?: string) {
@@ -475,10 +119,10 @@ 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 })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
   addContactFormJob (fromEmail: string, fromName: string, subject: string, body: string) {
@@ -490,24 +134,60 @@ class Emailer {
       locals: {
         fromName,
         fromEmail,
-        body
+        body,
+
+        // There are not notification preferences for the contact form
+        hideNotificationPreferencesLink: true
       }
     }
 
-    return JobQueue.Instance.createJob({ type: 'email', payload: emailPayload })
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
+  }
+
+  addUserRegistrationRequestProcessedJob (registration: MRegistration) {
+    let template: string
+    let subject: string
+    if (registration.state === UserRegistrationState.ACCEPTED) {
+      template = 'user-registration-request-accepted'
+      subject = `Your registration request for ${registration.username} has been accepted`
+    } else {
+      template = 'user-registration-request-rejected'
+      subject = `Your registration request for ${registration.username} has been rejected`
+    }
+
+    const to = registration.email
+    const emailPayload: EmailPayload = {
+      to: [ to ],
+      template,
+      subject,
+      locals: {
+        username: registration.username,
+        moderationResponse: registration.moderationResponse,
+        loginLink: WEBSERVER.URL + '/login'
+      }
+    }
+
+    return JobQueue.Instance.createJobAsync({ type: 'email', payload: emailPayload })
   }
 
   async sendMail (options: EmailPayload) {
     if (!isEmailEnabled()) {
-      throw new Error('Cannot send mail because SMTP is not configured.')
+      logger.info('Cannot send mail because SMTP is not configured.')
+      return
     }
 
     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}>`
       },
@@ -518,34 +198,78 @@ 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 = arrayify(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 () {