Render CSS/title/description tags on server side
This commit is contained in:
parent
1d94c15468
commit
e032aec9b9
|
@ -4,6 +4,7 @@ import { GuardsCheckStart, NavigationEnd, Router } from '@angular/router'
|
||||||
import { AuthService, RedirectService, ServerService } from '@app/core'
|
import { AuthService, RedirectService, ServerService } from '@app/core'
|
||||||
import { is18nPath } from '../../../shared/models/i18n'
|
import { is18nPath } from '../../../shared/models/i18n'
|
||||||
import { ScreenService } from '@app/shared/misc/screen.service'
|
import { ScreenService } from '@app/shared/misc/screen.service'
|
||||||
|
import { skip } from 'rxjs/operators'
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
selector: 'my-app',
|
selector: 'my-app',
|
||||||
|
@ -89,16 +90,11 @@ export class AppComponent implements OnInit {
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
|
// Inject JS
|
||||||
this.serverService.configLoaded
|
this.serverService.configLoaded
|
||||||
.subscribe(() => {
|
.subscribe(() => {
|
||||||
const config = this.serverService.getConfig()
|
const config = this.serverService.getConfig()
|
||||||
|
|
||||||
// We test customCSS if the admin removed the css
|
|
||||||
if (this.customCSS || config.instance.customizations.css) {
|
|
||||||
const styleTag = '<style>' + config.instance.customizations.css + '</style>'
|
|
||||||
this.customCSS = this.domSanitizer.bypassSecurityTrustHtml(styleTag)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (config.instance.customizations.javascript) {
|
if (config.instance.customizations.javascript) {
|
||||||
try {
|
try {
|
||||||
// tslint:disable:no-eval
|
// tslint:disable:no-eval
|
||||||
|
@ -108,6 +104,22 @@ export class AppComponent implements OnInit {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
// Inject CSS if modified (admin config settings)
|
||||||
|
this.serverService.configLoaded
|
||||||
|
.pipe(skip(1)) // We only want to subscribe to reloads, because the CSS is already injected by the server
|
||||||
|
.subscribe(() => {
|
||||||
|
const headStyle = document.querySelector('style.custom-css-style')
|
||||||
|
if (headStyle) headStyle.parentNode.removeChild(headStyle)
|
||||||
|
|
||||||
|
const config = this.serverService.getConfig()
|
||||||
|
|
||||||
|
// We test customCSS if the admin removed the css
|
||||||
|
if (this.customCSS || config.instance.customizations.css) {
|
||||||
|
const styleTag = '<style>' + config.instance.customizations.css + '</style>'
|
||||||
|
this.customCSS = this.domSanitizer.bypassSecurityTrustHtml(styleTag)
|
||||||
|
}
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
isUserLoggedIn () {
|
isUserLoggedIn () {
|
||||||
|
|
|
@ -1,20 +1,22 @@
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<title>PeerTube</title>
|
|
||||||
|
|
||||||
<meta charset="UTF-8">
|
<meta charset="UTF-8">
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||||
<meta name="description" content="PeerTube, a decentralized video streaming platform using P2P (BitTorrent) directly in the web browser" />
|
|
||||||
|
|
||||||
<meta name="theme-color" content="#fff" />
|
<meta name="theme-color" content="#fff" />
|
||||||
|
|
||||||
<!-- Web Manifest file -->
|
<!-- Web Manifest file -->
|
||||||
<link rel="manifest" href="/manifest.json">
|
<link rel="manifest" href="/manifest.json">
|
||||||
|
|
||||||
<!-- The following comment is used by the server to prerender OpenGraph and oEmbed tags -->
|
<!-- /!\ The following comment is used by the server to prerender some tags /!\ -->
|
||||||
|
|
||||||
|
<!-- title tag -->
|
||||||
|
<!-- description tag -->
|
||||||
|
<!-- custom css tag -->
|
||||||
<!-- open graph and oembed tags -->
|
<!-- open graph and oembed tags -->
|
||||||
<!-- Do not remove it! -->
|
|
||||||
|
<!-- /!\ Do not remove it /!\ -->
|
||||||
|
|
||||||
<link rel="icon" type="image/png" href="/client/assets/images/favicon.png" />
|
<link rel="icon" type="image/png" href="/client/assets/images/favicon.png" />
|
||||||
|
|
||||||
|
|
|
@ -10,16 +10,19 @@ defaultLanguage="en_US"
|
||||||
npm run ng build -- --output-path "dist/$defaultLanguage/" --deploy-url "/client/$defaultLanguage/" --prod --stats-json
|
npm run ng build -- --output-path "dist/$defaultLanguage/" --deploy-url "/client/$defaultLanguage/" --prod --stats-json
|
||||||
mv "./dist/$defaultLanguage/assets" "./dist"
|
mv "./dist/$defaultLanguage/assets" "./dist"
|
||||||
|
|
||||||
# Supported languages
|
# Don't build other languages if --light arg is provided
|
||||||
languages=("fr_FR" "eu_ES" "ca_ES" "cs_CZ" "eo")
|
if [ -z ${1+x} ] || [ "$1" != "--light" ]; then
|
||||||
|
# Supported languages
|
||||||
|
languages=("fr_FR" "eu_ES" "ca_ES" "cs_CZ" "eo")
|
||||||
|
|
||||||
for lang in "${languages[@]}"; do
|
for lang in "${languages[@]}"; do
|
||||||
npm run ng build -- --prod --i18n-file "./src/locale/target/angular_$lang.xml" --i18n-format xlf --i18n-locale "$lang" \
|
npm run ng build -- --prod --i18n-file "./src/locale/target/angular_$lang.xml" --i18n-format xlf --i18n-locale "$lang" \
|
||||||
--output-path "dist/$lang/" --deploy-url "/client/$lang/"
|
--output-path "dist/$lang/" --deploy-url "/client/$lang/"
|
||||||
|
|
||||||
# Do no duplicate assets
|
# Do no duplicate assets
|
||||||
rm -r "./dist/$lang/assets"
|
rm -r "./dist/$lang/assets"
|
||||||
done
|
done
|
||||||
|
fi
|
||||||
|
|
||||||
NODE_ENV=production npm run webpack -- --config webpack/webpack.video-embed.js --mode production --json > "./dist/embed-stats.json"
|
NODE_ENV=production npm run webpack -- --config webpack/webpack.video-embed.js --mode production --json > "./dist/embed-stats.json"
|
||||||
|
|
||||||
|
|
|
@ -8,6 +8,7 @@ import { isSignupAllowed, isSignupAllowedForCurrentIP } from '../../helpers/util
|
||||||
import { CONFIG, CONSTRAINTS_FIELDS, reloadConfig } from '../../initializers'
|
import { CONFIG, CONSTRAINTS_FIELDS, reloadConfig } from '../../initializers'
|
||||||
import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
|
import { asyncMiddleware, authenticate, ensureUserHasRight } from '../../middlewares'
|
||||||
import { customConfigUpdateValidator } from '../../middlewares/validators/config'
|
import { customConfigUpdateValidator } from '../../middlewares/validators/config'
|
||||||
|
import { ClientHtml } from '../../lib/client-html'
|
||||||
|
|
||||||
const packageJSON = require('../../../../package.json')
|
const packageJSON = require('../../../../package.json')
|
||||||
const configRouter = express.Router()
|
const configRouter = express.Router()
|
||||||
|
@ -119,6 +120,7 @@ async function deleteCustomConfig (req: express.Request, res: express.Response,
|
||||||
await unlinkPromise(CONFIG.CUSTOM_FILE)
|
await unlinkPromise(CONFIG.CUSTOM_FILE)
|
||||||
|
|
||||||
reloadConfig()
|
reloadConfig()
|
||||||
|
ClientHtml.invalidCache()
|
||||||
|
|
||||||
const data = customConfig()
|
const data = customConfig()
|
||||||
|
|
||||||
|
@ -145,6 +147,7 @@ async function updateCustomConfig (req: express.Request, res: express.Response,
|
||||||
await writeFilePromise(CONFIG.CUSTOM_FILE, JSON.stringify(toUpdateJSON, undefined, 2))
|
await writeFilePromise(CONFIG.CUSTOM_FILE, JSON.stringify(toUpdateJSON, undefined, 2))
|
||||||
|
|
||||||
reloadConfig()
|
reloadConfig()
|
||||||
|
ClientHtml.invalidCache()
|
||||||
|
|
||||||
const data = customConfig()
|
const data = customConfig()
|
||||||
return res.json(data).end()
|
return res.json(data).end()
|
||||||
|
|
|
@ -1,21 +1,10 @@
|
||||||
import * as Bluebird from 'bluebird'
|
|
||||||
import * as express from 'express'
|
import * as express from 'express'
|
||||||
import * as helmet from 'helmet'
|
|
||||||
import { join } from 'path'
|
import { join } from 'path'
|
||||||
import * as validator from 'validator'
|
import { root } from '../helpers/core-utils'
|
||||||
import { escapeHTML, readFileBufferPromise, root } from '../helpers/core-utils'
|
import { ACCEPT_HEADERS, STATIC_MAX_AGE } from '../initializers'
|
||||||
import { ACCEPT_HEADERS, CONFIG, EMBED_SIZE, OPENGRAPH_AND_OEMBED_COMMENT, STATIC_MAX_AGE, STATIC_PATHS } from '../initializers'
|
|
||||||
import { asyncMiddleware } from '../middlewares'
|
import { asyncMiddleware } from '../middlewares'
|
||||||
import { VideoModel } from '../models/video/video'
|
import { buildFileLocale, getCompleteLocale, is18nLocale, LOCALE_FILES } from '../../shared/models/i18n/i18n'
|
||||||
import { VideoPrivacy } from '../../shared/models/videos'
|
import { ClientHtml } from '../lib/client-html'
|
||||||
import {
|
|
||||||
buildFileLocale,
|
|
||||||
getCompleteLocale,
|
|
||||||
getDefaultLocale,
|
|
||||||
is18nLocale,
|
|
||||||
LOCALE_FILES,
|
|
||||||
POSSIBLE_LOCALES
|
|
||||||
} from '../../shared/models/i18n/i18n'
|
|
||||||
|
|
||||||
const clientsRouter = express.Router()
|
const clientsRouter = express.Router()
|
||||||
|
|
||||||
|
@ -79,7 +68,7 @@ clientsRouter.use('/client/*', (req: express.Request, res: express.Response, nex
|
||||||
// Try to provide the right language index.html
|
// Try to provide the right language index.html
|
||||||
clientsRouter.use('/(:language)?', function (req, res) {
|
clientsRouter.use('/(:language)?', function (req, res) {
|
||||||
if (req.accepts(ACCEPT_HEADERS) === 'html') {
|
if (req.accepts(ACCEPT_HEADERS) === 'html') {
|
||||||
return res.sendFile(getIndexPath(req, res, req.params.language))
|
return generateHTMLPage(req, res, req.params.language)
|
||||||
}
|
}
|
||||||
|
|
||||||
return res.status(404).end()
|
return res.status(404).end()
|
||||||
|
@ -93,131 +82,20 @@ export {
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
function getIndexPath (req: express.Request, res: express.Response, paramLang?: string) {
|
async function generateHTMLPage (req: express.Request, res: express.Response, paramLang?: string) {
|
||||||
let lang: string
|
const html = await ClientHtml.getIndexHTML(req, res)
|
||||||
|
|
||||||
// Check param lang validity
|
return sendHTML(html, res)
|
||||||
if (paramLang && is18nLocale(paramLang)) {
|
|
||||||
lang = paramLang
|
|
||||||
|
|
||||||
// Save locale in cookies
|
|
||||||
res.cookie('clientLanguage', lang, {
|
|
||||||
secure: CONFIG.WEBSERVER.SCHEME === 'https',
|
|
||||||
sameSite: true,
|
|
||||||
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()
|
|
||||||
}
|
|
||||||
|
|
||||||
return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html')
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function addOpenGraphAndOEmbedTags (htmlStringPage: string, video: VideoModel) {
|
async function generateWatchHtmlPage (req: express.Request, res: express.Response) {
|
||||||
const previewUrl = CONFIG.WEBSERVER.URL + STATIC_PATHS.PREVIEWS + video.getPreviewName()
|
const html = await ClientHtml.getWatchHTMLPage(req.params.id + '', req, res)
|
||||||
const videoUrl = CONFIG.WEBSERVER.URL + '/videos/watch/' + video.uuid
|
|
||||||
|
|
||||||
const videoNameEscaped = escapeHTML(video.name)
|
return sendHTML(html, res)
|
||||||
const videoDescriptionEscaped = escapeHTML(video.description)
|
|
||||||
const embedUrl = CONFIG.WEBSERVER.URL + video.getEmbedStaticPath()
|
|
||||||
|
|
||||||
const openGraphMetaTags = {
|
|
||||||
'og:type': 'video',
|
|
||||||
'og:title': videoNameEscaped,
|
|
||||||
'og:image': previewUrl,
|
|
||||||
'og:url': videoUrl,
|
|
||||||
'og:description': videoDescriptionEscaped,
|
|
||||||
|
|
||||||
'og:video:url': embedUrl,
|
|
||||||
'og:video:secure_url': embedUrl,
|
|
||||||
'og:video:type': 'text/html',
|
|
||||||
'og:video:width': EMBED_SIZE.width,
|
|
||||||
'og:video:height': EMBED_SIZE.height,
|
|
||||||
|
|
||||||
'name': videoNameEscaped,
|
|
||||||
'description': videoDescriptionEscaped,
|
|
||||||
'image': previewUrl,
|
|
||||||
|
|
||||||
'twitter:card': CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image',
|
|
||||||
'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
|
|
||||||
'twitter:title': videoNameEscaped,
|
|
||||||
'twitter:description': videoDescriptionEscaped,
|
|
||||||
'twitter:image': previewUrl,
|
|
||||||
'twitter:player': embedUrl,
|
|
||||||
'twitter:player:width': EMBED_SIZE.width,
|
|
||||||
'twitter:player:height': EMBED_SIZE.height
|
|
||||||
}
|
|
||||||
|
|
||||||
const oembedLinkTags = [
|
|
||||||
{
|
|
||||||
type: 'application/json+oembed',
|
|
||||||
href: CONFIG.WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(videoUrl),
|
|
||||||
title: videoNameEscaped
|
|
||||||
}
|
|
||||||
]
|
|
||||||
|
|
||||||
const schemaTags = {
|
|
||||||
'@context': 'http://schema.org',
|
|
||||||
'@type': 'VideoObject',
|
|
||||||
name: videoNameEscaped,
|
|
||||||
description: videoDescriptionEscaped,
|
|
||||||
thumbnailUrl: previewUrl,
|
|
||||||
uploadDate: video.createdAt.toISOString(),
|
|
||||||
duration: video.getActivityStreamDuration(),
|
|
||||||
contentUrl: videoUrl,
|
|
||||||
embedUrl: embedUrl,
|
|
||||||
interactionCount: video.views
|
|
||||||
}
|
|
||||||
|
|
||||||
let tagsString = ''
|
|
||||||
|
|
||||||
// Opengraph
|
|
||||||
Object.keys(openGraphMetaTags).forEach(tagName => {
|
|
||||||
const tagValue = openGraphMetaTags[tagName]
|
|
||||||
|
|
||||||
tagsString += `<meta property="${tagName}" content="${tagValue}" />`
|
|
||||||
})
|
|
||||||
|
|
||||||
// OEmbed
|
|
||||||
for (const oembedLinkTag of oembedLinkTags) {
|
|
||||||
tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Schema.org
|
|
||||||
tagsString += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>`
|
|
||||||
|
|
||||||
// SEO
|
|
||||||
tagsString += `<link rel="canonical" href="${videoUrl}" />`
|
|
||||||
|
|
||||||
return htmlStringPage.replace(OPENGRAPH_AND_OEMBED_COMMENT, tagsString)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
async function generateWatchHtmlPage (req: express.Request, res: express.Response, next: express.NextFunction) {
|
function sendHTML (html: string, res: express.Response) {
|
||||||
const videoId = '' + req.params.id
|
res.set('Content-Type', 'text/html; charset=UTF-8')
|
||||||
let videoPromise: Bluebird<VideoModel>
|
|
||||||
|
|
||||||
// Let Angular application handle errors
|
return res.send(html)
|
||||||
if (validator.isUUID(videoId, 4)) {
|
|
||||||
videoPromise = VideoModel.loadByUUIDAndPopulateAccountAndServerAndTags(videoId)
|
|
||||||
} else if (validator.isInt(videoId)) {
|
|
||||||
videoPromise = VideoModel.loadAndPopulateAccountAndServerAndTags(+videoId)
|
|
||||||
} else {
|
|
||||||
return res.sendFile(getIndexPath(req, res))
|
|
||||||
}
|
|
||||||
|
|
||||||
let [ file, video ] = await Promise.all([
|
|
||||||
readFileBufferPromise(getIndexPath(req, res)),
|
|
||||||
videoPromise
|
|
||||||
])
|
|
||||||
|
|
||||||
const html = file.toString()
|
|
||||||
|
|
||||||
// Let Angular application handle errors
|
|
||||||
if (!video || video.privacy === VideoPrivacy.PRIVATE) return res.sendFile(getIndexPath(req, res))
|
|
||||||
|
|
||||||
const htmlStringPageWithTags = addOpenGraphAndOEmbedTags(html, video)
|
|
||||||
res.set('Content-Type', 'text/html; charset=UTF-8').send(htmlStringPageWithTags)
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -466,7 +466,12 @@ const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENT
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
|
const CUSTOM_HTML_TAG_COMMENTS = {
|
||||||
|
TITLE: '<!-- title tag -->',
|
||||||
|
DESCRIPTION: '<!-- description tag -->',
|
||||||
|
CUSTOM_CSS: '<!-- custom css tag -->',
|
||||||
|
OPENGRAPH_AND_OEMBED: '<!-- open graph and oembed tags -->'
|
||||||
|
}
|
||||||
|
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
|
@ -528,7 +533,7 @@ export {
|
||||||
JOB_ATTEMPTS,
|
JOB_ATTEMPTS,
|
||||||
LAST_MIGRATION_VERSION,
|
LAST_MIGRATION_VERSION,
|
||||||
OAUTH_LIFETIME,
|
OAUTH_LIFETIME,
|
||||||
OPENGRAPH_AND_OEMBED_COMMENT,
|
CUSTOM_HTML_TAG_COMMENTS,
|
||||||
BROADCAST_CONCURRENCY,
|
BROADCAST_CONCURRENCY,
|
||||||
PAGINATION_COUNT_DEFAULT,
|
PAGINATION_COUNT_DEFAULT,
|
||||||
ACTOR_FOLLOW_SCORE,
|
ACTOR_FOLLOW_SCORE,
|
||||||
|
|
|
@ -0,0 +1,180 @@
|
||||||
|
import * as express from 'express'
|
||||||
|
import * as Bluebird from 'bluebird'
|
||||||
|
import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/models/i18n/i18n'
|
||||||
|
import { CONFIG, EMBED_SIZE, CUSTOM_HTML_TAG_COMMENTS, STATIC_PATHS } from '../initializers'
|
||||||
|
import { join } from 'path'
|
||||||
|
import { escapeHTML, readFileBufferPromise } from '../helpers/core-utils'
|
||||||
|
import { VideoModel } from '../models/video/video'
|
||||||
|
import * as validator from 'validator'
|
||||||
|
import { VideoPrivacy } from '../../shared/models/videos'
|
||||||
|
|
||||||
|
export class ClientHtml {
|
||||||
|
|
||||||
|
private static htmlCache: { [path: string]: string } = {}
|
||||||
|
|
||||||
|
static invalidCache () {
|
||||||
|
ClientHtml.htmlCache = {}
|
||||||
|
}
|
||||||
|
|
||||||
|
static async getIndexHTML (req: express.Request, res: express.Response, paramLang?: string) {
|
||||||
|
const path = ClientHtml.getIndexPath(req, res, paramLang)
|
||||||
|
if (ClientHtml.htmlCache[path]) return ClientHtml.htmlCache[path]
|
||||||
|
|
||||||
|
const buffer = await readFileBufferPromise(path)
|
||||||
|
|
||||||
|
let html = buffer.toString()
|
||||||
|
|
||||||
|
html = ClientHtml.addTitleTag(html)
|
||||||
|
html = ClientHtml.addDescriptionTag(html)
|
||||||
|
html = ClientHtml.addCustomCSS(html)
|
||||||
|
|
||||||
|
ClientHtml.htmlCache[path] = html
|
||||||
|
|
||||||
|
return html
|
||||||
|
}
|
||||||
|
|
||||||
|
static async getWatchHTMLPage (videoId: string, req: express.Request, res: express.Response) {
|
||||||
|
let videoPromise: Bluebird<VideoModel>
|
||||||
|
|
||||||
|
// Let Angular application handle errors
|
||||||
|
if (validator.isUUID(videoId, 4)) {
|
||||||
|
videoPromise = VideoModel.loadByUUIDAndPopulateAccountAndServerAndTags(videoId)
|
||||||
|
} else if (validator.isInt(videoId)) {
|
||||||
|
videoPromise = VideoModel.loadAndPopulateAccountAndServerAndTags(+videoId)
|
||||||
|
} else {
|
||||||
|
return ClientHtml.getIndexHTML(req, res)
|
||||||
|
}
|
||||||
|
|
||||||
|
const [ html, video ] = await Promise.all([
|
||||||
|
ClientHtml.getIndexHTML(req, res),
|
||||||
|
videoPromise
|
||||||
|
])
|
||||||
|
|
||||||
|
// Let Angular application handle errors
|
||||||
|
if (!video || video.privacy === VideoPrivacy.PRIVATE) {
|
||||||
|
return ClientHtml.getIndexHTML(req, res)
|
||||||
|
}
|
||||||
|
|
||||||
|
return ClientHtml.addOpenGraphAndOEmbedTags(html, video)
|
||||||
|
}
|
||||||
|
|
||||||
|
private static getIndexPath (req: express.Request, res: express.Response, paramLang?: string) {
|
||||||
|
let lang: string
|
||||||
|
|
||||||
|
// Check param lang validity
|
||||||
|
if (paramLang && is18nLocale(paramLang)) {
|
||||||
|
lang = paramLang
|
||||||
|
|
||||||
|
// Save locale in cookies
|
||||||
|
res.cookie('clientLanguage', lang, {
|
||||||
|
secure: CONFIG.WEBSERVER.SCHEME === 'https',
|
||||||
|
sameSite: true,
|
||||||
|
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()
|
||||||
|
}
|
||||||
|
|
||||||
|
return join(__dirname, '../../../client/dist/' + buildFileLocale(lang) + '/index.html')
|
||||||
|
}
|
||||||
|
|
||||||
|
private static addTitleTag (htmlStringPage: string) {
|
||||||
|
const titleTag = '<title>' + CONFIG.INSTANCE.NAME + '</title>'
|
||||||
|
|
||||||
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.TITLE, titleTag)
|
||||||
|
}
|
||||||
|
|
||||||
|
private static addDescriptionTag (htmlStringPage: string) {
|
||||||
|
const descriptionTag = `<meta name="description" content="${CONFIG.INSTANCE.SHORT_DESCRIPTION}" />`
|
||||||
|
|
||||||
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.DESCRIPTION, descriptionTag)
|
||||||
|
}
|
||||||
|
|
||||||
|
private static addCustomCSS (htmlStringPage: string) {
|
||||||
|
const styleTag = '<style class="custom-css-style">' + CONFIG.INSTANCE.CUSTOMIZATIONS.CSS + '</style>'
|
||||||
|
|
||||||
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag)
|
||||||
|
}
|
||||||
|
|
||||||
|
private static addOpenGraphAndOEmbedTags (htmlStringPage: string, video: VideoModel) {
|
||||||
|
const previewUrl = CONFIG.WEBSERVER.URL + STATIC_PATHS.PREVIEWS + video.getPreviewName()
|
||||||
|
const videoUrl = CONFIG.WEBSERVER.URL + '/videos/watch/' + video.uuid
|
||||||
|
|
||||||
|
const videoNameEscaped = escapeHTML(video.name)
|
||||||
|
const videoDescriptionEscaped = escapeHTML(video.description)
|
||||||
|
const embedUrl = CONFIG.WEBSERVER.URL + video.getEmbedStaticPath()
|
||||||
|
|
||||||
|
const openGraphMetaTags = {
|
||||||
|
'og:type': 'video',
|
||||||
|
'og:title': videoNameEscaped,
|
||||||
|
'og:image': previewUrl,
|
||||||
|
'og:url': videoUrl,
|
||||||
|
'og:description': videoDescriptionEscaped,
|
||||||
|
|
||||||
|
'og:video:url': embedUrl,
|
||||||
|
'og:video:secure_url': embedUrl,
|
||||||
|
'og:video:type': 'text/html',
|
||||||
|
'og:video:width': EMBED_SIZE.width,
|
||||||
|
'og:video:height': EMBED_SIZE.height,
|
||||||
|
|
||||||
|
'name': videoNameEscaped,
|
||||||
|
'description': videoDescriptionEscaped,
|
||||||
|
'image': previewUrl,
|
||||||
|
|
||||||
|
'twitter:card': CONFIG.SERVICES.TWITTER.WHITELISTED ? 'player' : 'summary_large_image',
|
||||||
|
'twitter:site': CONFIG.SERVICES.TWITTER.USERNAME,
|
||||||
|
'twitter:title': videoNameEscaped,
|
||||||
|
'twitter:description': videoDescriptionEscaped,
|
||||||
|
'twitter:image': previewUrl,
|
||||||
|
'twitter:player': embedUrl,
|
||||||
|
'twitter:player:width': EMBED_SIZE.width,
|
||||||
|
'twitter:player:height': EMBED_SIZE.height
|
||||||
|
}
|
||||||
|
|
||||||
|
const oembedLinkTags = [
|
||||||
|
{
|
||||||
|
type: 'application/json+oembed',
|
||||||
|
href: CONFIG.WEBSERVER.URL + '/services/oembed?url=' + encodeURIComponent(videoUrl),
|
||||||
|
title: videoNameEscaped
|
||||||
|
}
|
||||||
|
]
|
||||||
|
|
||||||
|
const schemaTags = {
|
||||||
|
'@context': 'http://schema.org',
|
||||||
|
'@type': 'VideoObject',
|
||||||
|
name: videoNameEscaped,
|
||||||
|
description: videoDescriptionEscaped,
|
||||||
|
thumbnailUrl: previewUrl,
|
||||||
|
uploadDate: video.createdAt.toISOString(),
|
||||||
|
duration: video.getActivityStreamDuration(),
|
||||||
|
contentUrl: videoUrl,
|
||||||
|
embedUrl: embedUrl,
|
||||||
|
interactionCount: video.views
|
||||||
|
}
|
||||||
|
|
||||||
|
let tagsString = ''
|
||||||
|
|
||||||
|
// Opengraph
|
||||||
|
Object.keys(openGraphMetaTags).forEach(tagName => {
|
||||||
|
const tagValue = openGraphMetaTags[tagName]
|
||||||
|
|
||||||
|
tagsString += `<meta property="${tagName}" content="${tagValue}" />`
|
||||||
|
})
|
||||||
|
|
||||||
|
// OEmbed
|
||||||
|
for (const oembedLinkTag of oembedLinkTags) {
|
||||||
|
tagsString += `<link rel="alternate" type="${oembedLinkTag.type}" href="${oembedLinkTag.href}" title="${oembedLinkTag.title}" />`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Schema.org
|
||||||
|
tagsString += `<script type="application/ld+json">${JSON.stringify(schemaTags)}</script>`
|
||||||
|
|
||||||
|
// SEO
|
||||||
|
tagsString += `<link rel="canonical" href="${videoUrl}" />`
|
||||||
|
|
||||||
|
return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.OPENGRAPH_AND_OEMBED, tagsString)
|
||||||
|
}
|
||||||
|
}
|
|
@ -4,7 +4,7 @@ import 'mocha'
|
||||||
import * as chai from 'chai'
|
import * as chai from 'chai'
|
||||||
import { About } from '../../../../shared/models/server/about.model'
|
import { About } from '../../../../shared/models/server/about.model'
|
||||||
import { CustomConfig } from '../../../../shared/models/server/custom-config.model'
|
import { CustomConfig } from '../../../../shared/models/server/custom-config.model'
|
||||||
import { deleteCustomConfig, getAbout, killallServers, reRunServer } from '../../utils'
|
import { deleteCustomConfig, getAbout, killallServers, makeHTMLRequest, reRunServer } from '../../utils'
|
||||||
const expect = chai.expect
|
const expect = chai.expect
|
||||||
|
|
||||||
import {
|
import {
|
||||||
|
@ -69,6 +69,12 @@ function checkUpdatedConfig (data: CustomConfig) {
|
||||||
expect(data.transcoding.resolutions['1080p']).to.be.false
|
expect(data.transcoding.resolutions['1080p']).to.be.false
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function checkIndexTags (html: string, title: string, description: string, css: string) {
|
||||||
|
expect(html).to.contain('<title>' + title + '</title>')
|
||||||
|
expect(html).to.contain('<meta name="description" content="' + description + '" />')
|
||||||
|
expect(html).to.contain('<style class="custom-css-style">' + css + '</style>')
|
||||||
|
}
|
||||||
|
|
||||||
describe('Test config', function () {
|
describe('Test config', function () {
|
||||||
let server = null
|
let server = null
|
||||||
|
|
||||||
|
@ -109,6 +115,14 @@ describe('Test config', function () {
|
||||||
checkInitialConfig(data)
|
checkInitialConfig(data)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('Should have valid index html tags (title, description...)', async function () {
|
||||||
|
const res = await makeHTMLRequest(server.url, '/videos/trending')
|
||||||
|
|
||||||
|
const description = 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser ' +
|
||||||
|
'with WebTorrent and Angular.'
|
||||||
|
checkIndexTags(res.text, 'PeerTube', description, '')
|
||||||
|
})
|
||||||
|
|
||||||
it('Should update the customized configuration', async function () {
|
it('Should update the customized configuration', async function () {
|
||||||
const newCustomConfig: CustomConfig = {
|
const newCustomConfig: CustomConfig = {
|
||||||
instance: {
|
instance: {
|
||||||
|
@ -167,6 +181,12 @@ describe('Test config', function () {
|
||||||
checkUpdatedConfig(data)
|
checkUpdatedConfig(data)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('Should have valid index html updated tags (title, description...)', async function () {
|
||||||
|
const res = await makeHTMLRequest(server.url, '/videos/trending')
|
||||||
|
|
||||||
|
checkIndexTags(res.text, 'PeerTube updated', 'my short description', 'body { background-color: red; }')
|
||||||
|
})
|
||||||
|
|
||||||
it('Should have the configuration updated after a restart', async function () {
|
it('Should have the configuration updated after a restart', async function () {
|
||||||
this.timeout(10000)
|
this.timeout(10000)
|
||||||
|
|
||||||
|
@ -178,6 +198,10 @@ describe('Test config', function () {
|
||||||
const data = res.body
|
const data = res.body
|
||||||
|
|
||||||
checkUpdatedConfig(data)
|
checkUpdatedConfig(data)
|
||||||
|
|
||||||
|
// Check HTML too
|
||||||
|
const resHtml = await makeHTMLRequest(server.url, '/videos/trending')
|
||||||
|
checkIndexTags(resHtml.text, 'PeerTube updated', 'my short description', 'body { background-color: red; }')
|
||||||
})
|
})
|
||||||
|
|
||||||
it('Should fetch the about information', async function () {
|
it('Should fetch the about information', async function () {
|
||||||
|
|
|
@ -19,6 +19,12 @@ start()
|
||||||
// ----------------------------------------------------------------------------
|
// ----------------------------------------------------------------------------
|
||||||
|
|
||||||
async function start () {
|
async function start () {
|
||||||
|
await flushTests()
|
||||||
|
|
||||||
|
console.log('Flushed tests.')
|
||||||
|
|
||||||
|
const server = await runServer(6)
|
||||||
|
|
||||||
process.on('exit', async () => {
|
process.on('exit', async () => {
|
||||||
killallServers([ server ])
|
killallServers([ server ])
|
||||||
return
|
return
|
||||||
|
@ -26,11 +32,6 @@ async function start () {
|
||||||
process.on('SIGINT', goodbye)
|
process.on('SIGINT', goodbye)
|
||||||
process.on('SIGTERM', goodbye)
|
process.on('SIGTERM', goodbye)
|
||||||
|
|
||||||
await flushTests()
|
|
||||||
|
|
||||||
console.log('Flushed tests.')
|
|
||||||
|
|
||||||
const server = await runServer(6)
|
|
||||||
await setAccessTokensToServers([ server ])
|
await setAccessTokensToServers([ server ])
|
||||||
|
|
||||||
console.log('Servers ran.')
|
console.log('Servers ran.')
|
||||||
|
|
|
@ -123,6 +123,13 @@ function makePutBodyRequest (options: {
|
||||||
.expect(options.statusCodeExpected)
|
.expect(options.statusCodeExpected)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function makeHTMLRequest (url: string, path: string) {
|
||||||
|
return request(url)
|
||||||
|
.get(path)
|
||||||
|
.set('Accept', 'text/html')
|
||||||
|
.expect(200)
|
||||||
|
}
|
||||||
|
|
||||||
function updateAvatarRequest (options: {
|
function updateAvatarRequest (options: {
|
||||||
url: string,
|
url: string,
|
||||||
path: string,
|
path: string,
|
||||||
|
@ -149,6 +156,7 @@ function updateAvatarRequest (options: {
|
||||||
// ---------------------------------------------------------------------------
|
// ---------------------------------------------------------------------------
|
||||||
|
|
||||||
export {
|
export {
|
||||||
|
makeHTMLRequest,
|
||||||
makeGetRequest,
|
makeGetRequest,
|
||||||
makeUploadRequest,
|
makeUploadRequest,
|
||||||
makePostBodyRequest,
|
makePostBodyRequest,
|
||||||
|
|
Loading…
Reference in New Issue