+
+
+ Your comment history will be downloaded into a .zip file. After
+ your comment history is unzipped you will have a comma separated
+ value (or .csv) file that you can easily import into your favorite
+ spreadsheet application.
+
+
+
+
+
+
+
+ For each of your comments the following information is included:
+
+
+
+
+
+
+ check
+
+
+
+ When you wrote the comment
+
+
+
+
+
+
+
+ check
+
+
+
+ The permalink URL for the comment
+
+
+
+
+
+
+
+ check
+
+
+
+ The comment text
+
+
+
+
+
+
+
+ check
+
+
+
+ The URL on the article or story where the comment appears
+
+
+
+
+
+
+ Download my comment history
+
+
+ }
+ >
+
+ You will receive an email with a link to download your comment
+ history. You can make one download request every 14 days.
+
+
+ {lastDownloadedAt && (
+
+
+ Your most recent request: {formatter.format(lastDownloadedAt)}
+
+
+ )}
+ {canDownload ? (
+
+ ) : (
+
+
+ query_builder
+
+
+
+ You can submit another request in {scaled} {unit}
+
+
+
+ )}
+
+ );
+};
+
+const enhanced = withFragmentContainer({
+ viewer: graphql`
+ fragment DownloadCommentsContainer_viewer on User {
+ id
+ lastDownloadedAt
+ }
+ `,
+})(DownloadCommentsContainer);
+
+export default enhanced;
diff --git a/src/core/client/stream/tabs/Profile/Settings/RequestCommentsDownloadMutation.ts b/src/core/client/stream/tabs/Profile/Settings/RequestCommentsDownloadMutation.ts
new file mode 100644
index 000000000..fc1fc6771
--- /dev/null
+++ b/src/core/client/stream/tabs/Profile/Settings/RequestCommentsDownloadMutation.ts
@@ -0,0 +1,50 @@
+import { graphql } from "react-relay";
+import { Environment, RecordSourceSelectorProxy } from "relay-runtime";
+
+import { getViewer } from "coral-framework/helpers";
+import {
+ commitMutationPromiseNormalized,
+ createMutation,
+ MutationInput,
+} from "coral-framework/lib/relay";
+
+import { RequestCommentsDownloadMutation as MutationTypes } from "coral-stream/__generated__/RequestCommentsDownloadMutation.graphql";
+
+let clientMutationId = 0;
+
+const RequestCommentsDownloadMutation = createMutation(
+ "requestCommentsDownload",
+ (environment: Environment, input: MutationInput) => {
+ const updater = (store: RecordSourceSelectorProxy) => {
+ const viewer = getViewer(environment)!;
+ const user = store.get(viewer.id);
+ const now = new Date();
+
+ if (user !== null) {
+ user.setValue(now.toISOString(), "lastDownloadedAt");
+ }
+ };
+
+ return commitMutationPromiseNormalized(environment, {
+ mutation: graphql`
+ mutation RequestCommentsDownloadMutation(
+ $input: RequestCommentsDownloadInput!
+ ) {
+ requestCommentsDownload(input: $input) {
+ clientMutationId
+ }
+ }
+ `,
+ variables: {
+ input: {
+ ...input,
+ clientMutationId: (clientMutationId++).toString(),
+ },
+ },
+ optimisticUpdater: updater,
+ updater,
+ });
+ }
+);
+
+export default RequestCommentsDownloadMutation;
diff --git a/src/core/client/stream/tabs/Profile/Settings/SettingsContainer.tsx b/src/core/client/stream/tabs/Profile/Settings/SettingsContainer.tsx
index 8406ef682..c5d3917a9 100644
--- a/src/core/client/stream/tabs/Profile/Settings/SettingsContainer.tsx
+++ b/src/core/client/stream/tabs/Profile/Settings/SettingsContainer.tsx
@@ -7,6 +7,7 @@ import { SettingsContainer_viewer } from "coral-stream/__generated__/SettingsCon
import { HorizontalGutter } from "coral-ui/components";
import ChangePasswordContainer from "./ChangePasswordContainer";
+import DownloadCommentsContainer from "./DownloadCommentsContainer";
import IgnoreUserSettingsContainer from "./IgnoreUserSettingsContainer";
import styles from "./SettingsContainer.css";
@@ -20,6 +21,7 @@ const SettingsContainer: FunctionComponent = ({ viewer, settings }) => (
+
);
@@ -27,6 +29,7 @@ const enhanced = withFragmentContainer({
viewer: graphql`
fragment SettingsContainer_viewer on User {
...IgnoreUserSettingsContainer_viewer
+ ...DownloadCommentsContainer_viewer
}
`,
settings: graphql`
diff --git a/src/core/client/stream/test/profile/__snapshots__/settings.spec.tsx.snap b/src/core/client/stream/test/profile/__snapshots__/settings.spec.tsx.snap
index a0fb6b6b7..095c9d045 100644
--- a/src/core/client/stream/test/profile/__snapshots__/settings.spec.tsx.snap
+++ b/src/core/client/stream/test/profile/__snapshots__/settings.spec.tsx.snap
@@ -329,6 +329,45 @@ Commenters you ignore will still be able to see your comments.
+
+
+ Download my comment history
+
+
+ You will receive an email with a link to download your comment history.
+You can make
+
+ one download request every 14 days.
+
+
+
+
diff --git a/src/core/common/constants.ts b/src/core/common/constants.ts
index c0173b983..00ba17de1 100644
--- a/src/core/common/constants.ts
+++ b/src/core/common/constants.ts
@@ -34,3 +34,9 @@ export const TOXICITY_MODEL_DEFAULT = "TOXICITY";
*/
export const TOXICITY_ENDPOINT_DEFAULT =
"https://commentanalyzer.googleapis.com/v1alpha1";
+
+/**
+ * DOWNLOAD_LIMIT_TIMEFRAME is the number of seconds that a given download may
+ * be made within.
+ */
+export const DOWNLOAD_LIMIT_TIMEFRAME = 14 * 86400;
diff --git a/src/core/server/app/handlers/api/account/download.ts b/src/core/server/app/handlers/api/account/download.ts
new file mode 100644
index 000000000..043a96905
--- /dev/null
+++ b/src/core/server/app/handlers/api/account/download.ts
@@ -0,0 +1,269 @@
+import archiver from "archiver";
+import stringify from "csv-stringify";
+import DataLoader from "dataloader";
+import { Response } from "express";
+import Joi from "joi";
+import { kebabCase } from "lodash";
+import { Db } from "mongodb";
+
+import { AppOptions } from "coral-server/app";
+import { validate } from "coral-server/app/request/body";
+import { RequestLimiter } from "coral-server/app/request/limiter";
+import { getLatestRevision } from "coral-server/models/comment";
+import { Comment } from "coral-server/models/comment";
+import { retrieveManyStories } from "coral-server/models/story";
+import { Tenant } from "coral-server/models/tenant";
+import { User } from "coral-server/models/user";
+import { decodeJWT, extractTokenFromRequest } from "coral-server/services/jwt";
+import { verifyDownloadTokenString } from "coral-server/services/users/download/download";
+import { RequestHandler } from "coral-server/types/express";
+import { Request } from "coral-server/types/express";
+
+const BATCH_SIZE = 100;
+const USER_ID_LIMITER_TTL = "1d";
+
+export type DownloadOptions = Pick<
+ AppOptions,
+ "mongo" | "redis" | "signingConfig" | "config"
+>;
+
+async function sendExport(
+ mongo: Db,
+ tenant: Tenant,
+ user: Readonly,
+ latestContentDate: Date,
+ res: Response
+) {
+ // Create the date formatter to format the dates for the CSV.
+ const formatter = Intl.DateTimeFormat(tenant.locale, {
+ year: "numeric",
+ month: "numeric",
+ day: "numeric",
+ hour: "numeric",
+ minute: "numeric",
+ second: "numeric",
+ hour12: false,
+ });
+
+ // Create a DataLoader to load stories for each batch.
+ const getStories = new DataLoader((ids: string[]) =>
+ retrieveManyStories(mongo, tenant.id, ids)
+ );
+
+ // Create a cursor to iterate over the user's comment's in order.
+ const cursor = mongo
+ .collection>("comments")
+ .find({
+ tenantID: tenant.id,
+ authorID: user.id,
+ createdAt: {
+ $lt: latestContentDate,
+ },
+ })
+ .sort({ createdAt: 1 });
+
+ // Collect all the user's comments in batches.
+ let commentBatch: Array> = [];
+
+ // Generate the filename of the file that the user will download.
+ const filename = `talk-${kebabCase(user.username)}-${kebabCase(
+ formatter.format(latestContentDate)
+ )}.zip`;
+
+ res.writeHead(200, {
+ "Content-Type": "application/octet-stream",
+ "Content-Disposition": `attachment; filename=${filename}`,
+ });
+
+ // Create the zip archive we'll use to write all the exported files to.
+ const archive = archiver("zip", {
+ zlib: { level: 9 },
+ });
+
+ // Pipe this to the response writer directly.
+ archive.pipe(res);
+
+ // Create all the csv writers that'll write the data to the archive.
+ const csv = stringify();
+
+ // Add all the streams as files to the archive.
+ archive.append(csv, { name: "comments-export/my_comments.csv" });
+
+ csv.write([
+ "Comment ID",
+ "Published Timestamp",
+ "Article URL",
+ "Comment URL",
+ "Comment Text",
+ ]);
+
+ /**
+ * writeAndFlushBatch will write the given batch of comments to the CSV and
+ * flush out the batchfor the next run.
+ */
+ const writeAndFlushBatch = async () => {
+ const stories = await getStories.loadMany(
+ commentBatch.map(({ storyID }) => storyID)
+ );
+
+ for (let i = 0; i < commentBatch.length; i++) {
+ const comment = commentBatch[i];
+ const story = stories[i];
+ if (!story) {
+ continue;
+ }
+
+ const revision = getLatestRevision(comment);
+
+ const commentID = comment.id;
+ const createdAt = formatter.format(new Date(comment.createdAt));
+ const storyURL = story.url;
+ const commentURL = `${storyURL}?commentID=${commentID}`;
+ const body = revision.body;
+
+ csv.write([commentID, createdAt, storyURL, commentURL, body]);
+ }
+
+ commentBatch = [];
+ };
+
+ while (await cursor.hasNext()) {
+ const comment = await cursor.next();
+ if (!comment) {
+ break;
+ }
+
+ commentBatch.push(comment);
+
+ if (commentBatch.length >= BATCH_SIZE) {
+ await writeAndFlushBatch();
+ }
+ }
+
+ if (commentBatch.length > 0) {
+ await writeAndFlushBatch();
+ }
+
+ csv.end();
+
+ // Mark the end of adding files, no more files can be added after this. Once
+ // all the stream readers have finished writing, and have closed, the
+ // archiver will close which will finish the HTTP request.
+ await archive.finalize();
+}
+
+export interface DownloadBody {
+ token: string;
+}
+
+export const DownloadBodySchema = Joi.object().keys({
+ token: Joi.string().trim(),
+});
+
+export const downloadHandler = ({
+ mongo,
+ redis,
+ signingConfig,
+ config,
+}: DownloadOptions): RequestHandler => {
+ const userIDLimiter = new RequestLimiter({
+ redis,
+ ttl: USER_ID_LIMITER_TTL,
+ max: 1,
+ prefix: "userID",
+ config,
+ });
+
+ return async (req: Request, res, next) => {
+ // Tenant is guaranteed at this point.
+ const coral = req.coral!;
+ const tenant = coral.tenant!;
+
+ // Get the fields from the body. Validate will throw an error if the body
+ // does not conform to the specification.
+ const { token }: DownloadBody = validate(DownloadBodySchema, req.body);
+
+ // Decode the token so we can rate limit based on the user's ID.
+ const { sub: userID } = decodeJWT(token);
+ if (!userID) {
+ return res.sendStatus(400);
+ }
+
+ await userIDLimiter.test(req, userID);
+
+ try {
+ const {
+ token: { iat },
+ user,
+ } = await verifyDownloadTokenString(
+ mongo,
+ tenant,
+ signingConfig,
+ token,
+ coral.now
+ );
+
+ // Only load comments since this download token was issued.
+ const latestContentDate = new Date(iat * 1000);
+
+ // Send the export down the response.
+ await sendExport(mongo, tenant, user, latestContentDate, res);
+
+ return;
+ } catch (err) {
+ return next(err);
+ }
+ };
+};
+
+export type DownloadCheckOptions = Pick<
+ AppOptions,
+ "mongo" | "redis" | "signingConfig" | "config"
+>;
+
+export const downloadCheckHandler = ({
+ mongo,
+ redis,
+ signingConfig,
+ config,
+}: DownloadCheckOptions): RequestHandler => {
+ const userIDLimiter = new RequestLimiter({
+ redis,
+ ttl: USER_ID_LIMITER_TTL,
+ max: 1,
+ prefix: "userID",
+ config,
+ });
+
+ return async (req, res, next) => {
+ try {
+ // Tenant is guaranteed at this point.
+ const coral = req.coral!;
+ const tenant = coral.tenant!;
+
+ const tokenString = extractTokenFromRequest(req, true);
+ if (!tokenString) {
+ return res.sendStatus(400);
+ }
+
+ const { sub: userID } = decodeJWT(tokenString);
+ if (!userID) {
+ return res.sendStatus(400);
+ }
+
+ await userIDLimiter.test(req, userID);
+
+ await verifyDownloadTokenString(
+ mongo,
+ tenant,
+ signingConfig,
+ tokenString,
+ coral.now
+ );
+
+ return res.sendStatus(204);
+ } catch (err) {
+ return next(err);
+ }
+ };
+};
diff --git a/src/core/server/app/handlers/api/account/index.ts b/src/core/server/app/handlers/api/account/index.ts
index ea68cb5a2..648f118c8 100644
--- a/src/core/server/app/handlers/api/account/index.ts
+++ b/src/core/server/app/handlers/api/account/index.ts
@@ -1,2 +1,3 @@
export * from "./confirm";
export * from "./invite";
+export * from "./download";
diff --git a/src/core/server/app/router/api/account.ts b/src/core/server/app/router/api/account.ts
index 9a7133bcd..6be6821bf 100644
--- a/src/core/server/app/router/api/account.ts
+++ b/src/core/server/app/router/api/account.ts
@@ -1,3 +1,4 @@
+import bodyParser from "body-parser";
import express from "express";
import { AppOptions } from "coral-server/app";
@@ -5,6 +6,8 @@ import {
confirmCheckHandler,
confirmHandler,
confirmRequestHandler,
+ downloadCheckHandler,
+ downloadHandler,
inviteCheckHandler,
inviteHandler,
} from "coral-server/app/handlers";
@@ -30,5 +33,14 @@ export function createNewAccountRouter(
router.get("/invite", inviteCheckHandler(app));
router.put("/invite", jsonMiddleware, inviteHandler(app));
+ router.get("/downloadcheck", downloadCheckHandler(app));
+ router.post(
+ "/download",
+ bodyParser.urlencoded({
+ extended: true,
+ }),
+ downloadHandler(app)
+ );
+
return router;
}
diff --git a/src/core/server/graph/tenant/mutators/Users.ts b/src/core/server/graph/tenant/mutators/Users.ts
index 70e18df13..835955919 100644
--- a/src/core/server/graph/tenant/mutators/Users.ts
+++ b/src/core/server/graph/tenant/mutators/Users.ts
@@ -10,6 +10,7 @@ import {
removeBan,
removeIgnore,
removeSuspension,
+ requestCommentsDownload,
setEmail,
setPassword,
setUsername,
@@ -31,6 +32,7 @@ import {
GQLRemoveUserBanInput,
GQLRemoveUserIgnoreInput,
GQLRemoveUserSuspensionInput,
+ GQLRequestCommentsDownloadInput,
GQLSetEmailInput,
GQLSetPasswordInput,
GQLSetUsernameInput,
@@ -155,4 +157,14 @@ export const Users = (ctx: TenantContext) => ({
ignore(ctx.mongo, ctx.tenant, ctx.user!, input.userID, ctx.now),
removeIgnore: async (input: GQLRemoveUserIgnoreInput) =>
removeIgnore(ctx.mongo, ctx.tenant, ctx.user!, input.userID),
+ requestCommentsDownload: async (input: GQLRequestCommentsDownloadInput) =>
+ requestCommentsDownload(
+ ctx.mongo,
+ ctx.mailerQueue,
+ ctx.tenant,
+ ctx.config,
+ ctx.signingConfig!,
+ ctx.user!,
+ ctx.now
+ ),
});
diff --git a/src/core/server/graph/tenant/resolvers/Mutation.ts b/src/core/server/graph/tenant/resolvers/Mutation.ts
index 0591ea9fc..2126cdea5 100644
--- a/src/core/server/graph/tenant/resolvers/Mutation.ts
+++ b/src/core/server/graph/tenant/resolvers/Mutation.ts
@@ -177,4 +177,8 @@ export const Mutation: Required> = {
user: await ctx.mutators.Users.removeIgnore(input),
clientMutationId: input.clientMutationId,
}),
+ requestCommentsDownload: async (sourc, { input }, ctx) => ({
+ user: await ctx.mutators.Users.requestCommentsDownload(input),
+ clientMutationId: input.clientMutationId,
+ }),
};
diff --git a/src/core/server/graph/tenant/schema/schema.graphql b/src/core/server/graph/tenant/schema/schema.graphql
index 94ddb3c01..2f93fa7dc 100644
--- a/src/core/server/graph/tenant/schema/schema.graphql
+++ b/src/core/server/graph/tenant/schema/schema.graphql
@@ -1599,6 +1599,12 @@ type User {
createdAt is the time that the User was created at.
"""
createdAt: Time!
+
+ """
+ lastDownloadedAt the last time the user made a download request
+ of their account data.
+ """
+ lastDownloadedAt: Time
}
"""
@@ -4400,6 +4406,24 @@ type RemoveUserIgnorePayload {
clientMutationId: String!
}
+#########################
+# requestCommentsDownload
+#########################
+
+input RequestCommentsDownloadInput {
+ """
+ clientMutationId is required for Relay support.
+ """
+ clientMutationId: String!
+}
+
+type RequestCommentsDownloadPayload {
+ """
+ clientMutationId is required for Relay support.
+ """
+ clientMutationId: String!
+}
+
##################
## Mutation
##################
@@ -4663,6 +4687,13 @@ type Mutation {
"""
removeUserIgnore(input: RemoveUserIgnoreInput!): RemoveUserIgnorePayload!
@auth(permit: [SUSPENDED, BANNED])
+
+ """
+ requestCommentsDownload allows a user to request to download their comments.
+ """
+ requestCommentsDownload(
+ input: RequestCommentsDownloadInput!
+ ): RequestCommentsDownloadPayload! @auth(permit: [SUSPENDED, BANNED])
}
##################
diff --git a/src/core/server/locales/en-US/email.ftl b/src/core/server/locales/en-US/email.ftl
index a0c10054b..570465e27 100644
--- a/src/core/server/locales/en-US/email.ftl
+++ b/src/core/server/locales/en-US/email.ftl
@@ -45,3 +45,8 @@ email-subject-invite = Coral Team invite
email-notification-template-invite =
You have been invited to join the { $organizationName } team on Coral. Finish
setting up your account here.
+
+email-subject-downloadComments = Your comments are ready for download
+email-notification-template-downloadComments =
+ Your comments from { $organizationName } as of { $date } are now available for download.
+ Download my comment archive
\ No newline at end of file
diff --git a/src/core/server/models/user/user.ts b/src/core/server/models/user/user.ts
index 0daf0314d..7e7ad1979 100644
--- a/src/core/server/models/user/user.ts
+++ b/src/core/server/models/user/user.ts
@@ -292,6 +292,12 @@ export interface User extends TenantResource {
*/
ignoredUsers: IgnoredUser[];
+ /**
+ * lastDownloadedAt is the last time the user requested to download their
+ * user data.
+ */
+ lastDownloadedAt?: Date;
+
/**
* createdAt is the time that the User was created at.
*/
@@ -1794,3 +1800,36 @@ export async function removeUserIgnore(
return result.value;
}
+
+export async function setUserLastDownloadedAt(
+ mongo: Db,
+ tenantID: string,
+ id: string,
+ now: Date
+) {
+ const result = await collection(mongo).findOneAndUpdate(
+ {
+ id,
+ tenantID,
+ },
+ {
+ $set: { lastDownloadedAt: now },
+ },
+ {
+ // False to return the updated document instead of the original
+ // document.
+ returnOriginal: false,
+ }
+ );
+ if (!result.value) {
+ // Get the user so we can figure out why the ignore operation failed.
+ const user = await retrieveUser(mongo, tenantID, id);
+ if (!user) {
+ throw new UserNotFoundError(id);
+ }
+
+ throw new Error("an unexpected error occurred");
+ }
+
+ return result.value;
+}
diff --git a/src/core/server/queue/tasks/mailer/templates/download-comments.html b/src/core/server/queue/tasks/mailer/templates/download-comments.html
new file mode 100644
index 000000000..6ee13b1be
--- /dev/null
+++ b/src/core/server/queue/tasks/mailer/templates/download-comments.html
@@ -0,0 +1,7 @@
+{% extends "layouts/user-notification.html" %}
+
+{% block content %}
+ Your comments from {{ context.organizationName }} as of {{ context.date }} are
+ now available for download.
+ Download my comment archive
+{% endblock %}
diff --git a/src/core/server/queue/tasks/mailer/templates/index.ts b/src/core/server/queue/tasks/mailer/templates/index.ts
index ad3941ef3..f1c57a339 100644
--- a/src/core/server/queue/tasks/mailer/templates/index.ts
+++ b/src/core/server/queue/tasks/mailer/templates/index.ts
@@ -62,12 +62,22 @@ export type InviteEmailTemplate = UserNotificationContext<
}
>;
+export type DownloadCommentsTemplate = UserNotificationContext<
+ "download-comments",
+ {
+ username: string;
+ date: string;
+ downloadUrl: string;
+ }
+>;
+
type Templates =
| BanTemplate
| ConfirmEmailTemplate
| ForgotPasswordTemplate
| InviteEmailTemplate
| PasswordChangeTemplate
- | SuspendTemplate;
+ | SuspendTemplate
+ | DownloadCommentsTemplate;
export { Templates as Template };
diff --git a/src/core/server/services/users/download/download.ts b/src/core/server/services/users/download/download.ts
new file mode 100644
index 000000000..adc3c27d0
--- /dev/null
+++ b/src/core/server/services/users/download/download.ts
@@ -0,0 +1,104 @@
+import Joi from "joi";
+import { isNull } from "lodash";
+import { DateTime } from "luxon";
+import { Db } from "mongodb";
+import uuid from "uuid";
+
+import { constructTenantURL } from "coral-server/app/url";
+import { Config } from "coral-server/config";
+import { TokenInvalidError, UserNotFoundError } from "coral-server/errors";
+import { Tenant } from "coral-server/models/tenant";
+import { retrieveUser } from "coral-server/models/user";
+import {
+ JWTSigningConfig,
+ signString,
+ StandardClaims,
+ StandardClaimsSchema,
+ verifyJWT,
+} from "coral-server/services/jwt";
+
+interface DownloadToken extends Required {
+ aud: "download";
+}
+
+const DownloadTokenSchema = StandardClaimsSchema.keys({
+ aud: Joi.string().only("download"),
+});
+
+export async function generateDownloadLink(
+ userID: string,
+ tenant: Tenant,
+ config: Config,
+ signingConfig: JWTSigningConfig,
+ now: Date
+) {
+ const nowDate = DateTime.fromJSDate(now);
+ const nowSeconds = Math.round(nowDate.toSeconds());
+ const expiresAt = Math.round(nowDate.plus({ weeks: 2 }).toSeconds());
+
+ const downloadToken: DownloadToken = {
+ jti: uuid.v4(),
+ iss: tenant.id,
+ sub: userID,
+ exp: expiresAt,
+ iat: nowSeconds,
+ nbf: nowSeconds,
+ aud: "download",
+ };
+
+ const token = await signString(signingConfig, downloadToken);
+
+ return constructTenantURL(
+ config,
+ tenant,
+ `/account/download#downloadToken=${token}`
+ );
+}
+
+export function validateDownloadToken(
+ token: DownloadToken | object
+): Error | null {
+ const { error } = Joi.validate(token, DownloadTokenSchema, {
+ presence: "required",
+ });
+ return error || null;
+}
+
+export function isDownloadToken(
+ token: DownloadToken | object
+): token is DownloadToken {
+ return isNull(validateDownloadToken(token));
+}
+
+export async function verifyDownloadTokenString(
+ mongo: Db,
+ tenant: Tenant,
+ signingConfig: JWTSigningConfig,
+ tokenString: string,
+ now: Date
+) {
+ const token = verifyJWT(tokenString, signingConfig, now, {
+ issuer: tenant.id,
+ audience: "download",
+ });
+
+ if (!isDownloadToken(token)) {
+ throw new TokenInvalidError(
+ tokenString,
+ "does not conform to the download token schema"
+ );
+ }
+
+ const { sub: userID, iss } = token;
+
+ const user = await retrieveUser(mongo, tenant.id, userID);
+ if (!user) {
+ throw new UserNotFoundError(userID);
+ }
+
+ if (iss !== tenant.id) {
+ throw new TokenInvalidError(tokenString, "invalid tenant");
+ }
+
+ return { token, user };
+}
diff --git a/src/core/server/services/users/index.ts b/src/core/server/services/users/index.ts
index d855d2c63..baf0624de 100644
--- a/src/core/server/services/users/index.ts
+++ b/src/core/server/services/users/index.ts
@@ -1,6 +1,8 @@
import { DateTime } from "luxon";
import { Db } from "mongodb";
+import { DOWNLOAD_LIMIT_TIMEFRAME } from "coral-common/constants";
+import { Config } from "coral-server/config";
import {
DuplicateEmailError,
DuplicateUserError,
@@ -33,6 +35,7 @@ import {
retrieveUser,
retrieveUserWithEmail,
setUserEmail,
+ setUserLastDownloadedAt,
setUserLocalProfile,
setUserUsername,
suspendUser,
@@ -52,6 +55,8 @@ import { userIsStaff } from "coral-server/models/user/helpers";
import { MailerQueue } from "coral-server/queue/tasks/mailer";
import { JWTSigningConfig, signPATString } from "coral-server/services/jwt";
+import logger from "coral-server/logger";
+import { generateDownloadLink } from "./download/download";
import { validateEmail, validatePassword, validateUsername } from "./helpers";
export type InsertUser = InsertUserInput;
@@ -681,3 +686,59 @@ export async function removeIgnore(
return targetUser;
}
+
+export async function requestCommentsDownload(
+ mongo: Db,
+ mailer: MailerQueue,
+ tenant: Tenant,
+ config: Config,
+ signingConfig: JWTSigningConfig,
+ user: User,
+ now: Date
+) {
+ // Check to see if the user is allowed to download this now.
+ if (
+ user.lastDownloadedAt &&
+ DateTime.fromJSDate(user.lastDownloadedAt)
+ .plus({ seconds: DOWNLOAD_LIMIT_TIMEFRAME })
+ .toSeconds() >= DateTime.fromJSDate(now).toSeconds()
+ ) {
+ throw new Error("requested download too early");
+ }
+
+ const downloadUrl = await generateDownloadLink(
+ user.id,
+ tenant,
+ config,
+ signingConfig,
+ now
+ );
+
+ await setUserLastDownloadedAt(mongo, tenant.id, user.id, now);
+
+ if (user.email) {
+ await mailer.add({
+ tenantID: tenant.id,
+ message: {
+ to: user.email,
+ },
+ template: {
+ name: "download-comments",
+ context: {
+ username: user.username!,
+ date: Intl.DateTimeFormat(tenant.locale).format(now),
+ downloadUrl,
+ organizationName: tenant.organization.name,
+ organizationURL: tenant.organization.url,
+ },
+ },
+ });
+ } else {
+ logger.error(
+ { userID: user.id },
+ "could not send download email because the user does not have an email address"
+ );
+ }
+
+ return user;
+}
diff --git a/src/locales/en-US/account.ftl b/src/locales/en-US/account.ftl
index 7843e54ed..cf4ad892f 100644
--- a/src/locales/en-US/account.ftl
+++ b/src/locales/en-US/account.ftl
@@ -31,3 +31,24 @@ confirmEmail-successfullyConfirmed = Email successfully confirmed
confirmEmail-youMayClose =
You may now close this window.
+## Download
+
+download-landingPage-title = Download Your Comment History
+download-landingPage-description =
+ Your comment history will be downloaded into a .zip file. After your
+ comment history is unzipped you will have a comma separated value (or .csv)
+ file that you can easily import into your favorite spreadsheet
+ application.
+download-landingPage-contentsDescription =
+ For each of your comments the following information is included:
+download-landingPage-contentsDate =
+ When you wrote the comment
+download-landingPage-contentsUrl =
+ The permalink URL for the comment
+download-landingPage-contentsText =
+ The comment text
+download-landingPage-contentsStoryUrl =
+ The URL on the article or story where the comment appears
+download-landingPage-downloadComments =
+ Download My Comment History
+download-landingPage-sorry = Your download link is invalid.
\ No newline at end of file
diff --git a/src/locales/en-US/stream.ftl b/src/locales/en-US/stream.ftl
index 57de81652..f0225f4b5 100644
--- a/src/locales/en-US/stream.ftl
+++ b/src/locales/en-US/stream.ftl
@@ -173,6 +173,19 @@ profile-settings-changePassword-button = Change Password
profile-settings-changePassword-updated =
Your password has been updated
+profile-settings-download-comments-title = Download my comment history
+profile-settings-download-comments-description =
+ You will receive an email with a link to download your comment history.
+ You can make one download request every 14 days.
+profile-settings-download-comments-request =
+ Request comment history
+profile-settings-download-comments-request-icon =
+ .title = Request comment history
+profile-settings-download-comments-recentRequest =
+ Your most recent request: { $timeStamp }
+profile-settings-download-comments-timeOut =
+ You can submit another request in { framework-timeago-time }
+
## Report Comment Popover
comments-reportPopover =
.description = A dialog for reporting comments
@@ -247,8 +260,8 @@ configure-openStream-openStream = Open Stream
comments-tombstone-ignore = This comment is hidden because you ignored {$username}
suspendInfo-heading = Your account has been temporarily suspended from commenting.
-suspendInfo-info =
+suspendInfo-info =
In accordance with { $organization }'s community guidelines your
account has been temporarily suspended. While suspended you will not
be able to comment, respect or report comments. Please rejoin the
- conversation on { $until }
\ No newline at end of file
+ conversation on { $until }