summaryrefslogtreecommitdiffstats
path: root/browser/components/pagedata/OpenGraphPageData.sys.mjs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 19:33:14 +0000
commit36d22d82aa202bb199967e9512281e9a53db42c9 (patch)
tree105e8c98ddea1c1e4784a60a5a6410fa416be2de /browser/components/pagedata/OpenGraphPageData.sys.mjs
parentInitial commit. (diff)
downloadfirefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.tar.xz
firefox-esr-36d22d82aa202bb199967e9512281e9a53db42c9.zip
Adding upstream version 115.7.0esr.upstream/115.7.0esrupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'browser/components/pagedata/OpenGraphPageData.sys.mjs')
-rw-r--r--browser/components/pagedata/OpenGraphPageData.sys.mjs46
1 files changed, 46 insertions, 0 deletions
diff --git a/browser/components/pagedata/OpenGraphPageData.sys.mjs b/browser/components/pagedata/OpenGraphPageData.sys.mjs
new file mode 100644
index 0000000000..8f8b361799
--- /dev/null
+++ b/browser/components/pagedata/OpenGraphPageData.sys.mjs
@@ -0,0 +1,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;
+ },
+};