Merge pull request #252 from mchangrh/segmentInfo

Implementation of segmentInfo and new userInfo properties

src/routes/getSegmentInfo.ts

@@ -0,0 +1,79 @@
+import { Request, Response } from 'express';
+import { db } from '../databases/databases';
+import { DBSegment, SegmentUUID } from "../types/segments.model";
+
+const isValidSegmentUUID = (str: string): Boolean => /^([a-f0-9]{64}|[a-f0-9]{8}\-[a-f0-9]{4}\-[a-f0-9]{4}\-[a-f0-9]{4}\-[a-f0-9]{12})/.test(str)
+
+async function getSegmentFromDBByUUID(UUID: SegmentUUID): Promise<DBSegment> {
+    try {
+        return await db.prepare('get',
+            `SELECT "videoID", "startTime", "endTime", "votes", "locked",
+                "UUID", "userID", "timeSubmitted", "views", "category",
+                "service", "videoDuration", "hidden", "reputation", "shadowHidden" FROM "sponsorTimes"
+            WHERE "UUID" = ?`, [UUID]);
+    } catch (err) {
+        return null;
+    }
+}
+
+async function getSegmentsByUUID(UUIDs: SegmentUUID[]): Promise<DBSegment[]> {
+    const DBSegments: DBSegment[] = [];
+    for (let UUID of UUIDs) {
+        // if UUID is invalid, skip
+        if (!isValidSegmentUUID(UUID)) {
+            continue;
+        }
+        DBSegments.push(await getSegmentFromDBByUUID(UUID as SegmentUUID));
+    }
+    return DBSegments;
+}
+
+async function handleGetSegmentInfo(req: Request, res: Response) {
+    // If using params instead of JSON, only one UUID can be pulled
+    let UUIDs = req.query.UUIDs
+    ? JSON.parse(req.query.UUIDs as string)
+    : req.query.UUID
+        ? [req.query.UUID]
+        : null;
+    // deduplicate with set
+    UUIDs = [ ...new Set(UUIDs)];
+    // if more than 10 entries, slice
+    if (UUIDs.length > 10) UUIDs = UUIDs.slice(0, 10);
+    if (!Array.isArray(UUIDs) || !UUIDs) {
+        res.status(400).send("UUIDs parameter does not match format requirements.");
+        return false;
+    }
+    const DBSegments = await getSegmentsByUUID(UUIDs);
+    if (DBSegments === null || DBSegments === undefined) {
+        res.sendStatus(400);
+        return false;
+    }
+    if (DBSegments.length === 0) {
+        res.sendStatus(404);
+        return false;
+    }
+    return DBSegments;
+}
+
+async function endpoint(req: Request, res: Response): Promise<void> {
+    try {
+        const DBSegments = await handleGetSegmentInfo(req, res);
+
+        // If false, res.send has already been called
+        if (DBSegments) {
+            //send result
+            res.send(DBSegments);
+        }
+    } catch (err) {
+        if (err instanceof SyntaxError) { // catch JSON.parse error
+            res.status(400).send("UUIDs parameter does not match format requirements.");
+        } else res.status(500).send();
+    }
+}
+
+export {
+    getSegmentFromDBByUUID,
+    getSegmentsByUUID,
+    handleGetSegmentInfo,
+    endpoint
+};

src/routes/getUserInfo.ts

@@ -5,6 +5,7 @@ import {Request, Response} from 'express';
 import {Logger} from '../utils/logger';
 import { HashedUserID, UserID } from '../types/user.model';
 import { getReputation } from '../utils/reputation';
+import { SegmentUUID } from "../types/segments.model";
 
 async function dbGetSubmittedSegmentSummary(userID: HashedUserID): Promise<{ minutesSaved: number, segmentCount: number }> {
     try {
@@ -27,6 +28,15 @@ async function dbGetSubmittedSegmentSummary(userID: HashedUserID): Promise<{ min
     }
 }
 
+async function dbGetIgnoredSegmentCount(userID: HashedUserID): Promise<number> {
+    try {
+        let row = await db.prepare("get", `SELECT COUNT(*) as "ignoredSegmentCount" FROM "sponsorTimes" WHERE "userID" = ? AND ( "votes" <= -2 OR "shadowHidden" = 1 )`, [userID]);
+        return row?.ignoredSegmentCount ?? 0
+    } catch (err) {
+        return null;
+    }
+}
+
 async function dbGetUsername(userID: HashedUserID) {
     try {
         let row = await db.prepare('get', `SELECT "userName" FROM "userNames" WHERE "userID" = ?`, [userID]);
@@ -50,6 +60,15 @@ async function dbGetViewsForUser(userID: HashedUserID) {
     }
 }
 
+async function dbGetIgnoredViewsForUser(userID: HashedUserID) {
+    try {
+        let row = await db.prepare('get', `SELECT SUM("views") as "ignoredViewCount" FROM "sponsorTimes" WHERE "userID" = ? AND ( "votes" <= -2 OR "shadowHidden" = 1 )`, [userID]);
+        return row?.ignoredViewCount ?? 0;
+    } catch (err) {
+        return false;
+    }
+}
+
 async function dbGetWarningsForUser(userID: HashedUserID): Promise<number> {
     try {
         let row = await db.prepare('get', `SELECT COUNT(*) as total FROM "warnings" WHERE "userID" = ? AND "enabled" = 1`, [userID]);
@@ -60,6 +79,15 @@ async function dbGetWarningsForUser(userID: HashedUserID): Promise<number> {
     }
 }
 
+async function dbGetLastSegmentForUser(userID: HashedUserID): Promise<SegmentUUID> {
+    try {
+        let row = await db.prepare('get', `SELECT "UUID" FROM "sponsorTimes" WHERE "userID" = ? ORDER BY "timeSubmitted" DESC LIMIT 1`, [userID]);
+        return row?.UUID ?? null;
+    } catch (err) {
+        return null;
+    }
+}
+
 export async function getUserInfo(req: Request, res: Response) {
     const userID = req.query.userID as UserID;
     const hashedUserID: HashedUserID = userID ? getHash(userID) : req.query.publicUserID as HashedUserID;
@@ -70,7 +98,6 @@ export async function getUserInfo(req: Request, res: Response) {
         return;
     }
 
-
     const segmentsSummary = await dbGetSubmittedSegmentSummary(hashedUserID);
     if (segmentsSummary) {
         res.send({
@@ -78,10 +105,13 @@ export async function getUserInfo(req: Request, res: Response) {
             userName: await dbGetUsername(hashedUserID),
             minutesSaved: segmentsSummary.minutesSaved,
             segmentCount: segmentsSummary.segmentCount,
+            ignoredSegmentCount: await dbGetIgnoredSegmentCount(hashedUserID),
             viewCount: await dbGetViewsForUser(hashedUserID),
+            ignoredViewCount: await dbGetIgnoredViewsForUser(hashedUserID),
             warnings: await dbGetWarningsForUser(hashedUserID),
             reputation: await getReputation(hashedUserID),
             vip: await isUserVIP(hashedUserID),
+            lastSegmentID: await dbGetLastSegmentForUser(hashedUserID),
         });
     } else {
         res.status(400).send();