import * as express from 'express'
import { asyncMiddleware } from '../middlewares'
import { ROUTE_CACHE_LIFETIME, WEBSERVER } from '../initializers/constants'
import { SitemapStream, streamToPromise } from 'sitemap'
import { VideoModel } from '../models/video/video'
import { VideoChannelModel } from '../models/video/video-channel'
import { AccountModel } from '../models/account/account'
import { cacheRoute } from '../middlewares/cache/cache'
import { buildNSFWFilter } from '../helpers/express-utils'
import { truncate } from 'lodash'
const botsRouter = express.Router()
// Special route that add OpenGraph and oEmbed tags
// Do not use a template engine for a so little thing
botsRouter.use('/sitemap.xml',
cacheRoute(ROUTE_CACHE_LIFETIME.SITEMAP),
asyncMiddleware(getSitemap)
)
// ---------------------------------------------------------------------------
export {
botsRouter
}
// ---------------------------------------------------------------------------
async function getSitemap (req: express.Request, res: express.Response) {
let urls = getSitemapBasicUrls()
urls = urls.concat(await getSitemapLocalVideoUrls())
urls = urls.concat(await getSitemapVideoChannelUrls())
urls = urls.concat(await getSitemapAccountUrls())
const sitemapStream = new SitemapStream({ hostname: WEBSERVER.URL })
for (const urlObj of urls) {
sitemapStream.write(urlObj)
}
sitemapStream.end()
const xml = await streamToPromise(sitemapStream)
res.header('Content-Type', 'application/xml')
res.send(xml)
}
async function getSitemapVideoChannelUrls () {
const rows = await VideoChannelModel.listLocalsForSitemap('createdAt')
return rows.map(channel => ({
url: WEBSERVER.URL + '/video-channels/' + channel.Actor.preferredUsername
}))
}
async function getSitemapAccountUrls () {
const rows = await AccountModel.listLocalsForSitemap('createdAt')
return rows.map(channel => ({
url: WEBSERVER.URL + '/accounts/' + channel.Actor.preferredUsername
}))
}
async function getSitemapLocalVideoUrls () {
const { data } = await VideoModel.listForApi({
start: 0,
count: undefined,
sort: 'createdAt',
includeLocalVideos: true,
nsfw: buildNSFWFilter(),
filter: 'local',
withFiles: false,
countVideos: false
})
return data.map(v => ({
url: WEBSERVER.URL + '/w/' + v.uuid,
video: [
{
title: v.name,
// Sitemap description should be < 2000 characters
description: truncate(v.description || v.name, { length: 2000, omission: '...' }),
player_loc: WEBSERVER.URL + '/videos/embed/' + v.uuid,
thumbnail_loc: WEBSERVER.URL + v.getMiniatureStaticPath()
}
]
}))
}
function getSitemapBasicUrls () {
const paths = [
'/about/instance',
'/videos/local'
]
return paths.map(p => ({ url: WEBSERVER.URL + p }))
}