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

14 files changed, 406 insertions, 0 deletions

diff --git a/server/lib/emails/common/base.pug b/server/lib/emails/common/base.pug
new file mode 100644
index 000000000..9a1894cab
--- /dev/null
+++ b/server/lib/emails/common/base.pug
@@ -0,0 +1,267 @@
+//-
+  The email background color is defined in three places:
+  1. body tag: for most email clients
+  2. center tag: for Gmail and Inbox mobile apps and web versions of Gmail, GSuite, Inbox, Yahoo, AOL, Libero, Comcast, freenet, Mail.ru, Orange.fr
+  3. mso conditional: For Windows 10 Mail
+- var backgroundColor = "#fff";
+- var mainColor = "#f2690d";
+doctype html
+head
+  // This template is heavily adapted from the Cerberus Fluid template. Kudos to them!
+  meta(charset='utf-8')
+  //- utf-8 works for most cases
+  meta(name='viewport' content='width=device-width')
+  //- Forcing initial-scale shouldn't be necessary
+  meta(http-equiv='X-UA-Compatible' content='IE=edge')
+  //- Use the latest (edge) version of IE rendering engine
+  meta(name='x-apple-disable-message-reformatting')
+  //- Disable auto-scale in iOS 10 Mail entirely
+  meta(name='format-detection' content='telephone=no,address=no,email=no,date=no,url=no')
+  //- Tell iOS not to automatically link certain text strings.
+  meta(name='color-scheme' content='light')
+  meta(name='supported-color-schemes' content='light')
+  //- The title tag shows in email notifications, like Android 4.4.
+  title #{subject}
+  //- What it does: Makes background images in 72ppi Outlook render at correct size.
+  //if gte mso 9
+    xml
+      o:officedocumentsettings
+        o:allowpng
+          o:pixelsperinch 96
+  //- CSS Reset : BEGIN
+  style.
+    /* What it does: Tells the email client that only light styles are provided but the client can transform them to dark. A duplicate of meta color-scheme meta tag above. */
+    :root {
+      color-scheme: light;
+      supported-color-schemes: light;
+    }
+    /* What it does: Remove spaces around the email design added by some email clients. */
+    /* Beware: It can remove the padding / margin and add a background color to the compose a reply window. */
+    html,
+    body {
+      margin: 0 auto !important;
+      padding: 0 !important;
+      height: 100% !important;
+      width: 100% !important;
+    }
+    /* What it does: Stops email clients resizing small text. */
+    * {
+      -ms-text-size-adjust: 100%;
+      -webkit-text-size-adjust: 100%;
+    }
+    /* What it does: Centers email on Android 4.4 */
+    div[style*="margin: 16px 0"] {
+      margin: 0 !important;
+    }
+    /* What it does: forces Samsung Android mail clients to use the entire viewport */
+    #MessageViewBody, #MessageWebViewDiv{
+      width: 100% !important;
+    }
+    /* What it does: Stops Outlook from adding extra spacing to tables. */
+    table,
+    td {
+      mso-table-lspace: 0pt !important;
+      mso-table-rspace: 0pt !important;
+    }
+    /* What it does: Fixes webkit padding issue. */
+    table {
+      border-spacing: 0 !important;
+      border-collapse: collapse !important;
+      table-layout: fixed !important;
+      margin: 0 auto !important;
+    }
+    /* What it does: Uses a better rendering method when resizing images in IE. */
+    img {
+      -ms-interpolation-mode:bicubic;
+    }
+    /* What it does: Prevents Windows 10 Mail from underlining links despite inline CSS. Styles for underlined links should be inline. */
+    a {
+      text-decoration: none;
+    }
+    a:not(.nocolor) {
+      color: #{mainColor};
+    }
+    a.nocolor {
+      color: inherit !important;
+    }
+    /* What it does: A work-around for email clients meddling in triggered links. */
+    a[x-apple-data-detectors],  /* iOS */
+    .unstyle-auto-detected-links a,
+    .aBn {
+      border-bottom: 0 !important;
+      cursor: default !important;
+      color: inherit !important;
+      text-decoration: none !important;
+      font-size: inherit !important;
+      font-family: inherit !important;
+      font-weight: inherit !important;
+      line-height: inherit !important;
+    }
+    /* What it does: Prevents Gmail from displaying a download button on large, non-linked images. */
+    .a6S {
+      display: none !important;
+      opacity: 0.01 !important;
+    }
+    /* What it does: Prevents Gmail from changing the text color in conversation threads. */
+    .im {
+      color: inherit !important;
+    }
+    /* If the above doesn't work, add a .g-img class to any image in question. */
+    img.g-img + div {
+      display: none !important;
+    }
+    /* What it does: Removes right gutter in Gmail iOS app: https://github.com/TedGoas/Cerberus/issues/89  */
+    /* Create one of these media queries for each additional viewport size you'd like to fix */
+    /* iPhone 4, 4S, 5, 5S, 5C, and 5SE */
+    @media only screen and (min-device-width: 320px) and (max-device-width: 374px) {
+      u ~ div .email-container {
+        min-width: 320px !important;
+      }
+    }
+    /* iPhone 6, 6S, 7, 8, and X */
+    @media only screen and (min-device-width: 375px) and (max-device-width: 413px) {
+      u ~ div .email-container {
+        min-width: 375px !important;
+      }
+    }
+    /* iPhone 6+, 7+, and 8+ */
+    @media only screen and (min-device-width: 414px) {
+      u ~ div .email-container {
+        min-width: 414px !important;
+      }
+    }
+  //- CSS Reset : END
+  //- CSS for PeerTube : START
+  style.
+    blockquote {
+      margin-left: 0;
+      padding-left: 20px;
+      border-left: 2px solid #f2690d;
+    }
+  //- CSS for PeerTube : END
+  //- Progressive Enhancements : BEGIN
+  style.
+    /* What it does: Hover styles for buttons */
+    .button-td,
+    .button-a {
+      transition: all 100ms ease-in;
+    }
+    .button-td-primary:hover,
+    .button-a-primary:hover {
+      background: #555555 !important;
+      border-color: #555555 !important;
+    }
+    /* Media Queries */
+    @media screen and (max-width: 600px) {
+      /* What it does: Adjust typography on small screens to improve readability */
+      .email-container p {
+        font-size: 17px !important;
+      }
+    }
+  //- Progressive Enhancements : END
+
+body(width="100%" style="margin: 0; padding: 0 !important; mso-line-height-rule: exactly; background-color: #{backgroundColor};")
+  center(role='article' aria-roledescription='email' lang='en' style='width: 100%; background-color: #{backgroundColor};')
+    //if mso | IE
+      table(role='presentation' border='0' cellpadding='0' cellspacing='0' width='100%' style='background-color: #fff;')
+        tr
+          td
+    //- Visually Hidden Preheader Text : BEGIN
+    div(style='max-height:0; overflow:hidden; mso-hide:all;' aria-hidden='true')
+      block preheader
+    //- Visually Hidden Preheader Text : END
+
+    //- Create white space after the desired preview text so email clients don’t pull other distracting text into the inbox preview. Extend as necessary.
+    //- Preview Text Spacing Hack : BEGIN
+    div(style='display: none; font-size: 1px; line-height: 1px; max-height: 0px; max-width: 0px; opacity: 0; overflow: hidden; mso-hide: all; font-family: sans-serif;')
+      | ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌
+    //- Preview Text Spacing Hack : END
+
+    //-
+      Set the email width. Defined in two places:
+      1. max-width for all clients except Desktop Windows Outlook, allowing the email to squish on narrow but never go wider than 600px.
+      2. MSO tags for Desktop Windows Outlook enforce a 600px width.
+    .email-container(style='max-width: 600px; margin: 0 auto;')
+      //if mso
+        table(align='center' role='presentation' cellspacing='0' cellpadding='0' border='0' width='600')
+          tr
+            td
+      //- Email Body : BEGIN
+      table(align='center' role='presentation' cellspacing='0' cellpadding='0' border='0' width='100%' style='margin: auto;')
+        //- 1 Column Text + Button : BEGIN
+        tr
+          td(style='background-color: #ffffff;')
+            table(role='presentation' cellspacing='0' cellpadding='0' border='0' width='100%')
+              tr
+                td(style='padding: 20px; font-family: sans-serif; font-size: 15px; line-height: 20px; color: #555555;')
+                  table(role="presentation" border="0" cellpadding="0" cellspacing="0" width="100%")
+                    tr
+                      td(width="40px")
+                        img(src=`${WEBSERVER.URL}/client/assets/images/icons/icon-192x192.png` width="auto" height="30px" alt="icon" border="0" style="height: 30px; background: #ffffff; font-family: sans-serif; font-size: 15px; line-height: 15px; color: #555555;")
+                      td
+                        h1(style='margin: 10px 0 10px 0; font-family: sans-serif; font-size: 25px; line-height: 30px; color: #333333; font-weight: normal;') 
+                          block title
+                            if title
+                              | #{title}
+                            else
+                              | Something requires your attention
+                  p(style='margin: 0;')
+                    block body
+              if action
+                tr
+                  td(style='padding: 0 20px;')
+                    //- Button : BEGIN
+                    table(align='center' role='presentation' cellspacing='0' cellpadding='0' border='0' style='margin: auto;')
+                      tr
+                        td.button-td.button-td-primary(style='border-radius: 4px; background: #222222;')
+                          a.button-a.button-a-primary(href=action.url style='background: #222222; border: 1px solid #000000; font-family: sans-serif; font-size: 15px; line-height: 15px; text-decoration: none; padding: 13px 17px; color: #ffffff; display: block; border-radius: 4px;') #{action.text}
+                    //- Button : END
+        //- 1 Column Text + Button : END
+        //- Clear Spacer : BEGIN
+        tr
+          td(aria-hidden='true' height='20' style='font-size: 0px; line-height: 0px;')
+        br
+        //- Clear Spacer : END
+        //- 1 Column Text : BEGIN
+        if username
+          tr
+            td(style='background-color: #cccccc;')
+              table(role='presentation' cellspacing='0' cellpadding='0' border='0' width='100%')
+                tr
+                  td(style='padding: 20px; font-family: sans-serif; font-size: 15px; line-height: 20px; color: #555555;')
+                    p(style='margin: 0;')
+                      | You are receiving this email as part of your notification settings on #{WEBSERVER.HOST} for your account #{username}.
+        //- 1 Column Text : END
+      //- Email Body : END
+      //- Email Footer : BEGIN
+      table(align='center' role='presentation' cellspacing='0' cellpadding='0' border='0' width='100%' style='margin: auto;')
+        tr
+          td(style='padding: 20px; padding-bottom: 0px; font-family: sans-serif; font-size: 12px; line-height: 15px; text-align: center; color: #888888;')
+            webversion
+              a.nocolor(href=`${WEBSERVER.URL}/my-account/notifications` style='color: #cccccc; font-weight: bold;') View in your notifications
+            br
+        tr
+          td(style='padding: 20px; padding-top: 10px; font-family: sans-serif; font-size: 12px; line-height: 15px; text-align: center; color: #888888;')
+            unsubscribe
+              a.nocolor(href=`${WEBSERVER.URL}/my-account/settings#notifications` style='color: #888888;') Manage your notification preferences in your profile
+            br
+      //- Email Footer : END
+      //if mso
+    //- Full Bleed Background Section : BEGIN
+    table(role='presentation' cellspacing='0' cellpadding='0' border='0' width='100%' style=`background-color: ${mainColor};`)
+      tr
+        td
+          .email-container(align='center' style='max-width: 600px; margin: auto;')
+            //if mso
+              table(role='presentation' cellspacing='0' cellpadding='0' border='0' width='600' align='center')
+                tr
+                  td
+            table(role='presentation' cellspacing='0' cellpadding='0' border='0' width='100%')
+              tr
+                td(style='padding: 20px; text-align: left; font-family: sans-serif; font-size: 12px; line-height: 20px; color: #ffffff;')
+                  table(role="presentation" border="0" cellpadding="0" cellspacing="0" width="100%")
+                    tr
+                      td(valign="top") #[a(href="https://github.com/Chocobozzz/PeerTube" style="color: white !important") PeerTube © 2015-#{new Date().getFullYear()}] #[a(href="https://github.com/Chocobozzz/PeerTube/blob/master/CREDITS.md" style="color: white !important") PeerTube Contributors]
+            //if mso
+    //- Full Bleed Background Section : END
+    //if mso | IE
diff --git a/server/lib/emails/common/greetings.pug b/server/lib/emails/common/greetings.pug
new file mode 100644
index 000000000..5efe29dfb
--- /dev/null
+++ b/server/lib/emails/common/greetings.pug
@@ -0,0 +1,11 @@
+extends base
+
+block body
+  if username
+    p Hi #{username},
+  else
+    p Hi,
+  block content
+  p
+    | Cheers,#[br]
+    | #{EMAIL.BODY.SIGNATURE}
\ No newline at end of file
diff --git a/server/lib/emails/common/html.pug b/server/lib/emails/common/html.pug
new file mode 100644
index 000000000..d76168b85
--- /dev/null
+++ b/server/lib/emails/common/html.pug
@@ -0,0 +1,4 @@
+extends greetings
+
+block content
+  p !{text}
\ No newline at end of file
diff --git a/server/lib/emails/common/mixins.pug b/server/lib/emails/common/mixins.pug
new file mode 100644
index 000000000..76b805a24
--- /dev/null
+++ b/server/lib/emails/common/mixins.pug
@@ -0,0 +1,3 @@
+mixin channel(channel)
+  - var handle = `${channel.name}@${channel.host}`
+  | #[a(href=`${WEBSERVER.URL}/video-channels/${handle}` title=handle) #{channel.displayName}]
\ No newline at end of file
diff --git a/server/lib/emails/contact-form/html.pug b/server/lib/emails/contact-form/html.pug
new file mode 100644
index 000000000..0073ff78e
--- /dev/null
+++ b/server/lib/emails/contact-form/html.pug
@@ -0,0 +1,9 @@
+extends ../common/greetings
+
+block title
+  | Someone just used the contact form
+
+block content
+  p #{fromName} sent you a message via the contact form on #[a(href=WEBSERVER.URL) #{WEBSERVER.HOST}]:
+  blockquote(style='white-space: pre-wrap') #{body}
+  p You can contact them at #[a(href=`mailto:${fromEmail}`) #{fromEmail}], or simply reply to this email to get in touch.
\ No newline at end of file
diff --git a/server/lib/emails/follower-on-channel/html.pug b/server/lib/emails/follower-on-channel/html.pug
new file mode 100644
index 000000000..8a352e90f
--- /dev/null
+++ b/server/lib/emails/follower-on-channel/html.pug
@@ -0,0 +1,9 @@
+extends ../common/greetings
+
+block title
+  | New follower on your channel
+
+block content
+  p.
+    Your #{followType} #[a(href=followingUrl) #{followingName}] has a new subscriber: 
+    #[a(href=followerUrl) #{followerName}].
\ No newline at end of file
diff --git a/server/lib/emails/password-create/html.pug b/server/lib/emails/password-create/html.pug
new file mode 100644
index 000000000..45ff3078a
--- /dev/null
+++ b/server/lib/emails/password-create/html.pug
@@ -0,0 +1,10 @@
+extends ../common/greetings
+
+block title
+  | Password creation for your account
+
+block content
+  p.
+    Welcome to #[a(href=WEBSERVER.URL) #{WEBSERVER.HOST}], your PeerTube instance. Your username is: #{username}.
+    Please set your password by following #[a(href=createPasswordUrl) this link]: #[a(href=createPasswordUrl) #{createPasswordUrl}] 
+    (this link will expire within seven days).
\ No newline at end of file
diff --git a/server/lib/emails/password-reset/html.pug b/server/lib/emails/password-reset/html.pug
new file mode 100644
index 000000000..bb6a9d16b
--- /dev/null
+++ b/server/lib/emails/password-reset/html.pug
@@ -0,0 +1,12 @@
+extends ../common/greetings
+
+block title
+  | Password reset for your account
+
+block content
+  p.
+    A reset password procedure for your account ${to} has been requested on #[a(href=WEBSERVER.URL) #{WEBSERVER.HOST}].
+    Please follow #[a(href=resetPasswordUrl) this link] to reset it: #[a(href=resetPasswordUrl) #{resetPasswordUrl}] 
+    (the link will expire within 1 hour)
+  p.
+    If you are not the person who initiated this request, please ignore this email.
\ No newline at end of file
diff --git a/server/lib/emails/user-registered/html.pug b/server/lib/emails/user-registered/html.pug
new file mode 100644
index 000000000..20f62125e
--- /dev/null
+++ b/server/lib/emails/user-registered/html.pug
@@ -0,0 +1,10 @@
+extends ../common/greetings
+
+block title
+  | A new user registered
+
+block content
+  - var mail = user.email || user.pendingEmail;
+  p
+    | User #[a(href=`${WEBSERVER.URL}/accounts/${user.username}`) #{user.username}] just registered. 
+    | You might want to contact them at #[a(href=`mailto:${mail}`) #{mail}].
\ No newline at end of file
diff --git a/server/lib/emails/verify-email/html.pug b/server/lib/emails/verify-email/html.pug
new file mode 100644
index 000000000..8a4a77703
--- /dev/null
+++ b/server/lib/emails/verify-email/html.pug
@@ -0,0 +1,14 @@
+extends ../common/greetings
+
+block title
+  | Account verification
+
+block content
+  p Welcome to PeerTube!
+  p.
+    You just created an account #[a(href=WEBSERVER.URL) #{WEBSERVER.HOST}], your new PeerTube instance. 
+    Your username there is: #{username}.
+  p.
+    To start using PeerTube on #[a(href=WEBSERVER.URL) #{WEBSERVER.HOST}] you must verify your email first! 
+    Please follow #[a(href=verifyEmailUrl) this link] to verify this email belongs to you: #[a(href=verifyEmailUrl) #{verifyEmailUrl}] 
+    If you are not the person who initiated this request, please ignore this email.
\ No newline at end of file
diff --git a/server/lib/emails/video-abuse-new/html.pug b/server/lib/emails/video-abuse-new/html.pug
new file mode 100644
index 000000000..999c89d26
--- /dev/null
+++ b/server/lib/emails/video-abuse-new/html.pug
@@ -0,0 +1,18 @@
+extends ../common/greetings
+include ../common/mixins.pug
+
+block title
+  | A video is pending moderation
+
+block content
+  p
+    | #[a(href=WEBSERVER.URL) #{WEBSERVER.HOST}] received an abuse report for the #{videoAbuse.video.channel.isLocal ? '' : 'remote '}video "
+    a(href=videoUrl) #{videoAbuse.video.name}
+    | " by #[+channel(videoAbuse.video.channel)]
+    if videoPublishedAt
+      | , published the #{videoPublishedAt}.
+    else
+      | , uploaded the #{videoCreatedAt} but not yet published.
+  p The reporter, #{reporter}, cited the following reason(s):
+  blockquote #{videoAbuse.reason}
+  br(style="display: none;")
diff --git a/server/lib/emails/video-auto-blacklist-new/html.pug b/server/lib/emails/video-auto-blacklist-new/html.pug
new file mode 100644
index 000000000..07c8dfd16
--- /dev/null
+++ b/server/lib/emails/video-auto-blacklist-new/html.pug
@@ -0,0 +1,17 @@
+extends ../common/greetings
+include ../common/mixins
+
+block title
+  | A video is pending moderation
+
+block content
+  p
+    | A recently added video was auto-blacklisted and requires moderator review before going public:
+    |
+    a(href=videoUrl) #{videoName}
+    |
+    | by #[+channel(channel)].
+  p.
+    Apart from the publisher and the moderation team, no one will be able to see the video until you
+    unblacklist it. If you trust the publisher, any admin can whitelist the user for later videos so
+    that they don't require approval before going public.
diff --git a/server/lib/emails/video-comment-mention/html.pug b/server/lib/emails/video-comment-mention/html.pug
new file mode 100644
index 000000000..9e9ced62d
--- /dev/null
+++ b/server/lib/emails/video-comment-mention/html.pug
@@ -0,0 +1,11 @@
+extends ../common/greetings
+
+block title
+  | Someone mentioned you
+
+block content
+  p.
+    #[a(href=accountUrl title=handle) #{accountName}] mentioned you in a comment on video 
+    "#[a(href=videoUrl) #{video.name}]":
+  blockquote #{comment.text}
+  br(style="display: none;")
\ No newline at end of file
diff --git a/server/lib/emails/video-comment-new/html.pug b/server/lib/emails/video-comment-new/html.pug
new file mode 100644
index 000000000..075af5717
--- /dev/null
+++ b/server/lib/emails/video-comment-new/html.pug
@@ -0,0 +1,11 @@
+extends ../common/greetings
+
+block title
+  | Someone commented your video
+
+block content
+  p.
+    #[a(href=accountUrl title=handle) #{accountName}] added a comment on your video 
+    "#[a(href=videoUrl) #{video.name}]":
+  blockquote #{comment.text}
+  br(style="display: none;")
\ No newline at end of file