common.js 18 KB

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