Emebed JS: fix compatibility with sphinx 6.x (jquery removal)

Author: stsewd

readthedocs/core/static-src/core/js/doc-embed/search.js

@@ -7,33 +7,6 @@ var xss = require('xss/lib/index');
 var MAX_RESULT_PER_SECTION = 3;
 var MAX_SUBSTRING_LIMIT = 100;
 
-/**
- * Use try...catch block to append html to contents
- *
- * @param {Object} contents html element on which additional html is be appended
- * @param {String} template underscore.js template string
- * @param {Object} data template vars and their values
- */
-function append_html_to_contents(contents, template, data) {
-    // underscore.js throws variable not defined error
-    // because of change of syntax in new versions.
-    // See: https://stackoverflow.com/a/25881231/8601393
-    try {
-        // this is the pre-1.7 syntax from Underscore.js
-        contents.append(
-            $u.template(
-                template,
-                data
-            )
-        );
-    }
-    catch (error) {
-        // this is the new syntax
-        contents.append(
-            $u.template(template)(data)
-        );
-    }
-}
 
 /*
  * Search query override for hitting our local API instead of the standard
@@ -50,7 +23,7 @@ function attach_elastic_search_query_sphinx(data) {
         var search_url = document.createElement('a');
 
         search_url.href = data.proxied_api_host + '/api/v2/search/';
-        search_url.search = '?q=' + $.urlencode(query) + '&project=' + project +
+        search_url.search = '?q=' + encodeURIComponent(query) + '&project=' + project +
                             '&version=' + version + '&language=' + language;
 
         /*
@@ -64,6 +37,48 @@ function attach_elastic_search_query_sphinx(data) {
           }
         };
 
+        /**
+         * Build a section with its matching results.
+         *
+         * @param {String} title.
+         * @param {String} link.
+         * @param {Array} contents.
+         */
+        var buildSection = function (title, link, contents) {
+            var div_title = document.createElement("div");
+            var a_element = document.createElement("a");
+            a_element.href = link;
+            a_element.innerHTML = title;
+            div_title.appendChild(a_element);
+            html = div_title.outerHTML;
+            for (var i = 0; i < contents.length; i += 1) {
+                var div_content = document.createElement("div");
+                div_content.innerHTML = contents[i];
+                html += div_content.outerHTML;
+            }
+            return html;
+        };
+
+        /**
+         * Build a domain section.
+         *
+         * @param {String} title.
+         * @param {String} link.
+         * @param {String} content.
+         */
+        var buildDomain = function (title, link, content) {
+            var div_title = document.createElement("div");
+            var a_element = document.createElement("a");
+            a_element.href = link;
+            a_element.innerHTML = title;
+            div_title.appendChild(a_element);
+
+            var div_content = document.createElement("div");
+            div_content.innerHTML = content;
+
+            return div_title.outerHTML + div_content.outerHTML;
+        };
+
         search_def
             .then(function (data) {
                 var results = data.results || [];
@@ -80,7 +95,7 @@ function attach_elastic_search_query_sphinx(data) {
                             title = xss(result.highlights.title[0]);
                         }
 
-                        var link = result.path + "?highlight=" + $.urlencode(query);
+                        var link = result.path + "?highlight=" + encodeURIComponent(query);
 
                         var item = $('<a>', {'href': link});
 
@@ -100,33 +115,11 @@ function attach_elastic_search_query_sphinx(data) {
 
                             var contents = $('<div class="context">');
 
-                            var section_template =
-                                '<div>' +
-                                    '<a href="<%= section_subtitle_link %>">' +
-                                        '<%= section_subtitle %>' +
-                                    '</a>' +
-                                '</div>' +
-                                '<% for (var i = 0; i < section_content.length; ++i) { %>' +
-                                    '<div>' +
-                                        '<%= section_content[i] %>' +
-                                    '</div>' +
-                                '<% } %>';
-
-                            var domain_template =
-                                '<div>' +
-                                    '<a href="<%= domain_subtitle_link %>">' +
-                                        '<%= domain_subtitle %>' +
-                                    '</a>' +
-                                '</div>' +
-                                '<div>' +
-                                    '<%= domain_content %>' +
-                                '</div>';
-
                             // if the result is page section
                             if (current_block.type === "section") {
                                 var section = current_block;
                                 var section_subtitle = section.title;
-                                var section_subtitle_link = link + "#" + section.id;
+                                var section_subtitle_link = xss(link + "#" + section.id);
                                 var section_content = [section.content.substr(0, MAX_SUBSTRING_LIMIT) + " ..."];
 
                                 if (section.highlights.title.length) {
@@ -145,15 +138,11 @@ function attach_elastic_search_query_sphinx(data) {
                                     }
                                 }
 
-                                append_html_to_contents(
-                                    contents,
-                                    section_template,
-                                    {
-                                        section_subtitle_link: section_subtitle_link,
-                                        section_subtitle: section_subtitle,
-                                        section_content: section_content
-                                    }
-                                );
+                                contents.append(buildSection(
+                                    section_subtitle,
+                                    section_subtitle_link,
+                                    section_content
+                                ));
                             }
 
                             // if the result is a sphinx domain object
@@ -178,15 +167,11 @@ function attach_elastic_search_query_sphinx(data) {
 
                                 var domain_subtitle = "[" + domain_role_name + "]: " + domain_name;
 
-                                append_html_to_contents(
-                                    contents,
-                                    domain_template,
-                                    {
-                                        domain_subtitle_link: domain_subtitle_link,
-                                        domain_subtitle: domain_subtitle,
-                                        domain_content: domain_content
-                                    }
-                                );
+                                contents.append(buildDomain(
+                                    domain_subtitle,
+                                    domain_subtitle_link,
+                                    domain_content
+                                ));
                             }
 
                             contents.find('span').addClass('highlighted');

readthedocs/core/static-src/core/js/readthedocs-doc-embed.js

@@ -19,10 +19,22 @@ var search = require('./doc-embed/search');
         }
     }
 
-    domReady(function () {
+    function init() {
         footer.init();
         sphinx.init();
         search.init();
         sponsorship.init();
-    });
+    }
+
+    // Inject JQuery if isn't present already.
+    if (!window.jQuery) {
+        console.log("JQuery not found. Injecting.");
+        var script = document.createElement("script");
+        script.type = 'text/javascript';
+        script.src = "https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js";
+        script.onload = function () { domReady(init); };
+        document.head.appendChild(script);
+    } else {
+        domReady(init);
+    }
 }());