Merge pull request #924 from solid/improvement/invalidusername-command

Improvement/invalidusername command

Author: kjetilk

bin/lib/common.js

@@ -1,17 +1,15 @@
 const fs = require('fs')
 const extend = require('extend')
 const { cyan, bold } = require('colorette')
-const util = require('util')
 
-module.exports = {}
 module.exports.loadConfig = loadConfig
 
-async function loadConfig (program, options) {
+function loadConfig (program, options) {
   let argv = extend({}, options, { version: program.version() })
   let configFile = argv['configFile'] || './config.json'
 
   try {
-    const file = await util.promisify(fs.readFile)(configFile)
+    const file = fs.readFileSync(configFile)
 
     // Use flags with priority over config file
     const config = JSON.parse(file)

bin/lib/invalidUsernames.js

@@ -2,7 +2,6 @@ const fs = require('fs-extra')
 const Handlebars = require('handlebars')
 const path = require('path')
 const { URL } = require('url')
-const util = require('util')
 
 const { loadConfig } = require('./common')
 const { isValidUsername } = require('../../lib/common/user-utils')
@@ -15,22 +14,19 @@ const EmailService = require('../../lib/services/email-service')
 const LDP = require('../../lib/ldp')
 const SolidHost = require('../../lib/models/solid-host')
 
-const fileExists = util.promisify(fs.exists)
-const fileRename = util.promisify(fs.rename)
-
 module.exports = function (program) {
   program
     .command('invalidusernames')
     .option('--notify', 'Will notify users with usernames that are invalid')
     .option('--delete', 'Will delete users with usernames that are invalid')
     .description('Manage usernames that are invalid')
     .action(async (options) => {
-      const config = await loadConfig(program, options)
+      const config = loadConfig(program, options)
       if (!config.multiuser) {
         return console.error('You are running a single user server, no need to check for invalid usernames')
       }
 
-      const invalidUsernames = await getInvalidUsernames(config)
+      const invalidUsernames = getInvalidUsernames(config)
       const host = SolidHost.from({ port: config.port, serverUri: config.serverUri })
       const accountManager = getAccountManager(config, host)
 
@@ -42,28 +38,41 @@ module.exports = function (program) {
         return deleteUsers(invalidUsernames, accountManager, config, host)
       }
 
-      listUsernames(listUsernames)
+      listUsernames(invalidUsernames)
     })
 }
 
-async function createNewIndexFile (username, accountManager, invalidUsernameTemplate, dateOfRemoval, supportEmail, fileOptions) {
+function backupIndexFile (username, accountManager, invalidUsernameTemplate, dateOfRemoval, supportEmail) {
   const userDirectory = accountManager.accountDirFor(username)
   const currentIndex = path.join(userDirectory, 'index.html')
-  const currentIndexExists = await fileExists(currentIndex)
+  const currentIndexExists = fs.existsSync(currentIndex)
   const backupIndex = path.join(userDirectory, 'index.backup.html')
-  const backupIndexExists = await fileExists(backupIndex)
+  const backupIndexExists = fs.existsSync(backupIndex)
   if (currentIndexExists && !backupIndexExists) {
-    await fileRename(currentIndex, backupIndex)
-    const newIndexSource = invalidUsernameTemplate({
-      username,
-      dateOfRemoval,
-      supportEmail
-    })
-    fs.writeFileSync(currentIndex, newIndexSource, fileOptions)
+    fs.renameSync(currentIndex, backupIndex)
+    createNewIndexAcl(userDirectory)
+    createNewIndex(username, invalidUsernameTemplate, dateOfRemoval, supportEmail, currentIndex)
     console.info(`index.html updated for user ${username}`)
   }
 }
 
+function createNewIndex (username, invalidUsernameTemplate, dateOfRemoval, supportEmail, currentIndex) {
+  const newIndexSource = invalidUsernameTemplate({
+    username,
+    dateOfRemoval,
+    supportEmail
+  })
+  fs.writeFileSync(currentIndex, newIndexSource, 'utf-8')
+}
+
+function createNewIndexAcl (userDirectory) {
+  const currentIndexAcl = path.join(userDirectory, 'index.html.acl')
+  const backupIndexAcl = path.join(userDirectory, 'index.backup.html.acl')
+  const currentIndexSource = fs.readFileSync(currentIndexAcl, 'utf-8')
+  const backupIndexSource = currentIndexSource.replace(/index.html/g, 'index.backup.html')
+  fs.writeFileSync(backupIndexAcl, backupIndexSource, 'utf-8')
+}
+
 async function deleteUsers (usernames, accountManager, config, host) {
   const oidcManager = fromServerConfig({
     ...config,
@@ -96,8 +105,8 @@ function getAccountManager (config, host) {
   })
 }
 
-async function getInvalidUsernames (config) {
-  const files = await util.promisify(fs.readdir)(config.root)
+function getInvalidUsernames (config) {
+  const files = fs.readdirSync(config.root)
   const hostname = new URL(config.serverUri).hostname
   const isUserDirectory = new RegExp(`.${hostname}$`)
   return files
@@ -108,7 +117,7 @@ async function getInvalidUsernames (config) {
 
 function listUsernames (usernames) {
   if (usernames.length === 0) {
-    console.info('No invalid usernames was found')
+    return console.info('No invalid usernames was found')
   }
   console.info(`${usernames.length} invalid usernames were found:${usernames.map(username => `\n- ${username}`)}`)
 }
@@ -118,7 +127,7 @@ async function notifyUsers (usernames, accountManager, config) {
   const dateOfRemoval = (new Date(twoWeeksFromNow)).toLocaleDateString()
   const { supportEmail } = config
 
-  await updateIndexFiles(usernames, accountManager, dateOfRemoval, supportEmail)
+  updateIndexFiles(usernames, accountManager, dateOfRemoval, supportEmail)
   await sendEmails(config, usernames, accountManager, dateOfRemoval, supportEmail)
 }
 
@@ -132,9 +141,9 @@ async function sendEmails (config, usernames, accountManager, dateOfRemoval, sup
       return { username, emailAddress, accountUri }
     }))
     const emailService = new EmailService(templates.email, config.email)
-    const sendingEmails = await users
+    const sendingEmails = users
       .filter(user => !!user.emailAddress)
-      .map(async user => await emailService.sendWithTemplate('invalid-username', {
+      .map(user => emailService.sendWithTemplate('invalid-username', {
         to: user.emailAddress,
         accountUri: user.accountUri,
         dateOfRemoval,
@@ -148,13 +157,9 @@ async function sendEmails (config, usernames, accountManager, dateOfRemoval, sup
   console.info('Please set it up to send users email about their accounts')
 }
 
-async function updateIndexFiles (usernames, accountManager, dateOfRemoval, supportEmail) {
-  const invalidUsernameFilePath = path.join(process.cwd(), 'default-views/account/invalid-username.hbs')
-  const fileOptions = {
-    encoding: 'utf-8'
-  }
-  const source = fs.readFileSync(invalidUsernameFilePath, fileOptions)
+function updateIndexFiles (usernames, accountManager, dateOfRemoval, supportEmail) {
+  const invalidUsernameFilePath = path.join(process.cwd(), 'default-views', 'account', 'invalid-username.hbs')
+  const source = fs.readFileSync(invalidUsernameFilePath, 'utf-8')
   const invalidUsernameTemplate = Handlebars.compile(source)
-  const updatingFiles = usernames.map(username => createNewIndexFile(username, accountManager, invalidUsernameTemplate, dateOfRemoval, supportEmail, fileOptions))
-  return Promise.all(updatingFiles)
+  usernames.forEach(username => backupIndexFile(username, accountManager, invalidUsernameTemplate, dateOfRemoval, supportEmail))
 }

bin/lib/start.js

@@ -35,7 +35,7 @@ module.exports = function (program, server) {
   start.option('-v, --verbose', 'Print the logs to console')
 
   start.action(async (options) => {
-    const config = await loadConfig(program, options)
+    const config = loadConfig(program, options)
     bin(config, server)
   })
 }

default-views/account/invalid-username.hbs

@@ -5,7 +5,6 @@
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>Invalid username</title>
   <link rel="stylesheet" href="/common/css/bootstrap.min.css">
-  <script></script>
 </head>
 <body>
 <div class="container">