summaryrefslogtreecommitdiffstats
path: root/browser/components/pagedata/OpenGraphPageData.sys.mjs
blob: 8f8b361799f31f6e295b7404e947f216269316c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * Collects Open Graph (https://opengraphprotocol.org/) related data from a page.
 */
export const OpenGraphPageData = {
  /**
   * Collects the opengraph data from the page.
   *
   * @param {Document} document
   *   The document to collect from
   *
   * @returns {PageData}
   */
  collect(document) {
    let pageData = {};

    // Sites can technically define an Open Graph prefix other than `og:`.
    // However, `og:` is one of the default RDFa prefixes and it's likely
    // uncommon that sites use a custom prefix. If we find that metadata is
    // missing for common sites due to this issue, we could consider adding a
    // basic RDFa parser.
    let openGraphTags = document.querySelectorAll("meta[property^='og:'");

    for (let tag of openGraphTags) {
      // Strip "og:" from the property name.
      let propertyName = tag.getAttribute("property").substring(3);

      switch (propertyName) {
        case "description":
          pageData.description = tag.getAttribute("content");
          break;
        case "site_name":
          pageData.siteName = tag.getAttribute("content");
          break;
        case "image":
          pageData.image = tag.getAttribute("content");
          break;
      }
    }

    return pageData;
  },
};