system.js 10.3 KB
Newer Older
NGPixel's avatar
NGPixel committed
1
const _ = require('lodash')
2 3
const Promise = require('bluebird')
const getos = Promise.promisify(require('getos'))
NGPixel's avatar
NGPixel committed
4 5
const os = require('os')
const filesize = require('filesize')
6
const path = require('path')
7
const fs = require('fs-extra')
8
const moment = require('moment')
Nick's avatar
Nick committed
9
const graphHelper = require('../../helpers/graph')
10
const request = require('request-promise')
11 12
const crypto = require('crypto')
const nanoid = require('nanoid/non-secure/generate')
NGPixel's avatar
NGPixel committed
13 14 15

/* global WIKI */

16
const dbTypes = {
17 18
  mysql: 'MySQL',
  mariadb: 'MariaDB',
19
  postgres: 'PostgreSQL',
20 21
  sqlite: 'SQLite',
  mssql: 'MS SQL Server'
22 23
}

NGPixel's avatar
NGPixel committed
24 25
module.exports = {
  Query: {
Nick's avatar
Nick committed
26
    async system () { return {} }
NGPixel's avatar
NGPixel committed
27
  },
Nick's avatar
Nick committed
28
  Mutation: {
Nick's avatar
Nick committed
29
    async system () { return {} }
Nick's avatar
Nick committed
30
  },
NGPixel's avatar
NGPixel committed
31
  SystemQuery: {
Nick's avatar
Nick committed
32
    flags () {
Nick's avatar
Nick committed
33 34 35 36
      return _.transform(WIKI.config.flags, (result, value, key) => {
        result.push({ key, value })
      }, [])
    },
37 38
    async info() { return {} }
  },
Nick's avatar
Nick committed
39
  SystemMutation: {
Nick's avatar
Nick committed
40
    async updateFlags (obj, args, context) {
Nick's avatar
Nick committed
41 42 43 44 45 46 47 48
      WIKI.config.flags = _.transform(args.flags, (result, row) => {
        _.set(result, row.key, row.value)
      }, {})
      await WIKI.configSvc.applyFlags()
      await WIKI.configSvc.saveToDb(['flags'])
      return {
        responseResult: graphHelper.generateSuccess('System Flags applied successfully')
      }
Nick's avatar
Nick committed
49
    },
Nick's avatar
Nick committed
50
    async resetTelemetryClientId (obj, args, context) {
Nick's avatar
Nick committed
51 52 53 54 55 56
      try {
        WIKI.telemetry.generateClientId()
        await WIKI.configSvc.saveToDb(['telemetry'])
        return {
          responseResult: graphHelper.generateSuccess('Telemetry state updated successfully')
        }
57
      } catch (err) {
Nick's avatar
Nick committed
58 59 60
        return graphHelper.generateError(err)
      }
    },
Nick's avatar
Nick committed
61
    async setTelemetry (obj, args, context) {
Nick's avatar
Nick committed
62 63 64 65 66 67 68
      try {
        _.set(WIKI.config, 'telemetry.isEnabled', args.enabled)
        WIKI.telemetry.enabled = args.enabled
        await WIKI.configSvc.saveToDb(['telemetry'])
        return {
          responseResult: graphHelper.generateSuccess('Telemetry Client ID has been reset successfully')
        }
69
      } catch (err) {
Nick's avatar
Nick committed
70 71
        return graphHelper.generateError(err)
      }
Nick's avatar
Nick committed
72 73 74
    },
    async performUpgrade (obj, args, context) {
      try {
75 76 77 78 79 80 81
        if (process.env.UPGRADE_COMPANION) {
          await request({
            method: 'POST',
            uri: 'http://wiki-update-companion/upgrade'
          })
          return {
            responseResult: graphHelper.generateSuccess('Upgrade has started.')
Nick's avatar
Nick committed
82
          }
83 84
        } else {
          throw new Error('You must run the wiki-update-companion container and pass the UPGRADE_COMPANION env var in order to use this feature.')
Nick's avatar
Nick committed
85 86 87 88
        }
      } catch (err) {
        return graphHelper.generateError(err)
      }
89
    },
90 91 92
    /**
     * Import Users from a v1 installation
     */
93 94 95 96
    async importUsersFromV1(obj, args, context) {
      try {
        const MongoClient = require('mongodb').MongoClient
        if (args.mongoDbConnString && args.mongoDbConnString.length > 10) {
97 98
          // -> Connect to DB

99 100 101 102 103 104
          const client = await MongoClient.connect(args.mongoDbConnString, {
            appname: `Wiki.js ${WIKI.version} Migration Tool`
          })
          const dbUsers = client.db().collection('users')
          const userCursor = dbUsers.find({ email: { '$ne': 'guest' } })

105 106
          const curDateISO = new Date().toISOString()

107 108 109
          let failed = []
          let usersCount = 0
          let groupsCount = 0
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
          let assignableGroups = []
          let reuseGroups = []

          // -> Create SINGLE group

          if (args.groupMode === `SINGLE`) {
            const singleGroup = await WIKI.models.groups.query().insert({
              name: `Import_${curDateISO}`,
              permissions: JSON.stringify(WIKI.data.groups.defaultPermissions),
              pageRules: JSON.stringify(WIKI.data.groups.defaultPageRules)
            })
            groupsCount++
            assignableGroups.push(singleGroup.id)
          }

          // -> Iterate all users
126 127 128

          while (await userCursor.hasNext()) {
            const usr = await userCursor.next()
129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182

            let usrGroup = []
            if (args.groupMode === `MULTI`) {
              // -> Check if global admin

              if (_.some(usr.rights, ['role', 'admin'])) {
                usrGroup.push(1)
              } else {
                // -> Check if identical group already exists

                const currentRights = _.sortBy(_.map(usr.rights, r => _.pick(r, ['role', 'path', 'exact', 'deny'])), ['role', 'path', 'exact', 'deny'])
                const ruleSetId = crypto.createHash('sha1').update(JSON.stringify(currentRights)).digest('base64')
                const existingGroup = _.find(reuseGroups, ['hash', ruleSetId])
                if (existingGroup) {
                  usrGroup.push(existingGroup.groupId)
                } else {
                  // -> Build new group

                  const pageRules = _.map(usr.rights, r => {
                    let roles = ['read:pages', 'read:assets', 'read:comments', 'write:comments']
                    if (r.role === `write`) {
                      roles = _.concat(roles, ['write:pages', 'manage:pages', 'read:source', 'read:history', 'write:assets', 'manage:assets'])
                    }
                    return {
                      id: nanoid('1234567890abcdef', 10),
                      roles: roles,
                      match: r.exact ? 'EXACT' : 'START',
                      deny: r.deny,
                      path: (r.path.indexOf('/') === 0) ? r.path.substring(1) : r.path,
                      locales: []
                    }
                  })

                  const perms = _.chain(pageRules).reject('deny').map('roles').union().flatten().value()

                  // -> Create new group

                  const newGroup = await WIKI.models.groups.query().insert({
                    name: `Import_${curDateISO}_${groupsCount + 1}`,
                    permissions: JSON.stringify(perms),
                    pageRules: JSON.stringify(pageRules)
                  })
                  reuseGroups.push({
                    groupId: newGroup.id,
                    hash: ruleSetId
                  })
                  groupsCount++
                  usrGroup.push(newGroup.id)
                }
              }
            }

            // -> Create User

183 184 185 186 187 188
            try {
              await WIKI.models.users.createNewUser({
                providerKey: usr.provider,
                email: usr.email,
                name: usr.name,
                passwordRaw: usr.password,
189
                groups: (usrGroup.length > 0) ? usrGroup : assignableGroups,
190 191 192 193 194 195 196 197 198 199 200 201 202 203
                mustChangePassword: false,
                sendWelcomeEmail: false
              })
              usersCount++
            } catch (err) {
              failed.push({
                provider: usr.provider,
                email: usr.email,
                error: err.message
              })
              WIKI.logger.warn(`${usr.email}: ${err}`)
            }
          }

204 205 206 207 208 209
          // -> Reload group permissions

          if (args.groupMode !== `NONE`) {
            await WIKI.auth.reloadGroups()
          }

210 211 212 213 214 215 216 217 218 219 220 221 222
          client.close()
          return {
            responseResult: graphHelper.generateSuccess('Import completed.'),
            usersCount: usersCount,
            groupsCount: groupsCount,
            failed: failed
          }
        } else {
          throw new Error('MongoDB Connection String is missing or invalid.')
        }
      } catch (err) {
        return graphHelper.generateError(err)
      }
Nick's avatar
Nick committed
223 224
    }
  },
225
  SystemInfo: {
Nick's avatar
Nick committed
226
    configFile () {
227 228
      return path.join(process.cwd(), 'config.yml')
    },
Nick's avatar
Nick committed
229
    cpuCores () {
Nick's avatar
Nick committed
230 231
      return os.cpus().length
    },
Nick's avatar
Nick committed
232
    currentVersion () {
233 234
      return WIKI.version
    },
Nick's avatar
Nick committed
235
    dbType () {
236 237
      return _.get(dbTypes, WIKI.config.db.type, 'Unknown DB')
    },
Nick's avatar
Nick committed
238
    async dbVersion () {
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
      let version = 'Unknown Version'
      switch (WIKI.config.db.type) {
        case 'mariadb':
        case 'mysql':
          const resultMYSQL = await WIKI.models.knex.raw('SELECT VERSION() as version;')
          version = _.get(resultMYSQL, '[0][0].version', 'Unknown Version')
          break
        case 'mssql':
          const resultMSSQL = await WIKI.models.knex.raw('SELECT @@VERSION as version;')
          version = _.get(resultMSSQL, '[0].version', 'Unknown Version')
          break
        case 'postgres':
          version = _.get(WIKI.models, 'knex.client.version', 'Unknown Version')
          break
        case 'sqlite':
          version = _.get(WIKI.models, 'knex.client.driver.VERSION', 'Unknown Version')
          break
      }
      return version
258
    },
Nick's avatar
Nick committed
259
    dbHost () {
260 261 262 263 264
      if (WIKI.config.db.type === 'sqlite') {
        return WIKI.config.db.storage
      } else {
        return WIKI.config.db.host
      }
265
    },
Nick's avatar
Nick committed
266
    hostname () {
Nick's avatar
Nick committed
267 268
      return os.hostname()
    },
Nick's avatar
Nick committed
269
    latestVersion () {
270
      return WIKI.system.updates.version
271
    },
Nick's avatar
Nick committed
272
    latestVersionReleaseDate () {
273
      return moment.utc(WIKI.system.updates.releaseDate)
274
    },
Nick's avatar
Nick committed
275
    nodeVersion () {
Nick's avatar
Nick committed
276 277
      return process.version.substr(1)
    },
Nick's avatar
Nick committed
278
    async operatingSystem () {
279 280 281 282 283
      let osLabel = `${os.type()} (${os.platform()}) ${os.release()} ${os.arch()}`
      if (os.platform() === 'linux') {
        const osInfo = await getos()
        osLabel = `${os.type()} - ${osInfo.dist} (${osInfo.codename || os.platform()}) ${osInfo.release || os.release()} ${os.arch()}`
      }
284 285 286
      return osLabel
    },
    async platform () {
287 288
      const isDockerized = await fs.pathExists('/.dockerenv')
      if (isDockerized) {
289
        return 'docker'
290
      }
291
      return os.platform()
292
    },
Nick's avatar
Nick committed
293
    ramTotal () {
294 295
      return filesize(os.totalmem())
    },
Nick's avatar
Nick committed
296
    telemetry () {
Nick's avatar
Nick committed
297 298
      return WIKI.telemetry.enabled
    },
Nick's avatar
Nick committed
299
    telemetryClientId () {
Nick's avatar
Nick committed
300 301
      return WIKI.config.telemetry.clientId
    },
Nick's avatar
Nick committed
302
    async upgradeCapable () {
303
      return !_.isNil(process.env.UPGRADE_COMPANION)
Nick's avatar
Nick committed
304 305
    },
    workingDirectory () {
306 307
      return process.cwd()
    },
Nick's avatar
Nick committed
308
    async groupsTotal () {
309 310 311
      const total = await WIKI.models.groups.query().count('* as total').first().pluck('total')
      return _.toSafeInteger(total)
    },
Nick's avatar
Nick committed
312
    async pagesTotal () {
313 314 315
      const total = await WIKI.models.pages.query().count('* as total').first().pluck('total')
      return _.toSafeInteger(total)
    },
Nick's avatar
Nick committed
316
    async usersTotal () {
317 318
      const total = await WIKI.models.users.query().count('* as total').first().pluck('total')
      return _.toSafeInteger(total)
NGPixel's avatar
NGPixel committed
319
    }
320
  }
NGPixel's avatar
NGPixel committed
321
}