Merge pull request #869 from solid/feature/server-info

Feature/server-info

Author: kjetilk

bin/lib/init.js

@@ -31,29 +31,9 @@ module.exports = function (program) {
       // Prompt to the user
       inquirer.prompt(questions)
         .then((answers) => {
-          // setting email
-          if (answers.useEmail) {
-            answers.email = {
-              host: answers['email-host'],
-              port: answers['email-port'],
-              secure: true,
-              auth: {
-                user: answers['email-auth-user'],
-                pass: answers['email-auth-pass']
-              }
-            }
-            delete answers['email-host']
-            delete answers['email-port']
-            delete answers['email-auth-user']
-            delete answers['email-auth-pass']
-          }
-
-          // clean answers
-          Object.keys(answers).forEach((answer) => {
-            if (answer.startsWith('use')) {
-              delete answers[answer]
-            }
-          })
+          manipulateEmailSection(answers)
+          manipulateServerSection(answers)
+          cleanupAnswers(answers)
 
           // write config file
           const config = JSON.stringify(camelize(answers), null, '  ')
@@ -71,3 +51,44 @@ module.exports = function (program) {
         })
     })
 }
+
+function cleanupAnswers (answers) {
+  // clean answers
+  Object.keys(answers).forEach((answer) => {
+    if (answer.startsWith('use')) {
+      delete answers[answer]
+    }
+  })
+}
+
+function manipulateEmailSection (answers) {
+  // setting email
+  if (answers.useEmail) {
+    answers.email = {
+      host: answers['email-host'],
+      port: answers['email-port'],
+      secure: true,
+      auth: {
+        user: answers['email-auth-user'],
+        pass: answers['email-auth-pass']
+      }
+    }
+    delete answers['email-host']
+    delete answers['email-port']
+    delete answers['email-auth-user']
+    delete answers['email-auth-pass']
+  }
+}
+
+function manipulateServerSection (answers) {
+  answers.server = {
+    name: answers['server-name'],
+    description: answers['server-description'],
+    logo: answers['server-logo']
+  }
+  Object.keys(answers).forEach((answer) => {
+    if (answer.startsWith('server-')) {
+      delete answers[answer]
+    }
+  })
+}

bin/lib/options.js

@@ -1,6 +1,7 @@
 const fs = require('fs')
 const path = require('path')
 const validUrl = require('valid-url')
+const { URL } = require('url')
 
 module.exports = [
   // {
@@ -317,6 +318,22 @@ module.exports = [
       }
       return true
     }
+  },
+  {
+    name: 'server-name',
+    help: 'A name for your server (not required, but will be presented on your server\'s frontpage)',
+    prompt: true,
+    default: answers => new URL(answers.serverUri).hostname
+  },
+  {
+    name: 'server-description',
+    help: 'A description of your server (not required)',
+    prompt: true
+  },
+  {
+    name: 'server-logo',
+    help: 'A logo that represents you, your brand, or your server (not required)',
+    prompt: true
   }
 ]
 

common/img/.gitkeep

@@ -9,5 +9,10 @@
   "sslKey": "./privkey.pem",
   "sslCert": "./fullchain.pem",
   "multiuser": true,
-  "corsProxy": "/proxy"
+  "corsProxy": "/proxy",
+  "server": {
+    "name": "",
+    "description": "",
+    "logo": ""
+  }
 }

config.json-default

@@ -31,6 +31,23 @@ <h1>Welcome to the Solid Prototype</h1>
     You are logged in as
     <a href="#" id="profileLink"></a>.
   </p>
+
+  <section>
+    {{#if serverLogo}}
+    <img src="{{serverLogo}}" />
+    {{/if}}
+    <h2>Server info</h2>
+    <dl>
+      <dt>Name</dt>
+      <dd>{{serverName}}</dd>
+      {{#if serverDescription}}
+      <dt>Description</dt>
+      <dd>{{serverDescription}}</dd>
+      {{/if}}
+      <dt>Details</dt>
+      <dd>Running on <a href="https://solid.mit.edu/">Solid {{serverVersion}}</a> (<a href="https://solid.inrupt.com/docs">Documentation</a>)</dd>
+    </dl>
+  </section>
 </div>
 <script src="/common/js/solid-auth-client.bundle.js"></script>
 <script>

default-templates/server/index.html

@@ -0,0 +1,33 @@
+module.exports.copyTemplateDir = copyTemplateDir
+module.exports.processFile = processFile
+
+const fs = require('fs-extra')
+
+async function copyTemplateDir (templatePath, targetPath) {
+  return new Promise((resolve, reject) => {
+    fs.copy(templatePath, targetPath, (error) => {
+      if (error) { return reject(error) }
+
+      resolve()
+    })
+  })
+}
+
+async function processFile (filePath, manipulateSourceFn) {
+  return new Promise((resolve, reject) => {
+    fs.readFile(filePath, 'utf8', (error, rawSource) => {
+      if (error) {
+        return reject(error)
+      }
+
+      const output = manipulateSourceFn(rawSource)
+
+      fs.writeFile(filePath, output, (error) => {
+        if (error) {
+          return reject(error)
+        }
+        resolve()
+      })
+    })
+  })
+}

lib/common/fs-utils.js

@@ -0,0 +1,38 @@
+module.exports.processHandlebarFile = processHandlebarFile
+
+const Handlebars = require('handlebars')
+const debug = require('../debug').errors
+const { processFile } = require('./fs-utils')
+
+/**
+ * Reads a file, processes it (performing template substitution), and saves
+ * back the processed result.
+ *
+ * @param filePath {string}
+ * @param substitutions {Object}
+ *
+ * @return {Promise}
+ */
+async function processHandlebarFile (filePath, substitutions) {
+  return processFile(filePath, (rawSource) => processHandlebarTemplate(rawSource, substitutions))
+}
+
+/**
+ * Performs a Handlebars string template substitution, and returns the
+ * resulting string.
+ *
+ * @see https://www.npmjs.com/package/handlebars
+ *
+ * @param source {string} e.g. 'Hello, {{name}}'
+ *
+ * @return {string} Result, e.g. 'Hello, Alice'
+ */
+function processHandlebarTemplate (source, substitutions) {
+  try {
+    const template = Handlebars.compile(source)
+    return template(substitutions)
+  } catch (error) {
+    debug(`Error processing template: ${error}`)
+    return source
+  }
+}

lib/common/template-utils.js

@@ -1,10 +1,10 @@
 'use strict'
 
-const fs = require('fs-extra')
 const path = require('path')
 const mime = require('mime-types')
 const recursiveRead = require('recursive-readdir')
-const Handlebars = require('handlebars')
+const fsUtils = require('../common/fs-utils')
+const templateUtils = require('../common/template-utils')
 
 const RDF_MIME_TYPES = require('../ldp').RDF_MIME_TYPES
 const TEMPLATE_EXTENSIONS = [ '.acl', '.meta', '.json', '.hbs', '.handlebars' ]
@@ -62,13 +62,7 @@ class AccountTemplate {
    * @return {Promise}
    */
   static copyTemplateDir (templatePath, accountPath) {
-    return new Promise((resolve, reject) => {
-      fs.copy(templatePath, accountPath, (error) => {
-        if (error) { return reject(error) }
-
-        resolve()
-      })
-    })
+    return fsUtils.copyTemplateDir(templatePath, accountPath)
   }
 
   /**
@@ -130,58 +124,7 @@ class AccountTemplate {
    */
   processAccount (accountPath) {
     return this.readTemplateFiles(accountPath)
-      .then(files => {
-        return Promise.all(
-          files.map((path) => { return this.processFile(path) })
-        )
-      })
-  }
-
-  /**
-   * Reads a file, processes it (performing template substitution), and saves
-   * back the processed result.
-   *
-   * @param filePath {string}
-   *
-   * @return {Promise}
-   */
-  processFile (filePath) {
-    return new Promise((resolve, reject) => {
-      fs.readFile(filePath, 'utf8', (error, rawSource) => {
-        if (error) { return reject(error) }
-
-        let output = this.processTemplate(rawSource)
-
-        fs.writeFile(filePath, output, (error) => {
-          if (error) { return reject(error) }
-          resolve()
-        })
-      })
-    })
-  }
-
-  /**
-   * Performs a Handlebars string template substitution, and returns the
-   * resulting string.
-   *
-   * @see https://www.npmjs.com/package/handlebars
-   *
-   * @param source {string} e.g. 'Hello, {{name}}'
-   *
-   * @return {string} Result, e.g. 'Hello, Alice'
-   */
-  processTemplate (source) {
-    let template, result
-
-    try {
-      template = Handlebars.compile(source)
-      result = template(this.substitutions)
-    } catch (error) {
-      console.log('Error processing template: ', error)
-      return source
-    }
-
-    return result
+      .then(files => Promise.all(files.map(path => templateUtils.processHandlebarFile(path, this.substitutions))))
   }
 
   /**

lib/models/account-template.js

@@ -1,10 +1,13 @@
 'use strict'
+
 /**
  * Server config initialization utilities
  */
 
 const fs = require('fs-extra')
 const path = require('path')
+const templateUtils = require('./common/template-utils')
+const fsUtils = require('./common/fs-utils')
 
 /**
  * Ensures that a directory has been copied / initialized. Used to ensure that
@@ -34,28 +37,24 @@ function ensureDirCopyExists (fromDir, toDir) {
  * typically has links to account signup and login, and can be overridden by
  * the server operator.
  *
- * @param argv {Function} Express.js app object
+ * @param argv {Object} Express.js app object
  */
-function ensureWelcomePage (argv) {
-  let { multiuser, templates } = argv
-  let rootDir = path.resolve(argv.root)
-  let serverRootDir
-
-  if (multiuser) {
-    serverRootDir = path.join(rootDir, argv.host.hostname)
-  } else {
-    serverRootDir = rootDir
-  }
-
-  let defaultIndexPage = path.join(templates.server, 'index.html')
-  let existingIndexPage = path.join(serverRootDir, 'index.html')
-  let defaultIndexPageAcl = path.join(templates.server, 'index.html.acl')
-  let existingIndexPageAcl = path.join(serverRootDir, 'index.html.acl')
+async function ensureWelcomePage (argv) {
+  const { multiuser, templates, server, host } = argv
+  const rootDir = path.resolve(argv.root)
+  const serverRootDir = multiuser ? path.join(rootDir, argv.host.hostname) : rootDir
+  const existingIndexPage = path.join(serverRootDir, 'index.html')
+  const packageData = require('../package.json')
 
   if (!fs.existsSync(existingIndexPage)) {
     fs.mkdirp(serverRootDir)
-    fs.copySync(defaultIndexPage, existingIndexPage)
-    fs.copySync(defaultIndexPageAcl, existingIndexPageAcl)
+    await fsUtils.copyTemplateDir(templates.server, serverRootDir)
+    await templateUtils.processHandlebarFile(existingIndexPage, {
+      serverName: server ? server.name : host.hostname,
+      serverDescription: server ? server.description : '',
+      serverLogo: server ? server.logo : '',
+      serverVersion: packageData.version
+    })
   }
 }
 

lib/server-config.js

@@ -14,7 +14,7 @@ module.exports.stripLineEndings = stripLineEndings
 module.exports.fullUrlForReq = fullUrlForReq
 module.exports.routeResolvedFile = routeResolvedFile
 
-const fs = require('fs')
+const fs = require('fs-extra')
 const path = require('path')
 const $rdf = require('rdflib')
 const from = require('from2')
@@ -149,7 +149,7 @@ function parse (data, baseUri, contentType, callback) {
 
 function serialize (graph, baseUri, contentType, callback) {
   try {
-                // target, kb, base, contentType, callback
+    // target, kb, base, contentType, callback
     $rdf.serialize(null, graph, baseUri, contentType, function (err, result) {
       if (err) {
         console.log(err)
@@ -171,9 +171,9 @@ function serialize (graph, baseUri, contentType, callback) {
 function translate (stream, baseUri, from, to, callback) {
   // Handle Turtle Accept header
   if (to === 'text/turtle' ||
-      to === 'text/n3' ||
-      to === 'application/turtle' ||
-      to === 'application/n3') {
+    to === 'text/n3' ||
+    to === 'application/turtle' ||
+    to === 'application/n3') {
     to = 'text/turtle'
   }