common.js 16 KB

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