common.js 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511
  1. const express = require('express')
  2. const router = express.Router()
  3. const pageHelper = require('../helpers/page')
  4. const _ = require('lodash')
  5. const CleanCSS = require('clean-css')
  6. const moment = require('moment')
  7. const path = require('path')
  8. const tmplCreateRegex = /^[0-9]+(,[0-9]+)?$/
  9. const siteAssetsPath = path.resolve(WIKI.ROOTPATH, WIKI.config.dataPath, 'assets')
  10. /**
  11. * Robots.txt
  12. */
  13. router.get('/robots.txt', (req, res, next) => {
  14. res.type('text/plain')
  15. if (_.includes(WIKI.config.seo.robots, 'noindex')) {
  16. res.send('User-agent: *\nDisallow: /')
  17. } else {
  18. res.status(200).end()
  19. }
  20. })
  21. /**
  22. * Health Endpoint
  23. */
  24. router.get('/healthz', (req, res, next) => {
  25. if (WIKI.db.knex.client.pool.numFree() < 1 && WIKI.db.knex.client.pool.numUsed() < 1) {
  26. res.status(503).json({ ok: false }).end()
  27. } else {
  28. res.status(200).json({ ok: true }).end()
  29. }
  30. })
  31. /**
  32. * Site Asset
  33. */
  34. router.get('/_site/:siteId?/:resource', async (req, res, next) => {
  35. const site = req.params.siteId ? WIKI.sites[req.params.siteId] : await WIKI.db.sites.getSiteByHostname({ hostname: req.hostname })
  36. if (!site) {
  37. return res.status(404).send('Site Not Found')
  38. }
  39. switch (req.params.resource) {
  40. case 'logo': {
  41. if (site.config.assets.logo) {
  42. // TODO: Fetch from db if not in disk cache
  43. res.sendFile(path.join(siteAssetsPath, `logo-${site.id}.${site.config.assets.logoExt}`))
  44. } else {
  45. res.sendFile(path.join(WIKI.ROOTPATH, 'assets/_assets/logo-wikijs.svg'))
  46. }
  47. break
  48. }
  49. case 'favicon': {
  50. if (site.config.assets.favicon) {
  51. // TODO: Fetch from db if not in disk cache
  52. res.sendFile(path.join(siteAssetsPath, `favicon-${site.id}.${site.config.assets.faviconExt}`))
  53. } else {
  54. res.sendFile(path.join(WIKI.ROOTPATH, 'assets/_assets/logo-wikijs.svg'))
  55. }
  56. break
  57. }
  58. case 'loginbg': {
  59. if (site.config.assets.loginBg) {
  60. // TODO: Fetch from db if not in disk cache
  61. res.sendFile(path.join(siteAssetsPath, `loginbg-${site.id}.jpg`))
  62. } else {
  63. res.sendFile(path.join(WIKI.ROOTPATH, 'assets/_assets/bg/login.jpg'))
  64. }
  65. break
  66. }
  67. default: {
  68. return res.status(404).send('Invalid Site Resource')
  69. }
  70. }
  71. })
  72. /**
  73. * New v3 vue app
  74. */
  75. router.get([
  76. '/_admin',
  77. '/_admin/*',
  78. '/_profile',
  79. '/_profile/*',
  80. '/_error',
  81. '/_error/*',
  82. '/_welcome'
  83. ], (req, res, next) => {
  84. res.sendFile(path.join(WIKI.ROOTPATH, 'assets/index.html'))
  85. })
  86. // router.get(['/_admin', '/_admin/*'], (req, res, next) => {
  87. // if (!WIKI.auth.checkAccess(req.user, [
  88. // 'manage:system',
  89. // 'write:users',
  90. // 'manage:users',
  91. // 'write:groups',
  92. // 'manage:groups',
  93. // 'manage:navigation',
  94. // 'manage:theme',
  95. // 'manage:api'
  96. // ])) {
  97. // _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  98. // return res.status(403).render('unauthorized', { action: 'view' })
  99. // }
  100. // _.set(res.locals, 'pageMeta.title', 'Admin')
  101. // res.render('admin')
  102. // })
  103. /**
  104. * Download Page / Version
  105. */
  106. router.get(['/d', '/d/*'], async (req, res, next) => {
  107. const pageArgs = pageHelper.parsePath(req.path, { stripExt: true })
  108. const versionId = (req.query.v) ? _.toSafeInteger(req.query.v) : 0
  109. const page = await WIKI.db.pages.getPageFromDb({
  110. path: pageArgs.path,
  111. locale: pageArgs.locale,
  112. userId: req.user.id,
  113. isPrivate: false
  114. })
  115. pageArgs.tags = _.get(page, 'tags', [])
  116. if (versionId > 0) {
  117. if (!WIKI.auth.checkAccess(req.user, ['read:history'], pageArgs)) {
  118. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  119. return res.render('unauthorized', { action: 'downloadVersion' })
  120. }
  121. } else {
  122. if (!WIKI.auth.checkAccess(req.user, ['read:source'], pageArgs)) {
  123. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  124. return res.render('unauthorized', { action: 'download' })
  125. }
  126. }
  127. if (page) {
  128. const fileName = _.last(page.path.split('/')) + '.' + pageHelper.getFileExtension(page.contentType)
  129. res.attachment(fileName)
  130. if (versionId > 0) {
  131. const pageVersion = await WIKI.db.pageHistory.getVersion({ pageId: page.id, versionId })
  132. res.send(pageHelper.injectPageMetadata(pageVersion))
  133. } else {
  134. res.send(pageHelper.injectPageMetadata(page))
  135. }
  136. } else {
  137. res.status(404).end()
  138. }
  139. })
  140. /**
  141. * Create/Edit document
  142. */
  143. router.get(['/_edit', '/_edit/*'], async (req, res, next) => {
  144. const pageArgs = pageHelper.parsePath(req.path, { stripExt: true })
  145. const site = await WIKI.db.sites.getSiteByHostname({ hostname: req.hostname })
  146. if (!site) {
  147. throw new Error('INVALID_SITE')
  148. }
  149. if (pageArgs.path === '') {
  150. return res.redirect(`/_edit/home`)
  151. }
  152. // if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  153. // return res.redirect(`/_edit/${pageArgs.locale}/${pageArgs.path}`)
  154. // }
  155. // req.i18n.changeLanguage(pageArgs.locale)
  156. // -> Set Editor Lang
  157. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  158. // _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  159. // -> Check for reserved path
  160. if (pageHelper.isReservedPath(pageArgs.path)) {
  161. return next(new Error('Cannot create this page because it starts with a system reserved path.'))
  162. }
  163. // -> Get page data from DB
  164. let page = await WIKI.db.pages.getPageFromDb({
  165. siteId: site.id,
  166. path: pageArgs.path,
  167. locale: pageArgs.locale,
  168. userId: req.user.id
  169. })
  170. pageArgs.tags = _.get(page, 'tags', [])
  171. // -> Effective Permissions
  172. const effectivePermissions = WIKI.auth.getEffectivePermissions(req, pageArgs)
  173. const injectCode = {
  174. css: '', // WIKI.config.theming.injectCSS,
  175. head: '', // WIKI.config.theming.injectHead,
  176. body: '' // WIKI.config.theming.injectBody
  177. }
  178. if (page) {
  179. // -> EDIT MODE
  180. if (!(effectivePermissions.pages.write || effectivePermissions.pages.manage)) {
  181. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  182. return res.render('unauthorized', { action: 'edit' })
  183. }
  184. // -> Get page tags
  185. await page.$relatedQuery('tags')
  186. page.tags = _.map(page.tags, 'tag')
  187. // Handle missing extra field
  188. page.extra = page.extra || { css: '', js: '' }
  189. // -> Beautify Script CSS
  190. if (!_.isEmpty(page.extra.css)) {
  191. page.extra.css = new CleanCSS({ format: 'beautify' }).minify(page.extra.css).styles
  192. }
  193. _.set(res.locals, 'pageMeta.title', `Edit ${page.title}`)
  194. _.set(res.locals, 'pageMeta.description', page.description)
  195. page.mode = 'update'
  196. page.isPublished = (page.isPublished === true || page.isPublished === 1) ? 'true' : 'false'
  197. page.content = Buffer.from(page.content).toString('base64')
  198. } else {
  199. // -> CREATE MODE
  200. if (!effectivePermissions.pages.write) {
  201. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  202. return res.render('unauthorized', { action: 'create' })
  203. }
  204. _.set(res.locals, 'pageMeta.title', `New Page`)
  205. page = {
  206. path: pageArgs.path,
  207. localeCode: pageArgs.locale,
  208. editorKey: null,
  209. mode: 'create',
  210. content: null,
  211. title: null,
  212. description: null,
  213. updatedAt: new Date().toISOString(),
  214. extra: {
  215. css: '',
  216. js: ''
  217. }
  218. }
  219. }
  220. res.render('editor', { page, injectCode, effectivePermissions })
  221. })
  222. /**
  223. * History
  224. */
  225. router.get(['/h', '/h/*'], async (req, res, next) => {
  226. const pageArgs = pageHelper.parsePath(req.path, { stripExt: true })
  227. if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  228. return res.redirect(`/h/${pageArgs.locale}/${pageArgs.path}`)
  229. }
  230. req.i18n.changeLanguage(pageArgs.locale)
  231. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  232. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  233. const page = await WIKI.db.pages.getPageFromDb({
  234. path: pageArgs.path,
  235. locale: pageArgs.locale,
  236. userId: req.user.id,
  237. isPrivate: false
  238. })
  239. if (!page) {
  240. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  241. return res.status(404).render('notfound', { action: 'history' })
  242. }
  243. pageArgs.tags = _.get(page, 'tags', [])
  244. const effectivePermissions = WIKI.auth.getEffectivePermissions(req, pageArgs)
  245. if (!effectivePermissions.history.read) {
  246. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  247. return res.render('unauthorized', { action: 'history' })
  248. }
  249. if (page) {
  250. _.set(res.locals, 'pageMeta.title', page.title)
  251. _.set(res.locals, 'pageMeta.description', page.description)
  252. res.render('history', { page, effectivePermissions })
  253. } else {
  254. res.redirect(`/${pageArgs.path}`)
  255. }
  256. })
  257. /**
  258. * Page ID redirection
  259. */
  260. router.get(['/i', '/i/:id'], async (req, res, next) => {
  261. const pageId = _.toSafeInteger(req.params.id)
  262. if (pageId <= 0) {
  263. return res.redirect('/')
  264. }
  265. const page = await WIKI.db.pages.query().column(['path', 'localeCode', 'isPrivate', 'privateNS']).findById(pageId)
  266. if (!page) {
  267. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  268. return res.status(404).render('notfound', { action: 'view' })
  269. }
  270. if (!WIKI.auth.checkAccess(req.user, ['read:pages'], {
  271. locale: page.localeCode,
  272. path: page.path,
  273. private: page.isPrivate,
  274. privateNS: page.privateNS,
  275. explicitLocale: false,
  276. tags: page.tags
  277. })) {
  278. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  279. return res.render('unauthorized', { action: 'view' })
  280. }
  281. if (WIKI.config.lang.namespacing) {
  282. return res.redirect(`/${page.localeCode}/${page.path}`)
  283. } else {
  284. return res.redirect(`/${page.path}`)
  285. }
  286. })
  287. /**
  288. * Source
  289. */
  290. router.get(['/s', '/s/*'], async (req, res, next) => {
  291. const pageArgs = pageHelper.parsePath(req.path, { stripExt: true })
  292. const versionId = (req.query.v) ? _.toSafeInteger(req.query.v) : 0
  293. const page = await WIKI.db.pages.getPageFromDb({
  294. path: pageArgs.path,
  295. locale: pageArgs.locale,
  296. userId: req.user.id,
  297. isPrivate: false
  298. })
  299. pageArgs.tags = _.get(page, 'tags', [])
  300. if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  301. return res.redirect(`/s/${pageArgs.locale}/${pageArgs.path}`)
  302. }
  303. // -> Effective Permissions
  304. const effectivePermissions = WIKI.auth.getEffectivePermissions(req, pageArgs)
  305. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  306. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  307. if (versionId > 0) {
  308. if (!effectivePermissions.history.read) {
  309. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  310. return res.render('unauthorized', { action: 'sourceVersion' })
  311. }
  312. } else {
  313. if (!effectivePermissions.source.read) {
  314. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  315. return res.render('unauthorized', { action: 'source' })
  316. }
  317. }
  318. if (page) {
  319. if (versionId > 0) {
  320. const pageVersion = await WIKI.db.pageHistory.getVersion({ pageId: page.id, versionId })
  321. _.set(res.locals, 'pageMeta.title', pageVersion.title)
  322. _.set(res.locals, 'pageMeta.description', pageVersion.description)
  323. res.render('source', {
  324. page: {
  325. ...page,
  326. ...pageVersion
  327. },
  328. effectivePermissions
  329. })
  330. } else {
  331. _.set(res.locals, 'pageMeta.title', page.title)
  332. _.set(res.locals, 'pageMeta.description', page.description)
  333. res.render('source', { page, effectivePermissions })
  334. }
  335. } else {
  336. res.redirect(`/${pageArgs.path}`)
  337. }
  338. })
  339. /**
  340. * Tags
  341. */
  342. router.get(['/t', '/t/*'], (req, res, next) => {
  343. _.set(res.locals, 'pageMeta.title', 'Tags')
  344. res.render('tags')
  345. })
  346. /**
  347. * User Avatar
  348. */
  349. router.get('/_user/:uid/avatar', async (req, res, next) => {
  350. if (!WIKI.auth.checkAccess(req.user, ['read:pages'])) {
  351. return res.sendStatus(403)
  352. }
  353. const av = await WIKI.db.users.getUserAvatarData(req.params.uid)
  354. if (av) {
  355. res.set('Content-Type', 'image/jpeg')
  356. return res.send(av)
  357. }
  358. return res.sendStatus(404)
  359. })
  360. /**
  361. * View document / asset
  362. */
  363. router.get('/*', async (req, res, next) => {
  364. const stripExt = _.some(WIKI.data.pageExtensions, ext => _.endsWith(req.path, `.${ext}`))
  365. const pageArgs = pageHelper.parsePath(req.path, { stripExt })
  366. const isPage = (stripExt || pageArgs.path.indexOf('.') === -1)
  367. const site = await WIKI.db.sites.getSiteByHostname({ hostname: req.hostname })
  368. if (!site) {
  369. throw new Error('INVALID_SITE')
  370. }
  371. if (isPage) {
  372. // if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  373. // return res.redirect(`/${pageArgs.locale}/${pageArgs.path}`)
  374. // }
  375. // req.i18n.changeLanguage(pageArgs.locale)
  376. try {
  377. // -> Get Page from cache
  378. const page = await WIKI.db.pages.getPage({
  379. siteId: site.id,
  380. path: pageArgs.path,
  381. locale: pageArgs.locale,
  382. userId: req.user.id
  383. })
  384. pageArgs.tags = _.get(page, 'tags', [])
  385. // -> Effective Permissions
  386. const effectivePermissions = WIKI.auth.getEffectivePermissions(req, pageArgs)
  387. // -> Check User Access
  388. if (!effectivePermissions.pages.read) {
  389. if (req.user.id === WIKI.auth.guest.id) {
  390. res.cookie('loginRedirect', req.path, {
  391. maxAge: 15 * 60 * 1000
  392. })
  393. }
  394. if (pageArgs.path === 'home' && req.user.id === WIKI.auth.guest.id) {
  395. return res.redirect('/login')
  396. }
  397. return res.redirect(`/_error/unauthorized?from=${req.path}`)
  398. }
  399. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  400. // _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  401. if (page) {
  402. _.set(res.locals, 'pageMeta.title', page.title)
  403. _.set(res.locals, 'pageMeta.description', page.description)
  404. // -> Check Publishing State
  405. let pageIsPublished = page.isPublished
  406. if (pageIsPublished && !_.isEmpty(page.publishStartDate)) {
  407. pageIsPublished = moment(page.publishStartDate).isSameOrBefore()
  408. }
  409. if (pageIsPublished && !_.isEmpty(page.publishEndDate)) {
  410. pageIsPublished = moment(page.publishEndDate).isSameOrAfter()
  411. }
  412. if (!pageIsPublished && !effectivePermissions.pages.write) {
  413. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  414. return res.status(403).render('unauthorized', {
  415. action: 'view'
  416. })
  417. }
  418. // -> Render view
  419. res.sendFile(path.join(WIKI.ROOTPATH, 'assets/index.html'))
  420. } else if (pageArgs.path === 'home') {
  421. res.redirect('/_welcome')
  422. } else {
  423. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  424. if (effectivePermissions.pages.write) {
  425. res.status(404).render('new', { path: pageArgs.path, locale: pageArgs.locale })
  426. } else {
  427. res.status(404).render('notfound', { action: 'view' })
  428. }
  429. }
  430. } catch (err) {
  431. next(err)
  432. }
  433. } else {
  434. if (!WIKI.auth.checkAccess(req.user, ['read:assets'], pageArgs)) {
  435. return res.sendStatus(403)
  436. }
  437. await WIKI.db.assets.getAsset(pageArgs.path, res)
  438. }
  439. })
  440. module.exports = router