feat: add 'linkType' property to new mirrors

This will allow download-only services to integrate with the mirror bot

Author: kyleratti

src/controllers/admin/mirroredvideos.ts

@@ -10,7 +10,7 @@ router.get("/get", async (req: Request, res: Response) => {
   authorized(req, res, async () => {
     let reqData = req.body.data;
     let reqUrl = reqData.reqUrl;
-    let mirroredVideo;
+    let mirroredVideo: AvailableMirror;
 
     try {
       mirroredVideo = await AvailableMirror.findOne({ mirrorUrl: reqUrl });
@@ -32,8 +32,9 @@ router.get("/get", async (req: Request, res: Response) => {
         message: `OK`,
         data: {
           id: mirroredVideo.id,
-          url: mirroredVideo.url,
+          url: mirroredVideo.mirrorUrl,
           botUsername: mirroredVideo.bot.username,
+          linkType: mirroredVideo.linkType,
           createdAt: mirroredVideo.createdAt,
           updatedAt: mirroredVideo.updatedAt,
         },
@@ -76,6 +77,7 @@ router.get("/getall", async (req: Request, res: Response) => {
         redditPostId: mirroredVideo.redditPostId,
         mirrorUrl: mirroredVideo.mirrorUrl,
         botUsername: mirroredVideo.bot.username,
+        linkType: mirroredVideo.linkType,
         createdAt: mirroredVideo.createdAt,
         updatedAt: mirroredVideo.updatedAt,
       });

src/controllers/bot/mirroredvideos.ts

@@ -7,6 +7,7 @@ import { redditapi } from "../../services/redditapi";
 import {
   CreateMirrorRequest,
   DeleteRequest,
+  LinkType,
   UpdateRequest,
 } from "../../structures";
 import { hasAuthHeaders, isAuthorized, isValidRequest } from "./api";
@@ -25,6 +26,7 @@ async function createVideo(data: CreateMirrorRequest) {
   newMirroredVideo.redditPostId = data.redditPostId;
   newMirroredVideo.mirrorUrl = data.url;
   newMirroredVideo.bot = data.bot;
+  newMirroredVideo.linkType = data.linkType;
   await newMirroredVideo.save();
 }
 
@@ -63,7 +65,11 @@ router.all("/*", async (req, res, next) => {
 router.post("/update", async (req, res) => {
   const bot = res.locals.bot as RegisteredBot;
   const data = req.body.data as UpdateRequest;
-  const [redditPostId, url] = [data.redditPostId, data.url];
+  const [redditPostId, url, linkType] = [
+    data.redditPostId,
+    data.url,
+    data.linkType ?? LinkType.Mirror,
+  ];
 
   let commentReply: CommentReply;
 
@@ -146,10 +152,11 @@ router.post("/update", async (req, res) => {
     });
   } else {
     try {
-      createVideo({
-        redditPostId: redditPostId,
-        url: url,
-        bot: bot,
+      await createVideo({
+        redditPostId,
+        url,
+        bot,
+        linkType,
       });
     } catch (err) {
       req.log.error(err);

src/controllers/cron/commentreply.ts

@@ -9,7 +9,7 @@ import { response } from "..";
 import * as configuration from "../../configuration";
 import { AvailableMirror, CommentReply } from "../../entity";
 import { redditapi } from "../../services";
-import { CommentReplyStatus } from "../../structures";
+import { CommentReplyStatus, LinkType } from "../../structures";
 
 const router: Router = Router();
 
@@ -47,25 +47,58 @@ async function hasStickiedReplies(submissionId: string) {
   return false;
 }
 
+const generateFormattedDownloads = (downloads: AvailableMirror[]) => {
+  const formattedDownloads = [];
+
+  downloads.forEach((download) => {
+    const [mirrorUrl, botUsername] = [
+      download.mirrorUrl,
+      download.bot.username,
+    ];
+
+    formattedDownloads.push();
+  });
+};
+
 /**
  * Generates a formatted comment reply string containing all available mirrors
  * @param mirrors An array of AvailableMirror objects
  */
-function generateFormattedMirrors(mirrors: AvailableMirror[]): string {
-  let formattedMirrors: string[] = [];
-
-  for (let i = 0; i < mirrors.length; i++) {
-    const mirror = mirrors[i];
+function generateFormattedMirrors(allMirrors: AvailableMirror[]): string {
+  const [mirrors, downloads] = [
+    allMirrors.filter((obj) => obj.linkType === LinkType.Mirror),
+    allMirrors.filter((obj) => obj.linkType === LinkType.Download),
+  ];
+  const hasMirrorsAndLinks = mirrors.length > 0 && downloads.length > 0;
+  const formattedLinks: string[] = [];
+
+  const appendAll = (links: AvailableMirror[]) =>
+    links.forEach((link, idx) => {
+      const prefix =
+        link.linkType === null || link.linkType === LinkType.Mirror
+          ? "Mirror"
+          : "Download";
+      const [mirrorUrl, botUsername] = [link.mirrorUrl, link.bot.username];
+
+      formattedLinks.push(
+        `* [${prefix} #${
+          idx + 1
+        }](${mirrorUrl}) (provided by /u/${botUsername})`
+      );
+    });
 
-    let mirrorUrl = mirror.mirrorUrl;
-    let botUsername = mirror.bot.username;
+  if (mirrors.length > 0) {
+    formattedLinks.push(`**Mirrors**`, `\n`);
+    appendAll(mirrors);
+  }
 
-    formattedMirrors.push(
-      `* [Mirror #${i + 1}](${mirrorUrl}) (provided by /u/${botUsername})`
-    );
+  if (downloads.length > 0) {
+    if (hasMirrorsAndLinks) formattedLinks.push("\n");
+    formattedLinks.push(`**Downloads**`, `\n`);
+    appendAll(downloads);
   }
 
-  return TEMPLATE_COMMENTREPLY.replace("%s", formattedMirrors.join("\n"));
+  return TEMPLATE_COMMENTREPLY.replace("%s", formattedLinks.join("\n"));
 }
 
 /**

src/entity/availablemirror.ts

@@ -11,7 +11,7 @@ import {
   PrimaryGeneratedColumn,
   UpdateDateColumn,
 } from "typeorm";
-import { CommentReplyStatus } from "../structures";
+import { CommentReplyStatus, LinkType } from "../structures";
 import { CommentReply } from "./commentreply";
 import { RegisteredBot } from "./registeredbot";
 
@@ -35,6 +35,11 @@ export class AvailableMirror extends BaseEntity {
   })
   bot: RegisteredBot;
 
+  @Column({
+    default: LinkType.Mirror,
+  })
+  linkType: LinkType;
+
   @CreateDateColumn()
   createdAt: Date;
 

src/structures/api.ts

@@ -1,4 +1,5 @@
 import { RegisteredBot } from "../entity";
+import { LinkType } from "./availablemirror";
 
 /** Data structure for API responses */
 export interface ResponseData {
@@ -21,6 +22,9 @@ export interface CreateMirrorRequest {
 
   /** The bot hosting the mirror */
   bot: RegisteredBot;
+
+  /** The type of link */
+  linkType: LinkType;
 }
 
 /** Data structure for video API requests */
@@ -30,6 +34,9 @@ export interface ApiRequest {
 
   /** The URL to the mirrored video */
   url: string;
+
+  /** The type of link */
+  linkType?: LinkType;
 }
 
 /** Data structure for delete requests */

src/structures/availablemirror.ts

@@ -0,0 +1,6 @@
+export enum LinkType {
+  /** Indicates this link is for a mirror */
+  Mirror = 0,
+  /** Indicates this link is for a download */
+  Download = 1,
+}

src/structures/index.ts

@@ -1,2 +1,3 @@
 export * from "./api";
+export * from "./availablemirror";
 export * from "./commentreply";