mirror of https://github.com/Requarks/wiki.git
Christian Bläul
2 weeks ago
committed by
GitHub
GitHub
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 371 additions and 2 deletions
Split View
Diff Options
-
1.gitignore
-
5server/app/data.yml
-
8server/db/migrations-sqlite/2.5.292.js
-
8server/db/migrations/2.5.292.js
-
10server/jobs/README.md
-
47server/jobs/send-comment-notification-emails.js
-
3server/models/comments.js
-
8server/modules/comments/default/definition.yml
-
283server/templates/comment-notification.html
@ -0,0 +1,8 @@ |
|||
exports.up = async knex => { |
|||
await knex.schema.alterTable('comments', table => { |
|||
table.boolean('notificationSent').notNullable().defaultTo(false) |
|||
}) |
|||
} |
|||
|
|||
exports.down = knex => { |
|||
} |
|||
@ -0,0 +1,8 @@ |
|||
exports.up = async knex => { |
|||
await knex.schema.alterTable('comments', table => { |
|||
table.boolean('notificationSent').notNullable().defaultTo(false) |
|||
}) |
|||
} |
|||
|
|||
exports.down = knex => { |
|||
} |
|||
@ -0,0 +1,10 @@ |
|||
# About jobs |
|||
|
|||
The files in this directory can be executed manually from the terminal like this: |
|||
|
|||
````bash |
|||
node server/core/worker.js --job=send-comment-notification-emails |
|||
```` |
|||
|
|||
To trigger a job on schedule automatically, you need to add an entry to the file `server/app/data.yml` under the `jobs` |
|||
key. For the `schedule` values, refer to [ISO 8601 durations](https://en.wikipedia.org/wiki/ISO_8601#Durations). |
|||
@ -0,0 +1,47 @@ |
|||
/* global WIKI */ |
|||
|
|||
module.exports = async () => { |
|||
WIKI.models = require('../core/db').init() |
|||
await WIKI.configSvc.loadFromDb() |
|||
WIKI.mail = require('../core/mail').init() |
|||
WIKI.lang = require('../core/localization').init() |
|||
const providers = await WIKI.models.commentProviders.query().where('key', 'default') |
|||
const emailAddresses = providers[0].config.notificationEmailAddresses |
|||
if (!providers[0].isEnabled || !emailAddresses) return |
|||
const unsentComments = await WIKI.models.comments.query().select('id', 'pageId', 'name', 'email', 'content').where('notificationSent', false) |
|||
WIKI.logger.info('Number of comments that need to be sent: ' + unsentComments.length) |
|||
if (!unsentComments.length) return |
|||
let listItems = '' |
|||
for (const comment of unsentComments) { |
|||
const page = await WIKI.models.pages.getPageFromDb(comment.pageId) |
|||
if (!page) { |
|||
throw new WIKI.Error.PageNotFound() |
|||
} |
|||
const interpolation = { |
|||
email: comment.email, |
|||
commentAuthorName: comment.name, |
|||
pagePath: WIKI.config.host + '/' + page.path, |
|||
pageTitle: page.title |
|||
} |
|||
listItems += '<li>' + WIKI.lang.engine.t('emails:notification-email:item', interpolation) + ':<br>' + |
|||
comment.content |
|||
|
|||
await WIKI.models.comments.query().findById(comment.id).patch({ |
|||
notificationSent: true |
|||
}) |
|||
} |
|||
const subject = WIKI.lang.engine.t('emails:notification-email:subject') |
|||
for (const to of emailAddresses.split(/, */)) { |
|||
await WIKI.mail.send({ |
|||
template: 'comment-notification', |
|||
to, |
|||
subject, |
|||
data: { |
|||
preheadertext: WIKI.lang.engine.t('emails:notification-email:preheadertext'), |
|||
title: subject, |
|||
content: '<ul>' + listItems + '</ul>' |
|||
} |
|||
}) |
|||
WIKI.logger.info('Sent notification email to ' + to + '.') |
|||
} |
|||
} |
|||
@ -0,0 +1,283 @@ |
|||
<!DOCTYPE html> |
|||
<html lang="en" xmlns="http://www.w3.org/1999/xhtml" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office"> |
|||
<head> |
|||
<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 --> |
|||
<title></title> <!-- The title tag shows in email notifications, like Android 4.4. --> |
|||
|
|||
<!-- Web Font / @font-face : BEGIN --> |
|||
<!-- NOTE: If web fonts are not required, lines 10 - 27 can be safely removed. --> |
|||
|
|||
<!-- Desktop Outlook chokes on web font references and defaults to Times New Roman, so we force a safe fallback font. --> |
|||
<!--[if mso]> |
|||
<style> |
|||
* { |
|||
font-family: sans-serif !important; |
|||
} |
|||
</style> |
|||
<![endif]--> |
|||
|
|||
<!-- All other clients get the webfont reference; some will render the font and others will silently fail to the fallbacks. More on that here: http://stylecampaign.com/blog/2015/02/webfont-support-in-email/ --> |
|||
<!--[if !mso]><!--> |
|||
<!-- insert web font reference, eg: <link href='https://fonts.googleapis.com/css?family=Roboto:400,700' rel='stylesheet' type='text/css'> --> |
|||
<!--<![endif]--> |
|||
|
|||
<!-- Web Font / @font-face : END --> |
|||
|
|||
<!-- CSS Reset : BEGIN --> |
|||
<style> |
|||
|
|||
/* 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: 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. Fix for Yahoo mail table alignment bug. Applies table-layout to the first 2 tables then removes for anything nested deeper. */ |
|||
table { |
|||
border-spacing: 0 !important; |
|||
border-collapse: collapse !important; |
|||
table-layout: fixed !important; |
|||
margin: 0 auto !important; |
|||
} |
|||
table table table { |
|||
table-layout: auto; |
|||
} |
|||
|
|||
/* 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; |
|||
} |
|||
|
|||
/* What it does: A work-around for email clients meddling in triggered links. */ |
|||
*[x-apple-data-detectors], /* iOS */ |
|||
.unstyle-auto-detected-links *, |
|||
.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; |
|||
} |
|||
} |
|||
|
|||
</style> |
|||
<!-- CSS Reset : END --> |
|||
<!-- Reset list spacing because Outlook ignores much of our inline CSS. --> |
|||
<!--[if mso]> |
|||
<style type="text/css"> |
|||
ul, |
|||
ol { |
|||
margin: 0 !important; |
|||
} |
|||
li { |
|||
margin-left: 30px !important; |
|||
} |
|||
li.list-item-first { |
|||
margin-top: 0 !important; |
|||
} |
|||
li.list-item-last { |
|||
margin-bottom: 10px !important; |
|||
} |
|||
</style> |
|||
<![endif]--> |
|||
|
|||
<!-- 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: #1976d2 !important; |
|||
border-color: #1976d2 !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; |
|||
} |
|||
|
|||
} |
|||
|
|||
</style> |
|||
<!-- Progressive Enhancements : END --> |
|||
|
|||
<!-- 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</o:PixelsPerInch> |
|||
</o:OfficeDocumentSettings> |
|||
</xml> |
|||
<![endif]--> |
|||
|
|||
</head> |
|||
<!-- |
|||
The email background color (#222222) 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 |
|||
--> |
|||
<body width="100%" style="margin: 0; padding: 0 !important; mso-line-height-rule: exactly; background-color: #EEE;"> |
|||
<center style="width: 100%; background-color: #EEE;"> |
|||
<!--[if mso | IE]> |
|||
<table role="presentation" border="0" cellpadding="0" cellspacing="0" width="100%" style="background-color: #222222;"> |
|||
<tr> |
|||
<td> |
|||
<![endif]--> |
|||
|
|||
<!-- Visually Hidden Preheader Text : 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;"> |
|||
<%= preheadertext %> |
|||
</div> |
|||
<!-- 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;"> |
|||
‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ ‌ |
|||
</div> |
|||
<!-- 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. |
|||
--> |
|||
<div style="max-width: 600px; margin: 0 auto;" class="email-container"> |
|||
<!--[if mso]> |
|||
<table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="600"> |
|||
<tr> |
|||
<td> |
|||
<![endif]--> |
|||
|
|||
<!-- Email Body : BEGIN --> |
|||
<table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%" style="margin: 0 auto;"> |
|||
<!-- Email Header : BEGIN --> |
|||
<tr> |
|||
<td style="padding: 20px 0; text-align: center"> |
|||
<img src="<%= logo %>" height="50" alt="<%= siteTitle %>" border="0" style="width: auto; background: #dddddd; font-family: sans-serif; font-size: 15px; line-height: 15px; color: #555555;"> |
|||
</td> |
|||
</tr> |
|||
<!-- Email Header : END --> |
|||
|
|||
<!-- 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;"> |
|||
<h1 style="margin: 0 0 10px 0; font-family: sans-serif; font-size: 25px; line-height: 30px; color: #333333; font-weight: normal;"><%= title %></h1> |
|||
<p style="margin: 0;"><%= content %></p> |
|||
</td> |
|||
</tr> |
|||
</table> |
|||
</td> |
|||
</tr> |
|||
<!-- 1 Column Text + Button : END --> |
|||
|
|||
</table> |
|||
<!-- Email Body : END --> |
|||
|
|||
<!-- Email Footer : BEGIN --> |
|||
<table align="center" role="presentation" cellspacing="0" cellpadding="0" border="0" width="100%" style="margin: 0 auto;"> |
|||
<tr> |
|||
<td style="padding: 20px; font-family: sans-serif; font-size: 12px; line-height: 15px; text-align: center; color: #888888;"> |
|||
<%= copyright %> |
|||
</td> |
|||
</tr> |
|||
</table> |
|||
<!-- Email Footer : END --> |
|||
|
|||
<!--[if mso]> |
|||
</td> |
|||
</tr> |
|||
</table> |
|||
<![endif]--> |
|||
</div> |
|||
|
|||
<!--[if mso | IE]> |
|||
</td> |
|||
</tr> |
|||
</table> |
|||
<![endif]--> |
|||
</center> |
|||
</body> |
|||
</html> |
|||
Write
Preview
Loading…
Cancel
Save