2
0

common.js 17 KB

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