blog/scripts/openGraph.js

'use strict'
/* global hexo */

/*
* Modified from the hexo version,
* https://github.com/hexojs/hexo/blob/master/lib/plugins/helper/open_graph.js
* to include https://github.com/hexojs/hexo/pull/3674
* and use WHATWG URL API
* https://nodejs.org/api/url.html#url_the_whatwg_url_api
*/

'use strict'

const moment = require('moment')
const { escapeHTML, htmlTag, stripHTML } = require('hexo-util')
const micromatch = require('micromatch')

function meta (name, content, escape) {
  if (escape !== false && typeof content === 'string') {
    content = escapeHTML(content)
  }

  return `${htmlTag('meta', {
    name,
    content
  })}\n`
}

function og (name, content, escape) {
  if (escape !== false && typeof content === 'string') {
    content = escapeHTML(content)
  }

  return `${htmlTag('meta', {
    property: name,
    content
  })}\n`
}

function openGraphHelper (options = {}) {
  const { config, page, theme } = this
  const { content } = page
  let images = page.photos || []
  let description = page.excerpt || theme.description
  const keywords = page.keywords || (page.tags && page.tags.length ? page.tags : undefined) || config.keywords
  const title = page.title || theme.nickname
  const type = (this.is_post() ? 'article' : 'website')
  const url = this.url.replace(/index.html$/, '')
  const siteName = theme.nickname
  const twitterCard = options.twitter_card || 'summary'
  const published = page.date || false
  const updated = page.lastUpdated || false
  const language = options.language || page.lang || page.language || config.language
  let result = ''

  if (!Array.isArray(images)) images = [images]

  if (description) {
    description = stripHTML(description).substring(0, 200)
      .trim() // Remove prefixing/trailing spaces
      .replace(/</g, '&lt;')
      .replace(/>/g, '&gt;')
      .replace(/&/g, '&amp;')
      .replace(/"/g, '&quot;')
      .replace(/'/g, '&apos;')
      .replace(/\n/g, ' ') // Replace new lines by spaces
  }

  if (!images.length && content && content.includes('<img')) {
    images = images.slice();

    let img
    const imgPattern = /<img [^>]*src=['"]([^'"]+)([^>]*>)/gi
    while ((img = imgPattern.exec(content)) !== null) {
      images.push(img[1])
    }
  }

  if (description) {
    result += meta('description', description, false)
  }

  if (keywords) {
    if (typeof keywords === 'string') {
      result += meta('keywords', keywords)
    } else if (keywords.length) {
      result += meta('keywords', keywords.map(tag => {
        return tag.name ? tag.name : tag
      }).filter(keyword => !!keyword).join())
    }
  }

  result += og('og:type', type)
  result += og('og:title', title)
  result += og('og:url', url, false)
  result += og('og:site_name', siteName)
  if (description) {
    result += og('og:description', description, false)
  }

  if (language) {
    result += og('og:locale', language, false)
  }

  images = images.map(path => {
    // parse relative url to full url
    try {
      new URL(path)
    } catch {
      return new URL(path, config.url).href
    }

    return path
  })

  images.forEach(path => {
    result += og('og:image', path, false)
  })

  if (published) {
    if ((moment.isMoment(published) || moment.isDate(published)) && !isNaN(published.valueOf()) &&
      this.is_post()) {
      // Skip timezone conversion
      result += og('article:published_time', moment(published).format('YYYY-MM-DD[T00:00:00.000Z]'))
    }
  }

  if (updated) {
    if ((moment.isMoment(updated) || moment.isDate(updated)) && !isNaN(updated.valueOf())) {
      result += og('og:updated_time', moment(updated).format('YYYY-MM-DD[T00:00:00.000Z]'))

      if (this.is_post()) {
        result += og('article:modified_time', moment(updated).format('YYYY-MM-DD[T00:00:00.000Z]'))
      }
    }
  }

  result += meta('twitter:card', twitterCard)

  if (images.length) {
    result += meta('twitter:image', images[0], false)
  }

  return result.trim()
}

hexo.extend.helper.register('openGraph', openGraphHelper)