forks/peertube
1
0
Fork 0
Code Releases Activity

Truncate html/og/card HTML description tags

Browse source
This commit is contained in:
Chocobozzz 2023-07-26 10:19:51 +02:00
parent d7c3670945
commit 3ffff82e87
No known key found for this signature in database
GPG key ID: 583A612D890159BE
1 changed files with 22 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
server/lib/client-html.ts
View file

@ -1,5 +1,6 @@
import express from 'express' import express from 'express'
import { pathExists, readFile } from 'fs-extra' import { pathExists, readFile } from 'fs-extra'
import { truncate } from 'lodash'
import { join } from 'path' import { join } from 'path'
import validator from 'validator' import validator from 'validator'
import { isTestOrDevInstance } from '@server/helpers/core-utils' import { isTestOrDevInstance } from '@server/helpers/core-utils'
@ -45,7 +46,7 @@ type Tags = {
escapedSiteName: string escapedSiteName: string
escapedTitle: string escapedTitle: string
escapedDescription: string escapedTruncatedDescription: string
url: string url: string
originUrl: string originUrl: string
@ -111,10 +112,10 @@ class ClientHtml {
res.status(HttpStatusCode.NOT_FOUND_404) res.status(HttpStatusCode.NOT_FOUND_404)
return html return html
} }
const description = mdToOneLinePlainText(video.description) const escapedTruncatedDescription = buildEscapedTruncatedDescription(video.description)
let customHtml = ClientHtml.addTitleTag(html, video.name) let customHtml = ClientHtml.addTitleTag(html, video.name)
customHtml = ClientHtml.addDescriptionTag(customHtml, description) customHtml = ClientHtml.addDescriptionTag(customHtml, escapedTruncatedDescription)
const url = WEBSERVER.URL + video.getWatchStaticPath() const url = WEBSERVER.URL + video.getWatchStaticPath()
const originUrl = video.url const originUrl = video.url
@ -141,7 +142,7 @@ class ClientHtml {
originUrl, originUrl,
escapedSiteName: escapeHTML(siteName), escapedSiteName: escapeHTML(siteName),
escapedTitle: escapeHTML(title), escapedTitle: escapeHTML(title),
escapedDescription: escapeHTML(description), escapedTruncatedDescription,
disallowIndexation: video.privacy !== VideoPrivacy.PUBLIC, disallowIndexation: video.privacy !== VideoPrivacy.PUBLIC,
image, image,
embed, embed,
@ -173,10 +174,10 @@ class ClientHtml {
return html return html
} }
const description = mdToOneLinePlainText(videoPlaylist.description) const escapedTruncatedDescription = buildEscapedTruncatedDescription(videoPlaylist.description)
let customHtml = ClientHtml.addTitleTag(html, videoPlaylist.name) let customHtml = ClientHtml.addTitleTag(html, videoPlaylist.name)
customHtml = ClientHtml.addDescriptionTag(customHtml, description) customHtml = ClientHtml.addDescriptionTag(customHtml, escapedTruncatedDescription)
const url = WEBSERVER.URL + videoPlaylist.getWatchStaticPath() const url = WEBSERVER.URL + videoPlaylist.getWatchStaticPath()
const originUrl = videoPlaylist.url const originUrl = videoPlaylist.url
@ -205,7 +206,7 @@ class ClientHtml {
originUrl, originUrl,
escapedSiteName: escapeHTML(siteName), escapedSiteName: escapeHTML(siteName),
escapedTitle: escapeHTML(title), escapedTitle: escapeHTML(title),
escapedDescription: escapeHTML(description), escapedTruncatedDescription,
disallowIndexation: videoPlaylist.privacy !== VideoPlaylistPrivacy.PUBLIC, disallowIndexation: videoPlaylist.privacy !== VideoPlaylistPrivacy.PUBLIC,
embed, embed,
image, image,
@ -276,10 +277,10 @@ class ClientHtml {
return ClientHtml.getIndexHTML(req, res) return ClientHtml.getIndexHTML(req, res)
} }
const description = mdToOneLinePlainText(entity.description) const escapedTruncatedDescription = buildEscapedTruncatedDescription(entity.description)
let customHtml = ClientHtml.addTitleTag(html, entity.getDisplayName()) let customHtml = ClientHtml.addTitleTag(html, entity.getDisplayName())
customHtml = ClientHtml.addDescriptionTag(customHtml, description) customHtml = ClientHtml.addDescriptionTag(customHtml, escapedTruncatedDescription)
const url = entity.getClientUrl() const url = entity.getClientUrl()
const originUrl = entity.Actor.url const originUrl = entity.Actor.url
@ -302,7 +303,7 @@ class ClientHtml {
originUrl, originUrl,
escapedTitle: escapeHTML(title), escapedTitle: escapeHTML(title),
escapedSiteName: escapeHTML(siteName), escapedSiteName: escapeHTML(siteName),
escapedDescription: escapeHTML(description), escapedTruncatedDescription,
image, image,
ogType, ogType,
twitterCard, twitterCard,
@ -387,9 +388,9 @@ class ClientHtml {
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.TITLE, titleTag) return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.TITLE, titleTag)
} }
private static addDescriptionTag (htmlStringPage: string, description?: string) { private static addDescriptionTag (htmlStringPage: string, escapedTruncatedDescription?: string) {
const content = description || CONFIG.INSTANCE.SHORT_DESCRIPTION const content = escapedTruncatedDescription || escapeHTML(CONFIG.INSTANCE.SHORT_DESCRIPTION)
const descriptionTag = `<meta name="description" content="${escapeHTML(content)}" />` const descriptionTag = `<meta name="description" content="${content}" />`
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag) return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag)
} }
@ -445,7 +446,7 @@ class ClientHtml {
} }
metaTags['og:url'] = tags.url metaTags['og:url'] = tags.url
metaTags['og:description'] = tags.escapedDescription metaTags['og:description'] = tags.escapedTruncatedDescription
if (tags.embed) { if (tags.embed) {
metaTags['og:video:url'] = tags.embed.url metaTags['og:video:url'] = tags.embed.url
@ -461,7 +462,7 @@ class ClientHtml {
private static generateStandardMetaTags (tags: Tags) { private static generateStandardMetaTags (tags: Tags) {
return { return {
name: tags.escapedTitle, name: tags.escapedTitle,
description: tags.escapedDescription, description: tags.escapedTruncatedDescription,
image: tags.image.url image: tags.image.url
} }
} }
@ -471,7 +472,7 @@ class ClientHtml {
'twitter:card': tags.twitterCard, 'twitter:card': tags.twitterCard,
'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME, 'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
'twitter:title': tags.escapedTitle, 'twitter:title': tags.escapedTitle,
'twitter:description': tags.escapedDescription, 'twitter:description': tags.escapedTruncatedDescription,
'twitter:image': tags.image.url 'twitter:image': tags.image.url
} }
@ -494,7 +495,7 @@ class ClientHtml {
'@context': 'http://schema.org', '@context': 'http://schema.org',
'@type': tags.schemaType, '@type': tags.schemaType,
'name': tags.escapedTitle, 'name': tags.escapedTitle,
'description': tags.escapedDescription, 'description': tags.escapedTruncatedDescription,
'image': tags.image.url, 'image': tags.image.url,
'url': tags.url 'url': tags.url
} }
@ -616,3 +617,7 @@ async function generateHTMLPage (req: express.Request, res: express.Response, pa
return sendHTML(html, res, true) return sendHTML(html, res, true)
} }
function buildEscapedTruncatedDescription (description: string) {
return truncate(mdToOneLinePlainText(description), { length: 200 })
}