liz/wikijs-fork
liz/wikijs-fork
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: modular auth + queue tasks

Browse Source
This commit is contained in:
NGPixel 2017-07-29 17:33:08 -04:00
parent 9c112ab535
commit f32429325c
25 changed files with 822 additions and 770 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
config.sample.yml
View File

@ -5,7 +5,7 @@
# https://docs.requarks.io/wiki/install # https://docs.requarks.io/wiki/install
# --------------------------------------------------------------------- # ---------------------------------------------------------------------
# Port the main server should listen to (80 by default) # Port the main server should listen to
# --------------------------------------------------------------------- # ---------------------------------------------------------------------
port: 80 port: 80
@ -39,3 +39,9 @@ redis:
db: 0 db: 0
password: null password: null
# ---------------------------------------------------------------------
# Background Workers
# ---------------------------------------------------------------------
# Leave 0 for auto based on CPU cores
workers: 0

1
package.json
View File

@ -52,7 +52,6 @@
"connect-flash": "~0.1.1", "connect-flash": "~0.1.1",
"connect-redis": "~3.3.0", "connect-redis": "~3.3.0",
"cookie-parser": "~1.4.3", "cookie-parser": "~1.4.3",
"cron": "~1.2.1",
"diff2html": "~2.3.0", "diff2html": "~2.3.0",
"execa": "~0.7.0", "execa": "~0.7.0",
"express": "~4.15.3", "express": "~4.15.3",

68
server/app/data.yml
View File

@ -5,65 +5,22 @@
name: Wiki.js name: Wiki.js
defaults: defaults:
config: config:
title: Wiki
host: http://localhost
port: 80 port: 80
paths: paths:
repo: ./repo repo: ./repo
data: ./data data: ./data
uploads: db:
maxImageFileSize: 3, host: localhost
maxOtherFileSize: 100 port: 5432
lang: en user: wikijs
public: false pass: wikijsrocks
auth: db: wiki
defaultReadAccess: false redis:
local: host: localhost
enabled: true port: 6379
microsoft: db: 0
enabled: false
google:
enabled: false
facebook:
enabled: false
github:
enabled: false
slack:
enabled: false
ldap:
enabled: false
azure:
enabled: false
db: mongodb://localhost/wiki
sessionSecret: null
admin: null
git:
url: null
branch: master
auth:
type: basic
username: null
password: null password: null
privateKey: null workers: 0
sslVerify: true
serverEmail: wiki@example.com
showUserEmail: true
features:
linebreaks: true
mathjax: true
externalLogging:
bugsnap: false
loggly: false
papertrail: false
rollbar: false
sentry: false
theme:
primary: indigo
alt: blue-grey
footer: blue-grey
code:
dark: true
colorize: true
authProviders: authProviders:
- local - local
- microsoft - microsoft
@ -112,6 +69,9 @@ langs:
- -
id: ko id: ko
name: Korean - 한국어 name: Korean - 한국어
-
id: pt
name: Portuguese - Português
- -
id: ru id: ru
name: Russian - Русский name: Russian - Русский

33
server/authentication/azure.js Normal file
View File

@ -0,0 +1,33 @@
'use strict'
/* global wiki */
// ------------------------------------
// Azure AD Account
// ------------------------------------
const AzureAdOAuth2Strategy = require('passport-azure-ad-oauth2').Strategy
module.exports = (passport) => {
if (wiki.config.auth.azure && wiki.config.auth.azure.enabled) {
const jwt = require('jsonwebtoken')
passport.use('azure_ad_oauth2',
new AzureAdOAuth2Strategy({
clientID: wiki.config.auth.azure.clientId,
clientSecret: wiki.config.auth.azure.clientSecret,
callbackURL: wiki.config.host + '/login/azure/callback',
resource: wiki.config.auth.azure.resource,
tenant: wiki.config.auth.azure.tenant
}, (accessToken, refreshToken, params, profile, cb) => {
let waadProfile = jwt.decode(params.id_token)
waadProfile.id = waadProfile.oid
waadProfile.provider = 'azure'
wiki.db.User.processProfile(waadProfile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
}

28
server/authentication/facebook.js Normal file
View File

@ -0,0 +1,28 @@
'use strict'
/* global wiki */
// ------------------------------------
// Facebook Account
// ------------------------------------
const FacebookStrategy = require('passport-facebook').Strategy
module.exports = (passport) => {
if (wiki.config.auth.facebook && wiki.config.auth.facebook.enabled) {
passport.use('facebook',
new FacebookStrategy({
clientID: wiki.config.auth.facebook.clientId,
clientSecret: wiki.config.auth.facebook.clientSecret,
callbackURL: wiki.config.host + '/login/facebook/callback',
profileFields: ['id', 'displayName', 'email']
}, function (accessToken, refreshToken, profile, cb) {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
}

28
server/authentication/github.js Normal file
View File

@ -0,0 +1,28 @@
'use strict'
/* global wiki */
// ------------------------------------
// GitHub Account
// ------------------------------------
const GitHubStrategy = require('passport-github2').Strategy
module.exports = (passport) => {
if (wiki.config.auth.github && wiki.config.auth.github.enabled) {
passport.use('github',
new GitHubStrategy({
clientID: wiki.config.auth.github.clientId,
clientSecret: wiki.config.auth.github.clientSecret,
callbackURL: wiki.config.host + '/login/github/callback',
scope: ['user:email']
}, (accessToken, refreshToken, profile, cb) => {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
}

27
server/authentication/google.js Normal file
View File

@ -0,0 +1,27 @@
'use strict'
/* global wiki */
// ------------------------------------
// Google ID Account
// ------------------------------------
const GoogleStrategy = require('passport-google-oauth20').Strategy
module.exports = (passport) => {
if (wiki.config.auth.google && wiki.config.auth.google.enabled) {
passport.use('google',
new GoogleStrategy({
clientID: wiki.config.auth.google.clientId,
clientSecret: wiki.config.auth.google.clientSecret,
callbackURL: wiki.config.host + '/login/google/callback'
}, (accessToken, refreshToken, profile, cb) => {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
}

41
server/authentication/ldap.js Normal file
View File

@ -0,0 +1,41 @@
'use strict'
/* global wiki */
// ------------------------------------
// LDAP Account
// ------------------------------------
const LdapStrategy = require('passport-ldapauth').Strategy
module.exports = (passport) => {
if (wiki.config.auth.ldap && wiki.config.auth.ldap.enabled) {
passport.use('ldapauth',
new LdapStrategy({
server: {
url: wiki.config.auth.ldap.url,
bindDn: wiki.config.auth.ldap.bindDn,
bindCredentials: wiki.config.auth.ldap.bindCredentials,
searchBase: wiki.config.auth.ldap.searchBase,
searchFilter: wiki.config.auth.ldap.searchFilter,
searchAttributes: ['displayName', 'name', 'cn', 'mail'],
tlsOptions: (wiki.config.auth.ldap.tlsEnabled) ? {
ca: [
fs.readFileSync(wiki.config.auth.ldap.tlsCertPath)
]
} : {}
},
usernameField: 'email',
passReqToCallback: false
}, (profile, cb) => {
profile.provider = 'ldap'
profile.id = profile.dn
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
}

34
server/authentication/local.js Normal file
View File

@ -0,0 +1,34 @@
'use strict'
/* global wiki */
// ------------------------------------
// Local Account
// ------------------------------------
const LocalStrategy = require('passport-local').Strategy
module.exports = (passport) => {
if (wiki.config.auth.local && wiki.config.auth.local.enabled) {
passport.use('local',
new LocalStrategy({
usernameField: 'email',
passwordField: 'password'
}, (uEmail, uPassword, done) => {
wiki.db.User.findOne({ email: uEmail, provider: 'local' }).then((user) => {
if (user) {
return user.validatePassword(uPassword).then(() => {
return done(null, user) || true
}).catch((err) => {
return done(err, null)
})
} else {
return done(new Error('INVALID_LOGIN'), null)
}
}).catch((err) => {
done(err, null)
})
}
))
}
}

27
server/authentication/microsoft.js Normal file
View File

@ -0,0 +1,27 @@
'use strict'
/* global wiki */
// ------------------------------------
// Microsoft Account
// ------------------------------------
const WindowsLiveStrategy = require('passport-windowslive').Strategy
module.exports = (passport) => {
if (wiki.config.auth.microsoft && wiki.config.auth.microsoft.enabled) {
passport.use('windowslive',
new WindowsLiveStrategy({
clientID: wiki.config.auth.microsoft.clientId,
clientSecret: wiki.config.auth.microsoft.clientSecret,
callbackURL: wiki.config.host + '/login/ms/callback'
}, function (accessToken, refreshToken, profile, cb) {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
}

27
server/authentication/slack.js Normal file
View File

@ -0,0 +1,27 @@
'use strict'
/* global wiki */
// ------------------------------------
// Slack Account
// ------------------------------------
const SlackStrategy = require('passport-slack').Strategy
module.exports = (passport) => {
if (wiki.config.auth.slack && wiki.config.auth.slack.enabled) {
passport.use('slack',
new SlackStrategy({
clientID: wiki.config.auth.slack.clientId,
clientSecret: wiki.config.auth.slack.clientSecret,
callbackURL: wiki.config.host + '/login/slack/callback'
}, (accessToken, refreshToken, profile, cb) => {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
}

29
server/index.js
View File

@ -6,10 +6,14 @@
// =========================================== // ===========================================
const path = require('path') const path = require('path')
const cluster = require('cluster')
let wiki = { let wiki = {
IS_DEBUG: process.env.NODE_ENV === 'development', IS_DEBUG: process.env.NODE_ENV === 'development',
IS_MASTER: cluster.isMaster,
ROOTPATH: process.cwd(), ROOTPATH: process.cwd(),
SERVERPATH: path.join(process.cwd(), 'server') SERVERPATH: path.join(process.cwd(), 'server'),
configSvc: require('./modules/config')
} }
global.wiki = wiki global.wiki = wiki
@ -19,29 +23,36 @@ process.env.VIPS_WARNING = false
// require('@glimpse/glimpse').init() // require('@glimpse/glimpse').init()
// } // }
let appconf = require('./modules/config')() wiki.configSvc.init()
wiki.config = appconf.config
wiki.data = appconf.data
// ---------------------------------------- // ----------------------------------------
// Load Winston // Init Logger
// ---------------------------------------- // ----------------------------------------
wiki.logger = require('./modules/logger')() wiki.logger = require('./modules/logger').init()
// ----------------------------------------
// Init DB
// ----------------------------------------
wiki.db = require('./modules/db').init()
// ---------------------------------------- // ----------------------------------------
// Start Cluster // Start Cluster
// ---------------------------------------- // ----------------------------------------
const cluster = require('cluster')
const numCPUs = require('os').cpus().length const numCPUs = require('os').cpus().length
let numWorkers = (wiki.config.workers > 0) ? wiki.config.workers : numCPUs
if (numWorkers > numCPUs) {
numWorkers = numCPUs
}
if (cluster.isMaster) { if (cluster.isMaster) {
wiki.logger.info('Wiki.js is initializing...') wiki.logger.info('Wiki.js is initializing...')
require('./master') require('./master')
for (let i = 0; i < numCPUs; i++) { for (let i = 0; i < numWorkers; i++) {
cluster.fork() cluster.fork()
} }
@ -50,5 +61,5 @@ if (cluster.isMaster) {
}) })
} else { } else {
wiki.logger.info(`Background Worker #${cluster.worker.id} is starting...`) wiki.logger.info(`Background Worker #${cluster.worker.id} is starting...`)
// require('./worker') require('./worker')
} }

28
server/master.js
View File

@ -2,14 +2,17 @@
/* global wiki */ /* global wiki */
const path = require('path') const Promise = require('bluebird')
module.exports = Promise.join(
wiki.db.onReady,
wiki.configSvc.loadFromDb()
).then(() => {
// ---------------------------------------- // ----------------------------------------
// Load global modules // Load global modules
// ---------------------------------------- // ----------------------------------------
wiki.disk = require('./modules/disk').init() wiki.disk = require('./modules/disk').init()
wiki.db = require('./modules/db').init()
wiki.entries = require('./modules/entries').init() wiki.entries = require('./modules/entries').init()
wiki.git = require('./modules/git').init(false) wiki.git = require('./modules/git').init(false)
wiki.lang = require('i18next') wiki.lang = require('i18next')
@ -31,6 +34,7 @@ const favicon = require('serve-favicon')
const flash = require('connect-flash') const flash = require('connect-flash')
const http = require('http') const http = require('http')
const i18nBackend = require('i18next-node-fs-backend') const i18nBackend = require('i18next-node-fs-backend')
const path = require('path')
const passport = require('passport') const passport = require('passport')
const passportSocketIo = require('passport.socketio') const passportSocketIo = require('passport.socketio')
const session = require('express-session') const session = require('express-session')
@ -73,7 +77,7 @@ app.use(express.static(path.join(wiki.ROOTPATH, 'assets'), {
require('./modules/auth')(passport) require('./modules/auth')(passport)
wiki.rights = require('./modules/rights') wiki.rights = require('./modules/rights')
wiki.rights.init() // wiki.rights.init()
let sessionStore = new SessionRedisStore({ let sessionStore = new SessionRedisStore({
client: wiki.redis client: wiki.redis
@ -83,7 +87,7 @@ app.use(cookieParser())
app.use(session({ app.use(session({
name: 'wikijs.sid', name: 'wikijs.sid',
store: sessionStore, store: sessionStore,
secret: wiki.config.sessionSecret, secret: wiki.config.site.sessionSecret,
resave: false, resave: false,
saveUninitialized: false saveUninitialized: false
})) }))
@ -106,8 +110,8 @@ wiki.lang.use(i18nBackend).init({
ns: ['common', 'admin', 'auth', 'errors', 'git'], ns: ['common', 'admin', 'auth', 'errors', 'git'],
defaultNS: 'common', defaultNS: 'common',
saveMissing: false, saveMissing: false,
preload: [wiki.config.lang], preload: [wiki.config.site.lang],
lng: wiki.config.lang, lng: wiki.config.site.lang,
fallbackLng: 'en', fallbackLng: 'en',
backend: { backend: {
loadPath: path.join(wiki.SERVERPATH, 'locales/{{lng}}/{{ns}}.json') loadPath: path.join(wiki.SERVERPATH, 'locales/{{lng}}/{{ns}}.json')
@ -129,9 +133,9 @@ app.use(bodyParser.urlencoded({ extended: false, limit: '1mb' }))
// ---------------------------------------- // ----------------------------------------
app.locals._ = require('lodash') app.locals._ = require('lodash')
app.locals.t = wiki.lang.t.bind(wiki.lang) app.locals.t = wiki.lang.t.bind(wiki.config.site.lang)
app.locals.moment = require('moment') app.locals.moment = require('moment')
app.locals.moment.locale(wiki.config.lang) app.locals.moment.locale(wiki.config.site.lang)
app.locals.appconfig = wiki.config app.locals.appconfig = wiki.config
app.use(mw.flash) app.use(mw.flash)
@ -205,7 +209,7 @@ server.on('listening', () => {
io.use(passportSocketIo.authorize({ io.use(passportSocketIo.authorize({
key: 'wikijs.sid', key: 'wikijs.sid',
store: sessionStore, store: sessionStore,
secret: wiki.config.sessionSecret, secret: wiki.config.site.sessionSecret,
cookieParser, cookieParser,
success: (data, accept) => { success: (data, accept) => {
accept() accept()
@ -230,3 +234,9 @@ graceful.on('exit', () => {
process.exit() process.exit()
}) })
}) })
return true
}).catch(err => {
wiki.logger.error(err)
process.exit(1)
})

233
server/modules/auth.js
View File

@ -24,191 +24,9 @@ module.exports = function (passport) {
}) })
}) })
// Local Account
if (wiki.config.auth.local && wiki.config.auth.local.enabled) {
const LocalStrategy = require('passport-local').Strategy
passport.use('local',
new LocalStrategy({
usernameField: 'email',
passwordField: 'password'
}, (uEmail, uPassword, done) => {
wiki.db.User.findOne({ email: uEmail, provider: 'local' }).then((user) => {
if (user) {
return user.validatePassword(uPassword).then(() => {
return done(null, user) || true
}).catch((err) => {
return done(err, null)
})
} else {
return done(new Error('INVALID_LOGIN'), null)
}
}).catch((err) => {
done(err, null)
})
}
))
}
// Google ID
if (wiki.config.auth.google && wiki.config.auth.google.enabled) {
const GoogleStrategy = require('passport-google-oauth20').Strategy
passport.use('google',
new GoogleStrategy({
clientID: wiki.config.auth.google.clientId,
clientSecret: wiki.config.auth.google.clientSecret,
callbackURL: wiki.config.host + '/login/google/callback'
}, (accessToken, refreshToken, profile, cb) => {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
// Microsoft Accounts
if (wiki.config.auth.microsoft && wiki.config.auth.microsoft.enabled) {
const WindowsLiveStrategy = require('passport-windowslive').Strategy
passport.use('windowslive',
new WindowsLiveStrategy({
clientID: wiki.config.auth.microsoft.clientId,
clientSecret: wiki.config.auth.microsoft.clientSecret,
callbackURL: wiki.config.host + '/login/ms/callback'
}, function (accessToken, refreshToken, profile, cb) {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
// Facebook
if (wiki.config.auth.facebook && wiki.config.auth.facebook.enabled) {
const FacebookStrategy = require('passport-facebook').Strategy
passport.use('facebook',
new FacebookStrategy({
clientID: wiki.config.auth.facebook.clientId,
clientSecret: wiki.config.auth.facebook.clientSecret,
callbackURL: wiki.config.host + '/login/facebook/callback',
profileFields: ['id', 'displayName', 'email']
}, function (accessToken, refreshToken, profile, cb) {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
// GitHub
if (wiki.config.auth.github && wiki.config.auth.github.enabled) {
const GitHubStrategy = require('passport-github2').Strategy
passport.use('github',
new GitHubStrategy({
clientID: wiki.config.auth.github.clientId,
clientSecret: wiki.config.auth.github.clientSecret,
callbackURL: wiki.config.host + '/login/github/callback',
scope: ['user:email']
}, (accessToken, refreshToken, profile, cb) => {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
// Slack
if (wiki.config.auth.slack && wiki.config.auth.slack.enabled) {
const SlackStrategy = require('passport-slack').Strategy
passport.use('slack',
new SlackStrategy({
clientID: wiki.config.auth.slack.clientId,
clientSecret: wiki.config.auth.slack.clientSecret,
callbackURL: wiki.config.host + '/login/slack/callback'
}, (accessToken, refreshToken, profile, cb) => {
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
// LDAP
if (wiki.config.auth.ldap && wiki.config.auth.ldap.enabled) {
const LdapStrategy = require('passport-ldapauth').Strategy
passport.use('ldapauth',
new LdapStrategy({
server: {
url: wiki.config.auth.ldap.url,
bindDn: wiki.config.auth.ldap.bindDn,
bindCredentials: wiki.config.auth.ldap.bindCredentials,
searchBase: wiki.config.auth.ldap.searchBase,
searchFilter: wiki.config.auth.ldap.searchFilter,
searchAttributes: ['displayName', 'name', 'cn', 'mail'],
tlsOptions: (wiki.config.auth.ldap.tlsEnabled) ? {
ca: [
fs.readFileSync(wiki.config.auth.ldap.tlsCertPath)
]
} : {}
},
usernameField: 'email',
passReqToCallback: false
}, (profile, cb) => {
profile.provider = 'ldap'
profile.id = profile.dn
wiki.db.User.processProfile(profile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
// AZURE AD
if (wiki.config.auth.azure && wiki.config.auth.azure.enabled) {
const AzureAdOAuth2Strategy = require('passport-azure-ad-oauth2').Strategy
const jwt = require('jsonwebtoken')
passport.use('azure_ad_oauth2',
new AzureAdOAuth2Strategy({
clientID: wiki.config.auth.azure.clientId,
clientSecret: wiki.config.auth.azure.clientSecret,
callbackURL: wiki.config.host + '/login/azure/callback',
resource: wiki.config.auth.azure.resource,
tenant: wiki.config.auth.azure.tenant
}, (accessToken, refreshToken, params, profile, cb) => {
let waadProfile = jwt.decode(params.id_token)
waadProfile.id = waadProfile.oid
waadProfile.provider = 'azure'
wiki.db.User.processProfile(waadProfile).then((user) => {
return cb(null, user) || true
}).catch((err) => {
return cb(err, null) || true
})
}
))
}
// Create users for first-time // Create users for first-time
wiki.db.onReady.then(() => { return wiki.db.User.findOne({ provider: 'local', email: 'guest@example.com' }).then((c) => {
return wiki.db.User.findOne({ provider: 'local', email: 'guest' }).then((c) => {
if (c < 1) { if (c < 1) {
// Create guest account // Create guest account
@ -227,29 +45,30 @@ module.exports = function (passport) {
return err return err
}) })
} }
}).then(() => { })
if (process.env.WIKI_JS_HEROKU) {
return wiki.db.User.findOne({ provider: 'local', email: process.env.WIKI_ADMIN_EMAIL }).then((c) => {
if (c < 1) {
// Create root admin account (HEROKU ONLY)
return wiki.db.User.create({ // .then(() => {
provider: 'local', // if (process.env.WIKI_JS_HEROKU) {
email: process.env.WIKI_ADMIN_EMAIL, // return wiki.db.User.findOne({ provider: 'local', email: process.env.WIKI_ADMIN_EMAIL }).then((c) => {
name: 'Administrator', // if (c < 1) {
password: '$2a$04$MAHRw785Xe/Jd5kcKzr3D.VRZDeomFZu2lius4gGpZZ9cJw7B7Mna', // admin123 (default) // // Create root admin account (HEROKU ONLY)
role: 'admin'
}).then(() => { // return wiki.db.User.create({
wiki.logger.info('[AUTH] Root admin account created successfully!') // provider: 'local',
return true // email: process.env.WIKI_ADMIN_EMAIL,
}).catch((err) => { // name: 'Administrator',
wiki.logger.error('[AUTH] An error occured while creating root admin account:') // password: '$2a$04$MAHRw785Xe/Jd5kcKzr3D.VRZDeomFZu2lius4gGpZZ9cJw7B7Mna', // admin123 (default)
wiki.logger.error(err) // role: 'admin'
return err // }).then(() => {
}) // wiki.logger.info('[AUTH] Root admin account created successfully!')
} else { return true } // return true
}) // }).catch((err) => {
} else { return true } // wiki.logger.error('[AUTH] An error occured while creating root admin account:')
}) // wiki.logger.error(err)
}) // return err
// })
// } else { return true }
// })
// } else { return true }
// })
} }

65
server/modules/config.js
View File

@ -8,18 +8,21 @@ const _ = require('lodash')
const path = require('path') const path = require('path')
const cfgHelper = require('../helpers/config') const cfgHelper = require('../helpers/config')
module.exports = {
SUBSETS: ['auth', 'features', 'git', 'logging', 'site', 'theme', 'uploads'],
/** /**
* Load Application Configuration * Load root config from disk
* *
* @param {Object} confPaths Path to the configuration files * @param {any} confPaths
* @return {Object} Application Configuration * @returns
*/ */
module.exports = (confPaths) => { init() {
confPaths = _.defaults(confPaths, { let confPaths = {
config: path.join(wiki.ROOTPATH, 'config.yml'), config: path.join(wiki.ROOTPATH, 'config.yml'),
data: path.join(wiki.SERVERPATH, 'app/data.yml'), data: path.join(wiki.SERVERPATH, 'app/data.yml'),
dataRegex: path.join(wiki.SERVERPATH, 'app/regex.js') dataRegex: path.join(wiki.SERVERPATH, 'app/regex.js')
}) }
let appconfig = {} let appconfig = {}
let appdata = {} let appdata = {}
@ -52,18 +55,48 @@ module.exports = (confPaths) => {
appconfig.public = (appconfig.public === true || _.toLower(appconfig.public) === 'true') appconfig.public = (appconfig.public === true || _.toLower(appconfig.public) === 'true')
// List authentication strategies // List authentication strategies
wiki.config = appconfig
wiki.data = appdata
appconfig.authStrategies = { // List authentication strategies
list: _.filter(appconfig.auth, ['enabled', true]),
socialEnabled: (_.chain(appconfig.auth).omit(['local', 'ldap']).filter(['enabled', true]).value().length > 0) // appconfig.authStrategies = {
} // list: _.filter(appconfig.auth, ['enabled', true]),
if (appconfig.authStrategies.list.length < 1) { // socialEnabled: (_.chain(appconfig.auth).omit('local').filter(['enabled', true]).value().length > 0)
console.error(new Error('You must enable at least 1 authentication strategy!')) // }
process.exit(1) // if (appconfig.authStrategies.list.length < 1) {
// console.error(new Error('You must enable at least 1 authentication strategy!'))
// process.exit(1)
// }
},
/**
* Load config from DB
*
* @param {Array} subsets Array of subsets to load
* @returns Promise
*/
loadFromDb(subsets) {
if (!_.isArray(subsets) || subsets.length === 0) {
subsets = this.SUBSETS
} }
return { return wiki.db.Setting.findAll({
config: appconfig, attributes: ['key', 'config'],
data: appdata where: {
key: {
$in: subsets
}
}
}).then(results => {
if (_.isArray(results) && results.length > 0) {
results.forEach(result => {
wiki.config[result.key] = result.config
})
return true
} else {
return Promise.reject(new Error('Invalid DB Configuration result set'))
}
})
} }
} }

8
server/modules/db.js
View File

@ -5,6 +5,7 @@
const fs = require('fs') const fs = require('fs')
const path = require('path') const path = require('path')
const _ = require('lodash') const _ = require('lodash')
const Promise = require('bluebird')
/** /**
* PostgreSQL DB module * PostgreSQL DB module
@ -33,7 +34,8 @@ module.exports = {
max: 10, max: 10,
min: 0, min: 0,
idle: 10000 idle: 10000
} },
logging: false
}) })
// Attempt to connect and authenticate to DB // Attempt to connect and authenticate to DB
@ -63,10 +65,10 @@ module.exports = {
// Sync DB // Sync DB
self.onReady = self.inst.sync({ self.onReady = (wiki.IS_MASTER) ? self.inst.sync({
force: false, force: false,
logging: false logging: false
}) }) : Promise.resolve()
return self return self
} }

8
server/modules/disk.js
View File

@ -27,7 +27,7 @@ module.exports = {
this._uploadsThumbsPath = path.resolve(wiki.ROOTPATH, wiki.config.paths.data, 'thumbs') this._uploadsThumbsPath = path.resolve(wiki.ROOTPATH, wiki.config.paths.data, 'thumbs')
this.createBaseDirectories() this.createBaseDirectories()
this.initMulter() // this.initMulter()
return this return this
}, },
@ -37,8 +37,10 @@ module.exports = {
*/ */
initMulter () { initMulter () {
let maxFileSizes = { let maxFileSizes = {
img: wiki.config.uploads.maxImageFileSize * 1024 * 1024, // img: wiki.config.uploads.maxImageFileSize * 1024 * 1024,
file: wiki.config.uploads.maxOtherFileSize * 1024 * 1024 // file: wiki.config.uploads.maxOtherFileSize * 1024 * 1024
img: 3 * 1024 * 1024,
file: 10 * 1024 * 1024
} }
// -> IMAGES // -> IMAGES

2
server/modules/git.js
View File

@ -51,7 +51,7 @@ module.exports = {
// -> Initialize repository // -> Initialize repository
self.onReady = self._initRepo() self.onReady = (wiki.IS_MASTER) ? self._initRepo() : Promise.resolve()
// Define signature // Define signature

84
server/modules/logger.js
View File

@ -4,7 +4,8 @@
const cluster = require('cluster') const cluster = require('cluster')
module.exports = () => { module.exports = {
init() {
let winston = require('winston') let winston = require('winston')
// Console // Console
@ -29,50 +30,51 @@ module.exports = () => {
// External services // External services
if (wiki.config.externalLogging.bugsnag) { // if (wiki.config.externalLogging.bugsnag) {
const bugsnagTransport = require('./winston-transports/bugsnag') // const bugsnagTransport = require('./winston-transports/bugsnag')
logger.add(bugsnagTransport, { // logger.add(bugsnagTransport, {
level: 'warn', // level: 'warn',
key: wiki.config.externalLogging.bugsnag // key: wiki.config.externalLogging.bugsnag
}) // })
} // }
if (wiki.config.externalLogging.loggly) { // if (wiki.config.externalLogging.loggly) {
require('winston-loggly-bulk') // require('winston-loggly-bulk')
logger.add(winston.transports.Loggly, { // logger.add(winston.transports.Loggly, {
token: wiki.config.externalLogging.loggly.token, // token: wiki.config.externalLogging.loggly.token,
subdomain: wiki.config.externalLogging.loggly.subdomain, // subdomain: wiki.config.externalLogging.loggly.subdomain,
tags: ['wiki-js'], // tags: ['wiki-js'],
level: 'warn', // level: 'warn',
json: true // json: true
}) // })
} // }
if (wiki.config.externalLogging.papertrail) { // if (wiki.config.externalLogging.papertrail) {
require('winston-papertrail').Papertrail // eslint-disable-line no-unused-expressions // require('winston-papertrail').Papertrail // eslint-disable-line no-unused-expressions
logger.add(winston.transports.Papertrail, { // logger.add(winston.transports.Papertrail, {
host: wiki.config.externalLogging.papertrail.host, // host: wiki.config.externalLogging.papertrail.host,
port: wiki.config.externalLogging.papertrail.port, // port: wiki.config.externalLogging.papertrail.port,
level: 'warn', // level: 'warn',
program: 'wiki.js' // program: 'wiki.js'
}) // })
} // }
if (wiki.config.externalLogging.rollbar) { // if (wiki.config.externalLogging.rollbar) {
const rollbarTransport = require('./winston-transports/rollbar') // const rollbarTransport = require('./winston-transports/rollbar')
logger.add(rollbarTransport, { // logger.add(rollbarTransport, {
level: 'warn', // level: 'warn',
key: wiki.config.externalLogging.rollbar // key: wiki.config.externalLogging.rollbar
}) // })
} // }
if (wiki.config.externalLogging.sentry) { // if (wiki.config.externalLogging.sentry) {
const sentryTransport = require('./winston-transports/sentry') // const sentryTransport = require('./winston-transports/sentry')
logger.add(sentryTransport, { // logger.add(sentryTransport, {
level: 'warn', // level: 'warn',
key: wiki.config.externalLogging.sentry // key: wiki.config.externalLogging.sentry
}) // })
} // }
return logger return logger
} }
}

6
server/modules/markdown.js
View File

@ -23,7 +23,8 @@ const mdRemove = require('remove-markdown')
var mkdown = md({ var mkdown = md({
html: true, html: true,
breaks: wiki.config.features.linebreaks, // breaks: wiki.config.features.linebreaks,
breaks: true,
linkify: true, linkify: true,
typography: true, typography: true,
highlight(str, lang) { highlight(str, lang) {
@ -57,7 +58,8 @@ var mkdown = md({
}) })
.use(mdAttrs) .use(mdAttrs)
if (wiki.config.features.mathjax) { // if (wiki.config.features.mathjax) {
if (true) {
mkdown.use(mdMathjax) mkdown.use(mdMathjax)
} }

24
server/modules/uploads-agent.js
View File

@ -1,6 +1,6 @@
'use strict' 'use strict'
/* global db, git, lang, upl */ /* global wiki */
const path = require('path') const path = require('path')
const Promise = require('bluebird') const Promise = require('bluebird')
@ -32,8 +32,8 @@ module.exports = {
init () { init () {
let self = this let self = this
self._uploadsPath = path.resolve(ROOTPATH, appconfig.paths.repo, 'uploads') self._uploadsPath = path.resolve(wiki.ROOTPATH, wiki.config.paths.repo, 'uploads')
self._uploadsThumbsPath = path.resolve(ROOTPATH, appconfig.paths.data, 'thumbs') self._uploadsThumbsPath = path.resolve(wiki.ROOTPATH, wiki.config.paths.data, 'thumbs')
return self return self
}, },
@ -59,16 +59,16 @@ module.exports = {
self._watcher.on('add', (p) => { self._watcher.on('add', (p) => {
let pInfo = self.parseUploadsRelPath(p) let pInfo = self.parseUploadsRelPath(p)
return self.processFile(pInfo.folder, pInfo.filename).then((mData) => { return self.processFile(pInfo.folder, pInfo.filename).then((mData) => {
return db.UplFile.findByIdAndUpdate(mData._id, mData, { upsert: true }) return wiki.db.UplFile.findByIdAndUpdate(mData._id, mData, { upsert: true })
}).then(() => { }).then(() => {
return git.commitUploads(lang.t('git:uploaded', { path: p })) return wiki.git.commitUploads(wiki.lang.t('git:uploaded', { path: p }))
}) })
}) })
// -> Remove upload file // -> Remove upload file
self._watcher.on('unlink', (p) => { self._watcher.on('unlink', (p) => {
return git.commitUploads(lang.t('git:deleted', { path: p })) return wiki.git.commitUploads(wiki.lang.t('git:deleted', { path: p }))
}) })
}, },
@ -91,8 +91,8 @@ module.exports = {
// Add folders to DB // Add folders to DB
return db.UplFolder.remove({}).then(() => { return wiki.db.UplFolder.remove({}).then(() => {
return db.UplFolder.insertMany(_.map(folderNames, (f) => { return wiki.db.UplFolder.insertMany(_.map(folderNames, (f) => {
return { return {
_id: 'f:' + f, _id: 'f:' + f,
name: f name: f
@ -107,7 +107,7 @@ module.exports = {
let fldPath = path.join(self._uploadsPath, fldName) let fldPath = path.join(self._uploadsPath, fldName)
return fs.readdirAsync(fldPath).then((fList) => { return fs.readdirAsync(fldPath).then((fList) => {
return Promise.map(fList, (f) => { return Promise.map(fList, (f) => {
return upl.processFile(fldName, f).then((mData) => { return wiki.upl.processFile(fldName, f).then((mData) => {
if (mData) { if (mData) {
allFiles.push(mData) allFiles.push(mData)
} }
@ -118,9 +118,9 @@ module.exports = {
}, {concurrency: 1}).finally(() => { }, {concurrency: 1}).finally(() => {
// Add files to DB // Add files to DB
return db.UplFile.remove({}).then(() => { return wiki.db.UplFile.remove({}).then(() => {
if (_.isArray(allFiles) && allFiles.length > 0) { if (_.isArray(allFiles) && allFiles.length > 0) {
return db.UplFile.insertMany(allFiles) return wiki.db.UplFile.insertMany(allFiles)
} else { } else {
return true return true
} }
@ -131,7 +131,7 @@ module.exports = {
}).then(() => { }).then(() => {
// Watch for new changes // Watch for new changes
return upl.watch() return wiki.upl.watch()
}) })
}, },

65
server/queues/git-sync.js Normal file
View File

@ -0,0 +1,65 @@
'use strict'
/* global wiki */
const Promise = require('bluebird')
const fs = Promise.promisifyAll(require('fs-extra'))
const klaw = require('klaw')
const moment = require('moment')
const path = require('path')
const entryHelper = require('../helpers/entry')
module.exports = (job, done) => {
return wiki.git.resync().then(() => {
// -> Stream all documents
let cacheJobs = []
let jobCbStreamDocsResolve = null
let jobCbStreamDocs = new Promise((resolve, reject) => {
jobCbStreamDocsResolve = resolve
})
klaw(wiki.REPOPATH).on('data', function (item) {
if (path.extname(item.path) === '.md' && path.basename(item.path) !== 'README.md') {
let entryPath = entryHelper.parsePath(entryHelper.getEntryPathFromFullPath(item.path))
let cachePath = entryHelper.getCachePath(entryPath)
// -> Purge outdated cache
cacheJobs.push(
fs.statAsync(cachePath).then((st) => {
return moment(st.mtime).isBefore(item.stats.mtime) ? 'expired' : 'active'
}).catch((err) => {
return (err.code !== 'EEXIST') ? err : 'new'
}).then((fileStatus) => {
// -> Delete expired cache file
if (fileStatus === 'expired') {
return fs.unlinkAsync(cachePath).return(fileStatus)
}
return fileStatus
}).then((fileStatus) => {
// -> Update cache and search index
if (fileStatus !== 'active') {
return global.entries.updateCache(entryPath).then(entry => {
process.send({
action: 'searchAdd',
content: entry
})
return true
})
}
return true
})
)
}
}).on('end', () => {
jobCbStreamDocsResolve(Promise.all(cacheJobs))
})
return jobCbStreamDocs
})
}

26
server/queues/upl-clear-temp.js Normal file
View File

@ -0,0 +1,26 @@
'use strict'
/* global wiki */
const Promise = require('bluebird')
const fs = Promise.promisifyAll(require('fs-extra'))
const moment = require('moment')
const path = require('path')
module.exports = (job, done) => {
return fs.readdirAsync(wiki.UPLTEMPPATH).then((ls) => {
let fifteenAgo = moment().subtract(15, 'minutes')
return Promise.map(ls, (f) => {
return fs.statAsync(path.join(wiki.UPLTEMPPATH, f)).then((s) => { return { filename: f, stat: s } })
}).filter((s) => { return s.stat.isFile() }).then((arrFiles) => {
return Promise.map(arrFiles, (f) => {
if (moment(f.stat.ctime).isBefore(fifteenAgo, 'minute')) {
return fs.unlinkAsync(path.join(wiki.UPLTEMPPATH, f.filename))
} else {
return true
}
})
})
})
}

168
server/worker.js
View File

@ -4,30 +4,27 @@
const path = require('path') const path = require('path')
wiki.REPOPATH = path.resolve(wiki.ROOTPATH, wiki.config.paths.repo)
wiki.DATAPATH = path.resolve(wiki.ROOTPATH, wiki.config.paths.data)
wiki.UPLTEMPPATH = path.join(wiki.DATAPATH, 'temp-upload')
// ---------------------------------------- // ----------------------------------------
// Load global modules // Load global modules
// ---------------------------------------- // ----------------------------------------
wiki.db = require('./modules/db').init() // wiki.upl = require('./modules/uploads-agent').init()
wiki.upl = require('./modules/uploads-agent').init() // wiki.git = require('./modules/git').init()
wiki.git = require('./modules/git').init() // wiki.entries = require('./modules/entries').init()
wiki.entries = require('./modules/entries').init()
wiki.lang = require('i18next') wiki.lang = require('i18next')
wiki.mark = require('./modules/markdown') wiki.mark = require('./modules/markdown')
// ---------------------------------------- // ----------------------------------------
// Load modules // Load local modules
// ---------------------------------------- // ----------------------------------------
const moment = require('moment')
const Promise = require('bluebird') const Promise = require('bluebird')
const fs = Promise.promisifyAll(require('fs-extra'))
const klaw = require('klaw')
const Cron = require('cron').CronJob
const i18nBackend = require('i18next-node-fs-backend') const i18nBackend = require('i18next-node-fs-backend')
const entryHelper = require('./helpers/entry')
// ---------------------------------------- // ----------------------------------------
// Localization Engine // Localization Engine
// ---------------------------------------- // ----------------------------------------
@ -46,143 +43,21 @@ wiki.lang.use(i18nBackend).init({
}) })
// ---------------------------------------- // ----------------------------------------
// Start Cron // Start Queues
// ---------------------------------------- // ----------------------------------------
let job const Bull = require('bull')
let jobIsBusy = false const autoload = require('auto-load')
let jobUplWatchStarted = false
wiki.db.onReady.then(() => { let queues = autoload(path.join(wiki.SERVERPATH, 'queues'))
return wiki.db.Entry.remove({})
}).then(() => {
job = new Cron({
cronTime: '0 */5 * * * *',
onTick: () => {
// Make sure we don't start two concurrent jobs
if (jobIsBusy) { Promise.join(
wiki.logger.warn('Previous job has not completed gracefully or is still running! Skipping for now. (This is not normal, you should investigate)') wiki.db.onReady
return // wiki.upl.initialScan()
).then(() => {
for (let queueName in queues) {
new Bull(queueName, { redis: wiki.config.redis }).process(queues[queueName])
} }
wiki.logger.info('Running all jobs...')
jobIsBusy = true
// Prepare async job collector
let jobs = []
let repoPath = path.resolve(wiki.ROOTPATH, wiki.config.paths.repo)
let dataPath = path.resolve(wiki.ROOTPATH, wiki.config.paths.data)
let uploadsTempPath = path.join(dataPath, 'temp-upload')
// ----------------------------------------
// REGULAR JOBS
// ----------------------------------------
//* ****************************************
// -> Sync with Git remote
//* ****************************************
jobs.push(wiki.git.resync().then(() => {
// -> Stream all documents
let cacheJobs = []
let jobCbStreamDocsResolve = null
let jobCbStreamDocs = new Promise((resolve, reject) => {
jobCbStreamDocsResolve = resolve
})
klaw(repoPath).on('data', function (item) {
if (path.extname(item.path) === '.md' && path.basename(item.path) !== 'README.md') {
let entryPath = entryHelper.parsePath(entryHelper.getEntryPathFromFullPath(item.path))
let cachePath = entryHelper.getCachePath(entryPath)
// -> Purge outdated cache
cacheJobs.push(
fs.statAsync(cachePath).then((st) => {
return moment(st.mtime).isBefore(item.stats.mtime) ? 'expired' : 'active'
}).catch((err) => {
return (err.code !== 'EEXIST') ? err : 'new'
}).then((fileStatus) => {
// -> Delete expired cache file
if (fileStatus === 'expired') {
return fs.unlinkAsync(cachePath).return(fileStatus)
}
return fileStatus
}).then((fileStatus) => {
// -> Update cache and search index
if (fileStatus !== 'active') {
return global.entries.updateCache(entryPath).then(entry => {
process.send({
action: 'searchAdd',
content: entry
})
return true
})
}
return true
})
)
}
}).on('end', () => {
jobCbStreamDocsResolve(Promise.all(cacheJobs))
})
return jobCbStreamDocs
}))
//* ****************************************
// -> Clear failed temporary upload files
//* ****************************************
jobs.push(
fs.readdirAsync(uploadsTempPath).then((ls) => {
let fifteenAgo = moment().subtract(15, 'minutes')
return Promise.map(ls, (f) => {
return fs.statAsync(path.join(uploadsTempPath, f)).then((s) => { return { filename: f, stat: s } })
}).filter((s) => { return s.stat.isFile() }).then((arrFiles) => {
return Promise.map(arrFiles, (f) => {
if (moment(f.stat.ctime).isBefore(fifteenAgo, 'minute')) {
return fs.unlinkAsync(path.join(uploadsTempPath, f.filename))
} else {
return true
}
})
})
})
)
// ----------------------------------------
// Run
// ----------------------------------------
Promise.all(jobs).then(() => {
wiki.logger.info('All jobs completed successfully! Going to sleep for now.')
if (!jobUplWatchStarted) {
jobUplWatchStarted = true
wiki.upl.initialScan().then(() => {
job.start()
})
}
return true
}).catch((err) => {
wiki.logger.error('One or more jobs have failed: ', err)
}).finally(() => {
jobIsBusy = false
})
},
start: false,
timeZone: 'UTC',
runOnInit: true
})
}) })
// ---------------------------------------- // ----------------------------------------
@ -190,11 +65,6 @@ wiki.db.onReady.then(() => {
// ---------------------------------------- // ----------------------------------------
process.on('disconnect', () => { process.on('disconnect', () => {
wiki.logger.warn('Lost connection to main server. Exiting...') wiki.logger.warn('Lost connection to Master. Exiting...')
job.stop()
process.exit() process.exit()
}) })
process.on('exit', () => {
job.stop()
})

2
yarn.lock
View File

@ -1609,7 +1609,7 @@ cron-parser@^2.4.1:
is-nan "^1.2.1" is-nan "^1.2.1"
moment-timezone "^0.5.0" moment-timezone "^0.5.0"
cron@1.2.1, cron@~1.2.1: cron@1.2.1:
version "1.2.1" version "1.2.1"
resolved "https://registry.yarnpkg.com/cron/-/cron-1.2.1.tgz#3a86c09b41b8f261ac863a7cc85ea4735857eab2" resolved "https://registry.yarnpkg.com/cron/-/cron-1.2.1.tgz#3a86c09b41b8f261ac863a7cc85ea4735857eab2"
dependencies: dependencies: