diff --git a/databases/_upgrade_sponsorTimes_18.sql b/databases/_upgrade_sponsorTimes_18.sql new file mode 100644 index 0000000..f50d454 --- /dev/null +++ b/databases/_upgrade_sponsorTimes_18.sql @@ -0,0 +1,9 @@ +BEGIN TRANSACTION; + +/* Add hash field */ +ALTER TABLE "lockCategories" ADD "hashedVideoID" TEXT NOT NULL default ''; +UPDATE "lockCategories" SET "hashedVideoID" = sha256("videoID"); + +UPDATE "config" SET value = 18 WHERE key = 'version'; + +COMMIT; diff --git a/src/app.ts b/src/app.ts index b409136..b7d5ce6 100644 --- a/src/app.ts +++ b/src/app.ts @@ -33,6 +33,8 @@ import {postClearCache} from './routes/postClearCache'; import { addUnlistedVideo } from './routes/addUnlistedVideo'; import {postPurgeAllSegments} from './routes/postPurgeAllSegments'; import {getUserID} from './routes/getUserID'; +import {getLockCategories} from './routes/getLockCategories'; +import {getLockCategoriesByHash} from './routes/getLockCategoriesByHash'; import ExpressPromiseRouter from 'express-promise-router'; import { Server } from 'http'; @@ -156,6 +158,12 @@ function setupRoutes(router: Router) { // get userID from username router.get('/api/userID', getUserID); + // get lock categores from userID + router.get('/api/lockCategories', getLockCategories); + + // get privacy protecting lock categories functions + router.get('/api/lockCategories/:prefix', getLockCategoriesByHash); + if (config.postgres) { router.get('/database', (req, res) => dumpDatabase(req, res, true)); router.get('/database.json', (req, res) => dumpDatabase(req, res, false)); diff --git a/src/routes/getLockCategories.ts b/src/routes/getLockCategories.ts new file mode 100644 index 0000000..e27acea --- /dev/null +++ b/src/routes/getLockCategories.ts @@ -0,0 +1,27 @@ +import {db} from '../databases/databases'; +import {Logger} from '../utils/logger'; +import {Request, Response} from 'express'; +import { Category, VideoID } from "../types/segments.model"; + +export async function getLockCategories(req: Request, res: Response): Promise { + const videoID = req.query.videoID as VideoID; + + if (videoID == undefined) { + //invalid request + return res.sendStatus(400); + } + + try { + // Get existing lock categories markers + const lockedCategories = await db.prepare('all', 'SELECT "category" from "lockCategories" where "videoID" = ?', [videoID]) as {category: Category}[]; + if (lockedCategories.length === 0 || !lockedCategories[0]) return res.sendStatus(404); + // map to array in JS becaues of SQL incompatibilities + const categories = Object.values(lockedCategories).map((entry) => entry.category); + return res.send({ + categories + }); + } catch (err) { + Logger.error(err); + return res.sendStatus(500); + } +} diff --git a/src/routes/getLockCategoriesByHash.ts b/src/routes/getLockCategoriesByHash.ts new file mode 100644 index 0000000..90772b2 --- /dev/null +++ b/src/routes/getLockCategoriesByHash.ts @@ -0,0 +1,56 @@ +import {db} from '../databases/databases'; +import {Logger} from '../utils/logger'; +import {Request, Response} from 'express'; +import {hashPrefixTester} from '../utils/hashPrefixTester'; +import { Category, VideoID, VideoIDHash } from "../types/segments.model"; + +interface LockResultByHash { + videoID: VideoID, + hash: VideoIDHash, + categories: Category[] +} + +interface DBLock { + videoID: VideoID, + hash: VideoIDHash, + category: Category +} + +const mergeLocks = (source: DBLock[]) => { + const dest: LockResultByHash[] = []; + for (const obj of source) { + // videoID already exists + const destMatch = dest.find(s => s.videoID === obj.videoID); + if (destMatch) { + // push to categories + destMatch.categories.push(obj.category); + } else { + dest.push({ + videoID: obj.videoID, + hash: obj.hash, + categories: [obj.category] + }); + } + } + return dest; +}; + + +export async function getLockCategoriesByHash(req: Request, res: Response): Promise { + let hashPrefix = req.params.prefix as VideoIDHash; + if (!hashPrefixTester(req.params.prefix)) { + return res.status(400).send("Hash prefix does not match format requirements."); // Exit early on faulty prefix + } + hashPrefix = hashPrefix.toLowerCase() as VideoIDHash; + + try { + // Get existing lock categories markers + const lockedRows = await db.prepare('all', 'SELECT "videoID", "hashedVideoID" as "hash", "category" from "lockCategories" where "hashedVideoID" LIKE ?', [hashPrefix + '%']) as DBLock[]; + if (lockedRows.length === 0 || !lockedRows[0]) return res.sendStatus(404); + // merge all locks + return res.send(mergeLocks(lockedRows)); + } catch (err) { + Logger.error(err); + return res.sendStatus(500); + } +} diff --git a/test/cases/getLockCategories.ts b/test/cases/getLockCategories.ts new file mode 100644 index 0000000..177710e --- /dev/null +++ b/test/cases/getLockCategories.ts @@ -0,0 +1,84 @@ +import fetch from 'node-fetch'; +import {Done, getbaseURL} from '../utils'; +import {getHash} from '../../src/utils/getHash'; +import {db} from '../../src/databases/databases'; + + +describe('getLockCategories', () => { + before(async () => { + const insertVipUserQuery = 'INSERT INTO "vipUsers" ("userID") VALUES (?)'; + await db.prepare("run", insertVipUserQuery, [getHash("VIPUser-getLockCategories")]); + + const insertLockCategoryQuery = 'INSERT INTO "lockCategories" ("userID", "videoID", "category") VALUES (?, ?, ?)'; + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-1', 'sponsor']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-1', 'interaction']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-2', 'preview']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLock-3', 'nonmusic']); + }); + + it('Should update the database version when starting the application', async () => { + const version = (await db.prepare('get', 'SELECT key, value FROM config where key = ?', ['version'])).value; + if (version > 1) return; + else return 'Version isn\'t greater than 1. Version is ' + version; + }); + + it('Should be able to get multiple locks', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories?videoID=getLock-1') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.categories.length !== 2) { + done(`Returned incorrect number of locks "${data.categories.length}"`); + } else if (data.categories[0] !== "sponsor") { + done(`Returned incorrect category "${data.categories[0]}"`); + } else if (data.categories[1] !== "interaction") { + done(`Returned incorrect category "${data.categories[1]}"`); + } else { + done(); // pass + } + } + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('Should be able to get single locks', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories?videoID=getLock-2') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.categories.length !== 1) { + done('Returned incorrect number of locks "' + data.categories.length + '"'); + } else if (data.categories[0] !== "preview") { + done(`Returned incorrect category "${data.categories[0].category}"`); + } else { + done(); // pass + } + } + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('should return 404 if no lock exists', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories?videoID=getLock-0') + .then(res => { + if (res.status !== 404) done('non 404 (' + res.status + ')'); + else done(); // pass + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('should return 400 if no videoID specified', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories') + .then(res => { + if (res.status !== 400) done('non 400 (' + res.status + ')'); + else done(); // pass + }) + .catch(() => ("couldn't call endpoint")); + }); +}); diff --git a/test/cases/getLockCategoriesByHash.ts b/test/cases/getLockCategoriesByHash.ts new file mode 100644 index 0000000..585c08e --- /dev/null +++ b/test/cases/getLockCategoriesByHash.ts @@ -0,0 +1,176 @@ +import fetch from 'node-fetch'; +import {Done, getbaseURL} from '../utils'; +import {getHash} from '../../src/utils/getHash'; +import {db} from '../../src/databases/databases'; + + +describe('getLockCategoriesByHash', () => { + before(async () => { + const insertVipUserQuery = 'INSERT INTO "vipUsers" ("userID") VALUES (?)'; + await db.prepare("run", insertVipUserQuery, [getHash("VIPUser-getLockCategories")]); + + const insertLockCategoryQuery = 'INSERT INTO "lockCategories" ("userID", "videoID", "category", "hashedVideoID") VALUES (?, ?, ?, ?)'; + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLockHash-1', 'sponsor', '67a654898fda3a5541774aea345796c7709982bb6018cb08d22a18eeddccc1d0']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLockHash-1', 'interaction', '67a654898fda3a5541774aea345796c7709982bb6018cb08d22a18eeddccc1d0']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLockHash-2', 'preview', 'dff09120437b4bd594dffae5f3cde3cfc5f6099fb01d0ef4051919b2908d9a50']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'getLockHash-3', 'nonmusic', 'bf1b122fd5630e0df8626d00c4a95c58954ad715e5595b0f75a19ac131e28928']); + + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'fakehash-1', 'outro', 'b05a20424f24a53dac1b059fb78d861ba9723645026be2174c93a94f9106bb35']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'fakehash-2', 'intro', 'b05acd1cd6ec7dffe5ffea64ada91ae7469d6db2ce21c7e30ad7fa62075d450']); + await db.prepare("run", insertLockCategoryQuery, [getHash("VIPUser-getLockCategories"), 'fakehash-2', 'preview', 'b05acd1cd6ec7dffe5ffea64ada91ae7469d6db2ce21c7e30ad7fa62075d450']); + }); + + it('Database should be greater or equal to version 18', async () => { + const version = (await db.prepare('get', 'SELECT key, value FROM config where key = ?', ['version'])).value; + if (version >= 18) return; + else return 'Version isn\'t greater than 18. Version is ' + version; + }); + + it('Should be able to get multiple locks in one object', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/67a65') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 1) { + done(`Returned incorrect number of videos "${data.length}"`); + } else if (data[0].videoID !== "getLockHash-1") { + done(`Returned incorrect videoID "${data[0].videoID}"`); + } else if (data[0].hash !== getHash("getLockHash-1", 1)) { + done(`Returned incorrect hash "${data[0].hash}"`); + } else if (data[0].categories[0] !== "sponsor") { + done(`Returned incorrect category "${data[0].categories[0]}"`); + } else if (data[0].categories[1] !== "interaction") { + done(`Returned incorrect category "${data[0].categories[1]}"`); + } else { + done(); // pass + } + } + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('Should be able to get single lock', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/dff09') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 1) { + done('Returned incorrect number of videos "' + data.length + '"'); + } else if (data[0].videoID !== "getLockHash-2") { + done(`Returned incorrect videoID "${data[0].videoID}"`); + } else if (data[0].hash !== getHash("getLockHash-2", 1)) { + done(`Returned incorrect hashedVideoID hash "${data[0].hash}"`); + } else if (data[0].categories.length !== 1) { + done(`Returned incorrect number of categories "${data[0].categories.length}"`); + } else if (data[0].categories[0] !== "preview") { + done(`Returned incorrect category "${data[0].categories[0]}"`); + } else { + done(); // pass + } + } + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('Should be able to get by half full hash', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/bf1b122fd5630e0df8626d00c4a95c58') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 1) { + done('Returned incorrect number of videos "' + data.length + '"'); + } else if (data[0].videoID !== "getLockHash-3") { + done(`Returned incorrect videoID "${data[0].videoID}"`); + } else if (data[0].hash !== getHash("getLockHash-3", 1)) { + done(`Returned incorrect hashedVideoID hash "${data[0].hash}"`); + } else if (data[0].categories.length !== 1) { + done(`Returned incorrect number of categories "${data[0].categories.length}"`); + } else if (data[0].categories[0] !== "nonmusic") { + done(`Returned incorrect category "${data[0].categories[0]}"`); + } else { + done(); // pass + } + } + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('Should be able to get multiple by similar hash with multiple categories', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/b05a') + .then(async res => { + if (res.status !== 200) { + done("non 200"); + } else { + const data = await res.json(); + if (data.length !== 2) { + done(`Returned incorrect number of locks "${data.length}"`); + } else if (data[0].videoID !== "fakehash-1") { + done(`Returned incorrect videoID "${data[0].videoID}"`); + } else if (data[1].videoID !== "fakehash-2") { + done(`Returned incorrect videoID "${data[1].videoID}"`); + } else if (data[0].hash !== "b05a20424f24a53dac1b059fb78d861ba9723645026be2174c93a94f9106bb35") { + done(`Returned incorrect hashedVideoID hash "${data[0].hash}"`); + } else if (data[1].hash !== "b05acd1cd6ec7dffe5ffea64ada91ae7469d6db2ce21c7e30ad7fa62075d450") { + done(`Returned incorrect hashedVideoID hash "${data[1].hash}"`); + } else if (data[0].categories.length !== 1) { + done(`Returned incorrect number of categories "${data[0].categories.length}"`); + } else if (data[1].categories.length !== 2) { + done(`Returned incorrect number of categories "${data[1].categories.length}"`); + } else if (data[0].categories[0] !== "outro") { + done(`Returned incorrect category "${data[0].category}"`); + } else if (data[1].categories[0] !== "intro") { + done(`Returned incorrect category "${data[1].category}"`); + } else if (data[1].categories[1] !== "preview") { + done(`Returned incorrect category "${data[1].category}"`); + } else { + done(); // pass + } + } + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('should return 404 once hash prefix varies', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/aaaaaa') + .then(res => { + if (res.status !== 404) done('non 404 (' + res.status + ')'); + else done(); // pass + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('should return 404 if no lock exists', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/aaaaaa') + .then(res => { + if (res.status !== 404) done('non 404 (' + res.status + ')'); + else done(); // pass + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('should return 400 if no videoID specified', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/') + .then(res => { + if (res.status !== 400) done('non 400 (' + res.status + ')'); + else done(); // pass + }) + .catch(() => ("couldn't call endpoint")); + }); + + it('should return 400 if full hash sent', (done: Done) => { + fetch(getbaseURL() + '/api/lockCategories/b05a20424f24a53dac1b059fb78d861ba9723645026be2174c93a94f9106bb35') + .then(res => { + if (res.status !== 400) done('non 400 (' + res.status + ')'); + else done(); // pass + }) + .catch(() => ("couldn't call endpoint")); + }); +});