common.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537
  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. /* global WIKI */
  7. const tmplCreateRegex = /^[0-9]+(,[0-9]+)?$/
  8. const getPageEffectivePermissions = (req, page) => {
  9. return {
  10. comments: {
  11. read: WIKI.config.features.featurePageComments ? WIKI.auth.checkAccess(req.user, ['read:comments'], page) : false,
  12. write: WIKI.config.features.featurePageComments ? WIKI.auth.checkAccess(req.user, ['write:comments'], page) : false,
  13. manage: WIKI.config.features.featurePageComments ? WIKI.auth.checkAccess(req.user, ['manage:comments'], page) : false
  14. },
  15. history: {
  16. read: WIKI.auth.checkAccess(req.user, ['read:history'], page)
  17. },
  18. source: {
  19. read: WIKI.auth.checkAccess(req.user, ['read:source'], page)
  20. },
  21. pages: {
  22. write: WIKI.auth.checkAccess(req.user, ['write:pages'], page),
  23. manage: WIKI.auth.checkAccess(req.user, ['manage:pages'], page),
  24. delete: WIKI.auth.checkAccess(req.user, ['delete:pages'], page),
  25. script: WIKI.auth.checkAccess(req.user, ['write:scripts'], page),
  26. style: WIKI.auth.checkAccess(req.user, ['write:styles'], page)
  27. },
  28. system: {
  29. manage: WIKI.auth.checkAccess(req.user, ['manage:system'], page)
  30. }
  31. }
  32. }
  33. /**
  34. * Robots.txt
  35. */
  36. router.get('/robots.txt', (req, res, next) => {
  37. res.type('text/plain')
  38. if (_.includes(WIKI.config.seo.robots, 'noindex')) {
  39. res.send('User-agent: *\nDisallow: /')
  40. } else {
  41. res.status(200).end()
  42. }
  43. })
  44. /**
  45. * Health Endpoint
  46. */
  47. router.get('/healthz', (req, res, next) => {
  48. if (WIKI.models.knex.client.pool.numFree() < 1 && WIKI.models.knex.client.pool.numUsed() < 1) {
  49. res.status(503).json({ ok: false }).end()
  50. } else {
  51. res.status(200).json({ ok: true }).end()
  52. }
  53. })
  54. /**
  55. * Administration
  56. */
  57. router.get(['/a', '/a/*'], (req, res, next) => {
  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. // -> Set Editor Lang
  107. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  108. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  109. // -> Check for reserved path
  110. if (pageHelper.isReservedPath(pageArgs.path)) {
  111. return next(new Error('Cannot create this page because it starts with a system reserved path.'))
  112. }
  113. // -> Get page data from DB
  114. let page = await WIKI.models.pages.getPageFromDb({
  115. path: pageArgs.path,
  116. locale: pageArgs.locale,
  117. userId: req.user.id,
  118. isPrivate: false
  119. })
  120. pageArgs.tags = _.get(page, 'tags', [])
  121. const injectCode = {
  122. css: WIKI.config.theming.injectCSS,
  123. head: WIKI.config.theming.injectHead,
  124. body: WIKI.config.theming.injectBody
  125. }
  126. if (page) {
  127. // -> EDIT MODE
  128. if (!WIKI.auth.checkAccess(req.user, ['write:pages', 'manage:pages'], pageArgs)) {
  129. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  130. return res.render('unauthorized', { action: 'edit' })
  131. }
  132. // -> Get page tags
  133. await page.$relatedQuery('tags')
  134. page.tags = _.map(page.tags, 'tag')
  135. // -> Beautify Script CSS
  136. if (!_.isEmpty(page.extra.css)) {
  137. page.extra.css = new CleanCSS({ format: 'beautify' }).minify(page.extra.css).styles
  138. }
  139. _.set(res.locals, 'pageMeta.title', `Edit ${page.title}`)
  140. _.set(res.locals, 'pageMeta.description', page.description)
  141. page.mode = 'update'
  142. page.isPublished = (page.isPublished === true || page.isPublished === 1) ? 'true' : 'false'
  143. page.content = Buffer.from(page.content).toString('base64')
  144. } else {
  145. // -> CREATE MODE
  146. if (!WIKI.auth.checkAccess(req.user, ['write:pages'], pageArgs)) {
  147. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  148. return res.render('unauthorized', { action: 'create' })
  149. }
  150. _.set(res.locals, 'pageMeta.title', `New Page`)
  151. page = {
  152. path: pageArgs.path,
  153. localeCode: pageArgs.locale,
  154. editorKey: null,
  155. mode: 'create',
  156. content: null,
  157. title: null,
  158. description: null,
  159. updatedAt: new Date().toISOString()
  160. }
  161. // -> From Template
  162. if (req.query.from && tmplCreateRegex.test(req.query.from)) {
  163. let tmplPageId = 0
  164. let tmplVersionId = 0
  165. if (req.query.from.indexOf(',')) {
  166. const q = req.query.from.split(',')
  167. tmplPageId = _.toSafeInteger(q[0])
  168. tmplVersionId = _.toSafeInteger(q[1])
  169. } else {
  170. tmplPageId = _.toSafeInteger(req.query.from)
  171. }
  172. if (tmplVersionId > 0) {
  173. // -> From Page Version
  174. const pageVersion = await WIKI.models.pageHistory.getVersion({ pageId: tmplPageId, versionId: tmplVersionId })
  175. if (!pageVersion) {
  176. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  177. return res.status(404).render('notfound', { action: 'template' })
  178. }
  179. if (!WIKI.auth.checkAccess(req.user, ['read:history'], { path: pageVersion.path, locale: pageVersion.locale })) {
  180. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  181. return res.render('unauthorized', { action: 'sourceVersion' })
  182. }
  183. page.content = Buffer.from(pageVersion.content).toString('base64')
  184. page.editorKey = pageVersion.editor
  185. page.title = pageVersion.title
  186. page.description = pageVersion.description
  187. } else {
  188. // -> From Page Live
  189. const pageOriginal = await WIKI.models.pages.query().findById(tmplPageId)
  190. if (!pageOriginal) {
  191. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  192. return res.status(404).render('notfound', { action: 'template' })
  193. }
  194. if (!WIKI.auth.checkAccess(req.user, ['read:source'], { path: pageOriginal.path, locale: pageOriginal.locale })) {
  195. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  196. return res.render('unauthorized', { action: 'source' })
  197. }
  198. page.content = Buffer.from(pageOriginal.content).toString('base64')
  199. page.editorKey = pageOriginal.editorKey
  200. page.title = pageOriginal.title
  201. page.description = pageOriginal.description
  202. }
  203. }
  204. }
  205. // -> Effective Permissions
  206. const effectivePermissions = getPageEffectivePermissions(req, pageArgs)
  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. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  218. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  219. const page = await WIKI.models.pages.getPageFromDb({
  220. path: pageArgs.path,
  221. locale: pageArgs.locale,
  222. userId: req.user.id,
  223. isPrivate: false
  224. })
  225. if (!page) {
  226. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  227. return res.status(404).render('notfound', { action: 'history' })
  228. }
  229. pageArgs.tags = _.get(page, 'tags', [])
  230. if (!WIKI.auth.checkAccess(req.user, ['read:history'], pageArgs)) {
  231. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  232. return res.render('unauthorized', { action: 'history' })
  233. }
  234. if (page) {
  235. _.set(res.locals, 'pageMeta.title', page.title)
  236. _.set(res.locals, 'pageMeta.description', page.description)
  237. // -> Effective Permissions
  238. const effectivePermissions = getPageEffectivePermissions(req, pageArgs)
  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. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  301. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  302. if (versionId > 0) {
  303. if (!WIKI.auth.checkAccess(req.user, ['read:history'], pageArgs)) {
  304. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  305. return res.render('unauthorized', { action: 'sourceVersion' })
  306. }
  307. } else {
  308. if (!WIKI.auth.checkAccess(req.user, ['read:source'], pageArgs)) {
  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. })
  324. } else {
  325. _.set(res.locals, 'pageMeta.title', page.title)
  326. _.set(res.locals, 'pageMeta.description', page.description)
  327. // -> Effective Permissions
  328. const effectivePermissions = getPageEffectivePermissions(req, pageArgs)
  329. res.render('source', { page, effectivePermissions })
  330. }
  331. } else {
  332. res.redirect(`/${pageArgs.path}`)
  333. }
  334. })
  335. /**
  336. * Tags
  337. */
  338. router.get(['/t', '/t/*'], (req, res, next) => {
  339. _.set(res.locals, 'pageMeta.title', 'Tags')
  340. res.render('tags')
  341. })
  342. /**
  343. * View document / asset
  344. */
  345. router.get('/*', async (req, res, next) => {
  346. const stripExt = _.some(WIKI.data.pageExtensions, ext => _.endsWith(req.path, `.${ext}`))
  347. const pageArgs = pageHelper.parsePath(req.path, { stripExt })
  348. const isPage = (stripExt || pageArgs.path.indexOf('.') === -1)
  349. if (isPage) {
  350. if (WIKI.config.lang.namespacing && !pageArgs.explicitLocale) {
  351. return res.redirect(`/${pageArgs.locale}/${pageArgs.path}`)
  352. }
  353. req.i18n.changeLanguage(pageArgs.locale)
  354. try {
  355. // -> Get Page from cache
  356. const page = await WIKI.models.pages.getPage({
  357. path: pageArgs.path,
  358. locale: pageArgs.locale,
  359. userId: req.user.id,
  360. isPrivate: false
  361. })
  362. pageArgs.tags = _.get(page, 'tags', [])
  363. // -> Check User Access
  364. if (!WIKI.auth.checkAccess(req.user, ['read:pages'], pageArgs)) {
  365. if (req.user.id === 2) {
  366. res.cookie('loginRedirect', req.path, {
  367. maxAge: 15 * 60 * 1000
  368. })
  369. }
  370. if (pageArgs.path === 'home' && req.user.id === 2) {
  371. return res.redirect('/login')
  372. }
  373. _.set(res.locals, 'pageMeta.title', 'Unauthorized')
  374. return res.status(403).render('unauthorized', {
  375. action: 'view'
  376. })
  377. }
  378. _.set(res, 'locals.siteConfig.lang', pageArgs.locale)
  379. _.set(res, 'locals.siteConfig.rtl', req.i18n.dir() === 'rtl')
  380. if (page) {
  381. _.set(res.locals, 'pageMeta.title', page.title)
  382. _.set(res.locals, 'pageMeta.description', page.description)
  383. // -> Build sidebar navigation
  384. let sdi = 1
  385. const sidebar = (await WIKI.models.navigation.getTree({ cache: true, locale: pageArgs.locale, groups: req.user.groups })).map(n => ({
  386. i: `sdi-${sdi++}`,
  387. k: n.kind,
  388. l: n.label,
  389. c: n.icon,
  390. y: n.targetType,
  391. t: n.target
  392. }))
  393. // -> Build theme code injection
  394. const injectCode = {
  395. css: WIKI.config.theming.injectCSS,
  396. head: WIKI.config.theming.injectHead,
  397. body: WIKI.config.theming.injectBody
  398. }
  399. if (!_.isEmpty(page.extra.css)) {
  400. injectCode.css = `${injectCode.css}\n${page.extra.css}`
  401. }
  402. if (!_.isEmpty(page.extra.js)) {
  403. injectCode.body = `${injectCode.body}\n${page.extra.js}`
  404. }
  405. if (req.query.legacy || req.get('user-agent').indexOf('Trident') >= 0) {
  406. // -> Convert page TOC
  407. if (_.isString(page.toc)) {
  408. page.toc = JSON.parse(page.toc)
  409. }
  410. // -> Render legacy view
  411. res.render('legacy/page', {
  412. page,
  413. sidebar,
  414. injectCode,
  415. isAuthenticated: req.user && req.user.id !== 2
  416. })
  417. } else {
  418. // -> Convert page TOC
  419. if (!_.isString(page.toc)) {
  420. page.toc = JSON.stringify(page.toc)
  421. }
  422. // -> Inject comments variables
  423. if (WIKI.config.features.featurePageComments && WIKI.data.commentProvider.codeTemplate) {
  424. [
  425. { key: 'pageUrl', value: `${WIKI.config.host}/i/${page.id}` },
  426. { key: 'pageId', value: page.id }
  427. ].forEach((cfg) => {
  428. WIKI.data.commentProvider.head = _.replace(WIKI.data.commentProvider.head, new RegExp(`{{${cfg.key}}}`, 'g'), cfg.value)
  429. WIKI.data.commentProvider.body = _.replace(WIKI.data.commentProvider.body, new RegExp(`{{${cfg.key}}}`, 'g'), cfg.value)
  430. WIKI.data.commentProvider.main = _.replace(WIKI.data.commentProvider.main, new RegExp(`{{${cfg.key}}}`, 'g'), cfg.value)
  431. })
  432. }
  433. // -> Effective Permissions
  434. const effectivePermissions = getPageEffectivePermissions(req, pageArgs)
  435. // -> Render view
  436. res.render('page', {
  437. page,
  438. sidebar,
  439. injectCode,
  440. comments: WIKI.data.commentProvider,
  441. effectivePermissions
  442. })
  443. }
  444. } else if (pageArgs.path === 'home') {
  445. _.set(res.locals, 'pageMeta.title', 'Welcome')
  446. res.render('welcome', { locale: pageArgs.locale })
  447. } else {
  448. _.set(res.locals, 'pageMeta.title', 'Page Not Found')
  449. if (WIKI.auth.checkAccess(req.user, ['write:pages'], pageArgs)) {
  450. res.status(404).render('new', { path: pageArgs.path, locale: pageArgs.locale })
  451. } else {
  452. res.status(404).render('notfound', { action: 'view' })
  453. }
  454. }
  455. } catch (err) {
  456. next(err)
  457. }
  458. } else {
  459. if (!WIKI.auth.checkAccess(req.user, ['read:assets'], pageArgs)) {
  460. return res.sendStatus(403)
  461. }
  462. await WIKI.models.assets.getAsset(pageArgs.path, res)
  463. }
  464. })
  465. module.exports = router