|
| 1 | +const fs = require('fs-extra') |
| 2 | +const Handlebars = require('handlebars') |
| 3 | +const path = require('path') |
| 4 | +const { URL } = require('url') |
| 5 | +const util = require('util') |
| 6 | + |
| 7 | +const { loadConfig } = require('./common') |
| 8 | +const { isValidUsername } = require('../../lib/common/user-utils') |
| 9 | +const blacklistService = require('../../lib/services/blacklist-service') |
| 10 | +const { initConfigDir, initTemplateDirs } = require('../../lib/server-config') |
| 11 | +const { fromServerConfig } = require('../../lib/models/oidc-manager') |
| 12 | + |
| 13 | +const AccountManager = require('../../lib/models/account-manager') |
| 14 | +const EmailService = require('../../lib/services/email-service') |
| 15 | +const LDP = require('../../lib/ldp') |
| 16 | +const SolidHost = require('../../lib/models/solid-host') |
| 17 | + |
| 18 | +const fileExists = util.promisify(fs.exists) |
| 19 | +const fileRename = util.promisify(fs.rename) |
| 20 | + |
| 21 | +module.exports = function (program) { |
| 22 | + program |
| 23 | + .command('invalidusernames') |
| 24 | + .option('--notify', 'Will notify users with usernames that are invalid') |
| 25 | + .option('--delete', 'Will delete users with usernames that are invalid') |
| 26 | + .description('Manage usernames that are invalid') |
| 27 | + .action(async (options) => { |
| 28 | + const config = await loadConfig(program, options) |
| 29 | + if (!config.multiuser) { |
| 30 | + return console.error('You are running a single user server, no need to check for invalid usernames') |
| 31 | + } |
| 32 | + |
| 33 | + const invalidUsernames = await getInvalidUsernames(config) |
| 34 | + const host = SolidHost.from({ port: config.port, serverUri: config.serverUri }) |
| 35 | + const accountManager = getAccountManager(config, host) |
| 36 | + |
| 37 | + if (options.notify) { |
| 38 | + return notifyUsers(invalidUsernames, accountManager, config) |
| 39 | + } |
| 40 | + |
| 41 | + if (options.delete) { |
| 42 | + return deleteUsers(invalidUsernames, accountManager, config, host) |
| 43 | + } |
| 44 | + |
| 45 | + listUsernames(listUsernames) |
| 46 | + }) |
| 47 | +} |
| 48 | + |
| 49 | +async function createNewIndexFile (username, accountManager, invalidUsernameTemplate, dateOfRemoval, supportEmail, fileOptions) { |
| 50 | + const userDirectory = accountManager.accountDirFor(username) |
| 51 | + const currentIndex = path.join(userDirectory, 'index.html') |
| 52 | + const currentIndexExists = await fileExists(currentIndex) |
| 53 | + const backupIndex = path.join(userDirectory, 'index.backup.html') |
| 54 | + const backupIndexExists = await fileExists(backupIndex) |
| 55 | + if (currentIndexExists && !backupIndexExists) { |
| 56 | + await fileRename(currentIndex, backupIndex) |
| 57 | + const newIndexSource = invalidUsernameTemplate({ |
| 58 | + username, |
| 59 | + dateOfRemoval, |
| 60 | + supportEmail |
| 61 | + }) |
| 62 | + fs.writeFileSync(currentIndex, newIndexSource, fileOptions) |
| 63 | + console.info(`index.html updated for user ${username}`) |
| 64 | + } |
| 65 | +} |
| 66 | + |
| 67 | +async function deleteUsers (usernames, accountManager, config, host) { |
| 68 | + const oidcManager = fromServerConfig({ |
| 69 | + ...config, |
| 70 | + host |
| 71 | + }) |
| 72 | + const deletingUsers = usernames |
| 73 | + .map(async username => { |
| 74 | + try { |
| 75 | + const user = accountManager.userAccountFrom({ username }) |
| 76 | + await oidcManager.users.deleteUser(user) |
| 77 | + } catch (error) { |
| 78 | + if (error.message !== 'No email given') { |
| 79 | + // 'No email given' is an expected error that we want to ignore |
| 80 | + throw error |
| 81 | + } |
| 82 | + } |
| 83 | + const userDirectory = accountManager.accountDirFor(username) |
| 84 | + await fs.remove(userDirectory) |
| 85 | + }) |
| 86 | + await Promise.all(deletingUsers) |
| 87 | + console.info(`Deleted ${deletingUsers.length} users succeeded`) |
| 88 | +} |
| 89 | + |
| 90 | +function getAccountManager (config, host) { |
| 91 | + const ldp = new LDP(config) |
| 92 | + return AccountManager.from({ |
| 93 | + host, |
| 94 | + store: ldp, |
| 95 | + multiuser: config.multiuser |
| 96 | + }) |
| 97 | +} |
| 98 | + |
| 99 | +async function getInvalidUsernames (config) { |
| 100 | + const files = await util.promisify(fs.readdir)(config.root) |
| 101 | + const hostname = new URL(config.serverUri).hostname |
| 102 | + const isUserDirectory = new RegExp(`.${hostname}$`) |
| 103 | + return files |
| 104 | + .filter(file => isUserDirectory.test(file)) |
| 105 | + .map(userDirectory => userDirectory.substr(0, userDirectory.length - hostname.length - 1)) |
| 106 | + .filter(username => !isValidUsername(username) || !blacklistService.validate(username)) |
| 107 | +} |
| 108 | + |
| 109 | +function listUsernames (usernames) { |
| 110 | + if (usernames.length === 0) { |
| 111 | + console.info('No invalid usernames was found') |
| 112 | + } |
| 113 | + console.info(`${usernames.length} invalid usernames were found:${usernames.map(username => `\n- ${username}`)}`) |
| 114 | +} |
| 115 | + |
| 116 | +async function notifyUsers (usernames, accountManager, config) { |
| 117 | + const twoWeeksFromNow = Date.now() + 14 * 24 * 60 * 60 * 1000 |
| 118 | + const dateOfRemoval = (new Date(twoWeeksFromNow)).toLocaleDateString() |
| 119 | + const { supportEmail } = config |
| 120 | + |
| 121 | + await updateIndexFiles(usernames, accountManager, dateOfRemoval, supportEmail) |
| 122 | + await sendEmails(config, usernames, accountManager, dateOfRemoval, supportEmail) |
| 123 | +} |
| 124 | + |
| 125 | +async function sendEmails (config, usernames, accountManager, dateOfRemoval, supportEmail) { |
| 126 | + if (config.email && config.email.host) { |
| 127 | + const configPath = initConfigDir(config) |
| 128 | + const templates = initTemplateDirs(configPath) |
| 129 | + const users = await Promise.all(await usernames.map(async username => { |
| 130 | + const emailAddress = await accountManager.loadAccountRecoveryEmail({ username }) |
| 131 | + const accountUri = accountManager.accountUriFor(username) |
| 132 | + return { username, emailAddress, accountUri } |
| 133 | + })) |
| 134 | + const emailService = new EmailService(templates.email, config.email) |
| 135 | + const sendingEmails = await users |
| 136 | + .filter(user => !!user.emailAddress) |
| 137 | + .map(async user => await emailService.sendWithTemplate('invalid-username', { |
| 138 | + to: user.emailAddress, |
| 139 | + accountUri: user.accountUri, |
| 140 | + dateOfRemoval, |
| 141 | + supportEmail |
| 142 | + })) |
| 143 | + const emailsSent = await Promise.all(sendingEmails) |
| 144 | + console.info(`${emailsSent.length} emails sent to users with invalid usernames`) |
| 145 | + return |
| 146 | + } |
| 147 | + console.info('You have not configured an email service.') |
| 148 | + console.info('Please set it up to send users email about their accounts') |
| 149 | +} |
| 150 | + |
| 151 | +async function updateIndexFiles (usernames, accountManager, dateOfRemoval, supportEmail) { |
| 152 | + const invalidUsernameFilePath = path.join(process.cwd(), 'default-views/account/invalid-username.hbs') |
| 153 | + const fileOptions = { |
| 154 | + encoding: 'utf-8' |
| 155 | + } |
| 156 | + const source = fs.readFileSync(invalidUsernameFilePath, fileOptions) |
| 157 | + const invalidUsernameTemplate = Handlebars.compile(source) |
| 158 | + const updatingFiles = usernames.map(username => createNewIndexFile(username, accountManager, invalidUsernameTemplate, dateOfRemoval, supportEmail, fileOptions)) |
| 159 | + return Promise.all(updatingFiles) |
| 160 | +} |
0 commit comments