2021-08-27 14:32:44 +02:00
|
|
|
import express from 'express'
|
2023-05-10 09:54:44 +02:00
|
|
|
import { pathExists, readFile } from 'fs-extra'
|
2020-12-08 14:30:29 +01:00
|
|
|
import { join } from 'path'
|
|
|
|
import validator from 'validator'
|
2022-07-06 15:44:14 +02:00
|
|
|
import { isTestOrDevInstance } from '@server/helpers/core-utils'
|
2021-11-30 08:31:56 +01:00
|
|
|
import { toCompleteUUID } from '@server/helpers/custom-validators/misc'
|
2022-03-08 11:34:15 +01:00
|
|
|
import { mdToOneLinePlainText } from '@server/helpers/markdown'
|
2022-02-28 08:34:43 +01:00
|
|
|
import { ActorImageModel } from '@server/models/actor/actor-image'
|
2022-01-03 17:13:11 +01:00
|
|
|
import { root } from '@shared/core-utils'
|
2021-05-14 12:04:44 +02:00
|
|
|
import { escapeHTML } from '@shared/core-utils/renderer'
|
2021-12-17 13:58:07 +01:00
|
|
|
import { sha256 } from '@shared/extra-utils'
|
2021-05-14 12:04:44 +02:00
|
|
|
import { HTMLServerConfig } from '@shared/models'
|
2020-08-06 14:58:01 +02:00
|
|
|
import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/core-utils/i18n/i18n'
|
2021-07-16 10:42:24 +02:00
|
|
|
import { HttpStatusCode } from '../../shared/models/http/http-error-codes'
|
2020-12-08 14:30:29 +01:00
|
|
|
import { VideoPlaylistPrivacy, VideoPrivacy } from '../../shared/models/videos'
|
|
|
|
import { logger } from '../helpers/logger'
|
|
|
|
import { CONFIG } from '../initializers/config'
|
2020-07-31 11:29:15 +02:00
|
|
|
import {
|
2020-12-08 14:30:29 +01:00
|
|
|
ACCEPT_HEADERS,
|
2020-07-31 11:29:15 +02:00
|
|
|
CUSTOM_HTML_TAG_COMMENTS,
|
|
|
|
EMBED_SIZE,
|
2020-12-08 21:16:10 +01:00
|
|
|
FILES_CONTENT_HASH,
|
2020-12-08 14:30:29 +01:00
|
|
|
PLUGIN_GLOBAL_CSS_PATH,
|
|
|
|
WEBSERVER
|
2020-07-31 11:29:15 +02:00
|
|
|
} from '../initializers/constants'
|
2019-02-21 14:06:10 +01:00
|
|
|
import { AccountModel } from '../models/account/account'
|
2020-12-08 14:30:29 +01:00
|
|
|
import { VideoModel } from '../models/video/video'
|
2019-02-21 14:06:10 +01:00
|
|
|
import { VideoChannelModel } from '../models/video/video-channel'
|
2020-12-08 14:30:29 +01:00
|
|
|
import { VideoPlaylistModel } from '../models/video/video-playlist'
|
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 16:00:05 +02:00
|
|
|
import { MAccountHost, MChannelHost, MVideo, MVideoPlaylist } from '../types/models'
|
2022-03-24 13:36:47 +01:00
|
|
|
import { getActivityStreamDuration } from './activitypub/activity'
|
2022-02-28 08:34:43 +01:00
|
|
|
import { getBiggestActorImage } from './actor-image'
|
2023-03-24 18:37:55 +01:00
|
|
|
import { Hooks } from './plugins/hooks'
|
2021-05-27 15:59:55 +02:00
|
|
|
import { ServerConfigManager } from './server-config-manager'
|
2023-06-29 09:48:55 +02:00
|
|
|
import { isVideoInPrivateDirectory } from './video-privacy'
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2020-08-05 15:35:58 +02:00
|
|
|
type Tags = {
|
|
|
|
ogType: string
|
2020-08-07 14:53:01 +02:00
|
|
|
twitterCard: 'player' | 'summary' | 'summary_large_image'
|
2020-08-05 15:35:58 +02:00
|
|
|
schemaType: string
|
|
|
|
|
|
|
|
list?: {
|
|
|
|
numberOfItems: number
|
|
|
|
}
|
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
escapedSiteName: string
|
|
|
|
escapedTitle: string
|
|
|
|
escapedDescription: string
|
|
|
|
|
2020-08-05 15:35:58 +02:00
|
|
|
url: string
|
2020-12-06 18:47:49 +01:00
|
|
|
originUrl: string
|
2020-08-05 15:35:58 +02:00
|
|
|
|
2021-08-05 13:29:10 +02:00
|
|
|
disallowIndexation?: boolean
|
|
|
|
|
2020-08-05 15:35:58 +02:00
|
|
|
embed?: {
|
|
|
|
url: string
|
|
|
|
createdAt: string
|
|
|
|
duration?: string
|
|
|
|
views?: number
|
|
|
|
}
|
|
|
|
|
|
|
|
image: {
|
|
|
|
url: string
|
|
|
|
width?: number
|
|
|
|
height?: number
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2023-03-24 18:37:55 +01:00
|
|
|
type HookContext = {
|
|
|
|
video?: MVideo
|
|
|
|
playlist?: MVideoPlaylist
|
|
|
|
}
|
|
|
|
|
2020-12-08 21:16:10 +01:00
|
|
|
class ClientHtml {
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2020-01-31 16:56:52 +01:00
|
|
|
private static htmlCache: { [path: string]: string } = {}
|
2018-07-18 09:52:46 +02:00
|
|
|
|
|
|
|
static invalidCache () {
|
2019-07-23 10:40:39 +02:00
|
|
|
logger.info('Cleaning HTML cache.')
|
|
|
|
|
2018-07-18 09:52:46 +02:00
|
|
|
ClientHtml.htmlCache = {}
|
|
|
|
}
|
|
|
|
|
2018-12-14 15:49:36 +01:00
|
|
|
static async getDefaultHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
|
2020-01-10 19:50:48 +01:00
|
|
|
const html = paramLang
|
|
|
|
? await ClientHtml.getIndexHTML(req, res, paramLang)
|
|
|
|
: await ClientHtml.getIndexHTML(req, res)
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2018-12-14 15:49:36 +01:00
|
|
|
let customHtml = ClientHtml.addTitleTag(html)
|
|
|
|
customHtml = ClientHtml.addDescriptionTag(customHtml)
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2018-12-14 15:49:36 +01:00
|
|
|
return customHtml
|
2018-07-18 09:52:46 +02:00
|
|
|
}
|
|
|
|
|
2021-06-28 17:30:59 +02:00
|
|
|
static async getWatchHTMLPage (videoIdArg: string, req: express.Request, res: express.Response) {
|
|
|
|
const videoId = toCompleteUUID(videoIdArg)
|
|
|
|
|
2018-07-18 09:52:46 +02:00
|
|
|
// Let Angular application handle errors
|
2019-02-21 14:06:10 +01:00
|
|
|
if (!validator.isInt(videoId) && !validator.isUUID(videoId, 4)) {
|
2020-12-07 14:32:36 +01:00
|
|
|
res.status(HttpStatusCode.NOT_FOUND_404)
|
2018-07-18 09:52:46 +02:00
|
|
|
return ClientHtml.getIndexHTML(req, res)
|
|
|
|
}
|
|
|
|
|
|
|
|
const [ html, video ] = await Promise.all([
|
|
|
|
ClientHtml.getIndexHTML(req, res),
|
2019-08-22 10:46:54 +02:00
|
|
|
VideoModel.loadWithBlacklist(videoId)
|
2018-07-18 09:52:46 +02:00
|
|
|
])
|
|
|
|
|
|
|
|
// Let Angular application handle errors
|
2023-06-29 09:48:55 +02:00
|
|
|
if (!video || isVideoInPrivateDirectory(video.privacy) || video.VideoBlacklist) {
|
2020-12-07 14:32:36 +01:00
|
|
|
res.status(HttpStatusCode.NOT_FOUND_404)
|
2020-01-09 08:50:00 +01:00
|
|
|
return html
|
2018-07-18 09:52:46 +02:00
|
|
|
}
|
2022-03-08 11:34:15 +01:00
|
|
|
const description = mdToOneLinePlainText(video.description)
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
let customHtml = ClientHtml.addTitleTag(html, video.name)
|
|
|
|
customHtml = ClientHtml.addDescriptionTag(customHtml, description)
|
2020-07-31 11:29:15 +02:00
|
|
|
|
|
|
|
const url = WEBSERVER.URL + video.getWatchStaticPath()
|
2020-12-06 18:47:49 +01:00
|
|
|
const originUrl = video.url
|
2021-11-30 08:31:56 +01:00
|
|
|
const title = video.name
|
|
|
|
const siteName = CONFIG.INSTANCE.NAME
|
2020-07-31 11:29:15 +02:00
|
|
|
|
|
|
|
const image = {
|
|
|
|
url: WEBSERVER.URL + video.getPreviewStaticPath()
|
|
|
|
}
|
|
|
|
|
|
|
|
const embed = {
|
|
|
|
url: WEBSERVER.URL + video.getEmbedStaticPath(),
|
|
|
|
createdAt: video.createdAt.toISOString(),
|
|
|
|
duration: getActivityStreamDuration(video.duration),
|
|
|
|
views: video.views
|
|
|
|
}
|
|
|
|
|
|
|
|
const ogType = 'video'
|
|
|
|
const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image'
|
|
|
|
const schemaType = 'VideoObject'
|
|
|
|
|
2023-03-24 18:37:55 +01:00
|
|
|
customHtml = await ClientHtml.addTags(customHtml, {
|
2020-12-08 10:53:41 +01:00
|
|
|
url,
|
|
|
|
originUrl,
|
2021-11-30 08:31:56 +01:00
|
|
|
escapedSiteName: escapeHTML(siteName),
|
|
|
|
escapedTitle: escapeHTML(title),
|
|
|
|
escapedDescription: escapeHTML(description),
|
2022-04-08 16:26:38 +02:00
|
|
|
disallowIndexation: video.privacy !== VideoPrivacy.PUBLIC,
|
2020-12-08 10:53:41 +01:00
|
|
|
image,
|
|
|
|
embed,
|
|
|
|
ogType,
|
|
|
|
twitterCard,
|
|
|
|
schemaType
|
2023-03-24 18:37:55 +01:00
|
|
|
}, { video })
|
2020-07-31 11:29:15 +02:00
|
|
|
|
|
|
|
return customHtml
|
|
|
|
}
|
|
|
|
|
2021-06-28 17:30:59 +02:00
|
|
|
static async getWatchPlaylistHTMLPage (videoPlaylistIdArg: string, req: express.Request, res: express.Response) {
|
|
|
|
const videoPlaylistId = toCompleteUUID(videoPlaylistIdArg)
|
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
// Let Angular application handle errors
|
|
|
|
if (!validator.isInt(videoPlaylistId) && !validator.isUUID(videoPlaylistId, 4)) {
|
2020-12-07 14:32:36 +01:00
|
|
|
res.status(HttpStatusCode.NOT_FOUND_404)
|
2020-07-31 11:29:15 +02:00
|
|
|
return ClientHtml.getIndexHTML(req, res)
|
|
|
|
}
|
|
|
|
|
|
|
|
const [ html, videoPlaylist ] = await Promise.all([
|
|
|
|
ClientHtml.getIndexHTML(req, res),
|
|
|
|
VideoPlaylistModel.loadWithAccountAndChannel(videoPlaylistId, null)
|
|
|
|
])
|
|
|
|
|
|
|
|
// Let Angular application handle errors
|
|
|
|
if (!videoPlaylist || videoPlaylist.privacy === VideoPlaylistPrivacy.PRIVATE) {
|
2020-12-07 14:32:36 +01:00
|
|
|
res.status(HttpStatusCode.NOT_FOUND_404)
|
2020-07-31 11:29:15 +02:00
|
|
|
return html
|
|
|
|
}
|
|
|
|
|
2022-03-08 11:34:15 +01:00
|
|
|
const description = mdToOneLinePlainText(videoPlaylist.description)
|
2021-11-30 08:31:56 +01:00
|
|
|
|
|
|
|
let customHtml = ClientHtml.addTitleTag(html, videoPlaylist.name)
|
|
|
|
customHtml = ClientHtml.addDescriptionTag(customHtml, description)
|
2020-07-31 11:29:15 +02:00
|
|
|
|
2021-07-27 17:37:59 +02:00
|
|
|
const url = WEBSERVER.URL + videoPlaylist.getWatchStaticPath()
|
2020-12-06 18:47:49 +01:00
|
|
|
const originUrl = videoPlaylist.url
|
2021-11-30 08:31:56 +01:00
|
|
|
const title = videoPlaylist.name
|
|
|
|
const siteName = CONFIG.INSTANCE.NAME
|
2020-07-31 11:29:15 +02:00
|
|
|
|
|
|
|
const image = {
|
|
|
|
url: videoPlaylist.getThumbnailUrl()
|
|
|
|
}
|
|
|
|
|
2020-08-05 15:35:58 +02:00
|
|
|
const embed = {
|
|
|
|
url: WEBSERVER.URL + videoPlaylist.getEmbedStaticPath(),
|
|
|
|
createdAt: videoPlaylist.createdAt.toISOString()
|
|
|
|
}
|
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
const list = {
|
2020-08-05 15:35:58 +02:00
|
|
|
numberOfItems: videoPlaylist.get('videosLength') as number
|
2020-07-31 11:29:15 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
const ogType = 'video'
|
2020-08-05 15:35:58 +02:00
|
|
|
const twitterCard = CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary'
|
2020-07-31 11:29:15 +02:00
|
|
|
const schemaType = 'ItemList'
|
|
|
|
|
2023-03-24 18:37:55 +01:00
|
|
|
customHtml = await ClientHtml.addTags(customHtml, {
|
2020-12-08 10:53:41 +01:00
|
|
|
url,
|
|
|
|
originUrl,
|
2021-11-30 08:31:56 +01:00
|
|
|
escapedSiteName: escapeHTML(siteName),
|
|
|
|
escapedTitle: escapeHTML(title),
|
|
|
|
escapedDescription: escapeHTML(description),
|
2022-04-08 16:26:38 +02:00
|
|
|
disallowIndexation: videoPlaylist.privacy !== VideoPlaylistPrivacy.PUBLIC,
|
2020-12-08 10:53:41 +01:00
|
|
|
embed,
|
|
|
|
image,
|
|
|
|
list,
|
|
|
|
ogType,
|
|
|
|
twitterCard,
|
|
|
|
schemaType
|
2023-03-24 18:37:55 +01:00
|
|
|
}, { playlist: videoPlaylist })
|
2019-02-21 14:06:10 +01:00
|
|
|
|
|
|
|
return customHtml
|
|
|
|
}
|
|
|
|
|
|
|
|
static async getAccountHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
|
2021-04-24 01:44:39 +02:00
|
|
|
const accountModelPromise = AccountModel.loadByNameWithHost(nameWithHost)
|
|
|
|
return this.getAccountOrChannelHTMLPage(() => accountModelPromise, req, res)
|
2019-02-21 14:06:10 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
static async getVideoChannelHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
|
2021-04-24 01:44:39 +02:00
|
|
|
const videoChannelModelPromise = VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost)
|
|
|
|
return this.getAccountOrChannelHTMLPage(() => videoChannelModelPromise, req, res)
|
|
|
|
}
|
|
|
|
|
|
|
|
static async getActorHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) {
|
2021-05-28 10:21:39 +02:00
|
|
|
const [ account, channel ] = await Promise.all([
|
|
|
|
AccountModel.loadByNameWithHost(nameWithHost),
|
|
|
|
VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost)
|
|
|
|
])
|
2021-04-24 01:44:39 +02:00
|
|
|
|
2021-05-28 10:21:39 +02:00
|
|
|
return this.getAccountOrChannelHTMLPage(() => Promise.resolve(account || channel), req, res)
|
2019-02-21 14:06:10 +01:00
|
|
|
}
|
|
|
|
|
2020-08-24 11:25:40 +02:00
|
|
|
static async getEmbedHTML () {
|
|
|
|
const path = ClientHtml.getEmbedPath()
|
|
|
|
|
2022-05-31 14:18:41 +02:00
|
|
|
// Disable HTML cache in dev mode because webpack can regenerate JS files
|
2022-07-06 15:44:14 +02:00
|
|
|
if (!isTestOrDevInstance() && ClientHtml.htmlCache[path]) {
|
2022-05-31 14:18:41 +02:00
|
|
|
return ClientHtml.htmlCache[path]
|
|
|
|
}
|
2020-08-24 11:25:40 +02:00
|
|
|
|
|
|
|
const buffer = await readFile(path)
|
2021-05-27 15:59:55 +02:00
|
|
|
const serverConfig = await ServerConfigManager.Instance.getHTMLServerConfig()
|
2020-08-24 11:25:40 +02:00
|
|
|
|
|
|
|
let html = buffer.toString()
|
|
|
|
html = await ClientHtml.addAsyncPluginCSS(html)
|
2020-12-08 14:51:51 +01:00
|
|
|
html = ClientHtml.addCustomCSS(html)
|
2020-12-08 15:28:14 +01:00
|
|
|
html = ClientHtml.addTitleTag(html)
|
2021-05-14 12:04:44 +02:00
|
|
|
html = ClientHtml.addDescriptionTag(html)
|
|
|
|
html = ClientHtml.addServerConfig(html, serverConfig)
|
2020-08-24 11:25:40 +02:00
|
|
|
|
|
|
|
ClientHtml.htmlCache[path] = html
|
|
|
|
|
|
|
|
return html
|
|
|
|
}
|
|
|
|
|
2019-02-21 14:06:10 +01:00
|
|
|
private static async getAccountOrChannelHTMLPage (
|
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 16:00:05 +02:00
|
|
|
loader: () => Promise<MAccountHost | MChannelHost>,
|
2019-02-21 14:06:10 +01:00
|
|
|
req: express.Request,
|
|
|
|
res: express.Response
|
|
|
|
) {
|
|
|
|
const [ html, entity ] = await Promise.all([
|
|
|
|
ClientHtml.getIndexHTML(req, res),
|
|
|
|
loader()
|
|
|
|
])
|
|
|
|
|
|
|
|
// Let Angular application handle errors
|
|
|
|
if (!entity) {
|
2020-12-07 14:32:36 +01:00
|
|
|
res.status(HttpStatusCode.NOT_FOUND_404)
|
2019-02-21 14:06:10 +01:00
|
|
|
return ClientHtml.getIndexHTML(req, res)
|
|
|
|
}
|
|
|
|
|
2022-03-08 11:34:15 +01:00
|
|
|
const description = mdToOneLinePlainText(entity.description)
|
2021-11-30 08:31:56 +01:00
|
|
|
|
|
|
|
let customHtml = ClientHtml.addTitleTag(html, entity.getDisplayName())
|
|
|
|
customHtml = ClientHtml.addDescriptionTag(customHtml, description)
|
2020-07-31 11:29:15 +02:00
|
|
|
|
Add Podcast RSS feeds (#5487)
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Initial test implementation of Podcast RSS
This is a pretty simple implementation to add support for The Podcast Namespace in RSS -- instead of affecting the existing RSS implementation, this adds a new UI option.
I attempted to retain compatibility with the rest of the RSS feed implementation as much as possible and have created a temporary fork of the "pfeed" library to support this effort.
* Update to pfeed-podcast 1.2.2
* Add correct feed image to RSS channel
* Prefer HLS videos for podcast RSS
Remove video/stream titles, add optional height attribute to podcast RSS
* Prefix podcast RSS images with root server URL
* Add optional video query support to include captions
* Add transcripts & person images to podcast RSS feed
* Prefer webseed/webtorrent files over HLS fragmented mp4s
* Experimentally adding podcast fields to basic config page
* Add validation for new basic config fields
* Don't include "content" in podcast feed, use full description for "description"
* Add medium/socialInteract to podcast RSS feeds. Use HTML for description
* Change base production image to bullseye, install prosody in image
* Add liveItem and trackers to Podcast RSS feeds
Remove height from alternateEnclosure, replaced with title.
* Clear Podcast RSS feed cache when live streams start/end
* Upgrade to Node 16
* Refactor clearCacheRoute to use ApiCache
* Remove unnecessary type hint
* Update dockerfile to node 16, install python-is-python2
* Use new file paths for captions/playlists
* Fix legacy videos in RSS after migration to object storage
* Improve method of identifying non-fragmented mp4s in podcast RSS feeds
* Don't include fragmented MP4s in podcast RSS feeds
* Add experimental support for podcast:categories on the podcast RSS item
* Fix undefined category when no videos exist
Allows for empty feeds to exist (important for feeds that might only go live)
* Add support for podcast:locked -- user has to opt in to show their email
* Use comma for podcast:categories delimiter
* Make cache clearing async
* Fix merge, temporarily test with pfeed-podcast
* Syntax changes
* Add EXT_MIMETYPE constants for captions
* Update & fix tests, fix enclosure mimetypes, remove admin email
* Add test for podacst:socialInteract
* Add filters hooks for podcast customTags
* Remove showdown, updated to pfeed-podcast 6.1.2
* Add 'action:api.live-video.state.updated' hook
* Avoid assigning undefined category to podcast feeds
* Remove nvmrc
* Remove comment
* Remove unused podcast config
* Remove more unused podcast config
* Fix MChannelAccountDefault type hint missed in merge
* Remove extra line
* Re-add newline in config
* Fix lint errors for isEmailPublic
* Fix thumbnails in podcast feeds
* Requested changes based on review
* Provide podcast rss 2.0 only on video channels
* Misc cleanup for a less messy PR
* Lint fixes
* Remove pfeed-podcast
* Add peertube version to new hooks
* Don't use query include, remove TODO
* Remove film medium hack
* Clear podcast rss cache before video/channel update hooks
* Clear podcast rss cache before video uploaded/deleted hooks
* Refactor podcast feed cache clearing
* Set correct person name from video channel
* Styling
* Fix tests
---------
Co-authored-by: Chocobozzz <me@florianbigard.com>
2023-05-22 16:00:05 +02:00
|
|
|
const url = entity.getClientUrl()
|
2020-12-06 18:47:49 +01:00
|
|
|
const originUrl = entity.Actor.url
|
2021-11-30 08:31:56 +01:00
|
|
|
const siteName = CONFIG.INSTANCE.NAME
|
|
|
|
const title = entity.getDisplayName()
|
2020-07-31 11:29:15 +02:00
|
|
|
|
2022-02-28 08:34:43 +01:00
|
|
|
const avatar = getBiggestActorImage(entity.Actor.Avatars)
|
2020-07-31 11:29:15 +02:00
|
|
|
const image = {
|
2022-02-28 08:34:43 +01:00
|
|
|
url: ActorImageModel.getImageUrl(avatar),
|
|
|
|
width: avatar?.width,
|
|
|
|
height: avatar?.height
|
2020-07-31 11:29:15 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
const ogType = 'website'
|
|
|
|
const twitterCard = 'summary'
|
|
|
|
const schemaType = 'ProfilePage'
|
|
|
|
|
2023-03-24 18:37:55 +01:00
|
|
|
customHtml = await ClientHtml.addTags(customHtml, {
|
2020-12-08 10:53:41 +01:00
|
|
|
url,
|
|
|
|
originUrl,
|
2021-11-30 08:31:56 +01:00
|
|
|
escapedTitle: escapeHTML(title),
|
|
|
|
escapedSiteName: escapeHTML(siteName),
|
|
|
|
escapedDescription: escapeHTML(description),
|
2020-12-08 10:53:41 +01:00
|
|
|
image,
|
|
|
|
ogType,
|
|
|
|
twitterCard,
|
2021-08-05 13:29:10 +02:00
|
|
|
schemaType,
|
|
|
|
disallowIndexation: !entity.Actor.isOwned()
|
2023-03-24 18:37:55 +01:00
|
|
|
}, {})
|
2018-12-14 15:49:36 +01:00
|
|
|
|
|
|
|
return customHtml
|
|
|
|
}
|
|
|
|
|
|
|
|
private static async getIndexHTML (req: express.Request, res: express.Response, paramLang?: string) {
|
|
|
|
const path = ClientHtml.getIndexPath(req, res, paramLang)
|
2022-03-17 09:09:06 +01:00
|
|
|
if (ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path]
|
2018-12-14 15:49:36 +01:00
|
|
|
|
|
|
|
const buffer = await readFile(path)
|
2021-05-27 15:59:55 +02:00
|
|
|
const serverConfig = await ServerConfigManager.Instance.getHTMLServerConfig()
|
2018-12-14 15:49:36 +01:00
|
|
|
|
|
|
|
let html = buffer.toString()
|
|
|
|
|
2020-07-10 10:20:11 +02:00
|
|
|
html = ClientHtml.addManifestContentHash(html)
|
|
|
|
html = ClientHtml.addFaviconContentHash(html)
|
|
|
|
html = ClientHtml.addLogoContentHash(html)
|
2018-12-14 15:49:36 +01:00
|
|
|
html = ClientHtml.addCustomCSS(html)
|
2021-05-14 12:04:44 +02:00
|
|
|
html = ClientHtml.addServerConfig(html, serverConfig)
|
2019-07-23 09:48:48 +02:00
|
|
|
html = await ClientHtml.addAsyncPluginCSS(html)
|
2018-12-14 15:49:36 +01:00
|
|
|
|
2020-01-31 16:56:52 +01:00
|
|
|
ClientHtml.htmlCache[path] = html
|
2018-12-14 15:49:36 +01:00
|
|
|
|
|
|
|
return html
|
2018-07-18 09:52:46 +02:00
|
|
|
}
|
|
|
|
|
2020-01-10 19:50:48 +01:00
|
|
|
private static getIndexPath (req: express.Request, res: express.Response, paramLang: string) {
|
2018-07-18 09:52:46 +02:00
|
|
|
let lang: string
|
|
|
|
|
|
|
|
// Check param lang validity
|
|
|
|
if (paramLang && is18nLocale(paramLang)) {
|
|
|
|
lang = paramLang
|
|
|
|
|
|
|
|
// Save locale in cookies
|
|
|
|
res.cookie('clientLanguage', lang, {
|
2019-04-11 11:33:44 +02:00
|
|
|
secure: WEBSERVER.SCHEME === 'https',
|
2020-04-30 15:03:09 +02:00
|
|
|
sameSite: 'none',
|
2018-07-18 09:52:46 +02:00
|
|
|
maxAge: 1000 * 3600 * 24 * 90 // 3 months
|
|
|
|
})
|
|
|
|
|
|
|
|
} else if (req.cookies.clientLanguage && is18nLocale(req.cookies.clientLanguage)) {
|
|
|
|
lang = req.cookies.clientLanguage
|
|
|
|
} else {
|
|
|
|
lang = req.acceptsLanguages(POSSIBLE_LOCALES) || getDefaultLocale()
|
|
|
|
}
|
|
|
|
|
2021-11-24 10:49:12 +01:00
|
|
|
logger.debug(
|
|
|
|
'Serving %s HTML language', buildFileLocale(lang),
|
|
|
|
{ cookie: req.cookies?.clientLanguage, paramLang, acceptLanguage: req.headers['accept-language'] }
|
|
|
|
)
|
|
|
|
|
2022-01-03 17:13:11 +01:00
|
|
|
return join(root(), 'client', 'dist', buildFileLocale(lang), 'index.html')
|
2018-07-18 09:52:46 +02:00
|
|
|
}
|
|
|
|
|
2020-08-24 11:25:40 +02:00
|
|
|
private static getEmbedPath () {
|
2022-01-03 17:13:11 +01:00
|
|
|
return join(root(), 'client', 'dist', 'standalone', 'videos', 'embed.html')
|
2020-08-24 11:25:40 +02:00
|
|
|
}
|
|
|
|
|
2020-07-10 10:20:11 +02:00
|
|
|
private static addManifestContentHash (htmlStringPage: string) {
|
|
|
|
return htmlStringPage.replace('[manifestContentHash]', FILES_CONTENT_HASH.MANIFEST)
|
|
|
|
}
|
|
|
|
|
2020-07-10 10:51:07 +02:00
|
|
|
private static addFaviconContentHash (htmlStringPage: string) {
|
2020-07-10 10:20:11 +02:00
|
|
|
return htmlStringPage.replace('[faviconContentHash]', FILES_CONTENT_HASH.FAVICON)
|
|
|
|
}
|
|
|
|
|
2020-07-10 10:51:07 +02:00
|
|
|
private static addLogoContentHash (htmlStringPage: string) {
|
2020-07-10 10:20:11 +02:00
|
|
|
return htmlStringPage.replace('[logoContentHash]', FILES_CONTENT_HASH.LOGO)
|
|
|
|
}
|
|
|
|
|
2018-12-14 15:49:36 +01:00
|
|
|
private static addTitleTag (htmlStringPage: string, title?: string) {
|
|
|
|
let text = title || CONFIG.INSTANCE.NAME
|
|
|
|
if (title) text += ` - ${CONFIG.INSTANCE.NAME}`
|
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
const titleTag = `<title>${escapeHTML(text)}</title>`
|
2018-07-18 09:52:46 +02:00
|
|
|
|
|
|
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.TITLE, titleTag)
|
|
|
|
}
|
|
|
|
|
2018-12-14 15:49:36 +01:00
|
|
|
private static addDescriptionTag (htmlStringPage: string, description?: string) {
|
|
|
|
const content = description || CONFIG.INSTANCE.SHORT_DESCRIPTION
|
2021-11-30 08:31:56 +01:00
|
|
|
const descriptionTag = `<meta name="description" content="${escapeHTML(content)}" />`
|
2018-07-18 09:52:46 +02:00
|
|
|
|
|
|
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag)
|
|
|
|
}
|
|
|
|
|
|
|
|
private static addCustomCSS (htmlStringPage: string) {
|
2019-07-10 14:06:19 +02:00
|
|
|
const styleTag = `<style class="custom-css-style">${CONFIG.INSTANCE.CUSTOMIZATIONS.CSS}</style>`
|
2018-07-18 09:52:46 +02:00
|
|
|
|
|
|
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag)
|
|
|
|
}
|
|
|
|
|
2021-05-14 12:04:44 +02:00
|
|
|
private static addServerConfig (htmlStringPage: string, serverConfig: HTMLServerConfig) {
|
2021-09-09 09:13:45 +02:00
|
|
|
// Stringify the JSON object, and then stringify the string object so we can inject it into the HTML
|
|
|
|
const serverConfigString = JSON.stringify(JSON.stringify(serverConfig))
|
|
|
|
const configScriptTag = `<script type="application/javascript">window.PeerTubeServerConfig = ${serverConfigString}</script>`
|
2021-05-14 12:04:44 +02:00
|
|
|
|
|
|
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.SERVER_CONFIG, configScriptTag)
|
|
|
|
}
|
|
|
|
|
2019-07-23 09:48:48 +02:00
|
|
|
private static async addAsyncPluginCSS (htmlStringPage: string) {
|
2023-05-10 09:54:44 +02:00
|
|
|
if (!pathExists(PLUGIN_GLOBAL_CSS_PATH)) {
|
|
|
|
logger.info('Plugin Global CSS file is not available (generation may still be in progress), ignoring it.')
|
|
|
|
return htmlStringPage
|
|
|
|
}
|
|
|
|
|
|
|
|
let globalCSSContent: Buffer
|
|
|
|
|
|
|
|
try {
|
|
|
|
globalCSSContent = await readFile(PLUGIN_GLOBAL_CSS_PATH)
|
|
|
|
} catch (err) {
|
|
|
|
logger.error('Error retrieving the Plugin Global CSS file, ignoring it.', { err })
|
|
|
|
return htmlStringPage
|
|
|
|
}
|
|
|
|
|
2019-07-23 10:40:39 +02:00
|
|
|
if (globalCSSContent.byteLength === 0) return htmlStringPage
|
2019-07-23 09:48:48 +02:00
|
|
|
|
|
|
|
const fileHash = sha256(globalCSSContent)
|
|
|
|
const linkTag = `<link rel="stylesheet" href="/plugins/global.css?hash=${fileHash}" />`
|
2019-07-10 14:06:19 +02:00
|
|
|
|
|
|
|
return htmlStringPage.replace('</head>', linkTag + '</head>')
|
|
|
|
}
|
|
|
|
|
2020-08-05 15:35:58 +02:00
|
|
|
private static generateOpenGraphMetaTags (tags: Tags) {
|
2020-07-31 11:29:15 +02:00
|
|
|
const metaTags = {
|
|
|
|
'og:type': tags.ogType,
|
2021-11-30 08:31:56 +01:00
|
|
|
'og:site_name': tags.escapedSiteName,
|
|
|
|
'og:title': tags.escapedTitle,
|
2020-07-31 11:29:15 +02:00
|
|
|
'og:image': tags.image.url
|
|
|
|
}
|
|
|
|
|
|
|
|
if (tags.image.width && tags.image.height) {
|
|
|
|
metaTags['og:image:width'] = tags.image.width
|
|
|
|
metaTags['og:image:height'] = tags.image.height
|
|
|
|
}
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
metaTags['og:url'] = tags.url
|
2021-11-30 08:31:56 +01:00
|
|
|
metaTags['og:description'] = tags.escapedDescription
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
if (tags.embed) {
|
|
|
|
metaTags['og:video:url'] = tags.embed.url
|
|
|
|
metaTags['og:video:secure_url'] = tags.embed.url
|
|
|
|
metaTags['og:video:type'] = 'text/html'
|
|
|
|
metaTags['og:video:width'] = EMBED_SIZE.width
|
|
|
|
metaTags['og:video:height'] = EMBED_SIZE.height
|
|
|
|
}
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
return metaTags
|
|
|
|
}
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2020-08-05 15:35:58 +02:00
|
|
|
private static generateStandardMetaTags (tags: Tags) {
|
2020-07-31 11:29:15 +02:00
|
|
|
return {
|
2021-11-30 08:31:56 +01:00
|
|
|
name: tags.escapedTitle,
|
|
|
|
description: tags.escapedDescription,
|
2020-07-31 11:29:15 +02:00
|
|
|
image: tags.image.url
|
|
|
|
}
|
|
|
|
}
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2020-08-05 15:35:58 +02:00
|
|
|
private static generateTwitterCardMetaTags (tags: Tags) {
|
2020-07-31 11:29:15 +02:00
|
|
|
const metaTags = {
|
|
|
|
'twitter:card': tags.twitterCard,
|
2018-07-18 09:52:46 +02:00
|
|
|
'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
|
2021-11-30 08:31:56 +01:00
|
|
|
'twitter:title': tags.escapedTitle,
|
|
|
|
'twitter:description': tags.escapedDescription,
|
2020-07-31 11:29:15 +02:00
|
|
|
'twitter:image': tags.image.url
|
2018-07-18 09:52:46 +02:00
|
|
|
}
|
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
if (tags.image.width && tags.image.height) {
|
|
|
|
metaTags['twitter:image:width'] = tags.image.width
|
|
|
|
metaTags['twitter:image:height'] = tags.image.height
|
|
|
|
}
|
|
|
|
|
2020-08-07 14:53:01 +02:00
|
|
|
if (tags.twitterCard === 'player') {
|
|
|
|
metaTags['twitter:player'] = tags.embed.url
|
|
|
|
metaTags['twitter:player:width'] = EMBED_SIZE.width
|
|
|
|
metaTags['twitter:player:height'] = EMBED_SIZE.height
|
|
|
|
}
|
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
return metaTags
|
|
|
|
}
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2023-03-24 18:37:55 +01:00
|
|
|
private static async generateSchemaTags (tags: Tags, context: HookContext) {
|
2020-07-31 11:29:15 +02:00
|
|
|
const schema = {
|
2018-07-18 09:52:46 +02:00
|
|
|
'@context': 'http://schema.org',
|
2020-07-31 11:29:15 +02:00
|
|
|
'@type': tags.schemaType,
|
2021-11-30 08:31:56 +01:00
|
|
|
'name': tags.escapedTitle,
|
|
|
|
'description': tags.escapedDescription,
|
2020-07-31 11:29:15 +02:00
|
|
|
'image': tags.image.url,
|
|
|
|
'url': tags.url
|
|
|
|
}
|
|
|
|
|
|
|
|
if (tags.list) {
|
|
|
|
schema['numberOfItems'] = tags.list.numberOfItems
|
|
|
|
schema['thumbnailUrl'] = tags.image.url
|
|
|
|
}
|
|
|
|
|
|
|
|
if (tags.embed) {
|
|
|
|
schema['embedUrl'] = tags.embed.url
|
|
|
|
schema['uploadDate'] = tags.embed.createdAt
|
2020-08-05 15:35:58 +02:00
|
|
|
|
|
|
|
if (tags.embed.duration) schema['duration'] = tags.embed.duration
|
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
schema['thumbnailUrl'] = tags.image.url
|
|
|
|
schema['contentUrl'] = tags.url
|
|
|
|
}
|
|
|
|
|
2023-03-24 18:37:55 +01:00
|
|
|
return Hooks.wrapObject(schema, 'filter:html.client.json-ld.result', context)
|
2020-07-31 11:29:15 +02:00
|
|
|
}
|
|
|
|
|
2023-03-24 18:37:55 +01:00
|
|
|
private static async addTags (htmlStringPage: string, tagsValues: Tags, context: HookContext) {
|
2020-07-31 11:29:15 +02:00
|
|
|
const openGraphMetaTags = this.generateOpenGraphMetaTags(tagsValues)
|
|
|
|
const standardMetaTags = this.generateStandardMetaTags(tagsValues)
|
|
|
|
const twitterCardMetaTags = this.generateTwitterCardMetaTags(tagsValues)
|
2023-03-24 18:37:55 +01:00
|
|
|
const schemaTags = await this.generateSchemaTags(tagsValues, context)
|
2020-07-31 11:29:15 +02:00
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
const { url, escapedTitle, embed, originUrl, disallowIndexation } = tagsValues
|
2020-07-31 11:29:15 +02:00
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
const oembedLinkTags: { type: string, href: string, escapedTitle: string }[] = []
|
2020-07-31 11:29:15 +02:00
|
|
|
|
|
|
|
if (embed) {
|
|
|
|
oembedLinkTags.push({
|
|
|
|
type: 'application/json+oembed',
|
|
|
|
href: WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(url),
|
2021-11-30 08:31:56 +01:00
|
|
|
escapedTitle
|
2020-07-31 11:29:15 +02:00
|
|
|
})
|
2018-07-18 09:52:46 +02:00
|
|
|
}
|
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
let tagsStr = ''
|
2018-07-18 09:52:46 +02:00
|
|
|
|
|
|
|
// Opengraph
|
|
|
|
Object.keys(openGraphMetaTags).forEach(tagName => {
|
2020-01-31 16:56:52 +01:00
|
|
|
const tagValue = openGraphMetaTags[tagName]
|
2018-07-18 09:52:46 +02:00
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
tagsStr += `<meta property="${tagName}" content="${tagValue}" />`
|
2018-07-18 09:52:46 +02:00
|
|
|
})
|
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
// Standard
|
|
|
|
Object.keys(standardMetaTags).forEach(tagName => {
|
|
|
|
const tagValue = standardMetaTags[tagName]
|
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
tagsStr += `<meta property="${tagName}" content="${tagValue}" />`
|
2020-07-31 11:29:15 +02:00
|
|
|
})
|
|
|
|
|
|
|
|
// Twitter card
|
|
|
|
Object.keys(twitterCardMetaTags).forEach(tagName => {
|
|
|
|
const tagValue = twitterCardMetaTags[tagName]
|
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
tagsStr += `<meta property="${tagName}" content="${tagValue}" />`
|
2020-07-31 11:29:15 +02:00
|
|
|
})
|
|
|
|
|
2018-07-18 09:52:46 +02:00
|
|
|
// OEmbed
|
|
|
|
for (const oembedLinkTag of oembedLinkTags) {
|
2021-11-30 08:31:56 +01:00
|
|
|
tagsStr += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.escapedTitle}" />`
|
2018-07-18 09:52:46 +02:00
|
|
|
}
|
|
|
|
|
|
|
|
// Schema.org
|
2020-07-31 11:29:15 +02:00
|
|
|
if (schemaTags) {
|
2021-11-30 08:31:56 +01:00
|
|
|
tagsStr += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>`
|
2020-07-31 11:29:15 +02:00
|
|
|
}
|
2019-02-21 14:06:10 +01:00
|
|
|
|
2020-07-31 11:29:15 +02:00
|
|
|
// SEO, use origin URL
|
2021-11-30 08:31:56 +01:00
|
|
|
tagsStr += `<link rel="canonical" href="${originUrl}" />`
|
2019-02-21 14:06:10 +01:00
|
|
|
|
2021-08-05 13:29:10 +02:00
|
|
|
if (disallowIndexation) {
|
2021-11-30 08:31:56 +01:00
|
|
|
tagsStr += `<meta name="robots" content="noindex" />`
|
2021-08-05 13:29:10 +02:00
|
|
|
}
|
|
|
|
|
2021-11-30 08:31:56 +01:00
|
|
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, tagsStr)
|
2018-07-18 09:52:46 +02:00
|
|
|
}
|
|
|
|
}
|
2020-12-08 21:16:10 +01:00
|
|
|
|
2021-12-02 09:14:54 +01:00
|
|
|
function sendHTML (html: string, res: express.Response, localizedHTML: boolean = false) {
|
2020-12-08 21:16:10 +01:00
|
|
|
res.set('Content-Type', 'text/html; charset=UTF-8')
|
|
|
|
|
2021-12-02 09:14:54 +01:00
|
|
|
if (localizedHTML) {
|
|
|
|
res.set('Vary', 'Accept-Language')
|
|
|
|
}
|
|
|
|
|
2020-12-08 21:16:10 +01:00
|
|
|
return res.send(html)
|
|
|
|
}
|
|
|
|
|
|
|
|
async function serveIndexHTML (req: express.Request, res: express.Response) {
|
2021-10-11 14:00:09 +02:00
|
|
|
if (req.accepts(ACCEPT_HEADERS) === 'html' || !req.headers.accept) {
|
2020-12-08 21:16:10 +01:00
|
|
|
try {
|
|
|
|
await generateHTMLPage(req, res, req.params.language)
|
|
|
|
return
|
|
|
|
} catch (err) {
|
2022-07-18 11:55:13 +02:00
|
|
|
logger.error('Cannot generate HTML page.', { err })
|
2021-06-01 01:36:53 +02:00
|
|
|
return res.status(HttpStatusCode.INTERNAL_SERVER_ERROR_500).end()
|
2020-12-08 21:16:10 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-06-01 01:36:53 +02:00
|
|
|
return res.status(HttpStatusCode.NOT_ACCEPTABLE_406).end()
|
2020-12-08 21:16:10 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// ---------------------------------------------------------------------------
|
|
|
|
|
|
|
|
export {
|
|
|
|
ClientHtml,
|
|
|
|
sendHTML,
|
|
|
|
serveIndexHTML
|
|
|
|
}
|
|
|
|
|
|
|
|
async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
|
|
|
|
const html = await ClientHtml.getDefaultHTMLPage(req, res, paramLang)
|
|
|
|
|
2021-12-02 09:14:54 +01:00
|
|
|
return sendHTML(html, res, true)
|
2020-12-08 21:16:10 +01:00
|
|
|
}
|