PeerTube/server/core/controllers/sitemap.ts

116 lines
3.4 KiB
TypeScript
Raw Normal View History

2021-08-27 14:32:44 +02:00
import express from 'express'
import truncate from 'lodash-es/truncate.js'
import { ErrorLevel, SitemapStream, streamToPromise } from 'sitemap'
import { logger } from '@server/helpers/logger.js'
import { getServerActor } from '@server/models/application/application.js'
import { buildNSFWFilter } from '../helpers/express-utils.js'
import { ROUTE_CACHE_LIFETIME, WEBSERVER } from '../initializers/constants.js'
import { apiRateLimiter, asyncMiddleware } from '../middlewares/index.js'
import { cacheRoute } from '../middlewares/cache/cache.js'
import { AccountModel } from '../models/account/account.js'
import { VideoModel } from '../models/video/video.js'
import { VideoChannelModel } from '../models/video/video-channel.js'
2018-12-05 17:27:24 +01:00
2023-07-25 15:18:10 +02:00
const sitemapRouter = express.Router()
2018-12-05 17:27:24 +01:00
2023-07-25 15:18:10 +02:00
sitemapRouter.use('/sitemap.xml',
apiRateLimiter,
cacheRoute(ROUTE_CACHE_LIFETIME.SITEMAP),
2018-12-05 17:27:24 +01:00
asyncMiddleware(getSitemap)
)
// ---------------------------------------------------------------------------
export {
2023-07-25 15:18:10 +02:00
sitemapRouter
2018-12-05 17:27:24 +01:00
}
// ---------------------------------------------------------------------------
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())
2022-09-27 16:19:36 +02:00
const sitemapStream = new SitemapStream({
hostname: WEBSERVER.URL,
errorHandler: (err: Error, level: ErrorLevel) => {
if (level === 'warn') {
logger.warn('Warning in sitemap generation.', { err })
} else if (level === 'throw') {
logger.error('Error in sitemap generation.', { err })
throw err
}
}
})
2018-12-05 17:27:24 +01:00
2020-04-01 17:02:52 +02:00
for (const urlObj of urls) {
sitemapStream.write(urlObj)
2020-04-01 14:16:19 +02:00
}
sitemapStream.end()
const xml = await streamToPromise(sitemapStream)
2018-12-05 17:27:24 +01:00
2019-10-21 14:50:55 +02:00
res.header('Content-Type', 'application/xml')
res.send(xml)
2018-12-05 17:27:24 +01:00
}
async function getSitemapVideoChannelUrls () {
const rows = await VideoChannelModel.listLocalsForSitemap('createdAt')
return rows.map(channel => ({
2019-04-11 11:33:44 +02:00
url: WEBSERVER.URL + '/video-channels/' + channel.Actor.preferredUsername
2018-12-05 17:27:24 +01:00
}))
}
async function getSitemapAccountUrls () {
const rows = await AccountModel.listLocalsForSitemap('createdAt')
return rows.map(channel => ({
2019-04-11 11:33:44 +02:00
url: WEBSERVER.URL + '/accounts/' + channel.Actor.preferredUsername
2018-12-05 17:27:24 +01:00
}))
}
async function getSitemapLocalVideoUrls () {
const serverActor = await getServerActor()
2020-01-08 14:15:16 +01:00
const { data } = await VideoModel.listForApi({
2018-12-05 17:27:24 +01:00
start: 0,
count: undefined,
sort: 'createdAt',
displayOnlyForFollower: {
actorId: serverActor.id,
orLocalVideos: true
},
isLocal: true,
2018-12-05 17:27:24 +01:00
nsfw: buildNSFWFilter(),
2020-01-08 14:15:16 +01:00
countVideos: false
2018-12-05 17:27:24 +01:00
})
2020-01-08 14:15:16 +01:00
return data.map(v => ({
2021-07-26 15:04:37 +02:00
url: WEBSERVER.URL + v.getWatchStaticPath(),
2018-12-05 17:27:24 +01:00
video: [
{
2022-09-27 16:19:36 +02:00
// Sitemap title should be < 100 characters
title: truncate(v.name, { length: 100, omission: '...' }),
2018-12-05 17:27:24 +01:00
// Sitemap description should be < 2000 characters
description: truncate(v.description || v.name, { length: 2000, omission: '...' }),
2021-07-26 15:04:37 +02:00
player_loc: WEBSERVER.URL + v.getEmbedStaticPath(),
2019-04-23 09:50:57 +02:00
thumbnail_loc: WEBSERVER.URL + v.getMiniatureStaticPath()
2018-12-05 17:27:24 +01:00
}
]
}))
}
function getSitemapBasicUrls () {
const paths = [
'/about/instance',
'/videos/local'
]
2019-04-11 11:33:44 +02:00
return paths.map(p => ({ url: WEBSERVER.URL + p }))
2018-12-05 17:27:24 +01:00
}