gancio/server/cli.js

#!/usr/bin/env node
process.env.NODE_ENV = 'production'

const fs = require('fs')
const consola = require('consola')
const Sequelize = require('sequelize')
const inquirer = require('inquirer')
const pkg = require('../package.json')
const firstrun = require('./firstrun')
const path = require('path')
const mkdirp = require('mkdirp')
const url = require('url')

const cwd = process.cwd()
const data_path = process.env.GANCIO_DATA || path.resolve('./')

// needed by nuxt
process.chdir(path.resolve(__dirname, '..'))

function notEmpty (value) {
  return value.length > 0
}

async function setupQuestionnaire (is_docker, db) {
  const questions = []
  questions.push({
    name: 'title',
    message: 'Name of your instance',
    default: 'Gancio',
    validate: notEmpty
  })

  questions.push({
    message:
      'Specify a baseurl for this gancio installation! (eg. http://gancio.cisti.org)',
    name: 'baseurl',
    default: 'http://localhost:13120',
    validate: value => {
      if (!value) {
        return false
      }
      return /^https?:\/\//.test(value)
    }
  })

  if (!is_docker) {
    questions.push({
      name: 'server.host',
      message: 'address to listen to',
      default: 'localhost',
      validate: notEmpty
    })

    questions.push({
      name: 'server.port',
      message: 'port to listen to',
      default: 13120
    })

    questions.push({
      name: 'db.dialect',
      message: 'DB dialect',
      type: 'list',
      choices: ['sqlite', 'postgres']
    })

    questions.push({
      name: 'db.storage',
      message: 'sqlite db path',
      default: path.resolve(data_path, 'db.sqlite'),
      filter: p => path.resolve(cwd, p),
      when: answers => answers.db.dialect === 'sqlite',
      validate: db_path =>
        db_path.length > 0 && fs.existsSync(path.dirname(db_path))
    })

    questions.push({
      name: 'db.host',
      message: 'Postgres host',
      default: 'localhost',
      when: answers => answers.db.dialect === 'postgres',
      validate: notEmpty
    })

    questions.push({
      name: 'db.database',
      message: 'DB name',
      default: 'gancio',
      when: answers => answers.db.dialect === 'postgres',
      validate: notEmpty
    })

    questions.push({
      name: 'db.username',
      message: 'DB user',
      default: 'gancio',
      when: answers => answers.db.dialect === 'postgres',
      validate: notEmpty
    })

    questions.push({
      name: 'db.password',
      type: 'password',
      message: 'DB password',
      default: 'gancio',
      when: answers => answers.db.dialect === 'postgres',
      validate: (password, options) => {
        try {
          const db = new Sequelize({
            ...options.db,
            dialect: 'postgres',
            password,
            logging: false
          })
          return db.authenticate().then(() => {
            db.close()
            return true
          })
        } catch (e) {
          consola.error(e)
          return false
        }
      }
    })

    questions.push({
      name: 'upload_path',
      message: 'Where gancio has to store media?',
      default: './uploads',
      filter: p => path.resolve(cwd, p),
      validate: p => {
        const exists = fs.existsSync(p)
        if (!exists) {
          consola.warn(`"${p}" does not exists, trying to create it`)
          try {
            mkdirp.sync(p)
            consola.info(`${p} succesfully created`)
          } catch (e) {
            console.error(String(e))
            return false
          }
        }
        return true
      }
    })

    questions.push({
      name: 'log_path',
      message: 'Log path',
      default: path.resolve(data_path, 'logs')
    })
  }

  questions.push({
    name: 'admin.email',
    message: 'Admin email',
    default: options => {
      const baseurl = new url.URL(options.baseurl)
      return (
        options.title.replace(' ', '').toLowerCase() + '@' + baseurl.hostname
      )
    },
    validate: notEmpty
  })

  questions.push({
    name: 'admin.password',
    message: 'Admin password',
    type: 'password',
    validate: notEmpty
  })

  questions.push({
    name: 'smtp_type',
    message: 'How should we send the emails ?',
    type: 'list',
    choices: ['SMTP', 'sendmail', 'None (choose later)']
  })

  questions.push({
    name: 'smtp.path',
    message: 'Where sendmail binary is ?',
    default: '/usr/sbin/sendmail',
    when: answers => answers.smtp_type === 'sendmail',
    validate: sendmail_path => sendmail_path.length > 0 && fs.existsSync(path.resolve(sendmail_path))
  })

  questions.push({
    name: 'smtp.host',
    message: 'SMTP Host',
    default: 'localhost',
    validate: notEmpty,
    when: answers => answers.smtp_type === 'SMTP'
  })

  questions.push({
    name: 'smtp.secure',
    message: 'Does SMTP server support TLS?',
    when: answers => answers.smtp_type === 'SMTP' && !['localhost', '127.0.0.1'].includes(answers.smtp.host),
    default: true,
    type: 'confirm'
  })

  questions.push({
    name: 'smtp.port',
    message: 'SMTP Port',
    default: answers => ['localhost', '127.0.0.1'].includes(answers.smtp.host) ? 25 : (answers.smtp.secure ? 465 : 587),
    when: answers => answers.smtp_type === 'SMTP'
  })

  questions.push({
    name: 'smtp_need_auth',
    message: 'is SMTP authentication needed?',
    type: 'confirm',
    default: answers => !['localhost', '127.0.0.1'].includes(answers.smtp.host),
    when: answers => answers.smtp_type === 'SMTP'
  })

  questions.push({
    name: 'smtp.auth.user',
    message: 'SMTP User',
    validate: notEmpty,
    default: answers => answers.admin.email,
    when: answers => answers.smtp_type === 'SMTP' && answers.smtp_need_auth
  })

  questions.push({
    name: 'smtp.auth.pass',
    message: 'SMTP Password',
    type: 'password',
    validate: notEmpty,
    when: answers => answers.smtp_type === 'SMTP' && answers.smtp_need_auth
  })

  const answers = await inquirer.prompt(questions)
  if (is_docker) {
    answers.server = { host: '0.0.0.0', port: 13120 }
    answers.upload_path = path.resolve(data_path, 'uploads')
    answers.log_level = 'debug'
    answers.log_path = path.resolve(data_path, 'logs')
    if (db === 'sqlite') {
      answers.db = { dialect: db, storage: path.resolve(data_path, 'db.sqlite') }
    } else {
      answers.db = {
        dialect: db,
        host: 'db',
        database: 'gancio',
        username: 'gancio',
        password: 'gancio'
      }
    }
  }

  return answers
}

async function run_migrations (db_conf) {
  const Umzug = require('umzug')
  const Sequelize = require('sequelize')
  try {
    const db = new Sequelize(db_conf)
    const umzug = new Umzug({
      storage: 'sequelize',
      storageOptions: { sequelize: db },
      logging: consola.info,
      migrations: {
        wrap: fun => {
          return () =>
            fun(db.queryInterface, Sequelize).catch(e => {
              consola.error(e)
              return false
            })
        },
        path: path.resolve(__dirname, 'migrations')
      }
    })
    await umzug.up()
    return db.close()
  } catch (e) {
    consola.warn(` ⚠️ Cannot connect to db, check your configuration => ${e}`)
    process.exit(-1)
  }
}

async function start (options) {
  // is first run?
  if (firstrun.check(options.config)) {
    if (options.docker) {
      consola.error(
        '⚠ ️ Something goes wrong, did you run "docker-compose run --rm gancio gancio setup --docker --db=<YOUR_DB_DIALECT>"'
      )
      process.exit(-1)
    }
    consola.error(` ⚠ Configuration file "${options.config}" not found! Use "--config <CONFIG_FILE.json>" to specify another path.
If this is your first run use 'gancio setup --config <CONFIG_FILE.json>' `)
    process.exit(-1)
  }
  const config = require('config')
  await run_migrations(config.db)
  consola.info(`Logging to ${path.resolve(`${config.log_path}/gancio.log`)} [level: ${config.log_level}]`)

  require('./index')
}

async function setup (options) {
  consola.info('You\'re going to setup gancio on this machine.')
  const config = await setupQuestionnaire(options.docker, options.db)
  await run_migrations(config.db)
  const ret = await firstrun.setup(config, options.config)
  if (!ret) {
    process.exit(-1)
  }
  if (options.docker) {
    consola.info('You can edit ./data/config.json to modify your configuration.')
    consola.info('Start the server with "docker-compose up"')
  } else {
    consola.info(
      `You can edit '${options.config}' to modify your configuration. `
    )
    consola.info(`Start the server with "gancio --config ${options.config}"`)
  }
  process.exit(0)
}

consola.info(`📅 ${pkg.name} - v${pkg.version} - ${pkg.description}`)

require('yargs')
  .usage('Usage $0 <command> [options]')
  .option('docker', {
    alias: 'd',
    describe: 'Inside docker',
    default: false,
    type: 'boolean'
  })
  .option('db', {
    describe: 'Specify db type'
  })
  .option('config', {
    alias: 'c',
    describe: 'Configuration file',
    default: path.resolve(data_path, 'config.json')
  })
  .coerce('config', config_path => {
    const absolute_config_path = path.resolve(cwd, config_path)
    process.env.config_path = absolute_config_path
    return absolute_config_path
  })
  .command(['start', 'run', '$0'], 'Start gancio', {}, start)
  .command('setup', 'Setup a new instance', {}, setup)
  .help('h')
  .alias('h', 'help')
  .epilog('Made with ❤ by underscore hacklab - https://gancio.org')
  .argv