From 92bf2f62995bbaa0402cb4657473ad8d5b6fcf8d Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Thu, 21 Feb 2019 14:06:10 +0100 Subject: [PATCH] Improve channel and account SEO --- client/src/index.html | 2 +- server/controllers/client.ts | 14 ++++ server/helpers/custom-validators/accounts.ts | 8 +-- .../custom-validators/video-channels.ts | 6 +- server/initializers/constants.ts | 2 +- server/lib/client-html.ts | 67 +++++++++++++++---- server/models/account/account.ts | 10 +++ server/models/video/video-channel.ts | 10 ++- 8 files changed, 90 insertions(+), 29 deletions(-) diff --git a/client/src/index.html b/client/src/index.html index 8c257824e..6aa885eb7 100644 --- a/client/src/index.html +++ b/client/src/index.html @@ -14,7 +14,7 @@ - + diff --git a/server/controllers/client.ts b/server/controllers/client.ts index f17f2a5d2..ece2f460c 100644 --- a/server/controllers/client.ts +++ b/server/controllers/client.ts @@ -17,6 +17,8 @@ const testEmbedPath = join(distPath, 'standalone', 'videos', 'test-embed.html') // Special route that add OpenGraph and oEmbed tags // Do not use a template engine for a so little thing clientsRouter.use('/videos/watch/:id', asyncMiddleware(generateWatchHtmlPage)) +clientsRouter.use('/accounts/:nameWithHost', asyncMiddleware(generateAccountHtmlPage)) +clientsRouter.use('/video-channels/:nameWithHost', asyncMiddleware(generateVideoChannelHtmlPage)) clientsRouter.use( '/videos/embed', @@ -99,6 +101,18 @@ async function generateWatchHtmlPage (req: express.Request, res: express.Respons return sendHTML(html, res) } +async function generateAccountHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getAccountHTMLPage(req.params.nameWithHost, req, res) + + return sendHTML(html, res) +} + +async function generateVideoChannelHtmlPage (req: express.Request, res: express.Response) { + const html = await ClientHtml.getVideoChannelHTMLPage(req.params.nameWithHost, req, res) + + return sendHTML(html, res) +} + function sendHTML (html: string, res: express.Response) { res.set('Content-Type', 'text/html; charset=UTF-8') diff --git a/server/helpers/custom-validators/accounts.ts b/server/helpers/custom-validators/accounts.ts index 191de1496..aad04fe93 100644 --- a/server/helpers/custom-validators/accounts.ts +++ b/server/helpers/custom-validators/accounts.ts @@ -38,13 +38,7 @@ function isLocalAccountNameExist (name: string, res: Response, sendNotFound = tr } function isAccountNameWithHostExist (nameWithDomain: string, res: Response, sendNotFound = true) { - const [ accountName, host ] = nameWithDomain.split('@') - - let promise: Bluebird - if (!host || host === CONFIG.WEBSERVER.HOST) promise = AccountModel.loadLocalByName(accountName) - else promise = AccountModel.loadByNameAndHost(accountName, host) - - return isAccountExist(promise, res, sendNotFound) + return isAccountExist(AccountModel.loadByNameWithHost(nameWithDomain), res, sendNotFound) } async function isAccountExist (p: Bluebird, res: Response, sendNotFound: boolean) { diff --git a/server/helpers/custom-validators/video-channels.ts b/server/helpers/custom-validators/video-channels.ts index f13519c1d..cbf150e53 100644 --- a/server/helpers/custom-validators/video-channels.ts +++ b/server/helpers/custom-validators/video-channels.ts @@ -38,11 +38,7 @@ async function isVideoChannelIdExist (id: string, res: express.Response) { } async function isVideoChannelNameWithHostExist (nameWithDomain: string, res: express.Response) { - const [ name, host ] = nameWithDomain.split('@') - let videoChannel: VideoChannelModel - - if (!host || host === CONFIG.WEBSERVER.HOST) videoChannel = await VideoChannelModel.loadLocalByNameAndPopulateAccount(name) - else videoChannel = await VideoChannelModel.loadByNameAndHostAndPopulateAccount(name, host) + const videoChannel = await VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithDomain) return processVideoChannelExist(videoChannel, res) } diff --git a/server/initializers/constants.ts b/server/initializers/constants.ts index bb2c6765f..0ede45620 100644 --- a/server/initializers/constants.ts +++ b/server/initializers/constants.ts @@ -661,7 +661,7 @@ const CUSTOM_HTML_TAG_COMMENTS = { TITLE: '', DESCRIPTION: '', CUSTOM_CSS: '', - OPENGRAPH_AND_OEMBED: '' + META_TAGS: '' } // --------------------------------------------------------------------------- diff --git a/server/lib/client-html.ts b/server/lib/client-html.ts index b2c376e20..217f6a437 100644 --- a/server/lib/client-html.ts +++ b/server/lib/client-html.ts @@ -1,5 +1,4 @@ import * as express from 'express' -import * as Bluebird from 'bluebird' import { buildFileLocale, getDefaultLocale, is18nLocale, POSSIBLE_LOCALES } from '../../shared/models/i18n/i18n' import { CONFIG, CUSTOM_HTML_TAG_COMMENTS, EMBED_SIZE } from '../initializers' import { join } from 'path' @@ -9,10 +8,13 @@ import * as validator from 'validator' import { VideoPrivacy } from '../../shared/models/videos' import { readFile } from 'fs-extra' import { getActivityStreamDuration } from '../models/video/video-format-utils' +import { AccountModel } from '../models/account/account' +import { VideoChannelModel } from '../models/video/video-channel' +import * as Bluebird from 'bluebird' export class ClientHtml { - private static htmlCache: { [path: string]: string } = {} + private static htmlCache: { [ path: string ]: string } = {} static invalidCache () { ClientHtml.htmlCache = {} @@ -28,18 +30,14 @@ export class ClientHtml { } static async getWatchHTMLPage (videoId: string, req: express.Request, res: express.Response) { - let videoPromise: Bluebird - // Let Angular application handle errors - if (validator.isInt(videoId) || validator.isUUID(videoId, 4)) { - videoPromise = VideoModel.loadAndPopulateAccountAndServerAndTags(videoId) - } else { + if (!validator.isInt(videoId) && !validator.isUUID(videoId, 4)) { return ClientHtml.getIndexHTML(req, res) } const [ html, video ] = await Promise.all([ ClientHtml.getIndexHTML(req, res), - videoPromise + VideoModel.loadAndPopulateAccountAndServerAndTags(videoId) ]) // Let Angular application handle errors @@ -49,14 +47,44 @@ export class ClientHtml { let customHtml = ClientHtml.addTitleTag(html, escapeHTML(video.name)) customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(video.description)) - customHtml = ClientHtml.addOpenGraphAndOEmbedTags(customHtml, video) + customHtml = ClientHtml.addVideoOpenGraphAndOEmbedTags(customHtml, video) + + return customHtml + } + + static async getAccountHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) { + return this.getAccountOrChannelHTMLPage(() => AccountModel.loadByNameWithHost(nameWithHost), req, res) + } + + static async getVideoChannelHTMLPage (nameWithHost: string, req: express.Request, res: express.Response) { + return this.getAccountOrChannelHTMLPage(() => VideoChannelModel.loadByNameWithHostAndPopulateAccount(nameWithHost), req, res) + } + + private static async getAccountOrChannelHTMLPage ( + loader: () => Bluebird, + req: express.Request, + res: express.Response + ) { + const [ html, entity ] = await Promise.all([ + ClientHtml.getIndexHTML(req, res), + loader() + ]) + + // Let Angular application handle errors + if (!entity) { + return ClientHtml.getIndexHTML(req, res) + } + + let customHtml = ClientHtml.addTitleTag(html, escapeHTML(entity.getDisplayName())) + customHtml = ClientHtml.addDescriptionTag(customHtml, escapeHTML(entity.description)) + customHtml = ClientHtml.addAccountOrChannelMetaTags(customHtml, entity) return customHtml } private 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] + if (ClientHtml.htmlCache[ path ]) return ClientHtml.htmlCache[ path ] const buffer = await readFile(path) @@ -64,7 +92,7 @@ export class ClientHtml { html = ClientHtml.addCustomCSS(html) - ClientHtml.htmlCache[path] = html + ClientHtml.htmlCache[ path ] = html return html } @@ -114,7 +142,7 @@ export class ClientHtml { return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.CUSTOM_CSS, styleTag) } - private static addOpenGraphAndOEmbedTags (htmlStringPage: string, video: VideoModel) { + private static addVideoOpenGraphAndOEmbedTags (htmlStringPage: string, video: VideoModel) { const previewUrl = CONFIG.WEBSERVER.URL + video.getPreviewStaticPath() const videoUrl = CONFIG.WEBSERVER.URL + video.getWatchStaticPath() @@ -174,7 +202,7 @@ export class ClientHtml { // Opengraph Object.keys(openGraphMetaTags).forEach(tagName => { - const tagValue = openGraphMetaTags[tagName] + const tagValue = openGraphMetaTags[ tagName ] tagsString += `` }) @@ -190,6 +218,17 @@ export class ClientHtml { // SEO, use origin video url so Google does not index remote videos tagsString += `` - return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.OPENGRAPH_AND_OEMBED, tagsString) + return this.addOpenGraphAndOEmbedTags(htmlStringPage, tagsString) + } + + private static addAccountOrChannelMetaTags (htmlStringPage: string, entity: AccountModel | VideoChannelModel) { + // SEO, use origin account or channel URL + const metaTags = `` + + return this.addOpenGraphAndOEmbedTags(htmlStringPage, metaTags) + } + + private static addOpenGraphAndOEmbedTags (htmlStringPage: string, metaTags: string) { + return htmlStringPage.replace(CUSTOM_HTML_TAG_COMMENTS.META_TAGS, metaTags) } } diff --git a/server/models/account/account.ts b/server/models/account/account.ts index 84ef0b30d..747b51afb 100644 --- a/server/models/account/account.ts +++ b/server/models/account/account.ts @@ -24,6 +24,8 @@ import { getSort, throwIfNotValid } from '../utils' import { VideoChannelModel } from '../video/video-channel' import { VideoCommentModel } from '../video/video-comment' import { UserModel } from './user' +import * as Bluebird from '../../helpers/custom-validators/accounts' +import { CONFIG } from '../../initializers' @DefaultScope({ include: [ @@ -153,6 +155,14 @@ export class AccountModel extends Model { return AccountModel.findOne(query) } + static loadByNameWithHost (nameWithHost: string) { + const [ accountName, host ] = nameWithHost.split('@') + + if (!host || host === CONFIG.WEBSERVER.HOST) return AccountModel.loadLocalByName(accountName) + + return AccountModel.loadByNameAndHost(accountName, host) + } + static loadLocalByName (name: string) { const query = { where: { diff --git a/server/models/video/video-channel.ts b/server/models/video/video-channel.ts index 5598d80f6..91dd0440c 100644 --- a/server/models/video/video-channel.ts +++ b/server/models/video/video-channel.ts @@ -28,7 +28,7 @@ import { AccountModel } from '../account/account' import { ActorModel, unusedActorAttributesForAPI } from '../activitypub/actor' import { buildTrigramSearchIndex, createSimilarityAttribute, getSort, throwIfNotValid } from '../utils' import { VideoModel } from './video' -import { CONSTRAINTS_FIELDS } from '../../initializers' +import { CONFIG, CONSTRAINTS_FIELDS } from '../../initializers' import { ServerModel } from '../server/server' import { DefineIndexesOptions } from 'sequelize' @@ -378,6 +378,14 @@ export class VideoChannelModel extends Model { .findOne(query) } + static loadByNameWithHostAndPopulateAccount (nameWithHost: string) { + const [ name, host ] = nameWithHost.split('@') + + if (!host || host === CONFIG.WEBSERVER.HOST) return VideoChannelModel.loadLocalByNameAndPopulateAccount(name) + + return VideoChannelModel.loadByNameAndHostAndPopulateAccount(name, host) + } + static loadLocalByNameAndPopulateAccount (name: string) { const query = { include: [