common.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559
  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. ], (req, res, next) => {
  42. res.sendFile(path.join(WIKI.ROOTPATH, 'assets/index.html'))
  43. })
  44. // router.get(['/_admin', '/_admin/*'], (req, res, next) => {
  45. // if (!WIKI.auth.checkAccess(req.user, [
  46. // 'manage:system',
  47. // 'write:users',
  48. // 'manage:users',
  49. // 'write:groups',
  50. // 'manage:groups',
  51. // 'manage:navigation',
  52. // 'manage:theme',
  53. // 'manage:api'
  54. // ])) {
  55. // _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  56. // return res.status(403).render('unauthorized', { action: 'view' })
  57. // }
  58. // _.set(res.locals, 'pageMeta.title', 'Admin')
  59. // res.render('admin')
  60. // })
  61. /**
  62. * Download Page / Version
  63. */
  64. router.get(['/d', '/d/*'], async (req, res, next) => {
  65. const pageArgs = pageHelper.parsePath(req.path, { stripExt: true })
  66. const versionId = (req.query.v) ? _.toSafeInteger(req.query.v) : 0
  67. const page = await WIKI.models.pages.getPageFromDb({
  68. path: pageArgs.path,
  69. locale: pageArgs.locale,
  70. userId: req.user.id,
  71. isPrivate: false
  72. })
  73. pageArgs.tags = _.get(page, 'tags', [])
  74. if (versionId > 0) {
  75. if (!WIKI.auth.checkAccess(req.user, ['read:history'], pageArgs)) {
  76. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  77. return res.render('unauthorized', { action: 'downloadVersion' })
  78. }
  79. } else {
  80. if (!WIKI.auth.checkAccess(req.user, ['read:source'], pageArgs)) {
  81. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  82. return res.render('unauthorized', { action: 'download' })
  83. }
  84. }
  85. if (page) {
  86. const fileName = _.last(page.path.split('/')) + '.' + pageHelper.getFileExtension(page.contentType)
  87. res.attachment(fileName)
  88. if (versionId > 0) {
  89. const pageVersion = await WIKI.models.pageHistory.getVersion({ pageId: page.id, versionId })
  90. res.send(pageHelper.injectPageMetadata(pageVersion))
  91. } else {
  92. res.send(pageHelper.injectPageMetadata(page))
  93. }
  94. } else {
  95. res.status(404).end()
  96. }
  97. })
  98. /**
  99. * Create/Edit document
  100. */
  101. router.get(['/e', '/e/*'], async (req, res, next) => {
  102. const pageArgs = pageHelper.parsePath(req.path, { stripExt: true })
  103. if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  104. return res.redirect(`/e/${pageArgs.locale}/${pageArgs.path}`)
  105. }
  106. req.i18n.changeLanguage(pageArgs.locale)
  107. // -> Set Editor Lang
  108. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  109. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  110. // -> Check for reserved path
  111. if (pageHelper.isReservedPath(pageArgs.path)) {
  112. return next(new Error('Cannot create this page because it starts with a system reserved path.'))
  113. }
  114. // -> Get page data from DB
  115. let page = await WIKI.models.pages.getPageFromDb({
  116. path: pageArgs.path,
  117. locale: pageArgs.locale,
  118. userId: req.user.id,
  119. isPrivate: false
  120. })
  121. pageArgs.tags = _.get(page, 'tags', [])
  122. // -> Effective Permissions
  123. const effectivePermissions = WIKI.auth.getEffectivePermissions(req, pageArgs)
  124. const injectCode = {
  125. css: WIKI.config.theming.injectCSS,
  126. head: WIKI.config.theming.injectHead,
  127. body: WIKI.config.theming.injectBody
  128. }
  129. if (page) {
  130. // -> EDIT MODE
  131. if (!(effectivePermissions.pages.write || effectivePermissions.pages.manage)) {
  132. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  133. return res.render('unauthorized', { action: 'edit' })
  134. }
  135. // -> Get page tags
  136. await page.$relatedQuery('tags')
  137. page.tags = _.map(page.tags, 'tag')
  138. // Handle missing extra field
  139. page.extra = page.extra || { css: '', js: '' }
  140. // -> Beautify Script CSS
  141. if (!_.isEmpty(page.extra.css)) {
  142. page.extra.css = new CleanCSS({ format: 'beautify' }).minify(page.extra.css).styles
  143. }
  144. _.set(res.locals, 'pageMeta.title', `Edit ${page.title}`)
  145. _.set(res.locals, 'pageMeta.description', page.description)
  146. page.mode = 'update'
  147. page.isPublished = (page.isPublished === true || page.isPublished === 1) ? 'true' : 'false'
  148. page.content = Buffer.from(page.content).toString('base64')
  149. } else {
  150. // -> CREATE MODE
  151. if (!effectivePermissions.pages.write) {
  152. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  153. return res.render('unauthorized', { action: 'create' })
  154. }
  155. _.set(res.locals, 'pageMeta.title', `New Page`)
  156. page = {
  157. path: pageArgs.path,
  158. localeCode: pageArgs.locale,
  159. editorKey: null,
  160. mode: 'create',
  161. content: null,
  162. title: null,
  163. description: null,
  164. updatedAt: new Date().toISOString(),
  165. extra: {
  166. css: '',
  167. js: ''
  168. }
  169. }
  170. // -> From Template
  171. if (req.query.from && tmplCreateRegex.test(req.query.from)) {
  172. let tmplPageId = 0
  173. let tmplVersionId = 0
  174. if (req.query.from.indexOf(',')) {
  175. const q = req.query.from.split(',')
  176. tmplPageId = _.toSafeInteger(q[0])
  177. tmplVersionId = _.toSafeInteger(q[1])
  178. } else {
  179. tmplPageId = _.toSafeInteger(req.query.from)
  180. }
  181. if (tmplVersionId > 0) {
  182. // -> From Page Version
  183. const pageVersion = await WIKI.models.pageHistory.getVersion({ pageId: tmplPageId, versionId: tmplVersionId })
  184. if (!pageVersion) {
  185. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  186. return res.status(404).render('notfound', { action: 'template' })
  187. }
  188. if (!WIKI.auth.checkAccess(req.user, ['read:history'], { path: pageVersion.path, locale: pageVersion.locale })) {
  189. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  190. return res.render('unauthorized', { action: 'sourceVersion' })
  191. }
  192. page.content = Buffer.from(pageVersion.content).toString('base64')
  193. page.editorKey = pageVersion.editor
  194. page.title = pageVersion.title
  195. page.description = pageVersion.description
  196. } else {
  197. // -> From Page Live
  198. const pageOriginal = await WIKI.models.pages.query().findById(tmplPageId)
  199. if (!pageOriginal) {
  200. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  201. return res.status(404).render('notfound', { action: 'template' })
  202. }
  203. if (!WIKI.auth.checkAccess(req.user, ['read:source'], { path: pageOriginal.path, locale: pageOriginal.locale })) {
  204. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  205. return res.render('unauthorized', { action: 'source' })
  206. }
  207. page.content = Buffer.from(pageOriginal.content).toString('base64')
  208. page.editorKey = pageOriginal.editorKey
  209. page.title = pageOriginal.title
  210. page.description = pageOriginal.description
  211. }
  212. }
  213. }
  214. res.render('editor', { page, injectCode, effectivePermissions })
  215. })
  216. /**
  217. * History
  218. */
  219. router.get(['/h', '/h/*'], async (req, res, next) => {
  220. const pageArgs = pageHelper.parsePath(req.path, { stripExt: true })
  221. if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  222. return res.redirect(`/h/${pageArgs.locale}/${pageArgs.path}`)
  223. }
  224. req.i18n.changeLanguage(pageArgs.locale)
  225. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  226. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  227. const page = await WIKI.models.pages.getPageFromDb({
  228. path: pageArgs.path,
  229. locale: pageArgs.locale,
  230. userId: req.user.id,
  231. isPrivate: false
  232. })
  233. if (!page) {
  234. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  235. return res.status(404).render('notfound', { action: 'history' })
  236. }
  237. pageArgs.tags = _.get(page, 'tags', [])
  238. const effectivePermissions = WIKI.auth.getEffectivePermissions(req, pageArgs)
  239. if (!effectivePermissions.history.read) {
  240. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  241. return res.render('unauthorized', { action: 'history' })
  242. }
  243. if (page) {
  244. _.set(res.locals, 'pageMeta.title', page.title)
  245. _.set(res.locals, 'pageMeta.description', page.description)
  246. res.render('history', { page, effectivePermissions })
  247. } else {
  248. res.redirect(`/${pageArgs.path}`)
  249. }
  250. })
  251. /**
  252. * Page ID redirection
  253. */
  254. router.get(['/i', '/i/:id'], async (req, res, next) => {
  255. const pageId = _.toSafeInteger(req.params.id)
  256. if (pageId <= 0) {
  257. return res.redirect('/')
  258. }
  259. const page = await WIKI.models.pages.query().column(['path', 'localeCode', 'isPrivate', 'privateNS']).findById(pageId)
  260. if (!page) {
  261. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  262. return res.status(404).render('notfound', { action: 'view' })
  263. }
  264. if (!WIKI.auth.checkAccess(req.user, ['read:pages'], {
  265. locale: page.localeCode,
  266. path: page.path,
  267. private: page.isPrivate,
  268. privateNS: page.privateNS,
  269. explicitLocale: false,
  270. tags: page.tags
  271. })) {
  272. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  273. return res.render('unauthorized', { action: 'view' })
  274. }
  275. if (WIKI.config.lang.namespacing) {
  276. return res.redirect(`/${page.localeCode}/${page.path}`)
  277. } else {
  278. return res.redirect(`/${page.path}`)
  279. }
  280. })
  281. /**
  282. * Source
  283. */
  284. router.get(['/s', '/s/*'], async (req, res, next) => {
  285. const pageArgs = pageHelper.parsePath(req.path, { stripExt: true })
  286. const versionId = (req.query.v) ? _.toSafeInteger(req.query.v) : 0
  287. const page = await WIKI.models.pages.getPageFromDb({
  288. path: pageArgs.path,
  289. locale: pageArgs.locale,
  290. userId: req.user.id,
  291. isPrivate: false
  292. })
  293. pageArgs.tags = _.get(page, 'tags', [])
  294. if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  295. return res.redirect(`/s/${pageArgs.locale}/${pageArgs.path}`)
  296. }
  297. // -> Effective Permissions
  298. const effectivePermissions = WIKI.auth.getEffectivePermissions(req, pageArgs)
  299. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  300. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  301. if (versionId > 0) {
  302. if (!effectivePermissions.history.read) {
  303. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  304. return res.render('unauthorized', { action: 'sourceVersion' })
  305. }
  306. } else {
  307. if (!effectivePermissions.source.read) {
  308. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  309. return res.render('unauthorized', { action: 'source' })
  310. }
  311. }
  312. if (page) {
  313. if (versionId > 0) {
  314. const pageVersion = await WIKI.models.pageHistory.getVersion({ pageId: page.id, versionId })
  315. _.set(res.locals, 'pageMeta.title', pageVersion.title)
  316. _.set(res.locals, 'pageMeta.description', pageVersion.description)
  317. res.render('source', {
  318. page: {
  319. ...page,
  320. ...pageVersion
  321. },
  322. effectivePermissions
  323. })
  324. } else {
  325. _.set(res.locals, 'pageMeta.title', page.title)
  326. _.set(res.locals, 'pageMeta.description', page.description)
  327. res.render('source', { page, effectivePermissions })
  328. }
  329. } else {
  330. res.redirect(`/${pageArgs.path}`)
  331. }
  332. })
  333. /**
  334. * Tags
  335. */
  336. router.get(['/t', '/t/*'], (req, res, next) => {
  337. _.set(res.locals, 'pageMeta.title', 'Tags')
  338. res.render('tags')
  339. })
  340. /**
  341. * User Avatar
  342. */
  343. router.get('/_userav/:uid', async (req, res, next) => {
  344. if (!WIKI.auth.checkAccess(req.user, ['read:pages'])) {
  345. return res.sendStatus(403)
  346. }
  347. const av = await WIKI.models.users.getUserAvatarData(req.params.uid)
  348. if (av) {
  349. res.set('Content-Type', 'image/jpeg')
  350. res.send(av)
  351. }
  352. return res.sendStatus(404)
  353. })
  354. /**
  355. * View document / asset
  356. */
  357. router.get('/*', async (req, res, next) => {
  358. const stripExt = _.some(WIKI.data.pageExtensions, ext => _.endsWith(req.path, `.${ext}`))
  359. const pageArgs = pageHelper.parsePath(req.path, { stripExt })
  360. const isPage = (stripExt || pageArgs.path.indexOf('.') === -1)
  361. if (isPage) {
  362. if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  363. return res.redirect(`/${pageArgs.locale}/${pageArgs.path}`)
  364. }
  365. req.i18n.changeLanguage(pageArgs.locale)
  366. try {
  367. // -> Get Page from cache
  368. const page = await WIKI.models.pages.getPage({
  369. path: pageArgs.path,
  370. locale: pageArgs.locale,
  371. userId: req.user.id,
  372. isPrivate: false
  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 === 2) {
  380. res.cookie('loginRedirect', req.path, {
  381. maxAge: 15 * 60 * 1000
  382. })
  383. }
  384. if (pageArgs.path === 'home' && req.user.id === 2) {
  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. _.set(res.locals, 'pageMeta.title', 'Welcome')
  463. res.render('welcome', { locale: pageArgs.locale })
  464. } else {
  465. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  466. if (effectivePermissions.pages.write) {
  467. res.status(404).render('new', { path: pageArgs.path, locale: pageArgs.locale })
  468. } else {
  469. res.status(404).render('notfound', { action: 'view' })
  470. }
  471. }
  472. } catch (err) {
  473. next(err)
  474. }
  475. } else {
  476. if (!WIKI.auth.checkAccess(req.user, ['read:assets'], pageArgs)) {
  477. return res.sendStatus(403)
  478. }
  479. await WIKI.models.assets.getAsset(pageArgs.path, res)
  480. }
  481. })
  482. module.exports = router