common.js 18 KB

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