1 import * as express from 'express'
2 import { asyncMiddleware } from '../middlewares'
3 import { ROUTE_CACHE_LIFETIME, WEBSERVER } from '../initializers/constants'
4 import * as sitemapModule from 'sitemap'
5 import { VideoModel } from '../models/video/video'
6 import { VideoChannelModel } from '../models/video/video-channel'
7 import { AccountModel } from '../models/account/account'
8 import { cacheRoute } from '../middlewares/cache'
9 import { buildNSFWFilter } from '../helpers/express-utils'
10 import { truncate } from 'lodash'
12 const botsRouter = express.Router()
14 // Special route that add OpenGraph and oEmbed tags
15 // Do not use a template engine for a so little thing
16 botsRouter.use('/sitemap.xml',
17 asyncMiddleware(cacheRoute(ROUTE_CACHE_LIFETIME.SITEMAP)),
18 asyncMiddleware(getSitemap)
21 // ---------------------------------------------------------------------------
27 // ---------------------------------------------------------------------------
29 async function getSitemap (req: express.Request, res: express.Response) {
30 let urls = getSitemapBasicUrls()
32 urls = urls.concat(await getSitemapLocalVideoUrls())
33 urls = urls.concat(await getSitemapVideoChannelUrls())
34 urls = urls.concat(await getSitemapAccountUrls())
36 const sitemap = sitemapModule.createSitemap({
37 hostname: WEBSERVER.URL,
41 const xml = sitemap.toXML()
43 res.header('Content-Type', 'application/xml')
47 async function getSitemapVideoChannelUrls () {
48 const rows = await VideoChannelModel.listLocalsForSitemap('createdAt')
50 return rows.map(channel => ({
51 url: WEBSERVER.URL + '/video-channels/' + channel.Actor.preferredUsername
55 async function getSitemapAccountUrls () {
56 const rows = await AccountModel.listLocalsForSitemap('createdAt')
58 return rows.map(channel => ({
59 url: WEBSERVER.URL + '/accounts/' + channel.Actor.preferredUsername
63 async function getSitemapLocalVideoUrls () {
64 const resultList = await VideoModel.listForApi({
68 includeLocalVideos: true,
69 nsfw: buildNSFWFilter(),
74 return resultList.data.map(v => ({
75 url: WEBSERVER.URL + '/videos/watch/' + v.uuid,
79 // Sitemap description should be < 2000 characters
80 description: truncate(v.description || v.name, { length: 2000, omission: '...' }),
81 player_loc: WEBSERVER.URL + '/videos/embed/' + v.uuid,
82 thumbnail_loc: WEBSERVER.URL + v.getMiniatureStaticPath()
88 function getSitemapBasicUrls () {
94 return paths.map(p => ({ url: WEBSERVER.URL + p }))