Rebuild database task (#900)

* Improved tests for multi-user mode
* Adds task to rebuild database
* Updated subscriptions.js export syntax
* Subscription metadata is now backed up
* Added typing to task key
* Updated api models
* Tasks actions styling update
pull/925/head
Tzahi12345 3 years ago committed by GitHub
parent 441131e930
commit c207e56855
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -1758,14 +1758,14 @@ components:
type: object type: object
properties: properties:
task_key: task_key:
type: string $ref: '#/components/schemas/TaskType'
required: required:
- task_key - task_key
UpdateTaskScheduleRequest: UpdateTaskScheduleRequest:
type: object type: object
properties: properties:
task_key: task_key:
type: string $ref: '#/components/schemas/TaskType'
new_schedule: new_schedule:
$ref: '#/components/schemas/Schedule' $ref: '#/components/schemas/Schedule'
required: required:
@ -1775,7 +1775,7 @@ components:
type: object type: object
properties: properties:
task_key: task_key:
type: string $ref: '#/components/schemas/TaskType'
new_data: new_data:
type: object type: object
required: required:
@ -1785,7 +1785,7 @@ components:
type: object type: object
properties: properties:
task_key: task_key:
type: string $ref: '#/components/schemas/TaskType'
new_options: new_options:
type: object type: object
required: required:
@ -2726,7 +2726,7 @@ components:
type: object type: object
properties: properties:
key: key:
type: string $ref: '#/components/schemas/TaskType'
title: title:
type: string type: string
last_ran: last_ran:
@ -2745,6 +2745,17 @@ components:
$ref: '#/components/schemas/Schedule' $ref: '#/components/schemas/Schedule'
options: options:
type: object type: object
TaskType:
type: string
enum:
- backup_local_db
- missing_files_check
- missing_db_records
- duplicate_files_check
- youtubedl_update_check
- delete_old_files
- import_legacy_archives
- rebuild_database
Schedule: Schedule:
required: required:
- type - type

@ -535,6 +535,7 @@ async function loadConfig() {
if (allowSubscriptions) { if (allowSubscriptions) {
// set downloading to false // set downloading to false
let subscriptions = await subscriptions_api.getAllSubscriptions(); let subscriptions = await subscriptions_api.getAllSubscriptions();
subscriptions.forEach(async sub => subscriptions_api.writeSubscriptionMetadata(sub));
subscriptions_api.updateSubscriptionPropertyMultiple(subscriptions, {downloading: false}); subscriptions_api.updateSubscriptionPropertyMultiple(subscriptions, {downloading: false});
// runs initially, then runs every ${subscriptionCheckInterval} seconds // runs initially, then runs every ${subscriptionCheckInterval} seconds
const watchSubscriptionsInterval = function() { const watchSubscriptionsInterval = function() {
@ -1928,9 +1929,34 @@ app.post('/api/clearAllLogs', optionalJwt, async function(req, res) {
// user authentication // user authentication
app.post('/api/auth/register' app.post('/api/auth/register', optionalJwt, async (req, res) => {
, optionalJwt const userid = req.body.userid;
, auth_api.registerUser); const username = req.body.username;
const plaintextPassword = req.body.password;
if (userid !== 'admin' && !config_api.getConfigItem('ytdl_allow_registration') && !req.isAuthenticated() && (!req.user || !exports.userHasPermission(req.user.uid, 'settings'))) {
logger.error(`Registration failed for user ${userid}. Registration is disabled.`);
res.sendStatus(409);
return;
}
if (plaintextPassword === "") {
logger.error(`Registration failed for user ${userid}. A password must be provided.`);
res.sendStatus(409);
return;
}
const new_user = await auth_api.registerUser(userid, username, plaintextPassword);
if (!new_user) {
res.sendStatus(409);
return;
}
res.send({
user: new_user
});
});
app.post('/api/auth/login' app.post('/api/auth/login'
, auth_api.passport.authenticate(['local', 'ldapauth'], {}) , auth_api.passport.authenticate(['local', 'ldapauth'], {})
, auth_api.generateJWT , auth_api.generateJWT
@ -1982,18 +2008,7 @@ app.post('/api/updateUser', optionalJwt, async (req, res) => {
app.post('/api/deleteUser', optionalJwt, async (req, res) => { app.post('/api/deleteUser', optionalJwt, async (req, res) => {
let uid = req.body.uid; let uid = req.body.uid;
try { try {
let success = false; const success = await auth_api.deleteUser(uid);
let usersFileFolder = config_api.getConfigItem('ytdl_users_base_path');
const user_folder = path.join(__dirname, usersFileFolder, uid);
const user_db_obj = await db_api.getRecord('users', {uid: uid});
if (user_db_obj) {
// user exists, let's delete
await fs.remove(user_folder);
await db_api.removeRecord('users', {uid: uid});
success = true;
} else {
logger.error(`Could not find user with uid ${uid}`);
}
res.send({success: success}); res.send({success: success});
} catch (err) { } catch (err) {
logger.error(err); logger.error(err);

@ -1,11 +1,13 @@
const config_api = require('../config'); const config_api = require('../config');
const consts = require('../consts'); const CONSTS = require('../consts');
const logger = require('../logger'); const logger = require('../logger');
const db_api = require('../db'); const db_api = require('../db');
const jwt = require('jsonwebtoken'); const jwt = require('jsonwebtoken');
const { uuid } = require('uuidv4'); const { uuid } = require('uuidv4');
const bcrypt = require('bcryptjs'); const bcrypt = require('bcryptjs');
const fs = require('fs-extra');
const path = require('path');
var LocalStrategy = require('passport-local').Strategy; var LocalStrategy = require('passport-local').Strategy;
var LdapStrategy = require('passport-ldapauth'); var LdapStrategy = require('passport-ldapauth');
@ -16,7 +18,7 @@ var JwtStrategy = require('passport-jwt').Strategy,
let SERVER_SECRET = null; let SERVER_SECRET = null;
let JWT_EXPIRATION = null; let JWT_EXPIRATION = null;
let opts = null; let opts = null;
let saltRounds = null; let saltRounds = 10;
exports.initialize = function () { exports.initialize = function () {
/************************* /*************************
@ -31,8 +33,6 @@ exports.initialize = function () {
}); });
} }
saltRounds = 10;
// Sometimes this value is not properly typed: https://github.com/Tzahi12345/YoutubeDL-Material/issues/813 // Sometimes this value is not properly typed: https://github.com/Tzahi12345/YoutubeDL-Material/issues/813
JWT_EXPIRATION = config_api.getConfigItem('ytdl_jwt_expiration'); JWT_EXPIRATION = config_api.getConfigItem('ytdl_jwt_expiration');
if (!(+JWT_EXPIRATION)) { if (!(+JWT_EXPIRATION)) {
@ -68,7 +68,7 @@ exports.initialize = function () {
const setupRoles = async () => { const setupRoles = async () => {
const required_roles = { const required_roles = {
admin: { admin: {
permissions: consts.AVAILABLE_PERMISSIONS permissions: CONSTS.AVAILABLE_PERMISSIONS
}, },
user: { user: {
permissions: [ permissions: [
@ -106,55 +106,41 @@ exports.passport.deserializeUser(function(user, done) {
/*************************************** /***************************************
* Register user with hashed password * Register user with hashed password
**************************************/ **************************************/
exports.registerUser = async function(req, res) {
var userid = req.body.userid;
var username = req.body.username;
var plaintextPassword = req.body.password;
if (userid !== 'admin' && !config_api.getConfigItem('ytdl_allow_registration') && !req.isAuthenticated() && (!req.user || !exports.userHasPermission(req.user.uid, 'settings'))) {
res.sendStatus(409);
logger.error(`Registration failed for user ${userid}. Registration is disabled.`);
return;
}
if (plaintextPassword === "") { exports.registerUser = async (userid, username, plaintextPassword) => {
res.sendStatus(400); const hash = await bcrypt.hash(plaintextPassword, saltRounds);
logger.error(`Registration failed for user ${userid}. A password must be provided.`); const new_user = generateUserObject(userid, username, hash);
return; // check if user exists
if (await db_api.getRecord('users', {uid: userid})) {
// user id is taken!
logger.error('Registration failed: UID is already taken!');
return null;
} else if (await db_api.getRecord('users', {name: username})) {
// user name is taken!
logger.error('Registration failed: User name is already taken!');
return null;
} else {
// add to db
await db_api.insertRecordIntoTable('users', new_user);
logger.verbose(`New user created: ${new_user.name}`);
return new_user;
} }
}
bcrypt.hash(plaintextPassword, saltRounds) exports.deleteUser = async (uid) => {
.then(async function(hash) { let success = false;
let new_user = generateUserObject(userid, username, hash); let usersFileFolder = config_api.getConfigItem('ytdl_users_base_path');
// check if user exists const user_folder = path.join(__dirname, usersFileFolder, uid);
if (await db_api.getRecord('users', {uid: userid})) { const user_db_obj = await db_api.getRecord('users', {uid: uid});
// user id is taken! if (user_db_obj) {
logger.error('Registration failed: UID is already taken!'); // user exists, let's delete
res.status(409).send('UID is already taken!'); await fs.remove(user_folder);
} else if (await db_api.getRecord('users', {name: username})) { await db_api.removeRecord('users', {uid: uid});
// user name is taken! success = true;
logger.error('Registration failed: User name is already taken!'); } else {
res.status(409).send('User name is already taken!'); logger.error(`Could not find user with uid ${uid}`);
} else { }
// add to db return success;
await db_api.insertRecordIntoTable('users', new_user);
logger.verbose(`New user created: ${new_user.name}`);
res.send({
user: new_user
});
}
})
.then(function(result) {
})
.catch(function(err) {
logger.error(err);
if( err.code == 'ER_DUP_ENTRY' ) {
res.status(409).send('UserId already taken');
} else {
res.sendStatus(409);
}
});
} }
/*************************************** /***************************************
@ -235,7 +221,7 @@ exports.returnAuthResponse = async function(req, res) {
user: req.user, user: req.user,
token: req.token, token: req.token,
permissions: await exports.userPermissions(req.user.uid), permissions: await exports.userPermissions(req.user.uid),
available_permissions: consts['AVAILABLE_PERMISSIONS'] available_permissions: CONSTS.AVAILABLE_PERMISSIONS
}); });
} }
@ -319,7 +305,7 @@ exports.getUserVideos = async function(user_uid, type) {
} }
exports.getUserVideo = async function(user_uid, file_uid, requireSharing = false) { exports.getUserVideo = async function(user_uid, file_uid, requireSharing = false) {
let file = await db_api.getRecord('files', {file_uid: file_uid}); let file = await db_api.getRecord('files', {uid: file_uid});
// prevent unauthorized users from accessing the file info // prevent unauthorized users from accessing the file info
if (file && !file['sharingEnabled'] && requireSharing) file = null; if (file && !file['sharingEnabled'] && requireSharing) file = null;
@ -406,8 +392,8 @@ exports.userPermissions = async function(user_uid) {
const role_obj = await db_api.getRecord('roles', {key: role}); const role_obj = await db_api.getRecord('roles', {key: role});
const role_permissions = role_obj['permissions']; const role_permissions = role_obj['permissions'];
for (let i = 0; i < consts['AVAILABLE_PERMISSIONS'].length; i++) { for (let i = 0; i < CONSTS.AVAILABLE_PERMISSIONS.length; i++) {
let permission = consts['AVAILABLE_PERMISSIONS'][i]; let permission = CONSTS.AVAILABLE_PERMISSIONS[i];
const user_has_explicit_permission = user_obj['permissions'].includes(permission); const user_has_explicit_permission = user_obj['permissions'].includes(permission);
const permission_in_overrides = user_obj['permission_overrides'].includes(permission); const permission_in_overrides = user_obj['permission_overrides'].includes(permission);

@ -347,6 +347,8 @@ const YTDL_ARGS_WITH_VALUES = [
'--convert-subs' '--convert-subs'
]; ];
exports.SUBSCRIPTION_BACKUP_PATH = 'subscription_backup.json'
// we're using a Set here for performance // we're using a Set here for performance
exports.YTDL_ARGS_WITH_VALUES = new Set(YTDL_ARGS_WITH_VALUES); exports.YTDL_ARGS_WITH_VALUES = new Set(YTDL_ARGS_WITH_VALUES);

@ -6,20 +6,21 @@ const config_api = require('./config');
const archive_api = require('./archive'); const archive_api = require('./archive');
const utils = require('./utils'); const utils = require('./utils');
const logger = require('./logger'); const logger = require('./logger');
const CONSTS = require('./consts');
const debugMode = process.env.YTDL_MODE === 'debug'; const debugMode = process.env.YTDL_MODE === 'debug';
const db_api = require('./db'); const db_api = require('./db');
const downloader_api = require('./downloader'); const downloader_api = require('./downloader');
async function subscribe(sub, user_uid = null) { exports.subscribe = async (sub, user_uid = null, skip_get_info = false) => {
const result_obj = { const result_obj = {
success: false, success: false,
error: '' error: ''
}; };
return new Promise(async resolve => { return new Promise(async resolve => {
// sub should just have url and name. here we will get isPlaylist and path // sub should just have url and name. here we will get isPlaylist and path
sub.isPlaylist = sub.url.includes('playlist'); sub.isPlaylist = sub.isPlaylist || sub.url.includes('playlist');
sub.videos = []; sub.videos = [];
let url_exists = !!(await db_api.getRecord('subscriptions', {url: sub.url, user_uid: user_uid})); let url_exists = !!(await db_api.getRecord('subscriptions', {url: sub.url, user_uid: user_uid}));
@ -34,10 +35,11 @@ async function subscribe(sub, user_uid = null) {
sub['user_uid'] = user_uid ? user_uid : undefined; sub['user_uid'] = user_uid ? user_uid : undefined;
await db_api.insertRecordIntoTable('subscriptions', sub); await db_api.insertRecordIntoTable('subscriptions', sub);
let success = await getSubscriptionInfo(sub); let success = skip_get_info ? true : await getSubscriptionInfo(sub);
exports.writeSubscriptionMetadata(sub);
if (success) { if (success) {
getVideosForSub(sub, user_uid); if (!sub.paused) exports.getVideosForSub(sub, user_uid);
} else { } else {
logger.error('Subscribe: Failed to get subscription info. Subscribe failed.') logger.error('Subscribe: Failed to get subscription info. Subscribe failed.')
} }
@ -109,7 +111,7 @@ async function getSubscriptionInfo(sub) {
}); });
} }
async function unsubscribe(sub, deleteMode, user_uid = null) { exports.unsubscribe = async (sub, deleteMode, user_uid = null) => {
let basePath = null; let basePath = null;
if (user_uid) if (user_uid)
basePath = path.join(config_api.getConfigItem('ytdl_users_base_path'), user_uid, 'subscriptions'); basePath = path.join(config_api.getConfigItem('ytdl_users_base_path'), user_uid, 'subscriptions');
@ -148,7 +150,7 @@ async function unsubscribe(sub, deleteMode, user_uid = null) {
await db_api.removeAllRecords('archives', {sub_id: sub.id}); await db_api.removeAllRecords('archives', {sub_id: sub.id});
} }
async function deleteSubscriptionFile(sub, file, deleteForever, file_uid = null, user_uid = null) { exports.deleteSubscriptionFile = async (sub, file, deleteForever, file_uid = null, user_uid = null) => {
if (typeof sub === 'string') { if (typeof sub === 'string') {
// TODO: fix bad workaround where sub is a sub_id // TODO: fix bad workaround where sub is a sub_id
sub = await db_api.getRecord('subscriptions', {sub_id: sub}); sub = await db_api.getRecord('subscriptions', {sub_id: sub});
@ -216,8 +218,8 @@ async function deleteSubscriptionFile(sub, file, deleteForever, file_uid = null,
} }
} }
async function getVideosForSub(sub, user_uid = null) { exports.getVideosForSub = async (sub, user_uid = null) => {
const latest_sub_obj = await getSubscription(sub.id); const latest_sub_obj = await exports.getSubscription(sub.id);
if (!latest_sub_obj || latest_sub_obj['downloading']) { if (!latest_sub_obj || latest_sub_obj['downloading']) {
return false; return false;
} }
@ -305,7 +307,7 @@ async function handleOutputJSON(output, sub, user_uid) {
} }
const files_to_download = await getFilesToDownload(sub, output_jsons); const files_to_download = await getFilesToDownload(sub, output_jsons);
const base_download_options = generateOptionsForSubscriptionDownload(sub, user_uid); const base_download_options = exports.generateOptionsForSubscriptionDownload(sub, user_uid);
for (let j = 0; j < files_to_download.length; j++) { for (let j = 0; j < files_to_download.length; j++) {
const file_to_download = files_to_download[j]; const file_to_download = files_to_download[j];
@ -316,7 +318,7 @@ async function handleOutputJSON(output, sub, user_uid) {
return files_to_download; return files_to_download;
} }
function generateOptionsForSubscriptionDownload(sub, user_uid) { exports.generateOptionsForSubscriptionDownload = (sub, user_uid) => {
let basePath = null; let basePath = null;
if (user_uid) if (user_uid)
basePath = path.join(config_api.getConfigItem('ytdl_users_base_path'), user_uid, 'subscriptions'); basePath = path.join(config_api.getConfigItem('ytdl_users_base_path'), user_uid, 'subscriptions');
@ -443,35 +445,36 @@ async function getFilesToDownload(sub, output_jsons) {
} }
async function getSubscriptions(user_uid = null) { exports.getSubscriptions = async (user_uid = null) => {
return await db_api.getRecords('subscriptions', {user_uid: user_uid}); return await db_api.getRecords('subscriptions', {user_uid: user_uid});
} }
async function getAllSubscriptions() { exports.getAllSubscriptions = async () => {
const all_subs = await db_api.getRecords('subscriptions'); const all_subs = await db_api.getRecords('subscriptions');
const multiUserMode = config_api.getConfigItem('ytdl_multi_user_mode'); const multiUserMode = config_api.getConfigItem('ytdl_multi_user_mode');
return all_subs.filter(sub => !!(sub.user_uid) === !!multiUserMode); return all_subs.filter(sub => !!(sub.user_uid) === !!multiUserMode);
} }
async function getSubscription(subID) { exports.getSubscription = async (subID) => {
// stringify and parse because we may override the 'downloading' property // stringify and parse because we may override the 'downloading' property
const sub = JSON.parse(JSON.stringify(await db_api.getRecord('subscriptions', {id: subID}))); const sub = JSON.parse(JSON.stringify(await db_api.getRecord('subscriptions', {id: subID})));
// now with the download_queue, we may need to override 'downloading' // now with the download_queue, we may need to override 'downloading'
const current_downloads = await db_api.getRecords('download_queue', {running: true, sub_id: sub.id}, true); const current_downloads = await db_api.getRecords('download_queue', {running: true, sub_id: subID}, true);
if (!sub['downloading']) sub['downloading'] = current_downloads > 0; if (!sub['downloading']) sub['downloading'] = current_downloads > 0;
return sub; return sub;
} }
async function getSubscriptionByName(subName, user_uid = null) { exports.getSubscriptionByName = async (subName, user_uid = null) => {
return await db_api.getRecord('subscriptions', {name: subName, user_uid: user_uid}); return await db_api.getRecord('subscriptions', {name: subName, user_uid: user_uid});
} }
async function updateSubscription(sub) { exports.updateSubscription = async (sub) => {
await db_api.updateRecord('subscriptions', {id: sub.id}, sub); await db_api.updateRecord('subscriptions', {id: sub.id}, sub);
exports.writeSubscriptionMetadata(sub);
return true; return true;
} }
async function updateSubscriptionPropertyMultiple(subs, assignment_obj) { exports.updateSubscriptionPropertyMultiple = async (subs, assignment_obj) => {
subs.forEach(async sub => { subs.forEach(async sub => {
await updateSubscriptionProperty(sub, assignment_obj); await updateSubscriptionProperty(sub, assignment_obj);
}); });
@ -483,6 +486,14 @@ async function updateSubscriptionProperty(sub, assignment_obj) {
return true; return true;
} }
exports.writeSubscriptionMetadata = (sub) => {
let basePath = sub.user_uid ? path.join(config_api.getConfigItem('ytdl_users_base_path'), sub.user_uid, 'subscriptions')
: config_api.getConfigItem('ytdl_subscriptions_base_path');
const appendedBasePath = getAppendedBasePath(sub, basePath);
const metadata_path = path.join(appendedBasePath, CONSTS.SUBSCRIPTION_BACKUP_PATH);
fs.writeJSONSync(metadata_path, sub);
}
async function setFreshUploads(sub) { async function setFreshUploads(sub) {
const sub_files = await db_api.getRecords('files', {sub_id: sub.id}); const sub_files = await db_api.getRecords('files', {sub_id: sub.id});
if (!sub_files) return; if (!sub_files) return;
@ -537,17 +548,3 @@ async function checkVideoIfBetterExists(file_obj, sub, user_uid) {
function getAppendedBasePath(sub, base_path) { function getAppendedBasePath(sub, base_path) {
return path.join(base_path, (sub.isPlaylist ? 'playlists/' : 'channels/'), sub.name); return path.join(base_path, (sub.isPlaylist ? 'playlists/' : 'channels/'), sub.name);
} }
module.exports = {
getSubscription : getSubscription,
getSubscriptionByName : getSubscriptionByName,
getSubscriptions : getSubscriptions,
getAllSubscriptions : getAllSubscriptions,
updateSubscription : updateSubscription,
subscribe : subscribe,
unsubscribe : unsubscribe,
deleteSubscriptionFile : deleteSubscriptionFile,
getVideosForSub : getVideosForSub,
updateSubscriptionPropertyMultiple : updateSubscriptionPropertyMultiple,
generateOptionsForSubscriptionDownload: generateOptionsForSubscriptionDownload
}

@ -3,10 +3,17 @@ const notifications_api = require('./notifications');
const youtubedl_api = require('./youtube-dl'); const youtubedl_api = require('./youtube-dl');
const archive_api = require('./archive'); const archive_api = require('./archive');
const files_api = require('./files'); const files_api = require('./files');
const subscriptions_api = require('./subscriptions');
const config_api = require('./config');
const auth_api = require('./authentication/auth');
const utils = require('./utils');
const logger = require('./logger');
const CONSTS = require('./consts');
const fs = require('fs-extra'); const fs = require('fs-extra');
const logger = require('./logger'); const path = require('path');
const scheduler = require('node-schedule'); const scheduler = require('node-schedule');
const { uuid } = require('uuidv4');
const TASKS = { const TASKS = {
backup_local_db: { backup_local_db: {
@ -47,6 +54,11 @@ const TASKS = {
run: archive_api.importArchives, run: archive_api.importArchives,
title: 'Import legacy archives', title: 'Import legacy archives',
job: null job: null
},
rebuild_database: {
run: rebuildDB,
title: 'Rebuild database',
job: null
} }
} }
@ -265,4 +277,68 @@ async function autoDeleteFiles(data) {
} }
} }
async function rebuildDB() {
await db_api.backupDB();
let subs_to_add = await guessSubscriptions(false);
subs_to_add = subs_to_add.concat(await guessSubscriptions(true));
const users_to_add = await guessUsers();
for (const user_to_add of users_to_add) {
const usersFileFolder = config_api.getConfigItem('ytdl_users_base_path');
const user_exists = await db_api.getRecord('users', {uid: user_to_add});
if (!user_exists) {
await auth_api.registerUser(user_to_add, user_to_add, 'password');
logger.info(`Regenerated user ${user_to_add}`);
}
const user_channel_subs = await guessSubscriptions(false, path.join(usersFileFolder, user_to_add), user_to_add);
const user_playlist_subs = await guessSubscriptions(true, path.join(usersFileFolder, user_to_add), user_to_add);
subs_to_add = subs_to_add.concat(user_channel_subs, user_playlist_subs);
}
for (const sub_to_add of subs_to_add) {
const sub_exists = !!(await subscriptions_api.getSubscriptionByName(sub_to_add['name'], sub_to_add['user_uid']));
// TODO: we shouldn't be creating this here
const new_sub = Object.assign({}, sub_to_add, {paused: true});
if (!sub_exists) {
await subscriptions_api.subscribe(new_sub, sub_to_add['user_uid'], true);
logger.info(`Regenerated subscription ${sub_to_add['name']}`);
}
}
logger.info(`Importing unregistered files`);
await files_api.importUnregisteredFiles();
}
const guessUsers = async () => {
const usersFileFolder = config_api.getConfigItem('ytdl_users_base_path');
const userPaths = await utils.getDirectoriesInDirectory(usersFileFolder);
return userPaths.map(userPath => path.basename(userPath));
}
const guessSubscriptions = async (isPlaylist, basePath = null) => {
const guessed_subs = [];
const subscriptionsFileFolder = config_api.getConfigItem('ytdl_subscriptions_base_path');
const subsSubPath = basePath ? path.join(basePath, 'subscriptions') : subscriptionsFileFolder;
const subsPath = path.join(subsSubPath, isPlaylist ? 'playlists' : 'channels');
const subs = await utils.getDirectoriesInDirectory(subsPath);
for (const subPath of subs) {
const sub_backup_path = path.join(subPath, CONSTS.SUBSCRIPTION_BACKUP_PATH);
if (!fs.existsSync(sub_backup_path)) continue;
try {
const sub_backup = fs.readJSONSync(sub_backup_path)
delete sub_backup['_id'];
guessed_subs.push(sub_backup);
} catch(err) {
logger.warn(`Failed to reimport subscription in path ${subPath}`)
logger.warn(err);
}
}
return guessed_subs;
}
exports.TASKS = TASKS; exports.TASKS = TASKS;

@ -337,16 +337,22 @@ describe('Database', async function() {
}); });
describe('Multi User', async function() { describe('Multi User', async function() {
let user = null; const user_to_test = 'test_user';
const user_to_test = 'admin'; const user_password = 'test_pass';
const sub_to_test = 'dc834388-3454-41bf-a618-e11cb8c7de1c'; const sub_to_test = '';
const playlist_to_test = 'ysabVZz4x'; const playlist_to_test = '';
beforeEach(async function() { beforeEach(async function() {
await db_api.connectToDB(); await db_api.connectToDB();
user = await auth_api.login('admin', 'pass'); await auth_api.deleteUser(user_to_test);
}); });
describe('Authentication', function() { describe('Basic', function() {
it('login', async function() { it('Register', async function() {
const user = await auth_api.registerUser(user_to_test, user_to_test, user_password);
assert(user);
});
it('Login', async function() {
await auth_api.registerUser(user_to_test, user_to_test, user_password);
const user = await auth_api.login(user_to_test, user_password);
assert(user); assert(user);
}); });
}); });
@ -362,14 +368,14 @@ describe('Multi User', async function() {
}); });
it('Video access - disallowed', async function() { it('Video access - disallowed', async function() {
await db_api.setVideoProperty(video_to_test, {sharingEnabled: false}, user_to_test); await db_api.setVideoProperty(video_to_test, {sharingEnabled: false});
const video_obj = auth_api.getUserVideo('admin', video_to_test, true); const video_obj = auth_api.getUserVideo(user_to_test, video_to_test, true);
assert(!video_obj); assert(!video_obj);
}); });
it('Video access - allowed', async function() { it('Video access - allowed', async function() {
await db_api.setVideoProperty(video_to_test, {sharingEnabled: true}, user_to_test); await db_api.setVideoProperty(video_to_test, {sharingEnabled: true}, user_to_test);
const video_obj = auth_api.getUserVideo('admin', video_to_test, true); const video_obj = auth_api.getUserVideo(user_to_test, video_to_test, true);
assert(video_obj); assert(video_obj);
}); });
}); });

@ -519,6 +519,17 @@ exports.convertFlatObjectToNestedObject = (obj) => {
return result; return result;
} }
exports.getDirectoriesInDirectory = async (basePath) => {
try {
const files = await fs.readdir(basePath, { withFileTypes: true });
return files
.filter((file) => file.isDirectory())
.map((file) => path.join(basePath, file.name));
} catch (err) {
return [];
}
}
// objects // objects
function File(id, title, thumbnailURL, isAudio, duration, url, uploader, size, path, upload_date, description, view_count, height, abr) { function File(id, title, thumbnailURL, isAudio, duration, url, uploader, size, path, upload_date, description, view_count, height, abr) {

@ -104,6 +104,7 @@ export type { SubscriptionRequestData } from './models/SubscriptionRequestData';
export type { SuccessObject } from './models/SuccessObject'; export type { SuccessObject } from './models/SuccessObject';
export type { TableInfo } from './models/TableInfo'; export type { TableInfo } from './models/TableInfo';
export type { Task } from './models/Task'; export type { Task } from './models/Task';
export { TaskType } from './models/TaskType';
export type { TestConnectionStringRequest } from './models/TestConnectionStringRequest'; export type { TestConnectionStringRequest } from './models/TestConnectionStringRequest';
export type { TestConnectionStringResponse } from './models/TestConnectionStringResponse'; export type { TestConnectionStringResponse } from './models/TestConnectionStringResponse';
export type { TransferDBRequest } from './models/TransferDBRequest'; export type { TransferDBRequest } from './models/TransferDBRequest';

@ -3,5 +3,5 @@
/* eslint-disable */ /* eslint-disable */
export type Config = { export type Config = {
YoutubeDLMaterial: Record<string, any>; YoutubeDLMaterial: any;
}; };

@ -26,5 +26,5 @@ export type Download = {
user_uid?: string; user_uid?: string;
sub_id?: string; sub_id?: string;
sub_name?: string; sub_name?: string;
prefetched_info?: Record<string, any>; prefetched_info?: any;
}; };

@ -5,6 +5,6 @@
export type GetFileFormatsResponse = { export type GetFileFormatsResponse = {
success: boolean; success: boolean;
result: { result: {
formats?: Array<Record<string, any>>; formats?: Array<any>;
}; };
}; };

@ -6,5 +6,5 @@ import type { Subscription } from './Subscription';
export type GetSubscriptionResponse = { export type GetSubscriptionResponse = {
subscription: Subscription; subscription: Subscription;
files: Array<Record<string, any>>; files: Array<any>;
}; };

@ -2,6 +2,8 @@
/* tslint:disable */ /* tslint:disable */
/* eslint-disable */ /* eslint-disable */
import type { TaskType } from './TaskType';
export type GetTaskRequest = { export type GetTaskRequest = {
task_key: string; task_key: TaskType;
}; };

@ -11,6 +11,6 @@ export type Notification = {
user_uid?: string; user_uid?: string;
action?: Array<NotificationAction>; action?: Array<NotificationAction>;
read: boolean; read: boolean;
data?: Record<string, any>; data?: any;
timestamp: number; timestamp: number;
}; };

@ -15,5 +15,5 @@ export type Subscription = {
timerange?: string; timerange?: string;
custom_args?: string; custom_args?: string;
custom_output?: string; custom_output?: string;
videos: Array<Record<string, any>>; videos: Array<any>;
}; };

@ -3,16 +3,17 @@
/* eslint-disable */ /* eslint-disable */
import type { Schedule } from './Schedule'; import type { Schedule } from './Schedule';
import type { TaskType } from './TaskType';
export type Task = { export type Task = {
key: string; key: TaskType;
title?: string; title?: string;
last_ran: number; last_ran: number;
last_confirmed: number; last_confirmed: number;
running: boolean; running: boolean;
confirming: boolean; confirming: boolean;
data: Record<string, any>; data: any;
error: string; error: string;
schedule: Schedule; schedule: Schedule;
options?: Record<string, any>; options?: any;
}; };

@ -0,0 +1,14 @@
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
export enum TaskType {
BACKUP_LOCAL_DB = 'backup_local_db',
MISSING_FILES_CHECK = 'missing_files_check',
MISSING_DB_RECORDS = 'missing_db_records',
DUPLICATE_FILES_CHECK = 'duplicate_files_check',
YOUTUBEDL_UPDATE_CHECK = 'youtubedl_update_check',
DELETE_OLD_FILES = 'delete_old_files',
IMPORT_LEGACY_ARCHIVES = 'import_legacy_archives',
REBUILD_DATABASE = 'rebuild_database',
}

@ -10,5 +10,5 @@ export type UpdateFileRequest = {
/** /**
* Object with fields to update as keys and their new values * Object with fields to update as keys and their new values
*/ */
change_obj: Record<string, any>; change_obj: any;
}; };

@ -2,7 +2,9 @@
/* tslint:disable */ /* tslint:disable */
/* eslint-disable */ /* eslint-disable */
import type { TaskType } from './TaskType';
export type UpdateTaskDataRequest = { export type UpdateTaskDataRequest = {
task_key: string; task_key: TaskType;
new_data: Record<string, any>; new_data: any;
}; };

@ -2,7 +2,9 @@
/* tslint:disable */ /* tslint:disable */
/* eslint-disable */ /* eslint-disable */
import type { TaskType } from './TaskType';
export type UpdateTaskOptionsRequest = { export type UpdateTaskOptionsRequest = {
task_key: string; task_key: TaskType;
new_options: Record<string, any>; new_options: any;
}; };

@ -3,8 +3,9 @@
/* eslint-disable */ /* eslint-disable */
import type { Schedule } from './Schedule'; import type { Schedule } from './Schedule';
import type { TaskType } from './TaskType';
export type UpdateTaskScheduleRequest = { export type UpdateTaskScheduleRequest = {
task_key: string; task_key: TaskType;
new_schedule: Schedule; new_schedule: Schedule;
}; };

@ -1,6 +1,6 @@
import { Component, Inject } from '@angular/core'; import { Component, Inject } from '@angular/core';
import { MAT_DIALOG_DATA } from '@angular/material/dialog'; import { MAT_DIALOG_DATA } from '@angular/material/dialog';
import { Task } from 'api-types'; import { Task, TaskType } from 'api-types';
import { PostsService } from 'app/posts.services'; import { PostsService } from 'app/posts.services';
@Component({ @Component({
@ -9,7 +9,7 @@ import { PostsService } from 'app/posts.services';
styleUrls: ['./task-settings.component.scss'] styleUrls: ['./task-settings.component.scss']
}) })
export class TaskSettingsComponent { export class TaskSettingsComponent {
task_key: string; task_key: TaskType;
new_options = {}; new_options = {};
task: Task = null; task: Task = null;

@ -49,7 +49,7 @@
<mat-header-cell *matHeaderCellDef> <ng-container i18n="Actions">Actions</ng-container> </mat-header-cell> <mat-header-cell *matHeaderCellDef> <ng-container i18n="Actions">Actions</ng-container> </mat-header-cell>
<mat-cell *matCellDef="let element"> <mat-cell *matCellDef="let element">
<div class="container"> <div class="container">
<div class="row justify-content-center"> <div class="row justify-content-start">
<div *ngIf="element.data?.uids?.length > 0 || (!element.data?.uids && element.data)" class="col-12 mt-2" style="display: flex; justify-content: center;"> <div *ngIf="element.data?.uids?.length > 0 || (!element.data?.uids && element.data)" class="col-12 mt-2" style="display: flex; justify-content: center;">
<ng-container> <ng-container>
<button (click)="confirmTask(element.key)" [disabled]="element.running || element.confirming" mat-stroked-button> <button (click)="confirmTask(element.key)" [disabled]="element.running || element.confirming" mat-stroked-button>

@ -7,7 +7,7 @@ import { ConfirmDialogComponent } from 'app/dialogs/confirm-dialog/confirm-dialo
import { RestoreDbDialogComponent } from 'app/dialogs/restore-db-dialog/restore-db-dialog.component'; import { RestoreDbDialogComponent } from 'app/dialogs/restore-db-dialog/restore-db-dialog.component';
import { UpdateTaskScheduleDialogComponent } from 'app/dialogs/update-task-schedule-dialog/update-task-schedule-dialog.component'; import { UpdateTaskScheduleDialogComponent } from 'app/dialogs/update-task-schedule-dialog/update-task-schedule-dialog.component';
import { PostsService } from 'app/posts.services'; import { PostsService } from 'app/posts.services';
import { Task } from 'api-types'; import { Task, TaskType } from 'api-types';
import { TaskSettingsComponent } from '../task-settings/task-settings.component'; import { TaskSettingsComponent } from '../task-settings/task-settings.component';
import { Clipboard } from '@angular/cdk/clipboard'; import { Clipboard } from '@angular/cdk/clipboard';
@ -28,6 +28,15 @@ export class TasksComponent implements OnInit {
db_backups = []; db_backups = [];
TASKS_TO_REQUIRE_DIALOG: { [key in TaskType]? : {dialogTitle: string, dialogText: string, submitText: string, warnSubmitColor: boolean}} = {
[TaskType.REBUILD_DATABASE]: {
dialogTitle: $localize`Rebuild database`,
dialogText: $localize`Are you sure you want to rebuild the database? All missing users, subscriptions, and files will be reimported. Note that if missing users are detected, they will be created with the password: 'password'. A backup of your current database will be created.`,
submitText: $localize`Rebuild database`,
warnSubmitColor: false
}
}
@ViewChild(MatPaginator) paginator: MatPaginator; @ViewChild(MatPaginator) paginator: MatPaginator;
@ViewChild(MatSort) sort: MatSort; @ViewChild(MatSort) sort: MatSort;
@ -79,7 +88,29 @@ export class TasksComponent implements OnInit {
}); });
} }
runTask(task_key: string): void { runTask(task_key: TaskType): void {
const taskToRequireDialog = this.TASKS_TO_REQUIRE_DIALOG[task_key];
if (taskToRequireDialog) {
const dialogRef = this.dialog.open(ConfirmDialogComponent, {
data: {
dialogTitle: taskToRequireDialog['dialogTitle'],
dialogText: taskToRequireDialog['dialogText'],
submitText: taskToRequireDialog['submitText'],
warnSubmitColor: taskToRequireDialog['warnSubmitColor']
}
});
dialogRef.afterClosed().subscribe(confirmed => {
if (confirmed) {
this._runTask(task_key);
}
});
return;
}
this._runTask(task_key);
}
_runTask(task_key: TaskType): void {
this.postsService.runTask(task_key).subscribe(res => { this.postsService.runTask(task_key).subscribe(res => {
this.getTasks(); this.getTasks();
this.getDBBackups(); this.getDBBackups();
@ -91,7 +122,7 @@ export class TasksComponent implements OnInit {
}); });
} }
confirmTask(task_key: string): void { confirmTask(task_key: TaskType): void {
this.postsService.confirmTask(task_key).subscribe(res => { this.postsService.confirmTask(task_key).subscribe(res => {
this.getTasks(); this.getTasks();
if (res['success']) this.postsService.openSnackBar($localize`Successfully confirmed task!`); if (res['success']) this.postsService.openSnackBar($localize`Successfully confirmed task!`);

@ -112,7 +112,8 @@ import {
ImportArchiveRequest, ImportArchiveRequest,
Archive, Archive,
Subscription, Subscription,
RestartDownloadResponse RestartDownloadResponse,
TaskType
} from '../api-types'; } from '../api-types';
import { isoLangs } from './settings/locales_list'; import { isoLangs } from './settings/locales_list';
import { Title } from '@angular/platform-browser'; import { Title } from '@angular/platform-browser';
@ -640,32 +641,32 @@ export class PostsService implements CanActivate {
return this.http.post<SuccessObject>(this.path + 'resetTasks', {}, this.httpOptions); return this.http.post<SuccessObject>(this.path + 'resetTasks', {}, this.httpOptions);
} }
getTask(task_key: string) { getTask(task_key: TaskType) {
const body: GetTaskRequest = {task_key: task_key}; const body: GetTaskRequest = {task_key: task_key};
return this.http.post<GetTaskResponse>(this.path + 'getTask', body, this.httpOptions); return this.http.post<GetTaskResponse>(this.path + 'getTask', body, this.httpOptions);
} }
runTask(task_key: string) { runTask(task_key: TaskType) {
const body: GetTaskRequest = {task_key: task_key}; const body: GetTaskRequest = {task_key: task_key};
return this.http.post<SuccessObject>(this.path + 'runTask', body, this.httpOptions); return this.http.post<SuccessObject>(this.path + 'runTask', body, this.httpOptions);
} }
confirmTask(task_key: string) { confirmTask(task_key: TaskType) {
const body: GetTaskRequest = {task_key: task_key}; const body: GetTaskRequest = {task_key: task_key};
return this.http.post<SuccessObject>(this.path + 'confirmTask', body, this.httpOptions); return this.http.post<SuccessObject>(this.path + 'confirmTask', body, this.httpOptions);
} }
updateTaskSchedule(task_key: string, schedule: Schedule) { updateTaskSchedule(task_key: TaskType, schedule: Schedule) {
const body: UpdateTaskScheduleRequest = {task_key: task_key, new_schedule: schedule}; const body: UpdateTaskScheduleRequest = {task_key: task_key, new_schedule: schedule};
return this.http.post<SuccessObject>(this.path + 'updateTaskSchedule', body, this.httpOptions); return this.http.post<SuccessObject>(this.path + 'updateTaskSchedule', body, this.httpOptions);
} }
updateTaskData(task_key: string, data: any) { updateTaskData(task_key: TaskType, data: any) {
const body: UpdateTaskDataRequest = {task_key: task_key, new_data: data}; const body: UpdateTaskDataRequest = {task_key: task_key, new_data: data};
return this.http.post<SuccessObject>(this.path + 'updateTaskData', body, this.httpOptions); return this.http.post<SuccessObject>(this.path + 'updateTaskData', body, this.httpOptions);
} }
updateTaskOptions(task_key: string, options: any) { updateTaskOptions(task_key: TaskType, options: any) {
const body: UpdateTaskOptionsRequest = {task_key: task_key, new_options: options}; const body: UpdateTaskOptionsRequest = {task_key: task_key, new_options: options};
return this.http.post<SuccessObject>(this.path + 'updateTaskOptions', body, this.httpOptions); return this.http.post<SuccessObject>(this.path + 'updateTaskOptions', body, this.httpOptions);
} }

Loading…
Cancel
Save