2
0

common.js 17 KB

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